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

package/lib/file-driver-public.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 */
 

package/lib/file-driver-untrimmed.d.ts

@@ -26,6 +26,7 @@ import { TypedEventEmitter } from '@fluid-internal/client-utils';
 
 /**
  * Provides access to the underlying delta storage on the local file storage for file driver.
+ * @internal
  */
 export declare class FileDeltaStorageService implements IDocumentDeltaStorageService {
     private readonly path;
@@ -46,6 +47,7 @@ export declare class FileDeltaStorageService implements IDocumentDeltaStorageSer
 /**
  * Factory for creating the file document service. Use this if you want to
  * use the local file storage as underlying storage.
+ * @internal
  */
 export declare class FileDocumentServiceFactory implements IDocumentServiceFactory {
     private readonly storage;
@@ -62,6 +64,9 @@ export declare class FileDocumentServiceFactory implements IDocumentServiceFacto
     createContainer(createNewSummary: ISummaryTree, resolvedUrl: IResolvedUrl, logger?: ITelemetryBaseLogger, clientIsSummarizer?: boolean): Promise<IDocumentService>;
 }
 
+/**
+ * @internal
+ */
 export declare const FileSnapshotWriterClassFactory: <TBase extends ReaderConstructor>(Base: TBase) => {
     new (...args: any[]): {
         blobsWriter: Map<string, ArrayBufferLike>;
@@ -83,10 +88,14 @@ export declare const FileSnapshotWriterClassFactory: <TBase extends ReaderConstr
     };
 } & TBase;
 
+/**
+ * @internal
+ */
 export declare const FileStorageDocumentName = "FileStorageDocId";
 
 /**
  * Document storage service for the file driver.
+ * @internal
  */
 export declare class FluidFetchReader extends ReadDocumentStorageServiceBase implements IDocumentStorageService {
     private readonly path;
@@ -107,6 +116,9 @@ export declare class FluidFetchReader extends ReadDocumentStorageServiceBase imp
     readBlob(sha: string): Promise<ArrayBufferLike>;
 }
 
+/**
+ * @internal
+ */
 export declare const FluidFetchReaderFileSnapshotWriter: {
     new (...args: any[]): {
         blobsWriter: Map<string, ArrayBufferLike>;
@@ -128,15 +140,22 @@ export declare const FluidFetchReaderFileSnapshotWriter: {
     };
 } & typeof FluidFetchReader;
 
+/**
+ * @internal
+ */
 export declare interface ISnapshotWriterStorage extends IDocumentStorageService {
     onSnapshotHandler(snapshot: IFileSnapshot): void;
     reset(): void;
 }
 
+/**
+ * @internal
+ */
 export declare type ReaderConstructor = new (...args: any[]) => IDocumentStorageService;
 
 /**
  * Replay service used to play ops using the delta connection.
+ * @internal
  */
 export declare class Replayer {
     private readonly deltaConnection;
@@ -155,6 +174,9 @@ export declare class Replayer {
     private emit;
 }
 
+/**
+ * @internal
+ */
 export declare class ReplayFileDeltaConnection extends TypedEventEmitter<IDocumentDeltaConnectionEvents> implements IDocumentDeltaConnection, IDisposable {
     details: IConnected;
     /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/file-driver",
-  "version": "2.0.0-dev.7.4.0.215930",
+  "version": "2.0.0-dev.7.4.0.217212",
   "description": "A driver that reads/write from/to local file storage.",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -15,13 +15,13 @@
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "dependencies": {
-    "@fluid-internal/client-utils": "2.0.0-dev.7.4.0.215930",
-    "@fluidframework/core-interfaces": "2.0.0-dev.7.4.0.215930",
-    "@fluidframework/core-utils": "2.0.0-dev.7.4.0.215930",
-    "@fluidframework/driver-definitions": "2.0.0-dev.7.4.0.215930",
-    "@fluidframework/driver-utils": "2.0.0-dev.7.4.0.215930",
+    "@fluid-internal/client-utils": "2.0.0-dev.7.4.0.217212",
+    "@fluidframework/core-interfaces": "2.0.0-dev.7.4.0.217212",
+    "@fluidframework/core-utils": "2.0.0-dev.7.4.0.217212",
+    "@fluidframework/driver-definitions": "2.0.0-dev.7.4.0.217212",
+    "@fluidframework/driver-utils": "2.0.0-dev.7.4.0.217212",
     "@fluidframework/protocol-definitions": "^3.0.0",
-    "@fluidframework/replay-driver": "2.0.0-dev.7.4.0.215930"
+    "@fluidframework/replay-driver": "2.0.0-dev.7.4.0.217212"
   },
   "devDependencies": {
     "@fluid-tools/build-cli": "^0.28.0",
@@ -63,12 +63,13 @@
     "build": "fluid-build . --task build",
     "build:compile": "fluid-build . --task compile",
     "build:docs": "fluid-build . --task api",
+    "check:release-tags": "api-extractor run --local --config ./api-extractor-lint.json",
     "ci:build:docs": "api-extractor run",
     "clean": "rimraf --glob dist lib \"**/*.tsbuildinfo\" \"**/*.build.log\" _api-extractor-temp",
     "eslint": "eslint --format stylish src",
     "eslint:fix": "eslint --format stylish src --fix --fix-type problem,suggestion,layout",
     "format": "npm run prettier:fix",
-    "lint": "npm run prettier && npm run eslint",
+    "lint": "npm run prettier && npm run check:release-tags && npm run eslint",
     "lint:fix": "npm run prettier:fix && npm run eslint:fix",
     "prettier": "prettier --check . --cache --ignore-path ../../../.prettierignore",
     "prettier:fix": "prettier --write . --cache --ignore-path ../../../.prettierignore",

package/src/fileDeltaStorageService.ts

@@ -11,6 +11,7 @@ import * as api from "@fluidframework/protocol-definitions";
 
 /**
  * Provides access to the underlying delta storage on the local file storage for file driver.
+ * @internal
  */
 export class FileDeltaStorageService implements IDocumentDeltaStorageService {
 	private readonly messages: api.ISequencedDocumentMessage[];

package/src/fileDocumentDeltaConnection.ts

@@ -45,6 +45,7 @@ const Claims: ITokenClaims = {
 
 /**
  * Replay service used to play ops using the delta connection.
+ * @internal
  */
 export class Replayer {
 	private currentReplayOp = 0;
@@ -110,6 +111,9 @@ export class Replayer {
 	}
 }
 
+/**
+ * @internal
+ */
 export class ReplayFileDeltaConnection
 	extends TypedEventEmitter<IDocumentDeltaConnectionEvents>
 	implements IDocumentDeltaConnection, IDisposable

package/src/fileDocumentServiceFactory.ts

@@ -18,6 +18,7 @@ import { FileDocumentService } from "./fileDocumentService";
 /**
  * Factory for creating the file document service. Use this if you want to
  * use the local file storage as underlying storage.
+ * @internal
  */
 export class FileDocumentServiceFactory implements IDocumentServiceFactory {
 	constructor(

package/src/fileDocumentStorageService.ts

@@ -13,6 +13,9 @@ import { IFileSnapshot, ReadDocumentStorageServiceBase } from "@fluidframework/r
 
 // This ID is used by replay tool as Document Id.
 // We leverage it to figure out when container is asking for root document tree.
+/**
+ * @internal
+ */
 export const FileStorageDocumentName = "FileStorageDocId"; // Some unique document name
 
 // Tree ID use to communicate between getVersions() & getSnapshotTree() that IVersion is ours.
@@ -20,6 +23,7 @@ const FileStorageVersionTreeId = "FileStorageTreeId";
 
 /**
  * Document storage service for the file driver.
+ * @internal
  */
 export class FluidFetchReader
 	extends ReadDocumentStorageServiceBase
@@ -110,12 +114,21 @@ export class FluidFetchReader
 	}
 }
 
+/**
+ * @internal
+ */
 export interface ISnapshotWriterStorage extends IDocumentStorageService {
 	onSnapshotHandler(snapshot: IFileSnapshot): void;
 	reset(): void;
 }
 
+/**
+ * @internal
+ */
 export type ReaderConstructor = new (...args: any[]) => IDocumentStorageService;
+/**
+ * @internal
+ */
 export const FileSnapshotWriterClassFactory = <TBase extends ReaderConstructor>(Base: TBase) =>
 	class extends Base implements ISnapshotWriterStorage {
 		// Note: if variable name has same name as in base class, it overrides it!
@@ -228,4 +241,7 @@ function removeNullTreeIds(tree: api.ITree) {
 	);
 	delete tree.id;
 }
+/**
+ * @internal
+ */
 export const FluidFetchReaderFileSnapshotWriter = FileSnapshotWriterClassFactory(FluidFetchReader);