@devrev/ts-adaas 1.9.0-beta.1 → 1.10.0-beta.0

package/dist/mappers/mappers.interface.js

@@ -1,9 +1,48 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.SyncMapperRecordStatus = void 0;
+exports.SyncMapperRecordTargetType = exports.SyncMapperRecordStatus = void 0;
+/**
+ * Status of a sync mapper record indicating its operational state.
+ */
 var SyncMapperRecordStatus;
 (function (SyncMapperRecordStatus) {
+    /** The mapping is active and operational (default) */
     SyncMapperRecordStatus["OPERATIONAL"] = "operational";
+    /** The mapping was filtered out by user filter settings */
     SyncMapperRecordStatus["FILTERED"] = "filtered";
+    /**
+     * The external object should be ignored in sync operations.
+     * Use to prevent objects from being created or updated in DevRev.
+     */
     SyncMapperRecordStatus["IGNORED"] = "ignored";
 })(SyncMapperRecordStatus || (exports.SyncMapperRecordStatus = SyncMapperRecordStatus = {}));
+/**
+ * Types of DevRev entities that can be targets in sync mapper records.
+ */
+var SyncMapperRecordTargetType;
+(function (SyncMapperRecordTargetType) {
+    SyncMapperRecordTargetType["ACCESS_CONTROL_ENTRY"] = "access_control_entry";
+    SyncMapperRecordTargetType["ACCOUNT"] = "account";
+    SyncMapperRecordTargetType["AIRDROP_AUTHORIZATION_POLICY"] = "airdrop_authorization_policy";
+    SyncMapperRecordTargetType["AIRDROP_FIELD_AUTHORIZATION_POLICY"] = "airdrop_field_authorization_policy";
+    SyncMapperRecordTargetType["AIRDROP_PLATFORM_GROUP"] = "airdrop_platform_group";
+    SyncMapperRecordTargetType["ARTICLE"] = "article";
+    SyncMapperRecordTargetType["ARTIFACT"] = "artifact";
+    SyncMapperRecordTargetType["CHAT"] = "chat";
+    SyncMapperRecordTargetType["CONVERSATION"] = "conversation";
+    SyncMapperRecordTargetType["CUSTOM_OBJECT"] = "custom_object";
+    SyncMapperRecordTargetType["DIRECTORY"] = "directory";
+    SyncMapperRecordTargetType["GROUP"] = "group";
+    SyncMapperRecordTargetType["INCIDENT"] = "incident";
+    SyncMapperRecordTargetType["LINK"] = "link";
+    SyncMapperRecordTargetType["MEETING"] = "meeting";
+    SyncMapperRecordTargetType["OBJECT_MEMBER"] = "object_member";
+    SyncMapperRecordTargetType["PART"] = "part";
+    SyncMapperRecordTargetType["REV_ORG"] = "rev_org";
+    SyncMapperRecordTargetType["ROLE"] = "role";
+    SyncMapperRecordTargetType["ROLE_SET"] = "role_set";
+    SyncMapperRecordTargetType["TAG"] = "tag";
+    SyncMapperRecordTargetType["TIMELINE_COMMENT"] = "timeline_comment";
+    SyncMapperRecordTargetType["USER"] = "user";
+    SyncMapperRecordTargetType["WORK"] = "work";
+})(SyncMapperRecordTargetType || (exports.SyncMapperRecordTargetType = SyncMapperRecordTargetType = {}));

package/dist/mappers/mappers.js

@@ -2,11 +2,24 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Mappers = void 0;
 const axios_client_internal_1 = require("../http/axios-client-internal");
+/**
+ * Manages sync mapper records that link external system items to DevRev items.
+ *
+ * Used for tracking relationships between external and DevRev entities during sync operations.
+ */
 class Mappers {
     constructor({ event }) {
         this.devrevApiEndpoint = event.execution_metadata.devrev_endpoint;
         this.devrevApiToken = event.context.secrets.service_account_token;
     }
+    /**
+     * Retrieves a sync mapper record by DevRev ID.
+     *
+     * Used to find the mapping when you know the DevRev ID and want to find the external system ID.
+     *
+     * @param params - Query parameters of type MappersGetByTargetIdParams
+     * @returns Promise with response data containing the sync mapper record
+     */
     async getByTargetId(params) {
         const { sync_unit, target } = params;
         return axios_client_internal_1.axiosClient.get(`${this.devrevApiEndpoint}/internal/airdrop.sync-mapper-record.get-by-target`, {
@@ -16,6 +29,33 @@ class Mappers {
             params: { sync_unit, target },
         });
     }
+    /**
+     * Retrieves a sync mapper record by external system ID.
+     *
+     * Used to find the mapping when you know the external system ID and want to find the DevRev ID.
+     *
+     * @param params - Query parameters of type MappersGetByExternalIdParams
+     * @returns Promise with response data containing the sync mapper record
+     */
+    async getByExternalId(params) {
+        const { sync_unit, external_id, target_type } = params;
+        return axios_client_internal_1.axiosClient.get(`${this.devrevApiEndpoint}/internal/airdrop.sync-mapper-record.get-by-external-id`, {
+            headers: {
+                Authorization: this.devrevApiToken,
+            },
+            params: { sync_unit, external_id, target_type },
+        });
+    }
+    /**
+     * Creates a new sync mapper record to establish a relationship between external system
+     * entities and DevRev entities.
+     *
+     * This is called after importing an item from external system to DevRev to record
+     * the mapping for future synchronization operations.
+     *
+     * @param params - Creation parameters of type MappersCreateParams
+     * @returns Promise with response data containing the created sync mapper record
+     */
     async create(params) {
         return axios_client_internal_1.axiosClient.post(`${this.devrevApiEndpoint}/internal/airdrop.sync-mapper-record.create`, params, {
             headers: {
@@ -23,6 +63,15 @@ class Mappers {
             },
         });
     }
+    /**
+     * Updates an existing sync mapper record.
+     *
+     * Used to modify existing mappings when external system entities change or when
+     * additional DevRev entities need to be associated.
+     *
+     * @param params - Update parameters of type MappersUpdateParams
+     * @returns Promise with response data containing the updated sync mapper record
+     */
     async update(params) {
         return axios_client_internal_1.axiosClient.post(`${this.devrevApiEndpoint}/internal/airdrop.sync-mapper-record.update`, params, {
             headers: {

package/dist/mappers/mappers.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=mappers.test.d.ts.map

package/dist/mappers/mappers.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"mappers.test.d.ts","sourceRoot":"","sources":["../../src/mappers/mappers.test.ts"],"names":[],"mappings":""}

package/dist/mappers/mappers.test.js

@@ -0,0 +1,107 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const axios_client_internal_1 = require("../http/axios-client-internal");
+const mappers_1 = require("./mappers");
+const mappers_interface_1 = require("./mappers.interface");
+const test_helpers_1 = require("../tests/test-helpers");
+const extraction_1 = require("../types/extraction");
+// Mock the axios client
+jest.mock('../http/axios-client-internal');
+const mockAxiosClient = axios_client_internal_1.axiosClient;
+describe(mappers_1.Mappers.name, () => {
+    const apiEndpoint = 'test_devrev_endpoint';
+    const apiToken = 'test_service_token';
+    const syncUnit = 'test_sync_unit';
+    const targetId = 'test_target_id';
+    const externalId = 'test_external_id';
+    const id = 'test_id';
+    const externalIds = ['test_external_id'];
+    const targets = ['test_target_id'];
+    const mockEvent = (0, test_helpers_1.createEvent)({
+        eventType: extraction_1.EventType.ExtractionDataStart,
+        executionMetadataOverrides: { devrev_endpoint: apiEndpoint },
+        contextOverrides: {
+            secrets: { service_account_token: apiToken },
+        },
+    });
+    const mappers = new mappers_1.Mappers({ event: mockEvent });
+    beforeEach(() => {
+        jest.clearAllMocks();
+    });
+    it(`should call ${mappers.getByTargetId.name} with correct endpoint, headers and params`, async () => {
+        // Arrange
+        const params = {
+            sync_unit: syncUnit,
+            target: targetId,
+        };
+        mockAxiosClient.get.mockResolvedValue({ data: {} });
+        // Act
+        await mappers.getByTargetId(params);
+        // Assert
+        expect(mockAxiosClient.get).toHaveBeenCalledWith(`${apiEndpoint}/internal/airdrop.sync-mapper-record.get-by-target`, {
+            headers: {
+                Authorization: apiToken,
+            },
+            params: { sync_unit: syncUnit, target: targetId },
+        });
+    });
+    it(`should call ${mappers.getByExternalId.name} with correct endpoint, headers and params`, async () => {
+        // Arrange
+        const params = {
+            sync_unit: syncUnit,
+            external_id: externalId,
+            target_type: mappers_interface_1.SyncMapperRecordTargetType.USER,
+        };
+        mockAxiosClient.get.mockResolvedValue({ data: {} });
+        // Act
+        await mappers.getByExternalId(params);
+        // Assert
+        expect(mockAxiosClient.get).toHaveBeenCalledWith(`${apiEndpoint}/internal/airdrop.sync-mapper-record.get-by-external-id`, {
+            headers: {
+                Authorization: apiToken,
+            },
+            params: {
+                sync_unit: syncUnit,
+                external_id: externalId,
+                target_type: mappers_interface_1.SyncMapperRecordTargetType.USER,
+            },
+        });
+    });
+    it(`should call ${mappers.create.name} with correct endpoint, headers and data`, async () => {
+        // Arrange
+        const params = {
+            sync_unit: syncUnit,
+            external_ids: externalIds,
+            targets: targets,
+            status: mappers_interface_1.SyncMapperRecordStatus.OPERATIONAL,
+        };
+        mockAxiosClient.post.mockResolvedValue({ data: {} });
+        // Act
+        await mappers.create(params);
+        // Assert
+        expect(mockAxiosClient.post).toHaveBeenCalledWith(`${apiEndpoint}/internal/airdrop.sync-mapper-record.create`, params, {
+            headers: {
+                Authorization: apiToken,
+            },
+        });
+    });
+    it(`should call ${mappers.update.name} with correct endpoint, headers and data`, async () => {
+        // Arrange
+        const params = {
+            id: id,
+            sync_unit: syncUnit,
+            external_ids: { add: externalIds },
+            targets: { add: targets },
+            status: mappers_interface_1.SyncMapperRecordStatus.OPERATIONAL,
+        };
+        mockAxiosClient.post.mockResolvedValue({ data: {} });
+        // Act
+        await mappers.update(params);
+        // Assert
+        expect(mockAxiosClient.post).toHaveBeenCalledWith(`${apiEndpoint}/internal/airdrop.sync-mapper-record.update`, params, {
+            headers: {
+                Authorization: apiToken,
+            },
+        });
+    });
+});

package/dist/repo/repo.d.ts

@@ -13,3 +13,4 @@ export declare class Repo {
     upload(batch?: (NormalizedItem | NormalizedAttachment | Item)[]): Promise<void | ErrorRecord>;
     push(items: Item[]): Promise<boolean>;
 }
+//# sourceMappingURL=repo.d.ts.map

package/dist/repo/repo.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"repo.d.ts","sourceRoot":"","sources":["../../src/repo/repo.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAC9C,OAAO,EAAE,IAAI,EAAE,MAAM,yBAAyB,CAAC;AAI/C,OAAO,EACL,oBAAoB,EACpB,cAAc,EACd,oBAAoB,EACrB,MAAM,mBAAmB,CAAC;AAG3B,qBAAa,IAAI;IACf,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,OAAO,CAAC,KAAK,CAAmD;IAChE,OAAO,CAAC,SAAS,CAAC,CAAwD;IAC1E,OAAO,CAAC,QAAQ,CAAW;IAC3B,OAAO,CAAC,QAAQ,CAA+B;IAC/C,OAAO,CAAC,OAAO,CAAC,CAAuB;gBAE3B,EACV,KAAK,EACL,QAAQ,EACR,SAAS,EACT,QAAQ,EACR,OAAO,GACR,EAAE,oBAAoB;IASvB,QAAQ,IAAI,CAAC,cAAc,GAAG,oBAAoB,GAAG,IAAI,CAAC,EAAE;IAItD,MAAM,CACV,KAAK,CAAC,EAAE,CAAC,cAAc,GAAG,oBAAoB,GAAG,IAAI,CAAC,EAAE,GACvD,OAAO,CAAC,IAAI,GAAG,WAAW,CAAC;IAmCxB,IAAI,CAAC,KAAK,EAAE,IAAI,EAAE,GAAG,OAAO,CAAC,OAAO,CAAC;CAuC5C"}

package/dist/repo/repo.interfaces.d.ts

@@ -43,3 +43,4 @@ export interface NormalizedAttachment {
  * Item is an interface that defines the structure of an item.
  */
 export type Item = Record<string, any>;
+//# sourceMappingURL=repo.interfaces.d.ts.map

package/dist/repo/repo.interfaces.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"repo.interfaces.d.ts","sourceRoot":"","sources":["../../src/repo/repo.interfaces.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,iCAAiC,CAAC;AAE3D,OAAO,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AACnD,OAAO,EAAE,oBAAoB,EAAE,MAAM,kBAAkB,CAAC;AAExD;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,cAAc,GAAG,oBAAoB,CAAC;CACvE;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,KAAK,EAAE,YAAY,CAAC;IACpB,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,cAAc,GAAG,oBAAoB,CAAC;IACtE,QAAQ,EAAE,CAAC,QAAQ,EAAE,QAAQ,KAAK,IAAI,CAAC;IACvC,OAAO,CAAC,EAAE,oBAAoB,CAAC;CAChC;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,EAAE,EAAE,MAAM,CAAC;IACX,YAAY,EAAE,MAAM,CAAC;IACrB,aAAa,EAAE,MAAM,CAAC;IACtB,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,GAAG,EAAE,MAAM,CAAC;IACZ,EAAE,EAAE,MAAM,CAAC;IACX,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,MAAM,CAAC,EAAE,OAAO,CAAC;IAIjB,eAAe,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;CACnC;AAED;;GAEG;AAEH,MAAM,MAAM,IAAI,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC"}

package/dist/repo/repo.test.d.ts

@@ -1 +1,2 @@
 export {};
+//# sourceMappingURL=repo.test.d.ts.map

package/dist/repo/repo.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"repo.test.d.ts","sourceRoot":"","sources":["../../src/repo/repo.test.ts"],"names":[],"mappings":""}

package/dist/state/state.d.ts

@@ -27,3 +27,4 @@ export declare class State<ConnectorState> {
      */
     fetchState(): Promise<string>;
 }
+//# sourceMappingURL=state.d.ts.map

package/dist/state/state.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"state.d.ts","sourceRoot":"","sources":["../../src/state/state.ts"],"names":[],"mappings":"AAUA,OAAO,EACL,YAAY,EAIZ,cAAc,EACf,MAAM,oBAAoB,CAAC;AAE5B,wBAAsB,kBAAkB,CAAC,cAAc,EAAE,EACvD,KAAK,EACL,YAAY,EACZ,oBAAoB,EACpB,OAAO,GACR,EAAE,cAAc,CAAC,cAAc,CAAC,GAAG,OAAO,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC,CA0DjE;AAED,qBAAa,KAAK,CAAC,cAAc;IAC/B,OAAO,CAAC,MAAM,CAA+B;IAC7C,OAAO,CAAC,eAAe,CAAW;IAClC,OAAO,CAAC,SAAS,CAAS;IAC1B,OAAO,CAAC,WAAW,CAAS;IAC5B,OAAO,CAAC,UAAU,CAAS;IAC3B,OAAO,CAAC,SAAS,CAAS;gBAEd,EAAE,KAAK,EAAE,YAAY,EAAE,EAAE,cAAc,CAAC,cAAc,CAAC;IAenE,IAAI,KAAK,IAAI,YAAY,CAAC,cAAc,CAAC,CAExC;IAED,IAAI,KAAK,CAAC,KAAK,EAAE,YAAY,CAAC,cAAc,CAAC,EAE5C;IAED;;;;OAIG;IACG,IAAI,CAAC,YAAY,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC;IAoCvD;;;OAGG;IACG,SAAS,CAAC,KAAK,CAAC,EAAE,YAAY,CAAC,cAAc,CAAC;IAuCpD;;;OAGG;IACG,UAAU,IAAI,OAAO,CAAC,MAAM,CAAC;CAkBpC"}

package/dist/state/state.interfaces.d.ts

@@ -48,3 +48,4 @@ export declare const loadingSdkState: {
         filesToLoad: never[];
     };
 };
+//# sourceMappingURL=state.interfaces.d.ts.map

package/dist/state/state.interfaces.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"state.interfaces.d.ts","sourceRoot":"","sources":["../../src/state/state.interfaces.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AACnD,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAC9C,OAAO,EAAE,oBAAoB,EAAE,MAAM,kBAAkB,CAAC;AACxD,OAAO,EAAE,oBAAoB,EAAE,MAAM,iBAAiB,CAAC;AAEvD,MAAM,WAAW,QAAQ;IACvB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,yBAAyB,CAAC,EAAE,MAAM,CAAC;IACnC,QAAQ,CAAC,EAAE,QAAQ,CAAC;IACpB,UAAU,CAAC,EAAE,UAAU,CAAC;IACxB,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED;;;GAGG;AACH,MAAM,MAAM,YAAY,CAAC,cAAc,IAAI,cAAc,GAAG,QAAQ,CAAC;AAErE,MAAM,WAAW,QAAQ;IACvB,mBAAmB,EAAE;QACnB,WAAW,EAAE,MAAM,EAAE,CAAC;QACtB,aAAa,EAAE,MAAM,CAAC;QACtB,+BAA+B,CAAC,EAAE,MAAM,EAAE,CAAC;KAC5C,CAAC;CACH;AAED,MAAM,WAAW,UAAU;IACzB,WAAW,EAAE,UAAU,EAAE,CAAC;CAC3B;AAED,MAAM,WAAW,cAAc,CAAC,cAAc;IAC5C,KAAK,EAAE,YAAY,CAAC;IACpB,YAAY,EAAE,cAAc,CAAC;IAC7B,oBAAoB,CAAC,EAAE,oBAAoB,CAAC;IAC5C,OAAO,CAAC,EAAE,oBAAoB,CAAC;CAChC;AAED,eAAO,MAAM,kBAAkB;;;;;;;;;;;CAW9B,CAAC;AAEF,eAAO,MAAM,eAAe;;;;;CAK3B,CAAC"}

package/dist/state/state.test.d.ts

@@ -1 +1,2 @@
 export {};
+//# sourceMappingURL=state.test.d.ts.map

package/dist/state/state.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"state.test.d.ts","sourceRoot":"","sources":["../../src/state/state.test.ts"],"names":[],"mappings":""}

package/dist/tests/backwards-compatibility/backwards-compatibility.test.d.ts

@@ -0,0 +1,3 @@
+import { ApiConstructor, ApiFunction, ApiMethodSignature } from '@microsoft/api-extractor-model';
+export declare function checkFunctionCompatibility(newFunction: ApiFunction | ApiConstructor | ApiMethodSignature, currentFunction: ApiFunction | ApiConstructor | ApiMethodSignature): void;
+//# sourceMappingURL=backwards-compatibility.test.d.ts.map

package/dist/tests/backwards-compatibility/backwards-compatibility.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"backwards-compatibility.test.d.ts","sourceRoot":"","sources":["../../../src/tests/backwards-compatibility/backwards-compatibility.test.ts"],"names":[],"mappings":"AAGA,OAAO,EAEL,cAAc,EAGd,WAAW,EAEX,kBAAkB,EAKnB,MAAM,gCAAgC,CAAC;AAgBxC,wBAAgB,0BAA0B,CAAC,WAAW,EAAE,WAAW,GAAG,cAAc,GAAG,kBAAkB,EAAE,eAAe,EAAE,WAAW,GAAG,cAAc,GAAG,kBAAkB,QA8C5K"}