@healthcloudai/hc-safe-cdx 0.0.1 → 0.1.2

package/dist/index.d.ts

@@ -1,2 +1,376 @@
+import { HCLoginClient } from '@healthcloudai/hc-login-connector';
+import { HttpClient } from '@healthcloudai/hc-http';
 
-export {  }
+type Environment = "dev" | "uat" | "prod";
+interface SafeCDXConfig {
+    environment: Environment;
+    defaultLanguage?: string;
+    defaultImageType?: string;
+}
+interface ApiResponse<T> {
+    IsOK: boolean;
+    Data: T | 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 Scan2DdmRequest {
+    Code: string;
+    ExternalQuestionnaireResultId?: string;
+}
+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;
+}
+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;
+}
+interface GetTestProfilesByAccountRequest {
+    IncludeRegisterTestDetails: boolean;
+}
+interface CreateUploadUrlRequest {
+    Gtin: string;
+    UserTestResultId: string;
+    Metadata: {
+        ImageType: string;
+    };
+}
+interface CreateUploadUrlData {
+    preSignedURL: string | null;
+    Metadata: {
+        UploadId: string | null;
+        Type: string | null;
+        File: string | null;
+    } | null;
+}
+interface UpdateCvmlStatusRequest {
+    ImageOfCaptureId: string;
+    CvmlStatus: string;
+}
+interface GetPendingResultsRequest {
+    ExcludeStatus?: string;
+}
+interface GetLastResultsRequest {
+    ExcludeStatus?: string;
+}
+interface GetTestHistoryRequest {
+    ExcludeStatus?: string;
+}
+interface GetResultDetailsRequest {
+    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;
+    Resumed: boolean;
+}
+interface AnswerResult {
+    Analyte: string;
+    ReportedValue: string;
+    StoredValue: string;
+    Score: string;
+}
+interface SubmitAnswersRequest {
+    UserTestResultId: string;
+    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;
+}
+
+declare class HCSafeCDXClient {
+    private readonly http;
+    private readonly auth;
+    private readonly host;
+    private readonly defaultLanguage;
+    private readonly defaultImageType;
+    private apiKeyHeaderName?;
+    private apiKeyValue?;
+    constructor(httpClient: HttpClient, authClient: HCLoginClient, config: SafeCDXConfig);
+    setApiKey(headerName: string, value: string): void;
+    private getAuthHeaders;
+    private getJsonHeaders;
+    private getApiKeyHeader;
+    private url;
+    /**
+     * GET gs1/:gtin
+     * Resolves a test profile by GTIN barcode and creates a UserTestResultId.
+     */
+    getTestProfileByGTIN(gtin: string, language?: string): Promise<ApiResponse<GetTestProfileByGTINData>>;
+    /**
+     * POST scan/2ddm
+     * Scans a 2D data matrix barcode and resolves a UserTestResultId.
+     */
+    scan2Ddm(payload: Scan2DdmRequest): Promise<ApiResponse<ScanUpcResponseData>>;
+    /**
+     * POST test/profile
+     * Returns the full test profile for a given GTIN.
+     */
+    getTestProfile(payload: GetTestProfileRequest): Promise<ApiResponse<GetTestProfileByGTINData>>;
+    /**
+     * POST test/profiles/by-account
+     * Lists all test profiles available to the authenticated account.
+     */
+    getTestProfilesByAccount(payload?: GetTestProfilesByAccountRequest): Promise<ApiResponse<unknown>>;
+    /**
+     * POST upload/url
+     * Requests a pre-signed S3 URL for image upload.
+     * Use the returned Data.preSignedURL and Data.Metadata.UploadId in the next steps.
+     */
+    createUploadUrl(userTestResultId: string, gtin: string, imageType?: string): Promise<ApiResponse<CreateUploadUrlData>>;
+    /**
+     * PUT preSignedURL — direct S3 upload, not a SafeCDX API route.
+     * preSignedURL comes from createUploadUrl() response: Data.preSignedURL.
+     *
+     * This intentionally does not use the shared HttpClient because the existing
+     * HttpClient.put() is JSON-oriented and stringifies the request body.
+     */
+    uploadImage(preSignedURL: string, image: BodyInit, contentType?: string): Promise<void>;
+    /**
+     * POST cvml/status
+     * 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>;
+    /**
+     * 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>;
+    /**
+     * POST test/result/pending
+     * Returns test results in a pending/incomplete state.
+     */
+    getPendingResults(payload?: GetPendingResultsRequest): Promise<ApiResponse<unknown>>;
+    /**
+     * POST test/result/last
+     * Returns the most recent test result for the authenticated patient.
+     */
+    getLastResults(payload?: GetLastResultsRequest): Promise<ApiResponse<unknown>>;
+    /**
+     * POST test/result/history
+     * Returns the full test history for the authenticated patient.
+     */
+    getTestHistory(payload?: GetTestHistoryRequest): Promise<ApiResponse<unknown>>;
+    /**
+     * 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>;
+    /**
+     * POST test/result/pdf
+     * Generates a PDF report for a specific test result.
+     */
+    getResultPdf(payload: GetResultPdfRequest): Promise<ApiResponse<unknown>>;
+    /**
+     * POST test/result/image/capture
+     * Returns the image capture URL 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>>;
+    /**
+     * POST test/resume
+     * Marks a test attempt as resumed (or not).
+     */
+    resumeFlow(userTestResultId: string, resumed?: boolean): Promise<ApiResponse<unknown>>;
+    /**
+     * POST test/answers
+     * Submits analyte answers for a test attempt.
+     */
+    submitAnswers(payload: SubmitAnswersRequest): Promise<ApiResponse<unknown>>;
+    /**
+     * POST test/finalize
+     * Finalizes a test attempt with CTA, indication, and decision results.
+     */
+    finalizeTest(payload: FinalizeTestRequest): Promise<ApiResponse<unknown>>;
+}
+
+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 Scan2DdmRequest, type ScanUpcAnalyte, type ScanUpcArticle, type ScanUpcBillingInfo, type ScanUpcInstruction, type ScanUpcOrderableData, type ScanUpcResponseData, type ScanUpcScanImageDetail, type ScanUpcTerritory, type ScanUpcTestResult, type SubmitAnswersRequest, type UpdateCvmlStatusRequest };