@healthcloudai/hc-safe-cdx 0.2.2 → 0.4.0

package/dist/index.d.cts

@@ -1,27 +1,8 @@
 import { HCLoginClient } from '@healthcloudai/hc-login-connector';
-import { HttpClient } from '@healthcloudai/hc-http';
+export { Environment } from '@healthcloudai/hc-login-connector';
+import { HCBaseConnector, HttpClient, APIResponse } from '@healthcloudai/hc-http';
+export { APIError, APIResponse, ConfigError, HCServiceError, NetworkError, ValidationError } from '@healthcloudai/hc-http';
 
-type Environment = "dev" | "uat" | "prod";
-/**
- * Health Cloud request envelope.
- *
- * SDK consumers provide only method arguments or the inner payload.
- * HCSafeCDXClient creates the Data wrapper internally.
- */
-interface APIRequest<T> {
-    Data: T;
-}
-/**
- * Standard Health Cloud API response envelope.
- *
- * Connector methods return this response without unwrapping or transforming it.
- * Data may be null when the backend returns an unsuccessful response.
- */
-interface APIResponse<T> {
-    Data: T | null;
-    IsOK: boolean;
-    ErrorMessage: string | null;
-}
 /**
  * SafeCDX service response.
  *
@@ -416,11 +397,7 @@ type GetResultDetailsRequest = UserTestResultIdRequest;
 type GetResultPdfRequest = UserTestResultIdRequest;
 type GetImageCaptureUrlRequest = UserTestResultIdRequest;
 type FinalizeTestRequest = UserTestResultIdRequest;
-type GetPendingResultsData = SafeAPIResponse<TestResultSummary[]>;
-type GetLastResultsData = SafeAPIResponse<TestResultDetails>;
-type GetTestHistoryData = SafeAPIResponse<TestResultSummary[]>;
 type GetResultDetailsResponse = SafeAPIResponse<TestResultDetails>;
-type GetResultPdfData = SafeAPIResponse<string>;
 type GetImageCaptureUrlResponse = SafeAPIResponse<string>;
 interface ResumeFlowRequest extends UserTestResultIdRequest {
     Resumed: boolean;
@@ -433,7 +410,6 @@ interface ResumeFlowResult {
     failoverTriggered: boolean;
     showValidity: boolean;
 }
-type ResumeFlowData = SafeAPIResponse<ResumeFlowResult>;
 interface AnswerResult {
     Analyte: string;
     ReportedValue: string;
@@ -447,21 +423,16 @@ interface AnswerResult {
 interface SubmitAnswersRequest extends UserTestResultIdRequest {
     Result: AnswerResult[];
 }
-type SubmitAnswersData = SafeAPIResponse<EntityReferenceData>;
 /**
  * The client sends only UserTestResultId
  
  */
 type FinalizeTestData = unknown;
 
-declare class HCSafeCDXClient {
-    private readonly http;
-    private readonly loginClient;
+declare class HCSafeCDXClient extends HCBaseConnector {
+    private readonly auth;
     private readonly baseUrl;
-    private apiKeyHeaderName?;
-    private apiKeyValue?;
     constructor(httpClient: HttpClient, loginClient: HCLoginClient);
-    setApiKey(headerName: string, value: string): void;
     /**
      * GET gs1/:gtin
      * Resolves the SafeCDX test profile associated with a GTIN barcode.
@@ -469,11 +440,11 @@ declare class HCSafeCDXClient {
     getTestProfileByGTIN(gtin: string): Promise<APIResponse<GetTestProfileByGTINData>>;
     /**
      * POST test/profiles/by-account
-
      *
+     * Returns test profiles configured for the authenticated patient's account.
      * TenantId is resolved by the backend from the authenticated patient context.
      */
-    getTestProfilesByAccount(includeRegisterTestDetails?: boolean): Promise<APIResponse<GetTestProfilesByAccountData>>;
+    listTestProfilesByAccount(includeRegisterTestDetails?: boolean): Promise<SafeAPIResponse<TestProfileByAccountItem[]>>;
     /**
      * POST upload/url
      * Requests a pre-signed URL used to upload a test image.
@@ -483,52 +454,49 @@ declare class HCSafeCDXClient {
      * PUT preSignedURL
      * Uploads the image directly to the pre-signed storage URL.
      *
-     * This request does not call a SafeCDX API route and does not send
-     * authenticated Health Cloud headers.
+     * This request does NOT call a SafeCDX API route and does NOT send
+     * Health Cloud auth headers — it targets the storage provider directly.
+     * The pre-signed URL embeds credentials; no Authorization header is needed.
      */
     uploadImage(preSignedURL: string, image: BodyInit, contentType?: string): Promise<void>;
     /**
      * POST cvml/status
-     * Returns the direct SafeCDX response without an outer APIResponse wrapper.
+     * Updates the CVML processing status for an image capture.
      */
     updateCvmlStatus(imageOfCaptureId: string, cvmlStatus: string): Promise<UpdateCvmlStatusResponse>;
     /**
      * GET cvml/results
-     * Returns the direct SafeCDX response without an outer APIResponse wrapper.
+     * Returns the CVML analysis results for an image capture.
      */
     getCvmlResults(imageOfCaptureId: string): Promise<GetCvmlResultsResponse>;
-    /** POST test/result/pending */
-    getPendingResults(excludeStatus?: string): Promise<APIResponse<GetPendingResultsData>>;
-    /** POST test/result/last */
-    getLastResults(excludeStatus?: string): Promise<APIResponse<GetLastResultsData>>;
-    /** POST test/result/history */
-    getTestHistory(excludeStatus?: string): Promise<APIResponse<GetTestHistoryData>>;
+    /** POST test/result/pending — returns pending test results excluding the given statuses. */
+    listPendingResults(excludeStatus?: string): Promise<SafeAPIResponse<TestResultSummary[]>>;
+    /** POST test/result/last — returns the most recent test result. */
+    getLastResults(excludeStatus?: string): Promise<SafeAPIResponse<TestResultDetails>>;
+    /** POST test/result/history — returns all test results excluding the given statuses. */
+    listTestHistory(excludeStatus?: string): Promise<SafeAPIResponse<TestResultSummary[]>>;
     /**
      * POST test/result/details
-     * Returns the direct SafeCDX response without an outer APIResponse wrapper.
+     * Returns full details for a single test result.
      */
     getResultDetails(userTestResultId: string): Promise<GetResultDetailsResponse>;
-    /** POST test/result/pdf */
-    getResultPdf(userTestResultId: string): Promise<APIResponse<GetResultPdfData>>;
+    /** POST test/result/pdf — returns the PDF report for a test result. */
+    getResultPdf(userTestResultId: string): Promise<SafeAPIResponse<string>>;
     /**
      * POST test/result/image/capture
-     * Returns the direct SafeCDX response without an outer APIResponse wrapper.
+     * Returns a URL to capture an image for the given test result.
      */
     getImageCaptureUrl(userTestResultId: string): Promise<GetImageCaptureUrlResponse>;
     /** POST test/resume */
-    resumeFlow(userTestResultId: string, resumed?: boolean): Promise<APIResponse<ResumeFlowData>>;
+    resumeFlow(userTestResultId: string, resumed?: boolean): Promise<SafeAPIResponse<ResumeFlowResult>>;
     /** POST test/answers */
-    submitAnswers(submission: SubmitAnswersRequest): Promise<APIResponse<SubmitAnswersData>>;
+    submitAnswers(submission: SubmitAnswersRequest): Promise<SafeAPIResponse<EntityReferenceData>>;
     /** POST test/finalize */
-    finalizeTest(userTestResultId: string): Promise<APIResponse<FinalizeTestData>>;
+    finalizeTest(userTestResultId: string): Promise<APIResponse<unknown>>;
+    protected executeSafe<T>(operation: string, request: () => Promise<SafeAPIResponse<T>>): Promise<SafeAPIResponse<T>>;
+    private isSafeApiResponse;
     private getAuthHeaders;
-    private getJsonHeaders;
-    private getApiKeyHeader;
     private url;
 }
 
-declare class ConfigError extends Error {
-    constructor(message: string);
-}
-
-export { type APIRequest, type APIResponse, type AnswerResult, type CaptureState, ConfigError, type CreateUploadUrlData, type CreateUploadUrlRequest, type CvmlImageOfCaptureResult, type CvmlParsedResult, type CvmlResultsData, type DiagnosticProfileCta, type DiagnosticProfileData, type DiagnosticProfileDecision, type DiagnosticProfileDecisionResult, type DiagnosticProfileIndication, type DiagnosticProfileTestInfo, type DisclaimerDetail, type EntityReferenceData, type Environment, type ExcludeStatusRequest, type FinalizeTestData, 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 ImageOfCaptureResult, type ProductAssetDetail, type QuestionnaireAnalyte, type QuestionnaireAnalyteResponse, type QuestionnaireSnapshot, type QuestionnaireValidityItem, type RegisterTestDetail, type ReportedAnswerResult, type ResumeFlowData, type ResumeFlowRequest, type ResumeFlowResult, type SafeAPIResponse, type SubmitAnswersData, type SubmitAnswersRequest, type TestProfileAnalyte, type TestProfileAnalyteResponse, type TestProfileArticle, type TestProfileBillingInfo, type TestProfileByAccountItem, type TestProfileInstruction, type TestProfileResult, type TestProfileScanImageDetail, type TestProfileTerritory, type TestResultDetails, type TestResultSummary, type UpdateCvmlStatusRequest, type UpdateCvmlStatusResponse, type UploadMetadata, type UserTestResultIdRequest };
+export { type AnswerResult, type CaptureState, type CreateUploadUrlData, type CreateUploadUrlRequest, type CvmlImageOfCaptureResult, type CvmlParsedResult, type CvmlResultsData, type DiagnosticProfileCta, type DiagnosticProfileData, type DiagnosticProfileDecision, type DiagnosticProfileDecisionResult, type DiagnosticProfileIndication, type DiagnosticProfileTestInfo, type DisclaimerDetail, type EntityReferenceData, type ExcludeStatusRequest, type FinalizeTestData, type FinalizeTestRequest, type GetCvmlResultsResponse, type GetImageCaptureUrlRequest, type GetImageCaptureUrlResponse, type GetLastResultsRequest, type GetPendingResultsRequest, type GetResultDetailsRequest, type GetResultDetailsResponse, type GetResultPdfRequest, type GetTestHistoryRequest, type GetTestProfileByGTINData, type GetTestProfilesByAccountData, type GetTestProfilesByAccountRequest, HCSafeCDXClient, type ImageOfCaptureResult, type ProductAssetDetail, type QuestionnaireAnalyte, type QuestionnaireAnalyteResponse, type QuestionnaireSnapshot, type QuestionnaireValidityItem, type RegisterTestDetail, type ReportedAnswerResult, type ResumeFlowRequest, type ResumeFlowResult, type SafeAPIResponse, type SubmitAnswersRequest, type TestProfileAnalyte, type TestProfileAnalyteResponse, type TestProfileArticle, type TestProfileBillingInfo, type TestProfileByAccountItem, type TestProfileInstruction, type TestProfileResult, type TestProfileScanImageDetail, type TestProfileTerritory, type TestResultDetails, type TestResultSummary, type UpdateCvmlStatusRequest, type UpdateCvmlStatusResponse, type UploadMetadata, type UserTestResultIdRequest };

package/dist/index.d.ts

@@ -1,27 +1,8 @@
 import { HCLoginClient } from '@healthcloudai/hc-login-connector';
-import { HttpClient } from '@healthcloudai/hc-http';
+export { Environment } from '@healthcloudai/hc-login-connector';
+import { HCBaseConnector, HttpClient, APIResponse } from '@healthcloudai/hc-http';
+export { APIError, APIResponse, ConfigError, HCServiceError, NetworkError, ValidationError } from '@healthcloudai/hc-http';
 
-type Environment = "dev" | "uat" | "prod";
-/**
- * Health Cloud request envelope.
- *
- * SDK consumers provide only method arguments or the inner payload.
- * HCSafeCDXClient creates the Data wrapper internally.
- */
-interface APIRequest<T> {
-    Data: T;
-}
-/**
- * Standard Health Cloud API response envelope.
- *
- * Connector methods return this response without unwrapping or transforming it.
- * Data may be null when the backend returns an unsuccessful response.
- */
-interface APIResponse<T> {
-    Data: T | null;
-    IsOK: boolean;
-    ErrorMessage: string | null;
-}
 /**
  * SafeCDX service response.
  *
@@ -416,11 +397,7 @@ type GetResultDetailsRequest = UserTestResultIdRequest;
 type GetResultPdfRequest = UserTestResultIdRequest;
 type GetImageCaptureUrlRequest = UserTestResultIdRequest;
 type FinalizeTestRequest = UserTestResultIdRequest;
-type GetPendingResultsData = SafeAPIResponse<TestResultSummary[]>;
-type GetLastResultsData = SafeAPIResponse<TestResultDetails>;
-type GetTestHistoryData = SafeAPIResponse<TestResultSummary[]>;
 type GetResultDetailsResponse = SafeAPIResponse<TestResultDetails>;
-type GetResultPdfData = SafeAPIResponse<string>;
 type GetImageCaptureUrlResponse = SafeAPIResponse<string>;
 interface ResumeFlowRequest extends UserTestResultIdRequest {
     Resumed: boolean;
@@ -433,7 +410,6 @@ interface ResumeFlowResult {
     failoverTriggered: boolean;
     showValidity: boolean;
 }
-type ResumeFlowData = SafeAPIResponse<ResumeFlowResult>;
 interface AnswerResult {
     Analyte: string;
     ReportedValue: string;
@@ -447,21 +423,16 @@ interface AnswerResult {
 interface SubmitAnswersRequest extends UserTestResultIdRequest {
     Result: AnswerResult[];
 }
-type SubmitAnswersData = SafeAPIResponse<EntityReferenceData>;
 /**
  * The client sends only UserTestResultId
  
  */
 type FinalizeTestData = unknown;
 
-declare class HCSafeCDXClient {
-    private readonly http;
-    private readonly loginClient;
+declare class HCSafeCDXClient extends HCBaseConnector {
+    private readonly auth;
     private readonly baseUrl;
-    private apiKeyHeaderName?;
-    private apiKeyValue?;
     constructor(httpClient: HttpClient, loginClient: HCLoginClient);
-    setApiKey(headerName: string, value: string): void;
     /**
      * GET gs1/:gtin
      * Resolves the SafeCDX test profile associated with a GTIN barcode.
@@ -469,11 +440,11 @@ declare class HCSafeCDXClient {
     getTestProfileByGTIN(gtin: string): Promise<APIResponse<GetTestProfileByGTINData>>;
     /**
      * POST test/profiles/by-account
-
      *
+     * Returns test profiles configured for the authenticated patient's account.
      * TenantId is resolved by the backend from the authenticated patient context.
      */
-    getTestProfilesByAccount(includeRegisterTestDetails?: boolean): Promise<APIResponse<GetTestProfilesByAccountData>>;
+    listTestProfilesByAccount(includeRegisterTestDetails?: boolean): Promise<SafeAPIResponse<TestProfileByAccountItem[]>>;
     /**
      * POST upload/url
      * Requests a pre-signed URL used to upload a test image.
@@ -483,52 +454,49 @@ declare class HCSafeCDXClient {
      * PUT preSignedURL
      * Uploads the image directly to the pre-signed storage URL.
      *
-     * This request does not call a SafeCDX API route and does not send
-     * authenticated Health Cloud headers.
+     * This request does NOT call a SafeCDX API route and does NOT send
+     * Health Cloud auth headers — it targets the storage provider directly.
+     * The pre-signed URL embeds credentials; no Authorization header is needed.
      */
     uploadImage(preSignedURL: string, image: BodyInit, contentType?: string): Promise<void>;
     /**
      * POST cvml/status
-     * Returns the direct SafeCDX response without an outer APIResponse wrapper.
+     * Updates the CVML processing status for an image capture.
      */
     updateCvmlStatus(imageOfCaptureId: string, cvmlStatus: string): Promise<UpdateCvmlStatusResponse>;
     /**
      * GET cvml/results
-     * Returns the direct SafeCDX response without an outer APIResponse wrapper.
+     * Returns the CVML analysis results for an image capture.
      */
     getCvmlResults(imageOfCaptureId: string): Promise<GetCvmlResultsResponse>;
-    /** POST test/result/pending */
-    getPendingResults(excludeStatus?: string): Promise<APIResponse<GetPendingResultsData>>;
-    /** POST test/result/last */
-    getLastResults(excludeStatus?: string): Promise<APIResponse<GetLastResultsData>>;
-    /** POST test/result/history */
-    getTestHistory(excludeStatus?: string): Promise<APIResponse<GetTestHistoryData>>;
+    /** POST test/result/pending — returns pending test results excluding the given statuses. */
+    listPendingResults(excludeStatus?: string): Promise<SafeAPIResponse<TestResultSummary[]>>;
+    /** POST test/result/last — returns the most recent test result. */
+    getLastResults(excludeStatus?: string): Promise<SafeAPIResponse<TestResultDetails>>;
+    /** POST test/result/history — returns all test results excluding the given statuses. */
+    listTestHistory(excludeStatus?: string): Promise<SafeAPIResponse<TestResultSummary[]>>;
     /**
      * POST test/result/details
-     * Returns the direct SafeCDX response without an outer APIResponse wrapper.
+     * Returns full details for a single test result.
      */
     getResultDetails(userTestResultId: string): Promise<GetResultDetailsResponse>;
-    /** POST test/result/pdf */
-    getResultPdf(userTestResultId: string): Promise<APIResponse<GetResultPdfData>>;
+    /** POST test/result/pdf — returns the PDF report for a test result. */
+    getResultPdf(userTestResultId: string): Promise<SafeAPIResponse<string>>;
     /**
      * POST test/result/image/capture
-     * Returns the direct SafeCDX response without an outer APIResponse wrapper.
+     * Returns a URL to capture an image for the given test result.
      */
     getImageCaptureUrl(userTestResultId: string): Promise<GetImageCaptureUrlResponse>;
     /** POST test/resume */
-    resumeFlow(userTestResultId: string, resumed?: boolean): Promise<APIResponse<ResumeFlowData>>;
+    resumeFlow(userTestResultId: string, resumed?: boolean): Promise<SafeAPIResponse<ResumeFlowResult>>;
     /** POST test/answers */
-    submitAnswers(submission: SubmitAnswersRequest): Promise<APIResponse<SubmitAnswersData>>;
+    submitAnswers(submission: SubmitAnswersRequest): Promise<SafeAPIResponse<EntityReferenceData>>;
     /** POST test/finalize */
-    finalizeTest(userTestResultId: string): Promise<APIResponse<FinalizeTestData>>;
+    finalizeTest(userTestResultId: string): Promise<APIResponse<unknown>>;
+    protected executeSafe<T>(operation: string, request: () => Promise<SafeAPIResponse<T>>): Promise<SafeAPIResponse<T>>;
+    private isSafeApiResponse;
     private getAuthHeaders;
-    private getJsonHeaders;
-    private getApiKeyHeader;
     private url;
 }
 
-declare class ConfigError extends Error {
-    constructor(message: string);
-}
-
-export { type APIRequest, type APIResponse, type AnswerResult, type CaptureState, ConfigError, type CreateUploadUrlData, type CreateUploadUrlRequest, type CvmlImageOfCaptureResult, type CvmlParsedResult, type CvmlResultsData, type DiagnosticProfileCta, type DiagnosticProfileData, type DiagnosticProfileDecision, type DiagnosticProfileDecisionResult, type DiagnosticProfileIndication, type DiagnosticProfileTestInfo, type DisclaimerDetail, type EntityReferenceData, type Environment, type ExcludeStatusRequest, type FinalizeTestData, 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 ImageOfCaptureResult, type ProductAssetDetail, type QuestionnaireAnalyte, type QuestionnaireAnalyteResponse, type QuestionnaireSnapshot, type QuestionnaireValidityItem, type RegisterTestDetail, type ReportedAnswerResult, type ResumeFlowData, type ResumeFlowRequest, type ResumeFlowResult, type SafeAPIResponse, type SubmitAnswersData, type SubmitAnswersRequest, type TestProfileAnalyte, type TestProfileAnalyteResponse, type TestProfileArticle, type TestProfileBillingInfo, type TestProfileByAccountItem, type TestProfileInstruction, type TestProfileResult, type TestProfileScanImageDetail, type TestProfileTerritory, type TestResultDetails, type TestResultSummary, type UpdateCvmlStatusRequest, type UpdateCvmlStatusResponse, type UploadMetadata, type UserTestResultIdRequest };
+export { type AnswerResult, type CaptureState, type CreateUploadUrlData, type CreateUploadUrlRequest, type CvmlImageOfCaptureResult, type CvmlParsedResult, type CvmlResultsData, type DiagnosticProfileCta, type DiagnosticProfileData, type DiagnosticProfileDecision, type DiagnosticProfileDecisionResult, type DiagnosticProfileIndication, type DiagnosticProfileTestInfo, type DisclaimerDetail, type EntityReferenceData, type ExcludeStatusRequest, type FinalizeTestData, type FinalizeTestRequest, type GetCvmlResultsResponse, type GetImageCaptureUrlRequest, type GetImageCaptureUrlResponse, type GetLastResultsRequest, type GetPendingResultsRequest, type GetResultDetailsRequest, type GetResultDetailsResponse, type GetResultPdfRequest, type GetTestHistoryRequest, type GetTestProfileByGTINData, type GetTestProfilesByAccountData, type GetTestProfilesByAccountRequest, HCSafeCDXClient, type ImageOfCaptureResult, type ProductAssetDetail, type QuestionnaireAnalyte, type QuestionnaireAnalyteResponse, type QuestionnaireSnapshot, type QuestionnaireValidityItem, type RegisterTestDetail, type ReportedAnswerResult, type ResumeFlowRequest, type ResumeFlowResult, type SafeAPIResponse, type SubmitAnswersRequest, type TestProfileAnalyte, type TestProfileAnalyteResponse, type TestProfileArticle, type TestProfileBillingInfo, type TestProfileByAccountItem, type TestProfileInstruction, type TestProfileResult, type TestProfileScanImageDetail, type TestProfileTerritory, type TestResultDetails, type TestResultSummary, type UpdateCvmlStatusRequest, type UpdateCvmlStatusResponse, type UploadMetadata, type UserTestResultIdRequest };