@whook/gcp-functions 8.3.0

package/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+Copyright © 2017 Nicolas Froidure
+
+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,187 @@
+[//]: # ( )
+[//]: # (This file is automatically generated by a `metapak`)
+[//]: # (module. Do not change it  except between the)
+[//]: # (`content:start/end` flags, your changes would)
+[//]: # (be overridden.)
+[//]: # ( )
+# @whook/gcp-functions
+> 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)
+
+This module is aimed to help you to build and deploy your
+[Whook](https://github.com/nfroidure/whook) server to
+[Google Cloud Functions](https://cloud.google.com/functions).
+
+You can find a complete setup with a Terraform deployment example in
+[this pull request](https://github.com/nfroidure/whook/pull/66).
+
+## Quick setup
+
+Install this module and its peer dependencies :
+
+```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:
+
+```diff
+- import YError from 'yerror';
++import {
++  runBuild as runBaseBuild,
++  prepareBuildEnvironment as prepareBaseBuildEnvironment,
++} from '@whook/gcp-functions';
+
+// (...)
+
+export async function prepareEnvironment(
+  $: Knifecycle = new Knifecycle(),
+): Promise<Knifecycle> {
+
+  // (...)
+
+  // Setup your own whook plugins or avoid whook defaults by leaving it empty
+-  $.register(constant('WHOOK_PLUGINS', ['@whook/cli', '@whook/whook']));
++  $.register(constant('WHOOK_PLUGINS', [
++    '@whook/gcp-functions',
++    '@whook/cli',
++    '@whook/whook',
++  ]));
+
+  // (...)
+
+}
+
+// (...)
+
+// 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(
+  $: Knifecycle = new Knifecycle(),
+): Promise<Knifecycle> {
+  $ = await prepareEnvironment($);
+
+  // (...)
+
+-  // Usually, here you call the installed build env
+-  // $ = await prepareBaseBuildEnvironment($);
++  // Calling the GCP specific build env
++  $ = await prepareBaseBuildEnvironment($);
+
+
+  // The build often need to know were initializers
+  //  can be found to create a static build and
+  //  remove the need to create an injector
+  $.register(
+    constant('INITIALIZER_PATH_MAP', {
+      // (...)
+      obfuscator: '@whook/http-transaction/dist/services/obfuscator',
+-      log: 'common-services/dist/log',
++      log: '@whook/gcp-functions/dist/services/log',
+      time: 'common-services/dist/time',
+      delay: 'common-services/dist/delay',
+    }),
+  );
+
+  // (...)
+
+}
+```
+
+And add the GCP Functions config (usually in `src/config/common/config.js`):
+
+```diff
++ import type { WhookCompilerConfig } from '@whook/whook';
++ import type {
++   WhookAPIOperationGCPFunctionConfig
++ } from '@whook/gcp-functions';
+
+// ...
+
+export type AppConfigs = WhookConfigs &
++  WhookCompilerConfig &
+  APIConfig;
+
+const CONFIG: AppConfigs = {
+  // ...
++  COMPILER_OPTIONS: {
++    externalModules: [],
++    ignoredModules: [],
++    target: '12', // Node 14 is in public review
++  },
+};
+
+// Export custom handlers definitions
+export type APIHandlerDefinition = WhookAPIHandlerDefinition<
++  WhookAPIOperationGCPFunctionConfig &
+  WhookAPIOperationSwaggerConfig
+>;
+
+export default CONFIG;
+```
+
+# Build
+
+To build your functions :
+
+```sh
+# Build all functions
+npm run compile && npm run build
+
+# Build only one function
+npm run compile && npm run build -- getPing
+```
+
+# Debug
+
+You can easily test your function builds by adding `@whook/gcp-functions` to
+your `WHOOK_PLUGINS` list. It provides you some commands like the
+`testHTTPFunction` one:
+
+```sh
+npx whook testHTTPFunction --name getPing
+```
+
+To get more insights when errors happens:
+
+```sh
+npm run whook-dev -- testHTTPFunction --name getPing
+```
+
+## Deployment
+
+We recommend using [Terraform](https://terraform.io) to deploy your functions.
+
+There is a complete example on how to deploy your functions
+[in this pull request](https://github.com/nfroidure/whook/pull/54).
+
+[//]: # (::contents:end)
+
+# API
+
+# Authors
+- [Nicolas Froidure](http://insertafter.com/en/index.html)
+
+# License
+[MIT](https://github.com/nfroidure/whook/blob/master/packages/whook-gcp-functions/LICENSE)

package/dist/commands/testHTTPFunction.d.ts

@@ -0,0 +1,12 @@
+import type { WhookCommandArgs, WhookCommandDefinition } from '@whook/cli';
+import type { LogService } from 'common-services';
+import type { OpenAPIV3 } from 'openapi-types';
+export declare const definition: WhookCommandDefinition;
+declare const _default: import("knifecycle").ServiceInitializer<{
+    NODE_ENV: string;
+    PROJECT_DIR: string;
+    API: OpenAPIV3.Document<{}>;
+    log: LogService;
+    args: WhookCommandArgs;
+}, () => Promise<void>>;
+export default _default;

package/dist/commands/testHTTPFunction.js

@@ -0,0 +1,156 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = exports.definition = 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 }; }
+
+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: '{}'
+      }
+    }
+  }
+};
+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);
+        }
+      });
+    });
+    log('info', 'SUCCESS:', response);
+  };
+}
+//# sourceMappingURL=testHTTPFunction.js.map

package/dist/commands/testHTTPFunction.js.map

@@ -0,0 +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"}

package/dist/commands/testHTTPFunction.mjs

@@ -0,0 +1,136 @@
+import { loadLambda } from '../libs/utils';
+import { extra, service as _service } 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 = '/';
+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: '{}'
+      }
+    }
+  }
+};
+export default extra(definition, _service(initTestHTTPLambdaCommand, "testHTTPLambdaCommand", ["NODE_ENV", "PROJECT_DIR", "API", "log", "args"]));
+
+async function initTestHTTPLambdaCommand({
+  NODE_ENV,
+  PROJECT_DIR,
+  API,
+  log,
+  args
+}) {
+  return async () => {
+    const {
+      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');
+    }
+
+    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.mjs.map

package/dist/commands/testHTTPFunction.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/commands/testHTTPFunction.ts"],"names":["loadLambda","extra","autoService","readArgs","YError","dereferenceOpenAPIOperations","getOpenAPIOperations","stream","camelCase","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","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","PassThrough","set","value","code","catch","chunks","once","concat","toString","on","read","push"],"mappings":"AAAA,SAASA,UAAT,QAA2B,eAA3B;AACA,SAASC,KAAT,EAAgBC,OAAW,IAAXA,QAAhB,QAAmC,YAAnC;AACA,SAASC,QAAT,QAAyB,YAAzB;AACA,OAAOC,MAAP,MAAmB,QAAnB;AACA,SACEC,4BADF,EAEEC,oBAFF,QAGO,oBAHP;AAIA,OAAOC,MAAP,MAAmB,QAAnB;AACA,OAAOC,SAAP,MAAsB,WAAtB;AASA,MAAMC,gBAAgB,GAAG,GAAzB;AACA,MAAMC,cAAc,GAAG,GAAvB;AAEA,OAAO,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;AAgCP,eAAepB,KAAK,CAACU,UAAD,EAAaT,QAAW,CAACsB,yBAAD,6EAAxB,CAApB;;AAEA,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,QAKqB3B,QAAQ,CAACQ,UAAU,CAACG,SAAZ,EAAuBe,IAAvB,CALnC;AAWA,UAAME,OAAO,GAAG,MAAM/B,UAAU,CAC9B;AAAE0B,MAAAA,WAAF;AAAeE,MAAAA;AAAf,KAD8B,EAE9BH,QAF8B,EAG9BN,IAH8B,EAI9BJ,IAJ8B,CAAhC;AAMA,UAAMiB,SAAS,GAAG,CAChB,MAAM3B,4BAA4B,CAACsB,GAAD,EAAMrB,oBAAoB,CAACqB,GAAD,CAA1B,CADlB,EAEhBM,IAFgB,CAEX,CAAC;AAAEC,MAAAA;AAAF,KAAD,KAAqBA,WAAW,KAAKf,IAF1B,CAAlB;;AAIA,QAAI,CAACa,SAAL,EAAgB;AACd,YAAM,IAAI5B,MAAJ,CAAW,uBAAX,CAAN;AACD;;AAED,UAAM+B,OAAO,GAAG,CAAC,CAACH,SAAS,CAACI,WAA5B;AACA,UAAMb,UAAU,GAAGc,IAAI,CAACC,KAAL,CAAWR,aAAX,CAAnB;AACA,UAAMS,MAAM,GAAG,CAAEP,SAAS,CAACT,UAAV,IAAwB,EAA1B,EACZiB,MADY,CACJC,CAAD,IAAOA,CAAC,CAACC,EAAF,KAAS,OADX,EAEZC,MAFY,CAEL,CAACC,SAAD,EAAYH,CAAZ,KAAkB;AACxB,UAAI,QAAQlB,UAAU,CAACkB,CAAC,CAACtB,IAAH,CAAtB,EAAgC;AAC9B,eACEyB,SAAS,IACRA,SAAS,GAAG,GAAH,GAAS,EADV,CAAT,GAEAH,CAAC,CAACtB,IAFF,GAGA,GAHA,GAIAI,UAAU,CAACkB,CAAC,CAACtB,IAAH,CALZ;AAOD;;AACD,aAAOyB,SAAP;AACD,KAbY,EAaV,EAbU,CAAf;AAeA,UAAMC,IAAI,GAAGb,SAAS,CAACa,IAAV,CACVC,KADU,CACJpC,cADI,EAGVqC,GAHU,CAGLC,IAAD,IAAU;AACb,YAAMC,OAAO,GAAG,mBAAmBC,IAAnB,CAAwBF,IAAxB,CAAhB;;AAEA,UAAIC,OAAJ,EAAa;AACX,eAAO1B,UAAU,CAAC0B,OAAO,CAAC,CAAD,CAAR,CAAjB;AACD;;AACD,aAAOD,IAAP;AACD,KAVU,EAWVG,IAXU,CAWLzC,cAXK,CAAb;AAYA,UAAM0C,WAAW,GAAG;AAClBC,MAAAA,MAAM,EAAErB,SAAS,CAACqB,MADA;AAElBC,MAAAA,WAAW,EAAET,IAAI,IAAIN,MAAM,GAAG9B,gBAAgB,GAAG8B,MAAtB,GAA+B,EAAzC,CAFC;AAGlBgB,MAAAA,OAAO,EAAE,CAAEvB,SAAS,CAACT,UAAV,IAAwB,EAA1B,EACNiB,MADM,CACEC,CAAD,IAAOA,CAAC,CAACC,EAAF,KAAS,QADjB,EAENC,MAFM,CAEC,CAACa,gBAAD,EAAmBf,CAAnB,KAAyB;AAC/Be,QAAAA,gBAAgB,CAACf,CAAC,CAACtB,IAAH,CAAhB,GAA2BI,UAAU,CAACf,SAAS,CAACiC,CAAC,CAACtB,IAAH,CAAV,CAArC;AACA,eAAOqC,gBAAP;AACD,OALM,EAKJ,EALI,CAHS;AASlBC,MAAAA,OAAO,EAAEC,MAAM,CAACC,IAAP,CACPxB,OAAO,GACHb,WAAW,KAAK,kBAAhB,GACEC,UAAU,CAACqC,IAAX,GACEvB,IAAI,CAACwB,SAAL,CAAetC,UAAU,CAACqC,IAA1B,CADF,GAEE,EAHJ,GAIErC,UAAU,CAACqC,IAAX,IAAmB,EALlB,GAMH,EAPG;AATS,KAApB;;AAmBA,QAAIzB,OAAJ,EAAa;AACXiB,MAAAA,WAAW,CAACG,OAAZ,CAAoB,cAApB,IAAuC,GAAEjC,WAAY,gBAArD;AACD;;AACDM,IAAAA,GAAG,CAAC,MAAD,EAAS,eAAT,EAA0BwB,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,IAAI7D,MAAM,CAAC8D,WAAX,EAA1B;;AAEAD,MAAAA,YAAY,CAACE,GAAb,GAAmB,CAACnD,IAAD,EAAeoD,KAAf,KAAiC;AAClDT,QAAAA,QAAQ,CAACP,OAAT,CAAiBpC,IAAjB,IAAyBoD,KAAzB;AACD,OAFD;;AAGAH,MAAAA,YAAY,CAACL,MAAb,GAAuBS,IAAD,IAAkB;AACtCV,QAAAA,QAAQ,CAACC,MAAT,GAAkBS,IAAlB;AACD,OAFD;;AAIAzC,MAAAA,OAAO,CAACqB,WAAD,EAAcgB,YAAd,CAAP,CAAmCK,KAAnC,CAAyCN,MAAzC;AAEA,YAAMO,MAAM,GAAG,EAAf;AAEAN,MAAAA,YAAY,CAACO,IAAb,CAAkB,KAAlB,EAAyB,MAAM;AAC7Bb,QAAAA,QAAQ,CAACE,IAAT,GAAgBN,MAAM,CAACkB,MAAP,CAAcF,MAAd,EAAsBG,QAAtB,EAAhB;AACAX,QAAAA,OAAO;AACR,OAHD;AAIAE,MAAAA,YAAY,CAACO,IAAb,CAAkB,OAAlB,EAA2BR,MAA3B;AACAC,MAAAA,YAAY,CAACU,EAAb,CAAgB,UAAhB,EAA4B,MAAM;AAChC,YAAId,IAAJ;;AACA,eAAQA,IAAI,GAAGI,YAAY,CAACW,IAAb,EAAf,EAAqC;AACnCL,UAAAA,MAAM,CAACM,IAAP,CAAYhB,IAAZ;AACD;AACF,OALD;AAMD,KAzBK,CAAN;AA0BApC,IAAAA,GAAG,CAAC,MAAD,EAAS,UAAT,EAAqBkC,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.mjs"}

package/dist/index.d.ts

@@ -0,0 +1,18 @@
+import Knifecycle from 'knifecycle';
+import type { Dependencies } 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;
+    BUILD_PARALLELISM?: number;
+};
+export declare type WhookAPIOperationGCPFunctionConfig = {
+    type?: 'http';
+    sourceOperationId?: string;
+    staticFiles?: string[];
+    compilerOptions?: WhookCompilerOptions;
+    suffix?: string;
+};
+export declare function prepareBuildEnvironment<T extends Knifecycle<Dependencies>>($?: T): Promise<T>;
+export declare function runBuild(aPrepareBuildEnvironment: typeof prepareBuildEnvironment): Promise<void>;