namirasoft-field-node 1.3.4

package/src/controller/entity_field/Get.ts

@@ -0,0 +1,51 @@
+import { HTTPMethod, ObjectService } from "namirasoft-core";
+import { BaseEntityFieldController } from "../BaseEntityFieldController";
+import { EntityFieldModel } from "../../database/model/EntityFieldModel";
+import { StringSchema, BaseVariableSchema } from "namirasoft-schema";
+
+export class Get extends BaseEntityFieldController<EntityFieldModel>
+{
+	override getInfo()
+	{
+		return {
+			name: "Get",
+			tag: "Field",
+			method: HTTPMethod.GET,
+			path: "/field/{id}",
+			summary: "Returns an field by id."
+		};
+	}
+	override async getParametersSchema()
+	{
+		return [new BaseVariableSchema("id", new StringSchema(true))];
+	}
+	override async getQueriesSchema()
+	{
+		return [];
+	}
+	override async getBodySchema()
+	{
+		return null;
+	}
+	override async getOutputSchema()
+	{
+		return this.tables.entity_field.getSchemaByName(true);
+	}
+	override async getState()
+	{
+		return {
+			check_auth: true,
+			auth_optional: false
+		};
+	}
+	override async handle()
+	{
+		let session = await this.props.getSession();
+		let user_id = session.user_id;
+
+		let id = new ObjectService(this.req.params.id).getString();
+
+		let ans = await this.tables.entity_field.get(user_id, id, null);
+		return await this.tables.entity_field.secure(ans);
+	}
+}

package/src/controller/entity_field/List.ts

@@ -0,0 +1,50 @@
+import { HTTPMethod } from "namirasoft-core";
+import { BaseEntityFieldController } from "../BaseEntityFieldController";
+import { EntityFieldModel } from "../../database/model/EntityFieldModel";
+import { NSControllerList } from "namirasoft-site-node";
+
+export class List extends BaseEntityFieldController<{ rows: EntityFieldModel[], count: number }>
+{
+	override getInfo()
+	{
+		return {
+			name: "List",
+			tag: "Field",
+			method: HTTPMethod.GET,
+			path: "/field/list",
+			summary: "Returns all fields."
+		};
+	}
+	override async getParametersSchema()
+	{
+		return [];
+	}
+	override async getQueriesSchema()
+	{
+		return NSControllerList.getQueriesSchema();
+	}
+	override async getBodySchema()
+	{
+		return null;
+	}
+	override async getOutputSchema()
+	{
+		return NSControllerList.getOutputSchema(this.tables.entity_field.getArraySchemaByName(true));
+	}
+	override async getState()
+	{
+		return {
+			check_auth: true,
+			auth_optional: false
+		};
+	}
+	override async handle()
+	{
+		let session = await this.props.getSession();
+		let user_id = session.user_id;
+
+		let { filters, page, size } = NSControllerList.handle_GetQueries(this.req);
+
+		return await this.tables.entity_field.list({ user_id }, filters, page, size, {}, null);
+	}
+}

package/src/controller/entity_field/Update.ts

@@ -0,0 +1,57 @@
+import { HTTPMethod, ObjectService } from "namirasoft-core";
+import { BaseEntityFieldController } from "../BaseEntityFieldController";
+import { StringSchema, BaseVariableSchema } from "namirasoft-schema";
+import { EntityFieldNames } from "../../enum/EntityFieldNames";
+export class Update extends BaseEntityFieldController<string>
+{
+	override getInfo()
+	{
+		return {
+			name: "Update",
+			tag: "Field",
+			method: HTTPMethod.PUT,
+			path: "/field/{id}",
+			summary: "Updates an field"
+		};
+	}
+	override async getParametersSchema()
+	{
+		return [new BaseVariableSchema("id", new StringSchema(true))];
+	}
+	override async getQueriesSchema()
+	{
+		return [];
+	}
+	override async getBodySchema()
+	{
+		return this.tables.entity_field.getSchemaByName(true, EntityFieldNames.EntityFieldInput);
+	}
+	override async getOutputSchema()
+	{
+		return this.tables.entity_field.getSchemaByName(true);
+	}
+	override async getState()
+	{
+		return {
+			check_auth: true,
+			auth_optional: false
+		};
+	}
+	override async handle()
+	{
+		let session = await this.props.getSession();
+
+		let id = new ObjectService(this.req.params.id).getString();
+
+		let field_id = new ObjectService(this.req.body.field_id).getString();
+		let value = new ObjectService(this.req.body.value).getString();
+		let description = new ObjectService(this.req.body.description).getString();
+
+		let ans = await this.tables.entity_field.update(session, id,
+			field_id,
+			value,
+			description,
+			null);
+		return await this.tables.entity_field.secure(ans);
+	}
+}

package/src/controller/entity_tag/Create.ts

@@ -0,0 +1,55 @@
+import { HTTPMethod, ObjectService } from "namirasoft-core";
+import { BaseEntityFieldController } from "../BaseEntityFieldController";
+import { EntityTagModel } from "../../database/model/EntityTagModel";
+import { EntityTagNames } from "../../enum/EntityTagNames";
+export class Create extends BaseEntityFieldController<EntityTagModel>
+{
+	override getInfo()
+	{
+		return {
+			name: "Create",
+			tag: "Tag",
+			method: HTTPMethod.POST,
+			path: "/tag",
+			summary: "Creates a new tag"
+		};
+	}
+	override async getParametersSchema()
+	{
+		return [];
+	}
+	override async getQueriesSchema()
+	{
+		return [];
+	}
+	override async getBodySchema()
+	{
+		return this.tables.entity_tag.getSchemaByName(true, EntityTagNames.EntityTagInput);
+	}
+	override async getOutputSchema()
+	{
+		return this.tables.entity_tag.getSchemaByName(true);
+	}
+	override async getState()
+	{
+		return {
+			check_auth: true,
+			auth_optional: false
+		};
+	}
+	override async handle()
+	{
+		let session = await this.props.getSession();
+
+		let name = new ObjectService(this.req.body.name).getString();
+		let value = new ObjectService(this.req.body.value).getString();
+		let description = new ObjectService(this.req.body.description).getString();
+
+		let ans = await this.tables.entity_tag.create(session,
+			name,
+			value,
+			description,
+			null);
+		return await this.tables.entity_tag.secure(ans);
+	}
+}

package/src/controller/entity_tag/Delete.ts

@@ -0,0 +1,48 @@
+import { HTTPMethod, ObjectService } from "namirasoft-core";
+import { BaseEntityFieldController } from "../BaseEntityFieldController";
+import { StringSchema, BaseVariableSchema } from "namirasoft-schema";
+
+export class Delete extends BaseEntityFieldController<void>
+{
+	override getInfo()
+	{
+		return {
+			name: "Delete",
+			tag: "Tag",
+			method: HTTPMethod.DELETE,
+			path: "/tag/{id}",
+			summary: "Deletes an tag by id."
+		};
+	}
+	override async getParametersSchema()
+	{
+		return [new BaseVariableSchema("id", new StringSchema(true))];
+	}
+	override async getQueriesSchema()
+	{
+		return [];
+	}
+	override async getBodySchema()
+	{
+		return null;
+	}
+	override async getOutputSchema()
+	{
+		return null;
+	}
+	override async getState()
+	{
+		return {
+			check_auth: true,
+			auth_optional: false
+		};
+	}
+	override async handle()
+	{
+		let session = await this.props.getSession();
+
+		let id = new ObjectService(this.req.params.id).getString();
+
+		await this.tables.entity_tag.delete(session, id, null);
+	}
+}

package/src/controller/entity_tag/Get.ts

@@ -0,0 +1,51 @@
+import { HTTPMethod, ObjectService } from "namirasoft-core";
+import { BaseEntityFieldController } from "../BaseEntityFieldController";
+import { EntityTagModel } from "../../database/model/EntityTagModel";
+import { StringSchema, BaseVariableSchema } from "namirasoft-schema";
+
+export class Get extends BaseEntityFieldController<EntityTagModel>
+{
+	override getInfo()
+	{
+		return {
+			name: "Get",
+			tag: "Tag",
+			method: HTTPMethod.GET,
+			path: "/tag/{id}",
+			summary: "Returns an tag by id."
+		};
+	}
+	override async getParametersSchema()
+	{
+		return [new BaseVariableSchema("id", new StringSchema(true))];
+	}
+	override async getQueriesSchema()
+	{
+		return [];
+	}
+	override async getBodySchema()
+	{
+		return null;
+	}
+	override async getOutputSchema()
+	{
+		return this.tables.entity_tag.getSchemaByName(true);
+	}
+	override async getState()
+	{
+		return {
+			check_auth: true,
+			auth_optional: false
+		};
+	}
+	override async handle()
+	{
+		let session = await this.props.getSession();
+		let user_id = session.user_id;
+
+		let id = new ObjectService(this.req.params.id).getString();
+
+		let ans = await this.tables.entity_tag.get(user_id, id, null);
+		return await this.tables.entity_tag.secure(ans);
+	}
+}

package/src/controller/entity_tag/List.ts

@@ -0,0 +1,50 @@
+import { HTTPMethod } from "namirasoft-core";
+import { BaseEntityFieldController } from "../BaseEntityFieldController";
+import { EntityTagModel } from "../../database/model/EntityTagModel";
+import { NSControllerList } from "namirasoft-site-node";
+
+export class List extends BaseEntityFieldController<{ rows: EntityTagModel[], count: number }>
+{
+	override getInfo()
+	{
+		return {
+			name: "List",
+			tag: "Tag",
+			method: HTTPMethod.GET,
+			path: "/tag/list",
+			summary: "Returns all tags."
+		};
+	}
+	override async getParametersSchema()
+	{
+		return [];
+	}
+	override async getQueriesSchema()
+	{
+		return NSControllerList.getQueriesSchema();
+	}
+	override async getBodySchema()
+	{
+		return null;
+	}
+	override async getOutputSchema()
+	{
+		return NSControllerList.getOutputSchema(this.tables.entity_tag.getArraySchemaByName(true));
+	}
+	override async getState()
+	{
+		return {
+			check_auth: true,
+			auth_optional: false
+		};
+	}
+	override async handle()
+	{
+		let session = await this.props.getSession();
+		let user_id = session.user_id;
+
+		let { filters, page, size } = NSControllerList.handle_GetQueries(this.req);
+
+		return await this.tables.entity_tag.list({ user_id }, filters, page, size, {}, null);
+	}
+}

package/src/controller/entity_tag/Update.ts

@@ -0,0 +1,57 @@
+import { HTTPMethod, ObjectService } from "namirasoft-core";
+import { BaseEntityFieldController } from "../BaseEntityFieldController";
+import { StringSchema, BaseVariableSchema } from "namirasoft-schema";
+import { EntityTagNames } from "../../enum/EntityTagNames";
+export class Update extends BaseEntityFieldController<string>
+{
+	override getInfo()
+	{
+		return {
+			name: "Update",
+			tag: "Tag",
+			method: HTTPMethod.PUT,
+			path: "/tag/{id}",
+			summary: "Updates a tag"
+		};
+	}
+	override async getParametersSchema()
+	{
+		return [new BaseVariableSchema("id", new StringSchema(true))];
+	}
+	override async getQueriesSchema()
+	{
+		return [];
+	}
+	override async getBodySchema()
+	{
+		return this.tables.entity_tag.getSchemaByName(true, EntityTagNames.EntityTagInput);
+	}
+	override async getOutputSchema()
+	{
+		return this.tables.entity_tag.getSchemaByName(true);
+	}
+	override async getState()
+	{
+		return {
+			check_auth: true,
+			auth_optional: false
+		};
+	}
+	override async handle()
+	{
+		let session = await this.props.getSession();
+
+		let id = new ObjectService(this.req.params.id).getString();
+
+		let name = new ObjectService(this.req.body.name).getString();
+		let value = new ObjectService(this.req.body.value).getString();
+		let description = new ObjectService(this.req.body.description).getString();
+
+		let ans = await this.tables.entity_tag.update(session, id,
+			name,
+			value,
+			description,
+			null);
+		return await this.tables.entity_tag.secure(ans);
+	}
+}

package/src/database/DatabaseTables.ts

@@ -0,0 +1,40 @@
+import { BaseMySqlDatabase, BaseSequelizeModel } from "namirasoft-node-mysql";
+import { EntityCategoryTable } from "./table/EntityCategoryTable";
+import { EntityFieldTable } from "./table/EntityFieldTable";
+import { EntityTagTable } from "./table/EntityTagTable";
+import { NSABaseApplication } from "namirasoft-account-node";
+import { EntityTagAttributes } from "./attributes/EntityTagAttributes";
+import { EntityFieldAttributes } from "./attributes/EntityFieldAttributes";
+import { EntityCategoryAttributes } from "./attributes/EntityCategoryAttributes";
+import { ModelCtor } from 'sequelize';
+
+export class DatabaseTables<Database extends BaseMySqlDatabase>
+{
+    entity_category: EntityCategoryTable<Database>;
+    entity_field: EntityFieldTable<Database>;
+    entity_tag: EntityTagTable<Database>;
+    constructor(app: NSABaseApplication<Database>, database: Database)
+    {
+        this.entity_category = new EntityCategoryTable<Database>(app, database);
+        this.entity_field = new EntityFieldTable<Database>(app, database);
+        this.entity_tag = new EntityTagTable<Database>(app, database);
+    }
+    init<M extends BaseSequelizeModel>(model: ModelCtor<M>)
+    {
+        let name = model.name;
+        this.entity_category.define(name + "_category", EntityCategoryAttributes);
+        this.entity_field.define(name + "_field", EntityFieldAttributes);
+        this.entity_tag.define(name + "_tag", EntityTagAttributes);
+
+        // set foreignKeys
+        this.entity_tag.model.belongsTo(model, {
+            foreignKey: { name: "entity_id", allowNull: false },
+        });
+        this.entity_field.model.belongsTo(model, {
+            foreignKey: { name: "entity_id", allowNull: false },
+        });
+        this.entity_category.model.belongsTo(model, {
+            foreignKey: { name: "entity_id", allowNull: false },
+        });
+    }
+}

package/src/database/attributes/EntityCategoryAttributes.ts

@@ -0,0 +1,12 @@
+import { DataTypes, Attributes, ModelAttributes } from "sequelize";
+import { EntityCategoryModel } from "../model/EntityCategoryModel";
+
+export let EntityCategoryAttributes: ModelAttributes<
+	EntityCategoryModel,
+	Attributes<EntityCategoryModel>
+> = {
+	id: { type: DataTypes.INTEGER, allowNull: false, primaryKey: true, autoIncrement: true },
+	user_id: { type: DataTypes.CHAR(20), allowNull: false },
+	entity_id: { type: DataTypes.CHAR(20), allowNull: false },
+	category_id: { type: DataTypes.CHAR(20), allowNull: false }
+};

package/src/database/attributes/EntityFieldAttributes.ts

@@ -0,0 +1,14 @@
+import { DataTypes, Attributes, ModelAttributes } from "sequelize";
+import { EntityFieldModel } from "../model/EntityFieldModel";
+
+export let EntityFieldAttributes: ModelAttributes<
+	EntityFieldModel,
+	Attributes<EntityFieldModel>
+> = {
+	id: { type: DataTypes.INTEGER, allowNull: false, primaryKey: true, autoIncrement: true },
+	user_id: { type: DataTypes.CHAR(20), allowNull: false },
+	entity_id: { type: DataTypes.CHAR(20), allowNull: false },
+	field_id: { type: DataTypes.CHAR(20), allowNull: false },
+	value: { type: DataTypes.TEXT, allowNull: false },
+	description: { type: DataTypes.TEXT, allowNull: false },
+};

package/src/database/attributes/EntityTagAttributes.ts

@@ -0,0 +1,14 @@
+import { DataTypes, Attributes, ModelAttributes } from "sequelize";
+import { EntityTagModel } from "../model/EntityTagModel";
+
+export let EntityTagAttributes: ModelAttributes<
+	EntityTagModel,
+	Attributes<EntityTagModel>
+> = {
+	id: { type: DataTypes.INTEGER, allowNull: false, primaryKey: true, autoIncrement: true },
+	user_id: { type: DataTypes.CHAR(20), allowNull: false },
+	entity_id: { type: DataTypes.CHAR(20), allowNull: false },
+	name: { type: DataTypes.STRING, allowNull: false },
+	value: { type: DataTypes.TEXT, allowNull: false },
+	description: { type: DataTypes.TEXT, allowNull: false }
+};

package/src/database/model/EntityCategoryModel.ts

@@ -0,0 +1,9 @@
+import { BaseSequelizeModel } from "namirasoft-node-mysql";
+
+export class EntityCategoryModel extends BaseSequelizeModel
+{
+	id!: number;
+	user_id!: string;
+	entity_id!: string;
+	category_id!: string;
+};

package/src/database/model/EntityFieldModel.ts

@@ -0,0 +1,11 @@
+import { BaseSequelizeModel } from "namirasoft-node-mysql";
+
+export class EntityFieldModel extends BaseSequelizeModel
+{
+	id!: number;
+	user_id!: string;
+	entity_id!: string;
+	field_id!: string;
+	value!: string;
+	description!: string;
+}

package/src/database/model/EntityTagModel.ts

@@ -0,0 +1,11 @@
+import { BaseSequelizeModel } from "namirasoft-node-mysql";
+
+export class EntityTagModel extends BaseSequelizeModel
+{
+	id!: number;
+	user_id!: string;
+	entity_id!: string;
+	name!: string;
+	value!: string;
+	description!: string;
+}

package/src/database/table/EntityCategoryTable.ts

@@ -0,0 +1,63 @@
+import { BaseMySqlDatabase, BaseSequelizeTable } from "namirasoft-node-mysql";
+import { Transaction } from "sequelize";
+import { EntityCategoryModel } from "../model/EntityCategoryModel";
+import { ObjectSchema } from "namirasoft-schema";
+import { SessionRow } from "namirasoft-account";
+import { EntityCategoryNames } from "../../enum/EntityCategoryNames";
+import { NSABaseApplication } from "namirasoft-account-node";
+
+export class EntityCategoryTable<Database extends BaseMySqlDatabase> extends BaseSequelizeTable<Database, EntityCategoryModel>
+{
+    public app: NSABaseApplication<Database>;
+    constructor(app: NSABaseApplication<Database>, database: Database)
+    {
+        super(database);
+        this.app = app;
+    }
+    override getReadOnlyColumns()
+    {
+        return ["id", "user_id", "entity_id"];
+    }
+    override getSchemaNames(): string[]
+    {
+        return Object.keys(EntityCategoryNames);
+    }
+    protected override setSchemaByName(schema: ObjectSchema): void
+    {
+        schema.delReadOnly(true);
+    }
+    async get(user_id: string, id: string, trx: Transaction | null): Promise<EntityCategoryModel | null>
+    {
+        return await this.find({ where: { user_id, id }, }, trx);
+    }
+    async create(session: SessionRow, category_id: string, trx: Transaction | null): Promise<EntityCategoryModel>
+    {
+        return this.app.onHistoryCreate(this, session, async () =>
+        {
+            return await this.model.create({
+                user_id: session.user_id,
+                category_id,
+            }, { transaction: trx });
+        });
+    }
+    async update(session: SessionRow, id: string, category_id: string, trx: Transaction | null): Promise<EntityCategoryModel>
+    {
+        return await this.app.onHistoryUpdate(this, session, async () =>
+        {
+            return await this.find({ where: { user_id: session.user_id, id } }, trx);
+        }, async (item) =>
+        {
+            item.category_id = category_id;
+            return await item.save({ transaction: trx });
+        });
+    }
+    async delete(session: SessionRow, id: string, trx: Transaction | null): Promise<void>
+    {
+        await this.app.onHistoryDelete(this, session, async () =>
+        {
+            let item = await this.find({ where: { user_id: session.user_id, id } }, trx);
+            await item.destroy({ transaction: trx });
+            return item;
+        });
+    }
+}

package/src/database/table/EntityFieldTable.ts

@@ -0,0 +1,67 @@
+import { BaseMySqlDatabase, BaseSequelizeTable } from "namirasoft-node-mysql";
+import { Transaction } from "sequelize";
+import { EntityFieldModel } from "../model/EntityFieldModel";
+import { ObjectSchema } from "namirasoft-schema";
+import { SessionRow } from "namirasoft-account";
+import { EntityFieldNames } from "../../enum/EntityFieldNames";
+import { NSABaseApplication } from "namirasoft-account-node";
+
+export class EntityFieldTable<Database extends BaseMySqlDatabase> extends BaseSequelizeTable<Database, EntityFieldModel>
+{
+    public app: NSABaseApplication<Database>;
+    constructor(app: NSABaseApplication<Database>, database: Database)
+    {
+        super(database);
+        this.app = app;
+    }
+    override getReadOnlyColumns()
+    {
+        return ["id", "user_id", "entity_id"];
+    }
+    override getSchemaNames(): string[]
+    {
+        return Object.keys(EntityFieldNames);
+    }
+    protected override setSchemaByName(schema: ObjectSchema): void
+    {
+        schema.delReadOnly(true);
+    }
+    async get(user_id: string, id: string, trx: Transaction | null): Promise<EntityFieldModel | null>
+    {
+        return await this.find({ where: { user_id, id }, }, trx);
+    }
+    async create(session: SessionRow, field_id: string, value: string, description: string, trx: Transaction | null): Promise<EntityFieldModel>
+    {
+        return this.app.onHistoryCreate(this, session, async () =>
+        {
+            return await this.model.create({
+                user_id: session.user_id,
+                field_id,
+                value,
+                description,
+            }, { transaction: trx });
+        });
+    }
+    async update(session: SessionRow, id: string, field_id: string, value: string, description: string, trx: Transaction | null): Promise<EntityFieldModel>
+    {
+        return await this.app.onHistoryUpdate(this, session, async () =>
+        {
+            return await this.find({ where: { user_id: session.user_id, id } }, trx);
+        }, async (item) =>
+        {
+            item.field_id = field_id;
+            item.value = value;
+            item.description = description;
+            return await item.save({ transaction: trx });
+        });
+    }
+    async delete(session: SessionRow, id: string, trx: Transaction | null): Promise<void>
+    {
+        await this.app.onHistoryDelete(this, session, async () =>
+        {
+            let item = await this.find({ where: { user_id: session.user_id, id } }, trx);
+            await item.destroy({ transaction: trx });
+            return item;
+        });
+    }
+}