Merge pull request #1542 from geoadmin/feat-PB-1387-api-as-module

PB-1387: all API files as a package

Author: pakb

package.json

@@ -40,6 +40,7 @@
         "prettier-plugin-packagejson": "catalog:",
         "prettier-plugin-tailwindcss": "catalog:",
         "tsx": "catalog:",
+        "vitest": "catalog:",
         "yaml": "catalog:"
     },
     "engines": {

packages/api/eslint.config.mts

@@ -0,0 +1,12 @@
+import defaultConfig from '@swissgeo/config-eslint'
+
+export default [
+    ...defaultConfig,
+    {
+        languageOptions: {
+            parserOptions: {
+                tsconfigRootDir: import.meta.dirname,
+            },
+        },
+    },
+]

packages/api/package.json

@@ -0,0 +1,71 @@
+{
+    "name": "@swissgeo/api",
+    "version": "0.0.1",
+    "description": "API utilities to interact with SWISSGEO's backend services",
+    "type": "module",
+    "exports": {
+        ".": {
+            "types": "./dist/index.d.ts",
+            "import": "./dist/index.js",
+            "require": "./dist/index.umd.cjs"
+        },
+        "./utils": {
+            "types": "./dist/utils.d.ts",
+            "import": "./dist/utils.js",
+            "require": "./dist/utils.umd.cjs"
+        }
+    },
+    "scripts": {
+        "build": "pnpm run type-check && pnpm run generate-types && vite build",
+        "generate-types": "vue-tsc --declaration",
+        "lint": "eslint --fix",
+        "lint:no-fix": "eslint",
+        "prepare": "pnpm run build",
+        "test:unit": "vitest run",
+        "test:unit:watch": "vitest watch",
+        "type-check": "vue-tsc --build"
+    },
+    "dependencies": {
+        "@geoblocks/mapfishprint": "catalog:",
+        "@swissgeo/coordinates": "workspace:*",
+        "@swissgeo/layers": "workspace:*",
+        "@swissgeo/log": "workspace:*",
+        "@swissgeo/numbers": "workspace:*",
+        "@swissgeo/staging-config": "workspace:*",
+        "@swissgeo/theme": "workspace:*",
+        "@tmcw/togeojson": "catalog:",
+        "@turf/turf": "catalog:",
+        "form-data": "catalog:",
+        "jszip": "catalog:",
+        "lodash": "catalog:",
+        "luxon": "catalog:",
+        "pako": "catalog:"
+    },
+    "devDependencies": {
+        "@intlify/core-base": "catalog:",
+        "@microsoft/api-extractor": "catalog:",
+        "@swissgeo/config-eslint": "workspace:*",
+        "@swissgeo/config-prettier": "workspace:*",
+        "@swissgeo/config-typescript": "workspace:*",
+        "@tsconfig/node22": "catalog:",
+        "@types/chai": "catalog:",
+        "@types/geojson": "catalog:",
+        "@types/jsdom": "catalog:",
+        "@types/lodash": "catalog:",
+        "@types/pako": "catalog:",
+        "chai": "catalog:",
+        "eslint": "catalog:",
+        "typescript": "catalog:",
+        "unplugin-dts": "catalog:",
+        "vite": "catalog:",
+        "vite-plugin-vue-devtools": "catalog:",
+        "vite-tsconfig-paths": "catalog:",
+        "vitest": "catalog:",
+        "vue-tsc": "catalog:"
+    },
+    "peerDependencies": {
+        "axios": "catalog:",
+        "ol": "catalog:",
+        "proj4": "catalog:"
+    }
+}

…src/api/__tests__/file-proxy.api.spec.ts …ages/api/src/__tests__/fileProxy.spec.tspackages/viewer/src/api/__tests__/file-proxy.api.spec.ts renamed to packages/api/src/__tests__/fileProxy.spec.ts packages/viewer/src/api/__tests__/file-proxy.api.spec.ts renamed to packages/api/src/__tests__/fileProxy.spec.ts

@@ -1,14 +1,14 @@
 import { describe, expect, it } from 'vitest'
 
-import { transformFileUrl } from '@/api/file-proxy.api'
+import fileProxyAPI from '@/fileProxy'
 
 describe('Serice-proxy tests', () => {
     describe('transformFileUrl', () => {
         it('returns undefined when the input is invalid', () => {
-            expect(transformFileUrl('some non URL string')).to.be.undefined
+            expect(fileProxyAPI.transformFileUrl('some non URL string')).to.be.undefined
         })
         it('returns the URL transformed', () => {
-            expect(transformFileUrl('http://some-file.kml?one=1&foo=bar')).to.eq(
+            expect(fileProxyAPI.transformFileUrl('http://some-file.kml?one=1&foo=bar')).to.eq(
                 `http/some-file.kml${encodeURIComponent('?one=1&foo=bar')}`
             )
         })

…wer/src/api/__tests__/search.api.spec.ts packages/api/src/__tests__/search.spec.tspackages/viewer/src/api/__tests__/search.api.spec.ts renamed to packages/api/src/__tests__/search.spec.ts packages/viewer/src/api/__tests__/search.api.spec.ts renamed to packages/api/src/__tests__/search.spec.ts

@@ -1,18 +1,18 @@
 import { describe, expect, it } from 'vitest'
 
-import { sanitizeTitle } from '@/api/search.api'
+import searchAPI from '@/search'
 
 describe('Builds object by extracting all relevant attributes from the backend', () => {
     describe('FeatureSearchResult.getSimpleTitle', () => {
         it('Returns title removing HTML', () => {
             const expectedResult = 'Some irrelevant stuff 123 Test'
             const expectedResultWrappedInHtml = '<i>Some irrelevant stuff</i> <b>123 Test</b>'
-            expect(sanitizeTitle(expectedResultWrappedInHtml)).to.eq(expectedResult)
+            expect(searchAPI.sanitizeTitle(expectedResultWrappedInHtml)).to.eq(expectedResult)
         })
 
         it('Returns title as is if no HTML is present', () => {
             const expectedResult = 'Test 123 Test'
-            expect(sanitizeTitle(expectedResult)).to.eq(expectedResult)
+            expect(searchAPI.sanitizeTitle(expectedResult)).to.eq(expectedResult)
         })
     })
 })

packages/api/src/config/log.ts

@@ -0,0 +1,13 @@
+import { LogPreDefinedColor } from '@swissgeo/log'
+
+const LogColorPerService = {
+    feedback: LogPreDefinedColor.Amber,
+    fileProxy: LogPreDefinedColor.Green,
+    files: LogPreDefinedColor.Indigo,
+    height: LogPreDefinedColor.Orange,
+    icons: LogPreDefinedColor.Lime,
+    lv03Reframe: LogPreDefinedColor.Zinc,
+    print: LogPreDefinedColor.Emerald,
+    qrCode: LogPreDefinedColor.Purple,
+}
+export default LogColorPerService