/*!
 * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
 * Licensed under the MIT License.
 */
import type { BroadcastControls } from "./broadcastControlsTypes.js";
import type { InternalTypes } from "./exposedInternalTypes.js";
import type { InternalUtilityTypes } from "./exposedUtilityTypes.js";
import type { NotificationsManager } from "./notificationsManagerTypes.js";
import type { Presence, PresenceWithNotifications } from "./presence.js";
/**
 * Unique address within a session.
 *
 * @remarks
 * A string known to all clients working with a certain Workspace and unique
 * among Workspaces. Recommend using specifying concatenation of: type of
 * unique identifier, `:` (required), and unique identifier.
 *
 * @example Examples
 * ```typescript
 *   "guid:g0fl001d-1415-5000-c00l-g0fa54g0b1g1"
 *   "address:object0/sub-object2:pointers"
 * ```
 *
 * @public
 */
export type WorkspaceAddress = `${string}:${string}`;
/**
 * Single entry in {@link StatesWorkspaceSchema} or  {@link NotificationsWorkspaceSchema}.
 *
 * @public
 */
export type StatesWorkspaceEntry<TKey extends string, TValue extends InternalTypes.ValueDirectoryOrState<unknown>, TManager = unknown> = InternalTypes.ManagerFactory<TKey, TValue, TManager>;
/**
 * Schema for a {@link StatesWorkspace} workspace.
 *
 * Keys of schema are the keys of the {@link StatesWorkspace} providing access to State objects.
 *
 * @public
 */
export type StatesWorkspaceSchema<Keys extends string = string> = {
    [Key in Keys]: StatesWorkspaceEntry<Key, InternalTypes.ValueDirectoryOrState<unknown>>;
};
/**
 * Map of State objects registered with {@link StatesWorkspace}.
 *
 * @sealed
 * @public
 */
export type StatesWorkspaceEntries<TSchema extends Partial<StatesWorkspaceSchema<TSchemaKeys>>, TSchemaKeys extends string & keyof TSchema = string & keyof TSchema> = {
    /**
     * Registered State objects.
     */
    readonly [Key in keyof TSchema]: ReturnType<Exclude<TSchema[Key], undefined>>["manager"] extends InternalTypes.StateValue<infer TManager> ? TManager : never;
};
/**
 * `StatesWorkspace` maintains a registry of State objects that all share and provide access to
 * presence state values across client members in a session.
 *
 * State objects offer variations on how to manage states, but all share same principle that
 * each client's state is independent and may only be updated by originating client.
 *
 * @sealed
 * @public
 */
export interface StatesWorkspace<TSchema extends Partial<StatesWorkspaceSchema<TSchemaKeys>>, TManagerConstraints = unknown, TSchemaKeys extends string & keyof TSchema = string & keyof TSchema> {
    /**
     * Registers a new State object with the {@link StatesWorkspace}.
     * @param key - new unique key for the State object within the workspace
     * @param configuration - factory/settings for creating a State object. Use
     * {@link @fluidframework/presence#StateFactory} to create.
     */
    add<TKey extends string, TValue extends InternalTypes.ValueDirectoryOrState<unknown>, TManager extends TManagerConstraints>(key: TKey, configuration: InternalTypes.ManagerFactory<TKey, TValue, TManager>): asserts this is StatesWorkspace<TSchema & Record<TKey, InternalTypes.ManagerFactory<TKey, TValue, TManager>>, TManagerConstraints>;
    /**
     * Registry of State objects.
     */
    readonly states: StatesWorkspaceEntries<TSchema, TSchemaKeys>;
    /**
     * Default controls for management of broadcast updates.
     */
    readonly controls: BroadcastControls;
    /**
     * Containing {@link Presence}
     */
    readonly presence: Presence;
}
/**
 * Schema for a {@link NotificationsWorkspace} workspace.
 *
 * Keys of schema are the keys of the {@link NotificationsWorkspace} providing access to {@link NotificationsManager}s.
 *
 * @alpha
 */
export type NotificationsWorkspaceSchema<Keys extends string = string> = {
    [Key in Keys]: InternalTypes.ManagerFactory<Key, InternalTypes.ValueRequiredState<InternalTypes.NotificationType>, NotificationsManager<InternalUtilityTypes.NotificationListeners<unknown>>>;
};
/**
 * `NotificationsWorkspace` maintains a registry of {@link NotificationsManager}s
 * that facilitate messages across client members in a session.
 *
 * @privateRemarks
 * This should be kept mostly in sync with {@link StatesWorkspace}. Notably the
 * return type of `add` is limited here and the `controls` property is omitted.
 * The `PresenceStatesImpl` class implements `AnyWorkspace` and therefore
 * `NotificationsWorkspace`, so long as this is proper subset.
 *
 * @sealed
 * @alpha
 */
export interface NotificationsWorkspace<TSchema extends Partial<NotificationsWorkspaceSchema<TSchemaKeys>>, TSchemaKeys extends string & keyof TSchema = string & keyof TSchema> {
    /**
     * Registers a new `NotificationsManager` with the {@link NotificationsWorkspace}.
     * @param key - new unique key for the `NotificationsManager` within the workspace
     * @param manager - factory for creating a `NotificationsManager`
     */
    add<TKey extends string, TValue extends InternalTypes.ValueDirectoryOrState<unknown>, TManager extends NotificationsManager<InternalUtilityTypes.NotificationListeners<unknown>>>(key: TKey, manager: InternalTypes.ManagerFactory<TKey, TValue, TManager>): asserts this is NotificationsWorkspace<TSchema & Record<TKey, InternalTypes.ManagerFactory<TKey, TValue, TManager>>>;
    /**
     * Registry of `NotificationsManager`s.
     */
    readonly notifications: StatesWorkspaceEntries<TSchema, TSchemaKeys>;
    /**
     * Containing {@link PresenceWithNotifications}
     */
    readonly presence: PresenceWithNotifications;
}
/**
 * `AnyWorkspace` is a superset of {@link StatesWorkspace} and {@link NotificationsWorkspace}.
 *
 * @internal
 */
export interface AnyWorkspace<TSchema extends StatesWorkspaceSchema, TManagerConstraints = unknown> extends StatesWorkspace<TSchema, TManagerConstraints> {
    readonly notifications: StatesWorkspaceEntries<TSchema>;
    readonly presence: PresenceWithNotifications;
}
//# sourceMappingURL=types.d.ts.map