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

package/packages/drop-core/errors.ts

@@ -6,6 +6,8 @@
  * deployed as a one-asset site (matches react-ui).
  */
 export class UnsupportedDropError extends Error {
+  readonly code = 'unsupported-drop';
+
   constructor() {
     super('unsupported single file');
     this.name = 'UnsupportedDropError';
@@ -21,14 +23,30 @@ export class UnsupportedDropError extends Error {
  * through login/signup and have them drop again.
  */
 export class NotAuthenticatedError extends Error {
+  readonly code = 'not-authenticated';
+
   constructor(message = 'not authenticated') {
     super(message);
     this.name = 'NotAuthenticatedError';
   }
 }
 
+/**
+ * Whether an error is the pre-mutation "no session" signal, however it
+ * traveled. This package ships as both raw TypeScript (`./components`) and
+ * compiled dist (`./preact`, `./drop-core`), so two copies of the class can
+ * coexist in one app and defeat `instanceof` — the `code` brand is the
+ * copy-proof fallback. Control flow that decides whether an anonymous retry
+ * is safe must use this, never a bare `instanceof`.
+ */
+export function isNotAuthenticatedError(err: unknown): err is NotAuthenticatedError {
+  if (err instanceof NotAuthenticatedError) return true;
+  return err instanceof Error && (err as { code?: string }).code === 'not-authenticated';
+}
+
 /** `POST …/sites` failed, so there is nothing to build into. Carries the HTTP status. */
 export class SiteCreateError extends Error {
+  readonly code = 'site-create-failed';
   status?: number;
 
   constructor(status?: number) {
@@ -43,6 +61,7 @@ export class SiteCreateError extends Error {
  * started. Distinct from `BuildFailedError`, which is a build that ran and broke.
  */
 export class BuildCreateError extends Error {
+  readonly code = 'build-create-failed';
   status?: number;
 
   constructor(status?: number) {
@@ -59,6 +78,8 @@ export class BuildCreateError extends Error {
  * it is surfaced to the user rather than swallowed.
  */
 export class BuildFailedError extends Error {
+  readonly code = 'build-failed';
+
   constructor(public reason?: string) {
     super(reason ? `build failed: ${reason}` : 'build failed');
     this.name = 'BuildFailedError';
@@ -67,12 +88,37 @@ export class BuildFailedError extends Error {
 
 /** The build hadn't settled before the poller gave up. The build itself may still finish. */
 export class BuildTimeoutError extends Error {
+  readonly code = 'build-timeout';
+
   constructor() {
     super('Build did not finish in time');
     this.name = 'BuildTimeoutError';
   }
 }
 
+/**
+ * A static deploy ran and ended in `error`/`rejected`. Like a build failure,
+ * the API's `error_message` is the actionable part, so it travels on the error.
+ */
+export class DeployFailedError extends Error {
+  readonly code = 'deploy-failed';
+
+  constructor(public reason?: string) {
+    super(reason ? `deploy failed: ${reason}` : 'deploy failed');
+    this.name = 'DeployFailedError';
+  }
+}
+
+/** The deploy hadn't gone ready before the poller gave up. It may still finish. */
+export class DeployTimeoutError extends Error {
+  readonly code = 'deploy-timeout';
+
+  constructor() {
+    super('Deploy did not become ready in time');
+    this.name = 'DeployTimeoutError';
+  }
+}
+
 /**
  * Turn a raw deploy failure into copy a non-technical user can act on.
  * The original message is still tracked via analytics — this is only for display.
@@ -80,31 +126,42 @@ export class BuildTimeoutError extends Error {
 export function humanizeDropError(err: unknown): string {
   if (!(err instanceof Error)) return 'Something went wrong. Please try again.';
 
-  if (err instanceof UnsupportedDropError) {
+  // Match on the `code` brand rather than instanceof: raw-TS and dist copies
+  // of these classes can coexist (see isNotAuthenticatedError).
+  const code = (err as { code?: string }).code;
+
+  if (code === 'unsupported-drop') {
     return 'To deploy, drop a folder or a .zip file — or a single HTML page.';
   }
 
-  if (err instanceof NotAuthenticatedError) {
+  if (code === 'not-authenticated') {
     return 'Please log in to Netlify to deploy this project, then try again.';
   }
 
-  if (err instanceof SiteCreateError) {
+  if (code === 'site-create-failed') {
     return "We couldn't create a project for this build. Please try again.";
   }
 
-  // The build's own error message is the only actionable part of a build
-  // failure, so pass it straight through instead of a generic apology.
-  if (err instanceof BuildFailedError) {
-    return err.reason
-      ? `Your build failed: ${err.reason}`
+  // The failure's own error message is the only actionable part, so pass it
+  // straight through instead of a generic apology.
+  if (code === 'build-failed') {
+    const reason = (err as BuildFailedError).reason;
+    return reason
+      ? `Your build failed: ${reason}`
       : 'Your build failed. Check your build settings and try again.';
   }
+  if (code === 'deploy-failed') {
+    const reason = (err as DeployFailedError).reason;
+    return reason
+      ? `Your deploy failed: ${reason}`
+      : 'Your deploy failed. Please try again.';
+  }
 
-  if (err instanceof BuildTimeoutError) {
+  if (code === 'build-timeout') {
     return 'Your build is taking longer than expected. It may still finish — check your Netlify dashboard.';
   }
 
-  if (err.message === 'Deploy did not become ready in time') {
+  if (code === 'deploy-timeout') {
     return 'Your site is taking longer than expected to go live. Please try again in a moment.';
   }
   // fetch() rejects with a TypeError when the network is unreachable (offline, DNS, CORS, etc).

package/packages/drop-core/index.ts

@@ -1,14 +1,44 @@
+/**
+ * The public surface of drop-core — nothing is public unless named here.
+ * `export *` is reserved for the three modules that are contracts in their
+ * entirety: types, errors, and the analytics event map.
+ */
+
 export * from './types';
-export * from './digest';
-export * from './readFiles';
-export * from './fileTypes';
-export * from './detectBuild';
-export * from './client';
-export * from './authedApi';
-export * from './authedDropClient';
-export * from './buildClient';
-export * from './zip';
-export * from './buildStash';
-export * from './deploy';
 export * from './errors';
 export * from './analytics';
+
+// Reading a drop into deployable files
+export {
+  getSingleNonIndexHtmlFileName,
+  hasMultipleHtmlFilesWithoutIndex,
+  readDataTransfer,
+  readFileList,
+  renameSingleNonIndexHtmlToIndex,
+} from './readFiles';
+export { getFileTypes } from './fileTypes';
+
+// Build detection and archive synthesis
+export { detectBuild, inferBuildSettings } from './detectBuild';
+export type { BuildDetection, BuildReason, InferredBuildSettings } from './detectBuild';
+export { zipFiles } from './zip';
+export type { ZipOptions, ZipResult } from './zip';
+
+// Deploy clients — anonymous (claim flow) and authenticated (into the account)
+export { AnonymousDropClient } from './client';
+export type { DropClient } from './client';
+export { AuthenticatedDropClient } from './authedDropClient';
+export type { AuthenticatedDropClientConfig } from './authedDropClient';
+export { AuthenticatedBuildClient } from './buildClient';
+export type { AuthenticatedBuildClientConfig, BuildClient, BuildResponse } from './buildClient';
+
+// Deploy orchestration
+export { deployBuild, deployFiles, deployZippedBuild } from './deploy';
+export type { BuildDeployOptions, BuildDeployResult, DeployOptions } from './deploy';
+
+// Carrying a build drop across the signup round-trip
+export { clearDropStash, hasDropStashMarker, loadDropStash, saveDropStash } from './buildStash';
+export type { DropBuildStash } from './buildStash';
+
+// Documented defaults consumers may want to reference
+export { DEFAULT_API_BASE, DEFAULT_PROXY_BASE, UPLOAD_RETRY_DELAYS_MS } from './constants';

package/packages/drop-core/readFiles.test.ts

@@ -81,7 +81,6 @@ describe('readFileList', () => {
     const files = await readFileList(
       asFileList([new File([bytes.buffer.slice(0) as ArrayBuffer], 'my-site.zip')])
     );
-    // Junk gone, common "my-site/" root stripped.
     expect(files.map(f => f.path).sort()).toEqual(['/css/site.css', '/index.html']);
   });
 });