@fluidframework/aqueduct 1.4.0-115997 → 2.0.0-dev-rc.1.0.0.224419

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 (178) hide show
  1. package/README.md +67 -29
  2. package/dist/aqueduct-alpha.d.ts +365 -0
  3. package/dist/aqueduct-beta.d.ts +100 -0
  4. package/dist/aqueduct-public.d.ts +100 -0
  5. package/dist/aqueduct-untrimmed.d.ts +365 -0
  6. package/dist/container-runtime-factories/{baseContainerRuntimeFactory.js → baseContainerRuntimeFactory.cjs} +33 -19
  7. package/dist/container-runtime-factories/baseContainerRuntimeFactory.cjs.map +1 -0
  8. package/dist/container-runtime-factories/baseContainerRuntimeFactory.d.ts +20 -8
  9. package/dist/container-runtime-factories/baseContainerRuntimeFactory.d.ts.map +1 -1
  10. package/dist/container-runtime-factories/containerRuntimeFactoryWithDefaultDataStore.cjs +66 -0
  11. package/dist/container-runtime-factories/containerRuntimeFactoryWithDefaultDataStore.cjs.map +1 -0
  12. package/dist/container-runtime-factories/containerRuntimeFactoryWithDefaultDataStore.d.ts +21 -2
  13. package/dist/container-runtime-factories/containerRuntimeFactoryWithDefaultDataStore.d.ts.map +1 -1
  14. package/dist/container-runtime-factories/index.cjs +12 -0
  15. package/dist/container-runtime-factories/index.cjs.map +1 -0
  16. package/dist/container-runtime-factories/index.d.ts +2 -2
  17. package/dist/container-runtime-factories/index.d.ts.map +1 -1
  18. package/dist/data-object-factories/{dataObjectFactory.js → dataObjectFactory.cjs} +3 -2
  19. package/dist/data-object-factories/dataObjectFactory.cjs.map +1 -0
  20. package/dist/data-object-factories/dataObjectFactory.d.ts +1 -0
  21. package/dist/data-object-factories/dataObjectFactory.d.ts.map +1 -1
  22. package/dist/data-object-factories/index.cjs +12 -0
  23. package/dist/data-object-factories/index.cjs.map +1 -0
  24. package/dist/data-object-factories/index.d.ts +2 -2
  25. package/dist/data-object-factories/index.d.ts.map +1 -1
  26. package/dist/data-object-factories/{pureDataObjectFactory.js → pureDataObjectFactory.cjs} +27 -10
  27. package/dist/data-object-factories/pureDataObjectFactory.cjs.map +1 -0
  28. package/dist/data-object-factories/pureDataObjectFactory.d.ts +2 -5
  29. package/dist/data-object-factories/pureDataObjectFactory.d.ts.map +1 -1
  30. package/dist/data-objects/{dataObject.js → dataObject.cjs} +4 -21
  31. package/dist/data-objects/dataObject.cjs.map +1 -0
  32. package/dist/data-objects/dataObject.d.ts +1 -5
  33. package/dist/data-objects/dataObject.d.ts.map +1 -1
  34. package/dist/data-objects/{index.js → index.cjs} +3 -3
  35. package/dist/data-objects/index.cjs.map +1 -0
  36. package/dist/data-objects/pureDataObject.cjs +120 -0
  37. package/dist/data-objects/pureDataObject.cjs.map +1 -0
  38. package/dist/data-objects/pureDataObject.d.ts +8 -29
  39. package/dist/data-objects/pureDataObject.d.ts.map +1 -1
  40. package/dist/data-objects/{types.js → types.cjs} +1 -1
  41. package/dist/data-objects/types.cjs.map +1 -0
  42. package/dist/data-objects/types.d.ts +5 -2
  43. package/dist/data-objects/types.d.ts.map +1 -1
  44. package/dist/index.cjs +31 -0
  45. package/dist/index.cjs.map +1 -0
  46. package/dist/index.d.ts +5 -8
  47. package/dist/index.d.ts.map +1 -1
  48. package/dist/tsdoc-metadata.json +11 -0
  49. package/lib/aqueduct-alpha.d.mts +365 -0
  50. package/lib/aqueduct-beta.d.mts +100 -0
  51. package/lib/aqueduct-public.d.mts +100 -0
  52. package/lib/aqueduct-untrimmed.d.mts +365 -0
  53. package/lib/container-runtime-factories/baseContainerRuntimeFactory.d.mts +59 -0
  54. package/lib/container-runtime-factories/baseContainerRuntimeFactory.d.mts.map +1 -0
  55. package/lib/container-runtime-factories/{baseContainerRuntimeFactory.js → baseContainerRuntimeFactory.mjs} +33 -20
  56. package/lib/container-runtime-factories/baseContainerRuntimeFactory.mjs.map +1 -0
  57. package/lib/container-runtime-factories/containerRuntimeFactoryWithDefaultDataStore.d.mts +45 -0
  58. package/lib/container-runtime-factories/containerRuntimeFactoryWithDefaultDataStore.d.mts.map +1 -0
  59. package/lib/container-runtime-factories/containerRuntimeFactoryWithDefaultDataStore.mjs +62 -0
  60. package/lib/container-runtime-factories/containerRuntimeFactoryWithDefaultDataStore.mjs.map +1 -0
  61. package/lib/container-runtime-factories/index.d.mts +7 -0
  62. package/lib/container-runtime-factories/index.d.mts.map +1 -0
  63. package/lib/container-runtime-factories/index.mjs +7 -0
  64. package/lib/container-runtime-factories/index.mjs.map +1 -0
  65. package/lib/data-object-factories/dataObjectFactory.d.mts +23 -0
  66. package/lib/data-object-factories/dataObjectFactory.d.mts.map +1 -0
  67. package/lib/data-object-factories/{dataObjectFactory.js → dataObjectFactory.mjs} +4 -3
  68. package/lib/data-object-factories/dataObjectFactory.mjs.map +1 -0
  69. package/lib/data-object-factories/index.d.mts +7 -0
  70. package/lib/data-object-factories/index.d.mts.map +1 -0
  71. package/lib/data-object-factories/index.mjs +7 -0
  72. package/lib/data-object-factories/index.mjs.map +1 -0
  73. package/lib/data-object-factories/pureDataObjectFactory.d.mts +91 -0
  74. package/lib/data-object-factories/pureDataObjectFactory.d.mts.map +1 -0
  75. package/lib/data-object-factories/{pureDataObjectFactory.js → pureDataObjectFactory.mjs} +27 -10
  76. package/lib/data-object-factories/pureDataObjectFactory.mjs.map +1 -0
  77. package/lib/data-objects/dataObject.d.mts +38 -0
  78. package/lib/data-objects/dataObject.d.mts.map +1 -0
  79. package/lib/data-objects/{dataObject.js → dataObject.mjs} +4 -21
  80. package/lib/data-objects/dataObject.mjs.map +1 -0
  81. package/lib/data-objects/index.d.mts +8 -0
  82. package/lib/data-objects/index.d.mts.map +1 -0
  83. package/lib/data-objects/index.mjs +7 -0
  84. package/lib/data-objects/index.mjs.map +1 -0
  85. package/lib/data-objects/pureDataObject.d.mts +94 -0
  86. package/lib/data-objects/pureDataObject.d.mts.map +1 -0
  87. package/lib/data-objects/{pureDataObject.js → pureDataObject.mjs} +37 -70
  88. package/lib/data-objects/pureDataObject.mjs.map +1 -0
  89. package/lib/data-objects/types.d.mts +36 -0
  90. package/lib/data-objects/types.d.mts.map +1 -0
  91. package/lib/data-objects/{types.js → types.mjs} +1 -1
  92. package/lib/data-objects/types.mjs.map +1 -0
  93. package/lib/index.d.mts +8 -0
  94. package/lib/index.d.mts.map +1 -0
  95. package/lib/index.mjs +8 -0
  96. package/lib/index.mjs.map +1 -0
  97. package/package.json +141 -70
  98. package/dist/container-runtime-factories/baseContainerRuntimeFactory.js.map +0 -1
  99. package/dist/container-runtime-factories/containerRuntimeFactoryWithDefaultDataStore.js +0 -35
  100. package/dist/container-runtime-factories/containerRuntimeFactoryWithDefaultDataStore.js.map +0 -1
  101. package/dist/container-runtime-factories/index.js +0 -19
  102. package/dist/container-runtime-factories/index.js.map +0 -1
  103. package/dist/container-services/containerServices.d.ts +0 -27
  104. package/dist/container-services/containerServices.d.ts.map +0 -1
  105. package/dist/container-services/containerServices.js +0 -84
  106. package/dist/container-services/containerServices.js.map +0 -1
  107. package/dist/container-services/index.d.ts +0 -6
  108. package/dist/container-services/index.d.ts.map +0 -1
  109. package/dist/container-services/index.js +0 -18
  110. package/dist/container-services/index.js.map +0 -1
  111. package/dist/data-object-factories/dataObjectFactory.js.map +0 -1
  112. package/dist/data-object-factories/index.js +0 -19
  113. package/dist/data-object-factories/index.js.map +0 -1
  114. package/dist/data-object-factories/pureDataObjectFactory.js.map +0 -1
  115. package/dist/data-objects/dataObject.js.map +0 -1
  116. package/dist/data-objects/index.js.map +0 -1
  117. package/dist/data-objects/pureDataObject.js +0 -153
  118. package/dist/data-objects/pureDataObject.js.map +0 -1
  119. package/dist/data-objects/types.js.map +0 -1
  120. package/dist/index.js +0 -37
  121. package/dist/index.js.map +0 -1
  122. package/dist/request-handlers/index.d.ts +0 -6
  123. package/dist/request-handlers/index.d.ts.map +0 -1
  124. package/dist/request-handlers/index.js +0 -18
  125. package/dist/request-handlers/index.js.map +0 -1
  126. package/dist/request-handlers/requestHandlers.d.ts +0 -36
  127. package/dist/request-handlers/requestHandlers.d.ts.map +0 -1
  128. package/dist/request-handlers/requestHandlers.js +0 -83
  129. package/dist/request-handlers/requestHandlers.js.map +0 -1
  130. package/dist/test/containerServices.spec.js +0 -121
  131. package/dist/test/containerServices.spec.js.map +0 -1
  132. package/dist/test/defaultRoute.spec.js +0 -72
  133. package/dist/test/defaultRoute.spec.js.map +0 -1
  134. package/dist/test/tsconfig.tsbuildinfo +0 -1
  135. package/dist/test/types/validateAqueductPrevious.js +0 -43
  136. package/dist/test/types/validateAqueductPrevious.js.map +0 -1
  137. package/dist/utils/attachUtils.d.ts +0 -7
  138. package/dist/utils/attachUtils.d.ts.map +0 -1
  139. package/dist/utils/attachUtils.js +0 -20
  140. package/dist/utils/attachUtils.js.map +0 -1
  141. package/dist/utils/containerInteractions.d.ts +0 -36
  142. package/dist/utils/containerInteractions.d.ts.map +0 -1
  143. package/dist/utils/containerInteractions.js +0 -70
  144. package/dist/utils/containerInteractions.js.map +0 -1
  145. package/dist/utils/index.d.ts +0 -7
  146. package/dist/utils/index.d.ts.map +0 -1
  147. package/dist/utils/index.js +0 -19
  148. package/dist/utils/index.js.map +0 -1
  149. package/lib/container-runtime-factories/baseContainerRuntimeFactory.js.map +0 -1
  150. package/lib/container-runtime-factories/containerRuntimeFactoryWithDefaultDataStore.js +0 -31
  151. package/lib/container-runtime-factories/containerRuntimeFactoryWithDefaultDataStore.js.map +0 -1
  152. package/lib/container-runtime-factories/index.js +0 -7
  153. package/lib/container-runtime-factories/index.js.map +0 -1
  154. package/lib/container-services/containerServices.js +0 -79
  155. package/lib/container-services/containerServices.js.map +0 -1
  156. package/lib/container-services/index.js +0 -6
  157. package/lib/container-services/index.js.map +0 -1
  158. package/lib/data-object-factories/dataObjectFactory.js.map +0 -1
  159. package/lib/data-object-factories/index.js +0 -7
  160. package/lib/data-object-factories/index.js.map +0 -1
  161. package/lib/data-object-factories/pureDataObjectFactory.js.map +0 -1
  162. package/lib/data-objects/dataObject.js.map +0 -1
  163. package/lib/data-objects/index.js +0 -7
  164. package/lib/data-objects/index.js.map +0 -1
  165. package/lib/data-objects/pureDataObject.js.map +0 -1
  166. package/lib/data-objects/types.js.map +0 -1
  167. package/lib/index.js +0 -25
  168. package/lib/index.js.map +0 -1
  169. package/lib/request-handlers/index.js +0 -6
  170. package/lib/request-handlers/index.js.map +0 -1
  171. package/lib/request-handlers/requestHandlers.js +0 -77
  172. package/lib/request-handlers/requestHandlers.js.map +0 -1
  173. package/lib/utils/attachUtils.js +0 -16
  174. package/lib/utils/attachUtils.js.map +0 -1
  175. package/lib/utils/containerInteractions.js +0 -64
  176. package/lib/utils/containerInteractions.js.map +0 -1
  177. package/lib/utils/index.js +0 -7
  178. package/lib/utils/index.js.map +0 -1
@@ -0,0 +1,120 @@
1
+ "use strict";
2
+ /*!
3
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
4
+ * Licensed under the MIT License.
5
+ */
6
+ Object.defineProperty(exports, "__esModule", { value: true });
7
+ exports.PureDataObject = void 0;
8
+ const client_utils_1 = require("@fluid-internal/client-utils");
9
+ const core_utils_1 = require("@fluidframework/core-utils");
10
+ const runtime_utils_1 = require("@fluidframework/runtime-utils");
11
+ /**
12
+ * This is a bare-bones base class that does basic setup and enables for factory on an initialize call.
13
+ * You probably don't want to inherit from this data store directly unless
14
+ * you are creating another base data store class
15
+ *
16
+ * @typeParam I - The optional input types used to strongly type the data object
17
+ * @alpha
18
+ */
19
+ class PureDataObject extends client_utils_1.TypedEventEmitter {
20
+ get id() {
21
+ return this.runtime.id;
22
+ }
23
+ get IFluidLoadable() {
24
+ return this;
25
+ }
26
+ get IFluidHandle() {
27
+ return this.handle;
28
+ }
29
+ /**
30
+ * Handle to a data store
31
+ */
32
+ get handle() {
33
+ // PureDataObjectFactory already provides an entryPoint initialization function to the data store runtime,
34
+ // so this object should always have access to a non-null entryPoint. Need to cast because PureDataObject
35
+ // tried to be too smart with its typing for handles :).
36
+ (0, core_utils_1.assert)(this.runtime.entryPoint !== undefined, 0x46b /* EntryPoint was undefined */);
37
+ return this.runtime.entryPoint;
38
+ }
39
+ static async getDataObject(runtime) {
40
+ const obj = await runtime.entryPoint.get();
41
+ return obj;
42
+ }
43
+ constructor(props) {
44
+ super();
45
+ this.runtime = props.runtime;
46
+ this.context = props.context;
47
+ this.providers = props.providers;
48
+ this.initProps = props.initProps;
49
+ (0, core_utils_1.assert)(this.runtime._dataObject === undefined, 0x0bd /* "Object runtime already has DataObject!" */);
50
+ this.runtime._dataObject = this;
51
+ }
52
+ /**
53
+ * Return this object if someone requests it directly
54
+ * We will return this object in two scenarios:
55
+ *
56
+ * 1. the request url is a "/"
57
+ *
58
+ * 2. the request url is empty
59
+ */
60
+ async request(req) {
61
+ return req.url === "" || req.url === "/" || req.url.startsWith("/?")
62
+ ? { mimeType: "fluid/object", status: 200, value: this }
63
+ : (0, runtime_utils_1.create404Response)(req);
64
+ }
65
+ /**
66
+ * Call this API to ensure PureDataObject is fully initialized.
67
+ * Initialization happens on demand, only on as-needed bases.
68
+ * In most cases you should allow factory/object to decide when to finish initialization.
69
+ * But if you are supplying your own implementation of DataStoreRuntime factory and overriding some methods
70
+ * and need a fully initialized object, then you can call this API to ensure object is fully initialized.
71
+ */
72
+ async finishInitialization(existing) {
73
+ if (this.initializeP !== undefined) {
74
+ return this.initializeP;
75
+ }
76
+ this.initializeP = this.initializeInternal(existing);
77
+ return this.initializeP;
78
+ }
79
+ /**
80
+ * Internal initialize implementation. Overwriting this will change the flow of the PureDataObject and should
81
+ * generally not be done.
82
+ *
83
+ * Calls initializingFirstTime, initializingFromExisting, and hasInitialized. Caller is
84
+ * responsible for ensuring this is only invoked once.
85
+ */
86
+ async initializeInternal(existing) {
87
+ await this.preInitialize();
88
+ if (existing) {
89
+ (0, core_utils_1.assert)(this.initProps === undefined, 0x0be /* "Trying to initialize from existing while initProps is set!" */);
90
+ await this.initializingFromExisting();
91
+ }
92
+ else {
93
+ await this.initializingFirstTime(this.context.createProps ?? this.initProps);
94
+ }
95
+ await this.hasInitialized();
96
+ }
97
+ /**
98
+ * Called every time the data store is initialized, before initializingFirstTime or
99
+ * initializingFromExisting is called.
100
+ */
101
+ async preInitialize() { }
102
+ /**
103
+ * Called the first time the data store is initialized (new creations with a new
104
+ * data store runtime)
105
+ *
106
+ * @param props - Optional props to be passed in on create
107
+ */
108
+ async initializingFirstTime(props) { }
109
+ /**
110
+ * Called every time but the first time the data store is initialized (creations
111
+ * with an existing data store runtime)
112
+ */
113
+ async initializingFromExisting() { }
114
+ /**
115
+ * Called every time the data store is initialized after create or existing.
116
+ */
117
+ async hasInitialized() { }
118
+ }
119
+ exports.PureDataObject = PureDataObject;
120
+ //# sourceMappingURL=pureDataObject.cjs.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"pureDataObject.cjs","sourceRoot":"","sources":["../../src/data-objects/pureDataObject.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,+DAAiE;AACjE,2DAAoD;AAYpD,iEAAkE;AAGlE;;;;;;;GAOG;AACH,MAAsB,cACrB,SAAQ,gCAAuC;IA0B/C,IAAW,EAAE;QACZ,OAAO,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC;IACxB,CAAC;IACD,IAAW,cAAc;QACxB,OAAO,IAAI,CAAC;IACb,CAAC;IACD,IAAW,YAAY;QACtB,OAAO,IAAI,CAAC,MAAM,CAAC;IACpB,CAAC;IAED;;OAEG;IACH,IAAW,MAAM;QAChB,0GAA0G;QAC1G,yGAAyG;QACzG,wDAAwD;QACxD,IAAA,mBAAM,EAAC,IAAI,CAAC,OAAO,CAAC,UAAU,KAAK,SAAS,EAAE,KAAK,CAAC,8BAA8B,CAAC,CAAC;QACpF,OAAO,IAAI,CAAC,OAAO,CAAC,UAAgC,CAAC;IACtD,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,aAAa,CAAC,OAA+B;QAChE,MAAM,GAAG,GAAG,MAAM,OAAO,CAAC,UAAU,CAAC,GAAG,EAAE,CAAC;QAC3C,OAAO,GAAqB,CAAC;IAC9B,CAAC;IAED,YAAmB,KAA0B;QAC5C,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC;QAC7B,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC;QAC7B,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC,SAAS,CAAC;QACjC,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC,SAAS,CAAC;QAEjC,IAAA,mBAAM,EACJ,IAAI,CAAC,OAAe,CAAC,WAAW,KAAK,SAAS,EAC/C,KAAK,CAAC,8CAA8C,CACpD,CAAC;QACD,IAAI,CAAC,OAAe,CAAC,WAAW,GAAG,IAAI,CAAC;IAC1C,CAAC;IAED;;;;;;;OAOG;IACI,KAAK,CAAC,OAAO,CAAC,GAAa;QACjC,OAAO,GAAG,CAAC,GAAG,KAAK,EAAE,IAAI,GAAG,CAAC,GAAG,KAAK,GAAG,IAAI,GAAG,CAAC,GAAG,CAAC,UAAU,CAAC,IAAI,CAAC;YACnE,CAAC,CAAC,EAAE,QAAQ,EAAE,cAAc,EAAE,MAAM,EAAE,GAAG,EAAE,KAAK,EAAE,IAAI,EAAE;YACxD,CAAC,CAAC,IAAA,iCAAiB,EAAC,GAAG,CAAC,CAAC;IAC3B,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,oBAAoB,CAAC,QAAiB;QAClD,IAAI,IAAI,CAAC,WAAW,KAAK,SAAS,EAAE;YACnC,OAAO,IAAI,CAAC,WAAW,CAAC;SACxB;QACD,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,kBAAkB,CAAC,QAAQ,CAAC,CAAC;QACrD,OAAO,IAAI,CAAC,WAAW,CAAC;IACzB,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,kBAAkB,CAAC,QAAiB;QAChD,MAAM,IAAI,CAAC,aAAa,EAAE,CAAC;QAC3B,IAAI,QAAQ,EAAE;YACb,IAAA,mBAAM,EACL,IAAI,CAAC,SAAS,KAAK,SAAS,EAC5B,KAAK,CAAC,kEAAkE,CACxE,CAAC;YACF,MAAM,IAAI,CAAC,wBAAwB,EAAE,CAAC;SACtC;aAAM;YACN,MAAM,IAAI,CAAC,qBAAqB,CAC9B,IAAI,CAAC,OAAO,CAAC,WAAiC,IAAI,IAAI,CAAC,SAAS,CACjE,CAAC;SACF;QACD,MAAM,IAAI,CAAC,cAAc,EAAE,CAAC;IAC7B,CAAC;IAED;;;OAGG;IACO,KAAK,CAAC,aAAa,KAAmB,CAAC;IAEjD;;;;;OAKG;IACO,KAAK,CAAC,qBAAqB,CAAC,KAAyB,IAAkB,CAAC;IAElF;;;OAGG;IACO,KAAK,CAAC,wBAAwB,KAAmB,CAAC;IAE5D;;OAEG;IACO,KAAK,CAAC,cAAc,KAAmB,CAAC;CAClD;AA/ID,wCA+IC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { TypedEventEmitter } from \"@fluid-internal/client-utils\";\nimport { assert } from \"@fluidframework/core-utils\";\nimport {\n\tIEvent,\n\tIFluidHandle,\n\tIFluidLoadable,\n\tIProvideFluidHandle,\n\tIRequest,\n\tIResponse,\n} from \"@fluidframework/core-interfaces\";\nimport { IFluidDataStoreRuntime } from \"@fluidframework/datastore-definitions\";\nimport { IFluidDataStoreContext } from \"@fluidframework/runtime-definitions\";\nimport { AsyncFluidObjectProvider } from \"@fluidframework/synthesize\";\nimport { create404Response } from \"@fluidframework/runtime-utils\";\nimport { DataObjectTypes, IDataObjectProps } from \"./types\";\n\n/**\n * This is a bare-bones base class that does basic setup and enables for factory on an initialize call.\n * You probably don't want to inherit from this data store directly unless\n * you are creating another base data store class\n *\n * @typeParam I - The optional input types used to strongly type the data object\n * @alpha\n */\nexport abstract class PureDataObject<I extends DataObjectTypes = DataObjectTypes>\n\textends TypedEventEmitter<I[\"Events\"] & IEvent>\n\timplements IFluidLoadable, IProvideFluidHandle\n{\n\t/**\n\t * This is your FluidDataStoreRuntime object\n\t */\n\tprotected readonly runtime: IFluidDataStoreRuntime;\n\n\t/**\n\t * This context is used to talk up to the ContainerRuntime\n\t */\n\tprotected readonly context: IFluidDataStoreContext;\n\n\t/**\n\t * Providers are FluidObject keyed objects that provide back\n\t * a promise to the corresponding FluidObject or undefined.\n\t * Providers injected/provided by the Container and/or HostingApplication\n\t *\n\t * To define providers set FluidObject interfaces in the OptionalProviders generic type for your data store\n\t */\n\tprotected readonly providers: AsyncFluidObjectProvider<I[\"OptionalProviders\"]>;\n\n\tprotected initProps?: I[\"InitialState\"];\n\n\tprotected initializeP: Promise<void> | undefined;\n\n\tpublic get id() {\n\t\treturn this.runtime.id;\n\t}\n\tpublic get IFluidLoadable() {\n\t\treturn this;\n\t}\n\tpublic get IFluidHandle() {\n\t\treturn this.handle;\n\t}\n\n\t/**\n\t * Handle to a data store\n\t */\n\tpublic get handle(): IFluidHandle<this> {\n\t\t// PureDataObjectFactory already provides an entryPoint initialization function to the data store runtime,\n\t\t// so this object should always have access to a non-null entryPoint. Need to cast because PureDataObject\n\t\t// tried to be too smart with its typing for handles :).\n\t\tassert(this.runtime.entryPoint !== undefined, 0x46b /* EntryPoint was undefined */);\n\t\treturn this.runtime.entryPoint as IFluidHandle<this>;\n\t}\n\n\tpublic static async getDataObject(runtime: IFluidDataStoreRuntime) {\n\t\tconst obj = await runtime.entryPoint.get();\n\t\treturn obj as PureDataObject;\n\t}\n\n\tpublic constructor(props: IDataObjectProps<I>) {\n\t\tsuper();\n\t\tthis.runtime = props.runtime;\n\t\tthis.context = props.context;\n\t\tthis.providers = props.providers;\n\t\tthis.initProps = props.initProps;\n\n\t\tassert(\n\t\t\t(this.runtime as any)._dataObject === undefined,\n\t\t\t0x0bd /* \"Object runtime already has DataObject!\" */,\n\t\t);\n\t\t(this.runtime as any)._dataObject = this;\n\t}\n\n\t/**\n\t * Return this object if someone requests it directly\n\t * We will return this object in two scenarios:\n\t *\n\t * 1. the request url is a \"/\"\n\t *\n\t * 2. the request url is empty\n\t */\n\tpublic async request(req: IRequest): Promise<IResponse> {\n\t\treturn req.url === \"\" || req.url === \"/\" || req.url.startsWith(\"/?\")\n\t\t\t? { mimeType: \"fluid/object\", status: 200, value: this }\n\t\t\t: create404Response(req);\n\t}\n\n\t/**\n\t * Call this API to ensure PureDataObject is fully initialized.\n\t * Initialization happens on demand, only on as-needed bases.\n\t * In most cases you should allow factory/object to decide when to finish initialization.\n\t * But if you are supplying your own implementation of DataStoreRuntime factory and overriding some methods\n\t * and need a fully initialized object, then you can call this API to ensure object is fully initialized.\n\t */\n\tpublic async finishInitialization(existing: boolean): Promise<void> {\n\t\tif (this.initializeP !== undefined) {\n\t\t\treturn this.initializeP;\n\t\t}\n\t\tthis.initializeP = this.initializeInternal(existing);\n\t\treturn this.initializeP;\n\t}\n\n\t/**\n\t * Internal initialize implementation. Overwriting this will change the flow of the PureDataObject and should\n\t * generally not be done.\n\t *\n\t * Calls initializingFirstTime, initializingFromExisting, and hasInitialized. Caller is\n\t * responsible for ensuring this is only invoked once.\n\t */\n\tpublic async initializeInternal(existing: boolean): Promise<void> {\n\t\tawait this.preInitialize();\n\t\tif (existing) {\n\t\t\tassert(\n\t\t\t\tthis.initProps === undefined,\n\t\t\t\t0x0be /* \"Trying to initialize from existing while initProps is set!\" */,\n\t\t\t);\n\t\t\tawait this.initializingFromExisting();\n\t\t} else {\n\t\t\tawait this.initializingFirstTime(\n\t\t\t\t(this.context.createProps as I[\"InitialState\"]) ?? this.initProps,\n\t\t\t);\n\t\t}\n\t\tawait this.hasInitialized();\n\t}\n\n\t/**\n\t * Called every time the data store is initialized, before initializingFirstTime or\n\t * initializingFromExisting is called.\n\t */\n\tprotected async preInitialize(): Promise<void> {}\n\n\t/**\n\t * Called the first time the data store is initialized (new creations with a new\n\t * data store runtime)\n\t *\n\t * @param props - Optional props to be passed in on create\n\t */\n\tprotected async initializingFirstTime(props?: I[\"InitialState\"]): Promise<void> {}\n\n\t/**\n\t * Called every time but the first time the data store is initialized (creations\n\t * with an existing data store runtime)\n\t */\n\tprotected async initializingFromExisting(): Promise<void> {}\n\n\t/**\n\t * Called every time the data store is initialized after create or existing.\n\t */\n\tprotected async hasInitialized(): Promise<void> {}\n}\n"]}
@@ -2,11 +2,9 @@
2
2
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
3
3
  * Licensed under the MIT License.
4
4
  */
5
- import { IEvent } from "@fluidframework/common-definitions";
6
- import { EventForwarder } from "@fluidframework/common-utils";
7
- import { IFluidHandle, IFluidLoadable, IFluidRouter, IProvideFluidHandle, IRequest, IResponse, FluidObject } from "@fluidframework/core-interfaces";
5
+ import { TypedEventEmitter } from "@fluid-internal/client-utils";
6
+ import { IEvent, IFluidHandle, IFluidLoadable, IProvideFluidHandle, IRequest, IResponse } from "@fluidframework/core-interfaces";
8
7
  import { IFluidDataStoreRuntime } from "@fluidframework/datastore-definitions";
9
- import { IDirectory } from "@fluidframework/map";
10
8
  import { IFluidDataStoreContext } from "@fluidframework/runtime-definitions";
11
9
  import { AsyncFluidObjectProvider } from "@fluidframework/synthesize";
12
10
  import { DataObjectTypes, IDataObjectProps } from "./types";
@@ -16,10 +14,9 @@ import { DataObjectTypes, IDataObjectProps } from "./types";
16
14
  * you are creating another base data store class
17
15
  *
18
16
  * @typeParam I - The optional input types used to strongly type the data object
17
+ * @alpha
19
18
  */
20
- export declare abstract class PureDataObject<I extends DataObjectTypes = DataObjectTypes> extends EventForwarder<I["Events"] & IEvent> implements IFluidLoadable, IFluidRouter, IProvideFluidHandle {
21
- private readonly innerHandle;
22
- private _disposed;
19
+ export declare abstract class PureDataObject<I extends DataObjectTypes = DataObjectTypes> extends TypedEventEmitter<I["Events"] & IEvent> implements IFluidLoadable, IProvideFluidHandle {
23
20
  /**
24
21
  * This is your FluidDataStoreRuntime object
25
22
  */
@@ -38,9 +35,7 @@ export declare abstract class PureDataObject<I extends DataObjectTypes = DataObj
38
35
  protected readonly providers: AsyncFluidObjectProvider<I["OptionalProviders"]>;
39
36
  protected initProps?: I["InitialState"];
40
37
  protected initializeP: Promise<void> | undefined;
41
- get disposed(): boolean;
42
38
  get id(): string;
43
- get IFluidRouter(): this;
44
39
  get IFluidLoadable(): this;
45
40
  get IFluidHandle(): IFluidHandle<this>;
46
41
  /**
@@ -52,8 +47,10 @@ export declare abstract class PureDataObject<I extends DataObjectTypes = DataObj
52
47
  /**
53
48
  * Return this object if someone requests it directly
54
49
  * We will return this object in two scenarios:
55
- * 1. the request url is a "/"
56
- * 2. the request url is empty
50
+ *
51
+ * 1. the request url is a "/"
52
+ *
53
+ * 2. the request url is empty
57
54
  */
58
55
  request(req: IRequest): Promise<IResponse>;
59
56
  /**
@@ -72,20 +69,6 @@ export declare abstract class PureDataObject<I extends DataObjectTypes = DataObj
72
69
  * responsible for ensuring this is only invoked once.
73
70
  */
74
71
  initializeInternal(existing: boolean): Promise<void>;
75
- /**
76
- * Retrieve Fluid object using the handle get
77
- *
78
- * @param key - key that object (handle/id) is stored with in the directory
79
- * @param directory - directory containing the object
80
- * @param getObjectFromDirectory - optional callback for fetching object from the directory, allows users to
81
- * define custom types/getters for object retrieval
82
- */
83
- getFluidObjectFromDirectory<T extends IFluidLoadable>(key: string, directory: IDirectory, getObjectFromDirectory?: (id: string, directory: IDirectory) => IFluidHandle | undefined): Promise<T | undefined>;
84
- /**
85
- * Gets the service at a given id.
86
- * @param id - service id
87
- */
88
- protected getService<T extends FluidObject>(id: string): Promise<T>;
89
72
  /**
90
73
  * Called every time the data store is initialized, before initializingFirstTime or
91
74
  * initializingFromExisting is called.
@@ -107,9 +90,5 @@ export declare abstract class PureDataObject<I extends DataObjectTypes = DataObj
107
90
  * Called every time the data store is initialized after create or existing.
108
91
  */
109
92
  protected hasInitialized(): Promise<void>;
110
- /**
111
- * Called when the host container closes and disposes itself
112
- */
113
- dispose(): void;
114
93
  }
115
94
  //# sourceMappingURL=pureDataObject.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"pureDataObject.d.ts","sourceRoot":"","sources":["../../src/data-objects/pureDataObject.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,MAAM,EAAE,MAAM,oCAAoC,CAAC;AAC5D,OAAO,EAAU,cAAc,EAAE,MAAM,8BAA8B,CAAC;AACtE,OAAO,EACH,YAAY,EACZ,cAAc,EACd,YAAY,EACZ,mBAAmB,EACnB,QAAQ,EACR,SAAS,EACT,WAAW,EACd,MAAM,iCAAiC,CAAC;AAEzC,OAAO,EAAE,sBAAsB,EAAE,MAAM,uCAAuC,CAAC;AAC/E,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAEjD,OAAO,EAAE,sBAAsB,EAAE,MAAM,qCAAqC,CAAC;AAC7E,OAAO,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAC;AAGtE,OAAO,EAAE,eAAe,EAAE,gBAAgB,EAAE,MAAM,SAAS,CAAC;AAE5D;;;;;;GAMG;AACH,8BAAsB,cAAc,CAAC,CAAC,SAAS,eAAe,GAAG,eAAe,CAC5E,SAAQ,cAAc,CAAC,CAAC,CAAC,QAAQ,CAAC,GAAG,MAAM,CAC3C,YAAW,cAAc,EAAE,YAAY,EAAE,mBAAmB;IAC5D,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAqB;IACjD,OAAO,CAAC,SAAS,CAAS;IAE1B;;OAEG;IACH,SAAS,CAAC,QAAQ,CAAC,OAAO,EAAE,sBAAsB,CAAC;IAEnD;;OAEG;IACH,SAAS,CAAC,QAAQ,CAAC,OAAO,EAAE,sBAAsB,CAAC;IAEnD;;;;;;OAMG;IACH,SAAS,CAAC,QAAQ,CAAC,SAAS,EAAE,wBAAwB,CAAC,CAAC,CAAC,mBAAmB,CAAC,CAAC,CAAC;IAE/E,SAAS,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC,cAAc,CAAC,CAAC;IAExC,SAAS,CAAC,WAAW,EAAE,OAAO,CAAC,IAAI,CAAC,GAAG,SAAS,CAAC;IAEjD,IAAW,QAAQ,YAA6B;IAEhD,IAAW,EAAE,WAA8B;IAC3C,IAAW,YAAY,SAAmB;IAC1C,IAAW,cAAc,SAAmB;IAC5C,IAAW,YAAY,uBAA+B;IAEtD;;OAEG;IACH,IAAW,MAAM,IAAI,YAAY,CAAC,IAAI,CAAC,CAA6B;WAEhD,aAAa,CAAC,OAAO,EAAE,sBAAsB;gBAO9C,KAAK,EAAE,gBAAgB,CAAC,CAAC,CAAC;IAwB7C;;;;;OAKG;IACU,OAAO,CAAC,GAAG,EAAE,QAAQ,GAAG,OAAO,CAAC,SAAS,CAAC;IAUvD;;;;;;OAMG;IACU,oBAAoB,CAAC,QAAQ,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;IAQnE;;;;;;OAMG;IACU,kBAAkB,CAAC,QAAQ,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;IAajE;;;;;;;OAOG;IACU,2BAA2B,CAAC,CAAC,SAAS,cAAc,EAC7D,GAAG,EAAE,MAAM,EACX,SAAS,EAAE,UAAU,EACrB,sBAAsB,CAAC,EAAE,CAAC,EAAE,EAAE,MAAM,EAAE,SAAS,EAAE,UAAU,KAAK,YAAY,GAAG,SAAS,GACxF,OAAO,CAAC,CAAC,GAAG,SAAS,CAAC;IAS1B;;;OAGG;cACa,UAAU,CAAC,CAAC,SAAS,WAAW,EAAE,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,CAAC;IAIzE;;;OAGG;cACa,aAAa,IAAI,OAAO,CAAC,IAAI,CAAC;IAE9C;;;;;OAKG;cACa,qBAAqB,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,cAAc,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IAE/E;;;OAGG;cACa,wBAAwB,IAAI,OAAO,CAAC,IAAI,CAAC;IAEzD;;OAEG;cACa,cAAc,IAAI,OAAO,CAAC,IAAI,CAAC;IAE/C;;OAEG;IACI,OAAO,IAAI,IAAI;CAGzB"}
1
+ {"version":3,"file":"pureDataObject.d.ts","sourceRoot":"","sources":["../../src/data-objects/pureDataObject.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,iBAAiB,EAAE,MAAM,8BAA8B,CAAC;AAEjE,OAAO,EACN,MAAM,EACN,YAAY,EACZ,cAAc,EACd,mBAAmB,EACnB,QAAQ,EACR,SAAS,EACT,MAAM,iCAAiC,CAAC;AACzC,OAAO,EAAE,sBAAsB,EAAE,MAAM,uCAAuC,CAAC;AAC/E,OAAO,EAAE,sBAAsB,EAAE,MAAM,qCAAqC,CAAC;AAC7E,OAAO,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAC;AAEtE,OAAO,EAAE,eAAe,EAAE,gBAAgB,EAAE,MAAM,SAAS,CAAC;AAE5D;;;;;;;GAOG;AACH,8BAAsB,cAAc,CAAC,CAAC,SAAS,eAAe,GAAG,eAAe,CAC/E,SAAQ,iBAAiB,CAAC,CAAC,CAAC,QAAQ,CAAC,GAAG,MAAM,CAC9C,YAAW,cAAc,EAAE,mBAAmB;IAE9C;;OAEG;IACH,SAAS,CAAC,QAAQ,CAAC,OAAO,EAAE,sBAAsB,CAAC;IAEnD;;OAEG;IACH,SAAS,CAAC,QAAQ,CAAC,OAAO,EAAE,sBAAsB,CAAC;IAEnD;;;;;;OAMG;IACH,SAAS,CAAC,QAAQ,CAAC,SAAS,EAAE,wBAAwB,CAAC,CAAC,CAAC,mBAAmB,CAAC,CAAC,CAAC;IAE/E,SAAS,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC,cAAc,CAAC,CAAC;IAExC,SAAS,CAAC,WAAW,EAAE,OAAO,CAAC,IAAI,CAAC,GAAG,SAAS,CAAC;IAEjD,IAAW,EAAE,WAEZ;IACD,IAAW,cAAc,SAExB;IACD,IAAW,YAAY,uBAEtB;IAED;;OAEG;IACH,IAAW,MAAM,IAAI,YAAY,CAAC,IAAI,CAAC,CAMtC;WAEmB,aAAa,CAAC,OAAO,EAAE,sBAAsB;gBAK9C,KAAK,EAAE,gBAAgB,CAAC,CAAC,CAAC;IAc7C;;;;;;;OAOG;IACU,OAAO,CAAC,GAAG,EAAE,QAAQ,GAAG,OAAO,CAAC,SAAS,CAAC;IAMvD;;;;;;OAMG;IACU,oBAAoB,CAAC,QAAQ,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;IAQnE;;;;;;OAMG;IACU,kBAAkB,CAAC,QAAQ,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;IAgBjE;;;OAGG;cACa,aAAa,IAAI,OAAO,CAAC,IAAI,CAAC;IAE9C;;;;;OAKG;cACa,qBAAqB,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,cAAc,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IAE/E;;;OAGG;cACa,wBAAwB,IAAI,OAAO,CAAC,IAAI,CAAC;IAEzD;;OAEG;cACa,cAAc,IAAI,OAAO,CAAC,IAAI,CAAC;CAC/C"}
@@ -4,4 +4,4 @@
4
4
  * Licensed under the MIT License.
5
5
  */
6
6
  Object.defineProperty(exports, "__esModule", { value: true });
7
- //# sourceMappingURL=types.js.map
7
+ //# sourceMappingURL=types.cjs.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"types.cjs","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 { IEvent, FluidObject } from \"@fluidframework/core-interfaces\";\nimport { AsyncFluidObjectProvider } from \"@fluidframework/synthesize\";\nimport { IFluidDataStoreContext } from \"@fluidframework/runtime-definitions\";\nimport { IFluidDataStoreRuntime } from \"@fluidframework/datastore-definitions\";\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\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"]}
@@ -2,13 +2,13 @@
2
2
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
3
3
  * Licensed under the MIT License.
4
4
  */
5
- import { FluidObject } from "@fluidframework/core-interfaces";
5
+ import { IEvent, FluidObject } from "@fluidframework/core-interfaces";
6
6
  import { AsyncFluidObjectProvider } from "@fluidframework/synthesize";
7
7
  import { IFluidDataStoreContext } from "@fluidframework/runtime-definitions";
8
8
  import { IFluidDataStoreRuntime } from "@fluidframework/datastore-definitions";
9
- import { IEvent } from "@fluidframework/common-definitions";
10
9
  /**
11
10
  * This type is used as the base generic input to DataObject and PureDataObject.
11
+ * @alpha
12
12
  */
13
13
  export interface DataObjectTypes {
14
14
  /**
@@ -24,6 +24,9 @@ export interface DataObjectTypes {
24
24
  */
25
25
  Events?: IEvent;
26
26
  }
27
+ /**
28
+ * @alpha
29
+ */
27
30
  export interface IDataObjectProps<I extends DataObjectTypes = DataObjectTypes> {
28
31
  readonly runtime: IFluidDataStoreRuntime;
29
32
  readonly context: IFluidDataStoreContext;
@@ -1 +1 @@
1
- {"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/data-objects/types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EACH,WAAW,EACd,MAAM,iCAAiC,CAAC;AACzC,OAAO,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAC;AACtE,OAAO,EAAE,sBAAsB,EAAE,MAAM,qCAAqC,CAAC;AAC7E,OAAO,EAAE,sBAAsB,EAAE,MAAM,uCAAuC,CAAC;AAC/E,OAAO,EAAE,MAAM,EAAE,MAAM,oCAAoC,CAAC;AAE5D;;GAEG;AACH,MAAM,WAAW,eAAe;IAC5B;;OAEG;IACH,iBAAiB,CAAC,EAAE,WAAW,CAAC;IAChC;;OAEG;IACH,YAAY,CAAC,EAAE,GAAG,CAAC;IACnB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,gBAAgB,CAAC,CAAC,SAAS,eAAe,GAAG,eAAe;IACzE,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;CAC1C"}
1
+ {"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/data-objects/types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,iCAAiC,CAAC;AACtE,OAAO,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAC;AACtE,OAAO,EAAE,sBAAsB,EAAE,MAAM,qCAAqC,CAAC;AAC7E,OAAO,EAAE,sBAAsB,EAAE,MAAM,uCAAuC,CAAC;AAE/E;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC/B;;OAEG;IACH,iBAAiB,CAAC,EAAE,WAAW,CAAC;IAChC;;OAEG;IACH,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"}
package/dist/index.cjs ADDED
@@ -0,0 +1,31 @@
1
+ "use strict";
2
+ /*!
3
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
4
+ * Licensed under the MIT License.
5
+ */
6
+ Object.defineProperty(exports, "__esModule", { value: true });
7
+ exports.ContainerRuntimeFactoryWithDefaultDataStore = exports.BaseContainerRuntimeFactory = exports.PureDataObject = exports.DataObject = exports.PureDataObjectFactory = exports.DataObjectFactory = void 0;
8
+ /**
9
+ * The `aqueduct` package is a library for building Fluid objects and Fluid
10
+ * containers within the Fluid Framework. Its goal is to provide a thin base
11
+ * layer over the existing Fluid Framework interfaces that allows developers to
12
+ * get started quickly.
13
+ *
14
+ * @remarks
15
+ * About the library name: An "aqueduct" is a way to transport water from a source
16
+ * to another location. The library name was chosen because its purpose is to
17
+ * facilitate using lower level constructs and therefore handle 'fluid' items
18
+ * same as an aqueduct.
19
+ *
20
+ * @packageDocumentation
21
+ */
22
+ var data_object_factories_1 = require("./data-object-factories/index.cjs");
23
+ Object.defineProperty(exports, "DataObjectFactory", { enumerable: true, get: function () { return data_object_factories_1.DataObjectFactory; } });
24
+ Object.defineProperty(exports, "PureDataObjectFactory", { enumerable: true, get: function () { return data_object_factories_1.PureDataObjectFactory; } });
25
+ var data_objects_1 = require("./data-objects/index.cjs");
26
+ Object.defineProperty(exports, "DataObject", { enumerable: true, get: function () { return data_objects_1.DataObject; } });
27
+ Object.defineProperty(exports, "PureDataObject", { enumerable: true, get: function () { return data_objects_1.PureDataObject; } });
28
+ var container_runtime_factories_1 = require("./container-runtime-factories/index.cjs");
29
+ Object.defineProperty(exports, "BaseContainerRuntimeFactory", { enumerable: true, get: function () { return container_runtime_factories_1.BaseContainerRuntimeFactory; } });
30
+ Object.defineProperty(exports, "ContainerRuntimeFactoryWithDefaultDataStore", { enumerable: true, get: function () { return container_runtime_factories_1.ContainerRuntimeFactoryWithDefaultDataStore; } });
31
+ //# sourceMappingURL=index.cjs.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.cjs","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH;;;;;;;;;;;;;GAaG;AAEH,2EAAmF;AAA1E,0HAAA,iBAAiB,OAAA;AAAE,8HAAA,qBAAqB,OAAA;AACjD,yDAA+F;AAAtF,0GAAA,UAAU,OAAA;AAAqC,8GAAA,cAAc,OAAA;AACtE,uFAGuC;AAFtC,0IAAA,2BAA2B,OAAA;AAC3B,0JAAA,2CAA2C,OAAA","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\n/**\n * The `aqueduct` package is a library for building Fluid objects and Fluid\n * containers within the Fluid Framework. Its goal is to provide a thin base\n * layer over the existing Fluid Framework interfaces that allows developers to\n * get started quickly.\n *\n * @remarks\n * About the library name: An \"aqueduct\" is a way to transport water from a source\n * to another location. The library name was chosen because its purpose is to\n * facilitate using lower level constructs and therefore handle 'fluid' items\n * same as an aqueduct.\n *\n * @packageDocumentation\n */\n\nexport { DataObjectFactory, PureDataObjectFactory } from \"./data-object-factories\";\nexport { DataObject, DataObjectTypes, IDataObjectProps, PureDataObject } from \"./data-objects\";\nexport {\n\tBaseContainerRuntimeFactory,\n\tContainerRuntimeFactoryWithDefaultDataStore,\n} from \"./container-runtime-factories\";\n"]}
package/dist/index.d.ts CHANGED
@@ -9,17 +9,14 @@
9
9
  * get started quickly.
10
10
  *
11
11
  * @remarks
12
- * About the package name: An Aqueduct is a way to transport water from a source
13
- * to another location. The package name was chosen because its purpose is to
12
+ * About the library name: An "aqueduct" is a way to transport water from a source
13
+ * to another location. The library name was chosen because its purpose is to
14
14
  * facilitate using lower level constructs and therefore handle 'fluid' items
15
15
  * same as an aqueduct.
16
16
  *
17
17
  * @packageDocumentation
18
18
  */
19
- export * from "./data-object-factories";
20
- export * from "./data-objects";
21
- export * from "./container-runtime-factories";
22
- export * from "./container-services";
23
- export * from "./request-handlers";
24
- export * from "./utils";
19
+ export { DataObjectFactory, PureDataObjectFactory } from "./data-object-factories";
20
+ export { DataObject, DataObjectTypes, IDataObjectProps, PureDataObject } from "./data-objects";
21
+ export { BaseContainerRuntimeFactory, ContainerRuntimeFactoryWithDefaultDataStore, } from "./container-runtime-factories";
25
22
  //# sourceMappingURL=index.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;;;;;;;;;;;;GAaG;AAEH,cAAc,yBAAyB,CAAC;AACxC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,+BAA+B,CAAC;AAC9C,cAAc,sBAAsB,CAAC;AACrC,cAAc,oBAAoB,CAAC;AACnC,cAAc,SAAS,CAAC"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;;;;;;;;;;;;GAaG;AAEH,OAAO,EAAE,iBAAiB,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AACnF,OAAO,EAAE,UAAU,EAAE,eAAe,EAAE,gBAAgB,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAC/F,OAAO,EACN,2BAA2B,EAC3B,2CAA2C,GAC3C,MAAM,+BAA+B,CAAC"}
@@ -0,0 +1,11 @@
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.38.3"
9
+ }
10
+ ]
11
+ }