@xyo-network/xns-record-payloadset-plugins 4.1.0 → 4.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (4) hide show
  1. package/dist/browser/index.d.ts +3 -72
  2. package/dist/neutral/index.d.ts +3 -72
  3. package/dist/node/index.d.ts +3 -72
  4. package/package.json +15 -16
package/dist/browser/index.d.ts CHANGED
@@ -1,72 +1,3 @@
1
- import { Payload, PayloadValidationFunction } from '@xyo-network/payload-model';
2
- import { DomainEstimate, DomainFields } from '@xyo-network/xns-record-payload-plugins';
3
- import { Promisable } from '@xylabs/promise';
4
-
5
- /**
6
- * Parses a generic array of payloads into estimates
7
- * @param payloads An array of payloads
8
- * @returns Parsed estimates
9
- */
10
- declare const parseDomainEstimates: (payloads?: Payload[]) => Promise<DomainEstimate[]>;
11
-
12
- type ValidSourceTypes = 'xnsName' | 'hash' | null;
13
-
14
- declare class XnsNameHelper {
15
- static readonly ValidTLDs: readonly [".xyo"];
16
- private _xnsName;
17
- private constructor();
18
- get domain(): string;
19
- get name(): string;
20
- get tld(): "xyo";
21
- get xnsName(): Payload<DomainFields>;
22
- /**
23
- * Create an XnsNameHelper from a domain payload
24
- * @param {Domain} domain
25
- * @returns Promise<XnsNameHelper>
26
- */
27
- static fromPayload(domain: Payload<DomainFields>): Promisable<XnsNameHelper>;
28
- /**
29
- * Create an XnsNameHelper from a string
30
- * @param {string} xnsName
31
- * @returns Promise<XnsNameHelper>
32
- */
33
- static fromString(xnsName: string): XnsNameHelper;
34
- /**
35
- * Determine if a string is a valid XNS name or hash
36
- * @param {string} source?
37
- * @returns ValidSourceTypes
38
- */
39
- static isPotentialXnsNameOrHash(source?: string): ValidSourceTypes;
40
- static isValid(domain: Payload<DomainFields>): Promise<boolean>;
41
- /**
42
- * Mask a string to be a valid XNS name
43
- * @param {string} str
44
- * @returns string
45
- */
46
- static mask(str: string, options?: {
47
- maskStartEndHyphens: boolean;
48
- }): string;
49
- validate(): Promise<[boolean, string[]]>;
50
- }
51
-
52
- declare const MIN_DOMAIN_LENGTH = 3;
53
- declare const MAX_DOMAIN_LENGTH = 128;
54
-
55
- declare const getDomainReservedStringsValidator: (reservedStrings: string[]) => PayloadValidationFunction<Payload<DomainFields>>;
56
- declare const getDomainReservedFragmentsValidator: (reservedFragments: string[]) => PayloadValidationFunction<Payload<DomainFields>>;
57
- declare const getDomainReservedNamesValidator: (reservedNames: string[]) => PayloadValidationFunction<Payload<DomainFields>>;
58
-
59
- type PayloadValidationFunctionWithError<T extends Payload = Payload> = (payload: T, onErrors?: (message: string[]) => void) => boolean | Promise<boolean>;
60
- declare const domainCasingValidator: PayloadValidationFunctionWithError<Payload<DomainFields>>;
61
- declare const domainModuleNameValidator: PayloadValidationFunctionWithError<Payload<DomainFields>>;
62
- declare const domainTldValidator: PayloadValidationFunctionWithError<Payload<DomainFields>>;
63
- declare const getDomainLengthValidator: (minNameLength?: number, maxLength?: number) => PayloadValidationFunctionWithError<Payload<DomainFields>>;
64
- declare const getDomainAllowedHyphensValidator: (options?: {
65
- end?: boolean;
66
- start?: boolean;
67
- }) => PayloadValidationFunctionWithError<Payload<DomainFields>>;
68
- declare const XnsNameSimpleValidators: PayloadValidationFunctionWithError<Payload<DomainFields>>[];
69
- declare const XnsNameSimpleValidatorsWithErrors: (onErrors: (message: string[]) => void) => ((payload: Payload<DomainFields>) => boolean | Promise<boolean>)[];
70
-
71
- export { MAX_DOMAIN_LENGTH, MIN_DOMAIN_LENGTH, XnsNameHelper, XnsNameSimpleValidators, XnsNameSimpleValidatorsWithErrors, domainCasingValidator, domainModuleNameValidator, domainTldValidator, getDomainAllowedHyphensValidator, getDomainLengthValidator, getDomainReservedFragmentsValidator, getDomainReservedNamesValidator, getDomainReservedStringsValidator, parseDomainEstimates };
72
- export type { PayloadValidationFunctionWithError, ValidSourceTypes };
1
+ export * from './estimate/index.ts';
2
+ export * from './validation/index.ts';
3
+ //# sourceMappingURL=index.d.ts.map
package/dist/neutral/index.d.ts CHANGED
@@ -1,72 +1,3 @@
1
- import { Payload, PayloadValidationFunction } from '@xyo-network/payload-model';
2
- import { DomainEstimate, DomainFields } from '@xyo-network/xns-record-payload-plugins';
3
- import { Promisable } from '@xylabs/promise';
4
-
5
- /**
6
- * Parses a generic array of payloads into estimates
7
- * @param payloads An array of payloads
8
- * @returns Parsed estimates
9
- */
10
- declare const parseDomainEstimates: (payloads?: Payload[]) => Promise<DomainEstimate[]>;
11
-
12
- type ValidSourceTypes = 'xnsName' | 'hash' | null;
13
-
14
- declare class XnsNameHelper {
15
- static readonly ValidTLDs: readonly [".xyo"];
16
- private _xnsName;
17
- private constructor();
18
- get domain(): string;
19
- get name(): string;
20
- get tld(): "xyo";
21
- get xnsName(): Payload<DomainFields>;
22
- /**
23
- * Create an XnsNameHelper from a domain payload
24
- * @param {Domain} domain
25
- * @returns Promise<XnsNameHelper>
26
- */
27
- static fromPayload(domain: Payload<DomainFields>): Promisable<XnsNameHelper>;
28
- /**
29
- * Create an XnsNameHelper from a string
30
- * @param {string} xnsName
31
- * @returns Promise<XnsNameHelper>
32
- */
33
- static fromString(xnsName: string): XnsNameHelper;
34
- /**
35
- * Determine if a string is a valid XNS name or hash
36
- * @param {string} source?
37
- * @returns ValidSourceTypes
38
- */
39
- static isPotentialXnsNameOrHash(source?: string): ValidSourceTypes;
40
- static isValid(domain: Payload<DomainFields>): Promise<boolean>;
41
- /**
42
- * Mask a string to be a valid XNS name
43
- * @param {string} str
44
- * @returns string
45
- */
46
- static mask(str: string, options?: {
47
- maskStartEndHyphens: boolean;
48
- }): string;
49
- validate(): Promise<[boolean, string[]]>;
50
- }
51
-
52
- declare const MIN_DOMAIN_LENGTH = 3;
53
- declare const MAX_DOMAIN_LENGTH = 128;
54
-
55
- declare const getDomainReservedStringsValidator: (reservedStrings: string[]) => PayloadValidationFunction<Payload<DomainFields>>;
56
- declare const getDomainReservedFragmentsValidator: (reservedFragments: string[]) => PayloadValidationFunction<Payload<DomainFields>>;
57
- declare const getDomainReservedNamesValidator: (reservedNames: string[]) => PayloadValidationFunction<Payload<DomainFields>>;
58
-
59
- type PayloadValidationFunctionWithError<T extends Payload = Payload> = (payload: T, onErrors?: (message: string[]) => void) => boolean | Promise<boolean>;
60
- declare const domainCasingValidator: PayloadValidationFunctionWithError<Payload<DomainFields>>;
61
- declare const domainModuleNameValidator: PayloadValidationFunctionWithError<Payload<DomainFields>>;
62
- declare const domainTldValidator: PayloadValidationFunctionWithError<Payload<DomainFields>>;
63
- declare const getDomainLengthValidator: (minNameLength?: number, maxLength?: number) => PayloadValidationFunctionWithError<Payload<DomainFields>>;
64
- declare const getDomainAllowedHyphensValidator: (options?: {
65
- end?: boolean;
66
- start?: boolean;
67
- }) => PayloadValidationFunctionWithError<Payload<DomainFields>>;
68
- declare const XnsNameSimpleValidators: PayloadValidationFunctionWithError<Payload<DomainFields>>[];
69
- declare const XnsNameSimpleValidatorsWithErrors: (onErrors: (message: string[]) => void) => ((payload: Payload<DomainFields>) => boolean | Promise<boolean>)[];
70
-
71
- export { MAX_DOMAIN_LENGTH, MIN_DOMAIN_LENGTH, XnsNameHelper, XnsNameSimpleValidators, XnsNameSimpleValidatorsWithErrors, domainCasingValidator, domainModuleNameValidator, domainTldValidator, getDomainAllowedHyphensValidator, getDomainLengthValidator, getDomainReservedFragmentsValidator, getDomainReservedNamesValidator, getDomainReservedStringsValidator, parseDomainEstimates };
72
- export type { PayloadValidationFunctionWithError, ValidSourceTypes };
1
+ export * from './estimate/index.ts';
2
+ export * from './validation/index.ts';
3
+ //# sourceMappingURL=index.d.ts.map
package/dist/node/index.d.ts CHANGED
@@ -1,72 +1,3 @@
1
- import { Payload, PayloadValidationFunction } from '@xyo-network/payload-model';
2
- import { DomainEstimate, DomainFields } from '@xyo-network/xns-record-payload-plugins';
3
- import { Promisable } from '@xylabs/promise';
4
-
5
- /**
6
- * Parses a generic array of payloads into estimates
7
- * @param payloads An array of payloads
8
- * @returns Parsed estimates
9
- */
10
- declare const parseDomainEstimates: (payloads?: Payload[]) => Promise<DomainEstimate[]>;
11
-
12
- type ValidSourceTypes = 'xnsName' | 'hash' | null;
13
-
14
- declare class XnsNameHelper {
15
- static readonly ValidTLDs: readonly [".xyo"];
16
- private _xnsName;
17
- private constructor();
18
- get domain(): string;
19
- get name(): string;
20
- get tld(): "xyo";
21
- get xnsName(): Payload<DomainFields>;
22
- /**
23
- * Create an XnsNameHelper from a domain payload
24
- * @param {Domain} domain
25
- * @returns Promise<XnsNameHelper>
26
- */
27
- static fromPayload(domain: Payload<DomainFields>): Promisable<XnsNameHelper>;
28
- /**
29
- * Create an XnsNameHelper from a string
30
- * @param {string} xnsName
31
- * @returns Promise<XnsNameHelper>
32
- */
33
- static fromString(xnsName: string): XnsNameHelper;
34
- /**
35
- * Determine if a string is a valid XNS name or hash
36
- * @param {string} source?
37
- * @returns ValidSourceTypes
38
- */
39
- static isPotentialXnsNameOrHash(source?: string): ValidSourceTypes;
40
- static isValid(domain: Payload<DomainFields>): Promise<boolean>;
41
- /**
42
- * Mask a string to be a valid XNS name
43
- * @param {string} str
44
- * @returns string
45
- */
46
- static mask(str: string, options?: {
47
- maskStartEndHyphens: boolean;
48
- }): string;
49
- validate(): Promise<[boolean, string[]]>;
50
- }
51
-
52
- declare const MIN_DOMAIN_LENGTH = 3;
53
- declare const MAX_DOMAIN_LENGTH = 128;
54
-
55
- declare const getDomainReservedStringsValidator: (reservedStrings: string[]) => PayloadValidationFunction<Payload<DomainFields>>;
56
- declare const getDomainReservedFragmentsValidator: (reservedFragments: string[]) => PayloadValidationFunction<Payload<DomainFields>>;
57
- declare const getDomainReservedNamesValidator: (reservedNames: string[]) => PayloadValidationFunction<Payload<DomainFields>>;
58
-
59
- type PayloadValidationFunctionWithError<T extends Payload = Payload> = (payload: T, onErrors?: (message: string[]) => void) => boolean | Promise<boolean>;
60
- declare const domainCasingValidator: PayloadValidationFunctionWithError<Payload<DomainFields>>;
61
- declare const domainModuleNameValidator: PayloadValidationFunctionWithError<Payload<DomainFields>>;
62
- declare const domainTldValidator: PayloadValidationFunctionWithError<Payload<DomainFields>>;
63
- declare const getDomainLengthValidator: (minNameLength?: number, maxLength?: number) => PayloadValidationFunctionWithError<Payload<DomainFields>>;
64
- declare const getDomainAllowedHyphensValidator: (options?: {
65
- end?: boolean;
66
- start?: boolean;
67
- }) => PayloadValidationFunctionWithError<Payload<DomainFields>>;
68
- declare const XnsNameSimpleValidators: PayloadValidationFunctionWithError<Payload<DomainFields>>[];
69
- declare const XnsNameSimpleValidatorsWithErrors: (onErrors: (message: string[]) => void) => ((payload: Payload<DomainFields>) => boolean | Promise<boolean>)[];
70
-
71
- export { MAX_DOMAIN_LENGTH, MIN_DOMAIN_LENGTH, XnsNameHelper, XnsNameSimpleValidators, XnsNameSimpleValidatorsWithErrors, domainCasingValidator, domainModuleNameValidator, domainTldValidator, getDomainAllowedHyphensValidator, getDomainLengthValidator, getDomainReservedFragmentsValidator, getDomainReservedNamesValidator, getDomainReservedStringsValidator, parseDomainEstimates };
72
- export type { PayloadValidationFunctionWithError, ValidSourceTypes };
1
+ export * from './estimate/index.ts';
2
+ export * from './validation/index.ts';
3
+ //# sourceMappingURL=index.d.ts.map
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@xyo-network/xns-record-payloadset-plugins",
3
- "version": "4.1.0",
3
+ "version": "4.2.0",
4
4
  "description": "Typescript/Javascript Plugins for XYO Platform",
5
5
  "homepage": "https://xyo.network",
6
6
  "bugs": {
@@ -29,23 +29,22 @@
29
29
  "module": "dist/neutral/index.mjs",
30
30
  "types": "dist/neutral/index.d.ts",
31
31
  "dependencies": {
32
- "@xylabs/array": "^4.13.15",
33
- "@xylabs/assert": "^4.13.15",
34
- "@xylabs/exists": "^4.13.15",
35
- "@xylabs/hex": "^4.13.15",
36
- "@xylabs/promise": "^4.13.15",
37
- "@xyo-network/boundwitness-model": "^4.1.1",
38
- "@xyo-network/diviner-hash-lease": "^4.1.1",
39
- "@xyo-network/module-model": "^4.1.1",
40
- "@xyo-network/payload-builder": "^4.1.1",
41
- "@xyo-network/payload-model": "^4.1.1",
42
- "@xyo-network/xns-record-payload-plugins": "^4.1.0"
32
+ "@xylabs/array": "^4.15.1",
33
+ "@xylabs/assert": "^4.15.1",
34
+ "@xylabs/exists": "^4.15.1",
35
+ "@xylabs/hex": "^4.15.1",
36
+ "@xylabs/promise": "^4.15.1",
37
+ "@xyo-network/boundwitness-model": "^4.3.0",
38
+ "@xyo-network/diviner-hash-lease": "^4.3.0",
39
+ "@xyo-network/module-model": "^4.3.0",
40
+ "@xyo-network/payload-builder": "^4.3.0",
41
+ "@xyo-network/payload-model": "^4.3.0",
42
+ "@xyo-network/xns-record-payload-plugins": "^4.2.0"
43
43
  },
44
44
  "devDependencies": {
45
- "@xylabs/ts-scripts-yarn3": "^7.0.0-rc.24",
46
- "@xylabs/tsconfig": "^7.0.0-rc.24",
47
- "@xylabs/vitest-extended": "^4.13.15",
48
- "knip": "^5.61.3",
45
+ "@xylabs/ts-scripts-yarn3": "^7.0.1",
46
+ "@xylabs/tsconfig": "^7.0.1",
47
+ "@xylabs/vitest-extended": "^4.15.1",
49
48
  "typescript": "^5.8.3",
50
49
  "vitest": "^3.2.4"
51
50
  },