@project-ajax/sdk 0.0.28 → 0.0.30

package/dist/cli/config.d.ts

@@ -10,24 +10,42 @@ export declare function parseEnvironment(name: string): Environment;
 export declare class TokenNotSetError extends Error {
     constructor(message?: string);
 }
-export declare function parseEnvironmentName(name: string): Environment;
+/**
+ * Manages configuration for the CLI.
+ *
+ * Environment variables take precedence over the config file.
+ *
+ * | Environment Variable | Config File | Description |
+ * |----------------------|-------------|-------------|
+ * | WORKERS_TOKEN        | token       | The token to use for authentication |
+ * | WORKERS_ENVIRONMENT  | environment | The environment to use |
+ * | WORKERS_WORKER_ID    | workerId    | The worker ID to use |
+ * | WORKERS_BASE_URL     | baseUrl     | The base URL to use |
+ */
 export declare class Config {
     #private;
-    constructor(configFilePath: string, configFile: ConfigFile);
-    setEnvironment(environment: Environment): Promise<void>;
-    setBaseUrl(baseUrl: string): Promise<void>;
+    constructor(opts: {
+        configFilePath: string;
+        configFile: ConfigFile;
+        processEnv: NodeJS.ProcessEnv;
+    });
     get baseUrl(): string | undefined;
     get token(): string | null;
+    get environment(): "local" | "staging" | "dev" | "prod" | undefined;
+    get workerId(): string | null;
+    setEnvironment(environment: Environment): Promise<void>;
+    setBaseUrl(baseUrl: string): Promise<void>;
+    setToken(token: string | null): Promise<void>;
+    setWorkerId(workerId: string | null): Promise<void>;
     get tokenInfo(): {
         token: string;
         spaceId: string;
         cellId: string;
     };
-    get environment(): "local" | "staging" | "dev" | "prod" | undefined;
-    get workerId(): string | null;
-    setToken(token: string | null): Promise<void>;
-    setWorkerId(workerId: string | null): Promise<void>;
-    static load(configFilePath: string): Promise<Config>;
+    static load(opts: {
+        configFilePath: string;
+        processEnv: NodeJS.ProcessEnv;
+    }): Promise<Config>;
 }
 export declare function extractPayloadFromToken(token: string): {
     spaceId: string;

package/dist/cli/config.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../../src/cli/config.ts"],"names":[],"mappings":"AAGA,eAAO,MAAM,YAAY,8CAA+C,CAAC;AACzE,MAAM,MAAM,WAAW,GAAG,CAAC,OAAO,YAAY,CAAC,CAAC,MAAM,CAAC,CAAC;AAExD,UAAU,UAAU;IACnB,WAAW,CAAC,EAAE,WAAW,CAAC;IAC1B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;CACxB;AAED,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,MAAM,GAAG,WAAW,CAM1D;AAED,qBAAa,gBAAiB,SAAQ,KAAK;gBAEzC,OAAO,GAAE,MAA6D;CAKvE;AAED,wBAAgB,oBAAoB,CAAC,IAAI,EAAE,MAAM,GAAG,WAAW,CAM9D;AAED,qBAAa,MAAM;;gBAIN,cAAc,EAAE,MAAM,EAAE,UAAU,EAAE,UAAU;IAKpD,cAAc,CAAC,WAAW,EAAE,WAAW;IAKvC,UAAU,CAAC,OAAO,EAAE,MAAM;IAKhC,IAAI,OAAO,uBAEV;IAED,IAAI,KAAK,kBAER;IAED,IAAI,SAAS,IAAI;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,CAQlE;IAED,IAAI,WAAW,qDAEd;IAED,IAAI,QAAQ,kBAEX;IAEK,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IAK7B,WAAW,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI;WAa5B,IAAI,CAAC,cAAc,EAAE,MAAM;CAyBxC;AAQD,wBAAgB,uBAAuB,CAAC,KAAK,EAAE,MAAM,GAAG;IACvD,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,MAAM,CAAC;CACf,CAoCA"}
+{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../../src/cli/config.ts"],"names":[],"mappings":"AAGA,eAAO,MAAM,YAAY,8CAA+C,CAAC;AACzE,MAAM,MAAM,WAAW,GAAG,CAAC,OAAO,YAAY,CAAC,CAAC,MAAM,CAAC,CAAC;AAExD,UAAU,UAAU;IACnB,WAAW,CAAC,EAAE,WAAW,CAAC;IAC1B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;CACxB;AAED,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,MAAM,GAAG,WAAW,CAM1D;AAED,qBAAa,gBAAiB,SAAQ,KAAK;gBAEzC,OAAO,GAAE,MAA6D;CAKvE;AAED;;;;;;;;;;;GAWG;AACH,qBAAa,MAAM;;gBAKN,IAAI,EAAE;QACjB,cAAc,EAAE,MAAM,CAAC;QACvB,UAAU,EAAE,UAAU,CAAC;QACvB,UAAU,EAAE,MAAM,CAAC,UAAU,CAAC;KAC9B;IAQD,IAAI,OAAO,uBAEV;IAED,IAAI,KAAK,kBAER;IAED,IAAI,WAAW,qDAId;IAED,IAAI,QAAQ,kBAEX;IAIK,cAAc,CAAC,WAAW,EAAE,WAAW;IAKvC,UAAU,CAAC,OAAO,EAAE,MAAM;IAK1B,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IAK7B,WAAW,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI;IAazC,IAAI,SAAS,IAAI;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,CAQlE;WAEY,IAAI,CAAC,IAAI,EAAE;QACvB,cAAc,EAAE,MAAM,CAAC;QACvB,UAAU,EAAE,MAAM,CAAC,UAAU,CAAC;KAC9B;CA6BD;AAQD,wBAAgB,uBAAuB,CAAC,KAAK,EAAE,MAAM,GAAG;IACvD,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,MAAM,CAAC;CACf,CAoCA"}

package/dist/cli/config.js

@@ -13,46 +13,36 @@ class TokenNotSetError extends Error {
     this.name = "TokenNotSetError";
   }
 }
-function parseEnvironmentName(name) {
-  if (["local", "staging", "dev", "prod"].includes(name)) {
-    return name;
-  }
-  throw new Error(`Invalid environment name: ${name}`);
-}
 class Config {
   #configFile;
   #configFilePath;
-  constructor(configFilePath, configFile) {
-    this.#configFilePath = configFilePath;
-    this.#configFile = configFile;
-  }
-  async setEnvironment(environment) {
-    this.#configFile.environment = environment;
-    await this.#writeConfigFile();
-  }
-  async setBaseUrl(baseUrl) {
-    this.#configFile.baseUrl = baseUrl;
-    await this.#writeConfigFile();
+  #env;
+  constructor(opts) {
+    this.#configFilePath = opts.configFilePath;
+    this.#configFile = opts.configFile;
+    this.#env = opts.processEnv;
   }
+  // Getters read from the environment variables, and then the config file.
   get baseUrl() {
-    return this.#configFile.baseUrl;
+    return this.#env.WORKERS_BASE_URL ?? this.#configFile.baseUrl;
   }
   get token() {
-    return this.#configFile.token;
-  }
-  get tokenInfo() {
-    const token = this.#configFile.token;
-    if (!token) {
-      throw new TokenNotSetError();
-    }
-    const { spaceId, cellId } = extractPayloadFromToken(token);
-    return { token, spaceId, cellId };
+    return this.#env.WORKERS_TOKEN ?? this.#configFile.token;
   }
   get environment() {
-    return this.#configFile.environment;
+    return this.#env.WORKERS_ENVIRONMENT ? parseEnvironment(this.#env.WORKERS_ENVIRONMENT) : this.#configFile.environment;
   }
   get workerId() {
-    return this.#configFile.workerId;
+    return this.#env.WORKERS_WORKER_ID ?? this.#configFile.workerId;
+  }
+  // Setters update the config file, and then write it to disk.
+  async setEnvironment(environment) {
+    this.#configFile.environment = environment;
+    await this.#writeConfigFile();
+  }
+  async setBaseUrl(baseUrl) {
+    this.#configFile.baseUrl = baseUrl;
+    await this.#writeConfigFile();
   }
   async setToken(token) {
     this.#configFile.token = token;
@@ -69,10 +59,22 @@ class Config {
       "utf-8"
     );
   }
-  static async load(configFilePath) {
-    const absConfigFilePath = path.resolve(process.cwd(), configFilePath);
+  get tokenInfo() {
+    const token = this.token;
+    if (!token) {
+      throw new TokenNotSetError();
+    }
+    const { spaceId, cellId } = extractPayloadFromToken(token);
+    return { token, spaceId, cellId };
+  }
+  static async load(opts) {
+    const absConfigFilePath = path.resolve(process.cwd(), opts.configFilePath);
     const configFile = await Config.#readConfigFile(absConfigFilePath);
-    return new Config(absConfigFilePath, configFile);
+    return new Config({
+      configFilePath: absConfigFilePath,
+      configFile,
+      processEnv: opts.processEnv
+    });
   }
   static async #readConfigFile(configFilePath) {
     let configFile;
@@ -128,6 +130,5 @@ export {
   Environments,
   TokenNotSetError,
   extractPayloadFromToken,
-  parseEnvironment,
-  parseEnvironmentName
+  parseEnvironment
 };

package/dist/cli/handler.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"handler.d.ts","sourceRoot":"","sources":["../../src/cli/handler.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAC9C,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAC5C,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AACrC,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC;AACjD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAE9C,MAAM,WAAW,cAAe,SAAQ,YAAY;IACnD,MAAM,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,aAAc,SAAQ,cAAc;IACpD,SAAS,EAAE,SAAS,CAAC;CACrB;AAED,wBAAgB,YAAY,CAAC,KAAK,CAAC,KAAK,EAAE,KAAK,CAAC,IAAI,SAAS,QAAQ,GAAG,EAAE,EACzE,OAAO,EAAE,CACR,IAAI,EAAE,cAAc,EACpB,KAAK,EAAE,KAAK,EACZ,GAAG,IAAI,EAAE,IAAI,KACT,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,IAGxB,MAAM,YAAY,EAClB,OAAO,WAAW,GAAG,KAAK,EAC1B,GAAG,MAAM,IAAI,mBAQd;AAED,wBAAgB,kBAAkB,CACjC,KAAK,CAAC,KAAK,EACX,KAAK,CAAC,IAAI,SAAS,QAAQ,GAAG,EAAE,EAEhC,OAAO,EAAE,CACR,IAAI,EAAE,aAAa,EACnB,KAAK,EAAE,KAAK,EACZ,GAAG,IAAI,EAAE,IAAI,KACT,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,UApBlB,YAAY,8DAuCnB"}
+{"version":3,"file":"handler.d.ts","sourceRoot":"","sources":["../../src/cli/handler.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAC9C,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAC5C,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AACrC,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC;AACjD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAE9C,MAAM,WAAW,cAAe,SAAQ,YAAY;IACnD,MAAM,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,aAAc,SAAQ,cAAc;IACpD,SAAS,EAAE,SAAS,CAAC;CACrB;AAED,wBAAgB,YAAY,CAAC,KAAK,CAAC,KAAK,EAAE,KAAK,CAAC,IAAI,SAAS,QAAQ,GAAG,EAAE,EACzE,OAAO,EAAE,CACR,IAAI,EAAE,cAAc,EACpB,KAAK,EAAE,KAAK,EACZ,GAAG,IAAI,EAAE,IAAI,KACT,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,IAGxB,MAAM,YAAY,EAClB,OAAO,WAAW,GAAG,KAAK,EAC1B,GAAG,MAAM,IAAI,mBAWd;AAED,wBAAgB,kBAAkB,CACjC,KAAK,CAAC,KAAK,EACX,KAAK,CAAC,IAAI,SAAS,QAAQ,GAAG,EAAE,EAEhC,OAAO,EAAE,CACR,IAAI,EAAE,aAAa,EACnB,KAAK,EAAE,KAAK,EACZ,GAAG,IAAI,EAAE,IAAI,KACT,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,UAvBlB,YAAY,8DA2CnB"}

package/dist/cli/handler.js

@@ -2,18 +2,21 @@ import { ApiClient } from "./api/client.js";
 import { Config } from "./config.js";
 function buildHandler(handler) {
   return async function(flags, ...args) {
-    const config = await Config.load(flags.config ?? "./workers.json");
+    const config = await Config.load({
+      configFilePath: flags.config ?? "./workers.json",
+      processEnv: process.env
+    });
     this.writer.debugEnabled = flags.debug;
     await handler.call({ ...this, config }, flags, ...args);
   };
 }
 function buildAuthedHandler(handler) {
   return buildHandler(function(flags, ...args) {
+    const { token, cellId } = this.config.tokenInfo;
     const environment = this.config.environment;
     if (!environment) {
       throw new Error("Unexpected error: Environment not set");
     }
-    const { token, cellId } = this.config.tokenInfo;
     const client = new ApiClient({
       token,
       environment,

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@project-ajax/sdk",
-	"version": "0.0.28",
+	"version": "0.0.30",
 	"description": "An SDK for building workers for the Project Ajax platform",
 	"license": "UNLICENSED",
 	"type": "module",

package/src/cli/config.ts

@@ -28,57 +28,63 @@ export class TokenNotSetError extends Error {
 	}
 }
 
-export function parseEnvironmentName(name: string): Environment {
-	if (["local", "staging", "dev", "prod"].includes(name)) {
-		return name as Environment;
-	}
-
-	throw new Error(`Invalid environment name: ${name}`);
-}
-
+/**
+ * Manages configuration for the CLI.
+ *
+ * Environment variables take precedence over the config file.
+ *
+ * | Environment Variable | Config File | Description |
+ * |----------------------|-------------|-------------|
+ * | WORKERS_TOKEN        | token       | The token to use for authentication |
+ * | WORKERS_ENVIRONMENT  | environment | The environment to use |
+ * | WORKERS_WORKER_ID    | workerId    | The worker ID to use |
+ * | WORKERS_BASE_URL     | baseUrl     | The base URL to use |
+ */
 export class Config {
 	readonly #configFile: ConfigFile;
 	readonly #configFilePath: string;
+	readonly #env: NodeJS.ProcessEnv;
 
-	constructor(configFilePath: string, configFile: ConfigFile) {
-		this.#configFilePath = configFilePath;
-		this.#configFile = configFile;
-	}
-
-	async setEnvironment(environment: Environment) {
-		this.#configFile.environment = environment;
-		await this.#writeConfigFile();
+	constructor(opts: {
+		configFilePath: string;
+		configFile: ConfigFile;
+		processEnv: NodeJS.ProcessEnv;
+	}) {
+		this.#configFilePath = opts.configFilePath;
+		this.#configFile = opts.configFile;
+		this.#env = opts.processEnv;
 	}
 
-	async setBaseUrl(baseUrl: string) {
-		this.#configFile.baseUrl = baseUrl;
-		await this.#writeConfigFile();
-	}
+	// Getters read from the environment variables, and then the config file.
 
 	get baseUrl() {
-		return this.#configFile.baseUrl;
+		return this.#env.WORKERS_BASE_URL ?? this.#configFile.baseUrl;
 	}
 
 	get token() {
-		return this.#configFile.token;
+		return this.#env.WORKERS_TOKEN ?? this.#configFile.token;
 	}
 
-	get tokenInfo(): { token: string; spaceId: string; cellId: string } {
-		const token = this.#configFile.token;
-		if (!token) {
-			throw new TokenNotSetError();
-		}
+	get environment() {
+		return this.#env.WORKERS_ENVIRONMENT
+			? parseEnvironment(this.#env.WORKERS_ENVIRONMENT)
+			: this.#configFile.environment;
+	}
 
-		const { spaceId, cellId } = extractPayloadFromToken(token);
-		return { token, spaceId, cellId };
+	get workerId() {
+		return this.#env.WORKERS_WORKER_ID ?? this.#configFile.workerId;
 	}
 
-	get environment() {
-		return this.#configFile.environment;
+	// Setters update the config file, and then write it to disk.
+
+	async setEnvironment(environment: Environment) {
+		this.#configFile.environment = environment;
+		await this.#writeConfigFile();
 	}
 
-	get workerId() {
-		return this.#configFile.workerId;
+	async setBaseUrl(baseUrl: string) {
+		this.#configFile.baseUrl = baseUrl;
+		await this.#writeConfigFile();
 	}
 
 	async setToken(token: string | null) {
@@ -99,10 +105,27 @@ export class Config {
 		);
 	}
 
-	static async load(configFilePath: string) {
-		const absConfigFilePath = path.resolve(process.cwd(), configFilePath);
+	get tokenInfo(): { token: string; spaceId: string; cellId: string } {
+		const token = this.token;
+		if (!token) {
+			throw new TokenNotSetError();
+		}
+
+		const { spaceId, cellId } = extractPayloadFromToken(token);
+		return { token, spaceId, cellId };
+	}
+
+	static async load(opts: {
+		configFilePath: string;
+		processEnv: NodeJS.ProcessEnv;
+	}) {
+		const absConfigFilePath = path.resolve(process.cwd(), opts.configFilePath);
 		const configFile = await Config.#readConfigFile(absConfigFilePath);
-		return new Config(absConfigFilePath, configFile);
+		return new Config({
+			configFilePath: absConfigFilePath,
+			configFile,
+			processEnv: opts.processEnv,
+		});
 	}
 
 	static async #readConfigFile(configFilePath: string) {

package/src/cli/handler.ts

@@ -24,7 +24,10 @@ export function buildHandler<const FLAGS, const ARGS extends BaseArgs = []>(
 		flags: GlobalFlags & FLAGS,
 		...args: ARGS
 	) {
-		const config = await Config.load(flags.config ?? "./workers.json");
+		const config = await Config.load({
+			configFilePath: flags.config ?? "./workers.json",
+			processEnv: process.env,
+		});
 
 		this.writer.debugEnabled = flags.debug;
 
@@ -43,13 +46,14 @@ export function buildAuthedHandler<
 	) => Promise<void> | void,
 ) {
 	return buildHandler(function (flags: FLAGS, ...args: ARGS) {
+		// Check token first - this will throw TokenNotSetError with helpful message if not authenticated
+		const { token, cellId } = this.config.tokenInfo;
+
 		const environment = this.config.environment;
 		if (!environment) {
-			// Unexpected to get here when token is set
 			throw new Error("Unexpected error: Environment not set");
 		}
 
-		const { token, cellId } = this.config.tokenInfo;
 		const client = new ApiClient({
 			token,
 			environment,