@mettlecast/domain-cli 0.2.11 → 0.2.12

package/dist/builder/build-registry.js

@@ -93,6 +93,7 @@ export async function buildRegistry(domainRoot) {
             requestSchema: latestVersion?.requestSchema,
             responseSchema: latestVersion?.responseSchema,
             versions: versionSnapshots.length > 0 ? versionSnapshots : undefined,
+            examples: e['examples'],
         };
     }));
     const webhooks = paths.webhooks.flatMap((filePath, i) => (webhookExports[i] ?? [])

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

@@ -13,6 +13,10 @@ export interface CatalogApi {
         requestSchema?: Record<string, unknown>;
         responseSchema?: Record<string, unknown>;
     }>;
+    examples?: {
+        request?: Record<string, unknown>;
+        response?: Record<string, unknown>;
+    };
 }
 /** A single action entry in the catalog. */
 export interface CatalogAction {

package/dist/commands/build-catalog.js

@@ -67,6 +67,7 @@ export async function runBuildCatalog(tibDir) {
                 requestSchema: api['requestSchema'],
                 responseSchema: api['responseSchema'],
                 versions: api['versions'],
+                examples: api['examples'],
             });
         }
         const actions = registry['actions'] ?? [];

package/dist/commands/validate.js

@@ -139,19 +139,17 @@ export async function runValidate(domainRoot, exitOnFailure = true, config = { m
                 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)) {
-            warnings.push(`API '${api.id}' (${api.method} ${api.path}) request schema has no example data. Add .default({...}) to your Zod schema.`);
+        if (!api.examples?.request) {
+            errors.push({
+                code: 'MISSING_API_REQUEST_EXAMPLE',
+                message: `API '${api.id}' (${api.method} ${api.path}) has no request example. Add examples: { request: {...}, response: {...} } to the defineApi config.`,
+            });
         }
-        if (api.responseSchema && !hasExampleOrDefault(api.responseSchema)) {
-            warnings.push(`API '${api.id}' (${api.method} ${api.path}) response schema has no example data. Add .default({...}) to your Zod schema.`);
+        if (!api.examples?.response) {
+            errors.push({
+                code: 'MISSING_API_RESPONSE_EXAMPLE',
+                message: `API '${api.id}' (${api.method} ${api.path}) has no response example. Add examples: { request: {...}, response: {...} } to the defineApi config.`,
+            });
         }
     }
     const rawPathErrors = await checkRawPathViolations(registry.domainRoot, config);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mettlecast/domain-cli",
-  "version": "0.2.11",
+  "version": "0.2.12",
   "type": "module",
   "publishConfig": {
     "registry": "https://registry.npmjs.org",

package/src/builder/build-registry.ts

@@ -130,6 +130,7 @@ export async function buildRegistry(domainRoot: string): Promise<BuildResult> {
           requestSchema: latestVersion?.requestSchema,
           responseSchema: latestVersion?.responseSchema,
           versions: versionSnapshots.length > 0 ? versionSnapshots : undefined,
+          examples: (e['examples'] as { request?: Record<string, unknown>; response?: Record<string, unknown> } | undefined),
         };
       })
   );

package/src/commands/build-catalog.ts

@@ -13,6 +13,7 @@ export interface CatalogApi {
   requestSchema?: Record<string, unknown>;
   responseSchema?: Record<string, unknown>;
   versions?: Array<{ version: string; requestSchema?: Record<string, unknown>; responseSchema?: Record<string, unknown> }>;
+  examples?: { request?: Record<string, unknown>; response?: Record<string, unknown> };
 }
 
 /** A single action entry in the catalog. */
@@ -163,6 +164,7 @@ export async function runBuildCatalog(tibDir?: string): Promise<DomainCatalog> {
         requestSchema: api['requestSchema'] as Record<string, unknown> | undefined,
         responseSchema: api['responseSchema'] as Record<string, unknown> | undefined,
         versions: api['versions'] as CatalogApi['versions'],
+        examples: api['examples'] as CatalogApi['examples'],
       });
     }
 

package/src/commands/validate.ts

@@ -195,17 +195,17 @@ export async function runValidate(
         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)) {
-      warnings.push(`API '${api.id}' (${api.method} ${api.path}) request schema has no example data. Add .default({...}) to your Zod schema.`);
+    if (!api.examples?.request) {
+      errors.push({
+        code: 'MISSING_API_REQUEST_EXAMPLE',
+        message: `API '${api.id}' (${api.method} ${api.path}) has no request example. Add examples: { request: {...}, response: {...} } to the defineApi config.`,
+      });
     }
-    if (api.responseSchema && !hasExampleOrDefault(api.responseSchema)) {
-      warnings.push(`API '${api.id}' (${api.method} ${api.path}) response schema has no example data. Add .default({...}) to your Zod schema.`);
+    if (!api.examples?.response) {
+      errors.push({
+        code: 'MISSING_API_RESPONSE_EXAMPLE',
+        message: `API '${api.id}' (${api.method} ${api.path}) has no response example. Add examples: { request: {...}, response: {...} } to the defineApi config.`,
+      });
     }
   }