xrm-ex - npm Package Compare versions

Comparing version 1.0.28 to 1.1.0

package.json

 {
   "name": "xrm-ex",
-  "version": "1.0.28",
+  "version": "1.1.0",
   "description": "Xrm-Ex is a JavaScript framework that simplifies the usage of Dynamics 365 Client API. It provides intuitive wrappers for formContext and Xrm Object, helping developers reduce the amount of code, increase maintainability, and decrease errors. Ideal for developers looking to leverage the power of Dynamics 365 Client API within the TypeScript ecosystem.",
@@ -5,0 +5,0 @@ "keywords": [

README.md

@@ -105,2 +105,3 @@ ![NPM](https://img.shields.io/npm/l/xrm-ex)
     }
+    /**@type {Xrm.FormContext}*/ var formContext;
     /**@type {Fields}*/ var fields;
@@ -134,3 +135,4 @@ /**@type {Tabs}*/ var tabs;
         }
-        XrmEx.Form.formContext = executionContext;
+        XrmEx.Form.executionContext = executionContext;
+        formContext = XrmEx.Form.formContext;
         fields = new Fields();
@@ -137,0 +139,0 @@ tabs = new Tabs();

src/XrmEx.d.ts

@@ -31,3 +31,3 @@ /// <reference types="xrm" />
      */
-    function throwError(errorMessage: string): never;
+    export function throwError(errorMessage: string): never;
     /**
@@ -37,3 +37,3 @@ * Returns the name of the calling function.
      */
-    function getFunctionName(): string;
+    export function getFunctionName(): string;
     /**
@@ -46,3 +46,3 @@ * Displays a notification for an app with the given message and level, and lets you specify whether to show a close button.
      */
-    function addGlobalNotification(message: string, level: "SUCCESS" | "ERROR" | "WARNING" | "INFO", showCloseButton?: boolean): Promise<string>;
+    export function addGlobalNotification(message: string, level: "SUCCESS" | "ERROR" | "WARNING" | "INFO", showCloseButton?: boolean): Promise<string>;
     /**
@@ -53,3 +53,3 @@ * Clears a notification in the app with the given unique ID.
      */
-    function removeGlobalNotification(uniqueId: string): Promise<string>;
+    export function removeGlobalNotification(uniqueId: string): Promise<string>;
     /**
@@ -62,3 +62,3 @@ * Retrieves the value of an environment variable by using its schema name as key.
      */
-    function getEnvironmentVariableValue(environmentVariableSchemaName: string): Promise<string>;
+    export function getEnvironmentVariableValue(environmentVariableSchemaName: string): Promise<string>;
     /**
@@ -70,3 +70,3 @@ * Checks if the given request parameter is of a supported type and has a valid value.
      */
-    function checkRequestParameterType(requestParameter: RequestParameter): void;
+    export function checkRequestParameterType(requestParameter: RequestParameter): void;
     /**
@@ -80,3 +80,3 @@ * Executes an Action.
      */
-    function executeAction(actionName: string, requestParameters: RequestParameter[], boundEntity?: EntityReference): Promise<any>;
+    export function executeAction(actionName: string, requestParameters: RequestParameter[], boundEntity?: EntityReference): Promise<any>;
     /**
@@ -90,3 +90,3 @@ * Executes a Function.
      */
-    function executeFunction(functionName: string, requestParameters: RequestParameter[], boundEntity?: EntityReference): Promise<any>;
+    export function executeFunction(functionName: string, requestParameters: RequestParameter[], boundEntity?: EntityReference): Promise<any>;
     /**
@@ -97,4 +97,12 @@ * Makes a GUID lowercase and removes brackets.
      */
-    function normalizeGuid(guid: string): string;
+    export function normalizeGuid(guid: string): string;
     /**
+     * Wraps a function that takes a callback as its last parameter and returns a Promise.
+     * @param {Function} fn the function to wrap
+     * @param context the parent property of the function f.e. formContext.data.process for formContext.data.process.getEnabledProcesses
+     * @param args the arguments to pass to the function
+     * @returns {Promise<any>} a Promise that resolves with the callback response
+     */
+    export function asPromise<T>(fn: Function, context: any, ...args: any[]): Promise<T>;
+    /**
      * Opens a dialog with dynamic height and width based on text content.
@@ -105,7 +113,53 @@ * @param {string} title - The title of the dialog.
      */
-    function openAlertDialog(title: string, text: string): Promise<any>;
+    export function openAlertDialog(title: string, text: string): Promise<any>;
+    class Process {
+        /**
+         * Use this method to asynchronously retrieve the enabled business process flows that the user can switch to for an entity.
+         * @returns returns callback response as Promise
+         */
+        static getEnabledProcesses(): Promise<Xrm.ProcessFlow.ProcessDictionary>;
+        /**
+         * Returns all process instances for the entity record that the calling user has access to.
+         * @returns returns callback response as Promise
+         */
+        static getProcessInstances(): Promise<Xrm.ProcessFlow.GetProcessInstancesDelegate>;
+        /**
+         * Progresses to the next stage.
+         * @returns returns callback response as Promise
+         */
+        static moveNext(): Promise<Xrm.ProcessFlow.ProcessCallbackDelegate>;
+        /**
+         * Moves to the previous stage.
+         * @returns returns callback response as Promise
+         */
+        static movePrevious(): Promise<Xrm.ProcessFlow.ProcessCallbackDelegate>;
+        /**
+         * Set a Process as the active process.
+         * @param processId The Id of the process to make the active process.
+         * @returns returns callback response as Promise
+         */
+        static setActiveProcess(processId: string): Promise<Xrm.ProcessFlow.ProcessCallbackDelegate>;
+        /**
+         * Sets a process instance as the active instance
+         * @param processInstanceId The Id of the process instance to make the active instance.
+         * @returns returns callback response as Promise
+         */
+        static setActiveProcessInstance(processInstanceId: string): Promise<Xrm.ProcessFlow.SetProcessInstanceDelegate>;
+        /**
+         * Set a stage as the active stage.
+         * @param stageId the Id of the stage to make the active stage.
+         * @returns returns callback response as Promise
+         */
+        static setActiveStage(stageId: string): Promise<Xrm.ProcessFlow.SetProcessInstanceDelegate>;
+        /**
+         * Use this method to set the current status of the process instance
+         * @param status The new status for the process
+         * @returns returns callback response as Promise
+         */
+        static setStatus(status: Xrm.ProcessFlow.ProcessStatus): Promise<Xrm.ProcessFlow.SetProcessInstanceDelegate>;
+    }
     /**
      * Represents a form in Dynamics 365.
      */
-    class Form {
+    export class Form {
         protected static _formContext: Xrm.FormContext;
@@ -132,2 +186,3 @@ protected static _executionContext: Xrm.Events.EventContext;
         static get IsNotUpdate(): boolean;
+        static process: typeof Process;
         /**
@@ -173,3 +228,3 @@ * Displays a form level notification. Any number of notifications can be displayed and will remain until removed using clearFormNotification.
     }
-    namespace Class {
+    export namespace Class {
         /**
@@ -486,2 +541,3 @@ * Used to execute methods related to a single Attribute
     }
+    export {};
 }

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

229853

increased by6.9%

Lines of code

1953

increased by7.78%

Number of lines in readme file

436

increased by0.46%

No dependency changes