@powersync/lib-services-framework 0.0.0-dev-20240620165410

package/dist/index.js

@@ -0,0 +1,19 @@
+export * from './alerts/alerts-index.js';
+export * as alerts from './alerts/alerts-index.js';
+export * from './codec/codec-index.js';
+export * as codecs from './codec/codec-index.js';
+export * from './container.js';
+export * from './errors/errors-index.js';
+export * as errors from './errors/errors-index.js';
+export * from './logger/Logger.js';
+export * from './schema/schema-index.js';
+export * as schema from './schema/schema-index.js';
+export * from './signals/signals-index.js';
+export * as signals from './signals/signals-index.js';
+export * from './router/router-index.js';
+export * as router from './router/router-index.js';
+export * from './system/LifeCycledSystem.js';
+export * as system from './system/system-index.js';
+export * from './utils/utils-index.js';
+export * as utils from './utils/utils-index.js';
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,0BAA0B,CAAC;AACzC,OAAO,KAAK,MAAM,MAAM,0BAA0B,CAAC;AAEnD,cAAc,wBAAwB,CAAC;AACvC,OAAO,KAAK,MAAM,MAAM,wBAAwB,CAAC;AAEjD,cAAc,gBAAgB,CAAC;AAE/B,cAAc,0BAA0B,CAAC;AACzC,OAAO,KAAK,MAAM,MAAM,0BAA0B,CAAC;AAEnD,cAAc,oBAAoB,CAAC;AAEnC,cAAc,0BAA0B,CAAC;AACzC,OAAO,KAAK,MAAM,MAAM,0BAA0B,CAAC;AAEnD,cAAc,4BAA4B,CAAC;AAC3C,OAAO,KAAK,OAAO,MAAM,4BAA4B,CAAC;AAEtD,cAAc,0BAA0B,CAAC;AACzC,OAAO,KAAK,MAAM,MAAM,0BAA0B,CAAC;AAEnD,cAAc,8BAA8B,CAAC;AAC7C,OAAO,KAAK,MAAM,MAAM,0BAA0B,CAAC;AAEnD,cAAc,wBAAwB,CAAC;AACvC,OAAO,KAAK,KAAK,MAAM,wBAAwB,CAAC"}

package/dist/logger/Logger.d.ts

@@ -0,0 +1,6 @@
+import winston from 'winston';
+export declare namespace Logger {
+    const development_format: winston.Logform.Format;
+    const production_format: winston.Logform.Format;
+}
+export declare const logger: winston.Logger;

package/dist/logger/Logger.js

@@ -0,0 +1,13 @@
+import winston from 'winston';
+export var Logger;
+(function (Logger) {
+    Logger.development_format = winston.format.combine(winston.format.colorize({ level: true }), winston.format.simple());
+    Logger.production_format = winston.format.combine(winston.format.timestamp(), winston.format.json());
+})(Logger || (Logger = {}));
+export const logger = winston.createLogger();
+// Configure logging to console as the default
+logger.configure({
+    format: process.env.NODE_ENV == 'production' ? Logger.production_format : Logger.development_format,
+    transports: [new winston.transports.Console()]
+});
+//# sourceMappingURL=Logger.js.map

package/dist/logger/Logger.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Logger.js","sourceRoot":"","sources":["../../src/logger/Logger.ts"],"names":[],"mappings":"AAAA,OAAO,OAAO,MAAM,SAAS,CAAC;AAE9B,MAAM,KAAW,MAAM,CAMtB;AAND,WAAiB,MAAM;IACR,yBAAkB,GAAG,OAAO,CAAC,MAAM,CAAC,OAAO,CACtD,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,EACxC,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,CACxB,CAAC;IACW,wBAAiB,GAAG,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,SAAS,EAAE,EAAE,OAAO,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC;AAC7G,CAAC,EANgB,MAAM,KAAN,MAAM,QAMtB;AAED,MAAM,CAAC,MAAM,MAAM,GAAG,OAAO,CAAC,YAAY,EAAE,CAAC;AAE7C,8CAA8C;AAC9C,MAAM,CAAC,SAAS,CAAC;IACf,MAAM,EAAE,OAAO,CAAC,GAAG,CAAC,QAAQ,IAAI,YAAY,CAAC,CAAC,CAAC,MAAM,CAAC,iBAAiB,CAAC,CAAC,CAAC,MAAM,CAAC,kBAAkB;IACnG,UAAU,EAAE,CAAC,IAAI,OAAO,CAAC,UAAU,CAAC,OAAO,EAAE,CAAC;CAC/C,CAAC,CAAC"}

package/dist/logger/logger-index.d.ts

@@ -0,0 +1 @@
+export * from './Logger.js';

package/dist/logger/logger-index.js

@@ -0,0 +1,2 @@
+export * from './Logger.js';
+//# sourceMappingURL=logger-index.js.map

package/dist/logger/logger-index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"logger-index.js","sourceRoot":"","sources":["../../src/logger/logger-index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAC"}

package/dist/router/endpoint.d.ts

@@ -0,0 +1,7 @@
+import { Endpoint, EndpointHandlerPayload } from './router-definitions.js';
+/**
+ * Executes an endpoint's definition in the correct lifecycle order:
+ *  Validations are checked. A {@link ValidationError} is thrown if validations fail.
+ *  Authorization is checked. A {@link AuthorizationError} is thrown if checks fail.
+ */
+export declare const executeEndpoint: <I, O, C, P extends EndpointHandlerPayload<I, C>>(endpoint: Endpoint<I, O, C, P>, payload: P) => Promise<O>;

package/dist/router/endpoint.js

@@ -0,0 +1,18 @@
+import * as errors from '../errors/errors-index.js';
+/**
+ * Executes an endpoint's definition in the correct lifecycle order:
+ *  Validations are checked. A {@link ValidationError} is thrown if validations fail.
+ *  Authorization is checked. A {@link AuthorizationError} is thrown if checks fail.
+ */
+export const executeEndpoint = async (endpoint, payload) => {
+    const validation_response = await endpoint.validator?.validate(payload.params);
+    if (validation_response && !validation_response.valid) {
+        throw new errors.ValidationError(validation_response.errors);
+    }
+    const authorizer_response = await endpoint.authorize?.(payload);
+    if (authorizer_response && !authorizer_response.authorized) {
+        throw new errors.AuthorizationError(authorizer_response.errors);
+    }
+    return endpoint.handler(payload);
+};
+//# sourceMappingURL=endpoint.js.map

package/dist/router/endpoint.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"endpoint.js","sourceRoot":"","sources":["../../src/router/endpoint.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,MAAM,2BAA2B,CAAC;AAGpD;;;;GAIG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,KAAK,EAClC,QAA8B,EAC9B,OAAU,EACV,EAAE;IACF,MAAM,mBAAmB,GAAG,MAAM,QAAQ,CAAC,SAAS,EAAE,QAAQ,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IAC/E,IAAI,mBAAmB,IAAI,CAAC,mBAAmB,CAAC,KAAK,EAAE;QACrD,MAAM,IAAI,MAAM,CAAC,eAAe,CAAC,mBAAmB,CAAC,MAAM,CAAC,CAAC;KAC9D;IACD,MAAM,mBAAmB,GAAG,MAAM,QAAQ,CAAC,SAAS,EAAE,CAAC,OAAO,CAAC,CAAC;IAChE,IAAI,mBAAmB,IAAI,CAAC,mBAAmB,CAAC,UAAU,EAAE;QAC1D,MAAM,IAAI,MAAM,CAAC,kBAAkB,CAAC,mBAAmB,CAAC,MAAM,CAAC,CAAC;KACjE;IAED,OAAO,QAAQ,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;AACnC,CAAC,CAAC"}

package/dist/router/router-definitions.d.ts

@@ -0,0 +1,44 @@
+import { MicroValidator } from '../schema/definitions.js';
+/**
+ * Subset of HTTP methods used in route definitions
+ */
+export declare enum HTTPMethod {
+    'DELETE' = "DELETE",
+    'GET' = "GET",
+    'HEAD' = "HEAD",
+    'PATCH' = "PATCH",
+    'POST' = "POST",
+    'PUT' = "PUT",
+    'OPTIONS' = "OPTIONS"
+}
+/**
+ * Response for authorization checks in route definitions
+ */
+export type AuthorizationResponse = {
+    authorized: true;
+} | {
+    authorized: false;
+    errors?: any[];
+};
+/**
+ * Payload which is passed to route endpoint handler functions
+ */
+export type EndpointHandlerPayload<P, C> = {
+    params: P;
+    context: C;
+};
+/**
+ * A route endpoint handler function
+ */
+export type EndpointHandler<P, O> = (payload: P) => O | Promise<O>;
+/**
+ * The definition of a route endpoint
+ */
+export type Endpoint<I, O, C, P = EndpointHandlerPayload<I, C>, H = EndpointHandler<P, O>> = {
+    path: string;
+    method: HTTPMethod;
+    tags?: EndpointHandler<P, Record<string, string>>;
+    authorize?: EndpointHandler<P, AuthorizationResponse>;
+    validator?: MicroValidator<I>;
+    handler: H;
+};

package/dist/router/router-definitions.js

@@ -0,0 +1,14 @@
+/**
+ * Subset of HTTP methods used in route definitions
+ */
+export var HTTPMethod;
+(function (HTTPMethod) {
+    HTTPMethod["DELETE"] = "DELETE";
+    HTTPMethod["GET"] = "GET";
+    HTTPMethod["HEAD"] = "HEAD";
+    HTTPMethod["PATCH"] = "PATCH";
+    HTTPMethod["POST"] = "POST";
+    HTTPMethod["PUT"] = "PUT";
+    HTTPMethod["OPTIONS"] = "OPTIONS";
+})(HTTPMethod || (HTTPMethod = {}));
+//# sourceMappingURL=router-definitions.js.map

package/dist/router/router-definitions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"router-definitions.js","sourceRoot":"","sources":["../../src/router/router-definitions.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,CAAN,IAAY,UAQX;AARD,WAAY,UAAU;IACpB,+BAAmB,CAAA;IACnB,yBAAa,CAAA;IACb,2BAAe,CAAA;IACf,6BAAiB,CAAA;IACjB,2BAAe,CAAA;IACf,yBAAa,CAAA;IACb,iCAAqB,CAAA;AACvB,CAAC,EARW,UAAU,KAAV,UAAU,QAQrB"}

package/dist/router/router-index.d.ts

@@ -0,0 +1,3 @@
+export * from './router-definitions.js';
+export * from './router-response.js';
+export * from './endpoint.js';

package/dist/router/router-index.js

@@ -0,0 +1,4 @@
+export * from './router-definitions.js';
+export * from './router-response.js';
+export * from './endpoint.js';
+//# sourceMappingURL=router-index.js.map

package/dist/router/router-index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"router-index.js","sourceRoot":"","sources":["../../src/router/router-index.ts"],"names":[],"mappings":"AAAA,cAAc,yBAAyB,CAAC;AACxC,cAAc,sBAAsB,CAAC;AACrC,cAAc,eAAe,CAAC"}

package/dist/router/router-response.d.ts

@@ -0,0 +1,24 @@
+export declare const isAsyncIterable: (iterable: any) => iterable is AsyncIterable<any>;
+export type RouterResponseParams<T> = {
+    status?: number;
+    data: T;
+    headers?: Record<string, string>;
+    /**
+     * Hook to be called after the response has been sent
+     */
+    afterSend?: () => Promise<void>;
+};
+/**
+ * Wrapper for router responses.
+ * A {@link EndpointHandler} can return a raw JSON object to be used as the response data
+ * payload or a [RouterResponse] which allows for more granular control of what is sent.
+ */
+export declare class RouterResponse<T = unknown> {
+    status: number;
+    data: T;
+    headers: Record<string, string>;
+    afterSend: () => Promise<void>;
+    __micro_router_response: boolean;
+    static isRouterResponse(input: any): input is RouterResponse;
+    constructor(params: RouterResponseParams<T>);
+}

package/dist/router/router-response.js

@@ -0,0 +1,32 @@
+export const isAsyncIterable = (iterable) => {
+    return iterable != null && typeof iterable === 'object' && Symbol.asyncIterator in iterable;
+};
+/**
+ * Wrapper for router responses.
+ * A {@link EndpointHandler} can return a raw JSON object to be used as the response data
+ * payload or a [RouterResponse] which allows for more granular control of what is sent.
+ */
+export class RouterResponse {
+    static isRouterResponse(input) {
+        return input instanceof RouterResponse || input?.__micro_router_response == true;
+    }
+    constructor(params) {
+        this.__micro_router_response = true;
+        this.status = params.status || 200;
+        this.data = params.data;
+        this.headers = params.headers || {};
+        this.afterSend = params.afterSend ?? (() => Promise.resolve());
+        if (!this.headers['Content-Type']) {
+            if (isAsyncIterable(this.data)) {
+                this.headers['Content-Type'] = 'application/octet-stream';
+            }
+            else if (Buffer.isBuffer(this.data)) {
+                this.headers['Content-Type'] = 'application/octet-stream';
+            }
+            else {
+                this.headers['Content-Type'] = 'application/json';
+            }
+        }
+    }
+}
+//# sourceMappingURL=router-response.js.map

package/dist/router/router-response.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"router-response.js","sourceRoot":"","sources":["../../src/router/router-response.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,QAAa,EAAkC,EAAE;IAC/E,OAAO,QAAQ,IAAI,IAAI,IAAI,OAAO,QAAQ,KAAK,QAAQ,IAAI,MAAM,CAAC,aAAa,IAAI,QAAQ,CAAC;AAC9F,CAAC,CAAC;AAYF;;;;GAIG;AACH,MAAM,OAAO,cAAc;IAQzB,MAAM,CAAC,gBAAgB,CAAC,KAAU;QAChC,OAAO,KAAK,YAAY,cAAc,IAAI,KAAK,EAAE,uBAAuB,IAAI,IAAI,CAAC;IACnF,CAAC;IAED,YAAY,MAA+B;QAN3C,4BAAuB,GAAG,IAAI,CAAC;QAO7B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,IAAI,GAAG,CAAC;QACnC,IAAI,CAAC,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC;QACxB,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,OAAO,IAAI,EAAE,CAAC;QACpC,IAAI,CAAC,SAAS,GAAG,MAAM,CAAC,SAAS,IAAI,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC;QAE/D,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,EAAE;YACjC,IAAI,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE;gBAC9B,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,GAAG,0BAA0B,CAAC;aAC3D;iBAAM,IAAI,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE;gBACrC,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,GAAG,0BAA0B,CAAC;aAC3D;iBAAM;gBACL,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,GAAG,kBAAkB,CAAC;aACnD;SACF;IACH,CAAC;CACF"}

package/dist/schema/definitions.d.ts

@@ -0,0 +1,16 @@
+export type JSONSchema = {
+    definitions?: Record<string, any>;
+    [key: string]: any;
+};
+export type IValidationRight = {
+    valid: true;
+};
+export type ValidationLeft<T = string[]> = {
+    valid: false;
+    errors: T;
+};
+export type ValidationResponse<T, E = string[]> = ValidationLeft<E> | IValidationRight;
+export type MicroValidator<T = any, E = string[]> = {
+    validate: (data: T) => ValidationResponse<T, E>;
+    toJSONSchema?: () => JSONSchema;
+};

package/dist/schema/definitions.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=definitions.js.map

package/dist/schema/definitions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"definitions.js","sourceRoot":"","sources":["../../src/schema/definitions.ts"],"names":[],"mappings":""}

package/dist/schema/json-schema/keywords.d.ts

@@ -0,0 +1,2 @@
+import * as ajv from 'ajv';
+export declare const BufferNodeType: ajv.KeywordDefinition;

package/dist/schema/json-schema/keywords.js

@@ -0,0 +1,27 @@
+import * as ajv from 'ajv';
+export const BufferNodeType = {
+    keyword: 'nodeType',
+    metaSchema: {
+        type: 'string',
+        enum: ['buffer', 'date']
+    },
+    error: {
+        message: ({ schemaCode }) => {
+            return ajv.str `should be a ${schemaCode}`;
+        }
+    },
+    code(context) {
+        switch (context.schema) {
+            case 'buffer': {
+                return context.fail(ajv._ `!Buffer.isBuffer(${context.data})`);
+            }
+            case 'date': {
+                return context.fail(ajv._ `!(${context.data} instanceof Date)`);
+            }
+            default: {
+                context.fail(ajv._ `true`);
+            }
+        }
+    }
+};
+//# sourceMappingURL=keywords.js.map

package/dist/schema/json-schema/keywords.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"keywords.js","sourceRoot":"","sources":["../../../src/schema/json-schema/keywords.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,GAAG,MAAM,KAAK,CAAC;AAE3B,MAAM,CAAC,MAAM,cAAc,GAA0B;IACnD,OAAO,EAAE,UAAU;IACnB,UAAU,EAAE;QACV,IAAI,EAAE,QAAQ;QACd,IAAI,EAAE,CAAC,QAAQ,EAAE,MAAM,CAAC;KACzB;IACD,KAAK,EAAE;QACL,OAAO,EAAE,CAAC,EAAE,UAAU,EAAE,EAAE,EAAE;YAC1B,OAAO,GAAG,CAAC,GAAG,CAAA,eAAe,UAAU,EAAE,CAAC;QAC5C,CAAC;KACF;IACD,IAAI,CAAC,OAAO;QACV,QAAQ,OAAO,CAAC,MAAM,EAAE;YACtB,KAAK,QAAQ,CAAC,CAAC;gBACb,OAAO,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAA,oBAAoB,OAAO,CAAC,IAAI,GAAG,CAAC,CAAC;aAC/D;YACD,KAAK,MAAM,CAAC,CAAC;gBACX,OAAO,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAA,KAAK,OAAO,CAAC,IAAI,mBAAmB,CAAC,CAAC;aAChE;YACD,OAAO,CAAC,CAAC;gBACP,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAA,MAAM,CAAC,CAAC;aAC3B;SACF;IACH,CAAC;CACF,CAAC"}

package/dist/schema/json-schema/parser.d.ts

@@ -0,0 +1,39 @@
+import * as schema_validator from '../validators/schema-validator.js';
+import * as defs from '../definitions.js';
+/**
+ * Recursively walk a given schema resolving a list of refs that are actively used in some way by the
+ * root schema. This information can then later be used to prune unused definitions.
+ *
+ * This only works for top-level references to 'definitions' as this is intended to be used in
+ * conjunction with tools that generate schemas in deterministic ways. For a more general
+ * implementation one should make use of `$RefParser`.
+ *
+ * We don't use this here as it resolves to a Promise, which we want to avoid for this tool
+ */
+export declare const findUsedRefs: (schema: any, definitions?: any, cache?: string[]) => string[];
+/**
+ * Prune a given subschema definitions map by comparing keys against a given collection of
+ * definition keys that are referenced in some way, either directly or indirectly, by the
+ * root schema
+ */
+export declare const pruneDefinitions: (definitions: Record<string, any>, refs: string[]) => Record<string, any>;
+export type CompilerFunction = () => defs.JSONSchema;
+export type ValidatorFunction = <T>(params?: schema_validator.CreateSchemaValidatorParams) => schema_validator.SchemaValidator<T>;
+export type Compilers = {
+    compile: CompilerFunction;
+    validator: ValidatorFunction;
+};
+export type WithCompilers<T> = Compilers & {
+    [P in keyof T]: T[P] extends Record<string, any> ? WithCompilers<T[P]> : T[P];
+};
+/**
+ * Given a JSON Schema containing a `definitions` entry, return a Proxy representation of the same
+ * schema which responds to `compile` and `validator` arbitrarily deep.
+ *
+ * Calling compile on a sub-schema will 'inject' the root schema `definitions` mapping and remove
+ * the Proxy wrapping.
+ *
+ * Calling `validator` on a sub-schema will `compile` and then create a SchemaValidator from the
+ * resulting schema
+ */
+export declare const parseJSONSchema: <T extends defs.JSONSchema>(schema: T, definitions?: Record<string, any> | undefined) => WithCompilers<T>;

package/dist/schema/json-schema/parser.js

@@ -0,0 +1,100 @@
+import * as schema_validator from '../validators/schema-validator.js';
+/**
+ * Recursively walk a given schema resolving a list of refs that are actively used in some way by the
+ * root schema. This information can then later be used to prune unused definitions.
+ *
+ * This only works for top-level references to 'definitions' as this is intended to be used in
+ * conjunction with tools that generate schemas in deterministic ways. For a more general
+ * implementation one should make use of `$RefParser`.
+ *
+ * We don't use this here as it resolves to a Promise, which we want to avoid for this tool
+ */
+export const findUsedRefs = (schema, definitions = schema.definitions, cache = []) => {
+    if (Array.isArray(schema)) {
+        return schema
+            .map((subschema) => {
+            return findUsedRefs(subschema, definitions, cache);
+        })
+            .flat();
+    }
+    if (typeof schema === 'object') {
+        return Object.keys(schema).reduce((used, key) => {
+            const value = schema[key];
+            if (key === '$ref') {
+                if (cache.includes(value)) {
+                    return used;
+                }
+                cache.push(value);
+                const subschema = definitions[value.replace('#/definitions/', '')];
+                used.push(value, ...findUsedRefs(subschema, definitions, cache));
+                return used;
+            }
+            if (key === 'definitions') {
+                return used;
+            }
+            return used.concat(findUsedRefs(value, definitions, cache));
+        }, []);
+    }
+    return [];
+};
+/**
+ * Prune a given subschema definitions map by comparing keys against a given collection of
+ * definition keys that are referenced in some way, either directly or indirectly, by the
+ * root schema
+ */
+export const pruneDefinitions = (definitions, refs) => {
+    return Object.keys(definitions).reduce((pruned, key) => {
+        if (refs.includes(`#/definitions/${key}`)) {
+            pruned[key] = definitions[key];
+        }
+        return pruned;
+    }, {});
+};
+/**
+ * Given a JSON Schema containing a `definitions` entry, return a Proxy representation of the same
+ * schema which responds to `compile` and `validator` arbitrarily deep.
+ *
+ * Calling compile on a sub-schema will 'inject' the root schema `definitions` mapping and remove
+ * the Proxy wrapping.
+ *
+ * Calling `validator` on a sub-schema will `compile` and then create a SchemaValidator from the
+ * resulting schema
+ */
+export const parseJSONSchema = (schema, definitions = schema.definitions) => {
+    return new Proxy(schema, {
+        get(target, prop) {
+            const compile = () => {
+                const schema = {
+                    definitions: definitions,
+                    ...target
+                };
+                if (!schema.definitions) {
+                    return schema;
+                }
+                const used = findUsedRefs(schema);
+                return {
+                    ...schema,
+                    definitions: pruneDefinitions(schema.definitions, used)
+                };
+            };
+            const validator = (options) => {
+                return schema_validator.createSchemaValidator(compile(), options);
+            };
+            if (prop === 'compile') {
+                return compile;
+            }
+            if (prop === 'validator') {
+                return validator;
+            }
+            const subschema = target[prop];
+            if (Array.isArray(subschema)) {
+                return subschema;
+            }
+            if (typeof subschema !== 'object') {
+                return subschema;
+            }
+            return parseJSONSchema(subschema, definitions);
+        }
+    });
+};
+//# sourceMappingURL=parser.js.map

package/dist/schema/json-schema/parser.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"parser.js","sourceRoot":"","sources":["../../../src/schema/json-schema/parser.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,gBAAgB,MAAM,mCAAmC,CAAC;AAGtE;;;;;;;;;GASG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,MAAW,EAAE,WAAW,GAAG,MAAM,CAAC,WAAW,EAAE,QAAkB,EAAE,EAAY,EAAE;IAC5G,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE;QACzB,OAAO,MAAM;aACV,GAAG,CAAC,CAAC,SAAS,EAAE,EAAE;YACjB,OAAO,YAAY,CAAC,SAAS,EAAE,WAAW,EAAE,KAAK,CAAC,CAAC;QACrD,CAAC,CAAC;aACD,IAAI,EAAE,CAAC;KACX;IAED,IAAI,OAAO,MAAM,KAAK,QAAQ,EAAE;QAC9B,OAAO,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,CAAC,IAAc,EAAE,GAAG,EAAE,EAAE;YACxD,MAAM,KAAK,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC;YAC1B,IAAI,GAAG,KAAK,MAAM,EAAE;gBAClB,IAAI,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE;oBACzB,OAAO,IAAI,CAAC;iBACb;gBACD,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;gBAClB,MAAM,SAAS,GAAG,WAAW,CAAC,KAAK,CAAC,OAAO,CAAC,gBAAgB,EAAE,EAAE,CAAC,CAAC,CAAC;gBACnE,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,GAAG,YAAY,CAAC,SAAS,EAAE,WAAW,EAAE,KAAK,CAAC,CAAC,CAAC;gBACjE,OAAO,IAAI,CAAC;aACb;YACD,IAAI,GAAG,KAAK,aAAa,EAAE;gBACzB,OAAO,IAAI,CAAC;aACb;YACD,OAAO,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,KAAK,EAAE,WAAW,EAAE,KAAK,CAAC,CAAC,CAAC;QAC9D,CAAC,EAAE,EAAE,CAAC,CAAC;KACR;IAED,OAAO,EAAE,CAAC;AACZ,CAAC,CAAC;AAEF;;;;GAIG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,WAAgC,EAAE,IAAc,EAAE,EAAE;IACnF,OAAO,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,MAAM,CAAC,CAAC,MAA2B,EAAE,GAAG,EAAE,EAAE;QAC1E,IAAI,IAAI,CAAC,QAAQ,CAAC,iBAAiB,GAAG,EAAE,CAAC,EAAE;YACzC,MAAM,CAAC,GAAG,CAAC,GAAG,WAAW,CAAC,GAAG,CAAC,CAAC;SAChC;QACD,OAAO,MAAM,CAAC;IAChB,CAAC,EAAE,EAAE,CAAC,CAAC;AACT,CAAC,CAAC;AAeF;;;;;;;;;GASG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,CAC7B,MAAS,EACT,WAAW,GAAG,MAAM,CAAC,WAAW,EACd,EAAE;IACpB,OAAO,IAAI,KAAK,CAAC,MAAM,EAAE;QACvB,GAAG,CAAC,MAAW,EAAE,IAAI;YACnB,MAAM,OAAO,GAAqB,GAAG,EAAE;gBACrC,MAAM,MAAM,GAAG;oBACb,WAAW,EAAE,WAAW;oBACxB,GAAG,MAAM;iBACV,CAAC;gBAEF,IAAI,CAAC,MAAM,CAAC,WAAW,EAAE;oBACvB,OAAO,MAAM,CAAC;iBACf;gBAED,MAAM,IAAI,GAAG,YAAY,CAAC,MAAM,CAAC,CAAC;gBAClC,OAAO;oBACL,GAAG,MAAM;oBACT,WAAW,EAAE,gBAAgB,CAAC,MAAM,CAAC,WAAW,EAAE,IAAI,CAAC;iBACxD,CAAC;YACJ,CAAC,CAAC;YACF,MAAM,SAAS,GAAsB,CAAC,OAAO,EAAE,EAAE;gBAC/C,OAAO,gBAAgB,CAAC,qBAAqB,CAAC,OAAO,EAAE,EAAE,OAAO,CAAC,CAAC;YACpE,CAAC,CAAC;YAEF,IAAI,IAAI,KAAK,SAAS,EAAE;gBACtB,OAAO,OAAO,CAAC;aAChB;YACD,IAAI,IAAI,KAAK,WAAW,EAAE;gBACxB,OAAO,SAAS,CAAC;aAClB;YAED,MAAM,SAAS,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC;YAE/B,IAAI,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE;gBAC5B,OAAO,SAAS,CAAC;aAClB;YACD,IAAI,OAAO,SAAS,KAAK,QAAQ,EAAE;gBACjC,OAAO,SAAS,CAAC;aAClB;YAED,OAAO,eAAe,CAAC,SAAS,EAAE,WAAW,CAAC,CAAC;QACjD,CAAC;KACF,CAAC,CAAC;AACL,CAAC,CAAC"}

package/dist/schema/schema-index.d.ts

@@ -0,0 +1,5 @@
+export * from './definitions.js';
+export * from './json-schema/keywords.js';
+export * from './json-schema/parser.js';
+export * from './validators/schema-validator.js';
+export * from './validators/ts-codec-validator.js';

package/dist/schema/schema-index.js

@@ -0,0 +1,6 @@
+export * from './definitions.js';
+export * from './json-schema/keywords.js';
+export * from './json-schema/parser.js';
+export * from './validators/schema-validator.js';
+export * from './validators/ts-codec-validator.js';
+//# sourceMappingURL=schema-index.js.map

package/dist/schema/schema-index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"schema-index.js","sourceRoot":"","sources":["../../src/schema/schema-index.ts"],"names":[],"mappings":"AAAA,cAAc,kBAAkB,CAAC;AAEjC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,yBAAyB,CAAC;AACxC,cAAc,kCAAkC,CAAC;AACjD,cAAc,oCAAoC,CAAC"}

package/dist/schema/utils.d.ts

@@ -0,0 +1,15 @@
+import * as defs from './definitions.js';
+export type Schema = {
+    additionalProperties?: boolean | Schema;
+    [key: string]: any;
+};
+/**
+ * Utility function to strip out `additionalProperties` fields from a given JSON-Schema. This can be used
+ * to make a schema less strict which may be necessary for certain use-cases
+ */
+export declare const allowAdditionalProperties: <T extends Schema>(schema: T) => T;
+/**
+ * A small utility for validating some data using a MicroValidator. Will return the valid data (typed correctly) or throw
+ * a validation error
+ */
+export declare const validateData: <T>(event: any, validator: defs.MicroValidator<T, string[]>) => T;

package/dist/schema/utils.js

@@ -0,0 +1,40 @@
+import * as errors from '../errors/errors-index.js';
+/**
+ * Utility function to strip out `additionalProperties` fields from a given JSON-Schema. This can be used
+ * to make a schema less strict which may be necessary for certain use-cases
+ */
+export const allowAdditionalProperties = (schema) => {
+    return Object.keys(schema).reduce((next_schema, key) => {
+        const value = schema[key];
+        if (key === 'additionalProperties' && typeof value === 'boolean') {
+            return next_schema;
+        }
+        if (Array.isArray(value)) {
+            next_schema[key] = value.map((value) => {
+                if (typeof value !== 'object') {
+                    return value;
+                }
+                return allowAdditionalProperties(value);
+            });
+        }
+        else if (typeof value === 'object') {
+            next_schema[key] = allowAdditionalProperties(value);
+        }
+        else {
+            next_schema[key] = value;
+        }
+        return next_schema;
+    }, {});
+};
+/**
+ * A small utility for validating some data using a MicroValidator. Will return the valid data (typed correctly) or throw
+ * a validation error
+ */
+export const validateData = (event, validator) => {
+    const result = validator.validate(event);
+    if (!result.valid) {
+        throw new errors.ValidationError(result.errors);
+    }
+    return event;
+};
+//# sourceMappingURL=utils.js.map

package/dist/schema/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../src/schema/utils.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,MAAM,2BAA2B,CAAC;AAQpD;;;GAGG;AACH,MAAM,CAAC,MAAM,yBAAyB,GAAG,CAAmB,MAAS,EAAK,EAAE;IAC1E,OAAO,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,CAAC,WAAgB,EAAE,GAAG,EAAE,EAAE;QAC1D,MAAM,KAAK,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC;QAE1B,IAAI,GAAG,KAAK,sBAAsB,IAAI,OAAO,KAAK,KAAK,SAAS,EAAE;YAChE,OAAO,WAAW,CAAC;SACpB;QAED,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE;YACxB,WAAW,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE;gBACrC,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;oBAC7B,OAAO,KAAK,CAAC;iBACd;gBACD,OAAO,yBAAyB,CAAC,KAAK,CAAC,CAAC;YAC1C,CAAC,CAAC,CAAC;SACJ;aAAM,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;YACpC,WAAW,CAAC,GAAG,CAAC,GAAG,yBAAyB,CAAC,KAAK,CAAC,CAAC;SACrD;aAAM;YACL,WAAW,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;SAC1B;QAED,OAAO,WAAW,CAAC;IACrB,CAAC,EAAE,EAAE,CAAC,CAAC;AACT,CAAC,CAAC;AAEF;;;GAGG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG,CAAI,KAAU,EAAE,SAAiC,EAAK,EAAE;IAClF,MAAM,MAAM,GAAG,SAAS,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;IACzC,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE;QACjB,MAAM,IAAI,MAAM,CAAC,eAAe,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;KACjD;IACD,OAAO,KAAK,CAAC;AACf,CAAC,CAAC"}

package/dist/schema/validators/schema-validator.d.ts

@@ -0,0 +1,21 @@
+import AJV from 'ajv';
+import * as defs from '../definitions.js';
+export declare class SchemaValidatorError extends Error {
+    constructor(message: string);
+}
+export type SchemaValidator<T> = defs.MicroValidator<T>;
+export type CreateSchemaValidatorParams = {
+    ajv?: AJV.Options;
+    /**
+     * Allow making the given schema loosely typed to allow accepting additional properties. This
+     * is useful in certain scenarios such as accepting kafka events that are going through a
+     * migration and having additional properties set
+     */
+    allowAdditional?: boolean;
+    fail_fast?: boolean;
+};
+/**
+ * Create a validator from a given JSON-Schema schema object. This makes uses of AJV internally
+ * to compile a validation function
+ */
+export declare const createSchemaValidator: <T = any>(schema: defs.JSONSchema, params?: CreateSchemaValidatorParams) => SchemaValidator<T>;

package/dist/schema/validators/schema-validator.js

@@ -0,0 +1,55 @@
+// @ts-ignore
+import AjvErrorFormatter from 'better-ajv-errors';
+import AJV from 'ajv';
+import * as utils from '../utils.js';
+import * as keywords from '../json-schema/keywords.js';
+export class SchemaValidatorError extends Error {
+    constructor(message) {
+        super(message);
+        this.name = this.constructor.name;
+    }
+}
+/**
+ * Create a validator from a given JSON-Schema schema object. This makes uses of AJV internally
+ * to compile a validation function
+ */
+export const createSchemaValidator = (schema, params = {}) => {
+    try {
+        const ajv = new AJV.Ajv({
+            allErrors: !(params.fail_fast ?? false),
+            keywords: [keywords.BufferNodeType],
+            ...(params.ajv || {})
+        });
+        let processed_schema = schema;
+        if (params.allowAdditional) {
+            processed_schema = utils.allowAdditionalProperties(processed_schema);
+        }
+        const validator = ajv.compile(processed_schema);
+        return {
+            toJSONSchema: () => {
+                return schema;
+            },
+            validate: (data) => {
+                const valid = validator(data);
+                if (!valid) {
+                    const errors = AjvErrorFormatter(processed_schema, data, validator.errors || [], {
+                        format: 'js'
+                    })?.map((error) => error.error);
+                    return {
+                        valid: false,
+                        errors: errors || []
+                    };
+                }
+                return {
+                    valid: true
+                };
+            }
+        };
+    }
+    catch (err) {
+        // Here we re-throw the error because the original error thrown by AJV has a deep stack that
+        // obfuscates the location of the error in application code
+        throw new SchemaValidatorError(err.message);
+    }
+};
+//# sourceMappingURL=schema-validator.js.map

package/dist/schema/validators/schema-validator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"schema-validator.js","sourceRoot":"","sources":["../../../src/schema/validators/schema-validator.ts"],"names":[],"mappings":"AAAA,aAAa;AACb,OAAO,iBAAiB,MAAM,mBAAmB,CAAC;AAClD,OAAO,GAAG,MAAM,KAAK,CAAC;AAGtB,OAAO,KAAK,KAAK,MAAM,aAAa,CAAC;AACrC,OAAO,KAAK,QAAQ,MAAM,4BAA4B,CAAC;AAEvD,MAAM,OAAO,oBAAqB,SAAQ,KAAK;IAC7C,YAAY,OAAe;QACzB,KAAK,CAAC,OAAO,CAAC,CAAC;QAEf,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;IACpC,CAAC;CACF;AAiBD;;;GAGG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG,CACnC,MAAuB,EACvB,SAAsC,EAAE,EACpB,EAAE;IACtB,IAAI;QACF,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,GAAG,CAAC;YACtB,SAAS,EAAE,CAAC,CAAC,MAAM,CAAC,SAAS,IAAI,KAAK,CAAC;YACvC,QAAQ,EAAE,CAAC,QAAQ,CAAC,cAAc,CAAC;YACnC,GAAG,CAAC,MAAM,CAAC,GAAG,IAAI,EAAE,CAAC;SACtB,CAAC,CAAC;QAEH,IAAI,gBAAgB,GAAG,MAAM,CAAC;QAC9B,IAAI,MAAM,CAAC,eAAe,EAAE;YAC1B,gBAAgB,GAAG,KAAK,CAAC,yBAAyB,CAAC,gBAAgB,CAAC,CAAC;SACtE;QAED,MAAM,SAAS,GAAG,GAAG,CAAC,OAAO,CAAC,gBAAgB,CAAC,CAAC;QAEhD,OAAO;YACL,YAAY,EAAE,GAAG,EAAE;gBACjB,OAAO,MAAM,CAAC;YAChB,CAAC;YAED,QAAQ,EAAE,CAAC,IAAI,EAAE,EAAE;gBACjB,MAAM,KAAK,GAAG,SAAS,CAAC,IAAI,CAAC,CAAC;gBAE9B,IAAI,CAAC,KAAK,EAAE;oBACV,MAAM,MAAM,GAAG,iBAAiB,CAAC,gBAAgB,EAAE,IAAI,EAAE,SAAS,CAAC,MAAM,IAAI,EAAE,EAAE;wBAC/E,MAAM,EAAE,IAAI;qBACb,CAAC,EAAE,GAAG,CAAC,CAAC,KAAU,EAAE,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;oBAErC,OAAO;wBACL,KAAK,EAAE,KAAK;wBACZ,MAAM,EAAE,MAAM,IAAI,EAAE;qBACrB,CAAC;iBACH;gBAED,OAAO;oBACL,KAAK,EAAE,IAAI;iBACZ,CAAC;YACJ,CAAC;SACF,CAAC;KACH;IAAC,OAAO,GAAG,EAAE;QACZ,4FAA4F;QAC5F,2DAA2D;QAC3D,MAAM,IAAI,oBAAoB,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;KAC7C;AACH,CAAC,CAAC"}

package/dist/schema/validators/ts-codec-validator.d.ts

@@ -0,0 +1,11 @@
+import * as t from 'ts-codec';
+import * as defs from '../definitions.js';
+export type TsCodecValidator<C extends t.AnyCodec, T extends t.TransformTarget = t.TransformTarget.Encoded> = T extends t.TransformTarget.Encoded ? defs.MicroValidator<t.Encoded<C>> : defs.MicroValidator<t.Decoded<C>>;
+type ValidatorOptions<T extends t.TransformTarget> = Partial<Omit<t.BaseParserParams, 'target'>> & {
+    target?: T;
+};
+/**
+ * Create a validator from a given ts-codec codec
+ */
+export declare const createTsCodecValidator: <C extends t.AnyCodec, T extends t.TransformTarget = t.TransformTarget.Encoded>(codec: C, options?: ValidatorOptions<T> | undefined) => TsCodecValidator<C, T>;
+export {};

package/dist/schema/validators/ts-codec-validator.js

@@ -0,0 +1,14 @@
+import * as t from 'ts-codec';
+import * as schema_validator from './schema-validator.js';
+import * as codecs from '../../codec/codec-index.js';
+/**
+ * Create a validator from a given ts-codec codec
+ */
+export const createTsCodecValidator = (codec, options) => {
+    const schema = t.generateJSONSchema(codec, {
+        ...(options || {}),
+        parsers: [...(options?.parsers ?? []), ...codecs.parsers]
+    });
+    return schema_validator.createSchemaValidator(schema);
+};
+//# sourceMappingURL=ts-codec-validator.js.map