alchemy 2.0.0-beta.57 → 2.0.0-beta.59

package/src/Cloudflare/WaitingRoom/Settings.ts

@@ -1,6 +1,7 @@
 import * as waitingRooms from "@distilled.cloud/cloudflare/waiting-rooms";
 import * as Effect from "effect/Effect";
 import * as Predicate from "effect/Predicate";
+import * as Schedule from "effect/Schedule";
 
 import * as Provider from "../../Provider.ts";
 import { Resource } from "../../Resource.ts";
@@ -8,10 +9,10 @@ import { CloudflareEnvironment } from "../CloudflareEnvironment.ts";
 import type { Providers } from "../Providers.ts";
 import { listAllZones } from "../Zone/lookup.ts";
 
-const WaitingRoomSettingsTypeId = "Cloudflare.WaitingRoom.Settings" as const;
-type WaitingRoomSettingsTypeId = typeof WaitingRoomSettingsTypeId;
+const TypeId = "Cloudflare.WaitingRoom.Settings" as const;
+type TypeId = typeof TypeId;
 
-export type WaitingRoomSettingsProps = {
+export type SettingsProps = {
   /**
    * Zone whose waiting room settings are managed. Stable — changing the
    * zone triggers a replacement (the old zone's settings are restored to
@@ -27,7 +28,7 @@ export type WaitingRoomSettingsProps = {
   searchEngineCrawlerBypass?: boolean;
 };
 
-export type WaitingRoomSettingsAttributes = {
+export type SettingsAttributes = {
   /** Zone the settings belong to. */
   zoneId: string;
   /** Whether verified search engine crawlers bypass all waiting rooms. */
@@ -40,10 +41,10 @@ export type WaitingRoomSettingsAttributes = {
   initialSearchEngineCrawlerBypass: boolean;
 };
 
-export type WaitingRoomSettings = Resource<
-  WaitingRoomSettingsTypeId,
-  WaitingRoomSettingsProps,
-  WaitingRoomSettingsAttributes,
+export type Settings = Resource<
+  TypeId,
+  SettingsProps,
+  SettingsAttributes,
   never,
   Providers
 >;
@@ -68,7 +69,7 @@ export type WaitingRoomSettings = Resource<
  * @section Managing settings
  * @example Let search engine crawlers bypass waiting rooms
  * ```typescript
- * yield* Cloudflare.WaitingRoomSettings("CrawlerBypass", {
+ * yield* Cloudflare.WaitingRoom.Settings("CrawlerBypass", {
  *   zoneId: zone.zoneId,
  *   searchEngineCrawlerBypass: true,
  * });
@@ -76,7 +77,7 @@ export type WaitingRoomSettings = Resource<
  *
  * @example Pin the settings to their defaults
  * ```typescript
- * yield* Cloudflare.WaitingRoomSettings("Defaults", {
+ * yield* Cloudflare.WaitingRoom.Settings("Defaults", {
  *   zoneId: zone.zoneId,
  *   searchEngineCrawlerBypass: false,
  * });
@@ -84,21 +85,16 @@ export type WaitingRoomSettings = Resource<
  *
  * @see https://developers.cloudflare.com/waiting-room/
  */
-export const WaitingRoomSettings = Resource<WaitingRoomSettings>(
-  WaitingRoomSettingsTypeId,
-);
+export const Settings = Resource<Settings>(TypeId);
 
 /**
- * Returns true if the given value is a WaitingRoomSettings resource.
+ * Returns true if the given value is a Settings resource.
  */
-export const isWaitingRoomSettings = (
-  value: unknown,
-): value is WaitingRoomSettings =>
-  Predicate.hasProperty(value, "Type") &&
-  value.Type === WaitingRoomSettingsTypeId;
-
-export const WaitingRoomSettingsProvider = () =>
-  Provider.succeed(WaitingRoomSettings, {
+export const isSettings = (value: unknown): value is Settings =>
+  Predicate.hasProperty(value, "Type") && value.Type === TypeId;
+
+export const SettingsProvider = () =>
+  Provider.succeed(Settings, {
     nuke: { singleton: true },
     stables: ["zoneId", "initialSearchEngineCrawlerBypass"],
 
@@ -111,6 +107,20 @@ export const WaitingRoomSettingsProvider = () =>
         allZones.map((zone) => zone.id),
         (zoneId) =>
           waitingRooms.getSetting({ zoneId }).pipe(
+            // A freshly-minted scoped token propagates eventually-
+            // consistently across Cloudflare's edge — ride out transient
+            // 403 blips before giving up on a zone. The backoff is CAPPED at
+            // 5s and bounded to ~8 attempts (~40s): an uncapped
+            // `Schedule.exponential` reaches a 64s single delay by the 8th
+            // retry (~128s total) which, fanned across every zone, blows the
+            // test timeout when a zone is persistently 403.
+            Effect.retry({
+              while: (e) => e._tag === "Forbidden",
+              schedule: Schedule.exponential("500 millis").pipe(
+                Schedule.either(Schedule.spaced("5 seconds")),
+                Schedule.both(Schedule.recurs(8)),
+              ),
+            }),
             Effect.map((observed) =>
               toAttributes(
                 zoneId,
@@ -118,19 +128,20 @@ export const WaitingRoomSettingsProvider = () =>
                 observed.searchEngineCrawlerBypass,
               ),
             ),
-            // Plan-gated or partial zones reject the route; skip them.
+            // Plan-gated or partial zones reject the route; a zone the token
+            // still can't read (persistent 403) isn't ours to enumerate —
+            // skip both rather than failing the whole listing.
             Effect.catchTag("InvalidRoute", () => Effect.succeed(undefined)),
+            Effect.catchTag("Forbidden", () => Effect.succeed(undefined)),
           ),
         { concurrency: 10 },
       );
-      return rows.filter(
-        (row): row is WaitingRoomSettingsAttributes => row !== undefined,
-      );
+      return rows.filter((row): row is SettingsAttributes => row !== undefined);
     }),
 
     diff: Effect.fn(function* ({ olds = {}, news, output }) {
-      const o = olds as WaitingRoomSettingsProps;
-      const n = news as WaitingRoomSettingsProps;
+      const o = olds as SettingsProps;
+      const n = news as SettingsProps;
       // zoneId is Input<string>; compare only once both sides are concrete.
       const oldZoneId =
         output?.zoneId ?? (typeof o.zoneId === "string" ? o.zoneId : undefined);
@@ -219,7 +230,7 @@ const toAttributes = (
   zoneId: string,
   searchEngineCrawlerBypass: boolean,
   initialSearchEngineCrawlerBypass: boolean,
-): WaitingRoomSettingsAttributes => ({
+): SettingsAttributes => ({
   zoneId,
   searchEngineCrawlerBypass,
   initialSearchEngineCrawlerBypass,

package/src/Cloudflare/WaitingRoom/WaitingRoom.ts

@@ -11,29 +11,25 @@ import { CloudflareEnvironment } from "../CloudflareEnvironment.ts";
 import type { Providers } from "../Providers.ts";
 import { listAllZones } from "../Zone/lookup.ts";
 
-const WaitingRoomTypeId = "Cloudflare.WaitingRoom" as const;
-type WaitingRoomTypeId = typeof WaitingRoomTypeId;
+const TypeId = "Cloudflare.WaitingRoom.WaitingRoom" as const;
+type TypeId = typeof TypeId;
 
 /**
  * Queueing method used by a waiting room. Changing this from the default
  * `fifo` requires the Waiting Room Advanced subscription.
  */
-export type WaitingRoomQueueingMethod =
-  | "fifo"
-  | "random"
-  | "passthrough"
-  | "reject";
+export type QueueingMethod = "fifo" | "random" | "passthrough" | "reject";
 
 /**
  * HTTP status code returned to a user while in the queue.
  */
-export type WaitingRoomQueueingStatusCode = "200" | "202" | "429";
+export type QueueingStatusCode = "200" | "202" | "429";
 
 /**
  * Which Turnstile widget type the waiting room uses for detecting bot
  * traffic.
  */
-export type WaitingRoomTurnstileMode =
+export type TurnstileMode =
   | "off"
   | "invisible"
   | "visible_non_interactive"
@@ -44,12 +40,12 @@ export type WaitingRoomTurnstileMode =
  * analytics; `infinite_queue` sends the bot to a queue that never lets it
  * through.
  */
-export type WaitingRoomTurnstileAction = "log" | "infinite_queue";
+export type TurnstileAction = "log" | "infinite_queue";
 
 /**
  * Cookie attributes for the waiting room cookie (`__cf_waitingroom`).
  */
-export interface WaitingRoomCookieAttributes {
+export interface CookieAttributes {
   /**
    * SameSite attribute of the waiting room cookie.
    * @default "auto"
@@ -66,7 +62,7 @@ export interface WaitingRoomCookieAttributes {
  * An additional hostname + path combination the waiting room is applied to.
  * Only available with the Waiting Room Advanced subscription.
  */
-export interface WaitingRoomRoute {
+export interface Route {
   /**
    * Hostname (no scheme, no wildcards).
    */
@@ -78,7 +74,7 @@ export interface WaitingRoomRoute {
   path?: string;
 }
 
-export interface WaitingRoomProps {
+export interface Props {
   /**
    * Zone the waiting room belongs to. Stable — changing the zone triggers
    * a replacement.
@@ -141,12 +137,12 @@ export interface WaitingRoomProps {
    * subscription. Mutable.
    * @default "fifo"
    */
-  queueingMethod?: WaitingRoomQueueingMethod;
+  queueingMethod?: QueueingMethod;
   /**
    * HTTP status code returned to a user while in the queue. Mutable.
    * @default "200"
    */
-  queueingStatusCode?: WaitingRoomQueueingStatusCode;
+  queueingStatusCode?: QueueingStatusCode;
   /**
    * Suspends the waiting room — traffic flows straight to the route.
    * Mutable.
@@ -176,12 +172,12 @@ export interface WaitingRoomProps {
   /**
    * Cookie attributes for the waiting room cookie. Mutable.
    */
-  cookieAttributes?: WaitingRoomCookieAttributes;
+  cookieAttributes?: CookieAttributes;
   /**
    * Additional hostname/path combinations the waiting room applies to
    * (Waiting Room Advanced only). Mutable.
    */
-  additionalRoutes?: WaitingRoomRoute[];
+  additionalRoutes?: Route[];
   /**
    * Enabled origin commands (currently only `revoke`). Mutable.
    * @default []
@@ -191,15 +187,15 @@ export interface WaitingRoomProps {
    * Turnstile widget type used for detecting bot traffic. Mutable.
    * @default "off"
    */
-  turnstileMode?: WaitingRoomTurnstileMode;
+  turnstileMode?: TurnstileMode;
   /**
    * Action taken when Turnstile detects a bot. Mutable.
    * @default "log"
    */
-  turnstileAction?: WaitingRoomTurnstileAction;
+  turnstileAction?: TurnstileAction;
 }
 
-export interface WaitingRoomAttributes {
+export interface Attributes {
   /** Cloudflare-assigned identifier of the waiting room. */
   waitingRoomId: string;
   /** Zone the waiting room belongs to. */
@@ -221,9 +217,9 @@ export interface WaitingRoomAttributes {
   /** Whether all traffic is sent to the waiting room. */
   queueAll: boolean;
   /** Queueing method in effect. */
-  queueingMethod: WaitingRoomQueueingMethod;
+  queueingMethod: QueueingMethod;
   /** HTTP status code returned to queued users. */
-  queueingStatusCode: WaitingRoomQueueingStatusCode;
+  queueingStatusCode: QueueingStatusCode;
   /** Whether the waiting room is suspended. */
   suspended: boolean;
   /** ISO8601 creation timestamp. */
@@ -232,13 +228,7 @@ export interface WaitingRoomAttributes {
   modifiedOn: string | undefined;
 }
 
-export type WaitingRoom = Resource<
-  WaitingRoomTypeId,
-  WaitingRoomProps,
-  WaitingRoomAttributes,
-  never,
-  Providers
->;
+export type WaitingRoom = Resource<TypeId, Props, Attributes, never, Providers>;
 
 /**
  * A Cloudflare Waiting Room — places visitors in a virtual queue when
@@ -262,7 +252,7 @@ export type WaitingRoom = Resource<
  * @section Creating a Waiting Room
  * @example Basic waiting room on a host
  * ```typescript
- * const room = yield* Cloudflare.WaitingRoom("checkout", {
+ * const room = yield* Cloudflare.WaitingRoom.WaitingRoom("checkout", {
  *   zoneId: zone.zoneId,
  *   host: "shop.example.com",
  *   path: "/checkout",
@@ -273,7 +263,7 @@ export type WaitingRoom = Resource<
  *
  * @example Queue all traffic during an incident
  * ```typescript
- * yield* Cloudflare.WaitingRoom("incident-gate", {
+ * yield* Cloudflare.WaitingRoom.WaitingRoom("incident-gate", {
  *   zoneId: zone.zoneId,
  *   host: "example.com",
  *   totalActiveUsers: 500,
@@ -286,7 +276,7 @@ export type WaitingRoom = Resource<
  * @section Customizing behavior
  * @example Short sessions with a custom cookie suffix
  * ```typescript
- * yield* Cloudflare.WaitingRoom("flash-sale", {
+ * yield* Cloudflare.WaitingRoom.WaitingRoom("flash-sale", {
  *   zoneId: zone.zoneId,
  *   host: "example.com",
  *   path: "/sale",
@@ -300,21 +290,21 @@ export type WaitingRoom = Resource<
  *
  * @see https://developers.cloudflare.com/waiting-room/
  */
-export const WaitingRoom = Resource<WaitingRoom>(WaitingRoomTypeId);
+export const WaitingRoom = Resource<WaitingRoom>(TypeId);
 
 /**
  * Returns true if the given value is a WaitingRoom resource.
  */
 export const isWaitingRoom = (value: unknown): value is WaitingRoom =>
-  Predicate.hasProperty(value, "Type") && value.Type === WaitingRoomTypeId;
+  Predicate.hasProperty(value, "Type") && value.Type === TypeId;
 
 export const WaitingRoomProvider = () =>
   Provider.succeed(WaitingRoom, {
     stables: ["waitingRoomId", "zoneId", "createdOn"],
 
     diff: Effect.fn(function* ({ olds = {}, news, output }) {
-      const o = olds as WaitingRoomProps;
-      const n = news as WaitingRoomProps;
+      const o = olds as Props;
+      const n = news as Props;
       // zoneId is Input<string>; compare only once both sides are concrete.
       const oldZoneId =
         output?.zoneId ?? (typeof o.zoneId === "string" ? o.zoneId : undefined);
@@ -419,10 +409,10 @@ export const WaitingRoomProvider = () =>
             // Plan-gated / partial-permission zones reject the route, and a
             // zone deleted out-of-band has no rooms; skip both.
             Effect.catchTag("Forbidden", () =>
-              Effect.succeed([] as WaitingRoomAttributes[]),
+              Effect.succeed([] as Attributes[]),
             ),
             Effect.catchTag("InvalidRoute", () =>
-              Effect.succeed([] as WaitingRoomAttributes[]),
+              Effect.succeed([] as Attributes[]),
             ),
           ),
         { concurrency: 10 },
@@ -475,7 +465,7 @@ const createRoomName = (id: string, name: string | undefined) =>
  * defaults — sending Advanced-only fields explicitly would fail on
  * non-Advanced plans.
  */
-const desiredBody = (news: WaitingRoomProps) => ({
+const desiredBody = (news: Props) => ({
   host: news.host,
   totalActiveUsers: news.totalActiveUsers,
   newUsersPerMinute: news.newUsersPerMinute,
@@ -615,7 +605,7 @@ const toAttributes = (
     | waitingRooms.UpdateWaitingRoomResponse
     | waitingRooms.ListWaitingRoomsResponse["result"][number],
   zoneId: string,
-): WaitingRoomAttributes => ({
+): Attributes => ({
   // Cloudflare always echoes an id for a persisted room; distilled types it
   // optional/nullable.
   waitingRoomId: room.id ?? "",
@@ -628,9 +618,8 @@ const toAttributes = (
   description: room.description ?? "",
   sessionDuration: room.sessionDuration ?? 5,
   queueAll: room.queueAll ?? false,
-  queueingMethod: (room.queueingMethod ?? "fifo") as WaitingRoomQueueingMethod,
-  queueingStatusCode: (room.queueingStatusCode ??
-    "200") as WaitingRoomQueueingStatusCode,
+  queueingMethod: (room.queueingMethod ?? "fifo") as QueueingMethod,
+  queueingStatusCode: (room.queueingStatusCode ?? "200") as QueueingStatusCode,
   suspended: room.suspended ?? false,
   createdOn: room.createdOn ?? undefined,
   modifiedOn: room.modifiedOn ?? undefined,

package/src/Cloudflare/Web3/ContentList.ts

@@ -9,20 +9,19 @@ import { CloudflareEnvironment } from "../CloudflareEnvironment.ts";
 import type { Providers } from "../Providers.ts";
 import { listAllZones } from "../Zone/lookup.ts";
 
-const Web3HostnameContentListTypeId =
-  "Cloudflare.Web3HostnameContentList" as const;
-type Web3HostnameContentListTypeId = typeof Web3HostnameContentListTypeId;
+const TypeId = "Cloudflare.Web3.HostnameContentList" as const;
+type TypeId = typeof TypeId;
 
 /**
  * The kind of content a content-list entry blocks: a CID (`cid`) or a
  * content path (`content_path`).
  */
-export type Web3ContentListEntryType = "cid" | "content_path";
+export type ContentListEntryType = "cid" | "content_path";
 
 /**
  * A single entry of an IPFS universal-path content list.
  */
-export interface Web3ContentListEntry {
+export interface ContentListEntry {
   /**
    * The CID or content path of content to block, e.g.
    * `QmXoypizjW3WknFiJnKLwHCnL72vedxjQkDDP1mXWo6uco` (`cid`) or
@@ -32,14 +31,14 @@ export interface Web3ContentListEntry {
   /**
    * The type of content list entry to block.
    */
-  type: Web3ContentListEntryType;
+  type: ContentListEntryType;
   /**
    * An optional description of the content list entry.
    */
   description?: string;
 }
 
-export interface Web3HostnameContentListProps {
+export interface HostnameContentListProps {
   /**
    * The zone the hostname belongs to.
    *
@@ -66,10 +65,10 @@ export interface Web3HostnameContentListProps {
    * are removed.
    * @default []
    */
-  entries?: Web3ContentListEntry[];
+  entries?: ContentListEntry[];
 }
 
-export interface Web3HostnameContentListAttributes {
+export interface HostnameContentListAttributes {
   /** The zone the hostname belongs to. */
   zoneId: string;
   /** The Web3 hostname the content list belongs to. */
@@ -77,13 +76,13 @@ export interface Web3HostnameContentListAttributes {
   /** Behavior of the content list. */
   action: "block";
   /** The current content list entries. */
-  entries: Web3ContentListEntry[];
+  entries: ContentListEntry[];
 }
 
-export type Web3HostnameContentList = Resource<
-  Web3HostnameContentListTypeId,
-  Web3HostnameContentListProps,
-  Web3HostnameContentListAttributes,
+export type HostnameContentList = Resource<
+  TypeId,
+  HostnameContentListProps,
+  HostnameContentListAttributes,
   never,
   Providers
 >;
@@ -102,13 +101,13 @@ export type Web3HostnameContentList = Resource<
  * @section Blocking content
  * @example Block a CID and a content path
  * ```typescript
- * const gateway = yield* Cloudflare.Web3Hostname("UniversalGateway", {
+ * const gateway = yield* Cloudflare.Web3.Hostname("UniversalGateway", {
  *   zoneId: zone.zoneId,
  *   name: "gateway.example.com",
  *   target: "ipfs_universal_path",
  * });
  *
- * yield* Cloudflare.Web3HostnameContentList("Blocklist", {
+ * yield* Cloudflare.Web3.HostnameContentList("Blocklist", {
  *   zoneId: zone.zoneId,
  *   hostnameId: gateway.hostnameId,
  *   entries: [
@@ -128,7 +127,7 @@ export type Web3HostnameContentList = Resource<
  * @example Clear the blocklist
  * ```typescript
  * // An empty entries array removes every block (also what destroy does).
- * yield* Cloudflare.Web3HostnameContentList("Blocklist", {
+ * yield* Cloudflare.Web3.HostnameContentList("Blocklist", {
  *   zoneId: zone.zoneId,
  *   hostnameId: gateway.hostnameId,
  *   entries: [],
@@ -137,21 +136,18 @@ export type Web3HostnameContentList = Resource<
  *
  * @see https://developers.cloudflare.com/web3/
  */
-export const Web3HostnameContentList = Resource<Web3HostnameContentList>(
-  Web3HostnameContentListTypeId,
-);
+export const HostnameContentList = Resource<HostnameContentList>(TypeId);
 
 /**
- * Returns true if the given value is a Web3HostnameContentList resource.
+ * Returns true if the given value is a HostnameContentList resource.
  */
-export const isWeb3HostnameContentList = (
+export const isHostnameContentList = (
   value: unknown,
-): value is Web3HostnameContentList =>
-  Predicate.hasProperty(value, "Type") &&
-  value.Type === Web3HostnameContentListTypeId;
+): value is HostnameContentList =>
+  Predicate.hasProperty(value, "Type") && value.Type === TypeId;
 
-export const Web3HostnameContentListProvider = () =>
-  Provider.succeed(Web3HostnameContentList, {
+export const HostnameContentListProvider = () =>
+  Provider.succeed(HostnameContentList, {
     stables: ["zoneId", "hostnameId"],
 
     list: Effect.fn(function* () {
@@ -193,13 +189,13 @@ export const Web3HostnameContentListProvider = () =>
       return rows
         .flat()
         .filter(
-          (row): row is Web3HostnameContentListAttributes => row !== undefined,
+          (row): row is HostnameContentListAttributes => row !== undefined,
         );
     }),
 
     diff: Effect.fn(function* ({ olds = {}, news, output }) {
-      const o = olds as Partial<Web3HostnameContentListProps>;
-      const n = news as Web3HostnameContentListProps;
+      const o = olds as Partial<HostnameContentListProps>;
+      const n = news as HostnameContentListProps;
       // zoneId/hostnameId are Input<string>; compare only once both
       // sides are concrete. The content list is a sub-singleton of the
       // hostname — pointing elsewhere replaces it.
@@ -240,7 +236,7 @@ export const Web3HostnameContentListProvider = () =>
       // Inputs have been resolved to concrete strings by Plan.
       const zoneId = news.zoneId as string;
       const hostnameId = news.hostnameId as string;
-      const desired: Web3HostnameContentListAttributes = {
+      const desired: HostnameContentListAttributes = {
         zoneId,
         hostnameId,
         action: news.action ?? "block",
@@ -307,15 +303,15 @@ const observeContentList = (zoneId: string, hostnameId: string) =>
       hostnameId,
       action: (list.action ?? "block") as "block",
       entries: (entries.entries ?? []).map(
-        (entry): Web3ContentListEntry => ({
+        (entry): ContentListEntry => ({
           content: entry.content ?? "",
-          type: (entry.type ?? "cid") as Web3ContentListEntryType,
+          type: (entry.type ?? "cid") as ContentListEntryType,
           ...(entry.description != null
             ? { description: entry.description }
             : {}),
         }),
       ),
-    } satisfies Web3HostnameContentListAttributes;
+    } satisfies HostnameContentListAttributes;
   }).pipe(
     Effect.catchTag(["Web3HostnameNotFound", "InvalidWeb3HostnameTarget"], () =>
       Effect.succeed(undefined),
@@ -327,14 +323,14 @@ const observeContentList = (zoneId: string, hostnameId: string) =>
  * description).
  */
 const sameContentList = (
-  observed: Web3HostnameContentListAttributes,
-  desired: Web3HostnameContentListAttributes,
+  observed: HostnameContentListAttributes,
+  desired: HostnameContentListAttributes,
 ) =>
   observed.action === desired.action &&
   observed.entries.length === desired.entries.length &&
   serializeEntries(observed.entries) === serializeEntries(desired.entries);
 
-const serializeEntries = (entries: Web3ContentListEntry[]) =>
+const serializeEntries = (entries: ContentListEntry[]) =>
   entries
     .map((entry) => `${entry.type}${entry.content}${entry.description ?? ""}`)
     .sort()