@pbvision/firestore-orm 0.0.3 → 0.0.5

package/package.json

@@ -1,9 +1,13 @@
 {
   "name": "@pbvision/firestore-orm",
-  "version": "0.0.3",
+  "version": "0.0.5",
   "description": "Firestore ORM Library",
   "license": "Apache-2.0",
-  "main": "src/default-db.js",
+  "type": "module",
+  "engines": {
+    "node": ">=20"
+  },
+  "exports": "./src/default-db.js",
   "scripts": {
     "build-doc": "./docs/build.sh",
     "check-markdown-link": "./scripts/ci/markdown-link.sh",
@@ -12,7 +16,7 @@
     "restart-local-db": "./scripts/start-local-db.sh --force-recreate",
     "setup": "yarn install --frozen-lockfile && pip install -r requirements.txt",
     "start-local-db": "./scripts/start-local-db.sh",
-    "test": "./node_modules/jest/bin/jest.js --coverage --config=./jest.config.json"
+    "test": "node --experimental-vm-modules ./node_modules/jest/bin/jest.js --coverage --config=./jest.config.json"
   },
   "contributors": [
     "Yu Guan",
@@ -36,21 +40,19 @@
   ],
   "dependencies": {
     "@google-cloud/firestore": "^7.1.0",
-    "@pbvision/schema": "^0.1.4",
+    "@pbvision/schema": "^0.2.15",
     "deep-object-diff": "^1.1.7",
+    "eslint-import-resolver-webpack": "^0.13.8",
     "fast-deep-equal": "^3.1.3",
     "fast-json-stable-stringify": "^2.1.0",
     "rfdc": "^1.1.4",
     "uuid": "^8.3.2"
   },
-  "peerDependencies": {
-    "@pbvision/schema": "^0.1.4"
-  },
   "devDependencies": {
     "@babel/core": "^7.17.12",
     "@babel/eslint-parser": "^7.17.0",
     "@babel/preset-env": "^7.17.12",
-    "@pbvision/jest-unit-test": "^0.2.0",
+    "@pbvision/jest-unit-test": "^0.2.3",
     "eslint": "^8.22.0",
     "eslint-config-standard": "15.0.0",
     "eslint-plugin-import": "^2.22.0",
@@ -64,7 +66,8 @@
     "remark-validate-links": "^10.0.2",
     "snazzy": "^8.0.0",
     "standard": "^15.0.0",
-    "tui-jsdoc-template": "^1.2.2"
+    "tui-jsdoc-template": "^1.2.2",
+    "webpack": "^5.89.0"
   },
   "standard": {
     "envs": [

package/src/async-emitter.js

@@ -1,6 +1,6 @@
-const uuidv4 = require('uuid').v4
+import { v4 as uuidv4 } from 'uuid'
 
-class AsyncEmitter {
+export class AsyncEmitter {
   constructor () {
     this.handlers = {}
   }
@@ -46,5 +46,3 @@ class AsyncEmitter {
     }
   }
 }
-
-module.exports = AsyncEmitter

package/src/context.js

@@ -1,12 +1,12 @@
-const assert = require('assert')
+import assert from 'node:assert'
 
-const { Transaction } = require('@google-cloud/firestore')
-const { detailedDiff } = require('deep-object-diff')
+import { Transaction } from '@google-cloud/firestore'
+import { detailedDiff } from 'deep-object-diff'
 
-const AsyncEmitter = require('./async-emitter')
-const { Data } = require('./data')
-const DBError = require('./db-error')
-const {
+import { AsyncEmitter } from './async-emitter.js'
+import { Data } from './data.js'
+import { DBError } from './db-error.js'
+import {
   InvalidOptionsError,
   InvalidParameterError,
   DeletedTwiceError,
@@ -15,12 +15,12 @@ const {
   ModelTrackedTwiceError,
   ModelAlreadyExistsError,
   TransactionLockTimeoutError
-} = require('./errors')
-const { Key } = require('./key')
-const { Model } = require('./models')
-const { sleep, loadOptionDefaults } = require('./utils')
+} from './errors.js'
+import { Key } from './key.js'
+import { Model } from './models.js'
+import { sleep, loadOptionDefaults } from './utils.js'
 
-async function getWithArgs (args, callback) {
+export async function getWithArgs (args, callback) {
   if (!args || !(args instanceof Array) || args.length === 0) {
     throw new InvalidParameterError('args', 'must be a non-empty array')
   }
@@ -70,7 +70,7 @@ async function getWithArgs (args, callback) {
  * reads across multiple docs).
  * @public
  */
-class Context {
+export class Context {
   /**
    * Options for interacting with Firestore.
    * @typedef {Object} ContextOptions
@@ -670,8 +670,3 @@ function parseFirestoreErrorPath (err) {
     }
   }
 }
-
-module.exports = {
-  Context,
-  getWithArgs
-}

package/src/data.js

@@ -1,10 +1,10 @@
-const { Key } = require('./key')
+import { Key } from './key.js'
 
 /**
  * Data includes a model's key and non-key fields.
  * @param {Object} [fields] field (non-key) values
  */
-class Data extends Key {
+export class Data extends Key {
   constructor (Cls, encodedKey, keyComponents, fields) {
     super(Cls, encodedKey, keyComponents)
     this.data = fields
@@ -18,7 +18,3 @@ class Data extends Key {
     return { ...this.keyComponents, ...this.data }
   }
 }
-
-module.exports = {
-  Data
-}

package/src/db-error.js

@@ -1,5 +1,5 @@
 // istanbul ignore file
-class DBError extends Error {
+export class DBError extends Error {
   constructor (action, e) {
     super(`Failed to ${action} with error ${e}`)
     this.code = e.code
@@ -8,5 +8,3 @@ class DBError extends Error {
     this.allErrors = e.allErrors
   }
 }
-
-module.exports = DBError

package/src/default-db.js

@@ -1,8 +1,8 @@
 // Convenient helper to setup our db connection using environment variables.
 // The constructed db instance will be cached by NodeJS.
-const Firestore = require('@google-cloud/firestore')
+import Firestore from '@google-cloud/firestore'
 
-const setup = require('./firestore')
+import setup from './firestore.js'
 
 // make Firestore look like the Transaction object (it already has getAll but
 // does not have these others)
@@ -18,4 +18,4 @@ const firestoreClient = new Firestore({
   ignoreUndefinedProperties: true
 })
 
-module.exports = setup(firestoreClient)
+export default setup(firestoreClient)

package/src/errors.js

@@ -8,7 +8,7 @@
  * @access public
  * @memberof Errors
  */
-class InvalidOptionsError extends Error {
+export class InvalidOptionsError extends Error {
   constructor (option, expectation) {
     super(`Invalid option value for ${option}. ${expectation}.`)
     this.name = this.constructor.name
@@ -21,7 +21,7 @@ class InvalidOptionsError extends Error {
  * @access public
  * @memberof Errors
  */
-class InvalidParameterError extends Error {
+export class InvalidParameterError extends Error {
   constructor (param, expectation) {
     super(`Invalid parameter ${param}. ${expectation}.`)
     this.name = this.constructor.name
@@ -34,7 +34,7 @@ class InvalidParameterError extends Error {
  * @access public
  * @memberof Errors
  */
-class InvalidFieldError extends Error {
+export class InvalidFieldError extends Error {
   constructor (field, reason) {
     super(`${field} ${reason}`)
     this.name = this.constructor.name
@@ -51,7 +51,7 @@ class InvalidFieldError extends Error {
  * @access public
  * @memberof Errors
  */
-class TransactionFailedError extends Error {
+export class TransactionFailedError extends Error {
   constructor (msg, originalException) {
     super(msg)
     this.name = this.constructor.name
@@ -62,7 +62,7 @@ class TransactionFailedError extends Error {
   }
 }
 
-class TransactionLockTimeoutError extends TransactionFailedError {
+export class TransactionLockTimeoutError extends TransactionFailedError {
   constructor (reason, original) {
     super(reason, original)
     this.name = this.constructor.name
@@ -74,7 +74,7 @@ class TransactionLockTimeoutError extends TransactionFailedError {
  * Thrown when there's some error with a particular model.
  * @memberof Errors
  */
-class GenericModelError extends Error {
+export class GenericModelError extends Error {
   constructor (msg, collection, _id) {
     super(`${msg}: ${collection} _id=${_id}`)
     this.name = this.constructor.name
@@ -87,7 +87,7 @@ class GenericModelError extends Error {
  * same key.
  * @memberof Errors
  */
-class ModelAlreadyExistsError extends GenericModelError {
+export class ModelAlreadyExistsError extends GenericModelError {
   constructor (collection, _id) {
     super('Tried to recreate an existing model', collection, _id)
   }
@@ -96,7 +96,7 @@ class ModelAlreadyExistsError extends GenericModelError {
 /**
  * Thrown when model is tracked more than once inside a transaction.
  */
-class ModelTrackedTwiceError extends GenericModelError {
+export class ModelTrackedTwiceError extends GenericModelError {
   constructor (key, trackedModel) {
     const msg = 'Model tracked twice'
     super(msg, key.Cls.collectionName, key.encodedKey)
@@ -109,7 +109,7 @@ class ModelTrackedTwiceError extends GenericModelError {
  * Thrown when a model is being deleted more than once.
  * @memberof Errors
  */
-class DeletedTwiceError extends GenericModelError {
+export class DeletedTwiceError extends GenericModelError {
   constructor (collectionName, _id) {
     super('Tried to delete model twice in the same transaction',
       collectionName, _id)
@@ -120,30 +120,16 @@ class DeletedTwiceError extends GenericModelError {
  * Thrown when a tx tries to write when it was marked read-only.
  * @memberof Errors
  */
-class WriteAttemptedInReadOnlyTxError extends Error {
+export class WriteAttemptedInReadOnlyTxError extends Error {
   constructor (dataToWrite) {
     super(`Tried to write model in a read-only transaction with the following
       changes ${JSON.stringify(dataToWrite)}`)
   }
 }
 
-class NotImplementedError extends Error {
+export class NotImplementedError extends Error {
   constructor (reason) {
     super(reason)
     this.name = this.constructor.name
   }
 }
-
-module.exports = {
-  DeletedTwiceError,
-  GenericModelError,
-  InvalidFieldError,
-  InvalidOptionsError,
-  InvalidParameterError,
-  ModelAlreadyExistsError,
-  ModelTrackedTwiceError,
-  NotImplementedError,
-  TransactionFailedError,
-  TransactionLockTimeoutError,
-  WriteAttemptedInReadOnlyTxError
-}

package/src/fields.js

@@ -1,11 +1,11 @@
-const assert = require('assert')
+import assert from 'node:assert'
 
-const { FieldValue } = require('@google-cloud/firestore')
-const deepeq = require('fast-deep-equal')
-const deepcopy = require('rfdc')()
+import { FieldValue } from '@google-cloud/firestore'
+import deepeq from 'fast-deep-equal'
+import deepcopy from 'rfdc/default'
 
-const { InvalidFieldError, InvalidOptionsError, NotImplementedError } = require('./errors')
-const { validateValue } = require('./utils')
+import { InvalidFieldError, InvalidOptionsError, NotImplementedError } from './errors.js'
+import { validateValue } from './utils.js'
 
 /**
  * Abstract class representing a field / property of a Model.
@@ -13,7 +13,7 @@ const { validateValue } = require('./utils')
  * @private
  * @memberof Internal
  */
-class __FieldInterface {
+export class __FieldInterface {
   constructor () {
     if (this.constructor === __FieldInterface) {
       throw new Error('Can not instantiate abstract class')
@@ -96,7 +96,7 @@ class __BaseField extends __FieldInterface {
  * @private
  * @memberof Internal
  */
-class __Field extends __BaseField {
+export class __Field extends __BaseField {
   static __validateFieldOptions (modelName, isKey, fieldName, schema) {
     if (fieldName.startsWith('_')) {
       throw new InvalidFieldError(
@@ -358,7 +358,7 @@ class __Field extends __BaseField {
  * @memberof Internal.Fields
  * @private
  */
-class NumberField extends __Field {
+export class NumberField extends __Field {
   constructor (options) {
     super(options)
     this.__diff = undefined
@@ -453,7 +453,7 @@ class NumberField extends __Field {
  * @memberof Internal.Fields
  * @private
  */
-class StringField extends __Field {
+export class StringField extends __Field {
   get mutated () {
     return this.__mayHaveMutated && super.mutated
   }
@@ -464,7 +464,7 @@ class StringField extends __Field {
  * @memberof Internal.Fields
  * @private
  */
-class ObjectField extends __Field {
+export class ObjectField extends __Field {
   /**
    * This method checks for equality deeply against the initial
    * value so use it as sparsely as possible. It is primarily meant to be
@@ -483,14 +483,14 @@ class ObjectField extends __Field {
  * @memberof Internal.Fields
  * @private
  */
-class BooleanField extends __Field {}
+export class BooleanField extends __Field {}
 
 /**
  * @extends Internal.__Field
  * @memberof Internal.Fields
  * @private
  */
-class ArrayField extends __Field {
+export class ArrayField extends __Field {
   /**
    * This method checks for equality deeply against the initial
    * value so use it as sparsely as possible. It is primarily meant to be
@@ -504,7 +504,7 @@ class ArrayField extends __Field {
   }
 }
 
-const SCHEMA_TYPE_TO_FIELD_CLASS_MAP = {
+export const SCHEMA_TYPE_TO_FIELD_CLASS_MAP = {
   array: ArrayField,
   boolean: BooleanField,
   float: NumberField,
@@ -513,14 +513,3 @@ const SCHEMA_TYPE_TO_FIELD_CLASS_MAP = {
   object: ObjectField,
   string: StringField
 }
-
-module.exports = {
-  __FieldInterface,
-  __Field,
-  NumberField,
-  ArrayField,
-  BooleanField,
-  StringField,
-  ObjectField,
-  SCHEMA_TYPE_TO_FIELD_CLASS_MAP
-}

package/src/firestore.js

@@ -1,10 +1,10 @@
-const S = require('@pbvision/schema')
+import S from '@pbvision/schema'
 
-const {
+import {
   getWithArgs,
   Context
-} = require('./context')
-const {
+} from './context.js'
+import {
   DeletedTwiceError,
   InvalidFieldError,
   InvalidOptionsError,
@@ -13,17 +13,17 @@ const {
   ModelTrackedTwiceError,
   TransactionFailedError,
   WriteAttemptedInReadOnlyTxError
-} = require('./errors')
-const {
+} from './errors.js'
+import {
   __Field,
   ArrayField,
   BooleanField,
   NumberField,
   ObjectField,
   StringField
-} = require('./fields')
-const { Key, UniqueKeyList } = require('./key')
-const { Model } = require('./models')
+} from './fields.js'
+import { Key, UniqueKeyList } from './key.js'
+import { Model } from './models.js'
 
 /**
  * @module firestore
@@ -37,7 +37,7 @@ const { Model } = require('./models')
  * @returns {Object} Symbols that clients of this library can use.
  * @private
  */
-function setup (firestoreDB) {
+export default function setup (firestoreDB) {
   Key.firestoreDB = firestoreDB
   const toExport = {
     S,
@@ -71,5 +71,3 @@ function setup (firestoreDB) {
   }
   return toExport
 }
-
-module.exports = setup

package/src/key.js

@@ -1,7 +1,7 @@
 /**
  * Key uniquely identifies a model.
  */
-class Key {
+export class Key {
   /**
    * @param {Model} Cls a Model class
    * @param {Object} encodedKey encoded key
@@ -26,7 +26,7 @@ class Key {
  * This is useful because key equality cannot be checked with the
  * built-in equality operator.
  */
-class UniqueKeyList extends Array {
+export class UniqueKeyList extends Array {
   constructor (...keys) {
     super(...keys)
     const hashes = keys.map(key => this.constructor.getKeyHash(key))
@@ -59,8 +59,3 @@ class UniqueKeyList extends Array {
     return ret
   }
 }
-
-module.exports = {
-  Key,
-  UniqueKeyList
-}

package/src/models.js

@@ -1,26 +1,26 @@
-const assert = require('assert')
+import assert from 'node:assert'
 
-const { Transaction } = require('@google-cloud/firestore')
-const S = require('@pbvision/schema')
-const stableStringify = require('fast-json-stable-stringify')
+import { Transaction } from '@google-cloud/firestore'
+import S from '@pbvision/schema'
+import stableStringify from 'fast-json-stable-stringify'
 
-const { Data } = require('./data')
-const {
+import { Data } from './data.js'
+import {
   InvalidFieldError,
   InvalidParameterError,
   GenericModelError
-} = require('./errors')
-const { __Field, SCHEMA_TYPE_TO_FIELD_CLASS_MAP } = require('./fields')
-const { Key } = require('./key')
-const {
+} from './errors.js'
+import { __Field, SCHEMA_TYPE_TO_FIELD_CLASS_MAP } from './fields.js'
+import { Key } from './key.js'
+import {
   validateValue,
   SCHEMA_TYPE_TO_JS_TYPE_MAP
-} = require('./utils')
+} from './utils.js'
 
 /**
  * The base class for modeling data.
  */
-class Model {
+export class Model {
   /**
    * Create a representation of a database Doc. Should only be used by the
    * library.
@@ -86,7 +86,7 @@ class Model {
         opts,
         val: vals[name],
         valIsFromDB: !this.isNew && !this.__isPartial,
-        valSpecified: valSpecified,
+        valSpecified,
         isForUpdate: this.__isPartial
       })
       Object.seal(field)
@@ -536,7 +536,3 @@ class Model {
     return ret
   }
 }
-
-module.exports = {
-  Model
-}

package/src/utils.js

@@ -1,10 +1,10 @@
-const {
+import {
   InvalidFieldError,
   InvalidOptionsError,
   InvalidParameterError
-} = require('./errors')
+} from './errors.js'
 
-function validateValue (fieldName, opts, val) {
+export function validateValue (fieldName, opts, val) {
   const schema = opts.schema
   const valueType = SCHEMA_TYPE_TO_JS_TYPE_MAP[schema.type]
 
@@ -22,7 +22,7 @@ function validateValue (fieldName, opts, val) {
   return valueType
 }
 
-const SCHEMA_TYPE_TO_JS_TYPE_MAP = {
+export const SCHEMA_TYPE_TO_JS_TYPE_MAP = {
   array: Array,
   boolean: Boolean,
   integer: Number,
@@ -32,13 +32,13 @@ const SCHEMA_TYPE_TO_JS_TYPE_MAP = {
   string: String
 }
 
-async function sleep (millis) {
+export async function sleep (millis) {
   return new Promise((resolve, reject) => {
     setTimeout(resolve, millis)
   })
 }
 
-function checkUnexpectedOptions (options, defaults) {
+export function checkUnexpectedOptions (options, defaults) {
   if (typeof options !== 'object') {
     throw new InvalidParameterError('options', 'must be an object')
   }
@@ -58,18 +58,10 @@ function checkUnexpectedOptions (options, defaults) {
   })
 }
 
-function loadOptionDefaults (options, defaults) {
+export function loadOptionDefaults (options, defaults) {
   // istanbul ignore next
   options = options || {}
   checkUnexpectedOptions(options, defaults)
   const retOptions = Object.assign({}, defaults)
   return Object.assign(retOptions, options)
 }
-
-module.exports = {
-  checkUnexpectedOptions,
-  loadOptionDefaults,
-  SCHEMA_TYPE_TO_JS_TYPE_MAP,
-  sleep,
-  validateValue
-}