@bosonprotocol/core-sdk 1.29.0-ludo.1 → 1.29.0

package/dist/esm/offers/renderContractualAgreement.d.ts

@@ -1,54 +1,54 @@
-import * as yup from "yup";
-import { ITokenInfo } from "./../utils/tokenInfoManager";
-import { BigNumberish } from "@ethersproject/bignumber";
-import { CreateOfferArgs } from "./types";
-import { OfferFieldsFragment } from "../subgraph";
-export declare type AdditionalOfferMetadata = {
-    sellerContactMethod: string;
-    disputeResolverContactMethod: string;
-    escalationDeposit: BigNumberish;
-    escalationResponsePeriodInSec: BigNumberish;
-    sellerTradingName: string;
-    returnPeriodInDays: number;
-};
-export declare type TemplateRenderingData = CreateOfferArgs & AdditionalOfferMetadata & {
-    priceValue: string;
-    sellerDepositValue: string;
-    buyerCancelPenaltyValue: string;
-    escalationDepositValue: string;
-    exchangeTokenSymbol: string;
-    toISOString: () => void;
-    msecToDay: () => void;
-    secToDay: () => void;
-};
-export declare class InvalidOfferDataError extends Error {
-    missingProperties: string[];
-    constructor(missingProperties: string[]);
-}
-export declare class InvalidOfferMetadataError extends Error {
-    missingProperties: string[];
-    constructor(missingProperties: string[]);
-}
-export declare const baseOfferDataSchema: yup.SchemaOf<BaseOfferData>;
-export declare type BaseOfferData = {
-    price: BigNumberish;
-    sellerDeposit: BigNumberish;
-    agentId: BigNumberish;
-    buyerCancelPenalty: BigNumberish;
-    quantityAvailable: BigNumberish;
-    validFromDateInMS: BigNumberish;
-    validUntilDateInMS: BigNumberish;
-    voucherRedeemableFromDateInMS: BigNumberish;
-    voucherRedeemableUntilDateInMS: BigNumberish;
-    disputePeriodDurationInMS: BigNumberish;
-    resolutionPeriodDurationInMS: BigNumberish;
-    exchangeToken: string;
-    disputeResolverId: BigNumberish;
-    metadataUri: string;
-    metadataHash: string;
-};
-export declare const baseOfferMetadataSchema: yup.SchemaOf<AdditionalOfferMetadata>;
-export declare function prepareRenderingData(offerData: CreateOfferArgs, offerMetadata: AdditionalOfferMetadata, tokenInfo: ITokenInfo): Promise<TemplateRenderingData>;
-export declare function renderContractualAgreement(template: string, offerData: CreateOfferArgs, offerMetadata: AdditionalOfferMetadata, tokenInfo: ITokenInfo): Promise<string>;
-export declare function renderContractualAgreementForOffer(existingOfferData: OfferFieldsFragment): Promise<string>;
+import * as yup from "yup";
+import { ITokenInfo } from "./../utils/tokenInfoManager";
+import { BigNumberish } from "@ethersproject/bignumber";
+import { CreateOfferArgs } from "./types";
+import { OfferFieldsFragment } from "../subgraph";
+export type AdditionalOfferMetadata = {
+    sellerContactMethod: string;
+    disputeResolverContactMethod: string;
+    escalationDeposit: BigNumberish;
+    escalationResponsePeriodInSec: BigNumberish;
+    sellerTradingName: string;
+    returnPeriodInDays: number;
+};
+export type TemplateRenderingData = CreateOfferArgs & AdditionalOfferMetadata & {
+    priceValue: string;
+    sellerDepositValue: string;
+    buyerCancelPenaltyValue: string;
+    escalationDepositValue: string;
+    exchangeTokenSymbol: string;
+    toISOString: () => void;
+    msecToDay: () => void;
+    secToDay: () => void;
+};
+export declare class InvalidOfferDataError extends Error {
+    missingProperties: string[];
+    constructor(missingProperties: string[]);
+}
+export declare class InvalidOfferMetadataError extends Error {
+    missingProperties: string[];
+    constructor(missingProperties: string[]);
+}
+export declare const baseOfferDataSchema: yup.SchemaOf<BaseOfferData>;
+export type BaseOfferData = {
+    price: BigNumberish;
+    sellerDeposit: BigNumberish;
+    agentId: BigNumberish;
+    buyerCancelPenalty: BigNumberish;
+    quantityAvailable: BigNumberish;
+    validFromDateInMS: BigNumberish;
+    validUntilDateInMS: BigNumberish;
+    voucherRedeemableFromDateInMS: BigNumberish;
+    voucherRedeemableUntilDateInMS: BigNumberish;
+    disputePeriodDurationInMS: BigNumberish;
+    resolutionPeriodDurationInMS: BigNumberish;
+    exchangeToken: string;
+    disputeResolverId: BigNumberish;
+    metadataUri: string;
+    metadataHash: string;
+};
+export declare const baseOfferMetadataSchema: yup.SchemaOf<AdditionalOfferMetadata>;
+export declare function prepareRenderingData(offerData: CreateOfferArgs, offerMetadata: AdditionalOfferMetadata, tokenInfo: ITokenInfo): Promise<TemplateRenderingData>;
+export declare function renderContractualAgreement(template: string, offerData: CreateOfferArgs, offerMetadata: AdditionalOfferMetadata, tokenInfo: ITokenInfo): Promise<string>;
+export declare function renderContractualAgreementForOffer(existingOfferData: OfferFieldsFragment): Promise<string>;
 //# sourceMappingURL=renderContractualAgreement.d.ts.map

package/dist/esm/offers/renderContractualAgreement.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"renderContractualAgreement.d.ts","sourceRoot":"","sources":["../../../src/offers/renderContractualAgreement.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,GAAG,MAAM,KAAK,CAAC;AAC3B,OAAO,EAAE,UAAU,EAAE,MAAM,6BAA6B,CAAC;AACzD,OAAO,EAAa,YAAY,EAAE,MAAM,0BAA0B,CAAC;AAMnE,OAAO,EAAE,eAAe,EAAE,MAAM,SAAS,CAAC;AAC1C,OAAO,EACL,mBAAmB,EAGpB,MAAM,aAAa,CAAC;AAErB,oBAAY,uBAAuB,GAAG;IACpC,mBAAmB,EAAE,MAAM,CAAC;IAC5B,4BAA4B,EAAE,MAAM,CAAC;IACrC,iBAAiB,EAAE,YAAY,CAAC;IAChC,6BAA6B,EAAE,YAAY,CAAC;IAC5C,iBAAiB,EAAE,MAAM,CAAC;IAC1B,kBAAkB,EAAE,MAAM,CAAC;CAC5B,CAAC;AAEF,oBAAY,qBAAqB,GAAG,eAAe,GACjD,uBAAuB,GAAG;IACxB,UAAU,EAAE,MAAM,CAAC;IACnB,kBAAkB,EAAE,MAAM,CAAC;IAC3B,uBAAuB,EAAE,MAAM,CAAC;IAChC,sBAAsB,EAAE,MAAM,CAAC;IAC/B,mBAAmB,EAAE,MAAM,CAAC;IAC5B,WAAW,EAAE,MAAM,IAAI,CAAC;IACxB,SAAS,EAAE,MAAM,IAAI,CAAC;IACtB,QAAQ,EAAE,MAAM,IAAI,CAAC;CACtB,CAAC;AAEJ,qBAAa,qBAAsB,SAAQ,KAAK;IAC3B,iBAAiB,EAAE,MAAM,EAAE;gBAA3B,iBAAiB,EAAE,MAAM,EAAE;CAK/C;AAED,qBAAa,yBAA0B,SAAQ,KAAK;IAC/B,iBAAiB,EAAE,MAAM,EAAE;gBAA3B,iBAAiB,EAAE,MAAM,EAAE;CAO/C;AAED,eAAO,MAAM,mBAAmB,EAAE,GAAG,CAAC,QAAQ,CAAC,aAAa,CAgB1D,CAAC;AAEH,oBAAY,aAAa,GAAG;IAC1B,KAAK,EAAE,YAAY,CAAC;IACpB,aAAa,EAAE,YAAY,CAAC;IAC5B,OAAO,EAAE,YAAY,CAAC;IACtB,kBAAkB,EAAE,YAAY,CAAC;IACjC,iBAAiB,EAAE,YAAY,CAAC;IAChC,iBAAiB,EAAE,YAAY,CAAC;IAChC,kBAAkB,EAAE,YAAY,CAAC;IACjC,6BAA6B,EAAE,YAAY,CAAC;IAC5C,8BAA8B,EAAE,YAAY,CAAC;IAC7C,yBAAyB,EAAE,YAAY,CAAC;IACxC,4BAA4B,EAAE,YAAY,CAAC;IAC3C,aAAa,EAAE,MAAM,CAAC;IACtB,iBAAiB,EAAE,YAAY,CAAC;IAChC,WAAW,EAAE,MAAM,CAAC;IACpB,YAAY,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF,eAAO,MAAM,uBAAuB,EAAE,GAAG,CAAC,QAAQ,CAAC,uBAAuB,CAQtE,CAAC;AA4GL,wBAAsB,oBAAoB,CACxC,SAAS,EAAE,eAAe,EAC1B,aAAa,EAAE,uBAAuB,EACtC,SAAS,EAAE,UAAU,GACpB,OAAO,CAAC,qBAAqB,CAAC,CAkDhC;AAGD,wBAAsB,0BAA0B,CAC9C,QAAQ,EAAE,MAAM,EAChB,SAAS,EAAE,eAAe,EAC1B,aAAa,EAAE,uBAAuB,EACtC,SAAS,EAAE,UAAU,GACpB,OAAO,CAAC,MAAM,CAAC,CAUjB;AAED,wBAAsB,kCAAkC,CACtD,iBAAiB,EAAE,mBAAmB,GACrC,OAAO,CAAC,MAAM,CAAC,CA+BjB"}
+{"version":3,"file":"renderContractualAgreement.d.ts","sourceRoot":"","sources":["../../../src/offers/renderContractualAgreement.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,GAAG,MAAM,KAAK,CAAC;AAC3B,OAAO,EAAE,UAAU,EAAE,MAAM,6BAA6B,CAAC;AACzD,OAAO,EAAa,YAAY,EAAE,MAAM,0BAA0B,CAAC;AAMnE,OAAO,EAAE,eAAe,EAAE,MAAM,SAAS,CAAC;AAC1C,OAAO,EACL,mBAAmB,EAGpB,MAAM,aAAa,CAAC;AAErB,MAAM,MAAM,uBAAuB,GAAG;IACpC,mBAAmB,EAAE,MAAM,CAAC;IAC5B,4BAA4B,EAAE,MAAM,CAAC;IACrC,iBAAiB,EAAE,YAAY,CAAC;IAChC,6BAA6B,EAAE,YAAY,CAAC;IAC5C,iBAAiB,EAAE,MAAM,CAAC;IAC1B,kBAAkB,EAAE,MAAM,CAAC;CAC5B,CAAC;AAEF,MAAM,MAAM,qBAAqB,GAAG,eAAe,GACjD,uBAAuB,GAAG;IACxB,UAAU,EAAE,MAAM,CAAC;IACnB,kBAAkB,EAAE,MAAM,CAAC;IAC3B,uBAAuB,EAAE,MAAM,CAAC;IAChC,sBAAsB,EAAE,MAAM,CAAC;IAC/B,mBAAmB,EAAE,MAAM,CAAC;IAC5B,WAAW,EAAE,MAAM,IAAI,CAAC;IACxB,SAAS,EAAE,MAAM,IAAI,CAAC;IACtB,QAAQ,EAAE,MAAM,IAAI,CAAC;CACtB,CAAC;AAEJ,qBAAa,qBAAsB,SAAQ,KAAK;IAC3B,iBAAiB,EAAE,MAAM,EAAE;gBAA3B,iBAAiB,EAAE,MAAM,EAAE;CAK/C;AAED,qBAAa,yBAA0B,SAAQ,KAAK;IAC/B,iBAAiB,EAAE,MAAM,EAAE;gBAA3B,iBAAiB,EAAE,MAAM,EAAE;CAO/C;AAED,eAAO,MAAM,mBAAmB,EAAE,GAAG,CAAC,QAAQ,CAAC,aAAa,CAgB1D,CAAC;AAEH,MAAM,MAAM,aAAa,GAAG;IAC1B,KAAK,EAAE,YAAY,CAAC;IACpB,aAAa,EAAE,YAAY,CAAC;IAC5B,OAAO,EAAE,YAAY,CAAC;IACtB,kBAAkB,EAAE,YAAY,CAAC;IACjC,iBAAiB,EAAE,YAAY,CAAC;IAChC,iBAAiB,EAAE,YAAY,CAAC;IAChC,kBAAkB,EAAE,YAAY,CAAC;IACjC,6BAA6B,EAAE,YAAY,CAAC;IAC5C,8BAA8B,EAAE,YAAY,CAAC;IAC7C,yBAAyB,EAAE,YAAY,CAAC;IACxC,4BAA4B,EAAE,YAAY,CAAC;IAC3C,aAAa,EAAE,MAAM,CAAC;IACtB,iBAAiB,EAAE,YAAY,CAAC;IAChC,WAAW,EAAE,MAAM,CAAC;IACpB,YAAY,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF,eAAO,MAAM,uBAAuB,EAAE,GAAG,CAAC,QAAQ,CAAC,uBAAuB,CAQtE,CAAC;AA4GL,wBAAsB,oBAAoB,CACxC,SAAS,EAAE,eAAe,EAC1B,aAAa,EAAE,uBAAuB,EACtC,SAAS,EAAE,UAAU,GACpB,OAAO,CAAC,qBAAqB,CAAC,CAkDhC;AAGD,wBAAsB,0BAA0B,CAC9C,QAAQ,EAAE,MAAM,EAChB,SAAS,EAAE,eAAe,EAC1B,aAAa,EAAE,uBAAuB,EACtC,SAAS,EAAE,UAAU,GACpB,OAAO,CAAC,MAAM,CAAC,CAUjB;AAED,wBAAsB,kCAAkC,CACtD,iBAAiB,EAAE,mBAAmB,GACrC,OAAO,CAAC,MAAM,CAAC,CA+BjB"}

package/dist/esm/offers/renderContractualAgreement.js

@@ -1,209 +1,209 @@
-import * as yup from "yup";
-import { BigNumber } from "@ethersproject/bignumber";
-import { utils } from "@bosonprotocol/common";
-import Mustache from "mustache";
-import { formatUnits } from "@ethersproject/units";
-import { MetadataType } from "../subgraph";
-export class InvalidOfferDataError extends Error {
-    missingProperties;
-    constructor(missingProperties) {
-        super(`InvalidOfferData - missing properties: [${missingProperties.join(",")}]`);
-        this.missingProperties = missingProperties;
-    }
-}
-export class InvalidOfferMetadataError extends Error {
-    missingProperties;
-    constructor(missingProperties) {
-        super(`InvalidOfferMetadata - missing properties: [${missingProperties.join(",")}]`);
-        this.missingProperties = missingProperties;
-    }
-}
-export const baseOfferDataSchema = yup.object({
-    price: yup.mixed().required(),
-    sellerDeposit: yup.mixed().required(),
-    agentId: yup.mixed().required(),
-    buyerCancelPenalty: yup.mixed().required(),
-    quantityAvailable: yup.mixed().required(),
-    validFromDateInMS: yup.mixed().required(),
-    validUntilDateInMS: yup.mixed().required(),
-    voucherRedeemableFromDateInMS: yup.mixed().required(),
-    voucherRedeemableUntilDateInMS: yup.mixed().required(),
-    disputePeriodDurationInMS: yup.mixed().required(),
-    resolutionPeriodDurationInMS: yup.mixed().required(),
-    exchangeToken: yup.string().required(),
-    disputeResolverId: yup.mixed().required(),
-    metadataUri: yup.string().required(),
-    metadataHash: yup.string().required()
-});
-export const baseOfferMetadataSchema = yup.object({
-    sellerContactMethod: yup.string().required(),
-    disputeResolverContactMethod: yup.string().required(),
-    escalationDeposit: yup.mixed().required(),
-    escalationResponsePeriodInSec: yup.mixed().required(),
-    sellerTradingName: yup.string().required(),
-    returnPeriodInDays: yup.number().required()
-});
-function checkOfferDataIsValid(offerData, throwIfInvalid = false) {
-    if (offerData === undefined || offerData === null) {
-        throw new Error("InvalidOfferData - undefined");
-    }
-    if (typeof offerData !== "object") {
-        throw new Error("InvalidOfferData - expecting an object");
-    }
-    try {
-        baseOfferDataSchema.validateSync(offerData, { abortEarly: false });
-    }
-    catch (e) {
-        const missingProperties = [];
-        const getMissingProp = (error) => {
-            return error.match(/(.*) is a required field/)[1] || error;
-        };
-        if (throwIfInvalid) {
-            if (e.errors) {
-                e.errors.forEach((error) => {
-                    missingProperties.push(getMissingProp(error));
-                });
-            }
-            else {
-                missingProperties.push(getMissingProp(e));
-            }
-            throw new InvalidOfferDataError(missingProperties);
-        }
-        return false;
-    }
-    return true;
-}
-function checkOfferMetadataIsValid(offerMetadata, throwIfInvalid = false) {
-    if (offerMetadata === undefined || offerMetadata === null) {
-        throw new Error("InvalidOfferMetadata - undefined");
-    }
-    if (typeof offerMetadata !== "object") {
-        throw new Error("InvalidOfferMetadata - expecting an object");
-    }
-    try {
-        baseOfferMetadataSchema.validateSync(offerMetadata, { abortEarly: false });
-    }
-    catch (e) {
-        const missingProperties = [];
-        const getMissingProp = (error) => {
-            return error.match(/(.*) is a required field/)[1] || error;
-        };
-        if (throwIfInvalid) {
-            if (e.errors) {
-                e.errors.forEach((error) => {
-                    missingProperties.push(getMissingProp(error));
-                });
-            }
-            else {
-                missingProperties.push(getMissingProp(e));
-            }
-            throw new InvalidOfferMetadataError(missingProperties);
-        }
-        return false;
-    }
-    return true;
-}
-function convertExistingOfferData(offerDataSubGraph) {
-    return {
-        offerData: {
-            ...offerDataSubGraph,
-            validFromDateInMS: offerDataSubGraph.validFromDate,
-            validUntilDateInMS: offerDataSubGraph.validUntilDate,
-            voucherRedeemableFromDateInMS: offerDataSubGraph.voucherRedeemableFromDate,
-            voucherRedeemableUntilDateInMS: offerDataSubGraph.voucherRedeemableUntilDate,
-            disputePeriodDurationInMS: offerDataSubGraph.disputePeriodDuration,
-            resolutionPeriodDurationInMS: offerDataSubGraph.resolutionPeriodDuration,
-            exchangeToken: offerDataSubGraph.exchangeToken.address
-        },
-        offerMetadata: {
-            sellerContactMethod: offerDataSubGraph.metadata?.exchangePolicy.sellerContactMethod,
-            disputeResolverContactMethod: offerDataSubGraph.metadata?.exchangePolicy.disputeResolverContactMethod,
-            escalationDeposit: offerDataSubGraph.disputeResolutionTerms.buyerEscalationDeposit,
-            escalationResponsePeriodInSec: offerDataSubGraph.disputeResolutionTerms.escalationResponsePeriod,
-            sellerTradingName: offerDataSubGraph.metadata
-                ?.productV1Seller?.name,
-            returnPeriodInDays: offerDataSubGraph.metadata?.shipping.returnPeriodInDays
-        },
-        tokenInfo: {
-            ...offerDataSubGraph.exchangeToken,
-            decimals: parseInt(offerDataSubGraph.exchangeToken.decimals)
-        }
-    };
-}
-export async function prepareRenderingData(offerData, offerMetadata, tokenInfo) {
-    return {
-        ...offerData,
-        ...offerMetadata,
-        priceValue: formatUnits(offerData.price, tokenInfo.decimals),
-        exchangeTokenSymbol: tokenInfo.symbol,
-        sellerDepositValue: formatUnits(offerData.sellerDeposit, tokenInfo.decimals),
-        buyerCancelPenaltyValue: formatUnits(offerData.buyerCancelPenalty, tokenInfo.decimals),
-        escalationDepositValue: formatUnits(offerMetadata.escalationDeposit, tokenInfo.decimals),
-        toISOString: function () {
-            return function (num, render) {
-                try {
-                    return new Date(parseInt(render(num))).toISOString();
-                }
-                catch {
-                    return `[[${num} - invalid Date]]`;
-                }
-            };
-        },
-        msecToDay: function () {
-            return function (num, render) {
-                try {
-                    return BigNumber.from(render(num))
-                        .div(utils.timestamp.MSEC_PER_DAY)
-                        .toString();
-                }
-                catch {
-                    return `[[${num} - invalid BigNumber]]`;
-                }
-            };
-        },
-        secToDay: function () {
-            return function (num, render) {
-                try {
-                    return BigNumber.from(render(num))
-                        .div(utils.timestamp.SEC_PER_DAY)
-                        .toString();
-                }
-                catch {
-                    return `[[${num} - invalid BigNumber]]`;
-                }
-            };
-        }
-    };
-}
-// inject a template + all offer details
-export async function renderContractualAgreement(template, offerData, offerMetadata, tokenInfo) {
-    // Check the passed offerData is matching the required type
-    checkOfferDataIsValid(offerData, true);
-    checkOfferMetadataIsValid(offerMetadata, true);
-    const preparedData = await prepareRenderingData(offerData, offerMetadata, tokenInfo);
-    return Mustache.render(template, preparedData);
-}
-export async function renderContractualAgreementForOffer(existingOfferData) {
-    if (!existingOfferData) {
-        throw new Error(`offerData is undefined`);
-    }
-    if (!existingOfferData.metadata) {
-        throw new Error(`Offer Metadata is undefined`);
-    }
-    if (existingOfferData.metadata.type !== MetadataType.ProductV1) {
-        throw new Error(`Invalid Offer Metadata: Type is not supported: '${existingOfferData.metadata.type}'`);
-    }
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    if (!existingOfferData.metadata.exchangePolicy) {
-        throw new Error(`Invalid Offer Metadata: exchangePolicy is not defined`);
-    }
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    if (!existingOfferData.metadata.exchangePolicy.template) {
-        throw new Error(`Invalid Offer Metadata: exchangePolicy.template is not defined`);
-    }
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    const template = existingOfferData.metadata.exchangePolicy.template;
-    const convertedOfferArgs = convertExistingOfferData(existingOfferData);
-    return renderContractualAgreement(template, convertedOfferArgs.offerData, convertedOfferArgs.offerMetadata, convertedOfferArgs.tokenInfo);
-}
+import * as yup from "yup";
+import { BigNumber } from "@ethersproject/bignumber";
+import { utils } from "@bosonprotocol/common";
+import Mustache from "mustache";
+import { formatUnits } from "@ethersproject/units";
+import { MetadataType } from "../subgraph";
+export class InvalidOfferDataError extends Error {
+    missingProperties;
+    constructor(missingProperties) {
+        super(`InvalidOfferData - missing properties: [${missingProperties.join(",")}]`);
+        this.missingProperties = missingProperties;
+    }
+}
+export class InvalidOfferMetadataError extends Error {
+    missingProperties;
+    constructor(missingProperties) {
+        super(`InvalidOfferMetadata - missing properties: [${missingProperties.join(",")}]`);
+        this.missingProperties = missingProperties;
+    }
+}
+export const baseOfferDataSchema = yup.object({
+    price: yup.mixed().required(),
+    sellerDeposit: yup.mixed().required(),
+    agentId: yup.mixed().required(),
+    buyerCancelPenalty: yup.mixed().required(),
+    quantityAvailable: yup.mixed().required(),
+    validFromDateInMS: yup.mixed().required(),
+    validUntilDateInMS: yup.mixed().required(),
+    voucherRedeemableFromDateInMS: yup.mixed().required(),
+    voucherRedeemableUntilDateInMS: yup.mixed().required(),
+    disputePeriodDurationInMS: yup.mixed().required(),
+    resolutionPeriodDurationInMS: yup.mixed().required(),
+    exchangeToken: yup.string().required(),
+    disputeResolverId: yup.mixed().required(),
+    metadataUri: yup.string().required(),
+    metadataHash: yup.string().required()
+});
+export const baseOfferMetadataSchema = yup.object({
+    sellerContactMethod: yup.string().required(),
+    disputeResolverContactMethod: yup.string().required(),
+    escalationDeposit: yup.mixed().required(),
+    escalationResponsePeriodInSec: yup.mixed().required(),
+    sellerTradingName: yup.string().required(),
+    returnPeriodInDays: yup.number().required()
+});
+function checkOfferDataIsValid(offerData, throwIfInvalid = false) {
+    if (offerData === undefined || offerData === null) {
+        throw new Error("InvalidOfferData - undefined");
+    }
+    if (typeof offerData !== "object") {
+        throw new Error("InvalidOfferData - expecting an object");
+    }
+    try {
+        baseOfferDataSchema.validateSync(offerData, { abortEarly: false });
+    }
+    catch (e) {
+        const missingProperties = [];
+        const getMissingProp = (error) => {
+            return error.match(/(.*) is a required field/)[1] || error;
+        };
+        if (throwIfInvalid) {
+            if (e.errors) {
+                e.errors.forEach((error) => {
+                    missingProperties.push(getMissingProp(error));
+                });
+            }
+            else {
+                missingProperties.push(getMissingProp(e));
+            }
+            throw new InvalidOfferDataError(missingProperties);
+        }
+        return false;
+    }
+    return true;
+}
+function checkOfferMetadataIsValid(offerMetadata, throwIfInvalid = false) {
+    if (offerMetadata === undefined || offerMetadata === null) {
+        throw new Error("InvalidOfferMetadata - undefined");
+    }
+    if (typeof offerMetadata !== "object") {
+        throw new Error("InvalidOfferMetadata - expecting an object");
+    }
+    try {
+        baseOfferMetadataSchema.validateSync(offerMetadata, { abortEarly: false });
+    }
+    catch (e) {
+        const missingProperties = [];
+        const getMissingProp = (error) => {
+            return error.match(/(.*) is a required field/)[1] || error;
+        };
+        if (throwIfInvalid) {
+            if (e.errors) {
+                e.errors.forEach((error) => {
+                    missingProperties.push(getMissingProp(error));
+                });
+            }
+            else {
+                missingProperties.push(getMissingProp(e));
+            }
+            throw new InvalidOfferMetadataError(missingProperties);
+        }
+        return false;
+    }
+    return true;
+}
+function convertExistingOfferData(offerDataSubGraph) {
+    return {
+        offerData: {
+            ...offerDataSubGraph,
+            validFromDateInMS: offerDataSubGraph.validFromDate,
+            validUntilDateInMS: offerDataSubGraph.validUntilDate,
+            voucherRedeemableFromDateInMS: offerDataSubGraph.voucherRedeemableFromDate,
+            voucherRedeemableUntilDateInMS: offerDataSubGraph.voucherRedeemableUntilDate,
+            disputePeriodDurationInMS: offerDataSubGraph.disputePeriodDuration,
+            resolutionPeriodDurationInMS: offerDataSubGraph.resolutionPeriodDuration,
+            exchangeToken: offerDataSubGraph.exchangeToken.address
+        },
+        offerMetadata: {
+            sellerContactMethod: offerDataSubGraph.metadata?.exchangePolicy.sellerContactMethod,
+            disputeResolverContactMethod: offerDataSubGraph.metadata?.exchangePolicy.disputeResolverContactMethod,
+            escalationDeposit: offerDataSubGraph.disputeResolutionTerms.buyerEscalationDeposit,
+            escalationResponsePeriodInSec: offerDataSubGraph.disputeResolutionTerms.escalationResponsePeriod,
+            sellerTradingName: offerDataSubGraph.metadata
+                ?.productV1Seller?.name,
+            returnPeriodInDays: offerDataSubGraph.metadata?.shipping.returnPeriodInDays
+        },
+        tokenInfo: {
+            ...offerDataSubGraph.exchangeToken,
+            decimals: parseInt(offerDataSubGraph.exchangeToken.decimals)
+        }
+    };
+}
+export async function prepareRenderingData(offerData, offerMetadata, tokenInfo) {
+    return {
+        ...offerData,
+        ...offerMetadata,
+        priceValue: formatUnits(offerData.price, tokenInfo.decimals),
+        exchangeTokenSymbol: tokenInfo.symbol,
+        sellerDepositValue: formatUnits(offerData.sellerDeposit, tokenInfo.decimals),
+        buyerCancelPenaltyValue: formatUnits(offerData.buyerCancelPenalty, tokenInfo.decimals),
+        escalationDepositValue: formatUnits(offerMetadata.escalationDeposit, tokenInfo.decimals),
+        toISOString: function () {
+            return function (num, render) {
+                try {
+                    return new Date(parseInt(render(num))).toISOString();
+                }
+                catch {
+                    return `[[${num} - invalid Date]]`;
+                }
+            };
+        },
+        msecToDay: function () {
+            return function (num, render) {
+                try {
+                    return BigNumber.from(render(num))
+                        .div(utils.timestamp.MSEC_PER_DAY)
+                        .toString();
+                }
+                catch {
+                    return `[[${num} - invalid BigNumber]]`;
+                }
+            };
+        },
+        secToDay: function () {
+            return function (num, render) {
+                try {
+                    return BigNumber.from(render(num))
+                        .div(utils.timestamp.SEC_PER_DAY)
+                        .toString();
+                }
+                catch {
+                    return `[[${num} - invalid BigNumber]]`;
+                }
+            };
+        }
+    };
+}
+// inject a template + all offer details
+export async function renderContractualAgreement(template, offerData, offerMetadata, tokenInfo) {
+    // Check the passed offerData is matching the required type
+    checkOfferDataIsValid(offerData, true);
+    checkOfferMetadataIsValid(offerMetadata, true);
+    const preparedData = await prepareRenderingData(offerData, offerMetadata, tokenInfo);
+    return Mustache.render(template, preparedData);
+}
+export async function renderContractualAgreementForOffer(existingOfferData) {
+    if (!existingOfferData) {
+        throw new Error(`offerData is undefined`);
+    }
+    if (!existingOfferData.metadata) {
+        throw new Error(`Offer Metadata is undefined`);
+    }
+    if (existingOfferData.metadata.type !== MetadataType.ProductV1) {
+        throw new Error(`Invalid Offer Metadata: Type is not supported: '${existingOfferData.metadata.type}'`);
+    }
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    if (!existingOfferData.metadata.exchangePolicy) {
+        throw new Error(`Invalid Offer Metadata: exchangePolicy is not defined`);
+    }
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    if (!existingOfferData.metadata.exchangePolicy.template) {
+        throw new Error(`Invalid Offer Metadata: exchangePolicy.template is not defined`);
+    }
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    const template = existingOfferData.metadata.exchangePolicy.template;
+    const convertedOfferArgs = convertExistingOfferData(existingOfferData);
+    return renderContractualAgreement(template, convertedOfferArgs.offerData, convertedOfferArgs.offerMetadata, convertedOfferArgs.tokenInfo);
+}
 //# sourceMappingURL=renderContractualAgreement.js.map

package/dist/esm/offers/storage.d.ts

@@ -1,13 +1,13 @@
-import { MetadataStorage } from "@bosonprotocol/common";
-/**
- * We use the feature `ipfsOnEthereum` in our subgraph to resolve metadata from IPFS
- * and store them in the graph. In order for the graph node to reliably resolve them,
- * we need to add the metadata additionally to the IPFS node of the graph.
- * See https://thegraph.com/docs/en/developer/assemblyscript-api/#ipfs-api
- */
-export declare function storeMetadataOnTheGraph(args: {
-    metadataUriOrHash: string;
-    metadataStorage?: MetadataStorage;
-    theGraphStorage?: MetadataStorage;
-}): Promise<string | null>;
+import { MetadataStorage } from "@bosonprotocol/common";
+/**
+ * We use the feature `ipfsOnEthereum` in our subgraph to resolve metadata from IPFS
+ * and store them in the graph. In order for the graph node to reliably resolve them,
+ * we need to add the metadata additionally to the IPFS node of the graph.
+ * See https://thegraph.com/docs/en/developer/assemblyscript-api/#ipfs-api
+ */
+export declare function storeMetadataOnTheGraph(args: {
+    metadataUriOrHash: string;
+    metadataStorage?: MetadataStorage;
+    theGraphStorage?: MetadataStorage;
+}): Promise<string | null>;
 //# sourceMappingURL=storage.d.ts.map

package/dist/esm/offers/storage.js

@@ -1,15 +1,15 @@
-/**
- * We use the feature `ipfsOnEthereum` in our subgraph to resolve metadata from IPFS
- * and store them in the graph. In order for the graph node to reliably resolve them,
- * we need to add the metadata additionally to the IPFS node of the graph.
- * See https://thegraph.com/docs/en/developer/assemblyscript-api/#ipfs-api
- */
-export async function storeMetadataOnTheGraph(args) {
-    if (args.metadataStorage && args.theGraphStorage) {
-        const metadata = await args.metadataStorage.getMetadata(args.metadataUriOrHash);
-        const metadataUri = await args.theGraphStorage.storeMetadata(metadata);
-        return metadataUri;
-    }
-    return null;
-}
+/**
+ * We use the feature `ipfsOnEthereum` in our subgraph to resolve metadata from IPFS
+ * and store them in the graph. In order for the graph node to reliably resolve them,
+ * we need to add the metadata additionally to the IPFS node of the graph.
+ * See https://thegraph.com/docs/en/developer/assemblyscript-api/#ipfs-api
+ */
+export async function storeMetadataOnTheGraph(args) {
+    if (args.metadataStorage && args.theGraphStorage) {
+        const metadata = await args.metadataStorage.getMetadata(args.metadataUriOrHash);
+        const metadataUri = await args.theGraphStorage.storeMetadata(metadata);
+        return metadataUri;
+    }
+    return null;
+}
 //# sourceMappingURL=storage.js.map

package/dist/esm/offers/subgraph.d.ts

@@ -1,6 +1,6 @@
-import { BigNumberish } from "@ethersproject/bignumber";
-import { OfferFieldsFragment, GetOfferByIdQueryQueryVariables, GetOffersQueryQueryVariables } from "../subgraph";
-export declare type SingleOfferQueryVariables = Omit<GetOfferByIdQueryQueryVariables, "offerId">;
-export declare function getOfferById(subgraphUrl: string, offerId: BigNumberish, queryVars?: SingleOfferQueryVariables): Promise<OfferFieldsFragment>;
-export declare function getOffers(subgraphUrl: string, queryVars?: GetOffersQueryQueryVariables): Promise<OfferFieldsFragment[]>;
+import { BigNumberish } from "@ethersproject/bignumber";
+import { OfferFieldsFragment, GetOfferByIdQueryQueryVariables, GetOffersQueryQueryVariables } from "../subgraph";
+export type SingleOfferQueryVariables = Omit<GetOfferByIdQueryQueryVariables, "offerId">;
+export declare function getOfferById(subgraphUrl: string, offerId: BigNumberish, queryVars?: SingleOfferQueryVariables): Promise<OfferFieldsFragment>;
+export declare function getOffers(subgraphUrl: string, queryVars?: GetOffersQueryQueryVariables): Promise<OfferFieldsFragment[]>;
 //# sourceMappingURL=subgraph.d.ts.map

package/dist/esm/offers/subgraph.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"subgraph.d.ts","sourceRoot":"","sources":["../../../src/offers/subgraph.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAC;AAExD,OAAO,EACL,mBAAmB,EACnB,+BAA+B,EAC/B,4BAA4B,EAC7B,MAAM,aAAa,CAAC;AAErB,oBAAY,yBAAyB,GAAG,IAAI,CAC1C,+BAA+B,EAC/B,SAAS,CACV,CAAC;AAEF,wBAAsB,YAAY,CAChC,WAAW,EAAE,MAAM,EACnB,OAAO,EAAE,YAAY,EACrB,SAAS,GAAE,yBAA8B,GACxC,OAAO,CAAC,mBAAmB,CAAC,CAO9B;AAED,wBAAsB,SAAS,CAC7B,WAAW,EAAE,MAAM,EACnB,SAAS,GAAE,4BAAiC,GAC3C,OAAO,CAAC,mBAAmB,EAAE,CAAC,CAOhC"}
+{"version":3,"file":"subgraph.d.ts","sourceRoot":"","sources":["../../../src/offers/subgraph.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAC;AAExD,OAAO,EACL,mBAAmB,EACnB,+BAA+B,EAC/B,4BAA4B,EAC7B,MAAM,aAAa,CAAC;AAErB,MAAM,MAAM,yBAAyB,GAAG,IAAI,CAC1C,+BAA+B,EAC/B,SAAS,CACV,CAAC;AAEF,wBAAsB,YAAY,CAChC,WAAW,EAAE,MAAM,EACnB,OAAO,EAAE,YAAY,EACrB,SAAS,GAAE,yBAA8B,GACxC,OAAO,CAAC,mBAAmB,CAAC,CAO9B;AAED,wBAAsB,SAAS,CAC7B,WAAW,EAAE,MAAM,EACnB,SAAS,GAAE,4BAAiC,GAC3C,OAAO,CAAC,mBAAmB,EAAE,CAAC,CAOhC"}

package/dist/esm/offers/subgraph.js

@@ -1,17 +1,17 @@
-import { getSubgraphSdk } from "../utils/graphql";
-export async function getOfferById(subgraphUrl, offerId, queryVars = {}) {
-    const subgraphSdk = getSubgraphSdk(subgraphUrl);
-    const { offer } = await subgraphSdk.getOfferByIdQuery({
-        offerId: offerId.toString(),
-        ...queryVars
-    });
-    return offer;
-}
-export async function getOffers(subgraphUrl, queryVars = {}) {
-    const subgraphSdk = getSubgraphSdk(subgraphUrl);
-    const { offers = [] } = await subgraphSdk.getOffersQuery({
-        ...queryVars
-    });
-    return offers;
-}
+import { getSubgraphSdk } from "../utils/graphql";
+export async function getOfferById(subgraphUrl, offerId, queryVars = {}) {
+    const subgraphSdk = getSubgraphSdk(subgraphUrl);
+    const { offer } = await subgraphSdk.getOfferByIdQuery({
+        offerId: offerId.toString(),
+        ...queryVars
+    });
+    return offer;
+}
+export async function getOffers(subgraphUrl, queryVars = {}) {
+    const subgraphSdk = getSubgraphSdk(subgraphUrl);
+    const { offers = [] } = await subgraphSdk.getOffersQuery({
+        ...queryVars
+    });
+    return offers;
+}
 //# sourceMappingURL=subgraph.js.map