@junobuild/functions 0.0.15 → 0.1.0

package/schemas/list.d.ts

@@ -0,0 +1,428 @@
+import * as z from 'zod';
+import { type Description, type Key, type RawUserId, type Timestamp } from './satellite';
+/**
+ * @see TimestampMatcher
+ */
+export declare const TimestampMatcherSchema: z.ZodUnion<[z.ZodObject<{
+    equal: z.ZodBigInt;
+}, "strip", z.ZodTypeAny, {
+    equal: bigint;
+}, {
+    equal: bigint;
+}>, z.ZodObject<{
+    greater_than: z.ZodBigInt;
+}, "strip", z.ZodTypeAny, {
+    greater_than: bigint;
+}, {
+    greater_than: bigint;
+}>, z.ZodObject<{
+    less_than: z.ZodBigInt;
+}, "strip", z.ZodTypeAny, {
+    less_than: bigint;
+}, {
+    less_than: bigint;
+}>, z.ZodObject<{
+    between: z.ZodTuple<[z.ZodBigInt, z.ZodBigInt], null>;
+}, "strip", z.ZodTypeAny, {
+    between: [bigint, bigint];
+}, {
+    between: [bigint, bigint];
+}>]>;
+/**
+ * TimestampMatcher matches a timestamp field using a specific strategy.
+ */
+export type TimestampMatcher = {
+    equal: Timestamp;
+} | {
+    greater_than: Timestamp;
+} | {
+    less_than: Timestamp;
+} | {
+    between: [Timestamp, Timestamp];
+};
+/**
+ * @see ListMatcher
+ */
+export declare const ListMatcherSchema: z.ZodObject<{
+    key: z.ZodOptional<z.ZodString>;
+    description: z.ZodOptional<z.ZodString>;
+    created_at: z.ZodOptional<z.ZodUnion<[z.ZodObject<{
+        equal: z.ZodBigInt;
+    }, "strip", z.ZodTypeAny, {
+        equal: bigint;
+    }, {
+        equal: bigint;
+    }>, z.ZodObject<{
+        greater_than: z.ZodBigInt;
+    }, "strip", z.ZodTypeAny, {
+        greater_than: bigint;
+    }, {
+        greater_than: bigint;
+    }>, z.ZodObject<{
+        less_than: z.ZodBigInt;
+    }, "strip", z.ZodTypeAny, {
+        less_than: bigint;
+    }, {
+        less_than: bigint;
+    }>, z.ZodObject<{
+        between: z.ZodTuple<[z.ZodBigInt, z.ZodBigInt], null>;
+    }, "strip", z.ZodTypeAny, {
+        between: [bigint, bigint];
+    }, {
+        between: [bigint, bigint];
+    }>]>>;
+    updated_at: z.ZodOptional<z.ZodUnion<[z.ZodObject<{
+        equal: z.ZodBigInt;
+    }, "strip", z.ZodTypeAny, {
+        equal: bigint;
+    }, {
+        equal: bigint;
+    }>, z.ZodObject<{
+        greater_than: z.ZodBigInt;
+    }, "strip", z.ZodTypeAny, {
+        greater_than: bigint;
+    }, {
+        greater_than: bigint;
+    }>, z.ZodObject<{
+        less_than: z.ZodBigInt;
+    }, "strip", z.ZodTypeAny, {
+        less_than: bigint;
+    }, {
+        less_than: bigint;
+    }>, z.ZodObject<{
+        between: z.ZodTuple<[z.ZodBigInt, z.ZodBigInt], null>;
+    }, "strip", z.ZodTypeAny, {
+        between: [bigint, bigint];
+    }, {
+        between: [bigint, bigint];
+    }>]>>;
+}, "strict", z.ZodTypeAny, {
+    description?: string | undefined;
+    created_at?: {
+        equal: bigint;
+    } | {
+        greater_than: bigint;
+    } | {
+        less_than: bigint;
+    } | {
+        between: [bigint, bigint];
+    } | undefined;
+    updated_at?: {
+        equal: bigint;
+    } | {
+        greater_than: bigint;
+    } | {
+        less_than: bigint;
+    } | {
+        between: [bigint, bigint];
+    } | undefined;
+    key?: string | undefined;
+}, {
+    description?: string | undefined;
+    created_at?: {
+        equal: bigint;
+    } | {
+        greater_than: bigint;
+    } | {
+        less_than: bigint;
+    } | {
+        between: [bigint, bigint];
+    } | undefined;
+    updated_at?: {
+        equal: bigint;
+    } | {
+        greater_than: bigint;
+    } | {
+        less_than: bigint;
+    } | {
+        between: [bigint, bigint];
+    } | undefined;
+    key?: string | undefined;
+}>;
+/**
+ * Matcher used to filter list results.
+ */
+export interface ListMatcher {
+    key?: Key;
+    description?: Description;
+    created_at?: TimestampMatcher;
+    updated_at?: TimestampMatcher;
+}
+/**
+ * @see ListPaginate
+ */
+export declare const ListPaginateSchema: z.ZodObject<{
+    start_after: z.ZodOptional<z.ZodString>;
+    limit: z.ZodOptional<z.ZodBigInt>;
+}, "strict", z.ZodTypeAny, {
+    start_after?: string | undefined;
+    limit?: bigint | undefined;
+}, {
+    start_after?: string | undefined;
+    limit?: bigint | undefined;
+}>;
+/**
+ * Optional pagination controls for listing.
+ */
+export interface ListPaginate {
+    start_after?: Key;
+    limit?: bigint;
+}
+/**
+ * @see ListOrderField
+ */
+export declare const ListOrderFieldSchema: z.ZodEnum<["keys", "created_at", "updated_at"]>;
+/**
+ * Enum representing possible fields to order by.
+ */
+export type ListOrderField = 'keys' | 'updated_at' | 'created_at';
+/**
+ * @see ListOrder
+ */
+export declare const ListOrderSchema: z.ZodObject<{
+    desc: z.ZodBoolean;
+    field: z.ZodEnum<["keys", "created_at", "updated_at"]>;
+}, "strict", z.ZodTypeAny, {
+    desc: boolean;
+    field: "keys" | "created_at" | "updated_at";
+}, {
+    desc: boolean;
+    field: "keys" | "created_at" | "updated_at";
+}>;
+/**
+ * Ordering strategy for listing documents.
+ */
+export interface ListOrder {
+    desc: boolean;
+    field: ListOrderField;
+}
+/**
+ * @see ListParams
+ */
+export declare const ListParamsSchema: z.ZodObject<{
+    matcher: z.ZodOptional<z.ZodObject<{
+        key: z.ZodOptional<z.ZodString>;
+        description: z.ZodOptional<z.ZodString>;
+        created_at: z.ZodOptional<z.ZodUnion<[z.ZodObject<{
+            equal: z.ZodBigInt;
+        }, "strip", z.ZodTypeAny, {
+            equal: bigint;
+        }, {
+            equal: bigint;
+        }>, z.ZodObject<{
+            greater_than: z.ZodBigInt;
+        }, "strip", z.ZodTypeAny, {
+            greater_than: bigint;
+        }, {
+            greater_than: bigint;
+        }>, z.ZodObject<{
+            less_than: z.ZodBigInt;
+        }, "strip", z.ZodTypeAny, {
+            less_than: bigint;
+        }, {
+            less_than: bigint;
+        }>, z.ZodObject<{
+            between: z.ZodTuple<[z.ZodBigInt, z.ZodBigInt], null>;
+        }, "strip", z.ZodTypeAny, {
+            between: [bigint, bigint];
+        }, {
+            between: [bigint, bigint];
+        }>]>>;
+        updated_at: z.ZodOptional<z.ZodUnion<[z.ZodObject<{
+            equal: z.ZodBigInt;
+        }, "strip", z.ZodTypeAny, {
+            equal: bigint;
+        }, {
+            equal: bigint;
+        }>, z.ZodObject<{
+            greater_than: z.ZodBigInt;
+        }, "strip", z.ZodTypeAny, {
+            greater_than: bigint;
+        }, {
+            greater_than: bigint;
+        }>, z.ZodObject<{
+            less_than: z.ZodBigInt;
+        }, "strip", z.ZodTypeAny, {
+            less_than: bigint;
+        }, {
+            less_than: bigint;
+        }>, z.ZodObject<{
+            between: z.ZodTuple<[z.ZodBigInt, z.ZodBigInt], null>;
+        }, "strip", z.ZodTypeAny, {
+            between: [bigint, bigint];
+        }, {
+            between: [bigint, bigint];
+        }>]>>;
+    }, "strict", z.ZodTypeAny, {
+        description?: string | undefined;
+        created_at?: {
+            equal: bigint;
+        } | {
+            greater_than: bigint;
+        } | {
+            less_than: bigint;
+        } | {
+            between: [bigint, bigint];
+        } | undefined;
+        updated_at?: {
+            equal: bigint;
+        } | {
+            greater_than: bigint;
+        } | {
+            less_than: bigint;
+        } | {
+            between: [bigint, bigint];
+        } | undefined;
+        key?: string | undefined;
+    }, {
+        description?: string | undefined;
+        created_at?: {
+            equal: bigint;
+        } | {
+            greater_than: bigint;
+        } | {
+            less_than: bigint;
+        } | {
+            between: [bigint, bigint];
+        } | undefined;
+        updated_at?: {
+            equal: bigint;
+        } | {
+            greater_than: bigint;
+        } | {
+            less_than: bigint;
+        } | {
+            between: [bigint, bigint];
+        } | undefined;
+        key?: string | undefined;
+    }>>;
+    paginate: z.ZodOptional<z.ZodObject<{
+        start_after: z.ZodOptional<z.ZodString>;
+        limit: z.ZodOptional<z.ZodBigInt>;
+    }, "strict", z.ZodTypeAny, {
+        start_after?: string | undefined;
+        limit?: bigint | undefined;
+    }, {
+        start_after?: string | undefined;
+        limit?: bigint | undefined;
+    }>>;
+    order: z.ZodOptional<z.ZodObject<{
+        desc: z.ZodBoolean;
+        field: z.ZodEnum<["keys", "created_at", "updated_at"]>;
+    }, "strict", z.ZodTypeAny, {
+        desc: boolean;
+        field: "keys" | "created_at" | "updated_at";
+    }, {
+        desc: boolean;
+        field: "keys" | "created_at" | "updated_at";
+    }>>;
+    owner: z.ZodOptional<z.ZodType<Uint8Array<ArrayBufferLike>, z.ZodTypeDef, Uint8Array<ArrayBufferLike>>>;
+}, "strict", z.ZodTypeAny, {
+    owner?: Uint8Array<ArrayBufferLike> | undefined;
+    matcher?: {
+        description?: string | undefined;
+        created_at?: {
+            equal: bigint;
+        } | {
+            greater_than: bigint;
+        } | {
+            less_than: bigint;
+        } | {
+            between: [bigint, bigint];
+        } | undefined;
+        updated_at?: {
+            equal: bigint;
+        } | {
+            greater_than: bigint;
+        } | {
+            less_than: bigint;
+        } | {
+            between: [bigint, bigint];
+        } | undefined;
+        key?: string | undefined;
+    } | undefined;
+    paginate?: {
+        start_after?: string | undefined;
+        limit?: bigint | undefined;
+    } | undefined;
+    order?: {
+        desc: boolean;
+        field: "keys" | "created_at" | "updated_at";
+    } | undefined;
+}, {
+    owner?: Uint8Array<ArrayBufferLike> | undefined;
+    matcher?: {
+        description?: string | undefined;
+        created_at?: {
+            equal: bigint;
+        } | {
+            greater_than: bigint;
+        } | {
+            less_than: bigint;
+        } | {
+            between: [bigint, bigint];
+        } | undefined;
+        updated_at?: {
+            equal: bigint;
+        } | {
+            greater_than: bigint;
+        } | {
+            less_than: bigint;
+        } | {
+            between: [bigint, bigint];
+        } | undefined;
+        key?: string | undefined;
+    } | undefined;
+    paginate?: {
+        start_after?: string | undefined;
+        limit?: bigint | undefined;
+    } | undefined;
+    order?: {
+        desc: boolean;
+        field: "keys" | "created_at" | "updated_at";
+    } | undefined;
+}>;
+/**
+ * Full set of listing parameters.
+ */
+export interface ListParams {
+    matcher?: ListMatcher;
+    paginate?: ListPaginate;
+    order?: ListOrder;
+    owner?: RawUserId;
+}
+/**
+ * Represents a list result.
+ *
+ * @template T - The type of the data returned per item.
+ * @see JsListResults
+ */
+export declare const createListResultsSchema: <T extends z.ZodTypeAny>(itemData: T) => z.ZodObject<{
+    items: z.ZodArray<z.ZodTuple<[z.ZodString, T], null>, "many">;
+    items_length: z.ZodBigInt;
+    items_page: z.ZodOptional<z.ZodBigInt>;
+    matches_length: z.ZodBigInt;
+    matches_pages: z.ZodOptional<z.ZodBigInt>;
+}, "strict", z.ZodTypeAny, {
+    items: [string, T extends z.ZodType<any, any, any> ? T["_output"] : never][];
+    items_length: bigint;
+    matches_length: bigint;
+    items_page?: bigint | undefined;
+    matches_pages?: bigint | undefined;
+}, {
+    items: [string, T extends z.ZodType<any, any, any> ? T["_input"] : never][];
+    items_length: bigint;
+    matches_length: bigint;
+    items_page?: bigint | undefined;
+    matches_pages?: bigint | undefined;
+}>;
+/**
+ * List results, parameterized by type of returned item.
+ */
+export interface ListResults<T> {
+    items: [Key, T][];
+    items_length: bigint;
+    items_page?: bigint;
+    matches_length: bigint;
+    matches_pages?: bigint;
+}