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

package/dist/models/user/consent.d.ts

@@ -0,0 +1,91 @@
+import type { CodeableConcept, Meta, Period, Reference } from "../common/index.js";
+/**
+ * A record of a healthcare consumer's choices or choices made on their behalf by a third party.
+ * Captures permissions, prohibitions and obligations with respect to access to or use of a resource.
+ *
+ * @category Models
+ * @title Consent
+ * @excerpt Healthcare consumer consent permissions and obligations
+ */
+export type Consent = {
+    /**
+     * The logical id of the resource, as used in the URL for the resource.
+     */
+    id: string;
+    /**
+     * Indicates the current state of this consent.
+     */
+    status: string | null;
+    /**
+     * When this Consent was created or indexed.
+     */
+    dateTime: string | null;
+    /**
+     * Metadata about the resource.
+     */
+    meta: Meta | null;
+    /**
+     * A selector of the type of consent being presented.
+     */
+    scope: CodeableConcept | null;
+    /**
+     * A classification of the type of consents found in the statement.
+     */
+    category: (CodeableConcept | null)[] | null;
+    /**
+     * The patient/healthcare consumer to whom this consent applies.
+     */
+    patient: Reference | null;
+    /**
+     * Who is agreeing to the policy and rules.
+     */
+    performer: (Reference | null)[] | null;
+    /**
+     * The organization that manages the consent.
+     */
+    organization: (Reference | null)[] | null;
+    /**
+     * The references to the policies that are included in this consent scope.
+     */
+    policy: (ConsentPolicy | null)[] | null;
+    /**
+     * A reference to the specific base computable regulation or policy.
+     */
+    policyRule: CodeableConcept | null;
+    /**
+     * An exception to the base policy of this consent.
+     */
+    provision: ConsentProvision | null;
+};
+/**
+ * The references to the policies that are included in this consent scope.
+ *
+ * @title ConsentPolicy
+ * @excerpt Policy references included in consent scope
+ */
+export type ConsentPolicy = {
+    /**
+     * Entity or Organization having regulatory jurisdiction or accountability for enforcing policies.
+     */
+    authority: string | null;
+    /**
+     * The references to the policies that are included in this consent scope.
+     */
+    uri: string | null;
+};
+/**
+ * An exception to the base policy of this consent.
+ *
+ * @title ConsentProvision
+ * @excerpt Exception to the base consent policy
+ */
+export type ConsentProvision = {
+    /**
+     * Action to take - permit or deny.
+     */
+    type: string | null;
+    /**
+     * Timeframe for this rule.
+     */
+    period: Period | null;
+};

package/dist/models/user/consent.js

@@ -0,0 +1 @@
+export {};

package/dist/models/user/index.d.ts

@@ -0,0 +1,4 @@
+export type { User } from "./user.js";
+export type { Person } from "./person.js";
+export type { Consent } from "./consent.js";
+export type { VerificationResult } from "./verification-result.js";

package/dist/models/user/index.js

@@ -0,0 +1 @@
+export {};

package/dist/models/user/person.d.ts

@@ -0,0 +1,43 @@
+import { Address, ContactPoint, HumanName } from "../common/index.js";
+/**
+ * Person model representing demographics and administrative information about a person
+ * independent of a specific health-related context.
+ *
+ * @category Models
+ * @title Person
+ * @excerpt Demographics and administrative information about a person
+ */
+export type Person = {
+    /**
+     * The logical id of the resource, as used in the URL for the resource. Once
+     * assigned, this value never changes.
+     */
+    id: string;
+    /**
+     * Administrative Gender.
+     * Uses the Code scalar type from the GraphQL schema.
+     */
+    gender: string | null;
+    /**
+     * The birth date for the person.
+     * Uses the Date scalar type from the GraphQL schema.
+     */
+    birthDate: string | null;
+    /**
+     * The base language in which the resource is written.
+     * Uses the Code scalar type from the GraphQL schema.
+     */
+    language: string | null;
+    /**
+     * One or more addresses for the person.
+     */
+    address: (Address | null)[] | null;
+    /**
+     * A contact detail for the person, e.g. a telephone number or an email address.
+     */
+    telecom: (ContactPoint | null)[] | null;
+    /**
+     * A name associated with the person.
+     */
+    name: (HumanName | null)[] | null;
+};

package/dist/models/user/person.js

@@ -0,0 +1 @@
+export {};

package/dist/models/user/user.d.ts

@@ -0,0 +1,12 @@
+/**
+ * User model representing the relationship between bWell and client FHIR person identifiers.
+ * Used to link user identities across different systems.
+ *
+ * @category Models
+ * @title User
+ * @excerpt User identity mapping between bWell and client systems
+ */
+export type User = {
+    bwellFhirPersonId: string;
+    clientFhirPersonId: string;
+};

package/dist/models/user/user.js

@@ -0,0 +1 @@
+export {};

package/dist/models/user/verification-result.d.ts

@@ -0,0 +1,30 @@
+/**
+ * Describes validation requirements, source(s), status and dates for one or more elements.
+ * Used to track the verification status of identity and other validation processes.
+ *
+ * @category Models
+ * @title VerificationResult
+ * @excerpt Validation requirements and status tracking for identity verification
+ */
+export type VerificationResult = {
+    /**
+     * The type of resource being returned.
+     */
+    resourceType: string | null;
+    /**
+     * The logical id of the resource, as used in the URL for the resource.
+     */
+    id: string;
+    /**
+     * The validation status of the target.
+     */
+    status: string | null;
+    /**
+     * When the validation status was updated.
+     */
+    statusDate: string | null;
+    /**
+     * The date the validation was last performed.
+     */
+    lastPerformed: string | null;
+};

package/dist/models/user/verification-result.js

@@ -0,0 +1 @@
+export {};

package/dist/requests/paged-request.d.ts

@@ -1,14 +1,45 @@
 import { ValidationRequest } from "./request.js";
 import { ErrorsCollector, Validator } from "./validator.js";
+/**
+ * Input type for paged requests. Specifies pagination parameters.
+ * @category Inputs
+ * @title PagedRequestInput
+ * @excerpt Input type for paged requests
+ */
 export type PagedRequestInput = {
     page: number;
     pageSize?: number;
 };
+/**
+ * Request data type for paged requests
+ * @private
+ * @title PagedRequestRequestData
+ * @excerpt Request data type for paged requests
+ 
+ */
 export type PagedRequestRequestData = Required<PagedRequestInput>;
+/**
+ * Maximum page size for paged requests
+ * @private
+ * @title MAX_PAGE_SIZE
+ * @excerpt Maximum page size for paged requests
+ 
+ */
 export declare const MAX_PAGE_SIZE = 100;
+/**
+ * Default page size for paged requests
+ * @private
+ * @title DEFAULT_PAGE_SIZE
+ * @excerpt Default page size for paged requests
+ 
+ */
 export declare const DEFAULT_PAGE_SIZE = 20;
 /**
  * Validator for paged requests. Ensures that the page is a positive number and the page size is a positive number less than or equal to MAX_PAGE_SIZE.
+ * @private
+ * @title PagedRequestValidator
+ * @excerpt Validator for paged requests. Ensures that the page is a positive number and the page size is a positive number less than or equal to MAX_PAGE_SIZE
+ 
  */
 export declare class PagedRequestValidator<T extends PagedRequestInput> implements Validator<T> {
     #private;
@@ -21,6 +52,10 @@ export declare class PagedRequestValidator<T extends PagedRequestInput> implemen
 }
 /**
  * Base request object for fetching paged data.
+ * @category Requests
+ * @title PagedRequest
+ * @excerpt Base request object for fetching paged data
+ 
  */
 export declare class PagedRequest<I extends PagedRequestInput = PagedRequestInput, T extends Required<PagedRequestInput> = I & Required<PagedRequestInput>> extends ValidationRequest<I, T & Required<PagedRequestInput>> {
     protected validator: PagedRequestValidator<I>;

package/dist/requests/paged-request.js

@@ -5,10 +5,28 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
 };
 var _PagedRequestValidator_instances, _PagedRequestValidator_validatePage, _PagedRequestValidator_validatePageSize;
 import { ValidationRequest } from "./request.js";
+/**
+ * Maximum page size for paged requests
+ * @private
+ * @title MAX_PAGE_SIZE
+ * @excerpt Maximum page size for paged requests
+ 
+ */
 export const MAX_PAGE_SIZE = 100;
+/**
+ * Default page size for paged requests
+ * @private
+ * @title DEFAULT_PAGE_SIZE
+ * @excerpt Default page size for paged requests
+ 
+ */
 export const DEFAULT_PAGE_SIZE = 20;
 /**
  * Validator for paged requests. Ensures that the page is a positive number and the page size is a positive number less than or equal to MAX_PAGE_SIZE.
+ * @private
+ * @title PagedRequestValidator
+ * @excerpt Validator for paged requests. Ensures that the page is a positive number and the page size is a positive number less than or equal to MAX_PAGE_SIZE
+ 
  */
 export class PagedRequestValidator {
     constructor() {
@@ -41,6 +59,10 @@ _PagedRequestValidator_instances = new WeakSet(), _PagedRequestValidator_validat
 };
 /**
  * Base request object for fetching paged data.
+ * @category Requests
+ * @title PagedRequest
+ * @excerpt Base request object for fetching paged data
+ 
  */
 export class PagedRequest extends ValidationRequest {
     constructor() {

package/dist/requests/request.d.ts

@@ -4,6 +4,10 @@ import { Validator } from "./validator.js";
 /**
  * The Request interface provides a set of methods to be used for serializing,
  * validating, and accessing data Request data
+ * @private
+ * @title Request
+ * @excerpt The Request interface provides a set of methods to be used for serializing, validating, and accessing data Request data
+ 
  */
 export interface Request<T> {
     /**
@@ -31,6 +35,10 @@ export interface Request<T> {
  * I is the input type of the Request class.
  * T is the output type of the request class and is defaulted to I. T should
  * be the result of the trasnformInput method.
+ * @private
+ * @title BaseRequest
+ * @excerpt BaseRequest is the class to be extended when building a request input class which does not require any validation logic
+ 
  */
 export declare abstract class BaseRequest<I, T = I> implements Request<T> {
     #private;
@@ -56,6 +64,10 @@ export declare abstract class BaseRequest<I, T = I> implements Request<T> {
 }
 /**
  * Class to extend for building request objects that require data validation
+ * @private
+ * @title ValidationRequest
+ * @excerpt Class to extend for building request objects that require data validation
+ 
  */
 export declare abstract class ValidationRequest<I, T = I> extends BaseRequest<I, T> {
     /**
@@ -71,6 +83,10 @@ export declare abstract class ValidationRequest<I, T = I> extends BaseRequest<I,
 /**
  * Interface to implement when bulding classes that transform an abstract request
  * to a provider specific request object like GraphQL
+ * @private
+ * @title RequestFactory
+ * @excerpt Interface to implement when bulding classes that transform an abstract request to a provider specific request object like GraphQL
+ 
  */
 export interface RequestFactory<R extends Request<unknown>, Output> {
     /**

package/dist/requests/request.js

@@ -21,6 +21,10 @@ import { ValidationErrorsCollector } from "./validator.js";
  * I is the input type of the Request class.
  * T is the output type of the request class and is defaulted to I. T should
  * be the result of the trasnformInput method.
+ * @private
+ * @title BaseRequest
+ * @excerpt BaseRequest is the class to be extended when building a request input class which does not require any validation logic
+ 
  */
 export class BaseRequest {
     constructor(data) {
@@ -62,6 +66,10 @@ export class BaseRequest {
 _BaseRequest_data = new WeakMap(), _BaseRequest_input = new WeakMap();
 /**
  * Class to extend for building request objects that require data validation
+ * @private
+ * @title ValidationRequest
+ * @excerpt Class to extend for building request objects that require data validation
+ 
  */
 export class ValidationRequest extends BaseRequest {
     /**

package/dist/requests/validator.d.ts

@@ -1,6 +1,10 @@
 /**
  * Validator is an interface which only implements a `validate` method which
  * validates some data and collects the validation errors into an error collector
+ * @private
+ * @title Validator
+ * @excerpt Validator is an interface which only implements a `validate` method which validates some data and collects the validation errors into an error collector
+ 
  */
 export interface Validator<T> {
     /**
@@ -27,6 +31,10 @@ export interface Validator<T> {
 }
 /**
  * Interface for collecting errors during data validation
+ * @private
+ * @title ErrorsCollector
+ * @excerpt Interface for collecting errors during data validation
+ 
  */
 export interface ErrorsCollector {
     /**
@@ -46,6 +54,13 @@ export interface ErrorsCollector {
      */
     hasErrors(): boolean;
 }
+/**
+ * Implementation of ErrorsCollector for collecting validation errors
+ * @private
+ * @title ValidationErrorsCollector
+ * @excerpt Implementation of ErrorsCollector for collecting validation errors
+ 
+ */
 export declare class ValidationErrorsCollector implements ErrorsCollector {
     #private;
     add(error: string): void;

package/dist/requests/validator.js

@@ -4,6 +4,13 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
     return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
 };
 var _ValidationErrorsCollector_errors;
+/**
+ * Implementation of ErrorsCollector for collecting validation errors
+ * @private
+ * @title ValidationErrorsCollector
+ * @excerpt Implementation of ErrorsCollector for collecting validation errors
+ 
+ */
 export class ValidationErrorsCollector {
     constructor() {
         _ValidationErrorsCollector_errors.set(this, []);

package/dist/results/bwell-query-result.d.ts

@@ -2,6 +2,11 @@ import { type BWellError } from "../errors/index.js";
 /**
  * Used when just querying for data.
  * Can have data AND errors
+ *
+ * @typeParam T - The type of the data being queried
+ * @typeParam E - The type of the error, must extend BWellError (defaults to BWellError)
+ * @title BWellQueryResult
+ * @excerpt Used when just querying for data
  */
 export declare class BWellQueryResult<T, E extends BWellError = BWellError> {
     readonly data: T | undefined;

package/dist/results/bwell-query-result.js

@@ -1,6 +1,11 @@
 /**
  * Used when just querying for data.
  * Can have data AND errors
+ *
+ * @typeParam T - The type of the data being queried
+ * @typeParam E - The type of the error, must extend BWellError (defaults to BWellError)
+ * @title BWellQueryResult
+ * @excerpt Used when just querying for data
  */
 export class BWellQueryResult {
     constructor(data, error) {

package/dist/results/bwell-transaction-result.d.ts

@@ -3,6 +3,11 @@ import { BWellQueryResult } from "./bwell-query-result.js";
 /**
  * Class representing a successful operation whose result can only be a success
  * or a failure.
+ *
+ * @typeParam T - The type of the successful result value
+ * @typeParam E - The type of the error, must extend BWellError (defaults to BWellError)
+ * @title BWellTransactionResult
+ * @excerpt Class representing a successful operation whose result can only be a success or a failure
  */
 export declare abstract class BWellTransactionResult<T, E extends BWellError = BWellError> {
     /**
@@ -25,10 +30,10 @@ export declare abstract class BWellTransactionResult<T, E extends BWellError = B
     abstract data(): T;
     /**
      * If Result is a `BWellTransactionFailure` returns `E`;
-     * Throws `E` if result is `BWellTransactionSuccess`
+     * Throws `T` if result is `BWellTransactionSuccess`
      *
      * @returns {E}
-     * @throw {T}
+     * @throws {T}
      */
     abstract error(): E;
     /**
@@ -49,6 +54,10 @@ export declare abstract class BWellTransactionResult<T, E extends BWellError = B
 /**
  * Class representing a successful operation whose result can only be a success
  * and never a failure
+ *
+ * @typeParam T - The type of the successful result value
+ * @title BWellTransactionSuccess
+ * @excerpt Class representing a successful operation whose result can only be a success and never a failure
  */
 export declare class BWellTransactionSuccess<T> extends BWellTransactionResult<T, never> {
     #private;
@@ -61,7 +70,12 @@ export declare class BWellTransactionSuccess<T> extends BWellTransactionResult<T
 }
 /**
  * Class representing a failed operation whose result can only be a failure
- * and never a failure
+ * and never a success
+ *
+ * @typeParam T - The type of the successful result value (unused in failure)
+ * @typeParam E - The type of the error, must extend BWellError (defaults to BWellError)
+ * @title BWellTransactionFailure
+ * @excerpt Class representing a failed operation whose result can only be a failure and never a success
  */
 export declare class BWellTransactionFailure<T, E extends BWellError = BWellError> extends BWellTransactionResult<T, E> {
     #private;

package/dist/results/bwell-transaction-result.js

@@ -14,6 +14,11 @@ import { BWellQueryResult } from "./bwell-query-result.js";
 /**
  * Class representing a successful operation whose result can only be a success
  * or a failure.
+ *
+ * @typeParam T - The type of the successful result value
+ * @typeParam E - The type of the error, must extend BWellError (defaults to BWellError)
+ * @title BWellTransactionResult
+ * @excerpt Class representing a successful operation whose result can only be a success or a failure
  */
 export class BWellTransactionResult {
     /**
@@ -32,6 +37,10 @@ export class BWellTransactionResult {
 /**
  * Class representing a successful operation whose result can only be a success
  * and never a failure
+ *
+ * @typeParam T - The type of the successful result value
+ * @title BWellTransactionSuccess
+ * @excerpt Class representing a successful operation whose result can only be a success and never a failure
  */
 export class BWellTransactionSuccess extends BWellTransactionResult {
     constructor(data) {
@@ -58,7 +67,12 @@ export class BWellTransactionSuccess extends BWellTransactionResult {
 _BWellTransactionSuccess_data = new WeakMap();
 /**
  * Class representing a failed operation whose result can only be a failure
- * and never a failure
+ * and never a success
+ *
+ * @typeParam T - The type of the successful result value (unused in failure)
+ * @typeParam E - The type of the error, must extend BWellError (defaults to BWellError)
+ * @title BWellTransactionFailure
+ * @excerpt Class representing a failed operation whose result can only be a failure and never a success
  */
 export class BWellTransactionFailure extends BWellTransactionResult {
     constructor(error) {

package/dist/results/index.d.ts

@@ -1,3 +1,4 @@
 export * from "./bwell-query-result.js";
 export * from "./bwell-transaction-result.js";
 export * from "./bwell-query-result-factory.js";
+export * from "./operation-outcome.js";

package/dist/results/index.js

@@ -1,3 +1,4 @@
 export * from "./bwell-query-result.js";
 export * from "./bwell-transaction-result.js";
 export * from "./bwell-query-result-factory.js";
+export * from "./operation-outcome.js";

package/dist/tokens/load-auth-tokens.d.ts

@@ -1,6 +1,6 @@
-import { AuthTokens } from "../api/base/identity/identity-manager.js";
 import { BWellError } from "../errors/bwell-error.js";
 import { InvalidTokenError } from "../errors/invalid-token-error.js";
+import { AuthTokens } from "../models/identity/index.js";
 import { BWellTransactionResult } from "../results/index.js";
 import { TokenStorage } from "./token-storage.js";
 export declare function loadAuthTokens(storage: TokenStorage): Promise<BWellTransactionResult<AuthTokens, InvalidTokenError | BWellError>>;

package/dist/tokens/token-storage.d.ts

@@ -3,6 +3,8 @@ export type GetManyResult = [string, string | undefined];
  * Interface for storing tokens.
  * We might want to store more than one kind of token, so the interface is for a key-value store.
  * All methods are asynchronous, in cases of storage in the cloud, over the network, in a multi-step process, etc.
+ * @title TokenStorage
+ * @excerpt Interface for storing tokens
  */
 export interface TokenStorage {
     /**
@@ -37,6 +39,8 @@ export interface TokenStorage {
 }
 /**
  * Default token storage implementation that stores tokens in memory.
+ * @title InMemoryTokenStorage
+ * @excerpt Default token storage implementation that stores tokens in memory
  */
 export declare class InMemoryTokenStorage {
     private storage;

package/dist/tokens/token-storage.js

@@ -9,6 +9,8 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 /**
  * Default token storage implementation that stores tokens in memory.
+ * @title InMemoryTokenStorage
+ * @excerpt Default token storage implementation that stores tokens in memory
  */
 export class InMemoryTokenStorage {
     constructor(storage = new Map()) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@icanbwell/bwell-sdk-ts",
-  "version": "2.0.0-alpha.0-rc.1754330797",
+  "version": "2.0.0-alpha.0-rc.1754488327",
   "description": "b.well TypeScript SDK",
   "license": "UNLICENSED",
   "type": "module",
@@ -27,7 +27,8 @@
     "gen:clean": "rimraf ./src/graphql",
     "generate": "npm run generate:sdl && npm run generate:types && npm run generate:version",
     "generate:v2": "npm run generate:sdl:v2 && npm run generate:types && npm run generate:version",
-    "generate:docs": "typedoc --tsconfig tsconfig.json && npm run format",
+    "generate:docs:html": "typedoc --options typedoc/typedoc.html.mjs",
+    "generate:docs:readme": "typedoc --options typedoc/typedoc.readme.mjs",
     "generate:types": "graphql-codegen --config ./codegen/codegen.ts",
     "generate:version": "node ./scripts/generate-version-file.js",
     "generate:sdl": "npm run --prefix ../graphql generate:sdl",
@@ -77,6 +78,8 @@
     "rimraf": "^5.0.10",
     "ts-jest": "^29.2.4",
     "typedoc": "^0.28.7",
+    "typedoc-plugin-frontmatter": "^1.3.0",
+    "typedoc-plugin-markdown": "^4.7.0",
     "typescript": "^5.8.3",
     "typescript-eslint": "^8.36.0"
   },

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

@@ -1,19 +0,0 @@
-import { CodeableConceptFieldsFragment } from "../../../graphql/operations/types.js";
-import { ConnectionCategory, DataConnectionStatus, DataConnectionType, SyncStatus } from "../../../graphql/schema.js";
-/**
- * @property {string} id - The connection ID (service_slug).
- * @property {DataConnectionStatus} status - The auth token status.
- * @property {string} name - The name of the connection.
- * @property {ConnectionCategory} category - Either Basic ('hapi') or OAuth.
- * @property {DataConnectionType} type - Data type of the data source connection.
- * @property {SyncStatus} syncStatus - The status of the data ingest pipeline.
- */
-export type MemberConnection = {
-    id: string;
-    status: DataConnectionStatus;
-    name: string;
-    category: ConnectionCategory;
-    type: DataConnectionType;
-    syncStatus: SyncStatus;
-    syncError: Array<CodeableConceptFieldsFragment | null> | null;
-};

package/dist/api/base/health-space/cancelationReasons-request.d.ts

@@ -1,16 +0,0 @@
-import { SearchReference } from "../../../graphql/schema.js";
-import { ErrorsCollector, ValidationRequest, Validator } from "../../../requests/index.js";
-export type CancelationReasonsRequestInput = {
-    organization: SearchReference;
-};
-/**
- * Validator for CancelationReasonsRequestInput.
- * Ensures that organization is present and has a non-empty value.
- */
-declare class CancelationReasonsRequestValidator implements Validator<CancelationReasonsRequestInput> {
-    validate(data: CancelationReasonsRequestInput, errors: ErrorsCollector): void;
-}
-export declare class CancelationReasonsRequest extends ValidationRequest<CancelationReasonsRequestInput> {
-    protected validator: CancelationReasonsRequestValidator;
-}
-export {};

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

@@ -1,9 +0,0 @@
-import { CategoryCode as GraphQLCategoryCode, ConsentProvisionType as GraphQLConsentProvisionType, ConsentStatus as GraphQLConsentStatus, FhirPersonGender as GraphQLFhirPersonGender } from "../../../graphql/schema.js";
-export type PersonGender = `${GraphQLFhirPersonGender}`;
-export type ConsentStatus = `${GraphQLConsentStatus}`;
-export type CategoryCode = `${GraphQLCategoryCode}`;
-export type ConsentProvisionType = `${GraphQLConsentProvisionType}`;
-export declare function isValidPersonGender(gender: string): gender is GraphQLFhirPersonGender;
-export declare function isValidConsentStatus(status: string): status is GraphQLConsentStatus;
-export declare function isValidCategoryCode(categoryCode: string): categoryCode is GraphQLCategoryCode;
-export declare function isValidConsentProvisionType(type: string): type is GraphQLConsentProvisionType;