papr - npm Package Compare versions

Comparing version 9.1.0 to 9.2.0

cjs/types.d.ts

@@ -229,2 +229,27 @@ import { Binary, ObjectId, Decimal128 } from 'mongodb';
     /**
+     * Creates a `null` type. Use discouraged. Typically used in conjunction with
+     * another type when applying a schema to a collection that already contains
+     * `null` values in a field.
+     *
+     * Usage of `null` as a value in Mongo is discouraged, as it makes some
+     * common query patterns ambiguous: `find({ myField: null })` will match
+     * documents that have the `myField` value set to the literal `null` _or_
+     * that match `{ myField: { $exists: false } }`.
+     *
+     * To match documents with a literal `null` value you must query with
+     * `{ myField: { $type: 10 } }` (where `10` is the [BSON null type
+     * constant](https://www.mongodb.com/docs/manual/reference/bson-types/))
+     *
+     * @param [options] {GenericOptions}
+     * @param [options.required] {boolean}
+     *
+     * @example
+     * import { schema, types } from 'papr';
+     *
+     * schema({
+     *   nullableNumber: types.oneOf([ types.number(), types.null() ]),
+     * });
+     */
+    null: <Options_4 extends Partial<RequiredOptions>>(options?: Options_4 | undefined) => GetType<null, Options_4>;
+    /**
      * Creates a number type.
@@ -352,3 +377,3 @@ *
      */
-    objectId: <Options_4 extends Partial<RequiredOptions>>(options?: Options_4 | undefined) => GetType<ObjectId, Options_4>;
+    objectId: <Options_5 extends Partial<RequiredOptions>>(options?: Options_5 | undefined) => GetType<ObjectId, Options_5>;
     /**
@@ -355,0 +380,0 @@ * Creates a union type of multiple other types.

cjs/types.js

@@ -314,2 +314,27 @@ "use strict";
     /**
+     * Creates a `null` type. Use discouraged. Typically used in conjunction with
+     * another type when applying a schema to a collection that already contains
+     * `null` values in a field.
+     *
+     * Usage of `null` as a value in Mongo is discouraged, as it makes some
+     * common query patterns ambiguous: `find({ myField: null })` will match
+     * documents that have the `myField` value set to the literal `null` _or_
+     * that match `{ myField: { $exists: false } }`.
+     *
+     * To match documents with a literal `null` value you must query with
+     * `{ myField: { $type: 10 } }` (where `10` is the [BSON null type
+     * constant](https://www.mongodb.com/docs/manual/reference/bson-types/))
+     *
+     * @param [options] {GenericOptions}
+     * @param [options.required] {boolean}
+     *
+     * @example
+     * import { schema, types } from 'papr';
+     *
+     * schema({
+     *   nullableNumber: types.oneOf([ types.number(), types.null() ]),
+     * });
+     */
+    null: createSimpleType('null'),
+    /**
      * Creates a number type.
@@ -316,0 +341,0 @@ *

esm/types.d.ts

@@ -229,2 +229,27 @@ import { Binary, ObjectId, Decimal128 } from 'mongodb';
     /**
+     * Creates a `null` type. Use discouraged. Typically used in conjunction with
+     * another type when applying a schema to a collection that already contains
+     * `null` values in a field.
+     *
+     * Usage of `null` as a value in Mongo is discouraged, as it makes some
+     * common query patterns ambiguous: `find({ myField: null })` will match
+     * documents that have the `myField` value set to the literal `null` _or_
+     * that match `{ myField: { $exists: false } }`.
+     *
+     * To match documents with a literal `null` value you must query with
+     * `{ myField: { $type: 10 } }` (where `10` is the [BSON null type
+     * constant](https://www.mongodb.com/docs/manual/reference/bson-types/))
+     *
+     * @param [options] {GenericOptions}
+     * @param [options.required] {boolean}
+     *
+     * @example
+     * import { schema, types } from 'papr';
+     *
+     * schema({
+     *   nullableNumber: types.oneOf([ types.number(), types.null() ]),
+     * });
+     */
+    null: <Options_4 extends Partial<RequiredOptions>>(options?: Options_4 | undefined) => GetType<null, Options_4>;
+    /**
      * Creates a number type.
@@ -352,3 +377,3 @@ *
      */
-    objectId: <Options_4 extends Partial<RequiredOptions>>(options?: Options_4 | undefined) => GetType<ObjectId, Options_4>;
+    objectId: <Options_5 extends Partial<RequiredOptions>>(options?: Options_5 | undefined) => GetType<ObjectId, Options_5>;
     /**
@@ -355,0 +380,0 @@ * Creates a union type of multiple other types.

esm/types.js

@@ -307,2 +307,27 @@ /**
     /**
+     * Creates a `null` type. Use discouraged. Typically used in conjunction with
+     * another type when applying a schema to a collection that already contains
+     * `null` values in a field.
+     *
+     * Usage of `null` as a value in Mongo is discouraged, as it makes some
+     * common query patterns ambiguous: `find({ myField: null })` will match
+     * documents that have the `myField` value set to the literal `null` _or_
+     * that match `{ myField: { $exists: false } }`.
+     *
+     * To match documents with a literal `null` value you must query with
+     * `{ myField: { $type: 10 } }` (where `10` is the [BSON null type
+     * constant](https://www.mongodb.com/docs/manual/reference/bson-types/))
+     *
+     * @param [options] {GenericOptions}
+     * @param [options.required] {boolean}
+     *
+     * @example
+     * import { schema, types } from 'papr';
+     *
+     * schema({
+     *   nullableNumber: types.oneOf([ types.number(), types.null() ]),
+     * });
+     */
+    null: createSimpleType('null'),
+    /**
      * Creates a number type.
@@ -309,0 +334,0 @@ *

package.json

@@ -5,3 +5,3 @@ {
   "author": "Plex Inc.",
-  "version": "9.1.0",
+  "version": "9.2.0",
   "keywords": [
@@ -57,4 +57,4 @@ "mongodb",
   "devDependencies": {
-    "@babel/core": "7.19.1",
-    "@babel/preset-env": "7.19.1",
+    "@babel/core": "7.19.6",
+    "@babel/preset-env": "7.19.4",
     "@babel/preset-typescript": "7.18.6",
@@ -64,8 +64,8 @@ "@byu-oit/bar-chart": "1.4.2",
     "@commitlint/config-conventional": "17.1.0",
-    "@types/node": "14.18.30",
-    "@typescript-eslint/eslint-plugin": "5.38.0",
-    "@typescript-eslint/parser": "5.38.0",
+    "@types/node": "14.18.32",
+    "@typescript-eslint/eslint-plugin": "5.40.0",
+    "@typescript-eslint/parser": "5.40.0",
     "arg": "5.0.2",
     "docsify-cli": "4.4.4",
-    "eslint": "8.24.0",
+    "eslint": "8.25.0",
     "eslint-config-prettier": "8.5.0",
@@ -76,5 +76,5 @@ "eslint-config-standard": "17.0.0",
     "eslint-plugin-prettier": "4.2.1",
-    "eslint-plugin-promise": "6.0.1",
+    "eslint-plugin-promise": "6.1.1",
     "husky": "8.0.1",
-    "jest": "29.0.1",
+    "jest": "29.2.0",
     "jsdoc-api": "7.1.1",
@@ -84,3 +84,3 @@ "jsdoc-parse": "6.1.0",
     "mongodb": "4.10.0",
-    "mongodb-memory-server": "8.9.0",
+    "mongodb-memory-server": "8.9.3",
     "mongoose": "6.3.5",
@@ -130,3 +130,3 @@ "pinst": "3.0.0",
   },
-  "packageManager": "yarn@3.2.3"
+  "packageManager": "yarn@3.2.4"
 }

No alert changes

Improved metrics

Total package byte prevSize

214429

increased by2.04%

Lines of code

5544

increased by1.84%

No dependency changes