@getuserfeedback/adapters 0.2.1

package/dist/gtm/index.d.ts

@@ -0,0 +1,52 @@
+import { type InitOptions, type Scope } from "@getuserfeedback/protocol";
+export declare const GTM_CONSENT_TYPES: readonly [
+    "functionality_storage",
+    "security_storage",
+    "analytics_storage",
+    "personalization_storage",
+    "ad_storage",
+    "ad_user_data",
+    "ad_personalization"
+];
+export type GtmConsentType = (typeof GTM_CONSENT_TYPES)[number];
+export type GtmConsentValue = "granted" | "denied";
+export type GtmAnalyticsMeasurementMode = "inherit-analytics-storage" | "granted" | "denied";
+export type GtmScopeMapping = {
+    scope: Scope;
+    consentType: GtmConsentType;
+};
+export type GtmConsentState = Partial<Record<GtmConsentType, GtmConsentValue>>;
+export type GtmTemplateInput = {
+    apiKey: string;
+    consentState?: GtmConsentState;
+    scopeMappings?: ReadonlyArray<GtmScopeMapping>;
+    analyticsMeasurementMode?: GtmAnalyticsMeasurementMode;
+    colorScheme?: unknown;
+    disableTelemetry?: boolean;
+    enableDebug?: InitOptions["enableDebug"];
+    capabilities?: InitOptions["capabilities"];
+    runtimeEndpoints?: InitOptions["runtimeEndpoints"];
+    clientMeta?: InitOptions["clientMeta"];
+};
+type GtmTemplateScopeOption = {
+    label: string;
+    scope: Scope;
+    description: string;
+};
+type GtmTemplateMappingOption = {
+    consentType: GtmConsentType;
+    label: string;
+};
+export declare const DEFAULT_GTM_SCOPE_MAPPINGS: ReadonlyArray<GtmScopeMapping>;
+export declare const GTM_TEMPLATE_SCOPE_OPTIONS: ReadonlyArray<GtmTemplateScopeOption>;
+export declare const GTM_TEMPLATE_MAPPING_OPTIONS: ReadonlyArray<GtmTemplateMappingOption>;
+export declare function isGtmConsentType(value: unknown): value is GtmConsentType;
+export declare function normalizeGtmThemeInput(input: unknown): InitOptions["colorScheme"] | undefined;
+export declare function resolveDefaultConsentFromGtm(input: {
+    consentState?: GtmConsentState;
+    scopeMappings?: ReadonlyArray<GtmScopeMapping>;
+    analyticsMeasurementMode?: GtmAnalyticsMeasurementMode;
+}): InitOptions["defaultConsent"] | undefined;
+export declare function buildInitOptionsFromGtmTemplate(input: GtmTemplateInput): InitOptions;
+export {};
+//# sourceMappingURL=index.d.ts.map

package/dist/gtm/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/gtm/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAEN,KAAK,WAAW,EAEhB,KAAK,KAAK,EACV,MAAM,2BAA2B,CAAC;AAEnC,eAAO,MAAM,iBAAiB,EAAE,SAAS;IACxC,uBAAuB;IACvB,kBAAkB;IAClB,mBAAmB;IACnB,yBAAyB;IACzB,YAAY;IACZ,cAAc;IACd,oBAAoB;CASpB,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG,CAAC,OAAO,iBAAiB,CAAC,CAAC,MAAM,CAAC,CAAC;AAEhE,MAAM,MAAM,eAAe,GAAG,SAAS,GAAG,QAAQ,CAAC;AAEnD,MAAM,MAAM,2BAA2B,GACpC,2BAA2B,GAC3B,SAAS,GACT,QAAQ,CAAC;AAEZ,MAAM,MAAM,eAAe,GAAG;IAC7B,KAAK,EAAE,KAAK,CAAC;IACb,WAAW,EAAE,cAAc,CAAC;CAC5B,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG,OAAO,CAAC,MAAM,CAAC,cAAc,EAAE,eAAe,CAAC,CAAC,CAAC;AAE/E,MAAM,MAAM,gBAAgB,GAAG;IAC9B,MAAM,EAAE,MAAM,CAAC;IACf,YAAY,CAAC,EAAE,eAAe,CAAC;IAC/B,aAAa,CAAC,EAAE,aAAa,CAAC,eAAe,CAAC,CAAC;IAC/C,wBAAwB,CAAC,EAAE,2BAA2B,CAAC;IACvD,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,WAAW,CAAC,EAAE,WAAW,CAAC,aAAa,CAAC,CAAC;IACzC,YAAY,CAAC,EAAE,WAAW,CAAC,cAAc,CAAC,CAAC;IAC3C,gBAAgB,CAAC,EAAE,WAAW,CAAC,kBAAkB,CAAC,CAAC;IACnD,UAAU,CAAC,EAAE,WAAW,CAAC,YAAY,CAAC,CAAC;CACvC,CAAC;AAMF,KAAK,sBAAsB,GAAG;IAC7B,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,KAAK,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF,KAAK,wBAAwB,GAAG;IAC/B,WAAW,EAAE,cAAc,CAAC;IAC5B,KAAK,EAAE,MAAM,CAAC;CACd,CAAC;AAUF,eAAO,MAAM,0BAA0B,EAAE,aAAa,CAAC,eAAe,CA6BrE,CAAC;AA4BF,eAAO,MAAM,0BAA0B,EAAE,aAAa,CAAC,sBAAsB,CAKzE,CAAC;AAEL,eAAO,MAAM,4BAA4B,EAAE,aAAa,CAAC,wBAAwB,CAI7E,CAAC;AAEL,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,cAAc,CAKxE;AAED,wBAAgB,sBAAsB,CACrC,KAAK,EAAE,OAAO,GACZ,WAAW,CAAC,aAAa,CAAC,GAAG,SAAS,CA2CxC;AAED,wBAAgB,4BAA4B,CAAC,KAAK,EAAE;IACnD,YAAY,CAAC,EAAE,eAAe,CAAC;IAC/B,aAAa,CAAC,EAAE,aAAa,CAAC,eAAe,CAAC,CAAC;IAC/C,wBAAwB,CAAC,EAAE,2BAA2B,CAAC;CACvD,GAAG,WAAW,CAAC,gBAAgB,CAAC,GAAG,SAAS,CA0B5C;AAED,wBAAgB,+BAA+B,CAC9C,KAAK,EAAE,gBAAgB,GACrB,WAAW,CA8Bb"}

package/dist/gtm/index.js

@@ -0,0 +1,165 @@
+import { DEFAULT_AUTO_DETECT_COLOR_SCHEME_ATTRS, listScopes, } from "@getuserfeedback/protocol";
+export const GTM_CONSENT_TYPES = [
+    "functionality_storage",
+    "security_storage",
+    "analytics_storage",
+    "personalization_storage",
+    "ad_storage",
+    "ad_user_data",
+    "ad_personalization",
+];
+const essentialScopes = new Set([
+    "functionality.storage",
+    "security.storage",
+]);
+const isProtocolConsentScope = (scope) => !essentialScopes.has(scope);
+export const DEFAULT_GTM_SCOPE_MAPPINGS = [
+    {
+        scope: "functionality.storage",
+        consentType: "functionality_storage",
+    },
+    {
+        scope: "security.storage",
+        consentType: "security_storage",
+    },
+    {
+        scope: "analytics.storage",
+        consentType: "analytics_storage",
+    },
+    {
+        scope: "personalization.storage",
+        consentType: "personalization_storage",
+    },
+    {
+        scope: "ads.storage",
+        consentType: "ad_storage",
+    },
+    {
+        scope: "ads.user_data",
+        consentType: "ad_user_data",
+    },
+    {
+        scope: "ads.personalization",
+        consentType: "ad_personalization",
+    },
+];
+const toTitleCase = (value) => value
+    .split(/[_\-.]/g)
+    .filter((part) => part.length > 0)
+    .map((part) => `${part[0]?.toUpperCase() ?? ""}${part.slice(1)}`)
+    .join(" ");
+const uniqueScopes = (scopes) => {
+    const deduped = new Set();
+    for (const scope of scopes) {
+        if (!isProtocolConsentScope(scope)) {
+            continue;
+        }
+        deduped.add(scope);
+    }
+    return [...deduped];
+};
+const normalizeAttrList = (value) => value
+    .split(",")
+    .map((entry) => entry.trim())
+    .filter((entry) => entry.length > 0);
+export const GTM_TEMPLATE_SCOPE_OPTIONS = listScopes().map((scopeMeta) => ({
+    label: toTitleCase(scopeMeta.id),
+    scope: scopeMeta.id,
+    description: scopeMeta.description,
+}));
+export const GTM_TEMPLATE_MAPPING_OPTIONS = GTM_CONSENT_TYPES.map((consentType) => ({
+    consentType,
+    label: toTitleCase(consentType),
+}));
+export function isGtmConsentType(value) {
+    if (typeof value !== "string") {
+        return false;
+    }
+    return GTM_CONSENT_TYPES.some((consentType) => consentType === value);
+}
+export function normalizeGtmThemeInput(input) {
+    if (input === undefined || input === null) {
+        return undefined;
+    }
+    if (Array.isArray(input)) {
+        const attrs = input
+            .filter((value) => typeof value === "string")
+            .map((value) => value.trim())
+            .filter((value) => value.length > 0);
+        if (attrs.length === 0) {
+            return undefined;
+        }
+        return { autoDetectColorScheme: attrs };
+    }
+    if (typeof input !== "string") {
+        return undefined;
+    }
+    const normalized = input.trim().toLowerCase();
+    if (normalized.length === 0) {
+        return undefined;
+    }
+    if (normalized === "light" ||
+        normalized === "dark" ||
+        normalized === "system") {
+        return normalized;
+    }
+    if (normalized === "auto") {
+        return {
+            autoDetectColorScheme: [...DEFAULT_AUTO_DETECT_COLOR_SCHEME_ATTRS],
+        };
+    }
+    const attrs = normalizeAttrList(input);
+    if (attrs.length === 0) {
+        return undefined;
+    }
+    return {
+        autoDetectColorScheme: attrs,
+    };
+}
+export function resolveDefaultConsentFromGtm(input) {
+    const consentState = input.consentState;
+    if (!consentState) {
+        return undefined;
+    }
+    const mappings = input.scopeMappings ?? DEFAULT_GTM_SCOPE_MAPPINGS;
+    const grantedScopes = uniqueScopes(mappings.flatMap((mapping) => consentState[mapping.consentType] === "granted" ? [mapping.scope] : []));
+    const analyticsMeasurementMode = input.analyticsMeasurementMode ?? "inherit-analytics-storage";
+    if (analyticsMeasurementMode === "granted") {
+        grantedScopes.push("analytics.measurement");
+    }
+    if (analyticsMeasurementMode === "inherit-analytics-storage" &&
+        consentState.analytics_storage === "granted") {
+        grantedScopes.push("analytics.measurement");
+    }
+    return uniqueScopes(grantedScopes);
+}
+export function buildInitOptionsFromGtmTemplate(input) {
+    const colorScheme = normalizeGtmThemeInput(input.colorScheme);
+    const defaultConsent = resolveDefaultConsentFromGtm({
+        consentState: input.consentState,
+        scopeMappings: input.scopeMappings,
+        analyticsMeasurementMode: input.analyticsMeasurementMode,
+    });
+    return {
+        apiKey: input.apiKey,
+        ...(colorScheme !== undefined ? { colorScheme } : {}),
+        ...(input.disableTelemetry !== undefined
+            ? { disableTelemetry: input.disableTelemetry }
+            : {}),
+        ...(input.enableDebug !== undefined
+            ? { enableDebug: input.enableDebug }
+            : {}),
+        ...(defaultConsent !== undefined ? { defaultConsent } : {}),
+        clientMeta: {
+            ...(input.clientMeta ?? {}),
+            loader: "gtm",
+            transport: input.clientMeta?.transport ?? "tag-manager",
+        },
+        ...(input.capabilities !== undefined
+            ? { capabilities: input.capabilities }
+            : {}),
+        ...(input.runtimeEndpoints !== undefined
+            ? { runtimeEndpoints: input.runtimeEndpoints }
+            : {}),
+    };
+}

package/package.json

@@ -0,0 +1,44 @@
+{
+  "name": "@getuserfeedback/adapters",
+  "version": "0.2.1",
+  "description": "getuserfeedback integration adapters",
+  "keywords": [
+    "getuserfeedback",
+    "widget",
+    "adapters",
+    "gtm"
+  ],
+  "license": "MIT",
+  "publishConfig": {
+    "access": "public"
+  },
+  "type": "module",
+  "sideEffects": false,
+  "files": [
+    "dist"
+  ],
+  "exports": {
+    "./gtm": {
+      "types": "./dist/gtm/index.d.ts",
+      "import": "./dist/gtm/index.js"
+    }
+  },
+  "scripts": {
+    "prepack": "node scripts/prepack.cjs",
+    "postpack": "node scripts/postpack.cjs",
+    "lint": "ultracite check .",
+    "build": "bun x rimraf dist tsconfig.tsbuildinfo && tsc -b tsconfig.json",
+    "typecheck": "tsc -b tsconfig.json",
+    "test": "bun test --dots",
+    "pack:verify": "node ../../scripts/pack-and-verify.cjs --expect-dependency @getuserfeedback/protocol:../protocol/package.json",
+    "publish:dry-run": "node ../../scripts/publish-package.cjs . --expect-dependency @getuserfeedback/protocol:../protocol/package.json -- --dry-run",
+    "publish:npm": "node ../../scripts/publish-package.cjs . --expect-dependency @getuserfeedback/protocol:../protocol/package.json"
+  },
+  "dependencies": {
+    "@getuserfeedback/protocol": "^0.2.0"
+  },
+  "devDependencies": {
+    "rimraf": "^6.0.0",
+    "typescript": "^5.8.3"
+  }
+}