@live-change/relations-plugin 0.9.79 → 0.9.81

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@live-change/relations-plugin",
-  "version": "0.9.79",
+  "version": "0.9.81",
   "description": "",
   "main": "src/index.js",
   "scripts": {
@@ -22,8 +22,8 @@
   },
   "type": "module",
   "dependencies": {
-    "@live-change/framework": "^0.9.79",
+    "@live-change/framework": "^0.9.81",
     "pluralize": "^8.0.0"
   },
-  "gitHead": "68d2965e5a3b780063a5d0f9ce71d911fd1fb6be"
+  "gitHead": "d70a8bdf4d60b7826576d477b9dff5714c31763d"
 }

package/src/entity.ts

@@ -4,23 +4,26 @@ import {
 
 import {
   defineView, defineCreatedEvent, defineUpdatedEvent, defineDeletedEvent, defineCreateAction,
-  defineUpdateAction, defineDeleteAction, defineCreateTrigger, defineUpdateTrigger, defineDeleteTrigger
+  defineUpdateAction, defineDeleteAction, defineCreateTrigger, defineUpdateTrigger, defineDeleteTrigger,
+  ModelDefinitionSpecificationWithEntity,
+  EntityConfig,
+  EntityContext
 } from './entityUtils.js'
 
-const annotation = 'entity'
-
+export type { EntityConfig, ModelDefinitionSpecificationWithEntity } from './entityUtils.js'
 
 export default 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]
+    const model: ModelDefinitionSpecificationWithEntity = 
+      service.models[modelName] as ModelDefinitionSpecificationWithEntity
+    const config:EntityConfig = model.entity
     if(!config) continue
 
-    if (model[annotation + 'Processed']) throw new Error("duplicated processing of " + annotation + " processor")
-    model[annotation + 'Processed'] = true
+    if (model.entityProcessed) throw new Error("duplicated processing of entity processor")
+    model.entityProcessed = true
 
     const originalModelProperties = { ...model.properties }
     const modelProperties = Object.keys(model.properties)
@@ -45,13 +48,13 @@ export default function(service, app) {
     //console.log("PPP", others)
     const objectType = service.name + '_' + modelName
 
-    const context = {
+    const context: EntityContext = {
       service, app, model, originalModelProperties, modelProperties, modelPropertyName, modelRuntime,
-      modelName, writeableProperties, annotation, objectType
+      modelName, writeableProperties, annotation: 'entity', objectType
     }
 
     defineView(config, context, config.readAccess || config.readAccessControl || config.writeAccessControl)
-    defineGlobalRangeView(config, context, config.readAllAccess)
+    defineGlobalRangeView(config, context, !!config.readAllAccess)
     /// TODO: multiple views with limited fields
 
     defineCreatedEvent(config, context)

package/src/entityUtils.ts

@@ -1,19 +1,56 @@
 import {
   defineProperties, defineIndex,
-  processModelsAnnotation, extractIdParts, extractIdentifiers, extractObjectData, prepareAccessControl,
+  extractIdParts, extractIdentifiers, extractObjectData, prepareAccessControl,
   includeAccessRoles, defineGlobalRangeView
 } from './utils.js'
 import { fireChangeTriggers } from "./changeTriggers.js"
-import App, { ServiceDefinition } from '@live-change/framework'
+import App, { AccessSpecification, ModelDefinitionSpecification, PropertyDefinitionSpecification, ServiceDefinition } from '@live-change/framework'
 import {
   PropertyDefinition, ViewDefinition, IndexDefinition, ActionDefinition, EventDefinition, TriggerDefinition
 } from "@live-change/framework"
 import pluralize from 'pluralize'
 
 import { ServiceDefinitionSpecification } from "@live-change/framework"
-import { ActionDefinitionSpecificationAC, ViewDefinitionSpecificationAC, TriggerDefinitionSpecificationAC } from "./types.js"
+import { ActionDefinitionSpecificationAC, ViewDefinitionSpecificationAC, TriggerDefinitionSpecificationAC,
+         ModelDefinitionSpecificationExtended, AccessControlSettings } from "./types.js"
 import { EventDefinitionSpecification } from "@live-change/framework"
 
+export interface EntityConfig {
+  readAccessControl?: AccessControlSettings
+  writeAccessControl?: AccessControlSettings
+  createAccessControl?: AccessControlSettings
+  updateAccessControl?: AccessControlSettings
+  deleteAccessControl?: AccessControlSettings
+
+  readAllAccess?: AccessSpecification
+  readAccess?: AccessSpecification
+  writeAccess?: AccessSpecification
+  createAccess?: AccessSpecification
+  updateAccess?: AccessSpecification
+  deleteAccess?: AccessSpecification
+
+  writeableProperties?: string[]
+}
+
+export interface ModelDefinitionSpecificationWithEntity extends ModelDefinitionSpecificationExtended {
+  entity: EntityConfig
+  entityProcessed: boolean
+}
+
+export interface EntityContext {
+  service: ServiceDefinition<ServiceDefinitionSpecification>
+  modelName: string
+  modelPropertyName: string
+  model: ModelDefinitionSpecificationWithEntity
+  originalModelProperties: Record<string, PropertyDefinitionSpecification>
+  modelProperties: string[]
+  writeableProperties: string[]
+  objectType: string
+  app: App,
+  modelRuntime: any,
+  annotation: 'entity'
+}
+
 
 export function entityAccessControl({service, modelName, modelPropertyName}, accessControl) {
   if(!accessControl) return undefined

package/src/{itemOf.js → itemOf.ts}

@@ -2,7 +2,8 @@ import {
   defineProperties, defineIndexes,
   processModelsAnnotation, addAccessControlParents,
   defineDeleteByOwnerEvents, defineParentDeleteTriggers, defineParentCopyTriggers,
-   defineGlobalRangeView
+  defineGlobalRangeView,
+  RelationConfig
 } from './utils.js'
 
 import {
@@ -17,15 +18,38 @@ import {
   defineSortIndex,
   defineCopyAction, defineCopyOnParentCopyTrigger
 } from './pluralRelationUtils.js'
+import App, { AccessSpecification, ServiceDefinition, ServiceDefinitionSpecification } from '@live-change/framework'
+import { AccessControlSettings } from './types.js'
+
+export interface ItemOfConfig extends RelationConfig {
+  readAccess?: AccessSpecification
+  writeAccess?: AccessSpecification
+  createAccess?: AccessSpecification
+  updateAccess?: AccessSpecification
+  deleteAccess?: AccessSpecification
+  copyAccess?: AccessSpecification
+  readAllAccess?: AccessSpecification
+
+  readAccessControl?: AccessControlSettings
+  writeAccessControl?: AccessControlSettings
+  createAccessControl?: AccessControlSettings
+  updateAccessControl?: AccessControlSettings
+  deleteAccessControl?: AccessControlSettings
+  copyAccessControl?: AccessControlSettings
+  readAllAccessControl?: AccessControlSettings
+}
 
-export default function(service, app) {
-  processModelsAnnotation(service, app, 'itemOf', false, (config, context) => {
+export default function(service: ServiceDefinition<ServiceDefinitionSpecification>, app: any) {
+  processModelsAnnotation<ItemOfConfig>(service, app, 'itemOf', false, (config, context) => {
 
     context.relationWord = 'Item'
     context.reverseRelationWord = 'Owned'
 
     context.identifiers = defineProperties(context.model, context.others, context.otherPropertyNames)
-    context.model.identifiers = [...Object.keys(context.identifiers), { name: context.modelPropertyName, field: 'id' }]
+    context.model.identifiers = [
+      ...Object.keys(context.identifiers).map(name => ({ name, field: name })), 
+      { name: context.modelPropertyName, field: 'id' }
+    ]
 
     addAccessControlParents(context)
     defineIndexes(context.model, context.otherPropertyNames.map(p => p[0].toLowerCase() + p.slice(1)), context.others)
@@ -42,7 +66,7 @@ export default function(service, app) {
       config.readAccess || config.readAccessControl || config.writeAccessControl)
     /// TODO: multiple views with limited fields
 
-    defineGlobalRangeView(config, context, config.readAllAccess)
+    defineGlobalRangeView(config, context, !!config.readAllAccess)
 
     defineCreatedEvent(config, context)
     defineUpdatedEvent(config, context)

package/src/propertyOf.js

@@ -55,7 +55,6 @@ export default function(service, app) {
 
     defineGlobalRangeView(config, context, config.readAllAccess)
 
-
     defineSetEvent(config, context, generateId)
     defineUpdatedEvent(config, context, generateId)
     defineTransferredEvent(config, context, generateId)

package/src/types.ts

@@ -2,13 +2,17 @@ import {
   ViewContext, ViewDefinitionSpecificationObservable, ViewDefinitionSpecificationDaoPath,
     ViewDefinitionSpecificationFetch, 
   ActionDefinitionSpecification, 
-  TriggerDefinitionSpecification 
+  TriggerDefinitionSpecification,
+  ModelDefinitionSpecification
 } from "@live-change/framework"
 
-export type AccessControlSettings = string | string[] | {
+export type PreparedAccessControlSettings = {
   roles: string | string[]
   objects?: (properties: any) => any[]
+  objParams?: { names: string[], types: string[] }
 }
+
+export type AccessControlSettings = string | string[] | PreparedAccessControlSettings
 export interface ViewDefinitionSpecificationObservableAC extends ViewDefinitionSpecificationObservable {
   accessControl?: AccessControlSettings
 }
@@ -33,4 +37,29 @@ export interface ActionDefinitionSpecificationAC extends ActionDefinitionSpecifi
 
 export interface TriggerDefinitionSpecificationAC extends TriggerDefinitionSpecification {
   accessControl?: AccessControlSettings
-}
+}
+
+export interface CrudSettings {
+  read?: string
+  create?: string
+  update?: string
+  delete?: string
+  range?: string
+}
+
+export interface Identifier {
+  name: string
+  field: string
+}
+
+export interface ModelDefinitionSpecificationExtended extends ModelDefinitionSpecification {
+  crud: CrudSettings,
+  identifiers: Identifier[]
+}
+
+export interface ModelDefinitionSpecificationWithAccessControl extends ModelDefinitionSpecificationExtended {
+  accessControlParents?: (what: { object: string }) => Promise<{ objectType: string, object: any }[]>
+  accessControlParentsSource?: { property: string, type: string }[]
+  accessRoles?: string[]
+}
+

package/src/{utils.js → utils.ts}

@@ -1,11 +1,13 @@
-import App from "@live-change/framework"
+import App, { AccessSpecification, ServiceDefinition } from "@live-change/framework"
 const app = App.app()
 import { allCombinations } from "./combinations.js"
 import {
   registerParentDeleteTriggers, registerParentCopyTriggers
 } from "./changeTriggers.js"
 import {
-  PropertyDefinition, ViewDefinition, IndexDefinition, ActionDefinition, EventDefinition, TriggerDefinition
+  PropertyDefinition, ViewDefinition, IndexDefinition, ActionDefinition, EventDefinition, TriggerDefinition,
+  ServiceDefinitionSpecification,
+  PropertyDefinitionSpecification
 } from "@live-change/framework"
 
 export {
@@ -13,8 +15,10 @@ export {
 } from './dataUtils.js'
 
 import pluralize from 'pluralize'
+import { ModelDefinitionSpecificationWithEntity } from "./entityUtils.js"
+import { AccessControlSettings, ModelDefinitionSpecificationWithAccessControl, PreparedAccessControlSettings } from "./types.js"
 
-export function extractIdParts(otherPropertyNames, properties) {
+export function extractIdParts(otherPropertyNames: string[], properties: Record<string, any>) {
   const idParts = []
   for (const propertyName of otherPropertyNames) {
     idParts.push(properties[propertyName])
@@ -23,13 +27,15 @@ export function extractIdParts(otherPropertyNames, properties) {
 }
 
 
-export function generateId(otherPropertyNames, properties) {
+export function generateId(otherPropertyNames: string[], properties: Record<string, any>) {
   return otherPropertyNames.length > 1
       ? otherPropertyNames.map(p => JSON.stringify(properties[p])).join(':')
       : properties[otherPropertyNames[0]]
 }
 
-export function defineProperties(model, types, names) {
+export function defineProperties(model: ModelDefinitionSpecificationWithAccessControl,
+                                 types: string[], names: string[])
+                                 : Record<string, PropertyDefinition<PropertyDefinitionSpecification>> {
   const identifiers = {}
   for (let i = 0; i < types.length; i++) {
     identifiers[names[i]] = new PropertyDefinition({
@@ -43,14 +49,16 @@ export function defineProperties(model, types, names) {
   return identifiers
 }
 
-export function defineIndex(model, what, props, multi = undefined) {
+export function defineIndex(model: ModelDefinitionSpecificationWithAccessControl,
+                            what: string, props: string[], multi = undefined) {
   console.log("DEFINE INDEX", model.name, what, props)
-  model.indexes['by' + what] = new IndexDefinition({
+  model.indexes['by' + what] = {
     property: props,
     multi
-  })
+  }
 }
-export function defineIndexes(model, props, types) {
+export function defineIndexes(model: ModelDefinitionSpecificationWithAccessControl,
+                              props: Record<string, any>, types: string[]) {
   console.log("DEFINE INDEXES!", model.name, props, types)
   const propCombinations = allCombinations(Object.keys(props)) /// combinations of indexes
   for(const propCombination of propCombinations) {
@@ -79,7 +87,47 @@ export function defineIndexes(model, props, types) {
   }
 }
 
-export function processModelsAnnotation(service, app, annotation, multiple, cb) {
+export interface RelationConfig {
+  what: string | string[]
+  propertyNames?: string[]
+  writeableProperties?: string[]
+  prefix?: string
+  suffix?: string
+  globalView?: boolean
+  readAllAccess?: AccessSpecification
+  sortBy?: string[],
+  customDeleteTrigger?: boolean, /// TODO: check if this is needed
+  customParentCopyTrigger?: boolean /// TODO: check if this is needed
+}
+
+export interface ModelDefinitionSpecificationWithRelation extends ModelDefinitionSpecificationWithAccessControl {  
+}
+
+interface RelationContext {
+  service: ServiceDefinition<ServiceDefinitionSpecification>
+  app: App
+  model: ModelDefinitionSpecificationWithRelation
+  originalModelProperties: Record<string, PropertyDefinitionSpecification>
+  modelProperties: string[]
+  modelPropertyName: string
+  modelName: string
+  modelRuntime: any
+  annotation: string
+  objectType: string
+  parentsTypes: string[]
+  otherPropertyNames: string[]
+  joinedOthersPropertyName: string
+  joinedOthersClassName: string
+  writeableProperties: string[]
+  others: any[],
+  reverseRelationWord?: string
+  relationWord?: string,
+  identifiers?: Record<string, PropertyDefinition<PropertyDefinitionSpecification>>
+}
+
+export function processModelsAnnotation<PreparedConfig extends RelationConfig>
+     (service: ServiceDefinition<ServiceDefinitionSpecification>, app: App, annotation: string, multiple: boolean,
+     cb: (config: PreparedConfig, context: RelationContext) => void) {
   if (!service) throw new Error("no service")
   if (!app) throw new Error("no app")
 
@@ -134,7 +182,7 @@ export function processModelsAnnotation(service, app, annotation, multiple, cb)
         const joinedOthersClassName = otherNames.join('And')
         const objectType = service.name + '_' + modelName
 
-        const context = {
+        const context: RelationContext = {
           service, app, model, originalModelProperties, modelProperties, modelPropertyName, modelRuntime,
           otherPropertyNames, joinedOthersPropertyName, modelName, writeableProperties, joinedOthersClassName,
           others, annotation, objectType, parentsTypes: others
@@ -146,7 +194,7 @@ export function processModelsAnnotation(service, app, annotation, multiple, cb)
   }
 }
 
-export function addAccessControlParents(context) {
+export function addAccessControlParents(context: RelationContext) {
   const { modelRuntime } = context
   context.model.accessControlParents = context.model.accessControlParents ?? (async (what) => {
     const id = what.object
@@ -169,29 +217,31 @@ export function addAccessControlParents(context) {
   )
 }
 
-export function prepareAccessControl(accessControl, names, types) {
+
+export function prepareAccessControl(accessControl: AccessControlSettings, names: string[], types: string[]) {
   if(typeof accessControl == 'object') {
-    accessControl.objects = accessControl.objects ?? ((params) => names.map((name, index) => ({
+    const ac = accessControl as PreparedAccessControlSettings
+    ac.objects = ac.objects ?? ((params) => names.map((name, index) => ({
       objectType: types[index],
       object: params[name]
     })))
-    accessControl.objParams = { names, types }
+    ac.objParams = { names, types }
   }
 }
 
-export function cloneAndPrepareAccessControl(accessControl, names, types) {
+export function cloneAndPrepareAccessControl(accessControl: AccessControlSettings, names: string[], types: string[]) {
   if(!accessControl) return accessControl
   if(Array.isArray(accessControl)) {
-    accessControl = { roles: accessControl}
+    accessControl = { roles: accessControl }
   }
-  const newAccessControl = { ...accessControl }
+  const newAccessControl: PreparedAccessControlSettings = { ...(accessControl as PreparedAccessControlSettings) }
   prepareAccessControl(newAccessControl, names, types)
   return newAccessControl
 }
 
-export function defineDeleteByOwnerEvents(config, context, generateId) {
+export function defineDeleteByOwnerEvents(config: RelationConfig, context: RelationContext) {
   const {
-    service, modelRuntime, joinedOthersPropertyName, modelName, modelPropertyName, otherPropertyNames, reverseRelationWord
+    service, modelRuntime, joinedOthersPropertyName, modelName, modelPropertyName, otherPropertyNames,
   } = context
   for(const propertyName of otherPropertyNames) {
     const eventName = modelName + 'DeleteByOwner'
@@ -224,15 +274,16 @@ export function defineDeleteByOwnerEvents(config, context, generateId) {
   }
 }
 
-export function defineParentDeleteTriggers(config, context) {
+export function defineParentDeleteTriggers(config: RelationConfig, context: RelationContext) {
   registerParentDeleteTriggers(context, config)
 }
 
-export function defineParentCopyTriggers(config, context) {
+export function defineParentCopyTriggers(config: RelationConfig, context: RelationContext) {
   registerParentCopyTriggers(context, config)
 }
 
-export function includeAccessRoles(model, access) {
+export function includeAccessRoles(model: ModelDefinitionSpecificationWithAccessControl, 
+                                   access: AccessControlSettings | AccessControlSettings[]) {
   if(!access) return
   if(!model.accessRoles) model.accessRoles = []
   if(typeof access === 'string' && !model.accessRoles.find(role => role === access)) {
@@ -242,15 +293,30 @@ export function includeAccessRoles(model, access) {
     for(const element of access) {
       includeAccessRoles(model, element)
     }
-  }
-  if(access.roles) {
-    includeAccessRoles(model, access.roles)
+  } else if((access as PreparedAccessControlSettings).roles) {
+    includeAccessRoles(model, (access as PreparedAccessControlSettings).roles)
   }
 }
 
-export function defineGlobalRangeView(config, context, external = true) {
+export function defineGlobalRangeView(config: {
+  prefix?: string
+  suffix?: string
+  globalView?: boolean
+  readAllAccess?: AccessSpecification
+}, context: {
+  service: ServiceDefinition<ServiceDefinitionSpecification>
+  modelRuntime: any
+  modelPropertyName: string
+  modelName: string
+  model: ModelDefinitionSpecificationWithAccessControl
+}, external:boolean = true) {
   const { service, modelRuntime, modelPropertyName, modelName, model } = context
-  const viewName = (config.prefix || '' ) + pluralize(config.prefix ? modelName : modelPropertyName) + (config.suffix || '')
+  const alreadyPlural = pluralize.isPlural(modelPropertyName)  
+  const prefix = (config.prefix || '') + (alreadyPlural ? 'all' : '')
+  const viewName =      
+     prefix
+     + pluralize(prefix ? modelName : modelPropertyName) 
+     + (config.suffix || '')
   if(external) model.crud.range = viewName
   service.views[viewName] = new ViewDefinition({
     name: viewName,
@@ -260,16 +326,16 @@ export function defineGlobalRangeView(config, context, external = true) {
     returns: {
       type: Array,
       of: {
-        type: model
+        type: service.name + '_' + modelName
       }
     },
     internal: !external,
     global: config.globalView,
-    access: external && config.readAllAccess,
-    daoPath(properties, { client, context }) {
+    access: external ? (config.readAllAccess ?? undefined) : undefined,
+    daoPath(properties, { client, service }) {
       const range = App.extractRange(properties)
       const path = modelRuntime().rangePath(range)
       return path
     }
   })
-}
+}