@konomi-app/kintone-utilities 3.0.6 → 3.1.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.
package/dist/event-listener.d.ts
CHANGED
|
@@ -1,5 +1,4 @@
|
|
|
1
1
|
import type { kintoneAPI } from './types/api';
|
|
2
|
-
import { KintoneEventMap } from './types/api/js';
|
|
3
2
|
type ErrorHandler = (error: any, props: {
|
|
4
3
|
event: kintoneAPI.Event;
|
|
5
4
|
}) => void;
|
|
@@ -13,7 +12,7 @@ type CallbackOption = {
|
|
|
13
12
|
pluginId?: string;
|
|
14
13
|
guestSpaceId: string | null;
|
|
15
14
|
};
|
|
16
|
-
export declare class KintoneEventListener
|
|
15
|
+
export declare class KintoneEventListener {
|
|
17
16
|
#private;
|
|
18
17
|
/**
|
|
19
18
|
* 複数の処理を、各イベントに登録することができます
|
|
@@ -27,7 +26,7 @@ export declare class KintoneEventListener<T = kintoneAPI.RecordData> {
|
|
|
27
26
|
* @param events
|
|
28
27
|
* @param callback
|
|
29
28
|
*/
|
|
30
|
-
add: <
|
|
29
|
+
add: <T = import("./types/api/record").Record>(events: kintoneAPI.js.EventType[], callback: (event: kintoneAPI.js.Event<T>, options: CallbackOption) => kintoneAPI.js.Event<T> | Promise<kintoneAPI.js.Event<T>>) => void;
|
|
31
30
|
/**
|
|
32
31
|
* Changeイベントを登録します
|
|
33
32
|
*
|
|
@@ -35,7 +34,7 @@ export declare class KintoneEventListener<T = kintoneAPI.RecordData> {
|
|
|
35
34
|
* @param events
|
|
36
35
|
* @param callback
|
|
37
36
|
*/
|
|
38
|
-
addChangeEvents: (events: string[], callback: (event: kintoneAPI.js.Event<T>, options: CallbackOption) => kintoneAPI.js.Event<T>) => void;
|
|
37
|
+
addChangeEvents: <T = import("./types/api/record").Record>(events: string[], callback: (event: kintoneAPI.js.Event<T>, options: CallbackOption) => kintoneAPI.js.Event<T>) => void;
|
|
39
38
|
private initialize;
|
|
40
39
|
private tarminate;
|
|
41
40
|
set logDisabled(value: boolean);
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"event-listener.js","sourceRoot":"","sources":["../src/event-listener.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"event-listener.js","sourceRoot":"","sources":["../src/event-listener.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,kBAAkB,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAanE,MAAM,OAAO,oBAAoB;IACtB,IAAI,GAAW,IAAI,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IACnD,SAAS,CAAU;IACnB,mBAAmB,CAAe;IAClC,aAAa,CAAgB;IACtC,YAAY,CAAU;IACtB,UAAU,CAAS;IAEnB;;OAEG;IACH,YAAmB,KAAwB;QACzC,MAAM,EACJ,YAAY,GAAG,GAAG,EAAE,CAAC,IAAI,EACzB,QAAQ,EACR,WAAW,GAAG,KAAK,EACnB,SAAS,GAAG,EAAE,GACf,GAAG,KAAK,IAAI,EAAE,CAAC;QAEhB,MAAM,YAAY,GAAG,kBAAkB,EAAE,CAAC;QAE1C,IAAI,CAAC,mBAAmB,GAAG,YAAY,CAAC;QACxC,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC;QAC1B,IAAI,CAAC,aAAa,GAAG,YAAY,CAAC;QAClC,IAAI,CAAC,YAAY,GAAG,WAAW,CAAC;QAChC,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC;IAC9B,CAAC;IAED;;;;;;;OAOG;IACI,GAAG,GAAG,CACX,MAAiC,EACjC,QAG6D,EAC7D,EAAE;QACF,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC,gBAAgB,CAAC,MAAM,CAAC,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE;YAC1D,IAAI;gBACF,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;gBACvB,OAAO,MAAM,QAAQ,CAAC,KAAK,EAAE;oBAC3B,QAAQ,EAAE,IAAI,CAAC,SAAS;oBACxB,YAAY,EAAE,IAAI,CAAC,aAAa;iBACjC,CAAC,CAAC;aACJ;YAAC,OAAO,KAAK,EAAE;gBACd,MAAM,IAAI,CAAC,mBAAmB,CAAC,KAAK,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC;gBACjD,MAAM,KAAK,CAAC;aACb;oBAAS;gBACR,IAAI,CAAC,SAAS,EAAE,CAAC;aAClB;QACH,CAAC,CAAC,CAAC;IACL,CAAC,CAAC;IAEF;;;;;;OAMG;IACI,eAAe,GAAG,CACvB,MAAgB,EAChB,QAA4F,EAC5F,EAAE;QACF,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC,gBAAgB,CAAC,MAAM,CAAC,EAAE,CAAC,KAAK,EAAE,EAAE;YACpD,IAAI;gBACF,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;gBACvB,OAAO,QAAQ,CAAC,KAAK,EAAE;oBACrB,QAAQ,EAAE,IAAI,CAAC,SAAS;oBACxB,YAAY,EAAE,IAAI,CAAC,aAAa;iBACjC,CAAC,CAAC;aACJ;YAAC,OAAO,KAAK,EAAE;gBACd,IAAI,CAAC,mBAAmB,CAAC,KAAK,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC;gBAC3C,MAAM,KAAK,CAAC;aACb;oBAAS;gBACR,IAAI,CAAC,SAAS,EAAE,CAAC;aAClB;QACH,CAAC,CAAC,CAAC;IACL,CAAC,CAAC;IAEM,UAAU,GAAG,CAAC,KAA0B,EAAE,EAAE;QAClD,MAAM,CAAC,gBAAgB,CAAC,cAAc,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC;QAC3D,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE;YACtB,OAAO,CAAC,KAAK,CACX,GAAG,IAAI,CAAC,UAAU,KAAK,KAAK,CAAC,IAAI,OAAO,IAAI,CAAC,IAAI,GAAG,EACpD,iBAAiB,EACjB,aAAa,CACd,CAAC;SACH;IACH,CAAC,CAAC;IAEM,SAAS,GAAG,GAAG,EAAE;QACvB,MAAM,CAAC,mBAAmB,CAAC,cAAc,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC;QAC9D,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE;YACtB,OAAO,CAAC,QAAQ,EAAE,CAAC;SACpB;IACH,CAAC,CAAC;IAEF,IAAW,WAAW,CAAC,KAAc;QACnC,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC;IAC5B,CAAC;IAED,IAAW,SAAS,CAAC,KAAa;QAChC,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC;IAC1B,CAAC;IAED,2CAA2C;IACnC,YAAY,CAAC,KAAwB;QAC3C,KAAK,CAAC,cAAc,EAAE,CAAC;QACvB,KAAK,CAAC,WAAW,GAAG,EAAE,CAAC;IACzB,CAAC;CACF"}
|
|
@@ -1,7 +1,6 @@
|
|
|
1
1
|
import type { Calc as CalcField, Category as CategoryField, CheckBox as CheckBoxField, CreatedTime as CreatedTimeField, Creator as CreatorField, Date as DateField, DateTime as DateTimeField, Dropdown as DropdownField, File as FileField, GroupSelect as GroupSelectField, ID as IDField, InSubtable as InSubtableField, Link as LinkField, Modifier as ModifierField, MultiLineText as MultiLineTextField, MultiSelect as MultiSelectField, Number as NumberField, OneOf as OneOfField, OrganizationSelect as OrganizationSelectField, RadioButton as RadioButtonField, RecordNumber as RecordNumberField, Revision as RevisionField, RichText as RichTextField, SingleLineText as SingleLineTextField, StatusAssignee as StatusAssigneeField, Status as StatusField, Subtable as SubtableField, Time as TimeField, UpdatedTime as UpdatedTimeField, UserSelect as UserSelectField } from './field';
|
|
2
2
|
import type { CheckBox as DefaultLayoutCheckBox, CreatedTime as DefaultLayoutCreatedTime, Creator as DefaultLayoutCreator, Date as DefaultLayoutDate, DateTime as DefaultLayoutDateTime, Dropdown as DefaultLayoutDropdown, OneOf as DefaultLayoutField, File as DefaultLayoutFile, GroupSelect as DefaultLayoutGroupSelect, HR as DefaultLayoutHR, InSubtable as DefaultLayoutInSubtable, Label as DefaultLayoutLabel, Link as DefaultLayoutLink, Modifier as DefaultLayoutModifier, MultiLineText as DefaultLayoutMultiLineText, MultiSelect as DefaultLayoutMultiSelect, Number as DefaultLayoutNumber, OrganizationSelect as DefaultLayoutOrganizationSelect, RadioButton as DefaultLayoutRadioButton, RecordNumber as DefaultLayoutRecordNumber, ReferenceTable as DefaultLayoutReferenceTable, RichText as DefaultLayoutRichText, SingleLineText as DefaultLayoutSingleLineText, Spacer as DefaultLayoutSpacer, Time as DefaultLayoutTime, UpdatedTime as DefaultLayoutUpdatedTime, UserSelect as DefaultLayoutUserSelect } from './fieldLayout';
|
|
3
3
|
import type { Layout as DefaultLayout } from './form';
|
|
4
|
-
import { KintoneEventMap } from './js';
|
|
5
4
|
import type { Group as DefaultGroup, Row as DefaultRow } from './layout';
|
|
6
5
|
import type { Calc as CalcProperty, Category as CategoryProperty, CheckBox as CheckBoxProperty, CreatedTime as CreatedTimeProperty, Creator as CreatorProperty, Date as DateProperty, DateTime as DateTimeProperty, Dropdown as DropdownProperty, File as FileProperty, GroupSelect as GroupSelectProperty, InSubtable as InSubtableProperty, Link as LinkProperty, Modifier as ModifierProperty, MultiLineText as MultiLineTextProperty, MultiSelect as MultiSelectProperty, Number as NumberProperty, OneOf as OneOfProperty, Lookup as LookupProperty, OrganizationSelect as OrganizationSelectProperty, RadioButton as RadioButtonProperty, RecordNumber as RecordNumberProperty, RichText as RichTextProperty, SingleLineText as SingleLineTextProperty, StatusAssignee as StatusAssigneeProperty, Status as StatusProperty, Subtable as SubtableProperty, Time as TimeProperty, UpdatedTime as UpdatedTimeProperty, UserSelect as UserSelectProperty } from './property';
|
|
7
6
|
import type { Record as DefaultRecord } from './record';
|
|
@@ -149,14 +148,75 @@ export declare namespace kintoneAPI {
|
|
|
149
148
|
/**
|
|
150
149
|
* @deprecated Use `kintoneAPI.js.EventType` instead.
|
|
151
150
|
*/
|
|
152
|
-
type EventType =
|
|
151
|
+
type EventType = kintoneAPI.js.EventType;
|
|
153
152
|
/**
|
|
154
153
|
* @deprecated Use `kintoneAPI.js.Event` instead.
|
|
155
154
|
*/
|
|
156
|
-
type Event<T = RecordData> =
|
|
155
|
+
type Event<T = RecordData> = kintoneAPI.js.Event<T>;
|
|
157
156
|
namespace js {
|
|
158
|
-
type Event<T = RecordData> =
|
|
159
|
-
|
|
157
|
+
type Event<T = RecordData> = {
|
|
158
|
+
appId: number;
|
|
159
|
+
recordId: number;
|
|
160
|
+
record: T;
|
|
161
|
+
error: string;
|
|
162
|
+
url: string;
|
|
163
|
+
type: EventType;
|
|
164
|
+
changes?: {
|
|
165
|
+
field: {
|
|
166
|
+
type: string;
|
|
167
|
+
value: string;
|
|
168
|
+
};
|
|
169
|
+
row: any;
|
|
170
|
+
};
|
|
171
|
+
records?: T[];
|
|
172
|
+
/**
|
|
173
|
+
* 現在表示している一覧のID
|
|
174
|
+
* app.record.index.show イベントでのみ取得できます
|
|
175
|
+
*/
|
|
176
|
+
viewId: number;
|
|
177
|
+
/**
|
|
178
|
+
* 現在表示している一覧の種類
|
|
179
|
+
* app.record.index.show イベントでのみ取得できます
|
|
180
|
+
*/
|
|
181
|
+
viewType?: 'list' | 'calendar' | 'custom';
|
|
182
|
+
/**
|
|
183
|
+
* 現在表示している一覧の名前
|
|
184
|
+
* app.record.index.show イベントでのみ取得できます
|
|
185
|
+
*/
|
|
186
|
+
viewName?: string;
|
|
187
|
+
/**
|
|
188
|
+
* 一覧のレコードのオフセット
|
|
189
|
+
* app.record.index.show イベントでのみ取得でき、viewTypeがCalendar以外の場合に取得できます
|
|
190
|
+
*/
|
|
191
|
+
offset?: number | null;
|
|
192
|
+
/**
|
|
193
|
+
* 一覧のレコードの表示件数
|
|
194
|
+
* app.record.index.show イベントでのみ取得でき、viewTypeがCalendar以外の場合に取得できます
|
|
195
|
+
*/
|
|
196
|
+
size?: number | null;
|
|
197
|
+
/**
|
|
198
|
+
* プロセス - 実行されたアクション
|
|
199
|
+
* app.record.detail.process.proceed イベントで取得できます
|
|
200
|
+
*/
|
|
201
|
+
action?: {
|
|
202
|
+
value: string;
|
|
203
|
+
};
|
|
204
|
+
/**
|
|
205
|
+
* プロセス - 現在のステータス
|
|
206
|
+
* app.record.detail.process.proceed イベントで取得できます
|
|
207
|
+
*/
|
|
208
|
+
status?: {
|
|
209
|
+
value: string;
|
|
210
|
+
};
|
|
211
|
+
/**
|
|
212
|
+
* プロセス - 次のステータス
|
|
213
|
+
* app.record.detail.process.proceed イベントで取得できます
|
|
214
|
+
*/
|
|
215
|
+
nextStatus?: {
|
|
216
|
+
value: string;
|
|
217
|
+
};
|
|
218
|
+
};
|
|
219
|
+
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';
|
|
160
220
|
}
|
|
161
221
|
namespace rest {
|
|
162
222
|
type AppIDToRequest = string | number;
|