@orpc/arktype 1.14.11 → 1.14.12

package/README.md

@@ -1,16 +1,17 @@
-<h1 align="center">oRPC - Typesafe APIs Made Simple 🪄</h1>
+<div align="center">
+  <image align="center" src="https://orpc.dev/logo.webp" width=280 alt="oRPC logo" />
+</div>
+
+<h1></h1>
 
 <div align="center">
   <a href="https://codecov.io/gh/middleapi/orpc">
-    <img alt="codecov" src="https://codecov.io/gh/middleapi/orpc/branch/main/graph/badge.svg">
+    <img alt="codecov" src="https://codecov.io/gh/middleapi/orpc/branch/1.x/graph/badge.svg">
   </a>
   <a href="https://www.npmjs.com/package/@orpc/arktype">
     <img alt="weekly downloads" src="https://img.shields.io/npm/dw/%40orpc%2Farktype?logo=npm" />
   </a>
-  <a href="https://app.codspeed.io/middleapi/orpc?utm_source=badge">
-    <img alt="CodSpeed" src="https://img.shields.io/endpoint?url=https://codspeed.io/badge.json" />
-  </a>
-  <a href="https://github.com/middleapi/orpc/blob/main/LICENSE">
+  <a href="https://github.com/middleapi/orpc/blob/1.x/LICENSE">
     <img alt="MIT License" src="https://img.shields.io/github/license/middleapi/orpc?logo=open-source-initiative" />
   </a>
   <a href="https://discord.gg/TXEbwRBvQn">
@@ -21,53 +22,84 @@
   </a>
 </div>
 
-## Documentation
-
-You can read the documentation [here](https://orpc.dev).
-
-## Packages
-
-**Core**
+<h3 align="center">Typesafe APIs Made Simple 🪄</h3>
 
-- [@orpc/contract](https://www.npmjs.com/package/@orpc/contract): Define API contract as the single source of truth.
-- [@orpc/server](https://www.npmjs.com/package/@orpc/server): Build APIs or implement contracts.
-- [@orpc/client](https://www.npmjs.com/package/@orpc/client): Consume APIs with end-to-end type safety.
-- [@orpc/openapi](https://www.npmjs.com/package/@orpc/openapi): Add OpenAPI compatibility to APIs.
+**oRPC is a powerful combination of RPC and OpenAPI**, makes it easy to build APIs that are end-to-end type-safe and adhere to OpenAPI standards
 
-**Schema validation**
+---
 
-- [@orpc/zod](https://www.npmjs.com/package/@orpc/zod): Integrate with [Zod](https://zod.dev/).
-- [@orpc/valibot](https://www.npmjs.com/package/@orpc/valibot): Integrate with [Valibot](https://valibot.dev/).
-- [@orpc/arktype](https://www.npmjs.com/package/@orpc/arktype): Integrate with [ArkType](https://arktype.io/).
+## Highlights
 
-**Built-in features**
+- **🔗 End-to-End Type Safety**: Ensure type-safe inputs, outputs, and errors from client to server.
+- **📘 First-Class OpenAPI**: Built-in support that fully adheres to the OpenAPI standard.
+- **📝 Contract-First Development**: Optionally define your API contract before implementation.
+- **🔍 First-Class OpenTelemetry**: Seamlessly integrate with OpenTelemetry for observability.
+- **⚙️ Framework Integrations**: Seamlessly integrate with TanStack Query (React, Vue, Solid, Svelte, Angular), SWR, Pinia Colada, and more.
+- **🚀 Server Actions**: Fully compatible with React Server Actions on Next.js, TanStack Start, and other platforms.
+- **🔠 Standard Schema Support**: Works out of the box with Zod, Valibot, ArkType, and other schema validators.
+- **🗃️ Native Types**: Supports native types like Date, File, Blob, BigInt, URL, and more.
+- **⏱️ Lazy Router**: Enhance cold start times with our lazy routing feature.
+- **📡 SSE & Streaming**: Enjoy full type-safe support for SSE and streaming.
+- **🌍 Multi-Runtime Support**: Fast and lightweight on Cloudflare, Deno, Bun, Node.js, and beyond.
+- **🔌 Extendability**: Easily extend functionality with plugins, middleware, and interceptors.
 
-- [@orpc/publisher](https://www.npmjs.com/package/@orpc/publisher): Pub/Sub with memory, Redis, and Upstash adapters.
-- [@orpc/ratelimit](https://www.npmjs.com/package/@orpc/ratelimit): Rate limiting with memory, Redis, and Upstash adapters.
-- [@orpc/json-schema](https://www.npmjs.com/package/@orpc/json-schema): Smart coercion for OpenAPI requests.
-
-**Framework & ecosystem integrations**
+## Documentation
 
-- [@orpc/next](https://www.npmjs.com/package/@orpc/next): Integrate with [Next.js Server Functions](https://nextjs.org/docs/app/getting-started/mutating-data).
-- [@orpc/ai-sdk](https://www.npmjs.com/package/@orpc/ai-sdk): Turn contracts and procedures into [AI SDK](https://ai-sdk.dev/) tools.
-- [@orpc/tanstack-query](https://www.npmjs.com/package/@orpc/tanstack-query): Integrate with [TanStack Query](https://tanstack.com/query/latest).
-- [@orpc/pinia-colada](https://www.npmjs.com/package/@orpc/pinia-colada): Integrate with [Pinia Colada](https://pinia-colada.esm.dev/).
-- [@orpc/swr](https://www.npmjs.com/package/@orpc/swr): Integrate with [SWR](https://swr.vercel.app/).
-- [@orpc/experimental-effect](https://www.npmjs.com/package/@orpc/experimental-effect): Integrate with [Effect](https://effect.website/).
-- [@orpc/nest](https://www.npmjs.com/package/@orpc/nest): Implement your contract with [NestJS](https://nestjs.com/).
-- [@orpc/bun](https://www.npmjs.com/package/@orpc/bun): Adapters for [Bun's Redis](https://bun.sh/).
-- [@orpc/cloudflare](https://www.npmjs.com/package/@orpc/cloudflare): Adapters for [Cloudflare's RateLimit and Durable Objects](https://developers.cloudflare.com/workers/).
-- [@orpc/trpc](https://www.npmjs.com/package/@orpc/trpc): Reuse existing [tRPC](https://trpc.io/) routers within oRPC.
+You can find the full documentation [here](https://orpc.dev).
 
-**Observability**
+## Packages
 
-- [@orpc/opentelemetry](https://www.npmjs.com/package/@orpc/opentelemetry): Integrate with [OpenTelemetry](https://opentelemetry.io/) for distributed tracing.
-- [@orpc/pino](https://www.npmjs.com/package/@orpc/pino): Integrate with [Pino](https://getpino.io/) for logging.
-- [@orpc/evlog](https://www.npmjs.com/package/@orpc/evlog): Integrate with [Evlog](https://evlog.dev/) for logging.
+- [@orpc/contract](https://www.npmjs.com/package/@orpc/contract): Build your API contract.
+- [@orpc/server](https://www.npmjs.com/package/@orpc/server): Build your API or implement API contract.
+- [@orpc/client](https://www.npmjs.com/package/@orpc/client): Consume your API on the client with type-safety.
+- [@orpc/openapi](https://www.npmjs.com/package/@orpc/openapi): Generate OpenAPI specs and handle OpenAPI requests.
+- [@orpc/otel](https://www.npmjs.com/package/@orpc/otel): [OpenTelemetry](https://opentelemetry.io/) integration for observability.
+- [@orpc/nest](https://www.npmjs.com/package/@orpc/nest): Deeply integrate oRPC with [NestJS](https://nestjs.com/).
+- [@orpc/react](https://www.npmjs.com/package/@orpc/react): Utilities for integrating oRPC with React and React Server Actions.
+- [@orpc/tanstack-query](https://www.npmjs.com/package/@orpc/tanstack-query): [TanStack Query](https://tanstack.com/query/latest) integration.
+- [@orpc/experimental-react-swr](https://www.npmjs.com/package/@orpc/experimental-react-swr): [SWR](https://swr.vercel.app/) integration.
+- [@orpc/vue-colada](https://www.npmjs.com/package/@orpc/vue-colada): Integration with [Pinia Colada](https://pinia-colada.esm.dev/).
+- [@orpc/hey-api](https://www.npmjs.com/package/@orpc/hey-api): [Hey API](https://heyapi.dev/) integration.
+- [@orpc/zod](https://www.npmjs.com/package/@orpc/zod): More schemas that [Zod](https://zod.dev/) doesn't support yet.
+- [@orpc/valibot](https://www.npmjs.com/package/@orpc/valibot): OpenAPI spec generation from [Valibot](https://valibot.dev/).
+- [@orpc/arktype](https://www.npmjs.com/package/@orpc/arktype): OpenAPI spec generation from [ArkType](https://arktype.io/).
+
+## `@orpc/arktype`
+
+Provides `ArkTypeToJsonSchemaConverter` for generating OpenAPI specs from [ArkType](https://arktype.io/).
+
+### Generate OpenAPI Spec
+
+```ts
+import {
+  experimental_ArkTypeToJsonSchemaConverter as ArkTypeToJsonSchemaConverter
+} from '@orpc/arktype'
+import { OpenAPIGenerator } from '@orpc/openapi'
+
+const openAPIGenerator = new OpenAPIGenerator({
+  schemaConverters: [
+    new ArkTypeToJsonSchemaConverter()
+  ],
+})
+
+const specFromContract = await openAPIGenerator.generate(contract, {
+  info: {
+    title: 'My App',
+    version: '0.0.0',
+  },
+})
+
+const specFromRouter = await openAPIGenerator.generate(router, {
+  info: {
+    title: 'My App',
+    version: '0.0.0',
+  },
+})
+```
 
 ## Sponsors
 
-Like what we build over at [middleapi](https://github.com/middleapi)? You can help keep it going here: [GitHub Sponsors](https://github.com/sponsors/dinwwwh). Every bit helps! 🚀
+If you find oRPC valuable and would like to support its development, you can do so here: [GitHub Sponsors](https://github.com/sponsors/dinwwwh).
 
 ### 🏆 Platinum Sponsor
 
@@ -109,10 +141,11 @@ Like what we build over at [middleapi](https://github.com/middleapi)? You can he
    <td align="center"><a href="https://github.com/valerii15298?ref=orpc" target="_blank" rel="noopener" title="Valerii Petryniak"><img src="https://avatars.githubusercontent.com/u/44531564?u=88ac74d9bacd20401518441907acad21063cd397&amp;v=4" width="139" alt="Valerii Petryniak"/><br />Valerii Petryniak</a></td>
    <td align="center"><a href="https://github.com/letstri?ref=orpc" target="_blank" rel="noopener" title="Valerii Strilets"><img src="https://avatars.githubusercontent.com/u/13253748?u=c7b10399ccc8f8081e24db94ec32cd9858e86ac3&amp;v=4" width="139" alt="Valerii Strilets"/><br />Valerii Strilets</a></td>
    <td align="center"><a href="https://github.com/K-Mistele?ref=orpc" target="_blank" rel="noopener" title="Kyle Mistele"><img src="https://avatars.githubusercontent.com/u/18430555?u=3afebeb81de666e35aaac3ed46f14159d7603ffb&amp;v=4" width="139" alt="Kyle Mistele"/><br />Kyle Mistele</a></td>
+   <td align="center"><a href="https://github.com/R44VC0RP?ref=orpc" target="_blank" rel="noopener" title="Ryan Vogel"><img src="https://avatars.githubusercontent.com/u/89211796?u=1857347b9787d8d8a7ea5bfc333f96be92d5a683&amp;v=4" width="139" alt="Ryan Vogel"/><br />Ryan Vogel</a></td>
    <td align="center"><a href="https://github.com/christ12938?ref=orpc" target="_blank" rel="noopener" title="christ12938"><img src="https://avatars.githubusercontent.com/u/25758598?v=4" width="139" alt="christ12938"/><br />christ12938</a></td>
-   <td align="center"><a href="https://github.com/Ryanjso?ref=orpc" target="_blank" rel="noopener" title="Ryan Soderberg"><img src="https://avatars.githubusercontent.com/u/39172778?u=5ed913c31d57e7221b75784abcad48c7ebddde27&amp;v=4" width="139" alt="Ryan Soderberg"/><br />Ryan Soderberg</a></td>
   </tr>
   <tr>
+   <td align="center"><a href="https://github.com/Ryanjso?ref=orpc" target="_blank" rel="noopener" title="Ryan Soderberg"><img src="https://avatars.githubusercontent.com/u/39172778?u=5ed913c31d57e7221b75784abcad48c7ebddde27&amp;v=4" width="139" alt="Ryan Soderberg"/><br />Ryan Soderberg</a></td>
    <td align="center"><a href="https://github.com/itigoore01?ref=orpc" target="_blank" rel="noopener" title="shota"><img src="https://avatars.githubusercontent.com/u/11831107?u=c976a6dc7e055eb026304c46c99100ed22b0c8e0&amp;v=4" width="139" alt="shota"/><br />shota</a></td>
   </tr>
 </table>
@@ -172,7 +205,6 @@ Like what we build over at [middleapi](https://github.com/middleapi)? You can he
   <a href="https://github.com/nguyenlc1993?ref=orpc" target="_blank" rel="noopener" title="Lê Cao Nguyên"><img src="https://avatars.githubusercontent.com/u/13871971?u=83c8b69d9e35b589c4e1f066cc113b1d9461386f&amp;v=4" width="32" height="32" alt="Lê Cao Nguyên" /></a>
   <a href="https://github.com/wobsoriano?ref=orpc" target="_blank" rel="noopener" title="Robert Soriano"><img src="https://avatars.githubusercontent.com/u/13049130?u=6d72104182e7c9ed25934815313fb69107332111&amp;v=4" width="32" height="32" alt="Robert Soriano" /></a>
   <a href="https://github.com/andrewpeters9?ref=orpc" target="_blank" rel="noopener" title="Andrew Peters"><img src="https://avatars.githubusercontent.com/u/36251325?v=4" width="32" height="32" alt="Andrew Peters" /></a>
-  <a href="https://github.com/R44VC0RP?ref=orpc" target="_blank" rel="noopener" title="Ryan Vogel"><img src="https://avatars.githubusercontent.com/u/89211796?u=1857347b9787d8d8a7ea5bfc333f96be92d5a683&amp;v=4" width="32" height="32" alt="Ryan Vogel" /></a>
   <a href="https://github.com/SKostyukovich?ref=orpc" target="_blank" rel="noopener" title="SKostyukovich"><img src="https://avatars.githubusercontent.com/u/10700067?v=4" width="32" height="32" alt="SKostyukovich" /></a>
   <a href="https://github.com/peter-adam-dy?ref=orpc" target="_blank" rel="noopener" title="Peter Adam"><img src="https://avatars.githubusercontent.com/u/132129459?u=4f3dbbb3b443990b56acb7d6a5d11ed2c555f6db&amp;v=4" width="32" height="32" alt="Peter Adam" /></a>
   <a href="https://github.com/FabworksHQ?ref=orpc" target="_blank" rel="noopener" title="Fabworks"><img src="https://avatars.githubusercontent.com/u/160179500?v=4" width="32" height="32" alt="Fabworks" /></a>
@@ -187,13 +219,6 @@ Like what we build over at [middleapi](https://github.com/middleapi)? You can he
   <a href="https://github.com/plancraft?ref=orpc" target="_blank" rel="noopener" title="plancraft"><img src="https://avatars.githubusercontent.com/u/46482287?v=4" width="32" height="32" alt="plancraft" /></a>
 </p>
 
-## References
-
-oRPC is inspired by existing solutions that prioritize type safety and developer experience. Special acknowledgments to:
-
-- [tRPC](https://trpc.io): For pioneering the concept of end-to-end type-safe RPC and influencing the development of type-safe APIs.
-- [ts-rest](https://ts-rest.com): For its emphasis on contract-first development and OpenAPI integration, which have greatly inspired oRPC's feature set.
-
 ## License
 
-Distributed under the MIT License. See [LICENSE](https://github.com/middleapi/orpc/blob/main/LICENSE) for more information.
+Distributed under the MIT License. See [LICENSE](https://github.com/middleapi/orpc/blob/1.x/LICENSE) for more information.

package/dist/index.d.mts

@@ -1,15 +1,12 @@
 import { ToJsonSchema } from '@ark/schema';
-import { JsonSchemaConverter, AnySchema, JsonSchemaConverterDirection, JsonSchema } from '@orpc/json-schema';
+import { AnySchema } from '@orpc/contract';
+import { ConditionalSchemaConverter, SchemaConvertOptions, JSONSchema } from '@orpc/openapi';
 
-interface ArkTypeToJsonSchemaConverterOptions extends Omit<ToJsonSchema.Options, 'dialect' | 'target'> {
-}
-declare class ArkTypeToJsonSchemaConverter implements JsonSchemaConverter {
-    private readonly toJsonSchemaOptions;
-    constructor(options?: ArkTypeToJsonSchemaConverterOptions);
-    condition(schema: AnySchema | undefined, _direction: JsonSchemaConverterDirection): boolean;
-    convert(schema: AnySchema | undefined, direction: JsonSchemaConverterDirection): [jsonSchema: JsonSchema, optional: boolean];
-    private convertArkType;
+declare class experimental_ArkTypeToJsonSchemaConverter implements ConditionalSchemaConverter {
+    #private;
+    constructor(options?: ToJsonSchema.Options);
+    condition(schema: AnySchema | undefined): boolean;
+    convert(schema: AnySchema | undefined, _options: SchemaConvertOptions): [required: boolean, jsonSchema: Exclude<JSONSchema, boolean>];
 }
 
-export { ArkTypeToJsonSchemaConverter };
-export type { ArkTypeToJsonSchemaConverterOptions };
+export { experimental_ArkTypeToJsonSchemaConverter };

package/dist/index.d.ts

@@ -1,15 +1,12 @@
 import { ToJsonSchema } from '@ark/schema';
-import { JsonSchemaConverter, AnySchema, JsonSchemaConverterDirection, JsonSchema } from '@orpc/json-schema';
+import { AnySchema } from '@orpc/contract';
+import { ConditionalSchemaConverter, SchemaConvertOptions, JSONSchema } from '@orpc/openapi';
 
-interface ArkTypeToJsonSchemaConverterOptions extends Omit<ToJsonSchema.Options, 'dialect' | 'target'> {
-}
-declare class ArkTypeToJsonSchemaConverter implements JsonSchemaConverter {
-    private readonly toJsonSchemaOptions;
-    constructor(options?: ArkTypeToJsonSchemaConverterOptions);
-    condition(schema: AnySchema | undefined, _direction: JsonSchemaConverterDirection): boolean;
-    convert(schema: AnySchema | undefined, direction: JsonSchemaConverterDirection): [jsonSchema: JsonSchema, optional: boolean];
-    private convertArkType;
+declare class experimental_ArkTypeToJsonSchemaConverter implements ConditionalSchemaConverter {
+    #private;
+    constructor(options?: ToJsonSchema.Options);
+    condition(schema: AnySchema | undefined): boolean;
+    convert(schema: AnySchema | undefined, _options: SchemaConvertOptions): [required: boolean, jsonSchema: Exclude<JSONSchema, boolean>];
 }
 
-export { ArkTypeToJsonSchemaConverter };
-export type { ArkTypeToJsonSchemaConverterOptions };
+export { experimental_ArkTypeToJsonSchemaConverter };

package/dist/index.mjs

@@ -1,57 +1,30 @@
-import { JsonSchemaXNativeType, JsonSchemaFormat } from '@orpc/json-schema';
+import { JSONSchemaFormat } from '@orpc/openapi';
 
-class ArkTypeToJsonSchemaConverter {
-  toJsonSchemaOptions;
+const defaultToJsonSchemaFallback = {
+  date: (ctx) => ({
+    ...ctx.base,
+    type: "string",
+    format: JSONSchemaFormat.DateTime
+  })
+};
+class experimental_ArkTypeToJsonSchemaConverter {
+  #options;
   constructor(options = {}) {
-    this.toJsonSchemaOptions = {
+    this.#options = {
       ...options,
-      target: "draft-2020-12",
       fallback: {
-        ...options.fallback && typeof options.fallback !== "function" ? options.fallback : void 0,
-        default: (ctx) => {
-          if (ctx.code === "domain") {
-            if (ctx.domain === "bigint") {
-              ctx.base.type = "string";
-              ctx.base.pattern = "^-?[0-9]+$";
-              ctx.base["x-native-type"] = JsonSchemaXNativeType.BigInt;
-            }
-          } else if (ctx.code === "date") {
-            ctx.base.type = "string";
-            ctx.base.format = JsonSchemaFormat.DateTime;
-            ctx.base["x-native-type"] = JsonSchemaXNativeType.Date;
-          }
-          if (typeof options.fallback === "function") {
-            return options.fallback(ctx);
-          }
-          if (options.fallback?.default) {
-            return options.fallback.default(ctx);
-          }
-          return ctx.base;
-        }
+        ...defaultToJsonSchemaFallback,
+        ...options?.fallback
       }
     };
   }
-  condition(schema, _direction) {
-    return schema?.["~standard"].vendor === "arktype";
+  condition(schema) {
+    return schema !== void 0 && schema["~standard"].vendor === "arktype";
   }
-  convert(schema, direction) {
-    const arkTypeSchema = schema;
-    const jsonSchema = this.convertArkType(arkTypeSchema, direction);
-    let optional = false;
-    try {
-      const result = arkTypeSchema["~standard"].validate(void 0);
-      if (!(result instanceof Promise) && !result.issues) {
-        optional = direction === "input" ? true : result.value === void 0;
-      }
-    } catch {
-    }
-    return [jsonSchema, optional];
-  }
-  convertArkType(schema, _direction) {
-    const jsonSchema = schema.toJsonSchema(this.toJsonSchemaOptions);
-    const { $schema, ...rest } = jsonSchema;
-    return rest;
+  convert(schema, _options) {
+    const jsonSchema = schema.toJsonSchema(this.#options);
+    return [true, jsonSchema];
   }
 }
 
-export { ArkTypeToJsonSchemaConverter };
+export { experimental_ArkTypeToJsonSchemaConverter };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@orpc/arktype",
   "type": "module",
-  "version": "1.14.11",
+  "version": "1.14.12",
   "license": "MIT",
   "homepage": "https://orpc.dev",
   "repository": {
@@ -14,7 +14,6 @@
   ],
   "sideEffects": false,
   "exports": {
-    "./package.json": "./package.json",
     ".": {
       "types": "./dist/index.d.mts",
       "import": "./dist/index.mjs",
@@ -26,18 +25,20 @@
   ],
   "peerDependencies": {
     "@ark/schema": "*",
-    "arktype": "*"
+    "arktype": "*",
+    "@orpc/contract": "1.14.12"
   },
   "dependencies": {
-    "@orpc/json-schema": "1.14.11"
+    "@orpc/openapi": "1.14.12"
   },
   "devDependencies": {
     "@ark/schema": "^0.56.0",
-    "arktype": "^2.2.1",
-    "zod": "^4.4.3"
+    "arktype": "^2.2.0",
+    "zod": "^4.3.6"
   },
   "scripts": {
     "build": "unbuild",
+    "build:watch": "pnpm run build --watch",
     "type:check": "tsc -b"
   }
 }