@vercel/cli-config 0.1.2 → 0.2.0

package/dist/cli-config.d.ts

@@ -1,5 +1,5 @@
 import { z } from 'zod';
-import type { AuthConfig, GlobalConfig } from './types';
+import type { AuthConfig, AuthFileConfig, GlobalConfig } from './types';
 type WriteConfigFileOptions = {
     indent?: number | string;
     mode?: number;
@@ -9,6 +9,7 @@ export declare function getDefaultAuthConfig(): AuthConfig;
 export declare const defaultAuthConfig: AuthConfig;
 export declare function parseGlobalConfig(value: unknown): GlobalConfig;
 export declare function parseAuthConfig(value: unknown): AuthConfig;
+export declare function parseAuthFileConfig(value: unknown): AuthFileConfig;
 export declare function readConfigFile<S extends z.ZodType>(configPath: string, schema: S): z.output<S>;
 export declare function writeConfigFile<S extends z.ZodType>(configPath: string, schema: S, config: z.output<S>, options?: WriteConfigFileOptions): void;
 export declare function getGlobalPathConfig(): string;
@@ -17,5 +18,11 @@ export declare function getAuthConfigFilePath(configDir: string): string;
 export declare function readGlobalConfigFile(configPath: string): GlobalConfig;
 export declare function writeGlobalConfigFile(configPath: string, config: GlobalConfig): void;
 export declare function readAuthConfigFile(configPath: string): AuthConfig;
+export declare function readAuthFileConfig(configPath: string): AuthFileConfig;
+export declare function readAuthConfig(configDir: string): AuthConfig;
+export declare function tryReadAuthConfig(configDir: string): AuthConfig | null;
 export declare function writeAuthConfigFile(configPath: string, authConfig: AuthConfig): void;
+export declare function writeAuthConfig(configDir: string, authConfig: AuthConfig): void;
+export declare function deleteAuthConfigFile(configPath: string): void;
+export declare function deleteAuthConfig(configDir: string): void;
 export {};

package/dist/cli-config.js

@@ -7,6 +7,7 @@ exports.defaultAuthConfig = exports.defaultGlobalConfig = void 0;
 exports.getDefaultAuthConfig = getDefaultAuthConfig;
 exports.parseGlobalConfig = parseGlobalConfig;
 exports.parseAuthConfig = parseAuthConfig;
+exports.parseAuthFileConfig = parseAuthFileConfig;
 exports.readConfigFile = readConfigFile;
 exports.writeConfigFile = writeConfigFile;
 exports.getGlobalPathConfig = getGlobalPathConfig;
@@ -15,7 +16,13 @@ exports.getAuthConfigFilePath = getAuthConfigFilePath;
 exports.readGlobalConfigFile = readGlobalConfigFile;
 exports.writeGlobalConfigFile = writeGlobalConfigFile;
 exports.readAuthConfigFile = readAuthConfigFile;
+exports.readAuthFileConfig = readAuthFileConfig;
+exports.readAuthConfig = readAuthConfig;
+exports.tryReadAuthConfig = tryReadAuthConfig;
 exports.writeAuthConfigFile = writeAuthConfigFile;
+exports.writeAuthConfig = writeAuthConfig;
+exports.deleteAuthConfigFile = deleteAuthConfigFile;
+exports.deleteAuthConfig = deleteAuthConfig;
 const node_fs_1 = __importDefault(require("node:fs"));
 const node_path_1 = __importDefault(require("node:path"));
 const node_os_1 = require("node:os");
@@ -34,12 +41,30 @@ function getDefaultAuthConfig() {
     };
 }
 exports.defaultAuthConfig = getDefaultAuthConfig();
+function normalizeConfigError(error) {
+    if (error instanceof zod_1.z.ZodError) {
+        const credStorageIssue = error.issues.find(issue => issue.path[0] === 'credStorage');
+        if (credStorageIssue) {
+            throw new Error(credStorageIssue.message);
+        }
+    }
+    throw error;
+}
 function parseGlobalConfig(value) {
-    return schema_1.globalConfigSchema.parse(value);
+    try {
+        return schema_1.globalConfigSchema.parse(value);
+    }
+    catch (error) {
+        normalizeConfigError(error);
+    }
 }
 function parseAuthConfig(value) {
     return schema_1.authConfigSchema.parse(value);
 }
+function parseAuthFileConfig(value) {
+    const { tokenSource, ...authConfig } = parseAuthConfig(value);
+    return authConfig;
+}
 function readJsonFileSync(filePath) {
     const content = node_fs_1.default.readFileSync(filePath, 'utf8').replace(/^\uFEFF/, '');
     return JSON.parse(content);
@@ -102,7 +127,12 @@ function getAuthConfigFilePath(configDir) {
     return node_path_1.default.join(configDir, 'auth.json');
 }
 function readGlobalConfigFile(configPath) {
-    return readConfigFile(configPath, schema_1.globalConfigSchema);
+    try {
+        return readConfigFile(configPath, schema_1.globalConfigSchema);
+    }
+    catch (error) {
+        normalizeConfigError(error);
+    }
 }
 function writeGlobalConfigFile(configPath, config) {
     writeConfigFile(configPath, schema_1.globalConfigSchema, config);
@@ -110,6 +140,20 @@ function writeGlobalConfigFile(configPath, config) {
 function readAuthConfigFile(configPath) {
     return readConfigFile(configPath, schema_1.authConfigSchema);
 }
+function readAuthFileConfig(configPath) {
+    return parseAuthFileConfig(readJsonFileSync(configPath));
+}
+function readAuthConfig(configDir) {
+    return readAuthConfigFile(getAuthConfigFilePath(configDir));
+}
+function tryReadAuthConfig(configDir) {
+    try {
+        return readAuthConfig(configDir);
+    }
+    catch {
+        return null;
+    }
+}
 function writeAuthConfigFile(configPath, authConfig) {
     if (authConfig.skipWrite) {
         return;
@@ -118,3 +162,12 @@ function writeAuthConfigFile(configPath, authConfig) {
         mode: 0o600,
     });
 }
+function writeAuthConfig(configDir, authConfig) {
+    writeAuthConfigFile(getAuthConfigFilePath(configDir), authConfig);
+}
+function deleteAuthConfigFile(configPath) {
+    node_fs_1.default.rmSync(configPath, { force: true });
+}
+function deleteAuthConfig(configDir) {
+    deleteAuthConfigFile(getAuthConfigFilePath(configDir));
+}

package/dist/cred-storage.d.ts

@@ -0,0 +1,3 @@
+import type { AuthConfig, CredStorage } from './types';
+export declare function authConfigHasUsableTokenData(value: unknown): value is Pick<AuthConfig, 'token' | 'refreshToken'>;
+export declare function getLikelyEffectiveCredStorage(configDir: string): CredStorage;

package/dist/cred-storage.js

@@ -0,0 +1,73 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.authConfigHasUsableTokenData = authConfigHasUsableTokenData;
+exports.getLikelyEffectiveCredStorage = getLikelyEffectiveCredStorage;
+const types_1 = require("./types");
+const cli_config_1 = require("./cli-config");
+const TOKEN_STORAGE_ENV = 'VERCEL_TOKEN_STORAGE';
+function isErrnoException(error) {
+    return typeof error === 'object' && error !== null && 'code' in error;
+}
+function isCredStorage(value) {
+    return types_1.CRED_STORAGE_CONFIG_VALUES.includes(value);
+}
+function formatCredStorageError(value, source) {
+    return `Invalid value for \`${source}\`: ${JSON.stringify(value)}. Expected one of: ${types_1.CRED_STORAGE_CONFIG_VALUES.map(storage => JSON.stringify(storage)).join(', ')}.`;
+}
+function parseCredStorage(value, source = 'credStorage') {
+    if (typeof value === 'undefined') {
+        return undefined;
+    }
+    if (isCredStorage(value)) {
+        return value;
+    }
+    throw new Error(formatCredStorageError(value, source));
+}
+function authConfigHasUsableTokenData(value) {
+    if (!value || typeof value !== 'object') {
+        return false;
+    }
+    const authConfig = value;
+    return ((typeof authConfig.token === 'string' && authConfig.token.length > 0) ||
+        (typeof authConfig.refreshToken === 'string' &&
+            authConfig.refreshToken.length > 0));
+}
+function getLikelyAutoCredStorage(configDir) {
+    try {
+        return authConfigHasUsableTokenData((0, cli_config_1.readAuthConfigFile)((0, cli_config_1.getAuthConfigFilePath)(configDir)))
+            ? 'file'
+            : 'keyring';
+    }
+    catch {
+        return 'keyring';
+    }
+}
+function getLikelyConfiguredCredStorage(configDir, credStorage) {
+    if (credStorage === 'keyring') {
+        return 'keyring';
+    }
+    if (credStorage !== 'auto') {
+        return types_1.DEFAULT_CRED_STORAGE;
+    }
+    return getLikelyAutoCredStorage(configDir);
+}
+function getLikelyEffectiveCredStorage(configDir) {
+    let config = {};
+    const credStorageOverride = process.env[TOKEN_STORAGE_ENV];
+    if (typeof credStorageOverride !== 'undefined') {
+        return getLikelyConfiguredCredStorage(configDir, parseCredStorage(credStorageOverride, TOKEN_STORAGE_ENV));
+    }
+    try {
+        const parsed = (0, cli_config_1.readGlobalConfigFile)((0, cli_config_1.getConfigFilePath)(configDir));
+        config = {
+            ...parsed,
+            credStorage: parseCredStorage(parsed.credStorage),
+        };
+    }
+    catch (error) {
+        if (!(isErrnoException(error) && error.code === 'ENOENT')) {
+            throw error;
+        }
+    }
+    return getLikelyConfiguredCredStorage(configDir, config.credStorage);
+}

package/dist/index.d.ts

@@ -1,3 +1,4 @@
 export * from './types';
 export * from './schema';
 export * from './cli-config';
+export * from './cred-storage';

package/dist/index.js

@@ -17,3 +17,4 @@ Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./types"), exports);
 __exportStar(require("./schema"), exports);
 __exportStar(require("./cli-config"), exports);
+__exportStar(require("./cred-storage"), exports);

package/dist/schema.d.ts

@@ -5,10 +5,11 @@
  * Schemas are generated by ts-to-zod and re-exported here with runtime
  * passthrough behavior for unrecognized config keys.
  */
-import type { z } from 'zod';
-import type { AuthConfig, GlobalConfig, GuidanceConfig, TelemetryConfig, UpdatesConfig } from './types';
+import { z } from 'zod';
+import type { AuthConfig, CredStorage, GlobalConfig, GuidanceConfig, TelemetryConfig, UpdatesConfig } from './types';
 export declare const telemetryConfigSchema: z.ZodType<TelemetryConfig>;
 export declare const guidanceConfigSchema: z.ZodType<GuidanceConfig>;
 export declare const updatesConfigSchema: z.ZodType<UpdatesConfig>;
+export declare const credStorageSchema: z.ZodType<CredStorage | undefined>;
 export declare const globalConfigSchema: z.ZodType<GlobalConfig>;
 export declare const authConfigSchema: z.ZodType<AuthConfig>;

package/dist/schema.js

@@ -7,13 +7,26 @@
  * passthrough behavior for unrecognized config keys.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.authConfigSchema = exports.globalConfigSchema = exports.updatesConfigSchema = exports.guidanceConfigSchema = exports.telemetryConfigSchema = void 0;
+exports.authConfigSchema = exports.globalConfigSchema = exports.credStorageSchema = exports.updatesConfigSchema = exports.guidanceConfigSchema = exports.telemetryConfigSchema = void 0;
+const zod_1 = require("zod");
 const schema_zod_1 = require("./schema.zod");
+const types_1 = require("./types");
+function formatCredStorageError(value) {
+    return `Invalid value for \`credStorage\`: ${JSON.stringify(value)}. Expected one of: ${types_1.CRED_STORAGE_CONFIG_VALUES.map(storage => JSON.stringify(storage)).join(', ')}.`;
+}
 exports.telemetryConfigSchema = schema_zod_1.telemetryConfigSchema.passthrough();
 exports.guidanceConfigSchema = schema_zod_1.guidanceConfigSchema.passthrough();
 exports.updatesConfigSchema = schema_zod_1.updatesConfigSchema.passthrough();
+exports.credStorageSchema = zod_1.z
+    .enum(types_1.CRED_STORAGE_CONFIG_VALUES, {
+    error: issue => {
+        return formatCredStorageError(issue.input);
+    },
+})
+    .optional();
 exports.globalConfigSchema = schema_zod_1.globalConfigSchema
     .extend({
+    credStorage: exports.credStorageSchema,
     telemetry: exports.telemetryConfigSchema.optional(),
     guidance: exports.guidanceConfigSchema.optional(),
     updates: exports.updatesConfigSchema.optional(),

package/dist/schema.zod.d.ts

@@ -8,6 +8,7 @@ export declare const guidanceConfigSchema: z.ZodObject<{
 export declare const updatesConfigSchema: z.ZodObject<{
     auto: z.ZodOptional<z.ZodBoolean>;
 }, z.core.$strip>;
+export declare const credStorageSchema: z.ZodUnion<readonly [z.ZodLiteral<"auto">, z.ZodLiteral<"file">, z.ZodLiteral<"keyring">]>;
 export declare const authConfigSchema: z.ZodObject<{
     '// Note': z.ZodOptional<z.ZodString>;
     '// Docs': z.ZodOptional<z.ZodString>;
@@ -18,9 +19,19 @@ export declare const authConfigSchema: z.ZodObject<{
     expiresAt: z.ZodOptional<z.ZodNumber>;
     tokenSource: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"flag">, z.ZodLiteral<"env">]>>;
 }, z.core.$strip>;
+export declare const authFileConfigSchema: z.ZodObject<{
+    '// Note': z.ZodOptional<z.ZodString>;
+    '// Docs': z.ZodOptional<z.ZodString>;
+    skipWrite: z.ZodOptional<z.ZodBoolean>;
+    token: z.ZodOptional<z.ZodString>;
+    userId: z.ZodOptional<z.ZodString>;
+    refreshToken: z.ZodOptional<z.ZodString>;
+    expiresAt: z.ZodOptional<z.ZodNumber>;
+}, z.core.$strip>;
 export declare const globalConfigSchema: z.ZodObject<{
     '// Note': z.ZodOptional<z.ZodString>;
     '// Docs': z.ZodOptional<z.ZodString>;
+    credStorage: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"auto">, z.ZodLiteral<"file">, z.ZodLiteral<"keyring">]>>;
     currentTeam: z.ZodOptional<z.ZodString>;
     api: z.ZodOptional<z.ZodString>;
     telemetry: z.ZodOptional<z.ZodObject<{

package/dist/schema.zod.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.globalConfigSchema = exports.authConfigSchema = exports.updatesConfigSchema = exports.guidanceConfigSchema = exports.telemetryConfigSchema = void 0;
+exports.globalConfigSchema = exports.authFileConfigSchema = exports.authConfigSchema = exports.credStorageSchema = exports.updatesConfigSchema = exports.guidanceConfigSchema = exports.telemetryConfigSchema = void 0;
 // Generated by ts-to-zod
 const zod_1 = require("zod");
 exports.telemetryConfigSchema = zod_1.z.object({
@@ -12,6 +12,11 @@ exports.guidanceConfigSchema = zod_1.z.object({
 exports.updatesConfigSchema = zod_1.z.object({
     auto: zod_1.z.boolean().optional(),
 });
+exports.credStorageSchema = zod_1.z.union([
+    zod_1.z.literal('auto'),
+    zod_1.z.literal('file'),
+    zod_1.z.literal('keyring'),
+]);
 exports.authConfigSchema = zod_1.z.object({
     '// Note': zod_1.z.string().optional(),
     '// Docs': zod_1.z.string().optional(),
@@ -22,9 +27,13 @@ exports.authConfigSchema = zod_1.z.object({
     expiresAt: zod_1.z.number().optional(),
     tokenSource: zod_1.z.union([zod_1.z.literal('flag'), zod_1.z.literal('env')]).optional(),
 });
+exports.authFileConfigSchema = exports.authConfigSchema.omit({
+    tokenSource: true,
+});
 exports.globalConfigSchema = zod_1.z.object({
     '// Note': zod_1.z.string().optional(),
     '// Docs': zod_1.z.string().optional(),
+    credStorage: exports.credStorageSchema.optional(),
     currentTeam: zod_1.z.string().optional(),
     api: zod_1.z.string().optional(),
     telemetry: exports.telemetryConfigSchema.optional(),

package/dist/types.d.ts

@@ -13,6 +13,11 @@ export interface GuidanceConfig {
 export interface UpdatesConfig {
     auto?: boolean;
 }
+export type CredStorage = 'auto' | 'file' | 'keyring';
+export type CredentialsStorageLocation = Exclude<CredStorage, 'auto'>;
+export declare const CRED_STORAGE_CONFIG_VALUES: readonly ["auto", "file", "keyring"];
+export declare const CRED_STORAGE_VALUES: ("file" | "keyring")[];
+export declare const DEFAULT_CRED_STORAGE: CredentialsStorageLocation;
 export interface AuthConfig {
     '// Note'?: string;
     '// Docs'?: string;
@@ -23,9 +28,11 @@ export interface AuthConfig {
     expiresAt?: number;
     tokenSource?: 'flag' | 'env';
 }
+export type AuthFileConfig = Omit<AuthConfig, 'tokenSource'>;
 export interface GlobalConfig {
     '// Note'?: string;
     '// Docs'?: string;
+    credStorage?: CredStorage;
     currentTeam?: string;
     api?: string;
     telemetry?: TelemetryConfig;

package/dist/types.js

@@ -6,3 +6,11 @@
  * Zod schemas are generated from these using ts-to-zod.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.DEFAULT_CRED_STORAGE = exports.CRED_STORAGE_VALUES = exports.CRED_STORAGE_CONFIG_VALUES = void 0;
+exports.CRED_STORAGE_CONFIG_VALUES = [
+    'auto',
+    'file',
+    'keyring',
+];
+exports.CRED_STORAGE_VALUES = exports.CRED_STORAGE_CONFIG_VALUES.filter((storage) => storage !== 'auto');
+exports.DEFAULT_CRED_STORAGE = 'file';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vercel/cli-config",
-  "version": "0.1.2",
+  "version": "0.2.0",
   "description": "Shared core utilities for Vercel global configuration",
   "license": "Apache-2.0",
   "homepage": "https://vercel.com/docs/projects/project-configuration/global-configuration",