@junobuild/functions 0.0.4 → 0.0.6-next-2025-03-15

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

@@ -0,0 +1,109 @@
+import * as z from 'zod';
+/**
+ * @see SetDoc
+ */
+export declare const SetDocSchema: z.ZodObject<{
+    /**
+     * The unique key identifying the document within the collection.
+     */
+    key: z.ZodString;
+    /**
+     * An optional description of the document.
+     */
+    description: z.ZodOptional<z.ZodString>;
+    /**
+     * The raw data of the document.
+     */
+    data: z.ZodType<Uint8Array<ArrayBufferLike>, z.ZodTypeDef, Uint8Array<ArrayBufferLike>>;
+    /**
+     * The expected version number to ensure consistency.
+     * If provided, the operation will fail if the stored version does not match.
+     */
+    version: z.ZodOptional<z.ZodBigInt>;
+}, "strict", z.ZodTypeAny, {
+    data: Uint8Array<ArrayBufferLike>;
+    key: string;
+    description?: string | undefined;
+    version?: bigint | undefined;
+}, {
+    data: Uint8Array<ArrayBufferLike>;
+    key: string;
+    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>;
+/**
+ * @see SetDocStoreParams
+ */
+export declare const SetDocStoreParamsSchema: z.ZodObject<{
+    /**
+     * The caller who initiate the document operation.
+     */
+    caller: z.ZodType<Uint8Array<ArrayBufferLike>, z.ZodTypeDef, Uint8Array<ArrayBufferLike>>;
+    /**
+     * The name of the collection where the document is stored.
+     */
+    collection: z.ZodString;
+    /**
+     * The data, key and other information required to create or update a document.
+     */
+    doc: z.ZodObject<{
+        /**
+         * The unique key identifying the document within the collection.
+         */
+        key: z.ZodString;
+        /**
+         * An optional description of the document.
+         */
+        description: z.ZodOptional<z.ZodString>;
+        /**
+         * The raw data of the document.
+         */
+        data: z.ZodType<Uint8Array<ArrayBufferLike>, z.ZodTypeDef, Uint8Array<ArrayBufferLike>>;
+        /**
+         * The expected version number to ensure consistency.
+         * If provided, the operation will fail if the stored version does not match.
+         */
+        version: z.ZodOptional<z.ZodBigInt>;
+    }, "strict", z.ZodTypeAny, {
+        data: Uint8Array<ArrayBufferLike>;
+        key: string;
+        description?: string | undefined;
+        version?: bigint | undefined;
+    }, {
+        data: Uint8Array<ArrayBufferLike>;
+        key: string;
+        description?: string | undefined;
+        version?: bigint | undefined;
+    }>;
+}, "strict", z.ZodTypeAny, {
+    caller: Uint8Array<ArrayBufferLike>;
+    collection: string;
+    doc: {
+        data: Uint8Array<ArrayBufferLike>;
+        key: string;
+        description?: string | undefined;
+        version?: bigint | undefined;
+    };
+}, {
+    caller: Uint8Array<ArrayBufferLike>;
+    collection: string;
+    doc: {
+        data: Uint8Array<ArrayBufferLike>;
+        key: string;
+        description?: string | undefined;
+        version?: bigint | undefined;
+    };
+}>;
+/**
+ * Represents the parameters required to store or update a document.
+ *
+ * This includes the document data along with metadata such as the caller,
+ * collection, and key.
+ */
+export type SetDocStoreParams = z.infer<typeof SetDocStoreParamsSchema>;

package/dist/types/index.d.ts

@@ -1,9 +1,9 @@
-export * from './configs/assert.config';
+export * from './configs/assertions';
 export * from './configs/collections.config';
-export * from './configs/hook.config';
-export * from './configs/satellite.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';
+export * from './sdk/serializer.sdk';
 import './polyfills/console.polyfill';

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

@@ -1,3 +1,13 @@
-import type { RawData } from '../hooks/core';
-export declare const decodeDocData: <T>(data: RawData) => T;
-export declare const encodeDocData: <T>(data: T) => RawData;
+import { SetDocStoreParams } from '../hooks/sdk';
+/**
+ * Stores or updates a document in the datastore.
+ *
+ * The data must have been encoded - using encodeDocData - before calling this function.
+ *
+ * @param {SetDocStoreParams} params - The parameters required to store the document,
+ * including the caller, collection, key, and document data.
+ *
+ * @throws {z.ZodError} If the provided parameters do not match the expected schema.
+ * @throws {Error} If the Satellite fails at validating the submitted document before storing it.
+ */
+export declare const setDocStore: (params: SetDocStoreParams) => void;

package/dist/types/sdk/serializer.sdk.d.ts

@@ -0,0 +1,17 @@
+import type { RawData } from '../hooks/core';
+/**
+ * Decodes the raw data of a document into a JavaScript object.
+ *
+ * @template T The expected type of the decoded object.
+ * @param {RawData} data - The raw data to be decoded.
+ * @returns {T} The parsed JavaScript object.
+ */
+export declare const decodeDocData: <T>(data: RawData) => T;
+/**
+ * Encodes a JavaScript object into a raw data format to be applied to a document.
+ *
+ * @template T The type of the object to be encoded.
+ * @param {T} data - The data to be encoded.
+ * @returns {RawData} The serialized raw data.
+ */
+export declare const encodeDocData: <T>(data: T) => RawData;

package/package.json

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