@dfinity/pic 0.12.0-b0

package/dist/pocket-ic-deferred-actor.js

@@ -0,0 +1,44 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createDeferredActorClass = createDeferredActorClass;
+const candid_1 = require("@dfinity/candid");
+const principal_1 = require("@dfinity/principal");
+const util_1 = require("./util");
+function createDeferredActorClass(interfaceFactory, canisterId, pocketIcClient) {
+    const service = interfaceFactory({ IDL: candid_1.IDL });
+    let sender = null;
+    function createDeferredActorMethod(method, func) {
+        return async function (...args) {
+            const arg = candid_1.IDL.encode(func.argTypes, args);
+            const sender = getSender();
+            const messageId = await pocketIcClient.submitCall({
+                canisterId,
+                sender,
+                method,
+                payload: new Uint8Array(arg),
+            });
+            return function () {
+                return new Promise(async (resolve) => {
+                    const res = await pocketIcClient.awaitCall(messageId);
+                    const decodedRes = (0, util_1.decodeCandid)(func.retTypes, res.body);
+                    return resolve(decodedRes);
+                });
+            };
+        };
+    }
+    function getSender() {
+        return sender ?? principal_1.Principal.anonymous();
+    }
+    const DeferredActor = function () { };
+    DeferredActor.prototype.setPrincipal = function (newSender) {
+        sender = newSender;
+    };
+    DeferredActor.prototype.setIdentity = function (identity) {
+        sender = identity.getPrincipal();
+    };
+    service._fields.forEach(([methodName, func]) => {
+        DeferredActor.prototype[methodName] = createDeferredActorMethod(methodName, func);
+    });
+    return DeferredActor;
+}
+//# sourceMappingURL=pocket-ic-deferred-actor.js.map

package/dist/pocket-ic-deferred-actor.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"pocket-ic-deferred-actor.js","sourceRoot":"","sources":["../src/pocket-ic-deferred-actor.ts"],"names":[],"mappings":";;AA+EA,4DA0DC;AAzID,4CAAsC;AACtC,kDAA+C;AAI/C,iCAAsC;AA0EtC,SAAgB,wBAAwB,CAGtC,gBAAsC,EACtC,UAAqB,EACrB,cAA8B;IAE9B,MAAM,OAAO,GAAG,gBAAgB,CAAC,EAAE,GAAG,EAAH,YAAG,EAAE,CAAC,CAAC;IAC1C,IAAI,MAAM,GAAqB,IAAI,CAAC;IAEpC,SAAS,yBAAyB,CAChC,MAAc,EACd,IAAmB;QAEnB,OAAO,KAAK,WAAW,GAAG,IAAI;YAC5B,MAAM,GAAG,GAAG,YAAG,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;YAC5C,MAAM,MAAM,GAAG,SAAS,EAAE,CAAC;YAE3B,MAAM,SAAS,GAAG,MAAM,cAAc,CAAC,UAAU,CAAC;gBAChD,UAAU;gBACV,MAAM;gBACN,MAAM;gBACN,OAAO,EAAE,IAAI,UAAU,CAAC,GAAG,CAAC;aAC7B,CAAC,CAAC;YAEH,OAAO;gBACL,OAAO,IAAI,OAAO,CAAC,KAAK,EAAC,OAAO,EAAC,EAAE;oBACjC,MAAM,GAAG,GAAG,MAAM,cAAc,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;oBACtD,MAAM,UAAU,GAAG,IAAA,mBAAY,EAAC,IAAI,CAAC,QAAQ,EAAE,GAAG,CAAC,IAAI,CAAC,CAAC;oBAEzD,OAAO,OAAO,CAAC,UAAU,CAAC,CAAC;gBAC7B,CAAC,CAAC,CAAC;YACL,CAAC,CAAC;QACJ,CAAC,CAAC;IACJ,CAAC;IAED,SAAS,SAAS;QAChB,OAAO,MAAM,IAAI,qBAAS,CAAC,SAAS,EAAE,CAAC;IACzC,CAAC;IAED,MAAM,aAAa,GAAG,cAAa,CAAC,CAAC;IAErC,aAAa,CAAC,SAAS,CAAC,YAAY,GAAG,UAAU,SAAoB;QACnE,MAAM,GAAG,SAAS,CAAC;IACrB,CAAC,CAAC;IAEF,aAAa,CAAC,SAAS,CAAC,WAAW,GAAG,UAAU,QAAkB;QAChE,MAAM,GAAG,QAAQ,CAAC,YAAY,EAAE,CAAC;IACnC,CAAC,CAAC;IAEF,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,UAAU,EAAE,IAAI,CAAC,EAAE,EAAE;QAC7C,aAAa,CAAC,SAAS,CAAC,UAAU,CAAC,GAAG,yBAAyB,CAC7D,UAAU,EACV,IAAI,CACL,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,OAAO,aAA0C,CAAC;AACpD,CAAC"}

package/dist/pocket-ic-server-types.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Options for starting a PocketIC server.
+ */
+export interface StartServerOptions {
+    /**
+     * Whether to pipe the runtimes's logs to the parent process's stdout.
+     */
+    showRuntimeLogs?: boolean;
+    /**
+     * Whether to pipe the canister logs to the parent process's stderr.
+     */
+    showCanisterLogs?: boolean;
+}

package/dist/pocket-ic-server-types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=pocket-ic-server-types.js.map

package/dist/pocket-ic-server-types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"pocket-ic-server-types.js","sourceRoot":"","sources":["../src/pocket-ic-server-types.ts"],"names":[],"mappings":""}

package/dist/pocket-ic-server.d.ts

@@ -0,0 +1,53 @@
+import { StartServerOptions } from './pocket-ic-server-types';
+/**
+ * This class represents the main PocketIC server.
+ * It is responsible for maintaining the lifecycle of the server process.
+ * See {@link PocketIc} for details on the client to use with this server.
+ *
+ * @category API
+ *
+ * @example
+ * ```ts
+ * import { PocketIc, PocketIcServer } from '@dfinity/pic';
+ * import { _SERVICE, idlFactory } from '../declarations';
+ *
+ * const wasmPath = resolve('..', '..', 'canister.wasm');
+ *
+ * const picServer = await PocketIcServer.create();
+ * const pic = await PocketIc.create(picServer.getUrl());
+ *
+ * const fixture = await pic.setupCanister<_SERVICE>({ idlFactory, wasmPath });
+ * const { actor } = fixture;
+ *
+ * // perform tests...
+ *
+ * await pic.tearDown();
+ * await picServer.stop();
+ * ```
+ */
+export declare class PocketIcServer {
+    private readonly serverProcess;
+    private readonly url;
+    private constructor();
+    /**
+     * Start a new PocketIC server.
+     *
+     * @param options Options for starting the server.
+     * @returns An instance of the PocketIC server.
+     */
+    static start(options?: StartServerOptions): Promise<PocketIcServer>;
+    /**
+     * Get the URL of the server.
+     *
+     * @returns The URL of the server.
+     */
+    getUrl(): string;
+    /**
+     * Stop the server.
+     *
+     * @returns A promise that resolves when the server has stopped.
+     */
+    stop(): Promise<void>;
+    private static getBinPath;
+    private static assertBinExists;
+}

package/dist/pocket-ic-server.js

@@ -0,0 +1,126 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PocketIcServer = void 0;
+const node_child_process_1 = require("node:child_process");
+const node_path_1 = require("node:path");
+const node_fs_1 = require("node:fs");
+const error_1 = require("./error");
+const util_1 = require("./util");
+const node_stream_1 = require("node:stream");
+/**
+ * This class represents the main PocketIC server.
+ * It is responsible for maintaining the lifecycle of the server process.
+ * See {@link PocketIc} for details on the client to use with this server.
+ *
+ * @category API
+ *
+ * @example
+ * ```ts
+ * import { PocketIc, PocketIcServer } from '@dfinity/pic';
+ * import { _SERVICE, idlFactory } from '../declarations';
+ *
+ * const wasmPath = resolve('..', '..', 'canister.wasm');
+ *
+ * const picServer = await PocketIcServer.create();
+ * const pic = await PocketIc.create(picServer.getUrl());
+ *
+ * const fixture = await pic.setupCanister<_SERVICE>({ idlFactory, wasmPath });
+ * const { actor } = fixture;
+ *
+ * // perform tests...
+ *
+ * await pic.tearDown();
+ * await picServer.stop();
+ * ```
+ */
+class PocketIcServer {
+    serverProcess;
+    url;
+    constructor(serverProcess, portNumber) {
+        this.serverProcess = serverProcess;
+        this.url = `http://127.0.0.1:${portNumber}`;
+    }
+    /**
+     * Start a new PocketIC server.
+     *
+     * @param options Options for starting the server.
+     * @returns An instance of the PocketIC server.
+     */
+    static async start(options = {}) {
+        const binPath = this.getBinPath();
+        await this.assertBinExists(binPath);
+        const pid = process.ppid;
+        const picFilePrefix = `pocket_ic_${pid}`;
+        const portFilePath = (0, util_1.tmpFile)(`${picFilePrefix}.port`);
+        const serverProcess = (0, node_child_process_1.spawn)(binPath, ['--port-file', portFilePath]);
+        if (options.showRuntimeLogs) {
+            serverProcess.stdout.pipe(process.stdout);
+        }
+        else {
+            serverProcess.stdout.pipe(new NullStream());
+        }
+        if (options.showCanisterLogs) {
+            serverProcess.stderr.pipe(process.stderr);
+        }
+        else {
+            serverProcess.stderr.pipe(new NullStream());
+        }
+        serverProcess.on('error', error => {
+            if ((0, util_1.isArm)() && (0, util_1.isDarwin)()) {
+                throw new error_1.BinStartMacOSArmError(error);
+            }
+            throw new error_1.BinStartError(error);
+        });
+        return await (0, util_1.poll)(async () => {
+            const portString = await (0, util_1.readFileAsString)(portFilePath);
+            const port = parseInt(portString);
+            if (isNaN(port)) {
+                throw new error_1.BinTimeoutError();
+            }
+            return new PocketIcServer(serverProcess, port);
+        }, { intervalMs: POLL_INTERVAL_MS, timeoutMs: POLL_TIMEOUT_MS });
+    }
+    /**
+     * Get the URL of the server.
+     *
+     * @returns The URL of the server.
+     */
+    getUrl() {
+        return this.url;
+    }
+    /**
+     * Stop the server.
+     *
+     * @returns A promise that resolves when the server has stopped.
+     */
+    async stop() {
+        return new Promise((resolve, reject) => {
+            this.serverProcess.on('exit', () => {
+                resolve();
+            });
+            this.serverProcess.on('error', error => {
+                reject(error);
+            });
+            this.serverProcess.kill();
+        });
+    }
+    static getBinPath() {
+        return (0, node_path_1.resolve)(__dirname, '..', 'pocket-ic');
+    }
+    static async assertBinExists(binPath) {
+        const binExists = await (0, util_1.exists)(binPath);
+        if (!binExists) {
+            throw new error_1.BinNotFoundError(binPath);
+        }
+        (0, node_fs_1.chmodSync)(binPath, 0o700);
+    }
+}
+exports.PocketIcServer = PocketIcServer;
+const POLL_INTERVAL_MS = 20;
+const POLL_TIMEOUT_MS = 30_000;
+class NullStream extends node_stream_1.Writable {
+    _write(_chunk, _encoding, callback) {
+        callback();
+    }
+}
+//# sourceMappingURL=pocket-ic-server.js.map

package/dist/pocket-ic-server.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"pocket-ic-server.js","sourceRoot":"","sources":["../src/pocket-ic-server.ts"],"names":[],"mappings":";;;AAAA,2DAAyD;AACzD,yCAAoC;AACpC,qCAAoC;AACpC,mCAKiB;AACjB,iCAOgB;AAEhB,6CAAuC;AAEvC;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,MAAa,cAAc;IAIN;IAHF,GAAG,CAAS;IAE7B,YACmB,aAA2B,EAC5C,UAAkB;QADD,kBAAa,GAAb,aAAa,CAAc;QAG5C,IAAI,CAAC,GAAG,GAAG,oBAAoB,UAAU,EAAE,CAAC;IAC9C,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,KAAK,CAAC,KAAK,CACvB,UAA8B,EAAE;QAEhC,MAAM,OAAO,GAAG,IAAI,CAAC,UAAU,EAAE,CAAC;QAClC,MAAM,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC;QAEpC,MAAM,GAAG,GAAG,OAAO,CAAC,IAAI,CAAC;QACzB,MAAM,aAAa,GAAG,aAAa,GAAG,EAAE,CAAC;QACzC,MAAM,YAAY,GAAG,IAAA,cAAO,EAAC,GAAG,aAAa,OAAO,CAAC,CAAC;QAEtD,MAAM,aAAa,GAAG,IAAA,0BAAK,EAAC,OAAO,EAAE,CAAC,aAAa,EAAE,YAAY,CAAC,CAAC,CAAC;QAEpE,IAAI,OAAO,CAAC,eAAe,EAAE,CAAC;YAC5B,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QAC5C,CAAC;aAAM,CAAC;YACN,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,UAAU,EAAE,CAAC,CAAC;QAC9C,CAAC;QAED,IAAI,OAAO,CAAC,gBAAgB,EAAE,CAAC;YAC7B,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QAC5C,CAAC;aAAM,CAAC;YACN,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,UAAU,EAAE,CAAC,CAAC;QAC9C,CAAC;QAED,aAAa,CAAC,EAAE,CAAC,OAAO,EAAE,KAAK,CAAC,EAAE;YAChC,IAAI,IAAA,YAAK,GAAE,IAAI,IAAA,eAAQ,GAAE,EAAE,CAAC;gBAC1B,MAAM,IAAI,6BAAqB,CAAC,KAAK,CAAC,CAAC;YACzC,CAAC;YAED,MAAM,IAAI,qBAAa,CAAC,KAAK,CAAC,CAAC;QACjC,CAAC,CAAC,CAAC;QAEH,OAAO,MAAM,IAAA,WAAI,EACf,KAAK,IAAI,EAAE;YACT,MAAM,UAAU,GAAG,MAAM,IAAA,uBAAgB,EAAC,YAAY,CAAC,CAAC;YACxD,MAAM,IAAI,GAAG,QAAQ,CAAC,UAAU,CAAC,CAAC;YAClC,IAAI,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC;gBAChB,MAAM,IAAI,uBAAe,EAAE,CAAC;YAC9B,CAAC;YAED,OAAO,IAAI,cAAc,CAAC,aAAa,EAAE,IAAI,CAAC,CAAC;QACjD,CAAC,EACD,EAAE,UAAU,EAAE,gBAAgB,EAAE,SAAS,EAAE,eAAe,EAAE,CAC7D,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACI,MAAM;QACX,OAAO,IAAI,CAAC,GAAG,CAAC;IAClB,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,IAAI;QACf,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACrC,IAAI,CAAC,aAAa,CAAC,EAAE,CAAC,MAAM,EAAE,GAAG,EAAE;gBACjC,OAAO,EAAE,CAAC;YACZ,CAAC,CAAC,CAAC;YAEH,IAAI,CAAC,aAAa,CAAC,EAAE,CAAC,OAAO,EAAE,KAAK,CAAC,EAAE;gBACrC,MAAM,CAAC,KAAK,CAAC,CAAC;YAChB,CAAC,CAAC,CAAC;YAEH,IAAI,CAAC,aAAa,CAAC,IAAI,EAAE,CAAC;QAC5B,CAAC,CAAC,CAAC;IACL,CAAC;IAEO,MAAM,CAAC,UAAU;QACvB,OAAO,IAAA,mBAAO,EAAC,SAAS,EAAE,IAAI,EAAE,WAAW,CAAC,CAAC;IAC/C,CAAC;IAEO,MAAM,CAAC,KAAK,CAAC,eAAe,CAAC,OAAe;QAClD,MAAM,SAAS,GAAG,MAAM,IAAA,aAAM,EAAC,OAAO,CAAC,CAAC;QAExC,IAAI,CAAC,SAAS,EAAE,CAAC;YACf,MAAM,IAAI,wBAAgB,CAAC,OAAO,CAAC,CAAC;QACtC,CAAC;QAED,IAAA,mBAAS,EAAC,OAAO,EAAE,KAAK,CAAC,CAAC;IAC5B,CAAC;CACF;AAvGD,wCAuGC;AAED,MAAM,gBAAgB,GAAG,EAAE,CAAC;AAC5B,MAAM,eAAe,GAAG,MAAM,CAAC;AAE/B,MAAM,UAAW,SAAQ,sBAAQ;IAC/B,MAAM,CACJ,MAAW,EACX,SAAyB,EACzB,QAAwC;QAExC,QAAQ,EAAE,CAAC;IACb,CAAC;CACF"}