@atproto-labs/rollup-plugin-bundle-manifest 0.0.1 → 0.1.0

package/CHANGELOG.md

@@ -1,7 +1,7 @@
 # @atproto-labs/rollup-plugin-bundle-manifest
 
-## 0.0.1
+## 0.1.0
 
-### Patch Changes
+### Minor Changes
 
-- [`e134c79a0`](https://github.com/bluesky-social/atproto/commit/e134c79a0ffb000b2cb36437815673fa6bda664b) Thanks [@devinivy](https://github.com/devinivy)! - Initial publish of experimental oauth packages to @atproto-labs
+- [#2482](https://github.com/bluesky-social/atproto/pull/2482) [`a8d6c1123`](https://github.com/bluesky-social/atproto/commit/a8d6c112359f5c4c0cfbe2df63443ed275f2a646) Thanks [@matthieusieben](https://github.com/matthieusieben)! - Add OAuth provider capability & support for DPoP signed tokens

package/README.md

@@ -0,0 +1,99 @@
+# @atproto-labs/rollup-plugin-bundle-manifest
+
+This Rollup plugin allows to generate a (JSON) manifest containing the output
+files of a Rollup build. The manifest will look as follows:
+
+```json
+{
+  "main.js": {
+    "type": "chunk",
+    "mime": "application/javascript",
+    "dynamicImports": [],
+    "isDynamicEntry": false,
+    "isEntry": true,
+    "isImplicitEntry": false,
+    "name": "main",
+    "sha256": "<sha256-hash>",
+    "data": "<base64-encoded-contents>"
+  },
+  "main.js.map": {
+    "type": "asset",
+    "mime": "application/json",
+    "sha256": "<sha256-hash>",
+    "data": "<base64-encoded-contents>"
+  },
+  "main.css": {
+    "type": "asset",
+    "mime": "text/css",
+    "sha256": "<sha256-hash>",
+    "data": "<base64-encoded-contents>"
+  }
+  // ... more entries as needed
+}
+```
+
+This manifest will typically be useful for a backend service that serves the
+frontend assets, as it can be used to determine the correct `Content-Type` and
+and file integrity (via the SHA-256 hash), without having to read the files
+themselves.
+
+## Usage
+
+```js
+// rollup.config.js
+
+import bundleManifest from '@atproto-labs/rollup-plugin-bundle-manifest'
+
+export default {
+  input: 'src/index.js',
+  output: {
+    dir: 'dist',
+    format: 'es',
+  },
+  plugins: [
+    bundleManifest({
+      name: 'bundle-manifest.json',
+
+      // Optional: should the asset data be embedded (as base64 string) in the manifest?
+      data: false,
+    }),
+  ],
+}
+```
+
+## Options
+
+- `name` (string): The name of the manifest file. Defaults to `bundle-manifest.json`.
+- `data` (boolean): Whether to embed the asset data in the manifest. Defaults to `false`.
+
+## Example
+
+```js
+const assetManifest = require('./dist/bundle-manifest.json')
+
+const app = express()
+
+app.use((req, res, next) => {
+  const asset = assetManifest[req.path.slice(1)]
+  if (!asset) return next()
+
+  res.setHeader('Content-Type', asset.mime)
+  res.setHeader('Content-Length', asset.data.length)
+
+  res.end(Buffer.from(asset.data, 'base64'))
+})
+
+app.use((req, res, next) => {
+  res.setHeader(
+    'Content-Security-Policy',
+    buildCSP(assetManifest), // Not provided here
+  )
+
+  // Serve the index.html file
+  res.sendFile('index.html')
+})
+```
+
+## License
+
+MIT

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atproto-labs/rollup-plugin-bundle-manifest",
-  "version": "0.0.1",
+  "version": "0.1.0",
   "license": "MIT",
   "description": "Library for generating a manifest of bundled files from a Rollup build",
   "keywords": [
@@ -12,7 +12,7 @@
   "repository": {
     "type": "git",
     "url": "https://github.com/bluesky-social/atproto",
-    "directory": "packages/rollup-plugin-bundle-manifest"
+    "directory": "packages/internal/rollup-plugin-bundle-manifest"
   },
   "type": "commonjs",
   "main": "dist/index.js",

package/tsconfig.build.json

@@ -0,0 +1,8 @@
+{
+  "extends": ["../../../tsconfig/node.json"],
+  "compilerOptions": {
+    "outDir": "dist",
+    "rootDir": "src"
+  },
+  "include": ["src"]
+}

package/tsconfig.json

@@ -1,8 +1,4 @@
 {
-  "extends": "../../tsconfig/node.json",
-  "compilerOptions": {
-    "outDir": "dist",
-    "rootDir": "src"
-  },
-  "include": ["src"]
+  "include": [],
+  "references": [{ "path": "./tsconfig.build.json" }]
 }