ic-mops 1.12.0 → 2.0.0

package/tests/__snapshots__/cli.test.ts.snap

@@ -0,0 +1,202 @@
+// Jest Snapshot v1, https://jestjs.io/docs/snapshot-testing
+
+exports[`mops build error 1`] = `
+{
+  "exitCode": 0,
+  "stderr": "",
+  "stdout": "
+> ic-mops@1.13.0 mops
+> tsx ./environments/nodejs/cli build foo
+
+build canister foo
+
+✓ Built 1 canister successfully",
+}
+`;
+
+exports[`mops build error 2`] = `
+{
+  "exitCode": 1,
+  "stderr": "Candid compatibility check failed for canister bar",
+  "stdout": "
+> ic-mops@1.13.0 mops
+> tsx ./environments/nodejs/cli build bar
+
+build canister bar",
+}
+`;
+
+exports[`mops build error 3`] = `
+{
+  "exitCode": 1,
+  "stderr": "Candid compatibility check failed for canister bar",
+  "stdout": "
+> ic-mops@1.13.0 mops
+> tsx ./environments/nodejs/cli build foo bar
+
+build canister foo
+build canister bar",
+}
+`;
+
+exports[`mops build success 1`] = `
+{
+  "exitCode": 0,
+  "stderr": "",
+  "stdout": "
+> ic-mops@1.13.0 mops
+> tsx ./environments/nodejs/cli build
+
+build canister foo
+build canister bar
+
+✓ Built 2 canisters successfully",
+}
+`;
+
+exports[`mops build success 2`] = `
+{
+  "exitCode": 0,
+  "stderr": "",
+  "stdout": "
+> ic-mops@1.13.0 mops
+> tsx ./environments/nodejs/cli build foo
+
+build canister foo
+
+✓ Built 1 canister successfully",
+}
+`;
+
+exports[`mops build success 3`] = `
+{
+  "exitCode": 0,
+  "stderr": "",
+  "stdout": "
+> ic-mops@1.13.0 mops
+> tsx ./environments/nodejs/cli build bar
+
+build canister bar
+
+✓ Built 1 canister successfully",
+}
+`;
+
+exports[`mops build success 4`] = `
+{
+  "exitCode": 0,
+  "stderr": "",
+  "stdout": "
+> ic-mops@1.13.0 mops
+> tsx ./environments/nodejs/cli build foo bar
+
+build canister foo
+build canister bar
+
+✓ Built 2 canisters successfully",
+}
+`;
+
+exports[`mops check-candid 1`] = `
+{
+  "exitCode": 0,
+  "stderr": "",
+  "stdout": "
+> ic-mops@1.13.0 mops
+> tsx ./environments/nodejs/cli check-candid a.did a.did
+
+✓ Candid compatibility check passed",
+}
+`;
+
+exports[`mops check-candid 2`] = `
+{
+  "exitCode": 0,
+  "stderr": "",
+  "stdout": "
+> ic-mops@1.13.0 mops
+> tsx ./environments/nodejs/cli check-candid b.did b.did
+
+✓ Candid compatibility check passed",
+}
+`;
+
+exports[`mops check-candid 3`] = `
+{
+  "exitCode": 0,
+  "stderr": "",
+  "stdout": "
+> ic-mops@1.13.0 mops
+> tsx ./environments/nodejs/cli check-candid c.did c.did
+
+✓ Candid compatibility check passed",
+}
+`;
+
+exports[`mops check-candid 4`] = `
+{
+  "exitCode": 0,
+  "stderr": "",
+  "stdout": "
+> ic-mops@1.13.0 mops
+> tsx ./environments/nodejs/cli check-candid a.did b.did
+
+✓ Candid compatibility check passed",
+}
+`;
+
+exports[`mops check-candid 5`] = `
+{
+  "exitCode": 0,
+  "stderr": "",
+  "stdout": "
+> ic-mops@1.13.0 mops
+> tsx ./environments/nodejs/cli check-candid b.did a.did
+
+✓ Candid compatibility check passed",
+}
+`;
+
+exports[`mops check-candid 6`] = `
+{
+  "exitCode": 1,
+  "stderr": "✖ Candid compatibility check failed",
+  "stdout": "
+> ic-mops@1.13.0 mops
+> tsx ./environments/nodejs/cli check-candid a.did c.did
+",
+}
+`;
+
+exports[`mops check-candid 7`] = `
+{
+  "exitCode": 1,
+  "stderr": "✖ Candid compatibility check failed",
+  "stdout": "
+> ic-mops@1.13.0 mops
+> tsx ./environments/nodejs/cli check-candid c.did a.did
+",
+}
+`;
+
+exports[`mops check-candid 8`] = `
+{
+  "exitCode": 1,
+  "stderr": "✖ Candid compatibility check failed",
+  "stdout": "
+> ic-mops@1.13.0 mops
+> tsx ./environments/nodejs/cli check-candid b.did c.did
+",
+}
+`;
+
+exports[`mops check-candid 9`] = `
+{
+  "exitCode": 1,
+  "stderr": "✖ Candid compatibility check failed",
+  "stdout": "
+> ic-mops@1.13.0 mops
+> tsx ./environments/nodejs/cli check-candid c.did b.did
+",
+}
+`;

package/tests/build/error/candid/bar.did

@@ -0,0 +1,3 @@
+service : {
+  call: () -> (nat);
+}

package/tests/build/error/dfx.json

@@ -0,0 +1,12 @@
+{
+  "canisters": {
+    "foo": {
+      "type": "motoko",
+      "main": "src/Foo.mo"
+    },
+    "bar": {
+      "type": "motoko",
+      "main": "src/Bar.mo"
+    }
+  }
+}

package/tests/build/error/mops.toml

@@ -0,0 +1,9 @@
+[dependencies]
+core = "1.0.0"
+
+[canisters]
+foo = "src/Foo.mo"
+bar = { main = "src/Bar.mo", args = ["--incremental-gc"], candid = "candid/bar.did" }
+
+[build]
+args = ["--release"]

package/tests/build/error/src/Bar.mo

@@ -0,0 +1,5 @@
+persistent actor {
+  public func call() : async Text {
+    "Hello";
+  };
+};

package/tests/build/error/src/Foo.mo

@@ -0,0 +1,5 @@
+persistent actor {
+  public func call() : async Text {
+    "Foo";
+  };
+};

package/tests/build/success/.dfx/local/canister_ids.json

@@ -0,0 +1,17 @@
+{
+  "__Candid_UI": {
+    "local": "ufxgi-4p777-77774-qaadq-cai"
+  },
+  "a": {
+    "local": "uzt4z-lp777-77774-qaabq-cai"
+  },
+  "b": {
+    "local": "umunu-kh777-77774-qaaca-cai"
+  },
+  "bar": {
+    "local": "ulvla-h7777-77774-qaacq-cai"
+  },
+  "foo": {
+    "local": "ucwa4-rx777-77774-qaada-cai"
+  }
+}

package/tests/build/success/.dfx/local/canisters/bar/bar.did

@@ -0,0 +1,3 @@
+service : {
+  call: () -> (text);
+}

package/tests/build/success/.dfx/local/canisters/bar/bar.most

@@ -0,0 +1,4 @@
+// Version: 1.0.0
+actor {
+  
+};

package/tests/build/success/.dfx/local/canisters/bar/constructor.did

@@ -0,0 +1,3 @@
+service : {
+  call: () -> (text);
+}

package/tests/build/success/.dfx/local/canisters/bar/index.js

@@ -0,0 +1,42 @@
+import { Actor, HttpAgent } from "@dfinity/agent";
+
+// Imports and re-exports candid interface
+import { idlFactory } from './bar.did.js';
+export { idlFactory } from './bar.did.js';
+// CANISTER_ID is replaced by webpack based on node environment
+export const canisterId = process.env.CANISTER_ID_BAR;
+
+/**
+ * @deprecated since dfx 0.11.1
+ * Do not import from `.dfx`, instead switch to using `dfx generate` to generate your JS interface.
+ * @param {string | import("@dfinity/principal").Principal} canisterId Canister ID of Agent
+ * @param {{agentOptions?: import("@dfinity/agent").HttpAgentOptions; actorOptions?: import("@dfinity/agent").ActorConfig} | { agent?: import("@dfinity/agent").Agent; actorOptions?: import("@dfinity/agent").ActorConfig }} [options]
+ * @return {import("@dfinity/agent").ActorSubclass<import("./bar.did.js")._SERVICE>}
+ */
+export const createActor = (canisterId, options = {}) => {
+  console.warn(`Deprecation warning: you are currently importing code from .dfx. Going forward, refactor to use the dfx generate command for JavaScript bindings.
+
+See https://internetcomputer.org/docs/current/developer-docs/updates/release-notes/ for migration instructions`);
+  const agent = options.agent || new HttpAgent({ ...options.agentOptions });
+  
+  // Fetch root key for certificate validation during development
+  if (process.env.DFX_NETWORK !== "ic") {
+    agent.fetchRootKey().catch(err => {
+      console.warn("Unable to fetch root key. Check to ensure that your local replica is running");
+      console.error(err);
+    });
+  }
+
+  // Creates an actor with using the candid interface and the HttpAgent
+  return Actor.createActor(idlFactory, {
+    agent,
+    canisterId,
+    ...(options ? options.actorOptions : {}),
+  });
+};
+  
+/**
+ * A ready-to-use agent for the bar canister
+ * @type {import("@dfinity/agent").ActorSubclass<import("./bar.did.js")._SERVICE>}
+ */
+export const bar = createActor(canisterId);

package/tests/build/success/.dfx/local/canisters/bar/init_args.txt

@@ -0,0 +1 @@
+()

package/tests/build/success/.dfx/local/canisters/bar/service.did

@@ -0,0 +1,3 @@
+service : {
+  call: () -> (text);
+}

package/tests/build/success/.dfx/local/canisters/bar/service.did.d.ts

@@ -0,0 +1,7 @@
+import type { Principal } from '@dfinity/principal';
+import type { ActorMethod } from '@dfinity/agent';
+import type { IDL } from '@dfinity/candid';
+
+export interface _SERVICE { 'call' : ActorMethod<[], string> }
+export declare const idlFactory: IDL.InterfaceFactory;
+export declare const init: (args: { IDL: typeof IDL }) => IDL.Type[];

package/tests/build/success/.dfx/local/canisters/bar/service.did.js

@@ -0,0 +1,4 @@
+export const idlFactory = ({ IDL }) => {
+  return IDL.Service({ 'call' : IDL.Func([], [IDL.Text], []) });
+};
+export const init = ({ IDL }) => { return []; };

package/tests/build/success/.dfx/local/canisters/foo/constructor.did

@@ -0,0 +1,3 @@
+service : {
+  call: () -> (text);
+}

package/tests/build/success/.dfx/local/canisters/foo/foo.did

@@ -0,0 +1,3 @@
+service : {
+  call: () -> (text);
+}

package/tests/build/success/.dfx/local/canisters/foo/foo.most

@@ -0,0 +1,4 @@
+// Version: 1.0.0
+actor {
+  
+};

package/tests/build/success/.dfx/local/canisters/foo/index.js

@@ -0,0 +1,42 @@
+import { Actor, HttpAgent } from "@dfinity/agent";
+
+// Imports and re-exports candid interface
+import { idlFactory } from './foo.did.js';
+export { idlFactory } from './foo.did.js';
+// CANISTER_ID is replaced by webpack based on node environment
+export const canisterId = process.env.CANISTER_ID_FOO;
+
+/**
+ * @deprecated since dfx 0.11.1
+ * Do not import from `.dfx`, instead switch to using `dfx generate` to generate your JS interface.
+ * @param {string | import("@dfinity/principal").Principal} canisterId Canister ID of Agent
+ * @param {{agentOptions?: import("@dfinity/agent").HttpAgentOptions; actorOptions?: import("@dfinity/agent").ActorConfig} | { agent?: import("@dfinity/agent").Agent; actorOptions?: import("@dfinity/agent").ActorConfig }} [options]
+ * @return {import("@dfinity/agent").ActorSubclass<import("./foo.did.js")._SERVICE>}
+ */
+export const createActor = (canisterId, options = {}) => {
+  console.warn(`Deprecation warning: you are currently importing code from .dfx. Going forward, refactor to use the dfx generate command for JavaScript bindings.
+
+See https://internetcomputer.org/docs/current/developer-docs/updates/release-notes/ for migration instructions`);
+  const agent = options.agent || new HttpAgent({ ...options.agentOptions });
+  
+  // Fetch root key for certificate validation during development
+  if (process.env.DFX_NETWORK !== "ic") {
+    agent.fetchRootKey().catch(err => {
+      console.warn("Unable to fetch root key. Check to ensure that your local replica is running");
+      console.error(err);
+    });
+  }
+
+  // Creates an actor with using the candid interface and the HttpAgent
+  return Actor.createActor(idlFactory, {
+    agent,
+    canisterId,
+    ...(options ? options.actorOptions : {}),
+  });
+};
+  
+/**
+ * A ready-to-use agent for the foo canister
+ * @type {import("@dfinity/agent").ActorSubclass<import("./foo.did.js")._SERVICE>}
+ */
+export const foo = createActor(canisterId);

package/tests/build/success/.dfx/local/canisters/foo/init_args.txt

@@ -0,0 +1 @@
+()

package/tests/build/success/.dfx/local/canisters/foo/service.did

@@ -0,0 +1,3 @@
+service : {
+  call: () -> (text);
+}

package/tests/build/success/.dfx/local/canisters/foo/service.did.d.ts

@@ -0,0 +1,7 @@
+import type { Principal } from '@dfinity/principal';
+import type { ActorMethod } from '@dfinity/agent';
+import type { IDL } from '@dfinity/candid';
+
+export interface _SERVICE { 'call' : ActorMethod<[], string> }
+export declare const idlFactory: IDL.InterfaceFactory;
+export declare const init: (args: { IDL: typeof IDL }) => IDL.Type[];

package/tests/build/success/.dfx/local/canisters/foo/service.did.js

@@ -0,0 +1,4 @@
+export const idlFactory = ({ IDL }) => {
+  return IDL.Service({ 'call' : IDL.Func([], [IDL.Text], []) });
+};
+export const init = ({ IDL }) => { return []; };

package/tests/build/success/.dfx/local/lsp/ucwa4-rx777-77774-qaada-cai.did

@@ -0,0 +1,3 @@
+service : {
+  call: () -> (text);
+}

package/tests/build/success/.dfx/local/lsp/ulvla-h7777-77774-qaacq-cai.did

@@ -0,0 +1,3 @@
+service : {
+  call: () -> (text);
+}

package/tests/build/success/.dfx/local/network-id

@@ -0,0 +1,4 @@
+{
+  "created": "2025-09-11 02:20:43.69975 +00:00:00",
+  "settings_digest": "685af83dea9d217efa2077ec50e8b0ed561d1c292a5454dacdc43d3b5e45306f"
+}

package/tests/build/success/candid/bar.did

@@ -0,0 +1,3 @@
+service : {
+  call: () -> (text);
+}

package/tests/build/success/dfx.json

@@ -0,0 +1,12 @@
+{
+  "canisters": {
+    "foo": {
+      "type": "motoko",
+      "main": "src/Foo.mo"
+    },
+    "bar": {
+      "type": "motoko",
+      "main": "src/Bar.mo"
+    }
+  }
+}

package/tests/build/success/mops.toml

@@ -0,0 +1,9 @@
+[dependencies]
+core = "1.0.0"
+
+[canisters]
+foo = "src/Foo.mo"
+bar = { main = "src/Bar.mo", args = ["--incremental-gc"], candid = "candid/bar.did" }
+
+[build]
+args = ["--release"]

package/tests/build/success/src/Bar.mo

@@ -0,0 +1,5 @@
+persistent actor {
+  public func call() : async Text {
+    "Hello";
+  };
+};

package/tests/build/success/src/Foo.mo

@@ -0,0 +1,5 @@
+persistent actor {
+  public func call() : async Text {
+    "Foo";
+  };
+};

package/tests/check-candid/a.did

@@ -0,0 +1,3 @@
+service : {
+  call: () -> (text);
+}

package/tests/check-candid/b.did

@@ -0,0 +1,5 @@
+type ReturnValue = text;
+
+service : {
+  call: () -> (ReturnValue);
+}

package/tests/check-candid/c.did

@@ -0,0 +1,3 @@
+service : {
+  call: (text) -> (nat);
+}

package/tests/cli.test.ts

@@ -0,0 +1,82 @@
+import { describe, expect, test } from "@jest/globals";
+import { execa } from "execa";
+import path from "path";
+
+interface CliOptions {
+  cwd?: string;
+}
+
+const cli = async (args: string[], { cwd }: CliOptions = {}) => {
+  return await execa("npm", ["run", "mops", "--", ...args], {
+    env: { MOPS_CWD: cwd },
+    stdio: "pipe",
+    reject: false,
+  });
+};
+
+const cliSnapshot = async (
+  args: string[],
+  options: CliOptions,
+  exitCode: number,
+) => {
+  const result = await cli(args, options);
+  expect({
+    command: result.command,
+    exitCode: result.exitCode,
+    timedOut: result.timedOut,
+    stdio: Boolean(result.stdout || result.stderr),
+  }).toEqual({
+    command: result.command,
+    exitCode,
+    timedOut: false,
+    stdio: true,
+  });
+  expect({
+    exitCode: result.exitCode,
+    stdout: result.stdout,
+    stderr: result.stderr,
+  }).toMatchSnapshot();
+  return result;
+};
+
+describe("mops", () => {
+  test("version", async () => {
+    expect((await cli(["--version"])).stdout).toMatch(/CLI \d+\.\d+\.\d+/);
+  });
+
+  test("help", async () => {
+    expect((await cli(["--help"])).stdout).toMatch(/^Usage: mops/m);
+  });
+
+  test("build success", async () => {
+    const cwd = path.join(import.meta.dirname, "build/success");
+    await cliSnapshot(["build"], { cwd }, 0);
+    await cliSnapshot(["build", "foo"], { cwd }, 0);
+    await cliSnapshot(["build", "bar"], { cwd }, 0);
+    await cliSnapshot(["build", "foo", "bar"], { cwd }, 0);
+  });
+
+  test("build error", async () => {
+    const cwd = path.join(import.meta.dirname, "build/error");
+    await cliSnapshot(["build", "foo"], { cwd }, 0);
+    expect((await cliSnapshot(["build", "bar"], { cwd }, 1)).stderr).toMatch(
+      "Candid compatibility check failed for canister bar",
+    );
+    expect(
+      (await cliSnapshot(["build", "foo", "bar"], { cwd }, 1)).stderr,
+    ).toMatch("Candid compatibility check failed for canister bar");
+  });
+
+  test("check-candid", async () => {
+    const cwd = path.join(import.meta.dirname, "check-candid");
+    await cliSnapshot(["check-candid", "a.did", "a.did"], { cwd }, 0);
+    await cliSnapshot(["check-candid", "b.did", "b.did"], { cwd }, 0);
+    await cliSnapshot(["check-candid", "c.did", "c.did"], { cwd }, 0);
+    await cliSnapshot(["check-candid", "a.did", "b.did"], { cwd }, 0);
+    await cliSnapshot(["check-candid", "b.did", "a.did"], { cwd }, 0);
+    await cliSnapshot(["check-candid", "a.did", "c.did"], { cwd }, 1);
+    await cliSnapshot(["check-candid", "c.did", "a.did"], { cwd }, 1);
+    await cliSnapshot(["check-candid", "b.did", "c.did"], { cwd }, 1);
+    await cliSnapshot(["check-candid", "c.did", "b.did"], { cwd }, 1);
+  });
+});

package/tsconfig.json

@@ -1,20 +1,27 @@
 {
-	"extends": ["@tsconfig/strictest/tsconfig.json"],
-	"include": ["**/*.ts", "**/*.js"],
-	"exclude": ["node_modules", "dist", "bundle", "dist.js", "declarations/**/*.js"],
-	"compilerOptions": {
-		"target": "ES2022",
-		"lib": ["ES2022"],
-		"types": ["node"],
-		"outDir": "./dist",
-		"allowJs": true,
-		"module": "ES2022",
-		"moduleResolution": "bundler",
-		"noEmitOnError": false,
-		"noUnusedLocals": false,
-		"noUnusedParameters": false,
-		"noPropertyAccessFromIndexSignature": false,
-		"exactOptionalPropertyTypes": false,
-		"declaration": true
-	}
-}
+  "extends": ["@tsconfig/strictest/tsconfig.json"],
+  "include": ["**/*.ts", "**/*.js"],
+  "exclude": [
+    "node_modules",
+    "dist",
+    "bundle",
+    "dist.js",
+    "declarations/**/*.js",
+    "wasm/**/*.js"
+  ],
+  "compilerOptions": {
+    "target": "ES2022",
+    "lib": ["ES2022"],
+    "types": ["node"],
+    "outDir": "./dist",
+    "allowJs": true,
+    "module": "ES2022",
+    "moduleResolution": "bundler",
+    "noEmitOnError": false,
+    "noUnusedLocals": false,
+    "noUnusedParameters": false,
+    "noPropertyAccessFromIndexSignature": false,
+    "exactOptionalPropertyTypes": false,
+    "declaration": true
+  }
+}