zinkee 0.1.43 → 0.1.45

package/package.json

@@ -1,11 +1,13 @@
 {
   "name": "zinkee",
-  "version": "0.1.43",
+  "version": "0.1.45",
   "description": "CLI for Zinkee API v2",
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/Zinkee-Engineering/cli.git"
+    "url": "git+https://github.com/Zinkee-Engineering/z2.git",
+    "directory": "cli"
   },
+  "files": ["dist"],
   "type": "module",
   "bin": {
     "zinkee": "dist/index.js"
@@ -18,7 +20,8 @@
     "dev": "tsx src/index.ts",
     "test": "vitest run",
     "test:watch": "vitest",
-    "typecheck": "tsc --noEmit"
+    "typecheck": "tsc --noEmit",
+    "benchmark": "node scripts/benchmark.mjs"
   },
   "dependencies": {
     "chalk": "^5.6.2",

package/.github/workflows/npm-publish.yml

@@ -1,77 +0,0 @@
-name: Publish to npm
-
-on:
-  push:
-    branches:
-      - main
-
-permissions:
-  contents: read
-  id-token: write
-
-jobs:
-  publish:
-    name: Publish package
-    runs-on: ubuntu-latest
-
-    steps:
-      - name: Checkout repository
-        uses: actions/checkout@v6
-
-      - name: Set up Node.js
-        uses: actions/setup-node@v6
-        with:
-          node-version: 24
-          registry-url: https://registry.npmjs.org
-          package-manager-cache: false
-
-      - name: Check package version
-        id: version
-        shell: bash
-        run: |
-          package_name="$(node -p "require('./package.json').name")"
-          package_version="$(node -p "require('./package.json').version")"
-
-          set +e
-          lookup_output="$(npm view "${package_name}@${package_version}" version 2>&1)"
-          lookup_status=$?
-          set -e
-
-          if [ "$lookup_status" -eq 0 ]; then
-            echo "${package_name}@${package_version} is already published; skipping."
-            echo "already-published=true" >> "$GITHUB_OUTPUT"
-          elif echo "$lookup_output" | grep -q "E404"; then
-            echo "${package_name}@${package_version} is not published yet."
-            echo "already-published=false" >> "$GITHUB_OUTPUT"
-          else
-            echo "$lookup_output" >&2
-            exit "$lookup_status"
-          fi
-
-      - name: Set up trusted publishing
-        if: steps.version.outputs.already-published == 'false'
-        run: npm install --global npm@11.5.1
-
-      - name: Install dependencies
-        if: steps.version.outputs.already-published == 'false'
-        run: npm ci
-
-      - name: Run tests
-        if: steps.version.outputs.already-published == 'false'
-        run: npm test
-
-      - name: Run typecheck
-        if: steps.version.outputs.already-published == 'false'
-        run: npm run typecheck
-
-      - name: Build project
-        if: steps.version.outputs.already-published == 'false'
-        run: npm run build
-
-      - name: Inspect package contents
-        if: steps.version.outputs.already-published == 'false'
-        run: npm pack --dry-run
-
-      - name: Publish package
-        if: steps.version.outputs.already-published == 'false'
-        run: npm publish --access public

package/.github/workflows/pr-checks.yml

@@ -1,36 +0,0 @@
-name: PR Checks
-
-on:
-  pull_request:
-    branches:
-      - main
-
-permissions:
-  contents: read
-
-jobs:
-  validate:
-    name: Test, Typecheck, and Build
-    runs-on: ubuntu-latest
-
-    steps:
-      - name: Checkout repository
-        uses: actions/checkout@v4
-
-      - name: Set up Node.js
-        uses: actions/setup-node@v4
-        with:
-          node-version: 24
-          cache: npm
-
-      - name: Install dependencies
-        run: npm ci
-
-      - name: Run tests
-        run: npm test
-
-      - name: Run typecheck
-        run: npm run typecheck
-
-      - name: Build project
-        run: npm run build

package/AGENTS.md

@@ -1,110 +0,0 @@
-# Zinkee CLI Notes
-
-This repository contains a TypeScript ESM CLI for Zinkee API v2.
-
-## Source Of Truth
-
-Use this order when reasoning about behavior:
-
-1. live command registration in `src/index.ts`
-2. command modules in `src/commands`
-3. docs in `README.md`
-
-## Key Runtime Rules
-
-- Existing config compatibility is mandatory: `~/.config/zinkee/config.toml`
-- Runtime env compatibility is mandatory for agentic/backend use:
-  - `ZINKEE_PROFILE`
-  - `ZINKEE_API_BASE_URL`
-  - `ZINKEE_API_KEY`
-- `--read-only` must block write/destructive commands before network calls
-- `--example <command path>` should return concrete usage examples without running the command
-- `--json` must keep stdout machine-readable
-- success JSON shape is `{ data, meta }`
-- error JSON shape is `{ error, meta }`
-
-## Current Command Groups
-
-- `profiles`
-- `config`
-- `files`
-- `schemas`
-- `records`
-- `comments`
-- `logs`
-- `navigation`
-- `teamspace`
-- `displays`
-- `automations`
-- `document-templates`
-- `formulas`
-
-## Implementation Shape
-
-- REST transport lives in `src/api`
-- commander commands live in `src/commands`
-- shared config/runtime lives in `src/config.ts` and `src/runtime-context.ts`
-- JSON/table output helpers live in `src/utils/output.ts`
-- shared CLI error handling lives in `src/utils/errors.ts`
-- parsers live in `src/parsers`
-- shell completion (engine, scripts, install, runtime) lives in `src/completion`
-
-## API Examples (`--example`)
-
-- `--example` output comes 100% from hand-written `src/utils/examples.ts`
-  (`specificExamples`, keyed by command path e.g. `"schemas update"`). No
-  codegen, no OpenAPI import.
-- These MIRROR the swagger `@ExampleObject`s in the `z2-backend` repo
-  (`api/src/main/java/com/zinkee/api/infra/web/v2/ApiV2<Resource>Documentation.java`).
-  When you add/change an example on either side, update the other with the same
-  payload (request `raw` and `response`). Nothing keeps them in sync
-  automatically.
-- Keep `response` shapes aligned with the backend DTO field order (e.g.
-  `SchemaV2ResourceResponse`: `… commentable, highlightedField, fields`).
-
-## Testing
-
-Prefer focused command tests and parser/client unit tests.
-
-> **Unit tests use `fetchMock` and never hit the real API.** When changing the
-> shape of a payload (enum values, property names, structure), unit tests will
-> still pass even if the real API would reject the request with `400`. For
-> shape-sensitive changes — especially edits to strings in `src/utils/examples.ts`
-> — also run the resulting command against a real workspace and confirm the API
-> accepts it.
-
-## Contributing
-
-### Branches
-
-- `feature/eng-<ticket>-<slug>` for Linear-tracked work
-- `fix/<slug>` / `chore/<slug>` / `docs/<slug>` for untracked work
-- Never push to `main` directly; always open a PR
-
-### Commits
-
-- Conventional Commits format: `<type>(<scope>): <subject>` (e.g.
-  `fix(displays): correct chart-type values in widget examples`)
-- Subject in imperative mood, under ~72 chars, no trailing period
-- Body explains the *why*, not the *what* — the diff already shows what changed
-- Stage files explicitly (`git add <path>`); never `git add -A`
-- Don't add `Co-Authored-By:` trailers; existing history doesn't use them
-
-### Before committing
-
-1. `npm run typecheck` — must pass
-2. `npm test` — must pass
-3. For changes that affect runtime behaviour or `--example` output, also
-   exercise the affected commands against a live workspace (see Testing note
-   above).
-
-### Versioning
-
-- Versioning is patch-only today (`0.1.x`). Bump the patch number unless the
-  team decides to move to a different scheme.
-- If an agent determines that a PR requires a new published version, it must
-  bump the version in `package.json` in that same PR and keep
-  `package-lock.json` in sync. User-visible changes (new commands, fixed
-  examples, behaviour changes) always require this.
-- Before bumping, fetch `origin/main` to make sure the version you pick isn't
-  already taken by another PR that merged ahead of yours.

package/docs/cli-contract.md

@@ -1,41 +0,0 @@
-# CLI Contract
-
-This file is a quick reference for the implemented CLI surface.
-
-## Global Flags
-
-- `--profile <name>`
-- `--base-url <url>`
-- `--api-key <token>`
-- `--read-only`
-- `--example <command path>`
-- `--json`
-
-## Command Groups
-
-- `profiles`
-- `config`
-- `files`
-- `schemas`
-- `records`
-- `comments`
-- `navigation`
-- `teamspace`
-- `displays`
-- `automations`
-
-## Current Conventions
-
-- selectors are UUID-or-slug where the domain supports it
-- `records` writes use `--set`, `--set-json`, `--unset`, `--raw`, `--raw-file`
-- `comments create` is text-first with raw fallback
-- `files download --json` requires `--output`
-- `widgets` and `automation actions` are generic and type-driven via `--type`
-
-## Verification Commands
-
-```bash
-npm run build
-npm run typecheck
-npm test
-```

package/docs/npm-release.md

@@ -1,64 +0,0 @@
-# Publish to npm
-
-The `Publish to npm` GitHub Actions workflow publishes new CLI versions when
-they reach `main`. It uses npm trusted publishing with GitHub OIDC, so the
-repository does not need an `NPM_TOKEN`.
-
-## One-time npm configuration
-
-Configure the `zinkee` package on npmjs.com with this trusted publisher:
-
-- Provider: GitHub Actions
-- Organization: `Zinkee-Engineering`
-- Repository: `cli`
-- Workflow filename: `npm-publish.yml`
-- Environment: empty
-- Allowed action: `npm publish`
-
-Enter only the workflow filename, not `.github/workflows/npm-publish.yml`.
-
-## Release flow
-
-Every pull request that ships a user-visible change must update the package
-version. For a patch release, run:
-
-```bash
-npm version patch --no-git-tag-version
-```
-
-This updates `package.json` and `package-lock.json` without creating a commit or
-tag. Include both files in the feature pull request and run:
-
-```bash
-npm ci
-npm test
-npm run typecheck
-npm run build
-npm pack --dry-run
-```
-
-After the pull request is merged, `.github/workflows/npm-publish.yml`:
-
-1. Checks whether the package version already exists on npm.
-2. Skips the publish successfully when the version already exists.
-3. Runs the full quality gate for a new version.
-4. Publishes the package with `npm publish --access public`.
-
-## Verification
-
-Check the workflow run and the published version:
-
-```bash
-gh run list --workflow npm-publish.yml
-npm view zinkee version
-```
-
-Optionally install the published version and exercise the CLI:
-
-```bash
-npm install -g zinkee@latest
-zinkee --help
-```
-
-Do not create another version bump after a failed publish unless npm confirms
-that the failed version was already published.