teamplay 0.1.13 → 0.1.14

package/orm/Signal.js

@@ -12,13 +12,15 @@
  *    in the raw data tree which have the same name as signal's methods
  */
 import uuid from '@teamplay/utils/uuid'
-import { get as _get, set as _set, del as _del, setPublicDoc as _setPublicDoc } from './dataTree.js'
+import { get as _get, set as _set, del as _del, setPublicDoc as _setPublicDoc, getRaw } from './dataTree.js'
 import getSignal, { rawSignal } from './getSignal.js'
 import { IS_QUERY, HASH, QUERIES } from './Query.js'
 import { ROOT_FUNCTION, getRoot } from './Root.js'
 import { publicOnly } from './connection.js'
 
 export const SEGMENTS = Symbol('path segments targeting the particular node in the data tree')
+export const ARRAY_METHOD = Symbol('run array method on the signal')
+export const GET = Symbol('get the value of the signal - either observed or raw')
 
 export default class Signal extends Function {
   constructor (segments) {
@@ -36,13 +38,23 @@ export default class Signal extends Function {
     return uuid()
   }
 
-  get () {
-    if (arguments.length > 0) throw Error('Signal.get() does not accept any arguments')
+  [GET] (method) {
+    if (arguments.length > 1) throw Error('Signal[GET]() only accepts method as an argument')
     if (this[IS_QUERY]) {
       const hash = this[HASH]
-      return _get([QUERIES, hash, 'docs'])
+      return method([QUERIES, hash, 'docs'])
     }
-    return _get(this[SEGMENTS])
+    return method(this[SEGMENTS])
+  }
+
+  get () {
+    if (arguments.length > 0) throw Error('Signal.get() does not accept any arguments')
+    return this[GET](_get)
+  }
+
+  peek () {
+    if (arguments.length > 0) throw Error('Signal.peek() does not accept any arguments')
+    return this[GET](getRaw)
   }
 
   getId () {
@@ -62,19 +74,32 @@ export default class Signal extends Function {
     }
   }
 
-  map (...args) {
+  [ARRAY_METHOD] (method, nonArrayReturnValue, ...args) {
     if (this[IS_QUERY]) {
       const collection = this[SEGMENTS][0]
       const hash = this[HASH]
       const ids = _get([QUERIES, hash, 'ids'])
-      return ids.map(id => getSignal(getRoot(this), [collection, id])).map(...args)
+      return ids.map(
+        id => getSignal(getRoot(this), [collection, id])
+      )[method](...args)
     }
     const items = _get(this[SEGMENTS])
-    if (!Array.isArray(items)) return []
-    return Array(items.length)
-      .fill()
-      .map((_, index) => getSignal(getRoot(this), [...this[SEGMENTS], index]))
-      .map(...args)
+    if (!Array.isArray(items)) return nonArrayReturnValue
+    return Array(items.length).fill().map(
+      (_, index) => getSignal(getRoot(this), [...this[SEGMENTS], index])
+    )[method](...args)
+  }
+
+  map (...args) {
+    return this[ARRAY_METHOD]('map', [], ...args)
+  }
+
+  reduce (...args) {
+    return this[ARRAY_METHOD]('reduce', undefined, ...args)
+  }
+
+  find (...args) {
+    return this[ARRAY_METHOD]('find', undefined, ...args)
   }
 
   async set (value) {
@@ -104,7 +129,9 @@ export default class Signal extends Function {
     if (this[IS_QUERY]) throw Error('Signal.pop() can\'t be used on a query signal')
     const array = this.get()
     if (!Array.isArray(array) || array.length === 0) return
+    const lastItem = array[array.length - 1]
     await this[array.length - 1].del()
+    return lastItem
   }
 
   // TODO: implement a json0 operation for unshift
@@ -138,6 +165,7 @@ export default class Signal extends Function {
     }
     id ??= uuid()
     await this[id].set(value)
+    return id
   }
 
   async del () {
@@ -178,7 +206,7 @@ export const regularBindings = {
   }
 }
 
-const QUERY_METHODS = ['map', 'get']
+const QUERY_METHODS = ['map', 'reduce', 'find', 'get']
 
 // dot syntax always returns a child signal even if such method or property exists.
 // The method is only called when the signal is explicitly called as a function,
@@ -201,6 +229,7 @@ export const extremelyLateBindings = {
     if (typeof key === 'symbol') return Reflect.get(signal, key, receiver)
     if (key === 'then') return undefined // handle checks for whether the symbol is a Promise
     key = transformAlias(signal[SEGMENTS], key)
+    key = maybeTransformToArrayIndex(key)
     if (signal[IS_QUERY]) {
       if (key === 'ids') return getSignal(getRoot(signal), [QUERIES, signal[HASH], 'ids'])
       if (QUERY_METHODS.includes(key)) return Reflect.get(signal, key, receiver)
@@ -209,6 +238,14 @@ export const extremelyLateBindings = {
   }
 }
 
+const REGEX_POSITIVE_INTEGER = /^(?:0|[1-9]\d*)$/
+// Transform the key to a number if it's a positive integer.
+// Otherwise the key must be a string.
+function maybeTransformToArrayIndex (key) {
+  if (typeof key === 'string' && REGEX_POSITIVE_INTEGER.test(key)) return +key
+  return key
+}
+
 const transformAlias = (({
   collectionsMapping = {
     session: '_session',

package/orm/dataTree.js

@@ -23,7 +23,7 @@ export function getRaw (segments) {
 
 export function set (segments, value, tree = dataTree) {
   let dataNode = tree
-  let dataNodeRaw = raw(dataTree)
+  let dataNodeRaw = raw(tree)
   for (let i = 0; i < segments.length - 1; i++) {
     const segment = segments[i]
     if (dataNode[segment] == null) {

package/orm/sub.js

@@ -3,9 +3,16 @@ import { docSubscriptions } from './Doc.js'
 import { querySubscriptions, getQuerySignal } from './Query.js'
 
 export default function sub ($signal, params) {
+  if (Array.isArray($signal)) {
+    const res = $signal.map(args => Array.isArray(args) ? sub(...args) : sub(args))
+    if (res.some($s => $s.then)) return Promise.all(res)
+    return res
+  }
   if (isPublicDocumentSignal($signal)) {
+    if (arguments.length > 1) throw Error(ERRORS.subDocArguments(...arguments))
     return doc$($signal)
   } else if (isPublicCollectionSignal($signal)) {
+    if (arguments.length !== 2) throw Error(ERRORS.subQueryArguments(...arguments))
     return query$($signal, params)
   } else if (typeof $signal === 'function' && !($signal instanceof Signal)) {
     return api$($signal, params)
@@ -21,6 +28,7 @@ function doc$ ($doc) {
 }
 
 function query$ ($collection, params) {
+  if (typeof params !== 'object') throw Error(ERRORS.queryParamsObject($collection, params))
   const $query = getQuerySignal($collection[SEGMENTS], params)
   const promise = querySubscriptions.subscribe($query)
   if (!promise) return $query
@@ -30,3 +38,27 @@ function query$ ($collection, params) {
 function api$ (fn, args) {
   throw Error('sub() for async functions is not implemented yet')
 }
+
+const ERRORS = {
+  subDocArguments: ($signal, ...args) => `
+    sub($doc) accepts only 1 argument - the document signal to subscribe to
+    Doc: ${$signal[SEGMENTS]}
+    Got args: ${[$signal, ...args]}
+  `,
+  subQueryArguments: ($signal, params, ...args) => `
+    sub($collection, params) accepts 2 arguments - the collection signal and an object with query params.
+    If you want to subscribe to all documents in a collection, pass an empty object: sub($collection, {}).
+    Collection: ${$signal[SEGMENTS]}
+    Params: ${params}
+    Got args: ${[$signal, params, ...args]}
+  `,
+  queryParamsObject: ($collection, params) => `
+    sub($collection, params):
+      Params must be an object.
+      If you want to subscribe to all documents in a collection, pass an empty object: sub($collection, {}).
+
+      Got:
+        $collection: ${$collection[SEGMENTS]}
+        params: ${params}
+  `
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "teamplay",
-  "version": "0.1.13",
+  "version": "0.1.14",
   "description": "Full-stack signals ORM with multiplayer",
   "type": "module",
   "main": "index.js",
@@ -23,12 +23,12 @@
   },
   "dependencies": {
     "@nx-js/observer-util": "^4.1.3",
-    "@teamplay/backend": "^0.1.13",
-    "@teamplay/cache": "^0.1.13",
-    "@teamplay/channel": "^0.1.13",
-    "@teamplay/debug": "^0.1.13",
-    "@teamplay/schema": "^0.1.13",
-    "@teamplay/utils": "^0.1.13",
+    "@teamplay/backend": "^0.1.14",
+    "@teamplay/cache": "^0.1.14",
+    "@teamplay/channel": "^0.1.14",
+    "@teamplay/debug": "^0.1.14",
+    "@teamplay/schema": "^0.1.14",
+    "@teamplay/utils": "^0.1.14",
     "diff-match-patch": "^1.0.5",
     "events": "^3.3.0",
     "json0-ot-diff": "^1.1.2",
@@ -63,5 +63,5 @@
     ]
   },
   "license": "MIT",
-  "gitHead": "1abacbe2dd704f77dfa20d061edf89490ac65cee"
+  "gitHead": "edc77f39753ed2532266bbfea646cb3cb7ca6786"
 }