teamplay 0.3.16 → 0.3.18

package/index.js

@@ -14,7 +14,12 @@ export { GLOBAL_ROOT_ID } from './orm/Root.js'
 export const $ = _getRootSignal({ rootId: GLOBAL_ROOT_ID, rootFunction: universal$ })
 export default $
 export { default as sub } from './orm/sub.js'
-export { default as useSub, useAsyncSub, setUseDeferredValue as __setUseDeferredValue } from './react/useSub.js'
+export {
+  default as useSub,
+  useAsyncSub,
+  setUseDeferredValue as __setUseDeferredValue,
+  setDefaultDefer as __setDefaultDefer
+} from './react/useSub.js'
 export { default as observer } from './react/observer.js'
 export { connection, setConnection, getConnection, fetchOnly, setFetchOnly, publicOnly, setPublicOnly } from './orm/connection.js'
 export { useId, useNow, useScheduleUpdate, useTriggerUpdate } from './react/helpers.js'

package/orm/Signal.js

@@ -24,7 +24,7 @@ export const SEGMENTS = Symbol('path segments targeting the particular node in t
 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 const GETTERS = Symbol('get the list of this signal\'s getters')
-const DEFAULT_GETTERS = ['path', 'id', 'get', 'peek', 'getId', 'map', 'reduce', 'find', 'getIds']
+const DEFAULT_GETTERS = ['path', 'id', 'get', 'peek', 'getId', 'map', 'reduce', 'find', 'getIds', 'getCollection']
 
 export default class Signal extends Function {
   static [GETTERS] = DEFAULT_GETTERS
@@ -108,6 +108,14 @@ export default class Signal extends Function {
     return this[SEGMENTS][this[SEGMENTS].length - 1]
   }
 
+  getCollection () {
+    if (this[SEGMENTS].length === 0) throw Error('Can\'t get the collection of the root signal')
+    if (this[SEGMENTS][0] === AGGREGATIONS) {
+      return getAggregationCollectionName(this[SEGMENTS])
+    }
+    return this[SEGMENTS][0]
+  }
+
   * [Symbol.iterator] () {
     if (this[IS_QUERY]) {
       const ids = _get([QUERIES, this[HASH], 'ids'])

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "teamplay",
-  "version": "0.3.16",
+  "version": "0.3.18",
   "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.3.16",
-    "@teamplay/cache": "^0.3.16",
-    "@teamplay/channel": "^0.3.16",
-    "@teamplay/debug": "^0.3.16",
-    "@teamplay/schema": "^0.3.16",
-    "@teamplay/utils": "^0.3.16",
+    "@teamplay/backend": "^0.3.18",
+    "@teamplay/cache": "^0.3.18",
+    "@teamplay/channel": "^0.3.18",
+    "@teamplay/debug": "^0.3.18",
+    "@teamplay/schema": "^0.3.18",
+    "@teamplay/utils": "^0.3.18",
     "diff-match-patch": "^1.0.5",
     "events": "^3.3.0",
     "json0-ot-diff": "^1.1.2",
@@ -63,5 +63,5 @@
     ]
   },
   "license": "MIT",
-  "gitHead": "92ca8b74d176193e90f8a379eeaec31299b807bb"
+  "gitHead": "5c3e2b44f536b53adfc94ead762834ab2e907858"
 }

package/react/helpers.js

@@ -46,6 +46,12 @@ export function useScheduleUpdate () {
   return context.scheduleUpdate
 }
 
+export function useDefer () {
+  const context = useContext(ComponentMetaContext)
+  if (!context) throw Error(ERRORS.useScheduleUpdate)
+  return context.defer
+}
+
 export function useCache (key) {
   const context = useContext(ComponentMetaContext)
   if (!context) throw Error(ERRORS.useCache)

package/react/useSub.js

@@ -1,13 +1,15 @@
 import { useRef, useDeferredValue } from 'react'
 import sub from '../orm/sub.js'
-import { useScheduleUpdate, useCache } from './helpers.js'
+import { useScheduleUpdate, useCache, useDefer } from './helpers.js'
 import executionContextTracker from './executionContextTracker.js'
 
 let TEST_THROTTLING = false
 
 // experimental feature to leverage useDeferredValue() to handle re-subscriptions.
 // Currently it does lead to issues with extra rerenders and requires further investigation
-let USE_DEFERRED_VALUE = false
+let USE_DEFERRED_VALUE = true
+// by default we want to defer stuff if possible instead of throwing promises
+let DEFAULT_DEFER = true
 
 export function useAsyncSub (signal, params, options) {
   return useSub(signal, params, { ...options, async: true })
@@ -22,12 +24,16 @@ export default function useSub (signal, params, options) {
 }
 
 // version of sub() which works as a react hook and throws promise for Suspense
-export function useSubDeferred (signal, params, { async = false } = {}) {
+export function useSubDeferred (signal, params, { async = false, defer } = {}) {
   const $signalRef = useRef() // eslint-disable-line react-hooks/rules-of-hooks
   const scheduleUpdate = useScheduleUpdate()
-  signal = useDeferredValue(signal)
-  params = useDeferredValue(params ? JSON.stringify(params) : undefined)
-  params = params != null ? JSON.parse(params) : undefined
+  const observerDefer = useDefer()
+  defer ??= observerDefer ?? DEFAULT_DEFER
+  if (defer) {
+    signal = useDeferredValue(signal) // eslint-disable-line react-hooks/rules-of-hooks
+    params = useDeferredValue(params ? JSON.stringify(params) : undefined) // eslint-disable-line react-hooks/rules-of-hooks
+    params = params != null ? JSON.parse(params) : undefined
+  }
   const promiseOrSignal = params != null ? sub(signal, params) : sub(signal)
   // 1. if it's a promise, throw it so that Suspense can catch it and wait for subscription to finish
   if (promiseOrSignal.then) {
@@ -97,6 +103,9 @@ export function resetTestThrottling () {
 export function setUseDeferredValue (value) {
   USE_DEFERRED_VALUE = value
 }
+export function setDefaultDefer (value) {
+  DEFAULT_DEFER = value
+}
 
 // throttle to simulate slow network
 function maybeThrottle (promise) {

package/react/wrapIntoSuspense.js

@@ -17,6 +17,7 @@ function destroyAdm (adm) {
 export default function wrapIntoSuspense ({
   Component,
   forwardRef,
+  defer,
   suspenseProps = DEFAULT_SUSPENSE_PROPS
 } = {}) {
   if (!suspenseProps?.fallback) throw Error(ERRORS.noFallback)
@@ -62,6 +63,7 @@ export default function wrapIntoSuspense ({
       componentMetaRef.current = {
         componentId,
         createdAt: Date.now(),
+        defer,
         triggerUpdate: () => adm.onStoreChange?.(),
         scheduleUpdate: promise => adm.scheduleUpdate?.(promise),
         cache: {