@salesforce/sdk-view 1.103.2

package/LICENSE.txt

@@ -0,0 +1,82 @@
+Terms of Use
+
+Copyright 2026 Salesforce, Inc. All rights reserved.
+
+These Terms of Use govern the download, installation, and/or use of this
+software provided by Salesforce, Inc. ("Salesforce") (the "Software"), were
+last updated on April 15, 2025, and constitute a legally binding
+agreement between you and Salesforce. If you do not agree to these Terms of
+Use, do not install or use the Software.
+
+Salesforce grants you a worldwide, non-exclusive, no-charge, royalty-free
+copyright license to reproduce, prepare derivative works of, publicly
+display, publicly perform, sublicense, and distribute the Software and
+derivative works subject to these Terms. These Terms shall be included in
+all copies or substantial portions of the Software.
+
+Subject to the limited rights expressly granted hereunder, Salesforce
+reserves all rights, title, and interest in and to all intellectual
+property subsisting in the Software. No rights are granted to you hereunder
+other than as expressly set forth herein. Users residing in countries on
+the United States Office of Foreign Assets Control sanction list, or which
+are otherwise subject to a US export embargo, may not use the Software.
+
+Implementation of the Software may require development work, for which you
+are responsible. The Software may contain bugs, errors and
+incompatibilities and is made available on an AS IS basis without support,
+updates, or service level commitments.
+
+Salesforce reserves the right at any time to modify, suspend, or
+discontinue, the Software (or any part thereof) with or without notice. You
+agree that Salesforce shall not be liable to you or to any third party for
+any modification, suspension, or discontinuance.
+
+You agree to defend Salesforce against any claim, demand, suit or
+proceeding made or brought against Salesforce by a third party arising out
+of or accruing from (a) your use of the Software, and (b) any application
+you develop with the Software that infringes any copyright, trademark,
+trade secret, trade dress, patent, or other intellectual property right of
+any person or defames any person or violates their rights of publicity or
+privacy (each a "Claim Against Salesforce"), and will indemnify Salesforce
+from any damages, attorney fees, and costs finally awarded against
+Salesforce as a result of, or for any amounts paid by Salesforce under a
+settlement approved by you in writing of, a Claim Against Salesforce,
+provided Salesforce (x) promptly gives you written notice of the Claim
+Against Salesforce, (y) gives you sole control of the defense and
+settlement of the Claim Against Salesforce (except that you may not settle
+any Claim Against Salesforce unless it unconditionally releases Salesforce
+of all liability), and (z) gives you all reasonable assistance, at your
+expense.
+
+WITHOUT LIMITING THE GENERALITY OF THE FOREGOING, THE SOFTWARE IS NOT
+SUPPORTED AND IS PROVIDED "AS IS," WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED. IN NO EVENT SHALL SALESFORCE HAVE ANY LIABILITY FOR ANY DAMAGES,
+INCLUDING, BUT NOT LIMITED TO, DIRECT, INDIRECT, SPECIAL, INCIDENTAL,
+PUNITIVE, OR CONSEQUENTIAL DAMAGES, OR DAMAGES BASED ON LOST PROFITS, DATA,
+OR USE, IN CONNECTION WITH THE SOFTWARE, HOWEVER CAUSED AND WHETHER IN
+CONTRACT, TORT, OR UNDER ANY OTHER THEORY OF LIABILITY, WHETHER OR NOT YOU
+HAVE BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
+
+These Terms of Use shall be governed exclusively by the internal laws of
+the State of California, without regard to its conflicts of laws
+rules. Each party hereby consents to the exclusive jurisdiction of the
+state and federal courts located in San Francisco County, California to
+adjudicate any dispute arising out of or relating to these Terms of Use and
+the download, installation, and/or use of the Software. Except as expressly
+stated herein, these Terms of Use constitute the entire agreement between
+the parties, and supersede all prior and contemporaneous agreements,
+proposals, or representations, written or oral, concerning their subject
+matter. No modification, amendment, or waiver of any provision of these
+Terms of Use shall be effective unless it is by an update to these Terms of
+Use that Salesforce makes available, or is in writing and signed by the
+party against whom the modification, amendment, or waiver is to be
+asserted.
+
+Data Privacy: Salesforce may collect, process, and store device,
+system, and other information related to your use of the Software. This
+information includes, but is not limited to, IP address, user metrics, and
+other data ("Usage Data"). Salesforce may use Usage Data for analytics,
+product development, and marketing purposes. You acknowledge that files
+generated in conjunction with the Software may contain sensitive or
+confidential data, and you are solely responsible for anonymizing and
+protecting such data.

package/README.md

@@ -0,0 +1,41 @@
+# @salesforce/sdk-view
+
+The View SDK provides a unified interface for visual interactions and user feedback across different Salesforce application surfaces. It handles notifications, alerts, and modal dialogs, automatically adapting to the hosting environment.
+
+## Purpose
+
+The View SDK manages interactions that affect the visual shell or user feedback, independent of business data. It abstracts away the complexity of different hosting environments, allowing applications to deliver consistent user experiences whether running in a web application, embedded iframe, or conversational interface.
+
+## Key Capabilities
+
+- **Notifications**: Display alerts, toasts, and confirmations appropriate to the hosting environment
+- **Modals**: Request the host to overlay modal dialogs, even within iframe constraints
+- **Surface Adaptation**: Automatically detects and adapts to the runtime environment
+
+## Supported Surfaces
+
+The View SDK supports the following application surfaces:
+
+- **Web Applications**: Standard Salesforce web applications with native browser capabilities
+- **Micro Frontends**: Embedded iframe applications that communicate through the host bridge
+- **OpenAI ChatGPT Apps**: Conversational interfaces integrated with ChatGPT
+
+## Architecture
+
+The View SDK is part of the Salesforce Platform SDK ecosystem and works alongside other domain-specific SDKs:
+
+- **@salesforce/sdk-core**: Provides runtime detection and initialization
+- **@salesforce/sdk-data**: Unified data access layer
+- **@salesforce/sdk-chat**: Conversational flow participation
+
+## Status
+
+**Status:** Experimental (Private Package)
+
+This package is currently marked as private and intended for internal use within the Salesforce Web Applications monorepo.
+
+## License
+
+Copyright (c) 2026, Salesforce, Inc.
+All rights reserved.
+For full license text, see the LICENSE.txt file.

package/dist/index.d.ts

@@ -0,0 +1,21 @@
+import { SDKOptions, ViewSDK, McpAppsSessionOptions } from '@salesforce/sdk-core';
+/**
+ * Options for creating a ViewSDK instance.
+ */
+export interface ViewSDKOptions extends SDKOptions {
+    /** MCP Apps session options (app identity, handshake timeout) */
+    mcpApps?: McpAppsSessionOptions;
+}
+/**
+ * Create and initialize a ViewSDK instance based on the detected surface
+ *
+ * For MCP Apps surfaces, this obtains the shared {@link McpAppsSession} singleton
+ * (performing the SEP-1865 handshake on the first call across all SDK factories).
+ *
+ * @param options - Optional configuration including surface override
+ * @returns Promise resolving to an initialized ViewSDK instance
+ */
+export declare function createViewSDK(options?: ViewSDKOptions): Promise<ViewSDK>;
+export { MCPAppsViewSDK } from './mcpapps';
+export type { AlertOptions, ModalOptions, SDKOptions, Theme, ThemeMode, ToastOptions, ViewSDK, } from '@salesforce/sdk-core';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,EAAE,UAAU,EAAE,OAAO,EAAE,qBAAqB,EAAE,MAAM,sBAAsB,CAAC;AAIvF;;GAEG;AACH,MAAM,WAAW,cAAe,SAAQ,UAAU;IACjD,iEAAiE;IACjE,OAAO,CAAC,EAAE,qBAAqB,CAAC;CAChC;AAED;;;;;;;;GAQG;AACH,wBAAsB,aAAa,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,OAAO,CAAC,CAyB9E;AAED,OAAO,EAAE,cAAc,EAAE,MAAM,WAAW,CAAC;AAE3C,YAAY,EACX,YAAY,EACZ,YAAY,EACZ,UAAU,EACV,KAAK,EACL,SAAS,EACT,YAAY,EACZ,OAAO,GACP,MAAM,sBAAsB,CAAC"}

package/dist/index.js

@@ -0,0 +1,119 @@
+import { getSurface as l, Surface as a, McpAppsSession as d } from "@salesforce/sdk-core";
+function p(r) {
+  switch (r) {
+    case "info":
+      return "ℹ️";
+    case "success":
+      return "✅";
+    case "warning":
+      return "⚠️";
+    case "error":
+      return "❌";
+    default:
+      return "ℹ️";
+  }
+}
+function o(r, e) {
+  return `${p(e)} ${r}`;
+}
+function c(r, e) {
+  const s = r.trim();
+  if (s === "")
+    return { success: !0, value: void 0 };
+  const t = s.match(/^(\d+(?:\.\d+)?)(px)?$/);
+  if (!t || !t[1])
+    return {
+      success: !1,
+      error: `Invalid ${e}: "${r}". Only pixel values are supported (e.g., "800px" or "800").`
+    };
+  const n = parseFloat(t[1]);
+  return n < 0 || !isFinite(n) ? {
+    success: !1,
+    error: `Invalid ${e}: "${r}". Value must be a positive number.`
+  } : { success: !0, value: n };
+}
+class m {
+  constructor(e) {
+    this.session = e;
+  }
+  /**
+   * Send a formatted message to the host via ui/message
+   * @param message - The message text
+   * @param level - The message severity level (defaults to "info")
+   */
+  async sendMessage(e, s = "info") {
+    const t = o(e, s);
+    await this.session.request("ui/message", {
+      role: "user",
+      content: [
+        {
+          type: "text",
+          text: t
+        }
+      ]
+    });
+  }
+  async displayAlert(e) {
+    await this.sendMessage(e.message, e.level);
+  }
+  async displayToast(e) {
+    await this.sendMessage(e.message, e.level);
+  }
+  async displayModal(e) {
+    return Promise.resolve();
+  }
+  getTheme() {
+    const e = this.session.getHostContext().theme;
+    return e ? { mode: e } : null;
+  }
+  async resize(e, s) {
+    const t = c(e, "width");
+    if (!t.success)
+      return Promise.reject(new Error(t.error));
+    const n = c(s, "height");
+    if (!n.success)
+      return Promise.reject(new Error(n.error));
+    const i = {};
+    return t.value !== void 0 && (i.width = t.value), n.value !== void 0 && (i.height = n.value), this.session.sendNotification("ui/notifications/size-changed", i), Promise.resolve();
+  }
+}
+class u {
+  async displayAlert(e) {
+    const s = e.level || "info", t = o(e.message, s);
+    await window.openai.sendFollowUpMessage({ prompt: t });
+  }
+  async displayToast(e) {
+    const s = e.level || "info", t = o(e.message, s);
+    await window.openai.sendFollowUpMessage({ prompt: t });
+  }
+  async displayModal(e) {
+    await window.openai.requestModal({
+      template: e.componentReference,
+      params: e.params
+    });
+  }
+  getTheme() {
+    return window.openai.theme;
+  }
+}
+async function w(r) {
+  switch (l(r?.surface)) {
+    case a.OpenAI:
+      return new u();
+    case a.WebApp:
+    case a.MicroFrontend:
+      return {};
+    case a.SalesforceACC:
+      return {};
+    case a.MCPApps: {
+      const s = await d.getInstance(r?.mcpApps);
+      return s.handshakeSucceeded ? new m(s) : window.openai ? new u() : {};
+    }
+    default:
+      return {};
+  }
+}
+export {
+  m as MCPAppsViewSDK,
+  w as createViewSDK
+};

package/dist/mcpapps.d.ts

@@ -0,0 +1,24 @@
+import { ViewSDK, AlertOptions, ToastOptions, ModalOptions, Theme, McpAppsSession } from '@salesforce/sdk-core';
+/**
+ * ViewSDK implementation for MCP Apps surface.
+ *
+ * Uses a shared {@link McpAppsSession} for JSON-RPC 2.0 transport instead of
+ * owning its own postMessage listener, avoiding duplicate listeners and ID
+ * counter collisions when used alongside MCPAppsChatSDK.
+ */
+export declare class MCPAppsViewSDK implements ViewSDK {
+    private session;
+    constructor(session: McpAppsSession);
+    /**
+     * Send a formatted message to the host via ui/message
+     * @param message - The message text
+     * @param level - The message severity level (defaults to "info")
+     */
+    private sendMessage;
+    displayAlert(options: AlertOptions): Promise<void>;
+    displayToast(options: ToastOptions): Promise<void>;
+    displayModal(_options: ModalOptions): Promise<void>;
+    getTheme(): Theme | null;
+    resize(width: string, height: string): Promise<void>;
+}
+//# sourceMappingURL=mcpapps.d.ts.map

package/dist/mcpapps.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"mcpapps.d.ts","sourceRoot":"","sources":["../src/mcpapps.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,OAAO,KAAK,EACX,OAAO,EACP,YAAY,EACZ,YAAY,EACZ,YAAY,EACZ,KAAK,EAEL,MAAM,sBAAsB,CAAC;AAC9B,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAC;AAG3D;;;;;;GAMG;AACH,qBAAa,cAAe,YAAW,OAAO;IACjC,OAAO,CAAC,OAAO;gBAAP,OAAO,EAAE,cAAc;IAE3C;;;;OAIG;YACW,WAAW;IAcnB,YAAY,CAAC,OAAO,EAAE,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC;IAIlD,YAAY,CAAC,OAAO,EAAE,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC;IAIlD,YAAY,CAAC,QAAQ,EAAE,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC;IAKzD,QAAQ,IAAI,KAAK,GAAG,IAAI;IAKlB,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;CA2B1D"}

package/dist/openai.d.ts

@@ -0,0 +1,11 @@
+import { ViewSDK, AlertOptions, ToastOptions, ModalOptions, Theme } from '@salesforce/sdk-core';
+/**
+ * ViewSDK implementation for OpenAI surface
+ */
+export declare class OpenAIViewSDK implements ViewSDK {
+    displayAlert(options: AlertOptions): Promise<void>;
+    displayToast(options: ToastOptions): Promise<void>;
+    displayModal(options: ModalOptions): Promise<void>;
+    getTheme(): Theme | null;
+}
+//# sourceMappingURL=openai.d.ts.map

package/dist/openai.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"openai.d.ts","sourceRoot":"","sources":["../src/openai.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,OAAO,KAAK,EACX,OAAO,EACP,YAAY,EACZ,YAAY,EACZ,YAAY,EACZ,KAAK,EACL,MAAM,sBAAsB,CAAC;AAG9B;;GAEG;AACH,qBAAa,aAAc,YAAW,OAAO;IACtC,YAAY,CAAC,OAAO,EAAE,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC;IAOlD,YAAY,CAAC,OAAO,EAAE,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC;IAOlD,YAAY,CAAC,OAAO,EAAE,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC;IAOxD,QAAQ,IAAI,KAAK,GAAG,IAAI;CAGxB"}

package/dist/utils.d.ts

@@ -0,0 +1,59 @@
+import { MessageLevel } from '@salesforce/sdk-core';
+/**
+ * Get the icon emoji for a given message level
+ *
+ * Maps message severity levels to their corresponding emoji icons:
+ * - info: ℹ️
+ * - success: ✅
+ * - warning: ⚠️
+ * - error: ❌
+ *
+ * @param level - The message severity level
+ * @returns The emoji icon for the level
+ */
+export declare function getIconForLevel(level: MessageLevel): string;
+/**
+ * Format a message with an icon based on the severity level
+ *
+ * Prepends the appropriate emoji icon to the message text.
+ *
+ * @param message - The message text
+ * @param level - The message severity level
+ * @returns The formatted message with icon prefix (e.g., "ℹ️ Your message")
+ */
+export declare function formatMessageWithLevel(message: string, level: MessageLevel): string;
+/**
+ * Result type for dimension parsing
+ */
+export type ParseDimensionResult = {
+    success: true;
+    value: number | undefined;
+} | {
+    success: false;
+    error: string;
+};
+/**
+ * Parse a dimension string to a numeric pixel value
+ *
+ * Supports formats:
+ * - "800px" - pixel value with unit
+ * - "800" - unitless value (treated as pixels)
+ * - "" - empty string returns undefined
+ *
+ * Rejects with error message:
+ * - Invalid formats (e.g., "800rem", "50%", "auto")
+ * - Negative values
+ * - Non-numeric values
+ *
+ * @param value - The dimension string to parse
+ * @param dimensionName - Name of the dimension for error messages ("width" or "height")
+ * @returns Result object with success flag and either value or error message
+ *
+ * @example
+ * parseDimension("800px", "width") // Returns { success: true, value: 800 }
+ * parseDimension("600", "height") // Returns { success: true, value: 600 }
+ * parseDimension("", "width") // Returns { success: true, value: undefined }
+ * parseDimension("50%", "width") // Returns { success: false, error: "Invalid width..." }
+ */
+export declare function parseDimension(value: string, dimensionName: string): ParseDimensionResult;
+//# sourceMappingURL=utils.d.ts.map

package/dist/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAC;AAEzD;;;;;;;;;;;GAWG;AACH,wBAAgB,eAAe,CAAC,KAAK,EAAE,YAAY,GAAG,MAAM,CAa3D;AAED;;;;;;;;GAQG;AACH,wBAAgB,sBAAsB,CAAC,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,YAAY,GAAG,MAAM,CAGnF;AAED;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAC7B;IAAE,OAAO,EAAE,IAAI,CAAC;IAAC,KAAK,EAAE,MAAM,GAAG,SAAS,CAAA;CAAE,GAC5C;IAAE,OAAO,EAAE,KAAK,CAAC;IAAC,KAAK,EAAE,MAAM,CAAA;CAAE,CAAC;AAErC;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,wBAAgB,cAAc,CAAC,KAAK,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,GAAG,oBAAoB,CAiCzF"}

package/package.json

@@ -0,0 +1,39 @@
+{
+  "name": "@salesforce/sdk-view",
+  "version": "1.103.2",
+  "license": "SEE LICENSE IN LICENSE.txt",
+  "type": "module",
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    "./package.json": "./package.json",
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "default": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "vite build",
+    "clean": "rm -rf dist",
+    "dev": "vite build --watch",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "test:coverage": "vitest run --coverage"
+  },
+  "dependencies": {
+    "@salesforce/sdk-core": "^1.103.2"
+  },
+  "devDependencies": {
+    "vite": "^7.3.1",
+    "vite-plugin-dts": "^4.5.4",
+    "vitest": "^4.0.6"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}