@junobuild/functions 0.0.13 → 0.0.14

package/README.md

@@ -30,6 +30,11 @@ JavaScript and TypeScript utilities for [Juno] Serverless Functions.
 - [defineHook](#gear-definehook)
 - [defineHook](#gear-definehook)
 - [defineHook](#gear-definehook)
+- [normalizeCaller](#gear-normalizecaller)
+- [getAdminControllers](#gear-getadmincontrollers)
+- [getControllers](#gear-getcontrollers)
+- [isAdminController](#gear-isadmincontroller)
+- [isController](#gear-iscontroller)
 - [setDocStore](#gear-setdocstore)
 - [deleteDocStore](#gear-deletedocstore)
 - [decodeDocData](#gear-decodedocdata)
@@ -123,7 +128,7 @@ JavaScript and TypeScript utilities for [Juno] Serverless Functions.
 | -------------- | --------------------------------------------------------------------------------------------------------------------- |
 | `HookFnSchema` | `<T extends z.ZodTypeAny>(hookSchema: T) => ZodFunction<ZodTuple<[ZodRecord<ZodString, ZodUnknown>], ZodUnknown>, T>` |
 
-[:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/hooks/hooks.ts#L161)
+[:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/hooks/hooks.ts#L170)
 
 #### :gear: HookFnOrObjectSchema
 
@@ -131,7 +136,7 @@ JavaScript and TypeScript utilities for [Juno] Serverless Functions.
 | ---------------------- | ------------------------------------------------------------------------------------------------------------------------------------ |
 | `HookFnOrObjectSchema` | `<T extends z.ZodTypeAny>(hookSchema: T) => ZodUnion<[T, ZodFunction<ZodTuple<[ZodRecord<ZodString, ZodUnknown>], ZodUnknown>, T>]>` |
 
-[:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/hooks/hooks.ts#L165)
+[:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/hooks/hooks.ts#L174)
 
 #### :gear: defineHook
 
@@ -139,7 +144,7 @@ JavaScript and TypeScript utilities for [Juno] Serverless Functions.
 | ------------ | ----------------------------------------------------------------------------------------------------------------------------------------------- |
 | `defineHook` | `{ <T extends Hook>(hook: T): T; <T extends Hook>(hook: HookFn<T>): HookFn<T>; <T extends Hook>(hook: HookFnOrObject<T>): HookFnOrObject<T>; }` |
 
-[:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/hooks/hooks.ts#L169)
+[:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/hooks/hooks.ts#L178)
 
 #### :gear: defineHook
 
@@ -147,7 +152,7 @@ JavaScript and TypeScript utilities for [Juno] Serverless Functions.
 | ------------ | ----------------------------------------------------------------------------------------------------------------------------------------------- |
 | `defineHook` | `{ <T extends Hook>(hook: T): T; <T extends Hook>(hook: HookFn<T>): HookFn<T>; <T extends Hook>(hook: HookFnOrObject<T>): HookFnOrObject<T>; }` |
 
-[:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/hooks/hooks.ts#L170)
+[:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/hooks/hooks.ts#L179)
 
 #### :gear: defineHook
 
@@ -155,7 +160,7 @@ JavaScript and TypeScript utilities for [Juno] Serverless Functions.
 | ------------ | ----------------------------------------------------------------------------------------------------------------------------------------------- |
 | `defineHook` | `{ <T extends Hook>(hook: T): T; <T extends Hook>(hook: HookFn<T>): HookFn<T>; <T extends Hook>(hook: HookFnOrObject<T>): HookFnOrObject<T>; }` |
 
-[:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/hooks/hooks.ts#L171)
+[:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/hooks/hooks.ts#L180)
 
 #### :gear: defineHook
 
@@ -163,7 +168,72 @@ JavaScript and TypeScript utilities for [Juno] Serverless Functions.
 | ------------ | ----------------------------------------------------------------------------------------------------------------------------------------------- |
 | `defineHook` | `{ <T extends Hook>(hook: T): T; <T extends Hook>(hook: HookFn<T>): HookFn<T>; <T extends Hook>(hook: HookFnOrObject<T>): HookFnOrObject<T>; }` |
 
-[:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/hooks/hooks.ts#L172)
+[:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/hooks/hooks.ts#L181)
+
+#### :gear: normalizeCaller
+
+Normalizes a user ID into a raw `Uint8Array` representation.
+
+| Function          | Type                                                                                |
+| ----------------- | ----------------------------------------------------------------------------------- |
+| `normalizeCaller` | `(caller: Uint8Array<ArrayBufferLike> or Principal) => Uint8Array<ArrayBufferLike>` |
+
+Parameters:
+
+- `caller`: - The caller identity, either a raw `Uint8Array`
+  or a `Principal` instance.
+
+[:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/sdk/utils/caller.utils.ts#L12)
+
+#### :gear: getAdminControllers
+
+Gets the list of admin controllers from the Satellite.
+
+| Function              | Type                                                                                                                                                                            |
+| --------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `getAdminControllers` | `() => [Uint8Array<ArrayBufferLike>, { created_at: bigint; updated_at: bigint; metadata: [string, string][]; scope: "write" or "admin"; expires_at?: bigint or undefined; }][]` |
+
+[:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/sdk/controllers.sdk.ts#L15)
+
+#### :gear: getControllers
+
+Gets the list of controllers from the Satellite.
+
+| Function         | Type                                                                                                                                                                            |
+| ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `getControllers` | `() => [Uint8Array<ArrayBufferLike>, { created_at: bigint; updated_at: bigint; metadata: [string, string][]; scope: "write" or "admin"; expires_at?: bigint or undefined; }][]` |
+
+[:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/sdk/controllers.sdk.ts#L25)
+
+#### :gear: isAdminController
+
+Checks if the given caller is an admin among the provided controllers.
+
+| Function            | Type                                         |
+| ------------------- | -------------------------------------------- |
+| `isAdminController` | `(params: ControllerCheckParams) => boolean` |
+
+Parameters:
+
+- `params`: - The parameters including the caller identity
+  and the list of controllers to verify against.
+
+[:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/sdk/controllers.sdk.ts#L37)
+
+#### :gear: isController
+
+Checks if the given caller exists among the provided controllers.
+
+| Function       | Type                                         |
+| -------------- | -------------------------------------------- |
+| `isController` | `(params: ControllerCheckParams) => boolean` |
+
+Parameters:
+
+- `params`: - The parameters including the caller identity
+  and the list of controllers to verify against.
+
+[:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/sdk/controllers.sdk.ts#L57)
 
 #### :gear: setDocStore
 
@@ -195,7 +265,7 @@ Parameters:
 - `params`: - The parameters required to delete the document,
   including the caller, collection, key, and version of the document.
 
-[:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/sdk/db.sdk.ts#L40)
+[:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/sdk/db.sdk.ts#L39)
 
 #### :gear: decodeDocData
 
@@ -310,6 +380,12 @@ the Principal of the executing canister.
 - [OnDeleteManyAssetsSchema](#gear-ondeletemanyassetsschema)
 - [OnDeleteFilteredAssetsSchema](#gear-ondeletefilteredassetsschema)
 - [HookSchema](#gear-hookschema)
+- [ControllerScopeSchema](#gear-controllerscopeschema)
+- [MetadataSchema](#gear-metadataschema)
+- [ControllerSchema](#gear-controllerschema)
+- [ControllerRecordSchema](#gear-controllerrecordschema)
+- [ControllersSchema](#gear-controllersschema)
+- [ControllerCheckParamsSchema](#gear-controllercheckparamsschema)
 - [SetDocStoreParamsSchema](#gear-setdocstoreparamsschema)
 - [DeleteDocStoreParamsSchema](#gear-deletedocstoreparamsschema)
 - [IDLTypeSchema](#gear-idltypeschema)
@@ -736,6 +812,54 @@ A schema that validates a value is an Uint8Array.
 
 [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/hooks/hooks.ts#L144)
 
+#### :gear: ControllerScopeSchema
+
+| Constant                | Type                          |
+| ----------------------- | ----------------------------- |
+| `ControllerScopeSchema` | `ZodEnum<["write", "admin"]>` |
+
+[:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/sdk/schemas/controllers.ts#L15)
+
+#### :gear: MetadataSchema
+
+| Constant         | Type                                     |
+| ---------------- | ---------------------------------------- |
+| `MetadataSchema` | `ZodTuple<[ZodString, ZodString], null>` |
+
+[:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/sdk/schemas/controllers.ts#L25)
+
+#### :gear: ControllerSchema
+
+| Constant           | Type                                                                                                                                                                                                                            |
+| ------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `ControllerSchema` | `ZodObject<{ metadata: ZodArray<ZodTuple<[ZodString, ZodString], null>, "many">; created_at: ZodBigInt; updated_at: ZodBigInt; expires_at: ZodOptional<...>; scope: ZodEnum<...>; }, "strict", ZodTypeAny, { ...; }, { ...; }>` |
+
+[:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/sdk/schemas/controllers.ts#L35)
+
+#### :gear: ControllerRecordSchema
+
+| Constant                 | Type                                                                                                              |
+| ------------------------ | ----------------------------------------------------------------------------------------------------------------- |
+| `ControllerRecordSchema` | `ZodTuple<[ZodType<Uint8Array<ArrayBufferLike>, ZodTypeDef, Uint8Array<ArrayBufferLike>>, ZodObject<...>], null>` |
+
+[:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/sdk/schemas/controllers.ts#L79)
+
+#### :gear: ControllersSchema
+
+| Constant            | Type                                                                                                                                |
+| ------------------- | ----------------------------------------------------------------------------------------------------------------------------------- |
+| `ControllersSchema` | `ZodArray<ZodTuple<[ZodType<Uint8Array<ArrayBufferLike>, ZodTypeDef, Uint8Array<ArrayBufferLike>>, ZodObject<...>], null>, "many">` |
+
+[:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/sdk/schemas/controllers.ts#L89)
+
+#### :gear: ControllerCheckParamsSchema
+
+| Constant                      | Type                                                                                                                                                                                                   |
+| ----------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `ControllerCheckParamsSchema` | `ZodObject<{ caller: ZodUnion<[ZodType<Uint8Array<ArrayBufferLike>, ZodTypeDef, Uint8Array<ArrayBufferLike>>, ZodType<...>]>; controllers: ZodArray<...>; }, "strip", ZodTypeAny, { ...; }, { ...; }>` |
+
+[:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/sdk/schemas/controllers.ts#L99)
+
 #### :gear: SetDocStoreParamsSchema
 
 | Constant                  | Type                                                                                                                                                                                                                                      |
@@ -815,6 +939,8 @@ Schema for encoding the call arguments.
 - [Batch](#gear-batch)
 - [CommitBatch](#gear-commitbatch)
 - [AssetAssertUpload](#gear-assetassertupload)
+- [Controller](#gear-controller)
+- [ControllerCheckParams](#gear-controllercheckparams)
 - [DocStoreParams](#gear-docstoreparams)
 - [CallParams](#gear-callparams)
 
@@ -907,11 +1033,11 @@ throw an error if their validation fails.
 
 Represents the context of a document operation within a collection.
 
-| Property     | Type     | Description                                                    |
-| ------------ | -------- | -------------------------------------------------------------- |
-| `collection` | `string` | The name of the collection where the document is stored.       |
-| `key`        | `string` | The unique key identifying the document within the collection. |
-| `data`       | `T`      | The data associated with the document operation.               |
+| Property     | Type     | Description                                              |
+| ------------ | -------- | -------------------------------------------------------- |
+| `collection` | `string` | The name of the collection where the document is stored. |
+| `key`        | `string` | The key identifying the document within the collection.  |
+| `data`       | `T`      | The data associated with the document operation.         |
 
 #### :gear: AssetKey
 
@@ -981,15 +1107,36 @@ Represents a validation context before uploading an asset.
 | `batch`        | `Batch`              | The batch metadata being uploaded.                |
 | `commit_batch` | `CommitBatch`        | The commit data describing headers and chunk ids. |
 
+#### :gear: Controller
+
+Represents a controller with access scope and associated metadata.
+
+| Property     | Type                  | Description                                                                                        |
+| ------------ | --------------------- | -------------------------------------------------------------------------------------------------- |
+| `metadata`   | `[string, string][]`  | A list of key-value metadata pairs associated with the controller.                                 |
+| `created_at` | `bigint`              | The timestamp when the controller was created.                                                     |
+| `updated_at` | `bigint`              | The timestamp when the controller was last updated.                                                |
+| `expires_at` | `bigint or undefined` | Optional expiration timestamp for the controller. 👉 It's a placeholder for future implementation. |
+| `scope`      | `"write" or "admin"`  | The scope assigned to the controller.                                                              |
+
+#### :gear: ControllerCheckParams
+
+Represents the parameters required to perform controller checks.
+
+| Property      | Type                                                                                                                                                                      | Description                                                       |
+| ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------- |
+| `caller`      | `Uint8Array<ArrayBufferLike> or Principal`                                                                                                                                | The identity of the caller to verify against the controller list. |
+| `controllers` | `[Uint8Array<ArrayBufferLike>, { created_at: bigint; updated_at: bigint; metadata: [string, string][]; scope: "write" or "admin"; expires_at?: bigint or undefined; }][]` | The list of controllers to check against.                         |
+
 #### :gear: DocStoreParams
 
 Represents the base parameters required to access the datastore and modify a document.
 
-| Property     | Type                                       | Description                                                    |
-| ------------ | ------------------------------------------ | -------------------------------------------------------------- |
-| `caller`     | `Uint8Array<ArrayBufferLike> or Principal` | The caller who initiate the document operation.                |
-| `collection` | `string`                                   | The name of the collection where the document is stored.       |
-| `key`        | `string`                                   | The unique key identifying the document within the collection. |
+| Property     | Type                                       | Description                                              |
+| ------------ | ------------------------------------------ | -------------------------------------------------------- |
+| `caller`     | `Uint8Array<ArrayBufferLike> or Principal` | The caller who initiate the document operation.          |
+| `collection` | `string`                                   | The name of the collection where the document is stored. |
+| `key`        | `string`                                   | The key identifying the document within the collection.  |
 
 #### :gear: CallParams
 
@@ -1060,6 +1207,10 @@ Type representing the parameters required to make a canister call.
 - [Hook](#gear-hook)
 - [HookFn](#gear-hookfn)
 - [HookFnOrObject](#gear-hookfnorobject)
+- [ControllerScope](#gear-controllerscope)
+- [Metadata](#gear-metadata)
+- [ControllerRecord](#gear-controllerrecord)
+- [Controllers](#gear-controllers)
 - [SetDocStoreParams](#gear-setdocstoreparams)
 - [DeleteDocStoreParams](#gear-deletedocstoreparams)
 - [IDLType](#gear-idltype)
@@ -1147,7 +1298,7 @@ A collection name where data are stored.
 
 #### :gear: Key
 
-A unique key identifier within a collection.
+A key identifier within a collection.
 
 | Type  | Type                        |
 | ----- | --------------------------- |
@@ -1526,9 +1677,9 @@ An assertion that runs before an asset is deleted.
 
 All assertions definitions.
 
-| Type     | Type                              |
-| -------- | --------------------------------- |
-| `Assert` | `AssertSetDoc or AssertDeleteDoc` |
+| Type     | Type                                                                        |
+| -------- | --------------------------------------------------------------------------- |
+| `Assert` | `AssertSetDoc or AssertDeleteDoc or AssertUploadAsset or AssertDeleteAsset` |
 
 [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/hooks/assertions.ts#L94)
 
@@ -1652,9 +1803,9 @@ A hook that runs when a filtered set of assets is deleted based on query conditi
 
 All hooks definitions.
 
-| Type   | Type                                                                                   |
-| ------ | -------------------------------------------------------------------------------------- |
-| `Hook` | `OnSetDoc or OnSetManyDocs or OnDeleteDoc or OnDeleteManyDocs or OnDeleteFilteredDocs` |
+| Type   | Type |
+| ------ | ---- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `Hook` | `    | OnSetDoc or OnSetManyDocs or OnDeleteDoc or OnDeleteManyDocs or OnDeleteFilteredDocs or OnUploadAsset or OnDeleteAsset or OnDeleteManyAssets or OnDeleteFilteredAssets` |
 
 [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/hooks/hooks.ts#L159)
 
@@ -1664,7 +1815,7 @@ All hooks definitions.
 | -------- | ------------------------------------------------- |
 | `HookFn` | `(hook: z.infer<typeof SatelliteEnvSchema>) => T` |
 
-[:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/hooks/hooks.ts#L163)
+[:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/hooks/hooks.ts#L172)
 
 #### :gear: HookFnOrObject
 
@@ -1672,7 +1823,47 @@ All hooks definitions.
 | ---------------- | ---------------- |
 | `HookFnOrObject` | `T or HookFn<T>` |
 
-[:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/hooks/hooks.ts#L167)
+[:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/hooks/hooks.ts#L176)
+
+#### :gear: ControllerScope
+
+Represents the permission scope of a controller.
+
+| Type              | Type                                    |
+| ----------------- | --------------------------------------- |
+| `ControllerScope` | `z.infer<typeof ControllerScopeSchema>` |
+
+[:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/sdk/schemas/controllers.ts#L20)
+
+#### :gear: Metadata
+
+Represents a single metadata entry as a key-value tuple.
+
+| Type       | Type                             |
+| ---------- | -------------------------------- |
+| `Metadata` | `z.infer<typeof MetadataSchema>` |
+
+[:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/sdk/schemas/controllers.ts#L30)
+
+#### :gear: ControllerRecord
+
+Represents a tuple containing the principal ID and associated controller data.
+
+| Type               | Type                                     |
+| ------------------ | ---------------------------------------- |
+| `ControllerRecord` | `z.infer<typeof ControllerRecordSchema>` |
+
+[:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/sdk/schemas/controllers.ts#L84)
+
+#### :gear: Controllers
+
+Represents a list of controllers.
+
+| Type          | Type                                |
+| ------------- | ----------------------------------- |
+| `Controllers` | `z.infer<typeof ControllersSchema>` |
+
+[:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/sdk/schemas/controllers.ts#L94)
 
 #### :gear: SetDocStoreParams
 

package/{chunk-6G6FWQ45.js → chunk-367GY4VX.js}

@@ -1,2 +1,2 @@
 import{a,b as p,c}from"./chunk-CCKUQNB5.js";import*as e from"zod";var r=e.bigint(),t=e.bigint(),n=p,h=c,d=e.string(),f=e.string(),i=e.string().max(1024);import*as o from"zod";var s=a,m=o.object({owner:n,data:s,description:i.optional(),created_at:r,updated_at:r,version:t.optional()}).strict(),l=m.optional(),w=o.object({data:s,description:i.optional(),version:t.optional()}).strict(),R=o.object({version:t.optional()}).strict();export{r as a,t as b,n as c,h as d,d as e,f,i as g,s as h,m as i,l as j,w as k,R as l};
-//# sourceMappingURL=chunk-6G6FWQ45.js.map
+//# sourceMappingURL=chunk-367GY4VX.js.map

package/chunk-367GY4VX.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["src/schemas/satellite.ts", "src/schemas/db.ts"],
+  "sourcesContent": ["import * as z from 'zod';\nimport {PrincipalSchema, RawPrincipalSchema} from './candid';\n\n/**\n * @see Timestamp\n */\nexport const TimestampSchema = z.bigint();\n\n/**\n * Represents a timestamp in nanoseconds since the Unix epoch.\n *\n * Used for tracking when events occur, such as document creation and updates.\n */\nexport type Timestamp = z.infer<typeof TimestampSchema>;\n\n/**\n * @see Version\n */\nexport const VersionSchema = z.bigint();\n\n/**\n * Represents a version number for tracking changes.\n *\n * This is typically incremented with each update to ensure consistency.\n */\nexport type Version = z.infer<typeof VersionSchema>;\n\n/**\n * @see RawUserId\n */\nexport const RawUserIdSchema = RawPrincipalSchema;\n\n/**\n * Represents a raw user identifier.\n *\n * This is a principal associated with a user.\n */\nexport type RawUserId = z.infer<typeof RawUserIdSchema>;\n\n/**\n * @see UserId\n */\nexport const UserIdSchema = PrincipalSchema;\n\n/**\n * Represents a user identifier.\n *\n * This is a principal associated with a user.\n */\nexport type UserId = z.infer<typeof UserIdSchema>;\n\n/**\n * @see Collection\n */\nexport const CollectionSchema = z.string();\n\n/**\n * A collection name where data are stored.\n */\nexport type Collection = z.infer<typeof CollectionSchema>;\n\n/**\n * @see Key\n */\nexport const KeySchema = z.string();\n\n/**\n * A key identifier within a collection.\n */\nexport type Key = z.infer<typeof KeySchema>;\n\n/**\n * @see Description\n */\nexport const DescriptionSchema = z.string().max(1024);\n\n/**\n * Represents a description with a maximum length of 1024 characters.\n * Used for document and asset fields which can be useful for search purpose.\n */\nexport type Description = z.infer<typeof DescriptionSchema>;\n", "import * as z from 'zod';\nimport {Uint8ArraySchema} from './candid';\nimport {\n  Description,\n  DescriptionSchema,\n  type RawUserId,\n  RawUserIdSchema,\n  type Timestamp,\n  TimestampSchema,\n  type Version,\n  VersionSchema\n} from './satellite';\n\n/**\n * @see RawData\n */\nexport const RawDataSchema = Uint8ArraySchema;\n\n/**\n * Represents raw binary data.\n *\n * This is used to store structured data in a document.\n */\nexport type RawData = z.infer<typeof Uint8ArraySchema>;\n\n/**\n * @see Doc\n */\nexport const DocSchema = z\n  .object({\n    owner: RawUserIdSchema,\n    data: RawDataSchema,\n    description: DescriptionSchema.optional(),\n    created_at: TimestampSchema,\n    updated_at: TimestampSchema,\n    version: VersionSchema.optional()\n  })\n  .strict();\n\n/**\n * Represents a document stored in a collection.\n */\nexport interface Doc {\n  /**\n   * The user who owns this document.\n   */\n  owner: RawUserId;\n\n  /**\n   * The raw data of the document.\n   */\n  data: RawData;\n\n  /**\n   * An optional description of the document.\n   */\n  description?: Description;\n\n  /**\n   * The timestamp when the document was first created.\n   */\n  created_at: Timestamp;\n\n  /**\n   * The timestamp when the document was last updated.\n   */\n  updated_at: Timestamp;\n\n  /**\n   * The version number of the document, used for consistency checks.\n   * If not provided, it's assumed to be the first version.\n   */\n  version?: Version;\n}\n\n/**\n * @see OptionDoc\n */\nexport const OptionDocSchema = DocSchema.optional();\n\n/**\n * A shorthand for a document that might or not be defined.\n */\nexport type OptionDoc = Doc | undefined;\n\n/**\n * @see SetDoc\n */\nexport const SetDocSchema = z\n  .object({\n    data: RawDataSchema,\n    description: DescriptionSchema.optional(),\n    version: VersionSchema.optional()\n  })\n  .strict();\n\n/**\n * Represents the proposed version of a document to be created or updated.\n * This can be validated before allowing the operation.\n */\nexport interface SetDoc {\n  /**\n   * The raw data of the document.\n   */\n  data: RawData;\n\n  /**\n   * An optional description of the document.\n   */\n  description?: Description;\n\n  /**\n   * The expected version number to ensure consistency.\n   */\n  version?: Version;\n}\n\n/**\n * @see DelDoc\n */\nexport const DelDocSchema = z\n  .object({\n    version: VersionSchema.optional()\n  })\n  .strict();\n\n/**\n * Represents the proposed version of a document to be deleted.\n * This can be validated before allowing the operation.\n */\nexport interface DelDoc {\n  /**\n   * The expected version number to ensure consistency.\n   */\n  version?: Version;\n}\n"],
+  "mappings": "4CAAA,UAAYA,MAAO,MAMZ,IAAMC,EAAoB,SAAO,EAY3BC,EAAkB,SAAO,EAYzBC,EAAkBC,EAYlBC,EAAeC,EAYfC,EAAqB,SAAO,EAU5BC,EAAc,SAAO,EAUrBC,EAAsB,SAAO,EAAE,IAAI,IAAI,EC1EpD,UAAYC,MAAO,MAgBZ,IAAMC,EAAgBC,EAYhBC,EACV,SAAO,CACN,MAAOC,EACP,KAAMH,EACN,YAAaI,EAAkB,SAAS,EACxC,WAAYC,EACZ,WAAYA,EACZ,QAASC,EAAc,SAAS,CAClC,CAAC,EACA,OAAO,EAyCGC,EAAkBL,EAAU,SAAS,EAUrCM,EACV,SAAO,CACN,KAAMR,EACN,YAAaI,EAAkB,SAAS,EACxC,QAASE,EAAc,SAAS,CAClC,CAAC,EACA,OAAO,EA0BGG,EACV,SAAO,CACN,QAASH,EAAc,SAAS,CAClC,CAAC,EACA,OAAO",
+  "names": ["z", "TimestampSchema", "VersionSchema", "RawUserIdSchema", "RawPrincipalSchema", "UserIdSchema", "PrincipalSchema", "CollectionSchema", "KeySchema", "DescriptionSchema", "z", "RawDataSchema", "Uint8ArraySchema", "DocSchema", "RawUserIdSchema", "DescriptionSchema", "TimestampSchema", "VersionSchema", "OptionDocSchema", "SetDocSchema", "DelDocSchema"]
+}

package/global.d.ts

@@ -1,10 +1,22 @@
 import type {DelDoc, RawData, SetDoc} from './schemas/db';
 import type {Collection, Key, RawPrincipal, RawUserId} from './schemas/satellite';
+import {Controllers} from './sdk/schemas/controllers';
 
 declare global {
   function __juno_satellite_datastore_raw_data_to_text(data: RawData): string;
   function __juno_satellite_datastore_raw_data_from_text(data: string): RawData;
 
+  function __juno_satellite_datastore_get_admin_controllers(): Controllers;
+  function __juno_satellite_datastore_get_controllers(): Controllers;
+  function __juno_satellite_datastore_is_admin_controller(
+    caller: RawUserId,
+    controllers: Controllers
+  ): boolean;
+  function __juno_satellite_datastore_is_controller(
+    caller: RawUserId,
+    controllers: Controllers
+  ): boolean;
+
   function __juno_satellite_datastore_set_doc_store(
     caller: RawUserId,
     collection: Collection,