@shipstatic/ship 3.4.0-beta.16 → 3.4.0-beta.18

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/SKILL.md CHANGED
@@ -116,7 +116,7 @@ Visitors get an unlock page until they enter the password. Length: 6–128 chara
116
116
 
117
117
  ### Client-side routing
118
118
 
119
- A deployment whose only page is `index.html` serves it for every missing path, so a React, Vue, Svelte or Angular build works on its routes with nothing to configure. An app that ships other HTML files beside its shell declares the route itself: a `ship.json` rewrite from `/(.*)` to `/index.html`, the one the ship.json docs show. Your own rewrites run ahead of either. A root `404.html` of your own turns the automatic route off and is served for a missing path your rewrites do not claim. Every deployment states its default as `fallback`: the page declared for a missing path, or `null` when none is declared, so check it on the deploy response and add the rewrite when an app reads `null`.
119
+ A deployment whose only page is `index.html` serves it for every missing path, so a React, Vue, Svelte or Angular build works on its routes with nothing to configure. An app that ships other HTML files beside its shell declares the route itself: a `ship.json` rewrite from `/(.*)` to `/index.html`, the one the ship.json docs show. One exception needs nothing: a React Router build that prerenders with `ssr: false` leaves its shell at `__spa-fallback.html`, and that file is served for every missing path (do not add a rewrite to `/index.html` there; it would serve the prerendered home page). Your own rewrites run ahead of either. A root `404.html` of your own turns the automatic route off and is served for a missing path your rewrites do not claim. Every deployment states its default as `fallback`: the page declared for a missing path, or `null` when none is declared, so check it on the deploy response and add the rewrite when an app reads `null`.
120
120
 
121
121
  ## Authentication
122
122
 
@@ -5,7 +5,7 @@ Their copyright notices travel with that copy, and are reproduced here in
5
5
  full. This file is GENERATED from the build's own metafile — edit the
6
6
  bundle, not this list.
7
7
 
8
- ## @shipstatic/types 3.8.0-beta.12
8
+ ## @shipstatic/types 3.8.0-beta.13
9
9
 
10
10
  License: MIT
11
11
 
package/dist/browser.d.ts CHANGED
@@ -117,12 +117,16 @@ interface Deployment {
117
117
  /** Whether deployment has a password set */
118
118
  readonly password: boolean;
119
119
  /**
120
- * The page every missing path opens, when the deployment's rewrites end in
121
- * a catch-all to one: the platform's single-page preset (a deployment whose
122
- * only page is `index.html`), or a catch-all the author wrote. `null` when
123
- * a missing path is a 404, which is what an application with pages beside
124
- * its shell gets until its author declares the route. Absent from an API
125
- * older than the field, as every new field on an existing entity is.
120
+ * The default page the deployment declares for a missing path: the
121
+ * platform's single-page preset (a deployment whose only page is
122
+ * `index.html`, or React Router's `__spa-fallback.html`), or the target of
123
+ * the author's own catch-all (`/(.*)` or `/:path*`) to one file. The
124
+ * author's other rules still run ahead of it. `null` when no default is
125
+ * declared, which is what an application with pages beside its shell gets
126
+ * until its author declares the route. Carried by a deployment, not by a
127
+ * list of deployments; omitted when the deployment's artifact cannot be
128
+ * read, and by an API older than the field. Absent is not `null`: `null`
129
+ * is a declaration of none.
126
130
  */
127
131
  readonly fallback?: string | null;
128
132
  /** Labels for categorization and filtering (lowercase, alphanumeric with separators). Always present, empty array when none. */