@octonodes/sdk 0.1.12 → 0.2.0
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/PLUGINS.md +40 -0
- package/dist/gen/types.gen.d.ts +21 -0
- package/dist/gen/types.gen.d.ts.map +1 -1
- package/dist/plugins/schema/constants.d.ts +4 -0
- package/dist/plugins/schema/constants.d.ts.map +1 -1
- package/dist/plugins/schema/constants.js +5 -1
- package/dist/plugins/schema/constants.js.map +1 -1
- package/dist/plugins/schema/plugin/execution.constants.d.ts +8 -0
- package/dist/plugins/schema/plugin/execution.constants.d.ts.map +1 -0
- package/dist/plugins/schema/plugin/execution.constants.js +12 -0
- package/dist/plugins/schema/plugin/execution.constants.js.map +1 -0
- package/dist/plugins/schema/plugin/execution.d.ts +1070 -0
- package/dist/plugins/schema/plugin/execution.d.ts.map +1 -0
- package/dist/plugins/schema/plugin/execution.js +43 -0
- package/dist/plugins/schema/plugin/execution.js.map +1 -0
- package/dist/plugins/schema/plugin-publishing.d.ts +396 -0
- package/dist/plugins/schema/plugin-publishing.d.ts.map +1 -0
- package/dist/plugins/schema/plugin-publishing.js +57 -0
- package/dist/plugins/schema/plugin-publishing.js.map +1 -0
- package/dist/plugins/schema/plugin-sdk/index.d.ts +4 -1
- package/dist/plugins/schema/plugin-sdk/index.d.ts.map +1 -1
- package/dist/plugins/schema/plugin-sdk/index.js +9 -1
- package/dist/plugins/schema/plugin-sdk/index.js.map +1 -1
- package/dist/plugins/schema/plugin-version.d.ts +8 -0
- package/dist/plugins/schema/plugin-version.d.ts.map +1 -0
- package/dist/plugins/schema/plugin-version.js +61 -0
- package/dist/plugins/schema/plugin-version.js.map +1 -0
- package/dist/plugins/schema/plugin.d.ts +10 -0
- package/dist/plugins/schema/plugin.d.ts.map +1 -1
- package/dist/plugins/schema/plugin.js +6 -0
- package/dist/plugins/schema/plugin.js.map +1 -1
- package/dist/plugins/sdk/plugin.d.ts.map +1 -1
- package/dist/plugins/sdk/plugin.js +2 -1
- package/dist/plugins/sdk/plugin.js.map +1 -1
- package/dist/plugins/sdk/plugins/index.d.ts +3 -0
- package/dist/plugins/sdk/plugins/index.d.ts.map +1 -1
- package/dist/plugins/sdk/plugins/index.js +12 -1
- package/dist/plugins/sdk/plugins/index.js.map +1 -1
- package/package.json +1 -1
package/PLUGINS.md
CHANGED
|
@@ -324,3 +324,43 @@ inventories, project override precedence, npm argument/default behavior,
|
|
|
324
324
|
workflow runtime integrity, artifact relocation, and existing installation flows.
|
|
325
325
|
Decorators, executable configuration, multiple plugins in one package, custom
|
|
326
326
|
canvas renderers, and another manifest format remain outside this contract.
|
|
327
|
+
|
|
328
|
+
## Release files and GitHub publishing
|
|
329
|
+
|
|
330
|
+
SDK/CLI `0.2.0` supports `plugin.octonode.json`, `.yml`, and `.yaml` beside
|
|
331
|
+
`octonode.plugin.ts`. Keep exactly one release file. For example:
|
|
332
|
+
|
|
333
|
+
```json
|
|
334
|
+
{
|
|
335
|
+
"apiVersion": "octonode.plugin/v1",
|
|
336
|
+
"id": "my-plugin",
|
|
337
|
+
"version": "1.0.0",
|
|
338
|
+
"scope": "public"
|
|
339
|
+
}
|
|
340
|
+
```
|
|
341
|
+
|
|
342
|
+
The ID must match the TypeScript plugin. Release-file version, scope, and optional
|
|
343
|
+
contributors override the corresponding code metadata during compilation. Other
|
|
344
|
+
metadata and all node definitions remain in TypeScript. Scope can be `user`, `public`,
|
|
345
|
+
`team` with `teamId`, or `organization` with `orgId`.
|
|
346
|
+
|
|
347
|
+
`octonodes plugin version patch` updates the release file (also accepts `minor`,
|
|
348
|
+
`major`, or an exact version). `octonodes login` followed by
|
|
349
|
+
`octonodes plugin deploy .` builds, validates, hashes and publishes to
|
|
350
|
+
`https://plugins.octonodes.com`, using your existing account.
|
|
351
|
+
|
|
352
|
+
For automatic releases, connect the GitHub App repository and release-file path
|
|
353
|
+
in **Partner → GitHub publishing**, review its target, and enable publishing.
|
|
354
|
+
Use a GitHub sign-in with `repo` and `read:org` scopes. Installation requires the
|
|
355
|
+
personal account owner or an active organization admin; release review and consent
|
|
356
|
+
also require current repository admin permission.
|
|
357
|
+
Commit the downloaded workflow at `.github/workflows/octonode-publish.yml` (or the
|
|
358
|
+
explicit `workflow` path in your config). It runs
|
|
359
|
+
`octonodes plugin deploy . --github` with GitHub Actions `id-token: write`.
|
|
360
|
+
No marketplace secret is required. Only the authorized default-branch workflow
|
|
361
|
+
can publish; changing the target requires reconnection. Existing versions are
|
|
362
|
+
skipped; new bytes require a new version. Installed project pins remain unchanged.
|
|
363
|
+
|
|
364
|
+
Requires deployment of the corresponding engine/control-plane changes and
|
|
365
|
+
publication of SDK/CLI `0.2.0` or newer. Updating the source or opening a PR does not
|
|
366
|
+
apply production migrations, deploy Workers, or publish npm packages.
|
package/dist/gen/types.gen.d.ts
CHANGED
|
@@ -51,6 +51,8 @@ export type GetApiRunsData = {
|
|
|
51
51
|
query?: {
|
|
52
52
|
project?: string;
|
|
53
53
|
workflowId?: string;
|
|
54
|
+
search?: string;
|
|
55
|
+
status?: 'ok' | 'error' | 'partial';
|
|
54
56
|
cursor?: string;
|
|
55
57
|
offset?: number;
|
|
56
58
|
limit?: number;
|
|
@@ -89,6 +91,8 @@ export type GetApiRunsResponses = {
|
|
|
89
91
|
code: string;
|
|
90
92
|
message: string;
|
|
91
93
|
retryable?: boolean;
|
|
94
|
+
details?: unknown;
|
|
95
|
+
stack?: string;
|
|
92
96
|
};
|
|
93
97
|
note?: 'disabled' | 'pinned' | 'upstream-of-from-node';
|
|
94
98
|
};
|
|
@@ -175,6 +179,8 @@ export type GetApiRunsByRunIdResponses = {
|
|
|
175
179
|
code: string;
|
|
176
180
|
message: string;
|
|
177
181
|
retryable?: boolean;
|
|
182
|
+
details?: unknown;
|
|
183
|
+
stack?: string;
|
|
178
184
|
};
|
|
179
185
|
note?: 'disabled' | 'pinned' | 'upstream-of-from-node';
|
|
180
186
|
};
|
|
@@ -2978,6 +2984,8 @@ export type PostApiWorkflowsByWorkflowIdTriggersByTriggerIdEventsResponses = {
|
|
|
2978
2984
|
code: string;
|
|
2979
2985
|
message: string;
|
|
2980
2986
|
retryable?: boolean;
|
|
2987
|
+
details?: unknown;
|
|
2988
|
+
stack?: string;
|
|
2981
2989
|
};
|
|
2982
2990
|
note?: 'disabled' | 'pinned' | 'upstream-of-from-node';
|
|
2983
2991
|
};
|
|
@@ -3110,6 +3118,8 @@ export type PostApiWorkflowsByWorkflowIdExecutionsResponses = {
|
|
|
3110
3118
|
code: string;
|
|
3111
3119
|
message: string;
|
|
3112
3120
|
retryable?: boolean;
|
|
3121
|
+
details?: unknown;
|
|
3122
|
+
stack?: string;
|
|
3113
3123
|
};
|
|
3114
3124
|
note?: 'disabled' | 'pinned' | 'upstream-of-from-node';
|
|
3115
3125
|
};
|
|
@@ -3188,6 +3198,8 @@ export type GetApiExecutionsByRunIdResponses = {
|
|
|
3188
3198
|
code: string;
|
|
3189
3199
|
message: string;
|
|
3190
3200
|
retryable?: boolean;
|
|
3201
|
+
details?: unknown;
|
|
3202
|
+
stack?: string;
|
|
3191
3203
|
};
|
|
3192
3204
|
note?: 'disabled' | 'pinned' | 'upstream-of-from-node';
|
|
3193
3205
|
};
|
|
@@ -3383,6 +3395,11 @@ export type GetApiWorkflowsByWorkflowIdNodeCatalogData = {
|
|
|
3383
3395
|
workflowId: string;
|
|
3384
3396
|
};
|
|
3385
3397
|
query?: {
|
|
3398
|
+
workspace?: string;
|
|
3399
|
+
project?: string;
|
|
3400
|
+
view?: string;
|
|
3401
|
+
snapshot?: 'true';
|
|
3402
|
+
nativeRevision?: string;
|
|
3386
3403
|
q?: string;
|
|
3387
3404
|
offset?: number;
|
|
3388
3405
|
limit?: number;
|
|
@@ -3403,6 +3420,9 @@ export type GetApiWorkflowsByWorkflowIdNodeCatalogResponses = {
|
|
|
3403
3420
|
* Success
|
|
3404
3421
|
*/
|
|
3405
3422
|
200: {
|
|
3423
|
+
nativeRevision?: string;
|
|
3424
|
+
revision?: string;
|
|
3425
|
+
complete?: boolean;
|
|
3406
3426
|
items: Array<{
|
|
3407
3427
|
id: string;
|
|
3408
3428
|
label: string;
|
|
@@ -4156,6 +4176,7 @@ export type GetApiMarketplaceData = {
|
|
|
4156
4176
|
body?: never;
|
|
4157
4177
|
path?: never;
|
|
4158
4178
|
query?: {
|
|
4179
|
+
workspace?: string;
|
|
4159
4180
|
q?: string;
|
|
4160
4181
|
category?: string;
|
|
4161
4182
|
tag?: string;
|