@ir-kit/openapi-tools 0.1.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/LICENSE.md +21 -0
- package/README.md +48 -0
- package/dist/diff.d.ts +65 -0
- package/dist/diff.d.ts.map +1 -0
- package/dist/diff.js +296 -0
- package/dist/diff.js.map +1 -0
- package/dist/index.d.ts +10 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +8 -0
- package/dist/index.js.map +1 -0
- package/dist/ir.d.ts +5 -0
- package/dist/ir.d.ts.map +1 -0
- package/dist/ir.js +36 -0
- package/dist/ir.js.map +1 -0
- package/dist/load.d.ts +27 -0
- package/dist/load.d.ts.map +1 -0
- package/dist/load.js +38 -0
- package/dist/load.js.map +1 -0
- package/dist/match.d.ts +20 -0
- package/dist/match.d.ts.map +1 -0
- package/dist/match.js +60 -0
- package/dist/match.js.map +1 -0
- package/dist/merge/components.d.ts +7 -0
- package/dist/merge/components.d.ts.map +1 -0
- package/dist/merge/components.js +86 -0
- package/dist/merge/components.js.map +1 -0
- package/dist/merge/core.d.ts +3 -0
- package/dist/merge/core.d.ts.map +1 -0
- package/dist/merge/core.js +181 -0
- package/dist/merge/core.js.map +1 -0
- package/dist/merge/paths.d.ts +9 -0
- package/dist/merge/paths.d.ts.map +1 -0
- package/dist/merge/paths.js +43 -0
- package/dist/merge/paths.js.map +1 -0
- package/dist/merge/refs.d.ts +3 -0
- package/dist/merge/refs.d.ts.map +1 -0
- package/dist/merge/refs.js +34 -0
- package/dist/merge/refs.js.map +1 -0
- package/dist/merge/types.d.ts +55 -0
- package/dist/merge/types.d.ts.map +1 -0
- package/dist/merge/types.js +2 -0
- package/dist/merge/types.js.map +1 -0
- package/dist/merge.d.ts +5 -0
- package/dist/merge.d.ts.map +1 -0
- package/dist/merge.js +4 -0
- package/dist/merge.js.map +1 -0
- package/dist/parse.d.ts +7 -0
- package/dist/parse.d.ts.map +1 -0
- package/dist/parse.js +23 -0
- package/dist/parse.js.map +1 -0
- package/dist/route.d.ts +17 -0
- package/dist/route.d.ts.map +1 -0
- package/dist/route.js +2 -0
- package/dist/route.js.map +1 -0
- package/dist/router.d.ts +22 -0
- package/dist/router.d.ts.map +1 -0
- package/dist/router.js +40 -0
- package/dist/router.js.map +1 -0
- package/dist/schema.d.ts +7 -0
- package/dist/schema.d.ts.map +1 -0
- package/dist/schema.js +15 -0
- package/dist/schema.js.map +1 -0
- package/package.json +104 -0
package/dist/route.js
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"route.js","sourceRoot":"","sources":["../src/route.ts"],"names":[],"mappings":""}
|
package/dist/router.d.ts
ADDED
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
import type { ExtractParams } from "./match.js";
|
|
2
|
+
import type { Route } from "./route.js";
|
|
3
|
+
type RouteHandler<R extends Route, TResult = unknown> = (request: Request, params: ExtractParams<R["spec"]>) => TResult | Promise<TResult>;
|
|
4
|
+
export interface Router {
|
|
5
|
+
/** Register a handler for a route. Handler's `params` is typed from the route's `spec`. */
|
|
6
|
+
on<R extends Route>(route: R, handler: RouteHandler<R>): Router;
|
|
7
|
+
/** Match + dispatch. Returns handler's return value, or `undefined` if unmatched. */
|
|
8
|
+
handle(request: Request): Promise<unknown> | undefined;
|
|
9
|
+
}
|
|
10
|
+
/**
|
|
11
|
+
* Create a router that dispatches matched requests to typed handlers.
|
|
12
|
+
*
|
|
13
|
+
* @example
|
|
14
|
+
* ```ts
|
|
15
|
+
* createRouter()
|
|
16
|
+
* .on(getPetByIdRoute, (req, { petId }) => fetchPet(petId))
|
|
17
|
+
* .handle(request);
|
|
18
|
+
* ```
|
|
19
|
+
*/
|
|
20
|
+
export declare function createRouter(): Router;
|
|
21
|
+
export {};
|
|
22
|
+
//# sourceMappingURL=router.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"router.d.ts","sourceRoot":"","sources":["../src/router.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AAEhD,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AAExC,KAAK,YAAY,CAAC,CAAC,SAAS,KAAK,EAAE,OAAO,GAAG,OAAO,IAAI,CACtD,OAAO,EAAE,OAAO,EAChB,MAAM,EAAE,aAAa,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,KAC7B,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;AAEhC,MAAM,WAAW,MAAM;IACrB,2FAA2F;IAC3F,EAAE,CAAC,CAAC,SAAS,KAAK,EAAE,KAAK,EAAE,CAAC,EAAE,OAAO,EAAE,YAAY,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC;IAChE,qFAAqF;IACrF,MAAM,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,GAAG,SAAS,CAAC;CACxD;AAMD;;;;;;;;;GASG;AACH,wBAAgB,YAAY,IAAI,MAAM,CAwBrC"}
|
package/dist/router.js
ADDED
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
import { match } from "./match.js";
|
|
2
|
+
function key(method, spec) {
|
|
3
|
+
return `${method.toLowerCase()} ${spec}`;
|
|
4
|
+
}
|
|
5
|
+
/**
|
|
6
|
+
* Create a router that dispatches matched requests to typed handlers.
|
|
7
|
+
*
|
|
8
|
+
* @example
|
|
9
|
+
* ```ts
|
|
10
|
+
* createRouter()
|
|
11
|
+
* .on(getPetByIdRoute, (req, { petId }) => fetchPet(petId))
|
|
12
|
+
* .handle(request);
|
|
13
|
+
* ```
|
|
14
|
+
*/
|
|
15
|
+
export function createRouter() {
|
|
16
|
+
// Reassign (not push) so the array identity changes and `match()`'s WeakMap cache busts.
|
|
17
|
+
let routes = [];
|
|
18
|
+
// biome-ignore lint/suspicious/noExplicitAny: handler stored generically
|
|
19
|
+
const handlers = new Map();
|
|
20
|
+
const router = {
|
|
21
|
+
on(route, handler) {
|
|
22
|
+
routes = [...routes, route];
|
|
23
|
+
handlers.set(key(route.method, route.spec), handler);
|
|
24
|
+
return router;
|
|
25
|
+
},
|
|
26
|
+
handle(request) {
|
|
27
|
+
const m = match(routes, request);
|
|
28
|
+
if (!m)
|
|
29
|
+
return undefined;
|
|
30
|
+
const handler = handlers.get(key(m.method, m.spec));
|
|
31
|
+
if (!handler)
|
|
32
|
+
return undefined;
|
|
33
|
+
return Promise.resolve(
|
|
34
|
+
// biome-ignore lint/suspicious/noExplicitAny: erasure at boundary
|
|
35
|
+
handler(request, m.params));
|
|
36
|
+
},
|
|
37
|
+
};
|
|
38
|
+
return router;
|
|
39
|
+
}
|
|
40
|
+
//# sourceMappingURL=router.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"router.js","sourceRoot":"","sources":["../src/router.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AAenC,SAAS,GAAG,CAAC,MAAc,EAAE,IAAY;IACvC,OAAO,GAAG,MAAM,CAAC,WAAW,EAAE,IAAI,IAAI,EAAE,CAAC;AAC3C,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,UAAU,YAAY;IAC1B,yFAAyF;IACzF,IAAI,MAAM,GAAqB,EAAE,CAAC;IAClC,yEAAyE;IACzE,MAAM,QAAQ,GAAG,IAAI,GAAG,EAAoC,CAAC;IAE7D,MAAM,MAAM,GAAW;QACrB,EAAE,CAAC,KAAK,EAAE,OAAO;YACf,MAAM,GAAG,CAAC,GAAG,MAAM,EAAE,KAAK,CAAC,CAAC;YAC5B,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC,KAAK,CAAC,MAAM,EAAE,KAAK,CAAC,IAAI,CAAC,EAAE,OAAgB,CAAC,CAAC;YAC9D,OAAO,MAAM,CAAC;QAChB,CAAC;QACD,MAAM,CAAC,OAAO;YACZ,MAAM,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;YACjC,IAAI,CAAC,CAAC;gBAAE,OAAO,SAAS,CAAC;YACzB,MAAM,OAAO,GAAG,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;YACpD,IAAI,CAAC,OAAO;gBAAE,OAAO,SAAS,CAAC;YAC/B,OAAO,OAAO,CAAC,OAAO;YACpB,kEAAkE;YAClE,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC,MAAa,CAAC,CAClC,CAAC;QACJ,CAAC;KACF,CAAC;IACF,OAAO,MAAM,CAAC;AAChB,CAAC"}
|
package/dist/schema.d.ts
ADDED
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
import type { IR } from "@hey-api/shared";
|
|
2
|
+
export type EnumLiteral = string | number | boolean;
|
|
3
|
+
export declare function getEnumLiterals(schema: IR.SchemaObject): EnumLiteral[];
|
|
4
|
+
export declare function isEnumSchema(schema: IR.SchemaObject): boolean;
|
|
5
|
+
/** anyOf / oneOf / allOf — items present, concrete type absent. */
|
|
6
|
+
export declare function isUnionSchema(schema: IR.SchemaObject): boolean;
|
|
7
|
+
//# sourceMappingURL=schema.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"schema.d.ts","sourceRoot":"","sources":["../src/schema.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,EAAE,EAAE,MAAM,iBAAiB,CAAC;AAE1C,MAAM,MAAM,WAAW,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC;AAEpD,wBAAgB,eAAe,CAAC,MAAM,EAAE,EAAE,CAAC,YAAY,GAAG,WAAW,EAAE,CAStE;AAED,wBAAgB,YAAY,CAAC,MAAM,EAAE,EAAE,CAAC,YAAY,GAAG,OAAO,CAE7D;AAED,mEAAmE;AACnE,wBAAgB,aAAa,CAAC,MAAM,EAAE,EAAE,CAAC,YAAY,GAAG,OAAO,CAE9D"}
|
package/dist/schema.js
ADDED
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
export function getEnumLiterals(schema) {
|
|
2
|
+
return (schema.items ?? [])
|
|
3
|
+
.map((i) => i.const)
|
|
4
|
+
.filter((v) => typeof v === "string" ||
|
|
5
|
+
typeof v === "number" ||
|
|
6
|
+
typeof v === "boolean");
|
|
7
|
+
}
|
|
8
|
+
export function isEnumSchema(schema) {
|
|
9
|
+
return schema.type === "enum";
|
|
10
|
+
}
|
|
11
|
+
/** anyOf / oneOf / allOf — items present, concrete type absent. */
|
|
12
|
+
export function isUnionSchema(schema) {
|
|
13
|
+
return Boolean(schema.items && schema.items.length > 0 && !schema.type);
|
|
14
|
+
}
|
|
15
|
+
//# sourceMappingURL=schema.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"schema.js","sourceRoot":"","sources":["../src/schema.ts"],"names":[],"mappings":"AAIA,MAAM,UAAU,eAAe,CAAC,MAAuB;IACrD,OAAO,CAAC,MAAM,CAAC,KAAK,IAAI,EAAE,CAAC;SACxB,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC;SACnB,MAAM,CACL,CAAC,CAAC,EAAoB,EAAE,CACtB,OAAO,CAAC,KAAK,QAAQ;QACrB,OAAO,CAAC,KAAK,QAAQ;QACrB,OAAO,CAAC,KAAK,SAAS,CACzB,CAAC;AACN,CAAC;AAED,MAAM,UAAU,YAAY,CAAC,MAAuB;IAClD,OAAO,MAAM,CAAC,IAAI,KAAK,MAAM,CAAC;AAChC,CAAC;AAED,mEAAmE;AACnE,MAAM,UAAU,aAAa,CAAC,MAAuB;IACnD,OAAO,OAAO,CAAC,MAAM,CAAC,KAAK,IAAI,MAAM,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;AAC1E,CAAC"}
|
package/package.json
ADDED
|
@@ -0,0 +1,104 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@ir-kit/openapi-tools",
|
|
3
|
+
"version": "0.1.0",
|
|
4
|
+
"description": "OpenAPI utilities — request matching, spec diffing, parsing. Tree-shakable, pure functions, works on frontend or backend",
|
|
5
|
+
"keywords": [
|
|
6
|
+
"openapi",
|
|
7
|
+
"matcher",
|
|
8
|
+
"url-pattern",
|
|
9
|
+
"diff",
|
|
10
|
+
"parser",
|
|
11
|
+
"spec",
|
|
12
|
+
"tooling",
|
|
13
|
+
"typescript"
|
|
14
|
+
],
|
|
15
|
+
"homepage": "https://github.com/ir-kit/ir-kit/tree/main/packages/openapi/tools",
|
|
16
|
+
"bugs": {
|
|
17
|
+
"url": "https://github.com/ir-kit/ir-kit/issues"
|
|
18
|
+
},
|
|
19
|
+
"license": "MIT",
|
|
20
|
+
"author": {
|
|
21
|
+
"name": "Ahmed Rowaihi",
|
|
22
|
+
"email": "ahmedrowaihi@gmail.com"
|
|
23
|
+
},
|
|
24
|
+
"repository": {
|
|
25
|
+
"type": "git",
|
|
26
|
+
"url": "git+https://github.com/ir-kit/ir-kit.git",
|
|
27
|
+
"directory": "packages/openapi/tools"
|
|
28
|
+
},
|
|
29
|
+
"type": "module",
|
|
30
|
+
"sideEffects": false,
|
|
31
|
+
"main": "./dist/index.js",
|
|
32
|
+
"types": "./dist/index.d.ts",
|
|
33
|
+
"exports": {
|
|
34
|
+
".": {
|
|
35
|
+
"types": "./dist/index.d.ts",
|
|
36
|
+
"import": "./dist/index.js"
|
|
37
|
+
},
|
|
38
|
+
"./match": {
|
|
39
|
+
"types": "./dist/match.d.ts",
|
|
40
|
+
"import": "./dist/match.js"
|
|
41
|
+
},
|
|
42
|
+
"./router": {
|
|
43
|
+
"types": "./dist/router.d.ts",
|
|
44
|
+
"import": "./dist/router.js"
|
|
45
|
+
},
|
|
46
|
+
"./parse": {
|
|
47
|
+
"types": "./dist/parse.d.ts",
|
|
48
|
+
"import": "./dist/parse.js"
|
|
49
|
+
},
|
|
50
|
+
"./diff": {
|
|
51
|
+
"types": "./dist/diff.d.ts",
|
|
52
|
+
"import": "./dist/diff.js"
|
|
53
|
+
},
|
|
54
|
+
"./ir": {
|
|
55
|
+
"types": "./dist/ir.d.ts",
|
|
56
|
+
"import": "./dist/ir.js"
|
|
57
|
+
},
|
|
58
|
+
"./route": {
|
|
59
|
+
"types": "./dist/route.d.ts",
|
|
60
|
+
"import": "./dist/route.js"
|
|
61
|
+
},
|
|
62
|
+
"./merge": {
|
|
63
|
+
"types": "./dist/merge.d.ts",
|
|
64
|
+
"import": "./dist/merge.js"
|
|
65
|
+
},
|
|
66
|
+
"./package.json": "./package.json"
|
|
67
|
+
},
|
|
68
|
+
"files": [
|
|
69
|
+
"dist",
|
|
70
|
+
"README.md",
|
|
71
|
+
"LICENSE.md"
|
|
72
|
+
],
|
|
73
|
+
"publishConfig": {
|
|
74
|
+
"access": "public",
|
|
75
|
+
"provenance": true
|
|
76
|
+
},
|
|
77
|
+
"peerDependencies": {
|
|
78
|
+
"@hey-api/codegen-core": ">=0.7.0",
|
|
79
|
+
"@hey-api/shared": ">=0.3.0",
|
|
80
|
+
"@hey-api/spec-types": ">=0.2.0"
|
|
81
|
+
},
|
|
82
|
+
"dependencies": {
|
|
83
|
+
"@hey-api/json-schema-ref-parser": "^1.4.1",
|
|
84
|
+
"urlpattern-polyfill": "^10.1.0",
|
|
85
|
+
"@ir-kit/openapi-core": "0.1.0"
|
|
86
|
+
},
|
|
87
|
+
"devDependencies": {
|
|
88
|
+
"@hey-api/codegen-core": "^0.8.1",
|
|
89
|
+
"@hey-api/shared": "^0.4.2",
|
|
90
|
+
"@hey-api/spec-types": "^0.2.0",
|
|
91
|
+
"@types/node": "^22",
|
|
92
|
+
"vitest": "^4.0.0",
|
|
93
|
+
"@ir-kit/tsconfig": "0.0.0"
|
|
94
|
+
},
|
|
95
|
+
"engines": {
|
|
96
|
+
"node": ">=20.19.0"
|
|
97
|
+
},
|
|
98
|
+
"scripts": {
|
|
99
|
+
"build": "tsc -p tsconfig.build.json",
|
|
100
|
+
"dev": "tsc -p tsconfig.build.json --watch",
|
|
101
|
+
"typecheck": "tsc --noEmit",
|
|
102
|
+
"test": "vitest run --passWithNoTests"
|
|
103
|
+
}
|
|
104
|
+
}
|