@wix/mcp 1.0.93 → 1.0.95

package/build/dts/api-call/upload-headless-website-files.d.ts

@@ -0,0 +1,118 @@
+import { type SiteFile } from './site-files.js';
+import { WixMcpServer } from '../wix-mcp-server.js';
+import { type McpAuthenticationStrategy } from '../auth/index.js';
+export declare const UPLOAD_HEADLESS_WEBSITE_FILES_TOOL_NAME = "UploadHeadlessWebsiteFiles";
+/** The largest site zip `bundle-upload-url` presigns (headless-business-setup's MAX_BUNDLE_BYTES). */
+export declare const MAX_BUNDLE_BYTES: number;
+/**
+ * Attribution the drop endpoint stamps on its upload BI event (`source` from
+ * `campaign`, `agent` from `agent`, both ≤ 64 chars) — the same parser as the
+ * anonymous route, and what the headless Drop dashboard keys its "MCP API"
+ * entry point on. `agent` is the MCP client's name as a lowercase slug.
+ */
+export declare function dropAttribution(clientName?: string): string;
+export interface UploadHeadlessWebsiteFilesOptions {
+    authStrategy: McpAuthenticationStrategy;
+    toolDescriptions?: Record<string, string>;
+    /** Test seam; defaults to the global fetch. */
+    fetchImpl?: typeof fetch;
+    /** Client identity for drop attribution when the server cannot tell (the toolkit's configured name). */
+    clientName?: string;
+}
+export declare const UPLOAD_HEADLESS_WEBSITE_FILES_PARAM_DESCRIPTIONS: {
+    readonly files: "The site files as text, so file bytes never pass through a code string. Sections delimited by a line `=== FILE: <path> ===` (text, raw) or `=== FILE: <path> base64 ===` (binary, base64); `<path>` is relative to the site root; a static site must include `index.html`. Use base64 for small binaries (icons, logos, fonts); large images/video belong behind a URL in the HTML, not in the bundle. Optional when `attachments` carries the files. A Wix Astro build (`.wix/build-metadata.json` and `dist/` as `astro build` with the Wix hosting adapter wrote them, zipped from the project root) needs no `index.html`: it is released to the site's Wix hosting instead of dropped, and the project's other files in the upload are stored as its source when the site's repository accepts it.";
+    readonly attachments: string;
+    readonly prepare: "Phase one of the two-call upload of a Wix Astro build, for a shell that reaches the internet and no file handle (a sandbox whose network is limited to a few hosts cannot upload to the URLs): zip the build first, then `true` with its `size` returns presigned upload URLs for the build zip and, when the site's repository takes it, the project source zip, as `curl` commands to run verbatim, with the exact second call. The two calls: {siteId, prepare: true, size}, then {siteId, uploadKey, sourceUploadId?, expectedHeadRevisionId?, releaseNotes?}. No `files`, `attachments`, `uploadKey` or `sourceUploadId` on the first; `expectedHeadRevisionId` and `releaseNotes` given on the first are echoed into the second. Not for a static site: send its files in `files` or `attachments`, or drop them as the StartDeployWebsite recipe shows.";
+    readonly size: "Phase one, with `prepare: true` only, and required there: the build zip's length in bytes (`wc -c < build.zip`), 1 to 104857600 (100 MB). The upload URL takes a body of exactly this length; a zip changed after the prepare needs a new prepare.";
+    readonly uploadKey: "Phase two of the two-call upload: the `uploadKey` the `prepare` call returned, after the build zip was PUT to its URL. Releases that build to the site: {siteId, uploadKey, sourceUploadId?, expectedHeadRevisionId?, releaseNotes?}. Excludes `files` and `attachments`.";
+    readonly sourceUploadId: "Phase two: the `sourceUploadId` the `prepare` call returned, after the source zip was PUT to its URL. Stores the project source with the release. Needs `uploadKey`; leave it out when the prepare returned no source upload.";
+    readonly expectedHeadRevisionId: "The repository revision your project started from, so the source replaces only that and a commit made since (another chat, a Dev Machine) is never dropped unseen: the revision you downloaded the project at; for a project started here, the `headRevisionId` the `prepare` call returned. Leave it out only for a repository with nothing in it yet. Goes with `uploadKey`, or with `files`/`attachments` holding a build.";
+    readonly releaseNotes: "Optional: one line on what this release changes, at most 200 characters, kept with the deployment of a Wix Astro build, whether it comes in `files`/`attachments` or as the second call with `uploadKey` (given on the `prepare` call it is echoed into the second). A static drop keeps no notes.";
+    readonly siteId: "The metaSiteId of the Wix Headless site to upload into: the one returned by the provision call of the StartDeployWebsite recipe for a new site, or of a site deployed earlier to replace its files. Every upload replaces the whole file set, so send all files; the URL stays the same. A build released here replaces static pages dropped earlier, at the same URL.";
+    readonly calledStartDeployWebsite: "Whether you called StartDeployWebsite earlier in this conversation and are following the recipe it returned. Answer truthfully; it is recorded, not checked.";
+    readonly agentIdentity: "Which agent or product you are, which model if you know it, and the harness you run in. No personal data: no names, emails, phones, passwords, keys or local paths.";
+    readonly reason: "One sentence: the user request that led here and what is being published. No personal data: no names, emails, phones, passwords, keys or local paths.";
+};
+export interface DropResult {
+    metaSiteId: string;
+    siteUrl?: string;
+    uploadId?: string;
+    files: string[];
+}
+export declare function formatDropResult(r: DropResult): string;
+/** One presigned PUT: where the zip goes and the headers the storage requires on it. */
+interface PresignedPut {
+    putUrl: string;
+    headers?: Record<string, string>;
+    expiresAt?: string;
+}
+/** `POST /{siteId}/bundle-upload-url`: the site half, plus the Code Store half when the site has a source repository. */
+export interface BundleUploadUrls extends PresignedPut {
+    uploadKey: string;
+    source?: PresignedPut & {
+        uploadId: string;
+        headRevisionId?: string;
+    };
+}
+/** `POST /{siteId}/release-bundle`. */
+/**
+ * What the tool BI event records about an upload, beside the result text: the path it
+ * took (`drop` static pages, `build` an attached Astro build over the bundle routes,
+ * `prepare` and `release-bundle` the two calls) and whether the source was stored.
+ */
+export interface UploadBiFields {
+    path: 'drop' | 'build' | 'prepare' | 'release-bundle';
+    sourceOffered?: boolean;
+    sourceStored?: boolean;
+    sourceFiles?: number;
+    emptyStaticsDropped?: number;
+    files?: number;
+}
+export interface BundleReleaseResult {
+    deploymentId?: string;
+    siteUrl?: string;
+    revision?: {
+        id?: string;
+    };
+}
+/** The prepare reply: what the agent runs, verbatim, and the exact second call. */
+export declare function formatPrepareResult(siteId: string, urls: BundleUploadUrls, size?: number, given?: {
+    expectedHeadRevisionId?: string;
+    releaseNotes?: string;
+}): string;
+/** The release-bundle reply, for both the two-call form and a build uploaded as files. */
+export declare function formatBundleReleaseResult(siteId: string, r: BundleReleaseResult, notes?: string[]): string;
+/**
+ * How the agent starts over: in the two-call form a new `prepare`, after a build
+ * uploaded as files the same call again (the tool asks for new URLs itself).
+ */
+export type BundleRetry = 'prepare' | 'resend';
+/** The bundle-upload-url route's errors, as the agent should act on them. */
+export declare function describeBundleUploadUrlError(err: unknown): string;
+/** The deployment label the service keeps is 200 characters; longer notes are cut, not refused. */
+export declare const RELEASE_NOTES_MAX_CHARS = 200;
+export declare function releaseNotesForService(notes: string): string;
+/** The release-bundle route's errors, as the agent should act on them. */
+export declare function describeBundleReleaseError(err: unknown, uploadKey: string, retry?: BundleRetry): string;
+/**
+ * A build that came as files, released over the bundle routes: an upload URL for the
+ * site zip's size, the zip PUT there, the source zip PUT to the repository's URL when
+ * the service offered one and the upload holds source files, then the release with
+ * the ids. `onStaged` hears the uploadKey once the site zip is staged.
+ */
+export declare function releaseBuildByUrl(o: {
+    siteId: string;
+    siteZip: Uint8Array;
+    sourceFiles: SiteFile[];
+    siteHeaders: Record<string, string>;
+    fetchImpl: typeof fetch;
+    /** The revision the agent's project started from; never the head read here, which would replace work committed since. */
+    expectedHeadRevisionId?: string;
+    /** One line kept with the deployment; cut to the service's limit. */
+    releaseNotes?: string;
+    onStaged?: (uploadKey: string) => void;
+    log?: (line: string) => void;
+}): Promise<BundleReleaseResult>;
+export declare function addUploadHeadlessWebsiteFilesTool(server: WixMcpServer, options: UploadHeadlessWebsiteFilesOptions): void;
+export {};
+//# sourceMappingURL=upload-headless-website-files.d.ts.map