@xyo-network/id-payload-plugin 3.8.0 → 3.8.2

package/dist/neutral/index.d.ts

@@ -1,5 +1,47 @@
-export * from './Payload.ts';
-export { IdPayloadPlugin as default, IdPayloadPlugin } from './Plugin.ts';
-export * from './Schema.ts';
-export * from './Template.ts';
-//# sourceMappingURL=index.d.ts.map
+import * as _xylabs_promise from '@xylabs/promise';
+import * as _xylabs_object from '@xylabs/object';
+import { Payload, WithSources } from '@xyo-network/payload-model';
+import * as _xyo_network_payload_plugin from '@xyo-network/payload-plugin';
+
+declare const IdSchema: "network.xyo.id";
+type IdSchema = typeof IdSchema;
+
+type IdFields = {
+    salt: string;
+};
+type Id = Payload<IdFields, IdSchema>;
+type IdPayload = Id;
+declare const isId: (x?: unknown | null) => x is _xylabs_object.DeepRestrictToStringKeys<{
+    schema: "network.xyo.id";
+    salt: string;
+}>;
+declare const asId: {
+    <TType extends _xylabs_object.DeepRestrictToStringKeys<{
+        schema: "network.xyo.id";
+        salt: string;
+    }>>(value: _xylabs_promise.AnyNonPromise, config?: _xylabs_object.TypeCheckConfig): TType | undefined;
+    <TType extends _xylabs_object.DeepRestrictToStringKeys<{
+        schema: "network.xyo.id";
+        salt: string;
+    }>>(value: _xylabs_promise.AnyNonPromise, assert: _xylabs_object.StringOrAlertFunction<_xylabs_object.DeepRestrictToStringKeys<{
+        schema: "network.xyo.id";
+        salt: string;
+    }>>, config?: _xylabs_object.TypeCheckConfig): TType;
+};
+declare const asOptionalId: <TType extends _xylabs_object.DeepRestrictToStringKeys<{
+    schema: "network.xyo.id";
+    salt: string;
+}>>(value: _xylabs_promise.AnyNonPromise) => TType | undefined;
+declare const isIdWithSources: (x?: unknown | null) => x is WithSources<WithSources<_xylabs_object.DeepRestrictToStringKeys<{
+    schema: "network.xyo.id";
+    salt: string;
+}>>>;
+
+declare const IdPayloadPlugin: () => _xyo_network_payload_plugin.PayloadPlugin<_xylabs_object.DeepRestrictToStringKeys<{
+    schema: "network.xyo.id";
+    salt: string;
+}>>;
+
+declare const idPayloadTemplate: () => Id;
+
+export { type Id, type IdFields, type IdPayload, IdPayloadPlugin, IdSchema, asId, asOptionalId, IdPayloadPlugin as default, idPayloadTemplate, isId, isIdWithSources };

package/dist/neutral/index.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/Payload.ts","../../src/Schema.ts","../../src/Plugin.ts","../../src/Template.ts"],"sourcesContent":["import { AsObjectFactory } from '@xylabs/object'\nimport type {\n  Payload,\n  WithSources,\n} from '@xyo-network/payload-model'\nimport {\n  isPayloadOfSchemaType,\n  isPayloadOfSchemaTypeWithSources,\n} from '@xyo-network/payload-model'\n\nimport { IdSchema } from './Schema.ts'\n\n/**\n * The fields of an ID Payload\n */\nexport type IdFields = {\n  salt: string\n}\n\n/**\n * The ID Payload\n */\nexport type Id = Payload<IdFields, IdSchema>\n\n/**\n * @deprecated Use `Id` instead\n */\nexport type IdPayload = Id\n\n/**\n * Identity helper for ID Payload\n */\nexport const isId = isPayloadOfSchemaType<Id>(IdSchema)\nexport const asId = AsObjectFactory.create(isId)\nexport const asOptionalId = AsObjectFactory.createOptional(isId)\n\n/**\n * Identity helper for ID Payload with sources\n */\nexport const isIdWithSources = isPayloadOfSchemaTypeWithSources<WithSources<Id>>(IdSchema)\n","export const IdSchema = 'network.xyo.id' as const\nexport type IdSchema = typeof IdSchema\n","import { createPayloadPlugin } from '@xyo-network/payload-plugin'\n\nimport type { IdPayload } from './Payload.ts'\nimport { IdSchema } from './Schema.ts'\nimport { idPayloadTemplate } from './Template.ts'\n\nexport const IdPayloadPlugin = () =>\n  createPayloadPlugin<IdPayload>({\n    schema: IdSchema,\n    template: idPayloadTemplate,\n  })\n","import type { IdPayload } from './Payload.ts'\nimport { IdSchema } from './Schema.ts'\n\nexport const idPayloadTemplate = (): IdPayload => ({\n  salt: '',\n  schema: IdSchema,\n})\n"],"mappings":";AAAA,SAAS,uBAAuB;AAKhC;AAAA,EACE;AAAA,EACA;AAAA,OACK;;;ACRA,IAAM,WAAW;;;ADgCjB,IAAM,OAAO,sBAA0B,QAAQ;AAC/C,IAAM,OAAO,gBAAgB,OAAO,IAAI;AACxC,IAAM,eAAe,gBAAgB,eAAe,IAAI;AAKxD,IAAM,kBAAkB,iCAAkD,QAAQ;;;AEvCzF,SAAS,2BAA2B;;;ACG7B,IAAM,oBAAoB,OAAkB;AAAA,EACjD,MAAM;AAAA,EACN,QAAQ;AACV;;;ADAO,IAAM,kBAAkB,MAC7B,oBAA+B;AAAA,EAC7B,QAAQ;AAAA,EACR,UAAU;AACZ,CAAC;","names":[]}
+{"version":3,"sources":["../../src/Payload.ts","../../src/Schema.ts","../../src/Plugin.ts","../../src/Template.ts"],"sourcesContent":["import { AsObjectFactory } from '@xylabs/object'\nimport type {\n  Payload,\n  WithSources,\n} from '@xyo-network/payload-model'\nimport {\n  isPayloadOfSchemaType,\n  isPayloadOfSchemaTypeWithSources,\n} from '@xyo-network/payload-model'\n\nimport { IdSchema } from './Schema.ts'\n\n/**\n * The fields of an ID Payload\n */\nexport type IdFields = {\n  salt: string\n}\n\n/**\n * The ID Payload\n */\nexport type Id = Payload<IdFields, IdSchema>\n\n/**\n * @deprecated Use `Id` instead\n */\n\n// eslint-disable-next-line sonarjs/redundant-type-aliases\nexport type IdPayload = Id\n\n/**\n * Identity helper for ID Payload\n */\nexport const isId = isPayloadOfSchemaType<Id>(IdSchema)\nexport const asId = AsObjectFactory.create(isId)\nexport const asOptionalId = AsObjectFactory.createOptional(isId)\n\n/**\n * Identity helper for ID Payload with sources\n */\nexport const isIdWithSources = isPayloadOfSchemaTypeWithSources<WithSources<Id>>(IdSchema)\n","export const IdSchema = 'network.xyo.id' as const\nexport type IdSchema = typeof IdSchema\n","import { createPayloadPlugin } from '@xyo-network/payload-plugin'\n\nimport type { Id } from './Payload.ts'\nimport { IdSchema } from './Schema.ts'\nimport { idPayloadTemplate } from './Template.ts'\n\nexport const IdPayloadPlugin = () =>\n  createPayloadPlugin<Id>({\n    schema: IdSchema,\n    template: idPayloadTemplate,\n  })\n","import type { Id } from './Payload.ts'\nimport { IdSchema } from './Schema.ts'\n\nexport const idPayloadTemplate = (): Id => ({\n  salt: '',\n  schema: IdSchema,\n})\n"],"mappings":";AAAA,SAAS,uBAAuB;AAKhC;AAAA,EACE;AAAA,EACA;AAAA,OACK;;;ACRA,IAAM,WAAW;;;ADkCjB,IAAM,OAAO,sBAA0B,QAAQ;AAC/C,IAAM,OAAO,gBAAgB,OAAO,IAAI;AACxC,IAAM,eAAe,gBAAgB,eAAe,IAAI;AAKxD,IAAM,kBAAkB,iCAAkD,QAAQ;;;AEzCzF,SAAS,2BAA2B;;;ACG7B,IAAM,oBAAoB,OAAW;AAAA,EAC1C,MAAM;AAAA,EACN,QAAQ;AACV;;;ADAO,IAAM,kBAAkB,MAC7B,oBAAwB;AAAA,EACtB,QAAQ;AAAA,EACR,UAAU;AACZ,CAAC;","names":[]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xyo-network/id-payload-plugin",
-  "version": "3.8.0",
+  "version": "3.8.2",
   "description": "Typescript/Javascript Plugins for XYO Platform",
   "homepage": "https://xyo.network",
   "bugs": {
@@ -30,15 +30,15 @@
   "types": "dist/neutral/index.d.ts",
   "dependencies": {
     "@xylabs/object": "^4.5.1",
-    "@xyo-network/payload-model": "^3.8.0",
-    "@xyo-network/payload-plugin": "^3.8.0"
+    "@xyo-network/payload-model": "^3.8.2",
+    "@xyo-network/payload-plugin": "^3.8.2"
   },
   "devDependencies": {
-    "@xylabs/ts-scripts-yarn3": "^4.2.6",
-    "@xylabs/tsconfig": "^4.2.6",
+    "@xylabs/ts-scripts-yarn3": "^5.0.22",
+    "@xylabs/tsconfig": "^5.0.22",
     "@xylabs/vitest-extended": "^4.5.1",
     "typescript": "^5.7.3",
-    "vitest": "^3.0.4"
+    "vitest": "^3.0.5"
   },
   "publishConfig": {
     "access": "public"

package/src/Payload.ts

@@ -25,6 +25,8 @@ export type Id = Payload<IdFields, IdSchema>
 /**
  * @deprecated Use `Id` instead
  */
+
+// eslint-disable-next-line sonarjs/redundant-type-aliases
 export type IdPayload = Id
 
 /**

package/src/Plugin.ts

@@ -1,11 +1,11 @@
 import { createPayloadPlugin } from '@xyo-network/payload-plugin'
 
-import type { IdPayload } from './Payload.ts'
+import type { Id } from './Payload.ts'
 import { IdSchema } from './Schema.ts'
 import { idPayloadTemplate } from './Template.ts'
 
 export const IdPayloadPlugin = () =>
-  createPayloadPlugin<IdPayload>({
+  createPayloadPlugin<Id>({
     schema: IdSchema,
     template: idPayloadTemplate,
   })

package/src/Template.ts

@@ -1,7 +1,7 @@
-import type { IdPayload } from './Payload.ts'
+import type { Id } from './Payload.ts'
 import { IdSchema } from './Schema.ts'
 
-export const idPayloadTemplate = (): IdPayload => ({
+export const idPayloadTemplate = (): Id => ({
   salt: '',
   schema: IdSchema,
 })

package/dist/neutral/Payload.d.ts

@@ -1,48 +0,0 @@
-import type { Payload, WithSources } from '@xyo-network/payload-model';
-import { IdSchema } from './Schema.ts';
-/**
- * The fields of an ID Payload
- */
-export type IdFields = {
-    salt: string;
-};
-/**
- * The ID Payload
- */
-export type Id = Payload<IdFields, IdSchema>;
-/**
- * @deprecated Use `Id` instead
- */
-export type IdPayload = Id;
-/**
- * Identity helper for ID Payload
- */
-export declare const isId: (x?: unknown | null) => x is import("@xylabs/object").DeepRestrictToStringKeys<{
-    schema: "network.xyo.id";
-    salt: string;
-}>;
-export declare const asId: {
-    <TType extends import("@xylabs/object").DeepRestrictToStringKeys<{
-        schema: "network.xyo.id";
-        salt: string;
-    }>>(value: import("@xylabs/promise").AnyNonPromise, config?: import("@xylabs/object").TypeCheckConfig): TType | undefined;
-    <TType extends import("@xylabs/object").DeepRestrictToStringKeys<{
-        schema: "network.xyo.id";
-        salt: string;
-    }>>(value: import("@xylabs/promise").AnyNonPromise, assert: import("@xylabs/object").StringOrAlertFunction<import("@xylabs/object").DeepRestrictToStringKeys<{
-        schema: "network.xyo.id";
-        salt: string;
-    }>>, config?: import("@xylabs/object").TypeCheckConfig): TType;
-};
-export declare const asOptionalId: <TType extends import("@xylabs/object").DeepRestrictToStringKeys<{
-    schema: "network.xyo.id";
-    salt: string;
-}>>(value: import("@xylabs/promise").AnyNonPromise) => TType | undefined;
-/**
- * Identity helper for ID Payload with sources
- */
-export declare const isIdWithSources: (x?: unknown | null) => x is WithSources<WithSources<import("@xylabs/object").DeepRestrictToStringKeys<{
-    schema: "network.xyo.id";
-    salt: string;
-}>>>;
-//# sourceMappingURL=Payload.d.ts.map

package/dist/neutral/Payload.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"Payload.d.ts","sourceRoot":"","sources":["../../src/Payload.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EACV,OAAO,EACP,WAAW,EACZ,MAAM,4BAA4B,CAAA;AAMnC,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAA;AAEtC;;GAEG;AACH,MAAM,MAAM,QAAQ,GAAG;IACrB,IAAI,EAAE,MAAM,CAAA;CACb,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,EAAE,GAAG,OAAO,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAA;AAE5C;;GAEG;AACH,MAAM,MAAM,SAAS,GAAG,EAAE,CAAA;AAE1B;;GAEG;AACH,eAAO,MAAM,IAAI;;UAhBT,MAAM;EAgByC,CAAA;AACvD,eAAO,MAAM,IAAI;;;cAjBT,MAAM;sBANI,iBAAiB,iCAGX,gBAEf;;;cACD,MAAM;sBAMK,iBAAiB;;cAN5B,MAAM;yBAcA,gBACd;CAEgD,CAAA;AAChD,eAAO,MAAM,YAAY;;UAlBjB,MAAM;kBAkBe,iBAAiB,qCAAkB,CAAA;AAEhE;;GAEG;AACH,eAAO,MAAM,eAAe;;UAvBpB,MAAM;IAuB4E,CAAA"}

package/dist/neutral/Plugin.d.ts

@@ -1,5 +0,0 @@
-export declare const IdPayloadPlugin: () => import("@xyo-network/payload-plugin").PayloadPlugin<import("@xylabs/object").DeepRestrictToStringKeys<{
-    schema: "network.xyo.id";
-    salt: string;
-}>>;
-//# sourceMappingURL=Plugin.d.ts.map

package/dist/neutral/Plugin.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"Plugin.d.ts","sourceRoot":"","sources":["../../src/Plugin.ts"],"names":[],"mappings":"AAMA,eAAO,MAAM,eAAe;;;GAIxB,CAAA"}

package/dist/neutral/Schema.d.ts

@@ -1,3 +0,0 @@
-export declare const IdSchema: "network.xyo.id";
-export type IdSchema = typeof IdSchema;
-//# sourceMappingURL=Schema.d.ts.map

package/dist/neutral/Schema.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"Schema.d.ts","sourceRoot":"","sources":["../../src/Schema.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,QAAQ,EAAG,gBAAyB,CAAA;AACjD,MAAM,MAAM,QAAQ,GAAG,OAAO,QAAQ,CAAA"}

package/dist/neutral/Template.d.ts

@@ -1,3 +0,0 @@
-import type { IdPayload } from './Payload.ts';
-export declare const idPayloadTemplate: () => IdPayload;
-//# sourceMappingURL=Template.d.ts.map

package/dist/neutral/Template.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"Template.d.ts","sourceRoot":"","sources":["../../src/Template.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,cAAc,CAAA;AAG7C,eAAO,MAAM,iBAAiB,QAAO,SAGnC,CAAA"}

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

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAA;AAC5B,OAAO,EAAE,eAAe,IAAI,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAA;AACzE,cAAc,aAAa,CAAA;AAC3B,cAAc,eAAe,CAAA"}