@xyo-network/manifest-model 5.3.25 → 5.3.26

package/README.md

@@ -1,23 +1,645 @@
+[![logo][]](https://xyo.network)
+
 # @xyo-network/manifest-model
 
-[![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}}
+```
+
+Using yarn:
 
-Version: 5.0.2
+```sh
+yarn add {{name}}
+```
 
-Primary SDK for using XYO Protocol 2.0
+Using pnpm:
 
-## Documentation
+```sh
+pnpm add {{name}}
+```
 
-[TypeDoc Generated Documentation](https://gitbook.xyo.network/xyo-data-lab/xyo-reference/package-documentation/xyo-network__manifest-model)
+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
+
+  ### manifest
+
+    ### packages
+
+      ### model
+
+        ### .temp-typedoc
+
+          ### functions
+
+            ### <a id="isManifest"></a>isManifest
+
+[**@xyo-network/manifest-model**](#../README)
+
+***
+
+```ts
+function isManifest(value): value is Manifest;
+```
+
+## Parameters
+
+### value
+
+`unknown`
+
+## Returns
+
+`value is Manifest`
+
+          ### interfaces
+
+            ### <a id="ConfigManifest"></a>ConfigManifest
+
+[**@xyo-network/manifest-model**](#../README)
+
+***
+
+## Properties
+
+### accountPath?
+
+```ts
+optional accountPath?: string;
+```
+
+***
+
+### features?
+
+```ts
+optional features?: string[];
+```
+
+***
+
+### labels?
+
+```ts
+optional labels?: Record<string, string | undefined>;
+```
+
+***
+
+### language?
+
+```ts
+optional language?: string;
+```
+
+***
+
+### name
+
+```ts
+name: string;
+```
+
+***
+
+### os?
+
+```ts
+optional os?: string;
+```
+
+***
+
+### schema
+
+```ts
+schema: Schema;
+```
+
+            ### <a id="Manifest"></a>Manifest
+
+[**@xyo-network/manifest-model**](#../README)
+
+***
+
+## Extended by
+
+- [`ModuleManifest`](#ModuleManifest)
+- [`PackageManifest`](#PackageManifest)
+
+## Properties
+
+### description?
+
+```ts
+optional description?: string;
+```
+
+            ### <a id="ModuleManifest"></a>ModuleManifest
+
+[**@xyo-network/manifest-model**](#../README)
+
+***
+
+## Extends
+
+- [`Manifest`](#Manifest)
+
+## Extended by
+
+- [`NodeManifest`](#NodeManifest)
+
+## Properties
+
+### description?
+
+```ts
+optional description?: string;
+```
+
+### Inherited from
+
+[`Manifest`](#Manifest).[`description`](Manifest.md#description)
+
+***
+
+### config
+
+```ts
+config: ConfigManifest;
+```
+
+***
+
+### lazyStart?
+
+```ts
+optional lazyStart?: boolean;
+```
+
+***
+
+### status?
+
+```ts
+optional status?: object;
+```
+
+### address
+
+```ts
+address: BrandedAddress;
+```
+
+### children?
+
+```ts
+optional children?: Record<BrandedAddress, string | null>;
+```
+
+            ### <a id="NodeManifest"></a>NodeManifest
+
+[**@xyo-network/manifest-model**](#../README)
+
+***
+
+## Extends
+
+- [`ModuleManifest`](#ModuleManifest)
+
+## Extended by
+
+- [`NodeManifestPayload`](#NodeManifestPayload)
+
+## Properties
+
+### description?
+
+```ts
+optional description?: string;
+```
+
+### Inherited from
+
+[`ModuleManifest`](#ModuleManifest).[`description`](ModuleManifest.md#description)
+
+***
+
+### modules?
+
+```ts
+optional modules?: object;
+```
+
+### private?
+
+```ts
+optional private?: (
+  | ModuleManifest
+  | ModuleAlias)[];
+```
+
+### public?
+
+```ts
+optional public?: (
+  | ModuleManifest
+  | ModuleAlias)[];
+```
+
+***
+
+### config
+
+```ts
+config: ConfigManifest;
+```
+
+### Inherited from
+
+[`ModuleManifest`](#ModuleManifest).[`config`](ModuleManifest.md#config)
+
+***
+
+### lazyStart?
+
+```ts
+optional lazyStart?: boolean;
+```
+
+### Inherited from
+
+[`ModuleManifest`](#ModuleManifest).[`lazyStart`](ModuleManifest.md#lazystart)
+
+***
+
+### status?
+
+```ts
+optional status?: object;
+```
+
+### address
+
+```ts
+address: BrandedAddress;
+```
+
+### children?
+
+```ts
+optional children?: Record<BrandedAddress, string | null>;
+```
+
+### Inherited from
+
+[`ModuleManifest`](#ModuleManifest).[`status`](ModuleManifest.md#status)
+
+            ### <a id="NodeManifestPayload"></a>NodeManifestPayload
+
+[**@xyo-network/manifest-model**](#../README)
+
+***
+
+## Extends
+
+- [`NodeManifest`](#NodeManifest)
+
+## Properties
+
+### description?
+
+```ts
+optional description?: string;
+```
+
+### Inherited from
+
+[`NodeManifest`](#NodeManifest).[`description`](NodeManifest.md#description)
+
+***
+
+### modules?
+
+```ts
+optional modules?: object;
+```
+
+### private?
+
+```ts
+optional private?: (
+  | ModuleManifest
+  | ModuleAlias)[];
+```
+
+### public?
+
+```ts
+optional public?: (
+  | ModuleManifest
+  | ModuleAlias)[];
+```
+
+### Inherited from
+
+[`NodeManifest`](#NodeManifest).[`modules`](NodeManifest.md#modules)
+
+***
+
+### config
+
+```ts
+config: ConfigManifest;
+```
+
+### Inherited from
+
+[`NodeManifest`](#NodeManifest).[`config`](NodeManifest.md#config)
+
+***
+
+### lazyStart?
+
+```ts
+optional lazyStart?: boolean;
+```
+
+### Inherited from
+
+[`NodeManifest`](#NodeManifest).[`lazyStart`](NodeManifest.md#lazystart)
+
+***
+
+### status?
+
+```ts
+optional status?: object;
+```
+
+### address
+
+```ts
+address: BrandedAddress;
+```
+
+### children?
+
+```ts
+optional children?: Record<BrandedAddress, string | null>;
+```
+
+### Inherited from
+
+[`NodeManifest`](#NodeManifest).[`status`](NodeManifest.md#status)
+
+***
+
+### schema
+
+```ts
+schema: "network.xyo.node.manifest" & object;
+```
+
+### Type Declaration
+
+#### \_\_schema
+
+```ts
+readonly __schema: true;
+```
+
+            ### <a id="PackageManifest"></a>PackageManifest
+
+[**@xyo-network/manifest-model**](#../README)
+
+***
+
+## Extends
+
+- [`Manifest`](#Manifest)
+
+## Properties
+
+### description?
+
+```ts
+optional description?: string;
+```
+
+### Inherited from
+
+[`Manifest`](#Manifest).[`description`](Manifest.md#description)
+
+***
+
+### modules?
+
+```ts
+optional modules?: Record<ModuleAlias, ModuleManifest>;
+```
+
+***
+
+### nodes
+
+```ts
+nodes: NodeManifest[];
+```
+
+          ### type-aliases
+
+            ### <a id="DappPackageManifestPayloadSchema"></a>DappPackageManifestPayloadSchema
+
+[**@xyo-network/manifest-model**](#../README)
+
+***
+
+```ts
+type DappPackageManifestPayloadSchema = typeof DappPackageManifestPayloadSchema;
+```
+
+            ### <a id="ModuleAlias"></a>ModuleAlias
+
+[**@xyo-network/manifest-model**](#../README)
+
+***
+
+```ts
+type ModuleAlias = Brand<string, {
+  __moduleAlias: true;
+}>;
+```
+
+            ### <a id="ModuleManifestPayload"></a>ModuleManifestPayload
+
+[**@xyo-network/manifest-model**](#../README)
+
+***
+
+```ts
+type ModuleManifestPayload = Payload<ModuleManifest, 
+  | ModuleManifestPayloadSchema
+| NodeManifestPayloadSchema>;
+```
+
+            ### <a id="ModuleManifestPayloadSchema"></a>ModuleManifestPayloadSchema
+
+[**@xyo-network/manifest-model**](#../README)
+
+***
+
+```ts
+type ModuleManifestPayloadSchema = typeof ModuleManifestPayloadSchema;
+```
+
+            ### <a id="NodeManifestPayloadSchema"></a>NodeManifestPayloadSchema
+
+[**@xyo-network/manifest-model**](#../README)
+
+***
+
+```ts
+type NodeManifestPayloadSchema = typeof NodeManifestPayloadSchema;
+```
+
+            ### <a id="PackageManifestPayload"></a>PackageManifestPayload
+
+[**@xyo-network/manifest-model**](#../README)
+
+***
+
+```ts
+type PackageManifestPayload = Payload<PackageManifest, PackageManifestPayloadSchema>;
+```
+
+            ### <a id="PackageManifestPayloadSchema"></a>PackageManifestPayloadSchema
+
+[**@xyo-network/manifest-model**](#../README)
+
+***
+
+```ts
+type PackageManifestPayloadSchema = typeof PackageManifestPayloadSchema;
+```
+
+          ### variables
+
+            ### <a id="DappPackageManifestPayloadSchema"></a>DappPackageManifestPayloadSchema
+
+[**@xyo-network/manifest-model**](#../README)
+
+***
+
+```ts
+const DappPackageManifestPayloadSchema: "network.xyo.manifest.package.dapp" & object;
+```
+
+## Type Declaration
+
+### \_\_schema
+
+```ts
+readonly __schema: true;
+```
+
+            ### <a id="ModuleManifestPayloadSchema"></a>ModuleManifestPayloadSchema
+
+[**@xyo-network/manifest-model**](#../README)
+
+***
+
+```ts
+const ModuleManifestPayloadSchema: "network.xyo.module.manifest" & object;
+```
+
+## Type Declaration
+
+### \_\_schema
+
+```ts
+readonly __schema: true;
+```
+
+            ### <a id="NodeManifestPayloadSchema"></a>NodeManifestPayloadSchema
+
+[**@xyo-network/manifest-model**](#../README)
+
+***
+
+```ts
+const NodeManifestPayloadSchema: "network.xyo.node.manifest" & object;
+```
+
+## Type Declaration
+
+### \_\_schema
+
+```ts
+readonly __schema: true;
+```
+
+            ### <a id="PackageManifestPayloadSchema"></a>PackageManifestPayloadSchema
+
+[**@xyo-network/manifest-model**](#../README)
+
+***
+
+```ts
+const PackageManifestPayloadSchema: "network.xyo.manifest.package" & object;
+```
+
+## Type Declaration
+
+### \_\_schema
+
+```ts
+readonly __schema: true;
+```
+
+            ### <a id="isPackageManifestPayload"></a>isPackageManifestPayload
+
+[**@xyo-network/manifest-model**](#../README)
+
+***
+
+```ts
+const isPackageManifestPayload: (x?) => x is PackageManifestPayload;
+```
+
+## Parameters
+
+### x?
+
+`unknown`
+
+## Returns
 
-## Credits
+`x is PackageManifestPayload`
 
-[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/manifest-model.svg
+[npm-link]: https://www.npmjs.com/package/@xyo-network/manifest-model
+[license-badge]: https://img.shields.io/npm/l/@xyo-network/manifest-model.svg
+[license-link]: https://github.com/xylabs/sdk-js/blob/main/LICENSE

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xyo-network/manifest-model",
-  "version": "5.3.25",
+  "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,15 +36,15 @@
     "README.md"
   ],
   "dependencies": {
-    "@xyo-network/payload-model": "~5.3.25"
+    "@xyo-network/payload-model": "~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",
+    "@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",
     "acorn": "^8.16.0",
     "axios": "^1.14.0",
     "esbuild": "^0.28.0",