@xyo-network/xns-record-payloadset-plugins 3.1.1 → 3.2.0-rc.1

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 (29) hide show
  1. package/dist/browser/estimate/lib/parseDomainEstimates.d.ts +5 -0
  2. package/dist/browser/estimate/lib/parseDomainEstimates.d.ts.map +1 -1
  3. package/dist/browser/index.mjs +4 -4
  4. package/dist/browser/index.mjs.map +1 -1
  5. package/dist/browser/validation/name/Name.d.ts +20 -0
  6. package/dist/browser/validation/name/Name.d.ts.map +1 -1
  7. package/dist/browser/validation/name/lib/removeDisallowedCharacters.d.ts +5 -0
  8. package/dist/browser/validation/name/lib/removeDisallowedCharacters.d.ts.map +1 -1
  9. package/dist/neutral/estimate/lib/parseDomainEstimates.d.ts +5 -0
  10. package/dist/neutral/estimate/lib/parseDomainEstimates.d.ts.map +1 -1
  11. package/dist/neutral/index.mjs +4 -4
  12. package/dist/neutral/index.mjs.map +1 -1
  13. package/dist/neutral/validation/name/Name.d.ts +20 -0
  14. package/dist/neutral/validation/name/Name.d.ts.map +1 -1
  15. package/dist/neutral/validation/name/lib/removeDisallowedCharacters.d.ts +5 -0
  16. package/dist/neutral/validation/name/lib/removeDisallowedCharacters.d.ts.map +1 -1
  17. package/dist/node/estimate/lib/parseDomainEstimates.d.ts +5 -0
  18. package/dist/node/estimate/lib/parseDomainEstimates.d.ts.map +1 -1
  19. package/dist/node/index.mjs +4 -4
  20. package/dist/node/index.mjs.map +1 -1
  21. package/dist/node/validation/name/Name.d.ts +20 -0
  22. package/dist/node/validation/name/Name.d.ts.map +1 -1
  23. package/dist/node/validation/name/lib/removeDisallowedCharacters.d.ts +5 -0
  24. package/dist/node/validation/name/lib/removeDisallowedCharacters.d.ts.map +1 -1
  25. package/package.json +18 -15
  26. package/src/estimate/lib/parseDomainEstimates.ts +7 -9
  27. package/src/estimate/lib/spec/matchers/customMatchers.ts +287 -0
  28. package/src/estimate/lib/spec/matchers/index.ts +1 -0
  29. package/src/estimate/lib/spec/matchers/vitest.customMatchers.d.ts +27 -0
@@ -1,4 +1,9 @@
1
1
  import type { Payload } from '@xyo-network/payload-model';
2
2
  import { type DomainEstimate } from '@xyo-network/xns-record-payload-plugins';
3
+ /**
4
+ * Parses a generic array of payloads into estimates
5
+ * @param payloads An array of payloads
6
+ * @returns Parsed estimates
7
+ */
3
8
  export declare const parseDomainEstimates: (payloads?: Payload[]) => Promise<DomainEstimate[]>;
4
9
  //# sourceMappingURL=parseDomainEstimates.d.ts.map
@@ -1 +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"}
1
+ {"version":3,"file":"parseDomainEstimates.d.ts","sourceRoot":"","sources":["../../../../src/estimate/lib/parseDomainEstimates.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,EAAE,OAAO,EAAe,MAAM,4BAA4B,CAAA;AACtE,OAAO,EACL,KAAK,cAAc,EAEpB,MAAM,yCAAyC,CAAA;AAEhD;;;;GAIG;AACH,eAAO,MAAM,oBAAoB,cAAqB,OAAO,EAAE,KAAG,OAAO,CAAC,cAAc,EAAE,CA0BzF,CAAA"}
@@ -3,12 +3,12 @@ import { exists } from "@xylabs/exists";
3
3
  import { isBoundWitness } from "@xyo-network/boundwitness-model";
4
4
  import {
5
5
  HashLeaseEstimateSchema,
6
- isHashLeaseEstimateWithMeta
6
+ isHashLeaseEstimate
7
7
  } from "@xyo-network/diviner-hash-lease";
8
8
  import { PayloadBuilder } from "@xyo-network/payload-builder";
9
9
  import {
10
10
  DomainRegistrationLeaseSchema,
11
- isDomainRegistrationLeaseWithMeta
11
+ isDomainRegistrationLease
12
12
  } from "@xyo-network/xns-record-payload-plugins";
13
13
  var parseDomainEstimates = async (payloads) => {
14
14
  if (!payloads) return [];
@@ -20,14 +20,14 @@ var parseDomainEstimates = async (payloads) => {
20
20
  bw,
21
21
  HashLeaseEstimateSchema,
22
22
  hashMap,
23
- isHashLeaseEstimateWithMeta
23
+ isHashLeaseEstimate
24
24
  );
25
25
  if (!hashLeaseEstimate) return;
26
26
  const domainLease = getPayloadBySchemaFromBoundWitness(
27
27
  bw,
28
28
  DomainRegistrationLeaseSchema,
29
29
  hashMap,
30
- isDomainRegistrationLeaseWithMeta
30
+ isDomainRegistrationLease
31
31
  );
32
32
  if (!domainLease) return;
33
33
  return [bw, hashLeaseEstimate, domainLease];
@@ -1 +1 @@
1
- {"version":3,"sources":["../../src/estimate/lib/parseDomainEstimates.ts","../../src/validation/name/Name.ts","../../src/validation/validation/Constants.ts","../../src/validation/validation/factory/validators.ts","../../src/validation/validation/validators/validators.ts","../../src/validation/name/lib/removeDisallowedCharacters.ts"],"sourcesContent":["import { exists } from '@xylabs/exists'\nimport { type BoundWitness, isBoundWitness } from '@xyo-network/boundwitness-model'\nimport {\n type HashLeaseEstimate, HashLeaseEstimateSchema,\n isHashLeaseEstimateWithMeta,\n} from '@xyo-network/diviner-hash-lease'\nimport { PayloadBuilder } from '@xyo-network/payload-builder'\nimport type {\n Payload, WithMeta, WithSources,\n} from '@xyo-network/payload-model'\nimport {\n type DomainEstimate,\n type DomainRegistrationLease, DomainRegistrationLeaseSchema, isDomainRegistrationLeaseWithMeta,\n} from '@xyo-network/xns-record-payload-plugins'\n\n/**\n * Parses a generic array of payloads into estimates\n * @param payloads An array of payloads\n * @returns Parsed estimates\n */\nexport const parseDomainEstimates = async (payloads?: Payload[]): Promise<DomainEstimate[]> => {\n if (!payloads) return []\n const bws = payloads\n // Find all bound witnesses\n .filter(isBoundWitness)\n // that have the required estimate payloads\n .filter(hasEstimatePayloads) ?? []\n if (bws.length === 0) return []\n const hashMap = await PayloadBuilder.toAllHashMap(payloads)\n return bws.map<DomainEstimate | undefined>((bw) => {\n const hashLeaseEstimate = getPayloadBySchemaFromBoundWitness<WithSources<HashLeaseEstimate>>(\n bw,\n HashLeaseEstimateSchema,\n hashMap,\n isHashLeaseEstimateWithMeta,\n )\n if (!hashLeaseEstimate) return\n const domainLease = getPayloadBySchemaFromBoundWitness<DomainRegistrationLease>(\n bw,\n DomainRegistrationLeaseSchema,\n hashMap,\n isDomainRegistrationLeaseWithMeta,\n )\n if (!domainLease) return\n return [bw, hashLeaseEstimate, domainLease]\n }).filter(exists)\n}\n\n/**\n * Tests if a BoundWitness has the required estimate payloads\n * @param bw The BoundWitness to check for estimate payloads\n * @returns True if the BoundWitness has the required estimate payloads, false otherwise\n */\nconst hasEstimatePayloads = (bw: BoundWitness): boolean => {\n return bw.payload_schemas.includes(DomainRegistrationLeaseSchema)\n && bw.payload_schemas.includes(HashLeaseEstimateSchema)\n}\n\n/**\n * Finds the first instance of a payload in a BoundWitness by schema\n * @param bw The BoundWitness to extract the payload from\n * @param schema The schema of the payload to extract\n * @param hashMap The hashmap of the payloads\n * @param identity An identity function to check if the payload is of the correct type\n * @returns The payload if it exists or undefined\n */\nconst getPayloadBySchemaFromBoundWitness = <T extends Payload = Payload>(\n bw: BoundWitness,\n schema: string,\n hashMap: Awaited<ReturnType<typeof PayloadBuilder.toHashMap>>,\n identity: (payload: Payload) => payload is WithMeta<T>,\n): WithMeta<T> | undefined => {\n const schemaIndex = bw.payload_schemas.indexOf(schema)\n if (schemaIndex === -1) return\n const hash = bw.payload_hashes[schemaIndex]\n return [hashMap[hash]].filter(exists).find(identity)\n}\n","import { assertEx } from '@xylabs/assert'\nimport { isHash } from '@xylabs/hex'\nimport type { Promisable } from '@xylabs/promise'\nimport type { Payload } from '@xyo-network/payload-model'\nimport type { DomainFields, TopLevelDomain } from '@xyo-network/xns-record-payload-plugins'\nimport { DomainSchema } from '@xyo-network/xns-record-payload-plugins'\n\nimport { MAX_DOMAIN_LENGTH, XnsNameSimpleValidators } from '../validation/index.ts'\nimport { removeDisallowedCharacters } from './lib/index.ts'\nimport type { ValidSourceTypes } from './types/index.ts'\n\nconst defaultMaskOptions = { maskStartEndHyphens: false }\n\nexport class XnsNameHelper {\n static ValidTLDs = ['.xyo'] as const\n\n private _xnsName: Payload<DomainFields>\n\n private constructor(xnsName: Payload<DomainFields>) {\n this._xnsName = xnsName\n }\n\n get domain() {\n return assertEx(this.xnsName.domain, () => 'domain not found in payload')\n }\n\n get name() {\n return `${this.domain}.${this.tld}`\n }\n\n get tld() {\n return assertEx(this.xnsName.tld, () => 'tld not found in payload')\n }\n\n get xnsName() {\n return assertEx(this._xnsName, () => 'XnsNameHelper xnsName not set')\n }\n\n /**\n * Create an XnsNameHelper from a domain payload\n * @param {Domain} domain\n * @returns Promise<XnsNameHelper>\n */\n static fromPayload(domain: Payload<DomainFields>): Promisable<XnsNameHelper> {\n return new XnsNameHelper(domain)\n }\n\n /**\n * Create an XnsNameHelper from a string\n * @param {string} xnsName\n * @returns Promise<XnsNameHelper>\n */\n static fromString(xnsName: string): XnsNameHelper {\n const parts = xnsName.split('.')\n assertEx(parts.length === 2, () => 'Unable to parse xnsName')\n\n const domain = parts[0]\n const tld = parts[1] as TopLevelDomain\n return new XnsNameHelper({\n schema: DomainSchema, domain, tld,\n })\n }\n\n /**\n * Determine if a string is a valid XNS name or hash\n * @param {string} source?\n * @returns ValidSourceTypes\n */\n static isPotentialXnsNameOrHash(source?: string): ValidSourceTypes {\n if (isHash(source)) return 'hash'\n const xnsName = XnsNameHelper.ValidTLDs.some(tld => source?.endsWith(tld)) ? source : null\n return xnsName ? 'xnsName' : null\n }\n\n static async isValid(domain: Payload<DomainFields>): Promise<boolean> {\n const results = await Promise.all(XnsNameSimpleValidators.map(validator => validator(domain)))\n for (const result of results) {\n if (!result) return false\n }\n return true\n }\n\n /**\n * Mask a string to be a valid XNS name\n * @param {string} str\n * @returns string\n */\n static mask(str: string, options: { maskStartEndHyphens: boolean } = defaultMaskOptions): string {\n // Check if the domain name is too long\n if (str.length > MAX_DOMAIN_LENGTH) {\n throw new Error(`Domain name too long: ${str.length} exceeds max length: ${MAX_DOMAIN_LENGTH}`)\n }\n\n // convert to lowercase\n const lowercaseXnsName = str.toLowerCase()\n\n // Remove everything except letters, numbers, and dashes\n let formattedXnsName = lowercaseXnsName.replaceAll(/[^\\dA-Za-z-]+$/g, '')\n\n // Remove leading and trailing dashes\n if (options.maskStartEndHyphens) formattedXnsName = formattedXnsName.replaceAll(/^-+|-+$/g, '')\n\n // Filter out disallowed characters.\n return removeDisallowedCharacters(formattedXnsName)\n }\n\n async validate(): Promise<[boolean, string[]]> {\n const errorMessages: string[] = []\n const onErrorsInternal = (message: string[]) => errorMessages.push(...message)\n\n for (const validator of XnsNameSimpleValidators) {\n await validator(this.xnsName, onErrorsInternal)\n }\n\n if (errorMessages.length > 0) {\n return [false, errorMessages]\n }\n\n return [true, []]\n }\n}\n","export const MIN_DOMAIN_LENGTH = 3\nexport const MAX_DOMAIN_LENGTH = 128\n","import type { Payload, PayloadValidationFunction } from '@xyo-network/payload-model'\nimport type { DomainFields } from '@xyo-network/xns-record-payload-plugins'\n\nexport const getDomainReservedStringsValidator = (\n reservedStrings: string[],\n): PayloadValidationFunction<Payload<DomainFields>> => {\n return (payload: Payload<DomainFields>) => {\n const { domain } = payload\n // Check if in one of the reserved name lists\n if (reservedStrings.includes(domain)) {\n console.log('Reserved name')\n return false\n }\n return true\n }\n}\n\nexport const getDomainReservedFragmentsValidator = (\n reservedFragments: string[],\n): PayloadValidationFunction<Payload<DomainFields>> => {\n return (payload: Payload<DomainFields>) => {\n const { domain } = payload\n // Check if any of our fragments are in the name\n for (const reserved of reservedFragments) {\n if (domain.includes(reserved)) {\n console.log('Reserved name fragment')\n return false\n }\n }\n return true\n }\n}\n\nexport const getDomainReservedNamesValidator = (reservedNames: string[]): PayloadValidationFunction<Payload<DomainFields>> => {\n return (payload: Payload<DomainFields>) => {\n const { domain } = payload\n // Check if any of our fragments are in the name\n for (const reserved of reservedNames) {\n const parts = reserved.split(' ')\n if (domain === [parts[1], parts[0]].join('') || domain === [parts[0], parts[1]].join('')) {\n console.log('Reserved name')\n return false\n }\n }\n return true\n }\n}\n","import { isModuleName } from '@xyo-network/module-model'\nimport type { Payload } from '@xyo-network/payload-model'\nimport type { DomainFields } from '@xyo-network/xns-record-payload-plugins'\n\nimport { MAX_DOMAIN_LENGTH, MIN_DOMAIN_LENGTH } from '../Constants.ts'\n\nexport type PayloadValidationFunctionWithError<T extends Payload = Payload> = (payload: T, onErrors?: (message: string[]) => void) => boolean | Promise<boolean>\n\nexport const domainCasingValidator: PayloadValidationFunctionWithError<Payload<DomainFields>> = (\n payload: Payload<DomainFields>,\n onErrors?: (message: string[]) => void,\n) => {\n const { domain } = payload\n // Check if all lowercase\n if (domain.toLowerCase() !== domain) {\n onErrors?.(['name must be lowercase'])\n return false\n }\n return true\n}\n\nexport const domainModuleNameValidator: PayloadValidationFunctionWithError<Payload<DomainFields>> = (\n payload: Payload<DomainFields>,\n onErrors?: (message: string[]) => void,\n) => {\n const { domain } = payload\n\n // check if domain is a valid name\n if (!isModuleName(domain)) {\n onErrors?.([`Domain is not a valid module name: ${domain}`])\n return false\n }\n\n return true\n}\n\nexport const domainTldValidator: PayloadValidationFunctionWithError<Payload<DomainFields>> = (\n payload: Payload<DomainFields>,\n onErrors?: (message: string[]) => void,\n) => {\n const { tld } = payload\n const errorMessages: string[] = []\n\n // Check if all lowercase\n if (tld.toLowerCase() !== tld) {\n errorMessages.push('TLD must be lowercase')\n }\n // Check if supported TLDs\n if (tld !== 'xyo') {\n errorMessages.push('Only XYO TLD currently supported')\n }\n if (errorMessages.length > 0) {\n onErrors?.(errorMessages)\n return false\n }\n return true\n}\n\nexport const getDomainLengthValidator = (\n minNameLength = MIN_DOMAIN_LENGTH,\n maxLength = MAX_DOMAIN_LENGTH,\n): PayloadValidationFunctionWithError<Payload<DomainFields>> => {\n return (\n payload: Payload<DomainFields>,\n onErrors?: (message: string[]) => void,\n ) => {\n const { domain } = payload\n const errorMessages: string[] = []\n\n // Check if min length\n if (domain.length < minNameLength) {\n errorMessages.push(`name must be at least ${minNameLength} characters`)\n }\n\n if (domain.length > maxLength) {\n errorMessages.push(`name must be no more than ${maxLength} characters`)\n }\n\n if (errorMessages.length > 0) {\n onErrors?.(errorMessages)\n return false\n }\n\n return true\n }\n}\n\nexport const getDomainAllowedHyphensValidator = (\n options?: { end?: boolean; start?: boolean },\n): PayloadValidationFunctionWithError<Payload<DomainFields>> => {\n return (\n payload: Payload<DomainFields>,\n onErrors?: (message: string[]) => void,\n ) => {\n const { domain } = payload\n const { start, end } = options ?? {}\n const errorMessages: string[] = []\n\n if (!start && domain.startsWith('-')) {\n errorMessages.push('name cannot start with hyphen')\n }\n\n if (!end && domain.endsWith('-')) {\n errorMessages.push('name cannot end with hyphen')\n }\n\n if (errorMessages.length > 0) {\n onErrors?.(errorMessages)\n return false\n }\n return true\n }\n}\n\nexport const XnsNameSimpleValidators = [\n domainCasingValidator,\n domainModuleNameValidator,\n domainTldValidator,\n getDomainLengthValidator(),\n getDomainAllowedHyphensValidator(),\n]\n\nexport const XnsNameSimpleValidatorsWithErrors = (onErrors: (message: string[]) => void) => [\n domainCasingValidator,\n domainModuleNameValidator,\n domainTldValidator,\n getDomainLengthValidator(),\n getDomainAllowedHyphensValidator(),\n].map(validator => (payload: Payload<DomainFields>) => validator(payload, onErrors))\n","import { DisallowedModuleIdentifierCharacters } from '@xyo-network/module-model'\n\n/**\n * A set of all the disallowed characters in module identifiers\n */\nconst DISALLOWED_CHARACTERS = new Set(Object.keys(DisallowedModuleIdentifierCharacters))\n\n/**\n * Iterates over a string removing disallowed characters\n * @param xnsName The XNS name to remove disallowed characters from\n * @returns The XNS name with disallowed characters removed\n */\nexport const removeDisallowedCharacters = (xnsName: string): string => {\n // Create the initial result\n let result = ''\n // Iterate over each character in the XNS name\n for (const char of xnsName) {\n // If the character is not a disallowed character\n if (!DISALLOWED_CHARACTERS.has(char)) {\n // add it to the result\n result += char\n }\n }\n // Return the result which contains only allowed characters\n return result\n}\n"],"mappings":";AAAA,SAAS,cAAc;AACvB,SAA4B,sBAAsB;AAClD;AAAA,EAC0B;AAAA,EACxB;AAAA,OACK;AACP,SAAS,sBAAsB;AAI/B;AAAA,EAEgC;AAAA,EAA+B;AAAA,OACxD;AAOA,IAAM,uBAAuB,OAAO,aAAoD;AAC7F,MAAI,CAAC,SAAU,QAAO,CAAC;AACvB,QAAM,MAAM,SAET,OAAO,cAAc,EAErB,OAAO,mBAAmB,KAAK,CAAC;AACnC,MAAI,IAAI,WAAW,EAAG,QAAO,CAAC;AAC9B,QAAM,UAAU,MAAM,eAAe,aAAa,QAAQ;AAC1D,SAAO,IAAI,IAAgC,CAAC,OAAO;AACjD,UAAM,oBAAoB;AAAA,MACxB;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,IACF;AACA,QAAI,CAAC,kBAAmB;AACxB,UAAM,cAAc;AAAA,MAClB;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,IACF;AACA,QAAI,CAAC,YAAa;AAClB,WAAO,CAAC,IAAI,mBAAmB,WAAW;AAAA,EAC5C,CAAC,EAAE,OAAO,MAAM;AAClB;AAOA,IAAM,sBAAsB,CAAC,OAA8B;AACzD,SAAO,GAAG,gBAAgB,SAAS,6BAA6B,KAC3D,GAAG,gBAAgB,SAAS,uBAAuB;AAC1D;AAUA,IAAM,qCAAqC,CACzC,IACA,QACA,SACA,aAC4B;AAC5B,QAAM,cAAc,GAAG,gBAAgB,QAAQ,MAAM;AACrD,MAAI,gBAAgB,GAAI;AACxB,QAAM,OAAO,GAAG,eAAe,WAAW;AAC1C,SAAO,CAAC,QAAQ,IAAI,CAAC,EAAE,OAAO,MAAM,EAAE,KAAK,QAAQ;AACrD;;;AC5EA,SAAS,gBAAgB;AACzB,SAAS,cAAc;AAIvB,SAAS,oBAAoB;;;ACLtB,IAAM,oBAAoB;AAC1B,IAAM,oBAAoB;;;ACE1B,IAAM,oCAAoC,CAC/C,oBACqD;AACrD,SAAO,CAAC,YAAmC;AACzC,UAAM,EAAE,OAAO,IAAI;AAEnB,QAAI,gBAAgB,SAAS,MAAM,GAAG;AACpC,cAAQ,IAAI,eAAe;AAC3B,aAAO;AAAA,IACT;AACA,WAAO;AAAA,EACT;AACF;AAEO,IAAM,sCAAsC,CACjD,sBACqD;AACrD,SAAO,CAAC,YAAmC;AACzC,UAAM,EAAE,OAAO,IAAI;AAEnB,eAAW,YAAY,mBAAmB;AACxC,UAAI,OAAO,SAAS,QAAQ,GAAG;AAC7B,gBAAQ,IAAI,wBAAwB;AACpC,eAAO;AAAA,MACT;AAAA,IACF;AACA,WAAO;AAAA,EACT;AACF;AAEO,IAAM,kCAAkC,CAAC,kBAA8E;AAC5H,SAAO,CAAC,YAAmC;AACzC,UAAM,EAAE,OAAO,IAAI;AAEnB,eAAW,YAAY,eAAe;AACpC,YAAM,QAAQ,SAAS,MAAM,GAAG;AAChC,UAAI,WAAW,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,WAAW,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC,CAAC,EAAE,KAAK,EAAE,GAAG;AACxF,gBAAQ,IAAI,eAAe;AAC3B,eAAO;AAAA,MACT;AAAA,IACF;AACA,WAAO;AAAA,EACT;AACF;;;AC9CA,SAAS,oBAAoB;AAQtB,IAAM,wBAAmF,CAC9F,SACA,aACG;AACH,QAAM,EAAE,OAAO,IAAI;AAEnB,MAAI,OAAO,YAAY,MAAM,QAAQ;AACnC,eAAW,CAAC,wBAAwB,CAAC;AACrC,WAAO;AAAA,EACT;AACA,SAAO;AACT;AAEO,IAAM,4BAAuF,CAClG,SACA,aACG;AACH,QAAM,EAAE,OAAO,IAAI;AAGnB,MAAI,CAAC,aAAa,MAAM,GAAG;AACzB,eAAW,CAAC,sCAAsC,MAAM,EAAE,CAAC;AAC3D,WAAO;AAAA,EACT;AAEA,SAAO;AACT;AAEO,IAAM,qBAAgF,CAC3F,SACA,aACG;AACH,QAAM,EAAE,IAAI,IAAI;AAChB,QAAM,gBAA0B,CAAC;AAGjC,MAAI,IAAI,YAAY,MAAM,KAAK;AAC7B,kBAAc,KAAK,uBAAuB;AAAA,EAC5C;AAEA,MAAI,QAAQ,OAAO;AACjB,kBAAc,KAAK,kCAAkC;AAAA,EACvD;AACA,MAAI,cAAc,SAAS,GAAG;AAC5B,eAAW,aAAa;AACxB,WAAO;AAAA,EACT;AACA,SAAO;AACT;AAEO,IAAM,2BAA2B,CACtC,gBAAgB,mBAChB,YAAY,sBACkD;AAC9D,SAAO,CACL,SACA,aACG;AACH,UAAM,EAAE,OAAO,IAAI;AACnB,UAAM,gBAA0B,CAAC;AAGjC,QAAI,OAAO,SAAS,eAAe;AACjC,oBAAc,KAAK,yBAAyB,aAAa,aAAa;AAAA,IACxE;AAEA,QAAI,OAAO,SAAS,WAAW;AAC7B,oBAAc,KAAK,6BAA6B,SAAS,aAAa;AAAA,IACxE;AAEA,QAAI,cAAc,SAAS,GAAG;AAC5B,iBAAW,aAAa;AACxB,aAAO;AAAA,IACT;AAEA,WAAO;AAAA,EACT;AACF;AAEO,IAAM,mCAAmC,CAC9C,YAC8D;AAC9D,SAAO,CACL,SACA,aACG;AACH,UAAM,EAAE,OAAO,IAAI;AACnB,UAAM,EAAE,OAAO,IAAI,IAAI,WAAW,CAAC;AACnC,UAAM,gBAA0B,CAAC;AAEjC,QAAI,CAAC,SAAS,OAAO,WAAW,GAAG,GAAG;AACpC,oBAAc,KAAK,+BAA+B;AAAA,IACpD;AAEA,QAAI,CAAC,OAAO,OAAO,SAAS,GAAG,GAAG;AAChC,oBAAc,KAAK,6BAA6B;AAAA,IAClD;AAEA,QAAI,cAAc,SAAS,GAAG;AAC5B,iBAAW,aAAa;AACxB,aAAO;AAAA,IACT;AACA,WAAO;AAAA,EACT;AACF;AAEO,IAAM,0BAA0B;AAAA,EACrC;AAAA,EACA;AAAA,EACA;AAAA,EACA,yBAAyB;AAAA,EACzB,iCAAiC;AACnC;AAEO,IAAM,oCAAoC,CAAC,aAA0C;AAAA,EAC1F;AAAA,EACA;AAAA,EACA;AAAA,EACA,yBAAyB;AAAA,EACzB,iCAAiC;AACnC,EAAE,IAAI,eAAa,CAAC,YAAmC,UAAU,SAAS,QAAQ,CAAC;;;AChInF,SAAS,4CAA4C;AAKrD,IAAM,wBAAwB,IAAI,IAAI,OAAO,KAAK,oCAAoC,CAAC;AAOhF,IAAM,6BAA6B,CAAC,YAA4B;AAErE,MAAI,SAAS;AAEb,aAAW,QAAQ,SAAS;AAE1B,QAAI,CAAC,sBAAsB,IAAI,IAAI,GAAG;AAEpC,gBAAU;AAAA,IACZ;AAAA,EACF;AAEA,SAAO;AACT;;;AJdA,IAAM,qBAAqB,EAAE,qBAAqB,MAAM;AAEjD,IAAM,gBAAN,MAAM,eAAc;AAAA,EACzB,OAAO,YAAY,CAAC,MAAM;AAAA,EAElB;AAAA,EAEA,YAAY,SAAgC;AAClD,SAAK,WAAW;AAAA,EAClB;AAAA,EAEA,IAAI,SAAS;AACX,WAAO,SAAS,KAAK,QAAQ,QAAQ,MAAM,6BAA6B;AAAA,EAC1E;AAAA,EAEA,IAAI,OAAO;AACT,WAAO,GAAG,KAAK,MAAM,IAAI,KAAK,GAAG;AAAA,EACnC;AAAA,EAEA,IAAI,MAAM;AACR,WAAO,SAAS,KAAK,QAAQ,KAAK,MAAM,0BAA0B;AAAA,EACpE;AAAA,EAEA,IAAI,UAAU;AACZ,WAAO,SAAS,KAAK,UAAU,MAAM,+BAA+B;AAAA,EACtE;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,OAAO,YAAY,QAA0D;AAC3E,WAAO,IAAI,eAAc,MAAM;AAAA,EACjC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,OAAO,WAAW,SAAgC;AAChD,UAAM,QAAQ,QAAQ,MAAM,GAAG;AAC/B,aAAS,MAAM,WAAW,GAAG,MAAM,yBAAyB;AAE5D,UAAM,SAAS,MAAM,CAAC;AACtB,UAAM,MAAM,MAAM,CAAC;AACnB,WAAO,IAAI,eAAc;AAAA,MACvB,QAAQ;AAAA,MAAc;AAAA,MAAQ;AAAA,IAChC,CAAC;AAAA,EACH;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,OAAO,yBAAyB,QAAmC;AACjE,QAAI,OAAO,MAAM,EAAG,QAAO;AAC3B,UAAM,UAAU,eAAc,UAAU,KAAK,SAAO,QAAQ,SAAS,GAAG,CAAC,IAAI,SAAS;AACtF,WAAO,UAAU,YAAY;AAAA,EAC/B;AAAA,EAEA,aAAa,QAAQ,QAAiD;AACpE,UAAM,UAAU,MAAM,QAAQ,IAAI,wBAAwB,IAAI,eAAa,UAAU,MAAM,CAAC,CAAC;AAC7F,eAAW,UAAU,SAAS;AAC5B,UAAI,CAAC,OAAQ,QAAO;AAAA,IACtB;AACA,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,OAAO,KAAK,KAAa,UAA4C,oBAA4B;AAE/F,QAAI,IAAI,SAAS,mBAAmB;AAClC,YAAM,IAAI,MAAM,yBAAyB,IAAI,MAAM,wBAAwB,iBAAiB,EAAE;AAAA,IAChG;AAGA,UAAM,mBAAmB,IAAI,YAAY;AAGzC,QAAI,mBAAmB,iBAAiB,WAAW,mBAAmB,EAAE;AAGxE,QAAI,QAAQ,oBAAqB,oBAAmB,iBAAiB,WAAW,YAAY,EAAE;AAG9F,WAAO,2BAA2B,gBAAgB;AAAA,EACpD;AAAA,EAEA,MAAM,WAAyC;AAC7C,UAAM,gBAA0B,CAAC;AACjC,UAAM,mBAAmB,CAAC,YAAsB,cAAc,KAAK,GAAG,OAAO;AAE7E,eAAW,aAAa,yBAAyB;AAC/C,YAAM,UAAU,KAAK,SAAS,gBAAgB;AAAA,IAChD;AAEA,QAAI,cAAc,SAAS,GAAG;AAC5B,aAAO,CAAC,OAAO,aAAa;AAAA,IAC9B;AAEA,WAAO,CAAC,MAAM,CAAC,CAAC;AAAA,EAClB;AACF;","names":[]}
1
+ {"version":3,"sources":["../../src/estimate/lib/parseDomainEstimates.ts","../../src/validation/name/Name.ts","../../src/validation/validation/Constants.ts","../../src/validation/validation/factory/validators.ts","../../src/validation/validation/validators/validators.ts","../../src/validation/name/lib/removeDisallowedCharacters.ts"],"sourcesContent":["import { exists } from '@xylabs/exists'\nimport { type BoundWitness, isBoundWitness } from '@xyo-network/boundwitness-model'\nimport {\n type HashLeaseEstimate, HashLeaseEstimateSchema,\n isHashLeaseEstimate,\n} from '@xyo-network/diviner-hash-lease'\nimport { PayloadBuilder } from '@xyo-network/payload-builder'\nimport type { Payload, WithSources } from '@xyo-network/payload-model'\nimport {\n type DomainEstimate,\n type DomainRegistrationLease, DomainRegistrationLeaseSchema, isDomainRegistrationLease,\n} from '@xyo-network/xns-record-payload-plugins'\n\n/**\n * Parses a generic array of payloads into estimates\n * @param payloads An array of payloads\n * @returns Parsed estimates\n */\nexport const parseDomainEstimates = async (payloads?: Payload[]): Promise<DomainEstimate[]> => {\n if (!payloads) return []\n const bws = payloads\n // Find all bound witnesses\n .filter(isBoundWitness)\n // that have the required estimate payloads\n .filter(hasEstimatePayloads) ?? []\n if (bws.length === 0) return []\n const hashMap = await PayloadBuilder.toAllHashMap(payloads)\n return bws.map<DomainEstimate | undefined>((bw) => {\n const hashLeaseEstimate = getPayloadBySchemaFromBoundWitness<WithSources<HashLeaseEstimate>>(\n bw,\n HashLeaseEstimateSchema,\n hashMap,\n isHashLeaseEstimate,\n )\n if (!hashLeaseEstimate) return\n const domainLease = getPayloadBySchemaFromBoundWitness<DomainRegistrationLease>(\n bw,\n DomainRegistrationLeaseSchema,\n hashMap,\n isDomainRegistrationLease,\n )\n if (!domainLease) return\n return [bw, hashLeaseEstimate, domainLease]\n }).filter(exists)\n}\n\n/**\n * Tests if a BoundWitness has the required estimate payloads\n * @param bw The BoundWitness to check for estimate payloads\n * @returns True if the BoundWitness has the required estimate payloads, false otherwise\n */\nconst hasEstimatePayloads = (bw: BoundWitness): boolean => {\n return bw.payload_schemas.includes(DomainRegistrationLeaseSchema)\n && bw.payload_schemas.includes(HashLeaseEstimateSchema)\n}\n\n/**\n * Finds the first instance of a payload in a BoundWitness by schema\n * @param bw The BoundWitness to extract the payload from\n * @param schema The schema of the payload to extract\n * @param hashMap The hashmap of the payloads\n * @param identity An identity function to check if the payload is of the correct type\n * @returns The payload if it exists or undefined\n */\nconst getPayloadBySchemaFromBoundWitness = <T extends Payload = Payload>(\n bw: BoundWitness,\n schema: string,\n hashMap: Awaited<ReturnType<typeof PayloadBuilder.toHashMap>>,\n identity: (payload: Payload) => payload is T,\n): T | undefined => {\n const schemaIndex = bw.payload_schemas.indexOf(schema)\n if (schemaIndex === -1) return\n const hash = bw.payload_hashes[schemaIndex]\n return [hashMap[hash]].filter(exists).find(identity)\n}\n","import { assertEx } from '@xylabs/assert'\nimport { isHash } from '@xylabs/hex'\nimport type { Promisable } from '@xylabs/promise'\nimport type { Payload } from '@xyo-network/payload-model'\nimport type { DomainFields, TopLevelDomain } from '@xyo-network/xns-record-payload-plugins'\nimport { DomainSchema } from '@xyo-network/xns-record-payload-plugins'\n\nimport { MAX_DOMAIN_LENGTH, XnsNameSimpleValidators } from '../validation/index.ts'\nimport { removeDisallowedCharacters } from './lib/index.ts'\nimport type { ValidSourceTypes } from './types/index.ts'\n\nconst defaultMaskOptions = { maskStartEndHyphens: false }\n\nexport class XnsNameHelper {\n static ValidTLDs = ['.xyo'] as const\n\n private _xnsName: Payload<DomainFields>\n\n private constructor(xnsName: Payload<DomainFields>) {\n this._xnsName = xnsName\n }\n\n get domain() {\n return assertEx(this.xnsName.domain, () => 'domain not found in payload')\n }\n\n get name() {\n return `${this.domain}.${this.tld}`\n }\n\n get tld() {\n return assertEx(this.xnsName.tld, () => 'tld not found in payload')\n }\n\n get xnsName() {\n return assertEx(this._xnsName, () => 'XnsNameHelper xnsName not set')\n }\n\n /**\n * Create an XnsNameHelper from a domain payload\n * @param {Domain} domain\n * @returns Promise<XnsNameHelper>\n */\n static fromPayload(domain: Payload<DomainFields>): Promisable<XnsNameHelper> {\n return new XnsNameHelper(domain)\n }\n\n /**\n * Create an XnsNameHelper from a string\n * @param {string} xnsName\n * @returns Promise<XnsNameHelper>\n */\n static fromString(xnsName: string): XnsNameHelper {\n const parts = xnsName.split('.')\n assertEx(parts.length === 2, () => 'Unable to parse xnsName')\n\n const domain = parts[0]\n const tld = parts[1] as TopLevelDomain\n return new XnsNameHelper({\n schema: DomainSchema, domain, tld,\n })\n }\n\n /**\n * Determine if a string is a valid XNS name or hash\n * @param {string} source?\n * @returns ValidSourceTypes\n */\n static isPotentialXnsNameOrHash(source?: string): ValidSourceTypes {\n if (isHash(source)) return 'hash'\n const xnsName = XnsNameHelper.ValidTLDs.some(tld => source?.endsWith(tld)) ? source : null\n return xnsName ? 'xnsName' : null\n }\n\n static async isValid(domain: Payload<DomainFields>): Promise<boolean> {\n const results = await Promise.all(XnsNameSimpleValidators.map(validator => validator(domain)))\n for (const result of results) {\n if (!result) return false\n }\n return true\n }\n\n /**\n * Mask a string to be a valid XNS name\n * @param {string} str\n * @returns string\n */\n static mask(str: string, options: { maskStartEndHyphens: boolean } = defaultMaskOptions): string {\n // Check if the domain name is too long\n if (str.length > MAX_DOMAIN_LENGTH) {\n throw new Error(`Domain name too long: ${str.length} exceeds max length: ${MAX_DOMAIN_LENGTH}`)\n }\n\n // convert to lowercase\n const lowercaseXnsName = str.toLowerCase()\n\n // Remove everything except letters, numbers, and dashes\n let formattedXnsName = lowercaseXnsName.replaceAll(/[^\\dA-Za-z-]+$/g, '')\n\n // Remove leading and trailing dashes\n if (options.maskStartEndHyphens) formattedXnsName = formattedXnsName.replaceAll(/^-+|-+$/g, '')\n\n // Filter out disallowed characters.\n return removeDisallowedCharacters(formattedXnsName)\n }\n\n async validate(): Promise<[boolean, string[]]> {\n const errorMessages: string[] = []\n const onErrorsInternal = (message: string[]) => errorMessages.push(...message)\n\n for (const validator of XnsNameSimpleValidators) {\n await validator(this.xnsName, onErrorsInternal)\n }\n\n if (errorMessages.length > 0) {\n return [false, errorMessages]\n }\n\n return [true, []]\n }\n}\n","export const MIN_DOMAIN_LENGTH = 3\nexport const MAX_DOMAIN_LENGTH = 128\n","import type { Payload, PayloadValidationFunction } from '@xyo-network/payload-model'\nimport type { DomainFields } from '@xyo-network/xns-record-payload-plugins'\n\nexport const getDomainReservedStringsValidator = (\n reservedStrings: string[],\n): PayloadValidationFunction<Payload<DomainFields>> => {\n return (payload: Payload<DomainFields>) => {\n const { domain } = payload\n // Check if in one of the reserved name lists\n if (reservedStrings.includes(domain)) {\n console.log('Reserved name')\n return false\n }\n return true\n }\n}\n\nexport const getDomainReservedFragmentsValidator = (\n reservedFragments: string[],\n): PayloadValidationFunction<Payload<DomainFields>> => {\n return (payload: Payload<DomainFields>) => {\n const { domain } = payload\n // Check if any of our fragments are in the name\n for (const reserved of reservedFragments) {\n if (domain.includes(reserved)) {\n console.log('Reserved name fragment')\n return false\n }\n }\n return true\n }\n}\n\nexport const getDomainReservedNamesValidator = (reservedNames: string[]): PayloadValidationFunction<Payload<DomainFields>> => {\n return (payload: Payload<DomainFields>) => {\n const { domain } = payload\n // Check if any of our fragments are in the name\n for (const reserved of reservedNames) {\n const parts = reserved.split(' ')\n if (domain === [parts[1], parts[0]].join('') || domain === [parts[0], parts[1]].join('')) {\n console.log('Reserved name')\n return false\n }\n }\n return true\n }\n}\n","import { isModuleName } from '@xyo-network/module-model'\nimport type { Payload } from '@xyo-network/payload-model'\nimport type { DomainFields } from '@xyo-network/xns-record-payload-plugins'\n\nimport { MAX_DOMAIN_LENGTH, MIN_DOMAIN_LENGTH } from '../Constants.ts'\n\nexport type PayloadValidationFunctionWithError<T extends Payload = Payload> = (payload: T, onErrors?: (message: string[]) => void) => boolean | Promise<boolean>\n\nexport const domainCasingValidator: PayloadValidationFunctionWithError<Payload<DomainFields>> = (\n payload: Payload<DomainFields>,\n onErrors?: (message: string[]) => void,\n) => {\n const { domain } = payload\n // Check if all lowercase\n if (domain.toLowerCase() !== domain) {\n onErrors?.(['name must be lowercase'])\n return false\n }\n return true\n}\n\nexport const domainModuleNameValidator: PayloadValidationFunctionWithError<Payload<DomainFields>> = (\n payload: Payload<DomainFields>,\n onErrors?: (message: string[]) => void,\n) => {\n const { domain } = payload\n\n // check if domain is a valid name\n if (!isModuleName(domain)) {\n onErrors?.([`Domain is not a valid module name: ${domain}`])\n return false\n }\n\n return true\n}\n\nexport const domainTldValidator: PayloadValidationFunctionWithError<Payload<DomainFields>> = (\n payload: Payload<DomainFields>,\n onErrors?: (message: string[]) => void,\n) => {\n const { tld } = payload\n const errorMessages: string[] = []\n\n // Check if all lowercase\n if (tld.toLowerCase() !== tld) {\n errorMessages.push('TLD must be lowercase')\n }\n // Check if supported TLDs\n if (tld !== 'xyo') {\n errorMessages.push('Only XYO TLD currently supported')\n }\n if (errorMessages.length > 0) {\n onErrors?.(errorMessages)\n return false\n }\n return true\n}\n\nexport const getDomainLengthValidator = (\n minNameLength = MIN_DOMAIN_LENGTH,\n maxLength = MAX_DOMAIN_LENGTH,\n): PayloadValidationFunctionWithError<Payload<DomainFields>> => {\n return (\n payload: Payload<DomainFields>,\n onErrors?: (message: string[]) => void,\n ) => {\n const { domain } = payload\n const errorMessages: string[] = []\n\n // Check if min length\n if (domain.length < minNameLength) {\n errorMessages.push(`name must be at least ${minNameLength} characters`)\n }\n\n if (domain.length > maxLength) {\n errorMessages.push(`name must be no more than ${maxLength} characters`)\n }\n\n if (errorMessages.length > 0) {\n onErrors?.(errorMessages)\n return false\n }\n\n return true\n }\n}\n\nexport const getDomainAllowedHyphensValidator = (\n options?: { end?: boolean; start?: boolean },\n): PayloadValidationFunctionWithError<Payload<DomainFields>> => {\n return (\n payload: Payload<DomainFields>,\n onErrors?: (message: string[]) => void,\n ) => {\n const { domain } = payload\n const { start, end } = options ?? {}\n const errorMessages: string[] = []\n\n if (!start && domain.startsWith('-')) {\n errorMessages.push('name cannot start with hyphen')\n }\n\n if (!end && domain.endsWith('-')) {\n errorMessages.push('name cannot end with hyphen')\n }\n\n if (errorMessages.length > 0) {\n onErrors?.(errorMessages)\n return false\n }\n return true\n }\n}\n\nexport const XnsNameSimpleValidators = [\n domainCasingValidator,\n domainModuleNameValidator,\n domainTldValidator,\n getDomainLengthValidator(),\n getDomainAllowedHyphensValidator(),\n]\n\nexport const XnsNameSimpleValidatorsWithErrors = (onErrors: (message: string[]) => void) => [\n domainCasingValidator,\n domainModuleNameValidator,\n domainTldValidator,\n getDomainLengthValidator(),\n getDomainAllowedHyphensValidator(),\n].map(validator => (payload: Payload<DomainFields>) => validator(payload, onErrors))\n","import { DisallowedModuleIdentifierCharacters } from '@xyo-network/module-model'\n\n/**\n * A set of all the disallowed characters in module identifiers\n */\nconst DISALLOWED_CHARACTERS = new Set(Object.keys(DisallowedModuleIdentifierCharacters))\n\n/**\n * Iterates over a string removing disallowed characters\n * @param xnsName The XNS name to remove disallowed characters from\n * @returns The XNS name with disallowed characters removed\n */\nexport const removeDisallowedCharacters = (xnsName: string): string => {\n // Create the initial result\n let result = ''\n // Iterate over each character in the XNS name\n for (const char of xnsName) {\n // If the character is not a disallowed character\n if (!DISALLOWED_CHARACTERS.has(char)) {\n // add it to the result\n result += char\n }\n }\n // Return the result which contains only allowed characters\n return result\n}\n"],"mappings":";AAAA,SAAS,cAAc;AACvB,SAA4B,sBAAsB;AAClD;AAAA,EAC0B;AAAA,EACxB;AAAA,OACK;AACP,SAAS,sBAAsB;AAE/B;AAAA,EAEgC;AAAA,EAA+B;AAAA,OACxD;AAOA,IAAM,uBAAuB,OAAO,aAAoD;AAC7F,MAAI,CAAC,SAAU,QAAO,CAAC;AACvB,QAAM,MAAM,SAET,OAAO,cAAc,EAErB,OAAO,mBAAmB,KAAK,CAAC;AACnC,MAAI,IAAI,WAAW,EAAG,QAAO,CAAC;AAC9B,QAAM,UAAU,MAAM,eAAe,aAAa,QAAQ;AAC1D,SAAO,IAAI,IAAgC,CAAC,OAAO;AACjD,UAAM,oBAAoB;AAAA,MACxB;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,IACF;AACA,QAAI,CAAC,kBAAmB;AACxB,UAAM,cAAc;AAAA,MAClB;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,IACF;AACA,QAAI,CAAC,YAAa;AAClB,WAAO,CAAC,IAAI,mBAAmB,WAAW;AAAA,EAC5C,CAAC,EAAE,OAAO,MAAM;AAClB;AAOA,IAAM,sBAAsB,CAAC,OAA8B;AACzD,SAAO,GAAG,gBAAgB,SAAS,6BAA6B,KAC3D,GAAG,gBAAgB,SAAS,uBAAuB;AAC1D;AAUA,IAAM,qCAAqC,CACzC,IACA,QACA,SACA,aACkB;AAClB,QAAM,cAAc,GAAG,gBAAgB,QAAQ,MAAM;AACrD,MAAI,gBAAgB,GAAI;AACxB,QAAM,OAAO,GAAG,eAAe,WAAW;AAC1C,SAAO,CAAC,QAAQ,IAAI,CAAC,EAAE,OAAO,MAAM,EAAE,KAAK,QAAQ;AACrD;;;AC1EA,SAAS,gBAAgB;AACzB,SAAS,cAAc;AAIvB,SAAS,oBAAoB;;;ACLtB,IAAM,oBAAoB;AAC1B,IAAM,oBAAoB;;;ACE1B,IAAM,oCAAoC,CAC/C,oBACqD;AACrD,SAAO,CAAC,YAAmC;AACzC,UAAM,EAAE,OAAO,IAAI;AAEnB,QAAI,gBAAgB,SAAS,MAAM,GAAG;AACpC,cAAQ,IAAI,eAAe;AAC3B,aAAO;AAAA,IACT;AACA,WAAO;AAAA,EACT;AACF;AAEO,IAAM,sCAAsC,CACjD,sBACqD;AACrD,SAAO,CAAC,YAAmC;AACzC,UAAM,EAAE,OAAO,IAAI;AAEnB,eAAW,YAAY,mBAAmB;AACxC,UAAI,OAAO,SAAS,QAAQ,GAAG;AAC7B,gBAAQ,IAAI,wBAAwB;AACpC,eAAO;AAAA,MACT;AAAA,IACF;AACA,WAAO;AAAA,EACT;AACF;AAEO,IAAM,kCAAkC,CAAC,kBAA8E;AAC5H,SAAO,CAAC,YAAmC;AACzC,UAAM,EAAE,OAAO,IAAI;AAEnB,eAAW,YAAY,eAAe;AACpC,YAAM,QAAQ,SAAS,MAAM,GAAG;AAChC,UAAI,WAAW,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,WAAW,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC,CAAC,EAAE,KAAK,EAAE,GAAG;AACxF,gBAAQ,IAAI,eAAe;AAC3B,eAAO;AAAA,MACT;AAAA,IACF;AACA,WAAO;AAAA,EACT;AACF;;;AC9CA,SAAS,oBAAoB;AAQtB,IAAM,wBAAmF,CAC9F,SACA,aACG;AACH,QAAM,EAAE,OAAO,IAAI;AAEnB,MAAI,OAAO,YAAY,MAAM,QAAQ;AACnC,eAAW,CAAC,wBAAwB,CAAC;AACrC,WAAO;AAAA,EACT;AACA,SAAO;AACT;AAEO,IAAM,4BAAuF,CAClG,SACA,aACG;AACH,QAAM,EAAE,OAAO,IAAI;AAGnB,MAAI,CAAC,aAAa,MAAM,GAAG;AACzB,eAAW,CAAC,sCAAsC,MAAM,EAAE,CAAC;AAC3D,WAAO;AAAA,EACT;AAEA,SAAO;AACT;AAEO,IAAM,qBAAgF,CAC3F,SACA,aACG;AACH,QAAM,EAAE,IAAI,IAAI;AAChB,QAAM,gBAA0B,CAAC;AAGjC,MAAI,IAAI,YAAY,MAAM,KAAK;AAC7B,kBAAc,KAAK,uBAAuB;AAAA,EAC5C;AAEA,MAAI,QAAQ,OAAO;AACjB,kBAAc,KAAK,kCAAkC;AAAA,EACvD;AACA,MAAI,cAAc,SAAS,GAAG;AAC5B,eAAW,aAAa;AACxB,WAAO;AAAA,EACT;AACA,SAAO;AACT;AAEO,IAAM,2BAA2B,CACtC,gBAAgB,mBAChB,YAAY,sBACkD;AAC9D,SAAO,CACL,SACA,aACG;AACH,UAAM,EAAE,OAAO,IAAI;AACnB,UAAM,gBAA0B,CAAC;AAGjC,QAAI,OAAO,SAAS,eAAe;AACjC,oBAAc,KAAK,yBAAyB,aAAa,aAAa;AAAA,IACxE;AAEA,QAAI,OAAO,SAAS,WAAW;AAC7B,oBAAc,KAAK,6BAA6B,SAAS,aAAa;AAAA,IACxE;AAEA,QAAI,cAAc,SAAS,GAAG;AAC5B,iBAAW,aAAa;AACxB,aAAO;AAAA,IACT;AAEA,WAAO;AAAA,EACT;AACF;AAEO,IAAM,mCAAmC,CAC9C,YAC8D;AAC9D,SAAO,CACL,SACA,aACG;AACH,UAAM,EAAE,OAAO,IAAI;AACnB,UAAM,EAAE,OAAO,IAAI,IAAI,WAAW,CAAC;AACnC,UAAM,gBAA0B,CAAC;AAEjC,QAAI,CAAC,SAAS,OAAO,WAAW,GAAG,GAAG;AACpC,oBAAc,KAAK,+BAA+B;AAAA,IACpD;AAEA,QAAI,CAAC,OAAO,OAAO,SAAS,GAAG,GAAG;AAChC,oBAAc,KAAK,6BAA6B;AAAA,IAClD;AAEA,QAAI,cAAc,SAAS,GAAG;AAC5B,iBAAW,aAAa;AACxB,aAAO;AAAA,IACT;AACA,WAAO;AAAA,EACT;AACF;AAEO,IAAM,0BAA0B;AAAA,EACrC;AAAA,EACA;AAAA,EACA;AAAA,EACA,yBAAyB;AAAA,EACzB,iCAAiC;AACnC;AAEO,IAAM,oCAAoC,CAAC,aAA0C;AAAA,EAC1F;AAAA,EACA;AAAA,EACA;AAAA,EACA,yBAAyB;AAAA,EACzB,iCAAiC;AACnC,EAAE,IAAI,eAAa,CAAC,YAAmC,UAAU,SAAS,QAAQ,CAAC;;;AChInF,SAAS,4CAA4C;AAKrD,IAAM,wBAAwB,IAAI,IAAI,OAAO,KAAK,oCAAoC,CAAC;AAOhF,IAAM,6BAA6B,CAAC,YAA4B;AAErE,MAAI,SAAS;AAEb,aAAW,QAAQ,SAAS;AAE1B,QAAI,CAAC,sBAAsB,IAAI,IAAI,GAAG;AAEpC,gBAAU;AAAA,IACZ;AAAA,EACF;AAEA,SAAO;AACT;;;AJdA,IAAM,qBAAqB,EAAE,qBAAqB,MAAM;AAEjD,IAAM,gBAAN,MAAM,eAAc;AAAA,EACzB,OAAO,YAAY,CAAC,MAAM;AAAA,EAElB;AAAA,EAEA,YAAY,SAAgC;AAClD,SAAK,WAAW;AAAA,EAClB;AAAA,EAEA,IAAI,SAAS;AACX,WAAO,SAAS,KAAK,QAAQ,QAAQ,MAAM,6BAA6B;AAAA,EAC1E;AAAA,EAEA,IAAI,OAAO;AACT,WAAO,GAAG,KAAK,MAAM,IAAI,KAAK,GAAG;AAAA,EACnC;AAAA,EAEA,IAAI,MAAM;AACR,WAAO,SAAS,KAAK,QAAQ,KAAK,MAAM,0BAA0B;AAAA,EACpE;AAAA,EAEA,IAAI,UAAU;AACZ,WAAO,SAAS,KAAK,UAAU,MAAM,+BAA+B;AAAA,EACtE;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,OAAO,YAAY,QAA0D;AAC3E,WAAO,IAAI,eAAc,MAAM;AAAA,EACjC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,OAAO,WAAW,SAAgC;AAChD,UAAM,QAAQ,QAAQ,MAAM,GAAG;AAC/B,aAAS,MAAM,WAAW,GAAG,MAAM,yBAAyB;AAE5D,UAAM,SAAS,MAAM,CAAC;AACtB,UAAM,MAAM,MAAM,CAAC;AACnB,WAAO,IAAI,eAAc;AAAA,MACvB,QAAQ;AAAA,MAAc;AAAA,MAAQ;AAAA,IAChC,CAAC;AAAA,EACH;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,OAAO,yBAAyB,QAAmC;AACjE,QAAI,OAAO,MAAM,EAAG,QAAO;AAC3B,UAAM,UAAU,eAAc,UAAU,KAAK,SAAO,QAAQ,SAAS,GAAG,CAAC,IAAI,SAAS;AACtF,WAAO,UAAU,YAAY;AAAA,EAC/B;AAAA,EAEA,aAAa,QAAQ,QAAiD;AACpE,UAAM,UAAU,MAAM,QAAQ,IAAI,wBAAwB,IAAI,eAAa,UAAU,MAAM,CAAC,CAAC;AAC7F,eAAW,UAAU,SAAS;AAC5B,UAAI,CAAC,OAAQ,QAAO;AAAA,IACtB;AACA,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,OAAO,KAAK,KAAa,UAA4C,oBAA4B;AAE/F,QAAI,IAAI,SAAS,mBAAmB;AAClC,YAAM,IAAI,MAAM,yBAAyB,IAAI,MAAM,wBAAwB,iBAAiB,EAAE;AAAA,IAChG;AAGA,UAAM,mBAAmB,IAAI,YAAY;AAGzC,QAAI,mBAAmB,iBAAiB,WAAW,mBAAmB,EAAE;AAGxE,QAAI,QAAQ,oBAAqB,oBAAmB,iBAAiB,WAAW,YAAY,EAAE;AAG9F,WAAO,2BAA2B,gBAAgB;AAAA,EACpD;AAAA,EAEA,MAAM,WAAyC;AAC7C,UAAM,gBAA0B,CAAC;AACjC,UAAM,mBAAmB,CAAC,YAAsB,cAAc,KAAK,GAAG,OAAO;AAE7E,eAAW,aAAa,yBAAyB;AAC/C,YAAM,UAAU,KAAK,SAAS,gBAAgB;AAAA,IAChD;AAEA,QAAI,cAAc,SAAS,GAAG;AAC5B,aAAO,CAAC,OAAO,aAAa;AAAA,IAC9B;AAEA,WAAO,CAAC,MAAM,CAAC,CAAC;AAAA,EAClB;AACF;","names":[]}
@@ -12,10 +12,30 @@ export declare class XnsNameHelper {
12
12
  get xnsName(): import("@xyo-network/payload-model").SchemaFields & import("@xyo-network/payload-model").PayloadFields & DomainFields & {
13
13
  schema: import("@xyo-network/payload-model").Schema;
14
14
  };
15
+ /**
16
+ * Create an XnsNameHelper from a domain payload
17
+ * @param {Domain} domain
18
+ * @returns Promise<XnsNameHelper>
19
+ */
15
20
  static fromPayload(domain: Payload<DomainFields>): Promisable<XnsNameHelper>;
21
+ /**
22
+ * Create an XnsNameHelper from a string
23
+ * @param {string} xnsName
24
+ * @returns Promise<XnsNameHelper>
25
+ */
16
26
  static fromString(xnsName: string): XnsNameHelper;
27
+ /**
28
+ * Determine if a string is a valid XNS name or hash
29
+ * @param {string} source?
30
+ * @returns ValidSourceTypes
31
+ */
17
32
  static isPotentialXnsNameOrHash(source?: string): ValidSourceTypes;
18
33
  static isValid(domain: Payload<DomainFields>): Promise<boolean>;
34
+ /**
35
+ * Mask a string to be a valid XNS name
36
+ * @param {string} str
37
+ * @returns string
38
+ */
19
39
  static mask(str: string, options?: {
20
40
  maskStartEndHyphens: boolean;
21
41
  }): string;
@@ -1 +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"}
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;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"}
@@ -1,2 +1,7 @@
1
+ /**
2
+ * Iterates over a string removing disallowed characters
3
+ * @param xnsName The XNS name to remove disallowed characters from
4
+ * @returns The XNS name with disallowed characters removed
5
+ */
1
6
  export declare const removeDisallowedCharacters: (xnsName: string) => string;
2
7
  //# sourceMappingURL=removeDisallowedCharacters.d.ts.map
@@ -1 +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"}
1
+ {"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"}
@@ -1,4 +1,9 @@
1
1
  import type { Payload } from '@xyo-network/payload-model';
2
2
  import { type DomainEstimate } from '@xyo-network/xns-record-payload-plugins';
3
+ /**
4
+ * Parses a generic array of payloads into estimates
5
+ * @param payloads An array of payloads
6
+ * @returns Parsed estimates
7
+ */
3
8
  export declare const parseDomainEstimates: (payloads?: Payload[]) => Promise<DomainEstimate[]>;
4
9
  //# sourceMappingURL=parseDomainEstimates.d.ts.map
@@ -1 +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"}
1
+ {"version":3,"file":"parseDomainEstimates.d.ts","sourceRoot":"","sources":["../../../../src/estimate/lib/parseDomainEstimates.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,EAAE,OAAO,EAAe,MAAM,4BAA4B,CAAA;AACtE,OAAO,EACL,KAAK,cAAc,EAEpB,MAAM,yCAAyC,CAAA;AAEhD;;;;GAIG;AACH,eAAO,MAAM,oBAAoB,cAAqB,OAAO,EAAE,KAAG,OAAO,CAAC,cAAc,EAAE,CA0BzF,CAAA"}
@@ -3,12 +3,12 @@ import { exists } from "@xylabs/exists";
3
3
  import { isBoundWitness } from "@xyo-network/boundwitness-model";
4
4
  import {
5
5
  HashLeaseEstimateSchema,
6
- isHashLeaseEstimateWithMeta
6
+ isHashLeaseEstimate
7
7
  } from "@xyo-network/diviner-hash-lease";
8
8
  import { PayloadBuilder } from "@xyo-network/payload-builder";
9
9
  import {
10
10
  DomainRegistrationLeaseSchema,
11
- isDomainRegistrationLeaseWithMeta
11
+ isDomainRegistrationLease
12
12
  } from "@xyo-network/xns-record-payload-plugins";
13
13
  var parseDomainEstimates = async (payloads) => {
14
14
  if (!payloads) return [];
@@ -20,14 +20,14 @@ var parseDomainEstimates = async (payloads) => {
20
20
  bw,
21
21
  HashLeaseEstimateSchema,
22
22
  hashMap,
23
- isHashLeaseEstimateWithMeta
23
+ isHashLeaseEstimate
24
24
  );
25
25
  if (!hashLeaseEstimate) return;
26
26
  const domainLease = getPayloadBySchemaFromBoundWitness(
27
27
  bw,
28
28
  DomainRegistrationLeaseSchema,
29
29
  hashMap,
30
- isDomainRegistrationLeaseWithMeta
30
+ isDomainRegistrationLease
31
31
  );
32
32
  if (!domainLease) return;
33
33
  return [bw, hashLeaseEstimate, domainLease];
@@ -1 +1 @@
1
- {"version":3,"sources":["../../src/estimate/lib/parseDomainEstimates.ts","../../src/validation/name/Name.ts","../../src/validation/validation/Constants.ts","../../src/validation/validation/factory/validators.ts","../../src/validation/validation/validators/validators.ts","../../src/validation/name/lib/removeDisallowedCharacters.ts"],"sourcesContent":["import { exists } from '@xylabs/exists'\nimport { type BoundWitness, isBoundWitness } from '@xyo-network/boundwitness-model'\nimport {\n type HashLeaseEstimate, HashLeaseEstimateSchema,\n isHashLeaseEstimateWithMeta,\n} from '@xyo-network/diviner-hash-lease'\nimport { PayloadBuilder } from '@xyo-network/payload-builder'\nimport type {\n Payload, WithMeta, WithSources,\n} from '@xyo-network/payload-model'\nimport {\n type DomainEstimate,\n type DomainRegistrationLease, DomainRegistrationLeaseSchema, isDomainRegistrationLeaseWithMeta,\n} from '@xyo-network/xns-record-payload-plugins'\n\n/**\n * Parses a generic array of payloads into estimates\n * @param payloads An array of payloads\n * @returns Parsed estimates\n */\nexport const parseDomainEstimates = async (payloads?: Payload[]): Promise<DomainEstimate[]> => {\n if (!payloads) return []\n const bws = payloads\n // Find all bound witnesses\n .filter(isBoundWitness)\n // that have the required estimate payloads\n .filter(hasEstimatePayloads) ?? []\n if (bws.length === 0) return []\n const hashMap = await PayloadBuilder.toAllHashMap(payloads)\n return bws.map<DomainEstimate | undefined>((bw) => {\n const hashLeaseEstimate = getPayloadBySchemaFromBoundWitness<WithSources<HashLeaseEstimate>>(\n bw,\n HashLeaseEstimateSchema,\n hashMap,\n isHashLeaseEstimateWithMeta,\n )\n if (!hashLeaseEstimate) return\n const domainLease = getPayloadBySchemaFromBoundWitness<DomainRegistrationLease>(\n bw,\n DomainRegistrationLeaseSchema,\n hashMap,\n isDomainRegistrationLeaseWithMeta,\n )\n if (!domainLease) return\n return [bw, hashLeaseEstimate, domainLease]\n }).filter(exists)\n}\n\n/**\n * Tests if a BoundWitness has the required estimate payloads\n * @param bw The BoundWitness to check for estimate payloads\n * @returns True if the BoundWitness has the required estimate payloads, false otherwise\n */\nconst hasEstimatePayloads = (bw: BoundWitness): boolean => {\n return bw.payload_schemas.includes(DomainRegistrationLeaseSchema)\n && bw.payload_schemas.includes(HashLeaseEstimateSchema)\n}\n\n/**\n * Finds the first instance of a payload in a BoundWitness by schema\n * @param bw The BoundWitness to extract the payload from\n * @param schema The schema of the payload to extract\n * @param hashMap The hashmap of the payloads\n * @param identity An identity function to check if the payload is of the correct type\n * @returns The payload if it exists or undefined\n */\nconst getPayloadBySchemaFromBoundWitness = <T extends Payload = Payload>(\n bw: BoundWitness,\n schema: string,\n hashMap: Awaited<ReturnType<typeof PayloadBuilder.toHashMap>>,\n identity: (payload: Payload) => payload is WithMeta<T>,\n): WithMeta<T> | undefined => {\n const schemaIndex = bw.payload_schemas.indexOf(schema)\n if (schemaIndex === -1) return\n const hash = bw.payload_hashes[schemaIndex]\n return [hashMap[hash]].filter(exists).find(identity)\n}\n","import { assertEx } from '@xylabs/assert'\nimport { isHash } from '@xylabs/hex'\nimport type { Promisable } from '@xylabs/promise'\nimport type { Payload } from '@xyo-network/payload-model'\nimport type { DomainFields, TopLevelDomain } from '@xyo-network/xns-record-payload-plugins'\nimport { DomainSchema } from '@xyo-network/xns-record-payload-plugins'\n\nimport { MAX_DOMAIN_LENGTH, XnsNameSimpleValidators } from '../validation/index.ts'\nimport { removeDisallowedCharacters } from './lib/index.ts'\nimport type { ValidSourceTypes } from './types/index.ts'\n\nconst defaultMaskOptions = { maskStartEndHyphens: false }\n\nexport class XnsNameHelper {\n static ValidTLDs = ['.xyo'] as const\n\n private _xnsName: Payload<DomainFields>\n\n private constructor(xnsName: Payload<DomainFields>) {\n this._xnsName = xnsName\n }\n\n get domain() {\n return assertEx(this.xnsName.domain, () => 'domain not found in payload')\n }\n\n get name() {\n return `${this.domain}.${this.tld}`\n }\n\n get tld() {\n return assertEx(this.xnsName.tld, () => 'tld not found in payload')\n }\n\n get xnsName() {\n return assertEx(this._xnsName, () => 'XnsNameHelper xnsName not set')\n }\n\n /**\n * Create an XnsNameHelper from a domain payload\n * @param {Domain} domain\n * @returns Promise<XnsNameHelper>\n */\n static fromPayload(domain: Payload<DomainFields>): Promisable<XnsNameHelper> {\n return new XnsNameHelper(domain)\n }\n\n /**\n * Create an XnsNameHelper from a string\n * @param {string} xnsName\n * @returns Promise<XnsNameHelper>\n */\n static fromString(xnsName: string): XnsNameHelper {\n const parts = xnsName.split('.')\n assertEx(parts.length === 2, () => 'Unable to parse xnsName')\n\n const domain = parts[0]\n const tld = parts[1] as TopLevelDomain\n return new XnsNameHelper({\n schema: DomainSchema, domain, tld,\n })\n }\n\n /**\n * Determine if a string is a valid XNS name or hash\n * @param {string} source?\n * @returns ValidSourceTypes\n */\n static isPotentialXnsNameOrHash(source?: string): ValidSourceTypes {\n if (isHash(source)) return 'hash'\n const xnsName = XnsNameHelper.ValidTLDs.some(tld => source?.endsWith(tld)) ? source : null\n return xnsName ? 'xnsName' : null\n }\n\n static async isValid(domain: Payload<DomainFields>): Promise<boolean> {\n const results = await Promise.all(XnsNameSimpleValidators.map(validator => validator(domain)))\n for (const result of results) {\n if (!result) return false\n }\n return true\n }\n\n /**\n * Mask a string to be a valid XNS name\n * @param {string} str\n * @returns string\n */\n static mask(str: string, options: { maskStartEndHyphens: boolean } = defaultMaskOptions): string {\n // Check if the domain name is too long\n if (str.length > MAX_DOMAIN_LENGTH) {\n throw new Error(`Domain name too long: ${str.length} exceeds max length: ${MAX_DOMAIN_LENGTH}`)\n }\n\n // convert to lowercase\n const lowercaseXnsName = str.toLowerCase()\n\n // Remove everything except letters, numbers, and dashes\n let formattedXnsName = lowercaseXnsName.replaceAll(/[^\\dA-Za-z-]+$/g, '')\n\n // Remove leading and trailing dashes\n if (options.maskStartEndHyphens) formattedXnsName = formattedXnsName.replaceAll(/^-+|-+$/g, '')\n\n // Filter out disallowed characters.\n return removeDisallowedCharacters(formattedXnsName)\n }\n\n async validate(): Promise<[boolean, string[]]> {\n const errorMessages: string[] = []\n const onErrorsInternal = (message: string[]) => errorMessages.push(...message)\n\n for (const validator of XnsNameSimpleValidators) {\n await validator(this.xnsName, onErrorsInternal)\n }\n\n if (errorMessages.length > 0) {\n return [false, errorMessages]\n }\n\n return [true, []]\n }\n}\n","export const MIN_DOMAIN_LENGTH = 3\nexport const MAX_DOMAIN_LENGTH = 128\n","import type { Payload, PayloadValidationFunction } from '@xyo-network/payload-model'\nimport type { DomainFields } from '@xyo-network/xns-record-payload-plugins'\n\nexport const getDomainReservedStringsValidator = (\n reservedStrings: string[],\n): PayloadValidationFunction<Payload<DomainFields>> => {\n return (payload: Payload<DomainFields>) => {\n const { domain } = payload\n // Check if in one of the reserved name lists\n if (reservedStrings.includes(domain)) {\n console.log('Reserved name')\n return false\n }\n return true\n }\n}\n\nexport const getDomainReservedFragmentsValidator = (\n reservedFragments: string[],\n): PayloadValidationFunction<Payload<DomainFields>> => {\n return (payload: Payload<DomainFields>) => {\n const { domain } = payload\n // Check if any of our fragments are in the name\n for (const reserved of reservedFragments) {\n if (domain.includes(reserved)) {\n console.log('Reserved name fragment')\n return false\n }\n }\n return true\n }\n}\n\nexport const getDomainReservedNamesValidator = (reservedNames: string[]): PayloadValidationFunction<Payload<DomainFields>> => {\n return (payload: Payload<DomainFields>) => {\n const { domain } = payload\n // Check if any of our fragments are in the name\n for (const reserved of reservedNames) {\n const parts = reserved.split(' ')\n if (domain === [parts[1], parts[0]].join('') || domain === [parts[0], parts[1]].join('')) {\n console.log('Reserved name')\n return false\n }\n }\n return true\n }\n}\n","import { isModuleName } from '@xyo-network/module-model'\nimport type { Payload } from '@xyo-network/payload-model'\nimport type { DomainFields } from '@xyo-network/xns-record-payload-plugins'\n\nimport { MAX_DOMAIN_LENGTH, MIN_DOMAIN_LENGTH } from '../Constants.ts'\n\nexport type PayloadValidationFunctionWithError<T extends Payload = Payload> = (payload: T, onErrors?: (message: string[]) => void) => boolean | Promise<boolean>\n\nexport const domainCasingValidator: PayloadValidationFunctionWithError<Payload<DomainFields>> = (\n payload: Payload<DomainFields>,\n onErrors?: (message: string[]) => void,\n) => {\n const { domain } = payload\n // Check if all lowercase\n if (domain.toLowerCase() !== domain) {\n onErrors?.(['name must be lowercase'])\n return false\n }\n return true\n}\n\nexport const domainModuleNameValidator: PayloadValidationFunctionWithError<Payload<DomainFields>> = (\n payload: Payload<DomainFields>,\n onErrors?: (message: string[]) => void,\n) => {\n const { domain } = payload\n\n // check if domain is a valid name\n if (!isModuleName(domain)) {\n onErrors?.([`Domain is not a valid module name: ${domain}`])\n return false\n }\n\n return true\n}\n\nexport const domainTldValidator: PayloadValidationFunctionWithError<Payload<DomainFields>> = (\n payload: Payload<DomainFields>,\n onErrors?: (message: string[]) => void,\n) => {\n const { tld } = payload\n const errorMessages: string[] = []\n\n // Check if all lowercase\n if (tld.toLowerCase() !== tld) {\n errorMessages.push('TLD must be lowercase')\n }\n // Check if supported TLDs\n if (tld !== 'xyo') {\n errorMessages.push('Only XYO TLD currently supported')\n }\n if (errorMessages.length > 0) {\n onErrors?.(errorMessages)\n return false\n }\n return true\n}\n\nexport const getDomainLengthValidator = (\n minNameLength = MIN_DOMAIN_LENGTH,\n maxLength = MAX_DOMAIN_LENGTH,\n): PayloadValidationFunctionWithError<Payload<DomainFields>> => {\n return (\n payload: Payload<DomainFields>,\n onErrors?: (message: string[]) => void,\n ) => {\n const { domain } = payload\n const errorMessages: string[] = []\n\n // Check if min length\n if (domain.length < minNameLength) {\n errorMessages.push(`name must be at least ${minNameLength} characters`)\n }\n\n if (domain.length > maxLength) {\n errorMessages.push(`name must be no more than ${maxLength} characters`)\n }\n\n if (errorMessages.length > 0) {\n onErrors?.(errorMessages)\n return false\n }\n\n return true\n }\n}\n\nexport const getDomainAllowedHyphensValidator = (\n options?: { end?: boolean; start?: boolean },\n): PayloadValidationFunctionWithError<Payload<DomainFields>> => {\n return (\n payload: Payload<DomainFields>,\n onErrors?: (message: string[]) => void,\n ) => {\n const { domain } = payload\n const { start, end } = options ?? {}\n const errorMessages: string[] = []\n\n if (!start && domain.startsWith('-')) {\n errorMessages.push('name cannot start with hyphen')\n }\n\n if (!end && domain.endsWith('-')) {\n errorMessages.push('name cannot end with hyphen')\n }\n\n if (errorMessages.length > 0) {\n onErrors?.(errorMessages)\n return false\n }\n return true\n }\n}\n\nexport const XnsNameSimpleValidators = [\n domainCasingValidator,\n domainModuleNameValidator,\n domainTldValidator,\n getDomainLengthValidator(),\n getDomainAllowedHyphensValidator(),\n]\n\nexport const XnsNameSimpleValidatorsWithErrors = (onErrors: (message: string[]) => void) => [\n domainCasingValidator,\n domainModuleNameValidator,\n domainTldValidator,\n getDomainLengthValidator(),\n getDomainAllowedHyphensValidator(),\n].map(validator => (payload: Payload<DomainFields>) => validator(payload, onErrors))\n","import { DisallowedModuleIdentifierCharacters } from '@xyo-network/module-model'\n\n/**\n * A set of all the disallowed characters in module identifiers\n */\nconst DISALLOWED_CHARACTERS = new Set(Object.keys(DisallowedModuleIdentifierCharacters))\n\n/**\n * Iterates over a string removing disallowed characters\n * @param xnsName The XNS name to remove disallowed characters from\n * @returns The XNS name with disallowed characters removed\n */\nexport const removeDisallowedCharacters = (xnsName: string): string => {\n // Create the initial result\n let result = ''\n // Iterate over each character in the XNS name\n for (const char of xnsName) {\n // If the character is not a disallowed character\n if (!DISALLOWED_CHARACTERS.has(char)) {\n // add it to the result\n result += char\n }\n }\n // Return the result which contains only allowed characters\n return result\n}\n"],"mappings":";AAAA,SAAS,cAAc;AACvB,SAA4B,sBAAsB;AAClD;AAAA,EAC0B;AAAA,EACxB;AAAA,OACK;AACP,SAAS,sBAAsB;AAI/B;AAAA,EAEgC;AAAA,EAA+B;AAAA,OACxD;AAOA,IAAM,uBAAuB,OAAO,aAAoD;AAC7F,MAAI,CAAC,SAAU,QAAO,CAAC;AACvB,QAAM,MAAM,SAET,OAAO,cAAc,EAErB,OAAO,mBAAmB,KAAK,CAAC;AACnC,MAAI,IAAI,WAAW,EAAG,QAAO,CAAC;AAC9B,QAAM,UAAU,MAAM,eAAe,aAAa,QAAQ;AAC1D,SAAO,IAAI,IAAgC,CAAC,OAAO;AACjD,UAAM,oBAAoB;AAAA,MACxB;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,IACF;AACA,QAAI,CAAC,kBAAmB;AACxB,UAAM,cAAc;AAAA,MAClB;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,IACF;AACA,QAAI,CAAC,YAAa;AAClB,WAAO,CAAC,IAAI,mBAAmB,WAAW;AAAA,EAC5C,CAAC,EAAE,OAAO,MAAM;AAClB;AAOA,IAAM,sBAAsB,CAAC,OAA8B;AACzD,SAAO,GAAG,gBAAgB,SAAS,6BAA6B,KAC3D,GAAG,gBAAgB,SAAS,uBAAuB;AAC1D;AAUA,IAAM,qCAAqC,CACzC,IACA,QACA,SACA,aAC4B;AAC5B,QAAM,cAAc,GAAG,gBAAgB,QAAQ,MAAM;AACrD,MAAI,gBAAgB,GAAI;AACxB,QAAM,OAAO,GAAG,eAAe,WAAW;AAC1C,SAAO,CAAC,QAAQ,IAAI,CAAC,EAAE,OAAO,MAAM,EAAE,KAAK,QAAQ;AACrD;;;AC5EA,SAAS,gBAAgB;AACzB,SAAS,cAAc;AAIvB,SAAS,oBAAoB;;;ACLtB,IAAM,oBAAoB;AAC1B,IAAM,oBAAoB;;;ACE1B,IAAM,oCAAoC,CAC/C,oBACqD;AACrD,SAAO,CAAC,YAAmC;AACzC,UAAM,EAAE,OAAO,IAAI;AAEnB,QAAI,gBAAgB,SAAS,MAAM,GAAG;AACpC,cAAQ,IAAI,eAAe;AAC3B,aAAO;AAAA,IACT;AACA,WAAO;AAAA,EACT;AACF;AAEO,IAAM,sCAAsC,CACjD,sBACqD;AACrD,SAAO,CAAC,YAAmC;AACzC,UAAM,EAAE,OAAO,IAAI;AAEnB,eAAW,YAAY,mBAAmB;AACxC,UAAI,OAAO,SAAS,QAAQ,GAAG;AAC7B,gBAAQ,IAAI,wBAAwB;AACpC,eAAO;AAAA,MACT;AAAA,IACF;AACA,WAAO;AAAA,EACT;AACF;AAEO,IAAM,kCAAkC,CAAC,kBAA8E;AAC5H,SAAO,CAAC,YAAmC;AACzC,UAAM,EAAE,OAAO,IAAI;AAEnB,eAAW,YAAY,eAAe;AACpC,YAAM,QAAQ,SAAS,MAAM,GAAG;AAChC,UAAI,WAAW,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,WAAW,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC,CAAC,EAAE,KAAK,EAAE,GAAG;AACxF,gBAAQ,IAAI,eAAe;AAC3B,eAAO;AAAA,MACT;AAAA,IACF;AACA,WAAO;AAAA,EACT;AACF;;;AC9CA,SAAS,oBAAoB;AAQtB,IAAM,wBAAmF,CAC9F,SACA,aACG;AACH,QAAM,EAAE,OAAO,IAAI;AAEnB,MAAI,OAAO,YAAY,MAAM,QAAQ;AACnC,eAAW,CAAC,wBAAwB,CAAC;AACrC,WAAO;AAAA,EACT;AACA,SAAO;AACT;AAEO,IAAM,4BAAuF,CAClG,SACA,aACG;AACH,QAAM,EAAE,OAAO,IAAI;AAGnB,MAAI,CAAC,aAAa,MAAM,GAAG;AACzB,eAAW,CAAC,sCAAsC,MAAM,EAAE,CAAC;AAC3D,WAAO;AAAA,EACT;AAEA,SAAO;AACT;AAEO,IAAM,qBAAgF,CAC3F,SACA,aACG;AACH,QAAM,EAAE,IAAI,IAAI;AAChB,QAAM,gBAA0B,CAAC;AAGjC,MAAI,IAAI,YAAY,MAAM,KAAK;AAC7B,kBAAc,KAAK,uBAAuB;AAAA,EAC5C;AAEA,MAAI,QAAQ,OAAO;AACjB,kBAAc,KAAK,kCAAkC;AAAA,EACvD;AACA,MAAI,cAAc,SAAS,GAAG;AAC5B,eAAW,aAAa;AACxB,WAAO;AAAA,EACT;AACA,SAAO;AACT;AAEO,IAAM,2BAA2B,CACtC,gBAAgB,mBAChB,YAAY,sBACkD;AAC9D,SAAO,CACL,SACA,aACG;AACH,UAAM,EAAE,OAAO,IAAI;AACnB,UAAM,gBAA0B,CAAC;AAGjC,QAAI,OAAO,SAAS,eAAe;AACjC,oBAAc,KAAK,yBAAyB,aAAa,aAAa;AAAA,IACxE;AAEA,QAAI,OAAO,SAAS,WAAW;AAC7B,oBAAc,KAAK,6BAA6B,SAAS,aAAa;AAAA,IACxE;AAEA,QAAI,cAAc,SAAS,GAAG;AAC5B,iBAAW,aAAa;AACxB,aAAO;AAAA,IACT;AAEA,WAAO;AAAA,EACT;AACF;AAEO,IAAM,mCAAmC,CAC9C,YAC8D;AAC9D,SAAO,CACL,SACA,aACG;AACH,UAAM,EAAE,OAAO,IAAI;AACnB,UAAM,EAAE,OAAO,IAAI,IAAI,WAAW,CAAC;AACnC,UAAM,gBAA0B,CAAC;AAEjC,QAAI,CAAC,SAAS,OAAO,WAAW,GAAG,GAAG;AACpC,oBAAc,KAAK,+BAA+B;AAAA,IACpD;AAEA,QAAI,CAAC,OAAO,OAAO,SAAS,GAAG,GAAG;AAChC,oBAAc,KAAK,6BAA6B;AAAA,IAClD;AAEA,QAAI,cAAc,SAAS,GAAG;AAC5B,iBAAW,aAAa;AACxB,aAAO;AAAA,IACT;AACA,WAAO;AAAA,EACT;AACF;AAEO,IAAM,0BAA0B;AAAA,EACrC;AAAA,EACA;AAAA,EACA;AAAA,EACA,yBAAyB;AAAA,EACzB,iCAAiC;AACnC;AAEO,IAAM,oCAAoC,CAAC,aAA0C;AAAA,EAC1F;AAAA,EACA;AAAA,EACA;AAAA,EACA,yBAAyB;AAAA,EACzB,iCAAiC;AACnC,EAAE,IAAI,eAAa,CAAC,YAAmC,UAAU,SAAS,QAAQ,CAAC;;;AChInF,SAAS,4CAA4C;AAKrD,IAAM,wBAAwB,IAAI,IAAI,OAAO,KAAK,oCAAoC,CAAC;AAOhF,IAAM,6BAA6B,CAAC,YAA4B;AAErE,MAAI,SAAS;AAEb,aAAW,QAAQ,SAAS;AAE1B,QAAI,CAAC,sBAAsB,IAAI,IAAI,GAAG;AAEpC,gBAAU;AAAA,IACZ;AAAA,EACF;AAEA,SAAO;AACT;;;AJdA,IAAM,qBAAqB,EAAE,qBAAqB,MAAM;AAEjD,IAAM,gBAAN,MAAM,eAAc;AAAA,EACzB,OAAO,YAAY,CAAC,MAAM;AAAA,EAElB;AAAA,EAEA,YAAY,SAAgC;AAClD,SAAK,WAAW;AAAA,EAClB;AAAA,EAEA,IAAI,SAAS;AACX,WAAO,SAAS,KAAK,QAAQ,QAAQ,MAAM,6BAA6B;AAAA,EAC1E;AAAA,EAEA,IAAI,OAAO;AACT,WAAO,GAAG,KAAK,MAAM,IAAI,KAAK,GAAG;AAAA,EACnC;AAAA,EAEA,IAAI,MAAM;AACR,WAAO,SAAS,KAAK,QAAQ,KAAK,MAAM,0BAA0B;AAAA,EACpE;AAAA,EAEA,IAAI,UAAU;AACZ,WAAO,SAAS,KAAK,UAAU,MAAM,+BAA+B;AAAA,EACtE;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,OAAO,YAAY,QAA0D;AAC3E,WAAO,IAAI,eAAc,MAAM;AAAA,EACjC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,OAAO,WAAW,SAAgC;AAChD,UAAM,QAAQ,QAAQ,MAAM,GAAG;AAC/B,aAAS,MAAM,WAAW,GAAG,MAAM,yBAAyB;AAE5D,UAAM,SAAS,MAAM,CAAC;AACtB,UAAM,MAAM,MAAM,CAAC;AACnB,WAAO,IAAI,eAAc;AAAA,MACvB,QAAQ;AAAA,MAAc;AAAA,MAAQ;AAAA,IAChC,CAAC;AAAA,EACH;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,OAAO,yBAAyB,QAAmC;AACjE,QAAI,OAAO,MAAM,EAAG,QAAO;AAC3B,UAAM,UAAU,eAAc,UAAU,KAAK,SAAO,QAAQ,SAAS,GAAG,CAAC,IAAI,SAAS;AACtF,WAAO,UAAU,YAAY;AAAA,EAC/B;AAAA,EAEA,aAAa,QAAQ,QAAiD;AACpE,UAAM,UAAU,MAAM,QAAQ,IAAI,wBAAwB,IAAI,eAAa,UAAU,MAAM,CAAC,CAAC;AAC7F,eAAW,UAAU,SAAS;AAC5B,UAAI,CAAC,OAAQ,QAAO;AAAA,IACtB;AACA,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,OAAO,KAAK,KAAa,UAA4C,oBAA4B;AAE/F,QAAI,IAAI,SAAS,mBAAmB;AAClC,YAAM,IAAI,MAAM,yBAAyB,IAAI,MAAM,wBAAwB,iBAAiB,EAAE;AAAA,IAChG;AAGA,UAAM,mBAAmB,IAAI,YAAY;AAGzC,QAAI,mBAAmB,iBAAiB,WAAW,mBAAmB,EAAE;AAGxE,QAAI,QAAQ,oBAAqB,oBAAmB,iBAAiB,WAAW,YAAY,EAAE;AAG9F,WAAO,2BAA2B,gBAAgB;AAAA,EACpD;AAAA,EAEA,MAAM,WAAyC;AAC7C,UAAM,gBAA0B,CAAC;AACjC,UAAM,mBAAmB,CAAC,YAAsB,cAAc,KAAK,GAAG,OAAO;AAE7E,eAAW,aAAa,yBAAyB;AAC/C,YAAM,UAAU,KAAK,SAAS,gBAAgB;AAAA,IAChD;AAEA,QAAI,cAAc,SAAS,GAAG;AAC5B,aAAO,CAAC,OAAO,aAAa;AAAA,IAC9B;AAEA,WAAO,CAAC,MAAM,CAAC,CAAC;AAAA,EAClB;AACF;","names":[]}
1
+ {"version":3,"sources":["../../src/estimate/lib/parseDomainEstimates.ts","../../src/validation/name/Name.ts","../../src/validation/validation/Constants.ts","../../src/validation/validation/factory/validators.ts","../../src/validation/validation/validators/validators.ts","../../src/validation/name/lib/removeDisallowedCharacters.ts"],"sourcesContent":["import { exists } from '@xylabs/exists'\nimport { type BoundWitness, isBoundWitness } from '@xyo-network/boundwitness-model'\nimport {\n type HashLeaseEstimate, HashLeaseEstimateSchema,\n isHashLeaseEstimate,\n} from '@xyo-network/diviner-hash-lease'\nimport { PayloadBuilder } from '@xyo-network/payload-builder'\nimport type { Payload, WithSources } from '@xyo-network/payload-model'\nimport {\n type DomainEstimate,\n type DomainRegistrationLease, DomainRegistrationLeaseSchema, isDomainRegistrationLease,\n} from '@xyo-network/xns-record-payload-plugins'\n\n/**\n * Parses a generic array of payloads into estimates\n * @param payloads An array of payloads\n * @returns Parsed estimates\n */\nexport const parseDomainEstimates = async (payloads?: Payload[]): Promise<DomainEstimate[]> => {\n if (!payloads) return []\n const bws = payloads\n // Find all bound witnesses\n .filter(isBoundWitness)\n // that have the required estimate payloads\n .filter(hasEstimatePayloads) ?? []\n if (bws.length === 0) return []\n const hashMap = await PayloadBuilder.toAllHashMap(payloads)\n return bws.map<DomainEstimate | undefined>((bw) => {\n const hashLeaseEstimate = getPayloadBySchemaFromBoundWitness<WithSources<HashLeaseEstimate>>(\n bw,\n HashLeaseEstimateSchema,\n hashMap,\n isHashLeaseEstimate,\n )\n if (!hashLeaseEstimate) return\n const domainLease = getPayloadBySchemaFromBoundWitness<DomainRegistrationLease>(\n bw,\n DomainRegistrationLeaseSchema,\n hashMap,\n isDomainRegistrationLease,\n )\n if (!domainLease) return\n return [bw, hashLeaseEstimate, domainLease]\n }).filter(exists)\n}\n\n/**\n * Tests if a BoundWitness has the required estimate payloads\n * @param bw The BoundWitness to check for estimate payloads\n * @returns True if the BoundWitness has the required estimate payloads, false otherwise\n */\nconst hasEstimatePayloads = (bw: BoundWitness): boolean => {\n return bw.payload_schemas.includes(DomainRegistrationLeaseSchema)\n && bw.payload_schemas.includes(HashLeaseEstimateSchema)\n}\n\n/**\n * Finds the first instance of a payload in a BoundWitness by schema\n * @param bw The BoundWitness to extract the payload from\n * @param schema The schema of the payload to extract\n * @param hashMap The hashmap of the payloads\n * @param identity An identity function to check if the payload is of the correct type\n * @returns The payload if it exists or undefined\n */\nconst getPayloadBySchemaFromBoundWitness = <T extends Payload = Payload>(\n bw: BoundWitness,\n schema: string,\n hashMap: Awaited<ReturnType<typeof PayloadBuilder.toHashMap>>,\n identity: (payload: Payload) => payload is T,\n): T | undefined => {\n const schemaIndex = bw.payload_schemas.indexOf(schema)\n if (schemaIndex === -1) return\n const hash = bw.payload_hashes[schemaIndex]\n return [hashMap[hash]].filter(exists).find(identity)\n}\n","import { assertEx } from '@xylabs/assert'\nimport { isHash } from '@xylabs/hex'\nimport type { Promisable } from '@xylabs/promise'\nimport type { Payload } from '@xyo-network/payload-model'\nimport type { DomainFields, TopLevelDomain } from '@xyo-network/xns-record-payload-plugins'\nimport { DomainSchema } from '@xyo-network/xns-record-payload-plugins'\n\nimport { MAX_DOMAIN_LENGTH, XnsNameSimpleValidators } from '../validation/index.ts'\nimport { removeDisallowedCharacters } from './lib/index.ts'\nimport type { ValidSourceTypes } from './types/index.ts'\n\nconst defaultMaskOptions = { maskStartEndHyphens: false }\n\nexport class XnsNameHelper {\n static ValidTLDs = ['.xyo'] as const\n\n private _xnsName: Payload<DomainFields>\n\n private constructor(xnsName: Payload<DomainFields>) {\n this._xnsName = xnsName\n }\n\n get domain() {\n return assertEx(this.xnsName.domain, () => 'domain not found in payload')\n }\n\n get name() {\n return `${this.domain}.${this.tld}`\n }\n\n get tld() {\n return assertEx(this.xnsName.tld, () => 'tld not found in payload')\n }\n\n get xnsName() {\n return assertEx(this._xnsName, () => 'XnsNameHelper xnsName not set')\n }\n\n /**\n * Create an XnsNameHelper from a domain payload\n * @param {Domain} domain\n * @returns Promise<XnsNameHelper>\n */\n static fromPayload(domain: Payload<DomainFields>): Promisable<XnsNameHelper> {\n return new XnsNameHelper(domain)\n }\n\n /**\n * Create an XnsNameHelper from a string\n * @param {string} xnsName\n * @returns Promise<XnsNameHelper>\n */\n static fromString(xnsName: string): XnsNameHelper {\n const parts = xnsName.split('.')\n assertEx(parts.length === 2, () => 'Unable to parse xnsName')\n\n const domain = parts[0]\n const tld = parts[1] as TopLevelDomain\n return new XnsNameHelper({\n schema: DomainSchema, domain, tld,\n })\n }\n\n /**\n * Determine if a string is a valid XNS name or hash\n * @param {string} source?\n * @returns ValidSourceTypes\n */\n static isPotentialXnsNameOrHash(source?: string): ValidSourceTypes {\n if (isHash(source)) return 'hash'\n const xnsName = XnsNameHelper.ValidTLDs.some(tld => source?.endsWith(tld)) ? source : null\n return xnsName ? 'xnsName' : null\n }\n\n static async isValid(domain: Payload<DomainFields>): Promise<boolean> {\n const results = await Promise.all(XnsNameSimpleValidators.map(validator => validator(domain)))\n for (const result of results) {\n if (!result) return false\n }\n return true\n }\n\n /**\n * Mask a string to be a valid XNS name\n * @param {string} str\n * @returns string\n */\n static mask(str: string, options: { maskStartEndHyphens: boolean } = defaultMaskOptions): string {\n // Check if the domain name is too long\n if (str.length > MAX_DOMAIN_LENGTH) {\n throw new Error(`Domain name too long: ${str.length} exceeds max length: ${MAX_DOMAIN_LENGTH}`)\n }\n\n // convert to lowercase\n const lowercaseXnsName = str.toLowerCase()\n\n // Remove everything except letters, numbers, and dashes\n let formattedXnsName = lowercaseXnsName.replaceAll(/[^\\dA-Za-z-]+$/g, '')\n\n // Remove leading and trailing dashes\n if (options.maskStartEndHyphens) formattedXnsName = formattedXnsName.replaceAll(/^-+|-+$/g, '')\n\n // Filter out disallowed characters.\n return removeDisallowedCharacters(formattedXnsName)\n }\n\n async validate(): Promise<[boolean, string[]]> {\n const errorMessages: string[] = []\n const onErrorsInternal = (message: string[]) => errorMessages.push(...message)\n\n for (const validator of XnsNameSimpleValidators) {\n await validator(this.xnsName, onErrorsInternal)\n }\n\n if (errorMessages.length > 0) {\n return [false, errorMessages]\n }\n\n return [true, []]\n }\n}\n","export const MIN_DOMAIN_LENGTH = 3\nexport const MAX_DOMAIN_LENGTH = 128\n","import type { Payload, PayloadValidationFunction } from '@xyo-network/payload-model'\nimport type { DomainFields } from '@xyo-network/xns-record-payload-plugins'\n\nexport const getDomainReservedStringsValidator = (\n reservedStrings: string[],\n): PayloadValidationFunction<Payload<DomainFields>> => {\n return (payload: Payload<DomainFields>) => {\n const { domain } = payload\n // Check if in one of the reserved name lists\n if (reservedStrings.includes(domain)) {\n console.log('Reserved name')\n return false\n }\n return true\n }\n}\n\nexport const getDomainReservedFragmentsValidator = (\n reservedFragments: string[],\n): PayloadValidationFunction<Payload<DomainFields>> => {\n return (payload: Payload<DomainFields>) => {\n const { domain } = payload\n // Check if any of our fragments are in the name\n for (const reserved of reservedFragments) {\n if (domain.includes(reserved)) {\n console.log('Reserved name fragment')\n return false\n }\n }\n return true\n }\n}\n\nexport const getDomainReservedNamesValidator = (reservedNames: string[]): PayloadValidationFunction<Payload<DomainFields>> => {\n return (payload: Payload<DomainFields>) => {\n const { domain } = payload\n // Check if any of our fragments are in the name\n for (const reserved of reservedNames) {\n const parts = reserved.split(' ')\n if (domain === [parts[1], parts[0]].join('') || domain === [parts[0], parts[1]].join('')) {\n console.log('Reserved name')\n return false\n }\n }\n return true\n }\n}\n","import { isModuleName } from '@xyo-network/module-model'\nimport type { Payload } from '@xyo-network/payload-model'\nimport type { DomainFields } from '@xyo-network/xns-record-payload-plugins'\n\nimport { MAX_DOMAIN_LENGTH, MIN_DOMAIN_LENGTH } from '../Constants.ts'\n\nexport type PayloadValidationFunctionWithError<T extends Payload = Payload> = (payload: T, onErrors?: (message: string[]) => void) => boolean | Promise<boolean>\n\nexport const domainCasingValidator: PayloadValidationFunctionWithError<Payload<DomainFields>> = (\n payload: Payload<DomainFields>,\n onErrors?: (message: string[]) => void,\n) => {\n const { domain } = payload\n // Check if all lowercase\n if (domain.toLowerCase() !== domain) {\n onErrors?.(['name must be lowercase'])\n return false\n }\n return true\n}\n\nexport const domainModuleNameValidator: PayloadValidationFunctionWithError<Payload<DomainFields>> = (\n payload: Payload<DomainFields>,\n onErrors?: (message: string[]) => void,\n) => {\n const { domain } = payload\n\n // check if domain is a valid name\n if (!isModuleName(domain)) {\n onErrors?.([`Domain is not a valid module name: ${domain}`])\n return false\n }\n\n return true\n}\n\nexport const domainTldValidator: PayloadValidationFunctionWithError<Payload<DomainFields>> = (\n payload: Payload<DomainFields>,\n onErrors?: (message: string[]) => void,\n) => {\n const { tld } = payload\n const errorMessages: string[] = []\n\n // Check if all lowercase\n if (tld.toLowerCase() !== tld) {\n errorMessages.push('TLD must be lowercase')\n }\n // Check if supported TLDs\n if (tld !== 'xyo') {\n errorMessages.push('Only XYO TLD currently supported')\n }\n if (errorMessages.length > 0) {\n onErrors?.(errorMessages)\n return false\n }\n return true\n}\n\nexport const getDomainLengthValidator = (\n minNameLength = MIN_DOMAIN_LENGTH,\n maxLength = MAX_DOMAIN_LENGTH,\n): PayloadValidationFunctionWithError<Payload<DomainFields>> => {\n return (\n payload: Payload<DomainFields>,\n onErrors?: (message: string[]) => void,\n ) => {\n const { domain } = payload\n const errorMessages: string[] = []\n\n // Check if min length\n if (domain.length < minNameLength) {\n errorMessages.push(`name must be at least ${minNameLength} characters`)\n }\n\n if (domain.length > maxLength) {\n errorMessages.push(`name must be no more than ${maxLength} characters`)\n }\n\n if (errorMessages.length > 0) {\n onErrors?.(errorMessages)\n return false\n }\n\n return true\n }\n}\n\nexport const getDomainAllowedHyphensValidator = (\n options?: { end?: boolean; start?: boolean },\n): PayloadValidationFunctionWithError<Payload<DomainFields>> => {\n return (\n payload: Payload<DomainFields>,\n onErrors?: (message: string[]) => void,\n ) => {\n const { domain } = payload\n const { start, end } = options ?? {}\n const errorMessages: string[] = []\n\n if (!start && domain.startsWith('-')) {\n errorMessages.push('name cannot start with hyphen')\n }\n\n if (!end && domain.endsWith('-')) {\n errorMessages.push('name cannot end with hyphen')\n }\n\n if (errorMessages.length > 0) {\n onErrors?.(errorMessages)\n return false\n }\n return true\n }\n}\n\nexport const XnsNameSimpleValidators = [\n domainCasingValidator,\n domainModuleNameValidator,\n domainTldValidator,\n getDomainLengthValidator(),\n getDomainAllowedHyphensValidator(),\n]\n\nexport const XnsNameSimpleValidatorsWithErrors = (onErrors: (message: string[]) => void) => [\n domainCasingValidator,\n domainModuleNameValidator,\n domainTldValidator,\n getDomainLengthValidator(),\n getDomainAllowedHyphensValidator(),\n].map(validator => (payload: Payload<DomainFields>) => validator(payload, onErrors))\n","import { DisallowedModuleIdentifierCharacters } from '@xyo-network/module-model'\n\n/**\n * A set of all the disallowed characters in module identifiers\n */\nconst DISALLOWED_CHARACTERS = new Set(Object.keys(DisallowedModuleIdentifierCharacters))\n\n/**\n * Iterates over a string removing disallowed characters\n * @param xnsName The XNS name to remove disallowed characters from\n * @returns The XNS name with disallowed characters removed\n */\nexport const removeDisallowedCharacters = (xnsName: string): string => {\n // Create the initial result\n let result = ''\n // Iterate over each character in the XNS name\n for (const char of xnsName) {\n // If the character is not a disallowed character\n if (!DISALLOWED_CHARACTERS.has(char)) {\n // add it to the result\n result += char\n }\n }\n // Return the result which contains only allowed characters\n return result\n}\n"],"mappings":";AAAA,SAAS,cAAc;AACvB,SAA4B,sBAAsB;AAClD;AAAA,EAC0B;AAAA,EACxB;AAAA,OACK;AACP,SAAS,sBAAsB;AAE/B;AAAA,EAEgC;AAAA,EAA+B;AAAA,OACxD;AAOA,IAAM,uBAAuB,OAAO,aAAoD;AAC7F,MAAI,CAAC,SAAU,QAAO,CAAC;AACvB,QAAM,MAAM,SAET,OAAO,cAAc,EAErB,OAAO,mBAAmB,KAAK,CAAC;AACnC,MAAI,IAAI,WAAW,EAAG,QAAO,CAAC;AAC9B,QAAM,UAAU,MAAM,eAAe,aAAa,QAAQ;AAC1D,SAAO,IAAI,IAAgC,CAAC,OAAO;AACjD,UAAM,oBAAoB;AAAA,MACxB;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,IACF;AACA,QAAI,CAAC,kBAAmB;AACxB,UAAM,cAAc;AAAA,MAClB;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,IACF;AACA,QAAI,CAAC,YAAa;AAClB,WAAO,CAAC,IAAI,mBAAmB,WAAW;AAAA,EAC5C,CAAC,EAAE,OAAO,MAAM;AAClB;AAOA,IAAM,sBAAsB,CAAC,OAA8B;AACzD,SAAO,GAAG,gBAAgB,SAAS,6BAA6B,KAC3D,GAAG,gBAAgB,SAAS,uBAAuB;AAC1D;AAUA,IAAM,qCAAqC,CACzC,IACA,QACA,SACA,aACkB;AAClB,QAAM,cAAc,GAAG,gBAAgB,QAAQ,MAAM;AACrD,MAAI,gBAAgB,GAAI;AACxB,QAAM,OAAO,GAAG,eAAe,WAAW;AAC1C,SAAO,CAAC,QAAQ,IAAI,CAAC,EAAE,OAAO,MAAM,EAAE,KAAK,QAAQ;AACrD;;;AC1EA,SAAS,gBAAgB;AACzB,SAAS,cAAc;AAIvB,SAAS,oBAAoB;;;ACLtB,IAAM,oBAAoB;AAC1B,IAAM,oBAAoB;;;ACE1B,IAAM,oCAAoC,CAC/C,oBACqD;AACrD,SAAO,CAAC,YAAmC;AACzC,UAAM,EAAE,OAAO,IAAI;AAEnB,QAAI,gBAAgB,SAAS,MAAM,GAAG;AACpC,cAAQ,IAAI,eAAe;AAC3B,aAAO;AAAA,IACT;AACA,WAAO;AAAA,EACT;AACF;AAEO,IAAM,sCAAsC,CACjD,sBACqD;AACrD,SAAO,CAAC,YAAmC;AACzC,UAAM,EAAE,OAAO,IAAI;AAEnB,eAAW,YAAY,mBAAmB;AACxC,UAAI,OAAO,SAAS,QAAQ,GAAG;AAC7B,gBAAQ,IAAI,wBAAwB;AACpC,eAAO;AAAA,MACT;AAAA,IACF;AACA,WAAO;AAAA,EACT;AACF;AAEO,IAAM,kCAAkC,CAAC,kBAA8E;AAC5H,SAAO,CAAC,YAAmC;AACzC,UAAM,EAAE,OAAO,IAAI;AAEnB,eAAW,YAAY,eAAe;AACpC,YAAM,QAAQ,SAAS,MAAM,GAAG;AAChC,UAAI,WAAW,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,WAAW,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC,CAAC,EAAE,KAAK,EAAE,GAAG;AACxF,gBAAQ,IAAI,eAAe;AAC3B,eAAO;AAAA,MACT;AAAA,IACF;AACA,WAAO;AAAA,EACT;AACF;;;AC9CA,SAAS,oBAAoB;AAQtB,IAAM,wBAAmF,CAC9F,SACA,aACG;AACH,QAAM,EAAE,OAAO,IAAI;AAEnB,MAAI,OAAO,YAAY,MAAM,QAAQ;AACnC,eAAW,CAAC,wBAAwB,CAAC;AACrC,WAAO;AAAA,EACT;AACA,SAAO;AACT;AAEO,IAAM,4BAAuF,CAClG,SACA,aACG;AACH,QAAM,EAAE,OAAO,IAAI;AAGnB,MAAI,CAAC,aAAa,MAAM,GAAG;AACzB,eAAW,CAAC,sCAAsC,MAAM,EAAE,CAAC;AAC3D,WAAO;AAAA,EACT;AAEA,SAAO;AACT;AAEO,IAAM,qBAAgF,CAC3F,SACA,aACG;AACH,QAAM,EAAE,IAAI,IAAI;AAChB,QAAM,gBAA0B,CAAC;AAGjC,MAAI,IAAI,YAAY,MAAM,KAAK;AAC7B,kBAAc,KAAK,uBAAuB;AAAA,EAC5C;AAEA,MAAI,QAAQ,OAAO;AACjB,kBAAc,KAAK,kCAAkC;AAAA,EACvD;AACA,MAAI,cAAc,SAAS,GAAG;AAC5B,eAAW,aAAa;AACxB,WAAO;AAAA,EACT;AACA,SAAO;AACT;AAEO,IAAM,2BAA2B,CACtC,gBAAgB,mBAChB,YAAY,sBACkD;AAC9D,SAAO,CACL,SACA,aACG;AACH,UAAM,EAAE,OAAO,IAAI;AACnB,UAAM,gBAA0B,CAAC;AAGjC,QAAI,OAAO,SAAS,eAAe;AACjC,oBAAc,KAAK,yBAAyB,aAAa,aAAa;AAAA,IACxE;AAEA,QAAI,OAAO,SAAS,WAAW;AAC7B,oBAAc,KAAK,6BAA6B,SAAS,aAAa;AAAA,IACxE;AAEA,QAAI,cAAc,SAAS,GAAG;AAC5B,iBAAW,aAAa;AACxB,aAAO;AAAA,IACT;AAEA,WAAO;AAAA,EACT;AACF;AAEO,IAAM,mCAAmC,CAC9C,YAC8D;AAC9D,SAAO,CACL,SACA,aACG;AACH,UAAM,EAAE,OAAO,IAAI;AACnB,UAAM,EAAE,OAAO,IAAI,IAAI,WAAW,CAAC;AACnC,UAAM,gBAA0B,CAAC;AAEjC,QAAI,CAAC,SAAS,OAAO,WAAW,GAAG,GAAG;AACpC,oBAAc,KAAK,+BAA+B;AAAA,IACpD;AAEA,QAAI,CAAC,OAAO,OAAO,SAAS,GAAG,GAAG;AAChC,oBAAc,KAAK,6BAA6B;AAAA,IAClD;AAEA,QAAI,cAAc,SAAS,GAAG;AAC5B,iBAAW,aAAa;AACxB,aAAO;AAAA,IACT;AACA,WAAO;AAAA,EACT;AACF;AAEO,IAAM,0BAA0B;AAAA,EACrC;AAAA,EACA;AAAA,EACA;AAAA,EACA,yBAAyB;AAAA,EACzB,iCAAiC;AACnC;AAEO,IAAM,oCAAoC,CAAC,aAA0C;AAAA,EAC1F;AAAA,EACA;AAAA,EACA;AAAA,EACA,yBAAyB;AAAA,EACzB,iCAAiC;AACnC,EAAE,IAAI,eAAa,CAAC,YAAmC,UAAU,SAAS,QAAQ,CAAC;;;AChInF,SAAS,4CAA4C;AAKrD,IAAM,wBAAwB,IAAI,IAAI,OAAO,KAAK,oCAAoC,CAAC;AAOhF,IAAM,6BAA6B,CAAC,YAA4B;AAErE,MAAI,SAAS;AAEb,aAAW,QAAQ,SAAS;AAE1B,QAAI,CAAC,sBAAsB,IAAI,IAAI,GAAG;AAEpC,gBAAU;AAAA,IACZ;AAAA,EACF;AAEA,SAAO;AACT;;;AJdA,IAAM,qBAAqB,EAAE,qBAAqB,MAAM;AAEjD,IAAM,gBAAN,MAAM,eAAc;AAAA,EACzB,OAAO,YAAY,CAAC,MAAM;AAAA,EAElB;AAAA,EAEA,YAAY,SAAgC;AAClD,SAAK,WAAW;AAAA,EAClB;AAAA,EAEA,IAAI,SAAS;AACX,WAAO,SAAS,KAAK,QAAQ,QAAQ,MAAM,6BAA6B;AAAA,EAC1E;AAAA,EAEA,IAAI,OAAO;AACT,WAAO,GAAG,KAAK,MAAM,IAAI,KAAK,GAAG;AAAA,EACnC;AAAA,EAEA,IAAI,MAAM;AACR,WAAO,SAAS,KAAK,QAAQ,KAAK,MAAM,0BAA0B;AAAA,EACpE;AAAA,EAEA,IAAI,UAAU;AACZ,WAAO,SAAS,KAAK,UAAU,MAAM,+BAA+B;AAAA,EACtE;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,OAAO,YAAY,QAA0D;AAC3E,WAAO,IAAI,eAAc,MAAM;AAAA,EACjC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,OAAO,WAAW,SAAgC;AAChD,UAAM,QAAQ,QAAQ,MAAM,GAAG;AAC/B,aAAS,MAAM,WAAW,GAAG,MAAM,yBAAyB;AAE5D,UAAM,SAAS,MAAM,CAAC;AACtB,UAAM,MAAM,MAAM,CAAC;AACnB,WAAO,IAAI,eAAc;AAAA,MACvB,QAAQ;AAAA,MAAc;AAAA,MAAQ;AAAA,IAChC,CAAC;AAAA,EACH;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,OAAO,yBAAyB,QAAmC;AACjE,QAAI,OAAO,MAAM,EAAG,QAAO;AAC3B,UAAM,UAAU,eAAc,UAAU,KAAK,SAAO,QAAQ,SAAS,GAAG,CAAC,IAAI,SAAS;AACtF,WAAO,UAAU,YAAY;AAAA,EAC/B;AAAA,EAEA,aAAa,QAAQ,QAAiD;AACpE,UAAM,UAAU,MAAM,QAAQ,IAAI,wBAAwB,IAAI,eAAa,UAAU,MAAM,CAAC,CAAC;AAC7F,eAAW,UAAU,SAAS;AAC5B,UAAI,CAAC,OAAQ,QAAO;AAAA,IACtB;AACA,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,OAAO,KAAK,KAAa,UAA4C,oBAA4B;AAE/F,QAAI,IAAI,SAAS,mBAAmB;AAClC,YAAM,IAAI,MAAM,yBAAyB,IAAI,MAAM,wBAAwB,iBAAiB,EAAE;AAAA,IAChG;AAGA,UAAM,mBAAmB,IAAI,YAAY;AAGzC,QAAI,mBAAmB,iBAAiB,WAAW,mBAAmB,EAAE;AAGxE,QAAI,QAAQ,oBAAqB,oBAAmB,iBAAiB,WAAW,YAAY,EAAE;AAG9F,WAAO,2BAA2B,gBAAgB;AAAA,EACpD;AAAA,EAEA,MAAM,WAAyC;AAC7C,UAAM,gBAA0B,CAAC;AACjC,UAAM,mBAAmB,CAAC,YAAsB,cAAc,KAAK,GAAG,OAAO;AAE7E,eAAW,aAAa,yBAAyB;AAC/C,YAAM,UAAU,KAAK,SAAS,gBAAgB;AAAA,IAChD;AAEA,QAAI,cAAc,SAAS,GAAG;AAC5B,aAAO,CAAC,OAAO,aAAa;AAAA,IAC9B;AAEA,WAAO,CAAC,MAAM,CAAC,CAAC;AAAA,EAClB;AACF;","names":[]}
@@ -12,10 +12,30 @@ export declare class XnsNameHelper {
12
12
  get xnsName(): import("@xyo-network/payload-model").SchemaFields & import("@xyo-network/payload-model").PayloadFields & DomainFields & {
13
13
  schema: import("@xyo-network/payload-model").Schema;
14
14
  };
15
+ /**
16
+ * Create an XnsNameHelper from a domain payload
17
+ * @param {Domain} domain
18
+ * @returns Promise<XnsNameHelper>
19
+ */
15
20
  static fromPayload(domain: Payload<DomainFields>): Promisable<XnsNameHelper>;
21
+ /**
22
+ * Create an XnsNameHelper from a string
23
+ * @param {string} xnsName
24
+ * @returns Promise<XnsNameHelper>
25
+ */
16
26
  static fromString(xnsName: string): XnsNameHelper;
27
+ /**
28
+ * Determine if a string is a valid XNS name or hash
29
+ * @param {string} source?
30
+ * @returns ValidSourceTypes
31
+ */
17
32
  static isPotentialXnsNameOrHash(source?: string): ValidSourceTypes;
18
33
  static isValid(domain: Payload<DomainFields>): Promise<boolean>;
34
+ /**
35
+ * Mask a string to be a valid XNS name
36
+ * @param {string} str
37
+ * @returns string
38
+ */
19
39
  static mask(str: string, options?: {
20
40
  maskStartEndHyphens: boolean;
21
41
  }): string;
@@ -1 +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"}
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;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"}
@@ -1,2 +1,7 @@
1
+ /**
2
+ * Iterates over a string removing disallowed characters
3
+ * @param xnsName The XNS name to remove disallowed characters from
4
+ * @returns The XNS name with disallowed characters removed
5
+ */
1
6
  export declare const removeDisallowedCharacters: (xnsName: string) => string;
2
7
  //# sourceMappingURL=removeDisallowedCharacters.d.ts.map
@@ -1 +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"}
1
+ {"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"}
@@ -1,4 +1,9 @@
1
1
  import type { Payload } from '@xyo-network/payload-model';
2
2
  import { type DomainEstimate } from '@xyo-network/xns-record-payload-plugins';
3
+ /**
4
+ * Parses a generic array of payloads into estimates
5
+ * @param payloads An array of payloads
6
+ * @returns Parsed estimates
7
+ */
3
8
  export declare const parseDomainEstimates: (payloads?: Payload[]) => Promise<DomainEstimate[]>;
4
9
  //# sourceMappingURL=parseDomainEstimates.d.ts.map
@@ -1 +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"}
1
+ {"version":3,"file":"parseDomainEstimates.d.ts","sourceRoot":"","sources":["../../../../src/estimate/lib/parseDomainEstimates.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,EAAE,OAAO,EAAe,MAAM,4BAA4B,CAAA;AACtE,OAAO,EACL,KAAK,cAAc,EAEpB,MAAM,yCAAyC,CAAA;AAEhD;;;;GAIG;AACH,eAAO,MAAM,oBAAoB,cAAqB,OAAO,EAAE,KAAG,OAAO,CAAC,cAAc,EAAE,CA0BzF,CAAA"}
@@ -3,12 +3,12 @@ import { exists } from "@xylabs/exists";
3
3
  import { isBoundWitness } from "@xyo-network/boundwitness-model";
4
4
  import {
5
5
  HashLeaseEstimateSchema,
6
- isHashLeaseEstimateWithMeta
6
+ isHashLeaseEstimate
7
7
  } from "@xyo-network/diviner-hash-lease";
8
8
  import { PayloadBuilder } from "@xyo-network/payload-builder";
9
9
  import {
10
10
  DomainRegistrationLeaseSchema,
11
- isDomainRegistrationLeaseWithMeta
11
+ isDomainRegistrationLease
12
12
  } from "@xyo-network/xns-record-payload-plugins";
13
13
  var parseDomainEstimates = async (payloads) => {
14
14
  if (!payloads) return [];
@@ -20,14 +20,14 @@ var parseDomainEstimates = async (payloads) => {
20
20
  bw,
21
21
  HashLeaseEstimateSchema,
22
22
  hashMap,
23
- isHashLeaseEstimateWithMeta
23
+ isHashLeaseEstimate
24
24
  );
25
25
  if (!hashLeaseEstimate) return;
26
26
  const domainLease = getPayloadBySchemaFromBoundWitness(
27
27
  bw,
28
28
  DomainRegistrationLeaseSchema,
29
29
  hashMap,
30
- isDomainRegistrationLeaseWithMeta
30
+ isDomainRegistrationLease
31
31
  );
32
32
  if (!domainLease) return;
33
33
  return [bw, hashLeaseEstimate, domainLease];
@@ -1 +1 @@
1
- {"version":3,"sources":["../../src/estimate/lib/parseDomainEstimates.ts","../../src/validation/name/Name.ts","../../src/validation/validation/Constants.ts","../../src/validation/validation/factory/validators.ts","../../src/validation/validation/validators/validators.ts","../../src/validation/name/lib/removeDisallowedCharacters.ts"],"sourcesContent":["import { exists } from '@xylabs/exists'\nimport { type BoundWitness, isBoundWitness } from '@xyo-network/boundwitness-model'\nimport {\n type HashLeaseEstimate, HashLeaseEstimateSchema,\n isHashLeaseEstimateWithMeta,\n} from '@xyo-network/diviner-hash-lease'\nimport { PayloadBuilder } from '@xyo-network/payload-builder'\nimport type {\n Payload, WithMeta, WithSources,\n} from '@xyo-network/payload-model'\nimport {\n type DomainEstimate,\n type DomainRegistrationLease, DomainRegistrationLeaseSchema, isDomainRegistrationLeaseWithMeta,\n} from '@xyo-network/xns-record-payload-plugins'\n\n/**\n * Parses a generic array of payloads into estimates\n * @param payloads An array of payloads\n * @returns Parsed estimates\n */\nexport const parseDomainEstimates = async (payloads?: Payload[]): Promise<DomainEstimate[]> => {\n if (!payloads) return []\n const bws = payloads\n // Find all bound witnesses\n .filter(isBoundWitness)\n // that have the required estimate payloads\n .filter(hasEstimatePayloads) ?? []\n if (bws.length === 0) return []\n const hashMap = await PayloadBuilder.toAllHashMap(payloads)\n return bws.map<DomainEstimate | undefined>((bw) => {\n const hashLeaseEstimate = getPayloadBySchemaFromBoundWitness<WithSources<HashLeaseEstimate>>(\n bw,\n HashLeaseEstimateSchema,\n hashMap,\n isHashLeaseEstimateWithMeta,\n )\n if (!hashLeaseEstimate) return\n const domainLease = getPayloadBySchemaFromBoundWitness<DomainRegistrationLease>(\n bw,\n DomainRegistrationLeaseSchema,\n hashMap,\n isDomainRegistrationLeaseWithMeta,\n )\n if (!domainLease) return\n return [bw, hashLeaseEstimate, domainLease]\n }).filter(exists)\n}\n\n/**\n * Tests if a BoundWitness has the required estimate payloads\n * @param bw The BoundWitness to check for estimate payloads\n * @returns True if the BoundWitness has the required estimate payloads, false otherwise\n */\nconst hasEstimatePayloads = (bw: BoundWitness): boolean => {\n return bw.payload_schemas.includes(DomainRegistrationLeaseSchema)\n && bw.payload_schemas.includes(HashLeaseEstimateSchema)\n}\n\n/**\n * Finds the first instance of a payload in a BoundWitness by schema\n * @param bw The BoundWitness to extract the payload from\n * @param schema The schema of the payload to extract\n * @param hashMap The hashmap of the payloads\n * @param identity An identity function to check if the payload is of the correct type\n * @returns The payload if it exists or undefined\n */\nconst getPayloadBySchemaFromBoundWitness = <T extends Payload = Payload>(\n bw: BoundWitness,\n schema: string,\n hashMap: Awaited<ReturnType<typeof PayloadBuilder.toHashMap>>,\n identity: (payload: Payload) => payload is WithMeta<T>,\n): WithMeta<T> | undefined => {\n const schemaIndex = bw.payload_schemas.indexOf(schema)\n if (schemaIndex === -1) return\n const hash = bw.payload_hashes[schemaIndex]\n return [hashMap[hash]].filter(exists).find(identity)\n}\n","import { assertEx } from '@xylabs/assert'\nimport { isHash } from '@xylabs/hex'\nimport type { Promisable } from '@xylabs/promise'\nimport type { Payload } from '@xyo-network/payload-model'\nimport type { DomainFields, TopLevelDomain } from '@xyo-network/xns-record-payload-plugins'\nimport { DomainSchema } from '@xyo-network/xns-record-payload-plugins'\n\nimport { MAX_DOMAIN_LENGTH, XnsNameSimpleValidators } from '../validation/index.ts'\nimport { removeDisallowedCharacters } from './lib/index.ts'\nimport type { ValidSourceTypes } from './types/index.ts'\n\nconst defaultMaskOptions = { maskStartEndHyphens: false }\n\nexport class XnsNameHelper {\n static ValidTLDs = ['.xyo'] as const\n\n private _xnsName: Payload<DomainFields>\n\n private constructor(xnsName: Payload<DomainFields>) {\n this._xnsName = xnsName\n }\n\n get domain() {\n return assertEx(this.xnsName.domain, () => 'domain not found in payload')\n }\n\n get name() {\n return `${this.domain}.${this.tld}`\n }\n\n get tld() {\n return assertEx(this.xnsName.tld, () => 'tld not found in payload')\n }\n\n get xnsName() {\n return assertEx(this._xnsName, () => 'XnsNameHelper xnsName not set')\n }\n\n /**\n * Create an XnsNameHelper from a domain payload\n * @param {Domain} domain\n * @returns Promise<XnsNameHelper>\n */\n static fromPayload(domain: Payload<DomainFields>): Promisable<XnsNameHelper> {\n return new XnsNameHelper(domain)\n }\n\n /**\n * Create an XnsNameHelper from a string\n * @param {string} xnsName\n * @returns Promise<XnsNameHelper>\n */\n static fromString(xnsName: string): XnsNameHelper {\n const parts = xnsName.split('.')\n assertEx(parts.length === 2, () => 'Unable to parse xnsName')\n\n const domain = parts[0]\n const tld = parts[1] as TopLevelDomain\n return new XnsNameHelper({\n schema: DomainSchema, domain, tld,\n })\n }\n\n /**\n * Determine if a string is a valid XNS name or hash\n * @param {string} source?\n * @returns ValidSourceTypes\n */\n static isPotentialXnsNameOrHash(source?: string): ValidSourceTypes {\n if (isHash(source)) return 'hash'\n const xnsName = XnsNameHelper.ValidTLDs.some(tld => source?.endsWith(tld)) ? source : null\n return xnsName ? 'xnsName' : null\n }\n\n static async isValid(domain: Payload<DomainFields>): Promise<boolean> {\n const results = await Promise.all(XnsNameSimpleValidators.map(validator => validator(domain)))\n for (const result of results) {\n if (!result) return false\n }\n return true\n }\n\n /**\n * Mask a string to be a valid XNS name\n * @param {string} str\n * @returns string\n */\n static mask(str: string, options: { maskStartEndHyphens: boolean } = defaultMaskOptions): string {\n // Check if the domain name is too long\n if (str.length > MAX_DOMAIN_LENGTH) {\n throw new Error(`Domain name too long: ${str.length} exceeds max length: ${MAX_DOMAIN_LENGTH}`)\n }\n\n // convert to lowercase\n const lowercaseXnsName = str.toLowerCase()\n\n // Remove everything except letters, numbers, and dashes\n let formattedXnsName = lowercaseXnsName.replaceAll(/[^\\dA-Za-z-]+$/g, '')\n\n // Remove leading and trailing dashes\n if (options.maskStartEndHyphens) formattedXnsName = formattedXnsName.replaceAll(/^-+|-+$/g, '')\n\n // Filter out disallowed characters.\n return removeDisallowedCharacters(formattedXnsName)\n }\n\n async validate(): Promise<[boolean, string[]]> {\n const errorMessages: string[] = []\n const onErrorsInternal = (message: string[]) => errorMessages.push(...message)\n\n for (const validator of XnsNameSimpleValidators) {\n await validator(this.xnsName, onErrorsInternal)\n }\n\n if (errorMessages.length > 0) {\n return [false, errorMessages]\n }\n\n return [true, []]\n }\n}\n","export const MIN_DOMAIN_LENGTH = 3\nexport const MAX_DOMAIN_LENGTH = 128\n","import type { Payload, PayloadValidationFunction } from '@xyo-network/payload-model'\nimport type { DomainFields } from '@xyo-network/xns-record-payload-plugins'\n\nexport const getDomainReservedStringsValidator = (\n reservedStrings: string[],\n): PayloadValidationFunction<Payload<DomainFields>> => {\n return (payload: Payload<DomainFields>) => {\n const { domain } = payload\n // Check if in one of the reserved name lists\n if (reservedStrings.includes(domain)) {\n console.log('Reserved name')\n return false\n }\n return true\n }\n}\n\nexport const getDomainReservedFragmentsValidator = (\n reservedFragments: string[],\n): PayloadValidationFunction<Payload<DomainFields>> => {\n return (payload: Payload<DomainFields>) => {\n const { domain } = payload\n // Check if any of our fragments are in the name\n for (const reserved of reservedFragments) {\n if (domain.includes(reserved)) {\n console.log('Reserved name fragment')\n return false\n }\n }\n return true\n }\n}\n\nexport const getDomainReservedNamesValidator = (reservedNames: string[]): PayloadValidationFunction<Payload<DomainFields>> => {\n return (payload: Payload<DomainFields>) => {\n const { domain } = payload\n // Check if any of our fragments are in the name\n for (const reserved of reservedNames) {\n const parts = reserved.split(' ')\n if (domain === [parts[1], parts[0]].join('') || domain === [parts[0], parts[1]].join('')) {\n console.log('Reserved name')\n return false\n }\n }\n return true\n }\n}\n","import { isModuleName } from '@xyo-network/module-model'\nimport type { Payload } from '@xyo-network/payload-model'\nimport type { DomainFields } from '@xyo-network/xns-record-payload-plugins'\n\nimport { MAX_DOMAIN_LENGTH, MIN_DOMAIN_LENGTH } from '../Constants.ts'\n\nexport type PayloadValidationFunctionWithError<T extends Payload = Payload> = (payload: T, onErrors?: (message: string[]) => void) => boolean | Promise<boolean>\n\nexport const domainCasingValidator: PayloadValidationFunctionWithError<Payload<DomainFields>> = (\n payload: Payload<DomainFields>,\n onErrors?: (message: string[]) => void,\n) => {\n const { domain } = payload\n // Check if all lowercase\n if (domain.toLowerCase() !== domain) {\n onErrors?.(['name must be lowercase'])\n return false\n }\n return true\n}\n\nexport const domainModuleNameValidator: PayloadValidationFunctionWithError<Payload<DomainFields>> = (\n payload: Payload<DomainFields>,\n onErrors?: (message: string[]) => void,\n) => {\n const { domain } = payload\n\n // check if domain is a valid name\n if (!isModuleName(domain)) {\n onErrors?.([`Domain is not a valid module name: ${domain}`])\n return false\n }\n\n return true\n}\n\nexport const domainTldValidator: PayloadValidationFunctionWithError<Payload<DomainFields>> = (\n payload: Payload<DomainFields>,\n onErrors?: (message: string[]) => void,\n) => {\n const { tld } = payload\n const errorMessages: string[] = []\n\n // Check if all lowercase\n if (tld.toLowerCase() !== tld) {\n errorMessages.push('TLD must be lowercase')\n }\n // Check if supported TLDs\n if (tld !== 'xyo') {\n errorMessages.push('Only XYO TLD currently supported')\n }\n if (errorMessages.length > 0) {\n onErrors?.(errorMessages)\n return false\n }\n return true\n}\n\nexport const getDomainLengthValidator = (\n minNameLength = MIN_DOMAIN_LENGTH,\n maxLength = MAX_DOMAIN_LENGTH,\n): PayloadValidationFunctionWithError<Payload<DomainFields>> => {\n return (\n payload: Payload<DomainFields>,\n onErrors?: (message: string[]) => void,\n ) => {\n const { domain } = payload\n const errorMessages: string[] = []\n\n // Check if min length\n if (domain.length < minNameLength) {\n errorMessages.push(`name must be at least ${minNameLength} characters`)\n }\n\n if (domain.length > maxLength) {\n errorMessages.push(`name must be no more than ${maxLength} characters`)\n }\n\n if (errorMessages.length > 0) {\n onErrors?.(errorMessages)\n return false\n }\n\n return true\n }\n}\n\nexport const getDomainAllowedHyphensValidator = (\n options?: { end?: boolean; start?: boolean },\n): PayloadValidationFunctionWithError<Payload<DomainFields>> => {\n return (\n payload: Payload<DomainFields>,\n onErrors?: (message: string[]) => void,\n ) => {\n const { domain } = payload\n const { start, end } = options ?? {}\n const errorMessages: string[] = []\n\n if (!start && domain.startsWith('-')) {\n errorMessages.push('name cannot start with hyphen')\n }\n\n if (!end && domain.endsWith('-')) {\n errorMessages.push('name cannot end with hyphen')\n }\n\n if (errorMessages.length > 0) {\n onErrors?.(errorMessages)\n return false\n }\n return true\n }\n}\n\nexport const XnsNameSimpleValidators = [\n domainCasingValidator,\n domainModuleNameValidator,\n domainTldValidator,\n getDomainLengthValidator(),\n getDomainAllowedHyphensValidator(),\n]\n\nexport const XnsNameSimpleValidatorsWithErrors = (onErrors: (message: string[]) => void) => [\n domainCasingValidator,\n domainModuleNameValidator,\n domainTldValidator,\n getDomainLengthValidator(),\n getDomainAllowedHyphensValidator(),\n].map(validator => (payload: Payload<DomainFields>) => validator(payload, onErrors))\n","import { DisallowedModuleIdentifierCharacters } from '@xyo-network/module-model'\n\n/**\n * A set of all the disallowed characters in module identifiers\n */\nconst DISALLOWED_CHARACTERS = new Set(Object.keys(DisallowedModuleIdentifierCharacters))\n\n/**\n * Iterates over a string removing disallowed characters\n * @param xnsName The XNS name to remove disallowed characters from\n * @returns The XNS name with disallowed characters removed\n */\nexport const removeDisallowedCharacters = (xnsName: string): string => {\n // Create the initial result\n let result = ''\n // Iterate over each character in the XNS name\n for (const char of xnsName) {\n // If the character is not a disallowed character\n if (!DISALLOWED_CHARACTERS.has(char)) {\n // add it to the result\n result += char\n }\n }\n // Return the result which contains only allowed characters\n return result\n}\n"],"mappings":";AAAA,SAAS,cAAc;AACvB,SAA4B,sBAAsB;AAClD;AAAA,EAC0B;AAAA,EACxB;AAAA,OACK;AACP,SAAS,sBAAsB;AAI/B;AAAA,EAEgC;AAAA,EAA+B;AAAA,OACxD;AAOA,IAAM,uBAAuB,OAAO,aAAoD;AAC7F,MAAI,CAAC,SAAU,QAAO,CAAC;AACvB,QAAM,MAAM,SAET,OAAO,cAAc,EAErB,OAAO,mBAAmB,KAAK,CAAC;AACnC,MAAI,IAAI,WAAW,EAAG,QAAO,CAAC;AAC9B,QAAM,UAAU,MAAM,eAAe,aAAa,QAAQ;AAC1D,SAAO,IAAI,IAAgC,CAAC,OAAO;AACjD,UAAM,oBAAoB;AAAA,MACxB;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,IACF;AACA,QAAI,CAAC,kBAAmB;AACxB,UAAM,cAAc;AAAA,MAClB;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,IACF;AACA,QAAI,CAAC,YAAa;AAClB,WAAO,CAAC,IAAI,mBAAmB,WAAW;AAAA,EAC5C,CAAC,EAAE,OAAO,MAAM;AAClB;AAOA,IAAM,sBAAsB,CAAC,OAA8B;AACzD,SAAO,GAAG,gBAAgB,SAAS,6BAA6B,KAC3D,GAAG,gBAAgB,SAAS,uBAAuB;AAC1D;AAUA,IAAM,qCAAqC,CACzC,IACA,QACA,SACA,aAC4B;AAC5B,QAAM,cAAc,GAAG,gBAAgB,QAAQ,MAAM;AACrD,MAAI,gBAAgB,GAAI;AACxB,QAAM,OAAO,GAAG,eAAe,WAAW;AAC1C,SAAO,CAAC,QAAQ,IAAI,CAAC,EAAE,OAAO,MAAM,EAAE,KAAK,QAAQ;AACrD;;;AC5EA,SAAS,gBAAgB;AACzB,SAAS,cAAc;AAIvB,SAAS,oBAAoB;;;ACLtB,IAAM,oBAAoB;AAC1B,IAAM,oBAAoB;;;ACE1B,IAAM,oCAAoC,CAC/C,oBACqD;AACrD,SAAO,CAAC,YAAmC;AACzC,UAAM,EAAE,OAAO,IAAI;AAEnB,QAAI,gBAAgB,SAAS,MAAM,GAAG;AACpC,cAAQ,IAAI,eAAe;AAC3B,aAAO;AAAA,IACT;AACA,WAAO;AAAA,EACT;AACF;AAEO,IAAM,sCAAsC,CACjD,sBACqD;AACrD,SAAO,CAAC,YAAmC;AACzC,UAAM,EAAE,OAAO,IAAI;AAEnB,eAAW,YAAY,mBAAmB;AACxC,UAAI,OAAO,SAAS,QAAQ,GAAG;AAC7B,gBAAQ,IAAI,wBAAwB;AACpC,eAAO;AAAA,MACT;AAAA,IACF;AACA,WAAO;AAAA,EACT;AACF;AAEO,IAAM,kCAAkC,CAAC,kBAA8E;AAC5H,SAAO,CAAC,YAAmC;AACzC,UAAM,EAAE,OAAO,IAAI;AAEnB,eAAW,YAAY,eAAe;AACpC,YAAM,QAAQ,SAAS,MAAM,GAAG;AAChC,UAAI,WAAW,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,WAAW,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC,CAAC,EAAE,KAAK,EAAE,GAAG;AACxF,gBAAQ,IAAI,eAAe;AAC3B,eAAO;AAAA,MACT;AAAA,IACF;AACA,WAAO;AAAA,EACT;AACF;;;AC9CA,SAAS,oBAAoB;AAQtB,IAAM,wBAAmF,CAC9F,SACA,aACG;AACH,QAAM,EAAE,OAAO,IAAI;AAEnB,MAAI,OAAO,YAAY,MAAM,QAAQ;AACnC,eAAW,CAAC,wBAAwB,CAAC;AACrC,WAAO;AAAA,EACT;AACA,SAAO;AACT;AAEO,IAAM,4BAAuF,CAClG,SACA,aACG;AACH,QAAM,EAAE,OAAO,IAAI;AAGnB,MAAI,CAAC,aAAa,MAAM,GAAG;AACzB,eAAW,CAAC,sCAAsC,MAAM,EAAE,CAAC;AAC3D,WAAO;AAAA,EACT;AAEA,SAAO;AACT;AAEO,IAAM,qBAAgF,CAC3F,SACA,aACG;AACH,QAAM,EAAE,IAAI,IAAI;AAChB,QAAM,gBAA0B,CAAC;AAGjC,MAAI,IAAI,YAAY,MAAM,KAAK;AAC7B,kBAAc,KAAK,uBAAuB;AAAA,EAC5C;AAEA,MAAI,QAAQ,OAAO;AACjB,kBAAc,KAAK,kCAAkC;AAAA,EACvD;AACA,MAAI,cAAc,SAAS,GAAG;AAC5B,eAAW,aAAa;AACxB,WAAO;AAAA,EACT;AACA,SAAO;AACT;AAEO,IAAM,2BAA2B,CACtC,gBAAgB,mBAChB,YAAY,sBACkD;AAC9D,SAAO,CACL,SACA,aACG;AACH,UAAM,EAAE,OAAO,IAAI;AACnB,UAAM,gBAA0B,CAAC;AAGjC,QAAI,OAAO,SAAS,eAAe;AACjC,oBAAc,KAAK,yBAAyB,aAAa,aAAa;AAAA,IACxE;AAEA,QAAI,OAAO,SAAS,WAAW;AAC7B,oBAAc,KAAK,6BAA6B,SAAS,aAAa;AAAA,IACxE;AAEA,QAAI,cAAc,SAAS,GAAG;AAC5B,iBAAW,aAAa;AACxB,aAAO;AAAA,IACT;AAEA,WAAO;AAAA,EACT;AACF;AAEO,IAAM,mCAAmC,CAC9C,YAC8D;AAC9D,SAAO,CACL,SACA,aACG;AACH,UAAM,EAAE,OAAO,IAAI;AACnB,UAAM,EAAE,OAAO,IAAI,IAAI,WAAW,CAAC;AACnC,UAAM,gBAA0B,CAAC;AAEjC,QAAI,CAAC,SAAS,OAAO,WAAW,GAAG,GAAG;AACpC,oBAAc,KAAK,+BAA+B;AAAA,IACpD;AAEA,QAAI,CAAC,OAAO,OAAO,SAAS,GAAG,GAAG;AAChC,oBAAc,KAAK,6BAA6B;AAAA,IAClD;AAEA,QAAI,cAAc,SAAS,GAAG;AAC5B,iBAAW,aAAa;AACxB,aAAO;AAAA,IACT;AACA,WAAO;AAAA,EACT;AACF;AAEO,IAAM,0BAA0B;AAAA,EACrC;AAAA,EACA;AAAA,EACA;AAAA,EACA,yBAAyB;AAAA,EACzB,iCAAiC;AACnC;AAEO,IAAM,oCAAoC,CAAC,aAA0C;AAAA,EAC1F;AAAA,EACA;AAAA,EACA;AAAA,EACA,yBAAyB;AAAA,EACzB,iCAAiC;AACnC,EAAE,IAAI,eAAa,CAAC,YAAmC,UAAU,SAAS,QAAQ,CAAC;;;AChInF,SAAS,4CAA4C;AAKrD,IAAM,wBAAwB,IAAI,IAAI,OAAO,KAAK,oCAAoC,CAAC;AAOhF,IAAM,6BAA6B,CAAC,YAA4B;AAErE,MAAI,SAAS;AAEb,aAAW,QAAQ,SAAS;AAE1B,QAAI,CAAC,sBAAsB,IAAI,IAAI,GAAG;AAEpC,gBAAU;AAAA,IACZ;AAAA,EACF;AAEA,SAAO;AACT;;;AJdA,IAAM,qBAAqB,EAAE,qBAAqB,MAAM;AAEjD,IAAM,gBAAN,MAAM,eAAc;AAAA,EACzB,OAAO,YAAY,CAAC,MAAM;AAAA,EAElB;AAAA,EAEA,YAAY,SAAgC;AAClD,SAAK,WAAW;AAAA,EAClB;AAAA,EAEA,IAAI,SAAS;AACX,WAAO,SAAS,KAAK,QAAQ,QAAQ,MAAM,6BAA6B;AAAA,EAC1E;AAAA,EAEA,IAAI,OAAO;AACT,WAAO,GAAG,KAAK,MAAM,IAAI,KAAK,GAAG;AAAA,EACnC;AAAA,EAEA,IAAI,MAAM;AACR,WAAO,SAAS,KAAK,QAAQ,KAAK,MAAM,0BAA0B;AAAA,EACpE;AAAA,EAEA,IAAI,UAAU;AACZ,WAAO,SAAS,KAAK,UAAU,MAAM,+BAA+B;AAAA,EACtE;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,OAAO,YAAY,QAA0D;AAC3E,WAAO,IAAI,eAAc,MAAM;AAAA,EACjC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,OAAO,WAAW,SAAgC;AAChD,UAAM,QAAQ,QAAQ,MAAM,GAAG;AAC/B,aAAS,MAAM,WAAW,GAAG,MAAM,yBAAyB;AAE5D,UAAM,SAAS,MAAM,CAAC;AACtB,UAAM,MAAM,MAAM,CAAC;AACnB,WAAO,IAAI,eAAc;AAAA,MACvB,QAAQ;AAAA,MAAc;AAAA,MAAQ;AAAA,IAChC,CAAC;AAAA,EACH;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,OAAO,yBAAyB,QAAmC;AACjE,QAAI,OAAO,MAAM,EAAG,QAAO;AAC3B,UAAM,UAAU,eAAc,UAAU,KAAK,SAAO,QAAQ,SAAS,GAAG,CAAC,IAAI,SAAS;AACtF,WAAO,UAAU,YAAY;AAAA,EAC/B;AAAA,EAEA,aAAa,QAAQ,QAAiD;AACpE,UAAM,UAAU,MAAM,QAAQ,IAAI,wBAAwB,IAAI,eAAa,UAAU,MAAM,CAAC,CAAC;AAC7F,eAAW,UAAU,SAAS;AAC5B,UAAI,CAAC,OAAQ,QAAO;AAAA,IACtB;AACA,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,OAAO,KAAK,KAAa,UAA4C,oBAA4B;AAE/F,QAAI,IAAI,SAAS,mBAAmB;AAClC,YAAM,IAAI,MAAM,yBAAyB,IAAI,MAAM,wBAAwB,iBAAiB,EAAE;AAAA,IAChG;AAGA,UAAM,mBAAmB,IAAI,YAAY;AAGzC,QAAI,mBAAmB,iBAAiB,WAAW,mBAAmB,EAAE;AAGxE,QAAI,QAAQ,oBAAqB,oBAAmB,iBAAiB,WAAW,YAAY,EAAE;AAG9F,WAAO,2BAA2B,gBAAgB;AAAA,EACpD;AAAA,EAEA,MAAM,WAAyC;AAC7C,UAAM,gBAA0B,CAAC;AACjC,UAAM,mBAAmB,CAAC,YAAsB,cAAc,KAAK,GAAG,OAAO;AAE7E,eAAW,aAAa,yBAAyB;AAC/C,YAAM,UAAU,KAAK,SAAS,gBAAgB;AAAA,IAChD;AAEA,QAAI,cAAc,SAAS,GAAG;AAC5B,aAAO,CAAC,OAAO,aAAa;AAAA,IAC9B;AAEA,WAAO,CAAC,MAAM,CAAC,CAAC;AAAA,EAClB;AACF;","names":[]}
1
+ {"version":3,"sources":["../../src/estimate/lib/parseDomainEstimates.ts","../../src/validation/name/Name.ts","../../src/validation/validation/Constants.ts","../../src/validation/validation/factory/validators.ts","../../src/validation/validation/validators/validators.ts","../../src/validation/name/lib/removeDisallowedCharacters.ts"],"sourcesContent":["import { exists } from '@xylabs/exists'\nimport { type BoundWitness, isBoundWitness } from '@xyo-network/boundwitness-model'\nimport {\n type HashLeaseEstimate, HashLeaseEstimateSchema,\n isHashLeaseEstimate,\n} from '@xyo-network/diviner-hash-lease'\nimport { PayloadBuilder } from '@xyo-network/payload-builder'\nimport type { Payload, WithSources } from '@xyo-network/payload-model'\nimport {\n type DomainEstimate,\n type DomainRegistrationLease, DomainRegistrationLeaseSchema, isDomainRegistrationLease,\n} from '@xyo-network/xns-record-payload-plugins'\n\n/**\n * Parses a generic array of payloads into estimates\n * @param payloads An array of payloads\n * @returns Parsed estimates\n */\nexport const parseDomainEstimates = async (payloads?: Payload[]): Promise<DomainEstimate[]> => {\n if (!payloads) return []\n const bws = payloads\n // Find all bound witnesses\n .filter(isBoundWitness)\n // that have the required estimate payloads\n .filter(hasEstimatePayloads) ?? []\n if (bws.length === 0) return []\n const hashMap = await PayloadBuilder.toAllHashMap(payloads)\n return bws.map<DomainEstimate | undefined>((bw) => {\n const hashLeaseEstimate = getPayloadBySchemaFromBoundWitness<WithSources<HashLeaseEstimate>>(\n bw,\n HashLeaseEstimateSchema,\n hashMap,\n isHashLeaseEstimate,\n )\n if (!hashLeaseEstimate) return\n const domainLease = getPayloadBySchemaFromBoundWitness<DomainRegistrationLease>(\n bw,\n DomainRegistrationLeaseSchema,\n hashMap,\n isDomainRegistrationLease,\n )\n if (!domainLease) return\n return [bw, hashLeaseEstimate, domainLease]\n }).filter(exists)\n}\n\n/**\n * Tests if a BoundWitness has the required estimate payloads\n * @param bw The BoundWitness to check for estimate payloads\n * @returns True if the BoundWitness has the required estimate payloads, false otherwise\n */\nconst hasEstimatePayloads = (bw: BoundWitness): boolean => {\n return bw.payload_schemas.includes(DomainRegistrationLeaseSchema)\n && bw.payload_schemas.includes(HashLeaseEstimateSchema)\n}\n\n/**\n * Finds the first instance of a payload in a BoundWitness by schema\n * @param bw The BoundWitness to extract the payload from\n * @param schema The schema of the payload to extract\n * @param hashMap The hashmap of the payloads\n * @param identity An identity function to check if the payload is of the correct type\n * @returns The payload if it exists or undefined\n */\nconst getPayloadBySchemaFromBoundWitness = <T extends Payload = Payload>(\n bw: BoundWitness,\n schema: string,\n hashMap: Awaited<ReturnType<typeof PayloadBuilder.toHashMap>>,\n identity: (payload: Payload) => payload is T,\n): T | undefined => {\n const schemaIndex = bw.payload_schemas.indexOf(schema)\n if (schemaIndex === -1) return\n const hash = bw.payload_hashes[schemaIndex]\n return [hashMap[hash]].filter(exists).find(identity)\n}\n","import { assertEx } from '@xylabs/assert'\nimport { isHash } from '@xylabs/hex'\nimport type { Promisable } from '@xylabs/promise'\nimport type { Payload } from '@xyo-network/payload-model'\nimport type { DomainFields, TopLevelDomain } from '@xyo-network/xns-record-payload-plugins'\nimport { DomainSchema } from '@xyo-network/xns-record-payload-plugins'\n\nimport { MAX_DOMAIN_LENGTH, XnsNameSimpleValidators } from '../validation/index.ts'\nimport { removeDisallowedCharacters } from './lib/index.ts'\nimport type { ValidSourceTypes } from './types/index.ts'\n\nconst defaultMaskOptions = { maskStartEndHyphens: false }\n\nexport class XnsNameHelper {\n static ValidTLDs = ['.xyo'] as const\n\n private _xnsName: Payload<DomainFields>\n\n private constructor(xnsName: Payload<DomainFields>) {\n this._xnsName = xnsName\n }\n\n get domain() {\n return assertEx(this.xnsName.domain, () => 'domain not found in payload')\n }\n\n get name() {\n return `${this.domain}.${this.tld}`\n }\n\n get tld() {\n return assertEx(this.xnsName.tld, () => 'tld not found in payload')\n }\n\n get xnsName() {\n return assertEx(this._xnsName, () => 'XnsNameHelper xnsName not set')\n }\n\n /**\n * Create an XnsNameHelper from a domain payload\n * @param {Domain} domain\n * @returns Promise<XnsNameHelper>\n */\n static fromPayload(domain: Payload<DomainFields>): Promisable<XnsNameHelper> {\n return new XnsNameHelper(domain)\n }\n\n /**\n * Create an XnsNameHelper from a string\n * @param {string} xnsName\n * @returns Promise<XnsNameHelper>\n */\n static fromString(xnsName: string): XnsNameHelper {\n const parts = xnsName.split('.')\n assertEx(parts.length === 2, () => 'Unable to parse xnsName')\n\n const domain = parts[0]\n const tld = parts[1] as TopLevelDomain\n return new XnsNameHelper({\n schema: DomainSchema, domain, tld,\n })\n }\n\n /**\n * Determine if a string is a valid XNS name or hash\n * @param {string} source?\n * @returns ValidSourceTypes\n */\n static isPotentialXnsNameOrHash(source?: string): ValidSourceTypes {\n if (isHash(source)) return 'hash'\n const xnsName = XnsNameHelper.ValidTLDs.some(tld => source?.endsWith(tld)) ? source : null\n return xnsName ? 'xnsName' : null\n }\n\n static async isValid(domain: Payload<DomainFields>): Promise<boolean> {\n const results = await Promise.all(XnsNameSimpleValidators.map(validator => validator(domain)))\n for (const result of results) {\n if (!result) return false\n }\n return true\n }\n\n /**\n * Mask a string to be a valid XNS name\n * @param {string} str\n * @returns string\n */\n static mask(str: string, options: { maskStartEndHyphens: boolean } = defaultMaskOptions): string {\n // Check if the domain name is too long\n if (str.length > MAX_DOMAIN_LENGTH) {\n throw new Error(`Domain name too long: ${str.length} exceeds max length: ${MAX_DOMAIN_LENGTH}`)\n }\n\n // convert to lowercase\n const lowercaseXnsName = str.toLowerCase()\n\n // Remove everything except letters, numbers, and dashes\n let formattedXnsName = lowercaseXnsName.replaceAll(/[^\\dA-Za-z-]+$/g, '')\n\n // Remove leading and trailing dashes\n if (options.maskStartEndHyphens) formattedXnsName = formattedXnsName.replaceAll(/^-+|-+$/g, '')\n\n // Filter out disallowed characters.\n return removeDisallowedCharacters(formattedXnsName)\n }\n\n async validate(): Promise<[boolean, string[]]> {\n const errorMessages: string[] = []\n const onErrorsInternal = (message: string[]) => errorMessages.push(...message)\n\n for (const validator of XnsNameSimpleValidators) {\n await validator(this.xnsName, onErrorsInternal)\n }\n\n if (errorMessages.length > 0) {\n return [false, errorMessages]\n }\n\n return [true, []]\n }\n}\n","export const MIN_DOMAIN_LENGTH = 3\nexport const MAX_DOMAIN_LENGTH = 128\n","import type { Payload, PayloadValidationFunction } from '@xyo-network/payload-model'\nimport type { DomainFields } from '@xyo-network/xns-record-payload-plugins'\n\nexport const getDomainReservedStringsValidator = (\n reservedStrings: string[],\n): PayloadValidationFunction<Payload<DomainFields>> => {\n return (payload: Payload<DomainFields>) => {\n const { domain } = payload\n // Check if in one of the reserved name lists\n if (reservedStrings.includes(domain)) {\n console.log('Reserved name')\n return false\n }\n return true\n }\n}\n\nexport const getDomainReservedFragmentsValidator = (\n reservedFragments: string[],\n): PayloadValidationFunction<Payload<DomainFields>> => {\n return (payload: Payload<DomainFields>) => {\n const { domain } = payload\n // Check if any of our fragments are in the name\n for (const reserved of reservedFragments) {\n if (domain.includes(reserved)) {\n console.log('Reserved name fragment')\n return false\n }\n }\n return true\n }\n}\n\nexport const getDomainReservedNamesValidator = (reservedNames: string[]): PayloadValidationFunction<Payload<DomainFields>> => {\n return (payload: Payload<DomainFields>) => {\n const { domain } = payload\n // Check if any of our fragments are in the name\n for (const reserved of reservedNames) {\n const parts = reserved.split(' ')\n if (domain === [parts[1], parts[0]].join('') || domain === [parts[0], parts[1]].join('')) {\n console.log('Reserved name')\n return false\n }\n }\n return true\n }\n}\n","import { isModuleName } from '@xyo-network/module-model'\nimport type { Payload } from '@xyo-network/payload-model'\nimport type { DomainFields } from '@xyo-network/xns-record-payload-plugins'\n\nimport { MAX_DOMAIN_LENGTH, MIN_DOMAIN_LENGTH } from '../Constants.ts'\n\nexport type PayloadValidationFunctionWithError<T extends Payload = Payload> = (payload: T, onErrors?: (message: string[]) => void) => boolean | Promise<boolean>\n\nexport const domainCasingValidator: PayloadValidationFunctionWithError<Payload<DomainFields>> = (\n payload: Payload<DomainFields>,\n onErrors?: (message: string[]) => void,\n) => {\n const { domain } = payload\n // Check if all lowercase\n if (domain.toLowerCase() !== domain) {\n onErrors?.(['name must be lowercase'])\n return false\n }\n return true\n}\n\nexport const domainModuleNameValidator: PayloadValidationFunctionWithError<Payload<DomainFields>> = (\n payload: Payload<DomainFields>,\n onErrors?: (message: string[]) => void,\n) => {\n const { domain } = payload\n\n // check if domain is a valid name\n if (!isModuleName(domain)) {\n onErrors?.([`Domain is not a valid module name: ${domain}`])\n return false\n }\n\n return true\n}\n\nexport const domainTldValidator: PayloadValidationFunctionWithError<Payload<DomainFields>> = (\n payload: Payload<DomainFields>,\n onErrors?: (message: string[]) => void,\n) => {\n const { tld } = payload\n const errorMessages: string[] = []\n\n // Check if all lowercase\n if (tld.toLowerCase() !== tld) {\n errorMessages.push('TLD must be lowercase')\n }\n // Check if supported TLDs\n if (tld !== 'xyo') {\n errorMessages.push('Only XYO TLD currently supported')\n }\n if (errorMessages.length > 0) {\n onErrors?.(errorMessages)\n return false\n }\n return true\n}\n\nexport const getDomainLengthValidator = (\n minNameLength = MIN_DOMAIN_LENGTH,\n maxLength = MAX_DOMAIN_LENGTH,\n): PayloadValidationFunctionWithError<Payload<DomainFields>> => {\n return (\n payload: Payload<DomainFields>,\n onErrors?: (message: string[]) => void,\n ) => {\n const { domain } = payload\n const errorMessages: string[] = []\n\n // Check if min length\n if (domain.length < minNameLength) {\n errorMessages.push(`name must be at least ${minNameLength} characters`)\n }\n\n if (domain.length > maxLength) {\n errorMessages.push(`name must be no more than ${maxLength} characters`)\n }\n\n if (errorMessages.length > 0) {\n onErrors?.(errorMessages)\n return false\n }\n\n return true\n }\n}\n\nexport const getDomainAllowedHyphensValidator = (\n options?: { end?: boolean; start?: boolean },\n): PayloadValidationFunctionWithError<Payload<DomainFields>> => {\n return (\n payload: Payload<DomainFields>,\n onErrors?: (message: string[]) => void,\n ) => {\n const { domain } = payload\n const { start, end } = options ?? {}\n const errorMessages: string[] = []\n\n if (!start && domain.startsWith('-')) {\n errorMessages.push('name cannot start with hyphen')\n }\n\n if (!end && domain.endsWith('-')) {\n errorMessages.push('name cannot end with hyphen')\n }\n\n if (errorMessages.length > 0) {\n onErrors?.(errorMessages)\n return false\n }\n return true\n }\n}\n\nexport const XnsNameSimpleValidators = [\n domainCasingValidator,\n domainModuleNameValidator,\n domainTldValidator,\n getDomainLengthValidator(),\n getDomainAllowedHyphensValidator(),\n]\n\nexport const XnsNameSimpleValidatorsWithErrors = (onErrors: (message: string[]) => void) => [\n domainCasingValidator,\n domainModuleNameValidator,\n domainTldValidator,\n getDomainLengthValidator(),\n getDomainAllowedHyphensValidator(),\n].map(validator => (payload: Payload<DomainFields>) => validator(payload, onErrors))\n","import { DisallowedModuleIdentifierCharacters } from '@xyo-network/module-model'\n\n/**\n * A set of all the disallowed characters in module identifiers\n */\nconst DISALLOWED_CHARACTERS = new Set(Object.keys(DisallowedModuleIdentifierCharacters))\n\n/**\n * Iterates over a string removing disallowed characters\n * @param xnsName The XNS name to remove disallowed characters from\n * @returns The XNS name with disallowed characters removed\n */\nexport const removeDisallowedCharacters = (xnsName: string): string => {\n // Create the initial result\n let result = ''\n // Iterate over each character in the XNS name\n for (const char of xnsName) {\n // If the character is not a disallowed character\n if (!DISALLOWED_CHARACTERS.has(char)) {\n // add it to the result\n result += char\n }\n }\n // Return the result which contains only allowed characters\n return result\n}\n"],"mappings":";AAAA,SAAS,cAAc;AACvB,SAA4B,sBAAsB;AAClD;AAAA,EAC0B;AAAA,EACxB;AAAA,OACK;AACP,SAAS,sBAAsB;AAE/B;AAAA,EAEgC;AAAA,EAA+B;AAAA,OACxD;AAOA,IAAM,uBAAuB,OAAO,aAAoD;AAC7F,MAAI,CAAC,SAAU,QAAO,CAAC;AACvB,QAAM,MAAM,SAET,OAAO,cAAc,EAErB,OAAO,mBAAmB,KAAK,CAAC;AACnC,MAAI,IAAI,WAAW,EAAG,QAAO,CAAC;AAC9B,QAAM,UAAU,MAAM,eAAe,aAAa,QAAQ;AAC1D,SAAO,IAAI,IAAgC,CAAC,OAAO;AACjD,UAAM,oBAAoB;AAAA,MACxB;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,IACF;AACA,QAAI,CAAC,kBAAmB;AACxB,UAAM,cAAc;AAAA,MAClB;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,IACF;AACA,QAAI,CAAC,YAAa;AAClB,WAAO,CAAC,IAAI,mBAAmB,WAAW;AAAA,EAC5C,CAAC,EAAE,OAAO,MAAM;AAClB;AAOA,IAAM,sBAAsB,CAAC,OAA8B;AACzD,SAAO,GAAG,gBAAgB,SAAS,6BAA6B,KAC3D,GAAG,gBAAgB,SAAS,uBAAuB;AAC1D;AAUA,IAAM,qCAAqC,CACzC,IACA,QACA,SACA,aACkB;AAClB,QAAM,cAAc,GAAG,gBAAgB,QAAQ,MAAM;AACrD,MAAI,gBAAgB,GAAI;AACxB,QAAM,OAAO,GAAG,eAAe,WAAW;AAC1C,SAAO,CAAC,QAAQ,IAAI,CAAC,EAAE,OAAO,MAAM,EAAE,KAAK,QAAQ;AACrD;;;AC1EA,SAAS,gBAAgB;AACzB,SAAS,cAAc;AAIvB,SAAS,oBAAoB;;;ACLtB,IAAM,oBAAoB;AAC1B,IAAM,oBAAoB;;;ACE1B,IAAM,oCAAoC,CAC/C,oBACqD;AACrD,SAAO,CAAC,YAAmC;AACzC,UAAM,EAAE,OAAO,IAAI;AAEnB,QAAI,gBAAgB,SAAS,MAAM,GAAG;AACpC,cAAQ,IAAI,eAAe;AAC3B,aAAO;AAAA,IACT;AACA,WAAO;AAAA,EACT;AACF;AAEO,IAAM,sCAAsC,CACjD,sBACqD;AACrD,SAAO,CAAC,YAAmC;AACzC,UAAM,EAAE,OAAO,IAAI;AAEnB,eAAW,YAAY,mBAAmB;AACxC,UAAI,OAAO,SAAS,QAAQ,GAAG;AAC7B,gBAAQ,IAAI,wBAAwB;AACpC,eAAO;AAAA,MACT;AAAA,IACF;AACA,WAAO;AAAA,EACT;AACF;AAEO,IAAM,kCAAkC,CAAC,kBAA8E;AAC5H,SAAO,CAAC,YAAmC;AACzC,UAAM,EAAE,OAAO,IAAI;AAEnB,eAAW,YAAY,eAAe;AACpC,YAAM,QAAQ,SAAS,MAAM,GAAG;AAChC,UAAI,WAAW,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,WAAW,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC,CAAC,EAAE,KAAK,EAAE,GAAG;AACxF,gBAAQ,IAAI,eAAe;AAC3B,eAAO;AAAA,MACT;AAAA,IACF;AACA,WAAO;AAAA,EACT;AACF;;;AC9CA,SAAS,oBAAoB;AAQtB,IAAM,wBAAmF,CAC9F,SACA,aACG;AACH,QAAM,EAAE,OAAO,IAAI;AAEnB,MAAI,OAAO,YAAY,MAAM,QAAQ;AACnC,eAAW,CAAC,wBAAwB,CAAC;AACrC,WAAO;AAAA,EACT;AACA,SAAO;AACT;AAEO,IAAM,4BAAuF,CAClG,SACA,aACG;AACH,QAAM,EAAE,OAAO,IAAI;AAGnB,MAAI,CAAC,aAAa,MAAM,GAAG;AACzB,eAAW,CAAC,sCAAsC,MAAM,EAAE,CAAC;AAC3D,WAAO;AAAA,EACT;AAEA,SAAO;AACT;AAEO,IAAM,qBAAgF,CAC3F,SACA,aACG;AACH,QAAM,EAAE,IAAI,IAAI;AAChB,QAAM,gBAA0B,CAAC;AAGjC,MAAI,IAAI,YAAY,MAAM,KAAK;AAC7B,kBAAc,KAAK,uBAAuB;AAAA,EAC5C;AAEA,MAAI,QAAQ,OAAO;AACjB,kBAAc,KAAK,kCAAkC;AAAA,EACvD;AACA,MAAI,cAAc,SAAS,GAAG;AAC5B,eAAW,aAAa;AACxB,WAAO;AAAA,EACT;AACA,SAAO;AACT;AAEO,IAAM,2BAA2B,CACtC,gBAAgB,mBAChB,YAAY,sBACkD;AAC9D,SAAO,CACL,SACA,aACG;AACH,UAAM,EAAE,OAAO,IAAI;AACnB,UAAM,gBAA0B,CAAC;AAGjC,QAAI,OAAO,SAAS,eAAe;AACjC,oBAAc,KAAK,yBAAyB,aAAa,aAAa;AAAA,IACxE;AAEA,QAAI,OAAO,SAAS,WAAW;AAC7B,oBAAc,KAAK,6BAA6B,SAAS,aAAa;AAAA,IACxE;AAEA,QAAI,cAAc,SAAS,GAAG;AAC5B,iBAAW,aAAa;AACxB,aAAO;AAAA,IACT;AAEA,WAAO;AAAA,EACT;AACF;AAEO,IAAM,mCAAmC,CAC9C,YAC8D;AAC9D,SAAO,CACL,SACA,aACG;AACH,UAAM,EAAE,OAAO,IAAI;AACnB,UAAM,EAAE,OAAO,IAAI,IAAI,WAAW,CAAC;AACnC,UAAM,gBAA0B,CAAC;AAEjC,QAAI,CAAC,SAAS,OAAO,WAAW,GAAG,GAAG;AACpC,oBAAc,KAAK,+BAA+B;AAAA,IACpD;AAEA,QAAI,CAAC,OAAO,OAAO,SAAS,GAAG,GAAG;AAChC,oBAAc,KAAK,6BAA6B;AAAA,IAClD;AAEA,QAAI,cAAc,SAAS,GAAG;AAC5B,iBAAW,aAAa;AACxB,aAAO;AAAA,IACT;AACA,WAAO;AAAA,EACT;AACF;AAEO,IAAM,0BAA0B;AAAA,EACrC;AAAA,EACA;AAAA,EACA;AAAA,EACA,yBAAyB;AAAA,EACzB,iCAAiC;AACnC;AAEO,IAAM,oCAAoC,CAAC,aAA0C;AAAA,EAC1F;AAAA,EACA;AAAA,EACA;AAAA,EACA,yBAAyB;AAAA,EACzB,iCAAiC;AACnC,EAAE,IAAI,eAAa,CAAC,YAAmC,UAAU,SAAS,QAAQ,CAAC;;;AChInF,SAAS,4CAA4C;AAKrD,IAAM,wBAAwB,IAAI,IAAI,OAAO,KAAK,oCAAoC,CAAC;AAOhF,IAAM,6BAA6B,CAAC,YAA4B;AAErE,MAAI,SAAS;AAEb,aAAW,QAAQ,SAAS;AAE1B,QAAI,CAAC,sBAAsB,IAAI,IAAI,GAAG;AAEpC,gBAAU;AAAA,IACZ;AAAA,EACF;AAEA,SAAO;AACT;;;AJdA,IAAM,qBAAqB,EAAE,qBAAqB,MAAM;AAEjD,IAAM,gBAAN,MAAM,eAAc;AAAA,EACzB,OAAO,YAAY,CAAC,MAAM;AAAA,EAElB;AAAA,EAEA,YAAY,SAAgC;AAClD,SAAK,WAAW;AAAA,EAClB;AAAA,EAEA,IAAI,SAAS;AACX,WAAO,SAAS,KAAK,QAAQ,QAAQ,MAAM,6BAA6B;AAAA,EAC1E;AAAA,EAEA,IAAI,OAAO;AACT,WAAO,GAAG,KAAK,MAAM,IAAI,KAAK,GAAG;AAAA,EACnC;AAAA,EAEA,IAAI,MAAM;AACR,WAAO,SAAS,KAAK,QAAQ,KAAK,MAAM,0BAA0B;AAAA,EACpE;AAAA,EAEA,IAAI,UAAU;AACZ,WAAO,SAAS,KAAK,UAAU,MAAM,+BAA+B;AAAA,EACtE;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,OAAO,YAAY,QAA0D;AAC3E,WAAO,IAAI,eAAc,MAAM;AAAA,EACjC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,OAAO,WAAW,SAAgC;AAChD,UAAM,QAAQ,QAAQ,MAAM,GAAG;AAC/B,aAAS,MAAM,WAAW,GAAG,MAAM,yBAAyB;AAE5D,UAAM,SAAS,MAAM,CAAC;AACtB,UAAM,MAAM,MAAM,CAAC;AACnB,WAAO,IAAI,eAAc;AAAA,MACvB,QAAQ;AAAA,MAAc;AAAA,MAAQ;AAAA,IAChC,CAAC;AAAA,EACH;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,OAAO,yBAAyB,QAAmC;AACjE,QAAI,OAAO,MAAM,EAAG,QAAO;AAC3B,UAAM,UAAU,eAAc,UAAU,KAAK,SAAO,QAAQ,SAAS,GAAG,CAAC,IAAI,SAAS;AACtF,WAAO,UAAU,YAAY;AAAA,EAC/B;AAAA,EAEA,aAAa,QAAQ,QAAiD;AACpE,UAAM,UAAU,MAAM,QAAQ,IAAI,wBAAwB,IAAI,eAAa,UAAU,MAAM,CAAC,CAAC;AAC7F,eAAW,UAAU,SAAS;AAC5B,UAAI,CAAC,OAAQ,QAAO;AAAA,IACtB;AACA,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,OAAO,KAAK,KAAa,UAA4C,oBAA4B;AAE/F,QAAI,IAAI,SAAS,mBAAmB;AAClC,YAAM,IAAI,MAAM,yBAAyB,IAAI,MAAM,wBAAwB,iBAAiB,EAAE;AAAA,IAChG;AAGA,UAAM,mBAAmB,IAAI,YAAY;AAGzC,QAAI,mBAAmB,iBAAiB,WAAW,mBAAmB,EAAE;AAGxE,QAAI,QAAQ,oBAAqB,oBAAmB,iBAAiB,WAAW,YAAY,EAAE;AAG9F,WAAO,2BAA2B,gBAAgB;AAAA,EACpD;AAAA,EAEA,MAAM,WAAyC;AAC7C,UAAM,gBAA0B,CAAC;AACjC,UAAM,mBAAmB,CAAC,YAAsB,cAAc,KAAK,GAAG,OAAO;AAE7E,eAAW,aAAa,yBAAyB;AAC/C,YAAM,UAAU,KAAK,SAAS,gBAAgB;AAAA,IAChD;AAEA,QAAI,cAAc,SAAS,GAAG;AAC5B,aAAO,CAAC,OAAO,aAAa;AAAA,IAC9B;AAEA,WAAO,CAAC,MAAM,CAAC,CAAC;AAAA,EAClB;AACF;","names":[]}
@@ -12,10 +12,30 @@ export declare class XnsNameHelper {
12
12
  get xnsName(): import("@xyo-network/payload-model").SchemaFields & import("@xyo-network/payload-model").PayloadFields & DomainFields & {
13
13
  schema: import("@xyo-network/payload-model").Schema;
14
14
  };
15
+ /**
16
+ * Create an XnsNameHelper from a domain payload
17
+ * @param {Domain} domain
18
+ * @returns Promise<XnsNameHelper>
19
+ */
15
20
  static fromPayload(domain: Payload<DomainFields>): Promisable<XnsNameHelper>;
21
+ /**
22
+ * Create an XnsNameHelper from a string
23
+ * @param {string} xnsName
24
+ * @returns Promise<XnsNameHelper>
25
+ */
16
26
  static fromString(xnsName: string): XnsNameHelper;
27
+ /**
28
+ * Determine if a string is a valid XNS name or hash
29
+ * @param {string} source?
30
+ * @returns ValidSourceTypes
31
+ */
17
32
  static isPotentialXnsNameOrHash(source?: string): ValidSourceTypes;
18
33
  static isValid(domain: Payload<DomainFields>): Promise<boolean>;
34
+ /**
35
+ * Mask a string to be a valid XNS name
36
+ * @param {string} str
37
+ * @returns string
38
+ */
19
39
  static mask(str: string, options?: {
20
40
  maskStartEndHyphens: boolean;
21
41
  }): string;
@@ -1 +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"}
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;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"}
@@ -1,2 +1,7 @@
1
+ /**
2
+ * Iterates over a string removing disallowed characters
3
+ * @param xnsName The XNS name to remove disallowed characters from
4
+ * @returns The XNS name with disallowed characters removed
5
+ */
1
6
  export declare const removeDisallowedCharacters: (xnsName: string) => string;
2
7
  //# sourceMappingURL=removeDisallowedCharacters.d.ts.map
@@ -1 +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"}
1
+ {"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 CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@xyo-network/xns-record-payloadset-plugins",
3
- "version": "3.1.1",
3
+ "version": "3.2.0-rc.1",
4
4
  "description": "Typescript/Javascript Plugins for XYO Platform",
5
5
  "homepage": "https://xyo.network",
6
6
  "bugs": {
@@ -29,23 +29,26 @@
29
29
  "module": "dist/neutral/index.mjs",
30
30
  "types": "dist/neutral/index.d.ts",
31
31
  "dependencies": {
32
- "@xylabs/assert": "^4.1.0",
33
- "@xylabs/exists": "^4.1.0",
34
- "@xylabs/hex": "^4.1.0",
35
- "@xylabs/promise": "^4.1.0",
36
- "@xyo-network/boundwitness-model": "^3.2.0",
37
- "@xyo-network/diviner-hash-lease": "^3.2.0",
38
- "@xyo-network/module-model": "^3.2.0",
39
- "@xyo-network/payload-builder": "^3.2.0",
40
- "@xyo-network/payload-model": "^3.2.0",
41
- "@xyo-network/xns-record-payload-plugins": "^3.1.1"
32
+ "@xylabs/assert": "^4.4.12",
33
+ "@xylabs/exists": "^4.4.12",
34
+ "@xylabs/hex": "^4.4.12",
35
+ "@xylabs/promise": "^4.4.12",
36
+ "@xyo-network/boundwitness-model": "^3.6.0-rc.1",
37
+ "@xyo-network/diviner-hash-lease": "^3.6.0-rc.1",
38
+ "@xyo-network/module-model": "^3.6.0-rc.1",
39
+ "@xyo-network/payload-builder": "^3.6.0-rc.1",
40
+ "@xyo-network/payload-model": "^3.6.0-rc.1",
41
+ "@xyo-network/xns-record-payload-plugins": "^3.2.0-rc.1"
42
42
  },
43
43
  "devDependencies": {
44
- "@xylabs/ts-scripts-yarn3": "^4.1.0",
45
- "@xylabs/tsconfig": "^4.1.0",
46
- "typescript": "^5.6.3"
44
+ "@xylabs/ts-scripts-yarn3": "^4.2.4",
45
+ "@xylabs/tsconfig": "^4.2.4",
46
+ "@xylabs/vitest-extended": "^4.4.12",
47
+ "typescript": "^5.7.2",
48
+ "vitest": "^2.1.8"
47
49
  },
48
50
  "publishConfig": {
49
51
  "access": "public"
50
- }
52
+ },
53
+ "stableVersion": "3.1.2"
51
54
  }
@@ -2,15 +2,13 @@ import { exists } from '@xylabs/exists'
2
2
  import { type BoundWitness, isBoundWitness } from '@xyo-network/boundwitness-model'
3
3
  import {
4
4
  type HashLeaseEstimate, HashLeaseEstimateSchema,
5
- isHashLeaseEstimateWithMeta,
5
+ isHashLeaseEstimate,
6
6
  } from '@xyo-network/diviner-hash-lease'
7
7
  import { PayloadBuilder } from '@xyo-network/payload-builder'
8
- import type {
9
- Payload, WithMeta, WithSources,
10
- } from '@xyo-network/payload-model'
8
+ import type { Payload, WithSources } from '@xyo-network/payload-model'
11
9
  import {
12
10
  type DomainEstimate,
13
- type DomainRegistrationLease, DomainRegistrationLeaseSchema, isDomainRegistrationLeaseWithMeta,
11
+ type DomainRegistrationLease, DomainRegistrationLeaseSchema, isDomainRegistrationLease,
14
12
  } from '@xyo-network/xns-record-payload-plugins'
15
13
 
16
14
  /**
@@ -32,14 +30,14 @@ export const parseDomainEstimates = async (payloads?: Payload[]): Promise<Domain
32
30
  bw,
33
31
  HashLeaseEstimateSchema,
34
32
  hashMap,
35
- isHashLeaseEstimateWithMeta,
33
+ isHashLeaseEstimate,
36
34
  )
37
35
  if (!hashLeaseEstimate) return
38
36
  const domainLease = getPayloadBySchemaFromBoundWitness<DomainRegistrationLease>(
39
37
  bw,
40
38
  DomainRegistrationLeaseSchema,
41
39
  hashMap,
42
- isDomainRegistrationLeaseWithMeta,
40
+ isDomainRegistrationLease,
43
41
  )
44
42
  if (!domainLease) return
45
43
  return [bw, hashLeaseEstimate, domainLease]
@@ -68,8 +66,8 @@ const getPayloadBySchemaFromBoundWitness = <T extends Payload = Payload>(
68
66
  bw: BoundWitness,
69
67
  schema: string,
70
68
  hashMap: Awaited<ReturnType<typeof PayloadBuilder.toHashMap>>,
71
- identity: (payload: Payload) => payload is WithMeta<T>,
72
- ): WithMeta<T> | undefined => {
69
+ identity: (payload: Payload) => payload is T,
70
+ ): T | undefined => {
73
71
  const schemaIndex = bw.payload_schemas.indexOf(schema)
74
72
  if (schemaIndex === -1) return
75
73
  const hash = bw.payload_hashes[schemaIndex]
@@ -0,0 +1,287 @@
1
+ interface ExpectationResult {
2
+ actual?: unknown
3
+ expected?: unknown
4
+ message: () => string
5
+ pass: boolean
6
+ }
7
+
8
+ function toBeType(received: unknown, expectedType: string): ExpectationResult {
9
+ const pass = typeof received === expectedType && !Number.isNaN(received)
10
+ return pass
11
+ ? {
12
+ message: () => `expected ${received} not to be a ${expectedType}`,
13
+ pass: true,
14
+ }
15
+ : {
16
+ message: () => `expected ${received} to be a ${expectedType}`,
17
+ pass: false,
18
+ }
19
+ }
20
+
21
+ export const matchers = {
22
+ toBeArrayOfSize(received: unknown, expectedSize: number): ExpectationResult {
23
+ const pass = Array.isArray(received) && received.length === expectedSize
24
+ return pass
25
+ ? {
26
+ message: () => `expected array not to have size ${expectedSize}, but received array of size ${received.length}`,
27
+ pass: true,
28
+ }
29
+ : {
30
+ message: () => Array.isArray(received)
31
+ ? `expected array of size ${expectedSize}, but received array of size ${received.length}`
32
+ : `expected array of size ${expectedSize}, but received a non-array`,
33
+ pass: false,
34
+ }
35
+ },
36
+ toBeArray(received: unknown): ExpectationResult {
37
+ const pass = Array.isArray(received)
38
+ return pass
39
+ ? {
40
+ message: () => 'expected array',
41
+ pass: true,
42
+ }
43
+ : {
44
+ message: () => `expected array, but received ${typeof received}`,
45
+ pass: false,
46
+ }
47
+ },
48
+ toBeOneOf(received: unknown, expected: unknown[]): ExpectationResult {
49
+ const pass = expected.includes(received)
50
+ return pass
51
+ ? {
52
+ pass: true,
53
+ message: () =>
54
+ `expected ${received} not to be one of ${JSON.stringify(expected)}`,
55
+ }
56
+ : {
57
+ pass: false,
58
+ message: () =>
59
+ `expected ${received} to be one of ${JSON.stringify(expected)}`,
60
+ }
61
+ },
62
+ toBeNegative(received: number): ExpectationResult {
63
+ if (typeof received !== 'number') {
64
+ throw new TypeError(`Expected a number, but received ${typeof received}`)
65
+ }
66
+
67
+ const pass = received < 0
68
+ return pass
69
+ ? {
70
+ pass: true,
71
+ message: () =>
72
+ `expected ${received} not to be negative`,
73
+ }
74
+ : {
75
+ pass: false,
76
+ message: () =>
77
+ `expected ${received} to be negative`,
78
+ }
79
+ },
80
+ toBePositive(received: number): ExpectationResult {
81
+ if (typeof received !== 'number') {
82
+ throw new TypeError(`Expected a number, but received ${typeof received}`)
83
+ }
84
+
85
+ const pass = received > 0
86
+ return pass
87
+ ? {
88
+ pass: true,
89
+ message: () =>
90
+ `expected ${received} not to be positive`,
91
+ }
92
+ : {
93
+ pass: false,
94
+ message: () =>
95
+ `expected ${received} to be positive`,
96
+ }
97
+ },
98
+ toBeNumber: (received: unknown) => toBeType(received, 'number'),
99
+ toBeFunction: (received: unknown) => toBeType(received, 'function'),
100
+ toBeString: (received: unknown) => toBeType(received, 'string'),
101
+ toBeObject(received: unknown): ExpectationResult {
102
+ const pass = typeof received === 'object' && !Array.isArray(received) && received !== null
103
+ return pass
104
+ ? {
105
+ message: () => `expected ${received} to be object`,
106
+ pass: true,
107
+ }
108
+ : {
109
+ message: () => `expected ${received} to be an object but was ${Array.isArray(received) ? 'array' : typeof received}`,
110
+ pass: false,
111
+ }
112
+ },
113
+ toBeInteger(received: number): ExpectationResult {
114
+ if (typeof received !== 'number') {
115
+ throw new TypeError(`Expected a number, but received ${typeof received}`)
116
+ }
117
+
118
+ const pass = Number.isInteger(received)
119
+ return pass
120
+ ? {
121
+ pass: true,
122
+ message: () =>
123
+ `expected ${received} not to be an integer`,
124
+ }
125
+ : {
126
+ pass: false,
127
+ message: () =>
128
+ `expected ${received} to be an integer`,
129
+ }
130
+ },
131
+ toBeFalse(received: unknown): ExpectationResult {
132
+ const pass = received === false
133
+ return pass
134
+ ? {
135
+ message: () => `expected ${received} to be false`,
136
+ pass: true,
137
+ }
138
+ : {
139
+ message: () => `expected ${received} to be false but was not false`,
140
+ pass: false,
141
+ }
142
+ },
143
+ toBeTrue(received: unknown): ExpectationResult {
144
+ const pass = received === true
145
+ return pass
146
+ ? {
147
+ message: () => `expected ${received} to be true`,
148
+ pass: true,
149
+ }
150
+ : {
151
+ message: () => `expected ${received} to be true but was not true`,
152
+ pass: false,
153
+ }
154
+ },
155
+ toIncludeAllMembers(received: unknown[], expected: unknown[]): ExpectationResult {
156
+ if (!Array.isArray(received) || !Array.isArray(expected)) {
157
+ return {
158
+ pass: false,
159
+ message: () => 'Expected both received and expected values to be arrays.',
160
+ }
161
+ }
162
+
163
+ const missingMembers = expected.filter(item => !received.includes(item))
164
+
165
+ return missingMembers.length === 0
166
+ ? {
167
+ pass: true,
168
+ message: () =>
169
+ `Expected array not to include all members of ${JSON.stringify(expected)}, but it does.`,
170
+ }
171
+ : {
172
+ pass: false,
173
+ message: () =>
174
+ `Expected array to include all members of ${JSON.stringify(expected)}. Missing members: ${JSON.stringify(
175
+ missingMembers,
176
+ )}.`,
177
+ }
178
+ },
179
+ toContainAllKeys(received: object, expectedKeys: string[]): ExpectationResult {
180
+ if (typeof received !== 'object' || received === null) {
181
+ return {
182
+ pass: false,
183
+ message: () => `Expected ${JSON.stringify(received)} to be an object.`,
184
+ }
185
+ }
186
+
187
+ if (!Array.isArray(expectedKeys)) {
188
+ return {
189
+ pass: false,
190
+ message: () => `Expected keys to be an array, but received ${JSON.stringify(expectedKeys)}.`,
191
+ }
192
+ }
193
+
194
+ const missingKeys = expectedKeys.filter(key => !(key in received))
195
+
196
+ return missingKeys.length === 0
197
+ ? {
198
+ pass: true,
199
+ message: () =>
200
+ `Expected object not to contain all keys ${JSON.stringify(expectedKeys)}, but it does.`,
201
+ }
202
+ : {
203
+ pass: false,
204
+ message: () =>
205
+ `Expected object to contain all keys ${JSON.stringify(expectedKeys)}. Missing keys: ${JSON.stringify(
206
+ missingKeys,
207
+ )}.`,
208
+ }
209
+ },
210
+ toContainValues(received: object, expectedValues: unknown[]): ExpectationResult {
211
+ if (typeof received !== 'object' || received === null) {
212
+ return {
213
+ pass: false,
214
+ message: () => `Expected ${JSON.stringify(received)} to be an object.`,
215
+ }
216
+ }
217
+
218
+ if (!Array.isArray(expectedValues)) {
219
+ return {
220
+ pass: false,
221
+ message: () => `Expected values to be an array, but received ${JSON.stringify(expectedValues)}.`,
222
+ }
223
+ }
224
+
225
+ const objectValues = Object.values(received)
226
+
227
+ // eslint-disable-next-line @typescript-eslint/no-explicit-any
228
+ const deepEqual = (a: any, b: any): boolean => {
229
+ if (a === b) return true
230
+ if (typeof a !== typeof b) return false
231
+ if (a && b && typeof a === 'object') {
232
+ const aKeys = Object.keys(a)
233
+ const bKeys = Object.keys(b)
234
+ if (aKeys.length !== bKeys.length) return false
235
+ return aKeys.every(key => deepEqual(a[key], b[key]))
236
+ }
237
+ return false
238
+ }
239
+
240
+ const missingValues = expectedValues.filter(
241
+ expectedValue => !objectValues.some(value => deepEqual(value, expectedValue)),
242
+ )
243
+
244
+ return missingValues.length === 0
245
+ ? {
246
+ pass: true,
247
+ message: () =>
248
+ `Expected object not to contain all values ${JSON.stringify(expectedValues)}, but it does.`,
249
+ }
250
+ : {
251
+ pass: false,
252
+ message: () =>
253
+ `Expected object to contain all values ${JSON.stringify(expectedValues)}. Missing values: ${JSON.stringify(
254
+ missingValues,
255
+ )}.`,
256
+ }
257
+ },
258
+ toBeEmpty(received: unknown): ExpectationResult {
259
+ let isEmpty = false
260
+
261
+ if (Array.isArray(received) || typeof received === 'string') {
262
+ isEmpty = received.length === 0
263
+ } else if (received && typeof received === 'object') {
264
+ isEmpty = Object.keys(received).length === 0
265
+ } else if (received instanceof Map || received instanceof Set) {
266
+ isEmpty = received.size === 0
267
+ } else {
268
+ return {
269
+ pass: false,
270
+ message: () =>
271
+ `Expected value to be an empty array, string, object, Map, or Set, but received ${typeof received}.`,
272
+ }
273
+ }
274
+
275
+ return isEmpty
276
+ ? {
277
+ pass: true,
278
+ message: () =>
279
+ 'Expected value not to be empty, but it was.',
280
+ }
281
+ : {
282
+ pass: false,
283
+ message: () =>
284
+ 'Expected value to be empty, but it was not.',
285
+ }
286
+ },
287
+ }
@@ -0,0 +1 @@
1
+ export * from './customMatchers.ts'
@@ -0,0 +1,27 @@
1
+ // vitest.customMatchers.d.ts
2
+ import 'vitest'
3
+
4
+ interface CustomMatchers<T = unknown> {
5
+ toBeArray(): T
6
+ toBeArrayOfSize(size: number): T
7
+ toBeEmpty(): T
8
+ toBeFalse(): T
9
+ toBeFunction(): T
10
+ toBeInteger(): T
11
+ toBeNegative(): T
12
+ toBeNumber(): T
13
+ toBeObject(): T
14
+ toBeOneOf(expected: unknown[]): T
15
+ toBePositive(): T
16
+ toBeString(): T
17
+ toBeTrue(): T
18
+ toContainAllKeys(expectedKeys: string[]): T
19
+ toContainValues(expectedValues: unknown[]): T
20
+ toIncludeAllMembers(expected: unknown[]): T
21
+ }
22
+
23
+ // Extend the expect Matchers interface
24
+ declare module 'vitest' {
25
+ interface Assertion<T = unknown> extends CustomMatchers<T> {}
26
+ interface AsymmetricMatchersContaining extends CustomMatchers {}
27
+ }