wrangler 0.0.0-e61907d → 0.0.0-e9ab55a

package/src/api/worker.ts

@@ -0,0 +1,155 @@
+import type { CfPreviewToken } from "./preview";
+import { previewToken } from "./preview";
+import fetch from "node-fetch";
+
+/**
+ * A Cloudflare account.
+ */
+export interface CfAccount {
+  /**
+   * An API token.
+   *
+   * @link https://api.cloudflare.com/#user-api-tokens-properties
+   */
+  apiToken: string;
+  /**
+   * An account ID.
+   */
+  accountId: string;
+  /**
+   * A zone ID, only required if not using `workers.dev`.
+   */
+  zoneId?: string;
+}
+
+/**
+ * A module type.
+ */
+export type CfModuleType =
+  | "esm"
+  | "commonjs"
+  | "compiled-wasm"
+  | "text"
+  | "buffer";
+
+/**
+ * An imported module.
+ */
+export interface CfModule {
+  /**
+   * The module name.
+   *
+   * @example
+   * './src/index.js'
+   */
+  name: string;
+  /**
+   * The module content, usually JavaScript or WASM code.
+   *
+   * @example
+   * export default {
+   *   async fetch(request) {
+   *     return new Response('Ok')
+   *   }
+   * }
+   */
+  content: string | BufferSource;
+  /**
+   * The module type.
+   *
+   * If absent, will default to the main module's type.
+   */
+  type?: CfModuleType;
+}
+
+/**
+ * A map of variable names to values.
+ */
+interface CfVars {
+  [key: string]: string;
+}
+
+/**
+ * A KV namespace.
+ */
+interface CfKvNamespace {
+  binding: string;
+  id: string;
+}
+
+/**
+ * A Durable Object.
+ */
+interface CfDurableObject {
+  name: string;
+  class_name: string;
+  script_name?: string;
+}
+
+/**
+ * A Service.
+ */
+interface CfService {
+  name: string;
+  service: string;
+  environment: string;
+}
+
+export interface CfDurableObjectMigrations {
+  old_tag?: string;
+  new_tag: string;
+  steps: {
+    new_classes?: string[];
+    renamed_classes?: string[];
+    deleted_classes?: string[];
+  }[];
+}
+
+/**
+ * Options for creating a `CfWorker`.
+ */
+export interface CfWorkerInit {
+  /**
+   * The name of the worker.
+   */
+  name: string | undefined;
+  /**
+   * The entrypoint module.
+   */
+  main: CfModule;
+  /**
+   * The list of additional modules.
+   */
+  modules: undefined | CfModule[];
+  /**
+   * All the bindings
+   */
+  bindings: {
+    kv_namespaces?: CfKvNamespace[];
+    durable_objects?: { bindings: CfDurableObject[] };
+    vars?: CfVars;
+    services?: CfService[];
+  };
+  migrations: undefined | CfDurableObjectMigrations;
+  compatibility_date: string | undefined;
+  compatibility_flags: undefined | string[];
+  usage_model: undefined | "bundled" | "unbound";
+}
+
+/**
+ * A stub to create a Cloudflare Worker preview.
+ *
+ * @example
+ * const {value, host} = await createWorker(init, acct);
+ */
+export async function createWorker(
+  init: CfWorkerInit,
+  account: CfAccount
+): Promise<CfPreviewToken> {
+  const token = await previewToken(account, init);
+  const response = await fetch(token.prewarmUrl.href, { method: "POST" });
+  if (!response.ok) {
+    // console.error("worker failed to prewarm: ", response.statusText);
+  }
+  return token;
+}

package/src/cfetch/index.ts

@@ -0,0 +1,102 @@
+import type { RequestInit } from "node-fetch";
+import { URLSearchParams } from "url";
+import { fetchInternal } from "./internal";
+
+// Check out https://api.cloudflare.com/ for API docs.
+
+export { CF_API_BASE_URL } from "./internal";
+
+export interface FetchError {
+  code: number;
+  message: string;
+}
+export interface FetchResult<ResponseType = unknown> {
+  success: boolean;
+  result: ResponseType;
+  errors: FetchError[];
+  messages: string[];
+  result_info?: unknown;
+}
+
+/**
+ * Make a fetch request for a raw JSON value.
+ */
+export async function fetchRaw<ResponseType>(
+  resource: string,
+  init: RequestInit = {},
+  queryParams?: URLSearchParams
+): Promise<ResponseType> {
+  return fetchInternal<ResponseType>(resource, init, queryParams);
+}
+
+/**
+ * Make a fetch request, and extract the `result` from the JSON response.
+ */
+export async function fetchResult<ResponseType>(
+  resource: string,
+  init: RequestInit = {},
+  queryParams?: URLSearchParams
+): Promise<ResponseType> {
+  const json = await fetchInternal<FetchResult<ResponseType>>(
+    resource,
+    init,
+    queryParams
+  );
+  if (json.success) {
+    return json.result;
+  } else {
+    throwFetchError(resource, json);
+  }
+}
+
+/**
+ * Make a fetch request for a list of values,
+ * extracting the `result` from the JSON response,
+ * and repeating the request if the results are paginated.
+ */
+export async function fetchListResult<ResponseType>(
+  resource: string,
+  init: RequestInit = {},
+  queryParams?: URLSearchParams
+): Promise<ResponseType[]> {
+  const results: ResponseType[] = [];
+  let getMoreResults = true;
+  let cursor: string | undefined;
+  while (getMoreResults) {
+    if (cursor) {
+      queryParams = new URLSearchParams(queryParams);
+      queryParams.set("cursor", cursor);
+    }
+    const json = await fetchInternal<FetchResult<ResponseType[]>>(
+      resource,
+      init,
+      queryParams
+    );
+    if (json.success) {
+      results.push(...json.result);
+      if (hasCursor(json.result_info)) {
+        cursor = json.result_info?.cursor;
+      } else {
+        getMoreResults = false;
+      }
+    } else {
+      throwFetchError(resource, json);
+    }
+  }
+  return results;
+}
+
+function throwFetchError(
+  resource: string,
+  response: FetchResult<unknown>
+): never {
+  response.messages.forEach((message) => console.warn(message));
+  const errors = response.errors
+    .map((error) => `${error.code}: ${error.message}`)
+    .join("\n");
+  throw new Error(`Failed to fetch ${resource} - ${errors}`);
+}
+
+function hasCursor(result_info: unknown): result_info is { cursor: string } {
+  return (result_info as { cursor } | undefined)?.cursor !== undefined;
+}

package/src/cfetch/internal.ts

@@ -0,0 +1,69 @@
+import fetch from "node-fetch";
+import type { RequestInit, HeadersInit } from "node-fetch";
+import { getAPIToken, loginOrRefreshIfRequired } from "../user";
+
+export const CF_API_BASE_URL =
+  process.env.CF_API_BASE_URL || "https://api.cloudflare.com/client/v4";
+
+/**
+ * Make a fetch request to the Cloudflare API.
+ *
+ * This function handles acquiring the API token and logging the caller in, as necessary.
+ *
+ * Check out https://api.cloudflare.com/ for API docs.
+ *
+ * This function should not be used directly, instead use the functions in `cfetch/index.ts`.
+ */
+export async function fetchInternal<ResponseType>(
+  resource: string,
+  init: RequestInit = {},
+  queryParams?: URLSearchParams
+): Promise<ResponseType> {
+  await requireLoggedIn();
+  const apiToken = requireApiToken();
+  const headers = cloneHeaders(init.headers);
+  addAuthorizationHeader(headers, apiToken);
+
+  const queryString = queryParams ? `?${queryParams.toString()}` : "";
+  const response = await fetch(`${CF_API_BASE_URL}${resource}${queryString}`, {
+    method: "GET",
+    ...init,
+    headers,
+  });
+
+  if (response.ok) {
+    return (await response.json()) as ResponseType;
+  } else {
+    throw new Error(
+      `Failed to fetch ${resource} - ${response.status}: ${response.statusText}`
+    );
+  }
+}
+
+function cloneHeaders(headers: HeadersInit | undefined): HeadersInit {
+  return { ...headers };
+}
+
+async function requireLoggedIn(): Promise<void> {
+  const loggedIn = await loginOrRefreshIfRequired();
+  if (!loggedIn) {
+    throw new Error("Not logged in.");
+  }
+}
+
+function requireApiToken(): string {
+  const apiToken = getAPIToken();
+  if (!apiToken) {
+    throw new Error("No API token found.");
+  }
+  return apiToken;
+}
+
+function addAuthorizationHeader(headers: HeadersInit, apiToken: string): void {
+  if (headers["Authorization"]) {
+    throw new Error(
+      "The request already specifies an authorisation header - cannot add a new one."
+    );
+  }
+  headers["Authorization"] = `Bearer ${apiToken}`;
+}

package/src/cli.ts

@@ -0,0 +1,9 @@
+import { hideBin } from "yargs/helpers";
+import { main } from ".";
+
+main(hideBin(process.argv)).catch(() => {
+  // The logging of any error that was thrown from `main()` is handled in the `yargs.fail()` handler.
+  // Here we just want to ensure that the process exits with a non-zero code.
+  // We don't want to do this inside the `main()` function, since that would kill the process when running our tests.
+  process.exit(1);
+});