@live-change/relations-plugin 0.9.84 → 0.9.85

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@live-change/relations-plugin",
-  "version": "0.9.84",
+  "version": "0.9.85",
   "description": "",
   "main": "src/index.js",
   "scripts": {
@@ -22,8 +22,13 @@
   },
   "type": "module",
   "dependencies": {
-    "@live-change/framework": "^0.9.84",
+    "@live-change/framework": "^0.9.85",
     "pluralize": "^8.0.0"
   },
-  "gitHead": "5881a5406e3a39e673034f172266409ddb306f2e"
+  "devDependencies": {
+    "typedoc": "0.28.3",
+    "typedoc-plugin-markdown": "^4.6.3",
+    "typedoc-plugin-rename-defaults": "^0.7.3"
+  },
+  "gitHead": "126afb0aad3ab6e03aa5742726f429c95c46783a"
 }

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

@@ -1,6 +1,7 @@
 import {
   defineProperties, defineIndex,
-  processModelsAnnotation, generateId
+  processModelsAnnotation, generateId,
+  RelationConfig
 } from './utils.js'
 
 import { defineSetEvent, defineUpdatedEvent, defineTransferredEvent, defineResetEvent } from './propertyEvents.js'
@@ -19,9 +20,37 @@ import {
   defineDeleteAction,
   defineDeleteTrigger
 } from './singularRelationUtils.js'
+import { AccessSpecification } from '@live-change/framework'
+import { AccessControlSettings } from './types.js'
+
+export interface BoundToConfig extends RelationConfig {
+  readAccess?: AccessSpecification
+  writeAccess?: AccessSpecification
+  listAccess?: AccessSpecification
+  setAccess?: AccessSpecification
+  updateAccess?: AccessSpecification
+  setOrUpdateAccess?: AccessSpecification
+  resetAccess?: AccessSpecification
+  readAllAccess?: AccessSpecification
+
+  readAccessControl?: AccessControlSettings
+  writeAccessControl?: AccessControlSettings
+  listAccessControl?: AccessControlSettings
+  setAccessControl?: AccessControlSettings
+  updateAccessControl?: AccessControlSettings
+  resetAccessControl?: AccessControlSettings
+  setOrUpdateAccessControl?: AccessControlSettings
+  views?: {
+    type: 'range' | 'object'
+    internal?: boolean
+    readAccess?: AccessSpecification,
+    readAccessControl?: AccessControlSettings,
+    fields?: string[]
+  }[]
+}
 
 export default function(service, app) {
-  processModelsAnnotation(service, app, 'boundTo', false, (config, context) => {
+  processModelsAnnotation<BoundToConfig>(service, app, 'boundTo', false, (config, context) => {
 
     context.relationWord = 'Friend'
     context.reverseRelationWord = 'Bound'
@@ -31,10 +60,10 @@ export default function(service, app) {
     defineIndex(context.model, context.joinedOthersClassName, context.otherPropertyNames)
 
     defineObjectView({ ...config, access: config.readAccess }, context,
-      config.readAccess || config.readAccessControl || config.writeAccessControl
+      !!(config.readAccess || config.readAccessControl || config.writeAccessControl)
     )
     defineRangeViews(config, context,
-      config.listAccess || config.readAccess || config.listAccessControl
+      !!(config.listAccess || config.readAccess || config.listAccessControl)
     )
 
     if(config.views) {

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

@@ -1,6 +1,7 @@
 import {
   defineAnyProperties, defineAnyIndex,
-  processModelsAnyAnnotation, generateAnyId, defineAnyTypeIndexes
+  processModelsAnyAnnotation, generateAnyId, defineAnyTypeIndexes,
+  AnyRelationConfig
 } from './utilsAny.js'
 
 import { defineSetEvent, defineUpdatedEvent, defineTransferredEvent, defineResetEvent } from './propertyEvents.js'
@@ -11,9 +12,40 @@ import {
   defineSetTrigger, defineUpdateTrigger, defineSetOrUpdateTrigger, defineResetTrigger
 } from './singularRelationAnyUtils.js'
 import { defineDeleteAction, defineDeleteTrigger } from './singularRelationAnyUtils.js'
+import { AccessSpecification } from '@live-change/framework'
+import { AccessControlSettings } from './types.js'
+
+export interface BoundToAnyConfig extends AnyRelationConfig {
+  readAccess?: AccessSpecification
+  writeAccess?: AccessSpecification
+  readAllAccess?: AccessSpecification
+  setAccess?: AccessSpecification
+  updateAccess?: AccessSpecification
+  setOrUpdateAccess?: AccessSpecification
+  resetAccess?: AccessSpecification
+  singleAccess?: AccessSpecification
+  listAccess?: AccessSpecification
+
+  readAccessControl?: AccessControlSettings
+  writeAccessControl?: AccessControlSettings
+  readAllAccessControl?: AccessControlSettings
+  setAccessControl?: AccessControlSettings
+  updateAccessControl?: AccessControlSettings
+  setOrUpdateAccessControl?: AccessControlSettings
+  resetAccessControl?: AccessControlSettings
+  singleAccessControl?: AccessControlSettings
+  listAccessControl?: AccessControlSettings
+
+  views?: {
+    type: 'range' | 'object'
+    internal?: boolean
+    fields?: string[]
+  }[]
+  
+}
 
 export default function(service, app) {
-  processModelsAnyAnnotation(service, app, 'boundToAny', false, (config, context) => {
+  processModelsAnyAnnotation<BoundToAnyConfig>(service, app, 'boundToAny', false, (config, context) => {
 
     context.relationWord = 'Friend'
     context.reverseRelationWord = 'Bound'
@@ -24,10 +56,10 @@ export default function(service, app) {
     defineAnyTypeIndexes(config, context, context.otherPropertyNames.length === 1)
 
     defineObjectView(config, context,
-      config.singleAccess || config.readAccess || config.singleAccessControl || config.readAccessControl
+      !!(config.singleAccess || config.readAccess || config.singleAccessControl || config.readAccessControl)
     )
     defineRangeViews(config, context,
-      config.listAccess || config.readAccess || config.listAccessControl || config.readAccessControl
+      !!(config.listAccess || config.readAccess || config.listAccessControl || config.readAccessControl)
     )
 
     if(config.views) {

package/src/index.ts

@@ -0,0 +1,53 @@
+import entity from './entity.js'
+
+import propertyOf, { PropertyOfConfig } from './propertyOf.js'
+import itemOf, { ItemOfConfig } from './itemOf.js'
+
+import propertyOfAny, { PropertyOfAnyConfig } from './propertyOfAny.js'
+import itemOfAny, { ItemOfAnyConfig } from './itemOfAny.js'
+
+import relatedTo, { RelatedToConfig } from './relatedTo.js'
+import relatedToAny, { RelatedToAnyConfig } from './relatedToAny.js'
+
+import boundTo, { BoundToConfig } from './boundTo.js'
+import boundToAny, { BoundToAnyConfig } from './boundToAny.js'
+import saveAuthor from './saveAuthor.js'
+import { ModelDefinitionSpecificationWithAccessControl } from './types.js'
+import { SaveAuthorConfig } from './saveAuthor.js'
+
+const processors = [
+  entity,
+  propertyOf, itemOf,
+  propertyOfAny, itemOfAny,
+  relatedTo, relatedToAny,
+  boundTo, boundToAny,
+  saveAuthor
+]
+
+const plugin = function(app, services) {
+  app.defaultProcessors.push(...processors)
+}
+plugin.processors = processors
+
+export default plugin
+
+export { processors }
+
+export interface MotelWithRelations extends ModelDefinitionSpecificationWithAccessControl {
+  propertyOf: PropertyOfConfig
+  itemOf: ItemOfConfig
+  propertyOfAny: PropertyOfAnyConfig
+  itemOfAny: ItemOfAnyConfig
+  relatedTo: RelatedToConfig
+  relatedToAny: RelatedToAnyConfig
+  boundTo: BoundToConfig
+  boundToAny: BoundToAnyConfig
+  saveAuthor: SaveAuthorConfig        
+}
+
+export type { 
+  PropertyOfConfig, ItemOfConfig, PropertyOfAnyConfig, ItemOfAnyConfig,
+  RelatedToConfig, RelatedToAnyConfig, BoundToConfig, BoundToAnyConfig, 
+  SaveAuthorConfig
+} 
+

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

@@ -3,7 +3,8 @@ import { defineGlobalRangeView } from './utils.js'
 import {
   defineAnyProperties, defineAnyIndexes,
   processModelsAnyAnnotation, addAccessControlAnyParents, generateAnyId, defineDeleteByOwnerEvents,
-  defineParentDeleteTrigger, defineAnyTypeIndexes
+  defineParentDeleteTrigger, defineAnyTypeIndexes,
+  AnyRelationConfig
 } from './utilsAny.js'
 
 import {
@@ -16,15 +17,37 @@ import {
   defineCreateTrigger, defineUpdateTrigger, defineDeleteTrigger,
   defineSortIndex
 } from './pluralRelationAnyUtils.js'
+import { AccessSpecification } from '@live-change/framework'
+import { AccessControlSettings } from './types.js'
+
+export interface ItemOfAnyConfig extends AnyRelationConfig {
+  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
+}
 
 export default function(service, app) {
-  processModelsAnyAnnotation(service, app, 'itemOfAny',false, (config, context) => {
+  processModelsAnyAnnotation<ItemOfAnyConfig>(service, app, 'itemOfAny',false, (config, context) => {
 
     context.relationWord = 'Item'
     context.reverseRelationWord = 'Owned'
 
     context.identifiers = defineAnyProperties(context.model, context.otherPropertyNames, config)
-    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' }
+    ]
 
     addAccessControlAnyParents(context)
     defineAnyIndexes(context.model, context.otherPropertyNames)
@@ -37,19 +60,19 @@ export default function(service, app) {
     }
 
     defineSingleView(config, context,
-      config.readAccess || config.writeAccess || config.readAccessControl || config.writeAccessControl)
+      !!(config.readAccess || config.writeAccess || config.readAccessControl || config.writeAccessControl))
     defineRangeView(config, context,
-      config.readAccess || config.writeAccess || config.readAccessControl || config.writeAccessControl)
+      !!(config.readAccess || config.writeAccess || config.readAccessControl || config.writeAccessControl))
     /// TODO: multiple views with all properties combinations
     /// TODO: multiple views with limited fields
 
-    defineGlobalRangeView(config, context, config.readAllAccess)
+    defineGlobalRangeView(config, context, !!config.readAllAccess)
 
     defineCreatedEvent(config, context)
     defineUpdatedEvent(config, context)
     defineTransferredEvent(config, context)
     defineDeletedEvent(config, context)
-    defineDeleteByOwnerEvents(config, context, generateAnyId)
+    defineDeleteByOwnerEvents(config, context)
 
     defineCreateTrigger(config, context)
     defineUpdateTrigger(config, context)

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

@@ -2,7 +2,8 @@ import {
   defineProperties, defineIndexes,
   processModelsAnnotation, generateId, addAccessControlParents,
   defineDeleteByOwnerEvents, defineParentDeleteTriggers,
-  defineGlobalRangeView
+  defineGlobalRangeView,
+  RelationConfig
 } from './utils.js'
 
 import { defineSetEvent, defineUpdatedEvent, defineTransferredEvent, defineResetEvent } from './propertyEvents.js'
@@ -21,9 +22,37 @@ import {
   defineDeleteTrigger,
   defineDeleteAction
 } from './singularRelationUtils.js'
-
+import { AccessSpecification } from '@live-change/framework'
+import { AccessControlSettings } from './types.js'
+
+export interface PropertyOfConfig extends RelationConfig {
+  readAccess?: AccessSpecification
+  writeAccess?: AccessSpecification
+  listAccess?: AccessSpecification
+  setAccess?: AccessSpecification
+  updateAccess?: AccessSpecification
+  setOrUpdateAccess?: AccessSpecification
+  resetAccess?: AccessSpecification
+  readAllAccess?: AccessSpecification
+
+  readAccessControl?: AccessControlSettings
+  writeAccessControl?: AccessControlSettings
+  listAccessControl?: AccessControlSettings
+  setAccessControl?: AccessControlSettings
+  updateAccessControl?: AccessControlSettings
+  resetAccessControl?: AccessControlSettings
+  setOrUpdateAccessControl?: AccessControlSettings
+  views?: {
+    type: 'range' | 'object'
+    internal?: boolean
+    readAccess?: AccessSpecification,
+    readAccessControl?: AccessControlSettings,
+    fields?: string[]
+  }[]
+}
+  
 export default function(service, app) {
-  processModelsAnnotation(service, app, 'propertyOf', false, (config, context) => {
+  processModelsAnnotation<PropertyOfConfig>(service, app, 'propertyOf', false, (config, context) => {
 
     context.relationWord = 'Property'
     context.reverseRelationWord = 'Owned'
@@ -32,16 +61,18 @@ export default function(service, app) {
     context.sameIdAsParent = true
 
     context.identifiers = defineProperties(context.model, context.others, context.otherPropertyNames)
-    context.model.identifiers = Object.keys(context.identifiers)
+    context.model.identifiers = [
+      ...Object.keys(context.identifiers).map(name => ({ name, field: name })), 
+      { name: context.modelPropertyName, field: 'id' }
+    ]
 
     addAccessControlParents(context)
     defineIndexes(context.model, context.otherPropertyNames, context.others)
 
     defineObjectView({ ...config }, context,
-      config.readAccess || config.writeAccess || config.readAccessControl || config.writeAccessControl)
+      !!(config.readAccess || config.writeAccess || config.readAccessControl || config.writeAccessControl))
     defineRangeViews(config, context,
-      config.listAccess || config.readAccess || config.listAccessControl
-    )
+      !!(config.listAccess || config.readAccess || config.listAccessControl))
 
     if(config.views) {
       for(const view of config.views) {
@@ -53,7 +84,7 @@ export default function(service, app) {
       }
     }
 
-    defineGlobalRangeView(config, context, config.readAllAccess)
+    defineGlobalRangeView(config, context, !!config.readAllAccess)
 
     defineSetEvent(config, context, generateId)
     defineUpdatedEvent(config, context, generateId)
@@ -75,7 +106,7 @@ export default function(service, app) {
       defineUpdateAction(config, context)
     }
 
-    if((config.setAccess && config.updateAccess) || config.writeAccess
+    if((config.setAccess && config.updateAccess && config.setOrUpdateAccess) || config.writeAccess
       || config.setOrUpdateAccessControl || config.writeAccessControl) {
       defineSetOrUpdateAction(config, context)
     }

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

@@ -24,9 +24,41 @@ import {
   defineDeleteTrigger,
   defineDeleteAction
 } from './singularRelationAnyUtils.js'
+import { AccessSpecification } from '@live-change/framework'
+import { AnyRelationConfig } from './utilsAny.js'
+import { AccessControlSettings } from './types.js'
+
+export interface PropertyOfAnyConfig extends AnyRelationConfig {
+  readAccess?: AccessSpecification
+  writeAccess?: AccessSpecification
+  readAllAccess?: AccessSpecification
+  setAccess?: AccessSpecification
+  updateAccess?: AccessSpecification
+  setOrUpdateAccess?: AccessSpecification
+  resetAccess?: AccessSpecification
+  singleAccess?: AccessSpecification
+  listAccess?: AccessSpecification
+
+  readAccessControl?: AccessControlSettings
+  writeAccessControl?: AccessControlSettings
+  readAllAccessControl?: AccessControlSettings
+  setAccessControl?: AccessControlSettings
+  updateAccessControl?: AccessControlSettings
+  setOrUpdateAccessControl?: AccessControlSettings
+  resetAccessControl?: AccessControlSettings
+  singleAccessControl?: AccessControlSettings
+  listAccessControl?: AccessControlSettings
+
+  views?: {
+    type: 'range' | 'object'
+    internal?: boolean
+    fields?: string[]
+  }[]
+
+}
 
 export default function(service, app) {
-  processModelsAnyAnnotation(service, app, 'propertyOfAny', false, (config, context) => {
+  processModelsAnyAnnotation<PropertyOfAnyConfig>(service, app, 'propertyOfAny', false, (config, context) => {
 
     context.relationWord = 'Property'
     context.reverseRelationWord = 'Owned'
@@ -35,18 +67,20 @@ export default function(service, app) {
     context.sameIdAsParent = true
 
     context.identifiers = defineAnyProperties(context.model, context.otherPropertyNames, config)
-    context.model.identifiers = Object.keys(context.identifiers)
+    context.model.identifiers = [
+      ...Object.keys(context.identifiers).map(name => ({ name, field: name }))      
+    ]
 
     addAccessControlAnyParents(context)
     defineAnyIndexes(context.model, context.otherPropertyNames, false)
     defineAnyTypeIndexes(config, context, context.otherPropertyNames.length === 1)
 
     defineObjectView(config, context,
-      config.singleAccess || config.readAccess || config.singleAccessControl || config.readAccessControl
+      !!(config.singleAccess || config.readAccess || config.singleAccessControl || config.readAccessControl)
     )
 
     defineRangeViews(config, context,
-      config.listAccess || config.readAccess || config.listAccessControl || config.readAccessControl
+      !!(config.listAccess || config.readAccess || config.listAccessControl || config.readAccessControl)
     )
 
     if(config.views) {
@@ -59,13 +93,13 @@ export default function(service, app) {
       }
     }
 
-    defineGlobalRangeView(config, context, config.readAllAccess)
+    defineGlobalRangeView(config, context, !!config.readAllAccess)
 
     defineSetEvent(config, context, generateAnyId)
     defineUpdatedEvent(config, context, generateAnyId)
     defineTransferredEvent(config, context, generateAnyId)
     defineResetEvent(config, context, generateAnyId)
-    defineDeleteByOwnerEvents(config, context, generateAnyId)
+    defineDeleteByOwnerEvents(config, context)
 
     defineSetTrigger(config, context)
     defineUpdateTrigger(config, context)

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

@@ -1,5 +1,6 @@
 import {
-  defineProperties, defineIndex, processModelsAnnotation
+  defineProperties, defineIndex, processModelsAnnotation,
+  RelationConfig
 } from './utils.js'
 
 import {
@@ -12,9 +13,30 @@ import {
   defineCreateTrigger, defineUpdateTrigger, defineDeleteTrigger, defineCopyTrigger,
   defineSortIndex,
 } from './pluralRelationUtils.js'
+import { AccessSpecification } from '@live-change/framework'
+import { AccessControlSettings } from './types.js'
+
+export interface RelatedToConfig 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, 'relatedTo', true, (config, context) => {
+  processModelsAnnotation<RelatedToConfig>(service, app, 'relatedTo', true, (config, context) => {
 
     context.relationWord = 'Friend'
     context.reverseRelationWord = 'Related'
@@ -29,10 +51,10 @@ export default function(service, app) {
     }
 
     defineSingleView(config, context,
-      config.readAccess || config.readAccessControl || config.writeAccessControl
+      !!(config.readAccess || config.readAccessControl || config.writeAccessControl)
     )
     defineRangeView(config, context,
-      config.readAccess || config.readAccessControl || config.writeAccessControl
+      !!(config.readAccess || config.readAccessControl || config.writeAccessControl)
     )
     /// TODO: multiple views with limited fields
 

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

@@ -1,5 +1,6 @@
 import {
-  defineAnyProperties, defineAnyIndex, processModelsAnyAnnotation, defineAnyTypeIndexes
+  defineAnyProperties, defineAnyIndex, processModelsAnyAnnotation, defineAnyTypeIndexes,
+  AnyRelationConfig
 } from './utilsAny.js'
 
 import {
@@ -12,9 +13,28 @@ import {
   defineCreateTrigger, defineUpdateTrigger, defineDeleteTrigger,
   defineSortIndex
 } from './pluralRelationAnyUtils.js'
+import { AccessSpecification } from '@live-change/framework'
+import { AccessControlSettings } from './types.js'
+
+export interface RelatedToAnyConfig extends AnyRelationConfig {
+  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
+}
 
 export default function(service, app) {
-  processModelsAnyAnnotation(service, app, 'relatedToAny',true, (config, context) => {
+  processModelsAnyAnnotation<RelatedToAnyConfig>(service, app, 'relatedToAny',true, (config, context) => {
 
     context.relationWord = 'Friend'
     context.reverseRelationWord = 'Related'
@@ -30,10 +50,10 @@ export default function(service, app) {
     }
 
     defineSingleView(config, context,
-      config.readAccess || config.readAccessControl || config.writeAccessControl
+      !!(config.readAccess || config.readAccessControl || config.writeAccessControl)
     )
     defineRangeView(config, context,
-      config.readAccess || config.readAccessControl || config.writeAccessControl
+      !!(config.readAccess || config.readAccessControl || config.writeAccessControl)
     )
     /// TODO: multiple views with limited fields
 

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

@@ -32,6 +32,11 @@ export function defineUpdaterProperties() {
   }
 }
 
+export interface SaveAuthorConfig {
+  saveAuthor?: boolean
+  saveUpdater?: boolean
+}
+
 export default function(service, app) {
   for(let modelName in service.models) {
     const model = service.models[modelName]

package/src/utils.ts

@@ -5,7 +5,7 @@ import {
   registerParentDeleteTriggers, registerParentCopyTriggers
 } from "./changeTriggers.js"
 import {
-  PropertyDefinition, ViewDefinition, IndexDefinition, ActionDefinition, EventDefinition, TriggerDefinition,
+  PropertyDefinition, ViewDefinition,  EventDefinition,
   ServiceDefinitionSpecification,
   PropertyDefinitionSpecification
 } from "@live-change/framework"
@@ -122,7 +122,9 @@ interface RelationContext {
   others: any[],
   reverseRelationWord?: string
   relationWord?: string,
+  partialReverseRelationWord?: string,
   identifiers?: Record<string, PropertyDefinition<PropertyDefinitionSpecification>>
+  sameIdAsParent?: boolean
 }
 
 export function processModelsAnnotation<PreparedConfig extends RelationConfig>

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

@@ -1,10 +1,11 @@
-import App from "@live-change/framework"
+import App, { AccessSpecification, PropertyDefinitionSpecification, ServiceDefinition, ServiceDefinitionSpecification } from "@live-change/framework"
 const app = App.app()
 import {
-  PropertyDefinition, ViewDefinition, IndexDefinition, ActionDefinition, EventDefinition, TriggerDefinition
+  PropertyDefinition, EventDefinition,
 } from "@live-change/framework"
 import { allCombinations } from "./combinations.js"
 import { registerParentDeleteTriggers } from "./changeTriggers.js"
+import { ModelDefinitionSpecificationWithAccessControl } from "./types.js"
 
 
 export function extractTypeAndIdParts(otherPropertyNames, properties) {
@@ -62,10 +63,10 @@ export function defineAnyProperties(model, names, config) {
 }
 
 export function defineAnyIndex(model, what, props) {
-  model.indexes['by' + what] = new IndexDefinition({
+  model.indexes['by' + what] = {
     property: props.map(prop => [prop+'Type', prop]).flat(),
     hash: true
-  })
+  }
 }
 
 export function defineAnyIndexes(model, props, fullIndex = true) {
@@ -77,7 +78,50 @@ export function defineAnyIndexes(model, props, fullIndex = true) {
   }
 }
 
-export function processModelsAnyAnnotation(service, app, annotation, multiple, cb) {
+export interface AnyRelationConfig {
+  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 ModelDefinitionSpecificationWithAnyRelation extends ModelDefinitionSpecificationWithAccessControl {  
+}
+
+interface AnyRelationContext {
+  service: ServiceDefinition<ServiceDefinitionSpecification>
+  app: App
+  model: ModelDefinitionSpecificationWithAnyRelation
+  originalModelProperties: Record<string, PropertyDefinitionSpecification>
+  modelProperties: string[]
+  modelPropertyName: string
+  modelName: string
+  modelRuntime: any
+  annotation: string,
+  otherPropertyNames: string[]
+  joinedOthersPropertyName: string
+  joinedOthersClassName: string
+  writeableProperties: string[]
+  others: any[],
+  objectType: string
+  parentsTypes: string[]
+  otherPossibleTypes: string[][],
+  reverseRelationWord?: string,
+  relationWord?: string,
+  partialReverseRelationWord?: string,
+  identifiers?: Record<string, PropertyDefinition<PropertyDefinitionSpecification>>
+  sameIdAsParent?: boolean
+}
+
+export function processModelsAnyAnnotation<PreparedConfig extends AnyRelationConfig>
+        (service: ServiceDefinition<ServiceDefinitionSpecification>, app: App, annotation: string, multiple: boolean,
+        cb: (config: PreparedConfig, context: AnyRelationContext) => void) {
   if (!service) throw new Error("no service")
   if (!app) throw new Error("no app")
 
@@ -137,12 +181,13 @@ export function processModelsAnyAnnotation(service, app, annotation, multiple, c
         const joinedOthersClassName = others.join('And')
         const objectType = service.name + '_' + modelName
 
-        const parentsTypes = Array.from(new Set(
+        const parentsTypes: string[] = Array.from(new Set(
           (config.parentsTypes || [])
             .concat(otherPossibleTypes.filter(x => !!x).flat()
         )))
 
-        const context = {
+        const context: AnyRelationContext = {
+          annotation,
           service, app, model, originalModelProperties, modelProperties, modelPropertyName, modelRuntime,
           otherPropertyNames, joinedOthersPropertyName, modelName, writeableProperties, joinedOthersClassName, others,
           objectType, parentsTypes, otherPossibleTypes
@@ -241,7 +286,7 @@ export function defineAnyTypeIndexes(config, context, useId = false) {
   const tableName = service.name + '_' + model.name
   if(useId) { // don't use indexes - only object id's - good for propertyOfAny with one parent
     if(context.otherPossibleTypes[0]?.length) return // types defined in definition - no need for index
-    model.indexes[context.otherPropertyNames[0]+'Types'] = new IndexDefinition({
+    model.indexes[context.otherPropertyNames[0]+'Types'] = {
       //property: [propertyName+'Type'],
       function:  async function(input, output, { tableName }) {
         const table = await input.table(tableName)
@@ -263,7 +308,7 @@ export function defineAnyTypeIndexes(config, context, useId = false) {
         })
       },
       parameters: { tableName: tableName }
-    })
+    }
     return
   }
   for(let i = 0; i < context.otherPropertyNames.length; i++) {
@@ -272,7 +317,7 @@ export function defineAnyTypeIndexes(config, context, useId = false) {
     if(propertyTypes.length !== 0) continue // types defined in definition - no need for index
     const srcIndexName = 'by' + propertyName[0].toUpperCase() + propertyName.slice(1)
     if(!model.indexes[srcIndexName]) throw new Error("Parent index not defined: " + srcIndexName)
-    model.indexes[propertyName+'Types'] = new IndexDefinition({
+    model.indexes[propertyName+'Types'] = {
       //property: [propertyName+'Type'],
       function:  async function(input, output, { indexName }) {
         const index = await input.index(indexName)
@@ -294,6 +339,6 @@ export function defineAnyTypeIndexes(config, context, useId = false) {
         })
       },
       parameters: { indexName: tableName + '_' + srcIndexName }
-    })
+    }
   }
 }

package/tsconfig.json

@@ -21,7 +21,7 @@
     "skipLibCheck": true,
     "noImplicitAny": false
   },
-  "files": ["src/index.js"],
+  "files": ["src/index.ts"],
   "include": ["src/**/*.ts", "src/**/*.js"],
   "exclude": ["node_modules/@types", "node_modules/**/*.d.ts", "**/*.test.js", "**/CMakeFiles/**"]
 }

package/typedoc.json

@@ -0,0 +1,14 @@
+{
+  "entryPoints": ["src/index.ts"],
+  "out": "../../docs/docs/relations",
+  "includeVersion": true,
+  "excludePrivate": true,
+  "excludeInternal": true,
+  "excludeProtected": true,
+  "tsconfig": "./tsconfig.json",
+  "plugin": [
+    "typedoc-plugin-markdown",
+    "typedoc-plugin-rename-defaults"
+  ],
+  "sourceLinkTemplate": "https://github.com/live-change/live-change-stack/blob/master/framework/relations-plugin/{path}#L{line}"
+}

package/src/index.js

@@ -1,33 +0,0 @@
-import entity from './entity.js'
-
-import propertyOf from './propertyOf.js'
-import itemOf from './itemOf.js'
-
-import propertyOfAny from './propertyOfAny.js'
-import itemOfAny from './itemOfAny.js'
-
-import relatedTo from './relatedTo.js'
-import relatedToAny from './relatedToAny.js'
-
-import boundTo from './boundTo.js'
-import boundToAny from './boundToAny.js'
-import saveAuthor from './saveAuthor.js'
-
-
-const processors = [
-  entity,
-  propertyOf, itemOf,
-  propertyOfAny, itemOfAny,
-  relatedTo, relatedToAny,
-  boundTo, boundToAny,
-  saveAuthor
-]
-
-const plugin = function(app, services) {
-  app.defaultProcessors.push(...processors)
-}
-plugin.processors = processors
-
-export default plugin
-
-export { processors }