@goodfellow-cms/github 0.2.0 → 0.4.0

package/dist/testing.d.ts

@@ -4,6 +4,8 @@ import { FakeRepo } from "@goodfellow-cms/core/testing";
 export interface FakeGitHubUser {
   login: string;
   name?: string;
+  /** GitHub's number for the account. Defaults to one worked out from the login. */
+  id?: number;
   /** Whether the user may publish. Defaults to true. */
   push?: boolean;
   /** Whether the token may write `.github/workflows/`. Defaults to true. */
@@ -18,6 +20,8 @@ export interface FakeGitHubUser {
   actions?: boolean;
   /** Whether the token may run workflows, as owner tokens can. Defaults to the `administration` setting. */
   actionsWrite?: boolean;
+  /** Whether the token may set Actions secrets and add deploy keys. Defaults to true. */
+  secrets?: boolean;
 }
 /** A GitHub Actions workflow run, with its jobs and their steps. */
 export interface FakeRun {
@@ -30,6 +34,8 @@ export interface FakeRun {
   createdAt?: string;
   status: "queued" | "in_progress" | "completed";
   conclusion: "success" | "failure" | "startup_failure" | "cancelled" | null;
+  /** The workflow's file, `.github/workflows/deploy.yml` by default. */
+  path?: string;
   jobs: Array<{
     name: string;
     conclusion: string | null;
@@ -80,9 +86,43 @@ export interface FakeGitHubOptions {
   takenDomains?: string[];
   /** Other GitHub accounts that exist, which can be invited. Every token's user exists too. */
   accounts?: string[];
+  /** GitHub Apps, which the sign-in worker signs people in with. */
+  apps?: FakeGitHubApp[];
+}
+/** A GitHub App, as the sign-in worker uses one: its JWTs, installations, OAuth sign-in and tokens. */
+export interface FakeGitHubApp {
+  id: string;
+  slug: string;
+  clientId: string;
+  clientSecret: string;
+  /** The app's public key, which its JWTs are checked against. Without it, any JWT naming the app is accepted. */
+  publicKey?: CryptoKey;
+  /** The most its tokens may be given, as GitHub names permissions. */
+  permissions: Record<string, "read" | "write">;
+  installations: FakeInstallation[];
+}
+/** An app installed on an account, for some or all of its repositories. */
+export interface FakeInstallation {
+  id: number;
+  /** The account it's installed on. */
+  account: string;
+  accountType?: "User" | "Organization";
+  /** The repositories it can use, as `owner/name`, or `all` of the account's. */
+  repositories: string[] | "all";
+}
+/** A token an app's sign-in made: a person's own, or an installation's for some repositories. */
+export interface FakeIssuedToken {
+  token: string;
+  kind: "user" | "installation";
+  app: string;
+  login?: string;
+  repositories?: string[];
+  permissions: Record<string, string>;
+  revoked?: boolean;
 }
 /** A repository created through the fake's API, as the setup page creates them. */
 export interface FakeCreatedRepo {
+  id: number;
   fullName: string;
   private: boolean;
   description?: string;
@@ -91,6 +131,18 @@ export interface FakeCreatedRepo {
     build_type: string;
   };
   rulesets: unknown[];
+  /** Deploy keys added to it, by their public key. */
+  deployKeys: Array<{
+    title: string;
+    key: string;
+    read_only: boolean;
+  }>;
+  /** Its Actions secrets, opened. */
+  secrets: Map<string, string>;
+  /** The key pair GitHub seals secrets with. */
+  secretKey?: CryptoKeyPair;
+  /** People's permission on it, by login, as `collaborators/{login}/permission` says; others have none. */
+  collaborators?: Map<string, "admin" | "write" | "read">;
 }
 interface Deployment {
   id: number;
@@ -100,8 +152,27 @@ interface Deployment {
 }
 export declare function fakeGitHub(options: FakeGitHubOptions): {
   repo: FakeRepo;
-  /** Repositories created through the API, by `owner/name`. */
+  /** How many GraphQL requests read files, as `readFiles()` makes. */
+  readonly graphqlReads: number;
+  /** Tokens apps' sign-ins made, in order. */
+  issued: FakeIssuedToken[];
+  /** Who commits made through the REST API name as their author, by commit. */
+  commitAuthors: Map<string, {
+    name?: string;
+    email?: string;
+  }>;
+  authorize: (login: string, clientId: string) => string;
+  install: (slug: string, login: string, repositories: string[], account?: string) => {
+    code: string;
+    installation: number;
+  };
+  /** Repositories created through the API, or added with `addRepo()`, by `owner/name`. */
   created: Map<string, FakeCreatedRepo>;
+  addRepo: (fullName: string, repoOptions?: {
+    files?: Record<string, string>;
+    private?: boolean;
+    collaborators?: Record<string, "admin" | "write" | "read">;
+  }) => FakeCreatedRepo;
   /** The site's GitHub Pages settings, which tests can change, such as to issue the certificate. */
   pages: {
     current?: FakePages;
@@ -117,7 +188,7 @@ export declare function fakeGitHub(options: FakeGitHubOptions): {
   /** Every request received, for checking what the backend sent. */
   requests: Request[];
   /** Simulates someone else publishing. */
-  commit: (changes: FileChange[], message: string, expectedHead?: string, author?: string) => string;
+  commit: (changes: FileChange[], message: string, expectedHead?: string, author?: string, branch?: string) => string;
   handle: (request: Request) => Promise<Response>;
   /** A `fetch` that answers from the fake instead of the network. */
   fetch: typeof fetch;