@mediansh/widget 0.2.1 → 0.5.0

package/dist/index.d.ts

@@ -69,8 +69,7 @@ type MedianUser = {
     metadata?: Record<string, string>;
 };
 
-type MedianSupportProps = {
-    apiKey: string;
+type MedianSupportOptions = {
     /** Who is signed in on the host's site, if anyone. Shown to the team. */
     user?: MedianUser;
     /**
@@ -119,6 +118,22 @@ type MedianSupportProps = {
      * redeploy, and either side saying no is enough to keep it away.
      */
     requireEmail?: boolean;
+    /**
+     * Show the first lines of an unread reply on the closed button. On by
+     * default: the count says something arrived, and the card is what says
+     * whether it is worth opening.
+     *
+     *   <MedianSupport apiKey="median_pk_..." messagePreview={false} />
+     *
+     * Pass `false` and the corner stays a button with a count on it. Nothing
+     * else changes: the reply is still there, still counted, still announced.
+     * For a page where a customer's words should never appear unprompted,
+     * over somebody's shoulder or in a screen share.
+     *
+     * Your team can turn it off from the dashboard without a redeploy, and
+     * either side saying no is enough to keep the card away.
+     */
+    messagePreview?: boolean;
     /**
      * Watch what goes wrong on the page, so a bug report arrives with the
      * error already attached instead of after four messages of asking.
@@ -175,6 +190,25 @@ type MedianSupportProps = {
      */
     onNavigate?: (path: string) => void;
 };
+/**
+ * Two ways in, and every app has one of them.
+ *
+ * `apiKey` is the publishable id, and on its own it opens an anonymous
+ * thread. `identity` is the path to a route built with `medianIdentity`,
+ * which answers with the key and with whoever is signed in, already signed.
+ * A framework that renders its root layout on the server cannot hand this
+ * component a session any other way, so that is most of them.
+ *
+ * Passing both is worth it on a slow session: the button is up on the key
+ * from the prop straight away, and the person arrives when the route answers.
+ */
+type MedianSupportProps = MedianSupportOptions & ({
+    apiKey: string;
+    identity?: string;
+} | {
+    apiKey?: string;
+    identity: string;
+});
 /**
  * The whole SDK, as one component. Drop it on a page with your publishable API
  * key and the launcher, the thread, the AI and the inbox on the other side are
@@ -380,8 +414,7 @@ type MedianSupportControl = {
  */
 declare function useMedianSupport(): MedianSupportControl;
 
-type MedianFeedbackProps = {
-    apiKey: string;
+type MedianFeedbackOptions = {
     /**
      * Your own trigger. Whatever you pass is rendered where you put it and the
      * panel hangs off it, the way a dropdown hangs off the thing that opens
@@ -444,6 +477,34 @@ type MedianFeedbackProps = {
     description?: string;
     placeholder?: string;
 };
+/**
+ * Two ways in, the same two `<MedianSupport>` takes.
+ *
+ * `apiKey` is the publishable id on its own. `identity` is the path to a
+ * route built with `medianIdentity`, which answers with the key and with
+ * whoever is signed in, already signed. Pass both and the panel is usable on
+ * the key from the prop while the route is still answering.
+ */
+type MedianFeedbackProps = MedianFeedbackOptions & ({
+    apiKey: string;
+    identity?: string;
+} | {
+    apiKey?: string;
+    identity: string;
+});
+/**
+ * The same two ways in, for a host without JSX. Spelled out rather than
+ * `Omit`ped off the props above, because omitting a key from a union of two
+ * shapes flattens it into one and loses the "either, but not neither" the
+ * union is there to say.
+ */
+type MedianFeedbackMountOptions = Omit<MedianFeedbackOptions, "children"> & ({
+    apiKey: string;
+    identity?: string;
+} | {
+    apiKey?: string;
+    identity: string;
+});
 /**
  * A feedback panel, hung off a trigger of your own.
  *
@@ -493,7 +554,7 @@ type MedianFeedbackInstance = {
  * right corner and your own button says when. Everything else is the
  * component's, unchanged.
  */
-declare function mountMedianFeedback(options: Omit<MedianFeedbackProps, "children">): MedianFeedbackInstance;
+declare function mountMedianFeedback(options: MedianFeedbackMountOptions): MedianFeedbackInstance;
 
 declare const medianFeedback: {
     /** What the panel is doing right now. */