@fluidframework/core-interfaces 2.0.0-internal.2.0.2 → 2.0.0-internal.2.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,4 +1,4 @@
1
1
  {
2
2
  "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
3
- "extends": "@fluidframework/build-common/api-extractor-common-report.json"
3
+ "extends": "@fluidframework/build-common/api-extractor-common-strict.json"
4
4
  }
package/dist/handles.d.ts CHANGED
@@ -10,7 +10,7 @@ export interface IProvideFluidHandleContext {
10
10
  readonly IFluidHandleContext: IFluidHandleContext;
11
11
  }
12
12
  /**
13
- * An IFluidHandleContext describes a routing context from which other IFluidHandleContexts are defined
13
+ * Describes a routing context from which other `IFluidHandleContext`s are defined.
14
14
  */
15
15
  export interface IFluidHandleContext extends IProvideFluidHandleContext {
16
16
  /**
@@ -37,7 +37,7 @@ export interface IProvideFluidHandle {
37
37
  readonly IFluidHandle: IFluidHandle;
38
38
  }
39
39
  /**
40
- * Handle to a shared FluidObject
40
+ * Handle to a shared {@link FluidObject}.
41
41
  */
42
42
  export interface IFluidHandle<T = FluidObject & IFluidLoadable> extends IProvideFluidHandle {
43
43
  /**
@@ -1 +1 @@
1
- {"version":3,"file":"handles.js","sourceRoot":"","sources":["../src/handles.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAMU,QAAA,mBAAmB,GAAqC,qBAAqB,CAAC;AAkC9E,QAAA,YAAY,GAA8B,cAAc,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { IRequest, IResponse } from \"./fluidRouter\";\nimport { IFluidLoadable } from \"./fluidLoadable\";\nimport { FluidObject } from \"./provider\";\n\nexport const IFluidHandleContext: keyof IProvideFluidHandleContext = \"IFluidHandleContext\";\n\nexport interface IProvideFluidHandleContext {\n readonly IFluidHandleContext: IFluidHandleContext;\n}\n\n/**\n * An IFluidHandleContext describes a routing context from which other IFluidHandleContexts are defined\n */\nexport interface IFluidHandleContext extends IProvideFluidHandleContext {\n /**\n * The absolute path to the handle context from the root.\n */\n readonly absolutePath: string;\n\n /**\n * The parent IFluidHandleContext that has provided a route path to this IFluidHandleContext or undefined\n * at the root.\n */\n readonly routeContext?: IFluidHandleContext;\n\n /**\n * Flag indicating whether or not the entity has services attached.\n */\n readonly isAttached: boolean;\n\n /**\n * Runs through the graph and attach the bounded handles.\n */\n attachGraph(): void;\n\n resolveHandle(request: IRequest): Promise<IResponse>;\n}\n\nexport const IFluidHandle: keyof IProvideFluidHandle = \"IFluidHandle\";\n\nexport interface IProvideFluidHandle {\n readonly IFluidHandle: IFluidHandle;\n}\n\n/**\n * Handle to a shared FluidObject\n */\nexport interface IFluidHandle<\n // REVIEW: Constrain `T` to something? How do we support dds and datastores safely?\n T = FluidObject & IFluidLoadable,\n > extends IProvideFluidHandle {\n\n /**\n * @deprecated Do not use handle's path for routing. Use `get` to get the underlying object.\n *\n * The absolute path to the handle context from the root.\n */\n readonly absolutePath: string;\n\n /**\n * Flag indicating whether or not the entity has services attached.\n */\n readonly isAttached: boolean;\n\n /**\n * Runs through the graph and attach the bounded handles.\n */\n attachGraph(): void;\n\n /**\n * Returns a promise to the Fluid Object referenced by the handle.\n */\n get(): Promise<T>;\n\n /**\n * Binds the given handle to this one or attach the given handle if this handle is attached.\n * A bound handle will also be attached once this handle is attached.\n */\n bind(handle: IFluidHandle): void;\n}\n"]}
1
+ {"version":3,"file":"handles.js","sourceRoot":"","sources":["../src/handles.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAMU,QAAA,mBAAmB,GAAqC,qBAAqB,CAAC;AAkC9E,QAAA,YAAY,GAA8B,cAAc,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { IRequest, IResponse } from \"./fluidRouter\";\nimport { IFluidLoadable } from \"./fluidLoadable\";\nimport { FluidObject } from \"./provider\";\n\nexport const IFluidHandleContext: keyof IProvideFluidHandleContext = \"IFluidHandleContext\";\n\nexport interface IProvideFluidHandleContext {\n readonly IFluidHandleContext: IFluidHandleContext;\n}\n\n/**\n * Describes a routing context from which other `IFluidHandleContext`s are defined.\n */\nexport interface IFluidHandleContext extends IProvideFluidHandleContext {\n /**\n * The absolute path to the handle context from the root.\n */\n readonly absolutePath: string;\n\n /**\n * The parent IFluidHandleContext that has provided a route path to this IFluidHandleContext or undefined\n * at the root.\n */\n readonly routeContext?: IFluidHandleContext;\n\n /**\n * Flag indicating whether or not the entity has services attached.\n */\n readonly isAttached: boolean;\n\n /**\n * Runs through the graph and attach the bounded handles.\n */\n attachGraph(): void;\n\n resolveHandle(request: IRequest): Promise<IResponse>;\n}\n\nexport const IFluidHandle: keyof IProvideFluidHandle = \"IFluidHandle\";\n\nexport interface IProvideFluidHandle {\n readonly IFluidHandle: IFluidHandle;\n}\n\n/**\n * Handle to a shared {@link FluidObject}.\n */\nexport interface IFluidHandle<\n // REVIEW: Constrain `T` to something? How do we support dds and datastores safely?\n T = FluidObject & IFluidLoadable,\n > extends IProvideFluidHandle {\n\n /**\n * @deprecated Do not use handle's path for routing. Use `get` to get the underlying object.\n *\n * The absolute path to the handle context from the root.\n */\n readonly absolutePath: string;\n\n /**\n * Flag indicating whether or not the entity has services attached.\n */\n readonly isAttached: boolean;\n\n /**\n * Runs through the graph and attach the bounded handles.\n */\n attachGraph(): void;\n\n /**\n * Returns a promise to the Fluid Object referenced by the handle.\n */\n get(): Promise<T>;\n\n /**\n * Binds the given handle to this one or attach the given handle if this handle is attached.\n * A bound handle will also be attached once this handle is attached.\n */\n bind(handle: IFluidHandle): void;\n}\n"]}
package/dist/index.d.ts CHANGED
@@ -3,9 +3,9 @@
3
3
  * Licensed under the MIT License.
4
4
  */
5
5
  export { IFluidObject } from "./fluidObject";
6
- export * from "./fluidLoadable";
6
+ export { IFluidLoadable, IProvideFluidLoadable, IFluidRunnable, IProvideFluidRunnable, } from "./fluidLoadable";
7
7
  export { IRequest, IRequestHeader, IResponse, IProvideFluidRouter, IFluidRouter, } from "./fluidRouter";
8
- export * from "./handles";
9
- export * from "./fluidPackage";
10
- export * from "./provider";
8
+ export { IFluidHandleContext, IProvideFluidHandleContext, IFluidHandle, IProvideFluidHandle, } from "./handles";
9
+ export { IFluidPackageEnvironment, IFluidPackage, isFluidPackage, IFluidCodeDetailsConfig, IFluidCodeDetails, isFluidCodeDetails, IFluidCodeDetailsComparer, IProvideFluidCodeDetailsComparer, } from "./fluidPackage";
10
+ export { FluidObjectProviderKeys, FluidObject, FluidObjectKeys, } from "./provider";
11
11
  //# sourceMappingURL=index.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAE7C,cAAc,iBAAiB,CAAC;AAIhC,OAAO,EACH,QAAQ,EACR,cAAc,EACd,SAAS,EACT,mBAAmB,EACnB,YAAY,GACf,MAAM,eAAe,CAAC;AACvB,cAAc,WAAW,CAAC;AAC1B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,YAAY,CAAC"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAE7C,OAAO,EACH,cAAc,EACd,qBAAqB,EACrB,cAAc,EACd,qBAAqB,GACxB,MAAM,iBAAiB,CAAC;AAKzB,OAAO,EACH,QAAQ,EACR,cAAc,EACd,SAAS,EACT,mBAAmB,EACnB,YAAY,GACf,MAAM,eAAe,CAAC;AAEvB,OAAO,EACH,mBAAmB,EACnB,0BAA0B,EAC1B,YAAY,EACZ,mBAAmB,GACtB,MAAM,WAAW,CAAC;AAEnB,OAAO,EACH,wBAAwB,EACxB,aAAa,EACb,cAAc,EACd,uBAAuB,EACvB,iBAAiB,EACjB,kBAAkB,EAClB,yBAAyB,EACzB,gCAAgC,GACnC,MAAM,gBAAgB,CAAC;AAExB,OAAO,EACH,uBAAuB,EACvB,WAAW,EACX,eAAe,GAClB,MAAM,YAAY,CAAC"}
package/dist/index.js CHANGED
@@ -3,25 +3,21 @@
3
3
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
4
4
  * Licensed under the MIT License.
5
5
  */
6
- var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
7
- if (k2 === undefined) k2 = k;
8
- Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
9
- }) : (function(o, m, k, k2) {
10
- if (k2 === undefined) k2 = k;
11
- o[k2] = m[k];
12
- }));
13
- var __exportStar = (this && this.__exportStar) || function(m, exports) {
14
- for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
15
- };
16
6
  Object.defineProperty(exports, "__esModule", { value: true });
17
- exports.IFluidRouter = void 0;
18
- __exportStar(require("./fluidLoadable"), exports);
7
+ exports.IFluidCodeDetailsComparer = exports.isFluidCodeDetails = exports.isFluidPackage = exports.IFluidHandle = exports.IFluidHandleContext = exports.IFluidRouter = exports.IFluidRunnable = exports.IFluidLoadable = void 0;
8
+ var fluidLoadable_1 = require("./fluidLoadable");
9
+ Object.defineProperty(exports, "IFluidLoadable", { enumerable: true, get: function () { return fluidLoadable_1.IFluidLoadable; } });
10
+ Object.defineProperty(exports, "IFluidRunnable", { enumerable: true, get: function () { return fluidLoadable_1.IFluidRunnable; } });
19
11
  // Typescript forgets the index signature when customers augment IRequestHeader if we export *.
20
12
  // So we export the explicit members as a workaround:
21
13
  // https://github.com/microsoft/TypeScript/issues/18877#issuecomment-476921038
22
14
  var fluidRouter_1 = require("./fluidRouter");
23
15
  Object.defineProperty(exports, "IFluidRouter", { enumerable: true, get: function () { return fluidRouter_1.IFluidRouter; } });
24
- __exportStar(require("./handles"), exports);
25
- __exportStar(require("./fluidPackage"), exports);
26
- __exportStar(require("./provider"), exports);
16
+ var handles_1 = require("./handles");
17
+ Object.defineProperty(exports, "IFluidHandleContext", { enumerable: true, get: function () { return handles_1.IFluidHandleContext; } });
18
+ Object.defineProperty(exports, "IFluidHandle", { enumerable: true, get: function () { return handles_1.IFluidHandle; } });
19
+ var fluidPackage_1 = require("./fluidPackage");
20
+ Object.defineProperty(exports, "isFluidPackage", { enumerable: true, get: function () { return fluidPackage_1.isFluidPackage; } });
21
+ Object.defineProperty(exports, "isFluidCodeDetails", { enumerable: true, get: function () { return fluidPackage_1.isFluidCodeDetails; } });
22
+ Object.defineProperty(exports, "IFluidCodeDetailsComparer", { enumerable: true, get: function () { return fluidPackage_1.IFluidCodeDetailsComparer; } });
27
23
  //# sourceMappingURL=index.js.map
package/dist/index.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;;;;;;;;;;;AAMH,kDAAgC;AAChC,+FAA+F;AAC/F,qDAAqD;AACrD,8EAA8E;AAC9E,6CAMuB;AADnB,2GAAA,YAAY,OAAA;AAEhB,4CAA0B;AAC1B,iDAA+B;AAC/B,6CAA2B","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\n// when merging declarations the module path must match exactly. Because of this we need to explicitly export\n// IFluidObject as opposed to an export *\nexport { IFluidObject } from \"./fluidObject\";\n\nexport * from \"./fluidLoadable\";\n// Typescript forgets the index signature when customers augment IRequestHeader if we export *.\n// So we export the explicit members as a workaround:\n// https://github.com/microsoft/TypeScript/issues/18877#issuecomment-476921038\nexport {\n IRequest,\n IRequestHeader,\n IResponse,\n IProvideFluidRouter,\n IFluidRouter,\n} from \"./fluidRouter\";\nexport * from \"./handles\";\nexport * from \"./fluidPackage\";\nexport * from \"./provider\";\n"]}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAMH,iDAKyB;AAJrB,+GAAA,cAAc,OAAA;AAEd,+GAAA,cAAc,OAAA;AAIlB,+FAA+F;AAC/F,qDAAqD;AACrD,8EAA8E;AAC9E,6CAMuB;AADnB,2GAAA,YAAY,OAAA;AAGhB,qCAKmB;AAJf,8GAAA,mBAAmB,OAAA;AAEnB,uGAAA,YAAY,OAAA;AAIhB,+CASwB;AANpB,8GAAA,cAAc,OAAA;AAGd,kHAAA,kBAAkB,OAAA;AAClB,yHAAA,yBAAyB,OAAA","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\n// when merging declarations the module path must match exactly. Because of this we need to explicitly export\n// IFluidObject as opposed to an export *\nexport { IFluidObject } from \"./fluidObject\";\n\nexport {\n IFluidLoadable,\n IProvideFluidLoadable,\n IFluidRunnable,\n IProvideFluidRunnable,\n} from \"./fluidLoadable\";\n\n// Typescript forgets the index signature when customers augment IRequestHeader if we export *.\n// So we export the explicit members as a workaround:\n// https://github.com/microsoft/TypeScript/issues/18877#issuecomment-476921038\nexport {\n IRequest,\n IRequestHeader,\n IResponse,\n IProvideFluidRouter,\n IFluidRouter,\n} from \"./fluidRouter\";\n\nexport {\n IFluidHandleContext,\n IProvideFluidHandleContext,\n IFluidHandle,\n IProvideFluidHandle,\n} from \"./handles\";\n\nexport {\n IFluidPackageEnvironment,\n IFluidPackage,\n isFluidPackage,\n IFluidCodeDetailsConfig,\n IFluidCodeDetails,\n isFluidCodeDetails,\n IFluidCodeDetailsComparer,\n IProvideFluidCodeDetailsComparer,\n} from \"./fluidPackage\";\n\nexport {\n FluidObjectProviderKeys,\n FluidObject,\n FluidObjectKeys,\n} from \"./provider\";\n"]}
package/lib/handles.d.ts CHANGED
@@ -10,7 +10,7 @@ export interface IProvideFluidHandleContext {
10
10
  readonly IFluidHandleContext: IFluidHandleContext;
11
11
  }
12
12
  /**
13
- * An IFluidHandleContext describes a routing context from which other IFluidHandleContexts are defined
13
+ * Describes a routing context from which other `IFluidHandleContext`s are defined.
14
14
  */
15
15
  export interface IFluidHandleContext extends IProvideFluidHandleContext {
16
16
  /**
@@ -37,7 +37,7 @@ export interface IProvideFluidHandle {
37
37
  readonly IFluidHandle: IFluidHandle;
38
38
  }
39
39
  /**
40
- * Handle to a shared FluidObject
40
+ * Handle to a shared {@link FluidObject}.
41
41
  */
42
42
  export interface IFluidHandle<T = FluidObject & IFluidLoadable> extends IProvideFluidHandle {
43
43
  /**
@@ -1 +1 @@
1
- {"version":3,"file":"handles.js","sourceRoot":"","sources":["../src/handles.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAMH,MAAM,CAAC,MAAM,mBAAmB,GAAqC,qBAAqB,CAAC;AAkC3F,MAAM,CAAC,MAAM,YAAY,GAA8B,cAAc,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { IRequest, IResponse } from \"./fluidRouter\";\nimport { IFluidLoadable } from \"./fluidLoadable\";\nimport { FluidObject } from \"./provider\";\n\nexport const IFluidHandleContext: keyof IProvideFluidHandleContext = \"IFluidHandleContext\";\n\nexport interface IProvideFluidHandleContext {\n readonly IFluidHandleContext: IFluidHandleContext;\n}\n\n/**\n * An IFluidHandleContext describes a routing context from which other IFluidHandleContexts are defined\n */\nexport interface IFluidHandleContext extends IProvideFluidHandleContext {\n /**\n * The absolute path to the handle context from the root.\n */\n readonly absolutePath: string;\n\n /**\n * The parent IFluidHandleContext that has provided a route path to this IFluidHandleContext or undefined\n * at the root.\n */\n readonly routeContext?: IFluidHandleContext;\n\n /**\n * Flag indicating whether or not the entity has services attached.\n */\n readonly isAttached: boolean;\n\n /**\n * Runs through the graph and attach the bounded handles.\n */\n attachGraph(): void;\n\n resolveHandle(request: IRequest): Promise<IResponse>;\n}\n\nexport const IFluidHandle: keyof IProvideFluidHandle = \"IFluidHandle\";\n\nexport interface IProvideFluidHandle {\n readonly IFluidHandle: IFluidHandle;\n}\n\n/**\n * Handle to a shared FluidObject\n */\nexport interface IFluidHandle<\n // REVIEW: Constrain `T` to something? How do we support dds and datastores safely?\n T = FluidObject & IFluidLoadable,\n > extends IProvideFluidHandle {\n\n /**\n * @deprecated Do not use handle's path for routing. Use `get` to get the underlying object.\n *\n * The absolute path to the handle context from the root.\n */\n readonly absolutePath: string;\n\n /**\n * Flag indicating whether or not the entity has services attached.\n */\n readonly isAttached: boolean;\n\n /**\n * Runs through the graph and attach the bounded handles.\n */\n attachGraph(): void;\n\n /**\n * Returns a promise to the Fluid Object referenced by the handle.\n */\n get(): Promise<T>;\n\n /**\n * Binds the given handle to this one or attach the given handle if this handle is attached.\n * A bound handle will also be attached once this handle is attached.\n */\n bind(handle: IFluidHandle): void;\n}\n"]}
1
+ {"version":3,"file":"handles.js","sourceRoot":"","sources":["../src/handles.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAMH,MAAM,CAAC,MAAM,mBAAmB,GAAqC,qBAAqB,CAAC;AAkC3F,MAAM,CAAC,MAAM,YAAY,GAA8B,cAAc,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { IRequest, IResponse } from \"./fluidRouter\";\nimport { IFluidLoadable } from \"./fluidLoadable\";\nimport { FluidObject } from \"./provider\";\n\nexport const IFluidHandleContext: keyof IProvideFluidHandleContext = \"IFluidHandleContext\";\n\nexport interface IProvideFluidHandleContext {\n readonly IFluidHandleContext: IFluidHandleContext;\n}\n\n/**\n * Describes a routing context from which other `IFluidHandleContext`s are defined.\n */\nexport interface IFluidHandleContext extends IProvideFluidHandleContext {\n /**\n * The absolute path to the handle context from the root.\n */\n readonly absolutePath: string;\n\n /**\n * The parent IFluidHandleContext that has provided a route path to this IFluidHandleContext or undefined\n * at the root.\n */\n readonly routeContext?: IFluidHandleContext;\n\n /**\n * Flag indicating whether or not the entity has services attached.\n */\n readonly isAttached: boolean;\n\n /**\n * Runs through the graph and attach the bounded handles.\n */\n attachGraph(): void;\n\n resolveHandle(request: IRequest): Promise<IResponse>;\n}\n\nexport const IFluidHandle: keyof IProvideFluidHandle = \"IFluidHandle\";\n\nexport interface IProvideFluidHandle {\n readonly IFluidHandle: IFluidHandle;\n}\n\n/**\n * Handle to a shared {@link FluidObject}.\n */\nexport interface IFluidHandle<\n // REVIEW: Constrain `T` to something? How do we support dds and datastores safely?\n T = FluidObject & IFluidLoadable,\n > extends IProvideFluidHandle {\n\n /**\n * @deprecated Do not use handle's path for routing. Use `get` to get the underlying object.\n *\n * The absolute path to the handle context from the root.\n */\n readonly absolutePath: string;\n\n /**\n * Flag indicating whether or not the entity has services attached.\n */\n readonly isAttached: boolean;\n\n /**\n * Runs through the graph and attach the bounded handles.\n */\n attachGraph(): void;\n\n /**\n * Returns a promise to the Fluid Object referenced by the handle.\n */\n get(): Promise<T>;\n\n /**\n * Binds the given handle to this one or attach the given handle if this handle is attached.\n * A bound handle will also be attached once this handle is attached.\n */\n bind(handle: IFluidHandle): void;\n}\n"]}
package/lib/index.d.ts CHANGED
@@ -3,9 +3,9 @@
3
3
  * Licensed under the MIT License.
4
4
  */
5
5
  export { IFluidObject } from "./fluidObject";
6
- export * from "./fluidLoadable";
6
+ export { IFluidLoadable, IProvideFluidLoadable, IFluidRunnable, IProvideFluidRunnable, } from "./fluidLoadable";
7
7
  export { IRequest, IRequestHeader, IResponse, IProvideFluidRouter, IFluidRouter, } from "./fluidRouter";
8
- export * from "./handles";
9
- export * from "./fluidPackage";
10
- export * from "./provider";
8
+ export { IFluidHandleContext, IProvideFluidHandleContext, IFluidHandle, IProvideFluidHandle, } from "./handles";
9
+ export { IFluidPackageEnvironment, IFluidPackage, isFluidPackage, IFluidCodeDetailsConfig, IFluidCodeDetails, isFluidCodeDetails, IFluidCodeDetailsComparer, IProvideFluidCodeDetailsComparer, } from "./fluidPackage";
10
+ export { FluidObjectProviderKeys, FluidObject, FluidObjectKeys, } from "./provider";
11
11
  //# sourceMappingURL=index.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAE7C,cAAc,iBAAiB,CAAC;AAIhC,OAAO,EACH,QAAQ,EACR,cAAc,EACd,SAAS,EACT,mBAAmB,EACnB,YAAY,GACf,MAAM,eAAe,CAAC;AACvB,cAAc,WAAW,CAAC;AAC1B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,YAAY,CAAC"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAE7C,OAAO,EACH,cAAc,EACd,qBAAqB,EACrB,cAAc,EACd,qBAAqB,GACxB,MAAM,iBAAiB,CAAC;AAKzB,OAAO,EACH,QAAQ,EACR,cAAc,EACd,SAAS,EACT,mBAAmB,EACnB,YAAY,GACf,MAAM,eAAe,CAAC;AAEvB,OAAO,EACH,mBAAmB,EACnB,0BAA0B,EAC1B,YAAY,EACZ,mBAAmB,GACtB,MAAM,WAAW,CAAC;AAEnB,OAAO,EACH,wBAAwB,EACxB,aAAa,EACb,cAAc,EACd,uBAAuB,EACvB,iBAAiB,EACjB,kBAAkB,EAClB,yBAAyB,EACzB,gCAAgC,GACnC,MAAM,gBAAgB,CAAC;AAExB,OAAO,EACH,uBAAuB,EACvB,WAAW,EACX,eAAe,GAClB,MAAM,YAAY,CAAC"}
package/lib/index.js CHANGED
@@ -2,12 +2,11 @@
2
2
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
3
3
  * Licensed under the MIT License.
4
4
  */
5
- export * from "./fluidLoadable";
5
+ export { IFluidLoadable, IFluidRunnable, } from "./fluidLoadable";
6
6
  // Typescript forgets the index signature when customers augment IRequestHeader if we export *.
7
7
  // So we export the explicit members as a workaround:
8
8
  // https://github.com/microsoft/TypeScript/issues/18877#issuecomment-476921038
9
9
  export { IFluidRouter, } from "./fluidRouter";
10
- export * from "./handles";
11
- export * from "./fluidPackage";
12
- export * from "./provider";
10
+ export { IFluidHandleContext, IFluidHandle, } from "./handles";
11
+ export { isFluidPackage, isFluidCodeDetails, IFluidCodeDetailsComparer, } from "./fluidPackage";
13
12
  //# sourceMappingURL=index.js.map
package/lib/index.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAMH,cAAc,iBAAiB,CAAC;AAChC,+FAA+F;AAC/F,qDAAqD;AACrD,8EAA8E;AAC9E,OAAO,EAKH,YAAY,GACf,MAAM,eAAe,CAAC;AACvB,cAAc,WAAW,CAAC;AAC1B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,YAAY,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\n// when merging declarations the module path must match exactly. Because of this we need to explicitly export\n// IFluidObject as opposed to an export *\nexport { IFluidObject } from \"./fluidObject\";\n\nexport * from \"./fluidLoadable\";\n// Typescript forgets the index signature when customers augment IRequestHeader if we export *.\n// So we export the explicit members as a workaround:\n// https://github.com/microsoft/TypeScript/issues/18877#issuecomment-476921038\nexport {\n IRequest,\n IRequestHeader,\n IResponse,\n IProvideFluidRouter,\n IFluidRouter,\n} from \"./fluidRouter\";\nexport * from \"./handles\";\nexport * from \"./fluidPackage\";\nexport * from \"./provider\";\n"]}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAMH,OAAO,EACH,cAAc,EAEd,cAAc,GAEjB,MAAM,iBAAiB,CAAC;AAEzB,+FAA+F;AAC/F,qDAAqD;AACrD,8EAA8E;AAC9E,OAAO,EAKH,YAAY,GACf,MAAM,eAAe,CAAC;AAEvB,OAAO,EACH,mBAAmB,EAEnB,YAAY,GAEf,MAAM,WAAW,CAAC;AAEnB,OAAO,EAGH,cAAc,EAGd,kBAAkB,EAClB,yBAAyB,GAE5B,MAAM,gBAAgB,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\n// when merging declarations the module path must match exactly. Because of this we need to explicitly export\n// IFluidObject as opposed to an export *\nexport { IFluidObject } from \"./fluidObject\";\n\nexport {\n IFluidLoadable,\n IProvideFluidLoadable,\n IFluidRunnable,\n IProvideFluidRunnable,\n} from \"./fluidLoadable\";\n\n// Typescript forgets the index signature when customers augment IRequestHeader if we export *.\n// So we export the explicit members as a workaround:\n// https://github.com/microsoft/TypeScript/issues/18877#issuecomment-476921038\nexport {\n IRequest,\n IRequestHeader,\n IResponse,\n IProvideFluidRouter,\n IFluidRouter,\n} from \"./fluidRouter\";\n\nexport {\n IFluidHandleContext,\n IProvideFluidHandleContext,\n IFluidHandle,\n IProvideFluidHandle,\n} from \"./handles\";\n\nexport {\n IFluidPackageEnvironment,\n IFluidPackage,\n isFluidPackage,\n IFluidCodeDetailsConfig,\n IFluidCodeDetails,\n isFluidCodeDetails,\n IFluidCodeDetailsComparer,\n IProvideFluidCodeDetailsComparer,\n} from \"./fluidPackage\";\n\nexport {\n FluidObjectProviderKeys,\n FluidObject,\n FluidObjectKeys,\n} from \"./provider\";\n"]}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@fluidframework/core-interfaces",
3
- "version": "2.0.0-internal.2.0.2",
3
+ "version": "2.0.0-internal.2.1.0",
4
4
  "description": "Fluid object interfaces",
5
5
  "homepage": "https://fluidframework.com",
6
6
  "repository": {
@@ -32,15 +32,14 @@
32
32
  "lint:fix": "npm run eslint:fix",
33
33
  "tsc": "tsc",
34
34
  "tsc:watch": "tsc --watch",
35
- "tsfmt": "tsfmt --verify",
36
- "tsfmt:fix": "tsfmt --replace",
37
35
  "typetests:gen": "fluid-type-validator -g -d ."
38
36
  },
39
37
  "devDependencies": {
40
- "@fluidframework/build-common": "^1.0.0",
41
- "@fluidframework/build-tools": "^0.4.6000",
38
+ "@fluid-tools/build-cli": "^0.5.0",
39
+ "@fluidframework/build-common": "^1.1.0",
40
+ "@fluidframework/build-tools": "^0.5.0",
42
41
  "@fluidframework/core-interfaces-previous": "npm:@fluidframework/core-interfaces@2.0.0-internal.2.0.0",
43
- "@fluidframework/eslint-config-fluid": "^1.0.0",
42
+ "@fluidframework/eslint-config-fluid": "^1.1.0",
44
43
  "@microsoft/api-extractor": "^7.22.2",
45
44
  "@rushstack/eslint-config": "^2.5.1",
46
45
  "@types/node": "^14.18.0",
@@ -48,11 +47,10 @@
48
47
  "copyfiles": "^2.4.1",
49
48
  "eslint": "~8.6.0",
50
49
  "rimraf": "^2.6.2",
51
- "typescript": "~4.5.5",
52
- "typescript-formatter": "7.1.0"
50
+ "typescript": "~4.5.5"
53
51
  },
54
52
  "typeValidation": {
55
- "version": "2.0.0-internal.2.0.1",
53
+ "version": "2.0.0-internal.2.1.0",
56
54
  "broken": {}
57
55
  }
58
56
  }
package/src/handles.ts CHANGED
@@ -14,7 +14,7 @@ export interface IProvideFluidHandleContext {
14
14
  }
15
15
 
16
16
  /**
17
- * An IFluidHandleContext describes a routing context from which other IFluidHandleContexts are defined
17
+ * Describes a routing context from which other `IFluidHandleContext`s are defined.
18
18
  */
19
19
  export interface IFluidHandleContext extends IProvideFluidHandleContext {
20
20
  /**
@@ -48,7 +48,7 @@ export interface IProvideFluidHandle {
48
48
  }
49
49
 
50
50
  /**
51
- * Handle to a shared FluidObject
51
+ * Handle to a shared {@link FluidObject}.
52
52
  */
53
53
  export interface IFluidHandle<
54
54
  // REVIEW: Constrain `T` to something? How do we support dds and datastores safely?
package/src/index.ts CHANGED
@@ -7,7 +7,13 @@
7
7
  // IFluidObject as opposed to an export *
8
8
  export { IFluidObject } from "./fluidObject";
9
9
 
10
- export * from "./fluidLoadable";
10
+ export {
11
+ IFluidLoadable,
12
+ IProvideFluidLoadable,
13
+ IFluidRunnable,
14
+ IProvideFluidRunnable,
15
+ } from "./fluidLoadable";
16
+
11
17
  // Typescript forgets the index signature when customers augment IRequestHeader if we export *.
12
18
  // So we export the explicit members as a workaround:
13
19
  // https://github.com/microsoft/TypeScript/issues/18877#issuecomment-476921038
@@ -18,6 +24,27 @@ export {
18
24
  IProvideFluidRouter,
19
25
  IFluidRouter,
20
26
  } from "./fluidRouter";
21
- export * from "./handles";
22
- export * from "./fluidPackage";
23
- export * from "./provider";
27
+
28
+ export {
29
+ IFluidHandleContext,
30
+ IProvideFluidHandleContext,
31
+ IFluidHandle,
32
+ IProvideFluidHandle,
33
+ } from "./handles";
34
+
35
+ export {
36
+ IFluidPackageEnvironment,
37
+ IFluidPackage,
38
+ isFluidPackage,
39
+ IFluidCodeDetailsConfig,
40
+ IFluidCodeDetails,
41
+ isFluidCodeDetails,
42
+ IFluidCodeDetailsComparer,
43
+ IProvideFluidCodeDetailsComparer,
44
+ } from "./fluidPackage";
45
+
46
+ export {
47
+ FluidObjectProviderKeys,
48
+ FluidObject,
49
+ FluidObjectKeys,
50
+ } from "./provider";