mobx-state-tree 7.0.2 → 7.2.0

package/dist/types/index.d.ts

@@ -18,12 +18,14 @@ export declare const types: {
     integer: import("../internal").ISimpleType<number>;
     float: import("../internal").ISimpleType<number>;
     finite: import("../internal").ISimpleType<number>;
+    bigint: import("../internal").IType<string | number | bigint, string, bigint>;
     Date: import("../internal").IType<number | Date, number, Date>;
     map: typeof map;
     array: typeof array;
     frozen: typeof frozen;
     identifier: import("../internal").ISimpleType<string>;
     identifierNumber: import("../internal").ISimpleType<number>;
+    identifierBigint: import("../internal").IType<string | number | bigint, string, bigint>;
     late: typeof late;
     lazy: typeof lazy;
     undefined: import("../internal").ISimpleType<undefined>;

package/dist/types/primitives.d.ts

@@ -61,6 +61,20 @@ export declare const float: ISimpleType<number>;
  * ```
  */
 export declare const finite: ISimpleType<number>;
+/**
+ * `types.bigint` - Creates a type that can only contain a bigint value.
+ * Snapshots serialize to string (JSON-safe) and deserialize from string, number or bigint.
+ *
+ * Example:
+ * ```ts
+ * const BigId = types.model({
+ *   id: types.identifier,
+ *   value: types.bigint
+ * })
+ * getSnapshot(store).value // "0" (string, JSON-safe)
+ * ```
+ */
+export declare const bigint: IType<bigint | string | number, string, bigint>;
 /**
  * `types.boolean` - Creates a type that can only contain a boolean value.
  * This type is used for boolean values by default
@@ -101,4 +115,4 @@ export declare const DatePrimitive: IType<number | Date, number, Date>;
  * @param type
  * @returns
  */
-export declare function isPrimitiveType(type: unknown): type is ISimpleType<string> | ISimpleType<number> | ISimpleType<boolean> | typeof DatePrimitive;
+export declare function isPrimitiveType(type: unknown): type is ISimpleType<string> | ISimpleType<number> | ISimpleType<boolean> | typeof bigint | typeof DatePrimitive;

package/dist/types/utility-types/identifier.d.ts

@@ -1,10 +1,10 @@
-import { ISimpleType } from "../../internal";
+import { ISimpleType, IType } from "../../internal";
 /**
  * `types.identifier` - Identifiers are used to make references, lifecycle events and reconciling works.
  * Inside a state tree, for each type can exist only one instance for each given identifier.
  * For example there couldn't be 2 instances of user with id 1. If you need more, consider using references.
  * Identifier can be used only as type property of a model.
- * This type accepts as parameter the value type of the identifier field that can be either string or number.
+ * This type accepts as parameter the value type of the identifier field that can be either string, number or bigint.
  *
  * Example:
  * ```ts
@@ -31,14 +31,28 @@ export declare const identifier: ISimpleType<string>;
  * @returns
  */
 export declare const identifierNumber: ISimpleType<number>;
+/**
+ * `types.identifierBigint` - Similar to `types.identifier`. Snapshots serialize to string (JSON-safe) and deserialize from string, number or bigint.
+ *
+ * Example:
+ * ```ts
+ *  const Todo = types.model("Todo", {
+ *      id: types.identifierBigint,
+ *      title: types.string
+ *  })
+ * ```
+ *
+ * @returns
+ */
+export declare const identifierBigint: IType<bigint | string | number, string, bigint>;
 /**
  * Returns if a given value represents an identifier type.
  *
  * @param type
  * @returns
  */
-export declare function isIdentifierType(type: unknown): type is typeof identifier | typeof identifierNumber;
+export declare function isIdentifierType(type: unknown): type is typeof identifier | typeof identifierNumber | typeof identifierBigint;
 /**
  * Valid types for identifiers.
  */
-export type ReferenceIdentifier = string | number;
+export type ReferenceIdentifier = string | number | bigint;

package/dist/types/utility-types/snapshotProcessor.d.ts

@@ -29,6 +29,8 @@ export interface ISnapshotProcessors<IT extends IAnyType, CustomC, CustomS> {
 /**
  * `types.snapshotProcessor` - Runs a pre/post snapshot processor before/after serializing a given type.
  *
+ * [See known issue with `applySnapshot` and `preProcessSnapshot`](https://github.com/mobxjs/mobx-state-tree/issues/1317)
+ *
  * Example:
  * ```ts
  * const Todo1 = types.model({ text: types.string })

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "mobx-state-tree",
-    "version": "7.0.2",
+    "version": "7.2.0",
     "description": "Opinionated, transactional, MobX powered state container",
     "main": "dist/mobx-state-tree.js",
     "umd:main": "dist/mobx-state-tree.umd.js",
@@ -25,7 +25,7 @@
         "typecheck": "tsc --noEmit",
         "size": "size-limit",
         "tag-new-version": "yarn version && git push --tags",
-        "build-docs": "bun run fix-typedoc && shx rm -rf ./docs/API && typedoc --options ./typedocconfig.js",
+        "build-docs": "bun run fix-typedoc && shx rm -rf ./docs/API && typedoc --options ./typedocconfig.js && node scripts/fix-docs-source-links.js",
         "publish-docs": "bun run build-docs && cd ./website && GIT_USER=jamonholmgren USE_SSH=true bun run publish-gh-pages",
         "start": "cd website && bun run start",
         "prepare": "husky install",