@fluidframework/tool-utils 2.0.0-dev.7.3.0.212138 → 2.0.0-dev.7.4.0.215366

package/api-extractor.json

@@ -1,12 +1,19 @@
 {
 	"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
-	"extends": "@fluidframework/build-common/api-extractor-base.json",
+	"extends": "../../../common/build/build-common/api-extractor-base.json",
 	"messages": {
 		"extractorMessageReporting": {
+			// TODO: Fix violations and remove this rule override
 			"ae-missing-release-tag": {
-				// TODO: Fix violations and remove this rule override
+				"logLevel": "none"
+			},
+			// TODO: Add missing documentation and remove this rule override
+			"ae-undocumented": {
 				"logLevel": "none"
 			}
 		}
+	},
+	"dtsRollup": {
+		"enabled": true
 	}
 }

package/dist/packageVersion.d.ts

@@ -5,5 +5,5 @@
  * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY
  */
 export declare const pkgName = "@fluidframework/tool-utils";
-export declare const pkgVersion = "2.0.0-dev.7.3.0.212138";
+export declare const pkgVersion = "2.0.0-dev.7.4.0.215366";
 //# sourceMappingURL=packageVersion.d.ts.map

package/dist/packageVersion.js

@@ -8,5 +8,5 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.pkgVersion = exports.pkgName = void 0;
 exports.pkgName = "@fluidframework/tool-utils";
-exports.pkgVersion = "2.0.0-dev.7.3.0.212138";
+exports.pkgVersion = "2.0.0-dev.7.4.0.215366";
 //# sourceMappingURL=packageVersion.js.map

package/dist/packageVersion.js.map

@@ -1 +1 @@
-{"version":3,"file":"packageVersion.js","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEU,QAAA,OAAO,GAAG,4BAA4B,CAAC;AACvC,QAAA,UAAU,GAAG,wBAAwB,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n *\n * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY\n */\n\nexport const pkgName = \"@fluidframework/tool-utils\";\nexport const pkgVersion = \"2.0.0-dev.7.3.0.212138\";\n"]}
+{"version":3,"file":"packageVersion.js","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEU,QAAA,OAAO,GAAG,4BAA4B,CAAC;AACvC,QAAA,UAAU,GAAG,wBAAwB,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n *\n * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY\n */\n\nexport const pkgName = \"@fluidframework/tool-utils\";\nexport const pkgVersion = \"2.0.0-dev.7.4.0.215366\";\n"]}

package/dist/tool-utils-alpha.d.ts

@@ -0,0 +1,92 @@
+import { IClientConfig } from '@fluidframework/odsp-doclib-utils';
+import { IOdspTokens } from '@fluidframework/odsp-doclib-utils';
+import { ITree } from '@fluidframework/protocol-definitions';
+
+/** The prefix that all GC blob names start with. */
+export declare const gcBlobPrefix = "__gc";
+
+export declare const getMicrosoftConfiguration: () => IClientConfig;
+
+/**
+ * Helper function that normalizes the given snapshot tree. It sorts objects and arrays in the snapshot. It also
+ * normalizes certain blob contents for which the order of content does not matter. For example, garbage collection
+ * blobs contains objects / arrays whose element order do not matter.
+ * @param snapshot - The snapshot tree to normalize.
+ * @param config - Configs to use when normalizing snapshot. For example, it can contain paths of blobs whose contents
+ * should be normalized as well.
+ * @returns a copy of the normalized snapshot tree.
+ */
+export declare function getNormalizedSnapshot(snapshot: ITree, config?: ISnapshotNormalizerConfig): ITree;
+
+export declare interface IAsyncCache<TKey, TValue> {
+    get(key: TKey): Promise<TValue | undefined>;
+    save(key: TKey, value: TValue): Promise<void>;
+    lock<T>(callback: () => Promise<T>): Promise<T>;
+}
+
+export declare interface IOdspTokenManagerCacheKey {
+    readonly isPush: boolean;
+    readonly userOrServer: string;
+}
+
+export declare interface IResources {
+    tokens?: {
+        version?: number;
+        data: {
+            [key: string]: {
+                storage?: IOdspTokens;
+                push?: IOdspTokens;
+            };
+        };
+    };
+}
+
+export declare interface ISnapshotNormalizerConfig {
+    blobsToNormalize?: string[];
+    /**
+     * channel types who's content (non-attribute) blobs will be excluded.
+     * this is used to exclude the content of channels who's content cannot be compared
+     * as the content is non-deterministic between snapshot at the same sequence number.
+     */
+    excludedChannelContentTypes?: string[];
+}
+
+export declare function loadRC(): Promise<IResources>;
+
+export declare function lockRC(): Promise<any>;
+
+export declare type OdspTokenConfig = {
+    type: "password";
+    username: string;
+    password: string;
+} | {
+    type: "browserLogin";
+    navigator: (url: string) => void;
+    redirectUriCallback?: (tokens: IOdspTokens) => Promise<string>;
+};
+
+export declare class OdspTokenManager {
+    private readonly tokenCache?;
+    private readonly storageCache;
+    private readonly pushCache;
+    private readonly cacheMutex;
+    constructor(tokenCache?: IAsyncCache<IOdspTokenManagerCacheKey, IOdspTokens> | undefined);
+    updateTokensCache(key: IOdspTokenManagerCacheKey, value: IOdspTokens): Promise<void>;
+    private updateTokensCacheWithoutLock;
+    getOdspTokens(server: string, clientConfig: IClientConfig, tokenConfig: OdspTokenConfig, forceRefresh?: boolean, forceReauth?: boolean): Promise<IOdspTokens>;
+    getPushTokens(server: string, clientConfig: IClientConfig, tokenConfig: OdspTokenConfig, forceRefresh?: boolean, forceReauth?: boolean): Promise<IOdspTokens>;
+    private getTokenFromCache;
+    private static getCacheKey;
+    private getTokens;
+    private getTokensCore;
+    private acquireTokensWithPassword;
+    private acquireTokensViaBrowserLogin;
+    private onTokenRetrievalFromCache;
+    private extractAuthorizationCode;
+}
+
+export declare const odspTokensCache: IAsyncCache<IOdspTokenManagerCacheKey, IOdspTokens>;
+
+export declare function saveRC(rc: IResources): Promise<void>;
+
+export { }

package/dist/tool-utils-beta.d.ts

@@ -0,0 +1,92 @@
+import { IClientConfig } from '@fluidframework/odsp-doclib-utils';
+import { IOdspTokens } from '@fluidframework/odsp-doclib-utils';
+import { ITree } from '@fluidframework/protocol-definitions';
+
+/** The prefix that all GC blob names start with. */
+export declare const gcBlobPrefix = "__gc";
+
+export declare const getMicrosoftConfiguration: () => IClientConfig;
+
+/**
+ * Helper function that normalizes the given snapshot tree. It sorts objects and arrays in the snapshot. It also
+ * normalizes certain blob contents for which the order of content does not matter. For example, garbage collection
+ * blobs contains objects / arrays whose element order do not matter.
+ * @param snapshot - The snapshot tree to normalize.
+ * @param config - Configs to use when normalizing snapshot. For example, it can contain paths of blobs whose contents
+ * should be normalized as well.
+ * @returns a copy of the normalized snapshot tree.
+ */
+export declare function getNormalizedSnapshot(snapshot: ITree, config?: ISnapshotNormalizerConfig): ITree;
+
+export declare interface IAsyncCache<TKey, TValue> {
+    get(key: TKey): Promise<TValue | undefined>;
+    save(key: TKey, value: TValue): Promise<void>;
+    lock<T>(callback: () => Promise<T>): Promise<T>;
+}
+
+export declare interface IOdspTokenManagerCacheKey {
+    readonly isPush: boolean;
+    readonly userOrServer: string;
+}
+
+export declare interface IResources {
+    tokens?: {
+        version?: number;
+        data: {
+            [key: string]: {
+                storage?: IOdspTokens;
+                push?: IOdspTokens;
+            };
+        };
+    };
+}
+
+export declare interface ISnapshotNormalizerConfig {
+    blobsToNormalize?: string[];
+    /**
+     * channel types who's content (non-attribute) blobs will be excluded.
+     * this is used to exclude the content of channels who's content cannot be compared
+     * as the content is non-deterministic between snapshot at the same sequence number.
+     */
+    excludedChannelContentTypes?: string[];
+}
+
+export declare function loadRC(): Promise<IResources>;
+
+export declare function lockRC(): Promise<any>;
+
+export declare type OdspTokenConfig = {
+    type: "password";
+    username: string;
+    password: string;
+} | {
+    type: "browserLogin";
+    navigator: (url: string) => void;
+    redirectUriCallback?: (tokens: IOdspTokens) => Promise<string>;
+};
+
+export declare class OdspTokenManager {
+    private readonly tokenCache?;
+    private readonly storageCache;
+    private readonly pushCache;
+    private readonly cacheMutex;
+    constructor(tokenCache?: IAsyncCache<IOdspTokenManagerCacheKey, IOdspTokens> | undefined);
+    updateTokensCache(key: IOdspTokenManagerCacheKey, value: IOdspTokens): Promise<void>;
+    private updateTokensCacheWithoutLock;
+    getOdspTokens(server: string, clientConfig: IClientConfig, tokenConfig: OdspTokenConfig, forceRefresh?: boolean, forceReauth?: boolean): Promise<IOdspTokens>;
+    getPushTokens(server: string, clientConfig: IClientConfig, tokenConfig: OdspTokenConfig, forceRefresh?: boolean, forceReauth?: boolean): Promise<IOdspTokens>;
+    private getTokenFromCache;
+    private static getCacheKey;
+    private getTokens;
+    private getTokensCore;
+    private acquireTokensWithPassword;
+    private acquireTokensViaBrowserLogin;
+    private onTokenRetrievalFromCache;
+    private extractAuthorizationCode;
+}
+
+export declare const odspTokensCache: IAsyncCache<IOdspTokenManagerCacheKey, IOdspTokens>;
+
+export declare function saveRC(rc: IResources): Promise<void>;
+
+export { }

package/dist/tool-utils-public.d.ts

@@ -0,0 +1,92 @@
+import { IClientConfig } from '@fluidframework/odsp-doclib-utils';
+import { IOdspTokens } from '@fluidframework/odsp-doclib-utils';
+import { ITree } from '@fluidframework/protocol-definitions';
+
+/** The prefix that all GC blob names start with. */
+export declare const gcBlobPrefix = "__gc";
+
+export declare const getMicrosoftConfiguration: () => IClientConfig;
+
+/**
+ * Helper function that normalizes the given snapshot tree. It sorts objects and arrays in the snapshot. It also
+ * normalizes certain blob contents for which the order of content does not matter. For example, garbage collection
+ * blobs contains objects / arrays whose element order do not matter.
+ * @param snapshot - The snapshot tree to normalize.
+ * @param config - Configs to use when normalizing snapshot. For example, it can contain paths of blobs whose contents
+ * should be normalized as well.
+ * @returns a copy of the normalized snapshot tree.
+ */
+export declare function getNormalizedSnapshot(snapshot: ITree, config?: ISnapshotNormalizerConfig): ITree;
+
+export declare interface IAsyncCache<TKey, TValue> {
+    get(key: TKey): Promise<TValue | undefined>;
+    save(key: TKey, value: TValue): Promise<void>;
+    lock<T>(callback: () => Promise<T>): Promise<T>;
+}
+
+export declare interface IOdspTokenManagerCacheKey {
+    readonly isPush: boolean;
+    readonly userOrServer: string;
+}
+
+export declare interface IResources {
+    tokens?: {
+        version?: number;
+        data: {
+            [key: string]: {
+                storage?: IOdspTokens;
+                push?: IOdspTokens;
+            };
+        };
+    };
+}
+
+export declare interface ISnapshotNormalizerConfig {
+    blobsToNormalize?: string[];
+    /**
+     * channel types who's content (non-attribute) blobs will be excluded.
+     * this is used to exclude the content of channels who's content cannot be compared
+     * as the content is non-deterministic between snapshot at the same sequence number.
+     */
+    excludedChannelContentTypes?: string[];
+}
+
+export declare function loadRC(): Promise<IResources>;
+
+export declare function lockRC(): Promise<any>;
+
+export declare type OdspTokenConfig = {
+    type: "password";
+    username: string;
+    password: string;
+} | {
+    type: "browserLogin";
+    navigator: (url: string) => void;
+    redirectUriCallback?: (tokens: IOdspTokens) => Promise<string>;
+};
+
+export declare class OdspTokenManager {
+    private readonly tokenCache?;
+    private readonly storageCache;
+    private readonly pushCache;
+    private readonly cacheMutex;
+    constructor(tokenCache?: IAsyncCache<IOdspTokenManagerCacheKey, IOdspTokens> | undefined);
+    updateTokensCache(key: IOdspTokenManagerCacheKey, value: IOdspTokens): Promise<void>;
+    private updateTokensCacheWithoutLock;
+    getOdspTokens(server: string, clientConfig: IClientConfig, tokenConfig: OdspTokenConfig, forceRefresh?: boolean, forceReauth?: boolean): Promise<IOdspTokens>;
+    getPushTokens(server: string, clientConfig: IClientConfig, tokenConfig: OdspTokenConfig, forceRefresh?: boolean, forceReauth?: boolean): Promise<IOdspTokens>;
+    private getTokenFromCache;
+    private static getCacheKey;
+    private getTokens;
+    private getTokensCore;
+    private acquireTokensWithPassword;
+    private acquireTokensViaBrowserLogin;
+    private onTokenRetrievalFromCache;
+    private extractAuthorizationCode;
+}
+
+export declare const odspTokensCache: IAsyncCache<IOdspTokenManagerCacheKey, IOdspTokens>;
+
+export declare function saveRC(rc: IResources): Promise<void>;
+
+export { }

package/dist/tool-utils-untrimmed.d.ts

@@ -0,0 +1,92 @@
+import { IClientConfig } from '@fluidframework/odsp-doclib-utils';
+import { IOdspTokens } from '@fluidframework/odsp-doclib-utils';
+import { ITree } from '@fluidframework/protocol-definitions';
+
+/** The prefix that all GC blob names start with. */
+export declare const gcBlobPrefix = "__gc";
+
+export declare const getMicrosoftConfiguration: () => IClientConfig;
+
+/**
+ * Helper function that normalizes the given snapshot tree. It sorts objects and arrays in the snapshot. It also
+ * normalizes certain blob contents for which the order of content does not matter. For example, garbage collection
+ * blobs contains objects / arrays whose element order do not matter.
+ * @param snapshot - The snapshot tree to normalize.
+ * @param config - Configs to use when normalizing snapshot. For example, it can contain paths of blobs whose contents
+ * should be normalized as well.
+ * @returns a copy of the normalized snapshot tree.
+ */
+export declare function getNormalizedSnapshot(snapshot: ITree, config?: ISnapshotNormalizerConfig): ITree;
+
+export declare interface IAsyncCache<TKey, TValue> {
+    get(key: TKey): Promise<TValue | undefined>;
+    save(key: TKey, value: TValue): Promise<void>;
+    lock<T>(callback: () => Promise<T>): Promise<T>;
+}
+
+export declare interface IOdspTokenManagerCacheKey {
+    readonly isPush: boolean;
+    readonly userOrServer: string;
+}
+
+export declare interface IResources {
+    tokens?: {
+        version?: number;
+        data: {
+            [key: string]: {
+                storage?: IOdspTokens;
+                push?: IOdspTokens;
+            };
+        };
+    };
+}
+
+export declare interface ISnapshotNormalizerConfig {
+    blobsToNormalize?: string[];
+    /**
+     * channel types who's content (non-attribute) blobs will be excluded.
+     * this is used to exclude the content of channels who's content cannot be compared
+     * as the content is non-deterministic between snapshot at the same sequence number.
+     */
+    excludedChannelContentTypes?: string[];
+}
+
+export declare function loadRC(): Promise<IResources>;
+
+export declare function lockRC(): Promise<any>;
+
+export declare type OdspTokenConfig = {
+    type: "password";
+    username: string;
+    password: string;
+} | {
+    type: "browserLogin";
+    navigator: (url: string) => void;
+    redirectUriCallback?: (tokens: IOdspTokens) => Promise<string>;
+};
+
+export declare class OdspTokenManager {
+    private readonly tokenCache?;
+    private readonly storageCache;
+    private readonly pushCache;
+    private readonly cacheMutex;
+    constructor(tokenCache?: IAsyncCache<IOdspTokenManagerCacheKey, IOdspTokens> | undefined);
+    updateTokensCache(key: IOdspTokenManagerCacheKey, value: IOdspTokens): Promise<void>;
+    private updateTokensCacheWithoutLock;
+    getOdspTokens(server: string, clientConfig: IClientConfig, tokenConfig: OdspTokenConfig, forceRefresh?: boolean, forceReauth?: boolean): Promise<IOdspTokens>;
+    getPushTokens(server: string, clientConfig: IClientConfig, tokenConfig: OdspTokenConfig, forceRefresh?: boolean, forceReauth?: boolean): Promise<IOdspTokens>;
+    private getTokenFromCache;
+    private static getCacheKey;
+    private getTokens;
+    private getTokensCore;
+    private acquireTokensWithPassword;
+    private acquireTokensViaBrowserLogin;
+    private onTokenRetrievalFromCache;
+    private extractAuthorizationCode;
+}
+
+export declare const odspTokensCache: IAsyncCache<IOdspTokenManagerCacheKey, IOdspTokens>;
+
+export declare function saveRC(rc: IResources): Promise<void>;
+
+export { }

package/lib/packageVersion.d.ts

@@ -5,5 +5,5 @@
  * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY
  */
 export declare const pkgName = "@fluidframework/tool-utils";
-export declare const pkgVersion = "2.0.0-dev.7.3.0.212138";
+export declare const pkgVersion = "2.0.0-dev.7.4.0.215366";
 //# sourceMappingURL=packageVersion.d.ts.map

package/lib/packageVersion.js

@@ -5,5 +5,5 @@
  * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY
  */
 export const pkgName = "@fluidframework/tool-utils";
-export const pkgVersion = "2.0.0-dev.7.3.0.212138";
+export const pkgVersion = "2.0.0-dev.7.4.0.215366";
 //# sourceMappingURL=packageVersion.js.map

package/lib/packageVersion.js.map

@@ -1 +1 @@
-{"version":3,"file":"packageVersion.js","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,MAAM,CAAC,MAAM,OAAO,GAAG,4BAA4B,CAAC;AACpD,MAAM,CAAC,MAAM,UAAU,GAAG,wBAAwB,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n *\n * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY\n */\n\nexport const pkgName = \"@fluidframework/tool-utils\";\nexport const pkgVersion = \"2.0.0-dev.7.3.0.212138\";\n"]}
+{"version":3,"file":"packageVersion.js","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,MAAM,CAAC,MAAM,OAAO,GAAG,4BAA4B,CAAC;AACpD,MAAM,CAAC,MAAM,UAAU,GAAG,wBAAwB,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n *\n * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY\n */\n\nexport const pkgName = \"@fluidframework/tool-utils\";\nexport const pkgVersion = \"2.0.0-dev.7.4.0.215366\";\n"]}

package/lib/tool-utils-alpha.d.ts

@@ -0,0 +1,92 @@
+import { IClientConfig } from '@fluidframework/odsp-doclib-utils';
+import { IOdspTokens } from '@fluidframework/odsp-doclib-utils';
+import { ITree } from '@fluidframework/protocol-definitions';
+
+/** The prefix that all GC blob names start with. */
+export declare const gcBlobPrefix = "__gc";
+
+export declare const getMicrosoftConfiguration: () => IClientConfig;
+
+/**
+ * Helper function that normalizes the given snapshot tree. It sorts objects and arrays in the snapshot. It also
+ * normalizes certain blob contents for which the order of content does not matter. For example, garbage collection
+ * blobs contains objects / arrays whose element order do not matter.
+ * @param snapshot - The snapshot tree to normalize.
+ * @param config - Configs to use when normalizing snapshot. For example, it can contain paths of blobs whose contents
+ * should be normalized as well.
+ * @returns a copy of the normalized snapshot tree.
+ */
+export declare function getNormalizedSnapshot(snapshot: ITree, config?: ISnapshotNormalizerConfig): ITree;
+
+export declare interface IAsyncCache<TKey, TValue> {
+    get(key: TKey): Promise<TValue | undefined>;
+    save(key: TKey, value: TValue): Promise<void>;
+    lock<T>(callback: () => Promise<T>): Promise<T>;
+}
+
+export declare interface IOdspTokenManagerCacheKey {
+    readonly isPush: boolean;
+    readonly userOrServer: string;
+}
+
+export declare interface IResources {
+    tokens?: {
+        version?: number;
+        data: {
+            [key: string]: {
+                storage?: IOdspTokens;
+                push?: IOdspTokens;
+            };
+        };
+    };
+}
+
+export declare interface ISnapshotNormalizerConfig {
+    blobsToNormalize?: string[];
+    /**
+     * channel types who's content (non-attribute) blobs will be excluded.
+     * this is used to exclude the content of channels who's content cannot be compared
+     * as the content is non-deterministic between snapshot at the same sequence number.
+     */
+    excludedChannelContentTypes?: string[];
+}
+
+export declare function loadRC(): Promise<IResources>;
+
+export declare function lockRC(): Promise<any>;
+
+export declare type OdspTokenConfig = {
+    type: "password";
+    username: string;
+    password: string;
+} | {
+    type: "browserLogin";
+    navigator: (url: string) => void;
+    redirectUriCallback?: (tokens: IOdspTokens) => Promise<string>;
+};
+
+export declare class OdspTokenManager {
+    private readonly tokenCache?;
+    private readonly storageCache;
+    private readonly pushCache;
+    private readonly cacheMutex;
+    constructor(tokenCache?: IAsyncCache<IOdspTokenManagerCacheKey, IOdspTokens> | undefined);
+    updateTokensCache(key: IOdspTokenManagerCacheKey, value: IOdspTokens): Promise<void>;
+    private updateTokensCacheWithoutLock;
+    getOdspTokens(server: string, clientConfig: IClientConfig, tokenConfig: OdspTokenConfig, forceRefresh?: boolean, forceReauth?: boolean): Promise<IOdspTokens>;
+    getPushTokens(server: string, clientConfig: IClientConfig, tokenConfig: OdspTokenConfig, forceRefresh?: boolean, forceReauth?: boolean): Promise<IOdspTokens>;
+    private getTokenFromCache;
+    private static getCacheKey;
+    private getTokens;
+    private getTokensCore;
+    private acquireTokensWithPassword;
+    private acquireTokensViaBrowserLogin;
+    private onTokenRetrievalFromCache;
+    private extractAuthorizationCode;
+}
+
+export declare const odspTokensCache: IAsyncCache<IOdspTokenManagerCacheKey, IOdspTokens>;
+
+export declare function saveRC(rc: IResources): Promise<void>;
+
+export { }

package/lib/tool-utils-beta.d.ts

@@ -0,0 +1,92 @@
+import { IClientConfig } from '@fluidframework/odsp-doclib-utils';
+import { IOdspTokens } from '@fluidframework/odsp-doclib-utils';
+import { ITree } from '@fluidframework/protocol-definitions';
+
+/** The prefix that all GC blob names start with. */
+export declare const gcBlobPrefix = "__gc";
+
+export declare const getMicrosoftConfiguration: () => IClientConfig;
+
+/**
+ * Helper function that normalizes the given snapshot tree. It sorts objects and arrays in the snapshot. It also
+ * normalizes certain blob contents for which the order of content does not matter. For example, garbage collection
+ * blobs contains objects / arrays whose element order do not matter.
+ * @param snapshot - The snapshot tree to normalize.
+ * @param config - Configs to use when normalizing snapshot. For example, it can contain paths of blobs whose contents
+ * should be normalized as well.
+ * @returns a copy of the normalized snapshot tree.
+ */
+export declare function getNormalizedSnapshot(snapshot: ITree, config?: ISnapshotNormalizerConfig): ITree;
+
+export declare interface IAsyncCache<TKey, TValue> {
+    get(key: TKey): Promise<TValue | undefined>;
+    save(key: TKey, value: TValue): Promise<void>;
+    lock<T>(callback: () => Promise<T>): Promise<T>;
+}
+
+export declare interface IOdspTokenManagerCacheKey {
+    readonly isPush: boolean;
+    readonly userOrServer: string;
+}
+
+export declare interface IResources {
+    tokens?: {
+        version?: number;
+        data: {
+            [key: string]: {
+                storage?: IOdspTokens;
+                push?: IOdspTokens;
+            };
+        };
+    };
+}
+
+export declare interface ISnapshotNormalizerConfig {
+    blobsToNormalize?: string[];
+    /**
+     * channel types who's content (non-attribute) blobs will be excluded.
+     * this is used to exclude the content of channels who's content cannot be compared
+     * as the content is non-deterministic between snapshot at the same sequence number.
+     */
+    excludedChannelContentTypes?: string[];
+}
+
+export declare function loadRC(): Promise<IResources>;
+
+export declare function lockRC(): Promise<any>;
+
+export declare type OdspTokenConfig = {
+    type: "password";
+    username: string;
+    password: string;
+} | {
+    type: "browserLogin";
+    navigator: (url: string) => void;
+    redirectUriCallback?: (tokens: IOdspTokens) => Promise<string>;
+};
+
+export declare class OdspTokenManager {
+    private readonly tokenCache?;
+    private readonly storageCache;
+    private readonly pushCache;
+    private readonly cacheMutex;
+    constructor(tokenCache?: IAsyncCache<IOdspTokenManagerCacheKey, IOdspTokens> | undefined);
+    updateTokensCache(key: IOdspTokenManagerCacheKey, value: IOdspTokens): Promise<void>;
+    private updateTokensCacheWithoutLock;
+    getOdspTokens(server: string, clientConfig: IClientConfig, tokenConfig: OdspTokenConfig, forceRefresh?: boolean, forceReauth?: boolean): Promise<IOdspTokens>;
+    getPushTokens(server: string, clientConfig: IClientConfig, tokenConfig: OdspTokenConfig, forceRefresh?: boolean, forceReauth?: boolean): Promise<IOdspTokens>;
+    private getTokenFromCache;
+    private static getCacheKey;
+    private getTokens;
+    private getTokensCore;
+    private acquireTokensWithPassword;
+    private acquireTokensViaBrowserLogin;
+    private onTokenRetrievalFromCache;
+    private extractAuthorizationCode;
+}
+
+export declare const odspTokensCache: IAsyncCache<IOdspTokenManagerCacheKey, IOdspTokens>;
+
+export declare function saveRC(rc: IResources): Promise<void>;
+
+export { }

package/lib/tool-utils-public.d.ts

@@ -0,0 +1,92 @@
+import { IClientConfig } from '@fluidframework/odsp-doclib-utils';
+import { IOdspTokens } from '@fluidframework/odsp-doclib-utils';
+import { ITree } from '@fluidframework/protocol-definitions';
+
+/** The prefix that all GC blob names start with. */
+export declare const gcBlobPrefix = "__gc";
+
+export declare const getMicrosoftConfiguration: () => IClientConfig;
+
+/**
+ * Helper function that normalizes the given snapshot tree. It sorts objects and arrays in the snapshot. It also
+ * normalizes certain blob contents for which the order of content does not matter. For example, garbage collection
+ * blobs contains objects / arrays whose element order do not matter.
+ * @param snapshot - The snapshot tree to normalize.
+ * @param config - Configs to use when normalizing snapshot. For example, it can contain paths of blobs whose contents
+ * should be normalized as well.
+ * @returns a copy of the normalized snapshot tree.
+ */
+export declare function getNormalizedSnapshot(snapshot: ITree, config?: ISnapshotNormalizerConfig): ITree;
+
+export declare interface IAsyncCache<TKey, TValue> {
+    get(key: TKey): Promise<TValue | undefined>;
+    save(key: TKey, value: TValue): Promise<void>;
+    lock<T>(callback: () => Promise<T>): Promise<T>;
+}
+
+export declare interface IOdspTokenManagerCacheKey {
+    readonly isPush: boolean;
+    readonly userOrServer: string;
+}
+
+export declare interface IResources {
+    tokens?: {
+        version?: number;
+        data: {
+            [key: string]: {
+                storage?: IOdspTokens;
+                push?: IOdspTokens;
+            };
+        };
+    };
+}
+
+export declare interface ISnapshotNormalizerConfig {
+    blobsToNormalize?: string[];
+    /**
+     * channel types who's content (non-attribute) blobs will be excluded.
+     * this is used to exclude the content of channels who's content cannot be compared
+     * as the content is non-deterministic between snapshot at the same sequence number.
+     */
+    excludedChannelContentTypes?: string[];
+}
+
+export declare function loadRC(): Promise<IResources>;
+
+export declare function lockRC(): Promise<any>;
+
+export declare type OdspTokenConfig = {
+    type: "password";
+    username: string;
+    password: string;
+} | {
+    type: "browserLogin";
+    navigator: (url: string) => void;
+    redirectUriCallback?: (tokens: IOdspTokens) => Promise<string>;
+};
+
+export declare class OdspTokenManager {
+    private readonly tokenCache?;
+    private readonly storageCache;
+    private readonly pushCache;
+    private readonly cacheMutex;
+    constructor(tokenCache?: IAsyncCache<IOdspTokenManagerCacheKey, IOdspTokens> | undefined);
+    updateTokensCache(key: IOdspTokenManagerCacheKey, value: IOdspTokens): Promise<void>;
+    private updateTokensCacheWithoutLock;
+    getOdspTokens(server: string, clientConfig: IClientConfig, tokenConfig: OdspTokenConfig, forceRefresh?: boolean, forceReauth?: boolean): Promise<IOdspTokens>;
+    getPushTokens(server: string, clientConfig: IClientConfig, tokenConfig: OdspTokenConfig, forceRefresh?: boolean, forceReauth?: boolean): Promise<IOdspTokens>;
+    private getTokenFromCache;
+    private static getCacheKey;
+    private getTokens;
+    private getTokensCore;
+    private acquireTokensWithPassword;
+    private acquireTokensViaBrowserLogin;
+    private onTokenRetrievalFromCache;
+    private extractAuthorizationCode;
+}
+
+export declare const odspTokensCache: IAsyncCache<IOdspTokenManagerCacheKey, IOdspTokens>;
+
+export declare function saveRC(rc: IResources): Promise<void>;
+
+export { }

package/lib/tool-utils-untrimmed.d.ts

@@ -0,0 +1,92 @@
+import { IClientConfig } from '@fluidframework/odsp-doclib-utils';
+import { IOdspTokens } from '@fluidframework/odsp-doclib-utils';
+import { ITree } from '@fluidframework/protocol-definitions';
+
+/** The prefix that all GC blob names start with. */
+export declare const gcBlobPrefix = "__gc";
+
+export declare const getMicrosoftConfiguration: () => IClientConfig;
+
+/**
+ * Helper function that normalizes the given snapshot tree. It sorts objects and arrays in the snapshot. It also
+ * normalizes certain blob contents for which the order of content does not matter. For example, garbage collection
+ * blobs contains objects / arrays whose element order do not matter.
+ * @param snapshot - The snapshot tree to normalize.
+ * @param config - Configs to use when normalizing snapshot. For example, it can contain paths of blobs whose contents
+ * should be normalized as well.
+ * @returns a copy of the normalized snapshot tree.
+ */
+export declare function getNormalizedSnapshot(snapshot: ITree, config?: ISnapshotNormalizerConfig): ITree;
+
+export declare interface IAsyncCache<TKey, TValue> {
+    get(key: TKey): Promise<TValue | undefined>;
+    save(key: TKey, value: TValue): Promise<void>;
+    lock<T>(callback: () => Promise<T>): Promise<T>;
+}
+
+export declare interface IOdspTokenManagerCacheKey {
+    readonly isPush: boolean;
+    readonly userOrServer: string;
+}
+
+export declare interface IResources {
+    tokens?: {
+        version?: number;
+        data: {
+            [key: string]: {
+                storage?: IOdspTokens;
+                push?: IOdspTokens;
+            };
+        };
+    };
+}
+
+export declare interface ISnapshotNormalizerConfig {
+    blobsToNormalize?: string[];
+    /**
+     * channel types who's content (non-attribute) blobs will be excluded.
+     * this is used to exclude the content of channels who's content cannot be compared
+     * as the content is non-deterministic between snapshot at the same sequence number.
+     */
+    excludedChannelContentTypes?: string[];
+}
+
+export declare function loadRC(): Promise<IResources>;
+
+export declare function lockRC(): Promise<any>;
+
+export declare type OdspTokenConfig = {
+    type: "password";
+    username: string;
+    password: string;
+} | {
+    type: "browserLogin";
+    navigator: (url: string) => void;
+    redirectUriCallback?: (tokens: IOdspTokens) => Promise<string>;
+};
+
+export declare class OdspTokenManager {
+    private readonly tokenCache?;
+    private readonly storageCache;
+    private readonly pushCache;
+    private readonly cacheMutex;
+    constructor(tokenCache?: IAsyncCache<IOdspTokenManagerCacheKey, IOdspTokens> | undefined);
+    updateTokensCache(key: IOdspTokenManagerCacheKey, value: IOdspTokens): Promise<void>;
+    private updateTokensCacheWithoutLock;
+    getOdspTokens(server: string, clientConfig: IClientConfig, tokenConfig: OdspTokenConfig, forceRefresh?: boolean, forceReauth?: boolean): Promise<IOdspTokens>;
+    getPushTokens(server: string, clientConfig: IClientConfig, tokenConfig: OdspTokenConfig, forceRefresh?: boolean, forceReauth?: boolean): Promise<IOdspTokens>;
+    private getTokenFromCache;
+    private static getCacheKey;
+    private getTokens;
+    private getTokensCore;
+    private acquireTokensWithPassword;
+    private acquireTokensViaBrowserLogin;
+    private onTokenRetrievalFromCache;
+    private extractAuthorizationCode;
+}
+
+export declare const odspTokensCache: IAsyncCache<IOdspTokenManagerCacheKey, IOdspTokens>;
+
+export declare function saveRC(rc: IResources): Promise<void>;
+
+export { }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/tool-utils",
-  "version": "2.0.0-dev.7.3.0.212138",
+  "version": "2.0.0-dev.7.4.0.215366",
   "description": "Common utilities for Fluid tools",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -35,9 +35,9 @@
     "temp-directory": "nyc/.nyc_output"
   },
   "dependencies": {
-    "@fluidframework/core-utils": "2.0.0-dev.7.3.0.212138",
-    "@fluidframework/driver-utils": "2.0.0-dev.7.3.0.212138",
-    "@fluidframework/odsp-doclib-utils": "2.0.0-dev.7.3.0.212138",
+    "@fluidframework/core-utils": "2.0.0-dev.7.4.0.215366",
+    "@fluidframework/driver-utils": "2.0.0-dev.7.4.0.215366",
+    "@fluidframework/odsp-doclib-utils": "2.0.0-dev.7.4.0.215366",
     "@fluidframework/protocol-definitions": "^3.0.0",
     "async-mutex": "^0.3.1",
     "debug": "^4.3.4",
@@ -49,7 +49,7 @@
     "@fluidframework/build-common": "^2.0.3",
     "@fluidframework/build-tools": "^0.28.0",
     "@fluidframework/eslint-config-fluid": "^3.1.0",
-    "@fluidframework/mocha-test-setup": "2.0.0-dev.7.3.0.212138",
+    "@fluidframework/mocha-test-setup": "2.0.0-dev.7.4.0.215366",
     "@fluidframework/tool-utils-previous": "npm:@fluidframework/tool-utils@2.0.0-internal.7.2.0",
     "@microsoft/api-extractor": "^7.38.3",
     "@types/debug": "^4.1.5",
@@ -57,6 +57,7 @@
     "@types/mocha": "^9.1.1",
     "@types/node": "^16.18.38",
     "c8": "^7.7.1",
+    "copyfiles": "^2.4.1",
     "cross-env": "^7.0.3",
     "eslint": "~8.50.0",
     "mocha": "^10.2.0",
@@ -67,14 +68,29 @@
     "rimraf": "^4.4.0",
     "typescript": "~5.1.6"
   },
+  "fluidBuild": {
+    "tasks": {
+      "build:docs": {
+        "dependsOn": [
+          "...",
+          "api-extractor:commonjs",
+          "api-extractor:esnext"
+        ],
+        "script": false
+      }
+    }
+  },
   "typeValidation": {
     "broken": {}
   },
   "scripts": {
+    "api": "fluid-build . --task api",
+    "api-extractor:commonjs": "api-extractor run --local",
+    "api-extractor:esnext": "copyfiles -u 1 \"dist/**/*-@(alpha|beta|public|untrimmed).d.ts\" lib",
     "build": "fluid-build . --task build",
     "build:commonjs": "fluid-build . --task commonjs",
     "build:compile": "fluid-build . --task compile",
-    "build:docs": "api-extractor run --local",
+    "build:docs": "fluid-build . --task api",
     "build:esnext": "tsc --project ./tsconfig.esnext.json",
     "build:genver": "gen-version",
     "build:test": "tsc --project ./src/test/tsconfig.json",
@@ -85,8 +101,8 @@
     "format": "npm run prettier:fix",
     "lint": "npm run prettier && npm run eslint",
     "lint:fix": "npm run prettier:fix && npm run eslint:fix",
-    "prettier": "prettier --check . --ignore-path ../../../.prettierignore",
-    "prettier:fix": "prettier --write . --ignore-path ../../../.prettierignore",
+    "prettier": "prettier --check . --cache --ignore-path ../../../.prettierignore",
+    "prettier:fix": "prettier --write . --cache --ignore-path ../../../.prettierignore",
     "test": "npm run test:mocha",
     "test:coverage": "c8 npm test",
     "test:mocha": "mocha --ignore \"dist/test/types/*\" --recursive dist/test -r node_modules/@fluidframework/mocha-test-setup",

package/src/packageVersion.ts

@@ -6,4 +6,4 @@
  */
 
 export const pkgName = "@fluidframework/tool-utils";
-export const pkgVersion = "2.0.0-dev.7.3.0.212138";
+export const pkgVersion = "2.0.0-dev.7.4.0.215366";