@collective-intelligence/external-apps-server-sdk 0.0.0-stage → 0.1.0

package/dist/tools/ai-sdk.d.ts

@@ -0,0 +1,170 @@
+// Generated by dts-bundle-generator v9.5.1
+
+import { FlexibleSchema, Tool } from 'ai';
+
+export type JsonPrimitive = boolean | null | number | string;
+export type JsonValue = JsonObject | JsonPrimitive | readonly JsonValue[];
+export interface JsonObject {
+	readonly [key: string]: JsonValue;
+}
+declare const Draft202012Dialect: "https://json-schema.org/draft/2020-12/schema";
+/** JSON-compatible Draft 2020-12 vocabulary used for portable manifests. */
+export type JsonSchemaDocument = JsonObject & Readonly<{
+	$anchor?: string;
+	$comment?: string;
+	$defs?: Readonly<Record<string, JsonSchemaDocument>>;
+	$dynamicAnchor?: string;
+	$dynamicRef?: string;
+	$id?: string;
+	$ref?: string;
+	$schema?: typeof Draft202012Dialect;
+	additionalProperties?: boolean | JsonSchemaDocument;
+	allOf?: readonly JsonSchemaDocument[];
+	anyOf?: readonly JsonSchemaDocument[];
+	const?: JsonValue;
+	contains?: JsonSchemaDocument;
+	default?: JsonValue;
+	dependentRequired?: Readonly<Record<string, readonly string[]>>;
+	description?: string;
+	else?: JsonSchemaDocument;
+	enum?: readonly JsonValue[];
+	exclusiveMaximum?: number;
+	exclusiveMinimum?: number;
+	format?: string;
+	if?: JsonSchemaDocument;
+	items?: JsonSchemaDocument;
+	maxItems?: number;
+	maxLength?: number;
+	maxProperties?: number;
+	maximum?: number;
+	minItems?: number;
+	minLength?: number;
+	minProperties?: number;
+	minimum?: number;
+	multipleOf?: number;
+	not?: JsonSchemaDocument;
+	oneOf?: readonly JsonSchemaDocument[];
+	pattern?: string;
+	patternProperties?: Readonly<Record<string, JsonSchemaDocument>>;
+	prefixItems?: readonly JsonSchemaDocument[];
+	properties?: Readonly<Record<string, JsonSchemaDocument>>;
+	required?: readonly string[];
+	then?: JsonSchemaDocument;
+	title?: string;
+	type?: "array" | "boolean" | "integer" | "null" | "number" | "object" | "string" | readonly ("array" | "boolean" | "integer" | "null" | "number" | "object" | "string")[];
+	unevaluatedItems?: boolean | JsonSchemaDocument;
+	unevaluatedProperties?: boolean | JsonSchemaDocument;
+	uniqueItems?: boolean;
+}>;
+export type ProjectionFidelity = "exact" | "structural";
+export type PackageSchemaProjection = Readonly<{
+	dialect: typeof Draft202012Dialect;
+	document: JsonSchemaDocument;
+	fidelity: ProjectionFidelity;
+}>;
+/** Closed public principal vocabulary accepted by a gateway operation. */
+export type PortableOperationPrincipalKind = "detached_user" | "service_principal";
+/** Explicit delegated-subject requirement reviewed with an operation. */
+export type PortableOperationDelegatedSubjectPolicy = "allowed" | "forbidden" | "required";
+/** Fully materialized authorization policy for one exposed operation. */
+export type PortableOperationAuthorization = Readonly<{
+	delegatedSubject: PortableOperationDelegatedSubjectPolicy;
+	organization: "required";
+	principalKinds: readonly PortableOperationPrincipalKind[];
+	scopes: readonly string[];
+}>;
+/** Observable side-effect class reviewed before an operation becomes a tool. */
+export type PortableOperationEffect = "external_side_effect" | "read" | "write";
+/** The replay guarantee supplied by the operation implementation. */
+export type PortableOperationIdempotency = "idempotent" | "requires_key" | "safe";
+/** Explicit, bounded retry permission for callers of the operation. */
+export type PortableOperationRetryPolicy = Readonly<{
+	mode: "never";
+}> | Readonly<{
+	maxAttempts: number;
+	mode: "idempotent_only";
+}>;
+/** Execution lifecycle and maximum wall-clock duration. */
+export type PortableOperationExecutionPolicy = Readonly<{
+	mode: "synchronous";
+	timeoutMs: number;
+}>;
+/** Per-invocation transport bounds. */
+export type PortableOperationLimits = Readonly<{
+	maxRequestBytes: number;
+	maxResponseBytes: number;
+}>;
+/**
+ * Complete JSON-only operation contract reviewed by a host. Executable
+ * handlers remain in a server runtime sidecar and never enter this descriptor.
+ */
+export type PortableOperationDeclaration = Readonly<{
+	authorization: PortableOperationAuthorization;
+	description: string;
+	effects: PortableOperationEffect;
+	execution: PortableOperationExecutionPolicy;
+	id: string;
+	idempotency: PortableOperationIdempotency;
+	input: PackageSchemaProjection;
+	limits: PortableOperationLimits;
+	output: PackageSchemaProjection;
+	retry: PortableOperationRetryPolicy;
+	title: string;
+	version: string;
+}>;
+export type PrincipalKind = "detached_user" | "service_principal";
+export type ExternalAuditSubject = Readonly<{
+	issuer: string;
+	mappedCiUserId?: string;
+	subject: string;
+}>;
+export type GatewayCallerIdentity = Readonly<{
+	audience: readonly string[];
+	binding: string;
+	expiresAt: number;
+	installationId: string;
+	issuer: string;
+	organizationId: string;
+	principalKind: PrincipalKind;
+	requestId: string;
+	scopes: readonly string[];
+	subject: string;
+}>;
+export type GatewayInvocationContext = Readonly<{
+	caller: GatewayCallerIdentity;
+	correlationId: string;
+	externalAuditSubject?: ExternalAuditSubject;
+	organizationId: string;
+}>;
+/**
+ * Runtime dispatch validates the declared input schema before invoking a
+ * handler. The bivariant call signature lets domains retain heterogeneous,
+ * strongly typed handlers while exposing one erased operation collection.
+ */
+export type GatewayOperationHandler<Input = unknown, Output = unknown> = {
+	bivarianceHack(request: Readonly<{
+		context: GatewayInvocationContext;
+		/** Validated caller key; the handler owns durable replay storage. */
+		idempotencyKey?: string;
+		input: Input;
+		signal: AbortSignal;
+	}>): Promise<Output>;
+}["bivarianceHack"];
+export type GatewayOperationDefinition<Input = unknown, Output = unknown> = Omit<PortableOperationDeclaration, "input" | "output"> & Readonly<{
+	handler: GatewayOperationHandler<Input, Output>;
+	input: PackageSchemaProjection;
+	output: PackageSchemaProjection;
+}>;
+export type AiSdkOperationOptions<Input, Output, Context = unknown> = Omit<GatewayOperationDefinition, "handler" | "input" | "output" | "description"> & Readonly<{
+	tool: Tool<Input, Output, Context>;
+	/** Fills missing or dynamic descriptions; existing static strings are preserved. */
+	description?: string;
+	input?: PackageSchemaProjection;
+	output?: PackageSchemaProjection;
+	context?: (request: Parameters<GatewayOperationHandler<Input>>[0]) => unknown;
+	contextSchema?: FlexibleSchema<Context>;
+	authorize: (request: Parameters<GatewayOperationHandler<Input>>[0]) => boolean | Promise<boolean>;
+}>;
+export declare const defineAiSdkOperation: <Input, Output, Context = unknown>(options: AiSdkOperationOptions<Input, Output, Context>) => Promise<GatewayOperationDefinition>;
+
+export {};