@pptb/types 1.0.12 → 1.0.14

package/README.md

@@ -103,20 +103,30 @@ if (filePath) {
     console.log("File saved to:", filePath);
 }
 
+// Select a folder for exporting assets
+const targetFolder = await toolboxAPI.utils.selectPath({
+    type: "folder",
+    title: "Choose export directory",
+    defaultPath: "/Users/me/Downloads",
+});
+if (!targetFolder) {
+    console.log("User canceled folder selection");
+}
+
 // 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)
+    dataverseAPI.retrieve("account", accountId, ["name"]),
+    dataverseAPI.retrieve("contact", contactId, ["fullname"]),
+    dataverseAPI.fetchXmlQuery(opportunityFetchXml),
 );
-console.log('All data fetched:', account, contact, opportunities);
+console.log("All data fetched:", account, contact, opportunities);
 
 // Show loading screen during operations
-await toolboxAPI.utils.showLoading('Processing data...');
+await toolboxAPI.utils.showLoading("Processing data...");
 try {
     // Perform operations
     await processData();
@@ -253,6 +263,12 @@ const result = await dataverseAPI.execute({
         FieldName: "total_revenue",
     },
 });
+
+// Publish customizations for the active environment
+await dataverseAPI.publishCustomizations();
+
+// Publish only a specific table (in this case, the account table)
+await dataverseAPI.publishCustomizations("account");
 ```
 
 ## API Reference
@@ -282,6 +298,12 @@ Core platform features organized into namespaces:
 
     -   Opens a save dialog and writes the content. Returns the saved file path or null if canceled
 
+-   **selectPath(options?: SelectPathOptions)**: Promise<string | null>
+
+    -   Opens a native dialog to select either a file or folder (defaults to file)
+    -   Supports custom titles, button labels, default paths, and filters when selecting files
+    -   Returns the selected path or null if the user cancels
+
 -   **getCurrentTheme()**: Promise<"light" | "dark">
 
     -   Returns the current UI theme setting
@@ -294,9 +316,9 @@ Core platform features organized into namespaces:
     -   Example:
         ```typescript
         const [account, contact, opportunities] = await toolboxAPI.utils.executeParallel(
-            dataverseAPI.retrieve('account', id1),
-            dataverseAPI.retrieve('contact', id2),
-            dataverseAPI.fetchXmlQuery(fetchXml)
+            dataverseAPI.retrieve("account", id1),
+            dataverseAPI.retrieve("contact", id2),
+            dataverseAPI.fetchXmlQuery(fetchXml),
         );
         ```
 
@@ -407,6 +429,8 @@ Complete HTTP client for interacting with Microsoft Dataverse:
 -   **execute(request: ExecuteRequest)**: Promise<Record<string, unknown>>
     -   Executes a Dataverse Web API action or function
     -   Supports both bound and unbound operations
+-   **publishCustomizations(tableLogicalName?: string)**: Promise<void>
+    -   Publishes pending customizations. When `tableLogicalName` is omitted it runs PublishAllXml; otherwise it publishes only the specified table.
 
 ### Security Notes
 

package/dataverseAPI.d.ts

@@ -381,6 +381,25 @@ declare namespace DataverseAPI {
          */
         queryData: (odataQuery: string, connectionTarget?: "primary" | "secondary") => Promise<{ value: Record<string, unknown>[] }>;
 
+        /**
+         * Publish customizations for the current environment.
+         *
+         * When `tableLogicalName` is provided, this method publishes only that table by executing the PublishXml action with a generated payload.
+         * When no table name is provided, it runs PublishAllXml (equivalent to "Publish All Customizations").
+         *
+         * @param tableLogicalName - Optional table (entity) logical name to publish. If omitted, all pending customizations are published.
+         * @param connectionTarget - Optional connection target for multi-connection tools ('primary' or 'secondary'). Defaults to 'primary'.
+         *
+         * @example
+         * // Publish all customizations
+         * await dataverseAPI.publishCustomizations();
+         *
+         * @example
+         * // Publish only the account table
+         * await dataverseAPI.publishCustomizations('account');
+         */
+        publishCustomizations: (tableLogicalName?: string, connectionTarget?: "primary" | "secondary") => Promise<void>;
+
         /**
          * Create multiple records in Dataverse
          *
@@ -410,6 +429,8 @@ declare namespace DataverseAPI {
          * ]);
          */
         updateMultiple: (entityLogicalName: string, records: Record<string, unknown>[], connectionTarget?: "primary" | "secondary") => Promise<void>;
+
+        /**
          * Gets the Dataverse entity set (collection) name for the specified table.
          *
          * This is typically used when building OData queries where the collection name

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@pptb/types",
-    "version": "1.0.12",
+    "version": "1.0.14",
     "description": "TypeScript type definitions for Power Platform Tool Box API",
     "main": "index.d.ts",
     "types": "index.d.ts",
@@ -19,4 +19,4 @@
         "url": "https://github.com/PowerPlatformToolBox/desktop-app.git",
         "directory": "packages"
     }
-}
+}

package/toolboxAPI.d.ts

@@ -27,6 +27,26 @@ declare namespace ToolBoxAPI {
         duration?: number; // Duration in milliseconds, 0 for persistent
     }
 
+    /**
+     * File dialog filter definition
+     */
+    export interface FileDialogFilter {
+        name: string;
+        extensions: string[];
+    }
+
+    /**
+     * Options for selecting a file or folder path
+     */
+    export interface SelectPathOptions {
+        type?: "file" | "folder";
+        title?: string;
+        message?: string;
+        buttonLabel?: string;
+        defaultPath?: string;
+        filters?: FileDialogFilter[];
+    }
+
     /**
      * Event types that can be emitted by the ToolBox
      */
@@ -128,17 +148,17 @@ declare namespace ToolBoxAPI {
          * Get the currently active Dataverse connection
          */
         getActiveConnection: () => Promise<DataverseConnection | null>;
-        
+
         /**
          * Get the secondary connection for multi-connection tools
          */
         getSecondaryConnection: () => Promise<DataverseConnection | null>;
-        
+
         /**
          * Get the secondary connection URL for multi-connection tools
          */
         getSecondaryConnectionUrl: () => Promise<string | null>;
-        
+
         /**
          * Get the secondary connection ID for multi-connection tools
          */
@@ -164,6 +184,11 @@ declare namespace ToolBoxAPI {
          */
         saveFile: (defaultPath: string, content: any) => Promise<string | null>;
 
+        /**
+         * Open a native dialog to select either a file or a folder and return the chosen path
+         */
+        selectPath: (options?: SelectPathOptions) => Promise<string | null>;
+
         /**
          * Get the current UI theme (light or dark)
          */