@ir-kit/openapi-ts-paths 0.1.0

package/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Ahmed Rowaihi
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,77 @@
+# @ir-kit/openapi-ts-paths
+
+Per-operation route consts emitted from an OpenAPI spec — spec template, URLPattern-style pattern, method, and operationId, ready for tree-shakable runtime routing and matching. Plugin for [`@hey-api/openapi-ts`](https://heyapi.dev).
+
+## Install
+
+```bash
+npm install -D @ir-kit/openapi-ts-paths @hey-api/openapi-ts
+```
+
+## Use
+
+```ts
+import { defineConfig } from "@hey-api/openapi-ts";
+import { defineConfig as definePathsConfig } from "@ir-kit/openapi-ts-paths";
+
+export default defineConfig({
+  input: "openapi.yaml",
+  output: { path: "./generated" },
+  plugins: [
+    "@hey-api/typescript",
+    definePathsConfig({
+      output: "paths",                // → generated/paths.ts
+      naming: { casing: "camelCase", suffix: "Route" },
+    }),
+  ],
+});
+```
+
+## Output
+
+For each operation that has a `path` and an `operationId`, the plugin emits:
+
+```ts
+export const getPetByIdRoute = {
+  spec: "/pets/{id}",
+  pattern: "/pets/:id",
+  method: "get",
+  operationId: "getPetById",
+} as const;
+```
+
+- `spec` — the original `{param}` template, useful when re-issuing the request.
+- `pattern` — `:param` form, ready to feed `URLPattern`, `path-to-regexp`, your router of choice.
+- `method` — lower-case verb.
+- `operationId` — the OpenAPI id when present.
+
+`as const` keeps every value literal-typed so downstream code can narrow on `route.method`, etc.
+
+## Why route consts (instead of runtime routing)
+
+Tree-shakable: only the routes you import end up in the bundle. Pair with the matchers in [`@ir-kit/openapi-tools`](../../openapi-tools) for client-side dispatch:
+
+```ts
+import { match } from "@ir-kit/openapi-tools/match";
+import { getPetByIdRoute } from "./generated/paths";
+
+const params = match(getPetByIdRoute.pattern, "/pets/42"); // { id: "42" }
+```
+
+Or feed them to a router framework that takes pattern strings.
+
+## Options
+
+```ts
+definePathsConfig({
+  output: "paths",                    // filename (no extension). Default: "paths"
+  naming: {
+    casing: "camelCase",              // any @hey-api/shared NamingRule | Casing
+    suffix: "Route",                  // appended to each const name
+  },
+});
+```
+
+## License
+
+MIT

package/dist/config.d.ts

@@ -0,0 +1,6 @@
+import type { PathsPlugin } from "./types";
+export declare const defaultConfig: PathsPlugin["Config"];
+export declare const defineConfig: (userConfig?: Omit<import("./types").UserConfig, "name"> | undefined) => Omit<import("@hey-api/shared").Plugin.Config<import("@hey-api/shared").Plugin.Types<import("./types").UserConfig, import("./types").Config, never>>, "name"> & {
+    name: any;
+};
+//# sourceMappingURL=config.d.ts.map

package/dist/config.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAE3C,eAAO,MAAM,aAAa,EAAE,WAAW,CAAC,QAAQ,CAY/C,CAAC;AAEF,eAAO,MAAM,YAAY;;CAAoC,CAAC"}

package/dist/config.js

@@ -0,0 +1,17 @@
+import { definePluginConfig } from "@hey-api/shared";
+import { handler } from "./plugin";
+export const defaultConfig = {
+    config: {
+        output: "paths",
+        naming: {
+            casing: "camelCase",
+            suffix: "Route",
+        },
+    },
+    dependencies: ["@hey-api/typescript"],
+    handler,
+    name: "@ir-kit/paths",
+    tags: ["transformer"],
+};
+export const defineConfig = definePluginConfig(defaultConfig);
+//# sourceMappingURL=config.js.map

package/dist/config.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.js","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,iBAAiB,CAAC;AAErD,OAAO,EAAE,OAAO,EAAE,MAAM,UAAU,CAAC;AAGnC,MAAM,CAAC,MAAM,aAAa,GAA0B;IAClD,MAAM,EAAE;QACN,MAAM,EAAE,OAAO;QACf,MAAM,EAAE;YACN,MAAM,EAAE,WAAW;YACnB,MAAM,EAAE,OAAO;SAChB;KACF;IACD,YAAY,EAAE,CAAC,qBAAqB,CAAC;IACrC,OAAO;IACP,IAAI,EAAE,eAAe;IACrB,IAAI,EAAE,CAAC,aAAa,CAAC;CACtB,CAAC;AAEF,MAAM,CAAC,MAAM,YAAY,GAAG,kBAAkB,CAAC,aAAa,CAAC,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,4 @@
+import "./types";
+export { defaultConfig, defineConfig } from "./config";
+export type { PathsPlugin } from "./types";
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,SAAS,CAAC;AAEjB,OAAO,EAAE,aAAa,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AACvD,YAAY,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC"}

package/dist/index.js

@@ -0,0 +1,3 @@
+import "./types";
+export { defaultConfig, defineConfig } from "./config";
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,SAAS,CAAC;AAEjB,OAAO,EAAE,aAAa,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC"}

package/dist/plugin.d.ts

@@ -0,0 +1,3 @@
+import type { PathsPlugin } from "./types";
+export declare const handler: PathsPlugin["Handler"];
+//# sourceMappingURL=plugin.d.ts.map

package/dist/plugin.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"plugin.d.ts","sourceRoot":"","sources":["../src/plugin.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAW3C,eAAO,MAAM,OAAO,EAAE,WAAW,CAAC,SAAS,CAoB1C,CAAC"}

package/dist/plugin.js

@@ -0,0 +1,28 @@
+import { $ } from "@hey-api/openapi-ts";
+import { applyNaming } from "@hey-api/shared";
+/** `/users/{id}/posts/{postId}` → `/users/:id/posts/:postId` */
+function specToPattern(spec) {
+    return spec.replace(/\{([^}]+)\}/g, ":$1");
+}
+function sanitize(name) {
+    return name.replace(/[^\w]/g, "");
+}
+export const handler = ({ plugin }) => {
+    const { casing, suffix } = plugin.config.naming;
+    plugin.forEach("operation", ({ operation }) => {
+        if (!operation.path || !operation.id)
+            return;
+        const baseName = sanitize(applyNaming(operation.id, { casing }));
+        const symbolName = `${baseName}${suffix}`;
+        const symbol = plugin.symbol(symbolName);
+        let routeObj = $.object()
+            .prop("spec", $.literal(operation.path))
+            .prop("pattern", $.literal(specToPattern(operation.path)))
+            .prop("method", $.literal(operation.method.toLowerCase()));
+        if (operation.operationId) {
+            routeObj = routeObj.prop("operationId", $.literal(operation.operationId));
+        }
+        plugin.node($.const(symbol).export().assign(routeObj.as("const")));
+    });
+};
+//# sourceMappingURL=plugin.js.map

package/dist/plugin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"plugin.js","sourceRoot":"","sources":["../src/plugin.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,qBAAqB,CAAC;AACxC,OAAO,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAI9C,gEAAgE;AAChE,SAAS,aAAa,CAAC,IAAY;IACjC,OAAO,IAAI,CAAC,OAAO,CAAC,cAAc,EAAE,KAAK,CAAC,CAAC;AAC7C,CAAC;AAED,SAAS,QAAQ,CAAC,IAAY;IAC5B,OAAO,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;AACpC,CAAC;AAED,MAAM,CAAC,MAAM,OAAO,GAA2B,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE;IAC5D,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC;IAEhD,MAAM,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC,EAAE,SAAS,EAAE,EAAE,EAAE;QAC5C,IAAI,CAAC,SAAS,CAAC,IAAI,IAAI,CAAC,SAAS,CAAC,EAAE;YAAE,OAAO;QAE7C,MAAM,QAAQ,GAAG,QAAQ,CAAC,WAAW,CAAC,SAAS,CAAC,EAAE,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC;QACjE,MAAM,UAAU,GAAG,GAAG,QAAQ,GAAG,MAAM,EAAE,CAAC;QAC1C,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;QAEzC,IAAI,QAAQ,GAAG,CAAC,CAAC,MAAM,EAAE;aACtB,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;aACvC,IAAI,CAAC,SAAS,EAAE,CAAC,CAAC,OAAO,CAAC,aAAa,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC;aACzD,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC;QAC7D,IAAI,SAAS,CAAC,WAAW,EAAE,CAAC;YAC1B,QAAQ,GAAG,QAAQ,CAAC,IAAI,CAAC,aAAa,EAAE,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC,CAAC;QAC5E,CAAC;QAED,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,MAAM,EAAE,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;IACrE,CAAC,CAAC,CAAC;AACL,CAAC,CAAC"}

package/dist/types.d.ts

@@ -0,0 +1,28 @@
+import type { Casing, DefinePlugin, NamingRule, Plugin } from "@hey-api/shared";
+export type UserConfig = Plugin.Hooks & Plugin.UserExports & {
+    name: "@ir-kit/paths";
+    /** Filename (no extension). @default "paths" */
+    output?: string;
+    /** Route const naming: `applyNaming(operationId, casing) + suffix` (e.g. `getPetByIdRoute`). */
+    naming?: {
+        /** @default 'camelCase' */
+        casing?: NamingRule | Casing;
+        /** @default 'Route' */
+        suffix?: string;
+    };
+};
+export type Config = Plugin.Hooks & Plugin.Exports & {
+    name: "@ir-kit/paths";
+    output: string;
+    naming: {
+        casing: Casing;
+        suffix: string;
+    };
+};
+export type PathsPlugin = DefinePlugin<UserConfig, Config>;
+declare module "@hey-api/openapi-ts" {
+    interface PluginConfigMap {
+        "@ir-kit/paths": PathsPlugin["Types"];
+    }
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,YAAY,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAC;AAEhF,MAAM,MAAM,UAAU,GAAG,MAAM,CAAC,KAAK,GACnC,MAAM,CAAC,WAAW,GAAG;IACnB,IAAI,EAAE,eAAe,CAAC;IACtB,gDAAgD;IAChD,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,gGAAgG;IAChG,MAAM,CAAC,EAAE;QACP,2BAA2B;QAC3B,MAAM,CAAC,EAAE,UAAU,GAAG,MAAM,CAAC;QAC7B,uBAAuB;QACvB,MAAM,CAAC,EAAE,MAAM,CAAC;KACjB,CAAC;CACH,CAAC;AAEJ,MAAM,MAAM,MAAM,GAAG,MAAM,CAAC,KAAK,GAC/B,MAAM,CAAC,OAAO,GAAG;IACf,IAAI,EAAE,eAAe,CAAC;IACtB,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE;QACN,MAAM,EAAE,MAAM,CAAC;QACf,MAAM,EAAE,MAAM,CAAC;KAChB,CAAC;CACH,CAAC;AAEJ,MAAM,MAAM,WAAW,GAAG,YAAY,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC;AAE3D,OAAO,QAAQ,qBAAqB,CAAC;IACnC,UAAiB,eAAe;QAC9B,eAAe,EAAE,WAAW,CAAC,OAAO,CAAC,CAAC;KACvC;CACF"}

package/dist/types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":""}

package/package.json

@@ -0,0 +1,71 @@
+{
+  "name": "@ir-kit/openapi-ts-paths",
+  "version": "0.1.0",
+  "description": "Plugin for @hey-api/openapi-ts — emit per-operation route consts (spec template, URLPattern, method, operationId) for tree-shakable runtime routing and matching",
+  "keywords": [
+    "openapi",
+    "openapi-ts",
+    "routes",
+    "router",
+    "matcher",
+    "url-pattern",
+    "typescript",
+    "codegen",
+    "type-safe",
+    "plugin"
+  ],
+  "homepage": "https://github.com/ir-kit/ir-kit/tree/main/packages/openapi/plugins/paths",
+  "bugs": {
+    "url": "https://github.com/ir-kit/ir-kit/issues"
+  },
+  "license": "MIT",
+  "author": {
+    "name": "Ahmed Rowaihi",
+    "email": "ahmedrowaihi@gmail.com"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/ir-kit/ir-kit.git",
+    "directory": "packages/openapi/plugins/paths"
+  },
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE.md"
+  ],
+  "publishConfig": {
+    "access": "public",
+    "provenance": true
+  },
+  "peerDependencies": {
+    "@hey-api/codegen-core": ">=0.7.0",
+    "@hey-api/openapi-ts": ">=0.95.0",
+    "@hey-api/shared": ">=0.3.0"
+  },
+  "devDependencies": {
+    "@hey-api/codegen-core": "^0.8.1",
+    "@hey-api/openapi-ts": "^0.97.0",
+    "@hey-api/shared": "^0.4.2",
+    "@types/node": "^22",
+    "@ir-kit/tsconfig": "0.0.0"
+  },
+  "engines": {
+    "node": ">=20.19.0"
+  },
+  "scripts": {
+    "build": "tsc",
+    "dev": "tsc --watch",
+    "typecheck": "tsc --noEmit"
+  }
+}