zinkee 0.1.7 → 0.1.8

package/src/utils/examples.ts

@@ -225,14 +225,10 @@ const specificExamples: Record<string, readonly CommandExample[]> = {
   ]),
   "schemas update": buildCommandExamples([
     {
-      description: "Rename a schema and change its slug.",
-      command:
-        'zinkee --json schemas update contacts --name "Customer Contacts" --slug customer-contacts',
+      description: "Toggle the commentable flag on a schema.",
+      command: 'zinkee --json schemas update contacts --commentable true',
       raw: `{
-  "set": {
-    "name": "Customer Contacts",
-    "slug": "customer-contacts"
-  }
+  "commentable": true
 }`,
       response: `{
   "id": "2eb8bdcf-6d9c-4fbb-9018-7fa8180f4c5e",
@@ -245,38 +241,48 @@ const specificExamples: Record<string, readonly CommandExample[]> = {
   },
   "auditable": true,
   "commentable": true,
-  "fields": []
+  "fields": [
+    {
+      "id": "c60b8526-5835-4c9f-aecd-9a16c7704a34",
+      "type": "TextField",
+      "slug": "contact-name",
+      "label": "Customer Name",
+      "required": true,
+      "system": false,
+      "config": {
+        "textType": "LONG",
+        "defaultValue": "Unknown",
+        "conditionalFormatting": []
+      }
+    }
+  ]
 }`,
     },
     {
-      description: "Enable the audit log on a schema.",
-      command: 'zinkee --json schemas update contacts --auditable true',
+      description: "Rename a schema and change its slug.",
+      command:
+        'zinkee --json schemas update contacts --name "Customer Contacts" --slug customer-contacts',
       raw: `{
-  "set": {
-    "auditable": true
-  }
+  "name": "Customer Contacts",
+  "slug": "customer-contacts"
 }`,
     },
     {
-      description: "Toggle commentable off.",
-      command: 'zinkee --json schemas update contacts --commentable false',
+      description: "Enable the audit log on a schema.",
+      command: 'zinkee --json schemas update contacts --auditable true',
       raw: `{
-  "set": {
-    "commentable": false
-  }
+  "auditable": true
 }`,
     },
   ]),
   "schemas fields update": buildCommandExamples([
     {
-      description: "Rename a field label and drop the required flag.",
+      description: "Rename slug and label.",
       command:
-        'zinkee --json schemas fields update contacts contact-name --label "Customer Full Name" --required false',
+        `zinkee --json schemas fields update contacts contact-name --label "Customer Full Name" --raw '{"slug":"customer-full-name"}'`,
       raw: `{
-  "set": {
-    "label": "Customer Full Name",
-    "required": false
-  }
+  "slug": "customer-full-name",
+  "label": "Customer Full Name"
 }`,
       response: `{
   "schemaId": "2eb8bdcf-6d9c-4fbb-9018-7fa8180f4c5e",
@@ -285,28 +291,171 @@ const specificExamples: Record<string, readonly CommandExample[]> = {
 }`,
     },
     {
-      description: "Make a field required.",
-      command: 'zinkee --json schemas fields update contacts status --required true',
+      description: "Toggle required.",
+      command: "zinkee --json schemas fields update contacts status --required true",
       raw: `{
-  "set": {
-    "required": true
+  "required": true
+}`,
+    },
+    {
+      description: "Patch text field (long with default).",
+      command:
+        `zinkee --json schemas fields update contacts contact-name --raw '{"type":"TextField","label":"Customer Full Name","required":false,"config":{"textType":"LONG","defaultValue":"Unknown","conditionalFormatting":[]}}'`,
+      raw: `{
+  "type": "TextField",
+  "label": "Customer Full Name",
+  "required": false,
+  "config": {
+    "textType": "LONG",
+    "defaultValue": "Unknown",
+    "conditionalFormatting": []
   }
 }`,
     },
     {
-      description:
-        "Patch the format options of a number field through a raw set payload (no dedicated flag exists for nested config paths).",
+      description: "Patch number field (to currency).",
       command:
-        `zinkee --json schemas fields update contacts amount --raw '{"set":{"config":{"formatOptions":{"format":"percent","decimals":1}}}}'`,
+        `zinkee --json schemas fields update contacts amount --raw '{"type":"NumberField","config":{"defaultValue":"0","formatOptions":{"format":"currency","decimals":2,"thousandsSeparator":true,"symbolEnabled":true,"symbolPosition":"before","symbolValue":"€"},"conditionalFormatting":[]}}'`,
       raw: `{
-  "set": {
-    "config": {
-      "formatOptions": {
-        "format": "percent",
-        "decimals": 1
+  "type": "NumberField",
+  "config": {
+    "defaultValue": "0",
+    "formatOptions": {
+      "format": "currency",
+      "decimals": 2,
+      "thousandsSeparator": true,
+      "symbolEnabled": true,
+      "symbolPosition": "before",
+      "symbolValue": "€"
+    },
+    "conditionalFormatting": []
+  }
+}`,
+    },
+    {
+      description: "Patch number field (to percentage).",
+      command:
+        `zinkee --json schemas fields update contacts discount-rate --raw '{"type":"NumberField","config":{"defaultValue":"0","formatOptions":{"format":"percentage","decimals":1},"conditionalFormatting":[]}}'`,
+      raw: `{
+  "type": "NumberField",
+  "config": {
+    "defaultValue": "0",
+    "formatOptions": {
+      "format": "percentage",
+      "decimals": 1
+    },
+    "conditionalFormatting": []
+  }
+}`,
+    },
+    {
+      description: "Patch date field (to date only).",
+      command:
+        `zinkee --json schemas fields update contacts due-date --raw '{"type":"DateField","config":{"defaultValue":null,"formatOptions":{"format":"date","dateFormat":"YYYY-MM-DD","showTime":false},"conditionalFormatting":[]}}'`,
+      raw: `{
+  "type": "DateField",
+  "config": {
+    "defaultValue": null,
+    "formatOptions": {
+      "format": "date",
+      "dateFormat": "YYYY-MM-DD",
+      "showTime": false
+    },
+    "conditionalFormatting": []
+  }
+}`,
+    },
+    {
+      description: "Patch option field (button cycle).",
+      command:
+        `zinkee --json schemas fields update contacts stage --raw '{"type":"OptionField","config":{"options":[{"id":1,"name":"To Do","color":"default"},{"id":2,"name":"Doing","color":"warning"},{"id":3,"name":"Done","color":"success"}],"defaultValue":1,"conditionalFormatting":[],"buttonConfig":{"displayMode":"button","buttonBehavior":{"mode":"cycle","cycleOrder":[1,2,3],"allowReselect":true}}}}'`,
+      raw: `{
+  "type": "OptionField",
+  "config": {
+    "options": [
+      { "id": 1, "name": "To Do", "color": "default" },
+      { "id": 2, "name": "Doing", "color": "warning" },
+      { "id": 3, "name": "Done", "color": "success" }
+    ],
+    "defaultValue": 1,
+    "conditionalFormatting": [],
+    "buttonConfig": {
+      "displayMode": "button",
+      "buttonBehavior": {
+        "mode": "cycle",
+        "cycleOrder": [1, 2, 3],
+        "allowReselect": true
       }
     }
   }
+}`,
+    },
+    {
+      description: "Patch option field (drop button mode).",
+      command:
+        `zinkee --json schemas fields update contacts status --raw '{"type":"OptionField","config":{"options":[{"id":1,"name":"Open","color":"default"},{"id":2,"name":"In Progress","color":"warning"},{"id":3,"name":"Done","color":"success"}],"defaultValue":1,"conditionalFormatting":[],"buttonConfig":null}}'`,
+      raw: `{
+  "type": "OptionField",
+  "config": {
+    "options": [
+      { "id": 1, "name": "Open", "color": "default" },
+      { "id": 2, "name": "In Progress", "color": "warning" },
+      { "id": 3, "name": "Done", "color": "success" }
+    ],
+    "defaultValue": 1,
+    "conditionalFormatting": [],
+    "buttonConfig": null
+  }
+}`,
+    },
+    {
+      description: "Patch formula field (formula text).",
+      command:
+        `zinkee --json schemas fields update contacts formula-total --raw '{"type":"FormulaField","config":{"formulaText":"amount * 1.10","uiFormatKind":"number","status":"ACTIVE","numberFormatOptions":{"format":"number","decimals":2,"thousandsSeparator":true},"conditionalFormatting":[]}}'`,
+      raw: `{
+  "type": "FormulaField",
+  "config": {
+    "formulaText": "amount * 1.10",
+    "uiFormatKind": "number",
+    "status": "ACTIVE",
+    "numberFormatOptions": {
+      "format": "number",
+      "decimals": 2,
+      "thousandsSeparator": true
+    },
+    "conditionalFormatting": []
+  }
+}`,
+    },
+    {
+      description: "Patch reference field (delete behavior).",
+      command:
+        `zinkee --json schemas fields update contacts customer-ref --raw '{"type":"ReferenceField","config":{"targetSchema":"5223cbc8-8c6c-4694-93bc-dd176364df9b","targetDisplayField":"c60b8526-5835-4c9f-aecd-9a16c7704a34","deleteBehavior":"RESTRICT","defaultValue":null,"filterFields":[],"descriptionFields":[],"conditionalFormatting":[]}}'`,
+      raw: `{
+  "type": "ReferenceField",
+  "config": {
+    "targetSchema": "5223cbc8-8c6c-4694-93bc-dd176364df9b",
+    "targetDisplayField": "c60b8526-5835-4c9f-aecd-9a16c7704a34",
+    "deleteBehavior": "RESTRICT",
+    "defaultValue": null,
+    "filterFields": [],
+    "descriptionFields": [],
+    "conditionalFormatting": []
+  }
+}`,
+    },
+    {
+      description: "Patch schedule field (to daily).",
+      command:
+        `zinkee --json schemas fields update contacts recurrence --raw '{"type":"ScheduleField","config":{"referenceField":"c52efe3f-2825-4c60-a7e3-34dd4c1ce043","beginningPeriodField":"d4e5f6a7-b8c9-0d1e-2f3a-4b5c6d7e8f90","endingPeriodField":"d4e5f6a7-b8c9-0d1e-2f3a-4b5c6d7e8f90","frequency":"daily"}}'`,
+      raw: `{
+  "type": "ScheduleField",
+  "config": {
+    "referenceField": "c52efe3f-2825-4c60-a7e3-34dd4c1ce043",
+    "beginningPeriodField": "d4e5f6a7-b8c9-0d1e-2f3a-4b5c6d7e8f90",
+    "endingPeriodField": "d4e5f6a7-b8c9-0d1e-2f3a-4b5c6d7e8f90",
+    "frequency": "daily"
+  }
 }`,
     },
   ]),
@@ -1610,27 +1759,22 @@ const specificExamples: Record<string, readonly CommandExample[]> = {
       "required": true,
       "system": false,
       "config": {
-        "textType": "LONG",
+        "textType": "NORMAL",
         "defaultValue": "Unknown",
         "conditionalFormatting": []
       }
     },
     {
-      "id": "a8f1d7e3-2b5c-4d9e-8a1b-3c4d5e6f7890",
-      "type": "OptionField",
-      "slug": "status",
-      "label": "Status",
+      "id": "1d2e3f4a-5b6c-7d8e-9f01-23456789abcd",
+      "type": "TextField",
+      "slug": "notes",
+      "label": "Notes",
       "required": false,
       "system": false,
       "config": {
-        "options": [
-          { "id": 1, "name": "Open", "color": "default" },
-          { "id": 2, "name": "In Progress", "color": "warning" },
-          { "id": 3, "name": "Done", "color": "success" }
-        ],
-        "defaultValue": 1,
-        "conditionalFormatting": [],
-        "buttonConfig": null
+        "textType": "LONG",
+        "defaultValue": null,
+        "conditionalFormatting": []
       }
     },
     {
@@ -1654,6 +1798,40 @@ const specificExamples: Record<string, readonly CommandExample[]> = {
         "conditionalFormatting": []
       }
     },
+    {
+      "id": "2f3a4b5c-6d7e-8f90-1234-56789abcdef0",
+      "type": "NumberField",
+      "slug": "quantity",
+      "label": "Quantity",
+      "required": false,
+      "system": false,
+      "config": {
+        "defaultValue": "0",
+        "formatOptions": {
+          "format": "number",
+          "decimals": 0,
+          "thousandsSeparator": false
+        },
+        "conditionalFormatting": []
+      }
+    },
+    {
+      "id": "3a4b5c6d-7e8f-9012-3456-789abcdef012",
+      "type": "NumberField",
+      "slug": "discount-rate",
+      "label": "Discount Rate",
+      "required": false,
+      "system": false,
+      "config": {
+        "defaultValue": "0",
+        "formatOptions": {
+          "format": "percentage",
+          "decimals": 1,
+          "negativesInRed": true
+        },
+        "conditionalFormatting": []
+      }
+    },
     {
       "id": "d4e5f6a7-b8c9-0d1e-2f3a-4b5c6d7e8f90",
       "type": "DateField",
@@ -1671,6 +1849,203 @@ const specificExamples: Record<string, readonly CommandExample[]> = {
         "conditionalFormatting": []
       }
     },
+    {
+      "id": "4b5c6d7e-8f90-1234-5678-9abcdef01234",
+      "type": "DateField",
+      "slug": "birth-date",
+      "label": "Birth Date",
+      "required": false,
+      "system": false,
+      "config": {
+        "defaultValue": null,
+        "formatOptions": {
+          "format": "date",
+          "dateFormat": "YYYY-MM-DD",
+          "showTime": false
+        },
+        "conditionalFormatting": []
+      }
+    },
+    {
+      "id": "a8f1d7e3-2b5c-4d9e-8a1b-3c4d5e6f7890",
+      "type": "OptionField",
+      "slug": "status",
+      "label": "Status",
+      "required": false,
+      "system": false,
+      "config": {
+        "options": [
+          { "id": 1, "name": "Open", "color": "default" },
+          { "id": 2, "name": "In Progress", "color": "warning" },
+          { "id": 3, "name": "Done", "color": "success" }
+        ],
+        "defaultValue": 1,
+        "conditionalFormatting": [],
+        "buttonConfig": null
+      }
+    },
+    {
+      "id": "5c6d7e8f-9012-3456-789a-bcdef0123456",
+      "type": "OptionField",
+      "slug": "stage",
+      "label": "Stage",
+      "required": false,
+      "system": false,
+      "config": {
+        "options": [
+          { "id": 1, "name": "To Do", "color": "default" },
+          { "id": 2, "name": "Doing", "color": "warning" },
+          { "id": 3, "name": "Done", "color": "success" }
+        ],
+        "defaultValue": 1,
+        "conditionalFormatting": [],
+        "buttonConfig": {
+          "displayMode": "button",
+          "buttonBehavior": {
+            "mode": "cycle",
+            "cycleOrder": [1, 2, 3],
+            "requireConfirmation": false,
+            "lockAfterSelection": false,
+            "allowReselect": true
+          }
+        }
+      }
+    },
+    {
+      "id": "3e9f8c12-4a5b-6c7d-8e9f-0a1b2c3d4e5f",
+      "type": "FormulaField",
+      "slug": "formula-total",
+      "label": "Formula Total",
+      "required": false,
+      "system": false,
+      "config": {
+        "formulaText": "amount * 1.21",
+        "uiFormatKind": "number",
+        "status": "ACTIVE",
+        "defaultValue": null,
+        "numberFormatOptions": {
+          "format": "number",
+          "decimals": 2,
+          "thousandsSeparator": true
+        },
+        "conditionalFormatting": []
+      }
+    },
+    {
+      "id": "6d7e8f90-1234-5678-9abc-def012345678",
+      "type": "FormulaField",
+      "slug": "formula-deadline",
+      "label": "Computed Deadline",
+      "required": false,
+      "system": false,
+      "config": {
+        "formulaText": "addDays(startDate, 7)",
+        "uiFormatKind": "date",
+        "status": "ACTIVE",
+        "defaultValue": null,
+        "dateFormatOptions": {
+          "format": "date",
+          "dateFormat": "DD/MM/YYYY",
+          "showTime": false
+        },
+        "conditionalFormatting": []
+      }
+    },
+    {
+      "id": "45c5da96-0dc2-4cc1-ba61-7660a9c6da32",
+      "type": "ReferenceField",
+      "slug": "customer-ref",
+      "label": "Customer",
+      "required": false,
+      "system": false,
+      "config": {
+        "targetSchema": "5223cbc8-8c6c-4694-93bc-dd176364df9b",
+        "targetDisplayField": "c60b8526-5835-4c9f-aecd-9a16c7704a34",
+        "deleteBehavior": "SET_NULL",
+        "defaultValue": null,
+        "filterFields": [],
+        "descriptionFields": [],
+        "conditionalFormatting": []
+      }
+    },
+    {
+      "id": "7e8f9012-3456-789a-bcde-f01234567890",
+      "type": "ReferenceField",
+      "slug": "company-ref",
+      "label": "Company",
+      "required": false,
+      "system": false,
+      "config": {
+        "targetSchema": "5223cbc8-8c6c-4694-93bc-dd176364df9b",
+        "targetDisplayField": "c60b8526-5835-4c9f-aecd-9a16c7704a34",
+        "deleteBehavior": "RESTRICT",
+        "defaultValue": null,
+        "filterFields": [],
+        "descriptionFields": [],
+        "conditionalFormatting": []
+      }
+    },
+    {
+      "id": "b2c3d4e5-f6a7-8b9c-0d1e-2f3a4b5c6d7e",
+      "type": "AutoIncrementalField",
+      "slug": "sequence-code",
+      "label": "Sequence Code",
+      "required": false,
+      "system": true,
+      "config": {
+        "segmentedByFieldId": "45c5da96-0dc2-4cc1-ba61-7660a9c6da32",
+        "conditionalFormatting": []
+      }
+    },
+    {
+      "id": "8f901234-5678-9abc-def0-123456789012",
+      "type": "AutoIncrementalField",
+      "slug": "order-number",
+      "label": "Order Number",
+      "required": false,
+      "system": true,
+      "config": {
+        "segmentedByFieldId": null,
+        "conditionalFormatting": []
+      }
+    },
+    {
+      "id": "e5f6a7b8-c9d0-1e2f-3a4b-5c6d7e8f9012",
+      "type": "FileField",
+      "slug": "attachment",
+      "label": "Attachment",
+      "required": false,
+      "system": false,
+      "config": {}
+    },
+    {
+      "id": "f6a7b8c9-d0e1-2f3a-4b5c-6d7e8f901234",
+      "type": "ScheduleField",
+      "slug": "recurrence",
+      "label": "Recurrence",
+      "required": false,
+      "system": false,
+      "config": {
+        "referenceField": "c52efe3f-2825-4c60-a7e3-34dd4c1ce043",
+        "beginningPeriodField": "d4e5f6a7-b8c9-0d1e-2f3a-4b5c6d7e8f90",
+        "endingPeriodField": "d4e5f6a7-b8c9-0d1e-2f3a-4b5c6d7e8f90",
+        "frequency": "monthly"
+      }
+    },
+    {
+      "id": "9012abcd-ef01-2345-6789-abcdef012345",
+      "type": "ScheduleField",
+      "slug": "daily-recurrence",
+      "label": "Daily Recurrence",
+      "required": false,
+      "system": false,
+      "config": {
+        "referenceField": "c52efe3f-2825-4c60-a7e3-34dd4c1ce043",
+        "beginningPeriodField": "d4e5f6a7-b8c9-0d1e-2f3a-4b5c6d7e8f90",
+        "endingPeriodField": "d4e5f6a7-b8c9-0d1e-2f3a-4b5c6d7e8f90",
+        "frequency": "daily"
+      }
+    },
     {
       "id": "a7b8c9d0-e1f2-3a4b-5c6d-7e8f90123456",
       "type": "MemberField",
@@ -3265,26 +3640,32 @@ function buildSchemaFieldCreateExamples(type?: string): readonly CommandExample[
     ? definitions.filter((definition) => definition.key === selectedDefinition.key)
     : definitions;
 
+  const flat = filteredDefinitions.flatMap((definition) =>
+    definition.examplePayloads.map((example) => ({ definition, example })),
+  );
+
   return buildCommandExamples(
-    filteredDefinitions.flatMap((definition) => {
-      if (definition.key !== "number") {
-        return [{
-          description: `Create a ${definition.key} field`,
-          command: `zinkee --json schemas fields create contacts --raw '${JSON.stringify(definition.examplePayload)}'`,
-        }];
+    flat.map(({ example }, index) => {
+      const slug =
+        typeof example.payload.slug === "string" ? example.payload.slug : "field";
+      const command = `zinkee --json schemas fields create contacts --raw '${JSON.stringify(example.payload)}'`;
+
+      if (index === 0) {
+        return {
+          description: example.name,
+          command,
+          response: `{
+  "schemaId": "2eb8bdcf-6d9c-4fbb-9018-7fa8180f4c5e",
+  "fieldId": "a8f1d7e3-2b5c-4d9e-8a1b-3c4d5e6f7890",
+  "slug": "${slug}"
+}`,
+        };
       }
 
-      return [
-        {
-          description: "Create a plain number field",
-          command:
-            'zinkee --json schemas fields create contacts --raw \'{"type":"number","slug":"amount","label":"Amount"}\'',
-        },
-        {
-          description: "Create a number field formatted like Moneda",
-          command: `zinkee --json schemas fields create contacts --raw '${JSON.stringify(definition.examplePayload)}'`,
-        },
-      ];
+      return {
+        description: example.name,
+        command,
+      };
     }),
   );
 }