@xyo-network/schema-cache 5.3.24 → 5.3.26

package/README.md

@@ -1,23 +1,275 @@
+[![logo][]](https://xyo.network)
+
 # @xyo-network/schema-cache
 
-[![logo][]](https://xyo.network)
+[![npm][npm-badge]][npm-link]
+[![license][license-badge]][license-link]
+
+> Primary SDK for using XYO Protocol 2.0
+
+## Install
+
+Using npm:
+
+```sh
+npm install {{name}}
+```
 
-Version: 5.0.2
+Using yarn:
 
-Primary SDK for using XYO Protocol 2.0
+```sh
+yarn add {{name}}
+```
 
-## Documentation
+Using pnpm:
 
-[TypeDoc Generated Documentation](https://gitbook.xyo.network/xyo-data-lab/xyo-reference/package-documentation/xyo-network__schema-cache)
+```sh
+pnpm add {{name}}
+```
+
+Using bun:
+
+```sh
+bun add {{name}}
+```
 
-Part of [sdk-xyo-client-js](https://www.npmjs.com/package/@xyo-network/sdk-xyo-client-js)
 
 ## License
 
-> See the [LICENSE](LICENSE) file for license details
+See the [LICENSE](LICENSE) file for license rights and limitations (LGPL-3.0-only).
+
+## Reference
+
+### packages
+
+  ### sdk-utils
+
+    ### packages
+
+      ### schema-cache
+
+        ### .temp-typedoc
+
+          ### classes
+
+            ### <a id="Debounce"></a>Debounce
+
+[**@xyo-network/schema-cache**](#../README)
+
+***
+
+## Type Parameters
+
+### TKey
+
+`TKey` = `string`
+
+## Constructors
+
+### Constructor
+
+```ts
+new Debounce<TKey>(): Debounce<TKey>;
+```
+
+### Returns
+
+`Debounce`\<`TKey`\>
+
+## Methods
+
+### one()
+
+```ts
+one<T>(
+   key, 
+   closure, 
+timeout?): Promise<T>;
+```
+
+### Type Parameters
+
+#### T
+
+`T`
+
+### Parameters
+
+#### key
+
+`TKey`
+
+#### closure
+
+() => `Promise`\<`T`\>
+
+#### timeout?
+
+`number` = `10_000`
+
+### Returns
+
+`Promise`\<`T`\>
+
+            ### <a id="SchemaCache"></a>SchemaCache
+
+[**@xyo-network/schema-cache**](#../README)
+
+***
+
+## Type Parameters
+
+### T
+
+`T` *extends* [`SchemaNameToValidatorMap`](#../interfaces/SchemaNameToValidatorMap) = [`SchemaNameToValidatorMap`](#../interfaces/SchemaNameToValidatorMap)
+
+## Properties
+
+### NULL
+
+```ts
+protected readonly static NULL: SchemaCacheEntry;
+```
+
+Object representing `null` since LRU Cache types
+only allow for types that derive from object
+
+***
+
+### onSchemaCached?
+
+```ts
+optional onSchemaCached?: (name, entry) => void;
+```
+
+### Parameters
+
+#### name
+
+`string`
+
+#### entry
+
+[`SchemaCacheEntry`](#../type-aliases/SchemaCacheEntry)
+
+### Returns
+
+`void`
+
+***
+
+### proxy?
+
+```ts
+optional proxy?: string;
+```
+
+## Accessors
+
+### instance
+
+### Get Signature
+
+```ts
+get static instance(): SchemaCache<SchemaNameToValidatorMap>;
+```
+
+#### Returns
+
+`SchemaCache`\<[`SchemaNameToValidatorMap`](#../interfaces/SchemaNameToValidatorMap)\>
+
+***
+
+### validators
+
+### Get Signature
+
+```ts
+get validators(): T;
+```
+
+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.
+
+#### Returns
+
+`T`
+
+## Methods
+
+### get()
+
+```ts
+get(schema?): Promise<
+  | SchemaCacheEntry
+  | null
+| undefined>;
+```
+
+### Parameters
+
+#### schema?
+
+`string`
+
+### Returns
+
+`Promise`\<
+  \| [`SchemaCacheEntry`](#../type-aliases/SchemaCacheEntry)
+  \| `null`
+  \| `undefined`\>
+
+          ### interfaces
+
+            ### <a id="SchemaNameToValidatorMap"></a>SchemaNameToValidatorMap
+
+[**@xyo-network/schema-cache**](#../README)
+
+***
+
+Used to map known schemas (byt their string name) to the validators which assert their types
+
+## Indexable
+
+```ts
+[key: string]: ((x) => x is Payload) | undefined
+```
+
+          ### type-aliases
+
+            ### <a id="NarrowPayload"></a>NarrowPayload
+
+[**@xyo-network/schema-cache**](#../README)
+
+***
+
+```ts
+type NarrowPayload<T> = ((x) => x is T) | undefined;
+```
+
+Used in conjunction with schema validation to support compile time type assertion
+for known schema types.
+
+## Type Parameters
+
+### T
+
+`T` *extends* `Payload` = `Payload`
+
+            ### <a id="SchemaCacheEntry"></a>SchemaCacheEntry
+
+[**@xyo-network/schema-cache**](#../README)
+
+***
 
-## Credits
+```ts
+type SchemaCacheEntry = FetchedPayload<SchemaPayload>;
+```
 
-[Made with 🔥 and ❄️ by XYO](https://xyo.network)
 
-[logo]: https://cdn.xy.company/img/brand/XYO_full_colored.png
+[logo]: https://cdn.xy.company/img/brand/XYO_full_colored.png
+[npm-badge]: https://img.shields.io/npm/v/@xyo-network/schema-cache.svg
+[npm-link]: https://www.npmjs.com/package/@xyo-network/schema-cache
+[license-badge]: https://img.shields.io/npm/l/@xyo-network/schema-cache.svg
+[license-link]: https://github.com/xylabs/sdk-js/blob/main/LICENSE

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xyo-network/schema-cache",
-  "version": "5.3.24",
+  "version": "5.3.26",
   "description": "Primary SDK for using XYO Protocol 2.0",
   "homepage": "https://xyo.network",
   "bugs": {
@@ -22,11 +22,11 @@
   "exports": {
     ".": {
       "types": "./dist/neutral/index.d.ts",
+      "import": "./dist/neutral/index.mjs",
       "default": "./dist/neutral/index.mjs"
     },
     "./package.json": "./package.json"
   },
-  "module": "dist/neutral/index.mjs",
   "types": "dist/neutral/index.d.ts",
   "files": [
     "dist",
@@ -36,20 +36,20 @@
     "README.md"
   ],
   "dependencies": {
-    "@xyo-network/huri": "~5.3.24",
-    "@xyo-network/domain-payload-plugin": "~5.3.24",
-    "@xyo-network/payload-model": "~5.3.24",
-    "@xyo-network/schema-payload-plugin": "~5.3.24"
+    "@xyo-network/domain-payload-plugin": "~5.3.26",
+    "@xyo-network/huri": "~5.3.26",
+    "@xyo-network/payload-model": "~5.3.26",
+    "@xyo-network/schema-payload-plugin": "~5.3.26"
   },
   "devDependencies": {
     "@opentelemetry/api": "^1.9.1",
-    "@types/node": "^25.5.0",
-    "@xylabs/sdk-js": "^5.0.93",
-    "@xylabs/ts-scripts-common": "~7.6.16",
-    "@xylabs/ts-scripts-pnpm": "~7.6.16",
-    "@xylabs/tsconfig": "^7.6.16",
-    "@xylabs/tsconfig-dom": "~7.6.16",
-    "@xylabs/vitest-extended": "~5.0.93",
+    "@types/node": "^25.5.2",
+    "@xylabs/sdk-js": "^5.0.94",
+    "@xylabs/ts-scripts-common": "~7.7.5",
+    "@xylabs/ts-scripts-pnpm": "~7.7.5",
+    "@xylabs/tsconfig": "^7.7.5",
+    "@xylabs/tsconfig-dom": "~7.7.5",
+    "@xylabs/vitest-extended": "~5.0.94",
     "acorn": "^8.16.0",
     "ajv": "^8.18.0",
     "axios": "^1.14.0",
@@ -61,12 +61,12 @@
     "vite": "^8.0.3",
     "vitest": "~4.1.2",
     "zod": "^4.3.6",
-    "@xyo-network/huri": "~5.3.24",
-    "@xyo-network/network": "~5.3.24",
-    "@xyo-network/schema-payload-plugin": "~5.3.24",
-    "@xyo-network/domain-payload-plugin": "~5.3.24",
-    "@xyo-network/payload-model": "~5.3.24",
-    "@xyo-network/payload-builder": "~5.3.24"
+    "@xyo-network/huri": "~5.3.26",
+    "@xyo-network/network": "~5.3.26",
+    "@xyo-network/payload-builder": "~5.3.26",
+    "@xyo-network/payload-model": "~5.3.26",
+    "@xyo-network/schema-payload-plugin": "~5.3.26",
+    "@xyo-network/domain-payload-plugin": "~5.3.26"
   },
   "peerDependencies": {
     "@xylabs/sdk-js": "^5",