@medplum/mock 5.1.24 → 5.1.27

package/dist/cjs/index.d.ts

@@ -337,11 +337,25 @@ export declare class MockClient extends MedplumClient {
     private profile;
     subManager: MockSubscriptionManager | undefined;
     constructor(clientOptions?: MockClientOptions);
+    get mock(): MockClientTestMethods;
     clear(): void;
+    /**
+     * Run a function in "seeding" mode, allowing it to set metadata like
+     * `versionId` that normally would be dropped.
+     *
+     * @deprecated - Use `.mock.withSeeding()` instead
+     * @param fn - The callback to run in "seeding" mode
+     * @returns The return value from `fn`
+     */
     withSeeding<T>(fn: () => T | Promise<T>): Promise<T>;
     getProfile(): ProfileResource | undefined;
     getUserConfiguration(): WithId<UserConfiguration> | undefined;
     setActiveLoginOverride(activeLoginOverride: LoginState): void;
+    /**
+     * Overrides the active profile.
+     * @deprecated - Use `.mock.setProfile()` instead
+     * @param profile - The profile to set as active for this client
+     */
     setProfile(profile: ProfileResource | undefined): void;
     getActiveLogin(): LoginState | undefined;
     getLogins(): LoginState[];
@@ -382,8 +396,20 @@ export declare class MockClient extends MedplumClient {
      */
     createBinary(data: BinarySource, filename: string | undefined, contentType: string, onProgress?: (e: ProgressEvent) => void, options?: MedplumRequestOptions): Promise<WithId<Binary>>;
     pushToAgent(agent: Agent | Reference<Agent>, destination: Device | Reference<Device> | string, body: any, contentType?: string, _waitForResponse?: boolean, _options?: MedplumRequestOptions): Promise<any>;
+    /**
+     * Updates internal test state used by `pushToAgent` mocking.
+     *
+     * @deprecated - Use `.mock.setAgentAvailable()` instead
+     * @param value - boolean
+     */
     setAgentAvailable(value: boolean): void;
     getSubscriptionManager(): MockSubscriptionManager;
+    /**
+     * Sets a MockSubscriptionManager that this MockClient should use.
+     *
+     * @deprecated - Use `.mock.setSubscriptionManager()` instead
+     * @param subManager - A MockSubscriptionManager to attach to this MockClient
+     */
     setSubscriptionManager(subManager: MockSubscriptionManager): void;
     subscribeToCriteria(criteria: string, subscriptionProps?: Partial<Subscription>): SubscriptionEmitter;
     unsubscribeFromCriteria(criteria: string, subscriptionProps?: Partial<Subscription>): void;
@@ -403,6 +429,13 @@ export declare interface MockClientOptions extends Pick<MedplumClientOptions, 'b
     readonly mockFetchOverride?: MockFetchOverrideOptions;
 }
 
+declare interface MockClientTestMethods {
+    withSeeding: <T>(fn: () => T | Promise<T>) => Promise<T>;
+    setProfile: (profile: ProfileResource | undefined) => void;
+    setAgentAvailable: (value: boolean) => void;
+    setSubscriptionManager: (subManager: MockSubscriptionManager) => void;
+}
+
 export declare type MockCriteriaEntry = {
     criteria: string;
     subscriptionProps?: Partial<Subscription>;

package/dist/esm/index.d.ts

@@ -337,11 +337,25 @@ export declare class MockClient extends MedplumClient {
     private profile;
     subManager: MockSubscriptionManager | undefined;
     constructor(clientOptions?: MockClientOptions);
+    get mock(): MockClientTestMethods;
     clear(): void;
+    /**
+     * Run a function in "seeding" mode, allowing it to set metadata like
+     * `versionId` that normally would be dropped.
+     *
+     * @deprecated - Use `.mock.withSeeding()` instead
+     * @param fn - The callback to run in "seeding" mode
+     * @returns The return value from `fn`
+     */
     withSeeding<T>(fn: () => T | Promise<T>): Promise<T>;
     getProfile(): ProfileResource | undefined;
     getUserConfiguration(): WithId<UserConfiguration> | undefined;
     setActiveLoginOverride(activeLoginOverride: LoginState): void;
+    /**
+     * Overrides the active profile.
+     * @deprecated - Use `.mock.setProfile()` instead
+     * @param profile - The profile to set as active for this client
+     */
     setProfile(profile: ProfileResource | undefined): void;
     getActiveLogin(): LoginState | undefined;
     getLogins(): LoginState[];
@@ -382,8 +396,20 @@ export declare class MockClient extends MedplumClient {
      */
     createBinary(data: BinarySource, filename: string | undefined, contentType: string, onProgress?: (e: ProgressEvent) => void, options?: MedplumRequestOptions): Promise<WithId<Binary>>;
     pushToAgent(agent: Agent | Reference<Agent>, destination: Device | Reference<Device> | string, body: any, contentType?: string, _waitForResponse?: boolean, _options?: MedplumRequestOptions): Promise<any>;
+    /**
+     * Updates internal test state used by `pushToAgent` mocking.
+     *
+     * @deprecated - Use `.mock.setAgentAvailable()` instead
+     * @param value - boolean
+     */
     setAgentAvailable(value: boolean): void;
     getSubscriptionManager(): MockSubscriptionManager;
+    /**
+     * Sets a MockSubscriptionManager that this MockClient should use.
+     *
+     * @deprecated - Use `.mock.setSubscriptionManager()` instead
+     * @param subManager - A MockSubscriptionManager to attach to this MockClient
+     */
     setSubscriptionManager(subManager: MockSubscriptionManager): void;
     subscribeToCriteria(criteria: string, subscriptionProps?: Partial<Subscription>): SubscriptionEmitter;
     unsubscribeFromCriteria(criteria: string, subscriptionProps?: Partial<Subscription>): void;
@@ -403,6 +429,13 @@ export declare interface MockClientOptions extends Pick<MedplumClientOptions, 'b
     readonly mockFetchOverride?: MockFetchOverrideOptions;
 }
 
+declare interface MockClientTestMethods {
+    withSeeding: <T>(fn: () => T | Promise<T>) => Promise<T>;
+    setProfile: (profile: ProfileResource | undefined) => void;
+    setAgentAvailable: (value: boolean) => void;
+    setSubscriptionManager: (subManager: MockSubscriptionManager) => void;
+}
+
 export declare type MockCriteriaEntry = {
     criteria: string;
     subscriptionProps?: Partial<Subscription>;