merge main

Author: ziyuhehe

.github/pull_request_template.md

@@ -13,7 +13,8 @@
 <!-- Please mark the relevant options with 'X' like [X] -->
 
 - [ ] My changes rendered as expected by running `yarn start`.
-- [ ] My changes followed the [style guide](https://github.com/MicroStrategy/embedding-sdk-docs/blob/public/contributing/content-style-guide.md).
+- [ ] My changes followed the
+      [style guide](https://github.com/MicroStrategy/embedding-sdk-docs/blob/public/contributing/content-style-guide.md).
 - [ ] I have self-reviewed this PR.
 - [ ] I have performed a syntax validation check to avoid syntax errors.
 

.github/workflows/gh-pages.yml

@@ -41,4 +41,4 @@ jobs:
           # The GH actions bot is used by default if you didn't specify the two fields.
           # You can swap them out with your own user credentials.
           # user_name:
-          # user_email:
+          # user_email:

.github/workflows/linters.yml

@@ -2,7 +2,7 @@ name: Linters Check
 
 on:
   pull_request:
-    branches: [ "public" ]
+    branches: ["public"]
 
 jobs:
   linting:
@@ -30,4 +30,4 @@ jobs:
       - name: Markdownlint Check
         uses: borales/[email protected]
         with:
-          cmd: lint:markdownlint # will run `yarn lint:eslint` command
+          cmd: lint:markdownlint # will run `yarn lint:eslint` command

.github/workflows/test-deployment.yml

@@ -21,4 +21,4 @@ jobs:
       - name: Install dependencies
         run: yarn install --frozen-lockfile
       - name: Test build website
-        run: yarn build:public
+        run: yarn build:public

docs/add-functionality/add-event.md

@@ -31,8 +31,7 @@ specific events.
 
 ## Events
 
-Each supported event is described in the table below. You get the EventType from
-`microstrategy.dossier.EventType`.
+Each supported event is described in the table below. You get the EventType from `microstrategy.dossier.EventType` or `microstrategy.embeddingContexts.EventType`.
 
 ### onGraphicsSelected
 
@@ -409,7 +408,8 @@ embedDossier.registerEventHandler(EventType.ON_LIBRARY_ITEM_SELECTED, libraryIte
     "projectId": "B19DEDCC11D4E0EFC000EB9495D0F44F",
     "name": "Distribution Center & Brands",
     "type": 55,
-    "subtype": null
+    "subtype": null,
+    "isDocument": false
   }
 ]
 ```
@@ -588,6 +588,40 @@ embedDossier.registerEventHandler(EventType.ON_DOSSIER_INSTANCE_CHANGED, (conten
 }
 ```
 
+### onInstanceChanged
+
+#### Event enumeration
+
+`EventType.ON_INSTANCE_CHANGED`
+
+#### Description
+
+Raised when the a new object instance is created or destroyed. The object type could be a dashboard, document, report or bot.
+
+#### Content
+
+The event callback parameters contain the project id, object id, object type, object name, and the instance id.
+
+#### Code example
+
+```js
+embedDossier.registerEventHandler(EventType.ON_INSTANCE_CHANGED, (content) => {
+  // Use the content here
+});
+```
+
+#### Content example
+
+```json
+{
+  "projectId": "B19DEDCC11D4E0EFC000EB9495D0F44F",
+  "objectId": "D9AB379D11EC92C1D9DC0080EFD415BB",
+  "objectName": "Dashboard Prompted on Category",
+  "objectType": "dossier",
+  "instanceId": "EC003BC7A046E75DE83373A254824F20"
+}
+```
+
 ### onComponentSelectionChanged
 
 #### Event enumeration
@@ -616,6 +650,8 @@ embedDossier.registerEventHandler(EventType.ON_COMPONENT_SELECTION_CHANGED, (con
 {
   "projectId": "B19DEDCC11D4E0EFC000EB9495D0F44F",
   "dossierId": "EC5441154009D3C39D5BD6AD75865EF4",
+  "objectId": "EC5441154009D3C39D5BD6AD75865EF4",
+  "objectType": "dossier",
   "selectedComponents": [
     {
       "key": "K52",

docs/embed-document-consumption-page/embed-document-consumption-page.md

@@ -0,0 +1,39 @@
+---
+title: Embed Strategy document consumption page
+description: The Embedding SDK allows you to quickly integrate a Strategy document consumption page into a web application in a responsive manner. It also provides resources to add functionalities such as selecting components.
+---
+
+The Embedding SDK allows you to quickly integrate a Strategy document consumption page into a web application in a responsive manner. It also provides resources to add functionalities such as selecting components.
+
+There are three basic steps for embedding a Strategy document consumption page.
+
+1. In the initial page of your web application, add a link to the Strategy JavaScript Embedding SDK.
+
+   ```html
+   <script src="{YOUR_LIBRARY_SERVER_URL}/javascript/embeddinglib.js"></script>
+   ```
+
+   Replace `{YOUR_LIBRARY_SERVER_URL}` with your actual Strategy Library Server URL, e.g., [https://demo.microstrategy.com/MicroStrategyLibrary](https://demo.microstrategy.com/MicroStrategyLibrary).
+
+1. Create a `<div>` as the placeholder where you want to embed the dashboard consumption page.
+
+   ```html
+   <div id="container"></div>
+   ```
+
+1. Call the `microstrategy.embeddingContexts.embedDocumentConsumptionPage(props)` method to embed the dashboard consumption page in the container.
+
+   ```js
+   microstrategy.embeddingContexts.embedDocumentConsumptionPage({
+     serverUrl: "{YOUR_LIBRARY_SERVER_URL}",
+     projectId: "{YOUR_PROJECT_ID}",
+     objectId: "{YOUR_OBJECT_ID}",
+     placeholder: document.getElementById("container"),
+   });
+   ```
+
+To help you get started, we have provided a number of simple applications with sample code and explanations.
+
+- [Properties for an embedded Strategy document consumption page](./embed-document-consumption-properties.md)
+
+  Describes the properties that can be set for an embedded Strategy document consumption page.