@ada-support/web-storage 1.2.9 → 1.3.0

package/.github/workflows/notify-people.yml

@@ -11,7 +11,7 @@ jobs:
   notify:
     runs-on: ubuntu-latest
     env:
-      SLACK_CHANNEL: "#chatx-engineering-internal" #default
+      SLACK_CHANNEL: "#t-messaging-experience" #default
       SLACK_USERNAME: "`@ada-support/web-storage` package updates"
       SLACK_ICON_EMOJI: ":sparkles:"
       SLACK_COLOR: "#f5e512"
@@ -21,10 +21,10 @@ jobs:
       MSG_MINIMAL: true
 
     steps:
-      - name: "Notify ChatX team"
+      - name: "Notify messaging-experience team"
         uses: rtCamp/action-slack-notify@v2
         env:
-          SLACK_CHANNEL: "#chatx-engineering-internal"
+          SLACK_CHANNEL: "#t-messaging-experience"
 
       - name: "Notify #p-cookies-updates-management"
         uses: rtCamp/action-slack-notify@v2

package/.github/workflows/npm-publish.yml

@@ -8,23 +8,35 @@ jobs:
   npm-publish:
     name: "NPM publish"
     runs-on: ubuntu-latest
+    # Trusted publishing (OIDC) mints a short-lived token from this workflow's
+    # identity instead of a long-lived NPM_TOKEN. `id-token: write` is required
+    # for npm to request the OIDC token; `contents: read` is least-privilege for
+    # checkout.
+    permissions:
+      contents: read
+      id-token: write
     steps:
       - name: "Checkout source code"
-        uses: "actions/checkout@v2"
-        env:
-          GITHUB_TOKEN: ${{ secrets.PUSH_ACCESS_TOKEN }}
+        uses: "actions/checkout@v4"
         with:
           ref: ${{ github.ref }}
 
-      - uses: actions/setup-node@v2
+      # NOTE: deliberately no `registry-url` here. setup-node's `registry-url`
+      # writes an .npmrc with `//registry.npmjs.org/:_authToken=${NODE_AUTH_TOKEN}`
+      # (resolving to setup-node's placeholder token). npm only uses OIDC trusted
+      # publishing when NO auth is configured, so that placeholder token shadows
+      # OIDC and the publish 404s. Without registry-url npm uses the default
+      # registry (registry.npmjs.org) with no token, so OIDC engages.
+      - uses: actions/setup-node@v4
         with:
-          node-version: "16.x"
-          registry-url: "https://registry.npmjs.org"
+          node-version: "20.x"
+
+      # OIDC trusted publishing requires npm >= 11.5.1; the npm bundled with Node
+      # 20 is older, so upgrade before publishing. (npm 11 itself needs Node >= 20.)
+      - run: npm install -g npm@latest
 
       - run: |
           yarn install
           yarn compile
           mv "README_NPM.md" "README.md"
           npm publish
-        env:
-          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

package/CODEOWNERS

@@ -1,3 +1,3 @@
-src/ @AdaSupport/channels-and-handoffs
+src/ @AdaSupport/messaging-experience
 src/third-party-items.ts @AdaSupport/security
 src/storage-keys.ts @AdaSupport/security

package/dist/ada-web-storage-list.html

@@ -209,12 +209,36 @@ border: 1px solid;
 <td>Persistent</td>
 </tr>
 <tr>
+<td>LaunchDarkly_[alphanumeric ID]_[alphanumeric ID]</td>
+<td>Used by LaunchDarkly to cache feature flag values for the chat widget. Scoped per bot (client_handle), not per end-user.</td>
+<td>Web Storage (functional)</td>
+<td>Persistent</td>
+</tr>
+<tr>
+<td>LaunchDarkly_[alphanumeric ID]_[alphanumeric ID]_freshness</td>
+<td>Used by LaunchDarkly to record when the associated cached feature flag values were last refreshed. Paired with the flag cache entry.</td>
+<td>Web Storage (functional)</td>
+<td>Persistent</td>
+</tr>
+<tr>
+<td>LaunchDarkly_[alphanumeric ID]_ContextIndex</td>
+<td>Used by LaunchDarkly to index evaluation contexts (bots) that have fetched feature flags for the chat widget.</td>
+<td>Web Storage (functional)</td>
+<td>Persistent</td>
+</tr>
+<tr>
 <td>liveChatPending</td>
 <td>Indicates whether user is waiting to connect to a live agent.</td>
 <td>Web Storage (functional)</td>
 <td>Persistent</td>
 </tr>
 <tr>
+<td>messagingAuthState</td>
+<td>Stores the messaging authentication state (a short-lived messaging access token and its expiry, a rotating session refresh token, and a refresh counter) used to authenticate the visitor's generative chat session with Ada. Set on the bot's Ada subdomain.</td>
+<td>Web Storage (functional)</td>
+<td>Persistent</td>
+</tr>
+<tr>
 <td>netDisruptionMsgStartTime</td>
 <td>Used to implement Chat reconnection after an interruption.</td>
 <td>Web Storage (functional)</td>

package/dist/storage-keys.d.ts

@@ -1,4 +1,15 @@
 import type { AdaFunctionalStorageValue } from "./functional-storage";
+/**
+ * Messaging JWT auth state. Defined as a named type (not an inline object) so the
+ * `StorageValueByKey` entry below stays brace-free — `generate-html.ts` parses that
+ * interface up to its first `}`, so an inline object value would truncate the parse.
+ */
+export interface MessagingAuthState {
+    messagingToken: string;
+    messagingTokenExpiresAt: number;
+    sessionRefreshToken: string;
+    refreshGeneration: number;
+}
 /**
  * IMPORTANT
  * You most likely don't need to modify anything here.
@@ -51,6 +62,8 @@ export interface StorageValueByKey {
     "previouslyAuthenticated": boolean;
     /** Used for chatter authentication. */
     "ada-embed_session-token": string;
+    /** Stores the messaging authentication state (a short-lived messaging access token and its expiry, a rotating session refresh token, and a refresh counter) used to authenticate the visitor's generative chat session with Ada. Set on the bot's Ada subdomain. */
+    "messagingAuthState": MessagingAuthState;
     /** Used to implement Chat reconnection after an interruption. */
     "backoffTimeout": number;
     /** Used during Oracle handoffs to indicate whether the agent has sent a request for a secret message. Allows the state to persist between page changes. */

package/dist/third-party-items.js

@@ -181,4 +181,25 @@ exports.THIRD_PARTY_ITEMS = [
         duration: "2 Year",
         purpose: ["Functional"]
     },
+    {
+        keyName: "LaunchDarkly_[alphanumeric ID]_[alphanumeric ID]",
+        description: "Used by LaunchDarkly to cache feature flag values for the chat widget. Scoped per bot (client_handle), not per end-user.",
+        type: "Web Storage",
+        duration: "Persistent",
+        purpose: ["Functional"]
+    },
+    {
+        keyName: "LaunchDarkly_[alphanumeric ID]_ContextIndex",
+        description: "Used by LaunchDarkly to index evaluation contexts (bots) that have fetched feature flags for the chat widget.",
+        type: "Web Storage",
+        duration: "Persistent",
+        purpose: ["Functional"]
+    },
+    {
+        keyName: "LaunchDarkly_[alphanumeric ID]_[alphanumeric ID]_freshness",
+        description: "Used by LaunchDarkly to record when the associated cached feature flag values were last refreshed. Paired with the flag cache entry.",
+        type: "Web Storage",
+        duration: "Persistent",
+        purpose: ["Functional"]
+    },
 ];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ada-support/web-storage",
-  "version": "1.2.9",
+  "version": "1.3.0",
   "description": "A package to provide access to Web Storage API",
   "main": "dist/index.js",
   "publishConfig": {

package/src/storage-keys.ts

@@ -1,5 +1,17 @@
 import type { AdaFunctionalStorageValue } from "./functional-storage";
 
+/**
+ * Messaging JWT auth state. Defined as a named type (not an inline object) so the
+ * `StorageValueByKey` entry below stays brace-free — `generate-html.ts` parses that
+ * interface up to its first `}`, so an inline object value would truncate the parse.
+ */
+export interface MessagingAuthState {
+  messagingToken: string;
+  messagingTokenExpiresAt: number;
+  sessionRefreshToken: string;
+  refreshGeneration: number;
+}
+
 /**
  * IMPORTANT
  * You most likely don't need to modify anything here.
@@ -73,6 +85,9 @@ export interface StorageValueByKey {
   /** Used for chatter authentication. */
   "ada-embed_session-token": string;
 
+  /** Stores the messaging authentication state (a short-lived messaging access token and its expiry, a rotating session refresh token, and a refresh counter) used to authenticate the visitor's generative chat session with Ada. Set on the bot's Ada subdomain. */
+  "messagingAuthState": MessagingAuthState;
+
   /** Used to implement Chat reconnection after an interruption. */
   "backoffTimeout": number;
 

package/src/third-party-items.ts

@@ -186,5 +186,29 @@ export const THIRD_PARTY_ITEMS: WebStorageItem[] = [
     duration: "2 Year",
     purpose: ["Functional"],
   },
+  {
+    keyName: "LaunchDarkly_[alphanumeric ID]_[alphanumeric ID]",
+    description:
+      "Used by LaunchDarkly to cache feature flag values for the chat widget. Scoped per bot (client_handle), not per end-user.",
+    type: "Web Storage",
+    duration: "Persistent",
+    purpose: ["Functional"],
+  },
+  {
+    keyName: "LaunchDarkly_[alphanumeric ID]_ContextIndex",
+    description:
+      "Used by LaunchDarkly to index evaluation contexts (bots) that have fetched feature flags for the chat widget.",
+    type: "Web Storage",
+    duration: "Persistent",
+    purpose: ["Functional"],
+  },
+  {
+    keyName: "LaunchDarkly_[alphanumeric ID]_[alphanumeric ID]_freshness",
+    description:
+      "Used by LaunchDarkly to record when the associated cached feature flag values were last refreshed. Paired with the flag cache entry.",
+    type: "Web Storage",
+    duration: "Persistent",
+    purpose: ["Functional"],
+  },
 
 ];