Confira abaixo uma visão geral das especificações da API Bundle Builder, incluindo definições do TypeScript e descrições detalhadas.
Interface BundleDocument
É a especificação de um único documento dentro da coleção configurada:
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;
};
Interface ParamDefinition
É a especificação de um único parâmetro definido em um 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";
};
Por exemplo, considerando o seguinte parâmetro:
params: {
name: {
required: true,
type: 'string',
}
}
Ao fazer uma solicitação ao endpoint HTTP do pacote, o parâmetro pode ser fornecido por um parâmetro de consulta, por exemplo, ?name=david. O parâmetro pode ser usado em um valor QueryDefinition (veja abaixo) ($name) para criar pacotes dinamicamente.
Interface QueryDefinition
Uma definição de consulta é usada para criar consultas nomeadas no pacote. Cada objeto no mapa queries criará uma nova consulta nomeada usando a chave do objeto como o nome. Cada consulta precisa especificar uma coleção e, opcionalmente, uma lista de condições de consulta a serem executadas.
type QueryDefinition = {
// The collection to perform the query on.
collection: string;
// An optional list of conditions to perform on the specified collection.
conditions?: QueryCondition[];
};
O parâmetro conditions pode conter uma matriz de interfaces QueryCondition. Cada item da matriz precisa incluir apenas uma condição.
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;
};
Por exemplo, para criar uma consulta chamada "products" em uma coleção products com condições "where" e "limit", a saída da estrutura de dados precisa corresponder ao seguinte:
queries: {
products: {
collection: 'products',
conditions: [
{ where: ['type', '==', 'featured'] },
{ limit: 10 },
],
}
}
Ao fornecer valores de matriz aos filtros in, not-in ou array-contains-any, é necessário fornecer um valor separado por vírgulas, já que os valores de matriz aninhados não são compatíveis com o Firestore. Exemplo:
{ where: ['category', 'in', 'womens,shorts'] }, // ['womens', 'shorts']
Qualquer valor numérico será analisado como um número. Porém, se um valor de número de string for obrigatório, é necessário colocá-lo entre parênteses:
{ where: ['price', 'in', '1,2.5'] }, // [1, 2.5]
{ where: ['price', 'in', '"1","2.5"'] }, // ['1', '2.5']
As condições também podem ser usadas com parâmetros. Por exemplo, se um parâmetro type for definido (veja acima), ele poderá ser fornecido a um valor de condição para fornecer pacotes dinâmicos de dados pela sintaxe $:
// ?type=featured
conditions: [
{ where: ['type', '==', '$type'] },