@drax/crud-back 3.18.0 → 3.20.0

package/src/crud-saved-query/models/CrudSavedQueryModel.ts

@@ -0,0 +1,54 @@
+import {mongoose} from "@drax/common-back";
+import type {PaginateModel} from "mongoose";
+import mongoosePaginate from "mongoose-paginate-v2";
+import type {ICrudSavedQuery} from "../interfaces/ICrudSavedQuery";
+
+const FieldFilterSchema = new mongoose.Schema({
+    field: {type: String, required: true},
+    operator: {type: String, required: false, default: "eq"},
+    value: {type: mongoose.Schema.Types.Mixed, required: false},
+    orGroup: {type: String, required: false}
+}, {_id: false});
+
+const DynamicFilterSchema = new mongoose.Schema({
+    default: {type: mongoose.Schema.Types.Mixed, required: false},
+    label: {type: String, required: false},
+    name: {type: String, required: true},
+    operator: {type: String, required: false, default: "eq"},
+    type: {type: String, required: false, default: "string"},
+    permission: {type: String, required: false},
+    value: {type: mongoose.Schema.Types.Mixed, required: false},
+    ref: {type: String, required: false},
+    refDisplay: {type: String, required: false},
+    enum: {type: [mongoose.Schema.Types.Mixed], required: false}
+}, {_id: false, strict: false});
+
+const CrudSavedQuerySchema = new mongoose.Schema<ICrudSavedQuery>({
+    entity: {type: String, required: true, index: true},
+    name: {type: String, required: true, index: true},
+    shared: {type: Boolean, required: false, default: false, index: true},
+    columns: [{type: String, required: true}],
+    staticFilters: {type: [FieldFilterSchema], required: false, default: []},
+    dynamicFilters: {type: [DynamicFilterSchema], required: false, default: []},
+    tenant: {type: mongoose.Schema.Types.ObjectId, ref: "Tenant", required: false, index: true},
+    user: {type: mongoose.Schema.Types.ObjectId, ref: "User", required: false, index: true}
+}, {timestamps: true});
+
+CrudSavedQuerySchema.index({entity: 1, name: 1, tenant: 1, user: 1});
+CrudSavedQuerySchema.plugin(mongoosePaginate);
+
+CrudSavedQuerySchema.virtual("id").get(function () {
+    return this._id.toString();
+});
+
+CrudSavedQuerySchema.set("toJSON", {getters: true, virtuals: true});
+CrudSavedQuerySchema.set("toObject", {getters: true, virtuals: true});
+
+const CrudSavedQueryModel = mongoose.model<ICrudSavedQuery, PaginateModel<ICrudSavedQuery>>(
+    "CrudSavedQuery",
+    CrudSavedQuerySchema,
+    "CrudSavedQuery"
+);
+
+export {CrudSavedQuerySchema, CrudSavedQueryModel};
+export default CrudSavedQueryModel;

package/src/crud-saved-query/permissions/CrudSavedQueryPermissions.ts

@@ -0,0 +1,10 @@
+enum CrudSavedQueryPermissions {
+    Create = "crudSavedQuery:create",
+    Update = "crudSavedQuery:update",
+    Delete = "crudSavedQuery:delete",
+    View = "crudSavedQuery:view",
+    Manage = "crudSavedQuery:manage",
+}
+
+export {CrudSavedQueryPermissions};
+export default CrudSavedQueryPermissions;

package/src/crud-saved-query/repository/mongo/CrudSavedQueryMongoRepository.ts

@@ -0,0 +1,19 @@
+import AbstractMongoRepository from "../../../repository/AbstractMongoRepository.js";
+import {CrudSavedQueryModel} from "../../models/CrudSavedQueryModel.js";
+import type {ICrudSavedQueryRepository} from "../../interfaces/ICrudSavedQueryRepository";
+import type {ICrudSavedQuery, ICrudSavedQueryBase} from "../../interfaces/ICrudSavedQuery";
+
+class CrudSavedQueryMongoRepository
+    extends AbstractMongoRepository<ICrudSavedQuery, ICrudSavedQueryBase, ICrudSavedQueryBase>
+    implements ICrudSavedQueryRepository {
+
+    constructor() {
+        super();
+        this._model = CrudSavedQueryModel;
+        this._searchFields = ["name", "entity"];
+        this._populateFields = ["tenant", "user"];
+    }
+}
+
+export default CrudSavedQueryMongoRepository;
+export {CrudSavedQueryMongoRepository};

package/src/crud-saved-query/repository/sqlite/CrudSavedQuerySqliteRepository.ts

@@ -0,0 +1,34 @@
+import AbstractSqliteRepository from "../../../repository/AbstractSqliteRepository.js";
+import type {ICrudSavedQueryRepository} from "../../interfaces/ICrudSavedQueryRepository";
+import type {ICrudSavedQuery, ICrudSavedQueryBase} from "../../interfaces/ICrudSavedQuery";
+import {SqliteTableField} from "@drax/common-back";
+
+class CrudSavedQuerySqliteRepository
+    extends AbstractSqliteRepository<ICrudSavedQuery, ICrudSavedQueryBase, ICrudSavedQueryBase>
+    implements ICrudSavedQueryRepository {
+
+    protected tableName: string = "CrudSavedQuery";
+    protected searchFields: string[] = ["name", "entity"];
+    protected booleanFields: string[] = ["shared"];
+    protected jsonFields: string[] = ["columns", "staticFilters", "dynamicFilters"];
+    protected identifier: string = "_id";
+    protected populateFields = [
+        {field: "tenant", table: "Tenant", identifier: "_id"},
+        {field: "user", table: "User", identifier: "_id"}
+    ];
+    protected tableFields: SqliteTableField[] = [
+        {name: "entity", type: "TEXT", unique: false, primary: false},
+        {name: "name", type: "TEXT", unique: false, primary: false},
+        {name: "shared", type: "INTEGER", unique: false, primary: false},
+        {name: "columns", type: "TEXT", unique: false, primary: false},
+        {name: "staticFilters", type: "TEXT", unique: false, primary: false},
+        {name: "dynamicFilters", type: "TEXT", unique: false, primary: false},
+        {name: "tenant", type: "TEXT", unique: false, primary: false},
+        {name: "user", type: "TEXT", unique: false, primary: false},
+        {name: "createdAt", type: "TEXT", unique: false, primary: false},
+        {name: "updatedAt", type: "TEXT", unique: false, primary: false}
+    ];
+}
+
+export default CrudSavedQuerySqliteRepository;
+export {CrudSavedQuerySqliteRepository};

package/src/crud-saved-query/routes/CrudSavedQueryRoutes.ts

@@ -0,0 +1,31 @@
+import CrudSavedQueryController from "../controllers/CrudSavedQueryController.js";
+import {CrudSchemaBuilder} from "../../builders/CrudSchemaBuilder.js";
+import {CrudSavedQuerySchema, CrudSavedQueryBaseSchema} from "../schemas/CrudSavedQuerySchema.js";
+
+async function CrudSavedQueryFastifyRoutes(fastify, options) {
+    const controller = new CrudSavedQueryController();
+    const schemas = new CrudSchemaBuilder(
+        CrudSavedQuerySchema,
+        CrudSavedQueryBaseSchema,
+        CrudSavedQueryBaseSchema,
+        "CrudSavedQuery",
+        "openapi-3.0",
+        ["crud-saved-queries"]
+    );
+
+    fastify.get("/api/crud-saved-queries", {schema: schemas.paginateSchema}, (req, rep) => controller.paginate(req, rep));
+    fastify.get("/api/crud-saved-queries/find", {schema: schemas.findSchema}, (req, rep) => controller.find(req, rep));
+    fastify.get("/api/crud-saved-queries/search", {schema: schemas.searchSchema}, (req, rep) => controller.search(req, rep));
+    fastify.get("/api/crud-saved-queries/:id", {schema: schemas.findByIdSchema}, (req, rep) => controller.findById(req, rep));
+    fastify.get("/api/crud-saved-queries/find-one", {schema: schemas.findOneSchema}, (req, rep) => controller.findOne(req, rep));
+    fastify.get("/api/crud-saved-queries/find-by/:field/:value", {schema: schemas.findBySchema}, (req, rep) => controller.findBy(req, rep));
+    fastify.get("/api/crud-saved-queries/find-one-by/:field/:value", {schema: schemas.findOneBySchema}, (req, rep) => controller.findOneBy(req, rep));
+
+    fastify.post("/api/crud-saved-queries", {schema: schemas.createSchema}, (req, rep) => controller.create(req, rep));
+    fastify.put("/api/crud-saved-queries/:id", {schema: schemas.updateSchema}, (req, rep) => controller.update(req, rep));
+    fastify.patch("/api/crud-saved-queries/:id", {schema: schemas.updateSchema}, (req, rep) => controller.updatePartial(req, rep));
+    fastify.delete("/api/crud-saved-queries/:id", {schema: schemas.deleteSchema}, (req, rep) => controller.delete(req, rep));
+}
+
+export default CrudSavedQueryFastifyRoutes;
+export {CrudSavedQueryFastifyRoutes};

package/src/crud-saved-query/schemas/CrudSavedQuerySchema.ts

@@ -0,0 +1,41 @@
+import {z} from "zod";
+
+const CrudSavedQueryFieldFilterSchema = z.object({
+    field: z.string().min(1, "validation.required"),
+    operator: z.string().optional().default("eq"),
+    value: z.any().optional().nullable(),
+    orGroup: z.string().optional()
+});
+
+const CrudSavedQueryDynamicFilterSchema = z.object({
+    default: z.any().optional().nullable(),
+    label: z.string().optional(),
+    name: z.string().min(1, "validation.required"),
+    operator: z.string().optional().default("eq"),
+    type: z.string().optional().default("string"),
+    permission: z.string().optional(),
+    value: z.any().optional().nullable(),
+    ref: z.string().optional(),
+    refDisplay: z.string().optional(),
+    enum: z.array(z.any()).optional()
+}).catchall(z.any());
+
+const CrudSavedQueryBaseSchema = z.object({
+    entity: z.string().min(1, "validation.required"),
+    name: z.string().min(1, "validation.required"),
+    shared: z.boolean().optional().default(false),
+    columns: z.array(z.string()).optional().default([]),
+    staticFilters: z.array(CrudSavedQueryFieldFilterSchema).optional().default([]),
+    dynamicFilters: z.array(CrudSavedQueryDynamicFilterSchema).optional().default([]),
+    tenant: z.coerce.string().optional().nullable(),
+    user: z.coerce.string().optional().nullable()
+});
+
+const CrudSavedQuerySchema = CrudSavedQueryBaseSchema.extend({
+    _id: z.coerce.string(),
+    tenant: z.object({_id: z.coerce.string(), name: z.string()}).nullable().optional(),
+    user: z.object({_id: z.coerce.string(), username: z.string()}).nullable().optional()
+});
+
+export default CrudSavedQuerySchema;
+export {CrudSavedQuerySchema, CrudSavedQueryBaseSchema};

package/src/crud-saved-query/services/CrudSavedQueryService.ts

@@ -0,0 +1,13 @@
+import AbstractService from "../../services/AbstractService.js";
+import type {ZodObject, ZodRawShape} from "zod";
+import type {ICrudSavedQueryRepository} from "../interfaces/ICrudSavedQueryRepository";
+import type {ICrudSavedQuery, ICrudSavedQueryBase} from "../interfaces/ICrudSavedQuery";
+
+class CrudSavedQueryService extends AbstractService<ICrudSavedQuery, ICrudSavedQueryBase, ICrudSavedQueryBase> {
+    constructor(repository: ICrudSavedQueryRepository, baseSchema?: ZodObject<ZodRawShape>, fullSchema?: ZodObject<ZodRawShape>) {
+        super(repository, baseSchema, fullSchema);
+    }
+}
+
+export default CrudSavedQueryService;
+export {CrudSavedQueryService};

package/src/index.ts

@@ -18,6 +18,15 @@ import {ExportBodyResponseSchema} from "./schemas/ExportBodyResponseSchema.js"
 import {ErrorBodyResponseSchema, ValidationErrorBodyResponseSchema} from "./schemas/ErrorBodyResponseSchema.js"
 import {CrudSchemaBuilder} from "./builders/CrudSchemaBuilder.js";
 
+import CrudSavedQueryFastifyRoutes from "./crud-saved-query/routes/CrudSavedQueryRoutes.js";
+import {CrudSavedQueryController} from "./crud-saved-query/controllers/CrudSavedQueryController.js";
+import {CrudSavedQueryService} from "./crud-saved-query/services/CrudSavedQueryService.js";
+import {CrudSavedQueryServiceFactory} from "./crud-saved-query/factory/services/CrudSavedQueryServiceFactory.js";
+import CrudSavedQueryMongoRepository from "./crud-saved-query/repository/mongo/CrudSavedQueryMongoRepository.js";
+import CrudSavedQuerySqliteRepository from "./crud-saved-query/repository/sqlite/CrudSavedQuerySqliteRepository.js";
+import CrudSavedQueryPermissions from "./crud-saved-query/permissions/CrudSavedQueryPermissions.js";
+import {CrudSavedQueryModel, CrudSavedQuerySchema} from "./crud-saved-query/models/CrudSavedQueryModel.js";
+
 export type {
     CustomRequest
 }
@@ -50,5 +59,15 @@ export {
     //Builder
     CrudSchemaBuilder,
 
+    //Crud saved queries
+    CrudSavedQueryFastifyRoutes,
+    CrudSavedQueryController,
+    CrudSavedQueryService,
+    CrudSavedQueryServiceFactory,
+    CrudSavedQueryMongoRepository,
+    CrudSavedQuerySqliteRepository,
+    CrudSavedQueryPermissions,
+    CrudSavedQueryModel,
+    CrudSavedQuerySchema,
 
 }