refactor(json-api-nestjs): Deep refactoring

BREAKING CHANGE: Now relation body params allow only as specification.
  https://jsonapi.org/format/#crud-updating-resource-relationships

  befoare allow without data props

Author: klerick

.verdaccio/config.yml

@@ -0,0 +1,28 @@
+# path to a directory with all packages
+storage: ../tmp/local-registry/storage
+
+# a list of other known repositories we can talk to
+uplinks:
+  npmjs:
+    url: https://registry.npmjs.org/
+    maxage: 60m
+
+packages:
+  '**':
+    # give all users (including non-authenticated users) full access
+    # because it is a local registry
+    access: $all
+    publish: $all
+    unpublish: $all
+
+    # if package is not available locally, proxy requests to npm registry
+    proxy: npmjs
+
+# log settings
+log:
+  type: stdout
+  format: pretty
+  level: warn
+
+publish:
+  allow_offline: true # set offline to true to allow publish offline

docker-compose.yaml

@@ -0,0 +1,51 @@
+version: '3.8'
+services:
+#  api-gate:
+#    container_name: api-gate
+#    restart: always
+#    build: apps/api-gate/
+#    ports:
+#      - "3000:3000"
+  postgres:
+    image: postgres:15.1-alpine
+    restart: always
+    environment:
+      - POSTGRES_USER=postgres
+      - POSTGRES_PASSWORD=postgres
+    ports:
+      - '5432:5432'
+    volumes:
+      - db:/var/lib/postgresql/data
+  pgadmin:
+    container_name: 'pgadmin'
+    image: 'dpage/pgadmin4:latest'
+    hostname: pgadmin
+    depends_on:
+      - 'postgres'
+    environment:
+      - PGADMIN_DEFAULT_PASSWORD=password
+      - [email protected]
+    volumes:
+      - pgadmin:/root/.pgadmin
+    ports:
+      - '8000:80'
+#  redis:
+#    image: redis:6.2-alpine
+#    restart: always
+#    ports:
+#      - '6379:6379'
+#    command: redis-server --save 20 1 --loglevel warning
+#    volumes:
+#      - redis:/data
+#  jaeger:
+#    image: jaegertracing/all-in-one:1.41
+#    ports:
+#      - "16686:16686"
+#      - "14268:14268"
+volumes:
+  db:
+    driver: local
+#  redis:
+#    driver: local
+  pgadmin:
+    driver: local

libs/json-api/json-api-nestjs-sdk/src/lib/service/json-api-utils.service.ts

@@ -338,7 +338,7 @@ export class JsonApiUtilsService {
         }
         return {
           ...acum,
-          [key]: data,
+          [key]: { data },
         };
       }, {} as Relationships<E>);
 

libs/json-api/json-api-nestjs-sdk/src/lib/types/query-params.ts

@@ -1,4 +1,4 @@
-import { QueryField } from 'json-shared-type';
+import { QueryField } from '@klerick/json-api-nestjs-shared';
 import { EntityProps, EntityRelation } from './entity';
 import { TypeOfArray } from './utils';
 import { Operands, OperandsRelation } from './filter-operand';

libs/json-api/json-api-nestjs-shared/.eslintrc.json

@@ -0,0 +1,30 @@
+{
+  "extends": ["../../../.eslintrc.base.json"],
+  "ignorePatterns": ["!**/*"],
+  "overrides": [
+    {
+      "files": ["*.ts", "*.tsx", "*.js", "*.jsx"],
+      "rules": {}
+    },
+    {
+      "files": ["*.ts", "*.tsx"],
+      "rules": {}
+    },
+    {
+      "files": ["*.js", "*.jsx"],
+      "rules": {}
+    },
+    {
+      "files": ["*.json"],
+      "parser": "jsonc-eslint-parser",
+      "rules": {
+        "@nx/dependency-checks": [
+          "error",
+          {
+            "ignoredFiles": ["{projectRoot}/eslint.config.{js,cjs,mjs}"]
+          }
+        ]
+      }
+    }
+  ]
+}

libs/json-api/json-api-nestjs-shared/README.md

@@ -0,0 +1,11 @@
+# json-api-nestjs-shared
+
+This library was generated with [Nx](https://nx.dev).
+
+## Building
+
+Run `nx build json-api-nestjs-shared` to build the library.
+
+## Running unit tests
+
+Run `nx test json-api-nestjs-shared` to execute the unit tests via [Jest](https://jestjs.io).

libs/json-api/json-api-nestjs-shared/jest.config.ts

@@ -0,0 +1,10 @@
+export default {
+  displayName: 'json-api-nestjs-shared',
+  preset: '../../../jest.preset.js',
+  testEnvironment: 'node',
+  transform: {
+    '^.+\\.[tj]s$': ['ts-jest', { tsconfig: '<rootDir>/tsconfig.spec.json' }],
+  },
+  moduleFileExtensions: ['ts', 'js', 'html'],
+  coverageDirectory: '../../../coverage/libs/json-api/json-api-nestjs-shared',
+};

libs/json-api/json-api-nestjs-shared/package.json

@@ -0,0 +1,10 @@
+{
+  "name": "@klerick/json-api-nestjs-shared",
+  "version": "0.0.1",
+  "dependencies": {
+    "tslib": "^2.3.0"
+  },
+  "type": "commonjs",
+  "main": "./src/index.js",
+  "typings": "./src/index.d.ts"
+}

libs/json-api/json-api-nestjs-shared/project.json

@@ -0,0 +1,33 @@
+{
+  "name": "json-api-nestjs-shared",
+  "$schema": "../../../node_modules/nx/schemas/project-schema.json",
+  "sourceRoot": "libs/json-api/json-api-nestjs-shared/src",
+  "projectType": "library",
+  "release": {
+    "version": {
+      "generatorOptions": {
+        "packageRoot": "dist/{projectRoot}",
+        "currentVersionResolver": "git-tag"
+      }
+    }
+  },
+  "tags": [],
+  "targets": {
+    "build": {
+      "executor": "@nx/js:tsc",
+      "outputs": ["{options.outputPath}"],
+      "options": {
+        "outputPath": "dist/libs/json-api/json-api-nestjs-shared",
+        "tsConfig": "libs/json-api/json-api-nestjs-shared/tsconfig.lib.json",
+        "packageJson": "libs/json-api/json-api-nestjs-shared/package.json",
+        "main": "libs/json-api/json-api-nestjs-shared/src/index.ts",
+        "assets": ["libs/json-api/json-api-nestjs-shared/*.md"]
+      }
+    },
+    "nx-release-publish": {
+      "options": {
+        "packageRoot": "dist/{projectRoot}"
+      }
+    }
+  }
+}

libs/json-api/json-api-nestjs-shared/src/index.ts

@@ -0,0 +1,2 @@
+export * from './lib/utils';
+export * from './lib/types';

libs/json-api/json-api-nestjs-shared/src/lib/types/entity-type.ts

@@ -0,0 +1,17 @@
+export type EntityField =
+  | string
+  | number
+  | bigint
+  | boolean
+  | string[]
+  | number[]
+  | null
+  | Date;
+
+export type EntityProps<T> = {
+  [P in keyof T]: T[P] extends EntityField ? P : never;
+}[keyof T];
+
+export type EntityRelation<T> = {
+  [P in keyof T]: T[P] extends EntityField ? never : P;
+}[keyof T];

libs/json-api/json-api-nestjs-shared/src/lib/types/index.ts

@@ -0,0 +1,4 @@
+export * from './utils-string.type';
+export * from './query-type';
+export * from './entity-type';
+export * from './response-body';

libs/json-api/json-api-nestjs-shared/src/lib/types/query-type.ts

@@ -0,0 +1,36 @@
+export enum QueryField {
+  filter = 'filter',
+  sort = 'sort',
+  include = 'include',
+  page = 'page',
+  fields = 'fields',
+}
+
+export enum FilterOperand {
+  eq = 'eq',
+  gt = 'gt',
+  gte = 'gte',
+  like = 'like',
+  lt = 'lt',
+  lte = 'lte',
+  ne = 'ne',
+  regexp = 'regexp',
+  in = 'in',
+  nin = 'nin',
+  some = 'some',
+}
+
+export enum FilterOperandOnlyInNin {
+  in = 'in',
+  nin = 'nin',
+}
+export enum FilterOperandOnlySimple {
+  eq = 'eq',
+  gt = 'gt',
+  gte = 'gte',
+  like = 'like',
+  lt = 'lt',
+  lte = 'lte',
+  ne = 'ne',
+  regexp = 'regexp',
+}

libs/json-api/json-api-nestjs-shared/src/lib/types/response-body.ts

@@ -0,0 +1,69 @@
+import {
+  EntityField,
+  EntityProps,
+  EntityRelation,
+  TypeOfArray,
+  ValueOf,
+} from '.';
+
+export type PageProps = {
+  totalItems: number;
+  pageNumber: number;
+  pageSize: number;
+};
+
+export type DebugMetaProps = Partial<{
+  time: number;
+}>;
+
+export type MainData<T = string> = {
+  type: T;
+  id: string;
+};
+
+export type Links = {
+  self: string;
+  related?: string;
+};
+
+export type Attributes<D> = {
+  [P in EntityProps<D>]?: D[P] extends EntityField ? D[P] : TypeOfArray<D[P]>;
+};
+
+export type Data<E, S = string> = {
+  data?: E extends unknown[] ? MainData<S>[] : MainData<S> | null;
+};
+
+export type Relationships<T> = {
+  [P in EntityRelation<T>]?: {
+    links: Links;
+  } & Data<T[P], P>;
+};
+
+export type Include<T> = ValueOf<{
+  [P in EntityRelation<T>]: ResourceData<TypeOfArray<T[P]>>;
+}>;
+
+export type ResourceData<T> = MainData & {
+  attributes?: Attributes<T>;
+  relationships?: Relationships<T>;
+  links: Omit<Links, 'related'>;
+};
+
+export type MetaProps<T, R = null> = R extends null ? T : T & R;
+
+export type ResourceObject<
+  T,
+  R extends 'object' | 'array' = 'object',
+  M = null
+> = {
+  meta: R extends 'array'
+    ? MetaProps<PageProps & DebugMetaProps, M>
+    : MetaProps<DebugMetaProps, M>;
+  data: R extends 'array' ? ResourceData<T>[] : ResourceData<T>;
+  included?: Include<T>[];
+};
+
+export type ResourceObjectRelationships<E, K extends EntityRelation<E>> = {
+  meta: DebugMetaProps;
+} & Required<Data<E[K], K>>;

libs/json-api/json-api-nestjs-shared/src/lib/types/utils-string.type.ts

@@ -0,0 +1,20 @@
+export type KebabCase<S> = S extends `${infer C}${infer T}`
+  ? KebabCase<T> extends infer U
+    ? U extends string
+      ? T extends Uncapitalize<T>
+        ? `${Uncapitalize<C>}${U}`
+        : `${Uncapitalize<C>}-${U}`
+      : never
+    : never
+  : S;
+
+export type KebabToCamelCase<S extends string> =
+  S extends `${infer T}-${infer U}-${infer V}`
+    ? `${T}${Capitalize<U>}${Capitalize<KebabToCamelCase<V>>}`
+    : S extends `${infer T}-${infer U}`
+    ? `${Capitalize<T>}${Capitalize<KebabToCamelCase<U>>}`
+    : S;
+
+export type TypeOfArray<T> = T extends (infer U)[] ? U : T;
+
+export type ValueOf<T> = T[keyof T];

libs/json-api/json-api-nestjs-shared/src/lib/utils/index.ts

@@ -0,0 +1,2 @@
+export * from './string-utils';
+export * from './object-utils';

libs/json-api/json-api-nestjs-shared/src/lib/utils/object-utils.ts

@@ -0,0 +1,14 @@
+export const ObjectTyped = {
+  keys: Object.keys as <T extends {}>(yourObject: T) => Array<keyof T>,
+  values: Object.values as <U extends {}>(yourObject: U) => Array<U[keyof U]>,
+  entries: Object.entries as <O extends {}>(
+    yourObject: O
+  ) => Array<[keyof O, O[keyof O]]>,
+  fromEntries: Object.fromEntries as <K extends string, V>(
+    yourObjectEntries: [K, V][]
+  ) => Record<K, V>,
+};
+
+export function isObject(item: unknown): item is object {
+  return typeof item === 'object' && !Array.isArray(item) && item !== null;
+}