Ниже приведен обзор спецификаций API Bundle Builder, включая определения TypeScript и подробные описания.
Интерфейс пакета документов
Спецификация отдельного документа в настроенной коллекции:
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;
};
Интерфейс определения параметра
Спецификация одного параметра, определенного в 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 ) для динамического создания пакетов.
Интерфейс определения запроса
Определение запроса используется для создания именованных запросов в пакете. Каждый объект в карте 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 . Каждый элемент массива должен включать только одно условие.
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 с условием «где» и «предел», выходные данные структуры данных должны соответствовать следующему:
queries: {
products: {
collection: 'products',
conditions: [
{ where: ['type', '==', 'featured'] },
{ limit: 10 },
],
}
}
При предоставлении значений массива для фильтров in , not-in или array-contains-any необходимо указывать значение, разделенное запятыми, поскольку значения вложенных массивов не поддерживаются в Firestore. Например:
{ 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'] },