@live-change/access-control-service 0.2.26 → 0.2.29

package/LICENSE.md

@@ -0,0 +1,11 @@
+Copyright 2019-2022 Michał Łaszczewski
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

package/access.js

@@ -4,16 +4,30 @@ module.exports = (definition) => {
   const Access = definition.foreignModel('access-control', 'Access')
   const PublicAccess = definition.foreignModel('access-control', 'PublicAccess')
 
-  function clientHasAnyAccess(client, toType, toId) {
+  function clientHasAnyAccess(client, { objectType, object }) {
     /// TODO: access control
     return true
   }
 
-  function clientHasAdminAccess(client, toType, toId) {
+  function clientHasAdminAccess(client, { objectType, object }) {
     /// TODO: access control
     return true
   }
 
-  return {clientHasAnyAccess, clientHasAdminAccess }
+  function clientCanInvite(client, { roles, objectType, object }) {
+    /// TODO: access control
+    return true
+  }
+
+  function clientCanRequest(client, { roles, objectType, object }) {
+    /// TODO: access control
+    return true
+  }
+
+  function clientHasAccessRole(client, { objectType, object }, role) {
+    return true
+  }
+
+  return { clientHasAnyAccess, clientHasAdminAccess, clientCanInvite, clientCanRequest, clientHasAccessRole }
 
 }

package/index.js

@@ -3,5 +3,7 @@ const app = require("@live-change/framework").app()
 const definition = require('./definition.js')
 
 require('./model.js')
+require('./invite.js')
+require('./request.js')
 
 module.exports = definition

package/invite.js

@@ -0,0 +1,183 @@
+const App = require("@live-change/framework")
+const app = App.app()
+const definition = require('./definition.js')
+const config = definition.config
+
+const { AccessInvitation, invitationProperties, Access } = require('./model.js')
+const access = require('./access.js')(definition)
+
+const contactProperties = {
+  contactType: {
+    type: String,
+    validation: ['nonEmpty']
+  },
+  contact: {
+    type: String,
+    validation: ['nonEmpty']
+  }
+}
+
+const Session = definition.foreignModel('session', 'Session')
+
+definition.event({
+  name: 'userInvited',
+  async execute({ user, objectType, object, roles, message }) {
+    await AccessInvitation.create({
+      id: App.encodeIdentifier([ 'user_User', user, objectType, object ]),
+      contactOrUserType: 'user_User', contactOrUser: user,
+      objectType, object,
+      roles, message
+    })
+  }
+})
+
+definition.event({
+  name: 'contactInvited',
+  async execute({ contactType, contact, objectType, object, roles, message }) {
+    await AccessInvitation.create({
+      id: App.encodeIdentifier([ contactType, contact, objectType, object ]),
+      contactOrUserType: contactType, contactOrUser: contact,
+      objectType, object,
+      roles, message
+    })
+  }
+})
+
+definition.event({
+  name: 'userInvitationAccepted',
+  async execute({ user, objectType, object, roles }) {
+    await AccessInvitation.delete(
+        App.encodeIdentifier([ 'user_User', user, objectType, object ])
+    )
+    await Access.create({
+      id: App.encodeIdentifier([ 'user_User', user, objectType, object ]),
+      sessionOrUserType: 'user_User',
+      sessionOrUser: user,
+      objectType,
+      object,
+      roles
+    })
+  }
+})
+
+definition.trigger({
+  name: 'inviteWithMessageAuthenticated',
+  waitForEvents: true,
+  properties: {
+    ...contactProperties,
+    session: {
+      type: Session,
+      validation: ['nonEmpty']
+    },
+    actionProperties: {
+      type: Object
+    }
+  },
+  async execute({ contactType, contact, session, objectType, object }, { service }, emit) {
+    const contactTypeUpperCase = contactType[0].toUpperCase() + contactType.slice(1)
+    /// Load invitation
+    const invitation = App.encodeIdentifier([ contactType + '_' + contactTypeUpperCase, contact, objectType, object ])
+    console.log("INVITATION", invitation)
+    const invitationData = await AccessInvitation.get(invitation)
+    if(!invitationData) throw 'not_found'
+    const { roles } = invitation
+    /// Create account and sign-in:
+    const user = app.generateUid()
+    await service.trigger({
+      type: 'connect' + contactTypeUpperCase,
+      [contactType]: contact,
+      user
+    })
+    await service.trigger({
+      type: 'signUpAndSignIn',
+      user, session
+    })
+    emit({
+      type: 'userInvitationAccepted',
+      user, objectType, object, roles
+    })
+    return user
+  }
+})
+
+for(const contactType of config.contactTypes) {
+
+  const contactTypeUpperCaseName = contactType[0].toUpperCase() + contactType.slice(1)
+
+  const contactConfig = (typeof contactType == "string") ? { name: contactType } : contactType
+
+  const contactTypeName = contactConfig.name
+  const contactTypeUName = contactTypeName[0].toUpperCase() + contactTypeName.slice(1)
+
+  const contactTypeProperties = {
+    [contactType]: {
+      type: String,
+      validation: ['nonEmpty', contactTypeName]
+    }
+  }
+
+  definition.action({
+    name: 'invite' + contactTypeUpperCaseName,
+    waitForEvents: true,
+    properties: {
+      objectType: {
+        type: String,
+        validation: ['nonEmpty']
+      },
+      object: {
+        type: String,
+        validation: ['nonEmpty']
+      },
+      ...contactTypeProperties,
+      ...invitationProperties
+    },
+    access: (params, { client, context, visibilityTest }) =>
+        visibilityTest || access.clientCanInvite(client, params),
+    async execute(params, { client, service }, emit) {
+      const { [contactTypeName]: contact } = params
+      const { objectType, object } = params
+      const invitationData = { }
+      for(const propertyName in invitationProperties) invitationData[propertyName] = params[propertyName]
+
+      const contactData = (await service.trigger({
+        type: 'get' + contactTypeUName + 'OrNull',
+        [contactType]: contact,
+      }))[0]
+      if(contactData?.user) { // user exists
+        /// TODO: Trigger notification
+        emit({
+          type: 'userInvited',
+          user: contactData.user,
+          objectType, object,
+          ...invitationData
+        })
+      } else {
+        // Authenticate with message because we will create account later
+        const messageData = {
+          fromType: client.user ? 'user_User' : 'session_Session',
+          from: client.user ?? client.session,
+          objectType, object,
+          roles: params.roles,
+          message: params.message
+        }
+        await service.trigger({
+          type: 'authenticateWithMessage',
+          contactType,
+          contact,
+          messageData,
+          action: 'inviteWithMessage',
+          actionProperties: { objectType, object },
+          targetPage: { name: 'access:invitationAccepted', objectType, object }
+        })
+        emit({
+          type: 'contactInvited',
+          contactType: contactTypeName + '_' + contactTypeUName,
+          contact,
+          objectType, object,
+          ...invitationData
+        })
+      }
+    }
+  })
+
+}

package/model.js

@@ -1,28 +1,32 @@
+const App = require("@live-change/framework")
+const app = App.app()
 const definition = require('./definition.js')
 const config = definition.config
 const access = require('./access.js')(definition)
 
+const rolesArrayType = {
+  type: Array,
+  of: {
+    type: String,
+    validation: ['nonEmpty']
+  },
+  validation: ['elementsNonEmpty']
+}
+
 const Access = definition.model({
   name: 'Access',
   sessionOrUserProperty: {
     extendedWith: ['object'],
     ownerReadAccess: () => true,
     readAccess: (params, { client, context, visibilityTest }) =>
-        visibilityTest || access.clientHasAnyAccess(client, params.objectType, params.object),
+        visibilityTest || access.clientHasAnyAccess(client, params),
     updateAccess: (params, { client, context, visibilityTest }) =>
-        visibilityTest || access.clientHasAdminAccess(client, params.objectType, params.object),
+        visibilityTest || access.clientHasAdminAccess(client, params),
     resetAccess: (params, { client, context, visibilityTest }) =>
-        visibilityTest || access.clientHasAdminAccess(client, params.objectType, params.object)
+        visibilityTest || access.clientHasAdminAccess(client, params)
   },
   properties: {
-    roles: {
-      type: Array,
-      of: {
-        type: String,
-        validation: ['nonEmpty']
-      },
-      validation: ['elementsNonEmpty']
-    },
+    roles: rolesArrayType,
     lastUpdate: {
       type: Date
     }
@@ -34,27 +38,14 @@ const PublicAccess = definition.model({
   propertyOfAny: {
     to: 'object',
     readAccess: (params, { client, context, visibilityTest }) =>
-        visibilityTest || access.clientHasAnyAccess(client, params.objectType, params.object),
+        visibilityTest || access.clientHasAnyAccess(client, params),
     writeAccess: (params, { client, context, visibilityTest }) =>
-        visibilityTest || access.clientHasAdminAccess(client, params.objectType, params.object)
+        visibilityTest || access.clientHasAdminAccess(client, params)
   },
   properties: {
-    userRoles: {
-      type: Array,
-      of: {
-        type: String,
-        validation: ['nonEmpty']
-      },
-      validation: ['elementsNonEmpty']
-    },
-    sessionRoles: {
-      type: Array,
-      of: {
-        type: String,
-        validation: ['nonEmpty']
-      },
-      validation: ['elementsNonEmpty']
-    },
+    userRoles: rolesArrayType,
+    sessionRoles: rolesArrayType,
+    availableRoles: rolesArrayType,
     lastUpdate: {
       type: Date
     }
@@ -65,22 +56,19 @@ const PublicAccess = definition.model({
 
 const AccessRequest = definition.model({
   name: 'AccessRequest',
-  sessionOrUserItem: {
-  },
-  relatedToAny: {
-    to: 'object',
+  sessionOrUserProperty: {
+    extendedWith: ['object'],
+    ownerReadAccess: () => true,
+    ownerResetAccess: () => true,
     readAccess: (params, { client, context, visibilityTest }) =>
-        visibilityTest || access.clientHasAdminAccess(client, params.objectType, params.object)
+        visibilityTest || access.clientHasAnyAccess(client, params),
+    updateAccess: (params, { client, context, visibilityTest }) =>
+        visibilityTest || access.clientHasAdminAccess(client, params),
+    resetAccess: (params, { client, context, visibilityTest }) =>
+        visibilityTest || access.clientHasAdminAccess(client, params)
   },
   properties: {
-    roles: {
-      type: Array,
-      of: {
-        type: String,
-        validation: ['nonEmpty']
-      },
-      validation: ['elementsNonEmpty']
-    },
+    roles: rolesArrayType,
     message: {
       type: String,
       validation: []
@@ -90,32 +78,33 @@ const AccessRequest = definition.model({
   }
 })
 
+const invitationProperties = {
+  roles: rolesArrayType,
+  message: {
+    type: String,
+    validation: []
+  }
+}
 
-const AccessInvite = definition.model({
-  name: 'AccessInvite',
-  contactOrUserItem: {},
-  relatedToAny: {
-    to: 'object',
-    readAccess: (params, {client, context, visibilityTest}) =>
-        visibilityTest || access.clientHasAdminAccess(client, params.objectType, params.object)
+const AccessInvitation = definition.model({
+  name: 'AccessInvitation',
+  contactOrUserProperty: {
+    extendedWith: ['object'],
+    ownerReadAccess: () => true,
+    ownerResetAccess: () => true,
+    readAccess: (params, { client, context, visibilityTest }) =>
+        visibilityTest || access.clientHasAnyAccess(client, params),
+    updateAccess: (params, { client, context, visibilityTest }) =>
+        visibilityTest || access.clientHasAdminAccess(client, params),
+    resetAccess: (params, { client, context, visibilityTest }) =>
+        visibilityTest || access.clientHasAdminAccess(client, params)
   },
   properties: {
-    roles: {
-      type: Array,
-      of: {
-        type: String,
-        validation: ['nonEmpty']
-      },
-      validation: ['elementsNonEmpty']
-    },
-    message: {
-      type: String,
-      validation: []
-    }
+    ...invitationProperties
   },
   indexes: {
 
   }
 })
 
-module.exports = { Access, PublicAccess, AccessRequest, AccessInvite }
+module.exports = { Access, PublicAccess, AccessRequest, AccessInvitation, invitationProperties, rolesArrayType }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@live-change/access-control-service",
-  "version": "0.2.26",
+  "version": "0.2.29",
   "description": "",
   "main": "index.js",
   "scripts": {
@@ -21,7 +21,7 @@
     "url": "https://www.viamage.com/"
   },
   "dependencies": {
-    "@live-change/framework": "0.6.0"
+    "@live-change/framework": "0.6.3"
   },
-  "gitHead": "f3d7b9b6c689b9d87df3cb7f64cd75fc72339b7a"
+  "gitHead": "37d229ac05adf5e045ae3dcc826c6945d5dc3670"
 }

package/request.js

@@ -0,0 +1,54 @@
+const App = require("@live-change/framework")
+const app = App.app()
+const definition = require('./definition.js')
+const config = definition.config
+
+const { Access, AccessRequest, rolesArrayType } = require('./model.js')
+const access = require('./access.js')(definition)
+
+definition.event({
+  name: 'accessRequestAccepted',
+  async execute({ sessionOrUserType, sessionOrUser, objectType, object, roles }) {
+    const id = App.encodeIdentifier([sessionOrUserType, sessionOrUser, objectType, object])
+    await Access.create({
+      id,
+      sessionOrUserType, sessionOrUser, objectType, object, roles
+    })
+    await AccessRequest.delete(id)
+  }
+})
+
+definition.action({
+  name: 'acceptAccessRequest',
+  waitForEvents: true,
+  properties: {
+    objectType: {
+      type: String,
+      validation: ['nonEmpty']
+    },
+    object: {
+      type: String,
+      validation: ['nonEmpty']
+    },
+    sessionOrUserType: {
+      type: String,
+      validation: ['nonEmpty']
+    },
+    sessionOrUser: {
+      type: String,
+      validation: ['nonEmpty']
+    },
+    roles: rolesArrayType
+  },
+  access: (params, { client, context, visibilityTest }) =>
+      visibilityTest || access.clientCanInvite(client, params),
+  async execute({ objectType, object, sessionOrUserType, sessionOrUser, roles }, { client, service }, emit) {
+    const request = App.encodeIdentifier([ sessionOrUserType, sessionOrUser, objectType, object ])
+    const requestData = await AccessRequest.get(request)
+    if(!requestData) throw 'not_found'
+    emit({
+      type: 'accessRequestAccepted',
+      objectType, object, sessionOrUserType, sessionOrUser, roles
+    })
+  }
+})