@pptb/types 1.0.1 → 1.0.3

package/dataverseAPI.d.ts

@@ -205,14 +205,20 @@ declare namespace DataverseAPI {
          * Get metadata for a specific entity
          *
          * @param entityLogicalName - Logical name of the entity
+         * @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');
          * 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']);
+         * console.log('Display Name:', metadata.DisplayName?.LocalizedLabels[0]?.Label);
          */
-        getEntityMetadata: (entityLogicalName: string) => Promise<EntityMetadata>;
+        getEntityMetadata: (entityLogicalName: string, selectColumns?: string[]) => Promise<EntityMetadata>;
 
         /**
          * Get metadata for all entities
@@ -227,6 +233,59 @@ declare namespace DataverseAPI {
          * });
          */
         getAllEntitiesMetadata: () => Promise<EntityMetadataCollection>;
+
+        /**
+         * Get related metadata for a specific entity (attributes, relationships, etc.)
+         *
+         * @param entityLogicalName - Logical name of the entity
+         * @param relatedPath - Path after EntityDefinitions(LogicalName='name') (e.g., 'Attributes', 'OneToManyRelationships', 'ManyToOneRelationships', 'ManyToManyRelationships', 'Keys')
+         * @param selectColumns - Optional array of column names to retrieve (retrieves all if not specified)
+         * @returns Object containing the related metadata
+         *
+         * @example
+         * // Get all attributes for an entity
+         * const attributes = await dataverseAPI.getEntityRelatedMetadata('account', 'Attributes');
+         * console.log('Attributes:', attributes.value);
+         *
+         * @example
+         * // Get specific attributes with select
+         * const attributes = await dataverseAPI.getEntityRelatedMetadata(
+         *     'account',
+         *     'Attributes',
+         *     ['LogicalName', 'DisplayName', 'AttributeType']
+         * );
+         * console.log('Filtered attributes:', attributes.value);
+         *
+         * @example
+         * // Get one-to-many relationships
+         * const relationships = await dataverseAPI.getEntityRelatedMetadata(
+         *     'account',
+         *     'OneToManyRelationships'
+         * );
+         * console.log('One-to-many relationships:', relationships.value);
+         */
+        getEntityRelatedMetadata: (entityLogicalName: string, relatedPath: string, selectColumns?: string[]) => Promise<Record<string, unknown>>;
+
+        /**
+         * Get solutions from the environment
+         *
+         * @param selectColumns - Required array of column names to retrieve (must contain at least one column)
+         * @returns Object with value array containing solutions
+         *
+         * @example
+         * const solutions = await dataverseAPI.getSolutions([
+         *     'solutionid',
+         *     'uniquename',
+         *     'friendlyname',
+         *     'version',
+         *     'ismanaged'
+         * ]);
+         * console.log(`Total solutions: ${solutions.value.length}`);
+         * solutions.value.forEach(solution => {
+         *     console.log(`${solution.friendlyname} (${solution.uniquename}) - v${solution.version}`);
+         * });
+         */
+        getSolutions: (selectColumns: string[]) => Promise<{ value: Record<string, unknown>[] }>;
     }
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pptb/types",
-  "version": "1.0.1",
+  "version": "1.0.3",
   "description": "TypeScript type definitions for Power Platform Tool Box API",
   "main": "index.d.ts",
   "types": "index.d.ts",

package/toolboxAPI.d.ts

@@ -85,6 +85,7 @@ declare namespace ToolBoxAPI {
         shell?: string;
         cwd?: string;
         env?: Record<string, string>;
+        visible?: boolean; // Whether terminal should be visible initially (default: true)
     }
 
     /**
@@ -201,6 +202,40 @@ declare namespace ToolBoxAPI {
         off: (callback: (event: any, payload: ToolBoxEventPayload) => void) => void;
     }
 
+    /**
+     * Settings namespace - context-aware tool settings
+     * All settings operations automatically use the current tool's ID
+     */
+    export interface SettingsAPI {
+        /**
+         * 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>>;
+
+        /**
+         * 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>;
+
+        /**
+         * Set a specific setting by key
+         * @param key The setting key to set
+         * @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 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>;
+    }
+
     /**
      * Main ToolBox API exposed to tools via window.toolboxAPI
      */
@@ -215,6 +250,11 @@ declare namespace ToolBoxAPI {
          */
         utils: UtilsAPI;
 
+        /**
+         * Tool-specific settings (context-aware)
+         */
+        settings: SettingsAPI;
+
         /**
          * Terminal operations (context-aware)
          */