Refactor: Replace graphql-type-json with graphql-scalars (#2191)

This should be non-breaking, as apps have `graphql-type-json` as dependency on their own. After merging this, the starter should also switch to `graphql-scalars`. --------- Co-authored-by: Johannes Obermair <48853629+johnnyomair@users.noreply.github.com>
vivid-planet · Jun 25, 2024 · fe22985 · fe22985
1 parent caefa1c
commit fe22985
Show file tree

Hide file tree

Showing 16 changed files with 137 additions and 124 deletions.
diff --git a/.changeset/small-eggs-learn.md b/.changeset/small-eggs-learn.md
@@ -0,0 +1,16 @@
+---
+"@comet/cms-api": major
+---
+
+API Generator: Replace graphql-type-json with graphql-scalars for JSON columns
+
+**Upgrading**
+
+1. Install graphql-scalars: `npm install graphql-scalars`
+2. Uninstall graphql-type-json: `npm install graphql-type-json`
+3. Update imports:
+
+   ```diff
+   - import { GraphQLJSONObject } from "graphql-type-json";
+   + import { GraphQLJSONObject } from "graphql-scalars";
+   ```
diff --git a/demo/api/package.json b/demo/api/package.json
@@ -59,7 +59,6 @@
         "faker": "^5.0.0",
         "file-type": "^16.0.0",
         "graphql": "^15.0.0",
-        "graphql-type-json": "^0.3.0",
         "hasha": "^5.0.0",
         "helmet": "^4.6.0",
         "image-size": "^0.9.0",

diff --git a/packages/api/cms-api/package.json b/packages/api/cms-api/package.json
@@ -55,7 +55,7 @@
         "get-image-colors": "^4.0.0",
         "got": "^11.8.0",
         "graphql-parse-resolve-info": "^4.13.0",
-        "graphql-type-json": "^0.3.2",
+        "graphql-scalars": "^1.23.0",
         "hasha": "^5.2.2",
         "jsonwebtoken": "^8.5.1",
         "jszip": "^3.10.1",

diff --git a/packages/api/cms-api/src/auth/resolver/auth.resolver.ts b/packages/api/cms-api/src/auth/resolver/auth.resolver.ts
@@ -1,6 +1,6 @@
 import { Inject, Type } from "@nestjs/common";
 import { Args, Context, Mutation, Parent, Query, ResolveField, Resolver } from "@nestjs/graphql";
-import { GraphQLJSONObject } from "graphql-type-json";
+import { GraphQLJSONObject } from "graphql-scalars";
 import { IncomingMessage } from "http";
 
 import { SkipBuild } from "../../builds/skip-build.decorator";

diff --git a/packages/api/cms-api/src/blocks/rootBlocks/root-block-data.scalar.ts b/packages/api/cms-api/src/blocks/rootBlocks/root-block-data.scalar.ts
@@ -1,6 +1,6 @@
 import { Block } from "@comet/blocks-api";
 import { GraphQLScalarType } from "graphql";
-import { GraphQLJSONObject } from "graphql-type-json";
+import { GraphQLJSONObject } from "graphql-scalars";
 
 const rootBlockDataScalars = new Map<string, GraphQLScalarType>();
 

diff --git a/packages/api/cms-api/src/blocks/rootBlocks/root-block-input.scalar.ts b/packages/api/cms-api/src/blocks/rootBlocks/root-block-input.scalar.ts
@@ -1,6 +1,6 @@
 import { Block } from "@comet/blocks-api";
 import { GraphQLScalarType } from "graphql";
-import { GraphQLJSONObject } from "graphql-type-json";
+import { GraphQLJSONObject } from "graphql-scalars";
 
 const rootBlockInputScalars = new Map<string, GraphQLScalarType>();
 

diff --git a/packages/api/cms-api/src/dam/files/entities/file-image.entity.ts b/packages/api/cms-api/src/dam/files/entities/file-image.entity.ts
@@ -1,6 +1,6 @@
 import { BaseEntity, Embedded, Entity, OneToOne, PrimaryKey, Property } from "@mikro-orm/core";
 import { Field, ID, Int, ObjectType } from "@nestjs/graphql";
-import { GraphQLJSONObject } from "graphql-type-json";
+import { GraphQLJSONObject } from "graphql-scalars";
 import { v4 as uuid } from "uuid";
 
 import { ImageCropArea } from "../../images/entities/image-crop-area.entity";

diff --git a/packages/api/cms-api/src/generator/generate-crud-input.ts b/packages/api/cms-api/src/generator/generate-crud-input.ts
@@ -379,7 +379,7 @@ export async function generateCrudInput(
 import { Transform, Type } from "class-transformer";
 import { IsString, IsNotEmpty, ValidateNested, IsNumber, IsBoolean, IsDate, IsOptional, IsEnum, IsUUID, IsArray, IsInt } from "class-validator";
 import { IsSlug, RootBlockInputScalar, IsNullable, PartialType} from "@comet/cms-api";
-import { GraphQLJSONObject } from "graphql-type-json";
+import { GraphQLJSONObject } from "graphql-scalars";
 import { BlockInputInterface, isBlockInputInterface } from "@comet/blocks-api";
 ${generateImportsCode(imports)}
 

diff --git a/packages/api/cms-api/src/redirects/dto/redirect-input.factory.ts b/packages/api/cms-api/src/redirects/dto/redirect-input.factory.ts
@@ -3,7 +3,7 @@ import { Type } from "@nestjs/common";
 import { Field, InputType } from "@nestjs/graphql";
 import { Transform } from "class-transformer";
 import { IsEnum, IsOptional, ValidateNested, ValidationArguments } from "class-validator";
-import { GraphQLJSONObject } from "graphql-type-json";
+import { GraphQLJSONObject } from "graphql-scalars";
 
 import { RedirectGenerationType, RedirectSourceTypeValues } from "../redirects.enum";
 import { IsValidRedirectSource } from "../validators/isValidRedirectSource";

diff --git a/packages/api/cms-api/src/redirects/entities/redirect-entity.factory.ts b/packages/api/cms-api/src/redirects/entities/redirect-entity.factory.ts
@@ -2,7 +2,7 @@ import { Block, BlockDataInterface, RootBlock, RootBlockEntity } from "@comet/bl
 import { Embedded, Entity, Enum, OptionalProps, PrimaryKey, Property } from "@mikro-orm/core";
 import { Type } from "@nestjs/common";
 import { Field, ID, ObjectType } from "@nestjs/graphql";
-import { GraphQLJSONObject } from "graphql-type-json";
+import { GraphQLJSONObject } from "graphql-scalars";
 import { v4 as uuid } from "uuid";
 
 import { RootBlockType } from "../../blocks/root-block-type";

diff --git a/packages/api/cms-api/src/user-permissions/dto/current-user.ts b/packages/api/cms-api/src/user-permissions/dto/current-user.ts
@@ -1,5 +1,5 @@
 import { Field, ObjectType } from "@nestjs/graphql";
-import { GraphQLJSONObject } from "graphql-type-json";
+import { GraphQLJSONObject } from "graphql-scalars";
 
 import { ContentScope } from "../interfaces/content-scope.interface";
 

diff --git a/packages/api/cms-api/src/user-permissions/dto/user-content-scopes.input.ts b/packages/api/cms-api/src/user-permissions/dto/user-content-scopes.input.ts
@@ -1,6 +1,6 @@
 import { Field, InputType } from "@nestjs/graphql";
 import { IsArray, IsObject } from "class-validator";
-import { GraphQLJSONObject } from "graphql-type-json";
+import { GraphQLJSONObject } from "graphql-scalars";
 
 import { ContentScope } from "../interfaces/content-scope.interface";
 

diff --git a/packages/api/cms-api/src/user-permissions/dto/user-permission.input.ts b/packages/api/cms-api/src/user-permissions/dto/user-permission.input.ts
@@ -1,6 +1,6 @@
 import { Field, ID, InputType } from "@nestjs/graphql";
 import { IsArray, IsBoolean, IsDate, IsObject, IsOptional, IsString, IsUUID } from "class-validator";
-import { GraphQLJSONObject } from "graphql-type-json";
+import { GraphQLJSONObject } from "graphql-scalars";
 
 import { ContentScope } from "../interfaces/content-scope.interface";
 

diff --git a/packages/api/cms-api/src/user-permissions/entities/user-permission.entity.ts b/packages/api/cms-api/src/user-permissions/entities/user-permission.entity.ts
@@ -1,6 +1,6 @@
 import { BaseEntity, Entity, PrimaryKey, Property } from "@mikro-orm/core";
 import { Field, ID, ObjectType, registerEnumType } from "@nestjs/graphql";
-import { GraphQLJSONObject } from "graphql-type-json";
+import { GraphQLJSONObject } from "graphql-scalars";
 import { v4 } from "uuid";
 
 import { ContentScope } from "../interfaces/content-scope.interface";

diff --git a/packages/api/cms-api/src/user-permissions/user-content-scopes.resolver.ts b/packages/api/cms-api/src/user-permissions/user-content-scopes.resolver.ts
@@ -1,7 +1,7 @@
 import { EntityRepository } from "@mikro-orm/core";
 import { InjectRepository } from "@mikro-orm/nestjs";
 import { Args, Mutation, Query, Resolver } from "@nestjs/graphql";
-import { GraphQLJSONObject } from "graphql-type-json";
+import { GraphQLJSONObject } from "graphql-scalars";
 
 import { SkipBuild } from "../builds/skip-build.decorator";
 import { RequiredPermission } from "./decorators/required-permission.decorator";