@goodfellow-cms/github 0.1.0 → 0.2.0

package/README.md

@@ -8,9 +8,9 @@ import { github } from "@goodfellow-cms/github";
 export default defineConfig({ blocks, backend: github({ repo: "your-name/your-site" }) });
 ```
 
-[Goodfellow](https://github.com/chartung17/goodfellow-cms) is a website builder for people who aren't developers, with no server or database: pages are files in your own GitHub or GitLab repository, edited in a visual editor built on [Puck](https://puckeditor.com). To start a new site, run `npm create goodfellow@latest my-site`. See the [documentation](https://chartung17.github.io/goodfellow-cms/) for everything else.
+[Goodfellow](https://github.com/goodfellow-cms/goodfellow-cms) is a website builder for people who aren't developers, with no server or database: pages are files in your own GitHub or GitLab repository, edited in a visual editor built on [Puck](https://puckeditor.com). To start a new site, run `npm create goodfellow@latest my-site`. See the [documentation](https://goodfellow-cms.github.io/goodfellow-cms/) for everything else.
 
-More in the docs: [Hosts and business sites](https://chartung17.github.io/goodfellow-cms/docs/hosts).
+More in the docs: [Hosts and business sites](https://goodfellow-cms.github.io/goodfellow-cms/docs/hosts).
 
 ## License
 

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { DeployStatus, FileChange, GitBackend, GitHost, GitUser, StorageLike, WriteOptions } from "@goodfellow-cms/core";
+import { ConnectDomainOptions, DeployStatus, DnsRecord, FileChange, FileVersion, GitBackend, GitHost, GitUser, HistoryOptions, OwnerAccess, PagesDomains, SetupHost, SiteEditors, SiteUpdates, StorageLike, TokenLink, WriteOptions } from "@goodfellow-cms/core";
 //#region src/api.d.ts
 interface ApiOptions {
   apiUrl: string;
@@ -13,6 +13,8 @@ interface GitHubBackendOptions {
   branch: string;
   user: GitUser;
   onSignOut: () => void;
+  /** Where to create the owner token, which can change editors and GitHub Pages settings. */
+  ownerTokenLink: TokenLink;
 }
 /**
  * The site's files on GitHub. Reads come from the commit `revision()` last
@@ -21,6 +23,10 @@ interface GitHubBackendOptions {
  */
 export declare class GitHubBackend implements GitBackend {
   readonly user: GitUser;
+  readonly pages: PagesDomains;
+  readonly editors: SiteEditors;
+  readonly ownerAccess: OwnerAccess;
+  readonly updates: SiteUpdates;
   private readonly api;
   private readonly repo;
   private readonly branch;
@@ -34,20 +40,54 @@ export declare class GitHubBackend implements GitBackend {
   private tree;
   private currentTree;
   read(path: string): Promise<string | undefined>;
+  private readFrom;
   readBytes(path: string): Promise<Uint8Array | undefined>;
   list(dir: string): Promise<string[]>;
   write(changes: FileChange[], { message, expectedRevision }: WriteOptions): Promise<{
     revision: string;
   }>;
+  history(path: string, { page, perPage }?: HistoryOptions): Promise<FileVersion[]>;
+  readAt(path: string, revision: string): Promise<string | undefined>;
   changedPaths(from: string, to: string): Promise<string[]>;
   /**
-   * Reads the deployment GitHub Pages or Vercel created for a commit. Before
-   * one exists, the site counts as building if it has ever been deployed.
+   * Reads the deployment GitHub Pages or Vercel created for a commit, and for
+   * GitHub Actions, the workflow run that builds it: a build that fails never
+   * creates a deployment. Before either exists, the site counts as building
+   * if it has ever been deployed.
    */
   deployStatus(revision: string): Promise<DeployStatus>;
+  /** The site's deploy workflow run for a commit, or `undefined` if there's none or the token can't see Actions. */
+  private workflowRun;
+  /** Which step of a failed run failed. */
+  private runProblem;
   signOut(): void;
 }
 //#endregion
+//#region src/pages.d.ts
+/** The records GitHub Pages needs: its addresses for an apex domain, or an alias of the owner's github.io. */
+export declare function githubPagesRecords(repo: string, domain: string, { apex, www }: ConnectDomainOptions): DnsRecord[];
+//#endregion
+//#region src/setup.d.ts
+interface GitHubSetupOptions {
+  /** For GitHub Enterprise. Defaults to `https://api.github.com`. */
+  apiUrl?: string;
+  /** For GitHub Enterprise. Defaults to `https://github.com`. */
+  webUrl?: string;
+  /** For tests. */
+  fetch?: typeof fetch;
+}
+/**
+ * Links to GitHub's token pages with what creating a site needs: creating the
+ * repository (administration), writing its files and its build setup
+ * (contents and workflows), and turning on GitHub Pages (pages).
+ */
+export declare function githubSetupTokenLinks(webUrl?: string): {
+  fineGrained: string;
+  classic: string;
+};
+/** Signing in to GitHub to create a site's repository, with GitHub Pages if wanted. */
+export declare function githubSetup(options?: GitHubSetupOptions): SetupHost;
+//#endregion
 //#region src/index.d.ts
 export interface GitHubOptions {
   /** The site's repository, as `owner/name`. */
@@ -73,7 +113,9 @@ export interface GitHubOptions {
 export declare function githubTokenLinks(repo: string, webUrl?: string): {
   fineGrained: string;
   classic: string;
+  owner: string;
 };
 /** Sign-in and storage for a site whose repository is on GitHub. */
 export declare function github(options: GitHubOptions): GitHost;
-//#endregion
+//#endregion
+export type { GitHubSetupOptions };