@dereekb/nestjs 12.6.21 → 13.0.0

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2023 Hapier Creative LLC.
+Copyright (c) 2025 Hapier Creative LLC.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/index.cjs.js

@@ -0,0 +1,292 @@
+'use strict';
+
+var common = require('@nestjs/common');
+var rawbody = require('raw-body');
+var querystring = require('querystring');
+var bodyParser = require('body-parser');
+var util = require('@dereekb/util');
+var config = require('@nestjs/config');
+
+/**
+ * Returns true if the request is from localhost:4200.
+ */
+const IsRequestFromLocalHost = common.createParamDecorator((data, context) => {
+  return isLocalhost(context);
+});
+function isLocalhost(context) {
+  const req = context.switchToHttp().getRequest();
+  const origin = req.headers['origin'] ?? '';
+  return origin.startsWith('http://localhost') || origin.startsWith('https://localhost');
+}
+
+const ParseRawBody = common.createParamDecorator(async (_, context) => {
+  const req = context.switchToHttp().getRequest();
+  if (!req.readable) {
+    console.error('RawBody request was not readable. This is generally due to bad configuration.');
+    throw new common.BadRequestException('Invalid body');
+  }
+  const body = await rawbody(req);
+  return body;
+});
+const RawBody = common.createParamDecorator(async (_, context) => {
+  const req = context.switchToHttp().getRequest();
+  const body = req.body;
+  if (!Buffer.isBuffer(body)) {
+    console.error('RawBody expected a buffer set to req.body.');
+    throw new common.InternalServerErrorException('failed parsing body');
+  }
+  return body;
+});
+const ParsedQueryRawBody = common.createParamDecorator(async (_, context) => {
+  const req = context.switchToHttp().getRequest();
+  req.body = RawBodyToParsedQueryString(req.body);
+  return req.body;
+});
+function RawBodyToJson(rawBody) {
+  const string = RawBodyToString(rawBody);
+  return JSON.parse(string);
+}
+function RawBodyToParsedQueryString(rawBody) {
+  const string = RawBodyToString(rawBody);
+  return querystring.parse(string);
+}
+function RawBodyToString(rawBody) {
+  return rawBody.toString('utf8').trim();
+}
+
+/******************************************************************************
+Copyright (c) Microsoft Corporation.
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
+AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
+OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+PERFORMANCE OF THIS SOFTWARE.
+***************************************************************************** */
+/* global Reflect, Promise, SuppressedError, Symbol, Iterator */
+
+
+function __decorate(decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+}
+
+function __param(paramIndex, decorator) {
+    return function (target, key) { decorator(target, key, paramIndex); }
+}
+
+function __metadata(metadataKey, metadataValue) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(metadataKey, metadataValue);
+}
+
+typeof SuppressedError === "function" ? SuppressedError : function (error, suppressed, message) {
+    var e = new Error(message);
+    return e.name = "SuppressedError", e.error = error, e.suppressed = suppressed, e;
+};
+
+exports.JsonBodyMiddleware = class JsonBodyMiddleware {
+  use(req, res, next) {
+    bodyParser.json()(req, res, next);
+  }
+};
+exports.JsonBodyMiddleware = __decorate([common.Injectable()], exports.JsonBodyMiddleware);
+
+exports.RawBodyMiddleware = class RawBodyMiddleware {
+  use(req, res, next) {
+    bodyParser.raw({
+      type: '*/*'
+    })(req, res, next);
+  }
+};
+exports.RawBodyMiddleware = __decorate([common.Injectable()], exports.RawBodyMiddleware);
+
+const DEFAULT_BASE_WEBHOOK_PATH = '/webhook';
+const DEFAULT_WEBHOOK_MIDDLEWARE_ROUTE_INFO = {
+  path: `${DEFAULT_BASE_WEBHOOK_PATH}/*`,
+  method: common.RequestMethod.POST
+};
+/**
+ * Convenience class that configures a nestjs module (typically the root app module) to apply the proper middleware for handling webhooks.
+ */
+class AppModuleWithWebhooksEnabled {
+  configure(consumer) {
+    consumeWebhooksWithRawBodyMiddleware(consumer);
+  }
+}
+/**
+ * Convenience class that extends AppWithWebhooksEnabled.
+ */
+exports.ConfigureWebhookMiddlewareModule = class ConfigureWebhookMiddlewareModule extends AppModuleWithWebhooksEnabled {
+  logger = new common.Logger('ConfigureWebhookMiddlewareModule');
+  configure(consumer) {
+    super.configure(consumer);
+    this.logger.debug('Configured webhook routes with proper middleware.');
+  }
+};
+exports.ConfigureWebhookMiddlewareModule = __decorate([common.Module({})], exports.ConfigureWebhookMiddlewareModule);
+/**
+ * Configures a MiddlewareConsumer to use RawBodyMiddleware for all POST requests to /webhook/*. All other routes are consumed with the JsonBodyMiddleware.
+ *
+ * This is required for various webhooks that require the full body to properly parse content.
+ *
+ * Be sure to also set bodyParsing: false in the nest app options.
+ *
+ * @param consumer
+ */
+function consumeWebhooksWithRawBodyMiddleware(consumer) {
+  // Configure the app to not parse the body for our webhook routes.
+  // https://stackoverflow.com/questions/54346465/access-raw-body-of-stripe-webhook-in-nest-js
+  consumer.apply(exports.RawBodyMiddleware).forRoutes(DEFAULT_WEBHOOK_MIDDLEWARE_ROUTE_INFO).apply(exports.JsonBodyMiddleware).forRoutes('*');
+}
+
+/**
+ * Merges two module metadata entries together.
+ *
+ * @param base
+ * @param additional
+ * @returns
+ */
+function mergeModuleMetadata(base, additional = {}) {
+  return {
+    controllers: util.mergeArrays([base.controllers, additional.controllers]),
+    imports: util.mergeArrays([base.imports, additional.imports]),
+    exports: util.mergeArrays([base.exports, additional.exports]),
+    providers: util.mergeArrays([base.providers, additional.providers])
+  };
+}
+function injectionTokensFromProviders(providers) {
+  return util.asArray(providers).map(x => {
+    return typeof x === 'object' ? x.provide : x;
+  });
+}
+
+/**
+ * Environment variable that specfies the ClientWebAppUrl for your application
+ */
+const CLIENT_WEB_APP_URL_ENV_VAR = 'CLIENT_WEB_APP_URL';
+
+class ClientAppServiceConfig {
+  client;
+  static assertValidConfig(config) {
+    if (!config.client.clientWebAppUrl) {
+      throw new Error('No client app url specified.');
+    }
+  }
+}
+
+/**
+ * Provides information about companion apps and websites for the project.
+ */
+exports.ClientAppService = class ClientAppService {
+  _config;
+  constructor(config) {
+    this._config = config;
+  }
+  get config() {
+    return this._config;
+  }
+  get webAppUrl() {
+    return this.config.client.clientWebAppUrl;
+  }
+  get webAppHost() {
+    return this.webAppUrl.split('://', 2)[1];
+  }
+};
+exports.ClientAppService = __decorate([common.Injectable(), __param(0, common.Inject(ClientAppServiceConfig)), __metadata("design:paramtypes", [ClientAppServiceConfig])], exports.ClientAppService);
+
+function clientAppConfigFactory(configService) {
+  const config = {
+    client: {
+      clientWebAppUrl: configService.get(CLIENT_WEB_APP_URL_ENV_VAR)
+    }
+  };
+  ClientAppServiceConfig.assertValidConfig(config);
+  return config;
+}
+exports.ClientAppModule = class ClientAppModule {};
+exports.ClientAppModule = __decorate([common.Module({
+  imports: [config.ConfigModule],
+  providers: [{
+    provide: ClientAppServiceConfig,
+    inject: [config.ConfigService],
+    useFactory: clientAppConfigFactory
+  }],
+  exports: [exports.ClientAppService]
+})], exports.ClientAppModule);
+
+/**
+ * A server environment configuration.
+ *
+ * Explicitly states whether or not this is a production environment, and optionally some other config.
+ *
+ * This config is not meant to replace other typical configurations, like .env files, but instead is part of the build system.
+ */
+class ServerEnvironmentConfig {}
+
+// MARK: Tokens
+/**
+ * Token to access a configured ServerEnvironmentServiceConfig for the app.
+ */
+const SERVER_ENV_TOKEN = 'SERVER_ENV_TOKEN';
+function serverEnvTokenProvider(env) {
+  return {
+    provide: SERVER_ENV_TOKEN,
+    useValue: env
+  };
+}
+
+/**
+ * Checks process.env.NODE_ENV for "test"
+ */
+function isTestNodeEnv() {
+  return process.env['NODE_ENV'] === 'test';
+}
+
+exports.ServerEnvironmentService = class ServerEnvironmentService {
+  env;
+  constructor(env) {
+    this.env = env;
+  }
+  get isTestingEnv() {
+    return isTestNodeEnv();
+  }
+  get isProduction() {
+    return this.env.production;
+  }
+  get isStaging() {
+    return Boolean(this.env.staging);
+  }
+  get developerToolsEnabled() {
+    return Boolean(!this.isProduction && this.env.developerToolsEnabled);
+  }
+};
+exports.ServerEnvironmentService = __decorate([common.Injectable(), __param(0, common.Inject(SERVER_ENV_TOKEN)), __metadata("design:paramtypes", [ServerEnvironmentConfig])], exports.ServerEnvironmentService);
+
+exports.AppModuleWithWebhooksEnabled = AppModuleWithWebhooksEnabled;
+exports.CLIENT_WEB_APP_URL_ENV_VAR = CLIENT_WEB_APP_URL_ENV_VAR;
+exports.ClientAppServiceConfig = ClientAppServiceConfig;
+exports.DEFAULT_BASE_WEBHOOK_PATH = DEFAULT_BASE_WEBHOOK_PATH;
+exports.DEFAULT_WEBHOOK_MIDDLEWARE_ROUTE_INFO = DEFAULT_WEBHOOK_MIDDLEWARE_ROUTE_INFO;
+exports.IsRequestFromLocalHost = IsRequestFromLocalHost;
+exports.ParseRawBody = ParseRawBody;
+exports.ParsedQueryRawBody = ParsedQueryRawBody;
+exports.RawBody = RawBody;
+exports.RawBodyToJson = RawBodyToJson;
+exports.RawBodyToParsedQueryString = RawBodyToParsedQueryString;
+exports.RawBodyToString = RawBodyToString;
+exports.SERVER_ENV_TOKEN = SERVER_ENV_TOKEN;
+exports.ServerEnvironmentConfig = ServerEnvironmentConfig;
+exports.clientAppConfigFactory = clientAppConfigFactory;
+exports.consumeWebhooksWithRawBodyMiddleware = consumeWebhooksWithRawBodyMiddleware;
+exports.injectionTokensFromProviders = injectionTokensFromProviders;
+exports.isLocalhost = isLocalhost;
+exports.isTestNodeEnv = isTestNodeEnv;
+exports.mergeModuleMetadata = mergeModuleMetadata;
+exports.serverEnvTokenProvider = serverEnvTokenProvider;

package/index.d.ts

@@ -0,0 +1 @@
+export * from "./src/index";

package/index.esm.js

@@ -0,0 +1,270 @@
+import { createParamDecorator, BadRequestException, InternalServerErrorException, Injectable, RequestMethod, Module, Logger, Inject } from '@nestjs/common';
+import rawbody from 'raw-body';
+import { parse } from 'querystring';
+import bodyParser from 'body-parser';
+import { asArray, mergeArrays } from '@dereekb/util';
+import { ConfigService, ConfigModule } from '@nestjs/config';
+
+/**
+ * Returns true if the request is from localhost:4200.
+ */
+const IsRequestFromLocalHost = createParamDecorator((data, context) => {
+  return isLocalhost(context);
+});
+function isLocalhost(context) {
+  const req = context.switchToHttp().getRequest();
+  const origin = req.headers['origin'] ?? '';
+  return origin.startsWith('http://localhost') || origin.startsWith('https://localhost');
+}
+
+const ParseRawBody = createParamDecorator(async (_, context) => {
+  const req = context.switchToHttp().getRequest();
+  if (!req.readable) {
+    console.error('RawBody request was not readable. This is generally due to bad configuration.');
+    throw new BadRequestException('Invalid body');
+  }
+  const body = await rawbody(req);
+  return body;
+});
+const RawBody = createParamDecorator(async (_, context) => {
+  const req = context.switchToHttp().getRequest();
+  const body = req.body;
+  if (!Buffer.isBuffer(body)) {
+    console.error('RawBody expected a buffer set to req.body.');
+    throw new InternalServerErrorException('failed parsing body');
+  }
+  return body;
+});
+const ParsedQueryRawBody = createParamDecorator(async (_, context) => {
+  const req = context.switchToHttp().getRequest();
+  req.body = RawBodyToParsedQueryString(req.body);
+  return req.body;
+});
+function RawBodyToJson(rawBody) {
+  const string = RawBodyToString(rawBody);
+  return JSON.parse(string);
+}
+function RawBodyToParsedQueryString(rawBody) {
+  const string = RawBodyToString(rawBody);
+  return parse(string);
+}
+function RawBodyToString(rawBody) {
+  return rawBody.toString('utf8').trim();
+}
+
+/******************************************************************************
+Copyright (c) Microsoft Corporation.
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
+AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
+OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+PERFORMANCE OF THIS SOFTWARE.
+***************************************************************************** */
+/* global Reflect, Promise, SuppressedError, Symbol, Iterator */
+
+
+function __decorate(decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+}
+
+function __param(paramIndex, decorator) {
+    return function (target, key) { decorator(target, key, paramIndex); }
+}
+
+function __metadata(metadataKey, metadataValue) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(metadataKey, metadataValue);
+}
+
+typeof SuppressedError === "function" ? SuppressedError : function (error, suppressed, message) {
+    var e = new Error(message);
+    return e.name = "SuppressedError", e.error = error, e.suppressed = suppressed, e;
+};
+
+let JsonBodyMiddleware = class JsonBodyMiddleware {
+  use(req, res, next) {
+    bodyParser.json()(req, res, next);
+  }
+};
+JsonBodyMiddleware = __decorate([Injectable()], JsonBodyMiddleware);
+
+let RawBodyMiddleware = class RawBodyMiddleware {
+  use(req, res, next) {
+    bodyParser.raw({
+      type: '*/*'
+    })(req, res, next);
+  }
+};
+RawBodyMiddleware = __decorate([Injectable()], RawBodyMiddleware);
+
+const DEFAULT_BASE_WEBHOOK_PATH = '/webhook';
+const DEFAULT_WEBHOOK_MIDDLEWARE_ROUTE_INFO = {
+  path: `${DEFAULT_BASE_WEBHOOK_PATH}/*`,
+  method: RequestMethod.POST
+};
+/**
+ * Convenience class that configures a nestjs module (typically the root app module) to apply the proper middleware for handling webhooks.
+ */
+class AppModuleWithWebhooksEnabled {
+  configure(consumer) {
+    consumeWebhooksWithRawBodyMiddleware(consumer);
+  }
+}
+/**
+ * Convenience class that extends AppWithWebhooksEnabled.
+ */
+let ConfigureWebhookMiddlewareModule = class ConfigureWebhookMiddlewareModule extends AppModuleWithWebhooksEnabled {
+  logger = new Logger('ConfigureWebhookMiddlewareModule');
+  configure(consumer) {
+    super.configure(consumer);
+    this.logger.debug('Configured webhook routes with proper middleware.');
+  }
+};
+ConfigureWebhookMiddlewareModule = __decorate([Module({})], ConfigureWebhookMiddlewareModule);
+/**
+ * Configures a MiddlewareConsumer to use RawBodyMiddleware for all POST requests to /webhook/*. All other routes are consumed with the JsonBodyMiddleware.
+ *
+ * This is required for various webhooks that require the full body to properly parse content.
+ *
+ * Be sure to also set bodyParsing: false in the nest app options.
+ *
+ * @param consumer
+ */
+function consumeWebhooksWithRawBodyMiddleware(consumer) {
+  // Configure the app to not parse the body for our webhook routes.
+  // https://stackoverflow.com/questions/54346465/access-raw-body-of-stripe-webhook-in-nest-js
+  consumer.apply(RawBodyMiddleware).forRoutes(DEFAULT_WEBHOOK_MIDDLEWARE_ROUTE_INFO).apply(JsonBodyMiddleware).forRoutes('*');
+}
+
+/**
+ * Merges two module metadata entries together.
+ *
+ * @param base
+ * @param additional
+ * @returns
+ */
+function mergeModuleMetadata(base, additional = {}) {
+  return {
+    controllers: mergeArrays([base.controllers, additional.controllers]),
+    imports: mergeArrays([base.imports, additional.imports]),
+    exports: mergeArrays([base.exports, additional.exports]),
+    providers: mergeArrays([base.providers, additional.providers])
+  };
+}
+function injectionTokensFromProviders(providers) {
+  return asArray(providers).map(x => {
+    return typeof x === 'object' ? x.provide : x;
+  });
+}
+
+/**
+ * Environment variable that specfies the ClientWebAppUrl for your application
+ */
+const CLIENT_WEB_APP_URL_ENV_VAR = 'CLIENT_WEB_APP_URL';
+
+class ClientAppServiceConfig {
+  client;
+  static assertValidConfig(config) {
+    if (!config.client.clientWebAppUrl) {
+      throw new Error('No client app url specified.');
+    }
+  }
+}
+
+/**
+ * Provides information about companion apps and websites for the project.
+ */
+let ClientAppService = class ClientAppService {
+  _config;
+  constructor(config) {
+    this._config = config;
+  }
+  get config() {
+    return this._config;
+  }
+  get webAppUrl() {
+    return this.config.client.clientWebAppUrl;
+  }
+  get webAppHost() {
+    return this.webAppUrl.split('://', 2)[1];
+  }
+};
+ClientAppService = __decorate([Injectable(), __param(0, Inject(ClientAppServiceConfig)), __metadata("design:paramtypes", [ClientAppServiceConfig])], ClientAppService);
+
+function clientAppConfigFactory(configService) {
+  const config = {
+    client: {
+      clientWebAppUrl: configService.get(CLIENT_WEB_APP_URL_ENV_VAR)
+    }
+  };
+  ClientAppServiceConfig.assertValidConfig(config);
+  return config;
+}
+let ClientAppModule = class ClientAppModule {};
+ClientAppModule = __decorate([Module({
+  imports: [ConfigModule],
+  providers: [{
+    provide: ClientAppServiceConfig,
+    inject: [ConfigService],
+    useFactory: clientAppConfigFactory
+  }],
+  exports: [ClientAppService]
+})], ClientAppModule);
+
+/**
+ * A server environment configuration.
+ *
+ * Explicitly states whether or not this is a production environment, and optionally some other config.
+ *
+ * This config is not meant to replace other typical configurations, like .env files, but instead is part of the build system.
+ */
+class ServerEnvironmentConfig {}
+
+// MARK: Tokens
+/**
+ * Token to access a configured ServerEnvironmentServiceConfig for the app.
+ */
+const SERVER_ENV_TOKEN = 'SERVER_ENV_TOKEN';
+function serverEnvTokenProvider(env) {
+  return {
+    provide: SERVER_ENV_TOKEN,
+    useValue: env
+  };
+}
+
+/**
+ * Checks process.env.NODE_ENV for "test"
+ */
+function isTestNodeEnv() {
+  return process.env['NODE_ENV'] === 'test';
+}
+
+let ServerEnvironmentService = class ServerEnvironmentService {
+  env;
+  constructor(env) {
+    this.env = env;
+  }
+  get isTestingEnv() {
+    return isTestNodeEnv();
+  }
+  get isProduction() {
+    return this.env.production;
+  }
+  get isStaging() {
+    return Boolean(this.env.staging);
+  }
+  get developerToolsEnabled() {
+    return Boolean(!this.isProduction && this.env.developerToolsEnabled);
+  }
+};
+ServerEnvironmentService = __decorate([Injectable(), __param(0, Inject(SERVER_ENV_TOKEN)), __metadata("design:paramtypes", [ServerEnvironmentConfig])], ServerEnvironmentService);
+
+export { AppModuleWithWebhooksEnabled, CLIENT_WEB_APP_URL_ENV_VAR, ClientAppModule, ClientAppService, ClientAppServiceConfig, ConfigureWebhookMiddlewareModule, DEFAULT_BASE_WEBHOOK_PATH, DEFAULT_WEBHOOK_MIDDLEWARE_ROUTE_INFO, IsRequestFromLocalHost, JsonBodyMiddleware, ParseRawBody, ParsedQueryRawBody, RawBody, RawBodyMiddleware, RawBodyToJson, RawBodyToParsedQueryString, RawBodyToString, SERVER_ENV_TOKEN, ServerEnvironmentConfig, ServerEnvironmentService, clientAppConfigFactory, consumeWebhooksWithRawBodyMiddleware, injectionTokensFromProviders, isLocalhost, isTestNodeEnv, mergeModuleMetadata, serverEnvTokenProvider };