zinkee 0.1.64 → 0.1.66

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -486,6 +486,8 @@ zinkee records clear projects
486
486
 
487
487
  Option values are written as numbers (`--set status=1`) but returned as strings (`"1"`). Number values are stored and returned as strings.
488
488
 
489
+ Every record returned by `records get`, `list`, `query` and `update` carries `url`, its permanent link in the Zinkee web app (whoever opens it must sign in and be a member of the workspace); `records create` returns the links of the created records in `createdRecords`, in the order of `created`. Quote the link as is instead of building it.
490
+
489
491
  `records clear` removes every record from the schema's table. Heritage rules
490
492
  (`CASCADE` / `SET NULL`) propagate to child schemas asynchronously through the
491
493
  CDC pipeline, so related tables converge eventually. A `RESTRICT` reference that
@@ -619,6 +621,45 @@ zinkee --json logs list <schema-slug> <record-uuid>
619
621
 
620
622
  ---
621
623
 
624
+ ## Members
625
+
626
+ `members list` returns the active members of the workspace
627
+ (`GET /api/v2/members`), sorted by alias, without pending invitations or service
628
+ accounts. It is a read: it works with `--read-only`.
629
+
630
+ ```bash
631
+ zinkee members list
632
+ zinkee --json members list
633
+ ```
634
+
635
+ ```json
636
+ {
637
+ "data": [
638
+ { "email": "maria@example.com", "alias": "María López", "currentUser": true },
639
+ { "email": "pablo@example.com", "alias": "pablo", "currentUser": false }
640
+ ],
641
+ "meta": { "command": "members list" }
642
+ }
643
+ ```
644
+
645
+ - `email` is the value a member field stores: write it exactly with `--set`, and
646
+ filter by it with `eq` or `in` in `records query` and `records aggregate`.
647
+ - `alias` is the display name, the same label `records aggregate` gives a group
648
+ by a member field.
649
+ - `currentUser` is `true` only on your own entry, when the CLI runs with a user
650
+ token (as in Kraken); with an API key it is always `false`. Member fields do not
651
+ accept `myself` when writing, so to assign a record to yourself, write the
652
+ `email` of the entry with `currentUser: true`.
653
+
654
+ ```bash
655
+ # Assign a record to a member, then find the records of one or more members
656
+ zinkee records update deals <record-uuid> --set owner=maria@example.com
657
+ zinkee --json records query deals --where "owner eq maria@example.com"
658
+ zinkee --json records aggregate deals --where "owner in maria@example.com,pablo@example.com" --group-by owner
659
+ ```
660
+
661
+ ---
662
+
622
663
  ## Navigation
623
664
 
624
665
  Organize schemas into database folders. The navigation menu holds databases, so only schemas can be moved here.
@@ -639,6 +639,7 @@ var specificExamples = {
639
639
  "records": [
640
640
  {
641
641
  "recordId": "550e8400-e29b-41d4-a716-446655440000",
642
+ "url": "https://z2.zinkee.com/r/3f2b1c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d/2eb8bdcf-6d9c-4fbb-9018-7fa8180f4c5e/550e8400-e29b-41d4-a716-446655440000",
642
643
  "values": {
643
644
  "contact-name": "Ada Lovelace",
644
645
  "status": 2,
@@ -1007,6 +1008,12 @@ var specificExamples = {
1007
1008
  "created": [
1008
1009
  "550e8400-e29b-41d4-a716-446655440000"
1009
1010
  ],
1011
+ "createdRecords": [
1012
+ {
1013
+ "recordId": "550e8400-e29b-41d4-a716-446655440000",
1014
+ "url": "https://z2.zinkee.com/r/3f2b1c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d/2eb8bdcf-6d9c-4fbb-9018-7fa8180f4c5e/550e8400-e29b-41d4-a716-446655440000"
1015
+ }
1016
+ ],
1010
1017
  "errors": []
1011
1018
  }`
1012
1019
  },
@@ -1026,7 +1033,7 @@ var specificExamples = {
1026
1033
  "amount": 1999.99,
1027
1034
  "due-date": "2026-06-01T09:00:00Z",
1028
1035
  "customer-ref": "8ad602a1-f6e3-43f6-9ab2-f1c5afc99621",
1029
- "owner": "6c8a3e0d-4e5f-4a1b-9c2d-3e4f5a6b7c8d"
1036
+ "owner": "maria@example.com"
1030
1037
  }
1031
1038
  ]
1032
1039
  }`,
@@ -1034,6 +1041,12 @@ var specificExamples = {
1034
1041
  "created": [
1035
1042
  "550e8400-e29b-41d4-a716-446655440000"
1036
1043
  ],
1044
+ "createdRecords": [
1045
+ {
1046
+ "recordId": "550e8400-e29b-41d4-a716-446655440000",
1047
+ "url": "https://z2.zinkee.com/r/3f2b1c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d/2eb8bdcf-6d9c-4fbb-9018-7fa8180f4c5e/550e8400-e29b-41d4-a716-446655440000"
1048
+ }
1049
+ ],
1037
1050
  "errors": [
1038
1051
  {
1039
1052
  "index": 1,
@@ -1057,6 +1070,7 @@ var specificExamples = {
1057
1070
  }`,
1058
1071
  response: `{
1059
1072
  "created": [],
1073
+ "createdRecords": [],
1060
1074
  "errors": [
1061
1075
  {
1062
1076
  "index": 0,
@@ -1081,6 +1095,12 @@ var specificExamples = {
1081
1095
  "created": [
1082
1096
  "550e8400-e29b-41d4-a716-446655440000"
1083
1097
  ],
1098
+ "createdRecords": [
1099
+ {
1100
+ "recordId": "550e8400-e29b-41d4-a716-446655440000",
1101
+ "url": "https://z2.zinkee.com/r/3f2b1c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d/2eb8bdcf-6d9c-4fbb-9018-7fa8180f4c5e/550e8400-e29b-41d4-a716-446655440000"
1102
+ }
1103
+ ],
1084
1104
  "errors": []
1085
1105
  }`
1086
1106
  }
@@ -1097,24 +1117,25 @@ var specificExamples = {
1097
1117
  }`,
1098
1118
  response: `{
1099
1119
  "recordId": "550e8400-e29b-41d4-a716-446655440000",
1120
+ "url": "https://z2.zinkee.com/r/3f2b1c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d/2eb8bdcf-6d9c-4fbb-9018-7fa8180f4c5e/550e8400-e29b-41d4-a716-446655440000",
1100
1121
  "values": {
1101
1122
  "contact-name": "Ada Lovelace Updated",
1102
1123
  "status": 2,
1103
1124
  "amount": 1250.50,
1104
1125
  "due-date": "2026-05-15T12:00:00Z",
1105
- "owner": "6c8a3e0d-4e5f-4a1b-9c2d-3e4f5a6b7c8d"
1126
+ "owner": "maria@example.com"
1106
1127
  }
1107
1128
  }`
1108
1129
  },
1109
1130
  {
1110
1131
  description: "Patch multiple typed values at once.",
1111
- command: "zinkee --json records update contacts 550e8400-e29b-41d4-a716-446655440000 --set status=3 --set amount=2500.00 --set due-date=2026-07-01T09:00:00Z --set owner=6c8a3e0d-4e5f-4a1b-9c2d-3e4f5a6b7c8d",
1132
+ command: "zinkee --json records update contacts 550e8400-e29b-41d4-a716-446655440000 --set status=3 --set amount=2500.00 --set due-date=2026-07-01T09:00:00Z --set owner=maria@example.com",
1112
1133
  raw: `{
1113
1134
  "set": {
1114
1135
  "status": 3,
1115
1136
  "amount": 2500.00,
1116
1137
  "due-date": "2026-07-01T09:00:00Z",
1117
- "owner": "6c8a3e0d-4e5f-4a1b-9c2d-3e4f5a6b7c8d"
1138
+ "owner": "maria@example.com"
1118
1139
  }
1119
1140
  }`
1120
1141
  },
@@ -1135,6 +1156,7 @@ var specificExamples = {
1135
1156
  }`,
1136
1157
  response: `{
1137
1158
  "recordId": "550e8400-e29b-41d4-a716-446655440000",
1159
+ "url": "https://z2.zinkee.com/r/3f2b1c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d/2eb8bdcf-6d9c-4fbb-9018-7fa8180f4c5e/550e8400-e29b-41d4-a716-446655440000",
1138
1160
  "values": {
1139
1161
  "deal-name": "Acme renewal",
1140
1162
  "customer-ref": "8ad602a1-f6e3-43f6-9ab2-f1c5afc99621::Acme Corp"
@@ -1608,12 +1630,12 @@ var specificExamples = {
1608
1630
  }`
1609
1631
  },
1610
1632
  {
1611
- description: "Create a MEMBER variable with a default user id.",
1612
- command: "zinkee --json displays variables create 0f6f062f-1478-4df2-96a1-c495d037d260 --type MEMBER --name Owner --default 6c8a3e0d-4e5f-4a1b-9c2d-3e4f5a6b7c8d",
1633
+ description: "Create a MEMBER variable with a default member (the email that members list returns).",
1634
+ command: "zinkee --json displays variables create 0f6f062f-1478-4df2-96a1-c495d037d260 --type MEMBER --name Owner --default maria@example.com",
1613
1635
  raw: `{
1614
1636
  "type": "MEMBER",
1615
1637
  "name": "Owner",
1616
- "defaultValue": "6c8a3e0d-4e5f-4a1b-9c2d-3e4f5a6b7c8d",
1638
+ "defaultValue": "maria@example.com",
1617
1639
  "allowMultiple": false,
1618
1640
  "staticVariable": false
1619
1641
  }`
@@ -2858,17 +2880,19 @@ var specificExamples = {
2858
2880
  "records": [
2859
2881
  {
2860
2882
  "recordId": "550e8400-e29b-41d4-a716-446655440000",
2883
+ "url": "https://z2.zinkee.com/r/3f2b1c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d/2eb8bdcf-6d9c-4fbb-9018-7fa8180f4c5e/550e8400-e29b-41d4-a716-446655440000",
2861
2884
  "values": {
2862
2885
  "contact-name": "Ada Lovelace",
2863
2886
  "contact-email": "ada@example.com",
2864
2887
  "status": 2,
2865
2888
  "amount": 1250.50,
2866
2889
  "due-date": "2026-05-15T12:00:00Z",
2867
- "owner": "6c8a3e0d-4e5f-4a1b-9c2d-3e4f5a6b7c8d"
2890
+ "owner": "maria@example.com"
2868
2891
  }
2869
2892
  },
2870
2893
  {
2871
2894
  "recordId": "7c9a4b31-e85d-42f7-8b6a-123456789abc",
2895
+ "url": "https://z2.zinkee.com/r/3f2b1c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d/2eb8bdcf-6d9c-4fbb-9018-7fa8180f4c5e/7c9a4b31-e85d-42f7-8b6a-123456789abc",
2872
2896
  "values": {
2873
2897
  "contact-name": "Alan Turing",
2874
2898
  "contact-email": "alan@example.com",
@@ -2897,13 +2921,14 @@ var specificExamples = {
2897
2921
  command: `zinkee --json records get contacts ${SAMPLE_UUID}`,
2898
2922
  response: `{
2899
2923
  "recordId": "550e8400-e29b-41d4-a716-446655440000",
2924
+ "url": "https://z2.zinkee.com/r/3f2b1c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d/2eb8bdcf-6d9c-4fbb-9018-7fa8180f4c5e/550e8400-e29b-41d4-a716-446655440000",
2900
2925
  "values": {
2901
2926
  "contact-name": "Ada Lovelace",
2902
2927
  "contact-email": "ada@example.com",
2903
2928
  "status": 2,
2904
2929
  "amount": 1250.50,
2905
2930
  "due-date": "2026-05-15T12:00:00Z",
2906
- "owner": "6c8a3e0d-4e5f-4a1b-9c2d-3e4f5a6b7c8d"
2931
+ "owner": "maria@example.com"
2907
2932
  }
2908
2933
  }`
2909
2934
  }
@@ -3008,6 +3033,24 @@ var specificExamples = {
3008
3033
  "operation": "UPDATE"
3009
3034
  }
3010
3035
  }
3036
+ ]`
3037
+ }
3038
+ ],
3039
+ "members list": [
3040
+ {
3041
+ description: "List the active members of the workspace, sorted by alias (no pending invitations or service accounts). Write the exact 'email' in a member field and filter by it ('eq', 'in'); 'alias' is the display name, the label records aggregate gives a member group. 'currentUser' is true only on the caller's entry with a user token, always false with an API key; member fields do not accept 'myself' when writing.",
3042
+ command: "zinkee --json members list",
3043
+ response: `[
3044
+ {
3045
+ "email": "maria@example.com",
3046
+ "alias": "Mar\xEDa L\xF3pez",
3047
+ "currentUser": true
3048
+ },
3049
+ {
3050
+ "email": "pablo@example.com",
3051
+ "alias": "pablo",
3052
+ "currentUser": false
3053
+ }
3011
3054
  ]`
3012
3055
  }
3013
3056
  ],
@@ -3251,7 +3294,7 @@ var specificExamples = {
3251
3294
  "id": "cccccccc-3333-4333-a333-333333333333",
3252
3295
  "type": "MEMBER",
3253
3296
  "name": "Owner",
3254
- "defaultValue": "6c8a3e0d-4e5f-4a1b-9c2d-3e4f5a6b7c8d",
3297
+ "defaultValue": "maria@example.com",
3255
3298
  "allowMultiple": false,
3256
3299
  "staticVariable": false
3257
3300
  }
@@ -4743,4 +4786,4 @@ function withResponseEnvelope({ responseMeta, ...example }, commandName) {
4743
4786
  export {
4744
4787
  getCommandExamples
4745
4788
  };
4746
- //# sourceMappingURL=examples-RRNLFYD4.js.map
4789
+ //# sourceMappingURL=examples-C7OUOX34.js.map