2022-02-22 05:37:02 +13:00
|
|
|
const {
|
|
|
|
FieldTypes,
|
|
|
|
RelationshipTypes,
|
|
|
|
FormulaTypes,
|
2023-02-22 06:13:24 +13:00
|
|
|
} = require("../../src/constants")
|
2022-02-23 04:06:08 +13:00
|
|
|
const { object } = require("./utils")
|
|
|
|
const Resource = require("./utils/Resource")
|
2022-02-19 07:06:58 +13:00
|
|
|
|
2022-02-23 04:06:08 +13:00
|
|
|
const table = {
|
|
|
|
_id: "ta_5b1649e42a5b41dea4ef7742a36a7a70",
|
|
|
|
name: "People",
|
|
|
|
schema: {
|
|
|
|
name: {
|
|
|
|
type: "string",
|
|
|
|
name: "name",
|
|
|
|
},
|
|
|
|
age: {
|
|
|
|
type: "number",
|
|
|
|
name: "age",
|
|
|
|
},
|
|
|
|
relationship: {
|
|
|
|
type: "link",
|
|
|
|
name: "relationship",
|
|
|
|
tableId: "ta_...",
|
|
|
|
fieldName: "relatedColumn",
|
|
|
|
relationshipType: "many-to-many",
|
|
|
|
},
|
2022-02-19 06:44:08 +13:00
|
|
|
},
|
|
|
|
}
|
2022-02-19 07:06:58 +13:00
|
|
|
|
2022-02-22 05:37:02 +13:00
|
|
|
const baseColumnDef = {
|
|
|
|
type: {
|
|
|
|
type: "string",
|
|
|
|
enum: Object.values(FieldTypes),
|
|
|
|
description:
|
|
|
|
"Defines the type of the column, most explain themselves, a link column is a relationship.",
|
|
|
|
},
|
|
|
|
constraints: {
|
|
|
|
type: "object",
|
|
|
|
description:
|
|
|
|
"A constraint can be applied to the column which will be validated against when a row is saved.",
|
|
|
|
properties: {
|
|
|
|
type: {
|
|
|
|
type: "string",
|
|
|
|
enum: ["string", "number", "object", "boolean"],
|
|
|
|
},
|
|
|
|
presence: {
|
|
|
|
type: "boolean",
|
|
|
|
description: "Defines whether the column is required or not.",
|
|
|
|
},
|
|
|
|
},
|
|
|
|
},
|
|
|
|
name: {
|
|
|
|
type: "string",
|
|
|
|
description: "The name of the column.",
|
|
|
|
},
|
|
|
|
autocolumn: {
|
|
|
|
type: "boolean",
|
|
|
|
description: "Defines whether the column is automatically generated.",
|
|
|
|
},
|
|
|
|
}
|
|
|
|
|
2022-02-23 04:06:08 +13:00
|
|
|
const tableSchema = {
|
2022-02-19 07:06:58 +13:00
|
|
|
description: "The table to be created/updated.",
|
|
|
|
type: "object",
|
2022-02-25 12:21:10 +13:00
|
|
|
required: ["name", "schema"],
|
2022-02-19 07:06:58 +13:00
|
|
|
properties: {
|
|
|
|
name: {
|
2022-03-02 07:35:08 +13:00
|
|
|
description: "The name of the table.",
|
2022-02-19 07:06:58 +13:00
|
|
|
type: "string",
|
|
|
|
},
|
2022-02-22 05:37:02 +13:00
|
|
|
primaryDisplay: {
|
|
|
|
type: "string",
|
|
|
|
description:
|
|
|
|
"The name of the column which should be used in relationship tags when relating to this table.",
|
|
|
|
},
|
2022-02-19 07:06:58 +13:00
|
|
|
schema: {
|
2022-02-25 12:21:10 +13:00
|
|
|
type: "object",
|
|
|
|
additionalProperties: {
|
|
|
|
oneOf: [
|
|
|
|
// relationship
|
|
|
|
{
|
|
|
|
type: "object",
|
|
|
|
properties: {
|
|
|
|
...baseColumnDef,
|
|
|
|
type: {
|
|
|
|
type: "string",
|
|
|
|
enum: [FieldTypes.LINK],
|
|
|
|
description: "A relationship column.",
|
|
|
|
},
|
|
|
|
fieldName: {
|
|
|
|
type: "string",
|
|
|
|
description:
|
|
|
|
"The name of the column which a relationship column is related to in another table.",
|
|
|
|
},
|
|
|
|
tableId: {
|
|
|
|
type: "string",
|
|
|
|
description:
|
|
|
|
"The ID of the table which a relationship column is related to.",
|
|
|
|
},
|
|
|
|
relationshipType: {
|
|
|
|
type: "string",
|
|
|
|
enum: Object.values(RelationshipTypes),
|
|
|
|
description:
|
|
|
|
"Defines the type of relationship that this column will be used for.",
|
|
|
|
},
|
|
|
|
through: {
|
|
|
|
type: "string",
|
|
|
|
description:
|
|
|
|
"When using a SQL table that contains many to many relationships this defines the table the relationships are linked through.",
|
|
|
|
},
|
|
|
|
foreignKey: {
|
|
|
|
type: "string",
|
|
|
|
description:
|
|
|
|
"When using a SQL table that contains a one to many relationship this defines the foreign key.",
|
|
|
|
},
|
|
|
|
throughFrom: {
|
|
|
|
type: "string",
|
|
|
|
description:
|
|
|
|
"When using a SQL table that utilises a through table, this defines the primary key in the through table for this table.",
|
|
|
|
},
|
|
|
|
throughTo: {
|
|
|
|
type: "string",
|
|
|
|
description:
|
|
|
|
"When using a SQL table that utilises a through table, this defines the primary key in the through table for the related table.",
|
|
|
|
},
|
2022-02-22 05:37:02 +13:00
|
|
|
},
|
2022-02-19 07:06:58 +13:00
|
|
|
},
|
2022-02-25 12:21:10 +13:00
|
|
|
{
|
|
|
|
type: "object",
|
|
|
|
properties: {
|
|
|
|
...baseColumnDef,
|
|
|
|
type: {
|
|
|
|
type: "string",
|
|
|
|
enum: [FieldTypes.FORMULA],
|
|
|
|
description: "A formula column.",
|
|
|
|
},
|
|
|
|
formula: {
|
|
|
|
type: "string",
|
|
|
|
description:
|
|
|
|
"Defines a Handlebars or JavaScript formula to use, note that Javascript formulas are expected to be provided in the base64 format.",
|
|
|
|
},
|
|
|
|
formulaType: {
|
|
|
|
type: "string",
|
|
|
|
enum: Object.values(FormulaTypes),
|
|
|
|
description:
|
|
|
|
"Defines whether this is a static or dynamic formula.",
|
|
|
|
},
|
2022-02-22 05:37:02 +13:00
|
|
|
},
|
|
|
|
},
|
2022-02-25 12:21:10 +13:00
|
|
|
{
|
|
|
|
type: "object",
|
|
|
|
properties: baseColumnDef,
|
|
|
|
},
|
|
|
|
],
|
|
|
|
},
|
2022-02-19 07:06:58 +13:00
|
|
|
},
|
|
|
|
},
|
|
|
|
}
|
2022-02-22 08:04:13 +13:00
|
|
|
|
2022-03-02 07:35:08 +13:00
|
|
|
const tableOutputSchema = {
|
|
|
|
...tableSchema,
|
|
|
|
properties: {
|
|
|
|
...tableSchema.properties,
|
|
|
|
_id: {
|
|
|
|
description: "The ID of the table.",
|
|
|
|
type: "string",
|
|
|
|
},
|
|
|
|
},
|
|
|
|
required: [...tableSchema.required, "_id"],
|
|
|
|
}
|
|
|
|
|
2022-02-23 04:06:08 +13:00
|
|
|
module.exports = new Resource()
|
|
|
|
.setExamples({
|
|
|
|
table: {
|
|
|
|
value: {
|
2022-03-02 03:37:35 +13:00
|
|
|
data: table,
|
2022-02-23 04:06:08 +13:00
|
|
|
},
|
|
|
|
},
|
|
|
|
tables: {
|
|
|
|
value: {
|
2022-03-02 03:37:35 +13:00
|
|
|
data: [table],
|
2022-02-23 04:06:08 +13:00
|
|
|
},
|
|
|
|
},
|
|
|
|
})
|
|
|
|
.setSchemas({
|
|
|
|
table: tableSchema,
|
|
|
|
tableOutput: object({
|
2022-03-02 07:35:08 +13:00
|
|
|
data: tableOutputSchema,
|
2022-02-23 04:06:08 +13:00
|
|
|
}),
|
2022-03-09 06:42:26 +13:00
|
|
|
tableSearch: object({
|
|
|
|
data: {
|
|
|
|
type: "array",
|
|
|
|
items: tableOutputSchema,
|
|
|
|
},
|
|
|
|
}),
|
2022-02-23 04:06:08 +13:00
|
|
|
})
|