pptb-standard-sample-tool 0.1.9 → 1.0.0

package/README.md

@@ -148,6 +148,32 @@ const dataverse: typeof window.dataverseAPI = window.dataverseAPI;
 
 ## API Usage Examples
 
+### Advanced Utilities
+
+Below demonstrates using `executeParallel` to run multiple Dataverse operations concurrently, and wrapping work with `showLoading` / `hideLoading`:
+
+```typescript
+// 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();
+}
+```
+
+In this HTML sample, the "Run Parallel Demo" button issues three light FetchXML queries simultaneously using `toolbox.utils.executeParallel`, and the "Run Loading Demo" button shows a loading overlay while either performing a quick query (if connected) or simulating work.
+
 ### ToolBox API
 
 ```typescript

package/dist/app.js

@@ -135,6 +135,9 @@ function setupEventHandlers() {
     document.getElementById('get-metadata-btn')?.addEventListener('click', getContactMetadata);
     // Clear log button
     document.getElementById('clear-log-btn')?.addEventListener('click', clearLog);
+    // Advanced utilities demos
+    document.getElementById('parallel-demo-btn')?.addEventListener('click', demoExecuteParallel);
+    document.getElementById('loading-demo-btn')?.addEventListener('click', demoLoading);
 }
 /**
  * Show notification
@@ -469,7 +472,8 @@ async function getContactMetadata() {
         const output = document.getElementById('metadata-output');
         if (output)
             output.textContent = 'Retrieving metadata...\n';
-        const metadata = await dataverse.getEntityMetadata('contact');
+        // Adjusted to match current API signature (logical name, includeAttributes?)
+        const metadata = await dataverse.getEntityMetadata('contact', true);
         if (output) {
             output.textContent = 'Contact Entity Metadata:\n\n';
             output.textContent += `Logical Name: ${metadata.LogicalName}\n`;
@@ -527,6 +531,86 @@ function clearLog() {
         logDiv.innerHTML = '';
     }
 }
+/**
+ * Demonstrate executeParallel utility by performing three Dataverse operations in parallel.
+ * Falls back gracefully if no connection is available.
+ */
+async function demoExecuteParallel() {
+    const output = document.getElementById('parallel-output');
+    if (output)
+        output.textContent = 'Running parallel operations...\n';
+    if (!currentConnection) {
+        if (output)
+            output.textContent += 'No active Dataverse connection.\n';
+        await showNotification('No Connection', 'Connect to a Dataverse environment to run the parallel demo', 'warning');
+        return;
+    }
+    try {
+        // Prepare lightweight FetchXML queries (top 1 / top 3) for demo purposes
+        const accountFetchXml = `<fetch top="1"><entity name="account"><attribute name="name" /><attribute name="accountid" /></entity></fetch>`;
+        const contactFetchXml = `<fetch top="1"><entity name="contact"><attribute name="fullname" /><attribute name="contactid" /></entity></fetch>`;
+        const opportunityFetchXml = `<fetch top="3"><entity name="opportunity"><attribute name="name" /><attribute name="opportunityid" /></entity></fetch>`;
+        log('Starting parallel Dataverse queries', 'info');
+        const [accounts, contacts, opportunities] = await toolbox.utils.executeParallel(dataverse.fetchXmlQuery(accountFetchXml), dataverse.fetchXmlQuery(contactFetchXml), dataverse.fetchXmlQuery(opportunityFetchXml));
+        if (output) {
+            output.textContent += 'All operations completed!\n\n';
+            output.textContent += `Accounts Returned: ${accounts.value.length}\n`;
+            accounts.value.forEach((a) => output.textContent += ` • ${a.name} (${a.accountid})\n`);
+            output.textContent += `\nContacts Returned: ${contacts.value.length}\n`;
+            contacts.value.forEach((c) => output.textContent += ` • ${c.fullname} (${c.contactid})\n`);
+            output.textContent += `\nOpportunities Returned: ${opportunities.value.length}\n`;
+            opportunities.value.forEach((o) => output.textContent += ` • ${o.name} (${o.opportunityid})\n`);
+        }
+        await showNotification('Parallel Complete', 'Fetched accounts, contacts & opportunities', 'success');
+        log('Parallel queries finished successfully', 'success');
+    }
+    catch (error) {
+        if (output)
+            output.textContent += `Error: ${error.message}\n`;
+        log(`Parallel query error: ${error.message}`, 'error');
+        await showNotification('Parallel Error', error.message, 'error');
+    }
+}
+/**
+ * Demonstrate showLoading/hideLoading utilities wrapping async work.
+ */
+async function demoLoading() {
+    const output = document.getElementById('parallel-output');
+    if (output)
+        output.textContent = 'Showing loading screen...\n';
+    try {
+        await toolbox.utils.showLoading('Processing data...');
+        log('Loading screen displayed', 'info');
+        // Simulate async work or perform a lightweight query
+        if (currentConnection) {
+            const fetchXml = `<fetch top="2"><entity name="account"><attribute name="name" /></entity></fetch>`;
+            const result = await dataverse.fetchXmlQuery(fetchXml);
+            if (output) {
+                output.textContent += `Fetched ${result.value.length} account(s) during loading:\n`;
+                result.value.forEach((a) => output.textContent += ` • ${a.name}\n`);
+            }
+        }
+        else {
+            // Fallback simulated delay
+            await new Promise(r => setTimeout(r, 1500));
+            if (output)
+                output.textContent += 'Simulated work (no connection).\n';
+        }
+    }
+    catch (error) {
+        if (output)
+            output.textContent += `Error during loading demo: ${error.message}\n`;
+        log(`Loading demo error: ${error.message}`, 'error');
+        await showNotification('Loading Demo Error', error.message, 'error');
+    }
+    finally {
+        await toolbox.utils.hideLoading();
+        if (output)
+            output.textContent += '\nLoading screen hidden.';
+        log('Loading screen hidden', 'info');
+        await showNotification('Loading Complete', 'Demo finished', 'success');
+    }
+}
 // Initialize when DOM is ready
 if (document.readyState === 'loading') {
     document.addEventListener('DOMContentLoaded', initialize);

package/dist/index.html

@@ -44,6 +44,16 @@
                 </div>
             </div>
 
+            <div class="example-group">
+                <h3>Advanced Utilities</h3>
+                <p style="margin:4px 0 8px; font-size:12px; opacity:.8;">Demonstrates <code>executeParallel</code>, <code>showLoading</code> & <code>hideLoading</code>.</p>
+                <div class="button-group">
+                    <button id="parallel-demo-btn" class="btn btn-primary">Run Parallel Demo</button>
+                    <button id="loading-demo-btn" class="btn btn-secondary">Run Loading Demo</button>
+                </div>
+                <div id="parallel-output" class="output"></div>
+            </div>
+
             <div class="example-group">
                 <h3>Terminal</h3>
                 <div class="button-group">

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "pptb-standard-sample-tool",
-    "version": "0.1.9",
+    "version": "1.0.0",
     "displayName": "HTML Sample Tool",
     "description": "A sample Power Platform Tool Box tool built with HTML, CSS, and TypeScript",
     "main": "index.html",
@@ -29,7 +29,7 @@
         "watch": "tsc --watch"
     },
     "devDependencies": {
-        "@pptb/types": "^1.0.1",
+        "@pptb/types": "^1.0.8",
         "typescript": "^5.0.0",
         "shx": "^0.4.0"
     },