@devrev/ts-adaas 1.2.2 → 1.2.3

package/README.md

@@ -2,6 +2,13 @@
 
 ## Release Notes
 
+### v1.2.3
+
+- Add `local` flag to use for local development of the ADaaS snap-ins.
+- Send library version, snap-in version and snap-in slug in headers while emitting.
+- Make `actor_id` field optional for `SsorAttachment` interface.
+- Fix bugs related to event handling, error logging.
+
 ### v1.2.2
 
 - Add library version as a part of control protocol.

package/dist/common/constants.d.ts

@@ -10,3 +10,4 @@ export declare const AIRDROP_DEFAULT_ITEM_TYPES: {
     ATTACHMENTS: string;
     SSOR_ATTACHMENT: string;
 };
+export declare const LIBRARY_VERSION: any;

package/dist/common/constants.js

@@ -1,7 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.AIRDROP_DEFAULT_ITEM_TYPES = exports.MAX_DEVREV_ARTIFACT_SIZE = exports.ARTIFACT_BATCH_SIZE = exports.ALLOWED_EVENT_TYPES = exports.ALLOWED_LOADING_EVENT_TYPES = exports.ALLOWED_EXTRACTION_EVENT_TYPES = exports.STATELESS_EVENT_TYPES = void 0;
+exports.LIBRARY_VERSION = exports.AIRDROP_DEFAULT_ITEM_TYPES = exports.MAX_DEVREV_ARTIFACT_SIZE = exports.ARTIFACT_BATCH_SIZE = exports.ALLOWED_EVENT_TYPES = exports.ALLOWED_LOADING_EVENT_TYPES = exports.ALLOWED_EXTRACTION_EVENT_TYPES = exports.STATELESS_EVENT_TYPES = void 0;
 const extraction_1 = require("../types/extraction");
+const helpers_1 = require("./helpers");
 exports.STATELESS_EVENT_TYPES = [
     extraction_1.EventType.ExtractionExternalSyncUnitsStart,
     extraction_1.EventType.ExtractionMetadataStart,
@@ -37,3 +38,4 @@ exports.AIRDROP_DEFAULT_ITEM_TYPES = {
     ATTACHMENTS: 'attachments',
     SSOR_ATTACHMENT: 'ssor_attachment',
 };
+exports.LIBRARY_VERSION = (0, helpers_1.getLibraryVersion)();

package/dist/common/control-protocol.js

@@ -2,14 +2,14 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.emit = void 0;
 const axios_client_1 = require("../http/axios-client");
-const helpers_1 = require("./helpers");
+const constants_1 = require("./constants");
 const emit = async ({ event, eventType, data, }) => {
     const newEvent = {
         event_type: eventType,
         event_context: event.payload.event_context,
         event_data: Object.assign({}, data),
         worker_metadata: {
-            adaas_library_version: (0, helpers_1.getLibraryVersion)(),
+            adaas_library_version: constants_1.LIBRARY_VERSION,
         },
     };
     console.info('Emitting event', JSON.stringify(newEvent));
@@ -18,6 +18,9 @@ const emit = async ({ event, eventType, data, }) => {
             Accept: 'application/json, text/plain, */*',
             Authorization: event.context.secrets.service_account_token,
             'Content-Type': 'application/json',
+            'X-DevRev-Client-Platform': event.payload.event_context.snap_in_slug,
+            'X-DevRev-Client-Id': event.payload.event_context.snap_in_version_id,
+            'X-DevRev-Client-Version': constants_1.LIBRARY_VERSION,
         },
     });
 };

package/dist/common/helpers.js

@@ -80,6 +80,11 @@ function getTimeoutErrorEventType(eventType) {
             return {
                 eventType: loading_1.LoaderEventType.LoaderStateDeletionError,
             };
+        case extraction_1.EventType.StartLoadingAttachments:
+        case extraction_1.EventType.ContinueLoadingAttachments:
+            return {
+                eventType: loading_1.LoaderEventType.AttachmentLoadingError,
+            };
         case extraction_1.EventType.StartDeletingLoaderAttachmentState:
             return {
                 eventType: loading_1.LoaderEventType.LoaderAttachmentStateDeletionError,
@@ -160,7 +165,11 @@ function getCircularReplacer() {
 function getLibraryVersion() {
     var _a;
     try {
-        return (_a = JSON.parse((0, fs_1.readFileSync)(path.resolve(__dirname, '../../package.json'), 'utf8'))) === null || _a === void 0 ? void 0 : _a.version;
+        const version = (_a = JSON.parse((0, fs_1.readFileSync)(path.resolve(__dirname, '../../package.json'), 'utf8'))) === null || _a === void 0 ? void 0 : _a.version;
+        if (version) {
+            return version;
+        }
+        return '';
     }
     catch (error) {
         console.error('Error reading adaas library version from package.json', error);

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

@@ -34,8 +34,8 @@ export interface NormalizedAttachment {
     url: string;
     id: string;
     file_name: string;
-    author_id: string;
     parent_id: string;
+    author_id?: string;
     grand_parent_id?: number;
 }
 /**

package/dist/tests/test-helpers.js

@@ -31,6 +31,7 @@ function createEvent({ eventType, externalSyncUnits = [], progress, error, delay
                 mode: 'test_mode',
                 request_id: 'test_request_id',
                 snap_in_slug: 'test_snap_in_slug',
+                snap_in_version_id: 'test_snap_in_version_id',
                 sync_run: 'test_sync_run',
                 sync_run_id: 'test_sync_run_id',
                 sync_tier: 'test_sync_tier',

package/dist/types/extraction.d.ts

@@ -131,6 +131,7 @@ export interface EventContext {
     mode: string;
     request_id: string;
     snap_in_slug: string;
+    snap_in_version_id: string;
     sync_run: string;
     sync_run_id: string;
     sync_tier: string;

package/dist/uploader/uploader.interfaces.d.ts

@@ -58,7 +58,7 @@ export interface SsorAttachment {
     parent_id: {
         external: string;
     };
-    actor_id: {
+    actor_id?: {
         external: string;
     };
 }

package/dist/workers/create-worker.js

@@ -16,7 +16,7 @@ async function createWorker(workerData) {
                 workerData,
             });
             worker.on(workers_1.WorkerEvent.WorkerError, (error) => {
-                logger.error('Worker error', (0, logger_1.serializeError)(error));
+                logger.error('Worker error', error);
                 reject();
             });
             worker.on(workers_1.WorkerEvent.WorkerOnline, () => {

package/dist/workers/spawn.js

@@ -6,9 +6,11 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Spawn = void 0;
 exports.spawn = spawn;
 const axios_1 = __importDefault(require("axios"));
+const helpers_1 = require("yargs/helpers");
+const yargs_1 = __importDefault(require("yargs"));
 const extraction_1 = require("../types/extraction");
 const control_protocol_1 = require("../common/control-protocol");
-const helpers_1 = require("../common/helpers");
+const helpers_2 = require("../common/helpers");
 const logger_1 = require("../logger/logger");
 const workers_1 = require("../types/workers");
 const create_worker_1 = require("./create-worker");
@@ -75,6 +77,14 @@ async function spawn({ event, initialState, workerPath, options, }) {
         event,
         connectorWorkerPath: workerPath,
     });
+    if (options === null || options === void 0 ? void 0 : options.isLocalDevelopment) {
+        logger.warn('WARN: isLocalDevelopment is deprecated. Please use the -- local flag instead.');
+    }
+    // read the command line arguments to check if the local flag is passed
+    const argv = await (0, yargs_1.default)((0, helpers_1.hideBin)(process.argv)).argv;
+    if (argv._.includes('local')) {
+        options = Object.assign(Object.assign({}, (options || {})), { isLocalDevelopment: true });
+    }
     if (script) {
         try {
             const worker = await (0, create_worker_1.createWorker)({
@@ -181,7 +191,7 @@ class Spawn {
             return;
         }
         this.alreadyEmitted = true;
-        const timeoutEventType = (0, helpers_1.getTimeoutErrorEventType)(this.event.payload.event_type);
+        const timeoutEventType = (0, helpers_2.getTimeoutErrorEventType)(this.event.payload.event_type);
         if (timeoutEventType) {
             const { eventType } = timeoutEventType;
             try {

package/dist/workers/worker-adapter.js

@@ -529,10 +529,12 @@ class WorkerAdapter {
                 parent_id: {
                     external: attachment.parent_id,
                 },
-                actor_id: {
-                    external: attachment.author_id,
-                },
             };
+            if (attachment.author_id) {
+                ssorAttachment.actor_id = {
+                    external: attachment.author_id,
+                };
+            }
             await ((_b = this.getRepo('ssor_attachment')) === null || _b === void 0 ? void 0 : _b.push([ssorAttachment]));
         }
         return;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@devrev/ts-adaas",
-  "version": "1.2.2",
+  "version": "1.2.3",
   "description": "DevRev ADaaS (AirDrop-as-a-Service) Typescript SDK.",
   "type": "commonjs",
   "main": "./dist/index.js",
@@ -26,6 +26,7 @@
     "@types/jest": "^29.5.12",
     "@types/lambda-log": "^3.0.3",
     "@types/node": "20.16.11",
+    "@types/yargs": "^17.0.33",
     "@typescript-eslint/eslint-plugin": "^7.12.0",
     "@typescript-eslint/parser": "^7.12.0",
     "eslint": "^8.57.0",
@@ -42,7 +43,8 @@
     "form-data": "^4.0.1",
     "js-jsonl": "^1.1.1",
     "lambda-log": "^3.1.0",
-    "ts-node": "^10.9.2"
+    "ts-node": "^10.9.2",
+    "yargs": "^17.7.2"
   },
   "files": [
     "dist"