dicom-synth 1.0.1 → 1.2.0

package/dist/types/index.d.ts

@@ -1,5 +1,5 @@
-export { writeFakeDicomSignatureFile, writeNonDicomFile, } from './negativeCases/index';
-export { buildDicomdirBuffer, writeDicomdirFile, } from './nonStandardDicom/dicomdir';
-export { defaultPublicCasesPath, loadCaseById, loadCasesFromJson, loadDefaultCases, type PublicCaseRecord, type PublicCaseSource, } from './public-fixtures/catalog';
-export { caseCachePath, fetchPublicCaseToCache, verifySha256, } from './public-fixtures/fetch';
-export { buildDicomDict, buildSyntheticCtBuffer, type MinimalDicomTags, SYNTHETIC_FIXTURES, type SyntheticCtVariant, writeMinimalDicomFile, writeSyntheticFixturesToDir, } from './syntheticFixtures/generator';
+export { type CollectionManifest, type GeneratedFile, generateCollectionFromSpec, generateFile, writeCollectionFromSpec, } from './collection/writer.js';
+export { defaultPublicCasesPath, loadCaseById, loadCasesFromJson, loadDefaultCases, type PublicCaseRecord, type PublicCaseSource, } from './public-fixtures/catalog.js';
+export { caseCachePath, fetchPublicCaseToCache, verifySha256, } from './public-fixtures/fetch.js';
+export type { DatasetLayout, DatasetSpec, DicomdirSpec, DicomTagOverrides, FakeSignatureSpec, FileSpec, ImageSpec, InvalidUidCtSpec, LargeCtSpec, NonDicomSpec, SeriesEntrySpec, SeriesSpec, StudySpec, TransferSyntax, ValidCtSpec, VendorCtSpec, ViolationClass, } from './schema/types.js';
+export { validateDatasetSpec } from './schema/validate.js';

package/dist/types/schema/types.d.ts

@@ -0,0 +1,64 @@
+export type TransferSyntax = 'explicit-vr-little-endian' | 'implicit-vr-little-endian';
+export type DicomTagOverrides = {
+    PatientID?: string;
+    PatientName?: string;
+    StudyDescription?: string;
+    SeriesDescription?: string;
+    [tag: string]: unknown;
+};
+export type ViolationClass = 'uid-too-long' | 'non-conformant-uid' | 'missing-meta-header' | 'malformed-sq-delimiter' | 'vr-max-length-exceeded' | 'missing-type1-tag';
+type BaseCtSpec = {
+    tags?: DicomTagOverrides;
+    transferSyntax?: TransferSyntax;
+    violations?: ViolationClass[];
+};
+export type ValidCtSpec = BaseCtSpec & {
+    type: 'valid-ct';
+};
+export type InvalidUidCtSpec = BaseCtSpec & {
+    type: 'invalid-uid-ct';
+};
+export type VendorCtSpec = BaseCtSpec & {
+    type: 'vendor-warnings-ct';
+};
+export type LargeCtSpec = BaseCtSpec & {
+    type: 'large-ct';
+    rows: number;
+    columns: number;
+    frames?: number;
+};
+export type FakeSignatureSpec = {
+    type: 'fake-signature';
+};
+export type NonDicomSpec = {
+    type: 'non-dicom';
+    content?: string;
+};
+export type DicomdirSpec = {
+    type: 'dicomdir';
+};
+export type ImageSpec = ValidCtSpec | InvalidUidCtSpec | VendorCtSpec | LargeCtSpec;
+export type FileSpec = ImageSpec | FakeSignatureSpec | NonDicomSpec | DicomdirSpec;
+export type EntrySpec = FileSpec & {
+    count?: number;
+};
+export type SeriesEntrySpec = ImageSpec & {
+    count?: number;
+};
+export type SeriesSpec = {
+    entries: SeriesEntrySpec[];
+    tags?: DicomTagOverrides;
+};
+export type StudySpec = {
+    series: SeriesSpec[];
+    tags?: DicomTagOverrides;
+    count?: number;
+};
+export type DatasetLayout = 'flat' | 'hierarchical';
+export type DatasetSpec = {
+    entries?: EntrySpec[];
+    studies?: StudySpec[];
+    seed?: number;
+    layout?: DatasetLayout;
+};
+export {};

package/dist/types/schema/validate.d.ts

@@ -0,0 +1,3 @@
+import type { DatasetSpec } from './types.js';
+export declare const HEX_TAG_RE: RegExp;
+export declare function validateDatasetSpec(raw: unknown): DatasetSpec;

package/dist/types/syntheticFixtures/generator.d.ts

@@ -1,27 +1,3 @@
-import type * as Dcmjs from 'dcmjs';
-export type SyntheticCtVariant = 'minimal-invalid-uid' | 'valid-uid' | 'vendor-warnings';
-export declare function buildDicomDict(variant: SyntheticCtVariant): Dcmjs.data.DicomDict;
-export declare function buildSyntheticCtBuffer(variant: SyntheticCtVariant): Buffer;
-export declare const SYNTHETIC_FIXTURES: {
-    filename: string;
-    variant: SyntheticCtVariant;
-    description: string;
-}[];
-export type MinimalDicomTags = {
-    patientId?: string;
-    patientName?: string;
-    sopInstanceUid?: string;
-};
-/**
- * Write a minimal CT DICOM file to `filePath`.
- *
- * The output is intentionally bare: it contains no Part 10 group-0002
- * file-meta header (no MediaStorageSOPClassUID, TransferSyntaxUID, etc.).
- * Use `buildDicomDict` / `buildSyntheticCtBuffer` when a conformant
- * Part 10 file with a complete meta header is required.
- *
- * The parent directory is created if it does not exist.
- */
-export declare function writeMinimalDicomFile(filePath: string, tags?: MinimalDicomTags): void;
-/** Write all catalogue fixtures to a directory (created if missing). */
-export declare function writeSyntheticFixturesToDir(outDir: string): string[];
+import type { FileSpec } from '../schema/types.js';
+import type { UidSet } from './uid.js';
+export declare function buildBufferForSpec(spec: FileSpec, uid: UidSet): Buffer;

package/dist/types/syntheticFixtures/uid.d.ts

@@ -0,0 +1,12 @@
+export type UidSet = {
+    study: string;
+    series: string;
+    sop: string;
+};
+export type GroupUidGenerator = {
+    study: (studyIndex: number) => string;
+    series: (studyIndex: number, seriesIndex: number) => string;
+};
+export declare function makeGroupUidGenerator(seed?: number): GroupUidGenerator;
+export type UidGenerator = (fileIndex: number) => UidSet;
+export declare function makeUidGenerator(seed?: number): UidGenerator;

package/dist/types/syntheticFixtures/violations.d.ts

@@ -0,0 +1,2 @@
+import type { ViolationClass } from '../schema/types.js';
+export declare function applyViolations(buffer: Buffer, violations: ViolationClass[]): Buffer;

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "dicom-synth",
-  "version": "1.0.1",
+  "version": "1.2.0",
   "description": "Toolkit for synthetic DICOM fixtures and public fixture fetch/cache.",
   "license": "Apache-2.0",
   "type": "module",
-  "packageManager": "pnpm@11.3.0",
+  "packageManager": "pnpm@11.5.2",
   "repository": {
     "type": "git",
     "url": "https://github.com/clintools/dicom-synth.git"
@@ -22,7 +22,7 @@
   "module": "dist/esm/index.js",
   "types": "dist/types/index.d.ts",
   "bin": {
-    "dicom-synth-write": "./bin/dicom-synth-write.mjs",
+    "dicom-synth-generate": "./bin/dicom-synth-generate.mjs",
     "dicom-synth-fetch": "./bin/dicom-synth-fetch.mjs"
   },
   "exports": {

package/bin/dicom-synth-write.mjs

@@ -1,9 +0,0 @@
-#!/usr/bin/env node
-import { resolve } from 'node:path'
-import { writeSyntheticFixturesToDir } from '../dist/esm/index.js'
-
-const outDir = resolve(process.argv[2] ?? './fixtures/synthetic')
-const paths = writeSyntheticFixturesToDir(outDir)
-for (const p of paths) {
-  console.log(`wrote ${p}`)
-}

package/dist/esm/negativeCases/index.js

@@ -1,17 +0,0 @@
-// src/negativeCases/index.ts
-import { mkdirSync, writeFileSync } from "node:fs";
-import { resolve } from "node:path";
-function writeFakeDicomSignatureFile(filePath) {
-  const buf = Buffer.alloc(200, 0);
-  buf.write("XXXX", 128, 4, "ascii");
-  mkdirSync(resolve(filePath, ".."), { recursive: true });
-  writeFileSync(filePath, buf);
-}
-function writeNonDicomFile(filePath, content = "not dicom") {
-  mkdirSync(resolve(filePath, ".."), { recursive: true });
-  writeFileSync(filePath, content);
-}
-export {
-  writeFakeDicomSignatureFile,
-  writeNonDicomFile
-};

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

@@ -1,11 +0,0 @@
-/**
- * Write a file large enough to pass size checks but with `XXXX` at
- * offset 128 instead of the `DICM` magic bytes.
- * The parent directory is created if it does not exist.
- */
-export declare function writeFakeDicomSignatureFile(filePath: string): void;
-/**
- * Write arbitrary non-DICOM content to `filePath`.
- * The parent directory is created if it does not exist.
- */
-export declare function writeNonDicomFile(filePath: string, content?: string): void;