@devrev/airsync-sdk 2.0.0-beta.3 → 2.0.0-beta.5

package/dist/types/workers.d.ts

@@ -1,54 +1,27 @@
 import { Worker } from 'worker_threads';
 import type { LogLevel } from '../logger/logger.interfaces';
-import { BaseState } from '../state/base-state';
-import { BaseSdkState } from '../state/state.interfaces';
-import { BaseAdapter } from '../multithreading/adapters/base-adapter';
+import { BaseState } from '../state/state';
+import { ErrorRecord, InitialDomainMapping } from './common';
 import { AirSyncEvent, EventType, ExtractorEventType } from './extraction';
 import { LoaderEventType } from './loading';
-import { InitialDomainMapping } from './common';
-/**
- * WorkerAdapterInterface is the constructor parameter shape for an adapter.
- * @interface WorkerAdapterInterface
- * @constructor
- * @param {AirSyncEvent} event - The event object received from the platform
- * @param {BaseState} adapterState - The state instance for the adapter
- * @param {WorkerAdapterOptions} options - The options to create a new adapter
- */
-export interface WorkerAdapterInterface<ConnectorState, StateClass extends BaseState<ConnectorState, BaseSdkState>> {
+export interface WorkerAdapterInterface<ConnectorState> {
     event: AirSyncEvent;
-    adapterState: StateClass;
+    adapterState: BaseState<ConnectorState>;
     options?: WorkerAdapterOptions;
 }
-/**
- * ExtractionScope represents the parsed extraction scope from the platform.
- * Each key is an item type name, and the value indicates whether it should be extracted.
- */
+/** Parsed extraction scope from the platform, keyed by item type name. */
 export type ExtractionScope = Record<string, {
     extract: boolean;
 }>;
-/**
- * WorkerAdapterOptions represents the options for WorkerAdapter class.
- * @interface WorkerAdapterOptions
- * @constructor
- * @param {boolean=} isLocalDevelopment - A flag to indicate if the adapter is being used in local development
- * @param {number=} timeout - The timeout for the worker thread
- * @param {number=} batchSize - Maximum number of extracted items in a batch
- * @param {Record<EventType, string>=} workerPathOverrides - A map of event types to custom worker paths to override default worker paths
- */
 export interface WorkerAdapterOptions {
     isLocalDevelopment?: boolean;
+    /** Worker thread timeout. */
     timeout?: number;
+    /** Maximum number of extracted items in a batch. */
     batchSize?: number;
     workerPathOverrides?: WorkerPathOverrides;
     skipConfirmation?: boolean;
 }
-/**
- * SpawnInterface is an interface for Spawn class.
- * @interface SpawnInterface
- * @constructor
- * @param {AirSyncEvent} event - The event object received from the platform
- * @param {Worker} worker - The worker thread
- */
 export interface SpawnInterface {
     event: AirSyncEvent;
     worker: Worker;
@@ -56,108 +29,85 @@ export interface SpawnInterface {
     resolve: (value: void | PromiseLike<void>) => void;
     originalConsole?: Console;
 }
-/**
- * SpawnFactoryInterface is an interface for Spawn class factory.
- * Spawn class is responsible for spawning a new worker thread and managing the lifecycle of the worker.
- * The class provides utilities to emit control events to the platform and exit the worker gracefully.
- * In case of lambda timeout, the class emits a lambda timeout event to the platform.
- * @interface SpawnFactoryInterface
- * @constructor
- * @param {AirSyncEvent} event - The event object received from the platform
- * @param {object=} initialState - The initial state of the adapter
- * @param {string} initialDomainMapping - The initial domain mapping
- * @param {WorkerAdapterOptions} options - The options to create a new instance of Spawn class
- * @param {string=} baseWorkerPath - The base path for the worker files, usually `__dirname`
- */
 export interface SpawnFactoryInterface<ConnectorState> {
     event: AirSyncEvent;
     initialState: ConnectorState;
     options?: WorkerAdapterOptions;
     initialDomainMapping?: InitialDomainMapping;
+    /** Base path for the worker files, usually `__dirname`. */
     baseWorkerPath?: string;
 }
 /**
- * TaskAdapterInterface is the parameter shape passed to a task callback.
- * @interface TaskAdapterInterface
- * @constructor
- * @param {BaseAdapter} adapter - The adapter object
- */
-export interface TaskAdapterInterface<Adapter extends BaseAdapter<unknown, BaseState<unknown, BaseSdkState>>> {
+ * Returned by a worker's `task`/`onTimeout` callback; the SDK (never the connector)
+ * maps it to the phase-appropriate platform event and emits it exactly once.
+ * One invocation = one worker = one emitted event; continuation happens in a
+ * fresh platform-driven invocation.
+ *
+ * Status -> emitted event: 'success' -> *_DONE; 'error' -> *_ERROR;
+ * 'progress' -> *_PROGRESS and 'delay' -> *_DELAYED in resumable phases
+ * (data/attachment extraction and loading), but *_ERROR in non-resumable
+ * phases (external sync units, metadata), where they are illegal.
+ */
+export type TaskResult = {
+    status: 'success';
+} | {
+    status: 'progress';
+} | {
+    status: 'delay';
+    delaySeconds: number;
+} | {
+    status: 'error';
+    error: ErrorRecord;
+};
+export type TaskStatus = TaskResult['status'];
+/** Parameter shape passed to a worker's task and onTimeout callbacks. */
+export interface TaskAdapterInterface<Adapter> {
     adapter: Adapter;
 }
 /**
- * ProcessTaskInterface is the parameter shape for the process-task entry points.
- * @interface ProcessTaskInterface
- * @constructor
- * @param {function} task - The task to be executed, returns exit code
- * @param {function} onTimeout - The task to be executed on timeout, returns exit code
+ * If `onTimeout` is omitted, the SDK emits a phase-appropriate default on
+ * timeout: progress for resumable phases, error for ESU/metadata.
  */
-export interface ProcessTaskInterface<Adapter extends BaseAdapter<unknown, BaseState<unknown, BaseSdkState>>> {
-    task: (params: TaskAdapterInterface<Adapter>) => Promise<void>;
-    onTimeout: (params: TaskAdapterInterface<Adapter>) => Promise<void>;
+export interface ProcessTaskInterface<Adapter> {
+    task: (params: TaskAdapterInterface<Adapter>) => Promise<TaskResult>;
+    onTimeout?: (params: TaskAdapterInterface<Adapter>) => Promise<TaskResult>;
 }
-/**
- * WorkerEvent represents the standard worker events.
- */
 export declare enum WorkerEvent {
     WorkerMessage = "message",
     WorkerOnline = "online",
     WorkerError = "error",
     WorkerExit = "exit"
 }
-/**
- * WorkerMessageSubject represents the handled worker message subjects.
- */
 export declare enum WorkerMessageSubject {
     WorkerMessageEmitted = "emit",
     WorkerMessageExit = "exit",
     WorkerMessageLog = "log",
     WorkerMessageFailed = "failed"
 }
-/**
- * WorkerMessageEmitted interface represents the structure of the emitted worker message.
- */
 export interface WorkerMessageEmitted {
     subject: WorkerMessageSubject.WorkerMessageEmitted;
     payload: {
         eventType: ExtractorEventType | LoaderEventType;
     };
 }
-/**
- * WorkerMessageExit interface represents the structure of the exit worker message.
- */
 export interface WorkerMessageExit {
     subject: WorkerMessageSubject.WorkerMessageExit;
 }
-/**
- * WorkerMessageLog interface represents the structure of the worker log message.
- */
 export interface WorkerMessageLog {
     subject: WorkerMessageSubject.WorkerMessageLog;
     payload: {
         stringifiedArgs: string;
         level: LogLevel;
-        isSdkLog?: boolean;
     };
 }
-/**
- * WorkerMessageFailed interface represents the structure of the worker failed message.
- * Sent from the worker thread before calling process.exit(1) to convey the specific
- * error reason to the main thread.
- */
+/** Sent from the worker thread before process.exit(1) to convey the error reason to the main thread. */
 export interface WorkerMessageFailed {
     subject: WorkerMessageSubject.WorkerMessageFailed;
     payload: {
         message: string;
     };
 }
-/**
- * WorkerMessage represents the structure of the worker message.
- */
 export type WorkerMessage = WorkerMessageEmitted | WorkerMessageExit | WorkerMessageLog | WorkerMessageFailed;
-/**
- * WorkerData represents the structure of the worker data object.
- */
 export interface WorkerData<ConnectorState> {
     event: AirSyncEvent;
     initialState: ConnectorState;
@@ -165,15 +115,10 @@ export interface WorkerData<ConnectorState> {
     initialDomainMapping?: InitialDomainMapping;
     options?: WorkerAdapterOptions;
 }
-/**
- * GetWorkerPathInterface is an interface for getting the worker path.
- */
 export interface GetWorkerPathInterface {
     event: AirSyncEvent;
     workerBasePath?: string | null;
 }
-/**
- * WorkerPathOverrides represents a mapping of event types to custom worker paths.
- */
+/** Maps event types to custom worker paths, overriding the defaults. */
 export type WorkerPathOverrides = Partial<Record<EventType, string>>;
 //# sourceMappingURL=workers.d.ts.map

package/dist/types/workers.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"workers.d.ts","sourceRoot":"","sources":["../../src/types/workers.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAExC,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,6BAA6B,CAAC;AAC5D,OAAO,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AAChD,OAAO,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAC;AACzD,OAAO,EAAE,WAAW,EAAE,MAAM,yCAAyC,CAAC;AAEtE,OAAO,EAAE,YAAY,EAAE,SAAS,EAAE,kBAAkB,EAAE,MAAM,cAAc,CAAC;AAE3E,OAAO,EAAE,eAAe,EAAE,MAAM,WAAW,CAAC;AAE5C,OAAO,EAAE,oBAAoB,EAAE,MAAM,UAAU,CAAC;AAEhD;;;;;;;GAOG;AACH,MAAM,WAAW,sBAAsB,CACrC,cAAc,EACd,UAAU,SAAS,SAAS,CAAC,cAAc,EAAE,YAAY,CAAC;IAE1D,KAAK,EAAE,YAAY,CAAC;IACpB,YAAY,EAAE,UAAU,CAAC;IACzB,OAAO,CAAC,EAAE,oBAAoB,CAAC;CAChC;AAED;;;GAGG;AACH,MAAM,MAAM,eAAe,GAAG,MAAM,CAAC,MAAM,EAAE;IAAE,OAAO,EAAE,OAAO,CAAA;CAAE,CAAC,CAAC;AAEnE;;;;;;;;GAQG;AACH,MAAM,WAAW,oBAAoB;IACnC,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,mBAAmB,CAAC,EAAE,mBAAmB,CAAC;IAC1C,gBAAgB,CAAC,EAAE,OAAO,CAAC;CAC5B;AAED;;;;;;GAMG;AACH,MAAM,WAAW,cAAc;IAC7B,KAAK,EAAE,YAAY,CAAC;IACpB,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,oBAAoB,CAAC;IAC/B,OAAO,EAAE,CAAC,KAAK,EAAE,IAAI,GAAG,WAAW,CAAC,IAAI,CAAC,KAAK,IAAI,CAAC;IACnD,eAAe,CAAC,EAAE,OAAO,CAAC;CAC3B;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,WAAW,qBAAqB,CAAC,cAAc;IACnD,KAAK,EAAE,YAAY,CAAC;IACpB,YAAY,EAAE,cAAc,CAAC;IAC7B,OAAO,CAAC,EAAE,oBAAoB,CAAC;IAC/B,oBAAoB,CAAC,EAAE,oBAAoB,CAAC;IAC5C,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED;;;;;GAKG;AACH,MAAM,WAAW,oBAAoB,CACnC,OAAO,SAAS,WAAW,CAAC,OAAO,EAAE,SAAS,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC;IAEtE,OAAO,EAAE,OAAO,CAAC;CAClB;AAED;;;;;;GAMG;AACH,MAAM,WAAW,oBAAoB,CACnC,OAAO,SAAS,WAAW,CAAC,OAAO,EAAE,SAAS,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC;IAEtE,IAAI,EAAE,CAAC,MAAM,EAAE,oBAAoB,CAAC,OAAO,CAAC,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAC/D,SAAS,EAAE,CAAC,MAAM,EAAE,oBAAoB,CAAC,OAAO,CAAC,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;CACrE;AAED;;GAEG;AACH,oBAAY,WAAW;IACrB,aAAa,YAAY;IACzB,YAAY,WAAW;IACvB,WAAW,UAAU;IACrB,UAAU,SAAS;CACpB;AAED;;GAEG;AACH,oBAAY,oBAAoB;IAC9B,oBAAoB,SAAS;IAC7B,iBAAiB,SAAS;IAC1B,gBAAgB,QAAQ;IACxB,mBAAmB,WAAW;CAC/B;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,OAAO,EAAE,oBAAoB,CAAC,oBAAoB,CAAC;IACnD,OAAO,EAAE;QACP,SAAS,EAAE,kBAAkB,GAAG,eAAe,CAAC;KACjD,CAAC;CACH;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,OAAO,EAAE,oBAAoB,CAAC,iBAAiB,CAAC;CACjD;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,OAAO,EAAE,oBAAoB,CAAC,gBAAgB,CAAC;IAC/C,OAAO,EAAE;QACP,eAAe,EAAE,MAAM,CAAC;QACxB,KAAK,EAAE,QAAQ,CAAC;QAChB,QAAQ,CAAC,EAAE,OAAO,CAAC;KACpB,CAAC;CACH;AAED;;;;GAIG;AACH,MAAM,WAAW,mBAAmB;IAClC,OAAO,EAAE,oBAAoB,CAAC,mBAAmB,CAAC;IAClD,OAAO,EAAE;QAAE,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC;CAC9B;AAED;;GAEG;AACH,MAAM,MAAM,aAAa,GACrB,oBAAoB,GACpB,iBAAiB,GACjB,gBAAgB,GAChB,mBAAmB,CAAC;AAExB;;GAEG;AACH,MAAM,WAAW,UAAU,CAAC,cAAc;IACxC,KAAK,EAAE,YAAY,CAAC;IACpB,YAAY,EAAE,cAAc,CAAC;IAC7B,UAAU,EAAE,MAAM,CAAC;IACnB,oBAAoB,CAAC,EAAE,oBAAoB,CAAC;IAC5C,OAAO,CAAC,EAAE,oBAAoB,CAAC;CAChC;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC,KAAK,EAAE,YAAY,CAAC;IACpB,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAChC;AAED;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG,OAAO,CAAC,MAAM,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC,CAAC"}
+{"version":3,"file":"workers.d.ts","sourceRoot":"","sources":["../../src/types/workers.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAExC,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,6BAA6B,CAAC;AAC5D,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAE3C,OAAO,EAAE,WAAW,EAAE,oBAAoB,EAAE,MAAM,UAAU,CAAC;AAC7D,OAAO,EAAE,YAAY,EAAE,SAAS,EAAE,kBAAkB,EAAE,MAAM,cAAc,CAAC;AAC3E,OAAO,EAAE,eAAe,EAAE,MAAM,WAAW,CAAC;AAE5C,MAAM,WAAW,sBAAsB,CAAC,cAAc;IACpD,KAAK,EAAE,YAAY,CAAC;IACpB,YAAY,EAAE,SAAS,CAAC,cAAc,CAAC,CAAC;IACxC,OAAO,CAAC,EAAE,oBAAoB,CAAC;CAChC;AAED,0EAA0E;AAC1E,MAAM,MAAM,eAAe,GAAG,MAAM,CAAC,MAAM,EAAE;IAAE,OAAO,EAAE,OAAO,CAAA;CAAE,CAAC,CAAC;AAEnE,MAAM,WAAW,oBAAoB;IACnC,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B,6BAA6B;IAC7B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,oDAAoD;IACpD,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,mBAAmB,CAAC,EAAE,mBAAmB,CAAC;IAC1C,gBAAgB,CAAC,EAAE,OAAO,CAAC;CAC5B;AAED,MAAM,WAAW,cAAc;IAC7B,KAAK,EAAE,YAAY,CAAC;IACpB,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,oBAAoB,CAAC;IAC/B,OAAO,EAAE,CAAC,KAAK,EAAE,IAAI,GAAG,WAAW,CAAC,IAAI,CAAC,KAAK,IAAI,CAAC;IACnD,eAAe,CAAC,EAAE,OAAO,CAAC;CAC3B;AAED,MAAM,WAAW,qBAAqB,CAAC,cAAc;IACnD,KAAK,EAAE,YAAY,CAAC;IACpB,YAAY,EAAE,cAAc,CAAC;IAC7B,OAAO,CAAC,EAAE,oBAAoB,CAAC;IAC/B,oBAAoB,CAAC,EAAE,oBAAoB,CAAC;IAC5C,2DAA2D;IAC3D,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED;;;;;;;;;;GAUG;AACH,MAAM,MAAM,UAAU,GAClB;IAAE,MAAM,EAAE,SAAS,CAAA;CAAE,GACrB;IAAE,MAAM,EAAE,UAAU,CAAA;CAAE,GACtB;IAAE,MAAM,EAAE,OAAO,CAAC;IAAC,YAAY,EAAE,MAAM,CAAA;CAAE,GACzC;IAAE,MAAM,EAAE,OAAO,CAAC;IAAC,KAAK,EAAE,WAAW,CAAA;CAAE,CAAC;AAE5C,MAAM,MAAM,UAAU,GAAG,UAAU,CAAC,QAAQ,CAAC,CAAC;AAE9C,yEAAyE;AACzE,MAAM,WAAW,oBAAoB,CAAC,OAAO;IAC3C,OAAO,EAAE,OAAO,CAAC;CAClB;AAED;;;GAGG;AACH,MAAM,WAAW,oBAAoB,CAAC,OAAO;IAC3C,IAAI,EAAE,CAAC,MAAM,EAAE,oBAAoB,CAAC,OAAO,CAAC,KAAK,OAAO,CAAC,UAAU,CAAC,CAAC;IACrE,SAAS,CAAC,EAAE,CAAC,MAAM,EAAE,oBAAoB,CAAC,OAAO,CAAC,KAAK,OAAO,CAAC,UAAU,CAAC,CAAC;CAC5E;AAED,oBAAY,WAAW;IACrB,aAAa,YAAY;IACzB,YAAY,WAAW;IACvB,WAAW,UAAU;IACrB,UAAU,SAAS;CACpB;AAED,oBAAY,oBAAoB;IAC9B,oBAAoB,SAAS;IAC7B,iBAAiB,SAAS;IAC1B,gBAAgB,QAAQ;IACxB,mBAAmB,WAAW;CAC/B;AAED,MAAM,WAAW,oBAAoB;IACnC,OAAO,EAAE,oBAAoB,CAAC,oBAAoB,CAAC;IACnD,OAAO,EAAE;QACP,SAAS,EAAE,kBAAkB,GAAG,eAAe,CAAC;KACjD,CAAC;CACH;AAED,MAAM,WAAW,iBAAiB;IAChC,OAAO,EAAE,oBAAoB,CAAC,iBAAiB,CAAC;CACjD;AAED,MAAM,WAAW,gBAAgB;IAC/B,OAAO,EAAE,oBAAoB,CAAC,gBAAgB,CAAC;IAC/C,OAAO,EAAE;QACP,eAAe,EAAE,MAAM,CAAC;QACxB,KAAK,EAAE,QAAQ,CAAC;KACjB,CAAC;CACH;AAED,wGAAwG;AACxG,MAAM,WAAW,mBAAmB;IAClC,OAAO,EAAE,oBAAoB,CAAC,mBAAmB,CAAC;IAClD,OAAO,EAAE;QAAE,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC;CAC9B;AAED,MAAM,MAAM,aAAa,GACrB,oBAAoB,GACpB,iBAAiB,GACjB,gBAAgB,GAChB,mBAAmB,CAAC;AAExB,MAAM,WAAW,UAAU,CAAC,cAAc;IACxC,KAAK,EAAE,YAAY,CAAC;IACpB,YAAY,EAAE,cAAc,CAAC;IAC7B,UAAU,EAAE,MAAM,CAAC;IACnB,oBAAoB,CAAC,EAAE,oBAAoB,CAAC;IAC5C,OAAO,CAAC,EAAE,oBAAoB,CAAC;CAChC;AAED,MAAM,WAAW,sBAAsB;IACrC,KAAK,EAAE,YAAY,CAAC;IACpB,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAChC;AAED,wEAAwE;AACxE,MAAM,MAAM,mBAAmB,GAAG,OAAO,CAAC,MAAM,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC,CAAC"}

package/dist/types/workers.js

@@ -1,9 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.WorkerMessageSubject = exports.WorkerEvent = void 0;
-/**
- * WorkerEvent represents the standard worker events.
- */
 var WorkerEvent;
 (function (WorkerEvent) {
     WorkerEvent["WorkerMessage"] = "message";
@@ -11,9 +8,6 @@ var WorkerEvent;
     WorkerEvent["WorkerError"] = "error";
     WorkerEvent["WorkerExit"] = "exit";
 })(WorkerEvent || (exports.WorkerEvent = WorkerEvent = {}));
-/**
- * WorkerMessageSubject represents the handled worker message subjects.
- */
 var WorkerMessageSubject;
 (function (WorkerMessageSubject) {
     WorkerMessageSubject["WorkerMessageEmitted"] = "emit";

package/dist/uploader/uploader.d.ts

@@ -1,6 +1,7 @@
 import { AxiosResponse } from 'axios';
 import { NormalizedAttachment } from '../repo/repo.interfaces';
-import { ArtifactToUpload, UploadResponse, UploaderFactoryInterface, UploaderResult } from './uploader.interfaces';
+import { HttpStreamResponse } from '../types/extraction';
+import { ArtifactToUpload, UploaderFactoryInterface, UploaderResult, UploadResponse } from './uploader.interfaces';
 export declare class Uploader {
     private isLocalDevelopment?;
     private devrevApiEndpoint;
@@ -9,55 +10,19 @@ export declare class Uploader {
     private defaultHeaders;
     private skipConfirmation;
     constructor({ event, options }: UploaderFactoryInterface);
-    /**
-     * Uploads the fetched objects to the DevRev platform. Fetched objects are compressed to a gzipped jsonl object and uploaded to the platform.
-     * @param {string} itemType - The type of the item to be uploaded
-     * @param {object[] | object} fetchedObjects - The objects to be uploaded
-     * @returns {Promise<UploadResponse>} - The response object containing the artifact information or error information if there was an error
-     */
+    /** Compresses fetched objects to gzipped JSONL and uploads them as an artifact. */
     upload(itemType: string, fetchedObjects: object[] | object): Promise<UploadResponse>;
-    /**
-     * Gets the upload URL for an artifact from the DevRev API.
-     * @param {string} filename - The name of the file to upload
-     * @param {string} fileType - The MIME type of the file
-     * @param {number} [fileSize] - Optional file size in bytes
-     * @returns {Promise<ArtifactToUpload | void>} The artifact upload information or undefined on error
-     */
     getArtifactUploadUrl(filename: string, fileType: string, fileSize?: number): Promise<UploaderResult<ArtifactToUpload>>;
-    /**
-     * Uploads an artifact file to the provided upload URL using multipart form data.
-     * @param {ArtifactToUpload} artifact - The artifact upload information containing upload URL and form data
-     * @param {Buffer} file - The file buffer to upload
-     * @returns {Promise<AxiosResponse | void>} The axios response or undefined on error
-     */
+    /** Uploads the file buffer to the artifact's upload URL as multipart form data. */
     uploadArtifact(artifact: ArtifactToUpload, file: Buffer): Promise<UploaderResult<AxiosResponse>>;
-    /**
-     * Streams an artifact file from an axios response to the upload URL.
-     * @param {ArtifactToUpload} artifact - The artifact upload information containing upload URL and form data
-     * @param {AxiosResponse} fileStream - The axios response stream containing the file data
-     * @returns {Promise<AxiosResponse | void>} The axios response or undefined on error
-     */
-    streamArtifact(artifact: ArtifactToUpload, fileStream: AxiosResponse): Promise<UploaderResult<AxiosResponse>>;
-    /**
-     * Confirms that an artifact upload has been completed successfully.
-     * @param {string} artifactId - The ID of the artifact to confirm
-     * @returns {Promise<AxiosResponse | void>} The axios response or undefined on error
-     */
+    /** Streams a file from an HTTP response directly to the artifact's upload URL. */
+    streamArtifact(artifact: ArtifactToUpload, fileStream: HttpStreamResponse): Promise<UploaderResult<AxiosResponse>>;
     confirmArtifactUpload(artifactId: string): Promise<{
         response?: AxiosResponse;
         error?: unknown;
     }>;
-    /**
-     * Destroys a stream to prevent resource leaks.
-     * @param {any} fileStream - The axios response stream to destroy
-     */
     private destroyStream;
-    /**
-     * Retrieves attachment metadata from an artifact by downloading and parsing it.
-     * @param {object} param0 - Configuration object
-     * @param {string} param0.artifact - The artifact ID to download attachments from
-     * @returns {Promise<{attachments?: NormalizedAttachment[], error?: {message: string}}>} The attachments array or error object
-     */
+    /** Downloads an artifact and parses it into attachment metadata. */
     getAttachmentsFromArtifactId({ artifact, }: {
         artifact: string;
     }): Promise<{
@@ -66,25 +31,9 @@ export declare class Uploader {
             message: string;
         };
     }>;
-    /**
-     * Gets the download URL for an artifact from the DevRev API.
-     * @param {string} artifactId - The ID of the artifact to download
-     * @returns {Promise<string | void>} The download URL or undefined on error
-     */
     private getArtifactDownloadUrl;
-    /**
-     * Downloads an artifact file from the given URL.
-     * @param {string} artifactUrl - The URL to download the artifact from
-     * @returns {Promise<Buffer | void>} The artifact file buffer or undefined on error
-     */
     private downloadArtifact;
-    /**
-     * Retrieves and parses JSON objects from an artifact by artifact ID.
-     * @param {object} param0 - Configuration object
-     * @param {string} param0.artifactId - The artifact ID to download and parse
-     * @param {boolean} [param0.isGzipped=false] - Whether the artifact is gzipped
-     * @returns {Promise<object[] | object | void>} The parsed JSON objects or undefined on error
-     */
+    /** Downloads an artifact (optionally gzipped) and parses it as JSONL. */
     getJsonObjectByArtifactId({ artifactId, isGzipped, }: {
         artifactId: string;
         isGzipped?: boolean;

package/dist/uploader/uploader.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"uploader.d.ts","sourceRoot":"","sources":["../../src/uploader/uploader.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,OAAO,CAAC;AAMtC,OAAO,EAAE,oBAAoB,EAAE,MAAM,yBAAyB,CAAC;AAU/D,OAAO,EAEL,gBAAgB,EAChB,cAAc,EACd,wBAAwB,EACxB,cAAc,EACf,MAAM,uBAAuB,CAAC;AAE/B,qBAAa,QAAQ;IACnB,OAAO,CAAC,kBAAkB,CAAC,CAAU;IACrC,OAAO,CAAC,iBAAiB,CAAS;IAClC,OAAO,CAAC,cAAc,CAAS;IAC/B,OAAO,CAAC,SAAS,CAAS;IAC1B,OAAO,CAAC,cAAc,CAAyB;IAC/C,OAAO,CAAC,gBAAgB,CAAU;gBAEtB,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE,wBAAwB;IAWxD;;;;;OAKG;IACG,MAAM,CACV,QAAQ,EAAE,MAAM,EAChB,cAAc,EAAE,MAAM,EAAE,GAAG,MAAM,GAChC,OAAO,CAAC,cAAc,CAAC;IA4E1B;;;;;;OAMG;IACG,oBAAoB,CACxB,QAAQ,EAAE,MAAM,EAChB,QAAQ,EAAE,MAAM,EAChB,QAAQ,CAAC,EAAE,MAAM,GAChB,OAAO,CAAC,cAAc,CAAC,gBAAgB,CAAC,CAAC;IA2B5C;;;;;OAKG;IACG,cAAc,CAClB,QAAQ,EAAE,gBAAgB,EAC1B,IAAI,EAAE,MAAM,GACX,OAAO,CAAC,cAAc,CAAC,aAAa,CAAC,CAAC;IAmBzC;;;;;OAKG;IACG,cAAc,CAClB,QAAQ,EAAE,gBAAgB,EAC1B,UAAU,EAAE,aAAa,GACxB,OAAO,CAAC,cAAc,CAAC,aAAa,CAAC,CAAC;IA8BzC;;;;OAIG;IACG,qBAAqB,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC;QACvD,QAAQ,CAAC,EAAE,aAAa,CAAC;QACzB,KAAK,CAAC,EAAE,OAAO,CAAC;KACjB,CAAC;IAiCF;;;OAGG;IACH,OAAO,CAAC,aAAa;IAerB;;;;;OAKG;IACG,4BAA4B,CAAC,EACjC,QAAQ,GACT,EAAE;QACD,QAAQ,EAAE,MAAM,CAAC;KAClB,GAAG,OAAO,CAAC;QACV,WAAW,CAAC,EAAE,oBAAoB,EAAE,CAAC;QACrC,KAAK,CAAC,EAAE;YAAE,OAAO,EAAE,MAAM,CAAA;SAAE,CAAC;KAC7B,CAAC;IA2DF;;;;OAIG;YACW,sBAAsB;IAsBpC;;;;OAIG;YACW,gBAAgB;IAc9B;;;;;;OAMG;IACG,yBAAyB,CAAC,EAC9B,UAAU,EACV,SAAiB,GAClB,EAAE;QACD,UAAU,EAAE,MAAM,CAAC;QACnB,SAAS,CAAC,EAAE,OAAO,CAAC;KACrB,GAAG,OAAO,CAAC,cAAc,CAAC,MAAM,EAAE,GAAG,MAAM,CAAC,CAAC;CA6B/C"}
+{"version":3,"file":"uploader.d.ts","sourceRoot":"","sources":["../../src/uploader/uploader.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,OAAO,CAAC;AAOtC,OAAO,EAAE,oBAAoB,EAAE,MAAM,yBAAyB,CAAC;AAC/D,OAAO,EAAE,kBAAkB,EAAE,MAAM,qBAAqB,CAAC;AAUzD,OAAO,EAEL,gBAAgB,EAChB,wBAAwB,EACxB,cAAc,EACd,cAAc,EACf,MAAM,uBAAuB,CAAC;AAE/B,qBAAa,QAAQ;IACnB,OAAO,CAAC,kBAAkB,CAAC,CAAU;IACrC,OAAO,CAAC,iBAAiB,CAAS;IAClC,OAAO,CAAC,cAAc,CAAS;IAC/B,OAAO,CAAC,SAAS,CAAS;IAC1B,OAAO,CAAC,cAAc,CAAyB;IAC/C,OAAO,CAAC,gBAAgB,CAAU;gBAEtB,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE,wBAAwB;IAWxD,mFAAmF;IAC7E,MAAM,CACV,QAAQ,EAAE,MAAM,EAChB,cAAc,EAAE,MAAM,EAAE,GAAG,MAAM,GAChC,OAAO,CAAC,cAAc,CAAC;IA0EpB,oBAAoB,CACxB,QAAQ,EAAE,MAAM,EAChB,QAAQ,EAAE,MAAM,EAChB,QAAQ,CAAC,EAAE,MAAM,GAChB,OAAO,CAAC,cAAc,CAAC,gBAAgB,CAAC,CAAC;IA2B5C,mFAAmF;IAC7E,cAAc,CAClB,QAAQ,EAAE,gBAAgB,EAC1B,IAAI,EAAE,MAAM,GACX,OAAO,CAAC,cAAc,CAAC,aAAa,CAAC,CAAC;IAmBzC,kFAAkF;IAC5E,cAAc,CAClB,QAAQ,EAAE,gBAAgB,EAC1B,UAAU,EAAE,kBAAkB,GAC7B,OAAO,CAAC,cAAc,CAAC,aAAa,CAAC,CAAC;IAqCnC,qBAAqB,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC;QACvD,QAAQ,CAAC,EAAE,aAAa,CAAC;QACzB,KAAK,CAAC,EAAE,OAAO,CAAC;KACjB,CAAC;IAgCF,OAAO,CAAC,aAAa;IAerB,oEAAoE;IAC9D,4BAA4B,CAAC,EACjC,QAAQ,GACT,EAAE;QACD,QAAQ,EAAE,MAAM,CAAC;KAClB,GAAG,OAAO,CAAC;QACV,WAAW,CAAC,EAAE,oBAAoB,EAAE,CAAC;QACrC,KAAK,CAAC,EAAE;YAAE,OAAO,EAAE,MAAM,CAAA;SAAE,CAAC;KAC7B,CAAC;YAuDY,sBAAsB;YAsBtB,gBAAgB;IAc9B,yEAAyE;IACnE,yBAAyB,CAAC,EAC9B,UAAU,EACV,SAAiB,GAClB,EAAE;QACD,UAAU,EAAE,MAAM,CAAC;QACnB,SAAS,CAAC,EAAE,OAAO,CAAC;KACrB,GAAG,OAAO,CAAC,cAAc,CAAC,MAAM,EAAE,GAAG,MAAM,CAAC,CAAC;CA6B/C"}

package/dist/uploader/uploader.helpers.d.ts

@@ -1,33 +1,10 @@
-import { UploaderResult } from './uploader.interfaces';
-/**
- * Compresses a JSONL string using gzip compression.
- * @param {string} jsonlObject - The JSONL string to compress
- * @returns {Buffer | void} The compressed buffer or undefined on error
- */
+import { ArtifactDateRanges, UploaderResult } from './uploader.interfaces';
+/** Computes oldest/newest created and modified timestamps (RFC3339) across uploaded items. */
+export declare function computeArtifactDateRanges(fetchedObjects: object[] | object): ArtifactDateRanges;
 export declare function compressGzip(jsonlObject: string): UploaderResult<Buffer>;
-/**
- * Decompresses a gzipped buffer to a JSONL string.
- * @param {Buffer} gzippedJsonlObject - The gzipped buffer to decompress
- * @returns {string | void} The decompressed JSONL string or undefined on error
- */
 export declare function decompressGzip(gzippedJsonlObject: Buffer): UploaderResult<string>;
-/**
- * Parses a JSONL string into an array of objects.
- * @param {string} jsonlObject - The JSONL string to parse
- * @returns {object[] | null} The parsed array of objects or null on error
- */
 export declare function parseJsonl(jsonlObject: string): UploaderResult<object[]>;
-/**
- * Downloads fetched objects to the local file system (for local development).
- * @param {string} itemType - The type of items being downloaded
- * @param {object | object[]} fetchedObjects - The objects to write to file
- * @returns {Promise<void>} Resolves when the file is written or rejects on error
- */
+/** Writes fetched objects to the local file system (local development only). */
 export declare function downloadToLocal(itemType: string, fetchedObjects: object | object[]): Promise<void>;
-/**
- * Truncates a filename if it exceeds the maximum allowed length.
- * @param {string} filename - The filename to truncate
- * @returns {string} The truncated filename
- */
 export declare function truncateFilename(filename: string): string;
 //# sourceMappingURL=uploader.helpers.d.ts.map

package/dist/uploader/uploader.helpers.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"uploader.helpers.d.ts","sourceRoot":"","sources":["../../src/uploader/uploader.helpers.ts"],"names":[],"mappings":"AAQA,OAAO,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AAEvD;;;;GAIG;AACH,wBAAgB,YAAY,CAAC,WAAW,EAAE,MAAM,GAAG,cAAc,CAAC,MAAM,CAAC,CAMxE;AAED;;;;GAIG;AACH,wBAAgB,cAAc,CAC5B,kBAAkB,EAAE,MAAM,GACzB,cAAc,CAAC,MAAM,CAAC,CAOxB;AAED;;;;GAIG;AACH,wBAAgB,UAAU,CAAC,WAAW,EAAE,MAAM,GAAG,cAAc,CAAC,MAAM,EAAE,CAAC,CAMxE;AAED;;;;;GAKG;AACH,wBAAsB,eAAe,CACnC,QAAQ,EAAE,MAAM,EAChB,cAAc,EAAE,MAAM,GAAG,MAAM,EAAE,GAChC,OAAO,CAAC,IAAI,CAAC,CA4Bf;AAED;;;;GAIG;AACH,wBAAgB,gBAAgB,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,CAmBzD"}
+{"version":3,"file":"uploader.helpers.d.ts","sourceRoot":"","sources":["../../src/uploader/uploader.helpers.ts"],"names":[],"mappings":"AAWA,OAAO,EAEL,kBAAkB,EAClB,cAAc,EACf,MAAM,uBAAuB,CAAC;AAE/B,8FAA8F;AAC9F,wBAAgB,yBAAyB,CACvC,cAAc,EAAE,MAAM,EAAE,GAAG,MAAM,GAChC,kBAAkB,CAwEpB;AAED,wBAAgB,YAAY,CAAC,WAAW,EAAE,MAAM,GAAG,cAAc,CAAC,MAAM,CAAC,CAMxE;AAED,wBAAgB,cAAc,CAC5B,kBAAkB,EAAE,MAAM,GACzB,cAAc,CAAC,MAAM,CAAC,CAOxB;AAED,wBAAgB,UAAU,CAAC,WAAW,EAAE,MAAM,GAAG,cAAc,CAAC,MAAM,EAAE,CAAC,CAMxE;AAED,gFAAgF;AAChF,wBAAsB,eAAe,CACnC,QAAQ,EAAE,MAAM,EAChB,cAAc,EAAE,MAAM,GAAG,MAAM,EAAE,GAChC,OAAO,CAAC,IAAI,CAAC,CA4Bf;AAED,wBAAgB,gBAAgB,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,CAgBzD"}

package/dist/uploader/uploader.helpers.js

@@ -36,20 +36,77 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.computeArtifactDateRanges = computeArtifactDateRanges;
 exports.compressGzip = compressGzip;
 exports.decompressGzip = decompressGzip;
 exports.parseJsonl = parseJsonl;
 exports.downloadToLocal = downloadToLocal;
 exports.truncateFilename = truncateFilename;
 const fs_1 = __importStar(require("fs"));
-const js_jsonl_1 = require("js-jsonl");
 const zlib_1 = __importDefault(require("zlib"));
+const js_jsonl_1 = require("js-jsonl");
 const constants_1 = require("../common/constants");
-/**
- * Compresses a JSONL string using gzip compression.
- * @param {string} jsonlObject - The JSONL string to compress
- * @returns {Buffer | void} The compressed buffer or undefined on error
- */
+const uploader_interfaces_1 = require("./uploader.interfaces");
+/** Computes oldest/newest created and modified timestamps (RFC3339) across uploaded items. */
+function computeArtifactDateRanges(fetchedObjects) {
+    const items = Array.isArray(fetchedObjects)
+        ? fetchedObjects
+        : [fetchedObjects];
+    const created = {
+        min: Number.POSITIVE_INFINITY,
+        max: Number.NEGATIVE_INFINITY,
+    };
+    const modified = {
+        min: Number.POSITIVE_INFINITY,
+        max: Number.NEGATIVE_INFINITY,
+    };
+    let hasCreated = false;
+    let hasModified = false;
+    const parseTimestamp = (value) => {
+        const ts = new Date(value).getTime();
+        return Number.isNaN(ts) ? undefined : ts;
+    };
+    for (const obj of items) {
+        if (!obj || typeof obj !== 'object') {
+            continue;
+        }
+        const item = obj;
+        if (item.created_date != undefined) {
+            const ts = parseTimestamp(item.created_date);
+            if (ts != undefined) {
+                if (ts < created.min) {
+                    created.min = ts;
+                }
+                if (ts > created.max) {
+                    created.max = ts;
+                }
+                hasCreated = true;
+            }
+        }
+        if (item.modified_date != undefined) {
+            const ts = parseTimestamp(item.modified_date);
+            if (ts != undefined) {
+                if (ts < modified.min) {
+                    modified.min = ts;
+                }
+                if (ts > modified.max) {
+                    modified.max = ts;
+                }
+                hasModified = true;
+            }
+        }
+    }
+    const result = {};
+    if (hasCreated) {
+        result[uploader_interfaces_1.ArtifactDateField.OldestCreatedDate] = new Date(created.min).toISOString();
+        result[uploader_interfaces_1.ArtifactDateField.NewestCreatedDate] = new Date(created.max).toISOString();
+    }
+    if (hasModified) {
+        result[uploader_interfaces_1.ArtifactDateField.OldestModifiedDate] = new Date(modified.min).toISOString();
+        result[uploader_interfaces_1.ArtifactDateField.NewestModifiedDate] = new Date(modified.max).toISOString();
+    }
+    return result;
+}
 function compressGzip(jsonlObject) {
     try {
         return { response: zlib_1.default.gzipSync(jsonlObject) };
@@ -58,11 +115,6 @@ function compressGzip(jsonlObject) {
         return { error };
     }
 }
-/**
- * Decompresses a gzipped buffer to a JSONL string.
- * @param {Buffer} gzippedJsonlObject - The gzipped buffer to decompress
- * @returns {string | void} The decompressed JSONL string or undefined on error
- */
 function decompressGzip(gzippedJsonlObject) {
     try {
         const jsonlObject = zlib_1.default.gunzipSync(gzippedJsonlObject);
@@ -72,11 +124,6 @@ function decompressGzip(gzippedJsonlObject) {
         return { error };
     }
 }
-/**
- * Parses a JSONL string into an array of objects.
- * @param {string} jsonlObject - The JSONL string to parse
- * @returns {object[] | null} The parsed array of objects or null on error
- */
 function parseJsonl(jsonlObject) {
     try {
         return { response: js_jsonl_1.jsonl.parse(jsonlObject) };
@@ -85,12 +132,7 @@ function parseJsonl(jsonlObject) {
         return { error };
     }
 }
-/**
- * Downloads fetched objects to the local file system (for local development).
- * @param {string} itemType - The type of items being downloaded
- * @param {object | object[]} fetchedObjects - The objects to write to file
- * @returns {Promise<void>} Resolves when the file is written or rejects on error
- */
+/** Writes fetched objects to the local file system (local development only). */
 async function downloadToLocal(itemType, fetchedObjects) {
     console.log(`Downloading ${itemType} to local file system.`);
     try {
@@ -119,21 +161,13 @@ async function downloadToLocal(itemType, fetchedObjects) {
         return Promise.reject(error);
     }
 }
-/**
- * Truncates a filename if it exceeds the maximum allowed length.
- * @param {string} filename - The filename to truncate
- * @returns {string} The truncated filename
- */
 function truncateFilename(filename) {
-    // If the filename is already within the limit, return it as is.
     if (filename.length <= constants_1.MAX_DEVREV_FILENAME_LENGTH) {
         return filename;
     }
     console.warn(`Filename length exceeds the maximum limit of ${constants_1.MAX_DEVREV_FILENAME_LENGTH} characters. Truncating filename.`);
     const extension = filename.slice(-constants_1.MAX_DEVREV_FILENAME_EXTENSION_LENGTH);
-    // Calculate how many characters are available for the name part after accounting for the extension and "..."
     const availableNameLength = constants_1.MAX_DEVREV_FILENAME_LENGTH - constants_1.MAX_DEVREV_FILENAME_EXTENSION_LENGTH - 3; // -3 for "..."
-    // Truncate the name part and add an ellipsis
     const truncatedFilename = filename.slice(0, availableNameLength);
     return `${truncatedFilename}...${extension}`;
 }

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

@@ -6,10 +6,6 @@ export interface UploaderFactoryInterface {
     event: AirSyncEvent;
     options?: WorkerAdapterOptions;
 }
-/**
- * Generic result type for uploader operations that can either succeed with a response or fail with an error.
- * @template T The type of the successful response data
- */
 export type UploaderResult<T> = {
     response: T;
     error?: never;
@@ -17,17 +13,24 @@ export type UploaderResult<T> = {
     response?: never;
     error: unknown;
 };
-/**
- * Artifact is an interface that defines the structure of an artifact. Artifact is a file that is generated by the extractor and uploaded to the AirSync platform.
- */
+export declare enum ArtifactDateField {
+    OldestCreatedDate = "oldest_created_date",
+    NewestCreatedDate = "newest_created_date",
+    OldestModifiedDate = "oldest_modified_date",
+    NewestModifiedDate = "newest_modified_date"
+}
+/** A file generated by the extractor and uploaded to AirSync. */
 export interface Artifact {
     id: string;
     item_type: string;
     item_count: number;
+    [ArtifactDateField.OldestCreatedDate]?: string;
+    [ArtifactDateField.NewestCreatedDate]?: string;
+    [ArtifactDateField.OldestModifiedDate]?: string;
+    [ArtifactDateField.NewestModifiedDate]?: string;
 }
-/**
- * ArtifactsPrepareResponse is an interface that defines the structure of the response from the prepare artifacts endpoint.
- */
+export type ArtifactDateRanges = Pick<Artifact, ArtifactDateField.OldestCreatedDate | ArtifactDateField.NewestCreatedDate | ArtifactDateField.OldestModifiedDate | ArtifactDateField.NewestModifiedDate>;
+/** Response from the prepare artifacts endpoint. */
 export interface ArtifactsPrepareResponse {
     url: string;
     id: string;
@@ -36,9 +39,7 @@ export interface ArtifactsPrepareResponse {
         value: string;
     }[];
 }
-/**
- * ArtifactToUpload is an interface that defines the structure of the response from the get upload url endpoint.
- */
+/** Response from the get upload url endpoint. */
 export interface ArtifactToUpload {
     upload_url: string;
     artifact_id: string;
@@ -47,30 +48,19 @@ export interface ArtifactToUpload {
         value: string;
     }[];
 }
-/**
- * UploadResponse is an interface that defines the structure of the response from upload through Uploader.
- */
 export interface UploadResponse {
     artifact?: Artifact;
     error?: ErrorRecord;
 }
-/**
- * StreamAttachmentsResponse is an interface that defines the structure of the response from the stream attachments through Uploader.
- */
 export interface StreamAttachmentsResponse {
     ssorAttachments?: SsorAttachment[];
     error?: ErrorRecord;
 }
-/**
- * StreamResponse is an interface that defines the structure of the response from the stream of single attachment through Uploader.
- */
+/** Result of streaming a single attachment through Uploader. */
 export interface StreamResponse {
     ssorAttachment?: SsorAttachment;
     error?: ErrorRecord;
 }
-/**
- * SsorAttachment is an interface that defines the structure of the SSOR attachment.
- */
 export interface SsorAttachment {
     id: {
         devrev: string;

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

@@ -1 +1 @@
-{"version":3,"file":"uploader.interfaces.d.ts","sourceRoot":"","sources":["../../src/uploader/uploader.interfaces.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAC9C,OAAO,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AACnD,OAAO,EAAE,kBAAkB,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAC;AACvE,OAAO,EAAE,oBAAoB,EAAE,MAAM,kBAAkB,CAAC;AAExD,MAAM,WAAW,wBAAwB;IACvC,KAAK,EAAE,YAAY,CAAC;IACpB,OAAO,CAAC,EAAE,oBAAoB,CAAC;CAChC;AAED;;;GAGG;AACH,MAAM,MAAM,cAAc,CAAC,CAAC,IACxB;IAAE,QAAQ,EAAE,CAAC,CAAC;IAAC,KAAK,CAAC,EAAE,KAAK,CAAA;CAAE,GAC9B;IAAE,QAAQ,CAAC,EAAE,KAAK,CAAC;IAAC,KAAK,EAAE,OAAO,CAAA;CAAE,CAAC;AAEzC;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB,EAAE,EAAE,MAAM,CAAC;IACX,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC,GAAG,EAAE,MAAM,CAAC;IACZ,EAAE,EAAE,MAAM,CAAC;IACX,SAAS,EAAE;QACT,GAAG,EAAE,MAAM,CAAC;QACZ,KAAK,EAAE,MAAM,CAAC;KACf,EAAE,CAAC;CACL;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,UAAU,EAAE,MAAM,CAAC;IACnB,WAAW,EAAE,MAAM,CAAC;IACpB,SAAS,EAAE;QACT,GAAG,EAAE,MAAM,CAAC;QACZ,KAAK,EAAE,MAAM,CAAC;KACf,EAAE,CAAC;CACL;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,QAAQ,CAAC,EAAE,QAAQ,CAAC;IACpB,KAAK,CAAC,EAAE,WAAW,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC,eAAe,CAAC,EAAE,cAAc,EAAE,CAAC;IACnC,KAAK,CAAC,EAAE,WAAW,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,cAAc,CAAC,EAAE,cAAc,CAAC;IAChC,KAAK,CAAC,EAAE,WAAW,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,EAAE,EAAE;QACF,MAAM,EAAE,MAAM,CAAC;QACf,QAAQ,EAAE,MAAM,CAAC;KAClB,CAAC;IACF,SAAS,EAAE;QACT,QAAQ,EAAE,MAAM,CAAC;KAClB,CAAC;IACF,QAAQ,CAAC,EAAE;QACT,QAAQ,EAAE,MAAM,CAAC;KAClB,CAAC;IACF,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,WAAW,iBAAiB;IAChC,KAAK,CAAC,EAAE,WAAW,CAAC;IACpB,SAAS,CAAC,EAAE,eAAe,EAAE,CAAC;CAC/B;AAED,MAAM,WAAW,uBAAuB;IACtC,KAAK,CAAC,EAAE,WAAW,CAAC;IACpB,eAAe,CAAC,EAAE,kBAAkB,EAAE,CAAC;CACxC"}
+{"version":3,"file":"uploader.interfaces.d.ts","sourceRoot":"","sources":["../../src/uploader/uploader.interfaces.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAC9C,OAAO,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AACnD,OAAO,EAAE,kBAAkB,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAC;AACvE,OAAO,EAAE,oBAAoB,EAAE,MAAM,kBAAkB,CAAC;AAExD,MAAM,WAAW,wBAAwB;IACvC,KAAK,EAAE,YAAY,CAAC;IACpB,OAAO,CAAC,EAAE,oBAAoB,CAAC;CAChC;AAED,MAAM,MAAM,cAAc,CAAC,CAAC,IACxB;IAAE,QAAQ,EAAE,CAAC,CAAC;IAAC,KAAK,CAAC,EAAE,KAAK,CAAA;CAAE,GAC9B;IAAE,QAAQ,CAAC,EAAE,KAAK,CAAC;IAAC,KAAK,EAAE,OAAO,CAAA;CAAE,CAAC;AAEzC,oBAAY,iBAAiB;IAC3B,iBAAiB,wBAAwB;IACzC,iBAAiB,wBAAwB;IACzC,kBAAkB,yBAAyB;IAC3C,kBAAkB,yBAAyB;CAC5C;AAED,iEAAiE;AACjE,MAAM,WAAW,QAAQ;IACvB,EAAE,EAAE,MAAM,CAAC;IACX,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,MAAM,CAAC;IACnB,CAAC,iBAAiB,CAAC,iBAAiB,CAAC,CAAC,EAAE,MAAM,CAAC;IAC/C,CAAC,iBAAiB,CAAC,iBAAiB,CAAC,CAAC,EAAE,MAAM,CAAC;IAC/C,CAAC,iBAAiB,CAAC,kBAAkB,CAAC,CAAC,EAAE,MAAM,CAAC;IAChD,CAAC,iBAAiB,CAAC,kBAAkB,CAAC,CAAC,EAAE,MAAM,CAAC;CACjD;AAED,MAAM,MAAM,kBAAkB,GAAG,IAAI,CACnC,QAAQ,EACN,iBAAiB,CAAC,iBAAiB,GACnC,iBAAiB,CAAC,iBAAiB,GACnC,iBAAiB,CAAC,kBAAkB,GACpC,iBAAiB,CAAC,kBAAkB,CACvC,CAAC;AAEF,oDAAoD;AACpD,MAAM,WAAW,wBAAwB;IACvC,GAAG,EAAE,MAAM,CAAC;IACZ,EAAE,EAAE,MAAM,CAAC;IACX,SAAS,EAAE;QACT,GAAG,EAAE,MAAM,CAAC;QACZ,KAAK,EAAE,MAAM,CAAC;KACf,EAAE,CAAC;CACL;AAED,iDAAiD;AACjD,MAAM,WAAW,gBAAgB;IAC/B,UAAU,EAAE,MAAM,CAAC;IACnB,WAAW,EAAE,MAAM,CAAC;IACpB,SAAS,EAAE;QACT,GAAG,EAAE,MAAM,CAAC;QACZ,KAAK,EAAE,MAAM,CAAC;KACf,EAAE,CAAC;CACL;AAED,MAAM,WAAW,cAAc;IAC7B,QAAQ,CAAC,EAAE,QAAQ,CAAC;IACpB,KAAK,CAAC,EAAE,WAAW,CAAC;CACrB;AAED,MAAM,WAAW,yBAAyB;IACxC,eAAe,CAAC,EAAE,cAAc,EAAE,CAAC;IACnC,KAAK,CAAC,EAAE,WAAW,CAAC;CACrB;AAED,gEAAgE;AAChE,MAAM,WAAW,cAAc;IAC7B,cAAc,CAAC,EAAE,cAAc,CAAC;IAChC,KAAK,CAAC,EAAE,WAAW,CAAC;CACrB;AAED,MAAM,WAAW,cAAc;IAC7B,EAAE,EAAE;QACF,MAAM,EAAE,MAAM,CAAC;QACf,QAAQ,EAAE,MAAM,CAAC;KAClB,CAAC;IACF,SAAS,EAAE;QACT,QAAQ,EAAE,MAAM,CAAC;KAClB,CAAC;IACF,QAAQ,CAAC,EAAE;QACT,QAAQ,EAAE,MAAM,CAAC;KAClB,CAAC;IACF,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,WAAW,iBAAiB;IAChC,KAAK,CAAC,EAAE,WAAW,CAAC;IACpB,SAAS,CAAC,EAAE,eAAe,EAAE,CAAC;CAC/B;AAED,MAAM,WAAW,uBAAuB;IACtC,KAAK,CAAC,EAAE,WAAW,CAAC;IACpB,eAAe,CAAC,EAAE,kBAAkB,EAAE,CAAC;CACxC"}