@collective-intelligence/external-apps-server-sdk 0.1.8 → 0.1.10

package/dist/resources.d.ts

@@ -26,6 +26,8 @@ export type ResourceCapabilities = Readonly<{
 	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>>;
@@ -63,13 +65,21 @@ export type ResourceDefinition<Entity, Create = Entity, Update = Partial<Entity>
 	}>;
 }>;
 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, and `contains_any` and
+ * `contains_all` compare the ids of a field that holds many.
+ */
 export 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";
@@ -92,6 +102,11 @@ export type ResourcePagination = Readonly<{
 }>;
 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[];
@@ -100,7 +115,15 @@ export type ResourceListQuery = Readonly<{
 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<{
@@ -115,7 +138,9 @@ export type ResourceListResult<Entity> = Readonly<{
 	totalItems: number;
 	totalPages: number;
 }>;
-export type ResourceErrorCode = "capability_not_supported" | "conflict" | "forbidden" | "internal" | "invalid_request" | "not_found" | "rate_limited" | "transport_error" | "unauthenticated" | "unavailable";
+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. */
@@ -187,7 +212,7 @@ export type ResourceCreateInput<Value> = Readonly<{
 	value: Value;
 }>;
 /** Common entity operations. Generic resource lifecycle/cursor APIs remain separate. */
-export type EntityOperation = "list" | "get" | "create" | "update" | "delete";
+export type EntityOperation = "list" | "get" | "create" | "update" | "delete" | "upload";
 export type EntityListQuery = Omit<ResourceListQuery, "pagination" | "includeDeleted"> & Readonly<{
 	pagination: Extract<ResourcePagination, {
 		mode: "page";
@@ -203,6 +228,19 @@ export type EntityUpdateInput<Patch> = ResourceMutationInput<Patch> & Readonly<{
 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;
+}>;
 export type EntityRequestIdentity = Readonly<{
 	requestId: string;
 	resourceId: string;
@@ -213,13 +251,17 @@ export type EntityRequest<Create = unknown, Patch = unknown> = EntityRequestIden
 }> | Readonly<{
 	operation: "get";
 	id: ResourceRecordId;
+	include?: readonly string[];
 }> | (Readonly<{
 	operation: "create";
 }> & EntityCreateInput<Create>) | (Readonly<{
 	operation: "update";
 }> & EntityUpdateInput<Patch>) | (Readonly<{
 	operation: "delete";
-}> & EntityDeleteInput));
+}> & EntityDeleteInput) | (Readonly<{
+	operation: "upload";
+}> & EntityUploadInput));
+export type EntityOperationResult<Value, Operation extends EntityOperation> = Operation extends "list" ? EntityPage<Value> : Operation extends "upload" ? EntityUploadSlot : ResourceRecord<Value>;
 /** Application login identities are separate from gateway machine callers. */
 export type ApplicationUserIdentity = Readonly<{
 	kind: "local_user";
@@ -347,7 +389,7 @@ export type EntityResourceDefinition<Value = unknown, Create = Value, Patch = Pa
 	definition: ResourceDefinition<Value, Create, Patch>;
 	execute: (request: EntityRequest<Create, Patch>, context: EntityInvocationContext, options?: Readonly<{
 		signal?: AbortSignal;
-	}>) => Promise<ResourceResult<EntityPage<Value> | ResourceRecord<Value>>>;
+	}>) => Promise<ResourceResult<EntityOperationResult<Value, EntityOperation>>>;
 }>;
 export type GatewayResourceOperation = ResourceTransportRequest["operation"];
 export type GatewayResourceAuthorization = Readonly<Partial<Record<GatewayResourceOperation, AuthorizationRequirement>>>;
@@ -393,6 +435,8 @@ export type EntityHttpRoute = {
 } | {
 	readonly kind: "soft_delete";
 	readonly id: string;
+} | {
+	readonly kind: "uploads";
 };
 export declare const createResourceHttpHandler: <Value, Create = Value, Patch = Partial<Value>>(options: ResourceHttpHandlerOptions<Value, Create, Patch>) => (request: Request) => Promise<Response>;
 export declare const matchEntityHttpRoute: (pathname: string, basePath: string) => EntityHttpRoute | null;