@nu-art/analytics-shared 0.400.7

package/api-def.d.ts

@@ -0,0 +1,28 @@
+import { ApiDefResolver, BodyApi } from '@nu-art/thunderstorm-shared';
+import { TSAnalyticsEvent } from './types.js';
+export type Analytics_SendEvent = {
+    request: {
+        event: TSAnalyticsEvent;
+    };
+    response: void;
+};
+export type Analytics_UpdateUser = {
+    request: {
+        mode: 'set' | 'set_once';
+        userData: {
+            userId: string;
+            firstName?: string;
+            lastName?: string;
+            displayName?: string;
+            [key: string]: any;
+        };
+    };
+    response: void;
+};
+export type ApiStruct_Analytics = {
+    _v1: {
+        sendEvent: BodyApi<Analytics_SendEvent['response'], Analytics_SendEvent['request']>;
+        updateUser: BodyApi<Analytics_UpdateUser['response'], Analytics_UpdateUser['request']>;
+    };
+};
+export declare const ApiDef_Analytics: (baseUrl?: string) => ApiDefResolver<ApiStruct_Analytics>;

package/api-def.js

@@ -0,0 +1,7 @@
+import { HttpMethod } from '@nu-art/thunderstorm-shared';
+export const ApiDef_Analytics = (baseUrl) => ({
+    _v1: {
+        sendEvent: { baseUrl, method: HttpMethod.POST, path: '/v1/analytics/send-event' },
+        updateUser: { baseUrl, method: HttpMethod.POST, path: '/v1/analytics/update-user' },
+    }
+});

package/index.d.ts

@@ -0,0 +1,2 @@
+export * from './types.js';
+export * from './api-def.js';

package/index.js

@@ -0,0 +1,2 @@
+export * from './types.js';
+export * from './api-def.js';

package/package.json

@@ -0,0 +1,33 @@
+{
+  "name": "@nu-art/analytics-shared",
+  "version": "0.400.7",
+  "description": "Analytics Shared",
+  "license": "Apache-2.0",
+  "scripts": {
+    "build": "tsc"
+  },
+  "publishConfig": {
+    "directory": "dist",
+    "linkDirectory": true
+  },
+  "dependencies": {
+    "@nu-art/ts-common": "0.400.7",
+    "@nu-art/thunderstorm-shared": "0.400.7"
+  },
+  "devDependencies": {},
+  "private": false,
+  "unitConfig": {
+    "type": "typescript-lib"
+  },
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./index.d.ts",
+      "import": "./index.js"
+    },
+    "./*": {
+      "types": "./*.d.ts",
+      "import": "./*.js"
+    }
+  }
+}

package/types.d.ts

@@ -0,0 +1,49 @@
+import { TypedMap, UniqueId } from '@nu-art/ts-common';
+/**
+ * Contextual metadata describing the environment in which the event occurred.
+ * This includes device, OS, IP, app version, etc.
+ */
+export type TSAnalyticsEventMetadata = {
+    /** Device model or type (e.g., 'iPhone 14', 'Desktop') */
+    device?: string;
+    /** Operating system or platform (e.g., 'iOS', 'Android', 'Windows') */
+    os?: string;
+    /** IP of the device */
+    ip?: string;
+    /** Application version (e.g., '1.2.3') */
+    appVersion?: string;
+    /** Environment the event originated from */
+    env?: string;
+    /** Any additional context metadata */
+    [key: string]: any;
+};
+export type TSAnalyticsEvent = {
+    /**
+     * The name of the event, used to identify the type of action.
+     */
+    key: string;
+    /**
+     * The timestamp of when the event occurred, in Unix milliseconds.
+     */
+    timestamp: number;
+    context?: TSAnalyticsEventMetadata;
+    /**
+     * A dictionary of custom event-specific properties.
+     * These describe metadata unique to this event type.
+     */
+    properties?: Record<string, any>;
+    /**
+     * The internal user ID associated with this event.
+     * Optional for anonymous or pre-authentication events.
+     */
+    userId?: UniqueId;
+    /**
+     * The group or organization ID associated with the event, if applicable.
+     */
+    groups?: TypedMap<UniqueId>;
+    /**
+     * The session ID this event is part of.
+     * Useful for session-level tracking, funnels, and behavior analysis.
+     */
+    sessionId?: UniqueId;
+};

package/types.js

@@ -0,0 +1 @@
+export {};