@konomi-app/kintone-utilities 0.5.3

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Ribbit
+
+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,3 @@
+# kintone-utilities
+
+[ホームページ](https://ribbit.konomi.app)

package/dist/api-types.d.ts

@@ -0,0 +1,140 @@
+import type { App as DefaultApp, Layout as DefaultLayout, Record as DefaultRecord, ViewForParameter, ViewForResponse } from '@kintone/rest-api-client/lib/client/types';
+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, Status as StatusField, StatusAssignee as StatusAssigneeField, Subtable as SubtableField, Time as TimeField, UpdatedTime as UpdatedTimeField, UserSelect as UserSelectField } from '@kintone/rest-api-client/lib/KintoneFields/types/field';
+import type { Label as DefaultLayoutLabel, OneOf as DefaultLayoutField } from '@kintone/rest-api-client/lib/KintoneFields/types/fieldLayout';
+import type { Group as DefaultGroup, Row as DefaultRow } from '@kintone/rest-api-client/lib/KintoneFields/types/layout';
+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, OrganizationSelect as OrganizationSelectProperty, RadioButton as RadioButtonProperty, RecordNumber as RecordNumberProperty, RichText as RichTextProperty, SingleLineText as SingleLineTextProperty, Status as StatusProperty, StatusAssignee as StatusAssigneeProperty, Subtable as SubtableProperty, Time as TimeProperty, UpdatedTime as UpdatedTimeProperty, UserSelect as UserSelectProperty } from '@kintone/rest-api-client/lib/KintoneFields/types/property';
+export declare namespace kintoneAPI {
+    type App = DefaultApp;
+    type RecordData = DefaultRecord;
+    namespace view {
+        type Response = ViewForResponse;
+        type Parameter = ViewForParameter;
+    }
+    type Field = OneOfField;
+    /** JavaScript APIやREST APIから取得できるレコードの各フィールド情報 */
+    namespace field {
+        type Calc = CalcField;
+        type Category = CategoryField;
+        type CheckBox = CheckBoxField;
+        type CreatedTime = CreatedTimeField;
+        type Creator = CreatorField;
+        type Date = DateField;
+        type DateTime = DateTimeField;
+        type Dropdown = DropdownField;
+        type File = FileField;
+        type GroupSelect = GroupSelectField;
+        type GroupEntity = GroupSelect['value'][number];
+        type ID = IDField;
+        type InSubtable = InSubtableField;
+        type Link = LinkField;
+        type Modifier = ModifierField;
+        type MultiLineText = MultiLineTextField;
+        type MultiSelect = MultiSelectField;
+        type Number = NumberField;
+        type OneOf = OneOfField;
+        type OrganizationSelect = OrganizationSelectField;
+        type OrganizationEntity = OrganizationSelect['value'][number];
+        type RadioButton = RadioButtonField;
+        type RecordNumber = RecordNumberField;
+        type Revision = RevisionField;
+        type RichText = RichTextField;
+        type SingleLineText = SingleLineTextField;
+        type Status = StatusField;
+        type StatusAssignee = StatusAssigneeField;
+        type Subtable<T extends Record<string, InSubtable> = Record<string, InSubtable>> = SubtableField<T>;
+        type Time = TimeField;
+        type UpdatedTime = UpdatedTimeField;
+        type UserSelect = UserSelectField;
+        type UserEntity = UserSelect['value'][number];
+    }
+    type FieldProperty = OneOfProperty;
+    type FieldPropertyType = FieldProperty['type'];
+    type FieldProperties = Record<string, OneOfProperty>;
+    type FieldEntry = [string, OneOfProperty];
+    /** REST APIから取得できるアプリの各フィールド情報 */
+    namespace property {
+        type Calc = CalcProperty;
+        type Category = CategoryProperty;
+        type CheckBox = CheckBoxProperty;
+        type CreatedTime = CreatedTimeProperty;
+        type Creator = CreatorProperty;
+        type Date = DateProperty;
+        type DateTime = DateTimeProperty;
+        type Dropdown = DropdownProperty;
+        type File = FileProperty;
+        type GroupSelect = GroupSelectProperty;
+        type InSubtable = InSubtableProperty;
+        type Link = LinkProperty;
+        type Modifier = ModifierProperty;
+        type MultiLineText = MultiLineTextProperty;
+        type MultiSelect = MultiSelectProperty;
+        type Number = NumberProperty;
+        type OneOf = OneOfProperty;
+        type OrganizationSelect = OrganizationSelectProperty;
+        type RadioButton = RadioButtonProperty;
+        type RecordNumber = RecordNumberProperty;
+        type RichText = RichTextProperty;
+        type SingleLineText = SingleLineTextProperty;
+        type Status = StatusProperty;
+        type StatusAssignee = StatusAssigneeProperty;
+        type Subtable<T extends Record<string, InSubtable> = Record<string, InSubtable>> = SubtableProperty<T>;
+        type Time = TimeProperty;
+        type UpdatedTime = UpdatedTimeProperty;
+        type UserSelect = UserSelectProperty;
+    }
+    type Layout = DefaultLayout;
+    type LayoutField = DefaultLayoutField;
+    namespace layout {
+        type Label = DefaultLayoutLabel;
+        type Row = DefaultRow<LayoutField[]>;
+        type Group = DefaultGroup<Row[]>;
+    }
+    namespace response {
+        type App = {
+            readonly app?: DefaultApp;
+            readonly fields?: FieldProperties;
+        };
+    }
+    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';
+    type Event<T = RecordData> = {
+        appId: number;
+        viewId: number;
+        recordId: number;
+        record: T;
+        error: string;
+        url: string;
+        type: EventType;
+        changes?: {
+            field: {
+                type: string;
+                value: string;
+            };
+            row: any;
+        };
+        records?: T[];
+        viewType?: string;
+        viewName?: string;
+        offset?: number;
+        /**
+         * プロセス - 実行されたアクション
+         * app.record.detail.process.proceed イベントで取得できます
+         */
+        action?: {
+            value: string;
+        };
+        /**
+         * プロセス - 現在のステータス
+         * app.record.detail.process.proceed イベントで取得できます
+         */
+        status?: {
+            value: string;
+        };
+        /**
+         * プロセス - 次のステータス
+         * app.record.detail.process.proceed イベントで取得できます
+         */
+        nextStatus?: {
+            value: string;
+        };
+    };
+}

package/dist/api-types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=api-types.js.map

package/dist/api-types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"api-types.js","sourceRoot":"","sources":["../src/api-types.ts"],"names":[],"mappings":""}

package/dist/event-listener.d.ts

@@ -0,0 +1,16 @@
+import type { kintoneAPI } from './api-types';
+type ErrorHandler = (error: any, props: {
+    event: kintoneAPI.Event;
+}) => void;
+type ConstructorProps = {
+    errorHandler?: ErrorHandler;
+};
+export declare class KintoneEventListener {
+    #private;
+    /**
+     * 複数の処理を、各イベントに登録することができます
+     */
+    constructor(props?: ConstructorProps);
+    add: <T = import("@kintone/rest-api-client/lib/client/types").Record>(events: kintoneAPI.EventType[], callback: (event: kintoneAPI.Event<T>) => kintoneAPI.Event<T> | Promise<kintoneAPI.Event<T>>) => void;
+}
+export {};

package/dist/event-listener.js

@@ -0,0 +1,23 @@
+import { withMobileEvents } from './utilities';
+export class KintoneEventListener {
+    #commonErrorHandler;
+    /**
+     * 複数の処理を、各イベントに登録することができます
+     */
+    constructor(props) {
+        const { errorHandler = () => null } = props ?? {};
+        this.#commonErrorHandler = errorHandler;
+    }
+    add = (events, callback) => {
+        kintone.events.on(withMobileEvents(events), async (event) => {
+            try {
+                return await callback(event);
+            }
+            catch (error) {
+                await this.#commonErrorHandler(error, { event });
+                throw error;
+            }
+        });
+    };
+}
+//# sourceMappingURL=event-listener.js.map

package/dist/event-listener.js.map

@@ -0,0 +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,mBAAmB,CAAe;IAE3C;;OAEG;IACH,YAAmB,KAAwB;QACzC,MAAM,EAAE,YAAY,GAAG,GAAG,EAAE,CAAC,IAAI,EAAE,GAAG,KAAK,IAAI,EAAE,CAAC;QAElD,IAAI,CAAC,mBAAmB,GAAG,YAAY,CAAC;IAC1C,CAAC;IAEM,GAAG,GAAG,CACX,MAA8B,EAC9B,QAA4F,EAC5F,EAAE;QACF,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC,gBAAgB,CAAC,MAAM,CAAC,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE;YAC1D,IAAI;gBACF,OAAO,MAAM,QAAQ,CAAC,KAAK,CAAC,CAAC;aAC9B;YAAC,OAAO,KAAK,EAAE;gBACd,MAAM,IAAI,CAAC,mBAAmB,CAAC,KAAK,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC;gBACjD,MAAM,KAAK,CAAC;aACb;QACH,CAAC,CAAC,CAAC;IACL,CAAC,CAAC;CACH"}

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+export type { kintoneAPI } from './api-types';
+export * from './utilities';
+export * from './event-listener';

package/dist/index.js

@@ -0,0 +1,3 @@
+export * from './utilities';
+export * from './event-listener';
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAEA,cAAc,aAAa,CAAC;AAC5B,cAAc,kBAAkB,CAAC"}

package/dist/utilities.d.ts

@@ -0,0 +1,19 @@
+import type { kintoneAPI } from './api-types';
+/**
+ * 各フィールドタイプの値を文字列として返却します
+ *
+ * 配列で取得されるような値は区切り文字で連結されます
+ * @param field
+ * @param options
+ * @returns
+ */
+export declare const getFieldValueAsString: (field: kintoneAPI.Field, options?: {
+    separator?: string;
+    ignoresCalculationError?: boolean;
+}) => string;
+/**
+ * デスクトップ版のイベントタイプを基に、モバイル版を追加し返却します
+ * @param events デスクトップのイベントタイプ
+ * @returns モバイルを含むイベントタイプ
+ */
+export declare const withMobileEvents: (events: string[]) => string[];

package/dist/utilities.js

@@ -0,0 +1,71 @@
+/**
+ * 各フィールドタイプの値を文字列として返却します
+ *
+ * 配列で取得されるような値は区切り文字で連結されます
+ * @param field
+ * @param options
+ * @returns
+ */
+export const getFieldValueAsString = (field, options) => {
+    const { separator = ', ', ignoresCalculationError = false } = options ?? {};
+    if (field.type === 'MULTI_LINE_TEXT' ||
+        field.type === 'RICH_TEXT' ||
+        field.type === 'CREATED_TIME' ||
+        field.type === 'DATE' ||
+        field.type === 'DATETIME' ||
+        field.type === 'DROP_DOWN' ||
+        field.type === 'LINK' ||
+        field.type === 'RECORD_NUMBER' ||
+        field.type === 'STATUS' ||
+        field.type === 'RADIO_BUTTON' ||
+        field.type === 'TIME' ||
+        field.type === 'UPDATED_TIME' ||
+        field.type === '__ID__' ||
+        field.type === '__REVISION__') {
+        return field.value ?? '';
+    }
+    else if (field.type === 'SINGLE_LINE_TEXT' ||
+        field.type === 'NUMBER' ||
+        field.type === 'CALC') {
+        const value = field.value ?? '';
+        if (ignoresCalculationError) {
+            return /^#.*!$/.test(value) ? '' : value;
+        }
+        return value;
+    }
+    else if (field.type === 'CATEGORY' ||
+        field.type === 'CHECK_BOX' ||
+        field.type === 'MULTI_SELECT') {
+        return field.value.join(separator);
+    }
+    else if (field.type === 'CREATOR' || field.type === 'MODIFIER') {
+        return field.value.name;
+    }
+    else if (field.type === 'GROUP_SELECT' ||
+        field.type === 'ORGANIZATION_SELECT' ||
+        field.type === 'USER_SELECT' ||
+        field.type === 'STATUS_ASSIGNEE') {
+        return field.value.map((value) => value.name).join(separator);
+    }
+    else if (field.type === 'FILE') {
+        return field.value.map((value) => value.name).join(separator);
+    }
+    else if (field.type === 'SUBTABLE') {
+        return field.value
+            .map((row) => Object.values(row.value)
+            .map((cell) => getFieldValueAsString(cell, { separator }))
+            .join(separator))
+            .join(separator);
+    }
+    return '';
+};
+/**
+ * デスクトップ版のイベントタイプを基に、モバイル版を追加し返却します
+ * @param events デスクトップのイベントタイプ
+ * @returns モバイルを含むイベントタイプ
+ */
+export const withMobileEvents = (events) => {
+    const mobileEvents = events.filter((e) => !/^mobile/.test(e)).map((type) => 'mobile.' + type);
+    return [...events, ...mobileEvents];
+};
+//# sourceMappingURL=utilities.js.map

package/dist/utilities.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utilities.js","sourceRoot":"","sources":["../src/utilities.ts"],"names":[],"mappings":"AAEA;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG,CACnC,KAAuB,EACvB,OAGC,EACO,EAAE;IACV,MAAM,EAAE,SAAS,GAAG,IAAI,EAAE,uBAAuB,GAAG,KAAK,EAAE,GAAG,OAAO,IAAI,EAAE,CAAC;IAE5E,IACE,KAAK,CAAC,IAAI,KAAK,iBAAiB;QAChC,KAAK,CAAC,IAAI,KAAK,WAAW;QAC1B,KAAK,CAAC,IAAI,KAAK,cAAc;QAC7B,KAAK,CAAC,IAAI,KAAK,MAAM;QACrB,KAAK,CAAC,IAAI,KAAK,UAAU;QACzB,KAAK,CAAC,IAAI,KAAK,WAAW;QAC1B,KAAK,CAAC,IAAI,KAAK,MAAM;QACrB,KAAK,CAAC,IAAI,KAAK,eAAe;QAC9B,KAAK,CAAC,IAAI,KAAK,QAAQ;QACvB,KAAK,CAAC,IAAI,KAAK,cAAc;QAC7B,KAAK,CAAC,IAAI,KAAK,MAAM;QACrB,KAAK,CAAC,IAAI,KAAK,cAAc;QAC7B,KAAK,CAAC,IAAI,KAAK,QAAQ;QACvB,KAAK,CAAC,IAAI,KAAK,cAAc,EAC7B;QACA,OAAO,KAAK,CAAC,KAAK,IAAI,EAAE,CAAC;KAC1B;SAAM,IACL,KAAK,CAAC,IAAI,KAAK,kBAAkB;QACjC,KAAK,CAAC,IAAI,KAAK,QAAQ;QACvB,KAAK,CAAC,IAAI,KAAK,MAAM,EACrB;QACA,MAAM,KAAK,GAAG,KAAK,CAAC,KAAK,IAAI,EAAE,CAAC;QAChC,IAAI,uBAAuB,EAAE;YAC3B,OAAO,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC;SAC1C;QACD,OAAO,KAAK,CAAC;KACd;SAAM,IACL,KAAK,CAAC,IAAI,KAAK,UAAU;QACzB,KAAK,CAAC,IAAI,KAAK,WAAW;QAC1B,KAAK,CAAC,IAAI,KAAK,cAAc,EAC7B;QACA,OAAO,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;KACpC;SAAM,IAAI,KAAK,CAAC,IAAI,KAAK,SAAS,IAAI,KAAK,CAAC,IAAI,KAAK,UAAU,EAAE;QAChE,OAAO,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC;KACzB;SAAM,IACL,KAAK,CAAC,IAAI,KAAK,cAAc;QAC7B,KAAK,CAAC,IAAI,KAAK,qBAAqB;QACpC,KAAK,CAAC,IAAI,KAAK,aAAa;QAC5B,KAAK,CAAC,IAAI,KAAK,iBAAiB,EAChC;QACA,OAAO,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;KAC/D;SAAM,IAAI,KAAK,CAAC,IAAI,KAAK,MAAM,EAAE;QAChC,OAAO,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;KAC/D;SAAM,IAAI,KAAK,CAAC,IAAI,KAAK,UAAU,EAAE;QACpC,OAAO,KAAK,CAAC,KAAK;aACf,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CACX,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC;aACrB,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,qBAAqB,CAAC,IAAI,EAAE,EAAE,SAAS,EAAE,CAAC,CAAC;aACzD,IAAI,CAAC,SAAS,CAAC,CACnB;aACA,IAAI,CAAC,SAAS,CAAC,CAAC;KACpB;IACD,OAAO,EAAE,CAAC;AACZ,CAAC,CAAC;AAEF;;;;GAIG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,MAAgB,EAAY,EAAE;IAC7D,MAAM,YAAY,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,SAAS,GAAG,IAAI,CAAC,CAAC;IAC9F,OAAO,CAAC,GAAG,MAAM,EAAE,GAAG,YAAY,CAAC,CAAC;AACtC,CAAC,CAAC"}

package/package.json

@@ -0,0 +1,29 @@
+{
+  "name": "@konomi-app/kintone-utilities",
+  "version": "0.5.3",
+  "types": "dist/index.d.ts",
+  "main": "dist/index.js",
+  "repository": "https://github.com/local-bias/kintone-utilities.git",
+  "author": "Ribbit",
+  "license": "MIT",
+  "scripts": {
+    "build": "tsc",
+    "prepare": "yarn run build"
+  },
+  "dependencies": {
+    "@kintone/rest-api-client": "^3.3.1"
+  },
+  "devDependencies": {
+    "@kintone/dts-gen": "^6.1.19",
+    "typescript": "^4.9.5"
+  },
+  "prettier": {
+    "printWidth": 100,
+    "arrowParens": "always",
+    "singleQuote": true,
+    "jsxSingleQuote": true,
+    "tabWidth": 2,
+    "trailingComma": "es5",
+    "endOfLine": "lf"
+  }
+}