@wrkspace-co/env 0.1.0

package/dist/index.js

@@ -0,0 +1,123 @@
+import {
+  DEFAULT_GENERATED_SCHEMA_FILE,
+  DEFAULT_MIGRATIONS_DIR,
+  DEFAULT_MIGRATION_STATE_FILE,
+  DEFAULT_MIGRATION_TARGET_FILES,
+  DEFAULT_SCHEMA_FILES,
+  EnvValidationError,
+  applyPendingMigrations,
+  boolean,
+  builders,
+  createAirlockProgram,
+  createEnv,
+  createEnvMigrationContext,
+  createMigrationFile,
+  defineSchema,
+  detectDrift,
+  discoverMigrations,
+  dotenvToObject,
+  enumBuilder,
+  finalizeFluentDefinitions,
+  formatDotenvValue,
+  formatValidationIssues,
+  generateArtifacts,
+  generateTargetEnvFile,
+  getMigrationStatus,
+  hasKeyInTargetDocuments,
+  json,
+  loadEnvTargetDocuments,
+  loadMigrationState,
+  loadOrBuildMigrationSchema,
+  loadSchema,
+  number,
+  parseDotenv,
+  plugin_default,
+  prefixPolicies,
+  register,
+  renderExport,
+  resolveSchemaPath,
+  rollbackMigrations,
+  runAuditCommand,
+  runCheckCommand,
+  runDeprecationsCommand,
+  runDiffCommand,
+  runDoctorCommand,
+  runExportCommand,
+  runExternalCommand,
+  runGenerateCommand,
+  runMigrateCommand,
+  runMigrateMakeCommand,
+  runMigrateRollbackCommand,
+  runMigrateStatusCommand,
+  runPullVercelCommand,
+  runPushHerokuCommand,
+  runReconcileCommand,
+  runSchemaBuildCommand,
+  saveMigrationState,
+  string,
+  url,
+  writeDotenv,
+  writeEnvTargetDocuments
+} from "./chunk-32DQKIYR.js";
+export {
+  DEFAULT_GENERATED_SCHEMA_FILE,
+  DEFAULT_MIGRATIONS_DIR,
+  DEFAULT_MIGRATION_STATE_FILE,
+  DEFAULT_MIGRATION_TARGET_FILES,
+  DEFAULT_SCHEMA_FILES,
+  EnvValidationError,
+  applyPendingMigrations,
+  boolean,
+  builders,
+  createAirlockProgram,
+  createEnv,
+  createEnvMigrationContext,
+  createMigrationFile,
+  defineSchema,
+  detectDrift,
+  discoverMigrations,
+  dotenvToObject,
+  enumBuilder as enum,
+  finalizeFluentDefinitions,
+  formatDotenvValue,
+  formatValidationIssues,
+  generateArtifacts,
+  generateTargetEnvFile,
+  getMigrationStatus,
+  hasKeyInTargetDocuments,
+  json,
+  loadEnvTargetDocuments,
+  loadMigrationState,
+  loadOrBuildMigrationSchema,
+  loadSchema,
+  number,
+  parseDotenv,
+  plugin_default as plugin,
+  prefixPolicies,
+  register,
+  renderExport,
+  resolveSchemaPath,
+  rollbackMigrations,
+  runAuditCommand,
+  runCheckCommand,
+  runDeprecationsCommand,
+  runDiffCommand,
+  runDoctorCommand,
+  runExportCommand,
+  runExternalCommand,
+  runGenerateCommand,
+  runMigrateCommand,
+  runMigrateMakeCommand,
+  runMigrateRollbackCommand,
+  runMigrateStatusCommand,
+  runPullVercelCommand,
+  runPushHerokuCommand,
+  runReconcileCommand,
+  runSchemaBuildCommand,
+  saveMigrationState,
+  string,
+  url,
+  writeDotenv,
+  writeEnvTargetDocuments
+};
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}

package/dist/plugin-Dj0BMNPC.d.ts

@@ -0,0 +1,241 @@
+import { Command } from 'commander';
+
+type EnvTarget = "dev" | "preview" | "prod";
+type EnvScope = "server" | "client";
+type EnvKind = "string" | "url" | "number" | "boolean" | "enum" | "json";
+type ValidationSeverity = "error" | "warning";
+interface DeprecatedMetadata {
+    replacedBy?: string;
+    removeAfter?: string;
+    message?: string;
+}
+type ProviderMapping = {
+    vercel?: string;
+    heroku?: string;
+} & Record<string, string | undefined>;
+interface EnvVariableMetadata {
+    description?: string;
+    example?: string;
+    sensitive?: boolean;
+    owner?: string;
+    rotationDays?: number;
+    deprecated?: DeprecatedMetadata;
+    provider?: ProviderMapping;
+    tags?: string[];
+}
+interface EnvVariableConfig extends EnvVariableMetadata {
+    scope?: EnvScope;
+    requiredIn?: readonly EnvTarget[];
+    defaultValue?: unknown;
+}
+interface BaseVariableDefinition<TKind extends EnvKind> extends EnvVariableMetadata {
+    kind: TKind;
+    scope: EnvScope;
+    requiredIn: readonly EnvTarget[];
+    defaultValue?: unknown;
+}
+interface StringVariableDefinition extends BaseVariableDefinition<"string"> {
+}
+interface UrlVariableDefinition extends BaseVariableDefinition<"url"> {
+}
+interface NumberVariableDefinition extends BaseVariableDefinition<"number"> {
+}
+interface BooleanVariableDefinition extends BaseVariableDefinition<"boolean"> {
+}
+interface EnumVariableDefinition<TValue extends string = string> extends BaseVariableDefinition<"enum"> {
+    values: readonly TValue[];
+}
+interface JsonVariableDefinition<TValue = unknown> extends BaseVariableDefinition<"json"> {
+    readonly __valueType?: TValue;
+}
+type EnvVariableDefinition = StringVariableDefinition | UrlVariableDefinition | NumberVariableDefinition | BooleanVariableDefinition | EnumVariableDefinition | JsonVariableDefinition;
+type EnvSchema = Record<string, EnvVariableDefinition>;
+declare function string(config?: EnvVariableConfig): StringVariableDefinition;
+declare function url(config?: EnvVariableConfig): UrlVariableDefinition;
+declare function number(config?: EnvVariableConfig): NumberVariableDefinition;
+declare function boolean(config?: EnvVariableConfig): BooleanVariableDefinition;
+declare function enumBuilder<const TValue extends readonly [string, ...string[]]>(values: TValue, config?: EnvVariableConfig): EnumVariableDefinition<TValue[number]>;
+
+declare function json<TValue = unknown>(config?: EnvVariableConfig): JsonVariableDefinition<TValue>;
+declare const builders: {
+    string: typeof string;
+    url: typeof url;
+    number: typeof number;
+    boolean: typeof boolean;
+    enum: typeof enumBuilder;
+    json: typeof json;
+};
+declare function defineSchema<TSchema extends EnvSchema>(schema: TSchema): TSchema;
+interface EnvValidationIssue {
+    key: string;
+    target: EnvTarget;
+    scope: EnvScope;
+    severity: ValidationSeverity;
+    code: string;
+    message: string;
+    fix?: string;
+}
+interface PrefixPolicyIssue {
+    severity: ValidationSeverity;
+    code: string;
+    message: string;
+    fix?: string;
+}
+interface PrefixPolicyContext {
+    key: string;
+    target: EnvTarget;
+    scope: EnvScope;
+    hasPublicPrefix: boolean;
+    publicPrefixes: readonly string[];
+    strict: boolean;
+}
+interface PrefixPolicy {
+    name?: string;
+    publicPrefixes: readonly string[];
+    validate?(context: PrefixPolicyContext): PrefixPolicyIssue[] | void;
+}
+declare const prefixPolicies: {
+    nextjs: PrefixPolicy;
+    vite: PrefixPolicy;
+};
+interface CreateEnvOptions {
+    target: EnvTarget;
+    values?: Record<string, string | undefined>;
+    strict?: boolean;
+    throwOnError?: boolean;
+    prefixPolicy?: PrefixPolicy;
+    now?: Date;
+    onWarning?: (issue: EnvValidationIssue) => void;
+}
+type InferVariableValue<TDefinition extends EnvVariableDefinition> = TDefinition extends StringVariableDefinition ? string : TDefinition extends UrlVariableDefinition ? URL : TDefinition extends NumberVariableDefinition ? number : TDefinition extends BooleanVariableDefinition ? boolean : TDefinition extends EnumVariableDefinition<infer TValue> ? TValue : TDefinition extends JsonVariableDefinition<infer TValue> ? TValue : never;
+type EnvValueMap<TSchema extends EnvSchema> = {
+    [TKey in keyof TSchema]: InferVariableValue<TSchema[TKey]> | undefined;
+};
+type PickedEnvValueMap<TSchema extends EnvSchema, TKeys extends readonly (keyof TSchema)[]> = {
+    [TKey in TKeys[number]]: InferVariableValue<TSchema[TKey]> | undefined;
+};
+declare function formatValidationIssues(issues: readonly EnvValidationIssue[]): string;
+declare class EnvValidationError extends Error {
+    readonly issues: readonly EnvValidationIssue[];
+    constructor(issues: readonly EnvValidationIssue[]);
+}
+interface RuntimeEnv<TSchema extends EnvSchema> {
+    get<TKey extends keyof TSchema>(key: TKey): InferVariableValue<TSchema[TKey]>;
+    optional<TKey extends keyof TSchema>(key: TKey): InferVariableValue<TSchema[TKey]> | undefined;
+    assert(): void;
+    pick<const TKeys extends readonly (keyof TSchema)[]>(keys: TKeys): PickedEnvValueMap<TSchema, TKeys>;
+    all(): EnvValueMap<TSchema>;
+    meta<TKey extends keyof TSchema>(key: TKey): TSchema[TKey];
+    meta(): TSchema;
+}
+declare function createEnv<TSchema extends EnvSchema>(schema: TSchema, options: CreateEnvOptions): RuntimeEnv<TSchema>;
+
+type ProgramLike = Pick<Command, "command">;
+interface GenerateCliOptions {
+    writeLocal?: boolean;
+    writeTargetFiles?: boolean;
+    schema?: string;
+    app?: string;
+}
+interface CheckCliOptions {
+    target: EnvTarget;
+    app?: string;
+    allowUnknown?: boolean;
+    json?: boolean;
+    schema?: string;
+}
+interface DoctorCliOptions {
+    schema?: string;
+}
+interface AuditCliOptions {
+    schema?: string;
+    json?: boolean;
+}
+interface PullVercelCliOptions {
+    env: EnvTarget;
+}
+interface DiffVercelCliOptions {
+    env: EnvTarget;
+    schema?: string;
+    json?: boolean;
+    allowUnknown?: boolean;
+}
+interface DiffHerokuCliOptions {
+    app: string;
+    schema?: string;
+    json?: boolean;
+    allowUnknown?: boolean;
+}
+interface PushHerokuCliOptions {
+    app: string;
+    target: EnvTarget;
+    from: string;
+    schema?: string;
+}
+interface ExportCliOptions {
+    schema?: string;
+    withValues?: boolean;
+    from?: string;
+}
+interface DeprecationsCliOptions {
+    schema?: string;
+    app?: string;
+    json?: boolean;
+}
+interface MigrateMakeCliOptions {
+    dir?: string;
+}
+interface MigrateCliOptions {
+    dir?: string;
+    state?: string;
+    schemaFile?: string;
+}
+interface MigrateStatusCliOptions {
+    dir?: string;
+    state?: string;
+    schemaFile?: string;
+    json?: boolean;
+}
+interface MigrateRollbackCliOptions {
+    dir?: string;
+    state?: string;
+    schemaFile?: string;
+    steps: number;
+}
+interface SchemaBuildCliOptions {
+    dir?: string;
+    state?: string;
+    schemaFile?: string;
+    force?: boolean;
+}
+interface ReconcileCliOptions {
+    schema?: string;
+    app?: string;
+    writeMigration?: boolean;
+    dir?: string;
+}
+declare function handleGenerateCommand(options: GenerateCliOptions): Promise<void>;
+declare function handleCheckCommand(options: CheckCliOptions): Promise<number>;
+declare function handleDeprecationsCommand(options: DeprecationsCliOptions): Promise<number>;
+declare function handleDoctorCommand(options: DoctorCliOptions): Promise<number>;
+declare function handleAuditCommand(options: AuditCliOptions): Promise<number>;
+declare function handlePullVercelCommand(options: PullVercelCliOptions): Promise<number>;
+declare function handleDiffVercelCommand(options: DiffVercelCliOptions): Promise<number>;
+declare function handleDiffHerokuCommand(options: DiffHerokuCliOptions): Promise<number>;
+declare function handlePushHerokuCommand(options: PushHerokuCliOptions): Promise<number>;
+declare function handleExportDockerComposeCommand(options: ExportCliOptions): Promise<number>;
+declare function handleExportK8sCommand(options: ExportCliOptions): Promise<number>;
+declare function handleExportGithubActionsCommand(options: ExportCliOptions): Promise<number>;
+declare function handleMigrateMakeCommand(name: string, options: MigrateMakeCliOptions): Promise<number>;
+declare function handleMigrateCommand(options: MigrateCliOptions): Promise<number>;
+declare function handleMigrateStatusCommand(options: MigrateStatusCliOptions): Promise<number>;
+declare function handleMigrateRollbackCommand(options: MigrateRollbackCliOptions): Promise<number>;
+declare function handleSchemaBuildCommand(options: SchemaBuildCliOptions): Promise<number>;
+declare function handleReconcileCommand(options: ReconcileCliOptions): Promise<number>;
+declare function createAirlockProgram(): Command;
+declare function register(program: ProgramLike): void;
+declare const plugin: {
+    register: typeof register;
+};
+
+export { type SchemaBuildCliOptions as $, type AuditCliOptions as A, type BooleanVariableDefinition as B, type CreateEnvOptions as C, type DeprecatedMetadata as D, type EnvValidationIssue as E, type CheckCliOptions as F, type DeprecationsCliOptions as G, type DiffHerokuCliOptions as H, type DiffVercelCliOptions as I, type JsonVariableDefinition as J, type DoctorCliOptions as K, type ExportCliOptions as L, type GenerateCliOptions as M, type NumberVariableDefinition as N, type MigrateCliOptions as O, type PrefixPolicy as P, type MigrateMakeCliOptions as Q, type RuntimeEnv as R, type StringVariableDefinition as S, type MigrateRollbackCliOptions as T, type UrlVariableDefinition as U, type ValidationSeverity as V, type MigrateStatusCliOptions as W, type ProgramLike as X, type PullVercelCliOptions as Y, type PushHerokuCliOptions as Z, type ReconcileCliOptions as _, type EnvTarget as a, handleAuditCommand as a0, handleCheckCommand as a1, handleDeprecationsCommand as a2, handleDiffHerokuCommand as a3, handleDiffVercelCommand as a4, handleDoctorCommand as a5, handleExportDockerComposeCommand as a6, handleExportGithubActionsCommand as a7, handleExportK8sCommand as a8, handleGenerateCommand as a9, handleMigrateCommand as aa, handleMigrateMakeCommand as ab, handleMigrateRollbackCommand as ac, handleMigrateStatusCommand as ad, handlePullVercelCommand as ae, handlePushHerokuCommand as af, handleReconcileCommand as ag, handleSchemaBuildCommand as ah, type EnvSchema as b, type EnvScope as c, type EnvVariableDefinition as d, type ProviderMapping as e, type EnumVariableDefinition as f, type EnvKind as g, EnvValidationError as h, type EnvVariableConfig as i, type EnvVariableMetadata as j, type PrefixPolicyContext as k, type PrefixPolicyIssue as l, boolean as m, builders as n, createAirlockProgram as o, createEnv as p, defineSchema as q, enumBuilder as r, formatValidationIssues as s, json as t, number as u, plugin as v, prefixPolicies as w, register as x, string as y, url as z };

package/dist/plugin.d.ts

@@ -0,0 +1,2 @@
+import 'commander';
+export { A as AuditCliOptions, F as CheckCliOptions, G as DeprecationsCliOptions, H as DiffHerokuCliOptions, I as DiffVercelCliOptions, K as DoctorCliOptions, L as ExportCliOptions, M as GenerateCliOptions, O as MigrateCliOptions, Q as MigrateMakeCliOptions, T as MigrateRollbackCliOptions, W as MigrateStatusCliOptions, X as ProgramLike, Y as PullVercelCliOptions, Z as PushHerokuCliOptions, _ as ReconcileCliOptions, $ as SchemaBuildCliOptions, o as createAirlockProgram, v as default, a0 as handleAuditCommand, a1 as handleCheckCommand, a2 as handleDeprecationsCommand, a3 as handleDiffHerokuCommand, a4 as handleDiffVercelCommand, a5 as handleDoctorCommand, a6 as handleExportDockerComposeCommand, a7 as handleExportGithubActionsCommand, a8 as handleExportK8sCommand, a9 as handleGenerateCommand, aa as handleMigrateCommand, ab as handleMigrateMakeCommand, ac as handleMigrateRollbackCommand, ad as handleMigrateStatusCommand, ae as handlePullVercelCommand, af as handlePushHerokuCommand, ag as handleReconcileCommand, ah as handleSchemaBuildCommand, x as register } from './plugin-Dj0BMNPC.js';

package/dist/plugin.js

@@ -0,0 +1,47 @@
+import {
+  createAirlockProgram,
+  handleAuditCommand,
+  handleCheckCommand,
+  handleDeprecationsCommand,
+  handleDiffHerokuCommand,
+  handleDiffVercelCommand,
+  handleDoctorCommand,
+  handleExportDockerComposeCommand,
+  handleExportGithubActionsCommand,
+  handleExportK8sCommand,
+  handleGenerateCommand,
+  handleMigrateCommand,
+  handleMigrateMakeCommand,
+  handleMigrateRollbackCommand,
+  handleMigrateStatusCommand,
+  handlePullVercelCommand,
+  handlePushHerokuCommand,
+  handleReconcileCommand,
+  handleSchemaBuildCommand,
+  plugin_default,
+  register
+} from "./chunk-32DQKIYR.js";
+export {
+  createAirlockProgram,
+  plugin_default as default,
+  handleAuditCommand,
+  handleCheckCommand,
+  handleDeprecationsCommand,
+  handleDiffHerokuCommand,
+  handleDiffVercelCommand,
+  handleDoctorCommand,
+  handleExportDockerComposeCommand,
+  handleExportGithubActionsCommand,
+  handleExportK8sCommand,
+  handleGenerateCommand,
+  handleMigrateCommand,
+  handleMigrateMakeCommand,
+  handleMigrateRollbackCommand,
+  handleMigrateStatusCommand,
+  handlePullVercelCommand,
+  handlePushHerokuCommand,
+  handleReconcileCommand,
+  handleSchemaBuildCommand,
+  register
+};
+//# sourceMappingURL=plugin.js.map

package/dist/plugin.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}

package/package.json

@@ -0,0 +1,68 @@
+{
+  "name": "@wrkspace-co/env",
+  "version": "0.1.0",
+  "description": "Migration-first environment contract system for Node.js.",
+  "keywords": [
+    "env",
+    "environment",
+    "dotenv",
+    "schema",
+    "migrations",
+    "validation",
+    "typescript",
+    "airlock",
+    "wrkspace"
+  ],
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/wrkspace-co/env.git"
+  },
+  "homepage": "https://github.com/wrkspace-co/env#readme",
+  "bugs": {
+    "url": "https://github.com/wrkspace-co/env/issues"
+  },
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "bin": {
+    "airlock": "./dist/cli.js"
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    },
+    "./plugin": {
+      "types": "./dist/plugin.d.ts",
+      "default": "./dist/plugin.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "dependencies": {
+    "commander": "^13.1.0",
+    "typescript": "^5.7.3"
+  },
+  "scripts": {
+    "build": "tsup",
+    "test": "vitest run",
+    "docs:dev": "vitepress dev docs",
+    "docs:build": "vitepress build docs",
+    "docs:preview": "vitepress preview docs"
+  },
+  "wrkspacePlugin": {
+    "id": "env",
+    "displayName": "Airlock",
+    "description": "Airlock-grade environment safety and tooling",
+    "command": "env",
+    "entry": "./dist/plugin.js"
+  },
+  "devDependencies": {
+    "@types/node": "^22.13.10",
+    "tsup": "^8.3.5",
+    "vitepress": "^1.5.0",
+    "vitest": "^3.0.6"
+  }
+}