@layr-labs/ecloud-sdk 1.0.0-devep7 → 1.0.0

package/dist/validation-D3yIUF-Z.d.cts

@@ -0,0 +1,167 @@
+import { Address } from 'viem';
+
+/**
+ * Non-interactive validation utilities for SDK
+ *
+ * These functions validate parameters without any interactive prompts.
+ * They either return the validated value or throw an error.
+ */
+
+/**
+ * Validate app name format
+ * @throws Error if name is invalid
+ */
+declare function validateAppName(name: string): void;
+/**
+ * Validate Docker image reference format
+ * @returns true if valid, error message string if invalid
+ */
+declare function validateImageReference(value: string): true | string;
+/**
+ * Validate image reference and throw if invalid
+ * @throws Error if image reference is invalid
+ */
+declare function assertValidImageReference(value: string): void;
+/**
+ * Extract app name from image reference
+ */
+declare function extractAppNameFromImage(imageRef: string): string;
+/**
+ * Validate that a file path exists
+ * @returns true if valid, error message string if invalid
+ */
+declare function validateFilePath(value: string): true | string;
+/**
+ * Validate file path and throw if invalid
+ * @throws Error if file path is invalid or doesn't exist
+ */
+declare function assertValidFilePath(value: string): void;
+/**
+ * Validate instance type SKU against available types
+ * @returns the validated SKU
+ * @throws Error if SKU is not in the available types list
+ */
+declare function validateInstanceTypeSKU(sku: string, availableTypes: Array<{
+    sku: string;
+}>): string;
+/**
+ * Validate private key format
+ * Matches Go's common.ValidatePrivateKey() function
+ */
+declare function validatePrivateKeyFormat(key: string): boolean;
+/**
+ * Validate private key and throw if invalid
+ * @throws Error if private key format is invalid
+ */
+declare function assertValidPrivateKey(key: string): void;
+/**
+ * Validate URL format
+ * @returns undefined if valid, error message string if invalid
+ */
+declare function validateURL(rawURL: string): string | undefined;
+/**
+ * Validate X/Twitter URL format
+ * @returns undefined if valid, error message string if invalid
+ */
+declare function validateXURL(rawURL: string): string | undefined;
+/**
+ * Validate description length
+ * @returns undefined if valid, error message string if invalid
+ */
+declare function validateDescription(description: string): string | undefined;
+/**
+ * Validate image file path
+ * @returns undefined if valid, error message string if invalid
+ */
+declare function validateImagePath(filePath: string): string | undefined;
+/**
+ * Validate and normalize app ID address
+ * @param appID - App ID (must be a valid address)
+ * @returns Normalized app address
+ * @throws Error if app ID is not a valid address
+ *
+ * Note: Name resolution should be handled by CLI before calling SDK functions.
+ * The SDK only accepts resolved addresses.
+ */
+declare function validateAppID(appID: string | Address): Address;
+type LogVisibility = "public" | "private" | "off";
+/**
+ * Validate and convert log visibility setting to internal format
+ * @param logVisibility - Log visibility setting
+ * @returns Object with logRedirect and publicLogs settings
+ * @throws Error if log visibility value is invalid
+ */
+declare function validateLogVisibility(logVisibility: LogVisibility): {
+    logRedirect: string;
+    publicLogs: boolean;
+};
+type ResourceUsageMonitoring = "enable" | "disable";
+/**
+ * Validate and convert resource usage monitoring setting to internal format
+ * @param resourceUsageMonitoring - Resource usage monitoring setting
+ * @returns The resourceUsageAllow value for the Dockerfile label ("always" or "never")
+ * @throws Error if resource usage monitoring value is invalid
+ */
+declare function validateResourceUsageMonitoring(resourceUsageMonitoring: ResourceUsageMonitoring | undefined): string;
+/**
+ * Sanitize string (HTML escape and trim)
+ */
+declare function sanitizeString(s: string): string;
+/**
+ * Sanitize URL (add https:// if missing, validate)
+ * @throws Error if URL is invalid after sanitization
+ */
+declare function sanitizeURL(rawURL: string): string;
+/**
+ * Sanitize X/Twitter URL (handle username-only input, normalize)
+ * @throws Error if URL is invalid after sanitization
+ */
+declare function sanitizeXURL(rawURL: string): string;
+interface DeployParams {
+    dockerfilePath?: string;
+    imageRef?: string;
+    appName: string;
+    envFilePath?: string;
+    instanceType: string;
+    logVisibility: LogVisibility;
+}
+/**
+ * Validate deploy parameters
+ * @throws Error if required parameters are missing or invalid
+ */
+declare function validateDeployParams(params: Partial<DeployParams>): void;
+interface UpgradeParams {
+    appID: string | Address;
+    dockerfilePath?: string;
+    imageRef?: string;
+    envFilePath?: string;
+    instanceType: string;
+    logVisibility: LogVisibility;
+}
+/**
+ * Validate upgrade parameters
+ * @throws Error if required parameters are missing or invalid
+ */
+declare function validateUpgradeParams(params: Partial<UpgradeParams>): void;
+interface CreateAppParams {
+    name: string;
+    language: string;
+    template?: string;
+    templateVersion?: string;
+}
+/**
+ * Validate create app parameters
+ * @throws Error if required parameters are missing or invalid
+ */
+declare function validateCreateAppParams(params: Partial<CreateAppParams>): void;
+interface LogsParams {
+    appID: string | Address;
+    watch?: boolean;
+}
+/**
+ * Validate logs parameters
+ * @throws Error if required parameters are missing or invalid
+ */
+declare function validateLogsParams(params: Partial<LogsParams>): void;
+
+export { type CreateAppParams as C, type DeployParams as D, type LogVisibility as L, type ResourceUsageMonitoring as R, type UpgradeParams as U, type LogsParams as a, assertValidImageReference as b, assertValidPrivateKey as c, sanitizeURL as d, extractAppNameFromImage as e, sanitizeXURL as f, validateAppName as g, validateCreateAppParams as h, validateDescription as i, validateImageReference as j, validateInstanceTypeSKU as k, validateLogVisibility as l, validateLogsParams as m, validatePrivateKeyFormat as n, validateURL as o, validateXURL as p, assertValidFilePath as q, validateDeployParams as r, sanitizeString as s, validateFilePath as t, validateImagePath as u, validateAppID as v, validateResourceUsageMonitoring as w, validateUpgradeParams as x };

package/dist/validation-D3yIUF-Z.d.ts

@@ -0,0 +1,167 @@
+import { Address } from 'viem';
+
+/**
+ * Non-interactive validation utilities for SDK
+ *
+ * These functions validate parameters without any interactive prompts.
+ * They either return the validated value or throw an error.
+ */
+
+/**
+ * Validate app name format
+ * @throws Error if name is invalid
+ */
+declare function validateAppName(name: string): void;
+/**
+ * Validate Docker image reference format
+ * @returns true if valid, error message string if invalid
+ */
+declare function validateImageReference(value: string): true | string;
+/**
+ * Validate image reference and throw if invalid
+ * @throws Error if image reference is invalid
+ */
+declare function assertValidImageReference(value: string): void;
+/**
+ * Extract app name from image reference
+ */
+declare function extractAppNameFromImage(imageRef: string): string;
+/**
+ * Validate that a file path exists
+ * @returns true if valid, error message string if invalid
+ */
+declare function validateFilePath(value: string): true | string;
+/**
+ * Validate file path and throw if invalid
+ * @throws Error if file path is invalid or doesn't exist
+ */
+declare function assertValidFilePath(value: string): void;
+/**
+ * Validate instance type SKU against available types
+ * @returns the validated SKU
+ * @throws Error if SKU is not in the available types list
+ */
+declare function validateInstanceTypeSKU(sku: string, availableTypes: Array<{
+    sku: string;
+}>): string;
+/**
+ * Validate private key format
+ * Matches Go's common.ValidatePrivateKey() function
+ */
+declare function validatePrivateKeyFormat(key: string): boolean;
+/**
+ * Validate private key and throw if invalid
+ * @throws Error if private key format is invalid
+ */
+declare function assertValidPrivateKey(key: string): void;
+/**
+ * Validate URL format
+ * @returns undefined if valid, error message string if invalid
+ */
+declare function validateURL(rawURL: string): string | undefined;
+/**
+ * Validate X/Twitter URL format
+ * @returns undefined if valid, error message string if invalid
+ */
+declare function validateXURL(rawURL: string): string | undefined;
+/**
+ * Validate description length
+ * @returns undefined if valid, error message string if invalid
+ */
+declare function validateDescription(description: string): string | undefined;
+/**
+ * Validate image file path
+ * @returns undefined if valid, error message string if invalid
+ */
+declare function validateImagePath(filePath: string): string | undefined;
+/**
+ * Validate and normalize app ID address
+ * @param appID - App ID (must be a valid address)
+ * @returns Normalized app address
+ * @throws Error if app ID is not a valid address
+ *
+ * Note: Name resolution should be handled by CLI before calling SDK functions.
+ * The SDK only accepts resolved addresses.
+ */
+declare function validateAppID(appID: string | Address): Address;
+type LogVisibility = "public" | "private" | "off";
+/**
+ * Validate and convert log visibility setting to internal format
+ * @param logVisibility - Log visibility setting
+ * @returns Object with logRedirect and publicLogs settings
+ * @throws Error if log visibility value is invalid
+ */
+declare function validateLogVisibility(logVisibility: LogVisibility): {
+    logRedirect: string;
+    publicLogs: boolean;
+};
+type ResourceUsageMonitoring = "enable" | "disable";
+/**
+ * Validate and convert resource usage monitoring setting to internal format
+ * @param resourceUsageMonitoring - Resource usage monitoring setting
+ * @returns The resourceUsageAllow value for the Dockerfile label ("always" or "never")
+ * @throws Error if resource usage monitoring value is invalid
+ */
+declare function validateResourceUsageMonitoring(resourceUsageMonitoring: ResourceUsageMonitoring | undefined): string;
+/**
+ * Sanitize string (HTML escape and trim)
+ */
+declare function sanitizeString(s: string): string;
+/**
+ * Sanitize URL (add https:// if missing, validate)
+ * @throws Error if URL is invalid after sanitization
+ */
+declare function sanitizeURL(rawURL: string): string;
+/**
+ * Sanitize X/Twitter URL (handle username-only input, normalize)
+ * @throws Error if URL is invalid after sanitization
+ */
+declare function sanitizeXURL(rawURL: string): string;
+interface DeployParams {
+    dockerfilePath?: string;
+    imageRef?: string;
+    appName: string;
+    envFilePath?: string;
+    instanceType: string;
+    logVisibility: LogVisibility;
+}
+/**
+ * Validate deploy parameters
+ * @throws Error if required parameters are missing or invalid
+ */
+declare function validateDeployParams(params: Partial<DeployParams>): void;
+interface UpgradeParams {
+    appID: string | Address;
+    dockerfilePath?: string;
+    imageRef?: string;
+    envFilePath?: string;
+    instanceType: string;
+    logVisibility: LogVisibility;
+}
+/**
+ * Validate upgrade parameters
+ * @throws Error if required parameters are missing or invalid
+ */
+declare function validateUpgradeParams(params: Partial<UpgradeParams>): void;
+interface CreateAppParams {
+    name: string;
+    language: string;
+    template?: string;
+    templateVersion?: string;
+}
+/**
+ * Validate create app parameters
+ * @throws Error if required parameters are missing or invalid
+ */
+declare function validateCreateAppParams(params: Partial<CreateAppParams>): void;
+interface LogsParams {
+    appID: string | Address;
+    watch?: boolean;
+}
+/**
+ * Validate logs parameters
+ * @throws Error if required parameters are missing or invalid
+ */
+declare function validateLogsParams(params: Partial<LogsParams>): void;
+
+export { type CreateAppParams as C, type DeployParams as D, type LogVisibility as L, type ResourceUsageMonitoring as R, type UpgradeParams as U, type LogsParams as a, assertValidImageReference as b, assertValidPrivateKey as c, sanitizeURL as d, extractAppNameFromImage as e, sanitizeXURL as f, validateAppName as g, validateCreateAppParams as h, validateDescription as i, validateImageReference as j, validateInstanceTypeSKU as k, validateLogVisibility as l, validateLogsParams as m, validatePrivateKeyFormat as n, validateURL as o, validateXURL as p, assertValidFilePath as q, validateDeployParams as r, sanitizeString as s, validateFilePath as t, validateImagePath as u, validateAppID as v, validateResourceUsageMonitoring as w, validateUpgradeParams as x };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@layr-labs/ecloud-sdk",
-  "version": "1.0.0-devep7",
+  "version": "1.0.0",
   "type": "module",
   "main": "dist/index.js",
   "module": "dist/index.js",
@@ -39,14 +39,13 @@
     }
   },
   "scripts": {
-    "build": "pnpm run fetch:runtime-binaries && tsup",
-    "build:dev": "BUILD_TYPE=dev pnpm run fetch:runtime-binaries && tsup",
+    "build": "tsup",
+    "build:dev": "BUILD_TYPE=dev tsup",
     "prepublishOnly": "cp ../../README.md .",
     "lint": "eslint .",
     "format": "prettier --check .",
     "format:fix": "prettier --write .",
-    "typecheck": "tsc --noEmit",
-    "fetch:runtime-binaries": "pnpm -w exec tsx packages/sdk/scripts/fetch-runtime-binaries.ts"
+    "typecheck": "tsc --noEmit"
   },
   "dependencies": {
     "@inquirer/prompts": "7.10.1",

package/dist/compute-2WkiO-d8.d.ts

@@ -1,194 +0,0 @@
-import { Address, WalletClient, PublicClient, Hex } from 'viem';
-import { H as Logger, E as EnvironmentConfig, n as DeployAppOpts, A as AppId, ab as UpgradeAppOpts, R as PrepareDeployOpts, V as PreparedDeploy, G as GasEstimate, Q as PrepareDeployFromVerifiableBuildOpts, v as ExecuteDeployResult, U as PrepareUpgradeOpts, Y as PreparedUpgrade, T as PrepareUpgradeFromVerifiableBuildOpts, x as ExecuteUpgradeResult, c as AppProfile, d as AppProfileResponse, L as LifecycleOpts, b as AppConfig } from './index-XhjPvHIY.js';
-
-/**
- * Create command
- *
- * Creates a new app project from a template
- *
- * NOTE: This SDK function is non-interactive. All required parameters must be
- * provided explicitly. Use the CLI for interactive parameter collection.
- */
-
-/**
- * Required create app options for SDK (non-interactive)
- */
-interface SDKCreateAppOpts {
-    /** Project name - required */
-    name: string;
-    /** Programming language - required (typescript, golang, rust, python) */
-    language: string;
-    /** Template name/category (e.g., "minimal") or custom template URL - optional, defaults to first available */
-    template?: string;
-    /** Template version/ref - optional */
-    templateVersion?: string;
-    /** Verbose output - optional */
-    verbose?: boolean;
-    /** Skip telemetry (used when called from CLI) - optional */
-    skipTelemetry?: boolean;
-}
-/**
- * Legacy interface for backward compatibility
- * @deprecated Use SDKCreateAppOpts instead
- */
-interface CreateAppOpts {
-    name?: string;
-    language?: string;
-    template?: string;
-    templateVersion?: string;
-    verbose?: boolean;
-    skipTelemetry?: boolean;
-}
-declare const PRIMARY_LANGUAGES: string[];
-/**
- * Get available template categories for a language
- */
-declare function getAvailableTemplates(language: string): Promise<Array<{
-    name: string;
-    description: string;
-}>>;
-/**
- * Create a new app project from template
- *
- * This function is non-interactive and requires all parameters to be provided explicitly.
- *
- * @param options - Required options including name and language
- * @param logger - Optional logger instance
- * @throws Error if required parameters are missing or invalid
- */
-declare function createApp(options: SDKCreateAppOpts | CreateAppOpts, logger?: Logger): Promise<void>;
-
-/**
- * Logs command
- *
- * View app logs with optional watch mode
- *
- * NOTE: This SDK function is non-interactive. All required parameters must be
- * provided explicitly. Use the CLI for interactive parameter collection.
- */
-
-/**
- * Required logs options for SDK (non-interactive)
- */
-interface LogsOptions {
-    /** App ID (address) or app name - required */
-    appID: string | Address;
-    /** Watch logs continuously - optional */
-    watch?: boolean;
-    /** Client ID for API requests - optional */
-    clientId?: string;
-}
-/**
- * View app logs
- *
- * This function is non-interactive and requires appID to be provided explicitly.
- *
- * @param options - Required options including appID
- * @param walletClient - Viem WalletClient for signing requests
- * @param publicClient - Viem PublicClient for chain queries
- * @param environmentConfig - Environment configuration
- * @param logger - Optional logger instance
- * @param skipTelemetry - Skip telemetry (for CLI usage)
- * @throws Error if appID is missing or invalid
- */
-declare function logs(options: LogsOptions, walletClient: WalletClient, publicClient: PublicClient, environmentConfig: EnvironmentConfig, logger?: Logger, skipTelemetry?: boolean): Promise<void>;
-
-/**
- * Main App namespace entry point
- */
-
-/**
- * Encode start app call data for gas estimation
- */
-declare function encodeStartAppData(appId: AppId): Hex;
-/**
- * Encode stop app call data for gas estimation
- */
-declare function encodeStopAppData(appId: AppId): Hex;
-/**
- * Encode terminate app call data for gas estimation
- */
-declare function encodeTerminateAppData(appId: AppId): Hex;
-interface AppModule {
-    create: (opts: CreateAppOpts) => Promise<void>;
-    deploy: (opts: DeployAppOpts) => Promise<{
-        appId: AppId;
-        tx: Hex;
-        appName: string;
-        imageRef: string;
-        ipAddress?: string;
-    }>;
-    upgrade: (appId: AppId, opts: UpgradeAppOpts) => Promise<{
-        tx: Hex;
-        appId: AppId;
-        imageRef: string;
-    }>;
-    prepareDeploy: (opts: PrepareDeployOpts) => Promise<{
-        prepared: PreparedDeploy;
-        gasEstimate: GasEstimate;
-    }>;
-    prepareDeployFromVerifiableBuild: (opts: PrepareDeployFromVerifiableBuildOpts) => Promise<{
-        prepared: PreparedDeploy;
-        gasEstimate: GasEstimate;
-    }>;
-    executeDeploy: (prepared: PreparedDeploy, gas?: GasEstimate) => Promise<ExecuteDeployResult>;
-    watchDeployment: (appId: AppId) => Promise<string | undefined>;
-    prepareUpgrade: (appId: AppId, opts: PrepareUpgradeOpts) => Promise<{
-        prepared: PreparedUpgrade;
-        gasEstimate: GasEstimate;
-    }>;
-    prepareUpgradeFromVerifiableBuild: (appId: AppId, opts: PrepareUpgradeFromVerifiableBuildOpts) => Promise<{
-        prepared: PreparedUpgrade;
-        gasEstimate: GasEstimate;
-    }>;
-    executeUpgrade: (prepared: PreparedUpgrade, gas?: GasEstimate) => Promise<ExecuteUpgradeResult>;
-    watchUpgrade: (appId: AppId) => Promise<void>;
-    setProfile: (appId: AppId, profile: AppProfile) => Promise<AppProfileResponse>;
-    logs: (opts: LogsOptions) => Promise<void>;
-    start: (appId: AppId, opts?: LifecycleOpts) => Promise<{
-        tx: Hex | false;
-    }>;
-    stop: (appId: AppId, opts?: LifecycleOpts) => Promise<{
-        tx: Hex | false;
-    }>;
-    terminate: (appId: AppId, opts?: LifecycleOpts) => Promise<{
-        tx: Hex | false;
-    }>;
-    getBillingType: (appId: AppId) => Promise<number>;
-    getAppsByBillingAccount: (account: Address, offset: bigint, limit: bigint) => Promise<{
-        apps: Address[];
-        appConfigs: AppConfig[];
-    }>;
-    isDelegated: () => Promise<boolean>;
-    undelegate: () => Promise<{
-        tx: Hex | false;
-    }>;
-}
-interface AppModuleConfig {
-    verbose?: boolean;
-    walletClient: WalletClient;
-    publicClient: PublicClient;
-    environment: string;
-    clientId?: string;
-    skipTelemetry?: boolean;
-}
-declare function createAppModule(ctx: AppModuleConfig): AppModule;
-
-/**
- * Main Compute namespace entry point
- */
-
-interface ComputeModule {
-    app: AppModule;
-}
-interface ComputeModuleConfig {
-    verbose?: boolean;
-    walletClient: WalletClient;
-    publicClient: PublicClient;
-    environment: string;
-    clientId?: string;
-    skipTelemetry?: boolean;
-}
-declare function createComputeModule(config: ComputeModuleConfig): ComputeModule;
-
-export { type AppModule as A, type ComputeModule as C, type LogsOptions as L, PRIMARY_LANGUAGES as P, type SDKCreateAppOpts as S, type ComputeModuleConfig as a, type CreateAppOpts as b, createApp as c, createComputeModule as d, encodeStartAppData as e, encodeStopAppData as f, encodeTerminateAppData as g, getAvailableTemplates as h, type AppModuleConfig as i, createAppModule as j, logs as l };