@bedrockio/model 0.10.0 → 0.11.0

package/CHANGELOG.md

@@ -1,3 +1,11 @@
+## 0.11.0
+
+- Added clone module.
+
+## 0.10.1
+
+- Fix to not expose details on unique constraint errors.
+
 ## 0.10.0
 
 - Unique constraints now run sequentially and will not run on nested validations

package/README.md

@@ -23,6 +23,7 @@ Bedrock utilities for model creation.
   - [Access Control](#access-control)
   - [Assign](#assign)
   - [Upsert](#upsert)
+  - [Clone](#clone)
   - [Slugs](#slugs)
 - [Testing](#testing)
 - [Troubleshooting](#troubleshooting)
@@ -1667,6 +1668,16 @@ if (!shop) {
 }
 ```
 
+### Clone
+
+Adds a single `clone` method on documents. This is an async method mostly for
+testing that will immediately create a copy of the document. It makes up for
+some of the shortcomings of the Mongoose `$clone` method:
+
+- A new `id` will be generated.
+- Populated and self-referencing documents are handled.
+- Unique fields will be augmented to not collide.
+
 ### Slugs
 
 A common requirement is to allow slugs on documents to serve as ids for human

package/dist/cjs/clone.js

@@ -0,0 +1,55 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.applyClone = applyClone;
+// This module attempts to fix Mongoose $clone
+// which has a number of issues including:
+// - Keeps the same _id making it impossible to use
+//   the clone separate to the original document.
+// - Fails on circular references.
+// - Clones other internals like __v.
+// - Cannot deal with unique fields.
+//
+function applyClone(schema) {
+  schema.method('clone', async function clone() {
+    return await cloneDocument(this);
+  });
+}
+async function cloneDocument(doc) {
+  const Model = doc.constructor;
+  const clone = new Model();
+  for (let [key, typedef] of Object.entries(Model.schema.obj)) {
+    let value = doc.get(key);
+    const {
+      unique,
+      softUnique
+    } = typedef;
+    if (value && (unique || softUnique)) {
+      value = getUniqueValue(value);
+    }
+    clone.set(key, value);
+  }
+  await clone.save();
+  return clone;
+}
+let counter = 1;
+function getUniqueValue(value) {
+  const type = typeof value;
+  if (type === 'string') {
+    return getUniqueString(value);
+  } else if (type === 'number') {
+    return value + getCounter();
+  } else {
+    throw new Error(`Unique behavior not defined for ${type}.`);
+  }
+}
+function getUniqueString(str) {
+  const split = str.split('@');
+  split[0] += getCounter();
+  return split.join('@');
+}
+function getCounter() {
+  return counter++;
+}

package/dist/cjs/errors.js

@@ -25,5 +25,11 @@ class UniqueConstraintError extends Error {
     super(message);
     this.details = details;
   }
+  toJSON() {
+    return {
+      type: 'unique',
+      message: this.message
+    };
+  }
 }
 exports.UniqueConstraintError = UniqueConstraintError;

package/dist/cjs/schema.js

@@ -11,6 +11,7 @@ var _utils = require("./utils");
 var _serialization = require("./serialization");
 var _slug = require("./slug");
 var _cache = require("./cache");
+var _clone = require("./clone");
 var _search = require("./search");
 var _assign = require("./assign");
 var _upsert = require("./upsert");
@@ -56,6 +57,7 @@ function createSchema(definition, options = {}) {
   (0, _deleteHooks.applyDeleteHooks)(schema, definition);
   (0, _search.applySearch)(schema, definition);
   (0, _cache.applyCache)(schema, definition);
+  (0, _clone.applyClone)(schema);
   (0, _disallowed.applyDisallowed)(schema);
   (0, _include.applyInclude)(schema);
   (0, _hydrate.applyHydrate)(schema);

package/dist/cjs/soft-delete.js

@@ -34,8 +34,9 @@ async function assertUnique(options) {
   if (exists) {
     const message = getUniqueErrorMessage(model, field);
     throw new _errors.UniqueConstraintError(message, {
-      ...options,
-      field
+      model,
+      field,
+      value
     });
   }
 }

package/eslint.config.js

@@ -1,3 +1,2 @@
 import { jest, recommended, nodeImports } from '@bedrockio/eslint-plugin';
-
 export default [jest, recommended, nodeImports];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bedrockio/model",
-  "version": "0.10.0",
+  "version": "0.11.0",
   "description": "Bedrock utilities for model creation.",
   "type": "module",
   "scripts": {

package/src/clone.js

@@ -0,0 +1,55 @@
+// This module attempts to fix Mongoose $clone
+// which has a number of issues including:
+// - Keeps the same _id making it impossible to use
+//   the clone separate to the original document.
+// - Fails on circular references.
+// - Clones other internals like __v.
+// - Cannot deal with unique fields.
+//
+export function applyClone(schema) {
+  schema.method('clone', async function clone() {
+    return await cloneDocument(this);
+  });
+}
+
+async function cloneDocument(doc) {
+  const Model = doc.constructor;
+  const clone = new Model();
+
+  for (let [key, typedef] of Object.entries(Model.schema.obj)) {
+    let value = doc.get(key);
+    const { unique, softUnique } = typedef;
+    if (value && (unique || softUnique)) {
+      value = getUniqueValue(value);
+    }
+
+    clone.set(key, value);
+  }
+
+  await clone.save();
+
+  return clone;
+}
+
+let counter = 1;
+
+function getUniqueValue(value) {
+  const type = typeof value;
+  if (type === 'string') {
+    return getUniqueString(value);
+  } else if (type === 'number') {
+    return value + getCounter();
+  } else {
+    throw new Error(`Unique behavior not defined for ${type}.`);
+  }
+}
+
+function getUniqueString(str) {
+  const split = str.split('@');
+  split[0] += getCounter();
+  return split.join('@');
+}
+
+function getCounter() {
+  return counter++;
+}

package/src/errors.js

@@ -19,4 +19,11 @@ export class UniqueConstraintError extends Error {
     super(message);
     this.details = details;
   }
+
+  toJSON() {
+    return {
+      type: 'unique',
+      message: this.message,
+    };
+  }
 }

package/src/schema.js

@@ -6,6 +6,7 @@ import { isSchemaTypedef } from './utils';
 import { serializeOptions } from './serialization';
 import { applySlug } from './slug';
 import { applyCache } from './cache';
+import { applyClone } from './clone';
 import { applySearch } from './search';
 import { applyAssign } from './assign';
 import { applyUpsert } from './upsert';
@@ -60,6 +61,7 @@ export function createSchema(definition, options = {}) {
   applyDeleteHooks(schema, definition);
   applySearch(schema, definition);
   applyCache(schema, definition);
+  applyClone(schema);
   applyDisallowed(schema);
   applyInclude(schema);
   applyHydrate(schema);

package/src/soft-delete.js

@@ -27,8 +27,9 @@ export async function assertUnique(options) {
   if (exists) {
     const message = getUniqueErrorMessage(model, field);
     throw new UniqueConstraintError(message, {
-      ...options,
+      model,
       field,
+      value,
     });
   }
 }

package/types/clone.d.ts

@@ -0,0 +1,2 @@
+export function applyClone(schema: any): void;
+//# sourceMappingURL=clone.d.ts.map

package/types/clone.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"clone.d.ts","sourceRoot":"","sources":["../src/clone.js"],"names":[],"mappings":"AAQA,8CAIC"}

package/types/errors.d.ts

@@ -11,5 +11,9 @@ export class ReferenceError extends Error {
 export class UniqueConstraintError extends Error {
     constructor(message: any, details: any);
     details: any;
+    toJSON(): {
+        type: string;
+        message: string;
+    };
 }
 //# sourceMappingURL=errors.d.ts.map

package/types/errors.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../src/errors.js"],"names":[],"mappings":"AAAA;CAA8C;AAE9C;IACE,uBAGC;IADC,UAAgB;CAEnB;AAED;IACE,wCAGC;IADC,aAAsB;CAEzB;AAED;IACE,wCAGC;IADC,aAAsB;CAEzB"}
+{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../src/errors.js"],"names":[],"mappings":"AAAA;CAA8C;AAE9C;IACE,uBAGC;IADC,UAAgB;CAEnB;AAED;IACE,wCAGC;IADC,aAAsB;CAEzB;AAED;IACE,wCAGC;IADC,aAAsB;IAGxB;;;MAKC;CACF"}

package/types/schema.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"schema.d.ts","sourceRoot":"","sources":["../src/schema.js"],"names":[],"mappings":"AAuBA;;;;;;;GAOG;AACH,yCAJW,MAAM,YACN,QAAQ,CAAC,aAAa;;;;;;;YA8C5B,CAAC;WACF,CAAA;mBAAqB,CAAC;;;;;;;;;;;;;;;;;;;;;SAgHtB,CAAD;gBAA4B,CAAA;SAAY,CAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;aArH1C;AAED,iEAsBC;qBA9FoB,UAAU"}
+{"version":3,"file":"schema.d.ts","sourceRoot":"","sources":["../src/schema.js"],"names":[],"mappings":"AAwBA;;;;;;;GAOG;AACH,yCAJW,MAAM,YACN,QAAQ,CAAC,aAAa;;;;;;;YA6CM,CAAC;WACtC,CAAF;mBAAqB,CAAC;;;;;;;;;;;;;;;;;;;;;SAiHV,CAAA;gBAA2B,CAAC;SAAW,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;aApHnD;AAED,iEAsBC;qBAhGoB,UAAU"}

package/types/soft-delete.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"soft-delete.d.ts","sourceRoot":"","sources":["../src/soft-delete.js"],"names":[],"mappings":"AAKA,mDAIC;AAED,0DAsBC"}
+{"version":3,"file":"soft-delete.d.ts","sourceRoot":"","sources":["../src/soft-delete.js"],"names":[],"mappings":"AAKA,mDAIC;AAED,0DAuBC"}