Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

@fluidframework/map

Package Overview
Dependencies
Maintainers
2
Versions
587
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@fluidframework/map - npm Package Compare versions

Comparing version 2.0.0-rc.3.0.3 to 2.0.0-rc.4.0.0

39

api-report/map.api.md

@@ -10,9 +10,9 @@ ## API Report File for "@fluidframework/map"

import type { IChannelServices } from '@fluidframework/datastore-definitions';
import { IDisposable } from '@fluidframework/core-interfaces';
import { IEvent } from '@fluidframework/core-interfaces';
import { IEventProvider } from '@fluidframework/core-interfaces';
import { IEventThisPlaceHolder } from '@fluidframework/core-interfaces';
import type { IDisposable } from '@fluidframework/core-interfaces';
import type { IEvent } from '@fluidframework/core-interfaces';
import type { IEventProvider } from '@fluidframework/core-interfaces';
import type { IEventThisPlaceHolder } from '@fluidframework/core-interfaces';
import type { IFluidDataStoreRuntime } from '@fluidframework/datastore-definitions';
import { ISharedObject } from '@fluidframework/shared-object-base';
import { ISharedObjectEvents } from '@fluidframework/shared-object-base';
import type { ISharedObject } from '@fluidframework/shared-object-base';
import type { ISharedObjectEvents } from '@fluidframework/shared-object-base';
import type { ISharedObjectKind } from '@fluidframework/shared-object-base';

@@ -30,2 +30,8 @@

// @alpha @deprecated
export interface ICreateInfo {
ccIds: string[];
csn: number;
}
// @alpha

@@ -45,2 +51,9 @@ export interface IDirectory extends Map<string, any>, IEventProvider<IDirectoryEvents>, Partial<IDisposable> {

// @alpha @deprecated
export interface IDirectoryDataObject {
ci?: ICreateInfo;
storage?: Record<string, ISerializableValue>;
subdirectories?: Record<string, IDirectoryDataObject>;
}
// @alpha

@@ -55,2 +68,8 @@ export interface IDirectoryEvents extends IEvent {

// @alpha @deprecated
export interface IDirectoryNewStorageFormat {
blobs: string[];
content: IDirectoryDataObject;
}
// @alpha

@@ -61,2 +80,8 @@ export interface IDirectoryValueChanged extends IValueChanged {

// @alpha @deprecated
export interface ISerializableValue {
type: string;
value: any;
}
// @alpha

@@ -106,3 +131,3 @@ export interface ISharedDirectory extends ISharedObject<ISharedDirectoryEvents & IDirectoryEvents>, Omit<IDirectory, "on" | "once" | "off"> {

// @alpha @sealed
// @alpha
export const SharedDirectory: ISharedObjectKind<ISharedDirectory>;

@@ -109,0 +134,0 @@

# @fluidframework/map
## 2.0.0-rc.4.0.0
### Minor Changes
- Deprecated members of IFluidHandle are split off into new IFluidHandleInternal interface [96872186d0](https://github.com/microsoft/FluidFramework/commit/96872186d0d0f245c1fece7d19b3743e501679b6)
Split IFluidHandle into two interfaces, `IFluidHandle` and `IFluidHandleInternal`.
Code depending on the previously deprecated members of IFluidHandle can access them by using `toFluidHandleInternal` from `@fluidframework/runtime-utils/legacy`.
External implementation of the `IFluidHandle` interface are not supported: this change makes the typing better convey this using the `ErasedType` pattern.
Any existing and previously working, and now broken, external implementations of `IFluidHandle` should still work at runtime, but will need some unsafe type casts to compile.
Such handle implementation may break in the future and thus should be replaced with use of handles produced by the Fluid Framework client packages.
## 2.0.0-rc.3.0.0

@@ -4,0 +17,0 @@

38

dist/directory.d.ts

@@ -6,12 +6,13 @@ /*!

import { TypedEventEmitter } from "@fluid-internal/client-utils";
import { IChannelAttributes, IChannelStorageService, IFluidDataStoreRuntime } from "@fluidframework/datastore-definitions";
import type { IChannelAttributes, IChannelStorageService, IFluidDataStoreRuntime } from "@fluidframework/datastore-definitions";
import { RedBlackTree } from "@fluidframework/merge-tree/internal";
import { ISequencedDocumentMessage } from "@fluidframework/protocol-definitions";
import { ISummaryTreeWithStats, ITelemetryContext } from "@fluidframework/runtime-definitions";
import { IFluidSerializer } from "@fluidframework/shared-object-base";
import { type ISequencedDocumentMessage } from "@fluidframework/protocol-definitions";
import type { ISummaryTreeWithStats, ITelemetryContext } from "@fluidframework/runtime-definitions";
import type { IFluidSerializer } from "@fluidframework/shared-object-base";
import { SharedObject } from "@fluidframework/shared-object-base/internal";
import { ITelemetryLoggerExt } from "@fluidframework/telemetry-utils";
import { IDirectory, IDirectoryEvents, ISharedDirectory, ISharedDirectoryEvents } from "./interfaces.js";
import { ISerializableValue, ISerializedValue } from "./internalInterfaces.js";
import { ILocalValue, LocalValueMaker } from "./localValues.js";
import { type ITelemetryLoggerExt } from "@fluidframework/telemetry-utils/internal";
import type { IDirectory, IDirectoryEvents, ISharedDirectory, ISharedDirectoryEvents } from "./interfaces.js";
import type { ISerializableValue, ISerializedValue } from "./internalInterfaces.js";
import type { ILocalValue } from "./localValues.js";
import { LocalValueMaker } from "./localValues.js";
/**

@@ -129,2 +130,5 @@ * Operation indicating a value should be set for a key.

* Create info for the subdirectory.
*
* @deprecated - This interface will no longer be exported in the future(AB#8004).
*
* @alpha

@@ -149,2 +153,5 @@ */

* {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/parse | JSON.parse}.
*
* @deprecated - This interface will no longer be exported in the future(AB#8004).
*
* @alpha

@@ -156,11 +163,7 @@ */

*/
storage?: {
[key: string]: ISerializableValue;
};
storage?: Record<string, ISerializableValue>;
/**
* Recursive sub-directories {@link IDirectoryDataObject | objects}.
*/
subdirectories?: {
[subdirName: string]: IDirectoryDataObject;
};
subdirectories?: Record<string, IDirectoryDataObject>;
/**

@@ -178,3 +181,5 @@ * Create info for the sub directory. Since directories with same name can get deleted/created by multiple clients

*
* @internal
* @deprecated - This interface will no longer be exported in the future(AB#8004).
*
* @alpha
*/

@@ -430,2 +435,5 @@ export interface IDirectoryNewStorageFormat {

type SubDirLocalOpMetadata = ICreateSubDirLocalOpMetadata | IDeleteSubDirLocalOpMetadata;
/**
* Types of local op metadata.
*/
export type DirectoryLocalOpMetadata = IClearLocalOpMetadata | IKeyEditLocalOpMetadata | SubDirLocalOpMetadata;

@@ -432,0 +440,0 @@ /**

@@ -42,3 +42,2 @@ /*!

* Entrypoint for {@link ISharedDirectory} creation.
* @sealed
* @alpha

@@ -45,0 +44,0 @@ */

@@ -8,2 +8,3 @@ "use strict";

exports.SharedDirectory = exports.DirectoryFactory = void 0;
const internal_1 = require("@fluidframework/shared-object-base/internal");
const directory_js_1 = require("./directory.js");

@@ -62,32 +63,5 @@ const packageVersion_js_1 = require("./packageVersion.js");

* Entrypoint for {@link ISharedDirectory} creation.
* @sealed
* @alpha
*/
exports.SharedDirectory = {
/**
* Create a new shared directory
*
* @param runtime - Data store runtime the new shared directory belongs to
* @param id - Optional name of the shared directory
* @returns Newly create shared directory (but not attached yet)
*
* @example
* To create a `SharedDirectory`, call the static create method:
*
* ```typescript
* const myDirectory = SharedDirectory.create(this.runtime, id);
* ```
*/
create(runtime, id) {
return runtime.createChannel(id, DirectoryFactory.Type);
},
/**
* Get a factory for SharedDirectory to register with the data store.
*
* @returns A factory that creates and load SharedDirectory
*/
getFactory() {
return new DirectoryFactory();
},
};
exports.SharedDirectory = (0, internal_1.createSharedObjectKind)(DirectoryFactory);
//# sourceMappingURL=directoryFactory.js.map

@@ -16,5 +16,7 @@ /*!

*/
export { IDirectory, IDirectoryEvents, IDirectoryValueChanged, ISharedDirectory, ISharedDirectoryEvents, ISharedMap, ISharedMapEvents, IValueChanged, } from "./interfaces.js";
export type { IDirectory, IDirectoryEvents, IDirectoryValueChanged, ISharedDirectory, ISharedDirectoryEvents, ISharedMap, ISharedMapEvents, IValueChanged, } from "./interfaces.js";
export { MapFactory, SharedMap } from "./mapFactory.js";
export { DirectoryFactory, SharedDirectory } from "./directoryFactory.js";
export type { ICreateInfo, IDirectoryNewStorageFormat, IDirectoryDataObject } from "./directory.js";
export type { ISerializableValue } from "./internalInterfaces.js";
//# sourceMappingURL=index.d.ts.map

@@ -5,4 +5,4 @@ /*!

*/
import { IDisposable, IEvent, IEventProvider, IEventThisPlaceHolder } from "@fluidframework/core-interfaces";
import { ISharedObject, ISharedObjectEvents } from "@fluidframework/shared-object-base";
import type { IDisposable, IEvent, IEventProvider, IEventThisPlaceHolder } from "@fluidframework/core-interfaces";
import type { ISharedObject, ISharedObjectEvents } from "@fluidframework/shared-object-base";
/**

@@ -9,0 +9,0 @@ * Type of "valueChanged" event parameter.

@@ -5,3 +5,3 @@ /*!

*/
import { ILocalValue } from "./localValues.js";
import type { ILocalValue } from "./localValues.js";
/**

@@ -122,3 +122,3 @@ * Operation indicating a value should be set for a key.

*
* @deprecated This type is legacy and deprecated.
* @deprecated This type is legacy and deprecated(AB#8004).
* @alpha

@@ -125,0 +125,0 @@ */

@@ -12,7 +12,11 @@ /*!

export {
// alpha APIs
// @alpha APIs
DirectoryFactory,
ICreateInfo,
IDirectory,
IDirectoryDataObject,
IDirectoryEvents,
IDirectoryNewStorageFormat,
IDirectoryValueChanged,
ISerializableValue,
ISharedDirectory,

@@ -19,0 +23,0 @@ ISharedDirectoryEvents,

@@ -5,5 +5,5 @@ /*!

*/
import { IFluidHandle } from "@fluidframework/core-interfaces";
import { IFluidSerializer } from "@fluidframework/shared-object-base";
import { ISerializableValue, ISerializedValue } from "./internalInterfaces.js";
import type { IFluidHandle } from "@fluidframework/core-interfaces";
import type { IFluidSerializer } from "@fluidframework/shared-object-base";
import type { ISerializableValue, ISerializedValue } from "./internalInterfaces.js";
/**

@@ -10,0 +10,0 @@ * A local value to be stored in a container type Distributed Data Store (DDS).

@@ -5,11 +5,10 @@ /*!

*/
import { IChannelAttributes, IChannelStorageService, IFluidDataStoreRuntime } from "@fluidframework/datastore-definitions";
import { ISequencedDocumentMessage } from "@fluidframework/protocol-definitions";
import { ISummaryTreeWithStats, ITelemetryContext } from "@fluidframework/runtime-definitions";
import { IFluidSerializer } from "@fluidframework/shared-object-base";
import type { IChannelAttributes, IChannelStorageService, IFluidDataStoreRuntime } from "@fluidframework/datastore-definitions";
import { type ISequencedDocumentMessage } from "@fluidframework/protocol-definitions";
import type { ISummaryTreeWithStats, ITelemetryContext } from "@fluidframework/runtime-definitions";
import type { IFluidSerializer } from "@fluidframework/shared-object-base";
import { SharedObject } from "@fluidframework/shared-object-base/internal";
import { ISharedMap, ISharedMapEvents } from "./interfaces.js";
import type { ISharedMap, ISharedMapEvents } from "./interfaces.js";
/**
* {@inheritDoc ISharedMap}
* @alpha
*/

@@ -16,0 +15,0 @@ export declare class SharedMap extends SharedObject<ISharedMapEvents> implements ISharedMap {

@@ -17,3 +17,2 @@ "use strict";

* {@inheritDoc ISharedMap}
* @alpha
*/

@@ -227,2 +226,3 @@ class SharedMap extends internal_3.SharedObject {

processCore(message, local, localOpMetadata) {
// eslint-disable-next-line @typescript-eslint/no-unsafe-enum-comparison
if (message.type === protocol_definitions_1.MessageType.Operation) {

@@ -229,0 +229,0 @@ this.kernel.tryProcessMessage(message.contents, local, localOpMetadata);

@@ -8,2 +8,3 @@ "use strict";

exports.SharedMap = exports.MapFactory = void 0;
const internal_1 = require("@fluidframework/shared-object-base/internal");
const map_js_1 = require("./map.js");

@@ -64,10 +65,3 @@ const packageVersion_js_1 = require("./packageVersion.js");

*/
exports.SharedMap = {
getFactory() {
return new MapFactory();
},
create(runtime, id) {
return runtime.createChannel(id, MapFactory.Type);
},
};
exports.SharedMap = (0, internal_1.createSharedObjectKind)(MapFactory);
//# sourceMappingURL=mapFactory.js.map

@@ -5,7 +5,7 @@ /*!

*/
import { TypedEventEmitter } from "@fluid-internal/client-utils";
import { IFluidHandle } from "@fluidframework/core-interfaces";
import { IFluidSerializer } from "@fluidframework/shared-object-base";
import { ISharedMapEvents } from "./interfaces.js";
import { IMapClearOperation, IMapDeleteOperation, IMapSetOperation, ISerializableValue, ISerializedValue } from "./internalInterfaces.js";
import type { TypedEventEmitter } from "@fluid-internal/client-utils";
import type { IFluidHandle } from "@fluidframework/core-interfaces";
import type { IFluidSerializer } from "@fluidframework/shared-object-base";
import type { ISharedMapEvents } from "./interfaces.js";
import type { IMapClearOperation, IMapDeleteOperation, IMapSetOperation, ISerializableValue, ISerializedValue } from "./internalInterfaces.js";
/**

@@ -27,11 +27,7 @@ * Map key operations are one of several types.

*/
export interface IMapDataObjectSerializable {
[key: string]: ISerializableValue;
}
export type IMapDataObjectSerializable = Record<string, ISerializableValue>;
/**
* Serialized key/value data.
*/
export interface IMapDataObjectSerialized {
[key: string]: ISerializedValue;
}
export type IMapDataObjectSerialized = Record<string, ISerializedValue>;
/**

@@ -38,0 +34,0 @@ * A SharedMap is a map-like distributed data structure.

@@ -8,3 +8,3 @@ /*!

export declare const pkgName = "@fluidframework/map";
export declare const pkgVersion = "2.0.0-rc.3.0.3";
export declare const pkgVersion = "2.0.0-rc.4.0.0";
//# sourceMappingURL=packageVersion.d.ts.map

@@ -11,3 +11,3 @@ "use strict";

exports.pkgName = "@fluidframework/map";
exports.pkgVersion = "2.0.0-rc.3.0.3";
exports.pkgVersion = "2.0.0-rc.4.0.0";
//# sourceMappingURL=packageVersion.js.map

@@ -6,12 +6,13 @@ /*!

import { TypedEventEmitter } from "@fluid-internal/client-utils";
import { IChannelAttributes, IChannelStorageService, IFluidDataStoreRuntime } from "@fluidframework/datastore-definitions";
import type { IChannelAttributes, IChannelStorageService, IFluidDataStoreRuntime } from "@fluidframework/datastore-definitions";
import { RedBlackTree } from "@fluidframework/merge-tree/internal";
import { ISequencedDocumentMessage } from "@fluidframework/protocol-definitions";
import { ISummaryTreeWithStats, ITelemetryContext } from "@fluidframework/runtime-definitions";
import { IFluidSerializer } from "@fluidframework/shared-object-base";
import { type ISequencedDocumentMessage } from "@fluidframework/protocol-definitions";
import type { ISummaryTreeWithStats, ITelemetryContext } from "@fluidframework/runtime-definitions";
import type { IFluidSerializer } from "@fluidframework/shared-object-base";
import { SharedObject } from "@fluidframework/shared-object-base/internal";
import { ITelemetryLoggerExt } from "@fluidframework/telemetry-utils";
import { IDirectory, IDirectoryEvents, ISharedDirectory, ISharedDirectoryEvents } from "./interfaces.js";
import { ISerializableValue, ISerializedValue } from "./internalInterfaces.js";
import { ILocalValue, LocalValueMaker } from "./localValues.js";
import { type ITelemetryLoggerExt } from "@fluidframework/telemetry-utils/internal";
import type { IDirectory, IDirectoryEvents, ISharedDirectory, ISharedDirectoryEvents } from "./interfaces.js";
import type { ISerializableValue, ISerializedValue } from "./internalInterfaces.js";
import type { ILocalValue } from "./localValues.js";
import { LocalValueMaker } from "./localValues.js";
/**

@@ -129,2 +130,5 @@ * Operation indicating a value should be set for a key.

* Create info for the subdirectory.
*
* @deprecated - This interface will no longer be exported in the future(AB#8004).
*
* @alpha

@@ -149,2 +153,5 @@ */

* {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/parse | JSON.parse}.
*
* @deprecated - This interface will no longer be exported in the future(AB#8004).
*
* @alpha

@@ -156,11 +163,7 @@ */

*/
storage?: {
[key: string]: ISerializableValue;
};
storage?: Record<string, ISerializableValue>;
/**
* Recursive sub-directories {@link IDirectoryDataObject | objects}.
*/
subdirectories?: {
[subdirName: string]: IDirectoryDataObject;
};
subdirectories?: Record<string, IDirectoryDataObject>;
/**

@@ -178,3 +181,5 @@ * Create info for the sub directory. Since directories with same name can get deleted/created by multiple clients

*
* @internal
* @deprecated - This interface will no longer be exported in the future(AB#8004).
*
* @alpha
*/

@@ -430,2 +435,5 @@ export interface IDirectoryNewStorageFormat {

type SubDirLocalOpMetadata = ICreateSubDirLocalOpMetadata | IDeleteSubDirLocalOpMetadata;
/**
* Types of local op metadata.
*/
export type DirectoryLocalOpMetadata = IClearLocalOpMetadata | IKeyEditLocalOpMetadata | SubDirLocalOpMetadata;

@@ -432,0 +440,0 @@ /**

@@ -42,3 +42,2 @@ /*!

* Entrypoint for {@link ISharedDirectory} creation.
* @sealed
* @alpha

@@ -45,0 +44,0 @@ */

@@ -5,2 +5,3 @@ /*!

*/
import { createSharedObjectKind } from "@fluidframework/shared-object-base/internal";
import { SharedDirectory as SharedDirectoryInternal } from "./directory.js";

@@ -58,32 +59,5 @@ import { pkgVersion } from "./packageVersion.js";

* Entrypoint for {@link ISharedDirectory} creation.
* @sealed
* @alpha
*/
export const SharedDirectory = {
/**
* Create a new shared directory
*
* @param runtime - Data store runtime the new shared directory belongs to
* @param id - Optional name of the shared directory
* @returns Newly create shared directory (but not attached yet)
*
* @example
* To create a `SharedDirectory`, call the static create method:
*
* ```typescript
* const myDirectory = SharedDirectory.create(this.runtime, id);
* ```
*/
create(runtime, id) {
return runtime.createChannel(id, DirectoryFactory.Type);
},
/**
* Get a factory for SharedDirectory to register with the data store.
*
* @returns A factory that creates and load SharedDirectory
*/
getFactory() {
return new DirectoryFactory();
},
};
export const SharedDirectory = createSharedObjectKind(DirectoryFactory);
//# sourceMappingURL=directoryFactory.js.map

@@ -16,5 +16,7 @@ /*!

*/
export { IDirectory, IDirectoryEvents, IDirectoryValueChanged, ISharedDirectory, ISharedDirectoryEvents, ISharedMap, ISharedMapEvents, IValueChanged, } from "./interfaces.js";
export type { IDirectory, IDirectoryEvents, IDirectoryValueChanged, ISharedDirectory, ISharedDirectoryEvents, ISharedMap, ISharedMapEvents, IValueChanged, } from "./interfaces.js";
export { MapFactory, SharedMap } from "./mapFactory.js";
export { DirectoryFactory, SharedDirectory } from "./directoryFactory.js";
export type { ICreateInfo, IDirectoryNewStorageFormat, IDirectoryDataObject } from "./directory.js";
export type { ISerializableValue } from "./internalInterfaces.js";
//# sourceMappingURL=index.d.ts.map

@@ -5,4 +5,4 @@ /*!

*/
import { IDisposable, IEvent, IEventProvider, IEventThisPlaceHolder } from "@fluidframework/core-interfaces";
import { ISharedObject, ISharedObjectEvents } from "@fluidframework/shared-object-base";
import type { IDisposable, IEvent, IEventProvider, IEventThisPlaceHolder } from "@fluidframework/core-interfaces";
import type { ISharedObject, ISharedObjectEvents } from "@fluidframework/shared-object-base";
/**

@@ -9,0 +9,0 @@ * Type of "valueChanged" event parameter.

@@ -5,3 +5,3 @@ /*!

*/
import { ILocalValue } from "./localValues.js";
import type { ILocalValue } from "./localValues.js";
/**

@@ -122,3 +122,3 @@ * Operation indicating a value should be set for a key.

*
* @deprecated This type is legacy and deprecated.
* @deprecated This type is legacy and deprecated(AB#8004).
* @alpha

@@ -125,0 +125,0 @@ */

@@ -12,7 +12,11 @@ /*!

export {
// alpha APIs
// @alpha APIs
DirectoryFactory,
ICreateInfo,
IDirectory,
IDirectoryDataObject,
IDirectoryEvents,
IDirectoryNewStorageFormat,
IDirectoryValueChanged,
ISerializableValue,
ISharedDirectory,

@@ -19,0 +23,0 @@ ISharedDirectoryEvents,

@@ -5,5 +5,5 @@ /*!

*/
import { IFluidHandle } from "@fluidframework/core-interfaces";
import { IFluidSerializer } from "@fluidframework/shared-object-base";
import { ISerializableValue, ISerializedValue } from "./internalInterfaces.js";
import type { IFluidHandle } from "@fluidframework/core-interfaces";
import type { IFluidSerializer } from "@fluidframework/shared-object-base";
import type { ISerializableValue, ISerializedValue } from "./internalInterfaces.js";
/**

@@ -10,0 +10,0 @@ * A local value to be stored in a container type Distributed Data Store (DDS).

@@ -5,11 +5,10 @@ /*!

*/
import { IChannelAttributes, IChannelStorageService, IFluidDataStoreRuntime } from "@fluidframework/datastore-definitions";
import { ISequencedDocumentMessage } from "@fluidframework/protocol-definitions";
import { ISummaryTreeWithStats, ITelemetryContext } from "@fluidframework/runtime-definitions";
import { IFluidSerializer } from "@fluidframework/shared-object-base";
import type { IChannelAttributes, IChannelStorageService, IFluidDataStoreRuntime } from "@fluidframework/datastore-definitions";
import { type ISequencedDocumentMessage } from "@fluidframework/protocol-definitions";
import type { ISummaryTreeWithStats, ITelemetryContext } from "@fluidframework/runtime-definitions";
import type { IFluidSerializer } from "@fluidframework/shared-object-base";
import { SharedObject } from "@fluidframework/shared-object-base/internal";
import { ISharedMap, ISharedMapEvents } from "./interfaces.js";
import type { ISharedMap, ISharedMapEvents } from "./interfaces.js";
/**
* {@inheritDoc ISharedMap}
* @alpha
*/

@@ -16,0 +15,0 @@ export declare class SharedMap extends SharedObject<ISharedMapEvents> implements ISharedMap {

@@ -14,3 +14,2 @@ /*!

* {@inheritDoc ISharedMap}
* @alpha
*/

@@ -224,2 +223,3 @@ export class SharedMap extends SharedObject {

processCore(message, local, localOpMetadata) {
// eslint-disable-next-line @typescript-eslint/no-unsafe-enum-comparison
if (message.type === MessageType.Operation) {

@@ -226,0 +226,0 @@ this.kernel.tryProcessMessage(message.contents, local, localOpMetadata);

@@ -5,2 +5,3 @@ /*!

*/
import { createSharedObjectKind } from "@fluidframework/shared-object-base/internal";
import { SharedMap as SharedMapInternal } from "./map.js";

@@ -60,10 +61,3 @@ import { pkgVersion } from "./packageVersion.js";

*/
export const SharedMap = {
getFactory() {
return new MapFactory();
},
create(runtime, id) {
return runtime.createChannel(id, MapFactory.Type);
},
};
export const SharedMap = createSharedObjectKind(MapFactory);
//# sourceMappingURL=mapFactory.js.map

@@ -5,7 +5,7 @@ /*!

*/
import { TypedEventEmitter } from "@fluid-internal/client-utils";
import { IFluidHandle } from "@fluidframework/core-interfaces";
import { IFluidSerializer } from "@fluidframework/shared-object-base";
import { ISharedMapEvents } from "./interfaces.js";
import { IMapClearOperation, IMapDeleteOperation, IMapSetOperation, ISerializableValue, ISerializedValue } from "./internalInterfaces.js";
import type { TypedEventEmitter } from "@fluid-internal/client-utils";
import type { IFluidHandle } from "@fluidframework/core-interfaces";
import type { IFluidSerializer } from "@fluidframework/shared-object-base";
import type { ISharedMapEvents } from "./interfaces.js";
import type { IMapClearOperation, IMapDeleteOperation, IMapSetOperation, ISerializableValue, ISerializedValue } from "./internalInterfaces.js";
/**

@@ -27,11 +27,7 @@ * Map key operations are one of several types.

*/
export interface IMapDataObjectSerializable {
[key: string]: ISerializableValue;
}
export type IMapDataObjectSerializable = Record<string, ISerializableValue>;
/**
* Serialized key/value data.
*/
export interface IMapDataObjectSerialized {
[key: string]: ISerializedValue;
}
export type IMapDataObjectSerialized = Record<string, ISerializedValue>;
/**

@@ -38,0 +34,0 @@ * A SharedMap is a map-like distributed data structure.

@@ -8,3 +8,3 @@ /*!

export declare const pkgName = "@fluidframework/map";
export declare const pkgVersion = "2.0.0-rc.3.0.3";
export declare const pkgVersion = "2.0.0-rc.4.0.0";
//# sourceMappingURL=packageVersion.d.ts.map

@@ -8,3 +8,3 @@ /*!

export const pkgName = "@fluidframework/map";
export const pkgVersion = "2.0.0-rc.3.0.3";
export const pkgVersion = "2.0.0-rc.4.0.0";
//# sourceMappingURL=packageVersion.js.map

@@ -8,5 +8,5 @@ // This file is read by tools that parse documentation comments conforming to the TSDoc standard.

"packageName": "@microsoft/api-extractor",
"packageVersion": "7.42.3"
"packageVersion": "7.43.1"
}
]
}
{
"name": "@fluidframework/map",
"version": "2.0.0-rc.3.0.3",
"version": "2.0.0-rc.4.0.0",
"description": "Distributed map",

@@ -70,13 +70,13 @@ "homepage": "https://fluidframework.com",

"dependencies": {
"@fluid-internal/client-utils": ">=2.0.0-rc.3.0.3 <2.0.0-rc.3.1.0",
"@fluidframework/core-interfaces": ">=2.0.0-rc.3.0.3 <2.0.0-rc.3.1.0",
"@fluidframework/core-utils": ">=2.0.0-rc.3.0.3 <2.0.0-rc.3.1.0",
"@fluidframework/datastore-definitions": ">=2.0.0-rc.3.0.3 <2.0.0-rc.3.1.0",
"@fluidframework/driver-utils": ">=2.0.0-rc.3.0.3 <2.0.0-rc.3.1.0",
"@fluidframework/merge-tree": ">=2.0.0-rc.3.0.3 <2.0.0-rc.3.1.0",
"@fluid-internal/client-utils": ">=2.0.0-rc.4.0.0 <2.0.0-rc.4.1.0",
"@fluidframework/core-interfaces": ">=2.0.0-rc.4.0.0 <2.0.0-rc.4.1.0",
"@fluidframework/core-utils": ">=2.0.0-rc.4.0.0 <2.0.0-rc.4.1.0",
"@fluidframework/datastore-definitions": ">=2.0.0-rc.4.0.0 <2.0.0-rc.4.1.0",
"@fluidframework/driver-utils": ">=2.0.0-rc.4.0.0 <2.0.0-rc.4.1.0",
"@fluidframework/merge-tree": ">=2.0.0-rc.4.0.0 <2.0.0-rc.4.1.0",
"@fluidframework/protocol-definitions": "^3.2.0",
"@fluidframework/runtime-definitions": ">=2.0.0-rc.3.0.3 <2.0.0-rc.3.1.0",
"@fluidframework/runtime-utils": ">=2.0.0-rc.3.0.3 <2.0.0-rc.3.1.0",
"@fluidframework/shared-object-base": ">=2.0.0-rc.3.0.3 <2.0.0-rc.3.1.0",
"@fluidframework/telemetry-utils": ">=2.0.0-rc.3.0.3 <2.0.0-rc.3.1.0",
"@fluidframework/runtime-definitions": ">=2.0.0-rc.4.0.0 <2.0.0-rc.4.1.0",
"@fluidframework/runtime-utils": ">=2.0.0-rc.4.0.0 <2.0.0-rc.4.1.0",
"@fluidframework/shared-object-base": ">=2.0.0-rc.4.0.0 <2.0.0-rc.4.1.0",
"@fluidframework/telemetry-utils": ">=2.0.0-rc.4.0.0 <2.0.0-rc.4.1.0",
"path-browserify": "^1.0.1"

@@ -87,14 +87,14 @@ },

"@biomejs/biome": "^1.6.2",
"@fluid-internal/mocha-test-setup": ">=2.0.0-rc.3.0.3 <2.0.0-rc.3.1.0",
"@fluid-private/stochastic-test-utils": ">=2.0.0-rc.3.0.3 <2.0.0-rc.3.1.0",
"@fluid-private/test-dds-utils": ">=2.0.0-rc.3.0.3 <2.0.0-rc.3.1.0",
"@fluid-internal/mocha-test-setup": ">=2.0.0-rc.4.0.0 <2.0.0-rc.4.1.0",
"@fluid-private/stochastic-test-utils": ">=2.0.0-rc.4.0.0 <2.0.0-rc.4.1.0",
"@fluid-private/test-dds-utils": ">=2.0.0-rc.4.0.0 <2.0.0-rc.4.1.0",
"@fluid-tools/benchmark": "^0.48.0",
"@fluid-tools/build-cli": "^0.37.0",
"@fluid-tools/build-cli": "^0.38.0",
"@fluidframework/build-common": "^2.0.3",
"@fluidframework/build-tools": "^0.37.0",
"@fluidframework/container-definitions": ">=2.0.0-rc.3.0.3 <2.0.0-rc.3.1.0",
"@fluidframework/build-tools": "^0.38.0",
"@fluidframework/container-definitions": ">=2.0.0-rc.4.0.0 <2.0.0-rc.4.1.0",
"@fluidframework/eslint-config-fluid": "^5.1.0",
"@fluidframework/map-previous": "npm:@fluidframework/map@2.0.0-internal.8.0.0",
"@fluidframework/test-runtime-utils": ">=2.0.0-rc.3.0.3 <2.0.0-rc.3.1.0",
"@microsoft/api-extractor": "^7.42.3",
"@fluidframework/map-previous": "npm:@fluidframework/map@2.0.0-rc.3.0.0",
"@fluidframework/test-runtime-utils": ">=2.0.0-rc.4.0.0 <2.0.0-rc.4.1.0",
"@microsoft/api-extractor": "^7.43.1",
"@types/mocha": "^9.1.1",

@@ -118,75 +118,24 @@ "@types/node": "^18.19.0",

"broken": {
"RemovedClassDeclaration_SharedMap": {
"InterfaceDeclaration_ISharedDirectory": {
"forwardCompat": false,
"backCompat": false
},
"ClassDeclaration_SharedMap": {
"backCompat": false
},
"RemovedClassDeclaration_SharedDirectory": {
"backCompat": false
},
"RemovedInterfaceDeclaration_ICreateInfo": {
"InterfaceDeclaration_ISharedMap": {
"forwardCompat": false,
"backCompat": false
},
"RemovedInterfaceDeclaration_IDirectoryClearOperation": {
"forwardCompat": false,
"backCompat": false
"ClassDeclaration_SharedDirectory": {
"forwardCompat": false
},
"RemovedInterfaceDeclaration_IDirectoryCreateSubDirectoryOperation": {
"forwardCompat": false,
"backCompat": false
"RemovedClassDeclaration_SharedDirectory": {
"backCompat": false,
"forwardCompat": false
},
"RemovedInterfaceDeclaration_IDirectoryDataObject": {
"TypeAliasDeclaration_SharedDirectory": {
"forwardCompat": false,
"backCompat": false
},
"RemovedInterfaceDeclaration_IDirectoryDeleteOperation": {
"TypeAliasDeclaration_SharedMap": {
"forwardCompat": false,
"backCompat": false
},
"RemovedInterfaceDeclaration_IDirectoryDeleteSubDirectoryOperation": {
"forwardCompat": false,
"backCompat": false
},
"RemovedTypeAliasDeclaration_IDirectoryKeyOperation": {
"forwardCompat": false,
"backCompat": false
},
"RemovedInterfaceDeclaration_IDirectoryNewStorageFormat": {
"forwardCompat": false,
"backCompat": false
},
"RemovedTypeAliasDeclaration_IDirectoryOperation": {
"forwardCompat": false,
"backCompat": false
},
"RemovedInterfaceDeclaration_IDirectorySetOperation": {
"forwardCompat": false,
"backCompat": false
},
"RemovedTypeAliasDeclaration_IDirectoryStorageOperation": {
"forwardCompat": false,
"backCompat": false
},
"RemovedTypeAliasDeclaration_IDirectorySubDirectoryOperation": {
"forwardCompat": false,
"backCompat": false
},
"RemovedInterfaceDeclaration_ILocalValue": {
"forwardCompat": false,
"backCompat": false
},
"RemovedClassDeclaration_LocalValueMaker": {
"forwardCompat": false,
"backCompat": false
},
"RemovedInterfaceDeclaration_ISerializableValue": {
"forwardCompat": false,
"backCompat": false
},
"RemovedInterfaceDeclaration_ISerializedValue": {
"forwardCompat": false,
"backCompat": false
}

@@ -229,5 +178,5 @@ }

"tsc": "fluid-tsc commonjs --project ./tsconfig.cjs.json && copyfiles -f ../../../common/build/build-common/src/cjs/package.json ./dist",
"typetests:gen": "fluid-type-test-generator",
"typetests:gen": "flub generate typetests --dir . -v --publicFallback",
"typetests:prepare": "flub typetests --dir . --reset --previous --normalize"
}
}

@@ -13,2 +13,3 @@ /*!

import type { ISharedObjectKind } from "@fluidframework/shared-object-base";
import { createSharedObjectKind } from "@fluidframework/shared-object-base/internal";

@@ -82,34 +83,7 @@ import { SharedDirectory as SharedDirectoryInternal } from "./directory.js";

* Entrypoint for {@link ISharedDirectory} creation.
* @sealed
* @alpha
*/
export const SharedDirectory: ISharedObjectKind<ISharedDirectory> = {
/**
* Create a new shared directory
*
* @param runtime - Data store runtime the new shared directory belongs to
* @param id - Optional name of the shared directory
* @returns Newly create shared directory (but not attached yet)
*
* @example
* To create a `SharedDirectory`, call the static create method:
*
* ```typescript
* const myDirectory = SharedDirectory.create(this.runtime, id);
* ```
*/
create(runtime: IFluidDataStoreRuntime, id?: string): ISharedDirectory {
return runtime.createChannel(id, DirectoryFactory.Type) as ISharedDirectory;
},
export const SharedDirectory: ISharedObjectKind<ISharedDirectory> =
createSharedObjectKind(DirectoryFactory);
/**
* Get a factory for SharedDirectory to register with the data store.
*
* @returns A factory that creates and load SharedDirectory
*/
getFactory(): IChannelFactory<ISharedDirectory> {
return new DirectoryFactory();
},
};
/**

@@ -116,0 +90,0 @@ * Entrypoint for {@link ISharedDirectory} creation.

@@ -18,3 +18,3 @@ /*!

export {
export type {
IDirectory,

@@ -31,1 +31,3 @@ IDirectoryEvents,

export { DirectoryFactory, SharedDirectory } from "./directoryFactory.js";
export type { ICreateInfo, IDirectoryNewStorageFormat, IDirectoryDataObject } from "./directory.js";
export type { ISerializableValue } from "./internalInterfaces.js";

@@ -6,3 +6,3 @@ /*!

import {
import type {
IDisposable,

@@ -13,3 +13,3 @@ IEvent,

} from "@fluidframework/core-interfaces";
import { ISharedObject, ISharedObjectEvents } from "@fluidframework/shared-object-base";
import type { ISharedObject, ISharedObjectEvents } from "@fluidframework/shared-object-base";

@@ -16,0 +16,0 @@ /**

@@ -6,3 +6,3 @@ /*!

import { ILocalValue } from "./localValues.js";
import type { ILocalValue } from "./localValues.js";

@@ -26,3 +26,2 @@ /**

*/
// eslint-disable-next-line import/no-deprecated
value: ISerializableValue;

@@ -142,3 +141,3 @@ }

*
* @deprecated This type is legacy and deprecated.
* @deprecated This type is legacy and deprecated(AB#8004).
* @alpha

@@ -145,0 +144,0 @@ */

@@ -6,5 +6,5 @@ /*!

import { IFluidHandle } from "@fluidframework/core-interfaces";
import { ISerializedHandle } from "@fluidframework/runtime-utils/internal";
import { IFluidSerializer } from "@fluidframework/shared-object-base";
import type { IFluidHandle } from "@fluidframework/core-interfaces";
import type { ISerializedHandle } from "@fluidframework/runtime-utils/internal";
import type { IFluidSerializer } from "@fluidframework/shared-object-base";
import {

@@ -17,3 +17,3 @@ ValueType,

// eslint-disable-next-line import/no-deprecated
import { ISerializableValue, ISerializedValue } from "./internalInterfaces.js";
import type { ISerializableValue, ISerializedValue } from "./internalInterfaces.js";

@@ -20,0 +20,0 @@ /**

@@ -6,3 +6,3 @@ /*!

import {
import type {
IChannelAttributes,

@@ -13,10 +13,10 @@ IChannelStorageService,

import { readAndParse } from "@fluidframework/driver-utils/internal";
import { ISequencedDocumentMessage, MessageType } from "@fluidframework/protocol-definitions";
import { ISummaryTreeWithStats, ITelemetryContext } from "@fluidframework/runtime-definitions";
import { MessageType, type ISequencedDocumentMessage } from "@fluidframework/protocol-definitions";
import type { ISummaryTreeWithStats, ITelemetryContext } from "@fluidframework/runtime-definitions";
import { SummaryTreeBuilder } from "@fluidframework/runtime-utils/internal";
import { IFluidSerializer } from "@fluidframework/shared-object-base";
import type { IFluidSerializer } from "@fluidframework/shared-object-base";
import { SharedObject } from "@fluidframework/shared-object-base/internal";
import { ISharedMap, ISharedMapEvents } from "./interfaces.js";
import { IMapDataObjectSerializable, IMapOperation, MapKernel } from "./mapKernel.js";
import type { ISharedMap, ISharedMapEvents } from "./interfaces.js";
import { type IMapDataObjectSerializable, type IMapOperation, MapKernel } from "./mapKernel.js";

@@ -32,3 +32,2 @@ interface IMapSerializationFormat {

* {@inheritDoc ISharedMap}
* @alpha
*/

@@ -291,2 +290,3 @@ export class SharedMap extends SharedObject<ISharedMapEvents> implements ISharedMap {

): void {
// eslint-disable-next-line @typescript-eslint/no-unsafe-enum-comparison
if (message.type === MessageType.Operation) {

@@ -293,0 +293,0 @@ this.kernel.tryProcessMessage(

@@ -6,4 +6,2 @@ /*!

/* eslint-disable import/no-deprecated */
import type {

@@ -16,2 +14,3 @@ IChannelAttributes,

import type { ISharedObjectKind } from "@fluidframework/shared-object-base";
import { createSharedObjectKind } from "@fluidframework/shared-object-base/internal";

@@ -87,12 +86,4 @@ import type { ISharedMap } from "./interfaces.js";

*/
export const SharedMap: ISharedObjectKind<ISharedMap> = {
getFactory(): IChannelFactory<ISharedMap> {
return new MapFactory();
},
export const SharedMap: ISharedObjectKind<ISharedMap> = createSharedObjectKind(MapFactory);
create(runtime: IFluidDataStoreRuntime, id?: string): ISharedMap {
return runtime.createChannel(id, MapFactory.Type) as ISharedMap;
},
};
/**

@@ -99,0 +90,0 @@ * Entrypoint for {@link ISharedMap} creation.

@@ -6,10 +6,10 @@ /*!

import { TypedEventEmitter } from "@fluid-internal/client-utils";
import { IFluidHandle } from "@fluidframework/core-interfaces";
import type { TypedEventEmitter } from "@fluid-internal/client-utils";
import type { IFluidHandle } from "@fluidframework/core-interfaces";
import { assert, unreachableCase } from "@fluidframework/core-utils/internal";
import { IFluidSerializer } from "@fluidframework/shared-object-base";
import type { IFluidSerializer } from "@fluidframework/shared-object-base";
import { ValueType, bindHandles } from "@fluidframework/shared-object-base/internal";
import { ISharedMapEvents } from "./interfaces.js";
import {
import type { ISharedMapEvents } from "./interfaces.js";
import type {
IMapClearLocalOpMetadata,

@@ -25,3 +25,3 @@ IMapClearOperation,

} from "./internalInterfaces.js";
import { ILocalValue, LocalValueMaker, makeSerializable } from "./localValues.js";
import { type ILocalValue, LocalValueMaker, makeSerializable } from "./localValues.js";

@@ -67,6 +67,4 @@ /**

*/
export interface IMapDataObjectSerializable {
// eslint-disable-next-line import/no-deprecated
[key: string]: ISerializableValue;
}
// eslint-disable-next-line import/no-deprecated
export type IMapDataObjectSerializable = Record<string, ISerializableValue>;

@@ -76,5 +74,3 @@ /**

*/
export interface IMapDataObjectSerialized {
[key: string]: ISerializedValue;
}
export type IMapDataObjectSerialized = Record<string, ISerializedValue>;

@@ -160,3 +156,3 @@ type MapKeyLocalOpMetadata = IMapKeyEditLocalOpMetadata | IMapKeyAddLocalOpMetadata;

*/
private readonly pendingKeys: Map<string, number[]> = new Map();
private readonly pendingKeys = new Map<string, number[]>();

@@ -163,0 +159,0 @@ /**

@@ -9,2 +9,2 @@ /*!

export const pkgName = "@fluidframework/map";
export const pkgVersion = "2.0.0-rc.3.0.3";
export const pkgVersion = "2.0.0-rc.4.0.0";

Sorry, the diff of this file is not supported yet

Sorry, the diff of this file is not supported yet

Sorry, the diff of this file is too big to display

Sorry, the diff of this file is not supported yet

Sorry, the diff of this file is not supported yet

Sorry, the diff of this file is not supported yet

Sorry, the diff of this file is not supported yet

Sorry, the diff of this file is not supported yet

Sorry, the diff of this file is not supported yet

Sorry, the diff of this file is not supported yet

Sorry, the diff of this file is not supported yet

Sorry, the diff of this file is not supported yet

Sorry, the diff of this file is not supported yet

Sorry, the diff of this file is not supported yet

Sorry, the diff of this file is not supported yet

Sorry, the diff of this file is not supported yet

Sorry, the diff of this file is not supported yet

Sorry, the diff of this file is not supported yet

Sorry, the diff of this file is not supported yet

Sorry, the diff of this file is not supported yet

Sorry, the diff of this file is not supported yet

Sorry, the diff of this file is not supported yet

Sorry, the diff of this file is too big to display

Sorry, the diff of this file is not supported yet

Sorry, the diff of this file is not supported yet

Sorry, the diff of this file is not supported yet

Sorry, the diff of this file is not supported yet

Sorry, the diff of this file is not supported yet

Sorry, the diff of this file is not supported yet

Sorry, the diff of this file is not supported yet

Sorry, the diff of this file is not supported yet

Sorry, the diff of this file is not supported yet

Sorry, the diff of this file is not supported yet

Sorry, the diff of this file is not supported yet

Sorry, the diff of this file is not supported yet

Sorry, the diff of this file is not supported yet

Sorry, the diff of this file is not supported yet

Sorry, the diff of this file is not supported yet

Sorry, the diff of this file is not supported yet

Sorry, the diff of this file is not supported yet

Sorry, the diff of this file is not supported yet

Sorry, the diff of this file is too big to display

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc