@wtfalch/edge 0.7.0 → 0.8.0

package/dist/client.d.ts

@@ -1,5 +1,5 @@
 import { type ClientOptions } from './transport.js';
-import type { AdoptAccessAppsRequest, AdoptAccessAppsResponse, AdoptRecordsRequest, AdoptRecordsResponse, AdoptTunnelsRequest, AdoptTunnelsResponse, AdoptWorkersRequest, AdoptWorkersResponse, AvailableResponse, ClaimNameRequest, CreatePlatformAccessAppRequest, CreatePlatformAccessPolicyRequest, CreatePlatformRecordRequest, CreatePlatformTunnelRequest, CreatePlatformWorkerRouteRequest, FindServiceTokenResponse, ListClaimsResponse, ListPlatformAccessAppsRequest, ListPlatformAccessAppsResponse, ListPlatformAccessPoliciesResponse, ListPlatformRecordsRequest, ListPlatformRecordsResponse, ListPlatformTunnelsResponse, ListPlatformWorkerRoutesRequest, ListPlatformWorkerRoutesResponse, ListPlatformWorkerScriptsResponse, ListRecordsResponse, MintKeyRequest, MintKeyResponse, NameClaim, OrgSettingsRequest, PlatformAccessAppView, PlatformAccessPolicyView, PlatformRecordView, PlatformTunnelView, PlatformWorkerRouteView, PlatformWorkerScriptView, PutPlatformTunnelConfigRequest, RecordInput, RecordPatch, RecordView, TokenResponse, UpdatePlatformRecordRequest, UploadPlatformWorkerScriptRequest } from './types.js';
+import type { AdoptAccessAppsRequest, AdoptAccessAppsResponse, AdoptRateLimitRulesRequest, AdoptRateLimitRulesResponse, AdoptRecordsRequest, AdoptRecordsResponse, AdoptTunnelsRequest, AdoptTunnelsResponse, AdoptWorkersRequest, AdoptWorkersResponse, AvailableResponse, ClaimNameRequest, CreatePlatformAccessAppRequest, CreatePlatformAccessPolicyRequest, CreatePlatformRateLimitRuleRequest, CreatePlatformRecordRequest, CreatePlatformTunnelRequest, CreatePlatformWorkerRouteRequest, FindServiceTokenResponse, ListClaimsResponse, ListPlatformAccessAppsRequest, ListPlatformAccessAppsResponse, ListPlatformAccessPoliciesResponse, ListPlatformRateLimitRulesRequest, ListPlatformRateLimitRulesResponse, ListPlatformRecordsRequest, ListPlatformRecordsResponse, ListPlatformTunnelsResponse, ListPlatformWorkerRoutesRequest, ListPlatformWorkerRoutesResponse, ListPlatformWorkerScriptsResponse, ListRecordsResponse, MintKeyRequest, MintKeyResponse, NameClaim, OrgSettingsRequest, PlatformAccessAppView, PlatformAccessPolicyView, PlatformRateLimitRuleView, PlatformRecordView, PlatformTunnelView, PlatformWorkerRouteView, PlatformWorkerScriptView, PutPlatformTunnelConfigRequest, RecordInput, RecordPatch, RecordView, TokenResponse, UpdatePlatformRecordRequest, UploadPlatformWorkerScriptRequest } from './types.js';
 export { EdgeApiError, type ClientOptions } from './transport.js';
 /** Called with an entry's key: the key carries its organisation and domain, so
  * no call names either. `setReservedLabels`, `mintKey` and `revokeKey` are
@@ -85,6 +85,25 @@ export declare function createEdgeClient(options: ClientOptions): {
              * recreated, and an app nobody names is left alone. */
             adopt: (input: AdoptAccessAppsRequest) => Promise<AdoptAccessAppsResponse>;
         };
+        /** Cloudflare rate limiting rules the platform owns. A zone's rules share
+         * one ruleset, so each rule is owned on its own; a rule's `id` is
+         * Cloudflare's rule id. */
+        ratelimits: {
+            /** Every live rule in the zone with its owner (`null`: no row), optionally only one description. */
+            list: (filter: ListPlatformRateLimitRulesRequest) => Promise<ListPlatformRateLimitRulesResponse>;
+            /** Creates the rule, or returns the one edge already made for that zone
+             * and description (201 when new, 200 after). Rejects with `conflict` when
+             * a live rule with that description exists that nobody adopted (adopt it
+             * instead, reason `exists`) or another create of it is in progress
+             * (reason `busy`), and with `conflict` (reason `upstream_rejected`) when Cloudflare
+             * refuses the rule for good. */
+            create: (input: CreatePlatformRateLimitRuleRequest) => Promise<PlatformRateLimitRuleView>;
+            /** Deletes that one rule; returns the tombstone. Repeating it rejects with `not_found`. */
+            remove: (zoneId: string, id: string) => Promise<PlatformRateLimitRuleView>;
+            /** Writes platform rows for the rules named. Nothing is changed at
+             * Cloudflare, and anything nobody names is left alone. */
+            adopt: (input: AdoptRateLimitRulesRequest) => Promise<AdoptRateLimitRulesResponse>;
+        };
         /** Cloudflare Workers scripts and routes the platform owns. A script's
          * `id` is its name; a route's `id` is Cloudflare's route id. */
         workers: {

package/dist/client.js

@@ -88,6 +88,25 @@ export function createEdgeClient(options) {
                  * recreated, and an app nobody names is left alone. */
                 adopt: (input) => call('POST', '/v1/platform/access/apps/adopt', input),
             },
+            /** Cloudflare rate limiting rules the platform owns. A zone's rules share
+             * one ruleset, so each rule is owned on its own; a rule's `id` is
+             * Cloudflare's rule id. */
+            ratelimits: {
+                /** Every live rule in the zone with its owner (`null`: no row), optionally only one description. */
+                list: (filter) => call('GET', `/v1/platform/ratelimits/rules?${new URLSearchParams(Object.entries(filter).filter((entry) => entry[1] !== undefined))}`),
+                /** Creates the rule, or returns the one edge already made for that zone
+                 * and description (201 when new, 200 after). Rejects with `conflict` when
+                 * a live rule with that description exists that nobody adopted (adopt it
+                 * instead, reason `exists`) or another create of it is in progress
+                 * (reason `busy`), and with `conflict` (reason `upstream_rejected`) when Cloudflare
+                 * refuses the rule for good. */
+                create: (input) => call('POST', '/v1/platform/ratelimits/rules', input),
+                /** Deletes that one rule; returns the tombstone. Repeating it rejects with `not_found`. */
+                remove: (zoneId, id) => call('DELETE', `/v1/platform/ratelimits/rules/${encodeURIComponent(id)}?${new URLSearchParams({ zoneId })}`),
+                /** Writes platform rows for the rules named. Nothing is changed at
+                 * Cloudflare, and anything nobody names is left alone. */
+                adopt: (input) => call('POST', '/v1/platform/ratelimits/adopt', input),
+            },
             /** Cloudflare Workers scripts and routes the platform owns. A script's
              * `id` is its name; a route's `id` is Cloudflare's route id. */
             workers: {

package/dist/types.d.ts

@@ -501,3 +501,69 @@ export interface AdoptWorkersResponse {
         unclaimed: PlatformWorkerRouteView[];
     };
 }
+/** A rate limiting rule seen with the platform credential. A zone's rules share
+ * one ruleset, so ownership is per rule. `id` is Cloudflare's rule id, which
+ * every platform rule call takes. */
+export interface PlatformRateLimitRuleView {
+    id: string;
+    zoneId: string;
+    /** `null` for a live rule that has no description. */
+    description: string | null;
+    /** Who owns it: the platform, or `null` when no row exists (a live rule
+     * nobody adopted: reported, never touched). */
+    owner: 'platform' | null;
+    /** The company the rule serves; `'platform'` when none. `null` for a rule with no row. */
+    organisationId: string | null;
+    state: 'pending' | 'active' | 'removing' | 'removed';
+}
+export interface ListPlatformRateLimitRulesRequest {
+    zoneId: string;
+    /** Only the rule with exactly this description. */
+    description?: string;
+}
+export interface ListPlatformRateLimitRulesResponse {
+    rules: PlatformRateLimitRuleView[];
+}
+/** Creates the rule, or returns the one edge already made for that zone and
+ * description. The rule is added on its own: no other rule in the zone's
+ * ruleset is read back or rewritten. Cloudflare's plan limits (such as one rule
+ * on the Free plan) are Cloudflare's to refuse. */
+export interface CreatePlatformRateLimitRuleRequest {
+    zoneId: string;
+    /** Names the rule in the zone: the key that makes a repeat safe. */
+    description: string;
+    expression: string;
+    /** Cloudflare's rule action, such as `block`. */
+    action: string;
+    ratelimit: {
+        characteristics: string[];
+        period: number;
+        requests_per_period: number;
+        mitigation_timeout?: number;
+    };
+    /** The company the rule serves. Omit for a rule that serves none. */
+    organisationId?: string;
+}
+export interface AdoptRateLimitRuleEntry {
+    zoneId: string;
+    /** Match the live rule by description, by id, or both. At least one is needed. */
+    description?: string;
+    id?: string;
+}
+export interface AdoptRateLimitRulesRequest {
+    rules: AdoptRateLimitRuleEntry[];
+    /** The company the adopted rules serve. Omit for none. */
+    organisationId?: string;
+}
+export interface AdoptRateLimitRulesResponse {
+    adopted: PlatformRateLimitRuleView[];
+    alreadyAdopted: PlatformRateLimitRuleView[];
+    /** `taken`: a row for that zone and description exists. */
+    skipped: Array<{
+        rule: PlatformRateLimitRuleView;
+        reason: 'taken';
+    }>;
+    notFound: AdoptRateLimitRuleEntry[];
+    /** Live rules in the named zones that no entry named. Reported, never touched. */
+    unclaimed: PlatformRateLimitRuleView[];
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wtfalch/edge",
-  "version": "0.7.0",
+  "version": "0.8.0",
   "type": "module",
   "license": "MIT",
   "description": "Public client SDK and API types for the edge service.",