@ossy/workspaces 1.4.0 → 1.5.0

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@ossy/workspaces",
   "description": "Workspaces feature package — create, select, and manage workspaces, users, and invitations",
-  "version": "1.4.0",
+  "version": "1.5.0",
   "type": "module",
   "main": "./src/index.js",
   "module": "./src/index.js",
@@ -27,5 +27,5 @@
     "/src",
     "README.md"
   ],
-  "gitHead": "ed72d972761405ecc4e12804aefa77f763aa4646"
+  "gitHead": "5f1feadf3b630aa96ec61f1d48c11e0e1aa4b095"
 }

package/src/index.js

@@ -7,3 +7,5 @@ export { Users } from './Users.jsx'
 export { AuthenticationGuard } from './AuthenticationGuard.jsx'
 export { patchUserWorkspaceId } from './patchUserWorkspaceId.js'
 export { Definition } from './Definition.js'
+export { Workspace } from './workspace.aggregate.js'
+export { WorkspacesEvents } from './workspaces.events.js'

package/src/workspace.aggregate.js

@@ -0,0 +1,116 @@
+export class Workspace {
+
+  static AggregateType = 'Workspace'
+
+  static View(events, state = {}) {
+    return events
+      .reduce((workspace, event) => {
+
+      switch (event.type) {
+
+        case 'Created':
+          return {
+            ...workspace,
+            id: event.aggregateId,
+            name: event.payload.name,
+            createdBy: event.createdBy,
+            created: event.created,
+            apiTokens: [],
+            users: [event.createdBy],
+            invitations: [],
+            resourceTemplates: [],
+            services: {
+              // '@ossy/visual-content-classifiers': true,
+              '@ossy/tasks/resize-common-web': true,
+              '@ossy/apps': true,
+              '@ossy/domains': true,
+            }
+          }
+
+        case 'ResourceTemplatesImported':
+          return {
+            ...workspace,
+            resourceTemplates: [
+              ...(event.payload.templates || []),
+            ]
+          }
+
+        case 'UserInvited': {
+          const oneWeek = 1000 * 60 * 60 * 24 * 7
+          const expired = event.payload.expiresAt < Date.now()
+          // show expired workspace invitations for 7 days
+          const showInvitation = (event.payload.expiresAt + oneWeek) > Date.now()
+
+          if (!showInvitation) {
+            return workspace
+          }
+
+          return {
+            ...workspace,
+            invitations: [
+              ...(workspace.invitations || []),
+              {
+                email: event.payload.email,
+                invitedAt: event.created,
+                expiresAt: event.payload.expiresAt,
+                expired: expired
+              }
+            ]
+          }
+        }
+
+        case 'UserInvitationAccepted': {
+          return {
+            ...workspace,
+            users: [
+              ...workspace.users,
+              event.createdBy
+            ],
+            invitations: workspace.invitations.filter(invitation => invitation.email !== event.payload.email)
+          }
+        }
+
+        case 'ApiTokenCreated':
+          return {
+            ...workspace,
+            apiTokens: [
+              ...(apiTokens || []),
+              {
+                id: event.id,
+                description: event.payload.description
+              }
+            ]
+          }
+        
+        case 'ServiceEnabled':
+          return {
+            ...workspace,
+            services: {
+              ...(workspace.services || {}),
+              [event.payload.service]: true
+            }
+          }
+
+        case 'ServiceDisabled':
+          return {
+            ...workspace,
+            services: {
+              ...(workspace.services || {}),
+              [event.payload.service]: false
+            }
+          }
+
+        case 'UserRemoved':
+          return {
+            ...workspace,
+            users: (workspace.users || []).filter(id => id !== event.payload.userId)
+          }
+
+        default:
+          return workspace
+
+      }
+    }, state)
+  }
+
+}

package/src/workspaces.events.js

@@ -0,0 +1,171 @@
+/**
+ * Field
+ * @typedef {Object} Field
+ * @property {string} type - field type
+ * @property {string} name - name of field
+ */
+
+ /**
+  * ResourceTemplate
+  * @typedef {Object} ResourceTemplate
+  * @property {string} name - Displayname of the resource template
+  * @property {Field[]} fields - Allowed fields
+  */
+
+
+/**
+  * @class
+  */
+export class WorkspacesEvents {
+
+  /**
+   * Return type of WorkspacesEvents.Created
+   * @typedef {Object} Created
+   * @property {string} type - Created
+   * @property {string} createdBy - userId of user who created the workspace
+   * @property {CreatedPayload} payload - event payload
+   */
+
+   /**
+    * Payload of Workspace.Created event
+    * @typedef {Object} CreatedPayload
+    * @property {string} name - Name of workspace
+    */
+
+  /**
+   * Input for WorkspacesEvents.Created
+   * @typedef {Object} CreatedInput
+   * @property {string} name - Name of workspace
+   * @property {string} createdBy - userId of user who created the workspace
+   */
+
+  /**
+   *  Use this to indicate that a new workspace have been created
+   *
+   * @param {CreatedInput} input
+   * @return {Created} - Workspace created event
+   *
+   * @example
+   * const name = 'ossy.se'
+   * const createdBy = 'fake-user-id-123'
+   *
+   * const event = WorkspacesEvents.Created({ name, createdBy })
+   *
+   * Aggregate.Of(Workspace, event)
+   */
+  static Created({ createdBy, name }) {
+    return ({
+      type: 'Created',
+      createdBy: createdBy,
+      payload: {
+        name: name
+      }
+    })
+   }
+
+   /**
+    * Return type of WorkspacesEvents.ResourceTemplatesImported
+    * @typedef {Object} ResourceTemplatesImported
+    * @property {string} type - ResourceTemplatesImported
+    * @property {string} createdBy - userId of user who created the workspace
+    * @property {ResourceTemplate[]} payload - event payload
+    */
+
+   /**
+    * Input for WorkspacesEvents.Created
+    * @typedef {Object} ResourceTemplatesImportedInput
+    * @property {ResourceTemplate[]} templates - List of resource templates
+    * @property {string} createdBy - userId of user who created the workspace
+    */
+
+   /**
+    *  Use this to save imported resource templates
+    *
+    * @param {ResourceTemplatesImportedInput} input
+    * @return {ResourceTemplatesImported} - Resource templates imported event
+    *
+    * @example
+    * const templates = []
+    * const createdBy = 'fake-user-123'
+    *
+    * const event = WorkspacesEvents.Created({ templates, createdBy })
+    *
+    * Aggregate.Of(Workspace, userId)
+    *  .then(Aggregate.Add(event))
+    */
+   static ResourceTemplatesImported({ createdBy, templates }) {
+     return ({
+       type: 'ResourceTemplatesImported',
+       createdBy: createdBy,
+       payload: {
+         templates: templates
+       }
+     })
+   }
+
+   // Not in use atm, use API TOKENS in the user aggregate instead.
+   // Caller is responsible for generating the token value.
+   static ApiTokenCreated({ createdBy, description, token }) {
+     return ({
+       type: 'ApiTokenCreated',
+       createdBy: createdBy,
+       payload: {
+         description: description,
+         token: token
+       }
+     })
+   }
+   
+
+   static UserInvited({ createdBy, email, expiresAt }) {
+     return ({
+       type: 'UserInvited',
+       createdBy: createdBy,
+       payload: {
+         email: email,
+         expiresAt: new Date().getTime() + 1000 * 60 * 60 * 24 * 7, // One week
+       }
+     })
+   }
+
+   static UserInvitationAccepted({ createdBy, email }) {
+     return ({
+       type: 'UserInvitationAccepted',
+       createdBy: createdBy,
+       payload: {
+        email: email
+       }
+     })
+   }
+   
+   static ServiceEnabled({ createdBy, service }) {
+     return ({
+       type: 'ServiceEnabled',
+       createdBy: createdBy,
+       payload: {
+         service: service
+       }
+     })
+  }
+
+  static ServiceDisabled({ createdBy, service }) {
+    return ({
+      type: 'ServiceDisabled',
+      createdBy: createdBy,
+      payload: {
+        service: service
+      }
+    })
+  }
+
+  static UserRemoved({ createdBy, userId }) {
+    return ({
+      type: 'UserRemoved',
+      createdBy: createdBy,
+      payload: {
+        userId: userId
+      }
+    })
+  }
+
+}