feat: uuid support for relationships

Mateus Garcia · Mateus Garcia · commit e59761d1ee73 · 2023-03-30T09:29:39.000-03:00
diff --git a/libs/json-api-nestjs/src/lib/config/bindings.ts b/libs/json-api-nestjs/src/lib/config/bindings.ts
@@ -50,7 +50,7 @@ const Bindings: BindingsConfig = {
       {
         property: PARAMS_RESOURCE_ID,
         decorator: Param,
-        mixins: [idPipeMixin],
+        mixins: [],
       },
       {
         decorator: Query,
@@ -72,7 +72,7 @@ const Bindings: BindingsConfig = {
       {
         property: PARAMS_RESOURCE_ID,
         decorator: Param,
-        mixins: [idPipeMixin],
+        mixins: [],
       },
     ],
   },
@@ -97,7 +97,7 @@ const Bindings: BindingsConfig = {
       {
         property: PARAMS_RESOURCE_ID,
         decorator: Param,
-        mixins: [idPipeMixin],
+        mixins: [],
       },
       {
         decorator: Body,
@@ -114,7 +114,7 @@ const Bindings: BindingsConfig = {
       {
         property: PARAMS_RESOURCE_ID,
         decorator: Param,
-        mixins: [idPipeMixin],
+        mixins: [],
       },
       {
         property: PARAMS_RELATION_NAME,
@@ -132,7 +132,7 @@ const Bindings: BindingsConfig = {
       {
         property: PARAMS_RESOURCE_ID,
         decorator: Param,
-        mixins: [idPipeMixin],
+        mixins: [],
       },
       {
         property: PARAMS_RELATION_NAME,
@@ -154,7 +154,7 @@ const Bindings: BindingsConfig = {
       {
         property: PARAMS_RESOURCE_ID,
         decorator: Param,
-        mixins: [idPipeMixin],
+        mixins: [],
       },
       {
         property: PARAMS_RELATION_NAME,
@@ -176,7 +176,7 @@ const Bindings: BindingsConfig = {
       {
         property: PARAMS_RESOURCE_ID,
         decorator: Param,
-        mixins: [idPipeMixin],
+        mixins: [],
       },
       {
         property: PARAMS_RELATION_NAME,
diff --git a/libs/json-api-nestjs/src/lib/factory/ajv/ajv.factory.ts b/libs/json-api-nestjs/src/lib/factory/ajv/ajv.factory.ts
@@ -26,8 +26,10 @@ export function AjvCallFactory(
 
   for (const entity of options.entities) {
     const arrayProps: { [key: string]: boolean } = {};
+    const uuidProps: { [key: string]: boolean } = {};
     const relationArrayProps: { [key: string]: { [key: string]: boolean } } =
       {};
+    const relationUuids: { [key: string]: { [key: string]: boolean } } = {};
     const repository = dataSource.getRepository(entity);
     const relations = repository.metadata.relations.map((i) => {
       return i.propertyName;
@@ -36,6 +38,7 @@ export function AjvCallFactory(
       .filter((i) => !relations.includes(i.propertyName))
       .map((i) => {
         arrayProps[i.propertyName] = i.isArray;
+        uuidProps[i.propertyName] = i.generationStrategy === 'uuid';
         return i.propertyName;
       });
     const relationType = repository.metadata.relations.reduce((acum, i) => {
@@ -63,6 +66,15 @@ export function AjvCallFactory(
           relationArrayProps[item.propertyName] =
             relationArrayProps[item.propertyName] || {};
           relationArrayProps[item.propertyName][i.propertyName] = i.isArray;
+
+          relationUuids[item.propertyName] =
+            relationUuids[item.propertyName] || {};
+
+          if (i.isPrimary) {
+            relationUuids[item.propertyName][i.propertyName] =
+              i.generationStrategy === 'uuid';
+          }
+
           return i.propertyName;
         });
       const fakeObject = columns.reduce<Record<string, string>>(
@@ -110,6 +122,7 @@ export function AjvCallFactory(
           arrayProps,
           relationArrayProps,
           relationType,
+          relationUuids,
         }
       ),
       `inputBodyPostSchema-${schemaName}`
@@ -122,8 +135,10 @@ export function AjvCallFactory(
         `inputBodyPatchSchema-${schemaName}`,
         {
           arrayProps,
+          uuidProps,
           relationArrayProps,
           relationType,
+          relationUuids,
         }
       ),
       `inputBodyPatchSchema-${schemaName}`
diff --git a/libs/json-api-nestjs/src/lib/factory/ajv/utils/input-body-patch-schema.ts b/libs/json-api-nestjs/src/lib/factory/ajv/utils/input-body-patch-schema.ts
@@ -8,10 +8,12 @@ export function inputBodyPatchSchema(
   schemaName: string,
   arrayPropsConfig: {
     arrayProps: { [key: string]: boolean };
+    uuidProps: { [key: string]: boolean };
     relationArrayProps: { [key: string]: { [key: string]: boolean } };
     relationType: {
       [key: string]: Function | string;
     };
+    relationUuids: { [key: string]: { [key: string]: boolean } };
   }
 ): ReturnType<typeof inputBodyPostSchema> {
   const json = inputBodyPostSchema(
@@ -21,13 +23,18 @@ export function inputBodyPatchSchema(
     schemaName,
     arrayPropsConfig
   );
-  const patternObject: Record<string, string> = {};
-  if (
-    Reflect.getMetadata('design:type', entity['prototype'], 'id') === Number
-  ) {
-    patternObject.pattern = '^\\d+$';
-    patternObject.description = 'Use string should be as number string';
+  const patternObject: Record<string, string | number> = {};
+  patternObject.pattern = '^\\d+$';
+  patternObject.description = 'Use string should be as number string';
+
+  if (arrayPropsConfig.uuidProps.id) {
+    patternObject.pattern =
+      '^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$';
+    patternObject.maxLength = 36;
+    patternObject.minLength = 36;
+    patternObject.description = 'Use string should be as uuid string';
   }
+
   json.properties.data.properties = {
     ...{
       id: {
diff --git a/libs/json-api-nestjs/src/lib/factory/ajv/utils/input-body-post-schema.ts b/libs/json-api-nestjs/src/lib/factory/ajv/utils/input-body-post-schema.ts
@@ -13,6 +13,7 @@ export function inputBodyPostSchema(
     relationType: {
       [key: string]: Function | string;
     };
+    relationUuids: { [key: string]: { [key: string]: boolean } };
   }
 ): typeof inputBodySchemaJson {
   const json: typeof inputBodySchemaJson = JSON.parse(
@@ -23,7 +24,7 @@ export function inputBodyPostSchema(
     camelToKebab(getEntityName(entity))
   );
 
-  const relDataType = {
+  const relDataType: Record<string, any> = {
     type: 'object',
     properties: {
       data: {
@@ -103,13 +104,41 @@ export function inputBodyPostSchema(
     ...attributes,
   };
 
+  const uuidRelations = arrayPropsConfig.relationUuids || {};
   const relationships = Object.keys(relationsField).reduce((acum, item) => {
+    const currentRelDataType = {
+      [item]: {
+        ...relDataType,
+        properties: {
+          ...relDataType.properties,
+          data: {
+            ...relDataType.properties.data,
+            properties: {
+              ...relDataType.properties.data.properties,
+              id: {
+                ...relDataType.properties.data.properties.id,
+                pattern: uuidRelations[item]?.id
+                  ? '^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$'
+                  : '^\\d+$',
+                ...(uuidRelations[item]?.id
+                  ? {
+                      minLength: 36,
+                      maxLength: 36,
+                    }
+                  : {}),
+              },
+            },
+          },
+        },
+      },
+    };
+
     const resultSchema = {
-      ...relDataType.properties.data,
+      ...currentRelDataType[item].properties.data,
       properties: {
-        ...relDataType.properties.data.properties,
+        ...currentRelDataType[item].properties.data.properties,
         type: {
-          ...relDataType.properties.data.properties.type,
+          ...currentRelDataType[item].properties.data.properties.type,
           ...(arrayPropsConfig.relationType[item]
             ? {
                 enum: [
@@ -124,9 +153,9 @@ export function inputBodyPostSchema(
     };
 
     acum[item] = {
-      ...relDataType,
+      ...currentRelDataType[item],
       properties: {
-        ...relDataType.properties,
+        ...currentRelDataType[item].properties,
         data:
           Reflect.getMetadata('design:type', entity['prototype'], item) ===
           Array
@@ -138,6 +167,7 @@ export function inputBodyPostSchema(
             : resultSchema,
       },
     };
+
     return acum;
   }, {});
 

Original file line number	Diff line number	Diff line change
`@@ -50,7 +50,7 @@ const Bindings: BindingsConfig = {`
`50`	`50`	`{`
`51`	`51`	`property: PARAMS_RESOURCE_ID,`
`52`	`52`	`decorator: Param,`
`53`		`- mixins: [idPipeMixin],`
	`53`	`+ mixins: [],`
`54`	`54`	`},`
`55`	`55`	`{`
`56`	`56`	`decorator: Query,`
`@@ -72,7 +72,7 @@ const Bindings: BindingsConfig = {`
`72`	`72`	`{`
`73`	`73`	`property: PARAMS_RESOURCE_ID,`
`74`	`74`	`decorator: Param,`
`75`		`- mixins: [idPipeMixin],`
	`75`	`+ mixins: [],`
`76`	`76`	`},`
`77`	`77`	`],`
`78`	`78`	`},`
`@@ -97,7 +97,7 @@ const Bindings: BindingsConfig = {`
`97`	`97`	`{`
`98`	`98`	`property: PARAMS_RESOURCE_ID,`
`99`	`99`	`decorator: Param,`
`100`		`- mixins: [idPipeMixin],`
	`100`	`+ mixins: [],`
`101`	`101`	`},`
`102`	`102`	`{`
`103`	`103`	`decorator: Body,`
`@@ -114,7 +114,7 @@ const Bindings: BindingsConfig = {`
`114`	`114`	`{`
`115`	`115`	`property: PARAMS_RESOURCE_ID,`
`116`	`116`	`decorator: Param,`
`117`		`- mixins: [idPipeMixin],`
	`117`	`+ mixins: [],`
`118`	`118`	`},`
`119`	`119`	`{`
`120`	`120`	`property: PARAMS_RELATION_NAME,`
`@@ -132,7 +132,7 @@ const Bindings: BindingsConfig = {`
`132`	`132`	`{`
`133`	`133`	`property: PARAMS_RESOURCE_ID,`
`134`	`134`	`decorator: Param,`
`135`		`- mixins: [idPipeMixin],`
	`135`	`+ mixins: [],`
`136`	`136`	`},`
`137`	`137`	`{`
`138`	`138`	`property: PARAMS_RELATION_NAME,`
`@@ -154,7 +154,7 @@ const Bindings: BindingsConfig = {`
`154`	`154`	`{`
`155`	`155`	`property: PARAMS_RESOURCE_ID,`
`156`	`156`	`decorator: Param,`
`157`		`- mixins: [idPipeMixin],`
	`157`	`+ mixins: [],`
`158`	`158`	`},`
`159`	`159`	`{`
`160`	`160`	`property: PARAMS_RELATION_NAME,`
`@@ -176,7 +176,7 @@ const Bindings: BindingsConfig = {`
`176`	`176`	`{`
`177`	`177`	`property: PARAMS_RESOURCE_ID,`
`178`	`178`	`decorator: Param,`
`179`		`- mixins: [idPipeMixin],`
	`179`	`+ mixins: [],`
`180`	`180`	`},`
`181`	`181`	`{`
`182`	`182`	`property: PARAMS_RELATION_NAME,`