@konomi-app/kintone-utilities 5.6.2 → 5.6.4

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.
Files changed (8) hide show
  1. package/cybozu.d.ts +4 -4
  2. package/dist/cybozu.d.ts +21 -0
  3. package/dist/cybozu.js +23 -0
  4. package/dist/cybozu.js.map +1 -1
  5. package/dist/date.d.ts +1 -1
  6. package/dist/rest-api/utility.js.map +1 -1
  7. package/dist/utilities.d.ts +4 -4
  8. package/package.json +1 -1
package/cybozu.d.ts CHANGED
@@ -25,7 +25,7 @@ type Field = BaseFieldProperty & {
25
25
  };
26
26
 
27
27
  type Table = BaseFieldProperty & {
28
- fieldList: Record<string, Field>;
28
+ fieldList: Partial<Record<string, Field>>;
29
29
  properties: { noLabel: BooleanAsString };
30
30
  type: 'TABLE';
31
31
  };
@@ -33,7 +33,7 @@ type Table = BaseFieldProperty & {
33
33
  type Schema = {
34
34
  groups: any[];
35
35
  revision: string;
36
- subTable: Record<string, Table>;
36
+ subTable: Partial<Record<string, Table>>;
37
37
  table: Table;
38
38
  };
39
39
 
@@ -55,7 +55,7 @@ declare namespace cybozu {
55
55
  vtComponentLocalId: string;
56
56
  }[];
57
57
  export const revision: string;
58
- export const subTable: Record<string, Table>;
58
+ export const subTable: Partial<Record<string, Table>>;
59
59
  export const table: Table;
60
60
  }
61
61
  namespace FORM_DATA {
@@ -65,7 +65,7 @@ declare namespace cybozu {
65
65
  vtComponentLocalId: string;
66
66
  }[];
67
67
  export const revision: string;
68
- export const subTable: Record<string, Table>;
68
+ export const subTable: Partial<Record<string, Table>>;
69
69
  export const table: Table;
70
70
  }
71
71
  }
package/dist/cybozu.d.ts CHANGED
@@ -45,3 +45,24 @@ export declare const getMetaFieldId_UNSTABLE: <T = any>(code: keyof T) => string
45
45
  * @returns サブテーブル内に存在するフィールドのメタデータ一覧、またはnull
46
46
  */
47
47
  export declare const getMetaSubtableFields_UNSTABLE: (subtableCode: string) => cx.Field[] | null;
48
+ /**
49
+ * **この関数は非公式のAPIを使用しています。kintoneのアップデートにより使用できなくなる可能性があります**
50
+ *
51
+ * URLのクエリパラメータに含まれる一覧の検索条件を取得します
52
+ * クエリパラメータでは、フィールドのキー情報としてフィールドコードの代わりにフィールドID(f + 数字)が使用されます
53
+ *
54
+ * 保険として、URLのクエリパラメータに含まれるqパラメータも取得します
55
+ *
56
+ * 取得する手順は以下の通りです
57
+ *
58
+ * 1. `cybozu.data.page.QUERY_STRING`
59
+ * 2. `new URLSearchParams(location.search).get('q')`
60
+ * 3. 空文字
61
+ *
62
+ * @example
63
+ * ```ts
64
+ * // URL: https://example.cybozu.com/k/1/?f100000=1&f200000=2
65
+ * getQueryString_UNSTABLE(); // => 'f100000=1&f200000=2'
66
+ * ```
67
+ */
68
+ export declare const getQueryString_UNSTABLE: () => string;
package/dist/cybozu.js CHANGED
@@ -86,4 +86,27 @@ export const getMetaSubtableFields_UNSTABLE = (subtableCode) => {
86
86
  }
87
87
  return null;
88
88
  };
89
+ /**
90
+ * **この関数は非公式のAPIを使用しています。kintoneのアップデートにより使用できなくなる可能性があります**
91
+ *
92
+ * URLのクエリパラメータに含まれる一覧の検索条件を取得します
93
+ * クエリパラメータでは、フィールドのキー情報としてフィールドコードの代わりにフィールドID(f + 数字)が使用されます
94
+ *
95
+ * 保険として、URLのクエリパラメータに含まれるqパラメータも取得します
96
+ *
97
+ * 取得する手順は以下の通りです
98
+ *
99
+ * 1. `cybozu.data.page.QUERY_STRING`
100
+ * 2. `new URLSearchParams(location.search).get('q')`
101
+ * 3. 空文字
102
+ *
103
+ * @example
104
+ * ```ts
105
+ * // URL: https://example.cybozu.com/k/1/?f100000=1&f200000=2
106
+ * getQueryString_UNSTABLE(); // => 'f100000=1&f200000=2'
107
+ * ```
108
+ */
109
+ export const getQueryString_UNSTABLE = () => {
110
+ return cybozu?.data?.page?.QUERY_STRING ?? new URLSearchParams(location.search).get('q') ?? '';
111
+ };
89
112
  //# sourceMappingURL=cybozu.js.map
package/dist/cybozu.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"cybozu.js","sourceRoot":"","sources":["../src/cybozu.ts"],"names":[],"mappings":"AAQA,MAAM,SAAS,GAAG,GAAqB,EAAE,CACvC,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,WAAW,IAAI,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,SAAS,EAAE,MAAM,IAAI,IAAI,CAAC;AAEnF;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG,GAAsB,EAAE;IAC3D,MAAM,MAAM,GAAG,SAAS,EAAE,CAAC;IAC3B,MAAM,SAAS,GAAG,MAAM,EAAE,KAAK,EAAE,SAAS,CAAC;IAC3C,IAAI,CAAC,SAAS,EAAE,CAAC;QACf,OAAO,IAAI,CAAC;IACd,CAAC;IAED,OAAO,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;AAClC,CAAC,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,wBAAwB,GAAG,GAAyB,EAAE;IACjE,MAAM,MAAM,GAAG,SAAS,EAAE,CAAC;IAC3B,MAAM,QAAQ,GAAG,MAAM,EAAE,QAAQ,CAAC;IAClC,IAAI,CAAC,QAAQ,EAAE,CAAC;QACd,OAAO,IAAI,CAAC;IACd,CAAC;IAED,MAAM,YAAY,GAAG,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;IAC7C,OAAO,YAAY,CAAC;AACtB,CAAC,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,sBAAsB,GAAG,GAAsC,EAAE;IAC5E,OAAO,CAAC,GAAG,CAAC,qBAAqB,EAAE,IAAI,EAAE,CAAC,EAAE,GAAG,CAAC,wBAAwB,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;AACrF,CAAC,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAG,CAAU,IAAa,EAAE,EAAE;IAChE,MAAM,MAAM,GAAG,sBAAsB,EAAE,CAAC;IACxC,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,OAAO,IAAI,CAAC;IACd,CAAC;IAED,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;QAC3B,IAAI,KAAK,EAAE,GAAG,KAAK,IAAI,EAAE,CAAC;YACxB,OAAO,KAAK,EAAE,EAAE,IAAI,IAAI,CAAC;QAC3B,CAAC;IACH,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC,CAAC;AAEF;;;;;GAKG;AACH,MAAM,CAAC,MAAM,8BAA8B,GAAG,CAAC,YAAoB,EAAqB,EAAE;IACxF,MAAM,MAAM,GAAG,SAAS,EAAE,CAAC;IAC3B,MAAM,QAAQ,GAAG,MAAM,EAAE,QAAQ,CAAC;IAClC,IAAI,CAAC,QAAQ,EAAE,CAAC;QACd,OAAO,IAAI,CAAC;IACd,CAAC;IAED,MAAM,YAAY,GAAG,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;IAE7C,KAAK,MAAM,QAAQ,IAAI,YAAY,EAAE,CAAC;QACpC,MAAM,SAAS,GAAG,QAAQ,EAAE,SAAS,CAAC;QACtC,IAAI,CAAC,SAAS,EAAE,CAAC;YACf,SAAS;QACX,CAAC;QACD,IAAI,QAAQ,EAAE,GAAG,KAAK,YAAY,EAAE,CAAC;YACnC,OAAO,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;QAClC,CAAC;IACH,CAAC;IAED,OAAO,IAAI,CAAC;AACd,CAAC,CAAC"}
1
+ {"version":3,"file":"cybozu.js","sourceRoot":"","sources":["../src/cybozu.ts"],"names":[],"mappings":"AAQA,MAAM,SAAS,GAAG,GAAqB,EAAE,CACvC,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,WAAW,IAAI,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,SAAS,EAAE,MAAM,IAAI,IAAI,CAAC;AAEnF;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG,GAAsB,EAAE;IAC3D,MAAM,MAAM,GAAG,SAAS,EAAE,CAAC;IAC3B,MAAM,SAAS,GAAG,MAAM,EAAE,KAAK,EAAE,SAAS,CAAC;IAC3C,IAAI,CAAC,SAAS,EAAE,CAAC;QACf,OAAO,IAAI,CAAC;IACd,CAAC;IAED,OAAO,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;AAClC,CAAC,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,wBAAwB,GAAG,GAAyB,EAAE;IACjE,MAAM,MAAM,GAAG,SAAS,EAAE,CAAC;IAC3B,MAAM,QAAQ,GAAG,MAAM,EAAE,QAAQ,CAAC;IAClC,IAAI,CAAC,QAAQ,EAAE,CAAC;QACd,OAAO,IAAI,CAAC;IACd,CAAC;IAED,MAAM,YAAY,GAAG,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;IAC7C,OAAO,YAAY,CAAC;AACtB,CAAC,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,sBAAsB,GAAG,GAAsC,EAAE;IAC5E,OAAO,CAAC,GAAG,CAAC,qBAAqB,EAAE,IAAI,EAAE,CAAC,EAAE,GAAG,CAAC,wBAAwB,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;AACrF,CAAC,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAG,CAAU,IAAa,EAAE,EAAE;IAChE,MAAM,MAAM,GAAG,sBAAsB,EAAE,CAAC;IACxC,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,OAAO,IAAI,CAAC;IACd,CAAC;IAED,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;QAC3B,IAAI,KAAK,EAAE,GAAG,KAAK,IAAI,EAAE,CAAC;YACxB,OAAO,KAAK,EAAE,EAAE,IAAI,IAAI,CAAC;QAC3B,CAAC;IACH,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC,CAAC;AAEF;;;;;GAKG;AACH,MAAM,CAAC,MAAM,8BAA8B,GAAG,CAAC,YAAoB,EAAqB,EAAE;IACxF,MAAM,MAAM,GAAG,SAAS,EAAE,CAAC;IAC3B,MAAM,QAAQ,GAAG,MAAM,EAAE,QAAQ,CAAC;IAClC,IAAI,CAAC,QAAQ,EAAE,CAAC;QACd,OAAO,IAAI,CAAC;IACd,CAAC;IAED,MAAM,YAAY,GAAG,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;IAE7C,KAAK,MAAM,QAAQ,IAAI,YAAY,EAAE,CAAC;QACpC,MAAM,SAAS,GAAG,QAAQ,EAAE,SAAS,CAAC;QACtC,IAAI,CAAC,SAAS,EAAE,CAAC;YACf,SAAS;QACX,CAAC;QACD,IAAI,QAAQ,EAAE,GAAG,KAAK,YAAY,EAAE,CAAC;YACnC,OAAO,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;QAClC,CAAC;IACH,CAAC;IAED,OAAO,IAAI,CAAC;AACd,CAAC,CAAC;AAEF;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAG,GAAG,EAAE;IAC1C,OAAO,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,YAAY,IAAI,IAAI,eAAe,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC;AACjG,CAAC,CAAC"}
package/dist/date.d.ts CHANGED
@@ -1,5 +1,5 @@
1
1
  export declare const getWareki: (date: Date, option?: {
2
- era?: 'narrow' | 'short' | 'long';
2
+ era?: "narrow" | "short" | "long";
3
3
  }) => {
4
4
  gengo: string;
5
5
  year: number;
package/dist/rest-api/utility.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"utility.js","sourceRoot":"","sources":["../../src/rest-api/utility.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AAEtC;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG,CACnC,UAAsC,EACtC,QAAsD,EAC1B,EAAE;IAC9B,MAAM,QAAQ,GAAG,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC;IAEpF,MAAM,OAAO,GAAG,QAAQ,CAAC,MAAM,CAC7B,CAAC,GAAG,EAAE,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,GAAG,GAAG,EAAE,CAAC,GAAG,CAAC,EAAE,KAAK,EAAE,CAAC,EACjD,EAAE,CACH,CAAC;IAEF,OAAO,OAAO,CAAC;AACjB,CAAC,CAAC;AAEF;;;;GAIG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,KAAK,EAAmC,MAI1E,EAA0B,EAAE;IAC3B,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,UAAU,EAAE,GAAG,MAAM,CAAC;IAC7C,IAAI,CAAC;QACH,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,CAAC;QACxC,OAAO,QAAQ,CAAC;IAClB,CAAC;IAAC,OAAO,KAAU,EAAE,CAAC;QACpB,IAAI,CAAC,WAAW,EAAE,WAAW,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC;YACpD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,EAAE,GAAG,UAAU,EAAE,YAAY,EAAE,OAAO,EAAE,CAAC,CAAC;YACtE,OAAO,QAAQ,CAAC;QAClB,CAAC;QACD,MAAM,KAAK,CAAC;IACd,CAAC;AACH,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,YAAY,GAAG,KAAK,EAAE,KAAa,EAAoB,EAAE;IACpE,IAAI,CAAC;QACH,MAAM,UAAU,CAAC,EAAE,GAAG,EAAE,KAAK,EAAE,CAAC,CAAC;IACnC,CAAC;IAAC,OAAO,KAAU,EAAE,CAAC;QACpB,OAAO,KAAK,CAAC,IAAI,KAAK,WAAW,CAAC;IACpC,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC,CAAC"}
1
+ {"version":3,"file":"utility.js","sourceRoot":"","sources":["../../src/rest-api/utility.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AAEtC;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG,CACnC,UAAsC,EACtC,QAAsD,EAC1B,EAAE;IAC9B,MAAM,QAAQ,GAAG,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,QAAQ,CAAC,KAAM,CAAC,CAAC,CAAC;IAErF,MAAM,OAAO,GAAG,QAAQ,CAAC,MAAM,CAC7B,CAAC,GAAG,EAAE,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,GAAG,GAAG,EAAE,CAAC,GAAG,CAAC,EAAE,KAAK,EAAE,CAAC,EACjD,EAAE,CACH,CAAC;IAEF,OAAO,OAAO,CAAC;AACjB,CAAC,CAAC;AAEF;;;;GAIG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,KAAK,EAAmC,MAI1E,EAA0B,EAAE;IAC3B,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,UAAU,EAAE,GAAG,MAAM,CAAC;IAC7C,IAAI,CAAC;QACH,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,CAAC;QACxC,OAAO,QAAQ,CAAC;IAClB,CAAC;IAAC,OAAO,KAAU,EAAE,CAAC;QACpB,IAAI,CAAC,WAAW,EAAE,WAAW,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC;YACpD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,EAAE,GAAG,UAAU,EAAE,YAAY,EAAE,OAAO,EAAE,CAAC,CAAC;YACtE,OAAO,QAAQ,CAAC;QAClB,CAAC;QACD,MAAM,KAAK,CAAC;IACd,CAAC;AACH,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,YAAY,GAAG,KAAK,EAAE,KAAa,EAAoB,EAAE;IACpE,IAAI,CAAC;QACH,MAAM,UAAU,CAAC,EAAE,GAAG,EAAE,KAAK,EAAE,CAAC,CAAC;IACnC,CAAC;IAAC,OAAO,KAAU,EAAE,CAAC;QACpB,OAAO,KAAK,CAAC,IAAI,KAAK,WAAW,CAAC;IACpC,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC,CAAC"}
package/dist/utilities.d.ts CHANGED
@@ -19,7 +19,7 @@ export declare const getFieldValueAsString: (field: kintoneAPI.Field | SavedFiel
19
19
  * @param bField ソート対象のフィールド
20
20
  * @returns aFieldがbFieldより小さい場合は負の整数、aFieldがbFieldより大きい場合は正の整数、等しい場合は0
21
21
  */
22
- export declare const sortField: <T extends import("./types/api/field").OneOf>(aField: T, bField: T) => number;
22
+ export declare const sortField: <T extends kintoneAPI.Field>(aField: T, bField: T) => number;
23
23
  /**
24
24
  * 計算フィールドの値と設定情報を基に、画面表示用の値を返却します
25
25
  */
@@ -33,10 +33,10 @@ export declare const getCalcFieldValueAsString: (params: {
33
33
  * @returns クリア後のフィールドの値
34
34
  */
35
35
  export declare const getEmptyValue: (params: {
36
- type: kintoneAPI.Field['type'];
36
+ type: kintoneAPI.Field["type"];
37
37
  } | {
38
38
  field: kintoneAPI.Field;
39
- }) => kintoneAPI.Field['value'];
39
+ }) => kintoneAPI.Field["value"];
40
40
  export declare const getDefaultValue: (property: kintoneAPI.FieldProperty) => string | (never[] | {
41
41
  code: string;
42
42
  name: string;
@@ -78,5 +78,5 @@ export declare const onFileLoad: (file: File | Blob, options?: OnFileLoadOptions
78
78
  */
79
79
  export declare const getSortFromQuery: (query: string) => {
80
80
  field: string;
81
- order: 'asc' | 'desc';
81
+ order: "asc" | "desc";
82
82
  }[];
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@konomi-app/kintone-utilities",
3
- "version": "5.6.2",
3
+ "version": "5.6.4",
4
4
  "types": "dist/index.d.ts",
5
5
  "main": "dist/index.js",
6
6
  "repository": "https://github.com/local-bias/kintone-utilities.git",