@pptb/types 1.2.5 → 1.2.6-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 +17 -16
- package/package.json +2 -2
- package/toolboxAPI.d.ts +3 -1
package/README.md
CHANGED
|
@@ -106,22 +106,23 @@ npx pptb-validate path/to/package.json
|
|
|
106
106
|
|
|
107
107
|
The validator checks every field that the official review pipeline inspects:
|
|
108
108
|
|
|
109
|
-
| Field
|
|
110
|
-
|
|
|
111
|
-
| `name`
|
|
112
|
-
| `version`
|
|
113
|
-
| `displayName`
|
|
114
|
-
| `description`
|
|
115
|
-
| `license`
|
|
116
|
-
| `contributors`
|
|
117
|
-
| `configurations.repository`
|
|
118
|
-
| `configurations.readmeUrl`
|
|
119
|
-
| `configurations.website`
|
|
120
|
-
| `configurations.funding`
|
|
121
|
-
| `icon`
|
|
122
|
-
| `cspExceptions`
|
|
123
|
-
| `features.multiConnection`
|
|
124
|
-
| `features.
|
|
109
|
+
| Field | Required | Rules |
|
|
110
|
+
| -------------------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
|
|
111
|
+
| `name` | ✅ | Must be a string |
|
|
112
|
+
| `version` | ✅ | Must be a string |
|
|
113
|
+
| `displayName` | ✅ | Must be a string |
|
|
114
|
+
| `description` | ✅ | Must be a string |
|
|
115
|
+
| `license` | ✅ | Must be one of the approved OSS licenses (MIT, Apache-2.0, BSD-2-Clause, BSD-3-Clause, GPL-2.0, GPL-3.0, LGPL-3.0, ISC, AGPL-3.0-only) |
|
|
116
|
+
| `contributors` | ✅ | Non-empty array; each entry needs a `name` |
|
|
117
|
+
| `configurations.repository` | ✅ | Valid, reachable URL |
|
|
118
|
+
| `configurations.readmeUrl` | ✅ | Valid URL; must **not** be hosted on `github.com` (use `raw.githubusercontent.com`) |
|
|
119
|
+
| `configurations.website` | ❌ | Valid, reachable URL when provided |
|
|
120
|
+
| `configurations.funding` | ❌ | Valid, reachable URL when provided |
|
|
121
|
+
| `icon` | ❌ | Relative path to a `.svg` file bundled under `dist/`; must not be an HTTP URL or an absolute path |
|
|
122
|
+
| `cspExceptions` | ❌ | When present: must not be empty; only recognised directives; each directive must be a non-empty array |
|
|
123
|
+
| `features.multiConnection` | ❌\* | Required when `features` is present; must be `"required"`, `"optional"`, or `"none"` |
|
|
124
|
+
| `features.connectionRequirement` | ❌ | Must be `"required"` or `"optional"` when provided; defaults to `"required"`. `"optional"` lets the tool open with no connection selected |
|
|
125
|
+
| `features.minAPI` | ❌ | Valid semver string when provided |
|
|
125
126
|
|
|
126
127
|
> \* Required only when the `features` object is present.
|
|
127
128
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@pptb/types",
|
|
3
|
-
"version": "1.2.
|
|
3
|
+
"version": "1.2.6-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": "
|
|
26
|
+
"@pptb/validate": "1.0.2-beta.0"
|
|
27
27
|
},
|
|
28
28
|
"files": [
|
|
29
29
|
"index.d.ts",
|
package/toolboxAPI.d.ts
CHANGED
|
@@ -504,7 +504,9 @@ declare namespace ToolBoxAPI {
|
|
|
504
504
|
* `features.multiConnection: "required"` or `"optional"` and
|
|
505
505
|
* `options.secondaryConnectionId` is not provided, PPTB automatically shows
|
|
506
506
|
* the multi-connection selector before launching the callee. The Promise rejects
|
|
507
|
-
* if the user cancels the selector.
|
|
507
|
+
* if the user cancels the selector. This prompt is skipped entirely when the callee
|
|
508
|
+
* declares `features.connectionRequirement: "optional"`, since a connection is never
|
|
509
|
+
* mandatory for that tool.
|
|
508
510
|
*
|
|
509
511
|
* **`noReturn`**: pass `true` when the caller does not expect the callee to
|
|
510
512
|
* return data (e.g. a "Send To" pattern where data is only sent one-way).
|