@healthcloudai/hc-safe-cdx 0.0.1 → 0.1.2

package/dist/index.js

@@ -0,0 +1,384 @@
+// src/client.ts
+var SafeCDXError = class _SafeCDXError extends Error {
+  constructor(message, response) {
+    super(message);
+    this.name = "SafeCDXError";
+    this.response = response;
+    Object.setPrototypeOf(this, _SafeCDXError.prototype);
+  }
+};
+var ENV_HOST = {
+  dev: "dev-api-hcs.healthcloud-services.com",
+  uat: "uat-api-hcs.healthcloud-services.com",
+  prod: "api-hcs.healthcloud-services.com"
+};
+var ROUTE_PREFIX = "api/console/hcservice/safecdx";
+function buildUrl(host, route, query) {
+  const url = new URL(
+    `https://${host}/${ROUTE_PREFIX}/${route.replace(/^\/+/, "")}`
+  );
+  if (query) {
+    for (const [key, value] of Object.entries(query)) {
+      if (value !== void 0 && value !== "") {
+        url.searchParams.set(key, value);
+      }
+    }
+  }
+  return url.toString();
+}
+function wrapData(payload) {
+  return { Data: payload };
+}
+function assertApiResponse(envelope, route) {
+  var _a;
+  if (!envelope.IsOK) {
+    throw new SafeCDXError(
+      (_a = envelope.ErrorMessage) != null ? _a : `${route} returned IsOK=false.`,
+      envelope
+    );
+  }
+  return envelope;
+}
+var HCSafeCDXClient = class {
+  constructor(httpClient, authClient, config) {
+    var _a;
+    if (!ENV_HOST[config.environment]) {
+      throw new SafeCDXError(`Invalid environment: ${config.environment}`);
+    }
+    this.http = httpClient;
+    this.auth = authClient;
+    this.host = ENV_HOST[config.environment];
+    this.defaultLanguage = config.defaultLanguage;
+    this.defaultImageType = (_a = config.defaultImageType) != null ? _a : "jpg";
+  }
+  setApiKey(headerName, value) {
+    const trimmedHeaderName = headerName == null ? void 0 : headerName.trim();
+    const trimmedValue = value == null ? void 0 : value.trim();
+    if (!trimmedHeaderName) {
+      throw new SafeCDXError("API key header name is required.");
+    }
+    if (!trimmedValue) {
+      throw new SafeCDXError("API key value is required.");
+    }
+    this.apiKeyHeaderName = trimmedHeaderName;
+    this.apiKeyValue = trimmedValue;
+  }
+  // ---------------------------------------------------------------------------
+  // Private helpers
+  // ---------------------------------------------------------------------------
+  getAuthHeaders() {
+    return {
+      ...this.auth.getAuthHeader(),
+      ...this.getApiKeyHeader()
+    };
+  }
+  getJsonHeaders() {
+    return {
+      ...this.getAuthHeaders(),
+      "Content-Type": "application/json"
+    };
+  }
+  getApiKeyHeader() {
+    if (!this.apiKeyHeaderName || !this.apiKeyValue) {
+      return {};
+    }
+    return {
+      [this.apiKeyHeaderName]: this.apiKeyValue
+    };
+  }
+  url(route, query) {
+    return buildUrl(this.host, route, query);
+  }
+  // ---------------------------------------------------------------------------
+  // Scan
+  // ---------------------------------------------------------------------------
+  /**
+   * GET gs1/:gtin
+   * Resolves a test profile by GTIN barcode and creates a UserTestResultId.
+   */
+  async getTestProfileByGTIN(gtin, language) {
+    const envelope = await this.http.get(
+      this.url(`gs1/${encodeURIComponent(gtin)}`, {
+        language: language != null ? language : this.defaultLanguage
+      }),
+      this.getAuthHeaders()
+    );
+    return assertApiResponse(envelope, "gs1/:gtin");
+  }
+  /**
+   * POST scan/2ddm
+   * Scans a 2D data matrix barcode and resolves a UserTestResultId.
+   */
+  async scan2Ddm(payload) {
+    const envelope = await this.http.post(
+      this.url("scan/2ddm"),
+      wrapData(payload),
+      this.getJsonHeaders()
+    );
+    return assertApiResponse(envelope, "scan/2ddm");
+  }
+  // ---------------------------------------------------------------------------
+  // Test Profiles
+  // ---------------------------------------------------------------------------
+  /**
+   * POST test/profile
+   * Returns the full test profile for a given GTIN.
+   */
+  async getTestProfile(payload) {
+    const envelope = await this.http.post(
+      this.url("test/profile"),
+      wrapData(payload),
+      this.getJsonHeaders()
+    );
+    return assertApiResponse(envelope, "test/profile");
+  }
+  /**
+   * POST test/profiles/by-account
+   * Lists all test profiles available to the authenticated account.
+   */
+  async getTestProfilesByAccount(payload = {
+    IncludeRegisterTestDetails: true
+  }) {
+    const envelope = await this.http.post(
+      this.url("test/profiles/by-account"),
+      wrapData(payload),
+      this.getJsonHeaders()
+    );
+    return assertApiResponse(envelope, "test/profiles/by-account");
+  }
+  // ---------------------------------------------------------------------------
+  // Upload
+  // ---------------------------------------------------------------------------
+  /**
+   * 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.
+   */
+  async createUploadUrl(userTestResultId, gtin, imageType) {
+    const payload = {
+      Gtin: gtin,
+      UserTestResultId: userTestResultId,
+      Metadata: {
+        ImageType: imageType != null ? imageType : this.defaultImageType
+      }
+    };
+    const envelope = await this.http.post(
+      this.url("upload/url"),
+      wrapData(payload),
+      this.getJsonHeaders()
+    );
+    return assertApiResponse(envelope, "upload/url");
+  }
+  /**
+   * 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.
+   */
+  async uploadImage(preSignedURL, image, contentType = "image/jpeg") {
+    const response = await fetch(preSignedURL, {
+      method: "PUT",
+      headers: {
+        "Content-Type": contentType
+      },
+      body: image
+    });
+    if (!response.ok) {
+      let body;
+      try {
+        body = (await response.text()).slice(0, 500);
+      } catch {
+      }
+      throw new SafeCDXError(
+        `Image upload failed with HTTP ${response.status}.`,
+        {
+          status: response.status,
+          body
+        }
+      );
+    }
+  }
+  // ---------------------------------------------------------------------------
+  // CVML
+  // ---------------------------------------------------------------------------
+  /**
+   * POST cvml/status
+   * Updates the ML processing status for a captured image.
+   * NOTE: Returns raw service result — no ApiResponse wrapper on this endpoint.
+   */
+  async updateCvmlStatus(imageOfCaptureId, cvmlStatus) {
+    const payload = {
+      ImageOfCaptureId: imageOfCaptureId,
+      CvmlStatus: cvmlStatus
+    };
+    return this.http.post(
+      this.url("cvml/status"),
+      wrapData(payload),
+      this.getJsonHeaders()
+    );
+  }
+  /**
+   * GET cvml/results
+   * Polls ML analysis results for a captured image.
+   * NOTE: Returns raw service result — no ApiResponse wrapper on this endpoint.
+   */
+  async getCvmlResults(imageOfCaptureId) {
+    return this.http.get(
+      this.url("cvml/results", {
+        imageOfCaptureId
+      }),
+      this.getAuthHeaders()
+    );
+  }
+  // ---------------------------------------------------------------------------
+  // Test Results
+  // ---------------------------------------------------------------------------
+  /**
+   * POST test/result/pending
+   * Returns test results in a pending/incomplete state.
+   */
+  async getPendingResults(payload = {
+    ExcludeStatus: "Started"
+  }) {
+    const envelope = await this.http.post(
+      this.url("test/result/pending"),
+      wrapData(payload),
+      this.getJsonHeaders()
+    );
+    return assertApiResponse(envelope, "test/result/pending");
+  }
+  /**
+   * POST test/result/last
+   * Returns the most recent test result for the authenticated patient.
+   */
+  async getLastResults(payload = {}) {
+    const envelope = await this.http.post(
+      this.url("test/result/last"),
+      wrapData(payload),
+      this.getJsonHeaders()
+    );
+    return assertApiResponse(envelope, "test/result/last");
+  }
+  /**
+   * POST test/result/history
+   * Returns the full test history for the authenticated patient.
+   */
+  async getTestHistory(payload = {}) {
+    const envelope = await this.http.post(
+      this.url("test/result/history"),
+      wrapData(payload),
+      this.getJsonHeaders()
+    );
+    return assertApiResponse(envelope, "test/result/history");
+  }
+  /**
+   * POST test/result/details
+   * Returns detailed result data for a specific test attempt.
+   * NOTE: Returns raw service result — no ApiResponse wrapper on this endpoint.
+   */
+  async getResultDetails(userTestResultId) {
+    const payload = {
+      UserTestResultId: userTestResultId
+    };
+    return this.http.post(
+      this.url("test/result/details"),
+      wrapData(payload),
+      this.getJsonHeaders()
+    );
+  }
+  /**
+   * POST test/result/pdf
+   * Generates a PDF report for a specific test result.
+   */
+  async getResultPdf(payload) {
+    const envelope = await this.http.post(
+      this.url("test/result/pdf"),
+      wrapData(payload),
+      this.getJsonHeaders()
+    );
+    return assertApiResponse(envelope, "test/result/pdf");
+  }
+  /**
+   * 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.
+   */
+  async getImageCaptureUrl(userTestResultId) {
+    const payload = {
+      UserTestResultId: userTestResultId
+    };
+    return this.http.post(
+      this.url("test/result/image/capture"),
+      wrapData(payload),
+      this.getJsonHeaders()
+    );
+  }
+  /**
+   * POST test/result/analytics
+   * Returns analytics data for test results.
+   */
+  async getAnalytics(payload = {}) {
+    const envelope = await this.http.post(
+      this.url("test/result/analytics"),
+      wrapData(payload),
+      this.getJsonHeaders()
+    );
+    return assertApiResponse(envelope, "test/result/analytics");
+  }
+  // ---------------------------------------------------------------------------
+  // Resume / Answers / Finalize
+  // ---------------------------------------------------------------------------
+  /**
+   * POST test/resume
+   * Marks a test attempt as resumed (or not).
+   */
+  async resumeFlow(userTestResultId, resumed = true) {
+    const payload = {
+      UserTestResultId: userTestResultId,
+      Resumed: resumed
+    };
+    const envelope = await this.http.post(
+      this.url("test/resume"),
+      wrapData(payload),
+      this.getJsonHeaders()
+    );
+    return assertApiResponse(envelope, "test/resume");
+  }
+  /**
+   * POST test/answers
+   * Submits analyte answers for a test attempt.
+   */
+  async submitAnswers(payload) {
+    const envelope = await this.http.post(
+      this.url("test/answers"),
+      wrapData(payload),
+      this.getJsonHeaders()
+    );
+    return assertApiResponse(envelope, "test/answers");
+  }
+  /**
+   * POST test/finalize
+   * Finalizes a test attempt with CTA, indication, and decision results.
+   */
+  async finalizeTest(payload) {
+    const envelope = await this.http.post(
+      this.url("test/finalize"),
+      wrapData(payload),
+      this.getJsonHeaders()
+    );
+    return assertApiResponse(envelope, "test/finalize");
+  }
+};
+
+// src/errors.ts
+var ConfigError = class extends Error {
+  constructor(message) {
+    super(message);
+    this.name = "ConfigError";
+  }
+};
+export {
+  ConfigError,
+  HCSafeCDXClient
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@healthcloudai/hc-safe-cdx",
-  "version": "0.0.1",
+  "version": "0.1.2",
   "description": "Healthcheck Safe CDX connector.",
   "author": "Healthcheck Systems Inc",
   "license": "MIT",
@@ -32,6 +32,10 @@
     "lint": "eslint src --ext .ts",
     "prepublishOnly": "npm run build"
   },
+  "dependencies": {
+    "@healthcloudai/hc-http": "^0.0.6",
+    "@healthcloudai/hc-login-connector": "^0.0.15"
+  },
   "peerDependencies": {
     "react-native": ">=0.70.0"
   },