@quiltdata/benchling-webhook 0.7.4-20251107T053446Z → 0.7.4

package/dist/lib/xdg-config.d.ts

@@ -1,15 +1,15 @@
 /**
  * XDG Configuration Management (v0.7.0 - BREAKING CHANGE)
  *
- * Complete rewrite with NO backward compatibility with v0.6.x.
+ * Filesystem implementation of XDGBase for XDG-compliant configuration management.
  *
- * This module provides XDG-compliant configuration management for the Benchling Webhook system
- * with a simplified, profile-first architecture:
+ * This module provides filesystem-specific storage primitives for the Benchling Webhook system:
+ * - Filesystem-based profile storage in ~/.config/benchling-webhook/
+ * - Per-profile deployment tracking
+ * - Legacy configuration detection
+ * - Atomic writes with automatic backups
  *
- * - Single unified configuration file per profile (`config.json`)
- * - Per-profile deployment tracking (`deployments.json`)
- * - Profile inheritance support with deep merging
- * - Comprehensive validation and helpful error messages
+ * All business logic (validation, inheritance, deployment tracking) is handled by XDGBase.
  *
  * Directory Structure:
  * ```
@@ -25,10 +25,12 @@
  * @module xdg-config
  * @version 0.7.0
  */
-import { ProfileConfig, DeploymentHistory, DeploymentRecord, ValidationResult } from "./types/config";
+import { ProfileConfig, DeploymentHistory } from "./types/config";
+import { XDGBase } from "./xdg-base";
 /**
  * XDG Configuration Manager (v0.7.0)
  *
+ * Filesystem-based implementation extending XDGBase.
  * Manages profile-based configuration with deployment tracking.
  * NO backward compatibility with v0.6.x configuration files.
  *
@@ -53,7 +55,7 @@ import { ProfileConfig, DeploymentHistory, DeploymentRecord, ValidationResult }
  * });
  * ```
  */
-export declare class XDGConfig {
+export declare class XDGConfig extends XDGBase {
     private readonly baseDir;
     /**
      * Creates a new XDG Configuration Manager
@@ -62,222 +64,81 @@ export declare class XDGConfig {
      */
     constructor(baseDir?: string);
     /**
-     * Gets the default XDG base directory
-     *
-     * Respects XDG_CONFIG_HOME environment variable per XDG Base Directory spec.
+     * Reads raw profile configuration from filesystem without validation
      *
-     * @returns The default base directory path (~/.config/benchling-webhook or $XDG_CONFIG_HOME/benchling-webhook)
-     */
-    private getDefaultBaseDir;
-    /**
-     * Ensures the base configuration directory exists
-     *
-     * @throws {Error} If directory creation fails
-     */
-    private ensureBaseDirectoryExists;
-    /**
-     * Reads configuration for a profile
-     *
-     * @param profile - Profile name (e.g., "default", "dev", "prod")
-     * @returns Parsed configuration object
-     * @throws {Error} If profile not found or configuration is invalid
-     *
-     * @example
-     * ```typescript
-     * const config = xdg.readProfile("default");
-     * console.log(config.benchling.tenant);
-     * ```
+     * @param profile - Profile name
+     * @returns Raw profile configuration
+     * @throws {Error} If profile cannot be read
      */
-    readProfile(profile: string): ProfileConfig;
+    protected readProfileRaw(profile: string): ProfileConfig;
     /**
-     * Writes configuration for a profile
+     * Writes raw profile configuration to filesystem without validation
      *
      * Creates the profile directory if it doesn't exist.
      * Performs atomic write with automatic backup.
      *
      * @param profile - Profile name
-     * @param config - Configuration object to write
-     * @throws {Error} If validation fails or write operation fails
-     *
-     * @example
-     * ```typescript
-     * xdg.writeProfile("default", {
-     *   quilt: { ... },
-     *   benchling: { ... },
-     *   packages: { ... },
-     *   deployment: { ... },
-     *   _metadata: {
-     *     version: "0.7.0",
-     *     createdAt: new Date().toISOString(),
-     *     updatedAt: new Date().toISOString(),
-     *     source: "wizard"
-     *   }
-     * });
-     * ```
+     * @param config - Configuration to write
+     * @throws {Error} If write fails
      */
-    writeProfile(profile: string, config: ProfileConfig): void;
+    protected writeProfileRaw(profile: string, config: ProfileConfig): void;
     /**
-     * Deletes a profile and all its files
-     *
-     * WARNING: This is a destructive operation!
-     * Cannot delete the "default" profile.
-     *
-     * @param profile - Profile name to delete
-     * @throws {Error} If attempting to delete default profile or if deletion fails
+     * Deletes profile and all associated data from filesystem
      *
-     * @example
-     * ```typescript
-     * xdg.deleteProfile("dev");
-     * ```
+     * @param profile - Profile name
+     * @throws {Error} If deletion fails
      */
-    deleteProfile(profile: string): void;
+    protected deleteProfileRaw(profile: string): void;
     /**
-     * Lists all available profiles
+     * Lists all profile names from filesystem
      *
      * @returns Array of profile names
-     *
-     * @example
-     * ```typescript
-     * const profiles = xdg.listProfiles();
-     * console.log(profiles); // ["default", "dev", "prod"]
-     * ```
-     */
-    listProfiles(): string[];
-    /**
-     * Checks if a profile exists
-     *
-     * @param profile - Profile name to check
-     * @returns True if profile exists and has valid config.json, false otherwise
-     *
-     * @example
-     * ```typescript
-     * if (xdg.profileExists("dev")) {
-     *   const config = xdg.readProfile("dev");
-     * }
-     * ```
      */
-    profileExists(profile: string): boolean;
+    protected listProfilesRaw(): string[];
     /**
-     * Gets deployment history for a profile
-     *
-     * Returns empty history if deployments.json doesn't exist.
+     * Checks if profile exists on filesystem
      *
      * @param profile - Profile name
-     * @returns Deployment history with active deployments and full history
-     *
-     * @example
-     * ```typescript
-     * const deployments = xdg.getDeployments("default");
-     * console.log(deployments.active["prod"]); // Active prod deployment
-     * console.log(deployments.history[0]); // Most recent deployment
-     * ```
+     * @returns True if profile exists
      */
-    getDeployments(profile: string): DeploymentHistory;
+    protected profileExistsRaw(profile: string): boolean;
     /**
-     * Records a new deployment for a profile
-     *
-     * Adds deployment to history and updates active deployment for the stage.
-     * Creates deployments.json if it doesn't exist.
+     * Reads raw deployment history from filesystem without validation
      *
      * @param profile - Profile name
-     * @param deployment - Deployment record to add
-     *
-     * @example
-     * ```typescript
-     * xdg.recordDeployment("default", {
-     *   stage: "prod",
-     *   timestamp: new Date().toISOString(),
-     *   imageTag: "0.7.0",
-     *   endpoint: "https://abc123.execute-api.us-east-1.amazonaws.com/prod",
-     *   stackName: "BenchlingWebhookStack",
-     *   region: "us-east-1",
-     *   deployedBy: "ernest@example.com",
-     *   commit: "abc123f"
-     * });
-     * ```
+     * @returns Deployment history or null if none exists
+     * @throws {Error} If read fails
      */
-    recordDeployment(profile: string, deployment: DeploymentRecord): void;
+    protected readDeploymentsRaw(profile: string): DeploymentHistory | null;
     /**
-     * Gets the active deployment for a specific stage
+     * Writes raw deployment history to filesystem without validation
      *
      * @param profile - Profile name
-     * @param stage - Stage name (e.g., "dev", "prod")
-     * @returns Active deployment record for the stage, or null if none exists
-     *
-     * @example
-     * ```typescript
-     * const prodDeployment = xdg.getActiveDeployment("default", "prod");
-     * if (prodDeployment) {
-     *   console.log("Prod endpoint:", prodDeployment.endpoint);
-     * }
-     * ```
+     * @param history - Deployment history to write
+     * @throws {Error} If write fails
      */
-    getActiveDeployment(profile: string, stage: string): DeploymentRecord | null;
+    protected writeDeploymentsRaw(profile: string, history: DeploymentHistory): void;
     /**
-     * Reads profile configuration with inheritance support
-     *
-     * If the profile has an `_inherits` field, loads the base profile first
-     * and deep merges the current profile on top.
-     *
-     * Detects and prevents circular inheritance chains.
-     *
-     * @param profile - Profile name to read
-     * @param baseProfile - Optional explicit base profile (overrides `_inherits`)
-     * @returns Merged configuration with inheritance applied
-     * @throws {Error} If circular inheritance is detected
-     *
-     * @example
-     * ```typescript
-     * // dev/config.json has "_inherits": "default"
-     * const devConfig = xdg.readProfileWithInheritance("dev");
-     * // Returns default config deep-merged with dev overrides
-     * ```
-     */
-    readProfileWithInheritance(profile: string, baseProfile?: string): ProfileConfig;
-    /**
-     * Internal recursive implementation of profile inheritance
-     *
-     * @param profile - Current profile name
-     * @param explicitBase - Explicitly specified base profile
-     * @param visited - Set of visited profiles (for circular detection)
-     * @returns Merged configuration
-     * @throws {Error} If circular inheritance is detected
-     */
-    private readProfileWithInheritanceInternal;
-    /**
-     * Deep merges two profile configurations
+     * Gets the default XDG base directory
      *
-     * Nested objects are merged recursively.
-     * Arrays are replaced (not concatenated).
-     * Current config takes precedence over base config.
+     * Respects XDG_CONFIG_HOME environment variable per XDG Base Directory spec.
      *
-     * @param base - Base configuration
-     * @param current - Current configuration (takes precedence)
-     * @returns Merged configuration
+     * @returns The default base directory path (~/.config/benchling-webhook or $XDG_CONFIG_HOME/benchling-webhook)
      */
-    private deepMergeConfigs;
+    private getDefaultBaseDir;
     /**
-     * Validates a profile configuration against the schema
-     *
-     * @param config - Configuration object to validate
-     * @returns Validation result with errors and warnings
+     * Ensures the base configuration directory exists
      *
-     * @example
-     * ```typescript
-     * const validation = xdg.validateProfile(config);
-     * if (!validation.isValid) {
-     *   console.error("Validation errors:", validation.errors);
-     * }
-     * ```
+     * @throws {Error} If directory creation fails
      */
-    validateProfile(config: ProfileConfig): ValidationResult;
+    private ensureBaseDirectoryExists;
     /**
      * Gets the directory path for a profile
      *
      * @param profile - Profile name
      * @returns Absolute path to profile directory
      */
-    private getProfileDir;
+    private getProfilePath;
     /**
      * Gets the config.json path for a profile
      *
@@ -291,15 +152,21 @@ export declare class XDGConfig {
      * @param profile - Profile name
      * @returns Absolute path to deployments.json
      */
-    private getProfileDeploymentsPath;
+    private getDeploymentsPath;
+    /**
+     * Detects legacy v0.6.x configuration files
+     *
+     * @returns True if legacy files are detected
+     */
+    detectLegacyConfiguration(): boolean;
     /**
      * Builds a helpful error message when a profile is not found
      *
-     * Detects legacy v0.6.x configuration files and provides upgrade guidance.
+     * Overrides base class to add legacy configuration detection.
      *
      * @param profile - Profile name that was not found
      * @returns Formatted error message
      */
-    private buildProfileNotFoundError;
+    protected buildProfileNotFoundError(profile: string): string;
 }
 //# sourceMappingURL=xdg-config.d.ts.map

package/dist/lib/xdg-config.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"xdg-config.d.ts","sourceRoot":"","sources":["../../lib/xdg-config.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AAQH,OAAO,EACH,aAAa,EACb,iBAAiB,EACjB,gBAAgB,EAChB,gBAAgB,EAGnB,MAAM,gBAAgB,CAAC;AAExB;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,qBAAa,SAAS;IAClB,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAS;IAEjC;;;;OAIG;gBACS,OAAO,CAAC,EAAE,MAAM;IAK5B;;;;;;OAMG;IACH,OAAO,CAAC,iBAAiB;IASzB;;;;OAIG;IACH,OAAO,CAAC,yBAAyB;IAUjC;;;;;;;;;;;;OAYG;IACI,WAAW,CAAC,OAAO,EAAE,MAAM,GAAG,aAAa;IA8BlD;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACI,YAAY,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,aAAa,GAAG,IAAI;IAqDjE;;;;;;;;;;;;;OAaG;IACI,aAAa,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI;IAiB3C;;;;;;;;;;OAUG;IACI,YAAY,IAAI,MAAM,EAAE;IAgB/B;;;;;;;;;;;;OAYG;IACI,aAAa,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO;IAS9C;;;;;;;;;;;;;;OAcG;IACI,cAAc,CAAC,OAAO,EAAE,MAAM,GAAG,iBAAiB;IAsCzD;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACI,gBAAgB,CAAC,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,gBAAgB,GAAG,IAAI;IAiE5E;;;;;;;;;;;;;;OAcG;IACI,mBAAmB,CAAC,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,gBAAgB,GAAG,IAAI;IAanF;;;;;;;;;;;;;;;;;;;OAmBG;IACI,0BAA0B,CAAC,OAAO,EAAE,MAAM,EAAE,WAAW,CAAC,EAAE,MAAM,GAAG,aAAa;IAKvF;;;;;;;;OAQG;IACH,OAAO,CAAC,kCAAkC;IAoC1C;;;;;;;;;;OAUG;IACH,OAAO,CAAC,gBAAgB;IAQxB;;;;;;;;;;;;;OAaG;IACI,eAAe,CAAC,MAAM,EAAE,aAAa,GAAG,gBAAgB;IA8B/D;;;;;OAKG;IACH,OAAO,CAAC,aAAa;IAIrB;;;;;OAKG;IACH,OAAO,CAAC,oBAAoB;IAI5B;;;;;OAKG;IACH,OAAO,CAAC,yBAAyB;IAQjC;;;;;;;OAOG;IACH,OAAO,CAAC,yBAAyB;CAsCpC"}
+{"version":3,"file":"xdg-config.d.ts","sourceRoot":"","sources":["../../lib/xdg-config.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AAKH,OAAO,EAAE,aAAa,EAAE,iBAAiB,EAAE,MAAM,gBAAgB,CAAC;AAClE,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AAErC;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,qBAAa,SAAU,SAAQ,OAAO;IAClC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAS;IAEjC;;;;OAIG;gBACS,OAAO,CAAC,EAAE,MAAM;IAU5B;;;;;;OAMG;IACH,SAAS,CAAC,cAAc,CAAC,OAAO,EAAE,MAAM,GAAG,aAAa;IAoBxD;;;;;;;;;OASG;IACH,SAAS,CAAC,eAAe,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,aAAa,GAAG,IAAI;IA+CvE;;;;;OAKG;IACH,SAAS,CAAC,gBAAgB,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI;IASjD;;;;OAIG;IACH,SAAS,CAAC,eAAe,IAAI,MAAM,EAAE;IAgBrC;;;;;OAKG;IACH,SAAS,CAAC,gBAAgB,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO;IAKpD;;;;;;OAMG;IACH,SAAS,CAAC,kBAAkB,CAAC,OAAO,EAAE,MAAM,GAAG,iBAAiB,GAAG,IAAI;IAwBvE;;;;;;OAMG;IACH,SAAS,CAAC,mBAAmB,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,iBAAiB,GAAG,IAAI;IAmDhF;;;;;;OAMG;IACH,OAAO,CAAC,iBAAiB;IASzB;;;;OAIG;IACH,OAAO,CAAC,yBAAyB;IAMjC;;;;;OAKG;IACH,OAAO,CAAC,cAAc;IAItB;;;;;OAKG;IACH,OAAO,CAAC,oBAAoB;IAI5B;;;;;OAKG;IACH,OAAO,CAAC,kBAAkB;IAQ1B;;;;OAIG;IACI,yBAAyB,IAAI,OAAO;IAU3C;;;;;;;OAOG;IACH,SAAS,CAAC,yBAAyB,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM;CAqB/D"}