palbase 0.39.0 → 0.40.0

package/types/internal/src/modules/machines.d.ts

@@ -1548,6 +1548,10 @@ export type Site = {
      */
     move_note?: string;
     server: SiteServer;
+    /**
+     * Its previews — its pull requests' and its branches' — are its team's alone (Vercel's Deployment Protection; true by default): a visitor signs in with Studio, or holds one of its share links. What a protected preview answers is kept by no CDN.
+     */
+    previews_protected: boolean;
 };
 /**
  * The release a site serves; none before its first.
@@ -1599,6 +1603,10 @@ export type SiteCreate = {
      */
     environment?: string;
     server?: SiteServer;
+    /**
+     * Whether its previews are its team's alone; none is true.
+     */
+    previews_protected?: boolean;
 };
 /**
  * What to change of a site; a field left out is unchanged — in build too: each of its fields given changes alone, an empty one is found in the source again, and env, when given, is all of the build's settings from then on.
@@ -1616,6 +1624,10 @@ export type SiteUpdate = {
      */
     preview_forks?: boolean;
     server?: SiteServer;
+    /**
+     * Whether its previews are its team's alone from now on.
+     */
+    previews_protected?: boolean;
 };
 /**
  * One upload of a site's files.
@@ -1814,6 +1826,10 @@ export type Preview = {
  */
 export type PreviewList = {
     previews: Preview[];
+    /**
+     * A site's branches' previews, newest first: none of a machine's.
+     */
+    branches?: BranchPreview[];
 };
 /**
  * One record of a domain's DNS.
@@ -2030,6 +2046,100 @@ export type SiteServer = ({
     machine: string;
     paths: string[];
 }) | null;
+/**
+ * What a directory of a repository is found to be, as Vercel's import finds it: a static web app (`static`: a site, its build in `build`), a web app that runs on a server (`server`: a machine, and a site with no files of its own whose server it is — the site's address and domains), or a backend (`backend`: a machine). A proposal: each of it is changed before the project is made; nothing is made here.
+ */
+export type ProjectDetection = {
+    repository: string;
+    branch: string;
+    path: string;
+    /**
+     * The branch's head it was read at.
+     */
+    commit: string;
+    kind: "static" | "server" | "backend";
+    /**
+     * next, nuxt, sveltekit, react-router, astro, vite, gatsby, docusaurus, vitepress, create-react-app, angular, vue, parcel — or empty for none known.
+     */
+    framework: string;
+    framework_name: string;
+    /**
+     * What told it.
+     */
+    why: string;
+    build?: SiteBuildSettings;
+    /**
+     * The Node.js line a static web app's build runs (its .nvmrc, .node-version or engines.node; 24 when none says).
+     */
+    node?: number;
+    /**
+     * A server or backend is built from its own Dockerfile; without one, its language is found as it builds.
+     */
+    dockerfile: boolean;
+    warnings: string[];
+};
+/**
+ * A site's preview of one of its repository's branches: a push to a branch other than its own, while it previews, builds that branch's head into a release of its own, answered at <name>-git-<branch>-<ref> until the branch is deleted or a month goes by without a push.
+ */
+export type BranchPreview = {
+    branch: string;
+    commit: string;
+    url: string;
+    state: "building" | "ready" | "failed" | "closed";
+    created_at: string;
+    updated_at: string;
+    closed_at: string | null;
+};
+/**
+ * Where a member goes with a pass: the https address of one of the site's open previews.
+ */
+export type PreviewPassAsk = {
+    to: string;
+};
+/**
+ * A member's pass to a site's previews, 12 hours: url is the preview's address with the pass in its query once (the edge moves it into a cookie of the preview's own host).
+ */
+export type PreviewPass = {
+    url: string;
+    expires_at: string;
+};
+/**
+ * A share link to make.
+ */
+export type PreviewLinkCreate = {
+    name?: string;
+    /**
+     * Days it opens the previews; 7 when none.
+     */
+    days?: number;
+};
+/**
+ * A share link of a site's previews: its token — given once, as it is made — opens any of them, added to its address as ?_palbase_pass=<token>. Deleting it closes them to it at once.
+ */
+export type PreviewLink = {
+    id: string;
+    name: string;
+    token?: string;
+    made_by: string;
+    expires_at: string;
+    created_at: string;
+};
+/**
+ * A site's share links that have not ended, newest first: 20 at most.
+ */
+export type PreviewLinkList = {
+    links: PreviewLinkListed[];
+};
+/**
+ * A share link as its site lists it — never its token.
+ */
+export type PreviewLinkListed = {
+    id: string;
+    name: string;
+    made_by: string;
+    expires_at: string;
+    created_at: string;
+};
 /** Palbase Machines */
 export declare function client(t: Transport): {
     /**
@@ -2787,7 +2897,7 @@ export declare function client(t: Transport): {
     /**
      * Finish a release
      *
-     * Finishes a release whose files are all kept — refused, naming them, while one is missing — and the site serves it at once. Finishing one finished before has the site serve it again.
+     * Finishes a release whose files are all kept — refused, naming them, while one is missing — and the site serves it at once. Finishing one finished before has the site serve it again. A release whose `/_redirects` or `/_headers` does not hold is refused (400 `invalid_rules`), the description naming the file, each line and why.
      */
     finishSiteRelease(input: {
         path: {
@@ -3069,5 +3179,65 @@ export declare function client(t: Transport): {
         }; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
         signal?: AbortSignal;
     }): Promise<Reply<204, undefined>>;
+    /**
+     * Tell what a repository's directory is
+     *
+     * Reads a directory of a repository one of the project's installations reaches, at its branch's head — its package.json, its framework's configuration, its lockfiles, its Node.js version file — and says what it is and how it is built, as Vercel's import does. Nothing is made: a static web app is then opened as a site (POST /sites, with this build), a web app that runs on a server as a machine (POST /machines) and a site whose server it is (POST /sites with `server`), a backend as a machine. `project_not_detected` (422) when nothing there says what it is.
+     */
+    detectProject(input: {
+        query: {
+            repository: string; /** Its branch, read at its head. */
+            branch: string; /** The directory in the repository; none for its root. */
+            path?: string;
+        }; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
+        signal?: AbortSignal;
+    }): Promise<Reply<200, ProjectDetection>>;
+    /**
+     * Give a member a pass to a preview
+     *
+     * Makes a pass to the site's previews for the caller — Studio asks for one as a signed-in member comes from a protected preview (the edge sent them there) — and answers where to go with it: `to`, one of the site's open previews' addresses, with the pass in its query once. 12 hours.
+     */
+    createPreviewPass(input: {
+        path: {
+            name: string;
+        };
+        body: PreviewPassAsk; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
+        signal?: AbortSignal;
+    }): Promise<Reply<201, PreviewPass>>;
+    /**
+     * List a site's share links
+     *
+     * The site's share links that have not ended, newest first — never their tokens.
+     */
+    listPreviewLinks(input: {
+        path: {
+            name: string;
+        }; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
+        signal?: AbortSignal;
+    }): Promise<Reply<200, PreviewLinkList>>;
+    /**
+     * Make a share link of a site's previews
+     *
+     * Makes a link that opens the site's protected previews to anyone holding it, for 1 to 30 days (7 when none): its token is in the answer alone. 20 at most (`too_many_links`, 409).
+     */
+    createPreviewLink(input: {
+        path: {
+            name: string;
+        };
+        body: PreviewLinkCreate; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
+        signal?: AbortSignal;
+    }): Promise<Reply<201, PreviewLink>>;
+    /**
+     * Delete a share link
+     *
+     * Deletes a share link: the site's previews close to it at once.
+     */
+    deletePreviewLink(input: {
+        path: {
+            name: string; /** The share link's id. */
+            link: string;
+        }; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
+        signal?: AbortSignal;
+    }): Promise<Reply<204, undefined>>;
 };
 export type Client = ReturnType<typeof client>;