@collective-intelligence/extensions-sdk 0.1.26 → 0.1.28
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 +185 -31
- package/dist/components/agents.d.ts +3 -4
- package/dist/components/authoring-core.d.ts +10 -8
- package/dist/components/base.d.ts +1 -1
- package/dist/components/catalog.d.ts +0 -1
- package/dist/components/connector-instances.d.ts +1 -9
- package/dist/components/connectors.d.ts +40 -26
- package/dist/components/declaration.d.ts +4 -3
- package/dist/components/document-collections.d.ts +71 -0
- package/dist/components/executable-authoring.d.ts +2 -3
- package/dist/components/knowledge-remote-deletion.d.ts +60 -13
- package/dist/components/knowledge.d.ts +4 -27
- package/dist/components/metadata-authoring.d.ts +4 -10
- package/dist/index.d.ts +10 -8
- package/dist/index.js +2 -2
- package/dist/package/connector-readers.d.ts +0 -21
- package/dist/package/definition.d.ts +3 -3
- package/dist/package/instance-readers.d.ts +6 -0
- package/dist/package/knowledge-readers.d.ts +6 -0
- package/dist/package/policy-readers.d.ts +2 -2
- package/dist/package/primitive-readers.d.ts +5 -36
- package/dist/release/stored-manifest.d.ts +11 -1
- package/dist/schema/profiles.d.ts +0 -1
- package/package.json +2 -2
|
@@ -0,0 +1,71 @@
|
|
|
1
|
+
import type { PackagePrimitiveBase } from "./base.js";
|
|
2
|
+
import type { ConnectorInstanceConnection } from "./connector-instances.js";
|
|
3
|
+
/**
|
|
4
|
+
* A provider folder: a path of folder names below a drive, or the remote ID
|
|
5
|
+
* that names it when its path is ambiguous. On Microsoft 365, `drive` is the
|
|
6
|
+
* drive title `<siteName> / <libraryName>` that the browse route shows; an
|
|
7
|
+
* empty `folders` list names the drive itself.
|
|
8
|
+
*/
|
|
9
|
+
export type DocumentFolderTarget = Readonly<{
|
|
10
|
+
drive: string;
|
|
11
|
+
folders: readonly string[];
|
|
12
|
+
remoteId?: never;
|
|
13
|
+
}> | Readonly<{
|
|
14
|
+
remoteId: string;
|
|
15
|
+
drive?: never;
|
|
16
|
+
folders?: never;
|
|
17
|
+
}>;
|
|
18
|
+
/** A group or a Service principal by FQN, or the whole Organization; never a user. */
|
|
19
|
+
export type DeclaredRuleGrantee = Readonly<{
|
|
20
|
+
fqn: string;
|
|
21
|
+
kind: "group" | "servicePrincipal";
|
|
22
|
+
}> | Readonly<{
|
|
23
|
+
kind: "organization";
|
|
24
|
+
}>;
|
|
25
|
+
/**
|
|
26
|
+
* The collection, or a folder. A folder that a Remote root names is a Remote
|
|
27
|
+
* root target; any other folder is a subfolder below a Remote root.
|
|
28
|
+
*/
|
|
29
|
+
export type DeclaredRuleTarget = Readonly<{
|
|
30
|
+
kind: "collection";
|
|
31
|
+
}> | Readonly<{
|
|
32
|
+
folder: DocumentFolderTarget;
|
|
33
|
+
kind: "folder";
|
|
34
|
+
}>;
|
|
35
|
+
/**
|
|
36
|
+
* A Document access rule that the package declares and owns, with the meaning
|
|
37
|
+
* of the same rule made by an administrator. An `allow` of `view_history`
|
|
38
|
+
* needs an `allow` of `read` for the same grantee and target.
|
|
39
|
+
*/
|
|
40
|
+
export type DeclaredRule = Readonly<{
|
|
41
|
+
effect: "allow" | "deny";
|
|
42
|
+
grantee: DeclaredRuleGrantee;
|
|
43
|
+
permission: "manage" | "read" | "update" | "view_history";
|
|
44
|
+
target: DeclaredRuleTarget;
|
|
45
|
+
}>;
|
|
46
|
+
/**
|
|
47
|
+
* One Declared Connected collection, its Documents connector instance and its
|
|
48
|
+
* Declared rules. The declaration `description` is the collection
|
|
49
|
+
* description. No option creates a Local collection.
|
|
50
|
+
*/
|
|
51
|
+
export type DocumentCollectionDeclaration = PackagePrimitiveBase<"documentCollection"> & Readonly<{
|
|
52
|
+
/** An existing Connection by setup input, or a declared Connection. */
|
|
53
|
+
connection: ConnectorInstanceConnection;
|
|
54
|
+
/**
|
|
55
|
+
* FQN of the Documents connector that syncs the collection. When
|
|
56
|
+
* omitted, the host takes the one Documents connector of the declared
|
|
57
|
+
* dependencies whose Connection template matches `connection`.
|
|
58
|
+
*/
|
|
59
|
+
connectorFqn?: string;
|
|
60
|
+
/** Passages are embedded for vector search; defaults to `false`. */
|
|
61
|
+
indexContent?: boolean;
|
|
62
|
+
/** An overview is generated and embedded; defaults to `false`. */
|
|
63
|
+
indexOverview?: boolean;
|
|
64
|
+
overviewInputMaxChars?: number | null;
|
|
65
|
+
remoteRoots: readonly DocumentFolderTarget[];
|
|
66
|
+
richEnrichment?: boolean | null;
|
|
67
|
+
rules?: readonly DeclaredRule[];
|
|
68
|
+
/** Scheduled sync; defaults to `true`. */
|
|
69
|
+
syncEnabled?: boolean;
|
|
70
|
+
title: string;
|
|
71
|
+
}>;
|
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
import type { JsonValue } from "../foundation/json.js";
|
|
2
2
|
import type { FormSchemaSource } from "../schema/forms.js";
|
|
3
3
|
import type { SchemaValue } from "../schema/source.js";
|
|
4
|
-
import type { ClassDeclaration, ClassDeclaredComponent, ConnectionClassDeclaration, ConnectionImplementation, EventListenerClassDeclaration, EventListenerImplementation, DocumentsConnectorClassDeclaration, DocumentsConnectorImplementation, FieldTransformerClassDeclaration, FieldTransformerImplementation, KnowledgeConnectorClassDeclaration, KnowledgeConnectorImplementation, KnowledgeConnectorOAuthClassDeclaration, KnowledgeConnectorOAuthImplementation, KnowledgeEntityAdapterClassDeclaration, KnowledgeEntityAdapterImplementation,
|
|
5
|
-
import type { ConnectionDeclaration, DocumentsConnectorDeclaration, EmailProviderDeclaration, EventListenerDeclaration, InboundMessagingProviderDefinition, KnowledgeConnectorDeclaration, KnowledgeConnectorOAuthDeclaration, KnowledgeEntityAdapterDeclaration,
|
|
4
|
+
import type { ClassDeclaration, ClassDeclaredComponent, ConnectionClassDeclaration, ConnectionImplementation, EventListenerClassDeclaration, EventListenerImplementation, DocumentsConnectorClassDeclaration, DocumentsConnectorImplementation, FieldTransformerClassDeclaration, FieldTransformerImplementation, KnowledgeConnectorClassDeclaration, KnowledgeConnectorImplementation, KnowledgeConnectorOAuthClassDeclaration, KnowledgeConnectorOAuthImplementation, KnowledgeEntityAdapterClassDeclaration, KnowledgeEntityAdapterImplementation, NotificationChannelClassDeclaration, NotificationChannelImplementation, ToolClassDeclaration, ToolImplementation, ToolSettingsOptionsClassDeclaration, ToolSettingsOptionsImplementation, WorkflowFieldClassDeclaration, WorkflowFieldImplementation, WorkflowFieldValue } from "./authoring-core.js";
|
|
5
|
+
import type { ConnectionDeclaration, DocumentsConnectorDeclaration, EmailProviderDeclaration, EventListenerDeclaration, InboundMessagingProviderDefinition, KnowledgeConnectorDeclaration, KnowledgeConnectorOAuthDeclaration, KnowledgeEntityAdapterDeclaration, OrganizationSsoDeclaration, OutboundMessagingProviderDeclaration } from "./connectors.js";
|
|
6
6
|
import type { DatasetParserImplementation } from "./dataset-parser.js";
|
|
7
7
|
import type { FieldTransformerDeclaration, NotificationChannelDeclaration, ToolDeclaration, ToolSettingsOptionsDeclaration } from "./tools.js";
|
|
8
8
|
import type { WorkflowFieldDeclaration } from "./workflows.js";
|
|
@@ -16,7 +16,6 @@ export declare const declareEventListener: <Constructor extends new () => EventL
|
|
|
16
16
|
export declare const declareKnowledgeEntityAdapter: <Constructor extends new () => KnowledgeEntityAdapterImplementation>(input: KnowledgeEntityAdapterClassDeclaration<Constructor>) => ClassDeclaredComponent<KnowledgeEntityAdapterDeclaration, Constructor>;
|
|
17
17
|
export declare const declareKnowledgeConnectorOAuth: <Constructor extends new () => KnowledgeConnectorOAuthImplementation>(input: KnowledgeConnectorOAuthClassDeclaration<Constructor>) => ClassDeclaredComponent<KnowledgeConnectorOAuthDeclaration, Constructor>;
|
|
18
18
|
export declare const declareToolSettingsOptions: <Constructor extends new () => ToolSettingsOptionsImplementation>(input: ToolSettingsOptionsClassDeclaration<Constructor>) => ClassDeclaredComponent<ToolSettingsOptionsDeclaration, Constructor>;
|
|
19
|
-
export declare const declareKnowledgeRelationAdapter: <Constructor extends new () => KnowledgeRelationAdapterImplementation>(input: KnowledgeRelationAdapterClassDeclaration<Constructor>) => ClassDeclaredComponent<KnowledgeRelationAdapterDeclaration, Constructor>;
|
|
20
19
|
export declare const declareFieldTransformer: <Constructor extends new () => FieldTransformerImplementation>(input: FieldTransformerClassDeclaration<Constructor>) => ClassDeclaredComponent<FieldTransformerDeclaration, Constructor>;
|
|
21
20
|
export declare const declareNotificationChannel: <Schema extends FormSchemaSource, SetupSchema extends FormSchemaSource, Constructor extends new () => NotificationChannelImplementation>(input: NotificationChannelClassDeclaration<Schema, SetupSchema, Constructor>) => ClassDeclaredComponent<NotificationChannelDeclaration, Constructor>;
|
|
22
21
|
/** Structural admission keeps host APIs and frameworks outside the base SDK. */
|
|
@@ -22,7 +22,9 @@ export type KnowledgeConnectorCensusPageEvidence = Readonly<{
|
|
|
22
22
|
* `readRecord` (wire name `read_record`). Hosts delete a record only after a
|
|
23
23
|
* proven-complete census, and use this proof where the connector implements
|
|
24
24
|
* `readRecord`. The operation `read` is not this proof. A connector without
|
|
25
|
-
* `readRecord` gives none, and the host uses the listing-only path.
|
|
25
|
+
* `readRecord` gives none, and the host uses the listing-only path. An
|
|
26
|
+
* external `get` reads through the same operation; the `itemMetadata` of a
|
|
27
|
+
* `live` proof keeps the identity and revision of the item.
|
|
26
28
|
*/
|
|
27
29
|
export type KnowledgeConnectorRecordProof = Readonly<{
|
|
28
30
|
remoteId: string;
|
|
@@ -35,6 +37,7 @@ export type KnowledgeConnectorRecordProof = Readonly<{
|
|
|
35
37
|
status: "live";
|
|
36
38
|
sourceId: string;
|
|
37
39
|
item: JsonObject;
|
|
40
|
+
itemMetadata?: KnowledgeConnectorRemoteItemMetadata;
|
|
38
41
|
}> | Readonly<{
|
|
39
42
|
status: "not_verified";
|
|
40
43
|
reason: string;
|
|
@@ -56,11 +59,33 @@ export type KnowledgeConnectorRejectedRecord = Readonly<{
|
|
|
56
59
|
location: string;
|
|
57
60
|
field?: string;
|
|
58
61
|
}>;
|
|
59
|
-
/**
|
|
60
|
-
|
|
62
|
+
/**
|
|
63
|
+
* What the host asks of one `pull` call. Every key is always present, so a
|
|
64
|
+
* connector cannot lose the mode, the restart point or the page size.
|
|
65
|
+
*/
|
|
66
|
+
export type KnowledgePullRequest = Readonly<{
|
|
67
|
+
/** The remote collection of the entity binding. */
|
|
68
|
+
remoteId: string;
|
|
69
|
+
/** `delta` reads changes since `since`; `full` reads the whole collection. */
|
|
70
|
+
mode: "full" | "delta";
|
|
71
|
+
/** The page cursor of this phase; `null` for the first page. */
|
|
72
|
+
cursor: string | null;
|
|
73
|
+
/** The stored **Feed cursor**, passed through unchanged. */
|
|
74
|
+
deltaCursor: string | null;
|
|
75
|
+
/**
|
|
76
|
+
* ISO 8601 restart point of a delta phase, already moved back by the
|
|
77
|
+
* connector's `deltaOverlapSeconds`; `null` when no phase succeeded yet.
|
|
78
|
+
*/
|
|
79
|
+
since: string | null;
|
|
80
|
+
/** The connector's declared `pullPageSize`. */
|
|
81
|
+
limit: number;
|
|
82
|
+
/** Binding options; `watermarkColumn` is the binding's **Watermark Column**. */
|
|
83
|
+
options: Readonly<{
|
|
84
|
+
watermarkColumn?: string;
|
|
85
|
+
}>;
|
|
86
|
+
}>;
|
|
87
|
+
type KnowledgePullPageFields = Readonly<{
|
|
61
88
|
items: readonly JsonObject[];
|
|
62
|
-
/** `null` on the last page. */
|
|
63
|
-
nextCursor: string | null;
|
|
64
89
|
/** Without evidence, the page proves no **Census** and deletes nothing. */
|
|
65
90
|
census?: KnowledgeConnectorCensusPageEvidence;
|
|
66
91
|
/**
|
|
@@ -70,15 +95,37 @@ export type KnowledgeConnectorPullPage = Readonly<{
|
|
|
70
95
|
deltaCursor?: string;
|
|
71
96
|
itemMetadata?: readonly KnowledgeConnectorRemoteItemMetadata[];
|
|
72
97
|
rejected?: readonly KnowledgeConnectorRejectedRecord[];
|
|
98
|
+
/** Notices for the operator; the host keeps one per code in the run. */
|
|
99
|
+
warnings?: readonly Readonly<{
|
|
100
|
+
code: string;
|
|
101
|
+
message: string;
|
|
102
|
+
}>[];
|
|
73
103
|
}>;
|
|
74
104
|
/**
|
|
75
|
-
*
|
|
76
|
-
*
|
|
77
|
-
* the next run of the binding reads in full.
|
|
105
|
+
* One page of items that a connector pulls from its source. `nextCursor` is
|
|
106
|
+
* `null` on the last page; any other page declares how its cursor resumes.
|
|
78
107
|
*/
|
|
79
|
-
export type
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
108
|
+
export type KnowledgePullPage = KnowledgePullPageFields & (Readonly<{
|
|
109
|
+
nextCursor: null;
|
|
110
|
+
}> | Readonly<{
|
|
111
|
+
nextCursor: string;
|
|
112
|
+
nextCursorKind: "provider_page_token" | "provider_delta_token" | "timestamp_checkpoint" | "stable_remote_id";
|
|
113
|
+
}>);
|
|
114
|
+
/**
|
|
115
|
+
* Why a pull gives no page, returned as `{ fault }`. The host retries a
|
|
116
|
+
* `retryable` fault and fails the run on any other. The code
|
|
117
|
+
* `cursor_expired` means the source rejected the **Feed cursor**; the host
|
|
118
|
+
* then clears only the Feed cursor and keeps the **Delta Since**. The next
|
|
119
|
+
* delta run reads the changes since then without tombstones; only a full run
|
|
120
|
+
* reconciles deletions.
|
|
121
|
+
*/
|
|
122
|
+
export type KnowledgePullFault = Readonly<{
|
|
123
|
+
code: string;
|
|
124
|
+
message: string;
|
|
125
|
+
retryable: boolean;
|
|
126
|
+
}>;
|
|
127
|
+
/** What one `pull` gives: a page, or `{ fault }` when the source gives none. */
|
|
128
|
+
export type KnowledgePullResult = KnowledgePullPage | Readonly<{
|
|
129
|
+
fault: KnowledgePullFault;
|
|
84
130
|
}>;
|
|
131
|
+
export {};
|
|
@@ -201,24 +201,10 @@ export type KnowledgeEntitySchemaDeclaration = PackagePrimitiveBase<"knowledgeEn
|
|
|
201
201
|
versioned?: boolean;
|
|
202
202
|
versioningEnabled: boolean | null;
|
|
203
203
|
}>;
|
|
204
|
-
export type KnowledgeRelationSchemaDeclaration = PackagePrimitiveBase<"knowledgeRelationSchema"> & Readonly<{
|
|
205
|
-
catalogTags?: CatalogTags;
|
|
206
|
-
domainFqn: string;
|
|
207
|
-
/** Historical manifests may omit policy; new declarations require it. */
|
|
208
|
-
lifecycle?: LifecycleOptions;
|
|
209
|
-
localMutationPolicy?: "always" | "connector_backed" | "never";
|
|
210
|
-
managedProjection?: KnowledgeManagedProjection;
|
|
211
|
-
fieldLocalization?: Readonly<Record<string, KnowledgeFieldLocalization>>;
|
|
212
|
-
fieldPresentation?: Readonly<Record<string, KnowledgeFieldPresentation>>;
|
|
213
|
-
fieldSemantics?: Readonly<Record<string, KnowledgeFieldSemantics>>;
|
|
214
|
-
schema: PackageSchemaProjection;
|
|
215
|
-
sourceSchemaFqn: string;
|
|
216
|
-
targetSchemaFqn: string;
|
|
217
|
-
}>;
|
|
218
204
|
export type KnowledgePolicyDeclaration = PackagePrimitiveBase<"knowledgePolicy"> & Readonly<{
|
|
219
205
|
effect: "allow" | "deny";
|
|
220
206
|
/** Domain-attached policies target the domain FQN; schema policies target a schema FQN. */
|
|
221
|
-
targetKind: "entity_domain" | "entity_schema"
|
|
207
|
+
targetKind: "entity_domain" | "entity_schema";
|
|
222
208
|
policyBody: KnowledgePolicyBody;
|
|
223
209
|
policyType: "filter" | "gate";
|
|
224
210
|
priority?: number;
|
|
@@ -256,15 +242,6 @@ export type KnowledgePolicyPredicate = Readonly<{
|
|
|
256
242
|
}> | Readonly<{
|
|
257
243
|
op: "and" | "or";
|
|
258
244
|
args: readonly KnowledgePolicyPredicate[];
|
|
259
|
-
}> | Readonly<{
|
|
260
|
-
op: "relation_exists";
|
|
261
|
-
relationSchemaId: string;
|
|
262
|
-
direction: "out" | "in";
|
|
263
|
-
}> | Readonly<{
|
|
264
|
-
op: "relation_field";
|
|
265
|
-
relationSchemaId: string;
|
|
266
|
-
direction: "out" | "in";
|
|
267
|
-
inner: KnowledgePolicyPredicate;
|
|
268
245
|
}>
|
|
269
246
|
/**
|
|
270
247
|
* An Entity Relation Field hop: true when `inner` holds for some live
|
|
@@ -286,8 +263,8 @@ export type KnowledgePolicyPredicate = Readonly<{
|
|
|
286
263
|
* effective User Roles (`userRoles`) on the External App that makes the call;
|
|
287
264
|
* it is empty for a call outside an External App. Match a role with
|
|
288
265
|
* `{ op: "in", value: { kind: "literal", value: "<role key>" }, set: { kind: "subject", path: ["roles"] } }`.
|
|
289
|
-
* `access` is `"read"` for get, list, search, facets, autocomplete
|
|
290
|
-
*
|
|
266
|
+
* `access` is `"read"` for get, list, search, facets, autocomplete and
|
|
267
|
+
* retrieval, and `"write"` for create, update and delete;
|
|
291
268
|
* the deciding operation sets it, never the caller. A policy that does not
|
|
292
269
|
* test `access` applies to both. `resource` refs read `["id"]` or a `data`
|
|
293
270
|
* path.
|
|
@@ -382,7 +359,7 @@ export type KnowledgePolicyBody = Readonly<{
|
|
|
382
359
|
* `writableFields`, or lists every changed path. A File or relation field
|
|
383
360
|
* the update writes counts as changed; a change of the record's name,
|
|
384
361
|
* description or external binding is outside every `writableFields`. Such
|
|
385
|
-
* a policy admits no create
|
|
362
|
+
* a policy admits no create or delete, and does not change
|
|
386
363
|
* reads.
|
|
387
364
|
*/
|
|
388
365
|
writableFields?: readonly (readonly string[])[];
|
|
@@ -7,10 +7,10 @@ import type { KnowledgeConnectorInstanceDeclaration, DatasetConnectorInstanceDec
|
|
|
7
7
|
import type { DatasetParserDeclaration, ExternalDatasetProviderDeclaration, ManagedDatasetProviderDeclaration } from "./connectors.js";
|
|
8
8
|
import type { DatasetParserImplementation } from "./dataset-parser.js";
|
|
9
9
|
import type { ExternalDatasetProviderImplementation, ManagedDatasetProviderImplementation } from "./datasets.js";
|
|
10
|
+
import type { DocumentCollectionDeclaration } from "./document-collections.js";
|
|
10
11
|
import type { ExternalAppGatewayDeclaration } from "./external-app-gateway.js";
|
|
11
12
|
import type { ExternalApplicationAccessKey, ExternalApplicationDeclaration, ExternalApplicationGroupBinding, ExternalApplicationServerRole, ExternalApplicationUserRole } from "./external-application.js";
|
|
12
|
-
import type { KnowledgeEntitySchemaDeclaration, KnowledgeFieldSemantics, KnowledgeFileFieldDeclaration, KnowledgeUserFieldDeclaration, KnowledgePolicyDeclaration
|
|
13
|
-
import type { LifecycleOptions } from "./lifecycle.js";
|
|
13
|
+
import type { KnowledgeEntitySchemaDeclaration, KnowledgeFieldSemantics, KnowledgeFileFieldDeclaration, KnowledgeUserFieldDeclaration, KnowledgePolicyDeclaration } from "./knowledge.js";
|
|
14
14
|
import type { OrganizationGroupDeclaration } from "./organization-group.js";
|
|
15
15
|
import type { OrganizationInstructionsDeclaration } from "./organization-instructions.js";
|
|
16
16
|
import type { OrganizationSettingsDeclaration, VaryingOrganizationSettingsAuthentication, VaryingOrganizationSettingsSso } from "./organization-settings.js";
|
|
@@ -76,8 +76,6 @@ export declare const declareOrganizationSettings: (input: MetadataClassDeclarati
|
|
|
76
76
|
export declare const declareSkillTemplate: (input: MetadataClassDeclaration<SkillTemplateDeclaration>) => DeclaredComponent<SkillTemplateDeclaration>;
|
|
77
77
|
/** Authored field semantics; File and User entries come from `fileFields` and `userFields`. */
|
|
78
78
|
type KnowledgeFieldSemanticsInput = Readonly<Record<string, Omit<KnowledgeFieldSemantics, "file" | "user">>>;
|
|
79
|
-
/** Relation schemas take no File, User or relation field entries. */
|
|
80
|
-
type KnowledgeRelationFieldSemanticsInput = Readonly<Record<string, Omit<KnowledgeFieldSemantics, "file" | "relation" | "user">>>;
|
|
81
79
|
type KnowledgeEntityDefinitionInput<Schema> = Omit<MetadataDefinition<KnowledgeEntitySchemaDeclaration>, "fieldSemantics" | "schema"> & Readonly<{
|
|
82
80
|
fieldSemantics?: KnowledgeFieldSemanticsInput;
|
|
83
81
|
/** The File fields of the schema, by top-level property key. */
|
|
@@ -86,13 +84,7 @@ type KnowledgeEntityDefinitionInput<Schema> = Omit<MetadataDefinition<KnowledgeE
|
|
|
86
84
|
userFields?: Readonly<Record<string, KnowledgeUserFieldDeclaration>>;
|
|
87
85
|
schema: DecoderSource<Schema>;
|
|
88
86
|
}>;
|
|
89
|
-
type KnowledgeRelationDefinitionInput<Schema> = Omit<MetadataDefinition<KnowledgeRelationSchemaDeclaration>, "fieldSemantics" | "schema" | "lifecycle"> & Readonly<{
|
|
90
|
-
fieldSemantics?: KnowledgeRelationFieldSemanticsInput;
|
|
91
|
-
lifecycle: LifecycleOptions;
|
|
92
|
-
schema: DecoderSource<Schema>;
|
|
93
|
-
}>;
|
|
94
87
|
export declare const declareKnowledgeEntitySchema: <Schema>(input: MetadataClassDeclaration<KnowledgeEntitySchemaDeclaration, KnowledgeEntityDefinitionInput<Schema>>) => DeclaredComponent<KnowledgeEntitySchemaDeclaration>;
|
|
95
|
-
export declare const declareKnowledgeRelationSchema: <Schema>(input: MetadataClassDeclaration<KnowledgeRelationSchemaDeclaration, KnowledgeRelationDefinitionInput<Schema>>) => DeclaredComponent<KnowledgeRelationSchemaDeclaration>;
|
|
96
88
|
export declare const declareKnowledgePolicy: (input: MetadataClassDeclaration<KnowledgePolicyDeclaration>) => DeclaredComponent<KnowledgePolicyDeclaration>;
|
|
97
89
|
type WorkflowTemplateGraphDefinitionInput = Omit<WorkflowTemplateGraphDefinition, "inputContract" | "outputContract"> & Readonly<{
|
|
98
90
|
inputContract: Omit<WorkflowTemplateGraphDefinition["inputContract"], "schema"> & Readonly<{
|
|
@@ -126,6 +118,8 @@ type StudioComponentDefinitionInput<Schema> = Omit<MetadataDefinition<StudioComp
|
|
|
126
118
|
export declare const declareStudioComponent: <Schema>(input: MetadataClassDeclaration<StudioComponentDeclaration, StudioComponentDefinitionInput<Schema>>) => DeclaredComponent<StudioComponentDeclaration>;
|
|
127
119
|
export declare const declareKnowledgeConnectorInstance: (input: MetadataClassDeclaration<KnowledgeConnectorInstanceDeclaration, VaryingMetadataDefinition<KnowledgeConnectorInstanceDeclaration>>) => DeclaredComponent<KnowledgeConnectorInstanceDeclaration>;
|
|
128
120
|
export declare const declareDatasetConnectorInstance: (input: MetadataClassDeclaration<DatasetConnectorInstanceDeclaration, VaryingMetadataDefinition<DatasetConnectorInstanceDeclaration>>) => DeclaredComponent<DatasetConnectorInstanceDeclaration>;
|
|
121
|
+
/** Declares a Declared Connected collection with its Declared rules. */
|
|
122
|
+
export declare const declareDocumentCollection: (input: MetadataClassDeclaration<DocumentCollectionDeclaration, VaryingMetadataDefinition<DocumentCollectionDeclaration>>) => DeclaredComponent<DocumentCollectionDeclaration>;
|
|
129
123
|
/** Declares a service principal; Group ownership is checked when assembling the package. */
|
|
130
124
|
export declare const servicePrincipal: (input: Readonly<{
|
|
131
125
|
fqn: string;
|
package/dist/index.d.ts
CHANGED
|
@@ -13,24 +13,24 @@ export type { OperationDomainDeclaration, PortableGatewayDeclarations, PortableO
|
|
|
13
13
|
export type { PackageCodec, PackageCodecSource, PackageDecoder, PackageDecoderSource, PackageSchemaDefinition, PackageSchemaIssue, PackageSchemaProjections, PackageSchemaResult, PackageSchemaSource, SchemaDirection, SchemaValue, SchemaWire } from "./schema/source.js";
|
|
14
14
|
export type { JsonSchemaDocument, PackageSchemaProjection, ProjectionFidelity } from "./schema/projection.js";
|
|
15
15
|
export type { ConsumerProfile, ConsumerProfileDiagnostic, ConsumerProfileId } from "./schema/profiles.js";
|
|
16
|
-
export { declareKnowledgeEntityAdapter, declareConnection, declareDocumentsConnector, declareKnowledgeConnector, declareKnowledgeConnectorOAuth, declareEventListener, declareFieldTransformer, declareNotificationChannel,
|
|
16
|
+
export { declareKnowledgeEntityAdapter, declareConnection, declareDocumentsConnector, declareKnowledgeConnector, declareKnowledgeConnectorOAuth, declareEventListener, declareFieldTransformer, declareNotificationChannel, declareTool, declareToolSettingsOptions, declareWorkflowField, declareOrganizationSso, declareEmailProvider, declareInboundMessagingProvider, declareOutboundMessagingProvider } from "./components/executable-authoring.js";
|
|
17
17
|
export { declareWorkflowNode } from "./components/workflow-node-authoring.js";
|
|
18
18
|
export { resolveWorkflowNodePorts, WorkflowPortIssueCodes } from "./components/workflow-ports.js";
|
|
19
19
|
export type { WorkflowNodePortsContract, WorkflowPortIssue, WorkflowPortIssueCode, WorkflowResolvedPorts } from "./components/workflow-ports.js";
|
|
20
20
|
export { builtInCodeRuntimeIds } from "./components/workflow-code-runtimes.js";
|
|
21
21
|
export { workflowSchemaAt } from "./components/workflow-schema.js";
|
|
22
22
|
export type { WorkflowSchemaLocation } from "./components/workflow-schema.js";
|
|
23
|
-
export { declareDatasetParser, declareDomain, declareDomainTemplate, declareExternalApplication, declareExternalAppGateway, declareExternalDatasetProvider, declareKnowledgeEntitySchema, declareKnowledgePolicy,
|
|
23
|
+
export { declareDatasetParser, declareDomain, declareDomainTemplate, declareExternalApplication, declareExternalAppGateway, declareExternalDatasetProvider, declareKnowledgeEntitySchema, declareKnowledgePolicy, declareManagedDatasetProvider, declareOrganizationGroup, declareOrganizationInstructions, servicePrincipal, declareOrganizationSettings, declareRemoteToolCollection, declareSkillTemplate, declareStudioApp, declareStudioAppTemplate, declareStudioComponent, declareToolCollection, declareWorkflow, declareWorkflowFieldCollection, declareWorkflowNodeCollection, declareWorkflowTemplate } from "./components/metadata-authoring.js";
|
|
24
24
|
export { DATASET_TABLE_TEMPLATE_PHYSICAL_CODES, DATASET_TABLE_TEMPLATE_SEMANTIC_ROLES, declareDatasetBlueprint, declareDatasetTableTemplate, rejectUnsupportedDatasetTableTemplate } from "./components/templates.js";
|
|
25
25
|
export { declarePackage } from "./package/definition.js";
|
|
26
26
|
export { isVariableReference, packageVariables, packageVariableTypes, packageVariableViolation, variableReference } from "./package/variables.js";
|
|
27
27
|
export type { PackageVariable, PackageVariableDeclaration, PackageVariables, PackageVariablesDeclaration, PackageVariableType, PackageVariableValue, VariableReference, Varying, VaryingDefinition, VaryingExcludedKey, VaryingStructure } from "./package/variables.js";
|
|
28
28
|
export { normalizeNotificationChannelCapabilities } from "./components/notification-channel-capabilities.js";
|
|
29
29
|
export { renderKnowledgeRemoteReferenceUrl } from "./components/knowledge-remote-reference.js";
|
|
30
|
-
export type { KnowledgeConnectorCensusPageEvidence,
|
|
30
|
+
export type { KnowledgeConnectorCensusPageEvidence, KnowledgeConnectorRecordProof, KnowledgeConnectorRejectedRecord, KnowledgeConnectorRemoteItemMetadata, KnowledgePullFault, KnowledgePullPage, KnowledgePullRequest, KnowledgePullResult } from "./components/knowledge-remote-deletion.js";
|
|
31
31
|
export { BACKEND_EXECUTION_LANES, declareHostedContribution, FRONTEND_CATALOG_CONTRACT, FRONTEND_CATALOG_EXPORT_NAME, HOSTS } from "./hosted/contributions.js";
|
|
32
32
|
export type { BackendExecutionLane, BackendHostedContributionManifest, ExtensionHost, FrontendCatalogContract, FrontendCatalogContributionManifest, FrontendCatalogExportName, FrontendExtensionHost, HostedContributionDeclaration, HostedContributionInput, HostedContributionManifest, HostedContributionSourceIdentity } from "./hosted/contributions.js";
|
|
33
|
-
export type { ComponentManifest, ComponentPresentation, DeclarationHandle, DeclarationReference, DeclaredComponent, DocumentsConnectorImplementation, PackageSchemaRuntimeSidecar, MetadataComponentManifest, ToolClassDeclaration, WorkflowFieldClassDeclaration, KnowledgeEntityAdapterClassDeclaration, ConnectionClassDeclaration, KnowledgeConnectorClassDeclaration, KnowledgeConnectorOAuthClassDeclaration, EventListenerClassDeclaration, FieldTransformerClassDeclaration, NotificationChannelClassDeclaration,
|
|
33
|
+
export type { ComponentManifest, ComponentPresentation, DeclarationHandle, DeclarationReference, DeclaredComponent, DocumentsConnectorImplementation, PackageSchemaRuntimeSidecar, MetadataComponentManifest, ToolClassDeclaration, WorkflowFieldClassDeclaration, KnowledgeEntityAdapterClassDeclaration, ConnectionClassDeclaration, KnowledgeConnectorClassDeclaration, KnowledgeConnectorOAuthClassDeclaration, EventListenerClassDeclaration, FieldTransformerClassDeclaration, NotificationChannelClassDeclaration, ToolSettingsOptionsClassDeclaration, WorkflowNodeClassDeclaration, WorkflowNodePortInput } from "./components/authoring-core.js";
|
|
34
34
|
export type { DeclaredPackageComponent, DeclaredPackageManifest, PackageDefinition, PackageManifestInput, NormalizedPackageDefinition, PackageComponent } from "./package/definition.js";
|
|
35
35
|
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, StudioTriggerFormRichTextField, StudioTriggerFormUserField, StudioTriggerFormValueField } from "./components/studio.js";
|
|
36
36
|
export type { StudioAgentFormDeclaration, StudioAgentFormField } from "./components/studio-agent-form.js";
|
|
@@ -47,7 +47,7 @@ export { PackageManifestVersion } from "./package/manifest.js";
|
|
|
47
47
|
export type { InstallationWizard, InstallationWizardStep, PackageDependency, PackageManifest } from "./package/manifest.js";
|
|
48
48
|
export { canonicalExtensionReleaseManifest, ExtensionReleaseManifestVersion, PACKAGE_MEDIA_SIZE_LIMIT_BYTES, PackageMediaArchivePrefix, parseExtensionReleaseManifest } from "./release/manifest.js";
|
|
49
49
|
export { parseExtensionReleaseArchive, validateExtensionReleaseArchiveMetadata } from "./release/archive.js";
|
|
50
|
-
export { parseStoredExtensionReleaseManifest, storedPrimitiveKind, withCurrentPrimitiveKinds } from "./release/stored-manifest.js";
|
|
50
|
+
export { parseStoredExtensionReleaseManifest, storedPrimitiveKind, withCurrentPrimitive, withCurrentPrimitiveKinds } from "./release/stored-manifest.js";
|
|
51
51
|
export type { BuildAttemptResult, ExtensionReleaseArchiveEntry, ExtensionReleaseAsset, ExtensionReleaseContribution, ExtensionReleaseManifest, ExtensionReleaseMedia, ExtensionReleasePrivateSourceMap } from "./release/manifest.js";
|
|
52
52
|
export type { BindingScope, ConnectionReference, PackagePrimitiveBase, PackagePrimitiveKind } from "./components/base.js";
|
|
53
53
|
export type { LifecycleDeployMode, LifecycleOptions } from "./components/lifecycle.js";
|
|
@@ -62,10 +62,10 @@ export { organizationSettingsViolation } from "./components/organization-setting
|
|
|
62
62
|
export type { OrganizationSettingsApplicationConsent, OrganizationSettingsAuthentication, OrganizationSettingsDeclaration, OrganizationSettingsLocalMethod, OrganizationSettingsMedia, OrganizationSettingsSso, OrganizationSettingsSsoRole, VaryingOrganizationSettings } from "./components/organization-settings.js";
|
|
63
63
|
export { declareAgent, declareSkill, duplicateToolBinding, toolBindingDeclaration } from "./components/agents.js";
|
|
64
64
|
export type { AgentActivityPolicy, AgentAudience, AgentAudienceDeclaration, AgentDeclaration, AgentDefinitionInput, AgentMemberAudience, AgentModelTier, DeclaredToolBindings, KnowledgeScopeSelection, SkillDeclaration, SkillDefinitionInput, ToolBinding, ToolBindingApproval, ToolBindingDeclaration, ToolBindingKnowledgeScope } from "./components/agents.js";
|
|
65
|
-
export type { DocumentsDeltaCursorExpired, DocumentsDeltaItem, DocumentsDeltaPage, DocumentsDeltaRequest, DocumentsDrive, DocumentsDrivesPage, DocumentsFolder, DocumentsFoldersPage, DocumentsFetchedContent, DocumentsRootAncestry, DocumentsSource, KnowledgeEntityAdapterDeclaration, ConnectionDeclaration, DatasetParserDeclaration, ExternalDatasetProviderDeclaration, KnowledgeConnectorContribution, KnowledgeConnectorBindingExtraConfig, KnowledgeConnectorDeclaration, KnowledgeConnectorRemoteDeletion, KnowledgeConnectorFieldMapRule, KnowledgeEntitySchemaCapability, KnowledgeConnectorOAuthDeclaration, KnowledgeConnectorOAuthTokens, KnowledgeConnectorRemoteReference, EventListenerDeclaration, EventListenerInternalOccurrence, EventListenerPollRequest, EventListenerPollResult, EventListenerWebhookRequest, KnowledgePredefinedSchedule, ManagedDatasetProviderDeclaration
|
|
65
|
+
export type { DocumentsDeltaCursorExpired, DocumentsDeltaItem, DocumentsDeltaPage, DocumentsDeltaRequest, DocumentsDrive, DocumentsDrivesPage, DocumentsFolder, DocumentsFoldersPage, DocumentsFetchedContent, DocumentsFileRevision, DocumentsRootAncestry, DocumentsSource, DocumentsSyncWarning, KnowledgeEntityAdapterDeclaration, ConnectionDeclaration, DatasetParserDeclaration, ExternalDatasetProviderDeclaration, KnowledgeConnectorContribution, KnowledgeConnectorBindingExtraConfig, KnowledgeConnectorDeclaration, KnowledgeConnectorRemoteDeletion, KnowledgeConnectorFieldMapRule, KnowledgeEntitySchemaCapability, KnowledgeConnectorOAuthDeclaration, KnowledgeConnectorOAuthTokens, KnowledgeConnectorRemoteReference, EventListenerDeclaration, EventListenerInternalOccurrence, EventListenerPollRequest, EventListenerPollResult, EventListenerWebhookRequest, KnowledgePredefinedSchedule, ManagedDatasetProviderDeclaration } from "./components/connectors.js";
|
|
66
66
|
export type { PackagePrimitiveDeclaration } from "./components/declaration.js";
|
|
67
67
|
export type { DatasetBlueprintClassDeclaration, DatasetBlueprintDeclaration, DatasetTableTemplateClassDeclaration, DatasetTableTemplateDeclaration, DatasetTableTemplateHint, DatasetTableTemplatePhysicalCode, DatasetTableTemplateSemanticRole, DatasetTableTemplateUniqueness } from "./components/templates.js";
|
|
68
|
-
export type { KnowledgeAutocompleteConfiguration, KnowledgeAutocompleteFieldReference, KnowledgeEntityRelationField, KnowledgeEntitySchemaDeclaration, KnowledgeDisplayDefaults, KnowledgeFieldLocalization, KnowledgeFieldPresentation, KnowledgeFieldSemantics, KnowledgeFileField, KnowledgeFileFieldDeclaration, KnowledgeUserField, KnowledgeUserFieldDeclaration, KnowledgeManagedProjection, LocalizedFieldText, KnowledgePolicyDeclaration
|
|
68
|
+
export type { KnowledgeAutocompleteConfiguration, KnowledgeAutocompleteFieldReference, KnowledgeEntityRelationField, KnowledgeEntitySchemaDeclaration, KnowledgeDisplayDefaults, KnowledgeFieldLocalization, KnowledgeFieldPresentation, KnowledgeFieldSemantics, KnowledgeFileField, KnowledgeFileFieldDeclaration, KnowledgeUserField, KnowledgeUserFieldDeclaration, KnowledgeManagedProjection, LocalizedFieldText, KnowledgePolicyDeclaration } from "./components/knowledge.js";
|
|
69
69
|
export { toolResultBrand } from "./components/tools.js";
|
|
70
70
|
export type { FieldTransformerDeclaration, NotificationChannelDeclaration, RemoteToolCollectionDeclaration, RemoteToolCollectionDefinition, SetupInstructions, ToolCollectionDeclaration, ToolCollectionVisibilityGrant, ToolDeclaration, ToolDisplayPart, ToolExtraLoader, ToolGuidance, ToolHealthCheck, ToolResultWithDisplay, ToolSettingsOption, ToolSettingsOptionPage, ToolSettingsOptionsContext, ToolSettingsOptionsDeclaration } from "./components/tools.js";
|
|
71
71
|
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, WorkflowRunDetailsRetention, WorkflowTemplateKind, WorkflowTriggerActivationDeclaration, WorkflowTemplateDeclaration, WorkflowTemplateGraphDefinition, WorkflowTemplateGraphSchemaContract, WorkflowTemplateUiLayout, WorkflowTriggerInvocation } from "./components/workflows.js";
|
|
@@ -85,8 +85,10 @@ export { parseJsonSchemaProjection } from "./package/readers.js";
|
|
|
85
85
|
export { deriveWorkflowEditor, WorkflowJsonSchemaFormat } from "./components/workflow-editor.js";
|
|
86
86
|
export type { WorkflowEditorDerivationInput } from "./components/workflow-editor.js";
|
|
87
87
|
export { declareKnowledgeConnectorInstance, declareDatasetConnectorInstance } from "./components/metadata-authoring.js";
|
|
88
|
-
export type { ConnectorInstanceConnection, KnowledgeConnectorInstanceDeclaration, DatasetConnectorInstanceDeclaration, KnowledgeConnectorInstanceSettings, KnowledgeConnectorInstanceRemoteFilters, KnowledgeConnectorInstanceBindingOptions, KnowledgeConnectorInstanceEntityBinding, KnowledgeConnectorPushEntityMatch, KnowledgeConnectorRemoteDeletionPropagation,
|
|
88
|
+
export type { ConnectorInstanceConnection, KnowledgeConnectorInstanceDeclaration, DatasetConnectorInstanceDeclaration, KnowledgeConnectorInstanceSettings, KnowledgeConnectorInstanceRemoteFilters, KnowledgeConnectorInstanceBindingOptions, KnowledgeConnectorInstanceEntityBinding, KnowledgeConnectorPushEntityMatch, KnowledgeConnectorRemoteDeletionPropagation, KnowledgeConnectorInstancePipeline, KnowledgeConnectorInstanceSchedule, KnowledgeConnectorInstanceDataPolicy, DatasetConnectorInstanceDataPolicy, DatasetConnectorInstanceSchedule } from "./components/connector-instances.js";
|
|
89
89
|
export type { KnowledgePolicyBody, KnowledgePolicyPredicate, KnowledgePolicyRef } from "./components/knowledge.js";
|
|
90
90
|
export type { ServicePrincipalDeclaration, ServicePrincipalOrganizationRole } from "./components/service-principal.js";
|
|
91
|
+
export { declareDocumentCollection } from "./components/metadata-authoring.js";
|
|
92
|
+
export type { DeclaredRule, DeclaredRuleGrantee, DeclaredRuleTarget, DocumentCollectionDeclaration, DocumentFolderTarget } from "./components/document-collections.js";
|
|
91
93
|
export { declareConnectionInstance } from "./components/metadata-authoring.js";
|
|
92
94
|
export type { ConnectionInstanceDeclaration } from "./components/connection-instances.js";
|