fluid-framework - npm Package Compare versions

Comparing version 0.47.1 to 0.48.0-38105

dist/index.d.ts

@@ -5,2 +5,3 @@ /*!
  */
+export * from "./containerDefinitions";
 export * from "./fluidStatic";
@@ -7,0 +8,0 @@ export * from "./map";

dist/index.js

@@ -18,2 +18,3 @@ "use strict";
 /* eslint-disable import/export */
+__exportStar(require("./containerDefinitions"), exports);
 __exportStar(require("./fluidStatic"), exports);
@@ -20,0 +21,0 @@ __exportStar(require("./map"), exports);

package.json

 {
   "name": "fluid-framework",
-  "version": "0.47.1",
+  "version": "0.48.0-38105",
   "description": "The main entry point into Fluid Framework public packages",
@@ -15,4 +15,6 @@ "homepage": "https://fluidframework.com",
     "build": "concurrently npm:build:compile npm:lint && npm run build:docs",
-    "build:compile": "npm run tsc",
+    "build:commonjs": "npm run tsc",
+    "build:compile": "concurrently npm:build:commonjs npm:build:esnext",
     "build:docs": "api-extractor run --local --typescript-compiler-folder ../../../node_modules/typescript && copyfiles -u 1 ./_api-extractor-temp/doc-models/* ../../../_api-extractor-temp/",
+    "build:esnext": "tsc --project ./tsconfig.esnext.json",
     "build:full": "npm run build",
@@ -31,8 +33,9 @@ "build:full:compile": "npm run build:compile",
   "dependencies": {
-    "@fluidframework/fluid-static": "^0.47.1",
-    "@fluidframework/map": "^0.47.1",
-    "@fluidframework/sequence": "^0.47.1"
+    "@fluidframework/container-definitions": "^0.39.8",
+    "@fluidframework/fluid-static": "0.48.0-38105",
+    "@fluidframework/map": "0.48.0-38105",
+    "@fluidframework/sequence": "0.48.0-38105"
   },
   "devDependencies": {
-    "@fluidframework/build-common": "^0.23.0",
+    "@fluidframework/build-common": "^0.23.0-0",
     "@fluidframework/eslint-config-fluid": "^0.23.0",
@@ -39,0 +42,0 @@ "@microsoft/api-extractor": "^7.16.1",

README.md

 # fluid-framework
 
-The main entry point into Fluid Framework client packages
+The `fluid-framework` package bundles a collection of Fluid Framework client packages for easy use when paired with a corresponding service client package (ex. `@fluidframework/azure-client` & `@fluidframework/tinylicious-client`).
 
+## Contents
+
+The `fluid-framework` package consists primarily of two portions:  the `IFluidContainer` and a selection of distributed data structures (DDSes).
+
+### IFluidContainer
+
+The **[IFluidContainer][]** interface is the one of the types returned by calls to `createContainer()` and `getContainer()` on the service clients such as `AzureClient`.  It includes functionality to retrieve the Fluid data contained within, as well as to inspect the state of the collaboration session connection.
+
+### DDS packages
+
+You'll use one or more DDS data structures in your container to model your collaborative data.  The `fluid-framework` package comes with three data structures that cover a broad range of scenarios:
+1. **[SharedMap][]**, a map-like data structure for storing key/value pair data
+2. **[SharedDirectory][]**, a map-like data structure with ability to organize keys into subdirectories
+3. **[SharedString][]**, a data structure for string data
+
+## Tutorial
+
+Check out the Hello World tutorial using the `fluid-framework` package [here](https://fluidframework.com/docs/start/tutorial/).
+
 See [GitHub](https://github.com/microsoft/FluidFramework) for more details on the Fluid Framework and packages within.
+
+<!-- Links -->
+[IFluidContainer]: https://fluidframework.com/docs/apis/fluid-static/ifluidcontainer/
+[SharedMap]: https://fluidframework.com/docs/apis/map/sharedmap/
+[SharedDirectory]: https://fluidframework.com/docs/apis/map/shareddirectory/
+[SharedString]: https://fluidframework.com/docs/apis/sequence/sharedstring/

src/index.ts

@@ -8,4 +8,5 @@ /*!
 
+export * from "./containerDefinitions";
 export * from  "./fluidStatic";
 export * from  "./map";
 export * from  "./sequence";

No alert changes

Improved metrics

Total package byte prevSize

20033

increased by74.41%

Number of package files

52

increased by92.59%

Lines of code

237

increased by50%

Number of lines in readme file

31

increased by416.67%

Worsened metrics

Dependency count

4

increased by33.33%

Dependency changes

• + Added@fluidframework/container-definitions@^0.39.8

• + Added@fluidframework/aqueduct@0.48.0-38105(transitive)

• + Added@fluidframework/container-loader@0.48.0-38105(transitive)

• + Added@fluidframework/container-runtime@0.48.0-38105(transitive)

• + Added@fluidframework/container-runtime-definitions@0.48.0-38105(transitive)

• + Added@fluidframework/container-utils@0.48.0-38105(transitive)

• + Added@fluidframework/datastore@0.48.0-38105(transitive)

• + Added@fluidframework/datastore-definitions@0.48.0-38105(transitive)

• + Added@fluidframework/driver-utils@0.48.0-38105(transitive)

• + Added@fluidframework/fluid-static@0.48.0-38105(transitive)

• + Added@fluidframework/garbage-collector@0.48.0-38105(transitive)

• + Added@fluidframework/gitresources@0.1031.0(transitive)

• + Added@fluidframework/map@0.48.0-38105(transitive)

• + Added@fluidframework/merge-tree@0.48.0-38105(transitive)

• + Added@fluidframework/protocol-base@0.1031.0(transitive)

• + Added@fluidframework/request-handler@0.48.0-38105(transitive)

• + Added@fluidframework/runtime-definitions@0.48.0-38105(transitive)

• + Added@fluidframework/runtime-utils@0.48.0-38105(transitive)

• + Added@fluidframework/sequence@0.48.0-38105(transitive)

• + Added@fluidframework/shared-object-base@0.48.0-38105(transitive)

• + Added@fluidframework/synthesize@0.48.0-38105(transitive)

• + Added@fluidframework/telemetry-utils@0.48.0-38105(transitive)

• + Added@fluidframework/view-interfaces@0.48.0-38105(transitive)

• - Removed@fluidframework/aqueduct@0.47.1(transitive)

• - Removed@fluidframework/container-loader@0.47.1(transitive)

• - Removed@fluidframework/container-runtime@0.47.1(transitive)

• - Removed@fluidframework/container-runtime-definitions@0.47.1(transitive)

• - Removed@fluidframework/container-utils@0.47.1(transitive)

• - Removed@fluidframework/datastore@0.47.1(transitive)

• - Removed@fluidframework/datastore-definitions@0.47.1(transitive)

• - Removed@fluidframework/driver-utils@0.47.1(transitive)

• - Removed@fluidframework/fluid-static@0.47.1(transitive)

• - Removed@fluidframework/garbage-collector@0.47.1(transitive)

• - Removed@fluidframework/gitresources@0.1030.0(transitive)

• - Removed@fluidframework/map@0.47.1(transitive)

• - Removed@fluidframework/merge-tree@0.47.1(transitive)

• - Removed@fluidframework/protocol-base@0.1030.0(transitive)

• - Removed@fluidframework/request-handler@0.47.1(transitive)

• - Removed@fluidframework/runtime-definitions@0.47.1(transitive)

• - Removed@fluidframework/runtime-utils@0.47.1(transitive)

• - Removed@fluidframework/sequence@0.47.1(transitive)

• - Removed@fluidframework/shared-object-base@0.47.1(transitive)

• - Removed@fluidframework/synthesize@0.47.1(transitive)

• - Removed@fluidframework/telemetry-utils@0.47.1(transitive)

• - Removed@fluidframework/view-interfaces@0.47.1(transitive)

• Updated@fluidframework/fluid-static@0.48.0-38105

• Updated@fluidframework/map@0.48.0-38105

• Updated@fluidframework/sequence@0.48.0-38105