@icanbwell/bwell-sdk-ts 2.0.0-alpha.0-rc.1754330797 → 2.0.0-alpha.0-rc.1754488327

package/README.md

@@ -25,7 +25,6 @@ import { BWellSDK }
 
 const sdk = new BWellSDK({
   clientKey: "YOUR_CLIENT_KEY",
-  clientSecret: "YOUR_CLIENT_SECRET",
 });
 
 await sdk.initialize();
@@ -38,3 +37,20 @@ const healthSummaryResponse = sdk.health.getHealthSummary();
 
 const healthSummaryData = healthSummaryResponse.data;
 ```
+
+## Documentation
+
+For detailed documentation on generating external documentation sites
+(HTML/Markdown):
+
+📚 **[TypeDoc Documentation Guide]**
+
+Quick commands:
+
+```bash
+# Generate HTML documentation
+npm run generate:docs:html
+
+# Generate Readme documentation
+npm run generate:docs:readme
+```

package/dist/__version__.d.ts

@@ -1,4 +1,4 @@
 /**
  * This file is automatically generated. Please do not edit this file directly.
  */
-export declare const VERSION = "2.0.0-alpha.0-rc.1754330797";
+export declare const VERSION = "2.0.0-alpha.0-rc.1754488327";

package/dist/__version__.js

@@ -1,4 +1,4 @@
 /**
  * This file is automatically generated. Please do not edit this file directly.
  */
-export const VERSION = "2.0.0-alpha.0-rc.1754330797";
+export const VERSION = "2.0.0-alpha.0-rc.1754488327";

package/dist/api/base/connection/connection-manager.d.ts

@@ -1,26 +1,17 @@
-import { CreateConnectionMutationResults, DeleteConnectionMutationResults, DisconnectConnectionMutationResults, GetDataSourceQueryResults, GetOauthUrlQueryResults } from "../../../graphql/operations/types.js";
+import type { Connection, ConnectionStatus, DataSource, MemberConnection, OAuthUrl } from "../../../models/index.js";
 import type { BWellQueryResult, BWellTransactionResult } from "../../../results/index.js";
 import type { BaseManagerError } from "../errors.js";
 import { ConnectionRequest, DataSourceRequest } from "./connection-request.js";
-import { MemberConnection } from "./connection.js";
+/**
+ * @private
+ */
 export declare const MEMBER_CONNECTION_SUBSCRIPTION_STATUS_EXTENSION_ID = "data-connection-status";
-type DataSourceResultsType = GetDataSourceQueryResults["getDataSource"];
-export interface DataSourceResults extends DataSourceResultsType {
-}
-type CreateConnectionResultsType = CreateConnectionMutationResults["createConnection"];
-export interface CreateConnectionResults extends CreateConnectionResultsType {
-}
-type DisconnectConnectionResultsType = DisconnectConnectionMutationResults["disconnectConnection"];
-export interface DisconnectConnectionResults extends DisconnectConnectionResultsType {
-}
-type DeleteConnectionResultsType = DeleteConnectionMutationResults["deleteConnection"];
-export interface DeleteConnectionResults extends DeleteConnectionResultsType {
-}
-type OauthUrlResultsType = GetOauthUrlQueryResults["getOauthUrl"];
-export interface OauthUrlResults extends OauthUrlResultsType {
-}
 /**
- * The ConnectionManager interface provides methods for managing connections to data sources/healthcare providers.
+ * Connection Manager for data source connections and OAuth management.
+ * Provides methods for managing connections to healthcare providers and data sources.
+ * @title ConnectionManager
+ * @excerpt Connection Manager for data source connections and OAuth management
+ * @category Managers
  */
 export interface ConnectionManager {
     /**
@@ -31,44 +22,59 @@ export interface ConnectionManager {
      */
     getMemberConnections(): Promise<BWellQueryResult<MemberConnection[], BaseManagerError>>;
     /**
-     * Retrieves a DataSource by id.
-     *
-     * @param {DataSourceRequest<DataSourceRequestInput>} request The request object containing the connectionId of the DataSource to retrieve.
-     *
-     * @returns {Promise<BWellQueryResult<DataSourceResults>>} A promise resolving to an object representing the list of DataSource resources retrieved, along with potential validation or GraphQL errors.
+     * Retrieves a data source by ID.
+     * Gets information about a specific healthcare provider connection.
+     * @example
+     * ```typescript
+     * const dataSource = await sdk.connection.getDataSource({
+     *   connectionId: 'epic-123'
+     * });
+     * ```
      */
-    getDataSource(request: DataSourceRequest): Promise<BWellQueryResult<DataSourceResults, BaseManagerError>>;
+    getDataSource(request: DataSourceRequest): Promise<BWellQueryResult<DataSource, BaseManagerError>>;
     /**
-     * Creates a new Connection resource.
-     *
-     * @param {ConnectionRequest} request The request object containing the connectionId of the DataSource to create.
-     *
-     * @returns {Promise<BWellTransactionResult<CreateConnectionResults>>} A promise resolving to an object representing the list of Connection resources created, along with potential validation or GraphQL errors.
+     * Creates a new connection to a healthcare provider.
+     * Establishes a connection to retrieve health data.
+     * @example
+     * ```typescript
+     * await sdk.connection.createConnection({
+     *   connectionId: 'epic-123',
+     *   credentials: { username: 'user', password: 'pass' }
+     * });
+     * ```
      */
-    createConnection(request: ConnectionRequest): Promise<BWellTransactionResult<CreateConnectionResults, BaseManagerError>>;
+    createConnection(request: ConnectionRequest): Promise<BWellTransactionResult<Connection, BaseManagerError>>;
     /**
-     * Disconnects a Connection resource.
-     *
-     * @param {ConnectionRequest} request The request object containing the connectionId of the DataSource to disconnect.
-     *
-     * @returns {Promise<BWellTransactionResult<DisconnectConnectionResults>>} A promise resolving to an object representing the list of Connection resources disconnected, along with potential validation or GraphQL errors.
+     * Disconnects an existing connection.
+     * Stops data synchronization but preserves existing data.
+     * @example
+     * ```typescript
+     * await sdk.connection.disconnectConnection({
+     *   connectionId: 'epic-123'
+     * });
+     * ```
      */
-    disconnectConnection(request: DataSourceRequest): Promise<BWellTransactionResult<DisconnectConnectionResults, BaseManagerError>>;
+    disconnectConnection(request: DataSourceRequest): Promise<BWellTransactionResult<ConnectionStatus, BaseManagerError>>;
     /**
-     * Deletes a Connection resource.
-     *
-     * @param {DataSourceRequest} request The request object containing the connectionId of the DataSource to delete.
-     *
-     * @returns {Promise<BWellTransactionResult<DeleteConnectionResults>>} A promise resolving to an object representing the list of Connection resources deleted, along with potential validation or GraphQL errors.
+     * Permanently deletes a connection.
+     * Removes the connection and all associated data.
+     * @example
+     * ```typescript
+     * await sdk.connection.deleteConnection({
+     *   connectionId: 'epic-123'
+     * });
+     * ```
      */
-    deleteConnection(request: DataSourceRequest): Promise<BWellTransactionResult<DeleteConnectionResults, BaseManagerError>>;
+    deleteConnection(request: DataSourceRequest): Promise<BWellTransactionResult<ConnectionStatus, BaseManagerError>>;
     /**
-     * Retrieves an OAuth URL.
-     *
-     * @param {DataSourceRequest} request The request object containing the connectionId of the DataSource to retrieve the OAuth URL for.
-     *
-     * @returns {Promise<BWellQueryResult<OauthUrlResults>>} A promise resolving to an object representing the OAuth URL retrieved, along with potential validation or GraphQL errors.
+     * Retrieves OAuth URL for connection setup.
+     * Gets the authorization URL for OAuth-based connections.
+     * @example
+     * ```typescript
+     * const oauthUrl = await sdk.connection.getOauthUrl({
+     *   connectionId: 'epic-123'
+     * });
+     * ```
      */
-    getOauthUrl(request: DataSourceRequest): Promise<BWellQueryResult<OauthUrlResults, BaseManagerError>>;
+    getOauthUrl(request: DataSourceRequest): Promise<BWellQueryResult<OAuthUrl, BaseManagerError>>;
 }
-export {};

package/dist/api/base/connection/connection-manager.js

@@ -1 +1,4 @@
+/**
+ * @private
+ */
 export const MEMBER_CONNECTION_SUBSCRIPTION_STATUS_EXTENSION_ID = "data-connection-status";

package/dist/api/base/connection/connection-request.d.ts

@@ -13,12 +13,18 @@ export declare const UNDEFINED_USERNAME_ERROR = "username cannot be null or empt
 export declare const UNDEFINED_PASSWORD_ERROR = "password cannot be null or empty";
 /**
  * Input object for fetching a data source by connection id.
+ * @category Inputs
+ * @title DataSourceRequestInput
+ * @excerpt Input for fetching data source by connection id
  */
 export type DataSourceRequestInput = {
     connectionId: string;
 };
 /**
- * Input object for fetching a data source by connection id.
+ * Input object for creating a connection with authentication credentials.
+ * @category Inputs
+ * @title ConnectionRequestInput
+ * @excerpt Input for creating connection with credentials
  */
 export type ConnectionRequestInput = DataSourceRequestInput & {
     username: string;
@@ -39,17 +45,25 @@ export declare class ConnectionRequestValidator<T extends ConnectionRequestInput
 }
 /**
  * Base request object for interacting with the API using a connectionId.
+ * @title BaseDataSourceRequest
+ * @excerpt Base request object for interacting with the API using a connectionId
  */
 export declare class BaseDataSourceRequest<T extends DataSourceRequestInput> extends ValidationRequest<T> {
     protected validator: DataSourceRequestValidator<T>;
 }
 /**
  * Request object for interacting with the API using a connection id.
+ * @category Requests
+ * @title DataSourceRequest
+ * @excerpt Request object for interacting with the API using a connection id
  */
 export declare class DataSourceRequest extends BaseDataSourceRequest<DataSourceRequestInput> {
 }
 /**
  * Request object for creating a connection.
+ * @category Requests
+ * @title ConnectionRequest
+ * @excerpt Request object for creating a connection
  */
 export declare class ConnectionRequest extends BaseDataSourceRequest<ConnectionRequestInput> {
     protected validator: ConnectionRequestValidator<ConnectionRequestInput>;

package/dist/api/base/connection/connection-request.js

@@ -47,6 +47,8 @@ export class ConnectionRequestValidator {
 _ConnectionRequestValidator_dataSourceRequestValidator = new WeakMap();
 /**
  * Base request object for interacting with the API using a connectionId.
+ * @title BaseDataSourceRequest
+ * @excerpt Base request object for interacting with the API using a connectionId
  */
 export class BaseDataSourceRequest extends ValidationRequest {
     constructor() {
@@ -56,11 +58,17 @@ export class BaseDataSourceRequest extends ValidationRequest {
 }
 /**
  * Request object for interacting with the API using a connection id.
+ * @category Requests
+ * @title DataSourceRequest
+ * @excerpt Request object for interacting with the API using a connection id
  */
 export class DataSourceRequest extends BaseDataSourceRequest {
 }
 /**
  * Request object for creating a connection.
+ * @category Requests
+ * @title ConnectionRequest
+ * @excerpt Request object for creating a connection
  */
 export class ConnectionRequest extends BaseDataSourceRequest {
     constructor() {

package/dist/api/base/connection/index.d.ts

@@ -1,3 +1,2 @@
-export { DataSourceResults, CreateConnectionResults, DisconnectConnectionResults, DeleteConnectionResults, OauthUrlResults, MEMBER_CONNECTION_SUBSCRIPTION_STATUS_EXTENSION_ID, ConnectionManager, } from "./connection-manager.js";
-export { MemberConnection } from "./connection.js";
+export { MEMBER_CONNECTION_SUBSCRIPTION_STATUS_EXTENSION_ID, ConnectionManager, } from "./connection-manager.js";
 export { DataSourceRequest, DataSourceRequestInput, ConnectionRequest, ConnectionRequestInput, } from "./connection-request.js";

package/dist/api/base/health-data/health-data-request.d.ts

@@ -1,14 +1,32 @@
 import { ErrorsCollector, PagedRequest, PagedRequestInput, PagedRequestValidator, Validator } from "../../../requests/index.js";
 import { SearchDate } from "../requests/search-date.js";
 import { SearchToken } from "../requests/search-token.js";
+/**
+ * Input type for health data requests. Used to specify filters and pagination for health data queries.
+ * @category Inputs
+ * @title HealthDataRequestInput
+ * @excerpt Input for health data queries with filters and pagination
+ */
 export type HealthDataRequestInput = PagedRequestInput & {
     ids?: string[];
     groupCode?: SearchToken;
     lastUpdated?: SearchDate;
 };
+/**
+ * Input type for care team requests. Used to filter care teams by category.
+ * @category Inputs
+ * @title CareTeamRequestInput
+ * @excerpt Input for filtering care teams by category
+ */
 export type CareTeamRequestInput = PagedRequestInput & {
     category?: string;
 };
+/**
+ * Input type for binary data requests. Requires specific IDs to fetch binary resources.
+ * @category Inputs
+ * @title BinaryRequestInput
+ * @excerpt Input for fetching binary resources by IDs
+ */
 export type BinaryRequestInput = PagedRequestInput & {
     ids: string[];
 };
@@ -52,111 +70,175 @@ export declare class BinaryRequestValidator extends PagedRequestValidator<Binary
 }
 /**
  * Base request object for fetching health data.
+ * @category Requests
+ * @title HealthDataRequest
+ * @excerpt Base request object for fetching health data
  */
 export declare class HealthDataRequest extends PagedRequest<HealthDataRequestInput> {
     protected validator: HealthDataRequestValidator;
 }
 /**
  * Request object for fetching allergy intolerance data.
+ * @category Requests
+ * @title AllergyIntolerancesRequest
+ * @excerpt Request object for fetching allergy intolerance data
  */
 export declare class AllergyIntolerancesRequest extends HealthDataRequest {
 }
 /**
  * Request object for fetching allergy intolerance group data.
+ * @category Requests
+ * @title AllergyIntoleranceGroupsRequest
+ * @excerpt Request object for fetching allergy intolerance group data
  */
 export declare class AllergyIntoleranceGroupsRequest extends PagedRequest {
 }
 /**
  * Request object for fetching conditions data.
+ * @category Requests
+ * @title ConditionsRequest
+ * @excerpt Request object for fetching conditions data
  */
 export declare class ConditionsRequest extends HealthDataRequest {
 }
 /**
  * Request object for fetching condition groups data.
+ * @category Requests
+ * @title ConditionGroupsRequest
+ * @excerpt Request object for fetching condition groups data
  */
 export declare class ConditionGroupsRequest extends PagedRequest {
 }
 /**
  * Request object for fetching document references data.
+ * @category Requests
+ * @title DocumentReferencesRequest
+ * @excerpt Request object for fetching document references data
  */
 export declare class DocumentReferencesRequest extends HealthDataRequest {
 }
 /**
  * Request object for fetching labs data.
+ * @category Requests
+ * @title LabsRequest
+ * @excerpt Request object for fetching labs data
  */
 export declare class LabsRequest extends HealthDataRequest {
 }
 /**
  * Request object for fetching lab groups data.
+ * @category Requests
+ * @title LabGroupsRequest
+ * @excerpt Request object for fetching lab groups data
  */
 export declare class LabGroupsRequest extends PagedRequest {
 }
 /**
  * Request object for fetching care plan data.
+ * @category Requests
+ * @title CarePlansRequest
+ * @excerpt Request object for fetching care plan data
  */
 export declare class CarePlansRequest extends HealthDataRequest {
 }
 /**
  * Request object for fetching care team data.
+ * @category Requests
+ * @title CareTeamsRequest
+ * @excerpt Request object for fetching care team data
  */
 export declare class CareTeamsRequest extends PagedRequest<CareTeamRequestInput> {
 }
 /**
  * Request object for fetching care plan groups data.
+ * @category Requests
+ * @title CarePlanGroupsRequest
+ * @excerpt Request object for fetching care plan groups data
  */
 export declare class CarePlanGroupsRequest extends PagedRequest {
 }
 /**
  * Request object for fetching encounters data.
+ * @category Requests
+ * @title EncountersRequest
+ * @excerpt Request object for fetching encounters data
  */
 export declare class EncountersRequest extends HealthDataRequest {
 }
 /**
  * Request object for fetching encounter groups data.
+ * @category Requests
+ * @title EncounterGroupsRequest
+ * @excerpt Request object for fetching encounter groups data
  */
 export declare class EncounterGroupsRequest extends PagedRequest {
 }
 /**
  * Request object for fetching immunization data.
+ * @category Requests
+ * @title ImmunizationsRequest
+ * @excerpt Request object for fetching immunization data
  */
 export declare class ImmunizationsRequest extends HealthDataRequest {
 }
 /**
  * Request object for fetching immunization groups data.
+ * @category Requests
+ * @title ImmunizationGroupsRequest
+ * @excerpt Request object for fetching immunization groups data
  */
 export declare class ImmunizationGroupsRequest extends PagedRequest {
 }
 /**
  * Request object for fetching procedure data.
+ * @category Requests
+ * @title ProceduresRequest
+ * @excerpt Request object for fetching procedure data
  */
 export declare class ProceduresRequest extends HealthDataRequest {
 }
 /**
  * Request object for fetching procedure groups data.
+ * @category Requests
+ * @title ProcedureGroupsRequest
+ * @excerpt Request object for fetching procedure groups data
  */
 export declare class ProcedureGroupsRequest extends PagedRequest {
 }
 /**
  * Request object for fetching vital signs data.
+ * @category Requests
+ * @title VitalSignsRequest
+ * @excerpt Request object for fetching vital signs data
  */
 export declare class VitalSignsRequest extends HealthDataRequest {
 }
 /**
  * Request object for fetching vital sign groups data.
+ * @category Requests
+ * @title VitalSignGroupsRequest
+ * @excerpt Request object for fetching vital sign groups data
  */
 export declare class VitalSignGroupsRequest extends PagedRequest {
 }
 /**
  * Request object for fetching DiagnosticReport Lab Groups
+ * @category Requests
+ * @title DiagnosticReportLabGroupsRequest
+ * @excerpt Request object for fetching DiagnosticReport Lab Groups
  */
 export declare class DiagnosticReportLabGroupsRequest extends PagedRequest {
 }
+/**
+ */
 type MedicationDispenseRequestInput = PagedRequestInput & {
     prescription?: string[];
     ids?: string[];
     lastUpdated?: SearchDate;
     sort?: string[];
 };
+/**
+ */
 type MedicationRequestRequestInput = MedicationDispenseRequestInput & {
     medicationCode?: SearchToken;
 };
@@ -171,16 +253,24 @@ export declare class MedicationRequestRequestValidator extends MedicationDispens
 }
 /**
  * Request object for fetching medication dispense data.
+ * @category Requests
+ * @title MedicationDispenseRequest
+ * @excerpt Request object for fetching medication dispense data
  */
 export declare class MedicationDispenseRequest extends PagedRequest<MedicationDispenseRequestInput> {
     protected validator: MedicationDispenseRequestValidator;
 }
 /**
  * Request object for fetching medication request data.
+ * @category Requests
+ * @title MedicationRequestRequest
+ * @excerpt Request object for fetching medication request data
  */
 export declare class MedicationRequestRequest extends PagedRequest<MedicationRequestRequestInput> {
     protected validator: MedicationRequestRequestValidator;
 }
+/**
+ */
 type MedicationStatementRequestInput = HealthDataRequestInput & {
     medicationCode?: SearchToken;
 };
@@ -195,21 +285,36 @@ export declare class MedicationStatementRequestValidator extends HealthDataReque
 }
 /**
  * Request object for fetching medication statement data.
+ * @category Requests
+ * @title MedicationStatementsRequest
+ * @excerpt Request object for fetching medication statement data
  */
 export declare class MedicationStatementsRequest extends HealthDataRequest {
     protected validator: MedicationStatementRequestValidator;
 }
 /**
  * Request object for fetching medication groups data.
+ * @category Requests
+ * @title MedicationGroupsRequest
+ * @excerpt Request object for fetching medication groups data
  */
 export declare class MedicationGroupsRequest extends PagedRequest {
 }
 /**
  * Request object for fetching Binary data.
+ * @category Requests
+ * @title BinaryRequest
+ * @excerpt Request object for fetching Binary data
  */
 export declare class BinaryRequest extends PagedRequest<BinaryRequestInput> {
     protected validator: BinaryRequestValidator;
 }
+/**
+ * Request object for fetching diagnostic reports data.
+ * @category Requests
+ * @title DiagnosticReportsRequest
+ * @excerpt Request object for fetching diagnostic reports data
+ */
 export declare class DiagnosticReportsRequest extends HealthDataRequest {
 }
 export {};