@botonic/shared 2.28.0 → 2.29.0

package/CHANGELOG.md

@@ -1,3 +1,13 @@
+## 2.29.0 (2026-05-12)
+
+### 🚀 Features
+
+- rating component ([#882](https://github.com/metis-ai/hubtype-product/pull/882))
+
+### ❤️ Thank You
+
+- Marc Rabat @vanbasten17
+
 ## 2.28.0 (2026-05-06)
 
 This was a version bump only for @botonic/shared to align it with other projects, there were no code changes.

package/README.md

@@ -27,3 +27,14 @@ pnpm add @botonic/shared
 # or
 npm install @botonic/shared
 ```
+
+## Webchat rating submit payload (builtin)
+
+Built-in webchat rating UI (and demos that follow it) send postbacks with the same **`prefix|JSON`** pattern as webchat client settings:
+
+- **Prefix:** `submit-webchat-rating` (`SUBMIT_WEBCHAT_RATING_PAYLOAD`).
+- **Helpers:** `createSubmitWebchatRatingPayload`, `parseSubmitWebchatRatingPayload`, `isSubmitWebchatRatingPayload`.
+
+Flow Builder **CMS** rating nodes may still use **`agent-rating|…`** and other CMS-defined payloads; those are separate from this builtin contract. Custom **`payloads`** arrays on rating custom messages override defaults and are sent as-is.
+
+With **`@botonic/webchat-react`**, the UI for **`BOTONIC_OUTPUT_RATING`** (`botonic-output-rating`) is registered automatically in `customMessages`. Pass your own component under the same key only when you need to replace the default **`RatingMessage`**.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@botonic/shared",
-  "version": "2.28.0",
+  "version": "2.29.0",
   "type": "module",
   "module": "./src/index.js",
   "types": "./src/index.d.ts",

package/src/lib/domain/botonic/index.d.ts

@@ -6,5 +6,6 @@ export * from './session';
 export * from './settings';
 export * from './types';
 export * from './webchat-client-settings';
+export * from './webchat-outputs';
 export * from './webviews-session';
 export * from './whatsapp-outputs';

package/src/lib/domain/botonic/index.js

@@ -6,6 +6,7 @@ export * from './session';
 export * from './settings';
 export * from './types';
 export * from './webchat-client-settings';
+export * from './webchat-outputs';
 export * from './webviews-session';
 export * from './whatsapp-outputs';
 //# sourceMappingURL=index.js.map

package/src/lib/domain/botonic/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../../../../libs/botonic/shared/src/lib/domain/botonic/index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAA;AAC5B,cAAc,UAAU,CAAA;AACxB,cAAc,YAAY,CAAA;AAC1B,cAAc,WAAW,CAAA;AACzB,cAAc,WAAW,CAAA;AACzB,cAAc,YAAY,CAAA;AAC1B,cAAc,SAAS,CAAA;AACvB,cAAc,2BAA2B,CAAA;AACzC,cAAc,oBAAoB,CAAA;AAClC,cAAc,oBAAoB,CAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../../../../libs/botonic/shared/src/lib/domain/botonic/index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAA;AAC5B,cAAc,UAAU,CAAA;AACxB,cAAc,YAAY,CAAA;AAC1B,cAAc,WAAW,CAAA;AACzB,cAAc,WAAW,CAAA;AACzB,cAAc,YAAY,CAAA;AAC1B,cAAc,SAAS,CAAA;AACvB,cAAc,2BAA2B,CAAA;AACzC,cAAc,mBAAmB,CAAA;AACjC,cAAc,oBAAoB,CAAA;AAClC,cAAc,oBAAoB,CAAA"}

package/src/lib/domain/botonic/webchat-outputs/index.d.ts

@@ -0,0 +1 @@
+export * from './webchat-output-rating';

package/src/lib/domain/botonic/webchat-outputs/index.js

@@ -0,0 +1,2 @@
+export * from './webchat-output-rating';
+//# sourceMappingURL=index.js.map

package/src/lib/domain/botonic/webchat-outputs/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../../../../../libs/botonic/shared/src/lib/domain/botonic/webchat-outputs/index.ts"],"names":[],"mappings":"AAAA,cAAc,yBAAyB,CAAA"}

package/src/lib/domain/botonic/webchat-outputs/webchat-output-rating/index.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Built-in webchat output names emitted by Hubtype Botonic packages.
+ *
+ * `@botonic/webchat-react` registers matching renderers automatically (merged with
+ * embedder `customMessages`; embedder keys override builtins). You only need to add
+ * keys here yourself when using a custom webchat composition that does not use the
+ * default provider merge.
+ *
+ * Note: Flow Builder **content node** types (e.g. `type: 'rating'` in flow JSON) are
+ * separate from the wire **`name`** on custom chat messages.
+ */
+export * from './webchat-output-rating';

package/src/lib/domain/botonic/webchat-outputs/webchat-output-rating/index.js

@@ -0,0 +1,13 @@
+/**
+ * Built-in webchat output names emitted by Hubtype Botonic packages.
+ *
+ * `@botonic/webchat-react` registers matching renderers automatically (merged with
+ * embedder `customMessages`; embedder keys override builtins). You only need to add
+ * keys here yourself when using a custom webchat composition that does not use the
+ * default provider merge.
+ *
+ * Note: Flow Builder **content node** types (e.g. `type: 'rating'` in flow JSON) are
+ * separate from the wire **`name`** on custom chat messages.
+ */
+export * from './webchat-output-rating';
+//# sourceMappingURL=index.js.map

package/src/lib/domain/botonic/webchat-outputs/webchat-output-rating/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../../../../../../libs/botonic/shared/src/lib/domain/botonic/webchat-outputs/webchat-output-rating/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AACH,cAAc,yBAAyB,CAAA"}

package/src/lib/domain/botonic/webchat-outputs/webchat-output-rating/webchat-output-rating.d.ts

@@ -0,0 +1,14 @@
+export declare const WEBCHAT_OUTPUT_RATING: "botonic-output-rating";
+/** Matches Flow Builder / CMS `rating_type` wire values. */
+export type WebchatOutputRatingRatingType = 'stars' | 'smileys';
+export interface WebchatOutputRatingButton {
+    value: number;
+    payload: string;
+}
+export interface WebchatOutputRatingProps {
+    messageText?: string;
+    buttonText?: string;
+    /** JSON-serialised {@link WebchatOutputRatingButton} entries — one per rating option. */
+    payloads?: string[];
+    ratingType?: WebchatOutputRatingRatingType;
+}

package/src/lib/domain/botonic/webchat-outputs/webchat-output-rating/webchat-output-rating.js

@@ -0,0 +1,2 @@
+export const WEBCHAT_OUTPUT_RATING = 'botonic-output-rating';
+//# sourceMappingURL=webchat-output-rating.js.map

package/src/lib/domain/botonic/webchat-outputs/webchat-output-rating/webchat-output-rating.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"webchat-output-rating.js","sourceRoot":"","sources":["../../../../../../../../../../libs/botonic/shared/src/lib/domain/botonic/webchat-outputs/webchat-output-rating/webchat-output-rating.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,qBAAqB,GAAG,uBAAgC,CAAA"}