@placeshakr/config 10.19.12 → 10.19.13-alpha.4

package/src/environment/base.ts

@@ -42,6 +42,7 @@ const productionEnvironment: Environment = {
       medias: 'enterprises/{enterpriseId}/projects/{projectId}/medias',
       events: 'enterprises/{enterpriseId}/projects/{projectId}/events',
       notes: 'enterprises/{enterpriseId}/projects/{projectId}/notes',
+      visitReports: 'enterprises/{enterpriseId}/projects/{projectId}/visitReports',
       documents: 'enterprises/{enterpriseId}/projects/{projectId}/documents',
       devis: 'enterprises/{enterpriseId}/projects/{projectId}/devis',
       admins: 'enterprises/{enterpriseId}/admins',
@@ -50,7 +51,6 @@ const productionEnvironment: Environment = {
       tasks: 'enterprises/{enterpriseId}/projects/{projectId}/tasks',
       externalPlans:
         'enterprises/{enterpriseId}/projects/{projectId}/externalPlans',
-      payments: 'enterprises/{enterpriseId}/projects/{projectId}/payments',
       downPayments: 'enterprises/{enterpriseId}/projects/{projectId}/downPayments',
       providers: 'enterprises/{enterpriseId}/providers',
       statuses: 'enterprises/{enterpriseId}/statuses',
@@ -89,6 +89,7 @@ const productionEnvironment: Environment = {
       events:
         'enterprises/{enterpriseId}/projects/{projectId}/events/{eventId}',
       notes: 'enterprises/{enterpriseId}/projects/{projectId}/notes/{noteId}',
+      visitReports: 'enterprises/{enterpriseId}/projects/{projectId}/visitReports/{visitReportId}',
       documents:
         'enterprises/{enterpriseId}/projects/{projectId}/documents/{documentId}',
       devis: 'enterprises/{enterpriseId}/projects/{projectId}/devis/{devisId}',
@@ -99,8 +100,6 @@ const productionEnvironment: Environment = {
       task: 'enterprises/{enterpriseId}/projects/{projectId}/tasks/{taskId}',
       externalPlans:
         'enterprises/{enterpriseId}/projects/{projectId}/externalPlans/{externalPlanId}',
-      payments:
-        'enterprises/{enterpriseId}/projects/{projectId}/payments/{paymentId}',
       downPayments: 'enterprises/{enterpriseId}/projects/{projectId}/downPayments/{downPaymentId}',
       paymentMethods:
         'enterprises/{enterpriseId}/paymentMethods/{paymentMethodId}',
@@ -141,6 +140,7 @@ const productionEnvironment: Environment = {
       medias: 'projects-medias',
       events: 'projects-events',
       notes: 'projects-notes',
+      visitReports: 'projects-visitReports',
       documents: 'projects-documents',
       devis: 'projects-devis',
       admins: 'admins',
@@ -148,7 +148,6 @@ const productionEnvironment: Environment = {
       taskGroups: 'projects-taskGroups',
       tasks: 'projects-tasks',
       externalPlans: 'projects-externalPlans',
-      payments: 'projects-payments',
       downPayments: 'projects-downPayments',
       providers: 'providers',
       statuses: 'statuses',
@@ -335,10 +334,11 @@ const productionEnvironment: Environment = {
     operations: {
       searchableAttributes: ['name', 'unitPrice', 'objectID'],
       attributesForFaceting: [
-        'searchable(lot)',
         'unitPrice',
+        'searchable(lot)',
         'searchable(scope)',
-        'catalogId',
+        'searchable(catalogId)',
+        'searchable(category)'
       ],
       maxValuesPerFacet: 1000,
       maxFacetHits: 100
@@ -413,6 +413,13 @@ const productionEnvironment: Environment = {
       maxValuesPerFacet: 1000,
       maxFacetHits: 100
     },
+    visitReports: {
+      searchableAttributes: ['title'],
+      attributesForFaceting: ['projectId', 'searchable(scope)'],
+      ranking: ['desc(createdAt)'],
+      maxValuesPerFacet: 1000,
+      maxFacetHits: 100
+    },
     medias: {
       searchableAttributes: ['name'],
       attributesForFaceting: [
@@ -479,13 +486,6 @@ const productionEnvironment: Environment = {
       maxValuesPerFacet: 1000,
       maxFacetHits: 100
     },
-    payments: {
-      searchableAttributes: ['percent', 'devisId', 'projectId'],
-      attributesForFaceting: ['searchable(devisId)', 'searchable(projectId)', 'searchable(scope)'],
-      ranking: ['asc(date)'],
-      maxValuesPerFacet: 1000,
-      maxFacetHits: 100
-    },
     downPayments: {
       searchableAttributes: ['percent', 'devisId', 'projectId', 'billId', 'locked'],
       attributesForFaceting: ['searchable(billId)', 'searchable(locked)', 'searchable(devisId)', 'searchable(projectId)', 'searchable(scope)'],

package/src/environment/decorators.ts

@@ -29,6 +29,7 @@ const test: EnvironmentDecorator = (base: Environment) => ({
       medias: 'tests-projects-medias',
       events: 'tests-projects-events',
       notes: 'tests-projects-notes',
+      visitReports: 'tests-projects-visit-reports',
       documents: 'tests-projects-documents',
       devis: 'tests-projects-devis',
       admins: 'tests-admins',
@@ -85,6 +86,7 @@ const emulator: EnvironmentDecorator = (base: Environment) => ({
       medias: 'emulator-projects-medias',
       events: 'emulator-projects-events',
       notes: 'emulator-projects-notes',
+      visitReports: 'emulator-projects-visit-reports',
       documents: 'emulator-projects-documents',
       devis: 'emulator-projects-devis',
       admins: 'emulator-admins',

package/src/environment/types.ts

@@ -42,6 +42,7 @@ export interface Environment {
       medias: string;
       events: string;
       notes: string;
+      visitReports: string;
       documents: string;
       devis: string;
       admins: string;
@@ -49,7 +50,6 @@ export interface Environment {
       taskGroups: string;
       tasks: string;
       externalPlans: string;
-      payments: string;
       downPayments: string;
       providers: string;
       statuses: string;
@@ -89,6 +89,7 @@ export interface Environment {
       medias: string;
       events: string;
       notes: string;
+      visitReports: string;
       documents: string;
       devis: string;
       admins: string;
@@ -96,7 +97,6 @@ export interface Environment {
       taskGroups: string;
       tasks: string;
       externalPlans: string;
-      payments: string;
       downPayments: string;
       providers: string;
       statuses: string;
@@ -133,6 +133,7 @@ export interface Environment {
       medias: string;
       events: string;
       notes: string;
+      visitReports: string;
       documents: string;
       devis: string;
       admin: string;
@@ -140,7 +141,6 @@ export interface Environment {
       taskGroup: string;
       task: string;
       externalPlans: string;
-      payments: string;
       downPayments: string;
       provider: string;
       status: string;

package/src/helpers/index.ts

@@ -9,6 +9,7 @@ export interface Helpers {
   users: FactoryCreate<articho.User>;
   profiles: FactoryCreate<articho.Profile>;
   notes: FactoryCreate<articho.Note>;
+  visitReports: FactoryCreate<articho.VisitReport>;
   medias: FactoryCreate<articho.Media>;
   materials: FactoryCreate<articho.Material>;
   bills: FactoryCreate<articho.Bill>;
@@ -59,6 +60,7 @@ const helpers: Helpers = {
   profiles: FactoryCreateFunction(),
   projects: FactoryCreateFunction(),
   notes: FactoryCreateFunction(),
+  visitReports: FactoryCreateFunction(),
   materials: FactoryCreateFunction(),
   medias: FactoryCreateFunction(),
   plans: FactoryCreateFunction(),

package/src/types.ts

@@ -29,6 +29,7 @@ export type ResourceType =
   | Event
   | Plan
   | Note
+  | VisitReport
   | TaskGroup
   | Task
   | Devis
@@ -375,6 +376,10 @@ export interface Enterprise extends Resource {
   }>;
 
   certificates: Certificate[];
+
+  pluginsConfig?: {
+    visitReport?: boolean;
+  };
 }
 
 export type Certificate = { name: string; number: number };
@@ -715,7 +720,7 @@ export interface SuperAdmin extends Profile {
   role: ROLE.SUPERADMIN;
 }
 
-export interface Commissions {
+export type Commissions = {
   /**
    * Percentage corresponding to the company
    */
@@ -1045,6 +1050,92 @@ export interface Note extends Resource {
   images: File[];
 }
 
+/**
+ * Represents a project visit report
+ */
+export interface VisitReport extends Resource {
+  visitDate: number;
+  postalCode: string;
+  surface: number;
+  tenants: number;
+  incomeLevel: string;
+  yearBuilt: number;
+  floors: number;
+  ceilingHeight: number;
+  terracedHouse: boolean;
+  windowType: string[];
+  windowTypeDescription?: string;
+  murType: string;
+  indoorTemp: number;
+  boilerCondensation: string;
+  boilerBrand: string;
+  boilerRef: string;
+  boilerWeight: number;
+  boilerDimensions: string;
+  boilerDiameter: string;
+  boilerFiles: File[];
+  installDifficulty: string;
+  installInfoExtra: string;
+  wallDescription: string;
+  wallFiles: File[];
+  doorHeight: number;
+  doorWidth: number;
+  accessibilityDescription: string;
+  accessibilityFiles: File[];
+  electricSubscription: string;
+  electricPower: string;
+  electricPanelPlace: boolean;
+  electricFiles: File[];
+  distanceUnitIntAndPanel: number;
+  unitIntLocation: string;
+  unitIntFiles: File[];
+  distanceUiUe: number;
+  unitOutsideLocation: string;
+  unitOutsideFiles: File[];
+  domesticHWTDescription: string;
+  domesticHWTFiles: File[];
+  hotWater: boolean;
+  emitterType: string;
+  radiatorType: string;
+  radiatorFiles: File[];
+  hotWaterLoop: boolean;
+  nearbyDrainDescription: string;
+  nearbyDrainFiles: File[];
+  heatingNetworkType: string[];
+  heatingNetworkDiameter: string;
+  heatingNetworkFiles: File[];
+  networkEFAndDHWType: string[];
+  networkEFAndDHWDiameter: string;
+  networkEFAndDHWFiles: File[];
+  comments: string;
+  additionalFiles: File[];
+
+  devisType: string;
+  devisTypeDescription?: string;
+
+  estimatedResult: {
+    power: number,
+    devis: string,
+    equipment: string,
+    equipmentSize: string,
+    helps: { name: string, value: number }[]
+  };
+  customResult?: {
+    power: string,
+    devis: string,
+    equipment: string,
+    equipmentSize: string,
+    helps: { name: string, value: number }[]
+  };
+  title: string;
+  status: VisitReportStatus;
+}
+
+export enum VisitReportStatus {
+  IN_PROGRESS = 'IN_PROGRESS',
+  VALID = 'VALID',
+}
+
 export interface Media extends Resource {
   /**
    * When this resource has been created but onlu the date (not time)
@@ -1352,7 +1443,7 @@ export interface DevisMaterial extends Material {
   /**
    *
    */
-  responsible?: 'CLIENT' | 'PRO' | 'ENTERPRISE' | 'SELLER';
+  responsible?: ItemResponsible;
   /**
    *
    */
@@ -1391,6 +1482,8 @@ export interface DevisMaterial extends Material {
   fixed?: boolean;
 
   quantityConfig?: number
+
+  commissions?: Commissions
 }
 
 export interface Order extends Resource {
@@ -1423,6 +1516,9 @@ export interface DevisPiece extends Resource {
   /** Piece, example: bathroom, kitchen */
   name: string;
 
+  /** Used when the piece is a lot */
+  color?: string;
+
   /**
    * Display operations open or compresed
    */
@@ -1437,6 +1533,8 @@ export interface DevisPiece extends Resource {
    * Only used when devis format is PIECE
    */
   surfaces?: PieceSurfaces;
+
+  commissions?: Commissions
 }
 
 /**
@@ -1534,6 +1632,12 @@ export interface DevisOperation extends Resource {
   blockPrice?: boolean;
 
   blockTVA?: boolean;
+
+  adjustmentComplement?: string
+
+  commissions?: Commissions
+
+  responsible?: ItemResponsible;
 }
 
 /**
@@ -1548,7 +1652,7 @@ export interface Devis extends Resource {
   /**
    * Status
    */
-  status: 'CREATED' | 'SENT' | 'APPROVED' | 'REFUSED' | 'ABANDONED';
+  status: DevisStatusEnum;
 
   /**
    * Devis prices
@@ -1649,8 +1753,11 @@ export interface Devis extends Resource {
    * Used to copy commission values and TVA from provider when devis is created
    * whit this is possible to change provider config values and don't affect devis already created
    */
-  providerData?: Commissions & {
+  providerData?: {
     tva: number;
+    pro: number;
+    provider: number;
+    enterprise: number;
   };
 
   /**
@@ -1677,12 +1784,12 @@ export interface Devis extends Resource {
   /**
    * Payment planning (temporarily saved in the devis collection in Firestore)
    */
-  paymentPlanning?: [
-    {
-      description: string;
-      percent: number;
-    }
-  ];
+  paymentPlanning?: { description: string; percent: number; }[];
+
+  /**
+   * Allow user to add some additionals informations into the devis pdf depending on the section choose
+   */
+  docMetadata?: DocMetadataItem[];
 
   /************************************ V2 ************************************/
   operationsCatalog?: string;
@@ -1701,6 +1808,12 @@ export interface Devis extends Resource {
   bankDetails?: BankDetails;
 }
 
+export interface DocMetadataItem {
+  section?: DevisPdfSectionEnum | string;
+  title: string;
+  value: string | number;
+}
+
 export enum DevisHistoryType {
   CHANGE_STATUS = 'CHANGE_STATUS',
   SENT_TO_CLIENT = 'SENT_TO_CLIENT',
@@ -2092,7 +2205,10 @@ export interface UserNotification extends Resource {
   };
 }
 
-export type SelectOption = { label: string; value: string };
+export type SelectOption = {
+  label: string;
+  value: any;
+};
 
 export enum MaterialsProviderType {
   // created by the enterprises and use algolia index 'materials'
@@ -2152,6 +2268,13 @@ export enum DevisViewMode {
   CLIENT,
 }
 
+export enum DevisPdfSectionEnum {
+  FINANCIAL_HELP = 'FINANCIAL_HELP',
+  PROJECT = 'PROJECT',
+  CLIENT = 'CLIENT',
+  PROJECT_MANAGER = 'PROJECT_MANAGER',
+}
+
 export enum DocumentsTypeEnum {
   DEVIS = 'DEVIS',
   DOCUMENT = 'DOCUMENT',
@@ -2176,11 +2299,11 @@ export enum ExternalPlanTypeEnum {
 
 export enum BillIssuedStatus {
   PROVISIONAL = 'PROVISIONAL',
+  WAITING = 'WAITING',
   CREATED = 'CREATED',
   SENT = 'SENT',
-  WAITING = 'WAITING',
-  BLOCKED = 'BLOCKED',
   PAID = 'PAID',
+  BLOCKED = 'BLOCKED',
   CANCELED = 'CANCELED',
 }
 
@@ -2407,6 +2530,7 @@ export interface ProjectCounter {
   externalPlans: number;
   medias: number;
   notes: number;
+  visitReports: number;
   plans: number;
   taskGroups: number;
   tasks: number;
@@ -2784,6 +2908,11 @@ export interface OperationV2 extends Resource {
    */
   lot: string;
 
+  /**
+   * The operation base price
+   */
+  basePrice: number;
+
   /**
    * The operation unit price
    */
@@ -2880,13 +3009,14 @@ export interface OperationV2Material extends Material {
   quantity: number;
   loss: number;
   rounded: boolean;
-  responsible: string;
+  responsible: ItemResponsible;
   fixed: boolean;
   optId: string;
   complement?: string;
 }
 
-export enum MaterialResponsible {
+export enum ItemResponsible {
+  NONE = 'NONE',
   CLIENT = 'CLIENT',
   PRO = 'PRO',
   AGENT = 'AGENT',