Merge pull request #8748 from ever-co/fix/package-constants

[Refactor] Package Utils/Constants

apps/api/src/plugin-config.ts

@@ -1,12 +1,7 @@
 import * as path from 'path';
 import * as chalk from 'chalk';
-import {
-	ApplicationPluginConfig,
-	DEFAULT_API_PORT,
-	DEFAULT_GRAPHQL_API_PATH,
-	DEFAULT_API_HOST,
-	DEFAULT_API_BASE_URL
-} from '@gauzy/common';
+import { ApplicationPluginConfig } from '@gauzy/common';
+import { DEFAULT_API_PORT, DEFAULT_GRAPHQL_API_PATH, DEFAULT_API_HOST, DEFAULT_API_BASE_URL } from '@gauzy/constants';
 import {
 	dbTypeOrmConnectionConfig,
 	dbMikroOrmConnectionConfig,
@@ -61,7 +56,7 @@ console.log('Plugin Config -> assetPublicPath: ' + assetPublicPath);
 console.log('DB Synchronize: ' + process.env.DB_SYNCHRONIZE);
 
 /**
- * Application plugin configuration
+ * Application plugin configuration for production environment.
  */
 export const pluginConfig: ApplicationPluginConfig = {
 	apiConfigOptions: {

packages/common/package.json

@@ -28,6 +28,7 @@
 	},
 	"dependencies": {
 		"@apollo/server": "^4.11.3",
+		"@gauzy/constants": "^0.1.0",
 		"@gauzy/contracts": "^0.1.0",
 		"@mikro-orm/nestjs": "^6.0.2",
 		"@nestjs/common": "^10.4.15",

packages/common/src/index.ts

@@ -1,7 +1,6 @@
 /**
  * Public API Surface of @gauzy/common
  */
-export * from './lib/constants';
 export * from './lib/decorators';
 export * from './lib/enums';
 export * from './lib/guards';

packages/common/src/lib/decorators/feature-flag.decorator.ts

@@ -1,5 +1,5 @@
 import { SetMetadata } from '@nestjs/common';
+import { FEATURE_METADATA } from '@gauzy/constants';
 import { FeatureEnum } from '@gauzy/contracts';
-import { FEATURE_METADATA } from './../constants';
 
 export const FeatureFlag = (feature: FeatureEnum) => SetMetadata(FEATURE_METADATA, feature);

packages/common/src/lib/decorators/public.decorator.ts

@@ -1,5 +1,5 @@
 import { CustomDecorator, SetMetadata } from '@nestjs/common';
-import { PUBLIC_METHOD_METADATA } from './../constants';
+import { PUBLIC_METHOD_METADATA } from '@gauzy/constants';
 
 /**
  * Decorator that assigns metadata to the class/function using the
@@ -12,4 +12,4 @@ import { PUBLIC_METHOD_METADATA } from './../constants';
  *
  * @publicApi
  */
-export const Public = (): CustomDecorator => SetMetadata(PUBLIC_METHOD_METADATA, true);
+export const Public = (): CustomDecorator => SetMetadata(PUBLIC_METHOD_METADATA, true);

packages/common/src/lib/guards/feature-flag-enabled.guard.ts

@@ -1,12 +1,7 @@
-import {
-	CanActivate,
-	ExecutionContext,
-	Injectable,
-	NotFoundException,
-} from '@nestjs/common';
+import { CanActivate, ExecutionContext, Injectable, NotFoundException } from '@nestjs/common';
 import { Reflector } from '@nestjs/core';
+import { FEATURE_METADATA } from '@gauzy/constants';
 import { FeatureEnum, IAuthenticationFlagFeatures } from '@gauzy/contracts';
-import { FEATURE_METADATA } from '../constants';
 
 /**
  * Check if a specific feature is enabled based on the environment variable.
@@ -15,7 +10,7 @@ import { FEATURE_METADATA } from '../constants';
  * @returns True if the feature is enabled, otherwise false.
  */
 const featureEnabled = (feature: Extract<keyof IAuthenticationFlagFeatures, string>) => {
-    return process.env[feature] !== 'false';
+	return process.env[feature] !== 'false';
 };
 
 /**
@@ -44,7 +39,7 @@ export const flagFeatures: IAuthenticationFlagFeatures = {
 	FEATURE_MICROSOFT_LOGIN: featureEnabled(FeatureEnum.FEATURE_MICROSOFT_LOGIN),
 
 	/** Flag indicating whether LinkedIn login is enabled. */
-	FEATURE_LINKEDIN_LOGIN: featureEnabled(FeatureEnum.FEATURE_LINKEDIN_LOGIN),
+	FEATURE_LINKEDIN_LOGIN: featureEnabled(FeatureEnum.FEATURE_LINKEDIN_LOGIN)
 };
 
 /**
@@ -63,19 +58,19 @@ export class FeatureFlagEnabledGuard implements CanActivate {
 	 */
 	async canActivate(context: ExecutionContext) {
 		/*
-		* Retrieve metadata for a specified key for a specified set of features
-		*/
+		 * Retrieve metadata for a specified key for a specified set of features
+		 */
 		const flag = this._reflector.getAllAndOverride<FeatureEnum>(FEATURE_METADATA, [
 			context.getHandler(), // Returns a reference to the handler (method) that will be invoked next in the request pipeline.
-			context.getClass(), // Returns the *type* of the controller class which the current handler belongs to.
+			context.getClass() // Returns the *type* of the controller class which the current handler belongs to.
 		]);
 		if (!!flagFeatures[flag]) {
 			return true;
 		}
 
 		/**
-		* If the feature is not enabled, throw a NotFoundException.
-		*/
+		 * If the feature is not enabled, throw a NotFoundException.
+		 */
 		const httpContext = context.switchToHttp();
 		const request = httpContext.getRequest();
 		throw new NotFoundException(`Cannot ${request.method} ${request.url}`);

packages/config/package.json

@@ -27,6 +27,8 @@
 		"lib:watch": "yarn nx build config --watch"
 	},
 	"dependencies": {
+		"@gauzy/constants": "^0.1.0",
+		"@gauzy/common": "^0.1.0",
 		"@gauzy/contracts": "^0.1.0",
 		"@gauzy/utils": "^0.1.0",
 		"@mikro-orm/better-sqlite": "^6.4.2",

packages/config/src/lib/default-configuration.ts

@@ -2,13 +2,9 @@ import * as dotenv from 'dotenv';
 dotenv.config();
 
 import * as path from 'path';
-import {
-	DEFAULT_API_HOST,
-	DEFAULT_API_PORT,
-	DEFAULT_API_BASE_URL,
-	DEFAULT_GRAPHQL_API_PATH,
-	ApplicationPluginConfig
-} from '@gauzy/common';
+import { ApplicationPluginConfig } from '@gauzy/common';
+import { DEFAULT_API_HOST, DEFAULT_API_PORT, DEFAULT_API_BASE_URL, DEFAULT_GRAPHQL_API_PATH } from '@gauzy/constants';
+import {} from '@gauzy/contracts';
 import { dbTypeOrmConnectionConfig, dbMikroOrmConnectionConfig, dbKnexConnectionConfig } from './database';
 
 process.cwd();

packages/constants/src/index.ts

@@ -1,2 +1,7 @@
-export * from './lib/task';
+export * from './lib/ai';
+export * from './lib/api';
+export * from './lib/code';
+export * from './lib/github';
+export * from './lib/reflect-metadata';
 export * from './lib/organization';
+export * from './lib/task';

packages/constants/src/lib/ai.ts

@@ -0,0 +1,4 @@
+/**
+ * Injection token for Gauzy AI configuration.
+ */
+export const GAUZY_AI_CONFIG_TOKEN = 'GAUZY_AI_CONFIG_TOKEN';

packages/constants/src/lib/api.ts

@@ -0,0 +1,7 @@
+/**
+ * API-related default constants used across all packages.
+ */
+export const DEFAULT_API_PORT = 3000;
+export const DEFAULT_API_HOST = '127.0.0.1';
+export const DEFAULT_API_BASE_URL = `http://${DEFAULT_API_HOST}:${DEFAULT_API_PORT}`;
+export const DEFAULT_GRAPHQL_API_PATH = 'graphql';

packages/constants/src/lib/code.ts

@@ -0,0 +1,10 @@
+/**
+ * Represents the default length of generated alphanumeric codes.
+ */
+export const ALPHA_NUMERIC_CODE_LENGTH = 6;
+
+/**
+ * Represents a demo or magic code that allows authentication without a password.
+ * Typically used for demo environments or special login scenarios.
+ */
+export const DEMO_PASSWORD_LESS_MAGIC_CODE = '123456';

packages/constants/src/lib/github.ts

@@ -0,0 +1,12 @@
+/**
+ * Sync tag constants used to categorize synchronization sources.
+ */
+export const SyncTags = {
+	GITHUB: 'GitHub',
+	GAUZY: 'Gauzy'
+} as const;
+
+/**
+ * Type definition for valid sync tag values.
+ */
+export type SyncTag = (typeof SyncTags)[keyof typeof SyncTags];

packages/constants/src/lib/reflect-metadata.ts

@@ -0,0 +1,7 @@
+/**
+ * Metadata keys used for decorators and security features.
+ */
+export const PUBLIC_METHOD_METADATA = '__public:route__';
+export const ROLES_METADATA = '__roles__';
+export const PERMISSIONS_METADATA = '__permissions__';
+export const FEATURE_METADATA = '__feature__';