@veridid/workflow-parser 0.3.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 VeriDID
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,36 @@
+# workflow-parser
+
+Workflow Parser is a TypeScript Node.js module for parsing and managing workflow definitions in a PostgreSQL database. It retrieves workflows and instances, parses data, and handles state transitions. Ideal for managing complex workflows and integrating action-menu features.
+
+## Key Features
+
+- **Database Integration:** Connects to a PostgreSQL database to store and manage workflow definitions and instances.
+- **Workflow Management:** Supports defining workflows with states, transitions, actions, and display data.
+- **State Parsing:** Parses workflows to handle state transitions based on predefined conditions.
+- **Modular Design:** Can be easily integrated into different applications, including NestJS projects.
+
+## development
+
+```sh
+npm run build
+```
+
+and
+
+Must be logged into npm
+
+```sh
+npm publish
+```
+
+## Installation
+
+```sh
+npm install @@nas-veridid/workflow-parser
+```
+
+or
+
+```sh
+yarn add @@nas-veridid/workflow-parser
+```

package/dist/schema.sql

@@ -0,0 +1,16 @@
+CREATE TABLE workflows (
+  "workflowID" VARCHAR(255) PRIMARY KEY,
+  name VARCHAR(255) NOT NULL,
+  "formatVersion" VARCHAR(50) NOT NULL,
+  "initialState" VARCHAR(255) NOT NULL,
+  render JSONB NOT NULL,
+  states JSONB NOT NULL
+);
+
+CREATE TABLE instances (
+  "instanceID" UUID PRIMARY KEY DEFAULT gen_random_uuid(),
+  "workflowID" VARCHAR(255) REFERENCES workflows("workflowID"),
+  "connectionID" VARCHAR(255),
+  "currentState" VARCHAR(255),
+  "stateData" JSONB
+);

package/package.json

@@ -0,0 +1,42 @@
+{
+  "name": "@veridid/workflow-parser",
+  "version": "0.3.0",
+  "description": "Workflow Parser is a TypeScript Node.js module for parsing and managing workflow definitions in a PostgreSQL database.",
+  "main": "dist/index.js",
+  "scripts": {
+    "build": "mkdir -p dist && cp src/schema.sql dist/",
+    "start": "node dist/index.js",
+    "prepublishOnly": "npm run build",
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/VeriDID/workflow-parser.git"
+  },
+  "keywords": [
+    "workflow",
+    "parser",
+    "action-menu"
+  ],
+  "author": "Nas Til",
+  "license": "Apache-2.0",
+  "bugs": {
+    "url": "https://github.com/VeriDID/workflow-parser/issues"
+  },
+  "homepage": "https://github.com/VeriDID/workflow-parser#readme",
+  "dependencies": {
+    "dotenv": "^16.4.5",
+    "pg": "^8.12.0",
+    "uuid": "^10.0.0"
+  },
+  "devDependencies": {
+    "@types/dotenv": "^8.2.0",
+    "@types/node": "^20.14.2",
+    "@types/pg": "^8.11.6",
+    "@types/uuid": "^9.0.8",
+    "typescript": "^5.4.5"
+  },
+  "files": [
+    "dist"
+  ]
+}