@cyberismo/cli 0.0.1

package/dist/resource-type-parser.js

@@ -0,0 +1,197 @@
+/**
+    Cyberismo
+    Copyright © Cyberismo Ltd and contributors 2024
+
+    This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License version 3 as published by the Free Software Foundation.
+
+    This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.
+
+    You should have received a copy of the GNU Affero General Public
+    License along with this program.  If not, see <https://www.gnu.org/licenses/>.
+*/
+// Resource types that have commands affecting them.
+const Resources = [
+    'cardType',
+    'fieldType',
+    'graphModel',
+    'graphView',
+    'linkType',
+    'report',
+    'template',
+    'workflow',
+];
+// Lookup table for plural forms for command targets that have plural form commands.
+const pluralLookUpForResources = new Map([
+    ['cardType', 'cardTypes'],
+    ['fieldType', 'fieldTypes'],
+    ['graphModel', 'graphModels'],
+    ['graphView', 'graphViews'],
+    ['linkType', 'linkTypes'],
+    ['report', 'reports'],
+    ['template', 'templates'],
+    ['workflow', 'workflows'],
+]);
+// Default 'sort' puts Uppercase before lowercase.
+// Make sorting case-independent.
+// @todo: This could be in some util file.
+function alphabeticalOrder(a, b) {
+    const aLower = a.toLowerCase();
+    const bLower = b.toLowerCase();
+    if (aLower < bLower)
+        return -1;
+    if (aLower > bLower)
+        return 1;
+    return 0;
+}
+/**
+ * Class that helps parsing 'create', 'remove' and 'show' commands.
+ */
+class CreateTypes {
+    static ResourceTypes = Resources;
+    // Command specific additions; these can also be affected with 'create'.
+    static ResourceLikeTypes = [
+        'attachment',
+        'card',
+        'label',
+        'link',
+        'project',
+    ];
+    static TargetTypes = [
+        ...CreateTypes.ResourceTypes,
+        ...CreateTypes.ResourceLikeTypes,
+    ].sort(alphabeticalOrder);
+    // For create command, this is only used in cases where resource name is provided to the command.
+    // e.g. "cyberismo remove demo/workflows/controlledDocument"
+    static pluralLookupTable = new Map([...pluralLookUpForResources]);
+    // Lists all create-able resource types.
+    static all() {
+        return CreateTypes.TargetTypes;
+    }
+}
+// Helper class for show command types.
+class ShowTypes {
+    static ResourceTypes = Resources;
+    // Command specific additions; these can also be shown with 'show'.
+    static ResourceLikeTypes = [
+        'attachments',
+        'card',
+        'cards',
+        'labels',
+        'module',
+        'project',
+    ];
+    static TargetTypes = [
+        ...ShowTypes.ResourceTypes,
+        ...ShowTypes.ResourceLikeTypes,
+    ];
+    static pluralLookupTable = new Map([
+        ...pluralLookUpForResources,
+        ['module', 'modules'],
+    ]);
+    // Lists all show-able resource types.
+    static all() {
+        return [
+            ...ShowTypes.pluralLookupTable.values(),
+            ...ShowTypes.TargetTypes,
+        ].sort(alphabeticalOrder);
+    }
+}
+// Helper class for remove command types.
+// Note that remove command is never used with plural names.
+class RemoveTypes {
+    static ResourceTypes = Resources;
+    // Command specific additions; these can also be affected with 'remove'.
+    static ResourceLikeTypes = [
+        'attachment',
+        'card',
+        'label',
+        'link',
+        'module',
+    ];
+    static TargetTypes = [
+        ...RemoveTypes.ResourceLikeTypes,
+        ...RemoveTypes.ResourceTypes,
+    ].sort(alphabeticalOrder);
+    // For remove command, this is only used in cases where resource name is provided to the command.
+    // e.g. "cyberismo remove demo/workflows/controlledDocument"
+    static pluralLookupTable = new Map([...pluralLookUpForResources]);
+    // Lists all remove-able resource types.
+    static all() {
+        return RemoveTypes.TargetTypes;
+    }
+}
+// Parser that helps with certain commands that are related to resources (create, show, remove).
+export class ResourceTypeParser {
+    static parseTypes(types, value, pluralValues) {
+        // Known type.
+        if (types.includes(value)) {
+            return value;
+        }
+        // If it wasn't a known type, maybe it is a resource name
+        const parts = value.split('/');
+        if (parts && parts.length === 3) {
+            const type = parts.at(1) || '';
+            if (types.includes(type)) {
+                return value;
+            }
+            else {
+                for (const plural of pluralValues.values()) {
+                    if (type === plural) {
+                        return value;
+                    }
+                }
+            }
+        }
+        throw new Error(`Unknown type: '${value}'.\nSupported types are: '${types.join("', '")}'. Alternatively provide resource name (e.g "cyberismo show <prefix/type/identifier>").
+  `);
+    }
+    static command(value) {
+        let typeValue;
+        if (value === 'remove')
+            typeValue = RemoveTypes;
+        if (value === 'show')
+            typeValue = ShowTypes;
+        if (value === 'create')
+            typeValue = CreateTypes;
+        if (!typeValue)
+            throw new Error('Unsupported command: ' + value);
+        return typeValue;
+    }
+    static parseCommandTypes(type, category) {
+        const commandType = ResourceTypeParser.command(category);
+        return ResourceTypeParser.parseTypes(commandType.all(), type, commandType.pluralLookupTable);
+    }
+    /**
+     * Returns type targets related to 'command'.
+     * @param command command that targets need to be fetched to ('create', 'show', ...)
+     * @returns Array of type targets related to 'command'.
+     */
+    static listTargets(command) {
+        return ResourceTypeParser.command(command).all();
+    }
+    /**
+     * Parses remove command.
+     * @param type Argument 'type' from a command.
+     * @returns 'type' if it is a valid value. Throws if not.
+     */
+    static parseRemoveTypes(type) {
+        return ResourceTypeParser.parseCommandTypes(type, 'remove');
+    }
+    /**
+     * Parses create command.
+     * @param type Argument 'type' from a command.
+     * @returns 'type' if it is a valid value. Throws if not.
+     */
+    static parseCreateTypes(type) {
+        return ResourceTypeParser.parseCommandTypes(type, 'create');
+    }
+    /**
+     * Parses show command.
+     * @param type Argument 'type' from a command.
+     * @returns 'type' if it is a valid value. Throws if not.
+     */
+    static parseShowTypes(type) {
+        return ResourceTypeParser.parseCommandTypes(type, 'show');
+    }
+}
+//# sourceMappingURL=resource-type-parser.js.map

package/dist/resource-type-parser.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"resource-type-parser.js","sourceRoot":"","sources":["../src/resource-type-parser.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;EAUE;AAEF,oDAAoD;AACpD,MAAM,SAAS,GAAG;IAChB,UAAU;IACV,WAAW;IACX,YAAY;IACZ,WAAW;IACX,UAAU;IACV,QAAQ;IACR,UAAU;IACV,UAAU;CACX,CAAC;AAEF,oFAAoF;AACpF,MAAM,wBAAwB,GAAG,IAAI,GAAG,CAAC;IACvC,CAAC,UAAU,EAAE,WAAW,CAAC;IACzB,CAAC,WAAW,EAAE,YAAY,CAAC;IAC3B,CAAC,YAAY,EAAE,aAAa,CAAC;IAC7B,CAAC,WAAW,EAAE,YAAY,CAAC;IAC3B,CAAC,UAAU,EAAE,WAAW,CAAC;IACzB,CAAC,QAAQ,EAAE,SAAS,CAAC;IACrB,CAAC,UAAU,EAAE,WAAW,CAAC;IACzB,CAAC,UAAU,EAAE,WAAW,CAAC;CAC1B,CAAC,CAAC;AAEH,kDAAkD;AAClD,iCAAiC;AACjC,0CAA0C;AAC1C,SAAS,iBAAiB,CAAC,CAAS,EAAE,CAAS;IAC7C,MAAM,MAAM,GAAG,CAAC,CAAC,WAAW,EAAE,CAAC;IAC/B,MAAM,MAAM,GAAG,CAAC,CAAC,WAAW,EAAE,CAAC;IAC/B,IAAI,MAAM,GAAG,MAAM;QAAE,OAAO,CAAC,CAAC,CAAC;IAC/B,IAAI,MAAM,GAAG,MAAM;QAAE,OAAO,CAAC,CAAC;IAC9B,OAAO,CAAC,CAAC;AACX,CAAC;AAED;;GAEG;AACH,MAAe,WAAW;IAChB,MAAM,CAAC,aAAa,GAAG,SAAS,CAAC;IAEzC,wEAAwE;IAChE,MAAM,CAAC,iBAAiB,GAAG;QACjC,YAAY;QACZ,MAAM;QACN,OAAO;QACP,MAAM;QACN,SAAS;KACV,CAAC;IAEM,MAAM,CAAC,WAAW,GAAG;QAC3B,GAAG,WAAW,CAAC,aAAa;QAC5B,GAAG,WAAW,CAAC,iBAAiB;KACjC,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;IAE1B,iGAAiG;IACjG,4DAA4D;IACrD,MAAM,CAAC,iBAAiB,GAAG,IAAI,GAAG,CAAC,CAAC,GAAG,wBAAwB,CAAC,CAAC,CAAC;IAEzE,wCAAwC;IACjC,MAAM,CAAC,GAAG;QACf,OAAO,WAAW,CAAC,WAAW,CAAC;IACjC,CAAC;;AAGH,uCAAuC;AACvC,MAAe,SAAS;IACd,MAAM,CAAC,aAAa,GAAG,SAAS,CAAC;IAEzC,mEAAmE;IAC3D,MAAM,CAAC,iBAAiB,GAAG;QACjC,aAAa;QACb,MAAM;QACN,OAAO;QACP,QAAQ;QACR,QAAQ;QACR,SAAS;KACV,CAAC;IAEM,MAAM,CAAC,WAAW,GAAG;QAC3B,GAAG,SAAS,CAAC,aAAa;QAC1B,GAAG,SAAS,CAAC,iBAAiB;KAC/B,CAAC;IAEK,MAAM,CAAC,iBAAiB,GAAG,IAAI,GAAG,CAAC;QACxC,GAAG,wBAAwB;QAC3B,CAAC,QAAQ,EAAE,SAAS,CAAC;KACtB,CAAC,CAAC;IAEH,sCAAsC;IAC/B,MAAM,CAAC,GAAG;QACf,OAAO;YACL,GAAG,SAAS,CAAC,iBAAiB,CAAC,MAAM,EAAE;YACvC,GAAG,SAAS,CAAC,WAAW;SACzB,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;IAC5B,CAAC;;AAGH,yCAAyC;AACzC,4DAA4D;AAC5D,MAAe,WAAW;IAChB,MAAM,CAAC,aAAa,GAAG,SAAS,CAAC;IAEzC,wEAAwE;IAChE,MAAM,CAAC,iBAAiB,GAAG;QACjC,YAAY;QACZ,MAAM;QACN,OAAO;QACP,MAAM;QACN,QAAQ;KACT,CAAC;IAEM,MAAM,CAAC,WAAW,GAAG;QAC3B,GAAG,WAAW,CAAC,iBAAiB;QAChC,GAAG,WAAW,CAAC,aAAa;KAC7B,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;IAE1B,iGAAiG;IACjG,4DAA4D;IACrD,MAAM,CAAC,iBAAiB,GAAG,IAAI,GAAG,CAAC,CAAC,GAAG,wBAAwB,CAAC,CAAC,CAAC;IAEzE,wCAAwC;IACjC,MAAM,CAAC,GAAG;QACf,OAAO,WAAW,CAAC,WAAW,CAAC;IACjC,CAAC;;AAGH,gGAAgG;AAChG,MAAM,OAAO,kBAAkB;IACrB,MAAM,CAAC,UAAU,CACvB,KAAe,EACf,KAAa,EACb,YAAiC;QAEjC,cAAc;QACd,IAAI,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;YAC1B,OAAO,KAAK,CAAC;QACf,CAAC;QAED,yDAAyD;QACzD,MAAM,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAC/B,IAAI,KAAK,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAChC,MAAM,IAAI,GAAG,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;YAC/B,IAAI,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;gBACzB,OAAO,KAAK,CAAC;YACf,CAAC;iBAAM,CAAC;gBACN,KAAK,MAAM,MAAM,IAAI,YAAY,CAAC,MAAM,EAAE,EAAE,CAAC;oBAC3C,IAAI,IAAI,KAAK,MAAM,EAAE,CAAC;wBACpB,OAAO,KAAK,CAAC;oBACf,CAAC;gBACH,CAAC;YACH,CAAC;QACH,CAAC;QACD,MAAM,IAAI,KAAK,CAAC,kBAAkB,KAAK,6BAA6B,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC;GACvF,CAAC,CAAC;IACH,CAAC;IAEO,MAAM,CAAC,OAAO,CAAC,KAAa;QAClC,IAAI,SAAS,CAAC;QACd,IAAI,KAAK,KAAK,QAAQ;YAAE,SAAS,GAAG,WAAW,CAAC;QAChD,IAAI,KAAK,KAAK,MAAM;YAAE,SAAS,GAAG,SAAS,CAAC;QAC5C,IAAI,KAAK,KAAK,QAAQ;YAAE,SAAS,GAAG,WAAW,CAAC;QAChD,IAAI,CAAC,SAAS;YAAE,MAAM,IAAI,KAAK,CAAC,uBAAuB,GAAG,KAAK,CAAC,CAAC;QACjE,OAAO,SAAS,CAAC;IACnB,CAAC;IAEO,MAAM,CAAC,iBAAiB,CAAC,IAAY,EAAE,QAAgB;QAC7D,MAAM,WAAW,GAAG,kBAAkB,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;QACzD,OAAO,kBAAkB,CAAC,UAAU,CAClC,WAAW,CAAC,GAAG,EAAE,EACjB,IAAI,EACJ,WAAW,CAAC,iBAAiB,CAC9B,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,WAAW,CAAC,OAAe;QACvC,OAAO,kBAAkB,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,CAAC;IACnD,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,gBAAgB,CAAC,IAAY;QACzC,OAAO,kBAAkB,CAAC,iBAAiB,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;IAC9D,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,gBAAgB,CAAC,IAAY;QACzC,OAAO,kBAAkB,CAAC,iBAAiB,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;IAC9D,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,cAAc,CAAC,IAAY;QACvC,OAAO,kBAAkB,CAAC,iBAAiB,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;IAC5D,CAAC;CACF"}

package/package.json

@@ -0,0 +1,37 @@
+{
+  "name": "@cyberismo/cli",
+  "version": "0.0.1",
+  "description": "CLI tool to handle tasks.",
+  "main": "dist/index.js",
+  "bin": {
+    "cyberismo": "bin/run"
+  },
+  "files": [
+    "bin",
+    "dist",
+    "src"
+  ],
+  "keywords": [],
+  "author": "",
+  "license": "AGPL-3.0",
+  "dependencies": {
+    "@inquirer/confirm": "^5.1.9",
+    "commander": "^13.1.0"
+  },
+  "devDependencies": {
+    "@cyberismo/backend": "0.0.2",
+    "@cyberismo/data-handler": "0.0.2"
+  },
+  "types": "dist/index.d.ts",
+  "type": "module",
+  "exports": {
+    ".": "./dist/index.js"
+  },
+  "scripts": {
+    "preinstall": "npx only-allow pnpm",
+    "build": "tsc -p tsconfig.build.json",
+    "clean": "rm -rf node_modules",
+    "lint": "eslint .",
+    "test": "mocha --require mocha-suppress-logs --disable-warning=ExperimentalWarning --forbid-only \"./test/**/*.test.ts\""
+  }
+}