zinkee 0.1.4 → 0.1.8

package/.claude/settings.local.json

@@ -0,0 +1,16 @@
+{
+  "permissions": {
+    "allow": [
+      "Bash(npm test *)",
+      "Bash(npm run *)",
+      "Bash(pnpm typecheck *)",
+      "Bash(pnpm test *)",
+      "Bash(npx tsc *)",
+      "Read(//home/guillermo/dev/z2-backend/api/src/main/java/com/zinkee/api/domain/model/v2/log/**)",
+      "Read(//home/guillermo/dev/z2-backend/**)",
+      "Bash(grep *)",
+      "Bash(npx vitest *)",
+      "Bash(npx tsx *)"
+    ]
+  }
+}

package/AGENTS.md

@@ -31,6 +31,7 @@ Use this order when reasoning about behavior:
 - `schemas`
 - `records`
 - `comments`
+- `logs`
 - `navigation`
 - `teamspace`
 - `displays`

package/README.md

@@ -12,6 +12,7 @@ Implemented command groups:
 - `records`
 - `files`
 - `comments`
+- `logs`
 - `navigation`
 - `teamspace`
 - `displays`
@@ -35,6 +36,10 @@ npm run typecheck
 npm test
 ```
 
+## Publishing
+
+Release steps for npm are documented in [docs/npm-release.md](docs/npm-release.md).
+
 ## Configuration
 
 The CLI uses a TOML config file:
@@ -133,43 +138,62 @@ zinkee schemas fields create projects --type autoincremental --slug code --label
 zinkee schemas fields create projects --type member --slug owner --label "Owner"
 ```
 
-Valid types: `text`, `number`, `date`, `file`, `autoincremental`, `member`, `option`, `reference`, `formula`.
+Valid types: `text`, `number`, `date`, `file`, `autoincremental`, `member`, `option`, `reference`, `formula`, `schedule`.
 
-Complex types require `--raw`:
+Complex types require `--raw`. The JSON `type` uses the backend ClassName (`TextField`, `OptionField`, …) and type-specific fields go inside `config`:
 
 ```bash
 # Option field
 zinkee schemas fields create projects --raw '{
-  "type":"option","slug":"status","label":"Status",
-  "options":[
-    {"id":1,"name":"Open","color":"default"},
-    {"id":2,"name":"In Progress","color":"primary"},
-    {"id":3,"name":"Done","color":"success"}
-  ]
+  "type":"OptionField","slug":"status","label":"Status",
+  "config":{
+    "options":[
+      {"id":1,"name":"Open","color":"default"},
+      {"id":2,"name":"In Progress","color":"primary"},
+      {"id":3,"name":"Done","color":"success"}
+    ]
+  }
 }'
 
 # Reference field (targetSchema and targetDisplayField must be UUIDs)
 zinkee schemas fields create tasks --raw '{
-  "type":"reference","slug":"project","label":"Project",
-  "targetSchema":"<schema-uuid>",
-  "targetDisplayField":"<field-uuid>",
-  "deleteBehavior":"SET_NULL"
+  "type":"ReferenceField","slug":"project","label":"Project",
+  "config":{
+    "targetSchema":"<schema-uuid>",
+    "targetDisplayField":"<field-uuid>",
+    "deleteBehavior":"SET_NULL"
+  }
 }'
 
 # Formula field (use formulaText, not expression)
 zinkee schemas fields create projects --raw '{
-  "type":"formula","slug":"code","label":"Code",
-  "formulaText":"concat(\"PRJ-\", <_id-field-uuid>)"
+  "type":"FormulaField","slug":"code","label":"Code",
+  "config":{
+    "formulaText":"concat(\"PRJ-\", <_id-field-uuid>)"
+  }
+}'
+
+# Schedule field (frequency: monthly | daily). Bound to one NumberField (referenceField)
+# and two DateField UUIDs (beginning/ending). Cannot be required.
+zinkee schemas fields create projects --raw '{
+  "type":"ScheduleField","slug":"recurrence","label":"Recurrence",
+  "config":{
+    "referenceField":"<number-field-uuid>",
+    "beginningPeriodField":"<date-field-uuid>",
+    "endingPeriodField":"<date-field-uuid>",
+    "frequency":"monthly"
+  }
 }'
 ```
 
 ### Update field config
 
-Config properties must be wrapped inside a `config` key:
+PATCH bodies are flat (no `set` / `unset` wrapper). Config properties must be wrapped inside a `config` key:
 
 ```bash
 # Number formatting
 zinkee schemas fields update projects budget --raw '{
+  "type":"NumberField",
   "config":{
     "defaultValue":"0",
     "formatOptions":{
@@ -181,11 +205,12 @@ zinkee schemas fields update projects budget --raw '{
 
 # Date formatting
 zinkee schemas fields update projects start-date --raw '{
+  "type":"DateField",
   "config":{"formatOptions":{"format":"date","dateFormat":"L","showTime":false}}
 }'
 
 # Text type (valid values: NORMAL, LONG)
-zinkee schemas fields update projects description --raw '{"config":{"textType":"LONG"}}'
+zinkee schemas fields update projects description --raw '{"type":"TextField","config":{"textType":"LONG"}}'
 ```
 
 ### Formula syntax
@@ -274,6 +299,17 @@ zinkee comments list <schema-slug> <record-uuid>
 
 ---
 
+## Logs
+
+Returns the change history for a record. Only populated for schemas with `auditable: true`.
+
+```bash
+zinkee logs list <schema-slug> <record-uuid>
+zinkee --json logs list <schema-slug> <record-uuid>
+```
+
+---
+
 ## Navigation
 
 Organize schemas into database folders.