@ir-kit/spec-loader 0.2.1 → 0.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.d.ts +4 -2
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +20 -32
- package/dist/index.js.map +1 -1
- package/package.json +4 -4
package/dist/index.d.ts
CHANGED
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
import type { AsyncAPIDocumentInterface } from "@asyncapi/parser";
|
|
2
2
|
import { type AsyncAPIInput, type LoadAsyncAPIOptions, loadAsyncAPI } from "@ir-kit/asyncapi-loader";
|
|
3
|
-
import { type LoadOpenAPIOptions, loadOpenAPI, type OpenAPIInput, resolveOpenAPIInput } from "@ir-kit/openapi-loader";
|
|
3
|
+
import { type LoadOpenAPIOptions, loadOpenAPI, type OpenAPIInput, readSpecDocument, resolveOpenAPIInput } from "@ir-kit/openapi-loader";
|
|
4
4
|
import { type CompileTypespecOptions, compileTypespec, isTypespecPath } from "@ir-kit/typespec-loader";
|
|
5
5
|
export type { AsyncAPIInput, LoadAsyncAPIOptions, LoadOpenAPIOptions, OpenAPIInput, };
|
|
6
|
-
export { compileTypespec, isTypespecPath, loadAsyncAPI, loadOpenAPI, resolveOpenAPIInput, };
|
|
6
|
+
export { compileTypespec, isTypespecPath, loadAsyncAPI, loadOpenAPI, readSpecDocument, resolveOpenAPIInput, };
|
|
7
7
|
export type SpecKind = "openapi" | "asyncapi" | "typespec";
|
|
8
8
|
export type SpecInput = string | Record<string, unknown> | AsyncAPIDocumentInterface;
|
|
9
9
|
export interface LoadSpecOptions extends CompileTypespecOptions {
|
|
@@ -28,4 +28,6 @@ export type LoadSpecResult = {
|
|
|
28
28
|
* classified by the `asyncapi` / `openapi` / `swagger` top-level key.
|
|
29
29
|
*/
|
|
30
30
|
export declare function loadSpec(opts: LoadSpecOptions): Promise<LoadSpecResult>;
|
|
31
|
+
/** Classify a parsed document by its root version field. */
|
|
32
|
+
export declare function classifySpecDocument(document: Record<string, unknown>): "openapi" | "asyncapi" | undefined;
|
|
31
33
|
//# sourceMappingURL=index.d.ts.map
|
package/dist/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,kBAAkB,CAAC;AAClE,OAAO,EACL,KAAK,aAAa,EAClB,KAAK,mBAAmB,EACxB,YAAY,EACb,MAAM,yBAAyB,CAAC;AACjC,OAAO,EACL,KAAK,kBAAkB,EACvB,WAAW,EACX,KAAK,YAAY,EACjB,gBAAgB,EAChB,mBAAmB,EACpB,MAAM,wBAAwB,CAAC;AAChC,OAAO,EACL,KAAK,sBAAsB,EAC3B,eAAe,EACf,cAAc,EACf,MAAM,yBAAyB,CAAC;AAEjC,YAAY,EACV,aAAa,EACb,mBAAmB,EACnB,kBAAkB,EAClB,YAAY,GACb,CAAC;AACF,OAAO,EACL,eAAe,EACf,cAAc,EACd,YAAY,EACZ,WAAW,EACX,gBAAgB,EAChB,mBAAmB,GACpB,CAAC;AAEF,MAAM,MAAM,QAAQ,GAAG,SAAS,GAAG,UAAU,GAAG,UAAU,CAAC;AAE3D,MAAM,MAAM,SAAS,GACjB,MAAM,GACN,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GACvB,yBAAyB,CAAC;AAE9B,MAAM,WAAW,eAAgB,SAAQ,sBAAsB;IAC7D,KAAK,EAAE,SAAS,CAAC;IACjB;6EACyE;IACzE,IAAI,CAAC,EAAE,QAAQ,CAAC;IAChB,kEAAkE;IAClE,SAAS,CAAC,EAAE,kBAAkB,CAAC,WAAW,CAAC,CAAC;CAC7C;AAED,MAAM,MAAM,cAAc,GACtB;IAAE,IAAI,EAAE,SAAS,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CAAE,GACtD;IAAE,IAAI,EAAE,UAAU,CAAC;IAAC,QAAQ,EAAE,yBAAyB,CAAA;CAAE,CAAC;AAE9D;;;;;GAKG;AACH,wBAAsB,QAAQ,CAAC,IAAI,EAAE,eAAe,GAAG,OAAO,CAAC,cAAc,CAAC,CA0C7E;AAED,4DAA4D;AAC5D,wBAAgB,oBAAoB,CAClC,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAChC,SAAS,GAAG,UAAU,GAAG,SAAS,CAKpC"}
|
package/dist/index.js
CHANGED
|
@@ -1,9 +1,7 @@
|
|
|
1
|
-
import { readFile } from "node:fs/promises";
|
|
2
|
-
import { isAbsolute, resolve } from "node:path";
|
|
3
1
|
import { loadAsyncAPI, } from "@ir-kit/asyncapi-loader";
|
|
4
|
-
import { loadOpenAPI, resolveOpenAPIInput, } from "@ir-kit/openapi-loader";
|
|
2
|
+
import { loadOpenAPI, readSpecDocument, resolveOpenAPIInput, } from "@ir-kit/openapi-loader";
|
|
5
3
|
import { compileTypespec, isTypespecPath, } from "@ir-kit/typespec-loader";
|
|
6
|
-
export { compileTypespec, isTypespecPath, loadAsyncAPI, loadOpenAPI, resolveOpenAPIInput, };
|
|
4
|
+
export { compileTypespec, isTypespecPath, loadAsyncAPI, loadOpenAPI, readSpecDocument, resolveOpenAPIInput, };
|
|
7
5
|
/**
|
|
8
6
|
* Detect the spec format and dispatch to the matching per-format loader.
|
|
9
7
|
* TypeSpec inputs compile to OpenAPI 3 in-memory and return as
|
|
@@ -44,38 +42,28 @@ export async function loadSpec(opts) {
|
|
|
44
42
|
});
|
|
45
43
|
return { kind: "openapi", document };
|
|
46
44
|
}
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
}
|
|
51
|
-
const str = input;
|
|
52
|
-
if (/\.tsp$/i.test(str.trim()))
|
|
53
|
-
return "typespec";
|
|
54
|
-
const trimmed = str.trim();
|
|
55
|
-
if (/^https?:\/\//i.test(trimmed)) {
|
|
56
|
-
return sniffKindFromString(await fetchHead(trimmed));
|
|
57
|
-
}
|
|
58
|
-
const path = isAbsolute(trimmed)
|
|
59
|
-
? trimmed
|
|
60
|
-
: resolve(cwd ?? process.cwd(), trimmed);
|
|
61
|
-
return sniffKindFromString(await readFile(path, "utf8"));
|
|
62
|
-
}
|
|
63
|
-
function sniffKindFromString(text) {
|
|
64
|
-
const head = text.slice(0, 2048);
|
|
65
|
-
if (/(^|\n)\s*"?asyncapi"?\s*:/.test(head))
|
|
45
|
+
/** Classify a parsed document by its root version field. */
|
|
46
|
+
export function classifySpecDocument(document) {
|
|
47
|
+
if (document.asyncapi !== undefined)
|
|
66
48
|
return "asyncapi";
|
|
67
|
-
if (
|
|
49
|
+
if (document.openapi !== undefined || document.swagger !== undefined)
|
|
68
50
|
return "openapi";
|
|
69
|
-
|
|
70
|
-
return "openapi";
|
|
71
|
-
return "openapi";
|
|
51
|
+
return undefined;
|
|
72
52
|
}
|
|
73
|
-
async function
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
53
|
+
async function detectKind(input, cwd) {
|
|
54
|
+
if (isAsyncAPIDocument(input))
|
|
55
|
+
return "asyncapi";
|
|
56
|
+
if (typeof input === "string" && isTypespecPath(input.trim()))
|
|
57
|
+
return "typespec";
|
|
58
|
+
const document = typeof input === "string" ? await readSpecDocument(input, cwd) : input;
|
|
59
|
+
const kind = isPlainOpenAPIObject(document)
|
|
60
|
+
? classifySpecDocument(document)
|
|
61
|
+
: undefined;
|
|
62
|
+
if (!kind) {
|
|
63
|
+
const label = typeof input === "string" ? ` ${input}` : "";
|
|
64
|
+
throw new Error(`Unrecognized spec${label}: expected a top-level "openapi", "swagger" or "asyncapi" field.`);
|
|
77
65
|
}
|
|
78
|
-
return
|
|
66
|
+
return kind;
|
|
79
67
|
}
|
|
80
68
|
function isAsyncAPIDocument(value) {
|
|
81
69
|
return (typeof value === "object" &&
|
package/dist/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,EAGL,YAAY,GACb,MAAM,yBAAyB,CAAC;AACjC,OAAO,EAEL,WAAW,EAEX,gBAAgB,EAChB,mBAAmB,GACpB,MAAM,wBAAwB,CAAC;AAChC,OAAO,EAEL,eAAe,EACf,cAAc,GACf,MAAM,yBAAyB,CAAC;AAQjC,OAAO,EACL,eAAe,EACf,cAAc,EACd,YAAY,EACZ,WAAW,EACX,gBAAgB,EAChB,mBAAmB,GACpB,CAAC;AAsBF;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,QAAQ,CAAC,IAAqB;IAClD,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,IAAI,CAAC,MAAM,UAAU,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;IAEnE,IAAI,IAAI,KAAK,UAAU,EAAE,CAAC;QACxB,MAAM,IAAI,GAAG,OAAO,IAAI,CAAC,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC;QAC9D,IAAI,CAAC,IAAI,EAAE,CAAC;YACV,MAAM,IAAI,KAAK,CAAC,mDAAmD,CAAC,CAAC;QACvE,CAAC;QACD,MAAM,EAAE,QAAQ,EAAE,GAAG,MAAM,eAAe,CAAC,EAAE,IAAI,EAAE,EAAE,IAAI,CAAC,CAAC;QAC3D,OAAO;YACL,IAAI,EAAE,SAAS;YACf,QAAQ,EAAE,QAA8C;SACzD,CAAC;IACJ,CAAC;IAED,IAAI,IAAI,KAAK,UAAU,EAAE,CAAC;QACxB,IAAI,OAAO,IAAI,CAAC,KAAK,KAAK,QAAQ,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;YACtE,MAAM,IAAI,KAAK,CACb,0EAA0E,CAC3E,CAAC;QACJ,CAAC;QACD,MAAM,QAAQ,GAAG,MAAM,YAAY,CAAC;YAClC,KAAK,EAAE,IAAI,CAAC,KAAsB;YAClC,GAAG,EAAE,IAAI,CAAC,GAAG;SACd,CAAC,CAAC;QACH,OAAO,EAAE,IAAI,EAAE,UAAU,EAAE,QAAQ,EAAE,CAAC;IACxC,CAAC;IAED,IACE,OAAO,IAAI,CAAC,KAAK,KAAK,QAAQ;QAC9B,CAAC,oBAAoB,CAAC,IAAI,CAAC,KAAgC,CAAC,EAC5D,CAAC;QACD,MAAM,IAAI,KAAK,CACb,2DAA2D,CAC5D,CAAC;IACJ,CAAC;IACD,MAAM,QAAQ,GAAG,MAAM,WAAW,CAAC;QACjC,KAAK,EAAE,IAAI,CAAC,KAAqB;QACjC,GAAG,EAAE,IAAI,CAAC,GAAG;QACb,SAAS,EAAE,IAAI,CAAC,SAAS;KAC1B,CAAC,CAAC;IACH,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,QAAQ,EAAE,CAAC;AACvC,CAAC;AAED,4DAA4D;AAC5D,MAAM,UAAU,oBAAoB,CAClC,QAAiC;IAEjC,IAAI,QAAQ,CAAC,QAAQ,KAAK,SAAS;QAAE,OAAO,UAAU,CAAC;IACvD,IAAI,QAAQ,CAAC,OAAO,KAAK,SAAS,IAAI,QAAQ,CAAC,OAAO,KAAK,SAAS;QAClE,OAAO,SAAS,CAAC;IACnB,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,KAAK,UAAU,UAAU,CACvB,KAAgB,EAChB,GAAuB;IAEvB,IAAI,kBAAkB,CAAC,KAAK,CAAC;QAAE,OAAO,UAAU,CAAC;IACjD,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,cAAc,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC;QAC3D,OAAO,UAAU,CAAC;IACpB,MAAM,QAAQ,GACZ,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,MAAM,gBAAgB,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;IACzE,MAAM,IAAI,GAAG,oBAAoB,CAAC,QAAQ,CAAC;QACzC,CAAC,CAAC,oBAAoB,CAAC,QAAQ,CAAC;QAChC,CAAC,CAAC,SAAS,CAAC;IACd,IAAI,CAAC,IAAI,EAAE,CAAC;QACV,MAAM,KAAK,GAAG,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAC3D,MAAM,IAAI,KAAK,CACb,oBAAoB,KAAK,kEAAkE,CAC5F,CAAC;IACJ,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAED,SAAS,kBAAkB,CACzB,KAAc;IAEd,OAAO,CACL,OAAO,KAAK,KAAK,QAAQ;QACzB,KAAK,KAAK,IAAI;QACd,OAAQ,KAA4B,CAAC,IAAI,KAAK,UAAU;QACxD,OAAQ,KAA+B,CAAC,OAAO,KAAK,UAAU,CAC/D,CAAC;AACJ,CAAC;AAED,SAAS,oBAAoB,CAC3B,KAAc;IAEd,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;AAC9E,CAAC"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@ir-kit/spec-loader",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.3.0",
|
|
4
4
|
"description": "Universal spec loader for OpenAPI, AsyncAPI, and TypeSpec. Detects format by extension + content sniff and dispatches to the per-format loader, returning a discriminated `{ kind, document }` result.",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"openapi",
|
|
@@ -48,9 +48,9 @@
|
|
|
48
48
|
"@asyncapi/parser": "^3.6.0"
|
|
49
49
|
},
|
|
50
50
|
"dependencies": {
|
|
51
|
-
"@ir-kit/asyncapi-loader": "0.2.
|
|
52
|
-
"@ir-kit/
|
|
53
|
-
"@ir-kit/
|
|
51
|
+
"@ir-kit/asyncapi-loader": "0.2.1",
|
|
52
|
+
"@ir-kit/openapi-loader": "0.4.0",
|
|
53
|
+
"@ir-kit/typespec-loader": "0.2.1"
|
|
54
54
|
},
|
|
55
55
|
"devDependencies": {
|
|
56
56
|
"@asyncapi/parser": "^3.6.0",
|