@settlemint/sdk-utils 2.3.2-prebafe7cb → 2.3.2-prede7bc05

package/dist/package-manager.d.cts

@@ -1,5 +1,16 @@
-import { AgentName } from 'package-manager-detector';
+import { AgentName } from "package-manager-detector";
 
+//#region src/package-manager/download-and-extract.d.ts
+/**
+* Formats a directory path by removing trailing slashes and whitespace
+*
+* @param targetDir - The directory path to format
+* @returns The formatted directory path
+* @example
+* import { formatTargetDir } from "@settlemint/sdk-utils/package-manager";
+*
+* const formatted = formatTargetDir("/path/to/dir/ "); // "/path/to/dir"
+*/
 /**
  * Formats a directory path by removing trailing slashes and whitespace
  *
@@ -35,6 +46,8 @@ declare function isEmpty(path: string): Promise<boolean>;
  */
 declare function emptyDir(dir: string): Promise<void>;
 
+//#endregion
+//#region src/package-manager/get-package-manager.d.ts
 /**
  * Detects the package manager used in the current project
  *
@@ -48,6 +61,8 @@ declare function emptyDir(dir: string): Promise<void>;
  */
 declare function getPackageManager(targetDir?: string): Promise<AgentName>;
 
+//#endregion
+//#region src/package-manager/get-package-manager-executable.d.ts
 /**
  * Retrieves the executable command and arguments for the package manager
  *
@@ -60,10 +75,12 @@ declare function getPackageManager(targetDir?: string): Promise<AgentName>;
  * console.log(`Using ${command} with args: ${args.join(" ")}`);
  */
 declare function getPackageManagerExecutable(targetDir?: string): Promise<{
-    command: string;
-    args: string[];
+  command: string;
+  args: string[];
 }>;
 
+//#endregion
+//#region src/package-manager/install-dependencies.d.ts
 /**
  * Installs one or more packages as dependencies using the detected package manager
  *
@@ -82,6 +99,8 @@ declare function getPackageManagerExecutable(targetDir?: string): Promise<{
  */
 declare function installDependencies(pkgs: string | string[], cwd?: string): Promise<void>;
 
+//#endregion
+//#region src/package-manager/is-package-installed.d.ts
 /**
  * Checks if a package is installed in the project's dependencies, devDependencies, or peerDependencies.
  *
@@ -97,6 +116,8 @@ declare function installDependencies(pkgs: string | string[], cwd?: string): Pro
  */
 declare function isPackageInstalled(name: string, path?: string): Promise<boolean>;
 
+//#endregion
+//#region src/package-manager/set-name.d.ts
 /**
  * Sets the name field in the package.json file
  *
@@ -111,4 +132,6 @@ declare function isPackageInstalled(name: string, path?: string): Promise<boolea
  */
 declare function setName(name: string, path?: string): Promise<void>;
 
+//#endregion
 export { emptyDir, formatTargetDir, getPackageManager, getPackageManagerExecutable, installDependencies, isEmpty, isPackageInstalled, setName };
+//# sourceMappingURL=package-manager.d.cts.map

package/dist/package-manager.d.ts

@@ -1,5 +1,16 @@
-import { AgentName } from 'package-manager-detector';
+import { AgentName } from "package-manager-detector";
 
+//#region src/package-manager/download-and-extract.d.ts
+/**
+* Formats a directory path by removing trailing slashes and whitespace
+*
+* @param targetDir - The directory path to format
+* @returns The formatted directory path
+* @example
+* import { formatTargetDir } from "@settlemint/sdk-utils/package-manager";
+*
+* const formatted = formatTargetDir("/path/to/dir/ "); // "/path/to/dir"
+*/
 /**
  * Formats a directory path by removing trailing slashes and whitespace
  *
@@ -35,6 +46,8 @@ declare function isEmpty(path: string): Promise<boolean>;
  */
 declare function emptyDir(dir: string): Promise<void>;
 
+//#endregion
+//#region src/package-manager/get-package-manager.d.ts
 /**
  * Detects the package manager used in the current project
  *
@@ -48,6 +61,8 @@ declare function emptyDir(dir: string): Promise<void>;
  */
 declare function getPackageManager(targetDir?: string): Promise<AgentName>;
 
+//#endregion
+//#region src/package-manager/get-package-manager-executable.d.ts
 /**
  * Retrieves the executable command and arguments for the package manager
  *
@@ -60,10 +75,12 @@ declare function getPackageManager(targetDir?: string): Promise<AgentName>;
  * console.log(`Using ${command} with args: ${args.join(" ")}`);
  */
 declare function getPackageManagerExecutable(targetDir?: string): Promise<{
-    command: string;
-    args: string[];
+  command: string;
+  args: string[];
 }>;
 
+//#endregion
+//#region src/package-manager/install-dependencies.d.ts
 /**
  * Installs one or more packages as dependencies using the detected package manager
  *
@@ -82,6 +99,8 @@ declare function getPackageManagerExecutable(targetDir?: string): Promise<{
  */
 declare function installDependencies(pkgs: string | string[], cwd?: string): Promise<void>;
 
+//#endregion
+//#region src/package-manager/is-package-installed.d.ts
 /**
  * Checks if a package is installed in the project's dependencies, devDependencies, or peerDependencies.
  *
@@ -97,6 +116,8 @@ declare function installDependencies(pkgs: string | string[], cwd?: string): Pro
  */
 declare function isPackageInstalled(name: string, path?: string): Promise<boolean>;
 
+//#endregion
+//#region src/package-manager/set-name.d.ts
 /**
  * Sets the name field in the package.json file
  *
@@ -111,4 +132,6 @@ declare function isPackageInstalled(name: string, path?: string): Promise<boolea
  */
 declare function setName(name: string, path?: string): Promise<void>;
 
+//#endregion
 export { emptyDir, formatTargetDir, getPackageManager, getPackageManagerExecutable, installDependencies, isEmpty, isPackageInstalled, setName };
+//# sourceMappingURL=package-manager.d.ts.map