fluid-framework 2.91.0 → 2.93.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/CHANGELOG.md +156 -0
- package/README.md +1 -1
- package/alpha.d.ts +1 -1
- package/api-report/fluid-framework.alpha.api.md +158 -50
- package/api-report/fluid-framework.beta.api.md +80 -12
- package/api-report/fluid-framework.legacy.beta.api.md +91 -17
- package/api-report/fluid-framework.legacy.public.api.md +3 -0
- package/api-report/fluid-framework.public.api.md +3 -0
- package/beta.d.ts +1 -1
- package/dist/alpha.d.ts +27 -10
- package/dist/beta.d.ts +12 -1
- package/dist/index.d.ts +5 -4
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +16 -13
- package/dist/index.js.map +1 -1
- package/dist/legacy.d.ts +13 -1
- package/dist/public.d.ts +2 -1
- package/eslint.config.mts +1 -1
- package/legacy.d.ts +1 -1
- package/lib/alpha.d.ts +27 -10
- package/lib/beta.d.ts +12 -1
- package/lib/index.d.ts +5 -4
- package/lib/index.d.ts.map +1 -1
- package/lib/index.js +3 -2
- package/lib/index.js.map +1 -1
- package/lib/legacy.d.ts +13 -1
- package/lib/public.d.ts +2 -1
- package/lib/tsdoc-metadata.json +1 -1
- package/package.json +21 -34
- package/src/index.ts +11 -3
package/dist/index.d.ts
CHANGED
|
@@ -13,11 +13,12 @@ ICriticalContainerError, } from "@fluidframework/container-definitions";
|
|
|
13
13
|
export { AttachState } from "@fluidframework/container-definitions";
|
|
14
14
|
export { ConnectionState } from "@fluidframework/container-loader";
|
|
15
15
|
export type { ContainerAttachProps, ContainerSchema, IConnection, IFluidContainer, IFluidContainerEvents, IMember, InitialObjects, IServiceAudience, IServiceAudienceEvents, MemberChangedListener, Myself, } from "@fluidframework/fluid-static";
|
|
16
|
+
export { getPresence, getPresenceAlpha } from "@fluidframework/fluid-static/internal";
|
|
16
17
|
export type { SharedObjectKind } from "@fluidframework/shared-object-base";
|
|
17
18
|
export type { IErrorBase, IEventProvider, IDisposable, IEvent, IEventThisPlaceHolder, IErrorEvent, ErasedType, IFluidHandle, IFluidLoadable, ITelemetryBaseProperties, IEventTransformer, IProvideFluidLoadable, IFluidHandleErased, TransformedEvent, TelemetryBaseEventPropertyType, Tagged, ReplaceIEventThisPlaceHolder, FluidObject, // Linked in doc comment
|
|
18
19
|
FluidObjectProviderKeys, // Used by FluidObject
|
|
19
20
|
Listeners, IsListener, Listenable, Off, } from "@fluidframework/core-interfaces";
|
|
20
|
-
export type { ErasedBaseType } from "@fluidframework/core-interfaces/internal";
|
|
21
|
+
export type { ErasedBaseType, FluidIterable, FluidIterableIterator, FluidMap, FluidReadonlyMap, } from "@fluidframework/core-interfaces/internal";
|
|
21
22
|
export { onAssertionFailure } from "@fluidframework/core-utils/internal";
|
|
22
23
|
export type { isFluidHandle } from "@fluidframework/runtime-utils";
|
|
23
24
|
export * from "@fluidframework/tree/alpha";
|
|
@@ -28,10 +29,10 @@ import { type SharedTreeOptions } from "@fluidframework/tree/internal";
|
|
|
28
29
|
* A hierarchical data structure for collaboratively editing strongly typed JSON-like trees
|
|
29
30
|
* of objects, arrays, and other data types.
|
|
30
31
|
* @privateRemarks
|
|
31
|
-
* Here we reexport SharedTree, but with the `@
|
|
32
|
+
* Here we reexport SharedTree, but with the `@legacy` types (`ISharedObjectKind`) removed, just keeping the `SharedObjectKind`.
|
|
32
33
|
* Doing this requires creating this new typed export rather than relying on a reexport directly from the tree package.
|
|
33
34
|
* The tree package itself does not do this because it's API needs to be usable from the encapsulated API which requires `ISharedObjectKind`.
|
|
34
|
-
* This package however is not intended for use by users of the encapsulated API, and
|
|
35
|
+
* This package however is not intended for use by users of the encapsulated API, and therefore it can discard that interface.
|
|
35
36
|
* @public
|
|
36
37
|
*/
|
|
37
38
|
export declare const SharedTree: SharedObjectKind<ITree>;
|
|
@@ -66,7 +67,7 @@ export { SharedDirectory, SharedMap } from "@fluidframework/map/internal";
|
|
|
66
67
|
export type { DeserializeCallback, InteriorSequencePlace, IInterval, IntervalStickiness, ISequenceDeltaRange, ISerializedInterval, ISharedSegmentSequenceEvents, ISharedString, SequencePlace, SharedStringSegment, Side, ISharedSegmentSequence, ISequenceIntervalCollection, ISequenceIntervalCollectionEvents, SequenceIntervalIndex, } from "@fluidframework/sequence/internal";
|
|
67
68
|
export type { IntervalType, SequenceDeltaEvent, SequenceEvent, SequenceInterval, SequenceMaintenanceEvent, } from "@fluidframework/sequence/internal";
|
|
68
69
|
export { SharedString } from "@fluidframework/sequence/internal";
|
|
69
|
-
export type { ISharedObject, ISharedObjectEvents, } from "@fluidframework/shared-object-base/internal";
|
|
70
|
+
export type { ISharedObject, ISharedObjectEvents, ISharedObjectKind, } from "@fluidframework/shared-object-base/internal";
|
|
70
71
|
export type { ISequencedDocumentMessage, // Leaked via ISharedObjectEvents
|
|
71
72
|
IBranchOrigin, // Required for ISequencedDocumentMessage
|
|
72
73
|
ITrace, } from "@fluidframework/driver-definitions/internal";
|
package/dist/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;;;;GAKG;AAMH,YAAY,EACX,eAAe,IAAI,mBAAmB,EAAE,0CAA0C;AAClF,uBAAuB,GACvB,MAAM,uCAAuC,CAAC;AAC/C,OAAO,EAAE,WAAW,EAAE,MAAM,uCAAuC,CAAC;AACpE,OAAO,EAAE,eAAe,EAAE,MAAM,kCAAkC,CAAC;AACnE,YAAY,EACX,oBAAoB,EACpB,eAAe,EACf,WAAW,EACX,eAAe,EACf,qBAAqB,EACrB,OAAO,EACP,cAAc,EACd,gBAAgB,EAChB,sBAAsB,EACtB,qBAAqB,EACrB,MAAM,GACN,MAAM,8BAA8B,CAAC;AACtC,YAAY,EAAE,gBAAgB,EAAE,MAAM,oCAAoC,CAAC;AAC3E,YAAY,EACX,UAAU,EACV,cAAc,EACd,WAAW,EACX,MAAM,EACN,qBAAqB,EACrB,WAAW,EACX,UAAU,EACV,YAAY,EACZ,cAAc,EACd,wBAAwB,EACxB,iBAAiB,EACjB,qBAAqB,EACrB,kBAAkB,EAClB,gBAAgB,EAChB,8BAA8B,EAC9B,MAAM,EACN,4BAA4B,EAC5B,WAAW,EAAE,wBAAwB;AACrC,uBAAuB,EAAE,sBAAsB;AAE/C,SAAS,EACT,UAAU,EACV,UAAU,EACV,GAAG,GAEH,MAAM,iCAAiC,CAAC;AACzC,YAAY,
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;;;;GAKG;AAMH,YAAY,EACX,eAAe,IAAI,mBAAmB,EAAE,0CAA0C;AAClF,uBAAuB,GACvB,MAAM,uCAAuC,CAAC;AAC/C,OAAO,EAAE,WAAW,EAAE,MAAM,uCAAuC,CAAC;AACpE,OAAO,EAAE,eAAe,EAAE,MAAM,kCAAkC,CAAC;AACnE,YAAY,EACX,oBAAoB,EACpB,eAAe,EACf,WAAW,EACX,eAAe,EACf,qBAAqB,EACrB,OAAO,EACP,cAAc,EACd,gBAAgB,EAChB,sBAAsB,EACtB,qBAAqB,EACrB,MAAM,GACN,MAAM,8BAA8B,CAAC;AACtC,OAAO,EAAE,WAAW,EAAE,gBAAgB,EAAE,MAAM,uCAAuC,CAAC;AACtF,YAAY,EAAE,gBAAgB,EAAE,MAAM,oCAAoC,CAAC;AAC3E,YAAY,EACX,UAAU,EACV,cAAc,EACd,WAAW,EACX,MAAM,EACN,qBAAqB,EACrB,WAAW,EACX,UAAU,EACV,YAAY,EACZ,cAAc,EACd,wBAAwB,EACxB,iBAAiB,EACjB,qBAAqB,EACrB,kBAAkB,EAClB,gBAAgB,EAChB,8BAA8B,EAC9B,MAAM,EACN,4BAA4B,EAC5B,WAAW,EAAE,wBAAwB;AACrC,uBAAuB,EAAE,sBAAsB;AAE/C,SAAS,EACT,UAAU,EACV,UAAU,EACV,GAAG,GAEH,MAAM,iCAAiC,CAAC;AACzC,YAAY,EACX,cAAc,EACd,aAAa,EACb,qBAAqB,EACrB,QAAQ,EACR,gBAAgB,GAChB,MAAM,0CAA0C,CAAC;AAGlD,OAAO,EAAE,kBAAkB,EAAE,MAAM,qCAAqC,CAAC;AAEzE,YAAY,EAAE,aAAa,EAAE,MAAM,+BAA+B,CAAC;AASnE,cAAc,4BAA4B,CAAC;AAQ3C,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,oCAAoC,CAAC;AAC3E,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,sBAAsB,CAAC;AAClD,OAAO,EAGN,KAAK,iBAAiB,EACtB,MAAM,+BAA+B,CAAC;AAEvC;;;;;;;;;GASG;AACH,eAAO,MAAM,UAAU,EAAE,gBAAgB,CAAC,KAAK,CAAsB,CAAC;AAEtE;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,wBAAgB,oBAAoB,CAAC,OAAO,EAAE,iBAAiB,GAAG,gBAAgB,CAAC,KAAK,CAAC,CAExF;AAQD,YAAY,EACX,UAAU,EACV,gBAAgB,EAChB,sBAAsB,EACtB,gBAAgB,EAChB,sBAAsB,EACtB,UAAU,EACV,gBAAgB,EAChB,aAAa,GACb,MAAM,8BAA8B,CAAC;AAEtC,OAAO,EAAE,eAAe,EAAE,SAAS,EAAE,MAAM,8BAA8B,CAAC;AAE1E,YAAY,EACX,mBAAmB,EACnB,qBAAqB,EACrB,SAAS,EACT,kBAAkB,EAClB,mBAAmB,EACnB,mBAAmB,EACnB,4BAA4B,EAC5B,aAAa,EACb,aAAa,EACb,mBAAmB,EACnB,IAAI,EACJ,sBAAsB,EACtB,2BAA2B,EAC3B,iCAAiC,EACjC,qBAAqB,GACrB,MAAM,mCAAmC,CAAC;AAE3C,YAAY,EACX,YAAY,EACZ,kBAAkB,EAClB,aAAa,EACb,gBAAgB,EAChB,wBAAwB,GACxB,MAAM,mCAAmC,CAAC;AAE3C,OAAO,EAAE,YAAY,EAAE,MAAM,mCAAmC,CAAC;AAEjE,YAAY,EACX,aAAa,EACb,mBAAmB,EACnB,iBAAiB,GACjB,MAAM,6CAA6C,CAAC;AAErD,YAAY,EACX,yBAAyB,EAAE,iCAAiC;AAC5D,aAAa,EAAE,yCAAyC;AACxD,MAAM,GACN,MAAM,6CAA6C,CAAC"}
|
package/dist/index.js
CHANGED
|
@@ -18,14 +18,17 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
|
18
18
|
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
|
|
19
19
|
};
|
|
20
20
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
21
|
-
exports.SharedString = exports.SharedMap = exports.SharedDirectory = exports.configuredSharedTree = exports.SharedTree = exports.onAssertionFailure = exports.ConnectionState = exports.AttachState = void 0;
|
|
21
|
+
exports.SharedString = exports.SharedMap = exports.SharedDirectory = exports.configuredSharedTree = exports.SharedTree = exports.onAssertionFailure = exports.getPresenceAlpha = exports.getPresence = exports.ConnectionState = exports.AttachState = void 0;
|
|
22
22
|
var container_definitions_1 = require("@fluidframework/container-definitions");
|
|
23
23
|
Object.defineProperty(exports, "AttachState", { enumerable: true, get: function () { return container_definitions_1.AttachState; } });
|
|
24
24
|
var container_loader_1 = require("@fluidframework/container-loader");
|
|
25
25
|
Object.defineProperty(exports, "ConnectionState", { enumerable: true, get: function () { return container_loader_1.ConnectionState; } });
|
|
26
|
+
var internal_1 = require("@fluidframework/fluid-static/internal");
|
|
27
|
+
Object.defineProperty(exports, "getPresence", { enumerable: true, get: function () { return internal_1.getPresence; } });
|
|
28
|
+
Object.defineProperty(exports, "getPresenceAlpha", { enumerable: true, get: function () { return internal_1.getPresenceAlpha; } });
|
|
26
29
|
// This is an alpha API, but this package doesn't have an alpha entry point so its imported from "internal".
|
|
27
|
-
var
|
|
28
|
-
Object.defineProperty(exports, "onAssertionFailure", { enumerable: true, get: function () { return
|
|
30
|
+
var internal_2 = require("@fluidframework/core-utils/internal");
|
|
31
|
+
Object.defineProperty(exports, "onAssertionFailure", { enumerable: true, get: function () { return internal_2.onAssertionFailure; } });
|
|
29
32
|
// Let the tree package manage its own API surface.
|
|
30
33
|
// Note: this only surfaces the `@public, @beta and @alpha` API items from the tree package.
|
|
31
34
|
/* eslint-disable-next-line
|
|
@@ -34,18 +37,18 @@ Object.defineProperty(exports, "onAssertionFailure", { enumerable: true, get: fu
|
|
|
34
37
|
import-x/export -- This re-exports all non-conflicting APIs from `@fluidframework/tree`. In cases where * exports conflict with named exports, the named exports take precedence per https://tc39.es/ecma262/multipage/ecmascript-language-scripts-and-modules.html#sec-getexportednames. This does trigger the `import-x/export` lint warning (which is intentionally disabled here). This approach ensures that the non-deprecated versions of the event APIs from `@fluidframework/core-interfaces` (provided as named indirect exports) eclipse the deprecated ones from `@fluidframework/tree`. The preferred versions of the event APIs are those exported via `@fluidframework/core-interfaces`.
|
|
35
38
|
*/
|
|
36
39
|
__exportStar(require("@fluidframework/tree/alpha"), exports);
|
|
37
|
-
const
|
|
40
|
+
const internal_3 = require("@fluidframework/tree/internal");
|
|
38
41
|
/**
|
|
39
42
|
* A hierarchical data structure for collaboratively editing strongly typed JSON-like trees
|
|
40
43
|
* of objects, arrays, and other data types.
|
|
41
44
|
* @privateRemarks
|
|
42
|
-
* Here we reexport SharedTree, but with the `@
|
|
45
|
+
* Here we reexport SharedTree, but with the `@legacy` types (`ISharedObjectKind`) removed, just keeping the `SharedObjectKind`.
|
|
43
46
|
* Doing this requires creating this new typed export rather than relying on a reexport directly from the tree package.
|
|
44
47
|
* The tree package itself does not do this because it's API needs to be usable from the encapsulated API which requires `ISharedObjectKind`.
|
|
45
|
-
* This package however is not intended for use by users of the encapsulated API, and
|
|
48
|
+
* This package however is not intended for use by users of the encapsulated API, and therefore it can discard that interface.
|
|
46
49
|
* @public
|
|
47
50
|
*/
|
|
48
|
-
exports.SharedTree =
|
|
51
|
+
exports.SharedTree = internal_3.SharedTree;
|
|
49
52
|
/**
|
|
50
53
|
* {@link SharedTree} but allowing a non-default configuration.
|
|
51
54
|
* @remarks
|
|
@@ -72,13 +75,13 @@ exports.SharedTree = internal_2.SharedTree;
|
|
|
72
75
|
* @alpha
|
|
73
76
|
*/
|
|
74
77
|
function configuredSharedTree(options) {
|
|
75
|
-
return (0,
|
|
78
|
+
return (0, internal_3.configuredSharedTree)(options);
|
|
76
79
|
}
|
|
77
80
|
exports.configuredSharedTree = configuredSharedTree;
|
|
78
|
-
var
|
|
79
|
-
Object.defineProperty(exports, "SharedDirectory", { enumerable: true, get: function () { return
|
|
80
|
-
Object.defineProperty(exports, "SharedMap", { enumerable: true, get: function () { return
|
|
81
|
-
var
|
|
82
|
-
Object.defineProperty(exports, "SharedString", { enumerable: true, get: function () { return
|
|
81
|
+
var internal_4 = require("@fluidframework/map/internal");
|
|
82
|
+
Object.defineProperty(exports, "SharedDirectory", { enumerable: true, get: function () { return internal_4.SharedDirectory; } });
|
|
83
|
+
Object.defineProperty(exports, "SharedMap", { enumerable: true, get: function () { return internal_4.SharedMap; } });
|
|
84
|
+
var internal_5 = require("@fluidframework/sequence/internal");
|
|
85
|
+
Object.defineProperty(exports, "SharedString", { enumerable: true, get: function () { return internal_5.SharedString; } });
|
|
83
86
|
// #endregion Legacy exports
|
|
84
87
|
//# sourceMappingURL=index.js.map
|
package/dist/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;;;;;;;;;;;;;;;AAiBH,+EAAoE;AAA3D,oHAAA,WAAW,OAAA;AACpB,qEAAmE;AAA1D,mHAAA,eAAe,OAAA;
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;;;;;;;;;;;;;;;AAiBH,+EAAoE;AAA3D,oHAAA,WAAW,OAAA;AACpB,qEAAmE;AAA1D,mHAAA,eAAe,OAAA;AAcxB,kEAAsF;AAA7E,uGAAA,WAAW,OAAA;AAAE,4GAAA,gBAAgB,OAAA;AAqCtC,4GAA4G;AAC5G,gEAAyE;AAAhE,8GAAA,kBAAkB,OAAA;AAI3B,mDAAmD;AACnD,4FAA4F;AAC5F;;;;MAIG;AACH,6DAA2C;AAU3C,4DAIuC;AAEvC;;;;;;;;;GASG;AACU,QAAA,UAAU,GAA4B,qBAAkB,CAAC;AAEtE;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,SAAgB,oBAAoB,CAAC,OAA0B;IAC9D,OAAO,IAAA,+BAA4B,EAAC,OAAO,CAAC,CAAC;AAC9C,CAAC;AAFD,oDAEC;AAmBD,yDAA0E;AAAjE,2GAAA,eAAe,OAAA;AAAE,qGAAA,SAAS,OAAA;AA4BnC,8DAAiE;AAAxD,wGAAA,YAAY,OAAA;AAcrB,4BAA4B","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\n/**\n * Bundles a collection of Fluid Framework client libraries for easy use when paired with a corresponding service client\n * package (e.g. `@fluidframework/azure-client`, `@fluidframework/tinylicious-client`, or `@fluidframework/odsp-client (BETA)`).\n *\n * @packageDocumentation\n */\n\n// ===============================================================\n// #region Public, Beta and Alpha (non-legacy) exports\n// #region Basic re-exports\n\nexport type {\n\tConnectionState as ConnectionStateType, // TODO: deduplicate ConnectionState types\n\tICriticalContainerError,\n} from \"@fluidframework/container-definitions\";\nexport { AttachState } from \"@fluidframework/container-definitions\";\nexport { ConnectionState } from \"@fluidframework/container-loader\";\nexport type {\n\tContainerAttachProps,\n\tContainerSchema,\n\tIConnection,\n\tIFluidContainer,\n\tIFluidContainerEvents,\n\tIMember,\n\tInitialObjects,\n\tIServiceAudience,\n\tIServiceAudienceEvents,\n\tMemberChangedListener,\n\tMyself,\n} from \"@fluidframework/fluid-static\";\nexport { getPresence, getPresenceAlpha } from \"@fluidframework/fluid-static/internal\";\nexport type { SharedObjectKind } from \"@fluidframework/shared-object-base\";\nexport type {\n\tIErrorBase,\n\tIEventProvider,\n\tIDisposable,\n\tIEvent,\n\tIEventThisPlaceHolder,\n\tIErrorEvent,\n\tErasedType,\n\tIFluidHandle,\n\tIFluidLoadable,\n\tITelemetryBaseProperties,\n\tIEventTransformer,\n\tIProvideFluidLoadable,\n\tIFluidHandleErased,\n\tTransformedEvent,\n\tTelemetryBaseEventPropertyType,\n\tTagged,\n\tReplaceIEventThisPlaceHolder,\n\tFluidObject, // Linked in doc comment\n\tFluidObjectProviderKeys, // Used by FluidObject\n\t/* eslint-disable import-x/export -- The event APIs are known to conflict, and this is intended as the exports via `@fluidframework/core-interfaces` are preferred over the deprecated ones from `@fluidframework/tree`. */\n\tListeners,\n\tIsListener,\n\tListenable,\n\tOff,\n\t/* eslint-enable import-x/export */\n} from \"@fluidframework/core-interfaces\";\nexport type {\n\tErasedBaseType,\n\tFluidIterable,\n\tFluidIterableIterator,\n\tFluidMap,\n\tFluidReadonlyMap,\n} from \"@fluidframework/core-interfaces/internal\";\n\n// This is an alpha API, but this package doesn't have an alpha entry point so its imported from \"internal\".\nexport { onAssertionFailure } from \"@fluidframework/core-utils/internal\";\n\nexport type { isFluidHandle } from \"@fluidframework/runtime-utils\";\n\n// Let the tree package manage its own API surface.\n// Note: this only surfaces the `@public, @beta and @alpha` API items from the tree package.\n/* eslint-disable-next-line\n\tno-restricted-syntax,\n\timport-x/no-internal-modules,\n\timport-x/export -- This re-exports all non-conflicting APIs from `@fluidframework/tree`. In cases where * exports conflict with named exports, the named exports take precedence per https://tc39.es/ecma262/multipage/ecmascript-language-scripts-and-modules.html#sec-getexportednames. This does trigger the `import-x/export` lint warning (which is intentionally disabled here). This approach ensures that the non-deprecated versions of the event APIs from `@fluidframework/core-interfaces` (provided as named indirect exports) eclipse the deprecated ones from `@fluidframework/tree`. The preferred versions of the event APIs are those exported via `@fluidframework/core-interfaces`.\n\t*/\nexport * from \"@fluidframework/tree/alpha\";\n\n// End of basic public+beta+alpha exports - nothing above this line should\n// depend on an /internal path.\n// #endregion Basic re-exports\n// ---------------------------------------------------------------\n// #region Custom re-exports\n\nimport type { SharedObjectKind } from \"@fluidframework/shared-object-base\";\nimport type { ITree } from \"@fluidframework/tree\";\nimport {\n\tSharedTree as OriginalSharedTree,\n\tconfiguredSharedTree as originalConfiguredSharedTree,\n\ttype SharedTreeOptions,\n} from \"@fluidframework/tree/internal\";\n\n/**\n * A hierarchical data structure for collaboratively editing strongly typed JSON-like trees\n * of objects, arrays, and other data types.\n * @privateRemarks\n * Here we reexport SharedTree, but with the `@legacy` types (`ISharedObjectKind`) removed, just keeping the `SharedObjectKind`.\n * Doing this requires creating this new typed export rather than relying on a reexport directly from the tree package.\n * The tree package itself does not do this because it's API needs to be usable from the encapsulated API which requires `ISharedObjectKind`.\n * This package however is not intended for use by users of the encapsulated API, and therefore it can discard that interface.\n * @public\n */\nexport const SharedTree: SharedObjectKind<ITree> = OriginalSharedTree;\n\n/**\n * {@link SharedTree} but allowing a non-default configuration.\n * @remarks\n * This is useful for debugging and testing.\n * For example, it can be used to opt into extra validation or see if opting out of some optimizations fixes an issue.\n *\n * With great care, and knowledge of the support and stability of the options exposed here,\n * this can also be used to opt into some features early or for performance tuning.\n *\n * @example\n * ```typescript\n * import {\n * \tTreeCompressionStrategy,\n * \tconfiguredSharedTree,\n * \tFormatValidatorBasic,\n * \tForestTypeReference,\n * } from \"fluid-framework/alpha\";\n * const SharedTree = configuredSharedTree({\n * \tforest: ForestTypeReference,\n * \tjsonValidator: FormatValidatorBasic,\n * \ttreeEncodeType: TreeCompressionStrategy.Uncompressed,\n * });\n * ```\n * @alpha\n */\nexport function configuredSharedTree(options: SharedTreeOptions): SharedObjectKind<ITree> {\n\treturn originalConfiguredSharedTree(options);\n}\n\n// #endregion Custom re-exports\n// #endregion\n\n// ===============================================================\n// #region Legacy exports\n\nexport type {\n\tIDirectory,\n\tIDirectoryEvents,\n\tIDirectoryValueChanged,\n\tISharedDirectory,\n\tISharedDirectoryEvents,\n\tISharedMap,\n\tISharedMapEvents,\n\tIValueChanged,\n} from \"@fluidframework/map/internal\";\n\nexport { SharedDirectory, SharedMap } from \"@fluidframework/map/internal\";\n\nexport type {\n\tDeserializeCallback,\n\tInteriorSequencePlace,\n\tIInterval,\n\tIntervalStickiness,\n\tISequenceDeltaRange,\n\tISerializedInterval,\n\tISharedSegmentSequenceEvents,\n\tISharedString,\n\tSequencePlace,\n\tSharedStringSegment,\n\tSide,\n\tISharedSegmentSequence,\n\tISequenceIntervalCollection,\n\tISequenceIntervalCollectionEvents,\n\tSequenceIntervalIndex,\n} from \"@fluidframework/sequence/internal\";\n\nexport type {\n\tIntervalType,\n\tSequenceDeltaEvent,\n\tSequenceEvent,\n\tSequenceInterval,\n\tSequenceMaintenanceEvent,\n} from \"@fluidframework/sequence/internal\";\n\nexport { SharedString } from \"@fluidframework/sequence/internal\";\n\nexport type {\n\tISharedObject,\n\tISharedObjectEvents,\n\tISharedObjectKind,\n} from \"@fluidframework/shared-object-base/internal\";\n\nexport type {\n\tISequencedDocumentMessage, // Leaked via ISharedObjectEvents\n\tIBranchOrigin, // Required for ISequencedDocumentMessage\n\tITrace, // Required for ISequencedDocumentMessage\n} from \"@fluidframework/driver-definitions/internal\";\n\n// #endregion Legacy exports\n"]}
|
package/dist/legacy.d.ts
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
|
|
6
6
|
/*
|
|
7
7
|
* THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
|
|
8
|
-
* Generated by "flub generate entrypoints" in @fluid-tools/build-cli.
|
|
8
|
+
* Generated by "flub generate entrypoints --resolutionConditions require --outFileLegacyBeta legacy --outDir ./dist" in @fluid-tools/build-cli.
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -131,6 +131,7 @@ export {
|
|
|
131
131
|
ValidateRecursiveSchemaTemplate,
|
|
132
132
|
ViewableTree,
|
|
133
133
|
WithType,
|
|
134
|
+
getPresence,
|
|
134
135
|
isFluidHandle,
|
|
135
136
|
rollback,
|
|
136
137
|
typeSchemaSymbol,
|
|
@@ -161,12 +162,17 @@ export {
|
|
|
161
162
|
ErasedBaseType,
|
|
162
163
|
ExtensibleUnionNode,
|
|
163
164
|
FixRecursiveArraySchema,
|
|
165
|
+
FluidIterable,
|
|
166
|
+
FluidIterableIterator,
|
|
167
|
+
FluidMap,
|
|
168
|
+
FluidReadonlyMap,
|
|
164
169
|
FluidSerializableAsTree,
|
|
165
170
|
ForestOptions,
|
|
166
171
|
ForestType,
|
|
167
172
|
ForestTypeExpensiveDebug,
|
|
168
173
|
ForestTypeOptimized,
|
|
169
174
|
ForestTypeReference,
|
|
175
|
+
IdentifierIndex,
|
|
170
176
|
JsonCompatible,
|
|
171
177
|
JsonCompatibleObject,
|
|
172
178
|
KeyEncodingOptions,
|
|
@@ -186,6 +192,9 @@ export {
|
|
|
186
192
|
TreeBranch,
|
|
187
193
|
TreeChangeEventsBeta,
|
|
188
194
|
TreeEncodingOptions,
|
|
195
|
+
TreeIndex,
|
|
196
|
+
TreeIndexKey,
|
|
197
|
+
TreeIndexNodes,
|
|
189
198
|
TreeRecordNode,
|
|
190
199
|
TreeRecordNodeUnsafe,
|
|
191
200
|
TreeViewBeta,
|
|
@@ -196,7 +205,9 @@ export {
|
|
|
196
205
|
adaptEnum,
|
|
197
206
|
asBeta,
|
|
198
207
|
configuredSharedTreeBeta,
|
|
208
|
+
createIdentifierIndex,
|
|
199
209
|
createIndependentTreeBeta,
|
|
210
|
+
createTreeIndex,
|
|
200
211
|
enumFromStrings,
|
|
201
212
|
singletonSchema,
|
|
202
213
|
snapshotSchemaCompatibility,
|
|
@@ -217,6 +228,7 @@ export {
|
|
|
217
228
|
ISharedMapEvents,
|
|
218
229
|
ISharedObject,
|
|
219
230
|
ISharedObjectEvents,
|
|
231
|
+
ISharedObjectKind,
|
|
220
232
|
ISharedSegmentSequence,
|
|
221
233
|
ISharedSegmentSequenceEvents,
|
|
222
234
|
ISharedString,
|
package/dist/public.d.ts
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
|
|
6
6
|
/*
|
|
7
7
|
* THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
|
|
8
|
-
* Generated by "flub generate entrypoints" in @fluid-tools/build-cli.
|
|
8
|
+
* Generated by "flub generate entrypoints --resolutionConditions require --outFileLegacyBeta legacy --outDir ./dist" in @fluid-tools/build-cli.
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -131,6 +131,7 @@ export {
|
|
|
131
131
|
ValidateRecursiveSchemaTemplate,
|
|
132
132
|
ViewableTree,
|
|
133
133
|
WithType,
|
|
134
|
+
getPresence,
|
|
134
135
|
isFluidHandle,
|
|
135
136
|
rollback,
|
|
136
137
|
typeSchemaSymbol
|
package/eslint.config.mts
CHANGED
package/legacy.d.ts
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
|
|
6
6
|
/*
|
|
7
7
|
* THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
|
|
8
|
-
* Generated by "flub generate entrypoints" in @fluid-tools/build-cli.
|
|
8
|
+
* Generated by "flub generate entrypoints --outFileLegacyBeta legacy --outDir ./lib --node10TypeCompat" in @fluid-tools/build-cli.
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
export * from "./lib/legacy.js";
|
package/lib/alpha.d.ts
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
|
|
6
6
|
/*
|
|
7
7
|
* THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
|
|
8
|
-
* Generated by "flub generate entrypoints" in @fluid-tools/build-cli.
|
|
8
|
+
* Generated by "flub generate entrypoints --outFileLegacyBeta legacy --outDir ./lib --node10TypeCompat" in @fluid-tools/build-cli.
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -131,6 +131,7 @@ export {
|
|
|
131
131
|
ValidateRecursiveSchemaTemplate,
|
|
132
132
|
ViewableTree,
|
|
133
133
|
WithType,
|
|
134
|
+
getPresence,
|
|
134
135
|
isFluidHandle,
|
|
135
136
|
rollback,
|
|
136
137
|
typeSchemaSymbol,
|
|
@@ -154,12 +155,17 @@ export {
|
|
|
154
155
|
ErasedBaseType,
|
|
155
156
|
ExtensibleUnionNode,
|
|
156
157
|
FixRecursiveArraySchema,
|
|
158
|
+
FluidIterable,
|
|
159
|
+
FluidIterableIterator,
|
|
160
|
+
FluidMap,
|
|
161
|
+
FluidReadonlyMap,
|
|
157
162
|
FluidSerializableAsTree,
|
|
158
163
|
ForestOptions,
|
|
159
164
|
ForestType,
|
|
160
165
|
ForestTypeExpensiveDebug,
|
|
161
166
|
ForestTypeOptimized,
|
|
162
167
|
ForestTypeReference,
|
|
168
|
+
IdentifierIndex,
|
|
163
169
|
JsonCompatible,
|
|
164
170
|
JsonCompatibleObject,
|
|
165
171
|
KeyEncodingOptions,
|
|
@@ -179,6 +185,9 @@ export {
|
|
|
179
185
|
TreeBranch,
|
|
180
186
|
TreeChangeEventsBeta,
|
|
181
187
|
TreeEncodingOptions,
|
|
188
|
+
TreeIndex,
|
|
189
|
+
TreeIndexKey,
|
|
190
|
+
TreeIndexNodes,
|
|
182
191
|
TreeRecordNode,
|
|
183
192
|
TreeRecordNodeUnsafe,
|
|
184
193
|
TreeViewBeta,
|
|
@@ -189,7 +198,9 @@ export {
|
|
|
189
198
|
adaptEnum,
|
|
190
199
|
asBeta,
|
|
191
200
|
configuredSharedTreeBeta,
|
|
201
|
+
createIdentifierIndex,
|
|
192
202
|
createIndependentTreeBeta,
|
|
203
|
+
createTreeIndex,
|
|
193
204
|
enumFromStrings,
|
|
194
205
|
singletonSchema,
|
|
195
206
|
snapshotSchemaCompatibility,
|
|
@@ -198,11 +209,17 @@ export {
|
|
|
198
209
|
// #region @alpha APIs
|
|
199
210
|
AllowedTypesFullUnsafe,
|
|
200
211
|
ArrayNodeCustomizableSchema,
|
|
212
|
+
ArrayNodeCustomizableSchemaAlpha,
|
|
201
213
|
ArrayNodeCustomizableSchemaUnsafe,
|
|
214
|
+
ArrayNodeDeltaOp,
|
|
215
|
+
ArrayNodeInsertOp,
|
|
202
216
|
ArrayNodePojoEmulationSchema,
|
|
217
|
+
ArrayNodeRemoveOp,
|
|
218
|
+
ArrayNodeRetainOp,
|
|
203
219
|
ArrayNodeSchema,
|
|
220
|
+
ArrayNodeTreeChangedDeltaOp,
|
|
221
|
+
ArrayNodeTreeChangedRetainOp,
|
|
204
222
|
ArrayPlaceAnchor,
|
|
205
|
-
BranchableTree,
|
|
206
223
|
ChangeMetadata,
|
|
207
224
|
CodecName,
|
|
208
225
|
CodecWriteOptions,
|
|
@@ -227,7 +244,6 @@ export {
|
|
|
227
244
|
HandleConverter,
|
|
228
245
|
ICodecOptions,
|
|
229
246
|
ITreeAlpha,
|
|
230
|
-
IdentifierIndex,
|
|
231
247
|
IncrementalEncodingPolicy,
|
|
232
248
|
IndependentViewOptions,
|
|
233
249
|
Insertable,
|
|
@@ -260,6 +276,10 @@ export {
|
|
|
260
276
|
MapNodePojoEmulationSchema,
|
|
261
277
|
MapNodeSchema,
|
|
262
278
|
NoChangeConstraint,
|
|
279
|
+
NodeChangedDataAlpha,
|
|
280
|
+
NodeChangedDataDelta,
|
|
281
|
+
NodeChangedDataProperties,
|
|
282
|
+
NodeChangedDataTreeDelta,
|
|
263
283
|
NodeProvider,
|
|
264
284
|
NodeSchemaOptionsAlpha,
|
|
265
285
|
ObjectNodeSchema,
|
|
@@ -300,15 +320,14 @@ export {
|
|
|
300
320
|
TransactionResultFailed,
|
|
301
321
|
TransactionResultSuccess,
|
|
302
322
|
TreeAlpha,
|
|
323
|
+
TreeArrayNodeAlpha,
|
|
303
324
|
TreeBranchAlpha,
|
|
304
325
|
TreeBranchEvents,
|
|
305
|
-
|
|
326
|
+
TreeChangeEventsAlpha,
|
|
306
327
|
TreeCompressionStrategy,
|
|
307
328
|
TreeContextAlpha,
|
|
308
329
|
TreeIdentifierUtils,
|
|
309
|
-
|
|
310
|
-
TreeIndexKey,
|
|
311
|
-
TreeIndexNodes,
|
|
330
|
+
TreeMapNodeAlpha,
|
|
312
331
|
TreeParsingOptions,
|
|
313
332
|
TreeSchema,
|
|
314
333
|
TreeSchemaEncodingOptions,
|
|
@@ -331,9 +350,7 @@ export {
|
|
|
331
350
|
configuredSharedTreeAlpha,
|
|
332
351
|
contentSchemaSymbol,
|
|
333
352
|
createArrayInsertionAnchor,
|
|
334
|
-
createIdentifierIndex,
|
|
335
353
|
createIndependentTreeAlpha,
|
|
336
|
-
createTreeIndex,
|
|
337
354
|
decodeSchemaCompatibilitySnapshot,
|
|
338
355
|
encodeSchemaCompatibilitySnapshot,
|
|
339
356
|
eraseSchemaDetails,
|
|
@@ -342,8 +359,8 @@ export {
|
|
|
342
359
|
exportCompatibilitySchemaSnapshot,
|
|
343
360
|
extractPersistedSchema,
|
|
344
361
|
generateSchemaFromSimpleSchema,
|
|
345
|
-
getBranch,
|
|
346
362
|
getJsonSchema,
|
|
363
|
+
getPresenceAlpha,
|
|
347
364
|
getSimpleSchema,
|
|
348
365
|
importCompatibilitySchemaSnapshot,
|
|
349
366
|
incrementalEncodingPolicyForAllowedTypes,
|
package/lib/beta.d.ts
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
|
|
6
6
|
/*
|
|
7
7
|
* THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
|
|
8
|
-
* Generated by "flub generate entrypoints" in @fluid-tools/build-cli.
|
|
8
|
+
* Generated by "flub generate entrypoints --outFileLegacyBeta legacy --outDir ./lib --node10TypeCompat" in @fluid-tools/build-cli.
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -131,6 +131,7 @@ export {
|
|
|
131
131
|
ValidateRecursiveSchemaTemplate,
|
|
132
132
|
ViewableTree,
|
|
133
133
|
WithType,
|
|
134
|
+
getPresence,
|
|
134
135
|
isFluidHandle,
|
|
135
136
|
rollback,
|
|
136
137
|
typeSchemaSymbol,
|
|
@@ -154,12 +155,17 @@ export {
|
|
|
154
155
|
ErasedBaseType,
|
|
155
156
|
ExtensibleUnionNode,
|
|
156
157
|
FixRecursiveArraySchema,
|
|
158
|
+
FluidIterable,
|
|
159
|
+
FluidIterableIterator,
|
|
160
|
+
FluidMap,
|
|
161
|
+
FluidReadonlyMap,
|
|
157
162
|
FluidSerializableAsTree,
|
|
158
163
|
ForestOptions,
|
|
159
164
|
ForestType,
|
|
160
165
|
ForestTypeExpensiveDebug,
|
|
161
166
|
ForestTypeOptimized,
|
|
162
167
|
ForestTypeReference,
|
|
168
|
+
IdentifierIndex,
|
|
163
169
|
JsonCompatible,
|
|
164
170
|
JsonCompatibleObject,
|
|
165
171
|
KeyEncodingOptions,
|
|
@@ -179,6 +185,9 @@ export {
|
|
|
179
185
|
TreeBranch,
|
|
180
186
|
TreeChangeEventsBeta,
|
|
181
187
|
TreeEncodingOptions,
|
|
188
|
+
TreeIndex,
|
|
189
|
+
TreeIndexKey,
|
|
190
|
+
TreeIndexNodes,
|
|
182
191
|
TreeRecordNode,
|
|
183
192
|
TreeRecordNodeUnsafe,
|
|
184
193
|
TreeViewBeta,
|
|
@@ -189,7 +198,9 @@ export {
|
|
|
189
198
|
adaptEnum,
|
|
190
199
|
asBeta,
|
|
191
200
|
configuredSharedTreeBeta,
|
|
201
|
+
createIdentifierIndex,
|
|
192
202
|
createIndependentTreeBeta,
|
|
203
|
+
createTreeIndex,
|
|
193
204
|
enumFromStrings,
|
|
194
205
|
singletonSchema,
|
|
195
206
|
snapshotSchemaCompatibility
|
package/lib/index.d.ts
CHANGED
|
@@ -13,11 +13,12 @@ ICriticalContainerError, } from "@fluidframework/container-definitions";
|
|
|
13
13
|
export { AttachState } from "@fluidframework/container-definitions";
|
|
14
14
|
export { ConnectionState } from "@fluidframework/container-loader";
|
|
15
15
|
export type { ContainerAttachProps, ContainerSchema, IConnection, IFluidContainer, IFluidContainerEvents, IMember, InitialObjects, IServiceAudience, IServiceAudienceEvents, MemberChangedListener, Myself, } from "@fluidframework/fluid-static";
|
|
16
|
+
export { getPresence, getPresenceAlpha } from "@fluidframework/fluid-static/internal";
|
|
16
17
|
export type { SharedObjectKind } from "@fluidframework/shared-object-base";
|
|
17
18
|
export type { IErrorBase, IEventProvider, IDisposable, IEvent, IEventThisPlaceHolder, IErrorEvent, ErasedType, IFluidHandle, IFluidLoadable, ITelemetryBaseProperties, IEventTransformer, IProvideFluidLoadable, IFluidHandleErased, TransformedEvent, TelemetryBaseEventPropertyType, Tagged, ReplaceIEventThisPlaceHolder, FluidObject, // Linked in doc comment
|
|
18
19
|
FluidObjectProviderKeys, // Used by FluidObject
|
|
19
20
|
Listeners, IsListener, Listenable, Off, } from "@fluidframework/core-interfaces";
|
|
20
|
-
export type { ErasedBaseType } from "@fluidframework/core-interfaces/internal";
|
|
21
|
+
export type { ErasedBaseType, FluidIterable, FluidIterableIterator, FluidMap, FluidReadonlyMap, } from "@fluidframework/core-interfaces/internal";
|
|
21
22
|
export { onAssertionFailure } from "@fluidframework/core-utils/internal";
|
|
22
23
|
export type { isFluidHandle } from "@fluidframework/runtime-utils";
|
|
23
24
|
export * from "@fluidframework/tree/alpha";
|
|
@@ -28,10 +29,10 @@ import { type SharedTreeOptions } from "@fluidframework/tree/internal";
|
|
|
28
29
|
* A hierarchical data structure for collaboratively editing strongly typed JSON-like trees
|
|
29
30
|
* of objects, arrays, and other data types.
|
|
30
31
|
* @privateRemarks
|
|
31
|
-
* Here we reexport SharedTree, but with the `@
|
|
32
|
+
* Here we reexport SharedTree, but with the `@legacy` types (`ISharedObjectKind`) removed, just keeping the `SharedObjectKind`.
|
|
32
33
|
* Doing this requires creating this new typed export rather than relying on a reexport directly from the tree package.
|
|
33
34
|
* The tree package itself does not do this because it's API needs to be usable from the encapsulated API which requires `ISharedObjectKind`.
|
|
34
|
-
* This package however is not intended for use by users of the encapsulated API, and
|
|
35
|
+
* This package however is not intended for use by users of the encapsulated API, and therefore it can discard that interface.
|
|
35
36
|
* @public
|
|
36
37
|
*/
|
|
37
38
|
export declare const SharedTree: SharedObjectKind<ITree>;
|
|
@@ -66,7 +67,7 @@ export { SharedDirectory, SharedMap } from "@fluidframework/map/internal";
|
|
|
66
67
|
export type { DeserializeCallback, InteriorSequencePlace, IInterval, IntervalStickiness, ISequenceDeltaRange, ISerializedInterval, ISharedSegmentSequenceEvents, ISharedString, SequencePlace, SharedStringSegment, Side, ISharedSegmentSequence, ISequenceIntervalCollection, ISequenceIntervalCollectionEvents, SequenceIntervalIndex, } from "@fluidframework/sequence/internal";
|
|
67
68
|
export type { IntervalType, SequenceDeltaEvent, SequenceEvent, SequenceInterval, SequenceMaintenanceEvent, } from "@fluidframework/sequence/internal";
|
|
68
69
|
export { SharedString } from "@fluidframework/sequence/internal";
|
|
69
|
-
export type { ISharedObject, ISharedObjectEvents, } from "@fluidframework/shared-object-base/internal";
|
|
70
|
+
export type { ISharedObject, ISharedObjectEvents, ISharedObjectKind, } from "@fluidframework/shared-object-base/internal";
|
|
70
71
|
export type { ISequencedDocumentMessage, // Leaked via ISharedObjectEvents
|
|
71
72
|
IBranchOrigin, // Required for ISequencedDocumentMessage
|
|
72
73
|
ITrace, } from "@fluidframework/driver-definitions/internal";
|
package/lib/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;;;;GAKG;AAMH,YAAY,EACX,eAAe,IAAI,mBAAmB,EAAE,0CAA0C;AAClF,uBAAuB,GACvB,MAAM,uCAAuC,CAAC;AAC/C,OAAO,EAAE,WAAW,EAAE,MAAM,uCAAuC,CAAC;AACpE,OAAO,EAAE,eAAe,EAAE,MAAM,kCAAkC,CAAC;AACnE,YAAY,EACX,oBAAoB,EACpB,eAAe,EACf,WAAW,EACX,eAAe,EACf,qBAAqB,EACrB,OAAO,EACP,cAAc,EACd,gBAAgB,EAChB,sBAAsB,EACtB,qBAAqB,EACrB,MAAM,GACN,MAAM,8BAA8B,CAAC;AACtC,YAAY,EAAE,gBAAgB,EAAE,MAAM,oCAAoC,CAAC;AAC3E,YAAY,EACX,UAAU,EACV,cAAc,EACd,WAAW,EACX,MAAM,EACN,qBAAqB,EACrB,WAAW,EACX,UAAU,EACV,YAAY,EACZ,cAAc,EACd,wBAAwB,EACxB,iBAAiB,EACjB,qBAAqB,EACrB,kBAAkB,EAClB,gBAAgB,EAChB,8BAA8B,EAC9B,MAAM,EACN,4BAA4B,EAC5B,WAAW,EAAE,wBAAwB;AACrC,uBAAuB,EAAE,sBAAsB;AAE/C,SAAS,EACT,UAAU,EACV,UAAU,EACV,GAAG,GAEH,MAAM,iCAAiC,CAAC;AACzC,YAAY,
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;;;;GAKG;AAMH,YAAY,EACX,eAAe,IAAI,mBAAmB,EAAE,0CAA0C;AAClF,uBAAuB,GACvB,MAAM,uCAAuC,CAAC;AAC/C,OAAO,EAAE,WAAW,EAAE,MAAM,uCAAuC,CAAC;AACpE,OAAO,EAAE,eAAe,EAAE,MAAM,kCAAkC,CAAC;AACnE,YAAY,EACX,oBAAoB,EACpB,eAAe,EACf,WAAW,EACX,eAAe,EACf,qBAAqB,EACrB,OAAO,EACP,cAAc,EACd,gBAAgB,EAChB,sBAAsB,EACtB,qBAAqB,EACrB,MAAM,GACN,MAAM,8BAA8B,CAAC;AACtC,OAAO,EAAE,WAAW,EAAE,gBAAgB,EAAE,MAAM,uCAAuC,CAAC;AACtF,YAAY,EAAE,gBAAgB,EAAE,MAAM,oCAAoC,CAAC;AAC3E,YAAY,EACX,UAAU,EACV,cAAc,EACd,WAAW,EACX,MAAM,EACN,qBAAqB,EACrB,WAAW,EACX,UAAU,EACV,YAAY,EACZ,cAAc,EACd,wBAAwB,EACxB,iBAAiB,EACjB,qBAAqB,EACrB,kBAAkB,EAClB,gBAAgB,EAChB,8BAA8B,EAC9B,MAAM,EACN,4BAA4B,EAC5B,WAAW,EAAE,wBAAwB;AACrC,uBAAuB,EAAE,sBAAsB;AAE/C,SAAS,EACT,UAAU,EACV,UAAU,EACV,GAAG,GAEH,MAAM,iCAAiC,CAAC;AACzC,YAAY,EACX,cAAc,EACd,aAAa,EACb,qBAAqB,EACrB,QAAQ,EACR,gBAAgB,GAChB,MAAM,0CAA0C,CAAC;AAGlD,OAAO,EAAE,kBAAkB,EAAE,MAAM,qCAAqC,CAAC;AAEzE,YAAY,EAAE,aAAa,EAAE,MAAM,+BAA+B,CAAC;AASnE,cAAc,4BAA4B,CAAC;AAQ3C,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,oCAAoC,CAAC;AAC3E,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,sBAAsB,CAAC;AAClD,OAAO,EAGN,KAAK,iBAAiB,EACtB,MAAM,+BAA+B,CAAC;AAEvC;;;;;;;;;GASG;AACH,eAAO,MAAM,UAAU,EAAE,gBAAgB,CAAC,KAAK,CAAsB,CAAC;AAEtE;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,wBAAgB,oBAAoB,CAAC,OAAO,EAAE,iBAAiB,GAAG,gBAAgB,CAAC,KAAK,CAAC,CAExF;AAQD,YAAY,EACX,UAAU,EACV,gBAAgB,EAChB,sBAAsB,EACtB,gBAAgB,EAChB,sBAAsB,EACtB,UAAU,EACV,gBAAgB,EAChB,aAAa,GACb,MAAM,8BAA8B,CAAC;AAEtC,OAAO,EAAE,eAAe,EAAE,SAAS,EAAE,MAAM,8BAA8B,CAAC;AAE1E,YAAY,EACX,mBAAmB,EACnB,qBAAqB,EACrB,SAAS,EACT,kBAAkB,EAClB,mBAAmB,EACnB,mBAAmB,EACnB,4BAA4B,EAC5B,aAAa,EACb,aAAa,EACb,mBAAmB,EACnB,IAAI,EACJ,sBAAsB,EACtB,2BAA2B,EAC3B,iCAAiC,EACjC,qBAAqB,GACrB,MAAM,mCAAmC,CAAC;AAE3C,YAAY,EACX,YAAY,EACZ,kBAAkB,EAClB,aAAa,EACb,gBAAgB,EAChB,wBAAwB,GACxB,MAAM,mCAAmC,CAAC;AAE3C,OAAO,EAAE,YAAY,EAAE,MAAM,mCAAmC,CAAC;AAEjE,YAAY,EACX,aAAa,EACb,mBAAmB,EACnB,iBAAiB,GACjB,MAAM,6CAA6C,CAAC;AAErD,YAAY,EACX,yBAAyB,EAAE,iCAAiC;AAC5D,aAAa,EAAE,yCAAyC;AACxD,MAAM,GACN,MAAM,6CAA6C,CAAC"}
|
package/lib/index.js
CHANGED
|
@@ -4,6 +4,7 @@
|
|
|
4
4
|
*/
|
|
5
5
|
export { AttachState } from "@fluidframework/container-definitions";
|
|
6
6
|
export { ConnectionState } from "@fluidframework/container-loader";
|
|
7
|
+
export { getPresence, getPresenceAlpha } from "@fluidframework/fluid-static/internal";
|
|
7
8
|
// This is an alpha API, but this package doesn't have an alpha entry point so its imported from "internal".
|
|
8
9
|
export { onAssertionFailure } from "@fluidframework/core-utils/internal";
|
|
9
10
|
// Let the tree package manage its own API surface.
|
|
@@ -19,10 +20,10 @@ import { SharedTree as OriginalSharedTree, configuredSharedTree as originalConfi
|
|
|
19
20
|
* A hierarchical data structure for collaboratively editing strongly typed JSON-like trees
|
|
20
21
|
* of objects, arrays, and other data types.
|
|
21
22
|
* @privateRemarks
|
|
22
|
-
* Here we reexport SharedTree, but with the `@
|
|
23
|
+
* Here we reexport SharedTree, but with the `@legacy` types (`ISharedObjectKind`) removed, just keeping the `SharedObjectKind`.
|
|
23
24
|
* Doing this requires creating this new typed export rather than relying on a reexport directly from the tree package.
|
|
24
25
|
* The tree package itself does not do this because it's API needs to be usable from the encapsulated API which requires `ISharedObjectKind`.
|
|
25
|
-
* This package however is not intended for use by users of the encapsulated API, and
|
|
26
|
+
* This package however is not intended for use by users of the encapsulated API, and therefore it can discard that interface.
|
|
26
27
|
* @public
|
|
27
28
|
*/
|
|
28
29
|
export const SharedTree = OriginalSharedTree;
|
package/lib/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAiBH,OAAO,EAAE,WAAW,EAAE,MAAM,uCAAuC,CAAC;AACpE,OAAO,EAAE,eAAe,EAAE,MAAM,kCAAkC,CAAC;
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAiBH,OAAO,EAAE,WAAW,EAAE,MAAM,uCAAuC,CAAC;AACpE,OAAO,EAAE,eAAe,EAAE,MAAM,kCAAkC,CAAC;AAcnE,OAAO,EAAE,WAAW,EAAE,gBAAgB,EAAE,MAAM,uCAAuC,CAAC;AAqCtF,4GAA4G;AAC5G,OAAO,EAAE,kBAAkB,EAAE,MAAM,qCAAqC,CAAC;AAIzE,mDAAmD;AACnD,4FAA4F;AAC5F;;;;MAIG;AACH,cAAc,4BAA4B,CAAC;AAU3C,OAAO,EACN,UAAU,IAAI,kBAAkB,EAChC,oBAAoB,IAAI,4BAA4B,GAEpD,MAAM,+BAA+B,CAAC;AAEvC;;;;;;;;;GASG;AACH,MAAM,CAAC,MAAM,UAAU,GAA4B,kBAAkB,CAAC;AAEtE;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,MAAM,UAAU,oBAAoB,CAAC,OAA0B;IAC9D,OAAO,4BAA4B,CAAC,OAAO,CAAC,CAAC;AAC9C,CAAC;AAmBD,OAAO,EAAE,eAAe,EAAE,SAAS,EAAE,MAAM,8BAA8B,CAAC;AA4B1E,OAAO,EAAE,YAAY,EAAE,MAAM,mCAAmC,CAAC;AAcjE,4BAA4B","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\n/**\n * Bundles a collection of Fluid Framework client libraries for easy use when paired with a corresponding service client\n * package (e.g. `@fluidframework/azure-client`, `@fluidframework/tinylicious-client`, or `@fluidframework/odsp-client (BETA)`).\n *\n * @packageDocumentation\n */\n\n// ===============================================================\n// #region Public, Beta and Alpha (non-legacy) exports\n// #region Basic re-exports\n\nexport type {\n\tConnectionState as ConnectionStateType, // TODO: deduplicate ConnectionState types\n\tICriticalContainerError,\n} from \"@fluidframework/container-definitions\";\nexport { AttachState } from \"@fluidframework/container-definitions\";\nexport { ConnectionState } from \"@fluidframework/container-loader\";\nexport type {\n\tContainerAttachProps,\n\tContainerSchema,\n\tIConnection,\n\tIFluidContainer,\n\tIFluidContainerEvents,\n\tIMember,\n\tInitialObjects,\n\tIServiceAudience,\n\tIServiceAudienceEvents,\n\tMemberChangedListener,\n\tMyself,\n} from \"@fluidframework/fluid-static\";\nexport { getPresence, getPresenceAlpha } from \"@fluidframework/fluid-static/internal\";\nexport type { SharedObjectKind } from \"@fluidframework/shared-object-base\";\nexport type {\n\tIErrorBase,\n\tIEventProvider,\n\tIDisposable,\n\tIEvent,\n\tIEventThisPlaceHolder,\n\tIErrorEvent,\n\tErasedType,\n\tIFluidHandle,\n\tIFluidLoadable,\n\tITelemetryBaseProperties,\n\tIEventTransformer,\n\tIProvideFluidLoadable,\n\tIFluidHandleErased,\n\tTransformedEvent,\n\tTelemetryBaseEventPropertyType,\n\tTagged,\n\tReplaceIEventThisPlaceHolder,\n\tFluidObject, // Linked in doc comment\n\tFluidObjectProviderKeys, // Used by FluidObject\n\t/* eslint-disable import-x/export -- The event APIs are known to conflict, and this is intended as the exports via `@fluidframework/core-interfaces` are preferred over the deprecated ones from `@fluidframework/tree`. */\n\tListeners,\n\tIsListener,\n\tListenable,\n\tOff,\n\t/* eslint-enable import-x/export */\n} from \"@fluidframework/core-interfaces\";\nexport type {\n\tErasedBaseType,\n\tFluidIterable,\n\tFluidIterableIterator,\n\tFluidMap,\n\tFluidReadonlyMap,\n} from \"@fluidframework/core-interfaces/internal\";\n\n// This is an alpha API, but this package doesn't have an alpha entry point so its imported from \"internal\".\nexport { onAssertionFailure } from \"@fluidframework/core-utils/internal\";\n\nexport type { isFluidHandle } from \"@fluidframework/runtime-utils\";\n\n// Let the tree package manage its own API surface.\n// Note: this only surfaces the `@public, @beta and @alpha` API items from the tree package.\n/* eslint-disable-next-line\n\tno-restricted-syntax,\n\timport-x/no-internal-modules,\n\timport-x/export -- This re-exports all non-conflicting APIs from `@fluidframework/tree`. In cases where * exports conflict with named exports, the named exports take precedence per https://tc39.es/ecma262/multipage/ecmascript-language-scripts-and-modules.html#sec-getexportednames. This does trigger the `import-x/export` lint warning (which is intentionally disabled here). This approach ensures that the non-deprecated versions of the event APIs from `@fluidframework/core-interfaces` (provided as named indirect exports) eclipse the deprecated ones from `@fluidframework/tree`. The preferred versions of the event APIs are those exported via `@fluidframework/core-interfaces`.\n\t*/\nexport * from \"@fluidframework/tree/alpha\";\n\n// End of basic public+beta+alpha exports - nothing above this line should\n// depend on an /internal path.\n// #endregion Basic re-exports\n// ---------------------------------------------------------------\n// #region Custom re-exports\n\nimport type { SharedObjectKind } from \"@fluidframework/shared-object-base\";\nimport type { ITree } from \"@fluidframework/tree\";\nimport {\n\tSharedTree as OriginalSharedTree,\n\tconfiguredSharedTree as originalConfiguredSharedTree,\n\ttype SharedTreeOptions,\n} from \"@fluidframework/tree/internal\";\n\n/**\n * A hierarchical data structure for collaboratively editing strongly typed JSON-like trees\n * of objects, arrays, and other data types.\n * @privateRemarks\n * Here we reexport SharedTree, but with the `@legacy` types (`ISharedObjectKind`) removed, just keeping the `SharedObjectKind`.\n * Doing this requires creating this new typed export rather than relying on a reexport directly from the tree package.\n * The tree package itself does not do this because it's API needs to be usable from the encapsulated API which requires `ISharedObjectKind`.\n * This package however is not intended for use by users of the encapsulated API, and therefore it can discard that interface.\n * @public\n */\nexport const SharedTree: SharedObjectKind<ITree> = OriginalSharedTree;\n\n/**\n * {@link SharedTree} but allowing a non-default configuration.\n * @remarks\n * This is useful for debugging and testing.\n * For example, it can be used to opt into extra validation or see if opting out of some optimizations fixes an issue.\n *\n * With great care, and knowledge of the support and stability of the options exposed here,\n * this can also be used to opt into some features early or for performance tuning.\n *\n * @example\n * ```typescript\n * import {\n * \tTreeCompressionStrategy,\n * \tconfiguredSharedTree,\n * \tFormatValidatorBasic,\n * \tForestTypeReference,\n * } from \"fluid-framework/alpha\";\n * const SharedTree = configuredSharedTree({\n * \tforest: ForestTypeReference,\n * \tjsonValidator: FormatValidatorBasic,\n * \ttreeEncodeType: TreeCompressionStrategy.Uncompressed,\n * });\n * ```\n * @alpha\n */\nexport function configuredSharedTree(options: SharedTreeOptions): SharedObjectKind<ITree> {\n\treturn originalConfiguredSharedTree(options);\n}\n\n// #endregion Custom re-exports\n// #endregion\n\n// ===============================================================\n// #region Legacy exports\n\nexport type {\n\tIDirectory,\n\tIDirectoryEvents,\n\tIDirectoryValueChanged,\n\tISharedDirectory,\n\tISharedDirectoryEvents,\n\tISharedMap,\n\tISharedMapEvents,\n\tIValueChanged,\n} from \"@fluidframework/map/internal\";\n\nexport { SharedDirectory, SharedMap } from \"@fluidframework/map/internal\";\n\nexport type {\n\tDeserializeCallback,\n\tInteriorSequencePlace,\n\tIInterval,\n\tIntervalStickiness,\n\tISequenceDeltaRange,\n\tISerializedInterval,\n\tISharedSegmentSequenceEvents,\n\tISharedString,\n\tSequencePlace,\n\tSharedStringSegment,\n\tSide,\n\tISharedSegmentSequence,\n\tISequenceIntervalCollection,\n\tISequenceIntervalCollectionEvents,\n\tSequenceIntervalIndex,\n} from \"@fluidframework/sequence/internal\";\n\nexport type {\n\tIntervalType,\n\tSequenceDeltaEvent,\n\tSequenceEvent,\n\tSequenceInterval,\n\tSequenceMaintenanceEvent,\n} from \"@fluidframework/sequence/internal\";\n\nexport { SharedString } from \"@fluidframework/sequence/internal\";\n\nexport type {\n\tISharedObject,\n\tISharedObjectEvents,\n\tISharedObjectKind,\n} from \"@fluidframework/shared-object-base/internal\";\n\nexport type {\n\tISequencedDocumentMessage, // Leaked via ISharedObjectEvents\n\tIBranchOrigin, // Required for ISequencedDocumentMessage\n\tITrace, // Required for ISequencedDocumentMessage\n} from \"@fluidframework/driver-definitions/internal\";\n\n// #endregion Legacy exports\n"]}
|
package/lib/legacy.d.ts
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
|
|
6
6
|
/*
|
|
7
7
|
* THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
|
|
8
|
-
* Generated by "flub generate entrypoints" in @fluid-tools/build-cli.
|
|
8
|
+
* Generated by "flub generate entrypoints --outFileLegacyBeta legacy --outDir ./lib --node10TypeCompat" in @fluid-tools/build-cli.
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -131,6 +131,7 @@ export {
|
|
|
131
131
|
ValidateRecursiveSchemaTemplate,
|
|
132
132
|
ViewableTree,
|
|
133
133
|
WithType,
|
|
134
|
+
getPresence,
|
|
134
135
|
isFluidHandle,
|
|
135
136
|
rollback,
|
|
136
137
|
typeSchemaSymbol,
|
|
@@ -161,12 +162,17 @@ export {
|
|
|
161
162
|
ErasedBaseType,
|
|
162
163
|
ExtensibleUnionNode,
|
|
163
164
|
FixRecursiveArraySchema,
|
|
165
|
+
FluidIterable,
|
|
166
|
+
FluidIterableIterator,
|
|
167
|
+
FluidMap,
|
|
168
|
+
FluidReadonlyMap,
|
|
164
169
|
FluidSerializableAsTree,
|
|
165
170
|
ForestOptions,
|
|
166
171
|
ForestType,
|
|
167
172
|
ForestTypeExpensiveDebug,
|
|
168
173
|
ForestTypeOptimized,
|
|
169
174
|
ForestTypeReference,
|
|
175
|
+
IdentifierIndex,
|
|
170
176
|
JsonCompatible,
|
|
171
177
|
JsonCompatibleObject,
|
|
172
178
|
KeyEncodingOptions,
|
|
@@ -186,6 +192,9 @@ export {
|
|
|
186
192
|
TreeBranch,
|
|
187
193
|
TreeChangeEventsBeta,
|
|
188
194
|
TreeEncodingOptions,
|
|
195
|
+
TreeIndex,
|
|
196
|
+
TreeIndexKey,
|
|
197
|
+
TreeIndexNodes,
|
|
189
198
|
TreeRecordNode,
|
|
190
199
|
TreeRecordNodeUnsafe,
|
|
191
200
|
TreeViewBeta,
|
|
@@ -196,7 +205,9 @@ export {
|
|
|
196
205
|
adaptEnum,
|
|
197
206
|
asBeta,
|
|
198
207
|
configuredSharedTreeBeta,
|
|
208
|
+
createIdentifierIndex,
|
|
199
209
|
createIndependentTreeBeta,
|
|
210
|
+
createTreeIndex,
|
|
200
211
|
enumFromStrings,
|
|
201
212
|
singletonSchema,
|
|
202
213
|
snapshotSchemaCompatibility,
|
|
@@ -217,6 +228,7 @@ export {
|
|
|
217
228
|
ISharedMapEvents,
|
|
218
229
|
ISharedObject,
|
|
219
230
|
ISharedObjectEvents,
|
|
231
|
+
ISharedObjectKind,
|
|
220
232
|
ISharedSegmentSequence,
|
|
221
233
|
ISharedSegmentSequenceEvents,
|
|
222
234
|
ISharedString,
|
package/lib/public.d.ts
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
|
|
6
6
|
/*
|
|
7
7
|
* THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
|
|
8
|
-
* Generated by "flub generate entrypoints" in @fluid-tools/build-cli.
|
|
8
|
+
* Generated by "flub generate entrypoints --outFileLegacyBeta legacy --outDir ./lib --node10TypeCompat" in @fluid-tools/build-cli.
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -131,6 +131,7 @@ export {
|
|
|
131
131
|
ValidateRecursiveSchemaTemplate,
|
|
132
132
|
ViewableTree,
|
|
133
133
|
WithType,
|
|
134
|
+
getPresence,
|
|
134
135
|
isFluidHandle,
|
|
135
136
|
rollback,
|
|
136
137
|
typeSchemaSymbol
|