@herodevs/cli 1.0.0-beta.2 → 1.2.0-beta.1

package/README.md

@@ -16,7 +16,7 @@ $ npm install -g @herodevs/cli
 $ hd COMMAND
 running command...
 $ hd (--version)
-@herodevs/cli/1.0.0-beta.2 linux-x64 node-v22.14.0
+@herodevs/cli/1.2.0-beta.1 linux-x64 node-v22.14.0
 $ hd --help [COMMAND]
 USAGE
   $ hd COMMAND
@@ -26,16 +26,6 @@ USAGE
 ## Commands
 <!-- commands -->
 * [`hd help [COMMAND]`](#hd-help-command)
-* [`hd plugins`](#hd-plugins)
-* [`hd plugins add PLUGIN`](#hd-plugins-add-plugin)
-* [`hd plugins:inspect PLUGIN...`](#hd-pluginsinspect-plugin)
-* [`hd plugins install PLUGIN`](#hd-plugins-install-plugin)
-* [`hd plugins link PATH`](#hd-plugins-link-path)
-* [`hd plugins remove [PLUGIN]`](#hd-plugins-remove-plugin)
-* [`hd plugins reset`](#hd-plugins-reset)
-* [`hd plugins uninstall [PLUGIN]`](#hd-plugins-uninstall-plugin)
-* [`hd plugins unlink [PLUGIN]`](#hd-plugins-unlink-plugin)
-* [`hd plugins update`](#hd-plugins-update)
 * [`hd report committers`](#hd-report-committers)
 * [`hd report purls`](#hd-report-purls)
 * [`hd scan eol`](#hd-scan-eol)
@@ -61,309 +51,18 @@ DESCRIPTION
 
 _See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.2.27/src/commands/help.ts)_
 
-## `hd plugins`
-
-List installed plugins.
-
-```
-USAGE
-  $ hd plugins [--json] [--core]
-
-FLAGS
-  --core  Show core plugins.
-
-GLOBAL FLAGS
-  --json  Format output as json.
-
-DESCRIPTION
-  List installed plugins.
-
-EXAMPLES
-  $ hd plugins
-```
-
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.36/src/commands/plugins/index.ts)_
-
-## `hd plugins add PLUGIN`
-
-Installs a plugin into hd.
-
-```
-USAGE
-  $ hd plugins add PLUGIN... [--json] [-f] [-h] [-s | -v]
-
-ARGUMENTS
-  PLUGIN...  Plugin to install.
-
-FLAGS
-  -f, --force    Force npm to fetch remote resources even if a local copy exists on disk.
-  -h, --help     Show CLI help.
-  -s, --silent   Silences npm output.
-  -v, --verbose  Show verbose npm output.
-
-GLOBAL FLAGS
-  --json  Format output as json.
-
-DESCRIPTION
-  Installs a plugin into hd.
-
-  Uses npm to install plugins.
-
-  Installation of a user-installed plugin will override a core plugin.
-
-  Use the HD_NPM_LOG_LEVEL environment variable to set the npm loglevel.
-  Use the HD_NPM_REGISTRY environment variable to set the npm registry.
-
-ALIASES
-  $ hd plugins add
-
-EXAMPLES
-  Install a plugin from npm registry.
-
-    $ hd plugins add myplugin
-
-  Install a plugin from a github url.
-
-    $ hd plugins add https://github.com/someuser/someplugin
-
-  Install a plugin from a github slug.
-
-    $ hd plugins add someuser/someplugin
-```
-
-## `hd plugins:inspect PLUGIN...`
-
-Displays installation properties of a plugin.
-
-```
-USAGE
-  $ hd plugins inspect PLUGIN...
-
-ARGUMENTS
-  PLUGIN...  [default: .] Plugin to inspect.
-
-FLAGS
-  -h, --help     Show CLI help.
-  -v, --verbose
-
-GLOBAL FLAGS
-  --json  Format output as json.
-
-DESCRIPTION
-  Displays installation properties of a plugin.
-
-EXAMPLES
-  $ hd plugins inspect myplugin
-```
-
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.36/src/commands/plugins/inspect.ts)_
-
-## `hd plugins install PLUGIN`
-
-Installs a plugin into hd.
-
-```
-USAGE
-  $ hd plugins install PLUGIN... [--json] [-f] [-h] [-s | -v]
-
-ARGUMENTS
-  PLUGIN...  Plugin to install.
-
-FLAGS
-  -f, --force    Force npm to fetch remote resources even if a local copy exists on disk.
-  -h, --help     Show CLI help.
-  -s, --silent   Silences npm output.
-  -v, --verbose  Show verbose npm output.
-
-GLOBAL FLAGS
-  --json  Format output as json.
-
-DESCRIPTION
-  Installs a plugin into hd.
-
-  Uses npm to install plugins.
-
-  Installation of a user-installed plugin will override a core plugin.
-
-  Use the HD_NPM_LOG_LEVEL environment variable to set the npm loglevel.
-  Use the HD_NPM_REGISTRY environment variable to set the npm registry.
-
-ALIASES
-  $ hd plugins add
-
-EXAMPLES
-  Install a plugin from npm registry.
-
-    $ hd plugins install myplugin
-
-  Install a plugin from a github url.
-
-    $ hd plugins install https://github.com/someuser/someplugin
-
-  Install a plugin from a github slug.
-
-    $ hd plugins install someuser/someplugin
-```
-
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.36/src/commands/plugins/install.ts)_
-
-## `hd plugins link PATH`
-
-Links a plugin into the CLI for development.
-
-```
-USAGE
-  $ hd plugins link PATH [-h] [--install] [-v]
-
-ARGUMENTS
-  PATH  [default: .] path to plugin
-
-FLAGS
-  -h, --help          Show CLI help.
-  -v, --verbose
-      --[no-]install  Install dependencies after linking the plugin.
-
-DESCRIPTION
-  Links a plugin into the CLI for development.
-
-  Installation of a linked plugin will override a user-installed or core plugin.
-
-  e.g. If you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello'
-  command will override the user-installed or core plugin implementation. This is useful for development work.
-
-
-EXAMPLES
-  $ hd plugins link myplugin
-```
-
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.36/src/commands/plugins/link.ts)_
-
-## `hd plugins remove [PLUGIN]`
-
-Removes a plugin from the CLI.
-
-```
-USAGE
-  $ hd plugins remove [PLUGIN...] [-h] [-v]
-
-ARGUMENTS
-  PLUGIN...  plugin to uninstall
-
-FLAGS
-  -h, --help     Show CLI help.
-  -v, --verbose
-
-DESCRIPTION
-  Removes a plugin from the CLI.
-
-ALIASES
-  $ hd plugins unlink
-  $ hd plugins remove
-
-EXAMPLES
-  $ hd plugins remove myplugin
-```
-
-## `hd plugins reset`
-
-Remove all user-installed and linked plugins.
-
-```
-USAGE
-  $ hd plugins reset [--hard] [--reinstall]
-
-FLAGS
-  --hard       Delete node_modules and package manager related files in addition to uninstalling plugins.
-  --reinstall  Reinstall all plugins after uninstalling.
-```
-
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.36/src/commands/plugins/reset.ts)_
-
-## `hd plugins uninstall [PLUGIN]`
-
-Removes a plugin from the CLI.
-
-```
-USAGE
-  $ hd plugins uninstall [PLUGIN...] [-h] [-v]
-
-ARGUMENTS
-  PLUGIN...  plugin to uninstall
-
-FLAGS
-  -h, --help     Show CLI help.
-  -v, --verbose
-
-DESCRIPTION
-  Removes a plugin from the CLI.
-
-ALIASES
-  $ hd plugins unlink
-  $ hd plugins remove
-
-EXAMPLES
-  $ hd plugins uninstall myplugin
-```
-
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.36/src/commands/plugins/uninstall.ts)_
-
-## `hd plugins unlink [PLUGIN]`
-
-Removes a plugin from the CLI.
-
-```
-USAGE
-  $ hd plugins unlink [PLUGIN...] [-h] [-v]
-
-ARGUMENTS
-  PLUGIN...  plugin to uninstall
-
-FLAGS
-  -h, --help     Show CLI help.
-  -v, --verbose
-
-DESCRIPTION
-  Removes a plugin from the CLI.
-
-ALIASES
-  $ hd plugins unlink
-  $ hd plugins remove
-
-EXAMPLES
-  $ hd plugins unlink myplugin
-```
-
-## `hd plugins update`
-
-Update installed plugins.
-
-```
-USAGE
-  $ hd plugins update [-h] [-v]
-
-FLAGS
-  -h, --help     Show CLI help.
-  -v, --verbose
-
-DESCRIPTION
-  Update installed plugins.
-```
-
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.36/src/commands/plugins/update.ts)_
-
 ## `hd report committers`
 
 Generate report of committers to a git repository
 
 ```
 USAGE
-  $ hd report committers [--json] [-m <value>] [-o text|json|csv] [-s]
+  $ hd report committers [--json] [-m <value>] [-c] [-s]
 
 FLAGS
-  -m, --months=<value>   [default: 12] The number of months of git history to review
-  -o, --output=<option>  [default: text] Output format: text, json, or csv
-                         <options: text|json|csv>
-  -s, --save             Save the committers report as nes.committers.<output>
+  -c, --csv             Output in CSV format
+  -m, --months=<value>  [default: 12] The number of months of git history to review
+  -s, --save            Save the committers report as nes.committers.<output>
 
 GLOBAL FLAGS
   --json  Format output as json.
@@ -374,14 +73,14 @@ DESCRIPTION
 EXAMPLES
   $ hd report committers
 
-  $ hd report committers -o csv -s
+  $ hd report committers --csv -s
 
-  $ hd report committers --output=json
+  $ hd report committers --json
 
-  $ hd report committers --output=csv
+  $ hd report committers --csv
 ```
 
-_See code: [src/commands/report/committers.ts](https://github.com/herodevs/cli/blob/v1.0.0-beta.2/src/commands/report/committers.ts)_
+_See code: [src/commands/report/committers.ts](https://github.com/herodevs/cli/blob/v1.2.0-beta.1/src/commands/report/committers.ts)_
 
 ## `hd report purls`
 
@@ -389,14 +88,13 @@ Generate a list of purls from a sbom
 
 ```
 USAGE
-  $ hd report purls [--json] [-f <value>] [-d <value>] [-s] [-o json|csv]
+  $ hd report purls [--json] [-f <value>] [-d <value>] [-s] [-c]
 
 FLAGS
-  -d, --dir=<value>      The directory to scan in order to create a cyclonedx sbom
-  -f, --file=<value>     The file path of an existing cyclonedx sbom to scan for EOL
-  -o, --output=<option>  [default: json] The format of the saved file (when using --save)
-                         <options: json|csv>
-  -s, --save             Save the list of purls as nes.purls.<output>
+  -c, --csv           Save output in CSV format (only applies when using --save)
+  -d, --dir=<value>   The directory to scan in order to create a cyclonedx sbom
+  -f, --file=<value>  The file path of an existing cyclonedx sbom to scan for EOL
+  -s, --save          Save the list of purls as nes.purls.<output>
 
 GLOBAL FLAGS
   --json  Format output as json.
@@ -405,16 +103,18 @@ DESCRIPTION
   Generate a list of purls from a sbom
 
 EXAMPLES
+  $ hd report purls --json -s
+
   $ hd report purls --dir=./my-project
 
   $ hd report purls --file=path/to/sbom.json
 
   $ hd report purls --dir=./my-project --save
 
-  $ hd report purls --save --output=csv
+  $ hd report purls --save --csv
 ```
 
-_See code: [src/commands/report/purls.ts](https://github.com/herodevs/cli/blob/v1.0.0-beta.2/src/commands/report/purls.ts)_
+_See code: [src/commands/report/purls.ts](https://github.com/herodevs/cli/blob/v1.2.0-beta.1/src/commands/report/purls.ts)_
 
 ## `hd scan eol`
 
@@ -422,12 +122,14 @@ Scan a given sbom for EOL data
 
 ```
 USAGE
-  $ hd scan eol [--json] [-f <value>] [-d <value>] [-s]
+  $ hd scan eol [--json] [-f <value>] [-d <value>] [-s] [-a] [-c]
 
 FLAGS
-  -d, --dir=<value>   The directory to scan in order to create a cyclonedx sbom
-  -f, --file=<value>  The file path of an existing cyclonedx sbom to scan for EOL
-  -s, --save          Save the generated SBOM as nes.sbom.json in the scanned directory
+  -a, --all                 Show all components (default is EOL and LTS only)
+  -c, --getCustomerSupport  Get Never-Ending Support for End-of-Life components
+  -d, --dir=<value>         The directory to scan in order to create a cyclonedx sbom
+  -f, --file=<value>        The file path of an existing cyclonedx sbom to scan for EOL
+  -s, --save                Save the generated SBOM as nes.sbom.json in the scanned directory
 
 GLOBAL FLAGS
   --json  Format output as json.
@@ -439,9 +141,11 @@ EXAMPLES
   $ hd scan eol --dir=./my-project
 
   $ hd scan eol --file=path/to/sbom.json
+
+  $ hd scan eol -a --dir=./my-project
 ```
 
-_See code: [src/commands/scan/eol.ts](https://github.com/herodevs/cli/blob/v1.0.0-beta.2/src/commands/scan/eol.ts)_
+_See code: [src/commands/scan/eol.ts](https://github.com/herodevs/cli/blob/v1.2.0-beta.1/src/commands/scan/eol.ts)_
 
 ## `hd scan sbom`
 
@@ -449,9 +153,10 @@ Scan a SBOM for purls
 
 ```
 USAGE
-  $ hd scan sbom [--json] [-f <value>] [-d <value>] [-s]
+  $ hd scan sbom [--json] [-f <value>] [-d <value>] [-s] [-b]
 
 FLAGS
+  -b, --background    Run the scan in the background
   -d, --dir=<value>   The directory to scan in order to create a cyclonedx sbom
   -f, --file=<value>  The file path of an existing cyclonedx sbom to scan for EOL
   -s, --save          Save the generated SBOM as nes.sbom.json in the scanned directory
@@ -468,5 +173,5 @@ EXAMPLES
   $ hd scan sbom --file=path/to/sbom.json
 ```
 
-_See code: [src/commands/scan/sbom.ts](https://github.com/herodevs/cli/blob/v1.0.0-beta.2/src/commands/scan/sbom.ts)_
+_See code: [src/commands/scan/sbom.ts](https://github.com/herodevs/cli/blob/v1.2.0-beta.1/src/commands/scan/sbom.ts)_
 <!-- commandsstop -->

package/bin/dev.js

@@ -1,11 +1,11 @@
 #!/usr/bin/env node
 
+import { execute } from '@oclif/core';
+
+// Localhost
 process.env.GRAPHQL_HOST = 'http://localhost:3000';
 
-async function run() {
-  const oclif = await import('@oclif/core');
-  await oclif.execute({ development: true, dir: import.meta.dirname });
-  console.log('\n\n\n=> OCLIF: Command complete.');
-}
+// Dev
+// process.env.GRAPHQL_HOST = 'https://api.dev.nes.herodevs.com';
 
-run();
+await execute({ development: true, dir: import.meta.url });

package/bin/run.js

@@ -1,4 +1,5 @@
 #!/usr/bin/env node
 
-const oclif = await import('@oclif/core');
-await oclif.execute({ dir: import.meta.dirname });
+import { execute } from '@oclif/core';
+
+await execute({ dir: import.meta.url });

package/dist/api/client.d.ts

@@ -4,8 +4,6 @@ export interface ApolloHelper {
     query<T, V extends apollo.OperationVariables | undefined = undefined>(query: apollo.DocumentNode, variables?: V): Promise<apollo.ApolloQueryResult<T>>;
 }
 export declare const createApollo: (url: string) => apollo.ApolloClient<apollo.NormalizedCacheObject>;
-export declare class ApolloError extends Error {
-}
 export declare class ApolloClient implements ApolloHelper {
     #private;
     constructor(url: string);

package/dist/api/client.js

@@ -1,4 +1,5 @@
 import * as apollo from '@apollo/client/core/index.js';
+import { ApolloError } from "../service/error.svc.js";
 export const createApollo = (url) => new apollo.ApolloClient({
     cache: new apollo.InMemoryCache({
         addTypename: false,
@@ -12,31 +13,31 @@ export const createApollo = (url) => new apollo.ApolloClient({
         }),
     ]),
 });
-export class ApolloError extends Error {
-}
 export class ApolloClient {
     #apollo;
     constructor(url) {
         this.#apollo = createApollo(url);
     }
     async mutate(mutation, variables) {
-        return this.#apollo
-            .mutate({
-            mutation,
-            variables,
-        })
-            .catch((error) => {
-            throw new ApolloError('Failed GQL Mutation', error);
-        });
+        try {
+            return await this.#apollo.mutate({
+                mutation,
+                variables,
+            });
+        }
+        catch (error) {
+            throw new ApolloError('GraphQL mutation failed', error);
+        }
     }
     async query(query, variables) {
-        return this.#apollo
-            .query({
-            query,
-            variables,
-        })
-            .catch((error) => {
-            throw new ApolloError('Failed GQL Query', error);
-        });
+        try {
+            return await this.#apollo.query({
+                query,
+                variables,
+            });
+        }
+        catch (error) {
+            throw new ApolloError('GraphQL query failed', error);
+        }
     }
 }

package/dist/api/nes/nes.client.d.ts

@@ -14,3 +14,7 @@ export declare class NesApolloClient implements NesClient {
     mutate<T, V extends Record<string, unknown>>(mutation: apollo.DocumentNode, variables?: V): Promise<apollo.FetchResult<T>>;
     query<T, V extends Record<string, unknown> | undefined>(query: apollo.DocumentNode, variables?: V): Promise<apollo.ApolloQueryResult<T>>;
 }
+/**
+ * Uses the purls from the sbom to run the scan.
+ */
+export declare function submitScan(purls: string[]): Promise<ScanResult>;

package/dist/api/nes/nes.client.js

@@ -15,3 +15,14 @@ export class NesApolloClient {
         return this.#apollo.query(query, variables);
     }
 }
+/**
+ * Uses the purls from the sbom to run the scan.
+ */
+export async function submitScan(purls) {
+    // NOTE: GRAPHQL_HOST is set in `./bin/dev.js` or tests
+    const host = process.env.GRAPHQL_HOST || 'https://api.nes.herodevs.com';
+    const path = process.env.GRAPHQL_PATH || '/graphql';
+    const url = host + path;
+    const client = new NesApolloClient(url);
+    return client.scan.sbom(purls);
+}

package/dist/api/queries/nes/sbom.js

@@ -11,6 +11,8 @@ export const M_SCAN = {
                 isEol
                 isUnsafe
                 eolAt
+                daysEol
+                status
               }
             } 
             diagnostics
@@ -20,6 +22,9 @@ export const M_SCAN = {
             warnings {
               purl
               type
+              message
+              error
+              diagnostics
             }
           }
         }

package/dist/api/types/nes.types.d.ts

@@ -16,20 +16,34 @@ export interface ScanResponseReport {
     diagnostics?: Record<string, unknown>;
     message: string;
     success: boolean;
+    warnings?: ScanWarning[];
 }
-export type ComponentStatus = 'EOL' | 'LTS' | 'OK';
+export declare const VALID_STATUSES: readonly ["UNKNOWN", "OK", "EOL", "LTS"];
+export type ComponentStatus = (typeof VALID_STATUSES)[number];
+export declare const isValidComponentStatus: (status: string) => status is ComponentStatus;
+export declare const validateComponentStatuses: (statuses: string[]) => ComponentStatus[];
 export interface ScanResultComponent {
     info: {
         eolAt: Date | null;
         isEol: boolean;
+        daysEol: number | null;
         isUnsafe: boolean;
+        status: ComponentStatus;
     };
     purl: string;
-    status?: ComponentStatus;
 }
+export interface ScanWarning {
+    purl: string;
+    message: string;
+    type?: string;
+    error?: unknown;
+    diagnostics?: Record<string, unknown>;
+}
+export type ScanResultComponentsMap = Map<string, ScanResultComponent>;
 export interface ScanResult {
-    components: Map<string, ScanResultComponent>;
+    components: ScanResultComponentsMap;
     diagnostics?: Record<string, unknown>;
     message: string;
     success: boolean;
+    warnings: ScanWarning[];
 }

package/dist/api/types/nes.types.js

@@ -1 +1,11 @@
-export {};
+export const VALID_STATUSES = ['UNKNOWN', 'OK', 'EOL', 'LTS'];
+export const isValidComponentStatus = (status) => {
+    return VALID_STATUSES.includes(status);
+};
+export const validateComponentStatuses = (statuses) => {
+    const validStatuses = statuses.filter(isValidComponentStatus);
+    if (validStatuses.length !== statuses.length) {
+        throw new Error('Invalid component status provided');
+    }
+    return validStatuses;
+};

package/dist/commands/report/committers.d.ts

@@ -1,14 +1,15 @@
 import { Command } from '@oclif/core';
+import { type ReportData } from '../../service/committers.svc.ts';
 export default class Committers extends Command {
     static description: string;
     static enableJsonFlag: boolean;
     static examples: string[];
     static flags: {
         months: import("@oclif/core/interfaces").OptionFlag<number, import("@oclif/core/interfaces").CustomOptions>;
-        output: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
+        csv: import("@oclif/core/interfaces").BooleanFlag<boolean>;
         save: import("@oclif/core/interfaces").BooleanFlag<boolean>;
     };
-    run(): Promise<void>;
+    run(): Promise<ReportData | string>;
     /**
      * Generates structured report data
      * @param entries - parsed git log output for commits