@collective-intelligence/extensions-sdk 0.1.8 → 0.1.10

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.
@@ -8,11 +8,11 @@ import type { DatasetParserImplementation } from "./dataset-parser.js";
8
8
  import type { ExternalDatasetProviderImplementation, ManagedDatasetProviderImplementation } from "./datasets.js";
9
9
  import type { ExternalAppGatewayDeclaration } from "./external-app-gateway.js";
10
10
  import type { ExternalApplicationAccessKey, ExternalApplicationDeclaration, ExternalApplicationRole } from "./external-application.js";
11
- import type { KnowledgeEntitySchemaDeclaration, KnowledgePolicyDeclaration, KnowledgeRelationSchemaDeclaration } from "./knowledge.js";
11
+ import type { KnowledgeEntitySchemaDeclaration, KnowledgeFieldSemantics, KnowledgeFileFieldDeclaration, KnowledgePolicyDeclaration, KnowledgeRelationSchemaDeclaration } from "./knowledge.js";
12
12
  import type { LifecycleOptions } from "./lifecycle.js";
13
13
  import type { OrganizationGroupDeclaration } from "./organization-group.js";
14
14
  import type { OrganizationSettingsDeclaration, VaryingOrganizationSettingsAuthentication, VaryingOrganizationSettingsSso } from "./organization-settings.js";
15
- import type { StudioAppDeclaration, StudioComponentDeclaration } from "./studio.js";
15
+ import type { StudioAppDeclaration, StudioAppDeclarationInput, StudioAppTemplateDeclaration, StudioComponentDeclaration } from "./studio.js";
16
16
  import type { RemoteToolCollectionDeclaration, RemoteToolCollectionDefinition, ToolCollectionDeclaration } from "./tools.js";
17
17
  import type { WorkflowDeclaration, WorkflowFieldCollectionDeclaration, WorkflowNodeCollectionDeclaration, WorkflowTemplateDeclaration, WorkflowTemplateGraphDefinition } from "./workflows.js";
18
18
  type MetadataDefinition<Manifest> = Manifest extends MetadataComponentManifest ? Omit<Manifest, "description" | "displayName" | "fqn" | "icon" | "kind" | "tags" | "version"> : never;
@@ -67,10 +67,18 @@ type OrganizationSettingsDefinitionInput = VaryingDefinition<Omit<MetadataDefini
67
67
  /** Declares the settings of the Organization that installs the package. */
68
68
  export declare const declareOrganizationSettings: (input: MetadataClassDeclaration<OrganizationSettingsDeclaration, OrganizationSettingsDefinitionInput>) => DeclaredComponent<OrganizationSettingsDeclaration>;
69
69
  export declare const declareSkillTemplate: (input: MetadataClassDeclaration<SkillTemplateDeclaration>) => DeclaredComponent<SkillTemplateDeclaration>;
70
- type KnowledgeEntityDefinitionInput<Schema> = Omit<MetadataDefinition<KnowledgeEntitySchemaDeclaration>, "schema"> & Readonly<{
70
+ /** Authored field semantics; File field entries come from `fileFields`. */
71
+ type KnowledgeFieldSemanticsInput = Readonly<Record<string, Omit<KnowledgeFieldSemantics, "file">>>;
72
+ /** Relation schemas take no File or relation field entries. */
73
+ type KnowledgeRelationFieldSemanticsInput = Readonly<Record<string, Omit<KnowledgeFieldSemantics, "file" | "relation">>>;
74
+ type KnowledgeEntityDefinitionInput<Schema> = Omit<MetadataDefinition<KnowledgeEntitySchemaDeclaration>, "fieldSemantics" | "schema"> & Readonly<{
75
+ fieldSemantics?: KnowledgeFieldSemanticsInput;
76
+ /** The File fields of the schema, by top-level property key. */
77
+ fileFields?: Readonly<Record<string, KnowledgeFileFieldDeclaration>>;
71
78
  schema: DecoderSource<Schema>;
72
79
  }>;
73
- type KnowledgeRelationDefinitionInput<Schema> = Omit<MetadataDefinition<KnowledgeRelationSchemaDeclaration>, "schema" | "lifecycle"> & Readonly<{
80
+ type KnowledgeRelationDefinitionInput<Schema> = Omit<MetadataDefinition<KnowledgeRelationSchemaDeclaration>, "fieldSemantics" | "schema" | "lifecycle"> & Readonly<{
81
+ fieldSemantics?: KnowledgeRelationFieldSemanticsInput;
74
82
  lifecycle: LifecycleOptions;
75
83
  schema: DecoderSource<Schema>;
76
84
  }>;
@@ -95,7 +103,14 @@ export declare const declareExternalAppGateway: (input: MetadataClassDeclaration
95
103
  export declare const declareRemoteToolCollection: (input: MetadataClassDeclaration<RemoteToolCollectionDeclaration, RemoteToolCollectionDefinition>) => DeclaredComponent<RemoteToolCollectionDeclaration>;
96
104
  export declare const declareWorkflowFieldCollection: (input: MetadataClassDeclaration<WorkflowFieldCollectionDeclaration>) => DeclaredComponent<WorkflowFieldCollectionDeclaration>;
97
105
  export declare const declareWorkflowNodeCollection: (input: MetadataClassDeclaration<WorkflowNodeCollectionDeclaration>) => DeclaredComponent<WorkflowNodeCollectionDeclaration>;
98
- export declare const declareStudioApp: (input: MetadataClassDeclaration<StudioAppDeclaration>) => DeclaredComponent<StudioAppDeclaration>;
106
+ /**
107
+ * Declares a Declared Studio App: CI creates and publishes it on install, and
108
+ * the package owns it. References become FQNs; a view's `triggerRef` prop
109
+ * also accepts the trigger handle.
110
+ */
111
+ export declare const declareStudioApp: (input: StudioAppDeclarationInput) => DeclaredComponent<StudioAppDeclaration>;
112
+ /** Declares a Studio App Template that the builder copies into a new app. */
113
+ export declare const declareStudioAppTemplate: (input: MetadataClassDeclaration<StudioAppTemplateDeclaration>) => DeclaredComponent<StudioAppTemplateDeclaration>;
99
114
  type StudioComponentDefinitionInput<Schema> = Omit<MetadataDefinition<StudioComponentDeclaration>, "propsSchema"> & Readonly<{
100
115
  propsSchema: DecoderSource<Schema>;
101
116
  }>;
@@ -0,0 +1,25 @@
1
+ import type { JsonObject } from "../foundation/json.js";
2
+ import type { ReadValue } from "../package/readers.js";
3
+ import type { AgentDeclaration } from "./agents.js";
4
+ import type { DeclaredComponent } from "./authoring-core.js";
5
+ import type { StudioTriggerFormField } from "./studio.js";
6
+ /**
7
+ * The Studio form of an Agent. `builtin:view.agent-form` renders its fields
8
+ * and runs the Agent with the filled values as the task. The fields are the
9
+ * trigger-form fields.
10
+ */
11
+ export type StudioAgentFormDeclaration = Readonly<{
12
+ fields: readonly StudioTriggerFormField[];
13
+ }>;
14
+ /** Admits Agent metadata whose Studio form, when present, is well formed. */
15
+ export declare const studioAgentMetadata: (read: ReadValue<JsonObject>) => ReadValue<JsonObject>;
16
+ /**
17
+ * Gives an Agent a Studio form. A field type that trigger forms do not
18
+ * declare, or a repeated field key, fails here with a `TypeError`.
19
+ */
20
+ export declare const withStudioAgentForm: (agent: DeclaredComponent<AgentDeclaration>, form: StudioAgentFormDeclaration) => DeclaredComponent<AgentDeclaration>;
21
+ /**
22
+ * The Studio form an Agent declares in its `metadata`, or `undefined` when it
23
+ * declares none. Throws a `TypeError` naming the first invalid location.
24
+ */
25
+ export declare const readStudioAgentForm: (metadata: JsonObject) => StudioAgentFormDeclaration | undefined;
@@ -1,7 +1,107 @@
1
1
  import type { JsonObject } from "../foundation/json.js";
2
- import type { PackageSchemaProjection } from "../schema/projection.js";
2
+ import type { ReadValue } from "../package/readers.js";
3
+ import type { JsonSchemaDocument, PackageSchemaProjection } from "../schema/projection.js";
4
+ import type { ComponentManifest, ComponentPresentation, DeclarationReference } from "./authoring-core.js";
3
5
  import type { PackagePrimitiveBase } from "./base.js";
4
6
  import type { LocalizedFieldText } from "./knowledge.js";
7
+ import type { WorkflowAuthoringTrigger } from "./workflows.js";
8
+ /** Content types a file field accepts unless it declares its own. */
9
+ export declare const defaultStudioTriggerFormFileAccept: readonly string[];
10
+ /** The largest file a file field accepts, and its default limit: 10 MiB. */
11
+ export declare const maxStudioTriggerFormFileBytes: number;
12
+ /**
13
+ * A field that uploads one file. Studio stores it as a private stored file of
14
+ * the Organization; the run reads `{{ trigger.form.<key>.storageFileId }}`.
15
+ */
16
+ export type StudioTriggerFormFileField = Readonly<{
17
+ /** Accepted content types; PDF, JPEG and PNG when omitted. */
18
+ accept?: readonly string[];
19
+ /** Names the value under the run's `form`; letters, digits and `_`. */
20
+ key: string;
21
+ label: string;
22
+ /** Largest accepted size in bytes; 10 MiB, also the ceiling, when omitted. */
23
+ maxBytes?: number;
24
+ type: "file";
25
+ }>;
26
+ /**
27
+ * A field that holds one value: a string (`text`, or multi-line `textarea`
28
+ * such as a Markdown body), a finite `number`, or a `boolean`.
29
+ */
30
+ export type StudioTriggerFormValueField = Readonly<{
31
+ key: string;
32
+ label: string;
33
+ type: "boolean" | "number" | "text" | "textarea";
34
+ }>;
35
+ /** A choice the user makes in an `enum` field. */
36
+ export type StudioTriggerFormOption = Readonly<{
37
+ label: string;
38
+ value: string;
39
+ }>;
40
+ /** A field that holds the `value` of one of its `options`. */
41
+ export type StudioTriggerFormEnumField = Readonly<{
42
+ key: string;
43
+ label: string;
44
+ options: readonly StudioTriggerFormOption[];
45
+ type: "enum";
46
+ }>;
47
+ /**
48
+ * A field that holds structured data, such as a nested object or list. Its
49
+ * value must satisfy the Draft 2020-12 JSON Schema `schema`; Studio edits it
50
+ * as JSON text.
51
+ */
52
+ export type StudioTriggerFormJsonField = Readonly<{
53
+ key: string;
54
+ label: string;
55
+ schema: JsonSchemaDocument;
56
+ type: "json";
57
+ }>;
58
+ /**
59
+ * A searchable multi-select of the Organization's Knowledge entities of the
60
+ * schema `schemaFqn`, among those the user may read. The run reads
61
+ * `{ entityIds, values }`: the picked entities' ids and, at the same index,
62
+ * each one's `valueKey` data field (its id when omitted), so
63
+ * `{{ trigger.form.<key>.values }}` binds the list of, for example, slugs.
64
+ */
65
+ export type StudioTriggerFormEntitiesField = Readonly<{
66
+ key: string;
67
+ label: string;
68
+ /** Data field each option shows; the entity name when omitted. */
69
+ labelKey?: string;
70
+ /** FQN of the Knowledge entity schema whose entities the user picks. */
71
+ schemaFqn: string;
72
+ type: "entities";
73
+ /**
74
+ * String data field the run takes for each pick, such as a unique `slug`;
75
+ * the entity id when omitted. An entity without it cannot be picked.
76
+ */
77
+ valueKey?: string;
78
+ }>;
79
+ /** A field of a Studio trigger form; its value lands at `form.<key>` of the run. */
80
+ export type StudioTriggerFormField = StudioTriggerFormEntitiesField | StudioTriggerFormEnumField | StudioTriggerFormFileField | StudioTriggerFormJsonField | StudioTriggerFormValueField;
81
+ /**
82
+ * The Studio form of a user-invoked Workflow trigger. Studio shows and runs
83
+ * the trigger only for users of `organizationGroup`.
84
+ */
85
+ export type StudioTriggerFormDeclaration = Readonly<{
86
+ /** Fields the user fills before running; none when omitted. */
87
+ fields?: readonly StudioTriggerFormField[];
88
+ /** FQN of the Organization Group whose users see and run the form. */
89
+ organizationGroup: string;
90
+ }>;
91
+ export type StudioTriggerFormInput = Omit<StudioTriggerFormDeclaration, "organizationGroup"> & Readonly<{
92
+ organizationGroup: DeclarationReference<"organizationGroup">;
93
+ }>;
94
+ /** Reads the fields of a Studio form; trigger and agent forms share them. */
95
+ export declare const studioFormFields: ReadValue<readonly StudioTriggerFormField[]>;
96
+ /** Admits trigger metadata whose Studio form, when present, is well formed. */
97
+ export declare const studioTriggerMetadata: (read: ReadValue<JsonObject>) => ReadValue<JsonObject>;
98
+ /** Gives a user-invoked Workflow trigger a Studio form. */
99
+ export declare const withStudioTriggerForm: (trigger: WorkflowAuthoringTrigger, { organizationGroup, ...form }: StudioTriggerFormInput) => WorkflowAuthoringTrigger;
100
+ /**
101
+ * The Studio form a trigger declares in its `metadata`, or `undefined` when it
102
+ * declares none. Throws a `TypeError` naming the first invalid location.
103
+ */
104
+ export declare const readStudioTriggerForm: (metadata: JsonObject) => StudioTriggerFormDeclaration | undefined;
5
105
  export type StudioComponentDeclaration = PackagePrimitiveBase<"studioComponent"> & Readonly<{
6
106
  category: "layout" | "page" | "primitive" | "view" | "widget";
7
107
  composition?: Readonly<{
@@ -16,10 +116,14 @@ export type StudioComponentDeclaration = PackagePrimitiveBase<"studioComponent">
16
116
  propsSchema: PackageSchemaProjection;
17
117
  sourceRef: string;
18
118
  }>;
19
- export type StudioAppDeclaration = PackagePrimitiveBase<"studioApp"> & Readonly<{
20
- definition: StudioAppDefinition;
119
+ /**
120
+ * A Studio App Template: a starting tree the builder copies into a new Studio
121
+ * app. The copy keeps no link to the template.
122
+ */
123
+ export type StudioAppTemplateDeclaration = PackagePrimitiveBase<"studioAppTemplate"> & Readonly<{
124
+ definition: StudioAppTemplateDefinition;
21
125
  }>;
22
- export type StudioAppPageDefinition = Readonly<{
126
+ export type StudioAppTemplatePageDefinition = Readonly<{
23
127
  fullWidth?: boolean;
24
128
  icon?: string;
25
129
  kind: "predefined";
@@ -29,8 +133,98 @@ export type StudioAppPageDefinition = Readonly<{
29
133
  routeSegment: string;
30
134
  slug: string;
31
135
  }>;
136
+ export type StudioAppTemplateSectionDefinition = Readonly<{
137
+ description?: string;
138
+ icon?: string;
139
+ label: string;
140
+ orderIndex: number;
141
+ pages: readonly StudioAppTemplatePageDefinition[];
142
+ slug: string;
143
+ }>;
144
+ export type StudioAppTemplateDefinition = Readonly<{
145
+ color?: string;
146
+ description?: string;
147
+ icon?: string;
148
+ isDefaultTemplate?: boolean;
149
+ name: string;
150
+ sections: readonly StudioAppTemplateSectionDefinition[];
151
+ slug: string;
152
+ }>;
153
+ /** The Studio role a Declared Grant gives its Group on a Declared Studio App. */
154
+ export type StudioAppRole = "manage" | "view";
155
+ /** A Declared Grant: one Organization Group holds one Studio role. */
156
+ export type StudioAppGrant = Readonly<{
157
+ /** FQN of the Organization Group. */
158
+ group: string;
159
+ role: StudioAppRole;
160
+ }>;
161
+ /**
162
+ * The only lifecycle of a Declared Studio App: each deploy upserts it, and
163
+ * nobody edits it in the builder.
164
+ */
165
+ export type StudioAppLifecycle = Readonly<{
166
+ deployMode: "upsert";
167
+ readonly: true;
168
+ }>;
169
+ /**
170
+ * Shows a Declared Studio Node only to users of `groups` (Organization Group
171
+ * FQNs). A node without it shows to every user who can open the app.
172
+ */
173
+ export type StudioNodeAccess = Readonly<{
174
+ groups: readonly string[];
175
+ }>;
176
+ /** The app shell: the built-in left sidebar, or a layout Studio Component. */
177
+ export type StudioAppLayoutDefinition = Readonly<{
178
+ componentRef: string;
179
+ kind: "custom";
180
+ props?: JsonObject;
181
+ }> | Readonly<{
182
+ kind: "left_sidebar";
183
+ }>;
184
+ /** Binds a view to the entities of one Knowledge entity schema (its FQN). */
185
+ export type StudioAppViewDataBinding = Readonly<{
186
+ filter?: JsonObject;
187
+ kind: "schema";
188
+ schema: string;
189
+ }>;
190
+ /**
191
+ * A view, or a Widget, placed in `slot` of its page at `orderIndex`. A
192
+ * built-in component is referenced by its FQN, such as
193
+ * `builtin:view.trigger-form@0.1.0`.
194
+ */
195
+ export type StudioAppViewDefinition = Readonly<{
196
+ access?: StudioNodeAccess;
197
+ componentRef: string;
198
+ dataBinding?: StudioAppViewDataBinding;
199
+ fqn: string;
200
+ orderIndex: number;
201
+ props?: JsonObject;
202
+ slot: string;
203
+ }>;
204
+ type StudioAppPageBase = Readonly<{
205
+ access?: StudioNodeAccess;
206
+ fqn: string;
207
+ fullHeight?: boolean;
208
+ fullWidth?: boolean;
209
+ icon?: string;
210
+ label: string;
211
+ orderIndex: number;
212
+ /** The page's stable route; prefill links stay valid across deploys. */
213
+ routeSegment: string;
214
+ slug: string;
215
+ }>;
216
+ /** A page that holds views, or a predefined page that a built-in renders. */
217
+ export type StudioAppPageDefinition = StudioAppPageBase & (Readonly<{
218
+ kind: "generic";
219
+ views: readonly StudioAppViewDefinition[];
220
+ }> | Readonly<{
221
+ kind: "predefined";
222
+ predefinedPageRef: string;
223
+ }>);
32
224
  export type StudioAppSectionDefinition = Readonly<{
225
+ access?: StudioNodeAccess;
33
226
  description?: string;
227
+ fqn: string;
34
228
  icon?: string;
35
229
  label: string;
36
230
  orderIndex: number;
@@ -41,8 +235,101 @@ export type StudioAppDefinition = Readonly<{
41
235
  color?: string;
42
236
  description?: string;
43
237
  icon?: string;
44
- isDefaultTemplate?: boolean;
238
+ /** The built-in left sidebar when omitted. */
239
+ layout?: StudioAppLayoutDefinition;
45
240
  name: string;
46
241
  sections: readonly StudioAppSectionDefinition[];
47
242
  slug: string;
48
243
  }>;
244
+ /**
245
+ * A Declared Studio App: CI creates and publishes it on install, the package
246
+ * owns it, and Organization Groups open it through its Declared Grants.
247
+ */
248
+ export type StudioAppDeclaration = PackagePrimitiveBase<"studioApp"> & Readonly<{
249
+ definition: StudioAppDefinition;
250
+ grants: Readonly<{
251
+ groups: readonly StudioAppGrant[];
252
+ }>;
253
+ lifecycle: StudioAppLifecycle;
254
+ }>;
255
+ type GroupReference = DeclarationReference<"organizationGroup">;
256
+ type ComponentReference = DeclarationReference<"studioComponent">;
257
+ /** A trigger handle, or the `triggerRef` of a user-invoked trigger. */
258
+ export type StudioTriggerReference = string | WorkflowAuthoringTrigger;
259
+ export type StudioNodeAccessInput = Readonly<{
260
+ groups: readonly GroupReference[];
261
+ }>;
262
+ /** View props; `triggerRef` also accepts the trigger handle. */
263
+ export type StudioAppViewPropsInput = JsonObject & Readonly<{
264
+ triggerRef?: StudioTriggerReference;
265
+ }>;
266
+ export type StudioAppViewInput = Omit<StudioAppViewDefinition, "access" | "componentRef" | "dataBinding" | "props"> & Readonly<{
267
+ access?: StudioNodeAccessInput;
268
+ componentRef: ComponentReference;
269
+ dataBinding?: Omit<StudioAppViewDataBinding, "schema"> & Readonly<{
270
+ schema: DeclarationReference<"knowledgeEntitySchema">;
271
+ }>;
272
+ props?: StudioAppViewPropsInput;
273
+ }>;
274
+ export type StudioAppPageInput = Omit<StudioAppPageBase, "access"> & Readonly<{
275
+ access?: StudioNodeAccessInput;
276
+ }> & (Readonly<{
277
+ kind: "generic";
278
+ views: readonly StudioAppViewInput[];
279
+ }> | Readonly<{
280
+ kind: "predefined";
281
+ predefinedPageRef: ComponentReference;
282
+ }>);
283
+ export type StudioAppSectionInput = Omit<StudioAppSectionDefinition, "access" | "pages"> & Readonly<{
284
+ access?: StudioNodeAccessInput;
285
+ pages: readonly StudioAppPageInput[];
286
+ }>;
287
+ export type StudioAppDefinitionInput = Omit<StudioAppDefinition, "layout" | "sections"> & Readonly<{
288
+ layout?: Readonly<{
289
+ componentRef: ComponentReference;
290
+ kind: "custom";
291
+ props?: JsonObject;
292
+ }> | Readonly<{
293
+ kind: "left_sidebar";
294
+ }>;
295
+ sections: readonly StudioAppSectionInput[];
296
+ }>;
297
+ /** What `declareStudioApp` takes. */
298
+ export type StudioAppDeclarationInput = Readonly<{
299
+ definition: Readonly<{
300
+ definition: StudioAppDefinitionInput;
301
+ grants: Readonly<{
302
+ groups: readonly Readonly<{
303
+ group: GroupReference;
304
+ role: StudioAppRole;
305
+ }>[];
306
+ }>;
307
+ lifecycle: StudioAppLifecycle;
308
+ }>;
309
+ manifest: ComponentManifest;
310
+ presentation: ComponentPresentation;
311
+ }>;
312
+ /** The manifest fields of a Declared Studio App, references as FQNs. */
313
+ export declare const studioAppManifestFields: ({ definition: { layout, sections, ...definition }, grants, lifecycle }: StudioAppDeclarationInput["definition"]) => Pick<StudioAppDeclaration, "definition" | "grants" | "lifecycle">;
314
+ /**
315
+ * The key of a declared view in its slot: the last segment of its FQN as a
316
+ * kebab-case name. Two views of one page slot cannot share it.
317
+ */
318
+ export declare const studioViewKey: (fqn: string) => string;
319
+ /** Reads a Declared Studio App; its lifecycle must be `upsert` + `readonly`. */
320
+ export declare const studioAppDeclaration: ReadValue<Readonly<{
321
+ description?: string;
322
+ displayName: string;
323
+ fqn: string;
324
+ icon?: string;
325
+ kind: "studioApp";
326
+ tags?: readonly string[];
327
+ version: string;
328
+ }> & Readonly<{
329
+ definition: StudioAppDefinition;
330
+ grants: Readonly<{
331
+ groups: readonly StudioAppGrant[];
332
+ }>;
333
+ lifecycle: StudioAppLifecycle;
334
+ }> & JsonObject>;
335
+ export {};
@@ -1,4 +1,4 @@
1
- import type { JsonObject } from "../foundation/json.js";
1
+ import type { JsonObject, JsonValue } from "../foundation/json.js";
2
2
  import type { PortableFormDefinition } from "../schema/forms.js";
3
3
  import type { PackageSchemaProjection } from "../schema/projection.js";
4
4
  import type { DeclarationReference } from "./authoring-core.js";
@@ -11,6 +11,21 @@ export type ToolGuidance = Readonly<{
11
11
  inputRequirementsSummary?: string;
12
12
  useWhen?: string;
13
13
  }>;
14
+ /** One unit of display data a tool returns next to its output; it never reaches the model. */
15
+ export type ToolDisplayPart = Readonly<{
16
+ data: JsonValue;
17
+ description?: string | null;
18
+ metadata?: JsonObject;
19
+ title?: string | null;
20
+ type: string;
21
+ }>;
22
+ export declare const toolResultBrand: unique symbol;
23
+ /** A branded tool result that carries Display Parts next to its output. */
24
+ export type ToolResultWithDisplay<Output> = Readonly<{
25
+ [toolResultBrand]: true;
26
+ displayParts: readonly ToolDisplayPart[];
27
+ output: Output;
28
+ }>;
14
29
  /** A companion tool bound alongside the declaring tool, e.g. a catalog lookup. */
15
30
  export type ToolExtraLoader = Readonly<{
16
31
  bindingName: string;
@@ -123,6 +138,8 @@ export type ToolSettingsOptionPage = Readonly<{
123
138
  options: readonly ToolSettingsOption[];
124
139
  }>;
125
140
  export type ToolSettingsOptionsContext = Readonly<{
141
+ /** Eligible image-output choices projected by the authorized Host; no runtime authority. */
142
+ imageModelOptions?: readonly Readonly<Pick<ToolSettingsOption, "id" | "label">>[];
126
143
  connectionCatalogs: Readonly<Record<string, JsonObject>>;
127
144
  connectionCredentials: Readonly<Record<string, Readonly<Record<string, string | null>>>>;
128
145
  dependencies: JsonObject;
@@ -0,0 +1,11 @@
1
+ /**
2
+ * Well-known ids of the built-in workflow code runtimes. Every Collective
3
+ * Intelligence deployment seeds them, so a package `code-block` node sets its
4
+ * `runtimeId` to one of these instead of a per-deployment id.
5
+ */
6
+ export declare const builtInCodeRuntimeIds: {
7
+ /** JavaScript on Node.js 24. */
8
+ readonly node24: "65eda637-e41c-43ea-81aa-0596439e8513";
9
+ /** Python 3.12. */
10
+ readonly python312: "ff5aca6d-99b3-40cc-bccb-37951b919bcb";
11
+ };
@@ -8,6 +8,8 @@ export type PackageWorkflowPauseResumeContract = Readonly<{
8
8
  decisions?: readonly string[];
9
9
  /** Approval only: the authored summary is safe to show Approvers. */
10
10
  discloseSummary?: boolean;
11
+ /** Approval only: `explicit` keeps the Request pending for the Invoker. */
12
+ invokerDecision?: "automatic" | "explicit";
11
13
  mode: string;
12
14
  payloadSchema?: JsonObject;
13
15
  resumePorts: readonly string[];
@@ -78,6 +80,10 @@ export type PackageWorkflowNodeDirective = Readonly<{
78
80
  headers: Readonly<Record<string, string>>;
79
81
  maxBytes: number;
80
82
  method: "DELETE" | "GET" | "HEAD" | "OPTIONS" | "PATCH" | "POST" | "PUT";
83
+ /** `json` makes the engine parse the response body into `json`. */
84
+ responseType?: "json" | "text";
85
+ /** Header name to organization secret name; the engine sends the value. */
86
+ secretHeaders?: Readonly<Record<string, string>>;
81
87
  timeoutSeconds: number;
82
88
  url: string;
83
89
  }>;
package/dist/index.d.ts CHANGED
@@ -16,9 +16,10 @@ export { declareKnowledgeEntityAdapter, declareConnection, declareDocumentsConne
16
16
  export { declareWorkflowNode } from "./components/workflow-node-authoring.js";
17
17
  export { resolveWorkflowNodePorts, WorkflowPortIssueCodes } from "./components/workflow-ports.js";
18
18
  export type { WorkflowNodePortsContract, WorkflowPortIssue, WorkflowPortIssueCode, WorkflowResolvedPorts } from "./components/workflow-ports.js";
19
+ export { builtInCodeRuntimeIds } from "./components/workflow-code-runtimes.js";
19
20
  export { workflowSchemaAt } from "./components/workflow-schema.js";
20
21
  export type { WorkflowSchemaLocation } from "./components/workflow-schema.js";
21
- export { declareDatasetParser, declareDomain, declareDomainTemplate, declareExternalApplication, declareExternalAppGateway, declareExternalDatasetProvider, declareKnowledgeEntitySchema, declareKnowledgePolicy, declareKnowledgeRelationSchema, declareManagedDatasetProvider, declareOrganizationGroup, declareOrganizationSettings, declareRemoteToolCollection, declareSkillTemplate, declareStudioApp, declareStudioComponent, declareToolCollection, declareWorkflow, declareWorkflowFieldCollection, declareWorkflowNodeCollection, declareWorkflowTemplate } from "./components/metadata-authoring.js";
22
+ export { declareDatasetParser, declareDomain, declareDomainTemplate, declareExternalApplication, declareExternalAppGateway, declareExternalDatasetProvider, declareKnowledgeEntitySchema, declareKnowledgePolicy, declareKnowledgeRelationSchema, declareManagedDatasetProvider, declareOrganizationGroup, declareOrganizationSettings, declareRemoteToolCollection, declareSkillTemplate, declareStudioApp, declareStudioAppTemplate, declareStudioComponent, declareToolCollection, declareWorkflow, declareWorkflowFieldCollection, declareWorkflowNodeCollection, declareWorkflowTemplate } from "./components/metadata-authoring.js";
22
23
  export { DATASET_TABLE_TEMPLATE_PHYSICAL_CODES, DATASET_TABLE_TEMPLATE_SEMANTIC_ROLES, declareDatasetBlueprint, declareDatasetTableTemplate, rejectUnsupportedDatasetTableTemplate } from "./components/templates.js";
23
24
  export { declarePackage } from "./package/definition.js";
24
25
  export { isVariableReference, packageVariables, packageVariableTypes, packageVariableViolation, variableReference } from "./package/variables.js";
@@ -29,19 +30,22 @@ export { BACKEND_EXECUTION_LANES, declareHostedContribution, FRONTEND_CATALOG_CO
29
30
  export type { BackendExecutionLane, BackendHostedContributionManifest, ExtensionHost, FrontendCatalogContract, FrontendCatalogContributionManifest, FrontendCatalogExportName, FrontendExtensionHost, HostedContributionDeclaration, HostedContributionInput, HostedContributionManifest, HostedContributionSourceIdentity } from "./hosted/contributions.js";
30
31
  export type { ComponentManifest, ComponentPresentation, DeclarationHandle, DeclarationReference, DeclaredComponent, DocumentsConnectorImplementation, PackageSchemaRuntimeSidecar, MetadataComponentManifest, ToolClassDeclaration, WorkflowFieldClassDeclaration, KnowledgeEntityAdapterClassDeclaration, ConnectionClassDeclaration, KnowledgeConnectorClassDeclaration, KnowledgeConnectorOAuthClassDeclaration, EventListenerClassDeclaration, FieldTransformerClassDeclaration, NotificationChannelClassDeclaration, KnowledgeRelationAdapterClassDeclaration, ToolSettingsOptionsClassDeclaration, WorkflowNodeClassDeclaration, WorkflowNodePortInput } from "./components/authoring-core.js";
31
32
  export type { DeclaredPackageComponent, DeclaredPackageManifest, PackageDefinition, PackageManifestInput, NormalizedPackageDefinition, PackageComponent } from "./package/definition.js";
32
- export type { StudioAppDeclaration, StudioAppDefinition, StudioAppPageDefinition, StudioAppSectionDefinition, StudioComponentDeclaration } from "./components/studio.js";
33
+ export type { StudioAppDeclaration, StudioAppDeclarationInput, StudioAppDefinition, StudioAppDefinitionInput, StudioAppGrant, StudioAppLayoutDefinition, StudioAppLifecycle, StudioAppPageDefinition, StudioAppPageInput, StudioAppRole, StudioAppSectionDefinition, StudioAppSectionInput, StudioAppTemplateDeclaration, StudioAppTemplateDefinition, StudioAppTemplatePageDefinition, StudioAppTemplateSectionDefinition, StudioAppViewDataBinding, StudioAppViewDefinition, StudioAppViewInput, StudioAppViewPropsInput, StudioNodeAccess, StudioNodeAccessInput, StudioTriggerReference, StudioComponentDeclaration, StudioTriggerFormDeclaration, StudioTriggerFormEntitiesField, StudioTriggerFormEnumField, StudioTriggerFormField, StudioTriggerFormFileField, StudioTriggerFormInput, StudioTriggerFormJsonField, StudioTriggerFormOption, StudioTriggerFormValueField } from "./components/studio.js";
34
+ export type { StudioAgentFormDeclaration } from "./components/studio-agent-form.js";
35
+ export { readStudioAgentForm, withStudioAgentForm } from "./components/studio-agent-form.js";
36
+ export { defaultStudioTriggerFormFileAccept, maxStudioTriggerFormFileBytes, readStudioTriggerForm, studioViewKey, withStudioTriggerForm } from "./components/studio.js";
33
37
  export type { FieldUiSchema, FieldValidationRule, FieldVisibilityRule, FormMarkdownBlock, FormDefinition, FormMetadata, FormSchemaSource, FormLayout, FormSection, FormSectionItem, FormStep, FormWidget, PlainFormWidget, PortableFormDefinition, SelectFormWidget, SelectOption as FormSelectOption, SelectOptions, StructuredFileBrowserOptions, StructuredFileUploadOptions, DynamicFormAiFillConfig, VisibilityCondition } from "./schema/forms.js";
34
38
  export { plainFormWidgets, selectFormWidgets } from "./schema/forms.js";
35
39
  export type { FieldOption, FieldOptionGroup, FieldOptionPage, FieldOptionsInput, FieldPart } from "./components/fields.js";
36
40
  export type { PackageWorkflowNodeExecutionResult, PackageWorkflowNodeDirective, PackageWorkflowPauseResumeContract, PackageWorkflowNodeResult } from "./components/workflow-results.js";
37
41
  export type { ConnectionDiscoveryCatalog, ConnectionDiscoveryCollection, ConnectionDiscoveryField, ConnectionDiscoveryMetadata, ConnectionDiscoveryMetadataValue, ConnectionDiscoveryRelationship, ConnectionDiscoveryResource, PackageConnectionProgress } from "./components/connections.js";
38
42
  export { canonicalPackageManifest, packageManifestJson } from "./package/canonical.js";
39
- export { parsePackageDependencyPins, resolvePackageDependencyOrder } from "./package/dependencies.js";
43
+ export { parsePackageDependencies, resolvePackageDependencyOrder } from "./package/dependencies.js";
40
44
  export { PackageManifestVersion } from "./package/manifest.js";
41
- export type { InstallationWizard, InstallationWizardStep, PackageDependencyPin, PackageManifest } from "./package/manifest.js";
45
+ export type { InstallationWizard, InstallationWizardStep, PackageDependency, PackageManifest } from "./package/manifest.js";
42
46
  export { canonicalExtensionReleaseManifest, ExtensionReleaseManifestVersion, PACKAGE_MEDIA_SIZE_LIMIT_BYTES, PackageMediaArchivePrefix, parseExtensionReleaseManifest } from "./release/manifest.js";
43
47
  export { parseExtensionReleaseArchive, validateExtensionReleaseArchiveMetadata } from "./release/archive.js";
44
- export { parseStoredExtensionReleaseManifest, withCurrentPrimitiveKinds } from "./release/stored-manifest.js";
48
+ export { parseStoredExtensionReleaseManifest, storedPrimitiveKind, withCurrentPrimitiveKinds } from "./release/stored-manifest.js";
45
49
  export type { BuildAttemptResult, ExtensionReleaseArchiveEntry, ExtensionReleaseAsset, ExtensionReleaseContribution, ExtensionReleaseManifest, ExtensionReleaseMedia, ExtensionReleasePrivateSourceMap } from "./release/manifest.js";
46
50
  export type { BindingScope, ConnectionReference, PackagePrimitiveBase, PackagePrimitiveKind } from "./components/base.js";
47
51
  export type { LifecycleDeployMode, LifecycleOptions } from "./components/lifecycle.js";
@@ -57,8 +61,9 @@ export type { AgentActivityPolicy, AgentAudience, AgentAudienceDeclaration, Agen
57
61
  export type { DocumentsDeltaCursorExpired, DocumentsDeltaItem, DocumentsDeltaPage, DocumentsDeltaRequest, DocumentsDrive, DocumentsDrivesPage, DocumentsFolder, DocumentsFoldersPage, DocumentsFetchedContent, DocumentsRootAncestry, DocumentsSource, KnowledgeEntityAdapterDeclaration, ConnectionDeclaration, DatasetParserDeclaration, ExternalDatasetProviderDeclaration, KnowledgeConnectorContribution, KnowledgeConnectorBindingExtraConfig, KnowledgeConnectorDeclaration, KnowledgeConnectorFieldMapRule, KnowledgeEntitySchemaCapability, KnowledgeConnectorOAuthDeclaration, KnowledgeConnectorOAuthTokens, KnowledgeConnectorRemoteReference, EventListenerDeclaration, EventListenerInternalOccurrence, EventListenerPollRequest, EventListenerPollResult, EventListenerWebhookRequest, KnowledgePredefinedSchedule, ManagedDatasetProviderDeclaration, KnowledgeRelationAdapterDeclaration, KnowledgeRelationSchemaCapability } from "./components/connectors.js";
58
62
  export type { PackagePrimitiveDeclaration } from "./components/declaration.js";
59
63
  export type { DatasetBlueprintClassDeclaration, DatasetBlueprintDeclaration, DatasetTableTemplateClassDeclaration, DatasetTableTemplateDeclaration, DatasetTableTemplateHint, DatasetTableTemplatePhysicalCode, DatasetTableTemplateSemanticRole, DatasetTableTemplateUniqueness } from "./components/templates.js";
60
- export type { EntityRelationField, KnowledgeAutocompleteConfiguration, KnowledgeAutocompleteFieldReference, KnowledgeEntitySchemaDeclaration, KnowledgeDisplayDefaults, KnowledgeFieldLocalization, KnowledgeFieldPresentation, KnowledgeFieldSemantics, KnowledgeManagedProjection, LocalizedFieldText, KnowledgePolicyDeclaration, KnowledgeRelationSchemaDeclaration } from "./components/knowledge.js";
61
- export type { FieldTransformerDeclaration, NotificationChannelDeclaration, RemoteToolCollectionDeclaration, RemoteToolCollectionDefinition, SetupInstructions, ToolCollectionDeclaration, ToolCollectionVisibilityGrant, ToolDeclaration, ToolExtraLoader, ToolGuidance, ToolHealthCheck, ToolSettingsOption, ToolSettingsOptionPage, ToolSettingsOptionsContext, ToolSettingsOptionsDeclaration } from "./components/tools.js";
64
+ export type { KnowledgeAutocompleteConfiguration, KnowledgeAutocompleteFieldReference, KnowledgeEntityRelationField, KnowledgeEntitySchemaDeclaration, KnowledgeDisplayDefaults, KnowledgeFieldLocalization, KnowledgeFieldPresentation, KnowledgeFieldSemantics, KnowledgeFileField, KnowledgeFileFieldDeclaration, KnowledgeManagedProjection, LocalizedFieldText, KnowledgePolicyDeclaration, KnowledgeRelationSchemaDeclaration } from "./components/knowledge.js";
65
+ export { toolResultBrand } from "./components/tools.js";
66
+ export type { FieldTransformerDeclaration, NotificationChannelDeclaration, RemoteToolCollectionDeclaration, RemoteToolCollectionDefinition, SetupInstructions, ToolCollectionDeclaration, ToolCollectionVisibilityGrant, ToolDeclaration, ToolDisplayPart, ToolExtraLoader, ToolGuidance, ToolHealthCheck, ToolResultWithDisplay, ToolSettingsOption, ToolSettingsOptionPage, ToolSettingsOptionsContext, ToolSettingsOptionsDeclaration } from "./components/tools.js";
62
67
  export type { WorkflowAuthoringActionEndpoint, WorkflowAuthoringDefinition, WorkflowAuthoringEdge, WorkflowAuthoringEdgeSource, WorkflowAuthoringEdgeTarget, WorkflowAuthoringFieldProjection, WorkflowAuthoringInputContract, WorkflowAuthoringInputEndpoint, WorkflowAuthoringNode, WorkflowAuthoringOutputBinding, WorkflowAuthoringOutputContract, WorkflowAuthoringOutputEndpoint, WorkflowAuthoringTemplateRef, WorkflowAuthoringTrigger, WorkflowAuthoringTriggerBinding, WorkflowAuthoringTriggerEndpoint, WorkflowAuthoredValue, WorkflowBindingExpression, WorkflowBindingSource, WorkflowBindingSpan, WorkflowDeclaration, WorkflowFieldCollectionDeclaration, WorkflowFieldContract, WorkflowFieldDeclaration, WorkflowConnectionRequirementDeclaration, WorkflowEditorDeclaration, WorkflowEditorFieldDeclaration, WorkflowEditorFieldOverride, WorkflowEditorOption, WorkflowEditorOptionSource, WorkflowEditorOverrides, WorkflowEditorSectionDeclaration, WorkflowEditorSectionOverride, WorkflowEditorValueSource, WorkflowEditorVisibilityRule, WorkflowEditorWidget, WorkflowEventIngressDeclaration, WorkflowEventSelectorProjection, WorkflowFieldBindingDeclaration, WorkflowDynamicPortDeclaration, WorkflowNodeContract, WorkflowNodeCollectionDeclaration, WorkflowNodeDeclaration, WorkflowNodeExecutionContract, WorkflowNodeExecutionSettings, WorkflowNodeInstancePolicy, WorkflowNodePortDeclaration, WorkflowOutputChannelDeclaration, WorkflowPortSchemaInjection, WorkflowPortSchemaResolution, WorkflowReusableDependencyDeclaration, WorkflowTemplateKind, WorkflowTriggerActivationDeclaration, WorkflowTemplateDeclaration, WorkflowTemplateGraphDefinition, WorkflowTemplateGraphSchemaContract, WorkflowTemplateUiLayout, WorkflowTriggerInvocation } from "./components/workflows.js";
63
68
  export type { JsonObject, JsonPrimitive, JsonValue } from "./foundation/json.js";
64
69
  export type { Bounds, Compatibility, ConnectorContext, DatasetAggregateOperation, DatasetBindingMode, DatasetDefinition, DatasetDeleteInput, DatasetDeleteResult, DatasetHealth, DatasetIngestInput, DatasetIngestMode, DatasetIngestResult, DatasetInspectInput, DatasetInspectResult, DatasetFilter, DatasetOperation, DatasetOrder, DatasetPredicate, DatasetPredicateOperator, DatasetQueryIntent, DatasetTimeBucket, DatasetProviderCapabilities, DatasetProviderError, DatasetProviderResult, DatasetProvisionInput, DatasetProvisionResult, DatasetRecordPage, DatasetResultPage, DatasetScalarType, DatasetSourceItem, DatasetSourceLocation, DatasetValue, DefinitionProposal, DiscoverDefinitionInput, ExternalDatasetBinding, ListSourcesInput, QueryInput, Readiness, ReadinessInput, SafeDiagnostic, SourcePage } from "./components/datasets.js";