feat: 🔥 [EXL-71] support policy creation onboarding page

.depcheckrc.json

@@ -9,7 +9,7 @@
 		"@commitlint/cli",
 		"@types/node",
 		"stylelint",
-		"@prisma/client",
-		"is-docker"
+		"is-docker",
+		"@prisma/client"
 	]
 }

.npmrc

@@ -1,3 +1,5 @@
 save-exact=true
 stream=true
-strict-peer-dependencies=false
+strict-peer-dependencies=false
+public-hoist-pattern[]=prisma
+public-hoist-pattern[]=@prisma/client

apps/backend/.eslintrc.cjs

@@ -14,4 +14,12 @@ module.exports = {
 
 		'node/no-sync': 'error',
 	},
+	overrides: [
+		{
+			files: ['./src/data/**/*.ts'],
+			rules: {
+				'max-lines': 'off',
+			},
+		},
+	],
 };

apps/backend/src/data/depcheck-data.ts

@@ -0,0 +1,10 @@
+import type { ILibraryData } from '../interfaces/libraries-data';
+
+export const depcheckData: ILibraryData = {
+	name: 'Depcheck',
+	author: 'Djordje Lukic, Junle Li',
+	description: 'Check your npm module for unused dependencies.',
+	types: ['Linters'],
+	categories: ['Dependencies'],
+	language: 'JavaScript',
+};

apps/frontend/src/data/eslint-data.ts → apps/backend/src/data/eslint-data.ts

@@ -1,12 +1,12 @@
-import { LibraryCategory } from '../models/library-category';
-import { LibraryType } from '../models/library-type';
+import type { ILibraryData } from '../interfaces/libraries-data';
 
-export const eslintData = {
+export const eslintData: ILibraryData = {
 	name: 'ESLint',
 	author: 'Nicholas C. Zakas',
 	description: 'Find and fix problems in your JavaScript code.',
-	type: [LibraryType.Linters],
-	category: [LibraryCategory.Code],
+	types: ['Linters'],
+	categories: ['Code'],
+	language: 'JavaScript',
 	rules: {
 		'Array Callback Return': {
 			description: 'Enforce `return` statements in callbacks of array methods',

apps/backend/src/data/inflint-data.ts

@@ -0,0 +1,10 @@
+import type { ILibraryData } from '../interfaces/libraries-data';
+
+export const inflintData: ILibraryData = {
+	name: 'Inflint',
+	author: 'Tal Rofe',
+	description: 'Inflint is a tool which scans and verifies file name conventions.',
+	types: ['Linters'],
+	categories: ['File System'],
+	language: 'Agnostic',
+};

apps/frontend/src/data/libraries-data.ts → apps/backend/src/data/libraries-data.ts

@@ -1,14 +1,14 @@
-import type { ILbirariesData } from '../interfaces/libraries';
+import type { ILibraryData } from '../interfaces/libraries-data';
 import { depcheckData } from './depcheck-data';
 import { eslintData } from './eslint-data';
 import { inflintData } from './inflint-data';
 import { prettierData } from './prettier-data';
 import { stylelintData } from './stylelint-data';
 
-export const librariesData: ILbirariesData = {
-	eslint: eslintData,
-	stylelint: stylelintData,
-	depcheck: depcheckData,
-	prettier: prettierData,
-	inflint: inflintData,
-};
+export const librariesData: ILibraryData[] = [
+	depcheckData,
+	eslintData,
+	inflintData,
+	prettierData,
+	stylelintData,
+];

apps/frontend/src/data/prettier-data.ts → apps/backend/src/data/prettier-data.ts

@@ -1,12 +1,11 @@
-import { LibraryCategory } from '../models/library-category';
-import { LibraryType } from '../models/library-type';
+import type { ILibraryData } from '../interfaces/libraries-data';
 
-export const prettierData = {
+export const prettierData: ILibraryData = {
 	name: 'Prettier',
 	author: 'prettier.io',
 	description: 'Prettier is an opinionated code formatter.',
-	type: [LibraryType.Formatters],
-	category: [LibraryCategory.Code],
+	types: ['Formatters'],
+	categories: ['Code'],
 	rules: {
 		'Print Width': {
 			description: 'Specify the line length that the printer will wrap on.',
@@ -100,4 +99,5 @@ export const prettierData = {
 			configApi: 'singleAttributePerLine',
 		},
 	},
+	language: 'Agnostic',
 };

apps/frontend/src/data/stylelint-data.ts → apps/backend/src/data/stylelint-data.ts

@@ -1,13 +1,13 @@
-import { LibraryCategory } from '../models/library-category';
-import { LibraryType } from '../models/library-type';
+import type { ILibraryData } from '../interfaces/libraries-data';
 
-export const stylelintData = {
+export const stylelintData: ILibraryData = {
 	name: 'Stylelint',
 	author: 'stylelint.io',
 	description:
 		'A mighty, modern linter that helps you avoid errors and enforce conventions in your styles.',
-	type: [LibraryType.Linters],
-	category: [LibraryCategory.Code, LibraryCategory.Styles],
+	types: ['Linters'],
+	categories: ['Code', 'Styles'],
+	language: 'CSSHTML',
 	rules: {
 		'Color No Invalid Hex': {
 			description: 'Disallow invalid hex colors.',

apps/backend/src/interfaces/libraries-data.ts

@@ -0,0 +1,24 @@
+import type { PolicyLibrary } from '@prisma/client';
+
+interface ILibraryRule {
+	readonly description: string;
+	readonly configApi: string;
+	readonly hasAutoFix?: boolean;
+	readonly category?: string;
+}
+
+export type IType = 'Linters' | 'Formatters';
+
+export type ICategory = 'Code' | 'File System' | 'Styles' | 'Dependencies';
+
+export type ILanguage = 'JavaScript' | 'CSSHTML' | 'Agnostic';
+
+export interface ILibraryData {
+	readonly name: PolicyLibrary;
+	readonly author: string;
+	readonly description: string;
+	readonly types: IType[];
+	readonly categories: ICategory[];
+	readonly language: ILanguage;
+	readonly rules?: Record<string, ILibraryRule>;
+}

apps/backend/src/modules/database/inline-policy.service.ts

@@ -1,29 +1,20 @@
 import { Injectable } from '@nestjs/common';
-import type { PolicyLibrary, Prisma } from '@prisma/client';
+import type { PolicyLibrary } from '@prisma/client';
 
 import { PrismaService } from './prisma.service';
 
 @Injectable()
 export class DBInlinePolicyService {
 	constructor(private prisma: PrismaService) {}
 
-	public async createInlinePolicy(groupId: string, label: string, library: PolicyLibrary) {
-		const createdInlinePolicy = await this.prisma.inlinePolicy.create({
-			data: { groupId, label, library },
-			select: { id: true },
-		});
-
-		return createdInlinePolicy.id;
-	}
-
-	public async deleteInlinePolicy(inlinePolicyId: string) {
-		await this.prisma.inlinePolicy.delete({ where: { id: inlinePolicyId } });
-	}
-
-	public async updateConfiguration(inlinePolicyId: string, configuration: Record<string, unknown>) {
-		await this.prisma.inlinePolicy.update({
-			where: { id: inlinePolicyId },
-			data: { configuration: configuration as Prisma.JsonObject },
+	public async createInlinePolicy(
+		groupId: string,
+		label: string,
+		description: string | null,
+		library: PolicyLibrary,
+	) {
+		await this.prisma.inlinePolicy.create({
+			data: { groupId, label, description, library },
 		});
 	}
 
@@ -35,54 +26,21 @@ export class DBInlinePolicyService {
 		return inlinePolicyDB !== null;
 	}
 
-	public async addRule(inlinePolicyId: string, rule: Record<string, unknown>) {
-		const inlinePolicyDB = await this.prisma.inlinePolicy.findUniqueOrThrow({
-			where: { id: inlinePolicyId },
-			select: { rules: true },
+	public async isLabelAvailable(userId: string, label: string) {
+		const record = await this.prisma.inlinePolicy.findFirst({
+			where: { label, group: { userId } },
 		});
 
-		let newInlinePolicyRules: Prisma.JsonObject;
-
-		if (!inlinePolicyDB.rules) {
-			newInlinePolicyRules = rule as Prisma.JsonObject;
-		} else {
-			newInlinePolicyRules = {
-				...(inlinePolicyDB.rules as Prisma.JsonObject),
-				...rule,
-			} as Prisma.JsonObject;
-		}
-
-		await this.prisma.inlinePolicy.update({
-			where: { id: inlinePolicyId },
-			data: { rules: newInlinePolicyRules },
-		});
+		return record === null;
 	}
 
-	public async removeRule(inlinePolicyId: string, ruleName: string) {
-		const inlinePolicyDB = await this.prisma.inlinePolicy.findUniqueOrThrow({
-			where: { id: inlinePolicyId },
-			select: { rules: true },
-		});
-
-		if (!inlinePolicyDB.rules) {
-			return;
-		}
-
-		const rulesWithoutRule = {
-			...(inlinePolicyDB.rules as Prisma.JsonObject),
-			[ruleName]: undefined,
-		};
-
-		await this.prisma.inlinePolicy.update({
-			where: { id: inlinePolicyId },
-			data: { rules: rulesWithoutRule },
-		});
+	public getUserGroupLibraries(groupId: string) {
+		return this.prisma.inlinePolicy.findMany({ where: { groupId }, select: { library: true } });
 	}
 
-	public getConfiguration(inlinePolicyId: string) {
-		return this.prisma.inlinePolicy.findFirst({
-			where: { id: inlinePolicyId },
-			select: { configuration: true },
-		});
+	public async groupHasLibrary(groupId: string, library: PolicyLibrary) {
+		const record = await this.prisma.inlinePolicy.findFirst({ where: { groupId, library } });
+
+		return record !== null;
 	}
 }

apps/backend/src/modules/user/modules/groups/classes/responses.ts

@@ -1,8 +1,9 @@
 import { ApiResponseProperty } from '@nestjs/swagger';
 import { PolicyLibrary } from '@prisma/client';
 
-import type { IGroupInlinePolicies, IGroupInlinePolicy } from '../interfaces/group-policies';
+import { ILanguage } from '@/interfaces/libraries-data';
 
+import type { IGroupInlinePolicies, IGroupInlinePolicy } from '../interfaces/group-policies';
 import type { IUserGroupGetAll, IUserGroupInlinePolicy } from '../interfaces/user-group';
 
 class UserGroupInlinePolicyGetAll implements IUserGroupInlinePolicy {
@@ -71,7 +72,7 @@ class GroupInlinePolicy implements IGroupInlinePolicy {
 		type: String,
 		example: 'JavaScript',
 	})
-	public language!: string;
+	public language!: ILanguage;
 }
 
 export class CreateGroupResponse {

apps/backend/src/modules/user/modules/groups/interfaces/group-policies.ts

@@ -1,7 +1,9 @@
 import type { Group, InlinePolicy } from '@prisma/client';
 
+import type { ILanguage } from '@/interfaces/libraries-data';
+
 export type IGroupInlinePolicy = Pick<InlinePolicy, 'id' | 'label' | 'library'> & {
-	readonly language: string;
+	readonly language: ILanguage;
 };
 
 export interface IGroupInlinePolicies extends Pick<Group, 'description'> {

apps/backend/src/modules/user/modules/groups/queries/handlers/get-inline-policies.handler.ts

@@ -1,9 +1,9 @@
 import { QueryHandler, type IQueryHandler } from '@nestjs/cqrs';
 
 import { DBGroupService } from '@/modules/database/group.service';
+import { librariesData } from '@/data/libraries-data';
 
 import { GetInlinePoliciesContract } from '../contracts/get-inline-policies.contract';
-import { libariesLanguages } from '../../data/libraries';
 
 @QueryHandler(GetInlinePoliciesContract)
 export class GetInlinePoliciesHandler implements IQueryHandler<GetInlinePoliciesContract> {
@@ -17,10 +17,16 @@ export class GetInlinePoliciesHandler implements IQueryHandler<GetInlinePolicies
 			isPageANumber ? parseInt(contract.page!) : 1,
 		);
 
-		data.inlinePolicies = data.inlinePolicies.map((inlinePolicy) => ({
-			...inlinePolicy,
-			language: libariesLanguages[inlinePolicy.library],
-		}));
+		data.inlinePolicies = data.inlinePolicies.map((inlinePolicy) => {
+			const matchingLibraryData = librariesData.find(
+				(libraryData) => libraryData.name === inlinePolicy.library,
+			)!;
+
+			return {
+				...inlinePolicy,
+				language: matchingLibraryData.language,
+			};
+		});
 
 		return data;
 	}