@devrev/ts-adaas 0.0.2 → 1.0.0

package/dist/src/common/helpers.js

@@ -1,59 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getTimeoutExtractorEventType = exports.createArtifact = exports.createFormData = void 0;
-const js_jsonl_1 = require("js-jsonl");
-const types_1 = require("../types");
-function createFormData(
-//eslint-disable-next-line @typescript-eslint/no-explicit-any
-preparedArtifact, fetchedObjects) {
-    const formData = new FormData();
-    for (const item of preparedArtifact.form_data) {
-        formData.append(item.key, item.value);
-    }
-    const output = js_jsonl_1.jsonl.stringify(fetchedObjects);
-    formData.append('file', output);
-    return formData;
-}
-exports.createFormData = createFormData;
-function createArtifact(
-//eslint-disable-next-line @typescript-eslint/no-explicit-any
-preparedArtifact, fetchedObjects, entity) {
-    const itemCount = Array.isArray(fetchedObjects) ? fetchedObjects.length : 1;
-    return {
-        item_count: itemCount,
-        id: preparedArtifact.id,
-        item_type: entity,
-    };
-}
-exports.createArtifact = createArtifact;
-function getTimeoutExtractorEventType(eventType) {
-    switch (eventType) {
-        case types_1.EventType.ExtractionMetadataStart:
-            return {
-                eventType: types_1.ExtractorEventType.ExtractionMetadataError,
-                isError: true,
-            };
-        case types_1.EventType.ExtractionDataStart:
-        case types_1.EventType.ExtractionDataContinue:
-            return {
-                eventType: types_1.ExtractorEventType.ExtractionDataProgress,
-                isError: false,
-            };
-        case types_1.EventType.ExtractionAttachmentsStart:
-        case types_1.EventType.ExtractionAttachmentsContinue:
-            return {
-                eventType: types_1.ExtractorEventType.ExtractionAttachmentsProgress,
-                isError: false,
-            };
-        case types_1.EventType.ExtractionExternalSyncUnitsStart:
-            return {
-                eventType: types_1.ExtractorEventType.ExtractionExternalSyncUnitsError,
-                isError: true,
-            };
-        default:
-            console.log('Event type not recognized in getTimeoutExtractorEventType function: ' +
-                eventType);
-            return null;
-    }
-}
-exports.getTimeoutExtractorEventType = getTimeoutExtractorEventType;

package/dist/src/demo-extractor/index.d.ts

@@ -1,11 +0,0 @@
-import { AirdropEvent } from '../types';
-import { Adapter } from '../adapter';
-type ExtractorState = object;
-export declare class DemoExtractor {
-    private event;
-    private adapter;
-    private uploader;
-    constructor(event: AirdropEvent, adapter: Adapter<ExtractorState>);
-    run(): Promise<void>;
-}
-export {};

package/dist/src/demo-extractor/index.js

@@ -1,157 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.DemoExtractor = void 0;
-const types_1 = require("../types");
-const uploader_1 = require("../uploader");
-const initial_domain_mapping_json_1 = __importDefault(require("./initial_domain_mapping.json"));
-class DemoExtractor {
-    constructor(event, adapter) {
-        this.event = event;
-        this.adapter = adapter;
-        this.uploader = new uploader_1.Uploader(this.event.execution_metadata.devrev_endpoint, this.event.context.secrets.service_account_token);
-    }
-    async run() {
-        switch (this.event.payload.event_type) {
-            case types_1.EventType.ExtractionExternalSyncUnitsStart: {
-                const externalSyncUnits = [
-                    {
-                        id: 'devrev',
-                        name: 'devrev',
-                        description: 'Demo external sync unit',
-                    },
-                ];
-                await this.adapter.emit(types_1.ExtractorEventType.ExtractionExternalSyncUnitsDone, {
-                    external_sync_units: externalSyncUnits,
-                });
-                break;
-            }
-            case types_1.EventType.ExtractionMetadataStart: {
-                const metadata = [
-                    {
-                        item: 'contacts',
-                        fields: ['id', 'name', 'lastName'],
-                    },
-                    {
-                        item: 'users',
-                        fields: ['id', 'name', 'lastName'],
-                    },
-                ];
-                const { artifact, error } = await this.uploader.upload('loopback_metadata_1.jsonl', 'metadata', metadata);
-                if (error || !artifact) {
-                    await this.adapter.emit(types_1.ExtractorEventType.ExtractionMetadataError, {
-                        error,
-                    });
-                    return;
-                }
-                const { artifact: recipe, error: recipeError } = await this.uploader.upload('recipe.json', 'initial_domain_mapping', initial_domain_mapping_json_1.default);
-                if (recipeError || !recipe) {
-                    await this.adapter.emit(types_1.ExtractorEventType.ExtractionMetadataError, {
-                        error: recipeError,
-                    });
-                    return;
-                }
-                await this.adapter.emit(types_1.ExtractorEventType.ExtractionMetadataDone, {
-                    progress: 50,
-                    artifacts: [artifact, recipe],
-                });
-                break;
-            }
-            case types_1.EventType.ExtractionDataStart: {
-                const contacts = [
-                    {
-                        id: 1,
-                        name: 'John',
-                        lastName: 'Doe',
-                    },
-                    {
-                        id: 2,
-                        name: 'Jane',
-                        lastName: 'Doe',
-                    },
-                ];
-                const { artifact, error } = await this.uploader.upload('loopback_contacts_1.json', 'contacts', contacts);
-                if (error || !artifact) {
-                    await this.adapter.emit(types_1.ExtractorEventType.ExtractionDataError, {
-                        error,
-                    });
-                    return;
-                }
-                await this.adapter.emit(types_1.ExtractorEventType.ExtractionDataProgress, {
-                    progress: 50,
-                    artifacts: [artifact],
-                });
-                break;
-            }
-            case types_1.EventType.ExtractionDataContinue: {
-                const users = [
-                    {
-                        id: 1,
-                        name: 'John',
-                        lastName: 'Phd',
-                    },
-                    {
-                        id: 2,
-                        name: 'Jane',
-                        lastName: 'Phd',
-                    },
-                ];
-                const { artifact, error } = await this.uploader.upload('loopback_users_1.json', 'users', users);
-                if (error || !artifact) {
-                    await this.adapter.emit(types_1.ExtractorEventType.ExtractionDataError, {
-                        error,
-                    });
-                    return;
-                }
-                await this.adapter.emit(types_1.ExtractorEventType.ExtractionDataDone, {
-                    progress: 100,
-                    artifacts: [artifact],
-                });
-                break;
-            }
-            case types_1.EventType.ExtractionDataDelete: {
-                await this.adapter.emit(types_1.ExtractorEventType.ExtractionDataDeleteDone);
-                break;
-            }
-            case types_1.EventType.ExtractionAttachmentsStart: {
-                const attachment1 = ['This is attachment1.txt content'];
-                const { artifact, error } = await this.uploader.upload('attachment1.txt', 'attachment', attachment1);
-                if (error || !artifact) {
-                    await this.adapter.emit(types_1.ExtractorEventType.ExtractionAttachmentsError, {
-                        error,
-                    });
-                    return;
-                }
-                await this.adapter.emit(types_1.ExtractorEventType.ExtractionAttachmentsProgress, {
-                    artifacts: [artifact],
-                });
-                break;
-            }
-            case types_1.EventType.ExtractionAttachmentsContinue: {
-                const attachment2 = ['This is attachment2.txt content'];
-                const { artifact, error } = await this.uploader.upload('attachment2.txt', 'attachment', attachment2);
-                if (error || !artifact) {
-                    await this.adapter.emit(types_1.ExtractorEventType.ExtractionAttachmentsError, {
-                        error,
-                    });
-                    return;
-                }
-                await this.adapter.emit(types_1.ExtractorEventType.ExtractionAttachmentsDone, {
-                    artifacts: [artifact],
-                });
-                break;
-            }
-            case types_1.EventType.ExtractionAttachmentsDelete: {
-                await this.adapter.emit(types_1.ExtractorEventType.ExtractionAttachmentsDeleteDone);
-                break;
-            }
-            default: {
-                console.error('Event in DemoExtractor run not recognized: ' +
-                    JSON.stringify(this.event.payload.event_type));
-            }
-        }
-    }
-}
-exports.DemoExtractor = DemoExtractor;

package/dist/src/demo-extractor/initial_domain_mapping.json

@@ -1,107 +0,0 @@
-{
-    "initial_object_mappings": [
-        {
-            "external_type": "contacts",
-            "possible_targets": {
-                "rev_user": {
-                    "initial_field_mappings": [
-                        {
-                            "destination_field": {
-                                "id": "id",
-                                "is_required": true
-                            },
-                            "selected_resolutions": ["id"],
-                            "resolutions": {
-                                "id": {
-                                    "source_field_description": {
-                                        "id": "id",
-                                        "is_required": true
-                                    }
-                                }
-                            },
-                            "is_finished": true
-                        },
-                        {
-                            "destination_field": {
-                                "id": "display_name",
-                                "is_required": true
-                            },
-                            "selected_resolutions": ["name"],
-                            "resolutions": {
-                                "name": {
-                                    "source_field_description": {
-                                        "id": "name",
-                                        "is_required": true
-                                    }
-                                }
-                            },
-                            "is_finished": true
-                        }
-                    ]
-                }
-            },
-            "default_target": "rev_user",
-            "allow_item_type_decisions": true
-        },
-        {
-            "external_type": "users",
-            "possible_targets": {
-                "dev_user": {
-                    "initial_field_mappings": [
-                        {
-                            "destination_field": {
-                                "id": "id",
-                                "is_required": true
-                            },
-                            "selected_resolutions": ["id"],
-                            "resolutions": {
-                                "id": {
-                                    "source_field_description": {
-                                        "id": "id",
-                                        "is_required": true
-                                    }
-                                }
-                            },
-                            "is_finished": true
-                        },
-                        {
-                            "destination_field": {
-                                "id": "display_name",
-                                "is_required": true
-                            },
-                            "selected_resolutions": ["name"],
-                            "resolutions": {
-                                "name": {
-                                    "source_field_description": {
-                                        "id": "name",
-                                        "is_required": true
-                                    }
-                                }
-                            },
-                            "is_finished": true
-                        }
-                    ]
-                }
-            },
-            "default_target": "dev_user",
-            "allow_item_type_decisions": true
-        },
-        {
-            "external_type": "tickets",
-            "possible_targets": {
-                "work.ticket": {}
-            },
-            "default_target": "work.ticket",
-            "allow_item_type_decisions": true
-        },
-        {
-            "external_type": "conversations",
-            "possible_targets": {
-                "comment": {}
-            },
-            "default_target": "comment",
-            "allow_item_type_decisions": true
-        }
-    ],
-    "external_system_short_name": "Freshdesk"
-}

package/dist/src/index.d.ts

@@ -1,5 +0,0 @@
-export * from './adapter';
-export * from './demo-extractor';
-export * from './uploader';
-export * from './types';
-export * from './http';

package/dist/src/index.js

@@ -1,21 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./adapter"), exports);
-__exportStar(require("./demo-extractor"), exports);
-__exportStar(require("./uploader"), exports);
-__exportStar(require("./types"), exports);
-__exportStar(require("./http"), exports);

package/dist/src/logging/index.d.ts

@@ -1,18 +0,0 @@
-import { AirdropEvent } from '../types';
-export declare enum LogLevel {
-    INFO = "info",
-    WARN = "warn",
-    ERROR = "error"
-}
-/**
- * Logger class to log messages based on the log level.
- * The log level can be set to one of the following:
- * - INFO
- * - WARN
- * - ERROR
- *
- * The log tags can be set to any key-value pair.
- */
-export declare class Logger {
-    static init(event: AirdropEvent): void;
-}

package/dist/src/logging/index.js

@@ -1,39 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Logger = exports.LogLevel = void 0;
-var LogLevel;
-(function (LogLevel) {
-    LogLevel["INFO"] = "info";
-    LogLevel["WARN"] = "warn";
-    LogLevel["ERROR"] = "error";
-})(LogLevel || (exports.LogLevel = LogLevel = {}));
-/**
- * Logger class to log messages based on the log level.
- * The log level can be set to one of the following:
- * - INFO
- * - WARN
- * - ERROR
- *
- * The log tags can be set to any key-value pair.
- */
-class Logger {
-    static init(event) {
-        const origLog = console.log;
-        console.log = (message) => {
-            origLog(`[${LogLevel.INFO.toUpperCase()}]: ${message}`, Object.assign({}, event.payload.event_context));
-        };
-        const origInfo = console.info;
-        console.info = (message) => {
-            origInfo(`[${LogLevel.INFO.toUpperCase()}]: ${message}`, Object.assign({}, event.payload.event_context));
-        };
-        const origWarn = console.warn;
-        console.warn = (message) => {
-            origWarn(`[${LogLevel.WARN.toUpperCase()}]: ${message}`, Object.assign({}, event.payload.event_context));
-        };
-        const origError = console.error;
-        console.error = (message) => {
-            origError(`[${LogLevel.ERROR.toUpperCase()}]: ${message}`, Object.assign({}, event.payload.event_context));
-        };
-    }
-}
-exports.Logger = Logger;

package/dist/src/state/index.d.ts

@@ -1,23 +0,0 @@
-import { AdapterState, AirdropEvent } from '../types';
-export declare function createAdapterState<ExtractorState>(event: AirdropEvent, initialState: ExtractorState): Promise<State<ExtractorState>>;
-export declare class State<ExtractorState> {
-    private _state;
-    private event;
-    private workerUrl;
-    private devrevToken;
-    constructor(event: AirdropEvent, initialState: ExtractorState);
-    get state(): AdapterState<ExtractorState>;
-    set state(value: AdapterState<ExtractorState>);
-    /**
-     *  Updates the state of the adapter.
-     *
-     * @param {object} state - The state to be updated
-     */
-    postState(state: AdapterState<ExtractorState>): Promise<void>;
-    /**
-     *  Fetches the state of the adapter.
-     *
-     * @return  The state of the adapter
-     */
-    fetchState(initialState: ExtractorState): Promise<AdapterState<ExtractorState> | unknown>;
-}

package/dist/src/state/index.js

@@ -1,111 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.State = exports.createAdapterState = void 0;
-const axios_1 = __importStar(require("axios"));
-const constants_1 = require("../common/constants");
-async function createAdapterState(event, initialState) {
-    const newInitialState = structuredClone(initialState);
-    const as = new State(event, newInitialState);
-    if (!constants_1.STATELESS_EVENT_TYPES.includes(event.payload.event_type)) {
-        console.log('Fetching state');
-        await as.fetchState(newInitialState);
-    }
-    return as;
-}
-exports.createAdapterState = createAdapterState;
-class State {
-    constructor(event, initialState) {
-        this._state = Object.assign({ lastSyncStarted: '', lastSuccessfulSyncStarted: '' }, initialState);
-        this.event = event;
-        this.workerUrl = event.payload.event_context.worker_data_url;
-        this.devrevToken = event.context.secrets.service_account_token;
-    }
-    get state() {
-        return this._state;
-    }
-    set state(value) {
-        this._state = value;
-    }
-    /**
-     *  Updates the state of the adapter.
-     *
-     * @param {object} state - The state to be updated
-     */
-    async postState(state) {
-        try {
-            await axios_1.default.post(this.workerUrl + '.update', {
-                state: JSON.stringify(state),
-            }, {
-                headers: {
-                    Authorization: this.devrevToken,
-                },
-                params: {
-                    sync_unit: this.event.payload.event_context.sync_unit_id,
-                },
-            });
-            this.state = state;
-            console.log('State updated successfully');
-        }
-        catch (error) {
-            console.error('Failed to update state, error:' + error);
-        }
-    }
-    /**
-     *  Fetches the state of the adapter.
-     *
-     * @return  The state of the adapter
-     */
-    async fetchState(initialState) {
-        var _a;
-        const state = Object.assign(Object.assign({}, initialState), { lastSyncStarted: '', lastSuccessfulSyncStarted: '' });
-        console.log('Fetching state with sync unit id: ' +
-            this.event.payload.event_context.sync_unit_id);
-        try {
-            const response = await axios_1.default.post(this.workerUrl + '.get', {}, {
-                headers: {
-                    Authorization: this.devrevToken,
-                },
-                params: {
-                    sync_unit: this.event.payload.event_context.sync_unit_id,
-                },
-            });
-            this.state = JSON.parse(response.data.state);
-            console.log('State fetched successfully');
-            return this.state;
-        }
-        catch (error) {
-            if ((0, axios_1.isAxiosError)(error) && ((_a = error.response) === null || _a === void 0 ? void 0 : _a.status) === 404) {
-                console.log('State not found, returning initial state');
-                this.state = state;
-                this.postState(this.state);
-                return this.state;
-            }
-            console.error('Failed to fetch state, error:' + error);
-            return error;
-        }
-    }
-}
-exports.State = State;

package/dist/src/types/common.d.ts

@@ -1,33 +0,0 @@
-export declare enum ErrorLevel {
-    Warning = "WARNING",
-    Error = "ERROR",
-    Info = "INFO"
-}
-export interface ErrorRecord {
-    message: string;
-}
-export interface LogRecord {
-    level: ErrorLevel;
-    message: string;
-}
-export interface Artifact {
-    id: string;
-    item_type: string;
-    item_count: number;
-}
-export interface ArtifactsPrepareResponse {
-    url: string;
-    id: string;
-    form_data: {
-        key: string;
-        value: string;
-    }[];
-}
-export interface AdapterUpdateParams {
-    artifact?: Artifact;
-    extractor_state?: object;
-}
-export interface UploadResponse {
-    artifact?: Artifact;
-    error?: ErrorRecord;
-}

package/dist/src/types/index.d.ts

@@ -1,2 +0,0 @@
-export * from './common';
-export * from './extraction';

package/dist/src/types/index.js

@@ -1,18 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./common"), exports);
-__exportStar(require("./extraction"), exports);

package/dist/tests/adapter.helpers.test.js

@@ -1,60 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const helpers_1 = require("../src/common/helpers");
-const types_1 = require("../src/types");
-describe('adapter.helpers.ts', () => {
-    it("should create a FormData object with the correct 'key' and 'value'", () => {
-        const preparedArtifact = {
-            form_data: [{ key: 'key', value: 'value' }],
-        };
-        const fetchedObjects = [{ key: 'value' }];
-        const formData = (0, helpers_1.createFormData)(preparedArtifact, fetchedObjects);
-        expect(formData).toBeInstanceOf(FormData);
-        expect(formData.get('key')).toBe('value');
-    });
-    it("should create a FormData object with the correct 'file' key", () => {
-        const preparedArtifact = {
-            form_data: [{ key: 'key', value: 'value' }],
-        };
-        const fetchedObjects = [{ key: 'value' }];
-        const formData = (0, helpers_1.createFormData)(preparedArtifact, fetchedObjects);
-        expect(formData.get('file')).toBeDefined();
-    });
-    it("should create an Artifact object with the correct 'item_count', 'id', and 'item_type'", () => {
-        const preparedArtifact = { id: 'id' };
-        const fetchedObjects = [{ key: 'value' }];
-        const entity = 'entity';
-        const artifact = (0, helpers_1.createArtifact)(preparedArtifact, fetchedObjects, entity);
-        expect(artifact).toEqual({
-            item_count: 1,
-            id: 'id',
-            item_type: 'entity',
-        });
-    });
-    it('should return the correct ExtractorEventType', () => {
-        expect((0, helpers_1.getTimeoutExtractorEventType)(types_1.EventType.ExtractionMetadataStart)).toStrictEqual({
-            eventType: types_1.ExtractorEventType.ExtractionMetadataError,
-            isError: true,
-        });
-        expect((0, helpers_1.getTimeoutExtractorEventType)(types_1.EventType.ExtractionDataStart)).toStrictEqual({
-            eventType: types_1.ExtractorEventType.ExtractionDataProgress,
-            isError: false,
-        });
-        expect((0, helpers_1.getTimeoutExtractorEventType)(types_1.EventType.ExtractionDataContinue)).toStrictEqual({
-            eventType: types_1.ExtractorEventType.ExtractionDataProgress,
-            isError: false,
-        });
-        expect((0, helpers_1.getTimeoutExtractorEventType)(types_1.EventType.ExtractionAttachmentsStart)).toStrictEqual({
-            eventType: types_1.ExtractorEventType.ExtractionAttachmentsProgress,
-            isError: false,
-        });
-        expect((0, helpers_1.getTimeoutExtractorEventType)(types_1.EventType.ExtractionAttachmentsContinue)).toStrictEqual({
-            eventType: types_1.ExtractorEventType.ExtractionAttachmentsProgress,
-            isError: false,
-        });
-        expect((0, helpers_1.getTimeoutExtractorEventType)(types_1.EventType.ExtractionExternalSyncUnitsStart)).toStrictEqual({
-            eventType: types_1.ExtractorEventType.ExtractionExternalSyncUnitsError,
-            isError: true,
-        });
-    });
-});