@collective-intelligence/extensions-sdk 0.1.8 → 0.1.9
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 +126 -1
- package/dist/components/agents.d.ts +2 -0
- package/dist/components/base.d.ts +1 -1
- package/dist/components/declaration.d.ts +2 -2
- package/dist/components/knowledge.d.ts +29 -1
- package/dist/components/metadata-authoring.d.ts +18 -5
- package/dist/components/studio-agent-form.d.ts +25 -0
- package/dist/components/studio.d.ts +292 -5
- package/dist/components/workflow-results.d.ts +6 -0
- package/dist/index.d.ts +7 -4
- package/dist/index.js +2 -1
- package/dist/package/knowledge-readers.d.ts +25 -14
- package/dist/package/presentation-readers.d.ts +2 -20
- package/dist/package/primitive-readers.d.ts +18 -0
- package/dist/release/stored-manifest.d.ts +8 -1
- package/package.json +1 -1
|
@@ -1,8 +1,15 @@
|
|
|
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;
|
|
@@ -11,19 +18,19 @@ export declare const fieldSemantics: import("./readers.js").ReadValue<Readonly<{
|
|
|
11
18
|
queryGuidance?: string;
|
|
12
19
|
unique?: boolean;
|
|
13
20
|
}> & import("../index.js").JsonObject>;
|
|
14
|
-
export declare const managedProjection:
|
|
21
|
+
export declare const managedProjection: ReadValue<Readonly<{
|
|
15
22
|
connectorPolicy: "allow" | "deny_schema";
|
|
16
23
|
genericMutationPolicy: "deny_managed_fields" | "deny_schema";
|
|
17
24
|
kind: "directory_person" | "directory_person_in_group" | "directory_group" | "directory_group_parent";
|
|
18
25
|
source: "organization_group" | "organization_group_hierarchy" | "organization_group_membership" | "organization_user";
|
|
19
26
|
}> & import("../index.js").JsonObject>;
|
|
20
|
-
export declare const fieldLocalization:
|
|
27
|
+
export declare const fieldLocalization: ReadValue<Readonly<{
|
|
21
28
|
description?: K.LocalizedFieldText;
|
|
22
29
|
help?: K.LocalizedFieldText;
|
|
23
30
|
label?: K.LocalizedFieldText;
|
|
24
31
|
placeholder?: K.LocalizedFieldText;
|
|
25
32
|
}> & import("../index.js").JsonObject>;
|
|
26
|
-
export declare const fieldPresentation:
|
|
33
|
+
export declare const fieldPresentation: ReadValue<Readonly<{
|
|
27
34
|
copyable?: boolean;
|
|
28
35
|
editor?: string;
|
|
29
36
|
editorOptions?: Readonly<{
|
|
@@ -59,24 +66,24 @@ export declare const fieldPresentation: import("./readers.js").ReadValue<Readonl
|
|
|
59
66
|
renderer?: string;
|
|
60
67
|
trueLabel?: string;
|
|
61
68
|
}> & import("../index.js").JsonObject>;
|
|
62
|
-
export declare const lifecycle:
|
|
69
|
+
export declare const lifecycle: ReadValue<Readonly<{
|
|
63
70
|
deployMode: import("../index.js").LifecycleDeployMode;
|
|
64
71
|
readonly: boolean;
|
|
65
72
|
}> & import("../index.js").JsonObject>;
|
|
66
|
-
export declare const autocompleteConfiguration:
|
|
73
|
+
export declare const autocompleteConfiguration: ReadValue<Readonly<{
|
|
67
74
|
autocompleteFields: readonly K.KnowledgeAutocompleteFieldReference[];
|
|
68
75
|
defaultAutocompleteFields: readonly K.KnowledgeAutocompleteFieldReference[];
|
|
69
76
|
}> & import("../index.js").JsonObject>;
|
|
70
77
|
export declare const knowledgeSchema: {
|
|
71
|
-
catalogTags:
|
|
72
|
-
domainFqn:
|
|
73
|
-
fieldLocalization:
|
|
78
|
+
catalogTags: ReadValue<Readonly<Record<string, readonly string[]>> | undefined>;
|
|
79
|
+
domainFqn: ReadValue<string>;
|
|
80
|
+
fieldLocalization: ReadValue<Readonly<Record<string, Readonly<{
|
|
74
81
|
description?: K.LocalizedFieldText;
|
|
75
82
|
help?: K.LocalizedFieldText;
|
|
76
83
|
label?: K.LocalizedFieldText;
|
|
77
84
|
placeholder?: K.LocalizedFieldText;
|
|
78
85
|
}> & import("../index.js").JsonObject>> | undefined>;
|
|
79
|
-
fieldPresentation:
|
|
86
|
+
fieldPresentation: ReadValue<Readonly<Record<string, Readonly<{
|
|
80
87
|
copyable?: boolean;
|
|
81
88
|
editor?: string;
|
|
82
89
|
editorOptions?: Readonly<{
|
|
@@ -112,10 +119,14 @@ export declare const knowledgeSchema: {
|
|
|
112
119
|
renderer?: string;
|
|
113
120
|
trueLabel?: string;
|
|
114
121
|
}> & import("../index.js").JsonObject>> | undefined>;
|
|
115
|
-
fieldSemantics:
|
|
122
|
+
fieldSemantics: ReadValue<Readonly<Record<string, Readonly<{
|
|
123
|
+
overviewInputMaxChars?: number | null;
|
|
124
|
+
richEnrichment?: boolean | null;
|
|
116
125
|
defaultSearch?: boolean;
|
|
117
126
|
embedded?: boolean;
|
|
127
|
+
includeInItemEmbedding?: boolean;
|
|
118
128
|
faceted?: boolean;
|
|
129
|
+
file?: K.KnowledgeFileField;
|
|
119
130
|
indexContent?: boolean;
|
|
120
131
|
indexOverview?: boolean;
|
|
121
132
|
indexed?: boolean;
|
|
@@ -124,14 +135,14 @@ export declare const knowledgeSchema: {
|
|
|
124
135
|
queryGuidance?: string;
|
|
125
136
|
unique?: boolean;
|
|
126
137
|
}> & import("../index.js").JsonObject>> | undefined>;
|
|
127
|
-
localMutationPolicy:
|
|
128
|
-
managedProjection:
|
|
138
|
+
localMutationPolicy: ReadValue<"always" | "connector_backed" | "never" | undefined>;
|
|
139
|
+
managedProjection: ReadValue<(Readonly<{
|
|
129
140
|
connectorPolicy: "allow" | "deny_schema";
|
|
130
141
|
genericMutationPolicy: "deny_managed_fields" | "deny_schema";
|
|
131
142
|
kind: "directory_person" | "directory_person_in_group" | "directory_group" | "directory_group_parent";
|
|
132
143
|
source: "organization_group" | "organization_group_hierarchy" | "organization_group_membership" | "organization_user";
|
|
133
144
|
}> & import("../index.js").JsonObject) | undefined>;
|
|
134
|
-
schema:
|
|
145
|
+
schema: ReadValue<Readonly<{
|
|
135
146
|
dialect: typeof import("../index.js").Draft202012Dialect;
|
|
136
147
|
document: import("../index.js").JsonSchemaDocument;
|
|
137
148
|
fidelity: import("../index.js").ProjectionFidelity;
|
|
@@ -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[];
|
|
@@ -318,6 +319,8 @@ export declare const primitives: {
|
|
|
318
319
|
displayNameExpression: string | null;
|
|
319
320
|
domainFqn: string;
|
|
320
321
|
embedEntities?: boolean;
|
|
322
|
+
overviewInputMaxChars?: number | null;
|
|
323
|
+
richEnrichment?: boolean | null;
|
|
321
324
|
embeddingConfig: import("../index.js").JsonObject | null;
|
|
322
325
|
extendsSchemaFqn?: string;
|
|
323
326
|
fieldLocalization?: Readonly<Record<string, K.KnowledgeFieldLocalization>>;
|
|
@@ -532,6 +535,21 @@ export declare const primitives: {
|
|
|
532
535
|
version: string;
|
|
533
536
|
}> & Readonly<{
|
|
534
537
|
definition: S.StudioAppDefinition;
|
|
538
|
+
grants: Readonly<{
|
|
539
|
+
groups: readonly S.StudioAppGrant[];
|
|
540
|
+
}>;
|
|
541
|
+
lifecycle: S.StudioAppLifecycle;
|
|
542
|
+
}> & import("../index.js").JsonObject>;
|
|
543
|
+
studioAppTemplate: ReadValue<Readonly<{
|
|
544
|
+
description?: string;
|
|
545
|
+
displayName: string;
|
|
546
|
+
fqn: string;
|
|
547
|
+
icon?: string;
|
|
548
|
+
kind: "studioAppTemplate";
|
|
549
|
+
tags?: readonly string[];
|
|
550
|
+
version: string;
|
|
551
|
+
}> & Readonly<{
|
|
552
|
+
definition: S.StudioAppTemplateDefinition;
|
|
535
553
|
}> & import("../index.js").JsonObject>;
|
|
536
554
|
studioComponent: ReadValue<Readonly<{
|
|
537
555
|
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