@junobuild/functions 0.0.3 → 0.0.5

package/dist/types/hooks/context.d.ts

@@ -1,50 +1,509 @@
-import type { RawUserId } from './core';
-import type { DocAssertSet, DocUpsert } from './datastore';
+import * as z from 'zod';
 /**
- * Represents the context provided to hooks, containing information about the caller and related data.
- *
- * @template T - The type of data associated with the hook.
+ * @see HookContext
  */
-export interface HookContext<T> {
+declare const HookContextSchema: <T extends z.ZodTypeAny>(dataSchema: T) => z.ZodObject<{
     /**
      * The user who originally triggered the function that in turn triggered the hook.
      */
-    caller: RawUserId;
+    caller: z.ZodType<Uint8Array<ArrayBufferLike>, z.ZodTypeDef, Uint8Array<ArrayBufferLike>>;
     /**
      * The data associated with the hook execution.
      */
     data: T;
-}
+}, "strict", z.ZodTypeAny, z.objectUtil.addQuestionMarks<z.baseObjectOutputType<{
+    /**
+     * The user who originally triggered the function that in turn triggered the hook.
+     */
+    caller: z.ZodType<Uint8Array<ArrayBufferLike>, z.ZodTypeDef, Uint8Array<ArrayBufferLike>>;
+    /**
+     * The data associated with the hook execution.
+     */
+    data: T;
+}>, any> extends infer T_1 ? { [k in keyof T_1]: z.objectUtil.addQuestionMarks<z.baseObjectOutputType<{
+    /**
+     * The user who originally triggered the function that in turn triggered the hook.
+     */
+    caller: z.ZodType<Uint8Array<ArrayBufferLike>, z.ZodTypeDef, Uint8Array<ArrayBufferLike>>;
+    /**
+     * The data associated with the hook execution.
+     */
+    data: T;
+}>, any>[k]; } : never, z.baseObjectInputType<{
+    /**
+     * The user who originally triggered the function that in turn triggered the hook.
+     */
+    caller: z.ZodType<Uint8Array<ArrayBufferLike>, z.ZodTypeDef, Uint8Array<ArrayBufferLike>>;
+    /**
+     * The data associated with the hook execution.
+     */
+    data: T;
+}> extends infer T_2 ? { [k_1 in keyof T_2]: z.baseObjectInputType<{
+    /**
+     * The user who originally triggered the function that in turn triggered the hook.
+     */
+    caller: z.ZodType<Uint8Array<ArrayBufferLike>, z.ZodTypeDef, Uint8Array<ArrayBufferLike>>;
+    /**
+     * The data associated with the hook execution.
+     */
+    data: T;
+}>[k_1]; } : never>;
 /**
- * Represents the context of a document operation within a collection.
+ * Represents the context provided to hooks, containing information about the caller and related data.
  *
- * @template T - The type of data associated with the document.
+ * @template T - The type of data associated with the hook.
+ */
+export type HookContext<T extends z.ZodTypeAny> = z.infer<ReturnType<typeof HookContextSchema<T>>>;
+/**
+ * @see DocContext
  */
-export interface DocContext<T> {
+export declare const DocContextSchema: <T extends z.ZodTypeAny>(dataSchema: T) => z.ZodObject<{
+    /**
+     * The name of the collection where the document is stored.
+     */
+    collection: z.ZodString;
+    /**
+     * The unique key identifying the document within the collection.
+     */
+    key: z.ZodString;
+    /**
+     * The data associated with the document operation.
+     */
+    data: T;
+}, "strict", z.ZodTypeAny, z.objectUtil.addQuestionMarks<z.baseObjectOutputType<{
+    /**
+     * The name of the collection where the document is stored.
+     */
+    collection: z.ZodString;
+    /**
+     * The unique key identifying the document within the collection.
+     */
+    key: z.ZodString;
+    /**
+     * The data associated with the document operation.
+     */
+    data: T;
+}>, any> extends infer T_1 ? { [k in keyof T_1]: z.objectUtil.addQuestionMarks<z.baseObjectOutputType<{
     /**
      * The name of the collection where the document is stored.
      */
-    collection: string;
+    collection: z.ZodString;
     /**
      * The unique key identifying the document within the collection.
      */
-    key: string;
+    key: z.ZodString;
     /**
      * The data associated with the document operation.
      */
     data: T;
-}
+}>, any>[k]; } : never, z.baseObjectInputType<{
+    /**
+     * The name of the collection where the document is stored.
+     */
+    collection: z.ZodString;
+    /**
+     * The unique key identifying the document within the collection.
+     */
+    key: z.ZodString;
+    /**
+     * The data associated with the document operation.
+     */
+    data: T;
+}> extends infer T_2 ? { [k_1 in keyof T_2]: z.baseObjectInputType<{
+    /**
+     * The name of the collection where the document is stored.
+     */
+    collection: z.ZodString;
+    /**
+     * The unique key identifying the document within the collection.
+     */
+    key: z.ZodString;
+    /**
+     * The data associated with the document operation.
+     */
+    data: T;
+}>[k_1]; } : never>;
+/**
+ * Represents the context of a document operation within a collection.
+ *
+ * @template T - The type of data associated with the document.
+ */
+export type DocContext<T extends z.ZodTypeAny> = z.infer<ReturnType<typeof DocContextSchema<T>>>;
+/**
+ * @see OnSetDocContext
+ */
+export declare const OnSetDocContextSchema: z.ZodObject<{
+    /**
+     * The user who originally triggered the function that in turn triggered the hook.
+     */
+    caller: z.ZodType<Uint8Array<ArrayBufferLike>, z.ZodTypeDef, Uint8Array<ArrayBufferLike>>;
+    /**
+     * The data associated with the hook execution.
+     */
+    data: z.ZodObject<{
+        /**
+         * The name of the collection where the document is stored.
+         */
+        collection: z.ZodString;
+        /**
+         * The unique key identifying the document within the collection.
+         */
+        key: z.ZodString;
+        /**
+         * The data associated with the document operation.
+         */
+        data: z.ZodObject<{
+            before: z.ZodOptional<z.ZodObject<{
+                owner: z.ZodType<Uint8Array<ArrayBufferLike>, z.ZodTypeDef, Uint8Array<ArrayBufferLike>>;
+                data: z.ZodType<Uint8Array<ArrayBufferLike>, z.ZodTypeDef, Uint8Array<ArrayBufferLike>>;
+                description: z.ZodOptional<z.ZodString>;
+                created_at: z.ZodBigInt;
+                updated_at: z.ZodBigInt;
+                version: z.ZodOptional<z.ZodBigInt>;
+            }, "strict", z.ZodTypeAny, {
+                owner: Uint8Array<ArrayBufferLike>;
+                data: Uint8Array<ArrayBufferLike>;
+                created_at: bigint;
+                updated_at: bigint;
+                description?: string | undefined;
+                version?: bigint | undefined;
+            }, {
+                owner: Uint8Array<ArrayBufferLike>;
+                data: Uint8Array<ArrayBufferLike>;
+                created_at: bigint;
+                updated_at: bigint;
+                description?: string | undefined;
+                version?: bigint | undefined;
+            }>>;
+            after: z.ZodObject<{
+                owner: z.ZodType<Uint8Array<ArrayBufferLike>, z.ZodTypeDef, Uint8Array<ArrayBufferLike>>;
+                data: z.ZodType<Uint8Array<ArrayBufferLike>, z.ZodTypeDef, Uint8Array<ArrayBufferLike>>;
+                description: z.ZodOptional<z.ZodString>;
+                created_at: z.ZodBigInt;
+                updated_at: z.ZodBigInt;
+                version: z.ZodOptional<z.ZodBigInt>;
+            }, "strict", z.ZodTypeAny, {
+                owner: Uint8Array<ArrayBufferLike>;
+                data: Uint8Array<ArrayBufferLike>;
+                created_at: bigint;
+                updated_at: bigint;
+                description?: string | undefined;
+                version?: bigint | undefined;
+            }, {
+                owner: Uint8Array<ArrayBufferLike>;
+                data: Uint8Array<ArrayBufferLike>;
+                created_at: bigint;
+                updated_at: bigint;
+                description?: string | undefined;
+                version?: bigint | undefined;
+            }>;
+        }, "strict", z.ZodTypeAny, {
+            after: {
+                owner: Uint8Array<ArrayBufferLike>;
+                data: Uint8Array<ArrayBufferLike>;
+                created_at: bigint;
+                updated_at: bigint;
+                description?: string | undefined;
+                version?: bigint | undefined;
+            };
+            before?: {
+                owner: Uint8Array<ArrayBufferLike>;
+                data: Uint8Array<ArrayBufferLike>;
+                created_at: bigint;
+                updated_at: bigint;
+                description?: string | undefined;
+                version?: bigint | undefined;
+            } | undefined;
+        }, {
+            after: {
+                owner: Uint8Array<ArrayBufferLike>;
+                data: Uint8Array<ArrayBufferLike>;
+                created_at: bigint;
+                updated_at: bigint;
+                description?: string | undefined;
+                version?: bigint | undefined;
+            };
+            before?: {
+                owner: Uint8Array<ArrayBufferLike>;
+                data: Uint8Array<ArrayBufferLike>;
+                created_at: bigint;
+                updated_at: bigint;
+                description?: string | undefined;
+                version?: bigint | undefined;
+            } | undefined;
+        }>;
+    }, "strict", z.ZodTypeAny, {
+        data: {
+            after: {
+                owner: Uint8Array<ArrayBufferLike>;
+                data: Uint8Array<ArrayBufferLike>;
+                created_at: bigint;
+                updated_at: bigint;
+                description?: string | undefined;
+                version?: bigint | undefined;
+            };
+            before?: {
+                owner: Uint8Array<ArrayBufferLike>;
+                data: Uint8Array<ArrayBufferLike>;
+                created_at: bigint;
+                updated_at: bigint;
+                description?: string | undefined;
+                version?: bigint | undefined;
+            } | undefined;
+        };
+        collection: string;
+        key: string;
+    }, {
+        data: {
+            after: {
+                owner: Uint8Array<ArrayBufferLike>;
+                data: Uint8Array<ArrayBufferLike>;
+                created_at: bigint;
+                updated_at: bigint;
+                description?: string | undefined;
+                version?: bigint | undefined;
+            };
+            before?: {
+                owner: Uint8Array<ArrayBufferLike>;
+                data: Uint8Array<ArrayBufferLike>;
+                created_at: bigint;
+                updated_at: bigint;
+                description?: string | undefined;
+                version?: bigint | undefined;
+            } | undefined;
+        };
+        collection: string;
+        key: string;
+    }>;
+}, "strict", z.ZodTypeAny, {
+    data: {
+        data: {
+            after: {
+                owner: Uint8Array<ArrayBufferLike>;
+                data: Uint8Array<ArrayBufferLike>;
+                created_at: bigint;
+                updated_at: bigint;
+                description?: string | undefined;
+                version?: bigint | undefined;
+            };
+            before?: {
+                owner: Uint8Array<ArrayBufferLike>;
+                data: Uint8Array<ArrayBufferLike>;
+                created_at: bigint;
+                updated_at: bigint;
+                description?: string | undefined;
+                version?: bigint | undefined;
+            } | undefined;
+        };
+        collection: string;
+        key: string;
+    };
+    caller: Uint8Array<ArrayBufferLike>;
+}, {
+    data: {
+        data: {
+            after: {
+                owner: Uint8Array<ArrayBufferLike>;
+                data: Uint8Array<ArrayBufferLike>;
+                created_at: bigint;
+                updated_at: bigint;
+                description?: string | undefined;
+                version?: bigint | undefined;
+            };
+            before?: {
+                owner: Uint8Array<ArrayBufferLike>;
+                data: Uint8Array<ArrayBufferLike>;
+                created_at: bigint;
+                updated_at: bigint;
+                description?: string | undefined;
+                version?: bigint | undefined;
+            } | undefined;
+        };
+        collection: string;
+        key: string;
+    };
+    caller: Uint8Array<ArrayBufferLike>;
+}>;
 /**
  * The context provided to the `onSetDoc` hook.
  *
  * This context contains information about the document being created or updated,
  * along with details about the user who triggered the operation.
  */
-export type OnSetDocContext = HookContext<DocContext<DocUpsert>>;
+export type OnSetDocContext = z.infer<typeof OnSetDocContextSchema>;
+/**
+ * @see AssertSetDocContext
+ */
+export declare const AssertSetDocContextSchema: z.ZodObject<{
+    /**
+     * The user who originally triggered the function that in turn triggered the hook.
+     */
+    caller: z.ZodType<Uint8Array<ArrayBufferLike>, z.ZodTypeDef, Uint8Array<ArrayBufferLike>>;
+    /**
+     * The data associated with the hook execution.
+     */
+    data: z.ZodObject<{
+        /**
+         * The name of the collection where the document is stored.
+         */
+        collection: z.ZodString;
+        /**
+         * The unique key identifying the document within the collection.
+         */
+        key: z.ZodString;
+        /**
+         * The data associated with the document operation.
+         */
+        data: z.ZodObject<{
+            current: z.ZodOptional<z.ZodObject<{
+                owner: z.ZodType<Uint8Array<ArrayBufferLike>, z.ZodTypeDef, Uint8Array<ArrayBufferLike>>;
+                data: z.ZodType<Uint8Array<ArrayBufferLike>, z.ZodTypeDef, Uint8Array<ArrayBufferLike>>;
+                description: z.ZodOptional<z.ZodString>;
+                created_at: z.ZodBigInt;
+                updated_at: z.ZodBigInt;
+                version: z.ZodOptional<z.ZodBigInt>;
+            }, "strict", z.ZodTypeAny, {
+                owner: Uint8Array<ArrayBufferLike>;
+                data: Uint8Array<ArrayBufferLike>;
+                created_at: bigint;
+                updated_at: bigint;
+                description?: string | undefined;
+                version?: bigint | undefined;
+            }, {
+                owner: Uint8Array<ArrayBufferLike>;
+                data: Uint8Array<ArrayBufferLike>;
+                created_at: bigint;
+                updated_at: bigint;
+                description?: string | undefined;
+                version?: bigint | undefined;
+            }>>;
+            proposed: z.ZodObject<{
+                data: z.ZodType<Uint8Array<ArrayBufferLike>, z.ZodTypeDef, Uint8Array<ArrayBufferLike>>;
+                description: z.ZodOptional<z.ZodString>;
+                version: z.ZodOptional<z.ZodBigInt>;
+            }, "strict", z.ZodTypeAny, {
+                data: Uint8Array<ArrayBufferLike>;
+                description?: string | undefined;
+                version?: bigint | undefined;
+            }, {
+                data: Uint8Array<ArrayBufferLike>;
+                description?: string | undefined;
+                version?: bigint | undefined;
+            }>;
+        }, "strict", z.ZodTypeAny, {
+            proposed: {
+                data: Uint8Array<ArrayBufferLike>;
+                description?: string | undefined;
+                version?: bigint | undefined;
+            };
+            current?: {
+                owner: Uint8Array<ArrayBufferLike>;
+                data: Uint8Array<ArrayBufferLike>;
+                created_at: bigint;
+                updated_at: bigint;
+                description?: string | undefined;
+                version?: bigint | undefined;
+            } | undefined;
+        }, {
+            proposed: {
+                data: Uint8Array<ArrayBufferLike>;
+                description?: string | undefined;
+                version?: bigint | undefined;
+            };
+            current?: {
+                owner: Uint8Array<ArrayBufferLike>;
+                data: Uint8Array<ArrayBufferLike>;
+                created_at: bigint;
+                updated_at: bigint;
+                description?: string | undefined;
+                version?: bigint | undefined;
+            } | undefined;
+        }>;
+    }, "strict", z.ZodTypeAny, {
+        data: {
+            proposed: {
+                data: Uint8Array<ArrayBufferLike>;
+                description?: string | undefined;
+                version?: bigint | undefined;
+            };
+            current?: {
+                owner: Uint8Array<ArrayBufferLike>;
+                data: Uint8Array<ArrayBufferLike>;
+                created_at: bigint;
+                updated_at: bigint;
+                description?: string | undefined;
+                version?: bigint | undefined;
+            } | undefined;
+        };
+        collection: string;
+        key: string;
+    }, {
+        data: {
+            proposed: {
+                data: Uint8Array<ArrayBufferLike>;
+                description?: string | undefined;
+                version?: bigint | undefined;
+            };
+            current?: {
+                owner: Uint8Array<ArrayBufferLike>;
+                data: Uint8Array<ArrayBufferLike>;
+                created_at: bigint;
+                updated_at: bigint;
+                description?: string | undefined;
+                version?: bigint | undefined;
+            } | undefined;
+        };
+        collection: string;
+        key: string;
+    }>;
+}, "strict", z.ZodTypeAny, {
+    data: {
+        data: {
+            proposed: {
+                data: Uint8Array<ArrayBufferLike>;
+                description?: string | undefined;
+                version?: bigint | undefined;
+            };
+            current?: {
+                owner: Uint8Array<ArrayBufferLike>;
+                data: Uint8Array<ArrayBufferLike>;
+                created_at: bigint;
+                updated_at: bigint;
+                description?: string | undefined;
+                version?: bigint | undefined;
+            } | undefined;
+        };
+        collection: string;
+        key: string;
+    };
+    caller: Uint8Array<ArrayBufferLike>;
+}, {
+    data: {
+        data: {
+            proposed: {
+                data: Uint8Array<ArrayBufferLike>;
+                description?: string | undefined;
+                version?: bigint | undefined;
+            };
+            current?: {
+                owner: Uint8Array<ArrayBufferLike>;
+                data: Uint8Array<ArrayBufferLike>;
+                created_at: bigint;
+                updated_at: bigint;
+                description?: string | undefined;
+                version?: bigint | undefined;
+            } | undefined;
+        };
+        collection: string;
+        key: string;
+    };
+    caller: Uint8Array<ArrayBufferLike>;
+}>;
 /**
  * The context provided to the `assertSetDoc` hook.
  *
  * This context contains information about the document being validated before
  * it is created or updated. If validation fails, the developer should throw an error.
  */
-export type AssertSetDocContext = HookContext<DocContext<DocAssertSet>>;
+export type AssertSetDocContext = z.infer<typeof AssertSetDocContextSchema>;
+export {};

package/dist/types/hooks/core.d.ts

@@ -1,30 +1,51 @@
+import * as z from 'zod';
+/**
+ * @see Timestamp
+ */
+export declare const TimestampSchema: z.ZodBigInt;
 /**
  * Represents a timestamp in nanoseconds since the Unix epoch.
  *
  * Used for tracking when events occur, such as document creation and updates.
  */
-export type Timestamp = bigint;
+export type Timestamp = z.infer<typeof TimestampSchema>;
+/**
+ * @see Version
+ */
+export declare const VersionSchema: z.ZodBigInt;
 /**
  * Represents a version number for tracking changes.
  *
  * This is typically incremented with each update to ensure consistency.
  */
-export type Version = bigint;
+export type Version = z.infer<typeof VersionSchema>;
+/**
+ * @see RawData
+ */
+export declare const RawDataSchema: z.ZodType<Uint8Array<ArrayBufferLike>, z.ZodTypeDef, Uint8Array<ArrayBufferLike>>;
 /**
  * Represents raw binary data.
  *
  * This is used to store unstructured data in a document.
  */
-export type RawData = Uint8Array;
+export type RawData = z.infer<typeof RawDataSchema>;
+/**
+ * @see RawPrincipal
+ */
+export declare const RawPrincipalSchema: z.ZodType<Uint8Array<ArrayBufferLike>, z.ZodTypeDef, Uint8Array<ArrayBufferLike>>;
 /**
  * Represents a raw principal identifier.
  *
  * Principals are unique identities used in authentication and authorization.
  */
-export type RawPrincipal = Uint8Array;
+export type RawPrincipal = z.infer<typeof RawPrincipalSchema>;
+/**
+ * @see RawUserId
+ */
+export declare const RawUserIdSchema: z.ZodType<Uint8Array<ArrayBufferLike>, z.ZodTypeDef, Uint8Array<ArrayBufferLike>>;
 /**
  * Represents a raw user identifier.
  *
  * This is a principal associated with a user.
  */
-export type RawUserId = RawPrincipal;
+export type RawUserId = z.infer<typeof RawUserIdSchema>;