@stuntman/shared 0.1.0 → 0.1.2

package/README.md

@@ -0,0 +1,3 @@
+# Stuntman proxy/mock shared library
+
+Shared types and utils for [Stunman](https://github.com/andrzej-woof/stuntman#readme)

package/dist/config.js

@@ -23,7 +23,7 @@ const defaultConfig = {
         traffic: {
             limitCount: _1.DEFAULT_CACHE_MAX_ENTRIES,
             limitSize: _1.DEFAULT_CACHE_MAX_SIZE,
-            ttl: _1.DEFAULT_CACHE_TTL
+            ttl: _1.DEFAULT_CACHE_TTL,
         },
     },
     webgui: {
@@ -35,6 +35,7 @@ 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);

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;
@@ -151,3 +152,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,12 +1,16 @@
 {
   "name": "@stuntman/shared",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "description": "Stuntman - HTTP proxy / mock shared types and utils",
   "main": "dist/index.js",
   "repository": {
     "type": "git",
     "url": "https://github.com/andrzej-woof/stuntman.git"
   },
+  "homepage": "https://github.com/andrzej-woof/stuntman#readme",
+  "bugs": {
+    "url": "https://github.com/andrzej-woof/stuntman/issues"
+  },
   "keywords": [
     "proxy",
     "mock",

package/src/config.ts

@@ -30,7 +30,7 @@ const defaultConfig: ServerConfig = {
         traffic: {
             limitCount: DEFAULT_CACHE_MAX_ENTRIES,
             limitSize: DEFAULT_CACHE_MAX_SIZE,
-            ttl: DEFAULT_CACHE_TTL
+            ttl: DEFAULT_CACHE_TTL,
         },
     },
     webgui: {
@@ -42,7 +42,8 @@ let configFromFile: RecursivePartial<ServerConfig> = {};
 try {
     configFromFile = config.get<RecursivePartial<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;

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;
@@ -197,3 +199,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) {