@sogni-ai/sogni-client 5.27.1 → 5.29.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/AGENTS.md CHANGED
@@ -266,6 +266,38 @@ chore: Update example scripts for video generation
266
266
 
267
267
  **Important:** Changes that only affect the `/examples` folder should typically use `chore:` since they don't affect the published SDK package.
268
268
 
269
+ ## Python Client Parity
270
+
271
+ There is a second official client, [`sogni-client-python`](https://github.com/Sogni-AI/sogni-client-python),
272
+ which is a hand-maintained port of this SDK — not a generated artifact. It does
273
+ not update itself when this package publishes.
274
+
275
+ **Whenever this package publishes a release, port the same change to the Python
276
+ client.** A release here that changes the client contract — model IDs and their
277
+ validation, request/keyframe shape, event or job fields, socket/recovery
278
+ behavior, hosted tool schemas — leaves Python callers on a stale contract until
279
+ someone does. The drift is silent: the Python client keeps working and simply
280
+ does not know about the new surface.
281
+
282
+ That has already bitten us. The Python client sat at `5.21.3` while this package
283
+ reached `5.27.1`, so it rejected the FastH3 `minimax-h3-fastvideo-int8_*_turbo`
284
+ checkpoints as non-video models after they became the default Turbo engine, and
285
+ it still failed every in-flight project on a socket drop — behavior removed here
286
+ in 5.24.0.
287
+
288
+ How to port:
289
+ 1. Read this repo's `CHANGELOG.md` between the Python client's
290
+ `pyproject.toml` version and the new one; each entry is one port.
291
+ 2. Mirror the change in `sogni-client-python`, matching validation messages and
292
+ wire field names exactly so both clients fail the same way.
293
+ 3. Sync `sogni_client/data/hosted_tools.json` from
294
+ `src/Chat/_hostedToolsManifest.generated.ts` when tool schemas moved, then
295
+ re-pin `tests/fixtures/hosted-tool-alias-parity.generated.json`.
296
+ 4. Set the Python version to match this package's version and tag `v<version>`.
297
+
298
+ Not every release needs a port — a `chore:` release or a Node-only change does
299
+ not. Judge by whether the client contract moved.
300
+
269
301
  ## Common Tasks Quick Reference
270
302
 
271
303
  ### Generate an Image
package/CHANGELOG.md CHANGED
@@ -1,3 +1,17 @@
1
+ # [5.29.0](https://github.com/Sogni-AI/sogni-client/compare/v5.28.0...v5.29.0) (2026-09-05)
2
+
3
+
4
+ ### Features
5
+
6
+ * **projects:** type the model unload and load phases a worker reports while initiating ([3e8d04d](https://github.com/Sogni-AI/sogni-client/commit/3e8d04d25bf50809f36ab9b81229d54e691cd102))
7
+
8
+ # [5.28.0](https://github.com/Sogni-AI/sogni-client/compare/v5.27.1...v5.28.0) (2026-09-04)
9
+
10
+
11
+ ### Features
12
+
13
+ * **announcements:** add the appAlert event and announcements API ([abcc1f4](https://github.com/Sogni-AI/sogni-client/commit/abcc1f4de5a384bbfffe6de0ec7b922ed59df43d))
14
+
1
15
  ## [5.27.1](https://github.com/Sogni-AI/sogni-client/compare/v5.27.0...v5.27.1) (2026-09-02)
2
16
 
3
17
 
package/README.md CHANGED
@@ -53,7 +53,7 @@ yarn add @sogni-ai/sogni-client
53
53
  ## Core concepts
54
54
 
55
55
  In order to use Sogni Supernet, you need an active Sogni account with a positive SOGNI or Spark token balance. You can authenticate using either an **API key** (recommended) or **username and password**.
56
- You can create a free account in our [Web App](https://app.sogni.ai) or [Mac App](https://www.sogni.ai/studio) which will give you tokens just for signing up and confirming your email. Each email-verified account is allowed 400 free Spark render credits per month. On the API, free credits can be used with Z-Image Turbo; paid credits can access all models and features.
56
+ You can create a free account in our [Web App](https://app.sogni.ai) or [Mac App](https://www.sogni.ai/studio) which will give you tokens just for signing up and confirming your email. Each email-verified account is allowed 400 free Spark render credits per month. On the API, free credits can be used with Krea 2 Turbo; paid credits can access all models and features.
57
57
 
58
58
  **To get your API key:** Log in to [dashboard.sogni.ai](https://dashboard.sogni.ai), click your **Username** dropdown in the top-right corner, and provision your API key.
59
59
 
@@ -0,0 +1,36 @@
1
+ import ApiGroup from '../ApiGroup.js';
2
+ import type { AppAlert } from '../ApiClient/WebSocketClient/events.js';
3
+ /**
4
+ * Admin-authored in-app announcements — pinned banners and toasts composed in
5
+ * the Sogni Admin Portal.
6
+ *
7
+ * The socket is the primary delivery path: subscribe to the `appAlert` event
8
+ * (opt in with `socketEventSubscriptions: { appAlert: true }`) and the server
9
+ * pushes announcements live AND replays any live pinned banner on connect, so a
10
+ * user who was offline when one published still receives it.
11
+ *
12
+ * This REST surface covers the two moments the socket cannot:
13
+ * - `active()` at launch, before the socket has authenticated
14
+ * - `dismiss()`, which must persist per ACCOUNT rather than per device so a
15
+ * banner dismissed on one client stays dismissed on the next
16
+ *
17
+ * Full contract: `docs/app-alert-contract.md` in sogni-socket.
18
+ */
19
+ declare class AnnouncementsApi extends ApiGroup {
20
+ /**
21
+ * Announcements currently live for the signed-in account, minus anything the
22
+ * account has already dismissed.
23
+ *
24
+ * @param platform Optional `appSource` for this client (e.g. `'sogni-mac'`).
25
+ * Platform-scoped announcements only match when it is supplied — an
26
+ * announcement narrowed to macOS is deliberately withheld from a caller
27
+ * that cannot say what it is, rather than sent to everyone.
28
+ */
29
+ active(platform?: string): Promise<AppAlert[]>;
30
+ /**
31
+ * Dismiss one announcement for the signed-in account, on every device.
32
+ * Call this when the user closes a pinned announcement.
33
+ */
34
+ dismiss(id: string): Promise<void>;
35
+ }
36
+ export default AnnouncementsApi;
@@ -0,0 +1,59 @@
1
+ "use strict";
2
+ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
3
+ function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
4
+ return new (P || (P = Promise))(function (resolve, reject) {
5
+ function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
6
+ function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
7
+ function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
8
+ step((generator = generator.apply(thisArg, _arguments || [])).next());
9
+ });
10
+ };
11
+ var __importDefault = (this && this.__importDefault) || function (mod) {
12
+ return (mod && mod.__esModule) ? mod : { "default": mod };
13
+ };
14
+ Object.defineProperty(exports, "__esModule", { value: true });
15
+ const ApiGroup_js_1 = __importDefault(require("../ApiGroup.js"));
16
+ /**
17
+ * Admin-authored in-app announcements — pinned banners and toasts composed in
18
+ * the Sogni Admin Portal.
19
+ *
20
+ * The socket is the primary delivery path: subscribe to the `appAlert` event
21
+ * (opt in with `socketEventSubscriptions: { appAlert: true }`) and the server
22
+ * pushes announcements live AND replays any live pinned banner on connect, so a
23
+ * user who was offline when one published still receives it.
24
+ *
25
+ * This REST surface covers the two moments the socket cannot:
26
+ * - `active()` at launch, before the socket has authenticated
27
+ * - `dismiss()`, which must persist per ACCOUNT rather than per device so a
28
+ * banner dismissed on one client stays dismissed on the next
29
+ *
30
+ * Full contract: `docs/app-alert-contract.md` in sogni-socket.
31
+ */
32
+ class AnnouncementsApi extends ApiGroup_js_1.default {
33
+ /**
34
+ * Announcements currently live for the signed-in account, minus anything the
35
+ * account has already dismissed.
36
+ *
37
+ * @param platform Optional `appSource` for this client (e.g. `'sogni-mac'`).
38
+ * Platform-scoped announcements only match when it is supplied — an
39
+ * announcement narrowed to macOS is deliberately withheld from a caller
40
+ * that cannot say what it is, rather than sent to everyone.
41
+ */
42
+ active(platform) {
43
+ return __awaiter(this, void 0, void 0, function* () {
44
+ const res = yield this.client.rest.get('/v1/announcements/active', platform ? { platform } : undefined);
45
+ return res.data.announcements || [];
46
+ });
47
+ }
48
+ /**
49
+ * Dismiss one announcement for the signed-in account, on every device.
50
+ * Call this when the user closes a pinned announcement.
51
+ */
52
+ dismiss(id) {
53
+ return __awaiter(this, void 0, void 0, function* () {
54
+ yield this.client.rest.post(`/v1/announcements/${encodeURIComponent(id)}/dismiss`);
55
+ });
56
+ }
57
+ }
58
+ exports.default = AnnouncementsApi;
59
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/Announcements/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;AAAA,iEAAsC;AAItC;;;;;;;;;;;;;;;GAeG;AACH,MAAM,gBAAiB,SAAQ,qBAAQ;IACrC;;;;;;;;OAQG;IACG,MAAM,CAAC,QAAiB;;YAC5B,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CACpC,0BAA0B,EAC1B,QAAQ,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAC,CAAC,SAAS,CACpC,CAAC;YACF,OAAO,GAAG,CAAC,IAAI,CAAC,aAAa,IAAI,EAAE,CAAC;QACtC,CAAC;KAAA;IAED;;;OAGG;IACG,OAAO,CAAC,EAAU;;YACtB,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CACzB,qBAAqB,kBAAkB,CAAC,EAAE,CAAC,UAAU,CACtD,CAAC;QACJ,CAAC;KAAA;CACF;AAED,kBAAe,gBAAgB,CAAC"}
@@ -180,7 +180,11 @@ export type JobETAData = {
180
180
  imgID?: string;
181
181
  etaSeconds: number;
182
182
  };
183
- export type JobPreparation = {
183
+ /**
184
+ * A LoRA the job needs is being fetched by the worker before the graph is
185
+ * queued. Arrives on `initiatingModel` and updates as the download progresses.
186
+ */
187
+ export type JobAssetPreparation = {
184
188
  phase: 'downloadingAssets';
185
189
  assetType: 'lora';
186
190
  requested: number;
@@ -190,6 +194,25 @@ export type JobPreparation = {
190
194
  current: number;
191
195
  currentProgress?: number;
192
196
  };
197
+ /**
198
+ * The worker is switching models: ComfyUI is moving the previous model out of
199
+ * VRAM (`unloadingModel`) or the next one in (`loadingModel`). Each phase
200
+ * arrives twice on `initiatingModel`, at `start` and at `end`; the `end` step
201
+ * carries how long it took. A switch can run past a minute on a card that was
202
+ * full, so show it rather than a render that appears stuck at 0%.
203
+ */
204
+ export type JobModelPhasePreparation = {
205
+ phase: 'unloadingModel' | 'loadingModel';
206
+ /** The model class ComfyUI names, e.g. "Flux" or "WAN21"; not a display name. */
207
+ model: string;
208
+ step: 'start' | 'end';
209
+ elapsedSec?: number;
210
+ };
211
+ /**
212
+ * What the worker is doing while a job is `initiating`. Narrow on `phase`
213
+ * before reading the other fields.
214
+ */
215
+ export type JobPreparation = JobAssetPreparation | JobModelPhasePreparation;
193
216
  export type JobResultData = {
194
217
  jobID: string;
195
218
  imgID: string;
@@ -261,6 +284,60 @@ export type ToastMessage = {
261
284
  autoClose: number;
262
285
  stickyID: string;
263
286
  };
287
+ /** A call to action rendered inside an announcement. Always an absolute http(s) URL. */
288
+ export type AppAlertAction = {
289
+ label: string;
290
+ href: string;
291
+ /** Open in a new tab / the system browser rather than routing in-app. */
292
+ external?: boolean;
293
+ };
294
+ /**
295
+ * An admin-authored in-app announcement, composed in the Sogni Admin Portal.
296
+ *
297
+ * OPT-IN: the server sends this only to clients that asked for it with
298
+ * `socketEventSubscriptions: { appAlert: true }`. A client that does not opt in
299
+ * keeps receiving the same announcement as a plain {@link ToastMessage}, so this
300
+ * event can be adopted at any time without coordination. A client never
301
+ * receives both renderings of one announcement.
302
+ *
303
+ * NOT at-most-once: a live pinned announcement is re-sent on every reconnect
304
+ * while its window is open, so a user who was offline when it published still
305
+ * sees it. Deduplicate on `id`.
306
+ *
307
+ * Full contract: `docs/app-alert-contract.md` in sogni-socket.
308
+ */
309
+ export type AppAlert = {
310
+ /** Stable across redeliveries; also the key for `announcements.dismiss(id)`. */
311
+ id: string;
312
+ /** `toast` is a one-shot; `banner` persists until dismissed or `endsAt`. */
313
+ kind: 'toast' | 'banner';
314
+ severity: 'info' | 'success' | 'warn' | 'danger';
315
+ /**
316
+ * Icon token, never a URL — map it to your own icon set. One of `info`,
317
+ * `success`, `warning`, `error`, `megaphone`, `wrench`, `sparkles`, `gift`,
318
+ * `rocket`, `clock`. Absent means "use the icon for `severity`".
319
+ */
320
+ icon?: string;
321
+ /** Optional `#RRGGBB` tint. Ignoring it must still render a legible alert. */
322
+ accent?: string;
323
+ title: string;
324
+ /**
325
+ * Restricted markdown: paragraphs, bold, italic, inline code, strikethrough,
326
+ * links, and line breaks. No images, no raw HTML, no headings or lists.
327
+ */
328
+ bodyMarkdown: string;
329
+ /** Do not auto-dismiss. Banners are pinned; toasts normally are not. */
330
+ pinned: boolean;
331
+ /** When false, hide the close affordance — it still clears at `endsAt`. */
332
+ dismissible: boolean;
333
+ /** Toasts only. Milliseconds. */
334
+ autoCloseMs?: number;
335
+ actions?: AppAlertAction[];
336
+ /** Epoch ms. */
337
+ startsAt: number;
338
+ /** Epoch ms. Always present for a banner. */
339
+ endsAt?: number;
340
+ };
264
341
  export type ArtistCancelConfirmation = {
265
342
  didCancel: boolean;
266
343
  error_message?: string;
@@ -397,6 +474,14 @@ export type SocketEventMap = {
397
474
  * @event WebSocketClient#toastMessage - Toast message received
398
475
  */
399
476
  toastMessage: ToastMessage;
477
+ /**
478
+ * @event WebSocketClient#appAlert - Admin announcement received (banner or toast)
479
+ *
480
+ * Opt in with `socketEventSubscriptions: { appAlert: true }`; without it the
481
+ * server sends the same announcement as `toastMessage` instead. Redelivered on
482
+ * reconnect while a pinned announcement is live — deduplicate on `id`.
483
+ */
484
+ appAlert: AppAlert;
400
485
  artistCancelConfirmation: ArtistCancelConfirmation;
401
486
  };
402
487
  export type SocketEventName = keyof SocketEventMap;
package/dist/index.d.ts CHANGED
@@ -17,7 +17,7 @@ import type { ProjectResolution } from './Projects/index.js';
17
17
  import { PROJECT_LOST_ORIGINAL_CODE, isProjectLostError, projectParamsFromRecoveredProject } from './Projects/recovery.js';
18
18
  import type { Balances, Reward, RewardCantClaimReason, TxHistoryEntry } from './Account/types.js';
19
19
  import type { CreateSubscriptionCheckoutOptions, SubscriptionCheckoutResult, SubscriptionEntitlementSnapshot, SubscriptionFairUseState, SubscriptionPlanId, SubscriptionPlanInterval, SubscriptionPlan, SubscriptionPortalSession, SubscriptionRedirectType, SubscriptionStatus, SubscriptionTerm, SubscriptionUsage, TrialEligibility, TrialReasonCode } from './Account/subscription.types.js';
20
- import type { ToastMessage } from './ApiClient/WebSocketClient/events.js';
20
+ import type { AppAlert, AppAlertAction, ToastMessage } from './ApiClient/WebSocketClient/events.js';
21
21
  import type DataEntity from './lib/DataEntity.js';
22
22
  import { ControlNetName, ControlNetParams, ControlNetMode, VideoControlNetName, VideoControlNetParams } from './Projects/types/ControlNetParams.js';
23
23
  import ChatApi from './Chat/index.js';
@@ -32,6 +32,7 @@ import { CreativeWorkflowArtifact, CreativeWorkflowEvent, CreativeWorkflowRecord
32
32
  import { ForkWorkflowTemplateBody, ListWorkflowTemplatesOptions, ListWorkflowTemplatesResult, WorkflowTemplate, WorkflowTemplateAuthor, WorkflowTemplateRequestOptions, WorkflowTemplateStability, WorkflowTemplateVisibility, WorkflowTemplateVisibilityFilter } from './CreativeWorkflows/Templates/types.js';
33
33
  import StatsApi from './Stats/index.js';
34
34
  import ReplayApi from './Replay/index.js';
35
+ import AnnouncementsApi from './Announcements/index.js';
35
36
  import { GetReplayRecordResult, ListReplayRecordsOptions, ListReplayRecordsResult, ReplayRecordSummary, ReplayRequestOptions, ReplayWriteResult, RunRecord } from './Replay/types.js';
36
37
  import ErrorData, { SUBSCRIPTION_ERROR_CODES } from './types/ErrorData.js';
37
38
  import type { SubscriptionErrorCode } from './types/ErrorData.js';
@@ -39,7 +40,7 @@ import isSubscriptionLimitError from './lib/isSubscriptionLimitError.js';
39
40
  import { TokenType } from './types/token.js';
40
41
  import { ApiKeyAuthManager, TokenAuthData } from './lib/AuthManager/index.js';
41
42
  import type { AgentAttributionMetadata, AgentSurface, ConnectionAttribution, ExecutionMode, InteractionKind, OperationLineage, OperationScope, SogniAttributionConfig, WorkloadAttribution, WorkloadAttributionDefaults, WorkloadAttributionInput, WorkloadKind } from './types/attribution.js';
42
- export type { AudioFormat, AudioOutputFormat, AudioProjectParams, AvailableModel, BillingMode, ChatCompletionChunk, ChatCompletionParams, ChatCompletionResult, ChatJobErrorFields, ChatJobStateEvent, ChatMessage, ChatResponseFormat, ChatRunEvent, ChatRunRecord, ChatRunStatus, ChatTokenUsage, StartChatRunParams, StreamChatRunEventsOptions, ContentPart, HostedChatCompletionChoice, HostedChatCompletionMessage, HostedChatCompletionParams, HostedChatCompletionResult, HostedCreativeWorkflowReference, HostedSynchronousToolName, HostedToolExecutionParams, HostedToolExecutionResult, CreativeWorkflowArtifact, CreativeWorkflowEvent, CreativeWorkflowRecord, CreativeWorkflowSseEvent, CreativeWorkflowStatus, CreativeWorkflowWaitingReason, ImageUrlContentPart, ListCreativeWorkflowOptions, LLMCostEstimation, LLMJobCost, LLMModelInfo, LLMParamConstraint, LLMSamplingDefaults, AvailableLorasParams, LoraCatalog, LoraCatalogEntry, LoraConstraints, LoraUi, ControlNetMode, ControlNetName, ControlNetParams, TextContentPart, ErrorData, ImageProjectParams, ImageOutputFormat, JobStatus, Logger, LogLevel, ProjectParams, ProjectStatus, CreativeWorkflowHostedToolName, StartCreativeWorkflowOptions, StartCreativeWorkflowParams, StartCreativeWorkflowDependency, StartCreativeWorkflowInput, StartCreativeWorkflowStep, StreamCreativeWorkflowEventsOptions, ResumeCreativeWorkflowOptions, ResumeCreativeWorkflowParams, ResumeCreativeWorkflowResult, ReseedCreativeWorkflowOptions, ReseedCreativeWorkflowParams, ReseedCreativeWorkflowResult, ForkWorkflowTemplateBody, ListWorkflowTemplatesOptions, ListWorkflowTemplatesResult, WorkflowTemplate, WorkflowTemplateAuthor, WorkflowTemplateRequestOptions, WorkflowTemplateStability, WorkflowTemplateVisibility, WorkflowTemplateVisibilityFilter, RunRecord, ReplayWriteResult, ReplayRecordSummary, ReplayRequestOptions, ListReplayRecordsOptions, ListReplayRecordsResult, GetReplayRecordResult, SupernetType, TokenType, ToolCall, ToolCallDelta, ToolCallFunction, ToolChoice, ToolDefinition, ToolExecutionOptions, ToolExecutionProgress, ToolExecutionResult, ToolFunction, ToolHistoryEntry, SogniToolsMode, AuthenticatedData, SocketEventName, SocketEventSubscriptionInput, SocketEventSubscriptionName, SocketEventSubscriptions, SocketEventSubscriptionsUpdatedData, SocketEventSubscriptionUpdate, SocketSubscriptionEntitlementData, SocketSubscriptionFairUseState, SocketSubscriptionLimitNoticeData, VideoControlNetName, VideoControlNetParams, VideoFormat, VideoOutputFormat, VideoProjectParams, VideoWorkflowType, Balances, Reward, RewardCantClaimReason, TxHistoryEntry, CreateSubscriptionCheckoutOptions, SubscriptionCheckoutResult, SubscriptionEntitlementSnapshot, SubscriptionFairUseState, SubscriptionPlanId, SubscriptionPlanInterval, SubscriptionPlan, SubscriptionErrorCode, SubscriptionPortalSession, SubscriptionRedirectType, SubscriptionStatus, SubscriptionTerm, SubscriptionUsage, TrialEligibility, TrialReasonCode, SizePreset, EstimateRequest, CostEstimation, ProjectEvent, JobEvent, JobPreparation, RawProject, ToastMessage, DataEntity, InputMedia, AgentAttributionMetadata, AgentSurface, ConnectionAttribution, ExecutionMode, InteractionKind, OperationLineage, OperationScope, SogniAttributionConfig, WorkloadAttribution, WorkloadAttributionDefaults, WorkloadAttributionInput, WorkloadKind };
43
+ export type { AudioFormat, AudioOutputFormat, AudioProjectParams, AvailableModel, BillingMode, ChatCompletionChunk, ChatCompletionParams, ChatCompletionResult, ChatJobErrorFields, ChatJobStateEvent, ChatMessage, ChatResponseFormat, ChatRunEvent, ChatRunRecord, ChatRunStatus, ChatTokenUsage, StartChatRunParams, StreamChatRunEventsOptions, ContentPart, HostedChatCompletionChoice, HostedChatCompletionMessage, HostedChatCompletionParams, HostedChatCompletionResult, HostedCreativeWorkflowReference, HostedSynchronousToolName, HostedToolExecutionParams, HostedToolExecutionResult, CreativeWorkflowArtifact, CreativeWorkflowEvent, CreativeWorkflowRecord, CreativeWorkflowSseEvent, CreativeWorkflowStatus, CreativeWorkflowWaitingReason, ImageUrlContentPart, ListCreativeWorkflowOptions, LLMCostEstimation, LLMJobCost, LLMModelInfo, LLMParamConstraint, LLMSamplingDefaults, AvailableLorasParams, LoraCatalog, LoraCatalogEntry, LoraConstraints, LoraUi, ControlNetMode, ControlNetName, ControlNetParams, TextContentPart, ErrorData, ImageProjectParams, ImageOutputFormat, JobStatus, Logger, LogLevel, ProjectParams, ProjectStatus, CreativeWorkflowHostedToolName, StartCreativeWorkflowOptions, StartCreativeWorkflowParams, StartCreativeWorkflowDependency, StartCreativeWorkflowInput, StartCreativeWorkflowStep, StreamCreativeWorkflowEventsOptions, ResumeCreativeWorkflowOptions, ResumeCreativeWorkflowParams, ResumeCreativeWorkflowResult, ReseedCreativeWorkflowOptions, ReseedCreativeWorkflowParams, ReseedCreativeWorkflowResult, ForkWorkflowTemplateBody, ListWorkflowTemplatesOptions, ListWorkflowTemplatesResult, WorkflowTemplate, WorkflowTemplateAuthor, WorkflowTemplateRequestOptions, WorkflowTemplateStability, WorkflowTemplateVisibility, WorkflowTemplateVisibilityFilter, RunRecord, ReplayWriteResult, ReplayRecordSummary, ReplayRequestOptions, ListReplayRecordsOptions, ListReplayRecordsResult, GetReplayRecordResult, SupernetType, TokenType, ToolCall, ToolCallDelta, ToolCallFunction, ToolChoice, ToolDefinition, ToolExecutionOptions, ToolExecutionProgress, ToolExecutionResult, ToolFunction, ToolHistoryEntry, SogniToolsMode, AuthenticatedData, SocketEventName, SocketEventSubscriptionInput, SocketEventSubscriptionName, SocketEventSubscriptions, SocketEventSubscriptionsUpdatedData, SocketEventSubscriptionUpdate, SocketSubscriptionEntitlementData, SocketSubscriptionFairUseState, SocketSubscriptionLimitNoticeData, VideoControlNetName, VideoControlNetParams, VideoFormat, VideoOutputFormat, VideoProjectParams, VideoWorkflowType, Balances, Reward, RewardCantClaimReason, TxHistoryEntry, CreateSubscriptionCheckoutOptions, SubscriptionCheckoutResult, SubscriptionEntitlementSnapshot, SubscriptionFairUseState, SubscriptionPlanId, SubscriptionPlanInterval, SubscriptionPlan, SubscriptionErrorCode, SubscriptionPortalSession, SubscriptionRedirectType, SubscriptionStatus, SubscriptionTerm, SubscriptionUsage, TrialEligibility, TrialReasonCode, SizePreset, EstimateRequest, CostEstimation, ProjectEvent, JobEvent, JobPreparation, RawProject, ToastMessage, AppAlert, AppAlertAction, DataEntity, InputMedia, AgentAttributionMetadata, AgentSurface, ConnectionAttribution, ExecutionMode, InteractionKind, OperationLineage, OperationScope, SogniAttributionConfig, WorkloadAttribution, WorkloadAttributionDefaults, WorkloadAttributionInput, WorkloadKind };
43
44
  export type { CompletedRecoveredProject, ProjectRecoverySnapshot, ProjectResolution, ProjectSyncReason, ProjectSyncResult, RecoveredProject, RecoveredWorkerJob };
44
45
  export { ApiError, ApiKeyAuthManager, ChatJobError, ChatStream, ChatToolsApi, CreativeWorkflowsApi, CreativeWorkflowTemplatesApi, ReplayApi, CurrentAccount, Job, Project, PROJECT_LOST_ORIGINAL_CODE, SogniTools, SUBSCRIPTION_ERROR_CODES, isProjectLostError, isSubscriptionLimitError, isSogniToolCall, parseCreativeWorkflowSseChunk, parseToolCallArguments, projectParamsFromRecoveredProject };
45
46
  export interface SogniClientConfig {
@@ -160,6 +161,14 @@ export declare class SogniClient {
160
161
  * identity.
161
162
  */
162
163
  replay: ReplayApi;
164
+ /**
165
+ * Admin-authored in-app announcements (`/v1/announcements`). Live delivery is
166
+ * the `appAlert` socket event — opt in with
167
+ * `socketEventSubscriptions: { appAlert: true }`. This group covers the two
168
+ * moments the socket cannot: reading what is live at launch, and dismissing an
169
+ * announcement per account so it stays dismissed on every device.
170
+ */
171
+ announcements: AnnouncementsApi;
163
172
  apiClient: ApiClient;
164
173
  private constructor();
165
174
  get currentAccount(): CurrentAccount;
package/dist/index.js CHANGED
@@ -89,13 +89,14 @@ const index_js_7 = __importDefault(require("./Stats/index.js"));
89
89
  // Replay records
90
90
  const index_js_8 = __importDefault(require("./Replay/index.js"));
91
91
  exports.ReplayApi = index_js_8.default;
92
+ const index_js_9 = __importDefault(require("./Announcements/index.js"));
92
93
  // Base Types
93
94
  const ErrorData_js_1 = require("./types/ErrorData.js");
94
95
  Object.defineProperty(exports, "SUBSCRIPTION_ERROR_CODES", { enumerable: true, get: function () { return ErrorData_js_1.SUBSCRIPTION_ERROR_CODES; } });
95
96
  const isSubscriptionLimitError_js_1 = __importDefault(require("./lib/isSubscriptionLimitError.js"));
96
97
  exports.isSubscriptionLimitError = isSubscriptionLimitError_js_1.default;
97
- const index_js_9 = require("./lib/AuthManager/index.js");
98
- Object.defineProperty(exports, "ApiKeyAuthManager", { enumerable: true, get: function () { return index_js_9.ApiKeyAuthManager; } });
98
+ const index_js_10 = require("./lib/AuthManager/index.js");
99
+ Object.defineProperty(exports, "ApiKeyAuthManager", { enumerable: true, get: function () { return index_js_10.ApiKeyAuthManager; } });
99
100
  class SogniClient {
100
101
  constructor(config) {
101
102
  this.account = new index_js_1.default(config);
@@ -104,6 +105,7 @@ class SogniClient {
104
105
  this.chat = new index_js_4.default(config, this.projects);
105
106
  this.workflows = new index_js_5.default(config);
106
107
  this.replay = new index_js_8.default(config);
108
+ this.announcements = new index_js_9.default(config);
107
109
  this.apiClient = config.client;
108
110
  }
109
111
  get currentAccount() {
@@ -117,7 +119,7 @@ class SogniClient {
117
119
  setTokens(tokens) {
118
120
  return __awaiter(this, void 0, void 0, function* () {
119
121
  const auth = this.apiClient.auth;
120
- if (!(auth instanceof index_js_9.TokenAuthManager)) {
122
+ if (!(auth instanceof index_js_10.TokenAuthManager)) {
121
123
  throw new Error('setTokens can only be used with token authentication');
122
124
  }
123
125
  yield auth.authenticate(tokens);
@@ -132,7 +134,7 @@ class SogniClient {
132
134
  checkAuth() {
133
135
  return __awaiter(this, void 0, void 0, function* () {
134
136
  const auth = this.apiClient.auth;
135
- if (!(auth instanceof index_js_9.CookieAuthManager)) {
137
+ if (!(auth instanceof index_js_10.CookieAuthManager)) {
136
138
  throw Error('This method should only be called when using cookie auth');
137
139
  }
138
140
  try {
package/dist/index.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,cAAc;AACd,kEAA4C;AAC5C,oFAAyD;AAgZvD,yBAhZK,2BAAc,CAgZL;AA/YhB,YAAY;AACZ,iEAAwE;AAsYtE,yFAtYkB,mBAAQ,OAsYlB;AArXV,QAAQ;AACR,6DAAyE;AACzE,4EAAiD;AACjD,eAAe;AACf,mEAA8C;AAC9C,+DAAmD;AAyXjD,cAzXK,gBAAG,CAyXL;AAxXL,uEAA+D;AAyX7D,kBAzXK,oBAAO,CAyXL;AAhVT,wDAIgC;AA6U9B,2GAhVA,wCAA0B,OAgVA;AAG1B,mGAlVA,gCAAkB,OAkVA;AAKlB,kHAtVA,+CAAiC,OAsVA;AA1TnC,WAAW;AACX,+DAAsC;AACtC,6EAA0E;AAuSxE,uBAvSK,yBAAY,CAuSL;AAtSd,yEAA8C;AAuS5C,qBAvSK,uBAAU,CAuSL;AAtSZ,uEAA+C;AAuS7C,uBAvSK,sBAAY,CAuSL;AA7Pd,8CAAsF;AAqQpF,2FArQO,qBAAU,OAqQP;AAIV,gGAzQmB,0BAAe,OAyQnB;AAEf,uGA3QoC,iCAAsB,OA2QpC;AA1QxB,yBAAyB;AACzB,yEAAmG;AA4PjG,+BA5PK,kBAAoB,CA4PL;AAYpB,8GAxQ6B,wCAA6B,OAwQ7B;AAvQ/B,sFAAkF;AA4PhF,uCA5PK,kBAA4B,CA4PL;AA1N9B,YAAY;AACZ,gEAAwC;AACxC,iBAAiB;AACjB,iEAA0C;AAwNxC,oBAxNK,kBAAS,CAwNL;AA9MX,aAAa;AACb,uDAA2E;AAmNzE,yGAnNkB,uCAAwB,OAmNlB;AAjN1B,oGAAyE;AAmNvE,mCAnNK,qCAAwB,CAmNL;AAjN1B,yDAKoC;AA8LlC,kGAlMA,4BAAiB,OAkMA;AAgHnB,MAAa,WAAW;IA+BtB,YAAoB,MAAiB;QACnC,IAAI,CAAC,OAAO,GAAG,IAAI,kBAAU,CAAC,MAAM,CAAC,CAAC;QACtC,IAAI,CAAC,QAAQ,GAAG,IAAI,kBAAW,CAAC,MAAM,CAAC,CAAC;QACxC,IAAI,CAAC,KAAK,GAAG,IAAI,kBAAQ,CAAC,MAAM,CAAC,CAAC;QAClC,IAAI,CAAC,IAAI,GAAG,IAAI,kBAAO,CAAC,MAAM,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;QAC/C,IAAI,CAAC,SAAS,GAAG,IAAI,kBAAoB,CAAC,MAAM,CAAC,CAAC;QAClD,IAAI,CAAC,MAAM,GAAG,IAAI,kBAAS,CAAC,MAAM,CAAC,CAAC;QAEpC,IAAI,CAAC,SAAS,GAAG,MAAM,CAAC,MAAM,CAAC;IACjC,CAAC;IAED,IAAI,cAAc;QAChB,OAAO,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC;IACrC,CAAC;IAED;;;;OAIG;IACG,SAAS,CAAC,MAAqB;;YACnC,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;YACjC,IAAI,CAAC,CAAC,IAAI,YAAY,2BAAgB,CAAC,EAAE,CAAC;gBACxC,MAAM,IAAI,KAAK,CAAC,sDAAsD,CAAC,CAAC;YAC1E,CAAC;YACD,MAAM,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC;YAChC,MAAM,IAAI,CAAC,OAAO,CAAC,EAAE,EAAE,CAAC;QAC1B,CAAC;KAAA;IAED;;;;OAIG;IACG,SAAS;;YACb,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;YACjC,IAAI,CAAC,CAAC,IAAI,YAAY,4BAAiB,CAAC,EAAE,CAAC;gBACzC,MAAM,KAAK,CAAC,0DAA0D,CAAC,CAAC;YAC1E,CAAC;YACD,IAAI,CAAC;gBACH,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,CAAsB,gBAAgB,CAAC,CAAC;gBACjF,MAAM,IAAI,CAAC,YAAY,EAAE,CAAC;gBAC1B,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC;oBAC1B,QAAQ,EAAE,GAAG,CAAC,IAAI,CAAC,QAAQ;oBAC3B,KAAK,EAAE,GAAG,CAAC,IAAI,CAAC,YAAY;oBAC5B,aAAa,EAAE,GAAG,CAAC,IAAI,CAAC,aAAa;iBACtC,CAAC,CAAC;gBACH,OAAO,IAAI,CAAC;YACd,CAAC;YAAC,OAAO,CAAC,EAAE,CAAC;gBACX,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,6BAA6B,CAAC,CAAC;gBAC1D,OAAO,KAAK,CAAC;YACf,CAAC;QACH,CAAC;KAAA;IAED;;;OAGG;IACH,OAAO;QACL,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,CAAC;IAC3B,CAAC;IAED;;;;;OAKG;IACG,2BAA2B,CAAC,MAAoC;;YACpE,MAAM,IAAI,CAAC,SAAS,CAAC,2BAA2B,CAAC,MAAM,CAAC,CAAC;QAC3D,CAAC;KAAA;IAED;;;OAGG;IACH,MAAM,CAAO,cAAc,CAAC,MAAyB;;YACnD,MAAM,YAAY,GAAG,MAAM,CAAC,YAAY,IAAI,sBAAsB,CAAC;YACnE,MAAM,cAAc,GAAG,MAAM,CAAC,cAAc,IAAI,uBAAuB,CAAC;YACxE,MAAM,OAAO,GAAG,MAAM,CAAC,OAAO,IAAI,MAAM,CAAC;YACzC,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,IAAI,IAAI,gCAAa,CAAC,MAAM,CAAC,QAAQ,IAAI,MAAM,CAAC,CAAC;YAC7E,MAAM,SAAS,GAAG,MAAM,CAAC,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC;YACxE,MAAM,QAAQ,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,QAAQ,IAAI,OAAO,CAAC;YAEvE,MAAM,MAAM,GAAG,IAAI,kBAAS,CAAC;gBAC3B,OAAO,EAAE,YAAY;gBACrB,SAAS,EAAE,cAAc;gBACzB,KAAK,EAAE,MAAM,CAAC,KAAK;gBACnB,SAAS,EAAE,MAAM,CAAC,SAAS;gBAC3B,WAAW,EAAE,MAAM,CAAC,WAAW;gBAC/B,wBAAwB,EAAE,MAAM,CAAC,wBAAwB;gBACzD,WAAW,EAAE,OAAO;gBACpB,MAAM;gBACN,QAAQ;gBACR,aAAa,EAAE,MAAM,CAAC,aAAa;gBACnC,aAAa,EAAE,MAAM,CAAC,aAAa;aACpC,CAAC,CAAC;YACH,MAAM,MAAM,GAAG,IAAI,yBAAY,CAAC;gBAC9B,IAAI,EAAE,SAAS,CAAC,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,UAAU;gBAC9C,OAAO,EAAE,GAAG;gBACZ,OAAO,EAAE,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM;aACtC,CAAC,CAAC;YACH,MAAM,WAAW,GAAG,IAAI,WAAW,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC;YAExD,6CAA6C;YAC7C,IAAI,MAAM,CAAC,MAAM,EAAE,CAAC;gBAClB,MAAM,IAAI,GAAG,MAAM,CAAC,IAAyB,CAAC;gBAC9C,MAAM,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;YACzC,CAAC;YAED,OAAO,WAAW,CAAC;QACrB,CAAC;KAAA;CACF;AA/ID,kCA+IC"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,cAAc;AACd,kEAA4C;AAC5C,oFAAyD;AAmZvD,yBAnZK,2BAAc,CAmZL;AAlZhB,YAAY;AACZ,iEAAwE;AAyYtE,yFAzYkB,mBAAQ,OAyYlB;AAxXV,QAAQ;AACR,6DAAyE;AACzE,4EAAiD;AACjD,eAAe;AACf,mEAA8C;AAC9C,+DAAmD;AA4XjD,cA5XK,gBAAG,CA4XL;AA3XL,uEAA+D;AA4X7D,kBA5XK,oBAAO,CA4XL;AAnVT,wDAIgC;AAgV9B,2GAnVA,wCAA0B,OAmVA;AAG1B,mGArVA,gCAAkB,OAqVA;AAKlB,kHAzVA,+CAAiC,OAyVA;AA7TnC,WAAW;AACX,+DAAsC;AACtC,6EAA0E;AA0SxE,uBA1SK,yBAAY,CA0SL;AAzSd,yEAA8C;AA0S5C,qBA1SK,uBAAU,CA0SL;AAzSZ,uEAA+C;AA0S7C,uBA1SK,sBAAY,CA0SL;AAhQd,8CAAsF;AAwQpF,2FAxQO,qBAAU,OAwQP;AAIV,gGA5QmB,0BAAe,OA4QnB;AAEf,uGA9QoC,iCAAsB,OA8QpC;AA7QxB,yBAAyB;AACzB,yEAAmG;AA+PjG,+BA/PK,kBAAoB,CA+PL;AAYpB,8GA3Q6B,wCAA6B,OA2Q7B;AA1Q/B,sFAAkF;AA+PhF,uCA/PK,kBAA4B,CA+PL;AA7N9B,YAAY;AACZ,gEAAwC;AACxC,iBAAiB;AACjB,iEAA0C;AA2NxC,oBA3NK,kBAAS,CA2NL;AA1NX,wEAAwD;AAUxD,aAAa;AACb,uDAA2E;AAqNzE,yGArNkB,uCAAwB,OAqNlB;AAnN1B,oGAAyE;AAqNvE,mCArNK,qCAAwB,CAqNL;AAnN1B,0DAKoC;AAgMlC,kGApMA,6BAAiB,OAoMA;AAgHnB,MAAa,WAAW;IAuCtB,YAAoB,MAAiB;QACnC,IAAI,CAAC,OAAO,GAAG,IAAI,kBAAU,CAAC,MAAM,CAAC,CAAC;QACtC,IAAI,CAAC,QAAQ,GAAG,IAAI,kBAAW,CAAC,MAAM,CAAC,CAAC;QACxC,IAAI,CAAC,KAAK,GAAG,IAAI,kBAAQ,CAAC,MAAM,CAAC,CAAC;QAClC,IAAI,CAAC,IAAI,GAAG,IAAI,kBAAO,CAAC,MAAM,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;QAC/C,IAAI,CAAC,SAAS,GAAG,IAAI,kBAAoB,CAAC,MAAM,CAAC,CAAC;QAClD,IAAI,CAAC,MAAM,GAAG,IAAI,kBAAS,CAAC,MAAM,CAAC,CAAC;QACpC,IAAI,CAAC,aAAa,GAAG,IAAI,kBAAgB,CAAC,MAAM,CAAC,CAAC;QAElD,IAAI,CAAC,SAAS,GAAG,MAAM,CAAC,MAAM,CAAC;IACjC,CAAC;IAED,IAAI,cAAc;QAChB,OAAO,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC;IACrC,CAAC;IAED;;;;OAIG;IACG,SAAS,CAAC,MAAqB;;YACnC,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;YACjC,IAAI,CAAC,CAAC,IAAI,YAAY,4BAAgB,CAAC,EAAE,CAAC;gBACxC,MAAM,IAAI,KAAK,CAAC,sDAAsD,CAAC,CAAC;YAC1E,CAAC;YACD,MAAM,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC;YAChC,MAAM,IAAI,CAAC,OAAO,CAAC,EAAE,EAAE,CAAC;QAC1B,CAAC;KAAA;IAED;;;;OAIG;IACG,SAAS;;YACb,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;YACjC,IAAI,CAAC,CAAC,IAAI,YAAY,6BAAiB,CAAC,EAAE,CAAC;gBACzC,MAAM,KAAK,CAAC,0DAA0D,CAAC,CAAC;YAC1E,CAAC;YACD,IAAI,CAAC;gBACH,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,CAAsB,gBAAgB,CAAC,CAAC;gBACjF,MAAM,IAAI,CAAC,YAAY,EAAE,CAAC;gBAC1B,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC;oBAC1B,QAAQ,EAAE,GAAG,CAAC,IAAI,CAAC,QAAQ;oBAC3B,KAAK,EAAE,GAAG,CAAC,IAAI,CAAC,YAAY;oBAC5B,aAAa,EAAE,GAAG,CAAC,IAAI,CAAC,aAAa;iBACtC,CAAC,CAAC;gBACH,OAAO,IAAI,CAAC;YACd,CAAC;YAAC,OAAO,CAAC,EAAE,CAAC;gBACX,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,6BAA6B,CAAC,CAAC;gBAC1D,OAAO,KAAK,CAAC;YACf,CAAC;QACH,CAAC;KAAA;IAED;;;OAGG;IACH,OAAO;QACL,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,CAAC;IAC3B,CAAC;IAED;;;;;OAKG;IACG,2BAA2B,CAAC,MAAoC;;YACpE,MAAM,IAAI,CAAC,SAAS,CAAC,2BAA2B,CAAC,MAAM,CAAC,CAAC;QAC3D,CAAC;KAAA;IAED;;;OAGG;IACH,MAAM,CAAO,cAAc,CAAC,MAAyB;;YACnD,MAAM,YAAY,GAAG,MAAM,CAAC,YAAY,IAAI,sBAAsB,CAAC;YACnE,MAAM,cAAc,GAAG,MAAM,CAAC,cAAc,IAAI,uBAAuB,CAAC;YACxE,MAAM,OAAO,GAAG,MAAM,CAAC,OAAO,IAAI,MAAM,CAAC;YACzC,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,IAAI,IAAI,gCAAa,CAAC,MAAM,CAAC,QAAQ,IAAI,MAAM,CAAC,CAAC;YAC7E,MAAM,SAAS,GAAG,MAAM,CAAC,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC;YACxE,MAAM,QAAQ,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,QAAQ,IAAI,OAAO,CAAC;YAEvE,MAAM,MAAM,GAAG,IAAI,kBAAS,CAAC;gBAC3B,OAAO,EAAE,YAAY;gBACrB,SAAS,EAAE,cAAc;gBACzB,KAAK,EAAE,MAAM,CAAC,KAAK;gBACnB,SAAS,EAAE,MAAM,CAAC,SAAS;gBAC3B,WAAW,EAAE,MAAM,CAAC,WAAW;gBAC/B,wBAAwB,EAAE,MAAM,CAAC,wBAAwB;gBACzD,WAAW,EAAE,OAAO;gBACpB,MAAM;gBACN,QAAQ;gBACR,aAAa,EAAE,MAAM,CAAC,aAAa;gBACnC,aAAa,EAAE,MAAM,CAAC,aAAa;aACpC,CAAC,CAAC;YACH,MAAM,MAAM,GAAG,IAAI,yBAAY,CAAC;gBAC9B,IAAI,EAAE,SAAS,CAAC,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,UAAU;gBAC9C,OAAO,EAAE,GAAG;gBACZ,OAAO,EAAE,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM;aACtC,CAAC,CAAC;YACH,MAAM,WAAW,GAAG,IAAI,WAAW,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC;YAExD,6CAA6C;YAC7C,IAAI,MAAM,CAAC,MAAM,EAAE,CAAC;gBAClB,MAAM,IAAI,GAAG,MAAM,CAAC,IAAyB,CAAC;gBAC9C,MAAM,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;YACzC,CAAC;YAED,OAAO,WAAW,CAAC;QACrB,CAAC;KAAA;CACF;AAxJD,kCAwJC"}
package/dist/version.d.ts CHANGED
@@ -1 +1 @@
1
- export declare const LIB_VERSION = "5.27.1";
1
+ export declare const LIB_VERSION = "5.29.0";
package/dist/version.js CHANGED
@@ -3,5 +3,5 @@ Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.LIB_VERSION = void 0;
4
4
  // AUTO-GENERATED by scripts/generate-version.mjs — do not edit.
5
5
  // Source of truth: package.json version.
6
- exports.LIB_VERSION = '5.27.1';
6
+ exports.LIB_VERSION = '5.29.0';
7
7
  //# sourceMappingURL=version.js.map
@@ -0,0 +1,54 @@
1
+ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
2
+ function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
3
+ return new (P || (P = Promise))(function (resolve, reject) {
4
+ function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
5
+ function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
6
+ function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
7
+ step((generator = generator.apply(thisArg, _arguments || [])).next());
8
+ });
9
+ };
10
+ import ApiGroup from '../ApiGroup.js';
11
+ /**
12
+ * Admin-authored in-app announcements — pinned banners and toasts composed in
13
+ * the Sogni Admin Portal.
14
+ *
15
+ * The socket is the primary delivery path: subscribe to the `appAlert` event
16
+ * (opt in with `socketEventSubscriptions: { appAlert: true }`) and the server
17
+ * pushes announcements live AND replays any live pinned banner on connect, so a
18
+ * user who was offline when one published still receives it.
19
+ *
20
+ * This REST surface covers the two moments the socket cannot:
21
+ * - `active()` at launch, before the socket has authenticated
22
+ * - `dismiss()`, which must persist per ACCOUNT rather than per device so a
23
+ * banner dismissed on one client stays dismissed on the next
24
+ *
25
+ * Full contract: `docs/app-alert-contract.md` in sogni-socket.
26
+ */
27
+ class AnnouncementsApi extends ApiGroup {
28
+ /**
29
+ * Announcements currently live for the signed-in account, minus anything the
30
+ * account has already dismissed.
31
+ *
32
+ * @param platform Optional `appSource` for this client (e.g. `'sogni-mac'`).
33
+ * Platform-scoped announcements only match when it is supplied — an
34
+ * announcement narrowed to macOS is deliberately withheld from a caller
35
+ * that cannot say what it is, rather than sent to everyone.
36
+ */
37
+ active(platform) {
38
+ return __awaiter(this, void 0, void 0, function* () {
39
+ const res = yield this.client.rest.get('/v1/announcements/active', platform ? { platform } : undefined);
40
+ return res.data.announcements || [];
41
+ });
42
+ }
43
+ /**
44
+ * Dismiss one announcement for the signed-in account, on every device.
45
+ * Call this when the user closes a pinned announcement.
46
+ */
47
+ dismiss(id) {
48
+ return __awaiter(this, void 0, void 0, function* () {
49
+ yield this.client.rest.post(`/v1/announcements/${encodeURIComponent(id)}/dismiss`);
50
+ });
51
+ }
52
+ }
53
+ export default AnnouncementsApi;
54
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/Announcements/index.ts"],"names":[],"mappings":";;;;;;;;;AAAA,OAAO,QAAQ,MAAM,gBAAgB,CAAC;AAItC;;;;;;;;;;;;;;;GAeG;AACH,MAAM,gBAAiB,SAAQ,QAAQ;IACrC;;;;;;;;OAQG;IACG,MAAM,CAAC,QAAiB;;YAC5B,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CACpC,0BAA0B,EAC1B,QAAQ,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAC,CAAC,SAAS,CACpC,CAAC;YACF,OAAO,GAAG,CAAC,IAAI,CAAC,aAAa,IAAI,EAAE,CAAC;QACtC,CAAC;KAAA;IAED;;;OAGG;IACG,OAAO,CAAC,EAAU;;YACtB,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CACzB,qBAAqB,kBAAkB,CAAC,EAAE,CAAC,UAAU,CACtD,CAAC;QACJ,CAAC;KAAA;CACF;AAED,eAAe,gBAAgB,CAAC"}
package/dist-esm/index.js CHANGED
@@ -33,6 +33,7 @@ import CreativeWorkflowTemplatesApi from './CreativeWorkflows/Templates/index.js
33
33
  import StatsApi from './Stats/index.js';
34
34
  // Replay records
35
35
  import ReplayApi from './Replay/index.js';
36
+ import AnnouncementsApi from './Announcements/index.js';
36
37
  // Base Types
37
38
  import { SUBSCRIPTION_ERROR_CODES } from './types/ErrorData.js';
38
39
  import isSubscriptionLimitError from './lib/isSubscriptionLimitError.js';
@@ -46,6 +47,7 @@ export class SogniClient {
46
47
  this.chat = new ChatApi(config, this.projects);
47
48
  this.workflows = new CreativeWorkflowsApi(config);
48
49
  this.replay = new ReplayApi(config);
50
+ this.announcements = new AnnouncementsApi(config);
49
51
  this.apiClient = config.client;
50
52
  }
51
53
  get currentAccount() {
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;AAAA,cAAc;AACd,OAAO,UAAU,MAAM,oBAAoB,CAAC;AAC5C,OAAO,cAAc,MAAM,6BAA6B,CAAC;AACzD,YAAY;AACZ,OAAO,SAAS,EAAE,EAAE,QAAQ,EAAe,MAAM,sBAAsB,CAAC;AAiBxE,QAAQ;AACR,OAAO,EAAE,aAAa,EAAoB,MAAM,wBAAwB,CAAC;AACzE,OAAO,YAAY,MAAM,uBAAuB,CAAC;AACjD,eAAe;AACf,OAAO,WAAW,MAAM,qBAAqB,CAAC;AAC9C,OAAO,GAAkB,MAAM,mBAAmB,CAAC;AACnD,OAAO,OAA0B,MAAM,uBAAuB,CAAC;AAyC/D,OAAO,EACL,0BAA0B,EAC1B,kBAAkB,EAClB,iCAAiC,EAClC,MAAM,wBAAwB,CAAC;AA2BhC,WAAW;AACX,OAAO,OAAO,MAAM,iBAAiB,CAAC;AACtC,OAAO,YAAoC,MAAM,wBAAwB,CAAC;AAC1E,OAAO,UAAU,MAAM,sBAAsB,CAAC;AAC9C,OAAO,YAAY,MAAM,qBAAqB,CAAC;AA0C/C,OAAO,EAAE,UAAU,EAAE,eAAe,EAAE,sBAAsB,EAAE,MAAM,iBAAiB,CAAC;AACtF,yBAAyB;AACzB,OAAO,oBAAoB,EAAE,EAAE,6BAA6B,EAAE,MAAM,8BAA8B,CAAC;AACnG,OAAO,4BAA4B,MAAM,wCAAwC,CAAC;AAkClF,YAAY;AACZ,OAAO,QAAQ,MAAM,kBAAkB,CAAC;AACxC,iBAAiB;AACjB,OAAO,SAAS,MAAM,mBAAmB,CAAC;AAU1C,aAAa;AACb,OAAkB,EAAE,wBAAwB,EAAE,MAAM,sBAAsB,CAAC;AAE3E,OAAO,wBAAwB,MAAM,mCAAmC,CAAC;AAEzE,OAAO,EACL,iBAAiB,EACjB,iBAAiB,EAEjB,gBAAgB,EACjB,MAAM,4BAA4B,CAAC;AA4LpC,OAAO,EACL,QAAQ,EACR,iBAAiB,EACjB,YAAY,EACZ,UAAU,EACV,YAAY,EACZ,oBAAoB,EACpB,4BAA4B,EAC5B,SAAS,EACT,cAAc,EACd,GAAG,EACH,OAAO,EACP,0BAA0B,EAC1B,UAAU,EACV,wBAAwB,EACxB,kBAAkB,EAClB,wBAAwB,EACxB,eAAe,EACf,6BAA6B,EAC7B,sBAAsB,EACtB,iCAAiC,EAClC,CAAC;AA6FF,MAAM,OAAO,WAAW;IA+BtB,YAAoB,MAAiB;QACnC,IAAI,CAAC,OAAO,GAAG,IAAI,UAAU,CAAC,MAAM,CAAC,CAAC;QACtC,IAAI,CAAC,QAAQ,GAAG,IAAI,WAAW,CAAC,MAAM,CAAC,CAAC;QACxC,IAAI,CAAC,KAAK,GAAG,IAAI,QAAQ,CAAC,MAAM,CAAC,CAAC;QAClC,IAAI,CAAC,IAAI,GAAG,IAAI,OAAO,CAAC,MAAM,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;QAC/C,IAAI,CAAC,SAAS,GAAG,IAAI,oBAAoB,CAAC,MAAM,CAAC,CAAC;QAClD,IAAI,CAAC,MAAM,GAAG,IAAI,SAAS,CAAC,MAAM,CAAC,CAAC;QAEpC,IAAI,CAAC,SAAS,GAAG,MAAM,CAAC,MAAM,CAAC;IACjC,CAAC;IAED,IAAI,cAAc;QAChB,OAAO,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC;IACrC,CAAC;IAED;;;;OAIG;IACG,SAAS,CAAC,MAAqB;;YACnC,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;YACjC,IAAI,CAAC,CAAC,IAAI,YAAY,gBAAgB,CAAC,EAAE,CAAC;gBACxC,MAAM,IAAI,KAAK,CAAC,sDAAsD,CAAC,CAAC;YAC1E,CAAC;YACD,MAAM,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC;YAChC,MAAM,IAAI,CAAC,OAAO,CAAC,EAAE,EAAE,CAAC;QAC1B,CAAC;KAAA;IAED;;;;OAIG;IACG,SAAS;;YACb,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;YACjC,IAAI,CAAC,CAAC,IAAI,YAAY,iBAAiB,CAAC,EAAE,CAAC;gBACzC,MAAM,KAAK,CAAC,0DAA0D,CAAC,CAAC;YAC1E,CAAC;YACD,IAAI,CAAC;gBACH,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,CAAsB,gBAAgB,CAAC,CAAC;gBACjF,MAAM,IAAI,CAAC,YAAY,EAAE,CAAC;gBAC1B,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC;oBAC1B,QAAQ,EAAE,GAAG,CAAC,IAAI,CAAC,QAAQ;oBAC3B,KAAK,EAAE,GAAG,CAAC,IAAI,CAAC,YAAY;oBAC5B,aAAa,EAAE,GAAG,CAAC,IAAI,CAAC,aAAa;iBACtC,CAAC,CAAC;gBACH,OAAO,IAAI,CAAC;YACd,CAAC;YAAC,OAAO,CAAC,EAAE,CAAC;gBACX,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,6BAA6B,CAAC,CAAC;gBAC1D,OAAO,KAAK,CAAC;YACf,CAAC;QACH,CAAC;KAAA;IAED;;;OAGG;IACH,OAAO;QACL,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,CAAC;IAC3B,CAAC;IAED;;;;;OAKG;IACG,2BAA2B,CAAC,MAAoC;;YACpE,MAAM,IAAI,CAAC,SAAS,CAAC,2BAA2B,CAAC,MAAM,CAAC,CAAC;QAC3D,CAAC;KAAA;IAED;;;OAGG;IACH,MAAM,CAAO,cAAc,CAAC,MAAyB;;YACnD,MAAM,YAAY,GAAG,MAAM,CAAC,YAAY,IAAI,sBAAsB,CAAC;YACnE,MAAM,cAAc,GAAG,MAAM,CAAC,cAAc,IAAI,uBAAuB,CAAC;YACxE,MAAM,OAAO,GAAG,MAAM,CAAC,OAAO,IAAI,MAAM,CAAC;YACzC,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,IAAI,IAAI,aAAa,CAAC,MAAM,CAAC,QAAQ,IAAI,MAAM,CAAC,CAAC;YAC7E,MAAM,SAAS,GAAG,MAAM,CAAC,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC;YACxE,MAAM,QAAQ,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,QAAQ,IAAI,OAAO,CAAC;YAEvE,MAAM,MAAM,GAAG,IAAI,SAAS,CAAC;gBAC3B,OAAO,EAAE,YAAY;gBACrB,SAAS,EAAE,cAAc;gBACzB,KAAK,EAAE,MAAM,CAAC,KAAK;gBACnB,SAAS,EAAE,MAAM,CAAC,SAAS;gBAC3B,WAAW,EAAE,MAAM,CAAC,WAAW;gBAC/B,wBAAwB,EAAE,MAAM,CAAC,wBAAwB;gBACzD,WAAW,EAAE,OAAO;gBACpB,MAAM;gBACN,QAAQ;gBACR,aAAa,EAAE,MAAM,CAAC,aAAa;gBACnC,aAAa,EAAE,MAAM,CAAC,aAAa;aACpC,CAAC,CAAC;YACH,MAAM,MAAM,GAAG,IAAI,YAAY,CAAC;gBAC9B,IAAI,EAAE,SAAS,CAAC,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,UAAU;gBAC9C,OAAO,EAAE,GAAG;gBACZ,OAAO,EAAE,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM;aACtC,CAAC,CAAC;YACH,MAAM,WAAW,GAAG,IAAI,WAAW,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC;YAExD,6CAA6C;YAC7C,IAAI,MAAM,CAAC,MAAM,EAAE,CAAC;gBAClB,MAAM,IAAI,GAAG,MAAM,CAAC,IAAyB,CAAC;gBAC9C,MAAM,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;YACzC,CAAC;YAED,OAAO,WAAW,CAAC;QACrB,CAAC;KAAA;CACF"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;AAAA,cAAc;AACd,OAAO,UAAU,MAAM,oBAAoB,CAAC;AAC5C,OAAO,cAAc,MAAM,6BAA6B,CAAC;AACzD,YAAY;AACZ,OAAO,SAAS,EAAE,EAAE,QAAQ,EAAe,MAAM,sBAAsB,CAAC;AAiBxE,QAAQ;AACR,OAAO,EAAE,aAAa,EAAoB,MAAM,wBAAwB,CAAC;AACzE,OAAO,YAAY,MAAM,uBAAuB,CAAC;AACjD,eAAe;AACf,OAAO,WAAW,MAAM,qBAAqB,CAAC;AAC9C,OAAO,GAAkB,MAAM,mBAAmB,CAAC;AACnD,OAAO,OAA0B,MAAM,uBAAuB,CAAC;AAyC/D,OAAO,EACL,0BAA0B,EAC1B,kBAAkB,EAClB,iCAAiC,EAClC,MAAM,wBAAwB,CAAC;AA2BhC,WAAW;AACX,OAAO,OAAO,MAAM,iBAAiB,CAAC;AACtC,OAAO,YAAoC,MAAM,wBAAwB,CAAC;AAC1E,OAAO,UAAU,MAAM,sBAAsB,CAAC;AAC9C,OAAO,YAAY,MAAM,qBAAqB,CAAC;AA0C/C,OAAO,EAAE,UAAU,EAAE,eAAe,EAAE,sBAAsB,EAAE,MAAM,iBAAiB,CAAC;AACtF,yBAAyB;AACzB,OAAO,oBAAoB,EAAE,EAAE,6BAA6B,EAAE,MAAM,8BAA8B,CAAC;AACnG,OAAO,4BAA4B,MAAM,wCAAwC,CAAC;AAkClF,YAAY;AACZ,OAAO,QAAQ,MAAM,kBAAkB,CAAC;AACxC,iBAAiB;AACjB,OAAO,SAAS,MAAM,mBAAmB,CAAC;AAC1C,OAAO,gBAAgB,MAAM,0BAA0B,CAAC;AAUxD,aAAa;AACb,OAAkB,EAAE,wBAAwB,EAAE,MAAM,sBAAsB,CAAC;AAE3E,OAAO,wBAAwB,MAAM,mCAAmC,CAAC;AAEzE,OAAO,EACL,iBAAiB,EACjB,iBAAiB,EAEjB,gBAAgB,EACjB,MAAM,4BAA4B,CAAC;AA8LpC,OAAO,EACL,QAAQ,EACR,iBAAiB,EACjB,YAAY,EACZ,UAAU,EACV,YAAY,EACZ,oBAAoB,EACpB,4BAA4B,EAC5B,SAAS,EACT,cAAc,EACd,GAAG,EACH,OAAO,EACP,0BAA0B,EAC1B,UAAU,EACV,wBAAwB,EACxB,kBAAkB,EAClB,wBAAwB,EACxB,eAAe,EACf,6BAA6B,EAC7B,sBAAsB,EACtB,iCAAiC,EAClC,CAAC;AA6FF,MAAM,OAAO,WAAW;IAuCtB,YAAoB,MAAiB;QACnC,IAAI,CAAC,OAAO,GAAG,IAAI,UAAU,CAAC,MAAM,CAAC,CAAC;QACtC,IAAI,CAAC,QAAQ,GAAG,IAAI,WAAW,CAAC,MAAM,CAAC,CAAC;QACxC,IAAI,CAAC,KAAK,GAAG,IAAI,QAAQ,CAAC,MAAM,CAAC,CAAC;QAClC,IAAI,CAAC,IAAI,GAAG,IAAI,OAAO,CAAC,MAAM,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;QAC/C,IAAI,CAAC,SAAS,GAAG,IAAI,oBAAoB,CAAC,MAAM,CAAC,CAAC;QAClD,IAAI,CAAC,MAAM,GAAG,IAAI,SAAS,CAAC,MAAM,CAAC,CAAC;QACpC,IAAI,CAAC,aAAa,GAAG,IAAI,gBAAgB,CAAC,MAAM,CAAC,CAAC;QAElD,IAAI,CAAC,SAAS,GAAG,MAAM,CAAC,MAAM,CAAC;IACjC,CAAC;IAED,IAAI,cAAc;QAChB,OAAO,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC;IACrC,CAAC;IAED;;;;OAIG;IACG,SAAS,CAAC,MAAqB;;YACnC,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;YACjC,IAAI,CAAC,CAAC,IAAI,YAAY,gBAAgB,CAAC,EAAE,CAAC;gBACxC,MAAM,IAAI,KAAK,CAAC,sDAAsD,CAAC,CAAC;YAC1E,CAAC;YACD,MAAM,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC;YAChC,MAAM,IAAI,CAAC,OAAO,CAAC,EAAE,EAAE,CAAC;QAC1B,CAAC;KAAA;IAED;;;;OAIG;IACG,SAAS;;YACb,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;YACjC,IAAI,CAAC,CAAC,IAAI,YAAY,iBAAiB,CAAC,EAAE,CAAC;gBACzC,MAAM,KAAK,CAAC,0DAA0D,CAAC,CAAC;YAC1E,CAAC;YACD,IAAI,CAAC;gBACH,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,CAAsB,gBAAgB,CAAC,CAAC;gBACjF,MAAM,IAAI,CAAC,YAAY,EAAE,CAAC;gBAC1B,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC;oBAC1B,QAAQ,EAAE,GAAG,CAAC,IAAI,CAAC,QAAQ;oBAC3B,KAAK,EAAE,GAAG,CAAC,IAAI,CAAC,YAAY;oBAC5B,aAAa,EAAE,GAAG,CAAC,IAAI,CAAC,aAAa;iBACtC,CAAC,CAAC;gBACH,OAAO,IAAI,CAAC;YACd,CAAC;YAAC,OAAO,CAAC,EAAE,CAAC;gBACX,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,6BAA6B,CAAC,CAAC;gBAC1D,OAAO,KAAK,CAAC;YACf,CAAC;QACH,CAAC;KAAA;IAED;;;OAGG;IACH,OAAO;QACL,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,CAAC;IAC3B,CAAC;IAED;;;;;OAKG;IACG,2BAA2B,CAAC,MAAoC;;YACpE,MAAM,IAAI,CAAC,SAAS,CAAC,2BAA2B,CAAC,MAAM,CAAC,CAAC;QAC3D,CAAC;KAAA;IAED;;;OAGG;IACH,MAAM,CAAO,cAAc,CAAC,MAAyB;;YACnD,MAAM,YAAY,GAAG,MAAM,CAAC,YAAY,IAAI,sBAAsB,CAAC;YACnE,MAAM,cAAc,GAAG,MAAM,CAAC,cAAc,IAAI,uBAAuB,CAAC;YACxE,MAAM,OAAO,GAAG,MAAM,CAAC,OAAO,IAAI,MAAM,CAAC;YACzC,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,IAAI,IAAI,aAAa,CAAC,MAAM,CAAC,QAAQ,IAAI,MAAM,CAAC,CAAC;YAC7E,MAAM,SAAS,GAAG,MAAM,CAAC,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC;YACxE,MAAM,QAAQ,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,QAAQ,IAAI,OAAO,CAAC;YAEvE,MAAM,MAAM,GAAG,IAAI,SAAS,CAAC;gBAC3B,OAAO,EAAE,YAAY;gBACrB,SAAS,EAAE,cAAc;gBACzB,KAAK,EAAE,MAAM,CAAC,KAAK;gBACnB,SAAS,EAAE,MAAM,CAAC,SAAS;gBAC3B,WAAW,EAAE,MAAM,CAAC,WAAW;gBAC/B,wBAAwB,EAAE,MAAM,CAAC,wBAAwB;gBACzD,WAAW,EAAE,OAAO;gBACpB,MAAM;gBACN,QAAQ;gBACR,aAAa,EAAE,MAAM,CAAC,aAAa;gBACnC,aAAa,EAAE,MAAM,CAAC,aAAa;aACpC,CAAC,CAAC;YACH,MAAM,MAAM,GAAG,IAAI,YAAY,CAAC;gBAC9B,IAAI,EAAE,SAAS,CAAC,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,UAAU;gBAC9C,OAAO,EAAE,GAAG;gBACZ,OAAO,EAAE,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM;aACtC,CAAC,CAAC;YACH,MAAM,WAAW,GAAG,IAAI,WAAW,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC;YAExD,6CAA6C;YAC7C,IAAI,MAAM,CAAC,MAAM,EAAE,CAAC;gBAClB,MAAM,IAAI,GAAG,MAAM,CAAC,IAAyB,CAAC;gBAC9C,MAAM,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;YACzC,CAAC;YAED,OAAO,WAAW,CAAC;QACrB,CAAC;KAAA;CACF"}
@@ -1,4 +1,4 @@
1
1
  // AUTO-GENERATED by scripts/generate-version.mjs — do not edit.
2
2
  // Source of truth: package.json version.
3
- export const LIB_VERSION = '5.27.1';
3
+ export const LIB_VERSION = '5.29.0';
4
4
  //# sourceMappingURL=version.js.map
package/package.json CHANGED
@@ -3,7 +3,7 @@
3
3
  "publishConfig": {
4
4
  "access": "public"
5
5
  },
6
- "version": "5.27.1",
6
+ "version": "5.29.0",
7
7
  "engines": {
8
8
  "node": ">=22"
9
9
  },
@@ -0,0 +1,50 @@
1
+ import ApiGroup from '../ApiGroup.js';
2
+ import { ApiResponse } from '../ApiClient/index.js';
3
+ import type { AppAlert } from '../ApiClient/WebSocketClient/events.js';
4
+
5
+ /**
6
+ * Admin-authored in-app announcements — pinned banners and toasts composed in
7
+ * the Sogni Admin Portal.
8
+ *
9
+ * The socket is the primary delivery path: subscribe to the `appAlert` event
10
+ * (opt in with `socketEventSubscriptions: { appAlert: true }`) and the server
11
+ * pushes announcements live AND replays any live pinned banner on connect, so a
12
+ * user who was offline when one published still receives it.
13
+ *
14
+ * This REST surface covers the two moments the socket cannot:
15
+ * - `active()` at launch, before the socket has authenticated
16
+ * - `dismiss()`, which must persist per ACCOUNT rather than per device so a
17
+ * banner dismissed on one client stays dismissed on the next
18
+ *
19
+ * Full contract: `docs/app-alert-contract.md` in sogni-socket.
20
+ */
21
+ class AnnouncementsApi extends ApiGroup {
22
+ /**
23
+ * Announcements currently live for the signed-in account, minus anything the
24
+ * account has already dismissed.
25
+ *
26
+ * @param platform Optional `appSource` for this client (e.g. `'sogni-mac'`).
27
+ * Platform-scoped announcements only match when it is supplied — an
28
+ * announcement narrowed to macOS is deliberately withheld from a caller
29
+ * that cannot say what it is, rather than sent to everyone.
30
+ */
31
+ async active(platform?: string): Promise<AppAlert[]> {
32
+ const res = await this.client.rest.get<ApiResponse<{ announcements: AppAlert[] }>>(
33
+ '/v1/announcements/active',
34
+ platform ? { platform } : undefined
35
+ );
36
+ return res.data.announcements || [];
37
+ }
38
+
39
+ /**
40
+ * Dismiss one announcement for the signed-in account, on every device.
41
+ * Call this when the user closes a pinned announcement.
42
+ */
43
+ async dismiss(id: string): Promise<void> {
44
+ await this.client.rest.post<ApiResponse<{ dismissed: boolean; id: string }>>(
45
+ `/v1/announcements/${encodeURIComponent(id)}/dismiss`
46
+ );
47
+ }
48
+ }
49
+
50
+ export default AnnouncementsApi;
@@ -188,7 +188,11 @@ export type JobETAData = {
188
188
  etaSeconds: number;
189
189
  };
190
190
 
191
- export type JobPreparation = {
191
+ /**
192
+ * A LoRA the job needs is being fetched by the worker before the graph is
193
+ * queued. Arrives on `initiatingModel` and updates as the download progresses.
194
+ */
195
+ export type JobAssetPreparation = {
192
196
  phase: 'downloadingAssets';
193
197
  assetType: 'lora';
194
198
  requested: number;
@@ -199,6 +203,27 @@ export type JobPreparation = {
199
203
  currentProgress?: number;
200
204
  };
201
205
 
206
+ /**
207
+ * The worker is switching models: ComfyUI is moving the previous model out of
208
+ * VRAM (`unloadingModel`) or the next one in (`loadingModel`). Each phase
209
+ * arrives twice on `initiatingModel`, at `start` and at `end`; the `end` step
210
+ * carries how long it took. A switch can run past a minute on a card that was
211
+ * full, so show it rather than a render that appears stuck at 0%.
212
+ */
213
+ export type JobModelPhasePreparation = {
214
+ phase: 'unloadingModel' | 'loadingModel';
215
+ /** The model class ComfyUI names, e.g. "Flux" or "WAN21"; not a display name. */
216
+ model: string;
217
+ step: 'start' | 'end';
218
+ elapsedSec?: number;
219
+ };
220
+
221
+ /**
222
+ * What the worker is doing while a job is `initiating`. Narrow on `phase`
223
+ * before reading the other fields.
224
+ */
225
+ export type JobPreparation = JobAssetPreparation | JobModelPhasePreparation;
226
+
202
227
  export type JobResultData = {
203
228
  jobID: string;
204
229
  imgID: string;
@@ -280,6 +305,62 @@ export type ToastMessage = {
280
305
  stickyID: string;
281
306
  };
282
307
 
308
+ /** A call to action rendered inside an announcement. Always an absolute http(s) URL. */
309
+ export type AppAlertAction = {
310
+ label: string;
311
+ href: string;
312
+ /** Open in a new tab / the system browser rather than routing in-app. */
313
+ external?: boolean;
314
+ };
315
+
316
+ /**
317
+ * An admin-authored in-app announcement, composed in the Sogni Admin Portal.
318
+ *
319
+ * OPT-IN: the server sends this only to clients that asked for it with
320
+ * `socketEventSubscriptions: { appAlert: true }`. A client that does not opt in
321
+ * keeps receiving the same announcement as a plain {@link ToastMessage}, so this
322
+ * event can be adopted at any time without coordination. A client never
323
+ * receives both renderings of one announcement.
324
+ *
325
+ * NOT at-most-once: a live pinned announcement is re-sent on every reconnect
326
+ * while its window is open, so a user who was offline when it published still
327
+ * sees it. Deduplicate on `id`.
328
+ *
329
+ * Full contract: `docs/app-alert-contract.md` in sogni-socket.
330
+ */
331
+ export type AppAlert = {
332
+ /** Stable across redeliveries; also the key for `announcements.dismiss(id)`. */
333
+ id: string;
334
+ /** `toast` is a one-shot; `banner` persists until dismissed or `endsAt`. */
335
+ kind: 'toast' | 'banner';
336
+ severity: 'info' | 'success' | 'warn' | 'danger';
337
+ /**
338
+ * Icon token, never a URL — map it to your own icon set. One of `info`,
339
+ * `success`, `warning`, `error`, `megaphone`, `wrench`, `sparkles`, `gift`,
340
+ * `rocket`, `clock`. Absent means "use the icon for `severity`".
341
+ */
342
+ icon?: string;
343
+ /** Optional `#RRGGBB` tint. Ignoring it must still render a legible alert. */
344
+ accent?: string;
345
+ title: string;
346
+ /**
347
+ * Restricted markdown: paragraphs, bold, italic, inline code, strikethrough,
348
+ * links, and line breaks. No images, no raw HTML, no headings or lists.
349
+ */
350
+ bodyMarkdown: string;
351
+ /** Do not auto-dismiss. Banners are pinned; toasts normally are not. */
352
+ pinned: boolean;
353
+ /** When false, hide the close affordance — it still clears at `endsAt`. */
354
+ dismissible: boolean;
355
+ /** Toasts only. Milliseconds. */
356
+ autoCloseMs?: number;
357
+ actions?: AppAlertAction[];
358
+ /** Epoch ms. */
359
+ startsAt: number;
360
+ /** Epoch ms. Always present for a banner. */
361
+ endsAt?: number;
362
+ };
363
+
283
364
  export type ArtistCancelConfirmation = {
284
365
  didCancel: boolean;
285
366
  error_message?: string;
@@ -419,6 +500,14 @@ export type SocketEventMap = {
419
500
  * @event WebSocketClient#toastMessage - Toast message received
420
501
  */
421
502
  toastMessage: ToastMessage;
503
+ /**
504
+ * @event WebSocketClient#appAlert - Admin announcement received (banner or toast)
505
+ *
506
+ * Opt in with `socketEventSubscriptions: { appAlert: true }`; without it the
507
+ * server sends the same announcement as `toastMessage` instead. Redelivered on
508
+ * reconnect while a pinned announcement is live — deduplicate on `id`.
509
+ */
510
+ appAlert: AppAlert;
422
511
 
423
512
  artistCancelConfirmation: ArtistCancelConfirmation;
424
513
  };
package/src/index.ts CHANGED
@@ -88,7 +88,7 @@ import type {
88
88
  TrialEligibility,
89
89
  TrialReasonCode
90
90
  } from './Account/subscription.types.js';
91
- import type { ToastMessage } from './ApiClient/WebSocketClient/events.js';
91
+ import type { AppAlert, AppAlertAction, ToastMessage } from './ApiClient/WebSocketClient/events.js';
92
92
  import type DataEntity from './lib/DataEntity.js';
93
93
  import {
94
94
  ControlNetName,
@@ -184,6 +184,7 @@ import {
184
184
  import StatsApi from './Stats/index.js';
185
185
  // Replay records
186
186
  import ReplayApi from './Replay/index.js';
187
+ import AnnouncementsApi from './Announcements/index.js';
187
188
  import {
188
189
  GetReplayRecordResult,
189
190
  ListReplayRecordsOptions,
@@ -365,6 +366,8 @@ export type {
365
366
  JobPreparation,
366
367
  RawProject,
367
368
  ToastMessage,
369
+ AppAlert,
370
+ AppAlertAction,
368
371
  DataEntity,
369
372
  InputMedia,
370
373
  AgentAttributionMetadata,
@@ -533,6 +536,14 @@ export class SogniClient {
533
536
  * identity.
534
537
  */
535
538
  replay: ReplayApi;
539
+ /**
540
+ * Admin-authored in-app announcements (`/v1/announcements`). Live delivery is
541
+ * the `appAlert` socket event — opt in with
542
+ * `socketEventSubscriptions: { appAlert: true }`. This group covers the two
543
+ * moments the socket cannot: reading what is live at launch, and dismissing an
544
+ * announcement per account so it stays dismissed on every device.
545
+ */
546
+ announcements: AnnouncementsApi;
536
547
 
537
548
  apiClient: ApiClient;
538
549
 
@@ -543,6 +554,7 @@ export class SogniClient {
543
554
  this.chat = new ChatApi(config, this.projects);
544
555
  this.workflows = new CreativeWorkflowsApi(config);
545
556
  this.replay = new ReplayApi(config);
557
+ this.announcements = new AnnouncementsApi(config);
546
558
 
547
559
  this.apiClient = config.client;
548
560
  }
package/src/version.ts CHANGED
@@ -1,3 +1,3 @@
1
1
  // AUTO-GENERATED by scripts/generate-version.mjs — do not edit.
2
2
  // Source of truth: package.json version.
3
- export const LIB_VERSION = '5.27.1';
3
+ export const LIB_VERSION = '5.29.0';