@placeshakr/config 10.20.0 → 10.20.2-alpha.1

package/src/environment/base.ts

@@ -157,25 +157,23 @@ const productionEnvironment: Environment = {
       systemVersion: 'systemVersions/{systemVersionId}',
     },
     indexes: {
-      // tslint:disable-next-line: object-literal-sort-keys
-      clients: 'clients',
-      pros: 'pros',
+      // users
+      admins: 'admins',
       agents: 'agents',
+      pros: 'pros',
       sellers: 'sellers',
+      clients: 'clients',
+      // projects
       projects: 'projects',
       medias: 'projects-medias',
       events: 'projects-events',
       devis: 'projects-devis',
-      admins: 'admins',
+      // configuration
       providers: 'providers',
       materials: 'materials',
       operations: 'operations',
       operationsMaterials: 'operations-materials',
-      materialsProvider: 'materials-provider',
-      devisTemplates: 'devis-templates',
       estimations: 'estimations',
-      categories: 'categories',
-      operationsCatalogs: 'operations-catalogs',
       nomenclatures: 'nomenclatures',
       operationsGroups: 'operations-groups',
       // used only for managment
@@ -461,19 +459,6 @@ const productionEnvironment: Environment = {
       maxValuesPerFacet: 1000,
       maxFacetHits: 100,
     },
-    materialsProvider: {
-      searchableAttributes: ['name', 'status', 'identifier'],
-      attributesForFaceting: [
-        'searchable(scope)',
-        'searchable(status)',
-        'searchable(identifier)',
-        'searchable(addMaterials)',
-        'searchable(editable)',
-      ],
-      ranking: ['desc(status)', 'desc(updatedAt)'],
-      maxValuesPerFacet: 1000,
-      maxFacetHits: 100,
-    },
     systemMaterials: {
       searchableAttributes: ['name', 'unitPrice'],
       attributesForFaceting: [
@@ -529,17 +514,6 @@ const productionEnvironment: Environment = {
       maxValuesPerFacet: 1000,
       maxFacetHits: 100,
     },
-    devisTemplates: {
-      searchableAttributes: ['name'],
-      attributesForFaceting: [
-        'searchable(scope)',
-        'materialsProvider',
-        'searchable(category)',
-      ],
-      ranking: ['desc(updatedAt)'],
-      maxValuesPerFacet: 1000,
-      maxFacetHits: 100,
-    },
     estimations: {
       searchableAttributes: [
         'name',
@@ -565,18 +539,6 @@ const productionEnvironment: Environment = {
       maxValuesPerFacet: 1000,
       maxFacetHits: 100,
     },
-    categories: {
-      searchableAttributes: ['name'],
-      attributesForFaceting: [
-        'searchable(entity)',
-        'searchable(parent)',
-        'searchable(scope)',
-        'searchable(provider)',
-      ],
-      ranking: ['asc(name)'],
-      maxValuesPerFacet: 1000,
-      maxFacetHits: 100,
-    },
     systemCategories: {
       searchableAttributes: ['name'],
       attributesForFaceting: [
@@ -588,13 +550,6 @@ const productionEnvironment: Environment = {
       maxValuesPerFacet: 1000,
       maxFacetHits: 100,
     },
-    operationsCatalogs: {
-      searchableAttributes: ['name'],
-      attributesForFaceting: ['searchable(scope)', 'searchable(status)'],
-      ranking: ['asc(name)'],
-      maxValuesPerFacet: 1000,
-      maxFacetHits: 100,
-    },
     nomenclatures: {
       searchableAttributes: ['value'],
       attributesForFaceting: [

package/src/environment/types.ts

@@ -32,27 +32,26 @@ export interface Environment {
    */
   schema: {
     indexes: {
-      clients: string;
-      pros: string;
+      // users - 5
+      admins: string;
       agents: string;
+      pros: string;
       sellers: string;
+      clients: string;
+      // projects - 4
       projects: string;
       medias: string;
       events: string;
       devis: string;
-      admins: string;
+      // configuration - 7
       providers: string;
       materials: string;
       operations: string;
       operationsMaterials: string;
-      materialsProvider: string;
-      devisTemplates: string;
       estimations: string;
-      categories: string;
-      operationsCatalogs: string;
       nomenclatures: string;
       operationsGroups: string;
-      // used only for management
+      // used only for management - 7
       systemMaterials: string;
       systemOperations: string;
       systemOperationsMaterials: string;

package/src/index.ts

@@ -4,7 +4,10 @@ import { Environment, Environments, getEnv } from './environment';
 import helpers, { Helpers, FactoryCreate } from './helpers';
 import { uid } from './helpers/uid';
 import path, { reversePathName } from './path';
-import getPlatformConfiguration, { SubscriptionSettings, Product } from './plans';
+import getPlatformConfiguration, {
+  SubscriptionSettings,
+  Product,
+} from './plans';
 import {
   ProductReference,
   DeploymentEnvironment,
@@ -13,6 +16,7 @@ import {
 import * as articho from './types';
 import { flatten } from './utils/flatten';
 import { AppEvent, EventMetadata, createEvent } from './events';
+import * as WhatsApp from './whatsapp';
 
 export {
   DeploymentEnvironment,
@@ -43,4 +47,6 @@ export {
   flatten,
   Policy,
   acls,
+  //whatsapp
+  WhatsApp,
 };

package/src/types.ts

@@ -437,6 +437,7 @@ export interface Enterprise extends Resource {
     quoteBasicCreation?: boolean;
     quoteAdvancedWithNewDesign?: boolean;
     exportLogs?: boolean;
+    whatsapp?: boolean;
   };
 
   /**

package/src/whatsapp/index.ts

@@ -0,0 +1,4 @@
+import * as Requests from './requests';
+import type * as Responses from './responses';
+
+export { Requests, Responses };

package/src/whatsapp/requests.ts

@@ -0,0 +1,113 @@
+type NotifyQuoteStatusApprovedMessage = {
+  name: 'notify_quote_status_approved';
+  variables: {
+    header?: string[];
+    // 1. quoteTitle; 2. project address;
+    body: string[];
+    buttons?: ButtonArgs[];
+  };
+};
+
+type SendQuotePro = {
+  name: 'send_quote_pro';
+  variables: {
+    header?: string[];
+    // 1. quote name; 2. project address;
+    body: string[];
+    buttons?: ButtonArgs[];
+  };
+};
+
+type SendMediaRequest = {
+  name: 'send_media_request';
+  variables: {
+    header?: string[];
+    // 1. sender name; 2. project name; 3. project address;
+    body: string[];
+    buttons: ButtonArgs[];
+  };
+};
+
+type SendPlanRequest = {
+  name: 'send_plan_request';
+  variables: {
+    header?: string[];
+    // 1. sender name; 2. project name; 3. project address;
+    body: string[];
+    buttons: ButtonArgs[];
+  };
+};
+
+type QuoteReady = {
+  name: 'quote_ready';
+  variables: {
+    header?: string[];
+    // 1. sender name; 2. quote name; 3. project address
+    body: string[];
+    buttons: ButtonArgs[];
+  };
+};
+
+type WelcomeClient = {
+  name: 'welcome_client';
+  variables: {
+    header?: string[];
+    body?: string[];
+    buttons?: ButtonArgs[];
+  };
+};
+
+type ButtonArgs = {
+  type: 'button';
+  sub_type: 'quick_reply' | 'url';
+  index?: number;
+  parameters: { type: 'payload' | 'text'; value: string }[];
+};
+
+export type WhatsAppTemplate =
+  | NotifyQuoteStatusApprovedMessage
+  | SendQuotePro
+  | SendMediaRequest
+  | SendPlanRequest
+  | WelcomeClient
+  | QuoteReady;
+
+type TemplatePayloadArgs = {
+  type: 'template';
+  recipientPhone: string;
+  template: WhatsAppTemplate;
+};
+
+export type WhatsAppRequestPayloadType =
+  | 'audio'
+  | 'document'
+  | 'image'
+  | 'sticker'
+  | 'video'
+  | 'template'
+  | 'text';
+
+type CommonMultimediaPayload<T extends WhatsAppRequestPayloadType> = {
+  [key in T]: {
+    link: string;
+    filename: string;
+  };
+};
+
+type TextPayloadArgs = {
+  type: 'text';
+  recipientPhone: string;
+  message: string;
+};
+
+type MultimediaPayloadArgs<T extends WhatsAppRequestPayloadType> = {
+  type: T;
+  recipientPhone: string;
+} & CommonMultimediaPayload<T>;
+
+export type WABuildPayloadType<Type extends WhatsAppRequestPayloadType> =
+  Type extends 'text'
+    ? TextPayloadArgs
+    : Type extends 'template'
+    ? TemplatePayloadArgs
+    : MultimediaPayloadArgs<Type>;

package/src/whatsapp/responses.ts

@@ -0,0 +1,198 @@
+export type WhatsAppNotificationPayload = {
+  object: 'whatsapp_business_account';
+  entry: [
+    {
+      id: string;
+      changes: WhatAppNotificationValue[];
+    }
+  ];
+};
+
+export type WhatAppNotificationValue = {
+  value: {
+    contacts: WhatsAppContact[];
+    errors?: WhatsAppResponseError[];
+    messaging_product: 'whatsapp';
+    metadata: WhatsAppMetadata;
+    messages?: WhatsAppMessage[];
+    statuses?: WhatsAppStatus[];
+  };
+  field: 'messages';
+};
+
+type WhatsAppContact = {
+  wa_id: string;
+  profile: {
+    name: string;
+  };
+};
+
+type WhatsAppResponseError = {
+  code: number;
+  title: string;
+  message: string;
+  error_data: {
+    details: string;
+  };
+};
+
+type WhatsAppMetadata = {
+  display_phone_number: string;
+  phone_number_id: string;
+};
+
+export type WhatsAppMessage = {
+  audio?: {
+    id: string;
+    mime_type: string;
+  };
+  button?: {
+    payload: string;
+    text: string;
+  };
+  context?: {
+    forwarded: boolean;
+    frequently_forwarded: boolean;
+    from: string;
+    id: string;
+    referred_product: {
+      catalog_id: string;
+      product_retailer_id: string;
+    };
+  };
+  document?: {
+    caption?: string;
+    filename: string;
+    sha256: string;
+    mime_type: string;
+    id: string;
+  };
+  errors: {
+    code: number;
+    title: string;
+    message: string;
+    error_data: {
+      details: string;
+    };
+  };
+  from: string;
+  id: string;
+  image?: {
+    caption?: string;
+    sha256: string;
+    id: string;
+    mime_type: string;
+  };
+  interactive?: {
+    type: string;
+    button_reply: {
+      id: string;
+      title: string;
+    };
+    list_reply: {
+      id: string;
+      title: string;
+      description: string;
+    };
+  };
+  order?: {
+    catalog_id: string;
+    text: string;
+    product_items: {
+      product_retailer_id: string;
+      quantity: string;
+      item_price: string;
+      currency: string;
+    }[];
+  };
+  referral?: {
+    source_url: string;
+    source_type: 'ad' | 'post';
+    source_id: string;
+    headline: string;
+    body: string;
+    media_type: 'image' | 'video';
+    image_url?: string;
+    video_url?: string;
+    thumbnail_url?: string;
+    ctwa_clid: string;
+  };
+  sticker?: {
+    mime_type: string;
+    sha256: string;
+    id: string;
+    animated: boolean;
+  };
+  system?: {
+    body: string;
+    identity: string;
+    new_wa_id: string;
+    wa_id: string;
+    type: 'customer_changed_number' | 'customer_identity_changed';
+    customer: string;
+  };
+  text?: {
+    body: string;
+  };
+  timestamp: string;
+  type: WhatsAppMessageType;
+  video?: {
+    caption: string;
+    filename: string;
+    sha256: string;
+    id: string;
+    mime_type: string;
+  };
+};
+
+type WhatsAppStatus = {
+  biz_opaque_callback_data: string;
+  conversation: {
+    id: string;
+    origin: {
+      type:
+        | 'authentication'
+        | 'marketing'
+        | 'utility'
+        | 'service'
+        | 'referral_conversion';
+    };
+    expiration_timestamp?: string;
+  };
+  errors: {
+    code: number;
+    title: string;
+    message: string;
+    error_data: {
+      details: string;
+    };
+  }[];
+  id: string;
+  pricing: {
+    category:
+      | 'authentication'
+      | 'marketing'
+      | 'utility'
+      | 'service'
+      | 'referral_conversion';
+    pricing_model: 'CBP';
+  };
+  recipient_id: string;
+  status: 'delivered' | 'read' | 'sent';
+  timestamp: string;
+};
+
+export enum WhatsAppMessageType {
+  audio = 'audio',
+  button = 'button',
+  document = 'document',
+  text = 'text',
+  image = 'image',
+  interactive = 'interactive',
+  order = 'order',
+  sticker = 'sticker',
+  system = 'system',
+  unknown = 'unknown',
+  video = 'video',
+  location = 'location',
+}