@wtfalch/edge 0.8.0 → 0.9.0

package/dist/client.d.ts

@@ -1,5 +1,5 @@
 import { type ClientOptions } from './transport.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';
+import type { AdoptAccessAppsRequest, AdoptAccessAppsResponse, AdoptRateLimitRulesRequest, AdoptRateLimitRulesResponse, AdoptRecordsRequest, AdoptRecordsResponse, AdoptTunnelsRequest, AdoptTunnelsResponse, AdoptWorkersRequest, AdoptWorkersResponse, AdoptZonesRequest, AdoptZonesResponse, AvailableResponse, ClaimNameRequest, CreatePlatformAccessAppRequest, CreatePlatformAccessPolicyRequest, CreatePlatformRateLimitRuleRequest, CreatePlatformRecordRequest, CreatePlatformTunnelRequest, CreatePlatformWorkerRouteRequest, CreatePlatformZoneRequest, FindServiceTokenResponse, ListClaimsResponse, ListPlatformAccessAppsRequest, ListPlatformAccessAppsResponse, ListPlatformAccessPoliciesResponse, ListPlatformRateLimitRulesRequest, ListPlatformRateLimitRulesResponse, ListPlatformRecordsRequest, ListPlatformRecordsResponse, ListPlatformTunnelsResponse, ListPlatformWorkerRoutesRequest, ListPlatformWorkerRoutesResponse, ListPlatformWorkerScriptsResponse, ListPlatformZonesRequest, ListPlatformZonesResponse, ListRecordsResponse, MintKeyRequest, MintKeyResponse, NameClaim, OrgSettingsRequest, PlatformAccessAppView, PlatformAccessPolicyView, PlatformRateLimitRuleView, PlatformRecordView, PlatformTunnelView, PlatformWorkerRouteView, PlatformWorkerScriptView, PlatformZoneView, 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
@@ -104,6 +104,22 @@ export declare function createEdgeClient(options: ClientOptions): {
              * Cloudflare, and anything nobody names is left alone. */
             adopt: (input: AdoptRateLimitRulesRequest) => Promise<AdoptRateLimitRulesResponse>;
         };
+        /** Cloudflare zones the platform made or adopted. A zone is the root of a
+         * company's domain, so there is no delete. A zone's `id` is Cloudflare's zone id. */
+        zones: {
+            /** The live zone with exactly this name (none: an empty list), with its owner (`null`: no row). */
+            list: (filter: ListPlatformZonesRequest) => Promise<ListPlatformZonesResponse>;
+            /** Creates the zone, or returns the one edge already made for that name
+             * (201 when new, 200 after); `nameServers` are what the registrar must
+             * delegate to. Rejects with `conflict` when a zone of that name already
+             * exists at Cloudflare 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 zone for good. */
+            create: (input: CreatePlatformZoneRequest) => Promise<PlatformZoneView>;
+            /** Writes platform rows for the zones named. Nothing is changed at Cloudflare. */
+            adopt: (input: AdoptZonesRequest) => Promise<AdoptZonesResponse>;
+        };
         /** 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

@@ -107,6 +107,22 @@ export function createEdgeClient(options) {
                  * Cloudflare, and anything nobody names is left alone. */
                 adopt: (input) => call('POST', '/v1/platform/ratelimits/adopt', input),
             },
+            /** Cloudflare zones the platform made or adopted. A zone is the root of a
+             * company's domain, so there is no delete. A zone's `id` is Cloudflare's zone id. */
+            zones: {
+                /** The live zone with exactly this name (none: an empty list), with its owner (`null`: no row). */
+                list: (filter) => call('GET', `/v1/platform/zones?${new URLSearchParams({ name: filter.name })}`),
+                /** Creates the zone, or returns the one edge already made for that name
+                 * (201 when new, 200 after); `nameServers` are what the registrar must
+                 * delegate to. Rejects with `conflict` when a zone of that name already
+                 * exists at Cloudflare 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 zone for good. */
+                create: (input) => call('POST', '/v1/platform/zones', input),
+                /** Writes platform rows for the zones named. Nothing is changed at Cloudflare. */
+                adopt: (input) => call('POST', '/v1/platform/zones/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

@@ -567,3 +567,52 @@ export interface AdoptRateLimitRulesResponse {
     /** Live rules in the named zones that no entry named. Reported, never touched. */
     unclaimed: PlatformRateLimitRuleView[];
 }
+/** A Cloudflare zone seen with the platform credential. A zone is the root of a
+ * company's domain, so edge only looks it up, creates it and adopts it: there is no delete. */
+export interface PlatformZoneView {
+    /** Cloudflare's zone id. */
+    id: string;
+    name: string;
+    /** Cloudflare's zone status, such as `pending` until the registrar delegates. */
+    status: string;
+    /** What the domain's registrar must delegate to. */
+    nameServers: string[];
+    /** Who owns it: the platform, or `null` when no row exists (a live zone
+     * nobody adopted: reported, never touched). */
+    owner: 'platform' | null;
+    /** The company the zone serves; `'platform'` when none. `null` for a zone with no row. */
+    organisationId: string | null;
+    state: 'pending' | 'active' | 'removed' | null;
+}
+export interface ListPlatformZonesRequest {
+    /** The zone's exact name, such as `example.com`. */
+    name: string;
+}
+/** Empty when no zone has that name. */
+export interface ListPlatformZonesResponse {
+    zones: PlatformZoneView[];
+}
+export interface CreatePlatformZoneRequest {
+    /** The domain's apex, such as `example.com`. Lower-cased. */
+    name: string;
+    /** The company the zone serves. Omit for a zone that serves none. */
+    organisationId?: string;
+}
+export interface AdoptZoneEntry {
+    name: string;
+}
+export interface AdoptZonesRequest {
+    zones: AdoptZoneEntry[];
+    /** The company the adopted zones serve. Omit for none. */
+    organisationId?: string;
+}
+export interface AdoptZonesResponse {
+    adopted: PlatformZoneView[];
+    alreadyAdopted: PlatformZoneView[];
+    /** `taken`: a row for that name holds a different zone. */
+    skipped: Array<{
+        zone: PlatformZoneView;
+        reason: 'taken';
+    }>;
+    notFound: AdoptZoneEntry[];
+}

package/package.json

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