@rudderstack/analytics-js 3.6.0 → 3.7.0

package/CHANGELOG.md

@@ -2,6 +2,35 @@
 
 This file was generated using [@jscutlery/semver](https://github.com/jscutlery/semver).
 
+## [3.7.0](https://github.com/rudderlabs/rudder-sdk-js/compare/@rudderstack/analytics-js@3.6.1...@rudderstack/analytics-js@3.7.0) (2024-07-19)
+
+### Dependency Updates
+
+* `@rudderstack/analytics-js-cookies` updated to version `3.6.1`
+* `@rudderstack/analytics-js-common` updated to version `3.6.1`
+* `@rudderstack/analytics-js-plugins` updated to version `3.6.1`
+
+### Features
+
+* error reporting plugin ([#1601](https://github.com/rudderlabs/rudder-sdk-js/issues/1601)) ([1f2629e](https://github.com/rudderlabs/rudder-sdk-js/commit/1f2629e594740763ce9bd54a21213b92d80ae085))
+
+
+### Bug Fixes
+
+* event API overloads ([#1782](https://github.com/rudderlabs/rudder-sdk-js/issues/1782)) ([02c5b47](https://github.com/rudderlabs/rudder-sdk-js/commit/02c5b47d0a83250fb5180e9ed467a92361663dab))
+
+## [3.6.1](https://github.com/rudderlabs/rudder-sdk-js/compare/@rudderstack/analytics-js@3.6.0...@rudderstack/analytics-js@3.6.1) (2024-07-05)
+
+### Dependency Updates
+
+* `@rudderstack/analytics-js-cookies` updated to version `3.6.0`
+* `@rudderstack/analytics-js-common` updated to version `3.6.0`
+* `@rudderstack/analytics-js-plugins` updated to version `3.6.0`
+
+### Bug Fixes
+
+* package lint issues ([#1773](https://github.com/rudderlabs/rudder-sdk-js/issues/1773)) ([8e45d05](https://github.com/rudderlabs/rudder-sdk-js/commit/8e45d052bd6366d647d06226aa89b1fa2e512f9d))
+
 ## [3.6.0](https://github.com/rudderlabs/rudder-sdk-js/compare/@rudderstack/analytics-js@3.5.2...@rudderstack/analytics-js@3.6.0) (2024-07-04)
 
 ### Dependency Updates

package/LICENSE.md

@@ -0,0 +1,53 @@
+### Elastic License 2.0 (ELv2)
+
+## Acceptance
+
+By using the software, you agree to all of the terms and conditions below.
+
+## Copyright License
+
+The licensor grants you a non-exclusive, royalty-free, worldwide, non-sublicensable, non-transferable license to use, copy, distribute, make available, and prepare derivative works of the software, in each case subject to the limitations and conditions below
+
+## Limitations
+
+You may not provide the software to third parties as a hosted or managed service, where the service provides users with access to any substantial set of the features or functionality of the software.
+
+You may not move, change, disable, or circumvent the license key functionality in the software, and you may not remove or obscure any functionality in the software that is protected by the license key.
+
+You may not alter, remove, or obscure any licensing, copyright, or other notices of the licensor in the software. Any use of the licensor's trademarks is subject to applicable law.
+
+## Patents
+
+The licensor grants you a license, under any patent claims the licensor can license, or becomes able to license, to make, have made, use, sell, offer for sale, import and have imported the software, in each case subject to the limitations and conditions in this license. This license does not cover any patent claims that you cause to be infringed by modifications or additions to the software. If you or your company make any written claim that the software infringes or contributes to infringement of any patent, your patent license for the software granted under these terms ends immediately. If your company makes such a claim, your patent license ends immediately for work on behalf of your company.
+
+## Notices
+
+You must ensure that anyone who gets a copy of any part of the software from you also gets a copy of these terms.
+
+If you modify the software, you must include in any modified copies of the software prominent notices stating that you have modified the software.
+
+## No Other Rights
+
+These terms do not imply any licenses other than those expressly granted in these terms.
+
+## Termination
+
+If you use the software in violation of these terms, such use is not licensed, and your licenses will automatically terminate. If the licensor provides you with a notice of your violation, and you cease all violation of this license no later than 30 days after you receive that notice, your licenses will be reinstated retroactively. However, if you violate these terms after such reinstatement, any additional violation of these terms will cause your licenses to terminate automatically and permanently.
+
+## No Liability
+
+As far as the law allows, the software comes as is, without any warranty or condition, and the licensor will not be liable to you for any damages arising out of these terms or the use or nature of the software, under any kind of legal claim.
+
+## Definitions
+
+The *licensor* is the entity offering these terms, and the *software* is the software the licensor makes available under these terms, including any portion of it.
+
+*you* refers to the individual or entity agreeing to these terms.
+
+*your company* is any legal entity, sole proprietorship, or other kind of organization that you work for, plus all organizations that have control over, are under the control of, or are under common control with that organization. *control* means ownership of substantially all the assets of an entity, or the power to direct its management and policies by vote, contract, or otherwise. Control can be direct or indirect.
+
+*your licenses* are all the licenses granted to you for the software under these terms.
+
+*use* means anything you do with the software requiring one of your licenses.
+
+*trademark* means trademarks, service marks, and similar rights.

package/README.md

@@ -92,3 +92,47 @@ For more details, see:
 
 - [Vercel Edge Usage](https://github.com/rudderlabs/rudder-sdk-js/blob/main/examples/serverless/USAGE.md)
 - [Cloudflare Worker Usage](https://github.com/rudderlabs/rudder-sdk-js/blob/main/examples/serverless/USAGE.md)
+
+## License
+
+This project is licensed under the Elastic License 2.0. See the [LICENSE.md](LICENSE.md) file for details. Review the license terms to understand your permissions and restrictions.
+
+If you have any questions about licensing, please [contact us](#contact-us) or refer to the [official Elastic licensing](https://www.elastic.co/licensing/elastic-license) page.
+
+## Contribute
+
+We invite you to contribute to this project. For more information on how to contribute, please see [**here**](../../CONTRIBUTING.md).
+
+## Contact us
+
+For more information on any of the sections covered in this readme, you can [**contact us**](mailto:%20docs@rudderstack.com) or start a conversation on our [**Slack**](https://resources.rudderstack.com/join-rudderstack-slack) channel.
+
+## Follow Us
+
+- [RudderStack Blog][rudderstack-blog]
+- [Slack][slack]
+- [Twitter][twitter]
+- [LinkedIn][linkedin]
+- [dev.to][devto]
+- [Medium][medium]
+- [YouTube][youtube]
+- [HackerNews][hackernews]
+- [Product Hunt][producthunt]
+
+## :clap: Our Supporters
+
+[![Stargazers repo roster for @rudderlabs/rudder-sdk-js](https://reporoster.com/stars/rudderlabs/rudder-sdk-js)](https://github.com/rudderlabs/rudder-sdk-js/stargazers)
+
+[![Forkers repo roster for @rudderlabs/rudder-sdk-js](https://reporoster.com/forks/rudderlabs/rudder-sdk-js)](https://github.com/rudderlabs/rudder-sdk-js/network/members)
+
+<!----variables---->
+
+[rudderstack-blog]: https://rudderstack.com/blog/
+[slack]: https://resources.rudderstack.com/join-rudderstack-slack
+[twitter]: https://twitter.com/rudderstack
+[linkedin]: https://www.linkedin.com/company/rudderlabs/
+[devto]: https://dev.to/rudderstack
+[medium]: https://rudderstack.medium.com/
+[youtube]: https://www.youtube.com/channel/UCgV-B77bV_-LOmKYHw8jvBw
+[hackernews]: https://news.ycombinator.com/item?id=21081756
+[producthunt]: https://www.producthunt.com/posts/rudderstack

package/dist/npm/{index.d.ts → index.d.cts}

@@ -44,7 +44,7 @@ type Nullable<T> = T | null;
  * Use for parameters like properties, traits etc.
  */
 type ApiObject = {
-    [index: string]: string | number | boolean | ApiObject | null | Date | (string | number | boolean | null | ApiObject)[] | undefined;
+    [index: string]: string | number | boolean | ApiObject | null | Date | (string | number | boolean | null | Date | ApiObject)[] | undefined;
 };
 
 type DestinationIntgConfig = boolean | undefined | ApiObject;
@@ -79,7 +79,7 @@ type APIEvent = {
     callback?: () => void;
     userId?: Nullable<string>;
     traits?: Nullable<ApiObject>;
-    to?: Nullable<string>;
+    to?: string;
     from?: string;
     groupId?: Nullable<string>;
 };
@@ -338,7 +338,6 @@ type IdentifyTraits = {
     prospect?: string | boolean;
     doubleOptin?: string | boolean;
     event_id?: string;
-    constructor?: Record<string, string>;
     organization?: string;
     region?: string;
     anonymous?: string | boolean;
@@ -354,45 +353,44 @@ type IdentifyTraits = {
     anonymousId?: string | number;
     ip_address?: string;
     number?: string | number;
-    [index: string]: string | number | boolean | ApiObject | null | (string | number | boolean | null | ApiObject)[] | undefined;
+    [index: string]: string | number | boolean | ApiObject | null | Date | (string | number | boolean | null | Date | ApiObject)[] | undefined;
 };
 
 type AnalyticsIdentifyMethod = {
-    (userId?: string, traits?: Nullable<IdentifyTraits>, options?: Nullable<ApiOptions>, callback?: ApiCallback): void;
-    (userId: string, traits: Nullable<IdentifyTraits>, callback: ApiCallback): void;
-    (userId: string, callback: ApiCallback): void;
-    (traits: Nullable<IdentifyTraits>, options: Nullable<ApiOptions>, callback?: ApiCallback): void;
+    (userId: string, traits?: Nullable<IdentifyTraits>, options?: Nullable<ApiOptions>, callback?: ApiCallback): void;
+    (userId: string, traits?: Nullable<IdentifyTraits>, callback?: ApiCallback): void;
+    (userId: string, callback?: ApiCallback): void;
+    (traits: Nullable<IdentifyTraits>, options?: Nullable<ApiOptions>, callback?: ApiCallback): void;
     (traits: Nullable<IdentifyTraits>, callback?: ApiCallback): void;
 };
 type AnalyticsPageMethod = {
-    (category?: string, name?: string, properties?: Nullable<ApiObject>, options?: Nullable<ApiOptions>, callback?: ApiCallback): void;
-    (category: string, name: string, properties: Nullable<ApiObject>, callback: ApiCallback): void;
+    (category: string, name: string, properties?: Nullable<ApiObject>, options?: Nullable<ApiOptions>, callback?: ApiCallback): void;
+    (category: string, name: string, properties?: Nullable<ApiObject>, callback?: ApiCallback): void;
+    (category: string, name: string, callback?: ApiCallback): void;
     (name: string, properties?: Nullable<ApiObject>, options?: Nullable<ApiOptions>, callback?: ApiCallback): void;
-    (category: string, name: string, callback: ApiCallback): void;
-    (name: string, properties: Nullable<ApiObject>, callback: ApiCallback): void;
-    (name: string, callback: ApiCallback): void;
-    (properties: Nullable<ApiObject>, options: Nullable<ApiOptions>, callback?: ApiCallback): void;
+    (name: string, properties?: Nullable<ApiObject>, callback?: ApiCallback): void;
+    (name: string, callback?: ApiCallback): void;
+    (properties: Nullable<ApiObject>, options?: Nullable<ApiOptions>, callback?: ApiCallback): void;
     (properties: Nullable<ApiObject>, callback?: ApiCallback): void;
+    (callback?: ApiCallback): void;
 };
 type AnalyticsTrackMethod = {
     (event: string, properties?: Nullable<ApiObject>, options?: Nullable<ApiOptions>, callback?: ApiCallback): void;
-    (event: string, properties: Nullable<ApiObject>, callback: ApiCallback): void;
-    (event: string, callback: ApiCallback): void;
+    (event: string, properties?: Nullable<ApiObject>, callback?: ApiCallback): void;
+    (event: string, callback?: ApiCallback): void;
 };
 type AnalyticsGroupMethod = {
-    (groupId: string | number, traits?: Nullable<ApiObject>, options?: Nullable<ApiOptions>, callback?: ApiCallback): void;
-    (groupId: string | number, traits: Nullable<ApiObject>, callback: ApiCallback): void;
-    (groupId: string | number, callback: ApiCallback): void;
-    (traits: Nullable<ApiObject>, options: Nullable<ApiOptions>, callback?: ApiCallback): void;
-    (traits: Nullable<ApiObject>, callback?: ApiCallback): void;
+    (groupId: string, traits?: Nullable<IdentifyTraits>, options?: Nullable<ApiOptions>, callback?: ApiCallback): void;
+    (groupId: string, traits?: Nullable<IdentifyTraits>, callback?: ApiCallback): void;
+    (groupId: string, callback?: ApiCallback): void;
+    (traits: Nullable<IdentifyTraits>, options?: Nullable<ApiOptions>, callback?: ApiCallback): void;
+    (traits: Nullable<IdentifyTraits>, callback?: ApiCallback): void;
 };
 type AnalyticsAliasMethod = {
-    (to: Nullable<string>, from?: string, options?: Nullable<ApiOptions>, callback?: ApiCallback): void;
-    (to: Nullable<string>, from: string, callback: ApiCallback): void;
-    (to: Nullable<string>, options: Nullable<ApiOptions>, callback?: ApiCallback): void;
-    (to: Nullable<string>, callback: ApiCallback): void;
-    (to: ApiCallback): void;
-    (): void;
+    (to: string, from?: string, options?: Nullable<ApiOptions>, callback?: ApiCallback): void;
+    (to: string, from?: string, callback?: ApiCallback): void;
+    (to: string, options?: Nullable<ApiOptions>, callback?: ApiCallback): void;
+    (to: string, callback?: ApiCallback): void;
 };
 interface IRudderAnalytics<T = any> {
     analyticsInstances: Record<string, T>;
@@ -497,6 +495,20 @@ interface IRudderAnalytics<T = any> {
     consent(options?: ConsentOptions): void;
 }
 
+/**
+ * A buffer queue to serve as a store for any type of data
+ */
+declare class BufferQueue<T = any> {
+    items: T[];
+    constructor();
+    enqueue(item: T): void;
+    dequeue(): Nullable<T> | undefined;
+    isEmpty(): boolean;
+    size(): number;
+    clear(): void;
+}
+//# sourceMappingURL=BufferQueue.d.ts.map
+
 interface IExternalSourceLoadConfig {
     url: string;
     id: string;
@@ -509,36 +521,22 @@ interface IExternalSrcLoader {
     errorHandler?: {
         onError(error: unknown, context?: string, customMessage?: string, shouldAlwaysThrow?: boolean): void;
         leaveBreadcrumb(breadcrumb: string): void;
-        notifyError(error: Error): void;
+        notifyError(error: Error, errorState: ErrorState): void;
     };
     logger?: ILogger;
     timeout: number;
     loadJSFile(config: IExternalSourceLoadConfig): void;
 }
 
-/**
- * A buffer queue to serve as a store for any type of data
- */
-declare class BufferQueue<T = any> {
-    items: T[];
-    constructor();
-    enqueue(item: T): void;
-    dequeue(): Nullable<T> | undefined;
-    isEmpty(): boolean;
-    size(): number;
-    clear(): void;
-}
-//# sourceMappingURL=BufferQueue.d.ts.map
-
 type SDKError = unknown | Error | ErrorEvent | Event | PromiseRejectionEvent;
 interface IErrorHandler {
     logger?: ILogger;
     pluginEngine?: IPluginEngine;
     errorBuffer: BufferQueue<PreLoadErrorData>;
-    init(externalSrcLoader: IExternalSrcLoader): void;
+    init(httpClient: IHttpClient, externalSrcLoader: IExternalSrcLoader): void;
     onError(error: SDKError, context?: string, customMessage?: string, shouldAlwaysThrow?: boolean, errorType?: string): void;
     leaveBreadcrumb(breadcrumb: string): void;
-    notifyError(error: Error): void;
+    notifyError(error: Error, errorState: ErrorState): void;
     attachErrorListeners(): void;
 }
 type ErrorState = {
@@ -670,14 +668,14 @@ type TrackCallOptions = {
     callback?: ApiCallback;
 };
 type IdentifyCallOptions = {
-    userId?: string | null;
+    userId?: Nullable<string>;
     traits?: Nullable<IdentifyTraits>;
     options?: Nullable<ApiOptions>;
     callback?: ApiCallback;
 };
 type AliasCallOptions = {
-    to?: Nullable<string>;
-    from?: Nullable<string>;
+    to: string;
+    from?: string;
     options?: Nullable<ApiOptions>;
     callback?: ApiCallback;
 };
@@ -982,23 +980,44 @@ declare class RudderAnalytics implements IRudderAnalytics<IAnalytics> {
     /**
      * Process page arguments and forward to page call
      */
-    page(category?: string | Nullable<ApiObject> | ApiCallback, name?: string | Nullable<ApiOptions> | Nullable<ApiObject> | ApiCallback, properties?: Nullable<ApiOptions> | Nullable<ApiObject> | ApiCallback, options?: Nullable<ApiOptions> | ApiCallback, callback?: ApiCallback): void;
+    page(category: string, name: string, properties?: Nullable<ApiObject>, options?: Nullable<ApiOptions>, callback?: ApiCallback): void;
+    page(category: string, name: string, properties?: Nullable<ApiObject>, callback?: ApiCallback): void;
+    page(category: string, name: string, callback?: ApiCallback): void;
+    page(name: string, properties?: Nullable<ApiObject>, options?: Nullable<ApiOptions>, callback?: ApiCallback): void;
+    page(name: string, properties?: Nullable<ApiObject>, callback?: ApiCallback): void;
+    page(name: string, callback?: ApiCallback): void;
+    page(properties: Nullable<ApiObject>, options?: Nullable<ApiOptions>, callback?: ApiCallback): void;
+    page(properties: Nullable<ApiObject>, callback?: ApiCallback): void;
+    page(callback?: ApiCallback): void;
     /**
      * Process track arguments and forward to page call
      */
-    track(event: string, properties?: Nullable<ApiObject> | ApiCallback, options?: Nullable<ApiOptions> | ApiCallback, callback?: ApiCallback): void;
+    track(event: string, properties?: Nullable<ApiObject>, options?: Nullable<ApiOptions>, callback?: ApiCallback): void;
+    track(event: string, properties?: Nullable<ApiObject>, callback?: ApiCallback): void;
+    track(event: string, callback?: ApiCallback): void;
     /**
      * Process identify arguments and forward to page call
      */
-    identify(userId?: string | number | Nullable<IdentifyTraits>, traits?: Nullable<IdentifyTraits> | Nullable<ApiOptions> | ApiCallback, options?: Nullable<ApiOptions> | ApiCallback, callback?: ApiCallback): void;
+    identify(userId: string, traits?: Nullable<IdentifyTraits>, options?: Nullable<ApiOptions>, callback?: ApiCallback): void;
+    identify(userId: string, traits?: Nullable<IdentifyTraits>, callback?: ApiCallback): void;
+    identify(userId: string, callback?: ApiCallback): void;
+    identify(traits: Nullable<IdentifyTraits>, options?: Nullable<ApiOptions>, callback?: ApiCallback): void;
+    identify(traits: Nullable<IdentifyTraits>, callback?: ApiCallback): void;
     /**
      * Process alias arguments and forward to page call
      */
-    alias(to?: Nullable<string> | ApiCallback, from?: string | Nullable<ApiOptions> | ApiCallback, options?: Nullable<ApiOptions> | ApiCallback, callback?: ApiCallback): void;
+    alias(to: string, from?: string, options?: Nullable<ApiOptions>, callback?: ApiCallback): void;
+    alias(to: string, from?: string, callback?: ApiCallback): void;
+    alias(to: string, options?: Nullable<ApiOptions>, callback?: ApiCallback): void;
+    alias(to: string, callback?: ApiCallback): void;
     /**
      * Process group arguments and forward to page call
      */
-    group(groupId: string | number | Nullable<ApiObject> | ApiCallback, traits?: Nullable<ApiOptions> | Nullable<ApiObject> | ApiCallback, options?: Nullable<ApiOptions> | ApiCallback, callback?: ApiCallback): void;
+    group(groupId: string, traits?: Nullable<IdentifyTraits>, options?: Nullable<ApiOptions>, callback?: ApiCallback): void;
+    group(groupId: string, traits?: Nullable<IdentifyTraits>, callback?: ApiCallback): void;
+    group(groupId: string, callback?: ApiCallback): void;
+    group(traits: Nullable<IdentifyTraits>, options?: Nullable<ApiOptions>, callback?: ApiCallback): void;
+    group(traits: Nullable<IdentifyTraits>, callback?: ApiCallback): void;
     reset(resetAnonymousId?: boolean): void;
     getAnonymousId(options?: AnonymousIdOptions): string | undefined;
     setAnonymousId(anonymousId?: string, rudderAmpLinkerParam?: string): void;