@collective-intelligence/extensions-sdk 0.1.27 → 0.1.29
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 +106 -28
- 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 +3 -3
- 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 +1 -10
- package/dist/index.d.ts +8 -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/knowledge-readers.d.ts +6 -0
- package/dist/package/policy-readers.d.ts +2 -2
- package/dist/package/primitive-readers.d.ts +3 -36
- package/dist/release/stored-manifest.d.ts +11 -1
- package/dist/schema/profiles.d.ts +0 -1
- package/package.json +2 -2
|
@@ -124,27 +124,6 @@ export declare const entityCapability: ReadValue<Readonly<{
|
|
|
124
124
|
syncIntervalSeconds?: number | null;
|
|
125
125
|
updateMode?: "full" | "partial";
|
|
126
126
|
}> & import("../index.js").JsonObject>;
|
|
127
|
-
export declare const relationCapability: ReadValue<Readonly<{
|
|
128
|
-
extraPropsMode?: "ignore" | "import" | "inline";
|
|
129
|
-
fieldMap?: readonly C.KnowledgeConnectorFieldMapRule[];
|
|
130
|
-
fqn: string;
|
|
131
|
-
outboundStrategy?: "local_first" | "remote_first";
|
|
132
|
-
predefinedBindingExtras?: readonly C.KnowledgeConnectorBindingExtraConfig[];
|
|
133
|
-
predefinedBindingKey?: string;
|
|
134
|
-
predefinedBindingMode?: "external" | "managed";
|
|
135
|
-
predefinedBindingParentEntityKey?: string;
|
|
136
|
-
predefinedBindingRelationImportMode?: "child_binding" | "relation_only";
|
|
137
|
-
predefinedBindingRemoteCollectionId?: string;
|
|
138
|
-
predefinedBindingRemoteCollectionName?: string;
|
|
139
|
-
predefinedBindingSourceEntityKey?: string;
|
|
140
|
-
predefinedBindingTargetEntityKey?: string;
|
|
141
|
-
predefinedSchedules?: readonly C.KnowledgePredefinedSchedule[];
|
|
142
|
-
supportedSyncModes?: readonly ("delta" | "full")[];
|
|
143
|
-
supportsInbound?: boolean;
|
|
144
|
-
supportsOutbound?: boolean;
|
|
145
|
-
syncIntervalSeconds?: number | null;
|
|
146
|
-
updateMode?: "full" | "partial";
|
|
147
|
-
}> & import("../index.js").JsonObject>;
|
|
148
127
|
export declare const discoveryDefaults: ReadValue<Readonly<{
|
|
149
128
|
extraPropsMode: "ignore" | "import" | "inline";
|
|
150
129
|
outboundStrategy: "local_first" | "remote_first";
|
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import type { ClassDeclaredComponent, ConnectionImplementation, DeclaredComponent, DocumentsConnectorImplementation, ErasedWorkflowFieldImplementation, EventListenerImplementation, FieldTransformerImplementation, KnowledgeConnectorImplementation, KnowledgeConnectorOAuthImplementation, KnowledgeEntityAdapterImplementation,
|
|
2
|
-
import type { ConnectionDeclaration, DocumentsConnectorDeclaration, DatasetParserDeclaration, ExternalDatasetProviderDeclaration, ManagedDatasetProviderDeclaration, EmailProviderDeclaration, EventListenerDeclaration, KnowledgeConnectorDeclaration, KnowledgeConnectorOAuthDeclaration, KnowledgeEntityAdapterDeclaration,
|
|
1
|
+
import type { ClassDeclaredComponent, ConnectionImplementation, DeclaredComponent, DocumentsConnectorImplementation, ErasedWorkflowFieldImplementation, EventListenerImplementation, FieldTransformerImplementation, KnowledgeConnectorImplementation, KnowledgeConnectorOAuthImplementation, KnowledgeEntityAdapterImplementation, MetadataComponentManifest, NotificationChannelImplementation, PackageSchemaRuntimeSidecar, ToolImplementationConstructor, ToolSettingsOptionsImplementation, WorkflowNodeImplementationConstructor } from "../components/authoring-core.js";
|
|
2
|
+
import type { ConnectionDeclaration, DocumentsConnectorDeclaration, DatasetParserDeclaration, ExternalDatasetProviderDeclaration, ManagedDatasetProviderDeclaration, EmailProviderDeclaration, EventListenerDeclaration, KnowledgeConnectorDeclaration, KnowledgeConnectorOAuthDeclaration, KnowledgeEntityAdapterDeclaration, OrganizationSsoDeclaration, OutboundMessagingProviderDeclaration } from "../components/connectors.js";
|
|
3
3
|
import type { DatasetParserImplementation } from "../components/dataset-parser.js";
|
|
4
4
|
import type { ExternalDatasetProviderImplementation, ManagedDatasetProviderImplementation } from "../components/datasets.js";
|
|
5
5
|
import type { EmailProviderImplementation, OrganizationSsoImplementation, OutboundMessagingProviderImplementation } from "../components/executable-authoring.js";
|
|
@@ -8,7 +8,7 @@ import type { WorkflowFieldDeclaration, WorkflowNodeDeclaration } from "../compo
|
|
|
8
8
|
import type { HostedContributionDeclaration } from "../hosted/contributions.js";
|
|
9
9
|
import type { PackageManifest } from "./manifest.js";
|
|
10
10
|
import type { PackageVariablesDeclaration } from "./variables.js";
|
|
11
|
-
export type DeclaredPackageComponent = ClassDeclaredComponent<DatasetParserDeclaration, new () => DatasetParserImplementation> | ClassDeclaredComponent<ExternalDatasetProviderDeclaration, new () => ExternalDatasetProviderImplementation> | ClassDeclaredComponent<ManagedDatasetProviderDeclaration, new () => ManagedDatasetProviderImplementation> | ClassDeclaredComponent<OrganizationSsoDeclaration, new () => OrganizationSsoImplementation> | ClassDeclaredComponent<EmailProviderDeclaration, new () => EmailProviderImplementation> | ClassDeclaredComponent<OutboundMessagingProviderDeclaration, new () => OutboundMessagingProviderImplementation> | ClassDeclaredComponent<ToolDeclaration, ToolImplementationConstructor> | ClassDeclaredComponent<ConnectionDeclaration, new () => ConnectionImplementation<unknown>> | ClassDeclaredComponent<DocumentsConnectorDeclaration, new () => DocumentsConnectorImplementation> | ClassDeclaredComponent<KnowledgeConnectorDeclaration, new () => KnowledgeConnectorImplementation> | ClassDeclaredComponent<KnowledgeConnectorOAuthDeclaration, new () => KnowledgeConnectorOAuthImplementation> | ClassDeclaredComponent<WorkflowNodeDeclaration, WorkflowNodeImplementationConstructor> | ClassDeclaredComponent<WorkflowFieldDeclaration, new () => ErasedWorkflowFieldImplementation> | ClassDeclaredComponent<EventListenerDeclaration, new () => EventListenerImplementation> | ClassDeclaredComponent<KnowledgeEntityAdapterDeclaration, new () => KnowledgeEntityAdapterImplementation> | ClassDeclaredComponent<
|
|
11
|
+
export type DeclaredPackageComponent = ClassDeclaredComponent<DatasetParserDeclaration, new () => DatasetParserImplementation> | ClassDeclaredComponent<ExternalDatasetProviderDeclaration, new () => ExternalDatasetProviderImplementation> | ClassDeclaredComponent<ManagedDatasetProviderDeclaration, new () => ManagedDatasetProviderImplementation> | ClassDeclaredComponent<OrganizationSsoDeclaration, new () => OrganizationSsoImplementation> | ClassDeclaredComponent<EmailProviderDeclaration, new () => EmailProviderImplementation> | ClassDeclaredComponent<OutboundMessagingProviderDeclaration, new () => OutboundMessagingProviderImplementation> | ClassDeclaredComponent<ToolDeclaration, ToolImplementationConstructor> | ClassDeclaredComponent<ConnectionDeclaration, new () => ConnectionImplementation<unknown>> | ClassDeclaredComponent<DocumentsConnectorDeclaration, new () => DocumentsConnectorImplementation> | ClassDeclaredComponent<KnowledgeConnectorDeclaration, new () => KnowledgeConnectorImplementation> | ClassDeclaredComponent<KnowledgeConnectorOAuthDeclaration, new () => KnowledgeConnectorOAuthImplementation> | ClassDeclaredComponent<WorkflowNodeDeclaration, WorkflowNodeImplementationConstructor> | ClassDeclaredComponent<WorkflowFieldDeclaration, new () => ErasedWorkflowFieldImplementation> | ClassDeclaredComponent<EventListenerDeclaration, new () => EventListenerImplementation> | ClassDeclaredComponent<KnowledgeEntityAdapterDeclaration, new () => KnowledgeEntityAdapterImplementation> | ClassDeclaredComponent<FieldTransformerDeclaration, new () => FieldTransformerImplementation> | ClassDeclaredComponent<NotificationChannelDeclaration, new () => NotificationChannelImplementation> | ClassDeclaredComponent<ToolSettingsOptionsDeclaration, new () => ToolSettingsOptionsImplementation> | DeclaredComponent<MetadataComponentManifest>;
|
|
12
12
|
/** Backwards-compatible name for the discriminated package component union. */
|
|
13
13
|
export type PackageComponent = DeclaredPackageComponent;
|
|
14
14
|
export type DeclaredPackageManifest = PackageManifest;
|
|
@@ -124,6 +124,12 @@ export declare const lifecycle: ReadValue<Readonly<{
|
|
|
124
124
|
deployMode: import("../index.js").LifecycleDeployMode;
|
|
125
125
|
readonly: boolean;
|
|
126
126
|
}> & import("../index.js").JsonObject>;
|
|
127
|
+
/**
|
|
128
|
+
* Refuses a key retired with Record Relations by name. The object reader keeps
|
|
129
|
+
* unknown keys, so the retired key is refused here; only stored-release reads
|
|
130
|
+
* drop it.
|
|
131
|
+
*/
|
|
132
|
+
export declare const withoutRetiredRelationKey: <A extends object>(read: ReadValue<A>, key: string) => ReadValue<A>;
|
|
127
133
|
export declare const autocompleteConfiguration: ReadValue<Readonly<{
|
|
128
134
|
autocompleteFields: readonly K.KnowledgeAutocompleteFieldReference[];
|
|
129
135
|
defaultAutocompleteFields: readonly K.KnowledgeAutocompleteFieldReference[];
|
|
@@ -8,7 +8,7 @@ export declare const policyBody: ReadValue<Readonly<{
|
|
|
8
8
|
}> & import("../index.js").JsonObject>;
|
|
9
9
|
/** Only an allow filter policy on entities may hold a field write rule. */
|
|
10
10
|
export declare const fieldWriteRule: <A extends Pick<KnowledgePolicyDeclaration, "effect" | "policyBody" | "policyType" | "targetKind">>(policy: A, path: string) => A;
|
|
11
|
-
/** Only a policy on one entity schema may follow its
|
|
11
|
+
/** Only a policy on one entity schema may follow its Reference Fields. */
|
|
12
12
|
export declare const relationScopeRule: <A extends Pick<KnowledgePolicyDeclaration, "policyBody" | "targetKind">>(policy: A, path: string) => A;
|
|
13
13
|
export declare const policyFields: {
|
|
14
14
|
effect: ReadValue<"allow" | "deny">;
|
|
@@ -19,5 +19,5 @@ export declare const policyFields: {
|
|
|
19
19
|
}> & import("../index.js").JsonObject>;
|
|
20
20
|
policyType: ReadValue<"filter" | "gate">;
|
|
21
21
|
targetFqn: ReadValue<string>;
|
|
22
|
-
targetKind: ReadValue<"entity_domain" | "entity_schema"
|
|
22
|
+
targetKind: ReadValue<"entity_domain" | "entity_schema">;
|
|
23
23
|
};
|
|
@@ -165,7 +165,6 @@ export declare const primitives: {
|
|
|
165
165
|
domainFqn: string;
|
|
166
166
|
domainName: string;
|
|
167
167
|
entitySchemaFqns: readonly string[];
|
|
168
|
-
relationSchemaFqns: readonly string[];
|
|
169
168
|
}> & JsonObject>;
|
|
170
169
|
emailProvider: ReadValue<Readonly<{
|
|
171
170
|
description?: string;
|
|
@@ -274,14 +273,15 @@ export declare const primitives: {
|
|
|
274
273
|
contributions?: readonly C.KnowledgeConnectorContribution[];
|
|
275
274
|
defaultOutboundStrategy?: "local_first" | "remote_first";
|
|
276
275
|
defaultUpdateMode?: "full" | "partial";
|
|
276
|
+
deltaOverlapSeconds?: number;
|
|
277
277
|
discoveryDefaults?: C.KnowledgeConnectorDiscoveryDefaults;
|
|
278
278
|
entityIdentityMode?: "adapter" | "item_metadata";
|
|
279
279
|
entitySchemaCapabilities?: readonly C.KnowledgeEntitySchemaCapability[];
|
|
280
280
|
isSingleton?: boolean;
|
|
281
281
|
outboundCapability?: "declared_and_enablable" | "none";
|
|
282
|
+
pullPageSize?: number;
|
|
282
283
|
remoteDeletion?: C.KnowledgeConnectorRemoteDeletion;
|
|
283
284
|
recommendedImportSchedules?: readonly C.KnowledgePredefinedSchedule[];
|
|
284
|
-
relationSchemaCapabilities?: readonly C.KnowledgeRelationSchemaCapability[];
|
|
285
285
|
remoteReference?: C.KnowledgeConnectorRemoteReference;
|
|
286
286
|
settings?: import("../index.js").PortableFormDefinition;
|
|
287
287
|
supportedBindingModes?: readonly ("external" | "managed")[];
|
|
@@ -323,45 +323,12 @@ export declare const primitives: {
|
|
|
323
323
|
version: string;
|
|
324
324
|
}> & Readonly<{
|
|
325
325
|
effect: "allow" | "deny";
|
|
326
|
-
targetKind: "entity_domain" | "entity_schema"
|
|
326
|
+
targetKind: "entity_domain" | "entity_schema";
|
|
327
327
|
policyBody: K.KnowledgePolicyBody;
|
|
328
328
|
policyType: "filter" | "gate";
|
|
329
329
|
priority?: number;
|
|
330
330
|
targetFqn: string;
|
|
331
331
|
}> & JsonObject;
|
|
332
|
-
knowledgeRelationAdapter: ReadValue<Readonly<{
|
|
333
|
-
description?: string;
|
|
334
|
-
displayName: string;
|
|
335
|
-
fqn: string;
|
|
336
|
-
icon?: string;
|
|
337
|
-
kind: "knowledgeRelationAdapter";
|
|
338
|
-
tags?: readonly string[];
|
|
339
|
-
version: string;
|
|
340
|
-
}> & Readonly<{
|
|
341
|
-
connectorFqn: string;
|
|
342
|
-
relationSchemaFqn: string;
|
|
343
|
-
}> & JsonObject>;
|
|
344
|
-
knowledgeRelationSchema: ReadValue<Readonly<{
|
|
345
|
-
description?: string;
|
|
346
|
-
displayName: string;
|
|
347
|
-
fqn: string;
|
|
348
|
-
icon?: string;
|
|
349
|
-
kind: "knowledgeRelationSchema";
|
|
350
|
-
tags?: readonly string[];
|
|
351
|
-
version: string;
|
|
352
|
-
}> & Readonly<{
|
|
353
|
-
catalogTags?: Cat.CatalogTags;
|
|
354
|
-
domainFqn: string;
|
|
355
|
-
lifecycle?: import("../index.js").LifecycleOptions;
|
|
356
|
-
localMutationPolicy?: "always" | "connector_backed" | "never";
|
|
357
|
-
managedProjection?: K.KnowledgeManagedProjection;
|
|
358
|
-
fieldLocalization?: Readonly<Record<string, K.KnowledgeFieldLocalization>>;
|
|
359
|
-
fieldPresentation?: Readonly<Record<string, K.KnowledgeFieldPresentation>>;
|
|
360
|
-
fieldSemantics?: Readonly<Record<string, K.KnowledgeFieldSemantics>>;
|
|
361
|
-
schema: import("../index.js").PackageSchemaProjection;
|
|
362
|
-
sourceSchemaFqn: string;
|
|
363
|
-
targetSchemaFqn: string;
|
|
364
|
-
}> & JsonObject>;
|
|
365
332
|
managedDatasetProvider: ReadValue<Readonly<{
|
|
366
333
|
description?: string;
|
|
367
334
|
displayName: string;
|
|
@@ -6,6 +6,12 @@ import type { ExtensionReleaseManifest } from "./manifest.js";
|
|
|
6
6
|
* a Studio App Template stored as `studioApp`.
|
|
7
7
|
*/
|
|
8
8
|
export declare const storedPrimitiveKind: (stored: unknown) => string | undefined;
|
|
9
|
+
/**
|
|
10
|
+
* Returns one stored primitive declaration with the current spelling that
|
|
11
|
+
* {@link withCurrentPrimitiveKinds} gives each primitive of a stored release.
|
|
12
|
+
* A reader of a stored definition baseline calls it after the digest check.
|
|
13
|
+
*/
|
|
14
|
+
export declare const withCurrentPrimitive: (primitive: JsonObject) => JsonObject;
|
|
9
15
|
/**
|
|
10
16
|
* Returns a stored release manifest whose retained primitive declarations use
|
|
11
17
|
* the current spelling: current kind names, a Studio App Template in place of
|
|
@@ -13,7 +19,11 @@ export declare const storedPrimitiveKind: (stored: unknown) => string | undefine
|
|
|
13
19
|
* `invokingApplicationFqns`, and Organization Group names in place of
|
|
14
20
|
* Organization Team names. Historical Entity Relation Field cardinalities map
|
|
15
21
|
* one/many to many_to_one/many_to_many; valid redundant scalar maxItems is
|
|
16
|
-
* removed. Every other relation setting is retained.
|
|
22
|
+
* removed. Every other relation setting is retained. Components of a kind
|
|
23
|
+
* retired with Record Relations, the retired relation keys of current
|
|
24
|
+
* components, `relation` pipeline tasks and each step or pipeline left without
|
|
25
|
+
* a task are dropped; a retired nested policy form still fails the read. A
|
|
26
|
+
* reader that
|
|
17
27
|
* executes the release archive compares the verbatim stored JSON with the
|
|
18
28
|
* archive before it calls this function.
|
|
19
29
|
*/
|
|
@@ -8,7 +8,6 @@ export declare const SchemaConsumerProfiles: Readonly<{
|
|
|
8
8
|
readonly connectorSettings: "interactive_form";
|
|
9
9
|
readonly form: "interactive_form";
|
|
10
10
|
readonly knowledgeEntity: "knowledge_record";
|
|
11
|
-
readonly knowledgeRelation: "knowledge_record";
|
|
12
11
|
readonly notificationCredential: "interactive_form";
|
|
13
12
|
readonly studioComponentProps: "studio_props";
|
|
14
13
|
readonly toolInput: "ai_function_input";
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@collective-intelligence/extensions-sdk",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.29",
|
|
4
4
|
"description": "Framework-neutral authoring contracts for Collective Intelligence extension packages.",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"sideEffects": false,
|
|
@@ -45,5 +45,5 @@
|
|
|
45
45
|
"typescript": "7.0.2",
|
|
46
46
|
"ultracite": "7.10.7"
|
|
47
47
|
},
|
|
48
|
-
"gitHead": "
|
|
48
|
+
"gitHead": "02f5d1b5a00cf4cfb8575f6cc556c7c6b844577d"
|
|
49
49
|
}
|