@amplitude/plugin-global-user-properties 1.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Amplitude Analytics
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,66 @@
+<p align="center">
+  <a href="https://amplitude.com" target="_blank" align="center">
+    <img src="https://static.amplitude.com/lightning/46c85bfd91905de8047f1ee65c7c93d6fa9ee6ea/static/media/amplitude-logo-with-text.4fb9e463.svg" width="280">
+  </a>
+  <br />
+</p>
+
+# @amplitude/plugin-global-user-properties
+
+Official SDK plugin for adding global user properties to events
+
+## Installation
+
+This package is published on NPM registry and is available to be installed using npm and yarn.
+
+```sh
+# npm
+npm install @amplitude/plugin-global-user-properties
+
+# yarn
+yarn add @amplitude/plugin-global-user-properties
+```
+
+## Usage
+
+This plugin works on top of the Amplitude SDK and sends user properties as global user properties, a beta feature for that allows projects to share user properties (i.e. user properties can become "global" across multiple projects). 
+
+To use this plugin, you need to install `@amplitude/plugin-global-user-properties `v1.0.0` or later.
+
+### 1. Import Amplitude packages
+
+* `@amplitude/plugin-global-user-properties`
+
+```typescript
+import * as Amplitude from '@amplitude/analytics-browser'
+import { globalUserPropertiesPlugin } from '@amplitude/plugin-global-user-properties';
+```
+
+### 2. Instantiate page view plugin
+
+The plugin accepts an optional parameter of type `Object` to configure the plugin based on your use case.
+
+```typescript
+const globalUserPropertiesPlugin = globalUserPropertiesPlugin({
+  shouldKeepOriginalUserProperties: true,
+});
+```
+
+#### Options
+
+|Name|Type|Default|Description|
+|-|-|-|-|
+|`shouldKeepOriginalUserProperties`|`boolean`| `false` | Use this option if you want the user properties to be sent along with the global user properties. Since global user properties do not appear in Data yet, this would allow indirect governance (by observing the same properties as regular user properties). |
+
+### 3. Install plugin to Amplitude SDK
+
+```typescript
+amplitude.add(globalUserPropertiesPlugin);
+```
+
+### 4. Initialize Amplitude SDK
+
+```typescript
+amplitude.init('API_KEY');
+```
+

package/lib/cjs/global-user-properties.d.ts

@@ -0,0 +1,3 @@
+import { GlobalUserPropertiesPlugin } from './typings/global-user-properties';
+export declare const globalUserPropertiesPlugin: GlobalUserPropertiesPlugin;
+//# sourceMappingURL=global-user-properties.d.ts.map

package/lib/cjs/global-user-properties.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"global-user-properties.d.ts","sourceRoot":"","sources":["../../src/global-user-properties.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,0BAA0B,EAAW,MAAM,kCAAkC,CAAC;AAGvF,eAAO,MAAM,0BAA0B,EAAE,0BAoBxC,CAAC"}

package/lib/cjs/global-user-properties.js

@@ -0,0 +1,27 @@
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.globalUserPropertiesPlugin = void 0;
+var tslib_1 = require("tslib");
+var helpers_1 = require("./helpers");
+var globalUserPropertiesPlugin = function (options) {
+    var _this = this;
+    if (options === void 0) { options = {}; }
+    var plugin = {
+        name: '@amplitude/plugin-global-user-properties',
+        type: 'enrichment',
+        /* Note: The promise is because of the interface, not because this has any asynchronous behavior */
+        execute: function (event) { return tslib_1.__awaiter(_this, void 0, void 0, function () {
+            return tslib_1.__generator(this, function (_a) {
+                if ((0, helpers_1.isTrackEvent)(event) || (0, helpers_1.isAmplitudeIdentifyEvent)(event)) {
+                    event.global_user_properties = event.user_properties;
+                    if (!options.shouldKeepOriginalUserProperties) {
+                        delete event.user_properties;
+                    }
+                }
+                return [2 /*return*/, event];
+            });
+        }); },
+    };
+    return plugin;
+};
+exports.globalUserPropertiesPlugin = globalUserPropertiesPlugin;
+//# sourceMappingURL=global-user-properties.js.map

package/lib/cjs/global-user-properties.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"global-user-properties.js","sourceRoot":"","sources":["../../src/global-user-properties.ts"],"names":[],"mappings":";;;AAEA,qCAAmE;AAE5D,IAAM,0BAA0B,GAA+B,UAAU,OAAqB;IAA/B,iBAoBrE;IApB+E,wBAAA,EAAA,YAAqB;IACnG,IAAM,MAAM,GAAqB;QAC/B,IAAI,EAAE,0CAA0C;QAChD,IAAI,EAAE,YAAY;QAElB,mGAAmG;QACnG,OAAO,EAAE,UAAO,KAAY;;gBAC1B,IAAI,IAAA,sBAAY,EAAC,KAAK,CAAC,IAAI,IAAA,kCAAwB,EAAC,KAAK,CAAC,EAAE;oBAC1D,KAAK,CAAC,sBAAsB,GAAG,KAAK,CAAC,eAAe,CAAC;oBAErD,IAAI,CAAC,OAAO,CAAC,gCAAgC,EAAE;wBAC7C,OAAO,KAAK,CAAC,eAAe,CAAC;qBAC9B;iBACF;gBAED,sBAAO,KAAK,EAAC;;aACd;KACF,CAAC;IAEF,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC;AApBW,QAAA,0BAA0B,8BAoBrC","sourcesContent":["import { EnrichmentPlugin, Event } from '@amplitude/analytics-types';\nimport { GlobalUserPropertiesPlugin, Options } from './typings/global-user-properties';\nimport { isAmplitudeIdentifyEvent, isTrackEvent } from './helpers';\n\nexport const globalUserPropertiesPlugin: GlobalUserPropertiesPlugin = function (options: Options = {}) {\n  const plugin: EnrichmentPlugin = {\n    name: '@amplitude/plugin-global-user-properties',\n    type: 'enrichment',\n\n    /* Note: The promise is because of the interface, not because this has any asynchronous behavior */\n    execute: async (event: Event): Promise<Event> => {\n      if (isTrackEvent(event) || isAmplitudeIdentifyEvent(event)) {\n        event.global_user_properties = event.user_properties;\n\n        if (!options.shouldKeepOriginalUserProperties) {\n          delete event.user_properties;\n        }\n      }\n\n      return event;\n    },\n  };\n\n  return plugin;\n};\n"]}

package/lib/cjs/helpers.d.ts

@@ -0,0 +1,4 @@
+import { Event, TrackEvent, IdentifyEvent } from '@amplitude/analytics-types';
+export declare const isTrackEvent: (event: Event) => event is TrackEvent;
+export declare const isAmplitudeIdentifyEvent: (event: Event) => event is IdentifyEvent;
+//# sourceMappingURL=helpers.d.ts.map

package/lib/cjs/helpers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"helpers.d.ts","sourceRoot":"","sources":["../../src/helpers.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,UAAU,EAAoB,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAIhG,eAAO,MAAM,YAAY,UAAW,KAAK,wBAExC,CAAC;AAEF,eAAO,MAAM,wBAAwB,UAAW,KAAK,2BAEpD,CAAC"}

package/lib/cjs/helpers.js

@@ -0,0 +1,13 @@
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isAmplitudeIdentifyEvent = exports.isTrackEvent = void 0;
+var analytics_types_1 = require("@amplitude/analytics-types");
+var specialAmplitudeEvents = new Set(Object.values(analytics_types_1.SpecialEventType));
+var isTrackEvent = function (event) {
+    return !specialAmplitudeEvents.has(event.event_type);
+};
+exports.isTrackEvent = isTrackEvent;
+var isAmplitudeIdentifyEvent = function (event) {
+    return event.event_type === analytics_types_1.SpecialEventType.IDENTIFY;
+};
+exports.isAmplitudeIdentifyEvent = isAmplitudeIdentifyEvent;
+//# sourceMappingURL=helpers.js.map

package/lib/cjs/helpers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"helpers.js","sourceRoot":"","sources":["../../src/helpers.ts"],"names":[],"mappings":";;AAAA,8DAAgG;AAEhG,IAAM,sBAAsB,GAAG,IAAI,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC,kCAAgB,CAAC,CAAC,CAAC;AAEjE,IAAM,YAAY,GAAG,UAAC,KAAY;IACvC,OAAO,CAAC,sBAAsB,CAAC,GAAG,CAAC,KAAK,CAAC,UAA8B,CAAC,CAAC;AAC3E,CAAC,CAAC;AAFW,QAAA,YAAY,gBAEvB;AAEK,IAAM,wBAAwB,GAAG,UAAC,KAAY;IACnD,OAAO,KAAK,CAAC,UAAU,KAAK,kCAAgB,CAAC,QAAQ,CAAC;AACxD,CAAC,CAAC;AAFW,QAAA,wBAAwB,4BAEnC","sourcesContent":["import { Event, TrackEvent, SpecialEventType, IdentifyEvent } from '@amplitude/analytics-types';\n\nconst specialAmplitudeEvents = new Set(Object.values(SpecialEventType));\n\nexport const isTrackEvent = (event: Event): event is TrackEvent => {\n  return !specialAmplitudeEvents.has(event.event_type as SpecialEventType);\n};\n\nexport const isAmplitudeIdentifyEvent = (event: Event): event is IdentifyEvent => {\n  return event.event_type === SpecialEventType.IDENTIFY;\n};\n"]}

package/lib/cjs/index.d.ts

@@ -0,0 +1,4 @@
+export { globalUserPropertiesPlugin } from './global-user-properties';
+export { globalUserPropertiesPlugin as plugin } from './global-user-properties';
+export { GlobalUserPropertiesPlugin, Options } from './typings/global-user-properties';
+//# sourceMappingURL=index.d.ts.map

package/lib/cjs/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,0BAA0B,EAAE,MAAM,0BAA0B,CAAC;AACtE,OAAO,EAAE,0BAA0B,IAAI,MAAM,EAAE,MAAM,0BAA0B,CAAC;AAChF,OAAO,EAAE,0BAA0B,EAAE,OAAO,EAAE,MAAM,kCAAkC,CAAC"}

package/lib/cjs/index.js

@@ -0,0 +1,7 @@
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.plugin = exports.globalUserPropertiesPlugin = void 0;
+var global_user_properties_1 = require("./global-user-properties");
+Object.defineProperty(exports, "globalUserPropertiesPlugin", { enumerable: true, get: function () { return global_user_properties_1.globalUserPropertiesPlugin; } });
+var global_user_properties_2 = require("./global-user-properties");
+Object.defineProperty(exports, "plugin", { enumerable: true, get: function () { return global_user_properties_2.globalUserPropertiesPlugin; } });
+//# sourceMappingURL=index.js.map

package/lib/cjs/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;AAAA,mEAAsE;AAA7D,oIAAA,0BAA0B,OAAA;AACnC,mEAAgF;AAAvE,gHAAA,0BAA0B,OAAU","sourcesContent":["export { globalUserPropertiesPlugin } from './global-user-properties';\nexport { globalUserPropertiesPlugin as plugin } from './global-user-properties';\nexport { GlobalUserPropertiesPlugin, Options } from './typings/global-user-properties';\n"]}

package/lib/cjs/typings/global-user-properties.d.ts

@@ -0,0 +1,11 @@
+import { EnrichmentPlugin } from '@amplitude/analytics-types';
+export interface Options {
+    /**
+     * Whether or not the orignal user_properties field should be kept on the event
+     */
+    shouldKeepOriginalUserProperties?: boolean;
+}
+export interface GlobalUserPropertiesPlugin {
+    (options?: Options): EnrichmentPlugin;
+}
+//# sourceMappingURL=global-user-properties.d.ts.map

package/lib/cjs/typings/global-user-properties.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"global-user-properties.d.ts","sourceRoot":"","sources":["../../../src/typings/global-user-properties.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,4BAA4B,CAAC;AAE9D,MAAM,WAAW,OAAO;IACtB;;OAEG;IACH,gCAAgC,CAAC,EAAE,OAAO,CAAC;CAC5C;AAED,MAAM,WAAW,0BAA0B;IACzC,CAAC,OAAO,CAAC,EAAE,OAAO,GAAG,gBAAgB,CAAC;CACvC"}

package/lib/cjs/typings/global-user-properties.js

@@ -0,0 +1,2 @@
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=global-user-properties.js.map

package/lib/cjs/typings/global-user-properties.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"global-user-properties.js","sourceRoot":"","sources":["../../../src/typings/global-user-properties.ts"],"names":[],"mappings":"","sourcesContent":["import { EnrichmentPlugin } from '@amplitude/analytics-types';\n\nexport interface Options {\n  /**\n   * Whether or not the orignal user_properties field should be kept on the event\n   */\n  shouldKeepOriginalUserProperties?: boolean;\n}\n\nexport interface GlobalUserPropertiesPlugin {\n  (options?: Options): EnrichmentPlugin;\n}\n"]}

package/lib/esm/global-user-properties.d.ts

@@ -0,0 +1,3 @@
+import { GlobalUserPropertiesPlugin } from './typings/global-user-properties';
+export declare const globalUserPropertiesPlugin: GlobalUserPropertiesPlugin;
+//# sourceMappingURL=global-user-properties.d.ts.map

package/lib/esm/global-user-properties.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"global-user-properties.d.ts","sourceRoot":"","sources":["../../src/global-user-properties.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,0BAA0B,EAAW,MAAM,kCAAkC,CAAC;AAGvF,eAAO,MAAM,0BAA0B,EAAE,0BAoBxC,CAAC"}

package/lib/esm/global-user-properties.js

@@ -0,0 +1,24 @@
+import { __awaiter, __generator } from "tslib";
+import { isAmplitudeIdentifyEvent, isTrackEvent } from './helpers';
+export var globalUserPropertiesPlugin = function (options) {
+    var _this = this;
+    if (options === void 0) { options = {}; }
+    var plugin = {
+        name: '@amplitude/plugin-global-user-properties',
+        type: 'enrichment',
+        /* Note: The promise is because of the interface, not because this has any asynchronous behavior */
+        execute: function (event) { return __awaiter(_this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                if (isTrackEvent(event) || isAmplitudeIdentifyEvent(event)) {
+                    event.global_user_properties = event.user_properties;
+                    if (!options.shouldKeepOriginalUserProperties) {
+                        delete event.user_properties;
+                    }
+                }
+                return [2 /*return*/, event];
+            });
+        }); },
+    };
+    return plugin;
+};
+//# sourceMappingURL=global-user-properties.js.map

package/lib/esm/global-user-properties.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"global-user-properties.js","sourceRoot":"","sources":["../../src/global-user-properties.ts"],"names":[],"mappings":";AAEA,OAAO,EAAE,wBAAwB,EAAE,YAAY,EAAE,MAAM,WAAW,CAAC;AAEnE,MAAM,CAAC,IAAM,0BAA0B,GAA+B,UAAU,OAAqB;IAA/B,iBAoBrE;IApB+E,wBAAA,EAAA,YAAqB;IACnG,IAAM,MAAM,GAAqB;QAC/B,IAAI,EAAE,0CAA0C;QAChD,IAAI,EAAE,YAAY;QAElB,mGAAmG;QACnG,OAAO,EAAE,UAAO,KAAY;;gBAC1B,IAAI,YAAY,CAAC,KAAK,CAAC,IAAI,wBAAwB,CAAC,KAAK,CAAC,EAAE;oBAC1D,KAAK,CAAC,sBAAsB,GAAG,KAAK,CAAC,eAAe,CAAC;oBAErD,IAAI,CAAC,OAAO,CAAC,gCAAgC,EAAE;wBAC7C,OAAO,KAAK,CAAC,eAAe,CAAC;qBAC9B;iBACF;gBAED,sBAAO,KAAK,EAAC;;aACd;KACF,CAAC;IAEF,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC","sourcesContent":["import { EnrichmentPlugin, Event } from '@amplitude/analytics-types';\nimport { GlobalUserPropertiesPlugin, Options } from './typings/global-user-properties';\nimport { isAmplitudeIdentifyEvent, isTrackEvent } from './helpers';\n\nexport const globalUserPropertiesPlugin: GlobalUserPropertiesPlugin = function (options: Options = {}) {\n  const plugin: EnrichmentPlugin = {\n    name: '@amplitude/plugin-global-user-properties',\n    type: 'enrichment',\n\n    /* Note: The promise is because of the interface, not because this has any asynchronous behavior */\n    execute: async (event: Event): Promise<Event> => {\n      if (isTrackEvent(event) || isAmplitudeIdentifyEvent(event)) {\n        event.global_user_properties = event.user_properties;\n\n        if (!options.shouldKeepOriginalUserProperties) {\n          delete event.user_properties;\n        }\n      }\n\n      return event;\n    },\n  };\n\n  return plugin;\n};\n"]}

package/lib/esm/helpers.d.ts

@@ -0,0 +1,4 @@
+import { Event, TrackEvent, IdentifyEvent } from '@amplitude/analytics-types';
+export declare const isTrackEvent: (event: Event) => event is TrackEvent;
+export declare const isAmplitudeIdentifyEvent: (event: Event) => event is IdentifyEvent;
+//# sourceMappingURL=helpers.d.ts.map

package/lib/esm/helpers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"helpers.d.ts","sourceRoot":"","sources":["../../src/helpers.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,UAAU,EAAoB,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAIhG,eAAO,MAAM,YAAY,UAAW,KAAK,wBAExC,CAAC;AAEF,eAAO,MAAM,wBAAwB,UAAW,KAAK,2BAEpD,CAAC"}

package/lib/esm/helpers.js

@@ -0,0 +1,9 @@
+import { SpecialEventType } from '@amplitude/analytics-types';
+var specialAmplitudeEvents = new Set(Object.values(SpecialEventType));
+export var isTrackEvent = function (event) {
+    return !specialAmplitudeEvents.has(event.event_type);
+};
+export var isAmplitudeIdentifyEvent = function (event) {
+    return event.event_type === SpecialEventType.IDENTIFY;
+};
+//# sourceMappingURL=helpers.js.map

package/lib/esm/helpers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"helpers.js","sourceRoot":"","sources":["../../src/helpers.ts"],"names":[],"mappings":"AAAA,OAAO,EAAqB,gBAAgB,EAAiB,MAAM,4BAA4B,CAAC;AAEhG,IAAM,sBAAsB,GAAG,IAAI,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC,gBAAgB,CAAC,CAAC,CAAC;AAExE,MAAM,CAAC,IAAM,YAAY,GAAG,UAAC,KAAY;IACvC,OAAO,CAAC,sBAAsB,CAAC,GAAG,CAAC,KAAK,CAAC,UAA8B,CAAC,CAAC;AAC3E,CAAC,CAAC;AAEF,MAAM,CAAC,IAAM,wBAAwB,GAAG,UAAC,KAAY;IACnD,OAAO,KAAK,CAAC,UAAU,KAAK,gBAAgB,CAAC,QAAQ,CAAC;AACxD,CAAC,CAAC","sourcesContent":["import { Event, TrackEvent, SpecialEventType, IdentifyEvent } from '@amplitude/analytics-types';\n\nconst specialAmplitudeEvents = new Set(Object.values(SpecialEventType));\n\nexport const isTrackEvent = (event: Event): event is TrackEvent => {\n  return !specialAmplitudeEvents.has(event.event_type as SpecialEventType);\n};\n\nexport const isAmplitudeIdentifyEvent = (event: Event): event is IdentifyEvent => {\n  return event.event_type === SpecialEventType.IDENTIFY;\n};\n"]}

package/lib/esm/index.d.ts

@@ -0,0 +1,4 @@
+export { globalUserPropertiesPlugin } from './global-user-properties';
+export { globalUserPropertiesPlugin as plugin } from './global-user-properties';
+export { GlobalUserPropertiesPlugin, Options } from './typings/global-user-properties';
+//# sourceMappingURL=index.d.ts.map

package/lib/esm/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,0BAA0B,EAAE,MAAM,0BAA0B,CAAC;AACtE,OAAO,EAAE,0BAA0B,IAAI,MAAM,EAAE,MAAM,0BAA0B,CAAC;AAChF,OAAO,EAAE,0BAA0B,EAAE,OAAO,EAAE,MAAM,kCAAkC,CAAC"}

package/lib/esm/index.js

@@ -0,0 +1,3 @@
+export { globalUserPropertiesPlugin } from './global-user-properties';
+export { globalUserPropertiesPlugin as plugin } from './global-user-properties';
+//# sourceMappingURL=index.js.map

package/lib/esm/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,0BAA0B,EAAE,MAAM,0BAA0B,CAAC;AACtE,OAAO,EAAE,0BAA0B,IAAI,MAAM,EAAE,MAAM,0BAA0B,CAAC","sourcesContent":["export { globalUserPropertiesPlugin } from './global-user-properties';\nexport { globalUserPropertiesPlugin as plugin } from './global-user-properties';\nexport { GlobalUserPropertiesPlugin, Options } from './typings/global-user-properties';\n"]}

package/lib/esm/typings/global-user-properties.d.ts

@@ -0,0 +1,11 @@
+import { EnrichmentPlugin } from '@amplitude/analytics-types';
+export interface Options {
+    /**
+     * Whether or not the orignal user_properties field should be kept on the event
+     */
+    shouldKeepOriginalUserProperties?: boolean;
+}
+export interface GlobalUserPropertiesPlugin {
+    (options?: Options): EnrichmentPlugin;
+}
+//# sourceMappingURL=global-user-properties.d.ts.map

package/lib/esm/typings/global-user-properties.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"global-user-properties.d.ts","sourceRoot":"","sources":["../../../src/typings/global-user-properties.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,4BAA4B,CAAC;AAE9D,MAAM,WAAW,OAAO;IACtB;;OAEG;IACH,gCAAgC,CAAC,EAAE,OAAO,CAAC;CAC5C;AAED,MAAM,WAAW,0BAA0B;IACzC,CAAC,OAAO,CAAC,EAAE,OAAO,GAAG,gBAAgB,CAAC;CACvC"}

package/lib/esm/typings/global-user-properties.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=global-user-properties.js.map

package/lib/esm/typings/global-user-properties.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"global-user-properties.js","sourceRoot":"","sources":["../../../src/typings/global-user-properties.ts"],"names":[],"mappings":"","sourcesContent":["import { EnrichmentPlugin } from '@amplitude/analytics-types';\n\nexport interface Options {\n  /**\n   * Whether or not the orignal user_properties field should be kept on the event\n   */\n  shouldKeepOriginalUserProperties?: boolean;\n}\n\nexport interface GlobalUserPropertiesPlugin {\n  (options?: Options): EnrichmentPlugin;\n}\n"]}

package/lib/scripts/amplitude-min.umd.js

@@ -0,0 +1 @@
+!function(e,n){"object"==typeof exports&&"undefined"!=typeof module?n(exports):"function"==typeof define&&define.amd?define(["exports"],n):n((e="undefined"!=typeof globalThis?globalThis:e||self).amplitude={})}(this,(function(e){"use strict";function n(e,n,t,r){return new(t||(t=Promise))((function(o,i){function u(e){try{a(r.next(e))}catch(e){i(e)}}function l(e){try{a(r.throw(e))}catch(e){i(e)}}function a(e){var n;e.done?o(e.value):(n=e.value,n instanceof t?n:new t((function(e){e(n)}))).then(u,l)}a((r=r.apply(e,n||[])).next())}))}function t(e,n){var t,r,o,i,u={label:0,sent:function(){if(1&o[0])throw o[1];return o[1]},trys:[],ops:[]};return i={next:l(0),throw:l(1),return:l(2)},"function"==typeof Symbol&&(i[Symbol.iterator]=function(){return this}),i;function l(l){return function(a){return function(l){if(t)throw new TypeError("Generator is already executing.");for(;i&&(i=0,l[0]&&(u=0)),u;)try{if(t=1,r&&(o=2&l[0]?r.return:l[0]?r.throw||((o=r.return)&&o.call(r),0):r.next)&&!(o=o.call(r,l[1])).done)return o;switch(r=0,o&&(l=[2&l[0],o.value]),l[0]){case 0:case 1:o=l;break;case 4:return u.label++,{value:l[1],done:!1};case 5:u.label++,r=l[1],l=[0];continue;case 7:l=u.ops.pop(),u.trys.pop();continue;default:if(!(o=u.trys,(o=o.length>0&&o[o.length-1])||6!==l[0]&&2!==l[0])){u=0;continue}if(3===l[0]&&(!o||l[1]>o[0]&&l[1]<o[3])){u.label=l[1];break}if(6===l[0]&&u.label<o[1]){u.label=o[1],o=l;break}if(o&&u.label<o[2]){u.label=o[2],u.ops.push(l);break}o[2]&&u.ops.pop(),u.trys.pop();continue}l=n.call(e,u)}catch(e){l=[6,e],r=0}finally{t=o=0}if(5&l[0])throw l[1];return{value:l[0]?l[1]:void 0,done:!0}}([l,a])}}}var r,o,i;!function(e){e.SET="$set",e.SET_ONCE="$setOnce",e.ADD="$add",e.APPEND="$append",e.PREPEND="$prepend",e.REMOVE="$remove",e.PREINSERT="$preInsert",e.POSTINSERT="$postInsert",e.UNSET="$unset",e.CLEAR_ALL="$clearAll"}(r||(r={})),function(e){e.REVENUE_PRODUCT_ID="$productId",e.REVENUE_QUANTITY="$quantity",e.REVENUE_PRICE="$price",e.REVENUE_TYPE="$revenueType",e.REVENUE="$revenue"}(o||(o={})),function(e){e.IDENTIFY="$identify",e.GROUP_IDENTIFY="$groupidentify",e.REVENUE="revenue_amount"}(i||(i={}));var u=new Set(Object.values(i)),l=function(e){var r=this;return void 0===e&&(e={}),{name:"@amplitude/plugin-global-user-properties",type:"enrichment",execute:function(o){return n(r,void 0,void 0,(function(){return t(this,(function(n){return(function(e){return!u.has(e.event_type)}(o)||function(e){return e.event_type===i.IDENTIFY}(o))&&(o.global_user_properties=o.user_properties,e.shouldKeepOriginalUserProperties||delete o.user_properties),[2,o]}))}))}}};e.globalUserPropertiesPlugin=l,e.plugin=l,Object.defineProperty(e,"__esModule",{value:!0})}));

package/lib/scripts/global-user-properties.d.ts

@@ -0,0 +1,3 @@
+import { GlobalUserPropertiesPlugin } from './typings/global-user-properties';
+export declare const globalUserPropertiesPlugin: GlobalUserPropertiesPlugin;
+//# sourceMappingURL=global-user-properties.d.ts.map

package/lib/scripts/global-user-properties.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"global-user-properties.d.ts","sourceRoot":"","sources":["../../src/global-user-properties.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,0BAA0B,EAAW,MAAM,kCAAkC,CAAC;AAGvF,eAAO,MAAM,0BAA0B,EAAE,0BAoBxC,CAAC"}

package/lib/scripts/helpers.d.ts

@@ -0,0 +1,4 @@
+import { Event, TrackEvent, IdentifyEvent } from '@amplitude/analytics-types';
+export declare const isTrackEvent: (event: Event) => event is TrackEvent;
+export declare const isAmplitudeIdentifyEvent: (event: Event) => event is IdentifyEvent;
+//# sourceMappingURL=helpers.d.ts.map

package/lib/scripts/helpers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"helpers.d.ts","sourceRoot":"","sources":["../../src/helpers.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,UAAU,EAAoB,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAIhG,eAAO,MAAM,YAAY,UAAW,KAAK,wBAExC,CAAC;AAEF,eAAO,MAAM,wBAAwB,UAAW,KAAK,2BAEpD,CAAC"}

package/lib/scripts/index.d.ts

@@ -0,0 +1,4 @@
+export { globalUserPropertiesPlugin } from './global-user-properties';
+export { globalUserPropertiesPlugin as plugin } from './global-user-properties';
+export { GlobalUserPropertiesPlugin, Options } from './typings/global-user-properties';
+//# sourceMappingURL=index.d.ts.map

package/lib/scripts/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,0BAA0B,EAAE,MAAM,0BAA0B,CAAC;AACtE,OAAO,EAAE,0BAA0B,IAAI,MAAM,EAAE,MAAM,0BAA0B,CAAC;AAChF,OAAO,EAAE,0BAA0B,EAAE,OAAO,EAAE,MAAM,kCAAkC,CAAC"}

package/lib/scripts/typings/global-user-properties.d.ts

@@ -0,0 +1,11 @@
+import { EnrichmentPlugin } from '@amplitude/analytics-types';
+export interface Options {
+    /**
+     * Whether or not the orignal user_properties field should be kept on the event
+     */
+    shouldKeepOriginalUserProperties?: boolean;
+}
+export interface GlobalUserPropertiesPlugin {
+    (options?: Options): EnrichmentPlugin;
+}
+//# sourceMappingURL=global-user-properties.d.ts.map

package/lib/scripts/typings/global-user-properties.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"global-user-properties.d.ts","sourceRoot":"","sources":["../../../src/typings/global-user-properties.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,4BAA4B,CAAC;AAE9D,MAAM,WAAW,OAAO;IACtB;;OAEG;IACH,gCAAgC,CAAC,EAAE,OAAO,CAAC;CAC5C;AAED,MAAM,WAAW,0BAA0B;IACzC,CAAC,OAAO,CAAC,EAAE,OAAO,GAAG,gBAAgB,CAAC;CACvC"}

package/package.json

@@ -0,0 +1,56 @@
+{
+  "name": "@amplitude/plugin-global-user-properties",
+  "version": "1.1.0",
+  "description": "An event enrichment plugin that adds the experimental global user properties field to events",
+  "author": "Amplitude Inc",
+  "homepage": "https://github.com/amplitude/Amplitude-TypeScript",
+  "license": "MIT",
+  "main": "lib/cjs/index.js",
+  "module": "lib/esm/index.js",
+  "types": "lib/esm/index.d.ts",
+  "sideEffects": false,
+  "publishConfig": {
+    "access": "public",
+    "tag": "latest"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/amplitude/Amplitude-TypeScript.git"
+  },
+  "scripts": {
+    "build": "yarn bundle && yarn build:es5 && yarn build:esm",
+    "bundle": "rollup --config rollup.config.js",
+    "build:es5": "tsc -p ./tsconfig.es5.json",
+    "build:esm": "tsc -p ./tsconfig.esm.json",
+    "clean": "rimraf node_modules lib coverage",
+    "fix": "yarn fix:eslint & yarn fix:prettier",
+    "fix:eslint": "eslint '{src,test}/**/*.ts' --fix",
+    "fix:prettier": "prettier --write \"{src,test}/**/*.ts\"",
+    "lint": "yarn lint:eslint & yarn lint:prettier",
+    "lint:eslint": "eslint '{src,test}/**/*.ts'",
+    "lint:prettier": "prettier --check \"{src,test}/**/*.ts\"",
+    "test": "jest",
+    "typecheck": "tsc -p ./tsconfig.json"
+  },
+  "bugs": {
+    "url": "https://github.com/amplitude/Amplitude-TypeScript/issues"
+  },
+  "dependencies": {
+    "@amplitude/analytics-types": "^2.2.0",
+    "tslib": "^2.4.1"
+  },
+  "devDependencies": {
+    "@amplitude/analytics-browser": "^2.3.1",
+    "@rollup/plugin-commonjs": "^23.0.4",
+    "@rollup/plugin-node-resolve": "^15.0.1",
+    "@rollup/plugin-typescript": "^10.0.1",
+    "rollup": "^2.79.1",
+    "rollup-plugin-execute": "^1.1.1",
+    "rollup-plugin-gzip": "^3.1.0",
+    "rollup-plugin-terser": "^7.0.2"
+  },
+  "files": [
+    "lib"
+  ],
+  "gitHead": "98e7483e397d83cec498d6284efe92f03f0632c2"
+}