@getuserfeedback/adapters 0.5.0 → 0.5.1

package/README.md

@@ -6,25 +6,20 @@
 
 The `@getuserfeedback/adapters/gtm` entrypoint is the authoritative source for Google Tag Manager template generation. It owns:
 
-- GTM consent mapping logic
-- GTM theme normalization logic
+- GTM color scheme normalization logic
 - GTM template parameter generation
 - GTM runtime source generation
 - GTM permission generation
+- GTM importable `template.tpl` file generation
 - GTM template defaults, help text, and option labels
 - the canonical loader script base URL pattern
 
 ### Public exports
 
-Core mappings:
+Template inputs and init translation:
 
 - `GTM_CONSENT_TYPES`
-- `ESSENTIAL_GTM_SCOPES`
-- `DEFAULT_GTM_SCOPE_MAPPINGS`
-- `GTM_TEMPLATE_SCOPE_OPTIONS`
-- `GTM_TEMPLATE_MAPPING_OPTIONS`
 - `isGtmConsentType(value)`
-- `isHostConfigurableGtmScope(scope)`
 - `normalizeGtmThemeInput(input)`
 - `resolveDefaultConsentFromGtm(input)`
 - `buildInitOptionsFromGtmTemplate(input)`
@@ -34,11 +29,7 @@ Types:
 - `GtmConsentType`
 - `GtmConsentValue`
 - `GtmConsentState`
-- `GtmScopeMapping`
-- `GtmAnalyticsMeasurementMode`
 - `GtmTemplateInput`
-- `GtmTemplateScopeOption`
-- `GtmTemplateMappingOption`
 
 Template generation:
 
@@ -49,29 +40,19 @@ Template generation:
 - `buildGtmTemplateInfo(options?)`
 - `buildGtmTemplateParts(options?)`
 - `buildGtmTemplateArtifact(options?)`
+- `buildGtmTemplateFileSource(options?)`
 
-### Essential scope policy
+### Consent behavior
 
-`functionality.storage` and `security.storage` are essential baseline scopes.
+The GTM template no longer exposes consent settings in its UI.
 
-- They remain accepted by the protocol for backward compatibility.
-- They are not host-configurable in GTM-generated consent UI.
-- They are not emitted in GTM-generated host-overridable default consent output.
-- Generated help text states that they are fixed by the loader.
+- Default consent is derived automatically from Google Consent Mode state.
+- `analytics.measurement` follows `analytics.storage`.
+- If no GTM consent state is available, the adapter leaves `defaultConsent` unset.
 
-### Analytics measurement policy
+### Color scheme behavior
 
-Automatic GTM consent mode exposes an explicit analytics measurement policy:
-
-- `inherit-analytics-storage`
-- `granted`
-- `denied`
-
-Manual GTM consent mode does not apply hidden analytics measurement behavior. It only uses the generated host-configurable scope mappings.
-
-### Theme behavior
-
-Generated GTM theme support accepts:
+Generated GTM color scheme support accepts:
 
 - fixed `light`
 - fixed `dark`
@@ -80,35 +61,56 @@ Generated GTM theme support accepts:
 - GTM variable-driven values
 - comma-separated auto-detect attribute lists
 
-The adapter normalizes all theme inputs into protocol-valid `colorScheme`.
+The adapter normalizes all of these into protocol-valid `colorScheme`.
 
-### Generate a GTM template artifact
+### Identity behavior
+
+The generated template supports:
+
+- `Intelligent` mode, which reads common data-layer keys for user ID, email, phone, first name, and last name
+- `Custom` mode, which lets GTM explicitly map a main identity and traits
+- `Disabled` mode, which skips identify entirely
+
+### Generate GTM output
 
 ```ts
-import { buildGtmTemplateArtifact } from "@getuserfeedback/adapters/gtm";
+import {
+	buildGtmTemplateArtifact,
+	buildGtmTemplateFileSource,
+} from "@getuserfeedback/adapters/gtm";
 
 const artifact = buildGtmTemplateArtifact({
 	loaderScriptBaseUrl: "https://cdn.getuserfeedback.com/widget/loader/v1",
 });
 
-artifact.info;
-artifact.parameters;
-artifact.runtimeSource;
-artifact.permissions;
+const templateFile = buildGtmTemplateFileSource({
+	loaderScriptBaseUrl: "https://cdn.getuserfeedback.com/widget/loader/v1",
+});
+```
+
+Use the package script to write a local importable file:
+
+```sh
+bun run generate:gtm-template
 ```
 
-The returned object is suitable for rendering into GTM `___INFO___`, `___TEMPLATE_PARAMETERS___`, `___SANDBOXED_JS_FOR_WEB_TEMPLATE___`, and `___WEB_PERMISSIONS___` sections.
+For the sandbox-backed GTM smoke:
+
+```sh
+bun run generate:gtm-template:sandbox-hybrid
+```
+
+`buildGtmTemplateArtifact()` returns the rendered GTM sections. `buildGtmTemplateFileSource()` returns a full importable `template.tpl`.
 
 ### What the GTM repo should still own
 
 After importing the published package, the GTM repo should only own:
 
-- GTM Gallery wrapper file assembly
 - brand thumbnail and base64 image assets
 - `metadata.yaml`
 - publishing and release workflow
 
-It should not rebuild parameters, runtime source, permissions, or GTM-specific init payload translation.
+It should not rebuild parameters, runtime source, permissions, file assembly, or GTM-specific init payload translation.
 
 ### Customizing the loader base URL
 
@@ -118,9 +120,12 @@ Pass `loaderScriptBaseUrl` to:
 - `buildGtmPermissions`
 - `buildGtmTemplateParts`
 - `buildGtmTemplateArtifact`
+- `buildGtmTemplateFileSource`
 
 The same base URL is used to derive the runtime loader URL and the `inject_script` permission pattern.
 
+Pass `runtimeEndpoints` when you need the generated template to point loader bootstrap at non-default `core` and `api` endpoints.
+
 ### Versioning expectations
 
 Any change that affects generated GTM output is a public package change and should be versioned accordingly. This includes:
@@ -128,8 +133,8 @@ Any change that affects generated GTM output is a public package change and shou
 - parameter shape or defaults
 - runtime behavior
 - permission generation
-- default mappings
-- essential-scope exposure
-- analytics measurement behavior
+- color scheme normalization
+- identity lookup behavior
+- consent derivation behavior
 
 Release notes should call out template-affecting changes explicitly.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@getuserfeedback/adapters",
-  "version": "0.5.0",
+  "version": "0.5.1",
   "description": "getuserfeedback integration adapters",
   "keywords": [
     "getuserfeedback",
@@ -38,7 +38,7 @@
     "publish:npm": "node ../../scripts/publish-package.cjs . --expect-dependency @getuserfeedback/protocol:../protocol/package.json"
   },
   "dependencies": {
-    "@getuserfeedback/protocol": "^0.2.2"
+    "@getuserfeedback/protocol": "^0.3.0"
   },
   "devDependencies": {
     "rimraf": "^6.0.0",