@orpc/openapi-client 0.0.0-next.b4fc1d9 → 0.0.0-next.b50e4fc

package/dist/adapters/standard/index.mjs

@@ -1,229 +1,8 @@
-import { isObject, isAsyncIteratorObject } from '@orpc/shared';
-import { mapEventIterator, toORPCError, ORPCError } from '@orpc/client';
-import { ErrorEvent } from '@orpc/standard-server';
-
-class StandardBracketNotationSerializer {
-  serialize(data, segments = [], result = []) {
-    if (Array.isArray(data)) {
-      data.forEach((item, i) => {
-        this.serialize(item, [...segments, i], result);
-      });
-    } else if (isObject(data)) {
-      for (const key in data) {
-        this.serialize(data[key], [...segments, key], result);
-      }
-    } else {
-      result.push([this.stringifyPath(segments), data]);
-    }
-    return result;
-  }
-  deserialize(serialized) {
-    if (serialized.length === 0) {
-      return {};
-    }
-    const arrayPushStyles = /* @__PURE__ */ new WeakSet();
-    const ref = { value: [] };
-    for (const [path, value] of serialized) {
-      const segments = this.parsePath(path);
-      let currentRef = ref;
-      let nextSegment = "value";
-      segments.forEach((segment, i) => {
-        if (!Array.isArray(currentRef[nextSegment]) && !isObject(currentRef[nextSegment])) {
-          currentRef[nextSegment] = [];
-        }
-        if (i !== segments.length - 1) {
-          if (Array.isArray(currentRef[nextSegment]) && !isValidArrayIndex(segment)) {
-            currentRef[nextSegment] = { ...currentRef[nextSegment] };
-          }
-        } else {
-          if (Array.isArray(currentRef[nextSegment])) {
-            if (segment === "") {
-              if (currentRef[nextSegment].length && !arrayPushStyles.has(currentRef[nextSegment])) {
-                currentRef[nextSegment] = { ...currentRef[nextSegment] };
-              }
-            } else {
-              if (arrayPushStyles.has(currentRef[nextSegment])) {
-                currentRef[nextSegment] = { "": currentRef[nextSegment].at(-1) };
-              } else if (!isValidArrayIndex(segment)) {
-                currentRef[nextSegment] = { ...currentRef[nextSegment] };
-              }
-            }
-          }
-        }
-        currentRef = currentRef[nextSegment];
-        nextSegment = segment;
-      });
-      if (Array.isArray(currentRef)) {
-        if (nextSegment === "") {
-          arrayPushStyles.add(currentRef);
-          currentRef.push(value);
-        } else {
-          currentRef[Number(nextSegment)] = value;
-        }
-      } else {
-        currentRef[nextSegment] = value;
-      }
-    }
-    return ref.value;
-  }
-  stringifyPath(segments) {
-    return segments.map((segment) => {
-      return segment.toString().replace(/[\\[\]]/g, (match) => {
-        switch (match) {
-          case "\\":
-            return "\\\\";
-          case "[":
-            return "\\[";
-          case "]":
-            return "\\]";
-          /* v8 ignore next 2 */
-          default:
-            return match;
-        }
-      });
-    }).reduce((result, segment, i) => {
-      if (i === 0) {
-        return segment;
-      }
-      return `${result}[${segment}]`;
-    }, "");
-  }
-  parsePath(path) {
-    const segments = [];
-    let inBrackets = false;
-    let currentSegment = "";
-    let backslashCount = 0;
-    for (let i = 0; i < path.length; i++) {
-      const char = path[i];
-      const nextChar = path[i + 1];
-      if (inBrackets && char === "]" && (nextChar === void 0 || nextChar === "[") && backslashCount % 2 === 0) {
-        if (nextChar === void 0) {
-          inBrackets = false;
-        }
-        segments.push(currentSegment);
-        currentSegment = "";
-        i++;
-      } else if (segments.length === 0 && char === "[" && backslashCount % 2 === 0) {
-        inBrackets = true;
-        segments.push(currentSegment);
-        currentSegment = "";
-      } else if (char === "\\") {
-        backslashCount++;
-      } else {
-        currentSegment += "\\".repeat(backslashCount / 2) + char;
-        backslashCount = 0;
-      }
-    }
-    return inBrackets || segments.length === 0 ? [path] : segments;
-  }
-}
-function isValidArrayIndex(value) {
-  return /^0$|^[1-9]\d*$/.test(value);
-}
-
-class StandardOpenAPIJsonSerializer {
-  customSerializers;
-  constructor(options = {}) {
-    this.customSerializers = options.customJsonSerializers ?? [];
-  }
-  serialize(data, hasBlobRef = { value: false }) {
-    for (const custom of this.customSerializers) {
-      if (custom.condition(data)) {
-        const result = this.serialize(custom.serialize(data), hasBlobRef);
-        return result;
-      }
-    }
-    if (data instanceof Blob) {
-      hasBlobRef.value = true;
-      return [data, hasBlobRef.value];
-    }
-    if (data instanceof Set) {
-      return this.serialize(Array.from(data), hasBlobRef);
-    }
-    if (data instanceof Map) {
-      return this.serialize(Array.from(data.entries()), hasBlobRef);
-    }
-    if (Array.isArray(data)) {
-      const json = data.map((v) => v === void 0 ? null : this.serialize(v, hasBlobRef)[0]);
-      return [json, hasBlobRef.value];
-    }
-    if (isObject(data)) {
-      const json = {};
-      for (const k in data) {
-        if (k === "toJSON" && typeof data[k] === "function") {
-          continue;
-        }
-        json[k] = this.serialize(data[k], hasBlobRef)[0];
-      }
-      return [json, hasBlobRef.value];
-    }
-    if (typeof data === "bigint" || data instanceof RegExp || data instanceof URL) {
-      return [data.toString(), hasBlobRef.value];
-    }
-    if (data instanceof Date) {
-      return [Number.isNaN(data.getTime()) ? null : data.toISOString(), hasBlobRef.value];
-    }
-    if (Number.isNaN(data)) {
-      return [null, hasBlobRef.value];
-    }
-    return [data, hasBlobRef.value];
-  }
-}
-
-class StandardOpenAPISerializer {
-  constructor(jsonSerializer, bracketNotation) {
-    this.jsonSerializer = jsonSerializer;
-    this.bracketNotation = bracketNotation;
-  }
-  serialize(data) {
-    if (isAsyncIteratorObject(data)) {
-      return mapEventIterator(data, {
-        value: async (value) => this.#serialize(value, false),
-        error: async (e) => {
-          return new ErrorEvent({
-            data: this.#serialize(toORPCError(e).toJSON(), false),
-            cause: e
-          });
-        }
-      });
-    }
-    return this.#serialize(data, true);
-  }
-  #serialize(data, enableFormData) {
-    if (data instanceof Blob || data === void 0) {
-      return data;
-    }
-    const [json, hasBlob] = this.jsonSerializer.serialize(data);
-    if (!enableFormData || !hasBlob) {
-      return json;
-    }
-    const form = new FormData();
-    for (const [path, value] of this.bracketNotation.serialize(json)) {
-      if (typeof value === "string" || typeof value === "number" || typeof value === "boolean") {
-        form.append(path, value.toString());
-      } else if (value instanceof Blob) {
-        form.append(path, value);
-      }
-    }
-    return form;
-  }
-  deserialize(data) {
-    if (data instanceof URLSearchParams || data instanceof FormData) {
-      return this.bracketNotation.deserialize(Array.from(data.entries()));
-    }
-    if (isAsyncIteratorObject(data)) {
-      return mapEventIterator(data, {
-        value: async (value) => value,
-        error: async (e) => {
-          if (e instanceof ErrorEvent && ORPCError.isValidJSON(e.data)) {
-            return ORPCError.fromJSON(e.data, { cause: e });
-          }
-          return e;
-        }
-      });
-    }
-    return data;
-  }
-}
-
-export { StandardBracketNotationSerializer, StandardOpenAPIJsonSerializer, StandardOpenAPISerializer };
+export { S as StandardBracketNotationSerializer } from '../../shared/openapi-client.t9fCAe3x.mjs';
+export { g as getIssueMessage, p as parseFormData } from '../../shared/openapi-client.Dgl8z2tb.mjs';
+export { S as StandardOpenAPIJsonSerializer, a as StandardOpenAPILink, c as StandardOpenAPISerializer, b as StandardOpenapiLinkCodec, g as getDynamicParams, s as standardizeHTTPPath } from '../../shared/openapi-client.B2Q9qU5m.mjs';
+import '@orpc/shared';
+import '@orpc/contract';
+import '@orpc/client/standard';
+import '@orpc/client';
+import '@orpc/standard-server';

package/dist/helpers/index.d.mts

@@ -0,0 +1,54 @@
+/**
+ * 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.dev/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.dev/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;
+
+export { getIssueMessage, parseFormData };

package/dist/helpers/index.d.ts

@@ -0,0 +1,54 @@
+/**
+ * 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.dev/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.dev/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;
+
+export { getIssueMessage, parseFormData };

package/dist/helpers/index.mjs

@@ -0,0 +1,7 @@
+import '@orpc/shared';
+export { g as getIssueMessage, p as parseFormData } from '../shared/openapi-client.Dgl8z2tb.mjs';
+import '@orpc/client/standard';
+import '@orpc/client';
+import '@orpc/contract';
+import '@orpc/standard-server';
+import '../shared/openapi-client.t9fCAe3x.mjs';

package/dist/index.d.mts

@@ -1,2 +1,16 @@
+import { NestedClient, Client, ORPCError } from '@orpc/client';
 
-export {  }
+type JsonifiedValue<T> = T extends string ? T : T extends number ? T : T extends boolean ? T : T extends null ? T : T extends undefined ? T : T extends Array<unknown> ? JsonifiedArray<T> : T extends Record<string, unknown> ? {
+    [K in keyof T]: JsonifiedValue<T[K]>;
+} : T extends Date ? string : T extends bigint ? string : T extends File ? File : T extends Blob ? Blob : T extends RegExp ? string : T extends URL ? string : T extends Map<infer K, infer V> ? JsonifiedArray<[K, V][]> : T extends Set<infer U> ? JsonifiedArray<U[]> : T extends AsyncIteratorObject<infer U, infer V> ? AsyncIteratorObject<JsonifiedValue<U>, JsonifiedValue<V>> : unknown;
+type JsonifiedArray<T extends Array<unknown>> = T extends readonly [] ? [] : T extends readonly [infer U, ...infer V] ? [U extends undefined ? null : JsonifiedValue<U>, ...JsonifiedArray<V>] : T extends Array<infer U> ? Array<JsonifiedValue<U>> : unknown;
+/**
+ * Convert types that JSON not support to corresponding json types
+ *
+ * @see {@link https://orpc.dev/docs/openapi/client/openapi-link OpenAPI Link Docs}
+ */
+type JsonifiedClient<T extends NestedClient<any>> = T extends Client<infer UClientContext, infer UInput, infer UOutput, infer UError> ? Client<UClientContext, UInput, JsonifiedValue<UOutput>, UError extends ORPCError<infer UCode, infer UData> ? ORPCError<UCode, JsonifiedValue<UData>> : UError> : {
+    [K in keyof T]: T[K] extends NestedClient<any> ? JsonifiedClient<T[K]> : T[K];
+};
+
+export type { JsonifiedArray, JsonifiedClient, JsonifiedValue };

package/dist/index.d.ts

@@ -1,2 +1,16 @@
+import { NestedClient, Client, ORPCError } from '@orpc/client';
 
-export {  }
+type JsonifiedValue<T> = T extends string ? T : T extends number ? T : T extends boolean ? T : T extends null ? T : T extends undefined ? T : T extends Array<unknown> ? JsonifiedArray<T> : T extends Record<string, unknown> ? {
+    [K in keyof T]: JsonifiedValue<T[K]>;
+} : T extends Date ? string : T extends bigint ? string : T extends File ? File : T extends Blob ? Blob : T extends RegExp ? string : T extends URL ? string : T extends Map<infer K, infer V> ? JsonifiedArray<[K, V][]> : T extends Set<infer U> ? JsonifiedArray<U[]> : T extends AsyncIteratorObject<infer U, infer V> ? AsyncIteratorObject<JsonifiedValue<U>, JsonifiedValue<V>> : unknown;
+type JsonifiedArray<T extends Array<unknown>> = T extends readonly [] ? [] : T extends readonly [infer U, ...infer V] ? [U extends undefined ? null : JsonifiedValue<U>, ...JsonifiedArray<V>] : T extends Array<infer U> ? Array<JsonifiedValue<U>> : unknown;
+/**
+ * Convert types that JSON not support to corresponding json types
+ *
+ * @see {@link https://orpc.dev/docs/openapi/client/openapi-link OpenAPI Link Docs}
+ */
+type JsonifiedClient<T extends NestedClient<any>> = T extends Client<infer UClientContext, infer UInput, infer UOutput, infer UError> ? Client<UClientContext, UInput, JsonifiedValue<UOutput>, UError extends ORPCError<infer UCode, infer UData> ? ORPCError<UCode, JsonifiedValue<UData>> : UError> : {
+    [K in keyof T]: T[K] extends NestedClient<any> ? JsonifiedClient<T[K]> : T[K];
+};
+
+export type { JsonifiedArray, JsonifiedClient, JsonifiedValue };