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

package/dist/cjs/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/cjs/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/cjs/offers/renderContractualAgreement.js

@@ -1,233 +1,233 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.renderContractualAgreementForOffer = exports.renderContractualAgreement = exports.prepareRenderingData = exports.baseOfferMetadataSchema = exports.baseOfferDataSchema = exports.InvalidOfferMetadataError = exports.InvalidOfferDataError = void 0;
-const yup = __importStar(require("yup"));
-const bignumber_1 = require("@ethersproject/bignumber");
-const common_1 = require("@bosonprotocol/common");
-const mustache_1 = __importDefault(require("mustache"));
-const units_1 = require("@ethersproject/units");
-const subgraph_1 = require("../subgraph");
-class InvalidOfferDataError extends Error {
-    constructor(missingProperties) {
-        super(`InvalidOfferData - missing properties: [${missingProperties.join(",")}]`);
-        this.missingProperties = missingProperties;
-    }
-}
-exports.InvalidOfferDataError = InvalidOfferDataError;
-class InvalidOfferMetadataError extends Error {
-    constructor(missingProperties) {
-        super(`InvalidOfferMetadata - missing properties: [${missingProperties.join(",")}]`);
-        this.missingProperties = missingProperties;
-    }
-}
-exports.InvalidOfferMetadataError = InvalidOfferMetadataError;
-exports.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()
-});
-exports.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 {
-        exports.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 {
-        exports.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) {
-    var _a, _b, _c, _d, _e;
-    return {
-        offerData: Object.assign(Object.assign({}, 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: (_a = offerDataSubGraph.metadata) === null || _a === void 0 ? void 0 : _a.exchangePolicy.sellerContactMethod,
-            disputeResolverContactMethod: (_b = offerDataSubGraph.metadata) === null || _b === void 0 ? void 0 : _b.exchangePolicy.disputeResolverContactMethod,
-            escalationDeposit: offerDataSubGraph.disputeResolutionTerms.buyerEscalationDeposit,
-            escalationResponsePeriodInSec: offerDataSubGraph.disputeResolutionTerms.escalationResponsePeriod,
-            sellerTradingName: (_d = (_c = offerDataSubGraph.metadata) === null || _c === void 0 ? void 0 : _c.productV1Seller) === null || _d === void 0 ? void 0 : _d.name,
-            returnPeriodInDays: (_e = offerDataSubGraph.metadata) === null || _e === void 0 ? void 0 : _e.shipping.returnPeriodInDays
-        },
-        tokenInfo: Object.assign(Object.assign({}, offerDataSubGraph.exchangeToken), { decimals: parseInt(offerDataSubGraph.exchangeToken.decimals) })
-    };
-}
-function prepareRenderingData(offerData, offerMetadata, tokenInfo) {
-    return __awaiter(this, void 0, void 0, function* () {
-        return Object.assign(Object.assign(Object.assign({}, offerData), offerMetadata), { priceValue: (0, units_1.formatUnits)(offerData.price, tokenInfo.decimals), exchangeTokenSymbol: tokenInfo.symbol, sellerDepositValue: (0, units_1.formatUnits)(offerData.sellerDeposit, tokenInfo.decimals), buyerCancelPenaltyValue: (0, units_1.formatUnits)(offerData.buyerCancelPenalty, tokenInfo.decimals), escalationDepositValue: (0, units_1.formatUnits)(offerMetadata.escalationDeposit, tokenInfo.decimals), toISOString: function () {
-                return function (num, render) {
-                    try {
-                        return new Date(parseInt(render(num))).toISOString();
-                    }
-                    catch (_a) {
-                        return `[[${num} - invalid Date]]`;
-                    }
-                };
-            }, msecToDay: function () {
-                return function (num, render) {
-                    try {
-                        return bignumber_1.BigNumber.from(render(num))
-                            .div(common_1.utils.timestamp.MSEC_PER_DAY)
-                            .toString();
-                    }
-                    catch (_a) {
-                        return `[[${num} - invalid BigNumber]]`;
-                    }
-                };
-            }, secToDay: function () {
-                return function (num, render) {
-                    try {
-                        return bignumber_1.BigNumber.from(render(num))
-                            .div(common_1.utils.timestamp.SEC_PER_DAY)
-                            .toString();
-                    }
-                    catch (_a) {
-                        return `[[${num} - invalid BigNumber]]`;
-                    }
-                };
-            } });
-    });
-}
-exports.prepareRenderingData = prepareRenderingData;
-// inject a template + all offer details
-function renderContractualAgreement(template, offerData, offerMetadata, tokenInfo) {
-    return __awaiter(this, void 0, void 0, function* () {
-        // Check the passed offerData is matching the required type
-        checkOfferDataIsValid(offerData, true);
-        checkOfferMetadataIsValid(offerMetadata, true);
-        const preparedData = yield prepareRenderingData(offerData, offerMetadata, tokenInfo);
-        return mustache_1.default.render(template, preparedData);
-    });
-}
-exports.renderContractualAgreement = renderContractualAgreement;
-function renderContractualAgreementForOffer(existingOfferData) {
-    return __awaiter(this, void 0, void 0, function* () {
-        if (!existingOfferData) {
-            throw new Error(`offerData is undefined`);
-        }
-        if (!existingOfferData.metadata) {
-            throw new Error(`Offer Metadata is undefined`);
-        }
-        if (existingOfferData.metadata.type !== subgraph_1.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);
-    });
-}
-exports.renderContractualAgreementForOffer = renderContractualAgreementForOffer;
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.renderContractualAgreementForOffer = exports.renderContractualAgreement = exports.prepareRenderingData = exports.baseOfferMetadataSchema = exports.baseOfferDataSchema = exports.InvalidOfferMetadataError = exports.InvalidOfferDataError = void 0;
+const yup = __importStar(require("yup"));
+const bignumber_1 = require("@ethersproject/bignumber");
+const common_1 = require("@bosonprotocol/common");
+const mustache_1 = __importDefault(require("mustache"));
+const units_1 = require("@ethersproject/units");
+const subgraph_1 = require("../subgraph");
+class InvalidOfferDataError extends Error {
+    constructor(missingProperties) {
+        super(`InvalidOfferData - missing properties: [${missingProperties.join(",")}]`);
+        this.missingProperties = missingProperties;
+    }
+}
+exports.InvalidOfferDataError = InvalidOfferDataError;
+class InvalidOfferMetadataError extends Error {
+    constructor(missingProperties) {
+        super(`InvalidOfferMetadata - missing properties: [${missingProperties.join(",")}]`);
+        this.missingProperties = missingProperties;
+    }
+}
+exports.InvalidOfferMetadataError = InvalidOfferMetadataError;
+exports.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()
+});
+exports.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 {
+        exports.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 {
+        exports.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) {
+    var _a, _b, _c, _d, _e;
+    return {
+        offerData: Object.assign(Object.assign({}, 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: (_a = offerDataSubGraph.metadata) === null || _a === void 0 ? void 0 : _a.exchangePolicy.sellerContactMethod,
+            disputeResolverContactMethod: (_b = offerDataSubGraph.metadata) === null || _b === void 0 ? void 0 : _b.exchangePolicy.disputeResolverContactMethod,
+            escalationDeposit: offerDataSubGraph.disputeResolutionTerms.buyerEscalationDeposit,
+            escalationResponsePeriodInSec: offerDataSubGraph.disputeResolutionTerms.escalationResponsePeriod,
+            sellerTradingName: (_d = (_c = offerDataSubGraph.metadata) === null || _c === void 0 ? void 0 : _c.productV1Seller) === null || _d === void 0 ? void 0 : _d.name,
+            returnPeriodInDays: (_e = offerDataSubGraph.metadata) === null || _e === void 0 ? void 0 : _e.shipping.returnPeriodInDays
+        },
+        tokenInfo: Object.assign(Object.assign({}, offerDataSubGraph.exchangeToken), { decimals: parseInt(offerDataSubGraph.exchangeToken.decimals) })
+    };
+}
+function prepareRenderingData(offerData, offerMetadata, tokenInfo) {
+    return __awaiter(this, void 0, void 0, function* () {
+        return Object.assign(Object.assign(Object.assign({}, offerData), offerMetadata), { priceValue: (0, units_1.formatUnits)(offerData.price, tokenInfo.decimals), exchangeTokenSymbol: tokenInfo.symbol, sellerDepositValue: (0, units_1.formatUnits)(offerData.sellerDeposit, tokenInfo.decimals), buyerCancelPenaltyValue: (0, units_1.formatUnits)(offerData.buyerCancelPenalty, tokenInfo.decimals), escalationDepositValue: (0, units_1.formatUnits)(offerMetadata.escalationDeposit, tokenInfo.decimals), toISOString: function () {
+                return function (num, render) {
+                    try {
+                        return new Date(parseInt(render(num))).toISOString();
+                    }
+                    catch (_a) {
+                        return `[[${num} - invalid Date]]`;
+                    }
+                };
+            }, msecToDay: function () {
+                return function (num, render) {
+                    try {
+                        return bignumber_1.BigNumber.from(render(num))
+                            .div(common_1.utils.timestamp.MSEC_PER_DAY)
+                            .toString();
+                    }
+                    catch (_a) {
+                        return `[[${num} - invalid BigNumber]]`;
+                    }
+                };
+            }, secToDay: function () {
+                return function (num, render) {
+                    try {
+                        return bignumber_1.BigNumber.from(render(num))
+                            .div(common_1.utils.timestamp.SEC_PER_DAY)
+                            .toString();
+                    }
+                    catch (_a) {
+                        return `[[${num} - invalid BigNumber]]`;
+                    }
+                };
+            } });
+    });
+}
+exports.prepareRenderingData = prepareRenderingData;
+// inject a template + all offer details
+function renderContractualAgreement(template, offerData, offerMetadata, tokenInfo) {
+    return __awaiter(this, void 0, void 0, function* () {
+        // Check the passed offerData is matching the required type
+        checkOfferDataIsValid(offerData, true);
+        checkOfferMetadataIsValid(offerMetadata, true);
+        const preparedData = yield prepareRenderingData(offerData, offerMetadata, tokenInfo);
+        return mustache_1.default.render(template, preparedData);
+    });
+}
+exports.renderContractualAgreement = renderContractualAgreement;
+function renderContractualAgreementForOffer(existingOfferData) {
+    return __awaiter(this, void 0, void 0, function* () {
+        if (!existingOfferData) {
+            throw new Error(`offerData is undefined`);
+        }
+        if (!existingOfferData.metadata) {
+            throw new Error(`Offer Metadata is undefined`);
+        }
+        if (existingOfferData.metadata.type !== subgraph_1.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);
+    });
+}
+exports.renderContractualAgreementForOffer = renderContractualAgreementForOffer;
 //# sourceMappingURL=renderContractualAgreement.js.map

package/dist/cjs/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