@veltdev/sdk-staging 6.0.0-beta.9 → 6.0.0

package/app/client/snippyly.model.d.ts

@@ -283,6 +283,16 @@ export declare class Snippyly {
     */
    setDarkMode: (darkMode: boolean) => void;
 
+   /**
+    * Removes (or restores) ALL Velt visual styling at once — headless mode.
+    * By default a derived "functional-only" layer is kept so Velt UI retains
+    * its layout, positioning and show/hide behavior. Pass
+    * `keepFunctionalStyles: false` for total removal. Fully reversible.
+    * @param value {boolean} true = unstyled, false = styled (default)
+    * @param config {object} { keepFunctionalStyles?: boolean } defaults to true
+    */
+   setUnstyledMode: (value: boolean, config?: { keepFunctionalStyles?: boolean }) => void;
+
    /**
     * To check if user allowed in provided document or not.
     */

package/app/models/data/comment-events.data.model.d.ts

@@ -91,6 +91,7 @@ export type CommentEventTypesMap = {
     [CommentEventTypes.SIDEBAR_BUTTON_CLICKED]: SidebarButtonClickedEvent;
     [CommentEventTypes.SIDEBAR_OPEN]: SidebarOpenEvent;
     [CommentEventTypes.SIDEBAR_CLOSE]: SidebarCloseEvent;
+    [CommentEventTypes.FULLSCREEN_CLICK]: FullscreenClickEvent;
     [CommentEventTypes.COMMENT_CLICK]: CommentClickEvent;
     [CommentEventTypes.COMMENT_NAVIGATION_BUTTON_CLICK]: CommentNavigationButtonClickEvent;
     [CommentEventTypes.ATTACHMENT_DOWNLOAD_CLICKED]: AttachmentDownloadClickedEvent;
@@ -359,6 +360,15 @@ export interface SidebarOpenEvent {
 export interface SidebarCloseEvent {
     metadata?: VeltEventMetadata;
 }
+/**
+ * Fired when the sidebar fullscreen toggle is clicked. Subscribe via
+ * `commentElement.on('fullscreenClick')`. `fullScreen` is the NEW state after the toggle.
+ * (Also surfaced as the `onFullscreenClick` @Output on the sidebar component.)
+ */
+export interface FullscreenClickEvent {
+    fullScreen: boolean;
+    metadata?: VeltEventMetadata;
+}
 /** Fired when a comment is clicked in the sidebar list. Subscribe via `commentElement.on('commentClick')`. */
 export interface CommentClickEvent {
     documentId?: string | null;

package/app/models/data/config.data.model.d.ts

@@ -66,6 +66,160 @@ export declare class Config {
      * Configuration for routing all traffic through reverse proxies.
      */
     proxyConfig?: ProxyConfig;
+    /**
+     * Self-hosting / on-prem backend configuration. When set, a deployment can point
+     * Velt-infra endpoints (Firebase config, cloud-function URLs, the notifications-hub
+     * RTDB URL, the regional setEncryptedData endpoints) at the customer's own infra.
+     *
+     * Every field is OPTIONAL and every unspecified value falls back to the per-build
+     * default in `src/environments/*` — so an existing SaaS build with no `selfHosted`
+     * config behaves exactly as before (behavior-preserving).
+     */
+    selfHosted?: SelfHostedConfig;
+}
+/**
+ * VENDORED from the backend deployment-profile manifest — source of truth:
+ * `shared-firebase-function` repo, `functions/src/deployment-profiles/modules.manifest.ts`
+ * (`DeploymentModuleId`, 12 modules; backend plan §8.3; restructured 2026-07-10 in backend
+ * iteration-10, owner-directed). Do NOT add, remove, or rename ids here without a matching
+ * manifest change — the endpoint→module map in `endpoints.service.ts` and its cross-repo
+ * drift-fence test key off this list.
+ *
+ * 2026-07-10 restructure summary:
+ * - DELETED (absorbed into `core`): `notifications`, `analytics-telemetry`, `console`.
+ *   The agents RUNTIME also moved to `core` (`agents` keeps only the approval engine).
+ * - NEW `rest-api`: the customer-facing REST CFs (`commentsapibe`, `documentsapibe`, …),
+ *   now opt-in (hardDep `core`). None of the SDK's own runtime endpoints live there.
+ * - NEW `legacy-v1`: the ~55 standalone V1 REST CFs — EXCLUDED, never provisioned on any
+ *   self-hosted profile, so this id never appears in a valid `deploymentProfile`.
+ * - `core` is the SOLE mandatory module.
+ */
+export declare const DEPLOYMENT_MODULE_IDS: readonly ["core", "rest-api", "recorder-media", "ai", "agents", "huddle-webrtc", "integrations-workflow", "superflow", "billing-stripe", "migrations", "legacy-v1", "velt-internal"];
+/** A backend feature-module id (see {@link DEPLOYMENT_MODULE_IDS} for provenance). */
+export type DeploymentModuleId = typeof DEPLOYMENT_MODULE_IDS[number];
+/**
+ * Per-endpoint overrides for the cloud-function fleet. Each value is a fully-configurable
+ * ABSOLUTE base URL — do NOT assume the `*.cloudfunctions.net` shape (Tier A now serves the
+ * fleet from Cloud Run with arbitrary hostnames). Keys mirror `environment.cloudFunction.*`.
+ * Unspecified keys fall back to the `environment` default.
+ */
+export interface SelfHostedCloudFunctionConfig {
+    validateClient?: string;
+    getPlanDetails?: string;
+    sa?: string;
+    getIceServers?: string;
+    chatgptCompletion?: string;
+    rewriterAskAi?: string;
+    whisperTranscription?: string;
+    getAllowedDocuments?: string;
+    getNotificationsForDocuments?: string;
+    videoBackend?: string;
+    convertRecording?: string;
+    processRecording?: string;
+    sdkProxy?: string;
+    screenshot?: string;
+    /**
+     * Single override for the write endpoint that collapses the ×5 regional
+     * `setEncryptedData` split — when set, it is used for ALL regions. Self-hosted
+     * deployments typically run a single region.
+     */
+    setEncryptedData?: string;
+    /**
+     * Optional per-region overrides (used only if the single `setEncryptedData` above is
+     * unset). Keys are the `FirebaseRegion` values (`usCentral1`, `asiaSouthEast1`, ...).
+     */
+    regions?: {
+        [region: string]: {
+            setEncryptedData?: string;
+        };
+    };
+}
+export interface SelfHostedConfig {
+    /**
+     * Strict (full self-hosted) mode. Default `false`.
+     *
+     * - `false` (hybrid / staged rollout): any endpoint WITHOUT an injected override falls
+     *   back to the Velt default in `src/environments/*` — useful for testing one
+     *   self-hosted endpoint at a time while the rest stay on Velt SaaS.
+     * - `true` (full self-hosting / data sovereignty): there is NO fallback to Velt. An
+     *   endpoint without an injected override resolves to an inert
+     *   `velt://self-hosted-disabled/<endpoint>` sentinel that can never produce network
+     *   egress — the feature behind it is effectively disabled. Missing CORE endpoints
+     *   (`validateClient`, `sdkProxy`, `setEncryptedData`, `getNotificationsForDocuments`,
+     *   the notifications DB URL, `firebaseConfig`) are additionally
+     *   reported once as a loud misconfiguration error, since the SDK cannot function
+     *   without them (plan §4.3: every endpoint runs in the customer cloud or is disabled).
+     */
+    strict?: boolean;
+    /**
+     * Firebase config override (deep-merged over `environment.firebaseConfig`). Injected
+     * keys win; unspecified keys keep the `environment` default. Per-tenant auth-token
+     * claims still override this at runtime (within-project tenant routing is preserved).
+     *
+     * NOTE (strict mode): this is the ONE value that still falls back to the `environment`
+     * default when unset, because an undefined base config would break the Firebase
+     * bootstrap chain outright. The miss is still reported as a core misconfiguration, and
+     * the `identify()` response config overrides this base at runtime anyway. Making the
+     * bootstrap itself injectable is the tracked Phase A gap (`app.module.ts` static
+     * `initializeApp`).
+     */
+    firebaseConfig?: Partial<FirebaseOptions>;
+    /** Override for the notifications-hub RTDB URL (`firebaseNotificationsDatabaseURL`). */
+    firebaseNotificationsDatabaseURL?: string;
+    /** Per-endpoint cloud-function URL overrides. */
+    cloudFunction?: SelfHostedCloudFunctionConfig;
+    /**
+     * Enables defensive consumption of the portable-backend `identify()` response
+     * (`{ token, backend, wsEndpoint, apiEndpoint }`, backend §6.1). Default `false`:
+     * when false, a portable response is ignored and the existing Firebase path runs
+     * unchanged — no behavior change when the backend does not send it.
+     */
+    enablePortableBackend?: boolean;
+    /**
+     * The RESOLVED module closure of the deployment profile (backend plan §8.3) — the
+     * enabled-module-id list the backend deploy tooling emits in
+     * `velt-deployment-profile.json`. The customer's tooling inlines it at init; the SDK
+     * does NOT fetch it at runtime and does NOT re-resolve module dependencies (the
+     * backend's `profile-resolver.ts` already computed the fail-closed closure).
+     *
+     * Semantics (ratified — SDK-side synthesis, no Tier A server router):
+     * - Absent, not an array, or an EMPTY array (a valid resolved closure is never empty):
+     *   ALL modules enabled — byte-identical to today for SaaS and existing selfHosted
+     *   configs.
+     * - Non-empty: LITERAL membership — any endpoint whose module is NOT in the list
+     *   resolves to the inert `velt://self-hosted-disabled/*` sentinel, so the denial
+     *   normalizer synthesizes `'unimplemented'` locally with zero egress. Works with or
+     *   without `strict`. Unknown/typo'd ids enable nothing (fail-closed, mirroring the
+     *   backend resolver — a malformed profile must not silently re-open Velt egress).
+     * - A profile opt-out is authoritative: it wins over an injected endpoint URL, and its
+     *   endpoints degrade silently even when classified `core` (opt-out ≠ misconfiguration
+     *   — they are excluded from the strict-mode core-misconfiguration report).
+     */
+    deploymentProfile?: DeploymentModuleId[];
+    /**
+     * The `dataRegions` field of the `velt-deployment-profile.json` v1 document (additive
+     * 2026-07-10, GTK-005-safe): which regional `setencrypteddata*` variants the deployment
+     * provisioned. Inlined by the customer's tooling alongside {@link deploymentProfile}.
+     *
+     * - `undefined` / `null` — no region filter (all regional variants provisioned; the
+     *   SaaS shape). `null` and `[]` are DIFFERENT fleets — never coalesce them.
+     * - `[]` — ONLY the base `setencrypteddata` (in the deployment's own region) exists.
+     * - `['europe-west1', …]` — the base plus the variants for exactly those GCP regions
+     *   (known: `europe-west1`, `asia-southeast1`, `australia-southeast1`,
+     *   `asia-northeast1`).
+     *
+     * The SDK uses this as a pre-call provisioning check in
+     * `EndpointsService.getSetEncryptedDataUrl`: a tenant routed to an UNPROVISIONED
+     * regional variant degrades to the base `setEncryptedData` resolution instead of
+     * calling a URL that would 404.
+     *
+     * The filter is AUTHORITATIVE over injected per-region URLs (mirroring how a
+     * `deploymentProfile` opt-out wins over an injected endpoint URL): an injected
+     * `cloudFunction.regions[X]` override for a region excluded by `dataRegions` is
+     * never consulted — the write resolves through the base slot. Don't inject overrides
+     * for regions the deployment did not provision.
+     */
+    dataRegions?: string[] | null;
 }
 export interface ProxyConfig {
     /** Custom host for the Velt CDN (e.g., 'cdn-proxy.customer.com') */

package/app/models/data/notification.model.d.ts

@@ -28,6 +28,20 @@ export declare class NotificationRawData {
      * Annotation object
      */
     annotationData?: any;
+    /**
+     * Comment-visibility stamp for private comments
+     * (PM-2026-07-28-private-comment-notification-leak). Absent = public (legacy).
+     * The backend enforces visibility from this stamp on the per-user notification
+     * fan-out and on every notification read path.
+     * - `accessTokens`: the annotation's hashed visibility tokens (authoritative match)
+     * - `userIds` / `organizationIds`: the readable mirror (client ids)
+     */
+    visibility?: {
+        type: string;
+        userIds?: string[];
+        organizationIds?: string[];
+        accessTokens: string[];
+    };
     /**
      * Comment object for comment annotation
      */

package/app/models/data/suggestion.data.model.d.ts

@@ -98,8 +98,24 @@ export interface TargetEditDetails<T = unknown> {
  * auto-commit so a subscriber to `targetEditCommit` can drive it explicitly.
  */
 export interface TargetEditCommitResult {
-    /** Override the SDK's default `${targetId}: ${old} → ${new}` summary. */
+    /**
+     * Override the SDK's default diff summary (`Replace: "{old}" with "{new}"`;
+     * `Add:`/`Remove:` when one side is absent; a per-key op list when both
+     * values are plain objects). When provided without `summaryHtml`, it is
+     * used for BOTH the plain `commentText` and (escaped) the `commentHtml`
+     * of the seeded first comment.
+     */
     summary?: string;
+    /**
+     * Optional HTML version of the summary, used as the `commentHtml` of the
+     * suggestion's seeded first comment (the plain `summary` — or the SDK's
+     * default diff summary — stays in `commentText`). When BOTH are omitted,
+     * the SDK renders a default styled HTML diff (old/removed values in red
+     * italic, new/added values in green italic). Sanitized with DOMPurify at
+     * render time — script/event-handler content is stripped; inline `style`
+     * attributes are preserved.
+     */
+    summaryHtml?: string;
     /** Customer metadata persisted on the resulting Suggestion. */
     metadata?: Record<string, unknown>;
 }
@@ -134,6 +150,24 @@ export interface EnableSuggestionModeConfig {
      * to event subscribers.
      */
     onTargetEditCommit?: TargetEditCommitHandler;
+    /**
+     * When active AND no `onTargetEditCommit` handler is provided, every
+     * detected commit auto-commits with the SDK's default summary/summaryHtml
+     * (equivalent to a handler returning `{}`).
+     *
+     * **Default: true** — a bare `enableSuggestionMode()` turns edits into
+     * suggestions with zero config. Pass `autoCommit: false` for detect-only
+     * mode (events fire, nothing commits until a subscriber calls the event's
+     * `commitSuggestion` builder).
+     *
+     * A provided `onTargetEditCommit` handler always wins — including its
+     * null-return deferral contract — so handler-based integrations are
+     * unaffected. The `targetEditCommit` event still fires; its pre-bound
+     * `commitSuggestion` builder becomes a no-op for edits already
+     * auto-committed by this flag (same double-commit guard as the handler
+     * path).
+     */
+    autoCommit?: boolean;
 }
 /**
  * SDK-managed suggestion data persisted on a CommentAnnotation.
@@ -245,8 +279,24 @@ export interface CommitSuggestionConfig<T = unknown> {
     targetId: string;
     /** Any JSON-serializable value. Customer's apply handler interprets it. */
     newValue: T;
-    /** Optional human-readable string for logs and notifications. */
+    /**
+     * Optional human-readable string for logs and notifications. When provided
+     * without `summaryHtml`, it is used for BOTH the seeded comment's plain
+     * `commentText` and (escaped) its `commentHtml`. When omitted, the seeded
+     * comment falls back to the SDK's default diff summary
+     * (`Replace: "{old}" with "{new}"`; `Add:`/`Remove:` when one side is
+     * absent; a per-key op list when both values are plain objects).
+     */
     summary?: string;
+    /**
+     * Optional HTML version of the summary — becomes the `commentHtml` of the
+     * suggestion's seeded first comment (plain `summary` or the default diff
+     * summary stays in `commentText`). When BOTH are omitted, the SDK renders
+     * a default styled HTML diff (old/removed values in red italic, new/added
+     * values in green italic). Sanitized with DOMPurify at render time; inline
+     * `style` attributes are preserved so rich diff styling survives.
+     */
+    summaryHtml?: string;
     /** Optional customer-defined metadata. Stored on Suggestion.metadata. */
     metadata?: Record<string, unknown>;
 }

package/app/utils/constants.d.ts

@@ -12,6 +12,7 @@ export declare class Constants {
     static LISTENER_CONTEXT_BATCH_SIZE: number;
     static DEFAULT_VELT_CONTEXT: string;
     static VISIBILITY_SELF_PREFIX: string;
+    static VISIBILITY_ORG_PREFIX: string;
     static FIREBASE_PARTIAL_PATH_ORGANIZATIONS: string;
     static FIREBASE_PARTIAL_PATH_FOLDERS: string;
     static FIREBASE_PARTIAL_PATH_DOCS: string;

package/app/utils/enums.d.ts

@@ -100,6 +100,7 @@ export declare const CommentEventTypes: {
     readonly SIDEBAR_BUTTON_CLICKED: "sidebarButtonClicked";
     readonly SIDEBAR_OPEN: "sidebarOpen";
     readonly SIDEBAR_CLOSE: "sidebarClose";
+    readonly FULLSCREEN_CLICK: "fullscreenClick";
     readonly COMMENT_CLICK: "commentClick";
     readonly COMMENT_NAVIGATION_BUTTON_CLICK: "commentNavigationButtonClick";
     readonly ATTACHMENT_DOWNLOAD_CLICKED: "attachmentDownloadClicked";
@@ -332,7 +333,7 @@ export type RecorderType = 'audio' | 'video' | 'screen';
 export type RecorderFileFormat = 'mp3' | 'mp4' | 'webm';
 export type RecorderLayoutMode = 'floating' | 'thread';
 export type SupportedMimeType = 'audio' | 'video';
-export type FirebaseRegion = 'usCentral1' | 'asiaSouthEast1' | 'europeWest1' | 'australiaSouthEast1';
+export type FirebaseRegion = 'usCentral1' | 'asiaSouthEast1' | 'europeWest1' | 'australiaSouthEast1' | 'asiaNorthEast1';
 export type VideoEventType = 'play' | 'pause' | 'ratechange' | 'seeked' | 'timeupdate' | 'volumechange';
 export type RewriterType = 'copywriter' | 'generic';
 export type RecorderStatusType = 'started' | 'paused' | 'resumed' | 'stopped' | 'error' | null;