@sdk-it/spec 0.24.0 → 0.26.0

package/dist/lib/tune-response.js

@@ -0,0 +1,102 @@
+import { isRef, parseRef, resolveRef } from "@sdk-it/core/ref.js";
+import { isEmpty, pascalcase } from "@sdk-it/core/utils.js";
+import { findUniqueSchemaName } from "./find-unique-schema-name.js";
+import {
+  isSseContentType,
+  isSuccessStatusCode,
+  isTextContentType,
+  parseJsonContentType
+} from "./is.js";
+import {} from "./options.js";
+function resolveResponses(spec, operationId, operation, responsesConfig) {
+  const responses = operation.responses ?? {};
+  operation.responses ??= {};
+  let foundSuccessResponse = false;
+  for (const status in responses) {
+    if (status === "default") {
+      delete responses[status];
+      continue;
+    }
+    operation.responses[status] = structuredClone(
+      resolveRef(spec, responses[status])
+    );
+    if (isSuccessStatusCode(status)) {
+      foundSuccessResponse = true;
+    }
+  }
+  if (!foundSuccessResponse) {
+    operation.responses["200"] = {
+      description: "OK",
+      content: {
+        "application/json": {
+          schema: {}
+        }
+      }
+    };
+  }
+  for (const status in operation.responses) {
+    const response = operation.responses[status];
+    const statusCode = +status;
+    const outputName = statusCode !== 200 ? pascalcase(operationId) + status : findUniqueSchemaName(spec, operationId, [
+      "output",
+      "payload",
+      "result"
+    ]);
+    if (!responsesConfig?.flattenErrorResponses) {
+      if (!isSuccessStatusCode(status)) {
+        continue;
+      }
+    }
+    if (isEmpty(response.content)) {
+      response.content = {
+        "application/octet-stream": {}
+      };
+    }
+    response["x-response-name"] = outputName;
+    for (const [contentType, mediaType] of Object.entries(
+      response.content
+    )) {
+      if (isRef(mediaType.schema)) {
+        const { model } = parseRef(mediaType.schema.$ref);
+        Object.assign(spec.components.schemas[model], {
+          "x-responsebody": true
+          // do not assign response ref to a group
+          // because they are supposed to be in a separate file only inlined
+          // schemas are grouped by operationId
+        });
+        response["x-response-name"] = model;
+        continue;
+      }
+      if (isSseContentType(contentType)) {
+        continue;
+      }
+      if (parseJsonContentType(contentType)) {
+        if (isEmpty(mediaType.schema)) {
+          spec.components.schemas[outputName] = {
+            type: "object",
+            additionalProperties: true
+          };
+        }
+      } else {
+        spec.components.schemas[outputName] = {
+          ...spec.components.schemas[outputName],
+          "x-stream": !isTextContentType(contentType)
+        };
+      }
+      spec.components.schemas[outputName] = {
+        ...spec.components.schemas[outputName],
+        ...mediaType.schema,
+        "x-responsebody": true,
+        "x-response-group": operationId
+      };
+      operation.responses[status].content[contentType].schema = {
+        $ref: `#/components/schemas/${outputName}`
+      };
+    }
+  }
+  return operation.responses;
+}
+export {
+  resolveResponses
+};
+//# sourceMappingURL=tune-response.js.map

package/dist/lib/tune-response.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../src/lib/tune-response.ts"],
+  "sourcesContent": ["import type {\n  MediaTypeObject,\n  OperationObject,\n  ResponseObject,\n} from 'openapi3-ts/oas31';\n\nimport { isRef, parseRef, resolveRef } from '@sdk-it/core/ref.js';\nimport { isEmpty, pascalcase } from '@sdk-it/core/utils.js';\n\nimport { findUniqueSchemaName } from './find-unique-schema-name.js';\nimport {\n  isSseContentType,\n  isSuccessStatusCode,\n  isTextContentType,\n  parseJsonContentType,\n} from './is.js';\nimport { type ResponsesConfig } from './options.js';\nimport type { OurOpenAPIObject } from './types.js';\n\nexport function resolveResponses(\n  spec: OurOpenAPIObject,\n  operationId: string,\n  operation: OperationObject,\n  responsesConfig?: ResponsesConfig,\n) {\n  const responses = operation.responses ?? {};\n  operation.responses ??= {};\n  let foundSuccessResponse = false;\n  for (const status in responses) {\n    if (status === 'default') {\n      delete responses[status]; // Skip default response\n      continue;\n    }\n    // use structuredClone to avoid mutating a response object\n    // that is referenced by multiple operations\n    operation.responses[status] = structuredClone(\n      resolveRef<ResponseObject>(spec, responses[status]),\n    );\n\n    if (isSuccessStatusCode(status)) {\n      foundSuccessResponse = true;\n    }\n  }\n\n  if (!foundSuccessResponse) {\n    operation.responses['200'] = {\n      description: 'OK',\n      content: {\n        'application/json': {\n          schema: {},\n        },\n      },\n    };\n  }\n\n  for (const status in operation.responses) {\n    const response = operation.responses[status] as ResponseObject;\n    const statusCode = +status;\n\n    const outputName =\n      statusCode !== 200\n        ? pascalcase(operationId) + status\n        : findUniqueSchemaName(spec, operationId, [\n            'output',\n            'payload',\n            'result',\n          ]);\n\n    if (!responsesConfig?.flattenErrorResponses) {\n      if (!isSuccessStatusCode(status)) {\n        continue;\n      }\n    }\n\n    if (isEmpty(response.content)) {\n      response.content = {\n        'application/octet-stream': {},\n      };\n    }\n\n    response['x-response-name'] = outputName;\n\n    // if (isErrorStatusCode(status)) {\n    //   const mediaType = response.content?.['application/json'];\n    //   if (mediaType && isRef(mediaType.schema)) {\n    //     const { model } = parseRef(mediaType.schema.$ref);\n    //     Object.assign(config.spec.components.schemas[model], {\n    //       'x-responsebody': true,\n    //       // do not assign response ref to a group\n    //       // because they are supposed to be in a separate file only inlined\n    //       // schemas are grouped by operationId\n    //     });\n    //     response['x-response-name'] = model;\n    //   }\n    //   continue;\n    // }\n\n    for (const [contentType, mediaType] of Object.entries(\n      response.content as Record<string, MediaTypeObject>,\n    )) {\n      if (isRef(mediaType.schema)) {\n        const { model } = parseRef(mediaType.schema.$ref);\n        Object.assign(spec.components.schemas[model], {\n          'x-responsebody': true,\n          // do not assign response ref to a group\n          // because they are supposed to be in a separate file only inlined\n          // schemas are grouped by operationId\n        });\n        response['x-response-name'] = model;\n        continue;\n      }\n      if (isSseContentType(contentType)) {\n        continue; // Skip SSE content types\n      }\n      if (parseJsonContentType(contentType)) {\n        if (isEmpty(mediaType.schema)) {\n          // add \"additionalProperties\" because we're certain this is a response body is of json type\n          spec.components.schemas[outputName] = {\n            type: 'object',\n            additionalProperties: true,\n          };\n        }\n      } else {\n        spec.components.schemas[outputName] = {\n          ...spec.components.schemas[outputName],\n          'x-stream': !isTextContentType(contentType),\n        };\n      }\n\n      spec.components.schemas[outputName] = {\n        ...spec.components.schemas[outputName],\n        ...mediaType.schema,\n        'x-responsebody': true,\n        'x-response-group': operationId,\n      };\n      operation.responses[status].content[contentType].schema = {\n        $ref: `#/components/schemas/${outputName}`,\n      };\n    }\n  }\n\n  return operation.responses;\n}\n"],
+  "mappings": "AAMA,SAAS,OAAO,UAAU,kBAAkB;AAC5C,SAAS,SAAS,kBAAkB;AAEpC,SAAS,4BAA4B;AACrC;AAAA,EACE;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OACK;AACP,eAAqC;AAG9B,SAAS,iBACd,MACA,aACA,WACA,iBACA;AACA,QAAM,YAAY,UAAU,aAAa,CAAC;AAC1C,YAAU,cAAc,CAAC;AACzB,MAAI,uBAAuB;AAC3B,aAAW,UAAU,WAAW;AAC9B,QAAI,WAAW,WAAW;AACxB,aAAO,UAAU,MAAM;AACvB;AAAA,IACF;AAGA,cAAU,UAAU,MAAM,IAAI;AAAA,MAC5B,WAA2B,MAAM,UAAU,MAAM,CAAC;AAAA,IACpD;AAEA,QAAI,oBAAoB,MAAM,GAAG;AAC/B,6BAAuB;AAAA,IACzB;AAAA,EACF;AAEA,MAAI,CAAC,sBAAsB;AACzB,cAAU,UAAU,KAAK,IAAI;AAAA,MAC3B,aAAa;AAAA,MACb,SAAS;AAAA,QACP,oBAAoB;AAAA,UAClB,QAAQ,CAAC;AAAA,QACX;AAAA,MACF;AAAA,IACF;AAAA,EACF;AAEA,aAAW,UAAU,UAAU,WAAW;AACxC,UAAM,WAAW,UAAU,UAAU,MAAM;AAC3C,UAAM,aAAa,CAAC;AAEpB,UAAM,aACJ,eAAe,MACX,WAAW,WAAW,IAAI,SAC1B,qBAAqB,MAAM,aAAa;AAAA,MACtC;AAAA,MACA;AAAA,MACA;AAAA,IACF,CAAC;AAEP,QAAI,CAAC,iBAAiB,uBAAuB;AAC3C,UAAI,CAAC,oBAAoB,MAAM,GAAG;AAChC;AAAA,MACF;AAAA,IACF;AAEA,QAAI,QAAQ,SAAS,OAAO,GAAG;AAC7B,eAAS,UAAU;AAAA,QACjB,4BAA4B,CAAC;AAAA,MAC/B;AAAA,IACF;AAEA,aAAS,iBAAiB,IAAI;AAiB9B,eAAW,CAAC,aAAa,SAAS,KAAK,OAAO;AAAA,MAC5C,SAAS;AAAA,IACX,GAAG;AACD,UAAI,MAAM,UAAU,MAAM,GAAG;AAC3B,cAAM,EAAE,MAAM,IAAI,SAAS,UAAU,OAAO,IAAI;AAChD,eAAO,OAAO,KAAK,WAAW,QAAQ,KAAK,GAAG;AAAA,UAC5C,kBAAkB;AAAA;AAAA;AAAA;AAAA,QAIpB,CAAC;AACD,iBAAS,iBAAiB,IAAI;AAC9B;AAAA,MACF;AACA,UAAI,iBAAiB,WAAW,GAAG;AACjC;AAAA,MACF;AACA,UAAI,qBAAqB,WAAW,GAAG;AACrC,YAAI,QAAQ,UAAU,MAAM,GAAG;AAE7B,eAAK,WAAW,QAAQ,UAAU,IAAI;AAAA,YACpC,MAAM;AAAA,YACN,sBAAsB;AAAA,UACxB;AAAA,QACF;AAAA,MACF,OAAO;AACL,aAAK,WAAW,QAAQ,UAAU,IAAI;AAAA,UACpC,GAAG,KAAK,WAAW,QAAQ,UAAU;AAAA,UACrC,YAAY,CAAC,kBAAkB,WAAW;AAAA,QAC5C;AAAA,MACF;AAEA,WAAK,WAAW,QAAQ,UAAU,IAAI;AAAA,QACpC,GAAG,KAAK,WAAW,QAAQ,UAAU;AAAA,QACrC,GAAG,UAAU;AAAA,QACb,kBAAkB;AAAA,QAClB,oBAAoB;AAAA,MACtB;AACA,gBAAU,UAAU,MAAM,EAAE,QAAQ,WAAW,EAAE,SAAS;AAAA,QACxD,MAAM,wBAAwB,UAAU;AAAA,MAC1C;AAAA,IACF;AAAA,EACF;AAEA,SAAO,UAAU;AACnB;",
+  "names": []
+}

package/dist/lib/types.d.ts

@@ -1,8 +1,10 @@
 import type { ComponentsObject, MediaTypeObject, OpenAPIObject, OperationObject, ParameterObject, PathsObject, ReferenceObject, RequestBodyObject, ResponseObject, SchemaObject, SecuritySchemeObject } from 'openapi3-ts/oas31';
-import type { SidebarData } from './sidebar.ts';
+import type { PaginationGuess } from './pagination/guess-pagination.js';
+import type { SidebarData, TagGroups } from './sidebar.js';
 export interface OurOpenAPIObject extends OpenAPIObject {
     'x-sdk-augmented'?: boolean;
     'x-docs': SidebarData;
+    'x-tagGroups': TagGroups[];
     components: Omit<ComponentsObject, 'schemas'> & {
         schemas: Record<string, SchemaObject | ReferenceObject>;
         securitySchemes: Record<string, SecuritySchemeObject | ReferenceObject>;
@@ -18,20 +20,23 @@ export type TunedOperationObject = Omit<OperationObject, 'operationId' | 'tags'
     tags: string[];
     operationId: string;
     parameters: ParameterObject[];
+    ['x-fn-name']: string;
+    ['x-fn-group']?: string;
     responses: Record<string, Omit<ResponseObject, 'content'> & {
         content: Record<string, MediaTypeObject>;
     }>;
     requestBody: OurRequestBodyObject;
 };
 export interface OperationEntry {
-    name?: string;
     method: string;
     path: string;
-    groupName: string;
     tag: string;
 }
 export type Operation = {
     entry: OperationEntry;
     operation: TunedOperationObject;
 };
+export type OperationPagination = PaginationGuess & {
+    items: string;
+};
 //# sourceMappingURL=types.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/lib/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,gBAAgB,EAChB,eAAe,EACf,aAAa,EACb,eAAe,EACf,eAAe,EACf,WAAW,EACX,eAAe,EACf,iBAAiB,EACjB,cAAc,EACd,YAAY,EACZ,oBAAoB,EACrB,MAAM,mBAAmB,CAAC;AAE3B,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAEhD,MAAM,WAAW,gBAAiB,SAAQ,aAAa;IACrD,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,QAAQ,EAAE,WAAW,CAAC;IACtB,UAAU,EAAE,IAAI,CAAC,gBAAgB,EAAE,SAAS,CAAC,GAAG;QAC9C,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,YAAY,GAAG,eAAe,CAAC,CAAC;QACxD,eAAe,EAAE,MAAM,CAAC,MAAM,EAAE,oBAAoB,GAAG,eAAe,CAAC,CAAC;KACzE,CAAC;IACF,KAAK,EAAE,WAAW,CAAC;CACpB;AAED,MAAM,WAAW,oBAAqB,SAAQ,iBAAiB;IAC7D,OAAO,EAAE,MAAM,CACb,MAAM,EACN,IAAI,CAAC,eAAe,EAAE,QAAQ,CAAC,GAAG;QAAE,MAAM,EAAE,eAAe,CAAA;KAAE,CAC9D,CAAC;CACH;AAED,MAAM,MAAM,oBAAoB,GAAG,IAAI,CACrC,eAAe,EACf,aAAa,GAAG,MAAM,GAAG,YAAY,GAAG,WAAW,GAAG,aAAa,CACpE,GAAG;IACF,IAAI,EAAE,MAAM,EAAE,CAAC;IACf,WAAW,EAAE,MAAM,CAAC;IACpB,UAAU,EAAE,eAAe,EAAE,CAAC;IAC9B,SAAS,EAAE,MAAM,CACf,MAAM,EACN,IAAI,CAAC,cAAc,EAAE,SAAS,CAAC,GAAG;QAChC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;KAC1C,CACF,CAAC;IACF,WAAW,EAAE,oBAAoB,CAAC;CACnC,CAAC;AAEF,MAAM,WAAW,cAAc;IAC7B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,MAAM,CAAC;IAClB,GAAG,EAAE,MAAM,CAAC;CACb;AACD,MAAM,MAAM,SAAS,GAAG;IACtB,KAAK,EAAE,cAAc,CAAC;IACtB,SAAS,EAAE,oBAAoB,CAAC;CACjC,CAAC"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/lib/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,gBAAgB,EAChB,eAAe,EACf,aAAa,EACb,eAAe,EACf,eAAe,EACf,WAAW,EACX,eAAe,EACf,iBAAiB,EACjB,cAAc,EACd,YAAY,EACZ,oBAAoB,EACrB,MAAM,mBAAmB,CAAC;AAE3B,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,kCAAkC,CAAC;AACxE,OAAO,KAAK,EAAE,WAAW,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AAE3D,MAAM,WAAW,gBAAiB,SAAQ,aAAa;IACrD,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,QAAQ,EAAE,WAAW,CAAC;IACtB,aAAa,EAAE,SAAS,EAAE,CAAC;IAC3B,UAAU,EAAE,IAAI,CAAC,gBAAgB,EAAE,SAAS,CAAC,GAAG;QAC9C,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,YAAY,GAAG,eAAe,CAAC,CAAC;QACxD,eAAe,EAAE,MAAM,CAAC,MAAM,EAAE,oBAAoB,GAAG,eAAe,CAAC,CAAC;KACzE,CAAC;IACF,KAAK,EAAE,WAAW,CAAC;CACpB;AAED,MAAM,WAAW,oBAAqB,SAAQ,iBAAiB;IAC7D,OAAO,EAAE,MAAM,CACb,MAAM,EACN,IAAI,CAAC,eAAe,EAAE,QAAQ,CAAC,GAAG;QAAE,MAAM,EAAE,eAAe,CAAA;KAAE,CAC9D,CAAC;CACH;AAED,MAAM,MAAM,oBAAoB,GAAG,IAAI,CACrC,eAAe,EACf,aAAa,GAAG,MAAM,GAAG,YAAY,GAAG,WAAW,GAAG,aAAa,CACpE,GAAG;IACF,IAAI,EAAE,MAAM,EAAE,CAAC;IACf,WAAW,EAAE,MAAM,CAAC;IACpB,UAAU,EAAE,eAAe,EAAE,CAAC;IAC9B,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;IACtB,CAAC,YAAY,CAAC,CAAC,EAAE,MAAM,CAAC;IACxB,SAAS,EAAE,MAAM,CACf,MAAM,EACN,IAAI,CAAC,cAAc,EAAE,SAAS,CAAC,GAAG;QAChC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;KAC1C,CACF,CAAC;IACF,WAAW,EAAE,oBAAoB,CAAC;CACnC,CAAC;AAEF,MAAM,WAAW,cAAc;IAC7B,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;CACb;AACD,MAAM,MAAM,SAAS,GAAG;IACtB,KAAK,EAAE,cAAc,CAAC;IACtB,SAAS,EAAE,oBAAoB,CAAC;CACjC,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG,eAAe,GAAG;IAClD,KAAK,EAAE,MAAM,CAAC;CACf,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sdk-it/spec",
-  "version": "0.24.0",
+  "version": "0.26.0",
   "type": "module",
   "main": "./dist/index.js",
   "module": "./dist/index.js",
@@ -26,7 +26,7 @@
     "!**/*.tsbuildinfo"
   ],
   "dependencies": {
-    "@sdk-it/core": "0.24.0",
+    "@sdk-it/core": "0.26.0",
     "openapi3-ts": "4.4.0",
     "pluralize": "^8.0.0",
     "stringcase": "^4.3.1",