gdc-common-utils-ts 1.0.4 → 1.0.7

package/{src/models/bundle.ts → dist/models/bundle.d.ts}

@@ -23,70 +23,55 @@
  *                   contains the structured data derived from the claims.
  *     - `request`/`response`: Contextual objects indicating the operation's details or result.
  */
-
 import { OperationOutcome } from "./operation-outcome";
-
-// ===================================================================================
-// BUNDLE ENTRY COMPONENTS
-// ===================================================================================
-
 /**
  * Defines the `request` property for an entry in a request Bundle.
  * This indicates the intended action for the entry.
  */
 export interface BundleRequest {
-  method: 'POST' | 'PUT' | 'DELETE' | 'GET';
-  url: string;
+    method: 'POST' | 'PUT' | 'DELETE' | 'GET';
+    url: string;
 }
-
 /**
  * Defines the `response` property for an entry in a response Bundle.
  * This indicates the outcome of the action for the entry.
  */
 export interface BundleResponse {
-  /** The HTTP status code as a string (e.g., "201", "404"). */
-  status: string;
-  [key: string]: any;
+    /** The HTTP status code as a string (e.g., "201", "404"). */
+    status: string;
+    [key: string]: any;
 }
-
 /**
  * Defines the `meta` property that holds the original, unprocessed claims for a BundleEntry.
  * This ensures that the complete context of a request is preserved through the entire
  * asynchronous workflow and is available for error reporting.
  */
 export interface BundleEntryMeta {
-  /** The original, flattened claims record for this specific entry. */
-  claims?: Record<string, any>;
+    /** The original, flattened claims record for this specific entry. */
+    claims?: Record<string, any>;
 }
-
-// ===================================================================================
-// BUNDLE ENTRY TYPES
-// ===================================================================================
-
 /**
  * @deprecated Use `BundleEntry` instead. This will be removed in a future version.
  * Represents a single entry in an INCOMING request Bundle.
  */
 export interface BundleEntryRequest {
-  id?: string;
-  type: string;
-  request: BundleRequest;
-  resource?: Record<string, any>;
-  meta?: BundleEntryMeta;
+    id?: string;
+    type: string;
+    request: BundleRequest;
+    resource?: Record<string, any>;
+    meta?: BundleEntryMeta;
 }
-
 /**
  * @deprecated Use `BundleEntry` instead. This will be removed in a future version.
  * Represents a single successful entry in an OUTGOING response Bundle.
  */
 export interface BundleEntryResponse {
-  id?: string;
-  type: string;
-  response: BundleResponse;
-  resource?: Record<string, any>;
-  meta?: BundleEntryMeta;
+    id?: string;
+    type: string;
+    response: BundleResponse;
+    resource?: Record<string, any>;
+    meta?: BundleEntryMeta;
 }
-
 /**
  * Represents a single error entry in a response Bundle.
  *
@@ -96,21 +81,20 @@ export interface BundleEntryResponse {
  * request entry. This allows the client to correlate the exact input that caused the failure.
  */
 export interface ErrorEntry {
-  /** An optional unique identifier for this entry. */
-  id?: string;
-  /** The `type` of the original request entry that failed. */
-  type: string;
-  /** The original, unprocessed `meta` object from the request entry that failed. */
-  meta?: BundleEntryMeta;
-  /** The details of the error that occurred. */
-  response: {
-    /** The HTTP status code reflecting the error (e.g., "400", "500"). */
-    status: string;
-    /** A FHIR OperationOutcome resource providing detailed error diagnostics. */
-    outcome: OperationOutcome;
-  };
+    /** An optional unique identifier for this entry. */
+    id?: string;
+    /** The `type` of the original request entry that failed. */
+    type: string;
+    /** The original, unprocessed `meta` object from the request entry that failed. */
+    meta?: BundleEntryMeta;
+    /** The details of the error that occurred. */
+    response: {
+        /** The HTTP status code reflecting the error (e.g., "400", "500"). */
+        status: string;
+        /** A FHIR OperationOutcome resource providing detailed error diagnostics. */
+        outcome: OperationOutcome;
+    };
 }
-
 /**
  * Represents a single, canonical entry within a `BundleJsonApi`.
  * This structure is used for both requests and successful responses.
@@ -122,18 +106,13 @@ export interface ErrorEntry {
  * @property {BundleResponse} [response] - Details of the operation outcome (for response bundles).
  */
 export type BundleEntry = {
-  id?: string;
-  type: string;
-  meta?: BundleEntryMeta;
-  resource?: Record<string, any>;
-  request?: BundleRequest;
-  response?: BundleResponse;
-}
-
-// ===================================================================================
-// BUNDLE DEFINITION
-// ===================================================================================
-
+    id?: string;
+    type: string;
+    meta?: BundleEntryMeta;
+    resource?: Record<string, any>;
+    request?: BundleRequest;
+    response?: BundleResponse;
+};
 /**
  * Represents the canonical Bundle structure used as the `body` of a request or response.
  * The generic type `T` allows for specifying whether the `data` array contains request
@@ -144,9 +123,8 @@ export type BundleEntry = {
  * const responseBundle: BundleJsonApi<BundleEntry | ErrorEntry> = { ... };
  */
 export interface BundleJsonApi<T = BundleEntry | ErrorEntry> {
-  data: T[];
-  resourceType: 'Bundle';
-  total?: number;
-  type: string;
+    data: T[];
+    resourceType: 'Bundle';
+    total?: number;
+    type: string;
 }
-

package/dist/models/bundle.js

@@ -0,0 +1,26 @@
+/**
+ * @file src/models/bundle.ts
+ * @copyright 2025 Antifraud Services Inc. under the Apache License, Version 2.0.
+ *
+ * @summary
+ * This file defines the canonical data structures for "Bundles" and their "Entries"
+ * within this system, following a hybrid FHIR / JSON:API pattern. It is the single
+ * source of truth for the shape of request and response bodies.
+ *
+ * @architecture
+ * The models herein are critical for maintaining architectural consistency.
+ *
+ * 1.  **`BundleJsonApi`**: The top-level container for all batch operations. Corresponds
+ *     to the `body` of a DIDComm message or a standard API request.
+ *
+ * 2.  **`BundleEntry`**: The core component of a Bundle. Represents a single unit of work,
+ *     such as registering one organization or creating one employee. It has a strict
+ *     structure:
+ *     - `type`: A string that defines the business action (e.g., 'Organization-registration-offer-v1.0').
+ *     - `meta`: A **TOP-LEVEL** property containing the original `claims` for the operation.
+ *               This is crucial for both processing and error reporting.
+ *     - `resource`: A FHIR-like resource object that is the subject of the action. It
+ *                   contains the structured data derived from the claims.
+ *     - `request`/`response`: Contextual objects indicating the operation's details or result.
+ */
+export {};

package/dist/models/clinical-sections.d.ts

@@ -0,0 +1,36 @@
+/**
+ * Canonical registry of supported clinical document sections (e.g., IPS Composition sections).
+ *
+ * Design goals:
+ * - Use stable codes (LOINC) for interoperability.
+ * - Provide a reverse-DNS i18n key for consistent UI translations across apps.
+ * - Keep this in `gdc-common-utils-ts` so both backend and frontend can share it.
+ */
+import { clinicalSectionTitleEn } from './clinical-sections.en';
+export declare const LOINC_SYSTEM_URL: "http://loinc.org";
+export declare const LOINC_SYSTEM_REVERSE_DNS: "org.loinc";
+export type ClinicalSectionDescriptor = {
+    /** Canonical coding system URL (FHIR-style). */
+    system: string;
+    /** Code within the coding system (e.g., a LOINC code). */
+    code: string;
+    /**
+     * Reverse-DNS translation key, intended for i18n resources.
+     * Example: `org.loinc.48765-2`.
+     */
+    i18nKey: string;
+    /**
+     * English fallback label (documentation/UI fallback).
+     *
+     * Prefer rendering a UI label via `i18nKey` (e.g., `org.loinc.<CODE>`) rather than relying on this.
+     */
+    titleEn?: string;
+    /** True when this is an IPS-aligned section code. */
+    ips?: boolean;
+};
+export declare function loincI18nKey(code: string): string;
+export type SupportedClinicalSectionCode = keyof typeof clinicalSectionTitleEn;
+export declare const supportedClinicalSectionCodes: readonly ("10154-3" | "10157-6" | "10160-0" | "10164-2" | "10183-2" | "10184-0" | "10187-3" | "10210-3" | "10216-0" | "10218-6" | "10222-8" | "10223-6" | "11329-0" | "11348-0" | "11369-6" | "11493-4" | "11535-2" | "11537-8" | "18776-5" | "18841-7" | "29299-5" | "29545-1" | "29549-3" | "29554-3" | "29762-2" | "30954-2" | "42344-2" | "42346-7" | "42348-3" | "42349-1" | "46240-8" | "46241-6" | "46264-8" | "47420-5" | "47519-4" | "48765-2" | "48768-6" | "51848-0" | "55109-3" | "55122-6" | "57852-6" | "59768-2" | "59769-0" | "59770-8" | "59771-6" | "59772-4" | "59773-2" | "59775-7" | "59776-5" | "61149-1" | "61150-9" | "69730-0" | "8648-8" | "8653-8" | "8716-3" | "60591-5" | "11450-4" | "61144-2" | "82810-3" | "87520-3" | "10190-7" | "18726-0" | "11503-0" | "56796-6")[];
+export declare const clinicalSectionRegistry: Readonly<Record<string, ClinicalSectionDescriptor>>;
+export { clinicalSectionTitleEn };
+export declare function getClinicalSectionByCode(code: string): ClinicalSectionDescriptor | undefined;

package/dist/models/clinical-sections.en.d.ts

@@ -0,0 +1,75 @@
+/**
+ * English display labels for supported clinical document section codes.
+ *
+ * Notes:
+ * - This file is intentionally separate from the section registry so apps can:
+ *   - use these labels as a default (e.g., server-side rendering), and/or
+ *   - override them via i18n resources keyed by `org.loinc.<CODE>`.
+ * - Sources: HL7 FHIR doc-section-codes + project-specific additions.
+ */
+export declare const clinicalSectionTitleEn: {
+    readonly '10154-3': "Chief complaint Narrative - Reported";
+    readonly '10157-6': "History of family member diseases Narrative";
+    readonly '10160-0': "History of Medication use Narrative";
+    readonly '10164-2': "History of Present illness Narrative";
+    readonly '10183-2': "Hospital discharge medications Narrative";
+    readonly '10184-0': "Hospital discharge physical findings Narrative";
+    readonly '10187-3': "Review of systems Narrative - Reported";
+    readonly '10210-3': "Physical findings of General status Narrative";
+    readonly '10216-0': "Surgical operation note fluids Narrative";
+    readonly '10218-6': "Surgical operation note postoperative diagnosis Narrative";
+    readonly '10222-8': "Surgical operation note surgical complications [Interpretation] Narrative";
+    readonly '10223-6': "Surgical operation note surgical procedure Narrative";
+    readonly '11329-0': "History general Narrative - Reported";
+    readonly '11348-0': "History of Past illness Narrative";
+    readonly '11369-6': "History of Immunization Narrative";
+    readonly '11493-4': "Hospital discharge studies summary Narrative";
+    readonly '11535-2': "Hospital discharge Dx Narrative";
+    readonly '11537-8': "Surgical drains Narrative";
+    readonly '18776-5': "Plan of care note";
+    readonly '18841-7': "Hospital consultations Document";
+    readonly '29299-5': "Reason for visit Narrative";
+    readonly '29545-1': "Physical findings Narrative";
+    readonly '29549-3': "Medication administered Narrative";
+    readonly '29554-3': "Procedure Narrative";
+    readonly '29762-2': "Social history Narrative";
+    readonly '30954-2': "Relevant diagnostic tests/laboratory data Narrative";
+    readonly '42344-2': "Discharge diet (narrative)";
+    readonly '42346-7': "Medications on admission (narrative)";
+    readonly '42348-3': "Advance directives";
+    readonly '42349-1': "Reason for referral (narrative)";
+    readonly '46240-8': "History of Hospitalizations+Outpatient visits Narrative";
+    readonly '46241-6': "Hospital admission diagnosis Narrative - Reported";
+    readonly '46264-8': "History of medical device use";
+    readonly '47420-5': "Functional status assessment note";
+    readonly '47519-4': "History of Procedures Document";
+    readonly '48765-2': "Allergies and adverse reactions Document";
+    readonly '48768-6': "Payment sources Document";
+    readonly '51848-0': "Evaluation note";
+    readonly '55109-3': "Complications Document";
+    readonly '55122-6': "Surgical operation note implants Narrative";
+    readonly '57852-6': "Problem list Narrative - Reported";
+    readonly '59768-2': "Procedure indications [Interpretation] Narrative";
+    readonly '59769-0': "Postprocedure diagnosis Narrative";
+    readonly '59770-8': "Procedure estimated blood loss Narrative";
+    readonly '59771-6': "Procedure implants Narrative";
+    readonly '59772-4': "Planned procedure Narrative";
+    readonly '59773-2': "Procedure specimens taken Narrative";
+    readonly '59775-7': "Procedure disposition Narrative";
+    readonly '59776-5': "Procedure findings Narrative";
+    readonly '61149-1': "Objective Narrative";
+    readonly '61150-9': "Subjective Narrative";
+    readonly '69730-0': "Instructions";
+    readonly '8648-8': "Hospital course Narrative";
+    readonly '8653-8': "Hospital Discharge instructions";
+    readonly '8716-3': "Vital signs";
+    readonly '60591-5': "Patient summary";
+    readonly '11450-4': "Problem list";
+    readonly '61144-2': "Diet";
+    readonly '82810-3': "History of pregnancy";
+    readonly '87520-3': "Health insurance coverage";
+    readonly '10190-7': "Mental status";
+    readonly '18726-0': "Radiology studies";
+    readonly '11503-0': "Medical records (generic)";
+    readonly '56796-6': "Healthcare (general)";
+};

package/dist/models/clinical-sections.en.js

@@ -0,0 +1,81 @@
+/**
+ * English display labels for supported clinical document section codes.
+ *
+ * Notes:
+ * - This file is intentionally separate from the section registry so apps can:
+ *   - use these labels as a default (e.g., server-side rendering), and/or
+ *   - override them via i18n resources keyed by `org.loinc.<CODE>`.
+ * - Sources: HL7 FHIR doc-section-codes + project-specific additions.
+ */
+export const clinicalSectionTitleEn = {
+    // ---------------------------------------------------------------------------
+    // HL7 FHIR doc-section-codes (LOINC) — subset used by the platform/docs
+    // ---------------------------------------------------------------------------
+    '10154-3': 'Chief complaint Narrative - Reported',
+    '10157-6': 'History of family member diseases Narrative',
+    '10160-0': 'History of Medication use Narrative',
+    '10164-2': 'History of Present illness Narrative',
+    '10183-2': 'Hospital discharge medications Narrative',
+    '10184-0': 'Hospital discharge physical findings Narrative',
+    '10187-3': 'Review of systems Narrative - Reported',
+    '10210-3': 'Physical findings of General status Narrative',
+    '10216-0': 'Surgical operation note fluids Narrative',
+    '10218-6': 'Surgical operation note postoperative diagnosis Narrative',
+    '10222-8': 'Surgical operation note surgical complications [Interpretation] Narrative',
+    '10223-6': 'Surgical operation note surgical procedure Narrative',
+    '11329-0': 'History general Narrative - Reported',
+    '11348-0': 'History of Past illness Narrative',
+    '11369-6': 'History of Immunization Narrative',
+    '11493-4': 'Hospital discharge studies summary Narrative',
+    '11535-2': 'Hospital discharge Dx Narrative',
+    '11537-8': 'Surgical drains Narrative',
+    '18776-5': 'Plan of care note',
+    '18841-7': 'Hospital consultations Document',
+    '29299-5': 'Reason for visit Narrative',
+    '29545-1': 'Physical findings Narrative',
+    '29549-3': 'Medication administered Narrative',
+    '29554-3': 'Procedure Narrative',
+    '29762-2': 'Social history Narrative',
+    '30954-2': 'Relevant diagnostic tests/laboratory data Narrative',
+    '42344-2': 'Discharge diet (narrative)',
+    '42346-7': 'Medications on admission (narrative)',
+    '42348-3': 'Advance directives',
+    '42349-1': 'Reason for referral (narrative)',
+    '46240-8': 'History of Hospitalizations+Outpatient visits Narrative',
+    '46241-6': 'Hospital admission diagnosis Narrative - Reported',
+    '46264-8': 'History of medical device use',
+    '47420-5': 'Functional status assessment note',
+    '47519-4': 'History of Procedures Document',
+    '48765-2': 'Allergies and adverse reactions Document',
+    '48768-6': 'Payment sources Document',
+    '51848-0': 'Evaluation note',
+    '55109-3': 'Complications Document',
+    '55122-6': 'Surgical operation note implants Narrative',
+    '57852-6': 'Problem list Narrative - Reported',
+    '59768-2': 'Procedure indications [Interpretation] Narrative',
+    '59769-0': 'Postprocedure diagnosis Narrative',
+    '59770-8': 'Procedure estimated blood loss Narrative',
+    '59771-6': 'Procedure implants Narrative',
+    '59772-4': 'Planned procedure Narrative',
+    '59773-2': 'Procedure specimens taken Narrative',
+    '59775-7': 'Procedure disposition Narrative',
+    '59776-5': 'Procedure findings Narrative',
+    '61149-1': 'Objective Narrative',
+    '61150-9': 'Subjective Narrative',
+    '69730-0': 'Instructions',
+    '8648-8': 'Hospital course Narrative',
+    '8653-8': 'Hospital Discharge instructions',
+    '8716-3': 'Vital signs',
+    // ---------------------------------------------------------------------------
+    // Project additions (not part of doc-section-codes, but used by clients)
+    // ---------------------------------------------------------------------------
+    '60591-5': 'Patient summary',
+    '11450-4': 'Problem list',
+    '61144-2': 'Diet',
+    '82810-3': 'History of pregnancy',
+    '87520-3': 'Health insurance coverage',
+    '10190-7': 'Mental status',
+    '18726-0': 'Radiology studies',
+    '11503-0': 'Medical records (generic)',
+    '56796-6': 'Healthcare (general)',
+};

package/dist/models/clinical-sections.js

@@ -0,0 +1,32 @@
+/**
+ * Canonical registry of supported clinical document sections (e.g., IPS Composition sections).
+ *
+ * Design goals:
+ * - Use stable codes (LOINC) for interoperability.
+ * - Provide a reverse-DNS i18n key for consistent UI translations across apps.
+ * - Keep this in `gdc-common-utils-ts` so both backend and frontend can share it.
+ */
+import { clinicalSectionTitleEn } from './clinical-sections.en.js';
+export const LOINC_SYSTEM_URL = 'http://loinc.org';
+export const LOINC_SYSTEM_REVERSE_DNS = 'org.loinc';
+export function loincI18nKey(code) {
+    return `${LOINC_SYSTEM_REVERSE_DNS}.${code}`;
+}
+export const supportedClinicalSectionCodes = Object.freeze(Object.keys(clinicalSectionTitleEn));
+export const clinicalSectionRegistry = (() => {
+    const entries = Object.entries(clinicalSectionTitleEn).map(([code, titleEn]) => {
+        const descriptor = {
+            system: LOINC_SYSTEM_URL,
+            code,
+            i18nKey: loincI18nKey(code),
+            titleEn,
+            ips: true,
+        };
+        return [code, descriptor];
+    });
+    return Object.freeze(Object.fromEntries(entries));
+})();
+export { clinicalSectionTitleEn };
+export function getClinicalSectionByCode(code) {
+    return clinicalSectionRegistry[code];
+}

package/dist/models/comm.d.ts

@@ -0,0 +1,44 @@
+/**
+ * Represents the standard payload of a DIDComm v2 message.
+ * @see https://identity.foundation/didcomm-messaging/spec/v2.0/#plaintext-message-structure
+ */
+export interface DidCommPayload {
+    id: string;
+    type: string;
+    from?: string;
+    to?: string[];
+    thid?: string;
+    pthid?: string;
+    created_time?: number;
+    expires_time?: number;
+    body: {
+        [key: string]: any;
+    };
+}
+/**
+ * Represents a data entry in the `body` of a CommMsgExtended,
+ * following a hybrid JSON:API and FHIR structure.
+ */
+export interface DataEntry {
+    id: string;
+    type: 'Annotation' | 'Reference' | 'Attachment' | 'CodeableConcept' | string;
+    resource: {
+        [key: string]: any;
+    };
+    meta?: {
+        claims: any;
+    };
+}
+/**
+ * The canonical, internal representation of a secure message, extending
+ * the standard DIDComm payload with FHIR-specific, flattened metadata.
+ */
+export interface CommMsgExtended extends DidCommPayload {
+    body: {
+        data: DataEntry[];
+    };
+}
+/**
+ * A type placeholder for a FHIR Communication resource.
+ */
+export type FhirCommunication = any;

package/dist/models/comm.js

@@ -0,0 +1,4 @@
+// Copyright 2025 Antifraud Services Inc. under the Apache License, Version 2.0.
+// File: src/models/comm.ts
+// Description: Defines the core communication and data structures based on DIDComm and FHIR.
+export {};

package/{src/models/confidential-job.ts → dist/models/confidential-job.d.ts}

@@ -1,50 +1,43 @@
-// Copyright 2025 Antifraud Services Inc. under the Apache License, Version 2.0.
-// File: crypto-ts/models/confidential-job.ts
-
 /**
  * @file This file contains the core data models for the job processing system.
  * These models are platform-agnostic and are part of the core SDK.
  * @sdk
  */
-
 import { IDecodedDidcommPayload as DecodedDidcommPayload } from "./confidential-message";
 import { ConfidentialStorageDoc, IndexedData } from "./confidential-storage";
 import { ServiceEndpointSelector } from "./did";
-
 /** When the organization has its own domain for the connector do not appear in the path:
  * - the tenantId and jurisdiction, and
- * - the apiVersion and sector; 
+ * - the apiVersion and sector;
  */
 export interface JobRequestInfo extends ServiceEndpointSelector {
-  /** When the organization has its own domain for the connector the tenantId and jurisdiction do not appear in the path */
-  tenantId?: string;
-  jurisdiction?: string;
-  /** The Unix epoch timestamp (in milliseconds) of when the job record was created. */
-  createdAtTimestamp: number;
-  requestUrl?: string;
-  httpMethod?: string;
-  contentType?: string;
-  language?: string;  
+    /** When the organization has its own domain for the connector the tenantId and jurisdiction do not appear in the path */
+    tenantId?: string;
+    jurisdiction?: string;
+    /** The Unix epoch timestamp (in milliseconds) of when the job record was created. */
+    createdAtTimestamp: number;
+    requestUrl?: string;
+    httpMethod?: string;
+    contentType?: string;
+    language?: string;
 }
-
 /**
  * Defines the possible statuses of a job throughout its lifecycle.
  */
-export enum JobStatus {
-  /** The job has been created locally but not yet submitted. */
-  DRAFT = 'DRAFT',
-  /** The job is in the process of being submitted to the server. */
-  SUBMITTING = 'SUBMITTING',
-  /** The job was successfully submitted and is awaiting asynchronous processing. */
-  SENT = 'SENT',
-  /** The server has finished processing the job and returned a final result. This is a terminal state. */
-  COMPLETED = 'COMPLETED',
-  /** The job failed due to a transport-level error and will not be retried. This is a terminal state. */
-  FAILED = 'FAILED',
-  /** The job failed due to a transient error and may be retried. */
-  ERROR_RETRYABLE = 'ERROR_RETRYABLE',
+export declare enum JobStatus {
+    /** The job has been created locally but not yet submitted. */
+    DRAFT = "DRAFT",
+    /** The job is in the process of being submitted to the server. */
+    SUBMITTING = "SUBMITTING",
+    /** The job was successfully submitted and is awaiting asynchronous processing. */
+    SENT = "SENT",
+    /** The server has finished processing the job and returned a final result. This is a terminal state. */
+    COMPLETED = "COMPLETED",
+    /** The job failed due to a transport-level error and will not be retried. This is a terminal state. */
+    FAILED = "FAILED",
+    /** The job failed due to a transient error and may be retried. */
+    ERROR_RETRYABLE = "ERROR_RETRYABLE"
 }
-
 /**
  * Represents the entire data package for a single job ready for processing.
  * It combines the HTTP request context with the unprotected message and its security context.
@@ -52,7 +45,6 @@ export enum JobStatus {
  * The external URL has this structure: `https://<organization-domain>/:section/:format/:resourceType/:action`
  */
 export interface JobRequest extends ConfidentialStorageDoc, JobRequestInfo {
-    // 'id' serves as the primary key in the vault.
     id: string;
     /**
      * DIDComm thread ID for correlating async jobs.
@@ -63,38 +55,24 @@ export interface JobRequest extends ConfidentialStorageDoc, JobRequestInfo {
     versionId?: string;
     vaultId?: string;
     chunks?: number;
-
-    // From ConfidentialStorageDoc
-
     /** A number that MUST be incremented each time the document is updated. */
     sequence: number;
-    
     /** Previous sequence being replaced by the update */
     previousSequence?: number;
-
     /** Contains an array of indexed attributes protected with HMAC for blind queries. */
     indexed?: IndexedData;
-    
     /** The decoded DIDComm message. Present when the job is unprotected. */
     content?: DecodedDidcommPayload;
-
     /** The JWE representation of the encrypted content. Present when the job is protected. */
     jwe?: Record<string, any>;
-
-    // Additional information for job processing
-
     /** Addtional information from HTTP header */
     onBehalfOf?: string;
-
     /** The URL provided by the server to poll for the job's status. */
     locationUrl?: string;
-
     /** A counter for the number of retry attempts. */
     retryCount?: number;
-
     /** The ID of the corresponding response message stored in the vault, once the job is COMPLETED. */
     responseMessageId?: string;
-
     /** CAUTION: Only for debugging purposes. It is the last error message, o*/
     errorMessage?: string;
 }

package/dist/models/confidential-job.js

@@ -0,0 +1,20 @@
+// Copyright 2025 Antifraud Services Inc. under the Apache License, Version 2.0.
+// File: crypto-ts/models/confidential-job.ts
+/**
+ * Defines the possible statuses of a job throughout its lifecycle.
+ */
+export var JobStatus;
+(function (JobStatus) {
+    /** The job has been created locally but not yet submitted. */
+    JobStatus["DRAFT"] = "DRAFT";
+    /** The job is in the process of being submitted to the server. */
+    JobStatus["SUBMITTING"] = "SUBMITTING";
+    /** The job was successfully submitted and is awaiting asynchronous processing. */
+    JobStatus["SENT"] = "SENT";
+    /** The server has finished processing the job and returned a final result. This is a terminal state. */
+    JobStatus["COMPLETED"] = "COMPLETED";
+    /** The job failed due to a transport-level error and will not be retried. This is a terminal state. */
+    JobStatus["FAILED"] = "FAILED";
+    /** The job failed due to a transient error and may be retried. */
+    JobStatus["ERROR_RETRYABLE"] = "ERROR_RETRYABLE";
+})(JobStatus || (JobStatus = {}));