@live-change/relations-plugin 0.9.79 → 0.9.80

package/package.json

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

package/src/entity.ts

@@ -4,23 +4,28 @@ import {
 
 import {
   defineView, defineCreatedEvent, defineUpdatedEvent, defineDeletedEvent, defineCreateAction,
-  defineUpdateAction, defineDeleteAction, defineCreateTrigger, defineUpdateTrigger, defineDeleteTrigger
+  defineUpdateAction, defineDeleteAction, defineCreateTrigger, defineUpdateTrigger, defineDeleteTrigger,
+  ModelDefinitionSpecificationWithEntity,
+  EntityConfig,
+  EntityContext
 } from './entityUtils.js'
+import { AccessControlSettings, ModelDefinitionSpecificationExtended } from './types.js'
+import { AccessSpecification, ModelDefinitionSpecification } from '@live-change/framework'
 
-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 +50,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

@@ -4,16 +4,53 @@ import {
   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: 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/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,7 +2,8 @@ import {
   ViewContext, ViewDefinitionSpecificationObservable, ViewDefinitionSpecificationDaoPath,
     ViewDefinitionSpecificationFetch, 
   ActionDefinitionSpecification, 
-  TriggerDefinitionSpecification 
+  TriggerDefinitionSpecification,
+  ModelDefinitionSpecification
 } from "@live-change/framework"
 
 export type AccessControlSettings = string | string[] | {
@@ -33,4 +34,23 @@ export interface ActionDefinitionSpecificationAC extends ActionDefinitionSpecifi
 
 export interface TriggerDefinitionSpecificationAC extends TriggerDefinitionSpecification {
   accessControl?: AccessControlSettings
-}
+}
+
+export interface CrudSettings {
+  read?: string
+  create?: string
+  update?: string
+  delete?: string
+}
+
+export interface Identifier {
+  name: string
+  field: string
+}
+
+export interface ModelDefinitionSpecificationExtended extends ModelDefinitionSpecification {
+  crud: CrudSettings,
+  identifiers: Identifier[]
+}
+
+

package/src/utils.js

@@ -250,7 +250,12 @@ export function includeAccessRoles(model, access) {
 
 export function defineGlobalRangeView(config, context, external = 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,
@@ -272,4 +277,4 @@ export function defineGlobalRangeView(config, context, external = true) {
       return path
     }
   })
-}
+}