@icanbwell/bwell-sdk-ts 0.1.2 → 0.2.0

package/README.md

@@ -2,7 +2,8 @@
 
 ## Set-Up
 
-After pulling the code base from the GIT repo follow the next steps to install and run the sdk.
+After pulling the code base from the GIT repo follow the next steps to install
+and run the sdk.
 
 1. Open a terminal in the home directory of the typescript sdk:
 
@@ -20,12 +21,22 @@ npm install
 
 ### Build
 
-Compiles typescript to `dist` directory after cleaning directory
+Generates GraphQL TypesScript files and Compiles typescript to `dist` directory
+after cleaning directory
 
 ```bash
 npm run build
 ```
 
+### Generate GraphQL Models and Types
+
+See [Code Generation directory (./codegen)](./codegen) for more information
+about GraphQL code generation
+
+```bash
+npm run generate
+```
+
 ### Testing
 
 Runs all test verbosely and reports coverage
@@ -53,8 +64,8 @@ npm run format
 
 ### Linting
 
-Runs [eslint](https://eslint.org/) and reports any warnings or errors. Does not fix
-errors.
+Runs [eslint](https://eslint.org/) and reports any warnings or errors. Does not
+fix errors.
 
 ```bash
 npm run lint

package/dist/__version__.d.ts

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

package/dist/__version__.js

@@ -0,0 +1,5 @@
+/**
+ * This file is automatically generated. Please do not edit this file directly.
+ */
+export const VERSION = "0.2.0";
+//# sourceMappingURL=__version__.js.map

package/dist/__version__.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"__version__.js","sourceRoot":"","sources":["../src/__version__.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,CAAC,MAAM,OAAO,GAAG,OAAO,CAAC"}

package/dist/api/api-provider-factory.d.ts

@@ -0,0 +1,7 @@
+import { SdkConfig } from "../config/index.js";
+import { LoggerProvider } from "../logger/index.js";
+import { TokenManager } from "../tokens/index.js";
+import { ApiProvider } from "./base/api-provider.js";
+export declare class ApiProviderFactory {
+    createApiProvider(config: SdkConfig, tokenManager: TokenManager, loggerProvider: LoggerProvider): ApiProvider;
+}

package/dist/api/api-provider-factory.js

@@ -0,0 +1,9 @@
+import { graphQLSDKFactory } from "./graphql-api/graphql-sdk/index.js";
+import { GraphQLApiProvider } from "./graphql-api/index.js";
+export class ApiProviderFactory {
+    createApiProvider(config, tokenManager, loggerProvider) {
+        const { sdk } = graphQLSDKFactory(config.graphQL.apiUrl, tokenManager);
+        return new GraphQLApiProvider(sdk, loggerProvider);
+    }
+}
+//# sourceMappingURL=api-provider-factory.js.map

package/dist/api/api-provider-factory.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"api-provider-factory.js","sourceRoot":"","sources":["../../src/api/api-provider-factory.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,iBAAiB,EAAE,MAAM,oCAAoC,CAAC;AACvE,OAAO,EAAE,kBAAkB,EAAE,MAAM,wBAAwB,CAAC;AAE5D,MAAM,OAAO,kBAAkB;IACtB,iBAAiB,CACtB,MAAiB,EACjB,YAA0B,EAC1B,cAA8B;QAE9B,MAAM,EAAE,GAAG,EAAE,GAAG,iBAAiB,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC;QACvE,OAAO,IAAI,kBAAkB,CAAC,GAAG,EAAE,cAAc,CAAC,CAAC;IACrD,CAAC;CACF"}

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

@@ -0,0 +1,31 @@
+import { ValidationError } from "../../../errors/index.js";
+import { GetTasksQueryResults, TaskUpdateStatusMutationResults } from "../../../graphql/operations/types.js";
+import type { BWellQueryResult, BWellTransactionResult } from "../../../results/index.js";
+import { BaseManagerError } from "../errors.js";
+import { GetTasksRequest } from "./get-tasks-request.js";
+import { UpdateTaskStatusRequest } from "./update-task-status-request.js";
+export type GetTasksResults = GetTasksQueryResults["getTasks"];
+export type UpdateTaskStatusResults = TaskUpdateStatusMutationResults["taskUpdateStatus"];
+export interface ActivityManager {
+    /**
+     * Tasks represent insights, recommendations, and/or requests for the user. They
+     * can be personalized and have a status to track progress. Tasks can also be linked
+     * to other FHIR resources and/or external content.
+     *
+     * @param {GetTasksRequest} request - The query search criteria
+     * @returns {Promise<BWellQueryResult<GetTasksResults, BaseManagerError>>} Collection of FHIR Task resources
+     */
+    getTasks(request: GetTasksRequest): Promise<BWellQueryResult<GetTasksResults, BaseManagerError | ValidationError>>;
+    /**
+     * Updates the status of a specified Task. The status of the task identified
+     * by request.taskId will be updated to the new status provided.
+     *
+     * The new status must be one of the potential TaskStatus values
+     *
+     * @param {UpdateTaskStatusRequest} request - Object containing the id and desired status for the task
+     * @returns {Promise<BWellTransactionResult<UpdateTaskStatusResults, BaseManagerError>>} - Object containing the updated FHIR task resource
+     *
+     * @see https://build.fhir.org/valueset-task-status.html
+     */
+    updateTaskStatus(request: UpdateTaskStatusRequest): Promise<BWellTransactionResult<UpdateTaskStatusResults, BaseManagerError | ValidationError>>;
+}

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

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=activity-manager.js.map

package/dist/api/base/activity/activity-manager.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"activity-manager.js","sourceRoot":"","sources":["../../../../src/api/base/activity/activity-manager.ts"],"names":[],"mappings":""}

package/dist/api/base/activity/get-tasks-request.d.ts

@@ -0,0 +1,49 @@
+import { ErrorsCollector, PagedRequest, PagedRequestInput, PagedRequestValidator } from "../../../requests/index.js";
+import { TaskStatus } from "./types.js";
+export type GetTaskRequestInput = PagedRequestInput & {
+    /**
+     * The id[s] of a tasks to search for
+     */
+    id?: string | string[];
+    /**
+     * The activityId[s] of tasks to filter by
+     */
+    activityId?: string | string[];
+    /**
+     * The activityType[s] of tasks to filter by
+     */
+    activityType?: string | string[];
+    /**
+     * The activityTopic[s] of tasks to filter by
+     */
+    activityTopic?: string | string[];
+    /**
+     * The status[es] of tasks to fitler by
+     */
+    status?: TaskStatus | TaskStatus[];
+    /**
+     * subject[s] of tasks to filter by
+     */
+    subject?: string | string[];
+    /**
+     * If present and true, retrieve referenced content from CMS. All content found
+     * will be added to the associated Task field “extension”
+     */
+    enrichContent?: boolean;
+    /**
+     * If present and true, results will be ordered to place better Tasks for user
+     * consumption at the front of the list. Otherwise, Tasks will be unordered.
+     */
+    smartSort?: boolean;
+    /**
+     * The preferred language for returned content, e.g. "en" for English, "es" for Spanish
+     */
+    contentLanguage?: string;
+};
+export declare class GetTasksRequestValidator extends PagedRequestValidator<GetTaskRequestInput> {
+    #private;
+    validate(data: GetTaskRequestInput, errors: ErrorsCollector): void;
+}
+export declare class GetTasksRequest extends PagedRequest<GetTaskRequestInput> {
+    protected validator: PagedRequestValidator<GetTaskRequestInput>;
+}

package/dist/api/base/activity/get-tasks-request.js

@@ -0,0 +1,36 @@
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+};
+var _GetTasksRequestValidator_instances, _GetTasksRequestValidator_validateTaskStatus;
+import { PagedRequest, PagedRequestValidator, } from "../../../requests/index.js";
+import { isUndefined } from "../../../utils/index.js";
+import { isValidTaskStatus } from "./types.js";
+export class GetTasksRequestValidator extends PagedRequestValidator {
+    constructor() {
+        super(...arguments);
+        _GetTasksRequestValidator_instances.add(this);
+    }
+    validate(data, errors) {
+        super.validate(data, errors);
+        if (!isUndefined(data.status)) {
+            const statuses = Array.isArray(data.status) ? data.status : [data.status];
+            for (const status of statuses) {
+                __classPrivateFieldGet(this, _GetTasksRequestValidator_instances, "m", _GetTasksRequestValidator_validateTaskStatus).call(this, status, errors);
+            }
+        }
+    }
+}
+_GetTasksRequestValidator_instances = new WeakSet(), _GetTasksRequestValidator_validateTaskStatus = function _GetTasksRequestValidator_validateTaskStatus(status, errors) {
+    if (!isValidTaskStatus(status)) {
+        errors.add(`Invalid task status: "${status}"`);
+    }
+};
+export class GetTasksRequest extends PagedRequest {
+    constructor() {
+        super(...arguments);
+        this.validator = new GetTasksRequestValidator();
+    }
+}
+//# sourceMappingURL=get-tasks-request.js.map

package/dist/api/base/activity/get-tasks-request.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"get-tasks-request.js","sourceRoot":"","sources":["../../../../src/api/base/activity/get-tasks-request.ts"],"names":[],"mappings":";;;;;;AAAA,OAAO,EAEL,YAAY,EAEZ,qBAAqB,GACtB,MAAM,4BAA4B,CAAC;AACpC,OAAO,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AACtD,OAAO,EAAE,iBAAiB,EAAc,MAAM,YAAY,CAAC;AAmD3D,MAAM,OAAO,wBAAyB,SAAQ,qBAA0C;IAAxF;;;IAkBA,CAAC;IAjBQ,QAAQ,CAAC,IAAyB,EAAE,MAAuB;QAChE,KAAK,CAAC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QAE7B,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC;YAC9B,MAAM,QAAQ,GAAG,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YAE1E,KAAK,MAAM,MAAM,IAAI,QAAQ,EAAE,CAAC;gBAC9B,uBAAA,IAAI,yFAAoB,MAAxB,IAAI,EAAqB,MAAM,EAAE,MAAM,CAAC,CAAC;YAC3C,CAAC;QACH,CAAC;IACH,CAAC;CAOF;0JALqB,MAAc,EAAE,MAAuB;IACzD,IAAI,CAAC,iBAAiB,CAAC,MAAM,CAAC,EAAE,CAAC;QAC/B,MAAM,CAAC,GAAG,CAAC,yBAAyB,MAAM,GAAG,CAAC,CAAC;IACjD,CAAC;AACH,CAAC;AAGH,MAAM,OAAO,eAAgB,SAAQ,YAAiC;IAAtE;;QACY,cAAS,GACjB,IAAI,wBAAwB,EAAE,CAAC;IACnC,CAAC;CAAA"}

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

@@ -0,0 +1,4 @@
+export { GetTasksResults, UpdateTaskStatusResults, } from "./activity-manager.js";
+export { GetTasksRequest, GetTaskRequestInput } from "./get-tasks-request.js";
+export { UpdateTaskStatusRequest, UpdateTaskStatusRequestInput, } from "./update-task-status-request.js";
+export { TaskStatus } from "./types.js";

package/dist/api/base/activity/index.js

@@ -0,0 +1,3 @@
+export { GetTasksRequest } from "./get-tasks-request.js";
+export { UpdateTaskStatusRequest, } from "./update-task-status-request.js";
+//# sourceMappingURL=index.js.map

package/dist/api/base/activity/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/api/base/activity/index.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,eAAe,EAAuB,MAAM,wBAAwB,CAAC;AAC9E,OAAO,EACL,uBAAuB,GAExB,MAAM,iCAAiC,CAAC"}

package/dist/api/base/activity/types.d.ts

@@ -0,0 +1,3 @@
+import { TaskStatus as GraphQLTaskStatus } from "../../../graphql/schema.js";
+export type TaskStatus = `${GraphQLTaskStatus}`;
+export declare function isValidTaskStatus(status: string): status is GraphQLTaskStatus;

package/dist/api/base/activity/types.js

@@ -0,0 +1,6 @@
+import { TaskStatus as GraphQLTaskStatus } from "../../../graphql/schema.js";
+const taskStatusCache = new Set(Object.values(GraphQLTaskStatus));
+export function isValidTaskStatus(status) {
+    return taskStatusCache.has(status);
+}
+//# sourceMappingURL=types.js.map

package/dist/api/base/activity/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../src/api/base/activity/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,IAAI,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AAI7E,MAAM,eAAe,GAAG,IAAI,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC,iBAAiB,CAAC,CAAC,CAAC;AAElE,MAAM,UAAU,iBAAiB,CAAC,MAAc;IAC9C,OAAO,eAAe,CAAC,GAAG,CAAC,MAA2B,CAAC,CAAC;AAC1D,CAAC"}

package/dist/api/base/activity/update-task-status-request.d.ts

@@ -0,0 +1,18 @@
+import { TaskStatus as GraphQLTaskStatus } from "../../../graphql/schema.js";
+import { ErrorsCollector, ValidationRequest, Validator } from "../../../requests/index.js";
+import { TaskStatus } from "./types.js";
+export type UpdateTaskStatusRequestInput = {
+    taskId: string;
+    newStatus: TaskStatus;
+};
+type UpdateTaskStatusRequestData = {
+    taskId: string;
+    newStatus: GraphQLTaskStatus;
+};
+export declare class UpdateTaskStatusRequestValidator implements Validator<UpdateTaskStatusRequestInput> {
+    validate(data: UpdateTaskStatusRequestInput, errors: ErrorsCollector): void;
+}
+export declare class UpdateTaskStatusRequest extends ValidationRequest<UpdateTaskStatusRequestInput, UpdateTaskStatusRequestData> {
+    protected validator: Validator<UpdateTaskStatusRequestInput>;
+}
+export {};

package/dist/api/base/activity/update-task-status-request.js

@@ -0,0 +1,16 @@
+import { ValidationRequest, } from "../../../requests/index.js";
+import { isValidTaskStatus } from "./types.js";
+export class UpdateTaskStatusRequestValidator {
+    validate(data, errors) {
+        if (!isValidTaskStatus(data.newStatus)) {
+            errors.add(`Invalid task status: "${data.newStatus}"`);
+        }
+    }
+}
+export class UpdateTaskStatusRequest extends ValidationRequest {
+    constructor() {
+        super(...arguments);
+        this.validator = new UpdateTaskStatusRequestValidator();
+    }
+}
+//# sourceMappingURL=update-task-status-request.js.map

package/dist/api/base/activity/update-task-status-request.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"update-task-status-request.js","sourceRoot":"","sources":["../../../../src/api/base/activity/update-task-status-request.ts"],"names":[],"mappings":"AACA,OAAO,EAEL,iBAAiB,GAElB,MAAM,4BAA4B,CAAC;AACpC,OAAO,EAAE,iBAAiB,EAAc,MAAM,YAAY,CAAC;AAY3D,MAAM,OAAO,gCAAgC;IAGpC,QAAQ,CACb,IAAkC,EAClC,MAAuB;QAEvB,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC;YACvC,MAAM,CAAC,GAAG,CAAC,yBAAyB,IAAI,CAAC,SAAS,GAAG,CAAC,CAAC;QACzD,CAAC;IACH,CAAC;CACF;AAED,MAAM,OAAO,uBAAwB,SAAQ,iBAG5C;IAHD;;QAIY,cAAS,GACjB,IAAI,gCAAgC,EAAE,CAAC;IAC3C,CAAC;CAAA"}

package/dist/api/base/api-provider.d.ts

@@ -0,0 +1,16 @@
+import type { ActivityManager } from "./activity/activity-manager.js";
+import type { ConnectionManager } from "./connection/connection-manager.js";
+import type { DeviceManager } from "./device/device-manager.js";
+import type { EventManager } from "./event/event-manager.js";
+import type { HealthManager } from "./health-data/health-manager.js";
+import type { SearchManager } from "./search/search-manager.js";
+import type { UserManager } from "./user/user-manager.js";
+export interface ApiProvider {
+    readonly health: HealthManager;
+    readonly user: UserManager;
+    readonly device: DeviceManager;
+    readonly connection: ConnectionManager;
+    readonly activity: ActivityManager;
+    readonly event: EventManager;
+    readonly search: SearchManager;
+}

package/dist/api/base/api-provider.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=api-provider.js.map

package/dist/api/base/api-provider.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"api-provider.js","sourceRoot":"","sources":["../../../src/api/base/api-provider.ts"],"names":[],"mappings":""}

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

@@ -0,0 +1,60 @@
+import { CreateConnectionMutationResults, DeleteConnectionMutationResults, DisconnectConnectionMutationResults, GetDataSourceQueryResults, GetOauthUrlQueryResults } from "../../../graphql/operations/types.js";
+import type { BWellQueryResult, BWellTransactionResult } from "../../../results/index.js";
+import { MemberConnectionResults } from "../../graphql-api/connection/index.js";
+import type { BaseManagerError } from "../errors.js";
+import { ConnectionRequest, DataSourceRequest } from "./connection-request.js";
+export declare const MEMBER_CONNECTION_SUBSCRIPTION_STATUS_EXTENSION_ID = "data-connection-status";
+export type DataSourceResults = GetDataSourceQueryResults["getDataSource"];
+export type CreateConnectionResults = CreateConnectionMutationResults["createConnection"];
+export type DisconnectConnectionResults = DisconnectConnectionMutationResults["disconnectConnection"];
+export type DeleteConnectionResults = DeleteConnectionMutationResults["deleteConnection"];
+export type OauthUrlResults = GetOauthUrlQueryResults["getOauthUrl"];
+export interface ConnectionManager {
+    /**
+     * Retrieves a list of MemberConnections resources from a FHIR server.
+     * There are no parameters and no request object for this method.
+     *
+     * @returns {Promise<BWellQueryResult<MemberConnectionResults>>} A promise resolving to an object representing the list of MemberConnections resources retrieved, along with potential validation or GraphQL errors.
+     */
+    getMemberConnections(): Promise<BWellQueryResult<MemberConnectionResults, 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.
+     */
+    getDataSource(request: DataSourceRequest): Promise<BWellQueryResult<DataSourceResults, 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.
+     */
+    createConnection(request: ConnectionRequest): Promise<BWellTransactionResult<CreateConnectionResults, 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.
+     */
+    disconnectConnection(request: DataSourceRequest): Promise<BWellTransactionResult<DisconnectConnectionResults, 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.
+     */
+    deleteConnection(request: DataSourceRequest): Promise<BWellTransactionResult<DeleteConnectionResults, 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.
+     */
+    getOauthUrl(request: DataSourceRequest): Promise<BWellQueryResult<OauthUrlResults, BaseManagerError>>;
+}

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

@@ -0,0 +1,2 @@
+export const MEMBER_CONNECTION_SUBSCRIPTION_STATUS_EXTENSION_ID = "data-connection-status";
+//# sourceMappingURL=connection-manager.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"connection-manager.js","sourceRoot":"","sources":["../../../../src/api/base/connection/connection-manager.ts"],"names":[],"mappings":"AAeA,MAAM,CAAC,MAAM,kDAAkD,GAC7D,wBAAwB,CAAC"}

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

@@ -0,0 +1,56 @@
+import { ErrorsCollector, ValidationRequest } from "../../../requests/index.js";
+/**
+ * Error message for when the connection id is not defined.
+ */
+export declare const UNDEFINED_CONNECTION_ID_ERROR = "connectionId cannot be null or empty";
+/**
+ * Error message for when the username is not defined.
+ */
+export declare const UNDEFINED_USERNAME_ERROR = "username cannot be null or empty";
+/**
+ * Error message for when the password is not defined.
+ */
+export declare const UNDEFINED_PASSWORD_ERROR = "password cannot be null or empty";
+/**
+ * Input object for fetching a data source by connection id.
+ */
+export type DataSourceRequestInput = {
+    connectionId: string;
+};
+/**
+ * Input object for fetching a data source by connection id.
+ */
+export type ConnectionRequestInput = DataSourceRequestInput & {
+    username: string;
+    password: string;
+};
+/**
+ * Validator for data source requests. Ensures that the connectionId is defined, not null and not empty.
+ */
+export declare class DataSourceRequestValidator<T extends DataSourceRequestInput> {
+    validate(data: T, errors: ErrorsCollector): void;
+}
+/**
+ * Validator for connection requests. Ensures that the connectionId, username and password are defined, not null and not empty.
+ */
+export declare class ConnectionRequestValidator<T extends ConnectionRequestInput> {
+    #private;
+    validate(data: T, errors: ErrorsCollector): void;
+}
+/**
+ * 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.
+ */
+export declare class DataSourceRequest extends BaseDataSourceRequest<DataSourceRequestInput> {
+}
+/**
+ * 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

@@ -0,0 +1,71 @@
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+};
+var _ConnectionRequestValidator_dataSourceRequestValidator;
+import { ValidationRequest } from "../../../requests/index.js";
+/**
+ * Error message for when the connection id is not defined.
+ */
+export const UNDEFINED_CONNECTION_ID_ERROR = "connectionId cannot be null or empty";
+/**
+ * Error message for when the username is not defined.
+ */
+export const UNDEFINED_USERNAME_ERROR = "username cannot be null or empty";
+/**
+ * Error message for when the password is not defined.
+ */
+export const UNDEFINED_PASSWORD_ERROR = "password cannot be null or empty";
+/**
+ * Validator for data source requests. Ensures that the connectionId is defined, not null and not empty.
+ */
+export class DataSourceRequestValidator {
+    validate(data, errors) {
+        if (data.connectionId === "") {
+            errors.add(UNDEFINED_CONNECTION_ID_ERROR);
+        }
+    }
+}
+/**
+ * Validator for connection requests. Ensures that the connectionId, username and password are defined, not null and not empty.
+ */
+export class ConnectionRequestValidator {
+    constructor() {
+        _ConnectionRequestValidator_dataSourceRequestValidator.set(this, new DataSourceRequestValidator());
+    }
+    validate(data, errors) {
+        __classPrivateFieldGet(this, _ConnectionRequestValidator_dataSourceRequestValidator, "f").validate(data, errors);
+        if (data.username === "") {
+            errors.add(UNDEFINED_USERNAME_ERROR);
+        }
+        if (data.password === "") {
+            errors.add(UNDEFINED_PASSWORD_ERROR);
+        }
+    }
+}
+_ConnectionRequestValidator_dataSourceRequestValidator = new WeakMap();
+/**
+ * Base request object for interacting with the API using a connectionId.
+ */
+export class BaseDataSourceRequest extends ValidationRequest {
+    constructor() {
+        super(...arguments);
+        this.validator = new DataSourceRequestValidator();
+    }
+}
+/**
+ * Request object for interacting with the API using a connection id.
+ */
+export class DataSourceRequest extends BaseDataSourceRequest {
+}
+/**
+ * Request object for creating a connection.
+ */
+export class ConnectionRequest extends BaseDataSourceRequest {
+    constructor() {
+        super(...arguments);
+        this.validator = new ConnectionRequestValidator();
+    }
+}
+//# sourceMappingURL=connection-request.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"connection-request.js","sourceRoot":"","sources":["../../../../src/api/base/connection/connection-request.ts"],"names":[],"mappings":";;;;;;AAAA,OAAO,EAAmB,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AAEhF;;GAEG;AACH,MAAM,CAAC,MAAM,6BAA6B,GACxC,sCAAsC,CAAC;AAEzC;;GAEG;AACH,MAAM,CAAC,MAAM,wBAAwB,GAAG,kCAAkC,CAAC;AAE3E;;GAEG;AACH,MAAM,CAAC,MAAM,wBAAwB,GAAG,kCAAkC,CAAC;AAiB3E;;GAEG;AACH,MAAM,OAAO,0BAA0B;IAC9B,QAAQ,CAAC,IAAO,EAAE,MAAuB;QAC9C,IAAI,IAAI,CAAC,YAAY,KAAK,EAAE,EAAE,CAAC;YAC7B,MAAM,CAAC,GAAG,CAAC,6BAA6B,CAAC,CAAC;QAC5C,CAAC;IACH,CAAC;CACF;AAED;;GAEG;AACH,MAAM,OAAO,0BAA0B;IAAvC;QACE,iEAA8B,IAAI,0BAA0B,EAAK,EAAC;IAapE,CAAC;IAXQ,QAAQ,CAAC,IAAO,EAAE,MAAuB;QAC9C,uBAAA,IAAI,8DAA4B,CAAC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QAExD,IAAI,IAAI,CAAC,QAAQ,KAAK,EAAE,EAAE,CAAC;YACzB,MAAM,CAAC,GAAG,CAAC,wBAAwB,CAAC,CAAC;QACvC,CAAC;QAED,IAAI,IAAI,CAAC,QAAQ,KAAK,EAAE,EAAE,CAAC;YACzB,MAAM,CAAC,GAAG,CAAC,wBAAwB,CAAC,CAAC;QACvC,CAAC;IACH,CAAC;CACF;;AAED;;GAEG;AACH,MAAM,OAAO,qBAEX,SAAQ,iBAAoB;IAF9B;;QAGY,cAAS,GACjB,IAAI,0BAA0B,EAAK,CAAC;IACxC,CAAC;CAAA;AAED;;GAEG;AACH,MAAM,OAAO,iBAAkB,SAAQ,qBAA6C;CAAG;AAEvF;;GAEG;AACH,MAAM,OAAO,iBAAkB,SAAQ,qBAA6C;IAApF;;QACY,cAAS,GACjB,IAAI,0BAA0B,EAA0B,CAAC;IAC7D,CAAC;CAAA"}

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

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

package/dist/api/base/connection/index.js

@@ -0,0 +1,3 @@
+export { MEMBER_CONNECTION_SUBSCRIPTION_STATUS_EXTENSION_ID, } from "./connection-manager.js";
+export { DataSourceRequest, ConnectionRequest, } from "./connection-request.js";
+//# sourceMappingURL=index.js.map

package/dist/api/base/connection/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/api/base/connection/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAML,kDAAkD,GACnD,MAAM,yBAAyB,CAAC;AACjC,OAAO,EACL,iBAAiB,EAEjB,iBAAiB,GAElB,MAAM,yBAAyB,CAAC"}

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

@@ -0,0 +1,22 @@
+import type { UpdateDeviceRegistrationMutationResults } from "../../../graphql/operations/types.js";
+import type { BWellTransactionResult } from "../../../results/index.js";
+import type { BaseManagerError } from "../errors.js";
+import { DeregisterDeviceRequest, RegisterDeviceRequest } from "./device-request.js";
+export type DeviceRegistrationResults = UpdateDeviceRegistrationMutationResults["updateDeviceRegistration"];
+/**
+ * Base manager for device registration.
+ */
+export declare abstract class DeviceManager {
+    /**
+     * Registers a device to receive notifications.
+     * @param request The request to register the device.
+     * @returns A promise resolving to an object representing the transaction result with the registration results or an error.
+     */
+    abstract registerDevice(request: RegisterDeviceRequest): Promise<BWellTransactionResult<DeviceRegistrationResults, BaseManagerError>>;
+    /**
+     * Deregisters a device so that it will no longer receive notifications.
+     * @param request The request to deregister the device.
+     * @returns A promise resolving to an object representing the transaction result with the deregistration results or an error.
+     */
+    abstract deregisterDevice(request: DeregisterDeviceRequest): Promise<BWellTransactionResult<DeviceRegistrationResults, BaseManagerError>>;
+}

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

@@ -0,0 +1,6 @@
+/**
+ * Base manager for device registration.
+ */
+export class DeviceManager {
+}
+//# sourceMappingURL=device-manager.js.map

package/dist/api/base/device/device-manager.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"device-manager.js","sourceRoot":"","sources":["../../../../src/api/base/device/device-manager.ts"],"names":[],"mappings":"AAWA;;GAEG;AACH,MAAM,OAAgB,aAAa;CAsBlC"}

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

@@ -0,0 +1,62 @@
+import { ErrorsCollector, ValidationRequest, Validator } from "../../../requests/index.js";
+/**
+ * Error message for when deviceToken is missing
+ */
+export declare const INVALID_DEVICE_TOKEN_ERROR = "deviceToken is required";
+/**
+ * Error message for when platformName is not a valid DevicePlatform value
+ */
+export declare const INVALID_PLATFORM_NAME_ERROR = "platformName must be a valid DevicePlatform value";
+/**
+ * Error message for when applicationName is missing
+ */
+export declare const INVALID_APPLICATION_NAME_ERROR = "applicationName is required";
+/**
+ * Enum for the device platform; currently only supports IOS and ANDROID
+ */
+declare enum DevicePlatformEnum {
+    IOS = "IOS",
+    ANDROID = "ANDROID"
+}
+/**
+ * Type for the device platform; currently only supports IOS and ANDROID
+ */
+export type DevicePlatform = `${DevicePlatformEnum}`;
+/**
+ * Base input for device request; used directly by DeregisterDeviceRequest
+ */
+export type DeviceRequestInput = {
+    deviceToken: string;
+};
+/**
+ * Input for the register device request
+ */
+export type RegisterDeviceRequestInput = DeviceRequestInput & {
+    platformName: DevicePlatform;
+    applicationName: string;
+};
+/**
+ * Base validator for device requests - only deviceToken is required in both request types
+ */
+export declare class DeviceRequestValidator<T extends DeviceRequestInput> implements Validator<T> {
+    validate(data: T, errors: ErrorsCollector): void;
+}
+/**
+ * Validator for RegisterDeviceRequest - checks that platform, applicationName and deviceToken are valid
+ */
+export declare class RegisterDeviceRequestValidator<T extends RegisterDeviceRequestInput> extends DeviceRequestValidator<T> {
+    validate(data: T, errors: ErrorsCollector): void;
+}
+/**
+ * Request for registering a device
+ */
+export declare class RegisterDeviceRequest extends ValidationRequest<RegisterDeviceRequestInput> {
+    protected validator: RegisterDeviceRequestValidator<RegisterDeviceRequestInput>;
+}
+/**
+ * Request for deregistering a device
+ */
+export declare class DeregisterDeviceRequest extends ValidationRequest<DeviceRequestInput> {
+    protected validator: DeviceRequestValidator<DeviceRequestInput>;
+}
+export {};