@pptb/types 1.0.7 → 1.0.9

package/README.md

@@ -2,6 +2,37 @@
 
 TypeScript type definitions for Power Platform Tool Box APIs.
 
+-   [@pptb/types](#pptbtypes)
+    -   [Installation](#installation)
+    -   [Overview](#overview)
+    -   [Usage](#usage)
+        -   [Include all type definitions](#include-all-type-definitions)
+        -   [Include specific API types](#include-specific-api-types)
+    -   [ToolBox API Examples](#toolbox-api-examples)
+        -   [Connections](#connections)
+        -   [Utilities](#utilities)
+        -   [Terminal Operations](#terminal-operations)
+        -   [Events](#events)
+    -   [Dataverse API Examples](#dataverse-api-examples)
+        -   [CRUD Operations](#crud-operations)
+        -   [FetchXML Queries](#fetchxml-queries)
+        -   [Metadata Operations](#metadata-operations)
+        -   [Execute Actions/Functions](#execute-actionsfunctions)
+    -   [API Reference](#api-reference)
+        -   [ToolBox API (`window.toolboxAPI`)](#toolbox-api-windowtoolboxapi)
+            -   [Connections](#connections-1)
+            -   [Utils](#utils)
+            -   [Terminal](#terminal)
+            -   [Events](#events-1)
+        -   [Dataverse API (`window.dataverseAPI`)](#dataverse-api-windowdataverseapi)
+            -   [CRUD Operations](#crud-operations-1)
+            -   [Query Operations](#query-operations)
+            -   [Metadata Operations](#metadata-operations-1)
+            -   [Advanced Operations](#advanced-operations)
+        -   [Security Notes](#security-notes)
+    -   [Publishing the package to npm](#publishing-the-package-to-npm)
+    -   [License](#license)
+
 ## Installation
 
 ```bash
@@ -75,6 +106,24 @@ if (filePath) {
 // Get current theme
 const theme = await toolboxAPI.utils.getCurrentTheme();
 console.log("Current theme:", theme); // "light" or "dark"
+
+// Execute multiple operations in parallel
+const [account, contact, opportunities] = await toolboxAPI.utils.executeParallel(
+    dataverseAPI.retrieve('account', accountId, ['name']),
+    dataverseAPI.retrieve('contact', contactId, ['fullname']),
+    dataverseAPI.fetchXmlQuery(opportunityFetchXml)
+);
+console.log('All data fetched:', account, contact, opportunities);
+
+// Show loading screen during operations
+await toolboxAPI.utils.showLoading('Processing data...');
+try {
+    // Perform operations
+    await processData();
+} finally {
+    // Always hide loading
+    await toolboxAPI.utils.hideLoading();
+}
 ```
 
 ### Terminal Operations
@@ -234,8 +283,33 @@ Core platform features organized into namespaces:
     -   Opens a save dialog and writes the content. Returns the saved file path or null if canceled
 
 -   **getCurrentTheme()**: Promise<"light" | "dark">
+
     -   Returns the current UI theme setting
 
+-   **executeParallel(...operations)**: Promise<T[]>
+
+    -   Executes multiple async operations in parallel using Promise.all
+    -   Accepts promises or functions that return promises as variadic arguments
+    -   Returns an array of results in the same order as the operations
+    -   Example:
+        ```typescript
+        const [account, contact, opportunities] = await toolboxAPI.utils.executeParallel(
+            dataverseAPI.retrieve('account', id1),
+            dataverseAPI.retrieve('contact', id2),
+            dataverseAPI.fetchXmlQuery(fetchXml)
+        );
+        ```
+
+-   **showLoading(message?: string)**: Promise<void>
+
+    -   Displays a loading overlay with spinner in the tool's context
+    -   Optional message parameter (defaults to "Loading...")
+    -   Example: `await toolboxAPI.utils.showLoading('Fetching records...');`
+
+-   **hideLoading()**: Promise<void>
+    -   Hides the loading overlay
+    -   Should be called in a finally block to ensure it's always hidden
+
 #### Terminal
 
 -   **create(options: TerminalOptions)**: Promise<Terminal>

package/dataverseAPI.d.ts

@@ -205,17 +205,20 @@ declare namespace DataverseAPI {
          * Get metadata for a specific entity
          *
          * @param entityLogicalName - Logical name of the entity
+         * @param searchByLogicalName - Whether to search by logical name (true) or metadata ID (false)
          * @param selectColumns - Optional array of column names to retrieve (retrieves all if not specified)
          * @returns Object containing entity metadata
          *
          * @example
-         * const metadata = await dataverseAPI.getEntityMetadata('account');
+         * const metadata = await dataverseAPI.getEntityMetadata('account', true, ['LogicalName', 'DisplayName']);
+         * console.log('Logical Name:', metadata.LogicalName);
          * console.log('Display Name:', metadata.DisplayName?.LocalizedLabels[0]?.Label);
-         * console.log('Attributes:', metadata.Attributes?.length);
          *
          * @example
-         * // Get only specific metadata columns
-         * const metadata = await dataverseAPI.getEntityMetadata('account', ['LogicalName', 'DisplayName']);
+         * // Get entity metadata by metadata ID
+         * const metadata = await dataverseAPI.getEntityMetadata('00000000-0000-0000-0000-000000000001', false, ['LogicalName', 'DisplayName']);
+         * console.log('Entity Metadata ID:', metadata.MetadataId);
+         * console.log('Logical Name:', metadata.LogicalName);
          * console.log('Display Name:', metadata.DisplayName?.LocalizedLabels[0]?.Label);
          */
         getEntityMetadata: (entityLogicalName: string, searchByLogicalName: boolean, selectColumns?: string[]) => Promise<EntityMetadata>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pptb/types",
-  "version": "1.0.7",
+  "version": "1.0.9",
   "description": "TypeScript type definitions for Power Platform Tool Box API",
   "main": "index.d.ts",
   "types": "index.d.ts",
@@ -16,7 +16,7 @@
   "license": "GPL-3.0",
   "repository": {
     "type": "git",
-    "url": "https://github.com/PowerPlatform-ToolBox/desktop-app.git",
+    "url": "https://github.com/PowerPlatformToolBox/desktop-app.git",
     "directory": "packages"
   }
 }

package/toolboxAPI.d.ts

@@ -145,6 +145,31 @@ declare namespace ToolBoxAPI {
          * Get the current UI theme (light or dark)
          */
         getCurrentTheme: () => Promise<"light" | "dark">;
+
+        /**
+         * Execute multiple async operations in parallel using Promise.all
+         * @param operations Variable number of promises or async function calls
+         * @returns Promise that resolves when all operations complete with an array of results
+         * @example
+         * // Execute multiple API calls in parallel
+         * const [account, contact, opportunities] = await toolboxAPI.utils.executeParallel(
+         *   dataverseAPI.retrieve('account', '123'),
+         *   dataverseAPI.retrieve('contact', '456'),
+         *   dataverseAPI.fetchXmlQuery(fetchXml)
+         * );
+         */
+        executeParallel: <T = any>(...operations: Array<Promise<T> | (() => Promise<T>)>) => Promise<T[]>;
+
+        /**
+         * Show a loading screen in the tool's context
+         * @param message Optional message to display (default: "Loading...")
+         */
+        showLoading: (message?: string) => Promise<void>;
+
+        /**
+         * Hide the loading screen in the tool's context
+         */
+        hideLoading: () => Promise<void>;
     }
 
     /**
@@ -211,14 +236,14 @@ declare namespace ToolBoxAPI {
          * Get all settings for this tool
          * @returns Promise resolving to an object with all settings (empty object if no settings exist)
          */
-        getSettings: () => Promise<Record<string, any>>;
+        getAll: () => Promise<Record<string, any>>;
 
         /**
          * Get a specific setting by key
          * @param key The setting key to retrieve
          * @returns Promise resolving to the setting value, or undefined if not found
          */
-        getSetting: (key: string) => Promise<any>;
+        get: (key: string) => Promise<any>;
 
         /**
          * Set a specific setting by key
@@ -226,14 +251,14 @@ declare namespace ToolBoxAPI {
          * @param value The value to store (can be any JSON-serializable value)
          * @returns Promise that resolves when the setting is saved
          */
-        setSetting: (key: string, value: any) => Promise<void>;
+        set: (key: string, value: any) => Promise<void>;
 
         /**
          * Set all settings (replaces entire settings object)
          * @param settings The settings object to store
          * @returns Promise that resolves when the settings are saved
          */
-        setSettings: (settings: Record<string, any>) => Promise<void>;
+        setAll: (settings: Record<string, any>) => Promise<void>;
     }
 
     /**