@metriport/commonwell-cert-runner 1.26.18 → 2.0.0-alpha.0

package/README.md

@@ -1,107 +1,247 @@
-# `commonwell-cert-runner`
+# CommonWell Certification Runner
 
-CommonWell Certification Runner by Metriport Inc.
+A comprehensive tool by Metriport Inc. for running through CommonWell Alliance certification test cases and validating your integration with the CommonWell network.
 
-Tool to run through Edge System CommonWell certification test cases.
+## What It Does
 
-## Install
+The CommonWell Certification Runner automates the testing of CommonWell API integration across five main certification areas:
 
-To install the program, execute the following command on your terminal:
+### 1. Organization Management (`org-management.ts`)
 
-`npm i -g @metriport/commonwell-cert-runner`
+- Creates, retrieves, updates, and manages CommonWell organizations
+- Handles certificate management (add, replace, delete certificates)
+- Validates organization CRUD operations
+- Tests member-level organization management APIs
 
-Note: you may have to run the command with `sudo`.
+### 2. Patient Management (`patient-management.ts`)
 
-## Usage
+- Creates and updates patients with test demographics
+- Tests patient merge operations
+- Validates patient deletion workflows
+- Uses predefined test patients (Tracy Crane, Connie Carin)
+- Automatically cleans up test patients after execution
+
+### 3. Link Management (`link-management.ts`)
+
+- Tests patient linking and unlinking operations
+- Validates probable link detection and management
+- Tests link reset functionality
+- Uses demographic matching to find potential patient links
+
+### 4. Document Consumption (`document-consumption.ts`)
+
+- Queries for external documents on test patients
+- Downloads and stores document references and contents
+- Tests document retrieval workflows
+- Supports multiple document statuses (current, superseded, entered-in-error)
+
+### 5. Document Contribution (`document-contribution.ts`)
+
+- Tests document contribution workflows between organizations
+- Creates patients on both contributor and consumer organizations
+- Links patients across organizations
+- Initializes HTTP server for document contribution responses
+- Validates end-to-end document sharing
+- Requires a public URL to respond to the requests from CommonWell (reverse proxy -
+  see `src/flows/document-contribution.ts`).
+
+## Requirements
+
+### Prerequisites
+
+- Node.js 18+
+- npm or yarn package manager
+- CommonWell Alliance membership and credentials
+
+### CommonWell Credentials
+
+You need the following credentials from CommonWell:
+
+**Member Organization (Service Adopter):**
+
+- Member ID and OID
+- Member name
+- RSA private key and certificate for member operations
+
+**Organization (Your Organization):**
+
+- Organization OID
+- Organization name
+- RSA private key and certificate for organization operations
+- Gateway endpoint configuration
+- OAuth 2.0 credentials for document contribution
+
+## Installation
 
-After installation, create a `.env` file defining the following variables:
-
-- `COMMONWELL_ORG_NAME`: the organization that will be making the requests.
-- `COMMONWELL_OID`: the organization ID.
-- `COMMONWELL_SANDBOX_ORG_NAME`: the organization on sandbox for patient management and document contribution
-  - should be configured with your FHIR server and OAuth 2 data on Commonwell management portal
-- `COMMONWELL_SANDBOX_OID`: the ID of the organization above
-- `COMMONWELL_ORG_PRIVATE_KEY`: the RSA256 private key corresponding to the specified organization.
-- `COMMONWELL_ORG_CERTIFICATE`: the public certificate/key corresponding to the private key.
-- `COMMONWELL_MEMBER_OID`: the member ID for organization management
-- `COMMONWELL_MEMBER_PRIVATE_KEY`: the RSA256 private key corresponding to the specified member management organization.
-- `COMMONWELL_MEMBER_CERTIFICATE`: the public certificate/key corresponding to the private key.
-- `DOCUMENT_PATIENT_FIRST_NAME`: the first name of a patient created along with the sandbox that has a document associated
-- `DOCUMENT_PATIENT_LAST_NAME`: their last name
-- `DOCUMENT_PATIENT_DATE_OF_BIRTH`: their date of birth on the format YYYY-MM-DD
-- `DOCUMENT_PATIENT_GENDER`: their gender (M|F)
-- `DOCUMENT_PATIENT_ZIP`: their address zip code
-- `DOCUMENT_CONTRIBUTION_ORGANIZATION_ID`: organization suffix for the document contribution flow (usually in the format
-  "2.dddddd", with 'd' being a digit)
-- `DOCUMENT_CONTRIBUTION_PATIENT_FIRST_NAME`: the first name of the patient to be created on the organization used for the
-  document contribution flow - same for the properties below [optional, defaults to the same name from the document patient
-  above]
-- `DOCUMENT_CONTRIBUTION_PATIENT_LAST_NAME`
-- `DOCUMENT_CONTRIBUTION_PATIENT_DATE_OF_BIRTH`
-- `DOCUMENT_CONTRIBUTION_PATIENT_GENDER`
-- `DOCUMENT_CONTRIBUTION_PATIENT_ZIP`
-- `DOCUMENT_CONTRIBUTION_URL`: the url of the server where the documents are stored
-- `DOCUMENT_CONTRIBUTION_FHIRURL`: the direct url of the FHIR server where the documents are stored, with no authentication required
-- `DOCUMENT_CONTRIBUTION_AUTH_URL`: the url of the server used to authenticate document contribution requests
-- `DOCUMENT_CONTRIBUTION_CLIENT_ID`: the client OAuth ID to authenticate document contribution requests
-- `DOCUMENT_CONTRIBUTION_CLIENT_SECRET`: the client OAuth secret to authenticate document contribution requests
-
-flow - must exist on the sandbox organization
-
-Example file content looks like:
+### Global Installation
 
+```bash
+npm install -g @metriport/commonwell-cert-runner
 ```
-COMMONWELL_ORG_NAME=Metriport
-COMMONWELL_OID=2.16.840.1.113883.3.9621
-COMMONWELL_SANDBOX_ORG_NAME=Metriport-OrgA-1620
-COMMONWELL_SANDBOX_OID=2.16.840.1.113883.3.3330.8889429.1620.1
-COMMONWELL_ORG_PRIVATE_KEY="-----BEGIN PRIVATE KEY-----
-...
------END PRIVATE KEY-----"
-COMMONWELL_ORG_CERTIFICATE="-----BEGIN CERTIFICATE-----
+
+### Local Development
+
+```bash
+git clone <repository>
+cd packages/commonwell-cert-runner
+npm install
+npm run build
+```
+
+## Configuration
+
+Create a `.env` file with the following required variables:
+
+### Member Organization Configuration
+
+```env
+# Member (Service Adopter) credentials
+CW_MEMBER_ID=your-member-id
+CW_MEMBER_OID=1.2.3.4.5.678
+CW_MEMBER_NAME=Your Member Name
+CW_MEMBER_CERTIFICATE="-----BEGIN CERTIFICATE-----
 ...
 -----END CERTIFICATE-----"
-COMMONWELL_MEMBER_OID=1.3.6.1.4.1.18.12.29.2022.945
-COMMONWELL_ORG_PRIVATE_KEY="-----BEGIN PRIVATE KEY-----
+CW_MEMBER_PRIVATE_KEY="-----BEGIN PRIVATE KEY-----
 ...
 -----END PRIVATE KEY-----"
-COMMONWELL_ORG_CERTIFICATE="-----BEGIN CERTIFICATE-----
+```
+
+### Organization Configuration
+
+```env
+# Your organization credentials
+CW_ORG_CERTIFICATE="-----BEGIN CERTIFICATE-----
 ...
 -----END CERTIFICATE-----"
-DOCUMENT_PATIENT_FIRST_NAME="Stephen"
-DOCUMENT_PATIENT_LAST_NAME="Pujols1234"
-DOCUMENT_PATIENT_DATE_OF_BIRTH="1955-10-23"
-DOCUMENT_PATIENT_GENDER="M"
-DOCUMENT_PATIENT_ZIP="62732"
-# This is optional, if not set the runner will attempt to create the patient above on the sandbox org
-DOCUMENT_CONTRIBUTION_PATIENT_ID=<patient-id>%5E%5E%5Eurn%3aoid%3a<org-id>
+CW_ORG_PRIVATE_KEY="-----BEGIN PRIVATE KEY-----
+...
+-----END PRIVATE KEY-----"
+CW_ORG_GATEWAY_ENDPOINT=https://your-gateway.example.com/fhir
+CW_ORG_GATEWAY_AUTHORIZATION_SERVER_ENDPOINT=https://auth.example.com/oauth/token
+CW_ORG_GATEWAY_AUTHORIZATION_CLIENT_ID=your-client-id
+CW_ORG_GATEWAY_AUTHORIZATION_CLIENT_SECRET=your-client-secret
+
+# Optional: Use existing organization instead of creating new one
+CW_ORG_ID=1.2.3.4.5.678.5.123
 ```
 
-After the file is created, you can run execute following command on your terminal to run the program:
+### Contribution Server Configuration
 
-`cw-cert-runner --env-file "/path/to/created/env/file/.env"`
+These configuration variables are used to configure the contribution server. This
+should be a public URL that is accessible from the CommonWell network. See
+item #5. Document Contribution above for more details.
 
-## Options
+```env
+CONTRIB_SERVER_URL=https://your-contrib-server.example.com/with/path
+CONTRIB_SERVER_PORT=8088
+```
 
-`--env-file <file-path>`
+## Usage
+
+### Run Complete Certification Suite
+
+```bash
+cw-cert-runner
+```
+
+## Entry Points
+
+### Main Entry Point
+
+- **File**: `src/index.ts`
+- **Function**: `main()`
+- **Purpose**: Orchestrates the complete certification flow
+
+### Individual Flow Entry Points
+
+If you want to run individual flows, you can comment out the other flows in `src/index.ts`.
+
+1. **Organization Management**: `src/flows/org-management.ts`
+
+   - `orgManagement()`: Complete org management flow
+   - `getOneOrg()`: Retrieve specific organization
+   - `initApiForExistingOrg()`: Initialize API for existing org
+
+2. **Patient Management**: `src/flows/patient-management.ts`
+
+   - `patientManagement()`: Complete patient management flow
+
+3. **Link Management**: `src/flows/link-management.ts`
+
+   - `linkManagement()`: Complete link management flow
+
+4. **Document Consumption**: `src/flows/document-consumption.ts`
 
-Absolute path to the .env file containing required config.
+   - `documentConsumption()`: Complete document consumption flow
+   - `queryDocuments()`: Query documents for a patient
+   - `retrieveDocument()`: Download specific document
 
-`-V, --version`
+5. **Document Contribution**: `src/flows/document-contribution.ts`
+   - `documentContribution()`: Complete document contribution flow
 
-Output the version number.
+### Single Commands
 
-`-h, --help`
+For targeted testing, use individual commands in `src/single-commands/`:
 
-Display help for command.
+- `init-contrib-server.ts`: Initialize document contribution server
+- `patient-create.ts`: Create a single patient
+- `patient-get.ts`: Retrieve a patient
+- `patient-delete.ts`: Delete a patient
+- `patient-get-links.ts`: Get patient links
+- `document-parse.ts`: Parse document responses
+
+### Console Output
+
+The runner provides detailed console output including:
+
+- Transaction IDs for each API call
+- Request/response payloads
+- Success/failure status for each operation
+- Patient IDs and document references
+
+### File Output
+
+Documents are downloaded to:
+
+- `./downloads-consumption/`: Document consumption downloads
+- `./downloads-contribution/`: Document contribution downloads
+
+### Error Handling
+
+- Failed flows are logged with transaction IDs
+- Stack traces are preserved for debugging
+- Graceful cleanup of test data
+
+## Troubleshooting
+
+### Common Issues
+
+1. **Certificate Errors**: Ensure certificates are properly formatted with newlines
+2. **OAuth Errors**: Verify client credentials and endpoints
+3. **Patient Not Found**: Check patient demographics match test data
+4. **Document Download Failures**: Verify document URLs are accessible
 
 ## Development
 
-`npm run build`: builds the package
+```bash
+npm install # only has to be run once
+npm run build # run to build
+npm start # runs the code pointing to `./.env`
+```
+
+## License
+
+MIT License - see LICENSE file for details.
+
+## Support
+
+For issues and questions:
 
-`npm start`: runs the local code pointing to `./.env`
+- GitHub Issues: https://github.com/metriport/metriport/issues
+- Email: contact@metriport.com
 
-(optionally) `npm run install-local`: installs the package globally from the local source
+---
 
 ```
             ,▄,

package/dist/env.d.ts

@@ -0,0 +1,16 @@
+export declare const memberId: string;
+export declare const memberOID: string;
+export declare const memberName: string;
+export declare const memberCertificateString: string;
+export declare const memberPrivateKeyString: string;
+export declare const orgCertificateString: string;
+export declare const orgPrivateKeyString: string;
+export declare const orgGatewayEndpoint: string;
+export declare const orgGatewayAuthorizationServerEndpoint: string;
+export declare const orgGatewayAuthorizationClientId: string;
+export declare const orgGatewayAuthorizationClientSecret: string;
+/** If set, the cert runner will use this org and not try to create a new one. */
+export declare const existingOrgId: string | undefined;
+export declare const contribServerUrl: string;
+export declare const contribServerPort: number;
+//# sourceMappingURL=env.d.ts.map

package/dist/env.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"env.d.ts","sourceRoot":"","sources":["../src/env.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,QAAQ,QAA+B,CAAC;AACrD,eAAO,MAAM,SAAS,QAAgC,CAAC;AACvD,eAAO,MAAM,UAAU,QAAiC,CAAC;AACzD,eAAO,MAAM,uBAAuB,QAAwC,CAAC;AAC7E,eAAO,MAAM,sBAAsB,QAAwC,CAAC;AAE5E,eAAO,MAAM,oBAAoB,QAAqC,CAAC;AACvE,eAAO,MAAM,mBAAmB,QAAqC,CAAC;AACtE,eAAO,MAAM,kBAAkB,QAA0C,CAAC;AAC1E,eAAO,MAAM,qCAAqC,QAEjD,CAAC;AACF,eAAO,MAAM,+BAA+B,QAE3C,CAAC;AACF,eAAO,MAAM,mCAAmC,QAE/C,CAAC;AACF,iFAAiF;AACjF,eAAO,MAAM,aAAa,oBAAsB,CAAC;AAEjD,eAAO,MAAM,gBAAgB,QAAqC,CAAC;AACnE,eAAO,MAAM,iBAAiB,QAAgD,CAAC"}

package/dist/env.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.contribServerPort = exports.contribServerUrl = exports.existingOrgId = exports.orgGatewayAuthorizationClientSecret = exports.orgGatewayAuthorizationClientId = exports.orgGatewayAuthorizationServerEndpoint = exports.orgGatewayEndpoint = exports.orgPrivateKeyString = exports.orgCertificateString = exports.memberPrivateKeyString = exports.memberCertificateString = exports.memberName = exports.memberOID = exports.memberId = void 0;
+const util_1 = require("./util");
+exports.memberId = (0, util_1.getEnvOrFail)("CW_MEMBER_ID");
+exports.memberOID = (0, util_1.getEnvOrFail)("CW_MEMBER_OID");
+exports.memberName = (0, util_1.getEnvOrFail)("CW_MEMBER_NAME");
+exports.memberCertificateString = (0, util_1.getEnvOrFail)("CW_MEMBER_CERTIFICATE");
+exports.memberPrivateKeyString = (0, util_1.getEnvOrFail)("CW_MEMBER_PRIVATE_KEY");
+exports.orgCertificateString = (0, util_1.getEnvOrFail)("CW_ORG_CERTIFICATE");
+exports.orgPrivateKeyString = (0, util_1.getEnvOrFail)("CW_ORG_PRIVATE_KEY");
+exports.orgGatewayEndpoint = (0, util_1.getEnvOrFail)("CW_ORG_GATEWAY_ENDPOINT");
+exports.orgGatewayAuthorizationServerEndpoint = (0, util_1.getEnvOrFail)("CW_ORG_GATEWAY_AUTHORIZATION_SERVER_ENDPOINT");
+exports.orgGatewayAuthorizationClientId = (0, util_1.getEnvOrFail)("CW_ORG_GATEWAY_AUTHORIZATION_CLIENT_ID");
+exports.orgGatewayAuthorizationClientSecret = (0, util_1.getEnvOrFail)("CW_ORG_GATEWAY_AUTHORIZATION_CLIENT_SECRET");
+/** If set, the cert runner will use this org and not try to create a new one. */
+exports.existingOrgId = (0, util_1.getEnv)("CW_ORG_ID");
+exports.contribServerUrl = (0, util_1.getEnvOrFail)("CONTRIB_SERVER_URL");
+exports.contribServerPort = parseInt((0, util_1.getEnvOrFail)("CONTRIB_SERVER_PORT"));
+//# sourceMappingURL=env.js.map

package/dist/env.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"env.js","sourceRoot":"","sources":["../src/env.ts"],"names":[],"mappings":";;;AAAA,iCAA8C;AAEjC,QAAA,QAAQ,GAAG,IAAA,mBAAY,EAAC,cAAc,CAAC,CAAC;AACxC,QAAA,SAAS,GAAG,IAAA,mBAAY,EAAC,eAAe,CAAC,CAAC;AAC1C,QAAA,UAAU,GAAG,IAAA,mBAAY,EAAC,gBAAgB,CAAC,CAAC;AAC5C,QAAA,uBAAuB,GAAG,IAAA,mBAAY,EAAC,uBAAuB,CAAC,CAAC;AAChE,QAAA,sBAAsB,GAAG,IAAA,mBAAY,EAAC,uBAAuB,CAAC,CAAC;AAE/D,QAAA,oBAAoB,GAAG,IAAA,mBAAY,EAAC,oBAAoB,CAAC,CAAC;AAC1D,QAAA,mBAAmB,GAAG,IAAA,mBAAY,EAAC,oBAAoB,CAAC,CAAC;AACzD,QAAA,kBAAkB,GAAG,IAAA,mBAAY,EAAC,yBAAyB,CAAC,CAAC;AAC7D,QAAA,qCAAqC,GAAG,IAAA,mBAAY,EAC/D,8CAA8C,CAC/C,CAAC;AACW,QAAA,+BAA+B,GAAG,IAAA,mBAAY,EACzD,wCAAwC,CACzC,CAAC;AACW,QAAA,mCAAmC,GAAG,IAAA,mBAAY,EAC7D,4CAA4C,CAC7C,CAAC;AACF,iFAAiF;AACpE,QAAA,aAAa,GAAG,IAAA,aAAM,EAAC,WAAW,CAAC,CAAC;AAEpC,QAAA,gBAAgB,GAAG,IAAA,mBAAY,EAAC,oBAAoB,CAAC,CAAC;AACtD,QAAA,iBAAiB,GAAG,QAAQ,CAAC,IAAA,mBAAY,EAAC,qBAAqB,CAAC,CAAC,CAAC"}

package/dist/flows/contribution/binary.d.ts

@@ -0,0 +1,11 @@
+export declare function makeBinary({ binaryId, contentType, contents: contentsParam, }?: {
+    binaryId?: string;
+    contentType?: string;
+    contents?: string;
+}): {
+    resourceType: string;
+    id: string;
+    contentType: string;
+    data: string;
+};
+//# sourceMappingURL=binary.d.ts.map

package/dist/flows/contribution/binary.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"binary.d.ts","sourceRoot":"","sources":["../../../src/flows/contribution/binary.ts"],"names":[],"mappings":"AAKA,wBAAgB,UAAU,CAAC,EACzB,QAAmB,EACnB,WAA+B,EAC/B,QAAQ,EAAE,aAAa,GACxB,GAAE;IAAE,QAAQ,CAAC,EAAE,MAAM,CAAC;IAAC,WAAW,CAAC,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,EAAE,MAAM,CAAA;CAAO;;;;;EAUrE"}

package/dist/flows/contribution/binary.js

@@ -0,0 +1,23 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.makeBinary = void 0;
+const shared_1 = require("@metriport/shared");
+const fs_1 = __importDefault(require("fs"));
+const nanoid_1 = require("nanoid");
+const path_1 = __importDefault(require("path"));
+function makeBinary({ binaryId = (0, nanoid_1.nanoid)(), contentType = "application/xml", contents: contentsParam, } = {}) {
+    const contents = contentsParam ?? fs_1.default.readFileSync(path_1.default.join(__dirname, "ccda.xml"), "utf8");
+    const encodedData = (0, shared_1.stringToBase64)(contents);
+    const binary = {
+        resourceType: "Binary",
+        id: `${binaryId}`,
+        contentType,
+        data: `${encodedData}`,
+    };
+    return binary;
+}
+exports.makeBinary = makeBinary;
+//# sourceMappingURL=binary.js.map

package/dist/flows/contribution/binary.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"binary.js","sourceRoot":"","sources":["../../../src/flows/contribution/binary.ts"],"names":[],"mappings":";;;;;;AAAA,8CAAmD;AACnD,4CAAoB;AACpB,mCAAgC;AAChC,gDAAwB;AAExB,SAAgB,UAAU,CAAC,EACzB,QAAQ,GAAG,IAAA,eAAM,GAAE,EACnB,WAAW,GAAG,iBAAiB,EAC/B,QAAQ,EAAE,aAAa,MAC2C,EAAE;IACpE,MAAM,QAAQ,GAAG,aAAa,IAAI,YAAE,CAAC,YAAY,CAAC,cAAI,CAAC,IAAI,CAAC,SAAS,EAAE,UAAU,CAAC,EAAE,MAAM,CAAC,CAAC;IAC5F,MAAM,WAAW,GAAG,IAAA,uBAAc,EAAC,QAAQ,CAAC,CAAC;IAC7C,MAAM,MAAM,GAAG;QACb,YAAY,EAAE,QAAQ;QACtB,EAAE,EAAE,GAAG,QAAQ,EAAE;QACjB,WAAW;QACX,IAAI,EAAE,GAAG,WAAW,EAAE;KACvB,CAAC;IACF,OAAO,MAAM,CAAC;AAChB,CAAC;AAdD,gCAcC"}

package/dist/flows/contribution/contribution-server.d.ts

@@ -0,0 +1,8 @@
+import { CommonWell } from "@metriport/commonwell-sdk";
+/**
+ * Initialize the HTTP server for the contribution flow.
+ *
+ * @param commonWellParam - The CommonWell instance to use for the contribution flow.
+ */
+export declare function initContributionHttpServer(commonWellParam: CommonWell): Promise<void>;
+//# sourceMappingURL=contribution-server.d.ts.map

package/dist/flows/contribution/contribution-server.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"contribution-server.d.ts","sourceRoot":"","sources":["../../../src/flows/contribution/contribution-server.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,UAAU,EAAE,MAAM,2BAA2B,CAAC;AAkJvD;;;;GAIG;AACH,wBAAsB,0BAA0B,CAAC,eAAe,EAAE,UAAU,iBAO3E"}

package/dist/flows/contribution/contribution-server.js

@@ -0,0 +1,174 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.initContributionHttpServer = void 0;
+const dotenv = __importStar(require("dotenv"));
+dotenv.config();
+// Keep dotenv import/setup before all other imports
+const faker_1 = require("@faker-js/faker");
+const bundle_1 = require("@metriport/core/external/fhir/bundle/bundle");
+const express_1 = __importDefault(require("express"));
+const env_1 = require("../../env");
+const binary_1 = require("./binary");
+const document_reference_1 = require("./document-reference");
+const token_1 = require("./token");
+/**
+ * The contribution server is a simple HTTP server that handles requests from CommonWell
+ * to support the contribution flow.
+ *
+ * It is used to:
+ * - generate the OAuth 2.0 token (POST /oauth/token)
+ * - return the list of documents for a given patient (GET /oauth/fhir/DocumentReference)
+ * - return the document (GET /oauth/fhir/Binary/:id)
+ *
+ * See the function initContributionHttpServer() further down for the initialization.
+ */
+let commonWell;
+const app = (0, express_1.default)();
+app.use(express_1.default.urlencoded({ extended: false, limit: "2mb" }));
+app.use(express_1.default.json({ limit: "2mb" }));
+/**
+ * Endpoint to generate OAuth 2.0 token
+ */
+app.post("/oauth/token", express_1.default.urlencoded({ extended: true }), (req, res) => {
+    try {
+        console.log(`\nToken request`);
+        console.log(`>>> Headers: ${JSON.stringify(req.headers, null, 2)}`);
+        console.log(`>>> Path: ${req.path}`);
+        console.log(`>>> Query: ${JSON.stringify(req.query, null, 2)}`);
+        console.log(`>>> Body: ${JSON.stringify(req.body, null, 2)}`);
+        const accessToken = (0, token_1.makeToken)(req, commonWell.oid, commonWell.orgName);
+        const oauthResponse = {
+            access_token: accessToken,
+            token_type: "Bearer",
+        };
+        res.status(200).json(oauthResponse);
+    }
+    catch (error) {
+        console.log("Token generation failed:", error);
+        res.status(400).json({
+            error: "invalid_request",
+            error_description: error instanceof Error ? error.message : "Unknown error",
+        });
+    }
+});
+/**
+ * Endpoint to retrieve a DocumentReference resource.
+ *
+ * Query params provided by CW v2:
+ *  "_include": [
+ *    "DocumentReference:subject",
+ *    "DocumentReference:patient",
+ *    "DocumentReference:author",
+ *    "DocumentReference:custodian",
+ *    "DocumentReference:authenticator",
+ *    "DocumentReference:encounter"
+ * ],
+ * "subject": "<org-oid>|<patient-id>",
+ * "patient": "<org-oid>|<patient-id>",
+ */
+app.get("/oauth/fhir/DocumentReference", async (req, res) => {
+    console.log(`\nDocumentReference request`);
+    console.log(`>>> Headers: ${JSON.stringify(req.headers, null, 2)}`);
+    console.log(`>>> Path: ${req.path}`);
+    console.log(`>>> Query: ${JSON.stringify(req.query, null, 2)}`);
+    console.log(`>>> Body: ${JSON.stringify(req.body, null, 2)}`);
+    if (!(0, token_1.verifySignature)(req)) {
+        console.log(`Token verification failed`);
+        res.sendStatus(401);
+        return;
+    }
+    console.log(`Token verification successful!!!`);
+    const patientId = (req.query.patient ?? req.query.subject ?? "").toString();
+    if (!patientId) {
+        console.log(`>>> No patient ID found in query`);
+        res.status(400).json(buildResponseMessage("No patient ID found in query"));
+        return;
+    }
+    const binaryId = faker_1.faker.string.uuid();
+    const docRef = (0, document_reference_1.makeDocumentReference)({
+        memberOID: env_1.memberOID,
+        orgId: commonWell.oid,
+        orgName: commonWell.orgName,
+        patientId,
+        docUrl: env_1.contribServerUrl,
+        binaryId,
+    });
+    const entry = (0, bundle_1.buildBundleEntry)(docRef);
+    const respPayload = (0, bundle_1.buildSearchSetBundle)([entry]);
+    res.status(200).json(respPayload);
+});
+/**
+ * Endpoint to retrieve a document. This is called after the DocumentReference endpoint,
+ * with the ID being the binaryId present on the DocumentReference resource returned by
+ * that endpoint.
+ */
+app.get("/oauth/fhir/Binary/:id", async (req, res) => {
+    console.log(`\nBinary request`);
+    console.log(`>>> Headers: ${JSON.stringify(req.headers, null, 2)}`);
+    console.log(`>>> Path: ${req.path}`);
+    console.log(`>>> Query: ${JSON.stringify(req.query, null, 2)}`);
+    console.log(`>>> Body: ${JSON.stringify(req.body, null, 2)}`);
+    if (!(0, token_1.verifySignature)(req)) {
+        console.log(`Token verification failed`);
+        res.sendStatus(401);
+        return;
+    }
+    console.log(`Token verification successful!!!`);
+    const binary = (0, binary_1.makeBinary)();
+    res.status(200).json(binary);
+});
+app.use(express_1.default.json({ limit: "2mb" }));
+app.all("*", async (req, res) => {
+    console.log(`\nNOT FOUND`);
+    console.log(`>>> Headers: ${JSON.stringify(req.headers, null, 2)}`);
+    console.log(`>>> Path: ${req.path}`);
+    console.log(`>>> Query: ${JSON.stringify(req.query, null, 2)}`);
+    console.log(`>>> Body: ${JSON.stringify(req.body, null, 2)}`);
+    res.sendStatus(404);
+});
+/**
+ * Initialize the HTTP server for the contribution flow.
+ *
+ * @param commonWellParam - The CommonWell instance to use for the contribution flow.
+ */
+async function initContributionHttpServer(commonWellParam) {
+    commonWell = commonWellParam;
+    const port = env_1.contribServerPort;
+    app.listen(port, "0.0.0.0", async () => {
+        console.log(`[server]: HTTP server is running on port ${port}`);
+    });
+}
+exports.initContributionHttpServer = initContributionHttpServer;
+function buildResponseMessage(message) {
+    return {
+        resourceType: "OperationOutcome",
+        issue: [{ severity: "error", code: "invalid", details: { text: message } }],
+    };
+}
+//# sourceMappingURL=contribution-server.js.map

package/dist/flows/contribution/contribution-server.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"contribution-server.js","sourceRoot":"","sources":["../../../src/flows/contribution/contribution-server.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,+CAAiC;AACjC,MAAM,CAAC,MAAM,EAAE,CAAC;AAChB,oDAAoD;AACpD,2CAAwC;AAExC,wEAGqD;AACrD,sDAAkE;AAClE,mCAA2E;AAC3E,qCAAsC;AACtC,6DAA6D;AAC7D,mCAAqD;AAErD;;;;;;;;;;GAUG;AACH,IAAI,UAAsB,CAAC;AAE3B,MAAM,GAAG,GAAgB,IAAA,iBAAO,GAAE,CAAC;AAEnC,GAAG,CAAC,GAAG,CAAC,iBAAO,CAAC,UAAU,CAAC,EAAE,QAAQ,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC;AAC/D,GAAG,CAAC,GAAG,CAAC,iBAAO,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC;AAExC;;GAEG;AACH,GAAG,CAAC,IAAI,CACN,cAAc,EACd,iBAAO,CAAC,UAAU,CAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,EACtC,CAAC,GAAY,EAAE,GAAa,EAAQ,EAAE;IACpC,IAAI;QACF,OAAO,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAC;QAC/B,OAAO,CAAC,GAAG,CAAC,gBAAgB,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC;QACpE,OAAO,CAAC,GAAG,CAAC,aAAa,GAAG,CAAC,IAAI,EAAE,CAAC,CAAC;QACrC,OAAO,CAAC,GAAG,CAAC,cAAc,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC;QAChE,OAAO,CAAC,GAAG,CAAC,aAAa,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC;QAE9D,MAAM,WAAW,GAAG,IAAA,iBAAS,EAAC,GAAG,EAAE,UAAU,CAAC,GAAG,EAAE,UAAU,CAAC,OAAO,CAAC,CAAC;QAEvE,MAAM,aAAa,GAAG;YACpB,YAAY,EAAE,WAAW;YACzB,UAAU,EAAE,QAAQ;SACrB,CAAC;QACF,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;KACrC;IAAC,OAAO,KAAK,EAAE;QACd,OAAO,CAAC,GAAG,CAAC,0BAA0B,EAAE,KAAK,CAAC,CAAC;QAC/C,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC;YACnB,KAAK,EAAE,iBAAiB;YACxB,iBAAiB,EAAE,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,eAAe;SAC5E,CAAC,CAAC;KACJ;AACH,CAAC,CACF,CAAC;AAEF;;;;;;;;;;;;;;GAcG;AACH,GAAG,CAAC,GAAG,CAAC,+BAA+B,EAAE,KAAK,EAAE,GAAY,EAAE,GAAa,EAAiB,EAAE;IAC5F,OAAO,CAAC,GAAG,CAAC,6BAA6B,CAAC,CAAC;IAC3C,OAAO,CAAC,GAAG,CAAC,gBAAgB,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC;IACpE,OAAO,CAAC,GAAG,CAAC,aAAa,GAAG,CAAC,IAAI,EAAE,CAAC,CAAC;IACrC,OAAO,CAAC,GAAG,CAAC,cAAc,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC;IAChE,OAAO,CAAC,GAAG,CAAC,aAAa,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC;IAE9D,IAAI,CAAC,IAAA,uBAAe,EAAC,GAAG,CAAC,EAAE;QACzB,OAAO,CAAC,GAAG,CAAC,2BAA2B,CAAC,CAAC;QACzC,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;QACpB,OAAO;KACR;IACD,OAAO,CAAC,GAAG,CAAC,kCAAkC,CAAC,CAAC;IAEhD,MAAM,SAAS,GAAG,CAAC,GAAG,CAAC,KAAK,CAAC,OAAO,IAAI,GAAG,CAAC,KAAK,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC;IAC5E,IAAI,CAAC,SAAS,EAAE;QACd,OAAO,CAAC,GAAG,CAAC,kCAAkC,CAAC,CAAC;QAChD,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,oBAAoB,CAAC,8BAA8B,CAAC,CAAC,CAAC;QAC3E,OAAO;KACR;IAED,MAAM,QAAQ,GAAG,aAAK,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC;IACrC,MAAM,MAAM,GAAG,IAAA,0CAAqB,EAAC;QACnC,SAAS,EAAT,eAAS;QACT,KAAK,EAAE,UAAU,CAAC,GAAG;QACrB,OAAO,EAAE,UAAU,CAAC,OAAO;QAC3B,SAAS;QACT,MAAM,EAAE,sBAAgB;QACxB,QAAQ;KACT,CAAC,CAAC;IACH,MAAM,KAAK,GAAG,IAAA,yBAAgB,EAAC,MAAM,CAAC,CAAC;IACvC,MAAM,WAAW,GAAG,IAAA,6BAAoB,EAAC,CAAC,KAAK,CAAC,CAAC,CAAC;IAElD,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;AACpC,CAAC,CAAC,CAAC;AAEH;;;;GAIG;AACH,GAAG,CAAC,GAAG,CAAC,wBAAwB,EAAE,KAAK,EAAE,GAAY,EAAE,GAAa,EAAiB,EAAE;IACrF,OAAO,CAAC,GAAG,CAAC,kBAAkB,CAAC,CAAC;IAChC,OAAO,CAAC,GAAG,CAAC,gBAAgB,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC;IACpE,OAAO,CAAC,GAAG,CAAC,aAAa,GAAG,CAAC,IAAI,EAAE,CAAC,CAAC;IACrC,OAAO,CAAC,GAAG,CAAC,cAAc,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC;IAChE,OAAO,CAAC,GAAG,CAAC,aAAa,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC;IAE9D,IAAI,CAAC,IAAA,uBAAe,EAAC,GAAG,CAAC,EAAE;QACzB,OAAO,CAAC,GAAG,CAAC,2BAA2B,CAAC,CAAC;QACzC,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;QACpB,OAAO;KACR;IACD,OAAO,CAAC,GAAG,CAAC,kCAAkC,CAAC,CAAC;IAEhD,MAAM,MAAM,GAAG,IAAA,mBAAU,GAAE,CAAC;IAE5B,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;AAC/B,CAAC,CAAC,CAAC;AAEH,GAAG,CAAC,GAAG,CAAC,iBAAO,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC;AAExC,GAAG,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,EAAE,GAAY,EAAE,GAAa,EAAiB,EAAE;IAChE,OAAO,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC;IAC3B,OAAO,CAAC,GAAG,CAAC,gBAAgB,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC;IACpE,OAAO,CAAC,GAAG,CAAC,aAAa,GAAG,CAAC,IAAI,EAAE,CAAC,CAAC;IACrC,OAAO,CAAC,GAAG,CAAC,cAAc,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC;IAChE,OAAO,CAAC,GAAG,CAAC,aAAa,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC;IAC9D,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;AACtB,CAAC,CAAC,CAAC;AAEH;;;;GAIG;AACI,KAAK,UAAU,0BAA0B,CAAC,eAA2B;IAC1E,UAAU,GAAG,eAAe,CAAC;IAE7B,MAAM,IAAI,GAAG,uBAAiB,CAAC;IAC/B,GAAG,CAAC,MAAM,CAAC,IAAI,EAAE,SAAS,EAAE,KAAK,IAAI,EAAE;QACrC,OAAO,CAAC,GAAG,CAAC,4CAA4C,IAAI,EAAE,CAAC,CAAC;IAClE,CAAC,CAAC,CAAC;AACL,CAAC;AAPD,gEAOC;AAED,SAAS,oBAAoB,CAAC,OAAe;IAC3C,OAAO;QACL,YAAY,EAAE,kBAAkB;QAChC,KAAK,EAAE,CAAC,EAAE,QAAQ,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,EAAE,CAAC;KAC5E,CAAC;AACJ,CAAC"}

package/dist/flows/contribution/document-reference.d.ts

@@ -0,0 +1,9 @@
+export declare function makeDocumentReference({ memberOID, orgId, orgName, patientId, docUrl, binaryId, }: {
+    memberOID: string;
+    orgId: string;
+    orgName: string;
+    patientId: string;
+    docUrl: string;
+    binaryId: string;
+}): any;
+//# sourceMappingURL=document-reference.d.ts.map

package/dist/flows/contribution/document-reference.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"document-reference.d.ts","sourceRoot":"","sources":["../../../src/flows/contribution/document-reference.ts"],"names":[],"mappings":"AAEA,wBAAgB,qBAAqB,CAAC,EACpC,SAAS,EACT,KAAK,EACL,OAAO,EACP,SAAS,EACT,MAAM,EACN,QAAQ,GACT,EAAE;IACD,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;CAClB,OAqFA"}