@fluidframework/azure-client 0.59.3000 → 1.0.0
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.
- package/.eslintrc.js +1 -1
- package/README.md +7 -8
- package/dist/AzureClient.d.ts +22 -5
- package/dist/AzureClient.d.ts.map +1 -1
- package/dist/AzureClient.js +87 -20
- package/dist/AzureClient.js.map +1 -1
- package/dist/AzureUrlResolver.d.ts +1 -1
- package/dist/AzureUrlResolver.d.ts.map +1 -1
- package/dist/AzureUrlResolver.js +3 -3
- package/dist/AzureUrlResolver.js.map +1 -1
- package/dist/interfaces.d.ts +56 -9
- package/dist/interfaces.d.ts.map +1 -1
- package/dist/interfaces.js.map +1 -1
- package/dist/packageVersion.d.ts +1 -1
- package/dist/packageVersion.d.ts.map +1 -1
- package/dist/packageVersion.js +1 -1
- package/dist/packageVersion.js.map +1 -1
- package/dist/utils.d.ts +14 -0
- package/dist/utils.d.ts.map +1 -0
- package/dist/utils.js +18 -0
- package/dist/utils.js.map +1 -0
- package/lib/AzureClient.d.ts +22 -5
- package/lib/AzureClient.d.ts.map +1 -1
- package/lib/AzureClient.js +86 -19
- package/lib/AzureClient.js.map +1 -1
- package/lib/AzureUrlResolver.d.ts +1 -1
- package/lib/AzureUrlResolver.d.ts.map +1 -1
- package/lib/AzureUrlResolver.js +3 -3
- package/lib/AzureUrlResolver.js.map +1 -1
- package/lib/interfaces.d.ts +56 -9
- package/lib/interfaces.d.ts.map +1 -1
- package/lib/interfaces.js.map +1 -1
- package/lib/packageVersion.d.ts +1 -1
- package/lib/packageVersion.d.ts.map +1 -1
- package/lib/packageVersion.js +1 -1
- package/lib/packageVersion.js.map +1 -1
- package/lib/utils.d.ts +14 -0
- package/lib/utils.d.ts.map +1 -0
- package/lib/utils.js +13 -0
- package/lib/utils.js.map +1 -0
- package/package.json +35 -19
- package/src/AzureClient.ts +142 -27
- package/src/AzureUrlResolver.ts +4 -5
- package/src/interfaces.ts +62 -9
- package/src/packageVersion.ts +1 -1
- package/src/utils.ts +21 -0
package/lib/AzureClient.d.ts
CHANGED
|
@@ -1,9 +1,5 @@
|
|
|
1
1
|
import { ContainerSchema, IFluidContainer } from "@fluidframework/fluid-static";
|
|
2
|
-
import { AzureClientProps, AzureContainerServices } from "./interfaces";
|
|
3
|
-
/**
|
|
4
|
-
* Strongly typed id for connecting to a local Azure Fluid Relay.
|
|
5
|
-
*/
|
|
6
|
-
export declare const LOCAL_MODE_TENANT_ID = "local";
|
|
2
|
+
import { AzureClientProps, AzureContainerServices, AzureContainerVersion, AzureGetVersionsOptions } from "./interfaces";
|
|
7
3
|
/**
|
|
8
4
|
* AzureClient provides the ability to have a Fluid object backed by the Azure Fluid Relay or,
|
|
9
5
|
* when running with local tenantId, have it be backed by a local Azure Fluid Relay instance.
|
|
@@ -26,6 +22,18 @@ export declare class AzureClient {
|
|
|
26
22
|
container: IFluidContainer;
|
|
27
23
|
services: AzureContainerServices;
|
|
28
24
|
}>;
|
|
25
|
+
/**
|
|
26
|
+
* Creates new detached container out of specific version of another container.
|
|
27
|
+
* @param id - Unique ID of the source container in Azure Fluid Relay.
|
|
28
|
+
* @param containerSchema - Container schema used to access data objects in the container.
|
|
29
|
+
* @param version - Unique version of the source container in Azure Fluid Relay.
|
|
30
|
+
* It defaults to latest version if parameter not provided.
|
|
31
|
+
* @returns New detached container instance along with associated services.
|
|
32
|
+
*/
|
|
33
|
+
copyContainer(id: string, containerSchema: ContainerSchema, version?: AzureContainerVersion): Promise<{
|
|
34
|
+
container: IFluidContainer;
|
|
35
|
+
services: AzureContainerServices;
|
|
36
|
+
}>;
|
|
29
37
|
/**
|
|
30
38
|
* Accesses the existing container given its unique ID in the Azure Fluid Relay.
|
|
31
39
|
* @param id - Unique ID of the container in Azure Fluid Relay.
|
|
@@ -36,7 +44,16 @@ export declare class AzureClient {
|
|
|
36
44
|
container: IFluidContainer;
|
|
37
45
|
services: AzureContainerServices;
|
|
38
46
|
}>;
|
|
47
|
+
/**
|
|
48
|
+
* Get the list of versions for specific container.
|
|
49
|
+
* @param id - Unique ID of the source container in Azure Fluid Relay.
|
|
50
|
+
* @param options - "Get" options. If options are not provided, API
|
|
51
|
+
* will assume maxCount of versions to retreive to be 5.
|
|
52
|
+
* @returns Array of available container versions.
|
|
53
|
+
*/
|
|
54
|
+
getContainerVersions(id: string, options?: AzureGetVersionsOptions): Promise<AzureContainerVersion[]>;
|
|
39
55
|
private getContainerServices;
|
|
40
56
|
private createLoader;
|
|
57
|
+
private createFluidContainer;
|
|
41
58
|
}
|
|
42
59
|
//# sourceMappingURL=AzureClient.d.ts.map
|
package/lib/AzureClient.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"AzureClient.d.ts","sourceRoot":"","sources":["../src/AzureClient.ts"],"names":[],"mappings":"AAiBA,OAAO,EACH,eAAe,EAGf,eAAe,EAElB,MAAM,8BAA8B,CAAC;
|
|
1
|
+
{"version":3,"file":"AzureClient.d.ts","sourceRoot":"","sources":["../src/AzureClient.ts"],"names":[],"mappings":"AAiBA,OAAO,EACH,eAAe,EAGf,eAAe,EAElB,MAAM,8BAA8B,CAAC;AAMtC,OAAO,EACH,gBAAgB,EAEhB,sBAAsB,EACtB,qBAAqB,EACrB,uBAAuB,EAC1B,MAAM,cAAc,CAAC;AAkBtB;;;GAGG;AACH,qBAAa,WAAW;IAQR,OAAO,CAAC,QAAQ,CAAC,KAAK;IAPlC,OAAO,CAAC,QAAQ,CAAC,sBAAsB,CAA0B;IACjE,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAe;IAE3C;;;OAGG;gBAC0B,KAAK,EAAE,gBAAgB;IAapD;;;;OAIG;IACU,eAAe,CACxB,eAAe,EAAE,eAAe,GACjC,OAAO,CAAC;QACP,SAAS,EAAE,eAAe,CAAC;QAC3B,QAAQ,EAAE,sBAAsB,CAAC;KACpC,CAAC;IAgBF;;;;;;;OAOG;IACU,aAAa,CACtB,EAAE,EAAE,MAAM,EACV,eAAe,EAAE,eAAe,EAChC,OAAO,CAAC,EAAE,qBAAqB,GAChC,OAAO,CAAC;QACP,SAAS,EAAE,eAAe,CAAC;QAC3B,QAAQ,EAAE,sBAAsB,CAAC;KACpC,CAAC;IAmCF;;;;;OAKG;IACU,YAAY,CACrB,EAAE,EAAE,MAAM,EACV,eAAe,EAAE,eAAe,GACjC,OAAO,CAAC;QACP,SAAS,EAAE,eAAe,CAAC;QAC3B,QAAQ,EAAE,sBAAsB,CAAC;KACpC,CAAC;IAgBF;;;;;;OAMG;IACU,oBAAoB,CAC7B,EAAE,EAAE,MAAM,EACV,OAAO,CAAC,EAAE,uBAAuB,GAClC,OAAO,CAAC,qBAAqB,EAAE,CAAC;IA4BnC,OAAO,CAAC,oBAAoB;IAM5B,OAAO,CAAC,YAAY;YAoBN,oBAAoB;CA4BrC"}
|
package/lib/AzureClient.js
CHANGED
|
@@ -8,12 +8,18 @@ import { RouterliciousDocumentServiceFactory } from "@fluidframework/routerlicio
|
|
|
8
8
|
import { requestFluidObject } from "@fluidframework/runtime-utils";
|
|
9
9
|
import { ensureFluidResolvedUrl } from "@fluidframework/driver-utils";
|
|
10
10
|
import { DOProviderContainerRuntimeFactory, FluidContainer, } from "@fluidframework/fluid-static";
|
|
11
|
+
import { SummaryType, } from "@fluidframework/protocol-definitions";
|
|
12
|
+
import { isAzureRemoteConnectionConfig } from "./utils";
|
|
11
13
|
import { AzureAudience } from "./AzureAudience";
|
|
12
14
|
import { AzureUrlResolver, createAzureCreateNewRequest, } from "./AzureUrlResolver";
|
|
13
15
|
/**
|
|
14
16
|
* Strongly typed id for connecting to a local Azure Fluid Relay.
|
|
15
17
|
*/
|
|
16
|
-
|
|
18
|
+
const LOCAL_MODE_TENANT_ID = "local";
|
|
19
|
+
const getTenantId = (connectionProps) => {
|
|
20
|
+
return isAzureRemoteConnectionConfig(connectionProps) ? connectionProps.tenantId : LOCAL_MODE_TENANT_ID;
|
|
21
|
+
};
|
|
22
|
+
const MAX_VERSION_COUNT = 5;
|
|
17
23
|
/**
|
|
18
24
|
* AzureClient provides the ability to have a Fluid object backed by the Azure Fluid Relay or,
|
|
19
25
|
* when running with local tenantId, have it be backed by a local Azure Fluid Relay instance.
|
|
@@ -25,11 +31,13 @@ export class AzureClient {
|
|
|
25
31
|
*/
|
|
26
32
|
constructor(props) {
|
|
27
33
|
this.props = props;
|
|
34
|
+
// remove trailing slash from URL if any
|
|
35
|
+
props.connection.endpoint = props.connection.endpoint.replace(/\/$/, "");
|
|
28
36
|
this.urlResolver = new AzureUrlResolver();
|
|
29
37
|
// The local service implementation differs from the Azure Fluid Relay in blob
|
|
30
38
|
// storage format. Azure Fluid Relay supports whole summary upload. Local currently does not.
|
|
31
|
-
const enableWholeSummaryUpload = this.props.connection
|
|
32
|
-
this.documentServiceFactory = new RouterliciousDocumentServiceFactory(this.props.connection.tokenProvider, { enableWholeSummaryUpload });
|
|
39
|
+
const enableWholeSummaryUpload = isAzureRemoteConnectionConfig(this.props.connection);
|
|
40
|
+
this.documentServiceFactory = new RouterliciousDocumentServiceFactory(this.props.connection.tokenProvider, { enableWholeSummaryUpload, enableDiscovery: true });
|
|
33
41
|
}
|
|
34
42
|
/**
|
|
35
43
|
* Creates a new detached container instance in the Azure Fluid Relay.
|
|
@@ -42,19 +50,39 @@ export class AzureClient {
|
|
|
42
50
|
package: "no-dynamic-package",
|
|
43
51
|
config: {},
|
|
44
52
|
});
|
|
45
|
-
const
|
|
46
|
-
const
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
53
|
+
const fluidContainer = await this.createFluidContainer(container, this.props.connection);
|
|
54
|
+
const services = this.getContainerServices(container);
|
|
55
|
+
return { container: fluidContainer, services };
|
|
56
|
+
}
|
|
57
|
+
/**
|
|
58
|
+
* Creates new detached container out of specific version of another container.
|
|
59
|
+
* @param id - Unique ID of the source container in Azure Fluid Relay.
|
|
60
|
+
* @param containerSchema - Container schema used to access data objects in the container.
|
|
61
|
+
* @param version - Unique version of the source container in Azure Fluid Relay.
|
|
62
|
+
* It defaults to latest version if parameter not provided.
|
|
63
|
+
* @returns New detached container instance along with associated services.
|
|
64
|
+
*/
|
|
65
|
+
async copyContainer(id, containerSchema, version) {
|
|
66
|
+
var _a;
|
|
67
|
+
const loader = this.createLoader(containerSchema);
|
|
68
|
+
const url = new URL(this.props.connection.endpoint);
|
|
69
|
+
url.searchParams.append("storage", encodeURIComponent(this.props.connection.endpoint));
|
|
70
|
+
url.searchParams.append("tenantId", encodeURIComponent(getTenantId(this.props.connection)));
|
|
71
|
+
url.searchParams.append("containerId", encodeURIComponent(id));
|
|
72
|
+
const sourceContainer = await loader.resolve({ url: url.href });
|
|
73
|
+
if (sourceContainer.resolvedUrl === undefined) {
|
|
74
|
+
throw new Error("Source container cannot resolve URL.");
|
|
75
|
+
}
|
|
76
|
+
const documentService = await this.documentServiceFactory.createDocumentService(sourceContainer.resolvedUrl);
|
|
77
|
+
const storage = await documentService.connectToStorage();
|
|
78
|
+
const handle = {
|
|
79
|
+
type: SummaryType.Handle,
|
|
80
|
+
handleType: SummaryType.Tree,
|
|
81
|
+
handle: (_a = version === null || version === void 0 ? void 0 : version.id) !== null && _a !== void 0 ? _a : "latest",
|
|
82
|
+
};
|
|
83
|
+
const tree = await storage.downloadSummary(handle);
|
|
84
|
+
const container = await loader.rehydrateDetachedContainerFromSnapshot(JSON.stringify(tree));
|
|
85
|
+
const fluidContainer = await this.createFluidContainer(container, this.props.connection);
|
|
58
86
|
const services = this.getContainerServices(container);
|
|
59
87
|
return { container: fluidContainer, services };
|
|
60
88
|
}
|
|
@@ -66,9 +94,9 @@ export class AzureClient {
|
|
|
66
94
|
*/
|
|
67
95
|
async getContainer(id, containerSchema) {
|
|
68
96
|
const loader = this.createLoader(containerSchema);
|
|
69
|
-
const url = new URL(this.props.connection.
|
|
70
|
-
url.searchParams.append("storage", encodeURIComponent(this.props.connection.
|
|
71
|
-
url.searchParams.append("tenantId", encodeURIComponent(this.props.connection
|
|
97
|
+
const url = new URL(this.props.connection.endpoint);
|
|
98
|
+
url.searchParams.append("storage", encodeURIComponent(this.props.connection.endpoint));
|
|
99
|
+
url.searchParams.append("tenantId", encodeURIComponent(getTenantId(this.props.connection)));
|
|
72
100
|
url.searchParams.append("containerId", encodeURIComponent(id));
|
|
73
101
|
const container = await loader.resolve({ url: url.href });
|
|
74
102
|
const rootDataObject = await requestFluidObject(container, "/");
|
|
@@ -76,6 +104,30 @@ export class AzureClient {
|
|
|
76
104
|
const services = this.getContainerServices(container);
|
|
77
105
|
return { container: fluidContainer, services };
|
|
78
106
|
}
|
|
107
|
+
/**
|
|
108
|
+
* Get the list of versions for specific container.
|
|
109
|
+
* @param id - Unique ID of the source container in Azure Fluid Relay.
|
|
110
|
+
* @param options - "Get" options. If options are not provided, API
|
|
111
|
+
* will assume maxCount of versions to retreive to be 5.
|
|
112
|
+
* @returns Array of available container versions.
|
|
113
|
+
*/
|
|
114
|
+
async getContainerVersions(id, options) {
|
|
115
|
+
var _a;
|
|
116
|
+
const url = new URL(this.props.connection.endpoint);
|
|
117
|
+
url.searchParams.append("storage", encodeURIComponent(this.props.connection.endpoint));
|
|
118
|
+
url.searchParams.append("tenantId", encodeURIComponent(getTenantId(this.props.connection)));
|
|
119
|
+
url.searchParams.append("containerId", encodeURIComponent(id));
|
|
120
|
+
const resolvedUrl = await this.urlResolver.resolve({ url: url.href });
|
|
121
|
+
if (!resolvedUrl) {
|
|
122
|
+
throw new Error("Unable to resolved URL");
|
|
123
|
+
}
|
|
124
|
+
const documentService = await this.documentServiceFactory.createDocumentService(resolvedUrl);
|
|
125
|
+
const storage = await documentService.connectToStorage();
|
|
126
|
+
const versions = await storage.getVersions(null, (_a = options === null || options === void 0 ? void 0 : options.maxCount) !== null && _a !== void 0 ? _a : MAX_VERSION_COUNT);
|
|
127
|
+
return versions.map((item) => {
|
|
128
|
+
return { id: item.id, date: item.date };
|
|
129
|
+
});
|
|
130
|
+
}
|
|
79
131
|
getContainerServices(container) {
|
|
80
132
|
return {
|
|
81
133
|
audience: new AzureAudience(container),
|
|
@@ -97,5 +149,20 @@ export class AzureClient {
|
|
|
97
149
|
logger: this.props.logger,
|
|
98
150
|
});
|
|
99
151
|
}
|
|
152
|
+
async createFluidContainer(container, connection) {
|
|
153
|
+
const createNewRequest = createAzureCreateNewRequest(connection.endpoint, getTenantId(connection));
|
|
154
|
+
const rootDataObject = await requestFluidObject(container, "/");
|
|
155
|
+
return new (class extends FluidContainer {
|
|
156
|
+
async attach() {
|
|
157
|
+
if (this.attachState !== AttachState.Detached) {
|
|
158
|
+
throw new Error("Cannot attach container. Container is not in detached state");
|
|
159
|
+
}
|
|
160
|
+
await container.attach(createNewRequest);
|
|
161
|
+
const resolved = container.resolvedUrl;
|
|
162
|
+
ensureFluidResolvedUrl(resolved);
|
|
163
|
+
return resolved.id;
|
|
164
|
+
}
|
|
165
|
+
})(container, rootDataObject);
|
|
166
|
+
}
|
|
100
167
|
}
|
|
101
168
|
//# sourceMappingURL=AzureClient.js.map
|
package/lib/AzureClient.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"AzureClient.js","sourceRoot":"","sources":["../src/AzureClient.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,EAAE,MAAM,EAAE,MAAM,kCAAkC,CAAC;AAK1D,OAAO,EACH,WAAW,GAGd,MAAM,uCAAuC,CAAC;AAC/C,OAAO,EAAE,mCAAmC,EAAE,MAAM,sCAAsC,CAAC;AAC3F,OAAO,EAAE,kBAAkB,EAAE,MAAM,+BAA+B,CAAC;AACnE,OAAO,EAAE,sBAAsB,EAAE,MAAM,8BAA8B,CAAC;AACtE,OAAO,EAEH,iCAAiC,EACjC,cAAc,GAGjB,MAAM,8BAA8B,CAAC;AAGtC,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EACH,gBAAgB,EAChB,2BAA2B,GAC9B,MAAM,oBAAoB,CAAC;AAE5B;;GAEG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAG,OAAO,CAAC;AAE5C;;;GAGG;AACH,MAAM,OAAO,WAAW;IAIpB;;;OAGG;IACH,YAA6B,KAAuB;QAAvB,UAAK,GAAL,KAAK,CAAkB;QAChD,IAAI,CAAC,WAAW,GAAG,IAAI,gBAAgB,EAAE,CAAC;QAC1C,8EAA8E;QAC9E,6FAA6F;QAC7F,MAAM,wBAAwB,GAC1B,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,QAAQ,KAAK,oBAAoB,CAAC;QAC5D,IAAI,CAAC,sBAAsB,GAAG,IAAI,mCAAmC,CACjE,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,aAAa,EACnC,EAAE,wBAAwB,EAAE,CAC/B,CAAC;IACN,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,eAAe,CACxB,eAAgC;QAKhC,MAAM,MAAM,GAAG,IAAI,CAAC,YAAY,CAAC,eAAe,CAAC,CAAC;QAElD,MAAM,SAAS,GAAG,MAAM,MAAM,CAAC,uBAAuB,CAAC;YACnD,OAAO,EAAE,oBAAoB;YAC7B,MAAM,EAAE,EAAE;SACb,CAAC,CAAC;QAEH,MAAM,cAAc,GAAG,MAAM,kBAAkB,CAC3C,SAAS,EACT,GAAG,CACN,CAAC;QACF,MAAM,gBAAgB,GAAG,2BAA2B,CAChD,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,OAAO,EAC7B,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,OAAO,EAC7B,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,QAAQ,CACjC,CAAC;QACF,MAAM,cAAc,GAAG,IAAI,CAAC,KAAM,SAAQ,cAAc;YACpD,KAAK,CAAC,MAAM;gBACR,IAAI,IAAI,CAAC,WAAW,KAAK,WAAW,CAAC,QAAQ,EAAE;oBAC3C,MAAM,IAAI,KAAK,CACX,6DAA6D,CAChE,CAAC;iBACL;gBACD,MAAM,SAAS,CAAC,MAAM,CAAC,gBAAgB,CAAC,CAAC;gBACzC,MAAM,QAAQ,GAAG,SAAS,CAAC,WAAW,CAAC;gBACvC,sBAAsB,CAAC,QAAQ,CAAC,CAAC;gBACjC,OAAO,QAAQ,CAAC,EAAE,CAAC;YACvB,CAAC;SACJ,CAAC,CAAC,SAAS,EAAE,cAAc,CAAC,CAAC;QAE9B,MAAM,QAAQ,GAAG,IAAI,CAAC,oBAAoB,CAAC,SAAS,CAAC,CAAC;QACtD,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,QAAQ,EAAE,CAAC;IACnD,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,YAAY,CACrB,EAAU,EACV,eAAgC;QAKhC,MAAM,MAAM,GAAG,IAAI,CAAC,YAAY,CAAC,eAAe,CAAC,CAAC;QAClD,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;QACnD,GAAG,CAAC,YAAY,CAAC,MAAM,CAAC,SAAS,EAAE,kBAAkB,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC;QACtF,GAAG,CAAC,YAAY,CAAC,MAAM,CAAC,UAAU,EAAE,kBAAkB,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAC;QACxF,GAAG,CAAC,YAAY,CAAC,MAAM,CAAC,aAAa,EAAE,kBAAkB,CAAC,EAAE,CAAC,CAAC,CAAC;QAC/D,MAAM,SAAS,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC,EAAE,GAAG,EAAE,GAAG,CAAC,IAAI,EAAE,CAAC,CAAC;QAC1D,MAAM,cAAc,GAAG,MAAM,kBAAkB,CAC3C,SAAS,EACT,GAAG,CACN,CAAC;QACF,MAAM,cAAc,GAAG,IAAI,cAAc,CAAC,SAAS,EAAE,cAAc,CAAC,CAAC;QACrE,MAAM,QAAQ,GAAG,IAAI,CAAC,oBAAoB,CAAC,SAAS,CAAC,CAAC;QACtD,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,QAAQ,EAAE,CAAC;IACnD,CAAC;IAEO,oBAAoB,CAAC,SAAqB;QAC9C,OAAO;YACH,QAAQ,EAAE,IAAI,aAAa,CAAC,SAAS,CAAC;SACzC,CAAC;IACN,CAAC;IAEO,YAAY,CAAC,eAAgC;QACjD,MAAM,cAAc,GAAG,IAAI,iCAAiC,CACxD,eAAe,CAClB,CAAC;QACF,MAAM,IAAI,GAAG,KAAK,IAAsC,EAAE;YACtD,OAAO;gBACH,MAAM,EAAE,EAAE,WAAW,EAAE,cAAc,EAAE;gBACvC,OAAO,EAAE,EAAE,OAAO,EAAE,oBAAoB,EAAE,MAAM,EAAE,EAAE,EAAE;aACzD,CAAC;QACN,CAAC,CAAC;QAEF,MAAM,UAAU,GAAG,EAAE,IAAI,EAAE,CAAC;QAC5B,OAAO,IAAI,MAAM,CAAC;YACd,WAAW,EAAE,IAAI,CAAC,WAAW;YAC7B,sBAAsB,EAAE,IAAI,CAAC,sBAAsB;YACnD,UAAU;YACV,MAAM,EAAE,IAAI,CAAC,KAAK,CAAC,MAAM;SAC5B,CAAC,CAAC;IACP,CAAC;CACJ","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\nimport { Loader } from \"@fluidframework/container-loader\";\nimport {\n IDocumentServiceFactory,\n IUrlResolver,\n} from \"@fluidframework/driver-definitions\";\nimport {\n AttachState,\n IContainer,\n IFluidModuleWithDetails,\n} from \"@fluidframework/container-definitions\";\nimport { RouterliciousDocumentServiceFactory } from \"@fluidframework/routerlicious-driver\";\nimport { requestFluidObject } from \"@fluidframework/runtime-utils\";\nimport { ensureFluidResolvedUrl } from \"@fluidframework/driver-utils\";\nimport {\n ContainerSchema,\n DOProviderContainerRuntimeFactory,\n FluidContainer,\n IFluidContainer,\n RootDataObject,\n} from \"@fluidframework/fluid-static\";\n\nimport { AzureClientProps, AzureContainerServices } from \"./interfaces\";\nimport { AzureAudience } from \"./AzureAudience\";\nimport {\n AzureUrlResolver,\n createAzureCreateNewRequest,\n} from \"./AzureUrlResolver\";\n\n/**\n * Strongly typed id for connecting to a local Azure Fluid Relay.\n */\nexport const LOCAL_MODE_TENANT_ID = \"local\";\n\n/**\n * AzureClient provides the ability to have a Fluid object backed by the Azure Fluid Relay or,\n * when running with local tenantId, have it be backed by a local Azure Fluid Relay instance.\n */\nexport class AzureClient {\n private readonly documentServiceFactory: IDocumentServiceFactory;\n private readonly urlResolver: IUrlResolver;\n\n /**\n * Creates a new client instance using configuration parameters.\n * @param props - Properties for initializing a new AzureClient instance\n */\n constructor(private readonly props: AzureClientProps) {\n this.urlResolver = new AzureUrlResolver();\n // The local service implementation differs from the Azure Fluid Relay in blob\n // storage format. Azure Fluid Relay supports whole summary upload. Local currently does not.\n const enableWholeSummaryUpload =\n this.props.connection.tenantId !== LOCAL_MODE_TENANT_ID;\n this.documentServiceFactory = new RouterliciousDocumentServiceFactory(\n this.props.connection.tokenProvider,\n { enableWholeSummaryUpload },\n );\n }\n\n /**\n * Creates a new detached container instance in the Azure Fluid Relay.\n * @param containerSchema - Container schema for the new container.\n * @returns New detached container instance along with associated services.\n */\n public async createContainer(\n containerSchema: ContainerSchema,\n ): Promise<{\n container: IFluidContainer;\n services: AzureContainerServices;\n }> {\n const loader = this.createLoader(containerSchema);\n\n const container = await loader.createDetachedContainer({\n package: \"no-dynamic-package\",\n config: {},\n });\n\n const rootDataObject = await requestFluidObject<RootDataObject>(\n container,\n \"/\",\n );\n const createNewRequest = createAzureCreateNewRequest(\n this.props.connection.orderer,\n this.props.connection.storage,\n this.props.connection.tenantId,\n );\n const fluidContainer = new (class extends FluidContainer {\n async attach() {\n if (this.attachState !== AttachState.Detached) {\n throw new Error(\n \"Cannot attach container. Container is not in detached state\",\n );\n }\n await container.attach(createNewRequest);\n const resolved = container.resolvedUrl;\n ensureFluidResolvedUrl(resolved);\n return resolved.id;\n }\n })(container, rootDataObject);\n\n const services = this.getContainerServices(container);\n return { container: fluidContainer, services };\n }\n\n /**\n * Accesses the existing container given its unique ID in the Azure Fluid Relay.\n * @param id - Unique ID of the container in Azure Fluid Relay.\n * @param containerSchema - Container schema used to access data objects in the container.\n * @returns Existing container instance along with associated services.\n */\n public async getContainer(\n id: string,\n containerSchema: ContainerSchema,\n ): Promise<{\n container: IFluidContainer;\n services: AzureContainerServices;\n }> {\n const loader = this.createLoader(containerSchema);\n const url = new URL(this.props.connection.orderer);\n url.searchParams.append(\"storage\", encodeURIComponent(this.props.connection.storage));\n url.searchParams.append(\"tenantId\", encodeURIComponent(this.props.connection.tenantId));\n url.searchParams.append(\"containerId\", encodeURIComponent(id));\n const container = await loader.resolve({ url: url.href });\n const rootDataObject = await requestFluidObject<RootDataObject>(\n container,\n \"/\",\n );\n const fluidContainer = new FluidContainer(container, rootDataObject);\n const services = this.getContainerServices(container);\n return { container: fluidContainer, services };\n }\n\n private getContainerServices(container: IContainer): AzureContainerServices {\n return {\n audience: new AzureAudience(container),\n };\n }\n\n private createLoader(containerSchema: ContainerSchema): Loader {\n const runtimeFactory = new DOProviderContainerRuntimeFactory(\n containerSchema,\n );\n const load = async (): Promise<IFluidModuleWithDetails> => {\n return {\n module: { fluidExport: runtimeFactory },\n details: { package: \"no-dynamic-package\", config: {} },\n };\n };\n\n const codeLoader = { load };\n return new Loader({\n urlResolver: this.urlResolver,\n documentServiceFactory: this.documentServiceFactory,\n codeLoader,\n logger: this.props.logger,\n });\n }\n}\n"]}
|
|
1
|
+
{"version":3,"file":"AzureClient.js","sourceRoot":"","sources":["../src/AzureClient.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,EAAE,MAAM,EAAE,MAAM,kCAAkC,CAAC;AAK1D,OAAO,EACH,WAAW,GAGd,MAAM,uCAAuC,CAAC;AAC/C,OAAO,EAAE,mCAAmC,EAAE,MAAM,sCAAsC,CAAC;AAC3F,OAAO,EAAE,kBAAkB,EAAE,MAAM,+BAA+B,CAAC;AACnE,OAAO,EAAE,sBAAsB,EAAE,MAAM,8BAA8B,CAAC;AACtE,OAAO,EAEH,iCAAiC,EACjC,cAAc,GAGjB,MAAM,8BAA8B,CAAC;AAEtC,OAAO,EACH,WAAW,GACd,MAAM,sCAAsC,CAAC;AAS9C,OAAO,EAAE,6BAA6B,EAAE,MAAM,SAAS,CAAC;AACxD,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EACH,gBAAgB,EAChB,2BAA2B,GAC9B,MAAM,oBAAoB,CAAC;AAE5B;;GAEG;AACH,MAAM,oBAAoB,GAAG,OAAO,CAAC;AACrC,MAAM,WAAW,GAAG,CAAC,eAAsC,EAAU,EAAE;IACnE,OAAO,6BAA6B,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,eAAe,CAAC,QAAQ,CAAC,CAAC,CAAC,oBAAoB,CAAC;AAC5G,CAAC,CAAC;AAEF,MAAM,iBAAiB,GAAG,CAAC,CAAC;AAE5B;;;GAGG;AACH,MAAM,OAAO,WAAW;IAIpB;;;OAGG;IACH,YAA6B,KAAuB;QAAvB,UAAK,GAAL,KAAK,CAAkB;QAChD,wCAAwC;QACxC,KAAK,CAAC,UAAU,CAAC,QAAQ,GAAG,KAAK,CAAC,UAAU,CAAC,QAAQ,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;QACzE,IAAI,CAAC,WAAW,GAAG,IAAI,gBAAgB,EAAE,CAAC;QAC1C,8EAA8E;QAC9E,6FAA6F;QAC7F,MAAM,wBAAwB,GAAG,6BAA6B,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;QACtF,IAAI,CAAC,sBAAsB,GAAG,IAAI,mCAAmC,CACjE,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,aAAa,EACnC,EAAE,wBAAwB,EAAE,eAAe,EAAE,IAAI,EAAE,CACtD,CAAC;IACN,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,eAAe,CACxB,eAAgC;QAKhC,MAAM,MAAM,GAAG,IAAI,CAAC,YAAY,CAAC,eAAe,CAAC,CAAC;QAElD,MAAM,SAAS,GAAG,MAAM,MAAM,CAAC,uBAAuB,CAAC;YACnD,OAAO,EAAE,oBAAoB;YAC7B,MAAM,EAAE,EAAE;SACb,CAAC,CAAC;QAEH,MAAM,cAAc,GAAG,MAAM,IAAI,CAAC,oBAAoB,CAClD,SAAS,EACT,IAAI,CAAC,KAAK,CAAC,UAAU,CACxB,CAAC;QACF,MAAM,QAAQ,GAAG,IAAI,CAAC,oBAAoB,CAAC,SAAS,CAAC,CAAC;QACtD,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,QAAQ,EAAE,CAAC;IACnD,CAAC;IAED;;;;;;;OAOG;IACI,KAAK,CAAC,aAAa,CACtB,EAAU,EACV,eAAgC,EAChC,OAA+B;;QAK/B,MAAM,MAAM,GAAG,IAAI,CAAC,YAAY,CAAC,eAAe,CAAC,CAAC;QAClD,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;QACpD,GAAG,CAAC,YAAY,CAAC,MAAM,CAAC,SAAS,EAAE,kBAAkB,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAC;QACvF,GAAG,CAAC,YAAY,CAAC,MAAM,CAAC,UAAU,EAAE,kBAAkB,CAAC,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;QAC5F,GAAG,CAAC,YAAY,CAAC,MAAM,CAAC,aAAa,EAAE,kBAAkB,CAAC,EAAE,CAAC,CAAC,CAAC;QAC/D,MAAM,eAAe,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC,EAAE,GAAG,EAAE,GAAG,CAAC,IAAI,EAAE,CAAC,CAAC;QAEhE,IAAI,eAAe,CAAC,WAAW,KAAK,SAAS,EAAE;YAC3C,MAAM,IAAI,KAAK,CACX,sCAAsC,CACzC,CAAC;SACL;QAED,MAAM,eAAe,GAAG,MAAM,IAAI,CAAC,sBAAsB,CAAC,qBAAqB,CAAC,eAAe,CAAC,WAAW,CAAC,CAAC;QAC7G,MAAM,OAAO,GAAG,MAAM,eAAe,CAAC,gBAAgB,EAAE,CAAC;QACzD,MAAM,MAAM,GAAG;YACX,IAAI,EAAE,WAAW,CAAC,MAAM;YACxB,UAAU,EAAE,WAAW,CAAC,IAAI;YAC5B,MAAM,EAAE,MAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,EAAE,mCAAI,QAAQ;SAClC,CAAC;QACF,MAAM,IAAI,GAAG,MAAM,OAAO,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC;QAEnD,MAAM,SAAS,GAAG,MAAM,MAAM,CAAC,sCAAsC,CACjE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CACvB,CAAC;QAEF,MAAM,cAAc,GAAG,MAAM,IAAI,CAAC,oBAAoB,CAClD,SAAS,EACT,IAAI,CAAC,KAAK,CAAC,UAAU,CACxB,CAAC;QACF,MAAM,QAAQ,GAAG,IAAI,CAAC,oBAAoB,CAAC,SAAS,CAAC,CAAC;QACtD,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,QAAQ,EAAE,CAAC;IACnD,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,YAAY,CACrB,EAAU,EACV,eAAgC;QAKhC,MAAM,MAAM,GAAG,IAAI,CAAC,YAAY,CAAC,eAAe,CAAC,CAAC;QAClD,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;QACpD,GAAG,CAAC,YAAY,CAAC,MAAM,CAAC,SAAS,EAAE,kBAAkB,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAC;QACvF,GAAG,CAAC,YAAY,CAAC,MAAM,CAAC,UAAU,EAAE,kBAAkB,CAAC,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;QAC5F,GAAG,CAAC,YAAY,CAAC,MAAM,CAAC,aAAa,EAAE,kBAAkB,CAAC,EAAE,CAAC,CAAC,CAAC;QAC/D,MAAM,SAAS,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC,EAAE,GAAG,EAAE,GAAG,CAAC,IAAI,EAAE,CAAC,CAAC;QAC1D,MAAM,cAAc,GAAG,MAAM,kBAAkB,CAC3C,SAAS,EACT,GAAG,CACN,CAAC;QACF,MAAM,cAAc,GAAG,IAAI,cAAc,CAAC,SAAS,EAAE,cAAc,CAAC,CAAC;QACrE,MAAM,QAAQ,GAAG,IAAI,CAAC,oBAAoB,CAAC,SAAS,CAAC,CAAC;QACtD,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,QAAQ,EAAE,CAAC;IACnD,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,oBAAoB,CAC7B,EAAU,EACV,OAAiC;;QAEjC,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;QACpD,GAAG,CAAC,YAAY,CAAC,MAAM,CACnB,SAAS,EACT,kBAAkB,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,QAAQ,CAAC,CACrD,CAAC;QACF,GAAG,CAAC,YAAY,CAAC,MAAM,CACnB,UAAU,EACV,kBAAkB,CAAC,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CACzD,CAAC;QACF,GAAG,CAAC,YAAY,CAAC,MAAM,CAAC,aAAa,EAAE,kBAAkB,CAAC,EAAE,CAAC,CAAC,CAAC;QAE/D,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,EAAE,GAAG,EAAE,GAAG,CAAC,IAAI,EAAE,CAAC,CAAC;QACtE,IAAI,CAAC,WAAW,EAAE;YACd,MAAM,IAAI,KAAK,CAAC,wBAAwB,CAAC,CAAC;SAC7C;QACD,MAAM,eAAe,GACjB,MAAM,IAAI,CAAC,sBAAsB,CAAC,qBAAqB,CACnD,WAAW,CACd,CAAC;QACN,MAAM,OAAO,GAAG,MAAM,eAAe,CAAC,gBAAgB,EAAE,CAAC;QACzD,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,WAAW,CAAC,IAAI,EAAE,MAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,QAAQ,mCAAI,iBAAiB,CAAC,CAAC;QAEzF,OAAO,QAAQ,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE;YACzB,OAAO,EAAE,EAAE,EAAE,IAAI,CAAC,EAAE,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,CAAC;QAC5C,CAAC,CAAC,CAAC;IACP,CAAC;IAEO,oBAAoB,CAAC,SAAqB;QAC9C,OAAO;YACH,QAAQ,EAAE,IAAI,aAAa,CAAC,SAAS,CAAC;SACzC,CAAC;IACN,CAAC;IAEO,YAAY,CAAC,eAAgC;QACjD,MAAM,cAAc,GAAG,IAAI,iCAAiC,CACxD,eAAe,CAClB,CAAC;QACF,MAAM,IAAI,GAAG,KAAK,IAAsC,EAAE;YACtD,OAAO;gBACH,MAAM,EAAE,EAAE,WAAW,EAAE,cAAc,EAAE;gBACvC,OAAO,EAAE,EAAE,OAAO,EAAE,oBAAoB,EAAE,MAAM,EAAE,EAAE,EAAE;aACzD,CAAC;QACN,CAAC,CAAC;QAEF,MAAM,UAAU,GAAG,EAAE,IAAI,EAAE,CAAC;QAC5B,OAAO,IAAI,MAAM,CAAC;YACd,WAAW,EAAE,IAAI,CAAC,WAAW;YAC7B,sBAAsB,EAAE,IAAI,CAAC,sBAAsB;YACnD,UAAU;YACV,MAAM,EAAE,IAAI,CAAC,KAAK,CAAC,MAAM;SAC5B,CAAC,CAAC;IACP,CAAC;IAEO,KAAK,CAAC,oBAAoB,CAC9B,SAAqB,EACrB,UAAiC;QAEjC,MAAM,gBAAgB,GAAG,2BAA2B,CAChD,UAAU,CAAC,QAAQ,EACnB,WAAW,CAAC,UAAU,CAAC,CAC1B,CAAC;QAEF,MAAM,cAAc,GAAG,MAAM,kBAAkB,CAC3C,SAAS,EACT,GAAG,CACN,CAAC;QACF,OAAO,IAAI,CAAC,KAAM,SAAQ,cAAc;YACpC,KAAK,CAAC,MAAM;gBACR,IAAI,IAAI,CAAC,WAAW,KAAK,WAAW,CAAC,QAAQ,EAAE;oBAC3C,MAAM,IAAI,KAAK,CACX,6DAA6D,CAChE,CAAC;iBACL;gBACD,MAAM,SAAS,CAAC,MAAM,CAAC,gBAAgB,CAAC,CAAC;gBACzC,MAAM,QAAQ,GAAG,SAAS,CAAC,WAAW,CAAC;gBACvC,sBAAsB,CAAC,QAAQ,CAAC,CAAC;gBACjC,OAAO,QAAQ,CAAC,EAAE,CAAC;YACvB,CAAC;SACJ,CAAC,CAAC,SAAS,EAAE,cAAc,CAAC,CAAC;IAClC,CAAC;CAEJ","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\nimport { Loader } from \"@fluidframework/container-loader\";\nimport {\n IDocumentServiceFactory,\n IUrlResolver,\n} from \"@fluidframework/driver-definitions\";\nimport {\n AttachState,\n IContainer,\n IFluidModuleWithDetails,\n} from \"@fluidframework/container-definitions\";\nimport { RouterliciousDocumentServiceFactory } from \"@fluidframework/routerlicious-driver\";\nimport { requestFluidObject } from \"@fluidframework/runtime-utils\";\nimport { ensureFluidResolvedUrl } from \"@fluidframework/driver-utils\";\nimport {\n ContainerSchema,\n DOProviderContainerRuntimeFactory,\n FluidContainer,\n IFluidContainer,\n RootDataObject,\n} from \"@fluidframework/fluid-static\";\n\nimport {\n SummaryType,\n} from \"@fluidframework/protocol-definitions\";\n\nimport {\n AzureClientProps,\n AzureConnectionConfig,\n AzureContainerServices,\n AzureContainerVersion,\n AzureGetVersionsOptions,\n} from \"./interfaces\";\nimport { isAzureRemoteConnectionConfig } from \"./utils\";\nimport { AzureAudience } from \"./AzureAudience\";\nimport {\n AzureUrlResolver,\n createAzureCreateNewRequest,\n} from \"./AzureUrlResolver\";\n\n/**\n * Strongly typed id for connecting to a local Azure Fluid Relay.\n */\nconst LOCAL_MODE_TENANT_ID = \"local\";\nconst getTenantId = (connectionProps: AzureConnectionConfig): string => {\n return isAzureRemoteConnectionConfig(connectionProps) ? connectionProps.tenantId : LOCAL_MODE_TENANT_ID;\n};\n\nconst MAX_VERSION_COUNT = 5;\n\n/**\n * AzureClient provides the ability to have a Fluid object backed by the Azure Fluid Relay or,\n * when running with local tenantId, have it be backed by a local Azure Fluid Relay instance.\n */\nexport class AzureClient {\n private readonly documentServiceFactory: IDocumentServiceFactory;\n private readonly urlResolver: IUrlResolver;\n\n /**\n * Creates a new client instance using configuration parameters.\n * @param props - Properties for initializing a new AzureClient instance\n */\n constructor(private readonly props: AzureClientProps) {\n // remove trailing slash from URL if any\n props.connection.endpoint = props.connection.endpoint.replace(/\\/$/, \"\");\n this.urlResolver = new AzureUrlResolver();\n // The local service implementation differs from the Azure Fluid Relay in blob\n // storage format. Azure Fluid Relay supports whole summary upload. Local currently does not.\n const enableWholeSummaryUpload = isAzureRemoteConnectionConfig(this.props.connection);\n this.documentServiceFactory = new RouterliciousDocumentServiceFactory(\n this.props.connection.tokenProvider,\n { enableWholeSummaryUpload, enableDiscovery: true },\n );\n }\n\n /**\n * Creates a new detached container instance in the Azure Fluid Relay.\n * @param containerSchema - Container schema for the new container.\n * @returns New detached container instance along with associated services.\n */\n public async createContainer(\n containerSchema: ContainerSchema,\n ): Promise<{\n container: IFluidContainer;\n services: AzureContainerServices;\n }> {\n const loader = this.createLoader(containerSchema);\n\n const container = await loader.createDetachedContainer({\n package: \"no-dynamic-package\",\n config: {},\n });\n\n const fluidContainer = await this.createFluidContainer(\n container,\n this.props.connection,\n );\n const services = this.getContainerServices(container);\n return { container: fluidContainer, services };\n }\n\n /**\n * Creates new detached container out of specific version of another container.\n * @param id - Unique ID of the source container in Azure Fluid Relay.\n * @param containerSchema - Container schema used to access data objects in the container.\n * @param version - Unique version of the source container in Azure Fluid Relay.\n * It defaults to latest version if parameter not provided.\n * @returns New detached container instance along with associated services.\n */\n public async copyContainer(\n id: string,\n containerSchema: ContainerSchema,\n version?: AzureContainerVersion,\n ): Promise<{\n container: IFluidContainer;\n services: AzureContainerServices;\n }> {\n const loader = this.createLoader(containerSchema);\n const url = new URL(this.props.connection.endpoint);\n url.searchParams.append(\"storage\", encodeURIComponent(this.props.connection.endpoint));\n url.searchParams.append(\"tenantId\", encodeURIComponent(getTenantId(this.props.connection)));\n url.searchParams.append(\"containerId\", encodeURIComponent(id));\n const sourceContainer = await loader.resolve({ url: url.href });\n\n if (sourceContainer.resolvedUrl === undefined) {\n throw new Error(\n \"Source container cannot resolve URL.\",\n );\n }\n\n const documentService = await this.documentServiceFactory.createDocumentService(sourceContainer.resolvedUrl);\n const storage = await documentService.connectToStorage();\n const handle = {\n type: SummaryType.Handle,\n handleType: SummaryType.Tree,\n handle: version?.id ?? \"latest\",\n };\n const tree = await storage.downloadSummary(handle);\n\n const container = await loader.rehydrateDetachedContainerFromSnapshot(\n JSON.stringify(tree),\n );\n\n const fluidContainer = await this.createFluidContainer(\n container,\n this.props.connection,\n );\n const services = this.getContainerServices(container);\n return { container: fluidContainer, services };\n }\n\n /**\n * Accesses the existing container given its unique ID in the Azure Fluid Relay.\n * @param id - Unique ID of the container in Azure Fluid Relay.\n * @param containerSchema - Container schema used to access data objects in the container.\n * @returns Existing container instance along with associated services.\n */\n public async getContainer(\n id: string,\n containerSchema: ContainerSchema,\n ): Promise<{\n container: IFluidContainer;\n services: AzureContainerServices;\n }> {\n const loader = this.createLoader(containerSchema);\n const url = new URL(this.props.connection.endpoint);\n url.searchParams.append(\"storage\", encodeURIComponent(this.props.connection.endpoint));\n url.searchParams.append(\"tenantId\", encodeURIComponent(getTenantId(this.props.connection)));\n url.searchParams.append(\"containerId\", encodeURIComponent(id));\n const container = await loader.resolve({ url: url.href });\n const rootDataObject = await requestFluidObject<RootDataObject>(\n container,\n \"/\",\n );\n const fluidContainer = new FluidContainer(container, rootDataObject);\n const services = this.getContainerServices(container);\n return { container: fluidContainer, services };\n }\n\n /**\n * Get the list of versions for specific container.\n * @param id - Unique ID of the source container in Azure Fluid Relay.\n * @param options - \"Get\" options. If options are not provided, API\n * will assume maxCount of versions to retreive to be 5.\n * @returns Array of available container versions.\n */\n public async getContainerVersions(\n id: string,\n options?: AzureGetVersionsOptions,\n ): Promise<AzureContainerVersion[]> {\n const url = new URL(this.props.connection.endpoint);\n url.searchParams.append(\n \"storage\",\n encodeURIComponent(this.props.connection.endpoint),\n );\n url.searchParams.append(\n \"tenantId\",\n encodeURIComponent(getTenantId(this.props.connection)),\n );\n url.searchParams.append(\"containerId\", encodeURIComponent(id));\n\n const resolvedUrl = await this.urlResolver.resolve({ url: url.href });\n if (!resolvedUrl) {\n throw new Error(\"Unable to resolved URL\");\n }\n const documentService =\n await this.documentServiceFactory.createDocumentService(\n resolvedUrl,\n );\n const storage = await documentService.connectToStorage();\n const versions = await storage.getVersions(null, options?.maxCount ?? MAX_VERSION_COUNT);\n\n return versions.map((item) => {\n return { id: item.id, date: item.date };\n });\n }\n\n private getContainerServices(container: IContainer): AzureContainerServices {\n return {\n audience: new AzureAudience(container),\n };\n }\n\n private createLoader(containerSchema: ContainerSchema): Loader {\n const runtimeFactory = new DOProviderContainerRuntimeFactory(\n containerSchema,\n );\n const load = async (): Promise<IFluidModuleWithDetails> => {\n return {\n module: { fluidExport: runtimeFactory },\n details: { package: \"no-dynamic-package\", config: {} },\n };\n };\n\n const codeLoader = { load };\n return new Loader({\n urlResolver: this.urlResolver,\n documentServiceFactory: this.documentServiceFactory,\n codeLoader,\n logger: this.props.logger,\n });\n }\n\n private async createFluidContainer(\n container: IContainer,\n connection: AzureConnectionConfig,\n ): Promise<FluidContainer> {\n const createNewRequest = createAzureCreateNewRequest(\n connection.endpoint,\n getTenantId(connection),\n );\n\n const rootDataObject = await requestFluidObject<RootDataObject>(\n container,\n \"/\",\n );\n return new (class extends FluidContainer {\n async attach() {\n if (this.attachState !== AttachState.Detached) {\n throw new Error(\n \"Cannot attach container. Container is not in detached state\",\n );\n }\n await container.attach(createNewRequest);\n const resolved = container.resolvedUrl;\n ensureFluidResolvedUrl(resolved);\n return resolved.id;\n }\n })(container, rootDataObject);\n }\n // #endregion\n}\n"]}
|
|
@@ -9,5 +9,5 @@ export declare class AzureUrlResolver implements IUrlResolver {
|
|
|
9
9
|
resolve(request: IRequest): Promise<IFluidResolvedUrl>;
|
|
10
10
|
getAbsoluteUrl(resolvedUrl: IResolvedUrl, relativeUrl: string): Promise<string>;
|
|
11
11
|
}
|
|
12
|
-
export declare const createAzureCreateNewRequest: (
|
|
12
|
+
export declare const createAzureCreateNewRequest: (endpointUrl: string, tenantId: string) => IRequest;
|
|
13
13
|
//# sourceMappingURL=AzureUrlResolver.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"AzureUrlResolver.d.ts","sourceRoot":"","sources":["../src/AzureUrlResolver.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,QAAQ,EAAE,MAAM,iCAAiC,CAAC;AAC3D,OAAO,EAEH,iBAAiB,EACjB,YAAY,EACZ,YAAY,EACf,MAAM,oCAAoC,CAAC;AAM5C,qBAAa,gBAAiB,YAAW,YAAY;;IAGpC,OAAO,CAAC,OAAO,EAAE,QAAQ,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAyCtD,cAAc,CACvB,WAAW,EAAE,YAAY,EACzB,WAAW,EAAE,MAAM,GACpB,OAAO,CAAC,MAAM,CAAC;CAMrB;AA+BD,eAAO,MAAM,2BAA2B,
|
|
1
|
+
{"version":3,"file":"AzureUrlResolver.d.ts","sourceRoot":"","sources":["../src/AzureUrlResolver.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,QAAQ,EAAE,MAAM,iCAAiC,CAAC;AAC3D,OAAO,EAEH,iBAAiB,EACjB,YAAY,EACZ,YAAY,EACf,MAAM,oCAAoC,CAAC;AAM5C,qBAAa,gBAAiB,YAAW,YAAY;;IAGpC,OAAO,CAAC,OAAO,EAAE,QAAQ,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAyCtD,cAAc,CACvB,WAAW,EAAE,YAAY,EACzB,WAAW,EAAE,MAAM,GACpB,OAAO,CAAC,MAAM,CAAC;CAMrB;AA+BD,eAAO,MAAM,2BAA2B,gBACvB,MAAM,YACT,MAAM,KACjB,QAUF,CAAC"}
|
package/lib/AzureUrlResolver.js
CHANGED
|
@@ -75,9 +75,9 @@ function decodeAzureUrl(urlString) {
|
|
|
75
75
|
containerId: containerIdDecoded,
|
|
76
76
|
};
|
|
77
77
|
}
|
|
78
|
-
export const createAzureCreateNewRequest = (
|
|
79
|
-
const url = new URL(
|
|
80
|
-
url.searchParams.append("storage", encodeURIComponent(
|
|
78
|
+
export const createAzureCreateNewRequest = (endpointUrl, tenantId) => {
|
|
79
|
+
const url = new URL(endpointUrl);
|
|
80
|
+
url.searchParams.append("storage", encodeURIComponent(endpointUrl));
|
|
81
81
|
url.searchParams.append("tenantId", encodeURIComponent(tenantId));
|
|
82
82
|
return {
|
|
83
83
|
url: url.href,
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"AzureUrlResolver.js","sourceRoot":"","sources":["../src/AzureUrlResolver.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EACH,YAAY,GAIf,MAAM,oCAAoC,CAAC;AAE5C,2FAA2F;AAC3F,sFAAsF;AACtF,8FAA8F;AAC9F,2BAA2B;AAC3B,MAAM,OAAO,gBAAgB;IACzB,
|
|
1
|
+
{"version":3,"file":"AzureUrlResolver.js","sourceRoot":"","sources":["../src/AzureUrlResolver.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EACH,YAAY,GAIf,MAAM,oCAAoC,CAAC;AAE5C,2FAA2F;AAC3F,sFAAsF;AACtF,8FAA8F;AAC9F,2BAA2B;AAC3B,MAAM,OAAO,gBAAgB;IACzB,gBAAgB,CAAC;IAEV,KAAK,CAAC,OAAO,CAAC,OAAiB;QAClC,MAAM,EAAE,UAAU,EAAE,UAAU,EAAE,QAAQ,EAAE,WAAW,EAAE,GAAG,cAAc,CACpE,OAAO,CAAC,GAAG,CACd,CAAC;QACF,oEAAoE;QACpE,uFAAuF;QACvF,IACI,OAAO,CAAC,OAAO;YACf,OAAO,CAAC,OAAO,CAAC,YAAY,CAAC,SAAS,CAAC,KAAK,IAAI,EAClD;YACE,OAAO;gBACH,SAAS,EAAE;oBACP,eAAe,EAAE,GAAG,UAAU,WAAW,QAAQ,MAAM;oBACvD,UAAU;oBACV,UAAU,EAAE,GAAG,UAAU,UAAU,QAAQ,EAAE;iBAChD;gBACD,0FAA0F;gBAC1F,EAAE,EAAE,EAAE;gBACN,+EAA+E;gBAC/E,MAAM,EAAE,EAAE;gBACV,IAAI,EAAE,OAAO;gBACb,GAAG,EAAE,GAAG,UAAU,IAAI,QAAQ,MAAM;aACvC,CAAC;SACL;QACD,IAAI,WAAW,KAAK,SAAS,EAAE;YAC3B,MAAM,IAAI,KAAK,CAAC,uCAAuC,CAAC,CAAC;SAC5D;QACD,MAAM,WAAW,GAAG,GAAG,UAAU,IAAI,QAAQ,IAAI,WAAW,EAAE,CAAC;QAC/D,OAAO,OAAO,CAAC,OAAO,CAAC;YACnB,SAAS,EAAE;gBACP,eAAe,EAAE,GAAG,UAAU,WAAW,QAAQ,IAAI,WAAW,EAAE;gBAClE,UAAU;gBACV,UAAU,EAAE,GAAG,UAAU,UAAU,QAAQ,EAAE;aAChD;YACD,EAAE,EAAE,WAAW;YACf,MAAM,EAAE,EAAE;YACV,IAAI,EAAE,OAAO;YACb,GAAG,EAAE,WAAW;SACnB,CAAC,CAAC;IACP,CAAC;IAEM,KAAK,CAAC,cAAc,CACvB,WAAyB,EACzB,WAAmB;QAEnB,IAAI,WAAW,CAAC,IAAI,KAAK,OAAO,EAAE;YAC9B,MAAM,KAAK,CAAC,sBAAsB,CAAC,CAAC;SACvC;QACD,OAAO,GAAG,WAAW,CAAC,GAAG,IAAI,WAAW,EAAE,CAAC;IAC/C,CAAC;CACJ;AAED,SAAS,cAAc,CAAC,SAAiB;IAMrC,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,SAAS,CAAC,CAAC;IAC/B,MAAM,UAAU,GAAG,GAAG,CAAC,MAAM,CAAC;IAC9B,MAAM,YAAY,GAAG,GAAG,CAAC,YAAY,CAAC;IACtC,MAAM,UAAU,GAAG,YAAY,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;IAC/C,IAAI,UAAU,KAAK,IAAI,EAAE;QACrB,MAAM,IAAI,KAAK,CAAC,yCAAyC,CAAC,CAAC;KAC9D;IACD,MAAM,QAAQ,GAAG,YAAY,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;IAC9C,IAAI,QAAQ,KAAK,IAAI,EAAE;QACnB,MAAM,IAAI,KAAK,CAAC,uCAAuC,CAAC,CAAC;KAC5D;IACD,MAAM,iBAAiB,GAAG,kBAAkB,CAAC,UAAU,CAAC,CAAC;IACzD,MAAM,eAAe,GAAG,kBAAkB,CAAC,QAAQ,CAAC,CAAC;IACrD,MAAM,WAAW,GAAG,YAAY,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC;IACpD,MAAM,kBAAkB,GAAG,WAAW,KAAK,IAAI,CAAC,CAAC,CAAC,kBAAkB,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IAC9F,OAAO;QACH,UAAU;QACV,UAAU,EAAE,iBAAiB;QAC7B,QAAQ,EAAE,eAAe;QACzB,WAAW,EAAE,kBAAkB;KAClC,CAAC;AACN,CAAC;AAED,MAAM,CAAC,MAAM,2BAA2B,GAAG,CACvC,WAAmB,EACnB,QAAgB,EACR,EAAE;IACV,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,WAAW,CAAC,CAAC;IACjC,GAAG,CAAC,YAAY,CAAC,MAAM,CAAC,SAAS,EAAE,kBAAkB,CAAC,WAAW,CAAC,CAAC,CAAC;IACpE,GAAG,CAAC,YAAY,CAAC,MAAM,CAAC,UAAU,EAAE,kBAAkB,CAAC,QAAQ,CAAC,CAAC,CAAC;IAClE,OAAO;QACH,GAAG,EAAE,GAAG,CAAC,IAAI;QACb,OAAO,EAAE;YACL,CAAC,YAAY,CAAC,SAAS,CAAC,EAAE,IAAI;SACjC;KACJ,CAAC;AACN,CAAC,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { IRequest } from \"@fluidframework/core-interfaces\";\nimport {\n DriverHeader,\n IFluidResolvedUrl,\n IResolvedUrl,\n IUrlResolver,\n} from \"@fluidframework/driver-definitions\";\n\n// Implementation of a URL resolver to resolve documents stored using the Azure Fluid Relay\n// based off of the orderer and storage URLs provide. The token provider here can be a\n// InsecureTokenProvider for basic scenarios or more robust, secure providers that fulfill the\n// ITokenProvider interface\nexport class AzureUrlResolver implements IUrlResolver {\n constructor() { }\n\n public async resolve(request: IRequest): Promise<IFluidResolvedUrl> {\n const { ordererUrl, storageUrl, tenantId, containerId } = decodeAzureUrl(\n request.url,\n );\n // determine whether the request is for creating of a new container.\n // such request has the `createNew` header set to true and doesn't have a container ID.\n if (\n request.headers &&\n request.headers[DriverHeader.createNew] === true\n ) {\n return {\n endpoints: {\n deltaStorageUrl: `${ordererUrl}/deltas/${tenantId}/new`,\n ordererUrl,\n storageUrl: `${storageUrl}/repos/${tenantId}`,\n },\n // id is a mandatory attribute, but it's ignored by the driver for new container requests.\n id: \"\",\n // tokens attribute is redundant as all tokens are generated via ITokenProvider\n tokens: {},\n type: \"fluid\",\n url: `${ordererUrl}/${tenantId}/new`,\n };\n }\n if (containerId === undefined) {\n throw new Error(\"Azure URL did not contain containerId\");\n }\n const documentUrl = `${ordererUrl}/${tenantId}/${containerId}`;\n return Promise.resolve({\n endpoints: {\n deltaStorageUrl: `${ordererUrl}/deltas/${tenantId}/${containerId}`,\n ordererUrl,\n storageUrl: `${storageUrl}/repos/${tenantId}`,\n },\n id: containerId,\n tokens: {},\n type: \"fluid\",\n url: documentUrl,\n });\n }\n\n public async getAbsoluteUrl(\n resolvedUrl: IResolvedUrl,\n relativeUrl: string,\n ): Promise<string> {\n if (resolvedUrl.type !== \"fluid\") {\n throw Error(\"Invalid Resolved Url\");\n }\n return `${resolvedUrl.url}/${relativeUrl}`;\n }\n}\n\nfunction decodeAzureUrl(urlString: string): {\n ordererUrl: string;\n storageUrl: string;\n tenantId: string;\n containerId?: string;\n} {\n const url = new URL(urlString);\n const ordererUrl = url.origin;\n const searchParams = url.searchParams;\n const storageUrl = searchParams.get(\"storage\");\n if (storageUrl === null) {\n throw new Error(\"Azure URL did not contain a storage URL\");\n }\n const tenantId = searchParams.get(\"tenantId\");\n if (tenantId === null) {\n throw new Error(\"Azure URL did not contain a tenant ID\");\n }\n const storageUrlDecoded = decodeURIComponent(storageUrl);\n const tenantIdDecoded = decodeURIComponent(tenantId);\n const containerId = searchParams.get(\"containerId\");\n const containerIdDecoded = containerId !== null ? decodeURIComponent(containerId) : undefined;\n return {\n ordererUrl,\n storageUrl: storageUrlDecoded,\n tenantId: tenantIdDecoded,\n containerId: containerIdDecoded,\n };\n}\n\nexport const createAzureCreateNewRequest = (\n endpointUrl: string,\n tenantId: string,\n): IRequest => {\n const url = new URL(endpointUrl);\n url.searchParams.append(\"storage\", encodeURIComponent(endpointUrl));\n url.searchParams.append(\"tenantId\", encodeURIComponent(tenantId));\n return {\n url: url.href,\n headers: {\n [DriverHeader.createNew]: true,\n },\n };\n};\n"]}
|
package/lib/interfaces.d.ts
CHANGED
|
@@ -19,27 +19,74 @@ export interface AzureClientProps {
|
|
|
19
19
|
*/
|
|
20
20
|
readonly logger?: ITelemetryBaseLogger;
|
|
21
21
|
}
|
|
22
|
+
/**
|
|
23
|
+
* Container version metadata.
|
|
24
|
+
*/
|
|
25
|
+
export interface AzureContainerVersion {
|
|
26
|
+
/**
|
|
27
|
+
* Version ID
|
|
28
|
+
*/
|
|
29
|
+
id: string;
|
|
30
|
+
/**
|
|
31
|
+
* Time when version was generated.
|
|
32
|
+
* ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ
|
|
33
|
+
*/
|
|
34
|
+
date?: string;
|
|
35
|
+
}
|
|
36
|
+
/**
|
|
37
|
+
* Options for "Get Container Versions" API.
|
|
38
|
+
*/
|
|
39
|
+
export interface AzureGetVersionsOptions {
|
|
40
|
+
/**
|
|
41
|
+
* Max number of versions
|
|
42
|
+
*/
|
|
43
|
+
maxCount: number;
|
|
44
|
+
}
|
|
45
|
+
/**
|
|
46
|
+
* The type of connection.
|
|
47
|
+
* - "local" for local connections to a Fluid relay instance running on the localhost
|
|
48
|
+
* - "remote" for client connections to the Azure Fluid Relay service
|
|
49
|
+
*/
|
|
50
|
+
export declare type AzureConnectionConfigType = "local" | "remote";
|
|
22
51
|
/**
|
|
23
52
|
* Parameters for establishing a connection with the Azure Fluid Relay.
|
|
24
53
|
*/
|
|
25
54
|
export interface AzureConnectionConfig {
|
|
26
55
|
/**
|
|
27
|
-
*
|
|
56
|
+
* The type of connection. Whether we're connecting to a remote Fluid relay server or a local instance.
|
|
28
57
|
*/
|
|
29
|
-
|
|
58
|
+
type: AzureConnectionConfigType;
|
|
30
59
|
/**
|
|
31
|
-
* URI to the Azure Fluid Relay
|
|
60
|
+
* URI to the Azure Fluid Relay service discovery endpoint.
|
|
32
61
|
*/
|
|
33
|
-
|
|
62
|
+
endpoint: string;
|
|
34
63
|
/**
|
|
35
|
-
*
|
|
36
|
-
*/
|
|
37
|
-
tenantId: "local" | string;
|
|
38
|
-
/**
|
|
39
|
-
* Instance that provides Azure Fluid Relay endpoint tokens
|
|
64
|
+
* Instance that provides Azure Fluid Relay endpoint tokens.
|
|
40
65
|
*/
|
|
41
66
|
tokenProvider: ITokenProvider;
|
|
42
67
|
}
|
|
68
|
+
/**
|
|
69
|
+
* Parameters for establishing a remote connection with the Azure Fluid Relay.
|
|
70
|
+
*/
|
|
71
|
+
export interface AzureRemoteConnectionConfig extends AzureConnectionConfig {
|
|
72
|
+
/**
|
|
73
|
+
* The type of connection. Set to a remote connection.
|
|
74
|
+
*/
|
|
75
|
+
type: "remote";
|
|
76
|
+
/**
|
|
77
|
+
* Unique tenant identifier.
|
|
78
|
+
*/
|
|
79
|
+
tenantId: string;
|
|
80
|
+
}
|
|
81
|
+
/**
|
|
82
|
+
* Parameters for establishing a local connection with a local instance of the Azure Fluid Relay.
|
|
83
|
+
*/
|
|
84
|
+
export interface AzureLocalConnectionConfig extends AzureConnectionConfig {
|
|
85
|
+
/**
|
|
86
|
+
* The type of connection. Set to a remote connection.
|
|
87
|
+
*/
|
|
88
|
+
type: "local";
|
|
89
|
+
}
|
|
43
90
|
/**
|
|
44
91
|
* AzureContainerServices is returned by the AzureClient alongside a FluidContainer.
|
|
45
92
|
* It holds the functionality specifically tied to the Azure Fluid Relay, and how the data stored in
|
package/lib/interfaces.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"interfaces.d.ts","sourceRoot":"","sources":["../src/interfaces.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,oBAAoB,EAAE,MAAM,oCAAoC,CAAC;AAC1E,OAAO,EACH,OAAO,EACP,gBAAgB,EACnB,MAAM,8BAA8B,CAAC;AACtC,OAAO,EAAE,cAAc,EAAE,MAAM,sCAAsC,CAAC;AAGtE,OAAO,EACH,mBAAmB,EACnB,oBAAoB,GACvB,MAAM,oCAAoC,CAAC;AAE5C;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC7B;;OAEG;IACH,QAAQ,CAAC,UAAU,EAAE,qBAAqB,CAAC;IAC3C;;OAEG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,oBAAoB,CAAC;CAC1C;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IAClC;;OAEG;IACH,
|
|
1
|
+
{"version":3,"file":"interfaces.d.ts","sourceRoot":"","sources":["../src/interfaces.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,oBAAoB,EAAE,MAAM,oCAAoC,CAAC;AAC1E,OAAO,EACH,OAAO,EACP,gBAAgB,EACnB,MAAM,8BAA8B,CAAC;AACtC,OAAO,EAAE,cAAc,EAAE,MAAM,sCAAsC,CAAC;AAGtE,OAAO,EACH,mBAAmB,EACnB,oBAAoB,GACvB,MAAM,oCAAoC,CAAC;AAE5C;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC7B;;OAEG;IACH,QAAQ,CAAC,UAAU,EAAE,qBAAqB,CAAC;IAC3C;;OAEG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,oBAAoB,CAAC;CAC1C;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IAClC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACpC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;CACpB;AAED;;;;GAIG;AACH,oBAAY,yBAAyB,GAAG,OAAO,GAAG,QAAQ,CAAC;AAE3D;;GAEG;AACH,MAAM,WAAW,qBAAqB;IAClC;;OAEG;IACH,IAAI,EAAE,yBAAyB,CAAC;IAChC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,aAAa,EAAE,cAAc,CAAC;CACjC;AAED;;GAEG;AACH,MAAM,WAAW,2BAA4B,SAAQ,qBAAqB;IACtE;;OAEG;IACH,IAAI,EAAE,QAAQ,CAAC;IACf;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,0BAA2B,SAAQ,qBAAqB;IACrE;;OAEG;IACH,IAAI,EAAE,OAAO,CAAC;CACjB;AAED;;;;;;GAMG;AACH,MAAM,WAAW,sBAAsB;IACnC;;;OAGG;IACH,QAAQ,EAAE,cAAc,CAAC;CAC5B;AAED;;;GAGG;AACH,MAAM,WAAW,WAAW,CAAC,CAAC,GAAG,GAAG,CAAE,SAAQ,OAAO;IACjD,QAAQ,EAAE,MAAM,CAAC;IACjB,iBAAiB,CAAC,EAAE,CAAC,CAAC;CACzB;AAED;;GAEG;AACH,oBAAY,cAAc,GAAG,gBAAgB,CAAC,WAAW,CAAC,CAAC"}
|
package/lib/interfaces.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"interfaces.js","sourceRoot":"","sources":["../src/interfaces.ts"],"names":[],"mappings":"AAAA;;;GAGG","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { ITelemetryBaseLogger } from \"@fluidframework/common-definitions\";\nimport {\n IMember,\n IServiceAudience,\n} from \"@fluidframework/fluid-static\";\nimport { ITokenProvider } from \"@fluidframework/routerlicious-driver\";\n\n// Re-export so developers can build loggers without pulling in common-definitions\nexport {\n ITelemetryBaseEvent,\n ITelemetryBaseLogger,\n} from \"@fluidframework/common-definitions\";\n\n/**\n * Props for initializing a new AzureClient instance\n */\nexport interface AzureClientProps {\n /**\n * Configuration for establishing a connection with the Azure Fluid Relay.\n */\n readonly connection: AzureConnectionConfig;\n /**\n * Optional. A logger instance to receive diagnostic messages.\n */\n readonly logger?: ITelemetryBaseLogger;\n}\n\n/**\n * Parameters for establishing a connection with the Azure Fluid Relay.\n */\nexport interface AzureConnectionConfig {\n /**\n *
|
|
1
|
+
{"version":3,"file":"interfaces.js","sourceRoot":"","sources":["../src/interfaces.ts"],"names":[],"mappings":"AAAA;;;GAGG","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { ITelemetryBaseLogger } from \"@fluidframework/common-definitions\";\nimport {\n IMember,\n IServiceAudience,\n} from \"@fluidframework/fluid-static\";\nimport { ITokenProvider } from \"@fluidframework/routerlicious-driver\";\n\n// Re-export so developers can build loggers without pulling in common-definitions\nexport {\n ITelemetryBaseEvent,\n ITelemetryBaseLogger,\n} from \"@fluidframework/common-definitions\";\n\n/**\n * Props for initializing a new AzureClient instance\n */\nexport interface AzureClientProps {\n /**\n * Configuration for establishing a connection with the Azure Fluid Relay.\n */\n readonly connection: AzureConnectionConfig;\n /**\n * Optional. A logger instance to receive diagnostic messages.\n */\n readonly logger?: ITelemetryBaseLogger;\n}\n\n/**\n * Container version metadata.\n */\nexport interface AzureContainerVersion {\n /**\n * Version ID\n */\n id: string;\n\n /**\n * Time when version was generated.\n * ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ\n */\n date?: string;\n}\n\n/**\n * Options for \"Get Container Versions\" API.\n */\nexport interface AzureGetVersionsOptions {\n /**\n * Max number of versions\n */\n maxCount: number;\n}\n\n/**\n * The type of connection.\n * - \"local\" for local connections to a Fluid relay instance running on the localhost\n * - \"remote\" for client connections to the Azure Fluid Relay service\n */\nexport type AzureConnectionConfigType = \"local\" | \"remote\";\n\n/**\n * Parameters for establishing a connection with the Azure Fluid Relay.\n */\nexport interface AzureConnectionConfig {\n /**\n * The type of connection. Whether we're connecting to a remote Fluid relay server or a local instance.\n */\n type: AzureConnectionConfigType;\n /**\n * URI to the Azure Fluid Relay service discovery endpoint.\n */\n endpoint: string;\n /**\n * Instance that provides Azure Fluid Relay endpoint tokens.\n */\n tokenProvider: ITokenProvider;\n}\n\n/**\n * Parameters for establishing a remote connection with the Azure Fluid Relay.\n */\nexport interface AzureRemoteConnectionConfig extends AzureConnectionConfig {\n /**\n * The type of connection. Set to a remote connection.\n */\n type: \"remote\";\n /**\n * Unique tenant identifier.\n */\n tenantId: string;\n}\n\n/**\n * Parameters for establishing a local connection with a local instance of the Azure Fluid Relay.\n */\nexport interface AzureLocalConnectionConfig extends AzureConnectionConfig {\n /**\n * The type of connection. Set to a remote connection.\n */\n type: \"local\";\n}\n\n/**\n * AzureContainerServices is returned by the AzureClient alongside a FluidContainer.\n * It holds the functionality specifically tied to the Azure Fluid Relay, and how the data stored in\n * the FluidContainer is persisted in the backend and consumed by users. Any functionality regarding\n * how the data is handled within the FluidContainer itself, i.e. which data objects or DDSes to use,\n * will not be included here but rather on the FluidContainer class itself.\n */\nexport interface AzureContainerServices {\n /**\n * Provides an object that can be used to get the users that are present in this Fluid session and\n * listeners for when the roster has any changes from users joining/leaving the session\n */\n audience: IAzureAudience;\n}\n\n/**\n * Since Azure provides user names for all of its members, we extend the IMember interface to include\n * this service-specific value. It will be returned for all audience members connected to Azure.\n */\nexport interface AzureMember<T = any> extends IMember {\n userName: string;\n additionalDetails?: T;\n}\n\n/**\n * Audience object for Azure Fluid Relay containers\n */\nexport type IAzureAudience = IServiceAudience<AzureMember>;\n"]}
|
package/lib/packageVersion.d.ts
CHANGED
|
@@ -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/azure-client";
|
|
8
|
-
export declare const pkgVersion = "0.
|
|
8
|
+
export declare const pkgVersion = "1.0.0";
|
|
9
9
|
//# sourceMappingURL=packageVersion.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"packageVersion.d.ts","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,eAAO,MAAM,OAAO,iCAAiC,CAAC;AACtD,eAAO,MAAM,UAAU,
|
|
1
|
+
{"version":3,"file":"packageVersion.d.ts","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,eAAO,MAAM,OAAO,iCAAiC,CAAC;AACtD,eAAO,MAAM,UAAU,UAAU,CAAC"}
|
package/lib/packageVersion.js
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"packageVersion.js","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,MAAM,CAAC,MAAM,OAAO,GAAG,8BAA8B,CAAC;AACtD,MAAM,CAAC,MAAM,UAAU,GAAG,
|
|
1
|
+
{"version":3,"file":"packageVersion.js","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,MAAM,CAAC,MAAM,OAAO,GAAG,8BAA8B,CAAC;AACtD,MAAM,CAAC,MAAM,UAAU,GAAG,OAAO,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/azure-client\";\nexport const pkgVersion = \"1.0.0\";\n"]}
|
package/lib/utils.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
|
+
import { AzureRemoteConnectionConfig, AzureLocalConnectionConfig, AzureConnectionConfig } from "./interfaces";
|
|
6
|
+
/**
|
|
7
|
+
* Type guard for validating a given AzureConnectionConfig is a remote connection type (AzureRemoteConnectionConfig)
|
|
8
|
+
*/
|
|
9
|
+
export declare function isAzureRemoteConnectionConfig(connectionConfig: AzureConnectionConfig): connectionConfig is AzureRemoteConnectionConfig;
|
|
10
|
+
/**
|
|
11
|
+
* Type guard for validating a given AzureConnectionConfig is a local connection type (AzureLocalConnectionConfig)
|
|
12
|
+
*/
|
|
13
|
+
export declare function isAzureLocalConnectionConfig(connectionConfig: AzureConnectionConfig): connectionConfig is AzureLocalConnectionConfig;
|
|
14
|
+
//# sourceMappingURL=utils.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,EAAE,2BAA2B,EAAE,0BAA0B,EAAE,qBAAqB,EAAE,MAAM,cAAc,CAAC;AAE9G;;GAEG;AACH,wBAAgB,6BAA6B,CACzC,gBAAgB,EAAE,qBAAqB,GAAG,gBAAgB,IAAI,2BAA2B,CAE5F;AAED;;GAEG;AACH,wBAAgB,4BAA4B,CACxC,gBAAgB,EAAE,qBAAqB,GAAG,gBAAgB,IAAI,0BAA0B,CAE3F"}
|
package/lib/utils.js
ADDED
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Type guard for validating a given AzureConnectionConfig is a remote connection type (AzureRemoteConnectionConfig)
|
|
3
|
+
*/
|
|
4
|
+
export function isAzureRemoteConnectionConfig(connectionConfig) {
|
|
5
|
+
return connectionConfig.type === "remote";
|
|
6
|
+
}
|
|
7
|
+
/**
|
|
8
|
+
* Type guard for validating a given AzureConnectionConfig is a local connection type (AzureLocalConnectionConfig)
|
|
9
|
+
*/
|
|
10
|
+
export function isAzureLocalConnectionConfig(connectionConfig) {
|
|
11
|
+
return connectionConfig.type === "local";
|
|
12
|
+
}
|
|
13
|
+
//# sourceMappingURL=utils.js.map
|
package/lib/utils.js.map
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"utils.js","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAMA;;GAEG;AACH,MAAM,UAAU,6BAA6B,CACzC,gBAAuC;IACvC,OAAO,gBAAgB,CAAC,IAAI,KAAK,QAAQ,CAAC;AAC9C,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,4BAA4B,CACxC,gBAAuC;IACvC,OAAO,gBAAgB,CAAC,IAAI,KAAK,OAAO,CAAC;AAC7C,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\nimport { AzureRemoteConnectionConfig, AzureLocalConnectionConfig, AzureConnectionConfig } from \"./interfaces\";\n\n/**\n * Type guard for validating a given AzureConnectionConfig is a remote connection type (AzureRemoteConnectionConfig)\n */\nexport function isAzureRemoteConnectionConfig(\n connectionConfig: AzureConnectionConfig): connectionConfig is AzureRemoteConnectionConfig {\n return connectionConfig.type === \"remote\";\n}\n\n/**\n * Type guard for validating a given AzureConnectionConfig is a local connection type (AzureLocalConnectionConfig)\n */\nexport function isAzureLocalConnectionConfig(\n connectionConfig: AzureConnectionConfig): connectionConfig is AzureLocalConnectionConfig {\n return connectionConfig.type === \"local\";\n}\n"]}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@fluidframework/azure-client",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "1.0.0",
|
|
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": {
|
|
@@ -43,28 +43,28 @@
|
|
|
43
43
|
},
|
|
44
44
|
"dependencies": {
|
|
45
45
|
"@fluidframework/common-definitions": "^0.20.1",
|
|
46
|
-
"@fluidframework/container-definitions": "^0.
|
|
47
|
-
"@fluidframework/container-loader": "^0.
|
|
48
|
-
"@fluidframework/core-interfaces": "^0.
|
|
49
|
-
"@fluidframework/driver-definitions": "^0.
|
|
50
|
-
"@fluidframework/driver-utils": "^0.
|
|
51
|
-
"@fluidframework/fluid-static": "^0.
|
|
52
|
-
"@fluidframework/map": "^0.
|
|
53
|
-
"@fluidframework/protocol-definitions": "^0.1028.
|
|
54
|
-
"@fluidframework/routerlicious-driver": "^0.
|
|
55
|
-
"@fluidframework/runtime-utils": "^0.
|
|
56
|
-
"@fluidframework/server-services-client": "^0.1036.
|
|
46
|
+
"@fluidframework/container-definitions": "^1.0.1",
|
|
47
|
+
"@fluidframework/container-loader": "^1.0.1",
|
|
48
|
+
"@fluidframework/core-interfaces": "^1.0.1",
|
|
49
|
+
"@fluidframework/driver-definitions": "^1.0.1",
|
|
50
|
+
"@fluidframework/driver-utils": "^1.0.1",
|
|
51
|
+
"@fluidframework/fluid-static": "^1.0.1",
|
|
52
|
+
"@fluidframework/map": "^1.0.1",
|
|
53
|
+
"@fluidframework/protocol-definitions": "^0.1028.2000",
|
|
54
|
+
"@fluidframework/routerlicious-driver": "^1.0.1",
|
|
55
|
+
"@fluidframework/runtime-utils": "^1.0.1",
|
|
56
|
+
"@fluidframework/server-services-client": "^0.1036.4000",
|
|
57
57
|
"axios": "^0.26.0",
|
|
58
58
|
"uuid": "^8.3.1"
|
|
59
59
|
},
|
|
60
60
|
"devDependencies": {
|
|
61
|
-
"@fluidframework/aqueduct": "^0.
|
|
62
|
-
"@fluidframework/azure-client-previous": "npm:@fluidframework/azure-client@0.59.
|
|
61
|
+
"@fluidframework/aqueduct": "^1.0.1",
|
|
62
|
+
"@fluidframework/azure-client-previous": "npm:@fluidframework/azure-client@0.59.3000",
|
|
63
63
|
"@fluidframework/azure-local-service": "^0.1.38773",
|
|
64
64
|
"@fluidframework/build-common": "^0.23.0",
|
|
65
|
-
"@fluidframework/build-tools": "^0.2.
|
|
65
|
+
"@fluidframework/build-tools": "^0.2.71273",
|
|
66
66
|
"@fluidframework/eslint-config-fluid": "^0.28.2000",
|
|
67
|
-
"@fluidframework/test-client-utils": "^0.
|
|
67
|
+
"@fluidframework/test-client-utils": "^1.0.1",
|
|
68
68
|
"@microsoft/api-extractor": "^7.22.2",
|
|
69
69
|
"@rushstack/eslint-config": "^2.5.1",
|
|
70
70
|
"@types/mocha": "^9.1.1",
|
|
@@ -78,10 +78,26 @@
|
|
|
78
78
|
"typescript": "~4.5.5"
|
|
79
79
|
},
|
|
80
80
|
"peerDependencies": {
|
|
81
|
-
"fluid-framework": "
|
|
81
|
+
"fluid-framework": "^1.0.1"
|
|
82
82
|
},
|
|
83
83
|
"typeValidation": {
|
|
84
|
-
"version": "0.
|
|
85
|
-
"broken": {
|
|
84
|
+
"version": "1.0.0",
|
|
85
|
+
"broken": {
|
|
86
|
+
"ClassDeclaration_AzureClient": {
|
|
87
|
+
"forwardCompat": false
|
|
88
|
+
},
|
|
89
|
+
"InterfaceDeclaration_AzureClientProps": {
|
|
90
|
+
"backCompat": false,
|
|
91
|
+
"forwardCompat": false
|
|
92
|
+
},
|
|
93
|
+
"InterfaceDeclaration_AzureConnectionConfig": {
|
|
94
|
+
"backCompat": false,
|
|
95
|
+
"forwardCompat": false
|
|
96
|
+
},
|
|
97
|
+
"RemovedVariableDeclaration_LOCAL_MODE_TENANT_ID": {
|
|
98
|
+
"backCompat": false,
|
|
99
|
+
"forwardCompat": false
|
|
100
|
+
}
|
|
101
|
+
}
|
|
86
102
|
}
|
|
87
103
|
}
|