@burdenoff/bigconsole-cli 2026.1029.1 → 2026.1110.1

package/README.md

@@ -1,263 +1,147 @@
-# Bigconsole Cli
+# bigconsole-cli
 
-A powerful command-line interface for managing bigconsole operations with GraphQL backend integration.
+Command-line client for the BigConsole platform (`@burdenoff/bigconsole-cli`, binary `bigconsole`).
+It manages dashboards, widgets, DataSinks, parsers, pipelines and workflows through the
+BigConsole GraphQL gateways.
 
-## Features
-
-- 🔐 **Authentication Management** - Login, logout, and status checking
-- 👥 **User Management** - CRUD operations for user accounts
-- ⚙️ **Configuration Management** - Easy setup and configuration
-- 📊 **Multiple Output Formats** - JSON, table, and YAML output
-- 🛡️ **Type Safety** - Built with TypeScript for reliability
-- 🎨 **Rich CLI Experience** - Colorful output and interactive prompts
-
-## Installation
-
-### Global Installation (Production)
+## Install
 
 ```bash
-npm install -g @burdenoff/bigconsole-cli
-```
-
-### Local Installation
+npm install -g @burdenoff/bigconsole-cli   # Node >= 24.11
+# or
+bun install -g @burdenoff/bigconsole-cli
 
-```bash
-npm install @burdenoff/bigconsole-cli
+bigconsole --version
 ```
 
 ## Configuration
 
-Configure the API endpoint:
+The CLI targets **production** by default:
 
-```bash
-bigconsole config set apiEndpoint http://localhost:8000/graphql
-```
+| Setting | Default |
+|---|---|
+| `workspaceEndpoint` | `https://graphqlworkspaces.burdenoff.com/workspaces/graphql` |
+| `globalEndpoint` | `https://graphql.burdenoff.com/global/graphql` |
 
-## Authentication
+Override with environment variables (`BIGCONSOLE_WORKSPACE_ENDPOINT`,
+`BIGCONSOLE_GLOBAL_ENDPOINT`, `BIGCONSOLE_OIDC_ISSUER`, `BIGCONSOLE_CLIENT_ID`) or persist values
+in `~/.config/bigconsole-cli/config.json`. Values in the file win over environment variables.
 
-### Login with credentials
 ```bash
-bigconsole auth login
+bigconsole cli-config show
+bigconsole cli-config set workspaceEndpoint http://localhost:4003/workspaces/graphql
+bigconsole cli-config path
+bigconsole cli-config reset
 ```
 
-### Login with token
-```bash
-bigconsole auth login --token <your-access-token>
-```
-
-### Check authentication status
-```bash
-bigconsole auth status
-```
-
-### Logout
-```bash
-bigconsole auth logout
-```
+Local stack example:
 
-### Change password
 ```bash
-bigconsole auth change-password
+export BIGCONSOLE_WORKSPACE_ENDPOINT=http://localhost:4003/workspaces/graphql
+export BIGCONSOLE_GLOBAL_ENDPOINT=http://localhost:4000/global/graphql
+export BIGCONSOLE_OIDC_ISSUER=http://localhost:4000/global
 ```
 
-## User Management
-
-### List users
-```bash
-bigconsole users list
-bigconsole users list --page 2 --limit 20
-```
-
-### Get user details
-```bash
-bigconsole users get <user-id>
-```
-
-### Create a user
-```bash
-bigconsole users create
-bigconsole users create --email user@example.com --password password123 --fullName "John Doe"
-```
-
-### Update a user
-```bash
-bigconsole users update <user-id> --email newemail@example.com
-bigconsole users update <user-id> --active
-bigconsole users update <user-id> --superuser
-```
-
-### Delete a user
-```bash
-bigconsole users delete <user-id>
-bigconsole users delete <user-id> --force
-```
-
-## Configuration Management
-
-### View all configuration
-```bash
-bigconsole config get
-```
+## Authentication
 
-### Get specific configuration
 ```bash
-bigconsole config get apiEndpoint
+bigconsole auth login                                      # OAuth2 device-code flow (opens a browser)
+bigconsole auth login --client-credentials --workspace-id <id>   # app login (prompts for client id/secret)
+bigconsole auth status
+bigconsole auth token [--workspace]                        # print a token to stdout
+bigconsole auth refresh
+bigconsole auth logout
 ```
 
-### Set configuration
-```bash
-bigconsole config set apiEndpoint http://localhost:8000/graphql
-bigconsole config set outputFormat table
-```
+Device-code login lists your workspaces and asks which one to use. Switch later with
+`bigconsole workspace set <workspace-uuid>`.
 
-### Delete configuration
-```bash
-bigconsole config delete accessToken
-```
+## Commands
 
-### Clear all configuration
-```bash
-bigconsole config clear
-```
+| Group | Subcommands |
+|---|---|
+| `auth` | `login`, `logout`, `status`, `token`, `refresh` |
+| `cli-config` | `show`, `path`, `get`, `set`, `reset` |
+| `workspace` | `list`, `current`, `set` |
+| `dashboard` | `list`, `get`, `create`, `update`, `archive`, `delete`, `import`, `export` |
+| `widget` | `list`, `get`, `create`, `update`, `delete` |
+| `datasink` | `list`, `get`, `data`, `create`, `update`, `delete` |
+| `parser` | `list`, `get`, `create`, `update`, `delete` |
+| `pipeline` | `list`, `get`, `create`, `update`, `delete` |
+| `workflow` | `list`, `get` |
+| `drilldown` | `list`, `delete` |
+| `share` | `list` |
+| `template` | `list`, `get` |
+| `prompt` | `generate`, `list`, `get`, `cancel` |
 
-### Show config file path
-```bash
-bigconsole config path
-```
+Run `bigconsole <group> <command> --help` for the exact options. Notes:
 
-## Output Formats
+- `get`, `update`, `delete` take the id as a positional argument. `datasink get`/`datasink data`
+  take `--id` or `--key`.
+- `widget`, `parser`, `pipeline` and `share` list commands need their parent:
+  `widget list --page <pageId>`, `parser list --console <dashboardId>`,
+  `pipeline list --console <dashboardId>`, `share list --dashboard <id>`.
+- `parser update` and `pipeline update` require `--version <n>` (the current version, for
+  optimistic locking). `datasink update` reads it for you unless you pass `--version`.
+- Enum values: dashboard `--category` is `CUSTOM | EXECUTIVE | FINANCIAL | HR | MARKETING |
+  OPERATIONS | SALES`; `--layout` is `GRID | FLEX | TABS`; `--visibility` is
+  `PRIVATE | WORKSPACE | PUBLIC`; parser `--type` is `jq | jsonata`; parser and pipeline
+  statuses are lowercase.
+- `widget create` needs `--position-json '{"x":0,"y":0,"width":4,"height":2}'`.
 
-All commands support different output formats:
+Example workflow:
 
 ```bash
-bigconsole users list --format json
-bigconsole users list --format table
-bigconsole users list --format yaml   # `yml` is accepted as an alias
+bigconsole datasink create --key sales --name "Sales" --data-json '{"items":[{"value":1}]}'
+bigconsole dashboard create --name "Q4 Overview" --category EXECUTIVE
+bigconsole parser create --name total --console <dashboardId> --input-key sales \
+  --output-key total --type jsonata --expression 'items[0].value'
 ```
 
-- **stdout carries only command data.** Status lines (`✓`, `ℹ`, `!`, `✗`) are
-  written to stderr, so `--format json|yaml` output can be piped straight into
-  `jq` / `yq`.
-- **JSON** is standard `JSON.stringify` output; C1 control characters, line and
-  paragraph separators and bidirectional formatting characters are written as
-  `\uXXXX` escapes (the parsed data is unchanged).
-- **YAML** is produced by js-yaml with the YAML 1.2 JSON schema. Strings that a
-  YAML 1.1 or 1.2 parser could read as another type (`yes`, `~`, `0x1F`,
-  `2026-01-01`, ...) are quoted, so the output parses back to the same data.
-- **Tables** are for people: control sequences are removed, line breaks and tabs
-  are shown as spaces, and bidirectional formatting characters are shown as
-  `\uXXXX`.
-- **Errors** are a single bounded line. Failed requests report the HTTP status,
-  the server's first GraphQL error and its code; request variables, headers and
-  response bodies are never printed, and credential-shaped values are masked.
-
-## Global Options
-
-- `--endpoint <endpoint>`: Override the API endpoint for a single command
-- `--token <token>`: Override the access token for a single command
-- `--format <format>`: Set output format (json, table, yaml)
-- `--verbose`: Enable verbose logging
-
-## Examples
-
-```bash
-# Set up the CLI
-bigconsole config set apiEndpoint http://localhost:8000/graphql
+## Output formats
 
-# Login
-bigconsole auth login
-
-# List all users in table format
-bigconsole users list --format table
-
-# Create a new user
-bigconsole users create --email admin@example.com --password admin123 --superuser
-
-# Check authentication status
-bigconsole auth status
+`-f, --format json|table|yaml` (`yml` is accepted). Data goes to stdout; status lines go to
+stderr, so JSON and YAML pipe cleanly into `jq` / `yq`. Other global options: `--verbose`,
+`--no-color`, `-v, --version`.
 
-# Get help for any command
-bigconsole auth --help
-bigconsole users --help
-```
+Errors are a single bounded line. Request variables, headers and response bodies are never
+printed, and credential-shaped values are masked.
 
 ## Development
 
-```bash
-# Install dependencies
-npm install
-
-# Build the project
-npm run build
-
-# Run in development mode
-npm run dev
-
-# Run tests
-npm test
+Requires Bun `>= 1.4.4` (see `.bun-version`; older Bun cannot read `bun.lock`) and Node `>= 24.11`.
 
-# Lint code
-npm run lint
+```bash
+bun install --frozen-lockfile
+bun run dev            # run from source with watch
+bun run build
+bun run test           # builds first, then bun test
+bun run lint
+bun run sanity         # format, lint, typecheck, build, test, knip
 ```
 
-## Configuration File
-
-The CLI stores configuration in `~/.config/bigconsole-cli/config.json`. This includes:
-
-- `apiEndpoint`: The GraphQL API endpoint
-- `outputFormat`: Default output format (json, table, yaml)
-- `accessToken`: Authentication token
-- `refreshToken`: Refresh token for authentication
-
-## Releasing
-
-`main` is the only branch. The **Publish Production** workflow
-(`.github/workflows/publish-production.yml`) publishes it to npmjs:
-
-1. Bump `version` in `package.json` (CalVer `YYYY.MDD.PATCH`, e.g. `2026.1029.1`)
-   and add a `CHANGELOG.md` entry.
-2. Push to `main`. The `build` job lints, type-checks, tests, builds and packs
-   the CLI; the `publish` job (environment `Production`, org secret `NPM_TOKEN`)
-   publishes the tarball with dist-tags `latest` and `dev`.
-3. A version that is already on the registry is skipped, so a push without a
-   version bump publishes nothing. The workflow can be re-run from `main`
-   (workflow_dispatch).
-
-The former `@burdenoff/alpha-bigconsole-cli` channel and its `alpha` branch are
-retired.
+See [docs/TESTING.md](./docs/TESTING.md) for end-to-end testing.
 
 ### Schema contract
 
-`tests/unit/graphql/schema-contract.test.ts` validates every workspace operation
-in `src/graphql/operations.ts` against `graphql/bigconsole-subgraph.graphql`,
-the SDL that wspace-bigconsole-svc publishes to Hive. When the service schema
-changes, run `bun run schema:pull` (needs `gh` with read access to the service
-repo) and fix any operation the test rejects.
+`tests/unit/graphql/schema-contract.test.ts` validates every workspace operation in
+`src/graphql/operations.ts` against `graphql/bigconsole-subgraph.graphql`, the SDL that
+wspace-bigconsole-svc publishes to Hive. When the service schema changes, run
+`bun run schema:pull` (needs `gh` with read access to the service repo) and fix any operation the
+test rejects.
 
-## Testing
+## Releasing
 
-See [TESTING.md](./TESTING.md) for comprehensive testing instructions before publishing.
+Releases go through `.github/workflows/release.yml` only. Run it from the Actions tab (empty
+version = next free CalVer patch; `dry-run` runs every gate and publishes nothing) or push a
+CalVer tag (`git tag 2026.1107.1 && git push origin 2026.1107.1`). A plain push to `main` does not
+publish.
 
 ## Security
 
-- Tokens are stored securely in user configuration directory
-- No sensitive information is logged in verbose mode
-- All API communication uses HTTPS
-- Input validation prevents injection attacks
-
-## Contributing
-
-1. Fork the repository
-2. Create a feature branch
-3. Make your changes
-4. Add tests for new functionality
-5. Ensure all tests pass
-6. Submit a pull request
+- Tokens live in `~/.config/bigconsole-cli/` (files mode 0600).
+- Production and alpha endpoints use HTTPS. Local development endpoints may use plain HTTP.
 
 ## License
 
-UNLICENSED - Private package for internal use
-
----
-
-Built with ❤️ by [Vignesh T.V](https://github.com/tvvignesh)
+UNLICENSED - Burdenoff Consultancy Services Pvt. Ltd.

package/dist/auth/store.d.ts

@@ -36,10 +36,6 @@ export declare function isTokenExpired(auth: StoredAuth): boolean;
  * Check if the stored token is expiring within the next 5 minutes.
  */
 export declare function isTokenExpiringSoon(auth: StoredAuth): boolean;
-/**
- * Check if the workspace token has expired.
- */
-export declare function isWorkspaceTokenExpired(auth: StoredAuth): boolean;
 /**
  * Check if the workspace token is expiring within the next 5 minutes.
  */