@feedmepos/mf-connect 0.1.112-prod → 0.1.113-beta.3

package/README.md

@@ -20,6 +20,71 @@ pnpm dev
 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.
+
+#### Local setup
+
+Configure these in the backend's local environment, then restart campaign-service:
+
+```dotenv
+FLAGSMITH_URL=https://flagsmith.feedme.farm/api/v1/
+FLAGSMITH_ENVIRONMENT_KEY=<Development environment SDK 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.
+
+#### 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.
+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.
+
+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.
+
+#### 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.
+
 ### Formatting is with prettier, set default formatter to Prettier
 ```json
 "[typescript]": {
@@ -28,4 +93,4 @@ pnpm build
 "[vue]": {
   "editor.defaultFormatter": "esbenp.prettier-vscode"
 }
-```
+```