@live-change/framework 0.9.74 → 0.9.76

package/index.ts

@@ -0,0 +1,39 @@
+import App from './lib/App.js'
+
+export default App
+
+import ActionDefinition from './lib/definition/ActionDefinition.js'
+import EventDefinition from './lib/definition/EventDefinition.js'
+import ForeignIndexDefinition from './lib/definition/ForeignIndexDefinition.js'
+import ForeignModelDefinition from './lib/definition/ForeignModelDefinition.js'
+import IndexDefinition from './lib/definition/IndexDefinition.js'
+import ModelDefinition from './lib/definition/ModelDefinition.js'
+import PropertyDefinition from './lib/definition/PropertyDefinition.js'
+import ServiceDefinition from './lib/definition/ServiceDefinition.js'
+import TriggerDefinition from './lib/definition/TriggerDefinition.js'
+import ViewDefinition from './lib/definition/ViewDefinition.js'
+
+export {
+  ActionDefinition,
+  EventDefinition,
+  ForeignIndexDefinition,
+  ForeignModelDefinition,
+  IndexDefinition,
+  ModelDefinition,
+  PropertyDefinition,
+  ServiceDefinition,
+  TriggerDefinition,
+  ViewDefinition
+}
+
+// Export all types from definition files
+export type { ActionDefinitionSpecification, ActionParameters } from './lib/definition/ActionDefinition.js'
+export type { EventDefinitionSpecification, EventParameters } from './lib/definition/EventDefinition.js'
+export type { IndexDefinitionSpecification } from './lib/definition/IndexDefinition.js'
+export type { ModelDefinitionSpecification, ModelIndexDefinitionSpecification, ModelPropertyDefinitionSpecification } from './lib/definition/ModelDefinition.js'
+export type { PropertyDefinitionSpecification, ValidationSpecification, ValidationSpecificationObject } from './lib/definition/PropertyDefinition.js'
+export type { ViewDefinitionSpecification, ViewDefinitionSpecificationBase, ViewDefinitionSpecificationObservable, ViewDefinitionSpecificationDaoPath, ViewDefinitionSpecificationFetch } from './lib/definition/ViewDefinition.js'
+export type { TriggerDefinitionSpecification } from './lib/definition/TriggerDefinition.js'
+export type { ClientContext, ContextBase, ViewContext, ActionContext } from './lib/definition/types.js'
+export type { ServiceDefinitionSpecification } from './lib/definition/ServiceDefinition.js'
+export type { AccessSpecification, AccessFunction } from './lib/processors/accessMethod.js'

package/lib/App.js

@@ -36,6 +36,10 @@ import Debug from 'debug'
 
 const debug = Debug('framework')
 
+
+import * as utils from './utils.js'
+import * as validation from './utils/validation.js'
+
 class App {
 
   constructor(config = {}) {
@@ -82,8 +86,25 @@ class App {
     this.startedServices = {}
     this.triggerRoutes = {}
     this.globalViews = {}
+
   }
 
+  static app() {
+    if(!globalThis.liveChangeFrameworkApp) {
+      globalThis.liveChangeFrameworkApp = new App()
+    }
+    return globalThis.liveChangeFrameworkApp
+  }
+
+  static utils = utils
+  static validation = validation
+  static rangeProperties = utils.rangeProperties
+  static encodeIdentifier = utils.encodeIdentifier
+  static extractRange = utils.extractRange
+  static isomorphic = utils.isomorphic
+  static computeDefaults = utils.computeDefaults
+  static computeUpdates = utils.computeUpdates
+
   createServiceDefinition( definition ) {
     const sourceConfig = this.config && this.config.services && this.config.services.find
       && this.config.services.find(c => c.name === definition.name)

package/lib/definition/ActionDefinition.ts

@@ -1,18 +1,17 @@
+import { AccessSpecification } from "../processors/accessMethod.js"
 import PropertyDefinition, { PropertyDefinitionSpecification } from "./PropertyDefinition.js"
-import { ExecutionContext } from "./types.js"
+import type { ActionContext } from "./types.js"
 
-type ActionParameters = Record<string, any>
-
-export interface ActionContext extends ExecutionContext {
-  action: any
-  emit: (event: any) => void
-}
+export type ActionParameters = Record<string, any>
 
 export interface ActionDefinitionSpecification {  
   name: string
   properties: Record<string, PropertyDefinitionSpecification>
   returns: PropertyDefinitionSpecification,
-  execute: (parameters: ActionParameters, context: ActionContext, emit: (event: any) => void) => any
+  execute: (parameters: ActionParameters, context: ActionContext, emit: (event: any) => void) => any,
+  access: AccessSpecification,
+  skipValidation: boolean,
+  validation: (parameters: ActionParameters, context: ActionContext) => Promise<any>
 }
 
 class ActionDefinition<T extends ActionDefinitionSpecification> {

package/lib/definition/EventDefinition.ts

@@ -1,6 +1,6 @@
 import PropertyDefinition, { PropertyDefinitionSpecification } from "./PropertyDefinition.js"
 
-type EventParameters = Record<string, any>
+export type EventParameters = Record<string, any>
 
 export interface EventDefinitionSpecification {
   name: string

package/lib/definition/IndexDefinition.ts

@@ -1,9 +1,9 @@
 
 export interface IndexDefinitionSpecification {
   name: string
-  properties: Record<string, PropertyDefinition>
+  property: string | string[]
   function: (...args: any[]) => any
-  search: boolean
+  parameters: Record<string, any>
   storage: any
   multi: boolean,
 }

package/lib/definition/ModelDefinition.ts

@@ -1,12 +1,24 @@
 import PropertyDefinition from "./PropertyDefinition.js"
 import type { PropertyDefinitionSpecification } from "./PropertyDefinition.js"
-import type { IndexDefinitionSpecification } from "./IndexDefinition.js"
 import { crudChanges, definitionToJSON } from "../utils.js"
 
+export interface ModelIndexDefinitionSpecification {  
+  property?: string | string[]
+  function?: (...args: any[]) => any
+  parameters?: Record<string, any>  
+  storage?: any
+  multi?: boolean,
+}
+
+export interface ModelPropertyDefinitionSpecification {
+  type: string,
+  index: ModelIndexDefinitionSpecification
+}
+
 export interface ModelDefinitionSpecification {
   name: string
-  properties: Record<string, PropertyDefinitionSpecification>
-  indexes: Record<string, IndexDefinitionSpecification>
+  properties: Record<string, ModelPropertyDefinitionSpecification>
+  indexes: Record<string, ModelIndexDefinitionSpecification>
   onChange: (() => void)[]
 }
 

package/lib/definition/PropertyDefinition.ts

@@ -1,10 +1,18 @@
 import { typeName, definitionToJSON } from "../utils.js"
 
+export interface ValidationSpecificationObject {
+  name: string
+  [key: string]: any
+}
+
+export type ValidationSpecification = ValidationSpecificationObject | string
+
 export interface PropertyDefinitionSpecification {
   type: string
   of?: PropertyDefinitionSpecification
   items?: PropertyDefinitionSpecification
-  properties?: Record<string, PropertyDefinitionSpecification>
+  properties?: Record<string, PropertyDefinitionSpecification>,
+  validation: ValidationSpecification[]
 }
 
 class PropertyDefinition<T extends PropertyDefinitionSpecification> {

package/lib/definition/ServiceDefinition.ts

@@ -72,7 +72,7 @@ function createForeignIndexProxy(definition, model) {
 
 
 
-interface ServiceDefinitionSpecification {
+export interface ServiceDefinitionSpecification {
 
 }
 

package/lib/definition/ViewDefinition.ts

@@ -1,14 +1,17 @@
 import PropertyDefinition, { PropertyDefinitionSpecification } from "./PropertyDefinition.js"
 
-import type { ExecutionContext } from "./types.js"
+import type { ViewContext } from "./types.js"
+
+import type { AccessSpecification } from "../processors/accessMethod.js"
 
 export interface ViewDefinitionSpecificationBase {
   name: string
   properties: Record<string, PropertyDefinitionSpecification>
   returns: PropertyDefinitionSpecification
-}
-
-export interface ViewContext extends ExecutionContext {  
+  internal: boolean,
+  access: AccessSpecification,
+  skipValidation: boolean,
+  validation: (parameters: Record<string, any>, context: ViewContext) => Promise<any>
 }
 
 export interface ViewDefinitionSpecificationObservable extends ViewDefinitionSpecificationBase {

package/lib/definition/types.ts

@@ -6,7 +6,16 @@ export interface ClientContext {
   roles: string[]
 }
 
-export interface ExecutionContext {
+export interface ContextBase {
   client: ClientContext
-  service: any
-}
+  service: any,
+  visibilityTest: boolean
+}
+
+export interface ViewContext extends ContextBase {
+  view: any,
+}
+
+export interface ActionContext extends ContextBase {
+  action: any
+}

package/lib/processors/{accessMethod.js → accessMethod.ts}

@@ -1,4 +1,10 @@
-export default function getAccessMethod(access) {
+import { ActionContext, ViewContext } from "../definition/types.js"
+
+export type AccessFunction = (params: Record<string, any>, context: ViewContext | ActionContext) => boolean
+
+export type AccessSpecification = AccessFunction | string[] | 'internal'
+
+export default function getAccessMethod(access: AccessSpecification) {
   if(typeof access == 'function') {
     return access
   } else if(Array.isArray(access)) {

package/lib/processors/autoValidation.js

@@ -24,6 +24,10 @@ export default function(service, app) {
           if(!action.skipValidation) {
             await validate(args[0], validators, { source: action, action, service, app, ...context })
           }
+          if(typeof action.validation === 'function') {
+            const result = await action.validation(args[0], { source: action, action, service, app, ...context })
+            if(result) throw result            
+          }
           return oldExec.apply(action, args)
         }
       }
@@ -31,25 +35,35 @@ export default function(service, app) {
   }
   for(let viewName in service.views) {
     const view = service.views[viewName]
-    if(view.skipValidation) continue
+    if(view.skipValidation && !view.validation) continue
     const validators = getValidators(view, service, view)
     if(Object.keys(validators).length > 0) {
       if (view.observable) {
         const oldObservable = view.observable
         view.observable = async (...args) => {
           const context = args[1]
-          return validate(args[0], validators, { source: view, view, service, app, ...context }).then(() =>
-              oldObservable.apply(view, args)
-          )
+          if(!view.skipValidation) {
+            await validate(args[0], validators, { source: view, view, service, app, ...context })
+          }
+          if(typeof view.validation === 'function') {
+            const result = await view.validation(args[0], { source: view, view, service, app, ...context })
+            if(result) throw result            
+          }
+          return oldObservable.apply(view, args)
         }
       }
       if(view.get) {
         const oldGet = view.get
         view.get = async (...args) => {
           const context = args[1]
-          return validate(args[0], validators, { source: view, view, service, app, ...context }).then(() =>
-              oldGet.apply(view, args)
-          )
+          if(!view.skipValidation) {
+            await validate(args[0], validators, { source: view, view, service, app, ...context })
+          }
+          if(typeof view.validation === 'function') {
+            const result = await view.validation(args[0], { source: view, view, service, app, ...context })
+            if(result) throw result            
+          }
+          return oldGet.apply(view, args)          
         }
       }
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@live-change/framework",
-  "version": "0.9.74",
+  "version": "0.9.76",
   "description": "Live Change Framework - ultimate solution for real time mobile/web apps",
   "main": "index.js",
   "scripts": {
@@ -22,8 +22,11 @@
   },
   "homepage": "https://github.com/live-change/live-change-stack",
   "devDependencies": {
-    "@live-change/dao": "^0.9.74",
-    "@live-change/uid": "^0.9.74"
+    "@live-change/dao": "^0.9.76",
+    "@live-change/uid": "^0.9.76",
+    "typedoc": "0.28.3",
+    "typedoc-plugin-markdown": "^4.6.3",
+    "typedoc-plugin-rename-defaults": "^0.7.3"
   },
-  "gitHead": "cdb37d2051a08b4425fcb282dfd51a2c8f3112ba"
+  "gitHead": "7b28068b9dca33af82e94db52b8a778c289edfbc"
 }

package/tsconfig.json

@@ -0,0 +1,29 @@
+{
+  "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": ["index.ts"],
+  "include": [
+    "lib/**/*.ts", "lib/**/*.js", "index.ts"],
+  "exclude": ["node_modules/@types", "node_modules/**/*.d.ts", "**/*.test.js", "**/CMakeFiles/**"]
+}
+

package/typedoc.json

@@ -0,0 +1,14 @@
+{
+  "entryPoints": ["index.ts"],
+  "out": "docs",
+  "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/framework/{path}#L{line}"
+}

package/index.js

@@ -1,46 +0,0 @@
-import App from './lib/App.js'
-
-App.app = () => {
-  if(!globalThis.liveChangeFrameworkApp) {
-    globalThis.liveChangeFrameworkApp = new App()
-  }
-  return globalThis.liveChangeFrameworkApp
-}
-
-import * as utils from './lib/utils.js'
-import * as validation from './lib/utils/validation.js'
-
-App.utils = utils
-App.validation = validation
-App.rangeProperties = utils.rangeProperties
-App.encodeIdentifier = utils.encodeIdentifier
-App.extractRange = utils.extractRange
-App.isomorphic = utils.isomorphic
-App.computeDefaults = utils.computeDefaults
-App.computeUpdates = utils.computeUpdates
-
-export default App
-
-import ActionDefinition from './lib/definition/ActionDefinition.js'
-import EventDefinition from './lib/definition/EventDefinition.js'
-import ForeignIndexDefinition from './lib/definition/ForeignIndexDefinition.js'
-import ForeignModelDefinition from './lib/definition/ForeignModelDefinition.js'
-import IndexDefinition from './lib/definition/IndexDefinition.js'
-import ModelDefinition from './lib/definition/ModelDefinition.js'
-import PropertyDefinition from './lib/definition/PropertyDefinition.js'
-import ServiceDefinition from './lib/definition/ServiceDefinition.js'
-import TriggerDefinition from './lib/definition/TriggerDefinition.js'
-import ViewDefinition from './lib/definition/ViewDefinition.js'
-
-export {
-  ActionDefinition,
-  EventDefinition,
-  ForeignIndexDefinition,
-  ForeignModelDefinition,
-  IndexDefinition,
-  ModelDefinition,
-  PropertyDefinition,
-  ServiceDefinition,
-  TriggerDefinition,
-  ViewDefinition
-}