You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
106 lines
2.7 KiB
106 lines
2.7 KiB
import { CellValue } from "./GristData";
|
|
|
|
/**
|
|
* JSON schema for api /record endpoint. Used in POST method for adding new records.
|
|
*/
|
|
export interface NewRecord {
|
|
/**
|
|
* Initial values of cells in record. Optional, if not set cells are left
|
|
* blank.
|
|
*/
|
|
fields?: { [coldId: string]: CellValue };
|
|
}
|
|
|
|
export interface NewRecordWithStringId {
|
|
id?: string; // tableId or colId
|
|
/**
|
|
* Initial values of cells in record. Optional, if not set cells are left
|
|
* blank.
|
|
*/
|
|
fields?: { [coldId: string]: CellValue };
|
|
}
|
|
|
|
/**
|
|
* JSON schema for api /record endpoint. Used in PATCH method for updating existing records.
|
|
*/
|
|
export interface Record {
|
|
id: number;
|
|
fields: { [coldId: string]: CellValue };
|
|
}
|
|
|
|
export interface RecordWithStringId {
|
|
id: string; // tableId or colId
|
|
fields: { [coldId: string]: CellValue };
|
|
}
|
|
|
|
/**
|
|
* JSON schema for api /record endpoint. Used in PUT method for adding or updating records.
|
|
*/
|
|
export interface AddOrUpdateRecord {
|
|
/**
|
|
* The values we expect to have in particular columns, either by matching with
|
|
* an existing record, or creating a new record.
|
|
*/
|
|
require: { [coldId: string]: CellValue } & { id?: number };
|
|
|
|
/**
|
|
* The values we will place in particular columns, either overwriting values in
|
|
* an existing record, or setting initial values in a new record.
|
|
*/
|
|
fields?: { [coldId: string]: CellValue };
|
|
}
|
|
|
|
/**
|
|
* JSON schema for the body of api /record PATCH endpoint
|
|
*/
|
|
export interface RecordsPatch {
|
|
records: [Record, ...Record[]]; // at least one record is required
|
|
}
|
|
|
|
/**
|
|
* JSON schema for the body of api /record POST endpoint
|
|
*/
|
|
export interface RecordsPost {
|
|
records: [NewRecord, ...NewRecord[]]; // at least one record is required
|
|
}
|
|
|
|
/**
|
|
* JSON schema for the body of api /record PUT endpoint
|
|
*/
|
|
export interface RecordsPut {
|
|
records: [AddOrUpdateRecord, ...AddOrUpdateRecord[]]; // at least one record is required
|
|
}
|
|
|
|
export type RecordId = number;
|
|
|
|
/**
|
|
* The row id of a record, without any of its content.
|
|
*/
|
|
export interface MinimalRecord {
|
|
id: number
|
|
}
|
|
|
|
export interface ColumnsPost {
|
|
columns: [NewRecordWithStringId, ...NewRecordWithStringId[]]; // at least one column is required
|
|
}
|
|
|
|
export interface ColumnsPatch {
|
|
columns: [RecordWithStringId, ...RecordWithStringId[]]; // at least one column is required
|
|
}
|
|
|
|
/**
|
|
* Creating tables requires a list of columns.
|
|
* `fields` is not accepted because it's not generally sensible to set the metadata fields on new tables.
|
|
*/
|
|
export interface TablePost extends ColumnsPost {
|
|
id?: string;
|
|
}
|
|
|
|
export interface TablesPost {
|
|
tables: [TablePost, ...TablePost[]]; // at least one table is required
|
|
}
|
|
|
|
export interface TablesPatch {
|
|
tables: [RecordWithStringId, ...RecordWithStringId[]]; // at least one table is required
|
|
}
|