@konomi-app/kintone-utilities 1.13.0 → 1.14.0

package/dist/api-types.d.ts

@@ -120,14 +120,6 @@ export declare namespace kintoneAPI {
             readonly fields?: FieldProperties;
         };
     }
-    /**
-     * @deprecated Use `kintoneAPI.js.EventType` instead.
-     */
-    type EventType = kintoneAPI.js.EventType;
-    /**
-     * @deprecated Use `kintoneAPI.js.Event` instead.
-     */
-    type Event<T = RecordData> = kintoneAPI.js.Event<T>;
     namespace js {
         type Event<T = RecordData> = {
             appId: number;
@@ -173,4 +165,12 @@ export declare namespace kintoneAPI {
         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';
     }
     namespace rest { }
+    /**
+     * @deprecated Use `kintoneAPI.js.EventType` instead.
+     */
+    type EventType = kintoneAPI.js.EventType;
+    /**
+     * @deprecated Use `kintoneAPI.js.Event` instead.
+     */
+    type Event<T = RecordData> = kintoneAPI.js.Event<T>;
 }

package/dist/rest-api.d.ts

@@ -1,8 +1,35 @@
-export declare const getAllRecordsWithId: <T extends {
-    $id: unknown;
-} & Record<string, any>>(props: {
-    app: number | string;
+import { kintoneAPI } from './api-types';
+type App = number | string;
+export declare const getAllRecords: <T extends Record<string, any> = import("@kintone/rest-api-client/lib/client/types").Record>(props: {
+    app: App;
+    query?: string | undefined;
     fields?: string[] | undefined;
-    onStep?: ((current: T[]) => void) | undefined;
+    onStep?: OnStep<T> | undefined;
+}) => Promise<T[]>;
+type WithId<T> = T & {
+    $id: kintoneAPI.field.ID;
+};
+type OnStep<T> = (records: T[]) => void;
+export declare const getAllRecordsWithId: <T extends Record<string, any>>(props: {
+    app: App;
+    fields?: string[] | undefined;
+    onStep?: OnStep<T> | undefined;
     condition?: string | undefined;
+}) => Promise<WithId<T>[]>;
+type OnTotalGet = (total: number) => void;
+export declare const getAllRecordsWithCursor: <T extends Record<string, any>>(props: {
+    app: App;
+    fields?: string[] | undefined;
+    query?: string | undefined;
+    onTotalGet?: OnTotalGet | undefined;
+    onStep?: OnStep<T> | undefined;
 }) => Promise<T[]>;
+export declare const uploadFile: (props: {
+    file: {
+        name: string;
+        data: Blob;
+    };
+}) => Promise<{
+    fileKey: string;
+}>;
+export {};

package/dist/rest-api.js

@@ -1,5 +1,15 @@
-const CHUNK_SIZE = 500;
+const API_ENDPOINT_ROOT = '/k/v1';
+const API_LIMIT = {
+    GET: 500,
+};
+export const getAllRecords = async (props) => {
+    if (props.query && props.query.includes('order by')) {
+        return getAllRecordsWithCursor(props);
+    }
+    return getAllRecordsWithId(props);
+};
 export const getAllRecordsWithId = async (props) => {
+    checkBrowser();
     const { fields: initFields, condition: initCondition = '' } = props;
     const fields = initFields?.length ? [...new Set([...initFields, '$id'])] : undefined;
     // order byは使用できないため、conditionに含まれている場合は除外する
@@ -9,8 +19,8 @@ export const getAllRecordsWithId = async (props) => {
 const getRecursive = async (props) => {
     const { app, fields, condition, id } = props;
     const newCondition = id ? `${condition ? `${condition} and ` : ''} $id < ${id}` : condition;
-    const query = `${newCondition} order by $id desc limit ${CHUNK_SIZE}`;
-    const { records } = await kintone.api(kintone.api.url('/k/v1/records', true), 'GET', {
+    const query = `${newCondition} order by $id desc limit ${API_LIMIT.GET}`;
+    const { records } = await kintone.api(kintone.api.url(`${API_ENDPOINT_ROOT}/records`, true), 'GET', {
         app,
         fields,
         query,
@@ -24,6 +34,46 @@ const getRecursive = async (props) => {
     }
     const lastRecord = stored[stored.length - 1];
     const lastId = lastRecord.$id.value;
-    return records.length === CHUNK_SIZE ? getRecursive({ ...props, id: lastId, stored }) : stored;
+    return records.length === API_LIMIT.GET ? getRecursive({ ...props, id: lastId, stored }) : stored;
+};
+export const getAllRecordsWithCursor = async (props) => {
+    checkBrowser();
+    const { app, fields = [], query = '', onTotalGet = null, onStep = null } = props;
+    const param = { app, fields, size: API_LIMIT.GET, query };
+    const cursor = await kintone.api(kintone.api.url(`${API_ENDPOINT_ROOT}/cursor`, true), 'POST', param);
+    if (onTotalGet) {
+        onTotalGet(cursor.totalCount);
+    }
+    return getRecordsByCursorId({ id: cursor.id, onStep });
+};
+const getRecordsByCursorId = async (props) => {
+    const { id, onStep, loadedData = [] } = props;
+    const response = await kintone.api(kintone.api.url(`${API_ENDPOINT_ROOT}/cursor`, true), 'GET', {
+        id,
+    });
+    const newRecords = [...loadedData, ...response.records];
+    if (onStep) {
+        onStep(newRecords);
+    }
+    return response.next ? getRecordsByCursorId({ id, onStep, loadedData: newRecords }) : newRecords;
+};
+export const uploadFile = async (props) => {
+    checkBrowser();
+    const { file } = props;
+    const formData = new FormData();
+    formData.append('__REQUEST_TOKEN__', kintone.getRequestToken());
+    formData.append('file', file.data, file.name);
+    const headers = { 'X-Requested-With': 'XMLHttpRequest' };
+    const response = await fetch('/k/v1/file.json', {
+        method: 'POST',
+        headers,
+        body: formData,
+    });
+    return response.json();
+};
+const checkBrowser = () => {
+    if (typeof window === 'undefined') {
+        throw new Error('この関数はブラウザでのみ使用できます');
+    }
 };
 //# sourceMappingURL=rest-api.js.map

package/dist/rest-api.js.map

@@ -1 +1 @@
-{"version":3,"file":"rest-api.js","sourceRoot":"","sources":["../src/rest-api.ts"],"names":[],"mappings":"AAAA,MAAM,UAAU,GAAG,GAAG,CAAC;AAEvB,MAAM,CAAC,MAAM,mBAAmB,GAAG,KAAK,EAAoD,KAK3F,EAAgB,EAAE;IACjB,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,EAAgB,EAAE;IACjB,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,UAAU,EAAE,CAAC;IAEtE,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,eAAe,EAAE,IAAI,CAAC,EAAE,KAAK,EAAE;QACnF,GAAG;QACH,MAAM;QACN,KAAK;KACN,CAAC,CAAC;IACH,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,UAAU,CAAC,CAAC,CAAC,YAAY,CAAC,EAAE,GAAG,KAAK,EAAE,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC;AACjG,CAAC,CAAC"}
+{"version":3,"file":"rest-api.js","sourceRoot":"","sources":["../src/rest-api.ts"],"names":[],"mappings":"AAGA,MAAM,iBAAiB,GAAG,OAAO,CAAC;AAClC,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,KAAK,CAAC,CAAC;AACvC,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,CAC9B,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,iBAAiB,SAAS,EAAE,IAAI,CAAC,EACpD,MAAM,EACN,KAAK,CACN,CAAC;IAEF,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,GAAG,iBAAiB,SAAS,EAAE,IAAI,CAAC,EAAE,KAAK,EAAE;QAC9F,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"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@konomi-app/kintone-utilities",
-  "version": "1.13.0",
+  "version": "1.14.0",
   "types": "dist/index.d.ts",
   "main": "dist/index.js",
   "repository": "https://github.com/local-bias/kintone-utilities.git",