Skip to content

Commit

Permalink
Remove several types from @public scope (#21142)
Browse files Browse the repository at this point in the history
## Description

Due to my previous changes to make IFluidDataStoreRuntime non-public,
several types no longer need to be public. This moves more of them to
alpha.

Also includes a couple of `IAudience` related tweaks to make the types
better convey what I I think is supported as far as method binding and
modification.

## Breaking Changes

The following types have been moved from `@public` to `@alpha`:

-   `IFluidSerializer`
-   `ISharedObjectEvents`
-   `IChannelServices`
-   `IChannelStorageService`
-   `IDeltaConnection`
-   `IDeltaHandler`

These should not be needed by users of the declarative API, which is
what `@public` is targeting.
  • Loading branch information
CraigMacomber authored May 17, 2024
1 parent 1de3375 commit 983e9f0
Show file tree
Hide file tree
Showing 138 changed files with 324 additions and 252 deletions.
18 changes: 18 additions & 0 deletions .changeset/hip-results-press.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
"@fluidframework/datastore-definitions": minor
"fluid-framework": minor
"@fluidframework/shared-object-base": minor
---

Remove several types from `@public` scope

The following types have been moved from `@public` to `@alpha`:

- `IFluidSerializer`
- `ISharedObjectEvents`
- `IChannelServices`
- `IChannelStorageService`
- `IDeltaConnection`
- `IDeltaHandler`

These should not be needed by users of the declarative API, which is what `@public` is targeting.
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,10 @@

import { IChannelAttributes } from '@fluidframework/datastore-definitions/internal';
import { IChannelFactory } from '@fluidframework/datastore-definitions/internal';
import { IChannelServices } from '@fluidframework/datastore-definitions';
import { IChannelStorageService } from '@fluidframework/datastore-definitions';
import { IChannelServices } from '@fluidframework/datastore-definitions/internal';
import { IChannelStorageService } from '@fluidframework/datastore-definitions/internal';
import { IFluidDataStoreRuntime } from '@fluidframework/datastore-definitions/internal';
import { IFluidSerializer } from '@fluidframework/shared-object-base';
import { IFluidSerializer } from '@fluidframework/shared-object-base/internal';
import { ISequencedDocumentMessage } from '@fluidframework/protocol-definitions';
import { ISharedObjectKind } from '@fluidframework/shared-object-base/internal';
import { IsoBuffer } from '@fluid-internal/client-utils';
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,19 +18,18 @@ import {
NodeProperty,
PropertyFactory,
} from "@fluid-experimental/property-properties";
import { IChannelStorageService } from "@fluidframework/datastore-definitions";
import { IsoBuffer, bufferToString, stringToBuffer } from "@fluid-internal/client-utils";
import { AttachState } from "@fluidframework/container-definitions";
import {
IChannelAttributes,
IChannelFactory,
IFluidDataStoreRuntime,
IChannelStorageService,
} from "@fluidframework/datastore-definitions/internal";
import { ISequencedDocumentMessage, MessageType } from "@fluidframework/protocol-definitions";
import { ISummaryTreeWithStats } from "@fluidframework/runtime-definitions/internal";
import { SummaryTreeBuilder } from "@fluidframework/runtime-utils/internal";
import { IFluidSerializer } from "@fluidframework/shared-object-base";
import { SharedObject } from "@fluidframework/shared-object-base/internal";
import { SharedObject, IFluidSerializer } from "@fluidframework/shared-object-base/internal";
import axios from "axios";
import { copy as cloneDeep } from "fastest-json-copy";
import { Packr } from "msgpackr";
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,11 @@
/* eslint-disable @typescript-eslint/no-unsafe-return */

import { bufferToString, stringToBuffer } from "@fluid-internal/client-utils";
import { IChannelServices } from "@fluidframework/datastore-definitions";
import {
IChannelAttributes,
IChannelFactory,
IFluidDataStoreRuntime,
IChannelServices,
} from "@fluidframework/datastore-definitions/internal";
import { compress, decompress } from "lz4js";
import { deflate, inflate } from "pako";
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,11 @@
* Licensed under the MIT License.
*/

import { IChannelServices } from "@fluidframework/datastore-definitions";
import {
IChannelAttributes,
IChannelFactory,
IFluidDataStoreRuntime,
IChannelServices,
} from "@fluidframework/datastore-definitions/internal";
import { createSharedObjectKind } from "@fluidframework/shared-object-base/internal";

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,11 @@
import { AttributionKey } from '@fluidframework/runtime-definitions/internal';
import { IEventThisPlaceHolder } from '@fluidframework/core-interfaces';
import { IFluidHandle } from '@fluidframework/core-interfaces';
import { IFluidSerializer } from '@fluidframework/shared-object-base';
import { IFluidSerializer } from '@fluidframework/shared-object-base/internal';
import { ISharedObject } from '@fluidframework/shared-object-base/internal';
import { ISharedObjectEvents } from '@fluidframework/shared-object-base';
import { ISharedObjectEvents } from '@fluidframework/shared-object-base/internal';
import { ISharedObjectKind } from '@fluidframework/shared-object-base/internal';
import { SharedObjectKind } from '@fluidframework/shared-object-base';
import { SharedObjectKind } from '@fluidframework/shared-object-base/internal';

// @internal
export const AttributableMap: ISharedObjectKind<ISharedMap> & SharedObjectKind<ISharedMap>;
Expand Down
3 changes: 1 addition & 2 deletions experimental/dds/attributable-map/src/interfaces.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,7 @@

import { IEventThisPlaceHolder } from "@fluidframework/core-interfaces";
import { AttributionKey } from "@fluidframework/runtime-definitions/internal";
import { ISharedObjectEvents } from "@fluidframework/shared-object-base";
import { ISharedObject } from "@fluidframework/shared-object-base/internal";
import { ISharedObject, ISharedObjectEvents } from "@fluidframework/shared-object-base/internal";
/**
* Type of "valueChanged" event parameter.
* @internal
Expand Down
2 changes: 1 addition & 1 deletion experimental/dds/attributable-map/src/localValues.ts
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@
import { IFluidHandle } from "@fluidframework/core-interfaces";
import { AttributionKey } from "@fluidframework/runtime-definitions/internal";
import { ISerializedHandle } from "@fluidframework/runtime-utils/internal";
import { IFluidSerializer } from "@fluidframework/shared-object-base";
import {
IFluidSerializer,
ValueType,
parseHandles,
serializeHandles,
Expand Down
10 changes: 7 additions & 3 deletions experimental/dds/attributable-map/src/map.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,12 @@
* Licensed under the MIT License.
*/

import { IChannelServices, IChannelStorageService } from "@fluidframework/datastore-definitions";
import {
IChannelAttributes,
IChannelFactory,
IFluidDataStoreRuntime,
IChannelServices,
IChannelStorageService,
} from "@fluidframework/datastore-definitions/internal";
import { readAndParse } from "@fluidframework/driver-utils/internal";
import { ISequencedDocumentMessage, MessageType } from "@fluidframework/protocol-definitions";
Expand All @@ -17,8 +18,11 @@ import {
AttributionKey,
} from "@fluidframework/runtime-definitions/internal";
import { SummaryTreeBuilder } from "@fluidframework/runtime-utils/internal";
import { IFluidSerializer } from "@fluidframework/shared-object-base";
import { SharedObject, createSharedObjectKind } from "@fluidframework/shared-object-base/internal";
import {
IFluidSerializer,
SharedObject,
createSharedObjectKind,
} from "@fluidframework/shared-object-base/internal";

import { ISharedMap, ISharedMapEvents } from "./interfaces.js";
import { AttributableMapKernel, IMapDataObjectSerializable, IMapOperation } from "./mapKernel.js";
Expand Down
7 changes: 5 additions & 2 deletions experimental/dds/attributable-map/src/mapKernel.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,11 @@ import { IFluidHandle } from "@fluidframework/core-interfaces";
import { assert, unreachableCase } from "@fluidframework/core-utils/internal";
import { ISequencedDocumentMessage } from "@fluidframework/protocol-definitions";
import { AttributionKey } from "@fluidframework/runtime-definitions/internal";
import { IFluidSerializer } from "@fluidframework/shared-object-base";
import { ValueType, bindHandles } from "@fluidframework/shared-object-base/internal";
import {
IFluidSerializer,
ValueType,
bindHandles,
} from "@fluidframework/shared-object-base/internal";

// eslint-disable-next-line import/no-deprecated
import { ISerializableValue, ISerializedValue, ISharedMapEvents } from "./interfaces.js";
Expand Down
4 changes: 2 additions & 2 deletions experimental/dds/ot/ot/api-report/ot.api.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@
```ts

import { IChannelAttributes } from '@fluidframework/datastore-definitions/internal';
import { IChannelStorageService } from '@fluidframework/datastore-definitions';
import { IChannelStorageService } from '@fluidframework/datastore-definitions/internal';
import { IFluidDataStoreRuntime } from '@fluidframework/datastore-definitions/internal';
import { IFluidSerializer } from '@fluidframework/shared-object-base';
import { IFluidSerializer } from '@fluidframework/shared-object-base/internal';
import { ISequencedDocumentMessage } from '@fluidframework/protocol-definitions';
import { ISummaryTreeWithStats } from '@fluidframework/runtime-definitions/internal';
import { SharedObject } from '@fluidframework/shared-object-base/internal';
Expand Down
9 changes: 6 additions & 3 deletions experimental/dds/ot/ot/src/ot.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,18 @@

import { bufferToString } from "@fluid-internal/client-utils";
import { assert } from "@fluidframework/core-utils/internal";
import { IChannelStorageService } from "@fluidframework/datastore-definitions";
import {
IChannelAttributes,
IFluidDataStoreRuntime,
IChannelStorageService,
} from "@fluidframework/datastore-definitions/internal";
import { ISequencedDocumentMessage } from "@fluidframework/protocol-definitions";
import { ISummaryTreeWithStats } from "@fluidframework/runtime-definitions/internal";
import { IFluidSerializer } from "@fluidframework/shared-object-base";
import { SharedObject, createSingleBlobSummary } from "@fluidframework/shared-object-base/internal";
import {
IFluidSerializer,
SharedObject,
createSingleBlobSummary,
} from "@fluidframework/shared-object-base/internal";

interface ISequencedOpInfo<TOp> {
client: string;
Expand Down
2 changes: 1 addition & 1 deletion experimental/dds/ot/ot/src/test/delta.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,11 @@
* Licensed under the MIT License.
*/

import { IChannelServices } from "@fluidframework/datastore-definitions";
import {
IChannelAttributes,
IChannelFactory,
IFluidDataStoreRuntime,
IChannelServices,
} from "@fluidframework/datastore-definitions/internal";
import Delta from "quill-delta";

Expand Down
2 changes: 1 addition & 1 deletion experimental/dds/ot/ot/src/test/ot.stress.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

import { strict as assert } from "assert";

import { IChannelServices } from "@fluidframework/datastore-definitions";
import { IChannelServices } from "@fluidframework/datastore-definitions/internal";
import {
MockContainerRuntimeFactoryForReconnection,
MockContainerRuntimeForReconnection,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import { Doc } from 'ot-json1';
import { IChannel } from '@fluidframework/datastore-definitions/internal';
import { IChannelAttributes } from '@fluidframework/datastore-definitions/internal';
import { IChannelFactory } from '@fluidframework/datastore-definitions/internal';
import { IChannelServices } from '@fluidframework/datastore-definitions';
import { IChannelServices } from '@fluidframework/datastore-definitions/internal';
import { IFluidDataStoreRuntime } from '@fluidframework/datastore-definitions/internal';
import { JSONOp } from 'ot-json1';
import { Path } from 'ot-json1';
Expand Down
2 changes: 1 addition & 1 deletion experimental/dds/ot/sharejs/json1/src/factory.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@
* Licensed under the MIT License.
*/

import { IChannelServices } from "@fluidframework/datastore-definitions";
import {
IChannel,
IChannelAttributes,
IChannelFactory,
IFluidDataStoreRuntime,
IChannelServices,
} from "@fluidframework/datastore-definitions/internal";

import { SharedJson1 } from "./json1.js";
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
import { BaseSegment } from '@fluidframework/merge-tree/internal';
import { IChannelAttributes } from '@fluidframework/datastore-definitions/internal';
import { IChannelFactory } from '@fluidframework/datastore-definitions/internal';
import { IChannelServices } from '@fluidframework/datastore-definitions';
import { IChannelServices } from '@fluidframework/datastore-definitions/internal';
import { IFluidDataStoreRuntime } from '@fluidframework/datastore-definitions/internal';
import { IFluidHandle } from '@fluidframework/core-interfaces';
import { IJSONRunSegment } from '@fluidframework/sequence/internal';
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,11 @@
* Licensed under the MIT License.
*/

import { IChannelServices } from "@fluidframework/datastore-definitions";
import {
IChannelAttributes,
IChannelFactory,
IFluidDataStoreRuntime,
IChannelServices,
} from "@fluidframework/datastore-definitions/internal";
import { IJSONSegment } from "@fluidframework/merge-tree/internal";
import { IJSONRunSegment, SubSequence } from "@fluidframework/sequence/internal";
Expand Down
2 changes: 1 addition & 1 deletion experimental/dds/sequence-deprecated/src/sparsematrix.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,12 @@

import { IFluidHandle } from "@fluidframework/core-interfaces";
import { assert } from "@fluidframework/core-utils/internal";
import { IChannelServices } from "@fluidframework/datastore-definitions";
import {
IChannelAttributes,
IChannelFactory,
IFluidDataStoreRuntime,
Jsonable,
IChannelServices,
} from "@fluidframework/datastore-definitions/internal";
import {
BaseSegment,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

import { strict as assert } from "assert";

import { IChannelServices } from "@fluidframework/datastore-definitions";
import { IChannelServices } from "@fluidframework/datastore-definitions/internal";
import {
MockContainerRuntimeFactory,
MockContainerRuntimeFactoryForReconnection,
Expand Down
8 changes: 4 additions & 4 deletions experimental/dds/tree/api-report/experimental-tree.api.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,18 +8,18 @@ import { EventEmitterWithErrorHandling } from '@fluidframework/telemetry-utils/i
import { IChannel } from '@fluidframework/datastore-definitions/internal';
import { IChannelAttributes } from '@fluidframework/datastore-definitions/internal';
import { IChannelFactory } from '@fluidframework/datastore-definitions/internal';
import { IChannelServices } from '@fluidframework/datastore-definitions';
import { IChannelStorageService } from '@fluidframework/datastore-definitions';
import { IChannelServices } from '@fluidframework/datastore-definitions/internal';
import { IChannelStorageService } from '@fluidframework/datastore-definitions/internal';
import { IDisposable } from '@fluidframework/core-interfaces';
import { IErrorEvent } from '@fluidframework/core-interfaces';
import { IEvent } from '@fluidframework/core-interfaces';
import { IExperimentalIncrementalSummaryContext } from '@fluidframework/runtime-definitions/internal';
import { IFluidDataStoreRuntime } from '@fluidframework/datastore-definitions/internal';
import { IFluidHandle } from '@fluidframework/core-interfaces';
import { IFluidLoadable } from '@fluidframework/core-interfaces';
import { IFluidSerializer } from '@fluidframework/shared-object-base';
import { IFluidSerializer } from '@fluidframework/shared-object-base/internal';
import { IGarbageCollectionData } from '@fluidframework/runtime-definitions/internal';
import { ISharedObjectEvents } from '@fluidframework/shared-object-base';
import { ISharedObjectEvents } from '@fluidframework/shared-object-base/internal';
import { ISummaryTreeWithStats } from '@fluidframework/runtime-definitions/internal';
import { ITelemetryBaseEvent } from '@fluidframework/core-interfaces';
import { ITelemetryBaseProperties } from '@fluidframework/core-interfaces';
Expand Down
11 changes: 8 additions & 3 deletions experimental/dds/tree/src/SharedTree.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7,16 +7,21 @@ import { bufferToString } from '@fluid-internal/client-utils';
import { AttachState } from '@fluidframework/container-definitions';
import { ITelemetryBaseProperties } from '@fluidframework/core-interfaces';
import { assert } from '@fluidframework/core-utils/internal';
import { IChannelServices, IChannelStorageService } from '@fluidframework/datastore-definitions';
import {
IChannelAttributes,
IChannelFactory,
IFluidDataStoreRuntime,
IChannelServices,
IChannelStorageService,
} from '@fluidframework/datastore-definitions/internal';
import { ISequencedDocumentMessage } from '@fluidframework/protocol-definitions';
import { ISummaryTreeWithStats, ITelemetryContext } from '@fluidframework/runtime-definitions/internal';
import { IFluidSerializer, ISharedObjectEvents } from '@fluidframework/shared-object-base';
import { SharedObject, createSingleBlobSummary } from '@fluidframework/shared-object-base/internal';
import {
IFluidSerializer,
ISharedObjectEvents,
SharedObject,
createSingleBlobSummary,
} from '@fluidframework/shared-object-base/internal';
import {
IEventSampler,
ITelemetryLoggerPropertyBags,
Expand Down
3 changes: 1 addition & 2 deletions experimental/dds/tree/src/Summary.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,7 @@
*/

import type { IFluidHandle } from '@fluidframework/core-interfaces';
import { IFluidSerializer } from '@fluidframework/shared-object-base';
import { serializeHandles } from '@fluidframework/shared-object-base/internal';
import { IFluidSerializer, serializeHandles } from '@fluidframework/shared-object-base/internal';

import { fail } from './Common.js';
import type { EditHandle } from './EditLog.js';
Expand Down
2 changes: 1 addition & 1 deletion experimental/dds/tree/src/SummaryBackCompatibility.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
*/

import type { ITelemetryBaseProperties } from '@fluidframework/core-interfaces';
import type { IFluidSerializer } from '@fluidframework/shared-object-base';
import type { IFluidSerializer } from '@fluidframework/shared-object-base/internal';

import { fail } from './Common.js';
import { getNumberOfHandlesFromEditLogSummary } from './EditLog.js';
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,7 @@
*/

import { assert } from '@fluidframework/core-utils/internal';
import { type IDeltaHandler } from '@fluidframework/datastore-definitions';
import { type IChannelAttributes } from '@fluidframework/datastore-definitions/internal';
import { type IChannelAttributes, type IDeltaHandler } from '@fluidframework/datastore-definitions/internal';
import { type ISequencedDocumentMessage, MessageType } from '@fluidframework/protocol-definitions';

import { type IOpContents, type IShimDeltaHandler } from './types.js';
Expand Down
2 changes: 1 addition & 1 deletion experimental/dds/tree/src/migration-shim/migrationShim.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,12 @@ import { type EventEmitterEventType } from '@fluid-internal/client-utils';
import { AttachState } from '@fluidframework/container-definitions';
import { type IEvent, type IFluidHandle, type IFluidLoadable } from '@fluidframework/core-interfaces';
import { assert } from '@fluidframework/core-utils/internal';
import { type IChannelServices } from '@fluidframework/datastore-definitions';
import {
type IChannelAttributes,
IChannelFactory,
type IFluidDataStoreRuntime,
type IChannel,
type IChannelServices,
} from '@fluidframework/datastore-definitions/internal';
import type { SessionId } from '@fluidframework/id-compressor';
import type { IIdCompressorCore } from '@fluidframework/id-compressor/internal';
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@
*/

import { assert } from '@fluidframework/core-utils/internal';
import { type IChannelServices } from '@fluidframework/datastore-definitions';
import {
type IChannelAttributes,
type IChannelFactory,
type IFluidDataStoreRuntime,
type IChannelServices,
} from '@fluidframework/datastore-definitions/internal';
import { type ITree } from '@fluidframework/tree';

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,7 @@
*/

import { assert } from '@fluidframework/core-utils/internal';
import { type IDeltaHandler } from '@fluidframework/datastore-definitions';
import { type IChannelAttributes } from '@fluidframework/datastore-definitions/internal';
import { type IChannelAttributes, type IDeltaHandler } from '@fluidframework/datastore-definitions/internal';
import { type ISequencedDocumentMessage, MessageType } from '@fluidframework/protocol-definitions';

import { type IOpContents, type IShimDeltaHandler } from './types.js';
Expand Down
Loading

0 comments on commit 983e9f0

Please sign in to comment.