@psmarketplace/config 10.23.1

package/src/plans/base.ts

@@ -0,0 +1,121 @@
+import { ProductCreationParams, ProductReference } from './types';
+
+/**
+ *
+ * @param envName
+ * @param params
+ */
+const createProducts = (params: ProductCreationParams): ProductReference => {
+  const plans: string[] =
+    Object.values(params.classic.tariffs ?? {}).map((t) => t.id) ?? [];
+
+  const products: ProductReference = {
+    classic: {
+      id: params.classic.id,
+      internal: 'classic',
+      product: {
+        id: params.classic.id,
+        name: 'Abonnement Articho',
+        description: '',
+        type: 'service',
+        price: 159,
+        main: true,
+        active: true,
+        isPrivate: false,
+        rating: 3,
+        order: 3,
+        includes: {
+          maxAdminUsers: 1,
+          maxAgentUsers: 0,
+          maxProUsers: 0,
+          maxSellerUsers: 0,
+          authorizationManagement: true,
+          dashboard: true,
+          accounting: true,
+          projectStorage: true,
+          customCatalog: true,
+          customConfig: true,
+          exportReports: true,
+          externalApiIntegration: true,
+          support: true,
+        },
+        plans,
+        tax_rates: params.classic.tax_rates,
+      },
+      tariffs: params.classic.tariffs,
+    },
+    standard: {
+      id: params.standard.id,
+      internal: 'standard',
+      product: {
+        id: params.standard.id,
+        name: 'Standard',
+        description: 'Pour les entreprises unipersonnelles',
+        type: 'service',
+        price: 69,
+        main: true,
+        active: true,
+        isPrivate: true,
+        rating: 1,
+        order: 1,
+        includes: {
+          maxAdminUsers: null,
+          maxAgentUsers: null,
+          maxProUsers: null,
+          maxSellerUsers: null,
+          authorizationManagement: true,
+          dashboard: true,
+          accounting: true,
+          projectStorage: true,
+          customCatalog: true,
+          customConfig: true,
+          exportReports: true,
+          externalApiIntegration: true,
+          support: true,
+        },
+        plans,
+        tax_rates: params.standard.tax_rates,
+      },
+      tariffs: params.standard.tariffs,
+    },
+    plus: {
+      id: params.plus.id,
+      internal: 'plus',
+      product: {
+        id: params.plus.id,
+        name: 'Plus',
+        description:
+          'Idéal pour les agences et les entreprises de plus grande taille',
+        type: 'service',
+        price: 159,
+        main: true,
+        active: true,
+        isPrivate: true,
+        rating: 2,
+        order: 2,
+        includes: {
+          maxAdminUsers: null,
+          maxAgentUsers: null,
+          maxProUsers: null,
+          maxSellerUsers: null,
+          authorizationManagement: true,
+          dashboard: true,
+          accounting: true,
+          projectStorage: true,
+          customCatalog: true,
+          customConfig: true,
+          exportReports: true,
+          externalApiIntegration: true,
+          support: true,
+        },
+        plans,
+        tax_rates: params.plus.tax_rates,
+      },
+      tariffs: params.plus.tariffs,
+    },
+  };
+
+  return products;
+};
+
+export default createProducts;

package/src/plans/index.ts

@@ -0,0 +1,233 @@
+import {
+  Product,
+  DeploymentEnvironment,
+  ProductCreationParams,
+  ProductReference,
+  ProductEntry,
+} from './types';
+
+import createProducts from './base';
+import { SubscriptionSettings } from '../types';
+
+export { Product, ProductEntry, SubscriptionSettings };
+
+const testing: ProductCreationParams = {
+  classic: {
+    id: 'prod_KzmO4rORyWl8cA',
+    tax_rates: ['txr_1HPXZVLFzcsAA7x6w0zpHu01'],
+    tariffs: {
+      base: {
+        id: 'price_1KJmpiLFzcsAA7x6rLA0GNZX',
+        price: 159,
+        usageType: 'licensed',
+        type: 'base',
+      },
+      additionalAdmin: {
+        id: 'price_1KJmpiLFzcsAA7x6VtCIuhqw',
+        price: 30,
+        usageType: 'metered',
+        type: 'extra_user',
+      },
+      additionalAgent: {
+        id: 'price_1KJmpiLFzcsAA7x6gFBgAXkr',
+        price: 20,
+        usageType: 'metered',
+        type: 'extra_user',
+      },
+      additionalPro: {
+        id: 'price_1KJmpiLFzcsAA7x6JxTnlLC8',
+        price: 10,
+        usageType: 'metered',
+        type: 'extra_user',
+      },
+      additionalSeller: {
+        id: 'price_1KJmpiLFzcsAA7x6XS9PBgQo',
+        price: 2,
+        usageType: 'metered',
+        type: 'extra_user',
+      },
+    },
+  },
+  standard: {
+    id: 'prod_KzmEyS3UQ5lbnz',
+    tax_rates: ['txr_1HPXZVLFzcsAA7x6w0zpHu01'],
+    tariffs: {
+      base: {
+        id: 'price_1KJmg4LFzcsAA7x6SMfj1iDu',
+        price: 69,
+        usageType: 'licensed',
+        type: 'base',
+      },
+    },
+    // prices: {
+    //   monthly: 'price_1KJmg4LFzcsAA7x6SMfj1iDu',
+    //   additionalUser: 'price_1KJmg4LFzcsAA7x6yzvGdoxe',
+    // },
+    // additionalUserPrice: 10,
+  },
+  plus: {
+    id: 'prod_KzmyY1ysEOeK93',
+    tax_rates: ['txr_1HPXZVLFzcsAA7x6w0zpHu01'],
+    tariffs: {
+      base: {
+        id: 'price_1KJnP0LFzcsAA7x6oDVeaPAv',
+        price: 159,
+        usageType: 'licensed',
+        type: 'base',
+      },
+    },
+  },
+  // test_1: {
+  //   id: 'prod_L2ZqDUzF0HFuFN',
+  //   tax_rates: ['txr_1HPXZVLFzcsAA7x6w0zpHu01'],
+  //   tariffs: {
+  //     base: { id: 'price_1KMUgwLFzcsAA7x6c3wk0Buy', price: 50, usageType: 'licensed', type: 'base' },
+  //     additionalAdmin: { id: 'price_1KMUgwLFzcsAA7x6X8qYBxls', price: 10, usageType: 'metered', type: 'extra_user' },
+  //     additionalAgent: { id: 'price_1KMUgwLFzcsAA7x6fyOLh2gM', price: 8, usageType: 'metered', type: 'extra_user' },
+  //     additionalPro: { id: 'price_1KMUgwLFzcsAA7x6eB6Oevw2', price: 6, usageType: 'metered', type: 'extra_user' },
+  //     additionalSeller: { id: 'price_1KMUgwLFzcsAA7x6s9WBpxTS', price: 4, usageType: 'metered', type: 'extra_user' },
+  //   },
+  // },
+  // test_2: {
+  //   id: 'prod_L2xmEk7gqqRJtS',
+  //   tax_rates: ['txr_1HPXZVLFzcsAA7x6w0zpHu01'],
+  //   tariffs: {
+  //     base: { id: 'price_1KMrqrLFzcsAA7x62Ag7xwjU', price: 100, usageType: 'licensed', type: 'base' },
+  //     additionalAdmin: { id: 'price_1KMrqrLFzcsAA7x6cu3it43A', price: 20, usageType: 'metered', type: 'extra_user' },
+  //     additionalAgent: { id: 'price_1KMrqrLFzcsAA7x6eNCDb3D6', price: 16, usageType: 'metered', type: 'extra_user' },
+  //     additionalPro: { id: 'price_1KMrqrLFzcsAA7x6wRuDxyyN', price: 12, usageType: 'metered', type: 'extra_user' },
+  //     additionalSeller: { id: 'price_1KMrqsLFzcsAA7x61NRR9gne', price: 8, usageType: 'metered', type: 'extra_user' },
+  //   },
+  // },
+  // test_3: {
+  //   id: 'prod_L2xnCHGi6QNgX8',
+  //   tax_rates: ['txr_1HPXZVLFzcsAA7x6w0zpHu01'],
+  //   tariffs: {
+  //     base: { id: 'price_1KMrs0LFzcsAA7x6p2tkW6lu', price: 80, usageType: 'licensed', type: 'base' },
+  //   },
+  // },
+  // test_4: {
+  //   id: 'prod_L2yWF4ssugw8Ln',
+  //   tax_rates: ['txr_1HPXZVLFzcsAA7x6w0zpHu01'],
+  //   tariffs: {
+  //     base: { id: 'price_1KMsZFLFzcsAA7x6qVbCQpuN', price: 65, usageType: 'licensed', type: 'base' },
+  //     additionalAdmin: { id: 'price_1KMsZFLFzcsAA7x6EjaDfica', price: 15, usageType: 'metered', type: 'extra_user' },
+  //     additionalAgent: { id: 'price_1KMsZFLFzcsAA7x6T1FI1WF4', price: 12, usageType: 'metered', type: 'extra_user' },
+  //     additionalPro: { id: 'price_1KMsZFLFzcsAA7x6L6I0M1ND', price: 9, usageType: 'metered', type: 'extra_user' },
+  //     additionalSeller: { id: 'price_1KMsZFLFzcsAA7x6G5GXzPeW', price: 6, usageType: 'metered', type: 'extra_user' },
+  //   },
+  // },
+};
+
+const production: ProductCreationParams = {
+  classic: {
+    id: 'prod_KzmYFhrWXrzWdR',
+    tax_rates: ['txr_1HIMA8LFzcsAA7x61nsqfrYU'],
+    tariffs: {
+      base: {
+        id: 'price_1KJmzNLFzcsAA7x6I6gNlCpY',
+        price: 159,
+        usageType: 'licensed',
+        type: 'base',
+      },
+      additionalAdmin: {
+        id: 'price_1KJmzNLFzcsAA7x6Tl6D8Wus',
+        price: 30,
+        usageType: 'metered',
+        type: 'extra_user',
+      },
+      additionalAgent: {
+        id: 'price_1KJmzNLFzcsAA7x6DeUQScKY',
+        price: 20,
+        usageType: 'metered',
+        type: 'extra_user',
+      },
+      additionalPro: {
+        id: 'price_1KJmzNLFzcsAA7x695wsj6rA',
+        price: 10,
+        usageType: 'metered',
+        type: 'extra_user',
+      },
+      additionalSeller: {
+        id: 'price_1KJmzNLFzcsAA7x6gF62MX41',
+        price: 2,
+        usageType: 'metered',
+        type: 'extra_user',
+      },
+    },
+  },
+  standard: {
+    id: 'prod_HsAwETfIUblsAT',
+    tax_rates: ['txr_1HIMA8LFzcsAA7x61nsqfrYU'],
+    tariffs: {
+      base: {
+        id: 'price_1HIQaILFzcsAA7x6NVk3cJu1',
+        price: 69,
+        usageType: 'licensed',
+        type: 'base',
+      },
+    },
+  },
+  plus: {
+    id: 'prod_HsB2YJPEZ9H98c',
+    tax_rates: ['txr_1HIMA8LFzcsAA7x61nsqfrYU'],
+    tariffs: {
+      base: {
+        id: 'price_1HIQg0LFzcsAA7x6X6lfFUdv',
+        price: 159,
+        usageType: 'licensed',
+        type: 'base',
+      },
+    },
+  },
+  // test_1: {
+  //   id: 'prod_L2ZqDUzF0HFuFN',
+  //   tax_rates: ['txr_1HPXZVLFzcsAA7x6w0zpHu01'],
+  //   tariffs: {
+  //     base: { id: 'price_1KMUgwLFzcsAA7x6c3wk0Buy', price: 50, usageType: 'licensed', type: 'base' },
+  //     additionalAdmin: { id: 'price_1KMUgwLFzcsAA7x6X8qYBxls', price: 10, usageType: 'metered', type: 'extra_user' },
+  //     additionalAgent: { id: 'price_1KMUgwLFzcsAA7x6fyOLh2gM', price: 8, usageType: 'metered', type: 'extra_user' },
+  //     additionalPro: { id: 'price_1KMUgwLFzcsAA7x6eB6Oevw2', price: 6, usageType: 'metered', type: 'extra_user' },
+  //     additionalSeller: { id: 'price_1KMUgwLFzcsAA7x6s9WBpxTS', price: 4, usageType: 'metered', type: 'extra_user' },
+  //   },
+  // },
+  // test_2: {
+  //   id: 'prod_L2xmEk7gqqRJtS',
+  //   tax_rates: ['txr_1HPXZVLFzcsAA7x6w0zpHu01'],
+  //   tariffs: {
+  //     base: { id: 'price_1KMrqrLFzcsAA7x62Ag7xwjU', price: 100, usageType: 'licensed', type: 'base' },
+  //     additionalAdmin: { id: 'price_1KMrqrLFzcsAA7x6cu3it43A', price: 20, usageType: 'metered', type: 'extra_user' },
+  //     additionalAgent: { id: 'price_1KMrqrLFzcsAA7x6eNCDb3D6', price: 16, usageType: 'metered', type: 'extra_user' },
+  //     additionalPro: { id: 'price_1KMrqrLFzcsAA7x6wRuDxyyN', price: 12, usageType: 'metered', type: 'extra_user' },
+  //     additionalSeller: { id: 'price_1KMrqsLFzcsAA7x61NRR9gne', price: 8, usageType: 'metered', type: 'extra_user' },
+  //   },
+  // },
+  // test_3: {
+  //   id: 'prod_L2xnCHGi6QNgX8',
+  //   tax_rates: ['txr_1HPXZVLFzcsAA7x6w0zpHu01'],
+  //   tariffs: {
+  //     base: { id: 'price_1KMrs0LFzcsAA7x6p2tkW6lu', price: 80, usageType: 'licensed', type: 'base' },
+  //   },
+  // },
+  // test_4: {
+  //   id: 'prod_L2yWF4ssugw8Ln',
+  //   tax_rates: ['txr_1HPXZVLFzcsAA7x6w0zpHu01'],
+  //   tariffs: {
+  //     base: { id: 'price_1KMsZFLFzcsAA7x6qVbCQpuN', price: 65, usageType: 'licensed', type: 'base' },
+  //     additionalAdmin: { id: 'price_1KMsZFLFzcsAA7x6EjaDfica', price: 15, usageType: 'metered', type: 'extra_user' },
+  //     additionalAgent: { id: 'price_1KMsZFLFzcsAA7x6T1FI1WF4', price: 12, usageType: 'metered', type: 'extra_user' },
+  //     additionalPro: { id: 'price_1KMsZFLFzcsAA7x6L6I0M1ND', price: 9, usageType: 'metered', type: 'extra_user' },
+  //     additionalSeller: { id: 'price_1KMsZFLFzcsAA7x6G5GXzPeW', price: 6, usageType: 'metered', type: 'extra_user' },
+  //   },
+  // },
+};
+
+/**
+ *
+ * @param envName
+ */
+export default (envName: DeploymentEnvironment): ProductReference => {
+  if (envName === 'production') return createProducts(production);
+
+  return createProducts(testing);
+};

package/src/plans/types.ts

@@ -0,0 +1,208 @@
+import { SubscriptionSettings } from '../types';
+
+export type DeploymentEnvironment = 'development' | 'staging' | 'production';
+
+export interface CouponSettings {
+  /**
+   * How many admins extra can have a team
+   */
+  adminUsersFree?: number | 'all';
+
+  /**
+   * How many agents extra can have a team
+   */
+  agentUsersFree?: number | 'all';
+
+  /**
+   * How many pros extra can have a team
+   */
+  proUsersFree?: number | 'all';
+
+  /**
+   * How many sellers extra can have a team
+   */
+  sellerUsersFree?: number | 'all';
+}
+
+export interface Coupon {
+  id: string;
+  name: string;
+  object: string;
+  amount_off?: number;
+  percent_off?: number;
+  created: number;
+  currency?: string;
+  duration: string;
+  duration_in_months?: any;
+  livemode: boolean;
+  max_redemptions?: any;
+  redeem_by?: any;
+  times_redeemed?: number;
+  valid: boolean;
+  metadata?: CouponSettings;
+}
+
+export interface Product {
+  /**
+   * the internal product ID
+   */
+  id: string;
+
+  /**
+   *
+   */
+  order: number;
+
+  /**
+   * The product price
+   */
+  price: number;
+
+  /**
+   * The name of product
+   */
+  name: string;
+
+  /**
+   * Type of product
+   */
+  type: 'service';
+
+  /**
+   * Is this product active?
+   */
+  active: boolean;
+  /**
+   * Description to show to users
+   */
+  description: string;
+  /**
+   * Marked as default
+   */
+  isDefault?: boolean;
+
+  /**
+   * Marked as need on signup screen
+   */
+  main?: boolean;
+
+  /**
+   * Indicate rating among products
+   */
+  rating: 1 | 2 | 3;
+
+  /**
+   * Marked as private
+   */
+  isPrivate?: boolean;
+
+  /**
+   * Stripe plans associated with this product to be charged automatically
+   */
+  plans: string[];
+
+  /**
+   * What's inclued within the product
+   */
+  includes: SubscriptionSettings;
+
+  /**
+   * Ids of taxes applied to this product
+   */
+  tax_rates: string[];
+}
+
+export type ProductEntry = {
+  id: string;
+  internal: string;
+  product: Product;
+  tariffs: {
+    base: {
+      id: string;
+      price: number;
+      usageType: 'licensed' | 'metered';
+      type: 'base' | 'extra_user';
+    };
+    additionalAdmin?: {
+      id: string;
+      price: number;
+      usageType: 'licensed' | 'metered';
+      type: 'base' | 'extra_user';
+    };
+    additionalAgent?: {
+      id: string;
+      price: number;
+      usageType: 'licensed' | 'metered';
+      type: 'base' | 'extra_user';
+    };
+    additionalPro?: {
+      id: string;
+      price: number;
+      usageType: 'licensed' | 'metered';
+      type: 'base' | 'extra_user';
+    };
+    additionalSeller?: {
+      id: string;
+      price: number;
+      usageType: 'licensed' | 'metered';
+      type: 'base' | 'extra_user';
+    };
+  };
+};
+
+export type ProductReference = {
+  classic: ProductEntry;
+  plus: ProductEntry;
+  standard: ProductEntry;
+  // test_1: ProductEntry;
+  // test_2: ProductEntry;
+  // test_3: ProductEntry;
+  // test_4: ProductEntry;
+};
+
+export type ProductCreationEntry = {
+  id: string;
+  tax_rates: string[];
+  tariffs: {
+    base: {
+      id: string;
+      price: number;
+      usageType: 'licensed' | 'metered';
+      type: 'base' | 'extra_user';
+    };
+    additionalAdmin?: {
+      id: string;
+      price: number;
+      usageType: 'licensed' | 'metered';
+      type: 'base' | 'extra_user';
+    };
+    additionalAgent?: {
+      id: string;
+      price: number;
+      usageType: 'licensed' | 'metered';
+      type: 'base' | 'extra_user';
+    };
+    additionalPro?: {
+      id: string;
+      price: number;
+      usageType: 'licensed' | 'metered';
+      type: 'base' | 'extra_user';
+    };
+    additionalSeller?: {
+      id: string;
+      price: number;
+      usageType: 'licensed' | 'metered';
+      type: 'base' | 'extra_user';
+    };
+  };
+};
+
+export type ProductCreationParams = {
+  classic: ProductCreationEntry;
+  standard: ProductCreationEntry;
+  plus: ProductCreationEntry;
+  // test_1: ProductCreationEntry;
+  // test_2: ProductCreationEntry;
+  // test_3: ProductCreationEntry;
+  // test_4: ProductCreationEntry;
+};