@orpc/server 2.0.0-beta.3 → 2.0.0-beta.30

package/dist/helpers/index.d.mts

@@ -1,4 +1,4 @@
-import { ParseOptions, SerializeOptions } from 'cookie';
+import { ParseOptions, SetCookie, StringifyOptions } from 'cookie';
 
 /**
  * Encodes a Uint8Array to base64url format
@@ -11,6 +11,8 @@ import { ParseOptions, SerializeOptions } from 'cookie';
  * const decoded = decodeBase64url(encoded)
  * expect(new TextDecoder().decode(decoded)).toEqual(text)
  * ```
+ *
+ * @see {@link https://orpc.dev/docs/helpers/base64url | Base64Url Helpers}
  */
 declare function encodeBase64url(data: Uint8Array): string;
 /**
@@ -24,10 +26,12 @@ declare function encodeBase64url(data: Uint8Array): string;
  * const decoded = decodeBase64url(encoded)
  * expect(new TextDecoder().decode(decoded)).toEqual(text)
  * ```
+ *
+ * @see {@link https://orpc.dev/docs/helpers/base64url | Base64Url Helpers}
  */
 declare function decodeBase64url(base64url: string | undefined | null): Uint8Array<ArrayBuffer> | undefined;
 
-interface SetCookieOptions extends SerializeOptions {
+interface SetCookieOptions extends Omit<SetCookie, 'name' | 'value'>, StringifyOptions {
     /**
      * Specifies the value for the [`Path` `Set-Cookie` attribute](https://tools.ietf.org/html/rfc6265#section-5.2.4).
      *
@@ -36,7 +40,7 @@ interface SetCookieOptions extends SerializeOptions {
     path?: string;
 }
 /**
- * Sets a cookie in the response headers,
+ * Sets a cookie in the response headers.
  *
  * Does nothing if `headers` is `undefined`.
  *
@@ -46,9 +50,10 @@ interface SetCookieOptions extends SerializeOptions {
  *
  * setCookie(headers, 'sessionId', 'abc123', { httpOnly: true, maxAge: 3600 })
  *
- * expect(headers.get('Set-Cookie')).toBe('sessionId=abc123; HttpOnly; Max-Age=3600')
+ * expect(headers.get('Set-Cookie')).toBe('sessionId=abc123; Max-Age=3600; Path=/; HttpOnly')
  * ```
  *
+ * @see {@link https://orpc.dev/docs/helpers/cookie | Cookie Helpers}
  */
 declare function setCookie(headers: Headers | undefined, name: string, value: string, options?: SetCookieOptions): void;
 interface GetCookieOptions extends ParseOptions {
@@ -66,10 +71,14 @@ interface GetCookieOptions extends ParseOptions {
  *
  * expect(sessionId).toEqual('abc123')
  * ```
+ *
+ * @see {@link https://orpc.dev/docs/helpers/cookie | Cookie Helpers}
  */
 declare function getCookie(headers: Headers | undefined, name: string, options?: GetCookieOptions): string | undefined;
 /**
  * Deletes a cookie by marking it expired.
+ *
+ * @see {@link https://orpc.dev/docs/helpers/cookie | Cookie Helpers}
  */
 declare function deleteCookie(headers: Headers | undefined, name: string, options?: Omit<SetCookieOptions, 'maxAge'>): void;
 
@@ -83,6 +92,8 @@ declare function deleteCookie(headers: Headers | undefined, name: string, option
  * const decrypted = await decrypt(encrypted, "test-secret-key")
  * expect(decrypted).toBe("Hello, World!")
  * ```
+ *
+ * @see {@link https://orpc.dev/docs/helpers/encryption | Encryption Helpers}
  */
 declare function encrypt(value: string, secret: string): Promise<string>;
 /**
@@ -95,6 +106,8 @@ declare function encrypt(value: string, secret: string): Promise<string>;
  * const decrypted = await decrypt(encrypted, "test-secret-key")
  * expect(decrypted).toBe("Hello, World!")
  * ```
+ *
+ * @see {@link https://orpc.dev/docs/helpers/encryption | Encryption Helpers}
  */
 declare function decrypt(encrypted: string | undefined | null, secret: string): Promise<string | undefined>;
 
@@ -105,12 +118,13 @@ declare function decrypt(encrypted: string | undefined | null, secret: string):
  * 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")
  * ```
+ *
+ * @see {@link https://orpc.dev/docs/helpers/signing | Signing Helpers}
  */
 declare function sign(value: string, secret: string): Promise<string>;
 /**
@@ -120,13 +134,14 @@ declare function sign(value: string, secret: string): Promise<string>;
  * 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")
  * ```
+ *
+ * @see {@link https://orpc.dev/docs/helpers/signing | Signing Helpers}
  */
 declare function unsign(signedValue: string | undefined | null, secret: string): Promise<string | undefined>;
 /**
@@ -142,6 +157,8 @@ declare function unsign(signedValue: string | undefined | null, secret: string):
  * const value = getSignedValue(signedValue)
  * expect(value).toEqual("user123")
  * ```
+ *
+ * @see {@link https://orpc.dev/docs/helpers/signing | Signing Helpers}
  */
 declare function getSignedValue(signedValue: string | undefined | null): string | undefined;
 

package/dist/helpers/index.d.ts

@@ -1,4 +1,4 @@
-import { ParseOptions, SerializeOptions } from 'cookie';
+import { ParseOptions, SetCookie, StringifyOptions } from 'cookie';
 
 /**
  * Encodes a Uint8Array to base64url format
@@ -11,6 +11,8 @@ import { ParseOptions, SerializeOptions } from 'cookie';
  * const decoded = decodeBase64url(encoded)
  * expect(new TextDecoder().decode(decoded)).toEqual(text)
  * ```
+ *
+ * @see {@link https://orpc.dev/docs/helpers/base64url | Base64Url Helpers}
  */
 declare function encodeBase64url(data: Uint8Array): string;
 /**
@@ -24,10 +26,12 @@ declare function encodeBase64url(data: Uint8Array): string;
  * const decoded = decodeBase64url(encoded)
  * expect(new TextDecoder().decode(decoded)).toEqual(text)
  * ```
+ *
+ * @see {@link https://orpc.dev/docs/helpers/base64url | Base64Url Helpers}
  */
 declare function decodeBase64url(base64url: string | undefined | null): Uint8Array<ArrayBuffer> | undefined;
 
-interface SetCookieOptions extends SerializeOptions {
+interface SetCookieOptions extends Omit<SetCookie, 'name' | 'value'>, StringifyOptions {
     /**
      * Specifies the value for the [`Path` `Set-Cookie` attribute](https://tools.ietf.org/html/rfc6265#section-5.2.4).
      *
@@ -36,7 +40,7 @@ interface SetCookieOptions extends SerializeOptions {
     path?: string;
 }
 /**
- * Sets a cookie in the response headers,
+ * Sets a cookie in the response headers.
  *
  * Does nothing if `headers` is `undefined`.
  *
@@ -46,9 +50,10 @@ interface SetCookieOptions extends SerializeOptions {
  *
  * setCookie(headers, 'sessionId', 'abc123', { httpOnly: true, maxAge: 3600 })
  *
- * expect(headers.get('Set-Cookie')).toBe('sessionId=abc123; HttpOnly; Max-Age=3600')
+ * expect(headers.get('Set-Cookie')).toBe('sessionId=abc123; Max-Age=3600; Path=/; HttpOnly')
  * ```
  *
+ * @see {@link https://orpc.dev/docs/helpers/cookie | Cookie Helpers}
  */
 declare function setCookie(headers: Headers | undefined, name: string, value: string, options?: SetCookieOptions): void;
 interface GetCookieOptions extends ParseOptions {
@@ -66,10 +71,14 @@ interface GetCookieOptions extends ParseOptions {
  *
  * expect(sessionId).toEqual('abc123')
  * ```
+ *
+ * @see {@link https://orpc.dev/docs/helpers/cookie | Cookie Helpers}
  */
 declare function getCookie(headers: Headers | undefined, name: string, options?: GetCookieOptions): string | undefined;
 /**
  * Deletes a cookie by marking it expired.
+ *
+ * @see {@link https://orpc.dev/docs/helpers/cookie | Cookie Helpers}
  */
 declare function deleteCookie(headers: Headers | undefined, name: string, options?: Omit<SetCookieOptions, 'maxAge'>): void;
 
@@ -83,6 +92,8 @@ declare function deleteCookie(headers: Headers | undefined, name: string, option
  * const decrypted = await decrypt(encrypted, "test-secret-key")
  * expect(decrypted).toBe("Hello, World!")
  * ```
+ *
+ * @see {@link https://orpc.dev/docs/helpers/encryption | Encryption Helpers}
  */
 declare function encrypt(value: string, secret: string): Promise<string>;
 /**
@@ -95,6 +106,8 @@ declare function encrypt(value: string, secret: string): Promise<string>;
  * const decrypted = await decrypt(encrypted, "test-secret-key")
  * expect(decrypted).toBe("Hello, World!")
  * ```
+ *
+ * @see {@link https://orpc.dev/docs/helpers/encryption | Encryption Helpers}
  */
 declare function decrypt(encrypted: string | undefined | null, secret: string): Promise<string | undefined>;
 
@@ -105,12 +118,13 @@ declare function decrypt(encrypted: string | undefined | null, secret: string):
  * 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")
  * ```
+ *
+ * @see {@link https://orpc.dev/docs/helpers/signing | Signing Helpers}
  */
 declare function sign(value: string, secret: string): Promise<string>;
 /**
@@ -120,13 +134,14 @@ declare function sign(value: string, secret: string): Promise<string>;
  * 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")
  * ```
+ *
+ * @see {@link https://orpc.dev/docs/helpers/signing | Signing Helpers}
  */
 declare function unsign(signedValue: string | undefined | null, secret: string): Promise<string | undefined>;
 /**
@@ -142,6 +157,8 @@ declare function unsign(signedValue: string | undefined | null, secret: string):
  * const value = getSignedValue(signedValue)
  * expect(value).toEqual("user123")
  * ```
+ *
+ * @see {@link https://orpc.dev/docs/helpers/signing | Signing Helpers}
  */
 declare function getSignedValue(signedValue: string | undefined | null): string | undefined;
 

package/dist/helpers/index.mjs

@@ -1,4 +1,4 @@
-import { parse, serialize } from 'cookie';
+import { parseCookie, stringifySetCookie } from 'cookie';
 
 function encodeBase64url(data) {
   const chunkSize = 8192;
@@ -34,10 +34,17 @@ function setCookie(headers, name, value, options = {}) {
   if (headers === void 0) {
     return;
   }
-  const cookieString = serialize(name, value, {
+  const cookieString = stringifySetCookie({
+    // Force path to '/' by default so the cookie is available across the
+    // entire app, not just under the directory of the request that set it
+    // (which is what browsers do per RFC 6265 §5.1.4 when Path is omitted).
     path: "/",
-    ...options
-  });
+    ...options,
+    name,
+    // prioritize
+    value
+    // prioritize
+  }, options);
   headers.append("Set-Cookie", cookieString);
 }
 function getCookie(headers, name, options = {}) {
@@ -48,12 +55,13 @@ function getCookie(headers, name, options = {}) {
   if (cookieHeader === null) {
     return void 0;
   }
-  return parse(cookieHeader, options)[name];
+  return parseCookie(cookieHeader, options)[name];
 }
 function deleteCookie(headers, name, options = {}) {
   return setCookie(headers, name, "", {
     ...options,
     maxAge: 0
+    // prioritize
   });
 }