Folder structure changed

Author: incetarik

CHANGELOG.md

@@ -3,11 +3,21 @@ This file contains the changes made to the package.
 
 The sections are in descending order of the change date.
 
-## [0.1.15]: - 2022-08-20
+## [0.1.16] - 2022-08-21
+### Added
+- Basic pluralization for reverse table names if one of the links in navigation
+is an array. This will be default and used if not set by the developer.
+
+### Changed
+- The structure of the folders.
+- `mappers` for custom names for cross table references are not used anymore and
+planned to be removed in the following versions.
+
+## [0.1.15] - 2022-08-20
 ### Fixed
 - `Array.map` error during `*:1` relation mapping.
 
-## [0.1.14]: - 2022-08-16
+## [0.1.14] - 2022-08-16
 ### Fixed
 - Prisma Selections for deeply nested objects were not working correctly.
 
@@ -42,6 +52,7 @@ object.
 The initial version of the package.
 
 [Unreleased]: https://github.com/incetarik/nestjs-prisma-dynamic-resolvers/compare/v1.0.0...HEAD
+[0.1.16]: https://github.com/incetarik/nestjs-prisma-dynamic-resolvers/compare/0.1.15...0.1.16
 [0.1.15]: https://github.com/incetarik/nestjs-prisma-dynamic-resolvers/compare/0.1.14...0.1.15
 [0.1.14]: https://github.com/incetarik/nestjs-prisma-dynamic-resolvers/compare/0.1.13...0.1.14
 [0.1.13]: https://github.com/incetarik/nestjs-prisma-dynamic-resolvers/compare/0.1.9...0.1.13

src/dynamic-navigations.ts

@@ -22,10 +22,10 @@ export interface INavigationMap {
   /**
    * The prototype of the source class.
    *
-   * @type {Object}
+   * @type {Function}
    * @memberof INavigationMap
    */
-  source: Object
+  source: Function
 
   /**
    * The target type constructor.

src/dynamic-resolver/dynamic-resolver-base.ts

@@ -0,0 +1,106 @@
+import { GraphQLResolveInfo } from 'graphql'
+
+import { getNavigationMaps, INavigationMap } from '../dynamic-navigations'
+import {
+  extractGraphQLSelectionPath,
+  extractGraphQLSelections,
+  toCamelCase,
+  updatePathInfoFromSchema,
+} from '../helpers'
+
+import type { Dictionary } from '../types'
+
+export abstract class DynamicResolverBase {
+  constructor(protected readonly prisma: any) {}
+
+  protected getSelectionObject(info: GraphQLResolveInfo, selectionMap?: Dictionary<string>) {
+    const select = extractGraphQLSelections({
+      node: info.fieldNodes[ 0 ],
+      selectionMap,
+    })
+
+    return select
+  }
+
+  protected getSelectionPath(info: GraphQLResolveInfo, selectionMap?: Dictionary<string>) {
+    const selectionPath = extractGraphQLSelectionPath({
+      path: info.path,
+    })
+
+    const pathInfoList = selectionPath
+    pathInfoList.forEach(pathInfo => {
+      if (pathInfo.table) return
+
+      const tableName = toCamelCase(pathInfo.tableName)
+      const maps = getNavigationMaps()
+        .filter(it => it.sourceTableName === tableName)
+
+      pathInfo.table = maps[ 0 ]?.source
+      pathInfo.navigationMaps = maps
+
+      updatePathInfoFromSchema(pathInfo, info.schema)
+    })
+
+    const query = pathInfoList[ 0 ]
+
+    if (pathInfoList.length < 3) {
+      throw new Error(`The navigation source could not be extracted in (${query.propertyName})`)
+    }
+
+    const firstLink = pathInfoList[ 1 ]
+
+    if (!firstLink.table) {
+      throw new Error(`The navigation target could not be extracted in (${query.propertyName}): '${firstLink.propertyName}' → ?`)
+    }
+
+    const secondLink = pathInfoList[ 2 ]
+
+    if (!secondLink.table) {
+      throw new Error(`The navigation target could not be extracted in (${query.propertyName}): ${firstLink.propertyName} → ${secondLink.propertyName}' → ?`)
+    }
+
+    const sourceTableName
+      = selectionMap?.[ firstLink.propertyName ]
+      ?? toCamelCase(firstLink.table.name)
+
+    const source = this.prisma[ sourceTableName ]
+    if (!source) {
+      throw new Error(`Unrecognized Prisma model: "${sourceTableName}". Failed to build resolver for navigation: '${sourceTableName} → ${secondLink.propertyName}'`)
+    }
+
+    return {
+      to: secondLink,
+      root: query,
+      from: firstLink,
+      source,
+      selectionPath,
+    }
+  }
+
+  protected resolve(parent: any, _primaryKeyName: string, _info: GraphQLResolveInfo, navigationMap: INavigationMap, _selectionMap?: Dictionary<string>) {
+    const {
+      relation,
+      sourceProperty,
+      sourceTableName,
+      targetTableName,
+    } = navigationMap
+
+    const [ _left, right ] = relation.split(':')
+    const isArray = right.indexOf('*') >= 0
+
+    // The `parent` is the loaded instance
+    // If the source we are looking for is loaded, then process it.
+    if (sourceProperty in parent) {
+      const data = (parent as any)[ sourceProperty ]
+      if (isArray) {
+        return data.map((it: any) => it[ targetTableName ])
+      }
+      else {
+        return data
+      }
+    }
+    else {
+      throw new Error(`Could not resolve from ${sourceTableName}: ${sourceProperty}`)
+    }
+  }
+}

src/dynamic-resolver/dynamic-resolver-ops.ts

@@ -0,0 +1,145 @@
+import type { Type } from "@nestjs/common"
+import type { IOnResolvedParams, IOnResolvingParams } from "./event-params.interface"
+
+/**
+ * An interface containing parameters for {@link UseDynamicResolvers} decorator.
+ *
+ * @export
+ * @interface IUseDynamicResolversParams
+ */
+export interface IUseDynamicResolversParams {
+  /**
+   * The name of the module that will contain the resolver.
+   *
+   * This name is used for grouping the resolvers and then the grouped resolvers
+   * can be acquired through {@link NavigationProperty.getDynamicResolvers}.
+   *
+   * If the name is not given, then they will be registered as global.
+   *
+   * @type {string}
+   * @memberof IUseDynamicResolversParams
+   */
+  moduleName?: string
+
+  /**
+   * The name of the database table.
+   *
+   * This will be used for generating `select` / `include` clauses.
+   *
+   * @type {string}
+   * @memberof IUseDynamicResolversParams
+   */
+  tableName?: string
+
+  /**
+   * The name of the property that is used as ID property of the database table.
+   *
+   * @type {string}
+   * @memberof IUseDynamicResolversParams
+   * @default 'id
+   */
+  primaryKeyName?: string
+
+  /**
+   * Indicates if the generated navigation map should be kept as metadata of the
+   * target type.
+   * 
+   * Set this property to `true` to keep the navigation map and use
+   * {@link getNavigationMapsOf} function to get the navigation map of the type.
+   *
+   * @type {boolean}
+   * @memberof IUseDynamicResolversParams
+   * @default false
+   */
+  keepNavigationMap?: boolean
+
+  /**
+   * An event function that will be triggered when the resolver is about to resolve the defined navigation.
+   *
+   * @param {IOnResolvingParams<P>} params The parameters.
+   * @return {*} The
+   * replace value.
+   * 
+   * If this function returns a value from this event function, then the
+   * resolving will be cancelled and the data returned from this function will 
+   * be used as the result of resolving.
+   * 
+   * @memberof IUseDynamicResolversParams
+   */
+  onResolving?<P extends object = object, TRoot extends object = object>(params: IOnResolvingParams<P, TRoot>): any
+
+  /**
+   * An event function that will be triggered when the resolved is resolved the defined navigation.
+   *
+   * @param {IOnResolvedParams<any, P>} params The parameters.
+   * @return {*} The
+   * replace value.
+   * 
+   * If this function returns a value from this event function, then the
+   * resolving will be ignored and the data returned from this function will be
+   * used as the result of the resolving.
+   * 
+   * @memberof IUseDynamicResolversParams
+   */
+  onResolved?<P extends object = object, TRoot extends object = object>(params: IOnResolvedParams<any, P, TRoot>): any
+}
+
+export interface IRegisterDynamicResolverParams extends IUseDynamicResolversParams {
+  /**
+   * The target class that uses the dynamic resolvers.
+   *
+   * @type {Type}
+   * @memberof IUseDynamicResolversParams
+   */
+  target: Type
+}
+
+let _resolverParams: IRegisterDynamicResolverParams[] | undefined
+
+/**
+ * Registers a type as dynamic resolver.
+ *
+ * @export
+ * @param {IUseDynamicResolversParams} params The parameters.
+ */
+export function registerDynamicResolver(params: IRegisterDynamicResolverParams) {
+  _resolverParams ??= []
+  _resolverParams.push(params)
+}
+
+/**
+ * Gets the resolvers that are created dynamically.
+ *
+ * @export
+ * @param {string} [groupName='_global'] The name of the group.
+ * @return {Type[]} An array of resolver classes of the group.
+ */
+export function getDynamicResolverParams(groupName = '_global') {
+  if (!_resolverParams) return []
+  return _resolverParams.filter(it => it.moduleName === groupName)
+}
+
+/**
+ * Removes the dynamic resolver parameters of a group.
+ *
+ * @export
+ * @param {string} groupName The name of the groups.
+ * @return {boolean} A boolean indicating the operation state. If `false`, then
+ * nothing is done.
+ */
+export function removeDynamicResolverParamsOfGroup(groupName: string) {
+  if (!_resolverParams) return false
+
+  for (let i = _resolverParams.length - 1; i >= 0; --i) {
+    const item = _resolverParams[ i ]
+    if (item.moduleName === groupName) {
+      _resolverParams.splice(i, 1)
+    }
+  }
+
+  if (_resolverParams.length === 0) {
+    _resolverParams = undefined
+  }
+
+  return true
+}

src/dynamic-resolver/event-params.interface.ts

@@ -0,0 +1,57 @@
+import type { GraphQLExecutionContext } from "@nestjs/graphql"
+import type { GraphQLResolveInfo } from "graphql"
+
+export interface IOnResolvingParams<P extends object = object, TRoot extends object = object> {
+  /**
+   * The parent object.
+   *
+   * @type {P}
+   * @memberof IOnResolvingParams
+   */
+  readonly parent: P
+
+  /**
+   * The graphql resolve info.
+   *
+   * @type {GraphQLResolveInfo}
+   * @memberof IOnResolvingParams
+   */
+  readonly resolveInfo: GraphQLResolveInfo
+
+  /**
+   * The execution context.
+   *
+   * @type {GraphQLExecutionContext}
+   * @memberof IOnResolvingParams
+   */
+  readonly context: GraphQLExecutionContext
+
+  /**
+   * The root object.
+   *
+   * @type {TRoot}
+   * @memberof IOnResolvingParams
+   */
+  readonly root: TRoot
+}
+
+export interface IOnResolvedParams<R = any, P extends object = object, TRoot extends object = object> extends IOnResolvingParams<P, TRoot> {
+  /**
+   * The data resolved by the resolver.
+   *
+   * @type {R}
+   * @memberof IOnResolvedParams
+   */
+  data: R
+
+  /**
+   * Indicates if the {@link data} is resolved from the database or not.
+   * 
+   * This property will be `false` if the {@link data} is got from the
+   * {@link IUseDynamicResolversParams.onResolving} method.
+   *
+   * @type {boolean}
+   * @memberof IOnResolvedParams
+   */
+  readonly fromDatabase: boolean
+}