Filters & Graph QL

Author: Frantz Kati

.github/workflows/tests.yml

@@ -2,7 +2,7 @@ require('dotenv').config()
 const { auth } = require('@tensei/auth')
 const { graphql } = require('@tensei/graphql')
 const { trixPlugin: trix } = require('@tensei/trix')
-const { cashier, plan } = require('@tensei/cashier')
+// const { cashier, plan } = require('@tensei/cashier')
 const { AmazonWebServicesS3Storage } = require('@slynova/flydrive-s3')
 const { tensei, dashboard, valueMetric, plugin } = require('@tensei/core')
 
@@ -115,4 +115,5 @@ module.exports = tensei()
     .databaseConfig({
         type: 'mysql',
         dbName: 'mikrotensei',
+        debug: true
     })

.gitignore

@@ -1,8 +1,16 @@
-const { text, textarea, resource, belongsTo } = require('@tensei/core')
+const { text, textarea, resource, belongsTo, filter } = require('@tensei/core')
 
 module.exports = resource('Comment').fields([
     text('Title').rules('required').searchable(),
     textarea('Body').rules('required').hideOnIndex(),
     textarea('Reply').rules('required', 'max:255').hideOnIndex(),
     belongsTo('Post'),
+]).filters([
+    filter('Comments on Post')
+        .dashboardView()
+        .query((args) => ({
+            post: {
+                id: args.id
+            }
+        })),
 ])

.prettierignore

@@ -90,8 +90,8 @@ module.exports = resource('Post')
                 },
                 {
                     label: 'Mangojs',
-                    value: 'mangojs'
-                }
+                    value: 'mangojs',
+                },
             ])
             .rules('required')
             .searchable()
@@ -106,7 +106,7 @@ module.exports = resource('Post')
             .rules('required', 'date')
             .format('do MMM yyyy, hh:mm a')
             .hideOnIndex(),
-        belongsToMany('Tag'),
+        belongsToMany('Tag').owner(),
         hasMany('Comment'),
     ])
     .perPageOptions([25, 50, 100])

.prettierrc

@@ -30,6 +30,7 @@ const postBuilder = build('Post', {
         category: fake((f) =>
             f.random.arrayElement(['angular', 'javascript', 'mysql', 'pg'])
         ),
+        slug: fake((f) => `${f.lorem.slug()}-${Date.now()}`),
         published_at: fake((f) => f.date.past()),
         scheduled_for: fake((f) => f.date.future()),
         // created_at: fake((f) => f.date.recent(f.random.number())),
@@ -46,9 +47,9 @@ const tagsBuilder = build('Tag', {
 
 const commentsBuilder = build('Comment', {
     fields: {
-        post_id: sequence(),
         title: fake((f) => f.lorem.sentence()),
-        body: fake((f) => f.lorem.paragraph(2)),
+        body: fake((f) => f.lorem.sentence()),
+        reply: fake((f) => f.lorem.sentence()),
         // created_at: fake((f) => f.date.recent(f.random.number())),
     },
 })
@@ -65,7 +66,7 @@ const posts = Array(1000)
     .fill(undefined)
     .map(() => postBuilder())
 
-const users = Array(1000)
+const users = Array(10)
     .fill(undefined)
     .map(() => userBuilder())
 
@@ -126,31 +127,70 @@ async function seedMongo(resources, connection) {
 
 require('./app')
     .register()
-    .then(async ({ getDatabaseClient, config }) => {
-        if (config.database === 'mongodb') {
-            seedMongo(config.resources, getDatabaseClient())
+    .then(
+        async ({
+            config: {
+                orm: { em },
+            },
+        }) => {
+            const userObjects = users.map((user) => em.create('User', user))
+
+            await em.persistAndFlush(userObjects)
+
+            const savedUsers = await em.find('User')
+
+            for (let index = 0; index < savedUsers.length; index++) {
+                const user = savedUsers[index]
+
+                const posts = Array(10)
+                    .fill(undefined)
+                    .map(() => em.create('Post', postBuilder()))
+                    .map((post) => {
+                        post.user = user
+
+                        return post
+                    })
+
+                await em.persistAndFlush(posts)
+            }
+
+            const savedPosts = await em.find('Post')
 
+            for (let index = 0; index < savedPosts.length; index++) {
+                const post = savedPosts[index]
+
+                const comments = Array(10)
+                    .fill(undefined)
+                    .map(() => em.create('Comment', commentsBuilder()))
+                    .map((comment) => {
+                        comment.post = post
+
+                        return comment
+                    })
+
+                await em.persistAndFlush(comments)
+            }
+
+            // console.log(savedUsers)
             return
-        }
 
-        const knex = getDatabaseClient()
-
-        await Promise.all([
-            knex('posts').truncate(),
-            knex('users').truncate(),
-            knex('tags').truncate(),
-            knex('comments').truncate(),
-            knex('administrators').truncate(),
-        ])
-
-        await Promise.all([
-            knex('posts').insert(posts),
-            knex('users').insert(users),
-            knex('tags').insert(tags),
-            knex('comments').insert(comments),
-            knex('administrators').insert(administrators),
-            knex('posts_tags').insert(posts_tags),
-        ])
-
-        await knex.destroy()
-    })
+            await Promise.all([
+                knex('posts').truncate(),
+                knex('users').truncate(),
+                knex('tags').truncate(),
+                knex('comments').truncate(),
+                knex('administrators').truncate(),
+            ])
+
+            await Promise.all([
+                knex('posts').insert(posts),
+                knex('users').insert(users),
+                knex('tags').insert(tags),
+                knex('comments').insert(comments),
+                knex('administrators').insert(administrators),
+                knex('posts_tags').insert(posts_tags),
+            ])
+
+            await knex.destroy()
+        }
+    )

README.md

@@ -49,7 +49,7 @@ export class Field implements FieldContract {
     public property: FieldProperty = {
         name: '',
         type: 'string',
-        primary: false,
+        primary: false
         // nullable: true
     }
 

commitlint.config.js

@@ -1,12 +1,16 @@
-import { pascalCase, camelCase } from 'change-case'
+import Pluralize from 'pluralize'
 import { ReferenceType } from '@mikro-orm/core'
+import { pascalCase, camelCase } from 'change-case'
 import RelationshipField from './RelationshipField'
 
 // This would be hasMany in other relationship language.
 export class OneToMany extends RelationshipField {
     public component = 'OneToManyField'
 
-    public constructor(name: string, databaseField = camelCase(name)) {
+    public constructor(
+        name: string,
+        databaseField = Pluralize(camelCase(name))
+    ) {
         super(name, databaseField)
 
         this.relatedProperty.type = pascalCase(name)
@@ -16,6 +20,7 @@ export class OneToMany extends RelationshipField {
 
 export const oneToMany = (name: string, databaseField?: string) =>
     new OneToMany(name, databaseField)
+
 export const hasMany = oneToMany
 
 export default oneToMany

examples/.DS_Store

@@ -0,0 +1,49 @@
+import { camelCase } from 'change-case'
+import { FilterQuery, Dictionary } from '@mikro-orm/core'
+import { FilterCondition, FilterConfig, FilterContract } from '@tensei/common/filters'
+
+export class Filter<T = any> implements FilterContract {
+    public config: FilterConfig<T> = {
+        name: '',
+        shortName: '',
+        default: false,
+        dashboardView: false,
+        cond: () => ({})
+    }
+
+    constructor(name: string, shortName = camelCase(name)) {
+        this.config.name = name
+        this.config.shortName = shortName
+    }
+
+    query(condition: FilterCondition<T>) {
+        this.config.cond = condition
+
+        return this
+    }
+
+    dashboardView() {
+        this.config.dashboardView = true
+
+        return this
+    }
+
+    noArgs() {
+        this.config.args = false
+
+        return this
+    }
+
+    default() {
+        this.config.default = true
+
+        return this
+    }
+}
+
+export function filter<T = any>(name: string, shortName?: string) {
+    return new Filter<T>(
+        name,
+        shortName
+    )
+}

examples/blog/.gitignore

@@ -20,6 +20,8 @@ export { oneToMany, OneToMany, hasMany } from './fields/OneToMany'
 export { manyToOne, ManyToOne, belongsTo } from './fields/ManyToOne'
 export { manyToMany, ManyToMany, belongsToMany } from './fields/ManyToMany'
 
+export { filter } from './filters/Filter'
+
 export { ResourceHelpers } from './helpers'
 export { Manager } from './resources/Manager'
 export { card, Card } from './dashboard/Card'

examples/blog/.prettierrc

@@ -5,13 +5,15 @@ import {
     ResourceData,
     HookFunction,
     FieldContract,
+    FilterContract,
     ResourceContract,
     AuthorizeFunction,
     ValidationMessages,
-    SerializedResource
+    SerializedResource,
 } from '@tensei/common'
 
 import Pluralize from 'pluralize'
+// import { FilterContract } from '@tensei/filters'
 import { snakeCase, paramCase, camelCase, pascalCase } from 'change-case'
 
 interface ResourceDataWithFields extends ResourceData {
@@ -81,21 +83,28 @@ export class Resource<ResourceType = {}> implements ResourceContract {
         this.data.camelCaseName = camelCase(name)
         this.data.pascalCaseName = pascalCase(name)
         this.data.slug = Pluralize(paramCase(name))
-        this.data.camelCaseNamePlural = Pluralize(camelCase(name))
         this.data.table = tableName || Pluralize(snakeCase(name))
+        this.data.camelCaseNamePlural = Pluralize(camelCase(name))
     }
 
     public Model = (): any => {
         return null
     }
 
+    public filters(filters: FilterContract[]) {
+        this.data.filters = filters
+
+        return this
+    }
+
     public data: ResourceDataWithFields = {
         fields: [],
         actions: [],
         table: '',
         name: '',
         slug: '',
         label: '',
+        filters: [],
         hideFromApi: false,
         permissions: [],
         group: 'Resources',

examples/blog/app.js

@@ -4,5 +4,6 @@ declare module '@tensei/common' {
     export * from '@tensei/common/actions'
     export * from '@tensei/common/resources'
     export * from '@tensei/common/plugins'
+    export * from '@tensei/common/filters'
     export * from '@tensei/common/dashboards'
 }

examples/blog/index.js

@@ -111,6 +111,7 @@ declare module '@tensei/common/config' {
     }
     export interface Config {
         databaseClient: any
+        schemas: any
         serverUrl: string
         clientUrl: string
         plugins: PluginContract[]

examples/blog/mon.js

@@ -1,5 +1,6 @@
 import { Request } from 'express'
 import { Mail } from '@tensei/mail'
+import { MikroORM, EntityManager } from '@mikro-orm/core'
 import { StorageManager } from '@slynova/flydrive'
 import {
     User,
@@ -13,10 +14,6 @@ import {
 declare global {
     namespace Express {
         export interface Request {
-            manager: (
-                resourceSlugOrResource: string | ResourceContract,
-                request?: Request
-            ) => ManagerContract
             resources: {
                 [key: string]: ResourceContract
             }
@@ -26,6 +23,8 @@ declare global {
             mailer: Mail
             config: Config
             admin?: User
+            orm: MikroORM
+            manager: EntityManager
             scripts: Asset[]
             styles: Asset[]
             originatedFromDashboard: boolean | undefined

examples/blog/nodemon.json

@@ -0,0 +1,24 @@
+declare module '@tensei/common/filters' {
+    import { FilterQuery, Dictionary } from '@mikro-orm/core';
+
+    interface FilterConfig<T> {
+        name: string;
+        shortName: string;
+        args?: boolean;
+        default: boolean;
+        dashboardView?: boolean;
+        cond: FilterCondition<T>;
+    }
+
+    type FilterCondition<T = any> = (args: Dictionary, type: 'read' | 'update' | 'delete') => FilterQuery<any> | Promise<FilterQuery<T>>;
+
+    export interface FilterContract<T = any> {
+        config: FilterConfig<T>;
+        query(condition: FilterCondition<T>): this;
+        dashboardView(): this;
+        noArgs(): this;
+        default(): this;
+    }
+
+    export function filter<T = any>(name: string, slug?: string): FilterContract<T>;
+}

examples/blog/package.json

@@ -4,6 +4,7 @@
 /// <reference path="fields.d.ts" />
 /// <reference path="resources.d.ts" />
 /// <reference path="common.d.ts" />
+/// <reference path="filters.d.ts" />
 /// <reference path="express.d.ts" />
 /// <reference path="tensei.d.ts" />
 /// <reference path="dashboards.d.ts" />