Fix remote schema maps

Author: drwpow

.changeset/gold-bugs-chew.md

@@ -0,0 +1,5 @@
+---
+"openapi-typescript": patch
+---
+
+Fix remote schema maps

packages/openapi-typescript/examples/digital-ocean-api.ts

@@ -174,6 +174,18 @@ async function openapiTS(schema: string | URL | OpenAPI3 | Readable, options: Op
           subschemaOutput = transformResponseObject(subschema.schema, { path, ctx: { ...ctx, indentLv } });
           break;
         }
+        case "SchemaMap": {
+          subschemaOutput += "{\n";
+          indentLv++;
+          for (const [name, schemaObject] of getEntries(subschema.schema!)) {
+            const c = getSchemaObjectComment(schemaObject, indentLv);
+            if (c) subschemaOutput += indent(c, indentLv);
+            subschemaOutput += indent(`${escObjKey(name)}: ${transformSchemaObject(schemaObject, { path: `${path}${name}`, ctx: { ...ctx, indentLv } })};\n`, indentLv);
+          }
+          indentLv--;
+          subschemaOutput += indent("};", indentLv);
+          break;
+        }
         case "SchemaObject": {
           subschemaOutput = transformSchemaObject(subschema.schema, { path, ctx: { ...ctx, indentLv } });
           break;

packages/openapi-typescript/src/index.ts

@@ -217,7 +217,10 @@ export default async function load(schema: URL | Subschema | Readable, options:
 
     // hints help external partial schemas pick up where the root left off (for external complete/valid schemas, skip this)
     const isRemoteFullSchema = ref.path[0] === "paths" || ref.path[0] === "components"; // if the initial ref is "paths" or "components" this must be a full schema
-    const hint = isRemoteFullSchema ? "OpenAPI3" : getHint([...nodePath, ...ref.path], options.hint);
+    const hintPath = [...nodePath];
+    if (ref.filename) hintPath.push(ref.filename);
+    hintPath.push(...ref.path);
+    const hint = isRemoteFullSchema ? "OpenAPI3" : getHint(hintPath, options.hint);
 
     // if root schema is remote and this is a relative reference, treat as remote
     if (schema instanceof URL) {
@@ -400,6 +403,10 @@ function getHintFromResponseObject(path: (string | number)[]): Subschema["hint"]
   return "ResponseObject";
 }
 function getHintFromSchemaObject(path: (string | number)[]): Subschema["hint"] {
+  // if this is pointing to a remote file and there’s an additional path, it’s a SchemaMap
+  if (typeof path[0] === "string" && path[0].includes(".") && path[1]) {
+    return "SchemaMap";
+  }
   switch (path[0]) {
     case "allOf":
     case "anyOf":

packages/openapi-typescript/src/load.ts

@@ -639,6 +639,7 @@ export type Subschema =
     }
   | { hint: "RequestBodyObject"; schema: RequestBodyObject }
   | { hint: "ResponseObject"; schema: ResponseObject }
+  | { hint: "SchemaMap"; schema: NonNullable<ComponentsObject["schemas"]> }
   | { hint: "SchemaObject"; schema: SchemaObject };
 
 /** Context passed to all submodules */

packages/openapi-typescript/src/types.ts

@@ -0,0 +1,7 @@
+PartialType:
+  type: object
+  properties:
+    foo:
+      type: string
+  required:
+    - foo

packages/openapi-typescript/test/fixtures/_schema-test-partial.yaml

@@ -16,3 +16,5 @@ components:
   schemas:
     RemoteType:
       $ref: "./remote-ref-test-2.yaml#/components/schemas/SchemaType"
+    RemotePartialType:
+      $ref: '_schema-test-partial.yaml#/PartialType'

packages/openapi-typescript/test/fixtures/remote-ref-test.yaml

@@ -309,6 +309,7 @@ export type webhooks = Record<string, never>;
 export interface components {
   schemas: {
     RemoteType: external["remote-ref-test-2.yaml"]["components"]["schemas"]["SchemaType"];
+    RemotePartialType: external["_schema-test-partial.yaml"]["PartialType"];
   };
   responses: never;
   parameters: never;
@@ -318,6 +319,11 @@ export interface components {
 }
 
 export interface external {
+  "_schema-test-partial.yaml": {
+    PartialType: {
+      foo: string;
+    };
+  };
   "remote-ref-test-2.yaml": {
     paths: {
       "/": {