@neta-art/cohub 4.9.0 → 5.0.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 +3 -1
- package/dist/chunks/http.d.ts +2 -2
- package/dist/chunks/http.js +1 -1
- package/dist/chunks/websocket.d.ts +27 -46
- package/dist/http.d.ts +2 -2
- package/dist/index.d.ts +2 -10
- package/dist/index.js +0 -13
- package/docs/work-runtime-guide.md +123 -104
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -216,7 +216,7 @@ A **Work** is a published, shareable web page hosted by Cohub. When a viewer
|
|
|
216
216
|
opens a Work, it runs inside a Cohub-managed runtime that provides short-lived
|
|
217
217
|
access tokens — no API keys required.
|
|
218
218
|
|
|
219
|
-
|
|
219
|
+
Four runtime-only APIs are available **exclusively inside a published Work**:
|
|
220
220
|
|
|
221
221
|
- `client.context()` — returns Work identity, Space identity, and current
|
|
222
222
|
permission scopes. Returns `null` outside a Work runtime.
|
|
@@ -224,6 +224,8 @@ Three runtime-only APIs are available **exclusively inside a published Work**:
|
|
|
224
224
|
and caches a token with the approved scopes.
|
|
225
225
|
- `client.work.commerce.*` — entitlement checks, credit consumption,
|
|
226
226
|
purchases.
|
|
227
|
+
- `client.work.realtime.*` — temporary rooms, typed events, presence, and
|
|
228
|
+
membership.
|
|
227
229
|
|
|
228
230
|
### Quick start (inside a Work)
|
|
229
231
|
|
package/dist/chunks/http.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { $ as CreateSpacePromptInput, $n as SpaceFsTreeResponse, Ai as BoardCapabilities, Ar as SpaceUsageResponse, At as
|
|
1
|
+
import { $ as CreateSpacePromptInput, $n as SpaceFsTreeResponse, Ai as BoardCapabilities, Ar as SpaceUsageResponse, At as Permission, Br as ChannelHealth, Bt as ReferenceAggregateGroupBy, Ci as BoardAwarenessUpdate, Cn as SpaceCommerceBenefit, Ct as LabelResourceType, Di as WorkContentKind, Dn as SpaceCommerceOrder, Dt as ModelCatalogEntry, Er as SpaceTurnAuthorFilter, Et as MeResponse, Fn as SpaceCreateResponse, Fr as UserRulesResponse, Ft as PublicUserPageResponse, Gi as BoardPlaybackSnapshot, Gt as ReferenceQueryableType, Hi as BoardPlaybackCommand, Hn as SpaceFsCreateUploadResponse, Ht as ReferenceDirection, Ii as BoardInspectInput, In as SpaceDefaultResponse, J as ClaimReferralResponse, Jn as SpaceFsMoveInput, Jt as ReferralDashboard, K as CheckpointDiffSummary, Ln as SpaceEnvInput, Mi as BoardCreateInput, Mn as SpaceConfigInput, Mr as TaskRunDetailResponse, Nn as SpaceConfigResponse, Nr as TaskRunRecord, Nt as PromptTemplateCatalogResponse, On as SpaceCommerceProduct, Ot as PatchResourceLabelsInput, Pn as SpaceConfigUpdateResponse, Pr as UserProfile, Pt as PublicReferral, Qn as SpaceFsReadFilesResponse, R as Channel, Rn as SpaceFsCompleteUploadInput, Rr as UserSessionsResponse, Sa as RequestSource, Sn as SpaceCheckpointDetailResponse, Tr as SpaceSessionsResponse, Ut as ReferenceKind, V as CheckpointDiffFileResponse, Vn as SpaceFsCreateUploadInput, Vt as ReferenceAggregateResponse, Wt as ReferenceQueryResponse, X as CreateInvitationResponse, Xi as BoardValidationResult, Y as CreateInvitationInput, Yi as BoardTransaction, Yn as SpaceFsPreparingFile, Z as CreateSpaceInput, _a as BillingPayload, _r as SpacePresenceSnapshot, a as WebsocketClientOptions, aa as SessionTurnRecord, an as SessionRecord, at as CursorPageInfo, br as SpaceRecord, ci as BoardTransactionAppliedEvent$1, cn as SessionTurnSignedUrlsResponse, d as BatchUserProfilesResponse, di as RealtimePatchOperation, dn as SessionTurnsPaginatedResponse, dt as GlobalSearchType, ea as SpacePublicEndpoints, et as CreateSpacePromptResponse, fa as CreateSpaceCompletionInput, fr as SpaceMember, ft as InvitationDetail, ga as Usage, gn as SpaceAccessPolicy, gr as SpacePendingDiffSummary, ha as SpaceCompletionStreamEvent, hr as SpacePendingDiffFileResponse, ii as GenerationModelDeclaration, in as SessionMessagesResponse, it as CronJobUpdatePatch, ki as BoardBootstrap, kn as SpaceCommerceProductBenefitBinding, kt as PatchResourceLabelsResponse, l as AcceptInvitationResponse, ln as SessionTurnStreamSnapshotResponse, lr as SpaceInvitationListResponse, lt as GlobalSearchResponse, ma as SpaceCompletionResult, mr as SpaceModListItem, na as SessionForkRecord, nn as SessionMessageResponse, oa as SpaceTurnsResponse, oi as BoardAwarenessUpdatedEvent$1, on as SessionTurnIndexResponse, or as SpaceFsUploadResponse, pn as SkillCatalogResponse, q as CheckpointRecord, qn as SpaceFsFileResponse, r as WebsocketClient, ri as GenerationContentBlock, rn as SessionMessagesPaginatedResponse, rt as CronJobRecord, s as WebsocketEventPayload, si as BoardPlaybackChangedEvent$1, sn as SessionTurnResponse, sr as SpaceFsWriteFileInput, ta as MessageRecord, tt as CreateSpaceSessionInput, un as SessionTurnWindowResponse, va as ContentBlock, vi as SessionTurnPatchEvent, vt as LabelAssignmentRecord, wi as WorkArtifactDescriptor, wn as SpaceCommerceBuyerProfile, xr as SpaceRole, xt as LabelListItem, yr as SpacePublicProfile, yt as LabelItemsResponse, zn as SpaceFsCompleteUploadResponse, zr as ChannelConfig } from "./websocket.js";
|
|
2
2
|
import { n as CohubEnvironment } from "./environment.js";
|
|
3
3
|
import { a as VoiceInputCreateOptions } from "./voice-input.js";
|
|
4
4
|
//#region ../protocol/dist/model/status.d.ts
|
|
@@ -921,7 +921,7 @@ declare class SpacesApi {
|
|
|
921
921
|
getDefault(customFetch?: Fetch): Promise<SpaceDefaultResponse>;
|
|
922
922
|
get(spaceId: string, customFetch?: Fetch): Promise<SpaceRecord>;
|
|
923
923
|
getBySlug(username: string, slug: string, customFetch?: Fetch): Promise<SpaceRecord>;
|
|
924
|
-
create(input
|
|
924
|
+
create(input: CreateSpaceInput, headers?: Record<string, string>): Promise<SpaceCreateResponse>;
|
|
925
925
|
}
|
|
926
926
|
declare class SpaceFilesApi {
|
|
927
927
|
private readonly transport;
|
package/dist/chunks/http.js
CHANGED
|
@@ -2756,12 +2756,37 @@ type SpaceSandboxConfig = {
|
|
|
2756
2756
|
type SpaceConfig = {
|
|
2757
2757
|
sandbox?: SpaceSandboxConfig;
|
|
2758
2758
|
};
|
|
2759
|
+
type SpaceBootstrapSource = {
|
|
2760
|
+
type: "blank";
|
|
2761
|
+
} | {
|
|
2762
|
+
type: "git_repo";
|
|
2763
|
+
repoUrl: string;
|
|
2764
|
+
ref?: string | null;
|
|
2765
|
+
} | {
|
|
2766
|
+
type: "checkpoint";
|
|
2767
|
+
checkpointId: string;
|
|
2768
|
+
};
|
|
2769
|
+
type SpaceBootstrapStatus = "pending" | "running" | "ready" | "failed";
|
|
2770
|
+
type SpaceBootstrapStage = "prepare" | "import" | "checkpoint_restore" | "finalize";
|
|
2771
|
+
type SpaceBootstrapMeta = {
|
|
2772
|
+
source: SpaceBootstrapSource;
|
|
2773
|
+
status: SpaceBootstrapStatus;
|
|
2774
|
+
stage: SpaceBootstrapStage | null;
|
|
2775
|
+
taskRunId: string | null;
|
|
2776
|
+
errorMessage: string | null;
|
|
2777
|
+
errorCode?: string | null;
|
|
2778
|
+
startedAt: string | null;
|
|
2779
|
+
finishedAt: string | null;
|
|
2780
|
+
stageTimings?: Record<string, number>;
|
|
2781
|
+
initialCheckpointTaskRunId?: string | null;
|
|
2782
|
+
};
|
|
2759
2783
|
type SpacePublicProfile = {
|
|
2760
2784
|
avatarUrl: string | null;
|
|
2761
2785
|
};
|
|
2762
2786
|
type SpaceMeta = JsonObject & {
|
|
2763
2787
|
config?: SpaceConfig;
|
|
2764
2788
|
extraEnv?: SpaceEnvInput[];
|
|
2789
|
+
bootstrap?: SpaceBootstrapMeta;
|
|
2765
2790
|
publicProfile?: Partial<SpacePublicProfile> | null;
|
|
2766
2791
|
};
|
|
2767
2792
|
type SpaceRecord = {
|
|
@@ -2792,16 +2817,6 @@ type SpaceRecord = {
|
|
|
2792
2817
|
/** Whether the viewer has pinned this space (only present in list responses). */
|
|
2793
2818
|
isPinned?: boolean;
|
|
2794
2819
|
};
|
|
2795
|
-
type SpaceBootstrapSource = {
|
|
2796
|
-
type: "blank";
|
|
2797
|
-
} | {
|
|
2798
|
-
type: "git_repo";
|
|
2799
|
-
repoUrl?: string;
|
|
2800
|
-
ref?: string | null;
|
|
2801
|
-
} | {
|
|
2802
|
-
type: "checkpoint";
|
|
2803
|
-
checkpointId: string;
|
|
2804
|
-
};
|
|
2805
2820
|
type SpaceConfigInput = {
|
|
2806
2821
|
sandbox?: {
|
|
2807
2822
|
provider?: SpaceSandboxProvider;
|
|
@@ -2816,7 +2831,7 @@ type CreateSpaceModInput = {
|
|
|
2816
2831
|
enabled?: boolean;
|
|
2817
2832
|
};
|
|
2818
2833
|
type CreateSpaceInput = {
|
|
2819
|
-
name
|
|
2834
|
+
name: string;
|
|
2820
2835
|
slug?: string | null;
|
|
2821
2836
|
description?: string | null;
|
|
2822
2837
|
source?: string;
|
|
@@ -3342,40 +3357,6 @@ type SpaceModListItem = {
|
|
|
3342
3357
|
modSpaceName: string | null;
|
|
3343
3358
|
modSpaceDescription: string | null;
|
|
3344
3359
|
};
|
|
3345
|
-
/**
|
|
3346
|
-
* Public-safe DTO for Explore spaces.
|
|
3347
|
-
* Only contains fields safe for unauthenticated product rendering.
|
|
3348
|
-
*/
|
|
3349
|
-
type ExploreSpaceItem = {
|
|
3350
|
-
id: string;
|
|
3351
|
-
slug: string | null;
|
|
3352
|
-
title: string;
|
|
3353
|
-
summary: string | null;
|
|
3354
|
-
spaceUrl: string;
|
|
3355
|
-
avatarUrl: string | null;
|
|
3356
|
-
avatarAlt: string | null;
|
|
3357
|
-
ownerDisplayName: string | null;
|
|
3358
|
-
ownerAvatarUrl: string | null;
|
|
3359
|
-
ownerUsername: string | null;
|
|
3360
|
-
category: string | null;
|
|
3361
|
-
tags: string[];
|
|
3362
|
-
saveCount: number;
|
|
3363
|
-
forkCount: number;
|
|
3364
|
-
updatedAt: string | null;
|
|
3365
|
-
accessLabel: "public" | "sign-in-required" | "unknown";
|
|
3366
|
-
latestSaveLabel: string | null;
|
|
3367
|
-
};
|
|
3368
|
-
type ExploreSection = {
|
|
3369
|
-
key: string;
|
|
3370
|
-
title: string | null;
|
|
3371
|
-
subtitle: string | null;
|
|
3372
|
-
description: string | null;
|
|
3373
|
-
spaces: ExploreSpaceItem[];
|
|
3374
|
-
};
|
|
3375
|
-
type ExploreSpacesResponse = {
|
|
3376
|
-
sections: ExploreSection[];
|
|
3377
|
-
spaces: ExploreSpaceItem[];
|
|
3378
|
-
};
|
|
3379
3360
|
type Permission = "space.view" | "space.edit" | "space.label.view" | "space.label.manage" | "space.label.assign" | "session.view" | "session.edit" | "session.prompt.readonly" | "session.prompt.fullaccess" | "generation.create" | "file.view" | "file.view.filtered" | "file.edit" | "checkpoint.view" | "checkpoint.edit" | "member.view" | "member.manage" | "references.view" | "channel.view" | "channel.manage" | "cronjob.view" | "cronjob.manage" | "taskrun.view" | "sandbox.view" | "sandbox.manage" | "mod.view" | "mod.manage" | "user.space.list" | "user.session.list" | "user.usage.read";
|
|
3380
3361
|
type SpaceAccess = {
|
|
3381
3362
|
role: SpaceRole | null;
|
|
@@ -3758,4 +3739,4 @@ declare class WebsocketClient {
|
|
|
3758
3739
|
}
|
|
3759
3740
|
declare const createWebsocketClient: (options?: WebsocketClientOptions) => WebsocketClient;
|
|
3760
3741
|
//#endregion
|
|
3761
|
-
export { CreateSpacePromptInput as $, BoardRenderCost as $i, SpaceFsTreeResponse as $n, findGenerationModelPolicy as $r,
|
|
3742
|
+
export { CreateSpacePromptInput as $, BoardRenderCost as $i, SpaceFsTreeResponse as $n, findGenerationModelPolicy as $r, SandboxSpecId as $t, BillingProductDisplay as A, readRequestSourceFromEnv as Aa, BoardCapabilities as Ai, SpaceCommerceProductCreditBenefit as An, SpaceUsageResponse as Ar, Permission as At, CheckpointDiffFile as B, BoardNodeRecord as Bi, SpaceFsCreateDirectoryInput as Bn, ChannelHealth as Br, ReferenceAggregateGroupBy as Bt, BillingCreditStatus as C, RequestSourceVia as Ca, BoardAwarenessUpdate as Ci, SpaceCommerceBenefit as Cn, SpaceSandboxConfig as Cr, LabelResourceType as Ct, BillingPluginStatus as D, mergeRequestSourceIntoMeta as Da, WorkContentKind as Di, SpaceCommerceOrder as Dn, SpaceTurnListItem as Dr, ModelCatalogEntry as Dt, BillingPaymentStatus as E, isRequestSourceUuid as Ea, WorkBoardAsset as Ei, SpaceCommerceFeatureBenefit as En, SpaceTurnAuthorFilter as Er, MeResponse as Et, BillingSubscriptionHistoryList as F, BoardEffect as Fi, SpaceCreateResponse as Fn, UserRulesResponse as Fr, PublicUserPageResponse as Ft, CheckpointDiffStatus as G, BoardPlaybackSnapshot as Gi, SpaceFsEntry as Gn, GenerationModelPolicy as Gr, ReferenceQueryableType as Gt, CheckpointDiffPatchKind as H, BoardPlaybackCommand as Hi, SpaceFsCreateUploadResponse as Hn, ChannelRuntimeState as Hr, ReferenceDirection as Ht, BillingSubscriptionHistoryStatus as I, BoardInspectInput as Ii, SpaceDefaultResponse as In, UserSessionListItem as Ir, PublicUserProfile as It, ClaimReferralResponse as J, BoardTarget as Ji, SpaceFsMoveInput as Jn, GenerationPolicyError as Jr, ReferralDashboard as Jt, CheckpointDiffSummary as K, BoardRecord as Ki, SpaceFsFileKind as Kn, GenerationParameterConstraint as Kr, ReferenceRecord as Kt, BillingSubscriptionSummary as L, BoardKeyframe as Li, SpaceEnvInput as Ln, UserSessionSpaceSummary as Lr, PublicUserSpaceItem as Lt, BillingProductPricing as M, resolveRequestSourceChannel as Ma, BoardCreateInput as Mi, SpaceConfigInput as Mn, TaskRunDetailResponse as Mr, PromptTemplateCatalogEntry as Mt, BillingRedemptionResult as N, BoardDeleteReason as Ni, SpaceConfigResponse as Nn, TaskRunRecord as Nr, PromptTemplateCatalogResponse as Nt, BillingProductBillingInterval as O, normalizeRequestSource as Oa, BoardAssetRef as Oi, SpaceCommerceProduct as On, SpaceTurnsResponse as Or, PatchResourceLabelsInput as Ot, BillingResponsePayload as P, BoardDiagnostic as Pi, SpaceConfigUpdateResponse as Pn, UserProfile as Pr, PublicReferral as Pt, CreateSpaceModInput as Q, BoardCapability as Qi, SpaceFsReadFilesResponse as Qn, filterGenerationDeclarationsByPolicy as Qr, ResourceLabelsResponse as Qt, Channel as R, BoardManifest as Ri, SpaceFsCompleteUploadInput as Rn, UserSessionsResponse as Rr, PublicUserWorkItem as Rt, BillingCreditGrantStatus as S, RequestSource as Sa, BoardAwarenessStateUpdate as Si, SpaceCheckpointDetailResponse as Sn, SpaceSandboxAutoDestroyPolicy as Sr, LabelRecord as St, BillingHistoryPagination as T, isRequestSourceEmpty as Ta, WorkBoardArtifactManifest as Ti, SpaceCommerceCreditsBenefit as Tn, SpaceSessionsResponse as Tr, LabelSource as Tt, CheckpointDiffPatchLine as U, BoardPlaybackPolicy as Ui, SpaceFsDeleteNodeInput as Un, DiscordChannelConfig as Ur, ReferenceKind as Ut, CheckpointDiffFileResponse as V, BoardOperation as Vi, SpaceFsCreateUploadInput as Vn, ChannelHealthReasonCode as Vr, ReferenceAggregateResponse as Vt, CheckpointDiffStats as W, BoardPlaybackPolicySchema as Wi, SpaceFsEncoding as Wn, FeishuChannelConfig as Wr, ReferenceQueryResponse as Wt, CreateInvitationResponse as X, BoardValidationResult as Xi, SpaceFsReadFilesError as Xn, decodeGenerationPolicy as Xr, ReferralReward as Xt, CreateInvitationInput as Y, BoardTransaction as Yi, SpaceFsPreparingFile as Yn, assertGenerationRequestAllowedByPolicy as Yr, ReferralListItem as Yt, CreateSpaceInput as Z, parseBoardPlaybackPolicy as Zi, SpaceFsReadFilesInput as Zn, encodeGenerationPolicy as Zr, ReferralStatus as Zt, BillingCatalogProduct as _, BillingPayload as _a, RealtimeWorkVersionRecord as _i, SpaceBootstrapMeta as _n, SpacePresenceSnapshot as _r, LabelAssignmentPageInfo as _t, WebsocketClientOptions as a, SessionTurnRecord as aa, GenerationResult as ai, SessionRecord as an, SpaceFsUploadProgress as ar, CursorPageInfo as at, BillingConversionIntent as b, COHUB_SOURCE_HEADER_NAMES as ba, BoardAwarenessGesture as bi, SpaceBootstrapStatus as bn, SpaceRecord as br, LabelItemsSessionFork as bt, createWebsocketClient as c, CompletionMessage as ca, BoardTransactionAppliedEvent as ci, SessionTurnSignedUrlsResponse as cn, SpaceInvitation as cr, GenerationUsageSummary as ct, BatchUserProfilesResponse as d, CompletionUsage as da, RealtimePatchOperation as di, SessionTurnsPaginatedResponse as dn, SpaceListItem as dr, GlobalSearchType as dt, SpacePublicEndpoints as ea, getAllowedGenerationModelIds as ei, SendMessageCronJobPayload as en, SpaceFsUploadDestination as er, CreateSpacePromptResponse as et, BillingBalanceActivity as f, CreateSpaceCompletionInput as fa, RealtimeRoomDescriptor as fi, SkillCatalogEntry as fn, SpaceMember as fr, InvitationDetail as ft, BillingCatalog as g, Usage as ga, RealtimeWorkRecord as gi, SpaceAccessPolicy as gn, SpacePendingDiffSummary as gr, LabelAssignmentListItem as gt, BillingBalanceActivityStatus as h, SpaceCompletionStreamEvent as ha, RealtimeServerEvent as hi, SpaceAccess as hn, SpacePendingDiffFileResponse as hr, JsonValue as ht, WebsocketClientEvents as i, SessionTurnIndexItem as ia, GenerationModelDeclaration as ii, SessionMessagesResponse as in, SpaceFsUploadPlanEntryInput as ir, CronJobUpdatePatch as it, BillingProductKind as j, requestSourceToHeaders as ja, BoardClip as ji, SpaceConfig as jn, SpaceUsageSummary as jr, PromptAccessMode as jt, BillingProductCreditBenefit as k, parseRequestSourceFromHeaders as ka, BoardBootstrap as ki, SpaceCommerceProductBenefitBinding as kn, SpaceUsageHourlyStat as kr, PatchResourceLabelsResponse as kt, AcceptInvitationResponse as l, CompletionMessageRole as la, ChannelEnvelope as li, SessionTurnStreamSnapshotResponse as ln, SpaceInvitationListResponse as lr, GlobalSearchResponse as lt, BillingBalanceActivityList as m, SpaceCompletionResult as ma, RealtimeRoomMember as mi, SkillCatalogSource as mn, SpaceModListItem as mr, JsonPrimitive as mt, WebSocketLike as n, SessionForkRecord as na, parseGenerationPolicyFromEnv as ni, SessionMessageResponse as nn, SpaceFsUploadError as nr, CronJobPayload as nt, WebsocketClientState as o, SpaceTurnsResponse$1 as oa, BoardAwarenessUpdatedEvent as oi, SessionTurnIndexResponse as on, SpaceFsUploadResponse as or, GenerationUsageBlock as ot, BillingBalanceActivityKind as p, ModelThinkingLevel as pa, RealtimeRoomEvent as pi, SkillCatalogResponse as pn, SpaceMeta as pr, JsonObject as pt, CheckpointRecord as q, BoardSequence as qi, SpaceFsFileResponse as qn, GenerationPolicy as qr, ReferenceResourceType as qt, WebsocketClient as r, SessionTurnSegmentRecord as ra, GenerationContentBlock as ri, SessionMessagesPaginatedResponse as rn, SpaceFsUploadPlanEntry as rr, CronJobRecord as rt, WebsocketEventPayload as s, CompletionAssistantMessage as sa, BoardPlaybackChangedEvent as si, SessionTurnResponse as sn, SpaceFsWriteFileInput as sr, GenerationUsageHourlyStat as st, WebSocketConstructor as t, MessageRecord as ta, normalizeGenerationPolicy as ti, SessionBindingRecord as tn, SpaceFsUploadEntry as tr, CreateSpaceSessionInput as tt, ApiError as u, CompletionThinkingLevel as ua, LabelAssignmentsUpdatedEvent as ui, SessionTurnWindowResponse as un, SpaceInvitationLocation as ur, GlobalSearchResult as ut, BillingCheckoutActionState as v, ContentBlock as va, SessionTurnPatchEvent as vi, SpaceBootstrapSource as vn, SpacePresenceUser as vr, LabelAssignmentRecord as vt, BillingCreditUnit as w, hasRequestSourceIdentity as wa, WorkArtifactDescriptor as wi, SpaceCommerceBuyerProfile as wn, SpaceSandboxProvider as wr, LabelScopeType as wt, BillingCreditExpiryGroup as x, REQUEST_SOURCE_VIA_MAX_LENGTH as xa, BoardAwarenessNodePreview as xi, SpaceChannelBindingInput as xn, SpaceRole as xr, LabelListItem as xt, BillingCheckoutResult as y, COHUB_SOURCE_HEADER as ya, WorkVersionPublishedEvent as yi, SpaceBootstrapStage as yn, SpacePublicProfile as yr, LabelItemsResponse as yt, CheckpointDiffDelivery as z, BoardNodeInput as zi, SpaceFsCompleteUploadResponse as zn, ChannelConfig as zr, ReferenceAggregateGroup as zt };
|
package/dist/http.d.ts
CHANGED
|
@@ -1,3 +1,3 @@
|
|
|
1
|
-
import { $ as CreateSpacePromptInput, $i as BoardRenderCost, $n as SpaceFsTreeResponse, $t as
|
|
1
|
+
import { $ as CreateSpacePromptInput, $i as BoardRenderCost, $n as SpaceFsTreeResponse, $t as SandboxSpecId, A as BillingProductDisplay, Ai as BoardCapabilities, An as SpaceCommerceProductCreditBenefit, Ar as SpaceUsageResponse, At as Permission, B as CheckpointDiffFile, Bi as BoardNodeRecord, Bn as SpaceFsCreateDirectoryInput, Br as ChannelHealth, Bt as ReferenceAggregateGroupBy, C as BillingCreditStatus, Cn as SpaceCommerceBenefit, Cr as SpaceSandboxConfig, Ct as LabelResourceType, D as BillingPluginStatus, Dn as SpaceCommerceOrder, Dr as SpaceTurnListItem, Dt as ModelCatalogEntry, E as BillingPaymentStatus, En as SpaceCommerceFeatureBenefit, Er as SpaceTurnAuthorFilter, Et as MeResponse, F as BillingSubscriptionHistoryList, Fi as BoardEffect, Fn as SpaceCreateResponse, Fr as UserRulesResponse, Ft as PublicUserPageResponse, G as CheckpointDiffStatus, Gi as BoardPlaybackSnapshot, Gn as SpaceFsEntry, Gt as ReferenceQueryableType, H as CheckpointDiffPatchKind, Hi as BoardPlaybackCommand, Hn as SpaceFsCreateUploadResponse, Hr as ChannelRuntimeState, Ht as ReferenceDirection, I as BillingSubscriptionHistoryStatus, Ii as BoardInspectInput, In as SpaceDefaultResponse, Ir as UserSessionListItem, It as PublicUserProfile, J as ClaimReferralResponse, Ji as BoardTarget, Jn as SpaceFsMoveInput, Jt as ReferralDashboard, K as CheckpointDiffSummary, Ki as BoardRecord, Kn as SpaceFsFileKind, Kt as ReferenceRecord, L as BillingSubscriptionSummary, Li as BoardKeyframe, Ln as SpaceEnvInput, Lr as UserSessionSpaceSummary, Lt as PublicUserSpaceItem, M as BillingProductPricing, Mi as BoardCreateInput, Mn as SpaceConfigInput, Mr as TaskRunDetailResponse, Mt as PromptTemplateCatalogEntry, N as BillingRedemptionResult, Ni as BoardDeleteReason, Nn as SpaceConfigResponse, Nr as TaskRunRecord, Nt as PromptTemplateCatalogResponse, O as BillingProductBillingInterval, Oi as BoardAssetRef, On as SpaceCommerceProduct, Or as SpaceTurnsResponse, Ot as PatchResourceLabelsInput, P as BillingResponsePayload, Pi as BoardDiagnostic, Pn as SpaceConfigUpdateResponse, Pr as UserProfile, Pt as PublicReferral, Q as CreateSpaceModInput, Qi as BoardCapability, Qn as SpaceFsReadFilesResponse, Qt as ResourceLabelsResponse, R as Channel, Ri as BoardManifest, Rn as SpaceFsCompleteUploadInput, Rr as UserSessionsResponse, Rt as PublicUserWorkItem, S as BillingCreditGrantStatus, Sn as SpaceCheckpointDetailResponse, Sr as SpaceSandboxAutoDestroyPolicy, St as LabelRecord, T as BillingHistoryPagination, Tn as SpaceCommerceCreditsBenefit, Tr as SpaceSessionsResponse, Tt as LabelSource, U as CheckpointDiffPatchLine, Ui as BoardPlaybackPolicy, Un as SpaceFsDeleteNodeInput, Ur as DiscordChannelConfig, Ut as ReferenceKind, V as CheckpointDiffFileResponse, Vi as BoardOperation, Vn as SpaceFsCreateUploadInput, Vr as ChannelHealthReasonCode, Vt as ReferenceAggregateResponse, W as CheckpointDiffStats, Wn as SpaceFsEncoding, Wr as FeishuChannelConfig, Wt as ReferenceQueryResponse, X as CreateInvitationResponse, Xi as BoardValidationResult, Xn as SpaceFsReadFilesError, Xt as ReferralReward, Y as CreateInvitationInput, Yi as BoardTransaction, Yn as SpaceFsPreparingFile, Yt as ReferralListItem, Z as CreateSpaceInput, Zn as SpaceFsReadFilesInput, Zt as ReferralStatus, _ as BillingCatalogProduct, _n as SpaceBootstrapMeta, _r as SpacePresenceSnapshot, _t as LabelAssignmentPageInfo, aa as SessionTurnRecord, ai as GenerationResult, an as SessionRecord, ar as SpaceFsUploadProgress, at as CursorPageInfo, b as BillingConversionIntent, bn as SpaceBootstrapStatus, br as SpaceRecord, bt as LabelItemsSessionFork, ca as CompletionMessage, cn as SessionTurnSignedUrlsResponse, cr as SpaceInvitation, ct as GenerationUsageSummary, d as BatchUserProfilesResponse, da as CompletionUsage, dn as SessionTurnsPaginatedResponse, dr as SpaceListItem, dt as GlobalSearchType, en as SendMessageCronJobPayload, er as SpaceFsUploadDestination, et as CreateSpacePromptResponse, f as BillingBalanceActivity, fa as CreateSpaceCompletionInput, fn as SkillCatalogEntry, fr as SpaceMember, ft as InvitationDetail, g as BillingCatalog, gn as SpaceAccessPolicy, gr as SpacePendingDiffSummary, gt as LabelAssignmentListItem, h as BillingBalanceActivityStatus, ha as SpaceCompletionStreamEvent, hn as SpaceAccess, hr as SpacePendingDiffFileResponse, ht as JsonValue, ia as SessionTurnIndexItem, in as SessionMessagesResponse, ir as SpaceFsUploadPlanEntryInput, it as CronJobUpdatePatch, j as BillingProductKind, ji as BoardClip, jn as SpaceConfig, jr as SpaceUsageSummary, jt as PromptAccessMode, k as BillingProductCreditBenefit, ki as BoardBootstrap, kn as SpaceCommerceProductBenefitBinding, kr as SpaceUsageHourlyStat, kt as PatchResourceLabelsResponse, l as AcceptInvitationResponse, la as CompletionMessageRole, ln as SessionTurnStreamSnapshotResponse, lr as SpaceInvitationListResponse, lt as GlobalSearchResponse, m as BillingBalanceActivityList, ma as SpaceCompletionResult, mn as SkillCatalogSource, mr as SpaceModListItem, mt as JsonPrimitive, na as SessionForkRecord, nn as SessionMessageResponse, nr as SpaceFsUploadError, nt as CronJobPayload, on as SessionTurnIndexResponse, or as SpaceFsUploadResponse, ot as GenerationUsageBlock, p as BillingBalanceActivityKind, pa as ModelThinkingLevel, pn as SkillCatalogResponse, pr as SpaceMeta, pt as JsonObject, q as CheckpointRecord, qi as BoardSequence, qn as SpaceFsFileResponse, qr as GenerationPolicy, qt as ReferenceResourceType, ra as SessionTurnSegmentRecord, ri as GenerationContentBlock, rn as SessionMessagesPaginatedResponse, rr as SpaceFsUploadPlanEntry, rt as CronJobRecord, sa as CompletionAssistantMessage, sn as SessionTurnResponse, sr as SpaceFsWriteFileInput, st as GenerationUsageHourlyStat, ta as MessageRecord, tn as SessionBindingRecord, tr as SpaceFsUploadEntry, tt as CreateSpaceSessionInput, u as ApiError, ua as CompletionThinkingLevel, un as SessionTurnWindowResponse, ur as SpaceInvitationLocation, ut as GlobalSearchResult, v as BillingCheckoutActionState, va as ContentBlock, vn as SpaceBootstrapSource, vr as SpacePresenceUser, vt as LabelAssignmentRecord, w as BillingCreditUnit, wn as SpaceCommerceBuyerProfile, wr as SpaceSandboxProvider, wt as LabelScopeType, x as BillingCreditExpiryGroup, xn as SpaceChannelBindingInput, xr as SpaceRole, xt as LabelListItem, y as BillingCheckoutResult, yn as SpaceBootstrapStage, yr as SpacePublicProfile, yt as LabelItemsResponse, z as CheckpointDiffDelivery, zi as BoardNodeInput, zn as SpaceFsCompleteUploadResponse, zr as ChannelConfig, zt as ReferenceAggregateGroup } from "./chunks/websocket.js";
|
|
2
2
|
import { Gt as HttpError, Kt as HttpTransport, Ut as CohubClientOptions, Wt as Fetch, _n as ModelStatusResponse, dn as CreateGenerationTaskResponse, fn as GenerationTaskResult, gn as ModelStatusEntry, hn as PublicGenerationDeclaration, ln as SpaceStartupResponse, mn as ListGenerationModelsResponse, n as createHttpClient, pn as GenerationUsageBilling, t as CohubHttpClient, un as CreateGenerationTaskRequest } from "./chunks/http.js";
|
|
3
|
-
export { AcceptInvitationResponse, ApiError, BatchUserProfilesResponse, BillingBalanceActivity, BillingBalanceActivityKind, BillingBalanceActivityList, BillingBalanceActivityStatus, BillingCatalog, BillingCatalogProduct, BillingCheckoutActionState, BillingCheckoutResult, BillingConversionIntent, BillingCreditExpiryGroup, BillingCreditGrantStatus, BillingCreditStatus, BillingCreditUnit, BillingHistoryPagination, BillingPaymentStatus, BillingPluginStatus, BillingProductBillingInterval, BillingProductCreditBenefit, BillingProductDisplay, BillingProductKind, BillingProductPricing, BillingRedemptionResult, BillingResponsePayload, BillingSubscriptionHistoryList, BillingSubscriptionHistoryStatus, BillingSubscriptionSummary, type BoardAssetRef, type BoardBootstrap, type BoardCapabilities, type BoardCapability, type BoardClip, type BoardCreateInput, type BoardDeleteReason, type BoardDiagnostic, type BoardEffect, type BoardInspectInput, type BoardKeyframe, type BoardManifest, type BoardNodeInput, type BoardNodeRecord, type BoardOperation, type BoardPlaybackCommand, type BoardPlaybackPolicy, type BoardPlaybackSnapshot, type BoardRecord, type BoardRenderCost, type BoardSequence, type BoardTarget, type BoardTransaction, type BoardValidationResult, Channel, type ChannelConfig, type ChannelHealth, type ChannelHealthReasonCode, type ChannelRuntimeState, CheckpointDiffDelivery, CheckpointDiffFile, CheckpointDiffFileResponse, CheckpointDiffPatchKind, CheckpointDiffPatchLine, CheckpointDiffStats, CheckpointDiffStatus, CheckpointDiffSummary, CheckpointRecord, ClaimReferralResponse, type CohubClientOptions, CohubHttpClient, type CompletionAssistantMessage, type CompletionMessage, type CompletionMessageRole, type CompletionThinkingLevel, type CompletionUsage, type ContentBlock, type CreateGenerationTaskRequest, type CreateGenerationTaskResponse, CreateInvitationInput, CreateInvitationResponse, type CreateSpaceCompletionInput, CreateSpaceInput, CreateSpaceModInput, CreateSpacePromptInput, CreateSpacePromptResponse, CreateSpaceSessionInput, CronJobPayload, CronJobRecord, CronJobUpdatePatch, CursorPageInfo, type DiscordChannelConfig,
|
|
3
|
+
export { AcceptInvitationResponse, ApiError, BatchUserProfilesResponse, BillingBalanceActivity, BillingBalanceActivityKind, BillingBalanceActivityList, BillingBalanceActivityStatus, BillingCatalog, BillingCatalogProduct, BillingCheckoutActionState, BillingCheckoutResult, BillingConversionIntent, BillingCreditExpiryGroup, BillingCreditGrantStatus, BillingCreditStatus, BillingCreditUnit, BillingHistoryPagination, BillingPaymentStatus, BillingPluginStatus, BillingProductBillingInterval, BillingProductCreditBenefit, BillingProductDisplay, BillingProductKind, BillingProductPricing, BillingRedemptionResult, BillingResponsePayload, BillingSubscriptionHistoryList, BillingSubscriptionHistoryStatus, BillingSubscriptionSummary, type BoardAssetRef, type BoardBootstrap, type BoardCapabilities, type BoardCapability, type BoardClip, type BoardCreateInput, type BoardDeleteReason, type BoardDiagnostic, type BoardEffect, type BoardInspectInput, type BoardKeyframe, type BoardManifest, type BoardNodeInput, type BoardNodeRecord, type BoardOperation, type BoardPlaybackCommand, type BoardPlaybackPolicy, type BoardPlaybackSnapshot, type BoardRecord, type BoardRenderCost, type BoardSequence, type BoardTarget, type BoardTransaction, type BoardValidationResult, Channel, type ChannelConfig, type ChannelHealth, type ChannelHealthReasonCode, type ChannelRuntimeState, CheckpointDiffDelivery, CheckpointDiffFile, CheckpointDiffFileResponse, CheckpointDiffPatchKind, CheckpointDiffPatchLine, CheckpointDiffStats, CheckpointDiffStatus, CheckpointDiffSummary, CheckpointRecord, ClaimReferralResponse, type CohubClientOptions, CohubHttpClient, type CompletionAssistantMessage, type CompletionMessage, type CompletionMessageRole, type CompletionThinkingLevel, type CompletionUsage, type ContentBlock, type CreateGenerationTaskRequest, type CreateGenerationTaskResponse, CreateInvitationInput, CreateInvitationResponse, type CreateSpaceCompletionInput, CreateSpaceInput, CreateSpaceModInput, CreateSpacePromptInput, CreateSpacePromptResponse, CreateSpaceSessionInput, CronJobPayload, CronJobRecord, CronJobUpdatePatch, CursorPageInfo, type DiscordChannelConfig, type FeishuChannelConfig, type Fetch, type GenerationContentBlock, type GenerationPolicy, type GenerationResult, type GenerationTaskResult, type GenerationUsageBilling, GenerationUsageBlock, GenerationUsageHourlyStat, GenerationUsageSummary, GlobalSearchResponse, GlobalSearchResult, GlobalSearchType, HttpError, HttpTransport, InvitationDetail, JsonObject, JsonPrimitive, JsonValue, LabelAssignmentListItem, LabelAssignmentPageInfo, LabelAssignmentRecord, LabelItemsResponse, LabelItemsSessionFork, LabelListItem, LabelRecord, LabelResourceType, LabelScopeType, LabelSource, type ListGenerationModelsResponse, MeResponse, type MessageRecord, ModelCatalogEntry, type ModelStatusEntry, type ModelStatusResponse, type ModelThinkingLevel, PatchResourceLabelsInput, PatchResourceLabelsResponse, Permission, PromptAccessMode, PromptTemplateCatalogEntry, PromptTemplateCatalogResponse, type PublicGenerationDeclaration, PublicReferral, PublicUserPageResponse, PublicUserProfile, PublicUserSpaceItem, PublicUserWorkItem, ReferenceAggregateGroup, ReferenceAggregateGroupBy, ReferenceAggregateResponse, ReferenceDirection, ReferenceKind, ReferenceQueryResponse, ReferenceQueryableType, ReferenceRecord, ReferenceResourceType, ReferralDashboard, ReferralListItem, ReferralReward, ReferralStatus, ResourceLabelsResponse, SandboxSpecId, SendMessageCronJobPayload, SessionBindingRecord, type SessionForkRecord, SessionMessageResponse, SessionMessagesPaginatedResponse, SessionMessagesResponse, SessionRecord, type SessionTurnIndexItem, SessionTurnIndexResponse, type SessionTurnRecord, SessionTurnResponse, type SessionTurnSegmentRecord, SessionTurnSignedUrlsResponse, SessionTurnStreamSnapshotResponse, SessionTurnWindowResponse, SessionTurnsPaginatedResponse, SkillCatalogEntry, SkillCatalogResponse, SkillCatalogSource, SpaceAccess, SpaceAccessPolicy, SpaceBootstrapMeta, SpaceBootstrapSource, SpaceBootstrapStage, SpaceBootstrapStatus, SpaceChannelBindingInput, SpaceCheckpointDetailResponse, SpaceCommerceBenefit, SpaceCommerceBuyerProfile, SpaceCommerceCreditsBenefit, SpaceCommerceFeatureBenefit, SpaceCommerceOrder, SpaceCommerceProduct, SpaceCommerceProductBenefitBinding, SpaceCommerceProductCreditBenefit, type SpaceCompletionResult, type SpaceCompletionStreamEvent, SpaceConfig, SpaceConfigInput, SpaceConfigResponse, SpaceConfigUpdateResponse, SpaceCreateResponse, SpaceDefaultResponse, SpaceEnvInput, SpaceFsCompleteUploadInput, SpaceFsCompleteUploadResponse, SpaceFsCreateDirectoryInput, SpaceFsCreateUploadInput, SpaceFsCreateUploadResponse, SpaceFsDeleteNodeInput, SpaceFsEncoding, SpaceFsEntry, SpaceFsFileKind, SpaceFsFileResponse, SpaceFsMoveInput, SpaceFsPreparingFile, SpaceFsReadFilesError, SpaceFsReadFilesInput, SpaceFsReadFilesResponse, SpaceFsTreeResponse, SpaceFsUploadDestination, SpaceFsUploadEntry, SpaceFsUploadError, SpaceFsUploadPlanEntry, SpaceFsUploadPlanEntryInput, SpaceFsUploadProgress, SpaceFsUploadResponse, SpaceFsWriteFileInput, SpaceInvitation, SpaceInvitationListResponse, SpaceInvitationLocation, SpaceListItem, SpaceMember, SpaceMeta, SpaceModListItem, SpacePendingDiffFileResponse, SpacePendingDiffSummary, SpacePresenceSnapshot, SpacePresenceUser, SpacePublicProfile, SpaceRecord, SpaceRole, SpaceSandboxAutoDestroyPolicy, SpaceSandboxConfig, SpaceSandboxProvider, SpaceSessionsResponse, type SpaceStartupResponse, SpaceTurnAuthorFilter, SpaceTurnListItem, SpaceTurnsResponse, SpaceUsageHourlyStat, SpaceUsageResponse, SpaceUsageSummary, TaskRunDetailResponse, TaskRunRecord, UserProfile, UserRulesResponse, UserSessionListItem, UserSessionSpaceSummary, UserSessionsResponse, createHttpClient };
|
package/dist/index.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { $ as CreateSpacePromptInput, $i as BoardRenderCost, $n as SpaceFsTreeResponse, $r as findGenerationModelPolicy, $t as
|
|
1
|
+
import { $ as CreateSpacePromptInput, $i as BoardRenderCost, $n as SpaceFsTreeResponse, $r as findGenerationModelPolicy, $t as SandboxSpecId, A as BillingProductDisplay, Aa as readRequestSourceFromEnv, Ai as BoardCapabilities, An as SpaceCommerceProductCreditBenefit, Ar as SpaceUsageResponse, At as Permission, B as CheckpointDiffFile, Bi as BoardNodeRecord, Bn as SpaceFsCreateDirectoryInput, Br as ChannelHealth, Bt as ReferenceAggregateGroupBy, C as BillingCreditStatus, Ca as RequestSourceVia, Ci as BoardAwarenessUpdate, Cn as SpaceCommerceBenefit, Cr as SpaceSandboxConfig, Ct as LabelResourceType, D as BillingPluginStatus, Da as mergeRequestSourceIntoMeta, Di as WorkContentKind, Dn as SpaceCommerceOrder, Dr as SpaceTurnListItem, Dt as ModelCatalogEntry, E as BillingPaymentStatus, Ea as isRequestSourceUuid, Ei as WorkBoardAsset, En as SpaceCommerceFeatureBenefit, Er as SpaceTurnAuthorFilter, Et as MeResponse, F as BillingSubscriptionHistoryList, Fi as BoardEffect, Fn as SpaceCreateResponse, Fr as UserRulesResponse, Ft as PublicUserPageResponse, G as CheckpointDiffStatus, Gi as BoardPlaybackSnapshot, Gn as SpaceFsEntry, Gr as GenerationModelPolicy, Gt as ReferenceQueryableType, H as CheckpointDiffPatchKind, Hi as BoardPlaybackCommand, Hn as SpaceFsCreateUploadResponse, Hr as ChannelRuntimeState, Ht as ReferenceDirection, I as BillingSubscriptionHistoryStatus, Ii as BoardInspectInput, In as SpaceDefaultResponse, Ir as UserSessionListItem, It as PublicUserProfile, J as ClaimReferralResponse, Ji as BoardTarget, Jn as SpaceFsMoveInput, Jr as GenerationPolicyError, Jt as ReferralDashboard, K as CheckpointDiffSummary, Ki as BoardRecord, Kn as SpaceFsFileKind, Kr as GenerationParameterConstraint, Kt as ReferenceRecord, L as BillingSubscriptionSummary, Li as BoardKeyframe, Ln as SpaceEnvInput, Lr as UserSessionSpaceSummary, Lt as PublicUserSpaceItem, M as BillingProductPricing, Ma as resolveRequestSourceChannel, Mi as BoardCreateInput, Mn as SpaceConfigInput, Mr as TaskRunDetailResponse, Mt as PromptTemplateCatalogEntry, N as BillingRedemptionResult, Ni as BoardDeleteReason, Nn as SpaceConfigResponse, Nr as TaskRunRecord, Nt as PromptTemplateCatalogResponse, O as BillingProductBillingInterval, Oa as normalizeRequestSource, Oi as BoardAssetRef, On as SpaceCommerceProduct, Or as SpaceTurnsResponse, Ot as PatchResourceLabelsInput, P as BillingResponsePayload, Pi as BoardDiagnostic, Pn as SpaceConfigUpdateResponse, Pr as UserProfile, Pt as PublicReferral, Q as CreateSpaceModInput, Qi as BoardCapability, Qn as SpaceFsReadFilesResponse, Qr as filterGenerationDeclarationsByPolicy, Qt as ResourceLabelsResponse, R as Channel, Ri as BoardManifest, Rn as SpaceFsCompleteUploadInput, Rr as UserSessionsResponse, Rt as PublicUserWorkItem, S as BillingCreditGrantStatus, Sa as RequestSource, Si as BoardAwarenessStateUpdate, Sn as SpaceCheckpointDetailResponse, Sr as SpaceSandboxAutoDestroyPolicy, St as LabelRecord, T as BillingHistoryPagination, Ta as isRequestSourceEmpty, Ti as WorkBoardArtifactManifest, Tn as SpaceCommerceCreditsBenefit, Tr as SpaceSessionsResponse, Tt as LabelSource, U as CheckpointDiffPatchLine, Ui as BoardPlaybackPolicy, Un as SpaceFsDeleteNodeInput, Ur as DiscordChannelConfig, Ut as ReferenceKind, V as CheckpointDiffFileResponse, Vi as BoardOperation, Vn as SpaceFsCreateUploadInput, Vr as ChannelHealthReasonCode, Vt as ReferenceAggregateResponse, W as CheckpointDiffStats, Wi as BoardPlaybackPolicySchema, Wn as SpaceFsEncoding, Wr as FeishuChannelConfig, Wt as ReferenceQueryResponse, X as CreateInvitationResponse, Xi as BoardValidationResult, Xn as SpaceFsReadFilesError, Xr as decodeGenerationPolicy, Xt as ReferralReward, Y as CreateInvitationInput, Yi as BoardTransaction, Yn as SpaceFsPreparingFile, Yr as assertGenerationRequestAllowedByPolicy, Yt as ReferralListItem, Z as CreateSpaceInput, Zi as parseBoardPlaybackPolicy, Zn as SpaceFsReadFilesInput, Zr as encodeGenerationPolicy, Zt as ReferralStatus, _ as BillingCatalogProduct, _i as RealtimeWorkVersionRecord, _n as SpaceBootstrapMeta, _r as SpacePresenceSnapshot, _t as LabelAssignmentPageInfo, aa as SessionTurnRecord, ai as GenerationResult, an as SessionRecord, ar as SpaceFsUploadProgress, at as CursorPageInfo, b as BillingConversionIntent, ba as COHUB_SOURCE_HEADER_NAMES, bi as BoardAwarenessGesture, bn as SpaceBootstrapStatus, br as SpaceRecord, bt as LabelItemsSessionFork, c as createWebsocketClient, ca as CompletionMessage, cn as SessionTurnSignedUrlsResponse, cr as SpaceInvitation, ct as GenerationUsageSummary, d as BatchUserProfilesResponse, da as CompletionUsage, dn as SessionTurnsPaginatedResponse, dr as SpaceListItem, dt as GlobalSearchType, ei as getAllowedGenerationModelIds, en as SendMessageCronJobPayload, er as SpaceFsUploadDestination, et as CreateSpacePromptResponse, f as BillingBalanceActivity, fa as CreateSpaceCompletionInput, fi as RealtimeRoomDescriptor, fn as SkillCatalogEntry, fr as SpaceMember, ft as InvitationDetail, g as BillingCatalog, gi as RealtimeWorkRecord, gn as SpaceAccessPolicy, gr as SpacePendingDiffSummary, gt as LabelAssignmentListItem, h as BillingBalanceActivityStatus, ha as SpaceCompletionStreamEvent, hi as RealtimeServerEvent, hn as SpaceAccess, hr as SpacePendingDiffFileResponse, ht as JsonValue, ia as SessionTurnIndexItem, ii as GenerationModelDeclaration, in as SessionMessagesResponse, ir as SpaceFsUploadPlanEntryInput, it as CronJobUpdatePatch, j as BillingProductKind, ja as requestSourceToHeaders, ji as BoardClip, jn as SpaceConfig, jr as SpaceUsageSummary, jt as PromptAccessMode, k as BillingProductCreditBenefit, ka as parseRequestSourceFromHeaders, ki as BoardBootstrap, kn as SpaceCommerceProductBenefitBinding, kr as SpaceUsageHourlyStat, kt as PatchResourceLabelsResponse, l as AcceptInvitationResponse, la as CompletionMessageRole, li as ChannelEnvelope, ln as SessionTurnStreamSnapshotResponse, lr as SpaceInvitationListResponse, lt as GlobalSearchResponse, m as BillingBalanceActivityList, ma as SpaceCompletionResult, mi as RealtimeRoomMember, mn as SkillCatalogSource, mr as SpaceModListItem, mt as JsonPrimitive, na as SessionForkRecord, ni as parseGenerationPolicyFromEnv, nn as SessionMessageResponse, nr as SpaceFsUploadError, nt as CronJobPayload, on as SessionTurnIndexResponse, or as SpaceFsUploadResponse, ot as GenerationUsageBlock, p as BillingBalanceActivityKind, pa as ModelThinkingLevel, pi as RealtimeRoomEvent, pn as SkillCatalogResponse, pr as SpaceMeta, pt as JsonObject, q as CheckpointRecord, qi as BoardSequence, qn as SpaceFsFileResponse, qr as GenerationPolicy, qt as ReferenceResourceType, r as WebsocketClient, ra as SessionTurnSegmentRecord, ri as GenerationContentBlock, rn as SessionMessagesPaginatedResponse, rr as SpaceFsUploadPlanEntry, rt as CronJobRecord, s as WebsocketEventPayload, sa as CompletionAssistantMessage, sn as SessionTurnResponse, sr as SpaceFsWriteFileInput, st as GenerationUsageHourlyStat, ta as MessageRecord, ti as normalizeGenerationPolicy, tn as SessionBindingRecord, tr as SpaceFsUploadEntry, tt as CreateSpaceSessionInput, u as ApiError, ua as CompletionThinkingLevel, ui as LabelAssignmentsUpdatedEvent, un as SessionTurnWindowResponse, ur as SpaceInvitationLocation, ut as GlobalSearchResult, v as BillingCheckoutActionState, va as ContentBlock, vn as SpaceBootstrapSource, vr as SpacePresenceUser, vt as LabelAssignmentRecord, w as BillingCreditUnit, wa as hasRequestSourceIdentity, wi as WorkArtifactDescriptor, wn as SpaceCommerceBuyerProfile, wr as SpaceSandboxProvider, wt as LabelScopeType, x as BillingCreditExpiryGroup, xa as REQUEST_SOURCE_VIA_MAX_LENGTH, xi as BoardAwarenessNodePreview, xn as SpaceChannelBindingInput, xr as SpaceRole, xt as LabelListItem, y as BillingCheckoutResult, ya as COHUB_SOURCE_HEADER, yi as WorkVersionPublishedEvent, yn as SpaceBootstrapStage, yr as SpacePublicProfile, yt as LabelItemsResponse, z as CheckpointDiffDelivery, zi as BoardNodeInput, zn as SpaceFsCompleteUploadResponse, zr as ChannelConfig, zt as ReferenceAggregateGroup } from "./chunks/websocket.js";
|
|
2
2
|
import { a as normalizeWebsocketUrl, c as resolveVoiceInputWebsocketUrl, i as normalizeVoiceInputWebsocketUrl, l as resolveWebsocketUrl, n as CohubEnvironment, o as resolveApiBaseUrl, r as normalizeBaseUrl, s as resolveCohubEnvironment, t as COHUB_ENVIRONMENTS } from "./chunks/environment.js";
|
|
3
3
|
import { $ as PublicInviteApi, $t as WorkRuntimeApi, A as WorksApi, At as PublicAssetPurpose, B as BoardTransactionAppliedEvent, Bt as GenerationsApi, C as WorkResolveResponse, Ct as SessionAccessApi, D as WorkUpdateInput, Dt as CreatePublicAssetUploadInput, E as WorkTargetType, Et as SearchApi, F as BoardAwarenessUpdatedEvent, Ft as UploadChatImageAttachmentInput, G as SpaceChannelBindingRecord, Gt as HttpError, H as BoardTransactionInput, Ht as ChannelsApi, I as BoardClient, It as UploadPublicAssetInput, J as SpaceTurnListOptions, Jt as joinApiUrl, K as SpaceClient, Kt as HttpTransport, L as BoardEventName, Lt as SkillsApi, M as UsersApi, Mt as PublicAssetUploadProtocol, N as UserApi, Nt as PublicAssetsApi, O as WorkVersionRecord, Ot as CreatePublicAssetUploadResponse, P as TasksApi, Pt as UploadChatAttachmentInput, Q as BuildSpacePathInput, Qt as WorkIdResolver, R as BoardPlaybackChangedEvent, Rt as PromptsApi, S as WorkRecord, St as createSessionPatchReducer, T as WorkStatus, Tt as ReferencesApi, U as SessionEventName, Ut as CohubClientOptions, V as BoardTransactionError, Vt as CronJobsApi, W as SessionSubscriptionHandlers, Wt as Fetch, X as WebSocketConnectionState, Xt as ParentBridgeTransport, Y as SpacesApi, Yt as sanitizeAccessToken, Z as BuildSpaceInvitePathInput, Zt as PopupBrokerTransport, _ as WorkGetResponse, _n as ModelStatusResponse, _t as SessionPatchApplyInput, a as WorkCommerceCreditConsumeResponse, an as WorkRuntimeTransport, at as GenerationStreamEvent, b as WorkPublicOwnerRecord, bt as SessionPatchState, c as WorkCommerceEntitlementsResponse, cn as resolveWorkTransport, ct as GenerationStreamLifecycleEvent, d as WorkCommercePurchaseResponse, dn as CreateGenerationTaskResponse, dt as GenerationStreamSubscribeOptions, en as WorkRuntimeCheckoutState, et as buildSpaceInvitePath, f as WorkAuthorizeResponse, fn as GenerationTaskResult, ft as GenerationStreamSubscriptionHandlers, g as WorkExtractedPageMeta, gn as ModelStatusEntry, gt as parseAssistantMessageCommit, h as WorkDetailResponse, hn as PublicGenerationDeclaration, ht as createSessionGenerationStreamClient, i as WorkCommerceCheckoutStatus, in as WorkRuntimeRequestOptions, it as GenerationStreamErrorEvent, j as ReferralsApi, jt as PublicAssetUploadProgress, k as WorkVisibility, kt as PublicAssetMimeType, l as WorkCommerceOrder, ln as SpaceStartupResponse, lt as GenerationStreamOutOfSyncEvent, m as WorkCreateInput, mn as ListGenerationModelsResponse, mt as SessionGenerationStreamClient, n as createHttpClient, nn as WorkRuntimeContext, nt as AssistantMessageCommit, o as WorkCommerceCreditConsumeStatus, on as createSlugWorkIdResolver, ot as GenerationStreamFinalizedEvent, p as WorkContent, pn as GenerationUsageBilling, pt as GenerationStreamTurnUpdatedEvent, q as SpaceEventName, qt as RawHttpResponse, r as WorkCommerceApi, rn as WorkRuntimeModeConfig, rt as GenerationStreamCommitEvent, s as WorkCommerceEntitlement, sn as createWorkRuntime, st as GenerationStreamIntermediateMessage, t as CohubHttpClient, tn as WorkRuntimeCheckoutStatus, tt as buildSpacePath, u as WorkCommerceProductResolveResponse, un as CreateGenerationTaskRequest, ut as GenerationStreamStateEvent, v as WorkMeta, vt as SessionPatchApplyResult, w as WorkSessionResponse, wt as ReferenceResourceSelector, x as WorkPublicSpaceRecord, xt as SessionPatchStatus, y as WorkPresentationMeta, yt as SessionPatchReducer, z as BoardSubscriptionHandlers, zt as ModelsApi } from "./chunks/http.js";
|
|
4
4
|
import { a as VoiceInputCreateOptions, i as VoiceInputClientOptions, l as createVoiceInputClient, n as VoiceInputCallbacks, o as VoiceInputEvent, r as VoiceInputClient, t as VoiceApi } from "./chunks/voice-input.js";
|
|
@@ -58,13 +58,6 @@ declare class BillingApi {
|
|
|
58
58
|
}>;
|
|
59
59
|
}
|
|
60
60
|
//#endregion
|
|
61
|
-
//#region src/apis/explore.d.ts
|
|
62
|
-
declare class ExploreApi {
|
|
63
|
-
private readonly transport;
|
|
64
|
-
constructor(transport: HttpTransport);
|
|
65
|
-
spaces(): Promise<ExploreSpacesResponse>;
|
|
66
|
-
}
|
|
67
|
-
//#endregion
|
|
68
61
|
//#region src/apis/work-realtime.d.ts
|
|
69
62
|
type WorkRoomEventMap = object;
|
|
70
63
|
type WorkRoomCreateInput = {
|
|
@@ -213,7 +206,6 @@ declare class CohubClient {
|
|
|
213
206
|
readonly references: ReferencesApi;
|
|
214
207
|
readonly tasks: TasksApi;
|
|
215
208
|
readonly cronJobs: CronJobsApi;
|
|
216
|
-
readonly explore: ExploreApi;
|
|
217
209
|
readonly invite: PublicInviteApi;
|
|
218
210
|
readonly referrals: ReferralsApi;
|
|
219
211
|
readonly voice: VoiceApi;
|
|
@@ -512,4 +504,4 @@ declare function createBoardExtensionRegistry(input?: {
|
|
|
512
504
|
builtins?: boolean;
|
|
513
505
|
}): BoardExtensionRegistry;
|
|
514
506
|
//#endregion
|
|
515
|
-
export { AcceptInvitationResponse, ApiError, type AssistantMessageCommit, BILLING_ACCESS_BLOCKED_ERROR_CODE, BatchUserProfilesResponse, BillingApi, BillingBalanceActivity, BillingBalanceActivityKind, BillingBalanceActivityList, BillingBalanceActivityStatus, BillingCatalog, BillingCatalogProduct, BillingCheckoutActionState, BillingCheckoutResult, BillingConversionIntent, BillingCreditExpiryGroup, BillingCreditGrantStatus, BillingCreditStatus, BillingCreditUnit, BillingHistoryPagination, BillingPaymentStatus, BillingPluginStatus, BillingProductBillingInterval, BillingProductCreditBenefit, BillingProductDisplay, BillingProductKind, BillingProductPricing, BillingRedemptionResult, BillingResponsePayload, BillingSubscriptionHistoryList, BillingSubscriptionHistoryStatus, BillingSubscriptionSummary, type BoardAssetRef, type BoardAwarenessGesture, type BoardAwarenessNodePreview, type BoardAwarenessStateUpdate, type BoardAwarenessUpdate, type BoardAwarenessUpdatedEvent, type BoardBootstrap, type BoardCapabilities, type BoardCapability, BoardClient, type BoardClip, type BoardCreateInput, type BoardDeleteReason, type BoardDiagnostic, type BoardEffect, type BoardEventName, BoardExtensionDefinition, BoardExtensionRegistry, type BoardInspectInput, type BoardKeyframe, type BoardManifest, type BoardNodeInput, type BoardNodeRecord, type BoardOperation, type BoardPlaybackChangedEvent, type BoardPlaybackCommand, type BoardPlaybackPolicy, BoardPlaybackPolicySchema, type BoardPlaybackSnapshot, BoardPresetDefinition, type BoardRecord, type BoardRenderCost, type BoardSequence, type BoardSubscriptionHandlers, type BoardTarget, type BoardTransaction, type BoardTransactionAppliedEvent, BoardTransactionError, type BoardTransactionInput, type BoardValidationResult, type BuildSpaceInvitePathInput, type BuildSpacePathInput, COHUB_ENVIRONMENTS, COHUB_SOURCE_HEADER, COHUB_SOURCE_HEADER_NAMES, Channel, type ChannelConfig, type ChannelEnvelope, type ChannelHealth, type ChannelHealthReasonCode, type ChannelRuntimeState, CheckpointDiffDelivery, CheckpointDiffFile, CheckpointDiffFileResponse, CheckpointDiffPatchKind, CheckpointDiffPatchLine, CheckpointDiffStats, CheckpointDiffStatus, CheckpointDiffSummary, CheckpointRecord, ClaimReferralResponse, CohubClient, type CohubClientOptions, type CohubEnvironment, CohubHttpClient, CompiledSequence, type CompletionAssistantMessage, type CompletionMessage, type CompletionMessageRole, type CompletionThinkingLevel, type CompletionUsage, type ContentBlock, type CreateGenerationTaskRequest, type CreateGenerationTaskResponse, CreateInvitationInput, CreateInvitationResponse, type CreatePublicAssetUploadInput, type CreatePublicAssetUploadResponse, type CreateSpaceCompletionInput, CreateSpaceInput, CreateSpaceModInput, CreateSpacePromptInput, CreateSpacePromptResponse, CreateSpaceSessionInput, CronJobPayload, CronJobRecord, CronJobUpdatePatch, CursorPageInfo, DEFAULT_BOARD_LIMITS, type DiscordChannelConfig, ExploreSection, ExploreSpaceItem, ExploreSpacesResponse, FEATURE_NOT_ENTITLED_ERROR_CODE, type FeishuChannelConfig, type Fetch, type GenerationContentBlock, type GenerationModelPolicy, type GenerationModelVisibility, type GenerationParameterConstraint, type GenerationPolicy, GenerationPolicyError, type GenerationResult, type GenerationStreamCommitEvent, type GenerationStreamErrorEvent, type GenerationStreamEvent, type GenerationStreamFinalizedEvent, type GenerationStreamIntermediateMessage, type GenerationStreamLifecycleEvent, type GenerationStreamOutOfSyncEvent, type GenerationStreamStateEvent, type GenerationStreamSubscribeOptions, type GenerationStreamSubscriptionHandlers, type GenerationStreamTurnUpdatedEvent, type GenerationTaskResult, type GenerationUsageBilling, GenerationUsageBlock, GenerationUsageHourlyStat, GenerationUsageSummary, GlobalSearchResponse, GlobalSearchResult, GlobalSearchType, HttpError, InvitationDetail, JsonObject, JsonPrimitive, JsonValue, LabelAssignmentListItem, LabelAssignmentPageInfo, LabelAssignmentRecord, type LabelAssignmentsUpdatedEvent, LabelItemsResponse, LabelItemsSessionFork, LabelListItem, LabelRecord, LabelResourceType, LabelScopeType, LabelSource, type ListGenerationModelsResponse, MeResponse, type MessageRecord, ModelCatalogEntry, type ModelStatusEntry, type ModelStatusResponse, type ModelThinkingLevel, ParentBridgeTransport, PatchResourceLabelsInput, PatchResourceLabelsResponse, Permission, PopupBrokerTransport, PromptAccessMode, PromptTemplateCatalogEntry, PromptTemplateCatalogResponse, type PublicAssetMimeType, type PublicAssetPurpose, type PublicAssetUploadProgress, type PublicAssetUploadProtocol, type PublicGenerationDeclaration, PublicReferral, PublicUserPageResponse, PublicUserProfile, PublicUserSpaceItem, PublicUserWorkItem, QualityProfile, REQUEST_SOURCE_VIA_MAX_LENGTH, type RawHttpResponse, type RealtimeRoomDescriptor, type RealtimeRoomEvent, type RealtimeRoomMember, type RealtimeServerEvent, type RealtimeWorkRecord, type RealtimeWorkVersionRecord, ReferenceAggregateGroup, ReferenceAggregateGroupBy, ReferenceAggregateResponse, ReferenceDirection, ReferenceKind, ReferenceQueryResponse, ReferenceQueryableType, ReferenceRecord, type ReferenceResourceSelector, ReferenceResourceType, ReferencesApi, ReferralDashboard, ReferralListItem, ReferralReward, ReferralStatus, ReferralsApi, RenderBounds, type RequestSource, type RequestSourceVia, ResourceLabelsResponse, SandboxSpecId, SendMessageCronJobPayload, SessionBindingRecord, type SessionEventName, type SessionForkRecord, SessionGenerationStreamClient, SessionMessageResponse, SessionMessagesPaginatedResponse, SessionMessagesResponse, type SessionPatchApplyInput, type SessionPatchApplyResult, SessionPatchReducer, type SessionPatchState, type SessionPatchStatus, SessionRecord, type SessionSubscriptionHandlers, type SessionTurnIndexItem, SessionTurnIndexResponse, type SessionTurnRecord, SessionTurnResponse, type SessionTurnSegmentRecord, SessionTurnSignedUrlsResponse, SessionTurnStreamSnapshotResponse, SessionTurnWindowResponse, SessionTurnsPaginatedResponse, SkillCatalogEntry, SkillCatalogResponse, SkillCatalogSource, SpaceAccess, SpaceAccessPolicy, SpaceBootstrapSource, SpaceChannelBindingInput, type SpaceChannelBindingRecord, SpaceCheckpointDetailResponse, SpaceCommerceBenefit, SpaceCommerceBuyerProfile, SpaceCommerceCreditsBenefit, SpaceCommerceFeatureBenefit, SpaceCommerceOrder, SpaceCommerceProduct, SpaceCommerceProductBenefitBinding, SpaceCommerceProductCreditBenefit, type SpaceCompletionResult, type SpaceCompletionStreamEvent, SpaceConfig, SpaceConfigInput, SpaceConfigResponse, SpaceConfigUpdateResponse, SpaceCreateResponse, SpaceDefaultResponse, SpaceEnvInput, type SpaceEventName, SpaceFsCompleteUploadInput, SpaceFsCompleteUploadResponse, SpaceFsCreateDirectoryInput, SpaceFsCreateUploadInput, SpaceFsCreateUploadResponse, SpaceFsDeleteNodeInput, SpaceFsEncoding, SpaceFsEntry, SpaceFsFileKind, SpaceFsFileResponse, SpaceFsMoveInput, SpaceFsPreparingFile, SpaceFsReadFilesError, SpaceFsReadFilesInput, SpaceFsReadFilesResponse, SpaceFsTreeResponse, SpaceFsUploadDestination, SpaceFsUploadEntry, SpaceFsUploadError, SpaceFsUploadPlanEntry, SpaceFsUploadPlanEntryInput, SpaceFsUploadProgress, SpaceFsUploadResponse, SpaceFsWriteFileInput, SpaceInvitation, SpaceInvitationListResponse, SpaceInvitationLocation, SpaceListItem, SpaceMember, SpaceMeta, SpaceModListItem, SpacePendingDiffFileResponse, SpacePendingDiffSummary, SpacePresenceSnapshot, SpacePresenceUser, SpacePublicProfile, SpaceRecord, SpaceRole, SpaceSandboxAutoDestroyPolicy, SpaceSandboxConfig, SpaceSandboxProvider, SpaceSessionsResponse, type SpaceStartupResponse, SpaceTurnAuthorFilter, SpaceTurnListItem, type SpaceTurnListOptions, SpaceTurnsResponse, SpaceUsageHourlyStat, SpaceUsageResponse, SpaceUsageSummary, TaskRunDetailResponse, TaskRunRecord, TimelineClipInput, TimelineInput, type UploadChatAttachmentInput, type UploadChatImageAttachmentInput, type UploadPublicAssetInput, UserProfile, UserRulesResponse, UserSessionListItem, UserSessionSpaceSummary, UserSessionsResponse, UsersApi, VoiceApi, type VoiceInputCallbacks, VoiceInputClient, type VoiceInputClientOptions, type VoiceInputCreateOptions, type VoiceInputEvent, type WebSocketConnectionState, WebsocketClient, type WorkArtifactDescriptor, type WorkAuthorizeRequest, type WorkAuthorizeResponse, type WorkBoardArtifactManifest, type WorkBoardAsset, type WorkBridgeCore, type WorkBridgeCoreConfig, type WorkBridgeCoreWork, type WorkBridgeDialogState, type WorkBridgeGetAccessToken, type WorkBridgeGetViewerUuid, type WorkBridgeRequestSignIn, WorkCommerceApi, type WorkCommerceCheckoutStatus, type WorkCommerceCreditConsumeResponse, type WorkCommerceCreditConsumeStatus, type WorkCommerceEntitlement, type WorkCommerceEntitlementsResponse, type WorkCommerceOrder, type WorkCommerceProductResolveResponse, type WorkCommercePurchaseResponse, type WorkContent, type WorkContentKind, type WorkCreateInput, type WorkDetailResponse, type WorkExtractedPageMeta, type WorkGetResponse, type WorkIdResolver, type WorkMeta, type WorkPresentationMeta, type WorkPublicOwnerRecord, type WorkPublicSpaceRecord, type WorkPurchaseRequest, WorkRealtimeApi, type WorkRecord, type WorkResolveResponse, WorkRoom, type WorkRoomAdmissionResponse, type WorkRoomCreateInput, type WorkRoomEvent, type WorkRoomEventMap, type WorkRoomPublishResult, type WorkRoomState, WorkRuntimeApi, type WorkRuntimeCheckoutState, type WorkRuntimeCheckoutStatus, type WorkRuntimeContext, type WorkRuntimeModeConfig, type WorkRuntimeRequestOptions, type WorkRuntimeTransport, type WorkSessionResponse, type WorkStatus, type WorkTargetType, type WorkUpdateInput, type WorkVersionPublishedEvent, type WorkVersionRecord, type WorkVisibility, WorksApi, assertGenerationRequestAllowedByPolicy, buildSpaceInvitePath, buildSpacePath, clearGrantedWorkScopes, clip, compileSequence, createBoardExtensionRegistry, createCohubClient, createHttpClient, createSessionGenerationStreamClient, createSessionPatchReducer, createSlugWorkIdResolver, createVoiceInputClient, createWebsocketClient, createWorkBridgeCore, createWorkRuntime, decodeGenerationPolicy, encodeGenerationPolicy, extractBillingPayload, filterDiscoverableGenerationModels, filterGenerationDeclarationsByPolicy, findGenerationModelPolicy, getAllowedGenerationModelIds, hasGrantedWorkScopes, hasRequestSourceIdentity, isBillingAccessBlockedCode, isBillingAccessBlockedError, isFeatureNotEntitledError, isGenerationModelHidden, isHttpErrorCode, isRequestSourceEmpty, isRequestSourceUuid, joinApiUrl, mergeRequestSourceIntoMeta, normalizeBaseUrl, normalizeGenerationPolicy, normalizeRequestSource, normalizeVoiceInputWebsocketUrl, normalizeWebsocketUrl, parseAssistantMessageCommit, parseBoardPlaybackPolicy, parseGenerationPolicyFromEnv, parseRequestSourceFromHeaders, readRequestSourceFromEnv, requestSourceToHeaders, resolveApiBaseUrl, resolveCohubEnvironment, resolveRequestSourceChannel, resolveVoiceInputWebsocketUrl, resolveWebsocketUrl, resolveWorkTransport, sanitizeAccessToken, setGrantedWorkScopes, timeline };
|
|
507
|
+
export { AcceptInvitationResponse, ApiError, type AssistantMessageCommit, BILLING_ACCESS_BLOCKED_ERROR_CODE, BatchUserProfilesResponse, BillingApi, BillingBalanceActivity, BillingBalanceActivityKind, BillingBalanceActivityList, BillingBalanceActivityStatus, BillingCatalog, BillingCatalogProduct, BillingCheckoutActionState, BillingCheckoutResult, BillingConversionIntent, BillingCreditExpiryGroup, BillingCreditGrantStatus, BillingCreditStatus, BillingCreditUnit, BillingHistoryPagination, BillingPaymentStatus, BillingPluginStatus, BillingProductBillingInterval, BillingProductCreditBenefit, BillingProductDisplay, BillingProductKind, BillingProductPricing, BillingRedemptionResult, BillingResponsePayload, BillingSubscriptionHistoryList, BillingSubscriptionHistoryStatus, BillingSubscriptionSummary, type BoardAssetRef, type BoardAwarenessGesture, type BoardAwarenessNodePreview, type BoardAwarenessStateUpdate, type BoardAwarenessUpdate, type BoardAwarenessUpdatedEvent, type BoardBootstrap, type BoardCapabilities, type BoardCapability, BoardClient, type BoardClip, type BoardCreateInput, type BoardDeleteReason, type BoardDiagnostic, type BoardEffect, type BoardEventName, BoardExtensionDefinition, BoardExtensionRegistry, type BoardInspectInput, type BoardKeyframe, type BoardManifest, type BoardNodeInput, type BoardNodeRecord, type BoardOperation, type BoardPlaybackChangedEvent, type BoardPlaybackCommand, type BoardPlaybackPolicy, BoardPlaybackPolicySchema, type BoardPlaybackSnapshot, BoardPresetDefinition, type BoardRecord, type BoardRenderCost, type BoardSequence, type BoardSubscriptionHandlers, type BoardTarget, type BoardTransaction, type BoardTransactionAppliedEvent, BoardTransactionError, type BoardTransactionInput, type BoardValidationResult, type BuildSpaceInvitePathInput, type BuildSpacePathInput, COHUB_ENVIRONMENTS, COHUB_SOURCE_HEADER, COHUB_SOURCE_HEADER_NAMES, Channel, type ChannelConfig, type ChannelEnvelope, type ChannelHealth, type ChannelHealthReasonCode, type ChannelRuntimeState, CheckpointDiffDelivery, CheckpointDiffFile, CheckpointDiffFileResponse, CheckpointDiffPatchKind, CheckpointDiffPatchLine, CheckpointDiffStats, CheckpointDiffStatus, CheckpointDiffSummary, CheckpointRecord, ClaimReferralResponse, CohubClient, type CohubClientOptions, type CohubEnvironment, CohubHttpClient, CompiledSequence, type CompletionAssistantMessage, type CompletionMessage, type CompletionMessageRole, type CompletionThinkingLevel, type CompletionUsage, type ContentBlock, type CreateGenerationTaskRequest, type CreateGenerationTaskResponse, CreateInvitationInput, CreateInvitationResponse, type CreatePublicAssetUploadInput, type CreatePublicAssetUploadResponse, type CreateSpaceCompletionInput, CreateSpaceInput, CreateSpaceModInput, CreateSpacePromptInput, CreateSpacePromptResponse, CreateSpaceSessionInput, CronJobPayload, CronJobRecord, CronJobUpdatePatch, CursorPageInfo, DEFAULT_BOARD_LIMITS, type DiscordChannelConfig, FEATURE_NOT_ENTITLED_ERROR_CODE, type FeishuChannelConfig, type Fetch, type GenerationContentBlock, type GenerationModelPolicy, type GenerationModelVisibility, type GenerationParameterConstraint, type GenerationPolicy, GenerationPolicyError, type GenerationResult, type GenerationStreamCommitEvent, type GenerationStreamErrorEvent, type GenerationStreamEvent, type GenerationStreamFinalizedEvent, type GenerationStreamIntermediateMessage, type GenerationStreamLifecycleEvent, type GenerationStreamOutOfSyncEvent, type GenerationStreamStateEvent, type GenerationStreamSubscribeOptions, type GenerationStreamSubscriptionHandlers, type GenerationStreamTurnUpdatedEvent, type GenerationTaskResult, type GenerationUsageBilling, GenerationUsageBlock, GenerationUsageHourlyStat, GenerationUsageSummary, GlobalSearchResponse, GlobalSearchResult, GlobalSearchType, HttpError, InvitationDetail, JsonObject, JsonPrimitive, JsonValue, LabelAssignmentListItem, LabelAssignmentPageInfo, LabelAssignmentRecord, type LabelAssignmentsUpdatedEvent, LabelItemsResponse, LabelItemsSessionFork, LabelListItem, LabelRecord, LabelResourceType, LabelScopeType, LabelSource, type ListGenerationModelsResponse, MeResponse, type MessageRecord, ModelCatalogEntry, type ModelStatusEntry, type ModelStatusResponse, type ModelThinkingLevel, ParentBridgeTransport, PatchResourceLabelsInput, PatchResourceLabelsResponse, Permission, PopupBrokerTransport, PromptAccessMode, PromptTemplateCatalogEntry, PromptTemplateCatalogResponse, type PublicAssetMimeType, type PublicAssetPurpose, type PublicAssetUploadProgress, type PublicAssetUploadProtocol, type PublicGenerationDeclaration, PublicReferral, PublicUserPageResponse, PublicUserProfile, PublicUserSpaceItem, PublicUserWorkItem, QualityProfile, REQUEST_SOURCE_VIA_MAX_LENGTH, type RawHttpResponse, type RealtimeRoomDescriptor, type RealtimeRoomEvent, type RealtimeRoomMember, type RealtimeServerEvent, type RealtimeWorkRecord, type RealtimeWorkVersionRecord, ReferenceAggregateGroup, ReferenceAggregateGroupBy, ReferenceAggregateResponse, ReferenceDirection, ReferenceKind, ReferenceQueryResponse, ReferenceQueryableType, ReferenceRecord, type ReferenceResourceSelector, ReferenceResourceType, ReferencesApi, ReferralDashboard, ReferralListItem, ReferralReward, ReferralStatus, ReferralsApi, RenderBounds, type RequestSource, type RequestSourceVia, ResourceLabelsResponse, SandboxSpecId, SendMessageCronJobPayload, SessionBindingRecord, type SessionEventName, type SessionForkRecord, SessionGenerationStreamClient, SessionMessageResponse, SessionMessagesPaginatedResponse, SessionMessagesResponse, type SessionPatchApplyInput, type SessionPatchApplyResult, SessionPatchReducer, type SessionPatchState, type SessionPatchStatus, SessionRecord, type SessionSubscriptionHandlers, type SessionTurnIndexItem, SessionTurnIndexResponse, type SessionTurnRecord, SessionTurnResponse, type SessionTurnSegmentRecord, SessionTurnSignedUrlsResponse, SessionTurnStreamSnapshotResponse, SessionTurnWindowResponse, SessionTurnsPaginatedResponse, SkillCatalogEntry, SkillCatalogResponse, SkillCatalogSource, SpaceAccess, SpaceAccessPolicy, SpaceBootstrapMeta, SpaceBootstrapSource, SpaceBootstrapStage, SpaceBootstrapStatus, SpaceChannelBindingInput, type SpaceChannelBindingRecord, SpaceCheckpointDetailResponse, SpaceCommerceBenefit, SpaceCommerceBuyerProfile, SpaceCommerceCreditsBenefit, SpaceCommerceFeatureBenefit, SpaceCommerceOrder, SpaceCommerceProduct, SpaceCommerceProductBenefitBinding, SpaceCommerceProductCreditBenefit, type SpaceCompletionResult, type SpaceCompletionStreamEvent, SpaceConfig, SpaceConfigInput, SpaceConfigResponse, SpaceConfigUpdateResponse, SpaceCreateResponse, SpaceDefaultResponse, SpaceEnvInput, type SpaceEventName, SpaceFsCompleteUploadInput, SpaceFsCompleteUploadResponse, SpaceFsCreateDirectoryInput, SpaceFsCreateUploadInput, SpaceFsCreateUploadResponse, SpaceFsDeleteNodeInput, SpaceFsEncoding, SpaceFsEntry, SpaceFsFileKind, SpaceFsFileResponse, SpaceFsMoveInput, SpaceFsPreparingFile, SpaceFsReadFilesError, SpaceFsReadFilesInput, SpaceFsReadFilesResponse, SpaceFsTreeResponse, SpaceFsUploadDestination, SpaceFsUploadEntry, SpaceFsUploadError, SpaceFsUploadPlanEntry, SpaceFsUploadPlanEntryInput, SpaceFsUploadProgress, SpaceFsUploadResponse, SpaceFsWriteFileInput, SpaceInvitation, SpaceInvitationListResponse, SpaceInvitationLocation, SpaceListItem, SpaceMember, SpaceMeta, SpaceModListItem, SpacePendingDiffFileResponse, SpacePendingDiffSummary, SpacePresenceSnapshot, SpacePresenceUser, SpacePublicProfile, SpaceRecord, SpaceRole, SpaceSandboxAutoDestroyPolicy, SpaceSandboxConfig, SpaceSandboxProvider, SpaceSessionsResponse, type SpaceStartupResponse, SpaceTurnAuthorFilter, SpaceTurnListItem, type SpaceTurnListOptions, SpaceTurnsResponse, SpaceUsageHourlyStat, SpaceUsageResponse, SpaceUsageSummary, TaskRunDetailResponse, TaskRunRecord, TimelineClipInput, TimelineInput, type UploadChatAttachmentInput, type UploadChatImageAttachmentInput, type UploadPublicAssetInput, UserProfile, UserRulesResponse, UserSessionListItem, UserSessionSpaceSummary, UserSessionsResponse, UsersApi, VoiceApi, type VoiceInputCallbacks, VoiceInputClient, type VoiceInputClientOptions, type VoiceInputCreateOptions, type VoiceInputEvent, type WebSocketConnectionState, WebsocketClient, type WorkArtifactDescriptor, type WorkAuthorizeRequest, type WorkAuthorizeResponse, type WorkBoardArtifactManifest, type WorkBoardAsset, type WorkBridgeCore, type WorkBridgeCoreConfig, type WorkBridgeCoreWork, type WorkBridgeDialogState, type WorkBridgeGetAccessToken, type WorkBridgeGetViewerUuid, type WorkBridgeRequestSignIn, WorkCommerceApi, type WorkCommerceCheckoutStatus, type WorkCommerceCreditConsumeResponse, type WorkCommerceCreditConsumeStatus, type WorkCommerceEntitlement, type WorkCommerceEntitlementsResponse, type WorkCommerceOrder, type WorkCommerceProductResolveResponse, type WorkCommercePurchaseResponse, type WorkContent, type WorkContentKind, type WorkCreateInput, type WorkDetailResponse, type WorkExtractedPageMeta, type WorkGetResponse, type WorkIdResolver, type WorkMeta, type WorkPresentationMeta, type WorkPublicOwnerRecord, type WorkPublicSpaceRecord, type WorkPurchaseRequest, WorkRealtimeApi, type WorkRecord, type WorkResolveResponse, WorkRoom, type WorkRoomAdmissionResponse, type WorkRoomCreateInput, type WorkRoomEvent, type WorkRoomEventMap, type WorkRoomPublishResult, type WorkRoomState, WorkRuntimeApi, type WorkRuntimeCheckoutState, type WorkRuntimeCheckoutStatus, type WorkRuntimeContext, type WorkRuntimeModeConfig, type WorkRuntimeRequestOptions, type WorkRuntimeTransport, type WorkSessionResponse, type WorkStatus, type WorkTargetType, type WorkUpdateInput, type WorkVersionPublishedEvent, type WorkVersionRecord, type WorkVisibility, WorksApi, assertGenerationRequestAllowedByPolicy, buildSpaceInvitePath, buildSpacePath, clearGrantedWorkScopes, clip, compileSequence, createBoardExtensionRegistry, createCohubClient, createHttpClient, createSessionGenerationStreamClient, createSessionPatchReducer, createSlugWorkIdResolver, createVoiceInputClient, createWebsocketClient, createWorkBridgeCore, createWorkRuntime, decodeGenerationPolicy, encodeGenerationPolicy, extractBillingPayload, filterDiscoverableGenerationModels, filterGenerationDeclarationsByPolicy, findGenerationModelPolicy, getAllowedGenerationModelIds, hasGrantedWorkScopes, hasRequestSourceIdentity, isBillingAccessBlockedCode, isBillingAccessBlockedError, isFeatureNotEntitledError, isGenerationModelHidden, isHttpErrorCode, isRequestSourceEmpty, isRequestSourceUuid, joinApiUrl, mergeRequestSourceIntoMeta, normalizeBaseUrl, normalizeGenerationPolicy, normalizeRequestSource, normalizeVoiceInputWebsocketUrl, normalizeWebsocketUrl, parseAssistantMessageCommit, parseBoardPlaybackPolicy, parseGenerationPolicyFromEnv, parseRequestSourceFromHeaders, readRequestSourceFromEnv, requestSourceToHeaders, resolveApiBaseUrl, resolveCohubEnvironment, resolveRequestSourceChannel, resolveVoiceInputWebsocketUrl, resolveWebsocketUrl, resolveWorkTransport, sanitizeAccessToken, setGrantedWorkScopes, timeline };
|
package/dist/index.js
CHANGED
|
@@ -70,17 +70,6 @@ var BillingApi = class {
|
|
|
70
70
|
}
|
|
71
71
|
};
|
|
72
72
|
//#endregion
|
|
73
|
-
//#region src/apis/explore.ts
|
|
74
|
-
var ExploreApi = class {
|
|
75
|
-
transport;
|
|
76
|
-
constructor(transport) {
|
|
77
|
-
this.transport = transport;
|
|
78
|
-
}
|
|
79
|
-
spaces() {
|
|
80
|
-
return this.transport.request("/api/explore/spaces");
|
|
81
|
-
}
|
|
82
|
-
};
|
|
83
|
-
//#endregion
|
|
84
73
|
//#region ../protocol/dist/board-constants.js
|
|
85
74
|
const DEFAULT_BOARD_RENDER_LIMITS = {
|
|
86
75
|
particles: 2e4,
|
|
@@ -1251,7 +1240,6 @@ var CohubClient = class {
|
|
|
1251
1240
|
references;
|
|
1252
1241
|
tasks;
|
|
1253
1242
|
cronJobs;
|
|
1254
|
-
explore;
|
|
1255
1243
|
invite;
|
|
1256
1244
|
referrals;
|
|
1257
1245
|
voice;
|
|
@@ -1308,7 +1296,6 @@ var CohubClient = class {
|
|
|
1308
1296
|
this.references = new ReferencesApi(this.transport);
|
|
1309
1297
|
this.tasks = new TasksApi(this.transport);
|
|
1310
1298
|
this.cronJobs = new CronJobsApi(this.transport);
|
|
1311
|
-
this.explore = new ExploreApi(this.transport);
|
|
1312
1299
|
this.invite = new PublicInviteApi(this.transport);
|
|
1313
1300
|
this.referrals = new ReferralsApi(this.transport);
|
|
1314
1301
|
this.works = new WorksApi(this.transport);
|
|
@@ -2,8 +2,8 @@
|
|
|
2
2
|
|
|
3
3
|
This guide explains how to use the Cohub SDK **inside a published Work** — the
|
|
4
4
|
only environment where runtime APIs (`context()`, `auth.request`,
|
|
5
|
-
`work.commerce.*`) function. Read this before writing any
|
|
6
|
-
capabilities from browser-side JavaScript.
|
|
5
|
+
`work.commerce.*`, `work.realtime.*`) function. Read this before writing any
|
|
6
|
+
Work that calls Cohub capabilities from browser-side JavaScript.
|
|
7
7
|
|
|
8
8
|
It is written to be self-contained: an agent or developer who reads only this
|
|
9
9
|
file plus the SDK type definitions should be able to build a working Work
|
|
@@ -24,6 +24,7 @@ without reverse-engineering source code.
|
|
|
24
24
|
- [File reads](#file-reads-spacefiles)
|
|
25
25
|
- [Account-level data](#account-level-data-spaceslist--userlistsessions--usergetusage)
|
|
26
26
|
- [Commerce](#commerce-workcommerce)
|
|
27
|
+
- [Realtime rooms](#realtime-rooms-workrealtime)
|
|
27
28
|
6. [Complete working example](#6-complete-working-example)
|
|
28
29
|
7. [Common pitfalls checklist](#7-common-pitfalls-checklist)
|
|
29
30
|
8. [Publishing a Work (API/SDK)](#8-publishing-a-work-apisdk)
|
|
@@ -55,18 +56,19 @@ requiring the viewer to paste an API key.
|
|
|
55
56
|
└─────────────────────────────────────────┘
|
|
56
57
|
```
|
|
57
58
|
|
|
58
|
-
|
|
59
|
+
Four runtime-only APIs form the foundation; everything else is standard SDK:
|
|
59
60
|
|
|
60
61
|
| API | What it does | Returns |
|
|
61
62
|
|---|---|---|
|
|
62
63
|
| `client.context()` | Asks the host for the Work's identity | `{ work, space, viewer?, permissions }` or `null` |
|
|
63
64
|
| `client.auth.request({ scopes, reason })` | Shows the viewer a consent dialog; on approval, caches a token carrying those scopes | `true` / `false` |
|
|
64
65
|
| `client.work.commerce.*` | Entitlement checks, credit consumption, purchases | (see Commerce section) |
|
|
66
|
+
| `client.work.realtime.*` | Temporary rooms, events, presence, and membership | (see Realtime rooms section) |
|
|
65
67
|
|
|
66
|
-
> **Runtime-only constraint.** These
|
|
68
|
+
> **Runtime-only constraint.** These APIs only work inside a **published**
|
|
67
69
|
> Work. Outside that context (a static asset URL, a local `file://` preview,
|
|
68
|
-
> a plain Node script) `context()` returns `null` and
|
|
69
|
-
>
|
|
70
|
+
> a plain Node script) `context()` returns `null` and the other runtime APIs
|
|
71
|
+
> fail. Always develop against a published Work.
|
|
70
72
|
|
|
71
73
|
---
|
|
72
74
|
|
|
@@ -220,6 +222,7 @@ result needs `taskrun.view` (a work scope).
|
|
|
220
222
|
| Commerce: entitlements | `client.work.commerce.getEntitlements()` | *(runtime only, no scope)* | — |
|
|
221
223
|
| Commerce: consume credits | `client.work.commerce.consumeCredits()` | *(runtime only, no scope)* | — |
|
|
222
224
|
| Commerce: purchase | `client.work.commerce.purchase()` | *(runtime only, no scope)* | — |
|
|
225
|
+
| Realtime rooms | `client.work.realtime.createRoom()` / `joinRoom()` | *(runtime only, no scope)* | — |
|
|
223
226
|
|
|
224
227
|
### Minimal scope sets for common Work types
|
|
225
228
|
|
|
@@ -268,11 +271,11 @@ Works are typically single HTML files with no bundler. Import the SDK from an
|
|
|
268
271
|
ESM CDN:
|
|
269
272
|
|
|
270
273
|
```js
|
|
271
|
-
import { createCohubClient } from "https://esm.sh/@neta-art/cohub@
|
|
274
|
+
import { createCohubClient } from "https://esm.sh/@neta-art/cohub@latest";
|
|
272
275
|
```
|
|
273
276
|
|
|
274
|
-
|
|
275
|
-
|
|
277
|
+
`@latest` keeps a Work on the current SDK release. Pin an exact version only
|
|
278
|
+
when a deployment needs reproducible dependency updates.
|
|
276
279
|
|
|
277
280
|
### Environment detection — critical
|
|
278
281
|
|
|
@@ -660,12 +663,120 @@ if (checkoutState.orderId) {
|
|
|
660
663
|
retries the call after a timeout, pass the same `purchaseAttemptId` to ensure
|
|
661
664
|
the retry resolves to the original Billing order.
|
|
662
665
|
|
|
666
|
+
### Realtime rooms (`work.realtime`)
|
|
667
|
+
|
|
668
|
+
**Scopes:** none — uses the published Work's runtime identity without an
|
|
669
|
+
additional consent dialog. The CLI and ordinary server auth cannot create or
|
|
670
|
+
join these rooms.
|
|
671
|
+
|
|
672
|
+
```js
|
|
673
|
+
const room = await client.work.realtime.createRoom({
|
|
674
|
+
code: "TEAM-ALPHA", // optional; generated when omitted
|
|
675
|
+
maxParticipants: 64,
|
|
676
|
+
expiresInSeconds: 2 * 60 * 60,
|
|
677
|
+
});
|
|
678
|
+
|
|
679
|
+
const stopEvents = room.subscribe("shared.state.updated", (event) => {
|
|
680
|
+
console.log(event.sequence, event.data, event.self);
|
|
681
|
+
});
|
|
682
|
+
console.log(room.members); // initial snapshot
|
|
683
|
+
const stopMembers = room.onMembersChanged((members) => {
|
|
684
|
+
console.log(members);
|
|
685
|
+
});
|
|
686
|
+
|
|
687
|
+
await room.setPresence({ status: "active" });
|
|
688
|
+
await room.publish("shared.state.updated", { value: 42 });
|
|
689
|
+
|
|
690
|
+
stopEvents();
|
|
691
|
+
stopMembers();
|
|
692
|
+
await room.leave();
|
|
693
|
+
```
|
|
694
|
+
|
|
695
|
+
Join an existing room with
|
|
696
|
+
`client.work.realtime.joinRoom({ code: "TEAM-ALPHA" })`. Codes are scoped to
|
|
697
|
+
one Work and are identifiers, not credentials; the runtime session and a
|
|
698
|
+
short-lived admission ticket provide authorization.
|
|
699
|
+
|
|
700
|
+
| Surface | Purpose |
|
|
701
|
+
|---|---|
|
|
702
|
+
| `createRoom()` / `joinRoom()` | Create or enter a code-scoped room |
|
|
703
|
+
| `subscribe()` / `subscribeAll()` | Receive typed or all business events |
|
|
704
|
+
| `publish()` | Send an acknowledged event; accepts an optional correlation-only `clientEventId` |
|
|
705
|
+
| `send()` / `onSendError()` | Send without an ACK for high-rate traffic; observe asynchronous failures |
|
|
706
|
+
| `members` / `onMembersChanged()` | Read the initial member snapshot and later membership or presence changes |
|
|
707
|
+
| `setPresence()` | Replace this participant's transient presence object |
|
|
708
|
+
| `state` / `onStateChange()` | Observe `connecting`, `joined`, `reconnecting`, `expired`, or `closed` |
|
|
709
|
+
| `onOutOfSync()` | Detect sequence jumps in the current live stream |
|
|
710
|
+
| `leave()` | Release membership and SDK listeners |
|
|
711
|
+
|
|
712
|
+
Room events are ordered while connected but are not replayed. A reconnect
|
|
713
|
+
refreshes the member snapshot and advances the sequence cursor, so use
|
|
714
|
+
`onStateChange()` to resync authoritative application state after reconnecting;
|
|
715
|
+
`onOutOfSync()` only reports gaps visible in the current live stream. Payloads
|
|
716
|
+
are transient and are not stored in the Work.
|
|
717
|
+
|
|
718
|
+
| Limit | Value |
|
|
719
|
+
|---|---|
|
|
720
|
+
| Room code | Generated when omitted; custom codes are 3–48 uppercase letters, digits, `_`, or `-`, starting with a letter or digit |
|
|
721
|
+
| Lifetime | 2 hours by default; 60 seconds to 24 hours, absolute from creation |
|
|
722
|
+
| Participants | 16 by default; 2–128 |
|
|
723
|
+
| Active rooms | 512 per Work |
|
|
724
|
+
| Event name | 1–64 ASCII letters, digits, `.`, `_`, `:`, or `-`, starting with a letter or digit; `cohub.*` is reserved |
|
|
725
|
+
| Event payload | 16 KB of JSON |
|
|
726
|
+
| Presence payload | 2 KB of JSON |
|
|
727
|
+
| Publish rate | 2,000 events per second per room |
|
|
728
|
+
| Presence rate | 30 updates per second per connection |
|
|
729
|
+
| Pending mutations | 256 per connection before backpressure errors |
|
|
730
|
+
|
|
731
|
+
`createRoom()` returns HTTP 429 with `ROOM_QUOTA_EXCEEDED` at the active-room
|
|
732
|
+
limit. Activity never extends `expiresAt`; expired rooms release their slot
|
|
733
|
+
automatically.
|
|
734
|
+
|
|
735
|
+
#### High-frequency events
|
|
736
|
+
|
|
737
|
+
`publish()` waits for an ACK, so a loop that awaits each call is capped at
|
|
738
|
+
roughly `1000 / RTT` events per second. Use `send()` for input frames and other
|
|
739
|
+
high-rate traffic:
|
|
740
|
+
|
|
741
|
+
```js
|
|
742
|
+
room.onSendError((error) => console.warn("dropped frame", error.message));
|
|
743
|
+
room.onStateChange((state) => {
|
|
744
|
+
if (state !== "joined") pauseSimulation();
|
|
745
|
+
});
|
|
746
|
+
|
|
747
|
+
room.send("input.frame", { frame, pad });
|
|
748
|
+
```
|
|
749
|
+
|
|
750
|
+
`send()` preserves server ordering but drops calls while the room is not joined
|
|
751
|
+
and reports rate, validation, membership, and backpressure failures through
|
|
752
|
+
`onSendError()`. Use `publish()` whenever a specific event must be confirmed.
|
|
753
|
+
|
|
754
|
+
#### Seats and participant identity
|
|
755
|
+
|
|
756
|
+
Every connection is a participant by default, so two tabs appear twice. Each
|
|
757
|
+
member includes an opaque `userKey` that is stable for one room and viewer,
|
|
758
|
+
letting an application group connections without seeing the account ID.
|
|
759
|
+
|
|
760
|
+
Set `seatPerUser: true` when each viewer should occupy at most one seat:
|
|
761
|
+
|
|
762
|
+
```js
|
|
763
|
+
const room = await client.work.realtime.createRoom({
|
|
764
|
+
maxParticipants: 2,
|
|
765
|
+
seatPerUser: true,
|
|
766
|
+
});
|
|
767
|
+
```
|
|
768
|
+
|
|
769
|
+
A second tab or reconnect takes over the existing seat instead of consuming a
|
|
770
|
+
new one. The server keeps the participant ID, updates `room.participantId`, and
|
|
771
|
+
closes the superseded connection without emitting a leave event. Without this
|
|
772
|
+
mode, an unclean disconnect can retain its seat lease for up to one minute.
|
|
773
|
+
|
|
663
774
|
---
|
|
664
775
|
|
|
665
776
|
## 6. Complete working example
|
|
666
777
|
|
|
667
|
-
A no-build HTML Work
|
|
668
|
-
|
|
778
|
+
A no-build HTML Work for LLM chat and image generation. Use it as a starting
|
|
779
|
+
point and keep only the capabilities you need.
|
|
669
780
|
|
|
670
781
|
> **Publish this Work with:**
|
|
671
782
|
> - workScopes: `["space.view", "session.view", "taskrun.view"]`
|
|
@@ -724,7 +835,7 @@ exact pattern that was verified end-to-end. Adapt it to your needs.
|
|
|
724
835
|
### `app.js`
|
|
725
836
|
|
|
726
837
|
```js
|
|
727
|
-
import { createCohubClient } from "https://esm.sh/@neta-art/cohub@
|
|
838
|
+
import { createCohubClient } from "https://esm.sh/@neta-art/cohub@latest";
|
|
728
839
|
|
|
729
840
|
// --- Environment detection (critical: browsers don't inject ENV) ---
|
|
730
841
|
const isDevWork =
|
|
@@ -985,98 +1096,6 @@ Before publishing your Work, verify each item:
|
|
|
985
1096
|
|
|
986
1097
|
---
|
|
987
1098
|
|
|
988
|
-
## Realtime rooms in a Work
|
|
989
|
-
|
|
990
|
-
Realtime rooms are available through `client.work.realtime` and use the Work
|
|
991
|
-
runtime identity automatically. They do not require a viewer scope or an
|
|
992
|
-
additional consent dialog.
|
|
993
|
-
|
|
994
|
-
```js
|
|
995
|
-
const room = await client.work.realtime.createRoom({
|
|
996
|
-
code: "TEAM-ALPHA",
|
|
997
|
-
maxParticipants: 64,
|
|
998
|
-
expiresInSeconds: 2 * 60 * 60,
|
|
999
|
-
});
|
|
1000
|
-
|
|
1001
|
-
const stop = room.subscribe("shared.state.updated", (event) => {
|
|
1002
|
-
console.log(event.sequence, event.data);
|
|
1003
|
-
});
|
|
1004
|
-
|
|
1005
|
-
await room.publish("shared.state.updated", { value: 42 });
|
|
1006
|
-
await room.leave();
|
|
1007
|
-
stop();
|
|
1008
|
-
```
|
|
1009
|
-
|
|
1010
|
-
A Work can join an existing room with `client.work.realtime.joinRoom({ code })`.
|
|
1011
|
-
Room codes are scoped to the Work and are case-insensitive. They identify a
|
|
1012
|
-
room but are not credentials; the runtime Work session and the short-lived
|
|
1013
|
-
room admission ticket provide authorization.
|
|
1014
|
-
|
|
1015
|
-
`expiresInSeconds` is an absolute lifetime measured from server-side creation.
|
|
1016
|
-
Activity never extends it, and the maximum lifetime is 24 hours. The room is
|
|
1017
|
-
logically expired at `expiresAt`; connected clients receive a closed state and
|
|
1018
|
-
new publishes or joins fail.
|
|
1019
|
-
|
|
1020
|
-
Each Work can hold up to 512 active rooms at once. Expired rooms free their slot
|
|
1021
|
-
automatically, and `createRoom` fails with HTTP 429 and `ROOM_QUOTA_EXCEEDED`
|
|
1022
|
-
when the limit is reached.
|
|
1023
|
-
|
|
1024
|
-
Events are generic JSON payloads. The SDK does not define business event names,
|
|
1025
|
-
and the Work should define its own event map in TypeScript. Events are ordered
|
|
1026
|
-
and acknowledged while a connection is live. Events missed during a disconnect
|
|
1027
|
-
are not replayed, so applications should publish a current state snapshot after
|
|
1028
|
-
rejoining when needed. Payloads are transient and are not stored in the Work.
|
|
1029
|
-
|
|
1030
|
-
### High-frequency events
|
|
1031
|
-
|
|
1032
|
-
`publish` waits for a server ack, so a loop that awaits every call is capped at
|
|
1033
|
-
roughly `1000 / rtt` events per second. For input frames and other high-rate
|
|
1034
|
-
traffic use `send`, which skips the ack:
|
|
1035
|
-
|
|
1036
|
-
```js
|
|
1037
|
-
// 30 input frames per second, no per-event round trip
|
|
1038
|
-
room.send("input.frame", { frame, pad });
|
|
1039
|
-
|
|
1040
|
-
room.onSendError((error) => console.warn("dropped frame", error.message));
|
|
1041
|
-
room.onStateChange((state) => { if (state !== "joined") pauseSimulation(); });
|
|
1042
|
-
```
|
|
1043
|
-
|
|
1044
|
-
Ordering is still guaranteed by the server. Failures (rate limit, membership lost)
|
|
1045
|
-
arrive through `onSendError` for the room that failed, and calls while the room is
|
|
1046
|
-
not joined are dropped rather than queued. An invalid event name, an oversized
|
|
1047
|
-
payload, or data JSON cannot encode (`undefined`, a function, a symbol) is rejected
|
|
1048
|
-
locally before reaching the server. Use `publish` when a specific event must be
|
|
1049
|
-
confirmed, and `send` for the steady stream.
|
|
1050
|
-
|
|
1051
|
-
### Seats and participant identity
|
|
1052
|
-
|
|
1053
|
-
By default every connection is its own participant, so a viewer who opens the
|
|
1054
|
-
Work in two tabs appears twice. This suits presence-style features such as
|
|
1055
|
-
multiple cursors. Each member also carries an opaque `userKey` that is stable per
|
|
1056
|
-
room and viewer, so an application can group or de-duplicate participants without
|
|
1057
|
-
seeing the underlying account.
|
|
1058
|
-
|
|
1059
|
-
A room created with `seatPerUser: true` instead gives each viewer at most one
|
|
1060
|
-
seat:
|
|
1061
|
-
|
|
1062
|
-
```js
|
|
1063
|
-
const room = await client.work.realtime.createRoom({
|
|
1064
|
-
maxParticipants: 2,
|
|
1065
|
-
seatPerUser: true,
|
|
1066
|
-
});
|
|
1067
|
-
```
|
|
1068
|
-
|
|
1069
|
-
Joining then takes over the seat the viewer already holds instead of consuming
|
|
1070
|
-
another one. This matters for small fixed-size rooms: after an unclean disconnect
|
|
1071
|
-
(a killed tab, a dropped network, a sleeping laptop) the previous seat stays
|
|
1072
|
-
leased for up to a minute, and in a two-seat room that would otherwise block the
|
|
1073
|
-
viewer from rejoining. A clean close releases the seat immediately either way.
|
|
1074
|
-
|
|
1075
|
-
On takeover the server keeps the existing participant id, so peers see no churn,
|
|
1076
|
-
and `room.participantId` reflects the server value rather than the id issued at
|
|
1077
|
-
admission. The superseded connection is closed with reason `superseded` and emits
|
|
1078
|
-
no leave event, because the participant is still present.
|
|
1079
|
-
|
|
1080
1099
|
## 8. Publishing a Work (API/SDK)
|
|
1081
1100
|
|
|
1082
1101
|
Before creating a Work through the API, ensure the owner has a username and
|