@proveanything/smartlinks 1.15.5 → 1.15.6

package/dist/docs/API_SUMMARY.md

@@ -1,6 +1,6 @@
 # Smartlinks API Summary
 
-Version: 1.15.5  |  Generated: 2026-07-18T14:07:37.915Z
+Version: 1.15.6  |  Generated: 2026-07-19T08:21:33.985Z
 
 This is a concise summary of all available API functions and types.
 

package/dist/docs/appConfig.md

@@ -220,20 +220,25 @@ Resolution rule (see `resolveFeature()` / `isFeatureEnabled()`, §6.0):
 | `false` (explicit) | **off**                       | off                                     |
 | absent             | **on** (enterprise default)    | off (standard default)                 |
 
-This is why reading `cfg.system.features.custom_domain` directly is wrong
+This is why reading `cfg.system.features.customDomain` directly is wrong
 for enterprise accounts — an absent key there does NOT mean disabled:
 
 ```ts
 // ❌ WRONG for enterprise accounts — absent key silently reads as "off"
-if (cfg.system.features.custom_domain) enableCustomDomainUI();
+if (cfg.system.features.customDomain) enableCustomDomainUI();
 
 // ✅ CORRECT — applies the enterprise default
-if (await appConfiguration.isFeatureEnabled(collectionId, 'custom_domain')) {
+if (await appConfiguration.isFeatureEnabled(collectionId, 'customDomain')) {
   enableCustomDomainUI();
 }
 ```
 
-Feature flag naming: bare snake_case, no `feature_` prefix.
+Feature flag naming: camelCase, no `feature`/`is`/`has` prefix (e.g.
+`customDomain`, not `feature_custom_domain` or `isCustomDomainEnabled`).
+Flags belonging to the same topic/module may use a dotted grouping prefix,
+e.g. `crm.broadcasts`, `crm.segments` — this is a plain string key in
+`features`, not a nested object, so resolve it the same way:
+`isFeatureEnabled(collectionId, 'crm.broadcasts')`.
 
 Always resolve flags through `appConfiguration.isFeatureEnabled(collectionId, flag)`
 / `isFeatureEnabledSync()` (§6.0), or `appConfiguration.resolveFeature(cfg.system, flag)`
@@ -308,7 +313,7 @@ every subsequent call — so calling it once per component, or once per
 render, doesn't cause repeat network requests.
 
 ```ts
-if (await SL.appConfiguration.isFeatureEnabled(collectionId, 'custom_domain')) {
+if (await SL.appConfiguration.isFeatureEnabled(collectionId, 'customDomain')) {
   enableCustomDomainUI();
 }
 ```
@@ -321,11 +326,11 @@ cache once during app init and use the sync variant afterwards:
 ```ts
 // Once, e.g. in a top-level effect or before first render:
 useEffect(() => {
-  SL.appConfiguration.isFeatureEnabled(collectionId, 'custom_domain')
+  SL.appConfiguration.isFeatureEnabled(collectionId, 'customDomain')
 }, [collectionId]);
 
 // Anywhere else, read synchronously — no await:
-const enabled = SL.appConfiguration.isFeatureEnabledSync(collectionId, 'custom_domain');
+const enabled = SL.appConfiguration.isFeatureEnabledSync(collectionId, 'customDomain');
 if (enabled === undefined) {
   // not warmed yet this page load — treat as "not yet known", not "off"
 }
@@ -341,7 +346,7 @@ to bypass it — e.g. immediately after your own code calls
 `entitlements-reconcile` and the flags may have changed:
 
 ```ts
-await SL.appConfiguration.isFeatureEnabled(collectionId, 'custom_domain', { force: true });
+await SL.appConfiguration.isFeatureEnabled(collectionId, 'customDomain', { force: true });
 ```
 
 ### 6.1 Reading the raw config
@@ -481,3 +486,7 @@ CRM visibility), not just a capability flag.
   `isFeatureEnabled()` like everything else. Reading `cfg.system.features[flag]`
   directly is no longer correct for enterprise accounts — always resolve
   through one of these three.
+- **2026-07-19**: Corrected flag naming convention (§4.4): flags are
+  camelCase (e.g. `customDomain`), not snake_case, and may use a dotted
+  grouping prefix for a topic/module (e.g. `crm.broadcasts`). Updated all
+  examples in this doc accordingly.

package/docs/API_SUMMARY.md

@@ -1,6 +1,6 @@
 # Smartlinks API Summary
 
-Version: 1.15.5  |  Generated: 2026-07-18T14:07:37.915Z
+Version: 1.15.6  |  Generated: 2026-07-19T08:21:33.985Z
 
 This is a concise summary of all available API functions and types.
 

package/docs/appConfig.md

@@ -220,20 +220,25 @@ Resolution rule (see `resolveFeature()` / `isFeatureEnabled()`, §6.0):
 | `false` (explicit) | **off**                       | off                                     |
 | absent             | **on** (enterprise default)    | off (standard default)                 |
 
-This is why reading `cfg.system.features.custom_domain` directly is wrong
+This is why reading `cfg.system.features.customDomain` directly is wrong
 for enterprise accounts — an absent key there does NOT mean disabled:
 
 ```ts
 // ❌ WRONG for enterprise accounts — absent key silently reads as "off"
-if (cfg.system.features.custom_domain) enableCustomDomainUI();
+if (cfg.system.features.customDomain) enableCustomDomainUI();
 
 // ✅ CORRECT — applies the enterprise default
-if (await appConfiguration.isFeatureEnabled(collectionId, 'custom_domain')) {
+if (await appConfiguration.isFeatureEnabled(collectionId, 'customDomain')) {
   enableCustomDomainUI();
 }
 ```
 
-Feature flag naming: bare snake_case, no `feature_` prefix.
+Feature flag naming: camelCase, no `feature`/`is`/`has` prefix (e.g.
+`customDomain`, not `feature_custom_domain` or `isCustomDomainEnabled`).
+Flags belonging to the same topic/module may use a dotted grouping prefix,
+e.g. `crm.broadcasts`, `crm.segments` — this is a plain string key in
+`features`, not a nested object, so resolve it the same way:
+`isFeatureEnabled(collectionId, 'crm.broadcasts')`.
 
 Always resolve flags through `appConfiguration.isFeatureEnabled(collectionId, flag)`
 / `isFeatureEnabledSync()` (§6.0), or `appConfiguration.resolveFeature(cfg.system, flag)`
@@ -308,7 +313,7 @@ every subsequent call — so calling it once per component, or once per
 render, doesn't cause repeat network requests.
 
 ```ts
-if (await SL.appConfiguration.isFeatureEnabled(collectionId, 'custom_domain')) {
+if (await SL.appConfiguration.isFeatureEnabled(collectionId, 'customDomain')) {
   enableCustomDomainUI();
 }
 ```
@@ -321,11 +326,11 @@ cache once during app init and use the sync variant afterwards:
 ```ts
 // Once, e.g. in a top-level effect or before first render:
 useEffect(() => {
-  SL.appConfiguration.isFeatureEnabled(collectionId, 'custom_domain')
+  SL.appConfiguration.isFeatureEnabled(collectionId, 'customDomain')
 }, [collectionId]);
 
 // Anywhere else, read synchronously — no await:
-const enabled = SL.appConfiguration.isFeatureEnabledSync(collectionId, 'custom_domain');
+const enabled = SL.appConfiguration.isFeatureEnabledSync(collectionId, 'customDomain');
 if (enabled === undefined) {
   // not warmed yet this page load — treat as "not yet known", not "off"
 }
@@ -341,7 +346,7 @@ to bypass it — e.g. immediately after your own code calls
 `entitlements-reconcile` and the flags may have changed:
 
 ```ts
-await SL.appConfiguration.isFeatureEnabled(collectionId, 'custom_domain', { force: true });
+await SL.appConfiguration.isFeatureEnabled(collectionId, 'customDomain', { force: true });
 ```
 
 ### 6.1 Reading the raw config
@@ -481,3 +486,7 @@ CRM visibility), not just a capability flag.
   `isFeatureEnabled()` like everything else. Reading `cfg.system.features[flag]`
   directly is no longer correct for enterprise accounts — always resolve
   through one of these three.
+- **2026-07-19**: Corrected flag naming convention (§4.4): flags are
+  camelCase (e.g. `customDomain`), not snake_case, and may use a dotted
+  grouping prefix for a topic/module (e.g. `crm.broadcasts`). Updated all
+  examples in this doc accordingly.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@proveanything/smartlinks",
-  "version": "1.15.5",
+  "version": "1.15.6",
   "description": "Official JavaScript/TypeScript SDK for the Smartlinks API",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",