From d368641200cb80c20fb43de0d121a91e8b6bf745 Mon Sep 17 00:00:00 2001 From: Eric NGUYEN Date: Wed, 12 Oct 2022 18:08:35 +0200 Subject: [PATCH] Revert "Move settings to public/svgld-settings.js" This reverts commit 2cf56632155f5378c8819991b1b42ab135cbe384. --- .env.development | 3 +++ .env.production | 3 +++ .env.test | 3 +++ docs/DevDocs/Pages/SmartComponent.md | 16 ++++++++-------- index.html | 1 - public/svgld-settings.d.ts | 4 ---- public/svgld-settings.js | 3 --- src/Components/API/api.test.tsx | 5 ++--- src/Components/API/api.ts | 5 ++--- src/Components/UI/UseWorker.tsx | 5 ++--- src/vite-env.d.ts | 3 +++ tsconfig.json | 2 +- 12 files changed, 27 insertions(+), 26 deletions(-) create mode 100644 .env.development create mode 100644 .env.production create mode 100644 .env.test delete mode 100644 public/svgld-settings.d.ts delete mode 100644 public/svgld-settings.js diff --git a/.env.development b/.env.development new file mode 100644 index 0000000..58cf9aa --- /dev/null +++ b/.env.development @@ -0,0 +1,3 @@ +VITE_API_FETCH_URL=http://localhost:5000 +VITE_API_SET_CONTAINER_LIST_URL=http://localhost:5000/SetContainerList +VITE_API_GET_FEEDBACK_URL=http://localhost:5000/GetFeedback \ No newline at end of file diff --git a/.env.production b/.env.production new file mode 100644 index 0000000..4eb6fb6 --- /dev/null +++ b/.env.production @@ -0,0 +1,3 @@ +VITE_API_FETCH_URL=https://localhost/SmartMenuiserieTemplate/Service.svc/GetSVGLayoutConfiguration +VITE_API_SET_CONTAINER_LIST_URL=https://localhost/SmartMenuiserieTemplate/Service.svc/SetContainerList +VITE_API_GET_FEEDBACK_URL=https://localhost/SmartMenuiserieTemplate/Service.svc/GetFeedback \ No newline at end of file diff --git a/.env.test b/.env.test new file mode 100644 index 0000000..58cf9aa --- /dev/null +++ b/.env.test @@ -0,0 +1,3 @@ +VITE_API_FETCH_URL=http://localhost:5000 +VITE_API_SET_CONTAINER_LIST_URL=http://localhost:5000/SetContainerList +VITE_API_GET_FEEDBACK_URL=http://localhost:5000/GetFeedback \ No newline at end of file diff --git a/docs/DevDocs/Pages/SmartComponent.md b/docs/DevDocs/Pages/SmartComponent.md index fcb283b..e632da8 100644 --- a/docs/DevDocs/Pages/SmartComponent.md +++ b/docs/DevDocs/Pages/SmartComponent.md @@ -26,18 +26,18 @@ Il y deux manières de récupérer les builds du projets: Customiser le build du projet permet de modifier les urls de l'API et de personnaliser des fonctionnalités. -## Configurer l'API +## Configurer les options de build Il y a deux fichiers principaux à configurer : -- `src/assets/svgld-settings.js`: pour configurer les URLs d'API +- `.env.production.local`: pour configurer les URLs d'API - `src/utils/default.ts`: pour configurer les fonctionnalités -Modifiez `public/svgld-settings.js` +Copiez `.env.production` vers `.env.production.local` et modifiez-le comme bon vous semble : -```js -export const API_FETCH_URL = 'http://localhost:5000'; -export const API_SET_CONTAINER_LIST_URL = 'http://localhost:5000/SetContainerList'; -export const API_GET_FEEDBACK_URL = 'http://localhost:5000/GetFeedback'; +``` +VITE_API_FETCH_URL=https://localhost/SmartMenuiserieTemplate/Service.svc/GetSVGLayoutConfiguration +VITE_API_SET_CONTAINER_LIST_URL=https://localhost/SmartMenuiserieTemplate/Service.svc/SetContainerList +VITE_API_GET_FEEDBACK_URL=https://localhost/SmartMenuiserieTemplate/Service.svc/GetFeedback ``` Vous pouvez modifiez `src/utils/default.ts` mais ne le committez pas. @@ -92,7 +92,7 @@ Cliquez sur le menu hamburger et cliquez sur **Download Artifacts** :
- + ``` diff --git a/index.html b/index.html index 67ae223..7342bd5 100644 --- a/index.html +++ b/index.html @@ -9,7 +9,6 @@
- diff --git a/public/svgld-settings.d.ts b/public/svgld-settings.d.ts deleted file mode 100644 index 957f521..0000000 --- a/public/svgld-settings.d.ts +++ /dev/null @@ -1,4 +0,0 @@ - -export declare const API_FETCH_URL: string; -export declare const API_SET_CONTAINER_LIST_URL: string; -export declare const API_GET_FEEDBACK_URL: string; diff --git a/public/svgld-settings.js b/public/svgld-settings.js deleted file mode 100644 index 0937282..0000000 --- a/public/svgld-settings.js +++ /dev/null @@ -1,3 +0,0 @@ -export const API_FETCH_URL = 'http://localhost:5000'; -export const API_SET_CONTAINER_LIST_URL = 'http://localhost:5000/SetContainerList'; -export const API_GET_FEEDBACK_URL = 'http://localhost:5000/GetFeedback'; \ No newline at end of file diff --git a/src/Components/API/api.test.tsx b/src/Components/API/api.test.tsx index 1cb6a09..cf8ae3f 100644 --- a/src/Components/API/api.test.tsx +++ b/src/Components/API/api.test.tsx @@ -1,6 +1,5 @@ /* eslint-disable @typescript-eslint/naming-convention */ import { describe, it, expect } from 'vitest'; -import { API_FETCH_URL } from '../../../public/svgld-settings'; import { AddMethod } from '../../Enums/AddMethod'; import { Orientation } from '../../Enums/Orientation'; import { Position } from '../../Enums/Position'; @@ -21,9 +20,9 @@ const CHARP_WEB_API_RESOURCE_URL = 'SVGLD'; const CSHARP_WEB_API_URL = CSHARP_WEB_API_BASE_URL + CHARP_WEB_API_RESOURCE_URL + '/'; // TODO: Migrate this test to SVGLDWebAPI rather than using test-server/ -describe.concurrent('Test server test', async() => { +describe.concurrent('Test server test', () => { it('Load environment', () => { - const url = API_FETCH_URL; + const url = import.meta.env.VITE_API_FETCH_URL; expect(url).toBe('http://localhost:5000'); }); diff --git a/src/Components/API/api.ts b/src/Components/API/api.ts index e011c48..b366e6e 100644 --- a/src/Components/API/api.ts +++ b/src/Components/API/api.ts @@ -1,4 +1,3 @@ -import { API_FETCH_URL, API_SET_CONTAINER_LIST_URL } from '../../../public/svgld-settings'; import { IConfiguration } from '../../Interfaces/IConfiguration'; import { ISetContainerListRequest } from '../../Interfaces/ISetContainerListRequest'; import { ISetContainerListResponse } from '../../Interfaces/ISetContainerListResponse'; @@ -9,7 +8,7 @@ import { GetCircularReplacerToDotnet } from '../../utils/saveload'; * @returns {Configation} The model of the configuration for the application */ export async function FetchConfiguration(): Promise { - const url = API_FETCH_URL; + const url = import.meta.env.VITE_API_FETCH_URL; // The test library cannot use the Fetch API // @ts-expect-error // eslint-disable-next-line @typescript-eslint/strict-boolean-expressions @@ -35,7 +34,7 @@ export async function FetchConfiguration(): Promise { } export async function SetContainerList(request: ISetContainerListRequest): Promise { - const url = API_SET_CONTAINER_LIST_URL; + const url = import.meta.env.VITE_API_SET_CONTAINER_LIST_URL; const dataParsed = JSON.stringify(request, GetCircularReplacerToDotnet()); // The test library cannot use the Fetch API // @ts-expect-error diff --git a/src/Components/UI/UseWorker.tsx b/src/Components/UI/UseWorker.tsx index ed6b8e2..5047bcb 100644 --- a/src/Components/UI/UseWorker.tsx +++ b/src/Components/UI/UseWorker.tsx @@ -4,7 +4,6 @@ import { IGetFeedbackRequest } from '../../Interfaces/IGetFeedbackRequest'; import { IGetFeedbackResponse } from '../../Interfaces/IGetFeedbackResponse'; import { IMessage } from '../../Interfaces/IMessage'; import { GetCircularReplacerToDotnet } from '../../utils/saveload'; -import { API_GET_FEEDBACK_URL } from '../../../public/svgld-settings'; // eslint-disable-next-line @typescript-eslint/strict-boolean-expressions const myWorker = window.Worker && new Worker('workers/message_worker.js'); @@ -16,7 +15,7 @@ export function UseWorker( // use webworker for the stringify to avoid freezing myWorker.postMessage({ state, - url: API_GET_FEEDBACK_URL + url: import.meta.env.VITE_API_GET_FEEDBACK_URL }); return () => { @@ -38,7 +37,7 @@ export function UseAsync( ApplicationState: state }; const dataParsed = JSON.stringify(request, GetCircularReplacerToDotnet()); - fetch(API_GET_FEEDBACK_URL, { + fetch(import.meta.env.VITE_API_GET_FEEDBACK_URL, { method: 'POST', headers: new Headers({ // eslint-disable-next-line @typescript-eslint/naming-convention diff --git a/src/vite-env.d.ts b/src/vite-env.d.ts index 5119518..3fc526e 100644 --- a/src/vite-env.d.ts +++ b/src/vite-env.d.ts @@ -1,6 +1,9 @@ /// interface ImportMetaEnv { + readonly VITE_API_FETCH_URL: string + readonly VITE_API_SET_CONTAINER_LIST_URL: string + readonly VITE_API_GET_FEEDBACK_URL: string // more env variables... } diff --git a/tsconfig.json b/tsconfig.json index 76cee5e..4b64a19 100644 --- a/tsconfig.json +++ b/tsconfig.json @@ -16,7 +16,7 @@ "noEmit": true, "jsx": "react-jsx" }, - "include": ["src", "public/svgld-settings.d.ts", "public/svgld-settings.ts"], + "include": ["src"], "exclude": ["test-server"], "references": [{ "path": "./tsconfig.node.json" }] }