rerobe-js-orm 2.8.0 → 2.9.1

package/lib/factories/Merchant/MerchantFromFormState.js

@@ -4,7 +4,7 @@ const MerchantFactory_1 = require("./MerchantFactory");
 const Merchant_1 = require("../../models/Merchant");
 class MerchantFromFormState extends MerchantFactory_1.default {
     createMerchant(fs) {
-        var _a, _b, _c, _d, _e, _f, _g, _h, _j;
+        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
         const merchantAttributes = {
             id: ((_a = fs.props) === null || _a === void 0 ? void 0 : _a.id) || '',
             name: fs.fields.name.inputValue,
@@ -31,6 +31,7 @@ class MerchantFromFormState extends MerchantFactory_1.default {
             sharedSecret: (_j = fs.props) === null || _j === void 0 ? void 0 : _j.sharedSecret,
             ribbnId: fs.fields.ribbnId.inputValue,
             primaryDomain: fs.fields.primaryDomain.inputValue,
+            webshopHomePageId: (_k = fs.props) === null || _k === void 0 ? void 0 : _k.webshopHomePageId,
         };
         return new Merchant_1.default(Object.assign({}, merchantAttributes));
     }

package/lib/index.d.ts

@@ -25,6 +25,7 @@ import Product from './models/Product';
 import Order from './models/Order';
 import Merchant from './models/Merchant';
 import User from './models/User';
+import MerchantWebPage from './models/MerchantWebPage';
 import ProductStateManager from './models/ProductStateManager';
 import PayoutAccount from './models/PayoutAccount';
 import PayoutAccountFormState from './form-states/PayoutAccount/PayoutAccountFormState';
@@ -33,4 +34,4 @@ import WebhookFormState from './form-states/Merchant/WebhookFormState';
 import ReRobeProductHelpers from './helpers/ReRobeProductHelpers';
 import AnalyticsHelpers from './helpers/AnalyticsHelpers';
 import OrderHelpers from './helpers/OrderHelpers';
-export { ProductFromAlgoliaJSONDoc, ProductFromShopifyWebhookJSONDoc, ProductFromShopifyJSClientJSONDoc, ProductFormStateFactory, ProductCollectionFormStateFactory, ProductCollectionHelpers, SellRequestFormStateFactory, PickUpFormStateFactory, AddressFormStateFactory, UserFormStateFactory, UserFromShopifyWebhookJSONDoc, UserFromAuthTemplateMethod, DraftOrderFromMirakl, DraftOrderFromApp, ChatRoomFromNewUserSignUp, KlarnaSessionFactory, Product, ProductStateManager, Order, OrderFromShopifyWebhook, OrderFromShopifyAdminApi, OrderFromShopifyStorefrontApi, OrderFromApp, OrderFormStateFactory, RefundFormStateFactory, PayoutAccount, PayoutAccountFormState, Merchant, MerchantFormState, MerchantFormStateFactory, ReRobeProductHelpers, User, AnalyticsHelpers, OrderHelpers, WebhookFormState, };
+export { ProductFromAlgoliaJSONDoc, ProductFromShopifyWebhookJSONDoc, ProductFromShopifyJSClientJSONDoc, ProductFormStateFactory, ProductCollectionFormStateFactory, ProductCollectionHelpers, SellRequestFormStateFactory, PickUpFormStateFactory, AddressFormStateFactory, UserFormStateFactory, UserFromShopifyWebhookJSONDoc, UserFromAuthTemplateMethod, DraftOrderFromMirakl, DraftOrderFromApp, ChatRoomFromNewUserSignUp, KlarnaSessionFactory, Product, ProductStateManager, Order, OrderFromShopifyWebhook, OrderFromShopifyAdminApi, OrderFromShopifyStorefrontApi, OrderFromApp, OrderFormStateFactory, RefundFormStateFactory, PayoutAccount, PayoutAccountFormState, Merchant, MerchantFormState, MerchantFormStateFactory, ReRobeProductHelpers, User, AnalyticsHelpers, OrderHelpers, WebhookFormState, MerchantWebPage, };

package/lib/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.WebhookFormState = exports.OrderHelpers = exports.AnalyticsHelpers = exports.User = exports.ReRobeProductHelpers = exports.MerchantFormStateFactory = exports.MerchantFormState = exports.Merchant = exports.PayoutAccountFormState = exports.PayoutAccount = exports.RefundFormStateFactory = exports.OrderFormStateFactory = exports.OrderFromApp = exports.OrderFromShopifyStorefrontApi = exports.OrderFromShopifyAdminApi = exports.OrderFromShopifyWebhook = exports.Order = exports.ProductStateManager = exports.Product = exports.KlarnaSessionFactory = exports.ChatRoomFromNewUserSignUp = exports.DraftOrderFromApp = exports.DraftOrderFromMirakl = exports.UserFromAuthTemplateMethod = exports.UserFromShopifyWebhookJSONDoc = exports.UserFormStateFactory = exports.AddressFormStateFactory = exports.PickUpFormStateFactory = exports.SellRequestFormStateFactory = exports.ProductCollectionHelpers = exports.ProductCollectionFormStateFactory = exports.ProductFormStateFactory = exports.ProductFromShopifyJSClientJSONDoc = exports.ProductFromShopifyWebhookJSONDoc = exports.ProductFromAlgoliaJSONDoc = void 0;
+exports.MerchantWebPage = exports.WebhookFormState = exports.OrderHelpers = exports.AnalyticsHelpers = exports.User = exports.ReRobeProductHelpers = exports.MerchantFormStateFactory = exports.MerchantFormState = exports.Merchant = exports.PayoutAccountFormState = exports.PayoutAccount = exports.RefundFormStateFactory = exports.OrderFormStateFactory = exports.OrderFromApp = exports.OrderFromShopifyStorefrontApi = exports.OrderFromShopifyAdminApi = exports.OrderFromShopifyWebhook = exports.Order = exports.ProductStateManager = exports.Product = exports.KlarnaSessionFactory = exports.ChatRoomFromNewUserSignUp = exports.DraftOrderFromApp = exports.DraftOrderFromMirakl = exports.UserFromAuthTemplateMethod = exports.UserFromShopifyWebhookJSONDoc = exports.UserFormStateFactory = exports.AddressFormStateFactory = exports.PickUpFormStateFactory = exports.SellRequestFormStateFactory = exports.ProductCollectionHelpers = exports.ProductCollectionFormStateFactory = exports.ProductFormStateFactory = exports.ProductFromShopifyJSClientJSONDoc = exports.ProductFromShopifyWebhookJSONDoc = exports.ProductFromAlgoliaJSONDoc = void 0;
 const ProductFromShopifyJSClientJSONDoc_1 = require("./factories/Product/ProductFromShopifyJSClientJSONDoc");
 exports.ProductFromShopifyJSClientJSONDoc = ProductFromShopifyJSClientJSONDoc_1.default;
 const ProductFromAlgoliaJSONDoc_1 = require("./factories/Product/ProductFromAlgoliaJSONDoc");
@@ -55,6 +55,8 @@ const Merchant_1 = require("./models/Merchant");
 exports.Merchant = Merchant_1.default;
 const User_1 = require("./models/User");
 exports.User = User_1.default;
+const MerchantWebPage_1 = require("./models/MerchantWebPage");
+exports.MerchantWebPage = MerchantWebPage_1.default;
 const ProductStateManager_1 = require("./models/ProductStateManager");
 exports.ProductStateManager = ProductStateManager_1.default;
 const PayoutAccount_1 = require("./models/PayoutAccount");

package/lib/models/Merchant.d.ts

@@ -61,6 +61,7 @@ export default class Merchant extends Base {
     sharedSecret: string;
     ribbnId: string;
     primaryDomain: string;
+    webshopHomePageId: string;
     constructor(props?: any);
     toObj(): MerchantObj;
 }

package/lib/models/Merchant.js

@@ -38,6 +38,7 @@ class Merchant extends Base_1.default {
         this.sharedSecret = (props === null || props === void 0 ? void 0 : props.sharedSecret) || '';
         this.ribbnId = (props === null || props === void 0 ? void 0 : props.ribbnId) || '';
         this.primaryDomain = (props === null || props === void 0 ? void 0 : props.primaryDomain) || '';
+        this.webshopHomePageId = (props === null || props === void 0 ? void 0 : props.webshopHomePageId) || 'home';
     }
     toObj() {
         return {
@@ -66,6 +67,7 @@ class Merchant extends Base_1.default {
             sharedSecret: this.sharedSecret,
             ribbnId: this.ribbnId,
             primaryDomain: this.primaryDomain,
+            webshopHomePageId: this.webshopHomePageId,
         };
     }
 }

package/lib/models/MerchantWebPage.d.ts

@@ -0,0 +1,18 @@
+import Base from '../Base';
+import { MerchantWebPageObj, SeoMetadataType, WebPageElement } from '../types/merchant-webshop-types';
+export default class MerchantWebPage extends Base {
+    documentId: string;
+    pageTitle: string;
+    navigationTitle: string;
+    urlSlug: string;
+    layers: WebPageElement[];
+    password?: string;
+    metadata: SeoMetadataType;
+    advancedSettings: string;
+    isCustomPage: boolean;
+    isHidden: boolean;
+    createdAt?: string;
+    updatedAt?: string;
+    constructor(props?: any);
+    toObj(): MerchantWebPageObj;
+}

package/lib/models/MerchantWebPage.js

@@ -0,0 +1,45 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const Base_1 = require("../Base");
+class MerchantWebPage extends Base_1.default {
+    constructor(props) {
+        var _a, _b;
+        super();
+        const docId = (props === null || props === void 0 ? void 0 : props.pageTitle) ? this.utilities.camelCase(props.pageTitle) : '';
+        this.documentId = (props === null || props === void 0 ? void 0 : props.documentId) || docId || this.utilities.makeRandId(28);
+        this.pageTitle = (props === null || props === void 0 ? void 0 : props.pageTitle) || '';
+        this.navigationTitle = (props === null || props === void 0 ? void 0 : props.navigationTitle) || (props === null || props === void 0 ? void 0 : props.pageTitle) || '';
+        this.urlSlug = (props === null || props === void 0 ? void 0 : props.urlSlug) || `/${(props === null || props === void 0 ? void 0 : props.documentId) || docId}`;
+        this.layers = (props === null || props === void 0 ? void 0 : props.layers) || [];
+        this.password = (props === null || props === void 0 ? void 0 : props.password) || '';
+        this.metadata = (props === null || props === void 0 ? void 0 : props.metadata) || {
+            title: (props === null || props === void 0 ? void 0 : props.pageTitle) || '',
+            description: '',
+            ogImgUrl: '',
+            keywords: '',
+            favIconImgUrl: '',
+        };
+        this.advancedSettings = (props === null || props === void 0 ? void 0 : props.advancedSettings) || '';
+        this.isCustomPage = (_a = props === null || props === void 0 ? void 0 : props.isCustomPage) !== null && _a !== void 0 ? _a : true;
+        this.isHidden = (_b = props === null || props === void 0 ? void 0 : props.isHidden) !== null && _b !== void 0 ? _b : false;
+        this.createdAt = (props === null || props === void 0 ? void 0 : props.createdAt) || '';
+        this.updatedAt = (props === null || props === void 0 ? void 0 : props.updatedAt) || '';
+    }
+    toObj() {
+        return {
+            documentId: this.documentId,
+            pageTitle: this.pageTitle,
+            navigationTitle: this.navigationTitle,
+            urlSlug: this.urlSlug,
+            layers: this.layers,
+            password: this.password,
+            metadata: this.metadata,
+            advancedSettings: this.advancedSettings,
+            isCustomPage: this.isCustomPage,
+            isHidden: this.isHidden,
+            createdAt: this.createdAt,
+            updatedAt: this.updatedAt,
+        };
+    }
+}
+exports.default = MerchantWebPage;

package/lib/types/merchant-types.d.ts

@@ -24,6 +24,7 @@ declare type MerchantObj = {
     sharedSecret: string;
     ribbnId: string;
     primaryDomain: string;
+    webshopHomePageId: string;
 };
 declare type MerchantTypes = 'INDIVIDUAL' | 'BUSINESS';
 declare type RibbnPaymentTiers = 'FREE' | 'TIER_ONE';

package/lib/types/merchant-webshop-types.d.ts

@@ -0,0 +1,25 @@
+import { LayoutElement } from './webshop-page/elements/layout-element-interface';
+import { TypographyElement } from './webshop-page/elements/typography-element-interface';
+import { ButtonElement } from './webshop-page/elements/button-element-interface';
+export declare type WebPageElement = LayoutElement | TypographyElement | ButtonElement;
+export declare type SeoMetadataType = {
+    title: string;
+    description: string;
+    favIconImgUrl: string;
+    ogImgUrl: string;
+    keywords: string;
+};
+export declare type MerchantWebPageObj = {
+    pageTitle: string;
+    documentId: string;
+    layers: WebPageElement[];
+    navigationTitle: string;
+    urlSlug: string;
+    password?: string;
+    metadata: SeoMetadataType;
+    advancedSettings: string;
+    isCustomPage: boolean;
+    isHidden: boolean;
+    createdAt?: string;
+    updatedAt?: string;
+};

package/lib/types/merchant-webshop-types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/types/webshop-page/common/web-page-element-common-interface.d.ts

@@ -0,0 +1,10 @@
+import { WebPageElementAttrProperties, WebPageElementSizeProperties, WebPageElementPositionProperties, WebPageElementMarginProperties, WebPageElementPaddingProperties } from './web-page-element-property-types';
+export interface WebPageElementCommonInterface {
+    uniqueId: string;
+    elementId: string;
+    attributes: WebPageElementAttrProperties;
+    size: WebPageElementSizeProperties;
+    position: WebPageElementPositionProperties;
+    margin: WebPageElementMarginProperties;
+    padding: WebPageElementPaddingProperties;
+}

package/lib/types/webshop-page/common/web-page-element-common-interface.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/types/webshop-page/common/web-page-element-property-types.d.ts

@@ -0,0 +1,62 @@
+export declare type WebPageElementAttrProperties = {
+    tag: string;
+    id: string;
+    [x: string]: any;
+};
+export declare type WebPageElementSizeProperties = {
+    width: string;
+    height: string;
+    minWidth: string;
+    minHeight: string;
+    maxWidth: string;
+    maxHeight: string;
+};
+export declare type WebPageElementPositionProperties = {
+    position: string;
+    left: string;
+    top: string;
+    justifySelf: string;
+    alignSelf: string;
+};
+export declare type WebPageElementMarginProperties = {
+    marginTop: string;
+    marginRight: string;
+    marginBottom: string;
+    marginLeft: string;
+};
+export declare type WebPageElementPaddingProperties = {
+    paddingTop: string;
+    paddingRight: string;
+    paddingBottom: string;
+    paddingLeft: string;
+};
+declare type WebPageElementPseudoClassOptions = 'focus' | 'hover' | 'active' | 'focus-within' | 'focus-visible';
+export declare type WebPageElementDisplayStatesProperties<T> = {
+    [x in WebPageElementPseudoClassOptions]?: T;
+};
+export declare type WebPageElementBackgroundProperties = {
+    type: 'color' | 'gradient' | 'image' | '';
+    value: string;
+};
+export declare type InnerLayoutProperties = {
+    direction: 'row' | 'column';
+    justifyContent: 'flex-start' | 'center' | 'flex-end' | 'space-between';
+    alignItems: 'flex-start' | 'center' | 'flex-end' | 'stretch';
+    gap: string;
+    wrap: boolean;
+};
+export declare type TypographyProperties = {
+    fontFamily: string;
+    fontSize: string;
+    fontColor: string;
+    fontWeight: number;
+};
+export declare type ButtonProperties = {
+    fontFamily: string;
+    fontSize: string;
+    fontColor: string;
+    fontWeight: number;
+    buttonName: string;
+    buttonColor: string;
+};
+export {};

package/lib/types/webshop-page/common/web-page-element-property-types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/types/webshop-page/elements/button-element-interface.d.ts

@@ -0,0 +1,15 @@
+import { WebPageElementDisplayStatesProperties } from '../common/web-page-element-property-types';
+import { WebPageElementCommonInterface } from '../common/web-page-element-common-interface';
+declare type ButtonProperties = {
+    fontFamily: string;
+    fontSize: string;
+    fontColor: string;
+    fontWeight: string;
+    buttonName: string;
+    buttonColor: string;
+};
+export interface ButtonElement extends WebPageElementCommonInterface {
+    displayStates: WebPageElementDisplayStatesProperties<Omit<ButtonElement, 'displayStates'>>;
+    button: ButtonProperties;
+}
+export {};

package/lib/types/webshop-page/elements/button-element-interface.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/types/webshop-page/elements/layout-element-interface.d.ts

@@ -0,0 +1,17 @@
+import { WebPageElementDisplayStatesProperties, WebPageElementBackgroundProperties } from '../common/web-page-element-property-types';
+import { WebPageElementCommonInterface } from '../common/web-page-element-common-interface';
+import { WebPageElement } from '../../merchant-webshop-types';
+declare type InnerLayoutProperties = {
+    direction: 'row' | 'column';
+    justifyContent: 'flex-start' | 'center' | 'flex-end' | 'space-between';
+    alignItems: 'flex-start' | 'center' | 'flex-end' | 'stretch';
+    gap: string;
+    wrap: boolean;
+};
+export interface LayoutElement extends WebPageElementCommonInterface {
+    innerLayout: InnerLayoutProperties;
+    background: WebPageElementBackgroundProperties;
+    displayStates: WebPageElementDisplayStatesProperties<Omit<LayoutElement, 'displayStates' | 'layers'>>;
+    layers: WebPageElement[];
+}
+export {};

package/lib/types/webshop-page/elements/layout-element-interface.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/types/webshop-page/elements/typography-element-interface.d.ts

@@ -0,0 +1,14 @@
+import { WebPageElementDisplayStatesProperties } from '../common/web-page-element-property-types';
+import { WebPageElementCommonInterface } from '../common/web-page-element-common-interface';
+declare type TypographyProperties = {
+    fontFamily: string;
+    fontSize: string;
+    fontColor: string;
+    fontWeight: string;
+    content: string;
+};
+export interface TypographyElement extends WebPageElementCommonInterface {
+    displayStates: WebPageElementDisplayStatesProperties<Omit<TypographyElement, 'displayStates'>>;
+    typography: TypographyProperties;
+}
+export {};

package/lib/types/webshop-page/elements/typography-element-interface.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "rerobe-js-orm",
-  "version": "2.8.0",
+  "version": "2.9.1",
   "description": "ReRobe's Javascript ORM Framework",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",