@healthcloudai/hc-safe-cdx 0.1.3 → 0.2.0

package/dist/index.d.cts

@@ -2,167 +2,135 @@ import { HCLoginClient } from '@healthcloudai/hc-login-connector';
 import { HttpClient } from '@healthcloudai/hc-http';
 
 type Environment = "dev" | "uat" | "prod";
-interface SafeCDXConfig {
-    environment: Environment;
-    defaultLanguage?: string;
-    defaultImageType?: string;
-}
-interface ApiResponse<T> {
-    IsOK: boolean;
-    Data: T | null;
+/**
+ * SDK callers pass only the inner payload; the client creates this wrapper.
+ */
+interface ApiRequest<TPayload> {
+    Data: TPayload;
+}
+/**
+ * Successful standard Health Cloud API response envelope.
+ */
+interface SuccessfulApiResponse<TData> {
+    IsOK: true;
+    Data: TData;
+    ErrorMessage: null;
+}
+/**
+ * Failed standard Health Cloud API response envelope.
+ */
+interface FailedApiResponse<TData = unknown> {
+    IsOK: false;
+    Data: TData | null;
     ErrorMessage: string | null;
 }
-interface ScanUpcTerritory {
-    Code: string | null;
-    StateName: string | null;
-    IsEnabled: boolean;
-}
-interface ScanUpcScanImageDetail {
-    ImageUrl: string | null;
-}
-interface ScanUpcInstruction {
-    NavigationTitle: string | null;
-    Type: string | null;
-    Title: string | null;
-    Body: string | null;
-    ButtonTitle: string | null;
-    TimeInSeconds: number;
-    AutoStartTimer: boolean;
-    AutoContinue: boolean;
-    CanContinue: boolean;
-    IsFullscreenVideo: boolean;
-    ShowBackButton: boolean;
-    ImageUrl: string | null;
-    VideoUrl: string | null;
-    SequenceOrder: number;
-    ResumeInstructionHere: boolean;
-}
-interface ScanUpcBillingInfo {
-    Taxable: boolean;
-}
-interface ScanUpcArticle {
-    ImageUrl: string | null;
-    Title: string | null;
-    DateCreated: string | null;
-    Owner: string | null;
-    Status: string | null;
-    Actions: unknown;
-}
-interface ScanUpcTestResult {
-    PatientTestResult: number;
-    ResultTitle: string | null;
-    ResultDisplay: string | null;
-    ResultLongDescription: string | null;
-    TreatmentPlanDescription: string | null;
-    IsReturnToDashboardAllowed: boolean;
-    IsOrderTestAllowed: boolean;
-    IsFindTestRetailerAllowed: boolean;
-}
-interface ScanUpcAnalyte {
-    _id: string | null;
-    DisplayOrder: number;
-    Display: string | null;
-    Name: string | null;
-    Question: string | null;
-    Image: string | null;
-    Responses: unknown[];
-}
-interface ScanUpcOrderableData {
-    _id: string | null;
-    ShortName: string | null;
-    CustomTestName: string | null;
-    OrderableName: string | null;
-    VendorTestID: string | null;
-    SkuId: string | null;
-    IsOrderable: boolean;
-    IsSelfAssessmentMode: boolean;
-    KitRegistrationRequired: boolean;
-    RequiresResultsVerification: boolean;
-    TestClassification: string | null;
-    IsMLDisabled: boolean;
-    IsPublicHealthReportingEnabled: boolean;
-    IsActive: boolean;
-    CaptureMethod: string | null;
-    Created: string | null;
-    Modified: string | null;
-    ProductAssetDetail: unknown;
-    DisclaimerDetail: unknown;
-    ScanImageDetails: ScanUpcScanImageDetail | null;
-    BillingDetail: ScanUpcBillingInfo | null;
-    TestResults: ScanUpcTestResult[] | null;
-    CollectionInstructionV2: ScanUpcInstruction[] | null;
-    Articles: ScanUpcArticle[] | null;
-}
-interface ScanUpcResponseData {
-    UserTestResultId: string | null;
-    LegacyLabTestOrderable: {
-        Data: ScanUpcOrderableData | null;
-    } | null;
-}
+/**
+ * Raw response received from endpoints that use the standard Health Cloud
+ * response envelope.
+ */
+type ApiResponse<TData> = SuccessfulApiResponse<TData> | FailedApiResponse<TData>;
+/**
+ * Successful inner/raw SafeCDX service result.
+ *
+ * Some endpoints return this directly.
+ * Other endpoints return it inside ApiResponse.Data.
+ */
+interface SuccessfulServiceResult<TData> {
+    success: true;
+    data: TData;
+    message: string | null;
+    code: number;
+}
+/**
+ * Failed inner/raw SafeCDX service result.
+ */
+interface FailedServiceResult<TData = unknown> {
+    success: false;
+    data: TData | null;
+    message: string | null;
+    code: number;
+}
+/**
+ * Service-level result used either directly or inside ApiResponse.Data.
+ */
+type ServiceResult<TData> = SuccessfulServiceResult<TData> | FailedServiceResult<TData>;
+/**
+ * Minimal entity reference returned by update/submit operations.
+ */
+interface EntityReferenceData {
+    _id: string;
+    [key: string]: unknown;
+}
+/**
+ * Minimal test result summary used by pending/history responses.
+ */
+interface TestResultSummary {
+    _id: string;
+    status: string | null;
+    testName?: string | null;
+    recordedDate?: string | null;
+    created?: string | null;
+    cvmlStatus?: string | null;
+    gtin?: string | null;
+    [key: string]: unknown;
+}
+/**
+ * Detailed result object returned by last-result and result-details routes.
+ */
+interface TestResultDetails extends TestResultSummary {
+    gtin?: string | null;
+    cvmlStatus?: string | null;
+    finalized?: boolean;
+    resumed?: boolean;
+    [key: string]: unknown;
+}
+/**
+ * The nested test information used by the standard scan flow.
+ */
+interface DiagnosticProfileTestInfo {
+    gtin: string;
+    cvmlTestName?: string | null;
+    isCVMLResult?: boolean;
+    [key: string]: unknown;
+}
+/**
+ * Only the nested diagnostic profile data required by SDK consumers is typed.
+ */
+interface DiagnosticProfileData {
+    TestInfo: DiagnosticProfileTestInfo;
+    [key: string]: unknown;
+}
+/**
+ * Response data for resolving a test profile by GTIN.
+ *
+ */
 interface GetTestProfileByGTINData {
-    ID: string | null;
-    FHIRID: string | null;
-    CQLID: string | null;
-    TestName: string | null;
-    CustomTestName: string | null;
-    IsDeactivated: boolean;
-    IsOrderable: boolean;
-    EnablePublicHealthReporting: boolean;
-    IsSelfAssessmentMode: boolean;
-    CaptureMethod: number;
-    IsMLDisabled: boolean;
-    ShortName: string | null;
-    DescriptionHTML: string | null;
-    OrderableName: string | null;
-    VendorName: string | null;
-    ManufactureName: string | null;
-    VendorTestID: string | null;
-    Sku: string | null;
-    LabTestType: string | null;
-    TestClassification: string | null;
-    DeviceFulfilmentPartner: string | null;
-    FulfilmentPartnerCompediumId: string | null;
-    KitRegistrationRequired: boolean;
-    RequiresProviderVerificationOfResults: boolean;
-    ShippingPartner: string | null;
-    SpecimenTypeCode: string | null;
-    SpecimenCollectionType: number;
-    SpecimenSite: string | null;
-    Frequency: number;
-    UnitFrequency: number;
-    ProcessingTime: number;
-    UnitProcessingTime: number;
-    DeviceDetails: unknown;
-    Territories: ScanUpcTerritory[] | null;
-    DiagnosticProfile: unknown;
-    ProductAssetDetail: unknown;
-    DisclaimerDetail: unknown;
-    ScanImageDetail: ScanUpcScanImageDetail | null;
-    Survey: unknown;
-    Instructions: ScanUpcInstruction[] | null;
-    BillingInfo: ScanUpcBillingInfo | null;
-    Associations: unknown;
-    TestReportAsset: unknown;
-    Articles: ScanUpcArticle[] | null;
-    TestResults: ScanUpcTestResult[] | null;
-    GS1GTINs: string[] | null;
-    Included: string[] | null;
-    Analytes: ScanUpcAnalyte[] | null;
-    LOINCCodes: unknown;
-    TestLOINCCodes: unknown[];
-    TestSNOMEDCTCodes: unknown[];
-    Created: string | null;
-    Modified: string | null;
-    CreatedByID: string | null;
-    ModifiedByID: string | null;
-    TenantID: string | null;
-}
-interface GetTestProfileRequest {
-    Gtin: string;
+    ID: string;
+    TestName?: string | null;
+    CustomTestName?: string | null;
+    DiagnosticProfile: DiagnosticProfileData;
+    [key: string]: unknown;
 }
 interface GetTestProfilesByAccountRequest {
     IncludeRegisterTestDetails: boolean;
 }
+interface RegisterTestDetail {
+    title: string | null;
+    description: string | null;
+    buttonTitle: string | null;
+    imageURL: string | null;
+    [key: string]: unknown;
+}
+interface TestProfileByAccountItem {
+    gtin: string;
+    productName: string;
+    description: string | null;
+    testKitImageURL: string | null;
+    language: string | null;
+    registerTestDetail: RegisterTestDetail | null;
+    [key: string]: unknown;
+}
+type GetTestProfilesByAccountData = ServiceResult<TestProfileByAccountItem[]>;
 interface CreateUploadUrlRequest {
     Gtin: string;
     UserTestResultId: string;
@@ -170,96 +138,85 @@ interface CreateUploadUrlRequest {
         ImageType: string;
     };
 }
+interface UploadMetadata {
+    UploadId: string;
+    Type: string | null;
+    File: string;
+}
 interface CreateUploadUrlData {
-    preSignedURL: string | null;
-    Metadata: {
-        UploadId: string | null;
-        Type: string | null;
-        File: string | null;
-    } | null;
+    preSignedURL: string;
+    Metadata: UploadMetadata;
 }
 interface UpdateCvmlStatusRequest {
     ImageOfCaptureId: string;
     CvmlStatus: string;
 }
-interface GetPendingResultsRequest {
-    ExcludeStatus?: string;
-}
-interface GetLastResultsRequest {
-    ExcludeStatus?: string;
-}
-interface GetTestHistoryRequest {
-    ExcludeStatus?: string;
-}
-interface GetResultDetailsRequest {
+type UpdateCvmlStatusResponse = ServiceResult<EntityReferenceData>;
+interface CvmlResultsData {
+    _id: string;
+    status: string | null;
+    cvmlStatus: string | null;
+    gtin: string | null;
+    resumed?: boolean;
+    [key: string]: unknown;
+}
+type GetCvmlResultsResponse = ServiceResult<CvmlResultsData>;
+interface ExcludeStatusRequest {
+    ExcludeStatus: string;
+}
+type GetPendingResultsRequest = ExcludeStatusRequest;
+type GetLastResultsRequest = ExcludeStatusRequest;
+type GetTestHistoryRequest = ExcludeStatusRequest;
+interface UserTestResultIdRequest {
     UserTestResultId: string;
 }
-interface GetResultPdfRequest {
-    UserTestResultId: string;
-    BirthDate?: string;
-    FirstName?: string;
-    LastName?: string;
-    Gender?: string;
-}
-interface GetImageCaptureUrlRequest {
-    UserTestResultId: string;
-}
-interface GetAnalyticsRequest {
-    ExcludeStatus?: string;
-}
-interface ResumeFlowRequest {
-    UserTestResultId: string;
+type GetResultDetailsRequest = UserTestResultIdRequest;
+type GetResultPdfRequest = UserTestResultIdRequest;
+type GetImageCaptureUrlRequest = UserTestResultIdRequest;
+type GetPendingResultsData = ServiceResult<TestResultSummary[]>;
+type GetLastResultsData = ServiceResult<TestResultDetails>;
+type GetTestHistoryData = ServiceResult<TestResultSummary[]>;
+/**
+ * Raw service result returned directly by getResultDetails().
+ */
+type GetResultDetailsResponse = ServiceResult<TestResultDetails>;
+/**
+ * Standard API envelope Data returned by getResultPdf().
+ */
+type GetResultPdfData = ServiceResult<string>;
+/**
+ * Raw service result returned directly by getImageCaptureUrl().
+ */
+type GetImageCaptureUrlResponse = ServiceResult<string>;
+interface ResumeFlowRequest extends UserTestResultIdRequest {
     Resumed: boolean;
 }
+interface ResumeFlowResult {
+    _id: string;
+    resumed: boolean;
+    cvmlStatus?: string | null;
+    [key: string]: unknown;
+}
+type ResumeFlowData = ServiceResult<ResumeFlowResult>;
 interface AnswerResult {
     Analyte: string;
     ReportedValue: string;
     StoredValue: string;
     Score: string;
 }
-interface SubmitAnswersRequest {
-    UserTestResultId: string;
+interface SubmitAnswersRequest extends UserTestResultIdRequest {
     Result: AnswerResult[];
 }
-interface CtaResult {
-    Id?: string;
-    Title?: string;
-    Instructions?: string;
-    UrlText?: string;
-    Url?: string;
-}
-interface IndicationResult {
-    Id?: string;
-    Title?: string;
-    Text?: string;
-    RecommendTitle?: string;
-    RecommendText?: string;
-    CtaId?: string;
-}
-interface DecisionResultItem {
-    IndicationId: string;
-    Value: string;
-}
-interface DecisionResult {
-    Calculation?: string;
-    Results: DecisionResultItem[];
-}
-interface FinalizeTestRequest {
-    UserTestResultId: string;
-    CtaResult?: CtaResult;
-    IndicationResult?: IndicationResult;
-    DecisionResult?: DecisionResult;
-}
+type SubmitAnswersData = ServiceResult<EntityReferenceData>;
+type FinalizeTestRequest = UserTestResultIdRequest;
 
 declare class HCSafeCDXClient {
     private readonly http;
     private readonly auth;
-    private readonly host;
-    private readonly defaultLanguage;
-    private readonly defaultImageType;
+    private readonly baseUrl;
     private apiKeyHeaderName?;
     private apiKeyValue?;
-    constructor(httpClient: HttpClient, authClient: HCLoginClient, config: SafeCDXConfig);
+    constructor(httpClient: HttpClient, authClient: HCLoginClient);
     setApiKey(headerName: string, value: string): void;
     private getAuthHeaders;
     private getJsonHeaders;
@@ -269,17 +226,12 @@ declare class HCSafeCDXClient {
      * GET gs1/:gtin
      * Resolves a test profile by GTIN barcode and creates a UserTestResultId.
      */
-    getTestProfileByGTIN(gtin: string, language?: string): Promise<ApiResponse<GetTestProfileByGTINData>>;
-    /**
-     * POST test/profile
-     * Returns the full test profile for a given GTIN.
-     */
-    getTestProfile(payload: GetTestProfileRequest): Promise<ApiResponse<GetTestProfileByGTINData>>;
+    getTestProfileByGTIN(gtin: string): Promise<ApiResponse<GetTestProfileByGTINData>>;
     /**
      * POST test/profiles/by-account
      * Lists all test profiles available to the authenticated account.
      */
-    getTestProfilesByAccount(payload?: GetTestProfilesByAccountRequest): Promise<ApiResponse<unknown>>;
+    getTestProfilesByAccount(payload?: GetTestProfilesByAccountRequest): Promise<ApiResponse<GetTestProfilesByAccountData>>;
     /**
      * POST upload/url
      * Requests a pre-signed S3 URL for image upload.
@@ -299,63 +251,58 @@ declare class HCSafeCDXClient {
      * Updates the ML processing status for a captured image.
      * NOTE: Returns raw service result — no ApiResponse wrapper on this endpoint.
      */
-    updateCvmlStatus(imageOfCaptureId: string, cvmlStatus: string): Promise<unknown>;
+    updateCvmlStatus(imageOfCaptureId: string, cvmlStatus: string): Promise<UpdateCvmlStatusResponse>;
     /**
      * GET cvml/results
      * Polls ML analysis results for a captured image.
      * NOTE: Returns raw service result — no ApiResponse wrapper on this endpoint.
      */
-    getCvmlResults(imageOfCaptureId: string): Promise<unknown>;
+    getCvmlResults(imageOfCaptureId: string): Promise<GetCvmlResultsResponse>;
     /**
      * POST test/result/pending
      * Returns test results in a pending/incomplete state.
      */
-    getPendingResults(payload?: GetPendingResultsRequest): Promise<ApiResponse<unknown>>;
+    getPendingResults(payload?: GetPendingResultsRequest): Promise<ApiResponse<GetPendingResultsData>>;
     /**
      * POST test/result/last
      * Returns the most recent test result for the authenticated patient.
      */
-    getLastResults(payload?: GetLastResultsRequest): Promise<ApiResponse<unknown>>;
+    getLastResults(payload?: GetLastResultsRequest): Promise<ApiResponse<GetLastResultsData>>;
     /**
      * POST test/result/history
      * Returns the full test history for the authenticated patient.
      */
-    getTestHistory(payload?: GetTestHistoryRequest): Promise<ApiResponse<unknown>>;
+    getTestHistory(payload?: GetTestHistoryRequest): Promise<ApiResponse<GetTestHistoryData>>;
     /**
      * POST test/result/details
      * Returns detailed result data for a specific test attempt.
      * NOTE: Returns raw service result — no ApiResponse wrapper on this endpoint.
      */
-    getResultDetails(userTestResultId: string): Promise<unknown>;
+    getResultDetails(userTestResultId: string): Promise<GetResultDetailsResponse>;
     /**
      * POST test/result/pdf
-     * Generates a PDF report for a specific test result.
+     * Requests the PDF result for a specific test result.
      */
-    getResultPdf(payload: GetResultPdfRequest): Promise<ApiResponse<unknown>>;
+    getResultPdf(payload: GetResultPdfRequest): Promise<ApiResponse<GetResultPdfData>>;
     /**
      * POST test/result/image/capture
-     * Returns the image capture URL for a specific test result.
+     * Requests image capture data for a specific test result.
      * NOTE: Returns raw service result — no ApiResponse wrapper on this endpoint.
      */
-    getImageCaptureUrl(userTestResultId: string): Promise<unknown>;
-    /**
-     * POST test/result/analytics
-     * Returns analytics data for test results.
-     */
-    getAnalytics(payload?: GetAnalyticsRequest): Promise<ApiResponse<unknown>>;
+    getImageCaptureUrl(userTestResultId: string): Promise<GetImageCaptureUrlResponse>;
     /**
      * POST test/resume
      * Marks a test attempt as resumed (or not).
      */
-    resumeFlow(userTestResultId: string, resumed?: boolean): Promise<ApiResponse<unknown>>;
+    resumeFlow(userTestResultId: string, resumed?: boolean): Promise<ApiResponse<ResumeFlowData>>;
     /**
      * POST test/answers
      * Submits analyte answers for a test attempt.
      */
-    submitAnswers(payload: SubmitAnswersRequest): Promise<ApiResponse<unknown>>;
+    submitAnswers(payload: SubmitAnswersRequest): Promise<ApiResponse<SubmitAnswersData>>;
     /**
      * POST test/finalize
-     * Finalizes a test attempt with CTA, indication, and decision results.
+     * Finalizes a test by UserTestResultId.
      */
     finalizeTest(payload: FinalizeTestRequest): Promise<ApiResponse<unknown>>;
 }
@@ -364,4 +311,4 @@ declare class ConfigError extends Error {
     constructor(message: string);
 }
 
-export { type AnswerResult, type ApiResponse, ConfigError, type CreateUploadUrlData, type CreateUploadUrlRequest, type CtaResult, type DecisionResult, type DecisionResultItem, type Environment, type FinalizeTestRequest, type GetAnalyticsRequest, type GetImageCaptureUrlRequest, type GetLastResultsRequest, type GetPendingResultsRequest, type GetResultDetailsRequest, type GetResultPdfRequest, type GetTestHistoryRequest, type GetTestProfileByGTINData, type GetTestProfileRequest, type GetTestProfilesByAccountRequest, HCSafeCDXClient, type IndicationResult, type ResumeFlowRequest, type SafeCDXConfig, type ScanUpcAnalyte, type ScanUpcArticle, type ScanUpcBillingInfo, type ScanUpcInstruction, type ScanUpcOrderableData, type ScanUpcResponseData, type ScanUpcScanImageDetail, type ScanUpcTerritory, type ScanUpcTestResult, type SubmitAnswersRequest, type UpdateCvmlStatusRequest };
+export { type AnswerResult, type ApiRequest, type ApiResponse, ConfigError, type CreateUploadUrlData, type CreateUploadUrlRequest, type CvmlResultsData, type DiagnosticProfileData, type DiagnosticProfileTestInfo, type EntityReferenceData, type Environment, type ExcludeStatusRequest, type FailedApiResponse, type FailedServiceResult, type FinalizeTestRequest, type GetCvmlResultsResponse, type GetImageCaptureUrlRequest, type GetImageCaptureUrlResponse, type GetLastResultsData, type GetLastResultsRequest, type GetPendingResultsData, type GetPendingResultsRequest, type GetResultDetailsRequest, type GetResultDetailsResponse, type GetResultPdfData, type GetResultPdfRequest, type GetTestHistoryData, type GetTestHistoryRequest, type GetTestProfileByGTINData, type GetTestProfilesByAccountData, type GetTestProfilesByAccountRequest, HCSafeCDXClient, type RegisterTestDetail, type ResumeFlowData, type ResumeFlowRequest, type ResumeFlowResult, type ServiceResult, type SubmitAnswersData, type SubmitAnswersRequest, type SuccessfulApiResponse, type SuccessfulServiceResult, type TestProfileByAccountItem, type TestResultDetails, type TestResultSummary, type UpdateCvmlStatusRequest, type UpdateCvmlStatusResponse, type UploadMetadata, type UserTestResultIdRequest };