ic-mops 0.11.0 → 0.12.1

package/commands/sources.js

@@ -112,6 +112,7 @@ export async function sources({verbose} = {}) {
 		let pkgDir;
 		if (pkg.path) {
 			pkgDir = path.relative(process.cwd(), path.resolve(pkg.path));
+			pkgDir = pkgDir.replaceAll('{MOPS_ENV}', process.env.MOPS_ENV || 'local');
 		}
 		else if (pkg.repo) {
 			pkgDir = path.relative(process.cwd(), formatGithubDir(name, pkg.repo));
@@ -130,6 +131,11 @@ export async function sources({verbose} = {}) {
 			pkgBaseDir = path.join(pkgDir, 'src');
 		}
 
+		// use pkgDir if baseDir doesn't exist for local packages
+		if (pkg.path && !fs.existsSync(pkgBaseDir)) {
+			pkgBaseDir = pkgDir;
+		}
+
 		return `--package ${name} ${pkgBaseDir}`;
 	});
 }

package/declarations/main/index.d.ts

@@ -1,16 +1,50 @@
-import { ActorSubclass, HttpAgentOptions, ActorConfig } from '@dfinity/agent';
-import { Principal } from '@dfinity/principal';
+import type {
+  ActorSubclass,
+  HttpAgentOptions,
+  ActorConfig,
+  Agent,
+} from "@dfinity/agent";
+import type { Principal } from "@dfinity/principal";
+import type { IDL } from "@dfinity/candid";
 
 import { _SERVICE } from './main.did';
 
+export declare const idlFactory: IDL.InterfaceFactory;
+export declare const canisterId: string;
+
 export declare interface CreateActorOptions {
+  /**
+   * @see {@link Agent}
+   */
+  agent?: Agent;
+  /**
+   * @see {@link HttpAgentOptions}
+   */
   agentOptions?: HttpAgentOptions;
+  /**
+   * @see {@link ActorConfig}
+   */
   actorOptions?: ActorConfig;
 }
 
+/**
+ * Intializes an {@link ActorSubclass}, configured with the provided SERVICE interface of a canister.
+ * @constructs {@link ActorSubClass}
+ * @param {string | Principal} canisterId - ID of the canister the {@link Actor} will talk to
+ * @param {CreateActorOptions} options - see {@link CreateActorOptions}
+ * @param {CreateActorOptions["agent"]} options.agent - a pre-configured agent you'd like to use. Supercedes agentOptions
+ * @param {CreateActorOptions["agentOptions"]} options.agentOptions - options to set up a new agent
+ * @see {@link HttpAgentOptions}
+ * @param {CreateActorOptions["actorOptions"]} options.actorOptions - options for the Actor
+ * @see {@link ActorConfig}
+ */
 export declare const createActor: (
   canisterId: string | Principal,
-  options: CreateActorOptions
+  options?: CreateActorOptions
 ) => ActorSubclass<_SERVICE>;
 
+/**
+ * Intialized Actor using default settings, ready to talk to a canister using its candid interface
+ * @constructs {@link ActorSubClass}
+ */
 export declare const main: ActorSubclass<_SERVICE>;

package/declarations/main/index.js

@@ -1,28 +1,27 @@
 import { Actor, HttpAgent } from "@dfinity/agent";
 
 // Imports and re-exports candid interface
-import { idlFactory } from './main.did.js';
-export { idlFactory } from './main.did.js';
+import { idlFactory } from "./main.did.js";
+export { idlFactory } from "./main.did.js";
+
 // CANISTER_ID is replaced by webpack based on node environment
 export const canisterId = process.env.MAIN_CANISTER_ID;
 
-/**
- * @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("./main.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 });
-  
+
+  if (options.agent && options.agentOptions) {
+    console.warn(
+      "Detected both agent and agentOptions passed to createActor. Ignoring agentOptions and proceeding with the provided agent."
+    );
+  }
+
   // 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");
+    agent.fetchRootKey().catch((err) => {
+      console.warn(
+        "Unable to fetch root key. Check to ensure that your local replica is running"
+      );
       console.error(err);
     });
   }
@@ -31,12 +30,8 @@ See https://internetcomputer.org/docs/current/developer-docs/updates/release-not
   return Actor.createActor(idlFactory, {
     agent,
     canisterId,
-    ...(options ? options.actorOptions : {}),
+    ...options.actorOptions,
   });
 };
-  
-/**
- * A ready-to-use agent for the main canister
- * @type {import("@dfinity/agent").ActorSubclass<import("./main.did.js")._SERVICE>}
- */
+
 export const main = createActor(canisterId);

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "ic-mops",
-	"version": "0.11.0",
+	"version": "0.12.1",
 	"type": "module",
 	"bin": {
 		"mops": "cli.js"