@live-change/relations-plugin 0.6.4 → 0.6.7

package/entity.js

@@ -0,0 +1,226 @@
+const {
+  defineProperties, defineIndex,
+  processModelsAnnotation, extractIdParts, extractIdentifiers, extractObjectData
+} = require('./utils.js')
+const App = require("@live-change/framework")
+
+const annotation = 'entity'
+
+function defineView(config, context) {
+  const { service, modelRuntime, modelName, others, model } = context
+  const viewName = (config.prefix || '' ) + modelName + (config.suffix || '')
+  service.views[viewName] = new ViewDefinition({
+    name: viewName,
+    properties: {
+      [modelName]: {
+        type: model,
+        validation: ['nonEmpty']
+      }
+    },
+    returns: {
+      type: model,
+    },
+    access: config.access,
+    daoPath(properties, { client, context }) {
+      const id = properties[modelName]
+      const path = config.fields ? modelRuntime().limitedPath(id, config.fields) : modelRuntime().path(id)
+      return path
+    }
+  })
+}
+
+function defineCreatedEvent(config, context) {
+  const {
+    service, modelRuntime, modelName, modelPropertyName
+  } = context
+  const eventName = modelName + 'Created'
+  service.events[eventName] = new EventDefinition({
+    name: eventName,
+    execute(properties) {
+      const id = properties[modelPropertyName]
+      return modelRuntime().create({ ...properties.data, id })
+    }
+  })
+}
+
+function defineUpdatedEvent(config, context) {
+  const {
+    service, modelRuntime, modelName, modelPropertyName
+  } = context
+  const eventName = modelName + 'Updated'
+  service.events[eventName] = new EventDefinition({
+    name: eventName,
+    execute(properties) {
+      const id = properties[modelPropertyName]
+      return modelRuntime().update(id, { ...properties.data, id })
+    }
+  })
+}
+
+function defineDeletedEvent(config, context) {
+  const {
+    service, modelRuntime, modelName, modelPropertyName,
+  } = context
+  const eventName = modelName + 'Deleted'
+  service.events[eventName] = new EventDefinition({
+    name: eventName,
+    execute(properties) {
+      const id = properties[modelPropertyName]
+      return modelRuntime().delete(id)
+    }
+  })
+}
+
+
+function defineCreateAction(config, context) {
+  const {
+    service, app, model,  defaults, modelPropertyName, modelRuntime,
+    modelName, writeableProperties
+  } = context
+  const eventName = modelName + 'Created'
+  const actionName = 'create' + 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 data = extractObjectData(writeableProperties, properties, defaults)
+      await App.validation.validate({ ...data }, validators,
+        { source: action, action, service, app, client })
+      emit({
+        type: eventName,
+        [modelPropertyName]: id,
+        data
+      })
+    }
+  })
+  const action = service.actions[actionName]
+  const validators = App.validation.getValidators(action, service, action)
+}
+
+function defineUpdateAction(config, context) {
+  const {
+    service, app, model, modelRuntime, modelPropertyName,
+    modelName, writeableProperties
+  } = context
+  const eventName = modelName + 'Updated'
+  const actionName = 'update' + 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 data = extractObjectData(writeableProperties, properties, entity)
+      await App.validation.validate({ ...identifiers, ...data }, validators,
+        { source: action, action, service, app, client })
+      emit({
+        type: eventName,
+        [modelPropertyName]: id,
+        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, modelName,
+  } = context
+  const eventName = modelName + 'Deleted'
+  const actionName = 'delete' + modelName
+  service.actions[actionName] = new ActionDefinition({
+    name: actionName,
+    properties: {
+      ...(model.properties)
+    },
+    access: config.deleteAccess || config.writeAccess,
+    skipValidation: true,
+    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')
+      emit({
+        type: eventName,
+        [modelPropertyName]: id
+      })
+    }
+  })
+}
+
+module.exports = function(service, app) {
+  if (!service) throw new Error("no service")
+  if (!app) throw new Error("no app")
+
+  for(let modelName in service.models) {
+    const model = service.models[modelName]
+    const config = model[annotation]
+    if(!config) continue
+
+    if (model[annotation + 'Processed']) throw new Error("duplicated processing of " + annotation + " processor")
+    model[annotation + 'Processed'] = true
+
+    const originalModelProperties = { ...model.properties }
+    const modelProperties = Object.keys(model.properties)
+    const modelPropertyName = modelName.slice(0, 1).toLowerCase() + modelName.slice(1)
+    const defaults = App.utils.generateDefault(originalModelProperties)
+
+    function modelRuntime() {
+      return service._runtime.models[modelName]
+    }
+
+    if (!model.indexes) {
+      model.indexes = {}
+    }
+
+    const writeableProperties = modelProperties || config.writeableProperties
+    //console.log("PPP", others)
+    const otherPropertyNames = others.map(other => other.slice(0, 1).toLowerCase() + other.slice(1))
+
+    const context = {
+      service, app, model, originalModelProperties, modelProperties, modelPropertyName, defaults, modelRuntime,
+      otherPropertyNames, modelName, writeableProperties, annotation
+    }
+
+    if (config.readAccess) {
+      defineView(config, context)
+    }
+    /// TODO: multiple views with limited fields
+
+    defineCreatedEvent(config, context)
+    defineUpdatedEvent(config, context)
+    defineDeletedEvent(config, context)
+
+    if (config.createAccess || config.writeAccess) {
+      defineCreateAction(config, context)
+    }
+
+    if (config.updateAccess || config.writeAccess) {
+      defineUpdateAction(config, context)
+    }
+
+    if (config.deleteAccess || config.writeAccess) {
+      defineDeleteAction(config, context)
+    }
+
+  }
+}

package/index.js

@@ -1,3 +1,5 @@
+const entity = require('./entity.js')
+
 const propertyOf = require('./propertyOf.js')
 const itemOf = require('./itemOf.js')
 
@@ -11,6 +13,7 @@ const boundTo = require('./boundTo.js')
 const boundToAny = require('./boundToAny.js')
 
 const processors = [
+  entity,
   propertyOf, itemOf,
   propertyOfAny, itemOfAny,
   relatedTo, relatedToAny,
@@ -23,4 +26,4 @@ module.exports = function(app, services) {
 
 module.exports.processors = [
     ...processors
-]
+]

package/itemOf.js

@@ -1,6 +1,6 @@
 const {
   defineProperties, defineIndex,
-  processModelsAnnotation
+  processModelsAnnotation, addAccessControlParents
 } = require('./utils.js')
 
 const {
@@ -18,6 +18,7 @@ module.exports = function(service, app) {
     context.reverseRelationWord = 'Owned'
 
     context.identifiers = defineProperties(context.model, context.others, context.otherPropertyNames)
+    addAccessControlParents(context)
     defineIndex(context.model, context.joinedOthersClassName, context.otherPropertyNames)
 
     if(config.sortBy) {
@@ -48,4 +49,4 @@ module.exports = function(service, app) {
       defineDeleteAction(config, context)
     }
   })
-}
+}

package/itemOfAny.js

@@ -1,6 +1,6 @@
 const {
   defineAnyProperties, defineAnyIndexes,
-  processModelsAnyAnnotation
+  processModelsAnyAnnotation, addAccessControlAnyParents
 } = require('./utilsAny.js')
 
 const {
@@ -18,6 +18,7 @@ module.exports = function(service, app) {
     context.reverseRelationWord = 'Owned'
 
     context.identifiers = defineAnyProperties(context.model, context.otherPropertyNames)
+    addAccessControlAnyParents(context)
     defineAnyIndexes(context.model, context.otherPropertyNames)
 
     if(config.sortBy) {
@@ -49,4 +50,4 @@ module.exports = function(service, app) {
       defineDeleteAction(config, context)
     }
   })
-}
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@live-change/relations-plugin",
-  "version": "0.6.4",
+  "version": "0.6.7",
   "description": "",
   "main": "index.js",
   "scripts": {
@@ -21,8 +21,8 @@
     "url": "https://www.viamage.com/"
   },
   "dependencies": {
-    "@live-change/framework": "^0.6.4",
+    "@live-change/framework": "^0.6.7",
     "pluralize": "8.0.0"
   },
-  "gitHead": "7a2db2aaf4b35a65bbbe90a979eb08ae5f216cf8"
+  "gitHead": "a7da9fe3eab0de40fd465b9fc29a0a73047e86ab"
 }

package/pluralRelationAnyUtils.js

@@ -165,7 +165,7 @@ function defineDeleteAction(config, context) {
 function defineSortIndex(context, sortFields) {
   if(!Array.isArray(sortFields)) sortFields = [sortFields]
   const sortFieldsUc = sortFields.map(fd => fd.slice(0, 1).toUpperCase() + fd.slice(1))
-  const indexName = 'by' + context.joinedOthersClassName + sortFieldsUc.join('')
+  const indexName = 'by' + context.joinedOthersClassName + 'And' + sortFieldsUc.join('And')
   const property = [...(context.otherPropertyNames.map(prop => [prop + 'Type', prop]).flat()), ...sortFields]
   console.log("DEFINE SORT INDEX", sortFields, "NAME", indexName, "PROP", property)
   context.model.indexes[indexName] = new IndexDefinition({

package/propertyOf.js

@@ -1,6 +1,6 @@
 const {
   defineProperties, defineIndex,
-  processModelsAnnotation, generateId
+  processModelsAnnotation, generateId, addAccessControlParents
 } = require('./utils.js')
 
 const { defineSetEvent, defineUpdatedEvent, defineTransferredEvent, defineResetEvent } = require('./propertyEvents.js')
@@ -16,6 +16,7 @@ module.exports = function(service, app) {
     context.reverseRelationWord = 'Owned'
 
     context.identifiers = defineProperties(context.model, context.others, context.otherPropertyNames)
+    addAccessControlParents(context)
     defineIndex(context.model, context.joinedOthersClassName, context.otherPropertyNames)
 
     if(config.readAccess) {
@@ -48,4 +49,4 @@ module.exports = function(service, app) {
       defineResetAction(config, context);
     }
   })
-}
+}

package/propertyOfAny.js

@@ -1,6 +1,6 @@
 const {
   defineAnyProperties, defineAnyIndexes,
-  processModelsAnyAnnotation, generateAnyId
+  processModelsAnyAnnotation, generateAnyId, addAccessControlAnyParents
 } = require('./utilsAny.js')
 
 const {
@@ -19,6 +19,7 @@ module.exports = function(service, app) {
     context.partialReverseRelationWord = 'Owned'
 
     context.identifiers = defineAnyProperties(context.model, context.otherPropertyNames)
+    addAccessControlAnyParents(context)
     defineAnyIndexes(context.model, context.otherPropertyNames)
 
     if(config.readAccess) {
@@ -53,4 +54,4 @@ module.exports = function(service, app) {
     }
 
   })
-}
+}

package/utils.js

@@ -115,7 +115,25 @@ function processModelsAnnotation(service, app, annotation, multiple, cb) {
   }
 }
 
+function addAccessControlParents(context) {
+  const { modelRuntime } = context
+  context.model.accessControlParents = async (id) => {
+    const data = await modelRuntime().get(id)
+    return context.otherPropertyNames.map(otherPropertyName => {
+      const objectType = (otherPropertyName.slice(0, 1).toUpperCase() + otherPropertyName.slice(1))
+      const object = data[otherPropertyName]
+      return { objectType, object }
+    }).filter(parent => parent.object && parent.objectType)
+  }
+  context.model.accessControlParentsSource = context.otherPropertyNames.map(
+    otherPropertyName => ({
+      property: otherPropertyName,
+      type: (otherPropertyName.slice(0, 1).toUpperCase() + otherPropertyName.slice(1))
+    })
+  )
+}
+
 module.exports = {
   extractIdParts, extractIdentifiers, extractObjectData, defineProperties, defineIndex,
-  processModelsAnnotation, generateId
-}
+  processModelsAnnotation, generateId, addAccessControlParents
+}

package/utilsAny.js

@@ -117,8 +117,26 @@ function processModelsAnyAnnotation(service, app, annotation, multiple, cb) {
   }
 }
 
+function addAccessControlAnyParents(context) {
+  const { modelRuntime } = context
+  context.model.accessControlParents = async (id) => {
+    const data = await modelRuntime().get(id)
+    return context.otherPropertyNames.map(otherPropertyName => {
+      const objectType = data[otherPropertyName + 'Type']
+      const object = data[otherPropertyName]
+      return { objectType, object }
+    }).filter(parent => parent.object && parent.objectType)
+  }
+  context.model.accessControlParentsSource = context.otherPropertyNames.map(
+    otherPropertyName => ({
+      property: otherPropertyName
+    })
+  )
+}
+
 module.exports = {
   extractTypeAndIdParts, extractIdentifiersWithTypes, defineAnyProperties,
   defineAnyIndex, defineAnyIndexes,
-  processModelsAnyAnnotation, generateAnyId
-}
+  processModelsAnyAnnotation, generateAnyId,
+  addAccessControlAnyParents
+}