@orpc/server 0.0.0-next.a2fc015 → 0.0.0-next.a320605

package/dist/helpers/index.d.mts

@@ -0,0 +1,134 @@
+import { SerializeOptions, ParseOptions } from 'cookie';
+
+/**
+ * Encodes a Uint8Array to base64url format
+ * Base64url is URL-safe and doesn't use padding
+ *
+ * @example
+ * ```ts
+ * const text = "Hello World"
+ * const encoded = encodeBase64url(new TextEncoder().encode(text))
+ * const decoded = decodeBase64url(encoded)
+ * expect(new TextDecoder().decode(decoded)).toEqual(text)
+ * ```
+ */
+declare function encodeBase64url(data: Uint8Array): string;
+/**
+ * Decodes a base64url string to Uint8Array
+ * Returns undefined if the input is invalid
+ *
+ * @example
+ * ```ts
+ * const text = "Hello World"
+ * const encoded = encodeBase64url(new TextEncoder().encode(text))
+ * const decoded = decodeBase64url(encoded)
+ * expect(new TextDecoder().decode(decoded)).toEqual(text)
+ * ```
+ */
+declare function decodeBase64url(base64url: string | undefined | null): Uint8Array | undefined;
+
+interface SetCookieOptions extends SerializeOptions {
+    /**
+     * Specifies the value for the [`Path` `Set-Cookie` attribute](https://tools.ietf.org/html/rfc6265#section-5.2.4).
+     *
+     * @default '/'
+     */
+    path?: string;
+}
+/**
+ * Sets a cookie in the response headers,
+ *
+ * Does nothing if `headers` is `undefined`.
+ *
+ * @example
+ * ```ts
+ * const headers = new Headers()
+ *
+ * setCookie(headers, 'sessionId', 'abc123', { httpOnly: true, maxAge: 3600 })
+ *
+ * expect(headers.get('Set-Cookie')).toBe('sessionId=abc123; HttpOnly; Max-Age=3600')
+ * ```
+ *
+ */
+declare function setCookie(headers: Headers | undefined, name: string, value: string, options?: SetCookieOptions): void;
+interface GetCookieOptions extends ParseOptions {
+}
+/**
+ * Gets a cookie value from request headers
+ *
+ * Returns `undefined` if the cookie is not found or headers are `undefined`.
+ *
+ * @example
+ * ```ts
+ * const headers = new Headers({ 'Cookie': 'sessionId=abc123; theme=dark' })
+ *
+ * const sessionId = getCookie(headers, 'sessionId')
+ *
+ * expect(sessionId).toEqual('abc123')
+ * ```
+ */
+declare function getCookie(headers: Headers | undefined, name: string, options?: GetCookieOptions): string | undefined;
+/**
+ * Deletes a cookie by marking it expired.
+ */
+declare function deleteCookie(headers: Headers | undefined, name: string, options?: Omit<SetCookieOptions, 'maxAge'>): void;
+
+/**
+ * Encrypts a string using AES-GCM with a secret key.
+ * The output is base64url encoded to be URL-safe.
+ *
+ * @example
+ * ```ts
+ * const encrypted = await encrypt("Hello, World!", "test-secret-key")
+ * const decrypted = await decrypt(encrypted, "test-secret-key")
+ * expect(decrypted).toBe("Hello, World!")
+ * ```
+ */
+declare function encrypt(value: string, secret: string): Promise<string>;
+/**
+ * Decrypts a base64url encoded string using AES-GCM with a secret key.
+ * Returns the original string if decryption is successful, or undefined if it fails.
+ *
+ * @example
+ * ```ts
+ * const encrypted = await encrypt("Hello, World!", "test-secret-key")
+ * const decrypted = await decrypt(encrypted, "test-secret-key")
+ * expect(decrypted).toBe("Hello, World!")
+ * ```
+ */
+declare function decrypt(encrypted: string | undefined | null, secret: string): Promise<string | undefined>;
+
+/**
+ * Signs a string value using HMAC-SHA256 with a secret key.
+ *
+ * This function creates a cryptographic signature that can be used to verify
+ * the integrity and authenticity of the data. The signature is appended to
+ * the original value, separated by a dot, using base64url encoding (no padding).
+ *
+ *
+ * @example
+ * ```ts
+ * const signedValue = await sign("user123", "my-secret-key")
+ * expect(signedValue).toEqual("user123.oneQsU0r5dvwQFHFEjjV1uOI_IR3gZfkYHij3TRauVA")
+ * ```
+ */
+declare function sign(value: string, secret: string): Promise<string>;
+/**
+ * Verifies and extracts the original value from a signed string.
+ *
+ * This function validates the signature of a previously signed value using the same
+ * secret key. If the signature is valid, it returns the original value. If the
+ * signature is invalid or the format is incorrect, it returns undefined.
+ *
+ *
+ * @example
+ * ```ts
+ * const signedValue = "user123.oneQsU0r5dvwQFHFEjjV1uOI_IR3gZfkYHij3TRauVA"
+ * const originalValue = await unsign(signedValue, "my-secret-key")
+ * expect(originalValue).toEqual("user123")
+ * ```
+ */
+declare function unsign(signedValue: string | undefined | null, secret: string): Promise<string | undefined>;
+
+export { decodeBase64url, decrypt, deleteCookie, encodeBase64url, encrypt, getCookie, setCookie, sign, unsign };
+export type { GetCookieOptions, SetCookieOptions };

package/dist/helpers/index.d.ts

@@ -0,0 +1,134 @@
+import { SerializeOptions, ParseOptions } from 'cookie';
+
+/**
+ * Encodes a Uint8Array to base64url format
+ * Base64url is URL-safe and doesn't use padding
+ *
+ * @example
+ * ```ts
+ * const text = "Hello World"
+ * const encoded = encodeBase64url(new TextEncoder().encode(text))
+ * const decoded = decodeBase64url(encoded)
+ * expect(new TextDecoder().decode(decoded)).toEqual(text)
+ * ```
+ */
+declare function encodeBase64url(data: Uint8Array): string;
+/**
+ * Decodes a base64url string to Uint8Array
+ * Returns undefined if the input is invalid
+ *
+ * @example
+ * ```ts
+ * const text = "Hello World"
+ * const encoded = encodeBase64url(new TextEncoder().encode(text))
+ * const decoded = decodeBase64url(encoded)
+ * expect(new TextDecoder().decode(decoded)).toEqual(text)
+ * ```
+ */
+declare function decodeBase64url(base64url: string | undefined | null): Uint8Array | undefined;
+
+interface SetCookieOptions extends SerializeOptions {
+    /**
+     * Specifies the value for the [`Path` `Set-Cookie` attribute](https://tools.ietf.org/html/rfc6265#section-5.2.4).
+     *
+     * @default '/'
+     */
+    path?: string;
+}
+/**
+ * Sets a cookie in the response headers,
+ *
+ * Does nothing if `headers` is `undefined`.
+ *
+ * @example
+ * ```ts
+ * const headers = new Headers()
+ *
+ * setCookie(headers, 'sessionId', 'abc123', { httpOnly: true, maxAge: 3600 })
+ *
+ * expect(headers.get('Set-Cookie')).toBe('sessionId=abc123; HttpOnly; Max-Age=3600')
+ * ```
+ *
+ */
+declare function setCookie(headers: Headers | undefined, name: string, value: string, options?: SetCookieOptions): void;
+interface GetCookieOptions extends ParseOptions {
+}
+/**
+ * Gets a cookie value from request headers
+ *
+ * Returns `undefined` if the cookie is not found or headers are `undefined`.
+ *
+ * @example
+ * ```ts
+ * const headers = new Headers({ 'Cookie': 'sessionId=abc123; theme=dark' })
+ *
+ * const sessionId = getCookie(headers, 'sessionId')
+ *
+ * expect(sessionId).toEqual('abc123')
+ * ```
+ */
+declare function getCookie(headers: Headers | undefined, name: string, options?: GetCookieOptions): string | undefined;
+/**
+ * Deletes a cookie by marking it expired.
+ */
+declare function deleteCookie(headers: Headers | undefined, name: string, options?: Omit<SetCookieOptions, 'maxAge'>): void;
+
+/**
+ * Encrypts a string using AES-GCM with a secret key.
+ * The output is base64url encoded to be URL-safe.
+ *
+ * @example
+ * ```ts
+ * const encrypted = await encrypt("Hello, World!", "test-secret-key")
+ * const decrypted = await decrypt(encrypted, "test-secret-key")
+ * expect(decrypted).toBe("Hello, World!")
+ * ```
+ */
+declare function encrypt(value: string, secret: string): Promise<string>;
+/**
+ * Decrypts a base64url encoded string using AES-GCM with a secret key.
+ * Returns the original string if decryption is successful, or undefined if it fails.
+ *
+ * @example
+ * ```ts
+ * const encrypted = await encrypt("Hello, World!", "test-secret-key")
+ * const decrypted = await decrypt(encrypted, "test-secret-key")
+ * expect(decrypted).toBe("Hello, World!")
+ * ```
+ */
+declare function decrypt(encrypted: string | undefined | null, secret: string): Promise<string | undefined>;
+
+/**
+ * Signs a string value using HMAC-SHA256 with a secret key.
+ *
+ * This function creates a cryptographic signature that can be used to verify
+ * the integrity and authenticity of the data. The signature is appended to
+ * the original value, separated by a dot, using base64url encoding (no padding).
+ *
+ *
+ * @example
+ * ```ts
+ * const signedValue = await sign("user123", "my-secret-key")
+ * expect(signedValue).toEqual("user123.oneQsU0r5dvwQFHFEjjV1uOI_IR3gZfkYHij3TRauVA")
+ * ```
+ */
+declare function sign(value: string, secret: string): Promise<string>;
+/**
+ * Verifies and extracts the original value from a signed string.
+ *
+ * This function validates the signature of a previously signed value using the same
+ * secret key. If the signature is valid, it returns the original value. If the
+ * signature is invalid or the format is incorrect, it returns undefined.
+ *
+ *
+ * @example
+ * ```ts
+ * const signedValue = "user123.oneQsU0r5dvwQFHFEjjV1uOI_IR3gZfkYHij3TRauVA"
+ * const originalValue = await unsign(signedValue, "my-secret-key")
+ * expect(originalValue).toEqual("user123")
+ * ```
+ */
+declare function unsign(signedValue: string | undefined | null, secret: string): Promise<string | undefined>;
+
+export { decodeBase64url, decrypt, deleteCookie, encodeBase64url, encrypt, getCookie, setCookie, sign, unsign };
+export type { GetCookieOptions, SetCookieOptions };

package/dist/helpers/index.mjs

@@ -0,0 +1,188 @@
+import { serialize, parse } from 'cookie';
+
+function encodeBase64url(data) {
+  const chunkSize = 8192;
+  let binaryString = "";
+  for (let i = 0; i < data.length; i += chunkSize) {
+    const chunk = data.subarray(i, i + chunkSize);
+    binaryString += String.fromCharCode(...chunk);
+  }
+  const base64 = btoa(binaryString);
+  return base64.replace(/\+/g, "-").replace(/\//g, "_").replace(/=/g, "");
+}
+function decodeBase64url(base64url) {
+  try {
+    if (typeof base64url !== "string") {
+      return void 0;
+    }
+    let base64 = base64url.replace(/-/g, "+").replace(/_/g, "/");
+    while (base64.length % 4) {
+      base64 += "=";
+    }
+    const binaryString = atob(base64);
+    const bytes = new Uint8Array(binaryString.length);
+    for (let i = 0; i < binaryString.length; i++) {
+      bytes[i] = binaryString.charCodeAt(i);
+    }
+    return bytes;
+  } catch {
+    return void 0;
+  }
+}
+
+function setCookie(headers, name, value, options = {}) {
+  if (headers === void 0) {
+    return;
+  }
+  const cookieString = serialize(name, value, {
+    path: "/",
+    ...options
+  });
+  headers.append("Set-Cookie", cookieString);
+}
+function getCookie(headers, name, options = {}) {
+  if (headers === void 0) {
+    return void 0;
+  }
+  const cookieHeader = headers.get("cookie");
+  if (cookieHeader === null) {
+    return void 0;
+  }
+  return parse(cookieHeader, options)[name];
+}
+function deleteCookie(headers, name, options = {}) {
+  return setCookie(headers, name, "", {
+    ...options,
+    maxAge: 0
+  });
+}
+
+const PBKDF2_CONFIG = {
+  name: "PBKDF2",
+  iterations: 6e4,
+  // Recommended minimum iterations per current OWASP guidelines
+  hash: "SHA-256"
+};
+const AES_GCM_CONFIG = {
+  name: "AES-GCM",
+  length: 256
+};
+const CRYPTO_CONSTANTS = {
+  SALT_LENGTH: 16,
+  IV_LENGTH: 12
+};
+async function encrypt(value, secret) {
+  const encoder = new TextEncoder();
+  const data = encoder.encode(value);
+  const salt = crypto.getRandomValues(new Uint8Array(CRYPTO_CONSTANTS.SALT_LENGTH));
+  const keyMaterial = await crypto.subtle.importKey(
+    "raw",
+    encoder.encode(secret),
+    PBKDF2_CONFIG.name,
+    false,
+    ["deriveKey"]
+  );
+  const key = await crypto.subtle.deriveKey(
+    { ...PBKDF2_CONFIG, salt },
+    keyMaterial,
+    AES_GCM_CONFIG,
+    false,
+    ["encrypt"]
+  );
+  const iv = crypto.getRandomValues(new Uint8Array(CRYPTO_CONSTANTS.IV_LENGTH));
+  const encrypted = await crypto.subtle.encrypt(
+    { name: AES_GCM_CONFIG.name, iv },
+    key,
+    data
+  );
+  const result = new Uint8Array(salt.length + iv.length + encrypted.byteLength);
+  result.set(salt, 0);
+  result.set(iv, salt.length);
+  result.set(new Uint8Array(encrypted), salt.length + iv.length);
+  return encodeBase64url(result);
+}
+async function decrypt(encrypted, secret) {
+  try {
+    const data = decodeBase64url(encrypted);
+    if (data === void 0) {
+      return void 0;
+    }
+    const encoder = new TextEncoder();
+    const decoder = new TextDecoder();
+    const salt = data.slice(0, CRYPTO_CONSTANTS.SALT_LENGTH);
+    const iv = data.slice(CRYPTO_CONSTANTS.SALT_LENGTH, CRYPTO_CONSTANTS.SALT_LENGTH + CRYPTO_CONSTANTS.IV_LENGTH);
+    const encryptedData = data.slice(CRYPTO_CONSTANTS.SALT_LENGTH + CRYPTO_CONSTANTS.IV_LENGTH);
+    const keyMaterial = await crypto.subtle.importKey(
+      "raw",
+      encoder.encode(secret),
+      PBKDF2_CONFIG.name,
+      false,
+      ["deriveKey"]
+    );
+    const key = await crypto.subtle.deriveKey(
+      { ...PBKDF2_CONFIG, salt },
+      keyMaterial,
+      AES_GCM_CONFIG,
+      false,
+      ["decrypt"]
+    );
+    const decrypted = await crypto.subtle.decrypt(
+      { name: AES_GCM_CONFIG.name, iv },
+      key,
+      encryptedData
+    );
+    return decoder.decode(decrypted);
+  } catch {
+    return void 0;
+  }
+}
+
+const ALGORITHM = { name: "HMAC", hash: "SHA-256" };
+async function sign(value, secret) {
+  const encoder = new TextEncoder();
+  const key = await crypto.subtle.importKey(
+    "raw",
+    encoder.encode(secret),
+    ALGORITHM,
+    false,
+    ["sign"]
+  );
+  const signature = await crypto.subtle.sign(
+    ALGORITHM,
+    key,
+    encoder.encode(value)
+  );
+  return `${value}.${encodeBase64url(new Uint8Array(signature))}`;
+}
+async function unsign(signedValue, secret) {
+  if (typeof signedValue !== "string") {
+    return void 0;
+  }
+  const lastDotIndex = signedValue.lastIndexOf(".");
+  if (lastDotIndex === -1) {
+    return void 0;
+  }
+  const value = signedValue.slice(0, lastDotIndex);
+  const signatureBase64url = signedValue.slice(lastDotIndex + 1);
+  const signature = decodeBase64url(signatureBase64url);
+  if (signature === void 0) {
+    return void 0;
+  }
+  const encoder = new TextEncoder();
+  const key = await crypto.subtle.importKey(
+    "raw",
+    encoder.encode(secret),
+    ALGORITHM,
+    false,
+    ["verify"]
+  );
+  const isValid = await crypto.subtle.verify(
+    ALGORITHM,
+    key,
+    signature,
+    encoder.encode(value)
+  );
+  return isValid ? value : void 0;
+}
+
+export { decodeBase64url, decrypt, deleteCookie, encodeBase64url, encrypt, getCookie, setCookie, sign, unsign };

package/dist/hibernation/index.d.mts

@@ -0,0 +1,44 @@
+import { StandardRPCJsonSerializerOptions } from '@orpc/client/standard';
+import { g as StandardHandlerPlugin, e as StandardHandlerOptions } from '../shared/server.gqRxT-yN.mjs';
+import { HibernationEventIterator } from '@orpc/standard-server';
+export { HibernationEventIterator, HibernationEventIteratorCallback } from '@orpc/standard-server';
+import { C as Context, R as Router } from '../shared/server.CYNGeoCm.mjs';
+import '@orpc/client';
+import '@orpc/contract';
+import '@orpc/shared';
+
+interface EncodeHibernationRPCEventOptions extends StandardRPCJsonSerializerOptions {
+    /**
+     * The type of event, each type corresponds a different operation
+     *
+     * - 'message' = 'yield'
+     * - 'error' = 'throw'
+     * - 'done' = 'return'
+     *
+     * @default 'message'
+     */
+    event?: 'message' | 'error' | 'done';
+}
+/**
+ * Encodes a Hibernation RPC Event
+ *
+ * @see {@link https://orpc.unnoq.com/docs/plugins/hibernation Hibernation Plugin}
+ */
+declare function encodeHibernationRPCEvent(id: string, payload: unknown, options?: EncodeHibernationRPCEventOptions): string;
+
+interface HibernationPluginContext {
+    iterator?: HibernationEventIterator<any>;
+}
+/**
+ * Enable Hibernation APIs
+ *
+ * @see {@link https://orpc.unnoq.com/docs/plugins/hibernation Hibernation Plugin}
+ */
+declare class HibernationPlugin<T extends Context> implements StandardHandlerPlugin<T> {
+    readonly CONTEXT_SYMBOL: symbol;
+    order: number;
+    init(options: StandardHandlerOptions<T>, _router: Router<any, T>): void;
+}
+
+export { HibernationPlugin, encodeHibernationRPCEvent };
+export type { EncodeHibernationRPCEventOptions, HibernationPluginContext };

package/dist/hibernation/index.d.ts

@@ -0,0 +1,44 @@
+import { StandardRPCJsonSerializerOptions } from '@orpc/client/standard';
+import { g as StandardHandlerPlugin, e as StandardHandlerOptions } from '../shared/server.Bmh5xd4n.js';
+import { HibernationEventIterator } from '@orpc/standard-server';
+export { HibernationEventIterator, HibernationEventIteratorCallback } from '@orpc/standard-server';
+import { C as Context, R as Router } from '../shared/server.CYNGeoCm.js';
+import '@orpc/client';
+import '@orpc/contract';
+import '@orpc/shared';
+
+interface EncodeHibernationRPCEventOptions extends StandardRPCJsonSerializerOptions {
+    /**
+     * The type of event, each type corresponds a different operation
+     *
+     * - 'message' = 'yield'
+     * - 'error' = 'throw'
+     * - 'done' = 'return'
+     *
+     * @default 'message'
+     */
+    event?: 'message' | 'error' | 'done';
+}
+/**
+ * Encodes a Hibernation RPC Event
+ *
+ * @see {@link https://orpc.unnoq.com/docs/plugins/hibernation Hibernation Plugin}
+ */
+declare function encodeHibernationRPCEvent(id: string, payload: unknown, options?: EncodeHibernationRPCEventOptions): string;
+
+interface HibernationPluginContext {
+    iterator?: HibernationEventIterator<any>;
+}
+/**
+ * Enable Hibernation APIs
+ *
+ * @see {@link https://orpc.unnoq.com/docs/plugins/hibernation Hibernation Plugin}
+ */
+declare class HibernationPlugin<T extends Context> implements StandardHandlerPlugin<T> {
+    readonly CONTEXT_SYMBOL: symbol;
+    order: number;
+    init(options: StandardHandlerOptions<T>, _router: Router<any, T>): void;
+}
+
+export { HibernationPlugin, encodeHibernationRPCEvent };
+export type { EncodeHibernationRPCEventOptions, HibernationPluginContext };

package/dist/hibernation/index.mjs

@@ -0,0 +1,65 @@
+import { toORPCError } from '@orpc/client';
+import { StandardRPCJsonSerializer } from '@orpc/client/standard';
+import { stringifyJSON } from '@orpc/shared';
+import { getEventMeta, HibernationEventIterator } from '@orpc/standard-server';
+export { HibernationEventIterator } from '@orpc/standard-server';
+import { MessageType } from '@orpc/standard-server-peer';
+
+function encodeHibernationRPCEvent(id, payload, options = {}) {
+  const { event = "message", ...rest } = options;
+  const serializer = new StandardRPCJsonSerializer(rest);
+  const data = event === "error" ? toORPCError(payload).toJSON() : payload;
+  const [json, meta] = serializer.serialize(data);
+  return stringifyJSON({
+    i: id,
+    t: MessageType.EVENT_ITERATOR,
+    p: {
+      e: event,
+      d: { json, meta: meta.length > 0 ? meta : void 0 },
+      m: getEventMeta(payload)
+    }
+  });
+}
+
+class HibernationPlugin {
+  CONTEXT_SYMBOL = Symbol("ORPC_HIBERNATION_CONTEXT");
+  order = 2e6;
+  // make sure execute after the batch plugin
+  init(options, _router) {
+    options.interceptors ??= [];
+    options.clientInterceptors ??= [];
+    options.interceptors.unshift(async (options2) => {
+      const hibernationContext = {};
+      const result = await options2.next({
+        ...options2,
+        context: {
+          ...options2.context,
+          [this.CONTEXT_SYMBOL]: hibernationContext
+        }
+      });
+      if (!result.matched || !hibernationContext.iterator) {
+        return result;
+      }
+      return {
+        ...result,
+        response: {
+          ...result.response,
+          body: hibernationContext.iterator
+        }
+      };
+    });
+    options.clientInterceptors.unshift(async (options2) => {
+      const hibernationContext = options2.context[this.CONTEXT_SYMBOL];
+      if (!hibernationContext) {
+        throw new TypeError("[HibernationPlugin] Hibernation context has been corrupted or modified by another plugin or interceptor");
+      }
+      const output = await options2.next();
+      if (output instanceof HibernationEventIterator) {
+        hibernationContext.iterator = output;
+      }
+      return output;
+    });
+  }
+}
+
+export { HibernationPlugin, encodeHibernationRPCEvent };