@fastly/hono-compute-js-static-publish 0.4.0

package/CHANGELOG.md

@@ -0,0 +1,46 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [unreleased]
+
+## [0.4.0] - 2024-10-06
+
+### Changed
+
+- BREAKING: Moved to @fastly scope
+
+## [0.3.0] - 2024-08-30
+
+### Added
+
+- Update for @fastly/compute-js-static-publish v7
+
+## [0.2.0] - 2024-04-26
+
+### Added
+
+- Added files field to npm package
+- Added keywords field to npm package
+
+## [0.1.1] - 2024-04-26
+
+### Added
+
+- Added repository field to npm package
+
+## [0.1.0] - 2024-04-26
+
+### Added
+
+- Initial public release
+
+[unreleased]: https://github.com/harmony7/hono-compute-js-static-publish/compare/v0.4.0...HEAD
+[0.4.0]: https://github.com/harmony7/hono-compute-js-static-publish/compare/v0.1.1...v0.4.0
+[0.3.0]: https://github.com/harmony7/hono-compute-js-static-publish/compare/v0.1.1...v0.3.0
+[0.2.0]: https://github.com/harmony7/hono-compute-js-static-publish/compare/v0.1.1...v0.2.0
+[0.1.1]: https://github.com/harmony7/hono-compute-js-static-publish/compare/v0.1.0...v0.1.1
+[0.1.0]: https://github.com/harmony7/hono-compute-js-static-publish/releases/tag/v0.1.0

package/LICENSE

@@ -0,0 +1,19 @@
+MIT License
+
+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

@@ -0,0 +1,185 @@
+# Compute Static Publisher for Hono
+
+`@fastly/hono-compute-js-static-publish` is a utility for [Hono](https://hono.dev) to allow your program to serve static files under [Fastly Compute](https://www.fastly.com/products/edge-compute). It leverages the `PublisherServer` from [`@fastly/compute-js-static-publish`](https://www.npmjs.com/package/@fastly/compute-js-static-publish).
+
+Works with:
+* Hono v4.x
+* [@fastly/compute-js-static-publish](https://www.npmjs.com/package/@fastly/compute-js-static-publish) v6.x and v7.x
+
+## Example
+
+### compute-js-static-publish v7
+
+```typescript
+import { Hono } from 'hono/quick'
+import { fire } from 'hono/service-worker'
+
+import { serveStatic } from '@fastly/hono-compute-js-static-publish'
+import { PublisherServer } from '@fastly/compute-js-static-publish'
+import rc from '../static-publish.rc.js'
+const staticPublisherServer = PublisherServer.fromStaticPublishRc(rc)
+
+const app = new Hono()
+
+app.get('/', (c) => {
+  return c.text('Hello Hono!')
+})
+
+app.get('/favicon.ico', serveStatic({ path: './favicon.ico', staticPublisherServer }))
+app.get('/static/*', serveStatic({ root: './', staticPublisherServer }))
+
+fire(app)
+```
+
+### compute-js-static-publish v6
+
+```typescript
+import { Hono } from 'hono/quick'
+import { fire } from 'hono/service-worker'
+
+import { serveStatic } from '@fastly/hono-compute-js-static-publish'
+import { getServer } from '../static-publisher/statics.js'
+
+const app = new Hono()
+
+app.get('/', (c) => {
+  return c.text('Hello Hono!')
+});
+
+const staticPublisherServer = getServer()
+app.get('/favicon.ico', serveStatic({ path: './favicon.ico', staticPublisherServer }))
+app.get('/static/*', serveStatic({ root: './', staticPublisherServer }))
+
+fire(app)
+```
+
+## Usage
+
+> [!NOTE]
+> The instructions below are for @fastly/compute-js-static-publish v7.
+
+Once you have [set up a Hono project for Fastly Compute](https://hono.dev/getting-started/fastly), add this Adapter, the Fastly CLI, and the Static Publisher library to your application:
+
+```
+npm install @fastly/hono-compute-js-static-publish @fastly/cli @fastly/compute-js-static-publish
+```
+
+These directions assume your static files exist directly under the `./assets` subdirectory of your Fastly Compute application.
+
+You will need to add and modify some files at the root of your project.
+
+* Add `static-publish.rc.js`
+    ```javascript
+    /** @type {import('@fastly/compute-js-static-publish').StaticPublishRc} */
+    const rc = {
+        kvStoreName: "site-content",
+        publishId: "default",
+        defaultCollectionName: "live",
+        staticPublisherWorkingDir: "./static-publisher",
+    };
+    
+    export default rc;
+    ```
+    This sets up the Static Publisher to use a KV Store named `site-content` and to place generated temporary files in the `./static-publisher` subdirectory. The other fields are not used in `@fastly/hono-compute-js-static-publish` but are required fields.
+
+    > [!TIP]
+    > Add `./static-publisher/` to your `.gitignore` as these files will be regenerated on the build.
+
+* Add `publish-content.config.js`
+    ```javascript
+    /** @type {import('@fastly/compute-js-static-publish').PublishContentConfig} */
+    const config = {
+        rootDir: './assets'
+    };
+    
+    export default config;
+    ```
+
+    This instructs the Static Publisher to find static files at `./assets`.
+
+    > [!IMPORTANT]
+    > As this application does not use `PublisherServer` to directly serve assets, the `server` field is not applicable.
+
+* Modify `package.json`
+    Add the following items under the `scripts` section:
+    ```json
+    {
+      "scripts": {
+        "dev:publish": "npx @fastly/compute-js-static-publish publish-content --local",
+        "dev:start": "fastly compute serve",
+        "fastly:deploy": "fastly compute publish",
+        "fastly:publish": "npx @fastly/compute-js-static-publish publish-content"
+      }
+    }
+    ```
+
+* Modify `fastly.toml`
+    Add the following lines to the end of the file:
+    ```toml
+    [local_server.kv_stores]
+    site-content = { file = "./static-publisher/kvstore.json", format = "json" }
+
+    [setup.kv_stores.site-content]
+    ``` 
+
+Finally, modify your application's `src/index.ts` file:
+1. Import `serveStatic` from this library and `PublisherServer` from `@fastly/compute-js-static-publish`
+2. Import the default constant from `static-publish.rc.js` and pass it to `PublisherServer.fromStaticPublishRc()` to obtain an instance of the Publisher Server.
+3. Call `serveStatic` to instantiate [Hono Middleware](https://hono.dev/guides/middleware), passing in the `PublisherServer` instance obtained above. 
+
+```typescript
+import { Hono } from 'hono/quick'
+import { fire } from 'hono/service-worker'
+
+import { serveStatic } from '@fastly/hono-compute-js-static-publish'
+import { PublisherServer } from '@fastly/compute-js-static-publish'
+import rc from '../static-publish.rc.js'
+const staticPublisherServer = PublisherServer.fromStaticPublishRc(rc)
+
+const app = new Hono()
+
+app.get('/', (c) => {
+  return c.text('Hello Hono!')
+})
+
+app.get('/favicon.ico', serveStatic({ path: './favicon.ico', staticPublisherServer }))
+app.get('/static/*', serveStatic({ root: './', staticPublisherServer }))
+
+fire(app)
+```
+
+Include either `path` or `root` in the object passed to `serveStatic()`.
+* `path` - serves the static file at the specified path under the asset directory.
+    * e.g., a request for `/favicon.ico` serves `./assets/favicon.ico`.
+* `root` - serves the file at the path under the asset directory relative to the specified directory.
+    * e.g., a request for `/static/foo.html` serves `./assets/static/foo.html`.
+
+### Run locally
+
+```sh
+npm run dev:publish          # 'publish' your files to the simulated local KV Store
+npm run dev:start            # preview locally
+```
+
+Serves your app at `http://127.0.0.1:7676`, powered by a simulated KV Store.
+
+### Deploy to Fastly Compute
+
+[Create a free Fastly account](https://www.fastly.com/signup/?tier=free) if you haven't already, and then:
+
+```sh
+npm run fastly:deploy        # deploy the app
+npm run fastly:publish       # upload your static files
+```
+
+Further changes involving only updates to your static files can be made by running:
+```sh
+npm run fastly:publish       # upload your static files
+```
+
+📘 For more on Compute-JS Static Publisher:  
+[https://github.com/fastly/compute-js-static-publish](https://github.com/fastly/compute-js-static-publish)
+
+## License
+
+[MIT](./LICENSE).

package/build/index.d.ts

@@ -0,0 +1,8 @@
+import { type PublisherServer } from '@fastly/compute-js-static-publish';
+export type ServeStaticOptions = {
+    path?: string;
+    root?: string;
+    staticPublisherServer: PublisherServer;
+};
+export declare function serveStatic(options: ServeStaticOptions): import("hono/types").MiddlewareHandler<any, string, {}>;
+//# sourceMappingURL=index.d.ts.map

package/build/index.js

@@ -0,0 +1,23 @@
+import { createMiddleware } from 'hono/factory';
+export function serveStatic(options) {
+    const server = options.staticPublisherServer;
+    let root = options.root ?? './';
+    if (!root.endsWith('/')) {
+        root += root;
+    }
+    const base = new URL(root, 'https://www.example.com/');
+    return createMiddleware(async (c, next) => {
+        let reqPath = options.path ?? c.req.path;
+        if (reqPath.startsWith('/')) {
+            reqPath = '.' + reqPath;
+        }
+        const pathname = new URL(reqPath, base).pathname;
+        const asset = await server.getMatchingAsset(pathname);
+        if (asset == null) {
+            await next();
+            return;
+        }
+        c.res = undefined;
+        c.res = await server.serveAsset(c.req.raw, asset, { cache: 'never' });
+    });
+}

package/package.json

@@ -0,0 +1,52 @@
+{
+  "name": "@fastly/hono-compute-js-static-publish",
+  "version": "0.4.0",
+  "description": "Serve files from Fastly Compute Static Publisher on Hono",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/fastly/hono-compute-js-static-publish.git"
+  },
+  "author": {
+    "name": "Katsuyuki Omuro",
+    "email": "komuro@fastly.com"
+  },
+  "type": "module",
+  "main": "./build/index.js",
+  "exports": {
+    ".": {
+      "types": "./build/index.d.ts",
+      "import": "./build/index.js"
+    }
+  },
+  "types": "./build/index.d.ts",
+  "scripts": {
+    "prepack": "npm run build",
+    "build": "tsc -p tsconfig.build.json",
+    "clean": "rm -rf build"
+  },
+  "devDependencies": {
+    "@fastly/compute-js-static-publish": "^7.0.0",
+    "hono": "^4.9.5",
+    "typescript": "^5.4.5"
+  },
+  "peerDependencies": {
+    "@fastly/compute-js-static-publish": "^6.0.0 || ^7.0.0",
+    "hono": "^4.0.0"
+  },
+  "files": [
+    "build/**/*.js",
+    "build/**/*.js.map",
+    "build/**/*.d.ts",
+    "LICENSE",
+    "README.md",
+    "CHANGELOG.md"
+  ],
+  "keywords": [
+    "hono",
+    "fastly",
+    "compute",
+    "static",
+    "serve"
+  ]
+}