@cuboapp/api-backend 1.0.0 → 1.0.2

package/.vscode/settings.json

@@ -0,0 +1,18 @@
+{
+  "editor.minimap.enabled": false,
+  "editor.formatOnSave": true,
+  "editor.codeActionsOnSave": {
+    "source.fixAll.eslint": "explicit",
+    "source.fixAll.stylelint": "explicit",
+    "source.organizeImports": "explicit",
+    "source.organizeExports": "explicit"
+  },
+  "emmet.includeLanguages": {
+    "javascriptreact": "html",
+    "typescriptreact": "html"
+  },
+  "files.exclude": {
+    "node_modules/": true
+  },
+  "typescript.tsdk": "node_modules/typescript/lib"
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cuboapp/api-backend",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "Backend Api for CuboApp",
   "main": "src/index.ts",
   "repository": "git@github.com:cuboapp/api-backend.git",
@@ -12,7 +12,7 @@
   },
   "dependencies": {
     "@cuboapp/config": "^0.0.6",
-    "@cuboapp/types": "^1.0.19",
+    "@cuboapp/types": "^1.0.20",
     "lodash-es": "^4.17.21",
     "pg": "^8.13.3",
     "sequelize": "^6.37.6"

package/pnpm-lock.yaml

@@ -12,8 +12,8 @@ importers:
         specifier: ^0.0.6
         version: 0.0.6
       '@cuboapp/types':
-        specifier: ^1.0.19
-        version: 1.0.19
+        specifier: ^1.0.20
+        version: 1.0.20
       lodash-es:
         specifier: ^4.17.21
         version: 4.17.21
@@ -42,6 +42,9 @@ packages:
   '@cuboapp/types@1.0.19':
     resolution: {integrity: sha512-CZyut9MmCT+5bBBbZF3ETiJnRbgnExvx/+zT/UKj4NxZKlqQAnzX8hWIFMBbed3YoSkbS+cdZcJE26k5mLNPjw==}
 
+  '@cuboapp/types@1.0.20':
+    resolution: {integrity: sha512-PDeJ4GOsVA6OhC1ryd8XwBrnZ7k6mB48GEnMLDdgw3ACRxV2KaWc/5bDrZUdfRjggOAXmwEhX+8rvqfNvp93hg==}
+
   '@types/debug@4.1.12':
     resolution: {integrity: sha512-vIChWdVG3LG1SMxEvI/AK+FWJthlrqlTu7fbrlywTkkaONwk/UAGaULXRlf8vkzFBLVm0zkMdCquhL5aOjhXPQ==}
 
@@ -239,6 +242,10 @@ snapshots:
     dependencies:
       '@types/events': 3.0.3
 
+  '@cuboapp/types@1.0.20':
+    dependencies:
+      '@types/events': 3.0.3
+
   '@types/debug@4.1.12':
     dependencies:
       '@types/ms': 2.1.0

package/src/helpers/convert.ts

@@ -1,16 +1,17 @@
+import { CuboApiEntitiesMap, CuboEntity, CuboEntityField } from '@cuboapp/types'
 import get from 'lodash-es/get'
 import set from 'lodash-es/set'
 import unset from 'lodash-es/unset'
 
-import { CUBO_CRUD_DEFAULT_FIELDS, CUBO_ENTITY_FIELD_TYPE } from '../../constants'
-import { CuboCrudFindQuery, CuboCrudRequest, CuboEntitiesMap, CuboEntityFieldModel, CuboEntityModel } from '../../types'
+import { CUBO_CRUD_DEFAULT_FIELDS, CUBO_ENTITY_FIELD_TYPE } from '../constants'
+import { CuboCrudFindQuery, CuboCrudRequest } from '../types'
 
 import { ApiHelpers } from '.'
 
-export class ApiHelpersConvert<T extends CuboEntitiesMap<T>> {
+export class ApiHelpersConvert<T extends CuboApiEntitiesMap<T>> {
   constructor(public helpers: ApiHelpers<T>) {}
 
-  public async prepareAll(req: CuboCrudRequest, entity: CuboEntityModel, rows: any[], query?: Partial<CuboCrudFindQuery>): Promise<any[]> {
+  public async prepareAll(req: CuboCrudRequest, entity: CuboEntity, rows: any[], query?: Partial<CuboCrudFindQuery>): Promise<any[]> {
     for (const rowKey in rows) {
       rows[rowKey] = await this.prepareOne(req, entity, rows[rowKey], query)
     }
@@ -18,7 +19,7 @@ export class ApiHelpersConvert<T extends CuboEntitiesMap<T>> {
     return rows
   }
 
-  public async prepareOne(req: CuboCrudRequest, entity: CuboEntityModel, row: any, query?: Partial<CuboCrudFindQuery>) {
+  public async prepareOne(req: CuboCrudRequest, entity: CuboEntity, row: any, query?: Partial<CuboCrudFindQuery>) {
     const usersDefaultFields = ['created_by', 'modified_by', 'deleted_by']
 
     const toPrepare: Record<string, any> = {}
@@ -111,7 +112,7 @@ export class ApiHelpersConvert<T extends CuboEntitiesMap<T>> {
     return row
   }
 
-  private prepareFieldValue(field: Pick<CuboEntityFieldModel, 'type_id' | 'alias' | 'extra'>, value: any) {
+  private prepareFieldValue(field: Pick<CuboEntityField, 'type_id' | 'alias' | 'extra'>, value: any) {
     switch (field.type_id) {
       case CUBO_ENTITY_FIELD_TYPE.BOOLEAN:
         return value !== undefined ? (['true', true].includes(value) ? true : false) : null

package/src/helpers/data.ts

@@ -1,15 +1,14 @@
+import { CuboApiEntitiesMap, CuboEntityField } from '@cuboapp/types'
 import keyBy from 'lodash-es/keyBy'
 
-import { CUBO_ENTITY_FIELD_TYPE } from '../../constants'
-import { CuboEntitiesMap, CuboEntityFieldModel } from '../../types'
-import { isDateValid } from '../../utils'
+import { CUBO_ENTITY_FIELD_TYPE } from '../constants'
 
 import { ApiHelpers } from '.'
 
-export class ApiHelpersData<T extends CuboEntitiesMap<T>> {
+export class ApiHelpersData<T extends CuboApiEntitiesMap<T>> {
   constructor(private helpers: ApiHelpers<T>) {}
 
-  public prepare(type: 'create' | 'update' | 'delete', fields: CuboEntityFieldModel[], dto?: any, performer_id?: number) {
+  public prepare(type: 'create' | 'update' | 'delete', fields: CuboEntityField[], dto?: any, performer_id?: number) {
     const fieldsByAlias = keyBy(fields, (i) => i.alias)
 
     const errors: string[] = []
@@ -109,7 +108,7 @@ export class ApiHelpersData<T extends CuboEntitiesMap<T>> {
             {
               if (value === null) {
                 prepared[key] = value
-              } else if (tval !== 'string' || !isDateValid(value)) {
+              } else if (tval !== 'string') {
                 errors.push(`"${key}": value must be a valid date string in format YYYY-MM-DD`)
               } else {
                 prepared[key] = value

package/src/helpers/entities.ts

@@ -1,28 +1,28 @@
-import { CuboEntitiesMap, CuboEntityModel } from '../../types'
+import { CuboApiEntitiesMap, CuboEntity } from '@cuboapp/types'
 
 import { ApiHelpers } from '.'
 
-export class ApiHelpersEntities<T extends CuboEntitiesMap<T>> {
+export class ApiHelpersEntities<T extends CuboApiEntitiesMap<T>> {
   constructor(private helpers: ApiHelpers<T>) {}
 
-  public async getMany(force = false): Promise<CuboEntityModel[]> {
+  public async getMany(force = false): Promise<CuboEntity[]> {
     return (
       this.helpers?.api?.options?.entities ??
       this.helpers.getCached(
         `get_entities`,
-        () => this.helpers.api.apiRequest<{ items: CuboEntityModel[] }>(`/api/v1/entities?with=fields`).then((res) => res.items),
+        () => this.helpers.api.apiRequest<{ items: CuboEntity[] }>(`/api/v1/entities?with=fields`).then((res) => res.items),
         force
       )
     )
   }
 
-  public async getByAlias(alias: keyof T): Promise<CuboEntityModel | undefined> {
+  public async getByAlias(alias: keyof T): Promise<CuboEntity | undefined> {
     const entities = await this.getMany()
 
     return entities.find((e) => e.alias === alias)
   }
 
-  public async getById(id: number): Promise<CuboEntityModel | undefined> {
+  public async getById(id: number): Promise<CuboEntity | undefined> {
     const entities = await this.getMany()
 
     return entities.find((e) => e.id === id)

package/src/helpers/index.ts

@@ -1,9 +1,9 @@
 import { CuboConfigDatabase } from '@cuboapp/config'
+import { CuboApiEntitiesMap, CuboEntityField, CuboEntityFieldExtra } from '@cuboapp/types'
 import { Sequelize, type Options } from 'sequelize'
 
 import { CuboBackendApi } from '../..'
-import { CUBO_CRUD_QUERY_CONDITION, CUBO_CRUD_QUERY_SYMBOL_NOT, CUBO_ENTITY_FIELD_TYPE } from '../../constants'
-import { CuboEntitiesMap, CuboEntityFieldModel, CuboEntityFieldModelExtra } from '../../types'
+import { CUBO_CRUD_QUERY_CONDITION, CUBO_CRUD_QUERY_SYMBOL_NOT, CUBO_ENTITY_FIELD_TYPE } from '../constants'
 
 import { ApiHelpersConvert } from './convert'
 import { ApiHelpersData } from './data'
@@ -12,7 +12,7 @@ import { ApiHelpersQuery } from './query'
 import { ApiHelpersUsers } from './users'
 import { ApiHelpersWithes } from './withes'
 
-export class ApiHelpers<T extends CuboEntitiesMap<T>> {
+export class ApiHelpers<T extends CuboApiEntitiesMap<T>> {
   constructor(public api: CuboBackendApi<T>) {}
 
   public withes = new ApiHelpersWithes<T>(this)
@@ -49,10 +49,7 @@ export class ApiHelpers<T extends CuboEntitiesMap<T>> {
     return this.fetching[alias]
   }
 
-  public clearFieldConditionValue(
-    field: CuboEntityFieldModel | { type_id: number; alias: string; extra: CuboEntityFieldModelExtra },
-    value: any
-  ) {
+  public clearFieldConditionValue(field: CuboEntityField | { type_id: number; alias: string; extra?: CuboEntityFieldExtra }, value: any) {
     const type = typeof value
 
     const parts = `${value}`.split(':')
@@ -121,7 +118,8 @@ export class ApiHelpers<T extends CuboEntitiesMap<T>> {
         }
         break
       case CUBO_ENTITY_FIELD_TYPE.NUMBER:
-        const precision = field.extra?.number_precision || 0
+        // const precision = field.extra?.number_precision || 0
+        const precision = 0
 
         switch (type) {
           case 'object':
@@ -284,8 +282,6 @@ export class ApiHelpers<T extends CuboEntitiesMap<T>> {
     }
 
     this.connecting[cacheKey] = new Promise(async (success) => {
-      const { storage } = this.api.account
-
       let database: string = ''
       let host: string = ''
       let port: number = 0
@@ -294,37 +290,28 @@ export class ApiHelpers<T extends CuboEntitiesMap<T>> {
       let schema: string = ''
       let dialect: string = ''
 
-      if (storage?.database) {
-        database = storage?.database
-        host = storage?.[type]?.host
-        port = storage?.[type]?.port
-        username = storage?.[type]?.username
-        password = storage?.[type]?.password
-        schema = storage?.[type]?.schema
-      } else {
-        if (!this.api.config.db) {
-          throw 'DB connection is not configured'
-        }
+      if (!this.api.config.db) {
+        throw 'DB connection is not configured'
+      }
 
-        const dbConfig = this.api.config.db as any
-        let cfg: CuboConfigDatabase = {} as any
-        if (dbConfig) {
-          if (dbConfig[type]) {
-            cfg = dbConfig[type]
-          } else {
-            cfg = dbConfig as CuboConfigDatabase
-          }
+      const dbConfig = this.api.config.db as any
+      let cfg: CuboConfigDatabase = {} as any
+      if (dbConfig) {
+        if (dbConfig[type]) {
+          cfg = dbConfig[type]
+        } else {
+          cfg = dbConfig as CuboConfigDatabase
         }
-
-        database = cfg.database as string
-        host = cfg.host as string
-        port = cfg.port as number
-        username = cfg.username as string
-        password = cfg.password as string
-        schema = cfg.schema as string
-        dialect = cfg.dialect as string
       }
 
+      database = cfg.database as string
+      host = cfg.host as string
+      port = cfg.port as number
+      username = cfg.username as string
+      password = cfg.password as string
+      schema = cfg.schema as string
+      dialect = cfg.dialect as string
+
       if (!schema) {
         schema = `account_${this.api.account.id}`
       }

package/src/helpers/query.ts

@@ -1,15 +1,17 @@
-import { CUBO_CRUD_DEFAULT_FIELDS, CUBO_CRUD_DEFAULT_PAGE_LIMIT, CUBO_CRUD_MAX_PAGE_LIMIT, CUBO_CRUD_QUERY_KEY_REGEX } from '../../constants'
-import { CuboCrudFindQuery, CuboCrudRequest, CuboEntitiesMap, CuboEntityModel } from '../../types'
-import { dbPrepareUpdateQueryString } from '../../utils'
+import { CuboApiEntitiesMap, CuboEntity } from '@cuboapp/types'
+
+import { CUBO_CRUD_DEFAULT_FIELDS, CUBO_CRUD_DEFAULT_PAGE_LIMIT, CUBO_CRUD_MAX_PAGE_LIMIT, CUBO_CRUD_QUERY_KEY_REGEX } from '../constants'
+import { CuboCrudFindQuery, CuboCrudRequest } from '../types'
+import { dbPrepareUpdateQueryString } from '../utils'
 
 import { ApiHelpers } from '.'
 
-export class ApiHelpersQuery<T extends CuboEntitiesMap<T>> {
+export class ApiHelpersQuery<T extends CuboApiEntitiesMap<T>> {
   constructor(private helpers: ApiHelpers<T>) {}
 
   public async createFindQuery(
     req: CuboCrudRequest,
-    entity: CuboEntityModel,
+    entity: CuboEntity,
     queryDto?: Partial<CuboCrudFindQuery>,
     isCount?: boolean
   ): Promise<Partial<CuboCrudFindQuery>> {
@@ -133,7 +135,7 @@ export class ApiHelpersQuery<T extends CuboEntitiesMap<T>> {
     }
   }
 
-  public async createUpdateQuery(req: CuboCrudRequest, entity: CuboEntityModel, queryDto?: Partial<CuboCrudFindQuery>) {
+  public async createUpdateQuery(req: CuboCrudRequest, entity: CuboEntity, queryDto?: Partial<CuboCrudFindQuery>) {
     const dto = await this.helpers.data.prepare('update', entity.fields, req.body)
 
     if (!Object.keys(dto)) {

package/src/helpers/users.ts

@@ -1,18 +1,17 @@
+import { CuboApiEntitiesMap, CuboUser } from '@cuboapp/types'
 import keyBy from 'lodash-es/keyBy'
 
-import { CuboEntitiesMap, CuboUserModel } from '../../types'
-
 import { ApiHelpers } from '.'
 
-export class ApiHelpersUsers<T extends CuboEntitiesMap<T>> {
+export class ApiHelpersUsers<T extends CuboApiEntitiesMap<T>> {
   constructor(private helpers: ApiHelpers<T>) {}
 
-  public async getMany(force = false): Promise<CuboUserModel[]> {
+  public async getMany(force = false): Promise<CuboUser[]> {
     const users = await this.helpers.getCached(
       `users`,
       async () => {
         return this.helpers.api
-          .apiRequest<{ items: CuboUserModel[] }>(`/api/v1/users?account_id=${this.helpers.api.account.id}`)
+          .apiRequest<{ items: CuboUser[] }>(`/api/v1/users?account_id=${this.helpers.api.account.id}`)
           .then((res) => res.items)
       },
       force
@@ -26,12 +25,12 @@ export class ApiHelpersUsers<T extends CuboEntitiesMap<T>> {
     return this.helpers.getCached(`users_by_id`, async () => keyBy(users, (i) => +i.id), force)
   }
 
-  public async getByEmail(email: string): Promise<CuboUserModel | undefined> {
+  public async getByEmail(email: string): Promise<CuboUser | undefined> {
     const entities = await this.getMany()
     return entities.find((e) => e.email === email)
   }
 
-  public async getById(id: number): Promise<CuboUserModel | undefined> {
+  public async getById(id: number): Promise<CuboUser | undefined> {
     const entities = await this.getManyById()
     return entities[id]
   }

package/src/helpers/withes.ts

@@ -1,25 +1,17 @@
+import { CuboApiEntitiesMap, CuboApiEntityDefaultUsersKeys, CuboEntity, CuboEntityField } from '@cuboapp/types'
 import cloneDeep from 'lodash-es/cloneDeep'
 
-import { CUBO_CRUD_DEFAULT_FIELDS, CUBO_CRUD_QUERY_KEY_REGEX } from '../../constants'
-import {
-  CuboCrudFindQuery,
-  CuboCrudMethodOptions,
-  CuboCrudRequest,
-  CuboCrudWith,
-  CuboEntitiesMap,
-  CuboEntityDefaultUsersKeys,
-  CuboEntityFieldModel,
-  CuboEntityModel
-} from '../../types'
+import { CUBO_CRUD_DEFAULT_FIELDS, CUBO_CRUD_QUERY_KEY_REGEX } from '../constants'
+import { CuboCrudFindQuery, CuboCrudMethodOptions, CuboCrudRequest, CuboCrudWith } from '../types'
 
 import { ApiHelpers } from '.'
 
-export class ApiHelpersWithes<T extends CuboEntitiesMap<T>> {
+export class ApiHelpersWithes<T extends CuboApiEntitiesMap<T>> {
   constructor(private helpers: ApiHelpers<T>) {}
 
   private async getKeyWithes(
     key: string,
-    entity: CuboEntityModel,
+    entity: CuboEntity,
     withes: CuboCrudWith[],
     opts: {
       replacements?: Record<string, any>
@@ -52,10 +44,10 @@ export class ApiHelpersWithes<T extends CuboEntitiesMap<T>> {
 
     const needSorts = opts.sorts !== undefined && Array.isArray(opts.sorts)
 
-    const parts = normalKey.split('.') as (keyof T | CuboEntityDefaultUsersKeys)[]
+    const parts = normalKey.split('.') as (keyof T | CuboApiEntityDefaultUsersKeys)[]
 
     const currentKey: string[] = []
-    let lastEntity: CuboEntityModel | undefined = entity
+    let lastEntity: CuboEntity | undefined = entity
     let joinIndex = (opts.joins.length || 0) + 1
     let joinAlias = 0
 
@@ -68,7 +60,7 @@ export class ApiHelpersWithes<T extends CuboEntitiesMap<T>> {
       const partKey = currentKey.join('.')
       const tableName = currentKey.join('_')
 
-      const joinCustomField: CuboEntityFieldModel | undefined = lastEntity?.fields?.find((f) => f.extra?.select_entity_key === part)
+      const joinCustomField: CuboEntityField | undefined = lastEntity?.fields?.find((f) => f.extra?.select_entity_key === part)
       const joinDefaultField = CUBO_CRUD_DEFAULT_FIELDS.find((f) => f.extra?.select_entity_key === part)
 
       const ex = withes.find((i) => i.key === partKey)
@@ -221,7 +213,7 @@ export class ApiHelpersWithes<T extends CuboEntitiesMap<T>> {
     return ret
   }
 
-  public async prepare(req: CuboCrudRequest, entity: CuboEntityModel, opts?: CuboCrudMethodOptions): Promise<Partial<CuboCrudFindQuery>> {
+  public async prepare(req: CuboCrudRequest, entity: CuboEntity, opts?: CuboCrudMethodOptions): Promise<Partial<CuboCrudFindQuery>> {
     const { with: __withes, sort: _sort, limit: _limit, ...other } = req.query || {}
 
     const _withes = (__withes || '').split(',').filter((i: string) => i !== '')