configorama 1.1.0 → 1.2.1

package/types/src/utils/setup/setupEngine.d.ts

@@ -0,0 +1,89 @@
+export type SetupAnswers = {
+    /**
+     * - answers for ${opt:...} variables
+     */
+    options: {
+        [x: string]: any;
+    };
+    /**
+     * - answers for ${env:...} variables
+     */
+    env: {
+        [x: string]: any;
+    };
+    /**
+     * - answers for ${self:...} variables
+     */
+    self: {
+        [x: string]: any;
+    };
+    /**
+     * - answers for dot-prop config references
+     */
+    dotProp: {
+        [x: string]: any;
+    };
+};
+export type SetupResult = {
+    /**
+     * - result shape version
+     */
+    schemaVersion: number;
+    /**
+     * - absolute path to the config file, null for object input
+     */
+    configPath: string | null;
+    /**
+     * - prompt requirements from buildConfigRequirements
+     */
+    requirements: Array<any>;
+    /**
+     * - raw user answers grouped by variable type
+     */
+    answers: SetupAnswers;
+    /**
+     * - answers with sensitive values redacted for display
+     */
+    redactedAnswers: SetupAnswers;
+};
+/**
+ * Run the setup flow: analyze the config, prompt for unresolved values, return answers.
+ * Pure orchestration - applies nothing to process.env, config, or disk.
+ * @param {string|Object} configPathOrObject - path to config file or raw config object
+ * @param {Object} [settings] - configorama settings, plus:
+ * @param {Function} [settings.promptRenderer] - replaces the interactive wizard (mocks, answers files)
+ * @param {Object} [settings.streams] - stream overrides forwarded to the prompt renderer
+ * @param {Object} deps - injected dependencies
+ * @param {Function} [deps.analyze] - configorama.analyze, injected to avoid a require cycle
+ * @param {Object} [deps.analysis] - pre-computed analysis; skips the analyze call
+ * @returns {Promise<SetupResult>} collected answers and requirements
+ */
+export function runSetup(configPathOrObject: string | any, settings?: {
+    promptRenderer?: Function;
+    streams?: any;
+}, deps?: {
+    analyze?: Function;
+    analysis?: any;
+}): Promise<SetupResult>;
+/**
+ * @typedef {Object} SetupAnswers
+ * @property {Object.<string, any>} options - answers for ${opt:...} variables
+ * @property {Object.<string, any>} env - answers for ${env:...} variables
+ * @property {Object.<string, any>} self - answers for ${self:...} variables
+ * @property {Object.<string, any>} dotProp - answers for dot-prop config references
+ */
+/**
+ * @typedef {Object} SetupResult
+ * @property {number} schemaVersion - result shape version
+ * @property {string|null} configPath - absolute path to the config file, null for object input
+ * @property {Array<Object>} requirements - prompt requirements from buildConfigRequirements
+ * @property {SetupAnswers} answers - raw user answers grouped by variable type
+ * @property {SetupAnswers} redactedAnswers - answers with sensitive values redacted for display
+ */
+/**
+ * Ensure every answer group exists so callers get a stable shape
+ * @param {Object|undefined} userInputs - answers from the prompt renderer
+ * @returns {SetupAnswers} answers with all groups present
+ */
+export function normalizeAnswerGroups(userInputs: any | undefined): SetupAnswers;
+//# sourceMappingURL=setupEngine.d.ts.map

package/types/src/utils/setup/setupEngine.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"setupEngine.d.ts","sourceRoot":"","sources":["../../../../src/utils/setup/setupEngine.js"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;mBAmBc,MAAM;;;;gBACN,MAAM,GAAC,IAAI;;;;kBACX,KAAK,KAAQ;;;;aACb,YAAY;;;;qBACZ,YAAY;;AAiB1B;;;;;;;;;;;GAWG;AACH,6CATW,MAAM,MAAO,aAErB;IAA4B,cAAc;IAChB,OAAO;CACjC,SACA;IAAwB,OAAO;IACT,QAAQ;CAC9B,GAAU,OAAO,CAAC,WAAW,CAAC,CA6BhC;AAtED;;;;;;GAMG;AAEH;;;;;;;GAOG;AAEH;;;;GAIG;AACH,kDAHW,MAAO,SAAS,GACd,YAAY,CASxB"}

package/types/src/utils/setup/stdoutRedirect.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Run fn with all process.stdout writes forwarded to target.
+ * TTY dimensions are mirrored from target so prompt layout matches the
+ * stream it actually renders on (stdout is often a pipe in --export mode).
+ * @param {import('stream').Writable} target - stream that receives the writes
+ * @param {Function} fn - async function to run while redirected
+ * @returns {Promise<any>} fn's result
+ */
+export function withStdoutRedirected(target: import("stream").Writable, fn: Function): Promise<any>;
+//# sourceMappingURL=stdoutRedirect.d.ts.map

package/types/src/utils/setup/stdoutRedirect.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"stdoutRedirect.d.ts","sourceRoot":"","sources":["../../../../src/utils/setup/stdoutRedirect.js"],"names":[],"mappings":"AAKA;;;;;;;GAOG;AACH,6CAJW,OAAO,QAAQ,EAAE,QAAQ,iBAEvB,OAAO,CAAC,GAAG,CAAC,CAgCxB"}

package/types/src/utils/setup/writeAnswers.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Write setup answers to a JSON file
+ * @param {string} filePath - target path
+ * @param {Object} answers - answer groups { options, env, self, dotProp }
+ * @param {Object} [opts] - write behavior
+ * @param {boolean} [opts.force] - overwrite an existing file
+ * @returns {{ path: string, groups: Object.<string, string[]> }} written target and key names per group
+ */
+export function writeAnswers(filePath: string, answers: any, opts?: {
+    force?: boolean;
+}): {
+    path: string;
+    groups: {
+        [x: string]: string[];
+    };
+};
+//# sourceMappingURL=writeAnswers.d.ts.map

package/types/src/utils/setup/writeAnswers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"writeAnswers.d.ts","sourceRoot":"","sources":["../../../../src/utils/setup/writeAnswers.js"],"names":[],"mappings":"AAOA;;;;;;;GAOG;AACH,uCANW,MAAM,uBAGd;IAAuB,KAAK,GAApB,OAAO;CACf,GAAU;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE;YAAQ,MAAM,GAAE,MAAM,EAAE;KAAC,CAAA;CAAE,CAgC/D"}

package/types/src/utils/setup/writeDotenv.d.ts

@@ -0,0 +1,27 @@
+/**
+ * Write env answers to a dotenv file
+ * @param {string} filePath - target dotenv path
+ * @param {Object.<string, any>} values - env key/value pairs to write
+ * @param {Object} [opts] - write behavior
+ * @param {boolean} [opts.merge] - replace/append the managed block, preserving other content
+ * @param {boolean} [opts.force] - overwrite the whole file if it exists
+ * @returns {{ path: string, keys: string[] }} written target and key names for summaries
+ */
+export function writeDotenv(filePath: string, values: {
+    [x: string]: any;
+}, opts?: {
+    merge?: boolean;
+    force?: boolean;
+}): {
+    path: string;
+    keys: string[];
+};
+/**
+ * Quote a value so common dotenv parsers read it back verbatim
+ * @param {string} value - raw value
+ * @returns {string} dotenv-safe representation
+ */
+export function quoteDotenvValue(value: string): string;
+export const MANAGED_BLOCK_START: "# >>> configx setup values >>>";
+export const MANAGED_BLOCK_END: "# <<< configx setup values <<<";
+//# sourceMappingURL=writeDotenv.d.ts.map

package/types/src/utils/setup/writeDotenv.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"writeDotenv.d.ts","sourceRoot":"","sources":["../../../../src/utils/setup/writeDotenv.js"],"names":[],"mappings":"AA4FA;;;;;;;;GAQG;AACH,sCAPW,MAAM;;UAGd;IAAuB,KAAK,GAApB,OAAO;IACQ,KAAK,GAApB,OAAO;CACf,GAAU;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,EAAE,CAAA;CAAE,CAmC5C;AA1HD;;;;GAIG;AACH,wCAHW,MAAM,GACJ,MAAM,CAYlB;AArBD,kCAA4B,gCAAgC,CAAA;AAC5D,gCAA0B,gCAAgC,CAAA"}

package/types/src/utils/strings/didYouMean.d.ts

@@ -0,0 +1,23 @@
+/**
+ * Optimal string alignment (Damerau) edit distance between two strings.
+ * Counts an adjacent transposition (e.g. "fromat" -> "format") as one edit,
+ * which keeps real single typos close while keeping unrelated words far apart.
+ * @param {string} a
+ * @param {string} b
+ * @returns {number} minimum edits (insert/delete/substitute/transpose)
+ */
+export function editDistance(a: string, b: string): number;
+/**
+ * Returns the candidate closest to input within an edit-distance threshold.
+ * Defaults to threshold 1 so only near-certain typos are suggested; this avoids
+ * hijacking legitimate passthrough options (e.g. `--stage`) that happen to sit a
+ * couple of edits away from a known flag.
+ * @param {string} input - the user-provided (possibly misspelled) token
+ * @param {string[]} candidates - known valid strings
+ * @param {{ threshold?: number }} [options]
+ * @returns {string|null} closest candidate, or null if none is close enough
+ */
+export function didYouMean(input: string, candidates: string[], options?: {
+    threshold?: number;
+}): string | null;
+//# sourceMappingURL=didYouMean.d.ts.map

package/types/src/utils/strings/didYouMean.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"didYouMean.d.ts","sourceRoot":"","sources":["../../../../src/utils/strings/didYouMean.js"],"names":[],"mappings":"AAGA;;;;;;;GAOG;AACH,gCAJW,MAAM,KACN,MAAM,GACJ,MAAM,CA8BlB;AAED;;;;;;;;;GASG;AACH,kCALW,MAAM,cACN,MAAM,EAAE,YACR;IAAE,SAAS,CAAC,EAAE,MAAM,CAAA;CAAE,GACpB,MAAM,GAAC,IAAI,CAkBvB"}

package/types/src/utils/strings/formatFunctionArgs.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"formatFunctionArgs.d.ts","sourceRoot":"","sources":["../../../../src/utils/strings/formatFunctionArgs.js"],"names":[],"mappings":"AAiBiB,0CAWhB"}
+{"version":3,"file":"formatFunctionArgs.d.ts","sourceRoot":"","sources":["../../../../src/utils/strings/formatFunctionArgs.js"],"names":[],"mappings":"AAsBiB,0CAWhB"}

package/types/src/utils/strings/replaceAll.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"replaceAll.d.ts","sourceRoot":"","sources":["../../../../src/utils/strings/replaceAll.js"],"names":[],"mappings":"AAKA;;;;;;GAMG;AACH,wCALW,MAAM,YACN,MAAM,UACN,MAAM,GACJ,MAAM,CAelB"}
+{"version":3,"file":"replaceAll.d.ts","sourceRoot":"","sources":["../../../../src/utils/strings/replaceAll.js"],"names":[],"mappings":"AAMA;;;;;;GAMG;AACH,wCALW,MAAM,YACN,MAAM,UACN,MAAM,GACJ,MAAM,CAelB"}

package/types/src/utils/strings/splitByComma.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"splitByComma.d.ts","sourceRoot":"","sources":["../../../../src/utils/strings/splitByComma.js"],"names":[],"mappings":"AAiBA,oEAgGC"}
+{"version":3,"file":"splitByComma.d.ts","sourceRoot":"","sources":["../../../../src/utils/strings/splitByComma.js"],"names":[],"mappings":"AAiBA,oEAqGC"}

package/types/src/utils/ui/configWizard.d.ts

@@ -2,9 +2,14 @@
  * Runs config setup wizard
  * @param {object} metadata - Enriched metadata from configorama
  * @param {object} originalConfig - The original config before resolution
+ * @param {string} [configFilePath] - Path to the config file for display
+ * @param {object} [streams] - Stream overrides for the prompt UI
+ * @param {import('stream').Writable} [streams.output] - Where prompt UI renders; stdout stays clean when set
  * @returns {Promise<object>} User inputs by variable type
  */
-export function runConfigWizard(metadata: object, originalConfig?: object, configFilePath?: string): Promise<object>;
+export function runConfigWizard(metadata: object, originalConfig?: object, configFilePath?: string, streams?: {
+    output?: import("stream").Writable;
+}): Promise<object>;
 /**
  * Groups variables by type for wizard flow
  * @param {object} uniqueVariables - The uniqueVariables from enriched metadata
@@ -12,12 +17,35 @@ export function runConfigWizard(metadata: object, originalConfig?: object, confi
  * @returns {object} Grouped variables by type
  */
 export function groupVariablesByType(uniqueVariables: object, originalConfig?: object): object;
-/**
- * Detects if a variable name suggests sensitive data
- * @param {string} name - Variable name
- * @returns {boolean} True if likely sensitive
- */
-export function isSensitiveVariable(name: string): boolean;
+export function groupPromptDescriptorsForWizard(descriptors: any): {
+    options: any[];
+    env: any[];
+    self: any[];
+    dotProp: any[];
+};
+export function descriptorToVarInfo(descriptor: any): {
+    key: any;
+    variable: any;
+    cleanName: any;
+    variableType: any;
+    type: any;
+    isRequired: any;
+    defaultValue: any;
+    hasFallback: boolean;
+    resolvedValue: any;
+    occurrences: any;
+    descriptions: any[];
+    allowedValues: any;
+    conflictWarning: any;
+    obtainHint: any;
+    examples: any;
+    defaultHint: any;
+    group: any;
+    deprecationMessage: any;
+    sensitive: any;
+};
+import { isSensitiveVariable } from "../redaction/redact";
+export function isVarInfoSensitive(varInfo: any): any;
 /**
  * Creates a human-readable prompt message
  * @param {object} varInfo - Variable info
@@ -64,4 +92,20 @@ export function prefixMultilineText(count: number, text: string): string;
  * @returns {string} Formatted text with pipe prefix and indentation
  */
 export function formatWizardMultilineText(indentCount: number, text: string, addLeadingEmptyLine?: boolean): string;
+/**
+ * Shortens a file path for display so long absolute paths don't wrap the prompt box.
+ * Prefers a path relative to cwd when shorter, then truncates the front, keeping the filename.
+ * @param {string} filePath - Path to display
+ * @param {number} maxLen - Maximum display length (default 56)
+ * @returns {string} Display-friendly path
+ */
+export function formatPathForDisplay(filePath: string, maxLen?: number): string;
+/**
+ * Removes a single pair of matching surrounding quotes from a string.
+ * Mirrors how configorama strips quotes from inline fallback values like `'us-east-1'`.
+ * @param {*} val - Value to clean
+ * @returns {*} The value without surrounding quotes (non-strings pass through)
+ */
+export function stripQuotes(val: any): any;
+export { isSensitiveVariable };
 //# sourceMappingURL=configWizard.d.ts.map

package/types/src/utils/ui/configWizard.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"configWizard.d.ts","sourceRoot":"","sources":["../../../../src/utils/ui/configWizard.js"],"names":[],"mappings":"AAwcA;;;;;GAKG;AACH,0CAJW,MAAM,mBACN,MAAM,4BACJ,OAAO,CAAC,MAAM,CAAC,CAqP3B;AA5pBD;;;;;GAKG;AACH,sDAJW,MAAM,mBACN,MAAM,GACJ,MAAM,CAgKlB;AAED;;;;GAIG;AACH,0CAHW,MAAM,GACJ,OAAO,CAYnB;AA+HD;;;;GAIG;AACH,6CAHW,MAAM,GACJ,MAAM,CA0GlB;AApMD;;;;GAIG;AACH,yCAHW,MAAM,GACJ,MAAM,GAAC,IAAI,CA0BvB;AAED;;;;GAIG;AACH,qCAHW,MAAM,GACJ,MAAM,GAAC,IAAI,CA4BvB;AAED;;;;GAIG;AACH,0CAHW,MAAM,GACJ,MAAM,EAAE,GAAC,IAAI,CAkBzB;AA3HD;;;;;GAKG;AACH,oCAJW,MAAM,gBACN,MAAM,GACJ,MAAM,GAAC,SAAS,CAgC5B;AAvPD;;;;;GAKG;AACH,2CAJW,MAAM,QACN,MAAM,GACJ,MAAM,CAMlB;AAED;;;;;;GAMG;AACH,uDALW,MAAM,QACN,MAAM,wBACN,OAAO,GACL,MAAM,CASlB"}
+{"version":3,"file":"configWizard.d.ts","sourceRoot":"","sources":["../../../../src/utils/ui/configWizard.js"],"names":[],"mappings":"AAomBA;;;;;;;;GAQG;AACH,0CAPW,MAAM,mBACN,MAAM,mBACN,MAAM,YAEd;IAA4C,MAAM,GAA1C,OAAO,QAAQ,EAAE,QAAQ;CACjC,GAAU,OAAO,CAAC,MAAM,CAAC,CAQ3B;AA/iBD;;;;;GAKG;AACH,sDAJW,MAAM,mBACN,MAAM,GACJ,MAAM,CAgKlB;AA2CD;;;;;EAkBC;AAnDD;;;;;;;;;;;;;;;;;;;;EA+BC;;AAsBD,sDAGC;AA0LD;;;;GAIG;AACH,6CAHW,MAAM,GACJ,MAAM,CA2HlB;AA7ND;;;;GAIG;AACH,yCAHW,MAAM,GACJ,MAAM,GAAC,IAAI,CA8BvB;AAED;;;;GAIG;AACH,qCAHW,MAAM,GACJ,MAAM,GAAC,IAAI,CA4BvB;AAED;;;;GAIG;AACH,0CAHW,MAAM,GACJ,MAAM,EAAE,GAAC,IAAI,CAsBzB;AAlKD;;;;;GAKG;AACH,oCAJW,MAAM,gBACN,MAAM,GACJ,MAAM,GAAC,SAAS,CA+D5B;AArXD;;;;;GAKG;AACH,2CAJW,MAAM,QACN,MAAM,GACJ,MAAM,CAMlB;AAED;;;;;;GAMG;AACH,uDALW,MAAM,QACN,MAAM,wBACN,OAAO,GACL,MAAM,CASlB;AAcD;;;;;;GAMG;AACH,+CAJW,MAAM,WACN,MAAM,GACJ,MAAM,CAOlB;AAxBD;;;;;GAKG;AACH,iCAHW,GAAC,GACC,GAAC,CAMb"}

package/types/src/utils/ui/createEditorLink.d.ts

@@ -8,4 +8,11 @@
  * @returns {string} The hyperlink string
  */
 export function createEditorLink(filePath: string, line?: number, column?: number, customDisplay?: string, color?: string | false): string;
+/**
+ * Returns a click-to-open path: relative to cwd with a leading './' when the file
+ * lives under cwd, otherwise the absolute path. Editors linkify both forms.
+ * @param {string} filePath - The file path
+ * @returns {string} Display path that editors can open on click
+ */
+export function toClickablePath(filePath: string): string;
 //# sourceMappingURL=createEditorLink.d.ts.map

package/types/src/utils/ui/createEditorLink.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"createEditorLink.d.ts","sourceRoot":"","sources":["../../../../src/utils/ui/createEditorLink.js"],"names":[],"mappings":"AAGA;;;;;;;;GAQG;AACH,2CAPW,MAAM,SACN,MAAM,WACN,MAAM,kBACN,MAAM,UACN,MAAM,GAAC,KAAK,GACV,MAAM,CAiBlB"}
+{"version":3,"file":"createEditorLink.d.ts","sourceRoot":"","sources":["../../../../src/utils/ui/createEditorLink.js"],"names":[],"mappings":"AAGA;;;;;;;;GAQG;AACH,2CAPW,MAAM,SACN,MAAM,WACN,MAAM,kBACN,MAAM,UACN,MAAM,GAAC,KAAK,GACV,MAAM,CAiBlB;AAED;;;;;GAKG;AACH,0CAHW,MAAM,GACJ,MAAM,CASlB"}

package/types/src/utils/ui/promptDescriptors.d.ts

@@ -0,0 +1,39 @@
+export function createPromptDescriptor(requirement: any): {
+    name: any;
+    variable: any;
+    variableType: any;
+    group: any;
+    promptType: string;
+    type: any;
+    required: boolean;
+    sensitive: boolean;
+    description: any;
+    obtainHint: any;
+    examples: any;
+    defaultHint: any;
+    deprecationMessage: any;
+    defaultValue: any;
+    placeholder: any;
+    allowedValues: any;
+    paths: any;
+    occurrences: any;
+    conflicts: any;
+    conflictWarning: any;
+    normalize: (value: any) => any;
+    validate: (value: any) => string;
+};
+export function createPromptDescriptors(requirements: any): any;
+export function getRequirementGroup(requirement: any): any;
+export function groupRequirementsForWizard(requirements: any): {
+    options: any[];
+    env: any[];
+    self: any[];
+    dotProp: any[];
+    files: any[];
+    other: any[];
+};
+export function normalizePromptValue(value: any, descriptor: any): any;
+export function selectPromptType(requirement: any): "text" | "password" | "multiselect" | "select" | "confirm";
+export function stripPromptQuotes(value: any): any;
+export function validatePromptValue(value: any, descriptor: any): string;
+//# sourceMappingURL=promptDescriptors.d.ts.map

package/types/src/utils/ui/promptDescriptors.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"promptDescriptors.d.ts","sourceRoot":"","sources":["../../../../src/utils/ui/promptDescriptors.js"],"names":[],"mappings":"AAgJA;;;;;;;;;;;;;;;;;;;;;;;EAoCC;AAED,gEAEC;AAzKD,2DAEC;AAED;;;;;;;EAiBC;AAsFD,uEAoBC;AAxGD,+GAOC;AA7CD,mDAIC;AAqED,yEA+CC"}

package/types/src/utils/variables/cleanVariable.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"cleanVariable.d.ts","sourceRoot":"","sources":["../../../../src/utils/variables/cleanVariable.js"],"names":[],"mappings":"AAUiB,2GAFJ,MAAM,CAoDlB"}
+{"version":3,"file":"cleanVariable.d.ts","sourceRoot":"","sources":["../../../../src/utils/variables/cleanVariable.js"],"names":[],"mappings":"AAaiB,2GAFJ,MAAM,CAuElB"}

package/types/src/utils/variables/getVariableType.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"getVariableType.d.ts","sourceRoot":"","sources":["../../../../src/utils/variables/getVariableType.js"],"names":[],"mappings":"AAQA;;;;;GAKG;AACH,2CAJW,MAAM,yBAEJ,MAAM,CAwClB"}
+{"version":3,"file":"getVariableType.d.ts","sourceRoot":"","sources":["../../../../src/utils/variables/getVariableType.js"],"names":[],"mappings":"AASA;;;;;GAKG;AACH,2CAJW,MAAM,yBAEJ,MAAM,CAwClB"}

package/types/src/utils/variables/variableUtils.d.ts

@@ -23,7 +23,7 @@ export function verifyVariable(variableString: any, valueObject: any, variableTy
  * Excludes suffix characters from the allowed set to prevent parsing issues
  * @param {string} [prefix='${'] - Variable prefix
  * @param {string} [suffix='}'] - Variable suffix
- * @param {string[]} [excludePatterns=['AWS', 'stageVariables']] - Patterns to exclude via negative lookahead
+ * @param {string[]} [excludePatterns=['AWS', 'aws:', 'stageVariables']] - Patterns to exclude via negative lookahead
  * @returns {string} Regex source string
  */
 export function buildVariableSyntax(prefix?: string, suffix?: string, excludePatterns?: string[]): string;