@placeshakr/config 10.16.0 → 10.17.2-alpha.0

package/src/types.ts

@@ -42,7 +42,11 @@ export type ResourceType =
   | UserNotification
   | ReceptionVoucher
   | Provider
-  | Category;
+  | Category
+  | OperationCatalog
+  | Nomenclature
+  | Operation
+  | OperationV2
 
 /**
  * Add timestampable behavior to any resource
@@ -172,13 +176,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
@@ -264,13 +268,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;
@@ -1659,6 +1663,8 @@ export type BillIssued = Bill & {
     TVA: number;
     // discount value is calculated using: finalHT - HT
     discount?: number;
+    // this value is calculated using adjustments in each element
+    adjustments?: number;
   };
 };
 
@@ -2447,5 +2453,160 @@ export interface Category extends Resource {
 
 export enum CategoryEntityEnum {
   MATERIAL = 'MATERIAL',
-  OPERATION = 'OPERATION',
+  OPERATION = 'OPERATION'
+}
+
+export interface OperationCatalog extends Resource {
+  name: string,
+  status: boolean,
+  sectors?: Array<{
+    objectID: string,
+    name: string,
+    value: number
+  }>;
+  description?: string;
+  materialsProvider?: Array<string>,
+  image?: File | null
+}
+
+export interface Nomenclature extends Resource {
+  name: string,
+  status: boolean,
+  identifier: NomenclaturesIdentifier,
+  color?: string
+}
+
+export enum NomenclaturesIdentifier {
+  OPERATIONS_SECTOR = "OPERATIONS_SECTOR",
+  OPERATIONS_PIECE = "OPERATIONS_PIECE",
+  OPERATIONS_LOT = "OPERATIONS_LOT",
+}
+
+
+/**
+ * New version of operations with more advanced config
+ */
+export interface OperationV2 extends Resource {
+  /**
+   * The operation id
+   */
+  objectID?: string;
+
+  /**
+   * The operation name
+   */
+  name: string;
+
+  /**
+   * The operation surface
+   */
+  lot: string;
+
+  /**
+   * The operation unit price
+   */
+  price: number;
+
+  /**
+   * The operation unit
+   */
+  unit: string;
+
+  /**
+   * The operation description
+   */
+  description?: string;
+
+  /**
+   * The materials added by default to the operation
+   */
+  materials?: Material[] | [];
+
+  /**
+   * Number of materials assigned to the operation
+   */
+  numberOfMaterials?: number;
+
+  /**
+   * 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
+
+  /**
+    * 
+    */
+  tva?: number | null
+
+  /**
+   * Used to create relation between operations and his catalog
+   */
+  catalogId: string
+
+  /**
+   * Used in operations page to assign categories
+   */
+  category: string;
+
+  /**
+   * Used to restrict modification in devis page
+   */
+  blockPrice?: boolean;
+
+  /**
+   * Used to restrict modification in devis page
+   */
+  blockTVA?: boolean;
+
+  /**
+   * Quantity 
+   */
+  quantity?: OperationQuantityEnum;
+
+  /**
+   * List of rules used to re-calculate the price
+   */
+  adjustments?: Array<OperationAdjustment>
+
+  reserves?: string
 }
+
+export interface OperationAdjustment {
+  rule: OperationRulesEnum
+  bigger?: number
+  lower?: number
+  equal?: number
+  complement?: string
+  percent: number
+}
+
+export enum OperationQuantityEnum {
+  NOT_DEFINED = "NOT_DEFINED",
+  PERIMETER = "PERIMETER",
+  GROUND_CEILING_SURFACE = "GROUND_CEILING_SURFACE",
+  WALL_SURFACE = "WALL_SURFACE",
+}
+
+export enum OperationRulesEnum {
+  BIGGER_THAN = "BIGGER_THAN",
+  LOWER_THAN = "LOWER_THAN",
+  EQUAL_TO = "EQUAL_TO",
+  BETWEEN = "BETWEEN"
+}
+
+export interface OperationV2Material extends Material {
+  quantity: number
+  loss: number
+  rounded: boolean
+  responsible: string
+  fixed: boolean
+  optId: string
+}
+
+export enum MaterialResponsible {
+  CLIENT = "CLIENT",
+  PRO = "PRO",
+  AGENT = "AGENT",
+  SELLER = "SELLER",
+  ENTERPRISE = "ENTERPRISE",
+}