@mettlecast/domain-cli 0.2.6 → 0.2.8

package/dist/builder/build-registry.js

@@ -64,9 +64,14 @@ export async function buildRegistry(domainRoot) {
         Promise.all(paths.integrations.map(load)),
         paths.publishes ? load(paths.publishes) : Promise.resolve([]),
     ]);
+    const VALID_API_METHODS = new Set(['GET', 'POST', 'PUT', 'PATCH', 'DELETE', 'HEAD', 'OPTIONS']);
     const apis = paths.apis.flatMap((filePath, i) => (apiExports[i] ?? [])
         .filter(e => e['_kind'] === 'api')
         .map(e => {
+        const rawMethod = typeof e['method'] === 'string' ? e['method'].toUpperCase() : '';
+        if (!rawMethod || !VALID_API_METHODS.has(rawMethod)) {
+            warnings.push(`${relPath(filePath)}: defineApi "${e['id']}" has invalid or missing method "${rawMethod || '(none)'}". Use one of: ${[...VALID_API_METHODS].join(', ')}.`);
+        }
         const rawVersions = e['versions'];
         const versionSnapshots = rawVersions
             ? Object.entries(rawVersions).map(([ver, v]) => ({
@@ -81,7 +86,7 @@ export async function buildRegistry(domainRoot) {
             kind: 'api',
             handlerFile: relPath(filePath),
             path: String(e['path']),
-            method: typeof e['method'] === 'string' ? e['method'].toUpperCase() : 'ANY',
+            method: VALID_API_METHODS.has(rawMethod) ? rawMethod : 'GET',
             authType: e['auth']?.type ?? 'jwt',
             description: typeof e['description'] === 'string' ? e['description'] : undefined,
             deployment: deployment(e),

package/dist/builder/load-module.js

@@ -26,20 +26,23 @@ function makeEvalScript(absoluteFilePath) {
     // Convert to file:// URL so ESM loader works on all platforms (especially Windows).
     const fileUrl = pathToFileURL(absoluteFilePath).href;
     return `
-import { zodToJsonSchema } from 'zod-to-json-schema';
+import { z } from 'zod';
 import * as mod from ${JSON.stringify(fileUrl)};
 const KINDS = new Set(['api','webhook','subscriber','schedule','job','action','integration','event','domain']);
 function isZod(v) {
   return v && typeof v === 'object' && typeof v.parse === 'function' && typeof v.safeParse === 'function' && v._def !== undefined;
 }
+function toJsonSchema(v) {
+  try { return z.toJSONSchema(v); } catch { /* skip unserializable */ }
+}
 function strip(obj) {
   const out = {};
   for (const [k, v] of Object.entries(obj)) {
     if (typeof v === 'function') continue;
     if (isZod(v)) {
-      try { out[k] = zodToJsonSchema(v, { target: 'jsonSchema7' }); } catch { /* skip unserializable */ }
+      out[k] = toJsonSchema(v);
     } else if (Array.isArray(v)) {
-      out[k] = v.map(item => (item && typeof item === 'object' && !isZod(item) ? strip(item) : isZod(item) ? (() => { try { return zodToJsonSchema(item, { target: 'jsonSchema7' }); } catch { return undefined; } })() : item));
+      out[k] = v.map(item => (item && typeof item === 'object' && !isZod(item) ? strip(item) : isZod(item) ? toJsonSchema(item) : item));
     } else if (v && typeof v === 'object') {
       out[k] = strip(v);
     } else {

package/dist/commands/build-catalog.d.ts

@@ -42,6 +42,29 @@ export interface CatalogSubscriber {
     semverRange: string;
     description?: string;
 }
+/** A single job entry in the catalog. */
+export interface CatalogJob {
+    id: string;
+    domainId: string;
+    maxRetries: number;
+    visibilityTimeoutSeconds: number;
+    description?: string;
+}
+/** A single schedule entry in the catalog. */
+export interface CatalogSchedule {
+    id: string;
+    domainId: string;
+    cron: string;
+    enabled: boolean;
+    description?: string;
+}
+/** A single integration entry in the catalog. */
+export interface CatalogIntegration {
+    id: string;
+    domainId: string;
+    baseUrl: string;
+    description?: string;
+}
 /** A single domain entry in the catalog. */
 export interface CatalogDomain {
     id: string;
@@ -58,6 +81,9 @@ export interface DomainCatalog {
     actions: CatalogAction[];
     events: CatalogEvent[];
     subscribers: CatalogSubscriber[];
+    jobs: CatalogJob[];
+    schedules: CatalogSchedule[];
+    integrations: CatalogIntegration[];
 }
 /**
  * Build the combined domain catalog from all per-domain registry files.

package/dist/commands/build-catalog.js

@@ -1,4 +1,4 @@
-import { readFile, writeFile, readdir } from 'node:fs/promises';
+import { readFile, writeFile, readdir, mkdir } from 'node:fs/promises';
 import { join, resolve } from 'node:path';
 import { cliLogger } from '../utils/logger.js';
 /**
@@ -29,6 +29,9 @@ export async function runBuildCatalog(tibDir) {
         actions: [],
         events: [],
         subscribers: [],
+        jobs: [],
+        schedules: [],
+        integrations: [],
     };
     for (const file of registryFiles) {
         const raw = await readFile(join(dir, file), 'utf8');
@@ -97,9 +100,40 @@ export async function runBuildCatalog(tibDir) {
                 description: sub['description'],
             });
         }
+        const jobs = registry['jobs'] ?? [];
+        for (const job of jobs) {
+            catalog.jobs.push({
+                id: String(job['id']),
+                domainId,
+                maxRetries: Number(job['maxRetries'] ?? 3),
+                visibilityTimeoutSeconds: Number(job['visibilityTimeoutSeconds'] ?? 300),
+                description: job['description'],
+            });
+        }
+        const schedules = registry['schedules'] ?? [];
+        for (const schedule of schedules) {
+            catalog.schedules.push({
+                id: String(schedule['id']),
+                domainId,
+                cron: String(schedule['cron'] ?? ''),
+                enabled: Boolean(schedule['enabled'] ?? true),
+                description: schedule['description'],
+            });
+        }
+        const integrations = registry['integrations'] ?? [];
+        for (const integration of integrations) {
+            catalog.integrations.push({
+                id: String(integration['id']),
+                domainId,
+                baseUrl: String(integration['baseUrl'] ?? ''),
+                description: integration['description'],
+            });
+        }
     }
-    const outPath = join(dir, 'domain-registry.json');
+    const mcDir = join(process.cwd(), '.mc');
+    await mkdir(mcDir, { recursive: true });
+    const outPath = join(mcDir, 'domain-registry.json');
     await writeFile(outPath, JSON.stringify(catalog, null, 2), 'utf8');
-    cliLogger.info({ outPath, domains: catalog.domains.length, apis: catalog.apis.length, actions: catalog.actions.length, events: catalog.events.length }, 'Domain catalog written');
+    cliLogger.info({ outPath, domains: catalog.domains.length, apis: catalog.apis.length, actions: catalog.actions.length, events: catalog.events.length, jobs: catalog.jobs.length, schedules: catalog.schedules.length, integrations: catalog.integrations.length }, 'Domain catalog written');
     return catalog;
 }

package/dist/commands/build.js

@@ -1,5 +1,5 @@
 import { writeFile, mkdir, readdir, readFile } from 'node:fs/promises';
-import { join, resolve } from 'node:path';
+import { join, resolve, basename } from 'node:path';
 import { buildRegistry } from '../builder/build-registry.js';
 import { buildActionsTypes } from '../builder/build-types.js';
 import { cliLogger } from '../utils/logger.js';
@@ -12,9 +12,10 @@ import { cliLogger } from '../utils/logger.js';
  */
 export async function runBuild(options) {
     const domainRoot = resolve(options.domainRoot);
+    const domainId = basename(domainRoot);
     const outFile = options.outFile
         ? resolve(options.outFile)
-        : join(process.cwd(), '.tib', 'domain-registry.json');
+        : join(process.cwd(), '.tib', `${domainId}-registry.json`);
     cliLogger.info({ domainRoot }, 'Building domain registry');
     const { registry, warnings } = await buildRegistry(domainRoot);
     for (const w of warnings) {

package/dist/commands/validate.js

@@ -117,9 +117,48 @@ export async function runValidate(domainRoot, exitOnFailure = true, config = { m
         }
     }));
     errors.push(...checkSubscriberSemverRanges(registry.subscribers));
+    const VALID_METHODS = new Set(['GET', 'POST', 'PUT', 'PATCH', 'DELETE', 'HEAD', 'OPTIONS']);
     for (const api of registry.apis) {
         const entry = api;
         errors.push(...checkLifecycleConsistency(entry, `api '${api.id}'`));
+        if (!api.requestSchema) {
+            errors.push({
+                code: 'MISSING_API_REQUEST_SCHEMA',
+                message: `API '${api.id}' (${api.method} ${api.path}) has no request schema. Define input/output in defineApi versions.`,
+            });
+        }
+        if (!api.responseSchema) {
+            errors.push({
+                code: 'MISSING_API_RESPONSE_SCHEMA',
+                message: `API '${api.id}' (${api.method} ${api.path}) has no response schema. Define input/output in defineApi versions.`,
+            });
+        }
+        if (!VALID_METHODS.has(api.method)) {
+            errors.push({
+                code: 'INVALID_API_METHOD',
+                message: `API '${api.id}' (${api.method} ${api.path}) has invalid method "${api.method}". Use one of: ${[...VALID_METHODS].join(', ')}.`,
+            });
+        }
+        function hasExampleOrDefault(schema) {
+            if (!schema)
+                return false;
+            if (schema['default'] !== undefined)
+                return true;
+            const examples = schema['examples'] ?? schema['example'];
+            return Array.isArray(examples) && examples.length > 0;
+        }
+        if (api.requestSchema && !hasExampleOrDefault(api.requestSchema)) {
+            errors.push({
+                code: 'MISSING_API_REQUEST_EXAMPLE',
+                message: `API '${api.id}' (${api.method} ${api.path}) request schema has no example data. Add .default({...}) to your Zod schema.`,
+            });
+        }
+        if (api.responseSchema && !hasExampleOrDefault(api.responseSchema)) {
+            errors.push({
+                code: 'MISSING_API_RESPONSE_EXAMPLE',
+                message: `API '${api.id}' (${api.method} ${api.path}) response schema has no example data. Add .default({...}) to your Zod schema.`,
+            });
+        }
     }
     const rawPathErrors = await checkRawPathViolations(registry.domainRoot, config);
     errors.push(...rawPathErrors);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mettlecast/domain-cli",
-  "version": "0.2.6",
+  "version": "0.2.8",
   "type": "module",
   "publishConfig": {
     "registry": "https://registry.npmjs.org",
@@ -21,21 +21,21 @@
   "dependencies": {
     "@aws-sdk/client-s3": "^3.0.0",
     "@aws-sdk/client-sfn": "^3.0.0",
-    "@mettlecast/domain-runtime": "*",
     "@mettlecast/domain-cdk-packer": "*",
+    "@mettlecast/domain-runtime": "*",
     "commander": "^12.0.0",
+    "dotenv": "^16.0.0",
     "fastify": "^5.0.0",
-    "tar": "^7.0.0",
-    "tsx": "^4.0.0",
-    "zod-to-json-schema": "^3.0.0",
     "pino": "^9.0.0",
     "pino-pretty": "^11.0.0",
-    "dotenv": "^16.0.0",
-    "semver": "^7.0.0"
+    "semver": "^7.0.0",
+    "tar": "^7.0.0",
+    "tsx": "^4.0.0",
+    "zod-to-json-schema": "^3.0.0"
   },
   "devDependencies": {
     "@types/node": "^20.0.0",
-    "@types/semver": "^7.0.0",
+    "@types/semver": "^7.7.1",
     "@types/tar": "^6.0.0",
     "typescript": "^5.0.0",
     "vitest": "^2.0.0"

package/src/builder/build-registry.ts

@@ -99,10 +99,16 @@ export async function buildRegistry(domainRoot: string): Promise<BuildResult> {
     paths.publishes ? load(paths.publishes) : Promise.resolve([]),
   ]);
 
+  const VALID_API_METHODS = new Set(['GET', 'POST', 'PUT', 'PATCH', 'DELETE', 'HEAD', 'OPTIONS']);
+
   const apis: ApiRegistryEntry[] = paths.apis.flatMap((filePath, i) =>
     (apiExports[i] ?? [])
       .filter(e => e['_kind'] === 'api')
       .map(e => {
+        const rawMethod = typeof e['method'] === 'string' ? e['method'].toUpperCase() : '';
+        if (!rawMethod || !VALID_API_METHODS.has(rawMethod)) {
+          warnings.push(`${relPath(filePath)}: defineApi "${e['id']}" has invalid or missing method "${rawMethod || '(none)'}". Use one of: ${[...VALID_API_METHODS].join(', ')}.`);
+        }
         const rawVersions = e['versions'] as Record<string, { input?: unknown; output?: unknown }> | undefined;
         const versionSnapshots: ApiVersionSnapshot[] = rawVersions
           ? Object.entries(rawVersions).map(([ver, v]) => ({
@@ -117,7 +123,7 @@ export async function buildRegistry(domainRoot: string): Promise<BuildResult> {
           kind: 'api' as const,
           handlerFile: relPath(filePath),
           path: String(e['path']),
-          method: typeof e['method'] === 'string' ? e['method'].toUpperCase() : 'ANY',
+          method: VALID_API_METHODS.has(rawMethod) ? rawMethod : 'GET',
           authType: ((e['auth'] as { type?: string } | undefined)?.type as 'jwt' | 'api-key' | 'none' | undefined) ?? 'jwt',
           description: typeof e['description'] === 'string' ? e['description'] : undefined,
           deployment: deployment(e),

package/src/builder/load-module.ts

@@ -43,20 +43,23 @@ function makeEvalScript(absoluteFilePath: string): string {
   // Convert to file:// URL so ESM loader works on all platforms (especially Windows).
   const fileUrl = pathToFileURL(absoluteFilePath).href;
   return `
-import { zodToJsonSchema } from 'zod-to-json-schema';
+import { z } from 'zod';
 import * as mod from ${JSON.stringify(fileUrl)};
 const KINDS = new Set(['api','webhook','subscriber','schedule','job','action','integration','event','domain']);
 function isZod(v) {
   return v && typeof v === 'object' && typeof v.parse === 'function' && typeof v.safeParse === 'function' && v._def !== undefined;
 }
+function toJsonSchema(v) {
+  try { return z.toJSONSchema(v); } catch { /* skip unserializable */ }
+}
 function strip(obj) {
   const out = {};
   for (const [k, v] of Object.entries(obj)) {
     if (typeof v === 'function') continue;
     if (isZod(v)) {
-      try { out[k] = zodToJsonSchema(v, { target: 'jsonSchema7' }); } catch { /* skip unserializable */ }
+      out[k] = toJsonSchema(v);
     } else if (Array.isArray(v)) {
-      out[k] = v.map(item => (item && typeof item === 'object' && !isZod(item) ? strip(item) : isZod(item) ? (() => { try { return zodToJsonSchema(item, { target: 'jsonSchema7' }); } catch { return undefined; } })() : item));
+      out[k] = v.map(item => (item && typeof item === 'object' && !isZod(item) ? strip(item) : isZod(item) ? toJsonSchema(item) : item));
     } else if (v && typeof v === 'object') {
       out[k] = strip(v);
     } else {

package/src/commands/build-catalog.ts

@@ -1,4 +1,4 @@
-import { readFile, writeFile, readdir } from 'node:fs/promises';
+import { readFile, writeFile, readdir, mkdir } from 'node:fs/promises';
 import { join, resolve } from 'node:path';
 import { cliLogger } from '../utils/logger.js';
 
@@ -43,6 +43,32 @@ export interface CatalogSubscriber {
   description?: string;
 }
 
+/** A single job entry in the catalog. */
+export interface CatalogJob {
+  id: string;
+  domainId: string;
+  maxRetries: number;
+  visibilityTimeoutSeconds: number;
+  description?: string;
+}
+
+/** A single schedule entry in the catalog. */
+export interface CatalogSchedule {
+  id: string;
+  domainId: string;
+  cron: string;
+  enabled: boolean;
+  description?: string;
+}
+
+/** A single integration entry in the catalog. */
+export interface CatalogIntegration {
+  id: string;
+  domainId: string;
+  baseUrl: string;
+  description?: string;
+}
+
 /** A single domain entry in the catalog. */
 export interface CatalogDomain {
   id: string;
@@ -60,6 +86,9 @@ export interface DomainCatalog {
   actions: CatalogAction[];
   events: CatalogEvent[];
   subscribers: CatalogSubscriber[];
+  jobs: CatalogJob[];
+  schedules: CatalogSchedule[];
+  integrations: CatalogIntegration[];
 }
 
 /**
@@ -92,6 +121,9 @@ export async function runBuildCatalog(tibDir?: string): Promise<DomainCatalog> {
     actions: [],
     events: [],
     subscribers: [],
+    jobs: [],
+    schedules: [],
+    integrations: [],
   };
 
   for (const file of registryFiles) {
@@ -167,13 +199,47 @@ export async function runBuildCatalog(tibDir?: string): Promise<DomainCatalog> {
         description: sub['description'] as string | undefined,
       });
     }
+
+    const jobs = (registry['jobs'] as Record<string, unknown>[] | undefined) ?? [];
+    for (const job of jobs) {
+      catalog.jobs.push({
+        id: String(job['id']),
+        domainId,
+        maxRetries: Number(job['maxRetries'] ?? 3),
+        visibilityTimeoutSeconds: Number(job['visibilityTimeoutSeconds'] ?? 300),
+        description: job['description'] as string | undefined,
+      });
+    }
+
+    const schedules = (registry['schedules'] as Record<string, unknown>[] | undefined) ?? [];
+    for (const schedule of schedules) {
+      catalog.schedules.push({
+        id: String(schedule['id']),
+        domainId,
+        cron: String(schedule['cron'] ?? ''),
+        enabled: Boolean(schedule['enabled'] ?? true),
+        description: schedule['description'] as string | undefined,
+      });
+    }
+
+    const integrations = (registry['integrations'] as Record<string, unknown>[] | undefined) ?? [];
+    for (const integration of integrations) {
+      catalog.integrations.push({
+        id: String(integration['id']),
+        domainId,
+        baseUrl: String(integration['baseUrl'] ?? ''),
+        description: integration['description'] as string | undefined,
+      });
+    }
   }
 
-  const outPath = join(dir, 'domain-registry.json');
+  const mcDir = join(process.cwd(), '.mc');
+  await mkdir(mcDir, { recursive: true });
+  const outPath = join(mcDir, 'domain-registry.json');
   await writeFile(outPath, JSON.stringify(catalog, null, 2), 'utf8');
 
   cliLogger.info(
-    { outPath, domains: catalog.domains.length, apis: catalog.apis.length, actions: catalog.actions.length, events: catalog.events.length },
+    { outPath, domains: catalog.domains.length, apis: catalog.apis.length, actions: catalog.actions.length, events: catalog.events.length, jobs: catalog.jobs.length, schedules: catalog.schedules.length, integrations: catalog.integrations.length },
     'Domain catalog written'
   );
 

package/src/commands/build.ts

@@ -1,5 +1,5 @@
 import { writeFile, mkdir, readdir, readFile } from 'node:fs/promises';
-import { join, resolve } from 'node:path';
+import { join, resolve, basename } from 'node:path';
 import type { DomainRegistry } from '@mettlecast/domain-cdk-packer';
 import { buildRegistry } from '../builder/build-registry.js';
 import { buildActionsTypes } from '../builder/build-types.js';
@@ -24,9 +24,10 @@ export interface BuildOptions {
  */
 export async function runBuild(options: BuildOptions): Promise<string> {
   const domainRoot = resolve(options.domainRoot);
+  const domainId = basename(domainRoot);
   const outFile = options.outFile
     ? resolve(options.outFile)
-    : join(process.cwd(), '.tib', 'domain-registry.json');
+    : join(process.cwd(), '.tib', `${domainId}-registry.json`);
 
   cliLogger.info({ domainRoot }, 'Building domain registry');
 

package/src/commands/validate.ts

@@ -173,9 +173,46 @@ export async function runValidate(
 
   errors.push(...checkSubscriberSemverRanges(registry.subscribers));
 
+  const VALID_METHODS = new Set(['GET', 'POST', 'PUT', 'PATCH', 'DELETE', 'HEAD', 'OPTIONS']);
   for (const api of registry.apis) {
     const entry = api as unknown as { deprecatedAt?: string; sunsetAt?: string };
     errors.push(...checkLifecycleConsistency(entry, `api '${api.id}'`));
+    if (!api.requestSchema) {
+      errors.push({
+        code: 'MISSING_API_REQUEST_SCHEMA',
+        message: `API '${api.id}' (${api.method} ${api.path}) has no request schema. Define input/output in defineApi versions.`,
+      });
+    }
+    if (!api.responseSchema) {
+      errors.push({
+        code: 'MISSING_API_RESPONSE_SCHEMA',
+        message: `API '${api.id}' (${api.method} ${api.path}) has no response schema. Define input/output in defineApi versions.`,
+      });
+    }
+    if (!VALID_METHODS.has(api.method)) {
+      errors.push({
+        code: 'INVALID_API_METHOD',
+        message: `API '${api.id}' (${api.method} ${api.path}) has invalid method "${api.method}". Use one of: ${[...VALID_METHODS].join(', ')}.`,
+      });
+    }
+    function hasExampleOrDefault(schema: Record<string, unknown> | undefined): boolean {
+      if (!schema) return false;
+      if (schema['default'] !== undefined) return true;
+      const examples = schema['examples'] ?? schema['example'];
+      return Array.isArray(examples) && examples.length > 0;
+    }
+    if (api.requestSchema && !hasExampleOrDefault(api.requestSchema)) {
+      errors.push({
+        code: 'MISSING_API_REQUEST_EXAMPLE',
+        message: `API '${api.id}' (${api.method} ${api.path}) request schema has no example data. Add .default({...}) to your Zod schema.`,
+      });
+    }
+    if (api.responseSchema && !hasExampleOrDefault(api.responseSchema)) {
+      errors.push({
+        code: 'MISSING_API_RESPONSE_EXAMPLE',
+        message: `API '${api.id}' (${api.method} ${api.path}) response schema has no example data. Add .default({...}) to your Zod schema.`,
+      });
+    }
   }
 
   const rawPathErrors = await checkRawPathViolations(registry.domainRoot, config);