Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 8 additions & 2 deletions src/consent.ts
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ import KitFilterHelper from './kitFilterHelper';
import Constants from './constants';
import { IMParticleUser } from './identity-user-interfaces';
import { IMParticleWebSDKInstance } from './mp-instance';
import { logDeprecatedMethodUsage } from './reporting/deprecatedMethodLogger';

const { CCPAPurpose } = Constants;

Expand Down Expand Up @@ -505,8 +506,13 @@ export default function Consent(this: IConsent, mpInstance: IMParticleWebSDKInst

// TODO: Can we remove this? It is deprecated.
function removeCCPAState(this: ConsentState) {
mpInstance.Logger.warning(
'removeCCPAState is deprecated and will be removed in a future release; use removeCCPAConsentState instead'
logDeprecatedMethodUsage(
{
methodName: 'Consent.removeCCPAState',
warningMessage: 'removeCCPAState is deprecated and will be removed in a future release; use removeCCPAConsentState instead',
},
mpInstance.Logger,
mpInstance._LoggingDispatcher
);
// @ts-ignore
return removeCCPAConsentState();
Expand Down
75 changes: 73 additions & 2 deletions src/forwarders.interfaces.ts
Original file line number Diff line number Diff line change
@@ -1,8 +1,16 @@
import { SDKEvent, SDKEventCustomFlags } from './sdkRuntimeModels';
import { SDKEvent, SDKEventCustomFlags, SDKLoggerApi } from './sdkRuntimeModels';
import { Dictionary } from './utils';
import { IKitConfigs, IKitFilterSettings } from './configAPIClient';
import {
IKitConfigs,
IKitFilterSettings,
IConfigResponse,
IFilteringUserAttributeValue,
} from './configAPIClient';
import { IForwardingStatsData } from './apiClient';
import { IdentityApiData, IdentityType } from '@mparticle/web-sdk';
import { Batch } from '@mparticle/event-models';
import { AsyncUploader } from './uploaders';
import { IPixelConfiguration } from './cookieSyncManager';

import {
IMParticleUser,
Expand Down Expand Up @@ -31,6 +39,11 @@ export interface UnregisteredKit {
suffix?: string;
}

export interface SideloadedKit {
kitInstance: UnregisteredKit;
filterDictionary: IKitFilterSettings;
}

// The state of the kit after being added to forwarderConstructors in the CDN
// or after registered to SDKConfig.kits via NPM
// Sideloaded Kits would also be considered registered
Expand Down Expand Up @@ -81,6 +94,7 @@ export interface ConfiguredKit
): string;
onUserIdentified(user: IMParticleUser): string;
process(event: SDKEvent): string;
processBatch?(batch: Batch): string;
setOptOut(isOptingOut: boolean): string;
removeUserAttribute(key: string): string;
setUserAttribute(key: string, value: string): string;
Expand All @@ -89,6 +103,9 @@ export interface ConfiguredKit
// TODO: https://go.mparticle.com/work/SQDSDKS-5156
isSandbox: boolean;
hasSandbox: boolean;

initialized?: boolean;
logger?: SDKLoggerApi;
}

export interface KitInterface {
Expand Down Expand Up @@ -140,3 +157,57 @@ export type forwardingStatsCallback = (
forwarder: ConfiguredKit,
event: SDKEvent
) => void;

export interface IForwarders {
forwarderStatsUploader: AsyncUploader;
initForwarders(
userIdentities: ISDKUserIdentity[],
forwardingStatsCallback: forwardingStatsCallback
): void;
isEnabledForUserAttributes(
filterObject: IFilteringUserAttributeValue,
user: IMParticleUser
): boolean;
isEnabledForUnknownUser(
excludeAnonymousUserBoolean: boolean,
user: IMParticleUser
): boolean;
applyToForwarders(functionName: string, functionArgs: unknown): void;
sendEventToForwarders(event: SDKEvent): void;
sendBatchToForwarders(batch: Batch): void;
handleForwarderUserAttributes(
functionNameKey: string,
key: string,
value: string
): void;
setForwarderUserIdentities(userIdentities: ISDKUserIdentity[]): void;
setForwarderOnUserIdentified(user: IMParticleUser): void;
setForwarderOnIdentityComplete(
user: IMParticleUser,
identityMethod: string
): void;
getForwarderStatsQueue(): IForwardingStatsData[];
setForwarderStatsQueue(queue: IForwardingStatsData[]): void;
processForwarders(
config: IConfigResponse,
forwardingStatsCallback: forwardingStatsCallback
): void;
processUIEnabledKits(config: IConfigResponse): void;
returnKitConstructors(): Dictionary<RegisteredKit>;
configureUIEnabledKit(
configuration: IKitConfigs,
kits: Dictionary<RegisteredKit>
): void;
processSideloadedKits(mpConfig: IConfigResponse & { sideloadedKits?: SideloadedKit[] }): void;
configureSideloadedKit(kitConstructor: RegisteredKit): void;
returnConfiguredKit(
forwarder: RegisteredKit,
config: Partial<IKitConfigs>
): MPForwarder;
configurePixel(settings: IPixelConfiguration): void;
processPixelConfigs(config: IConfigResponse): void;
sendSingleForwardingStatsToServer(
forwardingStatsData: IForwardingStatsData
): Promise<void>;
}

Loading
Loading