vite-plugin-cross-origin-storage 1.9.0 → 2.0.1

package/LICENSE

@@ -1,201 +1,21 @@
-                                 Apache License
-                           Version 2.0, January 2004
-                        http://www.apache.org/licenses/
-
-   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
-
-   1. Definitions.
-
-      "License" shall mean the terms and conditions for use, reproduction,
-      and distribution as defined by Sections 1 through 9 of this document.
-
-      "Licensor" shall mean the copyright owner or entity authorized by
-      the copyright owner that is granting the License.
-
-      "Legal Entity" shall mean the union of the acting entity and all
-      other entities that control, are controlled by, or are under common
-      control with that entity. For the purposes of this definition,
-      "control" means (i) the power, direct or indirect, to cause the
-      direction or management of such entity, whether by contract or
-      otherwise, or (ii) ownership of fifty percent (50%) or more of the
-      outstanding shares, or (iii) beneficial ownership of such entity.
-
-      "You" (or "Your") shall mean an individual or Legal Entity
-      exercising permissions granted by this License.
-
-      "Source" form shall mean the preferred form for making modifications,
-      including but not limited to software source code, documentation
-      source, and configuration files.
-
-      "Object" form shall mean any form resulting from mechanical
-      transformation or translation of a Source form, including but
-      not limited to compiled object code, generated documentation,
-      and conversions to other media types.
-
-      "Work" shall mean the work of authorship, whether in Source or
-      Object form, made available under the License, as indicated by a
-      copyright notice that is included in or attached to the work
-      (an example is provided in the Appendix below).
-
-      "Derivative Works" shall mean any work, whether in Source or Object
-      form, that is based on (or derived from) the Work and for which the
-      editorial revisions, annotations, elaborations, or other modifications
-      represent, as a whole, an original work of authorship. For the purposes
-      of this License, Derivative Works shall not include works that remain
-      separable from, or merely link (or bind by name) to the interfaces of,
-      the Work and Derivative Works thereof.
-
-      "Contribution" shall mean any work of authorship, including
-      the original version of the Work and any modifications or additions
-      to that Work or Derivative Works thereof, that is intentionally
-      submitted to Licensor for inclusion in the Work by the copyright owner
-      or by an individual or Legal Entity authorized to submit on behalf of
-      the copyright owner. For the purposes of this definition, "submitted"
-      means any form of electronic, verbal, or written communication sent
-      to the Licensor or its representatives, including but not limited to
-      communication on electronic mailing lists, source code control systems,
-      and issue tracking systems that are managed by, or on behalf of, the
-      Licensor for the purpose of discussing and improving the Work, but
-      excluding communication that is conspicuously marked or otherwise
-      designated in writing by the copyright owner as "Not a Contribution."
-
-      "Contributor" shall mean Licensor and any individual or Legal Entity
-      on behalf of whom a Contribution has been received by Licensor and
-      subsequently incorporated within the Work.
-
-   2. Grant of Copyright License. Subject to the terms and conditions of
-      this License, each Contributor hereby grants to You a perpetual,
-      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-      copyright license to reproduce, prepare Derivative Works of,
-      publicly display, publicly perform, sublicense, and distribute the
-      Work and such Derivative Works in Source or Object form.
-
-   3. Grant of Patent License. Subject to the terms and conditions of
-      this License, each Contributor hereby grants to You a perpetual,
-      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-      (except as stated in this section) patent license to make, have made,
-      use, offer to sell, sell, import, and otherwise transfer the Work,
-      where such license applies only to those patent claims licensable
-      by such Contributor that are necessarily infringed by their
-      Contribution(s) alone or by combination of their Contribution(s)
-      with the Work to which such Contribution(s) was submitted. If You
-      institute patent litigation against any entity (including a
-      cross-claim or counterclaim in a lawsuit) alleging that the Work
-      or a Contribution incorporated within the Work constitutes direct
-      or contributory patent infringement, then any patent licenses
-      granted to You under this License for that Work shall terminate
-      as of the date such litigation is filed.
-
-   4. Redistribution. You may reproduce and distribute copies of the
-      Work or Derivative Works thereof in any medium, with or without
-      modifications, and in Source or Object form, provided that You
-      meet the following conditions:
-
-      (a) You must give any other recipients of the Work or
-          Derivative Works a copy of this License; and
-
-      (b) You must cause any modified files to carry prominent notices
-          stating that You changed the files; and
-
-      (c) You must retain, in the Source form of any Derivative Works
-          that You distribute, all copyright, patent, trademark, and
-          attribution notices from the Source form of the Work,
-          excluding those notices that do not pertain to any part of
-          the Derivative Works; and
-
-      (d) If the Work includes a "NOTICE" text file as part of its
-          distribution, then any Derivative Works that You distribute must
-          include a readable copy of the attribution notices contained
-          within such NOTICE file, excluding those notices that do not
-          pertain to any part of the Derivative Works, in at least one
-          of the following places: within a NOTICE text file distributed
-          as part of the Derivative Works; within the Source form or
-          documentation, if provided along with the Derivative Works; or,
-          within a display generated by the Derivative Works, if and
-          wherever such third-party notices normally appear. The contents
-          of the NOTICE file are for informational purposes only and
-          do not modify the License. You may add Your own attribution
-          notices within Derivative Works that You distribute, alongside
-          or as an addendum to the NOTICE text from the Work, provided
-          that such additional attribution notices cannot be construed
-          as modifying the License.
-
-      You may add Your own copyright statement to Your modifications and
-      may provide additional or different license terms and conditions
-      for use, reproduction, or distribution of Your modifications, or
-      for any such Derivative Works as a whole, provided Your use,
-      reproduction, and distribution of the Work otherwise complies with
-      the conditions stated in this License.
-
-   5. Submission of Contributions. Unless You explicitly state otherwise,
-      any Contribution intentionally submitted for inclusion in the Work
-      by You to the Licensor shall be under the terms and conditions of
-      this License, without any additional terms or conditions.
-      Notwithstanding the above, nothing herein shall supersede or modify
-      the terms of any separate license agreement you may have executed
-      with Licensor regarding such Contributions.
-
-   6. Trademarks. This License does not grant permission to use the trade
-      names, trademarks, service marks, or product names of the Licensor,
-      except as required for reasonable and customary use in describing the
-      origin of the Work and reproducing the content of the NOTICE file.
-
-   7. Disclaimer of Warranty. Unless required by applicable law or
-      agreed to in writing, Licensor provides the Work (and each
-      Contributor provides its Contributions) on an "AS IS" BASIS,
-      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
-      implied, including, without limitation, any warranties or conditions
-      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
-      PARTICULAR PURPOSE. You are solely responsible for determining the
-      appropriateness of using or redistributing the Work and assume any
-      risks associated with Your exercise of permissions under this License.
-
-   8. Limitation of Liability. In no event and under no legal theory,
-      whether in tort (including negligence), contract, or otherwise,
-      unless required by applicable law (such as deliberate and grossly
-      negligent acts) or agreed to in writing, shall any Contributor be
-      liable to You for damages, including any direct, indirect, special,
-      incidental, or consequential damages of any character arising as a
-      result of this License or out of the use or inability to use the
-      Work (including but not limited to damages for loss of goodwill,
-      work stoppage, computer failure or malfunction, or any and all
-      other commercial damages or losses), even if such Contributor
-      has been advised of the possibility of such damages.
-
-   9. Accepting Warranty or Additional Liability. While redistributing
-      the Work or Derivative Works thereof, You may choose to offer,
-      and charge a fee for, acceptance of support, warranty, indemnity,
-      or other liability obligations and/or rights consistent with this
-      License. However, in accepting such obligations, You may act only
-      on Your own behalf and on Your sole responsibility, not on behalf
-      of any other Contributor, and only if You agree to indemnify,
-      defend, and hold each Contributor harmless for any liability
-      incurred by, or claims asserted against, such Contributor by reason
-      of your accepting any such warranty or additional liability.
-
-   END OF TERMS AND CONDITIONS
-
-   APPENDIX: How to apply the Apache License to your work.
-
-      To apply the Apache License to your work, attach the following
-      boilerplate notice, with the fields enclosed by brackets "[]"
-      replaced with your own identifying information. (Don't include
-      the brackets!)  The text should be enclosed in the appropriate
-      comment syntax for the file format. We also recommend that a
-      file or class name and description of purpose be included on the
-      same "printed page" as the copyright notice for easier
-      identification within third-party archives.
-
-   Copyright [yyyy] [name of copyright owner]
-
-   Licensed under the Apache License, Version 2.0 (the "License");
-   you may not use this file except in compliance with the License.
-   You may obtain a copy of the License at
-
-       http://www.apache.org/licenses/LICENSE-2.0
-
-   Unless required by applicable law or agreed to in writing, software
-   distributed under the License is distributed on an "AS IS" BASIS,
-   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-   See the License for the specific language governing permissions and
-   limitations under the License.
+MIT License
+
+Copyright (c) Daniel Roe <daniel@roe.dev>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,139 +1,90 @@
 # vite-plugin-cross-origin-storage
 
-A Vite plugin to cache and load static assets (chunks) using the
-[Cross-Origin Storage (COS) API](https://github.com/WICG/cross-origin-storage).
-
-This plugin progressively enhances your application by attempting to load vendor
-chunks and other assets from a shared Cross-Origin Storage, reducing bandwidth
-usage and improving load times across different sites that share common
-dependencies.
-
-## Features
-
-- **Automatic Import Rewriting**: Rewrites static imports to use COS-loaded Blob
-  URLs when available.
-- **Network Fallback**: Gracefully falls back to standard network requests if
-  COS is unavailable or the asset is missing.
-- **Smart Caching**: Automatically stores fetched assets into COS for future
-  use.
-- **Configurable**: Easily include or exclude specific chunks using glob
-  patterns.
-- **Runtime Loader**: Injects a lightweight loader to handle COS interactions
-  transparently.
+> [!WARNING]
+> Experimental. The [Cross-Origin Storage API](https://github.com/WICG/cross-origin-storage) is an early-stage proposal with no native browser support yet, and this plugin's chunk format is not stable. Do not depend on it in production.
+
+A Vite plugin that extracts shared dependencies (such as `vue`) into **content-addressed** chunks that can be loaded from [Cross-Origin Storage (COS)](https://github.com/WICG/cross-origin-storage). When two sites build the same dependency at the same version, they produce byte-identical chunks with the same SHA-256, so a browser that supports COS can serve the chunk from a shared store instead of fetching it again per origin.
+
+This builds on [Thomas Steiner](https://github.com/tomayac)'s original [`vite-plugin-cross-origin-storage`](https://github.com/tomayac/vite-plugin-cross-origin-storage), and is intended as an update of it. It explores a content-addressed chunking and decentralised (registry-free) sharing model on top of the loader and import-rewriting approach Thomas established. The aim is to merge these changes back upstream.
+
+## How it works
+
+At build time, for each package matched by `packages`:
+
+1. The package is externalised from the app graph and re-bundled on its own with `rolldown`, **preserving every export** (no tree-shaking). This makes a chunk's bytes depend only on the package, never on which parts of it the app happened to import, so it is identical across sites.
+2. Its dependencies are discovered and bundled too, recursively, so managing one package implicitly manages its whole import subgraph (e.g. `vue` pulls in `@vue/*`). Shared dependencies become their own chunks rather than being duplicated, which also preserves singletons like `@vue/reactivity`.
+3. Chunks are hashed **bottom-up**: each chunk imports its dependencies by their content hash (`cos1:<sha256>`), so a chunk can only be hashed once its dependencies are. The result is purely a function of the source plus a pinned build recipe.
+4. A runtime loader is injected. It looks each managed chunk up in COS by hash, falling back to the network and storing the fetched chunk for next time, then wires everything together through an import map.
+
+The `cos1:` prefix is a **recipe version**. Chunks are only byte-identical across builds that use the same recipe (the same `rolldown` version and options); the prefix is bumped when the recipe changes so chunks built under different recipes can never collide on the same hash.
 
 ## Installation
 
 ```bash
-npm install vite-plugin-cross-origin-storage --save-dev
+npm install -D vite-plugin-cross-origin-storage
 ```
 
 ## Usage
 
-Add the plugin to your `vite.config.ts` (or `vite.config.js`):
-
 ```ts
-import { defineConfig } from 'vite';
-import cosPlugin from 'vite-plugin-cross-origin-storage';
+// vite.config.ts
+import { defineConfig } from 'vite'
+import { cosPlugin } from 'vite-plugin-cross-origin-storage'
 
 export default defineConfig({
   plugins: [
     cosPlugin({
-      // Configuration options
-      include: ['**/vendor-*'], // Example: only manage vendor chunks
+      packages: [/^(?:vue$|@vue\/)/],
     }),
   ],
-});
+})
 ```
 
-## Configuration
+For a plain client build, the plugin injects the loader into `index.html` and removes the default entry `<script>` automatically.
 
-| Option    | Type                        | Default     | Description                                     |
-| :-------- | :-------------------------- | :---------- | :---------------------------------------------- |
-| `include` | `string \| RegExp \| Array` | `['**/*']`  | Pattern to include chunks to be managed by COS. |
-| `exclude` | `string \| RegExp \| Array` | `undefined` | Pattern to exclude chunks from being managed.   |
+## Trying it out
 
-## Recipe: Granular Vendor Splitting
+The plugin only runs at build time, so verify against a production build, not the dev server:
 
-To maximize caching benefits, it is recommended to split your `node_modules`
-dependencies into separate chunks. This ensures that updates to one package
-(e.g., `react`) do not invalidate the cache for others (e.g., `lodash`).
+```bash
+vite build && vite preview
+```
 
-Add the following `manualChunks` configuration to your `vite.config.ts`:
+Then check, in your `dist/<assetsDir>/`, that the managed packages are emitted as content-hashed chunks (a 64-character hex filename like `a1b2c3...e4f5.js`), and that opening the preview URL still loads the app normally. The chunks import each other by `cos1:<hash>` specifiers, resolved at runtime through an injected `<script type="importmap">`.
 
-```ts
-// vite.config.ts
-import { defineConfig } from 'vite';
-import cosPlugin from 'vite-plugin-cross-origin-storage';
+Without a COS-capable browser the loader fetches each chunk over the network, so this is the network-fallback path: it confirms the chunking and loader work, but not sharing.
 
-export default defineConfig({
-  build: {
-    rollupOptions: {
-      output: {
-        manualChunks(id) {
-          if (id.includes('node_modules')) {
-            // Split each package into its own chunk
-            // e.g. "node_modules/react/..." -> "vendor-react"
-            // e.g. "node_modules/@scope/pkg/..." -> "vendor-scope-pkg"
-            const parts = id.split('node_modules/')[1].split('/');
-            const packageName = parts[0].startsWith('@')
-              ? `${parts[0]}/${parts[1]}`
-              : parts[0];
-            return `vendor-${packageName.replace('@', '').replace('/', '-')}`;
-          }
-        },
-      },
-    },
-  },
-  plugins: [
-    cosPlugin({
-      // Only manage these vendor chunks with COS
-      include: ['**/vendor-*'],
-    }),
-  ],
-});
-```
+To see real Cross-Origin Storage, install the [extension](https://chromewebstore.google.com/detail/cross-origin-storage/denpnpcgjgikjpoglpjefakmdcbmlgih), then:
+
+1. Open the preview URL. On the first load the chunks are fetched and stored in COS (the extension's toolbar popup shows the activity).
+2. Reload, or open a **different** site that ships the same dependency at the same version. In DevTools -> Network, the managed hashed `.js` chunks are no longer fetched; they come from the shared store instead.
+
+For local testing it's safest to load the extension unpacked from [`web-ai-community/cross-origin-storage-extension`](https://github.com/web-ai-community/cross-origin-storage-extension).
+
+## Options
+
+| Option | Type | Default | Description |
+| --- | --- | --- | --- |
+| `packages` | `Array<string \| RegExp>` | (required) | Packages to extract into COS chunks. Matched against the imported specifier; a plain string is an exact match. Transitive dependencies are collected automatically. |
+| `base` | `string` | Vite's `base` + `build.assetsDir` | Public path the chunks are served from. |
+| `loaderEntry` | `string` | bundled loader | Path to a custom runtime loader entry. |
+| `onGenerated` | `(scriptContent: string) => void` | (unset) | Receives the loader `<script>` body once chunks are emitted. SSR frameworks inject it into their own rendered HTML; when omitted the plugin injects into `index.html`. |
+
+## Browser support
+
+The [Cross-Origin Storage API](https://github.com/WICG/cross-origin-storage) is not yet implemented in any browser. You can try it today with the [Cross-Origin Storage browser extension](https://github.com/web-ai-community/cross-origin-storage-extension). Without it, the loader falls back to ordinary network requests, so the build still works everywhere; it just doesn't share chunks.
+
+## Limitations
+
+- **Managed packages must be self-contained.** A package whose source imports build-time virtuals (e.g. `#build/*`, `#imports`) cannot be bundled standalone and is rejected with a clear error. It also wouldn't be shareable, since its output would differ per app.
+- **Single-entry builds.** The loader wires up one entry chunk; multi-page builds with several HTML entries are not yet supported.
+- **The app entry is never COS-shared.** It is app-specific and is loaded from the network.
+- **Determinism is recipe-scoped.** Sharing only happens between builds on the same package version *and* the same recipe (`cos1:`).
+
+## Credits
 
-## How It Works
-
-### Build Time
-
-1. **Magic Externals**: For `include` patterns that resolve to npm package
-   names (e.g. `vendor-react` → `react`), the plugin externalizes the package
-   from Rollup and uses esbuild to produce a single self-contained ESM bundle.
-   This bundle is emitted as a hashed asset (e.g. `assets/react-a1b2c3d4.js`)
-   and treated as a managed chunk.
-2. **Import Rewriting**: All inter-chunk imports are rewritten from relative
-   paths (`"./chunk.js"`) to bare specifiers (`"coschunk-assets-chunk-js"`).
-   This applies to both managed and unmanaged chunks, because managed chunks
-   run as Blob URLs and cannot resolve relative paths at runtime.
-3. **Manifest Generation**: A JSON manifest is built containing the base path,
-   the entry chunk filename, a map of every managed chunk filename to its
-   SHA-256 hash, and a list of unmanaged chunks that need network-URL entries
-   in the import map.
-4. **Loader Injection**: The plugin disables the default
-   `<script type="module">` entry tag and injects a `<script id="cos-loader">`
-   containing the runtime loader with the manifest inlined.
-
-### Runtime
-
-1. The loader checks for `navigator.crossOriginStorage`.
-2. For each managed chunk it calls
-   `navigator.crossOriginStorage.requestFileHandles([{ algorithm: 'SHA-256', value: hash }])`:
-   - **Cache hit**: wraps the returned `File` as a Blob URL.
-   - **Cache miss**: fetches the chunk from the network, stores it in COS via
-     `requestFileHandles(..., { create: true })`, then wraps it as a Blob URL.
-3. Unmanaged chunks receive absolute network URLs.
-4. An `<script type="importmap">` is injected into `<head>` mapping every
-   `coschunk-*` bare specifier to its resolved URL.
-5. The entry point is imported via its bare specifier inside a `setTimeout`
-   callback so the browser has time to register the import map before the
-   first module resolution occurs.
-
-## Requirements
-
-- A browser with `Cross-Origin Storage` support (or a
-  [browser extension](https://chromewebstore.google.com/detail/cross-origin-storage/denpnpcgjgikjpoglpjefakmdcbmlgih)).
+Original plugin and the COS loader / import-rewriting approach by [Thomas Steiner](https://github.com/tomayac) ([`tomayac/vite-plugin-cross-origin-storage`](https://github.com/tomayac/vite-plugin-cross-origin-storage)).
 
 ## License
 
-Apache 2.0
+MIT

package/dist/index.d.mts

@@ -0,0 +1,32 @@
+import { CosManifest } from "./loader.mjs";
+import { Plugin } from "vite";
+
+//#region src/index.d.ts
+interface CosPluginOptions {
+  /**
+   * Packages to extract into standalone Cross-Origin Storage chunks. Each entry
+   * is matched against the imported module specifier; a plain string is treated
+   * as an exact match.
+   */
+  packages: Array<string | RegExp>;
+  /**
+   * Public base path the managed chunks are served from. Defaults to Vite's
+   * resolved `base` joined with `build.assetsDir`.
+   */
+  base?: string;
+  /**
+   * Path to the runtime loader entry to bundle into the injected `<script>`.
+   * Defaults to the bundled loader. Override only to swap the loader runtime.
+   */
+  loaderEntry?: string;
+  /**
+   * Called once the managed chunks are emitted, with the loader `<script>` body
+   * (loader IIFE + inlined manifest). SSR frameworks should inject this into
+   * their rendered HTML themselves. When omitted, the plugin injects it into
+   * `index.html` via `transformIndexHtml` for plain client builds.
+   */
+  onGenerated?: (scriptContent: string) => void;
+}
+declare function cosPlugin(options: CosPluginOptions): Plugin;
+//#endregion
+export { type CosManifest, CosPluginOptions, cosPlugin, cosPlugin as default };