@fluidframework/tool-utils 2.0.0-dev-rc.3.0.0.254513 → 2.0.0-dev-rc.3.0.0.254674

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,9 @@
1
+ /*!
2
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
3
+ * Licensed under the MIT License.
4
+ */
5
+
6
+ /*
7
+ * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
8
+ * Generated by "flub generate entrypoints" in @fluidframework/build-tools.
9
+ */
package/dist/beta.d.ts ADDED
@@ -0,0 +1,9 @@
1
+ /*!
2
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
3
+ * Licensed under the MIT License.
4
+ */
5
+
6
+ /*
7
+ * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
8
+ * Generated by "flub generate entrypoints" in @fluidframework/build-tools.
9
+ */
@@ -5,5 +5,5 @@
5
5
  * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY
6
6
  */
7
7
  export declare const pkgName = "@fluidframework/tool-utils";
8
- export declare const pkgVersion = "2.0.0-dev-rc.3.0.0.254513";
8
+ export declare const pkgVersion = "2.0.0-dev-rc.3.0.0.254674";
9
9
  //# sourceMappingURL=packageVersion.d.ts.map
@@ -8,5 +8,5 @@
8
8
  Object.defineProperty(exports, "__esModule", { value: true });
9
9
  exports.pkgVersion = exports.pkgName = void 0;
10
10
  exports.pkgName = "@fluidframework/tool-utils";
11
- exports.pkgVersion = "2.0.0-dev-rc.3.0.0.254513";
11
+ exports.pkgVersion = "2.0.0-dev-rc.3.0.0.254674";
12
12
  //# sourceMappingURL=packageVersion.js.map
@@ -1 +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,2BAA2B,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-rc.3.0.0.254513\";\n"]}
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,2BAA2B,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-rc.3.0.0.254674\";\n"]}
@@ -0,0 +1,9 @@
1
+ /*!
2
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
3
+ * Licensed under the MIT License.
4
+ */
5
+
6
+ /*
7
+ * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
8
+ * Generated by "flub generate entrypoints" in @fluidframework/build-tools.
9
+ */
package/lib/alpha.d.ts ADDED
@@ -0,0 +1,9 @@
1
+ /*!
2
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
3
+ * Licensed under the MIT License.
4
+ */
5
+
6
+ /*
7
+ * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
8
+ * Generated by "flub generate entrypoints" in @fluidframework/build-tools.
9
+ */
package/lib/beta.d.ts ADDED
@@ -0,0 +1,9 @@
1
+ /*!
2
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
3
+ * Licensed under the MIT License.
4
+ */
5
+
6
+ /*
7
+ * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
8
+ * Generated by "flub generate entrypoints" in @fluidframework/build-tools.
9
+ */
@@ -5,5 +5,5 @@
5
5
  * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY
6
6
  */
7
7
  export declare const pkgName = "@fluidframework/tool-utils";
8
- export declare const pkgVersion = "2.0.0-dev-rc.3.0.0.254513";
8
+ export declare const pkgVersion = "2.0.0-dev-rc.3.0.0.254674";
9
9
  //# sourceMappingURL=packageVersion.d.ts.map
@@ -5,5 +5,5 @@
5
5
  * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY
6
6
  */
7
7
  export const pkgName = "@fluidframework/tool-utils";
8
- export const pkgVersion = "2.0.0-dev-rc.3.0.0.254513";
8
+ export const pkgVersion = "2.0.0-dev-rc.3.0.0.254674";
9
9
  //# sourceMappingURL=packageVersion.js.map
@@ -1 +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,2BAA2B,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-rc.3.0.0.254513\";\n"]}
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,2BAA2B,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-rc.3.0.0.254674\";\n"]}
@@ -0,0 +1,9 @@
1
+ /*!
2
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
3
+ * Licensed under the MIT License.
4
+ */
5
+
6
+ /*
7
+ * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
8
+ * Generated by "flub generate entrypoints" in @fluidframework/build-tools.
9
+ */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@fluidframework/tool-utils",
3
- "version": "2.0.0-dev-rc.3.0.0.254513",
3
+ "version": "2.0.0-dev-rc.3.0.0.254674",
4
4
  "description": "Common utilities for Fluid tools",
5
5
  "homepage": "https://fluidframework.com",
6
6
  "repository": {
@@ -15,11 +15,11 @@
15
15
  "exports": {
16
16
  ".": {
17
17
  "import": {
18
- "types": "./lib/tool-utils-public.d.ts",
18
+ "types": "./lib/public.d.ts",
19
19
  "default": "./lib/index.js"
20
20
  },
21
21
  "require": {
22
- "types": "./dist/tool-utils-public.d.ts",
22
+ "types": "./dist/public.d.ts",
23
23
  "default": "./dist/index.js"
24
24
  }
25
25
  },
@@ -35,7 +35,7 @@
35
35
  }
36
36
  },
37
37
  "main": "dist/index.js",
38
- "types": "./dist/tool-utils-public.d.ts",
38
+ "types": "./dist/public.d.ts",
39
39
  "c8": {
40
40
  "all": true,
41
41
  "cache-dir": "nyc/.cache",
@@ -57,9 +57,9 @@
57
57
  "temp-directory": "nyc/.nyc_output"
58
58
  },
59
59
  "dependencies": {
60
- "@fluidframework/core-utils": "2.0.0-dev-rc.3.0.0.254513",
61
- "@fluidframework/driver-utils": "2.0.0-dev-rc.3.0.0.254513",
62
- "@fluidframework/odsp-doclib-utils": "2.0.0-dev-rc.3.0.0.254513",
60
+ "@fluidframework/core-utils": "2.0.0-dev-rc.3.0.0.254674",
61
+ "@fluidframework/driver-utils": "2.0.0-dev-rc.3.0.0.254674",
62
+ "@fluidframework/odsp-doclib-utils": "2.0.0-dev-rc.3.0.0.254674",
63
63
  "@fluidframework/protocol-definitions": "^3.2.0",
64
64
  "async-mutex": "^0.3.1",
65
65
  "debug": "^4.3.4",
@@ -69,7 +69,7 @@
69
69
  "devDependencies": {
70
70
  "@arethetypeswrong/cli": "^0.15.2",
71
71
  "@biomejs/biome": "^1.6.2",
72
- "@fluid-internal/mocha-test-setup": "2.0.0-dev-rc.3.0.0.254513",
72
+ "@fluid-internal/mocha-test-setup": "2.0.0-dev-rc.3.0.0.254674",
73
73
  "@fluid-tools/build-cli": "^0.35.0",
74
74
  "@fluidframework/build-common": "^2.0.3",
75
75
  "@fluidframework/build-tools": "^0.35.0",
@@ -91,29 +91,17 @@
91
91
  "rimraf": "^4.4.0",
92
92
  "typescript": "~5.1.6"
93
93
  },
94
- "fluidBuild": {
95
- "tasks": {
96
- "build:docs": {
97
- "dependsOn": [
98
- "...",
99
- "api-extractor:commonjs",
100
- "api-extractor:esnext"
101
- ],
102
- "script": false
103
- }
104
- }
105
- },
106
94
  "typeValidation": {
107
95
  "broken": {}
108
96
  },
109
97
  "scripts": {
110
98
  "api": "fluid-build . --task api",
111
- "api-extractor:commonjs": "api-extractor run --config ./api-extractor-cjs.json",
112
- "api-extractor:esnext": "api-extractor run --local",
99
+ "api-extractor:commonjs": "flub generate entrypoints --outDir ./dist",
100
+ "api-extractor:esnext": "flub generate entrypoints --outDir ./lib",
113
101
  "build": "fluid-build . --task build",
114
102
  "build:commonjs": "fluid-build . --task commonjs",
115
103
  "build:compile": "fluid-build . --task compile",
116
- "build:docs": "fluid-build . --task api",
104
+ "build:docs": "api-extractor run --local",
117
105
  "build:esnext": "tsc --project ./tsconfig.json",
118
106
  "build:genver": "gen-version",
119
107
  "build:test": "npm run build:test:esm && npm run build:test:cjs",
@@ -6,4 +6,4 @@
6
6
  */
7
7
 
8
8
  export const pkgName = "@fluidframework/tool-utils";
9
- export const pkgVersion = "2.0.0-dev-rc.3.0.0.254513";
9
+ export const pkgVersion = "2.0.0-dev-rc.3.0.0.254674";
@@ -1,8 +0,0 @@
1
- {
2
- "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
3
- "extends": "../../../common/build/build-common/api-extractor-base.cjs.primary.json",
4
- // CJS is actually secondary; so, no report.
5
- "apiReport": {
6
- "enabled": false
7
- }
8
- }
@@ -1,35 +0,0 @@
1
- import { IClientConfig } from '@fluidframework/odsp-doclib-utils/internal';
2
- import { IOdspTokens } from '@fluidframework/odsp-doclib-utils/internal';
3
- import { ITree } from '@fluidframework/protocol-definitions';
4
-
5
- /* Excluded from this release type: gcBlobPrefix */
6
-
7
- /* Excluded from this release type: getMicrosoftConfiguration */
8
-
9
- /* Excluded from this release type: getNormalizedSnapshot */
10
-
11
- /* Excluded from this release type: IAsyncCache */
12
-
13
- /* Excluded from this release type: IClientConfig */
14
-
15
- /* Excluded from this release type: IOdspTokenManagerCacheKey */
16
-
17
- /* Excluded from this release type: IOdspTokens */
18
-
19
- /* Excluded from this release type: IResources */
20
-
21
- /* Excluded from this release type: ISnapshotNormalizerConfig */
22
-
23
- /* Excluded from this release type: loadRC */
24
-
25
- /* Excluded from this release type: lockRC */
26
-
27
- /* Excluded from this release type: OdspTokenConfig */
28
-
29
- /* Excluded from this release type: OdspTokenManager */
30
-
31
- /* Excluded from this release type: odspTokensCache */
32
-
33
- /* Excluded from this release type: saveRC */
34
-
35
- export { }
@@ -1,35 +0,0 @@
1
- import { IClientConfig } from '@fluidframework/odsp-doclib-utils/internal';
2
- import { IOdspTokens } from '@fluidframework/odsp-doclib-utils/internal';
3
- import { ITree } from '@fluidframework/protocol-definitions';
4
-
5
- /* Excluded from this release type: gcBlobPrefix */
6
-
7
- /* Excluded from this release type: getMicrosoftConfiguration */
8
-
9
- /* Excluded from this release type: getNormalizedSnapshot */
10
-
11
- /* Excluded from this release type: IAsyncCache */
12
-
13
- /* Excluded from this release type: IClientConfig */
14
-
15
- /* Excluded from this release type: IOdspTokenManagerCacheKey */
16
-
17
- /* Excluded from this release type: IOdspTokens */
18
-
19
- /* Excluded from this release type: IResources */
20
-
21
- /* Excluded from this release type: ISnapshotNormalizerConfig */
22
-
23
- /* Excluded from this release type: loadRC */
24
-
25
- /* Excluded from this release type: lockRC */
26
-
27
- /* Excluded from this release type: OdspTokenConfig */
28
-
29
- /* Excluded from this release type: OdspTokenManager */
30
-
31
- /* Excluded from this release type: odspTokensCache */
32
-
33
- /* Excluded from this release type: saveRC */
34
-
35
- export { }
@@ -1,35 +0,0 @@
1
- import { IClientConfig } from '@fluidframework/odsp-doclib-utils/internal';
2
- import { IOdspTokens } from '@fluidframework/odsp-doclib-utils/internal';
3
- import { ITree } from '@fluidframework/protocol-definitions';
4
-
5
- /* Excluded from this release type: gcBlobPrefix */
6
-
7
- /* Excluded from this release type: getMicrosoftConfiguration */
8
-
9
- /* Excluded from this release type: getNormalizedSnapshot */
10
-
11
- /* Excluded from this release type: IAsyncCache */
12
-
13
- /* Excluded from this release type: IClientConfig */
14
-
15
- /* Excluded from this release type: IOdspTokenManagerCacheKey */
16
-
17
- /* Excluded from this release type: IOdspTokens */
18
-
19
- /* Excluded from this release type: IResources */
20
-
21
- /* Excluded from this release type: ISnapshotNormalizerConfig */
22
-
23
- /* Excluded from this release type: loadRC */
24
-
25
- /* Excluded from this release type: lockRC */
26
-
27
- /* Excluded from this release type: OdspTokenConfig */
28
-
29
- /* Excluded from this release type: OdspTokenManager */
30
-
31
- /* Excluded from this release type: odspTokensCache */
32
-
33
- /* Excluded from this release type: saveRC */
34
-
35
- export { }
@@ -1,130 +0,0 @@
1
- import { IClientConfig } from '@fluidframework/odsp-doclib-utils/internal';
2
- import { IOdspTokens } from '@fluidframework/odsp-doclib-utils/internal';
3
- import { ITree } from '@fluidframework/protocol-definitions';
4
-
5
- /**
6
- * The prefix that all GC blob names start with.
7
- *
8
- * @internal
9
- */
10
- export declare const gcBlobPrefix = "__gc";
11
-
12
- /**
13
- * @internal
14
- */
15
- export declare const getMicrosoftConfiguration: () => IClientConfig;
16
-
17
- /**
18
- * Helper function that normalizes the given snapshot tree. It sorts objects and arrays in the snapshot. It also
19
- * normalizes certain blob contents for which the order of content does not matter. For example, garbage collection
20
- * blobs contains objects / arrays whose element order do not matter.
21
- * @param snapshot - The snapshot tree to normalize.
22
- * @param config - Configs to use when normalizing snapshot. For example, it can contain paths of blobs whose contents
23
- * should be normalized as well.
24
- * @returns a copy of the normalized snapshot tree.
25
- * @internal
26
- */
27
- export declare function getNormalizedSnapshot(snapshot: ITree, config?: ISnapshotNormalizerConfig): ITree;
28
-
29
- /**
30
- * @internal
31
- */
32
- export declare interface IAsyncCache<TKey, TValue> {
33
- get(key: TKey): Promise<TValue | undefined>;
34
- save(key: TKey, value: TValue): Promise<void>;
35
- lock<T>(callback: () => Promise<T>): Promise<T>;
36
- }
37
-
38
- /**
39
- * @internal
40
- */
41
- export declare interface IOdspTokenManagerCacheKey {
42
- readonly isPush: boolean;
43
- readonly userOrServer: string;
44
- }
45
-
46
- /**
47
- * @internal
48
- */
49
- export declare interface IResources {
50
- tokens?: {
51
- version?: number;
52
- data: {
53
- [key: string]: {
54
- storage?: IOdspTokens;
55
- push?: IOdspTokens;
56
- };
57
- };
58
- };
59
- }
60
-
61
- /**
62
- * @internal
63
- */
64
- export declare interface ISnapshotNormalizerConfig {
65
- blobsToNormalize?: string[];
66
- /**
67
- * channel types who's content (non-attribute) blobs will be excluded.
68
- * this is used to exclude the content of channels who's content cannot be compared
69
- * as the content is non-deterministic between snapshot at the same sequence number.
70
- */
71
- excludedChannelContentTypes?: string[];
72
- }
73
-
74
- /**
75
- * @internal
76
- */
77
- export declare function loadRC(): Promise<IResources>;
78
-
79
- /**
80
- * @internal
81
- */
82
- export declare function lockRC(): Promise<any>;
83
-
84
- /**
85
- * @internal
86
- */
87
- export declare type OdspTokenConfig = {
88
- type: "password";
89
- username: string;
90
- password: string;
91
- } | {
92
- type: "browserLogin";
93
- navigator: (url: string) => void;
94
- redirectUriCallback?: (tokens: IOdspTokens) => Promise<string>;
95
- };
96
-
97
- /**
98
- * @internal
99
- */
100
- export declare class OdspTokenManager {
101
- private readonly tokenCache?;
102
- private readonly storageCache;
103
- private readonly pushCache;
104
- private readonly cacheMutex;
105
- constructor(tokenCache?: IAsyncCache<IOdspTokenManagerCacheKey, IOdspTokens> | undefined);
106
- updateTokensCache(key: IOdspTokenManagerCacheKey, value: IOdspTokens): Promise<void>;
107
- private updateTokensCacheWithoutLock;
108
- getOdspTokens(server: string, clientConfig: IClientConfig, tokenConfig: OdspTokenConfig, forceRefresh?: boolean, forceReauth?: boolean): Promise<IOdspTokens>;
109
- getPushTokens(server: string, clientConfig: IClientConfig, tokenConfig: OdspTokenConfig, forceRefresh?: boolean, forceReauth?: boolean): Promise<IOdspTokens>;
110
- private getTokenFromCache;
111
- private static getCacheKey;
112
- private getTokens;
113
- private getTokensCore;
114
- private acquireTokensWithPassword;
115
- private acquireTokensViaBrowserLogin;
116
- private onTokenRetrievalFromCache;
117
- private extractAuthorizationCode;
118
- }
119
-
120
- /**
121
- * @internal
122
- */
123
- export declare const odspTokensCache: IAsyncCache<IOdspTokenManagerCacheKey, IOdspTokens>;
124
-
125
- /**
126
- * @internal
127
- */
128
- export declare function saveRC(rc: IResources): Promise<void>;
129
-
130
- export { }
@@ -1,11 +0,0 @@
1
- // This file is read by tools that parse documentation comments conforming to the TSDoc standard.
2
- // It should be published with your NPM package. It should not be tracked by Git.
3
- {
4
- "tsdocVersion": "0.12",
5
- "toolPackages": [
6
- {
7
- "packageName": "@microsoft/api-extractor",
8
- "packageVersion": "7.42.3"
9
- }
10
- ]
11
- }
@@ -1,35 +0,0 @@
1
- import { IClientConfig } from '@fluidframework/odsp-doclib-utils/internal';
2
- import { IOdspTokens } from '@fluidframework/odsp-doclib-utils/internal';
3
- import { ITree } from '@fluidframework/protocol-definitions';
4
-
5
- /* Excluded from this release type: gcBlobPrefix */
6
-
7
- /* Excluded from this release type: getMicrosoftConfiguration */
8
-
9
- /* Excluded from this release type: getNormalizedSnapshot */
10
-
11
- /* Excluded from this release type: IAsyncCache */
12
-
13
- /* Excluded from this release type: IClientConfig */
14
-
15
- /* Excluded from this release type: IOdspTokenManagerCacheKey */
16
-
17
- /* Excluded from this release type: IOdspTokens */
18
-
19
- /* Excluded from this release type: IResources */
20
-
21
- /* Excluded from this release type: ISnapshotNormalizerConfig */
22
-
23
- /* Excluded from this release type: loadRC */
24
-
25
- /* Excluded from this release type: lockRC */
26
-
27
- /* Excluded from this release type: OdspTokenConfig */
28
-
29
- /* Excluded from this release type: OdspTokenManager */
30
-
31
- /* Excluded from this release type: odspTokensCache */
32
-
33
- /* Excluded from this release type: saveRC */
34
-
35
- export { }
@@ -1,35 +0,0 @@
1
- import { IClientConfig } from '@fluidframework/odsp-doclib-utils/internal';
2
- import { IOdspTokens } from '@fluidframework/odsp-doclib-utils/internal';
3
- import { ITree } from '@fluidframework/protocol-definitions';
4
-
5
- /* Excluded from this release type: gcBlobPrefix */
6
-
7
- /* Excluded from this release type: getMicrosoftConfiguration */
8
-
9
- /* Excluded from this release type: getNormalizedSnapshot */
10
-
11
- /* Excluded from this release type: IAsyncCache */
12
-
13
- /* Excluded from this release type: IClientConfig */
14
-
15
- /* Excluded from this release type: IOdspTokenManagerCacheKey */
16
-
17
- /* Excluded from this release type: IOdspTokens */
18
-
19
- /* Excluded from this release type: IResources */
20
-
21
- /* Excluded from this release type: ISnapshotNormalizerConfig */
22
-
23
- /* Excluded from this release type: loadRC */
24
-
25
- /* Excluded from this release type: lockRC */
26
-
27
- /* Excluded from this release type: OdspTokenConfig */
28
-
29
- /* Excluded from this release type: OdspTokenManager */
30
-
31
- /* Excluded from this release type: odspTokensCache */
32
-
33
- /* Excluded from this release type: saveRC */
34
-
35
- export { }
@@ -1,35 +0,0 @@
1
- import { IClientConfig } from '@fluidframework/odsp-doclib-utils/internal';
2
- import { IOdspTokens } from '@fluidframework/odsp-doclib-utils/internal';
3
- import { ITree } from '@fluidframework/protocol-definitions';
4
-
5
- /* Excluded from this release type: gcBlobPrefix */
6
-
7
- /* Excluded from this release type: getMicrosoftConfiguration */
8
-
9
- /* Excluded from this release type: getNormalizedSnapshot */
10
-
11
- /* Excluded from this release type: IAsyncCache */
12
-
13
- /* Excluded from this release type: IClientConfig */
14
-
15
- /* Excluded from this release type: IOdspTokenManagerCacheKey */
16
-
17
- /* Excluded from this release type: IOdspTokens */
18
-
19
- /* Excluded from this release type: IResources */
20
-
21
- /* Excluded from this release type: ISnapshotNormalizerConfig */
22
-
23
- /* Excluded from this release type: loadRC */
24
-
25
- /* Excluded from this release type: lockRC */
26
-
27
- /* Excluded from this release type: OdspTokenConfig */
28
-
29
- /* Excluded from this release type: OdspTokenManager */
30
-
31
- /* Excluded from this release type: odspTokensCache */
32
-
33
- /* Excluded from this release type: saveRC */
34
-
35
- export { }
@@ -1,130 +0,0 @@
1
- import { IClientConfig } from '@fluidframework/odsp-doclib-utils/internal';
2
- import { IOdspTokens } from '@fluidframework/odsp-doclib-utils/internal';
3
- import { ITree } from '@fluidframework/protocol-definitions';
4
-
5
- /**
6
- * The prefix that all GC blob names start with.
7
- *
8
- * @internal
9
- */
10
- export declare const gcBlobPrefix = "__gc";
11
-
12
- /**
13
- * @internal
14
- */
15
- export declare const getMicrosoftConfiguration: () => IClientConfig;
16
-
17
- /**
18
- * Helper function that normalizes the given snapshot tree. It sorts objects and arrays in the snapshot. It also
19
- * normalizes certain blob contents for which the order of content does not matter. For example, garbage collection
20
- * blobs contains objects / arrays whose element order do not matter.
21
- * @param snapshot - The snapshot tree to normalize.
22
- * @param config - Configs to use when normalizing snapshot. For example, it can contain paths of blobs whose contents
23
- * should be normalized as well.
24
- * @returns a copy of the normalized snapshot tree.
25
- * @internal
26
- */
27
- export declare function getNormalizedSnapshot(snapshot: ITree, config?: ISnapshotNormalizerConfig): ITree;
28
-
29
- /**
30
- * @internal
31
- */
32
- export declare interface IAsyncCache<TKey, TValue> {
33
- get(key: TKey): Promise<TValue | undefined>;
34
- save(key: TKey, value: TValue): Promise<void>;
35
- lock<T>(callback: () => Promise<T>): Promise<T>;
36
- }
37
-
38
- /**
39
- * @internal
40
- */
41
- export declare interface IOdspTokenManagerCacheKey {
42
- readonly isPush: boolean;
43
- readonly userOrServer: string;
44
- }
45
-
46
- /**
47
- * @internal
48
- */
49
- export declare interface IResources {
50
- tokens?: {
51
- version?: number;
52
- data: {
53
- [key: string]: {
54
- storage?: IOdspTokens;
55
- push?: IOdspTokens;
56
- };
57
- };
58
- };
59
- }
60
-
61
- /**
62
- * @internal
63
- */
64
- export declare interface ISnapshotNormalizerConfig {
65
- blobsToNormalize?: string[];
66
- /**
67
- * channel types who's content (non-attribute) blobs will be excluded.
68
- * this is used to exclude the content of channels who's content cannot be compared
69
- * as the content is non-deterministic between snapshot at the same sequence number.
70
- */
71
- excludedChannelContentTypes?: string[];
72
- }
73
-
74
- /**
75
- * @internal
76
- */
77
- export declare function loadRC(): Promise<IResources>;
78
-
79
- /**
80
- * @internal
81
- */
82
- export declare function lockRC(): Promise<any>;
83
-
84
- /**
85
- * @internal
86
- */
87
- export declare type OdspTokenConfig = {
88
- type: "password";
89
- username: string;
90
- password: string;
91
- } | {
92
- type: "browserLogin";
93
- navigator: (url: string) => void;
94
- redirectUriCallback?: (tokens: IOdspTokens) => Promise<string>;
95
- };
96
-
97
- /**
98
- * @internal
99
- */
100
- export declare class OdspTokenManager {
101
- private readonly tokenCache?;
102
- private readonly storageCache;
103
- private readonly pushCache;
104
- private readonly cacheMutex;
105
- constructor(tokenCache?: IAsyncCache<IOdspTokenManagerCacheKey, IOdspTokens> | undefined);
106
- updateTokensCache(key: IOdspTokenManagerCacheKey, value: IOdspTokens): Promise<void>;
107
- private updateTokensCacheWithoutLock;
108
- getOdspTokens(server: string, clientConfig: IClientConfig, tokenConfig: OdspTokenConfig, forceRefresh?: boolean, forceReauth?: boolean): Promise<IOdspTokens>;
109
- getPushTokens(server: string, clientConfig: IClientConfig, tokenConfig: OdspTokenConfig, forceRefresh?: boolean, forceReauth?: boolean): Promise<IOdspTokens>;
110
- private getTokenFromCache;
111
- private static getCacheKey;
112
- private getTokens;
113
- private getTokensCore;
114
- private acquireTokensWithPassword;
115
- private acquireTokensViaBrowserLogin;
116
- private onTokenRetrievalFromCache;
117
- private extractAuthorizationCode;
118
- }
119
-
120
- /**
121
- * @internal
122
- */
123
- export declare const odspTokensCache: IAsyncCache<IOdspTokenManagerCacheKey, IOdspTokens>;
124
-
125
- /**
126
- * @internal
127
- */
128
- export declare function saveRC(rc: IResources): Promise<void>;
129
-
130
- export { }