quidproquo-webserver - npm Package Compare versions

Comparing version 0.0.173 to 0.0.174

lib/commonjs/config/QPQConfig.d.ts

@@ -14,3 +14,4 @@ export declare enum QPQWebServerConfigSettingType {
     Cache = "@quidproquo-webserver/config/Cache",
-    Certificate = "@quidproquo-webserver/config/Certificate"
+    Certificate = "@quidproquo-webserver/config/Certificate",
+    DomainProxy = "@quidproquo-webserver/config/DomainProxy"
 }
@@ -17,0 +18,0 @@ export interface CacheSettings {

lib/commonjs/config/QPQConfig.js

@@ -19,2 +19,3 @@ "use strict";
     QPQWebServerConfigSettingType["Certificate"] = "@quidproquo-webserver/config/Certificate";
+    QPQWebServerConfigSettingType["DomainProxy"] = "@quidproquo-webserver/config/DomainProxy";
 })(QPQWebServerConfigSettingType = exports.QPQWebServerConfigSettingType || (exports.QPQWebServerConfigSettingType = {}));

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

@@ -18,1 +18,2 @@ export * from './api';
 export * from './logs';
+export * from './domainProxy';

lib/commonjs/config/settings/index.js

@@ -34,1 +34,2 @@ "use strict";
 __exportStar(require("./logs"), exports);
+__exportStar(require("./domainProxy"), exports);

lib/commonjs/utils/qpqConfigAccessorsUtils.d.ts

 import { QPQConfig } from 'quidproquo-core';
-import { ApiKeyQPQWebServerConfigSetting, RouteQPQWebServerConfigSetting, DnsQPQWebServerConfigSetting, SeoQPQWebServerConfigSetting, SubdomainRedirectQPQWebServerConfigSetting, OpenApiQPQWebServerConfigSetting, DefaultRouteOptionsQPQWebServerConfigSetting, ServiceFunctionQPQWebServerConfigSetting, WebSocketQPQWebServerConfigSetting, CacheQPQWebServerConfigSetting, CertificateQPQWebServerConfigSetting } from '../config';
+import { ApiKeyQPQWebServerConfigSetting, RouteQPQWebServerConfigSetting, DnsQPQWebServerConfigSetting, SeoQPQWebServerConfigSetting, SubdomainRedirectQPQWebServerConfigSetting, OpenApiQPQWebServerConfigSetting, DefaultRouteOptionsQPQWebServerConfigSetting, ServiceFunctionQPQWebServerConfigSetting, WebSocketQPQWebServerConfigSetting, CacheQPQWebServerConfigSetting, CertificateQPQWebServerConfigSetting, DomainProxyQPQWebServerConfigSetting } from '../config';
 import { WebEntryQPQWebServerConfigSetting, ApiQPQWebServerConfigSetting } from '../config';
@@ -25,2 +25,3 @@ export declare const getAllRoutes: (qpqConfig: QPQConfig) => RouteQPQWebServerConfigSetting[];
 export declare const getWebEntryConfigs: (configs: QPQConfig) => WebEntryQPQWebServerConfigSetting[];
+export declare const getDomainProxyConfigs: (configs: QPQConfig) => DomainProxyQPQWebServerConfigSetting[];
 export declare const getAllOwnedCacheConfigs: (qpqConfig: QPQConfig) => CacheQPQWebServerConfigSetting[];
@@ -27,0 +28,0 @@ export declare const getAllOwnedCertifcateConfigs: (qpqConfig: QPQConfig) => CertificateQPQWebServerConfigSetting[];

lib/commonjs/utils/qpqConfigAccessorsUtils.js

@@ -26,3 +26,3 @@ "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getWebsocketSettings = exports.resolveDomainRoot = exports.getDomainRoot = exports.getDefaultRouteSettings = exports.constructEnvironmentDomainName = exports.constructServiceDomainName = exports.resolveApexDomainNameFromDomainConfig = exports.getServiceDomainName = exports.getBaseDomainName = exports.getEnvironmentDomainName = exports.getCacheConfigByName = exports.getAllOwnedCertifcateConfigs = exports.getAllOwnedCacheConfigs = exports.getWebEntryConfigs = exports.getDnsConfigs = exports.getApiConfigs = exports.getSubdomainRedirects = exports.getRedirectApiBuildFullPath = exports.getServiceFunctionFullPath = exports.getWebsocketEntryByApiName = exports.getWebsocketEntryFullPath = exports.getApiEntryFullPath = exports.getWebEntrySeoFullPath = exports.getWebEntryFullPath = exports.getWebEntry = exports.getDomainName = exports.getAllSrcEntries = exports.getAllWebsocketSrcEntries = exports.getAllOpenApiSpecs = exports.getAllServiceFunctions = exports.getAllSeo = exports.getAllApiKeyConfigs = exports.getAllRoutesForApi = exports.getAllRoutes = void 0;
+exports.getWebsocketSettings = exports.resolveDomainRoot = exports.getDomainRoot = exports.getDefaultRouteSettings = exports.constructEnvironmentDomainName = exports.constructServiceDomainName = exports.resolveApexDomainNameFromDomainConfig = exports.getServiceDomainName = exports.getBaseDomainName = exports.getEnvironmentDomainName = exports.getCacheConfigByName = exports.getAllOwnedCertifcateConfigs = exports.getAllOwnedCacheConfigs = exports.getDomainProxyConfigs = exports.getWebEntryConfigs = exports.getDnsConfigs = exports.getApiConfigs = exports.getSubdomainRedirects = exports.getRedirectApiBuildFullPath = exports.getServiceFunctionFullPath = exports.getWebsocketEntryByApiName = exports.getWebsocketEntryFullPath = exports.getApiEntryFullPath = exports.getWebEntrySeoFullPath = exports.getWebEntryFullPath = exports.getWebEntry = exports.getDomainName = exports.getAllSrcEntries = exports.getAllWebsocketSrcEntries = exports.getAllOpenApiSpecs = exports.getAllServiceFunctions = exports.getAllSeo = exports.getAllApiKeyConfigs = exports.getAllRoutesForApi = exports.getAllRoutes = void 0;
 const path = __importStar(require("path"));
@@ -161,2 +161,6 @@ const quidproquo_core_1 = require("quidproquo-core");
 exports.getWebEntryConfigs = getWebEntryConfigs;
+const getDomainProxyConfigs = (configs) => {
+    return quidproquo_core_1.qpqCoreUtils.getConfigSettings(configs, config_1.QPQWebServerConfigSettingType.DomainProxy);
+};
+exports.getDomainProxyConfigs = getDomainProxyConfigs;
 const getAllOwnedCacheConfigs = (qpqConfig) => {
@@ -163,0 +167,0 @@ const cacheSettings = quidproquo_core_1.qpqCoreUtils.getConfigSettings(qpqConfig, config_1.QPQWebServerConfigSettingType.Cache);

package.json

 {
   "name": "quidproquo-webserver",
-  "version": "0.0.173",
+  "version": "0.0.174",
   "description": "",
@@ -12,3 +12,3 @@ "main": "./lib/commonjs/index.js",
     "test": "echo \"Error: no test specified\" && exit 1",
-    "clean": "npx rimraf lib",
+    "clean": "npx rimraf lib && npx rimraf node_modules",
     "build": "npm run clean && tsc -p tsconfig.commonjs.json",
@@ -29,8 +29,8 @@ "watch": "tsc -p tsconfig.commonjs.json -w"
   "dependencies": {
-    "quidproquo-core": "0.0.173"
+    "quidproquo-core": "0.0.174"
   },
   "devDependencies": {
-    "quidproquo-tsconfig": "0.0.173",
+    "quidproquo-tsconfig": "0.0.174",
     "typescript": "^4.9.3"
   }
 }

README.md

 # quidproquo-webserver
 
-Web server definitions for quidproquo
+**WARNING: NOT FOR PRODUCTION**
 
-### Note
+The `quidproquo-webserver` library is a key component of the quidproquo framework, providing a set of abstractions and utilities for building web applications using the quidproquo architecture. This library serves as the bridge between the core quidproquo functionality and the web server runtime, enabling the execution of quidproquo-based applications on the web.
 
-Currently under development ~ Not for production
+## Note
+
+Currently under active development and should not be used in production environments. The APIs and functionality are subject to change without notice.
+
+## Key Features
+
+1. **Action-Oriented Architecture**: The `quidproquo-webserver` library aligns with the action-oriented architecture of the quidproquo framework, allowing for the seamless execution of quidproquo actions within the web server environment.
+
+2. **Event Handling**: The library provides specialized action processors for handling various event types, such as HTTP requests, WebSocket events, and more. This enables the integration of quidproquo-based applications with a wide range of web server functionality.
+
+3. **Configuration Management**: The library includes action processors for managing quidproquo configuration, including the retrieval of secrets, parameters, and global values from various sources.
+
+4. **File Management**: The library offers action processors for interacting with the file system, allowing for the reading, writing, and management of files and directories within the quidproquo application.
+
+5. **User Directory Integration**: The library includes action processors for integrating with user authentication and authorization systems, enabling user management and access control within quidproquo-based applications.
+
+6. **Event Bus Integration**: The library provides action processors for publishing and subscribing to events using event bus systems, facilitating cross-service communication and event-driven architectures.
+
+7. **Key-Value Store Integration**: The library includes action processors for interacting with key-value stores, enabling the use of persistent data storage within quidproquo applications.
+
+8. **Logging and Observability**: The library integrates with the quidproquo logging and observability features, ensuring that application logs and metrics are captured and made available for monitoring and troubleshooting.
+
+9. **Extensibility**: The library is designed to be highly extensible, allowing developers to create custom action processors to meet their specific requirements and integrate with a wide range of web server functionality and third-party tools.
+
+## Key Concepts
+
+1. **Action Processors**: Action processors are the core components of the `quidproquo-webserver` library, responsible for executing quidproquo actions within the web server environment. These processors handle the integration with various web server features and ensure the correct execution of quidproquo actions.
+
+2. **Event Handling**: The library provides specialized action processors for handling different event types, such as HTTP requests, WebSocket events, and more. These processors transform the event data into a format that can be consumed by the quidproquo runtime and execute the appropriate quidproquo actions.
+
+3. **Configuration Management**: The library includes action processors for retrieving and managing quidproquo configuration data, such as secrets, parameters, and global values, from various sources.
+
+4. **File Management**: The file management action processors enable the reading, writing, and management of files and directories within the quidproquo application, using the local file system as the underlying storage.
+
+5. **User Directory Integration**: The user directory integration action processors handle the integration with user authentication and authorization systems, allowing for user management and access control within quidproquo-based applications.
+
+6. **Event Bus Integration**: The event bus integration action processors facilitate the publishing and subscribing of events using event bus systems, enabling cross-service communication and event-driven architectures within quidproquo applications.
+
+7. **Key-Value Store Integration**: The key-value store integration action processors provide the ability to interact with key-value stores, allowing quidproquo applications to leverage persistent data storage for their needs.
+
+8. **Logging and Observability**: The library integrates with the quidproquo logging and observability features, ensuring that application logs and metrics are captured and made available for monitoring and troubleshooting.
+
+9. **Extensibility**: The `quidproquo-webserver` library is designed to be highly extensible, allowing developers to create custom action processors to meet their specific requirements and integrate with a wide range of web server functionality and third-party tools.
+
+## Getting Started
+
+To use the `quidproquo-webserver` library, you'll need to install the package and its dependencies. You can do this using your preferred package manager, such as npm or yarn:
+
+```
+npm install quidproquo-webserver
+```
+
+Once you have the package installed, you can start building your quidproquo-based web applications, leveraging the action processors and utilities provided by this library.
+
+## Documentation
+
+For more detailed information on using the `quidproquo-webserver` library, please refer to the [quidproquo-webserver documentation](https://github.com/joe-coady/quidproquo/tree/main/packages/quidproquo-webserver).
+
+## Contributing
+
+If you'd like to contribute to the development of `quidproquo-webserver`, please refer to the [contributing guidelines](https://github.com/joe-coady/quidproquo/blob/main/CONTRIBUTING.md) for more information.
+
+## License
+
+`quidproquo-webserver` is licensed under the [MIT License](https://github.com/joe-coady/quidproquo/blob/main/LICENSE).

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

170709

increased by4.9%

Number of package files

220

increased by0.92%

Lines of code

3304

increased by1.35%

Number of lines in readme file

71

increased by787.5%

Dependency changes

• + Addedquidproquo-core@0.0.174(transitive)

• - Removedquidproquo-core@0.0.173(transitive)

• Updatedquidproquo-core@0.0.174