better-ship 0.27.0 → 0.28.0

package/dist/cloudflare/rate-limiter.d.ts

@@ -0,0 +1,34 @@
+import { Xt as AppError } from "../index-DUFS0SJ_.js";
+//#region src/infrastructure/cloudflare/rate-limiter.d.ts
+/**
+ * Caller limits through a Workers Rate Limiting binding. Ported from the `consume` path of
+ * `better-auth/rate-limit.ts` and Porte `auth-rate-limit.ts`. This module does not log.
+ */
+/** The binding threw instead of answering. A refused call is `RateLimitError`, never this error. */
+export declare class RateLimiterUnavailableError extends AppError {
+  readonly scope: string;
+  readonly _tag = "RateLimiterUnavailableError";
+  readonly classification = "unknown";
+  constructor(scope: string, cause: unknown);
+}
+/** One feature's limit on a binding. The binding's `simple.limit` sets how many calls a window allows. */
+export type RateLimiterOptions = {
+  readonly binding: Pick<RateLimit, 'limit'>;
+  /** Names the feature. Two scopes on one binding keep separate counters. */
+  readonly scope: string;
+  /** The binding's `simple.period` in seconds. Cloudflare accepts only 10 or 60. */
+  readonly window: 10 | 60;
+};
+/** Counts calls for each caller key inside one scope. */
+export type RateLimiter = {
+  /**
+   * Count one call for `key`, and resolve when the binding allows it.
+   * A refused call throws `RateLimitError` with `retryAfter` set to the window.
+   * A binding failure throws `RateLimiterUnavailableError`. The call does not retry, because a retry counts again.
+   */
+  readonly limit: (key: string) => Promise<void>;
+};
+/** Bind one scope and window to a Rate Limiting binding. Build it once in the composition root. */
+export declare function createRateLimiter(options: RateLimiterOptions): RateLimiter;
+//#endregion
+//# sourceMappingURL=rate-limiter.d.ts.map

package/dist/cloudflare/rate-limiter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"rate-limiter.d.ts","names":[],"sources":["../../src/infrastructure/cloudflare/rate-limiter.ts"],"mappings":";;;;;;;qBAQa,oCAAoC;WAKpC;WAJF;WACA;EAET,YACW,eACT;;;YAOQ;WACD,SAAS,KAAK;;WAEd;;WAEA;;;YAIC;;;;;;WAMD,QAAQ,gBAAgB;;;wBAInB,kBAAkB,SAAS,qBAAqB"}

package/dist/cloudflare/rate-limiter.js

@@ -0,0 +1,35 @@
+import { U as RateLimitError, nt as AppError } from "../core-BiN6S_cm.js";
+
+//#region src/infrastructure/cloudflare/rate-limiter.ts
+/**
+* Caller limits through a Workers Rate Limiting binding. Ported from the `consume` path of
+* `better-auth/rate-limit.ts` and Porte `auth-rate-limit.ts`. This module does not log.
+*/
+/** The binding threw instead of answering. A refused call is `RateLimitError`, never this error. */
+var RateLimiterUnavailableError = class extends AppError {
+	scope;
+	_tag = "RateLimiterUnavailableError";
+	classification = "unknown";
+	constructor(scope, cause) {
+		super("Rate limiter is unavailable", { cause });
+		this.scope = scope;
+	}
+};
+/** Bind one scope and window to a Rate Limiting binding. Build it once in the composition root. */
+function createRateLimiter(options) {
+	return { async limit(key) {
+		const { success } = await consume(options, key);
+		if (!success) throw new RateLimitError(options.window);
+	} };
+}
+async function consume(options, key) {
+	try {
+		return await options.binding.limit({ key: JSON.stringify([options.scope, key]) });
+	} catch (cause) {
+		throw new RateLimiterUnavailableError(options.scope, cause);
+	}
+}
+
+//#endregion
+export { RateLimiterUnavailableError, createRateLimiter };
+//# sourceMappingURL=rate-limiter.js.map

package/dist/cloudflare/rate-limiter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"rate-limiter.js","names":[],"sources":["../../src/infrastructure/cloudflare/rate-limiter.ts"],"sourcesContent":["import { AppError, RateLimitError } from '@/core'\n\n/**\n * Caller limits through a Workers Rate Limiting binding. Ported from the `consume` path of\n * `better-auth/rate-limit.ts` and Porte `auth-rate-limit.ts`. This module does not log.\n */\n\n/** The binding threw instead of answering. A refused call is `RateLimitError`, never this error. */\nexport class RateLimiterUnavailableError extends AppError {\n  readonly _tag = 'RateLimiterUnavailableError'\n  readonly classification = 'unknown'\n\n  constructor(\n    readonly scope: string,\n    cause: unknown,\n  ) {\n    super('Rate limiter is unavailable', { cause })\n  }\n}\n\n/** One feature's limit on a binding. The binding's `simple.limit` sets how many calls a window allows. */\nexport type RateLimiterOptions = {\n  readonly binding: Pick<RateLimit, 'limit'>\n  /** Names the feature. Two scopes on one binding keep separate counters. */\n  readonly scope: string\n  /** The binding's `simple.period` in seconds. Cloudflare accepts only 10 or 60. */\n  readonly window: 10 | 60\n}\n\n/** Counts calls for each caller key inside one scope. */\nexport type RateLimiter = {\n  /**\n   * Count one call for `key`, and resolve when the binding allows it.\n   * A refused call throws `RateLimitError` with `retryAfter` set to the window.\n   * A binding failure throws `RateLimiterUnavailableError`. The call does not retry, because a retry counts again.\n   */\n  readonly limit: (key: string) => Promise<void>\n}\n\n/** Bind one scope and window to a Rate Limiting binding. Build it once in the composition root. */\nexport function createRateLimiter(options: RateLimiterOptions): RateLimiter {\n  return {\n    async limit(key) {\n      const { success } = await consume(options, key)\n      if (!success) throw new RateLimitError(options.window)\n    },\n  }\n}\n\nasync function consume(options: RateLimiterOptions, key: string): Promise<RateLimitOutcome> {\n  try {\n    // A JSON pair keeps `a:b` + `c` apart from `a` + `b:c`.\n    return await options.binding.limit({ key: JSON.stringify([options.scope, key]) })\n  } catch (cause) {\n    throw new RateLimiterUnavailableError(options.scope, cause)\n  }\n}\n"],"mappings":";;;;;;;;AAQA,IAAa,8BAAb,cAAiD,SAAS;CAK7C;CAJX,AAAS,OAAO;CAChB,AAAS,iBAAiB;CAE1B,YACE,AAAS,OACT,OACA;EACA,MAAM,+BAA+B,EAAE,MAAM,CAAC;EAHrC;CAIX;AACF;;AAsBA,SAAgB,kBAAkB,SAA0C;CAC1E,OAAO,EACL,MAAM,MAAM,KAAK;EACf,MAAM,EAAE,YAAY,MAAM,QAAQ,SAAS,GAAG;EAC9C,IAAI,CAAC,SAAS,MAAM,IAAI,eAAe,QAAQ,MAAM;CACvD,EACF;AACF;AAEA,eAAe,QAAQ,SAA6B,KAAwC;CAC1F,IAAI;EAEF,OAAO,MAAM,QAAQ,QAAQ,MAAM,EAAE,KAAK,KAAK,UAAU,CAAC,QAAQ,OAAO,GAAG,CAAC,EAAE,CAAC;CAClF,SAAS,OAAO;EACd,MAAM,IAAI,4BAA4B,QAAQ,OAAO,KAAK;CAC5D;AACF"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "$schema": "https://www.schemastore.org/package.json",
   "name": "better-ship",
-  "version": "0.27.0",
+  "version": "0.28.0",
   "description": "Foundation for applications on Cloudflare Workers: logger, errors, message bus, infrastructure adapters, and UI primitives",
   "license": "Apache-2.0",
   "repository": {
@@ -36,6 +36,7 @@
     "./cloudflare/queue": "./dist/cloudflare/queue.js",
     "./cloudflare/r2-client": "./dist/cloudflare/r2-client.js",
     "./cloudflare/r2-errors": "./dist/cloudflare/r2-errors.js",
+    "./cloudflare/rate-limiter": "./dist/cloudflare/rate-limiter.js",
     "./cloudflare/scheduled": "./dist/cloudflare/scheduled.js",
     "./cloudflare/tracing": "./dist/cloudflare/tracing.js",
     "./cloudflare/turnstile": "./dist/cloudflare/turnstile.js",

package/src/infrastructure/cloudflare/rate-limiter.ts

@@ -0,0 +1,57 @@
+import { AppError, RateLimitError } from '@/core'
+
+/**
+ * Caller limits through a Workers Rate Limiting binding. Ported from the `consume` path of
+ * `better-auth/rate-limit.ts` and Porte `auth-rate-limit.ts`. This module does not log.
+ */
+
+/** The binding threw instead of answering. A refused call is `RateLimitError`, never this error. */
+export class RateLimiterUnavailableError extends AppError {
+  readonly _tag = 'RateLimiterUnavailableError'
+  readonly classification = 'unknown'
+
+  constructor(
+    readonly scope: string,
+    cause: unknown,
+  ) {
+    super('Rate limiter is unavailable', { cause })
+  }
+}
+
+/** One feature's limit on a binding. The binding's `simple.limit` sets how many calls a window allows. */
+export type RateLimiterOptions = {
+  readonly binding: Pick<RateLimit, 'limit'>
+  /** Names the feature. Two scopes on one binding keep separate counters. */
+  readonly scope: string
+  /** The binding's `simple.period` in seconds. Cloudflare accepts only 10 or 60. */
+  readonly window: 10 | 60
+}
+
+/** Counts calls for each caller key inside one scope. */
+export type RateLimiter = {
+  /**
+   * Count one call for `key`, and resolve when the binding allows it.
+   * A refused call throws `RateLimitError` with `retryAfter` set to the window.
+   * A binding failure throws `RateLimiterUnavailableError`. The call does not retry, because a retry counts again.
+   */
+  readonly limit: (key: string) => Promise<void>
+}
+
+/** Bind one scope and window to a Rate Limiting binding. Build it once in the composition root. */
+export function createRateLimiter(options: RateLimiterOptions): RateLimiter {
+  return {
+    async limit(key) {
+      const { success } = await consume(options, key)
+      if (!success) throw new RateLimitError(options.window)
+    },
+  }
+}
+
+async function consume(options: RateLimiterOptions, key: string): Promise<RateLimitOutcome> {
+  try {
+    // A JSON pair keeps `a:b` + `c` apart from `a` + `b:c`.
+    return await options.binding.limit({ key: JSON.stringify([options.scope, key]) })
+  } catch (cause) {
+    throw new RateLimiterUnavailableError(options.scope, cause)
+  }
+}