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

package/dist/runtime/effect.d.ts

@@ -57,6 +57,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>>;
@@ -146,7 +148,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. */
@@ -218,7 +222,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";
@@ -234,6 +238,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;
@@ -250,7 +267,10 @@ export type EntityRequest<Create = unknown, Patch = unknown> = EntityRequestIden
 	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>;
 export type PrincipalKind = "detached_user" | "service_principal";
 export type DelegatedSubjectPolicy = "allowed" | "forbidden" | "required";
 export type AuthorizationRequirement = Readonly<{
@@ -334,7 +354,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>>>;