@placeshakr/config 10.19.0-alpha.5 → 10.19.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@placeshakr/config",
-  "version": "10.19.0-alpha.5",
+  "version": "10.19.0",
   "description": "Articho configuration module",
   "author": "Ibrael Espinosa <ibrael@placeshaker.fr>",
   "homepage": "https://github.com/placeshaker/articho#readme",
@@ -22,7 +22,7 @@
     "src"
   ],
   "engines": {
-    "node": ">=10"
+    "node": ">=14"
   },
   "scripts": {
     "start": "tsdx watch",
@@ -32,17 +32,14 @@
     "lint": "tsdx lint --fix",
     "prepare": "tsdx build"
   },
-  "husky": {
-    "hooks": {
-      "pre-commit": "tsdx lint"
-    }
+  "dependencies": {
+    "react-i18next": "^11.15.3"
   },
   "devDependencies": {
-    "@zerollup/ts-transform-paths": "^1.7.18",
-    "rollup-plugin-typescript2": "^0.30.0"
+    "husky": "^7.0.4",
+    "rollup": "^2.62.0",
+    "rollup-plugin-typescript2": "^0.31.1",
+    "ts-type": "^2.1.2"
   },
-  "peerDependencies": {
-    "husky": "^4.3.8"
-  },
-  "gitHead": "745caa80a5e95c6d5186c7095373c7a4ca0eaf99"
+  "gitHead": "120420a5e68ed21bdf8d5b659dcfe9eb095d2a29"
 }

package/src/environment/base.ts

@@ -66,7 +66,8 @@ const productionEnvironment: Environment = {
       histories: 'enterprises/{enterpriseId}/histories',
       receptionVouchers: 'enterprises/{enterpriseId}/projects/{projectId}/receptionVouchers',
       indexes: 'enterprises/{enterpriseId}/indexes',
-      notifications: 'enterprises/{enterpriseId}/notifications'
+      notifications: 'enterprises/{enterpriseId}/notifications',
+      nomenclatures: 'enterprises/{enterpriseId}/nomenclatures'
     },
     docs: {
       user: 'users/{userId}',
@@ -118,7 +119,8 @@ const productionEnvironment: Environment = {
       userNotification: 'users/{userId}/profiles/{enterpriseId}/notifications/{notificationId}',
       history: 'enterprises/{enterpriseId}/histories/{historyId}',
       receptionVouchers: 'enterprises/{enterpriseId}/projects/{projectId}/receptionVouchers/{receptionVoucherId}',
-      notification: 'enterprises/{enterpriseId}/notifications/{notificationId}'
+      notification: 'enterprises/{enterpriseId}/notifications/{notificationId}',
+      nomenclatures: 'enterprises/{enterpriseId}/nomenclatures/{nomenclatureId}',
     },
     indexes: {
       users: 'users',
@@ -163,6 +165,7 @@ const productionEnvironment: Environment = {
       systemOperationsMaterials: 'system-operations-materials',
       systemMaterialsProvider: 'system-materials-provider',
       systemStatus: 'system-status',
+      systemNomenclatures: 'system-nomenclatures',
       systemCategories: 'system-categories'
     },
   },
@@ -576,6 +579,16 @@ const productionEnvironment: Environment = {
       maxValuesPerFacet: 1000,
       maxFacetHits: 100
     },
+    systemNomenclatures: {
+      searchableAttributes: ['identifier', 'value'],
+      attributesForFaceting: [
+        'searchable(identifier)',
+        'searchable(status)'
+      ],
+      ranking: ['desc(updatedAt)'],
+      maxValuesPerFacet: 1000,
+      maxFacetHits: 100
+    },
     billing: {
       attributesForFaceting: [
         'searchable(scope)',
@@ -666,17 +679,17 @@ const productionEnvironment: Environment = {
       maxFacetHits: 100
     },
     nomenclatures: {
-      searchableAttributes: ['name'],
+      searchableAttributes: ['value'],
       attributesForFaceting: [
         'searchable(scope)',
         'searchable(identifier)',
         'searchable(status)',
       ],
-      ranking: ['asc(name)'],
+      ranking: ['asc(value)'],
       maxValuesPerFacet: 1000,
       maxFacetHits: 100
-    },
+    }
   },
 };
 
-export default productionEnvironment;
+export default productionEnvironment;

package/src/environment/decorators.ts

@@ -59,6 +59,7 @@ const test: EnvironmentDecorator = (base: Environment) => ({
       systemOperationsMaterials: 'system-operations-materials',
       systemMaterialsProvider: 'system-materials-provider',
       systemStatus: 'test-system-status',
+      systemNomenclatures: 'test-system-nomenclatures',
       systemCategories: 'system-categories'
     },
   },
@@ -113,6 +114,7 @@ const emulator: EnvironmentDecorator = (base: Environment) => ({
       systemOperationsMaterials: 'system-operations-materials',
       systemMaterialsProvider: 'system-materials-provider',
       systemStatus: 'emulator-system-status',
+      systemNomenclatures: 'emulator-system-nomenclatures',
       systemCategories: 'system-categories'
     },
   },
@@ -120,4 +122,4 @@ const emulator: EnvironmentDecorator = (base: Environment) => ({
   name: 'emulator',
 });
 
-export { dev, staging, test, emulator };
+export { dev, staging, test, emulator };

package/src/environment/types.ts

@@ -73,6 +73,7 @@ export interface Environment {
       systemOperationsMaterials: string;
       systemMaterialsProvider: string;
       systemStatus: string;
+      systemNomenclatures: string;
       systemCategories: string;
     };
     collections: {
@@ -111,6 +112,7 @@ export interface Environment {
       receptionVouchers: string;
       indexes: string;
       notifications: string;
+      nomenclatures: string;
     };
     docs: {
       user: string;
@@ -151,6 +153,7 @@ export interface Environment {
       history: string;
       receptionVouchers: string;
       notification: string;
+      nomenclatures: string;
     };
   };
 
@@ -159,4 +162,4 @@ export interface Environment {
   };
 }
 
-export type EnvironmentDecorator = (base: Environment) => Environment;
+export type EnvironmentDecorator = (base: Environment) => Environment;

package/src/helpers/index.ts

@@ -34,6 +34,7 @@ export interface Helpers {
   downPayment: FactoryCreate<articho.DownPayment>;
   histories: FactoryCreate<articho.History>;
   receptionVoucher: FactoryCreate<articho.ReceptionVoucher>;
+  nomenclatures: FactoryCreate<articho.Nomenclature>;
 }
 
 /**
@@ -81,6 +82,7 @@ const helpers: Helpers = {
   downPayment: FactoryCreateFunction(),
   histories: FactoryCreateFunction(),
   receptionVoucher: FactoryCreateFunction(),
+  nomenclatures: FactoryCreateFunction()
 };
 
 export default helpers;

package/src/helpers/uid.ts

@@ -94,7 +94,7 @@ export const uid: IUID = {
   timestamp: (function () {
     return function (id: string, asDate?: boolean): number | Date {
       let time = 0;
-      const data = id.substr(0, 8);
+      const data = id.substring(0, 8);
 
       for (let i = 0; i < 8; i++) {
         time = time * 62 + ASCII_CHARS.indexOf(data[i]);

package/src/plans/base.ts

@@ -11,24 +11,35 @@ const createProducts = (params: ProductCreationParams): ProductReference => {
       id: params.standard.id,
       internal: 'standard',
       product: {
-        price: 6900,
-        active: true,
-        description: 'Pour les entreprises unipersonnelles',
-        id: params.plus.id,
+        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: {
-          canCreateUser: false,
-          maxTeamMembers: 1,
+          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: [params.standard.prices.monthly],
-
+        plans: Object.values(params.standard.tariffs).map(t => t.id),
         tax_rates: params.standard.tax_rates,
       },
+      tariffs: params.standard.tariffs,
       additionalUser: params.standard.prices.additionalUser,
       additionalUserPrice: params.standard.additionalUserPrice,
     },
@@ -36,56 +47,72 @@ const createProducts = (params: ProductCreationParams): ProductReference => {
       id: params.plus.id,
       internal: 'plus',
       product: {
-        active: true,
-        description:
-          'Idéal pour les agences et les entreprises de plus grande taille',
         id: params.plus.id,
         name: 'Plus',
+        description: 'Idéal pour les agences et les entreprises de plus grande taille',
         type: 'service',
-        rating: 2,
+        price: 159,
         main: true,
-        price: 15900,
-        order: 3,
+        active: true,
+        isPrivate: true,
+        rating: 2,
+        order: 2,
         includes: {
-          canCreateUser: true,
-          maxTeamMembers: 10,
-          importExport: true,
+          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: Object.values(params.plus.tariffs).map(t => t.id),
         tax_rates: params.plus.tax_rates,
-        plans: [params.plus.prices.monthly],
       },
+      tariffs: params.plus.tariffs,
       additionalUser: params.plus.prices.additionalUser,
       additionalUserPrice: params.plus.additionalUserPrice,
     },
-    premium: {
-      id: params.premium.id,
-      internal: 'premium',
+    classic: {
+      id: params.classic.id,
+      internal: 'classic',
       product: {
-        active: true,
-        description:
-          'Pour les grandes entreprises qui cherchent des outils administratifs poussés',
-        id: params.premium.id,
-        name: 'Premium',
+        id: params.classic.id,
+        name: 'Abonnement Articho',
+        description: '',
         type: 'service',
-        isDefault: true,
+        price: 159,
         main: true,
+        active: true,
         rating: 3,
-        tax_rates: params.premium.tax_rates,
-        price: 29900,
-        order: 2,
+        order: 3,
         includes: {
-          canCreateUser: true,
-          customCatalog: true,
-          maxTeamMembers: 20,
-          importExport: true,
+          maxAdminUsers: 1,
+          maxAgentUsers: 0,
+          maxProUsers: 0,
+          maxSellerUsers: 0,
+          authorizationManagement: true,
+          dashboard: true,
           accounting: true,
-          clientInterface: true,
+          projectStorage: true,
+          customCatalog: true,
+          customConfig: true,
+          exportReports: true,
+          externalApiIntegration: true,
+          support: true,
         },
-        plans: [params.premium.prices.monthly],
+        plans: Object.values(params.classic.tariffs).map(t => t.id),
+        tax_rates: params.classic.tax_rates,
       },
-      additionalUser: params.plus.prices.additionalUser,
-      additionalUserPrice: params.premium.additionalUserPrice,
+      tariffs: params.classic.tariffs,
+      additionalUser: params.classic.prices.additionalUser,
+      additionalUserPrice: params.classic.additionalUserPrice,
     },
   };
 

package/src/plans/index.ts

@@ -13,31 +13,44 @@ export { Product, ProductEntry, SubscriptionSettings };
 
 const testing: ProductCreationParams = {
   standard: {
-    id: 'prod_HzWVSbBrLFn02Y',
+    id: 'prod_KzmEyS3UQ5lbnz',
     tax_rates: ['txr_1HPXZVLFzcsAA7x6w0zpHu01'],
+    tariffs: {
+      base: { id: 'price_1KJmg4LFzcsAA7x6SMfj1iDu', price: 69, usageType: 'licensed', type: 'base' },
+    },
     prices: {
-      monthly: 'price_1HPXSXLFzcsAA7x67BcgPhLS',
-      additionalUser: 'price_1HRPbYLFzcsAA7x6FTmLOIGj',
+      monthly: 'price_1KJmg4LFzcsAA7x6SMfj1iDu',
+      additionalUser: 'price_1KJmg4LFzcsAA7x6yzvGdoxe',
     },
-    additionalUserPrice: 1000,
+    additionalUserPrice: 10,
   },
   plus: {
-    id: 'prod_HzWYKl09U12eLQ',
+    id: 'prod_KzmyY1ysEOeK93',
     tax_rates: ['txr_1HPXZVLFzcsAA7x6w0zpHu01'],
+    tariffs: {
+      base: { id: 'price_1KJnP0LFzcsAA7x6oDVeaPAv', price: 159, usageType: 'licensed', type: 'base' },
+    },
     prices: {
-      monthly: 'price_1HPXVBLFzcsAA7x61LF40zVU',
-      additionalUser: 'price_1HRPfVLFzcsAA7x6JcMj1DWr',
+      monthly: 'price_1KJnP0LFzcsAA7x6oDVeaPAv',
+      additionalUser: 'price_1KJnP0LFzcsAA7x6s3rO71QX',
     },
-    additionalUserPrice: 1000,
+    additionalUserPrice: 5,
   },
-  premium: {
-    id: 'prod_HzWZVpSP77M3Pt',
+  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' },
+    },
     prices: {
-      monthly: 'price_1HPXWPLFzcsAA7x6sjYdFXOR',
-      additionalUser: 'price_1HRPjhLFzcsAA7x6o28A8tDC',
+      monthly: 'price_1KJmpiLFzcsAA7x6rLA0GNZX',
+      additionalUser: 'price_1KJmpiLFzcsAA7x6VtCIuhqw',
     },
-    additionalUserPrice: 500,
+    additionalUserPrice: 30,
   },
 };
 
@@ -45,29 +58,42 @@ const production: ProductCreationParams = {
   standard: {
     id: 'prod_HsAwETfIUblsAT',
     tax_rates: ['txr_1HIMA8LFzcsAA7x61nsqfrYU'],
+    tariffs: {
+      base: { id: 'price_1HIQaILFzcsAA7x6NVk3cJu1', price: 69, usageType: 'licensed', type: 'base' },
+    },
     prices: {
       monthly: 'price_1HIQaILFzcsAA7x6NVk3cJu1',
       additionalUser: 'price_1HRQFTLFzcsAA7x6X9wS7JUr',
     },
-    additionalUserPrice: 1000,
+    additionalUserPrice: 10,
   },
   plus: {
     id: 'prod_HsB2YJPEZ9H98c',
     tax_rates: ['txr_1HIMA8LFzcsAA7x61nsqfrYU'],
+    tariffs: {
+      base: { id: 'price_1HIQg0LFzcsAA7x6X6lfFUdv', price: 159, usageType: 'licensed', type: 'base' },
+    },
     prices: {
       monthly: 'price_1HIQg0LFzcsAA7x6X6lfFUdv',
       additionalUser: 'price_1HRg1fLFzcsAA7x6QYbtnty6',
     },
-    additionalUserPrice: 1000,
+    additionalUserPrice: 5,
   },
-  premium: {
-    id: 'prod_HsB1kn49KcAbL1',
+  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' },
+    },
     prices: {
-      monthly: 'price_1HIQfYLFzcsAA7x6AFuSBinh',
-      additionalUser: 'price_1HRfz6LFzcsAA7x6dFDETn6N',
+      monthly: 'price_1KJmzNLFzcsAA7x6I6gNlCpY',
+      additionalUser: 'price_1KJmzNLFzcsAA7x6Tl6D8Wus',
     },
-    additionalUserPrice: 500,
+    additionalUserPrice: 30,
   },
 };
 

package/src/plans/types.ts

@@ -30,6 +30,61 @@ export interface SubscriptionSettings {
    * How many members can have a team
    */
   maxTeamMembers?: number;
+
+  /**
+   *
+   */
+  authorizationManagement?: boolean;
+
+  /**
+   * Acces to dashboard
+   */
+  dashboard?: boolean;
+
+  /**
+   * Acces to projects
+   */
+  projectStorage?: boolean;
+
+  /**
+   * This plan allows you to export PDF and Excel reports
+   */
+  exportReports?: boolean;
+
+  /**
+   * This plan allows you to customize the settings
+   */
+  customConfig?: boolean;
+
+  /**
+   *
+   */
+  externalApiIntegration?: boolean;
+
+  /**
+   *
+   */
+  support?: boolean
+
+  /**
+   * How many admins can have a team
+   */
+  maxAdminUsers?: number | null;
+
+  /**
+   * How many agents can have a team
+   */
+  maxAgentUsers?: number | null;
+
+  /**
+   * How many pros can have a team
+   */
+  maxProUsers?: number | null;
+
+  /**
+   * How many sellers can have a team
+   */
+  maxSellerUsers?: number | null;
 }
 
 export interface Product {
@@ -81,6 +136,11 @@ export interface Product {
    */
   rating: number;
 
+  /**
+   * Marked as private
+   */
+  isPrivate?: boolean;
+
   /**
    * Stripe plans associated with this product to be charged automatically
    */
@@ -101,20 +161,34 @@ 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' };
+  };
   additionalUser: string;
   additionalUserPrice: number;
 };
 
 export type ProductReference = {
-  standard: ProductEntry;
+  classic: ProductEntry;
   plus: ProductEntry;
-  premium: ProductEntry;
+  standard: ProductEntry;
 };
 
 export type ProductCreationParams = {
   standard: {
     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' };
+    };
     prices: {
       monthly: string;
       additionalUser: string;
@@ -124,15 +198,29 @@ export type ProductCreationParams = {
   plus: {
     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' };
+    };
     prices: {
       monthly: string;
       additionalUser: string;
     };
     additionalUserPrice: number;
   };
-  premium: {
+  classic: {
     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' };
+    };
     prices: {
       monthly: string;
       additionalUser: string;