quidproquo-webserver 0.0.74 → 0.0.76

package/lib/config/QPQConfig.d.ts

@@ -6,7 +6,8 @@ export declare enum QPQWebServerConfigSettingType {
     Seo = "@quidproquo-webserver/config/Seo",
     SubdomainRedirect = "@quidproquo-webserver/config/SubdomainRedirect",
     WebEntry = "@quidproquo-webserver/config/WebEntry",
-    Api = "@quidproquo-webserver/config/Api"
+    Api = "@quidproquo-webserver/config/Api",
+    ApiKey = "@quidproquo-webserver/config/ApiKey"
 }
 export interface CacheSettings {
     minTTLInSeconds: number;

package/lib/config/QPQConfig.js

@@ -11,4 +11,5 @@ var QPQWebServerConfigSettingType;
     QPQWebServerConfigSettingType["SubdomainRedirect"] = "@quidproquo-webserver/config/SubdomainRedirect";
     QPQWebServerConfigSettingType["WebEntry"] = "@quidproquo-webserver/config/WebEntry";
     QPQWebServerConfigSettingType["Api"] = "@quidproquo-webserver/config/Api";
+    QPQWebServerConfigSettingType["ApiKey"] = "@quidproquo-webserver/config/ApiKey";
 })(QPQWebServerConfigSettingType = exports.QPQWebServerConfigSettingType || (exports.QPQWebServerConfigSettingType = {}));

package/lib/config/settings/apiKey.d.ts

@@ -0,0 +1,19 @@
+import { QPQConfigSetting, QPQConfigAdvancedSettings } from 'quidproquo-core';
+export interface ApiKey {
+    name: string;
+    value?: string;
+    description?: string;
+}
+export interface ApiKeyReference {
+    name: string;
+    applicationName?: string;
+    serviceName?: string;
+}
+export interface QPQConfigAdvancedApiKeySettings extends QPQConfigAdvancedSettings {
+    value?: string;
+    description?: string;
+}
+export interface ApiKeyQPQWebServerConfigSetting extends QPQConfigSetting {
+    apiKey: ApiKey;
+}
+export declare const defineApiKey: (apiKeyName: string, options?: QPQConfigAdvancedApiKeySettings) => ApiKeyQPQWebServerConfigSetting;

package/lib/config/settings/apiKey.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.defineApiKey = void 0;
+const QPQConfig_1 = require("../QPQConfig");
+const defineApiKey = (apiKeyName, options) => {
+    return {
+        configSettingType: QPQConfig_1.QPQWebServerConfigSettingType.ApiKey,
+        uniqueKey: apiKeyName,
+        apiKey: {
+            name: apiKeyName,
+            value: options === null || options === void 0 ? void 0 : options.value,
+            description: options === null || options === void 0 ? void 0 : options.description,
+        },
+    };
+};
+exports.defineApiKey = defineApiKey;

package/lib/config/settings/index.d.ts

@@ -1,4 +1,5 @@
 export * from './api';
+export * from './apiKey';
 export * from './defaultRouteOptions';
 export * from './dns';
 export * from './openApi';

package/lib/config/settings/index.js

@@ -15,6 +15,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./api"), exports);
+__exportStar(require("./apiKey"), exports);
 __exportStar(require("./defaultRouteOptions"), exports);
 __exportStar(require("./dns"), exports);
 __exportStar(require("./openApi"), exports);

package/lib/config/settings/route.d.ts

@@ -1,14 +1,18 @@
 import { QPQConfigSetting, HTTPMethod } from 'quidproquo-core';
-export interface RouteAuthSettings {
+import { ApiKeyReference } from './apiKey';
+interface GenericRouteAuthSettings<T> {
     userDirectoryName?: string;
     applicationName?: string;
     serviceName?: string;
     scopes?: string[];
+    apiKeys?: T[];
 }
-export type RouteOptions = {
+interface GenericRouteOptions<T> {
     allowedOrigins?: string[];
-    routeAuthSettings?: RouteAuthSettings;
-};
+    routeAuthSettings?: GenericRouteAuthSettings<T>;
+}
+export type RouteAuthSettings = GenericRouteAuthSettings<ApiKeyReference>;
+export type RouteOptions = GenericRouteOptions<ApiKeyReference>;
 export interface RouteQPQWebServerConfigSetting extends QPQConfigSetting {
     method: HTTPMethod;
     path: string;
@@ -16,4 +20,5 @@ export interface RouteQPQWebServerConfigSetting extends QPQConfigSetting {
     runtime: string;
     options: RouteOptions;
 }
-export declare const defineRoute: (method: HTTPMethod, path: string, src: string, runtime: string, options?: RouteOptions) => RouteQPQWebServerConfigSetting;
+export declare const defineRoute: (method: HTTPMethod, path: string, src: string, runtime: string, options?: GenericRouteOptions<ApiKeyReference | string>) => RouteQPQWebServerConfigSetting;
+export {};

package/lib/config/settings/route.js

@@ -2,13 +2,18 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.defineRoute = void 0;
 const QPQConfig_1 = require("../QPQConfig");
-const defineRoute = (method, path, src, runtime, options = {}) => ({
-    configSettingType: QPQConfig_1.QPQWebServerConfigSettingType.Route,
-    uniqueKey: runtime,
-    method,
-    path,
-    src,
-    runtime,
-    options,
-});
+const defineRoute = (method, path, src, runtime, options = {}) => {
+    const routeAuthSettings = options.routeAuthSettings || {};
+    const apiKeys = routeAuthSettings.apiKeys || [];
+    const newOptions = Object.assign(Object.assign({}, options), { routeAuthSettings: Object.assign(Object.assign({}, routeAuthSettings), { apiKeys: apiKeys.map((apiKey) => (typeof apiKey === 'string' ? { name: apiKey } : apiKey)) }) });
+    return {
+        configSettingType: QPQConfig_1.QPQWebServerConfigSettingType.Route,
+        uniqueKey: runtime,
+        method,
+        path,
+        src,
+        runtime,
+        options: newOptions,
+    };
+};
 exports.defineRoute = defineRoute;

package/lib/utils/mergeRouteUtils.js

@@ -8,8 +8,14 @@ const mergeRouteAuthSettings = (routeAuthSettingsA, routeAuthSettingsB) => {
         serviceName: (routeAuthSettingsB === null || routeAuthSettingsB === void 0 ? void 0 : routeAuthSettingsB.serviceName) || (routeAuthSettingsA === null || routeAuthSettingsA === void 0 ? void 0 : routeAuthSettingsA.serviceName),
         userDirectoryName: (routeAuthSettingsB === null || routeAuthSettingsB === void 0 ? void 0 : routeAuthSettingsB.userDirectoryName) || (routeAuthSettingsA === null || routeAuthSettingsA === void 0 ? void 0 : routeAuthSettingsA.userDirectoryName),
         scopes: [
-            ...new Set([...((routeAuthSettingsB === null || routeAuthSettingsB === void 0 ? void 0 : routeAuthSettingsB.scopes) || []), ...((routeAuthSettingsB === null || routeAuthSettingsB === void 0 ? void 0 : routeAuthSettingsB.scopes) || [])]),
+            ...new Set([...((routeAuthSettingsB === null || routeAuthSettingsB === void 0 ? void 0 : routeAuthSettingsB.scopes) || []), ...((routeAuthSettingsA === null || routeAuthSettingsA === void 0 ? void 0 : routeAuthSettingsA.scopes) || [])]),
         ],
+        apiKeys: [
+            ...((routeAuthSettingsB === null || routeAuthSettingsB === void 0 ? void 0 : routeAuthSettingsB.apiKeys) || []),
+            ...((routeAuthSettingsA === null || routeAuthSettingsA === void 0 ? void 0 : routeAuthSettingsA.apiKeys) || []),
+        ].filter((apiKeyRef, index, arr) => arr.findIndex((item) => item.name === apiKeyRef.name &&
+            item.applicationName === apiKeyRef.applicationName &&
+            item.serviceName === apiKeyRef.serviceName) === index),
     };
 };
 exports.mergeRouteAuthSettings = mergeRouteAuthSettings;

package/lib/utils/qpqConfigAccessorsUtils.d.ts

@@ -1,8 +1,9 @@
 import { QPQConfig } from 'quidproquo-core';
-import { RouteQPQWebServerConfigSetting, DnsQPQWebServerConfigSetting, SeoQPQWebServerConfigSetting, SubdomainRedirectQPQWebServerConfigSetting, OpenApiQPQWebServerConfigSetting, DefaultRouteOptionsQPQWebServerConfigSetting } from '../config';
+import { ApiKeyQPQWebServerConfigSetting, RouteQPQWebServerConfigSetting, DnsQPQWebServerConfigSetting, SeoQPQWebServerConfigSetting, SubdomainRedirectQPQWebServerConfigSetting, OpenApiQPQWebServerConfigSetting, DefaultRouteOptionsQPQWebServerConfigSetting } from '../config';
 import { WebEntryQPQWebServerConfigSetting, ApiQPQWebServerConfigSetting } from '../config';
 export declare const getAllRoutes: (qpqConfig: QPQConfig) => RouteQPQWebServerConfigSetting[];
 export declare const getAllRoutesForApi: (apiName: string, qpqConfig: QPQConfig) => RouteQPQWebServerConfigSetting[];
+export declare const getAllApiKeyConfigs: (qpqConfig: QPQConfig) => ApiKeyQPQWebServerConfigSetting[];
 export declare const getAllSeo: (qpqConfig: QPQConfig) => SeoQPQWebServerConfigSetting[];
 export declare const getAllOpenApiSpecs: (configs: QPQConfig) => OpenApiQPQWebServerConfigSetting[];
 export declare const getAllSrcEntries: (configs: QPQConfig) => string[];

package/lib/utils/qpqConfigAccessorsUtils.js

@@ -23,7 +23,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getDefaultRouteSettings = exports.getServiceDomainName = exports.getBaseDomainName = exports.getEnvironmentDomainName = exports.getWebEntryConfigs = exports.getDnsConfigs = exports.getApiConfigs = exports.getSubdomainRedirects = exports.getApiEntryFullPath = exports.getWebEntrySeoFullPath = exports.getWebEntryFullPath = exports.getWebEntry = exports.getDomainName = exports.getAllSrcEntries = exports.getAllOpenApiSpecs = exports.getAllSeo = exports.getAllRoutesForApi = exports.getAllRoutes = void 0;
+exports.getDefaultRouteSettings = exports.getServiceDomainName = exports.getBaseDomainName = exports.getEnvironmentDomainName = exports.getWebEntryConfigs = exports.getDnsConfigs = exports.getApiConfigs = exports.getSubdomainRedirects = exports.getApiEntryFullPath = exports.getWebEntrySeoFullPath = exports.getWebEntryFullPath = exports.getWebEntry = exports.getDomainName = exports.getAllSrcEntries = exports.getAllOpenApiSpecs = exports.getAllSeo = exports.getAllApiKeyConfigs = exports.getAllRoutesForApi = exports.getAllRoutes = void 0;
 const path = __importStar(require("path"));
 const quidproquo_core_1 = require("quidproquo-core");
 const config_1 = require("../config");
@@ -37,6 +37,11 @@ const getAllRoutesForApi = (apiName, qpqConfig) => {
     return routes;
 };
 exports.getAllRoutesForApi = getAllRoutesForApi;
+const getAllApiKeyConfigs = (qpqConfig) => {
+    const apiKeyConfigs = quidproquo_core_1.qpqCoreUtils.getConfigSettings(qpqConfig, config_1.QPQWebServerConfigSettingType.ApiKey);
+    return apiKeyConfigs;
+};
+exports.getAllApiKeyConfigs = getAllApiKeyConfigs;
 const getAllSeo = (qpqConfig) => {
     const seoConfigs = quidproquo_core_1.qpqCoreUtils.getConfigSettings(qpqConfig, config_1.QPQWebServerConfigSettingType.Seo);
     return seoConfigs;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "quidproquo-webserver",
-  "version": "0.0.74",
+  "version": "0.0.76",
   "description": "",
   "main": "./lib/index.js",
   "types": "./lib/index.d.js",