以下に、Bundle Builder API の仕様の概要（TypeScript の定義や詳細な説明など）を示します。
BundleDocument インターフェース
構成されたコレクション内の単一ドキュメントの仕様。
type BundleDocument = {
// A list of document IDs to serve in the bundle.
docs?: Array<string>;
// A map containing individual named queries and their definitions.
queries?: Map<string, QueryDefinition[]>;
// A map of parameters and their definitions, which can be provided to a query definition.
params?: Map<string, ParamDefinition>;
// Specifies how long to keep the bundle in the client's cache, in seconds. If not defined, client-side cache is disabled.
clientCache?: string;
// Only used in combination with Firebase Hosting. Specifies how long to keep the bundle in Firebase Hosting CDN cache, in seconds.
serverCache: string;
// Specifies how long (in seconds) to keep the bundle in a Cloud Storage bucket, in seconds. If not defined, Cloud Storage bucket is not accessed.
fileCache?: string;
// If a 'File Cache' is specified, bundles created before this timestamp will not be file cached.
notBefore?: Timestamp;
};
ParamDefinition インターフェース
BundleDocument で定義されている単一パラメータの仕様。
type ParamDefinition = {
// Whether this parameter is required. If not provided as a query string, an error will be thrown.
required: boolean;
// The type of value which will be parsed, defaults to 'string'.
type?:
| "string"
| "integer"
| "float"
| "boolean"
| "string-array"
| "integer-array"
| "float-array";
};
たとえば、次のパラメータの場合:
params: {
name: {
required: true,
type: 'string',
}
}
バンドルの HTTP エンドポイントにリクエストを送信するときに、クエリ パラメータ（?name=david など）を使用してこのパラメータを指定できます。このパラメータは、バンドルを動的に作成するために、QueryDefinition（以下を参照）の値（$name）内で使用できます。
QueryDefinition インターフェース
クエリ定義は、バンドルに名前付きクエリを作成するために使用されます。queries マップ内のオブジェクトは、オブジェクト キーを名前として使用し、新しい名前付きクエリを作成します。各クエリではコレクションを指定する必要があります。また、実行するクエリ条件のリストを指定することもできます。
type QueryDefinition = {
// The collection to perform the query on.
collection: string;
// An optional list of conditions to perform on the specified collection.
conditions?: QueryCondition[];
};
conditions パラメータには、QueryCondition インターフェースの配列を指定できます。配列の各項目に 1 つの条件を含める必要があります。
type QueryCondition = {
// Performs a `where` filter on the collection on a given FieldPath, operator and value.
where?: [
string,
(
| "<"
| "<="
| "=="
| ">="
| ">"
| "!="
| "array-contains"
| "in"
| "not-in"
| "array-contains-any"
),
any
];
orderBy?: [string, ("asc" | "desc")?];
limit?: number;
limitToLast?: number;
offset?: number;
startAt?: string;
startAfter?: string;
endAt?: string;
endBefore?: string;
};
たとえば、products コレクションに where と limit 条件を含む products という名前のクエリを作成する場合、データ構造の出力は次のようになります。
queries: {
products: {
collection: 'products',
conditions: [
{ where: ['type', '==', 'featured'] },
{ limit: 10 },
],
}
}
Firestore ではネストされた配列値がサポートされていないため、in、not-in、array-contains-any フィルタに配列値を指定する場合は、カンマ区切りで値を指定する必要があります。次に例を示します。
{ where: ['category', 'in', 'womens,shorts'] }, // ['womens', 'shorts']
数字はすべて数値として解析されます。文字列としての数字が必要な場合は、数字を丸かっこで囲んでください。
{ where: ['price', 'in', '1,2.5'] }, // [1, 2.5]
{ where: ['price', 'in', '"1","2.5"'] }, // ['1', '2.5']
条件はパラメータと併用することもできます。たとえば、パラメータ type が定義されている場合（上記を参照）、これを条件値に使用すると、$ 構文で動的データバンドルを提供できます。
// ?type=featured
conditions: [
{ where: ['type', '==', '$type'] },