@konomi-app/kintone-utilities 1.19.0 → 1.20.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.
@@ -193,5 +193,34 @@ export declare namespace kintoneAPI {
193
193
  };
194
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';
195
195
  }
196
- namespace rest { }
196
+ namespace rest {
197
+ type AppID = string | number;
198
+ type RecordID = string | number;
199
+ type Revision = string | number;
200
+ type Frame = Record<string, any>;
201
+ type Method = 'GET' | 'PUT' | 'POST' | 'DELETE';
202
+ type TypeOmmited<T extends Record<string, any> = kintoneAPI.RecordData> = {
203
+ [P in keyof T]: Omit<T[P], 'type'>;
204
+ };
205
+ type RecordToRequest<T extends Frame = kintoneAPI.RecordData> = Partial<TypeOmmited<T>>;
206
+ type RecordPutRequest<T extends Frame = kintoneAPI.RecordData> = {
207
+ app: AppID;
208
+ record: RecordToRequest<T>;
209
+ revision?: Revision;
210
+ } & ({
211
+ id: RecordID;
212
+ } | {
213
+ updateKey: {
214
+ field: keyof T;
215
+ value: string | number;
216
+ };
217
+ });
218
+ type RecordsPostRequest<T extends Frame = kintoneAPI.RecordData> = {
219
+ app: AppID;
220
+ records: RecordToRequest<T>[];
221
+ };
222
+ type RecordsPostResponse<T extends Frame = kintoneAPI.RecordData> = {
223
+ records: RecordToRequest<T>[];
224
+ };
225
+ }
197
226
  }
@@ -0,0 +1,14 @@
1
+ import { kintoneAPI } from '.';
2
+ type App = string | number;
3
+ export type TypeOmmited<T extends Record<string, any> = kintoneAPI.RecordData> = {
4
+ [P in keyof T]: Omit<T[P], 'type'>;
5
+ };
6
+ type RecordToRequest<T extends Record<string, any> = kintoneAPI.RecordData> = Partial<TypeOmmited<T>>;
7
+ export type RecordsPostRequest<T extends Record<string, any> = kintoneAPI.RecordData> = {
8
+ app: App;
9
+ records: RecordToRequest<T>[];
10
+ };
11
+ export type RecordsPostResponse<T extends Record<string, any> = kintoneAPI.RecordData> = {
12
+ records: RecordToRequest<T>[];
13
+ };
14
+ export {};
@@ -0,0 +1,2 @@
1
+ export {};
2
+ //# sourceMappingURL=rest.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"rest.js","sourceRoot":"","sources":["../../../src/types/api/rest.ts"],"names":[],"mappings":""}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@konomi-app/kintone-utilities",
3
- "version": "1.19.0",
3
+ "version": "1.20.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",