@xyo-network/xns-record-payloadset-plugins 3.1.1 → 3.1.2

package/dist/browser/estimate/lib/parseDomainEstimates.d.ts

@@ -1,4 +1,9 @@
 import type { Payload } from '@xyo-network/payload-model';
 import { type DomainEstimate } from '@xyo-network/xns-record-payload-plugins';
+/**
+ * Parses a generic array of payloads into estimates
+ * @param payloads An array of payloads
+ * @returns Parsed estimates
+ */
 export declare const parseDomainEstimates: (payloads?: Payload[]) => Promise<DomainEstimate[]>;
 //# sourceMappingURL=parseDomainEstimates.d.ts.map

package/dist/browser/estimate/lib/parseDomainEstimates.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"parseDomainEstimates.d.ts","sourceRoot":"","sources":["../../../../src/estimate/lib/parseDomainEstimates.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,EACV,OAAO,EACR,MAAM,4BAA4B,CAAA;AACnC,OAAO,EACL,KAAK,cAAc,EAEpB,MAAM,yCAAyC,CAAA;AAOhD,eAAO,MAAM,oBAAoB,cAAqB,OAAO,EAAE,KAAG,OAAO,CAAC,cAAc,EAAE,CA0BzF,CAAA"}
+{"version":3,"file":"parseDomainEstimates.d.ts","sourceRoot":"","sources":["../../../../src/estimate/lib/parseDomainEstimates.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,EACV,OAAO,EACR,MAAM,4BAA4B,CAAA;AACnC,OAAO,EACL,KAAK,cAAc,EAEpB,MAAM,yCAAyC,CAAA;AAEhD;;;;GAIG;AACH,eAAO,MAAM,oBAAoB,cAAqB,OAAO,EAAE,KAAG,OAAO,CAAC,cAAc,EAAE,CA0BzF,CAAA"}

package/dist/browser/validation/name/Name.d.ts

@@ -12,10 +12,30 @@ export declare class XnsNameHelper {
     get xnsName(): import("@xyo-network/payload-model").SchemaFields & import("@xyo-network/payload-model").PayloadFields & DomainFields & {
         schema: import("@xyo-network/payload-model").Schema;
     };
+    /**
+     * Create an XnsNameHelper from a domain payload
+     * @param  {Domain} domain
+     * @returns Promise<XnsNameHelper>
+     */
     static fromPayload(domain: Payload<DomainFields>): Promisable<XnsNameHelper>;
+    /**
+     * Create an XnsNameHelper from a string
+     * @param  {string} xnsName
+     * @returns Promise<XnsNameHelper>
+     */
     static fromString(xnsName: string): XnsNameHelper;
+    /**
+     * Determine if a string is a valid XNS name or hash
+     * @param  {string} source?
+     * @returns ValidSourceTypes
+     */
     static isPotentialXnsNameOrHash(source?: string): ValidSourceTypes;
     static isValid(domain: Payload<DomainFields>): Promise<boolean>;
+    /**
+     * Mask a string to be a valid XNS name
+     * @param {string} str
+     * @returns string
+     */
     static mask(str: string, options?: {
         maskStartEndHyphens: boolean;
     }): string;

package/dist/browser/validation/name/Name.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Name.d.ts","sourceRoot":"","sources":["../../../../src/validation/name/Name.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAA;AACjD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,4BAA4B,CAAA;AACzD,OAAO,KAAK,EAAE,YAAY,EAAkB,MAAM,yCAAyC,CAAA;AAK3F,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAA;AAIxD,qBAAa,aAAa;IACxB,MAAM,CAAC,SAAS,oBAAoB;IAEpC,OAAO,CAAC,QAAQ,CAAuB;IAEvC,OAAO;IAIP,IAAI,MAAM,WAET;IAED,IAAI,IAAI,WAEP;IAED,IAAI,GAAG,UAEN;IAED,IAAI,OAAO;;MAEV;IAOD,MAAM,CAAC,WAAW,CAAC,MAAM,EAAE,OAAO,CAAC,YAAY,CAAC,GAAG,UAAU,CAAC,aAAa,CAAC;IAS5E,MAAM,CAAC,UAAU,CAAC,OAAO,EAAE,MAAM,GAAG,aAAa;IAgBjD,MAAM,CAAC,wBAAwB,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,gBAAgB;WAMrD,OAAO,CAAC,MAAM,EAAE,OAAO,CAAC,YAAY,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC;IAarE,MAAM,CAAC,IAAI,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,GAAE;QAAE,mBAAmB,EAAE,OAAO,CAAA;KAAuB,GAAG,MAAM;IAmB1F,QAAQ,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,CAAC,CAAC;CAc/C"}
+{"version":3,"file":"Name.d.ts","sourceRoot":"","sources":["../../../../src/validation/name/Name.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAA;AACjD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,4BAA4B,CAAA;AACzD,OAAO,KAAK,EAAE,YAAY,EAAkB,MAAM,yCAAyC,CAAA;AAK3F,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAA;AAIxD,qBAAa,aAAa;IACxB,MAAM,CAAC,SAAS,oBAAoB;IAEpC,OAAO,CAAC,QAAQ,CAAuB;IAEvC,OAAO;IAIP,IAAI,MAAM,WAET;IAED,IAAI,IAAI,WAEP;IAED,IAAI,GAAG,UAEN;IAED,IAAI,OAAO;;MAEV;IAED;;;;OAIG;IACH,MAAM,CAAC,WAAW,CAAC,MAAM,EAAE,OAAO,CAAC,YAAY,CAAC,GAAG,UAAU,CAAC,aAAa,CAAC;IAI5E;;;;OAIG;IACH,MAAM,CAAC,UAAU,CAAC,OAAO,EAAE,MAAM,GAAG,aAAa;IAWjD;;;;OAIG;IACH,MAAM,CAAC,wBAAwB,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,gBAAgB;WAMrD,OAAO,CAAC,MAAM,EAAE,OAAO,CAAC,YAAY,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC;IAQrE;;;;OAIG;IACH,MAAM,CAAC,IAAI,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,GAAE;QAAE,mBAAmB,EAAE,OAAO,CAAA;KAAuB,GAAG,MAAM;IAmB1F,QAAQ,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,CAAC,CAAC;CAc/C"}

package/dist/browser/validation/name/lib/removeDisallowedCharacters.d.ts

@@ -1,2 +1,7 @@
+/**
+ * Iterates over a string removing disallowed characters
+ * @param xnsName The XNS name to remove disallowed characters from
+ * @returns The XNS name with disallowed characters removed
+ */
 export declare const removeDisallowedCharacters: (xnsName: string) => string;
 //# sourceMappingURL=removeDisallowedCharacters.d.ts.map

package/dist/browser/validation/name/lib/removeDisallowedCharacters.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"removeDisallowedCharacters.d.ts","sourceRoot":"","sources":["../../../../../src/validation/name/lib/removeDisallowedCharacters.ts"],"names":[],"mappings":"AAYA,eAAO,MAAM,0BAA0B,YAAa,MAAM,KAAG,MAa5D,CAAA"}
+{"version":3,"file":"removeDisallowedCharacters.d.ts","sourceRoot":"","sources":["../../../../../src/validation/name/lib/removeDisallowedCharacters.ts"],"names":[],"mappings":"AAOA;;;;GAIG;AACH,eAAO,MAAM,0BAA0B,YAAa,MAAM,KAAG,MAa5D,CAAA"}

package/dist/neutral/estimate/lib/parseDomainEstimates.d.ts

@@ -1,4 +1,9 @@
 import type { Payload } from '@xyo-network/payload-model';
 import { type DomainEstimate } from '@xyo-network/xns-record-payload-plugins';
+/**
+ * Parses a generic array of payloads into estimates
+ * @param payloads An array of payloads
+ * @returns Parsed estimates
+ */
 export declare const parseDomainEstimates: (payloads?: Payload[]) => Promise<DomainEstimate[]>;
 //# sourceMappingURL=parseDomainEstimates.d.ts.map

package/dist/neutral/estimate/lib/parseDomainEstimates.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"parseDomainEstimates.d.ts","sourceRoot":"","sources":["../../../../src/estimate/lib/parseDomainEstimates.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,EACV,OAAO,EACR,MAAM,4BAA4B,CAAA;AACnC,OAAO,EACL,KAAK,cAAc,EAEpB,MAAM,yCAAyC,CAAA;AAOhD,eAAO,MAAM,oBAAoB,cAAqB,OAAO,EAAE,KAAG,OAAO,CAAC,cAAc,EAAE,CA0BzF,CAAA"}
+{"version":3,"file":"parseDomainEstimates.d.ts","sourceRoot":"","sources":["../../../../src/estimate/lib/parseDomainEstimates.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,EACV,OAAO,EACR,MAAM,4BAA4B,CAAA;AACnC,OAAO,EACL,KAAK,cAAc,EAEpB,MAAM,yCAAyC,CAAA;AAEhD;;;;GAIG;AACH,eAAO,MAAM,oBAAoB,cAAqB,OAAO,EAAE,KAAG,OAAO,CAAC,cAAc,EAAE,CA0BzF,CAAA"}

package/dist/neutral/validation/name/Name.d.ts

@@ -12,10 +12,30 @@ export declare class XnsNameHelper {
     get xnsName(): import("@xyo-network/payload-model").SchemaFields & import("@xyo-network/payload-model").PayloadFields & DomainFields & {
         schema: import("@xyo-network/payload-model").Schema;
     };
+    /**
+     * Create an XnsNameHelper from a domain payload
+     * @param  {Domain} domain
+     * @returns Promise<XnsNameHelper>
+     */
     static fromPayload(domain: Payload<DomainFields>): Promisable<XnsNameHelper>;
+    /**
+     * Create an XnsNameHelper from a string
+     * @param  {string} xnsName
+     * @returns Promise<XnsNameHelper>
+     */
     static fromString(xnsName: string): XnsNameHelper;
+    /**
+     * Determine if a string is a valid XNS name or hash
+     * @param  {string} source?
+     * @returns ValidSourceTypes
+     */
     static isPotentialXnsNameOrHash(source?: string): ValidSourceTypes;
     static isValid(domain: Payload<DomainFields>): Promise<boolean>;
+    /**
+     * Mask a string to be a valid XNS name
+     * @param {string} str
+     * @returns string
+     */
     static mask(str: string, options?: {
         maskStartEndHyphens: boolean;
     }): string;

package/dist/neutral/validation/name/Name.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Name.d.ts","sourceRoot":"","sources":["../../../../src/validation/name/Name.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAA;AACjD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,4BAA4B,CAAA;AACzD,OAAO,KAAK,EAAE,YAAY,EAAkB,MAAM,yCAAyC,CAAA;AAK3F,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAA;AAIxD,qBAAa,aAAa;IACxB,MAAM,CAAC,SAAS,oBAAoB;IAEpC,OAAO,CAAC,QAAQ,CAAuB;IAEvC,OAAO;IAIP,IAAI,MAAM,WAET;IAED,IAAI,IAAI,WAEP;IAED,IAAI,GAAG,UAEN;IAED,IAAI,OAAO;;MAEV;IAOD,MAAM,CAAC,WAAW,CAAC,MAAM,EAAE,OAAO,CAAC,YAAY,CAAC,GAAG,UAAU,CAAC,aAAa,CAAC;IAS5E,MAAM,CAAC,UAAU,CAAC,OAAO,EAAE,MAAM,GAAG,aAAa;IAgBjD,MAAM,CAAC,wBAAwB,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,gBAAgB;WAMrD,OAAO,CAAC,MAAM,EAAE,OAAO,CAAC,YAAY,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC;IAarE,MAAM,CAAC,IAAI,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,GAAE;QAAE,mBAAmB,EAAE,OAAO,CAAA;KAAuB,GAAG,MAAM;IAmB1F,QAAQ,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,CAAC,CAAC;CAc/C"}
+{"version":3,"file":"Name.d.ts","sourceRoot":"","sources":["../../../../src/validation/name/Name.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAA;AACjD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,4BAA4B,CAAA;AACzD,OAAO,KAAK,EAAE,YAAY,EAAkB,MAAM,yCAAyC,CAAA;AAK3F,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAA;AAIxD,qBAAa,aAAa;IACxB,MAAM,CAAC,SAAS,oBAAoB;IAEpC,OAAO,CAAC,QAAQ,CAAuB;IAEvC,OAAO;IAIP,IAAI,MAAM,WAET;IAED,IAAI,IAAI,WAEP;IAED,IAAI,GAAG,UAEN;IAED,IAAI,OAAO;;MAEV;IAED;;;;OAIG;IACH,MAAM,CAAC,WAAW,CAAC,MAAM,EAAE,OAAO,CAAC,YAAY,CAAC,GAAG,UAAU,CAAC,aAAa,CAAC;IAI5E;;;;OAIG;IACH,MAAM,CAAC,UAAU,CAAC,OAAO,EAAE,MAAM,GAAG,aAAa;IAWjD;;;;OAIG;IACH,MAAM,CAAC,wBAAwB,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,gBAAgB;WAMrD,OAAO,CAAC,MAAM,EAAE,OAAO,CAAC,YAAY,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC;IAQrE;;;;OAIG;IACH,MAAM,CAAC,IAAI,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,GAAE;QAAE,mBAAmB,EAAE,OAAO,CAAA;KAAuB,GAAG,MAAM;IAmB1F,QAAQ,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,CAAC,CAAC;CAc/C"}

package/dist/neutral/validation/name/lib/removeDisallowedCharacters.d.ts

@@ -1,2 +1,7 @@
+/**
+ * Iterates over a string removing disallowed characters
+ * @param xnsName The XNS name to remove disallowed characters from
+ * @returns The XNS name with disallowed characters removed
+ */
 export declare const removeDisallowedCharacters: (xnsName: string) => string;
 //# sourceMappingURL=removeDisallowedCharacters.d.ts.map

package/dist/neutral/validation/name/lib/removeDisallowedCharacters.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"removeDisallowedCharacters.d.ts","sourceRoot":"","sources":["../../../../../src/validation/name/lib/removeDisallowedCharacters.ts"],"names":[],"mappings":"AAYA,eAAO,MAAM,0BAA0B,YAAa,MAAM,KAAG,MAa5D,CAAA"}
+{"version":3,"file":"removeDisallowedCharacters.d.ts","sourceRoot":"","sources":["../../../../../src/validation/name/lib/removeDisallowedCharacters.ts"],"names":[],"mappings":"AAOA;;;;GAIG;AACH,eAAO,MAAM,0BAA0B,YAAa,MAAM,KAAG,MAa5D,CAAA"}

package/dist/node/estimate/lib/parseDomainEstimates.d.ts

@@ -1,4 +1,9 @@
 import type { Payload } from '@xyo-network/payload-model';
 import { type DomainEstimate } from '@xyo-network/xns-record-payload-plugins';
+/**
+ * Parses a generic array of payloads into estimates
+ * @param payloads An array of payloads
+ * @returns Parsed estimates
+ */
 export declare const parseDomainEstimates: (payloads?: Payload[]) => Promise<DomainEstimate[]>;
 //# sourceMappingURL=parseDomainEstimates.d.ts.map

package/dist/node/estimate/lib/parseDomainEstimates.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"parseDomainEstimates.d.ts","sourceRoot":"","sources":["../../../../src/estimate/lib/parseDomainEstimates.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,EACV,OAAO,EACR,MAAM,4BAA4B,CAAA;AACnC,OAAO,EACL,KAAK,cAAc,EAEpB,MAAM,yCAAyC,CAAA;AAOhD,eAAO,MAAM,oBAAoB,cAAqB,OAAO,EAAE,KAAG,OAAO,CAAC,cAAc,EAAE,CA0BzF,CAAA"}
+{"version":3,"file":"parseDomainEstimates.d.ts","sourceRoot":"","sources":["../../../../src/estimate/lib/parseDomainEstimates.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,EACV,OAAO,EACR,MAAM,4BAA4B,CAAA;AACnC,OAAO,EACL,KAAK,cAAc,EAEpB,MAAM,yCAAyC,CAAA;AAEhD;;;;GAIG;AACH,eAAO,MAAM,oBAAoB,cAAqB,OAAO,EAAE,KAAG,OAAO,CAAC,cAAc,EAAE,CA0BzF,CAAA"}

package/dist/node/validation/name/Name.d.ts

@@ -12,10 +12,30 @@ export declare class XnsNameHelper {
     get xnsName(): import("@xyo-network/payload-model").SchemaFields & import("@xyo-network/payload-model").PayloadFields & DomainFields & {
         schema: import("@xyo-network/payload-model").Schema;
     };
+    /**
+     * Create an XnsNameHelper from a domain payload
+     * @param  {Domain} domain
+     * @returns Promise<XnsNameHelper>
+     */
     static fromPayload(domain: Payload<DomainFields>): Promisable<XnsNameHelper>;
+    /**
+     * Create an XnsNameHelper from a string
+     * @param  {string} xnsName
+     * @returns Promise<XnsNameHelper>
+     */
     static fromString(xnsName: string): XnsNameHelper;
+    /**
+     * Determine if a string is a valid XNS name or hash
+     * @param  {string} source?
+     * @returns ValidSourceTypes
+     */
     static isPotentialXnsNameOrHash(source?: string): ValidSourceTypes;
     static isValid(domain: Payload<DomainFields>): Promise<boolean>;
+    /**
+     * Mask a string to be a valid XNS name
+     * @param {string} str
+     * @returns string
+     */
     static mask(str: string, options?: {
         maskStartEndHyphens: boolean;
     }): string;

package/dist/node/validation/name/Name.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Name.d.ts","sourceRoot":"","sources":["../../../../src/validation/name/Name.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAA;AACjD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,4BAA4B,CAAA;AACzD,OAAO,KAAK,EAAE,YAAY,EAAkB,MAAM,yCAAyC,CAAA;AAK3F,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAA;AAIxD,qBAAa,aAAa;IACxB,MAAM,CAAC,SAAS,oBAAoB;IAEpC,OAAO,CAAC,QAAQ,CAAuB;IAEvC,OAAO;IAIP,IAAI,MAAM,WAET;IAED,IAAI,IAAI,WAEP;IAED,IAAI,GAAG,UAEN;IAED,IAAI,OAAO;;MAEV;IAOD,MAAM,CAAC,WAAW,CAAC,MAAM,EAAE,OAAO,CAAC,YAAY,CAAC,GAAG,UAAU,CAAC,aAAa,CAAC;IAS5E,MAAM,CAAC,UAAU,CAAC,OAAO,EAAE,MAAM,GAAG,aAAa;IAgBjD,MAAM,CAAC,wBAAwB,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,gBAAgB;WAMrD,OAAO,CAAC,MAAM,EAAE,OAAO,CAAC,YAAY,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC;IAarE,MAAM,CAAC,IAAI,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,GAAE;QAAE,mBAAmB,EAAE,OAAO,CAAA;KAAuB,GAAG,MAAM;IAmB1F,QAAQ,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,CAAC,CAAC;CAc/C"}
+{"version":3,"file":"Name.d.ts","sourceRoot":"","sources":["../../../../src/validation/name/Name.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAA;AACjD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,4BAA4B,CAAA;AACzD,OAAO,KAAK,EAAE,YAAY,EAAkB,MAAM,yCAAyC,CAAA;AAK3F,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAA;AAIxD,qBAAa,aAAa;IACxB,MAAM,CAAC,SAAS,oBAAoB;IAEpC,OAAO,CAAC,QAAQ,CAAuB;IAEvC,OAAO;IAIP,IAAI,MAAM,WAET;IAED,IAAI,IAAI,WAEP;IAED,IAAI,GAAG,UAEN;IAED,IAAI,OAAO;;MAEV;IAED;;;;OAIG;IACH,MAAM,CAAC,WAAW,CAAC,MAAM,EAAE,OAAO,CAAC,YAAY,CAAC,GAAG,UAAU,CAAC,aAAa,CAAC;IAI5E;;;;OAIG;IACH,MAAM,CAAC,UAAU,CAAC,OAAO,EAAE,MAAM,GAAG,aAAa;IAWjD;;;;OAIG;IACH,MAAM,CAAC,wBAAwB,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,gBAAgB;WAMrD,OAAO,CAAC,MAAM,EAAE,OAAO,CAAC,YAAY,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC;IAQrE;;;;OAIG;IACH,MAAM,CAAC,IAAI,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,GAAE;QAAE,mBAAmB,EAAE,OAAO,CAAA;KAAuB,GAAG,MAAM;IAmB1F,QAAQ,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,CAAC,CAAC;CAc/C"}

package/dist/node/validation/name/lib/removeDisallowedCharacters.d.ts

@@ -1,2 +1,7 @@
+/**
+ * Iterates over a string removing disallowed characters
+ * @param xnsName The XNS name to remove disallowed characters from
+ * @returns The XNS name with disallowed characters removed
+ */
 export declare const removeDisallowedCharacters: (xnsName: string) => string;
 //# sourceMappingURL=removeDisallowedCharacters.d.ts.map

package/dist/node/validation/name/lib/removeDisallowedCharacters.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"removeDisallowedCharacters.d.ts","sourceRoot":"","sources":["../../../../../src/validation/name/lib/removeDisallowedCharacters.ts"],"names":[],"mappings":"AAYA,eAAO,MAAM,0BAA0B,YAAa,MAAM,KAAG,MAa5D,CAAA"}
+{"version":3,"file":"removeDisallowedCharacters.d.ts","sourceRoot":"","sources":["../../../../../src/validation/name/lib/removeDisallowedCharacters.ts"],"names":[],"mappings":"AAOA;;;;GAIG;AACH,eAAO,MAAM,0BAA0B,YAAa,MAAM,KAAG,MAa5D,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xyo-network/xns-record-payloadset-plugins",
-  "version": "3.1.1",
+  "version": "3.1.2",
   "description": "Typescript/Javascript Plugins for XYO Platform",
   "homepage": "https://xyo.network",
   "bugs": {
@@ -29,21 +29,23 @@
   "module": "dist/neutral/index.mjs",
   "types": "dist/neutral/index.d.ts",
   "dependencies": {
-    "@xylabs/assert": "^4.1.0",
-    "@xylabs/exists": "^4.1.0",
-    "@xylabs/hex": "^4.1.0",
-    "@xylabs/promise": "^4.1.0",
-    "@xyo-network/boundwitness-model": "^3.2.0",
-    "@xyo-network/diviner-hash-lease": "^3.2.0",
-    "@xyo-network/module-model": "^3.2.0",
-    "@xyo-network/payload-builder": "^3.2.0",
-    "@xyo-network/payload-model": "^3.2.0",
-    "@xyo-network/xns-record-payload-plugins": "^3.1.1"
+    "@xylabs/assert": "^4.4.9",
+    "@xylabs/exists": "^4.4.9",
+    "@xylabs/hex": "^4.4.9",
+    "@xylabs/promise": "^4.4.9",
+    "@xyo-network/boundwitness-model": "^3.5.1",
+    "@xyo-network/diviner-hash-lease": "^3.5.1",
+    "@xyo-network/module-model": "^3.5.1",
+    "@xyo-network/payload-builder": "^3.5.1",
+    "@xyo-network/payload-model": "^3.5.1",
+    "@xyo-network/xns-record-payload-plugins": "^3.1.2"
   },
   "devDependencies": {
-    "@xylabs/ts-scripts-yarn3": "^4.1.0",
-    "@xylabs/tsconfig": "^4.1.0",
-    "typescript": "^5.6.3"
+    "@xylabs/ts-scripts-yarn3": "^4.2.4",
+    "@xylabs/tsconfig": "^4.2.4",
+    "@xylabs/vitest-extended": "^4.4.9",
+    "typescript": "^5.7.2",
+    "vitest": "^2.1.6"
   },
   "publishConfig": {
     "access": "public"

package/src/estimate/lib/spec/matchers/customMatchers.ts

@@ -0,0 +1,287 @@
+interface ExpectationResult {
+  actual?: unknown
+  expected?: unknown
+  message: () => string
+  pass: boolean
+}
+
+function toBeType(received: unknown, expectedType: string): ExpectationResult {
+  const pass = typeof received === expectedType && !Number.isNaN(received)
+  return pass
+    ? {
+        message: () => `expected ${received} not to be a ${expectedType}`,
+        pass: true,
+      }
+    : {
+        message: () => `expected ${received} to be a ${expectedType}`,
+        pass: false,
+      }
+}
+
+export const matchers = {
+  toBeArrayOfSize(received: unknown, expectedSize: number): ExpectationResult {
+    const pass = Array.isArray(received) && received.length === expectedSize
+    return pass
+      ? {
+          message: () => `expected array not to have size ${expectedSize}, but received array of size ${received.length}`,
+          pass: true,
+        }
+      : {
+          message: () => Array.isArray(received)
+            ? `expected array of size ${expectedSize}, but received array of size ${received.length}`
+            : `expected array of size ${expectedSize}, but received a non-array`,
+          pass: false,
+        }
+  },
+  toBeArray(received: unknown): ExpectationResult {
+    const pass = Array.isArray(received)
+    return pass
+      ? {
+          message: () => 'expected array',
+          pass: true,
+        }
+      : {
+          message: () => `expected array, but received ${typeof received}`,
+          pass: false,
+        }
+  },
+  toBeOneOf(received: unknown, expected: unknown[]): ExpectationResult {
+    const pass = expected.includes(received)
+    return pass
+      ? {
+          pass: true,
+          message: () =>
+            `expected ${received} not to be one of ${JSON.stringify(expected)}`,
+        }
+      : {
+          pass: false,
+          message: () =>
+            `expected ${received} to be one of ${JSON.stringify(expected)}`,
+        }
+  },
+  toBeNegative(received: number): ExpectationResult {
+    if (typeof received !== 'number') {
+      throw new TypeError(`Expected a number, but received ${typeof received}`)
+    }
+
+    const pass = received < 0
+    return pass
+      ? {
+          pass: true,
+          message: () =>
+            `expected ${received} not to be negative`,
+        }
+      : {
+          pass: false,
+          message: () =>
+            `expected ${received} to be negative`,
+        }
+  },
+  toBePositive(received: number): ExpectationResult {
+    if (typeof received !== 'number') {
+      throw new TypeError(`Expected a number, but received ${typeof received}`)
+    }
+
+    const pass = received > 0
+    return pass
+      ? {
+          pass: true,
+          message: () =>
+            `expected ${received} not to be positive`,
+        }
+      : {
+          pass: false,
+          message: () =>
+            `expected ${received} to be positive`,
+        }
+  },
+  toBeNumber: (received: unknown) => toBeType(received, 'number'),
+  toBeFunction: (received: unknown) => toBeType(received, 'function'),
+  toBeString: (received: unknown) => toBeType(received, 'string'),
+  toBeObject(received: unknown): ExpectationResult {
+    const pass = typeof received === 'object' && !Array.isArray(received) && received !== null
+    return pass
+      ? {
+          message: () => `expected ${received} to be object`,
+          pass: true,
+        }
+      : {
+          message: () => `expected ${received} to be an object but was ${Array.isArray(received) ? 'array' : typeof received}`,
+          pass: false,
+        }
+  },
+  toBeInteger(received: number): ExpectationResult {
+    if (typeof received !== 'number') {
+      throw new TypeError(`Expected a number, but received ${typeof received}`)
+    }
+
+    const pass = Number.isInteger(received)
+    return pass
+      ? {
+          pass: true,
+          message: () =>
+            `expected ${received} not to be an integer`,
+        }
+      : {
+          pass: false,
+          message: () =>
+            `expected ${received} to be an integer`,
+        }
+  },
+  toBeFalse(received: unknown): ExpectationResult {
+    const pass = received === false
+    return pass
+      ? {
+          message: () => `expected ${received} to be false`,
+          pass: true,
+        }
+      : {
+          message: () => `expected ${received} to be false but was not false`,
+          pass: false,
+        }
+  },
+  toBeTrue(received: unknown): ExpectationResult {
+    const pass = received === true
+    return pass
+      ? {
+          message: () => `expected ${received} to be true`,
+          pass: true,
+        }
+      : {
+          message: () => `expected ${received} to be true but was not true`,
+          pass: false,
+        }
+  },
+  toIncludeAllMembers(received: unknown[], expected: unknown[]): ExpectationResult {
+    if (!Array.isArray(received) || !Array.isArray(expected)) {
+      return {
+        pass: false,
+        message: () => 'Expected both received and expected values to be arrays.',
+      }
+    }
+
+    const missingMembers = expected.filter(item => !received.includes(item))
+
+    return missingMembers.length === 0
+      ? {
+          pass: true,
+          message: () =>
+            `Expected array not to include all members of ${JSON.stringify(expected)}, but it does.`,
+        }
+      : {
+          pass: false,
+          message: () =>
+            `Expected array to include all members of ${JSON.stringify(expected)}. Missing members: ${JSON.stringify(
+              missingMembers,
+            )}.`,
+        }
+  },
+  toContainAllKeys(received: object, expectedKeys: string[]): ExpectationResult {
+    if (typeof received !== 'object' || received === null) {
+      return {
+        pass: false,
+        message: () => `Expected ${JSON.stringify(received)} to be an object.`,
+      }
+    }
+
+    if (!Array.isArray(expectedKeys)) {
+      return {
+        pass: false,
+        message: () => `Expected keys to be an array, but received ${JSON.stringify(expectedKeys)}.`,
+      }
+    }
+
+    const missingKeys = expectedKeys.filter(key => !(key in received))
+
+    return missingKeys.length === 0
+      ? {
+          pass: true,
+          message: () =>
+            `Expected object not to contain all keys ${JSON.stringify(expectedKeys)}, but it does.`,
+        }
+      : {
+          pass: false,
+          message: () =>
+            `Expected object to contain all keys ${JSON.stringify(expectedKeys)}. Missing keys: ${JSON.stringify(
+              missingKeys,
+            )}.`,
+        }
+  },
+  toContainValues(received: object, expectedValues: unknown[]): ExpectationResult {
+    if (typeof received !== 'object' || received === null) {
+      return {
+        pass: false,
+        message: () => `Expected ${JSON.stringify(received)} to be an object.`,
+      }
+    }
+
+    if (!Array.isArray(expectedValues)) {
+      return {
+        pass: false,
+        message: () => `Expected values to be an array, but received ${JSON.stringify(expectedValues)}.`,
+      }
+    }
+
+    const objectValues = Object.values(received)
+
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    const deepEqual = (a: any, b: any): boolean => {
+      if (a === b) return true
+      if (typeof a !== typeof b) return false
+      if (a && b && typeof a === 'object') {
+        const aKeys = Object.keys(a)
+        const bKeys = Object.keys(b)
+        if (aKeys.length !== bKeys.length) return false
+        return aKeys.every(key => deepEqual(a[key], b[key]))
+      }
+      return false
+    }
+
+    const missingValues = expectedValues.filter(
+      expectedValue => !objectValues.some(value => deepEqual(value, expectedValue)),
+    )
+
+    return missingValues.length === 0
+      ? {
+          pass: true,
+          message: () =>
+            `Expected object not to contain all values ${JSON.stringify(expectedValues)}, but it does.`,
+        }
+      : {
+          pass: false,
+          message: () =>
+            `Expected object to contain all values ${JSON.stringify(expectedValues)}. Missing values: ${JSON.stringify(
+              missingValues,
+            )}.`,
+        }
+  },
+  toBeEmpty(received: unknown): ExpectationResult {
+    let isEmpty = false
+
+    if (Array.isArray(received) || typeof received === 'string') {
+      isEmpty = received.length === 0
+    } else if (received && typeof received === 'object') {
+      isEmpty = Object.keys(received).length === 0
+    } else if (received instanceof Map || received instanceof Set) {
+      isEmpty = received.size === 0
+    } else {
+      return {
+        pass: false,
+        message: () =>
+          `Expected value to be an empty array, string, object, Map, or Set, but received ${typeof received}.`,
+      }
+    }
+
+    return isEmpty
+      ? {
+          pass: true,
+          message: () =>
+            'Expected value not to be empty, but it was.',
+        }
+      : {
+          pass: false,
+          message: () =>
+            'Expected value to be empty, but it was not.',
+        }
+  },
+}

package/src/estimate/lib/spec/matchers/index.ts

@@ -0,0 +1 @@
+export * from './customMatchers.ts'

package/src/estimate/lib/spec/matchers/vitest.customMatchers.d.ts

@@ -0,0 +1,27 @@
+// vitest.customMatchers.d.ts
+import 'vitest'
+
+interface CustomMatchers<T = unknown> {
+  toBeArray(): T
+  toBeArrayOfSize(size: number): T
+  toBeEmpty(): T
+  toBeFalse(): T
+  toBeFunction(): T
+  toBeInteger(): T
+  toBeNegative(): T
+  toBeNumber(): T
+  toBeObject(): T
+  toBeOneOf(expected: unknown[]): T
+  toBePositive(): T
+  toBeString(): T
+  toBeTrue(): T
+  toContainAllKeys(expectedKeys: string[]): T
+  toContainValues(expectedValues: unknown[]): T
+  toIncludeAllMembers(expected: unknown[]): T
+}
+
+// Extend the expect Matchers interface
+declare module 'vitest' {
+  interface Assertion<T = unknown> extends CustomMatchers<T> {}
+  interface AsymmetricMatchersContaining extends CustomMatchers {}
+}