@segment/action-destinations 3.478.0 → 3.478.1-staging-7ad09fc36.0

package/dist/destinations/facebook-custom-audiences/sync/constants.js

@@ -0,0 +1,90 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SEGMENT_SCHEMA_PROPERTIES = exports.SCHEMA_PROPERTIES = exports.US_STATE_CODES = void 0;
+exports.US_STATE_CODES = new Map([
+    ['arizona', 'az'],
+    ['alabama', 'al'],
+    ['alaska', 'ak'],
+    ['arkansas', 'ar'],
+    ['california', 'ca'],
+    ['colorado', 'co'],
+    ['connecticut', 'ct'],
+    ['delaware', 'de'],
+    ['florida', 'fl'],
+    ['georgia', 'ga'],
+    ['hawaii', 'hi'],
+    ['idaho', 'id'],
+    ['illinois', 'il'],
+    ['indiana', 'in'],
+    ['iowa', 'ia'],
+    ['kansas', 'ks'],
+    ['kentucky', 'ky'],
+    ['louisiana', 'la'],
+    ['maine', 'me'],
+    ['maryland', 'md'],
+    ['massachusetts', 'ma'],
+    ['michigan', 'mi'],
+    ['minnesota', 'mn'],
+    ['mississippi', 'ms'],
+    ['missouri', 'mo'],
+    ['montana', 'mt'],
+    ['nebraska', 'ne'],
+    ['nevada', 'nv'],
+    ['newhampshire', 'nh'],
+    ['newjersey', 'nj'],
+    ['newmexico', 'nm'],
+    ['newyork', 'ny'],
+    ['northcarolina', 'nc'],
+    ['northdakota', 'nd'],
+    ['ohio', 'oh'],
+    ['oklahoma', 'ok'],
+    ['oregon', 'or'],
+    ['pennsylvania', 'pa'],
+    ['rhodeisland', 'ri'],
+    ['southcarolina', 'sc'],
+    ['southdakota', 'sd'],
+    ['tennessee', 'tn'],
+    ['texas', 'tx'],
+    ['utah', 'ut'],
+    ['vermont', 'vt'],
+    ['virginia', 'va'],
+    ['washington', 'wa'],
+    ['westvirginia', 'wv'],
+    ['wisconsin', 'wi'],
+    ['wyoming', 'wy']
+]);
+exports.SCHEMA_PROPERTIES = [
+    'EXTERN_ID',
+    'EMAIL',
+    'PHONE',
+    'DOBY',
+    'DOBM',
+    'DOBD',
+    'LN',
+    'FN',
+    'FI',
+    'GEN',
+    'CT',
+    'ST',
+    'ZIP',
+    'COUNTRY',
+    'MADID'
+];
+exports.SEGMENT_SCHEMA_PROPERTIES = [
+    'externalId',
+    'email',
+    'phone',
+    'year',
+    'month',
+    'day',
+    'last',
+    'first',
+    'firstInitial',
+    'gender',
+    'city',
+    'state',
+    'zip',
+    'country',
+    'mobileAdId'
+];
+//# sourceMappingURL=constants.js.map

package/dist/destinations/facebook-custom-audiences/sync/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../../../src/destinations/facebook-custom-audiences/sync/constants.ts"],"names":[],"mappings":";;;AAAa,QAAA,cAAc,GAAG,IAAI,GAAG,CAAiB;IACpD,CAAC,SAAS,EAAE,IAAI,CAAC;IACjB,CAAC,SAAS,EAAE,IAAI,CAAC;IACjB,CAAC,QAAQ,EAAE,IAAI,CAAC;IAChB,CAAC,UAAU,EAAE,IAAI,CAAC;IAClB,CAAC,YAAY,EAAE,IAAI,CAAC;IACpB,CAAC,UAAU,EAAE,IAAI,CAAC;IAClB,CAAC,aAAa,EAAE,IAAI,CAAC;IACrB,CAAC,UAAU,EAAE,IAAI,CAAC;IAClB,CAAC,SAAS,EAAE,IAAI,CAAC;IACjB,CAAC,SAAS,EAAE,IAAI,CAAC;IACjB,CAAC,QAAQ,EAAE,IAAI,CAAC;IAChB,CAAC,OAAO,EAAE,IAAI,CAAC;IACf,CAAC,UAAU,EAAE,IAAI,CAAC;IAClB,CAAC,SAAS,EAAE,IAAI,CAAC;IACjB,CAAC,MAAM,EAAE,IAAI,CAAC;IACd,CAAC,QAAQ,EAAE,IAAI,CAAC;IAChB,CAAC,UAAU,EAAE,IAAI,CAAC;IAClB,CAAC,WAAW,EAAE,IAAI,CAAC;IACnB,CAAC,OAAO,EAAE,IAAI,CAAC;IACf,CAAC,UAAU,EAAE,IAAI,CAAC;IAClB,CAAC,eAAe,EAAE,IAAI,CAAC;IACvB,CAAC,UAAU,EAAE,IAAI,CAAC;IAClB,CAAC,WAAW,EAAE,IAAI,CAAC;IACnB,CAAC,aAAa,EAAE,IAAI,CAAC;IACrB,CAAC,UAAU,EAAE,IAAI,CAAC;IAClB,CAAC,SAAS,EAAE,IAAI,CAAC;IACjB,CAAC,UAAU,EAAE,IAAI,CAAC;IAClB,CAAC,QAAQ,EAAE,IAAI,CAAC;IAChB,CAAC,cAAc,EAAE,IAAI,CAAC;IACtB,CAAC,WAAW,EAAE,IAAI,CAAC;IACnB,CAAC,WAAW,EAAE,IAAI,CAAC;IACnB,CAAC,SAAS,EAAE,IAAI,CAAC;IACjB,CAAC,eAAe,EAAE,IAAI,CAAC;IACvB,CAAC,aAAa,EAAE,IAAI,CAAC;IACrB,CAAC,MAAM,EAAE,IAAI,CAAC;IACd,CAAC,UAAU,EAAE,IAAI,CAAC;IAClB,CAAC,QAAQ,EAAE,IAAI,CAAC;IAChB,CAAC,cAAc,EAAE,IAAI,CAAC;IACtB,CAAC,aAAa,EAAE,IAAI,CAAC;IACrB,CAAC,eAAe,EAAE,IAAI,CAAC;IACvB,CAAC,aAAa,EAAE,IAAI,CAAC;IACrB,CAAC,WAAW,EAAE,IAAI,CAAC;IACnB,CAAC,OAAO,EAAE,IAAI,CAAC;IACf,CAAC,MAAM,EAAE,IAAI,CAAC;IACd,CAAC,SAAS,EAAE,IAAI,CAAC;IACjB,CAAC,UAAU,EAAE,IAAI,CAAC;IAClB,CAAC,YAAY,EAAE,IAAI,CAAC;IACpB,CAAC,cAAc,EAAE,IAAI,CAAC;IACtB,CAAC,WAAW,EAAE,IAAI,CAAC;IACnB,CAAC,SAAS,EAAE,IAAI,CAAC;CAClB,CAAC,CAAA;AAIW,QAAA,iBAAiB,GAAG;IAC/B,WAAW;IACX,OAAO;IACP,OAAO;IACP,MAAM;IACN,MAAM;IACN,MAAM;IACN,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,KAAK;IACL,IAAI;IACJ,IAAI;IACJ,KAAK;IACL,SAAS;IACT,OAAO;CACC,CAAA;AAIG,QAAA,yBAAyB,GAAG;IACvC,YAAY;IACZ,OAAO;IACP,OAAO;IACP,MAAM;IACN,OAAO;IACP,KAAK;IACL,MAAM;IACN,OAAO;IACP,cAAc;IACd,QAAQ;IACR,MAAM;IACN,OAAO;IACP,KAAK;IACL,SAAS;IACT,YAAY;CACb,CAAA"}

package/dist/destinations/facebook-custom-audiences/sync/fields.d.ts

@@ -0,0 +1,7 @@
+import { InputField } from '@segment/actions-core';
+import { ActionHookDefinition } from '@segment/actions-core/destination-kit';
+import type { Settings, AudienceSettings } from '../generated-types';
+import type { Payload, RetlOnMappingSaveOutputs, RetlOnMappingSaveInputs } from './generated-types';
+export declare const fields: Record<string, InputField>;
+export declare const retlHookInputFields: ActionHookDefinition<Settings, Payload, AudienceSettings, RetlOnMappingSaveInputs, RetlOnMappingSaveOutputs>['inputFields'];
+export declare const retlHookOutputTypes: ActionHookDefinition<Settings, Payload, AudienceSettings, RetlOnMappingSaveInputs, RetlOnMappingSaveOutputs>['outputTypes'];

package/dist/destinations/facebook-custom-audiences/sync/fields.js

@@ -0,0 +1,269 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.retlHookOutputTypes = exports.retlHookInputFields = exports.fields = void 0;
+const hook_functions_1 = require("./hook-functions");
+exports.fields = {
+    externalId: {
+        type: 'string',
+        required: true,
+        label: 'External ID',
+        category: 'hashedPII',
+        description: 'Your company’s custom identifier for this user. This can be any unique ID, such as loyalty membership IDs, user IDs, and external cookie IDs.',
+        default: { '@path': '$.userId' }
+    },
+    email: {
+        type: 'string',
+        label: 'Email',
+        description: 'User’s email (ex: foo@bar.com)',
+        category: 'hashedPII',
+        default: {
+            '@if': {
+                exists: { '@path': '$.traits.email' },
+                then: { '@path': '$.traits.email' },
+                else: { '@path': '$.properties.email' }
+            }
+        }
+    },
+    phone: {
+        type: 'string',
+        label: 'Phone',
+        description: 'User’s phone number, including country code. Punctuation and spaces are ok (ex: 1-234-567-8910 or +44 844 412 4653)',
+        category: 'hashedPII',
+        default: {
+            '@if': {
+                exists: { '@path': '$.traits.phone' },
+                then: { '@path': '$.traits.phone' },
+                else: { '@path': '$.properties.phone' }
+            }
+        }
+    },
+    birth: {
+        type: 'object',
+        label: 'Date of Birth',
+        description: 'User’s date of birth. Include as many fields as possible for better match rates (ex: year = YYYY, month = MM, day = DD)',
+        defaultObjectUI: 'keyvalue',
+        properties: {
+            year: {
+                type: 'string',
+                label: 'Year'
+            },
+            month: {
+                type: 'string',
+                label: 'Month'
+            },
+            day: {
+                type: 'string',
+                label: 'Day'
+            }
+        },
+        category: 'hashedPII'
+    },
+    name: {
+        type: 'object',
+        label: 'Name',
+        description: 'User’s name. Include as many fields as possible for better match rates. Use a-z only. No punctuation. Special characters in UTF-8 format',
+        category: 'hashedPII',
+        defaultObjectUI: 'keyvalue',
+        properties: {
+            first: {
+                type: 'string',
+                label: 'First Name',
+                category: 'hashedPII'
+            },
+            last: {
+                type: 'string',
+                label: 'Last Name',
+                category: 'hashedPII'
+            },
+            firstInitial: {
+                type: 'string',
+                label: 'First Initial'
+            }
+        },
+        default: {
+            first: {
+                '@if': {
+                    exists: { '@path': '$.traits.first_name' },
+                    then: { '@path': '$.traits.first_name' },
+                    else: { '@path': '$.properties.first_name' }
+                }
+            },
+            last: {
+                '@if': {
+                    exists: { '@path': '$.traits.last_name' },
+                    then: { '@path': '$.traits.last_name' },
+                    else: { '@path': '$.properties.last_name' }
+                }
+            }
+        }
+    },
+    gender: {
+        type: 'string',
+        label: 'Gender',
+        description: 'User’s gender (m for male, f for female)',
+        category: 'hashedPII',
+        default: {
+            '@if': {
+                exists: { '@path': '$.traits.gender' },
+                then: { '@path': '$.traits.gender' },
+                else: { '@path': '$.properties.gender' }
+            }
+        }
+    },
+    city: {
+        type: 'string',
+        label: 'City',
+        description: 'User’s city. Use a-z only. No punctuation. No special characters.',
+        category: 'hashedPII',
+        default: {
+            '@if': {
+                exists: { '@path': '$.traits.city' },
+                then: { '@path': '$.traits.city' },
+                else: { '@path': '$.properties.city' }
+            }
+        }
+    },
+    state: {
+        type: 'string',
+        label: 'State',
+        description: 'User’s state. Use the 2-character ANSI abbreviation code, Normalize states outside the US with no punctuation and no special characters.',
+        category: 'hashedPII',
+        default: {
+            '@if': {
+                exists: { '@path': '$.traits.state' },
+                then: { '@path': '$.traits.state' },
+                else: { '@path': '$.properties.state' }
+            }
+        }
+    },
+    zip: {
+        type: 'string',
+        label: 'Postal Code',
+        description: 'User’s postal code. For the US, use only the first 5 digits. For the UK, use the Area/District/Sector format.',
+        category: 'hashedPII',
+        default: {
+            '@if': {
+                exists: { '@path': '$.traits.postal_code' },
+                then: { '@path': '$.traits.postal_code' },
+                else: { '@path': '$.properties.postal_code' }
+            }
+        }
+    },
+    country: {
+        type: 'string',
+        label: 'Country',
+        description: 'User’s country. Use 2-letter country codes in ISO 3166-1 alpha-2 format.',
+        category: 'hashedPII',
+        default: {
+            '@if': {
+                exists: { '@path': '$.traits.country' },
+                then: { '@path': '$.traits.country' },
+                else: { '@path': '$.properties.country' }
+            }
+        }
+    },
+    mobileAdId: {
+        type: 'string',
+        label: 'Mobile Advertising ID',
+        description: 'User’s Apple IDFA, Android Ad ID, or Facebook app scoped ID. Keep hyphens (ex: AB1234CD-E123-12FG-J123)',
+        category: 'hashedPII'
+    },
+    appId: {
+        type: 'string',
+        label: 'App ID',
+        description: 'The app ID of the user.',
+        category: 'hashedPII'
+    },
+    pageId: {
+        type: 'string',
+        label: 'Page ID',
+        description: 'The page ID of the user.',
+        category: 'hashedPII'
+    },
+    igAccountIds: {
+        type: 'string',
+        label: 'Instagram Account IDs',
+        description: 'The Instagram account ID of the user.'
+    },
+    external_audience_id: {
+        label: 'Facebook List ID',
+        description: `The ID representing the Facebook identifier. This is the identifier that is returned during audience creation.'`,
+        type: 'string',
+        default: {
+            '@path': '$.context.personas.external_audience_id'
+        },
+        unsafe_hidden: true
+    },
+    enable_batching: {
+        label: 'Enable Batching',
+        description: 'Enable batching of requests.',
+        type: 'boolean',
+        default: true,
+        unsafe_hidden: true,
+        required: true
+    },
+    batch_size: {
+        label: 'Batch Size',
+        description: 'Maximum number of events to include in each batch. Actual batch sizes may be lower.',
+        type: 'number',
+        default: 10000,
+        unsafe_hidden: true,
+        required: true
+    }
+};
+exports.retlHookInputFields = {
+    operation: {
+        type: 'string',
+        label: 'Create a new custom audience or connect to an existing one?',
+        description: 'Choose to either create a new custom audience or use an existing one. If you opt to create a new audience, we will display the required fields for audience creation. If you opt to use an existing audience, a drop-down menu will appear, allowing you to select from all the custom audiences in your ad account.',
+        choices: [
+            { label: 'Create New Audience', value: 'create' },
+            { label: 'Connect to Existing Audience', value: 'existing' }
+        ],
+        default: 'create'
+    },
+    audienceName: {
+        type: 'string',
+        label: 'Audience Creation Name',
+        description: 'The name of the audience in Facebook.',
+        depends_on: {
+            conditions: [
+                {
+                    fieldKey: 'operation',
+                    operator: 'is',
+                    value: 'create'
+                }
+            ]
+        }
+    },
+    existingAudienceId: {
+        type: 'string',
+        label: 'Existing Audience ID',
+        description: 'The ID of the audience in Facebook.',
+        depends_on: {
+            conditions: [
+                {
+                    fieldKey: 'operation',
+                    operator: 'is',
+                    value: 'existing'
+                }
+            ]
+        },
+        dynamic: hook_functions_1.getExistingAudienceIdChoices
+    }
+};
+exports.retlHookOutputTypes = {
+    audienceName: {
+        type: 'string',
+        label: 'Audience Name',
+        description: 'The name of the audience in Facebook this mapping is connected to.',
+        required: true
+    },
+    audienceId: {
+        type: 'string',
+        label: 'Audience ID',
+        description: 'The ID of the audience in Facebook.',
+        required: true
+    }
+};
+//# sourceMappingURL=fields.js.map

package/dist/destinations/facebook-custom-audiences/sync/fields.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"fields.js","sourceRoot":"","sources":["../../../../src/destinations/facebook-custom-audiences/sync/fields.ts"],"names":[],"mappings":";;;AAIA,qDAA+D;AAElD,QAAA,MAAM,GAA+B;IAChD,UAAU,EAAE;QACV,IAAI,EAAE,QAAQ;QACd,QAAQ,EAAE,IAAI;QACd,KAAK,EAAE,aAAa;QACpB,QAAQ,EAAE,WAAW;QACrB,WAAW,EAAE,+IAA+I;QAC5J,OAAO,EAAE,EAAE,OAAO,EAAE,UAAU,EAAE;KACjC;IACD,KAAK,EAAE;QACL,IAAI,EAAE,QAAQ;QACd,KAAK,EAAE,OAAO;QACd,WAAW,EAAE,gCAAgC;QAC7C,QAAQ,EAAE,WAAW;QACrB,OAAO,EAAE;YACP,KAAK,EAAE;gBACL,MAAM,EAAE,EAAE,OAAO,EAAE,gBAAgB,EAAE;gBACrC,IAAI,EAAE,EAAE,OAAO,EAAE,gBAAgB,EAAE;gBACnC,IAAI,EAAE,EAAE,OAAO,EAAE,oBAAoB,EAAE;aACxC;SACF;KACF;IACD,KAAK,EAAE;QACL,IAAI,EAAE,QAAQ;QACd,KAAK,EAAE,OAAO;QACd,WAAW,EACT,qHAAqH;QACvH,QAAQ,EAAE,WAAW;QACrB,OAAO,EAAE;YACP,KAAK,EAAE;gBACL,MAAM,EAAE,EAAE,OAAO,EAAE,gBAAgB,EAAE;gBACrC,IAAI,EAAE,EAAE,OAAO,EAAE,gBAAgB,EAAE;gBACnC,IAAI,EAAE,EAAE,OAAO,EAAE,oBAAoB,EAAE;aACxC;SACF;KACF;IACD,KAAK,EAAE;QACL,IAAI,EAAE,QAAQ;QACd,KAAK,EAAE,eAAe;QACtB,WAAW,EAAE,yHAAyH;QACtI,eAAe,EAAE,UAAU;QAC3B,UAAU,EAAE;YACV,IAAI,EAAE;gBACJ,IAAI,EAAE,QAAQ;gBACd,KAAK,EAAE,MAAM;aACd;YACD,KAAK,EAAE;gBACL,IAAI,EAAE,QAAQ;gBACd,KAAK,EAAE,OAAO;aACf;YACD,GAAG,EAAE;gBACH,IAAI,EAAE,QAAQ;gBACd,KAAK,EAAE,KAAK;aACb;SACF;QACD,QAAQ,EAAE,WAAW;KACtB;IACD,IAAI,EAAE;QACJ,IAAI,EAAE,QAAQ;QACd,KAAK,EAAE,MAAM;QACb,WAAW,EACT,0IAA0I;QAC5I,QAAQ,EAAE,WAAW;QACrB,eAAe,EAAE,UAAU;QAC3B,UAAU,EAAE;YACV,KAAK,EAAE;gBACL,IAAI,EAAE,QAAQ;gBACd,KAAK,EAAE,YAAY;gBACnB,QAAQ,EAAE,WAAW;aACtB;YACD,IAAI,EAAE;gBACJ,IAAI,EAAE,QAAQ;gBACd,KAAK,EAAE,WAAW;gBAClB,QAAQ,EAAE,WAAW;aACtB;YACD,YAAY,EAAE;gBACZ,IAAI,EAAE,QAAQ;gBACd,KAAK,EAAE,eAAe;aACvB;SACF;QACD,OAAO,EAAE;YACP,KAAK,EAAE;gBACL,KAAK,EAAE;oBACL,MAAM,EAAE,EAAE,OAAO,EAAE,qBAAqB,EAAE;oBAC1C,IAAI,EAAE,EAAE,OAAO,EAAE,qBAAqB,EAAE;oBACxC,IAAI,EAAE,EAAE,OAAO,EAAE,yBAAyB,EAAE;iBAC7C;aACF;YACD,IAAI,EAAE;gBACJ,KAAK,EAAE;oBACL,MAAM,EAAE,EAAE,OAAO,EAAE,oBAAoB,EAAE;oBACzC,IAAI,EAAE,EAAE,OAAO,EAAE,oBAAoB,EAAE;oBACvC,IAAI,EAAE,EAAE,OAAO,EAAE,wBAAwB,EAAE;iBAC5C;aACF;SACF;KACF;IACD,MAAM,EAAE;QACN,IAAI,EAAE,QAAQ;QACd,KAAK,EAAE,QAAQ;QACf,WAAW,EAAE,0CAA0C;QACvD,QAAQ,EAAE,WAAW;QACrB,OAAO,EAAE;YACP,KAAK,EAAE;gBACL,MAAM,EAAE,EAAE,OAAO,EAAE,iBAAiB,EAAE;gBACtC,IAAI,EAAE,EAAE,OAAO,EAAE,iBAAiB,EAAE;gBACpC,IAAI,EAAE,EAAE,OAAO,EAAE,qBAAqB,EAAE;aACzC;SACF;KACF;IACD,IAAI,EAAE;QACJ,IAAI,EAAE,QAAQ;QACd,KAAK,EAAE,MAAM;QACb,WAAW,EAAE,mEAAmE;QAChF,QAAQ,EAAE,WAAW;QACrB,OAAO,EAAE;YACP,KAAK,EAAE;gBACL,MAAM,EAAE,EAAE,OAAO,EAAE,eAAe,EAAE;gBACpC,IAAI,EAAE,EAAE,OAAO,EAAE,eAAe,EAAE;gBAClC,IAAI,EAAE,EAAE,OAAO,EAAE,mBAAmB,EAAE;aACvC;SACF;KACF;IACD,KAAK,EAAE;QACL,IAAI,EAAE,QAAQ;QACd,KAAK,EAAE,OAAO;QACd,WAAW,EACT,0IAA0I;QAC5I,QAAQ,EAAE,WAAW;QACrB,OAAO,EAAE;YACP,KAAK,EAAE;gBACL,MAAM,EAAE,EAAE,OAAO,EAAE,gBAAgB,EAAE;gBACrC,IAAI,EAAE,EAAE,OAAO,EAAE,gBAAgB,EAAE;gBACnC,IAAI,EAAE,EAAE,OAAO,EAAE,oBAAoB,EAAE;aACxC;SACF;KACF;IACD,GAAG,EAAE;QACH,IAAI,EAAE,QAAQ;QACd,KAAK,EAAE,aAAa;QACpB,WAAW,EACT,+GAA+G;QACjH,QAAQ,EAAE,WAAW;QACrB,OAAO,EAAE;YACP,KAAK,EAAE;gBACL,MAAM,EAAE,EAAE,OAAO,EAAE,sBAAsB,EAAE;gBAC3C,IAAI,EAAE,EAAE,OAAO,EAAE,sBAAsB,EAAE;gBACzC,IAAI,EAAE,EAAE,OAAO,EAAE,0BAA0B,EAAE;aAC9C;SACF;KACF;IACD,OAAO,EAAE;QACP,IAAI,EAAE,QAAQ;QACd,KAAK,EAAE,SAAS;QAChB,WAAW,EAAE,0EAA0E;QACvF,QAAQ,EAAE,WAAW;QACrB,OAAO,EAAE;YACP,KAAK,EAAE;gBACL,MAAM,EAAE,EAAE,OAAO,EAAE,kBAAkB,EAAE;gBACvC,IAAI,EAAE,EAAE,OAAO,EAAE,kBAAkB,EAAE;gBACrC,IAAI,EAAE,EAAE,OAAO,EAAE,sBAAsB,EAAE;aAC1C;SACF;KACF;IACD,UAAU,EAAE;QACV,IAAI,EAAE,QAAQ;QACd,KAAK,EAAE,uBAAuB;QAC9B,WAAW,EACT,yGAAyG;QAC3G,QAAQ,EAAE,WAAW;KACtB;IACD,KAAK,EAAE;QACL,IAAI,EAAE,QAAQ;QACd,KAAK,EAAE,QAAQ;QACf,WAAW,EAAE,yBAAyB;QACtC,QAAQ,EAAE,WAAW;KACtB;IACD,MAAM,EAAE;QACN,IAAI,EAAE,QAAQ;QACd,KAAK,EAAE,SAAS;QAChB,WAAW,EAAE,0BAA0B;QACvC,QAAQ,EAAE,WAAW;KACtB;IACD,YAAY,EAAE;QACZ,IAAI,EAAE,QAAQ;QACd,KAAK,EAAE,uBAAuB;QAC9B,WAAW,EAAE,uCAAuC;KACrD;IACD,oBAAoB,EAAE;QACpB,KAAK,EAAE,kBAAkB;QACzB,WAAW,EAAE,iHAAiH;QAC9H,IAAI,EAAE,QAAQ;QACd,OAAO,EAAE;YACP,OAAO,EAAE,yCAAyC;SACnD;QACD,aAAa,EAAE,IAAI;KACpB;IACD,eAAe,EAAE;QACf,KAAK,EAAE,iBAAiB;QACxB,WAAW,EAAE,8BAA8B;QAC3C,IAAI,EAAE,SAAS;QACf,OAAO,EAAE,IAAI;QACb,aAAa,EAAE,IAAI;QACnB,QAAQ,EAAE,IAAI;KACf;IACD,UAAU,EAAE;QACV,KAAK,EAAE,YAAY;QACnB,WAAW,EAAE,qFAAqF;QAClG,IAAI,EAAE,QAAQ;QACd,OAAO,EAAE,KAAK;QACd,aAAa,EAAE,IAAI;QACnB,QAAQ,EAAE,IAAI;KACf;CACF,CAAA;AAEY,QAAA,mBAAmB,GAAgI;IAC9J,SAAS,EAAE;QACT,IAAI,EAAE,QAAQ;QACd,KAAK,EAAE,6DAA6D;QACpE,WAAW,EACT,sTAAsT;QACxT,OAAO,EAAE;YACP,EAAE,KAAK,EAAE,qBAAqB,EAAE,KAAK,EAAE,QAAQ,EAAE;YACjD,EAAE,KAAK,EAAE,8BAA8B,EAAE,KAAK,EAAE,UAAU,EAAE;SAC7D;QACD,OAAO,EAAE,QAAQ;KAClB;IACD,YAAY,EAAE;QACZ,IAAI,EAAE,QAAQ;QACd,KAAK,EAAE,wBAAwB;QAC/B,WAAW,EAAE,uCAAuC;QACpD,UAAU,EAAE;YACV,UAAU,EAAE;gBACV;oBACE,QAAQ,EAAE,WAAW;oBACrB,QAAQ,EAAE,IAAI;oBACd,KAAK,EAAE,QAAQ;iBAChB;aACF;SACF;KACF;IACD,kBAAkB,EAAE;QAClB,IAAI,EAAE,QAAQ;QACd,KAAK,EAAE,sBAAsB;QAC7B,WAAW,EAAE,qCAAqC;QAClD,UAAU,EAAE;YACV,UAAU,EAAE;gBACV;oBACE,QAAQ,EAAE,WAAW;oBACrB,QAAQ,EAAE,IAAI;oBACd,KAAK,EAAE,UAAU;iBAClB;aACF;SACF;QACD,OAAO,EAAE,6CAA4B;KACtC;CACF,CAAA;AAEY,QAAA,mBAAmB,GAAgI;IAC9J,YAAY,EAAE;QACZ,IAAI,EAAE,QAAQ;QACd,KAAK,EAAE,eAAe;QACtB,WAAW,EAAE,oEAAoE;QACjF,QAAQ,EAAE,IAAI;KACf;IACD,UAAU,EAAE;QACV,IAAI,EAAE,QAAQ;QACd,KAAK,EAAE,aAAa;QACpB,WAAW,EAAE,qCAAqC;QAClD,QAAQ,EAAE,IAAI;KACf;CACF,CAAA"}

package/dist/destinations/facebook-custom-audiences/sync/functions.d.ts

@@ -0,0 +1,33 @@
+import { Payload } from './generated-types';
+import { RequestClient, MultiStatusResponse, ErrorCodes, Features } from '@segment/actions-core';
+import type { JSONLikeObject, AudienceMembership } from '@segment/actions-core';
+import { StatsContext } from '@segment/actions-core/destination-kit';
+import { PayloadMap, AudienceJSON, FacebookDataRow } from './types';
+export declare function send(request: RequestClient, payloads: Payload[], isBatch: boolean, audienceMemberships?: AudienceMembership[], hookOutputs?: {
+    retlOnMappingSave?: {
+        outputs?: {
+            audienceId?: string;
+        };
+    };
+}, features?: Features, statsContext?: StatsContext): Promise<MultiStatusResponse | void>;
+export declare function sendRequest(request: RequestClient, audienceId: string, map: PayloadMap, msResponse: MultiStatusResponse, method: 'POST' | 'DELETE', isBatch: boolean, features?: Features, statsContext?: StatsContext): Promise<void>;
+export declare function setErrorResponse(msResponse: MultiStatusResponse, payload: Payload, status: number, index: number, isBatch: boolean, errormessage: string, errortype: keyof typeof ErrorCodes | string, sent?: JSONLikeObject): void;
+export declare function returnErrorResponse(msResponse: MultiStatusResponse, payloads: Payload[], isBatch: boolean, errormessage: string, errortype: keyof typeof ErrorCodes): MultiStatusResponse;
+export declare function getAudienceId(payload: Payload, hookOutputs?: {
+    retlOnMappingSave?: {
+        outputs?: {
+            audienceId?: string;
+        };
+    };
+}): string;
+export declare function getJSON(payloads: Payload[]): AudienceJSON;
+export declare function validate(payloads: Payload[], audienceId: unknown, audienceMemberships?: AudienceMembership[]): string | undefined;
+export declare function getData(payloads: Payload[]): FacebookDataRow[];
+export declare function normalizePhone(value: string): string;
+export declare function normalizeGender(value: string): string;
+export declare function normalizeMonth(value: string): string;
+export declare function normalizeName(value: string): string;
+export declare function normalizeCity(value: string): string;
+export declare function normalizeState(value: string): string;
+export declare function normalizeZip(value: string): string;
+export declare function normalizeCountry(value: string): string;

package/dist/destinations/facebook-custom-audiences/sync/functions.js

@@ -0,0 +1,245 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.send = send;
+exports.sendRequest = sendRequest;
+exports.setErrorResponse = setErrorResponse;
+exports.returnErrorResponse = returnErrorResponse;
+exports.getAudienceId = getAudienceId;
+exports.getJSON = getJSON;
+exports.validate = validate;
+exports.getData = getData;
+exports.normalizePhone = normalizePhone;
+exports.normalizeGender = normalizeGender;
+exports.normalizeMonth = normalizeMonth;
+exports.normalizeName = normalizeName;
+exports.normalizeCity = normalizeCity;
+exports.normalizeState = normalizeState;
+exports.normalizeZip = normalizeZip;
+exports.normalizeCountry = normalizeCountry;
+const constants_1 = require("./constants");
+const actions_core_1 = require("@segment/actions-core");
+const hashing_utils_1 = require("../../../lib/hashing-utils");
+const constants_2 = require("../constants");
+const functions_1 = require("../functions");
+async function send(request, payloads, isBatch, audienceMemberships, hookOutputs, features, statsContext) {
+    const msResponse = new actions_core_1.MultiStatusResponse();
+    const audienceId = getAudienceId(payloads[0], hookOutputs);
+    const errorMessage = validate(payloads, audienceId, audienceMemberships);
+    if (errorMessage) {
+        return returnErrorResponse(msResponse, payloads, isBatch, errorMessage, actions_core_1.ErrorCodes.PAYLOAD_VALIDATION_FAILED);
+    }
+    const addMap = new Map();
+    const deleteMap = new Map();
+    payloads.forEach((payload, index) => {
+        const audienceMembership = audienceMemberships?.[index];
+        if (audienceMembership === false) {
+            deleteMap.set(index, payload);
+        }
+        else if (audienceMembership === true) {
+            addMap.set(index, payload);
+        }
+        else if (audienceMembership === undefined) {
+            setErrorResponse(msResponse, payload, 400, index, isBatch, "Audience membership details missing", actions_core_1.ErrorCodes.PAYLOAD_VALIDATION_FAILED);
+        }
+    });
+    const requests = [];
+    if (addMap.size > 0) {
+        requests.push(sendRequest(request, audienceId, addMap, msResponse, 'POST', isBatch, features, statsContext));
+    }
+    if (deleteMap.size > 0) {
+        requests.push(sendRequest(request, audienceId, deleteMap, msResponse, 'DELETE', isBatch, features, statsContext));
+    }
+    await Promise.all(requests);
+    if (isBatch) {
+        return msResponse;
+    }
+}
+async function sendRequest(request, audienceId, map, msResponse, method, isBatch, features, statsContext) {
+    const indices = Array.from(map.keys());
+    const payloads = Array.from(map.values());
+    const json = getJSON(payloads);
+    try {
+        await request(`${constants_2.BASE_URL}/${(0, functions_1.getApiVersion)(features, statsContext)}/${audienceId}/users`, {
+            method,
+            json
+        });
+        for (let i = 0; i < indices.length; i++) {
+            const originalIndex = indices[i];
+            msResponse.setSuccessResponseAtIndex(originalIndex, {
+                status: 200,
+                body: payloads[i],
+                sent: {
+                    data: json.payload.data[i],
+                    method,
+                    audienceId
+                }
+            });
+        }
+    }
+    catch (error) {
+        const { message, code, status } = (0, functions_1.parseFacebookError)(error);
+        for (let i = 0; i < indices.length; i++) {
+            const sent = {
+                data: json.payload.data[i],
+                method,
+                audienceId
+            };
+            setErrorResponse(msResponse, payloads[i], status, indices[i], isBatch, message, code, sent);
+        }
+    }
+}
+function setErrorResponse(msResponse, payload, status, index, isBatch, errormessage, errortype, sent) {
+    if (!isBatch) {
+        if (errortype === actions_core_1.ErrorCodes.PAYLOAD_VALIDATION_FAILED) {
+            throw new actions_core_1.PayloadValidationError(errormessage);
+        }
+        throw new actions_core_1.IntegrationError(errormessage, errortype, status);
+    }
+    msResponse.setErrorResponseAtIndex(index, {
+        status,
+        errortype: errortype,
+        errormessage,
+        body: payload,
+        ...(sent ? { sent } : {})
+    });
+}
+function returnErrorResponse(msResponse, payloads, isBatch, errormessage, errortype) {
+    payloads.forEach((payload, i) => {
+        setErrorResponse(msResponse, payload, 400, i, isBatch, errormessage, errortype);
+    });
+    return msResponse;
+}
+function getAudienceId(payload, hookOutputs) {
+    const { retlOnMappingSave: { outputs: { audienceId: hookAudienceId = undefined } = {} } = {} } = hookOutputs ?? {};
+    const { external_audience_id: payloadAudienceId } = payload;
+    return (hookAudienceId ?? payloadAudienceId);
+}
+function getJSON(payloads) {
+    const data = getData(payloads);
+    const app_ids = [];
+    const page_ids = [];
+    const ig_account_ids = [];
+    payloads.forEach((payload) => {
+        const { appId, pageId, igAccountIds } = payload;
+        app_ids.push(typeof appId === 'string' && appId ? appId : '');
+        page_ids.push(typeof pageId === 'string' && pageId ? pageId : '');
+        ig_account_ids.push(typeof igAccountIds === 'string' && igAccountIds ? igAccountIds : '');
+    });
+    return {
+        payload: {
+            schema: constants_1.SCHEMA_PROPERTIES,
+            data,
+            ...(app_ids?.some((id) => id?.trim() !== '') ? { app_ids } : {}),
+            ...(page_ids?.some((id) => id?.trim() !== '') ? { page_ids } : {}),
+            ...(ig_account_ids?.some((id) => id?.trim() !== '') ? { ig_account_ids } : {})
+        }
+    };
+}
+function validate(payloads, audienceId, audienceMemberships) {
+    if (!Array.isArray(audienceMemberships)) {
+        return 'Audience membership details for batch missing.';
+    }
+    if (Array.isArray(audienceMemberships) && audienceMemberships.length !== payloads.length) {
+        return 'Audience membership details count does not match batch payload count.';
+    }
+    if (!audienceId || typeof audienceId !== 'string') {
+        return 'Missing audience ID.';
+    }
+}
+function getData(payloads) {
+    const data = new Array(payloads.length);
+    payloads.forEach((payload, index) => {
+        const { externalId, email, phone, birth: { year, month, day } = {}, name: { last, first, firstInitial } = {}, gender, city, state, zip, country, mobileAdId } = payload;
+        const row = [
+            externalId ?? '',
+            email ? (0, hashing_utils_1.processHashing)(email.trim().toLowerCase(), 'sha256', 'hex') : '',
+            phone ? (0, hashing_utils_1.processHashing)(phone, 'sha256', 'hex', normalizePhone) ?? '' : '',
+            year ? (0, hashing_utils_1.processHashing)(year.trim(), 'sha256', 'hex') ?? '' : '',
+            month ? (0, hashing_utils_1.processHashing)(normalizeMonth(month), 'sha256', 'hex') ?? '' : '',
+            day ? (0, hashing_utils_1.processHashing)(day.trim(), 'sha256', 'hex') ?? '' : '',
+            last ? (0, hashing_utils_1.processHashing)(normalizeName(last), 'sha256', 'hex') ?? '' : '',
+            first ? (0, hashing_utils_1.processHashing)(normalizeName(first), 'sha256', 'hex') ?? '' : '',
+            firstInitial ? (0, hashing_utils_1.processHashing)(firstInitial.trim().toLowerCase(), 'sha256', 'hex') ?? '' : '',
+            gender ? (0, hashing_utils_1.processHashing)(normalizeGender(gender), 'sha256', 'hex') ?? '' : '',
+            city ? (0, hashing_utils_1.processHashing)(normalizeCity(city), 'sha256', 'hex') ?? '' : '',
+            state ? (0, hashing_utils_1.processHashing)(normalizeState(state), 'sha256', 'hex') ?? '' : '',
+            zip ? (0, hashing_utils_1.processHashing)(normalizeZip(zip), 'sha256', 'hex') ?? '' : '',
+            country ? (0, hashing_utils_1.processHashing)(normalizeCountry(country), 'sha256', 'hex') ?? '' : '',
+            mobileAdId ?? ''
+        ];
+        data[index] = row;
+    });
+    return data;
+}
+function normalizePhone(value) {
+    const removedNonNumveric = value.replace(/\D/g, '');
+    return removedNonNumveric.replace(/^0+/, '');
+}
+function normalizeGender(value) {
+    const lowerCaseValue = value.toLowerCase().trim();
+    if (['male', 'boy', 'm'].includes(lowerCaseValue))
+        return 'm';
+    if (['female', 'woman', 'girl', 'f'].includes(lowerCaseValue))
+        return 'f';
+    return value;
+}
+function normalizeMonth(value) {
+    const normalizedValue = value.replace(/\s/g, '').trim();
+    if (normalizedValue.length === 2 && typeof Number(normalizedValue) === 'number') {
+        return normalizedValue;
+    }
+    const lowerCaseValue = value.trim().toLowerCase();
+    const months = [
+        'january',
+        'february',
+        'march',
+        'april',
+        'may',
+        'june',
+        'july',
+        'august',
+        'september',
+        'october',
+        'november',
+        'december'
+    ];
+    const monthIndex = months.indexOf(lowerCaseValue);
+    if (monthIndex === -1) {
+        return value;
+    }
+    if (monthIndex < 9) {
+        return `0${monthIndex + 1}`;
+    }
+    return `${monthIndex + 1}`;
+}
+function normalizeName(value) {
+    return value.trim().toLowerCase().replace(/\p{P}/gu, '');
+}
+function normalizeCity(value) {
+    return value
+        .trim()
+        .replace(/[\s\W_]/g, '')
+        .toLowerCase();
+}
+function normalizeState(value) {
+    if (constants_1.US_STATE_CODES.has(value.toLowerCase().trim())) {
+        return constants_1.US_STATE_CODES.get(value.toLowerCase().trim());
+    }
+    return value
+        .trim()
+        .replace(/[\s\W_]/g, '')
+        .toLowerCase();
+}
+function normalizeZip(value) {
+    if (value.includes('-')) {
+        return value.split('-')[0];
+    }
+    return value.trim().replace(/\s/g, '').toLowerCase();
+}
+function normalizeCountry(value) {
+    return value
+        .trim()
+        .replace(/[\s\W_]/g, '')
+        .toLowerCase();
+}
+//# sourceMappingURL=functions.js.map