@fnndsc/cumin 3.2.4

package/dist/pacs/chrisPACS.d.ts

@@ -0,0 +1,200 @@
+/**
+ * @file ChRIS PACS Management
+ *
+ * Provides helpers to list PACS servers that the current CUBE knows about.
+ *
+ * @module
+ */
+import { Result } from "../utils/result.js";
+import { ChRISResourceGroup } from "../resources/chrisResourceGroup.js";
+import { FilteredResourceData, ListOptions } from "../resources/chrisResources.js";
+/**
+ * Minimal shape of a PACS server as returned by the ChRIS API.
+ */
+export interface PACSServer {
+    id: number;
+    identifier?: string;
+    name?: string;
+    description?: string;
+    [key: string]: unknown;
+}
+/**
+ * Options for listing PACS servers (passed directly to the API).
+ */
+export interface PACSServerListOptions {
+    identifier?: string;
+    limit?: number;
+    offset?: number;
+    [key: string]: unknown;
+}
+/**
+ * Group handler for PACS servers.
+ */
+export declare class ChRISPACSGroup extends ChRISResourceGroup {
+    constructor();
+}
+/**
+ * Minimal shape of a PACS query record.
+ */
+export interface PACSQueryRecord {
+    id: number;
+    title?: string;
+    status?: string;
+    pacs_id?: number;
+    result?: unknown;
+    [key: string]: unknown;
+}
+/**
+ * Options for listing PACS queries.
+ */
+export interface PACSQueryListOptions extends ListOptions {
+    pacs_id?: number;
+    pacs_identifier?: string;
+}
+/**
+ * Group handler for PACS queries.
+ */
+export declare class ChRISPACSQueryGroup extends ChRISResourceGroup {
+    constructor();
+}
+/**
+ * Resolve a PACS server identifier or ID to an ID and identifier.
+ *
+ * @param pacsserver - Numeric ID or identifier string.
+ * @returns Result containing { id, identifier? } or Err on failure/ambiguity.
+ */
+export declare function pacsServer_resolve(pacsserver: string): Promise<Result<{
+    id: number;
+    identifier?: string;
+}>>;
+/**
+ * Fetch all PACS servers visible to the current ChRIS connection.
+ *
+ * @param options - Optional search/pagination parameters (identifier, limit, offset).
+ * @returns Result containing an array of PACS server records, or Err on failure.
+ */
+export declare function pacsServers_list(options?: PACSServerListOptions): Promise<Result<PACSServer[]>>;
+/**
+ * List PACS queries with optional filtering.
+ *
+ * @param options - Search/pagination options (pacs_id, pacs_identifier, limit, offset, etc.).
+ * @returns Result containing filtered resource data or Err.
+ */
+export declare function pacsQueries_list(options?: PACSQueryListOptions): Promise<Result<FilteredResourceData | null>>;
+/**
+ * Data needed to create a PACS query.
+ */
+export interface PACSQueryCreateData {
+    title: string;
+    query: string;
+    description?: string;
+    execute?: boolean;
+}
+/**
+ * Create a PACS query against a specific PACS server.
+ *
+ * @param pacsserver - PACS server ID or identifier.
+ * @param data - Query creation data (title, query JSON string, optional description).
+ * @returns Result containing a PACSQueryRecord or Err.
+ */
+export declare function pacsQueries_create(pacsserver: string, data: PACSQueryCreateData): Promise<Result<PACSQueryRecord>>;
+/**
+ * Decoded PACS query result payload.
+ */
+export interface PACSQueryDecodedResult {
+    raw: string;
+    base64Decoded?: Buffer;
+    zlibDecoded?: Buffer;
+    gzipDecoded?: Buffer;
+    text?: string;
+    json?: unknown;
+}
+/**
+ * Attempt to decode a PACS query result payload.
+ *
+ * @param queryId - PACS query ID.
+ * @returns Result containing decoded forms (raw, decoded buffers, text, optional JSON) or Err on failure.
+ */
+export declare function pacsQuery_resultDecode(queryId: number): Promise<Result<PACSQueryDecodedResult>>;
+/**
+ * Fetch a single PACS query record by ID.
+ *
+ * @param queryId - PACS query ID.
+ * @returns Result containing a PACSQueryRecord (with current status/result) or Err.
+ */
+export declare function pacsQuery_get(queryId: number): Promise<Result<PACSQueryRecord>>;
+/**
+ * Minimal shape of a PACS retrieve record.
+ */
+export interface PACSRetrieveRecord {
+    id: number;
+    pacs_query_id?: number;
+    status?: string;
+    creation_date?: string;
+    [key: string]: unknown;
+}
+/**
+ * Group handler for PACS retrieves.
+ */
+export declare class ChRISPACSRetrieveGroup extends ChRISResourceGroup {
+    constructor();
+}
+/**
+ * Create a PACS retrieve for a given query.
+ * This triggers the external service to pull DICOM data from PACS to ChRIS.
+ *
+ * @param queryId - PACS query ID to retrieve data for.
+ * @returns Result containing a PACSRetrieveRecord or Err.
+ */
+export declare function pacsRetrieve_create(queryId: number): Promise<Result<PACSRetrieveRecord>>;
+/**
+ * List all retrieves for a given PACS query.
+ *
+ * @param queryId - PACS query ID.
+ * @param options - Optional list options.
+ * @returns Result containing an array of PACSRetrieveRecord or Err.
+ */
+export declare function pacsRetrieves_list(queryId: number, options?: ListOptions): Promise<Result<PACSRetrieveRecord[]>>;
+/**
+ * Delete (cancel) a PACS retrieve.
+ *
+ * @param retrieveId - PACS retrieve ID to delete.
+ * @returns Result containing void or Err.
+ */
+export declare function pacsRetrieve_delete(retrieveId: number): Promise<Result<void>>;
+/**
+ * Status of a single series in the retrieve process.
+ */
+export interface SeriesRetrieveStatus {
+    seriesInfo: Record<string, unknown>;
+    seriesInstanceUID: string;
+    seriesDescription?: string;
+    expectedFiles: number;
+    actualFiles: number;
+    status: "pending" | "pulling" | "pulled" | "error";
+}
+/**
+ * Study with series status information.
+ */
+export interface StudyRetrieveStatus {
+    studyInfo: Record<string, unknown>;
+    studyInstanceUID?: string;
+    studyDescription?: string;
+    series: SeriesRetrieveStatus[];
+}
+/**
+ * Complete retrieve status report for a query.
+ */
+export interface PACSQueryStatusReport {
+    queryId: number;
+    retrieveStatus?: string;
+    retrieveId?: number;
+    studies: StudyRetrieveStatus[];
+}
+/**
+ * Reports the retrieve status for a PACS query.
+ *
+ * @param queryId - ID of the PACS query to inspect.
+ * @returns Result wrapping the status report, or Err on failure.
+ */
+export declare function pacsRetrieve_statusForQuery(queryId: number): Promise<Result<PACSQueryStatusReport>>;