@settlemint/sdk-utils
Advanced tools
Comparing version 1.0.5 to 1.0.6-main1055c654
@@ -13,3 +13,3 @@ import { z } from 'zod'; | ||
SETTLEMINT_ACCESS_TOKEN: z.ZodOptional<z.ZodString>; | ||
/** Personal access token for authenticating with SettleMint services */ | ||
/** @internal */ | ||
SETTLEMINT_PERSONAL_ACCESS_TOKEN: z.ZodOptional<z.ZodString>; | ||
@@ -306,5 +306,7 @@ /** Unique name of the workspace */ | ||
* | ||
* @param prod - Whether to write production environment variables | ||
* @param env - The environment variables to write | ||
* @param secrets - Whether to write to .env.local files for secrets | ||
* @param options - The options for writing the environment variables | ||
* @param options.prod - Whether to write production environment variables | ||
* @param options.env - The environment variables to write | ||
* @param options.secrets - Whether to write to .env.local files for secrets | ||
* @param options.cwd - The directory to start searching for the package.json file from (defaults to process.cwd()) | ||
* @returns Promise that resolves when writing is complete | ||
@@ -325,4 +327,9 @@ * @throws Will throw an error if writing fails | ||
*/ | ||
declare function writeEnv(prod: boolean, env: Partial<DotEnv>, secrets: boolean): Promise<void>; | ||
declare function writeEnv({ prod, env, secrets, cwd, }: { | ||
prod: boolean; | ||
env: Partial<DotEnv>; | ||
secrets: boolean; | ||
cwd?: string; | ||
}): Promise<void>; | ||
export { loadEnv, writeEnv }; |
@@ -6,2 +6,4 @@ import { PathLike } from 'node:fs'; | ||
* | ||
* @param fallbackToCwd - If true, will return the current working directory if no package.json is found | ||
* @param cwd - The directory to start searching for the package.json file from (defaults to process.cwd()) | ||
* @returns Promise that resolves to the absolute path of the project root directory | ||
@@ -16,3 +18,3 @@ * @throws Will throw an error if no package.json is found in the directory tree | ||
*/ | ||
declare function projectRoot(fallbackToCwd?: boolean): Promise<string>; | ||
declare function projectRoot(fallbackToCwd?: boolean, cwd?: string): Promise<string>; | ||
@@ -19,0 +21,0 @@ /** |
import { AgentName } from 'package-manager-detector'; | ||
/** | ||
* Available templates for project creation | ||
*/ | ||
type Template = { | ||
value: string; | ||
label: string; | ||
}; | ||
declare const templates: Template[]; | ||
/** | ||
* Formats a directory path by removing trailing slashes and whitespace | ||
@@ -122,2 +114,2 @@ * | ||
export { type Template, emptyDir, formatTargetDir, getPackageManager, getPackageManagerExecutable, installDependencies, isEmpty, isPackageInstalled, setName, templates }; | ||
export { emptyDir, formatTargetDir, getPackageManager, getPackageManagerExecutable, installDependencies, isEmpty, isPackageInstalled, setName }; |
@@ -87,2 +87,24 @@ import { SpawnOptionsWithoutStdio } from 'node:child_process'; | ||
/** | ||
* Displays a list of items in a formatted manner, supporting nested items. | ||
* | ||
* @param title - The title of the list | ||
* @param items - The items to display, can be strings or arrays for nested items | ||
* @returns The formatted list | ||
* @example | ||
* import { list } from "@settlemint/sdk-utils/terminal"; | ||
* | ||
* // Simple list | ||
* list("Use cases", ["use case 1", "use case 2", "use case 3"]); | ||
* | ||
* // Nested list | ||
* list("Providers", [ | ||
* "AWS", | ||
* ["us-east-1", "eu-west-1"], | ||
* "Azure", | ||
* ["eastus", "westeurope"] | ||
* ]); | ||
*/ | ||
declare function list(title: string, items: Array<string | string[]>): void; | ||
/** | ||
* Displays a note message with optional warning level formatting. | ||
@@ -152,2 +174,2 @@ * Regular notes are displayed in normal text, while warnings are shown in yellow. | ||
export { type ExecuteCommandOptions, type SpinnerOptions, ascii, cancel, executeCommand, intro, maskTokens, note, outro, spinner }; | ||
export { type ExecuteCommandOptions, type SpinnerOptions, ascii, cancel, executeCommand, intro, list, maskTokens, note, outro, spinner }; |
@@ -47,3 +47,3 @@ import { ZodSchema, ZodString, z } from 'zod'; | ||
SETTLEMINT_ACCESS_TOKEN: z.ZodOptional<z.ZodString>; | ||
/** Personal access token for authenticating with SettleMint services */ | ||
/** @internal */ | ||
SETTLEMINT_PERSONAL_ACCESS_TOKEN: z.ZodOptional<z.ZodString>; | ||
@@ -50,0 +50,0 @@ /** Unique name of the workspace */ |
{ | ||
"name": "@settlemint/sdk-utils", | ||
"description": "Shared utilities and helper functions for SettleMint SDK modules", | ||
"version": "1.0.5", | ||
"version": "1.0.6-main1055c654", | ||
"type": "module", | ||
@@ -6,0 +6,0 @@ "private": false, |
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is too big to display
No v1
QualityPackage is not semver >=1. This means it is not stable and does not support ^ ranges.
Found 1 instance in 1 package
485217
3395
1673
2