@zeroheight/adoption-cli 1.2.0 → 2.0.1

package/CHANGELOG.md

@@ -1,9 +1,23 @@
 # Release notes
 
+## [2.0.1](https://www.npmjs.com/package/@zeroheight/adoption-cli/v/2.0.1) - 21st October 2024
+
+- Update help text and link
+
+## [2.0.0](https://www.npmjs.com/package/@zeroheight/adoption-cli/v/2.0.0) - 21st October 2024
+
+- Use new API endpoints
+
+## [1.2.1](https://www.npmjs.com/package/@zeroheight/adoption-cli/v/1.2.1) - 18th October 2024
+
+- Update error handling internally
+
 ## [1.2.0](https://www.npmjs.com/package/@zeroheight/adoption-cli/v/1.2.0) - 17th October 2024
+
 - Support scoped packages in Yarn lockfiles
 
 ## [1.1.0](https://www.npmjs.com/package/@zeroheight/adoption-cli/v/1.1.0) - 17th October 2024
+
 - Validate authentication credentials on set up
 
 ## [1.0.0](https://www.npmjs.com/package/@zeroheight/adoption-cli/v/1.0.0) - 16th October 2024

package/dist/cli.js

@@ -12,7 +12,7 @@ const { output, cleanup } = render(React.createElement(HelpInfo, null));
 program
     .name("zh-adoption")
     .description("CLI for measuring design system usage usage in your products")
-    .version("1.2.0")
+    .version("2.0.1")
     .addHelpText("before", output)
     .addCommand(analyzeCommand())
     .addCommand(authCommand())

package/dist/common/api.d.ts

@@ -1,23 +1,82 @@
 import { RawUsageMap } from "../commands/analyze.js";
 import { Credentials } from "./config.js";
+export declare enum ResponseStatus {
+    Success = "success",
+    Error = "error",
+    Fail = "fail"
+}
 /**
  * Open API V2 Response format
  */
-interface APIResponse<T> {
-    status: string;
+interface BaseResponse<T> {
+    status: ResponseStatus;
     message: string;
     data: T;
 }
+interface SuccessResponse<T> extends BaseResponse<T> {
+    status: ResponseStatus.Success;
+}
+interface FailResponse<T> extends BaseResponse<T> {
+    status: ResponseStatus.Fail;
+}
+interface ErrorResponse<T> extends BaseResponse<T> {
+    status: ResponseStatus.Error;
+}
+export type APIResponse<S = {}, F = {}, E = {}> = SuccessResponse<S> | FailResponse<F> | ErrorResponse<E>;
 export declare function getZeroheightURL(): URL;
-export declare function submitPackageDetails(name: string, path: string, version: string, credentials: Credentials): Promise<APIResponse<any>>;
+interface PackageDetailsSuccessResponse {
+    design_system_packages: {
+        id: number;
+        name: string;
+        path: string;
+        latest_version: string;
+        source: string;
+        repository_id: number | null;
+        team_id: number | null;
+        project_id: number | null;
+        created_at: string;
+        updated_at: string;
+    };
+}
+export declare function submitPackageDetails(name: string, path: string, version: string, credentials: Credentials): Promise<APIResponse<PackageDetailsSuccessResponse, {}, {}>>;
+interface MonitoredRepoDetailsSuccess {
+    monitored_repository: {
+        id: number;
+        lock_file_path: string;
+        repository_id: number;
+        team_id: number | null;
+        project_id: number | null;
+        created_at: string;
+        updated_at: string;
+        name: string;
+        source: string;
+    };
+}
 export declare function submitMonitoredRepoDetails(name: string, version: string, lockfilePath: string, packages: {
     name: string;
     version: string;
-}[], credentials: Credentials): Promise<APIResponse<{
-    errors: string[];
-}>>;
-export declare function submitUsageData(usage: RawUsageMap, repoName: string, credentials: Credentials): Promise<any>;
-export declare function getExistingRepoNames(credentials: Credentials): Promise<string[]>;
+}[], credentials: Credentials): Promise<APIResponse<MonitoredRepoDetailsSuccess>>;
+interface ComponentUsageDetailsSuccess {
+    component_usage: {
+        id: number;
+        usage: {
+            name: string;
+            count: number;
+            package: string;
+            files: string[];
+        }[];
+        team_id: number | null;
+        project_id: number | null;
+        created_at: string;
+        updated_at: string;
+        repo_name: string;
+    };
+}
+export declare function submitUsageData(usage: RawUsageMap, repoName: string, credentials: Credentials): Promise<APIResponse<ComponentUsageDetailsSuccess>>;
+interface RepoNamesSuccss {
+    repo_names: string[];
+}
+export declare function getExistingRepoNames(credentials: Credentials): Promise<APIResponse<RepoNamesSuccss>>;
 interface AuthTokensResponse {
     scopes: string[];
     email: string;
@@ -30,5 +89,5 @@ interface AuthTokensResponse {
         name: string;
     };
 }
-export declare function getAuthDetails(credentials: Credentials): Promise<AuthTokensResponse>;
+export declare function getAuthDetails(credentials: Credentials): Promise<APIResponse<AuthTokensResponse>>;
 export {};

package/dist/common/api.js

@@ -1,3 +1,10 @@
+const API_PATH = "/open_api/v2";
+export var ResponseStatus;
+(function (ResponseStatus) {
+    ResponseStatus["Success"] = "success";
+    ResponseStatus["Error"] = "error";
+    ResponseStatus["Fail"] = "fail";
+})(ResponseStatus || (ResponseStatus = {}));
 export function getZeroheightURL() {
     if (process.env["NODE_ENV"] === "dev") {
         return new URL("https://zeroheight.dev");
@@ -7,14 +14,14 @@ export function getZeroheightURL() {
     }
 }
 export async function submitPackageDetails(name, path, version, credentials) {
-    return post("/open_api/v2/design_system_packages", {
+    return post("/design_system_packages", {
         name,
         path,
         latest_version: version,
     }, credentials);
 }
 export async function submitMonitoredRepoDetails(name, version, lockfilePath, packages, credentials) {
-    return post("/open_api/v2/monitored_repositories", {
+    return post("/monitored_repositories", {
         name,
         lock_file_path: lockfilePath,
         packages,
@@ -22,17 +29,16 @@ export async function submitMonitoredRepoDetails(name, version, lockfilePath, pa
     }, credentials);
 }
 export async function submitUsageData(usage, repoName, credentials) {
-    return post("/open_api/v1/component_usages", {
+    return post("/component_usages", {
         repo_name: repoName,
         usage: transformUsageByName(usage),
     }, credentials);
 }
-export function getExistingRepoNames(credentials) {
-    return get("/open_api/v1/component_usages/repo_names", credentials);
+export async function getExistingRepoNames(credentials) {
+    return get("/component_usages/repo_names", credentials);
 }
 export async function getAuthDetails(credentials) {
-    const response = await get("/open_api/v2/auth_tokens", credentials);
-    return response.data;
+    return get("/auth_tokens", credentials);
 }
 async function get(path, credentials) {
     return request(path, credentials, {
@@ -47,7 +53,7 @@ async function post(path, body, credentials) {
 }
 async function request(path, credentials, init) {
     const url = getZeroheightURL();
-    url.pathname = path;
+    url.pathname = API_PATH + path;
     if (process.env["NODE_ENV"] === "dev") {
         process.env["NODE_TLS_REJECT_UNAUTHORIZED"] = "0";
     }

package/dist/components/analyze/analyze.js

@@ -8,7 +8,7 @@ import NoCredentialsOnboarding from "../auth/no-credentials-onboarding.js";
 import RepoNamePrompt from "../repo-name-prompt.js";
 import UsageTable from "../usage-table.js";
 import { configPath, writeConfig, readConfig, } from "../../common/config.js";
-import { getAuthDetails, getZeroheightURL, submitUsageData, } from "../../common/api.js";
+import { ResponseStatus, getAuthDetails, getZeroheightURL, submitUsageData, } from "../../common/api.js";
 import { calculateNumberOfComponents } from "../../commands/analyze.utils.js";
 export default function Analyze({ onAnalyzeFiles, dryRun, repoName, }) {
     const { exit } = useApp();
@@ -49,8 +49,11 @@ export default function Analyze({ onAnalyzeFiles, dryRun, repoName, }) {
         setIsSendingData(true);
         try {
             await submitUsageData(result, repoName, credentials);
-            const authDetails = await getAuthDetails(credentials);
-            const projectId = authDetails.project?.id;
+            const authDetailsResponse = await getAuthDetails(credentials);
+            if (authDetailsResponse.status !== ResponseStatus.Success) {
+                throw new Error("Failed to get credentials");
+            }
+            const projectId = authDetailsResponse.data.project?.id;
             const resourceURL = getZeroheightURL();
             resourceURL.pathname = projectId
                 ? `/project/${projectId}/adoption/`

package/dist/components/help-info.js

@@ -1,24 +1,24 @@
 import * as React from "react";
-import { Box, Newline, Text } from "ink";
+import { Box, Text } from "ink";
 import Link from "ink-link";
 /**
  * Rich help banner with link to help center docs
  */
 export default function HelpInfo() {
     return (React.createElement(React.Fragment, null,
-        React.createElement(Box, { borderStyle: "double", padding: 2, margin: 1, flexDirection: "column" },
-            React.createElement(Box, { justifyContent: "center" },
+        React.createElement(Box, { borderStyle: "double", paddingLeft: 1, paddingRight: 1, marginBottom: 1, flexDirection: "column" },
+            React.createElement(Box, { justifyContent: "center", marginBottom: 1 },
                 React.createElement(Text, { bold: true }, "Welcome \uD83D\uDC4B")),
-            React.createElement(Newline, null),
-            React.createElement(Text, null,
-                "Get started with the",
-                " ",
-                React.createElement(Text, { color: "#f63e7c", bold: true }, "zeroheight"),
-                " ",
-                "measurement CLI and start tracking your component usage."),
+            React.createElement(Box, { marginBottom: 1 },
+                React.createElement(Text, null,
+                    "Get started with the",
+                    " ",
+                    React.createElement(Text, { color: "#f63e7c", bold: true }, "zeroheight"),
+                    " ",
+                    "measurement CLI and start tracking your design system's adoption.")),
             React.createElement(Text, null,
                 "For more information on how to set this up, check",
                 " ",
-                React.createElement(Link, { url: "https://zeroheight.com/help/article/component-usage/" }, "here"),
+                React.createElement(Link, { url: "https://zeroheight.com/help/article/adoption-private-beta-overview/" }, "here"),
                 "."))));
 }

package/dist/components/monitor-repo/non-interactive-monitor-repo.js

@@ -4,7 +4,7 @@ import Spinner from "ink-spinner";
 import { join as joinPath } from "path";
 import { findLockfiles, getPackageMeta, groupByBasename, parseLockfile, } from "../../commands/monitor-repo.utils.js";
 import { findPackageFiles } from "../../commands/track-package.utils.js";
-import { submitMonitoredRepoDetails } from "../../common/api.js";
+import { ResponseStatus, submitMonitoredRepoDetails, } from "../../common/api.js";
 import { readConfig } from "../../common/config.js";
 import YarnLockParser from "../../lockfile-parsers/yarn-lock-parser.js";
 var Step;
@@ -74,7 +74,7 @@ export default function NonInteractiveMonitorRepo({ packageDirs, }) {
                     token: config.token,
                     client: config.client,
                 });
-                if (response.status === "success") {
+                if (response.status === ResponseStatus.Success) {
                     updateRepoStatus(packageMeta.name, Step.COMPLETE);
                 }
                 else {

package/dist/components/repo-name-prompt.js

@@ -3,7 +3,7 @@ import { Box, Text } from "ink";
 import Spinner from "ink-spinner";
 import SelectInput from "ink-select-input";
 import { readConfig } from "../common/config.js";
-import { getExistingRepoNames } from "../common/api.js";
+import { ResponseStatus, getExistingRepoNames } from "../common/api.js";
 import TextInput from "ink-text-input";
 var RepoNamePromptState;
 (function (RepoNamePromptState) {
@@ -18,7 +18,11 @@ export default function RepoNamePrompt({ credentials, onRepoNameSelected, }) {
     const [repoName, setRepoName] = React.useState("");
     async function loadRepoNames(credentials) {
         try {
-            const names = await getExistingRepoNames(credentials);
+            const repoNamesResponse = await getExistingRepoNames(credentials);
+            if (repoNamesResponse.status !== ResponseStatus.Success) {
+                throw new Error("Failed to get repo names");
+            }
+            const names = repoNamesResponse.data.repo_names;
             setRepoNames(names);
             if (names.length === 0) {
                 setState(RepoNamePromptState.ENTER_REPO_NAME);

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

@@ -3,7 +3,7 @@ import { Newline, Text, useApp } from "ink";
 import Spinner from "ink-spinner";
 import { readConfig } from "../../common/config.js";
 import { getPackageInfo } from "../../commands/track-package.utils.js";
-import { submitPackageDetails } from "../../common/api.js";
+import { ResponseStatus, submitPackageDetails } from "../../common/api.js";
 var Step;
 (function (Step) {
     Step[Step["COMPLETE"] = 0] = "COMPLETE";
@@ -32,13 +32,13 @@ export default function NonInteractiveTrackPackage() {
                     token: config.token,
                     client: config.client,
                 });
-                if (response.status === "error") {
-                    setErrorMessage(response.message);
-                    setCurrentStep(Step.ERRORED);
+                if (response.status === ResponseStatus.Success) {
+                    setCurrentStep(Step.COMPLETE);
                     exit();
                 }
                 else {
-                    setCurrentStep(Step.COMPLETE);
+                    setErrorMessage(response.message);
+                    setCurrentStep(Step.ERRORED);
                     exit();
                 }
             }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zeroheight/adoption-cli",
-  "version": "1.2.0",
+  "version": "2.0.1",
   "license": "ISC",
   "main": "dist/cli.js",
   "bin": {