@orpc/openapi-client 1.1.1 → 1.3.0

package/README.md

@@ -49,6 +49,7 @@ You can find the full documentation [here](https://orpc.unnoq.com).
 - [@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/nest](https://www.npmjs.com/package/@orpc/nest): Deeply integrate oRPC with NestJS.
 - [@orpc/react](https://www.npmjs.com/package/@orpc/react): Utilities for integrating oRPC with React and React Server Actions.
 - [@orpc/react-query](https://www.npmjs.com/package/@orpc/react-query): Integration with [React Query](https://tanstack.com/query/latest/docs/framework/react/overview).
 - [@orpc/vue-query](https://www.npmjs.com/package/@orpc/vue-query): Integration with [Vue Query](https://tanstack.com/query/latest/docs/framework/vue/overview).

package/dist/adapters/fetch/index.d.mts

@@ -1,7 +1,7 @@
 import { ClientContext } from '@orpc/client';
 import { LinkFetchClientOptions } from '@orpc/client/fetch';
 import { AnyContractRouter } from '@orpc/contract';
-import { f as StandardOpenAPILinkOptions, g as StandardOpenAPILink } from '../../shared/openapi-client.D_hC2pAM.mjs';
+import { f as StandardOpenAPILinkOptions, g as StandardOpenAPILink } from '../../shared/openapi-client.Bc2pHPqD.mjs';
 import '@orpc/client/standard';
 import '@orpc/shared';
 import '@orpc/standard-server';

package/dist/adapters/fetch/index.d.ts

@@ -1,7 +1,7 @@
 import { ClientContext } from '@orpc/client';
 import { LinkFetchClientOptions } from '@orpc/client/fetch';
 import { AnyContractRouter } from '@orpc/contract';
-import { f as StandardOpenAPILinkOptions, g as StandardOpenAPILink } from '../../shared/openapi-client.D_hC2pAM.js';
+import { f as StandardOpenAPILinkOptions, g as StandardOpenAPILink } from '../../shared/openapi-client.Bc2pHPqD.js';
 import '@orpc/client/standard';
 import '@orpc/shared';
 import '@orpc/standard-server';

package/dist/adapters/fetch/index.mjs

@@ -1,9 +1,9 @@
 import { LinkFetchClient } from '@orpc/client/fetch';
 import '@orpc/shared';
-import { b as StandardOpenAPILink } from '../../shared/openapi-client.D89vdV2Y.mjs';
+import '@orpc/contract';
+import { b as StandardOpenAPILink } from '../../shared/openapi-client.BwEwVdZl.mjs';
 import '@orpc/client';
 import '@orpc/client/standard';
-import '@orpc/contract';
 import '@orpc/standard-server';
 
 class OpenAPILink extends StandardOpenAPILink {

package/dist/adapters/standard/index.d.mts

@@ -1,10 +1,63 @@
-export { S as StandardBracketNotationSerialized, a as StandardBracketNotationSerializer, c as StandardOpenAPICustomJsonSerializer, b as StandardOpenAPIJsonSerialized, e as StandardOpenAPIJsonSerializer, d as StandardOpenAPIJsonSerializerOptions, g as StandardOpenAPILink, f as StandardOpenAPILinkOptions, j as StandardOpenAPISerializeOptions, k as StandardOpenAPISerializer, i as StandardOpenapiLinkCodec, h as StandardOpenapiLinkCodecOptions } from '../../shared/openapi-client.D_hC2pAM.mjs';
+export { S as StandardBracketNotationSerialized, a as StandardBracketNotationSerializer, c as StandardOpenAPICustomJsonSerializer, b as StandardOpenAPIJsonSerialized, e as StandardOpenAPIJsonSerializer, d as StandardOpenAPIJsonSerializerOptions, g as StandardOpenAPILink, f as StandardOpenAPILinkOptions, j as StandardOpenAPISerializeOptions, k as StandardOpenAPISerializer, i as StandardOpenapiLinkCodec, h as StandardOpenapiLinkCodecOptions } from '../../shared/openapi-client.Bc2pHPqD.mjs';
 import { HTTPPath } from '@orpc/client';
 import '@orpc/client/standard';
 import '@orpc/contract';
 import '@orpc/shared';
 import '@orpc/standard-server';
 
+/**
+ * parse a form data with bracket notation
+ *
+ * @example
+ * ```ts
+ * const form = new FormData()
+ * form.append('a', '1')
+ * form.append('user[name]', 'John')
+ * form.append('user[age]', '20')
+ * form.append('user[friends][]', 'Bob')
+ * form.append('user[friends][]', 'Alice')
+ * form.append('user[friends][]', 'Charlie')
+ * form.append('thumb', new Blob(['hello']), 'thumb.png')
+ *
+ * parseFormData(form)
+ * // {
+ * //   a: '1',
+ * //   user: {
+ * //     name: 'John',
+ * //     age: '20',
+ * //     friends: ['Bob', 'Alice', 'Charlie'],
+ * //   },
+ * //   thumb: form.get('thumb'),
+ * // }
+ * ```
+ *
+ * @see {@link https://orpc.unnoq.com/docs/openapi/bracket-notation Bracket Notation Docs}
+ */
+declare function parseFormData(form: FormData): any;
+/**
+ * Get the issue message from the error.
+ *
+ * @param error - The error (can be anything) can contain `data.issues` (standard schema issues)
+ * @param path - The path of the field that has the issue follow [bracket notation](https://orpc.unnoq.com/docs/openapi/bracket-notation)
+ *
+ * @example
+ * ```tsx
+ * const { error, data, execute } = useServerAction(someAction)
+ *
+ * return <form action={(form) => execute(parseFormData(form))}>
+ *   <input name="user[name]" type="text" />
+ *   <p>{getIssueMessage(error, 'user[name]')}</p>
+ *
+ *   <input name="user[age]" type="number" />
+ *   <p>{getIssueMessage(error, 'user[age]')}</p>
+ *
+ *   <input name="images[]" type="file" />
+ *   <p>{getIssueMessage(error, 'images[]')}</p>
+ * </form>
+ *
+ */
+declare function getIssueMessage(error: unknown, path: string): string | undefined;
+
 /**
  * @internal
  */
@@ -17,4 +70,4 @@ declare function getDynamicParams(path: HTTPPath | undefined): {
     name: string;
 }[] | undefined;
 
-export { getDynamicParams, standardizeHTTPPath };
+export { getDynamicParams, getIssueMessage, parseFormData, standardizeHTTPPath };

package/dist/adapters/standard/index.d.ts

@@ -1,10 +1,63 @@
-export { S as StandardBracketNotationSerialized, a as StandardBracketNotationSerializer, c as StandardOpenAPICustomJsonSerializer, b as StandardOpenAPIJsonSerialized, e as StandardOpenAPIJsonSerializer, d as StandardOpenAPIJsonSerializerOptions, g as StandardOpenAPILink, f as StandardOpenAPILinkOptions, j as StandardOpenAPISerializeOptions, k as StandardOpenAPISerializer, i as StandardOpenapiLinkCodec, h as StandardOpenapiLinkCodecOptions } from '../../shared/openapi-client.D_hC2pAM.js';
+export { S as StandardBracketNotationSerialized, a as StandardBracketNotationSerializer, c as StandardOpenAPICustomJsonSerializer, b as StandardOpenAPIJsonSerialized, e as StandardOpenAPIJsonSerializer, d as StandardOpenAPIJsonSerializerOptions, g as StandardOpenAPILink, f as StandardOpenAPILinkOptions, j as StandardOpenAPISerializeOptions, k as StandardOpenAPISerializer, i as StandardOpenapiLinkCodec, h as StandardOpenapiLinkCodecOptions } from '../../shared/openapi-client.Bc2pHPqD.js';
 import { HTTPPath } from '@orpc/client';
 import '@orpc/client/standard';
 import '@orpc/contract';
 import '@orpc/shared';
 import '@orpc/standard-server';
 
+/**
+ * parse a form data with bracket notation
+ *
+ * @example
+ * ```ts
+ * const form = new FormData()
+ * form.append('a', '1')
+ * form.append('user[name]', 'John')
+ * form.append('user[age]', '20')
+ * form.append('user[friends][]', 'Bob')
+ * form.append('user[friends][]', 'Alice')
+ * form.append('user[friends][]', 'Charlie')
+ * form.append('thumb', new Blob(['hello']), 'thumb.png')
+ *
+ * parseFormData(form)
+ * // {
+ * //   a: '1',
+ * //   user: {
+ * //     name: 'John',
+ * //     age: '20',
+ * //     friends: ['Bob', 'Alice', 'Charlie'],
+ * //   },
+ * //   thumb: form.get('thumb'),
+ * // }
+ * ```
+ *
+ * @see {@link https://orpc.unnoq.com/docs/openapi/bracket-notation Bracket Notation Docs}
+ */
+declare function parseFormData(form: FormData): any;
+/**
+ * Get the issue message from the error.
+ *
+ * @param error - The error (can be anything) can contain `data.issues` (standard schema issues)
+ * @param path - The path of the field that has the issue follow [bracket notation](https://orpc.unnoq.com/docs/openapi/bracket-notation)
+ *
+ * @example
+ * ```tsx
+ * const { error, data, execute } = useServerAction(someAction)
+ *
+ * return <form action={(form) => execute(parseFormData(form))}>
+ *   <input name="user[name]" type="text" />
+ *   <p>{getIssueMessage(error, 'user[name]')}</p>
+ *
+ *   <input name="user[age]" type="number" />
+ *   <p>{getIssueMessage(error, 'user[age]')}</p>
+ *
+ *   <input name="images[]" type="file" />
+ *   <p>{getIssueMessage(error, 'images[]')}</p>
+ * </form>
+ *
+ */
+declare function getIssueMessage(error: unknown, path: string): string | undefined;
+
 /**
  * @internal
  */
@@ -17,4 +70,4 @@ declare function getDynamicParams(path: HTTPPath | undefined): {
     name: string;
 }[] | undefined;
 
-export { getDynamicParams, standardizeHTTPPath };
+export { getDynamicParams, getIssueMessage, parseFormData, standardizeHTTPPath };

package/dist/adapters/standard/index.mjs

@@ -1,6 +1,43 @@
-export { S as StandardBracketNotationSerializer, a as StandardOpenAPIJsonSerializer, b as StandardOpenAPILink, d as StandardOpenAPISerializer, c as StandardOpenapiLinkCodec, g as getDynamicParams, s as standardizeHTTPPath } from '../../shared/openapi-client.D89vdV2Y.mjs';
+import { S as StandardBracketNotationSerializer } from '../../shared/openapi-client.BwEwVdZl.mjs';
+export { a as StandardOpenAPIJsonSerializer, b as StandardOpenAPILink, d as StandardOpenAPISerializer, c as StandardOpenapiLinkCodec, g as getDynamicParams, s as standardizeHTTPPath } from '../../shared/openapi-client.BwEwVdZl.mjs';
+import { isSchemaIssue } from '@orpc/contract';
+import { isTypescriptObject } from '@orpc/shared';
 import '@orpc/client/standard';
-import '@orpc/shared';
 import '@orpc/client';
-import '@orpc/contract';
 import '@orpc/standard-server';
+
+function parseFormData(form) {
+  const serializer = new StandardBracketNotationSerializer();
+  return serializer.deserialize(Array.from(form.entries()));
+}
+function getIssueMessage(error, path) {
+  if (!isTypescriptObject(error) || !isTypescriptObject(error.data) || !Array.isArray(error.data.issues)) {
+    return void 0;
+  }
+  const serializer = new StandardBracketNotationSerializer();
+  for (const issue of error.data.issues) {
+    if (!isSchemaIssue(issue)) {
+      continue;
+    }
+    if (issue.path === void 0) {
+      if (path === "") {
+        return issue.message;
+      }
+      continue;
+    }
+    const issuePath = serializer.stringifyPath(
+      issue.path.map((segment) => typeof segment === "object" ? segment.key.toString() : segment.toString())
+    );
+    if (issuePath === path) {
+      return issue.message;
+    }
+    if (path.endsWith("[]") && issuePath.replace(/\[(?:0|[1-9]\d*)\]$/, "[]") === path) {
+      return issue.message;
+    }
+    if (path === "" && issuePath.match(/(?:0|[1-9]\d*)$/)) {
+      return issue.message;
+    }
+  }
+}
+
+export { StandardBracketNotationSerializer, getIssueMessage, parseFormData };

package/dist/shared/{openapi-client.D_hC2pAM.d.mts → openapi-client.Bc2pHPqD.d.mts}

@@ -1,7 +1,7 @@
 import { ClientContext, ClientOptions } from '@orpc/client';
 import { StandardLinkCodec, StandardLinkOptions, StandardLink, StandardLinkClient } from '@orpc/client/standard';
 import { AnyContractRouter } from '@orpc/contract';
-import { Segment, Value } from '@orpc/shared';
+import { Segment, Value, Promisable } from '@orpc/shared';
 import { StandardHeaders, StandardRequest, StandardLazyResponse } from '@orpc/standard-server';
 
 type StandardBracketNotationSerialized = [string, unknown][];
@@ -44,7 +44,7 @@ interface StandardOpenapiLinkCodecOptions<T extends ClientContext> {
     /**
      * Base url for all requests.
      */
-    url: Value<string | URL, [
+    url: Value<Promisable<string | URL>, [
         options: ClientOptions<T>,
         path: readonly string[],
         input: unknown
@@ -52,7 +52,7 @@ interface StandardOpenapiLinkCodecOptions<T extends ClientContext> {
     /**
      * Inject headers to the request.
      */
-    headers?: Value<StandardHeaders, [
+    headers?: Value<Promisable<StandardHeaders>, [
         options: ClientOptions<T>,
         path: readonly string[],
         input: unknown

package/dist/shared/{openapi-client.D_hC2pAM.d.ts → openapi-client.Bc2pHPqD.d.ts}

@@ -1,7 +1,7 @@
 import { ClientContext, ClientOptions } from '@orpc/client';
 import { StandardLinkCodec, StandardLinkOptions, StandardLink, StandardLinkClient } from '@orpc/client/standard';
 import { AnyContractRouter } from '@orpc/contract';
-import { Segment, Value } from '@orpc/shared';
+import { Segment, Value, Promisable } from '@orpc/shared';
 import { StandardHeaders, StandardRequest, StandardLazyResponse } from '@orpc/standard-server';
 
 type StandardBracketNotationSerialized = [string, unknown][];
@@ -44,7 +44,7 @@ interface StandardOpenapiLinkCodecOptions<T extends ClientContext> {
     /**
      * Base url for all requests.
      */
-    url: Value<string | URL, [
+    url: Value<Promisable<string | URL>, [
         options: ClientOptions<T>,
         path: readonly string[],
         input: unknown
@@ -52,7 +52,7 @@ interface StandardOpenapiLinkCodecOptions<T extends ClientContext> {
     /**
      * Inject headers to the request.
      */
-    headers?: Value<StandardHeaders, [
+    headers?: Value<Promisable<StandardHeaders>, [
         options: ClientOptions<T>,
         path: readonly string[],
         input: unknown

package/dist/shared/{openapi-client.D89vdV2Y.mjs → openapi-client.BwEwVdZl.mjs}

@@ -329,6 +329,7 @@ class StandardOpenapiLinkCodec {
       return deserialized;
     }
     return {
+      status: response.status,
       headers: response.headers,
       body: deserialized
     };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@orpc/openapi-client",
   "type": "module",
-  "version": "1.1.1",
+  "version": "1.3.0",
   "license": "MIT",
   "homepage": "https://orpc.unnoq.com",
   "repository": {
@@ -34,13 +34,13 @@
     "dist"
   ],
   "dependencies": {
-    "@orpc/client": "1.1.1",
-    "@orpc/standard-server": "1.1.1",
-    "@orpc/shared": "1.1.1",
-    "@orpc/contract": "1.1.1"
+    "@orpc/client": "1.3.0",
+    "@orpc/standard-server": "1.3.0",
+    "@orpc/contract": "1.3.0",
+    "@orpc/shared": "1.3.0"
   },
   "devDependencies": {
-    "@orpc/server": "1.1.1"
+    "@orpc/server": "1.3.0"
   },
   "scripts": {
     "build": "unbuild",