@feedmepos/mf-common 1.28.2 → 1.28.6

package/README.md

@@ -11,3 +11,89 @@ This package provide:
 ## Changelog
 
 See [CHANGELOG.md](./CHANGELOG.md) for details about changes in each version.
+
+---
+
+# Remy Integration Guide
+
+## Overview
+
+The common package provides a simplified interface for integrating Remy AI assistant into microfrontends. The responsibility of the common package is only to:
+
+1. Register a callback when Remy icon is clicked
+2. Show/hide the Remy icon based on callback registration
+3. Trigger the callback when the icon is clicked
+
+## Usage
+
+### 1. Register Remy Callback
+
+In your microfrontend (e.g., `mf-menu`), register a callback that will be triggered when the Remy icon is clicked:
+
+```typescript
+import { useCoreStore } from '@feedmepos/common'
+
+const coreStore = useCoreStore()
+
+// Register your callback
+coreStore.registerOnRemyClicked(() => {
+  // Your Remy logic here
+  // For example: open Remy dialog, activate Remy session, etc.
+  console.log('Remy icon clicked!')
+})
+```
+
+### 2. Automatic Icon Display
+
+When you register the callback:
+- The `publicSetting.aiSettings.remy.enable` will be automatically set to `true`
+- The Remy icon will appear on Desktop, Mobile, and Tablet views
+- The icon is a video element showing the Remy animation
+
+### 3. Icon Click Behavior
+
+When a user clicks the Remy icon:
+- The registered callback will be triggered
+- You control what happens next (open dialog, start session, etc.)
+
+## Implementation Details
+
+### Desktop (PortalDesktop.vue)
+- Icon appears in the header next to user info
+- Positioned before debug and storefront buttons
+
+### Mobile (PortalMobile.vue)
+- Icon appears in the footer navigation
+- Positioned next to the more menu button
+
+### Tablet (PortalTablet.vue)
+- Icon appears in the header
+- Similar position to desktop view
+
+## Example: Full Integration
+
+```typescript
+// In your microfrontend's main component or setup
+import { onMounted } from 'vue'
+import { useCoreStore } from '@feedmepos/common'
+import { Remy } from './helper/remy' // Your Remy client
+
+onMounted(async () => {
+  const coreStore = useCoreStore()
+  
+  // Initialize your Remy client
+  await Remy.init()
+  
+  // Register callback to handle Remy icon clicks
+  coreStore.registerOnRemyClicked(() => {
+    Remy.toggleDialog(true)
+  })
+})
+```
+
+## Benefits
+
+1. **Decoupled**: Common package doesn't need to know about Remy implementation details
+2. **Flexible**: Each microfrontend can implement their own Remy behavior
+3. **Simple API**: Only one method to register, icon visibility is automatic
+4. **Consistent UX**: Icon appears in the same place across all views

package/dist/{CustomAttributesForm-717e953b.js → CustomAttributesForm-e78f15d5.js}

@@ -1,5 +1,5 @@
 import { defineComponent as A, computed as d, resolveComponent as N, openBlock as f, createElementBlock as b, createVNode as S, toDisplayString as C, unref as F, h } from "vue";
-import { t as w, u as O } from "./app-dc181a5c.js";
+import { t as w, u as O } from "./app-9b38f0c2.js";
 import { components as y } from "@feedmepos/ui-library";
 import { c as x } from "./object-27ce045b.js";
 import "pinia";

package/dist/Entry.vue.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Entry.vue.d.ts","sourceRoot":"","sources":["../../src/Entry.vue.ts"],"names":[],"mappings":";AA0VA,wBAKG"}
+{"version":3,"file":"Entry.vue.d.ts","sourceRoot":"","sources":["../../src/Entry.vue.ts"],"names":[],"mappings":";AAyWA,wBAKG"}

package/dist/{ItemSelector-370ffe7a.js → ItemSelector-18dccc18.js}

@@ -1,5 +1,5 @@
 import { ref as fr, computed as Ut, defineComponent as ec, onMounted as tc, watch as bs, resolveComponent as ea, openBlock as jt, createElementBlock as an, createElementVNode as At, toDisplayString as ys, unref as Ct, createVNode as Kt, isRef as nc, createCommentVNode as Ur, Fragment as nu, renderList as ru, createBlock as ta, withCtx as iu, normalizeClass as Pu, Transition as vs } from "vue";
-import { c as $r, l as U, d as Te, e as We, f as rc, u as Du, g as ic, a as ac, O as ws, t as oc, b as uc } from "./app-dc181a5c.js";
+import { c as $r, l as U, d as Te, e as We, f as rc, u as Du, g as ic, a as ac, O as ws, t as oc, b as uc } from "./app-9b38f0c2.js";
 import { FmButtonVariant as Gr } from "@feedmepos/ui-library";
 import { defineStore as sc } from "pinia";
 import { c as Lr } from "./object-27ce045b.js";

package/dist/{RestaurantSelector-53eae27d.js → RestaurantSelector-0a2d4d60.js}

@@ -1,5 +1,5 @@
 import { ref as S, computed as o, defineComponent as ae, mergeModels as ne, useModel as ue, watch as j, resolveComponent as k, openBlock as i, createElementBlock as b, createElementVNode as C, createVNode as y, withCtx as L, normalizeClass as re, toDisplayString as oe, createCommentVNode as N, createBlock as O, withModifiers as K, unref as g, isRef as se, Fragment as Q, renderList as T, renderSlot as ie, nextTick as ce } from "vue";
-import { t as ve, u as de, a as fe, O as E, b as me } from "./app-dc181a5c.js";
+import { t as ve, u as de, a as fe, O as E, b as me } from "./app-9b38f0c2.js";
 import "@feedmepos/ui-library";
 import "pinia";
 import "vue-router";