@fluidframework/agent-scheduler 2.0.0-rc.2.0.2 → 2.0.0-rc.3.0.1

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

@@ -1,127 +0,0 @@
-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';
-import { TypedEventEmitter } from '@fluid-internal/client-utils';
-
-/**
- * @alpha
- */
-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>;
-}
-
-/**
- * @alpha
- */
-export declare const IAgentScheduler: keyof IProvideAgentScheduler;
-
-/**
- * Agent scheduler distributes a set of tasks/variables across connected clients.
- * @alpha
- */
-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[];
-}
-
-/**
- * Events emitted by {@link (IAgentScheduler:interface)}.
- * @alpha
- */
-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;
-}
-
-/**
- * @alpha
- */
-export declare interface IProvideAgentScheduler {
-    readonly IAgentScheduler: IAgentScheduler;
-}
-
-/**
- * Events emitted by {@link TaskSubscription}.
- * @alpha
- */
-export declare interface ITaskSubscriptionEvents extends IEvent {
-    (event: "gotTask" | "lostTask", listener: () => void): any;
-}
-
-/**
- * TaskSubscription works with an AgentScheduler to make it easier to monitor a specific task ownership.
- * @alpha
- */
-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;
-}
-
-export { }

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

@@ -1,127 +0,0 @@
-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';
-import { TypedEventEmitter } from '@fluid-internal/client-utils';
-
-/**
- * @alpha
- */
-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>;
-}
-
-/**
- * @alpha
- */
-export declare const IAgentScheduler: keyof IProvideAgentScheduler;
-
-/**
- * Agent scheduler distributes a set of tasks/variables across connected clients.
- * @alpha
- */
-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[];
-}
-
-/**
- * Events emitted by {@link (IAgentScheduler:interface)}.
- * @alpha
- */
-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;
-}
-
-/**
- * @alpha
- */
-export declare interface IProvideAgentScheduler {
-    readonly IAgentScheduler: IAgentScheduler;
-}
-
-/**
- * Events emitted by {@link TaskSubscription}.
- * @alpha
- */
-export declare interface ITaskSubscriptionEvents extends IEvent {
-    (event: "gotTask" | "lostTask", listener: () => void): any;
-}
-
-/**
- * TaskSubscription works with an AgentScheduler to make it easier to monitor a specific task ownership.
- * @alpha
- */
-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;
-}
-
-export { }

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

@@ -1,30 +0,0 @@
-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';
-import { TypedEventEmitter } from '@fluid-internal/client-utils';
-
-/* Excluded from this release type: AgentSchedulerFactory */
-
-/* Excluded from this release type: FluidDataStoreRuntime */
-
-/* Excluded from this release type: IAgentScheduler */
-
-/* Excluded from this release type: IAgentSchedulerEvents */
-
-/* Excluded from this release type: IFluidDataStoreContext */
-
-/* Excluded from this release type: IFluidDataStoreFactory */
-
-/* Excluded from this release type: IProvideAgentScheduler */
-
-/* Excluded from this release type: ITaskSubscriptionEvents */
-
-/* Excluded from this release type: NamedFluidDataStoreRegistryEntry */
-
-/* Excluded from this release type: TaskSubscription */
-
-export { }

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

@@ -1,30 +0,0 @@
-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';
-import { TypedEventEmitter } from '@fluid-internal/client-utils';
-
-/* Excluded from this release type: AgentSchedulerFactory */
-
-/* Excluded from this release type: FluidDataStoreRuntime */
-
-/* Excluded from this release type: IAgentScheduler */
-
-/* Excluded from this release type: IAgentSchedulerEvents */
-
-/* Excluded from this release type: IFluidDataStoreContext */
-
-/* Excluded from this release type: IFluidDataStoreFactory */
-
-/* Excluded from this release type: IProvideAgentScheduler */
-
-/* Excluded from this release type: ITaskSubscriptionEvents */
-
-/* Excluded from this release type: NamedFluidDataStoreRegistryEntry */
-
-/* Excluded from this release type: TaskSubscription */
-
-export { }

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

@@ -1,127 +0,0 @@
-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';
-import { TypedEventEmitter } from '@fluid-internal/client-utils';
-
-/**
- * @alpha
- */
-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>;
-}
-
-/**
- * @alpha
- */
-export declare const IAgentScheduler: keyof IProvideAgentScheduler;
-
-/**
- * Agent scheduler distributes a set of tasks/variables across connected clients.
- * @alpha
- */
-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[];
-}
-
-/**
- * Events emitted by {@link (IAgentScheduler:interface)}.
- * @alpha
- */
-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;
-}
-
-/**
- * @alpha
- */
-export declare interface IProvideAgentScheduler {
-    readonly IAgentScheduler: IAgentScheduler;
-}
-
-/**
- * Events emitted by {@link TaskSubscription}.
- * @alpha
- */
-export declare interface ITaskSubscriptionEvents extends IEvent {
-    (event: "gotTask" | "lostTask", listener: () => void): any;
-}
-
-/**
- * TaskSubscription works with an AgentScheduler to make it easier to monitor a specific task ownership.
- * @alpha
- */
-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;
-}
-
-export { }