teamplay 0.4.0-alpha.0 → 0.4.0-alpha.10

package/index.d.ts

@@ -28,6 +28,8 @@ export function observer<
 
 // Keep existing public surface available even if typed loosely for now.
 export const $: any
+export const $root: any
+export const model: any
 export { default as Signal, SEGMENTS } from './orm/Signal.js'
 export { __DEBUG_SIGNALS_CACHE__, rawSignal, getSignalClass } from './orm/getSignal.js'
 export { default as addModel } from './orm/addModel.js'
@@ -40,6 +42,57 @@ export {
   setUseDeferredValue as __setUseDeferredValue,
   setDefaultDefer as __setDefaultDefer
 } from './react/useSub.js'
+export function useValue (defaultValue?: any): [any, any]
+export function useValue$ (defaultValue?: any): any
+export function useModel (path?: any): any
+export function useLocal (path?: any): [any, any]
+export function useLocal$ (path?: any): any
+export function useSession (path?: any): [any, any]
+export function useSession$ (path?: any): any
+export function usePage (path?: any): [any, any]
+export function usePage$ (path?: any): any
+export function useBatch (): void
+export function useDoc (collection: string, id: any, options?: any): [any, any]
+export function useDoc$ (collection: string, id: any, options?: any): any
+export function useBatchDoc (collection: string, id: any, options?: any): [any, any]
+export function useBatchDoc$ (collection: string, id: any, options?: any): any
+export function useAsyncDoc (collection: string, id: any, options?: any): [any, any]
+export function useAsyncDoc$ (collection: string, id: any, options?: any): any
+export function useQuery (collection: string, query: any, options?: any): [any, any]
+export function useQuery$ (collection: string, query: any, options?: any): any
+export function useAsyncQuery (collection: string, query: any, options?: any): [any, any]
+export function useAsyncQuery$ (collection: string, query: any, options?: any): any
+export function useBatchQuery (collection: string, query: any, options?: any): [any, any]
+export function useBatchQuery$ (collection: string, query: any, options?: any): any
+export function useQueryIds (collection: string, ids?: any[], options?: any): [any, any]
+export function useBatchQueryIds (collection: string, ids?: any[], options?: any): [any, any]
+export function useAsyncQueryIds (collection: string, ids?: any[], options?: any): [any, any]
+export function useQueryDoc (collection: string, query: any, options?: any): [any, any]
+export function useQueryDoc$ (collection: string, query: any, options?: any): any
+export function useBatchQueryDoc (collection: string, query: any, options?: any): [any, any]
+export function useBatchQueryDoc$ (collection: string, query: any, options?: any): any
+export function useAsyncQueryDoc (collection: string, query: any, options?: any): [any, any]
+export function useAsyncQueryDoc$ (collection: string, query: any, options?: any): any
+export function useLocalDoc (collection: string, id: any): [any, any]
+export function useLocalDoc$ (collection: string, id: any): any
+export function emit (eventName: string, ...args: any[]): void
+export function useOn (
+  eventName: 'change' | 'all',
+  pattern: string | { path: () => string },
+  handler: (...args: any[]) => void,
+  deps?: any[]
+): void
+export function useOn (eventName: string, handler: (...args: any[]) => void, deps?: any[]): void
+export function useEmit (): (eventName: string, ...args: any[]) => void
+export function batch<T = any> (fn?: () => T): T | undefined
+export function batchModel<T = any> (fn?: () => T): T | undefined
+export function clone<T = any> (value: T): T
+export function initLocalCollection (name: string): any
+export function useApi (api: (...args: any[]) => any, args?: any[], options?: { debounce?: number }): [any, boolean, any]
+type EffectCleanup = (() => void) | undefined
+export function useDidUpdate (fn: () => EffectCleanup, deps?: any[]): void
+export function useOnce (condition: any, fn: () => EffectCleanup): void
+export function useSyncEffect (fn: () => EffectCleanup, deps?: any[]): void
 export { connection, setConnection, getConnection, fetchOnly, setFetchOnly, publicOnly, setPublicOnly } from './orm/connection.js'
 export { useId, useNow, useScheduleUpdate, useTriggerUpdate } from './react/helpers.js'
 export { GUID_PATTERN, hasMany, hasOne, hasManyFlags, belongsTo, pickFormFields } from '@teamplay/schema'

package/index.js

@@ -5,6 +5,7 @@
 //   In future, we might want to separate the plain JS and React APIs
 import { getRootSignal as _getRootSignal, GLOBAL_ROOT_ID } from './orm/Root.js'
 import universal$ from './react/universal$.js'
+import useApi from './react/useApi.js'
 
 export { default as Signal, SEGMENTS } from './orm/Signal.js'
 export { __DEBUG_SIGNALS_CACHE__, rawSignal, getSignalClass } from './orm/getSignal.js'
@@ -12,6 +13,8 @@ export { default as addModel } from './orm/addModel.js'
 export { default as signal } from './orm/getSignal.js'
 export { GLOBAL_ROOT_ID } from './orm/Root.js'
 export const $ = _getRootSignal({ rootId: GLOBAL_ROOT_ID, rootFunction: universal$ })
+export const $root = $
+export const model = $
 export default $
 export { default as sub } from './orm/sub.js'
 export {
@@ -21,12 +24,86 @@ export {
   setDefaultDefer as __setDefaultDefer
 } from './react/useSub.js'
 export { default as observer } from './react/observer.js'
+export {
+  useValue,
+  useValue$,
+  useModel,
+  useLocal,
+  useLocal$,
+  useLocalDoc,
+  useLocalDoc$,
+  useSession,
+  useSession$,
+  usePage,
+  usePage$,
+  useBatch,
+  useDoc,
+  useDoc$,
+  useBatchDoc,
+  useBatchDoc$,
+  useAsyncDoc,
+  useAsyncDoc$,
+  useQuery,
+  useQuery$,
+  useAsyncQuery,
+  useAsyncQuery$,
+  useBatchQuery,
+  useBatchQuery$,
+  useQueryIds,
+  useBatchQueryIds,
+  useAsyncQueryIds,
+  useQueryDoc,
+  useQueryDoc$,
+  useBatchQueryDoc,
+  useBatchQueryDoc$,
+  useAsyncQueryDoc,
+  useAsyncQueryDoc$
+} from './orm/Compat/hooksCompat.js'
+export { emit, useOn, useEmit } from './orm/Compat/eventsCompat.js'
+export {
+  useDidUpdate,
+  useOnce,
+  useSyncEffect
+} from './react/helpers.js'
 export { connection, setConnection, getConnection, fetchOnly, setFetchOnly, publicOnly, setPublicOnly } from './orm/connection.js'
 export { useId, useNow, useScheduleUpdate, useTriggerUpdate } from './react/helpers.js'
 export { GUID_PATTERN, hasMany, hasOne, hasManyFlags, belongsTo, pickFormFields } from '@teamplay/schema'
 export { aggregation, aggregationHeader as __aggregationHeader } from '@teamplay/utils/aggregation'
 export { accessControl } from '@teamplay/utils/accessControl'
 
+export function batch (fn) {
+  return $.batch(fn)
+}
+
+export function batchModel (fn) {
+  return $.batch(fn)
+}
+
+export function clone (value) {
+  if (typeof globalThis.structuredClone === 'function') {
+    try {
+      return globalThis.structuredClone(value)
+    } catch {}
+  }
+  if (value == null) return value
+  return JSON.parse(JSON.stringify(value))
+}
+
+export function initLocalCollection (name) {
+  if (typeof name !== 'string') throw Error('initLocalCollection() expects a collection name')
+  if (!name) return
+  const segments = name.split('.').filter(Boolean)
+  if (!segments.length) return
+  let $cursor = $
+  for (const segment of segments) {
+    $cursor = $cursor[segment]
+  }
+  if ($cursor.get() == null) $cursor.set({})
+  return $cursor
+}
+
+export { useApi }
+
 export function getRootSignal (options) {
   return _getRootSignal({
     rootFunction: universal$,

package/orm/Aggregation.js

@@ -3,6 +3,7 @@ import { set as _set, del as _del, getRaw } from './dataTree.js'
 import getSignal from './getSignal.js'
 import { QuerySubscriptions, hashQuery, Query, HASH, PARAMS, COLLECTION_NAME, parseQueryHash } from './Query.js'
 import Signal, { SEGMENTS } from './Signal.js'
+import { getIdFieldsForSegments, isPlainObject } from './idFields.js'
 
 export const IS_AGGREGATION = Symbol('is aggregation signal')
 export const AGGREGATIONS = '$aggregations'
@@ -11,11 +12,13 @@ class Aggregation extends Query {
   _initData () {
     {
       const extra = raw(this.shareQuery.extra)
+      injectAggregationIds(extra, this.collectionName)
       _set([AGGREGATIONS, this.hash], extra)
     }
 
     this.shareQuery.on('extra', extra => {
       extra = raw(extra)
+      injectAggregationIds(extra, this.collectionName)
       _set([AGGREGATIONS, this.hash], extra)
     })
   }
@@ -27,6 +30,18 @@ class Aggregation extends Query {
 
 export const aggregationSubscriptions = new QuerySubscriptions(Aggregation)
 
+function injectAggregationIds (extra, collectionName) {
+  if (!Array.isArray(extra)) return
+  const idFields = getIdFieldsForSegments([collectionName, ''])
+  for (const doc of extra) {
+    if (!isPlainObject(doc)) continue
+    const docId = doc._id ?? doc.id
+    if (docId == null) continue
+    if (idFields.includes('_id') && doc._id !== docId) doc._id = docId
+    if (idFields.includes('id') && doc.id !== docId) doc.id = docId
+  }
+}
+
 export function getAggregationSignal (collectionName, params, options) {
   params = JSON.parse(JSON.stringify(params))
   const hash = hashQuery(collectionName, params)