@feedmepos/mf-connect 0.1.116-dev → 0.1.117-dev

package/README.md

@@ -22,70 +22,68 @@ pnpm build
 
 ### Feature Flags
 
-The WhatsApp Bot area reads `crm_whatsapp_bot` from Flagsmith through
-`GET /portal/businesses/:businessId/feature-flags` on campaign-service. The exact
-business `_id` is the Flagsmith identity identifier. The backend checks the
-identity's **Enabled** state, including identity and segment overrides; a remote
-config value of `true` is not required.
-
-This reuses the backend's existing `FeatureFlagModule` and
-`FeatureFlagService.getIdentityFlags(businessId)`, also used by credit OTP
-evaluation. The SDK configuration and initialization are shared with that existing
-integration.
-
-Connect fetches flags on startup, business/country/user changes, and every 60
-seconds after each completed request. The sidebar stays hidden and WhatsApp views
-stay unmounted until enabled. Direct links wait for the initial check; disabled
-or failed checks redirect to analytics. Failed checks are retried automatically.
+Connect uses `@feedmepos/feature-flag` directly in the frontend. WhatsApp Bot
+shares the business flag loading used by broadcast channels in
+`src/feature-flag.ts` and uses the `connect_whatsapp_bot` flag.
+
+| Feature             | Flagsmith key                           |
+| ------------------- | --------------------------------------- |
+| WhatsApp Bot        | `connect_whatsapp_bot`                  |
+| Broadcast App Inbox | `connect_broadcast_app_inbox_countries` |
+| Broadcast Push      | `connect_broadcast_push_countries`      |
+| Broadcast WhatsApp  | `connect_broadcast_whatsapp_countries`  |
+
+WhatsApp Bot checks only whether `connect_whatsapp_bot` is enabled. Its remote
+config value and the selected country do not affect access; no remote config
+value is required.
+
+Broadcast channel flags also check the current business country. Their values are
+comma-separated country codes, such as `MY,SG`; an empty value or `*` allows every
+country. Country codes are case-insensitive.
+
+Connect loads flags on startup and when the selected business changes. Country
+changes re-evaluate broadcast channel flags. The WhatsApp sidebar entry stays
+hidden and WhatsApp views stay unmounted while flags load. Direct links show a
+loading screen until the check finishes; disabled or failed checks redirect to
+analytics.
 
 #### Local setup
 
-Configure these in the backend's local environment, then restart campaign-service:
+Set the frontend Flagsmith API key in Connect's local environment, then restart
+the Vite dev server:
 
 ```dotenv
-FLAGSMITH_URL=https://flagsmith.feedme.farm/api/v1/
-FLAGSMITH_ENVIRONMENT_KEY=<Development environment SDK key>
+FEATURE_FLAG_API_KEY=<Development environment client key>
 ```
 
-Use an environment SDK key, not an organisation admin token. The key stays on the
-backend. Replace the obsolete singular hostname `flag.feedme.farm` if present.
-The backend requires network access to Flagsmith (normally Twingate).
-As with the existing Flagsmith integration, a missing SDK key prevents the service
-from starting.
-
-Point Connect's local `BACKEND_SERVICE_URL` at `http://localhost:3000/portal/`
-(or your campaign-service port), then start/restart the Vite dev server. Localhost
-uses the same flag checks as deployed environments.
+This is the same frontend configuration used by broadcast channel flags.
 
 #### Enable selected businesses
 
 1. In <https://flagsmith.feedme.farm>, open organisation **Feedme**, project
    **MAIN**, and **Development** for local testing.
-2. Create `crm_whatsapp_bot` if missing and leave the environment default disabled.
+2. Create or rename the flag to `connect_whatsapp_bot`, disabled by default.
 3. Open Connect with the desired business selected. The first flag evaluation
    registers that business ID as a Flagsmith identity.
-4. In **Identities**, find that exact business `_id` and enable the
-   `crm_whatsapp_bot` identity override. Other businesses remain disabled unless
-   an identity or segment override enables them.
-5. Wait up to 60 seconds after the last check, or reload Connect, then open
-   `/whatsapp`. To revoke access, disable the override.
+4. In **Identities**, find `business-<businessId>` and enable the
+   `connect_whatsapp_bot` override. Identity or segment overrides can enable selected
+   businesses; no country-list value is required.
+5. Reload Connect, then open `/whatsapp`. To revoke access, disable the override
+   and reload.
 
-Configure **Production** separately and deploy the backend with that environment's
-SDK key. This flag controls page visibility; existing WhatsApp API permissions
-continue to apply. The `fm-flagsmith` skill can inspect configuration and overrides;
-its GET-only helper cannot create or change them.
+Configure **Production** separately with its frontend API key. This flag controls
+page visibility; existing WhatsApp API permissions continue to apply.
 
 #### Verify locally
 
-With Connect signed in, inspect the browser's Network tab for
-`GET http://localhost:3000/portal/businesses/<businessId>/feature-flags`.
-Its response data should contain `crm_whatsapp_bot: true` for an enabled identity
-and `false` for other businesses. HTTP 503 indicates a failed Flagsmith evaluation
-(check the SDK key, URL, and network access); 403 indicates missing business settings
-permission. A 404 usually means campaign-service needs restarting or Connect is
-pointing at the wrong backend.
+With Connect signed in, inspect the browser's Network tab for the frontend
+Flagsmith request using identity `business-<businessId>`. Verify the WhatsApp Bot
+navigation entry and `/whatsapp` are available only when
+`connect_whatsapp_bot` is enabled. Disabled, missing, or failed flag checks keep the
+entry hidden and redirect direct links to analytics.
 
 ### Formatting is with prettier, set default formatter to Prettier
+
 ```json
 "[typescript]": {
   "editor.defaultFormatter": "esbenp.prettier-vscode"