@xyo-network/schema-cache 4.0.3 → 4.1.0

package/dist/neutral/index.d.ts

@@ -0,0 +1,53 @@
+import { FetchedPayload } from '@xyo-network/huri';
+import { SchemaSchema, SchemaPayload } from '@xyo-network/schema-payload-plugin';
+import { DomainSchema, DomainPayload } from '@xyo-network/domain-payload-plugin';
+import { Payload, PayloadSchema } from '@xyo-network/payload-model';
+
+declare class Debounce<TKey = string> {
+    private map;
+    one<T>(key: TKey, closure: () => Promise<T>, timeout?: number): Promise<T>;
+}
+
+/**
+ * Used in conjunction with schema validation to support compile time type assertion
+ * for known schema types.
+ */
+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
+ */
+interface SchemaNameToValidatorMap {
+    [DomainSchema]: NarrowPayload<DomainPayload>;
+    [PayloadSchema]: NarrowPayload<Payload>;
+    [SchemaSchema]: NarrowPayload<SchemaPayload>;
+}
+
+type SchemaCacheEntry = FetchedPayload<SchemaPayload>;
+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;
+}
+
+export { Debounce, SchemaCache };
+export type { NarrowPayload, SchemaCacheEntry, SchemaNameToValidatorMap };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xyo-network/schema-cache",
-  "version": "4.0.3",
+  "version": "4.1.0",
   "description": "Primary SDK for using XYO Protocol 2.0",
   "homepage": "https://xyo.network",
   "bugs": {
@@ -21,32 +21,32 @@
   "type": "module",
   "exports": {
     ".": {
-      "types": "./dist/types/index.d.ts",
+      "types": "./dist/neutral/index.d.ts",
       "default": "./dist/neutral/index.mjs"
     },
     "./package.json": "./package.json"
   },
   "module": "dist/neutral/index.mjs",
-  "types": "dist/types/index.d.ts",
+  "types": "dist/neutral/index.d.ts",
   "dependencies": {
-    "@xylabs/delay": "^4.13.4",
-    "@xylabs/error": "^4.13.4",
-    "@xylabs/typeof": "^4.13.4",
-    "@xyo-network/domain-payload-plugin": "^4.0.3",
-    "@xyo-network/huri": "^4.0.3",
-    "@xyo-network/payload-model": "^4.0.3",
-    "@xyo-network/schema-payload-plugin": "^4.0.3",
+    "@xylabs/delay": "^4.13.15",
+    "@xylabs/error": "^4.13.15",
+    "@xylabs/typeof": "^4.13.15",
+    "@xyo-network/domain-payload-plugin": "^4.1.0",
+    "@xyo-network/huri": "^4.1.0",
+    "@xyo-network/payload-model": "^4.1.0",
+    "@xyo-network/schema-payload-plugin": "^4.1.0",
     "ajv": "^8.17.1",
     "axios": "^1.10.0",
     "lru-cache": "^11.1.0"
   },
   "devDependencies": {
-    "@xylabs/assert": "^4.13.4",
-    "@xylabs/ts-scripts-yarn3": "^6.5.18",
-    "@xylabs/tsconfig-dom": "^6.5.18",
-    "@xylabs/vitest-extended": "^4.13.4",
-    "@xyo-network/network": "^4.0.3",
-    "@xyo-network/payload-builder": "^4.0.3",
+    "@xylabs/assert": "^4.13.15",
+    "@xylabs/ts-scripts-yarn3": "^7.0.0-rc.20",
+    "@xylabs/tsconfig-dom": "^7.0.0-rc.20",
+    "@xylabs/vitest-extended": "^4.13.15",
+    "@xyo-network/network": "^4.1.0",
+    "@xyo-network/payload-builder": "^4.1.0",
     "typescript": "^5.8.3",
     "vitest": "^3.2.4"
   },