@collective-intelligence/external-apps-server-sdk 0.1.18 → 0.1.21

package/dist/runtime/next.d.ts

@@ -364,6 +364,22 @@ export type CiResourcesOptions = Readonly<{
 	policy?: UserAuthScopePolicy;
 	tenantUrl: string;
 }>;
+export type RealtimeTicketOptions = Readonly<{
+	auth: Pick<ApplicationUserAuth, "getAccessToken">;
+	/** The CI organization the signed-in users belong to. */
+	organizationId: string;
+	/** The CI origin that mints tickets. */
+	tenantUrl: string;
+	/** The origin the browser opens the event stream on; defaults to `tenantUrl`. */
+	host?: string;
+	fetch?: typeof globalThis.fetch;
+}>;
+/** The ticket route answer: a single-use ticket and the stream it opens. */
+export type RealtimeTicketResponse = Readonly<{
+	ticket: string;
+	expiresAt: string;
+	streamUrl: string;
+}>;
 export type BffResourceMount = Readonly<{
 	basePath: string;
 	handler: (request: Request) => Promise<Response>;
@@ -376,12 +392,17 @@ export type ExternalApplicationBffCapabilities = Readonly<{
 }> & (Readonly<{
 	authentication?: never;
 }> | ServiceCapabilityAuthorization);
+/** The realtime ticket route `POST {basePath}/realtime/ticket`; `basePath` defaults to `/api`. */
+export type ExternalApplicationBffRealtime = Omit<RealtimeTicketOptions, "auth"> & Readonly<{
+	basePath?: string;
+}>;
 export type ExternalApplicationBffOptions = Readonly<{
 	auth: ApplicationUserAuth;
 	authBasePath?: string;
 	capabilities?: ExternalApplicationBffCapabilities;
 	ciResources?: Omit<CiResourcesOptions, "auth">;
 	publicOrigin: string;
+	realtime?: ExternalApplicationBffRealtime;
 	resources?: readonly BffResourceMount[];
 }>;
 export type ExternalApplicationBff = (request: Request) => Promise<Response>;
@@ -922,6 +943,6 @@ export type ResourceNextRouteHandlers = Readonly<{
 export declare const cookies: (request: Request) => string | null, createCiResourceMounts: (options: CiResourcesOptions) => {
 	basePath: string;
 	handler: (request: Request) => Promise<Response>;
-}[], createExternalApplicationBff: (options: ExternalApplicationBffOptions) => ExternalApplicationBff, createExternalApplicationBffNextHandlers: (options: ExternalApplicationBffOptions) => GatewayNextRouteHandlers, createFixedWorkflowRoute: <Input, Params = Record<string, never>>(options: FixedWorkflowRouteOptions<Input, Params>) => ((request: Request, params: Params) => Promise<Response>), createGatewayNextRouteHandlers: (kernel: GatewayRuntimeKernel) => GatewayNextRouteHandlers, createResourceNextRouteHandlers: <Value, Create = Value, Patch = Partial<Value>>(options: ResourceHttpHandlerOptions<Value, Create, Patch>) => ResourceNextRouteHandlers, headers: (request: Request) => Headers, publicOriginFromHeaders: (headerList: Headers, fallbackOrigin: string) => string, requestWithPublicOrigin: (request: Request, publicOrigin: string) => Request;
+}[], createExternalApplicationBff: (options: ExternalApplicationBffOptions) => ExternalApplicationBff, createExternalApplicationBffNextHandlers: (options: ExternalApplicationBffOptions) => GatewayNextRouteHandlers, createFixedWorkflowRoute: <Input, Params = Record<string, never>>(options: FixedWorkflowRouteOptions<Input, Params>) => ((request: Request, params: Params) => Promise<Response>), createRealtimeTicketHandler: (options: RealtimeTicketOptions) => ((request: Request) => Promise<Response>), createGatewayNextRouteHandlers: (kernel: GatewayRuntimeKernel) => GatewayNextRouteHandlers, createResourceNextRouteHandlers: <Value, Create = Value, Patch = Partial<Value>>(options: ResourceHttpHandlerOptions<Value, Create, Patch>) => ResourceNextRouteHandlers, headers: (request: Request) => Headers, publicOriginFromHeaders: (headerList: Headers, fallbackOrigin: string) => string, requestWithPublicOrigin: (request: Request, publicOrigin: string) => Request;
 
 export {};