@stuntman/shared 0.1.1 → 0.1.3

package/dist/config.js

@@ -6,18 +6,21 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.serverConfig = void 0;
 const _1 = require(".");
 const config_1 = __importDefault(require("config"));
-const defaults_1 = __importDefault(require("defaults"));
+const path_1 = __importDefault(require("path"));
 // TODO safeguards & defaults
 const defaultConfig = {
     api: {
         disabled: false,
         port: _1.DEFAULT_API_PORT,
+        apiKeyReadOnly: null,
+        apiKeyReadWrite: null,
     },
     mock: {
         domain: _1.DEFAULT_MOCK_DOMAIN,
         externalDns: _1.EXTERNAL_DNS,
         port: _1.DEFAULT_MOCK_PORT,
         timeout: _1.DEFAULT_PROXY_TIMEOUT,
+        rulesPath: path_1.default.join(process.cwd(), 'rules'),
     },
     storage: {
         traffic: {
@@ -30,11 +33,13 @@ const defaultConfig = {
         disabled: false,
     },
 };
+config_1.default.util.setModuleDefaults('stuntman', defaultConfig);
 let configFromFile = {};
 try {
     configFromFile = config_1.default.get('stuntman');
 }
 catch (error) {
-    console.warn('unable to find correct config');
+    // eslint-disable-next-line no-console
+    console.warn('unable to find correct config - starting with defaults');
 }
-exports.serverConfig = (0, defaults_1.default)(configFromFile, defaultConfig);
+exports.serverConfig = configFromFile;

package/dist/index.d.ts

@@ -28,6 +28,7 @@ export type RuleMatchResult = boolean | {
     result: boolean;
     enableRuleIds?: string[];
     disableRuleIds?: string[];
+    description?: string;
 };
 export type RemotableFunction<T extends Function> = {
     localFn: T;
@@ -122,6 +123,8 @@ export type WebGuiConfig = {
 export type ApiConfig = {
     port: number;
     disabled: boolean;
+    apiKeyReadWrite: string | null;
+    apiKeyReadOnly: string | null;
 };
 export type ClientConfig = {
     protocol?: 'http' | 'https';
@@ -137,6 +140,7 @@ export type MockConfig = {
     httpsCert?: string;
     timeout: number;
     externalDns: string[];
+    rulesPath: string;
 };
 export type StorageConfig = {
     limitCount: number;
@@ -151,3 +155,12 @@ export type ServerConfig = {
         traffic: StorageConfig;
     };
 };
+export interface RuleExecutorInterface {
+    addRule: (rule: Rule, overwrite?: boolean) => Promise<LiveRule>;
+    removeRule: (id: string) => Promise<void>;
+    enableRule: (id: string) => void;
+    disableRule: (id: string) => void;
+    findMatchingRule: (request: Request) => Promise<LiveRule | null>;
+    getRules: () => Promise<readonly LiveRule[]>;
+    getRule: (id: string) => Promise<LiveRule | undefined>;
+}

package/dist/rawHeaders.d.ts

@@ -7,5 +7,6 @@ export declare class RawHeaders extends Array<string> implements Stuntman.RawHea
     remove(name: string): void;
     toHeaderPairs(): readonly [string, string][];
     static fromHeaderPairs(headerPairs: [string, string][]): RawHeaders;
+    static fromHeadersRecord(headersRecord: Record<string, string | string[] | undefined>): RawHeaders;
     static toHeaderPairs(rawHeaders: string[]): readonly [string, string][];
 }

package/dist/rawHeaders.js

@@ -59,6 +59,19 @@ class RawHeaders extends Array {
     static fromHeaderPairs(headerPairs) {
         return new RawHeaders(...headerPairs.flatMap((x) => x));
     }
+    static fromHeadersRecord(headersRecord) {
+        const output = new RawHeaders();
+        for (const [key, value] of Object.entries(headersRecord)) {
+            if (typeof value === 'string' || value === undefined) {
+                output.add(key, value !== null && value !== void 0 ? value : '');
+                continue;
+            }
+            for (const subValue of value) {
+                output.add(key, subValue);
+            }
+        }
+        return output;
+    }
     static toHeaderPairs(rawHeaders) {
         const headers = new Array();
         for (let headerIndex = 0; headerIndex < rawHeaders.length; headerIndex += 2) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stuntman/shared",
-  "version": "0.1.1",
+  "version": "0.1.3",
   "description": "Stuntman - HTTP proxy / mock shared types and utils",
   "main": "dist/index.js",
   "repository": {
@@ -33,18 +33,16 @@
   "license": "MIT",
   "dependencies": {
     "config": "3.3.9",
-    "defaults": "1.0.4",
     "pino": "8.10.0"
   },
   "devDependencies": {
-    "@types/config": "3.3.0",
-    "@types/defaults": "1.0.3"
+    "@types/config": "3.3.0"
   },
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1",
     "clean": "rm -fr dist",
     "build": "tsc",
     "lint": "prettier --check . && eslint . --ext ts",
-    "lint:fix": "prettier --write ./src && eslint ./src --ext ts --fix"
+    "lint:fix": "prettier --write ./{src,test} && eslint ./{src,test} --ext ts --fix"
   }
 }

package/src/config.ts

@@ -1,5 +1,4 @@
 import {
-    RecursivePartial,
     ServerConfig,
     DEFAULT_API_PORT,
     DEFAULT_MOCK_DOMAIN,
@@ -11,7 +10,7 @@ import {
     DEFAULT_CACHE_TTL,
 } from '.';
 import config from 'config';
-import defaults from 'defaults';
+import path from 'path';
 
 // TODO safeguards & defaults
 
@@ -19,12 +18,15 @@ const defaultConfig: ServerConfig = {
     api: {
         disabled: false,
         port: DEFAULT_API_PORT,
+        apiKeyReadOnly: null,
+        apiKeyReadWrite: null,
     },
     mock: {
         domain: DEFAULT_MOCK_DOMAIN,
         externalDns: EXTERNAL_DNS,
         port: DEFAULT_MOCK_PORT,
         timeout: DEFAULT_PROXY_TIMEOUT,
+        rulesPath: path.join(process.cwd(), 'rules'),
     },
     storage: {
         traffic: {
@@ -38,11 +40,14 @@ const defaultConfig: ServerConfig = {
     },
 };
 
-let configFromFile: RecursivePartial<ServerConfig> = {};
+config.util.setModuleDefaults('stuntman', defaultConfig);
+
+let configFromFile = {} as ServerConfig;
 try {
-    configFromFile = config.get<RecursivePartial<ServerConfig>>('stuntman');
+    configFromFile = config.get<ServerConfig>('stuntman');
 } catch (error) {
-    console.warn('unable to find correct config');
+    // eslint-disable-next-line no-console
+    console.warn('unable to find correct config - starting with defaults');
 }
 
-export const serverConfig = defaults(configFromFile, defaultConfig) as ServerConfig;
+export const serverConfig = configFromFile;

package/src/index.ts

@@ -42,7 +42,9 @@ export enum HttpCode {
 
 export type LocalVariables = Record<string, SerializableTypes>;
 
-export type RuleMatchResult = boolean | { result: boolean; enableRuleIds?: string[]; disableRuleIds?: string[] };
+export type RuleMatchResult =
+    | boolean
+    | { result: boolean; enableRuleIds?: string[]; disableRuleIds?: string[]; description?: string };
 
 export type RemotableFunction<T extends Function> = {
     localFn: T;
@@ -164,6 +166,8 @@ export type WebGuiConfig = {
 export type ApiConfig = {
     port: number;
     disabled: boolean;
+    apiKeyReadWrite: string | null;
+    apiKeyReadOnly: string | null;
 };
 
 export type ClientConfig = {
@@ -181,6 +185,7 @@ export type MockConfig = {
     httpsCert?: string;
     timeout: number;
     externalDns: string[];
+    rulesPath: string;
 };
 
 export type StorageConfig = {
@@ -197,3 +202,13 @@ export type ServerConfig = {
         traffic: StorageConfig;
     };
 };
+
+export interface RuleExecutorInterface {
+    addRule: (rule: Rule, overwrite?: boolean) => Promise<LiveRule>;
+    removeRule: (id: string) => Promise<void>;
+    enableRule: (id: string) => void;
+    disableRule: (id: string) => void;
+    findMatchingRule: (request: Request) => Promise<LiveRule | null>;
+    getRules: () => Promise<readonly LiveRule[]>;
+    getRule: (id: string) => Promise<LiveRule | undefined>;
+}

package/src/rawHeaders.ts

@@ -65,6 +65,20 @@ export class RawHeaders extends Array<string> implements Stuntman.RawHeadersInte
         return new RawHeaders(...headerPairs.flatMap((x) => x));
     }
 
+    static fromHeadersRecord(headersRecord: Record<string, string | string[] | undefined>): RawHeaders {
+        const output = new RawHeaders();
+        for (const [key, value] of Object.entries(headersRecord)) {
+            if (typeof value === 'string' || value === undefined) {
+                output.add(key, value ?? '');
+                continue;
+            }
+            for (const subValue of value) {
+                output.add(key, subValue);
+            }
+        }
+        return output;
+    }
+
     static toHeaderPairs(rawHeaders: string[]): readonly [string, string][] {
         const headers = new Array<[string, string]>();
         for (let headerIndex = 0; headerIndex < rawHeaders.length; headerIndex += 2) {

package/test/dummy.test.ts

@@ -0,0 +1 @@
+// TODO

package/tsconfig.json

@@ -11,6 +11,12 @@
         "skipLibCheck": true,
         "typeRoots": ["node_modules/@types"],
         "allowJs": true,
-        "moduleResolution": "node16"
-    }
+        "moduleResolution": "node16",
+        "types": ["node", "jest"]
+    },
+    "exclude": [
+        "jest.config.js",
+        "./dist/**",
+        "./test/**"
+    ]
 }