@e-n-v/env 0.0.5 → 0.0.8

package/dist/{BooleanMap-DmFnCA-O.d.ts → BooleanMap-BPQuO3Ae.d.ts}

@@ -1,7 +1,5 @@
-import { a as EnumEnvVarSchema, r as NumberEnvVarSchema, s as BooleanEnvVarSchema, t as StringEnvVarSchema } from "./StringEnvVarSchema-B8MT7htU.js";
-
+import { a as EnumEnvVarSchema, r as NumberEnvVarSchema, s as BooleanEnvVarSchema, t as StringEnvVarSchema } from "./StringEnvVarSchema-D9Jr1Aws.js";
 //#region ../core/src/schemas/EnvVarSchema.d.ts
-
 type EnvVarSchema = StringEnvVarSchema | NumberEnvVarSchema | BooleanEnvVarSchema | EnumEnvVarSchema<any>;
 /**
  * Type guard to check if a value is a EnvVarSchema instance

package/dist/{BooleanMap-B2eIP3tZ.d.cts → BooleanMap-CX_YrPCf.d.cts}

@@ -1,7 +1,5 @@
-import { a as EnumEnvVarSchema, r as NumberEnvVarSchema, s as BooleanEnvVarSchema, t as StringEnvVarSchema } from "./StringEnvVarSchema-BF6C0nyT.cjs";
-
+import { a as EnumEnvVarSchema, r as NumberEnvVarSchema, s as BooleanEnvVarSchema, t as StringEnvVarSchema } from "./StringEnvVarSchema-D9Jr1Aws.cjs";
 //#region ../core/src/schemas/EnvVarSchema.d.ts
-
 type EnvVarSchema = StringEnvVarSchema | NumberEnvVarSchema | BooleanEnvVarSchema | EnumEnvVarSchema<any>;
 /**
  * Type guard to check if a value is a EnvVarSchema instance

package/dist/EnvChannelOptions-BbKeuO-o.d.cts

@@ -0,0 +1,366 @@
+import { URL } from "url";
+//#region ../channels/src/channels/dotenv/DotEnvInstance.d.ts
+interface DotEnvConfigOptions {
+  path?: string;
+  encoding?: string;
+  debug?: boolean;
+  override?: boolean;
+  [key: string]: unknown;
+}
+interface DotEnvConfigOutput {
+  parsed?: Record<string, string>;
+  error?: Error;
+}
+interface DotEnvParseOptions {
+  debug?: boolean;
+  [key: string]: unknown;
+}
+interface DotEnvInstance {
+  parse(src: string | Buffer, options?: DotEnvParseOptions): Record<string, string | undefined>;
+  config?(options?: DotEnvConfigOptions): DotEnvConfigOutput;
+}
+//#endregion
+//#region ../channels/src/channels/dotenv/DotEnvChannelConfig.d.ts
+interface DotEnvChannelConfig {
+  dotenv: DotEnvInstance;
+  path?: string;
+  get?: DotEnvConfigOptions & {
+    [key: string]: unknown;
+  };
+  parse?: DotEnvParseOptions & {
+    [key: string]: unknown;
+  };
+}
+//#endregion
+//#region ../../node_modules/@dotenvx/dotenvx/src/lib/main.d.ts
+interface DotenvParseOutput {
+  [name: string]: string;
+}
+interface DotenvConfigOptions {
+  /**
+   * Specify explicit env sources. When set, `path` and `convention` are ignored.
+   *
+   * @default undefined
+   * @example require('@dotenvx/dotenvx').config({ envs: [{ type: 'envFile', value: '.env' }] })
+   * @example require('@dotenvx/dotenvx').config({ envs: [{ type: 'env', value: 'HELLO=World', privateKeyName: 'DOTENV_PRIVATE_KEY' }] })
+   */
+  envs?: DotenvConfigEnv[];
+  /**
+   * Specify a custom path if your file containing environment variables is located elsewhere.
+   * Can also be an array of strings, specifying multiple paths.
+   *
+   * @default require('path').resolve(process.cwd(), '.env')
+   * @example require('@dotenvx/dotenvx').config({ path: '/custom/path/to/.env' })
+   * @example require('@dotenvx/dotenvx').config({ path: ['/path/to/first.env', '/path/to/second.env'] })
+   */
+  path?: string | string[] | URL;
+  /**
+   * Specify the encoding of your file containing environment variables.
+   *
+   * @default 'utf8'
+   * @example require('@dotenvx/dotenvx').config({ encoding: 'latin1' })
+   */
+  encoding?: string;
+  /**
+   * Override any environment variables that have already been set on your machine with values from your .env file.
+   * @default false
+   * @example require('@dotenvx/dotenvx').config({ overload: true })
+   * @alias overload
+   */
+  overload?: boolean;
+  /**
+   * @default false
+   * @alias override
+   */
+  override?: boolean;
+  /**
+   * Throw immediately if an error is encountered - like a missing .env file.
+   * @default false
+   * @example require('@dotenvx/dotenvx').config({ strict: true })
+   */
+  strict?: boolean;
+  /**
+   * Suppress specific errors like MISSING_ENV_FILE. The error keys can be found
+   * in src/lib/helpers/errors.js
+   * @default []
+   * @example require('@dotenvx/dotenvx').config({ ignore: ['MISSING_ENV_FILE'] })
+   */
+  ignore?: string[];
+  /**
+   * Specify an object to write your secrets to. Defaults to process.env environment variables.
+   *
+   * @default process.env
+   * @example const processEnv = {}; require('@dotenvx/dotenvx').config({ processEnv: processEnv })
+   */
+  processEnv?: DotenvPopulateInput;
+  /**
+   * Mask resolved values, optionally setting the number of visible characters.
+   * @default false
+   * @example require('@dotenvx/dotenvx').config({ mask: true })
+   * @example require('@dotenvx/dotenvx').config({ mask: 0 })
+   */
+  mask?: boolean | number;
+  /**
+   * Customize the path to your .env.keys file. This is useful with monorepos.
+   * @default []
+   * @example require('@dotenvx/dotenvx').config({ envKeysFile: '../../.env.keys'} })
+   */
+  envKeysFile?: string;
+  /**
+   * Legacy option retained for compatibility.
+   *
+   * @default undefined
+   * @example require('@dotenvx/dotenvx').config({ DOTENV_KEY: 'dotenv://:key_1234…' })
+   */
+  DOTENV_KEY?: string;
+  /**
+   * Load a .env convention (available conventions: 'nextjs, flow')
+   */
+  convention?: string;
+  /**
+   * Turn on logging to help debug why certain keys or values are not being set as you expect.
+   *
+   * @default false
+   * @example require('@dotenvx/dotenvx').config({ debug: process.env.DEBUG })
+   */
+  debug?: boolean;
+  verbose?: boolean;
+  quiet?: boolean;
+  /**
+   * Disable spinner output from child Dotenvx Armor commands.
+   *
+   * @default false
+   * @example require('@dotenvx/dotenvx').config({ noSpinner: true })
+   */
+  noSpinner?: boolean;
+  /**
+   * Set Armor token.
+   *
+   * @example require('@dotenvx/dotenvx').config({ token: process.env.DOTENVX_ARMOR_TOKEN })
+   */
+  token?: string;
+  logLevel?: 'error' | 'warn' | 'success' | 'info' | 'help' | 'verbose' | 'debug';
+  /**
+   * Turn off Dotenvx Armor features.
+   *
+   * @default false
+   * @example require('@dotenvx/dotenvx').config({ noArmor: true })
+   */
+  noArmor?: boolean;
+  /**
+   * Turn off OS secret store features.
+   *
+   * @default false
+   * @example require('@dotenvx/dotenvx').config({ noNative: true })
+   */
+  noNative?: boolean;
+  /**
+   * Turn off 1Password secret reference resolution.
+   *
+   * @default false
+   * @example require('@dotenvx/dotenvx').config({ no1Password: true })
+   */
+  no1Password?: boolean;
+  /**
+   * Turn off Bitwarden secret reference resolution.
+   *
+   * @default false
+   * @example require('@dotenvx/dotenvx').config({ noBitwarden: true })
+   */
+  noBitwarden?: boolean;
+}
+type DotenvConfigEnv = DotenvConfigEnvFile | DotenvConfigEnvSrc;
+interface DotenvConfigEnvFile {
+  type: 'envFile';
+  value: string | URL;
+}
+interface DotenvConfigEnvSrc {
+  type: 'env';
+  value: string | Buffer;
+  privateKeyName?: string;
+}
+interface DotenvConfigOutput {
+  error?: Error;
+  parsed?: DotenvParseOutput;
+}
+interface DotenvPopulateInput {
+  [name: string]: string;
+}
+interface SetOptions {
+  /**
+   * Specify a custom path if your file containing environment variables is located elsewhere.
+   * Can also be an array of strings, specifying multiple paths.
+   *
+   * @default require('path').resolve(process.cwd(), '.env')
+   * @example require('@dotenvx/dotenvx').set(key, value, { path: '/custom/path/to/.env' })
+   * @example require('@dotenvx/dotenvx').set(key, value, { path: ['/path/to/first.env', '/path/to/second.env'] })
+   */
+  path?: string | string[] | URL;
+  /**
+   * Customize the path to your .env.keys file. This is useful with monorepos.
+   * @default []
+   * @example require('@dotenvx/dotenvx').config(key, value, { envKeysFile: '../../.env.keys'} })
+   */
+  envKeysFile?: string;
+  /**
+   * Set a .env convention (available conventions: 'nextjs, flow')
+   */
+  convention?: string;
+  /**
+   * Specify whether the variable has to be encrypted
+   * @default true
+   * @example require('@dotenvx/dotenvx').config(key, value, { encrypt: false } })
+   */
+  encrypt?: boolean;
+  /**
+   * Turn off Dotenvx Armor features.
+   *
+   * @default false
+   * @example require('@dotenvx/dotenvx').set(key, value, { noArmor: true })
+   */
+  noArmor?: boolean;
+  /**
+   * Turn off OS secret store features.
+   *
+   * @default false
+   * @example require('@dotenvx/dotenvx').set(key, value, { noNative: true })
+   */
+  noNative?: boolean;
+}
+interface GetOptions {
+  /**
+   * Mask returned values, optionally setting the number of visible characters.
+   * @default false
+   * @example require('@dotenvx/dotenvx').get('KEY', { mask: true })
+   * @example require('@dotenvx/dotenvx').get('KEY', { mask: 0 })
+   */
+  mask?: boolean | number;
+  /**
+   * Suppress specific errors like MISSING_ENV_FILE. The error keys can be found
+   * in src/lib/helpers/errors.js
+   * @default []
+   * @example require('@dotenvx/dotenvx').get('KEY', { ignore: ['MISSING_ENV_FILE'] })
+   */
+  ignore?: string[];
+  /**
+   * Override any environment variables that have already been set on your machine with values from your .env file.
+   * @default false
+   * @example require('@dotenvx/dotenvx').get('KEY', { overload: true })
+   * @alias overload
+   */
+  overload?: boolean;
+  /**
+   * Customize the path to your .env.keys file. This is useful with monorepos.
+   * @default []
+   * @example require('@dotenvx/dotenvx').get('KEY', { envKeysFile: '../../.env.keys'} })
+   */
+  envKeysFile?: string;
+  /**
+   * Throw immediately if an error is encountered - like a missing .env file.
+   * @default false
+   * @example require('@dotenvx/dotenvx').get('KEY', { strict: true })
+   */
+  strict?: boolean;
+  /**
+   * Turn off Dotenvx Armor features.
+   *
+   * @default false
+   * @example require('@dotenvx/dotenvx').get('KEY', { noArmor: true })
+   */
+  noArmor?: boolean;
+  /**
+   * Turn off OS secret store features.
+   *
+   * @default false
+   * @example require('@dotenvx/dotenvx').get('KEY', { noNative: true })
+   */
+  noNative?: boolean;
+  /**
+   * Turn off 1Password secret reference resolution.
+   *
+   * @default false
+   * @example require('@dotenvx/dotenvx').get('KEY', { no1Password: true })
+   */
+  no1Password?: boolean;
+  /**
+   * Turn off Bitwarden secret reference resolution.
+   *
+   * @default false
+   * @example require('@dotenvx/dotenvx').get('KEY', { noBitwarden: true })
+   */
+  noBitwarden?: boolean;
+}
+//#endregion
+//#region ../channels/src/channels/dotenvx/DotEnvXInstance.d.ts
+/**
+ * Minimal interface for dotenvx functionality used in ask-env.
+ */
+interface DotEnvXInstance {
+  get(key: string, options?: GetOptions): Promise<string>;
+  set(key: string, value: string, options?: SetOptions): Promise<unknown>;
+  config(options?: DotenvConfigOptions): DotenvConfigOutput;
+}
+//#endregion
+//#region ../channels/src/channels/dotenvx/DotEnvXGetOptions.d.ts
+/**
+ * Get options without envKeysFile since we manage that ourselves
+ */
+type DotEnvXGetOptions = Omit<GetOptions, "envKeysFile">;
+//#endregion
+//#region ../channels/src/channels/dotenvx/DotEnvXSetOptions.d.ts
+/**
+ * Set options without envKeysFile since we manage that ourselves
+ */
+type DotEnvXSetOptions = Omit<SetOptions, "envKeysFile">;
+//#endregion
+//#region ../channels/src/channels/dotenvx/DotEnvXChannelConfig.d.ts
+/**
+ * DotEnvX channel configuration
+ */
+interface DotEnvXChannelConfig {
+  dotenvx: DotEnvXInstance;
+  get?: DotEnvXGetOptions & {
+    [key: string]: unknown;
+  };
+  set?: DotEnvXSetOptions & {
+    [key: string]: unknown;
+  };
+}
+//#endregion
+//#region ../channels/src/channels/default/DefaultChannelConfig.d.ts
+/**
+ * Default channel configuration
+ */
+interface DefaultChannelConfig {
+  name: "default";
+}
+//#endregion
+//#region ../channels/src/channels/processenv/ProcessEnvChannelConfig.d.ts
+/**
+ * Configuration for ProcessEnv channel using name
+ */
+interface ProcessEnvChannelConfig {
+  name: "processenv";
+}
+/**
+ * Configuration for ProcessEnv channel using process shorthand
+ */
+interface ProcessChannelConfig {
+  process: NodeJS.Process;
+}
+//#endregion
+//#region ../channels/src/EnvChannelOptions.d.ts
+/**
+ * Channel options can be:
+ * - undefined (uses default channel)
+ * - "default" string (uses default channel)
+ * - "processenv" string (uses process.env channel)
+ * - dotenvx instance (uses dotenvx with default options)
+ * - DotEnvXChannelConfig (uses dotenvx with custom options)
+ * - DefaultChannelConfig (uses default with custom options)
+ * - ProcessEnvChannelConfig (uses process.env with config options)
+ * - ProcessChannelConfig (uses process.env with { process } notation)
+ */
+type EnvChannelOptions = undefined | "default" | "processenv" | DotEnvChannelConfig | DotEnvXChannelConfig | DefaultChannelConfig | ProcessEnvChannelConfig | ProcessChannelConfig;
+//#endregion
+export { DotEnvXChannelConfig as a, DotEnvXInstance as c, DotEnvConfigOutput as d, DotEnvInstance as f, DefaultChannelConfig as i, DotEnvChannelConfig as l, ProcessChannelConfig as n, DotEnvXSetOptions as o, DotEnvParseOptions as p, ProcessEnvChannelConfig as r, DotEnvXGetOptions as s, EnvChannelOptions as t, DotEnvConfigOptions as u };