@project-ajax/cli 0.0.14 → 0.0.16

package/dist/config.d.ts

@@ -1,63 +1,165 @@
+import z from "zod";
 import type { GlobalFlags } from "./flags.js";
-export declare const Environments: readonly ["local", "staging", "dev", "prod"];
-export type Environment = (typeof Environments)[number];
-export interface ConfigMap {
-    environment: Environment;
-    baseUrl: string;
-    token: string | null;
-    workerId: string | null;
-}
-export declare function parseEnvironment(name: string): Environment;
-export declare class TokenNotSetError extends Error {
-    constructor(message?: string);
+import { type TokenInfo } from "./token.js";
+export declare const Environment: z.ZodLiteral<"local" | "dev" | "stg" | "prod">;
+export type Environment = z.infer<typeof Environment>;
+declare const SpaceCache: z.ZodObject<{
+    version: z.ZodLiteral<"1">;
+    spaces: z.ZodRecord<z.ZodString, z.ZodObject<{
+        id: z.ZodString;
+        name: z.ZodString;
+        cellId: z.ZodString;
+    }, z.z.core.$strip>>;
+}, z.z.core.$strip>;
+export type SpaceCache = z.infer<typeof SpaceCache>;
+declare const LocalConfig: z.ZodObject<{
+    version: z.ZodLiteral<"1">;
+    environment: z.ZodLiteral<"local" | "dev" | "stg" | "prod">;
+    baseURL: z.ZodOptional<z.ZodString>;
+    spaceId: z.ZodNullable<z.ZodString>;
+    workerId: z.ZodNullable<z.ZodString>;
+}, z.z.core.$strip>;
+export type LocalConfig = z.infer<typeof LocalConfig>;
+export declare class NoSuitableConfigFileError extends Error {
+    constructor();
 }
 /**
- * Manages configuration for the CLI.
- *
- * Environment variables take precedence over the config file.
+ * Manages configuration for the command line interface.
  *
- * | 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 |
+ * Order of precedence: Command-line flags, environment variables, local config
+ * files, where appropriate.
  */
 export declare class Config {
     #private;
     constructor(opts: {
-        configMap: ConfigMap;
-        configFilePath: string;
+        spaceCachePath: string;
+        spaceCache: SpaceCache;
+        localConfigPath: string;
+        localConfig: LocalConfig;
+        environment: Environment;
+        baseURL: string;
+        spaceId: string | null;
+        workerId: string | null;
+        token: string | null;
     });
-    get baseUrl(): string;
-    get token(): string | null;
-    get environment(): "local" | "staging" | "dev" | "prod";
+    get environment(): Environment;
+    get baseURL(): string;
+    get spaceId(): string | null;
     get workerId(): string | null;
-    get tokenInfo(): {
+    /**
+     * Get the list of cached spaces.
+     *
+     * @returns An array of cached spaces with id, name, and cellId.
+     */
+    getCachedSpaces(): Array<{
+        id: string;
+        name: string;
+        cellId: string;
+    }>;
+    /**
+     * Get the token and token information from the keychain.
+     *
+     * @returns The token and token information, or null if no token is found.
+     */
+    getToken(): Promise<[token: string, tokenInfo: TokenInfo] | null>;
+    /**
+     * Get the token and token information from the keychain.
+     *
+     * Throws an error if no token is found.
+     *
+     * @returns The token and token information.
+     */
+    mustGetToken(): Promise<[token: string, tokenInfo: TokenInfo]>;
+    /**
+     * Log in by updating the local configuration and the space cache, and
+     * storing the token in the keychain.
+     *
+     * @param args The arguments to login.
+     * @param args.environment The environment to login to.
+     * @param args.token The token to login with.
+     * @param args.spaceId The space ID to login to.
+     * @param args.spaceName The space name to login to.
+     * @param args.cellId The cell ID to login to.
+     */
+    login(args: {
+        environment: Environment;
         token: string;
         spaceId: string;
+        spaceName: string;
         cellId: string;
-    };
+    }): Promise<void>;
     /**
-     * Update the config with a partial config map.
+     * Set the worker ID.
      *
-     * This will write only the updated keys in the config file on disk. Not all
-     * keys are written, since some current keys in the Config object may have
-     * come from e.g. environment variables, rather than the original config
-     * file.
+     * @param workerId The worker ID to set.
+     */
+    setWorker(workerId: string): void;
+    /**
+     * Switch to an existing cached space.
      *
-     * @param config The config update.
+     * This updates the local configuration to use the specified space.
+     * The token for this space should already exist in the keychain.
+     *
+     * @param spaceId The space ID to switch to.
+     * @throws Error if the space is not in the cache.
+     */
+    switchToSpace(spaceId: string): void;
+    /**
+     * Resolve the space cache path.
+     *
+     * @param opts Options for resolving the space cache path.
+     * @param opts.filePath The path to the space cache file.
+     * @param opts.env The environment variables.
+     * @returns The path to the space cache file.
+     */
+    static resolveSpaceCachePath(opts: {
+        filePath?: string;
+        env: NodeJS.ProcessEnv;
+    }): string;
+    /**
+     * Resolve the local config path.
+     *
+     * @param opts Options for resolving the local config path.
+     * @param opts.filePath The path to the local config file.
+     * @returns
+     */
+    static resolveLocalConfigPath(opts?: {
+        filePath?: string;
+    }): string;
+    /**
+     * Load config from space cache and local config files, then resolve them to
+     * a final config for this execution of the command line interface.
+     *
+     * If the local config is v0, it will be upgraded to v1.
+     *
+     * Overrides:
+     *
+     * - Environment: WORKERS_ENVIRONMENT or --env flag
+     * - Token: WORKERS_TOKEN or --token flag
+     * - Base URL: WORKERS_BASE_URL or --base-url flag
+     *
+     * @param opts The options to load the config from.
+     * @param opts.spaceCachePath The path to the space cache file.
+     * @param opts.localPath The path to the local config file.
+     * @param opts.env The process environment.
+     * @param opts.processEnv The process environment.
+     * @param opts.flags The global flags.
+     * @returns The resolved config.
      */
-    update(config: Partial<ConfigMap>): Promise<void>;
     static load(opts: {
-        configFilePath: string;
-        processEnv: NodeJS.ProcessEnv;
+        spaceCachePath: string;
+        localPath: string;
+        env: NodeJS.ProcessEnv;
         flags: GlobalFlags;
-    }): Promise<Config>;
+    }): Config;
+    /**
+     * The empty local config.
+     */
+    static get emptyLocalConfig(): LocalConfig;
+    /**
+     * The empty space cache.
+     */
+    static get emptySpaceCache(): SpaceCache;
 }
-export declare function extractPayloadFromToken(token: string): {
-    spaceId: string;
-    userId: string;
-    cellId: string;
-};
+export {};
 //# sourceMappingURL=config.d.ts.map

package/dist/config.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAE9C,eAAO,MAAM,YAAY,8CAA+C,CAAC;AACzE,MAAM,MAAM,WAAW,GAAG,CAAC,OAAO,YAAY,CAAC,CAAC,MAAM,CAAC,CAAC;AAExD,MAAM,WAAW,SAAS;IACzB,WAAW,EAAE,WAAW,CAAC;IACzB,OAAO,EAAE,MAAM,CAAC;IAChB,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;;gBAIN,IAAI,EAAE;QACjB,SAAS,EAAE,SAAS,CAAC;QACrB,cAAc,EAAE,MAAM,CAAC;KACvB;IAOD,IAAI,OAAO,WAEV;IAED,IAAI,KAAK,kBAER;IAED,IAAI,WAAW,yCAEd;IAED,IAAI,QAAQ,kBAEX;IAED,IAAI,SAAS,IAAI;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,CAQlE;IAED;;;;;;;;;OASG;IACG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,SAAS,CAAC;WAc1B,IAAI,CAAC,IAAI,EAAE;QACvB,cAAc,EAAE,MAAM,CAAC;QACvB,UAAU,EAAE,MAAM,CAAC,UAAU,CAAC;QAC9B,KAAK,EAAE,WAAW,CAAC;KACnB;CA4FD;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/config.ts"],"names":[],"mappings":"AAGA,OAAO,CAAC,MAAM,KAAK,CAAC;AACpB,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAC9C,OAAO,EAIN,KAAK,SAAS,EAEd,MAAM,YAAY,CAAC;AAIpB,eAAO,MAAM,WAAW,gDAA6C,CAAC;AACtE,MAAM,MAAM,WAAW,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,WAAW,CAAC,CAAC;AAEtD,QAAA,MAAM,UAAU;;;;;;;mBAMd,CAAC;AAEH,MAAM,MAAM,UAAU,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,UAAU,CAAC,CAAC;AAEpD,QAAA,MAAM,WAAW;;;;;;mBAMf,CAAC;AAEH,MAAM,MAAM,WAAW,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,WAAW,CAAC,CAAC;AAatD,qBAAa,yBAA0B,SAAQ,KAAK;;CAKnD;AAED;;;;;GAKG;AACH,qBAAa,MAAM;;gBAYN,IAAI,EAAE;QACjB,cAAc,EAAE,MAAM,CAAC;QACvB,UAAU,EAAE,UAAU,CAAC;QACvB,eAAe,EAAE,MAAM,CAAC;QACxB,WAAW,EAAE,WAAW,CAAC;QACzB,WAAW,EAAE,WAAW,CAAC;QACzB,OAAO,EAAE,MAAM,CAAC;QAChB,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;QACvB,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;QACxB,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;KACrB;IAYD,IAAI,WAAW,IAAI,WAAW,CAE7B;IAED,IAAI,OAAO,IAAI,MAAM,CAEpB;IAED,IAAI,OAAO,IAAI,MAAM,GAAG,IAAI,CAE3B;IAED,IAAI,QAAQ,IAAI,MAAM,GAAG,IAAI,CAE5B;IAED;;;;OAIG;IACH,eAAe,IAAI,KAAK,CAAC;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,CAAC;IAItE;;;;OAIG;IACG,QAAQ,IAAI,OAAO,CAAC,CAAC,KAAK,EAAE,MAAM,EAAE,SAAS,EAAE,SAAS,CAAC,GAAG,IAAI,CAAC;IAmBvE;;;;;;OAMG;IACG,YAAY,IAAI,OAAO,CAAC,CAAC,KAAK,EAAE,MAAM,EAAE,SAAS,EAAE,SAAS,CAAC,CAAC;IASpE;;;;;;;;;;OAUG;IACG,KAAK,CAAC,IAAI,EAAE;QACjB,WAAW,EAAE,WAAW,CAAC;QACzB,KAAK,EAAE,MAAM,CAAC;QACd,OAAO,EAAE,MAAM,CAAC;QAChB,SAAS,EAAE,MAAM,CAAC;QAClB,MAAM,EAAE,MAAM,CAAC;KACf;IAqBD;;;;OAIG;IACH,SAAS,CAAC,QAAQ,EAAE,MAAM;IAM1B;;;;;;;;OAQG;IACH,aAAa,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI;IAyBpC;;;;;;;OAOG;IACH,MAAM,CAAC,qBAAqB,CAAC,IAAI,EAAE;QAClC,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,GAAG,EAAE,MAAM,CAAC,UAAU,CAAC;KACvB,GAAG,MAAM;IA6DV;;;;;;OAMG;IACH,MAAM,CAAC,sBAAsB,CAAC,IAAI,GAAE;QAAE,QAAQ,CAAC,EAAE,MAAM,CAAA;KAAO,GAAG,MAAM;IAoBvE;;;;;;;;;;;;;;;;;;;OAmBG;IACH,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE;QACjB,cAAc,EAAE,MAAM,CAAC;QACvB,SAAS,EAAE,MAAM,CAAC;QAClB,GAAG,EAAE,MAAM,CAAC,UAAU,CAAC;QACvB,KAAK,EAAE,WAAW,CAAC;KACnB,GAAG,MAAM;IA6CV;;OAEG;IACH,MAAM,KAAK,gBAAgB,IAAI,WAAW,CAEzC;IAED;;OAEG;IACH,MAAM,KAAK,eAAe,IAAI,UAAU,CAEvC;CACD"}