@microsoft/omnichannel-chat-sdk 2.0.0 → 2.0.1-main.b9e3cb3

package/lib/validators/prefetchedConfigValidator.d.ts

@@ -0,0 +1,77 @@
+import { PrefetchedConfigAttestation } from "../core/GetLiveChatConfigOptionalParams";
+/**
+ * Reason a prefetched live chat config was not adopted. Emitted as telemetry so a
+ * silent fallback to the network is still observable.
+ */
+export declare enum PrefetchedConfigRejectionReason {
+    NotProvided = "NotProvided",
+    CacheBypass = "CacheBypass",
+    MissingAttestation = "MissingAttestation",
+    IdentityMismatch = "IdentityMismatch",
+    UnverifiedOrgUrl = "UnverifiedOrgUrl",
+    OrgUrlMismatch = "OrgUrlMismatch",
+    MalformedPayload = "MalformedPayload",
+    MissingLiveChatVersion = "MissingLiveChatVersion",
+    UnsupportedLiveChatVersion = "UnsupportedLiveChatVersion",
+    PayloadOrgIdMismatch = "PayloadOrgIdMismatch",
+    PayloadWidgetIdMismatch = "PayloadWidgetIdMismatch"
+}
+export interface PrefetchedConfigValidationResult {
+    accepted: boolean;
+    reason?: PrefetchedConfigRejectionReason;
+}
+/**
+ * Decide whether a caller-prefetched live chat config may be adopted in place of a
+ * network fetch.
+ *
+ * The prefetched payload arrives from outside the SDK, so it is treated as
+ * untrusted input. It is adopted only when every check passes:
+ *
+ * 1. A payload was actually supplied.
+ * 2. The caller is not deliberately bypassing cache — a cache bypass must reach
+ *    the network, otherwise `sendCacheHeaders` would be silently defeated.
+ * 3. The caller attested which org/widget it fetched the config for.
+ * 4. That attestation matches this SDK instance's own configured identity.
+ * 5. The payload is shaped like a config (`LiveWSAndLiveChatEngJoin` present, and
+ *    a `LiveChatVersion`).
+ * 6. The payload's OWN identity matches too. The attestation is only a *claim
+ *    about* the payload; without this step a caller that attests correctly but
+ *    hands over the wrong object — two widgets on one page with the configs
+ *    swapped, no attacker required — would be accepted. This is what actually
+ *    makes a cross-widget or cross-tenant payload harmless.
+ *
+ * Payload identity is enforced only when the payload carries those fields, since
+ * not every config does; a config that omits them is still gated by checks 3-5.
+ *
+ * Two further conditions block adoption because the network fetch has side effects
+ * beyond returning the config:
+ *
+ * - The first fetch is also what proves the org url currently in use actually
+ *   resolves. The SDK may rewrite that url at runtime (unq -> Core Services) and
+ *   nothing else exercises the rewritten one; if it does not resolve, the fetch
+ *   is what discovers that and falls back. Skipping the fetch skips the proof, so
+ *   the caller must supply one: it attests the url it fetched from, and the
+ *   payload is adopted only when that is the same url this instance is about to
+ *   use. Then the caller's own successful fetch IS the proof. A caller that
+ *   attests nothing, or attests a different url, takes the network fetch exactly
+ *   as before.
+ * - The fetch also settles the live chat version on the underlying client. Only
+ *   the version that client already defaults to can be adopted without the fetch,
+ *   so any other version is rejected rather than half-applied.
+ *
+ * Any failure is a rejection, never an error: every input is type-checked before
+ * it is used, and the caller falls back to its normal network fetch, so a bad
+ * prefetch costs a round-trip and nothing else.
+ *
+ * Identity comparison is case-insensitive because org and widget ids are GUIDs
+ * whose casing is not stable across the surfaces that pass them around.
+ *
+ * @param prefetchedLiveChatConfig The payload supplied by the caller.
+ * @param attestation The identity the caller claims the payload was fetched for.
+ * @param expected This SDK instance's own configured identity.
+ * @param bypassCache Whether the caller requested a deliberate cache bypass.
+ * @param effectiveOrgUrl The org url this SDK instance is about to use, after any
+ *   runtime rewrite. The attested fetch url must match it for the fast path.
+ */
+export declare const validatePrefetchedLiveChatConfig: (prefetchedLiveChatConfig: any, attestation: PrefetchedConfigAttestation | undefined, expected: PrefetchedConfigAttestation, bypassCache: boolean, effectiveOrgUrl: string) => PrefetchedConfigValidationResult;
+export default validatePrefetchedLiveChatConfig;

package/lib/validators/prefetchedConfigValidator.js

@@ -0,0 +1,152 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validatePrefetchedLiveChatConfig = exports.PrefetchedConfigRejectionReason = void 0;
+var LiveChatVersion_1 = require("../core/LiveChatVersion");
+/**
+ * Reason a prefetched live chat config was not adopted. Emitted as telemetry so a
+ * silent fallback to the network is still observable.
+ */
+var PrefetchedConfigRejectionReason;
+(function (PrefetchedConfigRejectionReason) {
+    PrefetchedConfigRejectionReason["NotProvided"] = "NotProvided";
+    PrefetchedConfigRejectionReason["CacheBypass"] = "CacheBypass";
+    PrefetchedConfigRejectionReason["MissingAttestation"] = "MissingAttestation";
+    PrefetchedConfigRejectionReason["IdentityMismatch"] = "IdentityMismatch";
+    PrefetchedConfigRejectionReason["UnverifiedOrgUrl"] = "UnverifiedOrgUrl";
+    PrefetchedConfigRejectionReason["OrgUrlMismatch"] = "OrgUrlMismatch";
+    PrefetchedConfigRejectionReason["MalformedPayload"] = "MalformedPayload";
+    PrefetchedConfigRejectionReason["MissingLiveChatVersion"] = "MissingLiveChatVersion";
+    PrefetchedConfigRejectionReason["UnsupportedLiveChatVersion"] = "UnsupportedLiveChatVersion";
+    PrefetchedConfigRejectionReason["PayloadOrgIdMismatch"] = "PayloadOrgIdMismatch";
+    PrefetchedConfigRejectionReason["PayloadWidgetIdMismatch"] = "PayloadWidgetIdMismatch";
+})(PrefetchedConfigRejectionReason || (exports.PrefetchedConfigRejectionReason = PrefetchedConfigRejectionReason = {}));
+var accepted = { accepted: true };
+var rejected = function (reason) { return ({ accepted: false, reason: reason }); };
+/**
+ * Whether two org urls address the same endpoint.
+ *
+ * Compared on ORIGIN rather than on the raw string: the two sides are produced
+ * independently (the caller builds a fetch url, the SDK builds its org url), so
+ * they can legitimately differ in trailing slash, case, or path while naming the
+ * same host. Anything unparsable is not a match — this gates a fast path, so
+ * "cannot tell" must mean "take the network fetch".
+ */
+var sameOrigin = function (a, b) {
+    try {
+        return new URL(a).origin.toLowerCase() === new URL(b).origin.toLowerCase();
+    }
+    catch (_a) {
+        return false;
+    }
+};
+/**
+ * Decide whether a caller-prefetched live chat config may be adopted in place of a
+ * network fetch.
+ *
+ * The prefetched payload arrives from outside the SDK, so it is treated as
+ * untrusted input. It is adopted only when every check passes:
+ *
+ * 1. A payload was actually supplied.
+ * 2. The caller is not deliberately bypassing cache — a cache bypass must reach
+ *    the network, otherwise `sendCacheHeaders` would be silently defeated.
+ * 3. The caller attested which org/widget it fetched the config for.
+ * 4. That attestation matches this SDK instance's own configured identity.
+ * 5. The payload is shaped like a config (`LiveWSAndLiveChatEngJoin` present, and
+ *    a `LiveChatVersion`).
+ * 6. The payload's OWN identity matches too. The attestation is only a *claim
+ *    about* the payload; without this step a caller that attests correctly but
+ *    hands over the wrong object — two widgets on one page with the configs
+ *    swapped, no attacker required — would be accepted. This is what actually
+ *    makes a cross-widget or cross-tenant payload harmless.
+ *
+ * Payload identity is enforced only when the payload carries those fields, since
+ * not every config does; a config that omits them is still gated by checks 3-5.
+ *
+ * Two further conditions block adoption because the network fetch has side effects
+ * beyond returning the config:
+ *
+ * - The first fetch is also what proves the org url currently in use actually
+ *   resolves. The SDK may rewrite that url at runtime (unq -> Core Services) and
+ *   nothing else exercises the rewritten one; if it does not resolve, the fetch
+ *   is what discovers that and falls back. Skipping the fetch skips the proof, so
+ *   the caller must supply one: it attests the url it fetched from, and the
+ *   payload is adopted only when that is the same url this instance is about to
+ *   use. Then the caller's own successful fetch IS the proof. A caller that
+ *   attests nothing, or attests a different url, takes the network fetch exactly
+ *   as before.
+ * - The fetch also settles the live chat version on the underlying client. Only
+ *   the version that client already defaults to can be adopted without the fetch,
+ *   so any other version is rejected rather than half-applied.
+ *
+ * Any failure is a rejection, never an error: every input is type-checked before
+ * it is used, and the caller falls back to its normal network fetch, so a bad
+ * prefetch costs a round-trip and nothing else.
+ *
+ * Identity comparison is case-insensitive because org and widget ids are GUIDs
+ * whose casing is not stable across the surfaces that pass them around.
+ *
+ * @param prefetchedLiveChatConfig The payload supplied by the caller.
+ * @param attestation The identity the caller claims the payload was fetched for.
+ * @param expected This SDK instance's own configured identity.
+ * @param bypassCache Whether the caller requested a deliberate cache bypass.
+ * @param effectiveOrgUrl The org url this SDK instance is about to use, after any
+ *   runtime rewrite. The attested fetch url must match it for the fast path.
+ */
+var validatePrefetchedLiveChatConfig = function (
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+prefetchedLiveChatConfig, attestation, expected, bypassCache, effectiveOrgUrl) {
+    if (prefetchedLiveChatConfig === undefined || prefetchedLiveChatConfig === null) {
+        return rejected(PrefetchedConfigRejectionReason.NotProvided);
+    }
+    if (bypassCache) {
+        return rejected(PrefetchedConfigRejectionReason.CacheBypass);
+    }
+    if (!attestation || typeof attestation.orgId !== "string" || typeof attestation.widgetId !== "string" || !attestation.orgId || !attestation.widgetId) {
+        return rejected(PrefetchedConfigRejectionReason.MissingAttestation);
+    }
+    if (typeof expected.orgId !== "string" || typeof expected.widgetId !== "string" || !expected.orgId || !expected.widgetId) {
+        return rejected(PrefetchedConfigRejectionReason.MissingAttestation);
+    }
+    var sameIdentity = attestation.orgId.toLowerCase() === expected.orgId.toLowerCase() &&
+        attestation.widgetId.toLowerCase() === expected.widgetId.toLowerCase();
+    if (!sameIdentity) {
+        return rejected(PrefetchedConfigRejectionReason.IdentityMismatch);
+    }
+    if (typeof attestation.orgUrl !== "string" || !attestation.orgUrl) {
+        return rejected(PrefetchedConfigRejectionReason.UnverifiedOrgUrl);
+    }
+    if (!sameOrigin(attestation.orgUrl, effectiveOrgUrl)) {
+        return rejected(PrefetchedConfigRejectionReason.OrgUrlMismatch);
+    }
+    if (typeof prefetchedLiveChatConfig !== "object" || Array.isArray(prefetchedLiveChatConfig)) {
+        return rejected(PrefetchedConfigRejectionReason.MalformedPayload);
+    }
+    // Every live chat config carries this block; its absence means we were handed
+    // something that is not a config, and adopting it would fail later in
+    // buildConfigurations() in a much harder place to diagnose.
+    if (!prefetchedLiveChatConfig.LiveWSAndLiveChatEngJoin || typeof prefetchedLiveChatConfig.LiveWSAndLiveChatEngJoin !== "object") {
+        return rejected(PrefetchedConfigRejectionReason.MalformedPayload);
+    }
+    if (prefetchedLiveChatConfig.LiveChatVersion === undefined || prefetchedLiveChatConfig.LiveChatVersion === null) {
+        return rejected(PrefetchedConfigRejectionReason.MissingLiveChatVersion);
+    }
+    if (prefetchedLiveChatConfig.LiveChatVersion !== LiveChatVersion_1.default.V2) {
+        return rejected(PrefetchedConfigRejectionReason.UnsupportedLiveChatVersion);
+    }
+    // The attestation above is only the caller's CLAIM about this payload. These
+    // two checks verify the payload itself, which is what stops a correctly
+    // attested but wrongly selected object from being adopted. Enforced only when
+    // present, since not every config carries them.
+    var payloadOrgId = prefetchedLiveChatConfig.SalOrgId;
+    if (typeof payloadOrgId === "string" && payloadOrgId.length > 0 && payloadOrgId.toLowerCase() !== expected.orgId.toLowerCase()) {
+        return rejected(PrefetchedConfigRejectionReason.PayloadOrgIdMismatch);
+    }
+    var payloadWidgetId = prefetchedLiveChatConfig.LiveWSAndLiveChatEngJoin.msdyn_widgetappid;
+    if (typeof payloadWidgetId === "string" && payloadWidgetId.length > 0 && payloadWidgetId.toLowerCase() !== expected.widgetId.toLowerCase()) {
+        return rejected(PrefetchedConfigRejectionReason.PayloadWidgetIdMismatch);
+    }
+    return accepted;
+};
+exports.validatePrefetchedLiveChatConfig = validatePrefetchedLiveChatConfig;
+exports.default = exports.validatePrefetchedLiveChatConfig;
+//# sourceMappingURL=prefetchedConfigValidator.js.map

package/lib/validators/prefetchedConfigValidator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"prefetchedConfigValidator.js","sourceRoot":"","sources":["../../src/validators/prefetchedConfigValidator.ts"],"names":[],"mappings":";;;AACA,2DAAsD;AAEtD;;;GAGG;AACH,IAAY,+BAYX;AAZD,WAAY,+BAA+B;IACvC,8DAA2B,CAAA;IAC3B,8DAA2B,CAAA;IAC3B,4EAAyC,CAAA;IACzC,wEAAqC,CAAA;IACrC,wEAAqC,CAAA;IACrC,oEAAiC,CAAA;IACjC,wEAAqC,CAAA;IACrC,oFAAiD,CAAA;IACjD,4FAAyD,CAAA;IACzD,gFAA6C,CAAA;IAC7C,sFAAmD,CAAA;AACvD,CAAC,EAZW,+BAA+B,+CAA/B,+BAA+B,QAY1C;AAOD,IAAM,QAAQ,GAAqC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;AAEtE,IAAM,QAAQ,GAAG,UAAC,MAAuC,IAAuC,OAAA,CAAC,EAAE,QAAQ,EAAE,KAAK,EAAE,MAAM,QAAA,EAAE,CAAC,EAA7B,CAA6B,CAAC;AAE9H;;;;;;;;GAQG;AACH,IAAM,UAAU,GAAG,UAAC,CAAS,EAAE,CAAS;IACpC,IAAI,CAAC;QACD,OAAO,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,WAAW,EAAE,KAAK,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC;IAC/E,CAAC;IAAC,WAAM,CAAC;QACL,OAAO,KAAK,CAAC;IACjB,CAAC;AACL,CAAC,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoDG;AACI,IAAM,gCAAgC,GAAG;AAC5C,8DAA8D;AAC9D,wBAA6B,EAC7B,WAAoD,EACpD,QAAqC,EACrC,WAAoB,EACpB,eAAuB;IAEvB,IAAI,wBAAwB,KAAK,SAAS,IAAI,wBAAwB,KAAK,IAAI,EAAE,CAAC;QAC9E,OAAO,QAAQ,CAAC,+BAA+B,CAAC,WAAW,CAAC,CAAC;IACjE,CAAC;IAED,IAAI,WAAW,EAAE,CAAC;QACd,OAAO,QAAQ,CAAC,+BAA+B,CAAC,WAAW,CAAC,CAAC;IACjE,CAAC;IAED,IAAI,CAAC,WAAW,IAAI,OAAO,WAAW,CAAC,KAAK,KAAK,QAAQ,IAAI,OAAO,WAAW,CAAC,QAAQ,KAAK,QAAQ,IAAI,CAAC,WAAW,CAAC,KAAK,IAAI,CAAC,WAAW,CAAC,QAAQ,EAAE,CAAC;QACnJ,OAAO,QAAQ,CAAC,+BAA+B,CAAC,kBAAkB,CAAC,CAAC;IACxE,CAAC;IAED,IAAI,OAAO,QAAQ,CAAC,KAAK,KAAK,QAAQ,IAAI,OAAO,QAAQ,CAAC,QAAQ,KAAK,QAAQ,IAAI,CAAC,QAAQ,CAAC,KAAK,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE,CAAC;QACvH,OAAO,QAAQ,CAAC,+BAA+B,CAAC,kBAAkB,CAAC,CAAC;IACxE,CAAC;IAED,IAAM,YAAY,GACd,WAAW,CAAC,KAAK,CAAC,WAAW,EAAE,KAAK,QAAQ,CAAC,KAAK,CAAC,WAAW,EAAE;QAChE,WAAW,CAAC,QAAQ,CAAC,WAAW,EAAE,KAAK,QAAQ,CAAC,QAAQ,CAAC,WAAW,EAAE,CAAC;IAE3E,IAAI,CAAC,YAAY,EAAE,CAAC;QAChB,OAAO,QAAQ,CAAC,+BAA+B,CAAC,gBAAgB,CAAC,CAAC;IACtE,CAAC;IAED,IAAI,OAAO,WAAW,CAAC,MAAM,KAAK,QAAQ,IAAI,CAAC,WAAW,CAAC,MAAM,EAAE,CAAC;QAChE,OAAO,QAAQ,CAAC,+BAA+B,CAAC,gBAAgB,CAAC,CAAC;IACtE,CAAC;IAED,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC,MAAM,EAAE,eAAe,CAAC,EAAE,CAAC;QACnD,OAAO,QAAQ,CAAC,+BAA+B,CAAC,cAAc,CAAC,CAAC;IACpE,CAAC;IAED,IAAI,OAAO,wBAAwB,KAAK,QAAQ,IAAI,KAAK,CAAC,OAAO,CAAC,wBAAwB,CAAC,EAAE,CAAC;QAC1F,OAAO,QAAQ,CAAC,+BAA+B,CAAC,gBAAgB,CAAC,CAAC;IACtE,CAAC;IAED,8EAA8E;IAC9E,sEAAsE;IACtE,4DAA4D;IAC5D,IAAI,CAAC,wBAAwB,CAAC,wBAAwB,IAAI,OAAO,wBAAwB,CAAC,wBAAwB,KAAK,QAAQ,EAAE,CAAC;QAC9H,OAAO,QAAQ,CAAC,+BAA+B,CAAC,gBAAgB,CAAC,CAAC;IACtE,CAAC;IAED,IAAI,wBAAwB,CAAC,eAAe,KAAK,SAAS,IAAI,wBAAwB,CAAC,eAAe,KAAK,IAAI,EAAE,CAAC;QAC9G,OAAO,QAAQ,CAAC,+BAA+B,CAAC,sBAAsB,CAAC,CAAC;IAC5E,CAAC;IAED,IAAI,wBAAwB,CAAC,eAAe,KAAK,yBAAe,CAAC,EAAE,EAAE,CAAC;QAClE,OAAO,QAAQ,CAAC,+BAA+B,CAAC,0BAA0B,CAAC,CAAC;IAChF,CAAC;IAED,6EAA6E;IAC7E,wEAAwE;IACxE,8EAA8E;IAC9E,gDAAgD;IAChD,IAAM,YAAY,GAAG,wBAAwB,CAAC,QAAQ,CAAC;IACvD,IAAI,OAAO,YAAY,KAAK,QAAQ,IAAI,YAAY,CAAC,MAAM,GAAG,CAAC,IAAI,YAAY,CAAC,WAAW,EAAE,KAAK,QAAQ,CAAC,KAAK,CAAC,WAAW,EAAE,EAAE,CAAC;QAC7H,OAAO,QAAQ,CAAC,+BAA+B,CAAC,oBAAoB,CAAC,CAAC;IAC1E,CAAC;IAED,IAAM,eAAe,GAAG,wBAAwB,CAAC,wBAAwB,CAAC,iBAAiB,CAAC;IAC5F,IAAI,OAAO,eAAe,KAAK,QAAQ,IAAI,eAAe,CAAC,MAAM,GAAG,CAAC,IAAI,eAAe,CAAC,WAAW,EAAE,KAAK,QAAQ,CAAC,QAAQ,CAAC,WAAW,EAAE,EAAE,CAAC;QACzI,OAAO,QAAQ,CAAC,+BAA+B,CAAC,uBAAuB,CAAC,CAAC;IAC7E,CAAC;IAED,OAAO,QAAQ,CAAC;AACpB,CAAC,CAAC;AA1EW,QAAA,gCAAgC,oCA0E3C;AAEF,kBAAe,wCAAgC,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@microsoft/omnichannel-chat-sdk",
-  "version": "2.0.0",
+  "version": "2.0.1-main.b9e3cb3",
   "description": "Microsoft Omnichannel Chat SDK",
   "files": [
     "lib/**/*"