@konomi-app/kintone-utilities 1.14.2 → 1.15.0

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.
@@ -120,10 +120,17 @@ export declare namespace kintoneAPI {
120
120
  readonly fields?: FieldProperties;
121
121
  };
122
122
  }
123
+ /**
124
+ * @deprecated Use `kintoneAPI.js.EventType` instead.
125
+ */
126
+ type EventType = kintoneAPI.js.EventType;
127
+ /**
128
+ * @deprecated Use `kintoneAPI.js.Event` instead.
129
+ */
130
+ type Event<T = RecordData> = kintoneAPI.js.Event<T>;
123
131
  namespace js {
124
132
  type Event<T = RecordData> = {
125
133
  appId: number;
126
- viewId: number;
127
134
  recordId: number;
128
135
  record: T;
129
136
  error: string;
@@ -137,9 +144,31 @@ export declare namespace kintoneAPI {
137
144
  row: any;
138
145
  };
139
146
  records?: T[];
140
- viewType?: string;
147
+ /**
148
+ * 現在表示している一覧のID
149
+ * app.record.index.show イベントでのみ取得できます
150
+ */
151
+ viewId: number;
152
+ /**
153
+ * 現在表示している一覧の種類
154
+ * app.record.index.show イベントでのみ取得できます
155
+ */
156
+ viewType?: 'list' | 'calendar' | 'custom';
157
+ /**
158
+ * 現在表示している一覧の名前
159
+ * app.record.index.show イベントでのみ取得できます
160
+ */
141
161
  viewName?: string;
142
- offset?: number;
162
+ /**
163
+ * 一覧のレコードのオフセット
164
+ * app.record.index.show イベントでのみ取得でき、viewTypeがCalendar以外の場合に取得できます
165
+ */
166
+ offset?: number | null;
167
+ /**
168
+ * 一覧のレコードの表示件数
169
+ * app.record.index.show イベントでのみ取得でき、viewTypeがCalendar以外の場合に取得できます
170
+ */
171
+ size?: number | null;
143
172
  /**
144
173
  * プロセス - 実行されたアクション
145
174
  * app.record.detail.process.proceed イベントで取得できます
@@ -165,12 +194,4 @@ export declare namespace kintoneAPI {
165
194
  type EventType = 'portal.show' | 'app.record.index.show' | 'app.record.index.edit.show' | 'app.record.index.edit.submit' | 'app.record.index.edit.submit.success' | 'app.record.index.delete.submit' | 'app.record.detail.show' | 'app.record.detail.delete.submit' | 'app.record.detail.process.proceed' | 'app.record.create.show' | 'app.record.create.change' | 'app.record.create.submit' | 'app.record.create.submit.success' | 'app.record.edit.show' | 'app.record.edit.change' | 'app.record.edit.submit' | 'app.record.edit.submit.success' | 'app.record.print.show' | 'mobile.app.record.index.show' | 'mobile.app.record.detail.show' | 'mobile.app.record.detail.delete.submit' | 'mobile.app.record.detail.process.proceed' | 'mobile.app.record.create.show' | 'mobile.app.record.create.change' | 'mobile.app.record.create.submit' | 'mobile.app.record.create.submit.success' | 'mobile.app.record.edit.show' | 'mobile.app.record.edit.change' | 'mobile.app.record.edit.submit' | 'mobile.app.record.edit.submit.success';
166
195
  }
167
196
  namespace rest { }
168
- /**
169
- * @deprecated Use `kintoneAPI.js.EventType` instead.
170
- */
171
- type EventType = kintoneAPI.js.EventType;
172
- /**
173
- * @deprecated Use `kintoneAPI.js.Event` instead.
174
- */
175
- type Event<T = RecordData> = kintoneAPI.js.Event<T>;
176
197
  }
@@ -32,4 +32,11 @@ export declare const uploadFile: (props: {
32
32
  }) => Promise<{
33
33
  fileKey: string;
34
34
  }>;
35
+ export declare const getFormFields: (props: {
36
+ app: App;
37
+ preview?: boolean;
38
+ }) => Promise<{
39
+ properties: kintoneAPI.FieldProperties;
40
+ revision: string;
41
+ }>;
35
42
  export {};
package/dist/rest-api.js CHANGED
@@ -77,4 +77,9 @@ const checkBrowser = () => {
77
77
  throw new Error('この関数はブラウザでのみ使用できます');
78
78
  }
79
79
  };
80
+ export const getFormFields = async (props) => {
81
+ checkBrowser();
82
+ const { app, preview = false } = props;
83
+ return kintone.api(kintone.api.url(`${API_ENDPOINT_ROOT}/${preview ? 'preview/' : ''}app/form/fields`, true), 'GET', { app });
84
+ };
80
85
  //# sourceMappingURL=rest-api.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"rest-api.js","sourceRoot":"","sources":["../src/rest-api.ts"],"names":[],"mappings":"AAGA,MAAM,iBAAiB,GAAG,OAAO,CAAC;AAClC,MAAM,mBAAmB,GAAG,GAAG,iBAAiB,iBAAiB,CAAC;AAClE,MAAM,SAAS,GAAG;IAChB,GAAG,EAAE,GAAG;CACT,CAAC;AAEF,MAAM,CAAC,MAAM,aAAa,GAAG,KAAK,EAAyD,KAK1F,EAAE,EAAE;IACH,IAAI,KAAK,CAAC,KAAK,IAAI,KAAK,CAAC,KAAK,CAAC,QAAQ,CAAC,UAAU,CAAC,EAAE;QACnD,OAAO,uBAAuB,CAAI,KAAK,CAAC,CAAC;KAC1C;IACD,OAAO,mBAAmB,CAAI,EAAE,GAAG,KAAK,EAAE,SAAS,EAAE,KAAK,CAAC,KAAK,EAAE,CAAC,CAAC;AACtE,CAAC,CAAC;AAKF,MAAM,CAAC,MAAM,mBAAmB,GAAG,KAAK,EAAiC,KAKxE,EAAwB,EAAE;IACzB,YAAY,EAAE,CAAC;IACf,MAAM,EAAE,MAAM,EAAE,UAAU,EAAE,SAAS,EAAE,aAAa,GAAG,EAAE,EAAE,GAAG,KAAK,CAAC;IAEpE,MAAM,MAAM,GAAG,UAAU,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,GAAG,IAAI,GAAG,CAAC,CAAC,GAAG,UAAU,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IAErF,4CAA4C;IAC5C,MAAM,SAAS,GAAG,aAAa,CAAC,OAAO,CAAC,aAAa,EAAE,EAAE,CAAC,CAAC;IAE3D,OAAO,YAAY,CAAI,EAAE,GAAG,KAAK,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC,CAAC;AAC1D,CAAC,CAAC;AAEF,MAAM,YAAY,GAAG,KAAK,EAAqC,KAO9D,EAAwB,EAAE;IACzB,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,SAAS,EAAE,EAAE,EAAE,GAAG,KAAK,CAAC;IAE7C,MAAM,YAAY,GAAG,EAAE,CAAC,CAAC,CAAC,GAAG,SAAS,CAAC,CAAC,CAAC,GAAG,SAAS,OAAO,CAAC,CAAC,CAAC,EAAE,UAAU,EAAE,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;IAE5F,MAAM,KAAK,GAAG,GAAG,YAAY,4BAA4B,SAAS,CAAC,GAAG,EAAE,CAAC;IAEzE,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,OAAO,CAAC,GAAG,CACnC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,iBAAiB,UAAU,EAAE,IAAI,CAAC,EACrD,KAAK,EACL;QACE,GAAG;QACH,MAAM;QACN,KAAK;KACN,CACF,CAAC;IACF,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE;QACnB,OAAO,KAAK,CAAC,MAAM,IAAI,EAAE,CAAC;KAC3B;IAED,MAAM,MAAM,GAAG,CAAC,GAAG,CAAC,KAAK,CAAC,MAAM,IAAI,EAAE,CAAC,EAAE,GAAG,OAAO,CAAC,CAAC;IAErD,IAAI,KAAK,CAAC,MAAM,EAAE;QAChB,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;KACtB;IAED,MAAM,UAAU,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;IAC7C,MAAM,MAAM,GAAG,UAAU,CAAC,GAAG,CAAC,KAAK,CAAC;IAEpC,OAAO,OAAO,CAAC,MAAM,KAAK,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,YAAY,CAAC,EAAE,GAAG,KAAK,EAAE,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC;AACpG,CAAC,CAAC;AAIF,MAAM,CAAC,MAAM,uBAAuB,GAAG,KAAK,EAAiC,KAM5E,EAAgB,EAAE;IACjB,YAAY,EAAE,CAAC;IACf,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,EAAE,EAAE,KAAK,GAAG,EAAE,EAAE,UAAU,GAAG,IAAI,EAAE,MAAM,GAAG,IAAI,EAAE,GAAG,KAAK,CAAC;IAEjF,MAAM,KAAK,GAAG,EAAE,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,SAAS,CAAC,GAAG,EAAE,KAAK,EAAE,CAAC;IAE1D,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,mBAAmB,EAAE,IAAI,CAAC,EAAE,MAAM,EAAE,KAAK,CAAC,CAAC;IAE5F,IAAI,UAAU,EAAE;QACd,UAAU,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;KAC/B;IAED,OAAO,oBAAoB,CAAI,EAAE,EAAE,EAAE,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC;AAC5D,CAAC,CAAC;AAEF,MAAM,oBAAoB,GAAG,KAAK,EAAK,KAItC,EAAgB,EAAE;IACjB,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,UAAU,GAAG,EAAE,EAAE,GAAG,KAAK,CAAC;IAC9C,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,mBAAmB,EAAE,IAAI,CAAC,EAAE,KAAK,EAAE;QACpF,EAAE;KACH,CAAC,CAAC;IAEH,MAAM,UAAU,GAAQ,CAAC,GAAG,UAAU,EAAE,GAAI,QAAQ,CAAC,OAAe,CAAC,CAAC;IAEtE,IAAI,MAAM,EAAE;QACV,MAAM,CAAC,UAAU,CAAC,CAAC;KACpB;IAED,OAAO,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,oBAAoB,CAAC,EAAE,EAAE,EAAE,MAAM,EAAE,UAAU,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC;AACnG,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,UAAU,GAAG,KAAK,EAAE,KAEhC,EAAgC,EAAE;IACjC,YAAY,EAAE,CAAC;IACf,MAAM,EAAE,IAAI,EAAE,GAAG,KAAK,CAAC;IAEvB,MAAM,QAAQ,GAAG,IAAI,QAAQ,EAAE,CAAC;IAChC,QAAQ,CAAC,MAAM,CAAC,mBAAmB,EAAE,OAAO,CAAC,eAAe,EAAE,CAAC,CAAC;IAChE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;IAE9C,MAAM,OAAO,GAAG,EAAE,kBAAkB,EAAE,gBAAgB,EAAE,CAAC;IACzD,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,iBAAiB,EAAE;QAC9C,MAAM,EAAE,MAAM;QACd,OAAO;QACP,IAAI,EAAE,QAAQ;KACf,CAAC,CAAC;IACH,OAAO,QAAQ,CAAC,IAAI,EAAE,CAAC;AACzB,CAAC,CAAC;AAEF,MAAM,YAAY,GAAG,GAAG,EAAE;IACxB,IAAI,OAAO,MAAM,KAAK,WAAW,EAAE;QACjC,MAAM,IAAI,KAAK,CAAC,oBAAoB,CAAC,CAAC;KACvC;AACH,CAAC,CAAC"}
1
+ {"version":3,"file":"rest-api.js","sourceRoot":"","sources":["../src/rest-api.ts"],"names":[],"mappings":"AAGA,MAAM,iBAAiB,GAAG,OAAO,CAAC;AAClC,MAAM,mBAAmB,GAAG,GAAG,iBAAiB,iBAAiB,CAAC;AAClE,MAAM,SAAS,GAAG;IAChB,GAAG,EAAE,GAAG;CACT,CAAC;AAEF,MAAM,CAAC,MAAM,aAAa,GAAG,KAAK,EAAyD,KAK1F,EAAE,EAAE;IACH,IAAI,KAAK,CAAC,KAAK,IAAI,KAAK,CAAC,KAAK,CAAC,QAAQ,CAAC,UAAU,CAAC,EAAE;QACnD,OAAO,uBAAuB,CAAI,KAAK,CAAC,CAAC;KAC1C;IACD,OAAO,mBAAmB,CAAI,EAAE,GAAG,KAAK,EAAE,SAAS,EAAE,KAAK,CAAC,KAAK,EAAE,CAAC,CAAC;AACtE,CAAC,CAAC;AAKF,MAAM,CAAC,MAAM,mBAAmB,GAAG,KAAK,EAAiC,KAKxE,EAAwB,EAAE;IACzB,YAAY,EAAE,CAAC;IACf,MAAM,EAAE,MAAM,EAAE,UAAU,EAAE,SAAS,EAAE,aAAa,GAAG,EAAE,EAAE,GAAG,KAAK,CAAC;IAEpE,MAAM,MAAM,GAAG,UAAU,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,GAAG,IAAI,GAAG,CAAC,CAAC,GAAG,UAAU,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IAErF,4CAA4C;IAC5C,MAAM,SAAS,GAAG,aAAa,CAAC,OAAO,CAAC,aAAa,EAAE,EAAE,CAAC,CAAC;IAE3D,OAAO,YAAY,CAAI,EAAE,GAAG,KAAK,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC,CAAC;AAC1D,CAAC,CAAC;AAEF,MAAM,YAAY,GAAG,KAAK,EAAqC,KAO9D,EAAwB,EAAE;IACzB,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,SAAS,EAAE,EAAE,EAAE,GAAG,KAAK,CAAC;IAE7C,MAAM,YAAY,GAAG,EAAE,CAAC,CAAC,CAAC,GAAG,SAAS,CAAC,CAAC,CAAC,GAAG,SAAS,OAAO,CAAC,CAAC,CAAC,EAAE,UAAU,EAAE,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;IAE5F,MAAM,KAAK,GAAG,GAAG,YAAY,4BAA4B,SAAS,CAAC,GAAG,EAAE,CAAC;IAEzE,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,OAAO,CAAC,GAAG,CACnC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,iBAAiB,UAAU,EAAE,IAAI,CAAC,EACrD,KAAK,EACL;QACE,GAAG;QACH,MAAM;QACN,KAAK;KACN,CACF,CAAC;IACF,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE;QACnB,OAAO,KAAK,CAAC,MAAM,IAAI,EAAE,CAAC;KAC3B;IAED,MAAM,MAAM,GAAG,CAAC,GAAG,CAAC,KAAK,CAAC,MAAM,IAAI,EAAE,CAAC,EAAE,GAAG,OAAO,CAAC,CAAC;IAErD,IAAI,KAAK,CAAC,MAAM,EAAE;QAChB,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;KACtB;IAED,MAAM,UAAU,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;IAC7C,MAAM,MAAM,GAAG,UAAU,CAAC,GAAG,CAAC,KAAK,CAAC;IAEpC,OAAO,OAAO,CAAC,MAAM,KAAK,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,YAAY,CAAC,EAAE,GAAG,KAAK,EAAE,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC;AACpG,CAAC,CAAC;AAIF,MAAM,CAAC,MAAM,uBAAuB,GAAG,KAAK,EAAiC,KAM5E,EAAgB,EAAE;IACjB,YAAY,EAAE,CAAC;IACf,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,EAAE,EAAE,KAAK,GAAG,EAAE,EAAE,UAAU,GAAG,IAAI,EAAE,MAAM,GAAG,IAAI,EAAE,GAAG,KAAK,CAAC;IAEjF,MAAM,KAAK,GAAG,EAAE,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,SAAS,CAAC,GAAG,EAAE,KAAK,EAAE,CAAC;IAE1D,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,mBAAmB,EAAE,IAAI,CAAC,EAAE,MAAM,EAAE,KAAK,CAAC,CAAC;IAE5F,IAAI,UAAU,EAAE;QACd,UAAU,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;KAC/B;IAED,OAAO,oBAAoB,CAAI,EAAE,EAAE,EAAE,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC;AAC5D,CAAC,CAAC;AAEF,MAAM,oBAAoB,GAAG,KAAK,EAAK,KAItC,EAAgB,EAAE;IACjB,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,UAAU,GAAG,EAAE,EAAE,GAAG,KAAK,CAAC;IAC9C,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,mBAAmB,EAAE,IAAI,CAAC,EAAE,KAAK,EAAE;QACpF,EAAE;KACH,CAAC,CAAC;IAEH,MAAM,UAAU,GAAQ,CAAC,GAAG,UAAU,EAAE,GAAI,QAAQ,CAAC,OAAe,CAAC,CAAC;IAEtE,IAAI,MAAM,EAAE;QACV,MAAM,CAAC,UAAU,CAAC,CAAC;KACpB;IAED,OAAO,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,oBAAoB,CAAC,EAAE,EAAE,EAAE,MAAM,EAAE,UAAU,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC;AACnG,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,UAAU,GAAG,KAAK,EAAE,KAEhC,EAAgC,EAAE;IACjC,YAAY,EAAE,CAAC;IACf,MAAM,EAAE,IAAI,EAAE,GAAG,KAAK,CAAC;IAEvB,MAAM,QAAQ,GAAG,IAAI,QAAQ,EAAE,CAAC;IAChC,QAAQ,CAAC,MAAM,CAAC,mBAAmB,EAAE,OAAO,CAAC,eAAe,EAAE,CAAC,CAAC;IAChE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;IAE9C,MAAM,OAAO,GAAG,EAAE,kBAAkB,EAAE,gBAAgB,EAAE,CAAC;IACzD,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,iBAAiB,EAAE;QAC9C,MAAM,EAAE,MAAM;QACd,OAAO;QACP,IAAI,EAAE,QAAQ;KACf,CAAC,CAAC;IACH,OAAO,QAAQ,CAAC,IAAI,EAAE,CAAC;AACzB,CAAC,CAAC;AAEF,MAAM,YAAY,GAAG,GAAG,EAAE;IACxB,IAAI,OAAO,MAAM,KAAK,WAAW,EAAE;QACjC,MAAM,IAAI,KAAK,CAAC,oBAAoB,CAAC,CAAC;KACvC;AACH,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,aAAa,GAAG,KAAK,EAAE,KAGnC,EAAyE,EAAE;IAC1E,YAAY,EAAE,CAAC;IACf,MAAM,EAAE,GAAG,EAAE,OAAO,GAAG,KAAK,EAAE,GAAG,KAAK,CAAC;IAEvC,OAAO,OAAO,CAAC,GAAG,CAChB,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,iBAAiB,IAAI,OAAO,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,iBAAiB,EAAE,IAAI,CAAC,EACzF,KAAK,EACL,EAAE,GAAG,EAAE,CACR,CAAC;AACJ,CAAC,CAAC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@konomi-app/kintone-utilities",
3
- "version": "1.14.2",
3
+ "version": "1.15.0",
4
4
  "types": "dist/index.d.ts",
5
5
  "main": "dist/index.js",
6
6
  "repository": "https://github.com/local-bias/kintone-utilities.git",