@albanian-xrm/cif-types 0.1.0 → 0.1.2

package/README.md

@@ -1,6 +1,6 @@
 # @albanian-xrm/cif-types
 Microsoft.CIFramework types from the community (us).
 
-Read more about Channel Integration Framework on the Microsoft Docs [here](https://learn.microsoft.com/en-us/dynamics365/customer-service/channel-integration-framework).
+Read more about Channel Integration Framework on the Microsoft Docs [here](https://learn.microsoft.com/en-us/dynamics365/customer-service/channel-integration-framework/channel-integration-framework).
 
 These types are based on the api documentation on the Microsoft Docs [here](https://learn.microsoft.com/en-us/dynamics365/customer-service/channel-integration-framework/reference/microsoft-ciframework).

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@albanian-xrm/cif-types",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "description": "Microsoft.CIFramework types from the community (us).",
   "repository": {
     "type": "git",
@@ -18,4 +18,4 @@
     "url": "https://github.com/albanian-xrm/cif-types/issues"
   },
   "homepage": "https://github.com/albanian-xrm/cif-types#readme"
-}
+}

package/v1.0/CRUD.d.ts

@@ -111,32 +111,32 @@ declare namespace Microsoft {
       id: string,
       data: string
     ): Promise<string>;
-  }
 
-  /**
-   * Deletes an entity record.
-   * @param entityLogicalName The entity logical name of the record you want to delete. For example: "account".
-   * @param id GUID of the entity record you want to delete.
-   * @returns On success, returns a promise containing a string with the attributes and their values.
-   * @see {@link https://learn.microsoft.com/en-us/dynamics365/customer-service/channel-integration-framework/reference/microsoft-ciframework/deleterecord External Link: deleteRecord}
-   * @example
-   * // delete contact record  with the id=b44d31ac-5fd1-e811-8158-000d3af97055d
-   * var id = "b44d31ac-5fd1-e811-8158-000d3af97055";
-   * var entityLogicalName = "contact";
-   * Microsoft.CIFramework.deleteRecord(entityLogicalName, id).then(
-   *     function success(result) {
-   *       res=JSON.parse(result);
-   *       console.log("Contact deleted with ID: " + res.contactid);
-   *       // the record is deleted
-   *     },
-   *     function (error) {
-   *         console.log(error.message);
-   *         // handle error conditions
-   *     }
-   * );
-   */
-  export function deleteRecord(
-    entityLogicalName: string,
-    id: string
-  ): Promise<string>;
+    /**
+     * Deletes an entity record.
+     * @param entityLogicalName The entity logical name of the record you want to delete. For example: "account".
+     * @param id GUID of the entity record you want to delete.
+     * @returns On success, returns a promise containing a string with the attributes and their values.
+     * @see {@link https://learn.microsoft.com/en-us/dynamics365/customer-service/channel-integration-framework/reference/microsoft-ciframework/deleterecord External Link: deleteRecord}
+     * @example
+     * // delete contact record  with the id=b44d31ac-5fd1-e811-8158-000d3af97055d
+     * var id = "b44d31ac-5fd1-e811-8158-000d3af97055";
+     * var entityLogicalName = "contact";
+     * Microsoft.CIFramework.deleteRecord(entityLogicalName, id).then(
+     *     function success(result) {
+     *       res=JSON.parse(result);
+     *       console.log("Contact deleted with ID: " + res.contactid);
+     *       // the record is deleted
+     *     },
+     *     function (error) {
+     *         console.log(error.message);
+     *         // handle error conditions
+     *     }
+     * );
+     */
+    export function deleteRecord(
+      entityLogicalName: string,
+      id: string
+    ): Promise<string>;
+  }
 }

package/v1.0/Context.d.ts

@@ -0,0 +1,31 @@
+declare namespace Microsoft {
+  namespace CIFramework {
+    /**
+     * This method allows you to set automation dictionary. It enables providers to add, modify and remove values of slugs and the updated values are subsequently available for future macro invocations.
+     * @param input JSON string
+     * @param sessionId Unique identifier of the current session.
+     * @param isDelete Set isDelete to `true` if the list of parameters in input JSON are to be deleted. If isDelete is set to `true`, the slug values will be deleted and will no longer be available for subsequent macro invocations.
+     * @param correlationId Used to group all related API calls together for diagnostic telemetry
+     * @returns Returns a promise with string value.
+     * @see {@link https://learn.microsoft.com/en-us/dynamics365/customer-service/channel-integration-framework/reference/microsoft-ciframework/updatecontext External Link: updateContext}
+     * @example
+     * var input = { "customerName" : "Contosso" };
+     * Microsoft.CIFramework.updateContext(input).then(
+     *     function success(result) {
+     *         console.log(result);
+     *         // Perform operations upon record retrieval and opening
+     *     },
+     *     function (error) {
+     *         console.log(error.message);
+     *         // Handle error conditions
+     *     }
+     * );
+     */
+    export function updateContext(
+      input: string,
+      sessionId?: string,
+      isDelete?: boolean,
+      correlationId?: string
+    ): Promise<string>;
+  }
+}

package/v1.0/Events.d.ts

@@ -0,0 +1,219 @@
+declare namespace Microsoft {
+  namespace CIFramework {
+    /**
+     * Adds the subscriber to the events.
+     * @remark This API can be used on both the widget and Unified Interface page.
+     * @param eventName Name of the event for which the handler is set. The supported events are as follows:
+     *   * onClickToAct - The event is invoked when the outbound communication (ClickToAct) field is enabled.
+     *   * onModeChanged - The event is invoked when the panel mode is manually toggled between Minimized (0) and Docked (1).
+     *   * onSizeChanged - The event is invoked when the panel size is manually changed by dragging.
+     *   * onPageNavigate - The event is triggered before a navigation event occurs on the main page.
+     *   * onSendKBArticle - The event is invoked when the user selects the Send button on the KB control.
+     *
+     *   You can also pass custom events in the `eventName` parameter.
+     * @param handlerFunction The handler function is invoked when any of the supported events are triggered.
+     * @returns Promise with a value as Boolean.
+     * @see {@link https://learn.microsoft.com/en-us/dynamics365/customer-service/channel-integration-framework/reference/microsoft-ciframework/raiseevent External Link: raiseEvent}
+     * @example
+     * handlerFunction = function(eventData) {
+     * console.log(eventData)
+     * return Promise.resolve();
+     * }
+     *
+     * Microsoft.CIFramework.addHandler("onmodechanged", handlerFunction);
+     */
+    export function addHandler(
+      eventName: string,
+      handlerFunction: (...args) => Promise<void>
+    ): Promise<boolean>;
+
+    /**
+     * Adds the subscriber to the events. The event is invoked when the panel mode is manually toggled between Minimized (0) and Docked (1).
+     * @remark This API can be used on both the widget and Unified Interface page.
+     * @param eventName Name of the event for which the handler is set. The event is invoked when the outbound communication (ClickToAct) field is enabled.
+     * @param handlerFunction The handler function is invoked when any of the supported events are triggered.
+     * @returns Promise with a value as Boolean.
+     * @see {@link https://learn.microsoft.com/en-us/dynamics365/customer-service/channel-integration-framework/reference/microsoft-ciframework/raiseevent External Link: raiseEvent}
+     */
+    export function addHandler(
+      eventName: "onclicktoact",
+      handlerFunction: (eventData: EventArgs.ClickToAct) => Promise<void>
+    ): Promise<boolean>;
+
+    /**
+     * Adds the subscriber to the events. The event is invoked when the panel mode is manually toggled between Minimized (0) and Docked (1).
+     * @remark This API can be used on both the widget and Unified Interface page.
+     * @param eventName Name of the event for which the handler is set. The 'OnModeChanged' event is invoked when the panel mode is manually toggled between Minimized (0) and Docked (1).
+     * @param handlerFunction The handler function is invoked when any of the supported events are triggered.
+     * @returns Promise with a value as Boolean.
+     * @see {@link https://learn.microsoft.com/en-us/dynamics365/customer-service/channel-integration-framework/reference/microsoft-ciframework/raiseevent External Link: raiseEvent}
+     * @example
+     * handlerFunction = function(eventData) {
+     * console.log(eventData)
+     * return Promise.resolve();
+     * }
+     *
+     * Microsoft.CIFramework.addHandler("onmodechanged", handlerFunction);
+     */
+    export function addHandler(
+      eventName: "onmodechanged",
+      handlerFunction: (eventData: EventArgs.ModeChanged) => Promise<void>
+    ): Promise<boolean>;
+
+    /**
+     * Adds the subscriber to the events. The event is triggered before a navigation event occurs on the main page.
+     * @remark This API can be used on both the widget and Unified Interface page.
+     * @param eventName Name of the event for which the handler is set.
+     * @param handlerFunction The handler function is invoked when any of the supported events are triggered.
+     * @returns Promise with a value as Boolean.
+     * @see {@link https://learn.microsoft.com/en-us/dynamics365/customer-service/channel-integration-framework/reference/microsoft-ciframework/raiseevent External Link: raiseEvent}
+     */
+    export function addHandler(
+      eventName: "onpagenavigate",
+      handlerFunction: (eventData: EventArgs.PageNavigate) => Promise<void>
+    ): Promise<boolean>;
+
+    /**
+     * Adds the subscriber to the events. The event is invoked when the user selects the Send button on the KB control.
+     * @remark This API can be used on both the widget and Unified Interface page.
+     * @param eventName Name of the event for which the handler is set.
+     * @param handlerFunction The handler function is invoked when any of the supported events are triggered.
+     * @returns Promise with a value as Boolean.
+     * @see {@link https://learn.microsoft.com/en-us/dynamics365/customer-service/channel-integration-framework/reference/microsoft-ciframework/raiseevent External Link: raiseEvent}
+     */
+    export function addHandler(
+      eventName: "onsendkbarticle",
+      handlerFunction: (eventData: EventArgs.SendKBArticle) => Promise<void>
+    ): Promise<boolean>;
+
+    /**
+     * Adds the subscriber to the events. The event is invoked when the panel size is manually changed by dragging.
+     * @remark This API can be used on both the widget and Unified Interface page.
+     * @param eventName Name of the event for which the handler is set.
+     * @param handlerFunction The handler function is invoked when any of the supported events are triggered.
+     * @returns Promise with a value as Boolean.
+     * @see {@link https://learn.microsoft.com/en-us/dynamics365/customer-service/channel-integration-framework/reference/microsoft-ciframework/raiseevent External Link: raiseEvent}
+     */
+    export function addHandler(
+      eventName: "onsizechanged",
+      handlerFunction: (eventData: EventArgs.SizeChanged) => Promise<void>
+    ): Promise<boolean>;
+
+    /**
+     * Invokes the associated subscriber for the event.
+     * @param eventName Name of the event whose handler needs to be invoked.
+     * @param eventInputParameters The input parameters that need to be passed to the handler function.
+     * @param correlationId Is used to group all related API calls together for diagnostic telemetry.
+     * @remark If you've created custom events using the {@link addHandler} method, then you can raise those events by passing the event name as parameter in this method.
+     * @returns Promise with a value as Boolean.
+     * @see {@link https://learn.microsoft.com/en-us/dynamics365/customer-service/channel-integration-framework/reference/microsoft-ciframework/raiseevent External Link: raiseEvent}
+     * @example
+     * // Let there be an event registered to a subscriber.
+     * handlerFunction = function(eventInput)
+     * {
+     *     console.log(eventInput);
+     *     if(eventInput != null &&  eventInput != undefined && eventInput.size > 0)
+     *     {
+     *         inputData = eventInput.get("value");
+     *         correlationId = eventInput.get("correlationId");
+     *         console.log(inputData + " " + correlationId);
+     *     }
+     *     return Promise.resolve();
+     * }
+     * Microsoft.CIFramework.addHandler("oncustomevent", handlerFunction);
+     * //Use raiseEvent API to invoke the subscribed handler of the event.
+     * Microsoft.CIFramework.raiseEvent("oncustomevent", "test input value");
+     *
+     * //In the main UCI page
+     * Microsoft.CIFramework.addHandler("widgetEvent", handlerFunction);
+     * ///In the widget code
+     * Microsoft.CIFramework.raiseEvent("widgetEvent", eventInput);
+     *
+     * //In the widget code
+     * Microsoft.CIFramework.addHandler("mainPageEvent", handlerFunction);
+     * //In the main UCI page
+     * Microsoft.CIFramework.raiseEvent("mainPageEvent", eventInput);
+     */
+    export function raiseEvent(
+      eventName: string,
+      eventInputParameters: string,
+      correlationId?: string
+    ): Promise<boolean>;
+
+    /**
+     * Removes the subscriber from the events.
+     * @remark This API can be used on both the widget and Unified Interface page.
+     * @param eventName Name of the event for which the handler is set. The supported events are as follows:
+     *   * onClickToAct - The event is invoked when the outbound communication (ClickToAct) field is enabled.
+     *   * onModeChanged - The event is invoked when the panel mode is manually toggled between Minimized (0) and Docked (1).
+     *   * onSizeChanged - The event is invoked when the panel size is manually changed by dragging.
+     *   * onPageNavigate - The event is triggered before a navigation event occurs on the main page.
+     *   * onSendKBArticle - The event is invoked when the user selects the Send button on the KB control.
+     *
+     *   You can also pass custom events in the `eventName` parameter.
+     * @param handlerFunction The handler function that is to removed.
+     * @see {@link https://learn.microsoft.com/en-us/dynamics365/customer-service/channel-integration-framework/reference/microsoft-ciframework/raiseevent External Link: raiseEvent}
+     */
+    export function removeHandler(
+      eventName: string,
+      handlerFunction: (eventData: EventArgs.SizeChanged) => Promise<void>
+    ): void;
+
+    namespace EventArgs {
+      export interface ClickToAct {
+        value: any;
+        name: "string";
+        format: "string";
+        entityLogicalName: "string";
+      }
+
+      export interface ModeChanged {
+        value: PanelMode;
+      }
+
+      /**
+       * The onpagenavigate event is invoked when the main Unified Interface page navigation occurs. The eventData URL is the navigated Unified Interface page URL.
+       */
+      export interface PageNavigate {
+        /**
+         * url
+         */
+        value: string;
+      }
+
+      export interface SendKBArticle {
+        /**
+         * KB article title
+         */
+        title: string;
+        /**
+         * url
+         */
+        link: string;
+      }
+
+      export interface SizeChanged {
+        value: number;
+      }
+    }
+  }
+}
+
+interface Window {
+  /**
+   * The CIFInitDone event is raised by the Dynamics 365 Channel Integration Framework library when Channel Integration Framework is loaded.
+   * This event is used to determine whether the Channel Integration Framework APIs are ready to be consumed.
+   * @see {@link https://learn.microsoft.com/en-us/dynamics365/customer-service/channel-integration-framework/reference/events/cifinitdone External Link: CIFInitDone event}
+   * @example
+   * (function () {
+   *     window.addEventListener("CIFInitDone", function () {
+   *         //Code that consumes CIF library APIs.
+   *     });
+   * })();
+   */
+  addEventListener(
+    type: "CIFInitDone",
+    listener: () => void,
+    options?: boolean | AddEventListenerOptions
+  ): void;
+}

package/v1.0/index.d.ts

@@ -2,6 +2,7 @@
 /// <reference path="./CRUD.d.ts" />
 /// <reference path="./EntityMetadata.d.ts" />
 /// <reference path="./Environment.d.ts" />
+/// <reference path="./Events.d.ts" />
 /// <reference path="./PanelMode.d.ts" />
 /// <reference path="./PanelWidth.d.ts" />
 /// <reference path="./Search.d.ts" />

package/v2.0/Notification.d.ts

@@ -0,0 +1,59 @@
+declare namespace Microsoft {
+  namespace CIFramework {
+    /**
+     * Cancels the notification about incoming conversations based on the cancellation token.
+     * @param cancellationToken Unique string that was provided in the {@link notifyEvent} method to display notifications about incoming conversations.
+     * @param correlationId Used to group all related API calls together for diagnostic telemetry.
+     * @returns Returns the cancellation token.
+     * @see {@link https://learn.microsoft.com/en-us/dynamics365/customer-service/channel-integration-framework/v2/reference/microsoft-ciframework/cancelevent External Link: cancelEvent}
+     * @example
+     * // Trying to cancel a notification, use the same cancelToken passed during creation of notification in notifyEvent
+     * Microsoft.CIFramework.cancelEvent(CancelToken).then(
+     *     function success(result) {
+     *                     console.log(result);
+     *                     // Perform operations
+     *     },
+     *     function (error) {
+     *                     console.log(error.message);
+     *                     // Handle error conditions
+     *     }
+     * );
+     */
+    export function cancelEvent(
+      cancellationToken: string,
+      correlationId?: string
+    ): Promise<string>;
+
+    /**
+     * Displays a notification that can be used to inform the agent about incoming conversations.
+     * @param input JSON string
+     * @param correlationId Used to group all related API calls together for diagnostic telemetry.
+     * @param cancellationToken Is the unique string that's used by the {@link cancelEvent} method to cancel notifications about incoming conversations.
+     * @returns Returns a Boolean value of success.
+     * @see {@link https://learn.microsoft.com/en-us/dynamics365/customer-service/channel-integration-framework/v2/reference/microsoft-ciframework/notifyevent External Link: notifyEvent}
+     * @example
+     * var canceltoken = "cancellationtoken"+ Math.ceil(Math.random() * 100000 + 100000).toString();
+     *
+     * var input = {
+     *      templateName: "msdyn_chat_incoming_unauthenticated", // unique name of the configured template
+     *      templateParameters: {},
+     *      cancellationToken: canceltoken // unique random token, to identify the notification during cancelEvent call
+     * }
+     * Microsoft.CIFramework.notifyEvent(input).then(
+     *      function success(result) {
+     *          console.log(result);
+     *          // Perform operations
+     *      },
+     *      function (error) {
+     *          console.log(error.message);
+     *          // Handle error conditions
+     *      }
+     * );
+     */
+    export function notifyEvent(
+      input: string,
+      correlationId?: string,
+      cancellationToken?: string
+    ): Promise<string>;
+  }
+}

package/v2.0/Presence.d.ts

@@ -0,0 +1,46 @@
+declare namespace Microsoft {
+  namespace CIFramework {
+    /**
+     * Returns the presence text of the agent in the client session.
+     * @returns Promise with the presence text of the current agent, as String.
+     * @see {@link https://learn.microsoft.com/en-us/dynamics365/customer-service/channel-integration-framework/v2/reference/microsoft-ciframework/getpresence External Link: getPresence}
+     * @example
+     * function getPresence() {
+     *     return new Promise((resolve, reject) => {
+     *         Microsoft.CIFramework.getPresence().then(
+     *             function (result) {
+     *                 if (result == "FAILED")
+     *                     //your code handling for failure
+     *                 else {
+     *                     //your code for success
+     *                 }
+     *                 return result;
+     *             },
+     *             function (error) {
+     *                 // code handling for promise failure
+     *             });
+     *     });
+     */
+    export function getPresence(): Promise<string>;
+
+    /**
+     * Sets the presence text of the agent in the client session.
+     * @param presenceText Presence text for current agent in Omnichannel for Customer Service. For the presence to be set correctly, the string should exactly match the text used in the admin app. To create custom presence, see {@link https://learn.microsoft.com/en-us/dynamics365/customer-service/presence-custom-presence External Link: Configure and manage custom presence} .
+     * @returns Returns a Boolean value of success.
+     * @see {@link https://learn.microsoft.com/en-us/dynamics365/customer-service/channel-integration-framework/v2/reference/microsoft-ciframework/setpresence External Link: setPresence}
+     * @example
+     * Microsoft.CIFramework.setPresence(custompresence).then(
+     *   function (result) {
+     *       if(!result)
+     *       //code handling when OC Presence is in error
+     *       else
+     *       //code handling for success
+     *   },
+     *   function (error) {
+     *       reject(error);
+     *   });
+     *
+     */
+    export function setPresence(presenceText: string): Promise<boolean>;
+  }
+}

package/v2.0/index.d.ts

@@ -2,6 +2,8 @@
 /// <reference path="../v1.0/CRUD.d.ts" />
 /// <reference path="../v1.0/EntityMetadata.d.ts" />
 /// <reference path="../v1.0/Environment.d.ts" />
+/// <reference path="../v1.0/Events.d.ts" />
 /// <reference path="./PanelMode.d.ts" />
 /// <reference path="../v1.0/PanelWidth.d.ts" />
+/// <reference path="./Presence.d.ts" />
 /// <reference path="../v1.0/Search.d.ts" />