@live-change/relations-plugin 0.9.77 → 0.9.78

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@live-change/relations-plugin",
-  "version": "0.9.77",
+  "version": "0.9.78",
   "description": "",
-  "main": "index.js",
+  "main": "src/index.js",
   "scripts": {
     "test": "NODE_ENV=test tape tests/*"
   },
@@ -22,8 +22,8 @@
   },
   "type": "module",
   "dependencies": {
-    "@live-change/framework": "^0.9.77",
+    "@live-change/framework": "^0.9.78",
     "pluralize": "^8.0.0"
   },
-  "gitHead": "5998bcbd97bda91829bcf57b23e938d95d431144"
+  "gitHead": "747a9cb02377d924583925508f082c8dd5031d43"
 }

package/src/entity.ts

@@ -0,0 +1,78 @@
+import {
+  includeAccessRoles, defineGlobalRangeView
+} from './utils.js'
+
+import {
+  defineView, defineCreatedEvent, defineUpdatedEvent, defineDeletedEvent, defineCreateAction,
+  defineUpdateAction, defineDeleteAction, defineCreateTrigger, defineUpdateTrigger, defineDeleteTrigger
+} from './entityUtils.js'
+
+const annotation = 'entity'
+
+
+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]
+    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)
+
+    model.identifiers = [{ name: modelPropertyName, field: 'id' }]
+    model.crud = {}
+    includeAccessRoles(model, [
+      config.readAccessControl, config.writeAccessControl,
+      config.createAccessControl, config.updateAccessControl, config.deleteAccessControl
+    ])
+
+    function modelRuntime() {
+      return service._runtime.models[modelName]
+    }
+
+    if (!model.indexes) {
+      model.indexes = {}
+    }
+
+    const writeableProperties = modelProperties || config.writeableProperties
+    //console.log("PPP", others)
+    const objectType = service.name + '_' + modelName
+
+    const context = {
+      service, app, model, originalModelProperties, modelProperties, modelPropertyName, modelRuntime,
+      modelName, writeableProperties, annotation, objectType
+    }
+
+    defineView(config, context, config.readAccess || config.readAccessControl || config.writeAccessControl)
+    defineGlobalRangeView(config, context, config.readAllAccess)
+    /// TODO: multiple views with limited fields
+
+    defineCreatedEvent(config, context)
+    defineUpdatedEvent(config, context)
+    defineDeletedEvent(config, context)
+
+    defineCreateTrigger(config, context)
+    defineUpdateTrigger(config, context)
+    defineDeleteTrigger(config, context)
+
+    if (config.createAccess || config.writeAccess || config.createAccessControl || config.writeAccessControl) {
+      defineCreateAction(config, context)
+    }
+
+    if (config.updateAccess || config.writeAccess || config.updateAccessControl || config.writeAccessControl) {
+      defineUpdateAction(config, context)
+    }
+
+    if (config.deleteAccess || config.writeAccess || config.deleteAccessControl || config.writeAccessControl) {
+      defineDeleteAction(config, context)
+    }
+
+  }
+}

package/{entity.js → src/entityUtils.ts}

@@ -4,15 +4,18 @@ import {
   includeAccessRoles, defineGlobalRangeView
 } from './utils.js'
 import { fireChangeTriggers } from "./changeTriggers.js"
-import App from '@live-change/framework'
+import App, { ServiceDefinition } from '@live-change/framework'
 import {
   PropertyDefinition, ViewDefinition, IndexDefinition, ActionDefinition, EventDefinition, TriggerDefinition
 } from "@live-change/framework"
 import pluralize from 'pluralize'
 
-const annotation = 'entity'
+import { ServiceDefinitionSpecification } from "@live-change/framework"
+import { ActionDefinitionSpecificationAC, ViewDefinitionSpecificationAC, TriggerDefinitionSpecificationAC } from "./types.js"
+import { EventDefinitionSpecification } from "@live-change/framework"
 
-function entityAccessControl({service, modelName, modelPropertyName}, accessControl) {
+
+export function entityAccessControl({service, modelName, modelPropertyName}, accessControl) {
   if(!accessControl) return undefined
   if(Array.isArray(accessControl)) accessControl = { roles: accessControl }
   return {
@@ -21,11 +24,11 @@ function entityAccessControl({service, modelName, modelPropertyName}, accessCont
   }
 }
 
-function defineView(config, context, external) {
+export function defineView(config, context, external) {
   const { service, modelRuntime, modelPropertyName, modelName, model } = context
   const viewName = (config.prefix || '' ) + (config.prefix ? modelName : modelPropertyName) + (config.suffix || '')
   if(external) model.crud.read = viewName
-  service.views[viewName] = new ViewDefinition({
+  const view = service.view({
     name: viewName,
     properties: {
       [modelPropertyName]: {
@@ -48,7 +51,7 @@ function defineView(config, context, external) {
 }
 
 
-function defineCreatedEvent(config, context) {
+export function defineCreatedEvent(config, context) {
   const {
     service, modelRuntime, modelName, modelPropertyName
   } = context
@@ -70,7 +73,7 @@ function defineCreatedEvent(config, context) {
   })
 }
 
-function defineUpdatedEvent(config, context) {
+export function defineUpdatedEvent(config, context) {
   const {
     service, modelRuntime, modelName, modelPropertyName
   } = context
@@ -92,12 +95,12 @@ function defineUpdatedEvent(config, context) {
   })
 }
 
-function defineDeletedEvent(config, context) {
+export function defineDeletedEvent(config, context) {
   const {
     service, modelRuntime, modelName, modelPropertyName,
   } = context
-  const eventName = modelName + 'Deleted'
-  service.events[eventName] = new EventDefinition({
+  const eventName = modelName + 'Deleted';
+  (service as ServiceDefinition<ServiceDefinitionSpecification>).event({
     name: eventName,
     properties: {
       [modelPropertyName]: {
@@ -111,7 +114,7 @@ function defineDeletedEvent(config, context) {
   })
 }
 
-function getCreateFunction( validators, validationContext, config, context) {
+export function getCreateFunction( validators, validationContext, config, context) {
   const {
     service, app, model, modelPropertyName, modelRuntime, objectType,
     modelName, writeableProperties
@@ -139,14 +142,14 @@ function getCreateFunction( validators, validationContext, config, context) {
   return execute
 }
 
-function defineCreateAction(config, context) {
+export function defineCreateAction(config, context) {
   const {
     service, app, model, modelPropertyName, modelRuntime, objectType,
     modelName, writeableProperties
   } = context
   const actionName = 'create' + modelName
   model.crud.create = actionName
-  const action = new ActionDefinition({
+  const action = (service as ServiceDefinition<ServiceDefinitionSpecification>).action<ActionDefinitionSpecificationAC>({
     name: actionName,
     properties: { ...model.properties },
     access: config.createAccess || config.writeAccess,
@@ -162,14 +165,14 @@ function defineCreateAction(config, context) {
   service.actions[actionName] = action
 }
 
-function defineCreateTrigger(config, context) {
+export function defineCreateTrigger(config, context) {
   const {
     service, app, model, modelPropertyName, modelRuntime, objectType,
     modelName, writeableProperties
   } = context
   const actionName = 'create' + modelName
   const triggerName = `${service.name}_${actionName}`
-  const trigger = new TriggerDefinition({
+  const trigger = (service as ServiceDefinition<ServiceDefinitionSpecification>).trigger<TriggerDefinitionSpecificationAC>({
     name: triggerName,
     properties: { ...model.properties },
     skipValidation: true,
@@ -179,10 +182,9 @@ function defineCreateTrigger(config, context) {
   const validators = App.validation.getValidators(trigger, service, trigger)
   const validationContext = { source: trigger, trigger }
   trigger.execute = getCreateFunction( validators, validationContext, config, context)
-  service.triggers[triggerName] = [trigger]
 }
 
-function getUpdateFunction( validators, validationContext, config, context) {
+export function getUpdateFunction( validators, validationContext, config, context) {
   const {
     service, app, model, modelRuntime, modelPropertyName, objectType,
     modelName, writeableProperties
@@ -209,7 +211,7 @@ function getUpdateFunction( validators, validationContext, config, context) {
   return execute
 }
 
-function defineUpdateAction(config, context) {
+export function defineUpdateAction(config, context) {
   const {
     service, app, model, modelRuntime, modelPropertyName, objectType,
     modelName, writeableProperties
@@ -237,7 +239,7 @@ function defineUpdateAction(config, context) {
   service.actions[actionName] = action
 }
 
-function defineUpdateTrigger(config, context) {
+export function defineUpdateTrigger(config, context) {
   const {
     service, app, model, modelRuntime, modelPropertyName, objectType,
     modelName, writeableProperties
@@ -262,7 +264,7 @@ function defineUpdateTrigger(config, context) {
   service.triggers[triggerName] = [trigger]
 }
 
-function getDeleteFunction(config, context) {
+export function getDeleteFunction(config, context) {
   const {
     service, app, model, modelRuntime, modelPropertyName, objectType,
     otherPropertyNames, modelName, writeableProperties,
@@ -282,7 +284,7 @@ function getDeleteFunction(config, context) {
   return execute
 }
 
-function defineDeleteAction(config, context) {
+export function defineDeleteAction(config, context) {
   const {
     service, app, model, modelRuntime, modelPropertyName, objectType,
     modelName, writeableProperties
@@ -305,7 +307,7 @@ function defineDeleteAction(config, context) {
   })
 }
 
-function defineDeleteTrigger(config, context) {
+export function defineDeleteTrigger(config, context) {
   const {
     service, app, model, modelRuntime, modelPropertyName, objectType,
     modelName, writeableProperties
@@ -324,71 +326,4 @@ function defineDeleteTrigger(config, context) {
     waitForEvents: true,
     execute: getDeleteFunction(config, context)
   })]
-}
-
-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]
-    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)
-
-    model.identifiers = [{ name: modelPropertyName, field: 'id' }]
-    model.crud = {}
-    includeAccessRoles(model, [
-      config.readAccessControl, config.writeAccessControl,
-      config.createAccessControl, config.updateAccessControl, config.deleteAccessControl
-    ])
-
-    function modelRuntime() {
-      return service._runtime.models[modelName]
-    }
-
-    if (!model.indexes) {
-      model.indexes = {}
-    }
-
-    const writeableProperties = modelProperties || config.writeableProperties
-    //console.log("PPP", others)
-    const objectType = service.name + '_' + modelName
-
-    const context = {
-      service, app, model, originalModelProperties, modelProperties, modelPropertyName, modelRuntime,
-      modelName, writeableProperties, annotation, objectType
-    }
-
-    defineView(config, context, config.readAccess || config.readAccessControl || config.writeAccessControl)
-    defineGlobalRangeView(config, context, config.readAllAccess)
-    /// TODO: multiple views with limited fields
-
-    defineCreatedEvent(config, context)
-    defineUpdatedEvent(config, context)
-    defineDeletedEvent(config, context)
-
-    defineCreateTrigger(config, context)
-    defineUpdateTrigger(config, context)
-    defineDeleteTrigger(config, context)
-
-    if (config.createAccess || config.writeAccess || config.createAccessControl || config.writeAccessControl) {
-      defineCreateAction(config, context)
-    }
-
-    if (config.updateAccess || config.writeAccess || config.updateAccessControl || config.writeAccessControl) {
-      defineUpdateAction(config, context)
-    }
-
-    if (config.deleteAccess || config.writeAccess || config.deleteAccessControl || config.writeAccessControl) {
-      defineDeleteAction(config, context)
-    }
-
-  }
-}
+}

package/src/types.ts

@@ -0,0 +1,36 @@
+import { 
+  ViewContext, ViewDefinitionSpecificationObservable, ViewDefinitionSpecificationDaoPath,
+    ViewDefinitionSpecificationFetch, 
+  ActionDefinitionSpecification, 
+  TriggerDefinitionSpecification 
+} from "@live-change/framework"
+
+export type AccessControlSettings = string | string[] | {
+  roles: string | string[]
+  objects?: (properties: any) => any[]
+}
+export interface ViewDefinitionSpecificationObservableAC extends ViewDefinitionSpecificationObservable {
+  accessControl?: AccessControlSettings
+}
+export interface ViewDefinitionSpecificationDaoPathAC extends ViewDefinitionSpecificationDaoPath {
+  daoPath: (parameters: Record<string, any>, context: ViewContext) => any[]
+  accessControl?: AccessControlSettings
+}
+export interface ViewDefinitionSpecificationFetchAC extends ViewDefinitionSpecificationFetch {
+  fetch: (parameters: Record<string, any>, context: ViewContext) => Promise<any>
+  accessControl?: AccessControlSettings
+}
+
+export type ViewDefinitionSpecificationAC = 
+  ViewDefinitionSpecificationObservableAC
+   | ViewDefinitionSpecificationDaoPathAC
+    | ViewDefinitionSpecificationFetchAC
+
+
+export interface ActionDefinitionSpecificationAC extends ActionDefinitionSpecification {
+  accessControl?: AccessControlSettings
+}
+
+export interface TriggerDefinitionSpecificationAC extends TriggerDefinitionSpecification {
+  accessControl?: AccessControlSettings
+}

package/tsconfig.json

@@ -0,0 +1,28 @@
+{
+  "compilerOptions": {
+    "composite": true,
+    "module": "nodenext",
+    "moduleResolution": "nodenext",
+    "allowSyntheticDefaultImports": true,
+
+    "target": "ES2020",
+    "useDefineForClassFields": true,
+    "lib": ["ES2020", "DOM"],
+
+    /* Linting */
+    "strict": false,
+    "noUnusedLocals": false,
+    "noUnusedParameters": false,
+    "noFallthroughCasesInSwitch": true,
+    "outDir": "dist",
+    "checkJs": false,
+    "esModuleInterop": true,    // Enable interop for ES modules
+    "resolveJsonModule": true,  // Allow importing JSON files
+    "skipLibCheck": true,
+    "noImplicitAny": false
+  },
+  "files": ["src/index.js"],
+  "include": ["src/**/*.ts", "src/**/*.js"],
+  "exclude": ["node_modules/@types", "node_modules/**/*.d.ts", "**/*.test.js", "**/CMakeFiles/**"]
+}
+