@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.
- package/README.md +303 -28
- package/dist/components/agents.d.ts +2 -0
- package/dist/components/authoring-core.d.ts +2 -2
- package/dist/components/base.d.ts +1 -1
- package/dist/components/connectors.d.ts +27 -1
- package/dist/components/declaration.d.ts +2 -2
- package/dist/components/knowledge.d.ts +59 -14
- package/dist/components/metadata-authoring.d.ts +20 -5
- package/dist/components/studio-agent-form.d.ts +25 -0
- package/dist/components/studio.d.ts +292 -5
- package/dist/components/tools.d.ts +18 -1
- package/dist/components/workflow-code-runtimes.d.ts +11 -0
- package/dist/components/workflow-results.d.ts +6 -0
- package/dist/index.d.ts +12 -7
- package/dist/index.js +2 -1
- package/dist/package/dependencies.d.ts +3 -3
- package/dist/package/knowledge-readers.d.ts +27 -14
- package/dist/package/manifest.d.ts +2 -4
- package/dist/package/presentation-readers.d.ts +2 -20
- package/dist/package/primitive-readers.d.ts +18 -35
- package/dist/release/stored-manifest.d.ts +8 -1
- package/package.json +1 -1
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import type { PackageDefinition } from "./definition.js";
|
|
2
|
-
import type {
|
|
3
|
-
/** Validates
|
|
4
|
-
export declare const
|
|
2
|
+
import type { PackageDependency } from "./manifest.js";
|
|
3
|
+
/** Validates FQN requirements and orders them by package identity. */
|
|
4
|
+
export declare const parsePackageDependencies: (value: unknown) => readonly PackageDependency[];
|
|
5
5
|
/**
|
|
6
6
|
* Validates package-to-package references and returns a dependency-first
|
|
7
7
|
* order. Discovery uses this once, rather than repeatedly walking imports or
|
|
@@ -1,29 +1,37 @@
|
|
|
1
1
|
import type * as K from "../components/knowledge.js";
|
|
2
|
-
|
|
2
|
+
import type { ReadValue } from "./readers.js";
|
|
3
|
+
export declare const overviewInputMaxChars: ReadValue<number | null | undefined>;
|
|
4
|
+
export declare const richEnrichment: ReadValue<boolean | null | undefined>;
|
|
5
|
+
export declare const fieldSemantics: ReadValue<Readonly<{
|
|
6
|
+
overviewInputMaxChars?: number | null;
|
|
7
|
+
richEnrichment?: boolean | null;
|
|
3
8
|
defaultSearch?: boolean;
|
|
4
9
|
embedded?: boolean;
|
|
10
|
+
includeInItemEmbedding?: boolean;
|
|
5
11
|
faceted?: boolean;
|
|
12
|
+
file?: K.KnowledgeFileField;
|
|
6
13
|
indexContent?: boolean;
|
|
7
14
|
indexOverview?: boolean;
|
|
8
15
|
indexed?: boolean;
|
|
9
16
|
managedProjectionSource?: "organization_group" | "organization_user";
|
|
10
17
|
mediaVisibility?: "private" | "protected" | "public";
|
|
11
18
|
queryGuidance?: string;
|
|
19
|
+
relation?: K.KnowledgeEntityRelationField;
|
|
12
20
|
unique?: boolean;
|
|
13
21
|
}> & import("../index.js").JsonObject>;
|
|
14
|
-
export declare const managedProjection:
|
|
22
|
+
export declare const managedProjection: ReadValue<Readonly<{
|
|
15
23
|
connectorPolicy: "allow" | "deny_schema";
|
|
16
24
|
genericMutationPolicy: "deny_managed_fields" | "deny_schema";
|
|
17
25
|
kind: "directory_person" | "directory_person_in_group" | "directory_group" | "directory_group_parent";
|
|
18
26
|
source: "organization_group" | "organization_group_hierarchy" | "organization_group_membership" | "organization_user";
|
|
19
27
|
}> & import("../index.js").JsonObject>;
|
|
20
|
-
export declare const fieldLocalization:
|
|
28
|
+
export declare const fieldLocalization: ReadValue<Readonly<{
|
|
21
29
|
description?: K.LocalizedFieldText;
|
|
22
30
|
help?: K.LocalizedFieldText;
|
|
23
31
|
label?: K.LocalizedFieldText;
|
|
24
32
|
placeholder?: K.LocalizedFieldText;
|
|
25
33
|
}> & import("../index.js").JsonObject>;
|
|
26
|
-
export declare const fieldPresentation:
|
|
34
|
+
export declare const fieldPresentation: ReadValue<Readonly<{
|
|
27
35
|
copyable?: boolean;
|
|
28
36
|
editor?: string;
|
|
29
37
|
editorOptions?: Readonly<{
|
|
@@ -59,24 +67,24 @@ export declare const fieldPresentation: import("./readers.js").ReadValue<Readonl
|
|
|
59
67
|
renderer?: string;
|
|
60
68
|
trueLabel?: string;
|
|
61
69
|
}> & import("../index.js").JsonObject>;
|
|
62
|
-
export declare const lifecycle:
|
|
70
|
+
export declare const lifecycle: ReadValue<Readonly<{
|
|
63
71
|
deployMode: import("../index.js").LifecycleDeployMode;
|
|
64
72
|
readonly: boolean;
|
|
65
73
|
}> & import("../index.js").JsonObject>;
|
|
66
|
-
export declare const autocompleteConfiguration:
|
|
74
|
+
export declare const autocompleteConfiguration: ReadValue<Readonly<{
|
|
67
75
|
autocompleteFields: readonly K.KnowledgeAutocompleteFieldReference[];
|
|
68
76
|
defaultAutocompleteFields: readonly K.KnowledgeAutocompleteFieldReference[];
|
|
69
77
|
}> & import("../index.js").JsonObject>;
|
|
70
78
|
export declare const knowledgeSchema: {
|
|
71
|
-
catalogTags:
|
|
72
|
-
domainFqn:
|
|
73
|
-
fieldLocalization:
|
|
79
|
+
catalogTags: ReadValue<Readonly<Record<string, readonly string[]>> | undefined>;
|
|
80
|
+
domainFqn: ReadValue<string>;
|
|
81
|
+
fieldLocalization: ReadValue<Readonly<Record<string, Readonly<{
|
|
74
82
|
description?: K.LocalizedFieldText;
|
|
75
83
|
help?: K.LocalizedFieldText;
|
|
76
84
|
label?: K.LocalizedFieldText;
|
|
77
85
|
placeholder?: K.LocalizedFieldText;
|
|
78
86
|
}> & import("../index.js").JsonObject>> | undefined>;
|
|
79
|
-
fieldPresentation:
|
|
87
|
+
fieldPresentation: ReadValue<Readonly<Record<string, Readonly<{
|
|
80
88
|
copyable?: boolean;
|
|
81
89
|
editor?: string;
|
|
82
90
|
editorOptions?: Readonly<{
|
|
@@ -112,26 +120,31 @@ export declare const knowledgeSchema: {
|
|
|
112
120
|
renderer?: string;
|
|
113
121
|
trueLabel?: string;
|
|
114
122
|
}> & import("../index.js").JsonObject>> | undefined>;
|
|
115
|
-
fieldSemantics:
|
|
123
|
+
fieldSemantics: ReadValue<Readonly<Record<string, Readonly<{
|
|
124
|
+
overviewInputMaxChars?: number | null;
|
|
125
|
+
richEnrichment?: boolean | null;
|
|
116
126
|
defaultSearch?: boolean;
|
|
117
127
|
embedded?: boolean;
|
|
128
|
+
includeInItemEmbedding?: boolean;
|
|
118
129
|
faceted?: boolean;
|
|
130
|
+
file?: K.KnowledgeFileField;
|
|
119
131
|
indexContent?: boolean;
|
|
120
132
|
indexOverview?: boolean;
|
|
121
133
|
indexed?: boolean;
|
|
122
134
|
managedProjectionSource?: "organization_group" | "organization_user";
|
|
123
135
|
mediaVisibility?: "private" | "protected" | "public";
|
|
124
136
|
queryGuidance?: string;
|
|
137
|
+
relation?: K.KnowledgeEntityRelationField;
|
|
125
138
|
unique?: boolean;
|
|
126
139
|
}> & import("../index.js").JsonObject>> | undefined>;
|
|
127
|
-
localMutationPolicy:
|
|
128
|
-
managedProjection:
|
|
140
|
+
localMutationPolicy: ReadValue<"always" | "connector_backed" | "never" | undefined>;
|
|
141
|
+
managedProjection: ReadValue<(Readonly<{
|
|
129
142
|
connectorPolicy: "allow" | "deny_schema";
|
|
130
143
|
genericMutationPolicy: "deny_managed_fields" | "deny_schema";
|
|
131
144
|
kind: "directory_person" | "directory_person_in_group" | "directory_group" | "directory_group_parent";
|
|
132
145
|
source: "organization_group" | "organization_group_hierarchy" | "organization_group_membership" | "organization_user";
|
|
133
146
|
}> & import("../index.js").JsonObject) | undefined>;
|
|
134
|
-
schema:
|
|
147
|
+
schema: ReadValue<Readonly<{
|
|
135
148
|
dialect: typeof import("../index.js").Draft202012Dialect;
|
|
136
149
|
document: import("../index.js").JsonSchemaDocument;
|
|
137
150
|
fidelity: import("../index.js").ProjectionFidelity;
|
|
@@ -14,10 +14,8 @@ export type InstallationWizardStep = Readonly<{
|
|
|
14
14
|
ref: string;
|
|
15
15
|
title?: string;
|
|
16
16
|
}>;
|
|
17
|
-
export type
|
|
17
|
+
export type PackageDependency = Readonly<{
|
|
18
18
|
fqn: string;
|
|
19
|
-
releaseId: string;
|
|
20
|
-
releaseDigest: string;
|
|
21
19
|
}>;
|
|
22
20
|
export type PackageManifest = Readonly<{
|
|
23
21
|
apiVersion: typeof PackageManifestVersion;
|
|
@@ -25,7 +23,7 @@ export type PackageManifest = Readonly<{
|
|
|
25
23
|
autoInstallable?: boolean;
|
|
26
24
|
bindingScopes?: readonly ("organization" | "tenant")[];
|
|
27
25
|
category?: string;
|
|
28
|
-
dependencies?: readonly
|
|
26
|
+
dependencies?: readonly PackageDependency[];
|
|
29
27
|
description?: string;
|
|
30
28
|
documentation?: string;
|
|
31
29
|
fqn: string;
|
|
@@ -32,30 +32,12 @@ export declare const notificationDefinition: import("./readers.js").ReadValue<Re
|
|
|
32
32
|
setupForm: import("../index.js").PortableFormDefinition | null;
|
|
33
33
|
}>;
|
|
34
34
|
}> & import("../index.js").JsonObject>;
|
|
35
|
-
export declare const
|
|
36
|
-
fullWidth?: boolean;
|
|
37
|
-
icon?: string;
|
|
38
|
-
kind: "predefined";
|
|
39
|
-
label: string;
|
|
40
|
-
orderIndex: number;
|
|
41
|
-
predefinedPageRef: string;
|
|
42
|
-
routeSegment: string;
|
|
43
|
-
slug: string;
|
|
44
|
-
}> & import("../index.js").JsonObject>;
|
|
45
|
-
export declare const studioSection: import("./readers.js").ReadValue<Readonly<{
|
|
46
|
-
description?: string;
|
|
47
|
-
icon?: string;
|
|
48
|
-
label: string;
|
|
49
|
-
orderIndex: number;
|
|
50
|
-
pages: readonly S.StudioAppPageDefinition[];
|
|
51
|
-
slug: string;
|
|
52
|
-
}> & import("../index.js").JsonObject>;
|
|
53
|
-
export declare const studioApp: import("./readers.js").ReadValue<Readonly<{
|
|
35
|
+
export declare const studioAppTemplate: import("./readers.js").ReadValue<Readonly<{
|
|
54
36
|
color?: string;
|
|
55
37
|
description?: string;
|
|
56
38
|
icon?: string;
|
|
57
39
|
isDefaultTemplate?: boolean;
|
|
58
40
|
name: string;
|
|
59
|
-
sections: readonly S.
|
|
41
|
+
sections: readonly S.StudioAppTemplateSectionDefinition[];
|
|
60
42
|
slug: string;
|
|
61
43
|
}> & import("../index.js").JsonObject>;
|
|
@@ -25,6 +25,7 @@ export declare const primitives: {
|
|
|
25
25
|
audience?: Ag.AgentAudienceDeclaration;
|
|
26
26
|
behavioralBoundaries: readonly string[];
|
|
27
27
|
lifecycle: import("../index.js").LifecycleOptions;
|
|
28
|
+
metadata?: import("../index.js").JsonObject;
|
|
28
29
|
maxSteps?: number;
|
|
29
30
|
modelTier?: Ag.AgentModelTier;
|
|
30
31
|
objectives: readonly string[];
|
|
@@ -167,7 +168,7 @@ export declare const primitives: {
|
|
|
167
168
|
version: string;
|
|
168
169
|
}> & Readonly<{
|
|
169
170
|
connectionTemplateFqn: string;
|
|
170
|
-
deploymentIdentity?: "aws";
|
|
171
|
+
deploymentIdentity?: "aws" | "azure";
|
|
171
172
|
senderKind: "address" | "mailbox";
|
|
172
173
|
}> & import("../index.js").JsonObject>;
|
|
173
174
|
eventListener: ReadValue<Readonly<{
|
|
@@ -301,40 +302,7 @@ export declare const primitives: {
|
|
|
301
302
|
normalizesFieldMapValues?: boolean;
|
|
302
303
|
normalizesImportedData?: boolean;
|
|
303
304
|
}> & import("../index.js").JsonObject>;
|
|
304
|
-
knowledgeEntitySchema: ReadValue<
|
|
305
|
-
description?: string;
|
|
306
|
-
displayName: string;
|
|
307
|
-
fqn: string;
|
|
308
|
-
icon?: string;
|
|
309
|
-
kind: "knowledgeEntitySchema";
|
|
310
|
-
tags?: readonly string[];
|
|
311
|
-
version: string;
|
|
312
|
-
}> & Readonly<{
|
|
313
|
-
autocompleteConfiguration: K.KnowledgeAutocompleteConfiguration;
|
|
314
|
-
catalogTags?: Cat.CatalogTags;
|
|
315
|
-
defaultSyncDirection?: string;
|
|
316
|
-
deletionMode?: string;
|
|
317
|
-
displayDefaults?: K.KnowledgeDisplayDefaults;
|
|
318
|
-
displayNameExpression: string | null;
|
|
319
|
-
domainFqn: string;
|
|
320
|
-
embedEntities?: boolean;
|
|
321
|
-
embeddingConfig: import("../index.js").JsonObject | null;
|
|
322
|
-
extendsSchemaFqn?: string;
|
|
323
|
-
fieldLocalization?: Readonly<Record<string, K.KnowledgeFieldLocalization>>;
|
|
324
|
-
fieldPresentation?: Readonly<Record<string, K.KnowledgeFieldPresentation>>;
|
|
325
|
-
fieldSemantics?: Readonly<Record<string, K.KnowledgeFieldSemantics>>;
|
|
326
|
-
lifecycle: import("../index.js").LifecycleOptions;
|
|
327
|
-
localMutationPolicy?: "always" | "connector_backed" | "never";
|
|
328
|
-
managedProjection?: K.KnowledgeManagedProjection;
|
|
329
|
-
maxVersionsExpirationDays?: number | null;
|
|
330
|
-
persistFullFieldContributions: boolean;
|
|
331
|
-
relationFields?: readonly K.EntityRelationField[];
|
|
332
|
-
schema: import("../index.js").PackageSchemaProjection;
|
|
333
|
-
syncable?: boolean;
|
|
334
|
-
usableAsDocumentScope: boolean;
|
|
335
|
-
versioned?: boolean;
|
|
336
|
-
versioningEnabled: boolean | null;
|
|
337
|
-
}> & import("../index.js").JsonObject>;
|
|
305
|
+
knowledgeEntitySchema: ReadValue<K.KnowledgeEntitySchemaDeclaration>;
|
|
338
306
|
knowledgePolicy: ReadValue<Readonly<{
|
|
339
307
|
description?: string;
|
|
340
308
|
displayName: string;
|
|
@@ -532,6 +500,21 @@ export declare const primitives: {
|
|
|
532
500
|
version: string;
|
|
533
501
|
}> & Readonly<{
|
|
534
502
|
definition: S.StudioAppDefinition;
|
|
503
|
+
grants: Readonly<{
|
|
504
|
+
groups: readonly S.StudioAppGrant[];
|
|
505
|
+
}>;
|
|
506
|
+
lifecycle: S.StudioAppLifecycle;
|
|
507
|
+
}> & import("../index.js").JsonObject>;
|
|
508
|
+
studioAppTemplate: ReadValue<Readonly<{
|
|
509
|
+
description?: string;
|
|
510
|
+
displayName: string;
|
|
511
|
+
fqn: string;
|
|
512
|
+
icon?: string;
|
|
513
|
+
kind: "studioAppTemplate";
|
|
514
|
+
tags?: readonly string[];
|
|
515
|
+
version: string;
|
|
516
|
+
}> & Readonly<{
|
|
517
|
+
definition: S.StudioAppTemplateDefinition;
|
|
535
518
|
}> & import("../index.js").JsonObject>;
|
|
536
519
|
studioComponent: ReadValue<Readonly<{
|
|
537
520
|
description?: string;
|
|
@@ -1,8 +1,15 @@
|
|
|
1
1
|
import type { JsonObject } from "../foundation/json.js";
|
|
2
2
|
import type { ExtensionReleaseManifest } from "./manifest.js";
|
|
3
|
+
/**
|
|
4
|
+
* The current kind of one stored primitive declaration, or `undefined` when it
|
|
5
|
+
* names no kind. It is the single reader that tells a Declared Studio App from
|
|
6
|
+
* a Studio App Template stored as `studioApp`.
|
|
7
|
+
*/
|
|
8
|
+
export declare const storedPrimitiveKind: (stored: unknown) => string | undefined;
|
|
3
9
|
/**
|
|
4
10
|
* Returns a stored release manifest whose retained primitive declarations use
|
|
5
|
-
* the current spelling: current kind names,
|
|
11
|
+
* the current spelling: current kind names, a Studio App Template in place of
|
|
12
|
+
* a `studioApp` without the Declared Studio App lifecycle, an Agent `audience` in place of
|
|
6
13
|
* `invokingApplicationFqns`, and Organization Group names in place of
|
|
7
14
|
* Organization Team names. The mapping is a one-to-one rename of
|
|
8
15
|
* retired spellings; every other value is returned as is. A reader that
|
package/package.json
CHANGED