118 lines
2.6 KiB
TypeScript
118 lines
2.6 KiB
TypeScript
export type FileMeta = {
|
|
name: string;
|
|
lastModified: number;
|
|
contentType: string;
|
|
size: number;
|
|
perm: "ro" | "rw";
|
|
noSync?: boolean;
|
|
};
|
|
|
|
export type PageMeta = {
|
|
name: string;
|
|
lastModified: number;
|
|
lastOpened?: number;
|
|
perm: "ro" | "rw";
|
|
};
|
|
|
|
export type AttachmentMeta = {
|
|
name: string;
|
|
contentType: string;
|
|
lastModified: number;
|
|
size: number;
|
|
perm: "ro" | "rw";
|
|
};
|
|
|
|
// Message Queue related types
|
|
export type MQMessage = {
|
|
id: string;
|
|
queue: string;
|
|
body: any;
|
|
retries?: number;
|
|
};
|
|
|
|
export type MQStats = {
|
|
queued: number;
|
|
processing: number;
|
|
dlq: number;
|
|
};
|
|
|
|
export type MQSubscribeOptions = {
|
|
batchSize?: number;
|
|
pollInterval?: number;
|
|
};
|
|
|
|
// Key-Value Store related types
|
|
export type KvKey = string[];
|
|
|
|
export type KV<T = any> = {
|
|
key: KvKey;
|
|
value: T;
|
|
};
|
|
|
|
export type OrderBy = {
|
|
expr: QueryExpression;
|
|
desc: boolean;
|
|
};
|
|
|
|
export type Select = {
|
|
name: string;
|
|
expr?: QueryExpression;
|
|
};
|
|
|
|
export type Query = {
|
|
querySource?: string;
|
|
filter?: QueryExpression;
|
|
orderBy?: OrderBy[];
|
|
select?: Select[];
|
|
limit?: QueryExpression;
|
|
render?: string;
|
|
distinct?: boolean;
|
|
};
|
|
|
|
export type KvQuery = Omit<Query, "querySource"> & {
|
|
prefix?: KvKey;
|
|
};
|
|
|
|
export type QueryExpression =
|
|
| ["and", QueryExpression, QueryExpression]
|
|
| ["or", QueryExpression, QueryExpression]
|
|
| ["=", QueryExpression, QueryExpression]
|
|
| ["!=", QueryExpression, QueryExpression]
|
|
| ["=~", QueryExpression, QueryExpression]
|
|
| ["!=~", QueryExpression, QueryExpression]
|
|
| ["<", QueryExpression, QueryExpression]
|
|
| ["<=", QueryExpression, QueryExpression]
|
|
| [">", QueryExpression, QueryExpression]
|
|
| [">=", QueryExpression, QueryExpression]
|
|
| ["in", QueryExpression, QueryExpression]
|
|
| ["attr", QueryExpression, string]
|
|
| ["attr", string]
|
|
| ["number", number]
|
|
| ["string", string]
|
|
| ["boolean", boolean]
|
|
| ["null"]
|
|
| ["array", QueryExpression[]]
|
|
| ["object", Record<string, any>]
|
|
| ["regexp", string, string] // regex, modifier
|
|
| ["+", QueryExpression, QueryExpression]
|
|
| ["-", QueryExpression, QueryExpression]
|
|
| ["*", QueryExpression, QueryExpression]
|
|
| ["%", QueryExpression, QueryExpression]
|
|
| ["/", QueryExpression, QueryExpression]
|
|
| ["call", string, QueryExpression[]];
|
|
|
|
export type FunctionMap = Record<string, (...args: any[]) => any>;
|
|
|
|
/**
|
|
* An ObjectValue that can be indexed by the `index` plug, needs to have a minimum of
|
|
* of two fields:
|
|
* - ref: a unique reference (id) for the object, ideally a page reference
|
|
* - tags: a list of tags that the object belongs to
|
|
*/
|
|
export type ObjectValue<T> = {
|
|
ref: string;
|
|
tags: string[];
|
|
} & T;
|
|
|
|
export type ObjectQuery = Omit<Query, "prefix">;
|