@junobuild/functions 0.0.12 → 0.0.13

package/hooks/schemas/db/payload.d.ts

@@ -1,12 +1,9 @@
 import * as z from 'zod';
+import { type DelDoc, type Doc, type SetDoc } from '../../../schemas/db';
 /**
  * @see DocUpsert
  */
 export declare const DocUpsertSchema: z.ZodObject<{
-    /**
-     * The previous version of the document before the update.
-     * Undefined if this is a new document.
-     */
     before: z.ZodOptional<z.ZodObject<{
         owner: z.ZodType<Uint8Array<ArrayBufferLike>, z.ZodTypeDef, Uint8Array<ArrayBufferLike>>;
         data: z.ZodType<Uint8Array<ArrayBufferLike>, z.ZodTypeDef, Uint8Array<ArrayBufferLike>>;
@@ -29,9 +26,6 @@ export declare const DocUpsertSchema: z.ZodObject<{
         description?: string | undefined;
         version?: bigint | undefined;
     }>>;
-    /**
-     * The new version of the document after the update.
-     */
     after: z.ZodObject<{
         owner: z.ZodType<Uint8Array<ArrayBufferLike>, z.ZodTypeDef, Uint8Array<ArrayBufferLike>>;
         data: z.ZodType<Uint8Array<ArrayBufferLike>, z.ZodTypeDef, Uint8Array<ArrayBufferLike>>;
@@ -94,45 +88,21 @@ export declare const DocUpsertSchema: z.ZodObject<{
  *
  * This is used in hooks where a document is either being created or updated.
  */
-export type DocUpsert = z.infer<typeof DocUpsertSchema>;
-/**
- * @see ProposedDoc
- */
-export declare const ProposedDocSchema: z.ZodObject<{
-    /**
-     * The raw data of the document.
-     */
-    data: z.ZodType<Uint8Array<ArrayBufferLike>, z.ZodTypeDef, Uint8Array<ArrayBufferLike>>;
+export interface DocUpsert {
     /**
-     * An optional description of the document.
+     * The previous version of the document before the update.
+     * Undefined if this is a new document.
      */
-    description: z.ZodOptional<z.ZodString>;
+    before?: Doc;
     /**
-     * The expected version number to ensure consistency.
+     * The new version of the document after the update.
      */
-    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;
-}>;
-/**
- * Represents the proposed version of a document.
- * This can be validated before allowing the operation.
- */
-export type ProposedDoc = z.infer<typeof ProposedDocSchema>;
+    after: Doc;
+}
 /**
  * @see DocAssertSet
  */
 export declare const DocAssertSetSchema: z.ZodObject<{
-    /**
-     * The current version of the document before the operation.
-     * Undefined if this is a new document.
-     */
     current: z.ZodOptional<z.ZodObject<{
         owner: z.ZodType<Uint8Array<ArrayBufferLike>, z.ZodTypeDef, Uint8Array<ArrayBufferLike>>;
         data: z.ZodType<Uint8Array<ArrayBufferLike>, z.ZodTypeDef, Uint8Array<ArrayBufferLike>>;
@@ -155,22 +125,9 @@ export declare const DocAssertSetSchema: z.ZodObject<{
         description?: string | undefined;
         version?: bigint | undefined;
     }>>;
-    /**
-     * The proposed version of the document.
-     * This can be validated before allowing the operation.
-     */
     proposed: z.ZodObject<{
-        /**
-         * The raw data of the document.
-         */
         data: z.ZodType<Uint8Array<ArrayBufferLike>, z.ZodTypeDef, Uint8Array<ArrayBufferLike>>;
-        /**
-         * An optional description of the document.
-         */
         description: z.ZodOptional<z.ZodString>;
-        /**
-         * The expected version number to ensure consistency.
-         */
         version: z.ZodOptional<z.ZodBigInt>;
     }, "strict", z.ZodTypeAny, {
         data: Uint8Array<ArrayBufferLike>;
@@ -216,4 +173,91 @@ export declare const DocAssertSetSchema: z.ZodObject<{
  * The developer can compare the `current` and `proposed` versions and
  * throw an error if their validation fails.
  */
-export type DocAssertSet = z.infer<typeof DocAssertSetSchema>;
+export interface DocAssertSet {
+    /**
+     * The current version of the document before the operation.
+     * Undefined if this is a new document.
+     */
+    current?: Doc;
+    /**
+     * The proposed version of the document.
+     * This can be validated before allowing the operation.
+     */
+    proposed: SetDoc;
+}
+/**
+ * @see DocAssertDelete
+ */
+export declare const DocAssertDeleteSchema: 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<{
+        version: z.ZodOptional<z.ZodBigInt>;
+    }, "strict", z.ZodTypeAny, {
+        version?: bigint | undefined;
+    }, {
+        version?: bigint | undefined;
+    }>;
+}, "strict", z.ZodTypeAny, {
+    proposed: {
+        version?: bigint | undefined;
+    };
+    current?: {
+        owner: Uint8Array<ArrayBufferLike>;
+        data: Uint8Array<ArrayBufferLike>;
+        created_at: bigint;
+        updated_at: bigint;
+        description?: string | undefined;
+        version?: bigint | undefined;
+    } | undefined;
+}, {
+    proposed: {
+        version?: bigint | undefined;
+    };
+    current?: {
+        owner: Uint8Array<ArrayBufferLike>;
+        data: Uint8Array<ArrayBufferLike>;
+        created_at: bigint;
+        updated_at: bigint;
+        description?: string | undefined;
+        version?: bigint | undefined;
+    } | undefined;
+}>;
+/**
+ * Represents a validation check before deleting a document.
+ *
+ * The developer can compare the `current` and `proposed` versions and
+ * throw an error if their validation fails.
+ */
+export interface DocAssertDelete {
+    /**
+     * The current version of the document before the operation.
+     * Undefined if the document does not exist.
+     */
+    current?: Doc;
+    /**
+     * The proposed version of the document.
+     * This can be validated before allowing the operation.
+     */
+    proposed: DelDoc;
+}