chowbea-axios 1.0.0

package/oclif.manifest.json

@@ -0,0 +1,556 @@
+{
+  "commands": {
+    "diff": {
+      "aliases": [],
+      "args": {},
+      "description": "Preview API changes before regenerating.\n\nCompares your cached spec with the remote (or a local file) and shows:\n- New endpoints added\n- Endpoints removed\n- Endpoints modified\n\nUseful to see what changed before running fetch.",
+      "examples": [
+        {
+          "command": "<%= config.bin %> diff",
+          "description": "Compare cached spec with remote endpoint"
+        },
+        {
+          "command": "<%= config.bin %> diff --spec ./new-openapi.json",
+          "description": "Compare cached spec with local file"
+        }
+      ],
+      "flags": {
+        "config": {
+          "char": "c",
+          "description": "Path to api.config.toml",
+          "name": "config",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "spec": {
+          "char": "s",
+          "description": "Path to new OpenAPI spec file to compare against",
+          "name": "spec",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "quiet": {
+          "char": "q",
+          "description": "Suppress non-error output",
+          "name": "quiet",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "verbose": {
+          "char": "v",
+          "description": "Show detailed output",
+          "name": "verbose",
+          "allowNo": false,
+          "type": "boolean"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "diff",
+      "pluginAlias": "chowbea-axios",
+      "pluginName": "chowbea-axios",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "diff.js"
+      ]
+    },
+    "fetch": {
+      "aliases": [],
+      "args": {},
+      "description": "Fetch OpenAPI spec and generate TypeScript types + operations.\n\nDownloads the spec from your configured endpoint (or local file),\ncaches it, and generates api.types.ts and api.operations.ts.\n\nSkips regeneration if spec hasn't changed (use --force to override).\nFalls back to cached spec on network failure.",
+      "examples": [
+        {
+          "command": "<%= config.bin %> fetch",
+          "description": "Fetch from configured endpoint, generate if changed"
+        },
+        {
+          "command": "<%= config.bin %> fetch --force",
+          "description": "Force regeneration even if spec unchanged"
+        },
+        {
+          "command": "<%= config.bin %> fetch --spec-file ./openapi.json",
+          "description": "Use local spec file instead of remote"
+        },
+        {
+          "command": "<%= config.bin %> fetch --dry-run",
+          "description": "Preview what would be generated"
+        },
+        {
+          "command": "<%= config.bin %> fetch --types-only",
+          "description": "Generate only TypeScript types"
+        }
+      ],
+      "flags": {
+        "config": {
+          "char": "c",
+          "description": "Path to api.config.toml",
+          "name": "config",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "endpoint": {
+          "char": "e",
+          "description": "Override API endpoint URL",
+          "name": "endpoint",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "spec-file": {
+          "char": "s",
+          "description": "Use local spec file instead of fetching from remote",
+          "name": "spec-file",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "force": {
+          "char": "f",
+          "description": "Force regeneration even if spec hasn't changed",
+          "name": "force",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "dry-run": {
+          "char": "n",
+          "description": "Show what would be generated without writing files",
+          "name": "dry-run",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "types-only": {
+          "description": "Generate only TypeScript types (skip operations)",
+          "name": "types-only",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "operations-only": {
+          "description": "Generate only operations (skip types)",
+          "name": "operations-only",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "quiet": {
+          "char": "q",
+          "description": "Suppress non-error output",
+          "name": "quiet",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "verbose": {
+          "char": "v",
+          "description": "Show detailed output",
+          "name": "verbose",
+          "allowNo": false,
+          "type": "boolean"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "fetch",
+      "pluginAlias": "chowbea-axios",
+      "pluginName": "chowbea-axios",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "fetch.js"
+      ]
+    },
+    "generate": {
+      "aliases": [],
+      "args": {},
+      "description": "Generate TypeScript types and operations from cached spec.\n\nUses the locally cached openapi.json (from a previous fetch).\nRun 'fetch' first if you don't have a cached spec.\n\nGenerates:\n- api.types.ts   - TypeScript types from OpenAPI schemas\n- api.operations.ts - Typed operation functions",
+      "examples": [
+        {
+          "command": "<%= config.bin %> generate",
+          "description": "Regenerate from cached spec"
+        },
+        {
+          "command": "<%= config.bin %> generate --dry-run",
+          "description": "Preview what would be generated"
+        },
+        {
+          "command": "<%= config.bin %> generate --types-only",
+          "description": "Generate only api.types.ts"
+        },
+        {
+          "command": "<%= config.bin %> generate --operations-only",
+          "description": "Generate only api.operations.ts"
+        },
+        {
+          "command": "<%= config.bin %> generate --spec-file ./openapi.json",
+          "description": "Generate from specific local file"
+        }
+      ],
+      "flags": {
+        "config": {
+          "char": "c",
+          "description": "Path to api.config.toml",
+          "name": "config",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "spec-file": {
+          "char": "s",
+          "description": "Use local spec file (copies to cache before generating)",
+          "name": "spec-file",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "dry-run": {
+          "char": "n",
+          "description": "Show what would be generated without writing files",
+          "name": "dry-run",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "types-only": {
+          "description": "Generate only TypeScript types (skip operations)",
+          "name": "types-only",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "operations-only": {
+          "description": "Generate only operations (skip types)",
+          "name": "operations-only",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "quiet": {
+          "char": "q",
+          "description": "Suppress non-error output",
+          "name": "quiet",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "verbose": {
+          "char": "v",
+          "description": "Show detailed output",
+          "name": "verbose",
+          "allowNo": false,
+          "type": "boolean"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "generate",
+      "pluginAlias": "chowbea-axios",
+      "pluginName": "chowbea-axios",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "generate.js"
+      ]
+    },
+    "init": {
+      "aliases": [],
+      "args": {},
+      "description": "Full project setup - one command to get started.\n\nPrompts for your API endpoint, then automatically:\n- Creates api.config.toml with your settings\n- Sets up pnpm workspace for the CLI\n- Adds npm scripts (api:fetch, api:generate, etc.)\n- Installs openapi-typescript dependency\n- Builds the CLI\n- Generates client files (api.instance.ts, api.client.ts, etc.)\n- Fetches spec and generates types (if not localhost)\n\nDetects existing setup and asks before overwriting.",
+      "examples": [
+        {
+          "command": "<%= config.bin %> init",
+          "description": "Interactive setup - prompts for endpoint, does everything"
+        },
+        {
+          "command": "<%= config.bin %> init --force",
+          "description": "Skip confirmations, overwrite existing files"
+        },
+        {
+          "command": "<%= config.bin %> init --skip-client",
+          "description": "Setup without generating client files"
+        }
+      ],
+      "flags": {
+        "force": {
+          "char": "f",
+          "description": "Skip all confirmations and overwrite everything",
+          "name": "force",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "skip-scripts": {
+          "description": "Skip adding npm scripts to package.json",
+          "name": "skip-scripts",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "skip-workspace": {
+          "description": "Skip creating/updating pnpm-workspace.yaml",
+          "name": "skip-workspace",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "skip-client": {
+          "description": "Skip generating client files (api.instance.ts, api.error.ts, api.client.ts)",
+          "name": "skip-client",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "skip-concurrent": {
+          "description": "Skip setting up concurrent dev script",
+          "name": "skip-concurrent",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "base-url-env": {
+          "description": "Environment variable name for base URL",
+          "name": "base-url-env",
+          "default": "VITE_API_URL",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "token-key": {
+          "description": "localStorage key for auth token",
+          "name": "token-key",
+          "default": "auth-token",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "with-credentials": {
+          "description": "Include credentials (cookies) in requests",
+          "name": "with-credentials",
+          "allowNo": true,
+          "type": "boolean"
+        },
+        "timeout": {
+          "description": "Request timeout in milliseconds",
+          "name": "timeout",
+          "default": 30000,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "quiet": {
+          "char": "q",
+          "description": "Suppress non-error output",
+          "name": "quiet",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "verbose": {
+          "char": "v",
+          "description": "Show detailed output",
+          "name": "verbose",
+          "allowNo": false,
+          "type": "boolean"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "init",
+      "pluginAlias": "chowbea-axios",
+      "pluginName": "chowbea-axios",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "init.js"
+      ]
+    },
+    "status": {
+      "aliases": [],
+      "args": {},
+      "description": "Show current state of your API client setup.\n\nDisplays:\n- Config file location and settings\n- Cached spec info (hash, age)\n- Endpoint statistics (total count, breakdown by HTTP method)\n- Generated file status (types, operations, client files)",
+      "examples": [
+        {
+          "command": "<%= config.bin %> status",
+          "description": "Show full status overview"
+        }
+      ],
+      "flags": {
+        "config": {
+          "char": "c",
+          "description": "Path to api.config.toml",
+          "name": "config",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "quiet": {
+          "char": "q",
+          "description": "Suppress non-error output",
+          "name": "quiet",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "verbose": {
+          "char": "v",
+          "description": "Show detailed output",
+          "name": "verbose",
+          "allowNo": false,
+          "type": "boolean"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "status",
+      "pluginAlias": "chowbea-axios",
+      "pluginName": "chowbea-axios",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "status.js"
+      ]
+    },
+    "validate": {
+      "aliases": [],
+      "args": {},
+      "description": "Check OpenAPI spec for issues that could affect generation.\n\nReports:\n- Missing operationIds (operations will be skipped)\n- Missing response definitions\n- Invalid spec structure\n\nUse --strict to treat warnings as errors.",
+      "examples": [
+        {
+          "command": "<%= config.bin %> validate",
+          "description": "Validate cached spec"
+        },
+        {
+          "command": "<%= config.bin %> validate --strict",
+          "description": "Fail on warnings too"
+        },
+        {
+          "command": "<%= config.bin %> validate --spec ./openapi.json",
+          "description": "Validate specific file"
+        }
+      ],
+      "flags": {
+        "config": {
+          "char": "c",
+          "description": "Path to api.config.toml",
+          "name": "config",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "spec": {
+          "char": "s",
+          "description": "Path to OpenAPI spec file (overrides config)",
+          "name": "spec",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "strict": {
+          "description": "Treat warnings as errors",
+          "name": "strict",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "quiet": {
+          "char": "q",
+          "description": "Suppress non-error output",
+          "name": "quiet",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "verbose": {
+          "char": "v",
+          "description": "Show detailed output",
+          "name": "verbose",
+          "allowNo": false,
+          "type": "boolean"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "validate",
+      "pluginAlias": "chowbea-axios",
+      "pluginName": "chowbea-axios",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "validate.js"
+      ]
+    },
+    "watch": {
+      "aliases": [],
+      "args": {},
+      "description": "Continuously poll for spec changes and regenerate.\n\nUseful during development - automatically regenerates types when\nyour API changes. Press Ctrl+C to stop.\n\nGracefully handles network failures and preserves cache on shutdown.",
+      "examples": [
+        {
+          "command": "<%= config.bin %> watch",
+          "description": "Start watching with default 10s interval"
+        },
+        {
+          "command": "<%= config.bin %> watch --interval 5000",
+          "description": "Poll every 5 seconds"
+        }
+      ],
+      "flags": {
+        "config": {
+          "char": "c",
+          "description": "Path to api.config.toml",
+          "name": "config",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "interval": {
+          "char": "i",
+          "description": "Polling interval in milliseconds",
+          "name": "interval",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "quiet": {
+          "char": "q",
+          "description": "Suppress non-error output",
+          "name": "quiet",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "debug": {
+          "char": "d",
+          "description": "Show verbose cycle-by-cycle logs",
+          "name": "debug",
+          "allowNo": false,
+          "type": "boolean"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "watch",
+      "pluginAlias": "chowbea-axios",
+      "pluginName": "chowbea-axios",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "watch.js"
+      ]
+    }
+  },
+  "version": "1.0.0"
+}

package/package.json

@@ -0,0 +1,68 @@
+{
+  "name": "chowbea-axios",
+  "version": "1.0.0",
+  "description": "Type-safe axios client that makes api requests a breeze",
+  "type": "module",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "bin": {
+    "chowbea-axios": "bin/run.js"
+  },
+  "files": [
+    "bin",
+    "dist",
+    "oclif.manifest.json"
+  ],
+  "scripts": {
+    "build": "tsc && npm run manifest",
+    "manifest": "oclif manifest",
+    "dev": "tsc --watch",
+    "clean": "rm -rf dist oclif.manifest.json",
+    "prepublishOnly": "npm run build",
+    "test": "test"
+  },
+  "oclif": {
+    "bin": "chowbea-axios",
+    "dirname": "chowbea-axios",
+    "commands": "./dist/commands",
+    "topicSeparator": " "
+  },
+  "dependencies": {
+    "@inquirer/prompts": "^7.0.0",
+    "@oclif/core": "^4.0.0",
+    "ora": "^8.0.0",
+    "toml": "^3.0.0"
+  },
+  "devDependencies": {
+    "@types/node": "^22.0.0",
+    "oclif": "^4.22.65",
+    "typescript": "^5.9.0"
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "keywords": [
+    "axios",
+    "api",
+    "typescript",
+    "openapi",
+    "codegen",
+    "cli"
+  ],
+  "homepage": "https://github.com/oddFEELING/chowbea-axios#readme",
+  "bugs": {
+    "url": "https://github.com/oddFEELING/chowbea-axios/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+ssh://git@github.com/oddFEELING/chowbea-axios.git"
+  },
+  "license": "MIT",
+  "author": "Emmanuel Alawode"
+}