@leancodepl/gtag 8.4.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.js

@@ -1,6 +1,19 @@
 'use strict';
 
-function mkgtag() {
+/**
+ * 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);

package/index.esm.js

@@ -1,4 +1,17 @@
-function mkgtag() {
+/**
+ * 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);

package/package.json

@@ -1,17 +1,48 @@
 {
   "name": "@leancodepl/gtag",
-  "version": "8.4.0",
+  "version": "8.5.1",
   "license": "Apache-2.0",
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/leancodepl/js_corelibrary.git",
+    "directory": "packages/gtag"
+  },
+  "homepage": "https://github.com/leancodepl/js_corelibrary",
+  "bugs": {
+    "url": "https://github.com/leancodepl/js_corelibrary/issues"
+  },
+  "description": "Google Tag Manager integration utilities for web analytics",
+  "keywords": [
+    "google",
+    "analytics",
+    "gtag",
+    "tracking",
+    "typescript",
+    "javascript",
+    "leancode"
+  ],
+  "author": {
+    "name": "LeanCode",
+    "url": "https://leancode.co"
+  },
+  "sideEffects": false,
   "exports": {
     "./package.json": "./package.json",
     ".": {
       "module": "./index.esm.js",
-      "types": "./index.esm.d.ts",
+      "types": "./index.d.ts",
       "import": "./index.cjs.mjs",
       "default": "./index.cjs.js"
     }
   },
   "module": "./index.esm.js",
   "main": "./index.cjs.js",
-  "types": "./index.esm.d.ts"
+  "types": "./index.d.ts"
 }

package/src/lib/index.d.ts

@@ -16,6 +16,20 @@ declare global {
         }>[];
     }
 }
+/**
+ * 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;

package/index.esm.d.ts

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