@zmdb/cli 1.0.0-beta.1

package/dist/templates/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/templates/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,OAAO,CAAC;AAE1C,eAAO,MAAM,cAAc,EAAE,YAe5B,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG,SAAS,GAAG,YAAY,GAAG,QAAQ,GAAG,SAAS,GAAG,YAAY,GAAG,QAAQ,CAAC;AAErG,MAAM,WAAW,YAAY;IAC3B,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,WAAW,eAAe;IAC9B,QAAQ,CAAC,IAAI,EAAE,YAAY,CAAC;IAC5B,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAC;CACjC;AAED,MAAM,WAAW,YAAY;IAC3B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,YAAY;IAC3B,QAAQ,CAAC,KAAK,EAAE,SAAS,YAAY,EAAE,CAAC;IACxC,QAAQ,CAAC,YAAY,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;CAC3C;AAED,MAAM,MAAM,eAAe,GAAG,CAAC,OAAO,EAAE,eAAe,KAAK,YAAY,CAAC"}

package/dist/templates/types.js

@@ -0,0 +1,17 @@
+export const FORMAT_OPTIONS = {
+    arrowParens: 'avoid',
+    bracketSpacing: true,
+    endOfLine: 'lf',
+    insertFinalNewline: true,
+    objectWrap: 'preserve',
+    printWidth: 120,
+    quoteProps: 'as-needed',
+    semi: true,
+    singleQuote: true,
+    sortImports: true,
+    sortPackageJson: true,
+    tabWidth: 2,
+    trailingComma: 'all',
+    useTabs: false,
+};
+//# sourceMappingURL=types.js.map

package/dist/templates/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/templates/types.ts"],"names":[],"mappings":"AAEA,MAAM,CAAC,MAAM,cAAc,GAAiB;IAC1C,WAAW,EAAE,OAAO;IACpB,cAAc,EAAE,IAAI;IACpB,SAAS,EAAE,IAAI;IACf,kBAAkB,EAAE,IAAI;IACxB,UAAU,EAAE,UAAU;IACtB,UAAU,EAAE,GAAG;IACf,UAAU,EAAE,WAAW;IACvB,IAAI,EAAE,IAAI;IACV,WAAW,EAAE,IAAI;IACjB,WAAW,EAAE,IAAI;IACjB,eAAe,EAAE,IAAI;IACrB,QAAQ,EAAE,CAAC;IACX,aAAa,EAAE,KAAK;IACpB,OAAO,EAAE,KAAK;CACf,CAAC"}

package/package.json

@@ -0,0 +1,72 @@
+{
+  "name": "@zmdb/cli",
+  "version": "1.0.0-beta.1",
+  "description": "The zmdb executable and developer command APIs for schema, application and HTTP workflows.",
+  "keywords": [
+    "cli",
+    "migrations",
+    "sql",
+    "typescript",
+    "zmdb"
+  ],
+  "homepage": "https://github.com/ambasta/zmdb#readme",
+  "bugs": {
+    "url": "https://github.com/ambasta/zmdb/issues"
+  },
+  "license": "GPL-3.0-or-later",
+  "author": "zmdb contributors",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/ambasta/zmdb.git",
+    "directory": "packages/cli"
+  },
+  "bin": {
+    "zmdb": "./dist/bin.js"
+  },
+  "type": "module",
+  "sideEffects": false,
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "publishConfig": {
+    "access": "public",
+    "tag": "beta"
+  },
+  "scripts": {
+    "build": "node ../../scripts/build-package.mjs",
+    "test": "vitest run"
+  },
+  "dependencies": {
+    "@zmdb/compiler": "1.0.0-beta.1",
+    "@zmdb/migrations": "1.0.0-beta.1",
+    "oxfmt": "0.66.0"
+  },
+  "peerDependencies": {
+    "@zmdb/app": "1.0.0-beta.1",
+    "@zmdb/orm": "1.0.0-beta.1",
+    "@zmdb/schema": "1.0.0-beta.1",
+    "@zmdb/sql": "1.0.0-beta.1",
+    "@zmdb/web": "1.0.0-beta.1",
+    "esbuild": ">=0.28.2 <0.29.0",
+    "typescript": ">=7.0.2 <8.0.0"
+  },
+  "peerDependenciesMeta": {
+    "@zmdb/app": {
+      "optional": true
+    },
+    "@zmdb/web": {
+      "optional": true
+    },
+    "esbuild": {
+      "optional": true
+    }
+  },
+  "engines": {
+    "node": ">=26"
+  },
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts"
+}

package/src/__fixtures__/http-client/package.json

@@ -0,0 +1,5 @@
+{
+  "name": "zmdb-http-client-cli-fixture",
+  "private": true,
+  "type": "module"
+}

package/src/__fixtures__/http-client/src/contract.ts

@@ -0,0 +1,85 @@
+import { defineHttpContract, httpOperation } from '@zmdb/web/contract';
+import { Controller, Get, Public } from '@zmdb/web/routing';
+
+import type { AcceptedAccount, Account, Health } from './models.js';
+
+const previousLoads: unknown = Reflect.get(globalThis, '__zmdbHttpContractFixtureLoads');
+Reflect.set(globalThis, '__zmdbHttpContractFixtureLoads', typeof previousLoads === 'number' ? previousLoads + 1 : 1);
+
+interface GetAccountOperation {
+  readonly path: { readonly accountId: string };
+  readonly responses: {
+    readonly 200: { readonly body: Account };
+    readonly 202: { readonly body: AcceptedAccount };
+  };
+}
+
+interface HealthOperation {
+  readonly responses: {
+    readonly 200: { readonly body: Health };
+  };
+}
+
+@Controller('/accounts')
+export class AccountsController {
+  @Get('/:accountId')
+  getAccount() {
+    return { id: 'account-1', displayName: 'Account 1' };
+  }
+
+  @Public()
+  @Get('/health')
+  health() {
+    return { ok: true };
+  }
+}
+
+export const HTTP_CONTRACT = defineHttpContract({
+  securitySchemes: {
+    bearerAuth: { type: 'http', scheme: 'bearer' },
+  },
+  operations: {
+    get_accounts_accountId: httpOperation<GetAccountOperation>({
+      controller: AccountsController,
+      handler: 'getAccount',
+      method: 'GET',
+      path: '/accounts/:accountId',
+      parameters: [{ in: 'path', property: 'accountId', name: 'accountId' }],
+      responses: {
+        200: {
+          description: 'Found',
+          body: { kind: 'json', mediaType: 'application/json' },
+        },
+        202: {
+          description: 'Accepted',
+          body: { kind: 'json', mediaType: 'application/json' },
+        },
+      },
+      security: [{ bearerAuth: [] }],
+      version: { kind: 'none' },
+      deprecated: false,
+    }),
+  },
+});
+
+export const HEALTH_CONTRACT = defineHttpContract({
+  securitySchemes: {},
+  operations: {
+    get_accounts_health: httpOperation<HealthOperation>({
+      controller: AccountsController,
+      handler: 'health',
+      method: 'GET',
+      path: '/accounts/health',
+      parameters: [],
+      responses: {
+        200: {
+          description: 'Healthy',
+          body: { kind: 'json', mediaType: 'application/json' },
+        },
+      },
+      security: [],
+      version: { kind: 'none' },
+      deprecated: false,
+    }),
+  },
+});

package/src/__fixtures__/http-client/src/models.ts

@@ -0,0 +1,12 @@
+export interface Account {
+  readonly id: string;
+  readonly displayName: string;
+}
+
+export interface AcceptedAccount {
+  readonly jobId: string;
+}
+
+export interface Health {
+  readonly ok: boolean;
+}

package/src/__fixtures__/http-client/src/schema.ts

@@ -0,0 +1,3 @@
+export interface FixtureSchema {
+  readonly id: number;
+}

package/src/__fixtures__/http-client/src/unrelated.ts

@@ -0,0 +1 @@
+export const unrelated = 'not part of the HTTP contract dependency set';

package/src/__fixtures__/http-client/tsconfig.json

@@ -0,0 +1,17 @@
+{
+  "compilerOptions": {
+    "allowImportingTsExtensions": false,
+    "exactOptionalPropertyTypes": true,
+    "isolatedModules": true,
+    "lib": ["ESNext", "DOM"],
+    "module": "NodeNext",
+    "moduleResolution": "NodeNext",
+    "noEmit": true,
+    "skipLibCheck": true,
+    "strict": true,
+    "target": "ESNext",
+    "types": [],
+    "verbatimModuleSyntax": true
+  },
+  "include": ["src/**/*.ts"]
+}

package/src/__fixtures__/http-client/zmdb.config.ts

@@ -0,0 +1,12 @@
+import { sqlite } from '@zmdb/sqlite';
+
+export default {
+  schema: './src/schema.ts',
+  dialect: sqlite,
+  project: './tsconfig.json',
+  http: {
+    contracts: './src/contract.ts#HTTP_CONTRACT',
+    openApi: { out: './generated/openapi.json' },
+    client: { out: './generated/http-client.generated.ts' },
+  },
+};

package/src/__fixtures__/project/package.json

@@ -0,0 +1,5 @@
+{
+  "name": "zmdb-cli-e2e-fixture",
+  "private": true,
+  "type": "module"
+}

package/src/__fixtures__/project/src/schema.ts

@@ -0,0 +1,6 @@
+import type { PrimaryKey, Serial, Sql, Table } from 'zmdb/tags';
+
+export interface User extends Table<'users'> {
+  id: number & Sql<'integer'> & Serial & PrimaryKey;
+  email: string & Sql<'text'>;
+}

package/src/__fixtures__/project/tsconfig.json

@@ -0,0 +1,24 @@
+{
+  "compilerOptions": {
+    "allowImportingTsExtensions": false,
+    "exactOptionalPropertyTypes": true,
+    "isolatedModules": true,
+    "lib": ["ESNext"],
+    "module": "NodeNext",
+    "moduleResolution": "NodeNext",
+    "noEmit": true,
+    "paths": {
+      "@zmdb/sql": ["__ROOT__/packages/sql/src/index.ts"],
+      "@zmdb/sql/*": ["__ROOT__/packages/sql/src/*/index.ts"],
+      "@zmdb/schema": ["__ROOT__/packages/schema/src/index.ts"],
+      "@zmdb/schema/*": ["__ROOT__/packages/schema/src/*/index.ts"],
+      "zmdb/tags": ["__ROOT__/packages/zmdb/src/tags.ts"]
+    },
+    "skipLibCheck": true,
+    "strict": true,
+    "target": "ESNext",
+    "types": [],
+    "verbatimModuleSyntax": true
+  },
+  "include": ["src/**/*.ts"]
+}

package/src/__fixtures__/project/zmdb.config.ts

@@ -0,0 +1,57 @@
+import { DatabaseSync, type SQLInputValue } from 'node:sqlite';
+
+import { sqlite } from '@zmdb/sqlite';
+
+const databasePath = process.env.ZMDB_TEST_DATABASE;
+if (databasePath === undefined) throw new Error('ZMDB_TEST_DATABASE is required');
+
+function sqliteValue(value: unknown): SQLInputValue {
+  if (
+    value === null ||
+    typeof value === 'number' ||
+    typeof value === 'bigint' ||
+    typeof value === 'string' ||
+    value instanceof Uint8Array
+  ) {
+    return value;
+  }
+  if (value instanceof Date) return value.toISOString();
+  throw new TypeError(`cannot bind ${typeof value} to sqlite`);
+}
+
+export default {
+  schema: 'src/**/*.ts',
+  dialect: sqlite,
+  project: './tsconfig.json',
+  out: './migrations',
+  driver: () => {
+    const database = new DatabaseSync(databasePath);
+    const driver = {
+      dialect: sqlite,
+      async execute(query: { readonly text: string; readonly parameters: readonly unknown[] }) {
+        const read = /^\s*(?:PRAGMA|SELECT|WITH)\b/i.test(query.text) || /\bRETURNING\b/i.test(query.text);
+        const parameters = query.parameters.map(sqliteValue);
+        if (!read && query.parameters.length === 0) {
+          database.exec(query.text);
+          return [];
+        }
+        const statement = database.prepare(query.text);
+        return read ? statement.all(...parameters) : (statement.run(...parameters), []);
+      },
+    };
+    return {
+      ...driver,
+      async transaction<Result>(run: (transaction: typeof driver) => Promise<Result>): Promise<Result> {
+        database.exec('BEGIN');
+        try {
+          const result = await run(driver);
+          database.exec('COMMIT');
+          return result;
+        } catch (error) {
+          database.exec('ROLLBACK');
+          throw error;
+        }
+      },
+    };
+  },
+};

package/src/application-loader.ts

@@ -0,0 +1,108 @@
+import { existsSync, readFileSync } from 'node:fs';
+import { registerHooks } from 'node:module';
+import { resolve } from 'node:path';
+import { fileURLToPath, pathToFileURL } from 'node:url';
+
+import type { ModuleClass } from '@zmdb/app/modules';
+
+import { CliInvocationError } from './errors.js';
+
+let applicationLoader: Promise<void> | undefined;
+
+export function requireOptionalPeer(name: '@zmdb/app' | '@zmdb/web' | 'esbuild'): void {
+  try {
+    import.meta.resolve(name);
+  } catch (error) {
+    if (error instanceof Error && 'code' in error && error.code === 'ERR_MODULE_NOT_FOUND') {
+      throw new CliInvocationError(`this command requires ${name}; install ${name}`);
+    }
+    throw error;
+  }
+}
+
+export async function loadRootModule(moduleSpec: string, cwd: string): Promise<ModuleClass> {
+  const hash = moduleSpec.lastIndexOf('#');
+  if (hash <= 0 || hash === moduleSpec.length - 1) {
+    throw new CliInvocationError(`module spec "${moduleSpec}" must be <path>#<export>`);
+  }
+  const namedPath = moduleSpec.slice(0, hash);
+  const exportName = moduleSpec.slice(hash + 1);
+  const file = resolve(cwd, namedPath);
+  if (!existsSync(file)) {
+    throw new CliInvocationError(`module path "${namedPath}" does not exist; cannot load export "${exportName}"`);
+  }
+
+  requireOptionalPeer('esbuild');
+  await installApplicationLoader();
+  let loaded: object;
+  try {
+    const candidate: unknown = await import(pathToFileURL(file).href);
+    if (typeof candidate !== 'object' || candidate === null) {
+      throw new Error(`module path "${namedPath}" did not load as a module record`);
+    }
+    loaded = candidate;
+  } catch (error) {
+    throw new Error(`could not import module path "${namedPath}" for export "${exportName}": ${errorMessage(error)}`, {
+      cause: error,
+    });
+  }
+  const root: unknown = Reflect.get(loaded, exportName);
+  if (!isModuleClass(root)) {
+    throw new CliInvocationError(`module path "${namedPath}" has no class export "${exportName}"`);
+  }
+  return root;
+}
+
+/**
+ * Lower Stage-3 decorators while importing application TypeScript.
+ *
+ * Node 26 strips types but does not parse standard decorator syntax. The hook
+ * applies the same esbuild transform used by the repository's Vitest setup, and
+ * only after the CLI command asks to import application source.
+ */
+async function installApplicationLoader(): Promise<void> {
+  applicationLoader ??= import('esbuild').then(({ transformSync }) => {
+    registerHooks({
+      resolve(specifier, context, nextResolve) {
+        if (context.parentURL !== undefined && /^\.{1,2}\/.*\.js$/.test(specifier)) {
+          const asJavaScript = new URL(specifier, context.parentURL);
+          if (!existsSync(fileURLToPath(asJavaScript))) {
+            const asTypeScript = new URL(`${specifier.slice(0, -'.js'.length)}.ts`, context.parentURL);
+            if (existsSync(fileURLToPath(asTypeScript))) {
+              return { url: asTypeScript.href, shortCircuit: true };
+            }
+          }
+        }
+        return nextResolve(specifier, context);
+      },
+      load(url, context, nextLoad) {
+        if (!url.startsWith('file:') || !/\.[cm]?tsx?$/.test(new URL(url).pathname)) {
+          return nextLoad(url, context);
+        }
+        const file = fileURLToPath(url);
+        const transformed = transformSync(readFileSync(file, 'utf8'), {
+          loader: file.endsWith('.tsx') ? 'tsx' : 'ts',
+          format: 'esm',
+          target: 'es2022',
+          sourcefile: file,
+          sourcemap: 'inline',
+          tsconfigRaw: {
+            compilerOptions: {
+              experimentalDecorators: false,
+              useDefineForClassFields: true,
+            },
+          },
+        });
+        return { format: 'module', source: transformed.code, shortCircuit: true };
+      },
+    });
+  });
+  await applicationLoader;
+}
+
+function errorMessage(error: unknown): string {
+  return error instanceof Error ? error.message : String(error);
+}
+function isModuleClass(value: unknown): value is ModuleClass {
+  return typeof value === 'function';
+}