@junobuild/admin 0.0.57-next-2024-10-28.2 → 0.0.58-next-2024-11-22

package/dist/types/api/actor.api.d.ts

@@ -1,5 +1,4 @@
 import type { IDL } from '@dfinity/candid';
-import type { _SERVICE as ICActor } from '../../declarations/ic/ic.did';
 import type { _SERVICE as MissionControlActor } from '../../declarations/mission_control/mission_control.did';
 import type { _SERVICE as OrbiterActor } from '../../declarations/orbiter/orbiter.did';
 import type { _SERVICE as DeprecatedSatelliteNoScopeActor } from '../../declarations/satellite/satellite-deprecated-no-scope.did';
@@ -15,4 +14,3 @@ export declare const getActor: <T>({ canisterId, idlFactory, ...rest }: ActorPar
     canisterId: string | undefined;
     idlFactory: IDL.InterfaceFactory;
 }) => Promise<T>;
-export declare const getICActor: (params: ActorParameters) => Promise<ICActor>;

package/dist/types/api/ic.api.d.ts

@@ -1,6 +1,6 @@
 import { CanisterStatus } from '@dfinity/agent';
+import { InstallCodeParams } from '@dfinity/ic-management';
 import type { ActorParameters } from '../types/actor.types';
-import type { InstallCodeParams } from '../types/ic.types';
 export declare const upgradeCode: ({ actor, code }: {
     actor: ActorParameters;
     code: InstallCodeParams;

package/dist/types/api/satellite.api.d.ts

@@ -31,7 +31,7 @@ export declare const setRule: ({ type, collection, rule, satellite }: {
     collection: string;
     rule: SetRule;
     satellite: SatelliteParameters;
-}) => Promise<void>;
+}) => Promise<Rule>;
 export declare const version: ({ satellite }: {
     satellite: SatelliteParameters;
 }) => Promise<string>;

package/dist/types/constants/rules.constants.d.ts

@@ -7,3 +7,4 @@ export declare const PermissionManaged: Permission;
 export declare const PermissionControllers: Permission;
 export declare const MemoryHeap: Memory;
 export declare const MemoryStable: Memory;
+export declare const DEFAULT_RATE_CONFIG_TIME_PER_TOKEN_NS = 600000000n;

package/dist/types/index.d.ts

@@ -1,10 +1,22 @@
-export * from './services/mission-control.services';
-export * from './services/orbiter.services';
+export * from './services/mission-control.controllers.services';
+export * from './services/mission-control.upgrade.services';
+export * from './services/mission-control.version.services';
+export * from './services/orbiter.controllers.services';
+export * from './services/orbiter.memory.services';
+export * from './services/orbiter.upgrade.services';
+export * from './services/orbiter.version.services';
 export * from './services/releases.services';
-export * from './services/satellite.services';
+export * from './services/satellite.assets.services';
+export * from './services/satellite.config.services';
+export * from './services/satellite.controllers.services';
+export * from './services/satellite.docs.services';
+export * from './services/satellite.domains.services';
+export * from './services/satellite.memory.services';
+export * from './services/satellite.rules.services';
+export * from './services/satellite.upgrade.services';
+export * from './services/satellite.version.services';
 export type * from './types/actor.types';
 export type * from './types/build.types';
 export type * from './types/controllers.types';
 export type * from './types/customdomain.types';
-export type * from './types/ic.types';
 export type * from './types/releases.types';

package/dist/types/services/{mission-control.services.d.ts → mission-control.controllers.services.d.ts}

@@ -2,27 +2,6 @@ import { Principal } from '@dfinity/principal';
 import type { Controller } from '../../declarations/mission_control/mission_control.did';
 import type { MissionControlParameters } from '../types/actor.types';
 import type { SetControllerParams } from '../types/controllers.types';
-/**
- * Retrieves the version of Mission Control.
- * @param {Object} params - The parameters for Mission Control.
- * @param {MissionControlParameters} params.missionControl - The Mission Control parameters.
- * @returns {Promise<string>} A promise that resolves to the version of Mission Control.
- */
-export declare const missionControlVersion: (params: {
-    missionControl: MissionControlParameters;
-}) => Promise<string>;
-/**
- * Upgrades the Mission Control with the provided WASM module.
- * @param {Object} params - The parameters for upgrading Mission Control.
- * @param {MissionControlParameters} params.missionControl - The Mission Control parameters.
- * @param {Uint8Array} params.wasm_module - The WASM module for the upgrade.
- * @throws Will throw an error if no mission control principal is defined.
- * @returns {Promise<void>} A promise that resolves when the upgrade is complete.
- */
-export declare const upgradeMissionControl: ({ missionControl, wasm_module }: {
-    missionControl: MissionControlParameters;
-    wasm_module: Uint8Array;
-}) => Promise<void>;
 /**
  * Sets the controller for the specified satellites.
  * @param {Object} params - The parameters for setting the satellites controller.

package/dist/types/services/mission-control.upgrade.services.d.ts

@@ -0,0 +1,13 @@
+import type { MissionControlParameters } from '../types/actor.types';
+/**
+ * Upgrades the Mission Control with the provided WASM module.
+ * @param {Object} params - The parameters for upgrading Mission Control.
+ * @param {MissionControlParameters} params.missionControl - The Mission Control parameters.
+ * @param {Uint8Array} params.wasm_module - The WASM module for the upgrade.
+ * @throws Will throw an error if no mission control principal is defined.
+ * @returns {Promise<void>} A promise that resolves when the upgrade is complete.
+ */
+export declare const upgradeMissionControl: ({ missionControl, wasmModule }: {
+    missionControl: MissionControlParameters;
+    wasmModule: Uint8Array;
+}) => Promise<void>;

package/dist/types/services/mission-control.version.services.d.ts

@@ -0,0 +1,10 @@
+import type { MissionControlParameters } from '../types/actor.types';
+/**
+ * Retrieves the version of Mission Control.
+ * @param {Object} params - The parameters for Mission Control.
+ * @param {MissionControlParameters} params.missionControl - The Mission Control parameters.
+ * @returns {Promise<string>} A promise that resolves to the version of Mission Control.
+ */
+export declare const missionControlVersion: (params: {
+    missionControl: MissionControlParameters;
+}) => Promise<string>;

package/dist/types/services/orbiter.controllers.services.d.ts

@@ -0,0 +1,12 @@
+import { Principal } from '@dfinity/principal';
+import type { Controller } from '../../declarations/mission_control/mission_control.did';
+import type { OrbiterParameters } from '../types/actor.types';
+/**
+ * Lists the controllers of the Orbiter.
+ * @param {Object} params - The parameters for listing the controllers.
+ * @param {OrbiterParameters} params.orbiter - The Orbiter parameters.
+ * @returns {Promise<[Principal, Controller][]>} A promise that resolves to a list of controllers.
+ */
+export declare const listOrbiterControllers: (params: {
+    orbiter: OrbiterParameters;
+}) => Promise<[Principal, Controller][]>;

package/dist/types/services/orbiter.memory.services.d.ts

@@ -0,0 +1,11 @@
+import type { MemorySize } from '../../declarations/orbiter/orbiter.did';
+import type { OrbiterParameters } from '../types/actor.types';
+/**
+ * Retrieves the memory size of the Orbiter.
+ * @param {Object} params - The parameters for the Orbiter.
+ * @param {OrbiterParameters} params.orbiter - The Orbiter parameters.
+ * @returns {Promise<MemorySize>} A promise that resolves to the memory size of the Orbiter.
+ */
+export declare const orbiterMemorySize: (params: {
+    orbiter: OrbiterParameters;
+}) => Promise<MemorySize>;

package/dist/types/services/orbiter.upgrade.services.d.ts

@@ -0,0 +1,15 @@
+import type { OrbiterParameters } from '../types/actor.types';
+/**
+ * Upgrades the Orbiter with the provided WASM module.
+ * @param {Object} params - The parameters for upgrading the Orbiter.
+ * @param {OrbiterParameters} params.orbiter - The Orbiter parameters.
+ * @param {Uint8Array} params.wasm_module - The WASM module for the upgrade.
+ * @param {boolean} [params.reset=false] - Whether to reset the Orbiter (reinstall) instead of upgrading.
+ * @throws Will throw an error if no orbiter principal is defined.
+ * @returns {Promise<void>} A promise that resolves when the upgrade is complete.
+ */
+export declare const upgradeOrbiter: ({ orbiter, wasmModule, reset }: {
+    orbiter: OrbiterParameters;
+    wasmModule: Uint8Array;
+    reset?: boolean;
+}) => Promise<void>;

package/dist/types/services/orbiter.version.services.d.ts

@@ -0,0 +1,10 @@
+import type { OrbiterParameters } from '../types/actor.types';
+/**
+ * Retrieves the version of the Orbiter.
+ * @param {Object} params - The parameters for the Orbiter.
+ * @param {OrbiterParameters} params.orbiter - The Orbiter parameters.
+ * @returns {Promise<string>} A promise that resolves to the version of the Orbiter.
+ */
+export declare const orbiterVersion: (params: {
+    orbiter: OrbiterParameters;
+}) => Promise<string>;

package/dist/types/services/satellite.assets.services.d.ts

@@ -0,0 +1,23 @@
+import type { SatelliteParameters } from '../types/actor.types';
+/**
+ * Counts the assets in a collection.
+ * @param {Object} params - The parameters for counting the assets.
+ * @param {string} params.collection - The name of the collection.
+ * @param {SatelliteParameters} params.satellite - The satellite parameters.
+ * @returns {Promise<bigint>} A promise that resolves to the number of assets in the collection.
+ */
+export declare const countAssets: (params: {
+    collection: string;
+    satellite: SatelliteParameters;
+}) => Promise<bigint>;
+/**
+ * Deletes the assets in a collection.
+ * @param {Object} params - The parameters for deleting the assets.
+ * @param {string} params.collection - The name of the collection.
+ * @param {SatelliteParameters} params.satellite - The satellite parameters.
+ * @returns {Promise<void>} A promise that resolves when the assets are deleted.
+ */
+export declare const deleteAssets: (params: {
+    collection: string;
+    satellite: SatelliteParameters;
+}) => Promise<void>;

package/dist/types/services/satellite.config.services.d.ts

@@ -0,0 +1,48 @@
+import type { AuthenticationConfig, DatastoreConfig, StorageConfig } from '@junobuild/config';
+import type { SatelliteParameters } from '../types/actor.types';
+/**
+ * Sets the configuration for the Storage of a Satellite.
+ * @param {Object} params - The parameters for setting the configuration.
+ * @param {Object} params.config - The storage configuration.
+ * @param {Array<StorageConfigHeader>} params.config.headers - The headers configuration.
+ * @param {Array<StorageConfigRewrite>} params.config.rewrites - The rewrites configuration.
+ * @param {Array<StorageConfigRedirect>} params.config.redirects - The redirects configuration.
+ * @param {string} params.config.iframe - The iframe configuration.
+ * @param {SatelliteParameters} params.satellite - The satellite parameters.
+ * @returns {Promise<void>} A promise that resolves when the configuration is set.
+ */
+export declare const setStorageConfig: ({ config: { headers: configHeaders, rewrites: configRewrites, redirects: configRedirects, iframe: configIFrame, rawAccess: configRawAccess, maxMemorySize: configMaxMemorySize }, satellite }: {
+    config: StorageConfig;
+    satellite: SatelliteParameters;
+}) => Promise<void>;
+/**
+ * Sets the datastore configuration for a satellite.
+ * @param {Object} params - The parameters for setting the authentication configuration.
+ * @param {Object} params.config - The datastore configuration.
+ * @param {SatelliteParameters} params.satellite - The satellite parameters.
+ * @returns {Promise<void>} A promise that resolves when the datastore configuration is set.
+ */
+export declare const setDatastoreConfig: ({ config: { maxMemorySize }, ...rest }: {
+    config: DatastoreConfig;
+    satellite: SatelliteParameters;
+}) => Promise<void>;
+/**
+ * Sets the authentication configuration for a satellite.
+ * @param {Object} params - The parameters for setting the authentication configuration.
+ * @param {Object} params.config - The authentication configuration.
+ * @param {SatelliteParameters} params.satellite - The satellite parameters.
+ * @returns {Promise<void>} A promise that resolves when the authentication configuration is set.
+ */
+export declare const setAuthConfig: ({ config: { internetIdentity }, ...rest }: {
+    config: AuthenticationConfig;
+    satellite: SatelliteParameters;
+}) => Promise<void>;
+/**
+ * Gets the authentication configuration for a satellite.
+ * @param {Object} params - The parameters for getting the authentication configuration.
+ * @param {SatelliteParameters} params.satellite - The satellite parameters.
+ * @returns {Promise<AuthenticationConfig | undefined>} A promise that resolves to the authentication configuration or undefined if not found.
+ */
+export declare const getAuthConfig: ({ satellite }: {
+    satellite: SatelliteParameters;
+}) => Promise<AuthenticationConfig | undefined>;

package/dist/types/services/satellite.controllers.services.d.ts

@@ -0,0 +1,25 @@
+import { Principal } from '@dfinity/principal';
+import type { Controller, SetControllersArgs } from '../../declarations/satellite/satellite.did';
+import type { SatelliteParameters } from '../types/actor.types';
+/**
+ * Lists the controllers of a satellite.
+ * @param {Object} params - The parameters for listing the controllers.
+ * @param {SatelliteParameters} params.satellite - The satellite parameters.
+ * @param {boolean} [params.deprecatedNoScope] - Whether to list deprecated no-scope controllers.
+ * @returns {Promise<[Principal, Controller][]>} A promise that resolves to a list of controllers.
+ */
+export declare const listSatelliteControllers: ({ deprecatedNoScope, ...params }: {
+    satellite: SatelliteParameters;
+    deprecatedNoScope?: boolean;
+}) => Promise<[Principal, Controller][]>;
+/**
+ * Sets the controllers of a satellite.
+ * @param {Object} params - The parameters for setting the controllers.
+ * @param {SatelliteParameters} params.satellite - The satellite parameters.
+ * @param {SetControllersArgs} params.args - The arguments for setting the controllers.
+ * @returns {Promise<[Principal, Controller][]>} A promise that resolves to a list of controllers.
+ */
+export declare const setSatelliteControllers: (params: {
+    satellite: SatelliteParameters;
+    args: SetControllersArgs;
+}) => Promise<[Principal, Controller][]>;

package/dist/types/services/satellite.docs.services.d.ts

@@ -0,0 +1,23 @@
+import type { SatelliteParameters } from '../types/actor.types';
+/**
+ * Counts the documents in a collection.
+ * @param {Object} params - The parameters for counting the documents.
+ * @param {string} params.collection - The name of the collection.
+ * @param {SatelliteParameters} params.satellite - The satellite parameters.
+ * @returns {Promise<bigint>} A promise that resolves to the number of documents in the collection.
+ */
+export declare const countDocs: (params: {
+    collection: string;
+    satellite: SatelliteParameters;
+}) => Promise<bigint>;
+/**
+ * Deletes the documents in a collection.
+ * @param {Object} params - The parameters for deleting the documents.
+ * @param {string} params.collection - The name of the collection.
+ * @param {SatelliteParameters} params.satellite - The satellite parameters.
+ * @returns {Promise<void>} A promise that resolves when the documents are deleted.
+ */
+export declare const deleteDocs: (params: {
+    collection: string;
+    satellite: SatelliteParameters;
+}) => Promise<void>;

package/dist/types/services/satellite.domains.services.d.ts

@@ -0,0 +1,22 @@
+import type { SatelliteParameters } from '../types/actor.types';
+import type { CustomDomain } from '../types/customdomain.types';
+/**
+ * Lists the custom domains for a satellite.
+ * @param {Object} params - The parameters for listing the custom domains.
+ * @param {SatelliteParameters} params.satellite - The satellite parameters.
+ * @returns {Promise<CustomDomain[]>} A promise that resolves to an array of custom domains.
+ */
+export declare const listCustomDomains: ({ satellite }: {
+    satellite: SatelliteParameters;
+}) => Promise<CustomDomain[]>;
+/**
+ * Sets the custom domains for a satellite.
+ * @param {Object} params - The parameters for setting the custom domains.
+ * @param {SatelliteParameters} params.satellite - The satellite parameters.
+ * @param {CustomDomain[]} params.domains - The custom domains to set.
+ * @returns {Promise<void[]>} A promise that resolves when the custom domains are set.
+ */
+export declare const setCustomDomains: ({ satellite, domains }: {
+    satellite: SatelliteParameters;
+    domains: CustomDomain[];
+}) => Promise<void[]>;

package/dist/types/services/satellite.memory.services.d.ts

@@ -0,0 +1,11 @@
+import type { MemorySize } from '../../declarations/satellite/satellite.did';
+import type { SatelliteParameters } from '../types/actor.types';
+/**
+ * Retrieves the memory size of a satellite.
+ * @param {Object} params - The parameters for retrieving the memory size.
+ * @param {SatelliteParameters} params.satellite - The satellite parameters.
+ * @returns {Promise<MemorySize>} A promise that resolves to the memory size of the satellite.
+ */
+export declare const satelliteMemorySize: (params: {
+    satellite: SatelliteParameters;
+}) => Promise<MemorySize>;

package/dist/types/services/satellite.rules.services.d.ts

@@ -0,0 +1,26 @@
+import type { Rule, RulesType } from '@junobuild/config';
+import type { SatelliteParameters } from '../types/actor.types';
+/**
+ * Lists the rules for a satellite.
+ * @param {Object} params - The parameters for listing the rules.
+ * @param {RulesType} params.type - The type of rules to list.
+ * @param {SatelliteParameters} params.satellite - The satellite parameters.
+ * @returns {Promise<Rule[]>} A promise that resolves to an array of rules.
+ */
+export declare const listRules: ({ type, satellite }: {
+    type: RulesType;
+    satellite: SatelliteParameters;
+}) => Promise<Rule[]>;
+/**
+ * Sets a rule for a satellite.
+ * @param {Object} params - The parameters for setting the rule.
+ * @param {Rule} params.rule - The rule to set.
+ * @param {RulesType} params.type - The type of rule.
+ * @param {SatelliteParameters} params.satellite - The satellite parameters.
+ * @returns {Promise<void>} A promise that resolves when the rule is set.
+ */
+export declare const setRule: ({ rule: { collection, ...rest }, type, satellite }: {
+    rule: Rule;
+    type: RulesType;
+    satellite: SatelliteParameters;
+}) => Promise<void>;

package/dist/types/services/satellite.upgrade.services.d.ts

@@ -0,0 +1,18 @@
+import type { SatelliteParameters } from '../types/actor.types';
+/**
+ * Upgrades the satellite with the provided WASM module.
+ * @param {Object} params - The parameters for upgrading the satellite.
+ * @param {SatelliteParameters} params.satellite - The satellite parameters.
+ * @param {Uint8Array} params.wasm_module - The WASM module for the upgrade.
+ * @param {boolean} params.deprecated - Whether the upgrade is deprecated.
+ * @param {boolean} params.deprecatedNoScope - Whether the upgrade is deprecated with no scope.
+ * @param {boolean} [params.reset=false] - Whether to reset the satellite (reinstall) instead of upgrading.
+ * @returns {Promise<void>} A promise that resolves when the upgrade is complete.
+ */
+export declare const upgradeSatellite: ({ satellite, wasmModule, deprecated, deprecatedNoScope, reset }: {
+    satellite: SatelliteParameters;
+    wasmModule: Uint8Array;
+    deprecated: boolean;
+    deprecatedNoScope: boolean;
+    reset?: boolean;
+}) => Promise<void>;

package/dist/types/services/satellite.version.services.d.ts

@@ -0,0 +1,29 @@
+import type { SatelliteParameters } from '../types/actor.types';
+import type { BuildType } from '../types/build.types';
+/**
+ * Retrieves the version of the satellite.
+ * @param {Object} params - The parameters for retrieving the version.
+ * @param {SatelliteParameters} params.satellite - The satellite parameters.
+ * @returns {Promise<string>} A promise that resolves to the version of the satellite.
+ */
+export declare const satelliteVersion: (params: {
+    satellite: SatelliteParameters;
+}) => Promise<string>;
+/**
+ * Retrieves the build version of the satellite.
+ * @param {Object} params - The parameters for retrieving the build version.
+ * @param {SatelliteParameters} params.satellite - The satellite parameters.
+ * @returns {Promise<string>} A promise that resolves to the build version of the satellite.
+ */
+export declare const satelliteBuildVersion: (params: {
+    satellite: SatelliteParameters;
+}) => Promise<string>;
+/**
+ * Retrieves the build type of the satellite.
+ * @param {Object} params - The parameters for retrieving the build type.
+ * @param {SatelliteParameters} params.satellite - The satellite parameters.
+ * @returns {Promise<BuildType | undefined>} A promise that resolves to the build type of the satellite or undefined if not found.
+ */
+export declare const satelliteBuildType: ({ satellite: { satelliteId, ...rest } }: {
+    satellite: SatelliteParameters;
+}) => Promise<BuildType | undefined>;

package/dist/types/types/controllers.types.d.ts

@@ -4,7 +4,7 @@
  * @property {string} controllerId - The ID of the controller.
  * @property {string | null | undefined} profile - The profile of the controller.
  */
-export type SetControllerParams = {
+export interface SetControllerParams {
     controllerId: string;
     profile: string | null | undefined;
-};
+}

package/dist/types/utils/actor.utils.d.ts

@@ -1,10 +1,9 @@
-import type { ActorConfig, ActorMethod, ActorSubclass } from '@dfinity/agent';
-import { HttpAgent } from '@dfinity/agent';
+import { HttpAgent, type ActorConfig, type ActorMethod, type ActorSubclass } from '@dfinity/agent';
 import type { IDL } from '@dfinity/candid';
 import type { ActorParameters } from '../types/actor.types';
 export declare const createActor: <T = Record<string, ActorMethod<unknown[], unknown>>>({ canisterId, idlFactory, config, ...rest }: {
     idlFactory: IDL.InterfaceFactory;
     canisterId: string;
-    config?: Pick<ActorConfig, 'callTransform' | 'queryTransform'>;
+    config?: Pick<ActorConfig, "callTransform" | "queryTransform">;
 } & ActorParameters) => Promise<ActorSubclass<T>>;
 export declare const initAgent: ({ identity, fetch, container }: ActorParameters) => Promise<HttpAgent>;

package/dist/types/utils/rule.utils.d.ts

@@ -1,7 +1,7 @@
 import type { MemoryText, PermissionText, Rule, RulesType } from '@junobuild/config';
 import type { Memory, Permission, Rule as RuleApi, RulesType as RulesTypeApi, SetRule } from '../../declarations/satellite/satellite.did';
 export declare const mapRuleType: (type: RulesType) => RulesTypeApi;
-export declare const mapSetRule: ({ read, write, memory, maxSize, maxCapacity, version, mutablePermissions }: Pick<Rule, 'read' | 'write' | 'maxSize' | 'maxCapacity' | 'version' | 'memory' | 'mutablePermissions'>) => SetRule;
+export declare const mapSetRule: ({ read, write, memory, maxSize, maxCapacity, version, mutablePermissions, maxTokens }: Pick<Rule, "read" | "write" | "maxSize" | "maxCapacity" | "version" | "memory" | "mutablePermissions" | "maxTokens">) => SetRule;
 export declare const mapRule: ([collection, rule]: [string, RuleApi]) => Rule;
 export declare const permissionToText: (permission: Permission) => PermissionText;
 export declare const memoryFromText: (text: MemoryText) => Memory;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@junobuild/admin",
-  "version": "0.0.57-next-2024-10-28.2",
+  "version": "0.0.58-next-2024-11-22",
   "description": "A library for interfacing with admin features of Juno",
   "author": "David Dal Busco (https://daviddalbusco.com)",
   "license": "MIT",
@@ -51,6 +51,7 @@
   "homepage": "https://juno.build",
   "peerDependencies": {
     "@dfinity/agent": "*",
+    "@dfinity/ic-management": "*",
     "@dfinity/identity": "*",
     "@dfinity/principal": "*",
     "@junobuild/config": "*",