@pptb/types 1.2.7-beta.0 → 1.2.7-beta.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +52 -51
- package/package.json +2 -2
- package/pptbConfig.d.ts +4 -0
package/README.md
CHANGED
|
@@ -3,57 +3,57 @@
|
|
|
3
3
|
TypeScript type definitions for Power Platform ToolBox APIs, plus a built-in CLI validator that checks your tool's `package.json` against the official review criteria before you publish to npm.
|
|
4
4
|
|
|
5
5
|
- [@pptb/types](#pptbtypes)
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
6
|
+
- [Installation](#installation)
|
|
7
|
+
- [Tool Validation](#tool-validation)
|
|
8
|
+
- [Quick start](#quick-start)
|
|
9
|
+
- [CLI options](#cli-options)
|
|
10
|
+
- [What is validated](#what-is-validated)
|
|
11
|
+
- [pptb.config.json (optional)](#pptbconfigjson-optional)
|
|
12
|
+
- [Additional Headers and Batch Operations](#additional-headers-and-batch-operations)
|
|
13
|
+
- [Overview](#overview)
|
|
14
|
+
- [Usage](#usage)
|
|
15
|
+
- [Include all type definitions](#include-all-type-definitions)
|
|
16
|
+
- [Include specific API types](#include-specific-api-types)
|
|
17
|
+
- [ToolBox API Examples](#toolbox-api-examples)
|
|
18
|
+
- [Connections](#connections)
|
|
19
|
+
- [Utilities](#utilities)
|
|
20
|
+
- [Terminal Operations](#terminal-operations)
|
|
21
|
+
- [Events](#events)
|
|
22
|
+
- [Inter-Tool Invocation](#inter-tool-invocation)
|
|
23
|
+
- [Caller: launching another tool with prefill data](#caller-launching-another-tool-with-prefill-data)
|
|
24
|
+
- [Caller: tag-based capability discovery](#caller-tag-based-capability-discovery)
|
|
25
|
+
- [Caller: tag-based capability discovery](#caller-tag-based-capability-discovery-1)
|
|
26
|
+
- [Callee: reading prefill data and returning a result](#callee-reading-prefill-data-and-returning-a-result)
|
|
27
|
+
- [Declaring your invocation contract](#declaring-your-invocation-contract)
|
|
28
|
+
- [Dataverse API Examples](#dataverse-api-examples)
|
|
29
|
+
- [CRUD Operations](#crud-operations)
|
|
30
|
+
- [FetchXML Queries](#fetchxml-queries)
|
|
31
|
+
- [Metadata Operations](#metadata-operations)
|
|
32
|
+
- [Execute Actions/Functions](#execute-actionsfunctions)
|
|
33
|
+
- [Deploy Solutions](#deploy-solutions)
|
|
34
|
+
- [Power Platform API Examples](#power-platform-api-examples)
|
|
35
|
+
- [Using Power Apps API](#using-power-apps-api)
|
|
36
|
+
- [Using Power Automate API](#using-power-automate-api)
|
|
37
|
+
- [Using Environment Management API](#using-environment-management-api)
|
|
38
|
+
- [Using Governance API](#using-governance-api)
|
|
39
|
+
- [Available Categories](#available-categories)
|
|
40
|
+
- [API Reference](#api-reference)
|
|
41
|
+
- [ToolBox API (`window.toolboxAPI`)](#toolbox-api-windowtoolboxapi)
|
|
42
|
+
- [Connections](#connections-1)
|
|
43
|
+
- [Utils](#utils)
|
|
44
|
+
- [Terminal](#terminal)
|
|
45
|
+
- [Events](#events-1)
|
|
46
|
+
- [Invocation](#invocation)
|
|
47
|
+
- [Dataverse API (`window.dataverseAPI`)](#dataverse-api-windowdataverseapi)
|
|
48
|
+
- [CRUD Operations](#crud-operations-1)
|
|
49
|
+
- [Query Operations](#query-operations)
|
|
50
|
+
- [Metadata Operations](#metadata-operations-1)
|
|
51
|
+
- [Advanced Operations](#advanced-operations)
|
|
52
|
+
- [Power Platform API (`window.powerplatformAPI`)](#power-platform-api-windowpowerplatformapi)
|
|
53
|
+
- [Category Methods](#category-methods)
|
|
54
|
+
- [Security Notes](#security-notes)
|
|
55
|
+
- [Publishing the package to npm](#publishing-the-package-to-npm)
|
|
56
|
+
- [License](#license)
|
|
57
57
|
|
|
58
58
|
## Installation
|
|
59
59
|
|
|
@@ -170,6 +170,7 @@ In addition to `package.json`, the validator automatically checks a `pptb.config
|
|
|
170
170
|
},
|
|
171
171
|
"agents": {
|
|
172
172
|
"version": "1.0.0",
|
|
173
|
+
"headless": false,
|
|
173
174
|
"invokable": true,
|
|
174
175
|
"modes": ["one-way", "two-way"],
|
|
175
176
|
"defaultMode": "two-way",
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@pptb/types",
|
|
3
|
-
"version": "1.2.7-beta.
|
|
3
|
+
"version": "1.2.7-beta.1",
|
|
4
4
|
"description": "Type definitions for Power Platform ToolBox APIs and validity checks for tool packages",
|
|
5
5
|
"main": "index.d.ts",
|
|
6
6
|
"types": "index.d.ts",
|
|
@@ -23,7 +23,7 @@
|
|
|
23
23
|
"pptb-validate": "./bin/pptb-validate.js"
|
|
24
24
|
},
|
|
25
25
|
"dependencies": {
|
|
26
|
-
"@pptb/validate": "1.0.
|
|
26
|
+
"@pptb/validate": "1.0.3"
|
|
27
27
|
},
|
|
28
28
|
"files": [
|
|
29
29
|
"index.d.ts",
|
package/pptbConfig.d.ts
CHANGED
|
@@ -28,6 +28,7 @@
|
|
|
28
28
|
* },
|
|
29
29
|
* "agents": {
|
|
30
30
|
* "version": "1.0.0",
|
|
31
|
+
* "headless": false,
|
|
31
32
|
* "invokable": true,
|
|
32
33
|
* "modes": ["one-way", "two-way"],
|
|
33
34
|
* "defaultMode": "two-way",
|
|
@@ -107,6 +108,7 @@ export type AgentInvocationMode = "one-way" | "two-way";
|
|
|
107
108
|
* Agent-specific launch contract for external automation callers.
|
|
108
109
|
*
|
|
109
110
|
* - `version`: semantic version for the agent-facing contract.
|
|
111
|
+
* - `headless`: whether the tool supports headless execution (required when agents is present).
|
|
110
112
|
* - `invokable`: opt-in flag that exposes the tool to the MCP server.
|
|
111
113
|
* - `modes`: supported MCP invocation modes for this tool.
|
|
112
114
|
* - `defaultMode`: fallback mode when the caller does not specify one.
|
|
@@ -115,6 +117,8 @@ export type AgentInvocationMode = "one-way" | "two-way";
|
|
|
115
117
|
export interface AgentsConfig {
|
|
116
118
|
/** Semantic version of this agent contract. */
|
|
117
119
|
version: string;
|
|
120
|
+
/** Whether the tool supports headless execution. */
|
|
121
|
+
headless: boolean;
|
|
118
122
|
/** Whether the tool may be invoked by an external agent. */
|
|
119
123
|
invokable?: boolean;
|
|
120
124
|
/** Invocation modes supported by the tool when called by an agent. */
|