@fluidframework/core-interfaces 1.1.0-75972 → 1.2.0-77818
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.
- package/dist/provider.d.ts +8 -4
- package/dist/provider.d.ts.map +1 -1
- package/dist/provider.js.map +1 -1
- package/lib/provider.d.ts +8 -4
- package/lib/provider.d.ts.map +1 -1
- package/lib/provider.js.map +1 -1
- package/package.json +5 -5
- package/src/provider.ts +10 -6
package/dist/provider.d.ts
CHANGED
|
@@ -3,12 +3,12 @@
|
|
|
3
3
|
* Licensed under the MIT License.
|
|
4
4
|
*/
|
|
5
5
|
/**
|
|
6
|
-
* @
|
|
7
|
-
* This utility type is meant for internal use by @see FluidObject
|
|
6
|
+
* This utility type is meant for internal use by {@link FluidObject}
|
|
8
7
|
* Produces a valid FluidObject key given a type and a property.
|
|
9
8
|
* A valid FluidObject key is a property that exists on the incoming type
|
|
10
|
-
* as well as on the type of the property itself. For example
|
|
9
|
+
* as well as on the type of the property itself. For example: `IProvideFoo.IFoo.IFoo`
|
|
11
10
|
* This aligns with the FluidObject pattern expected to be used with all FluidObjects.
|
|
11
|
+
*
|
|
12
12
|
* For example:
|
|
13
13
|
* ```
|
|
14
14
|
* interface IProvideFoo{
|
|
@@ -20,6 +20,8 @@
|
|
|
20
20
|
* ```
|
|
21
21
|
* This pattern enables discovery, and delegation in a standard way which is central
|
|
22
22
|
* to FluidObject pattern
|
|
23
|
+
*
|
|
24
|
+
* @internal
|
|
23
25
|
*/
|
|
24
26
|
export declare type FluidObjectProviderKeys<T, TProp extends keyof T = keyof T> = string extends TProp ? never : number extends TProp ? never : TProp extends keyof Required<T>[TProp] ? Required<T>[TProp] extends Required<Required<T>[TProp]>[TProp] ? TProp : never : never;
|
|
25
27
|
/**
|
|
@@ -57,7 +59,9 @@ export declare type FluidObject<T = unknown> = {
|
|
|
57
59
|
};
|
|
58
60
|
/**
|
|
59
61
|
* This utility type creates a type that is the union of all keys on the generic type
|
|
60
|
-
* which implement the FluidObject pattern.
|
|
62
|
+
* which implement the FluidObject pattern.
|
|
63
|
+
*
|
|
64
|
+
* See {@link FluidObject}
|
|
61
65
|
*
|
|
62
66
|
* For example `FluidObjectKeys<IFoo & IBar>` would result in `"IFoo" | "IBar"`
|
|
63
67
|
*
|
package/dist/provider.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"provider.d.ts","sourceRoot":"","sources":["../src/provider.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH
|
|
1
|
+
{"version":3,"file":"provider.d.ts","sourceRoot":"","sources":["../src/provider.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,oBAAY,uBAAuB,CAAC,CAAC,EAAE,KAAK,SAAS,MAAM,CAAC,GAAG,MAAM,CAAC,IAClE,MAAM,SAAS,KAAK,GAAG,KAAK,GAAG,MAAM,SAAS,KAAK,GAAE,KAAK,GAC1D,KAAK,SAAS,MAAM,QAAQ,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,GAChC,QAAQ,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,SAAS,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,GAC1D,KAAK,GACL,KAAK,GACT,KAAK,CAAC;AAEhB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,oBAAY,WAAW,CAAC,CAAC,GAAG,OAAO,IAAI;KAClC,CAAC,IAAI,uBAAuB,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;CAC3C,CAAC;AAEF;;;;;;;;GAQG;AACH,oBAAY,eAAe,CAAC,CAAC,IAAI,MAAM,WAAW,CAAC,CAAC,CAAC,CAAC"}
|
package/dist/provider.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"provider.js","sourceRoot":"","sources":["../src/provider.ts"],"names":[],"mappings":";AAAA;;;GAGG","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\n/**\n *
|
|
1
|
+
{"version":3,"file":"provider.js","sourceRoot":"","sources":["../src/provider.ts"],"names":[],"mappings":";AAAA;;;GAGG","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\n/**\n * This utility type is meant for internal use by {@link FluidObject}\n * Produces a valid FluidObject key given a type and a property.\n * A valid FluidObject key is a property that exists on the incoming type\n * as well as on the type of the property itself. For example: `IProvideFoo.IFoo.IFoo`\n * This aligns with the FluidObject pattern expected to be used with all FluidObjects.\n *\n * For example:\n * ```\n * interface IProvideFoo{\n * IFoo: IFoo\n * }\n * interface IFoo extends IProvideFoo{\n * foobar();\n * }\n * ```\n * This pattern enables discovery, and delegation in a standard way which is central\n * to FluidObject pattern\n *\n * @internal\n */\nexport type FluidObjectProviderKeys<T, TProp extends keyof T = keyof T> =\n string extends TProp ? never : number extends TProp? never : // exclude indexers [key:string |number]: any\n TProp extends keyof Required<T>[TProp] // TProp is a property of T, and T[TProp]\n ? Required<T>[TProp] extends Required<Required<T>[TProp]>[TProp] // T[TProp] is the same type as T[TProp][TProp]\n ? TProp\n : never\n : never;\n\n/**\n * This utility type take interface(s) that follow the FluidObject pattern, and produces\n * a new type that can be used for inspection and discovery of those interfaces.\n *\n * It is meant to be used with types that are known to implement the FluidObject pattern.\n * A common way to specify a type implements the FluidObject pattern is to expose it as a\n * FluidObject without a generic argument.\n *\n * For example, if we have an interface like below\n * ```\n * interface IProvideFoo{\n * IFoo: IFoo\n * }\n * interface IFoo extends IProvideFoo{\n * foobar();\n * }\n * ```\n *\n * and a function that returns a FluidObject. You would do the following\n *\n * `const maybeFoo: FluidObject<IFoo> = getFluidObject()`;\n *\n * Either IFoo or IProvideFoo are valid generic arguments. In both case\n * maybeFoo will be of type `{IFoo?: IFoo}`. If IFoo is not undefined,\n * then the FluidObject provides IFoo, and it can be used.\n *\n * You can inspect multiple types via a intersection. For example:\n * `FluidObject<IFoo & IBar>`\n *\n */\nexport type FluidObject<T = unknown> = {\n [P in FluidObjectProviderKeys<T>]?: T[P];\n};\n\n/**\n * This utility type creates a type that is the union of all keys on the generic type\n * which implement the FluidObject pattern.\n *\n * See {@link FluidObject}\n *\n * For example `FluidObjectKeys<IFoo & IBar>` would result in `\"IFoo\" | \"IBar\"`\n *\n */\nexport type FluidObjectKeys<T> = keyof FluidObject<T>;\n"]}
|
package/lib/provider.d.ts
CHANGED
|
@@ -3,12 +3,12 @@
|
|
|
3
3
|
* Licensed under the MIT License.
|
|
4
4
|
*/
|
|
5
5
|
/**
|
|
6
|
-
* @
|
|
7
|
-
* This utility type is meant for internal use by @see FluidObject
|
|
6
|
+
* This utility type is meant for internal use by {@link FluidObject}
|
|
8
7
|
* Produces a valid FluidObject key given a type and a property.
|
|
9
8
|
* A valid FluidObject key is a property that exists on the incoming type
|
|
10
|
-
* as well as on the type of the property itself. For example
|
|
9
|
+
* as well as on the type of the property itself. For example: `IProvideFoo.IFoo.IFoo`
|
|
11
10
|
* This aligns with the FluidObject pattern expected to be used with all FluidObjects.
|
|
11
|
+
*
|
|
12
12
|
* For example:
|
|
13
13
|
* ```
|
|
14
14
|
* interface IProvideFoo{
|
|
@@ -20,6 +20,8 @@
|
|
|
20
20
|
* ```
|
|
21
21
|
* This pattern enables discovery, and delegation in a standard way which is central
|
|
22
22
|
* to FluidObject pattern
|
|
23
|
+
*
|
|
24
|
+
* @internal
|
|
23
25
|
*/
|
|
24
26
|
export declare type FluidObjectProviderKeys<T, TProp extends keyof T = keyof T> = string extends TProp ? never : number extends TProp ? never : TProp extends keyof Required<T>[TProp] ? Required<T>[TProp] extends Required<Required<T>[TProp]>[TProp] ? TProp : never : never;
|
|
25
27
|
/**
|
|
@@ -57,7 +59,9 @@ export declare type FluidObject<T = unknown> = {
|
|
|
57
59
|
};
|
|
58
60
|
/**
|
|
59
61
|
* This utility type creates a type that is the union of all keys on the generic type
|
|
60
|
-
* which implement the FluidObject pattern.
|
|
62
|
+
* which implement the FluidObject pattern.
|
|
63
|
+
*
|
|
64
|
+
* See {@link FluidObject}
|
|
61
65
|
*
|
|
62
66
|
* For example `FluidObjectKeys<IFoo & IBar>` would result in `"IFoo" | "IBar"`
|
|
63
67
|
*
|
package/lib/provider.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"provider.d.ts","sourceRoot":"","sources":["../src/provider.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH
|
|
1
|
+
{"version":3,"file":"provider.d.ts","sourceRoot":"","sources":["../src/provider.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,oBAAY,uBAAuB,CAAC,CAAC,EAAE,KAAK,SAAS,MAAM,CAAC,GAAG,MAAM,CAAC,IAClE,MAAM,SAAS,KAAK,GAAG,KAAK,GAAG,MAAM,SAAS,KAAK,GAAE,KAAK,GAC1D,KAAK,SAAS,MAAM,QAAQ,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,GAChC,QAAQ,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,SAAS,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,GAC1D,KAAK,GACL,KAAK,GACT,KAAK,CAAC;AAEhB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,oBAAY,WAAW,CAAC,CAAC,GAAG,OAAO,IAAI;KAClC,CAAC,IAAI,uBAAuB,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;CAC3C,CAAC;AAEF;;;;;;;;GAQG;AACH,oBAAY,eAAe,CAAC,CAAC,IAAI,MAAM,WAAW,CAAC,CAAC,CAAC,CAAC"}
|
package/lib/provider.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"provider.js","sourceRoot":"","sources":["../src/provider.ts"],"names":[],"mappings":"AAAA;;;GAGG","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\n/**\n *
|
|
1
|
+
{"version":3,"file":"provider.js","sourceRoot":"","sources":["../src/provider.ts"],"names":[],"mappings":"AAAA;;;GAGG","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\n/**\n * This utility type is meant for internal use by {@link FluidObject}\n * Produces a valid FluidObject key given a type and a property.\n * A valid FluidObject key is a property that exists on the incoming type\n * as well as on the type of the property itself. For example: `IProvideFoo.IFoo.IFoo`\n * This aligns with the FluidObject pattern expected to be used with all FluidObjects.\n *\n * For example:\n * ```\n * interface IProvideFoo{\n * IFoo: IFoo\n * }\n * interface IFoo extends IProvideFoo{\n * foobar();\n * }\n * ```\n * This pattern enables discovery, and delegation in a standard way which is central\n * to FluidObject pattern\n *\n * @internal\n */\nexport type FluidObjectProviderKeys<T, TProp extends keyof T = keyof T> =\n string extends TProp ? never : number extends TProp? never : // exclude indexers [key:string |number]: any\n TProp extends keyof Required<T>[TProp] // TProp is a property of T, and T[TProp]\n ? Required<T>[TProp] extends Required<Required<T>[TProp]>[TProp] // T[TProp] is the same type as T[TProp][TProp]\n ? TProp\n : never\n : never;\n\n/**\n * This utility type take interface(s) that follow the FluidObject pattern, and produces\n * a new type that can be used for inspection and discovery of those interfaces.\n *\n * It is meant to be used with types that are known to implement the FluidObject pattern.\n * A common way to specify a type implements the FluidObject pattern is to expose it as a\n * FluidObject without a generic argument.\n *\n * For example, if we have an interface like below\n * ```\n * interface IProvideFoo{\n * IFoo: IFoo\n * }\n * interface IFoo extends IProvideFoo{\n * foobar();\n * }\n * ```\n *\n * and a function that returns a FluidObject. You would do the following\n *\n * `const maybeFoo: FluidObject<IFoo> = getFluidObject()`;\n *\n * Either IFoo or IProvideFoo are valid generic arguments. In both case\n * maybeFoo will be of type `{IFoo?: IFoo}`. If IFoo is not undefined,\n * then the FluidObject provides IFoo, and it can be used.\n *\n * You can inspect multiple types via a intersection. For example:\n * `FluidObject<IFoo & IBar>`\n *\n */\nexport type FluidObject<T = unknown> = {\n [P in FluidObjectProviderKeys<T>]?: T[P];\n};\n\n/**\n * This utility type creates a type that is the union of all keys on the generic type\n * which implement the FluidObject pattern.\n *\n * See {@link FluidObject}\n *\n * For example `FluidObjectKeys<IFoo & IBar>` would result in `\"IFoo\" | \"IBar\"`\n *\n */\nexport type FluidObjectKeys<T> = keyof FluidObject<T>;\n"]}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@fluidframework/core-interfaces",
|
|
3
|
-
"version": "1.
|
|
3
|
+
"version": "1.2.0-77818",
|
|
4
4
|
"description": "Fluid object interfaces",
|
|
5
5
|
"homepage": "https://fluidframework.com",
|
|
6
6
|
"repository": {
|
|
@@ -38,9 +38,9 @@
|
|
|
38
38
|
"typetests:gen": "fluid-type-validator -g -d ."
|
|
39
39
|
},
|
|
40
40
|
"devDependencies": {
|
|
41
|
-
"@fluidframework/build-common": "^0.24.0
|
|
42
|
-
"@fluidframework/build-tools": "^0.2.
|
|
43
|
-
"@fluidframework/core-interfaces-previous": "npm:@fluidframework/core-interfaces
|
|
41
|
+
"@fluidframework/build-common": "^0.24.0",
|
|
42
|
+
"@fluidframework/build-tools": "^0.2.74327",
|
|
43
|
+
"@fluidframework/core-interfaces-previous": "npm:@fluidframework/core-interfaces@1.1.0",
|
|
44
44
|
"@fluidframework/eslint-config-fluid": "^0.28.2000",
|
|
45
45
|
"@microsoft/api-extractor": "^7.22.2",
|
|
46
46
|
"@rushstack/eslint-config": "^2.5.1",
|
|
@@ -53,7 +53,7 @@
|
|
|
53
53
|
"typescript-formatter": "7.1.0"
|
|
54
54
|
},
|
|
55
55
|
"typeValidation": {
|
|
56
|
-
"version": "1.
|
|
56
|
+
"version": "1.2.0",
|
|
57
57
|
"broken": {}
|
|
58
58
|
}
|
|
59
59
|
}
|
package/src/provider.ts
CHANGED
|
@@ -4,12 +4,12 @@
|
|
|
4
4
|
*/
|
|
5
5
|
|
|
6
6
|
/**
|
|
7
|
-
* @
|
|
8
|
-
* This utility type is meant for internal use by @see FluidObject
|
|
7
|
+
* This utility type is meant for internal use by {@link FluidObject}
|
|
9
8
|
* Produces a valid FluidObject key given a type and a property.
|
|
10
9
|
* A valid FluidObject key is a property that exists on the incoming type
|
|
11
|
-
* as well as on the type of the property itself. For example
|
|
10
|
+
* as well as on the type of the property itself. For example: `IProvideFoo.IFoo.IFoo`
|
|
12
11
|
* This aligns with the FluidObject pattern expected to be used with all FluidObjects.
|
|
12
|
+
*
|
|
13
13
|
* For example:
|
|
14
14
|
* ```
|
|
15
15
|
* interface IProvideFoo{
|
|
@@ -21,8 +21,10 @@
|
|
|
21
21
|
* ```
|
|
22
22
|
* This pattern enables discovery, and delegation in a standard way which is central
|
|
23
23
|
* to FluidObject pattern
|
|
24
|
+
*
|
|
25
|
+
* @internal
|
|
24
26
|
*/
|
|
25
|
-
|
|
27
|
+
export type FluidObjectProviderKeys<T, TProp extends keyof T = keyof T> =
|
|
26
28
|
string extends TProp ? never : number extends TProp? never : // exclude indexers [key:string |number]: any
|
|
27
29
|
TProp extends keyof Required<T>[TProp] // TProp is a property of T, and T[TProp]
|
|
28
30
|
? Required<T>[TProp] extends Required<Required<T>[TProp]>[TProp] // T[TProp] is the same type as T[TProp][TProp]
|
|
@@ -60,13 +62,15 @@
|
|
|
60
62
|
* `FluidObject<IFoo & IBar>`
|
|
61
63
|
*
|
|
62
64
|
*/
|
|
63
|
-
|
|
65
|
+
export type FluidObject<T = unknown> = {
|
|
64
66
|
[P in FluidObjectProviderKeys<T>]?: T[P];
|
|
65
67
|
};
|
|
66
68
|
|
|
67
69
|
/**
|
|
68
70
|
* This utility type creates a type that is the union of all keys on the generic type
|
|
69
|
-
* which implement the FluidObject pattern.
|
|
71
|
+
* which implement the FluidObject pattern.
|
|
72
|
+
*
|
|
73
|
+
* See {@link FluidObject}
|
|
70
74
|
*
|
|
71
75
|
* For example `FluidObjectKeys<IFoo & IBar>` would result in `"IFoo" | "IBar"`
|
|
72
76
|
*
|