@docbox-nz/hapi-gateway 0.2.1 → 0.3.0

package/.github/workflows/build.yml

@@ -0,0 +1,30 @@
+name: Build
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '24'
+
+      - name: Setup pnpm
+        uses: pnpm/action-setup@fc06bc1257f339d1d5d8b3a19a8cae5388b55320 # v5
+        with:
+          cache: true
+
+      - name: Install dependencies
+        run: pnpm install --frozen-lockfile
+
+      - name: Build
+        run: pnpm build

package/.github/workflows/release.yml

@@ -0,0 +1,37 @@
+name: Release
+
+on:
+  push:
+    tags:
+      - '*.*.*'
+
+permissions:
+  contents: read
+  id-token: write
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    environment: publish_npm
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '24'
+          registry-url: 'https://registry.npmjs.org'
+          package-manager-cache: false
+
+      - name: Setup pnpm
+        uses: pnpm/action-setup@fc06bc1257f339d1d5d8b3a19a8cae5388b55320 # v5
+
+      - name: Install dependencies
+        run: pnpm install --frozen-lockfile
+
+      - name: Build
+        run: pnpm build
+
+      - name: Publish
+        run: pnpm publish --no-git-checks

package/.oxfmtrc.json

@@ -0,0 +1,8 @@
+{
+  "$schema": "./node_modules/oxfmt/configuration_schema.json",
+  "printWidth": 100,
+  "singleQuote": true,
+  "trailingComma": "es5",
+  "tabWidth": 2,
+  "ignorePatterns": []
+}

package/.oxlintrc.json

@@ -0,0 +1,11 @@
+{
+  "$schema": "./node_modules/oxlint/configuration_schema.json",
+  "plugins": ["typescript", "unicorn", "oxc"],
+  "categories": {
+    "correctness": "error"
+  },
+  "rules": {},
+  "env": {
+    "builtin": true
+  }
+}

package/.zed/settings.json

@@ -0,0 +1,10 @@
+{
+  "prettier": {
+    "allowed": false
+  },
+  "formatter": {
+    "language_server": {
+      "name": "oxfmt"
+    }
+  }
+}

package/README.md

@@ -1,10 +1,11 @@
 # 📦 @docbox-nz/hapi-gateway
 
-Docbox Gateway implementation for hapi 
+Docbox Gateway implementation for hapi
 
 Provides routes for forwarding requests to docbox and methods for enforcing access control over said routes
 
 ## Requirements
+
 - Hapi.js v20.1.0 or newer
 - Node.js 20+
 
@@ -18,13 +19,12 @@ npm i @docbox-nz/hapi-gateway
 
 You will also need to ensure that you have `@hapi/hapi` installed this plugin supports versions `^20.1.0 || ^21.0.0`
 
-
 ## Plugin setup
 
 For a simple installation where not much additional logic is required, you can add the following to your server setup
 
 ```js
-import { DocboxGateway } from "@docbox-nz/hapi-gateway";
+import { DocboxGateway } from '@docbox-nz/hapi-gateway';
 
 server.register({
   plugin: DocboxGateway,
@@ -32,25 +32,25 @@ server.register({
     // Prefix all routes with /data
     basePath: '/data',
     // Base request options for docbox routes
-    baseRouteOptions: { },
+    baseRouteOptions: {},
     // URL for the docbox API
-    docboxBaseURL: "http://docbox-server",
+    docboxBaseURL: 'http://docbox-server',
 
     // Get the tenant for a request
     getRequestTenant(request) {
       // ..derive your target tenant
       // this can be hard-coded for single tenant setups
-      return { id: '81284060-9542-4d66-9731-49ca3eb93bf9', env: "Development"}
+      return { id: '81284060-9542-4d66-9731-49ca3eb93bf9', env: 'Development' };
     },
 
     // Get the user for a request
     getRequestUser(request) {
       // ..derive your request user
       return {
-        id: "dd5ba8b5-7da2-4e8b-b255-9641faece80e",
-        name: "Example User",
-        imageId: "https://example.com/example.png"
-      }
+        id: 'dd5ba8b5-7da2-4e8b-b255-9641faece80e',
+        name: 'Example User',
+        imageId: 'https://example.com/example.png',
+      };
     },
 
     // Check request read access
@@ -64,7 +64,7 @@ server.register({
       // ..assert request is allowed to access scope
       return true;
     },
-  }
+  },
 });
 ```
 
@@ -73,31 +73,31 @@ server.register({
 If you have a more complex routing setup for your hapi app, you can use the `createDocboxRoutes` function to create a docbox setup and obtain a list of routes that you can manually add using `server.route`
 
 ```js
-import { createDocboxRoutes } from "@docbox-nz/hapi-gateway";
+import { createDocboxRoutes } from '@docbox-nz/hapi-gateway';
 
 const routes = createDocboxRoutes({
   // Prefix all routes with /data
   basePath: '/data',
   // Base request options for docbox routes
-  baseRouteOptions: { },
+  baseRouteOptions: {},
   // URL for the docbox API
-  docboxBaseURL: "http://docbox-server",
+  docboxBaseURL: 'http://docbox-server',
 
   // Get the tenant for a request
   getRequestTenant(request) {
     // ..derive your target tenant
     // this can be hard-coded for single tenant setups
-    return { id: '81284060-9542-4d66-9731-49ca3eb93bf9', env: "Development"}
+    return { id: '81284060-9542-4d66-9731-49ca3eb93bf9', env: 'Development' };
   },
 
   // Get the user for a request
   getRequestUser(request) {
     // ..derive your request user
     return {
-      id: "dd5ba8b5-7da2-4e8b-b255-9641faece80e",
-      name: "Example User",
-      imageId: "https://example.com/example.png"
-    }
+      id: 'dd5ba8b5-7da2-4e8b-b255-9641faece80e',
+      name: 'Example User',
+      imageId: 'https://example.com/example.png',
+    };
   },
 
   // Check request read access
@@ -116,10 +116,9 @@ const routes = createDocboxRoutes({
 module.exports = routes;
 ```
 
+## Example access control
 
-## Example access control 
-
-Access control is enforced on a scope level, you should check the `scope` (Document box scope) and decide whether the request should be allowed based 
+Access control is enforced on a scope level, you should check the `scope` (Document box scope) and decide whether the request should be allowed based
 on some information extracted from the request (or some other available context)
 
 > [!NOTE]
@@ -129,24 +128,19 @@ on some information extracted from the request (or some other available context)
 > `isAllowedWrite` also enforces the access control for creating new document boxes. Requests to `POST /box` are document box creation requests.
 
 ```js
-
 function isAllowedWrite(request, scope, path) {
+  // Get authenticated user scopes
+  const userScopes = request.auth.credentials.scope;
 
-    // Get authenticated user scopes
-    const userScopes = request.auth.credentials.scope
-
-    // User is trying to access the "admin-area" scope
-    if (scope === "admin-area") {
-
-        // Ensure the user has the required admin scope
-        if (userScopes.includes('admin')) {
-            return true;
-        }
-
+  // User is trying to access the "admin-area" scope
+  if (scope === 'admin-area') {
+    // Ensure the user has the required admin scope
+    if (userScopes.includes('admin')) {
+      return true;
     }
+  }
 
-    // Deny by default
-    return false;
-} 
-
+  // Deny by default
+  return false;
+}
 ```

package/cspell.json

@@ -1,6 +1,3 @@
 {
-    "words": [
-        "Docbox",
-        "Jacobtread"
-    ]
+  "words": ["Docbox", "Jacobtread"]
 }