@neta-art/cohub 8.17.0 → 8.19.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +17 -9
- package/dist/chunks/environment.d.ts +525 -5
- package/dist/chunks/environment.js +1 -0
- package/dist/chunks/http.d.ts +51 -2
- package/dist/chunks/http.js +975 -943
- package/dist/chunks/websocket.d.ts +1 -1
- package/dist/http.d.ts +2 -2
- package/dist/index.d.ts +35 -4
- package/dist/index.js +834 -30
- package/dist/protocol/dist/app-authorization.d.ts +1 -0
- package/dist/protocol/dist/index.d.ts +4 -0
- package/dist/protocol/dist/model/session.d.ts +1 -0
- package/dist/protocol/dist/model/turn.d.ts +1 -0
- package/dist/protocol/dist/realtime/types.d.ts +2 -0
- package/dist/protocol/dist/runtime/archive.d.ts +1 -0
- package/dist/protocol/dist/runtime/context.d.ts +1 -0
- package/dist/protocol/dist/runtime/index.d.ts +3 -0
- package/dist/types.d.ts +1 -0
- package/docs/app-runtime-guide.md +145 -92
- package/package.json +1 -1
package/dist/chunks/http.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { $r as SpaceUsageResponse, $t as PublicReferral, Aa as BoardPlaybackCommand, Ai as SessionTurnPatchEvent, An as SessionTurnWindowResponse, Ar as SpaceFsWriteFileInput, Br as SpacePresenceSnapshot, Bt as MeResponse, Cn as SessionMessagesPaginatedResponse, Dn as SessionTurnResponse, Ea as BoardCreateInput, En as SessionTurnIndexResponse, Et as InvitationDetail, Fa as BoardSummary, Fo as
|
|
1
|
+
import { $r as SpaceUsageResponse, $t as PublicReferral, Aa as BoardPlaybackCommand, Ai as SessionTurnPatchEvent, An as SessionTurnWindowResponse, Ar as SpaceFsWriteFileInput, As as RuntimeArchiveUpload, Bo as ChannelHealth, Br as SpacePresenceSnapshot, Bs as SpaceCompletionResult, Bt as MeResponse, Cn as SessionMessagesPaginatedResponse, Dn as SessionTurnResponse, Ea as BoardCreateInput, En as SessionTurnIndexResponse, Es as HarnessArchiveIndex, Et as InvitationDetail, Fa as BoardSummary, Fo as BillingPayload, Fr as SpaceMember, Ft as LabelListItem, Ga as BoardAuthoringSnapshot, Gn as SpaceCheckpointDetailResponse, Go as MessageRecord, Hr as SpacePublicProfile, Hs as Usage, In as SpaceAccessPolicy, Io as GenerationContentBlock, Ji as DesktopCommand, Jo as MessageToolCallsFile, Jr as SpaceSessionsResponse, Jt as PatchResourceLabelsResponse, Kn as SpaceCommerceBenefit, Ko as SessionForkRecord, Li as AppContentKind, Lo as GenerationModelDeclaration, Lr as SpaceModListItem, Lt as LabelResourceType, Mr as SpaceInvitationListResponse, Mt as LabelAssignmentRecord, Na as BoardPlaybackSnapshot, Nn as SkillCatalogResponse, Nt as LabelItemsResponse, On as SessionTurnSignedUrlsResponse, Os as RuntimeArchivePage, Qi as DesktopCommandStatus, Qn as SpaceCommerceProductBenefitBinding, Qo as StoredIntermediateMessage, Qt as PromptTemplateCatalogResponse, Ra as BoardTransactionsPage, Ri as AppVersionSource, Rr as SpacePendingDiffFileResponse, Rs as CreateSpaceCompletionInput, Sn as SessionMessageResponse, Sr as SpaceFsTreeResponse, St as GlobalSearchResponse, Ta as BoardCapabilities, Tn as SessionRecord, Ur as SpaceRecord, Us as ContentBlock, Ut as PaletteOverviewResponse, Vs as SpaceCompletionStreamEvent, Vt as ModelCatalogEntry, Wa as BoardAuthoringReadInput, Wr as SpaceRole, Xa as BoardSemanticMutation, Xi as DesktopCommandError, Xn as SpaceCommerceOrder, Xo as SessionTurnRecord, Yr as SpaceTurnAuthorFilter, Yt as Permission, Z as Channel, Zi as DesktopCommandRecord, Zn as SpaceCommerceProduct, Zo as SpaceTurnsResponse, _i as BoardAwarenessUpdatedEvent$1, _r as SpaceFsMoveInput, _t as CronJobUpdatePatch, ar as SpaceDefaultResponse, at as CheckpointDiffSummary, bo as AppAuthorizationRequest$1, ca as NavigationLaunch, ci as UserProfile, cn as ReferenceDirection, cr as SpaceFsCompleteUploadResponse, ct as CreateInvitationInput, di as UserSessionSourceKey, dn as ReferenceQueryableType, dr as SpaceFsCreateUploadResponse, es as TurnIntermediateMessagesFile, et as CheckpointDiffFileResponse, ft as CreateSpacePromptInput, g as AcceptInvitationResponse, gr as SpaceFsFileResponse, gt as CronJobRecord, hs as RuntimeStopConfirmation, ii as UserActivityQuery, ir as SpaceCreateResponse, ji as AppArtifactDescriptor, jn as SessionTurnsPaginatedResponse, ka as BoardMutationReceipt, kn as SessionTurnStreamSnapshotResponse, kr as SpaceFsUploadResponse, la as SpacePublicEndpoints, li as UserRulesResponse, ln as ReferenceKind, lt as CreateInvitationResponse, mn as ReferralDashboard, ms as RuntimeStatus, mt as CreateSpaceSessionInput, ni as TaskRunRecord, nn as PublicUserProfile, nr as SpaceConfigResponse, on as ReferenceAggregateGroupBy, or as SpaceEnvInput, ot as CheckpointRecord, pa as BoardAwarenessUpdate, pi as UserSessionsResponse, ps as RuntimeSessionRecoveryStatus, pt as CreateSpacePromptResponse, qn as SpaceCommerceBuyerProfile, qs as RequestSource, qt as PatchResourceLabelsInput, r as CohubEnvironment, rr as SpaceConfigUpdateResponse, sa as NavigationCall, si as UserActivityResponse, sn as ReferenceAggregateResponse, sr as SpaceFsCompleteUploadInput, st as ClaimReferralResponse, ti as TaskRunDetailResponse, tn as PublicUserPageResponse, tr as SpaceConfigInput, un as ReferenceQueryResponse, ur as SpaceFsCreateUploadInput, ut as CreateSpaceInput, v as BatchUserProfilesResponse, vi as BoardChangedEvent$1, vr as SpaceFsPreparingFile, vt as CursorPageInfo, wi as RealtimePatchOperation, wn as SessionMessagesResponse, wt as GlobalSearchType, xo as AppAuthorizationResult, xr as SpaceFsReadFilesResponse, yi as BoardPlaybackChangedEvent$1, za as BoardTransactionsReadInput, zn as SpaceActivityResponse, zo as ChannelConfig, zr as SpacePendingDiffSummary } from "./environment.js";
|
|
2
2
|
import { a as WebsocketClientOptions, r as WebsocketClient, s as WebsocketEventPayload } from "./websocket.js";
|
|
3
3
|
import { a as VoiceInputCreateOptions } from "./voice-input.js";
|
|
4
4
|
//#region ../protocol/dist/model/status.d.ts
|
|
@@ -321,6 +321,15 @@ declare const APP_PROMOTION_EVENT_KEYS: readonly ["landing", "ready", "registrat
|
|
|
321
321
|
type AppPromotionEventKey = typeof APP_PROMOTION_EVENT_KEYS[number];
|
|
322
322
|
//#endregion
|
|
323
323
|
//#region src/app-runtime.d.ts
|
|
324
|
+
type AppAuthorizationRequest = Omit<AppAuthorizationRequest$1, "scopes"> & {
|
|
325
|
+
scopes: Permission[];
|
|
326
|
+
};
|
|
327
|
+
declare class AppRuntimeError extends Error {
|
|
328
|
+
readonly code: string;
|
|
329
|
+
readonly requestId?: string | undefined;
|
|
330
|
+
readonly retryable: boolean;
|
|
331
|
+
constructor(code: string, message: string, requestId?: string | undefined);
|
|
332
|
+
}
|
|
324
333
|
type AppRuntimeInvocationContext = {
|
|
325
334
|
surface: "page" | "app" | "overlay" | "background" | "broker";
|
|
326
335
|
source?: "desktop_command" | "user" | "route" | "embed";
|
|
@@ -357,6 +366,12 @@ type AppRuntimeGrantSummary = {
|
|
|
357
366
|
scopes: Permission[];
|
|
358
367
|
};
|
|
359
368
|
type AppRuntimeContext = {
|
|
369
|
+
/** Host capabilities, independent of the viewer's granted permissions. */
|
|
370
|
+
capabilities?: {
|
|
371
|
+
authorization: 2;
|
|
372
|
+
serverGrants: true;
|
|
373
|
+
};
|
|
374
|
+
mode?: "bridge" | "broker";
|
|
360
375
|
app: {
|
|
361
376
|
id: string;
|
|
362
377
|
slug: string;
|
|
@@ -533,6 +548,11 @@ declare class AppRuntimeApi {
|
|
|
533
548
|
private writeStoredToken;
|
|
534
549
|
private readStoredGrants;
|
|
535
550
|
private writeStoredGrants;
|
|
551
|
+
private serverGrants;
|
|
552
|
+
private viewerIdentity;
|
|
553
|
+
private identityVersion;
|
|
554
|
+
private contextUnsubscribe;
|
|
555
|
+
private observeContext;
|
|
536
556
|
context(): Promise<AppRuntimeContext | null>;
|
|
537
557
|
onContextChanged(listener: AppContextChangedListener): () => void;
|
|
538
558
|
/** Subscribes to developer-facing host diagnostics. */
|
|
@@ -561,7 +581,10 @@ declare class AppRuntimeApi {
|
|
|
561
581
|
getAccessToken(options?: {
|
|
562
582
|
forceRefresh?: boolean;
|
|
563
583
|
}): Promise<string | null>;
|
|
584
|
+
/** Structured authorization. Legacy hosts cannot execute this message. */
|
|
585
|
+
authorize(input: AppAuthorizationRequest): Promise<AppAuthorizationResult>;
|
|
564
586
|
/**
|
|
587
|
+
* @deprecated Use authorize() to receive the actual target and grant.
|
|
565
588
|
* Requests viewer consent. With an accessible `spaceId` the grant targets
|
|
566
589
|
* that Space; otherwise the host resolves a viewer-controlled Space (the
|
|
567
590
|
* invocation or embedding Space, then the viewer's last picked Space, then
|
|
@@ -579,6 +602,7 @@ declare class AppRuntimeApi {
|
|
|
579
602
|
alwaysAsk?: boolean;
|
|
580
603
|
}): Promise<boolean>;
|
|
581
604
|
/**
|
|
605
|
+
* @deprecated Use authorize() with a pick-space target.
|
|
582
606
|
* Asks the viewer to pick a Space and grant the scopes on it — one consent
|
|
583
607
|
* dialog covers both. Resolves with the picked space so the app knows where
|
|
584
608
|
* it may act; `space` is null when the viewer denied.
|
|
@@ -1944,6 +1968,24 @@ declare class SpaceClient {
|
|
|
1944
1968
|
readonly commerce: SpaceCommerceApi;
|
|
1945
1969
|
constructor(id: string, transport: HttpTransport, websocketClient: WebsocketClient | null);
|
|
1946
1970
|
get(customFetch?: Fetch): Promise<SpaceRecord>;
|
|
1971
|
+
prepareRuntimeArchive(index: HarnessArchiveIndex, options?: {
|
|
1972
|
+
signal?: AbortSignal;
|
|
1973
|
+
}): Promise<{
|
|
1974
|
+
uploads: RuntimeArchiveUpload[];
|
|
1975
|
+
}>;
|
|
1976
|
+
commitRuntimeArchive(index: HarnessArchiveIndex, options?: {
|
|
1977
|
+
signal?: AbortSignal;
|
|
1978
|
+
}): Promise<{
|
|
1979
|
+
ready: true;
|
|
1980
|
+
}>;
|
|
1981
|
+
getRuntimeArchive(sessionId: string, turnId: string, options?: {
|
|
1982
|
+
signal?: AbortSignal;
|
|
1983
|
+
}): Promise<RuntimeArchivePage>;
|
|
1984
|
+
getRuntime(customFetch?: Fetch): Promise<RuntimeStatus>;
|
|
1985
|
+
getSessionRuntime(sessionId: string, customFetch?: Fetch): Promise<RuntimeSessionRecoveryStatus>;
|
|
1986
|
+
confirmRuntimeStopped(sessionId: string, confirmation: RuntimeStopConfirmation): Promise<{
|
|
1987
|
+
accepted: true;
|
|
1988
|
+
}>;
|
|
1947
1989
|
getStartup(customFetch?: Fetch): Promise<SpaceStartupResponse>;
|
|
1948
1990
|
prompt(input: CreateSpacePromptInput): Promise<CreateSpacePromptResponse>;
|
|
1949
1991
|
/**
|
|
@@ -2146,6 +2188,7 @@ type AppRecord = {
|
|
|
2146
2188
|
latestVersion: number;
|
|
2147
2189
|
publishedAt: string | null;
|
|
2148
2190
|
appScopes: Permission[];
|
|
2191
|
+
/** @deprecated Viewer grants are not restricted by publisher configuration. */
|
|
2149
2192
|
allowedViewerScopes: Permission[];
|
|
2150
2193
|
meta: AppMeta | null;
|
|
2151
2194
|
createdAt: string | null;
|
|
@@ -2160,6 +2203,7 @@ type AppCreateInput = {
|
|
|
2160
2203
|
targetRef: string;
|
|
2161
2204
|
assetKey?: string | null;
|
|
2162
2205
|
appScopes?: Permission[];
|
|
2206
|
+
/** @deprecated Viewer grants are not restricted by publisher configuration. */
|
|
2163
2207
|
allowedViewerScopes?: Permission[];
|
|
2164
2208
|
meta?: AppMeta | null;
|
|
2165
2209
|
};
|
|
@@ -2170,6 +2214,7 @@ type AppUpdateInput = Partial<{
|
|
|
2170
2214
|
targetType: AppTargetType;
|
|
2171
2215
|
targetRef: string;
|
|
2172
2216
|
appScopes: Permission[];
|
|
2217
|
+
/** @deprecated Viewer grants are not restricted by publisher configuration. */
|
|
2173
2218
|
allowedViewerScopes: Permission[];
|
|
2174
2219
|
meta: AppMeta | null;
|
|
2175
2220
|
}>;
|
|
@@ -2244,7 +2289,10 @@ type AppPublicOwnerRecord = {
|
|
|
2244
2289
|
type AppDetailResponse = {
|
|
2245
2290
|
app: AppRecord;
|
|
2246
2291
|
space: AppPublicSpaceRecord;
|
|
2292
|
+
/** Space owner: the public URL and share metadata use this identity. */
|
|
2247
2293
|
owner: AppPublicOwnerRecord;
|
|
2294
|
+
/** Member who published this App, which may differ from the Space owner. */
|
|
2295
|
+
publisher: PublicUserProfile;
|
|
2248
2296
|
publicUrl: string | null;
|
|
2249
2297
|
content: AppContent | null;
|
|
2250
2298
|
/** Version whose content is served; the current version when omitted. */
|
|
@@ -2428,6 +2476,7 @@ declare class AppsApi {
|
|
|
2428
2476
|
spaceId?: string;
|
|
2429
2477
|
reason?: string;
|
|
2430
2478
|
silent?: boolean;
|
|
2479
|
+
scopeMode?: "extend";
|
|
2431
2480
|
}): Promise<AppAuthorizeResponse>;
|
|
2432
2481
|
/** Lists the caller's own grants for an app, one row per space. */
|
|
2433
2482
|
listMyGrants(appId: string): Promise<{
|
|
@@ -2659,4 +2708,4 @@ declare class CohubHttpClient {
|
|
|
2659
2708
|
}
|
|
2660
2709
|
declare const createHttpClient: (options?: CohubClientOptions) => CohubHttpClient;
|
|
2661
2710
|
//#endregion
|
|
2662
|
-
export { AppTargetType as $, HttpTransport as $n, SpaceWebhooksApi as $t, WaitForUiCommandOptions as A, ReferencesApi as An,
|
|
2711
|
+
export { AppTargetType as $, HttpTransport as $n, SpaceWebhooksApi as $t, WaitForUiCommandOptions as A, ReferencesApi as An, AppNavigationTarget as Ar, WorkUpdateInput as At, AppPresentationMeta as B, UploadChatAttachmentInput as Bn, PublicFileUrlResponse as Br, BoardAwarenessUpdatedEvent as Bt, DesktopCommandsApi as C, SessionPatchApplyResult as Cn, createAppRuntime as Cr, WorkPublicOwnerRecord as Ct, UiCommandStatus as D, createSessionPatchReducer as Dn, AppNavigationLaunch as Dr, WorkSessionResponse as Dt, UiCommandRecord as E, SessionPatchStatus as En, AppNavigationCall as Er, WorkResolveResponse as Et, AppCreateInput as F, PublicAssetPurpose as Fn, PublicFileCreateUploadResponse as Fr, ReferralsApi as Ft, AppPromotionRecord as G, ModelsApi as Gn, CreateGenerationTaskResponse as Gr, BoardSubscriptionHandlers as Gt, AppPromotionEventResponse as H, UploadPublicAssetInput as Hn, SpaceWebhookTriggerResponse as Hr, BoardClient as Ht, AppDetailResponse as I, PublicAssetUploadProgress as In, PublicFileListEntry as Ir, UsersApi as It, AppPublicSpaceRecord as J, ChannelsApi as Jn, ListGenerationModelsResponse as Jr, SpaceChannelBindingRecord as Jt, AppPromotionStatsResponse as K, GenerationsApi as Kn, GenerationTaskResult as Kr, SessionEventName as Kt, AppExtractedPageMeta as L, PublicAssetUploadProtocol as Ln, PublicFileListResponse as Lr, UserApi as Lt, AppAuthorizeResponse as M, CreatePublicAssetUploadInput as Mn, AppRuntimeConfigureRequest as Mr, WorkViewSource as Mt, AppContent as N, CreatePublicAssetUploadResponse as Nn, AppRuntimeRect as Nr, WorkViewStatsResponse as Nt, UiCommandsApi as O, SessionAccessApi as On, AppNavigationOpenMessage as Or, WorkStatus as Ot, AppContentDownload as P, PublicAssetMimeType as Pn, PublicFileCreateUploadInput as Pr, WorkVisibility as Pt, AppStatus as Q, HttpTraceContext as Qn, SpaceTurnListOptions as Qt, AppGetResponse as R, PublicAssetsApi as Rn, PublicFileUploadEntryInput as Rr, TaskWaitOptions as Rt, CreateUiCommandInput as S, SessionPatchApplyInput as Sn, PopupBrokerTransport as Sr, WorkPromotionStatsResponse as St, UiCommandError as T, SessionPatchState as Tn, resolveAppTransport as Tr, WorkRecord as Tt, AppPromotionProvider as U, SkillsApi as Un, SpaceStartupResponse as Ur, BoardEventName as Ut, AppPromotionCreateInput as V, UploadChatImageAttachmentInput as Vn, SpaceWebhookListItem as Vr, BoardChangedEvent as Vt, AppPromotionProviderStatus as W, PromptsApi as Wn, CreateGenerationTaskRequest as Wr, BoardPlaybackChangedEvent as Wt, AppResolveResponse as X, Fetch as Xn, ModelStatusEntry as Xr, SpaceEventName as Xt, AppRecord as Y, CohubClientOptions as Yn, PublicGenerationDeclaration as Yr, SpaceClient as Yt, AppSessionResponse as Z, HttpError as Zn, ModelStatusResponse as Zr, SpacePublicFilesApi as Zt, WorkCommerceEntitlementsResponse as _, GenerationStreamSubscriptionHandlers as _n, AppRuntimeModeConfig as _r, WorkPromotionCreateInput as _t, AppCommerceCreditConsumeResponse as a, buildSpaceInvitePath as an, AppAuthorizationRequest as ar, AppVisibility as at, WorkCommercePurchaseResponse as b, createSessionGenerationStreamClient as bn, AppRuntimeTransport as br, WorkPromotionProviderStatus as bt, AppCommerceEntitlementsResponse as c, GenerationStreamCommitEvent as cn, AppDiagnosticListener as cr, WorkAuthorizeResponse as ct, AppCommercePurchaseResponse as d, GenerationStreamFinalizedEvent as dn, AppRuntimeAuthorizationResult as dr, WorkCreateInput as dt, SpacesApi as en, RawHttpResponse as er, AppUpdateInput as et, WorkCommerceApi as f, GenerationStreamIntermediateMessage as fn, AppRuntimeCheckoutState as fr, WorkDetailResponse as ft, WorkCommerceEntitlement as g, GenerationStreamSubscribeOptions as gn, AppRuntimeInvocationContext as gr, WorkPresentationMeta as gt, WorkCommerceCreditConsumeStatus as h, GenerationStreamStateEvent as hn, AppRuntimeError as hr, WorkMeta as ht, AppCommerceCheckoutStatus as i, PublicInviteApi as in, sanitizeAccessToken as ir, AppViewerGrantRecord as it, AppActionRunResponse as j, SearchApi as jn, AppRuntimeAnchor as jr, WorkVersionRecord as jt, WaitForDesktopCommandOptions as k, ReferenceResourceSelector as kn, AppNavigationOpenResponse as kr, WorkTargetType as kt, AppCommerceOrder as l, GenerationStreamErrorEvent as ln, AppIdResolver as lr, WorkContent as lt, WorkCommerceCreditConsumeResponse as m, GenerationStreamOutOfSyncEvent as mn, AppRuntimeContext as mr, WorkGetResponse as mt, createHttpClient as n, BuildSpaceInvitePathInput as nn, joinApiUrl as nr, AppViewSource as nt, AppCommerceCreditConsumeStatus as o, buildSpacePath as on, AppContextChangedListener as or, AppsApi as ot, WorkCommerceCheckoutStatus as p, GenerationStreamLifecycleEvent as pn, AppRuntimeCheckoutStatus as pr, WorkExtractedPageMeta as pt, AppPublicOwnerRecord as q, CronJobsApi as qn, GenerationUsageBilling as qr, SessionSubscriptionHandlers as qt, AppCommerceApi as r, BuildSpacePathInput as rn, matchesUnauthorizedErrorToken as rr, AppViewStatsResponse as rt, AppCommerceEntitlement as s, AssistantMessageCommit as sn, AppDiagnostic as sr, PublicAppVersionSummary as st, CohubHttpClient as t, WebSocketConnectionState as tn, UnauthorizedContext as tr, AppVersionRecord as tt, AppCommerceProductResolveResponse as u, GenerationStreamEvent as un, AppRuntimeApi as ur, WorkContentDownload as ut, WorkCommerceOrder as v, GenerationStreamTurnUpdatedEvent as vn, AppRuntimeRequestOptions as vr, WorkPromotionEventResponse as vt, UiCommand as w, SessionPatchReducer as wn, createSlugAppIdResolver as wr, WorkPublicSpaceRecord as wt, CreateDesktopCommandInput as x, parseAssistantMessageCommit as xn, ParentBridgeTransport as xr, WorkPromotionRecord as xt, WorkCommerceProductResolveResponse as y, SessionGenerationStreamClient as yn, AppRuntimeShellContext as yr, WorkPromotionProvider as yt, AppMeta as z, UploadAppSourceInput as zn, PublicFileUploadPlanEntry as zr, TasksApi as zt };
|