feat(rest): Created rest package

examples/project.json

@@ -6,20 +6,34 @@
   "targets": {
     "lint": {
       "executor": "@nx/eslint:lint",
-      "outputs": ["{options.outputFile}"],
+      "outputs": [
+        "{options.outputFile}"
+      ],
       "options": {
-        "lintFilePatterns": ["examples/**/*.ts"]
+        "lintFilePatterns": [
+          "examples/**/*.ts"
+        ]
       }
     },
     "e2e": {
       "executor": "@nx/jest:jest",
-      "outputs": ["{workspaceRoot}/coverage/examples"],
+      "outputs": [
+        "{workspaceRoot}/coverage/examples"
+      ],
       "options": {
         "jestConfig": "jest.e2e.ts",
         "runInBand": true
       }
     }
   },
   "tags": [],
-  "implicitDependencies": ["core", "query-graphql", "query-mongoose", "query-sequelize", "query-typegoose", "query-typeorm"]
+  "implicitDependencies": [
+    "core",
+    "query-graphql",
+    "query-mongoose",
+    "query-sequelize",
+    "query-typegoose",
+    "query-typeorm",
+    "query-rest"
+  ]
 }

jest.preset.js

@@ -19,7 +19,8 @@ module.exports = {
     '@ptc-org/nestjs-query-typeorm': process.cwd() + '/packages/query-typeorm/src',
     '@ptc-org/nestjs-query-sequelize': process.cwd() + '/packages/query-sequelize/src',
     '@ptc-org/nestjs-query-typegoose': process.cwd() + '/packages/query-typegoose/src',
-    '@ptc-org/nestjs-query-mongoose': process.cwd() + '/packages/query-mongoose/src'
+    '@ptc-org/nestjs-query-mongoose': process.cwd() + '/packages/query-mongoose/src',
+    '@ptc-org/nestjs-query-rest': process.cwd() + '/packages/query-rest/src'
   },
   testEnvironment: 'node',
   setupFilesAfterEnv: ['jest-extended'],

package.json

@@ -22,6 +22,7 @@
     "@nestjs/passport": "10.0.2",
     "@nestjs/platform-express": "10.2.7",
     "@nestjs/sequelize": "10.0.0",
+    "@nestjs/swagger": "^7.1.15",
     "@nestjs/typeorm": "^10.0.0",
     "class-validator": "0.14.0",
     "clsx": "^2.0.0",

packages/query-rest/.babelrc

@@ -0,0 +1,10 @@
+{
+  "presets": [
+    [
+      "@nrwl/web/babel",
+      {
+        "useBuiltIns": "usage"
+      }
+    ]
+  ]
+}

packages/query-rest/.eslintrc.json

@@ -0,0 +1,36 @@
+{
+  "extends": [
+    "../../.eslintrc.json"
+  ],
+  "ignorePatterns": [
+    "!**/*"
+  ],
+  "parserOptions": {
+    "project": "./tsconfig.json"
+  },
+  "overrides": [
+    {
+      "files": [
+        "*.ts",
+        "*.tsx",
+        "*.js",
+        "*.jsx"
+      ],
+      "rules": {}
+    },
+    {
+      "files": [
+        "*.ts",
+        "*.tsx"
+      ],
+      "rules": {}
+    },
+    {
+      "files": [
+        "*.js",
+        "*.jsx"
+      ],
+      "rules": {}
+    }
+  ]
+}

packages/query-rest/README.md

@@ -0,0 +1,23 @@
+<p align="center">
+  <a href="https://tripss.github.io/nestjs-query" target="blank"><img src="https://tripss.github.io/nestjs-query/img/logo.svg" width="120" alt="Nestjs-query Logo" /></a>
+</p>
+
+[![npm version](https://img.shields.io/npm/v/@ptc-org/nestjs-query-rest.svg)](https://www.npmjs.org/package/@ptc-org/nestjs-query-rest)
+[![Test](https://github.com/tripss/nestjs-query/workflows/Test/badge.svg?branch=master)](https://github.com/tripss/nestjs-query/actions?query=workflow%3ATest+and+branch%3Amaster+)
+[![Coverage Status](https://codecov.io/gh/TriPSs/nestjs-query/branch/master/graph/badge.svg?token=29EX71ID2P)](https://codecov.io/gh/TriPSs/nestjs-query)
+[![Known Vulnerabilities](https://snyk.io/test/github/tripss/nestjs-query/badge.svg?targetFile=packages/query-rest/package.json)](https://snyk.io/test/github/tripss/nestjs-query?targetFile=packages/query-rest/package.json)
+
+# `@ptc-org/nestjs-query-rest`
+
+This package provides a code first implementation of rest CRUD endpoints. It is built on top of
+of [nestjs](https://nestjs.com/).
+
+## Installation
+
+[Install Guide](https://tripss.github.io/nestjs-query/docs/introduction/install)
+
+## Getting Started
+
+The get started with the `@ptc-org/nestjs-query-rest` package checkout
+the [Getting Started](https://tripss.github.io/nestjs-query/docs/rest/getting-started) docs.
+

packages/query-rest/jest.config.ts

@@ -0,0 +1,18 @@
+/* eslint-disable */
+// eslint-disable-next-line import/no-default-export
+export default {
+  displayName: 'query-rest',
+  preset: '../../jest.preset.js',
+  globals: {},
+  testEnvironment: 'node',
+  transform: {
+    '^.+\\.[tj]sx?$': [
+      'ts-jest',
+      {
+        tsconfig: '<rootDir>/tsconfig.spec.json'
+      }
+    ]
+  },
+  moduleFileExtensions: ['ts', 'tsx', 'js', 'jsx'],
+  coverageDirectory: '../../coverage/packages/query-rest'
+}

packages/query-rest/package.json

@@ -0,0 +1,49 @@
+{
+  "name": "@ptc-org/nestjs-query-rest",
+  "version": "4.3.0",
+  "description": "Nestjs rest query adapter",
+  "author": "doug-martin <[email protected]>",
+  "homepage": "https://github.com/tripss/nestjs-query#readme",
+  "keywords": [
+    "rest",
+    "crud",
+    "nestjs"
+  ],
+  "license": "MIT",
+  "main": "src/index.js",
+  "types": "src/index.d.ts",
+  "directories": {
+    "lib": "src",
+    "test": "__tests__"
+  },
+  "files": [
+    "src/**"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/tripss/nestjs-query.git",
+    "directory": "packages/query-rest"
+  },
+  "bugs": {
+    "url": "https://github.com/tripss/nestjs-query/issues"
+  },
+  "dependencies": {
+    "lodash.omit": "^4.5.0",
+    "lower-case-first": "^2.0.2",
+    "pluralize": "^8.0.0",
+    "tslib": "^2.6.2",
+    "upper-case-first": "^2.0.2"
+  },
+  "peerDependencies": {
+    "@nestjs/common": "^9.0.0 || ^10.0.0",
+    "@nestjs/core": "^9.0.0 || ^10.0.0",
+    "@nestjs/graphql": "^11.0.0 || ^12.0.0",
+    "@nestjs/swagger": "^7.0.0",
+    "class-transformer": "^0.5",
+    "class-validator": "^0.14.0",
+    "ts-morph": "^19.0.0"
+  }
+}

packages/query-rest/project.json

@@ -0,0 +1,48 @@
+{
+  "name": "query-rest",
+  "$schema": "../../node_modules/nx/schemas/project-schema.json",
+  "sourceRoot": "packages/query-rest/src",
+  "projectType": "library",
+  "targets": {
+    "lint": {
+      "executor": "@nx/eslint:lint",
+      "outputs": ["{options.outputFile}"],
+      "options": {
+        "lintFilePatterns": ["packages/query-rest/**/*.ts"]
+      }
+    },
+    "test": {
+      "executor": "@nx/jest:jest",
+      "outputs": ["{workspaceRoot}/coverage/packages/query-rest"],
+      "options": {
+        "jestConfig": "packages/query-rest/jest.config.ts",
+        "passWithNoTests": true
+      }
+    },
+    "build": {
+      "executor": "@nx/js:tsc",
+      "outputs": ["{options.outputPath}"],
+      "options": {
+        "outputPath": "dist/packages/query-rest",
+        "tsConfig": "packages/query-rest/tsconfig.lib.json",
+        "packageJson": "packages/query-rest/package.json",
+        "main": "packages/query-rest/src/index.ts",
+        "assets": ["packages/query-rest/*.md"],
+        "updateBuildableProjectDepsInPackageJson": true,
+        "buildableProjectDepsInPackageJsonType": "dependencies"
+      }
+    },
+    "version": {
+      "executor": "@jscutlery/semver:version",
+      "options": {}
+    },
+    "publish": {
+      "executor": "nx:run-commands",
+      "options": {
+        "command": "npm publish ./dist/packages/query-rest --access public"
+      }
+    }
+  },
+  "tags": [],
+  "implicitDependencies": ["core"]
+}

packages/query-rest/src/auth/authorizer.ts

@@ -0,0 +1,47 @@
+import { Filter } from '@ptc-org/nestjs-query-core'
+
+export enum OperationGroup {
+  READ = 'read',
+  AGGREGATE = 'aggregate',
+  CREATE = 'create',
+  UPDATE = 'update',
+  DELETE = 'delete'
+}
+
+export interface AuthorizationContext {
+  /** The name of the method that uses the @AuthorizeFilter decorator */
+  readonly operationName: string
+
+  /** The group this operation belongs to */
+  readonly operationGroup: OperationGroup
+
+  /** If the operation does not modify any entities */
+  readonly readonly: boolean
+
+  /** If the operation can affect multiple entities */
+  readonly many: boolean
+}
+
+export interface CustomAuthorizer<DTO> {
+  // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types,@typescript-eslint/no-explicit-any
+  authorize(context: any, authorizerContext: AuthorizationContext): Promise<Filter<DTO>>
+
+  authorizeRelation?(
+    relationName: string,
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    context: any,
+    authorizerContext: AuthorizationContext
+  ): Promise<Filter<unknown> | undefined>
+}
+
+export interface Authorizer<DTO> extends CustomAuthorizer<DTO> {
+  // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types,@typescript-eslint/no-explicit-any
+  authorize(context: any, authorizerContext: AuthorizationContext): Promise<Filter<DTO>>
+
+  authorizeRelation(
+    relationName: string,
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    context: any,
+    authorizerContext: AuthorizationContext
+  ): Promise<Filter<unknown> | undefined>
+}

packages/query-rest/src/auth/default-crud.authorizer.ts

@@ -0,0 +1,99 @@
+import { Inject, Injectable, Optional } from '@nestjs/common'
+import { ModuleRef } from '@nestjs/core'
+import { Class, Filter } from '@ptc-org/nestjs-query-core'
+
+// import { getAuthorizer } from '../decorators'
+// import { ResolverRelation } from '../resolvers/relations'
+import { AuthorizationContext, Authorizer, CustomAuthorizer } from './authorizer'
+import { getCustomAuthorizerToken } from './tokens'
+
+export interface AuthorizerOptions<DTO> {
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  authorize: (context: any, authorizationContext: AuthorizationContext) => Filter<DTO> | Promise<Filter<DTO>>
+}
+
+// const createRelationAuthorizer = (opts: AuthorizerOptions<unknown>): Authorizer<unknown> => ({
+//   // eslint-disable-next-line @typescript-eslint/no-explicit-any
+//   async authorize(context: any, authorizationContext: AuthorizationContext): Promise<Filter<unknown>> {
+//     return opts.authorize(context, authorizationContext) ?? {}
+//   },
+//   authorizeRelation(): Promise<Filter<unknown>> {
+//     return Promise.reject(new Error('Not implemented'))
+//   }
+// })
+
+export function createDefaultAuthorizer<DTO>(
+  DTOClass: Class<DTO>,
+  opts?: CustomAuthorizer<DTO> | AuthorizerOptions<DTO> // instance of class or authorizer options
+): Class<Authorizer<DTO>> {
+  @Injectable()
+  class DefaultAuthorizer implements Authorizer<DTO> {
+    readonly authOptions?: AuthorizerOptions<DTO> | CustomAuthorizer<DTO> = opts
+
+    readonly relationsAuthorizers: Map<string, Authorizer<unknown> | undefined>
+
+    // private readonly relations: Map<string, ResolverRelation<unknown>>
+
+    constructor(
+      private readonly moduleRef: ModuleRef,
+      @Optional() @Inject(getCustomAuthorizerToken(DTOClass)) private readonly customAuthorizer?: CustomAuthorizer<DTO>
+    ) {
+      this.relationsAuthorizers = new Map<string, Authorizer<unknown> | undefined>()
+      // this.relations = this.getRelations()
+    }
+
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    public async authorize(context: any, authorizationContext: AuthorizationContext): Promise<Filter<DTO>> {
+      return (
+        this.customAuthorizer?.authorize(context, authorizationContext) ??
+        this.authOptions?.authorize(context, authorizationContext) ??
+        {}
+      )
+    }
+
+    public async authorizeRelation(
+      relationName: string,
+      // eslint-disable-next-line @typescript-eslint/no-explicit-any
+      context: any,
+      authorizationContext: AuthorizationContext
+    ): Promise<Filter<unknown>> {
+      if (this.customAuthorizer && typeof this.customAuthorizer.authorizeRelation === 'function') {
+        const filterFromCustomAuthorizer = await this.customAuthorizer.authorizeRelation(
+          relationName,
+          context,
+          authorizationContext
+        )
+
+        if (filterFromCustomAuthorizer) {
+          return filterFromCustomAuthorizer
+        }
+      }
+      return {}
+      // this.addRelationAuthorizerIfNotExist(relationName)
+      // return this.relationsAuthorizers.get(relationName)?.authorize(context, authorizationContext) ?? {}
+    }
+
+    private addRelationAuthorizerIfNotExist(relationName: string) {
+      if (!this.relationsAuthorizers.has(relationName)) {
+        return
+        // const relation = this.relations.get(relationName)
+        // if (!relation) return
+        // if (relation.auth) {
+        //   this.relationsAuthorizers.set(relationName, createRelationAuthorizer(relation.auth))
+        // } else if (getAuthorizer(relation.DTO)) {
+        //   this.relationsAuthorizers.set(relationName, this.moduleRef.get(getAuthorizerToken(relation.DTO), { strict: false }))
+        // }
+      }
+    }
+
+    // private getRelations(): Map<string, ResolverRelation<unknown>> {
+    //   const { many = {}, one = {} } = {}// getRelations(DTOClass)
+    //   const relationsMap = new Map<string, ResolverRelation<unknown>>()
+    //   Object.keys(many).forEach((relation) => relationsMap.set(relation, many[relation]))
+    //   Object.keys(one).forEach((relation) => relationsMap.set(relation, one[relation]))
+    //   return relationsMap
+    // }
+  }
+
+  return DefaultAuthorizer
+}

packages/query-rest/src/auth/index.ts

@@ -0,0 +1,3 @@
+export * from './authorizer'
+export * from './default-crud.authorizer'
+export * from './tokens'