@bitblit/ratchet-epsilon-common 4.0.183-alpha → 4.0.184-alpha

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/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';
+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" resolution-mode="require"/>
+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,34 @@
+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 defaultedCurrentRequestId(defaultValueIfMissing?: string): 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

@@ -1,6 +1,6 @@
 {
   "name": "@bitblit/ratchet-epsilon-common",
-  "version": "4.0.183-alpha",
+  "version": "4.0.184-alpha",
   "description": "Tiny adapter to simplify building API gateway Lambda APIS",
   "sideEffects": false,
   "bin": {
@@ -10,8 +10,8 @@
   "module": "./lib/index.mjs",
   "types": "./lib/index.d.ts",
   "files": [
-    "lib/*",
-    "bin/*"
+    "lib/**",
+    "bin/**"
   ],
   "exports": {
     ".": {
@@ -68,10 +68,10 @@
     "@aws-sdk/client-sqs": "3.357.0",
     "@aws-sdk/types": "3.357.0",
     "@aws-sdk/util-waiter": "3.357.0",
-    "@bitblit/ratchet-aws": "4.0.183-alpha",
-    "@bitblit/ratchet-common": "4.0.183-alpha",
-    "@bitblit/ratchet-misc": "4.0.183-alpha",
-    "@bitblit/ratchet-node-only": "4.0.183-alpha",
+    "@bitblit/ratchet-aws": "4.0.184-alpha",
+    "@bitblit/ratchet-common": "4.0.184-alpha",
+    "@bitblit/ratchet-misc": "4.0.184-alpha",
+    "@bitblit/ratchet-node-only": "4.0.184-alpha",
     "clear": "0.1.0",
     "commander": "11.0.0",
     "cross-fetch": "4.0.0",
@@ -118,7 +118,7 @@
   },
   "devDependencies": {
     "@apollo/server": "4.7.5",
-    "@bitblit/ratchet-jest": "4.0.183-alpha",
+    "@bitblit/ratchet-jest": "4.0.184-alpha",
     "@types/aws-lambda": "8.10.119",
     "aws-sdk-client-mock": "3.0.0",
     "graphql": "16.7.1",