@go-labs-sg/bb 1.1.0 → 1.1.1

package/README.md

@@ -1,12 +1,12 @@
 # bb
 
-Command-line interface for **Budget Builder**. Call budgets, bills, approvals, and suppliers from your terminal or from tools that don’t support MCP (e.g. some AI agents). Responses are JSON on stdout.
+Command-line interface for **Budget Builder**. Call budgets, bills, approvals, suppliers, dashboard, and more from your terminal or from tools that don’t support MCP (e.g. some AI agents). Responses are JSON on stdout.
 
 **Registry:** [`@go-labs-sg/bb`](https://www.npmjs.com/package/@go-labs-sg/bb)
 
 ## Requirements
 
-- **Node.js** 18+
+- **Node.js** 18+ (ESM; relative imports in `dist` use `.js` extensions)
 - A **Budget Builder API key** (same key used for the MCP server)
 
 ## Install
@@ -48,18 +48,21 @@ bb list-suppliers
 
 Global options and flags use `--key=value` or `--key value` (see `bb help`).
 
-## Commands
+**Authoritative command list:** run `bb help` — it includes every command, positional args, and flags (kept in sync with the MCP tool surface). You can also use MCP-style `snake_case` (e.g. `bb list_bills`); it is normalized to kebab-case.
 
-| Command | Description |
+### Command overview
+
+| Area | Commands (non-exhaustive) |
 | --- | --- |
-| `list-budgets` | List budgets. Flags: `--projectId`, `--name`, `--status` (comma-separated), `--page`, `--perPage` |
-| `get-budget <id>` | Budget details and line items |
-| `update-budget-status <id> <status>` | Change budget status (e.g. `APPROVED`, `REJECTED`, `DRAFT`, …) |
-| `list-bills` | List bills and/or claims. Flags: `--projectId`, `--budgetId`, `--status` (CSV, like `DRAFT,PAID` or `ALL`), `--search`, `--isClaimable` (`true`\|`false`), `--createdByIds` (CSV), `--sortBy` (`createdAt`\|`amount`\|`status`), `--sortDir` (`asc`\|`desc`), `--page`, `--pageSize` |
-| `list-claims` | Reimbursable claims only; same flags as `list-bills` except `--isClaimable` is ignored (always true) |
-| `approve-bill <id>` | Approve a pending bill (matches your pending bill approvals) |
-| `list-approvals` | Pending approvals. Flag: `--type` = `budget`, `supplier`, `bill`, or `all` |
-| `list-suppliers` | List suppliers. Flags: `--name`, `--page`, `--perPage` |
+| **Budgets** | `list-budgets`, `get-budget`, `get-budget-items`, `get-budget-details`, `get-budget-categories`, `get-budget-versions`, `update-budget-status`, `create-budget-approval`, `add-budget-items`, `update-budget-item`, `remove-budget-item` |
+| **Bills** | `list-bills`, `list-claims`, `create-bill-approval`, `update-bill-status`, `patch-bill-payment`, `patch-bill-invoice-number`, `get-bill-attachments`, `get-bill-details` |
+| **Approvals** | `list-approvals` / `get-pending-approvals`, `approve-bill`, `reject-bill`, `approve-budget`, `reject-budget`, `approve-supplier`, `reject-supplier` |
+| **Companies & projects** | `list-companies`, `get-company`, `create-company`, `list-projects`, `get-project`, `create-project`, `update-project-status` |
+| **Contacts** | `list-contacts` |
+| **Suppliers & items** | `list-suppliers`, `get-supplier-details`, `get-supplier-analytics`, `list-items`, `get-item`, `list-item-categories` |
+| **Dashboard & users** | `list-users`, `get-user-performance`, `get-dashboard`, `get-financial-overview` |
+| **Errors** | `get-recent-errors`, `get-error-metrics` |
+| **Historical / benchmarks** | `get-approved-budgets`, `get-budget-category-benchmarks`, `get-item-pricing-history`, `get-supplier-pricing-history` |
 
 ## Output
 
@@ -71,7 +74,7 @@ A `.env` file in the **current working directory** is loaded automatically (for
 
 ## Developing in this repo
 
-From the monorepo root:
+From the monorepo root (after `bun install`):
 
 ```bash
 export BB_API_KEY=...
@@ -81,5 +84,15 @@ bun run bb -- list-budgets
 Or from `packages/cli`:
 
 ```bash
+bun run build          # emit dist/ via tsc
+bun run typecheck      # tsc --noEmit
 bun run src/index.ts list-budgets
 ```
+
+### Layout
+
+- **`src/filter-enums.ts`** — “extended” filter enums (ALL + Prisma enums), maintained here so the published package does not depend on unpublished workspace packages. Keep in line with `packages/utils/src/filter-enums.ts` when those values change.
+
+### Publish
+
+`prepublishOnly` strips `workspace:` / `catalog:` entries from this package’s `package.json`, runs `tsc`, then `postpack` restores the file — so the npm tarball does not contain monorepo protocol dependencies. Types from `@bb/api` are compile-time only (`import type`). Enum **values** in emitted JS import `@bb/db/enums` (workspace `@bb/db` during monorepo development).

package/dist/commands.js

@@ -1,6 +1,6 @@
-import { BudgetRole, Deals, ExtendedApprovalStatus, ExtendedApprovalType, ExtendedBudgetStatus, TimeFrame, } from "@bb/utils/filter-enums";
-import { api } from "./api-client";
-import { billStatusesForApi, } from "./parse-cli-enums";
+import { api } from "./api-client.js";
+import { BudgetRole, Deals, ExtendedApprovalStatus, ExtendedApprovalType, ExtendedBudgetStatus, TimeFrame, } from "./filter-enums.js";
+import { billStatusesForApi, } from "./parse-cli-enums.js";
 const BUDGET = "BUDGET";
 const BILL = "BILL";
 const SUPPLIER = "SUPPLIER";

package/dist/filter-enums.js

@@ -0,0 +1,58 @@
+import { ApprovalStatus, ApprovalType, BillStatus, BudgetStatus, ErrorSeverity, ErrorStatus, EstimationMode, ProjectStatus, } from "@bb/db/enums";
+export const ExtendedApprovalStatus = {
+    ...ApprovalStatus,
+    ALL: "ALL",
+};
+export const ExtendedApprovalType = {
+    ...ApprovalType,
+    ALL: "ALL",
+};
+export const ExtendedProjectStatus = {
+    ...ProjectStatus,
+    ALL: "ALL",
+};
+export const ExtendedBudgetStatus = {
+    ...BudgetStatus,
+    ALL: "ALL",
+};
+export const ExtendedBillStatus = {
+    ...BillStatus,
+    ALL: "ALL",
+};
+export const ExtendedEstimationMode = {
+    ...EstimationMode,
+    ALL: "ALL",
+};
+export const BudgetRole = {
+    ALL: "ALL",
+    BD: "BD",
+    CREATOR: "CREATOR",
+    INSIDE_SALES: "INSIDE_SALES",
+};
+export const Deals = {
+    ALL: "ALL",
+    SUCCESSFUL: "SUCCESSFUL",
+    LOST: "LOST",
+};
+export const TimeFrame = {
+    ALL: "ALL",
+    LAST_YEAR: "LAST_YEAR",
+    LAST_6_MONTHS: "LAST_6_MONTHS",
+    LAST_3_MONTHS: "LAST_3_MONTHS",
+    CUSTOM: "CUSTOM",
+};
+export const ChartTimeFrame = {
+    LAST_30_DAYS: "last_30_days",
+    LAST_3_MONTHS: "last_3_months",
+    LAST_6_MONTHS: "last_6_months",
+    LAST_1_YEAR: "last_1_year",
+    ALL_TIME: "all_time",
+};
+export const ExtendedErrorSeverity = {
+    ALL: "ALL",
+    ...ErrorSeverity,
+};
+export const ExtendedErrorStatus = {
+    ALL: "ALL",
+    ...ErrorStatus,
+};

package/dist/index.js

@@ -1,6 +1,6 @@
 #!/usr/bin/env node
-import "./load-env";
-import { requireApiKey } from "./api-client";
+import "./load-env.js";
+import { requireApiKey } from "./api-client.js";
 import { addBudgetItems, approveBill, approveBudget, approveSupplier, createBillApproval, createBudgetApproval, createCompany, createProject, getApprovedBudgets, getBillAttachments, getBillDetails, getBudget, getBudgetCategories, getBudgetCategoryBenchmarks, getBudgetDetails, getBudgetItemsOnly, getBudgetVersions, getCompany, getDashboard, getErrorMetrics, getFinancialOverview, getItem, getItemPricingHistory, getProject, getRecentErrors, getSupplierAnalytics, getSupplierDetails, getSupplierPricingHistory, getUserPerformance, listApprovals, listBills, listBudgets, listCompanies, listContacts, listItemCategories, listItems, listProjects, listSuppliers, listUsers, patchBillInvoiceNumber, patchBillPayment, rejectBill, rejectBudget, rejectSupplier, removeBudgetItem, updateBillStatus, updateBudgetItem, updateBudgetStatus, updateProjectStatus, } from "./commands.js";
 import { getFlag, parseArgs } from "./parse-args.js";
 import { billStatusesForUpdateHelp, budgetStatusesForHelp, isBudgetStatusUpdate, parseApprovalTypeFlag, parseBillStatusForUpdate, parseCommaSeparatedBillStatuses, parseCommaSeparatedBudgetStatuses, parseCommaSeparatedIds, parseOptionalBillListSortBy, parseOptionalBillListSortDir, parseOptionalDashboardRole, parseOptionalDeals, parseOptionalErrorSeverity, parseOptionalErrorStatus, parseOptionalExtendedProjectStatus, parseOptionalFinancialRole, parseOptionalSupplierAnalyticsTimeFrame, parseOptionalTimeFrame, parseProjectStatusForUpdate, projectStatusesForHelp, } from "./parse-cli-enums.js";

package/dist/parse-cli-enums.js

@@ -1,5 +1,5 @@
 import { BillStatus, BudgetStatus, ProjectStatus } from "@bb/db/enums";
-import { BudgetRole, Deals, ExtendedBillStatus, ExtendedErrorSeverity, ExtendedErrorStatus, ExtendedProjectStatus, TimeFrame, } from "@bb/utils/filter-enums";
+import { BudgetRole, Deals, ExtendedBillStatus, ExtendedErrorSeverity, ExtendedErrorStatus, ExtendedProjectStatus, TimeFrame, } from "./filter-enums.js";
 const BUDGET_STATUS_VALUES = new Set(Object.values(BudgetStatus));
 const BILL_STATUS_VALUES = new Set(Object.values(BillStatus));
 const PROJECT_STATUS_VALUES = new Set(Object.values(ProjectStatus));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@go-labs-sg/bb",
-  "version": "1.1.0",
+  "version": "1.1.1",
   "description": "Budget Builder CLI — list budgets, bills, approvals, suppliers; approve bills; change status. For AI agents (e.g. Chuck/OpenClaw).",
   "type": "module",
   "main": "./dist/index.js",