@fluidframework/aqueduct 2.0.2 → 2.1.0-276326

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.
Files changed (68) hide show
  1. package/api-extractor/api-extractor.legacy.json +4 -0
  2. package/api-report/aqueduct.beta.api.md +0 -33
  3. package/api-report/{aqueduct.alpha.api.md → aqueduct.legacy.alpha.api.md} +2 -33
  4. package/api-report/aqueduct.public.api.md +0 -33
  5. package/dist/container-runtime-factories/baseContainerRuntimeFactory.d.ts +2 -0
  6. package/dist/container-runtime-factories/baseContainerRuntimeFactory.d.ts.map +1 -1
  7. package/dist/container-runtime-factories/baseContainerRuntimeFactory.js +1 -0
  8. package/dist/container-runtime-factories/baseContainerRuntimeFactory.js.map +1 -1
  9. package/dist/container-runtime-factories/containerRuntimeFactoryWithDefaultDataStore.d.ts +2 -0
  10. package/dist/container-runtime-factories/containerRuntimeFactoryWithDefaultDataStore.d.ts.map +1 -1
  11. package/dist/container-runtime-factories/containerRuntimeFactoryWithDefaultDataStore.js +1 -0
  12. package/dist/container-runtime-factories/containerRuntimeFactoryWithDefaultDataStore.js.map +1 -1
  13. package/dist/data-object-factories/dataObjectFactory.d.ts +1 -0
  14. package/dist/data-object-factories/dataObjectFactory.d.ts.map +1 -1
  15. package/dist/data-object-factories/dataObjectFactory.js +1 -0
  16. package/dist/data-object-factories/dataObjectFactory.js.map +1 -1
  17. package/dist/data-object-factories/pureDataObjectFactory.d.ts +1 -0
  18. package/dist/data-object-factories/pureDataObjectFactory.d.ts.map +1 -1
  19. package/dist/data-object-factories/pureDataObjectFactory.js +1 -0
  20. package/dist/data-object-factories/pureDataObjectFactory.js.map +1 -1
  21. package/dist/data-objects/dataObject.d.ts +1 -0
  22. package/dist/data-objects/dataObject.d.ts.map +1 -1
  23. package/dist/data-objects/dataObject.js +1 -0
  24. package/dist/data-objects/dataObject.js.map +1 -1
  25. package/dist/data-objects/pureDataObject.d.ts +1 -0
  26. package/dist/data-objects/pureDataObject.d.ts.map +1 -1
  27. package/dist/data-objects/pureDataObject.js +1 -6
  28. package/dist/data-objects/pureDataObject.js.map +1 -1
  29. package/dist/data-objects/types.d.ts +2 -0
  30. package/dist/data-objects/types.d.ts.map +1 -1
  31. package/dist/data-objects/types.js.map +1 -1
  32. package/dist/legacy.d.ts +1 -1
  33. package/lib/container-runtime-factories/baseContainerRuntimeFactory.d.ts +2 -0
  34. package/lib/container-runtime-factories/baseContainerRuntimeFactory.d.ts.map +1 -1
  35. package/lib/container-runtime-factories/baseContainerRuntimeFactory.js +1 -0
  36. package/lib/container-runtime-factories/baseContainerRuntimeFactory.js.map +1 -1
  37. package/lib/container-runtime-factories/containerRuntimeFactoryWithDefaultDataStore.d.ts +2 -0
  38. package/lib/container-runtime-factories/containerRuntimeFactoryWithDefaultDataStore.d.ts.map +1 -1
  39. package/lib/container-runtime-factories/containerRuntimeFactoryWithDefaultDataStore.js +1 -0
  40. package/lib/container-runtime-factories/containerRuntimeFactoryWithDefaultDataStore.js.map +1 -1
  41. package/lib/data-object-factories/dataObjectFactory.d.ts +1 -0
  42. package/lib/data-object-factories/dataObjectFactory.d.ts.map +1 -1
  43. package/lib/data-object-factories/dataObjectFactory.js +1 -0
  44. package/lib/data-object-factories/dataObjectFactory.js.map +1 -1
  45. package/lib/data-object-factories/pureDataObjectFactory.d.ts +1 -0
  46. package/lib/data-object-factories/pureDataObjectFactory.d.ts.map +1 -1
  47. package/lib/data-object-factories/pureDataObjectFactory.js +1 -0
  48. package/lib/data-object-factories/pureDataObjectFactory.js.map +1 -1
  49. package/lib/data-objects/dataObject.d.ts +1 -0
  50. package/lib/data-objects/dataObject.d.ts.map +1 -1
  51. package/lib/data-objects/dataObject.js +1 -0
  52. package/lib/data-objects/dataObject.js.map +1 -1
  53. package/lib/data-objects/pureDataObject.d.ts +1 -0
  54. package/lib/data-objects/pureDataObject.d.ts.map +1 -1
  55. package/lib/data-objects/pureDataObject.js +1 -6
  56. package/lib/data-objects/pureDataObject.js.map +1 -1
  57. package/lib/data-objects/types.d.ts +2 -0
  58. package/lib/data-objects/types.d.ts.map +1 -1
  59. package/lib/data-objects/types.js.map +1 -1
  60. package/lib/legacy.d.ts +1 -1
  61. package/package.json +27 -28
  62. package/src/container-runtime-factories/baseContainerRuntimeFactory.ts +2 -0
  63. package/src/container-runtime-factories/containerRuntimeFactoryWithDefaultDataStore.ts +2 -0
  64. package/src/data-object-factories/dataObjectFactory.ts +1 -0
  65. package/src/data-object-factories/pureDataObjectFactory.ts +1 -0
  66. package/src/data-objects/dataObject.ts +1 -0
  67. package/src/data-objects/pureDataObject.ts +1 -10
  68. package/src/data-objects/types.ts +2 -0
@@ -1 +1 @@
1
- {"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/data-objects/types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,EAAE,MAAM,iCAAiC,CAAC;AAC3E,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,gDAAgD,CAAC;AAC7F,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,8CAA8C,CAAC;AAC3F,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,qCAAqC,CAAC;AAEpF;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC/B;;OAEG;IACH,iBAAiB,CAAC,EAAE,WAAW,CAAC;IAChC;;OAEG;IAGH,YAAY,CAAC,EAAE,GAAG,CAAC;IACnB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB,CAAC,CAAC,SAAS,eAAe,GAAG,eAAe;IAC5E,QAAQ,CAAC,OAAO,EAAE,sBAAsB,CAAC;IACzC,QAAQ,CAAC,OAAO,EAAE,sBAAsB,CAAC;IACzC,QAAQ,CAAC,SAAS,EAAE,wBAAwB,CAAC,CAAC,CAAC,mBAAmB,CAAC,CAAC,CAAC;IACrE,QAAQ,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC,cAAc,CAAC,CAAC;CACvC"}
1
+ {"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/data-objects/types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,EAAE,MAAM,iCAAiC,CAAC;AAC3E,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,gDAAgD,CAAC;AAC7F,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,8CAA8C,CAAC;AAC3F,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,qCAAqC,CAAC;AAEpF;;;;GAIG;AACH,MAAM,WAAW,eAAe;IAC/B;;OAEG;IACH,iBAAiB,CAAC,EAAE,WAAW,CAAC;IAChC;;OAEG;IAGH,YAAY,CAAC,EAAE,GAAG,CAAC;IACnB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;;GAGG;AACH,MAAM,WAAW,gBAAgB,CAAC,CAAC,SAAS,eAAe,GAAG,eAAe;IAC5E,QAAQ,CAAC,OAAO,EAAE,sBAAsB,CAAC;IACzC,QAAQ,CAAC,OAAO,EAAE,sBAAsB,CAAC;IACzC,QAAQ,CAAC,SAAS,EAAE,wBAAwB,CAAC,CAAC,CAAC,mBAAmB,CAAC,CAAC,CAAC;IACrE,QAAQ,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC,cAAc,CAAC,CAAC;CACvC"}
@@ -1 +1 @@
1
- {"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/data-objects/types.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 type { FluidObject, IEvent } from \"@fluidframework/core-interfaces\";\nimport type { IFluidDataStoreRuntime } from \"@fluidframework/datastore-definitions/internal\";\nimport type { IFluidDataStoreContext } from \"@fluidframework/runtime-definitions/internal\";\nimport type { AsyncFluidObjectProvider } from \"@fluidframework/synthesize/internal\";\n\n/**\n * This type is used as the base generic input to DataObject and PureDataObject.\n * @alpha\n */\nexport interface DataObjectTypes {\n\t/**\n\t * Represents a type that will define optional providers that will be injected.\n\t */\n\tOptionalProviders?: FluidObject;\n\t/**\n\t * The initial state type that the produced data object may take during creation.\n\t */\n\t// TODO: Use a real type here.\n\t// eslint-disable-next-line @typescript-eslint/no-explicit-any\n\tInitialState?: any;\n\t/**\n\t * Represents events that will be available in the EventForwarder.\n\t */\n\tEvents?: IEvent;\n}\n\n/**\n * @alpha\n */\nexport interface IDataObjectProps<I extends DataObjectTypes = DataObjectTypes> {\n\treadonly runtime: IFluidDataStoreRuntime;\n\treadonly context: IFluidDataStoreContext;\n\treadonly providers: AsyncFluidObjectProvider<I[\"OptionalProviders\"]>;\n\treadonly initProps?: I[\"InitialState\"];\n}\n"]}
1
+ {"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/data-objects/types.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 type { FluidObject, IEvent } from \"@fluidframework/core-interfaces\";\nimport type { IFluidDataStoreRuntime } from \"@fluidframework/datastore-definitions/internal\";\nimport type { IFluidDataStoreContext } from \"@fluidframework/runtime-definitions/internal\";\nimport type { AsyncFluidObjectProvider } from \"@fluidframework/synthesize/internal\";\n\n/**\n * This type is used as the base generic input to DataObject and PureDataObject.\n * @legacy\n * @alpha\n */\nexport interface DataObjectTypes {\n\t/**\n\t * Represents a type that will define optional providers that will be injected.\n\t */\n\tOptionalProviders?: FluidObject;\n\t/**\n\t * The initial state type that the produced data object may take during creation.\n\t */\n\t// TODO: Use a real type here.\n\t// eslint-disable-next-line @typescript-eslint/no-explicit-any\n\tInitialState?: any;\n\t/**\n\t * Represents events that will be available in the EventForwarder.\n\t */\n\tEvents?: IEvent;\n}\n\n/**\n * @legacy\n * @alpha\n */\nexport interface IDataObjectProps<I extends DataObjectTypes = DataObjectTypes> {\n\treadonly runtime: IFluidDataStoreRuntime;\n\treadonly context: IFluidDataStoreContext;\n\treadonly providers: AsyncFluidObjectProvider<I[\"OptionalProviders\"]>;\n\treadonly initProps?: I[\"InitialState\"];\n}\n"]}
package/lib/legacy.d.ts CHANGED
@@ -9,7 +9,7 @@
9
9
  */
10
10
 
11
11
  export {
12
- // @alpha APIs
12
+ // @legacy APIs
13
13
  BaseContainerRuntimeFactory,
14
14
  BaseContainerRuntimeFactoryProps,
15
15
  ContainerRuntimeFactoryWithDefaultDataStore,
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@fluidframework/aqueduct",
3
- "version": "2.0.2",
3
+ "version": "2.1.0-276326",
4
4
  "description": "A set of implementations for Fluid Framework interfaces.",
5
5
  "homepage": "https://fluidframework.com",
6
6
  "repository": {
@@ -67,27 +67,27 @@
67
67
  "temp-directory": "nyc/.nyc_output"
68
68
  },
69
69
  "dependencies": {
70
- "@fluid-internal/client-utils": "~2.0.2",
71
- "@fluidframework/container-definitions": "~2.0.2",
72
- "@fluidframework/container-runtime": "~2.0.2",
73
- "@fluidframework/container-runtime-definitions": "~2.0.2",
74
- "@fluidframework/core-interfaces": "~2.0.2",
75
- "@fluidframework/core-utils": "~2.0.2",
76
- "@fluidframework/datastore": "~2.0.2",
77
- "@fluidframework/datastore-definitions": "~2.0.2",
78
- "@fluidframework/map": "~2.0.2",
79
- "@fluidframework/request-handler": "~2.0.2",
80
- "@fluidframework/runtime-definitions": "~2.0.2",
81
- "@fluidframework/runtime-utils": "~2.0.2",
82
- "@fluidframework/shared-object-base": "~2.0.2",
83
- "@fluidframework/synthesize": "~2.0.2"
70
+ "@fluid-internal/client-utils": "2.1.0-276326",
71
+ "@fluidframework/container-definitions": "2.1.0-276326",
72
+ "@fluidframework/container-runtime": "2.1.0-276326",
73
+ "@fluidframework/container-runtime-definitions": "2.1.0-276326",
74
+ "@fluidframework/core-interfaces": "2.1.0-276326",
75
+ "@fluidframework/core-utils": "2.1.0-276326",
76
+ "@fluidframework/datastore": "2.1.0-276326",
77
+ "@fluidframework/datastore-definitions": "2.1.0-276326",
78
+ "@fluidframework/map": "2.1.0-276326",
79
+ "@fluidframework/request-handler": "2.1.0-276326",
80
+ "@fluidframework/runtime-definitions": "2.1.0-276326",
81
+ "@fluidframework/runtime-utils": "2.1.0-276326",
82
+ "@fluidframework/shared-object-base": "2.1.0-276326",
83
+ "@fluidframework/synthesize": "2.1.0-276326"
84
84
  },
85
85
  "devDependencies": {
86
86
  "@arethetypeswrong/cli": "^0.15.2",
87
87
  "@biomejs/biome": "^1.7.3",
88
- "@fluid-internal/mocha-test-setup": "~2.0.2",
88
+ "@fluid-internal/mocha-test-setup": "2.1.0-276326",
89
89
  "@fluid-tools/build-cli": "^0.39.0",
90
- "@fluidframework/aqueduct-previous": "npm:@fluidframework/aqueduct@2.0.0-rc.4.0.0",
90
+ "@fluidframework/aqueduct-previous": "npm:@fluidframework/aqueduct@2.0.0-rc.5.0.0",
91
91
  "@fluidframework/build-common": "^2.0.3",
92
92
  "@fluidframework/build-tools": "^0.39.0",
93
93
  "@fluidframework/eslint-config-fluid": "^5.3.0",
@@ -108,21 +108,18 @@
108
108
  "typescript": "~5.4.5"
109
109
  },
110
110
  "typeValidation": {
111
- "broken": {
112
- "InterfaceDeclaration_IDataObjectProps": {
113
- "forwardCompat": false,
114
- "backCompat": false
115
- }
116
- }
111
+ "broken": {}
117
112
  },
118
113
  "scripts": {
119
114
  "api": "fluid-build . --task api",
120
- "api-extractor:commonjs": "flub generate entrypoints --outFileAlpha legacy --outDir ./dist",
121
- "api-extractor:esnext": "flub generate entrypoints --outFileAlpha legacy --outDir ./lib --node10TypeCompat",
115
+ "api-extractor:commonjs": "flub generate entrypoints --outDir ./dist",
116
+ "api-extractor:esnext": "flub generate entrypoints --outDir ./lib --node10TypeCompat",
122
117
  "build": "fluid-build . --task build",
123
118
  "build:commonjs": "fluid-build . --task commonjs",
124
119
  "build:compile": "fluid-build . --task compile",
125
- "build:docs": "api-extractor run --local",
120
+ "build:docs": "concurrently \"npm:build:docs:*\"",
121
+ "build:docs:current": "api-extractor run --local",
122
+ "build:docs:legacy": "api-extractor run --local --config api-extractor/api-extractor.legacy.json",
126
123
  "build:esnext": "tsc --project ./tsconfig.json",
127
124
  "build:test": "npm run build:test:esm && npm run build:test:cjs",
128
125
  "build:test:cjs": "fluid-tsc commonjs --project ./src/test/tsconfig.cjs.json",
@@ -137,7 +134,9 @@
137
134
  "check:exports:esm:public": "api-extractor run --config api-extractor/api-extractor-lint-public.esm.json",
138
135
  "check:format": "npm run check:biome",
139
136
  "check:prettier": "prettier --check . --cache --ignore-path ../../../.prettierignore",
140
- "ci:build:docs": "api-extractor run",
137
+ "ci:build:docs": "concurrently \"npm:ci:build:docs:*\"",
138
+ "ci:build:docs:current": "api-extractor run",
139
+ "ci:build:docs:legacy": "api-extractor run --config api-extractor/api-extractor.legacy.json",
141
140
  "clean": "rimraf --glob dist lib \"*.d.ts\" \"**/*.tsbuildinfo\" \"**/*.build.log\" _api-extractor-temp nyc",
142
141
  "eslint": "eslint --format stylish src",
143
142
  "eslint:fix": "eslint --format stylish src --fix --fix-type problem,suggestion,layout",
@@ -153,7 +152,7 @@
153
152
  "test:mocha:esm": "mocha --recursive \"lib/test/**/*.spec.*js\" --exit -r node_modules/@fluid-internal/mocha-test-setup",
154
153
  "test:mocha:verbose": "cross-env FLUID_TEST_VERBOSE=1 npm run test:mocha",
155
154
  "tsc": "fluid-tsc commonjs --project ./tsconfig.cjs.json && copyfiles -f ../../../common/build/build-common/src/cjs/package.json ./dist",
156
- "typetests:gen": "flub generate typetests --dir . -v --publicFallback",
155
+ "typetests:gen": "flub generate typetests --dir . -v",
157
156
  "typetests:prepare": "flub typetests --dir . --reset --previous --normalize"
158
157
  }
159
158
  }
@@ -31,6 +31,7 @@ import {
31
31
 
32
32
  /**
33
33
  * {@link BaseContainerRuntimeFactory} construction properties.
34
+ * @legacy
34
35
  * @alpha
35
36
  */
36
37
  export interface BaseContainerRuntimeFactoryProps {
@@ -63,6 +64,7 @@ export interface BaseContainerRuntimeFactoryProps {
63
64
  * BaseContainerRuntimeFactory produces container runtimes with the specified data store and service registries,
64
65
  * request handlers, runtimeOptions, and entryPoint initialization function.
65
66
  * It can be subclassed to implement a first-time initialization procedure for the containers it creates.
67
+ * @legacy
66
68
  * @alpha
67
69
  */
68
70
  export class BaseContainerRuntimeFactory
@@ -32,6 +32,7 @@ async function getDefaultFluidObject(runtime: IContainerRuntime): Promise<FluidO
32
32
 
33
33
  /**
34
34
  * {@link ContainerRuntimeFactoryWithDefaultDataStore} construction properties.
35
+ * @legacy
35
36
  * @alpha
36
37
  */
37
38
  export interface ContainerRuntimeFactoryWithDefaultDataStoreProps {
@@ -66,6 +67,7 @@ export interface ContainerRuntimeFactoryWithDefaultDataStoreProps {
66
67
  * the container with an empty URL.
67
68
  *
68
69
  * This factory should be exposed as fluidExport off the entry point to your module.
70
+ * @legacy
69
71
  * @alpha
70
72
  */
71
73
  export class ContainerRuntimeFactoryWithDefaultDataStore extends BaseContainerRuntimeFactory {
@@ -26,6 +26,7 @@ import { PureDataObjectFactory } from "./pureDataObjectFactory.js";
26
26
  *
27
27
  * @typeParam TObj - DataObject (concrete type)
28
28
  * @typeParam I - The input types for the DataObject
29
+ * @legacy
29
30
  * @alpha
30
31
  */
31
32
  export class DataObjectFactory<
@@ -133,6 +133,7 @@ async function createDataObject<
133
133
  *
134
134
  * @typeParam TObj - DataObject (concrete type)
135
135
  * @typeParam I - The input types for the DataObject
136
+ * @legacy
136
137
  * @alpha
137
138
  */
138
139
  export class PureDataObjectFactory<
@@ -23,6 +23,7 @@ import type { DataObjectTypes } from "./types.js";
23
23
  * will automatically be registered.
24
24
  *
25
25
  * @typeParam I - The optional input types used to strongly type the data object
26
+ * @legacy
26
27
  * @alpha
27
28
  */
28
29
  export abstract class DataObject<
@@ -29,6 +29,7 @@ import type { DataObjectTypes, IDataObjectProps } from "./types.js";
29
29
  * you are creating another base data store class
30
30
  *
31
31
  * @typeParam I - The optional input types used to strongly type the data object
32
+ * @legacy
32
33
  * @alpha
33
34
  */
34
35
  export abstract class PureDataObject<I extends DataObjectTypes = DataObjectTypes>
@@ -99,16 +100,6 @@ export abstract class PureDataObject<I extends DataObjectTypes = DataObjectTypes
99
100
  this.context = props.context;
100
101
  this.providers = props.providers;
101
102
  this.initProps = props.initProps;
102
-
103
- /* eslint-disable @typescript-eslint/no-unsafe-member-access */
104
- /* eslint-disable @typescript-eslint/no-explicit-any */
105
- assert(
106
- (this.runtime as any)._dataObject === undefined,
107
- 0x0bd /* "Object runtime already has DataObject!" */,
108
- );
109
- (this.runtime as any)._dataObject = this;
110
- /* eslint-enable @typescript-eslint/no-explicit-any */
111
- /* eslint-enable @typescript-eslint/no-unsafe-member-access */
112
103
  }
113
104
 
114
105
  /**
@@ -10,6 +10,7 @@ import type { AsyncFluidObjectProvider } from "@fluidframework/synthesize/intern
10
10
 
11
11
  /**
12
12
  * This type is used as the base generic input to DataObject and PureDataObject.
13
+ * @legacy
13
14
  * @alpha
14
15
  */
15
16
  export interface DataObjectTypes {
@@ -30,6 +31,7 @@ export interface DataObjectTypes {
30
31
  }
31
32
 
32
33
  /**
34
+ * @legacy
33
35
  * @alpha
34
36
  */
35
37
  export interface IDataObjectProps<I extends DataObjectTypes = DataObjectTypes> {