@fluidframework/datastore-definitions 2.0.0-internal.1.2.0.93071 → 2.0.0-internal.1.2.2

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/index.d.ts CHANGED
@@ -3,7 +3,7 @@
3
3
  * Licensed under the MIT License.
4
4
  */
5
5
  /**
6
- * This package defines the interfaces required to implement and/or communicate
6
+ * This library defines the interfaces required to implement and/or communicate
7
7
  * with a data store.
8
8
  *
9
9
  * @packageDocumentation
package/dist/index.js CHANGED
@@ -15,7 +15,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
15
15
  };
16
16
  Object.defineProperty(exports, "__esModule", { value: true });
17
17
  /**
18
- * This package defines the interfaces required to implement and/or communicate
18
+ * This library defines the interfaces required to implement and/or communicate
19
19
  * with a data store.
20
20
  *
21
21
  * @packageDocumentation
package/dist/index.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;;;;;;;;;;AAEH;;;;;EAKE;AAEF,4CAA0B;AAC1B,qDAAmC;AACnC,6CAA2B;AAC3B,iDAA+B;AAC/B,4CAA0B","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\n/**\n* This package defines the interfaces required to implement and/or communicate\n* with a data store.\n*\n* @packageDocumentation\n*/\n\nexport * from \"./channel\";\nexport * from \"./dataStoreRuntime\";\nexport * from \"./jsonable\";\nexport * from \"./serializable\";\nexport * from \"./storage\";\n"]}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;;;;;;;;;;AAEH;;;;;EAKE;AAEF,4CAA0B;AAC1B,qDAAmC;AACnC,6CAA2B;AAC3B,iDAA+B;AAC/B,4CAA0B","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\n/**\n* This library defines the interfaces required to implement and/or communicate\n* with a data store.\n*\n* @packageDocumentation\n*/\n\nexport * from \"./channel\";\nexport * from \"./dataStoreRuntime\";\nexport * from \"./jsonable\";\nexport * from \"./serializable\";\nexport * from \"./storage\";\n"]}
@@ -21,10 +21,13 @@
21
21
  *
22
22
  * Note that `Jsonable<T>` does not protect against the following pitfalls when serializing with JSON.stringify():
23
23
  *
24
- * - `undefined` properties on objects are omitted (i.e., properties become undefined instead of equal to undefined).
25
- * - When `undefined` appears as the root object or as an array element it is coerced to `null`.
26
- * - Non-finite numbers (`NaN`, `+/-Infinity`) are also coerced to `null`.
27
- * - prototypes and non-enumerable properties are lost.
24
+ * - `undefined` properties on objects are omitted (i.e., properties become undefined instead of equal to undefined).
25
+ *
26
+ * - When `undefined` appears as the root object or as an array element it is coerced to `null`.
27
+ *
28
+ * - Non-finite numbers (`NaN`, `+/-Infinity`) are also coerced to `null`.
29
+ *
30
+ * - prototypes and non-enumerable properties are lost.
28
31
  *
29
32
  * Also, `Jsonable<T>` does not prevent the construction of circular references.
30
33
  *
@@ -1 +1 @@
1
- {"version":3,"file":"jsonable.d.ts","sourceRoot":"","sources":["../src/jsonable.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;AACH,oBAAY,QAAQ,CAAC,CAAC,GAAG,GAAG,EAAE,SAAS,GAAG,IAAI,IAC1C,CAAC,SAAS,SAAS,GAAG,IAAI,GAAG,OAAO,GAAG,MAAM,GAAG,MAAM,GAAG,SAAS,GAC5D,CAAC,GAED,OAAO,CAAC,CAAC,EAAE,QAAQ,CAAC,SAAS,KAAK,GAC9B;KACG,CAAC,IAAI,MAAM,CAAC,GAAG,OAAO,CAAC,CAAC,EAAE,MAAM,CAAC,SAAS,KAAK,GAC1C,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,SAAS,CAAC,GACzB,KAAK;CACd,GACC,KAAK,CAAC"}
1
+ {"version":3,"file":"jsonable.d.ts","sourceRoot":"","sources":["../src/jsonable.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqCG;AACH,oBAAY,QAAQ,CAAC,CAAC,GAAG,GAAG,EAAE,SAAS,GAAG,IAAI,IAC1C,CAAC,SAAS,SAAS,GAAG,IAAI,GAAG,OAAO,GAAG,MAAM,GAAG,MAAM,GAAG,SAAS,GAC5D,CAAC,GAED,OAAO,CAAC,CAAC,EAAE,QAAQ,CAAC,SAAS,KAAK,GAC9B;KACG,CAAC,IAAI,MAAM,CAAC,GAAG,OAAO,CAAC,CAAC,EAAE,MAAM,CAAC,SAAS,KAAK,GAC1C,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,SAAS,CAAC,GACzB,KAAK;CACd,GACC,KAAK,CAAC"}
@@ -1 +1 @@
1
- {"version":3,"file":"jsonable.js","sourceRoot":"","sources":["../src/jsonable.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 * Used to constrain a type `T` to types that are serializable as JSON.\n * Produces a compile-time error if `T` contains non-Jsonable members.\n *\n * @remarks\n * Note that this does NOT prevent using of values with non-json compatible data,\n * it only prevents using values with types that include non-json compatible data.\n * This means that one can, for example, pass an a value typed with json compatible\n * interface into this function,\n * that could actually be a class with lots on non-json compatible fields and methods.\n *\n * Important: `T extends Jsonable<T>` is incorrect (does not even compile).\n * `T extends Jsonable` is also incorrect since `Jsonable` is just `any` and thus applies no constraint at all.\n *\n * The optional 'TReplaced' parameter may be used to permit additional leaf types to support\n * situations where a `replacer` is used to handle special values (e.g., `Jsonable<{ x: IFluidHandle }, IFluidHandle>`).\n *\n * Note that `Jsonable<T>` does not protect against the following pitfalls when serializing with JSON.stringify():\n *\n * - `undefined` properties on objects are omitted (i.e., properties become undefined instead of equal to undefined).\n * - When `undefined` appears as the root object or as an array element it is coerced to `null`.\n * - Non-finite numbers (`NaN`, `+/-Infinity`) are also coerced to `null`.\n * - prototypes and non-enumerable properties are lost.\n *\n * Also, `Jsonable<T>` does not prevent the construction of circular references.\n *\n * Using `Jsonable` (with no type parameters) or `Jsonable<any>` is just a type alias for `any`\n * and should not be used if type safety is desired.\n *\n * @example\n * Typical usage:\n * ```ts\n * function foo<T>(value: Jsonable<T>) { ... }\n * ```\n */\nexport type Jsonable<T = any, TReplaced = void> =\n T extends undefined | null | boolean | number | string | TReplaced\n ? T\n // eslint-disable-next-line @typescript-eslint/ban-types\n : Extract<T, Function> extends never\n ? {\n [K in keyof T]: Extract<K, symbol> extends never\n ? Jsonable<T[K], TReplaced>\n : never\n }\n : never;\n"]}
1
+ {"version":3,"file":"jsonable.js","sourceRoot":"","sources":["../src/jsonable.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 * Used to constrain a type `T` to types that are serializable as JSON.\n * Produces a compile-time error if `T` contains non-Jsonable members.\n *\n * @remarks\n * Note that this does NOT prevent using of values with non-json compatible data,\n * it only prevents using values with types that include non-json compatible data.\n * This means that one can, for example, pass an a value typed with json compatible\n * interface into this function,\n * that could actually be a class with lots on non-json compatible fields and methods.\n *\n * Important: `T extends Jsonable<T>` is incorrect (does not even compile).\n * `T extends Jsonable` is also incorrect since `Jsonable` is just `any` and thus applies no constraint at all.\n *\n * The optional 'TReplaced' parameter may be used to permit additional leaf types to support\n * situations where a `replacer` is used to handle special values (e.g., `Jsonable<{ x: IFluidHandle }, IFluidHandle>`).\n *\n * Note that `Jsonable<T>` does not protect against the following pitfalls when serializing with JSON.stringify():\n *\n * - `undefined` properties on objects are omitted (i.e., properties become undefined instead of equal to undefined).\n *\n * - When `undefined` appears as the root object or as an array element it is coerced to `null`.\n *\n * - Non-finite numbers (`NaN`, `+/-Infinity`) are also coerced to `null`.\n *\n * - prototypes and non-enumerable properties are lost.\n *\n * Also, `Jsonable<T>` does not prevent the construction of circular references.\n *\n * Using `Jsonable` (with no type parameters) or `Jsonable<any>` is just a type alias for `any`\n * and should not be used if type safety is desired.\n *\n * @example\n * Typical usage:\n * ```ts\n * function foo<T>(value: Jsonable<T>) { ... }\n * ```\n */\nexport type Jsonable<T = any, TReplaced = void> =\n T extends undefined | null | boolean | number | string | TReplaced\n ? T\n // eslint-disable-next-line @typescript-eslint/ban-types\n : Extract<T, Function> extends never\n ? {\n [K in keyof T]: Extract<K, symbol> extends never\n ? Jsonable<T[K], TReplaced>\n : never\n }\n : never;\n"]}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@fluidframework/datastore-definitions",
3
- "version": "2.0.0-internal.1.2.0.93071",
3
+ "version": "2.0.0-internal.1.2.2",
4
4
  "description": "Fluid data store definitions",
5
5
  "homepage": "https://fluidframework.com",
6
6
  "repository": {
@@ -34,17 +34,17 @@
34
34
  "dependencies": {
35
35
  "@fluidframework/common-definitions": "^0.20.1",
36
36
  "@fluidframework/common-utils": "^1.0.0",
37
- "@fluidframework/container-definitions": "2.0.0-internal.1.2.0.93071",
38
- "@fluidframework/core-interfaces": "2.0.0-internal.1.2.0.93071",
37
+ "@fluidframework/container-definitions": "^2.0.0-internal.1.2.2",
38
+ "@fluidframework/core-interfaces": "^2.0.0-internal.1.2.2",
39
39
  "@fluidframework/protocol-definitions": "^1.0.0",
40
- "@fluidframework/runtime-definitions": "2.0.0-internal.1.2.0.93071",
40
+ "@fluidframework/runtime-definitions": "^2.0.0-internal.1.2.2",
41
41
  "@types/node": "^14.18.0"
42
42
  },
43
43
  "devDependencies": {
44
44
  "@fluidframework/build-common": "^1.0.0",
45
45
  "@fluidframework/build-tools": "^0.4.4000",
46
46
  "@fluidframework/datastore-definitions-previous": "npm:@fluidframework/datastore-definitions@^1.2.0",
47
- "@fluidframework/eslint-config-fluid": "^0.28.2000",
47
+ "@fluidframework/eslint-config-fluid": "^1.0.0",
48
48
  "@microsoft/api-extractor": "^7.22.2",
49
49
  "@rushstack/eslint-config": "^2.5.1",
50
50
  "concurrently": "^6.2.0",
package/src/index.ts CHANGED
@@ -4,7 +4,7 @@
4
4
  */
5
5
 
6
6
  /**
7
- * This package defines the interfaces required to implement and/or communicate
7
+ * This library defines the interfaces required to implement and/or communicate
8
8
  * with a data store.
9
9
  *
10
10
  * @packageDocumentation
package/src/jsonable.ts CHANGED
@@ -22,10 +22,13 @@
22
22
  *
23
23
  * Note that `Jsonable<T>` does not protect against the following pitfalls when serializing with JSON.stringify():
24
24
  *
25
- * - `undefined` properties on objects are omitted (i.e., properties become undefined instead of equal to undefined).
26
- * - When `undefined` appears as the root object or as an array element it is coerced to `null`.
27
- * - Non-finite numbers (`NaN`, `+/-Infinity`) are also coerced to `null`.
28
- * - prototypes and non-enumerable properties are lost.
25
+ * - `undefined` properties on objects are omitted (i.e., properties become undefined instead of equal to undefined).
26
+ *
27
+ * - When `undefined` appears as the root object or as an array element it is coerced to `null`.
28
+ *
29
+ * - Non-finite numbers (`NaN`, `+/-Infinity`) are also coerced to `null`.
30
+ *
31
+ * - prototypes and non-enumerable properties are lost.
29
32
  *
30
33
  * Also, `Jsonable<T>` does not prevent the construction of circular references.
31
34
  *