@fluidframework/azure-client 2.0.0-dev-rc.5.0.0.267932 → 2.0.0-dev-rc.5.0.0.268409
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.
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
## API Report File for "@fluidframework/azure-client"
|
|
1
|
+
## Alpha API Report File for "@fluidframework/azure-client"
|
|
2
2
|
|
|
3
3
|
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
|
|
4
4
|
|
|
@@ -66,15 +66,6 @@ export interface AzureContainerVersion {
|
|
|
66
66
|
id: string;
|
|
67
67
|
}
|
|
68
68
|
|
|
69
|
-
// @internal @deprecated
|
|
70
|
-
export class AzureFunctionTokenProvider implements ITokenProvider {
|
|
71
|
-
constructor(azFunctionUrl: string, user?: Pick<AzureMember<any>, "name" | "id" | "additionalDetails"> | undefined);
|
|
72
|
-
// (undocumented)
|
|
73
|
-
fetchOrdererToken(tenantId: string, documentId?: string): Promise<ITokenResponse>;
|
|
74
|
-
// (undocumented)
|
|
75
|
-
fetchStorageToken(tenantId: string, documentId: string): Promise<ITokenResponse>;
|
|
76
|
-
}
|
|
77
|
-
|
|
78
69
|
// @public
|
|
79
70
|
export interface AzureGetVersionsOptions {
|
|
80
71
|
maxCount: number;
|
|
@@ -97,12 +88,6 @@ export interface AzureRemoteConnectionConfig extends AzureConnectionConfig {
|
|
|
97
88
|
type: "remote";
|
|
98
89
|
}
|
|
99
90
|
|
|
100
|
-
// @internal
|
|
101
|
-
export interface AzureUser<T = any> extends IUser {
|
|
102
|
-
additionalDetails?: T;
|
|
103
|
-
name: string;
|
|
104
|
-
}
|
|
105
|
-
|
|
106
91
|
// @public
|
|
107
92
|
export type IAzureAudience = IServiceAudience<AzureMember>;
|
|
108
93
|
|
|
@@ -0,0 +1,108 @@
|
|
|
1
|
+
## Beta API Report File for "@fluidframework/azure-client"
|
|
2
|
+
|
|
3
|
+
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
|
|
4
|
+
|
|
5
|
+
```ts
|
|
6
|
+
|
|
7
|
+
import { CompatibilityMode } from '@fluidframework/fluid-static/internal';
|
|
8
|
+
import { ContainerSchema } from '@fluidframework/fluid-static';
|
|
9
|
+
import { ICompressionStorageConfig } from '@fluidframework/driver-utils';
|
|
10
|
+
import { IConfigProviderBase } from '@fluidframework/core-interfaces';
|
|
11
|
+
import { IFluidContainer } from '@fluidframework/fluid-static';
|
|
12
|
+
import { IMember } from '@fluidframework/fluid-static';
|
|
13
|
+
import { IServiceAudience } from '@fluidframework/fluid-static';
|
|
14
|
+
import { ITelemetryBaseEvent } from '@fluidframework/core-interfaces';
|
|
15
|
+
import { ITelemetryBaseLogger } from '@fluidframework/core-interfaces';
|
|
16
|
+
import { ITokenClaims } from '@fluidframework/driver-definitions/internal';
|
|
17
|
+
import { ITokenProvider } from '@fluidframework/routerlicious-driver';
|
|
18
|
+
import { ITokenResponse } from '@fluidframework/routerlicious-driver';
|
|
19
|
+
import { IUser } from '@fluidframework/driver-definitions';
|
|
20
|
+
import { ScopeType } from '@fluidframework/driver-definitions/internal';
|
|
21
|
+
|
|
22
|
+
// @public
|
|
23
|
+
export class AzureClient {
|
|
24
|
+
constructor(properties: AzureClientProps);
|
|
25
|
+
createContainer<const TContainerSchema extends ContainerSchema>(containerSchema: TContainerSchema, compatibilityMode: CompatibilityMode): Promise<{
|
|
26
|
+
container: IFluidContainer<TContainerSchema>;
|
|
27
|
+
services: AzureContainerServices;
|
|
28
|
+
}>;
|
|
29
|
+
getContainer<TContainerSchema extends ContainerSchema>(id: string, containerSchema: TContainerSchema, compatibilityMode: CompatibilityMode): Promise<{
|
|
30
|
+
container: IFluidContainer<TContainerSchema>;
|
|
31
|
+
services: AzureContainerServices;
|
|
32
|
+
}>;
|
|
33
|
+
getContainerVersions(id: string, options?: AzureGetVersionsOptions): Promise<AzureContainerVersion[]>;
|
|
34
|
+
viewContainerVersion<TContainerSchema extends ContainerSchema>(id: string, containerSchema: TContainerSchema, version: AzureContainerVersion, compatibilityMode: CompatibilityMode): Promise<{
|
|
35
|
+
container: IFluidContainer<TContainerSchema>;
|
|
36
|
+
}>;
|
|
37
|
+
}
|
|
38
|
+
|
|
39
|
+
// @public
|
|
40
|
+
export interface AzureClientProps {
|
|
41
|
+
readonly configProvider?: IConfigProviderBase;
|
|
42
|
+
readonly connection: AzureRemoteConnectionConfig | AzureLocalConnectionConfig;
|
|
43
|
+
readonly logger?: ITelemetryBaseLogger;
|
|
44
|
+
// (undocumented)
|
|
45
|
+
readonly summaryCompression?: boolean | ICompressionStorageConfig;
|
|
46
|
+
}
|
|
47
|
+
|
|
48
|
+
// @public
|
|
49
|
+
export interface AzureConnectionConfig {
|
|
50
|
+
endpoint: string;
|
|
51
|
+
tokenProvider: ITokenProvider;
|
|
52
|
+
type: AzureConnectionConfigType;
|
|
53
|
+
}
|
|
54
|
+
|
|
55
|
+
// @public
|
|
56
|
+
export type AzureConnectionConfigType = "local" | "remote";
|
|
57
|
+
|
|
58
|
+
// @public
|
|
59
|
+
export interface AzureContainerServices {
|
|
60
|
+
audience: IAzureAudience;
|
|
61
|
+
}
|
|
62
|
+
|
|
63
|
+
// @public
|
|
64
|
+
export interface AzureContainerVersion {
|
|
65
|
+
date?: string;
|
|
66
|
+
id: string;
|
|
67
|
+
}
|
|
68
|
+
|
|
69
|
+
// @public
|
|
70
|
+
export interface AzureGetVersionsOptions {
|
|
71
|
+
maxCount: number;
|
|
72
|
+
}
|
|
73
|
+
|
|
74
|
+
// @public
|
|
75
|
+
export interface AzureLocalConnectionConfig extends AzureConnectionConfig {
|
|
76
|
+
type: "local";
|
|
77
|
+
}
|
|
78
|
+
|
|
79
|
+
// @public
|
|
80
|
+
export interface AzureMember<T = any> extends IMember {
|
|
81
|
+
additionalDetails?: T;
|
|
82
|
+
name: string;
|
|
83
|
+
}
|
|
84
|
+
|
|
85
|
+
// @public
|
|
86
|
+
export interface AzureRemoteConnectionConfig extends AzureConnectionConfig {
|
|
87
|
+
tenantId: string;
|
|
88
|
+
type: "remote";
|
|
89
|
+
}
|
|
90
|
+
|
|
91
|
+
// @public
|
|
92
|
+
export type IAzureAudience = IServiceAudience<AzureMember>;
|
|
93
|
+
|
|
94
|
+
export { ITelemetryBaseEvent }
|
|
95
|
+
|
|
96
|
+
export { ITelemetryBaseLogger }
|
|
97
|
+
|
|
98
|
+
export { ITokenClaims }
|
|
99
|
+
|
|
100
|
+
export { ITokenProvider }
|
|
101
|
+
|
|
102
|
+
export { ITokenResponse }
|
|
103
|
+
|
|
104
|
+
export { IUser }
|
|
105
|
+
|
|
106
|
+
export { ScopeType }
|
|
107
|
+
|
|
108
|
+
```
|
|
@@ -0,0 +1,108 @@
|
|
|
1
|
+
## Public API Report File for "@fluidframework/azure-client"
|
|
2
|
+
|
|
3
|
+
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
|
|
4
|
+
|
|
5
|
+
```ts
|
|
6
|
+
|
|
7
|
+
import { CompatibilityMode } from '@fluidframework/fluid-static/internal';
|
|
8
|
+
import { ContainerSchema } from '@fluidframework/fluid-static';
|
|
9
|
+
import { ICompressionStorageConfig } from '@fluidframework/driver-utils';
|
|
10
|
+
import { IConfigProviderBase } from '@fluidframework/core-interfaces';
|
|
11
|
+
import { IFluidContainer } from '@fluidframework/fluid-static';
|
|
12
|
+
import { IMember } from '@fluidframework/fluid-static';
|
|
13
|
+
import { IServiceAudience } from '@fluidframework/fluid-static';
|
|
14
|
+
import { ITelemetryBaseEvent } from '@fluidframework/core-interfaces';
|
|
15
|
+
import { ITelemetryBaseLogger } from '@fluidframework/core-interfaces';
|
|
16
|
+
import { ITokenClaims } from '@fluidframework/driver-definitions/internal';
|
|
17
|
+
import { ITokenProvider } from '@fluidframework/routerlicious-driver';
|
|
18
|
+
import { ITokenResponse } from '@fluidframework/routerlicious-driver';
|
|
19
|
+
import { IUser } from '@fluidframework/driver-definitions';
|
|
20
|
+
import { ScopeType } from '@fluidframework/driver-definitions/internal';
|
|
21
|
+
|
|
22
|
+
// @public
|
|
23
|
+
export class AzureClient {
|
|
24
|
+
constructor(properties: AzureClientProps);
|
|
25
|
+
createContainer<const TContainerSchema extends ContainerSchema>(containerSchema: TContainerSchema, compatibilityMode: CompatibilityMode): Promise<{
|
|
26
|
+
container: IFluidContainer<TContainerSchema>;
|
|
27
|
+
services: AzureContainerServices;
|
|
28
|
+
}>;
|
|
29
|
+
getContainer<TContainerSchema extends ContainerSchema>(id: string, containerSchema: TContainerSchema, compatibilityMode: CompatibilityMode): Promise<{
|
|
30
|
+
container: IFluidContainer<TContainerSchema>;
|
|
31
|
+
services: AzureContainerServices;
|
|
32
|
+
}>;
|
|
33
|
+
getContainerVersions(id: string, options?: AzureGetVersionsOptions): Promise<AzureContainerVersion[]>;
|
|
34
|
+
viewContainerVersion<TContainerSchema extends ContainerSchema>(id: string, containerSchema: TContainerSchema, version: AzureContainerVersion, compatibilityMode: CompatibilityMode): Promise<{
|
|
35
|
+
container: IFluidContainer<TContainerSchema>;
|
|
36
|
+
}>;
|
|
37
|
+
}
|
|
38
|
+
|
|
39
|
+
// @public
|
|
40
|
+
export interface AzureClientProps {
|
|
41
|
+
readonly configProvider?: IConfigProviderBase;
|
|
42
|
+
readonly connection: AzureRemoteConnectionConfig | AzureLocalConnectionConfig;
|
|
43
|
+
readonly logger?: ITelemetryBaseLogger;
|
|
44
|
+
// (undocumented)
|
|
45
|
+
readonly summaryCompression?: boolean | ICompressionStorageConfig;
|
|
46
|
+
}
|
|
47
|
+
|
|
48
|
+
// @public
|
|
49
|
+
export interface AzureConnectionConfig {
|
|
50
|
+
endpoint: string;
|
|
51
|
+
tokenProvider: ITokenProvider;
|
|
52
|
+
type: AzureConnectionConfigType;
|
|
53
|
+
}
|
|
54
|
+
|
|
55
|
+
// @public
|
|
56
|
+
export type AzureConnectionConfigType = "local" | "remote";
|
|
57
|
+
|
|
58
|
+
// @public
|
|
59
|
+
export interface AzureContainerServices {
|
|
60
|
+
audience: IAzureAudience;
|
|
61
|
+
}
|
|
62
|
+
|
|
63
|
+
// @public
|
|
64
|
+
export interface AzureContainerVersion {
|
|
65
|
+
date?: string;
|
|
66
|
+
id: string;
|
|
67
|
+
}
|
|
68
|
+
|
|
69
|
+
// @public
|
|
70
|
+
export interface AzureGetVersionsOptions {
|
|
71
|
+
maxCount: number;
|
|
72
|
+
}
|
|
73
|
+
|
|
74
|
+
// @public
|
|
75
|
+
export interface AzureLocalConnectionConfig extends AzureConnectionConfig {
|
|
76
|
+
type: "local";
|
|
77
|
+
}
|
|
78
|
+
|
|
79
|
+
// @public
|
|
80
|
+
export interface AzureMember<T = any> extends IMember {
|
|
81
|
+
additionalDetails?: T;
|
|
82
|
+
name: string;
|
|
83
|
+
}
|
|
84
|
+
|
|
85
|
+
// @public
|
|
86
|
+
export interface AzureRemoteConnectionConfig extends AzureConnectionConfig {
|
|
87
|
+
tenantId: string;
|
|
88
|
+
type: "remote";
|
|
89
|
+
}
|
|
90
|
+
|
|
91
|
+
// @public
|
|
92
|
+
export type IAzureAudience = IServiceAudience<AzureMember>;
|
|
93
|
+
|
|
94
|
+
export { ITelemetryBaseEvent }
|
|
95
|
+
|
|
96
|
+
export { ITelemetryBaseLogger }
|
|
97
|
+
|
|
98
|
+
export { ITokenClaims }
|
|
99
|
+
|
|
100
|
+
export { ITokenProvider }
|
|
101
|
+
|
|
102
|
+
export { ITokenResponse }
|
|
103
|
+
|
|
104
|
+
export { IUser }
|
|
105
|
+
|
|
106
|
+
export { ScopeType }
|
|
107
|
+
|
|
108
|
+
```
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@fluidframework/azure-client",
|
|
3
|
-
"version": "2.0.0-dev-rc.5.0.0.
|
|
3
|
+
"version": "2.0.0-dev-rc.5.0.0.268409",
|
|
4
4
|
"description": "A tool to enable creation and loading of Fluid containers using the Azure Fluid Relay service",
|
|
5
5
|
"homepage": "https://fluidframework.com",
|
|
6
6
|
"repository": {
|
|
@@ -57,32 +57,32 @@
|
|
|
57
57
|
"main": "lib/index.js",
|
|
58
58
|
"types": "lib/public.d.ts",
|
|
59
59
|
"dependencies": {
|
|
60
|
-
"@fluidframework/container-definitions": "2.0.0-dev-rc.5.0.0.
|
|
61
|
-
"@fluidframework/container-loader": "2.0.0-dev-rc.5.0.0.
|
|
62
|
-
"@fluidframework/core-interfaces": "2.0.0-dev-rc.5.0.0.
|
|
63
|
-
"@fluidframework/core-utils": "2.0.0-dev-rc.5.0.0.
|
|
64
|
-
"@fluidframework/driver-definitions": "2.0.0-dev-rc.5.0.0.
|
|
65
|
-
"@fluidframework/driver-utils": "2.0.0-dev-rc.5.0.0.
|
|
66
|
-
"@fluidframework/fluid-static": "2.0.0-dev-rc.5.0.0.
|
|
67
|
-
"@fluidframework/map": "2.0.0-dev-rc.5.0.0.
|
|
68
|
-
"@fluidframework/routerlicious-driver": "2.0.0-dev-rc.5.0.0.
|
|
69
|
-
"@fluidframework/runtime-utils": "2.0.0-dev-rc.5.0.0.
|
|
70
|
-
"@fluidframework/telemetry-utils": "2.0.0-dev-rc.5.0.0.
|
|
60
|
+
"@fluidframework/container-definitions": "2.0.0-dev-rc.5.0.0.268409",
|
|
61
|
+
"@fluidframework/container-loader": "2.0.0-dev-rc.5.0.0.268409",
|
|
62
|
+
"@fluidframework/core-interfaces": "2.0.0-dev-rc.5.0.0.268409",
|
|
63
|
+
"@fluidframework/core-utils": "2.0.0-dev-rc.5.0.0.268409",
|
|
64
|
+
"@fluidframework/driver-definitions": "2.0.0-dev-rc.5.0.0.268409",
|
|
65
|
+
"@fluidframework/driver-utils": "2.0.0-dev-rc.5.0.0.268409",
|
|
66
|
+
"@fluidframework/fluid-static": "2.0.0-dev-rc.5.0.0.268409",
|
|
67
|
+
"@fluidframework/map": "2.0.0-dev-rc.5.0.0.268409",
|
|
68
|
+
"@fluidframework/routerlicious-driver": "2.0.0-dev-rc.5.0.0.268409",
|
|
69
|
+
"@fluidframework/runtime-utils": "2.0.0-dev-rc.5.0.0.268409",
|
|
70
|
+
"@fluidframework/telemetry-utils": "2.0.0-dev-rc.5.0.0.268409",
|
|
71
71
|
"axios": "^1.6.2"
|
|
72
72
|
},
|
|
73
73
|
"devDependencies": {
|
|
74
74
|
"@arethetypeswrong/cli": "^0.15.2",
|
|
75
|
-
"@biomejs/biome": "^1.
|
|
75
|
+
"@biomejs/biome": "^1.7.3",
|
|
76
76
|
"@fluid-tools/build-cli": "^0.39.0-264124",
|
|
77
|
-
"@fluidframework/aqueduct": "2.0.0-dev-rc.5.0.0.
|
|
77
|
+
"@fluidframework/aqueduct": "2.0.0-dev-rc.5.0.0.268409",
|
|
78
78
|
"@fluidframework/azure-client-previous": "npm:@fluidframework/azure-client@2.0.0-rc.4.0.0",
|
|
79
|
-
"@fluidframework/azure-local-service": "2.0.0-dev-rc.5.0.0.
|
|
79
|
+
"@fluidframework/azure-local-service": "2.0.0-dev-rc.5.0.0.268409",
|
|
80
80
|
"@fluidframework/build-common": "^2.0.3",
|
|
81
81
|
"@fluidframework/build-tools": "^0.39.0-264124",
|
|
82
|
-
"@fluidframework/eslint-config-fluid": "^5.
|
|
83
|
-
"@fluidframework/test-runtime-utils": "2.0.0-dev-rc.5.0.0.
|
|
84
|
-
"@fluidframework/test-utils": "2.0.0-dev-rc.5.0.0.
|
|
85
|
-
"@fluidframework/tree": "2.0.0-dev-rc.5.0.0.
|
|
82
|
+
"@fluidframework/eslint-config-fluid": "^5.3.0",
|
|
83
|
+
"@fluidframework/test-runtime-utils": "2.0.0-dev-rc.5.0.0.268409",
|
|
84
|
+
"@fluidframework/test-utils": "2.0.0-dev-rc.5.0.0.268409",
|
|
85
|
+
"@fluidframework/tree": "2.0.0-dev-rc.5.0.0.268409",
|
|
86
86
|
"@microsoft/api-extractor": "^7.45.1",
|
|
87
87
|
"@types/mocha": "^9.1.1",
|
|
88
88
|
"@types/node": "^18.19.0",
|