@smartlyqofficial/cli 0.1.0

package/dist/index.d.cts

@@ -0,0 +1,90 @@
+import { Command } from 'commander';
+import { ClientOptions } from '@smartlyqofficial/node';
+
+/** One CLI command: `smartlyq <resource> <kebabMethod> [pathArgs...]` -> SDK `sq[resourceKey][methodName](...)`. */
+interface CommandDescriptor {
+    resourceKey: string;
+    methodName: string;
+    kebabMethod: string;
+    /** camelCase path parameter names, in call order. */
+    pathParams: string[];
+    hasBody: boolean;
+    bodyRequired: boolean;
+    hasQuery: boolean;
+    summary: string;
+    httpMethod: string;
+    path: string;
+}
+declare const commands: CommandDescriptor[];
+
+type OutputMode = 'json' | 'pretty';
+/**
+ * Parses a `--data` value into a request body.
+ * Accepts inline JSON, `@file.json` to read a file, or `-` to read stdin.
+ */
+declare function parseData(raw: string, readStdin?: () => string): unknown;
+/**
+ * Parses a `--query` value: either `k=v&k2=v2` pairs or a raw JSON object.
+ * Repeated keys in pair form become arrays.
+ */
+declare function parseQuery(raw: string): Record<string, unknown>;
+/** Renders a successful result. `pretty` (default) is colorless indented JSON. */
+declare function formatOutput(result: unknown, mode?: OutputMode): string;
+/** Renders any thrown error as a single stderr line. */
+declare function formatError(err: unknown): string;
+
+/** Config directory (`~/.smartlyq`, overridable via SMARTLYQ_CONFIG_DIR for tests). */
+declare function configDir(): string;
+declare function configPath(): string;
+/** The API key stored by `smartlyq login`, if any. */
+declare function readStoredApiKey(): string | undefined;
+/** Persists the API key with owner-only permissions. */
+declare function storeApiKey(apiKey: string): string;
+/** Deletes the stored config. Returns true if a file was removed. */
+declare function deleteStoredApiKey(): boolean;
+/** Resolves the API key: flag > SMARTLYQ_API_KEY env > config file. */
+declare function resolveApiKey(flagValue?: string): string | undefined;
+
+/** Prompts on the terminal without echoing the typed characters. */
+declare function promptHidden(prompt: string): Promise<string>;
+declare function runLogin(): Promise<void>;
+declare function runLogout(): void;
+
+/** Shared naming helpers for the CLI and its generators. */
+/** Renders a camelCase SDK name as the kebab-case CLI name (createPost -> create-post). */
+declare function kebabCase(name: string): string;
+/** Error for user-facing CLI failures (bad input, missing key). Always exits 1. */
+declare class CliError extends Error {
+    constructor(message: string);
+}
+
+/**
+ * SmartlyQ CLI: builds the commander tree from the generated command
+ * descriptors and dispatches through the official Node.js SDK.
+ *
+ *   smartlyq <resource> <method> [pathArgs...] [flags]
+ *   smartlyq social create-post --data '{"text":"hi","account_ids":["acc_1"]}'
+ */
+
+/** Flag values collected by commander for a resource/method command. */
+interface DispatchFlags {
+    data?: string;
+    query?: string;
+    profile?: string;
+    idempotencyKey?: string;
+    apiKey?: string;
+    baseUrl?: string;
+    timeout?: string | number;
+    output?: OutputMode;
+}
+/**
+ * Executes one command descriptor against the SDK and returns the API result.
+ * `overrides` lets tests inject a fake fetch via the SDK's ClientOptions.
+ */
+declare function dispatch(desc: CommandDescriptor, pathArgs: string[], flags?: DispatchFlags, overrides?: Partial<ClientOptions>): Promise<unknown>;
+/** Builds the full commander program from the generated descriptors. */
+declare function buildProgram(): Command;
+/** CLI entry point. */
+declare function main(argv?: string[]): Promise<void>;
+
+export { CliError, type CommandDescriptor, type DispatchFlags, type OutputMode, buildProgram, commands, configDir, configPath, deleteStoredApiKey, dispatch, formatError, formatOutput, kebabCase, main, parseData, parseQuery, promptHidden, readStoredApiKey, resolveApiKey, runLogin, runLogout, storeApiKey };

package/dist/index.d.ts

@@ -0,0 +1,90 @@
+import { Command } from 'commander';
+import { ClientOptions } from '@smartlyqofficial/node';
+
+/** One CLI command: `smartlyq <resource> <kebabMethod> [pathArgs...]` -> SDK `sq[resourceKey][methodName](...)`. */
+interface CommandDescriptor {
+    resourceKey: string;
+    methodName: string;
+    kebabMethod: string;
+    /** camelCase path parameter names, in call order. */
+    pathParams: string[];
+    hasBody: boolean;
+    bodyRequired: boolean;
+    hasQuery: boolean;
+    summary: string;
+    httpMethod: string;
+    path: string;
+}
+declare const commands: CommandDescriptor[];
+
+type OutputMode = 'json' | 'pretty';
+/**
+ * Parses a `--data` value into a request body.
+ * Accepts inline JSON, `@file.json` to read a file, or `-` to read stdin.
+ */
+declare function parseData(raw: string, readStdin?: () => string): unknown;
+/**
+ * Parses a `--query` value: either `k=v&k2=v2` pairs or a raw JSON object.
+ * Repeated keys in pair form become arrays.
+ */
+declare function parseQuery(raw: string): Record<string, unknown>;
+/** Renders a successful result. `pretty` (default) is colorless indented JSON. */
+declare function formatOutput(result: unknown, mode?: OutputMode): string;
+/** Renders any thrown error as a single stderr line. */
+declare function formatError(err: unknown): string;
+
+/** Config directory (`~/.smartlyq`, overridable via SMARTLYQ_CONFIG_DIR for tests). */
+declare function configDir(): string;
+declare function configPath(): string;
+/** The API key stored by `smartlyq login`, if any. */
+declare function readStoredApiKey(): string | undefined;
+/** Persists the API key with owner-only permissions. */
+declare function storeApiKey(apiKey: string): string;
+/** Deletes the stored config. Returns true if a file was removed. */
+declare function deleteStoredApiKey(): boolean;
+/** Resolves the API key: flag > SMARTLYQ_API_KEY env > config file. */
+declare function resolveApiKey(flagValue?: string): string | undefined;
+
+/** Prompts on the terminal without echoing the typed characters. */
+declare function promptHidden(prompt: string): Promise<string>;
+declare function runLogin(): Promise<void>;
+declare function runLogout(): void;
+
+/** Shared naming helpers for the CLI and its generators. */
+/** Renders a camelCase SDK name as the kebab-case CLI name (createPost -> create-post). */
+declare function kebabCase(name: string): string;
+/** Error for user-facing CLI failures (bad input, missing key). Always exits 1. */
+declare class CliError extends Error {
+    constructor(message: string);
+}
+
+/**
+ * SmartlyQ CLI: builds the commander tree from the generated command
+ * descriptors and dispatches through the official Node.js SDK.
+ *
+ *   smartlyq <resource> <method> [pathArgs...] [flags]
+ *   smartlyq social create-post --data '{"text":"hi","account_ids":["acc_1"]}'
+ */
+
+/** Flag values collected by commander for a resource/method command. */
+interface DispatchFlags {
+    data?: string;
+    query?: string;
+    profile?: string;
+    idempotencyKey?: string;
+    apiKey?: string;
+    baseUrl?: string;
+    timeout?: string | number;
+    output?: OutputMode;
+}
+/**
+ * Executes one command descriptor against the SDK and returns the API result.
+ * `overrides` lets tests inject a fake fetch via the SDK's ClientOptions.
+ */
+declare function dispatch(desc: CommandDescriptor, pathArgs: string[], flags?: DispatchFlags, overrides?: Partial<ClientOptions>): Promise<unknown>;
+/** Builds the full commander program from the generated descriptors. */
+declare function buildProgram(): Command;
+/** CLI entry point. */
+declare function main(argv?: string[]): Promise<void>;
+
+export { CliError, type CommandDescriptor, type DispatchFlags, type OutputMode, buildProgram, commands, configDir, configPath, deleteStoredApiKey, dispatch, formatError, formatOutput, kebabCase, main, parseData, parseQuery, promptHidden, readStoredApiKey, resolveApiKey, runLogin, runLogout, storeApiKey };