@fluidframework/azure-client 2.0.0-dev-rc.3.0.0.254274 → 2.0.0-dev-rc.3.0.0.254674

package/dist/azure-client-beta.d.ts

@@ -1,254 +0,0 @@
-/**
- * A simple and powerful way to consume collaborative Fluid data with the Azure Fluid Relay.
- *
- * @packageDocumentation
- */
-
-import { ContainerSchema } from '@fluidframework/fluid-static';
-import { ICompressionStorageConfig } from '@fluidframework/driver-utils';
-import { IConfigProviderBase } from '@fluidframework/core-interfaces';
-import { IFluidContainer } from '@fluidframework/fluid-static';
-import { IMember } from '@fluidframework/fluid-static';
-import { IServiceAudience } from '@fluidframework/fluid-static';
-import { ITelemetryBaseEvent } from '@fluidframework/core-interfaces';
-import { ITelemetryBaseLogger } from '@fluidframework/core-interfaces';
-import { ITokenClaims } from '@fluidframework/protocol-definitions';
-import { ITokenProvider } from '@fluidframework/routerlicious-driver';
-import { ITokenResponse } from '@fluidframework/routerlicious-driver';
-import { IUser } from '@fluidframework/protocol-definitions';
-import { ScopeType } from '@fluidframework/protocol-definitions';
-
-/**
- * AzureClient provides the ability to have a Fluid object backed by the Azure Fluid Relay or,
- * when running with local tenantId, have it be backed by a local Azure Fluid Relay instance.
- * @public
- */
-export declare class AzureClient {
-    private readonly properties;
-    private readonly documentServiceFactory;
-    private readonly urlResolver;
-    private readonly configProvider;
-    /**
-     * Creates a new client instance using configuration parameters.
-     * @param properties - Properties for initializing a new AzureClient instance
-     */
-    constructor(properties: AzureClientProps);
-    /**
-     * Creates a new detached container instance in the Azure Fluid Relay.
-     * @typeparam TContainerSchema - Used to infer the the type of 'initialObjects' in the returned container.
-     * (normally not explicitly specified.)
-     * @param containerSchema - Container schema for the new container.
-     * @returns New detached container instance along with associated services.
-     */
-    createContainer<const TContainerSchema extends ContainerSchema>(containerSchema: TContainerSchema): Promise<{
-        container: IFluidContainer<TContainerSchema>;
-        services: AzureContainerServices;
-    }>;
-    /**
-     * Creates new detached container out of specific version of another container.
-     * @typeparam TContainerSchema - Used to infer the the type of 'initialObjects' in the returned container.
-     * (normally not explicitly specified.)
-     * @param id - Unique ID of the source container in Azure Fluid Relay.
-     * @param containerSchema - Container schema used to access data objects in the container.
-     * @param version - Unique version of the source container in Azure Fluid Relay.
-     * It defaults to latest version if parameter not provided.
-     * @returns New detached container instance along with associated services.
-     */
-    copyContainer<TContainerSchema extends ContainerSchema>(id: string, containerSchema: TContainerSchema, version?: AzureContainerVersion): Promise<{
-        container: IFluidContainer<TContainerSchema>;
-        services: AzureContainerServices;
-    }>;
-    /**
-     * Accesses the existing container given its unique ID in the Azure Fluid Relay.
-     * @typeparam TContainerSchema - Used to infer the the type of 'initialObjects' in the returned container.
-     * (normally not explicitly specified.)
-     * @param id - Unique ID of the container in Azure Fluid Relay.
-     * @param containerSchema - Container schema used to access data objects in the container.
-     * @returns Existing container instance along with associated services.
-     */
-    getContainer<TContainerSchema extends ContainerSchema>(id: string, containerSchema: TContainerSchema): Promise<{
-        container: IFluidContainer<TContainerSchema>;
-        services: AzureContainerServices;
-    }>;
-    /**
-     * Get the list of versions for specific container.
-     * @param id - Unique ID of the source container in Azure Fluid Relay.
-     * @param options - "Get" options. If options are not provided, API
-     * will assume maxCount of versions to retrieve to be 5.
-     * @returns Array of available container versions.
-     */
-    getContainerVersions(id: string, options?: AzureGetVersionsOptions): Promise<AzureContainerVersion[]>;
-    private getContainerServices;
-    private createLoader;
-    private createFluidContainer;
-    private getContainerEntryPoint;
-}
-
-/**
- * Props for initializing a new AzureClient instance
- * @public
- */
-export declare interface AzureClientProps {
-    /**
-     * Configuration for establishing a connection with the Azure Fluid Relay.
-     */
-    readonly connection: AzureRemoteConnectionConfig | AzureLocalConnectionConfig;
-    /**
-     * Optional. A logger instance to receive diagnostic messages.
-     */
-    readonly logger?: ITelemetryBaseLogger;
-    /**
-     * Base interface for providing configurations to control experimental features. If unsure, leave this undefined.
-     */
-    readonly configProvider?: IConfigProviderBase;
-    readonly summaryCompression?: boolean | ICompressionStorageConfig;
-}
-
-/**
- * Parameters for establishing a connection with the Azure Fluid Relay.
- * @public
- */
-export declare interface AzureConnectionConfig {
-    /**
-     * The type of connection. Whether we're connecting to a remote Fluid relay server or a local instance.
-     */
-    type: AzureConnectionConfigType;
-    /**
-     * URI to the Azure Fluid Relay service discovery endpoint.
-     */
-    endpoint: string;
-    /**
-     * Instance that provides Azure Fluid Relay endpoint tokens.
-     */
-    tokenProvider: ITokenProvider;
-}
-
-/**
- * The type of connection.
- *
- * - "local" for local connections to a Fluid relay instance running on the localhost
- *
- * - "remote" for client connections to the Azure Fluid Relay service
- * @public
- */
-export declare type AzureConnectionConfigType = "local" | "remote";
-
-/**
- * Holds the functionality specifically tied to the Azure Fluid Relay, and how the data stored in
- * the FluidContainer is persisted in the backend and consumed by users.
- *
- * @remarks
- *
- * Returned by the {@link AzureClient} alongside a {@link @fluidframework/fluid-static#FluidContainer}.
- *
- * Any functionality regarding how the data is handled within the FluidContainer itself, i.e. which data objects
- * or DDSes to use, will not be included here but rather on the FluidContainer class itself.
- * @public
- */
-export declare interface AzureContainerServices {
-    /**
-     * Provides an object that can be used to get the users that are present in this Fluid session and
-     * listeners for when the roster has any changes from users joining/leaving the session
-     */
-    audience: IAzureAudience;
-}
-
-/**
- * Container version metadata.
- * @public
- */
-export declare interface AzureContainerVersion {
-    /**
-     * Version ID
-     */
-    id: string;
-    /**
-     * Time when version was generated.
-     * ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ
-     */
-    date?: string;
-}
-
-/* Excluded from this release type: AzureFunctionTokenProvider */
-
-/**
- * Options for "Get Container Versions" API.
- * @public
- */
-export declare interface AzureGetVersionsOptions {
-    /**
-     * Max number of versions
-     */
-    maxCount: number;
-}
-
-/**
- * Parameters for establishing a local connection with a local instance of the Azure Fluid Relay.
- * @public
- */
-export declare interface AzureLocalConnectionConfig extends AzureConnectionConfig {
-    /**
-     * The type of connection. Set to a remote connection.
-     */
-    type: "local";
-}
-
-/**
- * Since Azure provides user names for all of its members, we extend the
- * {@link @fluidframework/fluid-static#IMember} interface to include this service-specific value.
- * It will be returned for all audience members connected to Azure.
- *
- * @typeParam T - See {@link AzureMember.additionalDetails}.
- * Note: must be JSON-serializable.
- * Passing a non-serializable object (e.g. a `class`) will result in undefined behavior.
- * @public
- */
-export declare interface AzureMember<T = any> extends IMember {
-    /**
-     * {@inheritDoc AzureUser.name}
-     */
-    userName: string;
-    /**
-     * {@inheritDoc AzureUser.additionalDetails}
-     */
-    additionalDetails?: T;
-}
-
-/**
- * Parameters for establishing a remote connection with the Azure Fluid Relay.
- * @public
- */
-export declare interface AzureRemoteConnectionConfig extends AzureConnectionConfig {
-    /**
-     * The type of connection. Set to a remote connection.
-     */
-    type: "remote";
-    /**
-     * Unique tenant identifier.
-     */
-    tenantId: string;
-}
-
-/* Excluded from this release type: AzureUser */
-
-/**
- * Audience object for Azure Fluid Relay containers
- * @public
- */
-export declare type IAzureAudience = IServiceAudience<AzureMember>;
-
-export { ITelemetryBaseEvent }
-
-export { ITelemetryBaseLogger }
-
-export { ITokenClaims }
-
-export { ITokenProvider }
-
-export { ITokenResponse }
-
-export { IUser }
-
-export { ScopeType }
-
-export { }

package/dist/azure-client-public.d.ts

@@ -1,254 +0,0 @@
-/**
- * A simple and powerful way to consume collaborative Fluid data with the Azure Fluid Relay.
- *
- * @packageDocumentation
- */
-
-import { ContainerSchema } from '@fluidframework/fluid-static';
-import { ICompressionStorageConfig } from '@fluidframework/driver-utils';
-import { IConfigProviderBase } from '@fluidframework/core-interfaces';
-import { IFluidContainer } from '@fluidframework/fluid-static';
-import { IMember } from '@fluidframework/fluid-static';
-import { IServiceAudience } from '@fluidframework/fluid-static';
-import { ITelemetryBaseEvent } from '@fluidframework/core-interfaces';
-import { ITelemetryBaseLogger } from '@fluidframework/core-interfaces';
-import { ITokenClaims } from '@fluidframework/protocol-definitions';
-import { ITokenProvider } from '@fluidframework/routerlicious-driver';
-import { ITokenResponse } from '@fluidframework/routerlicious-driver';
-import { IUser } from '@fluidframework/protocol-definitions';
-import { ScopeType } from '@fluidframework/protocol-definitions';
-
-/**
- * AzureClient provides the ability to have a Fluid object backed by the Azure Fluid Relay or,
- * when running with local tenantId, have it be backed by a local Azure Fluid Relay instance.
- * @public
- */
-export declare class AzureClient {
-    private readonly properties;
-    private readonly documentServiceFactory;
-    private readonly urlResolver;
-    private readonly configProvider;
-    /**
-     * Creates a new client instance using configuration parameters.
-     * @param properties - Properties for initializing a new AzureClient instance
-     */
-    constructor(properties: AzureClientProps);
-    /**
-     * Creates a new detached container instance in the Azure Fluid Relay.
-     * @typeparam TContainerSchema - Used to infer the the type of 'initialObjects' in the returned container.
-     * (normally not explicitly specified.)
-     * @param containerSchema - Container schema for the new container.
-     * @returns New detached container instance along with associated services.
-     */
-    createContainer<const TContainerSchema extends ContainerSchema>(containerSchema: TContainerSchema): Promise<{
-        container: IFluidContainer<TContainerSchema>;
-        services: AzureContainerServices;
-    }>;
-    /**
-     * Creates new detached container out of specific version of another container.
-     * @typeparam TContainerSchema - Used to infer the the type of 'initialObjects' in the returned container.
-     * (normally not explicitly specified.)
-     * @param id - Unique ID of the source container in Azure Fluid Relay.
-     * @param containerSchema - Container schema used to access data objects in the container.
-     * @param version - Unique version of the source container in Azure Fluid Relay.
-     * It defaults to latest version if parameter not provided.
-     * @returns New detached container instance along with associated services.
-     */
-    copyContainer<TContainerSchema extends ContainerSchema>(id: string, containerSchema: TContainerSchema, version?: AzureContainerVersion): Promise<{
-        container: IFluidContainer<TContainerSchema>;
-        services: AzureContainerServices;
-    }>;
-    /**
-     * Accesses the existing container given its unique ID in the Azure Fluid Relay.
-     * @typeparam TContainerSchema - Used to infer the the type of 'initialObjects' in the returned container.
-     * (normally not explicitly specified.)
-     * @param id - Unique ID of the container in Azure Fluid Relay.
-     * @param containerSchema - Container schema used to access data objects in the container.
-     * @returns Existing container instance along with associated services.
-     */
-    getContainer<TContainerSchema extends ContainerSchema>(id: string, containerSchema: TContainerSchema): Promise<{
-        container: IFluidContainer<TContainerSchema>;
-        services: AzureContainerServices;
-    }>;
-    /**
-     * Get the list of versions for specific container.
-     * @param id - Unique ID of the source container in Azure Fluid Relay.
-     * @param options - "Get" options. If options are not provided, API
-     * will assume maxCount of versions to retrieve to be 5.
-     * @returns Array of available container versions.
-     */
-    getContainerVersions(id: string, options?: AzureGetVersionsOptions): Promise<AzureContainerVersion[]>;
-    private getContainerServices;
-    private createLoader;
-    private createFluidContainer;
-    private getContainerEntryPoint;
-}
-
-/**
- * Props for initializing a new AzureClient instance
- * @public
- */
-export declare interface AzureClientProps {
-    /**
-     * Configuration for establishing a connection with the Azure Fluid Relay.
-     */
-    readonly connection: AzureRemoteConnectionConfig | AzureLocalConnectionConfig;
-    /**
-     * Optional. A logger instance to receive diagnostic messages.
-     */
-    readonly logger?: ITelemetryBaseLogger;
-    /**
-     * Base interface for providing configurations to control experimental features. If unsure, leave this undefined.
-     */
-    readonly configProvider?: IConfigProviderBase;
-    readonly summaryCompression?: boolean | ICompressionStorageConfig;
-}
-
-/**
- * Parameters for establishing a connection with the Azure Fluid Relay.
- * @public
- */
-export declare interface AzureConnectionConfig {
-    /**
-     * The type of connection. Whether we're connecting to a remote Fluid relay server or a local instance.
-     */
-    type: AzureConnectionConfigType;
-    /**
-     * URI to the Azure Fluid Relay service discovery endpoint.
-     */
-    endpoint: string;
-    /**
-     * Instance that provides Azure Fluid Relay endpoint tokens.
-     */
-    tokenProvider: ITokenProvider;
-}
-
-/**
- * The type of connection.
- *
- * - "local" for local connections to a Fluid relay instance running on the localhost
- *
- * - "remote" for client connections to the Azure Fluid Relay service
- * @public
- */
-export declare type AzureConnectionConfigType = "local" | "remote";
-
-/**
- * Holds the functionality specifically tied to the Azure Fluid Relay, and how the data stored in
- * the FluidContainer is persisted in the backend and consumed by users.
- *
- * @remarks
- *
- * Returned by the {@link AzureClient} alongside a {@link @fluidframework/fluid-static#FluidContainer}.
- *
- * Any functionality regarding how the data is handled within the FluidContainer itself, i.e. which data objects
- * or DDSes to use, will not be included here but rather on the FluidContainer class itself.
- * @public
- */
-export declare interface AzureContainerServices {
-    /**
-     * Provides an object that can be used to get the users that are present in this Fluid session and
-     * listeners for when the roster has any changes from users joining/leaving the session
-     */
-    audience: IAzureAudience;
-}
-
-/**
- * Container version metadata.
- * @public
- */
-export declare interface AzureContainerVersion {
-    /**
-     * Version ID
-     */
-    id: string;
-    /**
-     * Time when version was generated.
-     * ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ
-     */
-    date?: string;
-}
-
-/* Excluded from this release type: AzureFunctionTokenProvider */
-
-/**
- * Options for "Get Container Versions" API.
- * @public
- */
-export declare interface AzureGetVersionsOptions {
-    /**
-     * Max number of versions
-     */
-    maxCount: number;
-}
-
-/**
- * Parameters for establishing a local connection with a local instance of the Azure Fluid Relay.
- * @public
- */
-export declare interface AzureLocalConnectionConfig extends AzureConnectionConfig {
-    /**
-     * The type of connection. Set to a remote connection.
-     */
-    type: "local";
-}
-
-/**
- * Since Azure provides user names for all of its members, we extend the
- * {@link @fluidframework/fluid-static#IMember} interface to include this service-specific value.
- * It will be returned for all audience members connected to Azure.
- *
- * @typeParam T - See {@link AzureMember.additionalDetails}.
- * Note: must be JSON-serializable.
- * Passing a non-serializable object (e.g. a `class`) will result in undefined behavior.
- * @public
- */
-export declare interface AzureMember<T = any> extends IMember {
-    /**
-     * {@inheritDoc AzureUser.name}
-     */
-    userName: string;
-    /**
-     * {@inheritDoc AzureUser.additionalDetails}
-     */
-    additionalDetails?: T;
-}
-
-/**
- * Parameters for establishing a remote connection with the Azure Fluid Relay.
- * @public
- */
-export declare interface AzureRemoteConnectionConfig extends AzureConnectionConfig {
-    /**
-     * The type of connection. Set to a remote connection.
-     */
-    type: "remote";
-    /**
-     * Unique tenant identifier.
-     */
-    tenantId: string;
-}
-
-/* Excluded from this release type: AzureUser */
-
-/**
- * Audience object for Azure Fluid Relay containers
- * @public
- */
-export declare type IAzureAudience = IServiceAudience<AzureMember>;
-
-export { ITelemetryBaseEvent }
-
-export { ITelemetryBaseLogger }
-
-export { ITokenClaims }
-
-export { ITokenProvider }
-
-export { ITokenResponse }
-
-export { IUser }
-
-export { ScopeType }
-
-export { }