@whook/gcp-functions 8.5.1 → 10.0.0

package/README.md

@@ -8,7 +8,6 @@
 > Build and deploy to GCP Cloud Functions with Whook.
 
 [![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/nfroidure/whook/blob/master/packages/whook-gcp-functions/LICENSE)
-[![NPM version](https://badge.fury.io/js/%40whook%2Fgcp-functions.svg)](https://npmjs.org/package/@whook/gcp-functions)
 
 
 [//]: # (::contents:start)
@@ -22,18 +21,21 @@ You can find a complete setup with a Terraform deployment example in
 
 ## Quick setup
 
-Install this module and its peer dependencies :
+Install this module:
 
 ```sh
 npm i @whook/gcp-functions;
-npm i --save-dev @whook/http-transaction esbuild
 ```
 
 Add this module to your Whook plugins and tweak the 2 build functions in your
-`build.ts` main file:
+`src/build.ts` main file:
 
 ```diff
-- import YError from 'yerror';
+import {
+  // (...)
+-  runBuild as runBaseBuild,
+  // (...)
+} from '@whook/whook';
 +import {
 +  runBuild as runBaseBuild,
 +  prepareBuildEnvironment as prepareBaseBuildEnvironment,
@@ -61,20 +63,6 @@ export async function prepareEnvironment(
 
 // (...)
 
-// The `runBuild` function is intended to build the
-// project
-export async function runBuild(
-  innerPrepareEnvironment = prepareBuildEnvironment,
-): Promise<void> {
--  throw new YError('E_NO_BUILD_IMPLEMENTED');
-
-  // Usually, here you call the installed build
--  // return runBaseBuild(innerPrepareEnvironment);
-+   return runBaseBuild(innerPrepareEnvironment);
-}
-
-// (...)
-
 // The `prepareBuildEnvironment` create the build
 //  environment
 export async function prepareBuildEnvironment(
@@ -109,48 +97,71 @@ export async function prepareBuildEnvironment(
 }
 ```
 
-And add the GCP Functions config (usually in `src/config/common/config.js`):
-
+Declare this module types in your `src/whook.d.ts` type
+ definitions:
 ```diff
 + import type { WhookCompilerConfig } from '@whook/whook';
 + import type {
-+   WhookAPIOperationGCPFunctionConfig
++    WhookGCPBuildConfig,
++    WhookAPIOperationGCPFunctionConfig
 + } from '@whook/gcp-functions';
 
-// ...
+declare module '@whook/whook' {
+
+  // ...
 
-export type AppConfigs = WhookConfigs &
-+  WhookCompilerConfig &
-  APIConfig;
+  export interface WhookConfigs
+-    extends WhookBaseConfigs {}
++    extends WhookBaseConfigs,
++      WhookGCPBuildConfig,
++      WhookCompilerConfig {}
 
-const CONFIG: AppConfigs = {
+  // ...
+
+  export interface WhookAPIHandlerDefinition<
+    T extends Record<string, unknown> = Record<string, unknown>,
+    U extends {
+      [K in keyof U]: K extends `x-${string}` ? Record<string, unknown> : never;
+    } = unknown,
+    V extends Record<string, unknown> = Record<string, unknown>,
+  > extends WhookBaseAPIHandlerDefinition<T, U> {
+    operation: U & WhookAPIOperation<
+        T &
++      WhookAPIOperationGCPFunctionConfig &
+      WhookAPIOperationCORSConfig
+    >;
+  }
+
+}
+```
+And add the GCP Functions config (usually in `src/config/common/config.js`):
+
+```diff
+import type { WhookConfigs } from '@whook/whook';
+
+// ...
+
+const CONFIG: WhookConfigs = {
   // ...
 +  COMPILER_OPTIONS: {
 +    externalModules: [],
-+    ignoredModules: [],
-+    target: '12', // Node 14 is in public review
++    target: '16',
 +  },
 };
 
-// Export custom handlers definitions
-export type APIHandlerDefinition = WhookAPIHandlerDefinition<
-+  WhookAPIOperationGCPFunctionConfig &
-  WhookAPIOperationSwaggerConfig
->;
-
 export default CONFIG;
 ```
 
 # Build
 
-To build your functions :
+To build your functions:
 
 ```sh
 # Build all functions
-npm run compile && npm run build
+npm run build
 
 # Build only one function
-npm run compile && npm run build -- getPing
+npm run build -- getPing
 ```
 
 # Debug
@@ -163,10 +174,10 @@ your `WHOOK_PLUGINS` list. It provides you some commands like the
 npx whook testHTTPFunction --name getPing
 ```
 
-To get more insights when errors happens:
+To get more insights when some errors happens:
 
 ```sh
-npm run whook-dev -- testHTTPFunction --name getPing
+DEBUG=whook npm run whook-dev -- testHTTPFunction --name getPing
 ```
 
 ## Deployment

package/dist/commands/testHTTPFunction.d.ts

@@ -7,6 +7,6 @@ declare const _default: import("knifecycle").ServiceInitializer<{
     PROJECT_DIR: string;
     API: OpenAPIV3.Document<{}>;
     log: LogService;
-    args: WhookCommandArgs;
+    args: WhookCommandArgs<Record<string, import("@whook/cli").WhookArgsTypes>>;
 }, () => Promise<void>>;
 export default _default;

package/dist/commands/testHTTPFunction.js

@@ -1,156 +1,125 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.definition = exports.default = void 0;
-
-var _utils = require("../libs/utils");
-
-var _knifecycle = require("knifecycle");
-
-var _cli = require("@whook/cli");
-
-var _yerror = _interopRequireDefault(require("yerror"));
-
-var _httpRouter = require("@whook/http-router");
-
-var _stream = _interopRequireDefault(require("stream"));
-
-var _camelcase = _interopRequireDefault(require("camelcase"));
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
+import { loadLambda } from '../libs/utils.js';
+import { extra, autoService } from 'knifecycle';
+import { readArgs } from '@whook/cli';
+import { YError } from 'yerror';
+import { dereferenceOpenAPIOperations, getOpenAPIOperations, } from '@whook/http-router';
+import stream from 'stream';
+import camelCase from 'camelcase';
 const SEARCH_SEPARATOR = '?';
 const PATH_SEPARATOR = '/';
-const definition = {
-  description: 'A command for testing AWS HTTP lambda',
-  example: `whook testHTTPLambda --name getPing`,
-  arguments: {
-    type: 'object',
-    additionalProperties: false,
-    required: ['name'],
-    properties: {
-      name: {
-        description: 'Name of the lamda to run',
-        type: 'string'
-      },
-      type: {
-        description: 'Type of lambda to test',
-        type: 'string',
-        enum: ['main', 'index'],
-        default: 'index'
-      },
-      contentType: {
-        description: 'Content type of the payload',
-        type: 'string',
-        default: 'application/json'
-      },
-      parameters: {
-        description: 'The HTTP call parameters',
-        type: 'string',
-        default: '{}'
-      }
-    }
-  }
+export const definition = {
+    description: 'A command for testing AWS HTTP lambda',
+    example: `whook testHTTPLambda --name getPing`,
+    arguments: {
+        type: 'object',
+        additionalProperties: false,
+        required: ['name'],
+        properties: {
+            name: {
+                description: 'Name of the lamda to run',
+                type: 'string',
+            },
+            type: {
+                description: 'Type of lambda to test',
+                type: 'string',
+                enum: ['main', 'index'],
+                default: 'index',
+            },
+            contentType: {
+                description: 'Content type of the payload',
+                type: 'string',
+                default: 'application/json',
+            },
+            parameters: {
+                description: 'The HTTP call parameters',
+                type: 'string',
+                default: '{}',
+            },
+        },
+    },
 };
-exports.definition = definition;
-
-var _default = (0, _knifecycle.extra)(definition, (0, _knifecycle.service)(initTestHTTPLambdaCommand, "testHTTPLambdaCommand", ["NODE_ENV", "PROJECT_DIR", "API", "log", "args"]));
-
-exports.default = _default;
-
-async function initTestHTTPLambdaCommand({
-  NODE_ENV,
-  PROJECT_DIR,
-  API,
-  log,
-  args
-}) {
-  return async () => {
-    const {
-      name,
-      type,
-      contentType,
-      parameters: rawParameters
-    } = (0, _cli.readArgs)(definition.arguments, args);
-    const handler = await (0, _utils.loadLambda)({
-      PROJECT_DIR,
-      log
-    }, NODE_ENV, name, type);
-    const OPERATION = (await (0, _httpRouter.dereferenceOpenAPIOperations)(API, (0, _httpRouter.getOpenAPIOperations)(API))).find(({
-      operationId
-    }) => operationId === name);
-
-    if (!OPERATION) {
-      throw new _yerror.default('E_OPERATION_NOT_FOUND');
-    }
-
-    const hasBody = !!OPERATION.requestBody;
-    const parameters = JSON.parse(rawParameters);
-    const search = (OPERATION.parameters || []).filter(p => p.in === 'query').reduce((accSearch, p) => {
-      if (null != parameters[p.name]) {
-        return accSearch + (accSearch ? '&' : '') + p.name + '=' + parameters[p.name];
-      }
-
-      return accSearch;
-    }, '');
-    const path = OPERATION.path.split(PATH_SEPARATOR).map(part => {
-      const matches = /^\{([\d\w]+)\}$/i.exec(part);
-
-      if (matches) {
-        return parameters[matches[1]];
-      }
-
-      return part;
-    }).join(PATH_SEPARATOR);
-    const gcpfRequest = {
-      method: OPERATION.method,
-      originalUrl: path + (search ? SEARCH_SEPARATOR + search : ''),
-      headers: (OPERATION.parameters || []).filter(p => p.in === 'header').reduce((headerParameters, p) => {
-        headerParameters[p.name] = parameters[(0, _camelcase.default)(p.name)];
-        return headerParameters;
-      }, {}),
-      rawBody: Buffer.from(hasBody ? contentType === 'application/json' ? parameters.body ? JSON.stringify(parameters.body) : '' : parameters.body || '' : '')
-    };
-
-    if (hasBody) {
-      gcpfRequest.headers['content-type'] = `${contentType};charset=UTF-8`;
-    }
-
-    log('info', 'GCPF_REQUEST:', gcpfRequest);
-    const response = {
-      status: 0,
-      headers: {},
-      data: ''
-    };
-    await new Promise((resolve, reject) => {
-      const gcpfResponse = new _stream.default.PassThrough();
-
-      gcpfResponse.set = (name, value) => {
-        response.headers[name] = value;
-      };
-
-      gcpfResponse.status = code => {
-        response.status = code;
-      };
-
-      handler(gcpfRequest, gcpfResponse).catch(reject);
-      const chunks = [];
-      gcpfResponse.once('end', () => {
-        response.data = Buffer.concat(chunks).toString();
-        resolve();
-      });
-      gcpfResponse.once('error', reject);
-      gcpfResponse.on('readable', () => {
-        let data;
-
-        while (data = gcpfResponse.read()) {
-          chunks.push(data);
+export default extra(definition, autoService(initTestHTTPLambdaCommand));
+async function initTestHTTPLambdaCommand({ NODE_ENV, PROJECT_DIR, API, log, args, }) {
+    return async () => {
+        const { namedArguments: { name, type, contentType, parameters: rawParameters }, } = readArgs(definition.arguments, args);
+        const handler = await loadLambda({ PROJECT_DIR, log }, NODE_ENV, name, type);
+        const OPERATION = (await dereferenceOpenAPIOperations(API, getOpenAPIOperations(API))).find(({ operationId }) => operationId === name);
+        if (!OPERATION) {
+            throw new YError('E_OPERATION_NOT_FOUND');
         }
-      });
-    });
-    log('info', 'SUCCESS:', response);
-  };
+        const hasBody = !!OPERATION.requestBody;
+        const parameters = JSON.parse(rawParameters);
+        const search = (OPERATION.parameters || [])
+            .filter((p) => p.in === 'query')
+            .reduce((accSearch, p) => {
+            if (null != parameters[p.name]) {
+                return (accSearch +
+                    (accSearch ? '&' : '') +
+                    p.name +
+                    '=' +
+                    parameters[p.name]);
+            }
+            return accSearch;
+        }, '');
+        const path = OPERATION.path
+            .split(PATH_SEPARATOR)
+            .map((part) => {
+            const matches = /^\{([\d\w]+)\}$/i.exec(part);
+            if (matches) {
+                return parameters[matches[1]];
+            }
+            return part;
+        })
+            .join(PATH_SEPARATOR);
+        const gcpfRequest = {
+            method: OPERATION.method,
+            originalUrl: path + (search ? SEARCH_SEPARATOR + search : ''),
+            headers: (OPERATION.parameters || [])
+                .filter((p) => p.in === 'header')
+                .reduce((headerParameters, p) => {
+                headerParameters[p.name] = parameters[camelCase(p.name)];
+                return headerParameters;
+            }, {}),
+            rawBody: Buffer.from(hasBody
+                ? contentType === 'application/json'
+                    ? parameters.body
+                        ? JSON.stringify(parameters.body)
+                        : ''
+                    : parameters.body || ''
+                : ''),
+        };
+        if (hasBody) {
+            gcpfRequest.headers['content-type'] = `${contentType};charset=UTF-8`;
+        }
+        log('info', 'GCPF_REQUEST:', gcpfRequest);
+        const response = {
+            status: 0,
+            headers: {},
+            data: '',
+        };
+        await new Promise((resolve, reject) => {
+            const gcpfResponse = new stream.PassThrough();
+            gcpfResponse.set = (name, value) => {
+                response.headers[name] = value;
+            };
+            gcpfResponse.status = (code) => {
+                response.status = code;
+            };
+            handler(gcpfRequest, gcpfResponse).catch(reject);
+            const chunks = [];
+            gcpfResponse.once('end', () => {
+                response.data = Buffer.concat(chunks).toString();
+                resolve();
+            });
+            gcpfResponse.once('error', reject);
+            gcpfResponse.on('readable', () => {
+                let data;
+                while ((data = gcpfResponse.read())) {
+                    chunks.push(data);
+                }
+            });
+        });
+        log('info', 'SUCCESS:', response);
+    };
 }
 //# sourceMappingURL=testHTTPFunction.js.map

package/dist/commands/testHTTPFunction.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/commands/testHTTPFunction.ts"],"names":["SEARCH_SEPARATOR","PATH_SEPARATOR","definition","description","example","arguments","type","additionalProperties","required","properties","name","enum","default","contentType","parameters","initTestHTTPLambdaCommand","NODE_ENV","PROJECT_DIR","API","log","args","rawParameters","handler","OPERATION","find","operationId","YError","hasBody","requestBody","JSON","parse","search","filter","p","in","reduce","accSearch","path","split","map","part","matches","exec","join","gcpfRequest","method","originalUrl","headers","headerParameters","rawBody","Buffer","from","body","stringify","response","status","data","Promise","resolve","reject","gcpfResponse","stream","PassThrough","set","value","code","catch","chunks","once","concat","toString","on","read","push"],"mappings":";;;;;;;AAAA;;AACA;;AACA;;AACA;;AACA;;AAIA;;AACA;;;;AASA,MAAMA,gBAAgB,GAAG,GAAzB;AACA,MAAMC,cAAc,GAAG,GAAvB;AAEO,MAAMC,UAAkC,GAAG;AAChDC,EAAAA,WAAW,EAAE,uCADmC;AAEhDC,EAAAA,OAAO,EAAG,qCAFsC;AAGhDC,EAAAA,SAAS,EAAE;AACTC,IAAAA,IAAI,EAAE,QADG;AAETC,IAAAA,oBAAoB,EAAE,KAFb;AAGTC,IAAAA,QAAQ,EAAE,CAAC,MAAD,CAHD;AAITC,IAAAA,UAAU,EAAE;AACVC,MAAAA,IAAI,EAAE;AACJP,QAAAA,WAAW,EAAE,0BADT;AAEJG,QAAAA,IAAI,EAAE;AAFF,OADI;AAKVA,MAAAA,IAAI,EAAE;AACJH,QAAAA,WAAW,EAAE,wBADT;AAEJG,QAAAA,IAAI,EAAE,QAFF;AAGJK,QAAAA,IAAI,EAAE,CAAC,MAAD,EAAS,OAAT,CAHF;AAIJC,QAAAA,OAAO,EAAE;AAJL,OALI;AAWVC,MAAAA,WAAW,EAAE;AACXV,QAAAA,WAAW,EAAE,6BADF;AAEXG,QAAAA,IAAI,EAAE,QAFK;AAGXM,QAAAA,OAAO,EAAE;AAHE,OAXH;AAgBVE,MAAAA,UAAU,EAAE;AACVX,QAAAA,WAAW,EAAE,0BADH;AAEVG,QAAAA,IAAI,EAAE,QAFI;AAGVM,QAAAA,OAAO,EAAE;AAHC;AAhBF;AAJH;AAHqC,CAA3C;;;eAgCQ,uBAAMV,UAAN,EAAkB,yBAAYa,yBAAZ,6EAAlB,C;;;;AAEf,eAAeA,yBAAf,CAAyC;AACvCC,EAAAA,QADuC;AAEvCC,EAAAA,WAFuC;AAGvCC,EAAAA,GAHuC;AAIvCC,EAAAA,GAJuC;AAKvCC,EAAAA;AALuC,CAAzC,EAYG;AACD,SAAO,YAAY;AACjB,UAAM;AACJV,MAAAA,IADI;AAEJJ,MAAAA,IAFI;AAGJO,MAAAA,WAHI;AAIJC,MAAAA,UAAU,EAAEO;AAJR,QAKqB,mBAASnB,UAAU,CAACG,SAApB,EAA+Be,IAA/B,CAL3B;AAWA,UAAME,OAAO,GAAG,MAAM,uBACpB;AAAEL,MAAAA,WAAF;AAAeE,MAAAA;AAAf,KADoB,EAEpBH,QAFoB,EAGpBN,IAHoB,EAIpBJ,IAJoB,CAAtB;AAMA,UAAMiB,SAAS,GAAG,CAChB,MAAM,8CAA6BL,GAA7B,EAAkC,sCAAqBA,GAArB,CAAlC,CADU,EAEhBM,IAFgB,CAEX,CAAC;AAAEC,MAAAA;AAAF,KAAD,KAAqBA,WAAW,KAAKf,IAF1B,CAAlB;;AAIA,QAAI,CAACa,SAAL,EAAgB;AACd,YAAM,IAAIG,eAAJ,CAAW,uBAAX,CAAN;AACD;;AAED,UAAMC,OAAO,GAAG,CAAC,CAACJ,SAAS,CAACK,WAA5B;AACA,UAAMd,UAAU,GAAGe,IAAI,CAACC,KAAL,CAAWT,aAAX,CAAnB;AACA,UAAMU,MAAM,GAAG,CAAER,SAAS,CAACT,UAAV,IAAwB,EAA1B,EACZkB,MADY,CACJC,CAAD,IAAOA,CAAC,CAACC,EAAF,KAAS,OADX,EAEZC,MAFY,CAEL,CAACC,SAAD,EAAYH,CAAZ,KAAkB;AACxB,UAAI,QAAQnB,UAAU,CAACmB,CAAC,CAACvB,IAAH,CAAtB,EAAgC;AAC9B,eACE0B,SAAS,IACRA,SAAS,GAAG,GAAH,GAAS,EADV,CAAT,GAEAH,CAAC,CAACvB,IAFF,GAGA,GAHA,GAIAI,UAAU,CAACmB,CAAC,CAACvB,IAAH,CALZ;AAOD;;AACD,aAAO0B,SAAP;AACD,KAbY,EAaV,EAbU,CAAf;AAeA,UAAMC,IAAI,GAAGd,SAAS,CAACc,IAAV,CACVC,KADU,CACJrC,cADI,EAGVsC,GAHU,CAGLC,IAAD,IAAU;AACb,YAAMC,OAAO,GAAG,mBAAmBC,IAAnB,CAAwBF,IAAxB,CAAhB;;AAEA,UAAIC,OAAJ,EAAa;AACX,eAAO3B,UAAU,CAAC2B,OAAO,CAAC,CAAD,CAAR,CAAjB;AACD;;AACD,aAAOD,IAAP;AACD,KAVU,EAWVG,IAXU,CAWL1C,cAXK,CAAb;AAYA,UAAM2C,WAAW,GAAG;AAClBC,MAAAA,MAAM,EAAEtB,SAAS,CAACsB,MADA;AAElBC,MAAAA,WAAW,EAAET,IAAI,IAAIN,MAAM,GAAG/B,gBAAgB,GAAG+B,MAAtB,GAA+B,EAAzC,CAFC;AAGlBgB,MAAAA,OAAO,EAAE,CAAExB,SAAS,CAACT,UAAV,IAAwB,EAA1B,EACNkB,MADM,CACEC,CAAD,IAAOA,CAAC,CAACC,EAAF,KAAS,QADjB,EAENC,MAFM,CAEC,CAACa,gBAAD,EAAmBf,CAAnB,KAAyB;AAC/Be,QAAAA,gBAAgB,CAACf,CAAC,CAACvB,IAAH,CAAhB,GAA2BI,UAAU,CAAC,wBAAUmB,CAAC,CAACvB,IAAZ,CAAD,CAArC;AACA,eAAOsC,gBAAP;AACD,OALM,EAKJ,EALI,CAHS;AASlBC,MAAAA,OAAO,EAAEC,MAAM,CAACC,IAAP,CACPxB,OAAO,GACHd,WAAW,KAAK,kBAAhB,GACEC,UAAU,CAACsC,IAAX,GACEvB,IAAI,CAACwB,SAAL,CAAevC,UAAU,CAACsC,IAA1B,CADF,GAEE,EAHJ,GAIEtC,UAAU,CAACsC,IAAX,IAAmB,EALlB,GAMH,EAPG;AATS,KAApB;;AAmBA,QAAIzB,OAAJ,EAAa;AACXiB,MAAAA,WAAW,CAACG,OAAZ,CAAoB,cAApB,IAAuC,GAAElC,WAAY,gBAArD;AACD;;AACDM,IAAAA,GAAG,CAAC,MAAD,EAAS,eAAT,EAA0ByB,WAA1B,CAAH;AAEA,UAAMU,QAAQ,GAAG;AACfC,MAAAA,MAAM,EAAE,CADO;AAEfR,MAAAA,OAAO,EAAE,EAFM;AAGfS,MAAAA,IAAI,EAAE;AAHS,KAAjB;AAKA,UAAM,IAAIC,OAAJ,CAAkB,CAACC,OAAD,EAAUC,MAAV,KAAqB;AAC3C,YAAMC,YAAiB,GAAG,IAAIC,gBAAOC,WAAX,EAA1B;;AAEAF,MAAAA,YAAY,CAACG,GAAb,GAAmB,CAACrD,IAAD,EAAesD,KAAf,KAAiC;AAClDV,QAAAA,QAAQ,CAACP,OAAT,CAAiBrC,IAAjB,IAAyBsD,KAAzB;AACD,OAFD;;AAGAJ,MAAAA,YAAY,CAACL,MAAb,GAAuBU,IAAD,IAAkB;AACtCX,QAAAA,QAAQ,CAACC,MAAT,GAAkBU,IAAlB;AACD,OAFD;;AAIA3C,MAAAA,OAAO,CAACsB,WAAD,EAAcgB,YAAd,CAAP,CAAmCM,KAAnC,CAAyCP,MAAzC;AAEA,YAAMQ,MAAM,GAAG,EAAf;AAEAP,MAAAA,YAAY,CAACQ,IAAb,CAAkB,KAAlB,EAAyB,MAAM;AAC7Bd,QAAAA,QAAQ,CAACE,IAAT,GAAgBN,MAAM,CAACmB,MAAP,CAAcF,MAAd,EAAsBG,QAAtB,EAAhB;AACAZ,QAAAA,OAAO;AACR,OAHD;AAIAE,MAAAA,YAAY,CAACQ,IAAb,CAAkB,OAAlB,EAA2BT,MAA3B;AACAC,MAAAA,YAAY,CAACW,EAAb,CAAgB,UAAhB,EAA4B,MAAM;AAChC,YAAIf,IAAJ;;AACA,eAAQA,IAAI,GAAGI,YAAY,CAACY,IAAb,EAAf,EAAqC;AACnCL,UAAAA,MAAM,CAACM,IAAP,CAAYjB,IAAZ;AACD;AACF,OALD;AAMD,KAzBK,CAAN;AA0BArC,IAAAA,GAAG,CAAC,MAAD,EAAS,UAAT,EAAqBmC,QAArB,CAAH;AACD,GA/GD;AAgHD","sourcesContent":["import { loadLambda } from '../libs/utils';\nimport { extra, autoService } from 'knifecycle';\nimport { readArgs } from '@whook/cli';\nimport YError from 'yerror';\nimport {\n  dereferenceOpenAPIOperations,\n  getOpenAPIOperations,\n} from '@whook/http-router';\nimport stream from 'stream';\nimport camelCase from 'camelcase';\nimport type {\n  WhookCommandArgs,\n  WhookCommandDefinition,\n  WhookCommandNamedArgs,\n} from '@whook/cli';\nimport type { LogService } from 'common-services';\nimport type { OpenAPIV3 } from 'openapi-types';\n\nconst SEARCH_SEPARATOR = '?';\nconst PATH_SEPARATOR = '/';\n\nexport const definition: WhookCommandDefinition = {\n  description: 'A command for testing AWS HTTP lambda',\n  example: `whook testHTTPLambda --name getPing`,\n  arguments: {\n    type: 'object',\n    additionalProperties: false,\n    required: ['name'],\n    properties: {\n      name: {\n        description: 'Name of the lamda to run',\n        type: 'string',\n      },\n      type: {\n        description: 'Type of lambda to test',\n        type: 'string',\n        enum: ['main', 'index'],\n        default: 'index',\n      },\n      contentType: {\n        description: 'Content type of the payload',\n        type: 'string',\n        default: 'application/json',\n      },\n      parameters: {\n        description: 'The HTTP call parameters',\n        type: 'string',\n        default: '{}',\n      },\n    },\n  },\n};\n\nexport default extra(definition, autoService(initTestHTTPLambdaCommand));\n\nasync function initTestHTTPLambdaCommand({\n  NODE_ENV,\n  PROJECT_DIR,\n  API,\n  log,\n  args,\n}: {\n  NODE_ENV: string;\n  PROJECT_DIR: string;\n  API: OpenAPIV3.Document;\n  log: LogService;\n  args: WhookCommandArgs;\n}) {\n  return async () => {\n    const {\n      name,\n      type,\n      contentType,\n      parameters: rawParameters,\n    }: WhookCommandNamedArgs = readArgs(definition.arguments, args) as {\n      name: string;\n      type: string;\n      contentType: string;\n      parameters: string;\n    };\n    const handler = await loadLambda(\n      { PROJECT_DIR, log },\n      NODE_ENV,\n      name,\n      type,\n    );\n    const OPERATION = (\n      await dereferenceOpenAPIOperations(API, getOpenAPIOperations(API))\n    ).find(({ operationId }) => operationId === name);\n\n    if (!OPERATION) {\n      throw new YError('E_OPERATION_NOT_FOUND');\n    }\n\n    const hasBody = !!OPERATION.requestBody;\n    const parameters = JSON.parse(rawParameters);\n    const search = ((OPERATION.parameters || []) as OpenAPIV3.ParameterObject[])\n      .filter((p) => p.in === 'query')\n      .reduce((accSearch, p) => {\n        if (null != parameters[p.name]) {\n          return (\n            accSearch +\n            (accSearch ? '&' : '') +\n            p.name +\n            '=' +\n            parameters[p.name]\n          );\n        }\n        return accSearch;\n      }, '');\n\n    const path = OPERATION.path\n      .split(PATH_SEPARATOR)\n\n      .map((part) => {\n        const matches = /^\\{([\\d\\w]+)\\}$/i.exec(part);\n\n        if (matches) {\n          return parameters[matches[1]];\n        }\n        return part;\n      })\n      .join(PATH_SEPARATOR);\n    const gcpfRequest = {\n      method: OPERATION.method,\n      originalUrl: path + (search ? SEARCH_SEPARATOR + search : ''),\n      headers: ((OPERATION.parameters || []) as OpenAPIV3.ParameterObject[])\n        .filter((p) => p.in === 'header')\n        .reduce((headerParameters, p) => {\n          headerParameters[p.name] = parameters[camelCase(p.name)];\n          return headerParameters;\n        }, {}),\n      rawBody: Buffer.from(\n        hasBody\n          ? contentType === 'application/json'\n            ? parameters.body\n              ? JSON.stringify(parameters.body)\n              : ''\n            : parameters.body || ''\n          : '',\n      ),\n    };\n    if (hasBody) {\n      gcpfRequest.headers['content-type'] = `${contentType};charset=UTF-8`;\n    }\n    log('info', 'GCPF_REQUEST:', gcpfRequest);\n\n    const response = {\n      status: 0,\n      headers: {},\n      data: '',\n    };\n    await new Promise<void>((resolve, reject) => {\n      const gcpfResponse: any = new stream.PassThrough();\n\n      gcpfResponse.set = (name: string, value: string) => {\n        response.headers[name] = value;\n      };\n      gcpfResponse.status = (code: number) => {\n        response.status = code;\n      };\n\n      handler(gcpfRequest, gcpfResponse).catch(reject);\n\n      const chunks = [];\n\n      gcpfResponse.once('end', () => {\n        response.data = Buffer.concat(chunks).toString();\n        resolve();\n      });\n      gcpfResponse.once('error', reject);\n      gcpfResponse.on('readable', () => {\n        let data;\n        while ((data = gcpfResponse.read())) {\n          chunks.push(data);\n        }\n      });\n    });\n    log('info', 'SUCCESS:', response);\n  };\n}\n"],"file":"testHTTPFunction.js"}
+{"version":3,"file":"testHTTPFunction.js","sourceRoot":"","sources":["../../src/commands/testHTTPFunction.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAC9C,OAAO,EAAE,KAAK,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAChD,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAChC,OAAO,EACL,4BAA4B,EAC5B,oBAAoB,GACrB,MAAM,oBAAoB,CAAC;AAC5B,OAAO,MAAM,MAAM,QAAQ,CAAC;AAC5B,OAAO,SAAS,MAAM,WAAW,CAAC;AAKlC,MAAM,gBAAgB,GAAG,GAAG,CAAC;AAC7B,MAAM,cAAc,GAAG,GAAG,CAAC;AAE3B,MAAM,CAAC,MAAM,UAAU,GAA2B;IAChD,WAAW,EAAE,uCAAuC;IACpD,OAAO,EAAE,qCAAqC;IAC9C,SAAS,EAAE;QACT,IAAI,EAAE,QAAQ;QACd,oBAAoB,EAAE,KAAK;QAC3B,QAAQ,EAAE,CAAC,MAAM,CAAC;QAClB,UAAU,EAAE;YACV,IAAI,EAAE;gBACJ,WAAW,EAAE,0BAA0B;gBACvC,IAAI,EAAE,QAAQ;aACf;YACD,IAAI,EAAE;gBACJ,WAAW,EAAE,wBAAwB;gBACrC,IAAI,EAAE,QAAQ;gBACd,IAAI,EAAE,CAAC,MAAM,EAAE,OAAO,CAAC;gBACvB,OAAO,EAAE,OAAO;aACjB;YACD,WAAW,EAAE;gBACX,WAAW,EAAE,6BAA6B;gBAC1C,IAAI,EAAE,QAAQ;gBACd,OAAO,EAAE,kBAAkB;aAC5B;YACD,UAAU,EAAE;gBACV,WAAW,EAAE,0BAA0B;gBACvC,IAAI,EAAE,QAAQ;gBACd,OAAO,EAAE,IAAI;aACd;SACF;KACF;CACF,CAAC;AAEF,eAAe,KAAK,CAAC,UAAU,EAAE,WAAW,CAAC,yBAAyB,CAAC,CAAC,CAAC;AAEzE,KAAK,UAAU,yBAAyB,CAAC,EACvC,QAAQ,EACR,WAAW,EACX,GAAG,EACH,GAAG,EACH,IAAI,GAOL;IACC,OAAO,KAAK,IAAI,EAAE;QAChB,MAAM,EACJ,cAAc,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,WAAW,EAAE,UAAU,EAAE,aAAa,EAAE,GACvE,GAAG,QAAQ,CAKT,UAAU,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC;QAC/B,MAAM,OAAO,GAAG,MAAM,UAAU,CAC9B,EAAE,WAAW,EAAE,GAAG,EAAE,EACpB,QAAQ,EACR,IAAI,EACJ,IAAI,CACL,CAAC;QACF,MAAM,SAAS,GAAG,CAChB,MAAM,4BAA4B,CAAC,GAAG,EAAE,oBAAoB,CAAC,GAAG,CAAC,CAAC,CACnE,CAAC,IAAI,CAAC,CAAC,EAAE,WAAW,EAAE,EAAE,EAAE,CAAC,WAAW,KAAK,IAAI,CAAC,CAAC;QAElD,IAAI,CAAC,SAAS,EAAE;YACd,MAAM,IAAI,MAAM,CAAC,uBAAuB,CAAC,CAAC;SAC3C;QAED,MAAM,OAAO,GAAG,CAAC,CAAC,SAAS,CAAC,WAAW,CAAC;QACxC,MAAM,UAAU,GAAG,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC;QAC7C,MAAM,MAAM,GAAI,CAAC,SAAS,CAAC,UAAU,IAAI,EAAE,CAAiC;aACzE,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,OAAO,CAAC;aAC/B,MAAM,CAAC,CAAC,SAAS,EAAE,CAAC,EAAE,EAAE;YACvB,IAAI,IAAI,IAAI,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE;gBAC9B,OAAO,CACL,SAAS;oBACT,CAAC,SAAS,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;oBACtB,CAAC,CAAC,IAAI;oBACN,GAAG;oBACH,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,CACnB,CAAC;aACH;YACD,OAAO,SAAS,CAAC;QACnB,CAAC,EAAE,EAAE,CAAC,CAAC;QAET,MAAM,IAAI,GAAG,SAAS,CAAC,IAAI;aACxB,KAAK,CAAC,cAAc,CAAC;aAErB,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE;YACZ,MAAM,OAAO,GAAG,kBAAkB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAE9C,IAAI,OAAO,EAAE;gBACX,OAAO,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC;aAC/B;YACD,OAAO,IAAI,CAAC;QACd,CAAC,CAAC;aACD,IAAI,CAAC,cAAc,CAAC,CAAC;QACxB,MAAM,WAAW,GAAG;YAClB,MAAM,EAAE,SAAS,CAAC,MAAM;YACxB,WAAW,EAAE,IAAI,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,gBAAgB,GAAG,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC;YAC7D,OAAO,EAAG,CAAC,SAAS,CAAC,UAAU,IAAI,EAAE,CAAiC;iBACnE,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,QAAQ,CAAC;iBAChC,MAAM,CAAC,CAAC,gBAAgB,EAAE,CAAC,EAAE,EAAE;gBAC9B,gBAAgB,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;gBACzD,OAAO,gBAAgB,CAAC;YAC1B,CAAC,EAAE,EAAE,CAAC;YACR,OAAO,EAAE,MAAM,CAAC,IAAI,CAClB,OAAO;gBACL,CAAC,CAAC,WAAW,KAAK,kBAAkB;oBAClC,CAAC,CAAC,UAAU,CAAC,IAAI;wBACf,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,IAAI,CAAC;wBACjC,CAAC,CAAC,EAAE;oBACN,CAAC,CAAC,UAAU,CAAC,IAAI,IAAI,EAAE;gBACzB,CAAC,CAAC,EAAE,CACP;SACF,CAAC;QACF,IAAI,OAAO,EAAE;YACX,WAAW,CAAC,OAAO,CAAC,cAAc,CAAC,GAAG,GAAG,WAAW,gBAAgB,CAAC;SACtE;QACD,GAAG,CAAC,MAAM,EAAE,eAAe,EAAE,WAAgC,CAAC,CAAC;QAE/D,MAAM,QAAQ,GAAG;YACf,MAAM,EAAE,CAAC;YACT,OAAO,EAAE,EAAE;YACX,IAAI,EAAE,EAAE;SACT,CAAC;QACF,MAAM,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YAC1C,MAAM,YAAY,GAAG,IAAI,MAAM,CAAC,WAAW,EAAE,CAAC;YAE7C,YAAoB,CAAC,GAAG,GAAG,CAAC,IAAY,EAAE,KAAa,EAAQ,EAAE;gBAChE,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC;YACjC,CAAC,CAAC;YACD,YAAoB,CAAC,MAAM,GAAG,CAAC,IAAY,EAAQ,EAAE;gBACpD,QAAQ,CAAC,MAAM,GAAG,IAAI,CAAC;YACzB,CAAC,CAAC;YAEF,OAAO,CAAC,WAAW,EAAE,YAAY,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;YAEjD,MAAM,MAAM,GAAG,EAAc,CAAC;YAE9B,YAAY,CAAC,IAAI,CAAC,KAAK,EAAE,GAAG,EAAE;gBAC5B,QAAQ,CAAC,IAAI,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,QAAQ,EAAE,CAAC;gBACjD,OAAO,EAAE,CAAC;YACZ,CAAC,CAAC,CAAC;YACH,YAAY,CAAC,IAAI,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;YACnC,YAAY,CAAC,EAAE,CAAC,UAAU,EAAE,GAAG,EAAE;gBAC/B,IAAI,IAAY,CAAC;gBACjB,OAAO,CAAC,IAAI,GAAG,YAAY,CAAC,IAAI,EAAE,CAAC,EAAE;oBACnC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;iBACnB;YACH,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QACH,GAAG,CAAC,MAAM,EAAE,UAAU,EAAE,QAAQ,CAAC,CAAC;IACpC,CAAC,CAAC;AACJ,CAAC"}

package/dist/index.d.ts

@@ -1,10 +1,7 @@
-import Knifecycle from 'knifecycle';
-import type { Dependencies } from 'knifecycle';
+import { Knifecycle } from 'knifecycle';
 import type { WhookCompilerOptions } from '@whook/whook';
-import type { BuildOptions } from 'knifecycle/dist/build';
 export declare const DEFAULT_BUILD_PARALLELISM = 10;
-export declare type WhookBuildConfig = {
-    BUILD_OPTIONS?: BuildOptions;
+export declare type WhookGCPBuildConfig = {
     BUILD_PARALLELISM?: number;
 };
 export declare type WhookAPIOperationGCPFunctionConfig = {
@@ -14,5 +11,5 @@ export declare type WhookAPIOperationGCPFunctionConfig = {
     compilerOptions?: WhookCompilerOptions;
     suffix?: string;
 };
-export declare function prepareBuildEnvironment<T extends Knifecycle<Dependencies>>($?: T): Promise<T>;
+export declare function prepareBuildEnvironment<T extends Knifecycle>($?: T): Promise<T>;
 export declare function runBuild(aPrepareBuildEnvironment: typeof prepareBuildEnvironment): Promise<void>;