cod-dicomweb-server 1.0.0 → 1.0.2

package/dist/fileManager.ts

@@ -1,84 +0,0 @@
-import type { FileManagerOptions } from './types';
-import { getWebWorkerManager } from './webWorker/workerManager';
-
-class FileManager {
-  private files: Record<string, { data: Uint8Array; position: number }> = {};
-  private fileStreamingWorkerName: string;
-
-  constructor({ fileStreamingWorkerName }: FileManagerOptions) {
-    this.fileStreamingWorkerName = fileStreamingWorkerName;
-  }
-
-  set(url: string, file: { data: Uint8Array; position: number }): void {
-    this.files[url] = file;
-  }
-
-  get(
-    url: string,
-    offsets?: { startByte: number; endByte: number },
-  ): Uint8Array | null {
-    if (
-      !this.files[url] ||
-      (offsets && this.files[url].position <= offsets.endByte)
-    ) {
-      return null;
-    }
-
-    return offsets
-      ? this.files[url].data.slice(offsets.startByte, offsets.endByte)
-      : this.files[url].data;
-  }
-
-  setPosition(url: string, position: number): void {
-    if (this.files[url]) {
-      this.files[url].position = position;
-    }
-  }
-
-  getPosition(url: string): number {
-    return this.files[url]?.position;
-  }
-
-  append(url: string, chunk: Uint8Array, position: number): void {
-    if (this.files[url] && position) {
-      this.files[url].data.set(chunk, position - chunk.length);
-      this.setPosition(url, position);
-    }
-  }
-
-  getTotalSize(): number {
-    return Object.entries(this.files).reduce((total, [url, { position }]) => {
-      return url.includes('?bytes=') ? total : total + position;
-    }, 0);
-  }
-
-  remove(url: string): void {
-    const removedSize = this.getPosition(url);
-    delete this.files[url];
-
-    if (url.includes('?bytes=')) {
-      return;
-    }
-
-    const workerManager = getWebWorkerManager();
-    workerManager.executeTask(
-      this.fileStreamingWorkerName,
-      'decreaseFetchedSize',
-      removedSize,
-    );
-  }
-
-  purge(): void {
-    const totalSize = this.getTotalSize();
-    this.files = {};
-
-    const workerManager = getWebWorkerManager();
-    workerManager.executeTask(
-      this.fileStreamingWorkerName,
-      'decreaseFetchedSize',
-      totalSize,
-    );
-  }
-}
-
-export default FileManager;

package/dist/index.ts

@@ -1,5 +0,0 @@
-import { FetchType } from './constants/enums';
-import CodDicomWebServer from './classes/CodDicomWebServer';
-
-export { FetchType, CodDicomWebServer };
-export default { FetchType, CodDicomWebServer };

package/dist/metadataManager.ts

@@ -1,32 +0,0 @@
-import { createMetadataJsonUrl } from './classes/utils';
-import type { JsonMetadata, MetadataUrlCreationParams } from './types';
-
-const metadata: Record<string, JsonMetadata> = {};
-
-export async function getMetadata(
-  params: MetadataUrlCreationParams,
-  headers: Record<string, string>,
-): Promise<JsonMetadata | null> {
-  const url = createMetadataJsonUrl(params);
-
-  if (!url) {
-    throw new Error('Error creating metadata json url');
-  }
-
-  if (metadata[url]) {
-    return metadata[url];
-  }
-
-  try {
-    const response = await fetch(url, { headers });
-    if (!response.ok) {
-      throw new Error(`Failed to fetch metadata: ${response.statusText}`);
-    }
-    const data = await response.json();
-    metadata[url] = data;
-    return data;
-  } catch (error) {
-    console.error(error);
-    throw error;
-  }
-}

package/dist/types/codDicomWebServerOptions.ts

@@ -1,7 +0,0 @@
-type CodDicomWebServerOptions = {
-  [key: string]: number | string;
-  maxWorkerFetchSize: number;
-  domain: string;
-};
-
-export type { CodDicomWebServerOptions };

package/dist/types/fileManagerOptions.ts

@@ -1,3 +0,0 @@
-type FileManagerOptions = { fileStreamingWorkerName: string };
-
-export type { FileManagerOptions };

package/dist/types/index.ts

@@ -1,7 +0,0 @@
-export type * from './codDicomWebServerOptions';
-export type * from './fileManagerOptions';
-export type * from './metadata';
-export type * from './metadataUrlCreationParams';
-export type * from './parsedWadoRsUrlDetails';
-export type * from './requestOptions';
-export type * from './workerCustomMessageEvents';

package/dist/types/metadata.ts

@@ -1,57 +0,0 @@
-/**
- * Metadata format stored in the metadata.json
- */
-type JsonMetadata = {
-  deid_study_uid: string;
-  deid_series_uid: string;
-  cod: {
-    instances: Record<
-      string,
-      {
-        metadata: InstanceMetadata;
-        // The metadata will either have url or uri
-        uri: string;
-        url: string;
-        headers: { start_byte: number; end_byte: number };
-        offset_tables: {
-          CustomOffsetTable?: number[];
-          CustomOffsetTableLengths?: number[];
-        };
-        crc32c: string;
-        size: number;
-        original_path: string;
-        dependencies: string[];
-        diff_hash_dupe_paths: [string];
-        version: string;
-        modified_datetime: string;
-      }
-    >;
-  };
-  thumbnail: {
-    version: string;
-    uri: string;
-    thumbnail_index_to_instance_frame: [string, number][];
-    instances: Record<
-      string,
-      {
-        frames: {
-          thumbnail_index: number;
-          anchors: {
-            original_size: { width: number; height: number };
-            thumbnail_upper_left: { row: number; col: number };
-            thumbnail_bottom_right: { row: number; col: number };
-          };
-        }[];
-      }
-    >;
-  };
-};
-
-type InstanceMetadata = Record<
-  string,
-  { vr: string; Value?: unknown[]; BulkDataURI?: string; InlineBinary?: string }
->;
-
-type SeriesMetadata = InstanceMetadata[];
-
-export type { InstanceMetadata, SeriesMetadata, JsonMetadata };

package/dist/types/metadataUrlCreationParams.ts

@@ -1,9 +0,0 @@
-type MetadataUrlCreationParams = {
-  domain?: string;
-  bucketName: string;
-  bucketPrefix: string;
-  studyInstanceUID: string;
-  seriesInstanceUID: string;
-};
-
-export type { MetadataUrlCreationParams };

package/dist/types/parsedWadoRsUrlDetails.ts

@@ -1,13 +0,0 @@
-import type { Enums } from '../constants';
-
-type ParsedWadoRsUrlDetails = {
-  type: Enums.RequestType;
-  bucketName: string;
-  bucketPrefix: string;
-  studyInstanceUID: string;
-  seriesInstanceUID: string;
-  sopInstanceUID: string;
-  frameNumber: number;
-};
-
-export type { ParsedWadoRsUrlDetails };

package/dist/types/requestOptions.ts

@@ -1,12 +0,0 @@
-import { Enums } from '../constants';
-
-type CODRequestOptions = {
-  useSharedArrayBuffer?: boolean;
-  fetchType?: Enums.FetchType;
-};
-
-type FileRequestOptions = CODRequestOptions & {
-  offsets?: { startByte: number; endByte: number };
-};
-
-export type { CODRequestOptions, FileRequestOptions };

package/dist/types/workerCustomMessageEvents.ts

@@ -1,11 +0,0 @@
-interface FileStreamingMessageEvent extends MessageEvent {
-  data: {
-    url: string;
-    position: number;
-    chunk?: Uint8Array;
-    isAppending?: boolean;
-    fileArraybuffer?: Uint8Array;
-  };
-}
-
-export type { FileStreamingMessageEvent };

package/dist/webWorker/registerWorker.ts

@@ -1,33 +0,0 @@
-import { getWebWorkerManager } from './workerManager';
-
-export function registerWorkers(
-  workerNames: {
-    fileStreamingWorkerName: string;
-    filePartialWorkerName: string;
-  },
-  maxFetchSize: number,
-): void {
-  const { fileStreamingWorkerName, filePartialWorkerName } = workerNames;
-  const workerManager = getWebWorkerManager();
-
-  // fileStreaming worker
-  const streamingWorkerFn = (): Worker =>
-    new Worker(new URL('./workers/fileStreaming.ts', import.meta.url), {
-      name: fileStreamingWorkerName,
-    });
-
-  workerManager.registerWorker(fileStreamingWorkerName, streamingWorkerFn);
-  workerManager.executeTask(
-    fileStreamingWorkerName,
-    'setMaxFetchSize',
-    maxFetchSize,
-  );
-
-  // filePartial worker
-  const partialWorkerFn = (): Worker =>
-    new Worker(new URL('./workers/filePartial.ts', import.meta.url), {
-      name: filePartialWorkerName,
-    });
-
-  workerManager.registerWorker(filePartialWorkerName, partialWorkerFn);
-}

package/dist/webWorker/workerManager.ts

@@ -1,83 +0,0 @@
-import { type Remote, wrap } from 'comlink';
-
-import type { FileStreamingMessageEvent } from '../types';
-
-class WebWorkerManager {
-  private workerRegistry: Record<
-    string,
-    { instance: Remote<Worker>; nativeWorker: Worker }
-  > = {};
-
-  public registerWorker(name: string, workerFn: () => Worker): void {
-    try {
-      const worker: Worker = workerFn();
-      if (!worker) {
-        return;
-      }
-
-      this.workerRegistry[name] = {
-        instance: wrap(worker),
-        nativeWorker: worker,
-      };
-    } catch (error) {
-      console.warn(error);
-    }
-  }
-
-  public async executeTask(
-    workerName: string,
-    taskName: string,
-    options: Record<string, unknown> | unknown,
-  ): Promise<void | ArrayBufferLike> {
-    const worker = this.workerRegistry[workerName]?.instance;
-    if (!worker) {
-      throw new Error(`Worker ${workerName} not registered`);
-    }
-
-    try {
-      // eslint-disable-next-line @typescript-eslint/ban-ts-comment
-      // @ts-ignore
-      return await worker[taskName](options);
-    } catch (error) {
-      console.error(
-        `Error executing task "${taskName}" on worker "${workerName}":`,
-        error,
-      );
-      throw new Error(`Task "${taskName}" failed: ${(error as Error).message}`);
-    }
-  }
-
-  public addEventListener(
-    workerName: string,
-    eventType: keyof WorkerEventMap,
-    listener: (evt: FileStreamingMessageEvent | ErrorEvent) => unknown,
-  ): void {
-    const worker = this.workerRegistry[workerName];
-    if (!worker) {
-      console.error(`Worker type '${workerName}' is not registered.`);
-      return;
-    }
-
-    worker.nativeWorker.addEventListener(eventType, listener);
-  }
-
-  public removeEventListener(
-    workerName: string,
-    eventType: keyof WorkerEventMap,
-    listener: (evt: FileStreamingMessageEvent | ErrorEvent) => unknown,
-  ): void {
-    const worker = this.workerRegistry[workerName];
-    if (!worker) {
-      console.error(`Worker type '${workerName}' is not registered.`);
-      return;
-    }
-
-    worker.nativeWorker.removeEventListener(eventType, listener);
-  }
-}
-
-const webWorkerManager = new WebWorkerManager();
-
-export function getWebWorkerManager(): WebWorkerManager {
-  return webWorkerManager;
-}

package/dist/webWorker/workers/filePartial.ts

@@ -1,20 +0,0 @@
-import { expose } from 'comlink';
-
-const filePartial = {
-  async partial(args: {
-    url: string;
-    headers?: Record<string, string>;
-  }): Promise<ArrayBufferLike | Error> {
-    const { url, headers } = args;
-
-    return fetch(url, { headers })
-      .then((response) => response.arrayBuffer())
-      .catch((error) => {
-        throw new Error(
-          'filePartial.ts: Error when fetching file: ' + error?.message,
-        );
-      });
-  },
-};
-
-expose(filePartial);

package/dist/webWorker/workers/fileStreaming.ts

@@ -1,130 +0,0 @@
-import { expose } from 'comlink';
-
-const fileStreaming = {
-  maxFetchSize: 0,
-  fetchedSize: 0,
-
-  setMaxFetchSize(size: number): void {
-    if (size > 0) {
-      this.maxFetchSize = size;
-    }
-  },
-
-  decreaseFetchedSize(size: number): void {
-    if (size > 0 && size <= this.fetchedSize) {
-      this.fetchedSize -= size;
-    }
-  },
-
-  async stream(args: {
-    url: string;
-    headers?: Record<string, string>;
-    useSharedArrayBuffer?: boolean;
-  }): Promise<void> {
-    const { url, headers, useSharedArrayBuffer } = args;
-    const controller = new AbortController();
-    let sharedArraybuffer: SharedArrayBuffer | null = null;
-    let fileArraybuffer: Uint8Array | null = null;
-
-    try {
-      const response = await fetch(url, {
-        headers: { ...headers },
-        signal: controller.signal,
-      });
-
-      if (!response.ok) {
-        throw new Error(`HTTP error! status: ${response.status}`);
-      }
-
-      const reader = response.body?.getReader();
-      if (!reader) {
-        throw new Error('Failed to get reader from response body');
-      }
-
-      let result: ReadableStreamReadResult<Uint8Array>;
-      let completed = false;
-      const totalLength = parseInt(
-        response.headers.get('Content-Length') || '0',
-        10,
-      );
-      const firstChunk = await reader.read();
-      completed = firstChunk.done;
-
-      if (!firstChunk.value) {
-        throw new Error('The fetched chunks does not have value');
-      }
-
-      if (!completed) {
-        let position = firstChunk.value.length;
-
-        if (
-          this.maxFetchSize &&
-          this.fetchedSize + position > this.maxFetchSize
-        ) {
-          controller.abort();
-          throw new Error(
-            `Maximum size(${this.maxFetchSize}) for fetching files reached`,
-          );
-        }
-
-        this.fetchedSize += position;
-
-        if (useSharedArrayBuffer) {
-          sharedArraybuffer = new SharedArrayBuffer(totalLength);
-          fileArraybuffer = new Uint8Array(sharedArraybuffer);
-        } else {
-          fileArraybuffer = new Uint8Array(totalLength);
-        }
-        fileArraybuffer.set(firstChunk.value);
-        postMessage({ url, position, fileArraybuffer });
-
-        while (!completed) {
-          result = await reader.read();
-
-          if (result.done) {
-            completed = true;
-            continue;
-          }
-
-          const chunk = result.value;
-
-          if (
-            this.maxFetchSize &&
-            this.fetchedSize + chunk.length > this.maxFetchSize
-          ) {
-            sharedArraybuffer = null;
-            fileArraybuffer = null;
-            controller.abort();
-            throw new Error(
-              `Maximum size(${this.maxFetchSize}) for fetching files reached`,
-            );
-          }
-
-          this.fetchedSize += chunk.length;
-          fileArraybuffer.set(chunk, position);
-          position += chunk.length;
-
-          postMessage({
-            isAppending: true,
-            url,
-            position: position,
-            chunk: !useSharedArrayBuffer ? chunk : null,
-          });
-        }
-      }
-    } catch (error) {
-      const streamingError = new Error(
-        'fileStreaming.ts: ' + (error as Error).message ||
-          'An error occured when streaming',
-      );
-      console.error(streamingError.message, error);
-      throw streamingError;
-    } finally {
-      sharedArraybuffer = null;
-      fileArraybuffer = null;
-      controller.abort();
-    }
-  },
-};
-
-expose(fileStreaming);