i-plane 1.0.2 → 1.1.1

package/docs/api-coverage.md

@@ -0,0 +1,114 @@
+# API coverage
+
+Paths below are relative to `/api/v1/workspaces/{workspace_slug}/`. The command
+registry defines the supported CLI surface, including value flags and aliases;
+`tests/registry.test.ts` checks it against the dispatch table and exercises the
+actual handlers. `tests/cli.test.ts` verifies the entry point's flag validation.
+
+| Resource | Supported operations | CLI |
+| --- | --- | --- |
+| Projects | GET/POST `projects/`; PATCH/DELETE `projects/{project}/`; POST `projects/{project}/archive/` | `projects`, `project create`, `project update`, `project rm`, `project archive` |
+| Work items | GET/POST `projects/{project}/issues/`; GET/PATCH/DELETE `projects/{project}/issues/{issue}/`; GET `issues/{ref}/` | `list`, `create`, `show`, `update`, `done`, `delete` |
+| Work item fields | `parent`, `assignees`, `labels`, `start_date`, `target_date`, `name`, `state`, `priority`, `description_html` | `create` and `update` flags; `done` forwards update fields except state |
+| Labels | GET/POST `projects/{project}/labels/`; DELETE `projects/{project}/labels/{label}/` | `labels`, `label create`, `label rm` |
+| States | GET/POST `projects/{project}/states/`; PATCH/DELETE `projects/{project}/states/{state}/` | `states`, `state create`, `state update`, `state rm` |
+| Comments | GET/POST `projects/{project}/issues/{issue}/comments/` | `comments`, `comment`, `show --comments` |
+| Cycles | GET/POST `projects/{project}/cycles/`; PATCH `projects/{project}/cycles/{cycle}/`; GET `projects/{project}/cycles-lite/`; GET/POST `projects/{project}/cycles/{cycle}/cycle-issues/`; POST `projects/{project}/cycles/{cycle}/transfer-issues/` | `cycles`, `cycle create`, `cycle update`, `cycle add`, `cycle issues`, `cycle transfer` |
+| Modules | GET/POST `projects/{project}/modules/`; GET `projects/{project}/modules-lite/`; GET/POST `projects/{project}/modules/{module}/module-issues/` | `modules`, `module create`, `module add`, `module issues` |
+| Intake | GET/POST `projects/{project}/intake-issues/`; GET/PATCH/DELETE `projects/{project}/intake-issues/{issue}/` | `intake list`, `intake create`, `intake show`, `intake update`, `intake rm` |
+| Project features | `cycle_view`, `module_view`, `intake_view` on project POST/PATCH | `project create` and `project update`: `--cycles`, `--modules`, `--intake` |
+| Search | GET `issues/search/` | `search` |
+| Members | GET `members-lite/` | `members`, named assignee resolution |
+| Current user | GET `/api/v1/users/me/` | `whoami` |
+| Summary | GET `projects/{project}/summary/` | `summary` |
+
+The compatibility target uses the `issues/` routes. The current public
+[work item reference](https://developers.plane.so/api-reference/issue/overview)
+documents `work-items/` instead. A route migration must be verified against the
+target server; do not change paths solely to match a newer documentation release.
+
+## What modules and intake are for
+
+A module groups work toward a feature, milestone or other goal and may span
+several cycles. A cycle is a time window. Work items can belong to multiple
+modules. A module's lead and members are separate from work item assignees.
+The module status describes its overall planning stage; work item states show
+individual progress. See [Plane's module guide](https://docs.plane.so/core-concepts/modules).
+
+Intake is a queue for reports and requests that have not yet been accepted into
+project work. Requests start in Triage with a pending decision. They can be
+accepted, rejected, snoozed or linked to an existing work item as a duplicate.
+This keeps undecided requests out of committed work. See the
+[intake overview](https://docs.plane.so/intake/overview).
+
+| Resource | Plane fields | Current CLI support |
+| --- | --- | --- |
+| Module | Name, description, overall status, start/due dates | `module create` with name, `--description`, `--status`, `--start`, `--due` |
+| Module ownership | Lead and members | Available in the API/UI; not set by this CLI |
+| Module contents | Related work items | `module add`, `module issues`; membership can overlap across modules |
+| Intake request | Title, description, priority | `intake create`; `intake update --name`, `--description`, `--priority` |
+| Intake decision | Pending, rejected, snoozed, accepted, duplicate; snooze deadline; duplicate target | `intake update --status`, `--snooze-until`, `--duplicate-of` |
+| Intake work properties | Assignees, labels, due date and other UI properties | Not exposed by intake commands; use normal `update` after acceptance |
+| Intake channels | In-app submissions, public forms, email | CLI submits through the API; it does not configure forms/email |
+
+The UI guide and API defaults are not interchangeable. The module guide says
+new modules start in Backlog, while the tested API instance returned `planned`
+when status was omitted. CLI examples therefore specify `--status planned`.
+The UI can choose a work item state while accepting an intake request; the
+current CLI/API acceptance path moves it to the default project state. A normal
+`update --state` can then select a different state.
+
+A focused check of the published CLI confirmed that adding a work item to a
+second module preserves its first membership, and that intake acceptance moves
+a request from pending/Triage into the normal Backlog state on the tested
+instance. Temporary check data was deleted.
+
+Field references: [module creation](https://developers.plane.so/api-reference/module/add-module),
+[intake properties](https://docs.plane.so/core-concepts/intake), and
+[intake updates](https://developers.plane.so/api-reference/intake-issue/update-intake-issue-detail).
+
+## Compatibility details
+
+Enabling intake on project creation requires a follow-up project PATCH to create
+the queue. A creation flag alone can leave `intake_view=true` without an intake
+record, causing the first submission to fail with HTTP 500. The CLI initializes
+the queue explicitly and reports partial setup without encouraging a duplicate
+project creation.
+
+Cycle updates explicitly preserve `owned_by` when no owner is supplied: some
+servers otherwise default it to the requesting user. Calendar dates are formatted
+in the project's timezone; the JSON model keeps the API timestamps.
+
+Expired snoozes can be filtered out of intake GET and ordinary triage work item
+lookup. Update and delete therefore accept underlying work item UUIDs without
+requiring an intake GET. A hidden readable reference cannot be resolved by these
+API endpoints; the diagnostic points to `issueId` from an earlier JSON response.
+
+## Remaining gaps
+
+- Label updates and comment updates/deletions are not exposed.
+- Cycle/module archive, delete and membership removal are not exposed; module
+  details cannot yet be edited. The planning tasks cover listing, creation,
+  membership and cycle transfer.
+- This is an inventory of the implemented surface, not a claim to cover every
+  endpoint in every edition of Plane.
+
+## Adding a command
+
+1. Add the command and all options to `src/registry.ts`. The parser gets value
+   flags from the registry, including those of multiword commands.
+2. Add an online handler to `src/dispatch.ts`. Both missing handlers and handlers
+   absent from the registry fail the command-set test.
+3. Add a fixture invocation and valid option values to the registry suite. Test
+   the requested method, path and body, and assert observable output. Merely
+   accepting a flag in `--help` is insufficient.
+4. Extend the live acceptance script when the command contributes to project
+   setup. Verify writes by reading them back, and clean up temporary data.
+5. Update this table and README examples.
+
+Reference: [projects](https://developers.plane.so/api-reference/project/add-project),
+[labels](https://developers.plane.so/api-reference/label/add-label),
+[states](https://developers.plane.so/api-reference/state/add-state),
+[cycles](https://developers.plane.so/api-reference/cycle/transfer-cycle-work-items),
+[modules](https://developers.plane.so/api-reference/module/add-module),
+[intake](https://developers.plane.so/api-reference/intake-issue/overview).

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "i-plane",
-  "version": "1.0.2",
+  "version": "1.1.1",
   "description": "CLI \u0434\u043b\u044f Plane \u0441 \u043f\u043b\u043e\u0442\u043d\u044b\u043c \u0432\u044b\u0432\u043e\u0434\u043e\u043c \u043f\u043e\u0434 \u0430\u0433\u0435\u043d\u0442\u0430",
   "type": "module",
   "license": "MIT",
@@ -17,6 +17,7 @@
   },
   "files": [
     "dist",
+    "docs/api-coverage.md",
     "AGENTS.md",
     "CLAUDE.md"
   ],