/*!
 * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
 * Licensed under the MIT License.
 */
/**
 * @legacy
 * @beta
 */
export interface ISnapshotOptions {
    blobs?: number;
    deltas?: number;
    channels?: number;
    /**
     * Maximum Data size (in bytes)
     *
     * @remarks
     * If specified, SPO will fail snapshot request with 413 error (see {@link @fluidframework/odsp-driver-definitions#(OdspErrorTypes:variable).snapshotTooBig})
     * if snapshot is bigger in size than specified limit.
     */
    mds?: number;
    timeout?: number;
}
/**
 * @legacy
 * @beta
 */
export interface IOpsCachingPolicy {
    /**
     * Batch size. Controls how many ops are grouped together as single cache entry
     * The bigger the number, the more efficient it is (less reads & writes)
     * At the same time, big number means we wait for so many ops to accumulate, which
     * increases chances and number of trailing ops that would not be flushed to cache
     * when user closes tab
     * Use any number below 1 to disable caching
     * Default: 100
     */
    batchSize?: number;
    /**
     * To reduce the problem of losing trailing ops when using big batch sizes, host
     * could specify how often driver should flush ops it has not flushed yet.
     * -1 means do not use timer.
     * Measured in ms.
     * Default: 5000
     */
    timerGranularity?: number;
    /**
     * Total number of ops to cache. When we reach that number, ops caching stops
     * Default: 5000
     */
    totalOpsToCache?: number;
}
/**
 * @legacy
 * @beta
 */
export interface ICollabSessionOptions {
    /**
     * Value indicating the display name for session that admits unauthenticated user.
     * This name will be used in attribution associated with edits made by such user.
     * @deprecated starting in 2.0-RC3. No longer needed.
     */
    unauthenticatedUserDisplayName?: string;
    /**
     * Value indicating session preference to always pass access token via Authorization header.
     * Default behavior is to pass access token via query parameter unless overall href string
     * length exceeds 2048 characters. Using query param is performance optimization which results
     * in ODSP XHR request being treated as 'simple' request which do not require OPTIONS call to
     * validate CORS. However, not all ODSP implementations understand this optimization.
     * For instance, auth layer on Converged stack will fail request with access token passed via
     * query param.
     * @deprecated Due to security reasons we will be passing the token via Authorization header only.
     */
    forceAccessTokenViaAuthorizationHeader?: boolean;
    /**
     * Value indicating the client display name for current session.
     * This name will be used in attribution associated with edits made during session.
     * This is optional and used only when collab session is being joined by client acting in app-only mode (i.e. without user context).
     * If not specified client display name is extracted from the access token that is used to join session.
     */
    displayName?: string;
}
/**
 * @legacy
 * @beta
 */
export interface HostStoragePolicy {
    snapshotOptions?: ISnapshotOptions;
    /**
     * If set to true, tells driver to concurrently fetch snapshot from storage (SPO) and cache
     * Container loads from whatever comes first in such case.
     * Snapshot fetched from storage is pushed to cache in either case.
     * If set to false, driver will first consult with cache. Only on cache miss (cache does not
     * return snapshot), driver will fetch snapshot from storage (and push it to cache), otherwise
     * it will load from cache and not reach out to storage.
     * Passing true results in faster loads and keeping cache more current, but it increases bandwidth consumption.
     */
    concurrentSnapshotFetch?: boolean;
    opsBatchSize?: number;
    concurrentOpsBatches?: number;
    /**
     * Policy controlling ops caching (leveraging IPersistedCache passed to driver factory)
     */
    opsCaching?: IOpsCachingPolicy;
    /**
     * Policy controlling how collaboration session is established
     */
    sessionOptions?: ICollabSessionOptions;
    /**
     * @deprecated This field will be always set to true after removal.
     * True to have the sharing link redeem fallback in case the Trees Latest/Redeem 1RT call fails with redeem error.
     * During fallback it will first redeem the sharing link and then make the Trees latest call.
     */
    enableRedeemFallback?: boolean;
    /**
     * Policy controlling if we will cache initial summary when we create a document
     */
    cacheCreateNewSummary?: boolean;
    /**
     * @deprecated This will be replaced with feature gate snapshotFormatFetchType.
     * Policy controlling if we want to fetch binary format snapshot.
     */
    fetchBinarySnapshotFormat?: boolean;
    /**
     * If set to true, socket cache are per OdspDocumentService instead of shared across all instances
     */
    isolateSocketCache?: boolean;
    /**
     * @deprecated Switch to using the new feature gated by enableSingleRequestForShareLinkWithCreate
     * with 'createLinkScope' and 'createLinkRole' is requested to the odsp apis instead of 'createLinkType'.
     * It enables the creation of sharing link along with the creation of file by setting this value to true.
     * If the host provides a 'createLinkType' parameter in the request URL to the container.attach()
     * method, we will send the request to ODSP with the same (if the flag is enabled) so
     * that a share link can be created with the creation of file to save number for round trips made to ODSP.
     * (This flag works independently of enableSingleRequestForShareLinkWithCreate which is used for sharing link
     * requests where 'createLinkScope' is requested.)
     */
    enableShareLinkWithCreate?: boolean;
    /**
     * Enable creation of sharing link along with the creation of file by setting this value to true.
     * If the host provides a 'createLinkScope' parameter in the request URL to the container.attach()
     * method, we will send the request to ODSP with the same (if the flag is enabled) so
     * that a share link can be created with the creation of file to save number for round trips made to ODSP.
     * (This flag works independently of enableShareLinkWithCreate which was used for old sharing link requests
     * where 'createLinkType' was requested.)
     */
    enableSingleRequestForShareLinkWithCreate?: boolean;
    /**
     * True if host does not want the storage service to use the prefetch cache to get the snapshot. Undefined will be treated
     * as false. This is if the host wants to do some A/B testing.
     */
    avoidPrefetchSnapshotCache?: boolean;
}
//# sourceMappingURL=factory.d.ts.map