@zeroheight/adoption-cli 0.4.1 → 0.4.3

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Release notes
 
+## [0.4.3](https://www.npmjs.com/package/@zeroheight/adoption-cli/v/0.4.3) - 17th September 2024
+
+- Update Ink, ink-link, ink-text-input, ink-select-input dependencies
+
+## [0.4.2](https://www.npmjs.com/package/@zeroheight/adoption-cli/v/0.4.2) - 10th September 2024
+
+- Update README
+
 ## [0.4.1](https://www.npmjs.com/package/@zeroheight/adoption-cli/v/0.4.1) - 9th August 2024
 
 - Update README

package/README.md

@@ -12,13 +12,15 @@ npm i @zeroheight/adoption-cli
 
 ## Usage
 
+### Component usage analysis
+
 In the repository in which you wish to analyze the component usage, run the following command:
 
 ```bash
 zh-adoption analyze
 ```
 
-### Options
+#### Options
 
 `-e` / `--extensions`
 
@@ -52,11 +54,12 @@ Pass in `false` to disable the interactive mode e.g. when running in a CI enviro
 zh-adoption analyze --interactive false -r "My Repo"
 ```
 
----
+
 
 To send adoption data to your [zeroheight](https://zeroheight.com/) account you will need to authenticate using a Client ID and Access Token.
 
-### Interactive mode
+### Authentication
+#### Interactive mode
 
 When running the `analyze` command, you will be prompted to authenticate. This will save the Client ID and Access Token to your local machine.
 
@@ -66,7 +69,7 @@ Alternatively, you can authenticate by running the following command:
 zh-adoption auth
 ```
 
-### Non-interactive mode
+#### Non-interactive mode
 
 When running the `analyze` command with the `--interactive false` flag, you will need to provide the Client ID and Access Token as environment variables.
 

package/dist/cli.js

@@ -2,18 +2,20 @@
 import * as React from "react";
 import { Command } from "commander";
 import { render } from "ink-render-string";
+import HelpInfo from "./components/help-info.js";
 import { analyzeCommand } from "./commands/analyze.js";
 import { authCommand } from "./commands/auth.js";
-import HelpInfo from "./components/help-info.js";
+import { trackPackageCommand } from "./commands/track-package.js";
 const program = new Command();
 const { output, cleanup } = render(React.createElement(HelpInfo, null));
 program
     .name("zh-adoption")
     .description("CLI for measuring design system usage usage in your products")
-    .version("0.4.0")
+    .version("0.4.3")
     .addHelpText("before", output)
     .addCommand(analyzeCommand())
-    .addCommand(authCommand());
+    .addCommand(authCommand())
+    .addCommand(trackPackageCommand());
 cleanup();
 // Only start parsing if run as CLI, don't start parsing during testing
 if (process.env["NODE_ENV"] !== "test") {

package/dist/commands/track-package.d.ts

@@ -0,0 +1,4 @@
+import { Command } from "commander";
+import { RenderOptions } from "ink";
+export declare function trackPackageAction(renderOptions?: RenderOptions): Promise<void>;
+export declare function trackPackageCommand(): Command;

package/dist/commands/track-package.js

@@ -0,0 +1,22 @@
+import * as React from "react";
+import { Command } from "commander";
+import { render } from "ink";
+import TrackPackage from "../components/track-package/track-package.js";
+export async function trackPackageAction(renderOptions) {
+    render(React.createElement(TrackPackage, null), renderOptions);
+}
+export function trackPackageCommand() {
+    const command = new Command();
+    return command
+        .command("track-package")
+        .description("Track the latest version of your package in zeroheight")
+        .action(async () => {
+        try {
+            await trackPackageAction();
+        }
+        catch (e) {
+            console.error(e);
+            process.exitCode = 1;
+        }
+    });
+}

package/dist/commands/track-package.utils.d.ts

@@ -0,0 +1,16 @@
+export declare function getPackageInfo(): Promise<{
+    name: null;
+    path: null;
+    version: null;
+    error: string;
+} | {
+    name: any;
+    path: string;
+    version: any;
+    error: null;
+} | {
+    name: null;
+    path: string;
+    version: null;
+    error: string;
+}>;

package/dist/commands/track-package.utils.js

@@ -0,0 +1,32 @@
+import { readFile } from "fs/promises";
+import { findFiles } from "./analyze.utils.js";
+export async function getPackageInfo() {
+    const base = process.cwd();
+    const files = await findFiles(base, "**/**/package.json", "");
+    if (files.length === 0) {
+        return {
+            name: null,
+            path: null,
+            version: null,
+            error: "Can't find any package files"
+        };
+    }
+    const relativeBase = `.${files[0]?.split(base).pop()}`;
+    try {
+        const fileContents = await readFile(files[0], "utf-8");
+        return {
+            name: JSON.parse(fileContents).name,
+            path: relativeBase,
+            version: JSON.parse(fileContents).version,
+            error: null
+        };
+    }
+    catch {
+        return {
+            name: null,
+            path: relativeBase,
+            version: null,
+            error: `Can't parse file ${files[0]}`
+        };
+    }
+}

package/dist/common/api.d.ts

@@ -1,5 +1,6 @@
 import { RawUsageMap } from "../commands/analyze.js";
 import { Credentials } from "./config.js";
 export declare function getZeroheightURL(): URL;
+export declare function submitPackageDetails(name: string, path: string, version: string, credentials: Credentials): Promise<any>;
 export declare function submitUsageData(usage: RawUsageMap, repoName: string, credentials: Credentials): Promise<any>;
 export declare function getExistingRepoNames(credentials: Credentials): Promise<any>;

package/dist/common/api.js

@@ -6,6 +6,13 @@ export function getZeroheightURL() {
         return new URL("https://zeroheight.com");
     }
 }
+export async function submitPackageDetails(name, path, version, credentials) {
+    return post("/open_api/v2/design_system_packages", {
+        name,
+        path,
+        latest_version: version,
+    }, credentials);
+}
 export async function submitUsageData(usage, repoName, credentials) {
     return post("/open_api/v1/component_usages", {
         repo_name: repoName,
@@ -35,6 +42,7 @@ async function request(path, credentials, init) {
     const response = await fetch(url, {
         ...init,
         headers: {
+            "X-API-CLIENT-NAME": 'cli',
             "X-API-CLIENT": credentials.client,
             "X-API-KEY": credentials.token,
             "Content-Type": "application/json",

package/dist/components/track-package/track-package.d.ts

@@ -0,0 +1,2 @@
+import React from "react";
+export default function TrackPackage(): React.JSX.Element;

package/dist/components/track-package/track-package.js

@@ -0,0 +1,100 @@
+import React from "react";
+import { Box, Newline, Text, useApp } from "ink";
+import Spinner from "ink-spinner";
+import ConfirmInput from "../ui/confirm-input.js";
+import { readConfig } from "../../common/config.js";
+import { getPackageInfo } from "../../commands/track-package.utils.js";
+import { submitPackageDetails } from "../../common/api.js";
+var Step;
+(function (Step) {
+    Step[Step["COMPLETE"] = 0] = "COMPLETE";
+    Step[Step["DETAILS_FOUND"] = 1] = "DETAILS_FOUND";
+    Step[Step["ERRORED"] = 2] = "ERRORED";
+    Step[Step["FINDING_DETAILS"] = 3] = "FINDING_DETAILS";
+    Step[Step["SENDING_DETAILS"] = 4] = "SENDING_DETAILS";
+})(Step || (Step = {}));
+export default function TrackPackage() {
+    const { exit } = useApp();
+    const [currentStep, setCurrentStep] = React.useState(Step.FINDING_DETAILS);
+    const [credentials, setCredentials] = React.useState(null);
+    const [errorMessage, setErrorMessage] = React.useState(null);
+    const [packageName, setPackageName] = React.useState(null);
+    const [packagePath, setPackagePath] = React.useState(null);
+    const [packageVersion, setPackageVersion] = React.useState(null);
+    const [shouldSend, setShouldSend] = React.useState("");
+    async function sendData() {
+        setCurrentStep(Step.SENDING_DETAILS);
+        try {
+            await submitPackageDetails(packageName, packagePath, packageVersion, credentials);
+            setCurrentStep(Step.COMPLETE);
+        }
+        catch (e) {
+            const errorMessage = e.message === "Unauthorized"
+                ? "Unauthorized. Please reset your authentication by running: zh-adoption auth"
+                : "Failed to send data to zeroheight";
+            setErrorMessage(errorMessage);
+            setCurrentStep(Step.ERRORED);
+        }
+        finally {
+            exit();
+        }
+    }
+    const handleSendToZh = async (shouldSendData) => {
+        if (shouldSendData)
+            return sendData();
+        exit();
+    };
+    React.useEffect(() => {
+        (async () => {
+            const config = await readConfig();
+            if (config) {
+                setCredentials({ token: config.token, client: config.client });
+            }
+            const { name, path, version, error } = await getPackageInfo();
+            if (name && path && version) {
+                setPackageName(name);
+                setPackagePath(path);
+                setPackageVersion(version);
+                setCurrentStep(Step.DETAILS_FOUND);
+            }
+            else {
+                setErrorMessage(error);
+                setCurrentStep(Step.ERRORED);
+            }
+        })();
+    }, []);
+    switch (currentStep) {
+        case Step.FINDING_DETAILS:
+            return (React.createElement(Text, null,
+                React.createElement(Text, { color: "green" },
+                    React.createElement(Spinner, { type: "dots" })),
+                " Searching for package file..."));
+        case Step.DETAILS_FOUND:
+            return (React.createElement(Box, { flexDirection: "column" },
+                React.createElement(Text, null,
+                    React.createElement(Text, { color: "green" }, "Details founds:"),
+                    " ",
+                    packageName,
+                    "@",
+                    packageVersion),
+                React.createElement(Newline, null),
+                React.createElement(Text, null,
+                    "Send to zeroheight? ",
+                    React.createElement(Text, { dimColor: true }, "(Y/n):")),
+                React.createElement(ConfirmInput, { isChecked: true, onChange: setShouldSend, onSubmit: handleSendToZh, value: shouldSend })));
+        case Step.SENDING_DETAILS:
+            return (React.createElement(Text, null,
+                React.createElement(Text, { color: "green" },
+                    React.createElement(Spinner, { type: "dots" })),
+                " Sending details to zeroheight..."));
+        case Step.COMPLETE:
+            return (React.createElement(Text, null, "Complete - details sent to your zeroheight account"));
+        case Step.ERRORED:
+            return (React.createElement(Text, null,
+                React.createElement(Text, { color: "red" }, "Error:"),
+                " ",
+                errorMessage));
+        default:
+            return React.createElement(Text, null, "Done");
+    }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zeroheight/adoption-cli",
-  "version": "0.4.1",
+  "version": "0.4.3",
   "license": "ISC",
   "main": "dist/cli.js",
   "bin": {
@@ -17,7 +17,7 @@
     "start-dev": "export NODE_ENV=dev && zh-adoption",
     "build": "tsc",
     "dev": "tsc --watch",
-    "lint": "prettier --check .",
+    "lint": "prettier .",
     "test": "vitest"
   },
   "files": [
@@ -31,12 +31,12 @@
     "commander": "^12.0.0",
     "glob": "^10.3.15",
     "ignore": "^5.3.1",
-    "ink": "^4.1.0",
-    "ink-link": "^3.0.0",
+    "ink": "^5.0.0",
+    "ink-link": "^4.1.0",
     "ink-render-string": "^1.0.0",
-    "ink-select-input": "^5.0.0",
+    "ink-select-input": "^6.0.0",
     "ink-spinner": "^5.0.0",
-    "ink-text-input": "^5.0.1",
+    "ink-text-input": "^6.0.0",
     "oxc-parser": "^0.22.0",
     "react": "^18.2.0",
     "yn": "^5.0.0"