@amplitude/types - npm Package Compare versions

Comparing version 1.0.3 to 1.0.4

dist/src/event.d.ts

@@ -1,45 +0,4 @@
-/**
- * Amplitude event definition.
- */
-export interface Event {
-    event_type: string;
-    user_id?: string;
-    device_id?: string;
-    time?: number;
-    country?: string;
-    region?: string;
-    city?: string;
-    location_lat?: number;
-    location_lng?: number;
-    dma?: string;
-    language?: string;
-    platform?: string;
-    version_name?: string;
-    library?: string;
-    ip?: string;
-    uuid?: string;
-    event_properties?: {
-        [key: string]: any;
-    };
-    user_properties?: {
-        [key: string]: any;
-    };
-    price?: number;
-    quantity?: number;
-    revenue?: number;
-    productId?: string;
-    revenueType?: string;
-    event_id?: number;
-    session_id?: number;
-    groups?: {
-        [key: string]: any;
-    };
-}
-/**
- * Amplitude request payload definition.
- */
-export interface Payload {
-    api_key: string;
-    events: ReadonlyArray<Event>;
-}
+import { BaseEvent } from './base-event';
+import { IdentifyEvent } from './identify';
+export declare type Event = BaseEvent | IdentifyEvent;
 //# sourceMappingURL=event.d.ts.map

dist/src/index.d.ts

@@ -0,4 +1,7 @@
+export { BaseEvent, SpecialEventType } from './base-event';
+export { Client } from './client';
+export { Event } from './event';
+export { IdentifyEvent, IdentifyOperation, IdentifyUserProperties, ValidPropertyType } from './identify';
+export { Identity, IdentityListener, DEFAULT_IDENTITY_INSTANCE } from './identity';
 export { LogLevel } from './logger';
-export { Client } from './client';
-export { Event, Payload } from './event';
 export { Options } from './options';
@@ -8,3 +11,3 @@ export { Response, ResponseBody, mapJSONToResponse, mapHttpMessageToResponse, SKIPPED_RESPONSE } from './response';
 export { Status } from './status';
-export { Transport, TransportOptions } from './transport';
+export { Transport, TransportOptions, Payload } from './transport';
 //# sourceMappingURL=index.d.ts.map

dist/src/index.js

 Object.defineProperty(exports, "__esModule", { value: true });
+var base_event_1 = require("./base-event");
+Object.defineProperty(exports, "SpecialEventType", { enumerable: true, get: function () { return base_event_1.SpecialEventType; } });
+var identify_1 = require("./identify");
+Object.defineProperty(exports, "IdentifyOperation", { enumerable: true, get: function () { return identify_1.IdentifyOperation; } });
+var identity_1 = require("./identity");
+Object.defineProperty(exports, "DEFAULT_IDENTITY_INSTANCE", { enumerable: true, get: function () { return identity_1.DEFAULT_IDENTITY_INSTANCE; } });
 var logger_1 = require("./logger");
@@ -3,0 +9,0 @@ Object.defineProperty(exports, "LogLevel", { enumerable: true, get: function () { return logger_1.LogLevel; } });

dist/src/transport.d.ts

@@ -1,3 +0,9 @@
-import { Payload } from './event';
 import { Response } from './response';
+/**
+ * Amplitude request payload definition.
+ */
+export interface Payload {
+    api_key: string;
+    events: ReadonlyArray<Event>;
+}
 /** Transport used sending data to Amplitude */
@@ -4,0 +10,0 @@ export interface Transport {

esm/client.d.ts

@@ -1,2 +0,2 @@
-import { Event } from './event';
+import { Event } from './base-event';
 import { Options } from './options';
@@ -11,15 +11,15 @@ /**
 export interface Client<O extends Options = Options> {
-    /** Return the current options */
-    getOptions(): O;
-    /**
-     * Captures a manually created event and sends it to Amplitude.
-     *
-     * @param event The event to send to Amplitude.
-     */
-    logEvent(event: Event): void;
-    /**
-     * Flush and send all the events which haven't been sent.
-     */
-    flush(): void;
+  /** Return the current options */
+  getOptions(): O;
+  /**
+   * Captures a manually created event and sends it to Amplitude.
+   *
+   * @param event The event to send to Amplitude.
+   */
+  logEvent(event: Event): void;
+  /**
+   * Flush and send all the events which haven't been sent.
+   */
+  flush(): void;
 }
-//# sourceMappingURL=client.d.ts.map
+//# sourceMappingURL=client.d.ts.map

esm/index.d.ts

 export { LogLevel } from './logger';
 export { Client } from './client';
-export { Event, Payload } from './event';
+export { Event, Payload } from './base-event';
 export { Options } from './options';
@@ -9,2 +9,2 @@ export { Response, ResponseBody, mapJSONToResponse, mapHttpMessageToResponse } from './response';
 export { Transport, TransportOptions } from './transport';
-//# sourceMappingURL=index.d.ts.map
+//# sourceMappingURL=index.d.ts.map

esm/retry.d.ts

@@ -1,12 +0,12 @@
-import { Event } from './event';
+import { Event } from './base-event';
 import { Response } from './response';
 /** Layer used to send data to Amplitude while retrying throttled events in the right order.  */
 export interface RetryClass {
-    /**
-     * Send the events payload to Amplitude, and retry the events that failed on a loop.
-     *
-     * @param events The events that should be sent to Amplitude.
-     */
-    sendEventsWithRetry(events: ReadonlyArray<Event>): Promise<Response>;
+  /**
+   * Send the events payload to Amplitude, and retry the events that failed on a loop.
+   *
+   * @param events The events that should be sent to Amplitude.
+   */
+  sendEventsWithRetry(events: ReadonlyArray<Event>): Promise<Response>;
 }
-//# sourceMappingURL=retry.d.ts.map
+//# sourceMappingURL=retry.d.ts.map

esm/src/event.d.ts

@@ -1,45 +0,4 @@
-/**
- * Amplitude event definition.
- */
-export interface Event {
-    event_type: string;
-    user_id?: string;
-    device_id?: string;
-    time?: number;
-    country?: string;
-    region?: string;
-    city?: string;
-    location_lat?: number;
-    location_lng?: number;
-    dma?: string;
-    language?: string;
-    platform?: string;
-    version_name?: string;
-    library?: string;
-    ip?: string;
-    uuid?: string;
-    event_properties?: {
-        [key: string]: any;
-    };
-    user_properties?: {
-        [key: string]: any;
-    };
-    price?: number;
-    quantity?: number;
-    revenue?: number;
-    productId?: string;
-    revenueType?: string;
-    event_id?: number;
-    session_id?: number;
-    groups?: {
-        [key: string]: any;
-    };
-}
-/**
- * Amplitude request payload definition.
- */
-export interface Payload {
-    api_key: string;
-    events: ReadonlyArray<Event>;
-}
+import { BaseEvent } from './base-event';
+import { IdentifyEvent } from './identify';
+export declare type Event = BaseEvent | IdentifyEvent;
 //# sourceMappingURL=event.d.ts.map

esm/src/index.d.ts

@@ -0,4 +1,7 @@
+export { BaseEvent, SpecialEventType } from './base-event';
+export { Client } from './client';
+export { Event } from './event';
+export { IdentifyEvent, IdentifyOperation, IdentifyUserProperties, ValidPropertyType } from './identify';
+export { Identity, IdentityListener, DEFAULT_IDENTITY_INSTANCE } from './identity';
 export { LogLevel } from './logger';
-export { Client } from './client';
-export { Event, Payload } from './event';
 export { Options } from './options';
@@ -8,3 +11,3 @@ export { Response, ResponseBody, mapJSONToResponse, mapHttpMessageToResponse, SKIPPED_RESPONSE } from './response';
 export { Status } from './status';
-export { Transport, TransportOptions } from './transport';
+export { Transport, TransportOptions, Payload } from './transport';
 //# sourceMappingURL=index.d.ts.map

esm/src/index.js

@@ -0,1 +1,4 @@
+export { SpecialEventType } from './base-event';
+export { IdentifyOperation } from './identify';
+export { DEFAULT_IDENTITY_INSTANCE } from './identity';
 export { LogLevel } from './logger';
@@ -2,0 +5,0 @@ export { mapJSONToResponse, mapHttpMessageToResponse, SKIPPED_RESPONSE } from './response';

esm/src/transport.d.ts

@@ -1,3 +0,9 @@
-import { Payload } from './event';
 import { Response } from './response';
+/**
+ * Amplitude request payload definition.
+ */
+export interface Payload {
+    api_key: string;
+    events: ReadonlyArray<Event>;
+}
 /** Transport used sending data to Amplitude */
@@ -4,0 +10,0 @@ export interface Transport {

esm/transport.d.ts

@@ -1,21 +0,21 @@
-import { Payload } from './event';
+import { Payload } from './base-event';
 import { Response } from './response';
 /** Transport used sending data to Amplitude */
 export interface Transport {
-    /**
-     * Send the events payload to Amplitude.
-     *
-     * @param payload Payload with events that should be sent to Amplitude.
-     */
-    sendPayload(payload: Payload): Promise<Response>;
+  /**
+   * Send the events payload to Amplitude.
+   *
+   * @param payload Payload with events that should be sent to Amplitude.
+   */
+  sendPayload(payload: Payload): Promise<Response>;
 }
 /** JSDoc */
 export interface TransportOptions {
-    /** Server path destination. */
-    serverUrl: string;
-    /** Define custom headers */
-    headers: {
-        [key: string]: string;
-    };
+  /** Server path destination. */
+  serverUrl: string;
+  /** Define custom headers */
+  headers: {
+    [key: string]: string;
+  };
 }
-//# sourceMappingURL=transport.d.ts.map
+//# sourceMappingURL=transport.d.ts.map

package.json

 {
   "name": "@amplitude/types",
-  "version": "1.0.3",
+  "version": "1.0.4",
   "description": "Types for all Amplitude JavaScript SDKs",
@@ -19,3 +19,5 @@ "repository": "git://github.com/amplitude/Amplitude-Node.git",
   "devDependencies": {
+    "@types/jest": "^26.0.14",
     "eslint": "^7.0.0",
+    "jest": "^26.5.3",
     "npm-run-all": "^4.1.5",
@@ -38,6 +40,7 @@ "prettier": "^1.17.0",
     "fix:eslint": "eslint --fix 'src/**/*.ts'",
-    "link:yarn": "yarn link"
+    "link:yarn": "yarn link",
+    "test": "jest --passWithNoTests"
   },
   "sideEffects": false,
-  "gitHead": "ca12dfa0324842a4913f21566df45cab43554909"
+  "gitHead": "24c1bdd5219a6d2ef9f5c134f47c5322062f4047"
 }

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

129761

increased by21.41%

Number of package files

135

increased by21.62%

Lines of code

1395

increased by17.82%

Worsened metrics

Dev dependency count

6

increased by50%

No dependency changes