@konomi-app/kintone-utilities 1.11.0 → 1.12.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.
Files changed (4) hide show
  1. package/dist/event-listener.d.ts +11 -0
  2. package/dist/event-listener.js +37 -1
  3. package/dist/event-listener.js.map +1 -1
  4. package/package.json +1 -1
package/dist/event-listener.d.ts CHANGED
@@ -5,6 +5,7 @@ type ErrorHandler = (error: any, props: {
5
5
  type ConstructorProps = Partial<{
6
6
  errorHandler: ErrorHandler;
7
7
  pluginId: string;
8
+ logDisabled: boolean;
8
9
  }>;
9
10
  export declare class KintoneEventListener {
10
11
  #private;
@@ -23,6 +24,16 @@ export declare class KintoneEventListener {
23
24
  add: <T = import("@kintone/rest-api-client/lib/client/types").Record>(events: kintoneAPI.EventType[], callback: (event: kintoneAPI.Event<T>, options?: {
24
25
  pluginId?: string;
25
26
  }) => kintoneAPI.Event<T> | Promise<kintoneAPI.Event<T>>) => void;
27
+ /**
28
+ * Changeイベントを登録します
29
+ *
30
+ * ChangeイベントはPromiseオブジェクトを返却することができません
31
+ * @param events
32
+ * @param callback
33
+ */
34
+ addChangeEvents: <T = import("@kintone/rest-api-client/lib/client/types").Record>(events: string[], callback: (event: kintoneAPI.Event<T>, options?: {
35
+ pluginId?: string;
36
+ }) => kintoneAPI.Event<T>) => void;
26
37
  /** JavaScript中にページを離れようとした場合にアラートを表示します */
27
38
  private beforeunload;
28
39
  }
package/dist/event-listener.js CHANGED
@@ -2,13 +2,15 @@ import { withMobileEvents } from './utilities';
2
2
  export class KintoneEventListener {
3
3
  #pluginId;
4
4
  #commonErrorHandler;
5
+ #logDisabled;
5
6
  /**
6
7
  * 複数の処理を、各イベントに登録することができます
7
8
  */
8
9
  constructor(props) {
9
- const { errorHandler = () => null, pluginId } = props ?? {};
10
+ const { errorHandler = () => null, pluginId, logDisabled = false } = props ?? {};
10
11
  this.#commonErrorHandler = errorHandler;
11
12
  this.#pluginId = pluginId;
13
+ this.#logDisabled = logDisabled;
12
14
  }
13
15
  /**
14
16
  * **この関数は`kintone.events.on`の代替関数です. 引数に互換性があります.**
@@ -22,6 +24,9 @@ export class KintoneEventListener {
22
24
  kintone.events.on(withMobileEvents(events), async (event) => {
23
25
  try {
24
26
  window.addEventListener('beforeunload', this.beforeunload);
27
+ if (!this.#logDisabled) {
28
+ console.group(`%c${event.type}`, 'color: #1e40af;');
29
+ }
25
30
  return await callback(event, { pluginId: this.#pluginId });
26
31
  }
27
32
  catch (error) {
@@ -30,6 +35,37 @@ export class KintoneEventListener {
30
35
  }
31
36
  finally {
32
37
  window.removeEventListener('beforeunload', this.beforeunload);
38
+ if (!this.#logDisabled) {
39
+ console.groupEnd();
40
+ }
41
+ }
42
+ });
43
+ };
44
+ /**
45
+ * Changeイベントを登録します
46
+ *
47
+ * ChangeイベントはPromiseオブジェクトを返却することができません
48
+ * @param events
49
+ * @param callback
50
+ */
51
+ addChangeEvents = (events, callback) => {
52
+ kintone.events.on(withMobileEvents(events), (event) => {
53
+ try {
54
+ window.addEventListener('beforeunload', this.beforeunload);
55
+ if (!this.#logDisabled) {
56
+ console.group(`%c${event.type}`, 'color: #1e40af;');
57
+ }
58
+ return callback(event, { pluginId: this.#pluginId });
59
+ }
60
+ catch (error) {
61
+ this.#commonErrorHandler(error, { event });
62
+ throw error;
63
+ }
64
+ finally {
65
+ window.removeEventListener('beforeunload', this.beforeunload);
66
+ if (!this.#logDisabled) {
67
+ console.groupEnd();
68
+ }
33
69
  }
34
70
  });
35
71
  };
package/dist/event-listener.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"event-listener.js","sourceRoot":"","sources":["../src/event-listener.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAM/C,MAAM,OAAO,oBAAoB;IACtB,SAAS,CAAU;IACnB,mBAAmB,CAAe;IAE3C;;OAEG;IACH,YAAmB,KAAwB;QACzC,MAAM,EAAE,YAAY,GAAG,GAAG,EAAE,CAAC,IAAI,EAAE,QAAQ,EAAE,GAAG,KAAK,IAAI,EAAE,CAAC;QAE5D,IAAI,CAAC,mBAAmB,GAAG,YAAY,CAAC;QACxC,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC;IAC5B,CAAC;IAED;;;;;;;OAOG;IACI,GAAG,GAAG,CACX,MAA8B,EAC9B,QAGuD,EACvD,EAAE;QACF,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC,gBAAgB,CAAC,MAAM,CAAC,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE;YAC1D,IAAI;gBACF,MAAM,CAAC,gBAAgB,CAAC,cAAc,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC;gBAC3D,OAAO,MAAM,QAAQ,CAAC,KAAK,EAAE,EAAE,QAAQ,EAAE,IAAI,CAAC,SAAS,EAAE,CAAC,CAAC;aAC5D;YAAC,OAAO,KAAK,EAAE;gBACd,MAAM,IAAI,CAAC,mBAAmB,CAAC,KAAK,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC;gBACjD,MAAM,KAAK,CAAC;aACb;oBAAS;gBACR,MAAM,CAAC,mBAAmB,CAAC,cAAc,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC;aAC/D;QACH,CAAC,CAAC,CAAC;IACL,CAAC,CAAC;IAEF,2CAA2C;IACnC,YAAY,CAAC,KAAwB;QAC3C,KAAK,CAAC,cAAc,EAAE,CAAC;QACvB,KAAK,CAAC,WAAW,GAAG,EAAE,CAAC;IACzB,CAAC;CACF"}
1
+ {"version":3,"file":"event-listener.js","sourceRoot":"","sources":["../src/event-listener.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAU/C,MAAM,OAAO,oBAAoB;IACtB,SAAS,CAAU;IACnB,mBAAmB,CAAe;IAClC,YAAY,CAAU;IAE/B;;OAEG;IACH,YAAmB,KAAwB;QACzC,MAAM,EAAE,YAAY,GAAG,GAAG,EAAE,CAAC,IAAI,EAAE,QAAQ,EAAE,WAAW,GAAG,KAAK,EAAE,GAAG,KAAK,IAAI,EAAE,CAAC;QAEjF,IAAI,CAAC,mBAAmB,GAAG,YAAY,CAAC;QACxC,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC;QAC1B,IAAI,CAAC,YAAY,GAAG,WAAW,CAAC;IAClC,CAAC;IAED;;;;;;;OAOG;IACI,GAAG,GAAG,CACX,MAA8B,EAC9B,QAGuD,EACvD,EAAE;QACF,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC,gBAAgB,CAAC,MAAM,CAAC,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE;YAC1D,IAAI;gBACF,MAAM,CAAC,gBAAgB,CAAC,cAAc,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC;gBAC3D,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE;oBACtB,OAAO,CAAC,KAAK,CAAC,KAAK,KAAK,CAAC,IAAI,EAAE,EAAE,iBAAiB,CAAC,CAAC;iBACrD;gBACD,OAAO,MAAM,QAAQ,CAAC,KAAK,EAAE,EAAE,QAAQ,EAAE,IAAI,CAAC,SAAS,EAAE,CAAC,CAAC;aAC5D;YAAC,OAAO,KAAK,EAAE;gBACd,MAAM,IAAI,CAAC,mBAAmB,CAAC,KAAK,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC;gBACjD,MAAM,KAAK,CAAC;aACb;oBAAS;gBACR,MAAM,CAAC,mBAAmB,CAAC,cAAc,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC;gBAC9D,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE;oBACtB,OAAO,CAAC,QAAQ,EAAE,CAAC;iBACpB;aACF;QACH,CAAC,CAAC,CAAC;IACL,CAAC,CAAC;IAEF;;;;;;OAMG;IACI,eAAe,GAAG,CACvB,MAAgB,EAChB,QAA8F,EAC9F,EAAE;QACF,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC,gBAAgB,CAAC,MAAM,CAAC,EAAE,CAAC,KAAK,EAAE,EAAE;YACpD,IAAI;gBACF,MAAM,CAAC,gBAAgB,CAAC,cAAc,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC;gBAC3D,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE;oBACtB,OAAO,CAAC,KAAK,CAAC,KAAK,KAAK,CAAC,IAAI,EAAE,EAAE,iBAAiB,CAAC,CAAC;iBACrD;gBACD,OAAO,QAAQ,CAAC,KAAK,EAAE,EAAE,QAAQ,EAAE,IAAI,CAAC,SAAS,EAAE,CAAC,CAAC;aACtD;YAAC,OAAO,KAAK,EAAE;gBACd,IAAI,CAAC,mBAAmB,CAAC,KAAK,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC;gBAC3C,MAAM,KAAK,CAAC;aACb;oBAAS;gBACR,MAAM,CAAC,mBAAmB,CAAC,cAAc,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC;gBAC9D,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE;oBACtB,OAAO,CAAC,QAAQ,EAAE,CAAC;iBACpB;aACF;QACH,CAAC,CAAC,CAAC;IACL,CAAC,CAAC;IAEF,2CAA2C;IACnC,YAAY,CAAC,KAAwB;QAC3C,KAAK,CAAC,cAAc,EAAE,CAAC;QACvB,KAAK,CAAC,WAAW,GAAG,EAAE,CAAC;IACzB,CAAC;CACF"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@konomi-app/kintone-utilities",
3
- "version": "1.11.0",
3
+ "version": "1.12.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",