@fluidframework/file-driver 2.0.0-dev.7.4.0.215930 → 2.0.0-dev.7.4.0.217212

package/api-extractor-lint.json

@@ -0,0 +1,13 @@
+{
+	"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
+	"extends": "../../../common/build/build-common/api-extractor-lint.json",
+	"messages": {
+		"extractorMessageReporting": {
+			// TODO: remove once base config has this enabled as an error
+			"ae-incompatible-release-tags": {
+				"logLevel": "error",
+				"addToApiReportFile": false
+			}
+		}
+	}
+}

package/api-extractor.json

@@ -6,10 +6,6 @@
 	},
 	"messages": {
 		"extractorMessageReporting": {
-			// TODO: Fix violations and remove this rule override
-			"ae-missing-release-tag": {
-				"logLevel": "none"
-			},
 			// TODO: Add missing documentation and remove this rule override
 			"ae-undocumented": {
 				"logLevel": "none"

package/api-report/file-driver.api.md

@@ -30,7 +30,7 @@ import { ITokenClaims } from '@fluidframework/protocol-definitions';
 import { ReadDocumentStorageServiceBase } from '@fluidframework/replay-driver';
 import { TypedEventEmitter } from '@fluid-internal/client-utils';
 
-// @public
+// @internal
 export class FileDeltaStorageService implements IDocumentDeltaStorageService {
     constructor(path: string);
     // (undocumented)
@@ -40,7 +40,7 @@ export class FileDeltaStorageService implements IDocumentDeltaStorageService {
     get ops(): readonly Readonly<api.ISequencedDocumentMessage>[];
 }
 
-// @public
+// @internal
 export class FileDocumentServiceFactory implements IDocumentServiceFactory {
     constructor(storage: IDocumentStorageService, deltaStorage: FileDeltaStorageService, deltaConnection: IDocumentDeltaConnection);
     // (undocumented)
@@ -48,7 +48,7 @@ export class FileDocumentServiceFactory implements IDocumentServiceFactory {
     createDocumentService(resolvedUrl: IResolvedUrl, logger?: ITelemetryBaseLogger, clientIsSummarizer?: boolean): Promise<IDocumentService>;
 }
 
-// @public (undocumented)
+// @internal (undocumented)
 export const FileSnapshotWriterClassFactory: <TBase extends ReaderConstructor>(Base: TBase) => {
     new (...args: any[]): {
         blobsWriter: Map<string, ArrayBufferLike>;
@@ -70,10 +70,10 @@ export const FileSnapshotWriterClassFactory: <TBase extends ReaderConstructor>(B
     };
 } & TBase;
 
-// @public (undocumented)
+// @internal (undocumented)
 export const FileStorageDocumentName = "FileStorageDocId";
 
-// @public
+// @internal
 export class FluidFetchReader extends ReadDocumentStorageServiceBase implements IDocumentStorageService {
     constructor(path: string, versionName?: string | undefined);
     // (undocumented)
@@ -84,7 +84,7 @@ export class FluidFetchReader extends ReadDocumentStorageServiceBase implements
     readBlob(sha: string): Promise<ArrayBufferLike>;
 }
 
-// @public (undocumented)
+// @internal (undocumented)
 export const FluidFetchReaderFileSnapshotWriter: {
     new (...args: any[]): {
         blobsWriter: Map<string, ArrayBufferLike>;
@@ -106,7 +106,7 @@ export const FluidFetchReaderFileSnapshotWriter: {
     };
 } & typeof FluidFetchReader;
 
-// @public (undocumented)
+// @internal (undocumented)
 export interface ISnapshotWriterStorage extends IDocumentStorageService {
     // (undocumented)
     onSnapshotHandler(snapshot: IFileSnapshot): void;
@@ -114,10 +114,10 @@ export interface ISnapshotWriterStorage extends IDocumentStorageService {
     reset(): void;
 }
 
-// @public (undocumented)
+// @internal (undocumented)
 export type ReaderConstructor = new (...args: any[]) => IDocumentStorageService;
 
-// @public
+// @internal
 export class Replayer {
     constructor(deltaConnection: ReplayFileDeltaConnection, documentStorageService: FileDeltaStorageService);
     // (undocumented)
@@ -128,7 +128,7 @@ export class Replayer {
     replay(replayTo: number): number;
 }
 
-// @public (undocumented)
+// @internal (undocumented)
 export class ReplayFileDeltaConnection extends TypedEventEmitter<IDocumentDeltaConnectionEvents> implements IDocumentDeltaConnection, IDisposable {
     constructor(details: IConnected, documentDeltaStorageService: FileDeltaStorageService);
     // (undocumented)

package/dist/file-driver-alpha.d.ts

@@ -11,7 +11,6 @@ import { IDocumentService } from '@fluidframework/driver-definitions';
 import { IDocumentServiceFactory } from '@fluidframework/driver-definitions';
 import { IDocumentStorageService } from '@fluidframework/driver-definitions';
 import { IDocumentStorageServicePolicies } from '@fluidframework/driver-definitions';
-import { IFileSnapshot } from '@fluidframework/replay-driver';
 import { IResolvedUrl } from '@fluidframework/driver-definitions';
 import { ISequencedDocumentMessage } from '@fluidframework/protocol-definitions';
 import { ISignalClient } from '@fluidframework/protocol-definitions';
@@ -21,167 +20,30 @@ import { ISummaryContext } from '@fluidframework/driver-definitions';
 import { ISummaryTree } from '@fluidframework/protocol-definitions';
 import { ITelemetryBaseLogger } from '@fluidframework/core-interfaces';
 import { ITokenClaims } from '@fluidframework/protocol-definitions';
-import { ReadDocumentStorageServiceBase } from '@fluidframework/replay-driver';
 
-/**
- * Provides access to the underlying delta storage on the local file storage for file driver.
- */
-export declare class FileDeltaStorageService implements IDocumentDeltaStorageService {
-    private readonly path;
-    private readonly messages;
-    private lastOps;
-    constructor(path: string);
-    fetchMessages(from: number, to: number | undefined, abortSignal?: AbortSignal, cachedOnly?: boolean): IStream<api.ISequencedDocumentMessage[]>;
-    get ops(): readonly Readonly<api.ISequencedDocumentMessage>[];
-    /**
-     * Retrieve ops within the exclusive sequence number range.
-     *
-     * @param from - First op to be fetched.
-     * @param to - Last op to be fetched. This is exclusive.
-     */
-    getFromWebSocket(from: number, to: number): api.ISequencedDocumentMessage[];
-}
+/* Excluded from this release type: FileDeltaStorageService */
 
-/**
- * Factory for creating the file document service. Use this if you want to
- * use the local file storage as underlying storage.
- */
-export declare class FileDocumentServiceFactory implements IDocumentServiceFactory {
-    private readonly storage;
-    private readonly deltaStorage;
-    private readonly deltaConnection;
-    constructor(storage: IDocumentStorageService, deltaStorage: FileDeltaStorageService, deltaConnection: IDocumentDeltaConnection);
-    /**
-     * Creates the file document service if the path exists.
-     *
-     * @param fileURL - Path of directory containing ops/snapshots.
-     * @returns file document service.
-     */
-    createDocumentService(resolvedUrl: IResolvedUrl, logger?: ITelemetryBaseLogger, clientIsSummarizer?: boolean): Promise<IDocumentService>;
-    createContainer(createNewSummary: ISummaryTree, resolvedUrl: IResolvedUrl, logger?: ITelemetryBaseLogger, clientIsSummarizer?: boolean): Promise<IDocumentService>;
-}
+/* Excluded from this release type: FileDocumentServiceFactory */
 
-export declare const FileSnapshotWriterClassFactory: <TBase extends ReaderConstructor>(Base: TBase) => {
-    new (...args: any[]): {
-        blobsWriter: Map<string, ArrayBufferLike>;
-        latestWriterTree?: api.ISnapshotTree | undefined;
-        docId?: string | undefined;
-        reset(): void;
-        onSnapshotHandler(snapshot: IFileSnapshot): void;
-        readBlob(sha: string): Promise<ArrayBufferLike>;
-        getVersions(versionId: string | null, count: number): Promise<api.IVersion[]>;
-        getSnapshotTree(version?: api.IVersion): Promise<api.ISnapshotTree | null>;
-        uploadSummaryWithContext(summary: api.ISummaryTree, context: ISummaryContext): Promise<string>;
-        buildTree(snapshotTree: api.ISnapshotTree): Promise<api.ITree>;
-        repositoryUrl: string;
-        readonly policies?: IDocumentStorageServicePolicies | undefined;
-        createBlob(file: ArrayBufferLike): Promise<api.ICreateBlobResponse>;
-        downloadSummary(handle: api.ISummaryHandle): Promise<api.ISummaryTree>;
-        readonly disposed?: boolean | undefined;
-        dispose?: ((error?: Error | undefined) => void) | undefined;
-    };
-} & TBase;
+/* Excluded from this release type: FileSnapshotWriterClassFactory */
 
-export declare const FileStorageDocumentName = "FileStorageDocId";
+/* Excluded from this release type: FileStorageDocumentName */
 
-/**
- * Document storage service for the file driver.
- */
-export declare class FluidFetchReader extends ReadDocumentStorageServiceBase implements IDocumentStorageService {
-    private readonly path;
-    private readonly versionName?;
-    protected docTree: api.ISnapshotTree | null;
-    constructor(path: string, versionName?: string | undefined);
-    /**
-     * Read the file and returns the snapshot tree.
-     * @param version - The version contains the path of the file which contains the snapshot tree.
-     */
-    getSnapshotTree(version?: api.IVersion): Promise<api.ISnapshotTree | null>;
-    /**
-     * Gets the path of the snapshot tree to be read.
-     * @param versionId - version ID.
-     * @param count - Number of versions to be returned.
-     */
-    getVersions(versionId: string | null, count: number): Promise<api.IVersion[]>;
-    readBlob(sha: string): Promise<ArrayBufferLike>;
-}
+/* Excluded from this release type: FluidFetchReader */
 
-export declare const FluidFetchReaderFileSnapshotWriter: {
-    new (...args: any[]): {
-        blobsWriter: Map<string, ArrayBufferLike>;
-        latestWriterTree?: api.ISnapshotTree | undefined;
-        docId?: string | undefined;
-        reset(): void;
-        onSnapshotHandler(snapshot: IFileSnapshot): void;
-        readBlob(sha: string): Promise<ArrayBufferLike>;
-        getVersions(versionId: string | null, count: number): Promise<api.IVersion[]>;
-        getSnapshotTree(version?: api.IVersion): Promise<api.ISnapshotTree | null>;
-        uploadSummaryWithContext(summary: api.ISummaryTree, context: ISummaryContext): Promise<string>;
-        buildTree(snapshotTree: api.ISnapshotTree): Promise<api.ITree>;
-        repositoryUrl: string;
-        readonly policies?: IDocumentStorageServicePolicies | undefined;
-        createBlob(file: ArrayBufferLike): Promise<api.ICreateBlobResponse>;
-        downloadSummary(handle: api.ISummaryHandle): Promise<api.ISummaryTree>;
-        readonly disposed?: boolean | undefined;
-        dispose?: ((error?: Error | undefined) => void) | undefined;
-    };
-} & typeof FluidFetchReader;
+/* Excluded from this release type: FluidFetchReaderFileSnapshotWriter */
 
-export declare interface ISnapshotWriterStorage extends IDocumentStorageService {
-    onSnapshotHandler(snapshot: IFileSnapshot): void;
-    reset(): void;
-}
+/* Excluded from this release type: IFileSnapshot */
 
-export declare type ReaderConstructor = new (...args: any[]) => IDocumentStorageService;
+/* Excluded from this release type: ISnapshotWriterStorage */
 
-/**
- * Replay service used to play ops using the delta connection.
- */
-export declare class Replayer {
-    private readonly deltaConnection;
-    private readonly documentStorageService;
-    private currentReplayOp;
-    constructor(deltaConnection: ReplayFileDeltaConnection, documentStorageService: FileDeltaStorageService);
-    get currentReplayedOp(): number;
-    set currentReplayedOp(op: number);
-    get ops(): readonly Readonly<ISequencedDocumentMessage>[];
-    /**
-     * Replay the ops upto a certain number.
-     * @param replayTo - The last op number to be replayed.
-     */
-    replay(replayTo: number): number;
-    private isDoneFetch;
-    private emit;
-}
+/* Excluded from this release type: ReadDocumentStorageServiceBase */
 
-export declare class ReplayFileDeltaConnection extends TypedEventEmitter<IDocumentDeltaConnectionEvents> implements IDocumentDeltaConnection, IDisposable {
-    details: IConnected;
-    /**
-     * Mimic the delta connection to replay ops on it.
-     *
-     * @param documentDeltaStorageService - The delta storage service to get ops from.
-     * @returns Document delta connection.
-     */
-    static create(documentDeltaStorageService: FileDeltaStorageService): Promise<ReplayFileDeltaConnection>;
-    readonly maxMessageSize: number;
-    private readonly replayer;
-    constructor(details: IConnected, documentDeltaStorageService: FileDeltaStorageService);
-    getReplayer(): Replayer;
-    get clientId(): string;
-    get mode(): ConnectionMode;
-    get claims(): ITokenClaims;
-    get existing(): boolean;
-    get version(): string;
-    get initialMessages(): ISequencedDocumentMessage[];
-    get initialSignals(): ISignalMessage[];
-    get initialClients(): ISignalClient[];
-    get serviceConfiguration(): IClientConfiguration;
-    submit(documentMessages: IDocumentMessage[]): void;
-    submitSignal(message: any): Promise<void>;
-    private _disposed;
-    get disposed(): boolean;
-    dispose(): void;
-}
+/* Excluded from this release type: ReaderConstructor */
+
+/* Excluded from this release type: Replayer */
+
+/* Excluded from this release type: ReplayFileDeltaConnection */
 
 /* Excluded from this release type: TypedEventEmitter */
 

package/dist/file-driver-beta.d.ts

@@ -2,186 +2,59 @@ import * as api from '@fluidframework/protocol-definitions';
 import { ConnectionMode } from '@fluidframework/protocol-definitions';
 import { IClientConfiguration } from '@fluidframework/protocol-definitions';
 import { IConnected } from '@fluidframework/protocol-definitions';
-import { IDisposable } from '@fluidframework/core-interfaces';
-import { IDocumentDeltaConnection } from '@fluidframework/driver-definitions';
-import { IDocumentDeltaConnectionEvents } from '@fluidframework/driver-definitions';
-import { IDocumentDeltaStorageService } from '@fluidframework/driver-definitions';
 import { IDocumentMessage } from '@fluidframework/protocol-definitions';
-import { IDocumentService } from '@fluidframework/driver-definitions';
-import { IDocumentServiceFactory } from '@fluidframework/driver-definitions';
-import { IDocumentStorageService } from '@fluidframework/driver-definitions';
 import { IDocumentStorageServicePolicies } from '@fluidframework/driver-definitions';
-import { IFileSnapshot } from '@fluidframework/replay-driver';
-import { IResolvedUrl } from '@fluidframework/driver-definitions';
 import { ISequencedDocumentMessage } from '@fluidframework/protocol-definitions';
 import { ISignalClient } from '@fluidframework/protocol-definitions';
 import { ISignalMessage } from '@fluidframework/protocol-definitions';
-import { IStream } from '@fluidframework/driver-definitions';
-import { ISummaryContext } from '@fluidframework/driver-definitions';
 import { ISummaryTree } from '@fluidframework/protocol-definitions';
-import { ITelemetryBaseLogger } from '@fluidframework/core-interfaces';
 import { ITokenClaims } from '@fluidframework/protocol-definitions';
-import { ReadDocumentStorageServiceBase } from '@fluidframework/replay-driver';
-
-/**
- * Provides access to the underlying delta storage on the local file storage for file driver.
- */
-export declare class FileDeltaStorageService implements IDocumentDeltaStorageService {
-    private readonly path;
-    private readonly messages;
-    private lastOps;
-    constructor(path: string);
-    fetchMessages(from: number, to: number | undefined, abortSignal?: AbortSignal, cachedOnly?: boolean): IStream<api.ISequencedDocumentMessage[]>;
-    get ops(): readonly Readonly<api.ISequencedDocumentMessage>[];
-    /**
-     * Retrieve ops within the exclusive sequence number range.
-     *
-     * @param from - First op to be fetched.
-     * @param to - Last op to be fetched. This is exclusive.
-     */
-    getFromWebSocket(from: number, to: number): api.ISequencedDocumentMessage[];
-}
-
-/**
- * Factory for creating the file document service. Use this if you want to
- * use the local file storage as underlying storage.
- */
-export declare class FileDocumentServiceFactory implements IDocumentServiceFactory {
-    private readonly storage;
-    private readonly deltaStorage;
-    private readonly deltaConnection;
-    constructor(storage: IDocumentStorageService, deltaStorage: FileDeltaStorageService, deltaConnection: IDocumentDeltaConnection);
-    /**
-     * Creates the file document service if the path exists.
-     *
-     * @param fileURL - Path of directory containing ops/snapshots.
-     * @returns file document service.
-     */
-    createDocumentService(resolvedUrl: IResolvedUrl, logger?: ITelemetryBaseLogger, clientIsSummarizer?: boolean): Promise<IDocumentService>;
-    createContainer(createNewSummary: ISummaryTree, resolvedUrl: IResolvedUrl, logger?: ITelemetryBaseLogger, clientIsSummarizer?: boolean): Promise<IDocumentService>;
-}
-
-export declare const FileSnapshotWriterClassFactory: <TBase extends ReaderConstructor>(Base: TBase) => {
-    new (...args: any[]): {
-        blobsWriter: Map<string, ArrayBufferLike>;
-        latestWriterTree?: api.ISnapshotTree | undefined;
-        docId?: string | undefined;
-        reset(): void;
-        onSnapshotHandler(snapshot: IFileSnapshot): void;
-        readBlob(sha: string): Promise<ArrayBufferLike>;
-        getVersions(versionId: string | null, count: number): Promise<api.IVersion[]>;
-        getSnapshotTree(version?: api.IVersion): Promise<api.ISnapshotTree | null>;
-        uploadSummaryWithContext(summary: api.ISummaryTree, context: ISummaryContext): Promise<string>;
-        buildTree(snapshotTree: api.ISnapshotTree): Promise<api.ITree>;
-        repositoryUrl: string;
-        readonly policies?: IDocumentStorageServicePolicies | undefined;
-        createBlob(file: ArrayBufferLike): Promise<api.ICreateBlobResponse>;
-        downloadSummary(handle: api.ISummaryHandle): Promise<api.ISummaryTree>;
-        readonly disposed?: boolean | undefined;
-        dispose?: ((error?: Error | undefined) => void) | undefined;
-    };
-} & TBase;
-
-export declare const FileStorageDocumentName = "FileStorageDocId";
-
-/**
- * Document storage service for the file driver.
- */
-export declare class FluidFetchReader extends ReadDocumentStorageServiceBase implements IDocumentStorageService {
-    private readonly path;
-    private readonly versionName?;
-    protected docTree: api.ISnapshotTree | null;
-    constructor(path: string, versionName?: string | undefined);
-    /**
-     * Read the file and returns the snapshot tree.
-     * @param version - The version contains the path of the file which contains the snapshot tree.
-     */
-    getSnapshotTree(version?: api.IVersion): Promise<api.ISnapshotTree | null>;
-    /**
-     * Gets the path of the snapshot tree to be read.
-     * @param versionId - version ID.
-     * @param count - Number of versions to be returned.
-     */
-    getVersions(versionId: string | null, count: number): Promise<api.IVersion[]>;
-    readBlob(sha: string): Promise<ArrayBufferLike>;
-}
-
-export declare const FluidFetchReaderFileSnapshotWriter: {
-    new (...args: any[]): {
-        blobsWriter: Map<string, ArrayBufferLike>;
-        latestWriterTree?: api.ISnapshotTree | undefined;
-        docId?: string | undefined;
-        reset(): void;
-        onSnapshotHandler(snapshot: IFileSnapshot): void;
-        readBlob(sha: string): Promise<ArrayBufferLike>;
-        getVersions(versionId: string | null, count: number): Promise<api.IVersion[]>;
-        getSnapshotTree(version?: api.IVersion): Promise<api.ISnapshotTree | null>;
-        uploadSummaryWithContext(summary: api.ISummaryTree, context: ISummaryContext): Promise<string>;
-        buildTree(snapshotTree: api.ISnapshotTree): Promise<api.ITree>;
-        repositoryUrl: string;
-        readonly policies?: IDocumentStorageServicePolicies | undefined;
-        createBlob(file: ArrayBufferLike): Promise<api.ICreateBlobResponse>;
-        downloadSummary(handle: api.ISummaryHandle): Promise<api.ISummaryTree>;
-        readonly disposed?: boolean | undefined;
-        dispose?: ((error?: Error | undefined) => void) | undefined;
-    };
-} & typeof FluidFetchReader;
-
-export declare interface ISnapshotWriterStorage extends IDocumentStorageService {
-    onSnapshotHandler(snapshot: IFileSnapshot): void;
-    reset(): void;
-}
-
-export declare type ReaderConstructor = new (...args: any[]) => IDocumentStorageService;
-
-/**
- * Replay service used to play ops using the delta connection.
- */
-export declare class Replayer {
-    private readonly deltaConnection;
-    private readonly documentStorageService;
-    private currentReplayOp;
-    constructor(deltaConnection: ReplayFileDeltaConnection, documentStorageService: FileDeltaStorageService);
-    get currentReplayedOp(): number;
-    set currentReplayedOp(op: number);
-    get ops(): readonly Readonly<ISequencedDocumentMessage>[];
-    /**
-     * Replay the ops upto a certain number.
-     * @param replayTo - The last op number to be replayed.
-     */
-    replay(replayTo: number): number;
-    private isDoneFetch;
-    private emit;
-}
-
-export declare class ReplayFileDeltaConnection extends TypedEventEmitter<IDocumentDeltaConnectionEvents> implements IDocumentDeltaConnection, IDisposable {
-    details: IConnected;
-    /**
-     * Mimic the delta connection to replay ops on it.
-     *
-     * @param documentDeltaStorageService - The delta storage service to get ops from.
-     * @returns Document delta connection.
-     */
-    static create(documentDeltaStorageService: FileDeltaStorageService): Promise<ReplayFileDeltaConnection>;
-    readonly maxMessageSize: number;
-    private readonly replayer;
-    constructor(details: IConnected, documentDeltaStorageService: FileDeltaStorageService);
-    getReplayer(): Replayer;
-    get clientId(): string;
-    get mode(): ConnectionMode;
-    get claims(): ITokenClaims;
-    get existing(): boolean;
-    get version(): string;
-    get initialMessages(): ISequencedDocumentMessage[];
-    get initialSignals(): ISignalMessage[];
-    get initialClients(): ISignalClient[];
-    get serviceConfiguration(): IClientConfiguration;
-    submit(documentMessages: IDocumentMessage[]): void;
-    submitSignal(message: any): Promise<void>;
-    private _disposed;
-    get disposed(): boolean;
-    dispose(): void;
-}
+
+/* Excluded from this release type: FileDeltaStorageService */
+
+/* Excluded from this release type: FileDocumentServiceFactory */
+
+/* Excluded from this release type: FileSnapshotWriterClassFactory */
+
+/* Excluded from this release type: FileStorageDocumentName */
+
+/* Excluded from this release type: FluidFetchReader */
+
+/* Excluded from this release type: FluidFetchReaderFileSnapshotWriter */
+
+/* Excluded from this release type: IDisposable */
+
+/* Excluded from this release type: IDocumentDeltaConnection */
+
+/* Excluded from this release type: IDocumentDeltaConnectionEvents */
+
+/* Excluded from this release type: IDocumentDeltaStorageService */
+
+/* Excluded from this release type: IDocumentService */
+
+/* Excluded from this release type: IDocumentServiceFactory */
+
+/* Excluded from this release type: IDocumentStorageService */
+
+/* Excluded from this release type: IFileSnapshot */
+
+/* Excluded from this release type: IResolvedUrl */
+
+/* Excluded from this release type: ISnapshotWriterStorage */
+
+/* Excluded from this release type: IStream */
+
+/* Excluded from this release type: ISummaryContext */
+
+/* Excluded from this release type: ITelemetryBaseLogger */
+
+/* Excluded from this release type: ReadDocumentStorageServiceBase */
+
+/* Excluded from this release type: ReaderConstructor */
+
+/* Excluded from this release type: Replayer */
+
+/* Excluded from this release type: ReplayFileDeltaConnection */
 
 /* Excluded from this release type: TypedEventEmitter */