@rdlabo/workers-hono-kit 0.2.0 → 0.2.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (97) hide show
  1. package/README.md +126 -11
  2. package/dist/ai/gateway.d.ts +54 -16
  3. package/dist/ai/gateway.js +37 -12
  4. package/dist/aws/cloudfront.d.ts +23 -5
  5. package/dist/aws/cloudfront.js +45 -6
  6. package/dist/aws/secrets-manager.d.ts +38 -4
  7. package/dist/aws/secrets-manager.js +48 -3
  8. package/dist/cache/kv-cache.d.ts +173 -10
  9. package/dist/cache/kv-cache.js +139 -7
  10. package/dist/db/connection.d.ts +56 -14
  11. package/dist/db/connection.js +39 -13
  12. package/dist/db/database.d.ts +159 -23
  13. package/dist/db/database.js +49 -5
  14. package/dist/db/index.d.ts +11 -0
  15. package/dist/db/index.js +11 -2
  16. package/dist/db/jst.d.ts +89 -6
  17. package/dist/db/jst.js +89 -23
  18. package/dist/db/orm-config.d.ts +61 -19
  19. package/dist/db/orm-config.js +43 -14
  20. package/dist/db/retry.d.ts +25 -3
  21. package/dist/db/retry.js +25 -3
  22. package/dist/db/write-result.d.ts +27 -4
  23. package/dist/db/write-result.js +22 -1
  24. package/dist/firebase/firebase-verifier.d.ts +53 -4
  25. package/dist/firebase/identity-toolkit.d.ts +54 -5
  26. package/dist/firebase/identity-toolkit.js +51 -0
  27. package/dist/firebase/jose-firebase-verifier.d.ts +79 -7
  28. package/dist/firebase/jose-firebase-verifier.js +68 -7
  29. package/dist/firebase/remote-verifier.d.ts +42 -4
  30. package/dist/firebase/remote-verifier.js +58 -9
  31. package/dist/http/app-env.d.ts +41 -8
  32. package/dist/http/app-env.js +38 -8
  33. package/dist/http/app-info.d.ts +25 -3
  34. package/dist/http/app-info.js +16 -2
  35. package/dist/http/http-status.d.ts +12 -3
  36. package/dist/http/http-status.js +12 -3
  37. package/dist/http/nest-error.d.ts +90 -29
  38. package/dist/http/nest-error.js +59 -18
  39. package/dist/http/user-protocol.d.ts +23 -3
  40. package/dist/http/user-protocol.js +14 -2
  41. package/dist/index.d.ts +11 -0
  42. package/dist/index.js +11 -3
  43. package/dist/middleware/auth.d.ts +74 -13
  44. package/dist/middleware/auth.js +30 -6
  45. package/dist/middleware/finalize-response.d.ts +30 -0
  46. package/dist/middleware/finalize-response.js +41 -12
  47. package/dist/middleware/validation.d.ts +83 -9
  48. package/dist/middleware/validation.js +52 -9
  49. package/dist/middleware/zod-coerce.d.ts +56 -2
  50. package/dist/middleware/zod-coerce.js +68 -9
  51. package/dist/stripe/client.d.ts +46 -9
  52. package/dist/stripe/client.js +41 -3
  53. package/dist/testing/auth.d.ts +58 -10
  54. package/dist/testing/auth.js +58 -10
  55. package/dist/testing/configurable-fake.d.ts +20 -9
  56. package/dist/testing/configurable-fake.js +23 -11
  57. package/dist/testing/db.d.ts +81 -12
  58. package/dist/testing/db.js +23 -1
  59. package/dist/testing/fakes.d.ts +77 -9
  60. package/dist/testing/fakes.js +69 -7
  61. package/dist/testing/index.d.ts +7 -0
  62. package/dist/testing/index.js +10 -5
  63. package/dist/testing/stripe-fixtures.d.ts +93 -3
  64. package/dist/testing/stripe-fixtures.js +93 -3
  65. package/package.json +1 -1
  66. package/src/ai/gateway.ts +66 -27
  67. package/src/aws/cloudfront.ts +46 -6
  68. package/src/aws/secrets-manager.ts +56 -7
  69. package/src/cache/kv-cache.ts +194 -12
  70. package/src/db/connection.ts +56 -14
  71. package/src/db/database.ts +160 -24
  72. package/src/db/index.ts +11 -2
  73. package/src/db/jst.ts +89 -23
  74. package/src/db/orm-config.ts +61 -19
  75. package/src/db/retry.ts +25 -3
  76. package/src/db/write-result.ts +27 -4
  77. package/src/firebase/firebase-verifier.ts +53 -4
  78. package/src/firebase/identity-toolkit.ts +57 -5
  79. package/src/firebase/jose-firebase-verifier.ts +79 -9
  80. package/src/firebase/remote-verifier.ts +58 -9
  81. package/src/http/app-env.ts +41 -8
  82. package/src/http/app-info.ts +25 -3
  83. package/src/http/http-status.ts +12 -3
  84. package/src/http/nest-error.ts +106 -37
  85. package/src/http/user-protocol.ts +23 -3
  86. package/src/index.ts +11 -3
  87. package/src/middleware/auth.ts +77 -15
  88. package/src/middleware/finalize-response.ts +41 -12
  89. package/src/middleware/validation.ts +89 -15
  90. package/src/middleware/zod-coerce.ts +68 -9
  91. package/src/stripe/client.ts +46 -9
  92. package/src/testing/auth.ts +58 -10
  93. package/src/testing/configurable-fake.ts +23 -11
  94. package/src/testing/db.ts +82 -13
  95. package/src/testing/fakes.ts +77 -9
  96. package/src/testing/index.ts +10 -5
  97. package/src/testing/stripe-fixtures.ts +93 -3
@@ -1,10 +1,15 @@
1
- // @rdlabo/workers-hono-kit/testing — フリート共通のテスト基盤(mysql2/drizzle 依存)。
2
- // 実行時には読み込まれないテスト専用ヘルパ。各 repo testing/db.ts・fakes.ts を集約。
1
+ /**
2
+ * Shared test infrastructure for Hono on Cloudflare Workers projects (depends on `mysql2`/`drizzle-orm`).
3
+ *
4
+ * Test-only helpers that are never loaded at runtime. This subpath consolidates the duplicated
5
+ * test boilerplate (test DB setup, in-memory fakes, auth header builders, Stripe fixtures) that
6
+ * tends to be copy-pasted across projects into a single, importable surface.
7
+ */
3
8
  export { createTestDb } from './db.js';
4
9
  export { FakeFirebaseVerifier, createPoolDatabase, createNoopDatabase } from './fakes.js';
5
- // 認証テストヘルパ(route spec のヘッダ生成・ユーザ provision を集約)。
10
+ // Authentication test helpers (route-spec header builders and user provisioning).
6
11
  export { authHeaders, registerFirebaseToken, provisionUser } from './auth.js';
7
- // test double ヘルパ(未設定メソッドで明示 throw する部分実装 fake)。
12
+ // Test double helper (partial-implementation fake that throws explicitly on unconfigured members).
8
13
  export { configurableFake } from './configurable-fake.js';
9
- // Stripe オブジェクトの test fixture factory。
14
+ // Test fixture factories for Stripe objects.
10
15
  export { fakeApiList, fakePaymentIntent, fakeStripeEvent, fakeCheckoutSession, fakeCustomer, fakePrice, fakeSubscription, } from './stripe-fixtures.js';
@@ -1,13 +1,103 @@
1
1
  import type Stripe from 'stripe';
2
2
  /**
3
- * Stripe オブジェクトの test fixture factory。実 SDK 型は巨大なので、テストが参照する範囲だけを
4
- * 妥当な既定値で組み、`over` で上書きする(最後に 1 度だけ Stripe 型へキャスト)。fleet 各 repo の
5
- * 課金テストで同じダミー PaymentIntent/Event/... を手組みしていた重複を集約する。
3
+ * Test fixture factories for Stripe objects.
4
+ *
5
+ * The real SDK types are enormous, so each factory builds only the fields tests typically read,
6
+ * fills them with reasonable defaults, lets you override via `over`, and casts to the Stripe type
7
+ * once at the end. This consolidates the duplicated hand-built dummy `PaymentIntent`/`Event`/... that
8
+ * billing tests tend to reconstruct in every project.
9
+ */
10
+ /**
11
+ * Build a fake Stripe `ApiList` wrapping the given data.
12
+ *
13
+ * @remarks Defaults: `object: 'list'`, `has_more: false`, `url: '/v1/_test'`.
14
+ * @typeParam T - Element type of the list.
15
+ * @param data - Items to place in `data`.
16
+ * @param over - Field overrides merged last.
17
+ * @returns A `Stripe.ApiList<T>` fixture.
18
+ * @example
19
+ * ```ts
20
+ * const list = fakeApiList([fakePaymentIntent()]);
21
+ * ```
6
22
  */
7
23
  export declare function fakeApiList<T>(data: T[], over?: Partial<Stripe.ApiList<T>>): Stripe.ApiList<T>;
24
+ /**
25
+ * Build a fake Stripe `PaymentIntent`.
26
+ *
27
+ * @remarks Defaults: `id: 'pi_test_1'`, `object: 'payment_intent'`, `amount: 1000`, `currency: 'jpy'`,
28
+ * `status: 'succeeded'`, `created: 1_700_000_000`.
29
+ * @param over - Field overrides merged last.
30
+ * @returns A `Stripe.PaymentIntent` fixture.
31
+ * @example
32
+ * ```ts
33
+ * const pi = fakePaymentIntent({ status: 'requires_payment_method' });
34
+ * ```
35
+ */
8
36
  export declare function fakePaymentIntent(over?: Partial<Stripe.PaymentIntent>): Stripe.PaymentIntent;
37
+ /**
38
+ * Build a fake Stripe webhook `Event` wrapping the given payload.
39
+ *
40
+ * @remarks Defaults: `id: 'evt_test_1'`, `object: 'event'`, `api_version: '2024-06-20'`,
41
+ * `created: 1_700_000_000`, `livemode: false`. The payload is placed at `data.object`.
42
+ * @param type - Event type (e.g. `'payment_intent.succeeded'`), assigned to `type`.
43
+ * @param dataObject - The object placed at `data.object`.
44
+ * @param over - Field overrides merged last.
45
+ * @returns A `Stripe.Event` fixture.
46
+ * @example
47
+ * ```ts
48
+ * const event = fakeStripeEvent('payment_intent.succeeded', fakePaymentIntent());
49
+ * ```
50
+ */
9
51
  export declare function fakeStripeEvent(type: string, dataObject: unknown, over?: Partial<Stripe.Event>): Stripe.Event;
52
+ /**
53
+ * Build a fake Stripe `Checkout.Session`.
54
+ *
55
+ * @remarks Defaults: `id: 'cs_test_1'`, `object: 'checkout.session'`,
56
+ * `url: 'https://checkout.stripe.test/cs_test_1'`, `mode: 'subscription'`, `status: 'open'`.
57
+ * @param over - Field overrides merged last.
58
+ * @returns A `Stripe.Checkout.Session` fixture.
59
+ * @example
60
+ * ```ts
61
+ * const session = fakeCheckoutSession({ status: 'complete' });
62
+ * ```
63
+ */
10
64
  export declare function fakeCheckoutSession(over?: Partial<Stripe.Checkout.Session>): Stripe.Checkout.Session;
65
+ /**
66
+ * Build a fake Stripe `Customer`.
67
+ *
68
+ * @remarks Defaults: `id: 'cus_test_1'`, `object: 'customer'`, `created: 1_700_000_000`,
69
+ * `livemode: false`.
70
+ * @param over - Field overrides merged last.
71
+ * @returns A `Stripe.Customer` fixture.
72
+ * @example
73
+ * ```ts
74
+ * const customer = fakeCustomer({ email: 'a@example.com' });
75
+ * ```
76
+ */
11
77
  export declare function fakeCustomer(over?: Partial<Stripe.Customer>): Stripe.Customer;
78
+ /**
79
+ * Build a fake Stripe `Price`.
80
+ *
81
+ * @remarks Defaults: `id: 'price_test_1'`, `object: 'price'`, `active: true`, `currency: 'jpy'`,
82
+ * `unit_amount: 1000`.
83
+ * @param over - Field overrides merged last.
84
+ * @returns A `Stripe.Price` fixture.
85
+ * @example
86
+ * ```ts
87
+ * const price = fakePrice({ unit_amount: 2000 });
88
+ * ```
89
+ */
12
90
  export declare function fakePrice(over?: Partial<Stripe.Price>): Stripe.Price;
91
+ /**
92
+ * Build a fake Stripe `Subscription`.
93
+ *
94
+ * @remarks Defaults: `id: 'sub_test_1'`, `object: 'subscription'`, `status: 'active'`,
95
+ * `customer: 'cus_test_1'`, `created: 1_700_000_000`.
96
+ * @param over - Field overrides merged last.
97
+ * @returns A `Stripe.Subscription` fixture.
98
+ * @example
99
+ * ```ts
100
+ * const sub = fakeSubscription({ status: 'canceled' });
101
+ * ```
102
+ */
13
103
  export declare function fakeSubscription(over?: Partial<Stripe.Subscription>): Stripe.Subscription;
@@ -1,7 +1,23 @@
1
1
  /**
2
- * Stripe オブジェクトの test fixture factory。実 SDK 型は巨大なので、テストが参照する範囲だけを
3
- * 妥当な既定値で組み、`over` で上書きする(最後に 1 度だけ Stripe 型へキャスト)。fleet 各 repo の
4
- * 課金テストで同じダミー PaymentIntent/Event/... を手組みしていた重複を集約する。
2
+ * Test fixture factories for Stripe objects.
3
+ *
4
+ * The real SDK types are enormous, so each factory builds only the fields tests typically read,
5
+ * fills them with reasonable defaults, lets you override via `over`, and casts to the Stripe type
6
+ * once at the end. This consolidates the duplicated hand-built dummy `PaymentIntent`/`Event`/... that
7
+ * billing tests tend to reconstruct in every project.
8
+ */
9
+ /**
10
+ * Build a fake Stripe `ApiList` wrapping the given data.
11
+ *
12
+ * @remarks Defaults: `object: 'list'`, `has_more: false`, `url: '/v1/_test'`.
13
+ * @typeParam T - Element type of the list.
14
+ * @param data - Items to place in `data`.
15
+ * @param over - Field overrides merged last.
16
+ * @returns A `Stripe.ApiList<T>` fixture.
17
+ * @example
18
+ * ```ts
19
+ * const list = fakeApiList([fakePaymentIntent()]);
20
+ * ```
5
21
  */
6
22
  export function fakeApiList(data, over = {}) {
7
23
  return {
@@ -12,6 +28,18 @@ export function fakeApiList(data, over = {}) {
12
28
  ...over,
13
29
  };
14
30
  }
31
+ /**
32
+ * Build a fake Stripe `PaymentIntent`.
33
+ *
34
+ * @remarks Defaults: `id: 'pi_test_1'`, `object: 'payment_intent'`, `amount: 1000`, `currency: 'jpy'`,
35
+ * `status: 'succeeded'`, `created: 1_700_000_000`.
36
+ * @param over - Field overrides merged last.
37
+ * @returns A `Stripe.PaymentIntent` fixture.
38
+ * @example
39
+ * ```ts
40
+ * const pi = fakePaymentIntent({ status: 'requires_payment_method' });
41
+ * ```
42
+ */
15
43
  export function fakePaymentIntent(over = {}) {
16
44
  return {
17
45
  id: 'pi_test_1',
@@ -23,6 +51,20 @@ export function fakePaymentIntent(over = {}) {
23
51
  ...over,
24
52
  };
25
53
  }
54
+ /**
55
+ * Build a fake Stripe webhook `Event` wrapping the given payload.
56
+ *
57
+ * @remarks Defaults: `id: 'evt_test_1'`, `object: 'event'`, `api_version: '2024-06-20'`,
58
+ * `created: 1_700_000_000`, `livemode: false`. The payload is placed at `data.object`.
59
+ * @param type - Event type (e.g. `'payment_intent.succeeded'`), assigned to `type`.
60
+ * @param dataObject - The object placed at `data.object`.
61
+ * @param over - Field overrides merged last.
62
+ * @returns A `Stripe.Event` fixture.
63
+ * @example
64
+ * ```ts
65
+ * const event = fakeStripeEvent('payment_intent.succeeded', fakePaymentIntent());
66
+ * ```
67
+ */
26
68
  export function fakeStripeEvent(type, dataObject, over = {}) {
27
69
  return {
28
70
  id: 'evt_test_1',
@@ -35,6 +77,18 @@ export function fakeStripeEvent(type, dataObject, over = {}) {
35
77
  ...over,
36
78
  };
37
79
  }
80
+ /**
81
+ * Build a fake Stripe `Checkout.Session`.
82
+ *
83
+ * @remarks Defaults: `id: 'cs_test_1'`, `object: 'checkout.session'`,
84
+ * `url: 'https://checkout.stripe.test/cs_test_1'`, `mode: 'subscription'`, `status: 'open'`.
85
+ * @param over - Field overrides merged last.
86
+ * @returns A `Stripe.Checkout.Session` fixture.
87
+ * @example
88
+ * ```ts
89
+ * const session = fakeCheckoutSession({ status: 'complete' });
90
+ * ```
91
+ */
38
92
  export function fakeCheckoutSession(over = {}) {
39
93
  return {
40
94
  id: 'cs_test_1',
@@ -45,6 +99,18 @@ export function fakeCheckoutSession(over = {}) {
45
99
  ...over,
46
100
  };
47
101
  }
102
+ /**
103
+ * Build a fake Stripe `Customer`.
104
+ *
105
+ * @remarks Defaults: `id: 'cus_test_1'`, `object: 'customer'`, `created: 1_700_000_000`,
106
+ * `livemode: false`.
107
+ * @param over - Field overrides merged last.
108
+ * @returns A `Stripe.Customer` fixture.
109
+ * @example
110
+ * ```ts
111
+ * const customer = fakeCustomer({ email: 'a@example.com' });
112
+ * ```
113
+ */
48
114
  export function fakeCustomer(over = {}) {
49
115
  return {
50
116
  id: 'cus_test_1',
@@ -54,6 +120,18 @@ export function fakeCustomer(over = {}) {
54
120
  ...over,
55
121
  };
56
122
  }
123
+ /**
124
+ * Build a fake Stripe `Price`.
125
+ *
126
+ * @remarks Defaults: `id: 'price_test_1'`, `object: 'price'`, `active: true`, `currency: 'jpy'`,
127
+ * `unit_amount: 1000`.
128
+ * @param over - Field overrides merged last.
129
+ * @returns A `Stripe.Price` fixture.
130
+ * @example
131
+ * ```ts
132
+ * const price = fakePrice({ unit_amount: 2000 });
133
+ * ```
134
+ */
57
135
  export function fakePrice(over = {}) {
58
136
  return {
59
137
  id: 'price_test_1',
@@ -64,6 +142,18 @@ export function fakePrice(over = {}) {
64
142
  ...over,
65
143
  };
66
144
  }
145
+ /**
146
+ * Build a fake Stripe `Subscription`.
147
+ *
148
+ * @remarks Defaults: `id: 'sub_test_1'`, `object: 'subscription'`, `status: 'active'`,
149
+ * `customer: 'cus_test_1'`, `created: 1_700_000_000`.
150
+ * @param over - Field overrides merged last.
151
+ * @returns A `Stripe.Subscription` fixture.
152
+ * @example
153
+ * ```ts
154
+ * const sub = fakeSubscription({ status: 'canceled' });
155
+ * ```
156
+ */
67
157
  export function fakeSubscription(over = {}) {
68
158
  return {
69
159
  id: 'sub_test_1',
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@rdlabo/workers-hono-kit",
3
- "version": "0.2.0",
3
+ "version": "0.2.1",
4
4
  "private": false,
5
5
  "publishConfig": {
6
6
  "access": "public"
package/src/ai/gateway.ts CHANGED
@@ -1,61 +1,100 @@
1
1
  /**
2
- * Cloudflare AI Gateway のプロバイダ生成(`ai` SDK + `ai-gateway-provider`)。
3
- * フリート共通 = foodlabel / winecode / receptray hono の AI 呼び出しを必ず Gateway 経由にする。
2
+ * Cloudflare AI Gateway provider factory built on the Vercel AI SDK and `ai-gateway-provider`.
4
3
  *
5
- * `createAiGateway` が返す wrapper `@ai-sdk/*` のモデルを包むと、SDK が組み立てた
6
- * プロバイダ宛リクエスト(api.openai.com / api.anthropic.com / *-aiplatform.googleapis.com 等)を
7
- * AI Gateway Universal Endpoint 経由に差し替える。OpenAI / Anthropic / Google Vertex(SA) の
8
- * いずれも同じ `aigateway(model)` で透過的にルーティングされる(Vertex も対応)。
4
+ * Routes OpenAI, Anthropic, and Google Vertex `@ai-sdk/*` models through the AI Gateway Universal
5
+ * Endpoint. The wrapper returned by `createAiGateway` intercepts the provider-bound requests the SDK
6
+ * assembles (`api.openai.com`, `api.anthropic.com`, `*-aiplatform.googleapis.com`, etc.) and redirects
7
+ * them through the Gateway. Every provider is routed transparently via the same `aigateway(model)` call.
9
8
  *
10
- * ここはインフラ層(Gateway 識別子と認証トークンの注入だけ)。プロバイダの API キーや
11
- * Vertex SA 認証情報は各 repo 側でモデル生成時に渡す(pass-through)。
9
+ * @remarks
10
+ * This module is purely the infrastructure layer: it injects only the Gateway identifier and (optionally)
11
+ * the Gateway authentication token. Provider API keys and Vertex service-account credentials are supplied
12
+ * by the caller at model-construction time and passed through untouched.
12
13
  */
13
14
  import { createAiGateway } from 'ai-gateway-provider';
14
15
  import type { AiGateway, AiGatewayBindingSettings, AiGatewayOptions } from 'ai-gateway-provider';
15
16
 
16
17
  export type { AiGateway, AiGatewayOptions } from 'ai-gateway-provider';
17
18
 
18
- /** Workers の AI binding(`env.AI.gateway(name)`)の最小形。Cloudflare の `AiGateway` が構造的に適合する。 */
19
+ /**
20
+ * Minimal shape of a Workers AI binding (`env.AI.gateway(name)`).
21
+ *
22
+ * @remarks
23
+ * Cloudflare's runtime `AiGateway` type is structurally compatible with this binding shape.
24
+ */
19
25
  export type AiGatewayBinding = AiGatewayBindingSettings['binding'];
20
26
 
21
27
  /**
22
- * AI Gateway 設定。2 系統:
23
- * - binding 形: Workers ランタイム(本番 / `wrangler dev`)。`env.AI.gateway(name)` を渡す。
24
- * binding 経由は同一アカウント内で事前認証されるため Gateway トークン不要。
25
- * - REST 形: Workers 外(Node eval ハーネス等、binding 不可)。accountId + gateway + token で REST。
28
+ * Configuration for the AI Gateway provider. This is a union with two mutually exclusive forms.
29
+ *
30
+ * @remarks
31
+ * - **Binding form** for the Workers runtime (production and `wrangler dev`). Pass the
32
+ * `env.AI.gateway(name)` binding. Requests through a binding are pre-authenticated within the same
33
+ * Cloudflare account, so no Gateway token is required.
34
+ * - **REST form** — for non-Workers contexts where a binding is unavailable (e.g. a Node evaluation
35
+ * harness). Supply `accountId`, `gateway`, and (for authenticated Gateways) `token` to reach the
36
+ * Gateway over REST.
26
37
  */
27
38
  export type AiGatewayConfig =
28
39
  | {
29
- /** `env.AI.gateway(name)` 等の AI Gateway binding。 */
40
+ /** The AI Gateway binding, typically obtained via `env.AI.gateway(name)`. */
30
41
  binding: AiGatewayBinding;
31
- /** キャッシュ / リトライ / メタデータ等の Gateway オプション(任意)。 */
42
+ /** Optional Gateway options such as caching, retries, and request metadata. */
32
43
  options?: AiGatewayOptions;
33
44
  }
34
45
  | {
35
- /** Cloudflare アカウント ID */
46
+ /** Cloudflare account ID that owns the Gateway. */
36
47
  accountId: string;
37
- /** AI Gateway 名。 */
48
+ /** AI Gateway name. */
38
49
  gateway: string;
39
50
  /**
40
- * `cf-aig-authorization` に載せる Gateway 認証トークン。Authenticated Gateway のときだけ必要。
41
- * unauthenticated Gateway では省略可(プロバイダの API キーではなく Gateway 自体への認証)。
51
+ * Gateway authentication token sent in the `cf-aig-authorization` header. Required only for an
52
+ * Authenticated Gateway; omit it for an unauthenticated Gateway. This authenticates the request to
53
+ * the Gateway itself and is distinct from any provider API key.
42
54
  */
43
55
  token?: string;
44
- /** キャッシュ / リトライ / メタデータ等の Gateway オプション(任意)。 */
56
+ /** Optional Gateway options such as caching, retries, and request metadata. */
45
57
  options?: AiGatewayOptions;
46
58
  };
47
59
 
60
+ /** Provider object exposing the AI Gateway model wrapper. */
48
61
  export interface AiGatewayProvider {
49
62
  /**
50
- * `@ai-sdk/*` のモデルを包んで AI Gateway 経由にする。
51
- * 例: `aigateway(createAnthropic({ apiKey }).('claude-...'))`。
52
- * 配列を渡すとフォールバック(先頭から順に試行)になる。
63
+ * Wraps an `@ai-sdk/*` model so its requests are routed through the AI Gateway.
64
+ *
65
+ * @remarks
66
+ * Example invocation: `aigateway(createAnthropic({ apiKey })('claude-...'))`. Passing an array of
67
+ * models enables fallback behavior — each model is attempted in order from the start of the array.
53
68
  */
54
69
  aigateway: AiGateway;
55
70
  }
56
71
 
57
72
  /**
58
- * AI Gateway 用のプロバイダを生成する。binding / REST 形のどちらでも可(欠落時は fail-fast)。
73
+ * Create an AI Gateway provider from either the binding form or the REST form of the configuration.
74
+ *
75
+ * @param config - The Gateway configuration; either the binding form or the REST form.
76
+ * @returns A provider whose `aigateway` wrapper routes models through the AI Gateway.
77
+ * @throws Error When the REST form is used and `accountId` or `gateway` is missing (fail-fast).
78
+ * @example
79
+ * ```ts
80
+ * // Binding form (Workers runtime: production / wrangler dev)
81
+ * import { createAnthropic } from '@ai-sdk/anthropic';
82
+ *
83
+ * const { aigateway } = createAiGatewayProvider({ binding: env.AI.gateway('my-gateway') });
84
+ * const model = aigateway(createAnthropic({ apiKey: env.ANTHROPIC_API_KEY })('claude-3-5-sonnet-latest'));
85
+ * ```
86
+ * @example
87
+ * ```ts
88
+ * // REST form (non-Workers context, e.g. a Node evaluation harness)
89
+ * import { createOpenAI } from '@ai-sdk/openai';
90
+ *
91
+ * const { aigateway } = createAiGatewayProvider({
92
+ * accountId: process.env.CF_ACCOUNT_ID!,
93
+ * gateway: 'my-gateway',
94
+ * token: process.env.CF_AIG_TOKEN, // only for an Authenticated Gateway
95
+ * });
96
+ * const model = aigateway(createOpenAI({ apiKey: process.env.OPENAI_API_KEY })('gpt-4o'));
97
+ * ```
59
98
  */
60
99
  export function createAiGatewayProvider(config: AiGatewayConfig): AiGatewayProvider {
61
100
  if ('binding' in config) {
@@ -63,13 +102,13 @@ export function createAiGatewayProvider(config: AiGatewayConfig): AiGatewayProvi
63
102
  }
64
103
 
65
104
  if (!config.accountId) {
66
- throw new Error('AI Gateway: accountId が未設定です');
105
+ throw new Error('AI Gateway: accountId is not set');
67
106
  }
68
107
  if (!config.gateway) {
69
- throw new Error('AI Gateway: gateway 名が未設定です');
108
+ throw new Error('AI Gateway: gateway name is not set');
70
109
  }
71
110
 
72
- // token Authenticated Gateway のときだけ apiKey として送る。unauthenticated では undefined で可。
111
+ // The token is sent as apiKey only for an Authenticated Gateway; undefined is fine when unauthenticated.
73
112
  return {
74
113
  aigateway: createAiGateway({
75
114
  accountId: config.accountId,
@@ -1,10 +1,28 @@
1
1
  /**
2
- * CloudFront 署名付き URL 生成(`@aws-sdk/cloudfront-signer` getSignedUrl Web Crypto で再実装)。
3
- * Cloudflare Workers ネイティブ(aws-sdk 不要)。フリート共通 = tipsys/winecode hono。
2
+ * Generate a CloudFront signed URL using a canned policy, implemented natively for Cloudflare Workers.
4
3
  *
5
- * canned policy RSASSA-PKCS1-v1_5 + SHA-1 で署名し、AWS URL-safe base64 変換
6
- * '+' -> '-' , '/' -> '~' , '=' -> '_'
7
- * を施して `Expires` / `Key-Pair-Id` / `Signature` の順でクエリを付与する(aws-sdk の出力とバイト一致)。
4
+ * Reimplements `getSignedUrl` from `@aws-sdk/cloudfront-signer` on top of the Web Crypto API, so no
5
+ * `@aws-sdk` dependency is required. The canned policy is signed with RSASSA-PKCS1-v1_5 and SHA-1, the
6
+ * signature is converted to AWS URL-safe base64 (`+` -> `-`, `/` -> `~`, `=` -> `_`), and the query
7
+ * parameters are appended in the order `Expires`, `Key-Pair-Id`, `Signature`.
8
+ *
9
+ * @remarks
10
+ * The output is byte-for-byte identical to that of `@aws-sdk/cloudfront-signer`.
11
+ *
12
+ * @param url - The resource URL to sign.
13
+ * @param privateKeyPem - The CloudFront key group private key in PKCS#8 PEM format.
14
+ * @param keyPairId - The CloudFront public key (key pair) ID associated with the private key.
15
+ * @param dateLessThan - Expiry time, accepted as a `Date`, epoch-millisecond number, or date string.
16
+ * @returns The signed URL with the `Expires`, `Key-Pair-Id`, and `Signature` query parameters appended.
17
+ * @example
18
+ * ```ts
19
+ * const signedUrl = await getCloudFrontSignedUrl(
20
+ * 'https://cdn.example.com/private/video.mp4',
21
+ * env.CLOUDFRONT_PRIVATE_KEY,
22
+ * env.CLOUDFRONT_KEY_PAIR_ID,
23
+ * Date.now() + 60 * 60 * 1000, // valid for one hour
24
+ * );
25
+ * ```
8
26
  */
9
27
  export async function getCloudFrontSignedUrl(
10
28
  url: string,
@@ -34,14 +52,29 @@ export async function getCloudFrontSignedUrl(
34
52
  const signature = toUrlSafeBase64(arrayBufferToBase64(signatureBuffer));
35
53
  const separator = url.includes('?') ? '&' : '?';
36
54
 
37
- // @aws-sdk/cloudfront-signer のクエリ順: Expires -> Key-Pair-Id -> Signature
55
+ // Query order used by @aws-sdk/cloudfront-signer: Expires -> Key-Pair-Id -> Signature
38
56
  return `${url}${separator}Expires=${epochSeconds}&Key-Pair-Id=${keyPairId}&Signature=${signature}`;
39
57
  }
40
58
 
59
+ /**
60
+ * Convert standard base64 to the URL-safe alphabet expected in CloudFront signatures.
61
+ *
62
+ * @param value - A standard base64 string.
63
+ * @returns The base64 string with `+` -> `-`, `=` -> `_`, and `/` -> `~`.
64
+ * @internal
65
+ */
66
+
41
67
  function toUrlSafeBase64(value: string): string {
42
68
  return value.replace(/\+/g, '-').replace(/=/g, '_').replace(/\//g, '~');
43
69
  }
44
70
 
71
+ /**
72
+ * Encode an `ArrayBuffer` to standard base64.
73
+ *
74
+ * @param buffer - The raw bytes to encode.
75
+ * @returns The standard base64 representation of the buffer.
76
+ * @internal
77
+ */
45
78
  function arrayBufferToBase64(buffer: ArrayBuffer): string {
46
79
  const bytes = new Uint8Array(buffer);
47
80
  let binary = '';
@@ -51,6 +84,13 @@ function arrayBufferToBase64(buffer: ArrayBuffer): string {
51
84
  return btoa(binary);
52
85
  }
53
86
 
87
+ /**
88
+ * Decode a PKCS#8 PEM private key into its DER `ArrayBuffer`.
89
+ *
90
+ * @param pem - The PEM-encoded key, including the BEGIN/END armor.
91
+ * @returns The decoded DER bytes, suitable for `crypto.subtle.importKey('pkcs8', ...)`.
92
+ * @internal
93
+ */
54
94
  function pemToDer(pem: string): ArrayBuffer {
55
95
  const base64 = pem
56
96
  .replace(/-----BEGIN [^-]+-----/, '')
@@ -1,26 +1,66 @@
1
1
  import { AwsClient } from 'aws4fetch';
2
2
 
3
3
  /**
4
- * AWS Secrets Manager GetSecretValue aws4fetch(SigV4 署名 fetch)で叩く汎用ヘルパ。
5
- * Cloudflare Workers には AWS SDK も IAM ロールも無いため、AWS の静的キーを Workers secrets として
6
- * 渡して署名する(移植元 `api/src/secrets-manager.ts` 相当)。DB 認証情報は Hyperdrive 側に持つので対象外。
4
+ * AWS credentials used to sign Secrets Manager requests.
7
5
  *
8
- * Secret の中身(スキーマ)と secretId は repo ごとに異なるため、`<T>` と `secretId` を呼び出し側が渡す。
6
+ * @remarks
7
+ * Cloudflare Workers have neither the AWS SDK nor IAM role credentials, so static AWS keys are supplied
8
+ * as Workers secrets and used to produce a SigV4 signature.
9
9
  */
10
10
  export interface AwsSecretsOptions {
11
+ /** AWS access key ID. */
11
12
  accessKeyId: string;
13
+ /** AWS secret access key. */
12
14
  secretAccessKey: string;
15
+ /** Optional STS session token, required when using temporary credentials. */
13
16
  sessionToken?: string;
17
+ /** AWS region of the Secrets Manager endpoint, e.g. `ap-northeast-1`. */
14
18
  region: string;
15
19
  }
16
20
 
17
21
  /**
18
- * Per-isolate cache: Secrets Manager isolate ごと 1 回だけ叩く。region+accessKeyId+secretId を
19
- * キーにし、資格情報ローテーション時は再取得する。promise をキャッシュして同時初回リクエストが 1 回の
20
- * 呼び出しを共有する。reject 時はキャッシュをクリアして retry を許す。
22
+ * Per-isolate cache for the fetched secret.
23
+ *
24
+ * @remarks
25
+ * Secrets Manager is queried at most once per isolate. The entry is keyed by
26
+ * `region:accessKeyId:secretId`, so rotating credentials triggers a fresh fetch. The in-flight promise
27
+ * itself is cached so that concurrent first-time callers share a single request. On rejection the cache
28
+ * is cleared so a failed fetch can be retried.
29
+ *
30
+ * @internal
21
31
  */
22
32
  let cache: { key: string; value: Promise<unknown> } | null = null;
23
33
 
34
+ /**
35
+ * Fetch and parse a secret from AWS Secrets Manager, caching the result per isolate.
36
+ *
37
+ * Issues a `GetSecretValue` call to Secrets Manager via a SigV4-signed `fetch` (using aws4fetch), with no
38
+ * AWS SDK involved. The parsed `SecretString` is cached per isolate keyed by region, access key ID, and
39
+ * secret ID; concurrent first-time callers share one in-flight request, and a rejected fetch clears the
40
+ * cache entry so the next call retries.
41
+ *
42
+ * @typeParam T - The shape of the JSON-parsed secret payload, supplied by the caller.
43
+ * @param options - AWS credentials and region used to sign the request.
44
+ * @param secretId - The Secrets Manager secret ID or ARN to retrieve.
45
+ * @returns The parsed secret value cast to `T`.
46
+ * @throws Error When the Secrets Manager response is not OK, or when it contains no `SecretString`.
47
+ * @example
48
+ * ```ts
49
+ * interface DbSecret {
50
+ * username: string;
51
+ * password: string;
52
+ * }
53
+ *
54
+ * const secret = await getAuthenticationSecret<DbSecret>(
55
+ * {
56
+ * accessKeyId: env.AWS_ACCESS_KEY_ID,
57
+ * secretAccessKey: env.AWS_SECRET_ACCESS_KEY,
58
+ * region: 'ap-northeast-1',
59
+ * },
60
+ * 'prod/db/credentials',
61
+ * );
62
+ * ```
63
+ */
24
64
  export function getAuthenticationSecret<T>(options: AwsSecretsOptions, secretId: string): Promise<T> {
25
65
  const key = `${options.region}:${options.accessKeyId}:${secretId}`;
26
66
  if (cache?.key !== key) {
@@ -33,6 +73,15 @@ export function getAuthenticationSecret<T>(options: AwsSecretsOptions, secretId:
33
73
  return cache.value as Promise<T>;
34
74
  }
35
75
 
76
+ /**
77
+ * Perform the SigV4-signed `GetSecretValue` request and parse the returned `SecretString`.
78
+ *
79
+ * @param options - AWS credentials and region used to sign the request.
80
+ * @param secretId - The Secrets Manager secret ID or ARN to retrieve.
81
+ * @returns The JSON-parsed secret payload.
82
+ * @throws Error When the response is not OK, or when it contains no `SecretString`.
83
+ * @internal
84
+ */
36
85
  async function fetchSecret(options: AwsSecretsOptions, secretId: string): Promise<unknown> {
37
86
  const aws = new AwsClient({
38
87
  accessKeyId: options.accessKeyId,