@fluidframework/fluid-static
Advanced tools
Comparing version 0.48.3 to 0.49.0-39015
@@ -14,2 +14,32 @@ /*! | ||
* Events emitted from IFluidContainer. | ||
* | ||
* ### "connected" | ||
* | ||
* The connected event is emitted when the `IFluidContainer` completes connecting to the Fluid service. | ||
* | ||
* #### Listener signature | ||
* | ||
* ```typescript | ||
* () => void; | ||
* ``` | ||
* | ||
* ### "dispose" | ||
* | ||
* The dispose event is emitted when the `IFluidContainer` is disposed, which permanently disables it. | ||
* | ||
* #### Listener signature | ||
* | ||
* ```typescript | ||
* () => void; | ||
* ``` | ||
* | ||
* ### "disconnected" | ||
* | ||
* The disconnected event is emitted when the `IFluidContainer` becomes disconnected from the Fluid service. | ||
* | ||
* #### Listener signature | ||
* | ||
* ```typescript | ||
* () => void; | ||
* ``` | ||
*/ | ||
@@ -16,0 +46,0 @@ export interface IFluidContainerEvents extends IEvent { |
@@ -24,6 +24,4 @@ /*! | ||
/** | ||
* The DOProviderContainerRuntimeFactory is the container code for our scenario. | ||
* | ||
* By including the createRequestHandler, we can create any droplet types we include in the registry on-demand. | ||
* These can then be retrieved via container.request("/dataObjectId"). | ||
* The DOProviderContainerRuntimeFactory is container code that provides a single RootDataObject. This data object is | ||
* dynamically customized (registry and initial objects) based on the schema provided to the container runtime factory. | ||
*/ | ||
@@ -30,0 +28,0 @@ export declare class DOProviderContainerRuntimeFactory extends BaseContainerRuntimeFactory { |
@@ -80,6 +80,4 @@ "use strict"; | ||
/** | ||
* The DOProviderContainerRuntimeFactory is the container code for our scenario. | ||
* | ||
* By including the createRequestHandler, we can create any droplet types we include in the registry on-demand. | ||
* These can then be retrieved via container.request("/dataObjectId"). | ||
* The DOProviderContainerRuntimeFactory is container code that provides a single RootDataObject. This data object is | ||
* dynamically customized (registry and initial objects) based on the schema provided to the container runtime factory. | ||
*/ | ||
@@ -86,0 +84,0 @@ class DOProviderContainerRuntimeFactory extends aqueduct_1.BaseContainerRuntimeFactory { |
@@ -10,2 +10,8 @@ /*! | ||
import { IServiceAudience, IServiceAudienceEvents, IMember } from "./types"; | ||
/** | ||
* Base class for providing audience information for sessions interacting with FluidContainer | ||
* This can be extended by different service-specific client packages to additional parameters to | ||
* the user and client details returned in IMember | ||
* @typeParam M - A service-specific member type. | ||
*/ | ||
export declare abstract class ServiceAudience<M extends IMember = IMember> extends TypedEventEmitter<IServiceAudienceEvents<M>> implements IServiceAudience<M> { | ||
@@ -12,0 +18,0 @@ protected readonly container: Container; |
@@ -9,5 +9,8 @@ "use strict"; | ||
const common_utils_1 = require("@fluidframework/common-utils"); | ||
// Base class for providing audience information for sessions interacting with FluidContainer | ||
// This can be extended by different service-specific client packages to additional parameters to | ||
// the user and client details returned in IMember | ||
/** | ||
* Base class for providing audience information for sessions interacting with FluidContainer | ||
* This can be extended by different service-specific client packages to additional parameters to | ||
* the user and client details returned in IMember | ||
* @typeParam M - A service-specific member type. | ||
*/ | ||
class ServiceAudience extends common_utils_1.TypedEventEmitter { | ||
@@ -14,0 +17,0 @@ constructor(container) { |
@@ -9,6 +9,14 @@ /*! | ||
import { IFluidDataStoreFactory } from "@fluidframework/runtime-definitions"; | ||
/** | ||
* A mapping of string identifiers to instantiated DataObjects or SharedObjects. | ||
*/ | ||
export declare type LoadableObjectRecord = Record<string, IFluidLoadable>; | ||
/** | ||
* A mapping of string identifiers to classes that will later be used to instantiate a corresponding DataObject | ||
* or SharedObject in a LoadableObjectRecord. | ||
*/ | ||
export declare type LoadableObjectClassRecord = Record<string, LoadableObjectClass<any>>; | ||
/** | ||
* A LoadableObjectClass is an class object of DataObject or SharedObject | ||
* @typeParam T - The class of the DataObject or SharedObject | ||
*/ | ||
@@ -19,2 +27,3 @@ export declare type LoadableObjectClass<T extends IFluidLoadable> = DataObjectClass<T> | SharedObjectClass<T>; | ||
* constructor that will return the type of the DataObject. | ||
* @typeParam T - The class of the DataObject | ||
*/ | ||
@@ -27,2 +36,3 @@ export declare type DataObjectClass<T extends IFluidLoadable> = { | ||
* constructor that will return the type of the DataObject. | ||
* @typeParam T - The class of the SharedObject | ||
*/ | ||
@@ -34,4 +44,10 @@ export declare type SharedObjectClass<T extends IFluidLoadable> = { | ||
* An object with a constructor that will return an `IFluidLoadable`. | ||
* @typeParam T - The class of the loadable object | ||
*/ | ||
export declare type LoadableObjectCtor<T extends IFluidLoadable> = new (...args: any[]) => T; | ||
/** | ||
* The ContainerSchema declares the Fluid objects that will be available in the container. It includes both the | ||
* instances of objects that are initially available upon container creation, as well as the types of objects that may | ||
* be dynamically created throughout the lifetime of the container. | ||
*/ | ||
export interface ContainerSchema { | ||
@@ -68,2 +84,39 @@ /** | ||
* will emit events. | ||
* | ||
* ### "membersChanged" | ||
* | ||
* The membersChanged event is emitted when a member is either added or removed. | ||
* | ||
* #### Listener signature | ||
* | ||
* ```typescript | ||
* () => void; | ||
* ``` | ||
* | ||
* ### "memberAdded" | ||
* | ||
* The memberAdded event is emitted when a member joins the audience. | ||
* | ||
* #### Listener signature | ||
* | ||
* ```typescript | ||
* (clientId: string, member: M) => void; | ||
* ``` | ||
* - `clientId` - A unique identifier for the client | ||
* | ||
* - `member` - The service-specific member object for the client | ||
* | ||
* ### "memberRemoved" | ||
* | ||
* The memberRemoved event is emitted when a member leaves the audience. | ||
* | ||
* #### Listener signature | ||
* | ||
* ```typescript | ||
* (clientId: string, member: M) => void; | ||
* ``` | ||
* - `clientId` - A unique identifier for the client | ||
* | ||
* - `member` - The service-specific member object for the client | ||
* @typeParam M - A service-specific member type. | ||
*/ | ||
@@ -77,3 +130,4 @@ export interface IServiceAudienceEvents<M extends IMember> extends IEvent { | ||
* extend the client object with service-specific details about the connecting client, such as device information, | ||
* environme | ||
* environment, or a username. | ||
* @typeParam M - A service-specific member type. | ||
*/ | ||
@@ -93,20 +147,29 @@ export interface IServiceAudience<M extends IMember> extends IEventProvider<IServiceAudienceEvents<M>> { | ||
/** | ||
* Base interface for information for each connection made to the Fluid session, which will be | ||
* different even if it is by the same user, i.e. the connection's id will be uniquely generated for each time the user | ||
* connects This interface can be extended to provide additional information specific to each service. | ||
* Base interface for information for each connection made to the Fluid session. This interface can be extended | ||
* to provide additional information specific to each service. | ||
*/ | ||
export interface IConnection { | ||
/** | ||
* A unique ID for the connection. A single user may have multiple connections, each with a different ID. | ||
*/ | ||
id: string; | ||
/** | ||
* Whether the connection is in read or read/write mode. | ||
*/ | ||
mode: "write" | "read"; | ||
} | ||
/** | ||
* Base interface to be implemented to fetch each service's member. The user ID is unique for each individual | ||
* user that is connecting to the session. However, one user may have multiple connections from different tabs, | ||
* devices, etc. and the information for each is provided within the connections array. This interface can be | ||
* extended by each service to provide additional service-specific user metadata. | ||
* Base interface to be implemented to fetch each service's member. This interface can be extended by each service | ||
* to provide additional service-specific user metadata. | ||
*/ | ||
export interface IMember { | ||
/** | ||
* An ID for the user, unique among each individual user connecting to the session. | ||
*/ | ||
userId: string; | ||
/** | ||
* The set of connections the user has made, e.g. from multiple tabs or devices. | ||
*/ | ||
connections: IConnection[]; | ||
} | ||
//# sourceMappingURL=types.d.ts.map |
@@ -14,2 +14,32 @@ /*! | ||
* Events emitted from IFluidContainer. | ||
* | ||
* ### "connected" | ||
* | ||
* The connected event is emitted when the `IFluidContainer` completes connecting to the Fluid service. | ||
* | ||
* #### Listener signature | ||
* | ||
* ```typescript | ||
* () => void; | ||
* ``` | ||
* | ||
* ### "dispose" | ||
* | ||
* The dispose event is emitted when the `IFluidContainer` is disposed, which permanently disables it. | ||
* | ||
* #### Listener signature | ||
* | ||
* ```typescript | ||
* () => void; | ||
* ``` | ||
* | ||
* ### "disconnected" | ||
* | ||
* The disconnected event is emitted when the `IFluidContainer` becomes disconnected from the Fluid service. | ||
* | ||
* #### Listener signature | ||
* | ||
* ```typescript | ||
* () => void; | ||
* ``` | ||
*/ | ||
@@ -16,0 +46,0 @@ export interface IFluidContainerEvents extends IEvent { |
@@ -24,6 +24,4 @@ /*! | ||
/** | ||
* The DOProviderContainerRuntimeFactory is the container code for our scenario. | ||
* | ||
* By including the createRequestHandler, we can create any droplet types we include in the registry on-demand. | ||
* These can then be retrieved via container.request("/dataObjectId"). | ||
* The DOProviderContainerRuntimeFactory is container code that provides a single RootDataObject. This data object is | ||
* dynamically customized (registry and initial objects) based on the schema provided to the container runtime factory. | ||
*/ | ||
@@ -30,0 +28,0 @@ export declare class DOProviderContainerRuntimeFactory extends BaseContainerRuntimeFactory { |
@@ -76,6 +76,4 @@ /*! | ||
/** | ||
* The DOProviderContainerRuntimeFactory is the container code for our scenario. | ||
* | ||
* By including the createRequestHandler, we can create any droplet types we include in the registry on-demand. | ||
* These can then be retrieved via container.request("/dataObjectId"). | ||
* The DOProviderContainerRuntimeFactory is container code that provides a single RootDataObject. This data object is | ||
* dynamically customized (registry and initial objects) based on the schema provided to the container runtime factory. | ||
*/ | ||
@@ -82,0 +80,0 @@ export class DOProviderContainerRuntimeFactory extends BaseContainerRuntimeFactory { |
@@ -10,2 +10,8 @@ /*! | ||
import { IServiceAudience, IServiceAudienceEvents, IMember } from "./types"; | ||
/** | ||
* Base class for providing audience information for sessions interacting with FluidContainer | ||
* This can be extended by different service-specific client packages to additional parameters to | ||
* the user and client details returned in IMember | ||
* @typeParam M - A service-specific member type. | ||
*/ | ||
export declare abstract class ServiceAudience<M extends IMember = IMember> extends TypedEventEmitter<IServiceAudienceEvents<M>> implements IServiceAudience<M> { | ||
@@ -12,0 +18,0 @@ protected readonly container: Container; |
@@ -6,5 +6,8 @@ /*! | ||
import { TypedEventEmitter } from "@fluidframework/common-utils"; | ||
// Base class for providing audience information for sessions interacting with FluidContainer | ||
// This can be extended by different service-specific client packages to additional parameters to | ||
// the user and client details returned in IMember | ||
/** | ||
* Base class for providing audience information for sessions interacting with FluidContainer | ||
* This can be extended by different service-specific client packages to additional parameters to | ||
* the user and client details returned in IMember | ||
* @typeParam M - A service-specific member type. | ||
*/ | ||
export class ServiceAudience extends TypedEventEmitter { | ||
@@ -11,0 +14,0 @@ constructor(container) { |
@@ -9,6 +9,14 @@ /*! | ||
import { IFluidDataStoreFactory } from "@fluidframework/runtime-definitions"; | ||
/** | ||
* A mapping of string identifiers to instantiated DataObjects or SharedObjects. | ||
*/ | ||
export declare type LoadableObjectRecord = Record<string, IFluidLoadable>; | ||
/** | ||
* A mapping of string identifiers to classes that will later be used to instantiate a corresponding DataObject | ||
* or SharedObject in a LoadableObjectRecord. | ||
*/ | ||
export declare type LoadableObjectClassRecord = Record<string, LoadableObjectClass<any>>; | ||
/** | ||
* A LoadableObjectClass is an class object of DataObject or SharedObject | ||
* @typeParam T - The class of the DataObject or SharedObject | ||
*/ | ||
@@ -19,2 +27,3 @@ export declare type LoadableObjectClass<T extends IFluidLoadable> = DataObjectClass<T> | SharedObjectClass<T>; | ||
* constructor that will return the type of the DataObject. | ||
* @typeParam T - The class of the DataObject | ||
*/ | ||
@@ -27,2 +36,3 @@ export declare type DataObjectClass<T extends IFluidLoadable> = { | ||
* constructor that will return the type of the DataObject. | ||
* @typeParam T - The class of the SharedObject | ||
*/ | ||
@@ -34,4 +44,10 @@ export declare type SharedObjectClass<T extends IFluidLoadable> = { | ||
* An object with a constructor that will return an `IFluidLoadable`. | ||
* @typeParam T - The class of the loadable object | ||
*/ | ||
export declare type LoadableObjectCtor<T extends IFluidLoadable> = new (...args: any[]) => T; | ||
/** | ||
* The ContainerSchema declares the Fluid objects that will be available in the container. It includes both the | ||
* instances of objects that are initially available upon container creation, as well as the types of objects that may | ||
* be dynamically created throughout the lifetime of the container. | ||
*/ | ||
export interface ContainerSchema { | ||
@@ -68,2 +84,39 @@ /** | ||
* will emit events. | ||
* | ||
* ### "membersChanged" | ||
* | ||
* The membersChanged event is emitted when a member is either added or removed. | ||
* | ||
* #### Listener signature | ||
* | ||
* ```typescript | ||
* () => void; | ||
* ``` | ||
* | ||
* ### "memberAdded" | ||
* | ||
* The memberAdded event is emitted when a member joins the audience. | ||
* | ||
* #### Listener signature | ||
* | ||
* ```typescript | ||
* (clientId: string, member: M) => void; | ||
* ``` | ||
* - `clientId` - A unique identifier for the client | ||
* | ||
* - `member` - The service-specific member object for the client | ||
* | ||
* ### "memberRemoved" | ||
* | ||
* The memberRemoved event is emitted when a member leaves the audience. | ||
* | ||
* #### Listener signature | ||
* | ||
* ```typescript | ||
* (clientId: string, member: M) => void; | ||
* ``` | ||
* - `clientId` - A unique identifier for the client | ||
* | ||
* - `member` - The service-specific member object for the client | ||
* @typeParam M - A service-specific member type. | ||
*/ | ||
@@ -77,3 +130,4 @@ export interface IServiceAudienceEvents<M extends IMember> extends IEvent { | ||
* extend the client object with service-specific details about the connecting client, such as device information, | ||
* environme | ||
* environment, or a username. | ||
* @typeParam M - A service-specific member type. | ||
*/ | ||
@@ -93,20 +147,29 @@ export interface IServiceAudience<M extends IMember> extends IEventProvider<IServiceAudienceEvents<M>> { | ||
/** | ||
* Base interface for information for each connection made to the Fluid session, which will be | ||
* different even if it is by the same user, i.e. the connection's id will be uniquely generated for each time the user | ||
* connects This interface can be extended to provide additional information specific to each service. | ||
* Base interface for information for each connection made to the Fluid session. This interface can be extended | ||
* to provide additional information specific to each service. | ||
*/ | ||
export interface IConnection { | ||
/** | ||
* A unique ID for the connection. A single user may have multiple connections, each with a different ID. | ||
*/ | ||
id: string; | ||
/** | ||
* Whether the connection is in read or read/write mode. | ||
*/ | ||
mode: "write" | "read"; | ||
} | ||
/** | ||
* Base interface to be implemented to fetch each service's member. The user ID is unique for each individual | ||
* user that is connecting to the session. However, one user may have multiple connections from different tabs, | ||
* devices, etc. and the information for each is provided within the connections array. This interface can be | ||
* extended by each service to provide additional service-specific user metadata. | ||
* Base interface to be implemented to fetch each service's member. This interface can be extended by each service | ||
* to provide additional service-specific user metadata. | ||
*/ | ||
export interface IMember { | ||
/** | ||
* An ID for the user, unique among each individual user connecting to the session. | ||
*/ | ||
userId: string; | ||
/** | ||
* The set of connections the user has made, e.g. from multiple tabs or devices. | ||
*/ | ||
connections: IConnection[]; | ||
} | ||
//# sourceMappingURL=types.d.ts.map |
{ | ||
"name": "@fluidframework/fluid-static", | ||
"version": "0.48.3", | ||
"version": "0.49.0-39015", | ||
"description": "A tool to enable consumption of Fluid Data Objects without requiring custom container code.", | ||
@@ -32,17 +32,17 @@ "homepage": "https://fluidframework.com", | ||
"dependencies": { | ||
"@fluidframework/aqueduct": "^0.48.3", | ||
"@fluidframework/aqueduct": "0.49.0-39015", | ||
"@fluidframework/common-definitions": "^0.20.1", | ||
"@fluidframework/common-utils": "^0.32.1", | ||
"@fluidframework/container-definitions": "^0.39.8", | ||
"@fluidframework/container-loader": "^0.48.3", | ||
"@fluidframework/container-runtime-definitions": "^0.48.3", | ||
"@fluidframework/container-loader": "0.49.0-39015", | ||
"@fluidframework/container-runtime-definitions": "0.49.0-39015", | ||
"@fluidframework/core-interfaces": "^0.39.7", | ||
"@fluidframework/datastore-definitions": "^0.48.3", | ||
"@fluidframework/datastore-definitions": "0.49.0-39015", | ||
"@fluidframework/protocol-definitions": "^0.1024.0", | ||
"@fluidframework/request-handler": "^0.48.3", | ||
"@fluidframework/runtime-definitions": "^0.48.3", | ||
"@fluidframework/runtime-utils": "^0.48.3" | ||
"@fluidframework/request-handler": "0.49.0-39015", | ||
"@fluidframework/runtime-definitions": "0.49.0-39015", | ||
"@fluidframework/runtime-utils": "0.49.0-39015" | ||
}, | ||
"devDependencies": { | ||
"@fluid-experimental/get-container": "^0.48.3", | ||
"@fluid-experimental/get-container": "0.49.0-39015", | ||
"@fluidframework/build-common": "^0.23.0", | ||
@@ -49,0 +49,0 @@ "@fluidframework/eslint-config-fluid": "^0.23.0", |
@@ -15,2 +15,32 @@ /*! | ||
* Events emitted from IFluidContainer. | ||
* | ||
* ### "connected" | ||
* | ||
* The connected event is emitted when the `IFluidContainer` completes connecting to the Fluid service. | ||
* | ||
* #### Listener signature | ||
* | ||
* ```typescript | ||
* () => void; | ||
* ``` | ||
* | ||
* ### "dispose" | ||
* | ||
* The dispose event is emitted when the `IFluidContainer` is disposed, which permanently disables it. | ||
* | ||
* #### Listener signature | ||
* | ||
* ```typescript | ||
* () => void; | ||
* ``` | ||
* | ||
* ### "disconnected" | ||
* | ||
* The disconnected event is emitted when the `IFluidContainer` becomes disconnected from the Fluid service. | ||
* | ||
* #### Listener signature | ||
* | ||
* ```typescript | ||
* () => void; | ||
* ``` | ||
*/ | ||
@@ -17,0 +47,0 @@ export interface IFluidContainerEvents extends IEvent { |
@@ -106,7 +106,6 @@ /*! | ||
const rootDataStoreId = "rootDOId"; | ||
/** | ||
* The DOProviderContainerRuntimeFactory is the container code for our scenario. | ||
* | ||
* By including the createRequestHandler, we can create any droplet types we include in the registry on-demand. | ||
* These can then be retrieved via container.request("/dataObjectId"). | ||
* The DOProviderContainerRuntimeFactory is container code that provides a single RootDataObject. This data object is | ||
* dynamically customized (registry and initial objects) based on the schema provided to the container runtime factory. | ||
*/ | ||
@@ -113,0 +112,0 @@ export class DOProviderContainerRuntimeFactory extends BaseContainerRuntimeFactory { |
@@ -12,5 +12,8 @@ /*! | ||
// Base class for providing audience information for sessions interacting with FluidContainer | ||
// This can be extended by different service-specific client packages to additional parameters to | ||
// the user and client details returned in IMember | ||
/** | ||
* Base class for providing audience information for sessions interacting with FluidContainer | ||
* This can be extended by different service-specific client packages to additional parameters to | ||
* the user and client details returned in IMember | ||
* @typeParam M - A service-specific member type. | ||
*/ | ||
export abstract class ServiceAudience<M extends IMember = IMember> | ||
@@ -17,0 +20,0 @@ extends TypedEventEmitter<IServiceAudienceEvents<M>> |
@@ -11,4 +11,11 @@ /*! | ||
/** | ||
* A mapping of string identifiers to instantiated DataObjects or SharedObjects. | ||
*/ | ||
export type LoadableObjectRecord = Record<string, IFluidLoadable>; | ||
/** | ||
* A mapping of string identifiers to classes that will later be used to instantiate a corresponding DataObject | ||
* or SharedObject in a LoadableObjectRecord. | ||
*/ | ||
export type LoadableObjectClassRecord = Record<string, LoadableObjectClass<any>>; | ||
@@ -18,2 +25,3 @@ | ||
* A LoadableObjectClass is an class object of DataObject or SharedObject | ||
* @typeParam T - The class of the DataObject or SharedObject | ||
*/ | ||
@@ -25,5 +33,6 @@ export type LoadableObjectClass<T extends IFluidLoadable> = DataObjectClass<T> | SharedObjectClass<T>; | ||
* constructor that will return the type of the DataObject. | ||
* @typeParam T - The class of the DataObject | ||
*/ | ||
export type DataObjectClass<T extends IFluidLoadable> | ||
= { readonly factory: IFluidDataStoreFactory } & LoadableObjectCtor<T>; | ||
= { readonly factory: IFluidDataStoreFactory } & LoadableObjectCtor<T>; | ||
@@ -33,2 +42,3 @@ /** | ||
* constructor that will return the type of the DataObject. | ||
* @typeParam T - The class of the SharedObject | ||
*/ | ||
@@ -40,5 +50,11 @@ export type SharedObjectClass<T extends IFluidLoadable> | ||
* An object with a constructor that will return an `IFluidLoadable`. | ||
* @typeParam T - The class of the loadable object | ||
*/ | ||
export type LoadableObjectCtor<T extends IFluidLoadable> = new(...args: any[]) => T; | ||
/** | ||
* The ContainerSchema declares the Fluid objects that will be available in the container. It includes both the | ||
* instances of objects that are initially available upon container creation, as well as the types of objects that may | ||
* be dynamically created throughout the lifetime of the container. | ||
*/ | ||
export interface ContainerSchema { | ||
@@ -77,2 +93,39 @@ /** | ||
* will emit events. | ||
* | ||
* ### "membersChanged" | ||
* | ||
* The membersChanged event is emitted when a member is either added or removed. | ||
* | ||
* #### Listener signature | ||
* | ||
* ```typescript | ||
* () => void; | ||
* ``` | ||
* | ||
* ### "memberAdded" | ||
* | ||
* The memberAdded event is emitted when a member joins the audience. | ||
* | ||
* #### Listener signature | ||
* | ||
* ```typescript | ||
* (clientId: string, member: M) => void; | ||
* ``` | ||
* - `clientId` - A unique identifier for the client | ||
* | ||
* - `member` - The service-specific member object for the client | ||
* | ||
* ### "memberRemoved" | ||
* | ||
* The memberRemoved event is emitted when a member leaves the audience. | ||
* | ||
* #### Listener signature | ||
* | ||
* ```typescript | ||
* (clientId: string, member: M) => void; | ||
* ``` | ||
* - `clientId` - A unique identifier for the client | ||
* | ||
* - `member` - The service-specific member object for the client | ||
* @typeParam M - A service-specific member type. | ||
*/ | ||
@@ -87,3 +140,4 @@ export interface IServiceAudienceEvents<M extends IMember> extends IEvent { | ||
* extend the client object with service-specific details about the connecting client, such as device information, | ||
* environme | ||
* environment, or a username. | ||
* @typeParam M - A service-specific member type. | ||
*/ | ||
@@ -105,8 +159,14 @@ export interface IServiceAudience<M extends IMember> extends IEventProvider<IServiceAudienceEvents<M>> { | ||
/** | ||
* Base interface for information for each connection made to the Fluid session, which will be | ||
* different even if it is by the same user, i.e. the connection's id will be uniquely generated for each time the user | ||
* connects This interface can be extended to provide additional information specific to each service. | ||
* Base interface for information for each connection made to the Fluid session. This interface can be extended | ||
* to provide additional information specific to each service. | ||
*/ | ||
export interface IConnection { | ||
/** | ||
* A unique ID for the connection. A single user may have multiple connections, each with a different ID. | ||
*/ | ||
id: string; | ||
/** | ||
* Whether the connection is in read or read/write mode. | ||
*/ | ||
mode: "write" | "read"; | ||
@@ -116,10 +176,15 @@ } | ||
/** | ||
* Base interface to be implemented to fetch each service's member. The user ID is unique for each individual | ||
* user that is connecting to the session. However, one user may have multiple connections from different tabs, | ||
* devices, etc. and the information for each is provided within the connections array. This interface can be | ||
* extended by each service to provide additional service-specific user metadata. | ||
* Base interface to be implemented to fetch each service's member. This interface can be extended by each service | ||
* to provide additional service-specific user metadata. | ||
*/ | ||
export interface IMember { | ||
/** | ||
* An ID for the user, unique among each individual user connecting to the session. | ||
*/ | ||
userId: string; | ||
/** | ||
* The set of connections the user has made, e.g. from multiple tabs or devices. | ||
*/ | ||
connections: IConnection[]; | ||
} |
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
179043
2127
+ Added@fluidframework/aqueduct@0.49.0-39015(transitive)
+ Added@fluidframework/container-loader@0.49.0-39015(transitive)
+ Added@fluidframework/container-runtime@0.49.0-39015(transitive)
+ Added@fluidframework/container-runtime-definitions@0.49.0-39015(transitive)
+ Added@fluidframework/container-utils@0.49.0-39015(transitive)
+ Added@fluidframework/datastore@0.49.0-39015(transitive)
+ Added@fluidframework/datastore-definitions@0.49.0-39015(transitive)
+ Added@fluidframework/driver-utils@0.49.0-39015(transitive)
+ Added@fluidframework/garbage-collector@0.49.0-39015(transitive)
+ Added@fluidframework/map@0.49.0-39015(transitive)
+ Added@fluidframework/request-handler@0.49.0-39015(transitive)
+ Added@fluidframework/runtime-definitions@0.49.0-39015(transitive)
+ Added@fluidframework/runtime-utils@0.49.0-39015(transitive)
+ Added@fluidframework/shared-object-base@0.49.0-39015(transitive)
+ Added@fluidframework/synthesize@0.49.0-39015(transitive)
+ Added@fluidframework/telemetry-utils@0.49.0-39015(transitive)
+ Added@fluidframework/view-interfaces@0.49.0-39015(transitive)
+ Addedaxios@0.21.4(transitive)
+ Addedfollow-redirects@1.15.9(transitive)
- Removed@fluidframework/aqueduct@0.48.5(transitive)
- Removed@fluidframework/container-loader@0.48.5(transitive)
- Removed@fluidframework/container-runtime@0.48.5(transitive)
- Removed@fluidframework/container-runtime-definitions@0.48.5(transitive)
- Removed@fluidframework/container-utils@0.48.5(transitive)
- Removed@fluidframework/datastore@0.48.5(transitive)
- Removed@fluidframework/datastore-definitions@0.48.5(transitive)
- Removed@fluidframework/driver-utils@0.48.5(transitive)
- Removed@fluidframework/garbage-collector@0.48.5(transitive)
- Removed@fluidframework/map@0.48.5(transitive)
- Removed@fluidframework/request-handler@0.48.5(transitive)
- Removed@fluidframework/runtime-definitions@0.48.5(transitive)
- Removed@fluidframework/runtime-utils@0.48.5(transitive)
- Removed@fluidframework/shared-object-base@0.48.5(transitive)
- Removed@fluidframework/synthesize@0.48.5(transitive)
- Removed@fluidframework/telemetry-utils@0.48.5(transitive)
- Removed@fluidframework/view-interfaces@0.48.5(transitive)
Updated@fluidframework/container-runtime-definitions@0.49.0-39015