@xyo-network/schema-cache 2.53.18

package/dist/esm/Debounce.js

@@ -0,0 +1,25 @@
+import { delay } from '@xylabs/delay';
+export class Debounce {
+    map = new Map();
+    async one(key, closure, timeout = 10000) {
+        const startTime = Date.now();
+        while (this.map.get(key)) {
+            await delay(100);
+            if (Date.now() - startTime > timeout) {
+                throw Error(`Debounce timed out [${key}]`);
+            }
+        }
+        try {
+            this.map.set(key, 1);
+            return await closure();
+        }
+        catch (ex) {
+            console.error(`Debounce closure threw: ${ex}`);
+            throw ex;
+        }
+        finally {
+            this.map.set(key, 0);
+        }
+    }
+}
+//# sourceMappingURL=Debounce.js.map

package/dist/esm/Debounce.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Debounce.js","sourceRoot":"","sources":["../../src/Debounce.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,eAAe,CAAA;AAErC,MAAM,OAAO,QAAQ;IACX,GAAG,GAAG,IAAI,GAAG,EAAgB,CAAA;IAErC,KAAK,CAAC,GAAG,CAAI,GAAS,EAAE,OAAyB,EAAE,OAAO,GAAG,KAAK;QAChE,MAAM,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,CAAA;QAC5B,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE;YACxB,MAAM,KAAK,CAAC,GAAG,CAAC,CAAA;YAChB,IAAI,IAAI,CAAC,GAAG,EAAE,GAAG,SAAS,GAAG,OAAO,EAAE;gBACpC,MAAM,KAAK,CAAC,uBAAuB,GAAG,GAAG,CAAC,CAAA;aAC3C;SACF;QACD,IAAI;YACF,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,CAAC,CAAA;YACpB,OAAO,MAAM,OAAO,EAAE,CAAA;SACvB;QAAC,OAAO,EAAE,EAAE;YACX,OAAO,CAAC,KAAK,CAAC,2BAA2B,EAAE,EAAE,CAAC,CAAA;YAC9C,MAAM,EAAE,CAAA;SACT;gBAAS;YACR,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,CAAC,CAAA;SACrB;IACH,CAAC;CACF"}

package/dist/esm/SchemaCache.js

@@ -0,0 +1,86 @@
+import { XyoDomainPayloadWrapper } from '@xyo-network/domain-payload-plugin';
+import { XyoSchemaSchema } from '@xyo-network/schema-payload-plugin';
+import Ajv from 'ajv';
+import LruCache from 'lru-cache';
+import { Debounce } from './Debounce';
+const getSchemaNameFromSchema = (schema) => {
+    if (schema.$id) {
+        return schema.$id;
+    }
+};
+export class SchemaCache {
+    /**
+     * Object representing `null` since LRU Cache types
+     * only allow for types that derive from object
+     */
+    static NULL = { payload: { definition: {}, schema: XyoSchemaSchema } };
+    static _instance;
+    onSchemaCached;
+    proxy;
+    _cache = new LruCache({ max: 500, ttl: 1000 * 60 * 5 });
+    _validators = {};
+    //prevents double discovery
+    getDebounce = new Debounce();
+    constructor(proxy) {
+        this.proxy = proxy;
+    }
+    static get instance() {
+        if (!this._instance) {
+            this._instance = new SchemaCache();
+        }
+        return this._instance;
+    }
+    /**
+     * A map of cached schema (by name) to payload validators for the schema. A schema
+     * must be cached via `get('schema.name')` before it's validator can be used as
+     * they are compiled dynamically at runtime upon retrieval.
+     */
+    get validators() {
+        return this._validators;
+    }
+    async get(schema) {
+        if (schema) {
+            await this.getDebounce.one(schema, async () => {
+                // If we've never looked for it before, it will be undefined
+                if (this._cache.get(schema) === undefined) {
+                    await this.fetchSchema(schema);
+                }
+            });
+            const value = this._cache.get(schema);
+            return value === SchemaCache.NULL ? null : value;
+        }
+        return undefined;
+    }
+    cacheSchemaIfValid(entry) {
+        //only store them if they match the schema root
+        if (entry.payload.definition) {
+            const ajv = new Ajv({ strict: false });
+            //check if it is a valid schema def
+            const validator = ajv.compile(entry.payload.definition);
+            const schemaName = getSchemaNameFromSchema(entry.payload.definition);
+            if (schemaName) {
+                this._cache.set(schemaName, entry);
+                const key = schemaName;
+                this._validators[key] = validator;
+                this.onSchemaCached?.(schemaName, entry);
+            }
+        }
+    }
+    cacheSchemas(aliasEntries) {
+        aliasEntries
+            ?.filter((entry) => entry.payload.schema === XyoSchemaSchema)
+            .forEach((entry) => {
+            this.cacheSchemaIfValid(entry);
+        });
+    }
+    async fetchSchema(schema) {
+        const domain = await XyoDomainPayloadWrapper.discover(schema, this.proxy);
+        await domain?.fetch();
+        this.cacheSchemas(domain?.aliases);
+        //if it is still undefined, mark it as null (not found)
+        if (this._cache.get(schema) === undefined) {
+            this._cache.set(schema, SchemaCache.NULL);
+        }
+    }
+}
+//# sourceMappingURL=SchemaCache.js.map

package/dist/esm/SchemaCache.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SchemaCache.js","sourceRoot":"","sources":["../../src/SchemaCache.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,uBAAuB,EAAE,MAAM,oCAAoC,CAAA;AAE5E,OAAO,EAAoB,eAAe,EAAE,MAAM,oCAAoC,CAAA;AACtF,OAAO,GAAqB,MAAM,KAAK,CAAA;AACvC,OAAO,QAAQ,MAAM,WAAW,CAAA;AAEhC,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAA;AAGrC,MAAM,uBAAuB,GAAG,CAAC,MAAoB,EAAE,EAAE;IACvD,IAAI,MAAM,CAAC,GAAG,EAAE;QACd,OAAO,MAAM,CAAC,GAAG,CAAA;KAClB;AACH,CAAC,CAAA;AAID,MAAM,OAAO,WAAW;IACtB;;;OAGG;IACO,MAAM,CAAU,IAAI,GAAqB,EAAE,OAAO,EAAE,EAAE,UAAU,EAAE,EAAE,EAAE,MAAM,EAAE,eAAe,EAAE,EAAE,CAAA;IAEnG,MAAM,CAAC,SAAS,CAAc;IAEtC,cAAc,CAAkD;IAChE,KAAK,CAAS;IAEN,MAAM,GAAG,IAAI,QAAQ,CAA2B,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,IAAI,GAAG,EAAE,GAAG,CAAC,EAAE,CAAC,CAAA;IACjF,WAAW,GAAM,EAAO,CAAA;IAEhC,2BAA2B;IACnB,WAAW,GAAG,IAAI,QAAQ,EAAE,CAAA;IAEpC,YAAoB,KAAc;QAChC,IAAI,CAAC,KAAK,GAAG,KAAK,CAAA;IACpB,CAAC;IAED,MAAM,KAAK,QAAQ;QACjB,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE;YACnB,IAAI,CAAC,SAAS,GAAG,IAAI,WAAW,EAAE,CAAA;SACnC;QACD,OAAO,IAAI,CAAC,SAAS,CAAA;IACvB,CAAC;IAED;;;;OAIG;IACH,IAAI,UAAU;QACZ,OAAO,IAAI,CAAC,WAAW,CAAA;IACzB,CAAC;IAED,KAAK,CAAC,GAAG,CAAC,MAAe;QACvB,IAAI,MAAM,EAAE;YACV,MAAM,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,MAAM,EAAE,KAAK,IAAI,EAAE;gBAC5C,4DAA4D;gBAC5D,IAAI,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,KAAK,SAAS,EAAE;oBACzC,MAAM,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,CAAA;iBAC/B;YACH,CAAC,CAAC,CAAA;YACF,MAAM,KAAK,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,CAAA;YACrC,OAAO,KAAK,KAAK,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAA;SACjD;QACD,OAAO,SAAS,CAAA;IAClB,CAAC;IAEO,kBAAkB,CAAC,KAAuB;QAChD,+CAA+C;QAC/C,IAAI,KAAK,CAAC,OAAO,CAAC,UAAU,EAAE;YAC5B,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,CAAA;YACtC,mCAAmC;YACnC,MAAM,SAAS,GAAG,GAAG,CAAC,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,CAAA;YACvD,MAAM,UAAU,GAAG,uBAAuB,CAAC,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,CAAA;YACpE,IAAI,UAAU,EAAE;gBACd,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,UAAU,EAAE,KAAK,CAAC,CAAA;gBAClC,MAAM,GAAG,GAAG,UAAqB,CAAA;gBACjC,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,GAAG,SAAkC,CAAA;gBAC1D,IAAI,CAAC,cAAc,EAAE,CAAC,UAAU,EAAE,KAAK,CAAC,CAAA;aACzC;SACF;IACH,CAAC;IAEO,YAAY,CAAC,YAAsC;QACzD,YAAY;YACV,EAAE,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,KAAK,eAAe,CAAC;aAC5D,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;YACjB,IAAI,CAAC,kBAAkB,CAAC,KAAyB,CAAC,CAAA;QACpD,CAAC,CAAC,CAAA;IACN,CAAC;IAEO,KAAK,CAAC,WAAW,CAAC,MAAc;QACtC,MAAM,MAAM,GAAG,MAAM,uBAAuB,CAAC,QAAQ,CAAC,MAAM,EAAE,IAAI,CAAC,KAAK,CAAC,CAAA;QACzE,MAAM,MAAM,EAAE,KAAK,EAAE,CAAA;QACrB,IAAI,CAAC,YAAY,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;QAElC,uDAAuD;QACvD,IAAI,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,KAAK,SAAS,EAAE;YACzC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,MAAM,EAAE,WAAW,CAAC,IAAI,CAAC,CAAA;SAC1C;IACH,CAAC"}

package/dist/esm/SchemaNameToValidatorMap.js

@@ -0,0 +1,4 @@
+import { XyoDomainSchema } from '@xyo-network/domain-payload-plugin';
+import { PayloadSchema } from '@xyo-network/payload-model';
+import { XyoSchemaSchema } from '@xyo-network/schema-payload-plugin';
+//# sourceMappingURL=SchemaNameToValidatorMap.js.map

package/dist/esm/SchemaNameToValidatorMap.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SchemaNameToValidatorMap.js","sourceRoot":"","sources":["../../src/SchemaNameToValidatorMap.ts"],"names":[],"mappings":"AAAA,OAAO,EAAoB,eAAe,EAAE,MAAM,oCAAoC,CAAA;AACtF,OAAO,EAAW,aAAa,EAAE,MAAM,4BAA4B,CAAA;AACnE,OAAO,EAAoB,eAAe,EAAE,MAAM,oCAAoC,CAAA"}

package/dist/esm/index.js

@@ -0,0 +1,3 @@
+export * from './SchemaCache';
+export * from './SchemaNameToValidatorMap';
+//# sourceMappingURL=index.js.map

package/dist/esm/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,eAAe,CAAA;AAC7B,cAAc,4BAA4B,CAAA"}

package/dist/types/Debounce.d.ts

@@ -0,0 +1,5 @@
+export declare class Debounce<TKey = string> {
+    private map;
+    one<T>(key: TKey, closure: () => Promise<T>, timeout?: number): Promise<T>;
+}
+//# sourceMappingURL=Debounce.d.ts.map

package/dist/types/Debounce.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Debounce.d.ts","sourceRoot":"","sources":["../../src/Debounce.ts"],"names":[],"mappings":"AAEA,qBAAa,QAAQ,CAAC,IAAI,GAAG,MAAM;IACjC,OAAO,CAAC,GAAG,CAA0B;IAE/B,GAAG,CAAC,CAAC,EAAE,GAAG,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,OAAO,CAAC,CAAC,CAAC,EAAE,OAAO,SAAQ;CAkBnE"}

package/dist/types/SchemaCache.d.ts

@@ -0,0 +1,30 @@
+import { FetchedPayload } from '@xyo-network/huri';
+import { XyoSchemaPayload } from '@xyo-network/schema-payload-plugin';
+import { SchemaNameToValidatorMap } from './SchemaNameToValidatorMap';
+export type SchemaCacheEntry = FetchedPayload<XyoSchemaPayload>;
+export declare class SchemaCache<T extends SchemaNameToValidatorMap = SchemaNameToValidatorMap> {
+    /**
+     * Object representing `null` since LRU Cache types
+     * only allow for types that derive from object
+     */
+    protected static readonly NULL: SchemaCacheEntry;
+    private static _instance?;
+    onSchemaCached?: (name: string, entry: SchemaCacheEntry) => void;
+    proxy?: string;
+    private _cache;
+    private _validators;
+    private getDebounce;
+    private constructor();
+    static get instance(): SchemaCache<SchemaNameToValidatorMap>;
+    /**
+     * A map of cached schema (by name) to payload validators for the schema. A schema
+     * must be cached via `get('schema.name')` before it's validator can be used as
+     * they are compiled dynamically at runtime upon retrieval.
+     */
+    get validators(): T;
+    get(schema?: string): Promise<SchemaCacheEntry | undefined | null>;
+    private cacheSchemaIfValid;
+    private cacheSchemas;
+    private fetchSchema;
+}
+//# sourceMappingURL=SchemaCache.d.ts.map

package/dist/types/SchemaCache.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"SchemaCache.d.ts","sourceRoot":"","sources":["../../src/SchemaCache.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAA;AAClD,OAAO,EAAE,gBAAgB,EAAmB,MAAM,oCAAoC,CAAA;AAKtF,OAAO,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAA;AAQrE,MAAM,MAAM,gBAAgB,GAAG,cAAc,CAAC,gBAAgB,CAAC,CAAA;AAE/D,qBAAa,WAAW,CAAC,CAAC,SAAS,wBAAwB,GAAG,wBAAwB;IACpF;;;OAGG;IACH,SAAS,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,EAAE,gBAAgB,CAA2D;IAE3G,OAAO,CAAC,MAAM,CAAC,SAAS,CAAC,CAAa;IAEtC,cAAc,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,gBAAgB,KAAK,IAAI,CAAA;IAChE,KAAK,CAAC,EAAE,MAAM,CAAA;IAEd,OAAO,CAAC,MAAM,CAA2E;IACzF,OAAO,CAAC,WAAW,CAAa;IAGhC,OAAO,CAAC,WAAW,CAAiB;IAEpC,OAAO;IAIP,MAAM,KAAK,QAAQ,0CAKlB;IAED;;;;OAIG;IACH,IAAI,UAAU,IAAI,CAAC,CAElB;IAEK,GAAG,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,gBAAgB,GAAG,SAAS,GAAG,IAAI,CAAC;IAcxE,OAAO,CAAC,kBAAkB;IAgB1B,OAAO,CAAC,YAAY;YAQN,WAAW;CAU1B"}

package/dist/types/SchemaNameToValidatorMap.d.ts

@@ -0,0 +1,17 @@
+import { XyoDomainPayload, XyoDomainSchema } from '@xyo-network/domain-payload-plugin';
+import { Payload, PayloadSchema } from '@xyo-network/payload-model';
+import { XyoSchemaPayload, XyoSchemaSchema } from '@xyo-network/schema-payload-plugin';
+/**
+ * Used in conjunction with schema validation to support compile time type assertion
+ * for known schema types.
+ */
+export type NarrowPayload<T extends Payload = Payload> = ((x: Payload) => x is T) | undefined;
+/**
+ * Used to map known schemas (byt their string name) to the validators which assert their types
+ */
+export interface SchemaNameToValidatorMap {
+    [PayloadSchema]: NarrowPayload<Payload>;
+    [XyoDomainSchema]: NarrowPayload<XyoDomainPayload>;
+    [XyoSchemaSchema]: NarrowPayload<XyoSchemaPayload>;
+}
+//# sourceMappingURL=SchemaNameToValidatorMap.d.ts.map

package/dist/types/SchemaNameToValidatorMap.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"SchemaNameToValidatorMap.d.ts","sourceRoot":"","sources":["../../src/SchemaNameToValidatorMap.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,eAAe,EAAE,MAAM,oCAAoC,CAAA;AACtF,OAAO,EAAE,OAAO,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAA;AACnE,OAAO,EAAE,gBAAgB,EAAE,eAAe,EAAE,MAAM,oCAAoC,CAAA;AAEtF;;;GAGG;AACH,MAAM,MAAM,aAAa,CAAC,CAAC,SAAS,OAAO,GAAG,OAAO,IAAI,CAAC,CAAC,CAAC,EAAE,OAAO,KAAK,CAAC,IAAI,CAAC,CAAC,GAAG,SAAS,CAAA;AAE7F;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC,CAAC,aAAa,CAAC,EAAE,aAAa,CAAC,OAAO,CAAC,CAAA;IACvC,CAAC,eAAe,CAAC,EAAE,aAAa,CAAC,gBAAgB,CAAC,CAAA;IAClD,CAAC,eAAe,CAAC,EAAE,aAAa,CAAC,gBAAgB,CAAC,CAAA;CACnD"}

package/dist/types/index.d.ts

@@ -0,0 +1,3 @@
+export * from './SchemaCache';
+export * from './SchemaNameToValidatorMap';
+//# sourceMappingURL=index.d.ts.map

package/dist/types/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,eAAe,CAAA;AAC7B,cAAc,4BAA4B,CAAA"}

package/package.json

@@ -0,0 +1,62 @@
+{
+  "author": {
+    "email": "support@xyo.network",
+    "name": "XYO Development Team",
+    "url": "https://xyo.network"
+  },
+  "bugs": {
+    "email": "support@xyo.network",
+    "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/issues"
+  },
+  "dependencies": {
+    "@ethersproject/providers": "^5.7.2",
+    "@metamask/providers": "^10.2.1",
+    "@xylabs/delay": "^2.7.6",
+    "@xyo-network/domain-payload-plugin": "^2.53.18",
+    "@xyo-network/huri": "^2.53.18",
+    "@xyo-network/payload-model": "^2.53.18",
+    "@xyo-network/schema-payload-plugin": "^2.53.18",
+    "ajv": "^8.12.0",
+    "lru-cache": "^8.0.4"
+  },
+  "description": "Primary SDK for using XYO Protocol 2.0",
+  "devDependencies": {
+    "@xylabs/ts-scripts-yarn3": "^2.16.1",
+    "@xylabs/tsconfig-dom": "^2.16.1",
+    "typescript": "^4.9.5"
+  },
+  "browser": "dist/esm/index.js",
+  "docs": "dist/docs.json",
+  "exports": {
+    ".": {
+      "node": {
+        "import": "./dist/esm/index.js",
+        "require": "./dist/cjs/index.js"
+      },
+      "browser": {
+        "import": "./dist/esm/index.js",
+        "require": "./dist/cjs/index.js"
+      },
+      "default": "./dist/esm/index.js"
+    },
+    "./dist/docs.json": {
+      "default": "./dist/docs.json"
+    },
+    "./package.json": "./package.json"
+  },
+  "main": "dist/cjs/index.js",
+  "module": "dist/esm/index.js",
+  "homepage": "https://xyo.network",
+  "license": "LGPL-3.0",
+  "name": "@xyo-network/schema-cache",
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js.git"
+  },
+  "sideEffects": false,
+  "types": "dist/types/index.d.ts",
+  "version": "2.53.18"
+}

package/src/Debounce.ts

@@ -0,0 +1,24 @@
+import { delay } from '@xylabs/delay'
+
+export class Debounce<TKey = string> {
+  private map = new Map<TKey, number>()
+
+  async one<T>(key: TKey, closure: () => Promise<T>, timeout = 10000) {
+    const startTime = Date.now()
+    while (this.map.get(key)) {
+      await delay(100)
+      if (Date.now() - startTime > timeout) {
+        throw Error(`Debounce timed out [${key}]`)
+      }
+    }
+    try {
+      this.map.set(key, 1)
+      return await closure()
+    } catch (ex) {
+      console.error(`Debounce closure threw: ${ex}`)
+      throw ex
+    } finally {
+      this.map.set(key, 0)
+    }
+  }
+}

package/src/SchemaCache.ts

@@ -0,0 +1,104 @@
+import { XyoDomainPayloadWrapper } from '@xyo-network/domain-payload-plugin'
+import { FetchedPayload } from '@xyo-network/huri'
+import { XyoSchemaPayload, XyoSchemaSchema } from '@xyo-network/schema-payload-plugin'
+import Ajv, { SchemaObject } from 'ajv'
+import LruCache from 'lru-cache'
+
+import { Debounce } from './Debounce'
+import { SchemaNameToValidatorMap } from './SchemaNameToValidatorMap'
+
+const getSchemaNameFromSchema = (schema: SchemaObject) => {
+  if (schema.$id) {
+    return schema.$id
+  }
+}
+
+export type SchemaCacheEntry = FetchedPayload<XyoSchemaPayload>
+
+export class SchemaCache<T extends SchemaNameToValidatorMap = SchemaNameToValidatorMap> {
+  /**
+   * Object representing `null` since LRU Cache types
+   * only allow for types that derive from object
+   */
+  protected static readonly NULL: SchemaCacheEntry = { payload: { definition: {}, schema: XyoSchemaSchema } }
+
+  private static _instance?: SchemaCache
+
+  onSchemaCached?: (name: string, entry: SchemaCacheEntry) => void
+  proxy?: string
+
+  private _cache = new LruCache<string, SchemaCacheEntry>({ max: 500, ttl: 1000 * 60 * 5 })
+  private _validators: T = {} as T
+
+  //prevents double discovery
+  private getDebounce = new Debounce()
+
+  private constructor(proxy?: string) {
+    this.proxy = proxy
+  }
+
+  static get instance() {
+    if (!this._instance) {
+      this._instance = new SchemaCache()
+    }
+    return this._instance
+  }
+
+  /**
+   * A map of cached schema (by name) to payload validators for the schema. A schema
+   * must be cached via `get('schema.name')` before it's validator can be used as
+   * they are compiled dynamically at runtime upon retrieval.
+   */
+  get validators(): T {
+    return this._validators
+  }
+
+  async get(schema?: string): Promise<SchemaCacheEntry | undefined | null> {
+    if (schema) {
+      await this.getDebounce.one(schema, async () => {
+        // If we've never looked for it before, it will be undefined
+        if (this._cache.get(schema) === undefined) {
+          await this.fetchSchema(schema)
+        }
+      })
+      const value = this._cache.get(schema)
+      return value === SchemaCache.NULL ? null : value
+    }
+    return undefined
+  }
+
+  private cacheSchemaIfValid(entry: SchemaCacheEntry) {
+    //only store them if they match the schema root
+    if (entry.payload.definition) {
+      const ajv = new Ajv({ strict: false })
+      //check if it is a valid schema def
+      const validator = ajv.compile(entry.payload.definition)
+      const schemaName = getSchemaNameFromSchema(entry.payload.definition)
+      if (schemaName) {
+        this._cache.set(schemaName, entry)
+        const key = schemaName as keyof T
+        this._validators[key] = validator as unknown as T[keyof T]
+        this.onSchemaCached?.(schemaName, entry)
+      }
+    }
+  }
+
+  private cacheSchemas(aliasEntries?: FetchedPayload[] | null) {
+    aliasEntries
+      ?.filter((entry) => entry.payload.schema === XyoSchemaSchema)
+      .forEach((entry) => {
+        this.cacheSchemaIfValid(entry as SchemaCacheEntry)
+      })
+  }
+
+  private async fetchSchema(schema: string) {
+    const domain = await XyoDomainPayloadWrapper.discover(schema, this.proxy)
+    await domain?.fetch()
+    this.cacheSchemas(domain?.aliases)
+
+    //if it is still undefined, mark it as null (not found)
+    if (this._cache.get(schema) === undefined) {
+      this._cache.set(schema, SchemaCache.NULL)
+    }
+  }
+}

package/src/SchemaNameToValidatorMap.ts

@@ -0,0 +1,18 @@
+import { XyoDomainPayload, XyoDomainSchema } from '@xyo-network/domain-payload-plugin'
+import { Payload, PayloadSchema } from '@xyo-network/payload-model'
+import { XyoSchemaPayload, XyoSchemaSchema } from '@xyo-network/schema-payload-plugin'
+
+/**
+ * Used in conjunction with schema validation to support compile time type assertion
+ * for known schema types.
+ */
+export type NarrowPayload<T extends Payload = Payload> = ((x: Payload) => x is T) | undefined
+
+/**
+ * Used to map known schemas (byt their string name) to the validators which assert their types
+ */
+export interface SchemaNameToValidatorMap {
+  [PayloadSchema]: NarrowPayload<Payload>
+  [XyoDomainSchema]: NarrowPayload<XyoDomainPayload>
+  [XyoSchemaSchema]: NarrowPayload<XyoSchemaPayload>
+}

package/src/index.ts

@@ -0,0 +1,2 @@
+export * from './SchemaCache'
+export * from './SchemaNameToValidatorMap'

package/typedoc.json

@@ -0,0 +1,9 @@
+{
+  "intentionallyNotExported": [
+    "XyoFetchedPayload",
+    "XyoSchemaPayload",
+    "PayloadFull",
+    "XyoDomainPayload",
+    "Payload"
+  ]
+}