@collective-intelligence/external-apps-client-sdk-react 0.1.35 → 0.1.36

package/dist/index.d.ts

@@ -1,894 +1,11 @@
 // Generated by dts-bundle-generator v9.5.1
 
+import { CiError as CiErrorEnvelope, CiErrorCode, CiResult, CiStreamPage, ClientDomains, ClientFetch, ClientOperationDefinition, ClientOperationId, ClientOperationInput, ClientOperationMap, ClientOperationOutput, ClientSdkClient, FederatedAuth, FederatedAuthError, FederatedAuthErrorCode, FederatedAuthState, FederatedSessionIdentity, FollowRunOptions, JsonValue, KnowledgeQuery, OperationExecutionOptions, OrganizationClient, QueryFilter, RealtimeChange, RealtimeClient, RealtimeClientOptions, RealtimeClientState, RealtimeClientStatus, RealtimeTopic, RealtimeTopicFilter, SearchQuery, TypedOperationExecutor, WorkflowInvokeTarget } from '@collective-intelligence/external-apps-client-sdk';
+import { EntityClient, EntityCreateInput, EntityDeleteInput, EntityListQuery, EntityMemberValue, EntityPage, EntityUpdateInput, EntityUploadInput, EntityUploadSlot, IdempotencyKey, PortableResourceSchema, ResourceCapabilities, ResourceCreateInput, ResourceCursor, ResourceDefinition, ResourceError, ResourceErrorCode, ResourceFilter, ResourceId, ResourceIdentityField, ResourceJsonValue, ResourceLifecycleInput, ResourceListQuery, ResourceListResult, ResourceMutationInput, ResourcePagination, ResourcePaginationMode, ResourceRecord, ResourceRecordId, ResourceRequestOptions, ResourceResult, ResourceRevision, ResourceSort } from '@collective-intelligence/external-apps-client-sdk/resources';
+import { ResourceField, ResourceFieldControlProps, ResourceObject, ResourceValue } from '@collective-intelligence/ui-react/resources';
+import { QueryClient } from '@tanstack/react-query';
 import { CSSProperties, ElementType, ReactNode } from 'react';
 
-export type FederatedAuthErrorCode = "configuration_error" | "invalid_return_target" | "invalid_callback" | "invalid_state" | "transaction_expired" | "authorization_failed" | "token_exchange_failed" | "reauthorization_required";
-declare class FederatedAuthError extends Error {
-	readonly code: FederatedAuthErrorCode;
-	constructor(code: FederatedAuthErrorCode, message: string);
-}
-/**
- * The signed-in CI user as the application's BFF reports it: the fields of
- * CI's `/oauth/identity`, read live by the server, plus email and name.
- */
-export type FederatedSessionIdentity = Readonly<{
-	appId: string;
-	/** The App Permissions of the user's effective roles. */
-	appPermissions: readonly string[];
-	email: string | null;
-	/** A person is a member or an External App User of one Organization, never both. */
-	kind: "member" | "external_app_user";
-	name: string | null;
-	organizationId: string;
-	/** The user's effective roles on the app. */
-	roles: readonly string[];
-	userId: string;
-}>;
-export type FederatedAuthState = Readonly<{
-	status: "anonymous";
-}> | Readonly<{
-	status: "redirecting";
-}> | Readonly<{
-	expiresAt: number;
-	identity?: FederatedSessionIdentity;
-	status: "authenticated";
-}> | Readonly<{
-	status: "expired";
-}> | Readonly<{
-	error: FederatedAuthError;
-	status: "error";
-}>;
-export type FederatedAuth = Readonly<{
-	beginLogin: (options: Readonly<{
-		returnTo: string;
-	}>) => Promise<string>;
-	completeLogin: (callbackUrl: string) => Promise<Readonly<{
-		returnTo: string;
-	}>>;
-	getAccessToken: () => Promise<string>;
-	getState: () => FederatedAuthState;
-	logout: () => Promise<void>;
-	reauthorize: (options?: Readonly<{
-		returnTo?: string;
-	}>) => Promise<string>;
-	subscribe: (listener: (state: FederatedAuthState) => void) => () => void;
-}>;
-export type ClientFetch = (input: RequestInfo | URL, init?: RequestInit) => Promise<Response>;
-export type ExternalApplicationsListAppUsersResponses = {
-	/**
-	 * Success
-	 */
-	200: {
-		correlationId: string;
-		result: {
-			items: Array<{
-				email: string | null;
-				name: string | null;
-				userId: string;
-			}>;
-		};
-	};
-};
-export type ExternalApplicationsListAppUsersResponse = ExternalApplicationsListAppUsersResponses[keyof ExternalApplicationsListAppUsersResponses];
-export type ExternalApplicationsCreateOrGetAppUserData = {
-	body: {
-		email: string;
-		name: string;
-		roles: Array<string>;
-	};
-	headers: {
-		authorization?: string;
-		"x-organization-id": string;
-		"x-correlation-id"?: string;
-		"x-external-audit-issuer"?: string;
-		"x-external-audit-subject"?: string;
-		"x-external-caller-kind"?: "anonymous_visitor";
-		"x-external-ci-user-id"?: string;
-		"x-external-server-role"?: string;
-	};
-	path?: never;
-	query?: never;
-	url: "/application/v1/users";
-};
-export type ExternalApplicationsCreateOrGetAppUserResponses = {
-	/**
-	 * Success
-	 */
-	200: {
-		correlationId: string;
-		result: {
-			email: string | null;
-			name: string | null;
-			userId: string;
-			created: boolean;
-			kind: "member" | "external_app_user";
-		};
-	};
-};
-export type ExternalApplicationsCreateOrGetAppUserResponse = ExternalApplicationsCreateOrGetAppUserResponses[keyof ExternalApplicationsCreateOrGetAppUserResponses];
-export type ExternalApplicationsCheckAppUserEmailData = {
-	body: {
-		email: string;
-	};
-	headers: {
-		authorization?: string;
-		"x-organization-id": string;
-		"x-correlation-id"?: string;
-		"x-external-audit-issuer"?: string;
-		"x-external-audit-subject"?: string;
-		"x-external-caller-kind"?: "anonymous_visitor";
-		"x-external-ci-user-id"?: string;
-		"x-external-server-role"?: string;
-	};
-	path?: never;
-	query?: never;
-	url: "/application/v1/users/check-email";
-};
-export type ExternalApplicationsCheckAppUserEmailResponses = {
-	/**
-	 * Success
-	 */
-	200: {
-		correlationId: string;
-		result: {
-			usable: true;
-		} | {
-			reason: "user_unavailable" | "target_inactive";
-			usable: false;
-		};
-	};
-};
-export type ExternalApplicationsCheckAppUserEmailResponse = ExternalApplicationsCheckAppUserEmailResponses[keyof ExternalApplicationsCheckAppUserEmailResponses];
-export type ExternalApplicationsGetAppUserResponses = {
-	/**
-	 * Success
-	 */
-	200: {
-		correlationId: string;
-		result: {
-			email: string | null;
-			name: string | null;
-			userId: string;
-		};
-	};
-};
-export type ExternalApplicationsGetAppUserResponse = ExternalApplicationsGetAppUserResponses[keyof ExternalApplicationsGetAppUserResponses];
-export type ExternalApplicationsListAppRolesResponses = {
-	/**
-	 * Success
-	 */
-	200: {
-		correlationId: string;
-		result: {
-			items: Array<{
-				id: string;
-				key: string;
-			}>;
-		};
-	};
-};
-export type ExternalApplicationsListAppRolesResponse = ExternalApplicationsListAppRolesResponses[keyof ExternalApplicationsListAppRolesResponses];
-export type JsonValue$1 = boolean | null | number | readonly JsonValue$1[] | Readonly<{
-	readonly [key: string]: JsonValue$1;
-}> | string;
-export type JsonObject = Readonly<Record<string, JsonValue$1>>;
-export type WorkflowInvokeTarget = {
-	workflowId: string;
-	workflowFqn?: never;
-} | {
-	workflowFqn: string;
-	workflowId?: never;
-};
-/** Addresses an Agent by its UUID or its in-organization FQN. */
-export type AgentInvokeTarget = {
-	agentId: string;
-	agentFqn?: never;
-} | {
-	agentFqn: string;
-	agentId?: never;
-};
-/** Starts a conversation with an Agent, or continues an existing one. */
-export type ConversationContinueTarget = (AgentInvokeTarget & {
-	conversationId?: never;
-}) | {
-	agentFqn?: never;
-	agentId?: never;
-	conversationId: string;
-};
-export type ConversationTurnStatus = "accepted" | "cancelled" | "failed" | "running" | "succeeded";
-/**
- * One conversation turn: the application's input, the Agent's final message
- * once its run succeeded, and the Agent Output the run saved, if any.
- * `runId` identifies the turn and its producing run.
- */
-export interface ConversationTurn {
-	completedAt: string | null;
-	createdAt: string;
-	input: unknown;
-	message: string | null;
-	output?: unknown;
-	runId: string;
-	status: ConversationTurnStatus;
-}
-export interface ConversationHistory {
-	agentId: string;
-	conversationId: string;
-	createdAt: string;
-	turns: ConversationTurn[];
-}
-export interface QueryFilter {
-	caseSensitive?: boolean;
-	field: string;
-	op: "eq" | "neq" | "in" | "contains" | "gt" | "gte" | "lt" | "lte" | "exists";
-	value?: unknown;
-}
-export interface SearchQuery {
-	cursor?: string;
-	entitySchemaId: string;
-	fields?: string[];
-	filters?: QueryFilter[];
-	limit?: number;
-	text?: string;
-}
-export type KnowledgeQuery = {
-	entityId: string;
-	op: "get";
-} | (SearchQuery & {
-	op: "search";
-}) | {
-	entitySchemaId: string;
-	fields: string[];
-	filters?: QueryFilter[];
-	op: "facets";
-	text?: string;
-} | (SearchQuery & {
-	op: "autocomplete";
-});
-export type ExternalApplicationOperationRequest = {
-	input: {
-		userId: string;
-	};
-	operationId: "users_get";
-} | {
-	input: {
-		page?: number;
-		pageSize?: number;
-	};
-	operationId: "users_list";
-} | {
-	input: {
-		userId: string;
-	};
-	operationId: "users_deactivate";
-} | {
-	input: Record<string, never>;
-	operationId: "roles_list";
-} | {
-	input: {
-		userId: string;
-		roles: string[];
-	};
-	operationId: "roles_assign";
-} | {
-	input: {
-		userId: string;
-		roles: string[];
-	};
-	operationId: "roles_revoke";
-} | {
-	input: ExternalApplicationsCreateOrGetAppUserData["body"];
-	operationId: "users_create_or_get";
-} | {
-	input: JsonObject | unknown[];
-	operationId: "context_get";
-} | {
-	input: {
-		query: KnowledgeQuery;
-	};
-	operationId: "knowledge_query";
-} | {
-	input: {
-		schemaId: string;
-	};
-	operationId: "knowledge_get_entity_schema_snapshot";
-} | {
-	input: SearchQuery;
-	operationId: "knowledge_search_entities";
-} | {
-	input: {
-		entitySchemaId: string;
-		fields: string[];
-		filters?: QueryFilter[];
-		text?: string;
-	};
-	operationId: "knowledge_facets";
-} | {
-	input: {
-		entitySchemaId: string;
-	};
-	operationId: "knowledge_get_schema_query_context";
-} | {
-	input: SearchQuery;
-	operationId: "knowledge_autocomplete";
-} | {
-	input: {
-		entityId: string;
-	};
-	operationId: "knowledge_get_entity";
-} | {
-	input: {
-		entity: {
-			data: JsonObject;
-			description?: string;
-			entitySchemaId: string;
-			name: string;
-		};
-		idempotencyKey: string;
-	};
-	operationId: "knowledge_create_entity";
-} | {
-	input: {
-		entity: {
-			data?: JsonObject;
-			description?: string;
-			name?: string;
-		};
-		entityId: string;
-		expectedVersion: number;
-		idempotencyKey: string;
-	};
-	operationId: "knowledge_update_entity";
-} | {
-	input: {
-		entity: {
-			data: JsonObject;
-			description?: string;
-			entitySchemaId: string;
-			name: string;
-		};
-		entitySchemaId: string;
-		externalIdentity: {
-			source: string;
-			value: string;
-		};
-		idempotencyKey: string;
-	};
-	operationId: "knowledge_upsert_entity";
-} | {
-	input: {
-		entityId: string;
-		expectedVersion: number;
-		idempotencyKey: string;
-	};
-	operationId: "knowledge_delete_entity";
-} | {
-	input: {
-		filter?: JsonObject;
-	};
-	operationId: "agents_list";
-} | {
-	input: {
-		idempotencyKey: string;
-		input: unknown;
-	} & AgentInvokeTarget;
-	operationId: "agents_invoke";
-} | {
-	input: {
-		filter?: JsonObject;
-	};
-	operationId: "skills_list";
-} | {
-	input: {
-		idempotencyKey: string;
-		input: unknown;
-		skillId: string;
-	};
-	operationId: "skills_invoke";
-} | {
-	input: {
-		filter?: JsonObject;
-	};
-	operationId: "workflows_list";
-} | {
-	input: {
-		idempotencyKey: string;
-		input: unknown;
-	} & WorkflowInvokeTarget;
-	operationId: "workflows_invoke";
-} | {
-	input: {
-		runId: string;
-	};
-	operationId: "runs_get";
-} | {
-	input: {
-		afterCursor?: string;
-		runId: string;
-	};
-	operationId: "runs_stream";
-} | {
-	input: {
-		runId: string;
-	};
-	operationId: "runs_cancel";
-} | {
-	input: {
-		contentBase64: string;
-		contentType: string;
-		fileName: string;
-		runId: string;
-		sizeBytes: number;
-	};
-	operationId: "attachments_upload";
-} | {
-	input: {
-		attachmentId: string;
-		runId: string;
-	};
-	operationId: "attachments_download_url";
-} | {
-	input: {
-		idempotencyKey: string;
-		input: unknown;
-	} & ConversationContinueTarget;
-	operationId: "conversations_continue";
-} | {
-	input: {
-		conversationId: string;
-	};
-	operationId: "conversations_history";
-};
-export interface EnvelopeSuccess<Id extends string, Result> {
-	correlationId: string;
-	operationId: Id;
-	result: Result;
-}
-export type ExternalApplicationOperationSuccess = EnvelopeSuccess<"users_get", ApplicationUser> | EnvelopeSuccess<"users_list", ApplicationUserPage> | EnvelopeSuccess<"users_deactivate", {
-	userId: string;
-}> | EnvelopeSuccess<"roles_list", {
-	items: ApplicationRole[];
-}> | EnvelopeSuccess<"roles_assign", {
-	userId: string;
-}> | EnvelopeSuccess<"roles_revoke", {
-	userId: string;
-}> | EnvelopeSuccess<"users_create_or_get", ApplicationUserResolution> | EnvelopeSuccess<"context_get", JsonObject> | EnvelopeSuccess<"knowledge_query", JsonObject> | EnvelopeSuccess<"knowledge_get_entity_schema_snapshot", JsonObject> | EnvelopeSuccess<"knowledge_search_entities", JsonObject> | EnvelopeSuccess<"knowledge_facets", JsonObject> | EnvelopeSuccess<"knowledge_get_schema_query_context", JsonObject> | EnvelopeSuccess<"knowledge_autocomplete", JsonObject> | EnvelopeSuccess<"knowledge_get_entity", JsonObject> | EnvelopeSuccess<"knowledge_create_entity", JsonObject> | EnvelopeSuccess<"knowledge_update_entity", JsonObject> | EnvelopeSuccess<"knowledge_upsert_entity", JsonObject> | EnvelopeSuccess<"knowledge_delete_entity", JsonObject> | EnvelopeSuccess<"agents_list", JsonObject> | EnvelopeSuccess<"agents_invoke", {
-	runId: string;
-}> | EnvelopeSuccess<"skills_list", JsonObject> | EnvelopeSuccess<"skills_invoke", {
-	runId: string;
-}> | EnvelopeSuccess<"workflows_list", JsonObject> | EnvelopeSuccess<"workflows_invoke", {
-	runId: string;
-}> | EnvelopeSuccess<"runs_get", JsonObject> | EnvelopeSuccess<"runs_stream", {
-	events: JsonObject[];
-	nextCursor: string | null;
-}> | EnvelopeSuccess<"runs_cancel", JsonObject> | EnvelopeSuccess<"attachments_upload", {
-	attachmentId: string;
-}> | EnvelopeSuccess<"attachments_download_url", {
-	expiresAt: string;
-	url: string;
-}> | EnvelopeSuccess<"conversations_continue", {
-	conversationId: string;
-	runId: string;
-}> | EnvelopeSuccess<"conversations_history", ConversationHistory>;
-/** User details returned by the application's user-management gateway. */
-export type ApplicationUser = ExternalApplicationsGetAppUserResponse["result"];
-export type ApplicationUserResolution = ExternalApplicationsCreateOrGetAppUserResponse["result"];
-export type ApplicationUserPage = ExternalApplicationsListAppUsersResponse["result"];
-export type ApplicationRole = ExternalApplicationsListAppRolesResponse["result"]["items"][number];
-declare const storageFileIdBrand: unique symbol;
-/** A durable private file of the application's Organization. */
-export type StorageFileId = string & Readonly<{
-	[storageFileIdBrand]: "StorageFileId";
-}>;
-/**
- * One file of up to 10 MiB, base64-encoded. CI accepts the content types
- * `application/pdf`, `image/jpeg` and `image/png`.
- */
-export interface DurableFileUpload {
-	contentBase64: string;
-	contentType: string;
-	fileName: string;
-	sizeBytes: number;
-}
-export type ExternalApplicationServiceOperationRequest = {
-	input: ExternalApplicationsCheckAppUserEmailData["body"];
-	operationId: "users_check_email";
-} | {
-	input: DurableFileUpload;
-	operationId: "files_upload";
-};
-/**
- * Whether `users_create_or_get` would accept an email, checked without
- * creating anything; an unknown email is usable.
- */
-export type ApplicationUserEmailCheck = ExternalApplicationsCheckAppUserEmailResponse["result"];
-export type ExternalApplicationServiceOperationSuccess = EnvelopeSuccess<"users_check_email", ApplicationUserEmailCheck> | EnvelopeSuccess<"files_upload", {
-	storageFileId: StorageFileId;
-}>;
-/** Every operation a confidential server client may invoke. */
-export type ExternalApplicationServerOperationRequest = ExternalApplicationOperationRequest | ExternalApplicationServiceOperationRequest;
-export type ExternalApplicationOperationId = ExternalApplicationOperationRequest["operationId"];
-export type ExternalApplicationServerOperationId = ExternalApplicationServerOperationRequest["operationId"];
-export type ExternalApplicationOperationRequestFor<Id extends ExternalApplicationServerOperationId> = Extract<ExternalApplicationServerOperationRequest, {
-	operationId: Id;
-}>;
-export type ExternalApplicationOperationSuccessFor<Id extends ExternalApplicationServerOperationId> = Extract<ExternalApplicationOperationSuccess | ExternalApplicationServiceOperationSuccess, {
-	operationId: Id;
-}>;
-export type ClientOperationId = ExternalApplicationOperationId;
-export interface ClientOperationDefinition<Input, Output> {
-	readonly input: Input;
-	readonly output: Output;
-}
-export type ClientOperationMap = Readonly<{
-	[Id in ClientOperationId]: ClientOperationDefinition<ExternalApplicationOperationRequestFor<Id>["input"], ExternalApplicationOperationSuccessFor<Id>["result"]>;
-}>;
-export type ClientOperationInput<Operations extends ClientOperationMap, Id extends ClientOperationId> = Operations[Id]["input"];
-export type ClientOperationOutput<Operations extends ClientOperationMap, Id extends ClientOperationId> = Operations[Id]["output"];
-export type OperationExecutionOptions = Readonly<{
-	organizationId: string;
-	signal?: AbortSignal;
-}>;
-export interface TypedOperationExecutor<Operations extends ClientOperationMap> {
-	readonly execute: <Id extends ClientOperationId>(operationId: Id, input: ClientOperationInput<Operations, Id>, options?: OperationExecutionOptions) => Promise<CiResult<ClientOperationOutput<Operations, Id>>>;
-}
-export type JsonValue = null | boolean | number | string | readonly JsonValue[] | Readonly<{
-	[key: string]: JsonValue;
-}>;
-export type CiErrorCode = "unauthenticated" | "forbidden" | "not_found" | "conflict" | "invalid_request" | "rate_limited" | "unavailable" | "internal";
-export type CiError = Readonly<{
-	code: CiErrorCode;
-	message: string;
-	retryable: boolean;
-	details?: Readonly<Record<string, JsonValue>>;
-}>;
-export type CiResult<Value> = Readonly<{
-	correlationId: string;
-	ok: true;
-	value: Value;
-}> | Readonly<{
-	correlationId: string;
-	error: CiError;
-	ok: false;
-}>;
-export type ResourceJsonValue = null | boolean | number | string | readonly ResourceJsonValue[] | Readonly<{
-	[key: string]: ResourceJsonValue;
-}>;
-/** Opaque wire identity. Callers must not infer or concatenate its internals. */
-export type ResourceId = string;
-export type ResourceRecordId = ResourceId;
-/** Opaque concurrency token independent from source timestamps. */
-export type ResourceRevision = string;
-/** Opaque pagination position issued and consumed only by a resource adapter. */
-export type ResourceCursor = string;
-export type IdempotencyKey = string;
-export type ResourceIdentityField = Readonly<{
-	name: string;
-	type: "number" | "string";
-}>;
-export type ResourceCapabilities = Readonly<{
-	create?: boolean;
-	/** Common entity deletion is always soft deletion. */
-	delete?: boolean;
-	get?: boolean;
-	hardDelete?: boolean;
-	includeDeleted?: boolean;
-	restore?: boolean;
-	search: true;
-	softDelete?: boolean;
-	update?: boolean;
-	/** File uploads for the File fields of a common entity resource. */
-	upload?: boolean;
-}>;
-export type ResourcePaginationMode = "cursor" | "page";
-export type PortableResourceSchema = Readonly<Record<string, ResourceJsonValue>>;
-export type ResourceDefinition<Entity, Create = Entity, Update = Partial<Entity>> = Readonly<{
-	capabilities: ResourceCapabilities;
-	concurrency: "revision";
-	id: string;
-	identity: Readonly<{
-		fields: readonly [
-			ResourceIdentityField,
-			...ResourceIdentityField[]
-		];
-	}>;
-	query: Readonly<{
-		filterableFields: readonly string[];
-		pagination: Readonly<{
-			modes: readonly ResourcePaginationMode[];
-		}>;
-		sortableFields: readonly string[];
-		textSearchFields?: readonly string[];
-	}>;
-	schemas: Readonly<{
-		create?: PortableResourceSchema;
-		entity: PortableResourceSchema;
-		update?: PortableResourceSchema;
-	}>;
-	version: string;
-	/** Portable UI metadata; required/enum/nullability remain in schemas. */
-	metadata?: Readonly<Record<string, ResourceJsonValue>>;
-	/** Type-only slots keep definition values portable and serializable. */
-	readonly __types?: Readonly<{
-		create: Create;
-		entity: Entity;
-		update: Update;
-	}>;
-}>;
-export 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. User fields accept identity
- * predicates for one ID and `contains_any`, `contains_all`, `contains_none`
- * for multiple IDs, plus empty/not-empty aliases. CI validates operators
- * against the actual field semantic; UUID shape alone does not declare User.
- */
-export type ResourceFilter = Readonly<{
-	field: string;
-	operator: "contains" | "contains_all" | "contains_any" | "contains_none" | "ends_with" | "eq" | "gt" | "gte" | "in" | "lt" | "lte" | "ne" | "not_in" | "starts_with";
-	value: FilterValue;
-}> | Readonly<{
-	field: string;
-	operator: "is_empty" | "is_not_empty" | "is_not_null" | "is_null";
-}> | Readonly<{
-	filters: readonly ResourceFilter[];
-	operator: "and" | "or";
-}> | Readonly<{
-	filter: ResourceFilter;
-	operator: "not";
-}>;
-export type ResourceSort = Readonly<{
-	direction: "asc" | "desc";
-	field: string;
-}>;
-export type ResourcePagination = Readonly<{
-	mode: "cursor";
-	cursor?: ResourceCursor;
-	limit: number;
-}> | Readonly<{
-	mode: "page";
-	page: number;
-	pageSize: number;
-}>;
-export 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[];
-	textSearch?: string;
-}>;
-export 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;
-}>;
-export type ResourceListResult<Entity> = Readonly<{
-	items: readonly ResourceRecord<Entity>[];
-	nextCursor?: ResourceCursor;
-	pagination: "cursor";
-}> | Readonly<{
-	items: readonly ResourceRecord<Entity>[];
-	page: number;
-	pageSize: number;
-	pagination: "page";
-	totalItems: number;
-	totalPages: number;
-}>;
-export type ResourceErrorCode = "capability_not_supported" | "conflict" | "forbidden" | "internal" | "invalid_request" | "not_found" | "rate_limited" | "transport_error" | "unauthenticated" | "unavailable" | 
-/** The CI Organization storage can not take a presigned File upload. */
-"upload_not_supported";
-export type ResourceError = Readonly<{
-	code: ResourceErrorCode;
-	/** Client-observed dispatch outcome; uncertainty never proves rollback. */
-	outcome?: "not_dispatched" | "rejected" | "uncertain";
-	details?: Readonly<Record<string, ResourceJsonValue>>;
-	message: string;
-	retryable: boolean;
-}>;
-export type ResourceResult<Value> = Readonly<{
-	correlationId: string;
-	ok: true;
-	value: Value;
-}> | Readonly<{
-	correlationId: string;
-	error: ResourceError;
-	ok: false;
-}>;
-export type ResourceRequestOptions = Readonly<{
-	signal?: AbortSignal;
-}>;
-export type ResourceMutationInput<Value> = Readonly<{
-	expectedRevision: ResourceRevision;
-	id: ResourceRecordId;
-	idempotencyKey?: IdempotencyKey;
-	value: Value;
-}>;
-export type ResourceLifecycleInput = Readonly<{
-	expectedRevision: ResourceRevision;
-	id: ResourceRecordId;
-	idempotencyKey?: IdempotencyKey;
-}>;
-export type ResourceCreateInput<Value> = Readonly<{
-	idempotencyKey: IdempotencyKey;
-	value: Value;
-}>;
-export type EntityListQuery = Omit<ResourceListQuery, "pagination" | "includeDeleted"> & Readonly<{
-	pagination: Extract<ResourcePagination, {
-		mode: "page";
-	}>;
-}>;
-export type EntityPage<Value> = Extract<ResourceListResult<Value>, {
-	pagination: "page";
-}>;
-/** Member schemas are resolved by CI, independently of the parent resource. */
-export type EntityMemberValue = Readonly<Record<string, ResourceJsonValue>>;
-export type EntityCreateInput<Value> = ResourceCreateInput<Value>;
-export type EntityUpdateInput<Patch> = ResourceMutationInput<Patch> & Readonly<{
-	idempotencyKey: IdempotencyKey;
-}>;
-export type EntityDeleteInput = ResourceLifecycleInput & Readonly<{
-	idempotencyKey: IdempotencyKey;
-}>;
-/** A File upload request for one File field of the entity schema. */
-export type EntityUploadInput = Readonly<{
-	field: string;
-	filename: string;
-	mimeType: string;
-}>;
-/** PUT the file bytes to `url` with `headers`; then write `{ upload: uploadId }`. */
-export type EntityUploadSlot = Readonly<{
-	headers: Readonly<Record<string, string>>;
-	method: "PUT";
-	uploadId: string;
-	url: string;
-}>;
-/** A logical write retains its key, payload and edited revision on explicit resubmission. */
-export interface EntityClient<Value, Create = Value, Patch = Partial<Value>> {
-	/** Filter, sort and page the resolved member schema; includes remain bounded. */
-	readonly listMembers: (parentId: ResourceRecordId, field: string, query: EntityListQuery, options?: ResourceRequestOptions) => Promise<ResourceResult<EntityPage<EntityMemberValue>>>;
-	readonly definition: ResourceDefinition<Value, Create, Patch>;
-	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>>>;
-	readonly delete: (input: EntityDeleteInput) => Promise<ResourceResult<ResourceRecord<Value>>>;
-	/** A single-use File upload slot; requires the `upload` capability. */
-	readonly upload: (input: EntityUploadInput, options?: ResourceRequestOptions) => Promise<ResourceResult<EntityUploadSlot>>;
-}
-export type CiStreamPage = ClientOperationOutput<ClientOperationMap, "runs_stream">;
-export type FollowRunOptions = Readonly<{
-	/**
-	 * Total wait before `followRun` throws "Run did not finish". Defaults to
-	 * {@link DEFAULT_FOLLOW_RUN_DEADLINE_MS}.
-	 */
-	deadlineMs?: number;
-	/**
-	 * First wait between polls in milliseconds (default 50). It doubles while
-	 * no new event arrives, up to one second or `idleMs` if larger.
-	 */
-	idleMs?: number;
-	now?: () => number;
-	runId: string;
-	/** Stops following and cancels in-flight requests made by `runs.follow`. */
-	signal?: AbortSignal;
-	sleep?: (ms: number) => Promise<void>;
-}>;
-declare const clientSdkProtocolVersion: "v1";
-export type SignalOptions = Readonly<{
-	signal?: AbortSignal;
-}>;
-export type FollowRunCall<Scoped extends boolean> = Scoped extends true ? (options: FollowRunOptions) => Promise<CiStreamPage> : (options: FollowRunOptions & Readonly<{
-	organizationId: string;
-}>) => Promise<CiStreamPage>;
-export type ScopedOperation<Operations extends ClientOperationMap, Id extends ClientOperationId> = (input: ClientOperationInput<Operations, Id>, options?: SignalOptions) => Promise<CiResult<ClientOperationOutput<Operations, Id>>>;
-export type RootOperation<Operations extends ClientOperationMap, Id extends ClientOperationId> = (input: ClientOperationInput<Operations, Id> & Readonly<{
-	organizationId: string;
-}>, options?: SignalOptions) => Promise<CiResult<ClientOperationOutput<Operations, Id>>>;
-export type DomainOperation<Operations extends ClientOperationMap, Id extends ClientOperationId, Scoped extends boolean> = Scoped extends true ? ScopedOperation<Operations, Id> : RootOperation<Operations, Id>;
-export type ClientDomains<Operations extends ClientOperationMap, Scoped extends boolean> = Readonly<{
-	agents: Readonly<{
-		invoke: DomainOperation<Operations, "agents_invoke", Scoped>;
-		list: DomainOperation<Operations, "agents_list", Scoped>;
-	}>;
-	attachments: Readonly<{
-		downloadUrl: DomainOperation<Operations, "attachments_download_url", Scoped>;
-		upload: DomainOperation<Operations, "attachments_upload", Scoped>;
-	}>;
-	context: Readonly<{
-		get: DomainOperation<Operations, "context_get", Scoped>;
-	}>;
-	knowledge: Readonly<{
-		autocomplete: DomainOperation<Operations, "knowledge_autocomplete", Scoped>;
-		createEntity: DomainOperation<Operations, "knowledge_create_entity", Scoped>;
-		deleteEntity: DomainOperation<Operations, "knowledge_delete_entity", Scoped>;
-		facets: DomainOperation<Operations, "knowledge_facets", Scoped>;
-		getEntity: DomainOperation<Operations, "knowledge_get_entity", Scoped>;
-		getEntitySchemaSnapshot: DomainOperation<Operations, "knowledge_get_entity_schema_snapshot", Scoped>;
-		getSchemaQueryContext: DomainOperation<Operations, "knowledge_get_schema_query_context", Scoped>;
-		query: DomainOperation<Operations, "knowledge_query", Scoped>;
-		searchEntities: DomainOperation<Operations, "knowledge_search_entities", Scoped>;
-		updateEntity: DomainOperation<Operations, "knowledge_update_entity", Scoped>;
-		upsertEntity: DomainOperation<Operations, "knowledge_upsert_entity", Scoped>;
-	}>;
-	runs: Readonly<{
-		cancel: DomainOperation<Operations, "runs_cancel", Scoped>;
-		follow: FollowRunCall<Scoped>;
-		get: DomainOperation<Operations, "runs_get", Scoped>;
-		stream: DomainOperation<Operations, "runs_stream", Scoped>;
-	}>;
-	skills: Readonly<{
-		invoke: DomainOperation<Operations, "skills_invoke", Scoped>;
-		list: DomainOperation<Operations, "skills_list", Scoped>;
-	}>;
-	workflows: Readonly<{
-		invoke: DomainOperation<Operations, "workflows_invoke", Scoped>;
-		list: DomainOperation<Operations, "workflows_list", Scoped>;
-	}>;
-}>;
-export type OrganizationClient<Operations extends ClientOperationMap> = ClientDomains<Operations, true> & Readonly<{
-	organizationId: string;
-}>;
-export type ClientSdkClient<Operations extends ClientOperationMap> = Omit<ClientDomains<Operations, false>, "context"> & TypedOperationExecutor<Operations> & Readonly<{
-	context: ClientDomains<Operations, false>["context"] & Readonly<{
-		forOrganization: (organizationId: string) => OrganizationClient<Operations>;
-	}>;
-	forOrganization: (organizationId: string) => OrganizationClient<Operations>;
-	protocolVersion: typeof clientSdkProtocolVersion;
-}>;
-/** One equality filter on a dotted data path of a topic's records. */
-export type RealtimeTopicFilter = Readonly<{
-	field: string;
-	eq: string | number | boolean | null;
-}>;
-/** The records of one entity schema, named by FQN or id, optionally filtered. */
-export type RealtimeTopic = Readonly<{
-	schema: string;
-	filter?: RealtimeTopicFilter;
-}>;
-/** A record of a subscribed topic changed; refetch it, the event carries ids only. */
-export type RealtimeChange = Readonly<{
-	id: string;
-	op: "create" | "update" | "delete";
-	revision: string;
-	topic: RealtimeTopic;
-}>;
-export type RealtimeClientStatus = "idle" | "connecting" | "open" | "backoff";
-export type RealtimeClientState = Readonly<{
-	status: RealtimeClientStatus;
-	/** Open or opening connections of this client: 0 or 1. */
-	connections: number;
-	topics: readonly RealtimeTopic[];
-	lastEventId: string | undefined;
-}>;
-export type RealtimeClient = Readonly<{
-	/**
-	 * Listens to one topic; the result stops listening. Changes arrive in
-	 * batches, one change per record: the latest, in order of arrival.
-	 */
-	subscribe: (topic: RealtimeTopic, onChanges: (changes: readonly RealtimeChange[]) => void) => () => void;
-	getState: () => RealtimeClientState;
-	/** Closes the connection and stops reacting to the page. */
-	close: () => void;
-}>;
 export type PromptKeyEvent = Readonly<{
 	isComposing: boolean;
 	key: string;
@@ -996,6 +113,8 @@ export type Client = ClientSdkClient<ClientOperationMap>;
 export type Organization = OrganizationClient<ClientOperationMap>;
 export type CollectiveIntelligenceProviderProps = Readonly<{
 	entitySource?: EntitySource | undefined;
+	/** The app's QueryClient; without it the provider owns one for its lifetime. */
+	queryClient?: QueryClient | undefined;
 } & ({
 	children: ReactNode;
 	client: Client;
@@ -1067,44 +186,29 @@ export type SessionGateProps = Readonly<{
 export declare const useSession: () => FederatedAuthState;
 /** Renders children only when the BFF sealed-cookie session is authenticated. */
 export declare const SessionGate: ({ children, fallback }: SessionGateProps) => ReactNode;
-export type RealtimeProviderProps = Readonly<{
+export type RealtimeProviderProps = Readonly<RealtimeClientOptions & {
 	children: ReactNode;
-	/** One client per tab; it holds the tab's single realtime connection. */
-	client: RealtimeClient;
 }>;
-export declare const RealtimeProvider: ({ children, client }: RealtimeProviderProps) => import("react").JSX.Element;
-export declare const useRealtimeClient: () => RealtimeClient;
+/** The client of a provider tree, as its hooks use it: the provider closes it. */
+export type TreeClient = Omit<RealtimeClient, "close">;
+/**
+ * Gives its tree one realtime client of the client SDK, and so one connection.
+ * It creates the client in the browser when it mounts or a hook subscribes,
+ * and closes it when the tree unmounts. `onReset` and `onAccessChanged` are
+ * the app's callbacks; the client calls the ones of the latest render. Only a
+ * client with `onReset` resyncs, so a render that adds or removes `onReset`
+ * replaces the client, and with it the stream. It reads the other options
+ * once, when it creates the client.
+ */
+export declare const RealtimeProvider: ({ children, ...options }: RealtimeProviderProps) => import("react").JSX.Element;
+/** The client of the nearest `RealtimeProvider`; a subscription holds it open. */
+export declare const useRealtimeClient: () => TreeClient;
 /**
  * Calls `onChanges` with each batch of changes of `topic` while the component
  * is mounted; `null` listens to nothing. Equal topics share one subscription
  * key, so a new topic object on each render does not resubscribe.
  */
 export declare const useRealtimeTopic: (topic: RealtimeTopic | null, onChanges: (changes: readonly RealtimeChange[]) => void) => void;
-export type ResourceValue = string | number | boolean | null | readonly ResourceValue[] | ResourceObject;
-export interface ResourceObject {
-	readonly [key: string]: ResourceValue;
-}
-/** Display-ready controls. Schema inference and registry selection belong to the consumer. */
-export type ResourceField = Readonly<{
-	name: string;
-	label: string;
-	control: "text" | "email" | "number" | "checkbox" | "date" | "datetime-local" | "select" | "custom";
-	required?: boolean;
-	readOnly?: boolean;
-	nullable?: boolean;
-	options?: readonly Readonly<{
-		label: string;
-		value: string | number | boolean;
-	}>[];
-}>;
-export type ResourceFieldControlProps = Readonly<{
-	field: ResourceField;
-	id: string;
-	value: ResourceValue | undefined;
-	disabled: boolean;
-	errorId?: string | undefined;
-	onChange: (value: ResourceValue) => void;
-}>;
 export type EntityFieldKey<Value> = Extract<keyof Value, string>;
 export type EntityFieldConfig = Readonly<{
 	control?: ResourceField["control"] | string;
@@ -1146,7 +250,7 @@ export type EntityRendererRegistry<Value> = Readonly<Record<string, (input: Read
 export declare const defineEntity: <Value extends {
 	readonly [Key in keyof Value]: ResourceJsonValue;
 }, Create, Patch>(declaration: EntityDeclaration<Value, Create, Patch>) => EntityDeclaration<Value, Create, Patch>;
-type JsonObject$1<Value = Readonly<Record<string, ResourceJsonValue>>> = {
+export type JsonObject<Value = Readonly<Record<string, ResourceJsonValue>>> = {
 	readonly [Key in keyof Value]: ResourceJsonValue;
 };
 export type ViewStateProps = Readonly<{
@@ -1163,24 +267,24 @@ export type SharedViewProps<Value, Create, Patch> = Readonly<{
 	renderers?: EntityRendererRegistry<Value>;
 	variant?: string;
 }>;
-export type EntityTableProps<Value extends JsonObject$1<Value>, Create, Patch> = SharedViewProps<Value, Create, Patch> & ViewStateProps;
-export type EntityListProps<Value extends JsonObject$1<Value>, Create, Patch> = SharedViewProps<Value, Create, Patch> & ViewStateProps;
-export declare const EntityTable: <Value extends JsonObject$1<Value>, Create, Patch>(props: EntityTableProps<Value, Create, Patch>) => import("react").JSX.Element;
-export declare const EntityList: <Value extends JsonObject$1<Value>, Create, Patch>(props: EntityListProps<Value, Create, Patch>) => import("react").JSX.Element;
-export type SharedEntityFormProps<Value extends JsonObject$1<Value>, Create, Patch> = Readonly<{
+export type EntityTableProps<Value extends JsonObject<Value>, Create, Patch> = SharedViewProps<Value, Create, Patch> & ViewStateProps;
+export type EntityListProps<Value extends JsonObject<Value>, Create, Patch> = SharedViewProps<Value, Create, Patch> & ViewStateProps;
+export declare const EntityTable: <Value extends JsonObject<Value>, Create, Patch>(props: EntityTableProps<Value, Create, Patch>) => import("react").JSX.Element;
+export declare const EntityList: <Value extends JsonObject<Value>, Create, Patch>(props: EntityListProps<Value, Create, Patch>) => import("react").JSX.Element;
+export type SharedEntityFormProps<Value extends JsonObject<Value>, Create, Patch> = Readonly<{
 	controls?: EntityControlRegistry;
 	entity: EntityDeclaration<Value, Create, Patch>;
 	initialValues?: Readonly<Record<string, ResourceValue>>;
 	onCancel?: () => void;
 	onSuccess?: (record: ResourceRecord<Value>) => void;
 }>;
-export type EntityFormProps<Value extends JsonObject$1<Value>, Create, Patch> = (SharedEntityFormProps<Value, Create, Patch> & Readonly<{
+export type EntityFormProps<Value extends JsonObject<Value>, Create, Patch> = (SharedEntityFormProps<Value, Create, Patch> & Readonly<{
 	mode: "create";
 }>) | (SharedEntityFormProps<Value, Create, Patch> & Readonly<{
 	mode: "update";
 	record: ResourceRecord<Value>;
 }>);
-export declare const EntityForm: <Value extends JsonObject$1<Value>, Create, Patch>(props: EntityFormProps<Value, Create, Patch>) => import("react").JSX.Element;
+export declare const EntityForm: <Value extends JsonObject<Value>, Create, Patch>(props: EntityFormProps<Value, Create, Patch>) => import("react").JSX.Element;
 export type EntityViewOptions = Readonly<{
 	contract?: ResourceDefinition<unknown, unknown, unknown>;
 	pageSize?: number;
@@ -1206,5 +310,80 @@ export declare const useMemoryEntityViewState: (input?: Readonly<{
 	pageSize?: number;
 }>) => EntityViewStateController;
 export declare const clientSdkReactEntrypoint: "react";
+/**
+ * The envelope of an Expected Error. The client SDK also exports a `CiError`
+ * class; this entrypoint exports no class at run time, so only the type.
+ */
+export type CiError = CiErrorEnvelope;
+
+export {
+	CiErrorCode,
+	CiResult,
+	CiStreamPage,
+	ClientDomains,
+	ClientFetch,
+	ClientOperationDefinition,
+	ClientOperationId,
+	ClientOperationInput,
+	ClientOperationMap,
+	ClientOperationOutput,
+	ClientSdkClient,
+	EntityClient,
+	EntityCreateInput,
+	EntityDeleteInput,
+	EntityListQuery,
+	EntityMemberValue,
+	EntityPage,
+	EntityUpdateInput,
+	EntityUploadInput,
+	EntityUploadSlot,
+	FederatedAuth,
+	FederatedAuthErrorCode,
+	FederatedAuthState,
+	FederatedSessionIdentity,
+	FollowRunOptions,
+	IdempotencyKey,
+	JsonValue,
+	KnowledgeQuery,
+	OperationExecutionOptions,
+	OrganizationClient,
+	PortableResourceSchema,
+	QueryFilter,
+	RealtimeChange,
+	RealtimeClient,
+	RealtimeClientState,
+	RealtimeClientStatus,
+	RealtimeTopic,
+	RealtimeTopicFilter,
+	ResourceCapabilities,
+	ResourceCreateInput,
+	ResourceCursor,
+	ResourceDefinition,
+	ResourceError,
+	ResourceErrorCode,
+	ResourceField,
+	ResourceFieldControlProps,
+	ResourceFilter,
+	ResourceId,
+	ResourceIdentityField,
+	ResourceJsonValue,
+	ResourceLifecycleInput,
+	ResourceListQuery,
+	ResourceListResult,
+	ResourceMutationInput,
+	ResourceObject,
+	ResourcePagination,
+	ResourcePaginationMode,
+	ResourceRecord,
+	ResourceRecordId,
+	ResourceRequestOptions,
+	ResourceResult,
+	ResourceRevision,
+	ResourceSort,
+	ResourceValue,
+	SearchQuery,
+	TypedOperationExecutor,
+	WorkflowInvokeTarget,
+};
 
 export {};