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

package/dist/index.d.ts

@@ -3,6 +3,19 @@
 export type ResourceJsonValue = null | boolean | number | string | readonly ResourceJsonValue[] | Readonly<{
 	[key: string]: ResourceJsonValue;
 }>;
+/** 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 ExternalApplicationsGetContextErrors = {
 	/**
 	 * Error
@@ -415,7 +428,25 @@ interface MemberUserPage {
 	pageSize: number;
 	totalItems: number;
 }
+declare const storageFileIdBrand: unique symbol;
+/** A durable private file of the application's Organization. */
+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`.
+ */
+interface DurableFileUpload {
+	contentBase64: string;
+	contentType: string;
+	fileName: string;
+	sizeBytes: number;
+}
 export type ExternalApplicationServiceOperationRequest = {
+	input: DurableFileUpload;
+	operationId: "files_upload";
+} | {
 	input: {
 		email: string;
 		name: string;
@@ -443,6 +474,11 @@ export type ExternalApplicationServiceOperationRequest = {
 		userId: string;
 	};
 	operationId: "members_remove";
+} | {
+	input: {
+		origin: string;
+	};
+	operationId: "origins_set_runtime";
 } | {
 	input: {
 		userId: string;
@@ -459,10 +495,14 @@ export type ExternalApplicationServiceOperationRequest = {
 export interface UserCompanyLinks {
 	entityIds: string[];
 }
-export type ExternalApplicationServiceOperationSuccess = EnvelopeSuccess<"members_create_or_get", MemberUser & {
+export type ExternalApplicationServiceOperationSuccess = EnvelopeSuccess<"files_upload", {
+	storageFileId: StorageFileId;
+}> | EnvelopeSuccess<"members_create_or_get", MemberUser & {
 	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. */
 export type ExternalApplicationServerOperationRequest = ExternalApplicationOperationRequest | ExternalApplicationServiceOperationRequest;
@@ -649,6 +689,45 @@ export type ServerMessageSendRequest = Omit<MessageSendInput, "idempotencyKey">
 	idempotencyKey?: string;
 }> & ServerInvocationContext;
 export type ServerMessageSendMethod = (request: ServerMessageSendRequest) => Promise<MessageSendResult>;
+/** A File upload slot for one File field of an entity schema, named by id or FQN. */
+export type ServerResourceUploadRequest = EntityUploadInput & Readonly<{
+	schemaId: string;
+	/** Bound on each attempt's request and response body. Defaults to 10 seconds. */
+	timeoutMs?: number;
+}> & ServerInvocationContext;
+declare const resourceFailureCodes: readonly [
+	"conflict",
+	"forbidden",
+	"internal",
+	"invalid_request",
+	"not_found",
+	"unauthenticated",
+	"unavailable",
+	"upload_not_supported"
+];
+/** Why CI's resources API refused the request. */
+export type ServerResourceFailure = Readonly<{
+	correlationId: string;
+	error: Readonly<{
+		code: (typeof resourceFailureCodes)[number];
+		details?: Readonly<Record<string, ResourceJsonValue>>;
+		message: string;
+		retryable: boolean;
+	}>;
+}>;
+/** PUT the bytes to `result.url` with `result.headers`, then write `{ upload: uploadId }`. */
+export type ServerResourceUploadResult = Readonly<{
+	error: ServerResourceFailure;
+	ok: false;
+}> | Readonly<{
+	ok: true;
+	value: Readonly<{
+		correlationId: string;
+		operationId: "resources_create_upload";
+		result: EntityUploadSlot;
+	}>;
+}>;
+export type ServerResourceUploadMethod = (request: ServerResourceUploadRequest) => Promise<ServerResourceUploadResult>;
 export type RunOperationId = "runs_cancel" | "runs_get" | "runs_stream";
 export type ServerRunStatus = "accepted" | "cancelled" | "failed" | "running" | "succeeded";
 /**
@@ -731,6 +810,17 @@ export interface ServerClient {
 		continue: ServerOperationMethod<"conversations_continue">;
 		history: ServerOperationMethod<"conversations_history">;
 	}>;
+	/**
+	 * Durable private files of the application's Organization. `upload` stores
+	 * one PDF, JPEG or PNG of up to 10 MiB with no expiry and returns its
+	 * `storageFileId`; a `workflows.invoke` input can name it, and the nodes of
+	 * the run read the file. Needs the `ai:attachments` scope and confidential
+	 * credentials. Unlike `attachments.upload`, the file belongs to no run and
+	 * does not expire after 24 hours.
+	 */
+	readonly files: Readonly<{
+		upload: ServerOperationMethod<"files_upload">;
+	}>;
 	readonly knowledge: Readonly<{
 		autocomplete: ServerOperationMethod<"knowledge_autocomplete">;
 		createEntity: ServerOperationMethod<"knowledge_create_entity">;
@@ -772,6 +862,26 @@ export interface ServerClient {
 	readonly messages: Readonly<{
 		send: ServerMessageSendMethod;
 	}>;
+	/**
+	 * The application's browser origins in its Organization. `setRuntime({ origin })`
+	 * replaces the application's one runtime origin, such as the URL of the
+	 * current deployment, beside the `allowedOrigins` its package declares.
+	 * Needs the `origins:write` scope and confidential credentials.
+	 */
+	readonly origins: Readonly<{
+		setRuntime: ServerOperationMethod<"origins_set_runtime">;
+	}>;
+	/**
+	 * CI's resources API. `createUpload` asks a single-use File upload slot for
+	 * one File field of an entity schema; the entity write then names its
+	 * `uploadId` as `{ upload }`. Slots follow entity writes: the member's
+	 * delegated token writes as that member; the service credential writes as
+	 * the Organization default service principal, only on schemas its own
+	 * package declares.
+	 */
+	readonly resources: Readonly<{
+		createUpload: ServerResourceUploadMethod;
+	}>;
 	readonly runs: Readonly<{
 		cancel: ServerRunOperationMethod<"runs_cancel", ServerRun>;
 		get: ServerRunOperationMethod<"runs_get", ServerRun>;
@@ -854,6 +964,7 @@ export declare const exchangeMemberSession: (request: MemberSessionExchangeReque
 export declare const uuidV7: () => string;
 
 export {
+	DurableFileUpload as ServerDurableFileUpload,
 	MemberSessionExchangeError$1 as MemberSessionExchangeError,
 	MemberUser as ServerMemberUser,
 	MemberUserPage as ServerMemberUserPage,
@@ -864,6 +975,7 @@ export {
 	MessageSendFailure as ServerMessageSendFailure,
 	MessageSendResult as ServerMessageSendResult,
 	MessageTarget as ServerMessageTarget,
+	StorageFileId as ServerStorageFileId,
 };
 
 export {};