@fluidframework/datastore-definitions 2.0.0-dev.7.4.0.217212 → 2.0.0-dev.7.4.0.221926

package/lib/datastore-definitions-untrimmed.d.ts

@@ -19,7 +19,7 @@ import { IFluidHandleContext } from '@fluidframework/core-interfaces';
 import { IFluidLoadable } from '@fluidframework/core-interfaces';
 import { IFluidRouter } from '@fluidframework/core-interfaces';
 import { IGarbageCollectionData } from '@fluidframework/runtime-definitions';
-import { IIdCompressor } from '@fluidframework/runtime-definitions';
+import { IIdCompressor } from '@fluidframework/id-compressor';
 import { IInboundSignalMessage } from '@fluidframework/runtime-definitions';
 import { ILoaderOptions } from '@fluidframework/container-definitions';
 import { IProvideFluidDataStoreRegistry } from '@fluidframework/runtime-definitions';
@@ -32,7 +32,7 @@ import { ITelemetryContext } from '@fluidframework/runtime-definitions';
 import { ITelemetryLogger } from '@fluidframework/core-interfaces';
 
 /**
- * @internal
+ * @alpha
  */
 export declare interface IChannel extends IFluidLoadable {
     /**
@@ -120,7 +120,7 @@ export declare interface IChannel extends IFluidLoadable {
 
 /**
  * Represents the attributes of a channel/DDS.
- * @internal
+ * @alpha
  */
 export declare interface IChannelAttributes {
     /**
@@ -157,7 +157,7 @@ export declare interface IChannelAttributes {
  *
  * If a collaboration includes a {@link https://fluidframework.com/docs/data-structures/map/ | SharedMap},
  * the collaborating clients will need to have access to a factory that can produce the `SharedMap` object.
- * @internal
+ * @alpha
  */
 export declare interface IChannelFactory {
     /**
@@ -200,7 +200,7 @@ export declare interface IChannelFactory {
 
 /**
  * Storage services to read the objects at a given path using the given delta connection.
- * @internal
+ * @alpha
  */
 export declare interface IChannelServices {
     deltaConnection: IDeltaConnection;
@@ -209,7 +209,7 @@ export declare interface IChannelServices {
 
 /**
  * Storage services to read the objects at a given path.
- * @internal
+ * @alpha
  */
 export declare interface IChannelStorageService {
     /**
@@ -228,7 +228,7 @@ export declare interface IChannelStorageService {
 
 /**
  * Interface to represent a connection to a delta notification stream.
- * @internal
+ * @alpha
  */
 export declare interface IDeltaConnection {
     connected: boolean;
@@ -260,7 +260,7 @@ export declare interface IDeltaConnection {
 
 /**
  * Handler provided by shared data structure to process requests from the runtime.
- * @internal
+ * @alpha
  */
 export declare interface IDeltaHandler {
     /**
@@ -304,7 +304,7 @@ export declare interface IDeltaHandler {
 
 /**
  * Represents the runtime for the data store. Contains helper functions/state of the data store.
- * @internal
+ * @alpha
  */
 export declare interface IFluidDataStoreRuntime extends IEventProvider<IFluidDataStoreRuntimeEvents>, IDisposable, Partial<IProvideFluidDataStoreRegistry> {
     readonly id: string;
@@ -386,7 +386,8 @@ export declare interface IFluidDataStoreRuntime extends IEventProvider<IFluidDat
 }
 
 /**
- * @internal
+ * Events emitted by {@link IFluidDataStoreRuntime}.
+ * @alpha
  */
 export declare interface IFluidDataStoreRuntimeEvents extends IEvent {
     (event: "disconnected" | "dispose" | "attaching" | "attached", listener: () => void): any;
@@ -432,7 +433,7 @@ export declare interface IFluidDataStoreRuntimeEvents extends IEvent {
  * ```typescript
  * function foo<T>(value: Jsonable<T>) { ... }
  * ```
- * @internal
+ * @alpha
  */
 export declare type Jsonable<T = any, TReplaced = void> = T extends undefined | null | boolean | number | string | TReplaced ? T : Extract<T, Function> extends never ? {
     [K in keyof T]: Extract<K, symbol> extends never ? Jsonable<T[K], TReplaced> : never;
@@ -454,7 +455,7 @@ export declare type Jsonable<T = any, TReplaced = void> = T extends undefined |
  * ```typescript
  * function serialize<T>(value: Serializable<T>) { ... }
  * ```
- * @internal
+ * @alpha
  */
 export declare type Serializable<T = any> = Jsonable<T, IFluidHandle>;
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/datastore-definitions",
-  "version": "2.0.0-dev.7.4.0.217212",
+  "version": "2.0.0-dev.7.4.0.221926",
   "description": "Fluid data store definitions",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -14,12 +14,14 @@
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "dependencies": {
-    "@fluidframework/container-definitions": "2.0.0-dev.7.4.0.217212",
-    "@fluidframework/core-interfaces": "2.0.0-dev.7.4.0.217212",
+    "@fluidframework/container-definitions": "2.0.0-dev.7.4.0.221926",
+    "@fluidframework/core-interfaces": "2.0.0-dev.7.4.0.221926",
+    "@fluidframework/id-compressor": "2.0.0-dev.7.4.0.221926",
     "@fluidframework/protocol-definitions": "^3.0.0",
-    "@fluidframework/runtime-definitions": "2.0.0-dev.7.4.0.217212"
+    "@fluidframework/runtime-definitions": "2.0.0-dev.7.4.0.221926"
   },
   "devDependencies": {
+    "@arethetypeswrong/cli": "^0.13.3",
     "@fluid-tools/build-cli": "^0.28.0",
     "@fluidframework/build-common": "^2.0.3",
     "@fluidframework/build-tools": "^0.28.0",
@@ -55,6 +57,7 @@
     "build:compile": "fluid-build . --task compile",
     "build:docs": "fluid-build . --task api",
     "build:test": "tsc --project ./src/test/tsconfig.json",
+    "check:are-the-types-wrong": "attw --pack",
     "check:release-tags": "api-extractor run --local --config ./api-extractor-lint.json",
     "ci:build:docs": "api-extractor run",
     "clean": "rimraf --glob dist \"**/*.tsbuildinfo\" \"**/*.build.log\" _api-extractor-temp",

package/src/channel.ts

@@ -15,7 +15,7 @@ import { IChannelAttributes } from "./storage";
 import { IFluidDataStoreRuntime } from "./dataStoreRuntime";
 
 /**
- * @internal
+ * @alpha
  */
 export interface IChannel extends IFluidLoadable {
 	/**
@@ -118,7 +118,7 @@ export interface IChannel extends IFluidLoadable {
 
 /**
  * Handler provided by shared data structure to process requests from the runtime.
- * @internal
+ * @alpha
  */
 export interface IDeltaHandler {
 	/**
@@ -166,7 +166,7 @@ export interface IDeltaHandler {
 
 /**
  * Interface to represent a connection to a delta notification stream.
- * @internal
+ * @alpha
  */
 export interface IDeltaConnection {
 	connected: boolean;
@@ -202,7 +202,7 @@ export interface IDeltaConnection {
 
 /**
  * Storage services to read the objects at a given path.
- * @internal
+ * @alpha
  */
 export interface IChannelStorageService {
 	/**
@@ -223,7 +223,7 @@ export interface IChannelStorageService {
 
 /**
  * Storage services to read the objects at a given path using the given delta connection.
- * @internal
+ * @alpha
  */
 export interface IChannelServices {
 	deltaConnection: IDeltaConnection;
@@ -250,7 +250,7 @@ export interface IChannelServices {
  *
  * If a collaboration includes a {@link https://fluidframework.com/docs/data-structures/map/ | SharedMap},
  * the collaborating clients will need to have access to a factory that can produce the `SharedMap` object.
- * @internal
+ * @alpha
  */
 export interface IChannelFactory {
 	/**

package/src/dataStoreRuntime.ts

@@ -28,14 +28,15 @@ import {
 	ISequencedDocumentMessage,
 } from "@fluidframework/protocol-definitions";
 import {
-	IIdCompressor,
 	IInboundSignalMessage,
 	IProvideFluidDataStoreRegistry,
 } from "@fluidframework/runtime-definitions";
+import { IIdCompressor } from "@fluidframework/id-compressor";
 import { IChannel } from ".";
 
 /**
- * @internal
+ * Events emitted by {@link IFluidDataStoreRuntime}.
+ * @alpha
  */
 export interface IFluidDataStoreRuntimeEvents extends IEvent {
 	(event: "disconnected" | "dispose" | "attaching" | "attached", listener: () => void);
@@ -46,7 +47,7 @@ export interface IFluidDataStoreRuntimeEvents extends IEvent {
 
 /**
  * Represents the runtime for the data store. Contains helper functions/state of the data store.
- * @internal
+ * @alpha
  */
 export interface IFluidDataStoreRuntime
 	extends IEventProvider<IFluidDataStoreRuntimeEvents>,

package/src/jsonable.ts

@@ -40,7 +40,7 @@
  * ```typescript
  * function foo<T>(value: Jsonable<T>) { ... }
  * ```
- * @internal
+ * @alpha
  */
 export type Jsonable<T = any, TReplaced = void> = T extends
 	| undefined

package/src/serializable.ts

@@ -22,6 +22,6 @@ import { Jsonable } from "./jsonable";
  * ```typescript
  * function serialize<T>(value: Serializable<T>) { ... }
  * ```
- * @internal
+ * @alpha
  */
 export type Serializable<T = any> = Jsonable<T, IFluidHandle>;

package/src/storage.ts

@@ -5,7 +5,7 @@
 
 /**
  * Represents the attributes of a channel/DDS.
- * @internal
+ * @alpha
  */
 export interface IChannelAttributes {
 	/**