@adtrackify/at-service-common 4.0.4 → 4.0.6

package/dist/esm/services/db/identity-cache-dynamodb-service/types.d.ts

@@ -0,0 +1,205 @@
+import { EventContext, EventIdentity, EventIdentityTraits, IdentityDynamoDbCache, IdentityMapDynamoDbCache, ForcePurgeDynamoDbCache, IdentityPointerRecord } from '@adtrackify/at-tracking-event-types';
+import { IDENTITY_CACHE_STALENESS_TIER, IdentityCacheStaleTracker } from '../../../helpers/identity-cache-helper.js';
+export type { IdentityDynamoDbCache, IdentityMapDynamoDbCache, ForcePurgeDynamoDbCache, IdentityPointerRecord };
+export declare enum CACHE_WRITE_REASON {
+    CACHE_MISS = "cache_miss",
+    STALE_TRAITS = "stale_traits",
+    EMAIL_POINTER_DISCOVERY = "email_pointer_discovery",
+    ADDRESS_UPDATE = "address_update"
+}
+export interface IdentityCacheResult {
+    resolvedIdentity?: EventIdentity;
+    isCacheStale: boolean;
+    cachedIdentity?: EventIdentity;
+    staleTracker?: IdentityCacheStaleTracker;
+    writeReason?: CACHE_WRITE_REASON;
+    staleTier?: IDENTITY_CACHE_STALENESS_TIER;
+    skipNeptune?: boolean;
+}
+export declare enum IDENTITY_CACHE_LOOKUP_OUTCOME {
+    INVALID_INPUT = "invalid_input",
+    PRIMARY_CACHE_MISS = "primary_cache_miss",
+    PRIMARY_CACHE_MISS_NO_RESPONSE = "primary_cache_miss_no_response",
+    PRIMARY_CACHE_HIT = "primary_cache_hit",
+    PRIMARY_CACHE_STALE = "primary_cache_stale",
+    EMAIL_POINTER_DISCOVERY = "email_pointer_discovery",
+    EMAIL_POINTER_MISS = "email_pointer_miss",
+    FAILED = "failed"
+}
+export interface IdentityCacheLookupSummary {
+    outcome: IDENTITY_CACHE_LOOKUP_OUTCOME;
+    pixelId: string;
+    identityId?: string;
+    didLookupByIdentityId: boolean;
+    didLookupByEmail: boolean;
+    isDeepEqual?: boolean;
+    isCacheStale: boolean;
+    staleTier?: IDENTITY_CACHE_STALENESS_TIER;
+    staleTraits: string[];
+    writeReason?: CACHE_WRITE_REASON;
+    skipNeptune?: boolean;
+    cachedIdentity?: EventIdentity;
+    incomingIdentity?: EventIdentity;
+    mergedIdentity?: EventIdentity;
+    resolvedIdentity?: EventIdentity;
+    discoveredIdentityId?: string;
+    incomingClick?: EventIdentityTraits['click'] | null;
+    cachedClick?: EventIdentityTraits['click'] | null;
+    mergedClick?: EventIdentityTraits['click'] | null;
+    errorMessage?: string;
+}
+export interface IdentityCacheLookupResult {
+    cacheResult: IdentityCacheResult;
+    summary: IdentityCacheLookupSummary;
+}
+export interface IdentityCacheLookupSummaryInput {
+    outcome: IDENTITY_CACHE_LOOKUP_OUTCOME;
+    pixelId: string;
+    identityId?: string;
+    didLookupByIdentityId?: boolean;
+    didLookupByEmail?: boolean;
+    isDeepEqual?: boolean;
+    isCacheStale?: boolean;
+    staleTier?: IDENTITY_CACHE_STALENESS_TIER;
+    staleTraits?: string[];
+    writeReason?: CACHE_WRITE_REASON;
+    skipNeptune?: boolean;
+    cachedIdentity?: EventIdentity;
+    incomingIdentity?: EventIdentity;
+    mergedIdentity?: EventIdentity;
+    resolvedIdentity?: EventIdentity;
+    discoveredIdentityId?: string;
+    errorMessage?: string;
+}
+export interface IdentityCacheLookupState {
+    pixelId: string;
+    incomingIdentity: EventIdentity;
+    cachedIdentityResponse?: IdentityDynamoDbCache;
+    cachedIdentity?: EventIdentity;
+    mergedIdentity?: EventIdentity;
+    resolvedIdentity?: EventIdentity;
+    identityStaleCacheTracker?: IdentityCacheStaleTracker;
+    discoveredIdentityId?: string;
+    didLookupByIdentityId: boolean;
+    didLookupByEmail: boolean;
+    isDeepEqual?: boolean;
+    isCacheStale: boolean;
+    staleTier?: IDENTITY_CACHE_STALENESS_TIER;
+    writeReason?: CACHE_WRITE_REASON;
+    skipNeptune?: boolean;
+    staleTraits: string[];
+}
+export interface IdentityCacheLookupStateSummaryInput extends Partial<IdentityCacheLookupSummaryInput> {
+    outcome: IDENTITY_CACHE_LOOKUP_OUTCOME;
+}
+export declare enum IDENTITY_CACHE_WITH_CACHING_OUTCOME {
+    INVALID_INPUT = "invalid_input",
+    FRESH_CACHE_HIT = "fresh_cache_hit",
+    VOLATILE_ONLY_CACHE_HIT = "volatile_only_cache_hit",
+    ADDRESS_UPDATE_WRITE = "address_update_write",
+    NEPTUNE_FETCH = "neptune_fetch",
+    NEPTUNE_WRITE_BACK = "neptune_write_back",
+    NEPTUNE_SKIP_WRITE = "neptune_skip_write",
+    NEPTUNE_RESOLUTION_FAILED = "neptune_resolution_failed",
+    FALLBACK_INCOMING = "fallback_incoming",
+    FAILED = "failed"
+}
+export interface IdentityCacheTraitChange {
+    cached?: unknown;
+    resolved?: unknown;
+}
+export interface IdentityCacheTraitChanges {
+    [traitName: string]: IdentityCacheTraitChange;
+}
+export interface IdentityCacheWithCachingSummary {
+    outcome: IDENTITY_CACHE_WITH_CACHING_OUTCOME;
+    pixelId: string;
+    identityId?: string;
+    writeReason?: CACHE_WRITE_REASON;
+    staleTier?: IDENTITY_CACHE_STALENESS_TIER;
+    staleTraits: string[];
+    didReadCache: boolean;
+    didCallNeptune: boolean;
+    didWriteCache: boolean;
+    didSkipNeptune: boolean;
+    didFallbackToIncoming: boolean;
+    cachedIdentity?: EventIdentity;
+    incomingIdentity?: EventIdentity;
+    identityForNeptune?: EventIdentity;
+    resolvedIdentity?: EventIdentity;
+    neptuneIdentity?: EventIdentity;
+    incomingClick?: EventIdentityTraits['click'] | null;
+    cachedClick?: EventIdentityTraits['click'] | null;
+    resolvedClick?: EventIdentityTraits['click'] | null;
+    neptuneClick?: EventIdentityTraits['click'] | null;
+    traitChanges?: IdentityCacheTraitChanges;
+    hasDiscoveredIdentityId?: boolean;
+    lookupSummary?: IdentityCacheLookupSummary;
+    errorMessage?: string;
+}
+export interface IdentityCacheWithCachingResult {
+    identity?: EventIdentity;
+    summary: IdentityCacheWithCachingSummary;
+}
+export interface IdentityCacheWithCachingSummaryInput {
+    outcome: IDENTITY_CACHE_WITH_CACHING_OUTCOME;
+    pixelId: string;
+    identityId?: string;
+    writeReason?: CACHE_WRITE_REASON;
+    staleTier?: IDENTITY_CACHE_STALENESS_TIER;
+    staleTraits?: string[];
+    didReadCache?: boolean;
+    didCallNeptune?: boolean;
+    didWriteCache?: boolean;
+    didSkipNeptune?: boolean;
+    didFallbackToIncoming?: boolean;
+    cachedIdentity?: EventIdentity;
+    incomingIdentity?: EventIdentity;
+    identityForNeptune?: EventIdentity;
+    resolvedIdentity?: EventIdentity;
+    neptuneIdentity?: EventIdentity;
+    traitChanges?: IdentityCacheTraitChanges;
+    hasDiscoveredIdentityId?: boolean;
+    lookupSummary?: IdentityCacheLookupSummary;
+    errorMessage?: string;
+}
+export interface IdentityCacheWithCachingState {
+    pixelId: string;
+    incomingIdentity?: EventIdentity;
+    identifyPrivateLambdaArn: string;
+    cacheResponse?: IdentityCacheResult;
+    lookupSummary?: IdentityCacheLookupSummary;
+    resolvedIdentity?: EventIdentity;
+    cachedIdentity?: EventIdentity;
+    identityForNeptune?: EventIdentity;
+    neptuneIdentity?: EventIdentity;
+    staleTraits: string[];
+    didReadCache: boolean;
+    didCallNeptune: boolean;
+    didWriteCache: boolean;
+    didSkipNeptune: boolean;
+    didFallbackToIncoming: boolean;
+}
+export interface IdentityCacheWithCachingStateSummaryInput extends Partial<IdentityCacheWithCachingSummaryInput> {
+    outcome: IDENTITY_CACHE_WITH_CACHING_OUTCOME;
+}
+export interface IdentityWithCachingOptions {
+    skipCacheWrite?: boolean;
+}
+export interface EnqueueAsyncIdentityUpdateRequest {
+    pixelId: string;
+    identity: EventIdentity;
+    context: EventContext;
+    reason: string;
+    eventId?: string;
+}
+export interface IdentifyAsyncUpdateMessage {
+    pixelId: string;
+    incomingIdentityId: string;
+    context: EventContext;
+}
+export interface EnqueueAsyncIdentityUpdateResult {
+    success: boolean;
+    messageId?: string;
+    error?: string;
+}

package/dist/esm/services/db/identity-cache-dynamodb-service/types.js

@@ -0,0 +1,32 @@
+export var CACHE_WRITE_REASON;
+(function (CACHE_WRITE_REASON) {
+    CACHE_WRITE_REASON["CACHE_MISS"] = "cache_miss";
+    CACHE_WRITE_REASON["STALE_TRAITS"] = "stale_traits";
+    CACHE_WRITE_REASON["EMAIL_POINTER_DISCOVERY"] = "email_pointer_discovery";
+    CACHE_WRITE_REASON["ADDRESS_UPDATE"] = "address_update";
+})(CACHE_WRITE_REASON || (CACHE_WRITE_REASON = {}));
+export var IDENTITY_CACHE_LOOKUP_OUTCOME;
+(function (IDENTITY_CACHE_LOOKUP_OUTCOME) {
+    IDENTITY_CACHE_LOOKUP_OUTCOME["INVALID_INPUT"] = "invalid_input";
+    IDENTITY_CACHE_LOOKUP_OUTCOME["PRIMARY_CACHE_MISS"] = "primary_cache_miss";
+    IDENTITY_CACHE_LOOKUP_OUTCOME["PRIMARY_CACHE_MISS_NO_RESPONSE"] = "primary_cache_miss_no_response";
+    IDENTITY_CACHE_LOOKUP_OUTCOME["PRIMARY_CACHE_HIT"] = "primary_cache_hit";
+    IDENTITY_CACHE_LOOKUP_OUTCOME["PRIMARY_CACHE_STALE"] = "primary_cache_stale";
+    IDENTITY_CACHE_LOOKUP_OUTCOME["EMAIL_POINTER_DISCOVERY"] = "email_pointer_discovery";
+    IDENTITY_CACHE_LOOKUP_OUTCOME["EMAIL_POINTER_MISS"] = "email_pointer_miss";
+    IDENTITY_CACHE_LOOKUP_OUTCOME["FAILED"] = "failed";
+})(IDENTITY_CACHE_LOOKUP_OUTCOME || (IDENTITY_CACHE_LOOKUP_OUTCOME = {}));
+export var IDENTITY_CACHE_WITH_CACHING_OUTCOME;
+(function (IDENTITY_CACHE_WITH_CACHING_OUTCOME) {
+    IDENTITY_CACHE_WITH_CACHING_OUTCOME["INVALID_INPUT"] = "invalid_input";
+    IDENTITY_CACHE_WITH_CACHING_OUTCOME["FRESH_CACHE_HIT"] = "fresh_cache_hit";
+    IDENTITY_CACHE_WITH_CACHING_OUTCOME["VOLATILE_ONLY_CACHE_HIT"] = "volatile_only_cache_hit";
+    IDENTITY_CACHE_WITH_CACHING_OUTCOME["ADDRESS_UPDATE_WRITE"] = "address_update_write";
+    IDENTITY_CACHE_WITH_CACHING_OUTCOME["NEPTUNE_FETCH"] = "neptune_fetch";
+    IDENTITY_CACHE_WITH_CACHING_OUTCOME["NEPTUNE_WRITE_BACK"] = "neptune_write_back";
+    IDENTITY_CACHE_WITH_CACHING_OUTCOME["NEPTUNE_SKIP_WRITE"] = "neptune_skip_write";
+    IDENTITY_CACHE_WITH_CACHING_OUTCOME["NEPTUNE_RESOLUTION_FAILED"] = "neptune_resolution_failed";
+    IDENTITY_CACHE_WITH_CACHING_OUTCOME["FALLBACK_INCOMING"] = "fallback_incoming";
+    IDENTITY_CACHE_WITH_CACHING_OUTCOME["FAILED"] = "failed";
+})(IDENTITY_CACHE_WITH_CACHING_OUTCOME || (IDENTITY_CACHE_WITH_CACHING_OUTCOME = {}));
+//# sourceMappingURL=types.js.map

package/dist/esm/services/db/identity-cache-dynamodb-service/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../../src/services/db/identity-cache-dynamodb-service/types.ts"],"names":[],"mappings":"AAaA,MAAM,CAAN,IAAY,kBAKX;AALD,WAAY,kBAAkB;IAC5B,+CAAyB,CAAA;IACzB,mDAA6B,CAAA;IAC7B,yEAAmD,CAAA;IACnD,uDAAiC,CAAA;AACnC,CAAC,EALW,kBAAkB,KAAlB,kBAAkB,QAK7B;AAYD,MAAM,CAAN,IAAY,6BASX;AATD,WAAY,6BAA6B;IACvC,gEAA+B,CAAA;IAC/B,0EAAyC,CAAA;IACzC,kGAAiE,CAAA;IACjE,wEAAuC,CAAA;IACvC,4EAA2C,CAAA;IAC3C,oFAAmD,CAAA;IACnD,0EAAyC,CAAA;IACzC,kDAAiB,CAAA;AACnB,CAAC,EATW,6BAA6B,KAA7B,6BAA6B,QASxC;AAyED,MAAM,CAAN,IAAY,mCAWX;AAXD,WAAY,mCAAmC;IAC7C,sEAA+B,CAAA;IAC/B,0EAAmC,CAAA;IACnC,0FAAmD,CAAA;IACnD,oFAA6C,CAAA;IAC7C,sEAA+B,CAAA;IAC/B,gFAAyC,CAAA;IACzC,gFAAyC,CAAA;IACzC,8FAAuD,CAAA;IACvD,8EAAuC,CAAA;IACvC,wDAAiB,CAAA;AACnB,CAAC,EAXW,mCAAmC,KAAnC,mCAAmC,QAW9C"}

package/dist/esm/services/db/index.d.ts

@@ -1,19 +1,22 @@
-export * from './destinations-db-service.js';
-export * from './log-events-db-service.js';
-export * from './pixels-db-service.js';
-export * from './purchasable-contacts-db-service.js';
-export * from './purchased-contacts/index.js';
-export * from './contact-enrichments-db-service.js';
-export * from './tracking-events-db-service.js';
-export * from './shopify-products-cache-db-service.js';
-export * from './shopify-app-installs-db-service.js';
-export * from './identity-cache-db-service.js';
-export * from './identity-cache-dynamodb-service.js';
-export * from './currency-exchange-rates-db-service.js';
-export * from './accounts-db-service.js';
-export * from './subscriptions-db-service.js';
-export * from './user-accounts-db-service.js';
-export * from './api-keys-db-service.js';
-export * from './custom-measures-db-service.js';
-export * from './products-db-service.js';
-export * from './products-db-service-types.js';
+export * from './destinations-db-service.js';
+export * from './log-events-db-service.js';
+export * from './pixels-db-service.js';
+export * from './purchasable-contacts-db-service.js';
+export * from './purchased-contacts/index.js';
+export * from './contact-enrichments-db-service.js';
+export * from './tracking-events-db-service.js';
+export * from './shopify-products-cache-db-service.js';
+export * from './shopify-app-installs-db-service.js';
+export * from './identity-cache-db-service.js';
+export * from './identity-cache-dynamodb-service/types.js';
+export * from './identity-cache-dynamodb-service/key-builders.js';
+export * from './identity-cache-dynamodb-service/identity-cache-dynamodb-db-service.js';
+export * from './identity-cache-dynamodb-service/identity-gateway-service.js';
+export * from './currency-exchange-rates-db-service.js';
+export * from './accounts-db-service.js';
+export * from './subscriptions-db-service.js';
+export * from './user-accounts-db-service.js';
+export * from './api-keys-db-service.js';
+export * from './custom-measures-db-service.js';
+export * from './products-db-service.js';
+export * from './products-db-service-types.js';

package/dist/esm/services/db/index.js

@@ -1,20 +1,23 @@
-export * from './destinations-db-service.js';
-export * from './log-events-db-service.js';
-export * from './pixels-db-service.js';
-export * from './purchasable-contacts-db-service.js';
-export * from './purchased-contacts/index.js';
-export * from './contact-enrichments-db-service.js';
-export * from './tracking-events-db-service.js';
-export * from './shopify-products-cache-db-service.js';
-export * from './shopify-app-installs-db-service.js';
-export * from './identity-cache-db-service.js';
-export * from './identity-cache-dynamodb-service.js';
-export * from './currency-exchange-rates-db-service.js';
-export * from './accounts-db-service.js';
-export * from './subscriptions-db-service.js';
-export * from './user-accounts-db-service.js';
-export * from './api-keys-db-service.js';
-export * from './custom-measures-db-service.js';
-export * from './products-db-service.js';
-export * from './products-db-service-types.js';
+export * from './destinations-db-service.js';
+export * from './log-events-db-service.js';
+export * from './pixels-db-service.js';
+export * from './purchasable-contacts-db-service.js';
+export * from './purchased-contacts/index.js';
+export * from './contact-enrichments-db-service.js';
+export * from './tracking-events-db-service.js';
+export * from './shopify-products-cache-db-service.js';
+export * from './shopify-app-installs-db-service.js';
+export * from './identity-cache-db-service.js';
+export * from './identity-cache-dynamodb-service/types.js';
+export * from './identity-cache-dynamodb-service/key-builders.js';
+export * from './identity-cache-dynamodb-service/identity-cache-dynamodb-db-service.js';
+export * from './identity-cache-dynamodb-service/identity-gateway-service.js';
+export * from './currency-exchange-rates-db-service.js';
+export * from './accounts-db-service.js';
+export * from './subscriptions-db-service.js';
+export * from './user-accounts-db-service.js';
+export * from './api-keys-db-service.js';
+export * from './custom-measures-db-service.js';
+export * from './products-db-service.js';
+export * from './products-db-service-types.js';
 //# sourceMappingURL=index.js.map

package/dist/esm/services/db/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/services/db/index.ts"],"names":[],"mappings":"AAAA,cAAc,8BAA8B,CAAC;AAC7C,cAAc,4BAA4B,CAAC;AAC3C,cAAc,wBAAwB,CAAC;AACvC,cAAc,sCAAsC,CAAC;AACrD,cAAc,+BAA+B,CAAC;AAC9C,cAAc,qCAAqC,CAAC;AACpD,cAAc,iCAAiC,CAAC;AAChD,cAAc,wCAAwC,CAAC;AACvD,cAAc,sCAAsC,CAAC;AACrD,cAAc,gCAAgC,CAAC;AAC/C,cAAc,sCAAsC,CAAC;AACrD,cAAc,yCAAyC,CAAC;AACxD,cAAc,0BAA0B,CAAC;AACzC,cAAc,+BAA+B,CAAC;AAC9C,cAAc,+BAA+B,CAAC;AAC9C,cAAc,0BAA0B,CAAC;AACzC,cAAc,iCAAiC,CAAC;AAChD,cAAc,0BAA0B,CAAC;AACzC,cAAc,gCAAgC,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/services/db/index.ts"],"names":[],"mappings":"AAAA,cAAc,8BAA8B,CAAC;AAC7C,cAAc,4BAA4B,CAAC;AAC3C,cAAc,wBAAwB,CAAC;AACvC,cAAc,sCAAsC,CAAC;AACrD,cAAc,+BAA+B,CAAC;AAC9C,cAAc,qCAAqC,CAAC;AACpD,cAAc,iCAAiC,CAAC;AAChD,cAAc,wCAAwC,CAAC;AACvD,cAAc,sCAAsC,CAAC;AACrD,cAAc,gCAAgC,CAAC;AAC/C,cAAc,4CAA4C,CAAC;AAC3D,cAAc,mDAAmD,CAAC;AAClE,cAAc,yEAAyE,CAAC;AACxF,cAAc,+DAA+D,CAAC;AAC9E,cAAc,yCAAyC,CAAC;AACxD,cAAc,0BAA0B,CAAC;AACzC,cAAc,+BAA+B,CAAC;AAC9C,cAAc,+BAA+B,CAAC;AAC9C,cAAc,0BAA0B,CAAC;AACzC,cAAc,iCAAiC,CAAC;AAChD,cAAc,0BAA0B,CAAC;AACzC,cAAc,gCAAgC,CAAC"}

package/dist/esm/services/db/log-events-db-service.d.ts

@@ -1,11 +1,11 @@
-import { LogEvent, LogEventRecord } from '@adtrackify/at-tracking-event-types';
-export declare class LogEventsDbService {
-    TABLE_NAME: string;
-    constructor(tableName: string);
-    private processResult;
-    private processResults;
-    getLogEventsByDestinationId: (indexName: string, pixelId: string, destinationId: string, limit?: number, afterCollectedAt?: string) => Promise<LogEventRecord[]>;
-    getEventDebugLogs: (indexName: string, pixelId: string, logLevel: string, destinations?: string[], sources?: string[], eventNames?: string[]) => Promise<LogEventRecord[]>;
-    putLogEvent: (logEvent: LogEvent, logGroup: string, ttlInMinutes?: number) => Promise<import("@aws-sdk/lib-dynamodb").PutCommandOutput | null>;
-    private buildLogEventErrorMessage;
-}
+import { LogEvent, LogEventRecord } from '@adtrackify/at-tracking-event-types';
+export declare class LogEventsDbService {
+    TABLE_NAME: string;
+    constructor(tableName: string);
+    private processResult;
+    private processResults;
+    getLogEventsByDestinationId: (indexName: string, pixelId: string, destinationId: string, limit?: number, afterCollectedAt?: string) => Promise<LogEventRecord[]>;
+    getEventDebugLogs: (indexName: string, pixelId: string, logLevel: string, destinations?: string[], sources?: string[], eventNames?: string[]) => Promise<LogEventRecord[]>;
+    putLogEvent: (logEvent: LogEvent, logGroup: string, ttlInMinutes?: number) => Promise<import("@aws-sdk/lib-dynamodb").PutCommandOutput | null>;
+    private buildLogEventErrorMessage;
+}