@envctrl/types 1.0.0

package/dist/command.d.ts

@@ -0,0 +1,25 @@
+/**
+ * Runtime context injected into every subcommand execution.
+ * Contains the resolved working directory and global flags.
+ */
+export interface CommandContext {
+    readonly cwd: string;
+    readonly quiet: boolean;
+}
+/** Uniform result envelope returned from every subcommand execution. */
+export interface CommandResult<T = unknown> {
+    readonly success: boolean;
+    readonly data?: T;
+    readonly error?: string;
+}
+/**
+ * Contract every concrete command must satisfy.
+ * Separates what to execute from how the CLI routes to it.
+ *
+ * @template TOptions - Parsed options object passed from Commander
+ * @template TResult - Shape of the `data` field in the returned {@link CommandResult}
+ */
+export interface ISubCommand<TOptions = Record<string, unknown>, TResult = unknown> {
+    execute(options: TOptions, context: CommandContext): Promise<CommandResult<TResult>>;
+}
+//# sourceMappingURL=command.d.ts.map

package/dist/command.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"command.d.ts","sourceRoot":"","sources":["../src/command.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,WAAW,cAAc;IAC7B,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,KAAK,EAAE,OAAO,CAAC;CACzB;AAED,wEAAwE;AACxE,MAAM,WAAW,aAAa,CAAC,CAAC,GAAG,OAAO;IACxC,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAC1B,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAClB,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC;CACzB;AAED;;;;;;GAMG;AACH,MAAM,WAAW,WAAW,CAAC,QAAQ,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,OAAO,GAAG,OAAO;IAChF,OAAO,CAAC,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,cAAc,GAAG,OAAO,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,CAAC;CACtF"}

package/dist/command.js

@@ -0,0 +1 @@
+export {};

package/dist/dotenvx.d.ts

@@ -0,0 +1,11 @@
+/** Result of a dotenvx set operation mirrored from SetOutput. */
+export interface DotenvxSetResult {
+    readonly changedFilepaths: string[];
+    readonly unchangedFilepaths: string[];
+}
+/** Result of a dotenvx encrypt operation. */
+export interface DotenvxEncryptResult {
+    readonly changedFilepaths: string[];
+    readonly unchangedFilepaths: string[];
+}
+//# sourceMappingURL=dotenvx.d.ts.map

package/dist/dotenvx.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"dotenvx.d.ts","sourceRoot":"","sources":["../src/dotenvx.ts"],"names":[],"mappings":"AAAA,iEAAiE;AACjE,MAAM,WAAW,gBAAgB;IAC/B,QAAQ,CAAC,gBAAgB,EAAE,MAAM,EAAE,CAAC;IACpC,QAAQ,CAAC,kBAAkB,EAAE,MAAM,EAAE,CAAC;CACvC;AAED,6CAA6C;AAC7C,MAAM,WAAW,oBAAoB;IACnC,QAAQ,CAAC,gBAAgB,EAAE,MAAM,EAAE,CAAC;IACpC,QAAQ,CAAC,kBAAkB,EAAE,MAAM,EAAE,CAAC;CACvC"}

package/dist/dotenvx.js

@@ -0,0 +1 @@
+export {};

package/dist/environment.d.ts

@@ -0,0 +1,30 @@
+/** A validated environment name token, e.g. "development", "production". */
+export type EnvironmentName = string;
+/**
+ * Represents the pair of files that back one named environment.
+ * - `unencrypted`: `.env.[env].unencrypted` — the human-editable plaintext source
+ * - `encrypted`: `.env.[env]` — the dotenvx-encrypted file committed to VCS
+ */
+export interface EnvFilePair {
+    readonly environment: EnvironmentName;
+    readonly unencrypted: string;
+    readonly encrypted: string;
+}
+/** Outcome of a switch operation. */
+export interface SwitchResult {
+    readonly environment: EnvironmentName;
+    readonly created: string[];
+    readonly activePath: string;
+}
+/** Result of a set operation on a single key. */
+export interface SetResult {
+    readonly environment: EnvironmentName;
+    readonly key: string;
+    readonly changed: boolean;
+}
+/** Result of a bulk encrypt operation. */
+export interface EncryptResult {
+    readonly changedFiles: string[];
+    readonly unchangedFiles: string[];
+}
+//# sourceMappingURL=environment.d.ts.map

package/dist/environment.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"environment.d.ts","sourceRoot":"","sources":["../src/environment.ts"],"names":[],"mappings":"AAAA,4EAA4E;AAC5E,MAAM,MAAM,eAAe,GAAG,MAAM,CAAC;AAErC;;;;GAIG;AACH,MAAM,WAAW,WAAW;IAC1B,QAAQ,CAAC,WAAW,EAAE,eAAe,CAAC;IACtC,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;CAC5B;AAED,qCAAqC;AACrC,MAAM,WAAW,YAAY;IAC3B,QAAQ,CAAC,WAAW,EAAE,eAAe,CAAC;IACtC,QAAQ,CAAC,OAAO,EAAE,MAAM,EAAE,CAAC;IAC3B,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;CAC7B;AAED,iDAAiD;AACjD,MAAM,WAAW,SAAS;IACxB,QAAQ,CAAC,WAAW,EAAE,eAAe,CAAC;IACtC,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;CAC3B;AAED,0CAA0C;AAC1C,MAAM,WAAW,aAAa;IAC5B,QAAQ,CAAC,YAAY,EAAE,MAAM,EAAE,CAAC;IAChC,QAAQ,CAAC,cAAc,EAAE,MAAM,EAAE,CAAC;CACnC"}

package/dist/environment.js

@@ -0,0 +1 @@
+export {};

package/dist/index.d.ts

@@ -0,0 +1,5 @@
+export * from './environment.js';
+export * from './keystore.js';
+export * from './command.js';
+export * from './dotenvx.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,kBAAkB,CAAC;AACjC,cAAc,eAAe,CAAC;AAC9B,cAAc,cAAc,CAAC;AAC7B,cAAc,cAAc,CAAC"}

package/dist/index.js

@@ -0,0 +1,4 @@
+export * from './environment.js';
+export * from './keystore.js';
+export * from './command.js';
+export * from './dotenvx.js';

package/dist/keystore.d.ts

@@ -0,0 +1,14 @@
+/** Absolute path to a keystore directory. */
+export type KeystorePath = string;
+/** A named keystore entry as returned by list. */
+export interface KeystoreEntry {
+    readonly name: string;
+    readonly path: KeystorePath;
+}
+/** Configuration for a keystore instance. */
+export interface KeystoreConfig {
+    readonly path: KeystorePath;
+}
+/** The three actions the keystore command dispatches. */
+export type KeystoreAction = 'create' | 'list' | 'delete';
+//# sourceMappingURL=keystore.d.ts.map

package/dist/keystore.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"keystore.d.ts","sourceRoot":"","sources":["../src/keystore.ts"],"names":[],"mappings":"AAAA,6CAA6C;AAC7C,MAAM,MAAM,YAAY,GAAG,MAAM,CAAC;AAElC,kDAAkD;AAClD,MAAM,WAAW,aAAa;IAC5B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,IAAI,EAAE,YAAY,CAAC;CAC7B;AAED,6CAA6C;AAC7C,MAAM,WAAW,cAAc;IAC7B,QAAQ,CAAC,IAAI,EAAE,YAAY,CAAC;CAC7B;AAED,yDAAyD;AACzD,MAAM,MAAM,cAAc,GAAG,QAAQ,GAAG,MAAM,GAAG,QAAQ,CAAC"}

package/dist/keystore.js

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -0,0 +1,24 @@
+{
+  "name": "@envctrl/types",
+  "version": "1.0.0",
+  "type": "module",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "devDependencies": {
+    "typescript": "^5.8.0"
+  },
+  "scripts": {
+    "build": "tsc -p tsconfig.build.json",
+    "typecheck": "tsc --noEmit"
+  }
+}