@fluidframework/tool-utils 2.0.0-dev.7.4.0.215930 → 2.0.0-dev.7.4.0.216897

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

@@ -1,92 +1,33 @@
-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>;
+/* Excluded from this release type: gcBlobPrefix */
+
+/* Excluded from this release type: getMicrosoftConfiguration */
+
+/* Excluded from this release type: getNormalizedSnapshot */
+
+/* Excluded from this release type: IAsyncCache */
+
+/* Excluded from this release type: IClientConfig */
+
+/* Excluded from this release type: IOdspTokenManagerCacheKey */
+
+/* Excluded from this release type: IOdspTokens */
+
+/* Excluded from this release type: IResources */
+
+/* Excluded from this release type: ISnapshotNormalizerConfig */
+
+/* Excluded from this release type: loadRC */
+
+/* Excluded from this release type: lockRC */
+
+/* Excluded from this release type: OdspTokenConfig */
+
+/* Excluded from this release type: OdspTokenManager */
+
+/* Excluded from this release type: odspTokensCache */
+
+/* Excluded from this release type: saveRC */
 
 export { }

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

@@ -1,92 +1,33 @@
-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>;
+/* Excluded from this release type: gcBlobPrefix */
+
+/* Excluded from this release type: getMicrosoftConfiguration */
+
+/* Excluded from this release type: getNormalizedSnapshot */
+
+/* Excluded from this release type: IAsyncCache */
+
+/* Excluded from this release type: IClientConfig */
+
+/* Excluded from this release type: IOdspTokenManagerCacheKey */
+
+/* Excluded from this release type: IOdspTokens */
+
+/* Excluded from this release type: IResources */
+
+/* Excluded from this release type: ISnapshotNormalizerConfig */
+
+/* Excluded from this release type: loadRC */
+
+/* Excluded from this release type: lockRC */
+
+/* Excluded from this release type: OdspTokenConfig */
+
+/* Excluded from this release type: OdspTokenManager */
+
+/* Excluded from this release type: odspTokensCache */
+
+/* Excluded from this release type: saveRC */
 
 export { }

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

@@ -1,92 +1,33 @@
-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>;
+/* Excluded from this release type: gcBlobPrefix */
+
+/* Excluded from this release type: getMicrosoftConfiguration */
+
+/* Excluded from this release type: getNormalizedSnapshot */
+
+/* Excluded from this release type: IAsyncCache */
+
+/* Excluded from this release type: IClientConfig */
+
+/* Excluded from this release type: IOdspTokenManagerCacheKey */
+
+/* Excluded from this release type: IOdspTokens */
+
+/* Excluded from this release type: IResources */
+
+/* Excluded from this release type: ISnapshotNormalizerConfig */
+
+/* Excluded from this release type: loadRC */
+
+/* Excluded from this release type: lockRC */
+
+/* Excluded from this release type: OdspTokenConfig */
+
+/* Excluded from this release type: OdspTokenManager */
+
+/* Excluded from this release type: odspTokensCache */
+
+/* Excluded from this release type: saveRC */
 
 export { }

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

@@ -2,9 +2,16 @@ 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. */
+/**
+ * The prefix that all GC blob names start with.
+ *
+ * @internal
+ */
 export declare const gcBlobPrefix = "__gc";
 
+/**
+ * @internal
+ */
 export declare const getMicrosoftConfiguration: () => IClientConfig;
 
 /**
@@ -15,20 +22,30 @@ export declare const getMicrosoftConfiguration: () => IClientConfig;
  * @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.
+ * @internal
  */
 export declare function getNormalizedSnapshot(snapshot: ITree, config?: ISnapshotNormalizerConfig): ITree;
 
+/**
+ * @internal
+ */
 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>;
 }
 
+/**
+ * @internal
+ */
 export declare interface IOdspTokenManagerCacheKey {
     readonly isPush: boolean;
     readonly userOrServer: string;
 }
 
+/**
+ * @internal
+ */
 export declare interface IResources {
     tokens?: {
         version?: number;
@@ -41,6 +58,9 @@ export declare interface IResources {
     };
 }
 
+/**
+ * @internal
+ */
 export declare interface ISnapshotNormalizerConfig {
     blobsToNormalize?: string[];
     /**
@@ -51,10 +71,19 @@ export declare interface ISnapshotNormalizerConfig {
     excludedChannelContentTypes?: string[];
 }
 
+/**
+ * @internal
+ */
 export declare function loadRC(): Promise<IResources>;
 
+/**
+ * @internal
+ */
 export declare function lockRC(): Promise<any>;
 
+/**
+ * @internal
+ */
 export declare type OdspTokenConfig = {
     type: "password";
     username: string;
@@ -65,6 +94,9 @@ export declare type OdspTokenConfig = {
     redirectUriCallback?: (tokens: IOdspTokens) => Promise<string>;
 };
 
+/**
+ * @internal
+ */
 export declare class OdspTokenManager {
     private readonly tokenCache?;
     private readonly storageCache;
@@ -85,8 +117,14 @@ export declare class OdspTokenManager {
     private extractAuthorizationCode;
 }
 
+/**
+ * @internal
+ */
 export declare const odspTokensCache: IAsyncCache<IOdspTokenManagerCacheKey, IOdspTokens>;
 
+/**
+ * @internal
+ */
 export declare function saveRC(rc: IResources): Promise<void>;
 
 export { }

package/lib/fluidToolRC.d.ts

@@ -3,11 +3,17 @@
  * Licensed under the MIT License.
  */
 import { IOdspTokens } from "@fluidframework/odsp-doclib-utils";
+/**
+ * @internal
+ */
 export interface IAsyncCache<TKey, TValue> {
     get(key: TKey): Promise<TValue | undefined>;
     save(key: TKey, value: TValue): Promise<void>;
     lock<T>(callback: () => Promise<T>): Promise<T>;
 }
+/**
+ * @internal
+ */
 export interface IResources {
     tokens?: {
         version?: number;
@@ -19,7 +25,16 @@ export interface IResources {
         };
     };
 }
+/**
+ * @internal
+ */
 export declare function loadRC(): Promise<IResources>;
+/**
+ * @internal
+ */
 export declare function saveRC(rc: IResources): Promise<void>;
+/**
+ * @internal
+ */
 export declare function lockRC(): Promise<any>;
 //# sourceMappingURL=fluidToolRC.d.ts.map

package/lib/fluidToolRC.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"fluidToolRC.d.ts","sourceRoot":"","sources":["../src/fluidToolRC.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAOH,OAAO,EAAE,WAAW,EAAE,MAAM,mCAAmC,CAAC;AAEhE,MAAM,WAAW,WAAW,CAAC,IAAI,EAAE,MAAM;IACxC,GAAG,CAAC,GAAG,EAAE,IAAI,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAAC;IAC5C,IAAI,CAAC,GAAG,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC9C,IAAI,CAAC,CAAC,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;CAChD;AAED,MAAM,WAAW,UAAU;IAC1B,MAAM,CAAC,EAAE;QACR,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,IAAI,EAAE;YACL,CAAC,GAAG,EAAE,MAAM,GAAG;gBACd,OAAO,CAAC,EAAE,WAAW,CAAC;gBACtB,IAAI,CAAC,EAAE,WAAW,CAAC;aACnB,CAAC;SACF,CAAC;KACF,CAAC;CACF;AAID,wBAAsB,MAAM,IAAI,OAAO,CAAC,UAAU,CAAC,CAclD;AAED,wBAAsB,MAAM,CAAC,EAAE,EAAE,UAAU,iBAI1C;AAED,wBAAsB,MAAM,iBAS3B"}
+{"version":3,"file":"fluidToolRC.d.ts","sourceRoot":"","sources":["../src/fluidToolRC.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAOH,OAAO,EAAE,WAAW,EAAE,MAAM,mCAAmC,CAAC;AAEhE;;GAEG;AACH,MAAM,WAAW,WAAW,CAAC,IAAI,EAAE,MAAM;IACxC,GAAG,CAAC,GAAG,EAAE,IAAI,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAAC;IAC5C,IAAI,CAAC,GAAG,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC9C,IAAI,CAAC,CAAC,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;CAChD;AAED;;GAEG;AACH,MAAM,WAAW,UAAU;IAC1B,MAAM,CAAC,EAAE;QACR,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,IAAI,EAAE;YACL,CAAC,GAAG,EAAE,MAAM,GAAG;gBACd,OAAO,CAAC,EAAE,WAAW,CAAC;gBACtB,IAAI,CAAC,EAAE,WAAW,CAAC;aACnB,CAAC;SACF,CAAC;KACF,CAAC;CACF;AAID;;GAEG;AACH,wBAAsB,MAAM,IAAI,OAAO,CAAC,UAAU,CAAC,CAclD;AAED;;GAEG;AACH,wBAAsB,MAAM,CAAC,EAAE,EAAE,UAAU,iBAI1C;AAED;;GAEG;AACH,wBAAsB,MAAM,iBAS3B"}

package/lib/fluidToolRC.js

@@ -8,6 +8,9 @@ import path from "path";
 import util from "util";
 import { lock } from "proper-lockfile";
 const getRCFileName = () => path.join(os.homedir(), ".fluidtoolrc");
+/**
+ * @internal
+ */
 export async function loadRC() {
     const readFile = util.promisify(fs.readFile);
     const exists = util.promisify(fs.exists);
@@ -24,11 +27,17 @@ export async function loadRC() {
     }
     return {};
 }
+/**
+ * @internal
+ */
 export async function saveRC(rc) {
     const writeFile = util.promisify(fs.writeFile);
     const content = JSON.stringify(rc, undefined, 2);
     return writeFile(getRCFileName(), Buffer.from(content, "utf8"));
 }
+/**
+ * @internal
+ */
 export async function lockRC() {
     // eslint-disable-next-line @typescript-eslint/no-unsafe-return
     return lock(getRCFileName(), {

package/lib/fluidToolRC.js.map

@@ -1 +1 @@
-{"version":3,"file":"fluidToolRC.js","sourceRoot":"","sources":["../src/fluidToolRC.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,MAAM,IAAI,CAAC;AACpB,OAAO,EAAE,MAAM,IAAI,CAAC;AACpB,OAAO,IAAI,MAAM,MAAM,CAAC;AACxB,OAAO,IAAI,MAAM,MAAM,CAAC;AACxB,OAAO,EAAE,IAAI,EAAE,MAAM,iBAAiB,CAAC;AAqBvC,MAAM,aAAa,GAAG,GAAG,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,OAAO,EAAE,EAAE,cAAc,CAAC,CAAC;AAEpE,MAAM,CAAC,KAAK,UAAU,MAAM;IAC3B,MAAM,QAAQ,GAAG,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,QAAQ,CAAC,CAAC;IAC7C,MAAM,MAAM,GAAG,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,MAAM,CAAC,CAAC;IACzC,MAAM,QAAQ,GAAG,aAAa,EAAE,CAAC;IACjC,IAAI,MAAM,MAAM,CAAC,QAAQ,CAAC,EAAE;QAC3B,MAAM,GAAG,GAAG,MAAM,QAAQ,CAAC,QAAQ,CAAC,CAAC;QACrC,IAAI;YACH,+DAA+D;YAC/D,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC;SACxC;QAAC,OAAO,CAAC,EAAE;YACX,UAAU;SACV;KACD;IACD,OAAO,EAAE,CAAC;AACX,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,MAAM,CAAC,EAAc;IAC1C,MAAM,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,SAAS,CAAC,CAAC;IAC/C,MAAM,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,EAAE,EAAE,SAAS,EAAE,CAAC,CAAC,CAAC;IACjD,OAAO,SAAS,CAAC,aAAa,EAAE,EAAE,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC,CAAC;AACjE,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,MAAM;IAC3B,+DAA+D;IAC/D,OAAO,IAAI,CAAC,aAAa,EAAE,EAAE;QAC5B,OAAO,EAAE;YACR,OAAO,EAAE,IAAI;SACb;QACD,KAAK,EAAE,KAAK;QACZ,QAAQ,EAAE,KAAK;KACf,CAAC,CAAC;AACJ,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport fs from \"fs\";\nimport os from \"os\";\nimport path from \"path\";\nimport util from \"util\";\nimport { lock } from \"proper-lockfile\";\nimport { IOdspTokens } from \"@fluidframework/odsp-doclib-utils\";\n\nexport interface IAsyncCache<TKey, TValue> {\n\tget(key: TKey): Promise<TValue | undefined>;\n\tsave(key: TKey, value: TValue): Promise<void>;\n\tlock<T>(callback: () => Promise<T>): Promise<T>;\n}\n\nexport interface IResources {\n\ttokens?: {\n\t\tversion?: number;\n\t\tdata: {\n\t\t\t[key: string]: {\n\t\t\t\tstorage?: IOdspTokens;\n\t\t\t\tpush?: IOdspTokens;\n\t\t\t};\n\t\t};\n\t};\n}\n\nconst getRCFileName = () => path.join(os.homedir(), \".fluidtoolrc\");\n\nexport async function loadRC(): Promise<IResources> {\n\tconst readFile = util.promisify(fs.readFile);\n\tconst exists = util.promisify(fs.exists);\n\tconst fileName = getRCFileName();\n\tif (await exists(fileName)) {\n\t\tconst buf = await readFile(fileName);\n\t\ttry {\n\t\t\t// eslint-disable-next-line @typescript-eslint/no-unsafe-return\n\t\t\treturn JSON.parse(buf.toString(\"utf8\"));\n\t\t} catch (e) {\n\t\t\t// Nothing\n\t\t}\n\t}\n\treturn {};\n}\n\nexport async function saveRC(rc: IResources) {\n\tconst writeFile = util.promisify(fs.writeFile);\n\tconst content = JSON.stringify(rc, undefined, 2);\n\treturn writeFile(getRCFileName(), Buffer.from(content, \"utf8\"));\n}\n\nexport async function lockRC() {\n\t// eslint-disable-next-line @typescript-eslint/no-unsafe-return\n\treturn lock(getRCFileName(), {\n\t\tretries: {\n\t\t\tforever: true,\n\t\t},\n\t\tstale: 60000,\n\t\trealpath: false,\n\t});\n}\n"]}
+{"version":3,"file":"fluidToolRC.js","sourceRoot":"","sources":["../src/fluidToolRC.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,MAAM,IAAI,CAAC;AACpB,OAAO,EAAE,MAAM,IAAI,CAAC;AACpB,OAAO,IAAI,MAAM,MAAM,CAAC;AACxB,OAAO,IAAI,MAAM,MAAM,CAAC;AACxB,OAAO,EAAE,IAAI,EAAE,MAAM,iBAAiB,CAAC;AA2BvC,MAAM,aAAa,GAAG,GAAG,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,OAAO,EAAE,EAAE,cAAc,CAAC,CAAC;AAEpE;;GAEG;AACH,MAAM,CAAC,KAAK,UAAU,MAAM;IAC3B,MAAM,QAAQ,GAAG,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,QAAQ,CAAC,CAAC;IAC7C,MAAM,MAAM,GAAG,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,MAAM,CAAC,CAAC;IACzC,MAAM,QAAQ,GAAG,aAAa,EAAE,CAAC;IACjC,IAAI,MAAM,MAAM,CAAC,QAAQ,CAAC,EAAE;QAC3B,MAAM,GAAG,GAAG,MAAM,QAAQ,CAAC,QAAQ,CAAC,CAAC;QACrC,IAAI;YACH,+DAA+D;YAC/D,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC;SACxC;QAAC,OAAO,CAAC,EAAE;YACX,UAAU;SACV;KACD;IACD,OAAO,EAAE,CAAC;AACX,CAAC;AAED;;GAEG;AACH,MAAM,CAAC,KAAK,UAAU,MAAM,CAAC,EAAc;IAC1C,MAAM,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,SAAS,CAAC,CAAC;IAC/C,MAAM,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,EAAE,EAAE,SAAS,EAAE,CAAC,CAAC,CAAC;IACjD,OAAO,SAAS,CAAC,aAAa,EAAE,EAAE,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC,CAAC;AACjE,CAAC;AAED;;GAEG;AACH,MAAM,CAAC,KAAK,UAAU,MAAM;IAC3B,+DAA+D;IAC/D,OAAO,IAAI,CAAC,aAAa,EAAE,EAAE;QAC5B,OAAO,EAAE;YACR,OAAO,EAAE,IAAI;SACb;QACD,KAAK,EAAE,KAAK;QACZ,QAAQ,EAAE,KAAK;KACf,CAAC,CAAC;AACJ,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport fs from \"fs\";\nimport os from \"os\";\nimport path from \"path\";\nimport util from \"util\";\nimport { lock } from \"proper-lockfile\";\nimport { IOdspTokens } from \"@fluidframework/odsp-doclib-utils\";\n\n/**\n * @internal\n */\nexport interface IAsyncCache<TKey, TValue> {\n\tget(key: TKey): Promise<TValue | undefined>;\n\tsave(key: TKey, value: TValue): Promise<void>;\n\tlock<T>(callback: () => Promise<T>): Promise<T>;\n}\n\n/**\n * @internal\n */\nexport interface IResources {\n\ttokens?: {\n\t\tversion?: number;\n\t\tdata: {\n\t\t\t[key: string]: {\n\t\t\t\tstorage?: IOdspTokens;\n\t\t\t\tpush?: IOdspTokens;\n\t\t\t};\n\t\t};\n\t};\n}\n\nconst getRCFileName = () => path.join(os.homedir(), \".fluidtoolrc\");\n\n/**\n * @internal\n */\nexport async function loadRC(): Promise<IResources> {\n\tconst readFile = util.promisify(fs.readFile);\n\tconst exists = util.promisify(fs.exists);\n\tconst fileName = getRCFileName();\n\tif (await exists(fileName)) {\n\t\tconst buf = await readFile(fileName);\n\t\ttry {\n\t\t\t// eslint-disable-next-line @typescript-eslint/no-unsafe-return\n\t\t\treturn JSON.parse(buf.toString(\"utf8\"));\n\t\t} catch (e) {\n\t\t\t// Nothing\n\t\t}\n\t}\n\treturn {};\n}\n\n/**\n * @internal\n */\nexport async function saveRC(rc: IResources) {\n\tconst writeFile = util.promisify(fs.writeFile);\n\tconst content = JSON.stringify(rc, undefined, 2);\n\treturn writeFile(getRCFileName(), Buffer.from(content, \"utf8\"));\n}\n\n/**\n * @internal\n */\nexport async function lockRC() {\n\t// eslint-disable-next-line @typescript-eslint/no-unsafe-return\n\treturn lock(getRCFileName(), {\n\t\tretries: {\n\t\t\tforever: true,\n\t\t},\n\t\tstale: 60000,\n\t\trealpath: false,\n\t});\n}\n"]}

package/lib/odspTokenManager.d.ts

@@ -4,7 +4,13 @@
  */
 import { IOdspTokens, IClientConfig } from "@fluidframework/odsp-doclib-utils";
 import { IAsyncCache } from "./fluidToolRC";
+/**
+ * @internal
+ */
 export declare const getMicrosoftConfiguration: () => IClientConfig;
+/**
+ * @internal
+ */
 export type OdspTokenConfig = {
     type: "password";
     username: string;
@@ -14,10 +20,16 @@ export type OdspTokenConfig = {
     navigator: (url: string) => void;
     redirectUriCallback?: (tokens: IOdspTokens) => Promise<string>;
 };
+/**
+ * @internal
+ */
 export interface IOdspTokenManagerCacheKey {
     readonly isPush: boolean;
     readonly userOrServer: string;
 }
+/**
+ * @internal
+ */
 export declare class OdspTokenManager {
     private readonly tokenCache?;
     private readonly storageCache;
@@ -37,5 +49,8 @@ export declare class OdspTokenManager {
     private onTokenRetrievalFromCache;
     private extractAuthorizationCode;
 }
+/**
+ * @internal
+ */
 export declare const odspTokensCache: IAsyncCache<IOdspTokenManagerCacheKey, IOdspTokens>;
 //# sourceMappingURL=odspTokenManager.d.ts.map

package/lib/odspTokenManager.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"odspTokenManager.d.ts","sourceRoot":"","sources":["../src/odspTokenManager.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EACN,WAAW,EACX,aAAa,EAOb,MAAM,mCAAmC,CAAC;AAI3C,OAAO,EAAE,WAAW,EAA0B,MAAM,eAAe,CAAC;AAOpE,eAAO,MAAM,yBAAyB,QAAO,aAe3C,CAAC;AAEH,MAAM,MAAM,eAAe,GACxB;IACA,IAAI,EAAE,UAAU,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;CAChB,GACD;IACA,IAAI,EAAE,cAAc,CAAC;IACrB,SAAS,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,IAAI,CAAC;IACjC,mBAAmB,CAAC,EAAE,CAAC,MAAM,EAAE,WAAW,KAAK,OAAO,CAAC,MAAM,CAAC,CAAC;CAC9D,CAAC;AAEL,MAAM,WAAW,yBAAyB;IACzC,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC;IACzB,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;CAC9B;AAiBD,qBAAa,gBAAgB;IAK3B,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAC;IAJ7B,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAkC;IAC/D,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAkC;IAC5D,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAe;gBAExB,UAAU,CAAC,iEAAqD;IAGrE,iBAAiB,CAAC,GAAG,EAAE,yBAAyB,EAAE,KAAK,EAAE,WAAW;YAMnE,4BAA4B;IAO7B,aAAa,CACzB,MAAM,EAAE,MAAM,EACd,YAAY,EAAE,aAAa,EAC3B,WAAW,EAAE,eAAe,EAC5B,YAAY,UAAQ,EACpB,WAAW,UAAQ,GACjB,OAAO,CAAC,WAAW,CAAC;IAIV,aAAa,CACzB,MAAM,EAAE,MAAM,EACd,YAAY,EAAE,aAAa,EAC3B,WAAW,EAAE,eAAe,EAC5B,YAAY,UAAQ,EACpB,WAAW,UAAQ,GACjB,OAAO,CAAC,WAAW,CAAC;YAIT,iBAAiB;IAe/B,OAAO,CAAC,MAAM,CAAC,WAAW;YAYZ,SAAS;YA0CT,aAAa;YA+Db,yBAAyB;YAezB,4BAA4B;YAuC5B,yBAAyB;IAMvC,OAAO,CAAC,wBAAwB;CAWhC;AAYD,eAAO,MAAM,eAAe,EAAE,WAAW,CAAC,yBAAyB,EAAE,WAAW,CA6B/E,CAAC"}
+{"version":3,"file":"odspTokenManager.d.ts","sourceRoot":"","sources":["../src/odspTokenManager.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EACN,WAAW,EACX,aAAa,EAOb,MAAM,mCAAmC,CAAC;AAI3C,OAAO,EAAE,WAAW,EAA0B,MAAM,eAAe,CAAC;AAOpE;;GAEG;AACH,eAAO,MAAM,yBAAyB,QAAO,aAe3C,CAAC;AAEH;;GAEG;AACH,MAAM,MAAM,eAAe,GACxB;IACA,IAAI,EAAE,UAAU,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;CAChB,GACD;IACA,IAAI,EAAE,cAAc,CAAC;IACrB,SAAS,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,IAAI,CAAC;IACjC,mBAAmB,CAAC,EAAE,CAAC,MAAM,EAAE,WAAW,KAAK,OAAO,CAAC,MAAM,CAAC,CAAC;CAC9D,CAAC;AAEL;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACzC,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC;IACzB,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;CAC9B;AAiBD;;GAEG;AACH,qBAAa,gBAAgB;IAK3B,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAC;IAJ7B,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAkC;IAC/D,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAkC;IAC5D,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAe;gBAExB,UAAU,CAAC,iEAAqD;IAGrE,iBAAiB,CAAC,GAAG,EAAE,yBAAyB,EAAE,KAAK,EAAE,WAAW;YAMnE,4BAA4B;IAO7B,aAAa,CACzB,MAAM,EAAE,MAAM,EACd,YAAY,EAAE,aAAa,EAC3B,WAAW,EAAE,eAAe,EAC5B,YAAY,UAAQ,EACpB,WAAW,UAAQ,GACjB,OAAO,CAAC,WAAW,CAAC;IAIV,aAAa,CACzB,MAAM,EAAE,MAAM,EACd,YAAY,EAAE,aAAa,EAC3B,WAAW,EAAE,eAAe,EAC5B,YAAY,UAAQ,EACpB,WAAW,UAAQ,GACjB,OAAO,CAAC,WAAW,CAAC;YAIT,iBAAiB;IAe/B,OAAO,CAAC,MAAM,CAAC,WAAW;YAYZ,SAAS;YA0CT,aAAa;YA+Db,yBAAyB;YAezB,4BAA4B;YAuC5B,yBAAyB;IAMvC,OAAO,CAAC,wBAAwB;CAWhC;AAYD;;GAEG;AACH,eAAO,MAAM,eAAe,EAAE,WAAW,CAAC,yBAAyB,EAAE,WAAW,CA6B/E,CAAC"}

package/lib/odspTokenManager.js

@@ -12,6 +12,9 @@ import { serverListenAndHandle, endResponse } from "./httpHelpers";
 const odspAuthRedirectPort = 7000;
 const odspAuthRedirectOrigin = `http://localhost:${odspAuthRedirectPort}`;
 const odspAuthRedirectUri = new URL("/auth/callback", odspAuthRedirectOrigin).href;
+/**
+ * @internal
+ */
 export const getMicrosoftConfiguration = () => ({
     get clientId() {
         if (!process.env.login__microsoft__clientId) {
@@ -38,6 +41,9 @@ const isValidToken = (token) => {
 const cacheKeyToString = (key) => {
     return `${key.userOrServer}${key.isPush ? "[Push]" : ""}`;
 };
+/**
+ * @internal
+ */
 export class OdspTokenManager {
     constructor(tokenCache) {
         this.tokenCache = tokenCache;
@@ -212,6 +218,9 @@ async function loadAndPatchRC() {
     }
     return rc;
 }
+/**
+ * @internal
+ */
 export const odspTokensCache = {
     async get(key) {
         const rc = await loadAndPatchRC();