@junobuild/functions 0.0.3 → 0.0.5

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

@@ -1,85 +1,364 @@
-import type { RawData, RawUserId, Timestamp, Version } from './core';
+import * as z from 'zod';
 /**
- * Represents a document update operation.
- *
- * This is used in hooks where a document is either being created or updated.
+ * @see DocDescription
+ */
+export declare const DocDescriptionSchema: z.ZodString;
+/**
+ * Represents a document description with a maximum length of 1024 characters.
  */
-export interface DocUpsert {
+export type DocDescription = z.infer<typeof DocDescriptionSchema>;
+/**
+ * @see Doc
+ */
+export declare const DocSchema: z.ZodObject<{
     /**
-     * The previous version of the document before the update.
-     * Undefined if this is a new document.
+     * The user who owns this document.
      */
-    before?: Doc;
+    owner: z.ZodType<Uint8Array<ArrayBufferLike>, z.ZodTypeDef, Uint8Array<ArrayBufferLike>>;
     /**
-     * The new version of the document after the update.
+     * The raw data of the document.
      */
-    after: Doc;
-}
-/**
- * Represents a validation check before setting a document.
- *
- * The developer can compare the `current` and `proposed` versions and
- * throw an error if their validation fails.
- */
-export interface DocAssertSet {
+    data: z.ZodType<Uint8Array<ArrayBufferLike>, z.ZodTypeDef, Uint8Array<ArrayBufferLike>>;
     /**
-     * The current version of the document before the operation.
-     * Undefined if this is a new document.
+     * An optional description of the document.
      */
-    current?: Doc;
+    description: z.ZodOptional<z.ZodString>;
     /**
-     * The proposed version of the document.
-     * This can be validated before allowing the operation.
+     * The timestamp when the document was first created.
+     */
+    created_at: z.ZodBigInt;
+    /**
+     * The timestamp when the document was last updated.
      */
-    proposed: SetDoc;
-}
+    updated_at: z.ZodBigInt;
+    /**
+     * The version number of the document, used for consistency checks.
+     * If not provided, it's assumed to be the first version.
+     */
+    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;
+}>;
 /**
  * Represents a document stored in a collection.
  */
-export interface Doc {
+export type Doc = z.infer<typeof DocSchema>;
+/**
+ * @see DocUpsert
+ */
+export declare const DocUpsertSchema: z.ZodObject<{
     /**
-     * The user who owns this document.
+     * The previous version of the document before the update.
+     * Undefined if this is a new document.
      */
-    owner: RawUserId;
+    before: z.ZodOptional<z.ZodObject<{
+        /**
+         * The user who owns this document.
+         */
+        owner: z.ZodType<Uint8Array<ArrayBufferLike>, z.ZodTypeDef, Uint8Array<ArrayBufferLike>>;
+        /**
+         * 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 timestamp when the document was first created.
+         */
+        created_at: z.ZodBigInt;
+        /**
+         * The timestamp when the document was last updated.
+         */
+        updated_at: z.ZodBigInt;
+        /**
+         * The version number of the document, used for consistency checks.
+         * If not provided, it's assumed to be the first version.
+         */
+        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;
+    }>>;
+    /**
+     * The new version of the document after the update.
+     */
+    after: z.ZodObject<{
+        /**
+         * The user who owns this document.
+         */
+        owner: z.ZodType<Uint8Array<ArrayBufferLike>, z.ZodTypeDef, Uint8Array<ArrayBufferLike>>;
+        /**
+         * 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 timestamp when the document was first created.
+         */
+        created_at: z.ZodBigInt;
+        /**
+         * The timestamp when the document was last updated.
+         */
+        updated_at: z.ZodBigInt;
+        /**
+         * The version number of the document, used for consistency checks.
+         * If not provided, it's assumed to be the first version.
+         */
+        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;
+}>;
+/**
+ * Represents a document update operation.
+ *
+ * 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: RawData;
+    data: z.ZodType<Uint8Array<ArrayBufferLike>, z.ZodTypeDef, Uint8Array<ArrayBufferLike>>;
     /**
      * An optional description of the document.
      */
-    description?: string;
+    description: z.ZodOptional<z.ZodString>;
     /**
-     * The timestamp when the document was first created.
+     * The expected version number to ensure consistency.
      */
-    created_at: Timestamp;
+    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>;
+/**
+ * @see DocAssertSet
+ */
+export declare const DocAssertSetSchema: z.ZodObject<{
     /**
-     * The timestamp when the document was last updated.
+     * The current version of the document before the operation.
+     * Undefined if this is a new document.
      */
-    updated_at: Timestamp;
+    current: z.ZodOptional<z.ZodObject<{
+        /**
+         * The user who owns this document.
+         */
+        owner: z.ZodType<Uint8Array<ArrayBufferLike>, z.ZodTypeDef, Uint8Array<ArrayBufferLike>>;
+        /**
+         * 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 timestamp when the document was first created.
+         */
+        created_at: z.ZodBigInt;
+        /**
+         * The timestamp when the document was last updated.
+         */
+        updated_at: z.ZodBigInt;
+        /**
+         * The version number of the document, used for consistency checks.
+         * If not provided, it's assumed to be the first version.
+         */
+        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;
+    }>>;
     /**
-     * The version number of the document, used for consistency checks.
-     * If not provided, it's assumed to be the first version.
+     * The proposed version of the document.
+     * This can be validated before allowing the operation.
      */
-    version?: Version;
-}
+    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>;
+        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;
+}>;
 /**
- * Represents a request to set or update a document.
+ * Represents a validation check before setting a document.
  *
- * This is used when submitting new document data.
+ * The developer can compare the `current` and `proposed` versions and
+ * throw an error if their validation fails.
+ */
+export type DocAssertSet = z.infer<typeof DocAssertSetSchema>;
+/**
+ * @see SetDoc
  */
-export interface SetDoc {
+export declare const SetDocSchema: z.ZodObject<{
     /**
      * The raw data of the document.
      */
-    data: RawData;
+    data: z.ZodType<Uint8Array<ArrayBufferLike>, z.ZodTypeDef, Uint8Array<ArrayBufferLike>>;
     /**
      * An optional description of the document.
      */
-    description?: string;
+    description: z.ZodOptional<z.ZodString>;
     /**
      * The expected version number to ensure consistency.
      * If provided, the operation will fail if the stored version does not match.
      */
-    version?: Version;
-}
+    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 a request to set or update a document.
+ *
+ * This is used when submitting new document data.
+ */
+export type SetDoc = z.infer<typeof SetDocSchema>;

package/dist/types/index.d.ts

@@ -1,9 +1,9 @@
-export type * from './configs/collection.config';
-export type * from './configs/satellite.config';
-export type * from './hooks/context';
-export type * from './hooks/core';
-export type * from './hooks/datastore';
-export * from './configs/assert.config';
-export * from './configs/hook.config';
+export * from './configs/assertions';
+export * from './configs/collections.config';
+export * from './configs/hooks';
+export * from './configs/satellite.env';
+export * from './hooks/context';
+export * from './hooks/core';
+export * from './hooks/datastore';
 export * from './sdk/datastore.sdk';
 import './polyfills/console.polyfill';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@junobuild/functions",
-  "version": "0.0.3",
+  "version": "0.0.5",
   "description": "JavaScript and TypeScript utilities for Juno Serverless Functions",
   "author": "David Dal Busco (https://daviddalbusco.com)",
   "license": "MIT",
@@ -37,6 +37,7 @@
   },
   "homepage": "https://juno.build",
   "peerDependencies": {
-    "@dfinity/utils": "^2"
+    "@dfinity/utils": "^2",
+    "zod": "^3"
   }
 }

package/dist/types/configs/assert.config.d.ts

@@ -1,30 +0,0 @@
-import type { AssertSetDocContext } from '../hooks/context';
-import type { CollectionsConfig } from './collection.config';
-import type { SatelliteConfigEnv } from './satellite.config';
-/**
- * The generic configuration for assertion hooks that manage collections.
- */
-export interface AssertAssertConfig extends CollectionsConfig {
-    assertSetDoc: never;
-}
-/**
- * A configuration object that includes the `assertSetDoc` function.
- * This function is called to validate a document before it is created or updated.
- */
-export interface AssertSetDocConfig extends Omit<AssertAssertConfig, 'assertSetDoc'> {
-    /**
-     * A function that runs synchronously before a document is set in the Datastore.
-     * This can be used to enforce your validation rules.
-     *
-     * @param {AssertSetDocContext} context - Provides details about the document being validated.
-     * @throws {Error} If your validation fails, throw an exception to prevent the document from being saved.
-     *
-     */
-    assertSetDoc: (context: AssertSetDocContext) => void;
-}
-export type AssertConfig = AssertSetDocConfig;
-export type AssertFn = (config: SatelliteConfigEnv) => AssertConfig;
-export type AssertFnOrObject = AssertConfig | AssertFn;
-export declare function defineAssert(config: AssertConfig): AssertConfig;
-export declare function defineAssert(config: AssertFn): AssertFn;
-export declare function defineAssert(config: AssertFnOrObject): AssertFnOrObject;

package/dist/types/configs/collection.config.d.ts

@@ -1,9 +0,0 @@
-/**
- * Defines the collections where a hook or assertion should run.
- */
-export interface CollectionsConfig {
-    /**
-     * A list of collection names where the hook or assertion will be executed.
-     */
-    collections: string[];
-}

package/dist/types/configs/hook.config.d.ts

@@ -1,28 +0,0 @@
-import type { OnSetDocContext } from '../hooks/context';
-import type { CollectionsConfig } from './collection.config';
-import type { SatelliteConfigEnv } from './satellite.config';
-/**
- * The generic configuration for hooks that manage collections.
- */
-export interface OnHookConfig extends CollectionsConfig {
-    onSetDoc: never;
-}
-/**
- * A configuration object that includes the `onSetDoc` function.
- * This function is called when a document is created or updated.
- */
-export interface OnSetDocConfig extends Omit<OnHookConfig, 'onSetDoc'> {
-    /**
-     * A function that runs when a document is set in the Datastore.
-     *
-     * @param {OnSetDocContext} context - Provides details about the document being saved.
-     * @returns {Promise<void>} Resolves when your operation is complete.
-     */
-    onSetDoc: (context: OnSetDocContext) => Promise<void>;
-}
-export type HookConfig = OnSetDocConfig;
-export type HookFn = (config: SatelliteConfigEnv) => HookConfig;
-export type HookFnOrObject = HookConfig | HookFn;
-export declare function defineHook(config: HookConfig): HookConfig;
-export declare function defineHook(config: HookFn): HookFn;
-export declare function defineHook(config: HookFnOrObject): HookFnOrObject;