@live-change/relations-plugin 0.5.21 → 0.5.24

package/pluralRelationUtils.js

@@ -0,0 +1,158 @@
+const App = require("@live-change/framework")
+const { PropertyDefinition, ViewDefinition, IndexDefinition, ActionDefinition } = App
+const { extractIdParts, extractRange, extractIdentifiers, extractObjectData } = require("./utils.js")
+
+const pluralize = require('pluralize')
+
+function defineView(config, context) {
+  const { service, modelRuntime, otherPropertyNames, joinedOthersPropertyName, joinedOthersClassName,
+    modelName, others, model } = context
+  const indexName = 'by'+context.joinedOthersClassName
+  const viewProperties = {}
+  for (let i = 0; i < others.length; i++) {
+    viewProperties[otherPropertyNames[i]] = new PropertyDefinition({
+      type: others[i],
+      validation: ['nonEmpty']
+    })
+  }
+  const viewName = joinedOthersPropertyName + context.reverseRelationWord + pluralize(modelName)
+  service.views[viewName] = new ViewDefinition({
+    name: viewName,
+    properties: {
+      ...viewProperties,
+      ...App.utils.rangeProperties
+    },
+    returns: {
+      type: Array,
+      of: {
+        type: model
+      }
+    },
+    access: config.readAccess,
+    daoPath(properties, { client, context }) {
+      const idParts = extractIdParts(otherPropertyNames, properties)
+      const range = extractRange(properties)
+      const path = modelRuntime().sortedIndexRangePath(indexName, idParts, range)
+      return path
+    }
+  })
+}
+
+function defineCreateAction(config, context) {
+  const {
+    service, app, model,  defaults, modelPropertyName, modelRuntime,
+    otherPropertyNames, joinedOthersPropertyName, modelName, writeableProperties, joinedOthersClassName
+  } = context
+  const eventName = joinedOthersPropertyName + context.reverseRelationWord + modelName + 'Created'
+  const actionName = 'set' + joinedOthersClassName + context.reverseRelationWord + modelName
+  service.actions[actionName] = new ActionDefinition({
+    name: actionName,
+    properties: {
+      ...(model.properties)
+    },
+    access: config.createAccess || config.writeAccess,
+    skipValidation: true,
+    //queuedBy: otherPropertyNames,
+    waitForEvents: true,
+    async execute(properties, { client, service }, emit) {
+      const id = properties[modelPropertyName] || app.generateUid()
+      const entity = await modelRuntime().get(id)
+      if(entity) throw 'exists'
+      const identifiers = extractIdentifiers(otherPropertyNames, properties)
+      const data = extractObjectData(writeableProperties, properties, defaults)
+      await App.validation.validate(data, validators, { source: action, action, service, app, client })
+      emit({
+        type: eventName,
+        [modelPropertyName]: id,
+        identifiers, data
+      })
+    }
+  })
+  const action = service.actions[actionName]
+  const validators = App.validation.getValidators(action, service, action)
+}
+
+function defineUpdateAction(config, context) {
+  const {
+    service, app, model, modelRuntime, modelPropertyName,
+    otherPropertyNames, joinedOthersPropertyName, modelName, writeableProperties, joinedOthersClassName
+  } = context
+  const eventName = joinedOthersPropertyName + context.reverseRelationWord + modelName + 'Updated'
+  const actionName = 'update' + joinedOthersClassName + context.reverseRelationWord + modelName
+  service.actions[actionName] = new ActionDefinition({
+    name: actionName,
+    properties: {
+      ...(model.properties)
+    },
+    access: config.updateAccess || config.writeAccess,
+    skipValidation: true,
+    //queuedBy: otherPropertyNames,
+    waitForEvents: true,
+    async execute(properties, {client, service}, emit) {
+      const id = properties[modelPropertyName]
+      const entity = await modelRuntime().get(id)
+      if(!entity) throw 'not_found'
+      const entityIdParts = extractIdParts(otherPropertyNames, entity)
+      const idParts = extractIdParts(otherPropertyNames, properties)
+      if(JSON.stringify(entityIdParts) != JSON.stringify(idParts)) {
+        throw 'not_authorized'
+      }
+      const identifiers = extractIdentifiers(otherPropertyNames, properties)
+      const data = extractObjectData(writeableProperties, properties, entity)
+      await App.validation.validate(data, validators, { source: action, action, service, app, client })
+      emit({
+        type: eventName,
+        [modelPropertyName]: id,
+        identifiers,
+        data
+      })
+    }
+  })
+  const action = service.actions[actionName]
+  const validators = App.validation.getValidators(action, service, action)
+}
+
+function defineDeleteAction(config, context) {
+  const {
+    service, app, model, modelRuntime, modelPropertyName,
+    otherPropertyNames, joinedOthersPropertyName, modelName, writeableProperties, joinedOthersClassName
+  } = context
+  const eventName = joinedOthersPropertyName + context.reverseRelationWord + modelName + 'Deleted'
+  const actionName = 'delete' + joinedOthersClassName + context.reverseRelationWord + modelName
+  service.actions[actionName] = new ActionDefinition({
+    name: actionName,
+    properties: {
+      ...(model.properties)
+    },
+    access: config.deleteAccess || config.writeAccess,
+    skipValidation: true,
+    //queuedBy: otherPropertyNames,
+    waitForEvents: true,
+    async execute(properties, {client, service}, emit) {
+      const id = properties[modelPropertyName]
+      const entity = await modelRuntime().get(id)
+      if(!entity) throw new Error('not_found')
+      const entityIdParts = extractIdParts(otherPropertyNames, entity)
+      const idParts = extractIdParts(otherPropertyNames, properties)
+      if(JSON.stringify(entityIdParts) != JSON.stringify(idParts)) {
+        throw new Error('not_authorized')
+      }
+      emit({
+        type: eventName,
+        [modelPropertyName]: id
+      })
+    }
+  })
+}
+
+function defineSortIndex(context, sortFields) {
+  if(!Array.isArray(sortFields)) sortFields = [sortFields]
+  console.log("DEFINE SORT INDEX", sortFields)
+  const sortFieldsUc = sortFields.map(fd=>fd.slice(0, 1).toUpperCase() + fd.slice(1))
+  const indexName = 'by' + context.joinedOthersClassName + sortFieldsUc.join('')
+  context.model.indexes[indexName] = new IndexDefinition({
+    property: [...context.otherPropertyNames, ...sortFields]
+  })
+}
+
+module.exports = { defineView, defineCreateAction, defineUpdateAction, defineDeleteAction, defineSortIndex }

package/propertyOf.js

@@ -1,142 +1,17 @@
-const App = require("@live-change/framework")
-const { PropertyDefinition, ViewDefinition, IndexDefinition, ActionDefinition, EventDefinition } = App
-
 const {
-  extractIdParts, extractIdentifiers, extractObjectData, defineProperties, defineIndex,
+  defineProperties, defineIndex,
   processModelsAnnotation, generateId
 } = require('./utils.js')
 
+const { defineSetEvent, defineUpdatedEvent, defineTransferredEvent, defineResetEvent } = require('./propertyEvents.js')
 
-function defineView(config, context) {
-  const { service, modelRuntime, otherPropertyNames, joinedOthersPropertyName, joinedOthersClassName,
-     modelName, others, model } = context
-  const viewProperties = {}
-  for (let i = 0; i < others.length; i++) {
-    viewProperties[otherPropertyNames[i]] = new PropertyDefinition({
-      type: others[i],
-      validation: ['nonEmpty']
-    })
-  }
-  const viewName = config.name || ((config.prefix ? (config.prefix + joinedOthersClassName) : joinedOthersPropertyName) +
-    'Owned' + modelName + (config.suffix || ''))
-  service.views[viewName] = new ViewDefinition({
-    name: viewName,
-    properties: {
-      ...viewProperties
-    },
-    returns: {
-      type: model,
-    },
-    access: config.access,
-    daoPath(properties, { client, context }) {
-      const idParts = extractIdParts(otherPropertyNames, properties)
-      const id = idParts.length > 1 ? idParts.map(p => JSON.stringify(p)).join(':') : idParts[0]
-      const path = config.fields ? modelRuntime().limitedPath(id, config.fields) : modelRuntime().path(id)
-      return path
-    }
-  })
-}
-
-const  { defineSetEvent, defineUpdatedEvent, defineTransferredEvent, defineResetEvent } = require('./propertyEvents.js')
-
-function defineSetAction(config, context) {
-  const {
-    service, app, model,  defaults,
-    otherPropertyNames, joinedOthersPropertyName, modelName, writeableProperties, joinedOthersClassName
-  } = context
-  const eventName = joinedOthersPropertyName + 'Owned' + modelName + 'Set'
-  const actionName = 'set' + joinedOthersClassName + 'Owned' + modelName
-  service.actions[actionName] = new ActionDefinition({
-    name: actionName,
-    properties: {
-      ...(model.properties)
-    },
-    access: config.setAccess || config.writeAccess,
-    skipValidation: true,
-    queuedBy: otherPropertyNames,
-    waitForEvents: true,
-    async execute(properties, {client, service}, emit) {
-      const identifiers = extractIdentifiers(otherPropertyNames, properties)
-      const data = extractObjectData(writeableProperties, properties, defaults)
-      await App.validation.validate(data, validators, { source: action, action, service, app, client })
-      emit({
-        type: eventName,
-        identifiers, data
-      })
-    }
-  })
-  const action = service.actions[actionName]
-  const validators = App.validation.getValidators(action, service, action)
-}
-
-function defineUpdateAction(config, context) {
-  const {
-    service, app, model, modelRuntime,
-    otherPropertyNames, joinedOthersPropertyName, modelName, writeableProperties, joinedOthersClassName
-  } = context
-  const eventName = joinedOthersPropertyName + 'Owned' + modelName + 'Updated'
-  const actionName = 'update' + joinedOthersClassName + 'Owned' + modelName
-  service.actions[actionName] = new ActionDefinition({
-    name: actionName,
-    properties: {
-      ...(model.properties)
-    },
-    access: config.updateAccess || config.writeAccess,
-    skipValidation: true,
-    queuedBy: otherPropertyNames,
-    waitForEvents: true,
-    async execute(properties, {client, service}, emit) {
-      const identifiers = extractIdentifiers(otherPropertyNames, properties)
-      const id = generateId(otherPropertyNames, properties)
-      const entity = await modelRuntime().get(id)
-      if (!entity) throw new Error('not_found')
-      const data = extractObjectData(writeableProperties, properties, entity)
-      await App.validation.validate(data, validators, { source: action, action, service, app, client })
-      emit({
-        type: eventName,
-        identifiers, data
-      })
-    }
-  })
-  const action = service.actions[actionName]
-  const validators = App.validation.getValidators(action, service, action)
-}
-
-function defineResetAction(config, context) {
-  const {
-    service, modelRuntime, modelPropertyName,
-    otherPropertyNames, joinedOthersPropertyName, modelName, joinedOthersClassName, model
-  } = context
-  const eventName = joinedOthersPropertyName + 'Owned' + modelName + 'Reset'
-  const actionName = 'reset' + joinedOthersClassName + 'Owned' + modelName
-  service.actions[actionName] = new ActionDefinition({
-    name: actionName,
-    properties: {
-      [modelPropertyName]: {
-        type: model,
-        validation: ['nonEmpty']
-      }
-    },
-    access: config.resetAccess || config.writeAccess,
-    queuedBy: otherPropertyNames,
-    waitForEvents: true,
-    async execute(properties, {client, service}, emit) {
-      const identifiers = extractIdentifiers(otherPropertyNames, properties)
-      const id = generateId(otherPropertyNames, properties)
-      const entity = await modelRuntime().get(id)
-      if (!entity) throw new Error('not_found')
-      emit({
-        type: eventName,
-        identifiers
-      })
-    }
-  })
-}
-
-
+const { defineView, defineSetAction, defineUpdateAction, defineResetAction } = require('./singularRelationUtils.js')
 
 module.exports = function(service, app) {
-  processModelsAnnotation(service, app, 'propertyOf', (config, context) => {
+  processModelsAnnotation(service, app, 'propertyOf', false, (config, context) => {
+
+    context.relationWord = 'Property'
+    context.reverseRelationWord = 'Owned'
 
     defineProperties(context.model, context.others, context.otherPropertyNames)
     defineIndex(context.model, context.joinedOthersClassName, context.otherPropertyNames)

package/propertyOfAny.js

@@ -1,151 +1,21 @@
-const App = require("@live-change/framework")
-const { PropertyDefinition, ViewDefinition, IndexDefinition, ActionDefinition, EventDefinition } = App
-
-const {
-  extractObjectData
-} = require('./utils.js')
-
 const {
-  extractTypeAndIdParts, extractIdentifiersWithTypes, defineAnyProperties, defineAnyIndex,
+  defineAnyProperties, defineAnyIndex,
   processModelsAnyAnnotation, generateAnyId
 } = require('./utilsAny.js')
 
+const {
+  defineSetEvent, defineUpdatedEvent, defineTransferredEvent, defineResetEvent
+} = require('./propertyEvents.js')
 
-function defineView(config, context) {
-  const { service, modelRuntime, otherPropertyNames, joinedOthersPropertyName, joinedOthersClassName,
-     modelName, others, model } = context
-  const viewProperties = {}
-  for (let i = 0; i < others.length; i++) {
-    viewProperties[otherPropertyNames[i]] = new PropertyDefinition({
-      type: others[i],
-      validation: ['nonEmpty']
-    })
-    viewProperties[otherPropertyNames[i] + 'Type'] = new PropertyDefinition({
-      type: 'String',
-      validation: ['nonEmpty']
-    })
-  }
-  const viewName = config.name || ((config.prefix ? (config.prefix + joinedOthersClassName) : joinedOthersPropertyName) +
-    'Owned' + modelName + (config.suffix || ''))
-  service.views[viewName] = new ViewDefinition({
-    name: viewName,
-    properties: {
-      ...viewProperties
-    },
-    returns: {
-      type: model,
-    },
-    access: config.access,
-    daoPath(properties, { client, context }) {
-      const typeAndIdParts = extractTypeAndIdParts(otherPropertyNames, properties)
-      const id = typeAndIdParts.length > 1 ? typeAndIdParts.map(p => JSON.stringify(p)).join(':') : idParts[0]
-      const path = config.fields ? modelRuntime().limitedPath(id, config.fields) : modelRuntime().path(id)
-      return path
-    }
-  })
-}
-
-const { defineSetEvent, defineUpdatedEvent, defineTransferredEvent, defineResetEvent } = require('./propertyEvents.js')
-
-function defineSetAction(config, context) {
-  const {
-    service, app, model,  defaults,
-    otherPropertyNames, joinedOthersPropertyName, modelName, writeableProperties, joinedOthersClassName
-  } = context
-
-  const eventName = joinedOthersPropertyName + 'Owned' + modelName + 'Set'
-  const actionName = 'set' + joinedOthersClassName + 'Owned' + modelName
-  service.actions[actionName] = new ActionDefinition({
-    name: actionName,
-    properties: {
-      ...(model.properties)
-    },
-    access: config.setAccess || config.writeAccess,
-    skipValidation: true,
-    queuedBy: otherPropertyNames,
-    waitForEvents: true,
-    async execute(properties, {client, service}, emit) {
-      const identifiers = extractIdentifiersWithTypes(otherPropertyNames, properties)
-      const data = extractObjectData(writeableProperties, properties, defaults)
-      await App.validation.validate(data, validators, { source: action, action, service, app, client })
-      emit({
-        type: eventName,
-        identifiers, data
-      })
-    }
-  })
-  const action = service.actions[actionName]
-  const validators = App.validation.getValidators(action, service, action)
-}
-
-function defineUpdateAction(config, context) {
-  const {
-    service, app, model, modelRuntime,
-    otherPropertyNames, joinedOthersPropertyName, modelName, writeableProperties, joinedOthersClassName
-  } = context
-  const eventName = joinedOthersPropertyName + 'Owned' + modelName + 'Updated'
-  const actionName = 'update' + joinedOthersClassName + 'Owned' + modelName
-  service.actions[actionName] = new ActionDefinition({
-    name: actionName,
-    properties: {
-      ...(model.properties)
-    },
-    access: config.updateAccess || config.writeAccess,
-    skipValidation: true,
-    queuedBy: otherPropertyNames,
-    waitForEvents: true,
-    async execute(properties, {client, service}, emit) {
-      const identifiers = extractIdentifiersWithTypes(otherPropertyNames, properties)
-      const id = generateAnyId(otherPropertyNames, properties)
-      const entity = await modelRuntime().get(id)
-      if (!entity) throw new Error('not_found')
-      const data = extractObjectData(writeableProperties, properties, entity)
-      await App.validation.validate(data, validators, { source: action, action, service, app, client })
-      emit({
-        type: eventName,
-        identifiers, data
-      })
-    }
-  })
-  const action = service.actions[actionName]
-  const validators = App.validation.getValidators(action, service, action)
-}
-
-function defineResetAction(config, context) {
-  const {
-    service, modelRuntime, modelPropertyName,
-    otherPropertyNames, joinedOthersPropertyName, modelName, joinedOthersClassName, model
-  } = context
-  const eventName = joinedOthersPropertyName + 'Owned' + modelName + 'Reset'
-  const actionName = 'reset' + joinedOthersClassName + 'Owned' + modelName
-  service.actions[actionName] = new ActionDefinition({
-    name: actionName,
-    properties: {
-      [modelPropertyName]: {
-        type: model,
-        validation: ['nonEmpty']
-      }
-    },
-    access: config.resetAccess || config.writeAccess,
-    queuedBy: otherPropertyNames,
-    waitForEvents: true,
-    async execute(properties, {client, service}, emit) {
-      const identifiers = extractIdentifiersWithTypes(otherPropertyNames, properties)
-      const id = generateAnyId(otherPropertyNames, properties)
-      const entity = await modelRuntime().get(id)
-      if (!entity) throw new Error('not_found')
-      emit({
-        type: eventName,
-        identifiers
-      })
-    }
-  })
-}
-
-
+const {
+  defineView, defineSetAction, defineUpdateAction, defineResetAction
+} = require('./singularRelationAnyUtils.js')
 
 module.exports = function(service, app) {
-  processModelsAnyAnnotation(service, app, 'propertyOfAny', (config, context) => {
+  processModelsAnyAnnotation(service, app, 'propertyOfAny', false, (config, context) => {
+
+    context.relationWord = 'Property'
+    context.reverseRelationWord = 'Owned'
 
     defineAnyProperties(context.model, context.otherPropertyNames)
     defineAnyIndex(context.model, context.joinedOthersClassName, context.otherPropertyNames)
@@ -175,5 +45,6 @@ module.exports = function(service, app) {
     if(config.resetAccess || config.writeAccess) {
       defineResetAction(config, context);
     }
+
   })
 }

package/relatedTo.js

@@ -0,0 +1,51 @@
+const {
+  defineProperties, defineIndex,
+  processModelsAnnotation
+} = require('./utils.js')
+
+const {
+  defineCreatedEvent, defineUpdatedEvent, defineDeletedEvent, defineTransferredEvent,
+} = require('./itemEvents.js')
+
+const {
+  defineView, defineCreateAction, defineUpdateAction, defineDeleteAction, defineSortIndex
+} = require('./pluralRelationUtils.js')
+
+module.exports = function(service, app) {
+  processModelsAnnotation(service, app, 'relatedTo', true, (config, context) => {
+
+    context.relationWord = 'Friend'
+    context.reverseRelationWord = 'Related'
+
+    defineProperties(context.model, context.others, context.otherPropertyNames)
+    defineIndex(context.model, context.joinedOthersClassName, context.otherPropertyNames)
+
+    if(config.sortBy) {
+      for(const sortFields of config.sortBy) {
+        defineSortIndex(context, sortFields)
+      }
+    }
+
+    if(config.readAccess) {
+      defineView(config, context)
+    }
+    /// TODO: multiple views with limited fields
+
+    defineCreatedEvent(config, context)
+    defineUpdatedEvent(config, context)
+    defineTransferredEvent(config, context)
+    defineDeletedEvent(config, context)
+
+    if(config.createAccess || config.writeAccess) {
+      defineCreateAction(config, context)
+    }
+
+    if(config.updateAccess || config.writeAccess) {
+      defineUpdateAction(config, context)
+    }
+
+    if(config.resetAccess || config.writeAccess) {
+      defineDeleteAction(config, context)
+    }
+  })
+}

package/relatedToAny.js

@@ -0,0 +1,51 @@
+const {
+  defineAnyProperties, defineAnyIndex,
+  processModelsAnyAnnotation
+} = require('./utilsAny.js')
+
+const {
+  defineCreatedEvent, defineUpdatedEvent, defineDeletedEvent, defineTransferredEvent,
+} = require('./itemEvents.js')
+
+const {
+  defineView, defineCreateAction, defineUpdateAction, defineDeleteAction, defineSortIndex
+} = require('./pluralRelationAnyUtils.js')
+
+module.exports = function(service, app) {
+  processModelsAnyAnnotation(service, app, 'relatedToAny',true, (config, context) => {
+
+    context.relationWord = 'Friend'
+    context.reverseRelationWord = 'Related'
+
+    defineAnyProperties(context.model, context.otherPropertyNames)
+    defineAnyIndex(context.model, context.joinedOthersClassName, context.otherPropertyNames)
+
+    if(config.sortBy) {
+      for(const sortFields of config.sortBy) {
+        defineSortIndex(context, sortFields)
+      }
+    }
+
+    if(config.readAccess) {
+      defineView(config, context)
+    }
+    /// TODO: multiple views with limited fields
+
+    defineCreatedEvent(config, context)
+    defineUpdatedEvent(config, context)
+    defineTransferredEvent(config, context)
+    defineDeletedEvent(config, context)
+
+    if(config.createAccess || config.writeAccess) {
+      defineCreateAction(config, context)
+    }
+
+    if(config.updateAccess || config.writeAccess) {
+      defineUpdateAction(config, context)
+    }
+
+    if(config.resetAccess || config.writeAccess) {
+      defineDeleteAction(config, context)
+    }
+  })
+}