fix(icons): make it possible to build without env vars, while fetchin…

…g icons throws an error if env vars are not defined
swisspost · Feb 6, 2025 · 3082fb4 · 3082fb4
1 parent 8b82fbb
commit 3082fb4
Show file tree

Hide file tree

Showing 16 changed files with 30 additions and 33 deletions.
diff --git a/packages/icons/src/fetch.ts b/packages/icons/src/fetch.ts
@@ -1,6 +1,6 @@
+import type { IconSet, JsonReport } from './models/icon.model';
 import iconSets from './iconsets.config';
-import { IconSet, JsonReport } from './models/icon.model';
-
+import { checkEnvVarsExist } from './utilities/environment';
 import { setup } from './utilities/download/setup';
 import { getBaseReport, coloredLogMessage } from './utilities/shared';
 import { fetchPage } from './utilities/download/fetchPage';
@@ -9,8 +9,6 @@ import { format } from './utilities/download/format';
 import { updateReport, writeReport } from './utilities/download/report';
 import buildSVGs from './utilities/build';
 
-import { MESSAGE_ENV_VARS_MISSING_ERROR } from './utilities/constants';
-
 async function fetchSVGs() {
   setup();
 
@@ -77,9 +75,6 @@ async function downloadIconSet(
   return writeReport(iconSet, report);
 }
 
-// start fetching icons if every iconSet has an "apiUrl" defined
-if (iconSets.every(iconSet => iconSet.apiUrl)) {
+if (checkEnvVarsExist()) {
   fetchSVGs();
-} else {
-  throw new Error(MESSAGE_ENV_VARS_MISSING_ERROR);
 }
diff --git a/packages/icons/src/iconsets.config.ts b/packages/icons/src/iconsets.config.ts
@@ -1,5 +1,5 @@
+import type { IconSet } from './models/icon.model';
 import path from 'path';
-import { IconSet } from './models/icon.model';
 import { urls } from './utilities/environment';
 import { SOURCE_PATH } from './utilities/constants';
 

diff --git a/packages/icons/src/models/icon.model.ts b/packages/icons/src/models/icon.model.ts
@@ -1,4 +1,4 @@
-import {
+import type {
   Type,
   TypeFilter,
   VariantMIME,

diff --git a/packages/icons/src/utilities/build/createFiles.ts b/packages/icons/src/utilities/build/createFiles.ts
@@ -1,9 +1,9 @@
+import type { IconSetGroups } from '../../models/icon.model';
+import svgoOptions from '../../../svgo.config.ui';
 import fs from 'fs';
 import path from 'path';
 import { HTMLElement, parse } from 'node-html-parser';
 import { optimize } from 'svgo';
-import svgoOptions from '../../../svgo.config.ui';
-import { IconSetGroups } from '../../models/icon.model';
 
 import {
   ID_PREFIX,

diff --git a/packages/icons/src/utilities/build/iconSetGroups.ts b/packages/icons/src/utilities/build/iconSetGroups.ts
@@ -1,7 +1,7 @@
+import type { Icon, JsonReport, IconSetGroups, GroupItem } from '../../models/icon.model';
+import iconSets from '../../iconsets.config';
 import fs from 'fs';
 import path from 'path';
-import iconSets from '../../iconsets.config';
-import { Icon, JsonReport, IconSetGroups, GroupItem } from '../../models/icon.model';
 import { getNameParts } from '../shared';
 
 import { ID_SEPERATOR, ID_UNWANTED_PARTS, UI_ICON_SIZES } from '../constants';

diff --git a/packages/icons/src/utilities/build/index.ts b/packages/icons/src/utilities/build/index.ts
@@ -4,7 +4,6 @@ import { getIconSetGroups } from './iconSetGroups';
 import { createFiles } from './createFiles';
 import { writeReport } from './report';
 import { coloredLogMessage } from '../shared';
-
 import { OUTPUT_PATH, OUTPUT_PATH_ICONS } from '../constants';
 
 const iconOutputDirectory = path.resolve(OUTPUT_PATH_ICONS);

diff --git a/packages/icons/src/utilities/build/report.ts b/packages/icons/src/utilities/build/report.ts
@@ -1,7 +1,7 @@
+import type { OutputIcon, JsonReport, GroupItem, IconSetGroups } from '../../models/icon.model';
 import fs from 'fs';
 import path from 'path';
 import { version } from '../../../package.json';
-import { OutputIcon, JsonReport, GroupItem, IconSetGroups } from '../../models/icon.model';
 import { getBaseReport, sortIcons } from '../shared';
 
 export function writeReport(

diff --git a/packages/icons/src/utilities/constants.ts b/packages/icons/src/utilities/constants.ts
@@ -1,5 +1,5 @@
+import type { JsonReport } from '../models/icon.model';
 import { version } from '../../package.json';
-import { JsonReport } from '../models/icon.model';
 import { coloredLogMessage } from './shared';
 
 export const SOURCE_PATH = 'src/icons';

diff --git a/packages/icons/src/utilities/download/fetchFile.spec.ts b/packages/icons/src/utilities/download/fetchFile.spec.ts
@@ -1,10 +1,10 @@
-import fetch, { Response } from 'node-fetch';
-import {
+import type {
   Businessfield,
   Type,
   TypeFilter,
   VariantMIME,
 } from '../../models/censhare-result-page.model';
+import fetch, { Response } from 'node-fetch';
 import mockFs from 'mock-fs';
 import { fetchFile } from './fetchFile';
 

diff --git a/packages/icons/src/utilities/download/fetchFile.ts b/packages/icons/src/utilities/download/fetchFile.ts
@@ -1,10 +1,10 @@
+import type { Icon } from '../../models/icon.model';
+import svgoOptions from '../../../svgo.config';
 import fetch from 'node-fetch';
 import fs from 'fs';
 import path from 'path';
 import { optimize } from 'svgo';
-import svgoOptions from '../../../svgo.config';
 import { requestInit } from '../environment';
-import { Icon } from '../../models/icon.model';
 
 export async function fetchFile(icon: Icon, output: string) {
   if (!icon.meta.downloadLink) {

diff --git a/packages/icons/src/utilities/download/fetchPage.ts b/packages/icons/src/utilities/download/fetchPage.ts
@@ -1,6 +1,6 @@
+import type { CenshareError, CenshareResultPage } from '../../models/censhare-result-page.model';
 import fetch from 'node-fetch';
 import { requestInit } from '../environment';
-import { CenshareError, CenshareResultPage } from '../../models/censhare-result-page.model';
 import { coloredLogMessage } from '../shared';
 
 /**

diff --git a/packages/icons/src/utilities/download/format.spec.ts b/packages/icons/src/utilities/download/format.spec.ts
@@ -1,6 +1,6 @@
-import testResult from '../../../tests/fixtures/test-result.json';
-import { CenshareResultPage } from '../../models/censhare-result-page.model';
+import type { CenshareResultPage } from '../../models/censhare-result-page.model';
 import { format } from './format';
+import testResult from '../../../tests/fixtures/test-result.json';
 
 describe('format', () => {
   it('Should format the result object to a meaningful data structure', () => {

diff --git a/packages/icons/src/utilities/download/format.ts b/packages/icons/src/utilities/download/format.ts
@@ -1,6 +1,6 @@
+import type { Icon } from '../../models/icon.model';
+import type { CenshareResultPage, CenshareResult } from '../../models/censhare-result-page.model';
 import path from 'path';
-import { CenshareResultPage, CenshareResult } from '../../models/censhare-result-page.model';
-import { Icon } from '../../models/icon.model';
 
 const excludedRanges = [[4000, 7999]];
 const excludedKeywords = ['Piktogramme "Die Post" ab 2017', 'Piktogramme "Die Post" 2017'];

diff --git a/packages/icons/src/utilities/download/setup.ts b/packages/icons/src/utilities/download/setup.ts
@@ -1,5 +1,5 @@
-import fs from 'fs';
 import iconSets from '../../iconsets.config';
+import fs from 'fs';
 
 export function setup() {
   iconSets.forEach(iconsSet => {

diff --git a/packages/icons/src/utilities/environment.ts b/packages/icons/src/utilities/environment.ts
@@ -11,10 +11,6 @@ const pw = process.env.CEN_PASSWORD;
 const proxy = process.env.HTTPS_PROXY;
 const passphrase = Buffer.from(`${user}:${pw}`).toString('base64');
 
-if (!user || !pw) {
-  throw new Error(MESSAGE_ENV_VARS_MISSING_ERROR);
-}
-
 export const urls = {
   post: process.env.CEN_URL_ICONSET_POST ?? '',
   ui: process.env.CEN_URL_ICONSET_UI ?? '',
@@ -26,3 +22,11 @@ export const requestInit: RequestInit = {
   },
   agent: proxy ? new HttpsProxyAgent(proxy) : undefined,
 };
+
+export function checkEnvVarsExist(): boolean {
+  if (!user || !pw || Object.values(urls).some(v => !v)) {
+    throw new Error(MESSAGE_ENV_VARS_MISSING_ERROR);
+  }
+
+  return true;
+}
diff --git a/packages/icons/src/utilities/shared.ts b/packages/icons/src/utilities/shared.ts
@@ -1,6 +1,5 @@
+import type { Icon, OutputIcon, JsonReport } from '../models/icon.model';
 import { styleText } from 'node:util';
-import { Icon, OutputIcon, JsonReport } from '../models/icon.model';
-
 import { REPORT } from './constants';
 
 export function getBaseReport(): JsonReport {