@xyo-network/id-payload-plugin 5.3.25 → 5.3.27

package/README.md

@@ -1,23 +1,240 @@
+[![logo][]](https://xyo.network)
+
 # @xyo-network/id-payload-plugin
 
-[![logo][]](https://xyo.network)
+[![npm][npm-badge]][npm-link]
+[![license][license-badge]][license-link]
+
+> Typescript/Javascript Plugins for XYO Platform
+
+## Install
+
+Using npm:
 
-Version: 5.0.2
+```sh
+npm install {{name}}
+```
 
-Typescript/Javascript Plugins for XYO Platform
+Using yarn:
 
-## Documentation
+```sh
+yarn add {{name}}
+```
 
-[TypeDoc Generated Documentation](https://gitbook.xyo.network/xyo-data-lab/xyo-reference/package-documentation/xyo-network__id-payload-plugin)
+Using pnpm:
+
+```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
+
+  ### core-payload-plugins
+
+    ### packages
+
+      ### id
+
+        ### .temp-typedoc
+
+          ### functions
+
+            ### <a id="IdPayloadPlugin"></a>IdPayloadPlugin
+
+[**@xyo-network/id-payload-plugin**](#../README)
+
+***
+
+```ts
+function IdPayloadPlugin(): PayloadPlugin<Id>;
+```
+
+## Returns
+
+`PayloadPlugin`\<[`Id`](#../type-aliases/Id)\>
+
+            ### <a id="idPayloadTemplate"></a>idPayloadTemplate
+
+[**@xyo-network/id-payload-plugin**](#../README)
+
+***
+
+```ts
+function idPayloadTemplate(): Id;
+```
+
+## Returns
+
+[`Id`](#../type-aliases/Id)
+
+          ### type-aliases
+
+            ### <a id="Id"></a>Id
+
+[**@xyo-network/id-payload-plugin**](#../README)
+
+***
+
+```ts
+type Id = Payload<IdFields, IdSchema>;
+```
+
+The ID Payload
+
+            ### <a id="IdFields"></a>IdFields
+
+[**@xyo-network/id-payload-plugin**](#../README)
+
+***
+
+```ts
+type IdFields = object;
+```
+
+The fields of an ID Payload
+
+## Properties
+
+### salt
+
+```ts
+salt: string;
+```
+
+            ### <a id="IdPayload"></a>IdPayload
+
+[**@xyo-network/id-payload-plugin**](#../README)
+
+***
+
+```ts
+type IdPayload = Id;
+```
+
+## Deprecated
+
+Use `Id` instead
+
+            ### <a id="IdSchema"></a>IdSchema
+
+[**@xyo-network/id-payload-plugin**](#../README)
+
+***
+
+```ts
+type IdSchema = typeof IdSchema;
+```
+
+          ### variables
+
+            ### <a id="IdSchema"></a>IdSchema
+
+[**@xyo-network/id-payload-plugin**](#../README)
+
+***
+
+```ts
+const IdSchema: "network.xyo.id" & object;
+```
+
+## Type Declaration
+
+### \_\_schema
+
+```ts
+readonly __schema: true;
+```
+
+            ### <a id="asId"></a>asId
+
+[**@xyo-network/id-payload-plugin**](#../README)
+
+***
+
+```ts
+const asId: AsTypeFunction<Id>;
+```
+
+            ### <a id="asOptionalId"></a>asOptionalId
+
+[**@xyo-network/id-payload-plugin**](#../README)
+
+***
+
+```ts
+const asOptionalId: (value) => Id | undefined;
+```
+
+## Parameters
+
+### value
+
+`AnyNonPromise`
+
+## Returns
+
+[`Id`](#../type-aliases/Id) \| `undefined`
+
+            ### <a id="isId"></a>isId
+
+[**@xyo-network/id-payload-plugin**](#../README)
+
+***
+
+```ts
+const isId: (x?) => x is Id;
+```
+
+Identity helper for ID Payload
+
+## Parameters
+
+### x?
+
+`unknown`
+
+## Returns
+
+`x is Id`
+
+            ### <a id="isIdWithSources"></a>isIdWithSources
+
+[**@xyo-network/id-payload-plugin**](#../README)
+
+***
+
+```ts
+const isIdWithSources: (x?) => x is WithSources<WithSources<Id>>;
+```
+
+Identity helper for ID Payload with sources
+
+## Parameters
+
+### x?
+
+`unknown`
+
+## Returns
 
-## Credits
+`x is WithSources<WithSources<Id>>`
 
-[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/id-payload-plugin.svg
+[npm-link]: https://www.npmjs.com/package/@xyo-network/id-payload-plugin
+[license-badge]: https://img.shields.io/npm/l/@xyo-network/id-payload-plugin.svg
+[license-link]: https://github.com/xylabs/sdk-js/blob/main/LICENSE

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xyo-network/id-payload-plugin",
-  "version": "5.3.25",
+  "version": "5.3.27",
   "description": "Typescript/Javascript Plugins for XYO Platform",
   "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,18 +36,17 @@
     "README.md"
   ],
   "dependencies": {
-    "@xyo-network/payload-model": "~5.3.25",
-    "@xyo-network/payload-plugin": "~5.3.25"
+    "@xyo-network/payload-model": "~5.3.27",
+    "@xyo-network/payload-plugin": "~5.3.27"
   },
   "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/vitest-extended": "~5.0.93",
-    "acorn": "^8.16.0",
+    "@types/node": "^25.5.2",
+    "@xylabs/sdk-js": "^5.0.94",
+    "@xylabs/ts-scripts-common": "~7.7.15",
+    "@xylabs/ts-scripts-pnpm": "~7.7.15",
+    "@xylabs/tsconfig": "~7.7.15",
+    "@xylabs/vitest-extended": "~5.0.94",
     "axios": "^1.14.0",
     "esbuild": "^0.28.0",
     "typescript": "~5.9.3",
@@ -56,8 +55,7 @@
     "zod": "^4.3.6"
   },
   "peerDependencies": {
-    "@xylabs/sdk-js": "^5",
-    "zod": "^4"
+    "@xylabs/sdk-js": "^5"
   },
   "publishConfig": {
     "access": "public"