@netlify/spark-ui 1.31.0-alpha.4 → 1.31.0-alpha.6

package/packages/drop-core/types.ts

@@ -11,10 +11,8 @@ export interface ProcessedFile {
 export type Digest = Record<string, string>; // { "/index.html": "<sha1>" }
 
 /**
- * Response body of `POST /api/v1/drop`. Not a canonical Deploy resource —
- * it's a mixed shape carrying both the anonymous site and the initial deploy
- * so the client has everything it needs to upload, poll, and hand off to the
- * user in one round trip.
+ * Response of `POST /api/v1/drop` — a mixed site+deploy shape, everything the
+ * client needs to upload, poll, and hand off in one round trip.
  */
 export interface DropResponse {
   /** site id (UUID) — surfaced to callers so they can build claim links */

package/packages/drop-core/zip.ts

@@ -13,12 +13,7 @@ function escapeTomlString(value: string): string {
     .replace(/\t/g, '\\t');
 }
 
-/**
- * Render inferred settings as a `[build]` table. Only `command` and `publish`
- * are written: everything else (functions directory, plugins, node version)
- * is zero-config on Netlify's side and guessing at it would override detection
- * that is better informed than we are.
- */
+/** Renders a [build] table — command and publish only; everything else is zero-config server-side. */
 export function generateNetlifyToml({ command, publish }: InferredBuildSettings): string {
   return [
     '[build]',
@@ -31,22 +26,14 @@ export function generateNetlifyToml({ command, publish }: InferredBuildSettings)
 export interface ZipOptions {
   /** Filename given to the produced `File`. Shows up as the build's source archive. */
   name?: string;
-  /**
-   * Synthesise a `netlify.toml` `[build]` table from `inferBuildSettings` when the
-   * drop doesn't declare one (default `true`). Set `false` to upload the files
-   * exactly as dropped and let buildbot resolve every setting itself.
-   */
+  /** Synthesise a [build] table when the drop lacks one (default true); false uploads as-dropped. */
   synthesizeNetlifyToml?: boolean;
 }
 
 export interface ZipResult {
   /** The archive, ready to hand to `createBuildFromZip`. */
   file: File;
-  /**
-   * The settings written into `netlify.toml`, or `null` when the archive is a
-   * faithful copy of the drop — either because it already declared a `[build]`
-   * table, or because nothing could be inferred with confidence.
-   */
+  /** Settings written into netlify.toml, or null when the archive is a faithful copy. */
   buildSettings: InferredBuildSettings | null;
 }
 
@@ -58,20 +45,10 @@ function toBytes(content: ArrayBuffer): Uint8Array {
 }
 
 /**
- * Zip an already-read file set into the source archive that
- * `POST /sites/{id}/builds` expects.
- *
- * The input is the same root-normalized `ProcessedFile[]` the static deploy path
- * uses (see `readFiles`), so junk — dotfiles, `node_modules`, macOS metadata — is
- * already gone and paths sit at the deploy root. Output directories (`dist/`,
- * `build/`) are deliberately *not* stripped: buildbot regenerates them when
- * there's a build command, and a drop whose `netlify.toml` publishes a committed
- * directory without a command would break if we removed it.
- *
- * When the drop needs a build but declares no `[build]` table, an inferred one is
- * written in (appended to an existing `netlify.toml`, or created if there is
- * none) so buildbot doesn't publish the project's source. See
- * `inferBuildSettings` for how conservative that inference is.
+ * Zip a read file set into the archive `POST /sites/{id}/builds` expects.
+ * Junk is already gone (readFiles); dist/build are deliberately kept — a drop
+ * publishing a committed directory without a command would break without them.
+ * A [build] table is synthesised when missing (appended, so redirects survive).
  */
 export async function zipFiles(
   files: ProcessedFile[],