@ts-contract/plugins 1.0.0-alpha.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Matthew Brimmer
+
+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,7 @@
+# utils
+
+This library was generated with [Nx](https://nx.dev).
+
+## Building
+
+Run `nx build utils` to build the library.

package/dist/index.d.ts

@@ -0,0 +1,5 @@
+export * from './lib/path';
+export * from './lib/validate';
+export * from './lib/plugins/path';
+export * from './lib/plugins/validate';
+//# 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,cAAc,YAAY,CAAC;AAC3B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,oBAAoB,CAAC;AACnC,cAAc,wBAAwB,CAAC"}

package/dist/index.js

@@ -0,0 +1,4 @@
+export * from './lib/path';
+export * from './lib/validate';
+export * from './lib/plugins/path';
+export * from './lib/plugins/validate';

package/dist/lib/path.d.ts

@@ -0,0 +1,5 @@
+import type { RouteDef, InferPathParams, InferQuery } from '@ts-contract/core';
+type BuildPathArgs<R extends RouteDef> = InferPathParams<R> extends undefined ? InferQuery<R> extends undefined ? [] : [params?: undefined, query?: InferQuery<R>] : InferQuery<R> extends undefined ? [params: InferPathParams<R>] : [params: InferPathParams<R>, query?: InferQuery<R>];
+export declare const buildPath: <R extends RouteDef>(route: R, ...args: BuildPathArgs<R>) => string;
+export {};
+//# sourceMappingURL=path.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"path.d.ts","sourceRoot":"","sources":["../../src/lib/path.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,eAAe,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAE/E,KAAK,aAAa,CAAC,CAAC,SAAS,QAAQ,IACnC,eAAe,CAAC,CAAC,CAAC,SAAS,SAAS,GAChC,UAAU,CAAC,CAAC,CAAC,SAAS,SAAS,GAC7B,EAAE,GACF,CAAC,MAAM,CAAC,EAAE,SAAS,EAAE,KAAK,CAAC,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC,GAC7C,UAAU,CAAC,CAAC,CAAC,SAAS,SAAS,GAC7B,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC,CAAC,CAAC,GAC5B,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC;AAE5D,eAAO,MAAM,SAAS,GAAI,CAAC,SAAS,QAAQ,EAC1C,OAAO,CAAC,EACR,GAAG,MAAM,aAAa,CAAC,CAAC,CAAC,KACxB,MA+BF,CAAC"}

package/dist/lib/path.js

@@ -0,0 +1,25 @@
+export const buildPath = (route, ...args) => {
+    const [params, query] = args;
+    let path = route.path;
+    if (params) {
+        path = path.replace(/:([^/]+)/g, (_, key) => {
+            if (!(key in params)) {
+                throw new Error(`Missing path parameter: ${key}`);
+            }
+            return encodeURIComponent(params[key]);
+        });
+    }
+    if (query) {
+        const searchParams = new URLSearchParams();
+        for (const [key, value] of Object.entries(query)) {
+            if (value !== undefined && value !== null) {
+                searchParams.append(key, String(value));
+            }
+        }
+        const qs = searchParams.toString();
+        if (qs) {
+            path += `?${qs}`;
+        }
+    }
+    return path;
+};

package/dist/lib/plugins/path.d.ts

@@ -0,0 +1,12 @@
+import type { RouteDef, InferPathParams, InferQuery, ContractPlugin } from '@ts-contract/core';
+type BuildPathArgs<R extends RouteDef> = InferPathParams<R> extends undefined ? InferQuery<R> extends undefined ? [] : [params?: undefined, query?: InferQuery<R>] : InferQuery<R> extends undefined ? [params: InferPathParams<R>] : [params: InferPathParams<R>, query?: InferQuery<R>];
+declare module '@ts-contract/core' {
+    interface PluginTypeRegistry<R> {
+        path: {
+            buildPath: R extends RouteDef ? (...args: BuildPathArgs<R>) => string : never;
+        };
+    }
+}
+export declare const pathPlugin: ContractPlugin<'path'>;
+export {};
+//# sourceMappingURL=path.d.ts.map

package/dist/lib/plugins/path.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"path.d.ts","sourceRoot":"","sources":["../../../src/lib/plugins/path.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,QAAQ,EACR,eAAe,EACf,UAAU,EACV,cAAc,EACf,MAAM,mBAAmB,CAAC;AAG3B,KAAK,aAAa,CAAC,CAAC,SAAS,QAAQ,IACnC,eAAe,CAAC,CAAC,CAAC,SAAS,SAAS,GAChC,UAAU,CAAC,CAAC,CAAC,SAAS,SAAS,GAC7B,EAAE,GACF,CAAC,MAAM,CAAC,EAAE,SAAS,EAAE,KAAK,CAAC,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC,GAC7C,UAAU,CAAC,CAAC,CAAC,SAAS,SAAS,GAC7B,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC,CAAC,CAAC,GAC5B,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC;AAE5D,OAAO,QAAQ,mBAAmB,CAAC;IACjC,UAAU,kBAAkB,CAAC,CAAC;QAC5B,IAAI,EAAE;YACJ,SAAS,EAAE,CAAC,SAAS,QAAQ,GACzB,CAAC,GAAG,IAAI,EAAE,aAAa,CAAC,CAAC,CAAC,KAAK,MAAM,GACrC,KAAK,CAAC;SACX,CAAC;KACH;CACF;AAED,eAAO,MAAM,UAAU,EAAE,cAAc,CAAC,MAAM,CAS7C,CAAC"}

package/dist/lib/plugins/path.js

@@ -0,0 +1,7 @@
+import { buildPath } from '../path';
+export const pathPlugin = {
+    name: 'path',
+    route: (route) => ({
+        buildPath: (...args) => buildPath(route, ...args),
+    }),
+};

package/dist/lib/plugins/validate.d.ts

@@ -0,0 +1,14 @@
+import type { RouteDef, InferPathParams, InferQuery, InferBody, InferHeaders, InferResponseBody, HttpStatusCodes, ContractPlugin } from '@ts-contract/core';
+declare module '@ts-contract/core' {
+    interface PluginTypeRegistry<R> {
+        validate: {
+            validatePathParams: R extends RouteDef ? (params: unknown) => InferPathParams<R> : never;
+            validateQuery: R extends RouteDef ? (query: unknown) => InferQuery<R> : never;
+            validateBody: R extends RouteDef ? (body: unknown) => InferBody<R> : never;
+            validateResponse: R extends RouteDef ? <S extends keyof R['responses'] & HttpStatusCodes>(status: S, data: unknown) => InferResponseBody<R, S> : never;
+            validateHeaders: R extends RouteDef ? (headers: Record<string, unknown>) => InferHeaders<R> : never;
+        };
+    }
+}
+export declare const validatePlugin: ContractPlugin<'validate'>;
+//# sourceMappingURL=validate.d.ts.map

package/dist/lib/plugins/validate.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"validate.d.ts","sourceRoot":"","sources":["../../../src/lib/plugins/validate.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,QAAQ,EACR,eAAe,EACf,UAAU,EACV,SAAS,EACT,YAAY,EACZ,iBAAiB,EACjB,eAAe,EACf,cAAc,EACf,MAAM,mBAAmB,CAAC;AAS3B,OAAO,QAAQ,mBAAmB,CAAC;IACjC,UAAU,kBAAkB,CAAC,CAAC;QAC5B,QAAQ,EAAE;YACR,kBAAkB,EAAE,CAAC,SAAS,QAAQ,GAClC,CAAC,MAAM,EAAE,OAAO,KAAK,eAAe,CAAC,CAAC,CAAC,GACvC,KAAK,CAAC;YACV,aAAa,EAAE,CAAC,SAAS,QAAQ,GAC7B,CAAC,KAAK,EAAE,OAAO,KAAK,UAAU,CAAC,CAAC,CAAC,GACjC,KAAK,CAAC;YACV,YAAY,EAAE,CAAC,SAAS,QAAQ,GAC5B,CAAC,IAAI,EAAE,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,GAC/B,KAAK,CAAC;YACV,gBAAgB,EAAE,CAAC,SAAS,QAAQ,GAChC,CAAC,CAAC,SAAS,MAAM,CAAC,CAAC,WAAW,CAAC,GAAG,eAAe,EAC/C,MAAM,EAAE,CAAC,EACT,IAAI,EAAE,OAAO,KACV,iBAAiB,CAAC,CAAC,EAAE,CAAC,CAAC,GAC5B,KAAK,CAAC;YACV,eAAe,EAAE,CAAC,SAAS,QAAQ,GAC/B,CAAC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,KAAK,YAAY,CAAC,CAAC,CAAC,GACrD,KAAK,CAAC;SACX,CAAC;KACH;CACF;AAED,eAAO,MAAM,cAAc,EAAE,cAAc,CAAC,UAAU,CAWrD,CAAC"}

package/dist/lib/plugins/validate.js

@@ -0,0 +1,11 @@
+import { validatePathParams, validateQuery, validateBody, validateResponse, validateHeaders, } from '../validate';
+export const validatePlugin = {
+    name: 'validate',
+    route: (route) => ({
+        validatePathParams: (params) => validatePathParams(route, params),
+        validateQuery: (query) => validateQuery(route, query),
+        validateBody: (body) => validateBody(route, body),
+        validateResponse: (status, data) => validateResponse(route, status, data),
+        validateHeaders: (headers) => validateHeaders(route, headers),
+    }),
+};

package/dist/lib/validate.d.ts

@@ -0,0 +1,7 @@
+import type { RouteDef, InferPathParams, InferQuery, InferBody, InferHeaders, InferResponseBody, HttpStatusCodes } from '@ts-contract/core';
+export declare const validatePathParams: <R extends RouteDef>(route: R, params: unknown) => InferPathParams<R>;
+export declare const validateQuery: <R extends RouteDef>(route: R, query: unknown) => InferQuery<R>;
+export declare const validateBody: <R extends RouteDef>(route: R, body: unknown) => InferBody<R>;
+export declare const validateResponse: <R extends RouteDef, S extends keyof R["responses"] & HttpStatusCodes>(route: R, status: S, data: unknown) => InferResponseBody<R, S>;
+export declare const validateHeaders: <R extends RouteDef>(route: R, headers: Record<string, unknown>) => InferHeaders<R>;
+//# sourceMappingURL=validate.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"validate.d.ts","sourceRoot":"","sources":["../../src/lib/validate.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,QAAQ,EACR,eAAe,EACf,UAAU,EACV,SAAS,EACT,YAAY,EACZ,iBAAiB,EACjB,eAAe,EAEhB,MAAM,mBAAmB,CAAC;AAoB3B,eAAO,MAAM,kBAAkB,GAAI,CAAC,SAAS,QAAQ,EACnD,OAAO,CAAC,EACR,QAAQ,OAAO,KACd,eAAe,CAAC,CAAC,CASnB,CAAC;AAEF,eAAO,MAAM,aAAa,GAAI,CAAC,SAAS,QAAQ,EAC9C,OAAO,CAAC,EACR,OAAO,OAAO,KACb,UAAU,CAAC,CAAC,CASd,CAAC;AAEF,eAAO,MAAM,YAAY,GAAI,CAAC,SAAS,QAAQ,EAC7C,OAAO,CAAC,EACR,MAAM,OAAO,KACZ,SAAS,CAAC,CAAC,CASb,CAAC;AAEF,eAAO,MAAM,gBAAgB,GAC3B,CAAC,SAAS,QAAQ,EAClB,CAAC,SAAS,MAAM,CAAC,CAAC,WAAW,CAAC,GAAG,eAAe,EAEhD,OAAO,CAAC,EACR,QAAQ,CAAC,EACT,MAAM,OAAO,KACZ,iBAAiB,CAAC,CAAC,EAAE,CAAC,CAYxB,CAAC;AAEF,eAAO,MAAM,eAAe,GAAI,CAAC,SAAS,QAAQ,EAChD,OAAO,CAAC,EACR,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,KAC/B,YAAY,CAAC,CAAC,CAahB,CAAC"}

package/dist/lib/validate.js

@@ -0,0 +1,46 @@
+/**
+ * Validate a value against a Standard Schema, throwing on failure
+ */
+const validateSchema = (schema, value, label) => {
+    const result = schema['~standard'].validate(value);
+    if ('issues' in result && result.issues) {
+        const messages = result.issues.map((i) => i.message).join(', ');
+        throw new Error(`Validation failed for ${label}: ${messages}`);
+    }
+    return result.value;
+};
+export const validatePathParams = (route, params) => {
+    if (!route.pathParams) {
+        throw new Error(`Route "${route.path}" has no pathParams schema`);
+    }
+    return validateSchema(route.pathParams, params, `pathParams of ${route.path}`);
+};
+export const validateQuery = (route, query) => {
+    if (!route.query) {
+        throw new Error(`Route "${route.path}" has no query schema`);
+    }
+    return validateSchema(route.query, query, `query of ${route.path}`);
+};
+export const validateBody = (route, body) => {
+    if (!route.body) {
+        throw new Error(`Route "${route.path}" has no body schema`);
+    }
+    return validateSchema(route.body, body, `body of ${route.path}`);
+};
+export const validateResponse = (route, status, data) => {
+    const schema = route.responses[status];
+    if (!schema) {
+        throw new Error(`Route "${route.path}" has no response schema for status ${String(status)}`);
+    }
+    return validateSchema(schema, data, `response ${String(status)} of ${route.path}`);
+};
+export const validateHeaders = (route, headers) => {
+    if (!route.headers) {
+        throw new Error(`Route "${route.path}" has no headers schema`);
+    }
+    const result = {};
+    for (const [key, schema] of Object.entries(route.headers)) {
+        result[key] = validateSchema(schema, headers[key], `header "${key}" of ${route.path}`);
+    }
+    return result;
+};

package/package.json

@@ -0,0 +1,50 @@
+{
+  "name": "@ts-contract/plugins",
+  "version": "1.0.0-alpha.0",
+  "description": "Built-in plugins for path building and schema validation for ts-contract",
+  "type": "module",
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    "./package.json": "./package.json",
+    ".": {
+      "@ts-contract/source": "./src/index.ts",
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "default": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "!**/*.tsbuildinfo"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/mbrimmer83/ts-contract.git",
+    "directory": "packages/plugins"
+  },
+  "homepage": "https://github.com/mbrimmer83/ts-contract#readme",
+  "bugs": {
+    "url": "https://github.com/mbrimmer83/ts-contract/issues"
+  },
+  "keywords": [
+    "typescript",
+    "contract",
+    "plugins",
+    "validation",
+    "path-building"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "tslib": "^2.3.0",
+    "@ts-contract/core": "1.0.0-alpha.0"
+  },
+  "scripts": {
+    "build": "tsc -b tsconfig.lib.json",
+    "test": "vitest run --config vitest.config.mts",
+    "lint": "eslint ."
+  }
+}