@universis/webhooks 1.1.1

package/src/config/models/WebHook.json

@@ -0,0 +1,182 @@
+{
+  "$schema": "https://themost-framework.github.io/themost/models/2018/2/schema.json",
+  "@id": "https://universis.io/schemas/WebHook",
+  "name": "WebHook",
+  "title": "WebHooks",
+  "hidden": false,
+  "sealed": false,
+  "abstract": false,
+  "version": "1.1.0",
+  "fields": [
+    {
+      "@id": "https://universis.io#id",
+      "name": "id",
+      "title": "ID",
+      "description": "The identifier of the item.",
+      "type": "Guid",
+      "primary": true,
+      "readonly": true,
+      "value": {
+        "$uuid": 1
+      }
+    },
+    {
+      "@id": "http://schema.org/additionalType",
+      "name": "additionalType",
+      "title": "additionalType",
+      "description": "An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.",
+      "type": "Text",
+      "value": "javascript:return this.model.name;",
+      "readonly": true
+    },
+    {
+      "@id": "http://schema.org/name",
+      "name": "name",
+      "title": "name",
+      "description": "The name of the item.",
+      "type": "Text"
+    },
+    {
+      "@id": "https://universis.io#dateCreated",
+      "name": "dateCreated",
+      "title": "dateCreated",
+      "description": "The date on which this item was created.",
+      "type": "DateTime",
+      "readonly": true,
+      "value": {
+        "$now": 1
+      }
+    },
+    {
+      "@id": "https://universis.io#dateModified",
+      "name": "dateModified",
+      "title": "dateModified",
+      "description": "The date on which this item was most recently modified.",
+      "type": "DateTime",
+      "readonly": true,
+      "value": {
+        "$now": 1
+      },
+      "calculation": {
+        "$now": 1
+      }
+    },
+    {
+      "@id": "https://universis.io#owner",
+      "name": "owner",
+      "title": "owner",
+      "description": "The owner of the item.",
+      "type": "User",
+      "editable": false,
+      "nullable": false,
+      "value": {
+        "$user": 1
+      }
+    },
+    {
+      "@id": "https://universis.io#emit",
+      "name": "emit",
+      "title": "Emit",
+      "description": "Specifies whether the webhook should be triggered automatically or not.",
+      "type": "Boolean",
+      "value": {
+        "$value": true
+      }
+    },
+    {
+      "@id": "https://universis.io#createdBy",
+      "name": "createdBy",
+      "title": "createdBy",
+      "description": "Created by user.",
+      "type": "User",
+      "readonly": true,
+      "value": {
+        "$user": 1
+      }
+    },
+    {
+      "@id": "https://universis.io#modifiedBy",
+      "name": "modifiedBy",
+      "title": "modifiedBy",
+      "description": "Last modified by user.",
+      "type": "User",
+      "readonly": true,
+      "value": {
+        "$user": 1
+      },
+      "calculation": {
+        "$user": 1
+      }
+    },
+    {
+      "@id": "https://universis.io#webHookAction",
+      "name": "action",
+      "title": "action",
+      "description": "Reference to WebHookAction entity that defines the scope of the webhook.",
+      "type": "WebHookAction",
+      "mapping": {
+        "parentModel": "WebHookAction",
+        "parentField": "name"
+      }
+    },
+    {
+      "@id": "https://universis.io#active",
+      "name": "active",
+      "title": "Active",
+      "description": "Specifies whether the webhook is active or not.",
+      "type": "Boolean",
+      "nullable": false,
+      "value": {
+        "$value": true
+      }
+    },
+    {
+      "@id": "https://universis.io#webHookConfig",
+      "name": "config",
+      "title": "WebHook endpoint configuration",
+      "description": "Configuration settings for the webhook endpoint e.g. authentication, custom headers etc.",
+      "type": "Json",
+      "additionalType": "WebHookConfiguration"
+    },
+    {
+      "@id": "https://universis.io#lastResponse",
+      "name": "lastResponse",
+      "title": "Last Response",
+      "description": "Details of the last response received from the webhook endpoint.",
+      "type": "Json"
+    }
+  ],
+  "privileges": [
+    {
+      "mask": 15,
+      "type": "global"
+    },
+    {
+      "mask": 15,
+      "type": "global",
+      "account": "Administrators"
+    },
+    {
+      "mask": 1,
+      "type": "self",
+      "filter": "owner eq me()",
+      "scope": [
+        "webhooks:read"
+      ]
+    },
+    {
+      "mask": 14,
+      "type": "self",
+      "filter": "owner eq me()",
+      "scope": [
+        "webhooks:write"
+      ]
+    }
+  ],
+  "constraints": [
+  ],
+  "seed": [
+  ],
+  "eventListeners": [
+  ]
+}

package/src/config/models/WebHookAction.json

@@ -0,0 +1,85 @@
+{
+  "$schema": "https://themost-framework.github.io/themost/models/2018/2/schema.json",
+  "@id": "https://universis.io/schemas/WebHookAction",
+  "name": "WebHookAction",
+  "title": "WebHookActions",
+  "hidden": false,
+  "sealed": false,
+  "abstract": false,
+  "implements": "Thing",
+  "version": "1.1.0",
+  "fields": [
+    {
+      "@id": "http://schema.org/name",
+      "name": "name",
+      "title": "name",
+      "description": "The name of the item.",
+      "type": "Text",
+      "nullable": false
+    },
+    {
+      "@id": "http://schema.org/about",
+        "name": "about",
+        "type": "Text",
+        "title": "About",
+        "description": "The name of the entity type to which the webhook applies",
+        "nullable": false
+    },
+    {
+      "@id": "https://universis.io#state",
+      "name": "state",
+      "type": "Integer",
+      "title": "Event Types",
+      "description": "The type of event that triggers the webhook (e.g., insert, update, delete)",
+      "nullable": false
+    },
+    {
+      "@id": "https://universis.io#filter",
+      "name": "filter",
+      "type": "Text",
+      "title": "Filter",
+      "description": "Specifies when the webhook should be executed according to the current state of an object. The expression should follow OData $filter query option e.g. studentStatus ne 'active'",
+      "nullable": true
+    },
+    {
+      "@id": "https://universis.io#when",
+      "name": "when",
+      "type": "Text",
+      "title": "When",
+      "description": "An optional filter expression to further refine when the webhook is triggered according to the previous state of an object. The expression should follow OData $filter query option e.g. studentStatus eq 'active'",
+      "nullable": true
+    }
+  ],
+  "privileges": [
+    {
+      "mask": 15,
+      "type": "global"
+    },
+    {
+      "mask": 1,
+      "type": "global",
+      "account": "*"
+    },
+    {
+      "mask": 15,
+      "type": "global",
+      "account": "Administrators"
+    }
+  ],
+  "constraints": [
+    {
+        "type": "unique",
+        "@help": "Each item name must be unique because it is used as a reference e.g. create_user or delete_user etc.",
+        "fields": [
+            "name"
+        ]
+    }
+  ],
+  "seed": [
+  ],
+  "eventListeners": [
+    {
+      "type": "./listeners/OnWebHookAction"
+    }
+  ]
+}

package/src/config/models/WebHookConfiguration.json

@@ -0,0 +1,66 @@
+{
+  "$schema": "https://themost-framework.github.io/themost/models/2018/2/schema.json",
+  "@id": "https://universis.io/schemas/WebHookConfiguration",
+  "name": "WebHookConfiguration",
+  "title": "WebHookConfigurations",
+  "hidden": true,
+  "sealed": true,
+  "abstract": true,
+  "version": "1.1.0",
+  "fields": [
+    {
+      "@id": "https://universis.io#url",
+      "name": "url",
+      "title": "URL",
+      "description": "The URL to which the webhook payloads will be delivered",
+      "type": "URL",
+      "nullable": false
+    },
+    {
+      "@id": "https://universis.io#contentType",
+      "name": "contentType",
+      "title": "Content Type",
+      "description": "The content type of the payload sent to the webhook URL (e.g., application/json)",
+      "type": "Text",
+      "nullable": false,
+      "value": {
+        "$value": "application/json"
+      }
+    },
+    {
+      "@id": "https://universis.io#insecure",
+      "name": "insecure",
+      "title": "Insecure",
+      "description": "Indicates whether to skip SSL certificate verification when sending requests to the webhook URL",
+      "type": "Boolean",
+      "nullable": false,
+      "value": {
+        "$value": false
+      }
+    },
+    {
+        "@id": "https://universis.io#secret",
+        "name": "secret",
+        "title": "Secret",
+        "description": "An optional secret key used to sign the payloads sent to the webhook URL for verification purposes. The signature is included in the 'X-Signature' header of the request.",
+        "type": "Text"
+    }
+  ],
+  "privileges": [
+    {
+      "mask": 15,
+      "type": "global"
+    },
+    {
+      "mask": 15,
+      "type": "global",
+      "account": "Administrators"
+    }
+  ],
+  "constraints": [
+  ],
+  "seed": [
+  ],
+  "eventListeners": [
+  ]
+}

package/src/config/scope.access.js

@@ -0,0 +1,34 @@
+const WebHookScopeAccessElements = [
+    {
+        'scope': [
+            'webhooks:read',
+        ],
+        'resource': '/api/WebHookActions/?',
+        'access': [
+            'read'
+        ]
+    },
+    {
+        'scope': [
+            'webhooks:read',
+        ],
+        'resource': '/api/WebHooks/?',
+        'access': [
+            'read'
+        ]
+    },
+    {
+        'scope': [
+            'webhooks:write',
+        ],
+        'resource': '/api/WebHooks/?',
+        'access': [
+            'read',
+            'write'
+        ]
+    }
+];
+
+export {
+    WebHookScopeAccessElements
+}

package/src/index.d.ts

@@ -0,0 +1,2 @@
+export * from './SchemaLoader';
+export * from './WebHookService';

package/src/index.js

@@ -0,0 +1,2 @@
+export * from './SchemaLoader';
+export * from './WebHookService';

package/src/listeners/OnWebHook.js

@@ -0,0 +1,37 @@
+import {WebHookService} from '../WebHookService';
+
+/**
+ * A generic web hook listener for insert or update operations to any data model
+ * @param {import('@themost/data').DataEventArgs} event
+ * @param {Function} callback
+ */
+function afterSave(event, callback) {
+    return afterEvent(event, callback);
+}
+/**
+ * @param {import('@themost/data').DataEventArgs} event
+ * @param {Function} callback
+ */
+function afterEvent(event, callback) {
+    const {context} = event.model;
+    const service = context.application.getService(WebHookService);
+    if (service) {
+        service.emit(event);
+    }
+    return callback();
+}
+
+/**
+ * A generic web hook for remove operations to any data model
+ * @param {import('@themost/data').DataEventArgs} event
+ * @param {Function} callback
+ */
+function afterRemove(event, callback) {
+
+    return afterEvent(event, callback);
+}
+
+export {
+    afterSave,
+    afterRemove
+}

package/src/listeners/OnWebHookAction.js

@@ -0,0 +1,56 @@
+import {DataObjectState, SchemaLoaderStrategy} from '@themost/data';
+import path from 'path';
+/**
+ * After save listener for OneWebHookAction
+ * @param {import('@themost/data').DataEventArgs} event
+ * @param {Function} callback
+ */
+function afterSave(event, callback) {
+    if (event.state === DataObjectState.Insert || event.state === DataObjectState.Update) {
+        // change the underlying model definition
+        const { context } = event.model;
+        const schemaLoader = context.getConfiguration().getStrategy(SchemaLoaderStrategy);
+        const { about } = event.target;
+        if (about) {
+            /**
+             * @type {import('@themost/common').DataModelProperties}
+             */
+            const schema = schemaLoader.getModelDefinition(about);
+            if (schema) {
+                // try to find of previous state listener should be included in the list of event listeners
+                schema.eventListeners = schema.eventListeners || [];
+                const index = schema.eventListeners.findIndex((item) => {
+                    return item.type === '@themost/data#previous-state-listener';
+                });
+                if (index < 0) {
+                    // insert previous state listener at the beginning of the list
+                    schema.eventListeners.unshift({
+                        type: '@themost/data/previous-state-listener'
+                    });
+                }
+                const type = path.resolve(__dirname, './OnWebHook');
+                const id = '@universis/webhooks/listeners/OnWebHook';
+                // try to find if web hook listener should be included in the list of event listeners
+                const webHookIndex = schema.eventListeners.findIndex((item) => {
+                    return item['@id'] === id;
+                });
+                if (webHookIndex < 0) {
+                    // add web hook listener at the end of the list
+                    schema.eventListeners.push({
+                        '@id': id,
+                        type
+                    });
+                }
+                const service = context.application.getService(function WebHookService() {});
+                service.logger.info(`A new web hook action with name "${event.target.name || 'unknown'}" has been registered for model "${about}"`);
+                // reset model definition
+                schemaLoader.setModelDefinition(schema);
+            }
+        }
+        return callback();
+    }
+}
+
+export {
+    afterSave
+}

package/src/listeners/package.json

@@ -0,0 +1,3 @@
+{
+  "private": true
+}