@zackbart/connecta 0.30.0 → 0.32.0

package/dist/providers/cloudflare/rest.d.ts

@@ -0,0 +1,37 @@
+import type { ApiTool } from "../../connectors/api-connector.js";
+import type { ConnectorContext, CredentialTestResult } from "../../types.js";
+import { type RestVendor } from "../_shared/rest/tools.js";
+/** Cloudflare's v4 REST base. Override only for a proxy or a test double. */
+export declare const CLOUDFLARE_API_BASE = "https://api.cloudflare.com/client/v4";
+/** The two key schemes Cloudflare's v4 API accepts. */
+export type CloudflareKeyAuth = "apiToken" | "globalApiKey";
+/** Accounts and zones a connector may touch; everything else is refused. */
+export interface CloudflarePin {
+    accountIds?: readonly string[];
+    zoneIds?: readonly string[];
+}
+export interface CloudflareRestOptions {
+    auth: CloudflareKeyAuth;
+    baseUrl: string;
+    accountId: string | undefined;
+    zoneId: string | undefined;
+    pin: CloudflarePin | undefined;
+}
+/**
+ * Operations with no account or zone in their path that a pinned connector
+ * still admits, each holding to the pin some other way: the identity reads
+ * name only the credential's own user, the three lists are filtered to the
+ * pin, zone creation must name a pinned account, and the rest is public data.
+ * Every other unscoped operation is refused under a pin (default deny).
+ */
+export declare const PIN_SAFE_UNSCOPED: ReadonlySet<string>;
+/** Why each family of unscoped operations is refused under a pin; `test` checks every one is covered. */
+export declare const PIN_REFUSED_UNSCOPED: Readonly<Record<string, string>>;
+export interface CloudflareRest {
+    vendor: RestVendor;
+    tools: ApiTool[];
+    testCredential(value: string, ctx: ConnectorContext): Promise<CredentialTestResult>;
+    testCredentials(values: Record<string, string>, ctx: ConnectorContext): Promise<CredentialTestResult>;
+}
+/** Cloudflare's REST vendor, its named tools, and its credential tests. */
+export declare function cloudflareRest(options: CloudflareRestOptions): CloudflareRest;