@fluidframework/routerlicious-driver 2.0.0-dev-rc.3.0.0.254513 → 2.0.0-dev-rc.3.0.0.254866

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,17 @@
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
+ */
10
+ export {
11
+ // public APIs
12
+ ITokenProvider,
13
+ ITokenResponse,
14
+
15
+ // alpha APIs
16
+ IRouterliciousResolvedUrl
17
+ } from "./index.js";
package/dist/beta.d.ts ADDED
@@ -0,0 +1,14 @@
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
+ */
10
+ export {
11
+ // public APIs
12
+ ITokenProvider,
13
+ ITokenResponse
14
+ } from "./index.js";
@@ -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/routerlicious-driver";
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.254866";
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/routerlicious-driver";
11
- exports.pkgVersion = "2.0.0-dev-rc.3.0.0.254513";
11
+ exports.pkgVersion = "2.0.0-dev-rc.3.0.0.254866";
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,sCAAsC,CAAC;AACjD,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/routerlicious-driver\";\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,sCAAsC,CAAC;AACjD,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/routerlicious-driver\";\nexport const pkgVersion = \"2.0.0-dev-rc.3.0.0.254866\";\n"]}
@@ -0,0 +1,14 @@
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
+ */
10
+ export {
11
+ // public APIs
12
+ ITokenProvider,
13
+ ITokenResponse
14
+ } from "./index.js";
package/lib/alpha.d.ts ADDED
@@ -0,0 +1,17 @@
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
+ */
10
+ export {
11
+ // public APIs
12
+ ITokenProvider,
13
+ ITokenResponse,
14
+
15
+ // alpha APIs
16
+ IRouterliciousResolvedUrl
17
+ } from "./index.js";
package/lib/beta.d.ts ADDED
@@ -0,0 +1,14 @@
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
+ */
10
+ export {
11
+ // public APIs
12
+ ITokenProvider,
13
+ ITokenResponse
14
+ } from "./index.js";
@@ -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/routerlicious-driver";
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.254866";
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/routerlicious-driver";
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.254866";
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,sCAAsC,CAAC;AAC9D,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/routerlicious-driver\";\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,sCAAsC,CAAC;AAC9D,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/routerlicious-driver\";\nexport const pkgVersion = \"2.0.0-dev-rc.3.0.0.254866\";\n"]}
@@ -0,0 +1,14 @@
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
+ */
10
+ export {
11
+ // public APIs
12
+ ITokenProvider,
13
+ ITokenResponse
14
+ } from "./index.js";
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@fluidframework/routerlicious-driver",
3
- "version": "2.0.0-dev-rc.3.0.0.254513",
3
+ "version": "2.0.0-dev-rc.3.0.0.254866",
4
4
  "description": "Socket.IO + Git implementation of Fluid service API",
5
5
  "homepage": "https://fluidframework.com",
6
6
  "repository": {
@@ -15,31 +15,31 @@
15
15
  "exports": {
16
16
  ".": {
17
17
  "import": {
18
- "types": "./lib/routerlicious-driver-public.d.ts",
18
+ "types": "./lib/public.d.ts",
19
19
  "default": "./lib/index.js"
20
20
  },
21
21
  "require": {
22
- "types": "./dist/routerlicious-driver-public.d.ts",
22
+ "types": "./dist/public.d.ts",
23
23
  "default": "./dist/index.js"
24
24
  }
25
25
  },
26
26
  "./beta": {
27
27
  "import": {
28
- "types": "./lib/routerlicious-driver-beta.d.ts",
28
+ "types": "./lib/beta.d.ts",
29
29
  "default": "./lib/index.js"
30
30
  },
31
31
  "require": {
32
- "types": "./dist/routerlicious-driver-beta.d.ts",
32
+ "types": "./dist/beta.d.ts",
33
33
  "default": "./dist/index.js"
34
34
  }
35
35
  },
36
36
  "./alpha": {
37
37
  "import": {
38
- "types": "./lib/routerlicious-driver-alpha.d.ts",
38
+ "types": "./lib/alpha.d.ts",
39
39
  "default": "./lib/index.js"
40
40
  },
41
41
  "require": {
42
- "types": "./dist/routerlicious-driver-alpha.d.ts",
42
+ "types": "./dist/alpha.d.ts",
43
43
  "default": "./dist/index.js"
44
44
  }
45
45
  },
@@ -55,7 +55,7 @@
55
55
  }
56
56
  },
57
57
  "main": "dist/index.js",
58
- "types": "./dist/routerlicious-driver-public.d.ts",
58
+ "types": "./dist/public.d.ts",
59
59
  "c8": {
60
60
  "all": true,
61
61
  "cache-dir": "nyc/.cache",
@@ -77,17 +77,17 @@
77
77
  "temp-directory": "nyc/.nyc_output"
78
78
  },
79
79
  "dependencies": {
80
- "@fluid-internal/client-utils": "2.0.0-dev-rc.3.0.0.254513",
81
- "@fluidframework/core-interfaces": "2.0.0-dev-rc.3.0.0.254513",
82
- "@fluidframework/core-utils": "2.0.0-dev-rc.3.0.0.254513",
83
- "@fluidframework/driver-base": "2.0.0-dev-rc.3.0.0.254513",
84
- "@fluidframework/driver-definitions": "2.0.0-dev-rc.3.0.0.254513",
85
- "@fluidframework/driver-utils": "2.0.0-dev-rc.3.0.0.254513",
80
+ "@fluid-internal/client-utils": "2.0.0-dev-rc.3.0.0.254866",
81
+ "@fluidframework/core-interfaces": "2.0.0-dev-rc.3.0.0.254866",
82
+ "@fluidframework/core-utils": "2.0.0-dev-rc.3.0.0.254866",
83
+ "@fluidframework/driver-base": "2.0.0-dev-rc.3.0.0.254866",
84
+ "@fluidframework/driver-definitions": "2.0.0-dev-rc.3.0.0.254866",
85
+ "@fluidframework/driver-utils": "2.0.0-dev-rc.3.0.0.254866",
86
86
  "@fluidframework/gitresources": "^4.0.0",
87
87
  "@fluidframework/protocol-base": "^4.0.0",
88
88
  "@fluidframework/protocol-definitions": "^3.2.0",
89
89
  "@fluidframework/server-services-client": "^4.0.0",
90
- "@fluidframework/telemetry-utils": "2.0.0-dev-rc.3.0.0.254513",
90
+ "@fluidframework/telemetry-utils": "2.0.0-dev-rc.3.0.0.254866",
91
91
  "cross-fetch": "^3.1.5",
92
92
  "json-stringify-safe": "5.0.1",
93
93
  "socket.io-client": "^4.7.3",
@@ -96,7 +96,7 @@
96
96
  "devDependencies": {
97
97
  "@arethetypeswrong/cli": "^0.15.2",
98
98
  "@biomejs/biome": "^1.6.2",
99
- "@fluid-internal/mocha-test-setup": "2.0.0-dev-rc.3.0.0.254513",
99
+ "@fluid-internal/mocha-test-setup": "2.0.0-dev-rc.3.0.0.254866",
100
100
  "@fluid-tools/build-cli": "^0.35.0",
101
101
  "@fluidframework/build-common": "^2.0.3",
102
102
  "@fluidframework/build-tools": "^0.35.0",
@@ -123,18 +123,6 @@
123
123
  "sinon": "^17.0.1",
124
124
  "typescript": "~5.1.6"
125
125
  },
126
- "fluidBuild": {
127
- "tasks": {
128
- "build:docs": {
129
- "dependsOn": [
130
- "...",
131
- "api-extractor:commonjs",
132
- "api-extractor:esnext"
133
- ],
134
- "script": false
135
- }
136
- }
137
- },
138
126
  "typeValidation": {
139
127
  "broken": {
140
128
  "RemovedEnumDeclaration_RouterliciousErrorType": {
@@ -148,12 +136,12 @@
148
136
  },
149
137
  "scripts": {
150
138
  "api": "fluid-build . --task api",
151
- "api-extractor:commonjs": "api-extractor run --config ./api-extractor-cjs.json",
152
- "api-extractor:esnext": "api-extractor run --local",
139
+ "api-extractor:commonjs": "flub generate entrypoints --outDir ./dist",
140
+ "api-extractor:esnext": "flub generate entrypoints --outDir ./lib",
153
141
  "build": "fluid-build . --task build",
154
142
  "build:commonjs": "fluid-build . --task commonjs",
155
143
  "build:compile": "fluid-build . --task compile",
156
- "build:docs": "fluid-build . --task api",
144
+ "build:docs": "api-extractor run --local",
157
145
  "build:esnext": "tsc --project ./tsconfig.json",
158
146
  "build:genver": "gen-version",
159
147
  "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/routerlicious-driver";
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.254866";
@@ -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,113 +0,0 @@
1
- import { IDocumentService } from '@fluidframework/driver-definitions/internal';
2
- import { IDocumentServiceFactory } from '@fluidframework/driver-definitions/internal';
3
- import { IResolvedUrl } from '@fluidframework/driver-definitions/internal';
4
- import { ISession } from '@fluidframework/server-services-client';
5
- import { ISummaryTree } from '@fluidframework/protocol-definitions';
6
- import { ITelemetryBaseLogger } from '@fluidframework/core-interfaces';
7
- import { ITokenClaims } from '@fluidframework/protocol-definitions';
8
-
9
- /* Excluded from this release type: DefaultTokenProvider */
10
-
11
- /* Excluded from this release type: DocumentPostCreateError */
12
-
13
- /* Excluded from this release type: IRouterliciousDriverPolicies */
14
-
15
- /**
16
- * Routerlicious extends the resolved url with additional properties to control Routerlicious-specific behaviors.
17
- *
18
- * @privateRemarks
19
- * {@link isRouterliciousResolvedUrl} can be used to detect whether an {@link @fluidframework/driver-definitions#IResolvedUrl}
20
- * is an IRouterliciousResolvedUrl.
21
- *
22
- * @alpha
23
- */
24
- export declare interface IRouterliciousResolvedUrl extends IResolvedUrl {
25
- /**
26
- * A flag to facilitate type narrowing from {@link @fluidframework/driver-definitions#IResolvedUrl} to IRouterliciousResolvedUrl.
27
- */
28
- routerliciousResolvedUrl: true;
29
- /**
30
- * Controls whether a newly created container will be ephemeral, which means the service will not retain it
31
- * after the collaboration session ends. Only affects
32
- * {@link @fluidframework/driver-definitions#IDocumentServiceFactory.createContainer} requests.
33
- *
34
- * @defaultValue If left undefined, treated as `false`
35
- */
36
- createAsEphemeral?: boolean;
37
- }
38
-
39
- /**
40
- * Abstracts the token fetching mechanism for a hosting application.
41
- * The hosting application is responsible for providing an implementation.
42
- * @public
43
- */
44
- export declare interface ITokenProvider {
45
- /**
46
- * Fetches the orderer token from host.
47
- *
48
- * @param tenantId - Tenant ID.
49
- * @param documentId - Optional. Document ID is only required for document-scoped requests.
50
- * @param refresh - Optional flag indicating whether token fetch must bypass local cache.
51
- * This likely indicates that some previous request failed authorization due to an expired token,
52
- * and so a fresh token is required.
53
- *
54
- * Default: `false`.
55
- *
56
- * NOTE: This parameter will be made required in the future.
57
- */
58
- fetchOrdererToken(tenantId: string, documentId?: string, refresh?: boolean): Promise<ITokenResponse>;
59
- /**
60
- * Fetches the storage token from host.
61
- *
62
- * @param tenantId - Tenant ID.
63
- * @param documentId - Document ID.
64
- * @param refresh - Optional flag indicating whether token fetch must bypass local cache.
65
- * This likely indicates that some previous request failed authorization due to an expired token,
66
- * and so a fresh token is required.
67
- *
68
- * Default: `false`.
69
- *
70
- * NOTE: This parameter will be made required in the future.
71
- */
72
- fetchStorageToken(tenantId: string, documentId: string, refresh?: boolean): Promise<ITokenResponse>;
73
- /**
74
- * A callback triggered directly after creating the document. In this callback the client has the opportunity, to
75
- * verify against an authorization service, if the user who claims to create the document is the same user who
76
- * created it.
77
- *
78
- * @remarks Notes:
79
- *
80
- * * Using the callback may have performance impact on the document creation process.
81
- *
82
- * * Any exceptions thrown in the callback would fail the creation workflow.
83
- *
84
- * @param documentId - Document ID.
85
- * @param creationToken - A special token that doesn't provide any kind of access, but it has the user's payload
86
- * and document id. It can be used to validate the identity of the document creator.
87
- */
88
- documentPostCreateCallback?(documentId: string, creationToken: string): Promise<void>;
89
- }
90
-
91
- /**
92
- * @public
93
- */
94
- export declare interface ITokenResponse {
95
- /**
96
- * {@link https://jwt.io/introduction/ | JSON Web Token (JWT)} value.
97
- */
98
- jwt: string;
99
- /**
100
- * A flag indicating whether token was obtained from local cache.
101
- *
102
- * @remarks `undefined` indicates that the source of the token could not be determined.
103
- */
104
- fromCache?: boolean;
105
- }
106
-
107
- /* Excluded from this release type: ITokenService */
108
-
109
- /* Excluded from this release type: RouterliciousDocumentServiceFactory */
110
-
111
- /* Excluded from this release type: RouterliciousErrorTypes */
112
-
113
- export { }
@@ -1,97 +0,0 @@
1
- import { IDocumentService } from '@fluidframework/driver-definitions/internal';
2
- import { IDocumentServiceFactory } from '@fluidframework/driver-definitions/internal';
3
- import { IResolvedUrl } from '@fluidframework/driver-definitions/internal';
4
- import { ISession } from '@fluidframework/server-services-client';
5
- import { ISummaryTree } from '@fluidframework/protocol-definitions';
6
- import { ITelemetryBaseLogger } from '@fluidframework/core-interfaces';
7
- import { ITokenClaims } from '@fluidframework/protocol-definitions';
8
-
9
- /* Excluded from this release type: DefaultTokenProvider */
10
-
11
- /* Excluded from this release type: DocumentPostCreateError */
12
-
13
- /* Excluded from this release type: IDocumentService */
14
-
15
- /* Excluded from this release type: IDocumentServiceFactory */
16
-
17
- /* Excluded from this release type: IResolvedUrl */
18
-
19
- /* Excluded from this release type: IRouterliciousDriverPolicies */
20
-
21
- /* Excluded from this release type: IRouterliciousResolvedUrl */
22
-
23
- /**
24
- * Abstracts the token fetching mechanism for a hosting application.
25
- * The hosting application is responsible for providing an implementation.
26
- * @public
27
- */
28
- export declare interface ITokenProvider {
29
- /**
30
- * Fetches the orderer token from host.
31
- *
32
- * @param tenantId - Tenant ID.
33
- * @param documentId - Optional. Document ID is only required for document-scoped requests.
34
- * @param refresh - Optional flag indicating whether token fetch must bypass local cache.
35
- * This likely indicates that some previous request failed authorization due to an expired token,
36
- * and so a fresh token is required.
37
- *
38
- * Default: `false`.
39
- *
40
- * NOTE: This parameter will be made required in the future.
41
- */
42
- fetchOrdererToken(tenantId: string, documentId?: string, refresh?: boolean): Promise<ITokenResponse>;
43
- /**
44
- * Fetches the storage token from host.
45
- *
46
- * @param tenantId - Tenant ID.
47
- * @param documentId - Document ID.
48
- * @param refresh - Optional flag indicating whether token fetch must bypass local cache.
49
- * This likely indicates that some previous request failed authorization due to an expired token,
50
- * and so a fresh token is required.
51
- *
52
- * Default: `false`.
53
- *
54
- * NOTE: This parameter will be made required in the future.
55
- */
56
- fetchStorageToken(tenantId: string, documentId: string, refresh?: boolean): Promise<ITokenResponse>;
57
- /**
58
- * A callback triggered directly after creating the document. In this callback the client has the opportunity, to
59
- * verify against an authorization service, if the user who claims to create the document is the same user who
60
- * created it.
61
- *
62
- * @remarks Notes:
63
- *
64
- * * Using the callback may have performance impact on the document creation process.
65
- *
66
- * * Any exceptions thrown in the callback would fail the creation workflow.
67
- *
68
- * @param documentId - Document ID.
69
- * @param creationToken - A special token that doesn't provide any kind of access, but it has the user's payload
70
- * and document id. It can be used to validate the identity of the document creator.
71
- */
72
- documentPostCreateCallback?(documentId: string, creationToken: string): Promise<void>;
73
- }
74
-
75
- /**
76
- * @public
77
- */
78
- export declare interface ITokenResponse {
79
- /**
80
- * {@link https://jwt.io/introduction/ | JSON Web Token (JWT)} value.
81
- */
82
- jwt: string;
83
- /**
84
- * A flag indicating whether token was obtained from local cache.
85
- *
86
- * @remarks `undefined` indicates that the source of the token could not be determined.
87
- */
88
- fromCache?: boolean;
89
- }
90
-
91
- /* Excluded from this release type: ITokenService */
92
-
93
- /* Excluded from this release type: RouterliciousDocumentServiceFactory */
94
-
95
- /* Excluded from this release type: RouterliciousErrorTypes */
96
-
97
- export { }
@@ -1,97 +0,0 @@
1
- import { IDocumentService } from '@fluidframework/driver-definitions/internal';
2
- import { IDocumentServiceFactory } from '@fluidframework/driver-definitions/internal';
3
- import { IResolvedUrl } from '@fluidframework/driver-definitions/internal';
4
- import { ISession } from '@fluidframework/server-services-client';
5
- import { ISummaryTree } from '@fluidframework/protocol-definitions';
6
- import { ITelemetryBaseLogger } from '@fluidframework/core-interfaces';
7
- import { ITokenClaims } from '@fluidframework/protocol-definitions';
8
-
9
- /* Excluded from this release type: DefaultTokenProvider */
10
-
11
- /* Excluded from this release type: DocumentPostCreateError */
12
-
13
- /* Excluded from this release type: IDocumentService */
14
-
15
- /* Excluded from this release type: IDocumentServiceFactory */
16
-
17
- /* Excluded from this release type: IResolvedUrl */
18
-
19
- /* Excluded from this release type: IRouterliciousDriverPolicies */
20
-
21
- /* Excluded from this release type: IRouterliciousResolvedUrl */
22
-
23
- /**
24
- * Abstracts the token fetching mechanism for a hosting application.
25
- * The hosting application is responsible for providing an implementation.
26
- * @public
27
- */
28
- export declare interface ITokenProvider {
29
- /**
30
- * Fetches the orderer token from host.
31
- *
32
- * @param tenantId - Tenant ID.
33
- * @param documentId - Optional. Document ID is only required for document-scoped requests.
34
- * @param refresh - Optional flag indicating whether token fetch must bypass local cache.
35
- * This likely indicates that some previous request failed authorization due to an expired token,
36
- * and so a fresh token is required.
37
- *
38
- * Default: `false`.
39
- *
40
- * NOTE: This parameter will be made required in the future.
41
- */
42
- fetchOrdererToken(tenantId: string, documentId?: string, refresh?: boolean): Promise<ITokenResponse>;
43
- /**
44
- * Fetches the storage token from host.
45
- *
46
- * @param tenantId - Tenant ID.
47
- * @param documentId - Document ID.
48
- * @param refresh - Optional flag indicating whether token fetch must bypass local cache.
49
- * This likely indicates that some previous request failed authorization due to an expired token,
50
- * and so a fresh token is required.
51
- *
52
- * Default: `false`.
53
- *
54
- * NOTE: This parameter will be made required in the future.
55
- */
56
- fetchStorageToken(tenantId: string, documentId: string, refresh?: boolean): Promise<ITokenResponse>;
57
- /**
58
- * A callback triggered directly after creating the document. In this callback the client has the opportunity, to
59
- * verify against an authorization service, if the user who claims to create the document is the same user who
60
- * created it.
61
- *
62
- * @remarks Notes:
63
- *
64
- * * Using the callback may have performance impact on the document creation process.
65
- *
66
- * * Any exceptions thrown in the callback would fail the creation workflow.
67
- *
68
- * @param documentId - Document ID.
69
- * @param creationToken - A special token that doesn't provide any kind of access, but it has the user's payload
70
- * and document id. It can be used to validate the identity of the document creator.
71
- */
72
- documentPostCreateCallback?(documentId: string, creationToken: string): Promise<void>;
73
- }
74
-
75
- /**
76
- * @public
77
- */
78
- export declare interface ITokenResponse {
79
- /**
80
- * {@link https://jwt.io/introduction/ | JSON Web Token (JWT)} value.
81
- */
82
- jwt: string;
83
- /**
84
- * A flag indicating whether token was obtained from local cache.
85
- *
86
- * @remarks `undefined` indicates that the source of the token could not be determined.
87
- */
88
- fromCache?: boolean;
89
- }
90
-
91
- /* Excluded from this release type: ITokenService */
92
-
93
- /* Excluded from this release type: RouterliciousDocumentServiceFactory */
94
-
95
- /* Excluded from this release type: RouterliciousErrorTypes */
96
-
97
- export { }