pptb-standard-sample-tool 1.0.3 → 1.0.5

package/README.md

@@ -11,6 +11,7 @@ This sample demonstrates:
   - Notifications (success, info, warning, error)
   - Clipboard operations
   - File save dialogs
+  - Tool settings storage (save/load/clear)
   - Theme detection
   - Terminal creation and command execution
   - Event subscription and handling
@@ -100,6 +101,7 @@ html-sample/
 **Query Records:**
 - FetchXML query to retrieve top 10 accounts
 - Display results with formatting
+- If a FetchXML is saved in Tool Settings, the Query button will use that instead of the default
 
 **CRUD Operations:**
 - Create new account records
@@ -174,6 +176,23 @@ try {
 
 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.
 
+### Tool Settings Storage
+
+Use the tool settings API to persist user preferences and configuration for your tool. This storage is scoped per tool.
+
+```typescript
+// Save a setting
+await toolboxAPI.settings.set('demo.fetchxml', myFetchXmlString);
+
+// Read a setting
+const saved = await toolboxAPI.settings.get('demo.fetchxml');
+
+// Delete a setting
+await toolboxAPI.settings.delete('demo.fetchxml');
+```
+
+In this sample, the “Tool Settings” section lets you save a FetchXML snippet. The “Query Top 10 Accounts” button will use the saved FetchXML if present, otherwise it falls back to the default.
+
 ### ToolBox API
 
 ```typescript

package/dist/app.js

@@ -31,6 +31,8 @@ async function initialize() {
         setupEventHandlers();
         // Apply theme
         await applyTheme();
+        // Load any previously saved setting into UI
+        await loadToolSetting();
         log('Tool initialized successfully', 'success');
     }
     catch (error) {
@@ -138,6 +140,9 @@ function setupEventHandlers() {
     // Advanced utilities demos
     document.getElementById('parallel-demo-btn')?.addEventListener('click', demoExecuteParallel);
     document.getElementById('loading-demo-btn')?.addEventListener('click', demoLoading);
+    // Settings buttons
+    document.getElementById('load-setting-btn')?.addEventListener('click', loadToolSetting);
+    document.getElementById('save-setting-btn')?.addEventListener('click', saveToolSetting);
 }
 /**
  * Show notification
@@ -318,17 +323,19 @@ async function queryAccounts() {
         const output = document.getElementById('query-output');
         if (output)
             output.textContent = 'Querying accounts...\n';
-        const fetchXml = `
+        // If user saved a FetchXML in settings, prefer that; otherwise use default
+        const saved = await getSetting('demo.fetchxml');
+        const fetchXml = (saved && saved.trim().length > 0) ? saved : `
 <fetch top="10">
-  <entity name="account">
-    <attribute name="name" />
-    <attribute name="accountid" />
-    <attribute name="emailaddress1" />
-    <attribute name="telephone1" />
-    <order attribute="name" />
-  </entity>
+    <entity name="account">
+        <attribute name="name" />
+        <attribute name="accountid" />
+        <attribute name="emailaddress1" />
+        <attribute name="telephone1" />
+        <order attribute="name" />
+    </entity>
 </fetch>
-        `.trim();
+                `.trim();
         const result = await dataverse.fetchXmlQuery(fetchXml);
         if (output) {
             output.textContent = `Found ${result.value.length} account(s):\n\n`;
@@ -531,6 +538,68 @@ function clearLog() {
         logDiv.innerHTML = '';
     }
 }
+// -----------------------------
+// Tool Settings helpers & demos
+// -----------------------------
+const SETTINGS_KEY = 'demo.fetchxml';
+async function getSetting(key) {
+    try {
+        // Tool settings are scoped to the tool; implementation provided by the host app
+        // API shape (based on docs): toolbox.settings.get(key)
+        const value = await toolbox.settings?.getSettings?.(key);
+        return value;
+    }
+    catch (error) {
+        log(`Error reading setting: ${error.message}`, 'error');
+        return undefined;
+    }
+}
+async function setSetting(key, value) {
+    try {
+        await toolbox.settings?.setSetting?.(key, value);
+    }
+    catch (error) {
+        log(`Error saving setting: ${error.message}`, 'error');
+        throw error;
+    }
+}
+async function loadToolSetting() {
+    const textarea = document.getElementById('settings-fetchxml');
+    const output = document.getElementById('settings-output');
+    try {
+        const val = await getSetting(SETTINGS_KEY);
+        if (textarea)
+            textarea.value = val || '';
+        if (output)
+            output.textContent = val ? 'Loaded saved FetchXML from settings.' : 'No saved FetchXML found.';
+        log('Loaded tool setting', 'info');
+    }
+    catch (error) {
+        if (output)
+            output.textContent = `Error loading setting: ${error.message}`;
+    }
+}
+async function saveToolSetting() {
+    const textarea = document.getElementById('settings-fetchxml');
+    const output = document.getElementById('settings-output');
+    const value = (textarea?.value || '').trim();
+    if (!value) {
+        await showNotification('Nothing to save', 'Enter FetchXML before saving.', 'warning');
+        return;
+    }
+    try {
+        await setSetting(SETTINGS_KEY, value);
+        if (output)
+            output.textContent = 'Saved FetchXML to tool settings.';
+        await showNotification('Setting Saved', 'Your FetchXML has been saved.', 'success');
+        log('Saved tool setting', 'success');
+    }
+    catch (error) {
+        if (output)
+            output.textContent = `Error saving setting: ${error.message}`;
+        await showNotification('Save Failed', error.message, 'error');
+    }
+}
 /**
  * Demonstrate executeParallel utility by performing three Dataverse operations in parallel.
  * Falls back gracefully if no connection is available.
@@ -549,7 +618,7 @@ async function demoExecuteParallel() {
         // 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 userFetchXml = `<fetch top="3"><entity name="systemuser"><attribute name="name" /><attribute name="systemuserid" /></entity></fetch>`;
+        const userFetchXml = `<fetch top="3"><entity name="systemuser"><attribute name="fullname" /><attribute name="systemuserid" /></entity></fetch>`;
         log('Starting parallel Dataverse queries', 'info');
         const [accounts, contacts, users] = await toolbox.utils.executeParallel(dataverse.fetchXmlQuery(accountFetchXml), dataverse.fetchXmlQuery(contactFetchXml), dataverse.fetchXmlQuery(userFetchXml));
         if (output) {

package/dist/index.html

@@ -68,6 +68,20 @@
         <!-- Dataverse API Examples -->
         <section class="card">
             <h2>💾 Dataverse API Examples</h2>
+
+            <div class="example-group">
+                <h3>Tool Settings</h3>
+                <p style="margin:4px 0 10px;font-size:12px;opacity:.85">Persist simple configuration values per tool instance using the Tool Settings storage API.</p>
+                <div class="input-group">
+                    <label for="settings-fetchxml">Saved FetchXML (used for Account Query demo if present):</label>
+                    <textarea id="settings-fetchxml" style="width:100%;min-height:110px;padding:10px;border:2px solid #e0e0e0;border-radius:6px;font-family:monospace;font-size:12px;line-height:1.4" placeholder="Enter FetchXML here and click Save Setting"></textarea>
+                </div>
+                <div class="button-group">
+                    <button id="load-setting-btn" class="btn">Load Setting</button>
+                    <button id="save-setting-btn" class="btn btn-primary">Save Setting</button>
+                </div>
+                <div id="settings-output" class="output"></div>
+            </div>
             
             <div class="example-group">
                 <h3>Query Records</h3>

package/npm-shrinkwrap.json

@@ -1,12 +1,12 @@
 {
     "name": "pptb-standard-sample-tool",
-    "version": "1.0.1",
+    "version": "1.0.4",
     "lockfileVersion": 3,
     "requires": true,
     "packages": {
         "": {
             "name": "pptb-standard-sample-tool",
-            "version": "1.0.1",
+            "version": "1.0.4",
             "license": "GPL-3.0",
             "devDependencies": {
                 "@pptb/types": "^1.0.8",

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "pptb-standard-sample-tool",
-    "version": "1.0.3",
+    "version": "1.0.5",
     "displayName": "HTML Sample Tool",
     "description": "A sample Power Platform Tool Box tool built with HTML, CSS, and TypeScript",
     "main": "index.html",