Poniżej znajdziesz omówienie specyfikacji interfejsu Bundle Builder API, w tym definicje i szczegółowe opisy języka TypeScript.
Interfejs BundleDocument
Specyfikacja pojedynczego dokumentu w skonfigurowanej kolekcji:
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;
};
Interfejs ParamDefinition
Specyfikacja pojedynczego parametru zdefiniowanego w polu 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";
};
Na przykład:
params: {
name: {
required: true,
type: 'string',
}
}
Gdy wysyłasz żądanie do punktu końcowego HTTP pakietu, parametr można podać za pomocą parametru zapytania, np. ?name=david. Ten parametr może być używany w obrębie wartości QueryDefinition (patrz poniżej) ($name) do dynamicznego tworzenia pakietów.
Interfejs QueryDefinition
Definicja zapytania służy do tworzenia nazwanych zapytań w pakiecie. Każdy obiekt w mapie queries utworzy nowe zapytanie o nazwie, używając jako nazwy klucza obiektu. Każde zapytanie musi określać kolekcję oraz opcjonalnie listę warunków zapytania.
type QueryDefinition = {
// The collection to perform the query on.
collection: string;
// An optional list of conditions to perform on the specified collection.
conditions?: QueryCondition[];
};
Parametr conditions może zawierać tablicę interfejsów QueryCondition. Każdy element w tablicy musi zawierać tylko 1 warunek.
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;
};
Jeśli na przykład chcesz utworzyć zapytanie o nazwie „products” w zbiorze products z warunkiem where i limit, struktura danych powinna wyglądać tak:
queries: {
products: {
collection: 'products',
conditions: [
{ where: ['type', '==', 'featured'] },
{ limit: 10 },
],
}
}
Gdy podajesz wartości tablicowe do filtrów in, not-in lub array-contains-any, musisz podać wartości rozdzielane przecinkami, ponieważ wartości zagnieżdżonej tablicy nie są obsługiwane w Firestore. Przykład:
{ where: ['category', 'in', 'womens,shorts'] }, // ['womens', 'shorts']
Każda wartość liczbowa zostanie przeanalizowana jako liczba, ale jeśli wymagana jest wartość liczbowa w postaci ciągu znaków, należy ją umieścić w nawiasach:
{ where: ['price', 'in', '1,2.5'] }, // [1, 2.5]
{ where: ['price', 'in', '"1","2.5"'] }, // ['1', '2.5']
Warunków można też używać obok parametrów. Jeśli np. zdefiniujesz parametr type (patrz wyżej), możesz go podać jako wartość warunku, aby za pomocą składni $ udostępnić dynamiczne pakiety danych:
// ?type=featured
conditions: [
{ where: ['type', '==', '$type'] },