@fluidframework/tinylicious-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,9 @@
1
+ /*!
2
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
3
+ * Licensed under the MIT License.
4
+ */
5
+
6
+ /*
7
+ * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
8
+ * Generated by "flub generate entrypoints" in @fluidframework/build-tools.
9
+ */
package/dist/beta.d.ts ADDED
@@ -0,0 +1,9 @@
1
+ /*!
2
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
3
+ * Licensed under the MIT License.
4
+ */
5
+
6
+ /*
7
+ * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
8
+ * Generated by "flub generate entrypoints" in @fluidframework/build-tools.
9
+ */
@@ -0,0 +1,9 @@
1
+ /*!
2
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
3
+ * Licensed under the MIT License.
4
+ */
5
+
6
+ /*
7
+ * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
8
+ * Generated by "flub generate entrypoints" in @fluidframework/build-tools.
9
+ */
package/lib/alpha.d.ts ADDED
@@ -0,0 +1,9 @@
1
+ /*!
2
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
3
+ * Licensed under the MIT License.
4
+ */
5
+
6
+ /*
7
+ * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
8
+ * Generated by "flub generate entrypoints" in @fluidframework/build-tools.
9
+ */
package/lib/beta.d.ts ADDED
@@ -0,0 +1,9 @@
1
+ /*!
2
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
3
+ * Licensed under the MIT License.
4
+ */
5
+
6
+ /*
7
+ * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
8
+ * Generated by "flub generate entrypoints" in @fluidframework/build-tools.
9
+ */
@@ -0,0 +1,9 @@
1
+ /*!
2
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
3
+ * Licensed under the MIT License.
4
+ */
5
+
6
+ /*
7
+ * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
8
+ * Generated by "flub generate entrypoints" in @fluidframework/build-tools.
9
+ */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@fluidframework/tinylicious-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": "Driver for tinylicious",
5
5
  "homepage": "https://fluidframework.com",
6
6
  "repository": {
@@ -14,11 +14,11 @@
14
14
  "exports": {
15
15
  ".": {
16
16
  "import": {
17
- "types": "./lib/tinylicious-driver-public.d.ts",
17
+ "types": "./lib/public.d.ts",
18
18
  "default": "./lib/index.js"
19
19
  },
20
20
  "require": {
21
- "types": "./dist/tinylicious-driver-public.d.ts",
21
+ "types": "./dist/public.d.ts",
22
22
  "default": "./dist/index.js"
23
23
  }
24
24
  },
@@ -34,20 +34,20 @@
34
34
  }
35
35
  },
36
36
  "main": "dist/index.js",
37
- "types": "./dist/tinylicious-driver-public.d.ts",
37
+ "types": "./dist/public.d.ts",
38
38
  "dependencies": {
39
- "@fluidframework/core-interfaces": "2.0.0-dev-rc.3.0.0.254513",
40
- "@fluidframework/driver-definitions": "2.0.0-dev-rc.3.0.0.254513",
41
- "@fluidframework/driver-utils": "2.0.0-dev-rc.3.0.0.254513",
39
+ "@fluidframework/core-interfaces": "2.0.0-dev-rc.3.0.0.254866",
40
+ "@fluidframework/driver-definitions": "2.0.0-dev-rc.3.0.0.254866",
41
+ "@fluidframework/driver-utils": "2.0.0-dev-rc.3.0.0.254866",
42
42
  "@fluidframework/protocol-definitions": "^3.2.0",
43
- "@fluidframework/routerlicious-driver": "2.0.0-dev-rc.3.0.0.254513",
43
+ "@fluidframework/routerlicious-driver": "2.0.0-dev-rc.3.0.0.254866",
44
44
  "jsrsasign": "^11.0.0",
45
45
  "uuid": "^9.0.0"
46
46
  },
47
47
  "devDependencies": {
48
48
  "@arethetypeswrong/cli": "^0.15.2",
49
49
  "@biomejs/biome": "^1.6.2",
50
- "@fluid-internal/mocha-test-setup": "2.0.0-dev-rc.3.0.0.254513",
50
+ "@fluid-internal/mocha-test-setup": "2.0.0-dev-rc.3.0.0.254866",
51
51
  "@fluid-tools/build-cli": "^0.35.0",
52
52
  "@fluidframework/build-common": "^2.0.3",
53
53
  "@fluidframework/build-tools": "^0.35.0",
@@ -66,29 +66,17 @@
66
66
  "rimraf": "^4.4.0",
67
67
  "typescript": "~5.1.6"
68
68
  },
69
- "fluidBuild": {
70
- "tasks": {
71
- "build:docs": {
72
- "dependsOn": [
73
- "...",
74
- "api-extractor:commonjs",
75
- "api-extractor:esnext"
76
- ],
77
- "script": false
78
- }
79
- }
80
- },
81
69
  "typeValidation": {
82
70
  "broken": {}
83
71
  },
84
72
  "scripts": {
85
73
  "api": "fluid-build . --task api",
86
- "api-extractor:commonjs": "api-extractor run --config ./api-extractor-cjs.json",
87
- "api-extractor:esnext": "api-extractor run --local",
74
+ "api-extractor:commonjs": "flub generate entrypoints --outDir ./dist",
75
+ "api-extractor:esnext": "flub generate entrypoints --outDir ./lib",
88
76
  "build": "fluid-build . --task build",
89
77
  "build:commonjs": "fluid-build . --task commonjs",
90
78
  "build:compile": "fluid-build . --task compile",
91
- "build:docs": "fluid-build . --task api",
79
+ "build:docs": "api-extractor run --local",
92
80
  "build:esnext": "tsc --project ./tsconfig.json",
93
81
  "build:test": "npm run build:test:esm && npm run build:test:cjs",
94
82
  "build:test:cjs": "fluid-tsc commonjs --project ./src/test/tsconfig.cjs.json",
@@ -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,18 +0,0 @@
1
- import { IRequest } from '@fluidframework/core-interfaces';
2
- import { IResolvedUrl } from '@fluidframework/driver-definitions/internal';
3
- import { ITokenProvider } from '@fluidframework/routerlicious-driver';
4
- import { ITokenResponse } from '@fluidframework/routerlicious-driver';
5
- import { IUrlResolver } from '@fluidframework/driver-definitions/internal';
6
- import { ScopeType } from '@fluidframework/protocol-definitions';
7
-
8
- /* Excluded from this release type: createTinyliciousCreateNewRequest */
9
-
10
- /* Excluded from this release type: defaultTinyliciousEndpoint */
11
-
12
- /* Excluded from this release type: defaultTinyliciousPort */
13
-
14
- /* Excluded from this release type: InsecureTinyliciousTokenProvider */
15
-
16
- /* Excluded from this release type: InsecureTinyliciousUrlResolver */
17
-
18
- export { }
@@ -1,22 +0,0 @@
1
- import { IRequest } from '@fluidframework/core-interfaces';
2
- import { IResolvedUrl } from '@fluidframework/driver-definitions/internal';
3
- import { ITokenProvider } from '@fluidframework/routerlicious-driver';
4
- import { ITokenResponse } from '@fluidframework/routerlicious-driver';
5
- import { IUrlResolver } from '@fluidframework/driver-definitions/internal';
6
- import { ScopeType } from '@fluidframework/protocol-definitions';
7
-
8
- /* Excluded from this release type: createTinyliciousCreateNewRequest */
9
-
10
- /* Excluded from this release type: defaultTinyliciousEndpoint */
11
-
12
- /* Excluded from this release type: defaultTinyliciousPort */
13
-
14
- /* Excluded from this release type: InsecureTinyliciousTokenProvider */
15
-
16
- /* Excluded from this release type: InsecureTinyliciousUrlResolver */
17
-
18
- /* Excluded from this release type: IResolvedUrl */
19
-
20
- /* Excluded from this release type: IUrlResolver */
21
-
22
- export { }
@@ -1,22 +0,0 @@
1
- import { IRequest } from '@fluidframework/core-interfaces';
2
- import { IResolvedUrl } from '@fluidframework/driver-definitions/internal';
3
- import { ITokenProvider } from '@fluidframework/routerlicious-driver';
4
- import { ITokenResponse } from '@fluidframework/routerlicious-driver';
5
- import { IUrlResolver } from '@fluidframework/driver-definitions/internal';
6
- import { ScopeType } from '@fluidframework/protocol-definitions';
7
-
8
- /* Excluded from this release type: createTinyliciousCreateNewRequest */
9
-
10
- /* Excluded from this release type: defaultTinyliciousEndpoint */
11
-
12
- /* Excluded from this release type: defaultTinyliciousPort */
13
-
14
- /* Excluded from this release type: InsecureTinyliciousTokenProvider */
15
-
16
- /* Excluded from this release type: InsecureTinyliciousUrlResolver */
17
-
18
- /* Excluded from this release type: IResolvedUrl */
19
-
20
- /* Excluded from this release type: IUrlResolver */
21
-
22
- export { }
@@ -1,70 +0,0 @@
1
- import { IRequest } from '@fluidframework/core-interfaces';
2
- import { IResolvedUrl } from '@fluidframework/driver-definitions/internal';
3
- import { ITokenProvider } from '@fluidframework/routerlicious-driver';
4
- import { ITokenResponse } from '@fluidframework/routerlicious-driver';
5
- import { IUrlResolver } from '@fluidframework/driver-definitions/internal';
6
- import { ScopeType } from '@fluidframework/protocol-definitions';
7
-
8
- /**
9
- * Creates a Routerlicious {@link @fluidframework/core-interfaces#IRequest}.
10
- * @internal
11
- */
12
- export declare const createTinyliciousCreateNewRequest: (documentId?: string) => IRequest;
13
-
14
- /**
15
- * Default endpoint URL base. Will be used by the service if the consumer does not specify an endpoint.
16
- * @internal
17
- */
18
- export declare const defaultTinyliciousEndpoint = "http://localhost";
19
-
20
- /**
21
- * Default endpoint port. Will be used by the service if the consumer does not specify a port.
22
- * @internal
23
- */
24
- export declare const defaultTinyliciousPort = 7070;
25
-
26
- /**
27
- * As the name implies this is not secure and should not be used in production. It simply makes the example easier
28
- * to get up and running.
29
- * @internal
30
- */
31
- export declare class InsecureTinyliciousTokenProvider implements ITokenProvider {
32
- /**
33
- * Optional. Override of scopes. If a param is not provided, InsecureTinyliciousTokenProvider
34
- * will use the default scopes which are document read, write and summarizer write.
35
- *
36
- * @param scopes - See {@link @fluidframework/protocol-definitions#ITokenClaims.scopes}
37
- *
38
- * @defaultValue [ ScopeType.DocRead, ScopeType.DocWrite, ScopeType.SummaryWrite ]
39
- */
40
- private readonly scopes?;
41
- constructor(
42
- /**
43
- * Optional. Override of scopes. If a param is not provided, InsecureTinyliciousTokenProvider
44
- * will use the default scopes which are document read, write and summarizer write.
45
- *
46
- * @param scopes - See {@link @fluidframework/protocol-definitions#ITokenClaims.scopes}
47
- *
48
- * @defaultValue [ ScopeType.DocRead, ScopeType.DocWrite, ScopeType.SummaryWrite ]
49
- */
50
- scopes?: ScopeType[] | undefined);
51
- fetchOrdererToken(tenantId: string, documentId?: string): Promise<ITokenResponse>;
52
- fetchStorageToken(tenantId: string, documentId: string): Promise<ITokenResponse>;
53
- private getSignedToken;
54
- }
55
-
56
- /**
57
- * InsecureTinyliciousUrlResolver knows how to get the URLs to the service (in this case Tinylicious) to use
58
- * for a given request. This particular implementation has a goal to avoid imposing requirements on the app's
59
- * URL shape, so it expects the request url to have this format (as opposed to a more traditional URL):
60
- * documentId/containerRelativePathing
61
- * @internal
62
- */
63
- export declare class InsecureTinyliciousUrlResolver implements IUrlResolver {
64
- private readonly tinyliciousEndpoint;
65
- constructor(port?: number, endpoint?: string);
66
- resolve(request: IRequest): Promise<IResolvedUrl>;
67
- getAbsoluteUrl(resolvedUrl: IResolvedUrl, relativeUrl: string): Promise<string>;
68
- }
69
-
70
- export { }
@@ -1,11 +0,0 @@
1
- // This file is read by tools that parse documentation comments conforming to the TSDoc standard.
2
- // It should be published with your NPM package. It should not be tracked by Git.
3
- {
4
- "tsdocVersion": "0.12",
5
- "toolPackages": [
6
- {
7
- "packageName": "@microsoft/api-extractor",
8
- "packageVersion": "7.42.3"
9
- }
10
- ]
11
- }
@@ -1,18 +0,0 @@
1
- import { IRequest } from '@fluidframework/core-interfaces';
2
- import { IResolvedUrl } from '@fluidframework/driver-definitions/internal';
3
- import { ITokenProvider } from '@fluidframework/routerlicious-driver';
4
- import { ITokenResponse } from '@fluidframework/routerlicious-driver';
5
- import { IUrlResolver } from '@fluidframework/driver-definitions/internal';
6
- import { ScopeType } from '@fluidframework/protocol-definitions';
7
-
8
- /* Excluded from this release type: createTinyliciousCreateNewRequest */
9
-
10
- /* Excluded from this release type: defaultTinyliciousEndpoint */
11
-
12
- /* Excluded from this release type: defaultTinyliciousPort */
13
-
14
- /* Excluded from this release type: InsecureTinyliciousTokenProvider */
15
-
16
- /* Excluded from this release type: InsecureTinyliciousUrlResolver */
17
-
18
- export { }
@@ -1,22 +0,0 @@
1
- import { IRequest } from '@fluidframework/core-interfaces';
2
- import { IResolvedUrl } from '@fluidframework/driver-definitions/internal';
3
- import { ITokenProvider } from '@fluidframework/routerlicious-driver';
4
- import { ITokenResponse } from '@fluidframework/routerlicious-driver';
5
- import { IUrlResolver } from '@fluidframework/driver-definitions/internal';
6
- import { ScopeType } from '@fluidframework/protocol-definitions';
7
-
8
- /* Excluded from this release type: createTinyliciousCreateNewRequest */
9
-
10
- /* Excluded from this release type: defaultTinyliciousEndpoint */
11
-
12
- /* Excluded from this release type: defaultTinyliciousPort */
13
-
14
- /* Excluded from this release type: InsecureTinyliciousTokenProvider */
15
-
16
- /* Excluded from this release type: InsecureTinyliciousUrlResolver */
17
-
18
- /* Excluded from this release type: IResolvedUrl */
19
-
20
- /* Excluded from this release type: IUrlResolver */
21
-
22
- export { }
@@ -1,22 +0,0 @@
1
- import { IRequest } from '@fluidframework/core-interfaces';
2
- import { IResolvedUrl } from '@fluidframework/driver-definitions/internal';
3
- import { ITokenProvider } from '@fluidframework/routerlicious-driver';
4
- import { ITokenResponse } from '@fluidframework/routerlicious-driver';
5
- import { IUrlResolver } from '@fluidframework/driver-definitions/internal';
6
- import { ScopeType } from '@fluidframework/protocol-definitions';
7
-
8
- /* Excluded from this release type: createTinyliciousCreateNewRequest */
9
-
10
- /* Excluded from this release type: defaultTinyliciousEndpoint */
11
-
12
- /* Excluded from this release type: defaultTinyliciousPort */
13
-
14
- /* Excluded from this release type: InsecureTinyliciousTokenProvider */
15
-
16
- /* Excluded from this release type: InsecureTinyliciousUrlResolver */
17
-
18
- /* Excluded from this release type: IResolvedUrl */
19
-
20
- /* Excluded from this release type: IUrlResolver */
21
-
22
- export { }
@@ -1,70 +0,0 @@
1
- import { IRequest } from '@fluidframework/core-interfaces';
2
- import { IResolvedUrl } from '@fluidframework/driver-definitions/internal';
3
- import { ITokenProvider } from '@fluidframework/routerlicious-driver';
4
- import { ITokenResponse } from '@fluidframework/routerlicious-driver';
5
- import { IUrlResolver } from '@fluidframework/driver-definitions/internal';
6
- import { ScopeType } from '@fluidframework/protocol-definitions';
7
-
8
- /**
9
- * Creates a Routerlicious {@link @fluidframework/core-interfaces#IRequest}.
10
- * @internal
11
- */
12
- export declare const createTinyliciousCreateNewRequest: (documentId?: string) => IRequest;
13
-
14
- /**
15
- * Default endpoint URL base. Will be used by the service if the consumer does not specify an endpoint.
16
- * @internal
17
- */
18
- export declare const defaultTinyliciousEndpoint = "http://localhost";
19
-
20
- /**
21
- * Default endpoint port. Will be used by the service if the consumer does not specify a port.
22
- * @internal
23
- */
24
- export declare const defaultTinyliciousPort = 7070;
25
-
26
- /**
27
- * As the name implies this is not secure and should not be used in production. It simply makes the example easier
28
- * to get up and running.
29
- * @internal
30
- */
31
- export declare class InsecureTinyliciousTokenProvider implements ITokenProvider {
32
- /**
33
- * Optional. Override of scopes. If a param is not provided, InsecureTinyliciousTokenProvider
34
- * will use the default scopes which are document read, write and summarizer write.
35
- *
36
- * @param scopes - See {@link @fluidframework/protocol-definitions#ITokenClaims.scopes}
37
- *
38
- * @defaultValue [ ScopeType.DocRead, ScopeType.DocWrite, ScopeType.SummaryWrite ]
39
- */
40
- private readonly scopes?;
41
- constructor(
42
- /**
43
- * Optional. Override of scopes. If a param is not provided, InsecureTinyliciousTokenProvider
44
- * will use the default scopes which are document read, write and summarizer write.
45
- *
46
- * @param scopes - See {@link @fluidframework/protocol-definitions#ITokenClaims.scopes}
47
- *
48
- * @defaultValue [ ScopeType.DocRead, ScopeType.DocWrite, ScopeType.SummaryWrite ]
49
- */
50
- scopes?: ScopeType[] | undefined);
51
- fetchOrdererToken(tenantId: string, documentId?: string): Promise<ITokenResponse>;
52
- fetchStorageToken(tenantId: string, documentId: string): Promise<ITokenResponse>;
53
- private getSignedToken;
54
- }
55
-
56
- /**
57
- * InsecureTinyliciousUrlResolver knows how to get the URLs to the service (in this case Tinylicious) to use
58
- * for a given request. This particular implementation has a goal to avoid imposing requirements on the app's
59
- * URL shape, so it expects the request url to have this format (as opposed to a more traditional URL):
60
- * documentId/containerRelativePathing
61
- * @internal
62
- */
63
- export declare class InsecureTinyliciousUrlResolver implements IUrlResolver {
64
- private readonly tinyliciousEndpoint;
65
- constructor(port?: number, endpoint?: string);
66
- resolve(request: IRequest): Promise<IResolvedUrl>;
67
- getAbsoluteUrl(resolvedUrl: IResolvedUrl, relativeUrl: string): Promise<string>;
68
- }
69
-
70
- export { }