Skip to content
Burrow0.1.0
API reference

namespace

Exports

Section titled “Exports”
Kind Export Description
type alias ArtifactsRepositoryInfo Host-only Artifacts namespace. Repository credentials never enter App results.
type alias ArtifactsCreatedRepository Initial revocation reference: a Workers token or an already-revoked REST ID.
type alias ArtifactsCommit Provider commit metadata and parent object IDs.
type alias ArtifactsTreeEntry One provider tree entry, including its mode and object kind.
type alias ArtifactsRepositoryHandle Host-only repository operations; secrets never belong in App results.
type alias ArtifactsNamespace Configured provider namespace with repository-name-addressed handles.

ArtifactsRepositoryInfotype alias

Section titled “ArtifactsRepositoryInfo”
Signature
type ArtifactsRepositoryInfo = Readonly<{
  id: string;
  name: string;
  defaultBranch: string;
  remote: string;
  lastPushAt?: string | null;
  source?: string | null;
}>;

Host-only Artifacts namespace. Repository credentials never enter App results.

ArtifactsCreatedRepositorytype alias

Section titled “ArtifactsCreatedRepository”
Signature
type ArtifactsCreatedRepository = ArtifactsRepositoryInfo &
  Readonly<{
    token: string;
  }>;

Initial revocation reference: a Workers token or an already-revoked REST ID.

ArtifactsCommittype alias

Section titled “ArtifactsCommit”
Signature
type ArtifactsCommit = Readonly<{
  hash: string;
  treeHash: string;
  message: string;
  author: Readonly<{
    name: string;
    email: string;
  }>;
  committer: Readonly<{
    name: string;
    email: string;
  }>;
  parents: readonly string[];
  authoredAt: number;
  committedAt: number;
}>;

Provider commit metadata and parent object IDs.

ArtifactsTreeEntrytype alias

Section titled “ArtifactsTreeEntry”
Signature
type ArtifactsTreeEntry = Readonly<{
  name: string;
  mode: string;
  hash: string;
  type: "blob" | "tree" | "commit";
}>;

One provider tree entry, including its mode and object kind.

ArtifactsRepositoryHandletype alias

Section titled “ArtifactsRepositoryHandle”
Signature
type ArtifactsRepositoryHandle = Readonly<{
  info: Promise<
    Readonly<{
      id: string;
      name: string;
      defaultBranch: string;
      remote: string;
      lastPushAt?: string | null;
      source?: string | null;
    }>
  >;
  createToken: Promise<
    Readonly<{
      id: string;
      plaintext: string;
      expiresAt: string;
    }>
  >;
  revokeToken: Promise<boolean>;
  fork: Promise<ArtifactsCreatedRepository>;
  log: Promise<
    readonly Readonly<{
      hash: string;
      treeHash: string;
      message: string;
      author: Readonly<{
        name: string;
        email: string;
      }>;
      committer: Readonly<{
        name: string;
        email: string;
      }>;
      parents: readonly string[];
      authoredAt: number;
      committedAt: number;
    }>[]
  >;
  readCommit: Promise<Readonly<{
    hash: string;
    treeHash: string;
    message: string;
    author: Readonly<{
      name: string;
      email: string;
    }>;
    committer: Readonly<{
      name: string;
      email: string;
    }>;
    parents: readonly string[];
    authoredAt: number;
    committedAt: number;
  }> | null>;
  readTree: Promise<
    | readonly Readonly<{
        name: string;
        mode: string;
        hash: string;
        type: "blob" | "tree" | "commit";
      }>[]
    | null
  >;
  readBlob: Promise<Blob | null>;
}>;

Host-only repository operations; secrets never belong in App results.

ArtifactsNamespacetype alias

Section titled “ArtifactsNamespace”
Signature
type ArtifactsNamespace = Readonly<{
  create: Promise<ArtifactsCreatedRepository>;
  get: Promise<Readonly<{
     info: Promise<Readonly<{
        id: string;
        name: string;
        defaultBranch: string;
        remote: string;
        lastPushAt?: string | null;
        source?: string | null;
     }>>;
     createToken: Promise<Readonly<{
        id: string;
        plaintext: string;
        expiresAt: string;
     }>>;
     revokeToken: Promise<boolean>;
     fork: Promise<ArtifactsCreatedRepository>;
     log: Promise<readonly Readonly<{
        hash: string;
        treeHash: string;
        message: string;
        author: Readonly<{
           name: ...;
           email: ...;
        }>;
        committer: Readonly<{
           name: ...;
           email: ...;
        }>;
        parents: readonly ...[];
        authoredAt: number;
        committedAt: number;
     }>[]>;
     readCommit: Promise<
        | Readonly<{
        hash: string;
        treeHash: string;
        message: string;
        author: Readonly<{
           name: ...;
           email: ...;
        }>;
        committer: Readonly<{
           name: ...;
           email: ...;
        }>;
        parents: readonly ...[];
        authoredAt: number;
        committedAt: number;
      }>
       | null>;
     readTree: Promise<
        | readonly Readonly<{
        name: string;
        mode: string;
        hash: string;
        type: ... | ... | ...;
      }>[]
       | null>;
     readBlob: Promise<Blob | null>;
  }>>;
  list: Promise<Readonly<{
     repos: readonly Readonly<{
        name: string;
        status: string;
     }>[];
     total: number;
     cursor?: string;
  }>>;
  delete: Promise<boolean>;
}>;

Configured provider namespace with repository-name-addressed handles.