@jitsu/js 1.10.0 → 1.10.1

package/dist/jitsu.cjs.js

@@ -1905,6 +1905,10 @@ function parse(input) {
 }
 const emptyAnalytics = {
     setAnonymousId: () => { },
+    setContextProperty(name, value) { },
+    getContextProperty(name) {
+        return undefined;
+    },
     track: () => Promise.resolve(),
     page: () => Promise.resolve(),
     user: () => ({}),
@@ -1992,6 +1996,25 @@ function createUnderlyingAnalyticsInstance(opts, rt, plugins = []) {
                 storageWrapper.setItem("__user_traits", args[1]);
             }
             return analytics.identify(...args);
+        }, setContextProperty(name, value) {
+            if (opts.debug) {
+                console.log(`[JITSU DEBUG] Setting context property '${name}':${JSON.stringify(value)}`);
+            }
+            if (!opts.defaultPayloadContext) {
+                opts.defaultPayloadContext = {
+                    [name]: value,
+                };
+            }
+            else {
+                opts.defaultPayloadContext[name] = value;
+            }
+        },
+        getContextProperty(name) {
+            var _a;
+            if (opts.debug) {
+                console.log(`[JITSU DEBUG] Getting context property '${name}'`);
+            }
+            return (_a = opts.defaultPayloadContext) === null || _a === void 0 ? void 0 : _a[name];
         }, setAnonymousId: (id) => {
             if (opts.debug) {
                 console.log("[JITSU DEBUG] Setting anonymous id to " + id);

package/dist/jitsu.d.ts

@@ -1,87 +1,38 @@
-import type { AnalyticsInterface } from "@jitsu/protocols/analytics";
-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
-     */
-    writeKey?: string;
-    /**
-     * API Host. Default value: same host as script origin
-     */
-    host?: string;
-    /**
-     * To enable debug logging
-     */
-    debug?: boolean;
-    /**
-     * Explicitly 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;
-    /**
-     * If true, events will go to s2s endpoints like ${host}/api/s/s2s/{type}. Otherwise they'll go to ${host}/api/s/{type}.
-     *
-     * If not set at all, it will be detected automatically by presence of `window` object
-     */
-    s2s?: boolean;
-    /**
-     * Timeout for fetch requests. Default value: 5000
-     */
-    fetchTimeoutMs?: number;
-    /**
-     * Endpoint that makes sure that Jitsu anonymousId cookie is set as server (httpOnly) cookie.
-     * Endpoint must be hosted on the same domain as the site where Jitsu code is installed.
-     * Required to overcome Safari ITP restrictions.
-     */
-    idEndpoint?: string;
-    enabled?: boolean;
-    enableAnonymousId?: boolean;
-    enableThirdPartIds?: boolean;
-    ipPolicy?: "keep" | "remove" | "stripLastOctet";
+import { PersistentStorage, JitsuOptions, RuntimeFacade, AnalyticsInterface } from '@jitsu/protocols/analytics';
+export { AnalyticsInterface, Callback, DispatchedEvent, DynamicJitsuOptions, ID, JSONObject, JitsuOptions, Options, PersistentStorage, RuntimeFacade } from '@jitsu/protocols/analytics';
+import { AnalyticsPlugin } from 'analytics';
+
+declare const parseQuery: (qs?: string) => Record<string, string>;
+type StorageFactory = (cookieDomain: string, key2Cookie: (key: string) => string) => PersistentStorage;
+declare function windowRuntime(opts: JitsuOptions): RuntimeFacade;
+declare function createInMemoryStorage(debug?: boolean): PersistentStorage;
+declare const emptyRuntime: (config: JitsuOptions) => RuntimeFacade;
+declare function isInBrowser(): boolean;
+type DestinationDescriptor = {
+    id: string;
+    destinationType: string;
+    credentials: any;
+    options: any;
+    newEvents?: any[];
+    deviceOptions: DeviceOptions;
 };
-type DynamicJitsuOptions = Pick<JitsuOptions, "enableAnonymousId" | "enableThirdPartIds" | "ipPolicy" | "debug" | "echoEvents" | "enabled">;
-type PersistentStorage = {
-    getItem: (key: string, options?: any) => any;
-    setItem: (key: string, value: any, options?: any) => void;
-    removeItem: (key: string, options?: any) => void;
-    reset: () => void;
+type AnalyticsPluginDescriptor = {
+    type: "analytics-plugin";
+    packageCdn: string;
+    moduleVarName: string;
 };
-type RuntimeFacade = {
-    store(): PersistentStorage;
-    userAgent(): string | undefined;
-    language(): string | undefined;
-    pageUrl(): string | undefined;
-    documentEncoding(): string | undefined;
-    getCookie(name: string): string | undefined;
-    getCookies(): Record<string, string>;
-    timezoneOffset(): number | undefined;
-    screen(): {
-        width: number;
-        height: number;
-        innerWidth: number;
-        innerHeight: number;
-        density: number;
-    } | undefined;
-    referrer(): string | undefined;
-    pageTitle(): string | undefined;
+type InternalPluginDescriptor = {
+    type: "internal-plugin";
+    name: string;
 };
-export declare function jitsuAnalytics(opts: JitsuOptions): AnalyticsInterface;
-export { AnalyticsInterface, JitsuOptions, DynamicJitsuOptions, PersistentStorage, RuntimeFacade };
+type DeviceOptions = AnalyticsPluginDescriptor | InternalPluginDescriptor;
+declare const jitsuAnalyticsPlugin: (jitsuOptions: JitsuOptions, storage: PersistentStorage) => AnalyticsPlugin;
+declare function randomId(hashString?: string | undefined): string;
+declare function uuid(): string;
+
+declare function parse(input: any): any;
+declare const emptyAnalytics: AnalyticsInterface;
+declare function jitsuAnalytics(_opts: JitsuOptions): AnalyticsInterface;
+
+export { createInMemoryStorage, parse as default, emptyAnalytics, emptyRuntime, isInBrowser, jitsuAnalytics, jitsuAnalyticsPlugin, parseQuery, randomId, uuid, windowRuntime };
+export type { AnalyticsPluginDescriptor, DestinationDescriptor, DeviceOptions, InternalPluginDescriptor, StorageFactory };

package/dist/jitsu.es.js

@@ -1903,6 +1903,10 @@ function parse(input) {
 }
 const emptyAnalytics = {
     setAnonymousId: () => { },
+    setContextProperty(name, value) { },
+    getContextProperty(name) {
+        return undefined;
+    },
     track: () => Promise.resolve(),
     page: () => Promise.resolve(),
     user: () => ({}),
@@ -1990,6 +1994,25 @@ function createUnderlyingAnalyticsInstance(opts, rt, plugins = []) {
                 storageWrapper.setItem("__user_traits", args[1]);
             }
             return analytics.identify(...args);
+        }, setContextProperty(name, value) {
+            if (opts.debug) {
+                console.log(`[JITSU DEBUG] Setting context property '${name}':${JSON.stringify(value)}`);
+            }
+            if (!opts.defaultPayloadContext) {
+                opts.defaultPayloadContext = {
+                    [name]: value,
+                };
+            }
+            else {
+                opts.defaultPayloadContext[name] = value;
+            }
+        },
+        getContextProperty(name) {
+            var _a;
+            if (opts.debug) {
+                console.log(`[JITSU DEBUG] Getting context property '${name}'`);
+            }
+            return (_a = opts.defaultPayloadContext) === null || _a === void 0 ? void 0 : _a[name];
         }, setAnonymousId: (id) => {
             if (opts.debug) {
                 console.log("[JITSU DEBUG] Setting anonymous id to " + id);

package/dist/web/p.js.txt

@@ -1983,6 +1983,25 @@
                   storageWrapper.setItem("__user_traits", args[1]);
               }
               return analytics.identify(...args);
+          }, setContextProperty(name, value) {
+              if (opts.debug) {
+                  console.log(`[JITSU DEBUG] Setting context property '${name}':${JSON.stringify(value)}`);
+              }
+              if (!opts.defaultPayloadContext) {
+                  opts.defaultPayloadContext = {
+                      [name]: value,
+                  };
+              }
+              else {
+                  opts.defaultPayloadContext[name] = value;
+              }
+          },
+          getContextProperty(name) {
+              var _a;
+              if (opts.debug) {
+                  console.log(`[JITSU DEBUG] Getting context property '${name}'`);
+              }
+              return (_a = opts.defaultPayloadContext) === null || _a === void 0 ? void 0 : _a[name];
           }, setAnonymousId: (id) => {
               if (opts.debug) {
                   console.log("[JITSU DEBUG] Setting anonymous id to " + id);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jitsu/js",
-  "version": "1.10.0",
+  "version": "1.10.1",
   "description": "",
   "author": "Jitsu Dev Team <dev@jitsu.com>",
   "main": "dist/jitsu.cjs.js",
@@ -8,7 +8,7 @@
     "dist"
   ],
   "module": "dist/jitsu.es.js",
-  "types": "dist/index.d.ts",
+  "types": "dist/jitsu.d.ts",
   "publishConfig": {
     "access": "public"
   },
@@ -18,6 +18,7 @@
     "tslib": "^2.6.3",
     "@playwright/test": "1.39.0",
     "@rollup/plugin-commonjs": "^28.0.2",
+    "rollup-plugin-dts": "^6.2.1",
     "@rollup/plugin-json": "^5.0.1",
     "@rollup/plugin-multi-entry": "^6.0.0",
     "@rollup/plugin-node-resolve": "^16.0.0",
@@ -38,20 +39,20 @@
     "rollup": "^3.29.5",
     "ts-jest": "29.0.5",
     "typescript": "^5.6.3",
-    "jsondiffpatch": "1.10.0"
+    "jsondiffpatch": "1.10.1"
   },
   "peerDependencies": {
-    "@jitsu/protocols": "1.10.0"
+    "@jitsu/protocols": "1.10.1"
   },
   "dependencies": {
     "analytics": "0.8.9"
   },
   "scripts": {
-    "clean": "rm -rf ./dist",
+    "clean": "rm -rf ./dist ./compiled",
     "test:node": "jest",
     "test:playwright": "playwright test ./__tests__/playwright",
     "test": "pnpm run test:node && pnpm run test:playwright",
     "compile": "tsc -p .",
-    "build": "tsc -p . && rollup -c && cp compiled/src/*.d.ts dist"
+    "build": "pnpm run clean && pnpm run compile && rollup -c"
   }
 }

package/dist/analytics-plugin.d.ts

@@ -1,29 +0,0 @@
-import { JitsuOptions, PersistentStorage, RuntimeFacade } from "@jitsu/protocols/analytics";
-import { AnalyticsPlugin } from "analytics";
-export declare const parseQuery: (qs?: string) => Record<string, string>;
-export type StorageFactory = (cookieDomain: string, key2Cookie: (key: string) => string) => PersistentStorage;
-export declare function windowRuntime(opts: JitsuOptions): RuntimeFacade;
-export declare function createInMemoryStorage(debug?: boolean): PersistentStorage;
-export declare const emptyRuntime: (config: JitsuOptions) => RuntimeFacade;
-export declare function isInBrowser(): boolean;
-export type DestinationDescriptor = {
-    id: string;
-    destinationType: string;
-    credentials: any;
-    options: any;
-    newEvents?: any[];
-    deviceOptions: DeviceOptions;
-};
-export type AnalyticsPluginDescriptor = {
-    type: "analytics-plugin";
-    packageCdn: string;
-    moduleVarName: string;
-};
-export type InternalPluginDescriptor = {
-    type: "internal-plugin";
-    name: string;
-};
-export type DeviceOptions = AnalyticsPluginDescriptor | InternalPluginDescriptor;
-export declare const jitsuAnalyticsPlugin: (jitsuOptions: JitsuOptions, storage: PersistentStorage) => AnalyticsPlugin;
-export declare function randomId(hashString?: string | undefined): string;
-export declare function uuid(): string;

package/dist/browser.d.ts

@@ -1,10 +0,0 @@
-import type { JitsuOptions } from "@jitsu/protocols/analytics";
-export type JitsuBrowserOptions = {
-    namespace?: string;
-    onload?: string;
-    initOnly?: boolean;
-} & JitsuOptions;
-export type Parser = {
-    path?: (name: string) => string[];
-    parse: (arg: string) => any;
-};

package/dist/index.d.ts

@@ -1,6 +0,0 @@
-import { Callback, DispatchedEvent, ID, JSONObject, Options, AnalyticsInterface, JitsuOptions, PersistentStorage, RuntimeFacade, DynamicJitsuOptions } from "@jitsu/protocols/analytics";
-export default function parse(input: any): any;
-export declare const emptyAnalytics: AnalyticsInterface;
-export declare function jitsuAnalytics(_opts: JitsuOptions): AnalyticsInterface;
-export { Callback, DispatchedEvent, ID, JSONObject, Options, AnalyticsInterface, JitsuOptions, PersistentStorage, RuntimeFacade, DynamicJitsuOptions, };
-export * from "./analytics-plugin";

package/dist/method-queue.d.ts

@@ -1,17 +0,0 @@
-export type InterfaceWrapper<T> = {
-    get(): WithAsyncMethods<T>;
-    loaded(instance: T): any;
-};
-type WithAsyncMethods<T> = {
-    [K in keyof T]: T[K] extends (...args: infer A) => infer R ? (...args: A) => R extends Promise<any> ? R : Promise<R> : T[K];
-};
-/**
- * This function creates a wrapper around an interface that allows to call methods on it, but all methods will go to queue. Once actual instance
- * implementation becomes available, all queued methods will be called on it.
- *
- *
- * @param methods of methods that should be wrapped. Per each method of you should specify if it should be wrapped. You'll need to mark all
- * methods for type safety. If method is not wrapped, it will throw an error when called.
- */
-export declare function delayMethodExec<T>(methods: Record<keyof T, boolean>): InterfaceWrapper<T>;
-export {};

package/dist/script-loader.d.ts

@@ -1,8 +0,0 @@
-export type ScriptOptions = {
-    attributes?: Record<string, string>;
-    www?: boolean;
-    js?: boolean;
-    min?: boolean;
-    query?: string;
-};
-export declare function loadScript(src: string, options?: ScriptOptions): Promise<HTMLScriptElement>;

package/dist/tlds.d.ts

@@ -1,3 +0,0 @@
-export declare const publicSuffixes: string[];
-export declare const publicSuffixesMap: Record<string, boolean>;
-export declare function getTopLevelDomain(hostname: string): string;

package/dist/version.d.ts

@@ -1,3 +0,0 @@
-declare const jitsuVersion: string;
-declare const jitsuLibraryName = "@jitsu/js";
-export { jitsuVersion, jitsuLibraryName };