@docbox-nz/hapi-gateway 0.1.0 → 0.2.1

package/dist/options.d.ts

@@ -42,6 +42,12 @@ export interface PluginOptions {
      * Additional configuration options for axios
      */
     axiosConfig?: CreateAxiosDefaults;
+    /**
+     * Get a API key for making requests to docbox
+     *
+     * @returns The key or a promise to the key
+     */
+    getApiKey?: () => (string | null) | Promise<string | null>;
     /**
      * Write access check, will be invoked to check whether the request
      * has authorization to perform a write action against docbox

package/package.json

@@ -1,56 +1,55 @@
-{
-  "name": "@docbox-nz/hapi-gateway",
-  "version": "0.1.0",
-  "type": "module",
-  "scripts": {
-    "build": "rollup -c",
-    "prepublishOnly": "npm run build",
-    "watch": "rollup -c --watch"
-  },
-  "main": "./dist/index.browser.cjs",
-  "types": "./dist/index.d.ts",
-  "exports": {
-    ".": {
-      "types": {
-        "default": "./dist/index.d.ts"
-      },
-      "default": {
-        "require": "./dist/index.node.cjs",
-        "default": "./dist/index.node.esm.js"
-      }
-    }
-  },
-  "author": "Jacobtread",
-  "license": "MIT",
-  "description": "Docbox hapi server gateway",
-  "dependencies": {
-    "@hapi/boom": "^10.0.1",
-    "axios": "^1.7.4"
-  },
-  "peerDependencies": {
-    "@hapi/hapi": "^20.1.0 || ^21.0.0"
-  },
-  "devDependencies": {
-    "@hapi/boom": "^10.0.1",
-    "@hapi/hapi": "^21.4.0",
-    "@rollup/plugin-commonjs": "^28.0.3",
-    "@rollup/plugin-json": "^6.1.0",
-    "@rollup/plugin-node-resolve": "^16.0.1",
-    "@types/node": "^24.0.0",
-    "@typescript-eslint/eslint-plugin": "^7.18.0",
-    "@typescript-eslint/parser": "^7.18.0",
-    "eslint": "^8.55.0",
-    "eslint-config-airbnb": "^19.0.4",
-    "eslint-config-airbnb-typescript": "^18.0.0",
-    "eslint-config-prettier": "^9.1.0",
-    "eslint-import-resolver-typescript": "^3.6.1",
-    "eslint-plugin-import": "^2.29.0",
-    "eslint-plugin-perfectionist": "^2.5.0",
-    "eslint-plugin-prettier": "^5.0.1",
-    "eslint-plugin-unused-imports": "^3.0.0",
-    "prettier": "^3.1.0",
-    "rollup-plugin-typescript2": "^0.36.0",
-    "tslib": "^2.8.1",
-    "typescript": "^5.8.3"
-  }
+{
+  "name": "@docbox-nz/hapi-gateway",
+  "version": "0.2.1",
+  "type": "module",
+  "main": "./dist/index.browser.cjs",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": {
+        "default": "./dist/index.d.ts"
+      },
+      "default": {
+        "require": "./dist/index.node.cjs",
+        "default": "./dist/index.node.esm.js"
+      }
+    }
+  },
+  "author": "Jacobtread",
+  "license": "MIT",
+  "description": "Docbox hapi server gateway",
+  "dependencies": {
+    "@hapi/boom": "^10.0.1",
+    "axios": "^1.7.4"
+  },
+  "peerDependencies": {
+    "@hapi/hapi": "^20.1.0 || ^21.0.0"
+  },
+  "devDependencies": {
+    "@hapi/boom": "^10.0.1",
+    "@hapi/hapi": "^21.4.0",
+    "@rollup/plugin-commonjs": "^28.0.3",
+    "@rollup/plugin-json": "^6.1.0",
+    "@rollup/plugin-node-resolve": "^16.0.1",
+    "@types/node": "^24.0.0",
+    "@typescript-eslint/eslint-plugin": "^7.18.0",
+    "@typescript-eslint/parser": "^7.18.0",
+    "eslint": "^8.55.0",
+    "eslint-config-airbnb": "^19.0.4",
+    "eslint-config-airbnb-typescript": "^18.0.0",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-import-resolver-typescript": "^3.6.1",
+    "eslint-plugin-import": "^2.29.0",
+    "eslint-plugin-perfectionist": "^2.5.0",
+    "eslint-plugin-prettier": "^5.0.1",
+    "eslint-plugin-unused-imports": "^3.0.0",
+    "prettier": "^3.1.0",
+    "rollup-plugin-typescript2": "^0.37.0",
+    "tslib": "^2.8.1",
+    "typescript": "^5.8.3"
+  },
+  "scripts": {
+    "build": "rollup -c",
+    "watch": "rollup -c --watch"
+  }
 }

package/src/index.ts

@@ -44,6 +44,7 @@ export function createDocboxRoutes(options: PluginOptions) {
   );
 
   const getRequestUser: PluginOptions['getRequestUser'] = options.getRequestUser ?? (() => null);
+  const getApiKey: PluginOptions['getApiKey'] = options.getApiKey ?? (() => null);
 
   // Base route for creating document boxes
   const createBoxRoute: ServerRoute = {
@@ -68,7 +69,9 @@ export function createDocboxRoutes(options: PluginOptions) {
 
       const tenant = await options.getRequestTenant(request);
       const user = await getRequestUser(request);
-      return forwardRequest(axiosInstance, request, tenant, user, h, path);
+      const apiKey = await getApiKey();
+
+      return forwardRequest(axiosInstance, request, tenant, user, apiKey, h, path);
     },
     options: baseRouteOptions,
   };
@@ -91,7 +94,9 @@ export function createDocboxRoutes(options: PluginOptions) {
 
       const tenant = await options.getRequestTenant(request);
       const user = await getRequestUser(request);
-      return forwardRequest(axiosInstance, request, tenant, user, h, path);
+      const apiKey = await getApiKey();
+
+      return forwardRequest(axiosInstance, request, tenant, user, apiKey, h, path);
     },
     options: { ...baseRouteOptions, ...baseForwardRouteOptions },
   };
@@ -120,7 +125,9 @@ export function createDocboxRoutes(options: PluginOptions) {
 
       const tenant = await options.getRequestTenant(request);
       const user = await getRequestUser(request);
-      return forwardRequest(axiosInstance, request, tenant, user, h, path);
+      const apiKey = await getApiKey();
+
+      return forwardRequest(axiosInstance, request, tenant, user, apiKey, h, path);
     },
     options: {
       ...baseRouteOptions,
@@ -176,6 +183,7 @@ function isWriteRequest(request: Request, path: string) {
  * @param axios Axios instance to forward the request through
  * @param request The request itself
  * @param user User performing the request
+ * @param apiKey API key for requests
  * @param h Response toolkit for creating the response
  * @param path Path requested from the server
  */
@@ -184,12 +192,17 @@ async function forwardRequest(
   request: Request,
   tenant: DocboxRequestTenant,
   user: DocboxRequestUser | null,
+  apiKey: string | null,
   h: ResponseToolkit,
   path: string
 ) {
   const userHeaders: Record<string, any> = request.headers;
   const forwardHeaders: Record<string, any> = {};
 
+  if (apiKey !== null) {
+    forwardHeaders['x-docbox-api-key'] = apiKey;
+  }
+
   // Forward content related headers
   if (userHeaders['accept'] !== undefined) {
     forwardHeaders['accept'] = userHeaders['accept'];

package/src/options.ts

@@ -53,6 +53,13 @@ export interface PluginOptions {
    */
   axiosConfig?: CreateAxiosDefaults;
 
+  /**
+   * Get a API key for making requests to docbox
+   *
+   * @returns The key or a promise to the key
+   */
+  getApiKey?: () => (string | null) | Promise<string | null>;
+
   /**
    * Write access check, will be invoked to check whether the request
    * has authorization to perform a write action against docbox