@5minds/node-red-contrib-processcube 1.5.5-feature-22f94f-m3eulbpf → 1.5.5

package/doc_generator/_process_instances_query.md

@@ -1,121 +0,0 @@
-### Query fields
-
-**Summary**: 
-
-**Description**: Gets all ProcessInstances that match the given query.
-
-#### Parameters:
-- Name: `offset` Required: `false`
-  - Type: number
-  - Description: The index of the first ProcessInstance to include in the result set.
-- Name: `limit` Required: `false`
-  - Type: number
-  - Description: The maximum number of ProcessInstances to return.
-- Name: `correlationId` Required: `false`
-  - Type: Array<string> | string | SearchQuery
-    - string: myCorrelationId
-    - Array<string>: myCorrelationId1,myCorrelationId2
-    - object: 
-  - Description: Filter by the CorrelationId of the ProcessInstances.
-- Name: `processInstanceId` Required: ``
-  - Type: Array<string> | string | SearchQuery
-    - string: myProcessInstance_12345678
-    - Array<string>: myProcessInstance_12345678,myProcessInstance_87654321
-    - object: 
-  - Description: Filter by the ID of the ProcessInstances.
-- Name: `processDefinitionId` Required: ``
-  - Type: Array<string> | string | SearchQuery
-    - string: myProcess_12345678
-    - Array<string>: myProcess_12345678,myProcess_87654321
-    - object: 
-  - Description: Filter by the ID of the ProcessDefinition that the ProcessInstances belong to.
-- Name: `processModelId` Required: ``
-  - Type: Array<string> | string | SearchQuery
-    - string: myProcessModel_12345678
-    - Array<string>: myProcessModel_12345678,myProcessModel_87654321
-    - object: 
-  - Description: Filter by the ID of the ProcessModel that the ProcessInstances belong to.
-- Name: `processModelName` Required: ``
-  - Type: Array<string> | string | SearchQuery
-    - string: My Process Model
-    - Array<string>: My Process Model,My Other Process Model
-    - object: 
-  - Description: Filter by the name of the ProcessModel that the ProcessInstances belong to.
-- Name: `processModelHash` Required: ``
-  - Type: Array<string> | string | SearchQuery
-    - string: 12345678
-    - Array<string>: 12345678,87654321
-    - object: 
-  - Description: Filter by the hash of the ProcessModel that the ProcessInstances belong to.
-- Name: `ownerId` Required: ``
-  - Type: Array<string> | string | SearchQuery
-    - string: 12345678
-    - Array<string>: 12345678,87654321
-    - object: 
-  - Description: Filter by the ID of the User that owns the ProcessInstances.
-- Name: `state` Required: ``
-  - Type: Array<string> | string | SearchQuery
-    - string: running
-    - Array<string>: running,finished
-    - object: 
-  - Description: Filter by the state of the ProcessInstances.
-- Name: `parentProcessInstanceId` Required: ``
-  - Type: Array<string> | string | SearchQuery
-    - string: myParentProcessInstance_12345678
-    - Array<string>: myParentProcessInstance_12345678,myParentProcessInstance_87654321
-    - object: 
-  - Description: Filter by the ID of the parent ProcessInstance.
-- Name: `embeddedProcessModelId` Required: ``
-  - Type: Array<string> | string | SearchQuery
-    - string: myModel1
-    - Array<string>: myModel1,myModel2
-    - object: 
-  - Description: Filter by the ID of the embedded process model.
-- Name: `terminatedByUserId` Required: ``
-  - Type: Array<string> | string | SearchQuery
-    - string: 12345678
-    - Array<string>: 12345678,87654321
-    - object: 
-  - Description: Filter by the ID of the User that terminated the ProcessInstances.
-- Name: `createdBefore` Required: ``
-  - Type: string
-  - Description: The maximum created date of the ProcessInstances to include in the results.
-- Name: `createdAt` Required: ``
-  - Type: Array<string> | string
-    - string: 2021-01-01T00:00:00.000Z
-    - array: 2021-01-01T00:00:00.000Z,2021-01-02T00:00:00.000Z
-  - Description: The minimum created date of the ProcessInstances to include in the results.
-- Name: `createdAfter` Required: ``
-  - Type: string
-  - Description: The minimum created date of the ProcessInstances to include in the results.
-- Name: `updatedBefore` Required: ``
-  - Type: string
-  - Description: The maximum updated date of the ProcessInstances to include in the results.
-- Name: `updatedAt` Required: ``
-  - Type: Array<string> | string
-    - string: 2021-01-01T00:00:00.000Z
-    - array: 2021-01-01T00:00:00.000Z,2021-01-02T00:00:00.000Z
-  - Description: The exact updated date of the ProcessInstances to include in the results.
-- Name: `updatedAfter` Required: ``
-  - Type: string
-  - Description: The minimum updated date of the ProcessInstances to include in the results.
-- Name: `finishedBefore` Required: ``
-  - Type: string
-  - Description: The maximum finished date of the ProcessInstances to include in the results.
-- Name: `finishedAt` Required: ``
-  - Type: Array<string> | string
-    - string: 2021-01-01T00:00:00.000Z
-    - array: 2021-01-01T00:00:00.000Z,2021-01-02T00:00:00.000Z
-  - Description: The exact finished date of the ProcessInstances to include in the results.
-- Name: `finishedAfter` Required: ``
-  - Type: string
-  - Description: The minimum finished date of the ProcessInstances to include in the results.
-- Name: `triggeredByFlowNodeInstance` Required: ``
-  - Type: Array<string> | string | SearchQuery
-    - string: myFlowNodeInstance_12345678
-    - array: myFlowNodeInstance_12345678,myFlowNodeInstance_87654321
-    - object: 
-  - Description: Filter by the ID of the FlowNodeInstance that triggered the ProcessInstance.
-
-#### Responses:
-- **200**: 

package/doc_generator/generator.js

@@ -1,41 +0,0 @@
-const Mustache = require('mustache');
-const fs = require('fs');
-
-const swaggerFilename = '../../ProcessCube.Engine/docs/swagger/swagger.json';  // Dateiname der Swagger-Datei
-
-const swaggerJson = JSON.parse(fs.readFileSync(swaggerFilename, 'utf-8'));
-
-//console.log(Object.keys(swaggerJson.paths));
-//return
-
-const apiPath = '/process_instances/query';  // Die API-Route, die du dokumentieren möchtest
-const routeData = swaggerJson.paths[apiPath];
-
-if (routeData) {
-    console.log(`Details for ${apiPath}:`, routeData);
-} else {
-    console.error(`Route ${apiPath} not found in Swagger documentation.`);
-}
-
-// API-Route-Information vorbereiten
-const apiRouteData = {
-    path: apiPath,
-    method: Object.keys(routeData)[0],  // z.B. GET, POST, etc.
-    summary: routeData[Object.keys(routeData)[0]].summary,
-    description: routeData[Object.keys(routeData)[0]].description,
-    parameters: routeData[Object.keys(routeData)[0]].parameters || [],
-    responses: Object.entries(routeData[Object.keys(routeData)[0]].responses).map(([status, response]) => ({
-        status,
-        description: response.description
-    }))
-};
-
-// Mustache-Template einlesen
-const template = fs.readFileSync('query_template.mustache', 'utf-8');
-
-// Mustache-Rendering
-const output = Mustache.render(template, apiRouteData);
-
-// Ausgabe in eine Datei schreiben oder anzeigen
-console.log(output);
-fs.writeFileSync('output.md', output);

package/doc_generator/generator_with_swagger.js

@@ -1,89 +0,0 @@
-const Mustache = require('mustache');
-const fs = require('fs');
-
-const SwaggerParser = require('swagger-parser');
-
-//const swaggerFilename = '../../ProcessCube.Engine/docs/swagger/swagger.json';  // Dateiname der Swagger-Datei
-//const swaggerFilename = 'swagger.json';  // Dateiname der Swagger-Datei
-
-
-SwaggerParser.dereference("http://localhost:56100/atlas_engine/api/v1/swagger")
-//SwaggerParser.dereference(swaggerFilename)
-.then(swaggerJson => {
-    console.log('Dereferenced API:', swaggerJson);
-
-    const apiPaths = [{
-        "ProcessInstance Query": {
-            "path": "/process_instances/query",
-            "method": "get"
-        },
-        "UserTasks Input": {
-            "path": "/process_instances/query",
-            "method": "get"
-        },
-        "Wait for UserTask": {
-            "path": "/process_instances/query",
-            "method": "get"
-        },
-        "UserTask Event Listener": {
-            "path": "/process_instances/query",
-            "method": "get"
-        }
-    }];
-
-    apiPaths.forEach(apiEntry => {
-        console.log('API Entry:', apiEntry);
-        console.log('API Entry Keys:', Object.keys(apiEntry));
-
-        Object.keys(apiEntry).forEach(apiName => {
-            console.log('API Name:', apiName);
-            console.log('API Data:', apiEntry[apiName]);
-
-            let apiPath = apiEntry[apiName].path;  // Die API-Route, die du dokumentieren möchtest
-
-            //let apiPath = '/process_instances/query';  // Die API-Route, die du dokumentieren möchtest
-            const routeData = swaggerJson.paths[apiPath];
-            
-            if (routeData) {
-                console.log(`Details for ${apiPath}:`, routeData);
-            } else {
-                console.error(`Route ${apiPath} not found in Swagger documentation.`);
-            }
-            
-            let description = routeData[Object.keys(routeData)[0]].description;
-
-            description = `Filter result for '${apiName}'`;
-
-            // API-Route-Information vorbereiten
-            const apiRouteData = {
-                path: apiPath,
-                method: Object.keys(routeData)[0],  // z.B. GET, POST, etc.
-                summary: routeData[Object.keys(routeData)[0]].summary,
-                description: description,
-                parameters: routeData[Object.keys(routeData)[0]].parameters || [],
-                responses: Object.entries(routeData[Object.keys(routeData)[0]].responses).map(([status, response]) => ({
-                    status,
-                    description: response.description
-                }))
-            };
-            
-            // Mustache-Template einlesen
-            const template = fs.readFileSync('query_template.mustache', 'utf-8');
-            
-            // Mustache-Rendering
-            const output = Mustache.render(template, apiRouteData);
-            
-            // Ausgabe in eine Datei schreiben oder anzeigen
-            //console.log(output);
-        
-            const outputFilename = apiName.replace(/\/ /g, '_') + '.md';
-            console.log(`Writing output to ${outputFilename}`);
-        
-            fs.writeFileSync(`outputs/${outputFilename}`, output);
-        });
-    });
-    
-  })
-  .catch(err => {
-    console.error('Dereferencing failed:', err);
-  });

package/doc_generator/package-lock.json

@@ -1,176 +0,0 @@
-{
-  "name": "doc_generator",
-  "version": "1.0.0",
-  "lockfileVersion": 3,
-  "requires": true,
-  "packages": {
-    "": {
-      "name": "doc_generator",
-      "version": "1.0.0",
-      "license": "MIT",
-      "dependencies": {
-        "mustache": "^4.2.0",
-        "swagger-parser": "^10.0.3"
-      }
-    },
-    "node_modules/@apidevtools/json-schema-ref-parser": {
-      "version": "9.1.2",
-      "resolved": "https://registry.npmjs.org/@apidevtools/json-schema-ref-parser/-/json-schema-ref-parser-9.1.2.tgz",
-      "integrity": "sha512-r1w81DpR+KyRWd3f+rk6TNqMgedmAxZP5v5KWlXQWlgMUUtyEJch0DKEci1SorPMiSeM8XPl7MZ3miJ60JIpQg==",
-      "license": "MIT",
-      "dependencies": {
-        "@jsdevtools/ono": "^7.1.3",
-        "@types/json-schema": "^7.0.6",
-        "call-me-maybe": "^1.0.1",
-        "js-yaml": "^4.1.0"
-      }
-    },
-    "node_modules/@apidevtools/openapi-schemas": {
-      "version": "2.1.0",
-      "resolved": "https://registry.npmjs.org/@apidevtools/openapi-schemas/-/openapi-schemas-2.1.0.tgz",
-      "integrity": "sha512-Zc1AlqrJlX3SlpupFGpiLi2EbteyP7fXmUOGup6/DnkRgjP9bgMM/ag+n91rsv0U1Gpz0H3VILA/o3bW7Ua6BQ==",
-      "license": "MIT",
-      "engines": {
-        "node": ">=10"
-      }
-    },
-    "node_modules/@apidevtools/swagger-methods": {
-      "version": "3.0.2",
-      "resolved": "https://registry.npmjs.org/@apidevtools/swagger-methods/-/swagger-methods-3.0.2.tgz",
-      "integrity": "sha512-QAkD5kK2b1WfjDS/UQn/qQkbwF31uqRjPTrsCs5ZG9BQGAkjwvqGFjjPqAuzac/IYzpPtRzjCP1WrTuAIjMrXg==",
-      "license": "MIT"
-    },
-    "node_modules/@apidevtools/swagger-parser": {
-      "version": "10.0.3",
-      "resolved": "https://registry.npmjs.org/@apidevtools/swagger-parser/-/swagger-parser-10.0.3.tgz",
-      "integrity": "sha512-sNiLY51vZOmSPFZA5TF35KZ2HbgYklQnTSDnkghamzLb3EkNtcQnrBQEj5AOCxHpTtXpqMCRM1CrmV2rG6nw4g==",
-      "license": "MIT",
-      "dependencies": {
-        "@apidevtools/json-schema-ref-parser": "^9.0.6",
-        "@apidevtools/openapi-schemas": "^2.0.4",
-        "@apidevtools/swagger-methods": "^3.0.2",
-        "@jsdevtools/ono": "^7.1.3",
-        "call-me-maybe": "^1.0.1",
-        "z-schema": "^5.0.1"
-      },
-      "peerDependencies": {
-        "openapi-types": ">=7"
-      }
-    },
-    "node_modules/@jsdevtools/ono": {
-      "version": "7.1.3",
-      "resolved": "https://registry.npmjs.org/@jsdevtools/ono/-/ono-7.1.3.tgz",
-      "integrity": "sha512-4JQNk+3mVzK3xh2rqd6RB4J46qUR19azEHBneZyTZM+c456qOrbbM/5xcR8huNCCcbVt7+UmizG6GuUvPvKUYg==",
-      "license": "MIT"
-    },
-    "node_modules/@types/json-schema": {
-      "version": "7.0.15",
-      "resolved": "https://registry.npmjs.org/@types/json-schema/-/json-schema-7.0.15.tgz",
-      "integrity": "sha512-5+fP8P8MFNC+AyZCDxrB2pkZFPGzqQWUzpSeuuVLvm8VMcorNYavBqoFcxK8bQz4Qsbn4oUEEem4wDLfcysGHA==",
-      "license": "MIT"
-    },
-    "node_modules/argparse": {
-      "version": "2.0.1",
-      "resolved": "https://registry.npmjs.org/argparse/-/argparse-2.0.1.tgz",
-      "integrity": "sha512-8+9WqebbFzpX9OR+Wa6O29asIogeRMzcGtAINdpMHHyAg10f05aSFVBbcEqGf/PXw1EjAZ+q2/bEBg3DvurK3Q==",
-      "license": "Python-2.0"
-    },
-    "node_modules/call-me-maybe": {
-      "version": "1.0.2",
-      "resolved": "https://registry.npmjs.org/call-me-maybe/-/call-me-maybe-1.0.2.tgz",
-      "integrity": "sha512-HpX65o1Hnr9HH25ojC1YGs7HCQLq0GCOibSaWER0eNpgJ/Z1MZv2mTc7+xh6WOPxbRVcmgbv4hGU+uSQ/2xFZQ==",
-      "license": "MIT"
-    },
-    "node_modules/commander": {
-      "version": "9.5.0",
-      "resolved": "https://registry.npmjs.org/commander/-/commander-9.5.0.tgz",
-      "integrity": "sha512-KRs7WVDKg86PWiuAqhDrAQnTXZKraVcCc6vFdL14qrZ/DcWwuRo7VoiYXalXO7S5GKpqYiVEwCbgFDfxNHKJBQ==",
-      "license": "MIT",
-      "optional": true,
-      "engines": {
-        "node": "^12.20.0 || >=14"
-      }
-    },
-    "node_modules/js-yaml": {
-      "version": "4.1.0",
-      "resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-4.1.0.tgz",
-      "integrity": "sha512-wpxZs9NoxZaJESJGIZTyDEaYpl0FKSA+FB9aJiyemKhMwkxQg63h4T1KJgUGHpTqPDNRcmmYLugrRjJlBtWvRA==",
-      "license": "MIT",
-      "dependencies": {
-        "argparse": "^2.0.1"
-      },
-      "bin": {
-        "js-yaml": "bin/js-yaml.js"
-      }
-    },
-    "node_modules/lodash.get": {
-      "version": "4.4.2",
-      "resolved": "https://registry.npmjs.org/lodash.get/-/lodash.get-4.4.2.tgz",
-      "integrity": "sha512-z+Uw/vLuy6gQe8cfaFWD7p0wVv8fJl3mbzXh33RS+0oW2wvUqiRXiQ69gLWSLpgB5/6sU+r6BlQR0MBILadqTQ==",
-      "license": "MIT"
-    },
-    "node_modules/lodash.isequal": {
-      "version": "4.5.0",
-      "resolved": "https://registry.npmjs.org/lodash.isequal/-/lodash.isequal-4.5.0.tgz",
-      "integrity": "sha512-pDo3lu8Jhfjqls6GkMgpahsF9kCyayhgykjyLMNFTKWrpVdAQtYyB4muAMWozBB4ig/dtWAmsMxLEI8wuz+DYQ==",
-      "license": "MIT"
-    },
-    "node_modules/mustache": {
-      "version": "4.2.0",
-      "resolved": "https://registry.npmjs.org/mustache/-/mustache-4.2.0.tgz",
-      "integrity": "sha512-71ippSywq5Yb7/tVYyGbkBggbU8H3u5Rz56fH60jGFgr8uHwxs+aSKeqmluIVzM0m0kB7xQjKS6qPfd0b2ZoqQ==",
-      "license": "MIT",
-      "bin": {
-        "mustache": "bin/mustache"
-      }
-    },
-    "node_modules/openapi-types": {
-      "version": "12.1.3",
-      "resolved": "https://registry.npmjs.org/openapi-types/-/openapi-types-12.1.3.tgz",
-      "integrity": "sha512-N4YtSYJqghVu4iek2ZUvcN/0aqH1kRDuNqzcycDxhOUpg7GdvLa2F3DgS6yBNhInhv2r/6I0Flkn7CqL8+nIcw==",
-      "license": "MIT",
-      "peer": true
-    },
-    "node_modules/swagger-parser": {
-      "version": "10.0.3",
-      "resolved": "https://registry.npmjs.org/swagger-parser/-/swagger-parser-10.0.3.tgz",
-      "integrity": "sha512-nF7oMeL4KypldrQhac8RyHerJeGPD1p2xDh900GPvc+Nk7nWP6jX2FcC7WmkinMoAmoO774+AFXcWsW8gMWEIg==",
-      "license": "MIT",
-      "dependencies": {
-        "@apidevtools/swagger-parser": "10.0.3"
-      },
-      "engines": {
-        "node": ">=10"
-      }
-    },
-    "node_modules/validator": {
-      "version": "13.12.0",
-      "resolved": "https://registry.npmjs.org/validator/-/validator-13.12.0.tgz",
-      "integrity": "sha512-c1Q0mCiPlgdTVVVIJIrBuxNicYE+t/7oKeI9MWLj3fh/uq2Pxh/3eeWbVZ4OcGW1TUf53At0njHw5SMdA3tmMg==",
-      "license": "MIT",
-      "engines": {
-        "node": ">= 0.10"
-      }
-    },
-    "node_modules/z-schema": {
-      "version": "5.0.5",
-      "resolved": "https://registry.npmjs.org/z-schema/-/z-schema-5.0.5.tgz",
-      "integrity": "sha512-D7eujBWkLa3p2sIpJA0d1pr7es+a7m0vFAnZLlCEKq/Ij2k0MLi9Br2UPxoxdYystm5K1yeBGzub0FlYUEWj2Q==",
-      "license": "MIT",
-      "dependencies": {
-        "lodash.get": "^4.4.2",
-        "lodash.isequal": "^4.5.0",
-        "validator": "^13.7.0"
-      },
-      "bin": {
-        "z-schema": "bin/z-schema"
-      },
-      "engines": {
-        "node": ">=8.0.0"
-      },
-      "optionalDependencies": {
-        "commander": "^9.4.1"
-      }
-    }
-  }
-}

package/doc_generator/package.json

@@ -1,15 +0,0 @@
-{
-  "name": "doc_generator",
-  "version": "1.0.0",
-  "main": "generator.js",
-  "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
-  },
-  "author": "",
-  "license": "MIT",
-  "description": "",
-  "dependencies": {
-    "mustache": "^4.2.0",
-    "swagger-parser": "^10.0.3"
-  }
-}

package/doc_generator/query_template.mustache

@@ -1,20 +0,0 @@
-### Query fields
-
-**Summary**: {{summary}}
-
-**Description**: {{description}}
-
-#### Parameters:
-{{#parameters}}
-- Name: `{{name}}` Required: `{{required}}`
-  - Type: {{schema.type}}
-    {{#schema.oneOf}}
-    - {{type}}: {{example}}
-    {{/schema.oneOf}}
-  - Description: {{description}}
-{{/parameters}}
-
-#### Responses:
-{{#responses}}
-- **{{status}}**: {{description}}
-{{/responses}}