@thymian/common-cli 0.1.0

package/dist/thymian-config-schema.json

@@ -0,0 +1,116 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "type": "object",
+    "required": ["plugins"],
+    "additionalProperties": false,
+    "properties": {
+        "autoload": {
+            "type": "boolean"
+        },
+        "logLevel": {
+            "type": "string",
+            "enum": ["trace", "debug", "info", "warn", "error", "silent"]
+        },
+        "specifications": {
+            "type": "array",
+            "items": {
+                "type": "object",
+                "required": ["type", "location"],
+                "additionalProperties": false,
+                "properties": {
+                    "type": {
+                        "type": "string"
+                    },
+                    "location": {},
+                    "options": {
+                        "type": "object",
+                        "additionalProperties": true
+                    }
+                }
+            }
+        },
+        "traffic": {
+            "type": "array",
+            "items": {
+                "type": "object",
+                "required": ["type", "location"],
+                "additionalProperties": false,
+                "properties": {
+                    "type": {
+                        "type": "string"
+                    },
+                    "location": {},
+                    "options": {
+                        "type": "object",
+                        "additionalProperties": true
+                    }
+                }
+            }
+        },
+        "ruleSets": {
+            "type": "array",
+            "items": {
+                "type": "string"
+            }
+        },
+        "ruleSeverity": {
+            "type": "string",
+            "enum": ["off", "error", "warn", "hint"]
+        },
+        "targetUrl": {
+            "type": "string",
+            "description": "Override the target URL for all test requests. When set, all requests are sent to this origin instead of the servers defined in the specification."
+        },
+        "rules": {
+            "type": "object",
+            "additionalProperties": {
+                "oneOf": [
+                    {
+                        "type": "string",
+                        "enum": ["error", "warn", "hint", "off"]
+                    },
+                    {
+                        "type": "object",
+                        "additionalProperties": true,
+                        "properties": {
+                            "severity": {
+                                "type": "string",
+                                "enum": ["error", "warn", "hint", "off"]
+                            },
+                            "options": {
+                                "type": "object",
+                                "additionalProperties": true
+                            },
+                            "skipOrigins": {
+                                "type": "array",
+                                "items": {
+                                    "type": "string"
+                                }
+                            }
+                        }
+                    }
+                ]
+            }
+        },
+        "plugins": {
+            "type": "object",
+            "nullable": false,
+            "additionalProperties": {
+                "type": "object",
+                "additionalProperties": false,
+                "properties": {
+                    "path": {
+                        "type": "string"
+                    },
+                    "verbose": {
+                        "type": "boolean"
+                    },
+                    "options": {
+                        "type": "object",
+                        "additionalProperties": true
+                    }
+                }
+            }
+        }
+    }
+}

package/dist/thymian-config.d.ts

@@ -0,0 +1,19 @@
+import type { LogLevel, RulesConfiguration, RuleSeverity, SpecificationInput, TrafficInput } from '@thymian/core';
+export interface ThymianPluginConfiguration<Options extends Record<PropertyKey, unknown> = Record<PropertyKey, unknown>> {
+    path?: string;
+    verbose?: boolean;
+    autoload?: boolean;
+    options?: Options;
+}
+export interface ThymianConfig {
+    autoload?: boolean;
+    logLevel?: LogLevel;
+    specifications?: SpecificationInput[];
+    traffic?: TrafficInput[];
+    ruleSets?: string[];
+    ruleSeverity?: RuleSeverity;
+    rules?: RulesConfiguration;
+    targetUrl?: string;
+    plugins: Record<string, ThymianPluginConfiguration>;
+}
+//# sourceMappingURL=thymian-config.d.ts.map

package/dist/thymian-config.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"thymian-config.d.ts","sourceRoot":"","sources":["../src/thymian-config.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,QAAQ,EACR,kBAAkB,EAClB,YAAY,EACZ,kBAAkB,EAClB,YAAY,EACb,MAAM,eAAe,CAAC;AAEvB,MAAM,WAAW,0BAA0B,CACzC,OAAO,SAAS,MAAM,CAAC,WAAW,EAAE,OAAO,CAAC,GAAG,MAAM,CAAC,WAAW,EAAE,OAAO,CAAC;IAE3E,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED,MAAM,WAAW,aAAa;IAC5B,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,QAAQ,CAAC,EAAE,QAAQ,CAAC;IACpB,cAAc,CAAC,EAAE,kBAAkB,EAAE,CAAC;IACtC,OAAO,CAAC,EAAE,YAAY,EAAE,CAAC;IACzB,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IACpB,YAAY,CAAC,EAAE,YAAY,CAAC;IAC5B,KAAK,CAAC,EAAE,kBAAkB,CAAC;IAC3B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,0BAA0B,CAAC,CAAC;CACrD"}

package/dist/thymian-config.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=thymian-config.js.map

package/dist/thymian-config.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"thymian-config.js","sourceRoot":"","sources":["../src/thymian-config.ts"],"names":[],"mappings":""}

package/dist/validate-config.d.ts

@@ -0,0 +1,8 @@
+export type ConfigValidationResult = {
+    valid: true;
+} | {
+    valid: boolean;
+    message: string;
+};
+export declare function validateConfig(config: unknown): ConfigValidationResult;
+//# sourceMappingURL=validate-config.d.ts.map

package/dist/validate-config.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"validate-config.d.ts","sourceRoot":"","sources":["../src/validate-config.ts"],"names":[],"mappings":"AAQA,MAAM,MAAM,sBAAsB,GAC9B;IACE,KAAK,EAAE,IAAI,CAAC;CACb,GACD;IACE,KAAK,EAAE,OAAO,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC;AAEN,wBAAgB,cAAc,CAAC,MAAM,EAAE,OAAO,GAAG,sBAAsB,CAatE"}

package/dist/validate-config.js

@@ -0,0 +1,18 @@
+import { EOL } from 'node:os';
+import { ajv } from '@thymian/core';
+import thymianSchema from './thymian-config-schema.json' with { type: 'json' };
+const validationFn = ajv.compile(thymianSchema);
+export function validateConfig(config) {
+    const valid = validationFn(config);
+    if (valid) {
+        return { valid };
+    }
+    else {
+        return {
+            valid,
+            message: validationFn.errors?.map((e) => EOL + '   * ' + e.message).join('') ??
+                'Unknown error',
+        };
+    }
+}
+//# sourceMappingURL=validate-config.js.map

package/dist/validate-config.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"validate-config.js","sourceRoot":"","sources":["../src/validate-config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,SAAS,CAAC;AAE9B,OAAO,EAAE,GAAG,EAAE,MAAM,eAAe,CAAC;AAEpC,OAAO,aAAa,MAAM,8BAA8B,CAAC,OAAO,IAAI,EAAE,MAAM,EAAE,CAAC;AAE/E,MAAM,YAAY,GAAG,GAAG,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC;AAWhD,MAAM,UAAU,cAAc,CAAC,MAAe;IAC5C,MAAM,KAAK,GAAG,YAAY,CAAC,MAAM,CAAC,CAAC;IAEnC,IAAI,KAAK,EAAE,CAAC;QACV,OAAO,EAAE,KAAK,EAAE,CAAC;IACnB,CAAC;SAAM,CAAC;QACN,OAAO;YACL,KAAK;YACL,OAAO,EACL,YAAY,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,GAAG,OAAO,GAAG,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC;gBACnE,eAAe;SAClB,CAAC;IACJ,CAAC;AACH,CAAC"}

package/dist/workflow-outcome.d.ts

@@ -0,0 +1,5 @@
+import type { Command } from '@oclif/core';
+import type { WorkflowClassification, WorkflowOutcome } from '@thymian/core';
+export declare function classificationToExitCode(classification: WorkflowClassification): 0 | 1 | 2;
+export declare function handleWorkflowOutcome(command: Pick<Command, 'exit'>, outcome: WorkflowOutcome): void;
+//# sourceMappingURL=workflow-outcome.d.ts.map

package/dist/workflow-outcome.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"workflow-outcome.d.ts","sourceRoot":"","sources":["../src/workflow-outcome.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,aAAa,CAAC;AAE3C,OAAO,KAAK,EAAE,sBAAsB,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC;AAE7E,wBAAgB,wBAAwB,CACtC,cAAc,EAAE,sBAAsB,GACrC,CAAC,GAAG,CAAC,GAAG,CAAC,CASX;AAED,wBAAgB,qBAAqB,CACnC,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE,MAAM,CAAC,EAC9B,OAAO,EAAE,eAAe,GACvB,IAAI,CAUN"}

package/dist/workflow-outcome.js

@@ -0,0 +1,21 @@
+import { ux } from '@oclif/core';
+export function classificationToExitCode(classification) {
+    switch (classification) {
+        case 'clean-run':
+            return 0;
+        case 'findings':
+            return 1;
+        case 'tool-error':
+            return 2;
+    }
+}
+export function handleWorkflowOutcome(command, outcome) {
+    if (outcome.text) {
+        ux.stdout(outcome.text);
+    }
+    const exitCode = classificationToExitCode(outcome.classification);
+    if (exitCode !== 0) {
+        command.exit(exitCode);
+    }
+}
+//# sourceMappingURL=workflow-outcome.js.map

package/dist/workflow-outcome.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"workflow-outcome.js","sourceRoot":"","sources":["../src/workflow-outcome.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,EAAE,EAAE,MAAM,aAAa,CAAC;AAGjC,MAAM,UAAU,wBAAwB,CACtC,cAAsC;IAEtC,QAAQ,cAAc,EAAE,CAAC;QACvB,KAAK,WAAW;YACd,OAAO,CAAC,CAAC;QACX,KAAK,UAAU;YACb,OAAO,CAAC,CAAC;QACX,KAAK,YAAY;YACf,OAAO,CAAC,CAAC;IACb,CAAC;AACH,CAAC;AAED,MAAM,UAAU,qBAAqB,CACnC,OAA8B,EAC9B,OAAwB;IAExB,IAAI,OAAO,CAAC,IAAI,EAAE,CAAC;QACjB,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IAC1B,CAAC;IAED,MAAM,QAAQ,GAAG,wBAAwB,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC;IAElE,IAAI,QAAQ,KAAK,CAAC,EAAE,CAAC;QACnB,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IACzB,CAAC;AACH,CAAC"}

package/dist/yaml.d.ts

@@ -0,0 +1,2 @@
+export * from 'yaml';
+//# sourceMappingURL=yaml.d.ts.map

package/dist/yaml.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"yaml.d.ts","sourceRoot":"","sources":["../src/yaml.ts"],"names":[],"mappings":"AAAA,cAAc,MAAM,CAAC"}

package/dist/yaml.js

@@ -0,0 +1,2 @@
+export * from 'yaml';
+//# sourceMappingURL=yaml.js.map

package/dist/yaml.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"yaml.js","sourceRoot":"","sources":["../src/yaml.ts"],"names":[],"mappings":"AAAA,cAAc,MAAM,CAAC"}

package/package.json

@@ -0,0 +1,34 @@
+{
+  "name": "@thymian/common-cli",
+  "version": "0.1.0",
+  "license": "AGPL-3.0-only",
+  "publishConfig": {
+    "access": "public"
+  },
+  "type": "module",
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    "./package.json": "./package.json",
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "default": "./dist/index.js"
+    },
+    "./oclif": "./dist/oclif.js",
+    "./yaml": "./dist/yaml.js",
+    "./prompts": "./dist/prompts.js"
+  },
+  "files": [
+    "dist",
+    "!**/*.tsbuildinfo"
+  ],
+  "dependencies": {
+    "@inquirer/prompts": "^7.6.0",
+    "tslib": "^2.3.0",
+    "yaml": "^2.8.0",
+    "@oclif/core": "^4.3.3",
+    "@thymian/core": "0.1.0"
+  }
+}