@xyo-network/payment-payload-plugins 3.1.1 → 3.1.2

package/dist/neutral/Escrow/util/appraisal/getSignaturesByAppraisal.d.ts

@@ -2,5 +2,12 @@ import type { Hash } from '@xylabs/hex';
 import { type BoundWitness } from '@xyo-network/boundwitness-model';
 import type { Payload, WithMeta } from '@xyo-network/payload-model';
 import type { EscrowTerms } from '../../Terms/index.ts';
+/**
+ * Returns a dictionary of appraisals and their associated bound witnesses which are signed by
+ * valid appraisal authorities from the escrow terms
+ * @param terms The escrow terms
+ * @param dictionary The diction of payloads associated with the escrow terms
+ * @returns A dictionary of appraisals and their associated bound witnesses
+ */
 export declare const getSignaturesByAppraisal: (terms: EscrowTerms, dictionary: Record<Hash, WithMeta<Payload>>) => Record<Hash, WithMeta<BoundWitness>[]>;
 //# sourceMappingURL=getSignaturesByAppraisal.d.ts.map

package/dist/neutral/Escrow/util/appraisal/getSignaturesByAppraisal.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"getSignaturesByAppraisal.d.ts","sourceRoot":"","sources":["../../../../../src/Escrow/util/appraisal/getSignaturesByAppraisal.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,aAAa,CAAA;AACvC,OAAO,EAAE,KAAK,YAAY,EAA0B,MAAM,iCAAiC,CAAA;AAC3F,OAAO,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,4BAA4B,CAAA;AAEnE,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAA;AASvD,eAAO,MAAM,wBAAwB,UAC5B,WAAW,cACN,MAAM,CAAC,IAAI,EAAE,QAAQ,CAAC,OAAO,CAAC,CAAC,KAC1C,MAAM,CAAC,IAAI,EAAE,QAAQ,CAAC,YAAY,CAAC,EAAE,CAsBvC,CAAA"}
+{"version":3,"file":"getSignaturesByAppraisal.d.ts","sourceRoot":"","sources":["../../../../../src/Escrow/util/appraisal/getSignaturesByAppraisal.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,aAAa,CAAA;AACvC,OAAO,EAAE,KAAK,YAAY,EAA0B,MAAM,iCAAiC,CAAA;AAC3F,OAAO,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,4BAA4B,CAAA;AAEnE,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAA;AAEvD;;;;;;GAMG;AACH,eAAO,MAAM,wBAAwB,UAC5B,WAAW,cACN,MAAM,CAAC,IAAI,EAAE,QAAQ,CAAC,OAAO,CAAC,CAAC,KAC1C,MAAM,CAAC,IAAI,EAAE,QAAQ,CAAC,YAAY,CAAC,EAAE,CAsBvC,CAAA"}

package/dist/neutral/Escrow/util/secret/createEscrowIntent.d.ts

@@ -1,12 +1,19 @@
 import type { AccountInstance } from '@xyo-network/account-model';
 import type { IdPayload } from '@xyo-network/id-payload-plugin';
 import type { EscrowTerms } from '../../Terms/index.ts';
+/**
+ * Creates an escrow intent (for a buyer or seller) using the supplied secret
+ * @param terms The payload describing the terms for the escrow
+ * @param secret The secret for the escrow principal party to use for the escrow
+ * @param account The account to create the escrow intent with
+ * @returns The escrow intent
+ */
 export declare const createEscrowIntentWithSecret: (terms: EscrowTerms, secret: IdPayload, account: AccountInstance) => Promise<[import("@xyo-network/payload-model").WithMeta<import("@xyo-network/payload-model").SchemaFields & import("@xyo-network/payload-model").PayloadFields & import("@xyo-network/boundwitness-model").BoundWitnessFields & {
     schema: "network.xyo.boundwitness";
 }>, import("@xyo-network/payload-model").WithMeta<{
     schema: string;
 } & import("@xyo-network/payload-model").PayloadFields>[], import("@xyo-network/payload-model").WithMeta<import("@xyo-network/payload-model").SchemaFields & import("@xyo-network/payload-model").PayloadFields & {
-    details?: import(".store/@xylabs-object-npm-4.1.0-3ec0b9a178/package").JsonValue;
+    details?: import(".store/@xylabs-object-npm-4.4.9-23a96f4f51/package").JsonValue;
     message?: string;
     name?: string;
     query?: import("@xylabs/hex").Hash;

package/dist/neutral/Escrow/util/secret/createEscrowIntent.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"createEscrowIntent.d.ts","sourceRoot":"","sources":["../../../../../src/Escrow/util/secret/createEscrowIntent.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,4BAA4B,CAAA;AAEjE,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,gCAAgC,CAAA;AAE/D,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAA;AASvD,eAAO,MAAM,4BAA4B,UAAiB,WAAW,UAAU,SAAS,WAAW,eAAe;;;;;;;;;;;MAGjH,CAAA"}
+{"version":3,"file":"createEscrowIntent.d.ts","sourceRoot":"","sources":["../../../../../src/Escrow/util/secret/createEscrowIntent.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,4BAA4B,CAAA;AAEjE,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,gCAAgC,CAAA;AAE/D,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAA;AAEvD;;;;;;GAMG;AACH,eAAO,MAAM,4BAA4B,UAAiB,WAAW,UAAU,SAAS,WAAW,eAAe;;;;;;;;;;;MAGjH,CAAA"}

package/dist/neutral/Escrow/util/secret/findEscrowPartySecretSignatures.d.ts

@@ -2,5 +2,12 @@ import type { Hash } from '@xylabs/hex';
 import type { BoundWitness } from '@xyo-network/boundwitness-model';
 import type { Payload, WithMeta } from '@xyo-network/payload-model';
 import type { EscrowParty, EscrowTerms } from '../../Terms/index.ts';
+/**
+ * Returns an array of BoundWitnesses containing the secret signed by all the parties
+ * @param terms The escrow terms
+ * @param dictionary A dictionary of all the payloads associated with the escrow
+ * @param party The party to get the secret signatures for
+ * @returns An array of BoundWitnesses containing the secret signed by all the parties
+ */
 export declare const findEscrowPartySecretSignatures: (terms: EscrowTerms, dictionary: Record<Hash, WithMeta<Payload>>, party: EscrowParty) => BoundWitness[];
 //# sourceMappingURL=findEscrowPartySecretSignatures.d.ts.map

package/dist/neutral/Escrow/util/secret/findEscrowPartySecretSignatures.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"findEscrowPartySecretSignatures.d.ts","sourceRoot":"","sources":["../../../../../src/Escrow/util/secret/findEscrowPartySecretSignatures.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,aAAa,CAAA;AACvC,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,iCAAiC,CAAA;AAEnE,OAAO,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,4BAA4B,CAAA;AAEnE,OAAO,KAAK,EACV,WAAW,EAAqB,WAAW,EAC5C,MAAM,sBAAsB,CAAA;AAkB7B,eAAO,MAAM,+BAA+B,UAAW,WAAW,cAAc,MAAM,CAAC,IAAI,EAAE,QAAQ,CAAC,OAAO,CAAC,CAAC,SAAS,WAAW,KAAG,YAAY,EAqBjJ,CAAA"}
+{"version":3,"file":"findEscrowPartySecretSignatures.d.ts","sourceRoot":"","sources":["../../../../../src/Escrow/util/secret/findEscrowPartySecretSignatures.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,aAAa,CAAA;AACvC,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,iCAAiC,CAAA;AAEnE,OAAO,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,4BAA4B,CAAA;AAEnE,OAAO,KAAK,EACV,WAAW,EAAqB,WAAW,EAC5C,MAAM,sBAAsB,CAAA;AAW7B;;;;;;GAMG;AACH,eAAO,MAAM,+BAA+B,UAAW,WAAW,cAAc,MAAM,CAAC,IAAI,EAAE,QAAQ,CAAC,OAAO,CAAC,CAAC,SAAS,WAAW,KAAG,YAAY,EAqBjJ,CAAA"}

package/dist/neutral/Escrow/util/secret/getEscrowSecret.d.ts

@@ -1,3 +1,7 @@
 import type { IdPayload } from '@xyo-network/id-payload-plugin';
+/**
+ * Returns a cryptographically random secret to use for escrow
+ * @returns The escrow secret
+ */
 export declare const getEscrowSecret: () => IdPayload;
 //# sourceMappingURL=getEscrowSecret.d.ts.map

package/dist/neutral/Escrow/util/secret/getEscrowSecret.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"getEscrowSecret.d.ts","sourceRoot":"","sources":["../../../../../src/Escrow/util/secret/getEscrowSecret.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,gCAAgC,CAAA;AAO/D,eAAO,MAAM,eAAe,QAAO,SAElC,CAAA"}
+{"version":3,"file":"getEscrowSecret.d.ts","sourceRoot":"","sources":["../../../../../src/Escrow/util/secret/getEscrowSecret.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,gCAAgC,CAAA;AAG/D;;;GAGG;AACH,eAAO,MAAM,eAAe,QAAO,SAElC,CAAA"}

package/dist/neutral/Escrow/util/secret/updateEscrowTermsWithSecret.d.ts

@@ -1,12 +1,21 @@
 import type { AccountInstance } from '@xyo-network/account-model';
 import type { IdPayload } from '@xyo-network/id-payload-plugin';
 import type { EscrowParty, EscrowTerms } from '../../Terms/index.ts';
+/**
+ * Creates an escrow intent (for a buyer or seller) using the supplied secret
+ * @param terms The payload describing the terms for the escrow
+ * @param escrowParty The party in the escrow transaction
+ * @param account The account(s) to create the escrow intent with
+ * @param secret The secret for the escrow principal party to use for the escrow. If
+ * not provided, a cryptographically random secret will be generated.
+ * @returns The escrow intent
+ */
 export declare const updateEscrowTermsWithSecret: (terms: EscrowTerms, escrowParty: EscrowParty, account: AccountInstance | AccountInstance[], secret?: IdPayload) => Promise<[import("@xyo-network/payload-model").WithMeta<import("@xyo-network/payload-model").SchemaFields & import("@xyo-network/payload-model").PayloadFields & import("@xyo-network/boundwitness-model").BoundWitnessFields & {
     schema: "network.xyo.boundwitness";
 }>, import("@xyo-network/payload-model").WithMeta<{
     schema: string;
 } & import("@xyo-network/payload-model").PayloadFields>[], import("@xyo-network/payload-model").WithMeta<import("@xyo-network/payload-model").SchemaFields & import("@xyo-network/payload-model").PayloadFields & {
-    details?: import(".store/@xylabs-object-npm-4.1.0-3ec0b9a178/package").JsonValue;
+    details?: import(".store/@xylabs-object-npm-4.4.9-23a96f4f51/package").JsonValue;
     message?: string;
     name?: string;
     query?: import("@xylabs/hex").Hash;

package/dist/neutral/Escrow/util/secret/updateEscrowTermsWithSecret.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"updateEscrowTermsWithSecret.d.ts","sourceRoot":"","sources":["../../../../../src/Escrow/util/secret/updateEscrowTermsWithSecret.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,4BAA4B,CAAA;AAEjE,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,gCAAgC,CAAA;AAG/D,OAAO,KAAK,EACV,WAAW,EAAqB,WAAW,EAC5C,MAAM,sBAAsB,CAAA;AAY7B,eAAO,MAAM,2BAA2B,UAC/B,WAAW,eACL,WAAW,WACf,eAAe,GAAG,eAAe,EAAE,WACnC,SAAS;;;;;;;;;;;MAanB,CAAA"}
+{"version":3,"file":"updateEscrowTermsWithSecret.d.ts","sourceRoot":"","sources":["../../../../../src/Escrow/util/secret/updateEscrowTermsWithSecret.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,4BAA4B,CAAA;AAEjE,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,gCAAgC,CAAA;AAG/D,OAAO,KAAK,EACV,WAAW,EAAqB,WAAW,EAC5C,MAAM,sBAAsB,CAAA;AAG7B;;;;;;;;GAQG;AACH,eAAO,MAAM,2BAA2B,UAC/B,WAAW,eACL,WAAW,WACf,eAAe,GAAG,eAAe,EAAE,WACnC,SAAS;;;;;;;;;;;MAanB,CAAA"}

package/dist/neutral/Escrow/validators/common/ModuleInstanceValidators/moduleInstanceValidators.d.ts

@@ -1,6 +1,22 @@
 import type { ModuleIdentifier } from '@xyo-network/module-model';
 import type { PayloadValueExpression } from '@xyo-network/payload-model';
 import type { EscrowTerms } from '../../../Terms/index.ts';
+/**
+ * Checks if property value of the escrow terms contains one of the valid moduleIdentifiers
+ * @param escrowTerms The escrow terms to validate
+ * @param propertyExpression The selector to get the property containing the moduleIdentifier(s) from the escrow terms
+ * @param moduleIdentifiers The list of allowed moduleIdentifiers
+ * @param required Is the property required to be present
+ * @returns True if the property value contains one of the valid moduleIdentifiers
+ */
 export declare const moduleIdentifiersContainsOneOf: (escrowTerms: EscrowTerms, propertyExpression: PayloadValueExpression<EscrowTerms, "appraisalAuthorities" | "buyer" | "escrowAgent" | "paymentAuthorities" | "seller">, moduleIdentifiers: ModuleIdentifier[], required?: boolean) => boolean;
+/**
+ * Checks if property value of the escrow terms contains all of the valid moduleIdentifiers
+ * @param escrowTerms The escrow terms to validate
+ * @param selector The selector to get the property containing the moduleIdentifier(s) from the escrow terms
+ * @param moduleIdentifiers The list of allowed moduleIdentifiers
+ * @param required Is the property required to be present
+ * @returns True if the property value contains all of the valid moduleIdentifiers
+ */
 export declare const moduleIdentifiersContainsAllOf: (escrowTerms: EscrowTerms, selector: PayloadValueExpression<EscrowTerms, "appraisalAuthorities" | "buyer" | "escrowAgent" | "paymentAuthorities" | "seller">, moduleIdentifiers: ModuleIdentifier[], required?: boolean) => boolean;
 //# sourceMappingURL=moduleInstanceValidators.d.ts.map

package/dist/neutral/Escrow/validators/common/ModuleInstanceValidators/moduleInstanceValidators.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"moduleInstanceValidators.d.ts","sourceRoot":"","sources":["../../../../../../src/Escrow/validators/common/ModuleInstanceValidators/moduleInstanceValidators.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAA;AACjE,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,4BAA4B,CAAA;AAExE,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAA;AAU1D,eAAO,MAAM,8BAA8B,gBAC5B,WAAW,sBACJ,sBAAsB,CAAC,WAAW,EAAE,sBAAsB,GAAG,OAAO,GAAG,aAAa,GAAG,oBAAoB,GAAG,QAAQ,CAAC,qBACxH,gBAAgB,EAAE,aAC3B,OAAO,YAQlB,CAAA;AAUD,eAAO,MAAM,8BAA8B,gBAC5B,WAAW,YACd,sBAAsB,CAAC,WAAW,EAAE,sBAAsB,GAAG,OAAO,GAAG,aAAa,GAAG,oBAAoB,GAAG,QAAQ,CAAC,qBAC9G,gBAAgB,EAAE,aAC3B,OAAO,YAQlB,CAAA"}
+{"version":3,"file":"moduleInstanceValidators.d.ts","sourceRoot":"","sources":["../../../../../../src/Escrow/validators/common/ModuleInstanceValidators/moduleInstanceValidators.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAA;AACjE,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,4BAA4B,CAAA;AAExE,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAA;AAE1D;;;;;;;GAOG;AACH,eAAO,MAAM,8BAA8B,gBAC5B,WAAW,sBACJ,sBAAsB,CAAC,WAAW,EAAE,sBAAsB,GAAG,OAAO,GAAG,aAAa,GAAG,oBAAoB,GAAG,QAAQ,CAAC,qBACxH,gBAAgB,EAAE,aAC3B,OAAO,YAQlB,CAAA;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,8BAA8B,gBAC5B,WAAW,YACd,sBAAsB,CAAC,WAAW,EAAE,sBAAsB,GAAG,OAAO,GAAG,aAAa,GAAG,oBAAoB,GAAG,QAAQ,CAAC,qBAC9G,gBAAgB,EAAE,aAC3B,OAAO,YAQlB,CAAA"}

package/dist/neutral/Escrow/validators/common/SecretValidators/getPartySecretSignedValidator.d.ts

@@ -1,5 +1,10 @@
 import type { Hash } from '@xylabs/hex';
 import type { AsyncPayloadValidationFunction, Payload, WithMeta } from '@xyo-network/payload-model';
 import type { EscrowParty, EscrowTerms } from '../../../Terms/index.ts';
+/**
+ * Returns a function that validates the escrow terms for the existence of the party secret signed by the party
+ * @param dictionary Payload dictionary of the escrow terms
+ * @returns A function that validates the escrow terms for the existence of the party secret signed by the party
+ */
 export declare const getPartySecretSignedValidator: (dictionary: Record<Hash, WithMeta<Payload>>, party: EscrowParty) => AsyncPayloadValidationFunction<EscrowTerms>;
 //# sourceMappingURL=getPartySecretSignedValidator.d.ts.map

package/dist/neutral/Escrow/validators/common/SecretValidators/getPartySecretSignedValidator.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"getPartySecretSignedValidator.d.ts","sourceRoot":"","sources":["../../../../../../src/Escrow/validators/common/SecretValidators/getPartySecretSignedValidator.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,aAAa,CAAA;AAEvC,OAAO,KAAK,EACV,8BAA8B,EAAE,OAAO,EAAE,QAAQ,EAClD,MAAM,4BAA4B,CAAA;AAEnC,OAAO,KAAK,EACV,WAAW,EAAqB,WAAW,EAC5C,MAAM,yBAAyB,CAAA;AAkBhC,eAAO,MAAM,6BAA6B,eAAgB,MAAM,CAAC,IAAI,EAAE,QAAQ,CAAC,OAAO,CAAC,CAAC,SAAS,WAAW,KAAG,8BAA8B,CAAC,WAAW,CAqBzJ,CAAA"}
+{"version":3,"file":"getPartySecretSignedValidator.d.ts","sourceRoot":"","sources":["../../../../../../src/Escrow/validators/common/SecretValidators/getPartySecretSignedValidator.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,aAAa,CAAA;AAEvC,OAAO,KAAK,EACV,8BAA8B,EAAE,OAAO,EAAE,QAAQ,EAClD,MAAM,4BAA4B,CAAA;AAEnC,OAAO,KAAK,EACV,WAAW,EAAqB,WAAW,EAC5C,MAAM,yBAAyB,CAAA;AAahC;;;;GAIG;AACH,eAAO,MAAM,6BAA6B,eAAgB,MAAM,CAAC,IAAI,EAAE,QAAQ,CAAC,OAAO,CAAC,CAAC,SAAS,WAAW,KAAG,8BAA8B,CAAC,WAAW,CAqBzJ,CAAA"}

package/dist/neutral/Escrow/validators/escrow/appraisal.d.ts

@@ -1,8 +1,29 @@
 import type { Hash } from '@xylabs/hex';
 import type { Payload, SyncPayloadValidationFunction, WithMeta } from '@xyo-network/payload-model';
 import type { EscrowTerms } from '../../Terms/index.ts';
+/**
+ * A function that validates the escrow terms for tbe existence of appraisals
+ * @returns True if the escrow terms contain appraisals, false otherwise
+ */
 export declare const appraisalsExistValidator: SyncPayloadValidationFunction<EscrowTerms>;
+/**
+ * Returns a function that validates the escrow terms for appraisals which are from valid authorities
+ * @param dictionary Payload dictionary of the escrow terms
+ * @returns A function that validates the escrow terms for appraisals which are from valid authorities
+ */
 export declare const getAppraisalsFromValidAuthoritiesValidator: (dictionary: Record<Hash, WithMeta<Payload>>) => SyncPayloadValidationFunction<EscrowTerms>;
+/**
+ * Returns a function that validates the escrow terms for appraisals which are valid
+ * @param dictionary Payload dictionary of the escrow terms
+ * @param minimumExp The minium amount of time an estimate needs to be valid
+ * for in the future (so as not to expire before the escrow is complete)
+ * @returns A function that validates the escrow terms for appraisals which are valid
+ */
 export declare const getAppraisalsValidValidator: (dictionary: Record<Hash, WithMeta<Payload>>, minimumExp: number) => SyncPayloadValidationFunction<EscrowTerms>;
+/**
+ * Returns a function that validates the escrow terms to ensure that they contain an appraisal for each asset
+ * @param dictionary Payload dictionary of the escrow terms
+ * @returns A function that validates the escrow terms for appraisals
+ */
 export declare const getAppraisalsForAllAssetsValidator: (dictionary: Record<Hash, WithMeta<Payload>>) => SyncPayloadValidationFunction<EscrowTerms>;
 //# sourceMappingURL=appraisal.d.ts.map

package/dist/neutral/Escrow/validators/escrow/appraisal.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"appraisal.d.ts","sourceRoot":"","sources":["../../../../../src/Escrow/validators/escrow/appraisal.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,aAAa,CAAA;AAIvC,OAAO,KAAK,EACV,OAAO,EAAE,6BAA6B,EAAE,QAAQ,EACjD,MAAM,4BAA4B,CAAA;AAEnC,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAA;AAUvD,eAAO,MAAM,wBAAwB,EAAE,6BAA6B,CAAC,WAAW,CAQ/E,CAAA;AAOD,eAAO,MAAM,0CAA0C,eAAgB,MAAM,CAAC,IAAI,EAAE,QAAQ,CAAC,OAAO,CAAC,CAAC,KAAG,6BAA6B,CAAC,WAAW,CA0BjJ,CAAA;AASD,eAAO,MAAM,2BAA2B,eAC1B,MAAM,CAAC,IAAI,EAAE,QAAQ,CAAC,OAAO,CAAC,CAAC,cAC/B,MAAM,KACjB,6BAA6B,CAAC,WAAW,CAiB3C,CAAA;AAOD,eAAO,MAAM,kCAAkC,eAAgB,MAAM,CAAC,IAAI,EAAE,QAAQ,CAAC,OAAO,CAAC,CAAC,KAAG,6BAA6B,CAAC,WAAW,CAWzI,CAAA"}
+{"version":3,"file":"appraisal.d.ts","sourceRoot":"","sources":["../../../../../src/Escrow/validators/escrow/appraisal.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,aAAa,CAAA;AAIvC,OAAO,KAAK,EACV,OAAO,EAAE,6BAA6B,EAAE,QAAQ,EACjD,MAAM,4BAA4B,CAAA;AAEnC,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAA;AAMvD;;;GAGG;AACH,eAAO,MAAM,wBAAwB,EAAE,6BAA6B,CAAC,WAAW,CAQ/E,CAAA;AAED;;;;GAIG;AACH,eAAO,MAAM,0CAA0C,eAAgB,MAAM,CAAC,IAAI,EAAE,QAAQ,CAAC,OAAO,CAAC,CAAC,KAAG,6BAA6B,CAAC,WAAW,CA0BjJ,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,2BAA2B,eAC1B,MAAM,CAAC,IAAI,EAAE,QAAQ,CAAC,OAAO,CAAC,CAAC,cAC/B,MAAM,KACjB,6BAA6B,CAAC,WAAW,CAiB3C,CAAA;AAED;;;;GAIG;AACH,eAAO,MAAM,kCAAkC,eAAgB,MAAM,CAAC,IAAI,EAAE,QAAQ,CAAC,OAAO,CAAC,CAAC,KAAG,6BAA6B,CAAC,WAAW,CAWzI,CAAA"}

package/dist/neutral/Escrow/validators/escrow/appraisalAuthorities.d.ts

@@ -1,6 +1,10 @@
 import type { ModuleIdentifier } from '@xyo-network/module-model';
 import type { SyncPayloadValidationFunction } from '@xyo-network/payload-model';
 import type { EscrowTerms } from '../../Terms/index.ts';
+/**
+ * A function that validates the escrow terms for appraisalAuthorities
+ * @returns True if the escrow terms contain appraisalAuthorities, false otherwise
+ */
 export declare const appraisalAuthoritiesExistValidator: SyncPayloadValidationFunction<EscrowTerms>;
 export declare const getAppraisalAuthoritiesAllowedValidator: (allowed: ModuleIdentifier[]) => SyncPayloadValidationFunction<EscrowTerms>;
 //# sourceMappingURL=appraisalAuthorities.d.ts.map

package/dist/neutral/Escrow/validators/escrow/appraisalAuthorities.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"appraisalAuthorities.d.ts","sourceRoot":"","sources":["../../../../../src/Escrow/validators/escrow/appraisalAuthorities.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAA;AACjE,OAAO,KAAK,EAAE,6BAA6B,EAAE,MAAM,4BAA4B,CAAA;AAE/E,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAA;AASvD,eAAO,MAAM,kCAAkC,EAAE,6BAA6B,CAAC,WAAW,CAazF,CAAA;AAED,eAAO,MAAM,uCAAuC,YAAa,gBAAgB,EAAE,KAAG,6BAA6B,CAAC,WAAW,CAQ9H,CAAA"}
+{"version":3,"file":"appraisalAuthorities.d.ts","sourceRoot":"","sources":["../../../../../src/Escrow/validators/escrow/appraisalAuthorities.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAA;AACjE,OAAO,KAAK,EAAE,6BAA6B,EAAE,MAAM,4BAA4B,CAAA;AAE/E,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAA;AAKvD;;;GAGG;AACH,eAAO,MAAM,kCAAkC,EAAE,6BAA6B,CAAC,WAAW,CAazF,CAAA;AAED,eAAO,MAAM,uCAAuC,YAAa,gBAAgB,EAAE,KAAG,6BAA6B,CAAC,WAAW,CAQ9H,CAAA"}

package/dist/neutral/Escrow/validators/escrow/assets.d.ts

@@ -1,4 +1,8 @@
 import type { SyncPayloadValidationFunction } from '@xyo-network/payload-model';
 import type { EscrowTerms } from '../../Terms/index.ts';
+/**
+ * Returns a function that validates the escrow terms for assets
+ * @returns A function that validates the escrow terms for assets
+ */
 export declare const assetsExistValidator: SyncPayloadValidationFunction<EscrowTerms>;
 //# sourceMappingURL=assets.d.ts.map

package/dist/neutral/Escrow/validators/escrow/assets.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"assets.d.ts","sourceRoot":"","sources":["../../../../../src/Escrow/validators/escrow/assets.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,6BAA6B,EAAE,MAAM,4BAA4B,CAAA;AAE/E,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAA;AAQvD,eAAO,MAAM,oBAAoB,EAAE,6BAA6B,CAAC,WAAW,CAQ3E,CAAA"}
+{"version":3,"file":"assets.d.ts","sourceRoot":"","sources":["../../../../../src/Escrow/validators/escrow/assets.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,6BAA6B,EAAE,MAAM,4BAA4B,CAAA;AAE/E,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAA;AAIvD;;;GAGG;AACH,eAAO,MAAM,oBAAoB,EAAE,6BAA6B,CAAC,WAAW,CAQ3E,CAAA"}

package/dist/neutral/Escrow/validators/escrow/buyer.d.ts

@@ -1,4 +1,8 @@
 import type { SyncPayloadValidationFunction } from '@xyo-network/payload-model';
 import type { EscrowTerms } from '../../Terms/index.ts';
+/**
+ * A function that validates the escrow terms for buyer
+ * @returns True if the escrow terms contain buyer, false otherwise
+ */
 export declare const buyerExistsValidator: SyncPayloadValidationFunction<EscrowTerms>;
 //# sourceMappingURL=buyer.d.ts.map

package/dist/neutral/Escrow/validators/escrow/buyer.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"buyer.d.ts","sourceRoot":"","sources":["../../../../../src/Escrow/validators/escrow/buyer.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,6BAA6B,EAAE,MAAM,4BAA4B,CAAA;AAE/E,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAA;AAQvD,eAAO,MAAM,oBAAoB,EAAE,6BAA6B,CAAC,WAAW,CAa3E,CAAA"}
+{"version":3,"file":"buyer.d.ts","sourceRoot":"","sources":["../../../../../src/Escrow/validators/escrow/buyer.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,6BAA6B,EAAE,MAAM,4BAA4B,CAAA;AAE/E,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAA;AAIvD;;;GAGG;AACH,eAAO,MAAM,oBAAoB,EAAE,6BAA6B,CAAC,WAAW,CAa3E,CAAA"}

package/dist/neutral/Escrow/validators/escrow/buyerSecret.d.ts

@@ -1,7 +1,21 @@
 import type { Hash } from '@xylabs/hex';
 import type { AsyncPayloadValidationFunction, Payload, SyncPayloadValidationFunction, WithMeta } from '@xyo-network/payload-model';
 import type { EscrowTerms } from '../../Terms/index.ts';
+/**
+ * Returns a function that validates the escrow terms for buyerSecret
+ * @returns A function that validates the escrow terms for buyerSecret
+ */
 export declare const buyerSecretExistsValidator: SyncPayloadValidationFunction<EscrowTerms>;
+/**
+ * Returns a function that validates the escrow terms for the existence of the buyerSecret in the dictionary
+ * @param dictionary Payload dictionary of the escrow terms
+ * @returns A function that validates the escrow terms for the existence of the buyerSecret in the dictionary
+ */
 export declare const getBuyerSecretSuppliedValidator: (dictionary: Record<Hash, WithMeta<Payload>>) => SyncPayloadValidationFunction<EscrowTerms>;
+/**
+ * Returns a function that validates the escrow terms for the existence of the buyerSecret signed by the buyer
+ * @param dictionary Payload dictionary of the escrow terms
+ * @returns A function that validates the escrow terms for the existence of the buyerSecret signed by the buyer
+ */
 export declare const getBuyerSecretSignedValidator: (dictionary: Record<Hash, WithMeta<Payload>>) => AsyncPayloadValidationFunction<EscrowTerms>;
 //# sourceMappingURL=buyerSecret.d.ts.map

package/dist/neutral/Escrow/validators/escrow/buyerSecret.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"buyerSecret.d.ts","sourceRoot":"","sources":["../../../../../src/Escrow/validators/escrow/buyerSecret.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,aAAa,CAAA;AACvC,OAAO,KAAK,EACV,8BAA8B,EAAE,OAAO,EAAE,6BAA6B,EAAE,QAAQ,EACjF,MAAM,4BAA4B,CAAA;AAEnC,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAA;AASvD,eAAO,MAAM,0BAA0B,EAAE,6BAA6B,CAAC,WAAW,CAQjF,CAAA;AAOD,eAAO,MAAM,+BAA+B,eAAgB,MAAM,CAAC,IAAI,EAAE,QAAQ,CAAC,OAAO,CAAC,CAAC,KAAG,6BAA6B,CAAC,WAAW,CAStI,CAAA;AAOD,eAAO,MAAM,6BAA6B,eAAgB,MAAM,CAAC,IAAI,EAAE,QAAQ,CAAC,OAAO,CAAC,CAAC,KAAG,8BAA8B,CAAC,WAAW,CAErI,CAAA"}
+{"version":3,"file":"buyerSecret.d.ts","sourceRoot":"","sources":["../../../../../src/Escrow/validators/escrow/buyerSecret.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,aAAa,CAAA;AACvC,OAAO,KAAK,EACV,8BAA8B,EAAE,OAAO,EAAE,6BAA6B,EAAE,QAAQ,EACjF,MAAM,4BAA4B,CAAA;AAEnC,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAA;AAKvD;;;GAGG;AACH,eAAO,MAAM,0BAA0B,EAAE,6BAA6B,CAAC,WAAW,CAQjF,CAAA;AAED;;;;GAIG;AACH,eAAO,MAAM,+BAA+B,eAAgB,MAAM,CAAC,IAAI,EAAE,QAAQ,CAAC,OAAO,CAAC,CAAC,KAAG,6BAA6B,CAAC,WAAW,CAStI,CAAA;AAED;;;;GAIG;AACH,eAAO,MAAM,6BAA6B,eAAgB,MAAM,CAAC,IAAI,EAAE,QAAQ,CAAC,OAAO,CAAC,CAAC,KAAG,8BAA8B,CAAC,WAAW,CAErI,CAAA"}

package/dist/neutral/Escrow/validators/escrow/seller.d.ts

@@ -1,4 +1,8 @@
 import type { SyncPayloadValidationFunction } from '@xyo-network/payload-model';
 import type { EscrowTerms } from '../../Terms/index.ts';
+/**
+ * A function that validates the escrow terms for seller
+ * @returns True if the escrow terms contain seller, false otherwise
+ */
 export declare const sellerExistsValidator: SyncPayloadValidationFunction<EscrowTerms>;
 //# sourceMappingURL=seller.d.ts.map

package/dist/neutral/Escrow/validators/escrow/seller.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"seller.d.ts","sourceRoot":"","sources":["../../../../../src/Escrow/validators/escrow/seller.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,6BAA6B,EAAE,MAAM,4BAA4B,CAAA;AAE/E,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAA;AAQvD,eAAO,MAAM,qBAAqB,EAAE,6BAA6B,CAAC,WAAW,CAa5E,CAAA"}
+{"version":3,"file":"seller.d.ts","sourceRoot":"","sources":["../../../../../src/Escrow/validators/escrow/seller.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,6BAA6B,EAAE,MAAM,4BAA4B,CAAA;AAE/E,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAA;AAIvD;;;GAGG;AACH,eAAO,MAAM,qBAAqB,EAAE,6BAA6B,CAAC,WAAW,CAa5E,CAAA"}

package/dist/neutral/Escrow/validators/escrow/sellerSecret.d.ts

@@ -1,7 +1,21 @@
 import type { Hash } from '@xylabs/hex';
 import type { AsyncPayloadValidationFunction, Payload, SyncPayloadValidationFunction, WithMeta } from '@xyo-network/payload-model';
 import type { EscrowTerms } from '../../Terms/index.ts';
+/**
+ * Returns a function that validates the escrow terms for sellerSecret
+ * @returns A function that validates the escrow terms for sellerSecret
+ */
 export declare const sellerSecretExistsValidator: SyncPayloadValidationFunction<EscrowTerms>;
+/**
+ * Returns a function that validates the escrow terms for the existence of the sellerSecret in the dictionary
+ * @param dictionary Payload dictionary of the escrow terms
+ * @returns A function that validates the escrow terms for the existence of the sellerSecret in the dictionary
+ */
 export declare const getSellerSecretSuppliedValidator: (dictionary: Record<Hash, WithMeta<Payload>>) => SyncPayloadValidationFunction<EscrowTerms>;
+/**
+ * Returns a function that validates the escrow terms for the existence of the sellerSecret signed by the seller
+ * @param dictionary Payload dictionary of the escrow terms
+ * @returns A function that validates the escrow terms for the existence of the sellerSecret signed by the seller
+ */
 export declare const getSellerSecretSignedValidator: (dictionary: Record<Hash, WithMeta<Payload>>) => AsyncPayloadValidationFunction<EscrowTerms>;
 //# sourceMappingURL=sellerSecret.d.ts.map

package/dist/neutral/Escrow/validators/escrow/sellerSecret.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"sellerSecret.d.ts","sourceRoot":"","sources":["../../../../../src/Escrow/validators/escrow/sellerSecret.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,aAAa,CAAA;AACvC,OAAO,KAAK,EACV,8BAA8B,EAAE,OAAO,EAAE,6BAA6B,EAAE,QAAQ,EACjF,MAAM,4BAA4B,CAAA;AAEnC,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAA;AASvD,eAAO,MAAM,2BAA2B,EAAE,6BAA6B,CAAC,WAAW,CAQlF,CAAA;AAOD,eAAO,MAAM,gCAAgC,eAAgB,MAAM,CAAC,IAAI,EAAE,QAAQ,CAAC,OAAO,CAAC,CAAC,KAAG,6BAA6B,CAAC,WAAW,CASvI,CAAA;AAOD,eAAO,MAAM,8BAA8B,eAAgB,MAAM,CAAC,IAAI,EAAE,QAAQ,CAAC,OAAO,CAAC,CAAC,KAAG,8BAA8B,CAAC,WAAW,CAEtI,CAAA"}
+{"version":3,"file":"sellerSecret.d.ts","sourceRoot":"","sources":["../../../../../src/Escrow/validators/escrow/sellerSecret.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,aAAa,CAAA;AACvC,OAAO,KAAK,EACV,8BAA8B,EAAE,OAAO,EAAE,6BAA6B,EAAE,QAAQ,EACjF,MAAM,4BAA4B,CAAA;AAEnC,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAA;AAKvD;;;GAGG;AACH,eAAO,MAAM,2BAA2B,EAAE,6BAA6B,CAAC,WAAW,CAQlF,CAAA;AAED;;;;GAIG;AACH,eAAO,MAAM,gCAAgC,eAAgB,MAAM,CAAC,IAAI,EAAE,QAAQ,CAAC,OAAO,CAAC,CAAC,KAAG,6BAA6B,CAAC,WAAW,CASvI,CAAA;AAED;;;;GAIG;AACH,eAAO,MAAM,8BAA8B,eAAgB,MAAM,CAAC,IAAI,EAAE,QAAQ,CAAC,OAAO,CAAC,CAAC,KAAG,8BAA8B,CAAC,WAAW,CAEtI,CAAA"}

package/dist/neutral/Invoice/Invoice.d.ts

@@ -2,7 +2,16 @@ import type { Discount } from '../Discount/index.ts';
 import type { Payment } from '../Payment/index.ts';
 import type { Subtotal } from '../Subtotal/index.ts';
 import type { Total } from '../Total/index.ts';
+/**
+ * A tuple containing the subtotal, total, and payment for an invoice.
+ */
 export type StandardInvoice = [Subtotal, Total, Payment];
+/**
+ * A tuple containing the subtotal, total, payment, and discount for an invoice.
+ */
 export type DiscountedInvoice = [...StandardInvoice, Discount];
+/**
+ * An invoice.
+ */
 export type Invoice = StandardInvoice | DiscountedInvoice;
 //# sourceMappingURL=Invoice.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"Invoice.d.ts","sourceRoot":"","sources":["../../../src/Invoice/Invoice.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAA;AACpD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAA;AAClD,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAA;AACpD,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,mBAAmB,CAAA;AAK9C,MAAM,MAAM,eAAe,GAAG,CAAC,QAAQ,EAAE,KAAK,EAAE,OAAO,CAAC,CAAA;AAKxD,MAAM,MAAM,iBAAiB,GAAG,CAAC,GAAG,eAAe,EAAE,QAAQ,CAAC,CAAA;AAK9D,MAAM,MAAM,OAAO,GAAG,eAAe,GAAG,iBAAiB,CAAA"}
+{"version":3,"file":"Invoice.d.ts","sourceRoot":"","sources":["../../../src/Invoice/Invoice.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAA;AACpD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAA;AAClD,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAA;AACpD,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,mBAAmB,CAAA;AAE9C;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,CAAC,QAAQ,EAAE,KAAK,EAAE,OAAO,CAAC,CAAA;AAExD;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG,CAAC,GAAG,eAAe,EAAE,QAAQ,CAAC,CAAA;AAE9D;;GAEG;AACH,MAAM,MAAM,OAAO,GAAG,eAAe,GAAG,iBAAiB,CAAA"}

package/dist/neutral/Payment/Instrument/Card/Payload.d.ts

@@ -1,19 +1,49 @@
 import type { Payload } from '@xyo-network/payload-model';
 import { PaymentCardSchema } from './Schema.ts';
+/**
+ * The fields describing a payment card.
+ */
 export interface PaymentCardFields {
+    /**
+     * Card Number (PAN) of the payment card. This value is required to perform a payment.
+     */
     cardNumber: string;
+    /**
+     * The name as it appears on the payment card.
+     */
     cardholderName?: string;
+    /**
+     * Card Verification Value (CVV/CVC) of the payment card.
+     */
     cvv: string;
+    /**
+     * Expiration month of the payment card.
+     */
     expMonth: number;
+    /**
+     * Expiration year of the payment card.
+     */
     expYear: number;
 }
+/**
+ * A PaymentCard Payload
+ */
 export type PaymentCard = Payload<PaymentCardFields, PaymentCardSchema>;
+/**
+ * Identity function for determine if an object is a PaymentCard
+ */
 export declare const isPaymentCard: (x?: unknown | null) => x is import("@xyo-network/payload-model").SchemaFields & import("@xyo-network/payload-model").PayloadFields & PaymentCardFields & {
     schema: "network.xyo.payments.payment.instrument.card";
 };
+/**
+ * Identity function for determine if an object is a PaymentCard with sources
+ */
 export declare const isPaymentCardWithSources: (x?: unknown | null) => x is import("@xyo-network/payload-model").WithSources<import("@xyo-network/payload-model").SchemaFields & import("@xyo-network/payload-model").PayloadFields & PaymentCardFields & {
     schema: "network.xyo.payments.payment.instrument.card";
 }>;
+/**
+ * Identity function for determine if an object is a PaymentCard with meta
+ */
 export declare const isPaymentCardWithMeta: (x?: unknown | null) => x is import("@xyo-network/payload-model").WithMeta<import("@xyo-network/payload-model").SchemaFields & import("@xyo-network/payload-model").PayloadFields & PaymentCardFields & {
     schema: "network.xyo.payments.payment.instrument.card";
 }>;

package/dist/neutral/Payment/Instrument/Card/Payload.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Payload.d.ts","sourceRoot":"","sources":["../../../../../src/Payment/Instrument/Card/Payload.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,4BAA4B,CAAA;AAKzD,OAAO,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAA;AAK/C,MAAM,WAAW,iBAAiB;IAIhC,UAAU,EAAE,MAAM,CAAA;IAIlB,cAAc,CAAC,EAAE,MAAM,CAAA;IAIvB,GAAG,EAAE,MAAM,CAAA;IAIX,QAAQ,EAAE,MAAM,CAAA;IAIhB,OAAO,EAAE,MAAM,CAAA;CAChB;AAKD,MAAM,MAAM,WAAW,GAAG,OAAO,CAAC,iBAAiB,EAAE,iBAAiB,CAAC,CAAA;AAKvE,eAAO,MAAM,aAAa;;CAAwD,CAAA;AAKlF,eAAO,MAAM,wBAAwB;;EAAmE,CAAA;AAKxG,eAAO,MAAM,qBAAqB;;EAAgE,CAAA"}
+{"version":3,"file":"Payload.d.ts","sourceRoot":"","sources":["../../../../../src/Payment/Instrument/Card/Payload.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,4BAA4B,CAAA;AAKzD,OAAO,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAA;AAE/C;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAA;IAClB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAA;IACvB;;OAEG;IACH,GAAG,EAAE,MAAM,CAAA;IACX;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAA;IAChB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAA;CAChB;AAED;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG,OAAO,CAAC,iBAAiB,EAAE,iBAAiB,CAAC,CAAA;AAEvE;;GAEG;AACH,eAAO,MAAM,aAAa;;CAAwD,CAAA;AAElF;;GAEG;AACH,eAAO,MAAM,wBAAwB;;EAAmE,CAAA;AAExG;;GAEG;AACH,eAAO,MAAM,qBAAqB;;EAAgE,CAAA"}

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

@@ -2,11 +2,29 @@ import type { PayloadWithSources } from '@xyo-network/payload-model';
 import type { SupportedCurrency } from '../Currency.ts';
 import { PaymentSchema } from './Schema.ts';
 export interface PaymentFields {
+    /**
+     * The amount paid
+     */
     amount: number;
+    /**
+     * The currency of the amount paid
+     */
     currency: SupportedCurrency;
 }
+/**
+ * A payment is a record of an amount to be paid
+ */
 export type Payment = PayloadWithSources<PaymentFields, PaymentSchema>;
+/**
+ * Identity function for determine if an object is a Payment
+ */
 export declare const isPayment: (x?: unknown | null) => x is Payment;
+/**
+ * Identity function for determine if an object is a Payment with sources
+ */
 export declare const isPaymentWithSources: (x?: unknown | null) => x is import("@xyo-network/payload-model").WithSources<Payment>;
+/**
+ * Identity function for determine if an object is a Payment with meta
+ */
 export declare const isPaymentWithMeta: (x?: unknown | null) => x is import("@xyo-network/payload-model").WithMeta<Payment>;
 //# sourceMappingURL=Payload.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"Payload.d.ts","sourceRoot":"","sources":["../../../src/Payment/Payload.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAA;AAOpE,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,gBAAgB,CAAA;AACvD,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAA;AAE3C,MAAM,WAAW,aAAa;IAI5B,MAAM,EAAE,MAAM,CAAA;IAId,QAAQ,EAAE,iBAAiB,CAAA;CAC5B;AAKD,MAAM,MAAM,OAAO,GAAG,kBAAkB,CAAC,aAAa,EAAE,aAAa,CAAC,CAAA;AAKtE,eAAO,MAAM,SAAS,sCAAgD,CAAA;AAKtE,eAAO,MAAM,oBAAoB,wFAA2D,CAAA;AAK5F,eAAO,MAAM,iBAAiB,qFAAwD,CAAA"}
+{"version":3,"file":"Payload.d.ts","sourceRoot":"","sources":["../../../src/Payment/Payload.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAA;AAOpE,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,gBAAgB,CAAA;AACvD,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAA;AAE3C,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAA;IACd;;OAEG;IACH,QAAQ,EAAE,iBAAiB,CAAA;CAC5B;AAED;;GAEG;AACH,MAAM,MAAM,OAAO,GAAG,kBAAkB,CAAC,aAAa,EAAE,aAAa,CAAC,CAAA;AAEtE;;GAEG;AACH,eAAO,MAAM,SAAS,sCAAgD,CAAA;AAEtE;;GAEG;AACH,eAAO,MAAM,oBAAoB,wFAA2D,CAAA;AAE5F;;GAEG;AACH,eAAO,MAAM,iBAAiB,qFAAwD,CAAA"}

package/dist/neutral/Payment/Status/Payload.d.ts

@@ -1,11 +1,29 @@
 import type { PayloadWithSources } from '@xyo-network/payload-model';
 import { PaymentStatusSchema } from './Schema.ts';
 export interface PaymentStatusFields {
+    /**
+     * The result of the payment (i.e. declined)
+     */
     result?: string;
+    /**
+     * The status of the payment (i.e. completed)
+     */
     status: string;
 }
+/**
+ * A payment status is the outcome of a payment attempt
+ */
 export type PaymentStatus = PayloadWithSources<PaymentStatusFields, PaymentStatusSchema>;
+/**
+ * Identity function for determine if an object is a PaymentStatus
+ */
 export declare const isPaymentStatus: (x?: unknown | null) => x is PaymentStatus;
+/**
+ * Identity function for determine if an object is a PaymentStatus with sources
+ */
 export declare const isPaymentStatusWithSources: (x?: unknown | null) => x is import("@xyo-network/payload-model").WithSources<PaymentStatus>;
+/**
+ * Identity function for determine if an object is a PaymentStatus with meta
+ */
 export declare const isPaymentStatusWithMeta: (x?: unknown | null) => x is import("@xyo-network/payload-model").WithMeta<PaymentStatus>;
 //# sourceMappingURL=Payload.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"Payload.d.ts","sourceRoot":"","sources":["../../../../src/Payment/Status/Payload.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAA;AAOpE,OAAO,EAAE,mBAAmB,EAAE,MAAM,aAAa,CAAA;AAEjD,MAAM,WAAW,mBAAmB;IAIlC,MAAM,CAAC,EAAE,MAAM,CAAA;IAKf,MAAM,EAAE,MAAM,CAAA;CACf;AAKD,MAAM,MAAM,aAAa,GAAG,kBAAkB,CAAC,mBAAmB,EAAE,mBAAmB,CAAC,CAAA;AAKxF,eAAO,MAAM,eAAe,4CAA4D,CAAA;AAKxF,eAAO,MAAM,0BAA0B,8FAAuE,CAAA;AAK9G,eAAO,MAAM,uBAAuB,2FAAoE,CAAA"}
+{"version":3,"file":"Payload.d.ts","sourceRoot":"","sources":["../../../../src/Payment/Status/Payload.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAA;AAOpE,OAAO,EAAE,mBAAmB,EAAE,MAAM,aAAa,CAAA;AAEjD,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;IAEf;;OAEG;IACH,MAAM,EAAE,MAAM,CAAA;CACf;AAED;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG,kBAAkB,CAAC,mBAAmB,EAAE,mBAAmB,CAAC,CAAA;AAExF;;GAEG;AACH,eAAO,MAAM,eAAe,4CAA4D,CAAA;AAExF;;GAEG;AACH,eAAO,MAAM,0BAA0B,8FAAuE,CAAA;AAE9G;;GAEG;AACH,eAAO,MAAM,uBAAuB,2FAAoE,CAAA"}

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

@@ -2,11 +2,30 @@ import type { Hash } from '@xylabs/hex';
 import type { PayloadWithSources } from '@xyo-network/payload-model';
 import { PurchaseSchema } from './Schema.ts';
 export interface PurchaseFields {
+    /**
+     * The things that were purchased
+     */
     assets: Hash[];
+    /**
+     * The receipts for payments for this purchase.  Array to allow for multiple payments
+     * for a single quote.
+     */
     receipts: Hash[];
 }
+/**
+ * A purchase ties a payment made to a quote
+ */
 export type Purchase = PayloadWithSources<PurchaseFields, PurchaseSchema>;
+/**
+ * Identity function for determine if an object is a Purchase
+ */
 export declare const isPurchase: (x?: unknown | null) => x is Purchase;
+/**
+ * Identity function for determine if an object is a Purchase with sources
+ */
 export declare const isPurchaseWithSources: (x?: unknown | null) => x is import("@xyo-network/payload-model").WithSources<Purchase>;
+/**
+ * Identity function for determine if an object is a Purchase with meta
+ */
 export declare const isPurchaseWithMeta: (x?: unknown | null) => x is import("@xyo-network/payload-model").WithMeta<Purchase>;
 //# sourceMappingURL=Payload.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"Payload.d.ts","sourceRoot":"","sources":["../../../src/Purchase/Payload.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,aAAa,CAAA;AACvC,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAA;AAOpE,OAAO,EAAE,cAAc,EAAE,MAAM,aAAa,CAAA;AAE5C,MAAM,WAAW,cAAc;IAI7B,MAAM,EAAE,IAAI,EAAE,CAAA;IAKd,QAAQ,EAAE,IAAI,EAAE,CAAA;CACjB;AAKD,MAAM,MAAM,QAAQ,GAAG,kBAAkB,CAAC,cAAc,EAAE,cAAc,CAAC,CAAA;AAKzE,eAAO,MAAM,UAAU,uCAAkD,CAAA;AAKzE,eAAO,MAAM,qBAAqB,yFAA6D,CAAA;AAK/F,eAAO,MAAM,kBAAkB,sFAA0D,CAAA"}
+{"version":3,"file":"Payload.d.ts","sourceRoot":"","sources":["../../../src/Purchase/Payload.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,aAAa,CAAA;AACvC,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAA;AAOpE,OAAO,EAAE,cAAc,EAAE,MAAM,aAAa,CAAA;AAE5C,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,MAAM,EAAE,IAAI,EAAE,CAAA;IACd;;;OAGG;IACH,QAAQ,EAAE,IAAI,EAAE,CAAA;CACjB;AAED;;GAEG;AACH,MAAM,MAAM,QAAQ,GAAG,kBAAkB,CAAC,cAAc,EAAE,cAAc,CAAC,CAAA;AAEzE;;GAEG;AACH,eAAO,MAAM,UAAU,uCAAkD,CAAA;AAEzE;;GAEG;AACH,eAAO,MAAM,qBAAqB,yFAA6D,CAAA;AAE/F;;GAEG;AACH,eAAO,MAAM,kBAAkB,sFAA0D,CAAA"}

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

@@ -2,11 +2,29 @@ import type { PayloadWithSources } from '@xyo-network/payload-model';
 import type { SupportedCurrency } from '../Currency.ts';
 import { ReceiptSchema } from './Schema.ts';
 export interface ReceiptFields {
+    /**
+     * The amount paid
+     */
     amount: number;
+    /**
+     * The currency of the amount paid
+     */
     currency: SupportedCurrency;
 }
+/**
+ * A receipt is a record of a payment made
+ */
 export type Receipt = PayloadWithSources<ReceiptFields, ReceiptSchema>;
+/**
+ * Identity function for determine if an object is a Receipt
+ */
 export declare const isReceipt: (x?: unknown | null) => x is Receipt;
+/**
+ * Identity function for determine if an object is a Receipt with sources
+ */
 export declare const isReceiptWithSources: (x?: unknown | null) => x is import("@xyo-network/payload-model").WithSources<Receipt>;
+/**
+ * Identity function for determine if an object is a Receipt with meta
+ */
 export declare const isReceiptWithMeta: (x?: unknown | null) => x is import("@xyo-network/payload-model").WithMeta<Receipt>;
 //# sourceMappingURL=Payload.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"Payload.d.ts","sourceRoot":"","sources":["../../../src/Receipt/Payload.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAA;AAOpE,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,gBAAgB,CAAA;AACvD,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAA;AAE3C,MAAM,WAAW,aAAa;IAI5B,MAAM,EAAE,MAAM,CAAA;IAId,QAAQ,EAAE,iBAAiB,CAAA;CAC5B;AAKD,MAAM,MAAM,OAAO,GAAG,kBAAkB,CAAC,aAAa,EAAE,aAAa,CAAC,CAAA;AAKtE,eAAO,MAAM,SAAS,sCAAgD,CAAA;AAKtE,eAAO,MAAM,oBAAoB,wFAA2D,CAAA;AAK5F,eAAO,MAAM,iBAAiB,qFAAwD,CAAA"}
+{"version":3,"file":"Payload.d.ts","sourceRoot":"","sources":["../../../src/Receipt/Payload.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAA;AAOpE,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,gBAAgB,CAAA;AACvD,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAA;AAE3C,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAA;IACd;;OAEG;IACH,QAAQ,EAAE,iBAAiB,CAAA;CAC5B;AAED;;GAEG;AACH,MAAM,MAAM,OAAO,GAAG,kBAAkB,CAAC,aAAa,EAAE,aAAa,CAAC,CAAA;AAEtE;;GAEG;AACH,eAAO,MAAM,SAAS,sCAAgD,CAAA;AAEtE;;GAEG;AACH,eAAO,MAAM,oBAAoB,wFAA2D,CAAA;AAE5F;;GAEG;AACH,eAAO,MAAM,iBAAiB,qFAAwD,CAAA"}

package/dist/neutral/Subtotal/Diviner/Config.d.ts

@@ -1,5 +1,8 @@
 import type { DivinerConfig } from '@xyo-network/diviner-model';
 export declare const PaymentSubtotalDivinerConfigSchema = "network.xyo.diviner.payments.subtotal.config";
 export type PaymentSubtotalDivinerConfigSchema = typeof PaymentSubtotalDivinerConfigSchema;
+/**
+ * The configuration for the Coupon Subtotal Diviner
+ */
 export type PaymentSubtotalDivinerConfig = DivinerConfig<{}, PaymentSubtotalDivinerConfigSchema>;
 //# sourceMappingURL=Config.d.ts.map

package/dist/neutral/Subtotal/Diviner/Config.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Config.d.ts","sourceRoot":"","sources":["../../../../src/Subtotal/Diviner/Config.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAA;AAE/D,eAAO,MAAM,kCAAkC,iDAAiD,CAAA;AAChG,MAAM,MAAM,kCAAkC,GAAG,OAAO,kCAAkC,CAAA;AAK1F,MAAM,MAAM,4BAA4B,GAAG,aAAa,CACtD,EAAE,EACF,kCAAkC,CACnC,CAAA"}
+{"version":3,"file":"Config.d.ts","sourceRoot":"","sources":["../../../../src/Subtotal/Diviner/Config.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAA;AAE/D,eAAO,MAAM,kCAAkC,iDAAiD,CAAA;AAChG,MAAM,MAAM,kCAAkC,GAAG,OAAO,kCAAkC,CAAA;AAE1F;;GAEG;AACH,MAAM,MAAM,4BAA4B,GAAG,aAAa,CACtD,EAAE,EACF,kCAAkC,CACnC,CAAA"}

package/dist/neutral/Subtotal/Diviner/Payload.d.ts

@@ -4,8 +4,20 @@ export declare const SubtotalSchema: "network.xyo.payments.subtotal";
 export type SubtotalSchema = typeof SubtotalSchema;
 export interface SubtotalFields extends AmountFields {
 }
+/**
+ * The result of a subtotal
+ */
 export type Subtotal = PayloadWithSources<SubtotalFields, SubtotalSchema>;
+/**
+ * Identity function for determining if an object is an Subtotal
+ */
 export declare const isSubtotal: (x?: unknown | null) => x is Subtotal;
+/**
+ * Identity function for determining if an object is an Subtotal with sources
+ */
 export declare const isSubtotalWithSources: (x?: unknown | null) => x is import("@xyo-network/payload-model").WithSources<Subtotal>;
+/**
+ * Identity function for determining if an object is an Subtotal with meta
+ */
 export declare const isSubtotalWithMeta: (x?: unknown | null) => x is import("@xyo-network/payload-model").WithMeta<Subtotal>;
 //# sourceMappingURL=Payload.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"Payload.d.ts","sourceRoot":"","sources":["../../../../src/Subtotal/Diviner/Payload.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAA;AAOpE,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAA;AAEzD,eAAO,MAAM,cAAc,iCAA2C,CAAA;AACtE,MAAM,MAAM,cAAc,GAAG,OAAO,cAAc,CAAA;AAElD,MAAM,WAAW,cAAe,SAAQ,YAAY;CAAG;AAKvD,MAAM,MAAM,QAAQ,GAAG,kBAAkB,CAAC,cAAc,EAAE,cAAc,CAAC,CAAA;AAKzE,eAAO,MAAM,UAAU,uCAAkD,CAAA;AAKzE,eAAO,MAAM,qBAAqB,yFAA6D,CAAA;AAK/F,eAAO,MAAM,kBAAkB,sFAA0D,CAAA"}
+{"version":3,"file":"Payload.d.ts","sourceRoot":"","sources":["../../../../src/Subtotal/Diviner/Payload.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAA;AAOpE,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAA;AAEzD,eAAO,MAAM,cAAc,EAAG,+BAAwC,CAAA;AACtE,MAAM,MAAM,cAAc,GAAG,OAAO,cAAc,CAAA;AAElD,MAAM,WAAW,cAAe,SAAQ,YAAY;CAAG;AAEvD;;GAEG;AACH,MAAM,MAAM,QAAQ,GAAG,kBAAkB,CAAC,cAAc,EAAE,cAAc,CAAC,CAAA;AAEzE;;GAEG;AACH,eAAO,MAAM,UAAU,uCAAkD,CAAA;AAEzE;;GAEG;AACH,eAAO,MAAM,qBAAqB,yFAA6D,CAAA;AAE/F;;GAEG;AACH,eAAO,MAAM,kBAAkB,sFAA0D,CAAA"}