teamplay 0.4.0-alpha.36 → 0.4.0-alpha.38

package/README.md

@@ -19,6 +19,18 @@ Features:
 
 For installation and documentation see [teamplay.dev](https://teamplay.dev)
 
+## ORM Compat Helpers
+
+For legacy Racer-style model mixins (for example versioning libraries which call
+`getAssociations()`), use ORM compat helpers from the `teamplay/orm` subpath:
+
+```js
+import BaseModel, { hasMany, hasOne, belongsTo } from 'teamplay/orm'
+```
+
+These helpers attach class-level associations and expose them through
+`$doc.getAssociations()` on model signals.
+
 ## License
 
 MIT

package/orm/Compat/README.md

@@ -389,6 +389,11 @@ console.log(getSubscriptionGcDelay()) // 500
 When refCount drops to `0`, unsubscribe/destroy is scheduled after this delay.
 If a new subscribe arrives before timeout, pending destroy is cancelled and the same doc/query instance is reused.
 
+Compat queries also retain lifecycle ownership of docs they materialize into DataTree.
+This means a doc that arrived through `useQuery` / `useBatchQuery` will stay available
+for immediate `useLocal` / `useModel` reads while that query remains subscribed, even if
+some unrelated `useDoc` subscriber for the same `collection.id` unmounts.
+
 ### set(value) and set(path, value)
 
 `SignalCompat` accepts both:

package/orm/Doc.js

@@ -149,6 +149,15 @@ export class DocSubscriptions {
     return doc._subscribing
   }
 
+  retain ($doc) {
+    const segments = [...$doc[SEGMENTS]]
+    const hash = hashDoc(segments)
+    this.cancelDestroy(hash)
+    const count = this.subCount.get(hash) || 0
+    this.subCount.set(hash, count + 1)
+    this.init($doc)
+  }
+
   async unsubscribe ($doc) {
     const segments = [...$doc[SEGMENTS]]
     const hash = hashDoc(segments)
@@ -167,6 +176,23 @@ export class DocSubscriptions {
     await this.scheduleDestroy(segments)
   }
 
+  async release ($doc) {
+    const segments = [...$doc[SEGMENTS]]
+    const hash = hashDoc(segments)
+    let count = this.subCount.get(hash) || 0
+    count -= 1
+    if (count < 0) {
+      if (ERROR_ON_EXCESSIVE_UNSUBSCRIBES) throw ERRORS.notSubscribed($doc)
+      return
+    }
+    if (count > 0) {
+      this.subCount.set(hash, count)
+      return
+    }
+    this.subCount.set(hash, 0)
+    await this.scheduleDestroy(segments)
+  }
+
   async destroy (segments) {
     const hash = hashDoc(segments)
     await this.destroyByHash(hash, { force: true })

package/orm/Query.js

@@ -89,7 +89,7 @@ export class Query {
       const ids = this.shareQuery.results.map(doc => doc.id)
       for (const docId of ids) {
         const $doc = getSignal(undefined, [this.collectionName, docId])
-        docSubscriptions.init($doc)
+        docSubscriptions.retain($doc)
         this.docSignals.add($doc)
       }
       _set([QUERIES, this.hash, 'ids'], ids)
@@ -112,7 +112,7 @@ export class Query {
       const ids = shareDocs.map(doc => doc.id)
       for (const docId of ids) {
         const $doc = getSignal(undefined, [this.collectionName, docId])
-        docSubscriptions.init($doc)
+        docSubscriptions.retain($doc)
         this.docSignals.add($doc)
       }
       _get([QUERIES, this.hash, 'ids']).splice(index, 0, ...ids)
@@ -172,6 +172,7 @@ export class Query {
       const docIds = shareDocs.map(doc => doc.id)
       for (const docId of docIds) {
         const $doc = getSignal(undefined, [this.collectionName, docId])
+        docSubscriptions.release($doc).catch(ignoreDestroyError)
         this.docSignals.delete($doc)
       }
       const ids = _get([QUERIES, this.hash, 'ids'])
@@ -202,6 +203,9 @@ export class Query {
   }
 
   _removeData () {
+    for (const $doc of this.docSignals) {
+      docSubscriptions.release($doc).catch(ignoreDestroyError)
+    }
     this.docSignals.clear()
     _del([QUERIES, this.hash])
   }

package/orm/SignalBase.js

@@ -60,6 +60,18 @@ export const DEFAULT_GETTERS = ['path', 'id', 'get', 'peek', 'getId', 'map', 're
 export class Signal extends Function {
   static ID_FIELDS = DEFAULT_ID_FIELDS
   static [GETTERS] = DEFAULT_GETTERS
+  static associations = []
+
+  static addAssociation (association) {
+    if (!association || typeof association !== 'object') {
+      throw Error('Signal.addAssociation() expects an association object')
+    }
+    const inherited = this.associations || []
+    const own = Object.prototype.hasOwnProperty.call(this, 'associations')
+      ? this.associations
+      : inherited.slice()
+    this.associations = own.concat(association)
+  }
 
   constructor (segments) {
     if (!Array.isArray(segments)) throw Error('Signal constructor expects an array of segments')
@@ -184,6 +196,11 @@ export class Signal extends Function {
     return this[SEGMENTS][0]
   }
 
+  getAssociations () {
+    const $raw = rawSignal(this) || this
+    return $raw.constructor.associations || []
+  }
+
   * [Symbol.iterator] () {
     if (this[IS_QUERY]) {
       const ids = _get([QUERIES, this[HASH], 'ids'])

package/orm/associations.js

@@ -0,0 +1,99 @@
+function getCollectionName (OrmEntity, options = {}, helperName = 'association') {
+  if (options.key) return undefined
+  const collection = OrmEntity?.collection
+  if (typeof collection === 'string' && collection) return collection
+  throw new Error(
+    `teamplay/${helperName}: Associated model must define static "collection" ` +
+    'or pass options.key explicitly'
+  )
+}
+
+function toSingular (name) {
+  if (typeof name !== 'string' || !name) return name
+  if (name.endsWith('ies') && name.length > 3) return name.slice(0, -3) + 'y'
+  if (name.endsWith('sses') && name.length > 4) return name.slice(0, -2) // classes -> class
+  if (name.endsWith('ses') && name.length > 3) return name.slice(0, -2) // houses -> house
+  if (name.endsWith('s') && !name.endsWith('ss') && name.length > 1) return name.slice(0, -1)
+  return name
+}
+
+export function belongsTo (AssociatedOrmEntity, options = {}) {
+  return function decorateBelongsTo (OrmEntity) {
+    const key = options.key || (toSingular(
+      getCollectionName(AssociatedOrmEntity, options, 'belongsTo')
+    ) + 'Id')
+
+    OrmEntity.addAssociation(
+      Object.assign({
+        type: 'belongsTo',
+        orm: AssociatedOrmEntity,
+        key
+      }, options)
+    )
+
+    AssociatedOrmEntity.addAssociation(
+      Object.assign({
+        type: 'oppositeBelongsTo',
+        orm: OrmEntity,
+        key,
+        opposite: true
+      }, options)
+    )
+
+    return OrmEntity
+  }
+}
+
+export function hasMany (AssociatedOrmEntity, options = {}) {
+  return function decorateHasMany (OrmEntity) {
+    const key = options.key || (toSingular(
+      getCollectionName(AssociatedOrmEntity, options, 'hasMany')
+    ) + 'Ids')
+
+    OrmEntity.addAssociation(
+      Object.assign({
+        type: 'hasMany',
+        orm: AssociatedOrmEntity,
+        key
+      }, options)
+    )
+
+    AssociatedOrmEntity.addAssociation(
+      Object.assign({
+        type: 'oppositeHasMany',
+        orm: OrmEntity,
+        key,
+        opposite: true
+      }, options)
+    )
+
+    return OrmEntity
+  }
+}
+
+export function hasOne (AssociatedOrmEntity, options = {}) {
+  return function decorateHasOne (OrmEntity) {
+    const key = options.key || (toSingular(
+      getCollectionName(AssociatedOrmEntity, options, 'hasOne')
+    ) + 'Id')
+
+    OrmEntity.addAssociation(
+      Object.assign({
+        type: 'hasOne',
+        orm: AssociatedOrmEntity,
+        key
+      }, options)
+    )
+
+    AssociatedOrmEntity.addAssociation(
+      Object.assign({
+        type: 'oppositeHasOne',
+        orm: OrmEntity,
+        key,
+        opposite: true
+      }, options)
+    )
+
+    return OrmEntity
+  }
+}

package/orm/index.d.ts

@@ -0,0 +1,6 @@
+export const BaseModel: any
+export default BaseModel
+
+export function belongsTo (AssociatedOrmEntity: any, options?: Record<string, any>): (OrmEntity: any) => any
+export function hasMany (AssociatedOrmEntity: any, options?: Record<string, any>): (OrmEntity: any) => any
+export function hasOne (AssociatedOrmEntity: any, options?: Record<string, any>): (OrmEntity: any) => any

package/orm/index.js

@@ -0,0 +1,5 @@
+import Signal from './Signal.js'
+export { belongsTo, hasMany, hasOne } from './associations.js'
+
+export const BaseModel = Signal
+export default BaseModel

package/package.json

@@ -1,11 +1,12 @@
 {
   "name": "teamplay",
-  "version": "0.4.0-alpha.36",
+  "version": "0.4.0-alpha.38",
   "description": "Full-stack signals ORM with multiplayer",
   "type": "module",
   "main": "index.js",
   "exports": {
     ".": "./index.js",
+    "./orm": "./orm/index.js",
     "./connect": "./connect/index.js",
     "./server": "./server.js",
     "./connect-test": "./connect/test.js",
@@ -81,5 +82,5 @@
     ]
   },
   "license": "MIT",
-  "gitHead": "0f90958b39502634ec8fefc99d7e688f0ac4c4bc"
+  "gitHead": "fb010df766a588f54f91b1bc14dfd14a7c178d33"
 }