@placeshakr/config 10.14.1-alpha.1 → 10.16.0

package/src/types.ts

@@ -42,7 +42,7 @@ export type ResourceType =
   | UserNotification
   | ReceptionVoucher
   | Provider
-  | Category
+  | Category;
 
 /**
  * Add timestampable behavior to any resource
@@ -108,6 +108,11 @@ export interface Enterprise extends Resource {
    */
   commercialName: string;
 
+  /**
+   * Display the company name next to the logo
+   */
+  displayName: boolean;
+
   /** The enterprise commercial status */
   commercialStatus: CommercialStatusEnum;
 
@@ -167,13 +172,13 @@ export interface Enterprise extends Resource {
    * Current subscription status
    */
   status:
-  | 'incomplete'
-  | 'incomplete_expired'
-  | 'trialing'
-  | 'active'
-  | 'past_due'
-  | 'canceled'
-  | 'unpaid';
+    | 'incomplete'
+    | 'incomplete_expired'
+    | 'trialing'
+    | 'active'
+    | 'past_due'
+    | 'canceled'
+    | 'unpaid';
 
   /**
    * Kind of forfait
@@ -259,13 +264,13 @@ export interface Enterprise extends Resource {
      * state of subscription
      */
     status:
-    | 'incomplete'
-    | 'incomplete_expired'
-    | 'trialing'
-    | 'active'
-    | 'past_due'
-    | 'canceled'
-    | 'unpaid';
+      | 'incomplete'
+      | 'incomplete_expired'
+      | 'trialing'
+      | 'active'
+      | 'past_due'
+      | 'canceled'
+      | 'unpaid';
   };
 
   insurance?: string;
@@ -310,7 +315,7 @@ export interface Enterprise extends Resource {
   /**
    * Geographical area covered, used in bills PDF data
    */
-  areaCovered?: string
+  areaCovered?: string;
 }
 
 /**
@@ -624,7 +629,7 @@ export interface Commissions {
    * Percentage corresponding to the provider
    */
   provider: number;
-};
+}
 
 /**
  * Represents an provider
@@ -727,18 +732,17 @@ export interface Status extends Resource {
   /**
    * Used to order status list
    */
-  order: number
+  order: number;
 
   /**
    * To know if status comes from system-status Algolia index and avoid delete or modify it
    */
-  system?: boolean
+  system?: boolean;
 
   /**
    * To know if status is fix in the position
    */
-  locked?: boolean
-
+  locked?: boolean;
 
   /**
    * Identifier to relate the status to its correspondent in system status algolia index
@@ -804,13 +808,13 @@ export interface Operation extends Resource {
    * Used at the moment of copy catalogs from system-operations to the enterprise
    * to create the relation between operations and system-operations-materials
    */
-  systemId?: string
+  systemId?: string;
 
   /**
-    * by default this value will be null, at time to use this operation 
-    * in devis will get tva from provider assigned to the project
-    */
-  tva?: number | null
+   * by default this value will be null, at time to use this operation
+   * in devis will get tva from provider assigned to the project
+   */
+  tva?: number | null;
 }
 
 /**
@@ -915,7 +919,7 @@ export interface Project extends Resource {
    * Used when a bill is approved
    * if is true project can't be removed
    */
-  blocked?: boolean
+  blocked?: boolean;
 }
 
 /**
@@ -947,7 +951,7 @@ export interface Media extends Resource {
   /**
    * When this resource has been created but onlu the date (not time)
    */
-  createdDate?: number
+  createdDate?: number;
   /**
    * The media name
    */
@@ -1044,9 +1048,9 @@ export interface Event extends Resource {
 }
 
 export interface PlanPage {
-  fileId: string,
-  source: string,
-  id: string
+  fileId: string;
+  source: string;
+  id: string;
 }
 
 /**
@@ -1057,13 +1061,13 @@ export interface Plan extends Resource {
   description: string;
   file: File;
   files: File[];
-  pages: PlanPage[]
+  pages: PlanPage[];
   elements: any[];
   validation?: {
-    userName: string
-    date: number
-  } | null
-  updatedByUsers?: any
+    userName: string;
+    date: number;
+  } | null;
+  updatedByUsers?: any;
   pdf?: File;
 }
 
@@ -1171,9 +1175,9 @@ export interface Material extends Resource {
   order?: number;
 
   /**
-    * by default this value will be null, at time to use this operation 
-    * in devis will get tva from operation
-    */
+   * by default this value will be null, at time to use this operation
+   * in devis will get tva from operation
+   */
   tva?: number | null;
 
   /**
@@ -1194,7 +1198,7 @@ export interface Material extends Resource {
   /**
    * Custom reference defined by user
    */
-  reference?: string
+  reference?: string;
 }
 
 export interface DevisMaterial extends Material {
@@ -1250,7 +1254,7 @@ export interface DevisMaterial extends Material {
    */
   devisId?: string;
 
-  tva?: number
+  tva?: number;
 }
 
 export interface Order extends Resource {
@@ -1437,29 +1441,29 @@ export interface Devis extends Resource {
   /**
    * Define which type of pdf will be created together with pro
    */
-  contractingEntity?: DevisContractingEntity
+  contractingEntity?: DevisContractingEntity;
 
   /**
    * Save the information of devis bill after apply any changes
    */
   accounting?: {
-    percent: number
-    paid: number,
-    type?: BillIssuedType
-    date?: Date
-  }
+    percent: number;
+    paid: number;
+    type?: BillIssuedType;
+    date?: Date;
+  };
   /**
    * Used on devis pdf and accounting
    */
-  reference?: string
+  reference?: string;
 
   /**
    * 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 & {
-    tva: number
-  }
+    tva: number;
+  };
 
   /**
    * Save percent and its value assigned to each entity on devis after apply modifications
@@ -1467,10 +1471,10 @@ export interface Devis extends Resource {
    * used on accounting to display devis price block and dashboards
    */
   commissions?: {
-    pro: { percent: number, value: number },
-    provider: { percent: number, value: number },
-    enterprise: { percent: number, value: number }
-  }
+    pro: { percent: number; value: number };
+    provider: { percent: number; value: number };
+    enterprise: { percent: number; value: number };
+  };
 }
 
 /**
@@ -1531,22 +1535,22 @@ export type Payment = Resource & {
 };
 
 /**
- * Used on accounting 
+ * Used on accounting
  */
 
 export type DownPayment = Payment & {
-  devisPrice: number
-  devisTVA: number
+  devisPrice: number;
+  devisTVA: number;
   bill?: {
-    id: string,
-    date: Date,
-    price: number
-  }
+    id: string;
+    date: Date;
+    price: number;
+  };
   /**
    * This will change to true if any custom bill is created on the devis related with it
    */
-  locked?: boolean
-}
+  locked?: boolean;
+};
 
 export type BillElement = {
   id: string;
@@ -1563,34 +1567,35 @@ export type BillElement = {
   totalTTC: number;
   isUpdated: boolean;
   isInvoiced: boolean;
-  devisId: string
+  devisId: string;
 };
 
 export type EntityData = {
-  name: string,
-  id?: string,
-  address?: string,
-  email?: string,
-  siret?: string,
-  tva?: string
-}
+  name: string;
+  id?: string;
+  address?: string;
+  email?: string;
+  siret?: string;
+  tva?: string;
+};
 
 export type ReceptionVoucher = Resource & {
-  status: ReceptionVoucherStatus,
-  title: string,
-  files: File[],
-  statusComment?: string,
-  statusDate?: number
-}
+  status: ReceptionVoucherStatus;
+  title: string;
+  files: File[];
+  statusComment?: string;
+  statusDate?: number;
+};
 
 export type Bill = Resource & {
   title: string;
   projectId: string;
   devisIds: Array<string>;
-  date: number; providerCommission?: boolean;
+  date: number;
+  providerCommission?: boolean;
   reference?: string;
   pdf?: File;
-  entityData?: EntityData
+  entityData?: EntityData;
   statusDate?: number;
   statusComment?: string;
   statusHistory?: any;
@@ -1630,16 +1635,16 @@ export type BillIssued = Bill & {
   downPaymentsIds?: Array<string>;
   // used by subType CREDIT_NOTE to create the relation between bills
   billSource?: {
-    id: string,
-    reference: string,
+    id: string;
+    reference: string;
     status?: BillIssuedStatus;
   };
   // bills list of CREDIT_NOTE associated with this bill
-  creditNotes?: Array<{ id: string, reference: string }>
+  creditNotes?: Array<{ id: string; reference: string }>;
   // set the incremental number of bills on the enterprise
   referenceNumber?: number;
   // check if bill was imported from external documents or system
-  imported?: boolean
+  imported?: boolean;
   dateSent?: number;
 
   // prices related with the bill
@@ -1767,7 +1772,7 @@ export type File = {
   format?: string;
 
   /**
-   * 
+   *
    */
   resourceType?: string;
 
@@ -1788,8 +1793,8 @@ export type File = {
   size?: string;
 
   /**
- * The file name used to download files
- */
+   * The file name used to download files
+   */
   name?: string;
 
   /**
@@ -1828,7 +1833,7 @@ export interface UserNotification extends Resource {
   totalUnread: number;
   notifications: {
     [key: string]: Notification;
-  }
+  };
 }
 
 export type SelectOption = { label: string; value: string };
@@ -1888,7 +1893,7 @@ export enum DevisViewMode {
   HOME,
   GENERAL,
   PRO,
-  CLIENT
+  CLIENT,
 }
 
 export enum DocumentsTypeEnum {
@@ -1903,9 +1908,9 @@ export enum EventsTypeEnum {
   VISIT = 'VISIT',
   DELIVERY = 'DELIVERY',
   CONSTRUCTION = 'CONSTRUCTION',
-  SAV = "SAV",
-  TECHNICAL_STATEMENT = "TECHNICAL_STATEMENT",
-  TS_DESIGN = "TS_DESIGN",
+  SAV = 'SAV',
+  TECHNICAL_STATEMENT = 'TECHNICAL_STATEMENT',
+  TS_DESIGN = 'TS_DESIGN',
 }
 
 export enum ExternalPlanTypeEnum {
@@ -1918,7 +1923,7 @@ export enum BillIssuedStatus {
   CREATED = 'CREATED',
   SENT = 'SENT',
   WAITING = 'WAITING',
-  BLOCKED = "BLOCKED",
+  BLOCKED = 'BLOCKED',
   PAID = 'PAID',
   CANCELED = 'CANCELED',
 }
@@ -1933,7 +1938,7 @@ export enum BillReceivedStatus {
   WITHOUT_INVOICE = 'WITHOUT_INVOICE',
   PAID = 'PAID',
   REFUSED = 'REFUSED',
-  BLOCKED = "BLOCKED"
+  BLOCKED = 'BLOCKED',
 }
 
 export enum ReceptionVoucherStatus {
@@ -1958,23 +1963,23 @@ export enum BillReceivedEntity {
 
 export enum BillReceivedType {
   FACTURE = 'FACTURE',
-  CREDIT_NOTE = 'CREDIT_NOTE'
+  CREDIT_NOTE = 'CREDIT_NOTE',
 }
 
 export enum BillIssuedEntity {
   CLIENT = 'CLIENT',
   PRO = 'PRO',
   PROVIDER = 'PROVIDER',
-  MATERIAL_PROVIDER = "MATERIAL_PROVIDER",
-  SERVICE_PROVIDER = "SERVICE_PROVIDER",
-  OTHER = "OTHER"
+  MATERIAL_PROVIDER = 'MATERIAL_PROVIDER',
+  SERVICE_PROVIDER = 'SERVICE_PROVIDER',
+  OTHER = 'OTHER',
 }
 
 export enum BillIssuedType {
   CUSTOM = 'CUSTOM',
   DOWN_PAYMENT = 'DOWN_PAYMENT',
   BALANCE = 'BALANCE',
-  CREDIT_NOTE = "CREDIT_NOTE"
+  CREDIT_NOTE = 'CREDIT_NOTE',
 }
 
 export enum BillElementType {
@@ -1983,7 +1988,7 @@ export enum BillElementType {
   DAYS = 'DAYS',
   PRODUCT = 'PRODUCT',
   SERVICE = 'SERVICE',
-  PROVIDER_COMMISSION = 'PROVIDER_COMMISSION'
+  PROVIDER_COMMISSION = 'PROVIDER_COMMISSION',
 }
 
 export enum BillDiscountType {
@@ -2019,7 +2024,7 @@ export enum ProjectCategoriesEnum {
   WALL_COVERING = 'WALL_COVERING',
   STAIRS = 'STAIRS',
   OUTSIDE = 'OUTSIDE',
-  COMMERCE = "COMMERCE",
+  COMMERCE = 'COMMERCE',
 }
 
 export enum TaskStatus {
@@ -2308,8 +2313,8 @@ export interface Estimation extends Resource {
   files?: Array<File>;
   comment?: string;
   /*
-  * link to project if estimate generated one
-  */
+   * link to project if estimate generated one
+   */
   projectId?: string;
 }
 
@@ -2322,23 +2327,23 @@ export enum EmailTemplate {
   CLIENT_ESTIMATION_WEBSITE = 'client-estimation-website',
   CLIENT_ESTIMATION_ARTICHO = 'client-estimation-articho',
   ENTERPRISE_ESTIMATION = 'enterprise-estimation',
-  RESET_PASSWORD = "reset-password",
-  WELCOME_TO_ENTERPRISE = "welcome-to-enterprise",
-  WELCOME_TO_NEW_ENTERPRISE = "welcome-to-new-enterprise",
-  NEW_ENTERPRISE = "new-enterprise",
+  RESET_PASSWORD = 'reset-password',
+  WELCOME_TO_ENTERPRISE = 'welcome-to-enterprise',
+  WELCOME_TO_NEW_ENTERPRISE = 'welcome-to-new-enterprise',
+  NEW_ENTERPRISE = 'new-enterprise',
   USER_CONTACT = 'user-contact',
-  PLAN = 'plan'
+  PLAN = 'plan',
 }
 
 export enum DevisPdfType {
   PROVIDER = 'provider',
   PROFESSIONAL = 'professional',
-  ENTERPRISE = 'enterprise'
+  ENTERPRISE = 'enterprise',
 }
 
 export enum DevisContractingEntity {
   PROVIDER = 'provider',
-  ENTERPRISE = 'enterprise'
+  ENTERPRISE = 'enterprise',
 }
 
 export enum EnterpriseStatusEnum {
@@ -2348,19 +2353,19 @@ export enum EnterpriseStatusEnum {
   ACTIVE = 'active',
   PAST_DUE = 'past_due',
   CANCELED = 'canceled',
-  UNPAID = 'unpaid'
+  UNPAID = 'unpaid',
 }
 
 export enum EnterpriseProductEnum {
   STANDARD = 'standard',
   PLUS = 'plus',
-  PREMIUM = 'premium'
+  PREMIUM = 'premium',
 }
 
 export enum EstimationStatusEnum {
   WAITING = 'WAITING',
   APPROVED = 'APPROVED',
-  REFUSED = 'REFUSED'
+  REFUSED = 'REFUSED',
 }
 
 export enum HistoryActionEnum {
@@ -2373,13 +2378,13 @@ export enum HistoryActionEnum {
   UNASSIGN_PRO = 'UNASSIGN_PRO',
   ASSIGN_SELLER = 'ASSIGN_SELLER',
   UNASSIGN_SELLER = 'UNASSIGN_SELLER',
-  APPROVED_R_V = 'APPROVED_R_V'
+  APPROVED_R_V = 'APPROVED_R_V',
 }
 
 export interface History {
   /**
-  * The internal ID of this resource
-  */
+   * The internal ID of this resource
+   */
   id?: string;
 
   /**
@@ -2398,7 +2403,7 @@ export interface History {
 export enum HistoryEntityType {
   PROJECT = 'PROJECT',
   NOTE = 'NOTE',
-  RECEPTION_VOUCHER = 'RECEPTION_VOUCHER'
+  RECEPTION_VOUCHER = 'RECEPTION_VOUCHER',
 }
 
 export interface HistoryAction {
@@ -2429,19 +2434,18 @@ export interface HistoryAction {
   data?: any;
 }
 
-
 export interface Category extends Resource {
-  name: string,
+  name: string;
   // with this field is possible to use categories in multiples area of the system and filter by it
-  entity: CategoryEntityEnum,
-  order?: number,
-  description?: string,
-  parent?: string,
+  entity: CategoryEntityEnum;
+  order?: number;
+  description?: string;
+  parent?: string;
   // create the relation between materials providers or operations catalogues
-  provider?: string
+  provider?: string;
 }
 
 export enum CategoryEntityEnum {
-  MATERIAL = "MATERIAL",
-  OPERATION = "OPERATION"
-}
+  MATERIAL = 'MATERIAL',
+  OPERATION = 'OPERATION',
+}