@fluidframework/agent-scheduler 2.0.0-dev.7.4.0.215930 → 2.0.0-dev.7.4.0.216897

package/api-extractor-lint.json

@@ -0,0 +1,13 @@
+{
+	"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
+	"extends": "../../../common/build/build-common/api-extractor-lint.json",
+	"messages": {
+		"extractorMessageReporting": {
+			// TODO: remove once base config has this enabled as an error
+			"ae-incompatible-release-tags": {
+				"logLevel": "error",
+				"addToApiReportFile": false
+			}
+		}
+	}
+}

package/api-report/agent-scheduler.api.md

@@ -13,7 +13,7 @@ import { IFluidLoadable } from '@fluidframework/core-interfaces';
 import { NamedFluidDataStoreRegistryEntry } from '@fluidframework/runtime-definitions';
 import { TypedEventEmitter } from '@fluid-internal/client-utils';
 
-// @public (undocumented)
+// @internal (undocumented)
 export class AgentSchedulerFactory implements IFluidDataStoreFactory {
     // (undocumented)
     static createChildInstance(parentContext: IFluidDataStoreContext): Promise<IAgentScheduler>;
@@ -29,10 +29,10 @@ export class AgentSchedulerFactory implements IFluidDataStoreFactory {
     readonly type = "_scheduler";
 }
 
-// @public (undocumented)
+// @internal (undocumented)
 export const IAgentScheduler: keyof IProvideAgentScheduler;
 
-// @public
+// @internal
 export interface IAgentScheduler extends IProvideAgentScheduler, IEventProvider<IAgentSchedulerEvents>, IFluidLoadable {
     pick(taskId: string, worker: () => Promise<void>): Promise<void>;
     pickedTasks(): string[];
@@ -40,24 +40,24 @@ export interface IAgentScheduler extends IProvideAgentScheduler, IEventProvider<
     release(...taskUrls: string[]): Promise<void>;
 }
 
-// @public
+// @internal
 export interface IAgentSchedulerEvents extends IEvent {
     (event: "picked" | "released" | "lost", listener: (taskId: string) => void): any;
 }
 
-// @public (undocumented)
+// @internal (undocumented)
 export interface IProvideAgentScheduler {
     // (undocumented)
     readonly IAgentScheduler: IAgentScheduler;
 }
 
-// @public
+// @internal
 export interface ITaskSubscriptionEvents extends IEvent {
     // (undocumented)
     (event: "gotTask" | "lostTask", listener: () => void): any;
 }
 
-// @public
+// @internal
 export class TaskSubscription extends TypedEventEmitter<ITaskSubscriptionEvents> {
     constructor(agentScheduler: IAgentScheduler, taskId: string);
     haveTask(): boolean;

package/dist/agent-scheduler-alpha.d.ts

@@ -1,131 +1,28 @@
-import { FluidDataStoreRuntime } from '@fluidframework/datastore';
-import { IEvent } from '@fluidframework/core-interfaces';
-import { IEventProvider } from '@fluidframework/core-interfaces';
-import { IFluidDataStoreContext } from '@fluidframework/runtime-definitions';
-import { IFluidDataStoreFactory } from '@fluidframework/runtime-definitions';
-import { IFluidLoadable } from '@fluidframework/core-interfaces';
-import { NamedFluidDataStoreRegistryEntry } from '@fluidframework/runtime-definitions';
+/* Excluded from this release type: AgentSchedulerFactory */
 
-/**
- * @public
- */
-export declare class AgentSchedulerFactory implements IFluidDataStoreFactory {
-    static readonly type = "_scheduler";
-    readonly type = "_scheduler";
-    get IFluidDataStoreFactory(): this;
-    static get registryEntry(): NamedFluidDataStoreRegistryEntry;
-    static createChildInstance(parentContext: IFluidDataStoreContext): Promise<IAgentScheduler>;
-    instantiateDataStore(context: IFluidDataStoreContext, existing: boolean): Promise<FluidDataStoreRuntime>;
-}
+/* Excluded from this release type: FluidDataStoreRuntime */
 
-/**
- * @public
- */
-export declare const IAgentScheduler: keyof IProvideAgentScheduler;
+/* Excluded from this release type: IAgentScheduler */
 
-/**
- * Agent scheduler distributes a set of tasks/variables across connected clients.
- *
- * @public
- */
-export declare interface IAgentScheduler extends IProvideAgentScheduler, IEventProvider<IAgentSchedulerEvents>, IFluidLoadable {
-    /**
-     * Registers a set of new tasks to distribute amongst connected clients. Only use this if a client wants
-     * a new agent to run but does not have the capability to run the agent inside the host.
-     * Client can call pick() later if the capability changes.
-     *
-     * This method should only be called once per task. Duplicate calls will be rejected.
-     */
-    register(...taskUrls: string[]): Promise<void>;
-    /**
-     * Attempts to pick a set of tasks. A client will only run the task if it's chosen based on consensus.
-     * Resolves when the tasks are assigned to one of the connected clients.
-     *
-     * This method should only be called once per task. Duplicate calls will be rejected.
-     *
-     * @param worker - callback to run when task is picked up.
-     */
-    pick(taskId: string, worker: () => Promise<void>): Promise<void>;
-    /**
-     * Releases a set of tasks for other clients to grab. Resolves when the tasks are released.
-     *
-     * Only previously picked tasks are allowed. Releasing non picked tasks will get a rejection.
-     * App can call pickedTasks() to get the picked list first.
-     */
-    release(...taskUrls: string[]): Promise<void>;
-    /**
-     * Returns a list of all tasks running on this client
-     */
-    pickedTasks(): string[];
-}
+/* Excluded from this release type: IAgentSchedulerEvents */
 
-/**
- * Events emitted by {@link (IAgentScheduler:interface)}.
- *
- * @public
- */
-export declare interface IAgentSchedulerEvents extends IEvent {
-    /**
-     * Event when ownership of task changes
-     * @param event - name of the event:
-     *
-     * - "picked" - the task has been assigned to this client, in response to pick() being called
-     * If client loses this task (due to disconnect), it will attempt to pick it again (on connection)
-     * automatically, unless release() is called
-     *
-     * - "released" - the task was successfully released back to the pool. Client will not attempt to
-     * re-acquire the task, unless pick() is called.
-     *
-     * - "lost" - task is lost due to disconnect or data store / container being attached.
-     * Task will be picked up again by some connected client (this client will try as well,
-     * unless release() is called)
-     *
-     * @param listener - callback notified when change happened for particular key
-     */
-    (event: "picked" | "released" | "lost", listener: (taskId: string) => void): any;
-}
+/* Excluded from this release type: IEvent */
 
-/**
- * @public
- */
-export declare interface IProvideAgentScheduler {
-    readonly IAgentScheduler: IAgentScheduler;
-}
+/* Excluded from this release type: IEventProvider */
 
-/**
- * Events emitted by {@link TaskSubscription}.
- *
- * @public
- */
-export declare interface ITaskSubscriptionEvents extends IEvent {
-    (event: "gotTask" | "lostTask", listener: () => void): any;
-}
+/* Excluded from this release type: IFluidDataStoreContext */
 
-/**
- * TaskSubscription works with an AgentScheduler to make it easier to monitor a specific task ownership.
- *
- * @public
- */
-export declare class TaskSubscription extends TypedEventEmitter<ITaskSubscriptionEvents> {
-    private readonly agentScheduler;
-    readonly taskId: string;
-    private subscribed;
-    /**
-     * @param agentScheduler - The AgentScheduler that will be subscribed against
-     * @param taskId - The string ID of the task to subscribe against
-     */
-    constructor(agentScheduler: IAgentScheduler, taskId: string);
-    /**
-     * Check if currently holding ownership of the task.
-     * @returns true if currently the task owner, false otherwise.
-     */
-    haveTask(): boolean;
-    /**
-     * Volunteer for the task.  By default, the TaskSubscription will only watch the task and not volunteer.
-     * This is safe to call multiple times across multiple TaskSubscriptions.
-     */
-    volunteer(): void;
-}
+/* Excluded from this release type: IFluidDataStoreFactory */
+
+/* Excluded from this release type: IFluidLoadable */
+
+/* Excluded from this release type: IProvideAgentScheduler */
+
+/* Excluded from this release type: ITaskSubscriptionEvents */
+
+/* Excluded from this release type: NamedFluidDataStoreRegistryEntry */
+
+/* Excluded from this release type: TaskSubscription */
 
 /* Excluded from this release type: TypedEventEmitter */
 

package/dist/agent-scheduler-beta.d.ts

@@ -1,131 +1,28 @@
-import { FluidDataStoreRuntime } from '@fluidframework/datastore';
-import { IEvent } from '@fluidframework/core-interfaces';
-import { IEventProvider } from '@fluidframework/core-interfaces';
-import { IFluidDataStoreContext } from '@fluidframework/runtime-definitions';
-import { IFluidDataStoreFactory } from '@fluidframework/runtime-definitions';
-import { IFluidLoadable } from '@fluidframework/core-interfaces';
-import { NamedFluidDataStoreRegistryEntry } from '@fluidframework/runtime-definitions';
+/* Excluded from this release type: AgentSchedulerFactory */
 
-/**
- * @public
- */
-export declare class AgentSchedulerFactory implements IFluidDataStoreFactory {
-    static readonly type = "_scheduler";
-    readonly type = "_scheduler";
-    get IFluidDataStoreFactory(): this;
-    static get registryEntry(): NamedFluidDataStoreRegistryEntry;
-    static createChildInstance(parentContext: IFluidDataStoreContext): Promise<IAgentScheduler>;
-    instantiateDataStore(context: IFluidDataStoreContext, existing: boolean): Promise<FluidDataStoreRuntime>;
-}
+/* Excluded from this release type: FluidDataStoreRuntime */
 
-/**
- * @public
- */
-export declare const IAgentScheduler: keyof IProvideAgentScheduler;
+/* Excluded from this release type: IAgentScheduler */
 
-/**
- * Agent scheduler distributes a set of tasks/variables across connected clients.
- *
- * @public
- */
-export declare interface IAgentScheduler extends IProvideAgentScheduler, IEventProvider<IAgentSchedulerEvents>, IFluidLoadable {
-    /**
-     * Registers a set of new tasks to distribute amongst connected clients. Only use this if a client wants
-     * a new agent to run but does not have the capability to run the agent inside the host.
-     * Client can call pick() later if the capability changes.
-     *
-     * This method should only be called once per task. Duplicate calls will be rejected.
-     */
-    register(...taskUrls: string[]): Promise<void>;
-    /**
-     * Attempts to pick a set of tasks. A client will only run the task if it's chosen based on consensus.
-     * Resolves when the tasks are assigned to one of the connected clients.
-     *
-     * This method should only be called once per task. Duplicate calls will be rejected.
-     *
-     * @param worker - callback to run when task is picked up.
-     */
-    pick(taskId: string, worker: () => Promise<void>): Promise<void>;
-    /**
-     * Releases a set of tasks for other clients to grab. Resolves when the tasks are released.
-     *
-     * Only previously picked tasks are allowed. Releasing non picked tasks will get a rejection.
-     * App can call pickedTasks() to get the picked list first.
-     */
-    release(...taskUrls: string[]): Promise<void>;
-    /**
-     * Returns a list of all tasks running on this client
-     */
-    pickedTasks(): string[];
-}
+/* Excluded from this release type: IAgentSchedulerEvents */
 
-/**
- * Events emitted by {@link (IAgentScheduler:interface)}.
- *
- * @public
- */
-export declare interface IAgentSchedulerEvents extends IEvent {
-    /**
-     * Event when ownership of task changes
-     * @param event - name of the event:
-     *
-     * - "picked" - the task has been assigned to this client, in response to pick() being called
-     * If client loses this task (due to disconnect), it will attempt to pick it again (on connection)
-     * automatically, unless release() is called
-     *
-     * - "released" - the task was successfully released back to the pool. Client will not attempt to
-     * re-acquire the task, unless pick() is called.
-     *
-     * - "lost" - task is lost due to disconnect or data store / container being attached.
-     * Task will be picked up again by some connected client (this client will try as well,
-     * unless release() is called)
-     *
-     * @param listener - callback notified when change happened for particular key
-     */
-    (event: "picked" | "released" | "lost", listener: (taskId: string) => void): any;
-}
+/* Excluded from this release type: IEvent */
 
-/**
- * @public
- */
-export declare interface IProvideAgentScheduler {
-    readonly IAgentScheduler: IAgentScheduler;
-}
+/* Excluded from this release type: IEventProvider */
 
-/**
- * Events emitted by {@link TaskSubscription}.
- *
- * @public
- */
-export declare interface ITaskSubscriptionEvents extends IEvent {
-    (event: "gotTask" | "lostTask", listener: () => void): any;
-}
+/* Excluded from this release type: IFluidDataStoreContext */
 
-/**
- * TaskSubscription works with an AgentScheduler to make it easier to monitor a specific task ownership.
- *
- * @public
- */
-export declare class TaskSubscription extends TypedEventEmitter<ITaskSubscriptionEvents> {
-    private readonly agentScheduler;
-    readonly taskId: string;
-    private subscribed;
-    /**
-     * @param agentScheduler - The AgentScheduler that will be subscribed against
-     * @param taskId - The string ID of the task to subscribe against
-     */
-    constructor(agentScheduler: IAgentScheduler, taskId: string);
-    /**
-     * Check if currently holding ownership of the task.
-     * @returns true if currently the task owner, false otherwise.
-     */
-    haveTask(): boolean;
-    /**
-     * Volunteer for the task.  By default, the TaskSubscription will only watch the task and not volunteer.
-     * This is safe to call multiple times across multiple TaskSubscriptions.
-     */
-    volunteer(): void;
-}
+/* Excluded from this release type: IFluidDataStoreFactory */
+
+/* Excluded from this release type: IFluidLoadable */
+
+/* Excluded from this release type: IProvideAgentScheduler */
+
+/* Excluded from this release type: ITaskSubscriptionEvents */
+
+/* Excluded from this release type: NamedFluidDataStoreRegistryEntry */
+
+/* Excluded from this release type: TaskSubscription */
 
 /* Excluded from this release type: TypedEventEmitter */
 

package/dist/agent-scheduler-public.d.ts

@@ -1,131 +1,28 @@
-import { FluidDataStoreRuntime } from '@fluidframework/datastore';
-import { IEvent } from '@fluidframework/core-interfaces';
-import { IEventProvider } from '@fluidframework/core-interfaces';
-import { IFluidDataStoreContext } from '@fluidframework/runtime-definitions';
-import { IFluidDataStoreFactory } from '@fluidframework/runtime-definitions';
-import { IFluidLoadable } from '@fluidframework/core-interfaces';
-import { NamedFluidDataStoreRegistryEntry } from '@fluidframework/runtime-definitions';
+/* Excluded from this release type: AgentSchedulerFactory */
 
-/**
- * @public
- */
-export declare class AgentSchedulerFactory implements IFluidDataStoreFactory {
-    static readonly type = "_scheduler";
-    readonly type = "_scheduler";
-    get IFluidDataStoreFactory(): this;
-    static get registryEntry(): NamedFluidDataStoreRegistryEntry;
-    static createChildInstance(parentContext: IFluidDataStoreContext): Promise<IAgentScheduler>;
-    instantiateDataStore(context: IFluidDataStoreContext, existing: boolean): Promise<FluidDataStoreRuntime>;
-}
+/* Excluded from this release type: FluidDataStoreRuntime */
 
-/**
- * @public
- */
-export declare const IAgentScheduler: keyof IProvideAgentScheduler;
+/* Excluded from this release type: IAgentScheduler */
 
-/**
- * Agent scheduler distributes a set of tasks/variables across connected clients.
- *
- * @public
- */
-export declare interface IAgentScheduler extends IProvideAgentScheduler, IEventProvider<IAgentSchedulerEvents>, IFluidLoadable {
-    /**
-     * Registers a set of new tasks to distribute amongst connected clients. Only use this if a client wants
-     * a new agent to run but does not have the capability to run the agent inside the host.
-     * Client can call pick() later if the capability changes.
-     *
-     * This method should only be called once per task. Duplicate calls will be rejected.
-     */
-    register(...taskUrls: string[]): Promise<void>;
-    /**
-     * Attempts to pick a set of tasks. A client will only run the task if it's chosen based on consensus.
-     * Resolves when the tasks are assigned to one of the connected clients.
-     *
-     * This method should only be called once per task. Duplicate calls will be rejected.
-     *
-     * @param worker - callback to run when task is picked up.
-     */
-    pick(taskId: string, worker: () => Promise<void>): Promise<void>;
-    /**
-     * Releases a set of tasks for other clients to grab. Resolves when the tasks are released.
-     *
-     * Only previously picked tasks are allowed. Releasing non picked tasks will get a rejection.
-     * App can call pickedTasks() to get the picked list first.
-     */
-    release(...taskUrls: string[]): Promise<void>;
-    /**
-     * Returns a list of all tasks running on this client
-     */
-    pickedTasks(): string[];
-}
+/* Excluded from this release type: IAgentSchedulerEvents */
 
-/**
- * Events emitted by {@link (IAgentScheduler:interface)}.
- *
- * @public
- */
-export declare interface IAgentSchedulerEvents extends IEvent {
-    /**
-     * Event when ownership of task changes
-     * @param event - name of the event:
-     *
-     * - "picked" - the task has been assigned to this client, in response to pick() being called
-     * If client loses this task (due to disconnect), it will attempt to pick it again (on connection)
-     * automatically, unless release() is called
-     *
-     * - "released" - the task was successfully released back to the pool. Client will not attempt to
-     * re-acquire the task, unless pick() is called.
-     *
-     * - "lost" - task is lost due to disconnect or data store / container being attached.
-     * Task will be picked up again by some connected client (this client will try as well,
-     * unless release() is called)
-     *
-     * @param listener - callback notified when change happened for particular key
-     */
-    (event: "picked" | "released" | "lost", listener: (taskId: string) => void): any;
-}
+/* Excluded from this release type: IEvent */
 
-/**
- * @public
- */
-export declare interface IProvideAgentScheduler {
-    readonly IAgentScheduler: IAgentScheduler;
-}
+/* Excluded from this release type: IEventProvider */
 
-/**
- * Events emitted by {@link TaskSubscription}.
- *
- * @public
- */
-export declare interface ITaskSubscriptionEvents extends IEvent {
-    (event: "gotTask" | "lostTask", listener: () => void): any;
-}
+/* Excluded from this release type: IFluidDataStoreContext */
 
-/**
- * TaskSubscription works with an AgentScheduler to make it easier to monitor a specific task ownership.
- *
- * @public
- */
-export declare class TaskSubscription extends TypedEventEmitter<ITaskSubscriptionEvents> {
-    private readonly agentScheduler;
-    readonly taskId: string;
-    private subscribed;
-    /**
-     * @param agentScheduler - The AgentScheduler that will be subscribed against
-     * @param taskId - The string ID of the task to subscribe against
-     */
-    constructor(agentScheduler: IAgentScheduler, taskId: string);
-    /**
-     * Check if currently holding ownership of the task.
-     * @returns true if currently the task owner, false otherwise.
-     */
-    haveTask(): boolean;
-    /**
-     * Volunteer for the task.  By default, the TaskSubscription will only watch the task and not volunteer.
-     * This is safe to call multiple times across multiple TaskSubscriptions.
-     */
-    volunteer(): void;
-}
+/* Excluded from this release type: IFluidDataStoreFactory */
+
+/* Excluded from this release type: IFluidLoadable */
+
+/* Excluded from this release type: IProvideAgentScheduler */
+
+/* Excluded from this release type: ITaskSubscriptionEvents */
+
+/* Excluded from this release type: NamedFluidDataStoreRegistryEntry */
+
+/* Excluded from this release type: TaskSubscription */
 
 /* Excluded from this release type: TypedEventEmitter */
 

package/dist/agent-scheduler-untrimmed.d.ts

@@ -8,7 +8,7 @@ import { NamedFluidDataStoreRegistryEntry } from '@fluidframework/runtime-defini
 import { TypedEventEmitter } from '@fluid-internal/client-utils';
 
 /**
- * @public
+ * @internal
  */
 export declare class AgentSchedulerFactory implements IFluidDataStoreFactory {
     static readonly type = "_scheduler";
@@ -20,14 +20,13 @@ export declare class AgentSchedulerFactory implements IFluidDataStoreFactory {
 }
 
 /**
- * @public
+ * @internal
  */
 export declare const IAgentScheduler: keyof IProvideAgentScheduler;
 
 /**
  * Agent scheduler distributes a set of tasks/variables across connected clients.
- *
- * @public
+ * @internal
  */
 export declare interface IAgentScheduler extends IProvideAgentScheduler, IEventProvider<IAgentSchedulerEvents>, IFluidLoadable {
     /**
@@ -62,8 +61,7 @@ export declare interface IAgentScheduler extends IProvideAgentScheduler, IEventP
 
 /**
  * Events emitted by {@link (IAgentScheduler:interface)}.
- *
- * @public
+ * @internal
  */
 export declare interface IAgentSchedulerEvents extends IEvent {
     /**
@@ -87,7 +85,7 @@ export declare interface IAgentSchedulerEvents extends IEvent {
 }
 
 /**
- * @public
+ * @internal
  */
 export declare interface IProvideAgentScheduler {
     readonly IAgentScheduler: IAgentScheduler;
@@ -95,8 +93,7 @@ export declare interface IProvideAgentScheduler {
 
 /**
  * Events emitted by {@link TaskSubscription}.
- *
- * @public
+ * @internal
  */
 export declare interface ITaskSubscriptionEvents extends IEvent {
     (event: "gotTask" | "lostTask", listener: () => void): any;
@@ -104,8 +101,7 @@ export declare interface ITaskSubscriptionEvents extends IEvent {
 
 /**
  * TaskSubscription works with an AgentScheduler to make it easier to monitor a specific task ownership.
- *
- * @public
+ * @internal
  */
 export declare class TaskSubscription extends TypedEventEmitter<ITaskSubscriptionEvents> {
     private readonly agentScheduler;

package/dist/agent.cjs

@@ -6,7 +6,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.IAgentScheduler = void 0;
 /**
- * @public
+ * @internal
  */
 exports.IAgentScheduler = "IAgentScheduler";
 //# sourceMappingURL=agent.cjs.map

package/dist/agent.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"agent.cjs","sourceRoot":"","sources":["../src/agent.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAIH;;GAEG;AACU,QAAA,eAAe,GAAiC,iBAAiB,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { IEvent, IEventProvider, IFluidLoadable } from \"@fluidframework/core-interfaces\";\n\n/**\n * @public\n */\nexport const IAgentScheduler: keyof IProvideAgentScheduler = \"IAgentScheduler\";\n\n/**\n * @public\n */\nexport interface IProvideAgentScheduler {\n\treadonly IAgentScheduler: IAgentScheduler;\n}\n\n/**\n * Events emitted by {@link (IAgentScheduler:interface)}.\n *\n * @public\n */\nexport interface IAgentSchedulerEvents extends IEvent {\n\t/**\n\t * Event when ownership of task changes\n\t * @param event - name of the event:\n\t *\n\t * - \"picked\" - the task has been assigned to this client, in response to pick() being called\n\t * If client loses this task (due to disconnect), it will attempt to pick it again (on connection)\n\t * automatically, unless release() is called\n\t *\n\t * - \"released\" - the task was successfully released back to the pool. Client will not attempt to\n\t * re-acquire the task, unless pick() is called.\n\t *\n\t * - \"lost\" - task is lost due to disconnect or data store / container being attached.\n\t * Task will be picked up again by some connected client (this client will try as well,\n\t * unless release() is called)\n\t *\n\t * @param listener - callback notified when change happened for particular key\n\t */\n\t(event: \"picked\" | \"released\" | \"lost\", listener: (taskId: string) => void);\n}\n\n/**\n * Agent scheduler distributes a set of tasks/variables across connected clients.\n *\n * @public\n */\nexport interface IAgentScheduler\n\textends IProvideAgentScheduler,\n\t\tIEventProvider<IAgentSchedulerEvents>,\n\t\tIFluidLoadable {\n\t/**\n\t * Registers a set of new tasks to distribute amongst connected clients. Only use this if a client wants\n\t * a new agent to run but does not have the capability to run the agent inside the host.\n\t * Client can call pick() later if the capability changes.\n\t *\n\t * This method should only be called once per task. Duplicate calls will be rejected.\n\t */\n\tregister(...taskUrls: string[]): Promise<void>;\n\n\t/**\n\t * Attempts to pick a set of tasks. A client will only run the task if it's chosen based on consensus.\n\t * Resolves when the tasks are assigned to one of the connected clients.\n\t *\n\t * This method should only be called once per task. Duplicate calls will be rejected.\n\t *\n\t * @param worker - callback to run when task is picked up.\n\t */\n\tpick(taskId: string, worker: () => Promise<void>): Promise<void>;\n\n\t/**\n\t * Releases a set of tasks for other clients to grab. Resolves when the tasks are released.\n\t *\n\t * Only previously picked tasks are allowed. Releasing non picked tasks will get a rejection.\n\t * App can call pickedTasks() to get the picked list first.\n\t */\n\trelease(...taskUrls: string[]): Promise<void>;\n\n\t/**\n\t * Returns a list of all tasks running on this client\n\t */\n\tpickedTasks(): string[];\n}\n"]}
+{"version":3,"file":"agent.cjs","sourceRoot":"","sources":["../src/agent.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAIH;;GAEG;AACU,QAAA,eAAe,GAAiC,iBAAiB,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { IEvent, IEventProvider, IFluidLoadable } from \"@fluidframework/core-interfaces\";\n\n/**\n * @internal\n */\nexport const IAgentScheduler: keyof IProvideAgentScheduler = \"IAgentScheduler\";\n\n/**\n * @internal\n */\nexport interface IProvideAgentScheduler {\n\treadonly IAgentScheduler: IAgentScheduler;\n}\n\n/**\n * Events emitted by {@link (IAgentScheduler:interface)}.\n * @internal\n */\nexport interface IAgentSchedulerEvents extends IEvent {\n\t/**\n\t * Event when ownership of task changes\n\t * @param event - name of the event:\n\t *\n\t * - \"picked\" - the task has been assigned to this client, in response to pick() being called\n\t * If client loses this task (due to disconnect), it will attempt to pick it again (on connection)\n\t * automatically, unless release() is called\n\t *\n\t * - \"released\" - the task was successfully released back to the pool. Client will not attempt to\n\t * re-acquire the task, unless pick() is called.\n\t *\n\t * - \"lost\" - task is lost due to disconnect or data store / container being attached.\n\t * Task will be picked up again by some connected client (this client will try as well,\n\t * unless release() is called)\n\t *\n\t * @param listener - callback notified when change happened for particular key\n\t */\n\t(event: \"picked\" | \"released\" | \"lost\", listener: (taskId: string) => void);\n}\n\n/**\n * Agent scheduler distributes a set of tasks/variables across connected clients.\n * @internal\n */\nexport interface IAgentScheduler\n\textends IProvideAgentScheduler,\n\t\tIEventProvider<IAgentSchedulerEvents>,\n\t\tIFluidLoadable {\n\t/**\n\t * Registers a set of new tasks to distribute amongst connected clients. Only use this if a client wants\n\t * a new agent to run but does not have the capability to run the agent inside the host.\n\t * Client can call pick() later if the capability changes.\n\t *\n\t * This method should only be called once per task. Duplicate calls will be rejected.\n\t */\n\tregister(...taskUrls: string[]): Promise<void>;\n\n\t/**\n\t * Attempts to pick a set of tasks. A client will only run the task if it's chosen based on consensus.\n\t * Resolves when the tasks are assigned to one of the connected clients.\n\t *\n\t * This method should only be called once per task. Duplicate calls will be rejected.\n\t *\n\t * @param worker - callback to run when task is picked up.\n\t */\n\tpick(taskId: string, worker: () => Promise<void>): Promise<void>;\n\n\t/**\n\t * Releases a set of tasks for other clients to grab. Resolves when the tasks are released.\n\t *\n\t * Only previously picked tasks are allowed. Releasing non picked tasks will get a rejection.\n\t * App can call pickedTasks() to get the picked list first.\n\t */\n\trelease(...taskUrls: string[]): Promise<void>;\n\n\t/**\n\t * Returns a list of all tasks running on this client\n\t */\n\tpickedTasks(): string[];\n}\n"]}

package/dist/agent.d.ts

@@ -4,19 +4,18 @@
  */
 import { IEvent, IEventProvider, IFluidLoadable } from "@fluidframework/core-interfaces";
 /**
- * @public
+ * @internal
  */
 export declare const IAgentScheduler: keyof IProvideAgentScheduler;
 /**
- * @public
+ * @internal
  */
 export interface IProvideAgentScheduler {
     readonly IAgentScheduler: IAgentScheduler;
 }
 /**
  * Events emitted by {@link (IAgentScheduler:interface)}.
- *
- * @public
+ * @internal
  */
 export interface IAgentSchedulerEvents extends IEvent {
     /**
@@ -40,8 +39,7 @@ export interface IAgentSchedulerEvents extends IEvent {
 }
 /**
  * Agent scheduler distributes a set of tasks/variables across connected clients.
- *
- * @public
+ * @internal
  */
 export interface IAgentScheduler extends IProvideAgentScheduler, IEventProvider<IAgentSchedulerEvents>, IFluidLoadable {
     /**

package/dist/agent.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"agent.d.ts","sourceRoot":"","sources":["../src/agent.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,MAAM,EAAE,cAAc,EAAE,cAAc,EAAE,MAAM,iCAAiC,CAAC;AAEzF;;GAEG;AACH,eAAO,MAAM,eAAe,EAAE,MAAM,sBAA0C,CAAC;AAE/E;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACtC,QAAQ,CAAC,eAAe,EAAE,eAAe,CAAC;CAC1C;AAED;;;;GAIG;AACH,MAAM,WAAW,qBAAsB,SAAQ,MAAM;IACpD;;;;;;;;;;;;;;;;OAgBG;IACH,CAAC,KAAK,EAAE,QAAQ,GAAG,UAAU,GAAG,MAAM,EAAE,QAAQ,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,IAAI,OAAE;CAC5E;AAED;;;;GAIG;AACH,MAAM,WAAW,eAChB,SAAQ,sBAAsB,EAC7B,cAAc,CAAC,qBAAqB,CAAC,EACrC,cAAc;IACf;;;;;;OAMG;IACH,QAAQ,CAAC,GAAG,QAAQ,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE/C;;;;;;;OAOG;IACH,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEjE;;;;;OAKG;IACH,OAAO,CAAC,GAAG,QAAQ,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE9C;;OAEG;IACH,WAAW,IAAI,MAAM,EAAE,CAAC;CACxB"}
+{"version":3,"file":"agent.d.ts","sourceRoot":"","sources":["../src/agent.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,MAAM,EAAE,cAAc,EAAE,cAAc,EAAE,MAAM,iCAAiC,CAAC;AAEzF;;GAEG;AACH,eAAO,MAAM,eAAe,EAAE,MAAM,sBAA0C,CAAC;AAE/E;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACtC,QAAQ,CAAC,eAAe,EAAE,eAAe,CAAC;CAC1C;AAED;;;GAGG;AACH,MAAM,WAAW,qBAAsB,SAAQ,MAAM;IACpD;;;;;;;;;;;;;;;;OAgBG;IACH,CAAC,KAAK,EAAE,QAAQ,GAAG,UAAU,GAAG,MAAM,EAAE,QAAQ,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,IAAI,OAAE;CAC5E;AAED;;;GAGG;AACH,MAAM,WAAW,eAChB,SAAQ,sBAAsB,EAC7B,cAAc,CAAC,qBAAqB,CAAC,EACrC,cAAc;IACf;;;;;;OAMG;IACH,QAAQ,CAAC,GAAG,QAAQ,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE/C;;;;;;;OAOG;IACH,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEjE;;;;;OAKG;IACH,OAAO,CAAC,GAAG,QAAQ,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE9C;;OAEG;IACH,WAAW,IAAI,MAAM,EAAE,CAAC;CACxB"}

package/dist/scheduler.cjs

@@ -371,7 +371,7 @@ class AgentSchedulerRuntime extends datastore_1.FluidDataStoreRuntime {
     }
 }
 /**
- * @public
+ * @internal
  */
 class AgentSchedulerFactory {
     constructor() {