@fluid-experimental/data-objects 2.0.0-dev-rc.3.0.0.254513 → 2.0.0-dev-rc.3.0.0.254866

package/dist/alpha.d.ts

@@ -0,0 +1,9 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+/*
+ * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
+ * Generated by "flub generate entrypoints" in @fluidframework/build-tools.
+ */

package/dist/beta.d.ts

@@ -0,0 +1,9 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+/*
+ * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
+ * Generated by "flub generate entrypoints" in @fluidframework/build-tools.
+ */

package/dist/public.d.ts

@@ -0,0 +1,9 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+/*
+ * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
+ * Generated by "flub generate entrypoints" in @fluidframework/build-tools.
+ */

package/lib/alpha.d.ts

@@ -0,0 +1,9 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+/*
+ * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
+ * Generated by "flub generate entrypoints" in @fluidframework/build-tools.
+ */

package/lib/beta.d.ts

@@ -0,0 +1,9 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+/*
+ * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
+ * Generated by "flub generate entrypoints" in @fluidframework/build-tools.
+ */

package/lib/public.d.ts

@@ -0,0 +1,9 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+/*
+ * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
+ * Generated by "flub generate entrypoints" in @fluidframework/build-tools.
+ */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluid-experimental/data-objects",
-  "version": "2.0.0-dev-rc.3.0.0.254513",
+  "version": "2.0.0-dev-rc.3.0.0.254866",
   "description": "A collection of ready to use Fluid Data Objects",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -25,11 +25,11 @@
     },
     "./public": {
       "import": {
-        "types": "./lib/data-objects-public.d.ts",
+        "types": "./lib/public.d.ts",
         "default": "./lib/index.js"
       },
       "require": {
-        "types": "./dist/data-objects-public.d.ts",
+        "types": "./dist/public.d.ts",
         "default": "./dist/index.js"
       }
     },
@@ -47,13 +47,13 @@
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "dependencies": {
-    "@fluid-internal/client-utils": "2.0.0-dev-rc.3.0.0.254513",
-    "@fluidframework/aqueduct": "2.0.0-dev-rc.3.0.0.254513",
-    "@fluidframework/core-interfaces": "2.0.0-dev-rc.3.0.0.254513",
-    "@fluidframework/core-utils": "2.0.0-dev-rc.3.0.0.254513",
-    "@fluidframework/datastore-definitions": "2.0.0-dev-rc.3.0.0.254513",
-    "@fluidframework/map": "2.0.0-dev-rc.3.0.0.254513",
-    "@fluidframework/runtime-definitions": "2.0.0-dev-rc.3.0.0.254513"
+    "@fluid-internal/client-utils": "2.0.0-dev-rc.3.0.0.254866",
+    "@fluidframework/aqueduct": "2.0.0-dev-rc.3.0.0.254866",
+    "@fluidframework/core-interfaces": "2.0.0-dev-rc.3.0.0.254866",
+    "@fluidframework/core-utils": "2.0.0-dev-rc.3.0.0.254866",
+    "@fluidframework/datastore-definitions": "2.0.0-dev-rc.3.0.0.254866",
+    "@fluidframework/map": "2.0.0-dev-rc.3.0.0.254866",
+    "@fluidframework/runtime-definitions": "2.0.0-dev-rc.3.0.0.254866"
   },
   "devDependencies": {
     "@arethetypeswrong/cli": "^0.15.2",
@@ -71,30 +71,18 @@
     "rimraf": "^4.4.0",
     "typescript": "~5.1.6"
   },
-  "fluidBuild": {
-    "tasks": {
-      "build:docs": {
-        "dependsOn": [
-          "...",
-          "api-extractor:commonjs",
-          "api-extractor:esnext"
-        ],
-        "script": false
-      }
-    }
-  },
   "typeValidation": {
     "disabled": true,
     "broken": {}
   },
   "scripts": {
     "api": "fluid-build . --task api",
-    "api-extractor:commonjs": "api-extractor run --config ./api-extractor-cjs.json",
-    "api-extractor:esnext": "api-extractor run --local",
+    "api-extractor:commonjs": "flub generate entrypoints --outDir ./dist",
+    "api-extractor:esnext": "flub generate entrypoints --outDir ./lib",
     "build": "fluid-build . --task build",
     "build:commonjs": "fluid-build . --task commonjs",
     "build:compile": "fluid-build . --task compile",
-    "build:docs": "fluid-build . --task api",
+    "build:docs": "api-extractor run --local",
     "build:esnext": "tsc --project ./tsconfig.json",
     "check:are-the-types-wrong": "attw --pack . --entrypoints .",
     "check:prettier": "prettier --check . --cache --ignore-path ../../../.prettierignore",

package/api-extractor-cjs.json

@@ -1,8 +0,0 @@
-{
-	"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
-	"extends": "../../../common/build/build-common/api-extractor-base.cjs.primary.json",
-	// CJS is actually secondary; so, no report.
-	"apiReport": {
-		"enabled": false
-	}
-}

package/dist/data-objects-alpha.d.ts

@@ -1,16 +0,0 @@
-import { DataObject } from '@fluidframework/aqueduct/internal';
-import { DataObjectFactory } from '@fluidframework/aqueduct/internal';
-import { EventEmitter } from '@fluid-internal/client-utils';
-import { IErrorEvent } from '@fluidframework/core-interfaces';
-import { IInboundSignalMessage } from '@fluidframework/runtime-definitions';
-import { Jsonable } from '@fluidframework/datastore-definitions/internal';
-
-/* Excluded from this release type: IRuntimeSignaler */
-
-/* Excluded from this release type: ISignaler */
-
-/* Excluded from this release type: Signaler */
-
-/* Excluded from this release type: SignalListener */
-
-export { }

package/dist/data-objects-beta.d.ts

@@ -1,22 +0,0 @@
-import { DataObject } from '@fluidframework/aqueduct/internal';
-import { DataObjectFactory } from '@fluidframework/aqueduct/internal';
-import { EventEmitter } from '@fluid-internal/client-utils';
-import { IErrorEvent } from '@fluidframework/core-interfaces';
-import { IInboundSignalMessage } from '@fluidframework/runtime-definitions';
-import { Jsonable } from '@fluidframework/datastore-definitions/internal';
-
-/* Excluded from this release type: DataObject */
-
-/* Excluded from this release type: DataObjectFactory */
-
-/* Excluded from this release type: IRuntimeSignaler */
-
-/* Excluded from this release type: ISignaler */
-
-/* Excluded from this release type: Jsonable */
-
-/* Excluded from this release type: Signaler */
-
-/* Excluded from this release type: SignalListener */
-
-export { }

package/dist/data-objects-public.d.ts

@@ -1,22 +0,0 @@
-import { DataObject } from '@fluidframework/aqueduct/internal';
-import { DataObjectFactory } from '@fluidframework/aqueduct/internal';
-import { EventEmitter } from '@fluid-internal/client-utils';
-import { IErrorEvent } from '@fluidframework/core-interfaces';
-import { IInboundSignalMessage } from '@fluidframework/runtime-definitions';
-import { Jsonable } from '@fluidframework/datastore-definitions/internal';
-
-/* Excluded from this release type: DataObject */
-
-/* Excluded from this release type: DataObjectFactory */
-
-/* Excluded from this release type: IRuntimeSignaler */
-
-/* Excluded from this release type: ISignaler */
-
-/* Excluded from this release type: Jsonable */
-
-/* Excluded from this release type: Signaler */
-
-/* Excluded from this release type: SignalListener */
-
-export { }

package/dist/data-objects-untrimmed.d.ts

@@ -1,75 +0,0 @@
-import { DataObject } from '@fluidframework/aqueduct/internal';
-import { DataObjectFactory } from '@fluidframework/aqueduct/internal';
-import { EventEmitter } from '@fluid-internal/client-utils';
-import { IErrorEvent } from '@fluidframework/core-interfaces';
-import { IInboundSignalMessage } from '@fluidframework/runtime-definitions';
-import { Jsonable } from '@fluidframework/datastore-definitions/internal';
-
-/**
- * Duck type of something that provides the expected signalling functionality:
- * A way to verify we can signal, a way to send a signal, and a way to listen for incoming signals
- * @internal
- */
-export declare interface IRuntimeSignaler {
-    connected: boolean;
-    on(event: "signal", listener: (message: IInboundSignalMessage, local: boolean) => void): any;
-    submitSignal(type: string, content: Jsonable<unknown>): void;
-}
-
-/**
- * ISignaler defines an interface for working with signals that is similar to the more common
- * eventing patterns of EventEmitter.  In addition to sending and responding to signals, it
- * provides explicit methods around signal requests to other connected clients.
- * @internal
- */
-export declare interface ISignaler {
-    /**
-     * Adds a listener for the specified signal.  It behaves in the same way as EventEmitter's `on`
-     * method regarding multiple registrations, callback order, etc.
-     * @param signalName - The name of the signal
-     * @param listener - The callback signal handler to add
-     * @returns This ISignaler
-     */
-    onSignal<T>(signalName: string, listener: SignalListener<T>): ISignaler;
-    /**
-     * Remove a listener for the specified signal.  It behaves in the same way as EventEmitter's
-     * `off` method regarding multiple registrations, removal order, etc.
-     * @param signalName - The name of the signal
-     * @param listener - The callback signal handler to remove
-     * @returns This ISignaler
-     */
-    offSignal<T>(signalName: string, listener: SignalListener<T>): ISignaler;
-    /**
-     * Send a signal with payload to its connected listeners.
-     * @param signalName - The name of the signal
-     * @param payload - The data to send with the signal
-     */
-    submitSignal<T>(signalName: string, payload?: Jsonable<T>): any;
-}
-
-/**
- * DataObject implementation of ISignaler for fluid-static plug-and-play.  Allows fluid-static
- * users to get an ISignaler without a custom DO.
- * @internal
- */
-export declare class Signaler extends DataObject<{
-    Events: IErrorEvent;
-}> implements EventEmitter, ISignaler {
-    private _signaler;
-    private get signaler();
-    static readonly Name = "@fluid-example/signaler";
-    static readonly factory: DataObjectFactory<Signaler, {
-        Events: IErrorEvent;
-    }>;
-    protected hasInitialized(): Promise<void>;
-    onSignal<T>(signalName: string, listener: SignalListener<T>): ISignaler;
-    offSignal<T>(signalName: string, listener: SignalListener<T>): ISignaler;
-    submitSignal<T>(signalName: string, payload?: Jsonable<T>): void;
-}
-
-/**
- * @internal
- */
-export declare type SignalListener<T> = (clientId: string, local: boolean, payload: Jsonable<T>) => void;
-
-export { }

package/dist/tsdoc-metadata.json

@@ -1,11 +0,0 @@
-// This file is read by tools that parse documentation comments conforming to the TSDoc standard.
-// It should be published with your NPM package.  It should not be tracked by Git.
-{
-  "tsdocVersion": "0.12",
-  "toolPackages": [
-    {
-      "packageName": "@microsoft/api-extractor",
-      "packageVersion": "7.42.3"
-    }
-  ]
-}

package/lib/data-objects-alpha.d.ts

@@ -1,16 +0,0 @@
-import { DataObject } from '@fluidframework/aqueduct/internal';
-import { DataObjectFactory } from '@fluidframework/aqueduct/internal';
-import { EventEmitter } from '@fluid-internal/client-utils';
-import { IErrorEvent } from '@fluidframework/core-interfaces';
-import { IInboundSignalMessage } from '@fluidframework/runtime-definitions';
-import { Jsonable } from '@fluidframework/datastore-definitions/internal';
-
-/* Excluded from this release type: IRuntimeSignaler */
-
-/* Excluded from this release type: ISignaler */
-
-/* Excluded from this release type: Signaler */
-
-/* Excluded from this release type: SignalListener */
-
-export { }

package/lib/data-objects-beta.d.ts

@@ -1,22 +0,0 @@
-import { DataObject } from '@fluidframework/aqueduct/internal';
-import { DataObjectFactory } from '@fluidframework/aqueduct/internal';
-import { EventEmitter } from '@fluid-internal/client-utils';
-import { IErrorEvent } from '@fluidframework/core-interfaces';
-import { IInboundSignalMessage } from '@fluidframework/runtime-definitions';
-import { Jsonable } from '@fluidframework/datastore-definitions/internal';
-
-/* Excluded from this release type: DataObject */
-
-/* Excluded from this release type: DataObjectFactory */
-
-/* Excluded from this release type: IRuntimeSignaler */
-
-/* Excluded from this release type: ISignaler */
-
-/* Excluded from this release type: Jsonable */
-
-/* Excluded from this release type: Signaler */
-
-/* Excluded from this release type: SignalListener */
-
-export { }

package/lib/data-objects-public.d.ts

@@ -1,22 +0,0 @@
-import { DataObject } from '@fluidframework/aqueduct/internal';
-import { DataObjectFactory } from '@fluidframework/aqueduct/internal';
-import { EventEmitter } from '@fluid-internal/client-utils';
-import { IErrorEvent } from '@fluidframework/core-interfaces';
-import { IInboundSignalMessage } from '@fluidframework/runtime-definitions';
-import { Jsonable } from '@fluidframework/datastore-definitions/internal';
-
-/* Excluded from this release type: DataObject */
-
-/* Excluded from this release type: DataObjectFactory */
-
-/* Excluded from this release type: IRuntimeSignaler */
-
-/* Excluded from this release type: ISignaler */
-
-/* Excluded from this release type: Jsonable */
-
-/* Excluded from this release type: Signaler */
-
-/* Excluded from this release type: SignalListener */
-
-export { }

package/lib/data-objects-untrimmed.d.ts

@@ -1,75 +0,0 @@
-import { DataObject } from '@fluidframework/aqueduct/internal';
-import { DataObjectFactory } from '@fluidframework/aqueduct/internal';
-import { EventEmitter } from '@fluid-internal/client-utils';
-import { IErrorEvent } from '@fluidframework/core-interfaces';
-import { IInboundSignalMessage } from '@fluidframework/runtime-definitions';
-import { Jsonable } from '@fluidframework/datastore-definitions/internal';
-
-/**
- * Duck type of something that provides the expected signalling functionality:
- * A way to verify we can signal, a way to send a signal, and a way to listen for incoming signals
- * @internal
- */
-export declare interface IRuntimeSignaler {
-    connected: boolean;
-    on(event: "signal", listener: (message: IInboundSignalMessage, local: boolean) => void): any;
-    submitSignal(type: string, content: Jsonable<unknown>): void;
-}
-
-/**
- * ISignaler defines an interface for working with signals that is similar to the more common
- * eventing patterns of EventEmitter.  In addition to sending and responding to signals, it
- * provides explicit methods around signal requests to other connected clients.
- * @internal
- */
-export declare interface ISignaler {
-    /**
-     * Adds a listener for the specified signal.  It behaves in the same way as EventEmitter's `on`
-     * method regarding multiple registrations, callback order, etc.
-     * @param signalName - The name of the signal
-     * @param listener - The callback signal handler to add
-     * @returns This ISignaler
-     */
-    onSignal<T>(signalName: string, listener: SignalListener<T>): ISignaler;
-    /**
-     * Remove a listener for the specified signal.  It behaves in the same way as EventEmitter's
-     * `off` method regarding multiple registrations, removal order, etc.
-     * @param signalName - The name of the signal
-     * @param listener - The callback signal handler to remove
-     * @returns This ISignaler
-     */
-    offSignal<T>(signalName: string, listener: SignalListener<T>): ISignaler;
-    /**
-     * Send a signal with payload to its connected listeners.
-     * @param signalName - The name of the signal
-     * @param payload - The data to send with the signal
-     */
-    submitSignal<T>(signalName: string, payload?: Jsonable<T>): any;
-}
-
-/**
- * DataObject implementation of ISignaler for fluid-static plug-and-play.  Allows fluid-static
- * users to get an ISignaler without a custom DO.
- * @internal
- */
-export declare class Signaler extends DataObject<{
-    Events: IErrorEvent;
-}> implements EventEmitter, ISignaler {
-    private _signaler;
-    private get signaler();
-    static readonly Name = "@fluid-example/signaler";
-    static readonly factory: DataObjectFactory<Signaler, {
-        Events: IErrorEvent;
-    }>;
-    protected hasInitialized(): Promise<void>;
-    onSignal<T>(signalName: string, listener: SignalListener<T>): ISignaler;
-    offSignal<T>(signalName: string, listener: SignalListener<T>): ISignaler;
-    submitSignal<T>(signalName: string, payload?: Jsonable<T>): void;
-}
-
-/**
- * @internal
- */
-export declare type SignalListener<T> = (clientId: string, local: boolean, payload: Jsonable<T>) => void;
-
-export { }