kintone-pretty-fields 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) Cybozu, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,138 @@
+# kintone-pretty-fields
+
+Retrieve kintone form field([@kintone/rest-api-client](https://www.npmjs.com/package/@kintone/rest-api-client)) information in a pretty format.
+
+- [Description](#description)
+- [Installation](#installation)
+- [Usage](#usage)
+- [License](#license)
+
+## Description
+
+Provides the field information needed to create a kintone plugin.
+
+1. Get both field and spacer.  
+Check[ Kintone Developer Program ](https://kintone.dev/en/docs/kintone/rest-api/apps/get-form-fields/#response-parameters)for property details.
+
+2. Obtain in layout order. (top left first, bottom right after)
+
+3. Determine the fields in a table.  
+Set the table field code to the table property.
+
+```js
+{
+  type: 'SINGLE_LINE_TEXT',
+  code: '文字列__1行_',
+  label: '文字列 (1行)',
+  noLabel: false,
+  required: false,
+  minLength: '',
+  maxLength: '',
+  expression: '',
+  hideExpression: false,
+  unique: false,
+  defaultValue: '',
+  table: 'テーブル' // table field code
+}
+```
+
+4. Determine the fields in a group.  
+Set the group field code to the group property.
+```js
+  {
+    type: 'SINGLE_LINE_TEXT',
+    code: '文字列__1行_',
+    label: '文字列 (1行)',
+    noLabel: false,
+    required: false,
+    minLength: '',
+    maxLength: '',
+    expression: '',
+    hideExpression: false,
+    unique: false,
+    defaultValue: '',
+    group: 'グループ' // group field code
+  }
+```
+
+5. Determine the destination field for copying lookups.  
+Set the true to the isLookupCopy property.(Requires lookup source app permissions)
+```js
+{
+  type: 'SINGLE_LINE_TEXT',
+  code: '文字列__1行_',
+  label: '文字列 (1行)',
+  noLabel: false,
+  required: false,
+  minLength: '',
+  maxLength: '',
+  expression: '',
+  hideExpression: false,
+  unique: false,
+  defaultValue: '',
+  isLookupCopy: true // If true, lookup copy destination field
+}
+```
+
+6. Sorts the values of the options.
+```js
+{
+  type: 'CHECK_BOX',
+  code: 'チェックボックス',
+  label: 'チェックボックス',
+  noLabel: false,
+  required: false,
+  options: {
+    sample1: { label: 'sample1', index: '0' },
+    sample4: { label: 'sample4', index: '3' },
+    sample3: { label: 'sample3', index: '2' },
+    sample2: { label: 'sample2', index: '1' }
+  },
+  defaultValue: [],
+  align: 'HORIZONTAL',
+  sortedOptions: [ 'sample1', 'sample2', 'sample3', 'sample4' ] // sorted options
+}
+```
+
+## Installation
+
+### 1. Install with `npm`
+
+This library is distributed on `npm`.
+
+```shell
+npm install kintone-pretty-fields
+```
+
+You can then use `import` to import the library.
+
+```ts
+// ES modules
+import { kintonePrettyFields } from "kintone-pretty-fields";
+```
+
+## Usage
+
+Here is a sample code that retrieves form fields of an app.
+
+```ts
+import { KintoneRestAPIClient } from "@kintone/rest-api-client";
+import { kintonePrettyFields } from "kintone-pretty-fields";
+
+const client = new KintoneRestAPIClient();
+const { fields, spacers } = await kintonePrettyFields.get({ client, app: 1, lang: "en", preview: false });
+console.log({ fields, spacers });
+
+for (const field of fields) {
+  if (kintonePrettyFields.isSingleLineText(field)) {
+    // do something
+  }
+  if (kintonePrettyFields.isDate(field)) {
+    // do something
+  }
+}
+```
+
+## License
+
+- [MIT](https://github.com/kintone/js-sdk/tree/master/LICENSE)

package/dist/index.js

@@ -0,0 +1,139 @@
+var j = typeof globalThis < "u" ? globalThis : typeof window < "u" ? window : typeof global < "u" ? global : typeof self < "u" ? self : {}, F = { exports: {} };
+(function(t, a) {
+  (function(o, c) {
+    c(a);
+  })(j, function(o) {
+    const c = Object.freeze(Object.defineProperty({ __proto__: null, isCalc: (e) => e.type === "CALC", isCategory: (e) => e.type === "CATEGORY", isCheckBox: (e) => e.type === "CHECK_BOX", isCreatedTime: (e) => e.type === "CREATED_TIME", isCreator: (e) => e.type === "CREATOR", isDate: (e) => e.type === "DATE", isDatetime: (e) => e.type === "DATETIME", isDropDown: (e) => e.type === "DROP_DOWN", isFile: (e) => e.type === "FILE", isGroup: (e) => e.type === "GROUP", isGroupSelect: (e) => e.type === "GROUP_SELECT", isLink: (e) => e.type === "LINK", isLookup: (e) => (e.type === "SINGLE_LINE_TEXT" || e.type === "NUMBER") && "lookup" in e, isModifier: (e) => e.type === "MODIFIER", isMultiLineText: (e) => e.type === "MULTI_LINE_TEXT", isMultiSelect: (e) => e.type === "MULTI_SELECT", isNumber: (e) => e.type === "NUMBER", isOrganizationSelect: (e) => e.type === "ORGANIZATION_SELECT", isRadioButton: (e) => e.type === "RADIO_BUTTON", isRecordNumber: (e) => e.type === "RECORD_NUMBER", isReferenceTable: (e) => e.type === "REFERENCE_TABLE", isRichText: (e) => e.type === "RICH_TEXT", isSingleLineText: (e) => e.type === "SINGLE_LINE_TEXT", isStatus: (e) => e.type === "STATUS", isStatusAssignee: (e) => e.type === "STATUS_ASSIGNEE", isSubtable: (e) => e.type === "SUBTABLE", isTime: (e) => e.type === "TIME", isUpdatedTime: (e) => e.type === "UPDATED_TIME", isUserSelect: (e) => e.type === "USER_SELECT" }, Symbol.toStringTag, { value: "Module" })), E = Object.freeze(Object.defineProperty({ __proto__: null, isCalc: (e) => e.type === "CALC", isCheckBox: (e) => e.type === "CHECK_BOX", isCreatedTime: (e) => e.type === "CREATED_TIME", isCreator: (e) => e.type === "CREATOR", isDate: (e) => e.type === "DATE", isDatetime: (e) => e.type === "DATETIME", isDropDown: (e) => e.type === "DROP_DOWN", isFile: (e) => e.type === "FILE", isGroup: (e) => e.type === "GROUP", isGroupSelect: (e) => e.type === "GROUP_SELECT", isHr: (e) => e.type === "HR", isLabel: (e) => e.type === "LABEL", isLink: (e) => e.type === "LINK", isModifier: (e) => e.type === "MODIFIER", isMultiLineText: (e) => e.type === "MULTI_LINE_TEXT", isMultiSelect: (e) => e.type === "MULTI_SELECT", isNumber: (e) => e.type === "NUMBER", isOrganizationSelect: (e) => e.type === "ORGANIZATION_SELECT", isRadioButon: (e) => e.type === "RADIO_BUTTON", isRecordNumber: (e) => e.type === "RECORD_NUMBER", isReferenceTable: (e) => e.type === "REFERENCE_TABLE", isRichText: (e) => e.type === "RICH_TEXT", isRow: (e) => e.type === "ROW", isSingleLineText: (e) => e.type === "SINGLE_LINE_TEXT", isSpacer: (e) => e.type === "SPACER", isSubtable: (e) => e.type === "SUBTABLE", isTime: (e) => e.type === "TIME", isUpdatedTime: (e) => e.type === "UPDATED_TIME", isUserSelect: (e) => e.type === "USER_SELECT" }, Symbol.toStringTag, { value: "Module" })), T = Object.freeze(Object.defineProperty({ __proto__: null, isCalc: (e) => e.type === "CALC", isCategory: (e) => e.type === "CATEGORY", isCheckBox: (e) => e.type === "CHECK_BOX", isCreatedTime: (e) => e.type === "CREATED_TIME", isCreator: (e) => e.type === "CREATOR", isDate: (e) => e.type === "DATE", isDatetime: (e) => e.type === "DATETIME", isDropDown: (e) => e.type === "DROP_DOWN", isFile: (e) => e.type === "FILE", isGroupSelect: (e) => e.type === "GROUP_SELECT", isLink: (e) => e.type === "LINK", isModifier: (e) => e.type === "MODIFIER", isMultiLineText: (e) => e.type === "MULTI_LINE_TEXT", isMultiSelect: (e) => e.type === "MULTI_SELECT", isNumber: (e) => e.type === "NUMBER", isOrganizationSelect: (e) => e.type === "ORGANIZATION_SELECT", isRadioButton: (e) => e.type === "RADIO_BUTTON", isRecordNumber: (e) => e.type === "RECORD_NUMBER", isRichText: (e) => e.type === "RICH_TEXT", isSingleLineText: (e) => e.type === "SINGLE_LINE_TEXT", isStatus: (e) => e.type === "STATUS", isStatusAssignee: (e) => e.type === "STATUS_ASSIGNEE", isSubtable: (e) => e.type === "SUBTABLE", isTime: (e) => e.type === "TIME", isUpdatedTime: (e) => e.type === "UPDATED_TIME", isUserSelect: (e) => e.type === "USER_SELECT" }, Symbol.toStringTag, { value: "Module" }));
+    o.guardFormField = c, o.guardFormLayout = E, o.guardRecord = T, Object.defineProperty(o, Symbol.toStringTag, { value: "Module" });
+  });
+})(F, F.exports);
+var i = F.exports;
+const X = (t) => t.type === "RECORD_NUMBER", v = (t) => t.type === "CREATOR", w = (t) => t.type === "CREATED_TIME", H = (t) => t.type === "MODIFIER", K = (t) => t.type === "UPDATED_TIME", f = (t) => t.type === "SINGLE_LINE_TEXT", O = (t) => t.type === "MULTI_LINE_TEXT", I = (t) => t.type === "RICH_TEXT", A = (t) => t.type === "NUMBER", z = (t) => t.type === "CALC", b = (t) => t.type === "CHECK_BOX", N = (t) => t.type === "RADIO_BUTTON", D = (t) => t.type === "MULTI_SELECT", M = (t) => t.type === "DROP_DOWN", U = (t) => t.type === "USER_SELECT", B = (t) => t.type === "ORGANIZATION_SELECT", G = (t) => t.type === "GROUP_SELECT", h = (t) => t.type === "DATE", x = (t) => t.type === "TIME", P = (t) => t.type === "DATETIME", k = (t) => t.type === "LINK", W = (t) => t.type === "FILE", Z = (t) => (t.type === "SINGLE_LINE_TEXT" || t.type === "NUMBER") && "lookup" in t, Y = (t) => t.type === "SUBTABLE", q = (t) => t.type === "GROUP", J = (t) => t.type === "REFERENCE_TABLE", Q = (t) => t.type === "CATEGORY", V = (t) => t.type === "STATUS", $ = (t) => t.type === "STATUS_ASSIGNEE", y = (t) => Object.values(t).sort((a, o) => Number(a.index) - Number(o.index)).map(({ label: a }) => a), ee = (t, a) => {
+  var C;
+  const o = [], c = [], E = Object.values(t).find(i.guardFormField.isStatus);
+  E && E.enabled && o.push(E);
+  const T = Object.values(t).find(i.guardFormField.isStatusAssignee);
+  T && T.enabled && o.push(T);
+  const e = Object.values(t).find(i.guardFormField.isCategory);
+  e && e.enabled && o.push(e);
+  for (const u of a)
+    if (i.guardFormLayout.isRow(u))
+      for (const r of u.fields) {
+        if (i.guardFormLayout.isLabel(r) || i.guardFormLayout.isHr(r))
+          continue;
+        if (i.guardFormLayout.isSpacer(r)) {
+          c.push(r);
+          continue;
+        }
+        const d = t[r.code];
+        if (!i.guardFormField.isSubtable(d) && !i.guardFormField.isGroup(d)) {
+          if (i.guardFormField.isCheckBox(d) || i.guardFormField.isDropDown(d) || i.guardFormField.isMultiSelect(d) || i.guardFormField.isRadioButton(d)) {
+            const s = y(d.options);
+            o.push({ ...d, sortedOptions: s });
+            continue;
+          }
+          o.push(d);
+        }
+      }
+    else if (i.guardFormLayout.isSubtable(u)) {
+      const r = u.code, d = t[r];
+      if (!i.guardFormField.isSubtable(d))
+        continue;
+      const s = {};
+      for (const { code: l } of u.fields) {
+        const p = d.fields[l];
+        if (i.guardFormField.isCheckBox(p) || i.guardFormField.isDropDown(p) || i.guardFormField.isMultiSelect(p) || i.guardFormField.isRadioButton(p)) {
+          const n = y(p.options);
+          s[p.code] = { ...p, table: r, sortedOptions: n }, o.push({ ...p, table: r, sortedOptions: n });
+          continue;
+        }
+        s[p.code] = { ...p, table: r }, o.push({ ...p, table: r });
+      }
+      o.push({ ...d, fields: s });
+    } else if (i.guardFormLayout.isGroup(u)) {
+      const r = u.code, d = t[r];
+      if (!i.guardFormField.isGroup(d))
+        continue;
+      const s = {};
+      for (const l of u.layout)
+        for (const p of l.fields) {
+          if (i.guardFormLayout.isLabel(p) || i.guardFormLayout.isHr(p))
+            continue;
+          if (i.guardFormLayout.isSpacer(p)) {
+            c.push(p);
+            continue;
+          }
+          const n = t[p.code];
+          if (!i.guardFormField.isCategory(n) && !i.guardFormField.isStatus(n) && !i.guardFormField.isStatusAssignee(n) && !i.guardFormField.isSubtable(n) && !i.guardFormField.isGroup(n)) {
+            if (i.guardFormField.isCheckBox(n) || i.guardFormField.isDropDown(n) || i.guardFormField.isMultiSelect(n) || i.guardFormField.isRadioButton(n)) {
+              const _ = y(n.options);
+              s[n.code] = { ...n, group: r, sortedOptions: _ }, o.push({ ...n, group: r, sortedOptions: _ });
+              continue;
+            }
+            s[n.code] = { ...n, group: r }, o.push({ ...n, group: r });
+          }
+        }
+      o.push({ ...d, fields: s });
+    }
+  for (const u of Object.values(o))
+    if (i.guardFormField.isLookup(u)) {
+      if (u.lookup === null)
+        continue;
+      for (const r of u.lookup.fieldMappings) {
+        const d = (C = o.filter(
+          (s) => f(s) || A(s) || O(s) || I(s) || k(s) || b(s) || N(s) || M(s) || D(s) || h(s) || x(s) || P(s) || U(s) || B(s) || G(s)
+        )) == null ? void 0 : C.find((s) => s.code === r.field);
+        d && (d.isLookupCopy = !0);
+      }
+    }
+  const S = Object.values(t).find(i.guardFormField.isRecordNumber);
+  S && (o.some(i.guardFormField.isRecordNumber) || o.push(S));
+  const m = Object.values(t).find(i.guardFormField.isCreator);
+  m && (o.some(i.guardFormField.isCreator) || o.push(m));
+  const R = Object.values(t).find(i.guardFormField.isCreatedTime);
+  R && (o.some(i.guardFormField.isCreatedTime) || o.push(R));
+  const L = Object.values(t).find(i.guardFormField.isModifier);
+  L && (o.some(i.guardFormField.isModifier) || o.push(L));
+  const g = Object.values(t).find(i.guardFormField.isUpdatedTime);
+  return g && (o.some(i.guardFormField.isUpdatedTime) || o.push(g)), { fields: o, spacers: c };
+}, te = async ({ client: t, app: a, lang: o, preview: c }) => {
+  const [{ properties: E }, { layout: T }] = await Promise.all([
+    t.app.getFormFields({ app: a, lang: o, preview: c }),
+    t.app.getFormLayout({ app: a, preview: c })
+  ]);
+  return ee(E, T);
+}, ie = {
+  get: te,
+  isRecordNumber: X,
+  isCreator: v,
+  isCreatedTime: w,
+  isModifier: H,
+  isUpdatedTime: K,
+  isSingleLineText: f,
+  isMultiLineText: O,
+  isRichText: I,
+  isNumber: A,
+  isCalc: z,
+  isCheckBox: b,
+  isRadioButton: N,
+  isMultiSelect: D,
+  isDropDown: M,
+  isUserSelect: U,
+  isOrganizationSelect: B,
+  isGroupSelect: G,
+  isDate: h,
+  isTime: x,
+  isDatetime: P,
+  isLink: k,
+  isFile: W,
+  isLookup: Z,
+  isSubtable: Y,
+  isGroup: q,
+  isReferenceTable: J,
+  isCategory: Q,
+  isStatus: V,
+  isStatusAssignee: $
+};
+export {
+  ie as kintonePrettyFields
+};

package/dist/index.umd.cjs

@@ -0,0 +1 @@
+(function(E,y){typeof exports=="object"&&typeof module<"u"?y(exports):typeof define=="function"&&define.amd?define(["exports"],y):(E=typeof globalThis<"u"?globalThis:E||self,y(E.KintonePrettyFields={}))})(this,function(E){"use strict";var y=typeof globalThis<"u"?globalThis:typeof window<"u"?window:typeof global<"u"?global:typeof self<"u"?self:{},F={exports:{}};(function(t,a){(function(o,c){c(a)})(y,function(o){const c=Object.freeze(Object.defineProperty({__proto__:null,isCalc:e=>e.type==="CALC",isCategory:e=>e.type==="CATEGORY",isCheckBox:e=>e.type==="CHECK_BOX",isCreatedTime:e=>e.type==="CREATED_TIME",isCreator:e=>e.type==="CREATOR",isDate:e=>e.type==="DATE",isDatetime:e=>e.type==="DATETIME",isDropDown:e=>e.type==="DROP_DOWN",isFile:e=>e.type==="FILE",isGroup:e=>e.type==="GROUP",isGroupSelect:e=>e.type==="GROUP_SELECT",isLink:e=>e.type==="LINK",isLookup:e=>(e.type==="SINGLE_LINE_TEXT"||e.type==="NUMBER")&&"lookup"in e,isModifier:e=>e.type==="MODIFIER",isMultiLineText:e=>e.type==="MULTI_LINE_TEXT",isMultiSelect:e=>e.type==="MULTI_SELECT",isNumber:e=>e.type==="NUMBER",isOrganizationSelect:e=>e.type==="ORGANIZATION_SELECT",isRadioButton:e=>e.type==="RADIO_BUTTON",isRecordNumber:e=>e.type==="RECORD_NUMBER",isReferenceTable:e=>e.type==="REFERENCE_TABLE",isRichText:e=>e.type==="RICH_TEXT",isSingleLineText:e=>e.type==="SINGLE_LINE_TEXT",isStatus:e=>e.type==="STATUS",isStatusAssignee:e=>e.type==="STATUS_ASSIGNEE",isSubtable:e=>e.type==="SUBTABLE",isTime:e=>e.type==="TIME",isUpdatedTime:e=>e.type==="UPDATED_TIME",isUserSelect:e=>e.type==="USER_SELECT"},Symbol.toStringTag,{value:"Module"})),l=Object.freeze(Object.defineProperty({__proto__:null,isCalc:e=>e.type==="CALC",isCheckBox:e=>e.type==="CHECK_BOX",isCreatedTime:e=>e.type==="CREATED_TIME",isCreator:e=>e.type==="CREATOR",isDate:e=>e.type==="DATE",isDatetime:e=>e.type==="DATETIME",isDropDown:e=>e.type==="DROP_DOWN",isFile:e=>e.type==="FILE",isGroup:e=>e.type==="GROUP",isGroupSelect:e=>e.type==="GROUP_SELECT",isHr:e=>e.type==="HR",isLabel:e=>e.type==="LABEL",isLink:e=>e.type==="LINK",isModifier:e=>e.type==="MODIFIER",isMultiLineText:e=>e.type==="MULTI_LINE_TEXT",isMultiSelect:e=>e.type==="MULTI_SELECT",isNumber:e=>e.type==="NUMBER",isOrganizationSelect:e=>e.type==="ORGANIZATION_SELECT",isRadioButon:e=>e.type==="RADIO_BUTTON",isRecordNumber:e=>e.type==="RECORD_NUMBER",isReferenceTable:e=>e.type==="REFERENCE_TABLE",isRichText:e=>e.type==="RICH_TEXT",isRow:e=>e.type==="ROW",isSingleLineText:e=>e.type==="SINGLE_LINE_TEXT",isSpacer:e=>e.type==="SPACER",isSubtable:e=>e.type==="SUBTABLE",isTime:e=>e.type==="TIME",isUpdatedTime:e=>e.type==="UPDATED_TIME",isUserSelect:e=>e.type==="USER_SELECT"},Symbol.toStringTag,{value:"Module"})),T=Object.freeze(Object.defineProperty({__proto__:null,isCalc:e=>e.type==="CALC",isCategory:e=>e.type==="CATEGORY",isCheckBox:e=>e.type==="CHECK_BOX",isCreatedTime:e=>e.type==="CREATED_TIME",isCreator:e=>e.type==="CREATOR",isDate:e=>e.type==="DATE",isDatetime:e=>e.type==="DATETIME",isDropDown:e=>e.type==="DROP_DOWN",isFile:e=>e.type==="FILE",isGroupSelect:e=>e.type==="GROUP_SELECT",isLink:e=>e.type==="LINK",isModifier:e=>e.type==="MODIFIER",isMultiLineText:e=>e.type==="MULTI_LINE_TEXT",isMultiSelect:e=>e.type==="MULTI_SELECT",isNumber:e=>e.type==="NUMBER",isOrganizationSelect:e=>e.type==="ORGANIZATION_SELECT",isRadioButton:e=>e.type==="RADIO_BUTTON",isRecordNumber:e=>e.type==="RECORD_NUMBER",isRichText:e=>e.type==="RICH_TEXT",isSingleLineText:e=>e.type==="SINGLE_LINE_TEXT",isStatus:e=>e.type==="STATUS",isStatusAssignee:e=>e.type==="STATUS_ASSIGNEE",isSubtable:e=>e.type==="SUBTABLE",isTime:e=>e.type==="TIME",isUpdatedTime:e=>e.type==="UPDATED_TIME",isUserSelect:e=>e.type==="USER_SELECT"},Symbol.toStringTag,{value:"Module"}));o.guardFormField=c,o.guardFormLayout=l,o.guardRecord=T,Object.defineProperty(o,Symbol.toStringTag,{value:"Module"})})})(F,F.exports);var i=F.exports;const v=t=>t.type==="RECORD_NUMBER",w=t=>t.type==="CREATOR",H=t=>t.type==="CREATED_TIME",K=t=>t.type==="MODIFIER",z=t=>t.type==="UPDATED_TIME",R=t=>t.type==="SINGLE_LINE_TEXT",f=t=>t.type==="MULTI_LINE_TEXT",L=t=>t.type==="RICH_TEXT",g=t=>t.type==="NUMBER",W=t=>t.type==="CALC",C=t=>t.type==="CHECK_BOX",_=t=>t.type==="RADIO_BUTTON",O=t=>t.type==="MULTI_SELECT",I=t=>t.type==="DROP_DOWN",b=t=>t.type==="USER_SELECT",A=t=>t.type==="ORGANIZATION_SELECT",N=t=>t.type==="GROUP_SELECT",D=t=>t.type==="DATE",M=t=>t.type==="TIME",U=t=>t.type==="DATETIME",B=t=>t.type==="LINK",Z=t=>t.type==="FILE",Y=t=>(t.type==="SINGLE_LINE_TEXT"||t.type==="NUMBER")&&"lookup"in t,q=t=>t.type==="SUBTABLE",J=t=>t.type==="GROUP",Q=t=>t.type==="REFERENCE_TABLE",V=t=>t.type==="CATEGORY",$=t=>t.type==="STATUS",ee=t=>t.type==="STATUS_ASSIGNEE",m=t=>Object.values(t).sort((a,o)=>Number(a.index)-Number(o.index)).map(({label:a})=>a),te=(t,a)=>{var j;const o=[],c=[],l=Object.values(t).find(i.guardFormField.isStatus);l&&l.enabled&&o.push(l);const T=Object.values(t).find(i.guardFormField.isStatusAssignee);T&&T.enabled&&o.push(T);const e=Object.values(t).find(i.guardFormField.isCategory);e&&e.enabled&&o.push(e);for(const u of a)if(i.guardFormLayout.isRow(u))for(const r of u.fields){if(i.guardFormLayout.isLabel(r)||i.guardFormLayout.isHr(r))continue;if(i.guardFormLayout.isSpacer(r)){c.push(r);continue}const n=t[r.code];if(!i.guardFormField.isSubtable(n)&&!i.guardFormField.isGroup(n)){if(i.guardFormField.isCheckBox(n)||i.guardFormField.isDropDown(n)||i.guardFormField.isMultiSelect(n)||i.guardFormField.isRadioButton(n)){const s=m(n.options);o.push({...n,sortedOptions:s});continue}o.push(n)}}else if(i.guardFormLayout.isSubtable(u)){const r=u.code,n=t[r];if(!i.guardFormField.isSubtable(n))continue;const s={};for(const{code:S}of u.fields){const p=n.fields[S];if(i.guardFormField.isCheckBox(p)||i.guardFormField.isDropDown(p)||i.guardFormField.isMultiSelect(p)||i.guardFormField.isRadioButton(p)){const d=m(p.options);s[p.code]={...p,table:r,sortedOptions:d},o.push({...p,table:r,sortedOptions:d});continue}s[p.code]={...p,table:r},o.push({...p,table:r})}o.push({...n,fields:s})}else if(i.guardFormLayout.isGroup(u)){const r=u.code,n=t[r];if(!i.guardFormField.isGroup(n))continue;const s={};for(const S of u.layout)for(const p of S.fields){if(i.guardFormLayout.isLabel(p)||i.guardFormLayout.isHr(p))continue;if(i.guardFormLayout.isSpacer(p)){c.push(p);continue}const d=t[p.code];if(!i.guardFormField.isCategory(d)&&!i.guardFormField.isStatus(d)&&!i.guardFormField.isStatusAssignee(d)&&!i.guardFormField.isSubtable(d)&&!i.guardFormField.isGroup(d)){if(i.guardFormField.isCheckBox(d)||i.guardFormField.isDropDown(d)||i.guardFormField.isMultiSelect(d)||i.guardFormField.isRadioButton(d)){const X=m(d.options);s[d.code]={...d,group:r,sortedOptions:X},o.push({...d,group:r,sortedOptions:X});continue}s[d.code]={...d,group:r},o.push({...d,group:r})}}o.push({...n,fields:s})}for(const u of Object.values(o))if(i.guardFormField.isLookup(u)){if(u.lookup===null)continue;for(const r of u.lookup.fieldMappings){const n=(j=o.filter(s=>R(s)||g(s)||f(s)||L(s)||B(s)||C(s)||_(s)||I(s)||O(s)||D(s)||M(s)||U(s)||b(s)||A(s)||N(s)))==null?void 0:j.find(s=>s.code===r.field);n&&(n.isLookupCopy=!0)}}const G=Object.values(t).find(i.guardFormField.isRecordNumber);G&&(o.some(i.guardFormField.isRecordNumber)||o.push(G));const h=Object.values(t).find(i.guardFormField.isCreator);h&&(o.some(i.guardFormField.isCreator)||o.push(h));const x=Object.values(t).find(i.guardFormField.isCreatedTime);x&&(o.some(i.guardFormField.isCreatedTime)||o.push(x));const P=Object.values(t).find(i.guardFormField.isModifier);P&&(o.some(i.guardFormField.isModifier)||o.push(P));const k=Object.values(t).find(i.guardFormField.isUpdatedTime);return k&&(o.some(i.guardFormField.isUpdatedTime)||o.push(k)),{fields:o,spacers:c}},ie={get:async({client:t,app:a,lang:o,preview:c})=>{const[{properties:l},{layout:T}]=await Promise.all([t.app.getFormFields({app:a,lang:o,preview:c}),t.app.getFormLayout({app:a,preview:c})]);return te(l,T)},isRecordNumber:v,isCreator:w,isCreatedTime:H,isModifier:K,isUpdatedTime:z,isSingleLineText:R,isMultiLineText:f,isRichText:L,isNumber:g,isCalc:W,isCheckBox:C,isRadioButton:_,isMultiSelect:O,isDropDown:I,isUserSelect:b,isOrganizationSelect:A,isGroupSelect:N,isDate:D,isTime:M,isDatetime:U,isLink:B,isFile:Z,isLookup:Y,isSubtable:q,isGroup:J,isReferenceTable:Q,isCategory:V,isStatus:$,isStatusAssignee:ee};E.kintonePrettyFields=ie,Object.defineProperty(E,Symbol.toStringTag,{value:"Module"})});

package/dist/types/functions/formField.d.ts

@@ -0,0 +1,36 @@
+import { PrettyRecordNumber, PrettyCreator, PrettyCreatedTime, PrettyModifier, PrettyUpdatedTime, PrettySingleLineText, PrettyMultiLineText, PrettyRichText, PrettyNumber, PrettyCalc, PrettyCheckBox, PrettyRadioButton, PrettyMultiSelect, PrettyDropdown, PrettyUserSelect, PrettyOrganizationSelect, PrettyGroupSelect, PrettyDate, PrettyTime, PrettyDateTime, PrettyLink, PrettyFile, PrettyLookup, PrettySubtable, PrettyGroup, PrettyReferenceTable, PrettyCategory, PrettyStatus, PrettyStatusAssignee, PrettyInSubtable, PrettyInGroup, PrettyOneOf } from "../types/type";
+declare const isRecordNumber: (field: PrettyOneOf) => field is PrettyRecordNumber;
+declare const isCreator: (field: PrettyOneOf) => field is PrettyCreator;
+declare const isCreatedTime: (field: PrettyOneOf) => field is PrettyCreatedTime;
+declare const isModifier: (field: PrettyOneOf) => field is PrettyModifier;
+declare const isUpdatedTime: (field: PrettyOneOf) => field is PrettyUpdatedTime;
+declare const isSingleLineText: (field: PrettyOneOf) => field is PrettySingleLineText;
+declare const isMultiLineText: (field: PrettyOneOf) => field is PrettyMultiLineText;
+declare const isRichText: (field: PrettyOneOf) => field is PrettyRichText;
+declare const isNumber: (field: PrettyOneOf) => field is PrettyNumber;
+declare const isCalc: (field: PrettyOneOf) => field is PrettyCalc;
+declare const isCheckBox: (field: PrettyOneOf) => field is PrettyCheckBox;
+declare const isRadioButton: (field: PrettyOneOf) => field is PrettyRadioButton;
+declare const isMultiSelect: (field: PrettyOneOf) => field is PrettyMultiSelect;
+declare const isDropDown: (field: PrettyOneOf) => field is PrettyDropdown;
+declare const isUserSelect: (field: PrettyOneOf) => field is PrettyUserSelect;
+declare const isOrganizationSelect: (field: PrettyOneOf) => field is PrettyOrganizationSelect;
+declare const isGroupSelect: (field: PrettyOneOf) => field is PrettyGroupSelect;
+declare const isDate: (field: PrettyOneOf) => field is PrettyDate;
+declare const isTime: (field: PrettyOneOf) => field is PrettyTime;
+declare const isDatetime: (field: PrettyOneOf) => field is PrettyDateTime;
+declare const isLink: (field: PrettyOneOf) => field is PrettyLink;
+declare const isFile: (field: PrettyOneOf) => field is PrettyFile;
+declare const isLookup: (field: PrettyOneOf) => field is PrettyLookup;
+declare const isSubtable: (field: PrettyOneOf) => field is PrettySubtable<{
+    [fieldCode: string]: PrettyInSubtable;
+}>;
+declare const isGroup: (field: PrettyOneOf) => field is PrettyGroup<{
+    [fieldCode: string]: PrettyInGroup;
+}>;
+declare const isReferenceTable: (field: PrettyOneOf) => field is PrettyReferenceTable;
+declare const isCategory: (field: PrettyOneOf) => field is PrettyCategory;
+declare const isStatus: (field: PrettyOneOf) => field is PrettyStatus;
+declare const isStatusAssignee: (field: PrettyOneOf) => field is PrettyStatusAssignee;
+export { isRecordNumber, isCreator, isCreatedTime, isModifier, isUpdatedTime, isSingleLineText, isMultiLineText, isRichText, isNumber, isCalc, isCheckBox, isRadioButton, isMultiSelect, isDropDown, isUserSelect, isOrganizationSelect, isGroupSelect, isDate, isTime, isDatetime, isLink, isFile, isLookup, isSubtable, isGroup, isReferenceTable, isCategory, isStatus, isStatusAssignee, };
+//# sourceMappingURL=formField.d.ts.map

package/dist/types/functions/formField.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"formField.d.ts","sourceRoot":"","sources":["../../../src/functions/formField.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,kBAAkB,EAClB,aAAa,EACb,iBAAiB,EACjB,cAAc,EACd,iBAAiB,EACjB,oBAAoB,EACpB,mBAAmB,EACnB,cAAc,EACd,YAAY,EACZ,UAAU,EACV,cAAc,EACd,iBAAiB,EACjB,iBAAiB,EACjB,cAAc,EACd,gBAAgB,EAChB,wBAAwB,EACxB,iBAAiB,EACjB,UAAU,EACV,UAAU,EACV,cAAc,EACd,UAAU,EACV,UAAU,EACV,YAAY,EACZ,cAAc,EACd,WAAW,EACX,oBAAoB,EACpB,cAAc,EACd,YAAY,EACZ,oBAAoB,EACpB,gBAAgB,EAChB,aAAa,EACb,WAAW,EACZ,MAAM,eAAe,CAAC;AAEvB,QAAA,MAAM,cAAc,UAAW,WAAW,gCAAgE,CAAC;AAC3G,QAAA,MAAM,SAAS,UAAW,WAAW,2BAAqD,CAAC;AAC3F,QAAA,MAAM,aAAa,UAAW,WAAW,+BAA8D,CAAC;AACxG,QAAA,MAAM,UAAU,UAAW,WAAW,4BAAuD,CAAC;AAC9F,QAAA,MAAM,aAAa,UAAW,WAAW,+BAA8D,CAAC;AACxG,QAAA,MAAM,gBAAgB,UAAW,WAAW,kCAAqE,CAAC;AAClH,QAAA,MAAM,eAAe,UAAW,WAAW,iCAAmE,CAAC;AAC/G,QAAA,MAAM,UAAU,UAAW,WAAW,4BAAwD,CAAC;AAC/F,QAAA,MAAM,QAAQ,UAAW,WAAW,0BAAmD,CAAC;AACxF,QAAA,MAAM,MAAM,UAAW,WAAW,wBAA+C,CAAC;AAClF,QAAA,MAAM,UAAU,UAAW,WAAW,4BAAwD,CAAC;AAC/F,QAAA,MAAM,aAAa,UAAW,WAAW,+BAA8D,CAAC;AACxG,QAAA,MAAM,aAAa,UAAW,WAAW,+BAA8D,CAAC;AACxG,QAAA,MAAM,UAAU,UAAW,WAAW,4BAAwD,CAAC;AAC/F,QAAA,MAAM,YAAY,UAAW,WAAW,8BAA4D,CAAC;AACrG,QAAA,MAAM,oBAAoB,UAAW,WAAW,sCAA4E,CAAC;AAC7H,QAAA,MAAM,aAAa,UAAW,WAAW,+BAA8D,CAAC;AACxG,QAAA,MAAM,MAAM,UAAW,WAAW,wBAA+C,CAAC;AAClF,QAAA,MAAM,MAAM,UAAW,WAAW,wBAA+C,CAAC;AAClF,QAAA,MAAM,UAAU,UAAW,WAAW,4BAAuD,CAAC;AAC9F,QAAA,MAAM,MAAM,UAAW,WAAW,wBAA+C,CAAC;AAClF,QAAA,MAAM,MAAM,UAAW,WAAW,wBAA+C,CAAC;AAClF,QAAA,MAAM,QAAQ,UAAW,WAAW,0BACiD,CAAC;AACtF,QAAA,MAAM,UAAU,UAAW,WAAW;;EAAkG,CAAC;AACzI,QAAA,MAAM,OAAO,UAAW,WAAW;;EAAyF,CAAC;AAC7H,QAAA,MAAM,gBAAgB,UAAW,WAAW,kCAAoE,CAAC;AACjH,QAAA,MAAM,UAAU,UAAW,WAAW,4BAAuD,CAAC;AAC9F,QAAA,MAAM,QAAQ,UAAW,WAAW,0BAAmD,CAAC;AACxF,QAAA,MAAM,gBAAgB,UAAW,WAAW,kCAAoE,CAAC;AAEjH,OAAO,EACL,cAAc,EACd,SAAS,EACT,aAAa,EACb,UAAU,EACV,aAAa,EACb,gBAAgB,EAChB,eAAe,EACf,UAAU,EACV,QAAQ,EACR,MAAM,EACN,UAAU,EACV,aAAa,EACb,aAAa,EACb,UAAU,EACV,YAAY,EACZ,oBAAoB,EACpB,aAAa,EACb,MAAM,EACN,MAAM,EACN,UAAU,EACV,MAAM,EACN,MAAM,EACN,QAAQ,EACR,UAAU,EACV,OAAO,EACP,gBAAgB,EAChB,UAAU,EACV,QAAQ,EACR,gBAAgB,GACjB,CAAC"}

package/dist/types/functions/utility.d.ts

@@ -0,0 +1,15 @@
+import { KintoneRestAPIClient } from "@kintone/rest-api-client";
+import { AppID, Lang } from "@kintone/rest-api-client/lib/src/client/types";
+import { Spacer } from "@kintone/rest-api-client/lib/src/KintoneFields/types/fieldLayout";
+import { PrettyOneOf } from "../types/type";
+declare const get: ({ client, app, lang, preview }: {
+    client: KintoneRestAPIClient;
+    app: AppID;
+    lang: Lang;
+    preview: boolean;
+}) => Promise<{
+    fields: PrettyOneOf[];
+    spacers: Spacer[];
+}>;
+export { get };
+//# sourceMappingURL=utility.d.ts.map

package/dist/types/functions/utility.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utility.d.ts","sourceRoot":"","sources":["../../../src/functions/utility.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,MAAM,0BAA0B,CAAC;AAChE,OAAO,EAAE,KAAK,EAAE,IAAI,EAAsB,MAAM,+CAA+C,CAAC;AAChG,OAAO,EAAE,MAAM,EAAE,MAAM,kEAAkE,CAAC;AAK1F,OAAO,EAYL,WAAW,EAOZ,MAAM,eAAe,CAAC;AAsNvB,QAAA,MAAM,GAAG;YAAoD,oBAAoB;SAAO,KAAK;UAAQ,IAAI;aAAW,OAAO;;;;EAO1H,CAAC;AAEF,OAAO,EAAE,GAAG,EAAE,CAAC"}

package/dist/types/index.d.ts

@@ -0,0 +1,46 @@
+declare const kintonePrettyFields: {
+    get: ({ client, app, lang, preview }: {
+        client: import("@kintone/rest-api-client").KintoneRestAPIClient;
+        app: import("@kintone/rest-api-client/lib/src/client/types").AppID;
+        lang: import("@kintone/rest-api-client/lib/src/client/types").Lang;
+        preview: boolean;
+    }) => Promise<{
+        fields: import("./types/type").PrettyOneOf[];
+        spacers: import("@kintone/rest-api-client/lib/src/KintoneFields/types/fieldLayout").Spacer[];
+    }>;
+    isRecordNumber: (field: import("./types/type").PrettyOneOf) => field is import("./types/type").PrettyRecordNumber;
+    isCreator: (field: import("./types/type").PrettyOneOf) => field is import("./types/type").PrettyCreator;
+    isCreatedTime: (field: import("./types/type").PrettyOneOf) => field is import("./types/type").PrettyCreatedTime;
+    isModifier: (field: import("./types/type").PrettyOneOf) => field is import("./types/type").PrettyModifier;
+    isUpdatedTime: (field: import("./types/type").PrettyOneOf) => field is import("./types/type").PrettyUpdatedTime;
+    isSingleLineText: (field: import("./types/type").PrettyOneOf) => field is import("./types/type").PrettySingleLineText;
+    isMultiLineText: (field: import("./types/type").PrettyOneOf) => field is import("./types/type").PrettyMultiLineText;
+    isRichText: (field: import("./types/type").PrettyOneOf) => field is import("./types/type").PrettyRichText;
+    isNumber: (field: import("./types/type").PrettyOneOf) => field is import("./types/type").PrettyNumber;
+    isCalc: (field: import("./types/type").PrettyOneOf) => field is import("./types/type").PrettyCalc;
+    isCheckBox: (field: import("./types/type").PrettyOneOf) => field is import("./types/type").PrettyCheckBox;
+    isRadioButton: (field: import("./types/type").PrettyOneOf) => field is import("./types/type").PrettyRadioButton;
+    isMultiSelect: (field: import("./types/type").PrettyOneOf) => field is import("./types/type").PrettyMultiSelect;
+    isDropDown: (field: import("./types/type").PrettyOneOf) => field is import("./types/type").PrettyDropdown;
+    isUserSelect: (field: import("./types/type").PrettyOneOf) => field is import("./types/type").PrettyUserSelect;
+    isOrganizationSelect: (field: import("./types/type").PrettyOneOf) => field is import("./types/type").PrettyOrganizationSelect;
+    isGroupSelect: (field: import("./types/type").PrettyOneOf) => field is import("./types/type").PrettyGroupSelect;
+    isDate: (field: import("./types/type").PrettyOneOf) => field is import("./types/type").PrettyDate;
+    isTime: (field: import("./types/type").PrettyOneOf) => field is import("./types/type").PrettyTime;
+    isDatetime: (field: import("./types/type").PrettyOneOf) => field is import("./types/type").PrettyDateTime;
+    isLink: (field: import("./types/type").PrettyOneOf) => field is import("./types/type").PrettyLink;
+    isFile: (field: import("./types/type").PrettyOneOf) => field is import("./types/type").PrettyFile;
+    isLookup: (field: import("./types/type").PrettyOneOf) => field is import("./types/type").PrettyLookup;
+    isSubtable: (field: import("./types/type").PrettyOneOf) => field is import("./types/type").PrettySubtable<{
+        [fieldCode: string]: import("./types/type").PrettyInSubtable;
+    }>;
+    isGroup: (field: import("./types/type").PrettyOneOf) => field is import("./types/type").PrettyGroup<{
+        [fieldCode: string]: import("./types/type").PrettyInGroup;
+    }>;
+    isReferenceTable: (field: import("./types/type").PrettyOneOf) => field is import("./types/type").PrettyReferenceTable;
+    isCategory: (field: import("./types/type").PrettyOneOf) => field is import("./types/type").PrettyCategory;
+    isStatus: (field: import("./types/type").PrettyOneOf) => field is import("./types/type").PrettyStatus;
+    isStatusAssignee: (field: import("./types/type").PrettyOneOf) => field is import("./types/type").PrettyStatusAssignee;
+};
+export { kintonePrettyFields };
+//# sourceMappingURL=index.d.ts.map

package/dist/types/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAiCA,QAAA,MAAM,mBAAmB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA+BxB,CAAC;AAEF,OAAO,EAAE,mBAAmB,EAAE,CAAC"}

package/package.json

@@ -0,0 +1,53 @@
+{
+  "name": "kintone-pretty-fields",
+  "type": "module",
+  "files": [
+    "dist"
+  ],
+  "version": "0.1.0",
+  "description": "Retrieve kintone form field(@kintone/rest-api-client) information in a pretty format.",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/cy-takeuchi/kintone-pretty-fields.git"
+  },
+  "keywords": [
+    "kintone"
+  ],
+  "author": "cy-takeuchi <cy.takeuchi@gmail.com>",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/cy-takeuchi/kintone-pretty-fields/issues"
+  },
+  "homepage": "https://github.com/cy-takeuchi/kintone-pretty-fields",
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/types/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/types/index.d.ts",
+      "node": {
+        "import": "./dist/index.js",
+        "require": "./dist/index.umd.cjs",
+        "default": "./dist/index.js"
+      },
+      "browser": "./dist/index.umd.cjs"
+    }
+  },
+  "scripts": {
+    "prebuild": "rimraf ./dist",
+    "build": "tsc && vite build",
+    "watch": "tsc && vite build --watch",
+    "prepare": "npm run build"
+  },
+  "dependencies": {
+    "@kintone/rest-api-client": "^5.0.3",
+    "kintone-typeguard": "^0.6.0"
+  },
+  "devDependencies": {
+    "@types/node": "^20.10.0",
+    "prettier": "^3.1.0",
+    "rimraf": "^5.0.5",
+    "typescript": "^5.3.2",
+    "vite": "^5.0.2"
+  }
+}