@mparticle/web-sdk 2.66.0 → 2.68.0

package/src/identity.interfaces.ts

@@ -12,6 +12,7 @@ import {
     mParticleUserCart,
     IIdentityResponse,
 } from './identity-user-interfaces';
+import { IdentitySearchCallback } from './identity/search';
 const { platform, sdkVendor, sdkVersion, HTTPCodes } = Constants;
 
 export type IdentityPreProcessResult = {
@@ -156,8 +157,53 @@ export interface SDKIdentityApi {
         destinationUser: IMParticleUser,
         scope?: AliasRequestScope
     ): IAliasRequest;
+    /**
+     * Sends a request to mParticle's IDSync `/v1/search` endpoint to look up
+     * a workspace identity without affecting the current user. The callback
+     * receives `httpCode` (always) and an optional `body` containing the
+     * parsed JSON response. Consumers should gate behaviour on
+     * `httpCode === 200`.
+     *
+     * `workspaceApiKey` is a workspace-specific API key supplied by the
+     * caller (from a kit's settings). It is sent as the `x-mp-key` header.
+     * The SDK's own workspace token is intentionally not used.
+     */
+    search?(
+        workspaceApiKey: string,
+        knownIdentities: UserIdentities,
+        callback: IdentitySearchCallback
+    ): void;
 }
 
+export type {
+    IIdentitySearchResult,
+    IIdentitySearchResponseBody,
+    IdentitySearchCallback,
+} from './identity/search';
+
+export interface IUserIdentities {
+    customerid?: string;
+    email?: string;
+    other?: string;
+    other2?: string;
+    other3?: string;
+    other4?: string;
+    other5?: string;
+    other6?: string;
+    other7?: string;
+    other8?: string;
+    other9?: string;
+    other10?: string;
+    mobile_number?: string;
+    phone_number_2?: string;
+    phone_number_3?: string;
+    facebook?: string;
+    facebookcustomaudienceid?: string;
+    google?: string;
+    twitter?: string;
+    microsoft?: string;
+    yahoo?: string;
+}
 export interface IIdentity {
     audienceManager: AudienceManager;
     idCache: BaseVault<Dictionary<ICachedIdentityCall>>;

package/src/identity.js

@@ -3,6 +3,8 @@ import Types, { IdentityType } from './types';
 import {
     cacheOrClearIdCache,
     createKnownIdentities,
+    executeSearchRequest,
+    normalizeUserIdentityKeys,
     tryCacheIdentity,
 } from './identity-utils';
 import AudienceManager from './audienceManager';
@@ -34,11 +36,21 @@ export default function Identity(mpInstance) {
             );
 
             // First, remove any falsy identity values and warn about them
-            const cleanedIdentityApiData = mpInstance._Helpers.Validators.removeFalsyIdentityValues(
+            const removedFalsyIdentityData = mpInstance._Helpers.Validators.removeFalsyIdentityValues(
                 identityApiData,
                 mpInstance.Logger
             );
 
+            // Normalize convenience aliases (email_sha256 → other, mobile_sha256 → other2)
+            const cleanedIdentityApiData = removedFalsyIdentityData?.userIdentities
+                ? {
+                      ...removedFalsyIdentityData,
+                      userIdentities: normalizeUserIdentityKeys(
+                          removedFalsyIdentityData.userIdentities
+                      ),
+                  }
+                : removedFalsyIdentityData;
+
             var identityValidationResult = mpInstance._Helpers.Validators.validateIdentities(
                 cleanedIdentityApiData,
                 method
@@ -730,6 +742,32 @@ export default function Identity(mpInstance) {
             }
         },
 
+        /**
+         * Search the IDSync Workspace endpoint for a known identity.
+         *
+         * POSTs to mParticle's `/v1/search` endpoint and invokes `callback`
+         * with `{ httpCode, body? }`.
+         *
+         * The `workspaceApiKey` is a workspace-specific API key supplied by
+         * the caller (passed in from a kit's settings). It is intentionally
+         * NOT read from the SDK's own workspace token, so that workspace
+         * searches can be authorised independently of the host SDK's
+         * workspace.
+         *
+         * @method search
+         * @param {String} workspaceApiKey Workspace API key (sent as x-mp-key).
+         * @param {Object} knownIdentities A `UserIdentities` map.
+         * @param {Function} callback Invoked with the `IIdentitySearchResult`.
+         */
+        search: function(workspaceApiKey, knownIdentities, callback) {
+            executeSearchRequest(
+                mpInstance,
+                workspaceApiKey,
+                knownIdentities,
+                callback
+            );
+        },
+
         /**
          Create a default AliasRequest for 2 MParticleUsers. This will construct the request
         using the sourceUser's firstSeenTime as the startTime, and its lastSeenTime as the endTime.

package/src/mparticle-instance-manager.ts

@@ -394,6 +394,13 @@ function mParticleInstanceManager(this: IMParticleInstanceManager) {
         modify: function(identityApiData, callback) {
             self.getInstance().Identity.modify(identityApiData, callback);
         },
+        search: function(workspaceApiKey, knownIdentities, callback) {
+            self.getInstance().Identity.search(
+                workspaceApiKey,
+                knownIdentities,
+                callback
+            );
+        },
     };
 
     this.sessionManager = {

package/src/public-types.ts

@@ -56,6 +56,10 @@ export type {
     IAliasCallback,
     IAliasResult,
     SDKIdentityTypeEnum,
+    IIdentitySearchResult,
+    IIdentitySearchResponseBody,
+    IdentitySearchCallback,
+    IUserIdentities
 } from './identity.interfaces';
 
 // eCommerce

package/src/sdkRuntimeModels.ts

@@ -161,9 +161,9 @@ export interface SDKProductAction {
 }
 
 export interface SDKProduct {
-    Sku?: string;
-    Name?: string;
-    Price?: number;
+    Sku: string;
+    Name: string;
+    Price: number;
     Quantity?: number;
     Brand?: string;
     Variant?: string;
@@ -173,7 +173,7 @@ export interface SDKProduct {
     TotalAmount?: number;
 
     // https://go.mparticle.com/work/SQDSDKS-4801
-    Attributes?: Record<string, unknown> | null;
+    Attributes?: Record<string, unknown>;
 }
 
 // https://go.mparticle.com/work/SQDSDKS-6949
@@ -306,7 +306,7 @@ export const LogLevelType = {
 // Currently, this extends MPConfiguration in @types/mparticle__web-sdk
 // and the two will be merged in once the Store module is refactored
 export interface SDKInitConfig
-    extends Omit<MPConfiguration, 'dataPlan' | 'logLevel'> {
+    extends Omit<MPConfiguration, 'dataPlan' | 'logLevel' | 'identityCallback'> {
     dataPlan?: DataPlanConfig | KitBlockerDataPlan; // TODO: These should be eventually split into two different attributes
     logLevel?: LogLevelType;
 

package/src/stub/mparticle.stub.js

@@ -56,6 +56,7 @@ let mParticle = {
         login: voidFunction,
         logout: voidFunction,
         modify: voidFunction,
+        search: voidFunction,
     },
 };
 

package/src/types.ts

@@ -205,6 +205,10 @@ export const IdentityType = {
                 return IdentityType.PhoneNumber2;
             case 'phone_number_3':
                 return IdentityType.PhoneNumber3;
+            case 'email_sha256':
+                return IdentityType.Other;
+            case 'mobile_sha256':
+                return IdentityType.Other2;
             default:
                 return false;
         }