@ada-support/embed2 1.0.33 → 1.0.39

package/README.md

@@ -67,6 +67,18 @@ yarn bundle-report:legacy
 
 You will notice that many tabs are opened when running this command. Because Embed 2 is split between many sub-applications (representing framed components), a bundle analyzer is run for each application. The total bundle size is equal to sum of bundle sizes, plus external dependencies.
 
+## Connecting to an external bot
+In certain scenarios it can be useful to run Embed 2 locally, but connect to a bot that exists on one of our external environments (`production`, `staging`, `dev`, `dev2`). To achieve this follow the steps below.
+1. open example/index.html and modify the `domain` parameter in the settings dictionary to match the environment the external bot exists on, should be one of `ada-dev`, `ada-dev2`, `ada-stage`, `ada` for dev, dev2, stage, or production respectively.
+2. open src/common/helpers/url/index.ts and modify the `getURL` function to return early after constructing the `prodURL`
+```javascript
+export function getURL({
+    ...
+    const prodUrl = `https://${handle}${clusterString}.${domainString}.support/${name}/${routeString}${questionSym}${queryString}`;
+    return prodURL
+})
+```
+After starting Embed 2, access the example page by entering `http://<bot-handle>.localhost:9000` and replace <bot-handle> with the bot handle as it exists on the external environment.
 ## Testing
 
 ### Unit testing
@@ -110,44 +122,31 @@ yarn ci-cypress
 
 ### Steps to Deploy
 
-Follow instructions listed on [this notion page](https://www.notion.so/adasupport/Deploying-Embed-2-71e2775038cd47c78732bf04bf1d0525)
+Follow instructions listed on [this notion page](https://www.notion.so/adasupport/Embed-2-deployment-runbook-fb81e8a28cb14ef1a607059914fb875a)
 
-### Beta
-Deployment of the beta script is handled automatically by CircleCI when merging a branch into `master`. Once merged, two different scripts will be added to the Ada CDN:
+Deployment of the static script is handled automatically by CircleCI when merging a branch into `master`. Once merged, two script will be added to the Ada CDN:
 
 ```
-# Verisoned
-
-https://static.ada.support/embed-beta/legacy/entry/<FIRST 7 CHAR OF COMMIT HASH>/embed2.beta.js
+https://static.ada.support/embed2.<VERSION>.js
 ```
 
-And:
-
+#### Example
 ```
-# Verisonless
-
-https://static.ada.support/embed2.beta.js
+https://static.ada.support/embed2.1.0.35.js
 ```
 
-Before deploying to production, you should manually smoke test to make sure the beta script is working [here](https://jsfiddle.net/gn3ukc4r/show/).
-
-### Production
-Once a beta script has been created, a production deployment will be "held" until approved by an Embed 2 admin. To approve the deploy, open the CircleCI job in question, and click on "Approve Job". You can read more about manual approval [here](https://circleci.com/docs/2.0/workflows/#holding-a-workflow-for-a-manual-approval).
+Once static script is created, production deployment will be "held" until approved by an Embed 2 admin. To approve the deploy, open the CircleCI job in question, and click on "Approve Job". You can read more about manual approval [here](https://circleci.com/docs/2.0/workflows/#holding-a-workflow-for-a-manual-approval).
 
-Deploying production will create the following scripts:
+Deploying production will create the versionless script
 
 ```
-# Verisoned
-
-https://static.ada.support/embed/legacy/entry/<FIRST 7 CHAR OF COMMIT HASH>/embed2.js
+https://static.ada.support/embed2.js
 ```
 
-And:
+Deploying to other cluster will create a script in following format.
 
 ```
-# Verisonless
-
-https://static.ada.support/embed2.js
+https://static.ada.support/embed2.<CLUSTER>.js
 ```
 
 If you require access to the [Embed Procuction Deploys](https://github.com/orgs/AdaSupport/teams/embed-production-deploys) team (needed for production deployment), please reach out to an Engineering admin.

package/dist/npm-entry/campaigns/campaign.d.ts

@@ -12,5 +12,5 @@ interface TriggerCampaignImplParams {
     messageService: MessageService;
 }
 export declare function triggerCampaignImpl({ adaSettings, chatterToken, campaign, ignoreStatus, ignoreFrequency, clearCampaignToTrigger, messageService, }: TriggerCampaignImplParams): void;
-export declare const getCampaignToTrigger: (adaSettings: StartOptions, chatterToken: string, marketingCampaigns: MarketingCampaign[], options: EvaluateCampaignParams) => MarketingCampaign;
+export declare const getCampaignToTrigger: (adaSettings: StartOptions, marketingCampaigns: MarketingCampaign[] | undefined, options: EvaluateCampaignParams, onlyBasic: boolean) => MarketingCampaign;
 export {};

package/dist/npm-entry/client/index.d.ts

@@ -20,6 +20,7 @@ export declare class Embed {
     unmountCallback: () => void;
     initializationReject: (error: Error) => void;
     initializationResolve: () => void;
+    private debounceCampaignTrigger;
     static embed2Version: string;
     constructor(adaSettings: StartOptions, unmountCallback: () => void);
     renderPreactApp(): void;

package/dist/npm-entry/common/constants/storage-keys.d.ts

@@ -3,5 +3,6 @@ export declare const CHATTER_CREATED_STORAGE_KEY = "ada-embed_chatter-created";
 export declare const IN_LIVE_CHAT_STORAGE_KEY = "inLiveChat";
 export declare const ZD_SESSION_STORAGE_KEY = "ada-embed_zd-session-id";
 export declare const ZD_PREVIOUS_TAGS_STORAGE_KEY = "ada-embed_zd-previous-tags";
+export declare const IS_DRAWER_OPEN_STORAGE_KEY = "ada-embed_is-drawer-open";
 /** @deprecated - Use CHATTER_TOKEN_STORAGE_KEY */
 export declare const CHATTER_STORAGE_KEY = "chatter";