@jitsu/js 0.0.1-alpha.126 → 0.0.1-alpha.136

package/.turbo/turbo-build.log

@@ -1,4 +1,4 @@
-@jitsu/js:build: cache hit, replaying output 86152f925c86fdcd
+@jitsu/js:build: cache hit, replaying output 28c829c71eac02d2
 @jitsu/js:build: 
 @jitsu/js:build: > @jitsu/js@0.0.0 build /Users/ildarnurislamov/Projects/onetag/libs/jitsu-js
 @jitsu/js:build: > tsc -p . && rollup -c && cp compiled/src/*.d.ts dist
@@ -7,9 +7,9 @@
 @jitsu/js:build: ./compiled/src/browser.js → dist/web/p.js.txt...
 @jitsu/js:build: (!) Circular dependency
 @jitsu/js:build: compiled/src/index.js -> compiled/src/analytics-plugin.js -> compiled/src/index.js
-@jitsu/js:build: created dist/web/p.js.txt in 237ms
+@jitsu/js:build: created dist/web/p.js.txt in 321ms
 @jitsu/js:build: 
 @jitsu/js:build: ./compiled/src/index.js, ./compiled/src/jitsu.js, ./compiled/src/analytics-plugin.js → dist/jitsu.es.js, dist/jitsu.cjs.js...
 @jitsu/js:build: (!) Circular dependency
 @jitsu/js:build: compiled/src/index.js -> compiled/src/analytics-plugin.js -> compiled/src/index.js
-@jitsu/js:build: created dist/jitsu.es.js, dist/jitsu.cjs.js in 128ms
+@jitsu/js:build: created dist/jitsu.es.js, dist/jitsu.cjs.js in 169ms

package/.turbo/turbo-clean.log

@@ -1,4 +1,4 @@
-@jitsu/js:clean: cache hit, replaying output 918ecf9a7a81d250
+@jitsu/js:clean: cache hit, replaying output 4b09f8b5fadef595
 @jitsu/js:clean: 
 @jitsu/js:clean: > @jitsu/js@0.0.0 clean /Users/ildarnurislamov/Projects/onetag/libs/jitsu-js
 @jitsu/js:clean: > rm -rf ./dist

package/dist/analytics-plugin.d.ts

@@ -1,7 +1,7 @@
 import { JitsuOptions, PersistentStorage, RuntimeFacade } from "./jitsu";
 import { AnalyticsPlugin } from "analytics";
 export declare const parseQuery: (qs?: string) => Record<string, string>;
-export declare type StorageFactory = (cookieDomain: string, cookie2key: Record<string, string>) => PersistentStorage;
+export type StorageFactory = (cookieDomain: string, cookie2key: Record<string, string>) => PersistentStorage;
 export declare function getTopLevelDomain(opts?: JitsuOptions): string;
 export declare function windowRuntime(opts: JitsuOptions): RuntimeFacade;
 export declare const emptyRuntime: (config: JitsuOptions) => RuntimeFacade;

package/dist/browser.d.ts

@@ -1,7 +1,7 @@
 import { JitsuOptions } from "./jitsu";
-export declare type JitsuBrowserOptions = {
+export type JitsuBrowserOptions = {
     userId?: string;
     onload?: string;
     initOnly?: boolean;
 } & JitsuOptions;
-export declare type Parser = (arg: string) => any;
+export type Parser = (arg: string) => any;

package/dist/jitsu.cjs.js

@@ -75,6 +75,7 @@ const config = {
     host: null,
     debug: false,
     fetch: null,
+    echoEvents: false,
 };
 const parseQuery = (qs) => {
     if (!qs) {
@@ -311,18 +312,22 @@ function adjustPayload(payload, config, storage) {
         },
         campaign: parseUtms(query),
     };
-    const withContext = Object.assign(Object.assign({}, payload), { timestamp: new Date().toISOString(), sentAt: new Date().toISOString(), messageId: randomId(properties.path || (parsedUrl && parsedUrl.pathname)), context: deepMerge(context, customContext) });
+    const withContext = Object.assign(Object.assign({}, payload), { timestamp: new Date().toISOString(), sentAt: new Date().toISOString(), messageId: randomId(properties.path || (parsedUrl && parsedUrl.pathname)), writeKey: config.writeKey, context: deepMerge(context, customContext) });
     delete withContext.meta;
     delete withContext.options;
     return withContext;
 }
 function send(method, payload, jitsuConfig, store) {
+    if (jitsuConfig.echoEvents) {
+        console.log(`[JITSU] sending '${method}' event:`, payload);
+        return;
+    }
     const url = `${jitsuConfig.host}/api/s/${method}`;
     const fetch = jitsuConfig.fetch || globalThis.fetch;
     if (!fetch) {
         throw new Error("Please specify fetch function in jitsu plugin initialization, fetch isn't available in global scope");
     }
-    const authHeader = jitsuConfig.writeKey ? { Authorization: `Bearer ${jitsuConfig.writeKey}` } : {};
+    const authHeader = {};
     const debugHeader = jitsuConfig.debug ? { "X-Enable-Debug": "true" } : {};
     if (jitsuConfig.debug) {
         console.log(`Sending jitsu event to ${url}: `, JSON.stringify(payload, null, 2));
@@ -370,8 +375,8 @@ const jitsuAnalyticsPlugin = (pluginConfig = {}) => {
             if (config.debug) {
                 console.debug("Initializing Jitsu plugin with config: ", JSON.stringify(config));
             }
-            if (!config.host) {
-                throw new Error("Please specify host variable in jitsu plugin initialization");
+            if (!config.host && !config.echoEvents) {
+                throw new Error("Please specify host variable in jitsu plugin initialization, or set echoEvents to true");
             }
         },
         page: args => {

package/dist/jitsu.d.ts

@@ -1,6 +1,6 @@
 import type { AnalyticsInterface } from "@jitsu/protocols/analytics";
 import type { AnalyticsPlugin } from "analytics";
-declare type JitsuOptions = {
+type JitsuOptions = {
     /**
      * API Key. Optional. If not set, Jitsu will send event to the server without auth, and server
      * will link the call to configured source by domain name
@@ -10,17 +10,40 @@ declare type JitsuOptions = {
      * API Host. Default value: same host as script origin
      */
     host?: string;
+    /**
+     * To enable debug logging
+     */
     debug?: boolean;
+    /**
+     * Explicitely specify cookie domain. If not set, cookie domain will be set to top level
+     * of the current domain. Example: if JS lives on "app.example.com", cookie domain will be
+     * set to ".example.com". If it lives on "example.com", cookie domain will be set to ".example.com" too
+     */
     cookieDomain?: string;
+    /**
+     * Provide fetch implementation. It is required if you want to use Jitsu in NodeJS
+     */
     fetch?: typeof fetch;
+    /**
+     * Which runtime to use. Runtime is used for obtaining context of the event: cookes,
+     * url, etc. At the moment, Jitsu supports browser runtime and NodeJS runtime, but you
+     * can provide your own implementation.
+     *
+     * If it's not set, the runtime will be detected automatically by presense of `window` object
+     */
     runtime?: RuntimeFacade;
+    /**
+     * If set to true, jitsu will output events in console. In this case you don't need to set
+     * writeKey / host. It's useful for debugging development environment
+     */
+    echoEvents?: boolean;
 };
-declare type PersistentStorage = {
+type PersistentStorage = {
     getItem: (key: string, options?: any) => any;
     setItem: (key: string, value: any, options?: any) => void;
     removeItem: (key: string, options?: any) => void;
 };
-declare type RuntimeFacade = {
+type RuntimeFacade = {
     store(): PersistentStorage;
     userAgent(): string | undefined;
     language(): string | undefined;

package/dist/jitsu.es.js

@@ -73,6 +73,7 @@ const config = {
     host: null,
     debug: false,
     fetch: null,
+    echoEvents: false,
 };
 const parseQuery = (qs) => {
     if (!qs) {
@@ -309,18 +310,22 @@ function adjustPayload(payload, config, storage) {
         },
         campaign: parseUtms(query),
     };
-    const withContext = Object.assign(Object.assign({}, payload), { timestamp: new Date().toISOString(), sentAt: new Date().toISOString(), messageId: randomId(properties.path || (parsedUrl && parsedUrl.pathname)), context: deepMerge(context, customContext) });
+    const withContext = Object.assign(Object.assign({}, payload), { timestamp: new Date().toISOString(), sentAt: new Date().toISOString(), messageId: randomId(properties.path || (parsedUrl && parsedUrl.pathname)), writeKey: config.writeKey, context: deepMerge(context, customContext) });
     delete withContext.meta;
     delete withContext.options;
     return withContext;
 }
 function send(method, payload, jitsuConfig, store) {
+    if (jitsuConfig.echoEvents) {
+        console.log(`[JITSU] sending '${method}' event:`, payload);
+        return;
+    }
     const url = `${jitsuConfig.host}/api/s/${method}`;
     const fetch = jitsuConfig.fetch || globalThis.fetch;
     if (!fetch) {
         throw new Error("Please specify fetch function in jitsu plugin initialization, fetch isn't available in global scope");
     }
-    const authHeader = jitsuConfig.writeKey ? { Authorization: `Bearer ${jitsuConfig.writeKey}` } : {};
+    const authHeader = {};
     const debugHeader = jitsuConfig.debug ? { "X-Enable-Debug": "true" } : {};
     if (jitsuConfig.debug) {
         console.log(`Sending jitsu event to ${url}: `, JSON.stringify(payload, null, 2));
@@ -368,8 +373,8 @@ const jitsuAnalyticsPlugin = (pluginConfig = {}) => {
             if (config.debug) {
                 console.debug("Initializing Jitsu plugin with config: ", JSON.stringify(config));
             }
-            if (!config.host) {
-                throw new Error("Please specify host variable in jitsu plugin initialization");
+            if (!config.host && !config.echoEvents) {
+                throw new Error("Please specify host variable in jitsu plugin initialization, or set echoEvents to true");
             }
         },
         page: args => {

package/dist/web/p.js.txt

@@ -76,6 +76,7 @@
       host: null,
       debug: false,
       fetch: null,
+      echoEvents: false,
   };
   const parseQuery = (qs) => {
       if (!qs) {
@@ -312,18 +313,22 @@
           },
           campaign: parseUtms(query),
       };
-      const withContext = Object.assign(Object.assign({}, payload), { timestamp: new Date().toISOString(), sentAt: new Date().toISOString(), messageId: randomId(properties.path || (parsedUrl && parsedUrl.pathname)), context: deepMerge(context, customContext) });
+      const withContext = Object.assign(Object.assign({}, payload), { timestamp: new Date().toISOString(), sentAt: new Date().toISOString(), messageId: randomId(properties.path || (parsedUrl && parsedUrl.pathname)), writeKey: config.writeKey, context: deepMerge(context, customContext) });
       delete withContext.meta;
       delete withContext.options;
       return withContext;
   }
   function send(method, payload, jitsuConfig, store) {
+      if (jitsuConfig.echoEvents) {
+          console.log(`[JITSU] sending '${method}' event:`, payload);
+          return;
+      }
       const url = `${jitsuConfig.host}/api/s/${method}`;
       const fetch = jitsuConfig.fetch || globalThis.fetch;
       if (!fetch) {
           throw new Error("Please specify fetch function in jitsu plugin initialization, fetch isn't available in global scope");
       }
-      const authHeader = jitsuConfig.writeKey ? { Authorization: `Bearer ${jitsuConfig.writeKey}` } : {};
+      const authHeader = {};
       const debugHeader = jitsuConfig.debug ? { "X-Enable-Debug": "true" } : {};
       if (jitsuConfig.debug) {
           console.log(`Sending jitsu event to ${url}: `, JSON.stringify(payload, null, 2));
@@ -371,8 +376,8 @@
               if (config.debug) {
                   console.debug("Initializing Jitsu plugin with config: ", JSON.stringify(config));
               }
-              if (!config.host) {
-                  throw new Error("Please specify host variable in jitsu plugin initialization");
+              if (!config.host && !config.echoEvents) {
+                  throw new Error("Please specify host variable in jitsu plugin initialization, or set echoEvents to true");
               }
           },
           page: args => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jitsu/js",
-  "version": "0.0.1-alpha.126",
+  "version": "0.0.1-alpha.136",
   "description": "",
   "author": "Jitsu Dev Team <dev@jitsu.com>",
   "main": "dist/jitsu.cjs.js",
@@ -36,7 +36,7 @@
   },
   "dependencies": {
     "analytics": "^0.8.1",
-    "@jitsu/protocols": "0.0.1-alpha.126"
+    "@jitsu/protocols": "0.0.1-alpha.136"
   },
   "scripts": {
     "clean": "rm -rf ./dist",

package/src/analytics-plugin.ts

@@ -12,6 +12,7 @@ const config: JitsuOptions = {
   host: null,
   debug: false,
   fetch: null,
+  echoEvents: false,
 };
 
 export const parseQuery = (qs?: string): Record<string, string> => {
@@ -276,6 +277,7 @@ function adjustPayload(payload: any, config: JitsuOptions, storage: PersistentSt
     timestamp: new Date().toISOString(),
     sentAt: new Date().toISOString(),
     messageId: randomId(properties.path || (parsedUrl && parsedUrl.pathname)),
+    writeKey: config.writeKey,
     context: deepMerge(context, customContext),
   };
   delete withContext.meta;
@@ -284,6 +286,11 @@ function adjustPayload(payload: any, config: JitsuOptions, storage: PersistentSt
 }
 
 function send(method, payload, jitsuConfig: Required<JitsuOptions>, store: PersistentStorage): Promise<void> {
+  if (jitsuConfig.echoEvents) {
+    console.log(`[JITSU] sending '${method}' event:`, payload);
+    return;
+  }
+
   const url = `${jitsuConfig.host}/api/s/${method}`;
   const fetch = jitsuConfig.fetch || globalThis.fetch;
   if (!fetch) {
@@ -291,7 +298,7 @@ function send(method, payload, jitsuConfig: Required<JitsuOptions>, store: Persi
       "Please specify fetch function in jitsu plugin initialization, fetch isn't available in global scope"
     );
   }
-  const authHeader = jitsuConfig.writeKey ? { Authorization: `Bearer ${jitsuConfig.writeKey}` } : {};
+  const authHeader = {};
   const debugHeader = jitsuConfig.debug ? { "X-Enable-Debug": "true" } : {};
 
   if (jitsuConfig.debug) {
@@ -352,8 +359,8 @@ const jitsuAnalyticsPlugin = (pluginConfig: JitsuOptions = {}): AnalyticsPlugin
       if (config.debug) {
         console.debug("Initializing Jitsu plugin with config: ", JSON.stringify(config));
       }
-      if (!config.host) {
-        throw new Error("Please specify host variable in jitsu plugin initialization");
+      if (!config.host && !config.echoEvents) {
+        throw new Error("Please specify host variable in jitsu plugin initialization, or set echoEvents to true");
       }
     },
     page: args => {

package/src/jitsu.ts

@@ -11,10 +11,33 @@ type JitsuOptions = {
    * API Host. Default value: same host as script origin
    */
   host?: string;
+  /**
+   * To enable debug logging
+   */
   debug?: boolean;
+  /**
+   * Explicitely specify cookie domain. If not set, cookie domain will be set to top level
+   * of the current domain. Example: if JS lives on "app.example.com", cookie domain will be
+   * set to ".example.com". If it lives on "example.com", cookie domain will be set to ".example.com" too
+   */
   cookieDomain?: string;
+  /**
+   * Provide fetch implementation. It is required if you want to use Jitsu in NodeJS
+   */
   fetch?: typeof fetch;
+  /**
+   * Which runtime to use. Runtime is used for obtaining context of the event: cookes,
+   * url, etc. At the moment, Jitsu supports browser runtime and NodeJS runtime, but you
+   * can provide your own implementation.
+   *
+   * If it's not set, the runtime will be detected automatically by presense of `window` object
+   */
   runtime?: RuntimeFacade;
+  /**
+   * If set to true, jitsu will output events in console. In this case you don't need to set
+   * writeKey / host. It's useful for debugging development environment
+   */
+  echoEvents?: boolean;
 };
 
 type PersistentStorage = {