forge-fsql 1.0.3 → 1.0.4

package/README.md

@@ -15,8 +15,17 @@ Interactive command-line interface for querying Atlassian Forge SQL databases vi
 
 ### In Your Forge Project
 
-```bash
-pnpm add -D forge-fsql
+```sh
+npm install -D forge-fsql
+
+# add webtrigger to manifest.yml and a wrapper module for the corresponding function
+node_modules/.bin/fsql-setup
+
+# deploy with the webtrigger
+forge deploy
+
+# get trigger url:
+forge webtrigger create --product Confluence --site <site>.atlassian.net --functionKey execute-sql
 ```
 
 Add to your `package.json` scripts:
@@ -24,37 +33,20 @@ Add to your `package.json` scripts:
 ```json
 {
   "scripts": {
-    "sql": "fsql"
+    "fsql": "fsql"
   }
 }
 ```
 
-### Global Installation
-
-```bash
-pnpm add -g forge-fsql
-```
-
-## Configuration
-
-Create a `.env` file in your project root:
-
-```bash
-FORGE_SQL_URL=https://your-trigger-url.forge.atlassian.com/sql
-```
-
-Or pass via command line:
-
-```bash
-fsql --url https://your-trigger-url.com
-```
+## Run
 
-## Usage
+```sh
+# set URL using value from previous step
+export FORGE_SQL_URL=https://your-trigger-url.com
 
-```bash
-# If installed in project
-pnpm sql
+# run fsql!
+npm run fsql
 
-# If installed globally
-fsql
+# or
+npm run fsql --url https://your-trigger-url.com
 ```

package/dist/cjs/cli.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/cjs/client.d.ts

@@ -0,0 +1,16 @@
+export interface SqlResult {
+    rows?: any[];
+    affectedRows?: number;
+    error?: string;
+    metadata?: Record<string, any>;
+}
+export interface ClientConfig {
+    url: string;
+    timeout?: number;
+}
+export declare class ForgeClient {
+    private config;
+    constructor(config: ClientConfig);
+    execute(sql: string): Promise<SqlResult>;
+    testConnection(): Promise<boolean>;
+}

package/dist/cjs/commands.d.ts

@@ -0,0 +1,12 @@
+import { ForgeClient } from "./client.js";
+export interface Command {
+    name: string;
+    description: string;
+    execute: (client: ForgeClient, args?: string) => Promise<string>;
+}
+export declare const specialCommands: Command[];
+export declare function parseCommand(input: string): {
+    command?: Command;
+    args?: string;
+    isSpecial: boolean;
+};

package/dist/cjs/execute-sql.d.ts

@@ -0,0 +1,12 @@
+declare const executeSql: (req: {
+    body: string;
+}) => Promise<ReturnType<typeof getHttpResponse>>;
+declare function getHttpResponse(statusCode: number, body: Record<string, unknown>): {
+    headers: {
+        "Content-Type": string[];
+    };
+    statusCode: number;
+    statusText: string;
+    body: string;
+};
+export { executeSql };

package/dist/cjs/formatter.d.ts

@@ -0,0 +1,9 @@
+import { SqlResult } from "./client.js";
+export declare class ResultFormatter {
+    static formatTable(rows: any[]): string;
+    static formatValue(value: any): string;
+    static formatError(error: string): string;
+    static formatSuccess(message: string): string;
+    static formatResult(result: SqlResult): string;
+    static formatQueryTime(ms: number): string;
+}

package/dist/cjs/history.d.ts

@@ -0,0 +1,10 @@
+export declare class History {
+    private historyFile;
+    private history;
+    private maxSize;
+    constructor(maxSize?: number);
+    private load;
+    save(): void;
+    add(command: string): void;
+    getAll(): string[];
+}

package/dist/cjs/index.d.ts

@@ -0,0 +1,18 @@
+export { ForgeClient } from "./client.js";
+export { executeSql } from "./execute-sql.js";
+interface CliConfig {
+    url?: string;
+}
+export declare class ForgeSqlCli {
+    private client;
+    private rl;
+    private history;
+    private multilineBuffer;
+    private isMultiline;
+    constructor(config: CliConfig);
+    private setupHandlers;
+    private handleLine;
+    private executeCommand;
+    private handleClose;
+    start(): Promise<void>;
+}

package/dist/cli.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/client.d.ts

@@ -0,0 +1,16 @@
+export interface SqlResult {
+    rows?: any[];
+    affectedRows?: number;
+    error?: string;
+    metadata?: Record<string, any>;
+}
+export interface ClientConfig {
+    url: string;
+    timeout?: number;
+}
+export declare class ForgeClient {
+    private config;
+    constructor(config: ClientConfig);
+    execute(sql: string): Promise<SqlResult>;
+    testConnection(): Promise<boolean>;
+}

package/dist/commands.d.ts

@@ -0,0 +1,12 @@
+import { ForgeClient } from "./client.js";
+export interface Command {
+    name: string;
+    description: string;
+    execute: (client: ForgeClient, args?: string) => Promise<string>;
+}
+export declare const specialCommands: Command[];
+export declare function parseCommand(input: string): {
+    command?: Command;
+    args?: string;
+    isSpecial: boolean;
+};

package/dist/execute-sql.d.ts

@@ -0,0 +1,12 @@
+declare const executeSql: (req: {
+    body: string;
+}) => Promise<ReturnType<typeof getHttpResponse>>;
+declare function getHttpResponse(statusCode: number, body: Record<string, unknown>): {
+    headers: {
+        "Content-Type": string[];
+    };
+    statusCode: number;
+    statusText: string;
+    body: string;
+};
+export { executeSql };

package/dist/formatter.d.ts

@@ -0,0 +1,9 @@
+import { SqlResult } from "./client.js";
+export declare class ResultFormatter {
+    static formatTable(rows: any[]): string;
+    static formatValue(value: any): string;
+    static formatError(error: string): string;
+    static formatSuccess(message: string): string;
+    static formatResult(result: SqlResult): string;
+    static formatQueryTime(ms: number): string;
+}

package/dist/history.d.ts

@@ -0,0 +1,10 @@
+export declare class History {
+    private historyFile;
+    private history;
+    private maxSize;
+    constructor(maxSize?: number);
+    private load;
+    save(): void;
+    add(command: string): void;
+    getAll(): string[];
+}

package/dist/index.d.ts

@@ -0,0 +1,18 @@
+export { ForgeClient } from "./client.js";
+export { executeSql } from "./execute-sql.js";
+interface CliConfig {
+    url?: string;
+}
+export declare class ForgeSqlCli {
+    private client;
+    private rl;
+    private history;
+    private multilineBuffer;
+    private isMultiline;
+    constructor(config: CliConfig);
+    private setupHandlers;
+    private handleLine;
+    private executeCommand;
+    private handleClose;
+    start(): Promise<void>;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "forge-fsql",
-  "version": "1.0.3",
+  "version": "1.0.4",
   "type": "module",
   "description": "Interactive SQL CLI for Atlassian Forge SQL via web triggers",
   "main": "dist/cjs/index.js",
@@ -12,9 +12,14 @@
   },
   "exports": {
     ".": {
-      "import": "./dist/index.js",
-      "require": "./dist/cjs/index.js",
-      "types": "./dist/index.d.ts"
+      "import": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      },
+      "require": {
+        "types": "./dist/cjs/index.d.ts",
+        "default": "./dist/cjs/index.js"
+      }
     }
   },
   "files": [