cloudflare

Import

Import

import * as api from "@fungi.computer/burrow/cloudflare";

Exports

Kind	Export	Description
Cclass	ArtifactsForkStuckError	A repository did not finish importing or forking within the readiness window.
Ttype alias	CloudflareArtifactsRepositoryHandle	Repository handle accepted by the Cloudflare Artifacts namespace.
Ttype alias	CloudflareArtifactsRepositoryMetadata	Provider identity recorded at creation; used to pin later remote access.
Ttype alias	CloudflareArtifactsRepositoryMetadataStore	Host-owned durable metadata and pending initial-token revocation records.
Ttype alias	CloudflareArtifactsNamespace	The maintained Cloudflare namespace methods used by this private adapter.
Ttype alias	CloudflareArtifactsRepositoryPage	Repository listing page used to observe fork/import readiness.
Ttype alias	CloudflareArtifactsOptions	Provider, durable metadata store and optional Git protocol transports.
fnfunction	exchangeCloudflareArtifactsGit()	Execute Git with an already-held repo credential. The custody owner chooses metadata and credential; caller URLs and authorization headers never enter.
fnfunction	createCloudflareArtifacts()	Configure the Artifacts owner once; provider remotes and credentials stay private.

ArtifactsForkStuckErrorCclass

A repository did not finish importing or forking within the readiness window.

Extends

• Error

Constructors

Constructor

Signature

new ArtifactsForkStuckError(repository, status): ArtifactsForkStuckError;

Parameters

Parameter	Type
repository	string
status	"importing" | "forking" | "missing"

Returns

ArtifactsForkStuckError

Overrides

Signature

Error.constructor;

Properties

name

Signature

readonly name: "ArtifactsForkStuckError" = "ArtifactsForkStuckError";

Overrides

Signature

Error.name;

repository

Signature

readonly repository: string;

status

Signature

readonly status: "importing" | "forking" | "missing";

CloudflareArtifactsRepositoryHandleTtype alias

Signature

type CloudflareArtifactsRepositoryHandle = Readonly<{
  info?: () => Promise<ArtifactsRepositoryInfo>;
  createToken: Promise<
    Readonly<{
      id: string;
      plaintext: string;
      expiresAt: string;
    }>
  >;
  revokeToken: Promise<boolean>;
  fork: Promise<
    Readonly<{
      id: string;
      name: string;
      remote: string;
      defaultBranch: string;
      token: string;
    }>
  >;
}>;

Repository handle accepted by the Cloudflare Artifacts namespace.

---

CloudflareArtifactsRepositoryMetadataTtype alias

Signature

type CloudflareArtifactsRepositoryMetadata = Readonly<{
  id: string;
  name: string;
  defaultBranch: string;
  remote: string;
  parentRepository: string | null;
}>;

Provider identity recorded at creation; used to pin later remote access.

---

CloudflareArtifactsRepositoryMetadataStoreTtype alias

Signature

type CloudflareArtifactsRepositoryMetadataStore = Readonly<{
  read: Promise<Readonly<{
    id: string;
    name: string;
    defaultBranch: string;
    remote: string;
    parentRepository: string | null;
  }> | null>;
  readPending: Promise<Readonly<{
    metadata: CloudflareArtifactsRepositoryMetadata;
    initialToken: string;
  }> | null>;
  recordPending: Promise<void>;
  activate: Promise<void>;
}>;

Host-owned durable metadata and pending initial-token revocation records.

---

CloudflareArtifactsNamespaceTtype alias

Signature

type CloudflareArtifactsNamespace = Readonly<{
  get: Promise<
    Readonly<{
      info?: () => Promise<ArtifactsRepositoryInfo>;
      createToken: Promise<
        Readonly<{
          id: string;
          plaintext: string;
          expiresAt: string;
        }>
      >;
      revokeToken: Promise<boolean>;
      fork: Promise<
        Readonly<{
          id: string;
          name: string;
          remote: string;
          defaultBranch: string;
          token: string;
        }>
      >;
    }>
  >;
  list: Promise<
    Readonly<{
      repos: readonly Readonly<{
        name: string;
      }>[];
      total: number;
      cursor?: string;
    }>
  >;
  create: Promise<
    Readonly<{
      id: string;
      name: string;
      remote: string;
      defaultBranch: string;
      token: string;
    }>
  >;
}>;

The maintained Cloudflare namespace methods used by this private adapter.

---

CloudflareArtifactsRepositoryPageTtype alias

Signature

type CloudflareArtifactsRepositoryPage = Readonly<{
  repos: readonly Readonly<{
    name: string;
  }>[];
  total: number;
  cursor?: string;
}>;

Repository listing page used to observe fork/import readiness.

---

CloudflareArtifactsOptionsTtype alias

Signature

type CloudflareArtifactsOptions = Readonly<{
  namespace: CloudflareArtifactsNamespace;
  repositories: CloudflareArtifactsRepositoryMetadataStore;
  gitHttp?: typeof http;
  gitFetch?: typeof fetch;
}>;

Provider, durable metadata store and optional Git protocol transports.

exchangeCloudflareArtifactsGit()fnfunction

Signature

function exchangeCloudflareArtifactsGit(
  metadata,
  input,
  credential,
  gitFetch,
): Promise<Response>;

Execute Git with an already-held repo credential. The custody owner chooses metadata and credential; caller URLs and authorization headers never enter.

Parameters

Parameter	Type
metadata	CloudflareArtifactsRepositoryMetadata
input	GitExchange
credential	string
gitFetch	{ (input, init?): Promise<Response>; (input, init?): Promise<Response>; (input, init?): Promise<Response>; }

Returns

Promise<Response>

---

createCloudflareArtifacts()fnfunction

Signature

function createCloudflareArtifacts(options): Artifacts;

Configure the Artifacts owner once; provider remotes and credentials stay private.

Parameters

Parameter	Type
options	CloudflareArtifactsOptions

Returns

Artifacts