@junobuild/functions 0.0.15 → 0.1.0

package/schemas/storage.d.ts

@@ -4,6 +4,18 @@ import { type Collection, type Description, type RawUserId, type Timestamp, type
  * Represents a single HTTP header as a tuple of name and value.
  */
 export type HeaderField = [string, string];
+/**
+ * @see HeaderFields
+ */
+export declare const HeaderFieldsSchema: z.ZodArray<z.ZodTuple<[z.ZodString, z.ZodString], null>, "many">;
+/**
+ * Represents a list of HTTP headers.
+ */
+export type HeaderFields = HeaderField[];
+/**
+ * @see Blob
+ */
+export declare const BlobSchema: z.ZodType<Uint8Array<ArrayBufferLike>, z.ZodTypeDef, Uint8Array<ArrayBufferLike>>;
 /**
  * Binary content used in asset encoding.
  */
@@ -16,6 +28,31 @@ export type BlobOrKey = Uint8Array;
  * Represents a SHA-256 hash as a 32-byte binary value.
  */
 export type Hash = Uint8Array;
+/**
+ * @see AssetKey
+ */
+export declare const AssetKeySchema: z.ZodObject<{
+    name: z.ZodString;
+    full_path: z.ZodString;
+    token: z.ZodOptional<z.ZodString>;
+    collection: z.ZodString;
+    owner: z.ZodType<Uint8Array<ArrayBufferLike>, z.ZodTypeDef, Uint8Array<ArrayBufferLike>>;
+    description: z.ZodOptional<z.ZodString>;
+}, "strict", z.ZodTypeAny, {
+    owner: Uint8Array<ArrayBufferLike>;
+    collection: string;
+    name: string;
+    full_path: string;
+    description?: string | undefined;
+    token?: string | undefined;
+}, {
+    owner: Uint8Array<ArrayBufferLike>;
+    collection: string;
+    name: string;
+    full_path: string;
+    description?: string | undefined;
+    token?: string | undefined;
+}>;
 /**
  * Metadata identifying an asset within a collection and the storage system.
  */
@@ -46,6 +83,25 @@ export interface AssetKey {
      */
     description?: Description;
 }
+/**
+ * @see AssetEncoding
+ */
+export declare const AssetEncodingSchema: z.ZodObject<{
+    modified: z.ZodBigInt;
+    content_chunks: z.ZodArray<z.ZodType<Uint8Array<ArrayBufferLike>, z.ZodTypeDef, Uint8Array<ArrayBufferLike>>, "many">;
+    total_length: z.ZodBigInt;
+    sha256: z.ZodEffects<z.ZodType<Uint8Array<ArrayBuffer>, z.ZodTypeDef, Uint8Array<ArrayBuffer>>, Uint8Array<ArrayBuffer>, Uint8Array<ArrayBuffer>>;
+}, "strip", z.ZodTypeAny, {
+    modified: bigint;
+    content_chunks: Uint8Array<ArrayBufferLike>[];
+    total_length: bigint;
+    sha256: Uint8Array<ArrayBuffer>;
+}, {
+    modified: bigint;
+    content_chunks: Uint8Array<ArrayBufferLike>[];
+    total_length: bigint;
+    sha256: Uint8Array<ArrayBuffer>;
+}>;
 /**
  * Represents a specific encoding of an asset, such as "gzip" or "identity" (no compression).
  */
@@ -67,6 +123,14 @@ export interface AssetEncoding {
      */
     sha256: Hash;
 }
+/**
+ * Represents a specific encoding of an asset, such as "gzip" or "identity" (no compression), without the chunks.
+ */
+export type AssetEncodingNoContent = Omit<AssetEncoding, 'content_chunks'>;
+/**
+ * A string identifier representing a specific encoding format (e.g., "gzip", "identity").
+ */
+export type EncodingType = 'identity' | 'gzip' | 'compress' | 'deflate' | 'br';
 /**
  * @see Asset
  */
@@ -78,7 +142,7 @@ export declare const AssetSchema: z.ZodObject<{
         collection: z.ZodString;
         owner: z.ZodType<Uint8Array<ArrayBufferLike>, z.ZodTypeDef, Uint8Array<ArrayBufferLike>>;
         description: z.ZodOptional<z.ZodString>;
-    }, "strip", z.ZodTypeAny, {
+    }, "strict", z.ZodTypeAny, {
         owner: Uint8Array<ArrayBufferLike>;
         collection: string;
         name: string;
@@ -94,7 +158,7 @@ export declare const AssetSchema: z.ZodObject<{
         token?: string | undefined;
     }>;
     headers: z.ZodArray<z.ZodTuple<[z.ZodString, z.ZodString], null>, "many">;
-    encodings: z.ZodRecord<z.ZodString, z.ZodObject<{
+    encodings: z.ZodArray<z.ZodTuple<[z.ZodEnum<["identity", "gzip", "compress", "deflate", "br"]>, z.ZodObject<{
         modified: z.ZodBigInt;
         content_chunks: z.ZodArray<z.ZodType<Uint8Array<ArrayBufferLike>, z.ZodTypeDef, Uint8Array<ArrayBufferLike>>, "many">;
         total_length: z.ZodBigInt;
@@ -109,7 +173,7 @@ export declare const AssetSchema: z.ZodObject<{
         content_chunks: Uint8Array<ArrayBufferLike>[];
         total_length: bigint;
         sha256: Uint8Array<ArrayBuffer>;
-    }>>;
+    }>], null>, "many">;
     created_at: z.ZodBigInt;
     updated_at: z.ZodBigInt;
     version: z.ZodOptional<z.ZodBigInt>;
@@ -125,12 +189,12 @@ export declare const AssetSchema: z.ZodObject<{
         token?: string | undefined;
     };
     headers: [string, string][];
-    encodings: Record<string, {
+    encodings: ["identity" | "gzip" | "compress" | "deflate" | "br", {
         modified: bigint;
         content_chunks: Uint8Array<ArrayBufferLike>[];
         total_length: bigint;
         sha256: Uint8Array<ArrayBuffer>;
-    }>;
+    }][];
     version?: bigint | undefined;
 }, {
     created_at: bigint;
@@ -144,12 +208,12 @@ export declare const AssetSchema: z.ZodObject<{
         token?: string | undefined;
     };
     headers: [string, string][];
-    encodings: Record<string, {
+    encodings: ["identity" | "gzip" | "compress" | "deflate" | "br", {
         modified: bigint;
         content_chunks: Uint8Array<ArrayBufferLike>[];
         total_length: bigint;
         sha256: Uint8Array<ArrayBuffer>;
-    }>;
+    }][];
     version?: bigint | undefined;
 }>;
 /**
@@ -167,7 +231,7 @@ export interface Asset {
     /**
      * A mapping from encoding types (e.g., "identity", "gzip") to the corresponding encoded version.
      */
-    encodings: Record<string, AssetEncoding>;
+    encodings: [EncodingType, AssetEncoding][];
     /**
      * Timestamp when the asset was created.
      */
@@ -182,9 +246,109 @@ export interface Asset {
     version?: Version;
 }
 /**
- * A string identifier representing a specific encoding format (e.g., "gzip", "identity").
+ * @see AssetNoContent
+ */
+export declare const AssetNoContentSchema: z.ZodObject<z.objectUtil.extendShape<Omit<{
+    key: z.ZodObject<{
+        name: z.ZodString;
+        full_path: z.ZodString;
+        token: z.ZodOptional<z.ZodString>;
+        collection: z.ZodString;
+        owner: z.ZodType<Uint8Array<ArrayBufferLike>, z.ZodTypeDef, Uint8Array<ArrayBufferLike>>;
+        description: z.ZodOptional<z.ZodString>;
+    }, "strict", z.ZodTypeAny, {
+        owner: Uint8Array<ArrayBufferLike>;
+        collection: string;
+        name: string;
+        full_path: string;
+        description?: string | undefined;
+        token?: string | undefined;
+    }, {
+        owner: Uint8Array<ArrayBufferLike>;
+        collection: string;
+        name: string;
+        full_path: string;
+        description?: string | undefined;
+        token?: string | undefined;
+    }>;
+    headers: z.ZodArray<z.ZodTuple<[z.ZodString, z.ZodString], null>, "many">;
+    encodings: z.ZodArray<z.ZodTuple<[z.ZodEnum<["identity", "gzip", "compress", "deflate", "br"]>, z.ZodObject<{
+        modified: z.ZodBigInt;
+        content_chunks: z.ZodArray<z.ZodType<Uint8Array<ArrayBufferLike>, z.ZodTypeDef, Uint8Array<ArrayBufferLike>>, "many">;
+        total_length: z.ZodBigInt;
+        sha256: z.ZodEffects<z.ZodType<Uint8Array<ArrayBuffer>, z.ZodTypeDef, Uint8Array<ArrayBuffer>>, Uint8Array<ArrayBuffer>, Uint8Array<ArrayBuffer>>;
+    }, "strip", z.ZodTypeAny, {
+        modified: bigint;
+        content_chunks: Uint8Array<ArrayBufferLike>[];
+        total_length: bigint;
+        sha256: Uint8Array<ArrayBuffer>;
+    }, {
+        modified: bigint;
+        content_chunks: Uint8Array<ArrayBufferLike>[];
+        total_length: bigint;
+        sha256: Uint8Array<ArrayBuffer>;
+    }>], null>, "many">;
+    created_at: z.ZodBigInt;
+    updated_at: z.ZodBigInt;
+    version: z.ZodOptional<z.ZodBigInt>;
+}, "encodings">, {
+    encodings: z.ZodArray<z.ZodTuple<[z.ZodEnum<["identity", "gzip", "compress", "deflate", "br"]>, z.ZodObject<Omit<{
+        modified: z.ZodBigInt;
+        content_chunks: z.ZodArray<z.ZodType<Uint8Array<ArrayBufferLike>, z.ZodTypeDef, Uint8Array<ArrayBufferLike>>, "many">;
+        total_length: z.ZodBigInt;
+        sha256: z.ZodEffects<z.ZodType<Uint8Array<ArrayBuffer>, z.ZodTypeDef, Uint8Array<ArrayBuffer>>, Uint8Array<ArrayBuffer>, Uint8Array<ArrayBuffer>>;
+    }, "content_chunks">, "strict", z.ZodTypeAny, {
+        modified: bigint;
+        total_length: bigint;
+        sha256: Uint8Array<ArrayBuffer>;
+    }, {
+        modified: bigint;
+        total_length: bigint;
+        sha256: Uint8Array<ArrayBuffer>;
+    }>], null>, "many">;
+}>, "strict", z.ZodTypeAny, {
+    created_at: bigint;
+    updated_at: bigint;
+    key: {
+        owner: Uint8Array<ArrayBufferLike>;
+        collection: string;
+        name: string;
+        full_path: string;
+        description?: string | undefined;
+        token?: string | undefined;
+    };
+    headers: [string, string][];
+    encodings: ["identity" | "gzip" | "compress" | "deflate" | "br", {
+        modified: bigint;
+        total_length: bigint;
+        sha256: Uint8Array<ArrayBuffer>;
+    }][];
+    version?: bigint | undefined;
+}, {
+    created_at: bigint;
+    updated_at: bigint;
+    key: {
+        owner: Uint8Array<ArrayBufferLike>;
+        collection: string;
+        name: string;
+        full_path: string;
+        description?: string | undefined;
+        token?: string | undefined;
+    };
+    headers: [string, string][];
+    encodings: ["identity" | "gzip" | "compress" | "deflate" | "br", {
+        modified: bigint;
+        total_length: bigint;
+        sha256: Uint8Array<ArrayBuffer>;
+    }][];
+    version?: bigint | undefined;
+}>;
+/**
+ * A stored asset including its metadata, encodings without chunks, and timestamps.
  */
-export type EncodingType = string;
+export type AssetNoContent = Omit<Asset, 'encodings'> & {
+    encodings: [EncodingType, AssetEncodingNoContent][];
+};
 /**
  * A unique reference identifier for batches.
  */
@@ -200,7 +364,7 @@ export declare const BatchSchema: z.ZodObject<{
         collection: z.ZodString;
         owner: z.ZodType<Uint8Array<ArrayBufferLike>, z.ZodTypeDef, Uint8Array<ArrayBufferLike>>;
         description: z.ZodOptional<z.ZodString>;
-    }, "strip", z.ZodTypeAny, {
+    }, "strict", z.ZodTypeAny, {
         owner: Uint8Array<ArrayBufferLike>;
         collection: string;
         name: string;
@@ -217,9 +381,8 @@ export declare const BatchSchema: z.ZodObject<{
     }>;
     reference_id: z.ZodOptional<z.ZodBigInt>;
     expires_at: z.ZodBigInt;
-    encoding_type: z.ZodOptional<z.ZodString>;
+    encoding_type: z.ZodOptional<z.ZodEnum<["identity", "gzip", "compress", "deflate", "br"]>>;
 }, "strict", z.ZodTypeAny, {
-    expires_at: bigint;
     key: {
         owner: Uint8Array<ArrayBufferLike>;
         collection: string;
@@ -228,10 +391,10 @@ export declare const BatchSchema: z.ZodObject<{
         description?: string | undefined;
         token?: string | undefined;
     };
+    expires_at: bigint;
     reference_id?: bigint | undefined;
-    encoding_type?: string | undefined;
+    encoding_type?: "identity" | "gzip" | "compress" | "deflate" | "br" | undefined;
 }, {
-    expires_at: bigint;
     key: {
         owner: Uint8Array<ArrayBufferLike>;
         collection: string;
@@ -240,8 +403,9 @@ export declare const BatchSchema: z.ZodObject<{
         description?: string | undefined;
         token?: string | undefined;
     };
+    expires_at: bigint;
     reference_id?: bigint | undefined;
-    encoding_type?: string | undefined;
+    encoding_type?: "identity" | "gzip" | "compress" | "deflate" | "br" | undefined;
 }>;
 /**
  * Represents a batch of chunks to be uploaded and committed to an asset.
@@ -305,3 +469,103 @@ export interface CommitBatch {
      */
     chunk_ids: ChunkId[];
 }
+/**
+ * @see FullPath
+ */
+export declare const FullPathSchema: z.ZodString;
+/**
+ * Represents the relative path of an asset in storage.
+ * For assets that are not part of the frontend app, the collection must be included at the root of the path.
+ *
+ * Example: `/images/a-sun-above-the-mountains.png`
+ */
+export type FullPath = string;
+/**
+ * @see OptionAsset
+ */
+export declare const OptionAssetSchema: z.ZodOptional<z.ZodObject<{
+    key: z.ZodObject<{
+        name: z.ZodString;
+        full_path: z.ZodString;
+        token: z.ZodOptional<z.ZodString>;
+        collection: z.ZodString;
+        owner: z.ZodType<Uint8Array<ArrayBufferLike>, z.ZodTypeDef, Uint8Array<ArrayBufferLike>>;
+        description: z.ZodOptional<z.ZodString>;
+    }, "strict", z.ZodTypeAny, {
+        owner: Uint8Array<ArrayBufferLike>;
+        collection: string;
+        name: string;
+        full_path: string;
+        description?: string | undefined;
+        token?: string | undefined;
+    }, {
+        owner: Uint8Array<ArrayBufferLike>;
+        collection: string;
+        name: string;
+        full_path: string;
+        description?: string | undefined;
+        token?: string | undefined;
+    }>;
+    headers: z.ZodArray<z.ZodTuple<[z.ZodString, z.ZodString], null>, "many">;
+    encodings: z.ZodArray<z.ZodTuple<[z.ZodEnum<["identity", "gzip", "compress", "deflate", "br"]>, z.ZodObject<{
+        modified: z.ZodBigInt;
+        content_chunks: z.ZodArray<z.ZodType<Uint8Array<ArrayBufferLike>, z.ZodTypeDef, Uint8Array<ArrayBufferLike>>, "many">;
+        total_length: z.ZodBigInt;
+        sha256: z.ZodEffects<z.ZodType<Uint8Array<ArrayBuffer>, z.ZodTypeDef, Uint8Array<ArrayBuffer>>, Uint8Array<ArrayBuffer>, Uint8Array<ArrayBuffer>>;
+    }, "strip", z.ZodTypeAny, {
+        modified: bigint;
+        content_chunks: Uint8Array<ArrayBufferLike>[];
+        total_length: bigint;
+        sha256: Uint8Array<ArrayBuffer>;
+    }, {
+        modified: bigint;
+        content_chunks: Uint8Array<ArrayBufferLike>[];
+        total_length: bigint;
+        sha256: Uint8Array<ArrayBuffer>;
+    }>], null>, "many">;
+    created_at: z.ZodBigInt;
+    updated_at: z.ZodBigInt;
+    version: z.ZodOptional<z.ZodBigInt>;
+}, "strict", z.ZodTypeAny, {
+    created_at: bigint;
+    updated_at: bigint;
+    key: {
+        owner: Uint8Array<ArrayBufferLike>;
+        collection: string;
+        name: string;
+        full_path: string;
+        description?: string | undefined;
+        token?: string | undefined;
+    };
+    headers: [string, string][];
+    encodings: ["identity" | "gzip" | "compress" | "deflate" | "br", {
+        modified: bigint;
+        content_chunks: Uint8Array<ArrayBufferLike>[];
+        total_length: bigint;
+        sha256: Uint8Array<ArrayBuffer>;
+    }][];
+    version?: bigint | undefined;
+}, {
+    created_at: bigint;
+    updated_at: bigint;
+    key: {
+        owner: Uint8Array<ArrayBufferLike>;
+        collection: string;
+        name: string;
+        full_path: string;
+        description?: string | undefined;
+        token?: string | undefined;
+    };
+    headers: [string, string][];
+    encodings: ["identity" | "gzip" | "compress" | "deflate" | "br", {
+        modified: bigint;
+        content_chunks: Uint8Array<ArrayBufferLike>[];
+        total_length: bigint;
+        sha256: Uint8Array<ArrayBuffer>;
+    }][];
+    version?: bigint | undefined;
+}>>;
+/**
+ * A shorthand for an asset that might or not be defined.
+ */
+export type OptionAsset = Asset | undefined;

package/sdk/db.sdk.d.ts

@@ -1,4 +1,8 @@
-import { type DeleteDocStoreParams, type SetDocStoreParams } from './schemas/db';
+import type { DocContext } from '../hooks/schemas/db/context';
+import type { DocUpsert } from '../hooks/schemas/db/payload';
+import type { Doc, OptionDoc } from '../schemas/db';
+import type { ListResults } from '../schemas/list';
+import { type CountCollectionDocsStoreParams, type CountDocsStoreParams, type DeleteDocsStoreParams, type DeleteDocStoreParams, type DeleteFilteredDocsStoreParams, type GetDocStoreParams, type ListDocsStoreParams, type SetDocStoreParams } from './schemas/db';
 /**
  * Stores or updates a document in the datastore.
  *
@@ -7,17 +11,87 @@ import { type DeleteDocStoreParams, type SetDocStoreParams } from './schemas/db'
  * @param {SetDocStoreParams} params - The parameters required to store the document,
  * including the caller, collection, key, and document data.
  *
+ * @returns {DocContext<DocUpsert>} The context of the stored or updated document,
+ * including its key, collection, and both the previous and current versions of the document.
+ *
  * @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.
+ * @throws {Error} If the Satellite fails to validate or store the document.
  */
-export declare const setDocStore: (params: SetDocStoreParams) => void;
+export declare const setDocStore: (params: SetDocStoreParams) => DocContext<DocUpsert>;
 /**
- * Delete a document in the datastore.
+ * Deletes a document from the datastore.
  *
  * @param {DeleteDocStoreParams} params - The parameters required to delete the document,
- * including the caller, collection, key, and version of the document.
+ * including the caller, collection, key, and the expected version of the document.
+ *
+ * @returns {DocContext<OptionDoc>} The context of the deleted document,
+ * including its key, collection, and optionally the previous document data if it existed.
+ *
+ * @throws {z.ZodError} If the provided parameters do not match the expected schema.
+ * @throws {Error} If the Satellite fails to validate the request or the document cannot be deleted.
+ */
+export declare const deleteDocStore: (params: DeleteDocStoreParams) => DocContext<OptionDoc>;
+/**
+ * Retrieve a document from the datastore.
+ *
+ * @param {GetDocStoreParams} params - The parameters required to get the document.
+ *
+ * @returns {OptionDoc} The document if found, or undefined if not.
  *
  * @throws {z.ZodError} If the provided parameters do not match the expected schema.
- * @throws {Error} If the Satellite fails at validating the submitted request before deleting it.
+ * @throws {Error} If the Satellite fails while retrieving the document.
+ */
+export declare const getDocStore: (params: GetDocStoreParams) => OptionDoc;
+/**
+ * Lists documents from the datastore using optional filtering, pagination, and ordering parameters.
+ *
+ * @param {ListStoreParams} params - The parameters required to perform the list operation.
+ *
+ * @returns {ListResults<Doc>} A list result containing matching documents and pagination metadata.
+ *
+ * @throws {z.ZodError} If the input parameters do not conform to the schema.
+ * @throws {Error} If the Satellite fails while performing the listing operation.
+ */
+export declare const listDocsStore: (params: ListDocsStoreParams) => ListResults<Doc>;
+/**
+ * Counts the number of documents in a specific collection.
+ *
+ * @param {CountCollectionDocsStoreParams} params - The parameters required to count documents in the collection.
+ *
+ * @returns {bigint} The total number of documents in the specified collection.
+ *
+ * @throws {z.ZodError} If the input parameters do not conform to the schema.
+ * @throws {Error} If the Satellite fails while performing the count operation.
+ */
+export declare const countCollectionDocsStore: (params: CountCollectionDocsStoreParams) => bigint;
+/**
+ * Counts the number of documents in a collection matching specific filters and owned by a specific caller.
+ *
+ * @param {CountDocsStoreParams} params - The parameters required to perform the filtered count.
+ *
+ * @returns {bigint} The number of documents that match the provided filters.
+ *
+ * @throws {z.ZodError} If the input parameters do not conform to the schema.
+ * @throws {Error} If the Satellite fails while performing the count operation.
+ */
+export declare const countDocsStore: (params: CountDocsStoreParams) => bigint;
+/**
+ * Delete documents in a specific collection of the Datastore.
+ *
+ * @param {DeleteDocsStoreParams} params - The parameters required to delete documents in the collection.
+ *
+ * @throws {z.ZodError} If the input parameters do not conform to the schema.
+ * @throws {Error} If the Satellite fails while performing the count operation.
+ */
+export declare const deleteDocsStore: (params: DeleteDocsStoreParams) => void;
+/**
+ * Delete documents in a collection matching specific filters and owned by a specific caller.
+ *
+ * @param {DeleteFilteredDocsStoreParams} params - The parameters required to perform the filtered deletion.
+ *
+ * @returns {DocContext<OptionDoc>[]} The context resulting of the deletion of documents that match the provided filters.
+ *
+ * @throws {z.ZodError} If the input parameters do not conform to the schema.
+ * @throws {Error} If the Satellite fails while performing the count operation.
  */
-export declare const deleteDocStore: (params: DeleteDocStoreParams) => void;
+export declare const deleteFilteredDocsStore: (params: DeleteFilteredDocsStoreParams) => DocContext<OptionDoc>[];

package/sdk/schemas/collections.d.ts

@@ -0,0 +1,9 @@
+import * as z from 'zod';
+/**
+ * @see Memory
+ */
+export declare const MemorySchema: z.ZodEnum<["heap", "stable"]>;
+/**
+ * Memory type used to select storage or datastore location.
+ */
+export type Memory = z.infer<typeof MemorySchema>;