vaultkeeper 1.0.0 → 1.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.cts CHANGED
@@ -401,9 +401,15 @@ interface BackendConfig {
401
401
  */
402
402
  /**
403
403
  * Factory function for creating a SecretBackend instance.
404
+ *
405
+ * @remarks
406
+ * Factories may optionally accept a {@link BackendConfig} to configure the
407
+ * backend from the user's vaultkeeper config file. Factories that do not need
408
+ * configuration can ignore the parameter.
409
+ *
404
410
  * @public
405
411
  */
406
- type BackendFactory = () => SecretBackend;
412
+ type BackendFactory = (config?: BackendConfig) => SecretBackend;
407
413
  /**
408
414
  * Abstraction interface for all secret storage backends.
409
415
  *
@@ -507,14 +513,6 @@ interface SetupResult {
507
513
  */
508
514
  type BackendSetupFactory = () => AsyncGenerator<SetupQuestion, SetupResult, string>;
509
515
 
510
- /**
511
- * Registry for secret backend implementations.
512
- *
513
- * @remarks
514
- * The registry maintains a mapping of backend types to factory functions,
515
- * allowing dynamic creation of backends based on configuration.
516
- */
517
-
518
516
  /**
519
517
  * Registry for secret backend implementations.
520
518
  *
@@ -537,10 +535,11 @@ declare class BackendRegistry {
537
535
  /**
538
536
  * Create a backend instance by type.
539
537
  * @param type - Backend type identifier
538
+ * @param config - Optional backend configuration forwarded to the factory
540
539
  * @returns A SecretBackend instance
541
540
  * @throws {@link BackendUnavailableError} if the backend type is not registered
542
541
  */
543
- static create(type: string): SecretBackend;
542
+ static create(type: string, config?: BackendConfig): SecretBackend;
544
543
  /**
545
544
  * Get all registered backend type identifiers.
546
545
  * @returns Array of backend type identifiers
package/dist/index.d.ts CHANGED
@@ -401,9 +401,15 @@ interface BackendConfig {
401
401
  */
402
402
  /**
403
403
  * Factory function for creating a SecretBackend instance.
404
+ *
405
+ * @remarks
406
+ * Factories may optionally accept a {@link BackendConfig} to configure the
407
+ * backend from the user's vaultkeeper config file. Factories that do not need
408
+ * configuration can ignore the parameter.
409
+ *
404
410
  * @public
405
411
  */
406
- type BackendFactory = () => SecretBackend;
412
+ type BackendFactory = (config?: BackendConfig) => SecretBackend;
407
413
  /**
408
414
  * Abstraction interface for all secret storage backends.
409
415
  *
@@ -507,14 +513,6 @@ interface SetupResult {
507
513
  */
508
514
  type BackendSetupFactory = () => AsyncGenerator<SetupQuestion, SetupResult, string>;
509
515
 
510
- /**
511
- * Registry for secret backend implementations.
512
- *
513
- * @remarks
514
- * The registry maintains a mapping of backend types to factory functions,
515
- * allowing dynamic creation of backends based on configuration.
516
- */
517
-
518
516
  /**
519
517
  * Registry for secret backend implementations.
520
518
  *
@@ -537,10 +535,11 @@ declare class BackendRegistry {
537
535
  /**
538
536
  * Create a backend instance by type.
539
537
  * @param type - Backend type identifier
538
+ * @param config - Optional backend configuration forwarded to the factory
540
539
  * @returns A SecretBackend instance
541
540
  * @throws {@link BackendUnavailableError} if the backend type is not registered
542
541
  */
543
- static create(type: string): SecretBackend;
542
+ static create(type: string, config?: BackendConfig): SecretBackend;
544
543
  /**
545
544
  * Get all registered backend type identifiers.
546
545
  * @returns Array of backend type identifiers