@leancodepl/gtag 8.5.0 → 8.5.1

package/README.md

@@ -0,0 +1,56 @@
+# @leancodepl/gtag
+
+Type-safe Google Tag Manager data layer integration.
+
+## Installation
+
+```bash
+npm install @leancodepl/gtag
+# or
+yarn add @leancodepl/gtag
+```
+
+## API
+
+### `mkgtag()`
+
+Creates a type-safe Google Tag Manager data layer push function.
+
+**Returns:** Function that accepts data layer arguments and pushes to GTM
+
+## Usage Examples
+
+### Basic Event Tracking
+
+```typescript
+import { mkgtag } from '@leancodepl/gtag';
+
+const gtag = mkgtag<{ event: 'page_view'; page_title: string }>();
+
+gtag({
+  event: 'page_view',
+  page_title: 'Home Page',
+});
+```
+
+### Custom Events with Callbacks
+
+```typescript
+import { mkgtag } from '@leancodepl/gtag';
+
+interface CustomEvent {
+  event: 'button_click';
+  element_id: string;
+}
+
+const gtag = mkgtag<CustomEvent>();
+
+gtag({
+  event: 'button_click',
+  element_id: 'signup-button',
+  eventCallback: (containerId) => {
+    console.log('Event sent to container:', containerId);
+  },
+  eventTimeout: 2000,
+});
+```

package/index.cjs.default.js

@@ -0,0 +1 @@
+exports._default = require('./index.cjs.js').default;

package/index.cjs.js

@@ -0,0 +1,23 @@
+'use strict';
+
+/**
+ * Creates a type-safe Google Tag Manager data layer push function.
+ * 
+ * Returns a function that pushes events to the GTM data layer with type safety.
+ * Handles cases where GTM is not initialized by safely checking for dataLayer existence.
+ * 
+ * @template T - Event object type extending { event: string }
+ * @returns Function that accepts data layer arguments and pushes to GTM
+ * @example
+ * ```typescript
+ * const gtag = mkgtag<{ event: 'purchase'; value: number }>();
+ * gtag({ event: 'purchase', value: 29.99 });
+ * ```
+ */ function mkgtag() {
+    return (dataLayerArguments)=>{
+        var _window_dataLayer;
+        (_window_dataLayer = window.dataLayer) == null ? void 0 : _window_dataLayer.push(dataLayerArguments);
+    };
+}
+
+exports.mkgtag = mkgtag;

package/index.cjs.mjs

@@ -0,0 +1,2 @@
+export * from './index.cjs.js';
+export { _default as default } from './index.cjs.default.js';

package/index.d.ts

@@ -0,0 +1 @@
+export * from "./src/index";

package/index.esm.js

@@ -0,0 +1,21 @@
+/**
+ * Creates a type-safe Google Tag Manager data layer push function.
+ * 
+ * Returns a function that pushes events to the GTM data layer with type safety.
+ * Handles cases where GTM is not initialized by safely checking for dataLayer existence.
+ * 
+ * @template T - Event object type extending { event: string }
+ * @returns Function that accepts data layer arguments and pushes to GTM
+ * @example
+ * ```typescript
+ * const gtag = mkgtag<{ event: 'purchase'; value: number }>();
+ * gtag({ event: 'purchase', value: 29.99 });
+ * ```
+ */ function mkgtag() {
+    return (dataLayerArguments)=>{
+        var _window_dataLayer;
+        (_window_dataLayer = window.dataLayer) == null ? void 0 : _window_dataLayer.push(dataLayerArguments);
+    };
+}
+
+export { mkgtag };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@leancodepl/gtag",
-  "version": "8.5.0",
+  "version": "8.5.1",
   "license": "Apache-2.0",
   "publishConfig": {
     "access": "public",
@@ -32,11 +32,6 @@
     "name": "LeanCode",
     "url": "https://leancode.co"
   },
-  "files": [
-    "dist",
-    "README.md",
-    "CHANGELOG.md"
-  ],
   "sideEffects": false,
   "exports": {
     "./package.json": "./package.json",

package/src/index.d.ts

@@ -0,0 +1 @@
+export { mkgtag } from "./lib";

package/src/lib/index.d.ts

@@ -0,0 +1,36 @@
+type DataLayerArguments<T extends {
+    event: string;
+}> = T & {
+    /**
+     * Function that will be called after all Tags have fired for the given event
+     *
+     * Will not be called when GTM is not initialized
+     */
+    eventCallback?: (containerId: string) => void;
+    eventTimeout?: number;
+};
+declare global {
+    interface Window {
+        dataLayer?: DataLayerArguments<{
+            event: string;
+        }>[];
+    }
+}
+/**
+ * Creates a type-safe Google Tag Manager data layer push function.
+ *
+ * Returns a function that pushes events to the GTM data layer with type safety.
+ * Handles cases where GTM is not initialized by safely checking for dataLayer existence.
+ *
+ * @template T - Event object type extending { event: string }
+ * @returns Function that accepts data layer arguments and pushes to GTM
+ * @example
+ * ```typescript
+ * const gtag = mkgtag<{ event: 'purchase'; value: number }>();
+ * gtag({ event: 'purchase', value: 29.99 });
+ * ```
+ */
+export declare function mkgtag<T extends {
+    event: string;
+}>(): (dataLayerArguments: DataLayerArguments<T>) => void;
+export {};