@goodfellow-cms/gitlab 0.1.0 → 0.3.0

package/README.md

@@ -8,9 +8,9 @@ import { gitlab } from "@goodfellow-cms/gitlab";
 export default defineConfig({ blocks, backend: gitlab({ project: "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, PagesDomains, SetupHost, SiteDrafts, SiteEditors, SiteUpdates, StorageLike, WriteOptions } from "@goodfellow-cms/core";
 //#region src/api.d.ts
 interface ApiOptions {
   /** The API root, such as `https://gitlab.com/api/v4`. */
@@ -27,6 +27,11 @@ interface GitLabBackendOptions {
  */
 export declare class GitLabBackend implements GitBackend {
   readonly user: GitUser;
+  readonly pages: PagesDomains;
+  readonly editors: SiteEditors;
+  readonly updates: SiteUpdates;
+  readonly drafts: SiteDrafts;
+  private readonly options;
   private readonly api;
   private readonly project;
   private readonly branch;
@@ -35,6 +40,8 @@ export declare class GitLabBackend implements GitBackend {
   private readonly trees;
   private readonly blobs;
   constructor(options: GitLabBackendOptions);
+  /** Drafts on branches of the project, with merge requests for review. */
+  private draftHost;
   private repo;
   revision(): Promise<string>;
   /** Every file in one folder at a commit, page by page. */
@@ -43,18 +50,26 @@ export declare class GitLabBackend implements GitBackend {
   private tree;
   private currentTree;
   read(path: string): Promise<string | undefined>;
+  /** Reads many text files in a few GraphQL requests rather than one request each. */
+  readFiles(paths: string[]): Promise<Map<string, string>>;
   readBytes(path: string): Promise<Uint8Array | undefined>;
   list(dir: string): Promise<string[]>;
+  /** GitLab's tree doesn't say how large files are, so they're asked for with GraphQL, in batches. */
+  fileSizes(dir: string): Promise<Map<string, number>>;
   private lastCommitFor;
   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 commit's pipeline and external statuses (GitLab Pages jobs, or
    * Vercel). Before any exist, the site counts as building if it has pipelines.
    */
   deployStatus(revision: string): Promise<DeployStatus>;
+  /** Why a commit's pipeline failed: the failed job's reason, and its log for which command failed and why. */
+  private jobProblem;
   signOut(): void;
 }
 //#endregion
@@ -62,6 +77,37 @@ export declare class GitLabBackend implements GitBackend {
 /** The admin panel's address, with a trailing slash so it always matches the redirect URI registered with GitLab. */
 export declare function redirectUri(href: string): string;
 //#endregion
+//#region src/pages.d.ts
+/**
+ * The records GitLab Pages needs: its address for an apex domain, or an alias
+ * of the namespace's gitlab.io otherwise, and a TXT record per domain that
+ * proves it's the owner's, with the codes GitLab gave.
+ */
+export declare function gitlabPagesRecords(project: string, domain: string, options: ConnectDomainOptions, codes: Record<string, string>): DnsRecord[];
+//#endregion
+//#region src/setup.d.ts
+interface GitLabSetupOptions {
+  /** For self-managed GitLab. Defaults to `https://gitlab.com`. */
+  url?: string;
+  /**
+   * The Application ID of an OAuth application for the setup page (not
+   * confidential, scope `api`, redirect URI the page's address). Enables
+   * "Sign in with GitLab". Without it, people sign in with a token.
+   */
+  clientId?: string;
+  /** For tests. */
+  fetch?: typeof fetch;
+  /** For tests. */
+  storage?: {
+    local?: StorageLike;
+    session?: StorageLike;
+  };
+  /** For tests. */
+  location?: BrowserLocation;
+}
+/** Signing in to GitLab to create a site's project, with GitLab Pages if wanted. */
+export declare function gitlabSetup(options?: GitLabSetupOptions): SetupHost;
+//#endregion
 //#region src/index.d.ts
 /** The page's address and how to change it. Replaceable in tests. */
 export interface BrowserLocation {
@@ -96,4 +142,5 @@ export interface GitLabOptions {
 }
 /** Sign-in and storage for a site whose repository is on GitLab. */
 export declare function gitlab(options: GitLabOptions): GitHost;
-//#endregion
+//#endregion
+export type { GitLabSetupOptions };