feat(shared-model): generate models from graphql schema (#670)

apps/api/dev-tokens.md

@@ -10,5 +10,5 @@ application of our AAD.
 | testuser     | c0cc4404-7907-4480-86d3-ba4bfc513c6d | Test                          | User                        | testuser@kordis-leitstelle.de | testorganization (dff7584efe2c174eee8bae45) | `eyJhbGciOiJub25lIiwidHlwIjoiSldUIn0.eyJvaWQiOiIxMjM0IiwiZW1haWxzIjpbInRlc3R1c2VyQHRlc3QuY29tIl0sImdpdmVuX25hbWUiOiJUZXN0IiwiZmFtaWx5X25hbWUiOiJVc2VyIDEifQ.` |
 
 The claims will be mapped to the
-[AuthUser](../../libs/shared/auth/src/lib/auth-user.model.ts) Model in the
+[AuthUser](../../libs/shared/model/src/lib/auth-user.model.ts) Model in the
 [AuthInterceptor](../../libs/api/auth/src/lib/interceptors/auth.interceptor.ts).

apps/api/project.json

@@ -38,6 +38,25 @@
 				}
 			}
 		},
+		"build-generate-schema-script": {
+			"executor": "@nx/webpack:webpack",
+			"outputs": ["{options.outputPath}"],
+			"options": {
+				"target": "node",
+				"compiler": "tsc",
+				"outputPath": "dist/apps/api-generate-schema",
+				"main": "apps/api/src/generate-schema.ts",
+				"tsConfig": "apps/api/tsconfig.app.json",
+				"webpackConfig": "apps/api/webpack.config.js"
+			}
+		},
+		"generate-schema": {
+			"executor": "@nx/js:node",
+			"options": {
+				"buildTarget": "api:build-generate-schema-script",
+				"watch": false
+			}
+		},
 		"lint": {
 			"executor": "@nx/eslint:lint",
 			"outputs": ["{options.outputFile}"]

apps/api/src/app/app.module.ts

@@ -41,10 +41,7 @@ const UTILITY_MODULES = [
 			imports: [ConfigModule],
 			driver: ApolloDriver,
 			useFactory: (config: ConfigService) => ({
-				autoSchemaFile:
-					config.get('NODE_ENV') !== 'production'
-						? path.join(process.cwd(), 'apps/api/src/schema.gql')
-						: true,
+				autoSchemaFile: true,
 				subscriptions: {
 					'graphql-ws': true,
 				},

apps/api/src/generate-schema.ts

@@ -0,0 +1,21 @@
+import { NestFactory } from '@nestjs/core';
+import { GraphQLSchemaHost } from '@nestjs/graphql';
+import { writeFileSync } from 'fs';
+import { printSchema } from 'graphql/utilities';
+import { join } from 'path';
+
+import { AppModule } from './app/app.module';
+
+const generateSchema = async (): Promise<void> => {
+	const app = await NestFactory.create(AppModule, { logger: false });
+	await app.init();
+
+	const { schema } = app.get(GraphQLSchemaHost);
+	const outputPath = join(process.cwd(), 'dist/schema.gql');
+	writeFileSync(outputPath, printSchema(schema));
+	await app.close();
+	// eslint-disable-next-line no-console
+	console.log(`Scheme generated successfully at ${outputPath}`);
+};
+// eslint-disable-next-line no-console
+generateSchema().catch(console.log);

codegen.yml

@@ -0,0 +1,6 @@
+overwrite: true
+schema: 'dist/schema.gql'
+generates:
+  libs/shared/model/src/lib/gql.model.ts:
+    plugins:
+      - typescript

libs/api/auth/src/lib/auth-strategies/verify-aadb2c-jwt.strategy.ts

@@ -5,7 +5,7 @@ import * as jwt from 'jsonwebtoken';
 import jwksClient from 'jwks-rsa';
 
 import { KordisLogger } from '@kordis/api/observability';
-import { AuthUser } from '@kordis/shared/auth';
+import { AuthUser } from '@kordis/shared/model';
 
 import { VerifyAuthUserStrategy } from './verify-auth-user.strategy';
 

libs/api/auth/src/lib/auth-strategies/verify-auth-user.strategy.ts

@@ -1,6 +1,6 @@
 import { Request } from 'express';
 
-import { AuthUser } from '@kordis/shared/auth';
+import { AuthUser } from '@kordis/shared/model';
 
 export abstract class VerifyAuthUserStrategy {
 	/*

libs/api/auth/src/lib/auth-strategies/verify-dev-bearer.strategy.ts

@@ -1,6 +1,6 @@
 import { Request } from 'express';
 
-import { AuthUser } from '@kordis/shared/auth';
+import { AuthUser } from '@kordis/shared/model';
 
 import { VerifyAuthUserStrategy } from './verify-auth-user.strategy';
 

libs/api/auth/src/lib/decorators/user.decorator.spec.ts

@@ -5,7 +5,7 @@ import {
 	createGqlContextForRequest,
 	createParamDecoratorFactory,
 } from '@kordis/api/test-helpers';
-import { AuthUser } from '@kordis/shared/auth';
+import { AuthUser } from '@kordis/shared/model';
 
 import { User } from './user.decorator';
 

libs/api/auth/src/lib/interceptors/auth.interceptor.spec.ts

@@ -7,7 +7,7 @@ import {
 	createGqlContextForRequest,
 	createHttpContextForRequest,
 } from '@kordis/api/test-helpers';
-import { AuthUser } from '@kordis/shared/auth';
+import { AuthUser } from '@kordis/shared/model';
 
 import { VerifyAuthUserStrategy } from '../auth-strategies/verify-auth-user.strategy';
 import { AuthInterceptor } from './auth.interceptor';

libs/api/observability/src/lib/interceptors/sentry-otel-user-context.interceptor.spec.ts

@@ -6,7 +6,7 @@ import { Observable, firstValueFrom, of } from 'rxjs';
 
 import { KordisRequest } from '@kordis/api/shared';
 import { createGqlContextForRequest } from '@kordis/api/test-helpers';
-import { AuthUser } from '@kordis/shared/auth';
+import { AuthUser } from '@kordis/shared/model';
 
 import { SentryOTelUserContextInterceptor } from './sentry-otel-user-context.interceptor';
 

libs/api/observability/src/lib/interceptors/sentry-otel-user-context.interceptor.ts

@@ -10,7 +10,7 @@ import * as Sentry from '@sentry/node';
 import { Observable } from 'rxjs';
 
 import { KordisGqlContext, KordisRequest } from '@kordis/api/shared';
-import { AuthUser } from '@kordis/shared/auth';
+import { AuthUser } from '@kordis/shared/model';
 
 @Injectable()
 export class SentryOTelUserContextInterceptor implements NestInterceptor {

libs/api/shared/src/lib/models/request.model.ts

@@ -1,6 +1,6 @@
 import { Request } from 'express';
 
-import { AuthUser } from '@kordis/shared/auth';
+import { AuthUser } from '@kordis/shared/model';
 
 export interface KordisGqlContext {
 	req: KordisRequest;

libs/shared/auth/project.json → libs/shared/model/project.json

@@ -1,7 +1,7 @@
 {
-	"name": "shared-auth",
+	"name": "shared-model",
 	"$schema": "../../../node_modules/nx/schemas/project-schema.json",
-	"sourceRoot": "libs/shared/auth/src",
+	"sourceRoot": "libs/shared/model/src",
 	"projectType": "library",
 	"targets": {
 		"lint": {

libs/shared/model/src/lib/gql.model.ts

@@ -0,0 +1,101 @@
+export type Maybe<T> = T | null;
+export type InputMaybe<T> = Maybe<T>;
+export type Exact<T extends { [key: string]: unknown }> = {
+	[K in keyof T]: T[K];
+};
+export type MakeOptional<T, K extends keyof T> = Omit<T, K> & {
+	[SubKey in K]?: Maybe<T[SubKey]>;
+};
+export type MakeMaybe<T, K extends keyof T> = Omit<T, K> & {
+	[SubKey in K]: Maybe<T[SubKey]>;
+};
+export type MakeEmpty<
+	T extends { [key: string]: unknown },
+	K extends keyof T,
+> = { [_ in K]?: never };
+export type Incremental<T> =
+	| T
+	| {
+			[P in keyof T]?: P extends ' $fragmentName' | '__typename' ? T[P] : never;
+	  };
+/** All built-in and custom scalars, mapped to their actual values */
+export type Scalars = {
+	ID: { input: string; output: string };
+	String: { input: string; output: string };
+	Boolean: { input: boolean; output: boolean };
+	Int: { input: number; output: number };
+	Float: { input: number; output: number };
+};
+
+export type AppData = {
+	__typename?: 'AppData';
+	message: Scalars['String']['output'];
+};
+
+export type BBox = {
+	__typename?: 'BBox';
+	bottomRight: Coordinate;
+	topLeft: Coordinate;
+};
+
+export type BBoxInput = {
+	bottomRight: CoordinateInput;
+	topLeft: CoordinateInput;
+};
+
+export type Coordinate = {
+	__typename?: 'Coordinate';
+	lat: Scalars['Float']['output'];
+	lon: Scalars['Float']['output'];
+};
+
+export type CoordinateInput = {
+	lat: Scalars['Float']['input'];
+	lon: Scalars['Float']['input'];
+};
+
+export type Mutation = {
+	__typename?: 'Mutation';
+	createOrganization: Organization;
+	updateOrganizationGeoSettings: Organization;
+};
+
+export type MutationCreateOrganizationArgs = {
+	geoSettings: OrganizationGeoSettingsInput;
+	name: Scalars['String']['input'];
+};
+
+export type MutationUpdateOrganizationGeoSettingsArgs = {
+	geoSettings: OrganizationGeoSettingsInput;
+	id: Scalars['String']['input'];
+};
+
+export type Organization = {
+	__typename?: 'Organization';
+	createdAt: Scalars['String']['output'];
+	geoSettings: OrganizationGeoSettings;
+	id: Scalars['String']['output'];
+	name: Scalars['String']['output'];
+	updatedAt: Scalars['String']['output'];
+};
+
+export type OrganizationGeoSettings = {
+	__typename?: 'OrganizationGeoSettings';
+	bbox: BBox;
+	centroid: Coordinate;
+};
+
+export type OrganizationGeoSettingsInput = {
+	bbox: BBoxInput;
+	centroid: CoordinateInput;
+};
+
+export type Query = {
+	__typename?: 'Query';
+	data: AppData;
+	organization: Organization;
+};
+
+export type QueryOrganizationArgs = {
+	id: Scalars['String']['input'];
+};

libs/shared/auth/tsconfig.lib.json → libs/shared/model/tsconfig.lib.json

@@ -5,6 +5,6 @@
 		"declaration": true,
 		"types": ["node"]
 	},
-	"include": ["src/**/*.ts", "../../../reset.d.ts"],
-	"exclude": ["jest.config.ts", "src/**/*.spec.ts", "src/**/*.test.ts"]
+	"include": ["src/**/*.ts"],
+	"exclude": ["src/**/*.spec.ts", "src/**/*.test.ts"]
 }

libs/spa/auth/src/lib/components/dev-login.component.ts

@@ -2,7 +2,7 @@ import { ChangeDetectionStrategy, Component, Inject } from '@angular/core';
 import { FormBuilder, Validators } from '@angular/forms';
 import { Router } from '@angular/router';
 
-import { AuthUser } from '@kordis/shared/auth';
+import { AuthUser } from '@kordis/shared/model';
 
 import { AUTH_SERVICE } from '../services/auth-service';
 import { DevAuthService } from '../services/dev-auth.service';

libs/spa/auth/src/lib/services/auth-service.ts

@@ -1,12 +1,14 @@
 import { InjectionToken } from '@angular/core';
 import { Observable } from 'rxjs';
 
-import { AuthUser } from '@kordis/shared/auth';
+import { AuthUser } from '@kordis/shared/model';
 
 export interface AuthService {
 	readonly user$: Observable<AuthUser | null>;
 	readonly isAuthenticated$: Observable<boolean>;
+
 	login(): void;
+
 	logout(): void;
 }
 

libs/spa/auth/src/lib/services/auth.service.ts

@@ -8,7 +8,7 @@ import {
 	shareReplay,
 } from 'rxjs';
 
-import { AuthUser } from '@kordis/shared/auth';
+import { AuthUser } from '@kordis/shared/model';
 
 import { AuthService } from './auth-service';
 

libs/spa/auth/src/lib/services/dev-auth.service.ts

@@ -2,7 +2,7 @@ import { Injectable } from '@angular/core';
 import { Router } from '@angular/router';
 import { BehaviorSubject, Observable, map } from 'rxjs';
 
-import { AuthUser } from '@kordis/shared/auth';
+import { AuthUser } from '@kordis/shared/model';
 
 import { AuthService } from './auth-service';