@checkdigit/eslint-plugin 7.18.0-PR.143-b064 → 7.18.0-PR.143-b6d4

package/src/athena/athena.ts

@@ -28,6 +28,8 @@ import {
 } from './context.ts';
 import { buildServiceTables } from './service-table.ts';
 import {
+  containsCastToArray,
+  containsCastToMap,
   containsLambda,
   extractBracketAccessorPath,
   extractColumnRefs,
@@ -228,7 +230,7 @@ function resolveFromClause(select: Select, ctx: VisitContext): void {
 
 interface UnnestMapping {
   fromColumn: string;
-  toColumn: string;
+  toColumns: string[]; // 1 item for array UNNEST, 2 items for map UNNEST (key, value)
   ast: object;
 }
 
@@ -243,15 +245,17 @@ function extractUnnestMappings(select: Select): UnnestMapping[] {
     const fromColumn = typeof item.expr.column === 'string' ? item.expr.column : undefined;
     assert.ok(fromColumn !== undefined, 'UNNEST expr must be a column_ref with a string column name');
 
-    // The alias is stored as a func_call node: UNNEST(col) AS t(alias)
-    const toColumn = item.as?.args.value[0];
-    const toColName =
-      toColumn !== undefined && typeof (toColumn as { column?: unknown }).column === 'string'
-        ? (toColumn as { column: string }).column
-        : undefined;
-    assert.ok(toColName !== undefined, 'UNNEST alias must be a column_ref with a string column name');
+    // The alias is stored as a func_call node: UNNEST(col) AS t(alias1[, alias2])
+    const aliasArgs = item.as?.args.value ?? [];
+    const toColumns: string[] = [];
+    for (const col of aliasArgs) {
+      if (typeof (col as { column?: unknown }).column === 'string') {
+        toColumns.push((col as { column: string }).column);
+      }
+    }
+    assert.ok(toColumns.length > 0, 'UNNEST alias must have at least one column name');
 
-    mappings.push({ fromColumn, toColumn: toColName, ast: item.expr });
+    mappings.push({ fromColumn, toColumns, ast: item.expr });
   }
 
   return mappings;
@@ -260,45 +264,93 @@ function extractUnnestMappings(select: Select): UnnestMapping[] {
 function applyUnnestPre(mappings: UnnestMapping[], ctx: VisitContext): UnnestMapping[] {
   const deferred: UnnestMapping[] = [];
 
-  for (const { fromColumn, toColumn, ast } of mappings) {
+  for (const { fromColumn, toColumns, ast } of mappings) {
     // Find the table that owns the source column
     const ownerTable = [...ctx.tables.values()].flat().find((table) => table.columns.has(fromColumn));
 
     if (ownerTable === undefined) {
-      deferred.push({ fromColumn, toColumn, ast });
+      deferred.push({ fromColumn, toColumns, ast });
       continue;
     }
 
     const sourceColumns = ownerTable.columns.get(fromColumn) ?? [];
     const sourceSchema = sourceColumns[0]?.schema;
-    if (sourceSchema?.type !== 'array') {
-      throw new AthenaError(ATHENA_ERROR, `UNNEST source column '${fromColumn}' must resolve to an array schema`, ast);
-    }
-
     const unnestTableName = `${ownerTable.name ?? '<anonymous>'}:<unnested>`;
-    ctx.tables.set(unnestTableName, [
-      {
-        name: unnestTableName,
-        ...(ownerTable.apiOperation !== undefined ? { apiOperation: ownerTable.apiOperation } : {}),
-        columns: new Map([[toColumn, [resolvedCol(toColumn, sourceSchema.items, sourceColumns[0]?.ast)]]]),
-      },
-    ]);
+    const apiOperation = ownerTable.apiOperation !== undefined ? { apiOperation: ownerTable.apiOperation } : {};
+
+    if (sourceSchema?.type === 'array') {
+      const [toColumn] = toColumns;
+      assert.ok(toColumn !== undefined);
+      ctx.tables.set(unnestTableName, [
+        {
+          name: unnestTableName,
+          ...apiOperation,
+          columns: new Map([[toColumn, [resolvedCol(toColumn, sourceSchema.items, sourceColumns[0]?.ast)]]]),
+        },
+      ]);
+    } else if (sourceSchema?.type === 'object') {
+      // MAP UNNEST: UNNEST(map_col) AS t(key_col, value_col)
+      const [keyColumn, valueColumn] = toColumns;
+      assert.ok(
+        keyColumn !== undefined && valueColumn !== undefined,
+        `UNNEST of map column '${fromColumn}' requires exactly two alias columns (key, value)`,
+      );
+      const addlProps = (sourceSchema as SchemaObject)['additionalProperties'] as unknown;
+      const valueSchema: SchemaObject =
+        typeof addlProps === 'object' && addlProps !== null ? addlProps : { type: 'string' };
+      ctx.tables.set(unnestTableName, [
+        {
+          name: unnestTableName,
+          ...apiOperation,
+          columns: new Map([
+            [keyColumn, [resolvedCol(keyColumn, { type: 'string' }, sourceColumns[0]?.ast)]],
+            [valueColumn, [resolvedCol(valueColumn, valueSchema, sourceColumns[0]?.ast)]],
+          ]),
+        },
+      ]);
+    } else {
+      throw new AthenaError(
+        ATHENA_ERROR,
+        `UNNEST source column '${fromColumn}' must resolve to an array or map schema`,
+        ast,
+      );
+    }
   }
 
   return deferred;
 }
 
 function applyUnnestPost(mappings: UnnestMapping[], columns: Map<string, ResolvedColumn[]>): void {
-  for (const { fromColumn, toColumn, ast } of mappings) {
+  for (const { fromColumn, toColumns, ast } of mappings) {
     const sourceColumns = columns.get(fromColumn);
     if (sourceColumns === undefined) {
       throw new AthenaError(ATHENA_ERROR, `UNNEST source column '${fromColumn}' not found in SELECT`, ast);
     }
     const sourceSchema = sourceColumns[0]?.schema;
-    if (sourceSchema?.type !== 'array') {
-      throw new AthenaError(ATHENA_ERROR, `UNNEST source column '${fromColumn}' must resolve to an array schema`, ast);
+
+    if (sourceSchema?.type === 'array') {
+      const [toColumn] = toColumns;
+      assert.ok(toColumn !== undefined);
+      columns.set(toColumn, [resolvedCol(toColumn, sourceSchema.items, sourceColumns[0]?.ast)]);
+    } else if (sourceSchema?.type === 'object') {
+      // MAP UNNEST: produces key column and value column
+      const [keyColumn, valueColumn] = toColumns;
+      assert.ok(
+        keyColumn !== undefined && valueColumn !== undefined,
+        `UNNEST of map column '${fromColumn}' requires exactly two alias columns (key, value)`,
+      );
+      const addlProps = (sourceSchema as SchemaObject)['additionalProperties'] as unknown;
+      const valueSchema: SchemaObject =
+        typeof addlProps === 'object' && addlProps !== null ? addlProps : { type: 'string' };
+      columns.set(keyColumn, [resolvedCol(keyColumn, { type: 'string' }, sourceColumns[0]?.ast)]);
+      columns.set(valueColumn, [resolvedCol(valueColumn, valueSchema, sourceColumns[0]?.ast)]);
+    } else {
+      throw new AthenaError(
+        ATHENA_ERROR,
+        `UNNEST source column '${fromColumn}' must resolve to an array or map schema`,
+        ast,
+      );
     }
-    columns.set(toColumn, [resolvedCol(toColumn, sourceSchema.items, sourceColumns[0]?.ast)]);
   }
 }
 
@@ -502,22 +554,6 @@ function resolveSingleColumnRef(
   );
 }
 
-/** Return true when the column expression is a CAST / TRY_CAST to ARRAY<…>. */
-function isCastToArray(node: unknown): boolean {
-  if (typeof node !== 'object' || node === null) {
-    return false;
-  }
-  const typed = node as Record<string, unknown>;
-  if (typed['type'] === 'cast') {
-    const target = (typed['target'] as { dataType?: string }[] | undefined)?.[0];
-    return target?.dataType === 'ARRAY';
-  }
-  if (typed['type'] === 'expr') {
-    return isCastToArray(typed['expr']);
-  }
-  return false;
-}
-
 function resolveSelectColumns(select: Select, ctx: VisitContext): Map<string, ResolvedColumn[]> {
   const allTables = [...ctx.tables.values()].flat();
   const columns = new Map<string, ResolvedColumn[]>();
@@ -544,7 +580,7 @@ function resolveSelectColumns(select: Select, ctx: VisitContext): Map<string, Re
     // the inner expression (e.g. json_parse) has no schema-aware path to navigate.
     // Skip when the inner expression already resolved to an array (e.g. json_extract on an
     // array-typed property): overriding would strip the items schema and break UNNEST typing.
-    if (isCastToArray(columnAST)) {
+    if (containsCastToArray(columnAST)) {
       const colName = columnAlias ?? indexedName;
       const existing = columns.get(colName);
       if (existing !== undefined && existing[0]?.schema.type !== 'array') {
@@ -554,6 +590,20 @@ function resolveSelectColumns(select: Select, ctx: VisitContext): Map<string, Re
         );
       }
     }
+
+    // Same for CAST/TRY_CAST to MAP<…>: honour the declared map type when the inner
+    // expression (e.g. split_to_map) has no schema-aware navigation available.
+    // Skip when the schema is already an object to preserve additionalProperties.
+    if (containsCastToMap(columnAST)) {
+      const colName = columnAlias ?? indexedName;
+      const existing = columns.get(colName);
+      if (existing !== undefined && existing[0]?.schema.type !== 'object') {
+        columns.set(
+          colName,
+          existing.map((col) => resolvedCol(col.name, { type: 'object' }, col.ast)),
+        );
+      }
+    }
   }
 
   return columns;

package/src/athena/visitor.ts

@@ -382,3 +382,31 @@ export function hasFunctionCalls(expr: unknown): boolean {
   });
   return found;
 }
+
+/** Return true when the expression tree contains any CAST / TRY_CAST to ARRAY<…>. */
+export function containsCastToArray(expr: unknown): boolean {
+  let found = false;
+  walkExpr(expr, {
+    visitCast(node) {
+      const target = (node as unknown as { target?: { dataType?: string }[] }).target?.[0];
+      if (target?.dataType === 'ARRAY') {
+        found = true;
+      }
+    },
+  });
+  return found;
+}
+
+/** Return true when the expression tree contains any CAST / TRY_CAST to MAP<…>. */
+export function containsCastToMap(expr: unknown): boolean {
+  let found = false;
+  walkExpr(expr, {
+    visitCast(node) {
+      const target = (node as unknown as { target?: { dataType?: string }[] }).target?.[0];
+      if (target?.dataType === 'MAP') {
+        found = true;
+      }
+    },
+  });
+  return found;
+}

package/src/openapi/service-schema-generator.ts

@@ -1,6 +1,5 @@
 // openapi/service-schema-generator.ts
 
-import { execFileSync } from 'node:child_process';
 import { existsSync, mkdirSync, readFileSync, writeFileSync } from 'node:fs';
 
 import debug from 'debug';
@@ -53,18 +52,6 @@ function derefApiSchemas(schemas: ApiSchemas): ApiSchemas {
   return { apis: resolvedApis };
 }
 
-function fetchUrlSync(url: string): string | null {
-  try {
-    return execFileSync(process.execPath, ['--input-type=module'], {
-      input: `const r=await fetch(${JSON.stringify(url)});if(!r.ok)process.exit(1);process.stdout.write(await r.text());`,
-      encoding: 'utf-8',
-      timeout: 15_000,
-    });
-  } catch {
-    return null;
-  }
-}
-
 function readServiceConfig(
   packageJsonContent: string,
   org: string,
@@ -105,73 +92,33 @@ function findServiceLocally(serviceFolder: string, org: string, serviceName: str
 }
 
 function findServiceInProject(serviceName: string): ServiceSource | null {
-  const packageJsonString = readFileSync(`./package.json`, 'utf-8');
-  const packageJson = JSON.parse(packageJsonString) as unknown as { name: string };
-  const [org, projectName] = packageJson.name.slice(1).split('/');
-  if (org === undefined) {
+  const packageJson = JSON.parse(readFileSync('./package.json', 'utf-8')) as { name?: string };
+  const [org, projectName] = (packageJson.name ?? '').slice(1).split('/');
+  if (org === undefined || projectName !== serviceName) {
     return null;
   }
-
-  if (projectName === serviceName) {
-    log('service is the current project, looking for API schemas locally', serviceName);
-    const serviceSource = findServiceLocally('.', org, serviceName);
-    if (serviceSource !== null) {
-      return serviceSource;
-    }
-  }
-
-  return null;
+  log(`[schema-generator] '${serviceName}' is the current project, reading local swagger files`);
+  return findServiceLocally('.', org, serviceName);
 }
 
 function findServiceInNodeModules(serviceName: string): ServiceSource | null {
   for (const org of GITHUB_ORGANIZATIONS) {
     const serviceFolder = `node_modules/@${org}/${serviceName}`;
     if (!existsSync(serviceFolder)) {
+      log(`[schema-generator] not found in node_modules: @${org}/${serviceName}`);
       continue;
     }
-
-    try {
-      const serviceSource = findServiceLocally(serviceFolder, org, serviceName);
-      if (serviceSource !== null) {
-        return serviceSource;
-      }
-    } catch {
-      // continue to next org
-    }
-  }
-  return null;
-}
-
-function findServiceOnGitHub(serviceName: string): ServiceSource | null {
-  for (const org of GITHUB_ORGANIZATIONS) {
-    const pkgUrl = `https://raw.githubusercontent.com/${org}/${serviceName}/main/package.json`;
-    log(`fetching package.json from ${pkgUrl}`);
-    const pkgContent = fetchUrlSync(pkgUrl);
-    if (pkgContent === null) {
-      continue;
-    }
-
     try {
-      const config = readServiceConfig(pkgContent, org, serviceName);
-      if (config === null) {
-        continue;
-      }
-
-      const endpoints: ServiceEndpoint[] = [];
-      for (const endpoint of config.endpoints) {
-        const swaggerUrl = `https://raw.githubusercontent.com/${org}/${serviceName}/main/${config.apiRoot}/${endpoint}/swagger.yml`;
-        log(`fetching swagger.yml from ${swaggerUrl}`);
-        const yamlContent = fetchUrlSync(swaggerUrl);
-        if (yamlContent !== null) {
-          endpoints.push({ path: endpoint, yamlContent });
-        }
+      log(`[schema-generator] found in node_modules: @${org}/${serviceName}, reading swagger files`);
+      const source = findServiceLocally(serviceFolder, org, serviceName);
+      if (source !== null) {
+        return source;
       }
-
-      if (endpoints.length > 0) {
-        return { organization: config.organization, serviceName: config.serviceName, endpoints };
-      }
-    } catch {
-      // continue to next org
+      log(`[schema-generator] no swagger schema inside node_modules/@${org}/${serviceName}`);
+    } catch (error) {
+      log(
+        `[schema-generator] error reading node_modules/@${org}/${serviceName}: ${error instanceof Error ? error.message : String(error)}`,
+      );
     }
   }
   return null;
@@ -181,15 +128,18 @@ export function generateSchemasForService(
   serviceName: string,
   outputDir?: string,
 ): { schema: ApiSchemas; endpoint: string }[] {
-  log('generating schemas for service', serviceName);
+  log(`[schema-generator] locating service '${serviceName}'`);
 
-  const source =
-    findServiceInProject(serviceName) ?? findServiceInNodeModules(serviceName) ?? findServiceOnGitHub(serviceName);
+  const source = findServiceInProject(serviceName) ?? findServiceInNodeModules(serviceName);
   if (source === null) {
-    log('no swagger source found for service', serviceName);
+    log(
+      `[schema-generator] '${serviceName}' not found — ensure it is listed as a devDependency or the repo is accessible via git`,
+    );
     return [];
   }
 
+  log(`[schema-generator] found '${serviceName}' (${source.endpoints.length.toString()} endpoint(s))`);
+
   const results: { schema: ApiSchemas; endpoint: string }[] = [];
   for (const { path: endpoint, yamlContent } of source.endpoints) {
     try {
@@ -205,10 +155,12 @@ export function generateSchemasForService(
         const dir = `${outputDir}/${versionFolder}`;
         mkdirSync(dir, { recursive: true });
         writeFileSync(`${dir}/${SWAGGER_SCHEMA_DEREF_FILENAME}`, JSON.stringify(schema, undefined, 2));
-        log(`cached schema to ${dir}/${SWAGGER_SCHEMA_DEREF_FILENAME}`);
+        log(`[schema-generator] cached schema to ${dir}/${SWAGGER_SCHEMA_DEREF_FILENAME}`);
       }
     } catch (error) {
-      log('error generating schema for endpoint', endpoint, error);
+      log(
+        `[schema-generator] error processing endpoint ${endpoint}: ${error instanceof Error ? error.message : String(error)}`,
+      );
     }
   }
 

package/src/services/interchange/v1/swagger.schema.deref.json

@@ -5,7 +5,7 @@
       "put": {
         "request": {
           "$schema": "https://json-schema.org/draft/2020-12/schema",
-          "$id": "https://eslint-plugin.checkdigit/interchange/v1/schemas/api/InterchangePutRequestContext",
+          "$id": "https://interchange.checkdigit/interchange/v1/schemas/api/InterchangePutRequestContext",
           "type": "object",
           "properties": {
             "params": {
@@ -31,7 +31,7 @@
             },
             "body": {
               "$schema": "https://json-schema.org/draft/2020-12/schema",
-              "$id": "https://eslint-plugin.checkdigit/interchange/v1/schemas/definitions/Interchange",
+              "$id": "https://interchange.checkdigit/interchange/v1/schemas/definitions/Interchange",
               "type": "object",
               "additionalProperties": false,
               "description": "Data that describes an interchange record.",
@@ -281,7 +281,7 @@
                   "allOf": [
                     {
                       "$schema": "https://json-schema.org/draft/2020-12/schema",
-                      "$id": "https://eslint-plugin.checkdigit/interchange/v1/schemas/definitions/Amount",
+                      "$id": "https://interchange.checkdigit/interchange/v1/schemas/definitions/Amount",
                       "type": "object",
                       "additionalProperties": false,
                       "required": ["amount", "currency"],
@@ -308,7 +308,7 @@
                   "allOf": [
                     {
                       "$schema": "https://json-schema.org/draft/2020-12/schema",
-                      "$id": "https://eslint-plugin.checkdigit/interchange/v1/schemas/definitions/Amount",
+                      "$id": "https://interchange.checkdigit/interchange/v1/schemas/definitions/Amount",
                       "type": "object",
                       "additionalProperties": false,
                       "required": ["amount", "currency"],
@@ -354,7 +354,7 @@
         "responses": {
           "204": {
             "$schema": "https://json-schema.org/draft/2020-12/schema",
-            "$id": "https://eslint-plugin.checkdigit/interchange/v1/schemas/api/InterchangePutResponseNoContent",
+            "$id": "https://interchange.checkdigit/interchange/v1/schemas/api/InterchangePutResponseNoContent",
             "type": "object",
             "properties": {
               "headers": {
@@ -368,15 +368,16 @@
                     "type": "string",
                     "format": "date-time"
                   }
-                }
+                },
+                "required": ["created-on", "updated-on"]
               }
             },
-            "required": [],
+            "required": ["headers"],
             "additionalProperties": false
           },
           "default": {
             "$schema": "https://json-schema.org/draft/2020-12/schema",
-            "$id": "https://eslint-plugin.checkdigit/interchange/v1/schemas/api/InterchangePutResponseDefault",
+            "$id": "https://interchange.checkdigit/interchange/v1/schemas/api/InterchangePutResponseDefault",
             "type": "object",
             "properties": {
               "headers": {
@@ -385,7 +386,7 @@
               },
               "body": {
                 "$schema": "https://json-schema.org/draft/2020-12/schema",
-                "$id": "https://eslint-plugin.checkdigit/interchange/v1/schemas/definitions/Error",
+                "$id": "https://interchange.checkdigit/interchange/v1/schemas/definitions/Error",
                 "type": "object",
                 "additionalProperties": false,
                 "properties": {
@@ -410,7 +411,7 @@
   "definitions": {
     "Ping": {
       "$schema": "https://json-schema.org/draft/2020-12/schema",
-      "$id": "https://eslint-plugin.checkdigit/interchange/v1/schemas/definitions/Ping",
+      "$id": "https://interchange.checkdigit/interchange/v1/schemas/definitions/Ping",
       "type": "object",
       "additionalProperties": false,
       "required": ["serverTime"],
@@ -424,7 +425,7 @@
     },
     "Error": {
       "$schema": "https://json-schema.org/draft/2020-12/schema",
-      "$id": "https://eslint-plugin.checkdigit/interchange/v1/schemas/definitions/Error",
+      "$id": "https://interchange.checkdigit/interchange/v1/schemas/definitions/Error",
       "type": "object",
       "additionalProperties": false,
       "properties": {
@@ -440,7 +441,7 @@
     },
     "Interchange": {
       "$schema": "https://json-schema.org/draft/2020-12/schema",
-      "$id": "https://eslint-plugin.checkdigit/interchange/v1/schemas/definitions/Interchange",
+      "$id": "https://interchange.checkdigit/interchange/v1/schemas/definitions/Interchange",
       "type": "object",
       "additionalProperties": false,
       "description": "Data that describes an interchange record.",
@@ -690,7 +691,7 @@
           "allOf": [
             {
               "$schema": "https://json-schema.org/draft/2020-12/schema",
-              "$id": "https://eslint-plugin.checkdigit/interchange/v1/schemas/definitions/Amount",
+              "$id": "https://interchange.checkdigit/interchange/v1/schemas/definitions/Amount",
               "type": "object",
               "additionalProperties": false,
               "required": ["amount", "currency"],
@@ -717,7 +718,7 @@
           "allOf": [
             {
               "$schema": "https://json-schema.org/draft/2020-12/schema",
-              "$id": "https://eslint-plugin.checkdigit/interchange/v1/schemas/definitions/Amount",
+              "$id": "https://interchange.checkdigit/interchange/v1/schemas/definitions/Amount",
               "type": "object",
               "additionalProperties": false,
               "required": ["amount", "currency"],
@@ -758,7 +759,7 @@
     },
     "Amount": {
       "$schema": "https://json-schema.org/draft/2020-12/schema",
-      "$id": "https://eslint-plugin.checkdigit/interchange/v1/schemas/definitions/Amount",
+      "$id": "https://interchange.checkdigit/interchange/v1/schemas/definitions/Amount",
       "type": "object",
       "additionalProperties": false,
       "required": ["amount", "currency"],