@fluidframework/core-interfaces 0.40.0 → 0.42.0

package/src/fluidPackage.ts

@@ -4,6 +4,8 @@
  */
 
  /**
+  * @deprecated in favor of {@link @fluidframework/container-definitions/fluidPackage.ts#IFluidPackageEnvironment}
+  * to have code loading modules in same package.
   * Specifies an environment on Fluid property of a IFluidPackage
   */
 export interface IFluidPackageEnvironment {
@@ -30,6 +32,8 @@ export interface IFluidPackageEnvironment {
 }
 
 /**
+ * @deprecated in favor of {@link @fluidframework/container-definitions/fluidPackage.ts#IFluidPackage}
+ * to have code loading modules in same package.
  * Fluid-specific properties expected on a package to be loaded by the code loader.
  * While compatible with the npm package format it is not necessary that that package is an
  * npm package:
@@ -59,6 +63,8 @@ export interface IFluidPackage {
 }
 
 /**
+ * @deprecated in favor of {@link @fluidframework/container-definitions/fluidPackage.ts#isFluidPackage}
+ * to have code loading modules in same package.
  * Check if the package.json defines a Fluid package
  * @param pkg - the package json data to check if it is a Fluid package.
  */
@@ -68,6 +74,8 @@ export const isFluidPackage = (pkg: any): pkg is Readonly<IFluidPackage> =>
     && typeof pkg?.fluid === "object";
 
 /**
+ * @deprecated in favor of {@link @fluidframework/container-definitions/fluidPackage.ts#IFluidCodeDetailsConfig}
+ * to have code loading modules in same package.
  * Package manager configuration. Provides a key value mapping of config values
  */
 export interface IFluidCodeDetailsConfig {
@@ -75,6 +83,8 @@ export interface IFluidCodeDetailsConfig {
 }
 
 /**
+ * @deprecated in favor of {@link @fluidframework/container-definitions/fluidPackage.ts#IFluidCodeDetails}
+ * to have code loading modules in same package.
  * Data structure used to describe the code to load on the Fluid document
  */
 export interface IFluidCodeDetails {
@@ -90,6 +100,10 @@ export interface IFluidCodeDetails {
     readonly config?: IFluidCodeDetailsConfig;
 }
 
+/**
+ * @deprecated  in favor of {@link @fluidframework/container-definitions/fluidPackage.ts#isFluidCodeDetails}
+ * to have code loading modules in same package
+*/
 export const isFluidCodeDetails = (details: unknown): details is Readonly<IFluidCodeDetails> =>{
     const maybeCodeDetails = details as Partial<IFluidCodeDetails> | undefined;
     return typeof maybeCodeDetails === "object"
@@ -97,13 +111,24 @@ export const isFluidCodeDetails = (details: unknown): details is Readonly<IFluid
         && (maybeCodeDetails?.config === undefined || typeof maybeCodeDetails?.config === "object");
 };
 
+/**
+ * @deprecated  in favor of {@link @fluidframework/container-definitions/fluidPackage.ts#IFluidCodeDetailsComparer}
+ * to have code loading modules in same package.
+*/
 export const IFluidCodeDetailsComparer: keyof IProvideFluidCodeDetailsComparer = "IFluidCodeDetailsComparer";
 
+/**
+ * @deprecated  in favor of
+ * {@link @fluidframework/container-definitions/fluidPackage.ts#IProvideFluidCodeDetailsComparer}
+ * to have code loading modules in same package.
+*/
 export interface IProvideFluidCodeDetailsComparer {
     readonly IFluidCodeDetailsComparer: IFluidCodeDetailsComparer ;
 }
 
 /**
+ * @deprecated  in favor of {@link @fluidframework/container-definitions/fluidPackage.ts#IFluidCodeDetailsComparer}
+ * to have code loading modules in same package.
  * Provides capability to compare Fluid code details.
  */
 export interface IFluidCodeDetailsComparer extends IProvideFluidCodeDetailsComparer {

package/src/handles.ts

@@ -6,6 +6,7 @@
 import { IRequest, IResponse } from "./fluidRouter";
 import { IFluidObject } from "./fluidObject";
 import { IFluidLoadable } from "./fluidLoadable";
+import { FluidObject } from "./provider";
 
 export const IFluidHandleContext: keyof IProvideFluidHandleContext = "IFluidHandleContext";
 
@@ -51,8 +52,8 @@ export interface IProvideFluidHandle {
  * Handle to a shared FluidObject
  */
 export interface IFluidHandle<
-    // REVIEW: Constrain `T` to `IFluidObject & IFluidLoadable`?
-    T = IFluidObject & IFluidLoadable
+    // REVIEW: Constrain `T` to something? How do we support dds and datastores safely?
+    T = IFluidObject & FluidObject & IFluidLoadable
     > extends IProvideFluidHandle {
 
     /**

package/src/index.ts

@@ -21,3 +21,4 @@ export {
 export * from "./handles";
 export * from "./serializer";
 export * from "./fluidPackage";
+export * from "./provider";

package/src/provider.ts

@@ -0,0 +1,70 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+/**
+ * @internal
+ * This utility type is meant for internal use by @see FluidObject
+ * Produces a valid FluidObject key given a type and a property.
+ * A valid FluidObject key is a property that exists on the incoming type
+ * as well as on the type of the property itself. For example, IProvideFoo.IFoo.IFoo
+ * This aligns with the FluidObject pattern expected to be used with all FluidObjects.
+ * For example:
+ * ```
+ * interface IProvideFoo{
+ *  IFoo: IFoo
+ * }
+ * interface IFoo extends IProvideFoo{
+ *  foobar();
+ * }
+ * ```
+ * This pattern enables discovery, and delegation in a standard way which is central
+ * to FluidObject pattern
+ */
+ export type FluidObjectProviderKeys<T, TProp extends keyof T = keyof T> =
+    string extends TProp ? never : number extends TProp? never : // exclude indexers [key:string |number]: any
+    TProp extends keyof Exclude<T[TProp], undefined> // TProp is a property of T, and T[TProp]
+        ? TProp
+        :never;
+
+/**
+ * This utility type take interface(s) that follow the FluidObject pattern, and produces
+ * a new type that can be used for inspection and discovery of those interfaces.
+ *
+ * It is meant to be used with types that are known to implement the FluidObject pattern.
+ * A common way to specify a type implements the FluidObject pattern is to expose it as a
+ * FluidObject without a generic argument.
+ *
+ * For example, if we have an interface like below
+ * ```
+ * interface IProvideFoo{
+ *  IFoo: IFoo
+ * }
+ * interface IFoo extends IProvideFoo{
+ *  foobar();
+ * }
+ * ```
+ *
+ * and a function that returns a FluidObject. You would do the following
+ *
+ * `const maybeFoo: FluidObject<IFoo> = getFluidObject()`;
+ *
+ * Either IFoo or IProvideFoo are valid generic arguments. In both case
+ * maybeFoo will be of type `{IFoo?: IFoo}`. If IFoo is not undefined,
+ * then the FluidObject provides IFoo, and it can be used.
+ *
+ * You can inspect multiple types via a intersection. For example:
+ * `FluidObject<IFoo & IBar>`
+ *
+ */
+ export type FluidObject<T = unknown> = Partial<Pick<T, FluidObjectProviderKeys<T>>>;
+
+/**
+ * This utility type creates a type that is the union of all keys on the generic type
+ * which implement the FluidObject pattern. @see FluidObject
+ *
+ * For example `FluidObjectKeys<IFoo & IBar>` would result in `"IFoo" | "IBar"`
+ *
+ */
+export type FluidObjectKeys<T> = keyof FluidObject<T>;

package/src/serializer.ts

@@ -6,6 +6,7 @@ import { IFluidHandle } from "./handles";
 
 /**
  * JSON serialized form of an IFluidHandle
+ * @deprecated - Moved to fluidframework/shared-object-base package
  */
 export interface ISerializedHandle {
     // Marker to indicate to JSON.parse that the object is a Fluid handle
@@ -15,12 +16,21 @@ export interface ISerializedHandle {
     url: string;
 }
 
+/**
+ * @deprecated - Moved to fluidframework/shared-object-base package
+ */
 export const IFluidSerializer: keyof IProvideFluidSerializer = "IFluidSerializer";
 
+/**
+ * @deprecated - Moved to fluidframework/shared-object-base package
+ */
 export interface IProvideFluidSerializer {
     readonly IFluidSerializer: IFluidSerializer;
 }
 
+/**
+ * @deprecated - Moved to fluidframework/shared-object-base package
+ */
 export interface IFluidSerializer extends IProvideFluidSerializer {
     /**
      * Given a mostly-plain object that may have handle objects embedded within, will return a fully-plain object

package/tsconfig.json

@@ -2,7 +2,8 @@
     "extends": "@fluidframework/build-common/ts-common-config.json",
     "exclude": [
         "dist",
-        "node_modules"
+        "node_modules",
+        "test-d"
     ],
     "compilerOptions": {
         "rootDir": "./src",
@@ -11,4 +12,4 @@
     "include": [
         "src/**/*"
     ]
-}
+}