@collective-intelligence/external-apps-client-sdk 0.1.9 → 0.1.10

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { $ as ResourceUpdateRequest, A as ResourceError, At as FederatedAuthOptions, B as ResourceListRequest, C as PortableResourceSchema, Ct as QueryFilter, D as ResourceCreateRequest, Dt as FederatedAuth, E as ResourceCreateInput, Et as ClientFetch, F as ResourceIdentityField, G as ResourceRecord, H as ResourceMutationInput, I as ResourceJsonValue, J as ResourceResult, K as ResourceRecordId, L as ResourceLifecycleInput, M as ResourceFilter, Mt as FederatedSessionIdentity, N as ResourceGetRequest, Nt as createFederatedAuth, O as ResourceCursor, Ot as FederatedAuthError, P as ResourceId, Q as ResourceTransportRequest, R as ResourceLifecycleRequest, S as IdempotencyKey, St as KnowledgeQuery, T as ResourceClient, Tt as WorkflowInvokeTarget, U as ResourcePagination, V as ResourceListResult, W as ResourcePaginationMode, X as ResourceSort, Y as ResourceRevision, Z as ResourceTransport, _ as EntityRequest, _t as isClientOperationId, a as createResourceClient, at as CiResult, b as EntityUploadInput, bt as ConversationHistory, c as EntityDeleteInput, ct as OperationSuccess, d as EntityFileWrite, dt as ClientOperationInput, et as ProxyAuthentication, f as EntityListQuery, ft as ClientOperationMap, g as EntityProtocol, gt as clientOperationIds, h as EntityPage, ht as TypedOperationExecutor, i as createEntityProtocol, it as CiErrorCode, j as ResourceErrorCode, jt as FederatedAuthState, k as ResourceDefinition, kt as FederatedAuthErrorCode, l as EntityFileFieldWrite, lt as ClientOperationDefinition, m as EntityOperationResult, mt as OperationExecutionOptions, n as EntityHttpTransportOptions, nt as createProxyTransport, o as EntityClient, ot as JsonValue, p as EntityOperation, pt as ClientOperationOutput, q as ResourceRequestOptions, r as createEntityHttpTransport, rt as CiError, s as EntityCreateInput, st as OperationRequest, t as EntityHttpDestination, tt as ProxyTransportOptions, u as EntityFileValue, ut as ClientOperationId, v as EntityTransport, vt as AgentInvokeTarget, w as ResourceCapabilities, wt as SearchQuery, x as EntityUploadSlot, xt as JsonObject, y as EntityUpdateInput, yt as ConversationContinueTarget, z as ResourceListQuery } from "./resources-DxMBAy-Z.js";
+import { $ as ResourceUpdateRequest, A as ResourceError, At as FederatedAuthOptions, B as ResourceListRequest, C as PortableResourceSchema, Ct as QueryFilter, D as ResourceCreateRequest, Dt as FederatedAuth, E as ResourceCreateInput, Et as ClientFetch, F as ResourceIdentityField, G as ResourceRecord, H as ResourceMutationInput, I as ResourceJsonValue, J as ResourceResult, K as ResourceRecordId, L as ResourceLifecycleInput, M as ResourceFilter, Mt as FederatedSessionIdentity, N as ResourceGetRequest, Nt as createFederatedAuth, O as ResourceCursor, Ot as FederatedAuthError, P as ResourceId, Q as ResourceTransportRequest, R as ResourceLifecycleRequest, S as IdempotencyKey, St as KnowledgeQuery, T as ResourceClient, Tt as WorkflowInvokeTarget, U as ResourcePagination, V as ResourceListResult, W as ResourcePaginationMode, X as ResourceSort, Y as ResourceRevision, Z as ResourceTransport, _ as EntityRequest, _t as isClientOperationId, a as createResourceClient, at as CiResult, b as EntityUploadInput, bt as ConversationHistory, c as EntityDeleteInput, ct as OperationSuccess, d as EntityFileWrite, dt as ClientOperationInput, et as ProxyAuthentication, f as EntityListQuery, ft as ClientOperationMap, g as EntityProtocol, gt as clientOperationIds, h as EntityPage, ht as TypedOperationExecutor, i as createEntityProtocol, it as CiErrorCode, j as ResourceErrorCode, jt as FederatedAuthState, k as ResourceDefinition, kt as FederatedAuthErrorCode, l as EntityFileFieldWrite, lt as ClientOperationDefinition, m as EntityOperationResult, mt as OperationExecutionOptions, n as EntityHttpTransportOptions, nt as createProxyTransport, o as EntityClient, ot as JsonValue, p as EntityOperation, pt as ClientOperationOutput, q as ResourceRequestOptions, r as createEntityHttpTransport, rt as CiError, s as EntityCreateInput, st as OperationRequest, t as EntityHttpDestination, tt as ProxyTransportOptions, u as EntityFileValue, ut as ClientOperationId, v as EntityTransport, vt as AgentInvokeTarget, w as ResourceCapabilities, wt as SearchQuery, x as EntityUploadSlot, xt as JsonObject, y as EntityUpdateInput, yt as ConversationContinueTarget, z as ResourceListQuery } from "./resources-D0bzEPx3.js";
 type ServerSessionAuthOptions = Readonly<{
   basePath: string;
   fetch?: ClientFetch;

package/dist/index.js

@@ -1,4 +1,4 @@
-import { a as parseMountPath, c as isClientOperationId, i as createHttpOperationTransport, n as createResourceClient, o as parseOriginUrl, r as createEntityProtocol, s as clientOperationIds, t as createEntityHttpTransport } from "./resources-BP_TaCP6.js";
+import { a as parseMountPath, c as isClientOperationId, i as createHttpOperationTransport, n as createResourceClient, o as parseOriginUrl, r as createEntityProtocol, s as clientOperationIds, t as createEntityHttpTransport } from "./resources-C0wYfzcV.js";
 const base64Url = (bytes) => {
 	let binary = "";
 	for (const byte of bytes) binary += String.fromCodePoint(byte);

package/dist/{resources-BP_TaCP6.js → resources-C0wYfzcV.js}

@@ -7575,6 +7575,36 @@ const objectSchema = (properties, required = Object.keys(properties)) => ({
 	required,
 	type: "object"
 });
+/**
+* Include Paths: relation fields whose records a read returns in
+* `included`, such as `["company", "contacts.company"]`, at most three
+* levels deep. CI refuses a segment that names no relation field.
+*/
+const includeSchema = {
+	items: {
+		minLength: 1,
+		pattern: "^[^.]+(\\.[^.]+){0,2}$",
+		type: "string"
+	},
+	type: "array"
+};
+const escapePattern = (value) => value.replaceAll(/[$()*+.?[\\\]^{|}]/gu, "\\$&");
+/**
+* The Entity References a declared property holds: `one` uuid string, or
+* `many` as an array of uuid strings.
+*/
+const references = (property) => {
+	if (property === null || typeof property !== "object" || Array.isArray(property)) return;
+	if ("format" in property && property.format === "uuid") return "one";
+	const items = "items" in property ? property.items : void 0;
+	return items !== null && typeof items === "object" && !Array.isArray(items) && "format" in items && items.format === "uuid" ? "many" : void 0;
+};
+/**
+* A path through a field that holds Entity References, such as
+* `company.industry`: at most three relation fields and a field of the
+* last target, as CI resolves it.
+*/
+const relationPath = (field) => ({ pattern: `^${escapePattern(field)}(\\.[^.]+){1,3}$` });
 const pointerKey = (key) => key.replaceAll("~", "~0").replaceAll("/", "~1");
 const schemaMaps = /* @__PURE__ */ new Set([
 	"$defs",
@@ -7651,42 +7681,95 @@ const entityQuerySchema = (definition) => {
 		...definition.query.sortableFields,
 		...definition.query.textSearchFields ?? []
 	]) if (!Object.hasOwn(properties, field)) throw new TypeError(`Query field '${field}' has no declared entity property`);
-	const filter = { oneOf: [
-		...definition.query.filterableFields.flatMap((field) => {
-			const value = { $ref: `#/$defs/filterEntity/properties/${pointerKey(field)}` };
-			const nullable = { anyOf: [value, { type: "null" }] };
-			const predicate = (operators, valueSchema) => {
-				const predicateProperties = {
-					field: { const: field },
-					operator: { enum: operators }
-				};
-				if (valueSchema === void 0) return objectSchema(predicateProperties);
-				return objectSchema({
-					...predicateProperties,
-					value: valueSchema
-				});
+	const leaves = definition.query.filterableFields.flatMap((field) => {
+		const cardinality = references(properties[field]);
+		const value = { $ref: `#/$defs/filterEntity/properties/${pointerKey(field)}` };
+		const nullable = { anyOf: [cardinality === "many" ? {
+			format: "uuid",
+			type: "string"
+		} : value, { type: "null" }] };
+		const predicate = (operators, valueSchema) => {
+			const predicateProperties = {
+				field: { const: field },
+				operator: { enum: operators }
 			};
-			return [
-				predicate(["is_null", "is_not_null"]),
-				predicate(["eq", "ne"], nullable),
-				predicate([
-					"gt",
-					"gte",
-					"lt",
-					"lte"
-				], { allOf: [value, { type: ["number", "string"] }] }),
-				predicate([
-					"contains",
-					"starts_with",
-					"ends_with"
-				], { allOf: [value, { type: "string" }] }),
-				predicate(["in", "not_in"], {
-					items: nullable,
-					minItems: 1,
-					type: "array"
-				})
-			];
+			if (valueSchema === void 0) return objectSchema(predicateProperties);
+			return objectSchema({
+				...predicateProperties,
+				value: valueSchema
+			});
+		};
+		return [
+			predicate(cardinality === void 0 ? ["is_null", "is_not_null"] : [
+				"is_null",
+				"is_not_null",
+				"is_empty"
+			]),
+			...cardinality === "many" ? [predicate(["contains_any", "contains_all"], {
+				items: { $ref: `${value.$ref}/items` },
+				minItems: 1,
+				type: "array"
+			})] : [],
+			predicate(["eq", "ne"], nullable),
+			predicate([
+				"gt",
+				"gte",
+				"lt",
+				"lte"
+			], { allOf: [value, { type: ["number", "string"] }] }),
+			predicate([
+				"contains",
+				"starts_with",
+				"ends_with"
+			], { allOf: [value, { type: "string" }] }),
+			predicate(["in", "not_in"], {
+				items: nullable,
+				minItems: 1,
+				type: "array"
+			})
+		];
+	});
+	const relationPaths = definition.query.filterableFields.flatMap((field) => references(properties[field]) === void 0 ? [] : [
+		objectSchema({
+			field: relationPath(field),
+			operator: { enum: [
+				"contains",
+				"ends_with",
+				"eq",
+				"gt",
+				"gte",
+				"ne",
+				"lt",
+				"lte",
+				"starts_with"
+			] },
+			value: true
 		}),
+		objectSchema({
+			field: relationPath(field),
+			operator: { enum: [
+				"in",
+				"not_in",
+				"contains_any",
+				"contains_all"
+			] },
+			value: {
+				minItems: 1,
+				type: "array"
+			}
+		}),
+		objectSchema({
+			field: relationPath(field),
+			operator: { enum: [
+				"is_null",
+				"is_not_null",
+				"is_empty"
+			] }
+		})
+	]);
+	const filter = { oneOf: [
+		...leaves,
+		...relationPaths,
 		objectSchema({
 			filters: {
 				items: { $ref: "#/$defs/filter" },
@@ -7714,6 +7797,7 @@ const entityQuerySchema = (definition) => {
 	});
 	const query = objectSchema({
 		filter: { $ref: "#/$defs/filter" },
+		include: includeSchema,
 		pagination: page,
 		sort: {
 			items: objectSchema({
@@ -7739,10 +7823,11 @@ const uploadText = {
 	minLength: 1,
 	type: "string"
 };
-const requestSchema = (definition, operation, properties) => ({
+const requestSchema = (definition, operation, properties, optional = {}) => ({
 	additionalProperties: false,
 	properties: {
 		...properties,
+		...optional,
 		operation: { const: operation },
 		requestId: identifier,
 		resourceId: { const: definition.id }
@@ -7779,7 +7864,7 @@ const createEntityProtocol = (definition) => {
 		},
 		oneOf: [
 			requestSchema(definition, "list", { query }),
-			requestSchema(definition, "get", { id: identifier }),
+			requestSchema(definition, "get", { id: identifier }, { include: includeSchema }),
 			requestSchema(definition, "create", {
 				idempotencyKey: operationKey,
 				value: { $ref: "#/$defs/create" }
@@ -7811,7 +7896,12 @@ const createEntityProtocol = (definition) => {
 			type: "string"
 		},
 		id: identifier,
+		included: { type: "object" },
 		revision: identifier,
+		truncated: {
+			items: { type: "string" },
+			type: "array"
+		},
 		value: { $ref: "#/$defs/entity" }
 	}, [
 		"id",
@@ -8144,10 +8234,13 @@ const encode = (request) => {
 			method: "POST",
 			path: "/search"
 		};
-		case "get": return {
-			method: "GET",
-			path: `/records/${encodeURIComponent(request.id)}`
-		};
+		case "get": {
+			const query = request.include?.length ? `?include=${encodeURIComponent(request.include.join(","))}` : "";
+			return {
+				method: "GET",
+				path: `/records/${encodeURIComponent(request.id)}${query}`
+			};
+		}
 		case "create": return {
 			body: JSON.stringify({
 				idempotencyKey: request.idempotencyKey,

package/dist/{resources-DxMBAy-Z.d.ts → resources-D0bzEPx3.d.ts}

@@ -422,6 +422,11 @@ type ExternalApplicationServiceOperationRequest = {
     userId: string;
   };
   operationId: "members_remove";
+} | {
+  input: {
+    origin: string;
+  };
+  operationId: "origins_set_runtime";
 } | {
   input: {
     userId: string;
@@ -444,6 +449,8 @@ type ExternalApplicationServiceOperationSuccess = EnvelopeSuccess<"files_upload"
   outcome: MemberUserResolution;
 }> | EnvelopeSuccess<"members_get", MemberUser> | EnvelopeSuccess<"members_list", MemberUserPage> | EnvelopeSuccess<"members_update", MemberUser> | EnvelopeSuccess<"members_remove", {
   userId: string;
+}> | EnvelopeSuccess<"origins_set_runtime", {
+  origin: string;
 }> | EnvelopeSuccess<"users_list_company_links", UserCompanyLinks> | EnvelopeSuccess<"users_link_companies", UserCompanyLinks>;
 /** Every operation a confidential server client may invoke. */
 type ExternalApplicationServerOperationRequest = ExternalApplicationOperationRequest | ExternalApplicationServiceOperationRequest;
@@ -572,13 +579,21 @@ type ResourceDefinition<Entity, Create = Entity, Update = Partial<Entity>> = Rea
   }>;
 }>;
 type FilterValue = ResourceJsonValue | readonly ResourceJsonValue[];
+/**
+ * A filter predicate. `field` names a declared filterable field, or a path
+ * through at most three fields that hold Entity References to a field of
+ * the last target, such as `company.industry` or
+ * `contacts.company.parent.industry`. On a field that holds Entity
+ * References, `is_empty` means no reference, and `contains_any` and
+ * `contains_all` compare the ids of a field that holds many.
+ */
 type ResourceFilter = Readonly<{
   field: string;
-  operator: "contains" | "ends_with" | "eq" | "gt" | "gte" | "in" | "lt" | "lte" | "ne" | "not_in" | "starts_with";
+  operator: "contains" | "contains_all" | "contains_any" | "ends_with" | "eq" | "gt" | "gte" | "in" | "lt" | "lte" | "ne" | "not_in" | "starts_with";
   value: FilterValue;
 }> | Readonly<{
   field: string;
-  operator: "is_not_null" | "is_null";
+  operator: "is_empty" | "is_not_null" | "is_null";
 }> | Readonly<{
   filters: readonly ResourceFilter[];
   operator: "and" | "or";
@@ -601,6 +616,11 @@ type ResourcePagination = Readonly<{
 }>;
 type ResourceListQuery = Readonly<{
   filter?: ResourceFilter;
+  /**
+   * Include Paths, such as `["company", "contacts.company"]`: relation
+   * fields whose records each item carries in `included`.
+   */
+  include?: readonly string[];
   includeDeleted?: boolean;
   pagination: ResourcePagination;
   sort?: readonly ResourceSort[];
@@ -609,7 +629,15 @@ type ResourceListQuery = Readonly<{
 type ResourceRecord<Entity> = Readonly<{
   deletedAt?: string;
   id: ResourceRecordId;
+  /**
+   * The records of the read's Include Paths by relation field key: one
+   * record, or the records of a `many` field in reference order. Untyped:
+   * the target schemas are CI's.
+   */
+  included?: Readonly<Record<string, ResourceJsonValue>>;
   revision: ResourceRevision;
+  /** The keys whose included records were cut to the first 100. */
+  truncated?: readonly string[];
   value: Entity;
 }>;
 type ResourceListResult<Entity> = Readonly<{
@@ -780,6 +808,7 @@ type EntityRequest<Create = unknown, Patch = unknown> = EntityRequestIdentity &
 }> | Readonly<{
   operation: "get";
   id: ResourceRecordId;
+  include?: readonly string[];
 }> | (Readonly<{
   operation: "create";
 }> & EntityCreateInput<Create>) | (Readonly<{
@@ -804,6 +833,7 @@ interface EntityClient<Value, Create = Value, Patch = Partial<Value>> {
   readonly list: (query: EntityListQuery, options?: ResourceRequestOptions) => Promise<ResourceResult<EntityPage<Value>>>;
   readonly get: (input: Readonly<{
     id: ResourceRecordId;
+    include?: readonly string[];
   }>, options?: ResourceRequestOptions) => Promise<ResourceResult<ResourceRecord<Value>>>;
   readonly create: (input: EntityCreateInput<Create>) => Promise<ResourceResult<ResourceRecord<Value>>>;
   readonly update: (input: EntityUpdateInput<Patch>) => Promise<ResourceResult<ResourceRecord<Value>>>;

package/dist/resources.d.ts

@@ -1,2 +1,2 @@
-import { $ as ResourceUpdateRequest, A as ResourceError, B as ResourceListRequest, C as PortableResourceSchema, D as ResourceCreateRequest, E as ResourceCreateInput, F as ResourceIdentityField, G as ResourceRecord, H as ResourceMutationInput, I as ResourceJsonValue, J as ResourceResult, K as ResourceRecordId, L as ResourceLifecycleInput, M as ResourceFilter, N as ResourceGetRequest, O as ResourceCursor, P as ResourceId, Q as ResourceTransportRequest, R as ResourceLifecycleRequest, S as IdempotencyKey, T as ResourceClient, U as ResourcePagination, V as ResourceListResult, W as ResourcePaginationMode, X as ResourceSort, Y as ResourceRevision, Z as ResourceTransport, _ as EntityRequest, a as createResourceClient, b as EntityUploadInput, c as EntityDeleteInput, d as EntityFileWrite, f as EntityListQuery, g as EntityProtocol, h as EntityPage, i as createEntityProtocol, j as ResourceErrorCode, k as ResourceDefinition, l as EntityFileFieldWrite, m as EntityOperationResult, n as EntityHttpTransportOptions, o as EntityClient, p as EntityOperation, q as ResourceRequestOptions, r as createEntityHttpTransport, s as EntityCreateInput, t as EntityHttpDestination, u as EntityFileValue, v as EntityTransport, w as ResourceCapabilities, x as EntityUploadSlot, y as EntityUpdateInput, z as ResourceListQuery } from "./resources-DxMBAy-Z.js";
+import { $ as ResourceUpdateRequest, A as ResourceError, B as ResourceListRequest, C as PortableResourceSchema, D as ResourceCreateRequest, E as ResourceCreateInput, F as ResourceIdentityField, G as ResourceRecord, H as ResourceMutationInput, I as ResourceJsonValue, J as ResourceResult, K as ResourceRecordId, L as ResourceLifecycleInput, M as ResourceFilter, N as ResourceGetRequest, O as ResourceCursor, P as ResourceId, Q as ResourceTransportRequest, R as ResourceLifecycleRequest, S as IdempotencyKey, T as ResourceClient, U as ResourcePagination, V as ResourceListResult, W as ResourcePaginationMode, X as ResourceSort, Y as ResourceRevision, Z as ResourceTransport, _ as EntityRequest, a as createResourceClient, b as EntityUploadInput, c as EntityDeleteInput, d as EntityFileWrite, f as EntityListQuery, g as EntityProtocol, h as EntityPage, i as createEntityProtocol, j as ResourceErrorCode, k as ResourceDefinition, l as EntityFileFieldWrite, m as EntityOperationResult, n as EntityHttpTransportOptions, o as EntityClient, p as EntityOperation, q as ResourceRequestOptions, r as createEntityHttpTransport, s as EntityCreateInput, t as EntityHttpDestination, u as EntityFileValue, v as EntityTransport, w as ResourceCapabilities, x as EntityUploadSlot, y as EntityUpdateInput, z as ResourceListQuery } from "./resources-D0bzEPx3.js";
 export { type EntityClient, type EntityCreateInput, type EntityDeleteInput, type EntityFileFieldWrite, type EntityFileValue, type EntityFileWrite, type EntityHttpDestination, type EntityHttpTransportOptions, type EntityListQuery, type EntityOperation, type EntityOperationResult, type EntityPage, type EntityProtocol, type EntityRequest, type EntityTransport, type EntityUpdateInput, type EntityUploadInput, type EntityUploadSlot, type IdempotencyKey, type PortableResourceSchema, type ResourceCapabilities, type ResourceClient, type ResourceCreateInput, type ResourceCreateRequest, type ResourceCursor, type ResourceDefinition, type ResourceError, type ResourceErrorCode, type ResourceFilter, type ResourceGetRequest, type ResourceId, type ResourceIdentityField, type ResourceJsonValue, type ResourceLifecycleInput, type ResourceLifecycleRequest, type ResourceListQuery, type ResourceListRequest, type ResourceListResult, type ResourceMutationInput, type ResourcePagination, type ResourcePaginationMode, type ResourceRecord, type ResourceRecordId, type ResourceRequestOptions, type ResourceResult, type ResourceRevision, type ResourceSort, type ResourceTransport, type ResourceTransportRequest, type ResourceUpdateRequest, createEntityHttpTransport, createEntityProtocol, createResourceClient };

package/dist/resources.js

@@ -1,2 +1,2 @@
-import { n as createResourceClient, r as createEntityProtocol, t as createEntityHttpTransport } from "./resources-BP_TaCP6.js";
+import { n as createResourceClient, r as createEntityProtocol, t as createEntityHttpTransport } from "./resources-C0wYfzcV.js";
 export { createEntityHttpTransport, createEntityProtocol, createResourceClient };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@collective-intelligence/external-apps-client-sdk",
-  "version": "0.1.9",
+  "version": "0.1.10",
   "description": "Framework-neutral client for Collective Intelligence external applications.",
   "type": "module",
   "sideEffects": false,