@ada-support/embed2 1.0.35 → 1.0.41

package/README.md

@@ -1,165 +1,28 @@
 # Embed 2
 
-Embed 2 helps clients to setup Ada Web Chat in their web application. These docs are for internal-use only; for client-facing docs check out our [docs repo](https://adasupport.github.io/documentation/#embed2).
-
-## Setup
-
-These instructions will get Embed 2 up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
-
-### 1. Start Embed 2
-Run this command:
-```
-yarn && yarn start
-```
-This will install dependencies and start the webpack dev server.
-
-### 2. Open the example page
-🎉 Head over to http://test.localhost:9001/example/. You should now be good to go! 🎉 
-
-Instead of `test`, you can also use a different handle to use a different local bot instead.
-
-If you are new to Embed 2, the next step will be to familiarize yourself with its architecture. You can find `README.md`s in each of the major directories that will explain how it works.
-
-You can also test different configuration options in `example/index.html`.
-
-Finally, it is highly recommend that you install the following plugins (or equivalent) into your text editor / IDE:
-- [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint)
-- [Better Comments](https://marketplace.visualstudio.com/items?itemName=aaron-bond.better-comments)
-
-## Tooling
-
-### Linting and Type Checking
-
-You can check for ESLint violations and type errors by running:
-
-```
-yarn lint
-```
-
-This will also run automatically during CI.
-
-### Sentry
-
-If you want to run Sentry locally, you will need to set the value for the Sentry DSN in your .env file. Create and open your .env file:
-
-```
-cp .env.example .env
-vim .env
-```
-
-Find the Sentry DSN for the Embed 2 project at https://docs.sentry.io/error-reporting/configuration/?platform=browser and selecting "Embed" from the dropdown menu above the code snippet. Copy this value (it should be a string that looks like a URL) to the .env file.
-
-### Checking Bundle Size
-
-Embed 2 is the entry to Ada's web chat, and is downloaded more than any other Ada script. As such, maintaining a small bundle size is extremely important. We do this by leveraging the browser cache, and using lightweight modules. Additionally, separate `modern` and `legacy` bundles are generated, so the majority of users who use new browser versions do not need to fetch superfluous polyfills.
-
-Bundle size should be checked periodically. You can check the bundle size by running:
-
-```
-yarn bundle-report:modern
-```
-
-and
-
-```
-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.
-
-## Testing
-
-### Unit testing
-
-Unit testing is done with Karma and Jasmine. Tests can be run on a local Chrome browser with:
-
-```
-yarn test
-```
-
-### End-to-end testing
-
-#### TestCafe
-
-TestCafe can run E2E tests on real browsers via LambdaTest. These tests will run automatically during the CI pipeline, but can also be run locally.
-
-To run locally, you will first need to add `LT_USERNAME` and `LT_ACCESS_KEY` to your `.env` file. You can find your username and access key in the LambdaTest dashboard. If you have not used LambdaTest before, follow this setup guide [here](https://www.notion.so/adasupport/Cross-Browser-Testing-e141ba6682c0476ca96d329b53fc0bb2).
-
-
-Once you have added valid keys, you can now run TestCafe with:
+Embed 2 allows clients to setup Ada Web Chat in their web application. For further information on how to use Embed, check out our [docs repo](https://adasupport.github.io/documentation/#embed2).
 
+## 1. Installation
+NPM:
 ```
-yarn ci-testcafe
+npm install @ada-support/embed2
 ```
-
-Note that this is the same command that runs during CI, and will make requests against the production API. If you would like to run against your local API, you can run:
-
+Yarn:
 ```
-yarn tc
+yarn add @ada-support/embed2
 ```
+This will install the Embed 2 package and it's dependencies.
 
-#### Cypress
-
-Cypress E2E tests can be run using:
 
+## 2. Usage
+First, import Embed 2 into your App: 
 ```
-yarn ci-cypress
+import adaEmbed from "@ada-support/embed2";
 ```
-
-## Deployment
-
-### Steps to Deploy
-
-Follow instructions listed on [this notion page](https://www.notion.so/adasupport/Deploying-Embed-2-71e2775038cd47c78732bf04bf1d0525)
-
-### 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:
-
+Second, place the code below to start Embed 2 when the DOM is ready:
 ```
-# Verisoned
-
-https://static.ada.support/embed-beta/legacy/entry/<FIRST 7 CHAR OF COMMIT HASH>/embed2.beta.js
+adaEmbed.start({
+  handle: "bot-handle",
+});
 ```
-
-And:
-
-```
-# Verisonless
-
-https://static.ada.support/embed2.beta.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).
-
-Deploying production will create the following scripts:
-
-```
-# Verisoned
-
-https://static.ada.support/embed/legacy/entry/<FIRST 7 CHAR OF COMMIT HASH>/embed2.js
-```
-
-And:
-
-```
-# Verisonless
-
-https://static.ada.support/embed2.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.
-
-## Versioning
-We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [releases on this repository](https://github.com/AdaSupport/embed-frames/releases).
-
-## Architecture
-![Frontend Architecture@2x(1)](https://user-images.githubusercontent.com/9045634/97473287-32b0e100-1921-11eb-98c6-d3059d6f24a8.png)
-
-Loom explanation: <https://www.loom.com/share/22f7b0060b3f46c8b3781afb1aae4b89>
-
-
-## Gotchas
-There are artifical timeouts in the application that may cause you not to see any errors with what you are working on. The longest timeout is 60000ms (60s). Please ensure you shorten this locally when you are testing your work. You can adjust this here: `src/common/constants/events.ts`
+In the example above the `handle` key is a part of `AdaSettings`. To learn more about other settings, consult the [API reference](https://adasupport.github.io/documentation/#api-reference).

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/lib/fc/index.d.ts

@@ -20,5 +20,5 @@ export default class FC extends Channel {
     private static isMessageEvent;
     postMessage<T extends EmbedEvent>(eventName: T, data?: PayloadByEvent[T], id?: string, status?: FetchEventStatusType): void;
     addEventListener(handler: (type: string, payload?: object, id?: string, status?: FetchEventStatusType) => void): Refhandler;
-    constructObjectToSend(type?: string, payload?: unknown, id?: string, status?: FetchEventStatusType): string;
+    constructObjectToSend(eventName?: string, payload?: unknown, id?: string, status?: FetchEventStatusType): string;
 }