@mirage-cli/dataforseo-cli 0.1.0

package/dist/lib/auth.d.ts

@@ -0,0 +1,8 @@
+export type Credentials = {
+    login: string;
+    password: string;
+};
+export declare function configPath(): string;
+export declare function loadCredentials(): Credentials;
+export declare function saveCredentials(creds: Credentials): string;
+export declare function basicAuthHeader({ login, password }: Credentials): string;

package/dist/lib/client.d.ts

@@ -0,0 +1,33 @@
+export type DfsResponse = {
+    status_code?: number;
+    status_message?: string;
+    cost?: number;
+    tasks?: Array<{
+        status_code?: number;
+        status_message?: string;
+        result?: unknown;
+        [k: string]: unknown;
+    }>;
+    [k: string]: unknown;
+};
+export type CallOptions = {
+    /** Wrap a single task object as `[task]` for endpoints that take an array body. Default: true. */
+    wrapAsTaskArray?: boolean;
+    /** Override base URL (rare). */
+    baseUrl?: string;
+    /** Request timeout in ms (default 120_000). */
+    timeoutMs?: number;
+};
+/**
+ * Call any DataForSEO endpoint. Path may be absolute (`/v3/serp/...`)
+ * or relative (`serp/...`); leading `v3/` is added if missing.
+ */
+export declare function call(path: string, body: unknown, opts?: CallOptions): Promise<DfsResponse>;
+/** GET helper for the few `GET` endpoints (locations, languages, user, errors). */
+export declare function get(path: string, opts?: CallOptions): Promise<DfsResponse>;
+/**
+ * Extract result rows from a DataForSEO response.
+ * DataForSEO nests results as `tasks[*].result[*]` — most useful data is the
+ * first task's result array, which itself often contains an `items` field.
+ */
+export declare function extractItems(resp: DfsResponse): unknown[];

package/dist/lib/output.d.ts

@@ -0,0 +1,11 @@
+import type { DfsResponse } from "./client.ts";
+export type OutputFormat = "json" | "ndjson" | "table" | "csv" | "raw";
+export type RenderOptions = {
+    format: OutputFormat;
+    /** When true, emit the full untouched response. Otherwise emit `extractItems(resp)`. */
+    full?: boolean;
+    /** Columns for table/csv. If omitted, derived from the first row. */
+    columns?: string[];
+};
+export declare function render(resp: DfsResponse, opts: RenderOptions): string;
+export declare function emitCost(resp: DfsResponse): void;

package/dist/lib/spec.d.ts

@@ -0,0 +1,15 @@
+export type EndpointMethod = "get" | "post";
+export type EndpointInfo = {
+    path: string;
+    method: EndpointMethod;
+    operationId?: string;
+    tag?: string;
+    description?: string;
+    /** First example body the spec ships with, useful for `dfs raw --example`. */
+    example?: unknown;
+    /** Doc URL extracted from the description, when present. */
+    docUrl?: string;
+};
+export declare function loadEndpoints(): EndpointInfo[];
+export declare function findEndpoint(path: string): EndpointInfo | undefined;
+export declare function searchEndpoints(query: string, tag?: string): EndpointInfo[];

package/package.json

@@ -0,0 +1,61 @@
+{
+  "name": "@mirage-cli/dataforseo-cli",
+  "version": "0.1.0",
+  "description": "Ergonomic CLI wrapper around the DataForSEO API (curated commands + raw escape hatch).",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/alexbruf/mirage-cli.git",
+    "directory": "packages/dataforseo-cli"
+  },
+  "bugs": {
+    "url": "https://github.com/alexbruf/mirage-cli/issues"
+  },
+  "homepage": "https://github.com/alexbruf/mirage-cli/tree/main/packages/dataforseo-cli#readme",
+  "type": "module",
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "bun": "./src/index.ts",
+      "import": "./dist/index.js"
+    },
+    "./cli": {
+      "types": "./dist/dfs.d.ts",
+      "bun": "./src/dfs.ts",
+      "import": "./dist/dfs.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "dist/",
+    "src/spec/index.json",
+    "README.md"
+  ],
+  "bin": {
+    "dfs": "./dist/dfs.js",
+    "dataforseo": "./dist/dfs.js"
+  },
+  "scripts": {
+    "dev": "bun run src/dfs.ts",
+    "spec:build": "bun run scripts/build-spec-index.ts",
+    "spec:refresh": "bun run scripts/refresh-spec.ts && bun run scripts/build-spec-index.ts",
+    "prebuild": "bun run scripts/build-spec-index.ts",
+    "build": "bun build src/dfs.ts src/index.ts --target=node --outdir=dist --minify && bun run scripts/postbuild.ts && bun run scripts/build-types.ts",
+    "compile": "bun build src/dfs.ts --compile --outfile=bin/dfs",
+    "test": "bun test --reporter=dots",
+    "typecheck": "tsc --noEmit"
+  },
+  "dependencies": {
+    "commander": "^12.1.0"
+  },
+  "devDependencies": {
+    "@struktoai/mirage-core": "^0.0.1",
+    "yaml": "^2.6.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}