@junobuild/functions 0.0.12 → 0.0.13-next-2025-04-01

package/schemas/db.d.ts

@@ -1,13 +1,6 @@
 import * as z from 'zod';
 import { Uint8ArraySchema } from './candid';
-/**
- * @see DocDescription
- */
-export declare const DocDescriptionSchema: z.ZodString;
-/**
- * Represents a document description with a maximum length of 1024 characters.
- */
-export type DocDescription = z.infer<typeof DocDescriptionSchema>;
+import { Description, type RawUserId, type Timestamp, type Version } from './satellite';
 /**
  * @see RawData
  */
@@ -22,30 +15,66 @@ export type RawData = z.infer<typeof Uint8ArraySchema>;
  * @see Doc
  */
 export declare const DocSchema: 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;
+}>;
+/**
+ * Represents a document stored in a collection.
+ */
+export interface Doc {
     /**
      * The user who owns this document.
      */
-    owner: z.ZodType<Uint8Array<ArrayBufferLike>, z.ZodTypeDef, Uint8Array<ArrayBufferLike>>;
+    owner: RawUserId;
     /**
      * The raw data of the document.
      */
-    data: z.ZodType<Uint8Array<ArrayBufferLike>, z.ZodTypeDef, Uint8Array<ArrayBufferLike>>;
+    data: RawData;
     /**
      * An optional description of the document.
      */
-    description: z.ZodOptional<z.ZodString>;
+    description?: Description;
     /**
      * The timestamp when the document was first created.
      */
-    created_at: z.ZodBigInt;
+    created_at: Timestamp;
     /**
      * The timestamp when the document was last updated.
      */
-    updated_at: z.ZodBigInt;
+    updated_at: Timestamp;
     /**
      * The version number of the document, used for consistency checks.
      * If not provided, it's assumed to be the first version.
      */
+    version?: Version;
+}
+/**
+ * @see OptionDoc
+ */
+export declare const OptionDocSchema: 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>;
@@ -61,8 +90,62 @@ export declare const DocSchema: z.ZodObject<{
     updated_at: bigint;
     description?: string | undefined;
     version?: bigint | undefined;
+}>>;
+/**
+ * A shorthand for a document that might or not be defined.
+ */
+export type OptionDoc = Doc | undefined;
+/**
+ * @see SetDoc
+ */
+export declare const SetDocSchema: 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;
 }>;
 /**
- * Represents a document stored in a collection.
+ * Represents the proposed version of a document to be created or updated.
+ * This can be validated before allowing the operation.
+ */
+export interface SetDoc {
+    /**
+     * The raw data of the document.
+     */
+    data: RawData;
+    /**
+     * An optional description of the document.
+     */
+    description?: Description;
+    /**
+     * The expected version number to ensure consistency.
+     */
+    version?: Version;
+}
+/**
+ * @see DelDoc
  */
-export type Doc = z.infer<typeof DocSchema>;
+export declare const DelDocSchema: z.ZodObject<{
+    version: z.ZodOptional<z.ZodBigInt>;
+}, "strict", z.ZodTypeAny, {
+    version?: bigint | undefined;
+}, {
+    version?: bigint | undefined;
+}>;
+/**
+ * Represents the proposed version of a document to be deleted.
+ * This can be validated before allowing the operation.
+ */
+export interface DelDoc {
+    /**
+     * The expected version number to ensure consistency.
+     */
+    version?: Version;
+}

package/schemas/satellite.d.ts

@@ -55,3 +55,12 @@ export declare const KeySchema: z.ZodString;
  * A unique key identifier within a collection.
  */
 export type Key = z.infer<typeof KeySchema>;
+/**
+ * @see Description
+ */
+export declare const DescriptionSchema: z.ZodString;
+/**
+ * Represents a description with a maximum length of 1024 characters.
+ * Used for document and asset fields which can be useful for search purpose.
+ */
+export type Description = z.infer<typeof DescriptionSchema>;

package/schemas/storage.d.ts

@@ -0,0 +1,307 @@
+import * as z from 'zod';
+import { type Collection, type Description, type RawUserId, type Timestamp, type Version } from './satellite';
+/**
+ * Represents a single HTTP header as a tuple of name and value.
+ */
+export type HeaderField = [string, string];
+/**
+ * Binary content used in asset encoding.
+ */
+export type Blob = Uint8Array;
+/**
+ * When stable memory is used, chunks are saved within a StableBTreeMap and their keys - StableEncodingChunkKey - are saved for reference as serialized values
+ */
+export type BlobOrKey = Uint8Array;
+/**
+ * Represents a SHA-256 hash as a 32-byte binary value.
+ */
+export type Hash = Uint8Array;
+/**
+ * Metadata identifying an asset within a collection and the storage system.
+ */
+export interface AssetKey {
+    /**
+     * The name of the asset (e.g., "logo.png").
+     */
+    name: string;
+    /**
+     * The full relative path of the asset (e.g., "/images/logo.png").
+     */
+    full_path: string;
+    /**
+     * Optional access token for the asset.
+     * If set, can be used using a query parameter e.g. /full_path/?token=1223-3345-5564-3333
+     */
+    token?: string;
+    /**
+     * The collection to which this asset belongs.
+     */
+    collection: Collection;
+    /**
+     * The owner of the asset.
+     */
+    owner: RawUserId;
+    /**
+     * Optional description of the asset for indexing/search.
+     */
+    description?: Description;
+}
+/**
+ * Represents a specific encoding of an asset, such as "gzip" or "identity" (no compression).
+ */
+export interface AssetEncoding {
+    /**
+     * Timestamp when the encoding was last modified.
+     */
+    modified: Timestamp;
+    /**
+     * Chunks of binary content or references to them.
+     */
+    content_chunks: BlobOrKey[];
+    /**
+     * Total byte size of the encoded content.
+     */
+    total_length: bigint;
+    /**
+     * SHA-256 hash of the encoded content.
+     */
+    sha256: Hash;
+}
+/**
+ * @see Asset
+ */
+export declare const AssetSchema: 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>;
+    }, "strip", 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.ZodRecord<z.ZodString, 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>;
+    }>>;
+    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: Record<string, {
+        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: Record<string, {
+        modified: bigint;
+        content_chunks: Uint8Array<ArrayBufferLike>[];
+        total_length: bigint;
+        sha256: Uint8Array<ArrayBuffer>;
+    }>;
+    version?: bigint | undefined;
+}>;
+/**
+ * A stored asset including its metadata, encodings, and timestamps.
+ */
+export interface Asset {
+    /**
+     * Metadata about the asset's identity and ownership.
+     */
+    key: AssetKey;
+    /**
+     * Optional HTTP headers associated with the asset.
+     */
+    headers: HeaderField[];
+    /**
+     * A mapping from encoding types (e.g., "identity", "gzip") to the corresponding encoded version.
+     */
+    encodings: Record<string, AssetEncoding>;
+    /**
+     * Timestamp when the asset was created.
+     */
+    created_at: Timestamp;
+    /**
+     * Timestamp when the asset was last updated.
+     */
+    updated_at: Timestamp;
+    /**
+     * Optional version number of the asset.
+     */
+    version?: Version;
+}
+/**
+ * A string identifier representing a specific encoding format (e.g., "gzip", "identity").
+ */
+export type EncodingType = string;
+/**
+ * A unique reference identifier for batches.
+ */
+export type ReferenceId = bigint;
+/**
+ * @see Batch
+ */
+export declare const BatchSchema: 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>;
+    }, "strip", 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;
+    }>;
+    reference_id: z.ZodOptional<z.ZodBigInt>;
+    expires_at: z.ZodBigInt;
+    encoding_type: z.ZodOptional<z.ZodString>;
+}, "strict", z.ZodTypeAny, {
+    expires_at: bigint;
+    key: {
+        owner: Uint8Array<ArrayBufferLike>;
+        collection: string;
+        name: string;
+        full_path: string;
+        description?: string | undefined;
+        token?: string | undefined;
+    };
+    reference_id?: bigint | undefined;
+    encoding_type?: string | undefined;
+}, {
+    expires_at: bigint;
+    key: {
+        owner: Uint8Array<ArrayBufferLike>;
+        collection: string;
+        name: string;
+        full_path: string;
+        description?: string | undefined;
+        token?: string | undefined;
+    };
+    reference_id?: bigint | undefined;
+    encoding_type?: string | undefined;
+}>;
+/**
+ * Represents a batch of chunks to be uploaded and committed to an asset.
+ */
+export interface Batch {
+    /**
+     * The metadata key for the asset being uploaded.
+     */
+    key: AssetKey;
+    /**
+     * Optional reference ID for tracking or validation.
+     */
+    reference_id?: ReferenceId;
+    /**
+     * Timestamp when this batch expires.
+     */
+    expires_at: Timestamp;
+    /**
+     * Optional encoding format (e.g., "gzip").
+     */
+    encoding_type?: EncodingType;
+}
+/**
+ * A unique identifier representing a single chunk of data.
+ */
+export type ChunkId = bigint;
+/**
+ * A unique identifier representing a batch of upload.
+ */
+export type BatchId = bigint;
+/**
+ * @see CommitBatch
+ */
+export declare const CommitBatchSchema: z.ZodObject<{
+    batch_id: z.ZodBigInt;
+    headers: z.ZodArray<z.ZodTuple<[z.ZodString, z.ZodString], null>, "many">;
+    chunk_ids: z.ZodArray<z.ZodBigInt, "many">;
+}, "strict", z.ZodTypeAny, {
+    headers: [string, string][];
+    batch_id: bigint;
+    chunk_ids: bigint[];
+}, {
+    headers: [string, string][];
+    batch_id: bigint;
+    chunk_ids: bigint[];
+}>;
+/**
+ * Represents the final step in uploading an asset, committing the batch to storage.
+ */
+export interface CommitBatch {
+    /**
+     * The ID of the batch being committed.
+     */
+    batch_id: BatchId;
+    /**
+     * HTTP headers associated with this asset.
+     */
+    headers: HeaderField[];
+    /**
+     * List of chunk IDs that make up the asset content.
+     */
+    chunk_ids: ChunkId[];
+}

package/sdk/controllers.sdk.d.ts

@@ -0,0 +1,39 @@
+import { ControllerCheckParams, Controllers } from './schemas/controllers';
+/**
+ * Gets the list of admin controllers from the Satellite.
+ *
+ * @returns {Controllers} The list of admin controllers.
+ *
+ * @throws {z.ZodError} If the returned value does not match the expected schema.
+ */
+export declare const getAdminControllers: () => Controllers;
+/**
+ * Gets the list of controllers from the Satellite.
+ *
+ * @returns {Controllers} The list of all controllers.
+ *
+ * @throws {z.ZodError} If the returned value does not match the expected schema.
+ */
+export declare const getControllers: () => Controllers;
+/**
+ * Checks if the given caller is an admin among the provided controllers.
+ *
+ * @param {ControllerCheckParams} params - The parameters including the caller identity
+ * and the list of controllers to verify against.
+ *
+ * @returns {boolean} Whether the caller is an admin.
+ *
+ * @throws {z.ZodError} If any input does not match the expected schema.
+ */
+export declare const isAdminController: (params: ControllerCheckParams) => boolean;
+/**
+ * Checks if the given caller exists among the provided controllers.
+ *
+ * @param {ControllerCheckParams} params - The parameters including the caller identity
+ * and the list of controllers to verify against.
+ *
+ * @returns {boolean} Whether the caller is a controller.
+ *
+ * @throws {z.ZodError} If any input does not match the expected schema.
+ */
+export declare const isController: (params: ControllerCheckParams) => boolean;

package/sdk/db.sdk.d.ts

@@ -1,4 +1,4 @@
-import { SetDocStoreParams } from './schemas/db';
+import { DeleteDocStoreParams, SetDocStoreParams } from './schemas/db';
 /**
  * Stores or updates a document in the datastore.
  *
@@ -11,3 +11,13 @@ import { SetDocStoreParams } from './schemas/db';
  * @throws {Error} If the Satellite fails at validating the submitted document before storing it.
  */
 export declare const setDocStore: (params: SetDocStoreParams) => void;
+/**
+ * Delete a document in the datastore.
+ *
+ * @param {DeleteDocStoreParams} params - The parameters required to delete the document,
+ * including the caller, collection, key, and version 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 request before deleting it.
+ */
+export declare const deleteDocStore: (params: DeleteDocStoreParams) => void;

package/sdk/schemas/controllers.d.ts

@@ -0,0 +1,174 @@
+import * as z from 'zod';
+import { RawUserId, Timestamp, UserId } from '../../schemas/satellite';
+/**
+ * @see ControllerScopeSchema
+ */
+export declare const ControllerScopeSchema: z.ZodEnum<["write", "admin"]>;
+/**
+ * Represents the permission scope of a controller.
+ */
+export type ControllerScope = z.infer<typeof ControllerScopeSchema>;
+/**
+ * @see MetadataSchema
+ */
+export declare const MetadataSchema: z.ZodTuple<[z.ZodString, z.ZodString], null>;
+/**
+ * Represents a single metadata entry as a key-value tuple.
+ */
+export type Metadata = z.infer<typeof MetadataSchema>;
+/**
+ * @see ControllerSchema
+ */
+export declare const ControllerSchema: z.ZodObject<{
+    metadata: z.ZodArray<z.ZodTuple<[z.ZodString, z.ZodString], null>, "many">;
+    created_at: z.ZodBigInt;
+    updated_at: z.ZodBigInt;
+    expires_at: z.ZodOptional<z.ZodBigInt>;
+    scope: z.ZodEnum<["write", "admin"]>;
+}, "strict", z.ZodTypeAny, {
+    created_at: bigint;
+    updated_at: bigint;
+    metadata: [string, string][];
+    scope: "write" | "admin";
+    expires_at?: bigint | undefined;
+}, {
+    created_at: bigint;
+    updated_at: bigint;
+    metadata: [string, string][];
+    scope: "write" | "admin";
+    expires_at?: bigint | undefined;
+}>;
+/**
+ * Represents a controller with access scope and associated metadata.
+ */
+export interface Controller {
+    /**
+     * A list of key-value metadata pairs associated with the controller.
+     */
+    metadata: Metadata[];
+    /**
+     * The timestamp when the controller was created.
+     */
+    created_at: Timestamp;
+    /**
+     * The timestamp when the controller was last updated.
+     */
+    updated_at: Timestamp;
+    /**
+     * Optional expiration timestamp for the controller.
+     * 👉 It's a placeholder for future implementation.
+     */
+    expires_at?: Timestamp;
+    /**
+     * The scope assigned to the controller.
+     */
+    scope: ControllerScope;
+}
+/**
+ * @see ControllerRecordSchema
+ */
+export declare const ControllerRecordSchema: z.ZodTuple<[z.ZodType<Uint8Array<ArrayBufferLike>, z.ZodTypeDef, Uint8Array<ArrayBufferLike>>, z.ZodObject<{
+    metadata: z.ZodArray<z.ZodTuple<[z.ZodString, z.ZodString], null>, "many">;
+    created_at: z.ZodBigInt;
+    updated_at: z.ZodBigInt;
+    expires_at: z.ZodOptional<z.ZodBigInt>;
+    scope: z.ZodEnum<["write", "admin"]>;
+}, "strict", z.ZodTypeAny, {
+    created_at: bigint;
+    updated_at: bigint;
+    metadata: [string, string][];
+    scope: "write" | "admin";
+    expires_at?: bigint | undefined;
+}, {
+    created_at: bigint;
+    updated_at: bigint;
+    metadata: [string, string][];
+    scope: "write" | "admin";
+    expires_at?: bigint | undefined;
+}>], null>;
+/**
+ * Represents a tuple containing the principal ID and associated controller data.
+ */
+export type ControllerRecord = z.infer<typeof ControllerRecordSchema>;
+/**
+ * @see ControllersSchema
+ */
+export declare const ControllersSchema: z.ZodArray<z.ZodTuple<[z.ZodType<Uint8Array<ArrayBufferLike>, z.ZodTypeDef, Uint8Array<ArrayBufferLike>>, z.ZodObject<{
+    metadata: z.ZodArray<z.ZodTuple<[z.ZodString, z.ZodString], null>, "many">;
+    created_at: z.ZodBigInt;
+    updated_at: z.ZodBigInt;
+    expires_at: z.ZodOptional<z.ZodBigInt>;
+    scope: z.ZodEnum<["write", "admin"]>;
+}, "strict", z.ZodTypeAny, {
+    created_at: bigint;
+    updated_at: bigint;
+    metadata: [string, string][];
+    scope: "write" | "admin";
+    expires_at?: bigint | undefined;
+}, {
+    created_at: bigint;
+    updated_at: bigint;
+    metadata: [string, string][];
+    scope: "write" | "admin";
+    expires_at?: bigint | undefined;
+}>], null>, "many">;
+/**
+ * Represents a list of controllers.
+ */
+export type Controllers = z.infer<typeof ControllersSchema>;
+/**
+ * @see ControllerCheckParamsSchema
+ */
+export declare const ControllerCheckParamsSchema: z.ZodObject<{
+    caller: z.ZodUnion<[z.ZodType<Uint8Array<ArrayBufferLike>, z.ZodTypeDef, Uint8Array<ArrayBufferLike>>, z.ZodType<import("@dfinity/principal").Principal, z.ZodTypeDef, import("@dfinity/principal").Principal>]>;
+    controllers: z.ZodArray<z.ZodTuple<[z.ZodType<Uint8Array<ArrayBufferLike>, z.ZodTypeDef, Uint8Array<ArrayBufferLike>>, z.ZodObject<{
+        metadata: z.ZodArray<z.ZodTuple<[z.ZodString, z.ZodString], null>, "many">;
+        created_at: z.ZodBigInt;
+        updated_at: z.ZodBigInt;
+        expires_at: z.ZodOptional<z.ZodBigInt>;
+        scope: z.ZodEnum<["write", "admin"]>;
+    }, "strict", z.ZodTypeAny, {
+        created_at: bigint;
+        updated_at: bigint;
+        metadata: [string, string][];
+        scope: "write" | "admin";
+        expires_at?: bigint | undefined;
+    }, {
+        created_at: bigint;
+        updated_at: bigint;
+        metadata: [string, string][];
+        scope: "write" | "admin";
+        expires_at?: bigint | undefined;
+    }>], null>, "many">;
+}, "strip", z.ZodTypeAny, {
+    caller: Uint8Array<ArrayBufferLike> | import("@dfinity/principal").Principal;
+    controllers: [Uint8Array<ArrayBufferLike>, {
+        created_at: bigint;
+        updated_at: bigint;
+        metadata: [string, string][];
+        scope: "write" | "admin";
+        expires_at?: bigint | undefined;
+    }][];
+}, {
+    caller: Uint8Array<ArrayBufferLike> | import("@dfinity/principal").Principal;
+    controllers: [Uint8Array<ArrayBufferLike>, {
+        created_at: bigint;
+        updated_at: bigint;
+        metadata: [string, string][];
+        scope: "write" | "admin";
+        expires_at?: bigint | undefined;
+    }][];
+}>;
+/**
+ * Represents the parameters required to perform controller checks.
+ */
+export interface ControllerCheckParams {
+    /**
+     * The identity of the caller to verify against the controller list.
+     */
+    caller: RawUserId | UserId;
+    /**
+     * The list of controllers to check against.
+     */
+    controllers: Controllers;
+}