@pptb/types 1.0.11 → 1.0.13

package/README.md

@@ -109,14 +109,14 @@ 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 +253,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
@@ -294,9 +300,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 +413,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

@@ -380,6 +380,77 @@ declare namespace DataverseAPI {
          * const result = await dataverseAPI.queryData('$filter=statecode eq 0', 'secondary');
          */
         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
+         *
+         * @param entityLogicalName - Logical name of the entity (e.g., 'account', 'contact')
+         * @param records - Array of record data to create, including the "@odata.type" property for each record
+         * @param connectionTarget - Optional connection target for multi-connection tools ('primary' or 'secondary'). Defaults to 'primary'.
+         * @returns Array of strings representing the created record IDs
+         *
+         * @example
+         * const results = await dataverseAPI.createMultiple('account', [
+         *     { name: 'Contoso Ltd', "@odata.type": "Microsoft.Dynamics.CRM.account" },
+         *     { name: 'Fabrikam Inc', "@odata.type": "Microsoft.Dynamics.CRM.account" }
+         * ]);
+         */
+        createMultiple: (entityLogicalName: string, records: Record<string, unknown>[], connectionTarget?: "primary" | "secondary") => Promise<string[]>;
+
+        /**
+         * Update multiple records in Dataverse
+         * @param entityLogicalName - Logical name of the entity
+         * @param records - Array of record data to update, each including the "id" property and the "odata.type" property
+         * @param connectionTarget - Optional connection target for multi-connection tools ('primary' or 'secondary'). Defaults to 'primary'.
+         *
+         * @example
+         * await dataverseAPI.updateMultiple('account', [
+         *     { accountid: 'guid-1', name: 'Updated Name 1', "@odata.type": "Microsoft.Dynamics.CRM.account" },
+         *     { accountid: 'guid-2', name: 'Updated Name 2', "@odata.type": "Microsoft.Dynamics.CRM.account" }
+         * ]);
+         */
+        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
+         * (entity set name) is required instead of the logical table name.
+         *
+         * Note: This is a utility method that applies pluralization rules and does not
+         * require an active connection to Dataverse.
+         *
+         * @param entityLogicalName - The logical name of the Dataverse table (for example, "account").
+         * @returns The corresponding entity set name (for example, "accounts").
+         *
+         * @example
+         * const entitySetName = await dataverseAPI.getEntitySetName('account');
+         * console.log(entitySetName); // Output: "accounts"
+         *
+         * @example
+         * const entitySetName = await dataverseAPI.getEntitySetName('opportunity');
+         * console.log(entitySetName); // Output: "opportunities"
+         */
+        getEntitySetName: (entityLogicalName: string) => Promise<string>;
     }
 }
 

package/package.json

@@ -1,22 +1,22 @@
 {
-  "name": "@pptb/types",
-  "version": "1.0.11",
-  "description": "TypeScript type definitions for Power Platform Tool Box API",
-  "main": "index.d.ts",
-  "types": "index.d.ts",
-  "keywords": [
-    "powerplatform",
-    "pptb",
-    "toolbox",
-    "types",
-    "typescript",
-    "dataverse"
-  ],
-  "author": "Power Platform Tool Box",
-  "license": "GPL-3.0",
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/PowerPlatformToolBox/desktop-app.git",
-    "directory": "packages"
-  }
+    "name": "@pptb/types",
+    "version": "1.0.13",
+    "description": "TypeScript type definitions for Power Platform Tool Box API",
+    "main": "index.d.ts",
+    "types": "index.d.ts",
+    "keywords": [
+        "powerplatform",
+        "pptb",
+        "toolbox",
+        "types",
+        "typescript",
+        "dataverse"
+    ],
+    "author": "Power Platform Tool Box",
+    "license": "GPL-3.0",
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/PowerPlatformToolBox/desktop-app.git",
+        "directory": "packages"
+    }
 }

package/toolboxAPI.d.ts

@@ -65,6 +65,11 @@ declare namespace ToolBoxAPI {
         tenantId?: string;
         createdAt: string;
         lastUsedAt?: string;
+        /**
+         * @deprecated isActive is a legacy field that is no longer persisted.
+         * It may be present in older tool code but should not be relied upon.
+         * Use the connection context provided by the ToolBox API instead.
+         */
         isActive?: boolean;
     }