@bitblit/ratchet-epsilon-common 4.0.1-alpha

package/lib/inter-api/inter-api-entry.d.ts

@@ -0,0 +1,7 @@
+export interface InterApiEntry<T> {
+    source: string;
+    type: string;
+    data: T;
+    traceId?: string;
+    traceDepth?: number;
+}

package/lib/inter-api/inter-api-util.d.ts

@@ -0,0 +1,10 @@
+import { SNSEvent } from 'aws-lambda';
+import { InterApiEntry } from './inter-api-entry.js';
+import { InterApiConfig } from '../config/inter-api/inter-api-config.js';
+import { BackgroundManagerLike } from '../background/manager/background-manager-like.js';
+export declare class InterApiUtil {
+    static isInterApiSnsEvent(event: any): boolean;
+    static extractEntryFromEvent(evt: SNSEvent): InterApiEntry<any>;
+    static processInterApiEvent(evt: SNSEvent, cfg: InterApiConfig, mgr: BackgroundManagerLike): Promise<string[]>;
+    static addTraceToInterApiEntry(ent: InterApiEntry<any>): InterApiEntry<any>;
+}

package/lib/inter-api/inter-api-util.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/inter-api-manager.d.ts

@@ -0,0 +1,14 @@
+import { InterApiEntry } from './inter-api/inter-api-entry.js';
+import { InterApiAwsConfig } from './config/inter-api/inter-api-aws-config.js';
+import { SNSClient } from '@aws-sdk/client-sns';
+export declare class InterApiManager {
+    private _aws;
+    private _sns;
+    constructor(_aws: InterApiAwsConfig, _sns: SNSClient);
+    get config(): InterApiAwsConfig;
+    get sns(): SNSClient;
+    createEntry<T>(type: string, data?: T): InterApiEntry<T>;
+    fireInterApiEventByParts<T>(type: string, data?: T): Promise<string>;
+    fireInterApiEvent<T>(entry: InterApiEntry<T>): Promise<string>;
+    writeMessageToSnsTopic(message: string): Promise<string>;
+}

package/lib/lambda-event-handler/cron-epsilon-lambda-event-handler.d.ts

@@ -0,0 +1,14 @@
+import { EpsilonLambdaEventHandler } from '../config/epsilon-lambda-event-handler.js';
+import { Context, ProxyResult, ScheduledEvent } from 'aws-lambda';
+import { EpsilonInstance } from '../epsilon-instance.js';
+import { CronConfig } from '../config/cron/cron-config.js';
+import { BackgroundHandler } from '../background/background-handler.js';
+import { BackgroundManagerLike } from '../background/manager/background-manager-like.js';
+export declare class CronEpsilonLambdaEventHandler implements EpsilonLambdaEventHandler<ScheduledEvent> {
+    private _epsilon;
+    constructor(_epsilon: EpsilonInstance);
+    extractLabel(evt: ScheduledEvent, context: Context): string;
+    handlesEvent(evt: any): boolean;
+    processEvent(evt: ScheduledEvent, context: Context): Promise<ProxyResult>;
+    static processCronEvent(evt: ScheduledEvent, cronConfig: CronConfig, backgroundManager: BackgroundManagerLike, background: BackgroundHandler): Promise<boolean>;
+}

package/lib/lambda-event-handler/cron-epsilon-lambda-event-handler.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/lambda-event-handler/dynamo-epsilon-lambda-event-handler.d.ts

@@ -0,0 +1,11 @@
+import { EpsilonLambdaEventHandler } from '../config/epsilon-lambda-event-handler.js';
+import { Context, DynamoDBStreamEvent, ProxyResult } from 'aws-lambda';
+import { EpsilonInstance } from '../epsilon-instance.js';
+export declare class DynamoEpsilonLambdaEventHandler implements EpsilonLambdaEventHandler<DynamoDBStreamEvent> {
+    private _epsilon;
+    constructor(_epsilon: EpsilonInstance);
+    extractLabel(evt: DynamoDBStreamEvent, context: Context): string;
+    handlesEvent(evt: any): boolean;
+    processEvent(evt: DynamoDBStreamEvent, context: Context): Promise<ProxyResult>;
+    processUncaughtError(event: DynamoDBStreamEvent, context: Context, err: any): Promise<ProxyResult>;
+}

package/lib/lambda-event-handler/generic-sns-epsilon-lambda-event-handler.d.ts

@@ -0,0 +1,10 @@
+import { EpsilonLambdaEventHandler } from '../config/epsilon-lambda-event-handler.js';
+import { Context, ProxyResult, SNSEvent } from 'aws-lambda';
+import { EpsilonInstance } from '../epsilon-instance.js';
+export declare class GenericSnsEpsilonLambdaEventHandler implements EpsilonLambdaEventHandler<SNSEvent> {
+    private _epsilon;
+    constructor(_epsilon: EpsilonInstance);
+    extractLabel(evt: SNSEvent, context: Context): string;
+    handlesEvent(evt: any): boolean;
+    processEvent(evt: SNSEvent, context: Context): Promise<ProxyResult>;
+}

package/lib/lambda-event-handler/inter-api-epsilon-lambda-event-handler.d.ts

@@ -0,0 +1,10 @@
+import { EpsilonLambdaEventHandler } from '../config/epsilon-lambda-event-handler.js';
+import { Context, ProxyResult, SNSEvent } from 'aws-lambda';
+import { EpsilonInstance } from '../epsilon-instance.js';
+export declare class InterApiEpsilonLambdaEventHandler implements EpsilonLambdaEventHandler<SNSEvent> {
+    private _epsilon;
+    constructor(_epsilon: EpsilonInstance);
+    extractLabel(evt: SNSEvent, context: Context): string;
+    handlesEvent(evt: any): boolean;
+    processEvent(evt: SNSEvent, context: Context): Promise<ProxyResult>;
+}

package/lib/lambda-event-handler/s3-epsilon-lambda-event-handler.d.ts

@@ -0,0 +1,10 @@
+import { EpsilonLambdaEventHandler } from '../config/epsilon-lambda-event-handler.js';
+import { Context, ProxyResult, S3Event } from 'aws-lambda';
+import { EpsilonInstance } from '../epsilon-instance.js';
+export declare class S3EpsilonLambdaEventHandler implements EpsilonLambdaEventHandler<S3Event> {
+    private _epsilon;
+    constructor(_epsilon: EpsilonInstance);
+    extractLabel(evt: S3Event, context: Context): string;
+    handlesEvent(evt: any): boolean;
+    processEvent(evt: S3Event, context: Context): Promise<ProxyResult>;
+}

package/lib/local-container-server.d.ts

@@ -0,0 +1,11 @@
+/// <reference types="node" />
+import { IncomingMessage, ServerResponse } from 'http';
+export declare class LocalContainerServer {
+    private port;
+    private server;
+    private aborted;
+    constructor(port?: number);
+    runServer(): Promise<boolean>;
+    requestHandler(request: IncomingMessage, response: ServerResponse): Promise<any>;
+    static runFromCliArgs(args: string[]): Promise<void>;
+}

package/lib/local-server-cert.d.ts

@@ -0,0 +1,5 @@
+export declare class LocalServerCert {
+    static readonly CLIENT_CSR: string;
+    static readonly CLIENT_CERT_PEM: string;
+    static readonly CLIENT_KEY_PEM: string;
+}

package/lib/local-server.d.ts

@@ -0,0 +1,18 @@
+/// <reference types="node" />
+import { APIGatewayEvent, Context, ProxyResult } from 'aws-lambda';
+import { IncomingMessage, ServerResponse } from 'http';
+import { EpsilonGlobalHandler } from './epsilon-global-handler.js';
+export declare class LocalServer {
+    private globalHandler;
+    private port;
+    private server;
+    private aborted;
+    constructor(globalHandler: EpsilonGlobalHandler, port?: number, https?: boolean);
+    runServer(): Promise<boolean>;
+    requestHandler(request: IncomingMessage, response: ServerResponse): Promise<any>;
+    static bodyAsBase64String(request: IncomingMessage): Promise<string>;
+    static messageToApiGatewayEvent(request: IncomingMessage, context: Context): Promise<APIGatewayEvent>;
+    static writeProxyResultToServerResponse(proxyResult: ProxyResult, response: ServerResponse): Promise<boolean>;
+    static runSampleBatchOnlyServerFromCliArgs(args: string[]): Promise<void>;
+    static runSampleLocalServerFromCliArgs(args: string[]): Promise<void>;
+}

package/lib/open-api-util/open-api-doc-modifications.d.ts

@@ -0,0 +1,8 @@
+export interface OpenApiDocModifications {
+    newServerPath: string;
+    removeEndpoints: RegExp[];
+    removeTags: string[];
+    removeSchemas: string[];
+    sortEndpoints: boolean;
+    sortSchemas: boolean;
+}

package/lib/open-api-util/open-api-doc-modifier.d.ts

@@ -0,0 +1,7 @@
+import { OpenApiDocModifications } from './open-api-doc-modifications.js';
+export declare class OpenApiDocModifier {
+    private options;
+    constructor(options: OpenApiDocModifications);
+    modifyOpenApiDoc(yamlString: string): string;
+    private matchNone;
+}

package/lib/open-api-util/open-api-doc-modifier.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/open-api-util/yaml-combiner.d.ts

@@ -0,0 +1,3 @@
+export declare class YamlCombiner {
+    static combine(files: string[], inRootPath?: string[]): string;
+}

package/lib/open-api-util/yaml-combiner.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/sample/sample-server-components.d.ts

@@ -0,0 +1,10 @@
+import { ApolloServer } from 'apollo-server-lambda';
+import { EpsilonGlobalHandler } from '../epsilon-global-handler.js';
+import { EpsilonConfig } from '../config/epsilon-config.js';
+export declare class SampleServerComponents {
+    private constructor();
+    static createSampleApollo(): Promise<ApolloServer>;
+    static createSampleEpsilonConfig(label: string): Promise<EpsilonConfig>;
+    static createSampleEpsilonGlobalHandler(label: string): Promise<EpsilonGlobalHandler>;
+    static createSampleBatchOnlyEpsilonGlobalHandler(label: string): Promise<EpsilonGlobalHandler>;
+}

package/lib/sample/sample-server-static-files.d.ts

@@ -0,0 +1,5 @@
+export declare class SampleServerStaticFiles {
+    private constructor();
+    static readonly SAMPLE_OPEN_API_DOC: string;
+    static readonly SAMPLE_SERVER_GRAPHQL: string;
+}

package/lib/sample/test-error-server.d.ts

@@ -0,0 +1,11 @@
+/// <reference types="node" />
+import { IncomingMessage, ServerResponse } from 'http';
+export declare class TestErrorServer {
+    private port;
+    private server;
+    private aborted;
+    constructor(port?: number);
+    runServer(): Promise<boolean>;
+    requestHandler(request: IncomingMessage, response: ServerResponse): Promise<any>;
+    static runFromCliArgs(args: string[]): Promise<void>;
+}

package/lib/util/aws-util.d.ts

@@ -0,0 +1,8 @@
+import { APIGatewayEvent, APIGatewayEventRequestContextV2, APIGatewayEventRequestContextWithAuthorizer, APIGatewayProxyEventV2 } from 'aws-lambda';
+export declare class AwsUtil {
+    static apiGatewayV2ToApiGatewayV1(srcEvt: APIGatewayProxyEventV2): APIGatewayEvent;
+    static apiGatewayV2RequestContextToApiGatewayV1RequestContext(srcEvt: APIGatewayEventRequestContextV2): APIGatewayEventRequestContextWithAuthorizer<any>;
+    static findInMap<T>(toFind: string, map: Map<string, T>): T;
+    static matchExact(r: any, str: any): boolean;
+    static resolvePotentialFunctionToResult<T>(src: any, def: T): T;
+}

package/lib/util/context-util.d.ts

@@ -0,0 +1,33 @@
+import { Context, ProxyResult } from 'aws-lambda';
+import { EpsilonInstance } from '../epsilon-instance.js';
+import { InternalBackgroundEntry } from '../background/internal-background-entry.js';
+import { InterApiEntry } from '../inter-api/inter-api-entry.js';
+export declare class ContextUtil {
+    private static CURRENT_EPSILON_REFERENCE;
+    private static CURRENT_CONTEXT;
+    private static CURRENT_EVENT;
+    private static CURRENT_LOG_VARS;
+    private static CURRENT_PROCESS_LABEL;
+    private static CURRENT_OVERRIDE_TRACE_ID;
+    private static CURRENT_OVERRIDE_TRACE_DEPTH;
+    private constructor();
+    static initContext(epsilon: EpsilonInstance, evt: any, ctx: Context, processLabel: string): void;
+    static clearContext(): void;
+    static setOverrideTrace(traceId: string, traceDepth: number): void;
+    static setOverrideTraceFromInternalBackgroundEntry(entry: InternalBackgroundEntry<any>): void;
+    static setOverrideTraceFromInterApiEntry(interApiEntry: InterApiEntry<any>): void;
+    static addHeadersToRecord(input: Record<string, any>, depthOffset?: number): void;
+    static addTraceToProxyResult(pr: ProxyResult): void;
+    static addTraceToHttpRequestInit(ri: RequestInit): void;
+    static setProcessLabel(processLabel: string): void;
+    static currentRequestId(): string;
+    static remainingTimeMS(): number;
+    static currentProcessLabel(): string;
+    private static traceHeaderName;
+    private static traceDepthHeaderName;
+    static currentTraceId(): string;
+    static currentTraceDepth(): number;
+    static addLogVariable(name: string, val: string | number | boolean): void;
+    static fetchLogVariable(name: string): string | number | boolean;
+    static fetchLogVariables(): Record<string, string | number | boolean>;
+}

package/lib/util/cron-util.d.ts

@@ -0,0 +1,11 @@
+import { ScheduledEvent } from 'aws-lambda';
+import { AbstractCronEntry } from '../config/cron/abstract-cron-entry.js';
+import { CronConfig } from '../config/cron/cron-config.js';
+export declare class CronUtil {
+    static everyNMinuteFilter(n: number): number[];
+    static everyNDaysOfYearFilter(n: number): number[];
+    static everyNElementFilter(n: number, m: number): number[];
+    static numberMatchesFilter(num: number, filter: number[]): boolean;
+    static eventMatchesEntry(event: ScheduledEvent, entry: AbstractCronEntry, cfg: CronConfig, testTimeEpochMS?: number): boolean;
+    static cronEntryName(entry: AbstractCronEntry, idx?: number): string;
+}

package/lib/util/cron-util.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/util/epsilon-config-parser.d.ts

@@ -0,0 +1,14 @@
+import { ModelValidator } from '@bitblit/ratchet-misc';
+import { OpenApiDocument } from '../config/open-api/open-api-document.js';
+import { EpsilonConfig } from '../config/epsilon-config.js';
+import { EpsilonInstance } from '../epsilon-instance.js';
+import { EpsilonGlobalHandler } from '../epsilon-global-handler.js';
+import { BackgroundManagerLike } from '../background/manager/background-manager-like.js';
+export declare class EpsilonConfigParser {
+    constructor();
+    static epsilonConfigToEpsilonGlobalHandler(config: EpsilonConfig, backgroundManager?: BackgroundManagerLike): EpsilonGlobalHandler;
+    static epsilonConfigToEpsilonInstance(config: EpsilonConfig, backgroundManager?: BackgroundManagerLike): EpsilonInstance;
+    static parseOpenApiDocument(yamlString: string): OpenApiDocument;
+    static openApiDocToValidator(doc: OpenApiDocument): ModelValidator;
+    static validateGlobalConfig(config: EpsilonConfig): void;
+}

package/package.json

@@ -0,0 +1,129 @@
+{
+  "name": "@bitblit/ratchet-epsilon-common",
+  "version": "4.0.1-alpha",
+  "description": "Tiny adapter to simplify building API gateway Lambda APIS",
+  "sideEffects": false,
+  "bin": {
+    "epsilon-cli": "./bin/cli.js"
+  },
+  "type": "module",
+  "files": [
+    "lib/*",
+    "bin/*"
+  ],
+  "exports": {
+    ".": {
+      "types": "./lib/index.d.ts",
+      "import": "./lib/index.mjs"
+    }
+  },
+  "contributors": [
+    "Christopher Weiss <bitblit@gmail.com>",
+    "Benn Linger <benn@bennlinger.com>",
+    "Lucas Myers <veganbeef@protonmail.com>",
+    "Zach Herridge"
+  ],
+  "husky": {
+    "hooks": {
+      "pre-commit": "pretty-quick --staged"
+    }
+  },
+  "prettier": {
+    "printWidth": 140,
+    "singleQuote": true,
+    "arrowParens": "always"
+  },
+  "config": {},
+  "scripts": {
+    "watch": "tsc-watch",
+    "clean": "shx rm -Rf lib",
+    "test": "cross-env NODE_OPTIONS=--experimental-vm-modules jest",
+    "lint": "eslint src/**/*.ts",
+    "lint-fix": "eslint --fix src/**/*.ts",
+    "generate-barrels": "barrelsby -q --delete -d src -e .*\\.spec\\.ts && sed -i 's/\\x27;/.js\\x27;/' src/index.ts",
+    "build": "yarn clean && yarn generate-barrels && rollup -c rollup.config.js",
+    "force-build": "tsc --build --force",
+    "run-local-container-server": "yarn build && node bin/cli.js run-local-container-server",
+    "run-sample-server": "yarn build && node bin/cli.js run-sample-local-server",
+    "run-test-error-server": "yarn build && node bin/cli.js run-test-error-server",
+    "run-batch-sample-server": "yarn build && node bin/cli.js run-sample-local-batch-server",
+    "run-background-process-from-command-line-dry-run": "yarn build && node bin/cli.js run-background-process"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/bitblit/Ratchet"
+  },
+  "keywords": [
+    "epsilon",
+    "lambda",
+    "api gateway"
+  ],
+  "bugs": {
+    "url": "https://github.com/bitblit/Ratchet/issues"
+  },
+  "homepage": "https://github.com/bitblit/Ratchet#readme",
+  "engines": {
+    "node": ">=14.18"
+  },
+  "license": "Apache-2.0",
+  "dependencies": {
+    "@aws-sdk/client-s3": "3.332.0",
+    "@aws-sdk/client-sns": "3.332.0",
+    "@aws-sdk/client-sqs": "3.332.0",
+    "@bitblit/ratchet-aws": "4.0.1-alpha",
+    "@bitblit/ratchet-common": "4.0.1-alpha",
+    "@bitblit/ratchet-misc": "4.0.1-alpha",
+    "@bitblit/ratchet-node-only": "4.0.1-alpha",
+    "clear": "0.1.0",
+    "commander": "10.0.1",
+    "cross-fetch": "3.1.5",
+    "js-yaml": "4.1.0",
+    "jsonwebtoken": "9.0.0",
+    "jwks-rsa": "3.0.1",
+    "luxon": "3.3.0",
+    "reflect-metadata": "0.1.13",
+    "route-parser": "0.0.5",
+    "rxjs": "7.8.1",
+    "strip-js": "1.2.0",
+    "swagger-model-validator": "3.0.21"
+  },
+  "resolutions": {
+    "ansi-regex": "^5.0.1",
+    "ajv": "^6.12.6",
+    "axios": "^1.2.3",
+    "browserslist": "^4.21.4",
+    "express": "^4.18.2",
+    "follow-redirects": "^1.15.2",
+    "glob-parent": "^6.0.2",
+    "hosted-git-info": "^6.1.1",
+    "jose": "^4.11.2",
+    "json5": "^1.0.2",
+    "lodash": "^4.17.21",
+    "minimist": "^1.2.7",
+    "nanoid": "^4.0.0",
+    "node-fetch": "^2.6.7",
+    "nth-check": "^2.1.1",
+    "object-path": "^0.11.8",
+    "path-parse": "^1.0.7",
+    "shelljs": "^0.8.5",
+    "sanitize-html": "^2.8.0",
+    "semver-regex": "^4.0.5",
+    "tmpl": "^1.0.5",
+    "ws": "^8.12.0",
+    "y18n": "^5.0.8"
+  },
+  "peerDependencies": {
+  },
+  "peerDependenciesMeta": {
+    "graphql": {
+      "optional": true
+    }
+  },
+  "devDependencies": {
+    "@bitblit/ratchet-jest": "4.0.1-alpha",
+    "@types/aws-lambda": "8.10.115",
+    "apollo-server-lambda": "3.12.0",
+    "aws-sdk-client-mock": "2.1.1",
+    "graphql": "16.6.0"
+  }
+}