added plugin code, pending connections and examples

Author: ap-atul

package-lock.json

@@ -3,6 +3,10 @@
   "version": "1.0.0",
   "description": "A hapijs plugin to generate signed url for response objects",
   "main": "index.js",
+  "engines": {
+    "node": "14.x",
+    "npm": "6.x.x"
+  },
   "scripts": {
     "start": "npx ts-node src/index.ts",
     "pretty": "npx prettier '**/*.{json,js,ts,md}' --write",
@@ -23,5 +27,11 @@
   "bugs": {
     "url": "https://github.com/AP-Atul/hapi-signed-url/issues"
   },
-  "homepage": "https://github.com/AP-Atul/hapi-signed-url#readme"
+  "homepage": "https://github.com/AP-Atul/hapi-signed-url#readme",
+  "dependencies": {
+    "prettier": "^2.7.1",
+    "ramda": "^0.28.0",
+    "ts-node": "^10.9.1",
+    "typescript": "^4.7.4"
+  }
 }

package.json

@@ -0,0 +1,2 @@
+// TODO: add the plugin export
+console.log('Hello world');

src/index.ts

@@ -0,0 +1,86 @@
+import * as _ from 'ramda';
+import { RouteOptions } from './types';
+
+const isPluginActive = (request): boolean => {
+    return (
+        (request.route.settings.plugins &&
+            request.route.settings.plugins.signedUrl) ||
+        false
+    );
+};
+
+const isResponseAbsent = (request): boolean => {
+    const response = request.response;
+    return (
+        response.statusCode !== 200 ||
+        _.isEmpty(response.source) ||
+        _.isNil(response.source)
+    );
+};
+
+const getRouteOptions = (request, getSignedUrl): RouteOptions => {
+    const options = request.route.settings.plugins.signedUrl;
+    const source = options.pathToSource
+        ? _.view(options.pathToSource, request.response.source)
+        : request.response.source;
+    return {
+        ...options,
+        source: source,
+        getSignedUrl: getSignedUrl,
+    };
+};
+
+const updateSignedUrl = async (options: RouteOptions) => {
+    const { source, lenses, getSignedUrl } = options;
+    const toUpdateLinks: string[] = lenses.map((lens) => _.view(lens, source));
+    const promises = toUpdateLinks.map(
+        async (link: string) => await getSignedUrl(link),
+    );
+    const updatedLinks = await Promise.all(promises);
+    const updatedSource = updatedLinks.reduce((source, link, index) => {
+        return _.set(lenses[index], link, source);
+    }, source);
+    return updatedSource as object;
+};
+
+const processSource = async (options: RouteOptions) => {
+    // single object
+    if (_.type(options.source) !== 'Array') {
+        return updateSignedUrl(options);
+    }
+
+    // if source is array
+    const promises = (options.source as any[]).map(async (src) => {
+        return updateSignedUrl({
+            ...options,
+            source: src,
+        });
+    });
+    return Promise.all(promises);
+};
+
+const signUrl = (getSignedUrl) => async (request, h) => {
+    if (!isPluginActive(request)) {
+        return h.continue;
+    }
+    if (isResponseAbsent(request)) {
+        return h.continue;
+    }
+
+    const routeOptions = getRouteOptions(request, getSignedUrl);
+    const updated = await processSource(routeOptions);
+    const updatedSource = routeOptions.pathToSource
+        ? _.set(routeOptions.pathToSource, updated, request.response.source)
+        : updated;
+
+    request.response.source = updatedSource;
+    return h.continue;
+};
+
+export const signedUrl = {
+    name: 'signedUrl',
+    version: '1.0.0',
+    register: async function (server, options) {
+        server.ext('onPreResponse', signUrl(options.getSignedUrl));
+    },
+};

src/signedUrl/plugin.ts

@@ -0,0 +1,10 @@
+export interface RouteOptions {
+    // lenses for properties to update
+    lenses: any[];
+    // path from which source to extract
+    pathToSource: any;
+    // source object can also be array
+    source: object | any[];
+    // function to generate signed urls
+    getSignedUrl(key: string): Promise<string>;
+}