@zeroheight/adoption-cli 2.1.0 → 2.2.1

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Release notes
 
+## [2.2.1](https://www.npmjs.com/package/@zeroheight/adoption-cli/v/2.2.1) - 13th November 2024
+
+- Handle API throttling
+
+## [2.2.0](https://www.npmjs.com/package/@zeroheight/adoption-cli/v/2.2.0) - 8th November 2024
+
+- Include export names in package file as part of component analyzing
+
 ## [2.1.0](https://www.npmjs.com/package/@zeroheight/adoption-cli/v/2.1.0) - 8th November 2024
 
 - Start collecting component property usage data as part of component analyzing

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("2.1.0")
+    .version("2.2.1")
     .addHelpText("before", output)
     .addCommand(analyzeCommand())
     .addCommand(authCommand())

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

@@ -8,3 +8,7 @@ export declare function getPackageInfo(): Promise<{
     files: PackageFile[];
     error: string | null;
 }>;
+/**
+ * Transform exports object into fully qualified aliases
+ */
+export declare function getAliasesFromExports(packageName: string, exports?: PackageFile["exports"]): string[];

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

@@ -21,10 +21,12 @@ export async function getPackageInfo() {
     try {
         const packageFiles = await Promise.all(files.map(async (file) => {
             const fileContents = await readFile(file, "utf-8");
+            const parsedPackage = JSON.parse(fileContents);
             return {
-                name: JSON.parse(fileContents).name,
+                name: parsedPackage.name,
                 path: `.${files[0]?.split(base).pop()}`,
-                version: JSON.parse(fileContents).version,
+                version: parsedPackage.version,
+                exports: parsedPackage.exports,
             };
         }));
         return {
@@ -39,3 +41,13 @@ export async function getPackageInfo() {
         };
     }
 }
+/**
+ * Transform exports object into fully qualified aliases
+ */
+export function getAliasesFromExports(packageName, exports) {
+    if (!exports)
+        return [];
+    return Object.keys(exports)
+        .map((path) => joinPath(packageName, path))
+        .filter((name) => name !== packageName);
+}

package/dist/common/api.d.ts

@@ -39,7 +39,7 @@ interface PackageDetailsSuccessResponse {
         updated_at: string;
     };
 }
-export declare function submitPackageDetails(name: string, path: string, version: string, credentials: Credentials): Promise<APIResponse<PackageDetailsSuccessResponse, {}, {}>>;
+export declare function submitPackageDetails(name: string, path: string, version: string, aliases: string[], credentials: Credentials): Promise<APIResponse<PackageDetailsSuccessResponse, {}, {}>>;
 interface MonitoredRepoDetailsSuccess {
     monitored_repository: {
         id: number;

package/dist/common/api.js

@@ -13,11 +13,12 @@ export function getZeroheightURL() {
         return new URL("https://zeroheight.com");
     }
 }
-export async function submitPackageDetails(name, path, version, credentials) {
+export async function submitPackageDetails(name, path, version, aliases, credentials) {
     return post("/design_system_packages", {
         name,
         path,
         latest_version: version,
+        aliases,
     }, credentials);
 }
 export async function submitMonitoredRepoDetails(name, version, lockfilePath, packages, credentials) {
@@ -51,25 +52,40 @@ async function post(path, body, credentials) {
         body: JSON.stringify(body),
     });
 }
+async function sleep(ms) {
+    return new Promise((resolve) => setTimeout(resolve, ms));
+}
 async function request(path, credentials, init) {
     const url = getZeroheightURL();
     url.pathname = API_PATH + path;
     if (process.env["NODE_ENV"] === "dev") {
         process.env["NODE_TLS_REJECT_UNAUTHORIZED"] = "0";
     }
-    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",
-        },
-    });
-    if (response.status === 401) {
-        throw new Error("Unauthorized");
+    const maxRetries = 3;
+    let retries = 0;
+    while (retries < maxRetries) {
+        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",
+            },
+        });
+        if (response.status === 401) {
+            throw new Error("Unauthorized");
+        }
+        else if (response.status === 429) {
+            retries++;
+            const responseData = await response.json();
+            const waitTime = responseData.data.reset_time * 1000 - Date.now();
+            await sleep(waitTime);
+            continue;
+        }
+        return await response.json();
     }
-    return await response.json();
+    throw new Error(`Request failed after ${maxRetries} retries`);
 }
 export function mergeUsageProps(newProps, currentProps) {
     if (!currentProps)

package/dist/common/types/package-file.d.ts

@@ -5,4 +5,9 @@ export interface PackageFile {
     name: string;
     path: string;
     version: string;
+    exports?: Record<string, Partial<{
+        import: string;
+        require: string;
+        types: string;
+    }> | string>;
 }

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

@@ -2,7 +2,7 @@ import React from "react";
 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 { getAliasesFromExports, getPackageInfo, } from "../../commands/track-package.utils.js";
 import { ResponseStatus, submitPackageDetails } from "../../common/api.js";
 var Step;
 (function (Step) {
@@ -24,11 +24,12 @@ export default function NonInteractiveTrackPackage() {
         const { files, error } = await getPackageInfo();
         try {
             if (files.length === 1) {
-                const { name, path, version } = files[0];
+                const { name, path, version, exports } = files[0];
                 setPackageName(name);
                 setPackageVersion(version);
                 setCurrentStep(Step.SINGLE_PACKAGE_FOUND);
-                const response = await submitPackageDetails(name, path, version, {
+                const aliases = getAliasesFromExports(name, exports);
+                const response = await submitPackageDetails(name, path, version, aliases, {
                     token: config.token,
                     client: config.client,
                 });
@@ -46,7 +47,8 @@ export default function NonInteractiveTrackPackage() {
                 setPackageFiles(files);
                 setCurrentStep(Step.MULTIPLE_PACKAGES_FOUND);
                 await Promise.all(files.map(async (pack) => {
-                    await submitPackageDetails(pack.name, pack.path, pack.version, {
+                    const aliases = getAliasesFromExports(pack.name, pack.exports);
+                    await submitPackageDetails(pack.name, pack.path, pack.version, aliases, {
                         token: config.token,
                         client: config.client,
                     });

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

@@ -5,7 +5,7 @@ import SelectInput from "ink-select-input";
 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 { getAliasesFromExports, getPackageInfo, } from "../../commands/track-package.utils.js";
 import { submitPackageDetails } from "../../common/api.js";
 var Step;
 (function (Step) {
@@ -28,12 +28,13 @@ export default function TrackPackage() {
     const [packageName, setPackageName] = React.useState(null);
     const [packagePath, setPackagePath] = React.useState(null);
     const [packageVersion, setPackageVersion] = React.useState(null);
+    const [packageAliases, setPackageAliases] = React.useState([]);
     const [shouldSend, setShouldSend] = React.useState("");
     const [shouldMultiSelect, setShouldMultiSelect] = React.useState("");
     const [packageSelection, setPackageSelection] = React.useState([]);
     const [selectedFileLabels, setSelectedFileLabels] = React.useState([]);
-    async function submitPackage(name, path, version) {
-        await submitPackageDetails(name, path, version, credentials);
+    async function submitPackage(name, path, version, aliases) {
+        await submitPackageDetails(name, path, version, aliases, credentials);
     }
     async function sendData() {
         setCurrentStep(Step.SENDING_DETAILS);
@@ -42,18 +43,20 @@ export default function TrackPackage() {
                 const packagesToSend = packageFiles.filter((p) => selectedFileLabels.includes(`${p.name}@${p.version}`));
                 if (packagesToSend.length > 0) {
                     await Promise.all(packagesToSend.map(async (pack) => {
-                        submitPackage(pack.name, pack.path, pack.version);
+                        const aliases = getAliasesFromExports(pack.name, pack.exports);
+                        submitPackage(pack.name, pack.path, pack.version, aliases);
                     }));
                 }
                 else {
                     await Promise.all(packageFiles.map(async (pack) => {
-                        submitPackage(pack.name, pack.path, pack.version);
+                        const aliases = getAliasesFromExports(pack.name, pack.exports);
+                        submitPackage(pack.name, pack.path, pack.version, aliases);
                     }));
                 }
                 setCurrentStep(Step.COMPLETE);
             }
             else {
-                await submitPackage(packageName, packagePath, packageVersion);
+                await submitPackage(packageName, packagePath, packageVersion, packageAliases);
                 setCurrentStep(Step.COMPLETE);
             }
         }
@@ -101,10 +104,11 @@ export default function TrackPackage() {
             }
             const { files, error } = await getPackageInfo();
             if (files.length === 1) {
-                const { name, path, version } = files[0];
+                const { name, path, version, exports } = files[0];
                 setPackageName(name);
                 setPackagePath(path);
                 setPackageVersion(version);
+                setPackageAliases(getAliasesFromExports(name, exports));
                 setCurrentStep(Step.SINGLE_PACKAGE_FOUND);
             }
             else if (files.length > 1) {

package/package.json

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