@sdk-it/spec 0.25.0 → 0.27.0

package/dist/index.d.ts

@@ -1,3 +1,4 @@
+export * from './lib/create-operation.js';
 export * from './lib/find-polymorphic-varients.js';
 export * from './lib/find-unique-schema-name.js';
 export * from './lib/for-each-operation.js';
@@ -11,10 +12,13 @@ export * from './lib/loaders/remote-loader.js';
 export * from './lib/metadata.js';
 export * from './lib/operation.js';
 export * from './lib/options.js';
+export * from './lib/overview-docs/overview-errors.js';
 export * from './lib/reserved-keywords.js';
 export * from './lib/security.js';
 export * from './lib/sidebar.js';
 export * from './lib/tag.js';
+export * from './lib/tune-request-body.js';
+export * from './lib/tune-response.js';
 export * from './lib/tune.js';
 export * from './lib/types.js';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,oCAAoC,CAAC;AACnD,cAAc,kCAAkC,CAAC;AACjD,cAAc,6BAA6B,CAAC;AAC5C,cAAc,sBAAsB,CAAC;AACrC,cAAc,wBAAwB,CAAC;AACvC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,aAAa,CAAC;AAC5B,cAAc,4BAA4B,CAAC;AAC3C,cAAc,+BAA+B,CAAC;AAC9C,cAAc,gCAAgC,CAAC;AAC/C,cAAc,mBAAmB,CAAC;AAClC,cAAc,oBAAoB,CAAC;AACnC,cAAc,kBAAkB,CAAC;AACjC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,mBAAmB,CAAC;AAClC,cAAc,kBAAkB,CAAC;AACjC,cAAc,cAAc,CAAC;AAC7B,cAAc,eAAe,CAAC;AAC9B,cAAc,gBAAgB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,2BAA2B,CAAC;AAC1C,cAAc,oCAAoC,CAAC;AACnD,cAAc,kCAAkC,CAAC;AACjD,cAAc,6BAA6B,CAAC;AAC5C,cAAc,sBAAsB,CAAC;AACrC,cAAc,wBAAwB,CAAC;AACvC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,aAAa,CAAC;AAC5B,cAAc,4BAA4B,CAAC;AAC3C,cAAc,+BAA+B,CAAC;AAC9C,cAAc,gCAAgC,CAAC;AAC/C,cAAc,mBAAmB,CAAC;AAClC,cAAc,oBAAoB,CAAC;AACnC,cAAc,kBAAkB,CAAC;AACjC,cAAc,wCAAwC,CAAC;AACvD,cAAc,4BAA4B,CAAC;AAC3C,cAAc,mBAAmB,CAAC;AAClC,cAAc,kBAAkB,CAAC;AACjC,cAAc,cAAc,CAAC;AAC7B,cAAc,4BAA4B,CAAC;AAC3C,cAAc,wBAAwB,CAAC;AACvC,cAAc,eAAe,CAAC;AAC9B,cAAc,gBAAgB,CAAC"}

package/dist/index.js

@@ -1,3 +1,4 @@
+export * from "./lib/create-operation.js";
 export * from "./lib/find-polymorphic-varients.js";
 export * from "./lib/find-unique-schema-name.js";
 export * from "./lib/for-each-operation.js";
@@ -11,10 +12,13 @@ export * from "./lib/loaders/remote-loader.js";
 export * from "./lib/metadata.js";
 export * from "./lib/operation.js";
 export * from "./lib/options.js";
+export * from "./lib/overview-docs/overview-errors.js";
 export * from "./lib/reserved-keywords.js";
 export * from "./lib/security.js";
 export * from "./lib/sidebar.js";
 export * from "./lib/tag.js";
+export * from "./lib/tune-request-body.js";
+export * from "./lib/tune-response.js";
 export * from "./lib/tune.js";
 export * from "./lib/types.js";
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../src/index.ts"],
-  "sourcesContent": ["export * from './lib/find-polymorphic-varients.js';\nexport * from './lib/find-unique-schema-name.js';\nexport * from './lib/for-each-operation.js';\nexport * from './lib/format-name.js';\nexport * from './lib/get-ref-usage.js';\nexport * from './lib/is-primitive-schema.js';\nexport * from './lib/is.js';\nexport * from './lib/loaders/load-spec.js';\nexport * from './lib/loaders/local-loader.js';\nexport * from './lib/loaders/remote-loader.js';\nexport * from './lib/metadata.js';\nexport * from './lib/operation.js';\nexport * from './lib/options.js';\nexport * from './lib/reserved-keywords.js';\nexport * from './lib/security.js';\nexport * from './lib/sidebar.js';\nexport * from './lib/tag.js';\nexport * from './lib/tune.js';\nexport * from './lib/types.js';\n"],
-  "mappings": "AAAA,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;",
+  "sourcesContent": ["export * from './lib/create-operation.js';\nexport * from './lib/find-polymorphic-varients.js';\nexport * from './lib/find-unique-schema-name.js';\nexport * from './lib/for-each-operation.js';\nexport * from './lib/format-name.js';\nexport * from './lib/get-ref-usage.js';\nexport * from './lib/is-primitive-schema.js';\nexport * from './lib/is.js';\nexport * from './lib/loaders/load-spec.js';\nexport * from './lib/loaders/local-loader.js';\nexport * from './lib/loaders/remote-loader.js';\nexport * from './lib/metadata.js';\nexport * from './lib/operation.js';\nexport * from './lib/options.js';\nexport * from './lib/overview-docs/overview-errors.js';\nexport * from './lib/reserved-keywords.js';\nexport * from './lib/security.js';\nexport * from './lib/sidebar.js';\nexport * from './lib/tag.js';\nexport * from './lib/tune-request-body.js';\nexport * from './lib/tune-response.js';\nexport * from './lib/tune.js';\nexport * from './lib/types.js';\n"],
+  "mappings": "AAAA,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;",
   "names": []
 }

package/dist/lib/create-operation.d.ts

@@ -0,0 +1,28 @@
+import type { ReferenceObject, SchemaObject } from 'openapi3-ts/oas31';
+import type { TunedOperationObject } from './types.js';
+export declare function createOperation(options: {
+    name: string;
+    group: string;
+    security?: string[];
+    parameters?: {
+        query?: Record<string, {
+            schema: SchemaObject;
+            required?: boolean;
+        }>;
+        path?: Record<string, {
+            schema: SchemaObject;
+            required?: boolean;
+        }>;
+        header?: Record<string, {
+            schema: SchemaObject;
+            required?: boolean;
+        }>;
+        cookie?: Record<string, {
+            schema: SchemaObject;
+            required?: boolean;
+        }>;
+    };
+    response: Record<string, SchemaObject | Record<string, SchemaObject>>;
+    request?: Record<string, ReferenceObject>;
+}): TunedOperationObject;
+//# sourceMappingURL=create-operation.d.ts.map

package/dist/lib/create-operation.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"create-operation.d.ts","sourceRoot":"","sources":["../../src/lib/create-operation.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAEV,eAAe,EAEf,YAAY,EACb,MAAM,mBAAmB,CAAC;AAI3B,OAAO,KAAK,EAAwB,oBAAoB,EAAE,MAAM,YAAY,CAAC;AAE7E,wBAAgB,eAAe,CAAC,OAAO,EAAE;IACvC,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IACpB,UAAU,CAAC,EAAE;QACX,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE;YAAE,MAAM,EAAE,YAAY,CAAC;YAAC,QAAQ,CAAC,EAAE,OAAO,CAAA;SAAE,CAAC,CAAC;QACrE,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE;YAAE,MAAM,EAAE,YAAY,CAAC;YAAC,QAAQ,CAAC,EAAE,OAAO,CAAA;SAAE,CAAC,CAAC;QACpE,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE;YAAE,MAAM,EAAE,YAAY,CAAC;YAAC,QAAQ,CAAC,EAAE,OAAO,CAAA;SAAE,CAAC,CAAC;QACtE,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE;YAAE,MAAM,EAAE,YAAY,CAAC;YAAC,QAAQ,CAAC,EAAE,OAAO,CAAA;SAAE,CAAC,CAAC;KACvE,CAAC;IACF,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,YAAY,GAAG,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC,CAAC;IACtE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;CAC3C,GAAG,oBAAoB,CA8DvB"}

package/dist/lib/create-operation.js

@@ -0,0 +1,62 @@
+import { isEmpty } from "@sdk-it/core/utils.js";
+function createOperation(options) {
+  const parameters = [];
+  if (!isEmpty(options.parameters)) {
+    const locations = ["query", "path", "header", "cookie"];
+    for (const location of locations) {
+      const locationParams = options.parameters[location];
+      if (locationParams) {
+        for (const [name, param] of Object.entries(locationParams)) {
+          parameters.push({
+            name,
+            in: location,
+            required: param.required ?? false,
+            schema: param.schema
+          });
+        }
+      }
+    }
+  }
+  const responses = {};
+  for (const [key, schema] of Object.entries(options.response)) {
+    const [statusCode, contentType] = key.split(/-(.*)/);
+    if (!contentType) {
+      throw new Error(
+        `Response key "${key}" must be in the format "statusCode-contentType"`
+      );
+    }
+    responses[statusCode] ??= {
+      description: `Response for ${statusCode}`,
+      content: {}
+    };
+    if (contentType === "headers") {
+      responses[statusCode].headers = schema;
+    } else {
+      responses[statusCode].content[contentType] = {
+        schema
+      };
+    }
+  }
+  let requestBody = void 0;
+  if (options.request) {
+    requestBody = { description: "Request body", content: {} };
+    for (const [contentType, schema] of Object.entries(options.request)) {
+      requestBody.content[contentType] = { schema };
+    }
+  }
+  return {
+    security: (options.security ?? []).map((name) => ({
+      [name]: []
+    })),
+    "x-fn-name": options.name,
+    operationId: options.name,
+    tags: [options.group],
+    parameters,
+    responses,
+    requestBody
+  };
+}
+export {
+  createOperation
+};
+//# sourceMappingURL=create-operation.js.map

package/dist/lib/create-operation.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../src/lib/create-operation.ts"],
+  "sourcesContent": ["import type {\n  ParameterObject,\n  ReferenceObject,\n  ResponsesObject,\n  SchemaObject,\n} from 'openapi3-ts/oas31';\n\nimport { isEmpty } from '@sdk-it/core/utils.js';\n\nimport type { OurRequestBodyObject, TunedOperationObject } from './types.js';\n\nexport function createOperation(options: {\n  name: string;\n  group: string;\n  security?: string[];\n  parameters?: {\n    query?: Record<string, { schema: SchemaObject; required?: boolean }>;\n    path?: Record<string, { schema: SchemaObject; required?: boolean }>;\n    header?: Record<string, { schema: SchemaObject; required?: boolean }>;\n    cookie?: Record<string, { schema: SchemaObject; required?: boolean }>;\n  };\n  response: Record<string, SchemaObject | Record<string, SchemaObject>>; // Key is statusCode-contentType\n  request?: Record<string, ReferenceObject>;\n}): TunedOperationObject {\n  const parameters: ParameterObject[] = [];\n  if (!isEmpty(options.parameters)) {\n    const locations = ['query', 'path', 'header', 'cookie'] as const;\n    for (const location of locations) {\n      const locationParams = options.parameters[location];\n      if (locationParams) {\n        for (const [name, param] of Object.entries(locationParams)) {\n          parameters.push({\n            name,\n            in: location,\n            required: param.required ?? false,\n            schema: param.schema,\n          });\n        }\n      }\n    }\n  }\n  const responses: ResponsesObject = {};\n\n  for (const [key, schema] of Object.entries(options.response)) {\n    const [statusCode, contentType] = key.split(/-(.*)/); // Split on the first dash\n    if (!contentType) {\n      throw new Error(\n        `Response key \"${key}\" must be in the format \"statusCode-contentType\"`,\n      );\n    }\n    responses[statusCode] ??= {\n      description: `Response for ${statusCode}`,\n      content: {},\n    };\n\n    if (contentType === 'headers') {\n      responses[statusCode].headers = schema;\n    } else {\n      responses[statusCode].content[contentType] = {\n        schema: schema,\n      };\n    }\n  }\n\n  let requestBody: OurRequestBodyObject | undefined = undefined;\n\n  if (options.request) {\n    requestBody = { description: 'Request body', content: {} };\n\n    for (const [contentType, schema] of Object.entries(options.request)) {\n      requestBody.content[contentType] = { schema: schema };\n    }\n  }\n\n  return {\n    security: (options.security ?? []).map((name) => ({\n      [name]: [],\n    })),\n    'x-fn-name': options.name,\n    operationId: options.name,\n    tags: [options.group],\n    parameters,\n    responses,\n    requestBody: requestBody as any,\n  };\n}\n"],
+  "mappings": "AAOA,SAAS,eAAe;AAIjB,SAAS,gBAAgB,SAYP;AACvB,QAAM,aAAgC,CAAC;AACvC,MAAI,CAAC,QAAQ,QAAQ,UAAU,GAAG;AAChC,UAAM,YAAY,CAAC,SAAS,QAAQ,UAAU,QAAQ;AACtD,eAAW,YAAY,WAAW;AAChC,YAAM,iBAAiB,QAAQ,WAAW,QAAQ;AAClD,UAAI,gBAAgB;AAClB,mBAAW,CAAC,MAAM,KAAK,KAAK,OAAO,QAAQ,cAAc,GAAG;AAC1D,qBAAW,KAAK;AAAA,YACd;AAAA,YACA,IAAI;AAAA,YACJ,UAAU,MAAM,YAAY;AAAA,YAC5B,QAAQ,MAAM;AAAA,UAChB,CAAC;AAAA,QACH;AAAA,MACF;AAAA,IACF;AAAA,EACF;AACA,QAAM,YAA6B,CAAC;AAEpC,aAAW,CAAC,KAAK,MAAM,KAAK,OAAO,QAAQ,QAAQ,QAAQ,GAAG;AAC5D,UAAM,CAAC,YAAY,WAAW,IAAI,IAAI,MAAM,OAAO;AACnD,QAAI,CAAC,aAAa;AAChB,YAAM,IAAI;AAAA,QACR,iBAAiB,GAAG;AAAA,MACtB;AAAA,IACF;AACA,cAAU,UAAU,MAAM;AAAA,MACxB,aAAa,gBAAgB,UAAU;AAAA,MACvC,SAAS,CAAC;AAAA,IACZ;AAEA,QAAI,gBAAgB,WAAW;AAC7B,gBAAU,UAAU,EAAE,UAAU;AAAA,IAClC,OAAO;AACL,gBAAU,UAAU,EAAE,QAAQ,WAAW,IAAI;AAAA,QAC3C;AAAA,MACF;AAAA,IACF;AAAA,EACF;AAEA,MAAI,cAAgD;AAEpD,MAAI,QAAQ,SAAS;AACnB,kBAAc,EAAE,aAAa,gBAAgB,SAAS,CAAC,EAAE;AAEzD,eAAW,CAAC,aAAa,MAAM,KAAK,OAAO,QAAQ,QAAQ,OAAO,GAAG;AACnE,kBAAY,QAAQ,WAAW,IAAI,EAAE,OAAe;AAAA,IACtD;AAAA,EACF;AAEA,SAAO;AAAA,IACL,WAAW,QAAQ,YAAY,CAAC,GAAG,IAAI,CAAC,UAAU;AAAA,MAChD,CAAC,IAAI,GAAG,CAAC;AAAA,IACX,EAAE;AAAA,IACF,aAAa,QAAQ;AAAA,IACrB,aAAa,QAAQ;AAAA,IACrB,MAAM,CAAC,QAAQ,KAAK;AAAA,IACpB;AAAA,IACA;AAAA,IACA;AAAA,EACF;AACF;",
+  "names": []
+}

package/dist/lib/for-each-operation.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"for-each-operation.d.ts","sourceRoot":"","sources":["../../src/lib/for-each-operation.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,cAAc,EAAE,gBAAgB,EAAE,oBAAoB,EAAE,MAAM,YAAY,CAAC;AAEzF,wBAAgB,gBAAgB,CAAC,CAAC,EAChC,IAAI,EAAE,gBAAgB,EACtB,QAAQ,EAAE,CAAC,KAAK,EAAE,cAAc,EAAE,SAAS,EAAE,oBAAoB,KAAK,CAAC,OA6BxE"}
+{"version":3,"file":"for-each-operation.d.ts","sourceRoot":"","sources":["../../src/lib/for-each-operation.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,cAAc,EAAE,gBAAgB,EAAE,oBAAoB,EAAE,MAAM,YAAY,CAAC;AAEzF,wBAAgB,gBAAgB,CAAC,CAAC,EAChC,IAAI,EAAE,gBAAgB,EACtB,QAAQ,EAAE,CAAC,KAAK,EAAE,cAAc,EAAE,SAAS,EAAE,oBAAoB,KAAK,CAAC,OA0BxE"}

package/dist/lib/for-each-operation.js

@@ -6,15 +6,12 @@ function forEachOperation(spec, callback) {
       if (!methods.includes(method)) {
         continue;
       }
-      const metadata = operation["x-oaiMeta"] ?? {};
       const operationTag = operation.tags?.[0];
       result.push(
         callback(
           {
-            name: metadata.name,
             method,
             path,
-            groupName: operationTag,
             tag: operationTag
           },
           operation

package/dist/lib/for-each-operation.js.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../../src/lib/for-each-operation.ts"],
-  "sourcesContent": ["import type { OperationObject } from 'openapi3-ts/oas31';\n\nimport { type Method, methods } from '@sdk-it/core/paths.js';\n\nimport type { OperationEntry, OurOpenAPIObject, TunedOperationObject } from './types.js';\n\nexport function forEachOperation<T>(\n  spec: OurOpenAPIObject,\n  callback: (entry: OperationEntry, operation: TunedOperationObject) => T,\n) {\n  const result: T[] = [];\n  for (const [path, pathItem] of Object.entries(spec.paths)) {\n    for (const [method, operation] of Object.entries(pathItem) as [\n      Method,\n      OperationObject,\n    ][]) {\n      if (!methods.includes(method)) {\n        continue;\n      }\n      const metadata = operation['x-oaiMeta'] ?? {};\n      const operationTag = operation.tags?.[0] as string;\n\n      result.push(\n        callback(\n          {\n            name: metadata.name,\n            method,\n            path: path,\n            groupName: operationTag,\n            tag: operationTag,\n          },\n          operation as TunedOperationObject,\n        ),\n      );\n    }\n  }\n  return result;\n}\n"],
-  "mappings": "AAEA,SAAsB,eAAe;AAI9B,SAAS,iBACd,MACA,UACA;AACA,QAAM,SAAc,CAAC;AACrB,aAAW,CAAC,MAAM,QAAQ,KAAK,OAAO,QAAQ,KAAK,KAAK,GAAG;AACzD,eAAW,CAAC,QAAQ,SAAS,KAAK,OAAO,QAAQ,QAAQ,GAGpD;AACH,UAAI,CAAC,QAAQ,SAAS,MAAM,GAAG;AAC7B;AAAA,MACF;AACA,YAAM,WAAW,UAAU,WAAW,KAAK,CAAC;AAC5C,YAAM,eAAe,UAAU,OAAO,CAAC;AAEvC,aAAO;AAAA,QACL;AAAA,UACE;AAAA,YACE,MAAM,SAAS;AAAA,YACf;AAAA,YACA;AAAA,YACA,WAAW;AAAA,YACX,KAAK;AAAA,UACP;AAAA,UACA;AAAA,QACF;AAAA,MACF;AAAA,IACF;AAAA,EACF;AACA,SAAO;AACT;",
+  "sourcesContent": ["import type { OperationObject } from 'openapi3-ts/oas31';\n\nimport { type Method, methods } from '@sdk-it/core/paths.js';\n\nimport type { OperationEntry, OurOpenAPIObject, TunedOperationObject } from './types.js';\n\nexport function forEachOperation<T>(\n  spec: OurOpenAPIObject,\n  callback: (entry: OperationEntry, operation: TunedOperationObject) => T,\n) {\n  const result: T[] = [];\n  for (const [path, pathItem] of Object.entries(spec.paths)) {\n    for (const [method, operation] of Object.entries(pathItem) as [\n      Method,\n      OperationObject,\n    ][]) {\n      if (!methods.includes(method)) {\n        continue;\n      }\n      const operationTag = operation.tags?.[0] as string;\n\n      result.push(\n        callback(\n          {\n            method,\n            path: path,\n            tag: operationTag,\n          },\n          operation as TunedOperationObject,\n        ),\n      );\n    }\n  }\n  return result;\n}\n"],
+  "mappings": "AAEA,SAAsB,eAAe;AAI9B,SAAS,iBACd,MACA,UACA;AACA,QAAM,SAAc,CAAC;AACrB,aAAW,CAAC,MAAM,QAAQ,KAAK,OAAO,QAAQ,KAAK,KAAK,GAAG;AACzD,eAAW,CAAC,QAAQ,SAAS,KAAK,OAAO,QAAQ,QAAQ,GAGpD;AACH,UAAI,CAAC,QAAQ,SAAS,MAAM,GAAG;AAC7B;AAAA,MACF;AACA,YAAM,eAAe,UAAU,OAAO,CAAC;AAEvC,aAAO;AAAA,QACL;AAAA,UACE;AAAA,YACE;AAAA,YACA;AAAA,YACA,KAAK;AAAA,UACP;AAAA,UACA;AAAA,QACF;AAAA,MACF;AAAA,IACF;AAAA,EACF;AACA,SAAO;AACT;",
   "names": []
 }

package/dist/lib/guess/guess-resource.d.ts

@@ -0,0 +1,7 @@
+import type { OperationObject } from 'openapi3-ts/oas31';
+import { type Method } from '@sdk-it/core/paths.js';
+export declare function toResource(operation: OperationObject, path: string, method: Method): {
+    name: string;
+    group: string;
+};
+//# sourceMappingURL=guess-resource.d.ts.map

package/dist/lib/guess/guess-resource.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"guess-resource.d.ts","sourceRoot":"","sources":["../../../src/lib/guess/guess-resource.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAGzD,OAAO,EAAE,KAAK,MAAM,EAAE,MAAM,uBAAuB,CAAC;AAiHpD,wBAAgB,UAAU,CACxB,SAAS,EAAE,eAAe,EAC1B,IAAI,EAAE,MAAM,EACZ,MAAM,EAAE,MAAM;UApCL,MAAM;WAAS,MAAM;EAiD/B"}

package/dist/lib/guess/guess-resource.js

@@ -0,0 +1,76 @@
+import { camelcase } from "stringcase";
+import {} from "@sdk-it/core/paths.js";
+import { cleanOperationId } from "../options.js";
+const HTTP_METHOD_ACTIONS = {
+  get: { single: "get", collection: "list" },
+  post: { single: "create", collection: "create" },
+  put: { single: "replace", collection: "replaceAll" },
+  patch: { single: "update", collection: "updateMany" },
+  delete: { single: "delete", collection: "deleteMany" },
+  head: { single: "exists", collection: "checkList" },
+  options: { single: "options", collection: "optionsList" },
+  trace: { single: "trace", collection: "traceList" },
+  connect: { single: "connect", collection: "connectList" }
+};
+function extractResourceInfo(path) {
+  const pathSegments = path.split("/").filter(Boolean);
+  if (pathSegments.length === 0) {
+    return {
+      resourceName: "root",
+      isSingleResource: false,
+      resourceHierarchy: ["root"]
+    };
+  }
+  const lastSegment = pathSegments[pathSegments.length - 1];
+  const isSingleResource = lastSegment?.startsWith("{") && lastSegment?.endsWith("}");
+  let resourceName;
+  let resourceHierarchy;
+  if (isSingleResource) {
+    const parentSegment = pathSegments[pathSegments.length - 2];
+    resourceName = parentSegment || "item";
+    resourceHierarchy = pathSegments.filter((segment) => !segment.startsWith("{")).map((segment) => segment.replace(/[{}]/g, ""));
+  } else {
+    resourceName = lastSegment;
+    resourceHierarchy = pathSegments.filter((segment) => !segment.startsWith("{")).map((segment) => segment.replace(/[{}]/g, ""));
+  }
+  const cleanResourceName = resourceName.replace(/[{}]/g, "").replace(/[-_]/g, " ").replace(/[^a-zA-Z0-9\s]/g, "");
+  const hierarchicalName = resourceHierarchy.length > 1 ? resourceHierarchy.join(" ") : cleanResourceName;
+  return {
+    resourceName: cleanResourceName || "resource",
+    isSingleResource,
+    resourceHierarchy: [hierarchicalName]
+  };
+}
+function guessOperationName(method, {
+  isSingleResource,
+  resourceHierarchy
+}) {
+  const methodAction = HTTP_METHOD_ACTIONS[method.toLowerCase()];
+  if (!methodAction) {
+    const fallbackAction = isSingleResource ? method.toLowerCase() : `${method.toLowerCase()}All`;
+    return {
+      name: camelcase(fallbackAction),
+      group: camelcase(resourceHierarchy[0])
+    };
+  }
+  const actionName = isSingleResource ? methodAction.single : methodAction.collection;
+  const operationName = resourceHierarchy.length > 1 && !isSingleResource ? `${actionName} ${resourceHierarchy.slice(-1)[0]}` : actionName;
+  return {
+    name: camelcase(operationName),
+    group: camelcase(resourceHierarchy[0])
+  };
+}
+function toResource(operation, path, method) {
+  const resourceInfo = extractResourceInfo(path);
+  if (operation.operationId) {
+    return {
+      name: cleanOperationId(operation.operationId),
+      group: camelcase(resourceInfo.resourceName)
+    };
+  }
+  return guessOperationName(method, resourceInfo);
+}
+export {
+  toResource
+};
+//# sourceMappingURL=guess-resource.js.map

package/dist/lib/guess/guess-resource.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../../src/lib/guess/guess-resource.ts"],
+  "sourcesContent": ["import type { OperationObject } from 'openapi3-ts/oas31';\nimport { camelcase } from 'stringcase';\n\nimport { type Method } from '@sdk-it/core/paths.js';\n\nimport { cleanOperationId } from '../options.js';\n\nconst HTTP_METHOD_ACTIONS = {\n  get: { single: 'get', collection: 'list' },\n  post: { single: 'create', collection: 'create' },\n  put: { single: 'replace', collection: 'replaceAll' },\n  patch: { single: 'update', collection: 'updateMany' },\n  delete: { single: 'delete', collection: 'deleteMany' },\n  head: { single: 'exists', collection: 'checkList' },\n  options: { single: 'options', collection: 'optionsList' },\n  trace: { single: 'trace', collection: 'traceList' },\n  connect: { single: 'connect', collection: 'connectList' },\n} as const;\n\nfunction extractResourceInfo(path: string): {\n  resourceName: string;\n  isSingleResource: boolean;\n  resourceHierarchy: string[];\n} {\n  const pathSegments = path.split('/').filter(Boolean);\n\n  if (pathSegments.length === 0) {\n    return {\n      resourceName: 'root',\n      isSingleResource: false,\n      resourceHierarchy: ['root'],\n    };\n  }\n\n  const lastSegment = pathSegments[pathSegments.length - 1];\n  const isSingleResource =\n    lastSegment?.startsWith('{') && lastSegment?.endsWith('}');\n\n  // For single resources, use the parent resource name\n  // For collections, use the last segment\n  let resourceName: string;\n  let resourceHierarchy: string[];\n\n  if (isSingleResource) {\n    // Single resource: /users/{id} -> \"users\"\n    const parentSegment = pathSegments[pathSegments.length - 2];\n    resourceName = parentSegment || 'item';\n    resourceHierarchy = pathSegments\n      .filter((segment) => !segment.startsWith('{'))\n      .map((segment) => segment.replace(/[{}]/g, ''));\n  } else {\n    // Collection: /users or /users/active -> \"users\" or \"usersActive\"\n    resourceName = lastSegment;\n    resourceHierarchy = pathSegments\n      .filter((segment) => !segment.startsWith('{'))\n      .map((segment) => segment.replace(/[{}]/g, ''));\n  }\n\n  // Clean and normalize resource name\n  const cleanResourceName = resourceName\n    .replace(/[{}]/g, '')\n    .replace(/[-_]/g, ' ')\n    .replace(/[^a-zA-Z0-9\\s]/g, '');\n\n  // Generate a hierarchy-based group name for better conflict avoidance\n  const hierarchicalName =\n    resourceHierarchy.length > 1\n      ? resourceHierarchy.join(' ')\n      : cleanResourceName;\n\n  return {\n    resourceName: cleanResourceName || 'resource',\n    isSingleResource,\n    resourceHierarchy: [hierarchicalName],\n  };\n}\n\nfunction guessOperationName(\n  method: Method,\n  {\n    isSingleResource,\n    resourceHierarchy,\n  }: ReturnType<typeof extractResourceInfo>,\n): { name: string; group: string } {\n  const methodAction =\n    HTTP_METHOD_ACTIONS[\n      method.toLowerCase() as keyof typeof HTTP_METHOD_ACTIONS\n    ];\n\n  if (!methodAction) {\n    // Fallback for unknown HTTP methods\n    const fallbackAction = isSingleResource\n      ? method.toLowerCase()\n      : `${method.toLowerCase()}All`;\n    return {\n      name: camelcase(fallbackAction),\n      group: camelcase(resourceHierarchy[0]),\n    };\n  }\n\n  const actionName = isSingleResource\n    ? methodAction.single\n    : methodAction.collection;\n\n  // Create more descriptive names for complex paths\n  const operationName =\n    resourceHierarchy.length > 1 && !isSingleResource\n      ? `${actionName} ${resourceHierarchy.slice(-1)[0]}` // e.g., \"list activeUsers\"\n      : actionName;\n\n  return {\n    name: camelcase(operationName),\n    group: camelcase(resourceHierarchy[0]),\n  };\n}\n\nexport function toResource(\n  operation: OperationObject,\n  path: string,\n  method: Method,\n) {\n  // Priority 1: Non-guessed operationId\n  const resourceInfo = extractResourceInfo(path);\n  if (operation.operationId) {\n    return {\n      name: cleanOperationId(operation.operationId),\n      group: camelcase(resourceInfo.resourceName),\n    };\n  }\n\n  // Priority 2: CRUD operation name\n  return guessOperationName(method, resourceInfo);\n}\n"],
+  "mappings": "AACA,SAAS,iBAAiB;AAE1B,eAA4B;AAE5B,SAAS,wBAAwB;AAEjC,MAAM,sBAAsB;AAAA,EAC1B,KAAK,EAAE,QAAQ,OAAO,YAAY,OAAO;AAAA,EACzC,MAAM,EAAE,QAAQ,UAAU,YAAY,SAAS;AAAA,EAC/C,KAAK,EAAE,QAAQ,WAAW,YAAY,aAAa;AAAA,EACnD,OAAO,EAAE,QAAQ,UAAU,YAAY,aAAa;AAAA,EACpD,QAAQ,EAAE,QAAQ,UAAU,YAAY,aAAa;AAAA,EACrD,MAAM,EAAE,QAAQ,UAAU,YAAY,YAAY;AAAA,EAClD,SAAS,EAAE,QAAQ,WAAW,YAAY,cAAc;AAAA,EACxD,OAAO,EAAE,QAAQ,SAAS,YAAY,YAAY;AAAA,EAClD,SAAS,EAAE,QAAQ,WAAW,YAAY,cAAc;AAC1D;AAEA,SAAS,oBAAoB,MAI3B;AACA,QAAM,eAAe,KAAK,MAAM,GAAG,EAAE,OAAO,OAAO;AAEnD,MAAI,aAAa,WAAW,GAAG;AAC7B,WAAO;AAAA,MACL,cAAc;AAAA,MACd,kBAAkB;AAAA,MAClB,mBAAmB,CAAC,MAAM;AAAA,IAC5B;AAAA,EACF;AAEA,QAAM,cAAc,aAAa,aAAa,SAAS,CAAC;AACxD,QAAM,mBACJ,aAAa,WAAW,GAAG,KAAK,aAAa,SAAS,GAAG;AAI3D,MAAI;AACJ,MAAI;AAEJ,MAAI,kBAAkB;AAEpB,UAAM,gBAAgB,aAAa,aAAa,SAAS,CAAC;AAC1D,mBAAe,iBAAiB;AAChC,wBAAoB,aACjB,OAAO,CAAC,YAAY,CAAC,QAAQ,WAAW,GAAG,CAAC,EAC5C,IAAI,CAAC,YAAY,QAAQ,QAAQ,SAAS,EAAE,CAAC;AAAA,EAClD,OAAO;AAEL,mBAAe;AACf,wBAAoB,aACjB,OAAO,CAAC,YAAY,CAAC,QAAQ,WAAW,GAAG,CAAC,EAC5C,IAAI,CAAC,YAAY,QAAQ,QAAQ,SAAS,EAAE,CAAC;AAAA,EAClD;AAGA,QAAM,oBAAoB,aACvB,QAAQ,SAAS,EAAE,EACnB,QAAQ,SAAS,GAAG,EACpB,QAAQ,mBAAmB,EAAE;AAGhC,QAAM,mBACJ,kBAAkB,SAAS,IACvB,kBAAkB,KAAK,GAAG,IAC1B;AAEN,SAAO;AAAA,IACL,cAAc,qBAAqB;AAAA,IACnC;AAAA,IACA,mBAAmB,CAAC,gBAAgB;AAAA,EACtC;AACF;AAEA,SAAS,mBACP,QACA;AAAA,EACE;AAAA,EACA;AACF,GACiC;AACjC,QAAM,eACJ,oBACE,OAAO,YAAY,CACrB;AAEF,MAAI,CAAC,cAAc;AAEjB,UAAM,iBAAiB,mBACnB,OAAO,YAAY,IACnB,GAAG,OAAO,YAAY,CAAC;AAC3B,WAAO;AAAA,MACL,MAAM,UAAU,cAAc;AAAA,MAC9B,OAAO,UAAU,kBAAkB,CAAC,CAAC;AAAA,IACvC;AAAA,EACF;AAEA,QAAM,aAAa,mBACf,aAAa,SACb,aAAa;AAGjB,QAAM,gBACJ,kBAAkB,SAAS,KAAK,CAAC,mBAC7B,GAAG,UAAU,IAAI,kBAAkB,MAAM,EAAE,EAAE,CAAC,CAAC,KAC/C;AAEN,SAAO;AAAA,IACL,MAAM,UAAU,aAAa;AAAA,IAC7B,OAAO,UAAU,kBAAkB,CAAC,CAAC;AAAA,EACvC;AACF;AAEO,SAAS,WACd,WACA,MACA,QACA;AAEA,QAAM,eAAe,oBAAoB,IAAI;AAC7C,MAAI,UAAU,aAAa;AACzB,WAAO;AAAA,MACL,MAAM,iBAAiB,UAAU,WAAW;AAAA,MAC5C,OAAO,UAAU,aAAa,YAAY;AAAA,IAC5C;AAAA,EACF;AAGA,SAAO,mBAAmB,QAAQ,YAAY;AAChD;",
+  "names": []
+}