@junobuild/ic-client 0.0.1

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

@@ -0,0 +1,3 @@
+import type { HttpAgent } from '@dfinity/agent';
+import type { ActorParameters } from '../types/actor';
+export declare const useOrInitAgent: ({ agent, ...rest }: ActorParameters) => Promise<HttpAgent>;

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

@@ -0,0 +1,34 @@
+import type { IDL } from '@dfinity/candid';
+import type { ActorParameters, MissionControlParameters, OrbiterParameters, SatelliteParameters } from '../types/actor';
+import { type DeprecatedMissionControlVersionActor, type DeprecatedOrbiterVersionActor, type DeprecatedSatelliteActor, type DeprecatedSatelliteNoScopeActor, type DeprecatedSatelliteVersionActor, type MissionControlActor, type OrbiterActor, type SatelliteActor } from './actor.factory';
+/**
+ * @deprecated TODO: for backwards compatibility - to be removed
+ */
+export declare const getDeprecatedSatelliteActor: ({ satelliteId, ...rest }: SatelliteParameters) => Promise<DeprecatedSatelliteActor>;
+export declare const getSatelliteActor: ({ satelliteId, certified, ...rest }: SatelliteParameters & {
+    certified?: boolean;
+}) => Promise<SatelliteActor>;
+/**
+ * @deprecated TODO: for backwards compatibility - to be removed
+ */
+export declare const getDeprecatedSatelliteNoScopeActor: ({ satelliteId, ...rest }: SatelliteParameters) => Promise<DeprecatedSatelliteNoScopeActor>;
+/**
+ * @deprecated TODO: for backwards compatibility - to be removed
+ */
+export declare const getDeprecatedSatelliteVersionActor: ({ satelliteId, ...rest }: SatelliteParameters) => Promise<DeprecatedSatelliteVersionActor>;
+export declare const getMissionControlActor: ({ missionControlId, ...rest }: MissionControlParameters) => Promise<MissionControlActor>;
+/**
+ * @deprecated TODO: for backwards compatibility - to be removed
+ */
+export declare const getDeprecatedMissionControlVersionActor: ({ missionControlId, ...rest }: MissionControlParameters) => Promise<DeprecatedMissionControlVersionActor>;
+export declare const getOrbiterActor: ({ orbiterId, certified, ...rest }: OrbiterParameters & {
+    certified?: boolean;
+}) => Promise<OrbiterActor>;
+/**
+ * @deprecated TODO: for backwards compatibility - to be removed
+ */
+export declare const getDeprecatedOrbiterVersionActor: ({ orbiterId, ...rest }: OrbiterParameters) => Promise<DeprecatedOrbiterVersionActor>;
+export declare const getActor: <T>({ canisterId, idlFactory, ...rest }: ActorParameters & {
+    canisterId: string | undefined;
+    idlFactory: IDL.InterfaceFactory;
+}) => Promise<T>;

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

@@ -0,0 +1,19 @@
+import { idlFactory as idlFactoryMissionControl } from '../../declarations/mission_control/mission_control.factory.did.js';
+import { idlFactory as idlFactoryOrbiter } from '../../declarations/orbiter/orbiter.factory.did.js';
+import { idlFactory as idlCertifiedFactoryOrbiter } from '../../declarations/orbiter/orbiter.factory.certified.did.js';
+import { idlFactory as idlDeprecatedFactorySatelliteNoScope } from '../../declarations/deprecated/satellite-deprecated-no-scope.factory.did.js';
+import { idlFactory as idlDeprecatedFactorySatelliteVersion } from '../../declarations/deprecated/satellite-deprecated-version.factory.did.js';
+import { idlFactory as idlDeprecatedFactoryOrbiterVersion } from '../../declarations/deprecated/orbiter-deprecated-version.factory.did.js';
+import { idlFactory as idlDeprecatedFactoryMissionControlVersion } from '../../declarations/deprecated/mission_control-deprecated-version.factory.did.js';
+import { idlFactory as idlDeprecatedFactorySatellite } from '../../declarations/deprecated/satellite-deprecated.factory.did.js';
+import { idlFactory as idlFactorySatellite } from '../../declarations/satellite/satellite.factory.did.js';
+import { idlFactory as idlCertifiedFactorySatellite } from '../../declarations/satellite/satellite.factory.certified.did.js';
+import type { _SERVICE as DeprecatedMissionControlVersionActor } from '../../declarations/deprecated/mission_control-deprecated-version.did';
+import type { _SERVICE as DeprecatedOrbiterVersionActor } from '../../declarations/deprecated/orbiter-deprecated-version.did';
+import type { _SERVICE as DeprecatedSatelliteNoScopeActor } from '../../declarations/deprecated/satellite-deprecated-no-scope.did';
+import type { _SERVICE as DeprecatedSatelliteVersionActor } from '../../declarations/deprecated/satellite-deprecated-version.did';
+import type { _SERVICE as DeprecatedSatelliteActor } from '../../declarations/deprecated/satellite-deprecated.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 SatelliteActor } from '../../declarations/satellite/satellite.did';
+export { idlCertifiedFactoryOrbiter, idlCertifiedFactorySatellite, idlDeprecatedFactoryMissionControlVersion, idlDeprecatedFactoryOrbiterVersion, idlDeprecatedFactorySatellite, idlDeprecatedFactorySatelliteNoScope, idlDeprecatedFactorySatelliteVersion, idlFactoryMissionControl, idlFactoryOrbiter, idlFactorySatellite, type DeprecatedMissionControlVersionActor, type DeprecatedOrbiterVersionActor, type DeprecatedSatelliteActor, type DeprecatedSatelliteNoScopeActor, type DeprecatedSatelliteVersionActor, type MissionControlActor, type OrbiterActor, type SatelliteActor };

package/dist/types/index.d.ts

@@ -0,0 +1,2 @@
+export * from './api/actor.api';
+export * from './api/actor.factory';

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

@@ -0,0 +1,74 @@
+import type { HttpAgent, Identity } from '@dfinity/agent';
+/**
+ * Represents the parameters for an actor.
+ * @interface
+ */
+export interface ActorParameters {
+    /**
+     * The identity associated with the actor.
+     * @type {Identity}
+     */
+    identity: Identity;
+    /**
+     * Specifies whether the actor is calling the local development Docker container or provides the container URL.
+     * @type {boolean | string}
+     * @optional
+     */
+    container?: boolean | string;
+    /**
+     * An optional HttpAgent. If none is provided, a new agent will automatically be created to execute calls.
+     */
+    agent?: HttpAgent;
+}
+/**
+ * Represents the parameters for a satellite actor.
+ * @interface
+ * @extends {ActorParameters}
+ */
+export interface SatelliteParameters extends ActorParameters {
+    /**
+     * The unique identifier for the satellite.
+     * @type {string}
+     * @optional
+     */
+    satelliteId?: string;
+}
+/**
+ * Represents the parameters for a Mission Control actor.
+ * @interface
+ * @extends {ActorParameters}
+ */
+export interface MissionControlParameters extends ActorParameters {
+    /**
+     * The unique identifier for Mission Control.
+     * @type {string}
+     * @optional
+     */
+    missionControlId?: string;
+}
+/**
+ * Represents the parameters for a Console actor.
+ * @interface
+ * @extends {ActorParameters}
+ */
+export interface ConsoleParameters extends ActorParameters {
+    /**
+     * The unique identifier for the console.
+     * @type {string}
+     * @optional
+     */
+    consoleId?: string;
+}
+/**
+ * Represents the parameters for an Orbiter actor.
+ * @interface
+ * @extends {ActorParameters}
+ */
+export interface OrbiterParameters extends ActorParameters {
+    /**
+     * The unique identifier for the Orbiter.
+     * @type {string}
+     * @optional
+     */
+    orbiterId?: string;
+}

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

@@ -0,0 +1,6 @@
+import { HttpAgent } from '@dfinity/agent';
+import type { ActorParameters } from '../types/actor';
+export declare const createAgent: ({ identity, host, localActor }: Pick<ActorParameters, "identity"> & {
+    host: string;
+    localActor: boolean;
+}) => Promise<HttpAgent>;

package/package.json

@@ -0,0 +1,63 @@
+{
+  "name": "@junobuild/ic-client",
+  "version": "0.0.1",
+  "description": "Agent and actor with generated bindings for Juno on the Internet Computer",
+  "author": "David Dal Busco (https://daviddalbusco.com)",
+  "license": "MIT",
+  "type": "module",
+  "main": "./dist/node/index.mjs",
+  "module": "./dist/browser/index.js",
+  "types": "./dist/types/index.d.ts",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/types/index.d.ts",
+        "default": "./dist/browser/index.js"
+      },
+      "require": {
+        "types": "./dist/types/index.d.ts",
+        "default": "./dist/node/index.mjs"
+      }
+    }
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "scripts": {
+    "rmdir": "node ../../scripts/rmdir.mjs",
+    "ts-declaration": "tsc --emitDeclarationOnly --outDir dist/types",
+    "build": "npm run rmdir && mkdir -p dist && cp -R declarations dist && node esbuild.mjs && npm run ts-declaration",
+    "prepack": "npm run build"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/junobuild/juno-js.git",
+    "directory": "packages/ic-client"
+  },
+  "bugs": {
+    "url": "https://github.com/junobuild/juno-js"
+  },
+  "keywords": [
+    "juno",
+    "internet-computer",
+    "ic",
+    "dfinity",
+    "canister",
+    "agent",
+    "actor",
+    "candid",
+    "idl",
+    "bindings",
+    "sdk",
+    "client"
+  ],
+  "homepage": "https://juno.build",
+  "peerDependencies": {
+    "@dfinity/agent": "^2.3.0",
+    "@dfinity/candid": "^2.3.0",
+    "@dfinity/identity": "^2.3.0",
+    "@dfinity/principal": "^2.3.0"
+  }
+}