2513: Rename api-client to shared and open a new subfolder api (#2595)

* 2513: Rename api-client to shared and create a subfolder api * 2513: removed not related files * 2513: removed not related files * 2513: fix merge * 2513: Fix merge * 2513: Tidy up * 2513: Exclude folders --------- Co-authored-by: Steffen Kleinle <[email protected]>
digitalfabrik · Jan 25, 2024 · 2350b8e · 2350b8e
1 parent da58dd1
commit 2350b8e
Show file tree

Hide file tree

Showing 389 changed files with 542 additions and 650 deletions.
diff --git a/.prettierrc b/.prettierrc
@@ -8,8 +8,8 @@
   "jsxSingleQuote": true,
   "endOfLine": "auto",
   "importOrder": [
-    "^(?!(api-client|build-configs|translations|\\.)).*",
-    "^(api-client|build-configs|translations)",
+    "^(?!(shared|build-configs|translations|\\.)).*",
+    "^(shared|build-configs|translations)",
     "^(\\.)+(\\/)+"
   ],
   "importOrderSeparation": true

diff --git a/README.md b/README.md
@@ -41,7 +41,7 @@ Both projects are whitelabelled with different [build configs](build-configs/REA
 There are also separate sub-projects used by both projects:
 
 - **[translations](translations/README.md)**: Translated texts and utilities to manage them
-- **[api-client](api-client/README.md)**: Implementation of the endpoints (v3) of the integreat cms
+- **[shared](shared/README.md)**: Contains common shared utilities, for example related to implementation of the endpoints (v3) of the integreat cms
 - **[build-configs](build-configs/README.md)**: Configuration files to build different versions of the apps
 
 ## Getting Started

diff --git a/api-client/.vscode/settings.json b/api-client/.vscode/settings.json
diff --git a/jest.config.ts b/jest.config.ts
@@ -3,7 +3,7 @@ import type { Config } from '@jest/types'
 const config: Partial<Config.GlobalConfig> = {
   rootDir: '.',
   verbose: true,
-  projects: ['web', 'native', 'api-client', 'translations'],
+  projects: ['web', 'native', 'shared', 'translations'],
   reporters: [
     ['default', {}],
     [

diff --git a/native/.idea/integreat-app-native.iml b/native/.idea/integreat-app-native.iml
diff --git a/native/jest.config.ts b/native/jest.config.ts
@@ -7,7 +7,7 @@ const transformNodeModules = [
   '@react-navigation',
   'react-navigation-header-buttons',
   'react-native-blob-util',
-  'api-client',
+  'shared',
   'translations',
   '@sentry/react-native',
   'build-configs',

diff --git a/native/package.json b/native/package.json
@@ -58,7 +58,7 @@
     "@sentry/react-native": "^5.9.1",
     "@sentry/types": "^7.65.0",
     "accordion-collapse-react-native": "^1.1.1",
-    "api-client": "0.0.1",
+    "shared": "0.0.1",
     "build-configs": "0.0.1",
     "htmlparser2": "^9.0.0",
     "i18next": "^23.4.6",

diff --git a/native/src/App.tsx b/native/src/App.tsx
@@ -8,7 +8,8 @@ import { enableScreens } from 'react-native-screens'
 import { HeaderButtonsProvider } from 'react-navigation-header-buttons'
 import { ThemeProvider } from 'styled-components'
 
-import { CLOSE_PAGE_SIGNAL_NAME, REDIRECT_ROUTE, setUserAgent } from 'api-client'
+import { CLOSE_PAGE_SIGNAL_NAME, REDIRECT_ROUTE } from 'shared'
+import { setUserAgent } from 'shared/api'
 import { config } from 'translations'
 
 import Navigator from './Navigator'

diff --git a/native/src/Navigator.tsx b/native/src/Navigator.tsx
@@ -29,8 +29,8 @@ import {
   SEARCH_ROUTE,
   SETTINGS_ROUTE,
   SPRUNGBRETT_OFFER_ROUTE,
-  useLoadAsync,
-} from 'api-client'
+} from 'shared'
+import { useLoadAsync } from 'shared/api'
 
 import Header from './components/Header'
 import RedirectContainer from './components/RedirectContainer'

diff --git a/native/src/__tests__/Navigator.spec.tsx b/native/src/__tests__/Navigator.spec.tsx
@@ -3,7 +3,7 @@ import { NavigationContainer } from '@react-navigation/native'
 import { mocked } from 'jest-mock'
 import React from 'react'
 
-import { CityModelBuilder, ReturnType, useLoadAsync } from 'api-client'
+import { CityModelBuilder, ReturnType, useLoadAsync } from 'shared/api'
 
 import Navigator from '../Navigator'
 import { AppContext } from '../contexts/AppContextProvider'
@@ -17,8 +17,8 @@ jest.mock('styled-components')
 jest.mock('../utils/DefaultDataContainer', () => ({ deleteCity: jest.fn(async () => undefined) }))
 jest.mock('@react-native-community/netinfo')
 jest.mock('../hooks/useLoadCities', () => jest.fn(() => ({ data: cities, error: null })))
-jest.mock('api-client', () => ({
-  ...jest.requireActual('api-client'),
+jest.mock('shared/api', () => ({
+  ...jest.requireActual('shared/api'),
   useLoadAsync: jest.fn(() => ({ data: null, error: null })),
 }))
 jest.mock('../utils/sentry')

diff --git a/native/src/components/AddressInfo.tsx b/native/src/components/AddressInfo.tsx
@@ -4,7 +4,8 @@ import { useTranslation } from 'react-i18next'
 import { Platform } from 'react-native'
 import styled from 'styled-components/native'
 
-import { getExternalMapsLink, LocationModel } from 'api-client'
+import { getExternalMapsLink } from 'shared'
+import { LocationModel } from 'shared/api'
 
 import { ExternalLinkIcon } from '../assets'
 import { contentDirection } from '../constants/contentDirection'

diff --git a/native/src/components/AppStateListener.ts b/native/src/components/AppStateListener.ts
@@ -1,7 +1,7 @@
 import { ReactElement, useEffect } from 'react'
 import { AppState } from 'react-native'
 
-import { RESUME_SIGNAL_NAME, SUSPEND_SIGNAL_NAME } from 'api-client'
+import { RESUME_SIGNAL_NAME, SUSPEND_SIGNAL_NAME } from 'shared'
 
 import sendTrackingSignal from '../utils/sendTrackingSignal'
 

diff --git a/native/src/components/Categories.tsx b/native/src/components/Categories.tsx
@@ -1,9 +1,8 @@
 import React, { ReactElement } from 'react'
 import { View } from 'react-native'
 
-import { CategoriesMapModel, CategoryModel, CityModel } from 'api-client'
-import { CATEGORIES_ROUTE } from 'api-client/src/routes'
-import { RouteInformationType } from 'api-client/src/routes/RouteInformationTypes'
+import { CATEGORIES_ROUTE, RouteInformationType } from 'shared'
+import { CategoriesMapModel, CategoryModel, CityModel } from 'shared/api'
 
 import { URL_PREFIX } from '../constants/webview'
 import TileModel from '../models/TileModel'

diff --git a/native/src/components/CategoryListItem.tsx b/native/src/components/CategoryListItem.tsx
@@ -1,7 +1,7 @@
 import React, { memo, ReactElement } from 'react'
 import styled from 'styled-components/native'
 
-import { CategoryModel } from 'api-client'
+import { CategoryModel } from 'shared/api'
 
 import { contentDirection, isContentDirectionReversalRequired } from '../constants/contentDirection'
 import dimensions from '../constants/dimensions'

diff --git a/native/src/components/CityEntry.tsx b/native/src/components/CityEntry.tsx
@@ -3,7 +3,8 @@ import { Text } from 'react-native'
 import Highlighter from 'react-native-highlight-words'
 import styled from 'styled-components/native'
 
-import { CityModel, normalizeString } from 'api-client'
+import { normalizeString } from 'shared'
+import { CityModel } from 'shared/api'
 
 import testID from '../testing/testID'
 import Pressable from './base/Pressable'

diff --git a/native/src/components/CitySelector.tsx b/native/src/components/CitySelector.tsx
@@ -4,7 +4,8 @@ import { useTranslation } from 'react-i18next'
 import { View } from 'react-native'
 import styled from 'styled-components/native'
 
-import { CityModel, filterSortCities } from 'api-client'
+import { filterSortCities } from 'shared'
+import { CityModel } from 'shared/api'
 
 import buildConfig from '../constants/buildConfig'
 import CityEntry from './CityEntry'

diff --git a/native/src/components/DashboardNavigationTiles.tsx b/native/src/components/DashboardNavigationTiles.tsx
@@ -3,15 +3,15 @@ import { useTranslation } from 'react-i18next'
 import styled from 'styled-components/native'
 
 import {
-  CityModel,
   EVENTS_ROUTE,
   LOCAL_NEWS_TYPE,
   NEWS_ROUTE,
   OFFERS_ROUTE,
   POIS_ROUTE,
   RouteInformationType,
   TU_NEWS_TYPE,
-} from 'api-client'
+} from 'shared'
+import { CityModel } from 'shared/api'
 
 import { CalendarIcon, NewsIcon, OffersIcon, POIsIcon } from '../assets'
 import buildConfig from '../constants/buildConfig'

diff --git a/native/src/components/DatesPageDetail.tsx b/native/src/components/DatesPageDetail.tsx
@@ -3,7 +3,8 @@ import { useTranslation } from 'react-i18next'
 import { View } from 'react-native'
 import styled from 'styled-components'
 
-import { DateModel, MAX_DATE_RECURRENCES, MAX_DATE_RECURRENCES_COLLAPSED } from 'api-client'
+import { MAX_DATE_RECURRENCES, MAX_DATE_RECURRENCES_COLLAPSED } from 'shared'
+import { DateModel } from 'shared/api'
 
 import Collapsible from './Collapsible'
 import PageDetail from './PageDetail'

diff --git a/native/src/components/EmbeddedOffers.tsx b/native/src/components/EmbeddedOffers.tsx
@@ -1,6 +1,7 @@
 import React, { ReactElement } from 'react'
 
-import { MALTE_HELP_FORM_OFFER_ROUTE, OfferModel, SPRUNGBRETT_OFFER_ALIAS } from 'api-client'
+import { MALTE_HELP_FORM_OFFER_ROUTE, SPRUNGBRETT_OFFER_ALIAS } from 'shared'
+import { OfferModel } from 'shared/api'
 
 import MalteHelpFormOffer from './MalteHelpFormOffer'
 import SprungbrettOffer from './SprungbrettOffer'

diff --git a/native/src/components/EventListItem.tsx b/native/src/components/EventListItem.tsx
@@ -3,7 +3,8 @@ import { useTranslation } from 'react-i18next'
 import { SvgProps } from 'react-native-svg'
 import styled from 'styled-components/native'
 
-import { DateModel, DateIcon, EventModel, parseHTML } from 'api-client'
+import { parseHTML } from 'shared'
+import { DateModel, DateIcon, EventModel } from 'shared/api'
 
 import {
   CalendarRecurringIcon,

diff --git a/native/src/components/ExportEventButton.tsx b/native/src/components/ExportEventButton.tsx
@@ -7,7 +7,7 @@ import { PERMISSIONS, requestMultiple } from 'react-native-permissions'
 import { Frequency } from 'rrule'
 import styled from 'styled-components/native'
 
-import { EventModel } from 'api-client'
+import { EventModel } from 'shared/api'
 
 import useSnackbar from '../hooks/useSnackbar'
 import { reportError } from '../utils/sentry'

diff --git a/native/src/components/Failure.tsx b/native/src/components/Failure.tsx
@@ -2,7 +2,7 @@ import React, { ReactElement } from 'react'
 import { useTranslation } from 'react-i18next'
 import styled from 'styled-components/native'
 
-import { ErrorCode } from 'api-client'
+import { ErrorCode } from 'shared/api'
 
 import { NoInternetIcon, SadSmileyIcon, WarningIcon } from '../assets'
 import Icon from './base/Icon'

diff --git a/native/src/components/FeedbackContainer.tsx b/native/src/components/FeedbackContainer.tsx
@@ -1,7 +1,8 @@
 import React, { ReactElement, useEffect, useState } from 'react'
 import styled from 'styled-components/native'
 
-import { createFeedbackEndpoint, FeedbackRouteType, SEND_FEEDBACK_SIGNAL_NAME } from 'api-client'
+import { SEND_FEEDBACK_SIGNAL_NAME } from 'shared'
+import { createFeedbackEndpoint, FeedbackRouteType } from 'shared/api'
 
 import { determineApiUrl } from '../utils/helpers'
 import sendTrackingSignal from '../utils/sendTrackingSignal'

diff --git a/native/src/components/Header.tsx b/native/src/components/Header.tsx
@@ -11,7 +11,6 @@ import {
   EventsRouteType,
   getSlugFromPath,
   LANDING_ROUTE,
-  LanguageModel,
   NEWS_ROUTE,
   POIS_ROUTE,
   PoisRouteType,
@@ -20,8 +19,8 @@ import {
   DISCLAIMER_ROUTE,
   SEARCH_ROUTE,
   SETTINGS_ROUTE,
-  FeedbackRouteType,
-} from 'api-client'
+} from 'shared'
+import { LanguageModel, FeedbackRouteType } from 'shared/api'
 
 import { NavigationProps, RouteProps, RoutesParamsType, RoutesType } from '../constants/NavigationTypes'
 import buildConfig from '../constants/buildConfig'

diff --git a/native/src/components/LanguageNotAvailablePage.tsx b/native/src/components/LanguageNotAvailablePage.tsx
@@ -3,7 +3,7 @@ import { useTranslation } from 'react-i18next'
 import { RefreshControl, Text } from 'react-native'
 import styled from 'styled-components/native'
 
-import { fromError, LanguageModel } from 'api-client'
+import { fromError, LanguageModel } from 'shared/api'
 
 import useCityAppContext from '../hooks/useCityAppContext'
 import useLoadCities from '../hooks/useLoadCities'

diff --git a/native/src/components/MalteHelpFormOffer.tsx b/native/src/components/MalteHelpFormOffer.tsx
@@ -8,10 +8,10 @@ import {
   ContactChannel,
   ContactGender,
   InvalidEmailError,
-  MALTE_HELP_FORM_MAX_COMMENT_LENGTH,
   OfferModel,
   submitMalteHelpForm,
-} from 'api-client'
+  MALTE_HELP_FORM_MAX_COMMENT_LENGTH,
+} from 'shared/api'
 
 import { SecurityIcon, SupportIcon } from '../assets'
 import useSnackbar from '../hooks/useSnackbar'

diff --git a/native/src/components/MapView.tsx b/native/src/components/MapView.tsx
@@ -17,7 +17,7 @@ import {
   clusterLayerId,
   featureLayerId,
   clusterClickZoomFactor,
-} from 'api-client'
+} from 'shared'
 
 import { LocationFixedIcon, LocationNotFixedIcon, LocationOffIcon } from '../assets'
 import { clusterCountLayer, clusterLayer, markerLayer } from '../constants/layers'

diff --git a/native/src/components/MapsAttribution.tsx b/native/src/components/MapsAttribution.tsx
@@ -1,7 +1,7 @@
 import React, { ReactElement, useState } from 'react'
 import styled from 'styled-components/native'
 
-import { openStreeMapCopyright } from 'api-client'
+import { openStreeMapCopyright } from 'shared'
 
 import Link from './Link'
 import Pressable from './base/Pressable'

diff --git a/native/src/components/NearbyCities.tsx b/native/src/components/NearbyCities.tsx
@@ -2,7 +2,8 @@ import React, { ReactElement } from 'react'
 import { useTranslation } from 'react-i18next'
 import styled from 'styled-components/native'
 
-import { CityModel, getNearbyCities } from 'api-client'
+import { getNearbyCities } from 'shared'
+import { CityModel } from 'shared/api'
 
 import { RefreshIcon } from '../assets'
 import useUserLocation from '../hooks/useUserLocation'

diff --git a/native/src/components/News.tsx b/native/src/components/News.tsx
@@ -3,7 +3,8 @@ import { useTranslation } from 'react-i18next'
 import { ScrollView } from 'react-native'
 import styled from 'styled-components/native'
 
-import { ErrorCode, LocalNewsModel, NewsRouteType, NewsType, replaceLinks, TU_NEWS_TYPE, TunewsModel } from 'api-client'
+import { NewsRouteType, NewsType, TU_NEWS_TYPE } from 'shared'
+import { LocalNewsModel, TunewsModel, ErrorCode, replaceLinks } from 'shared/api'
 
 import { NavigationProps } from '../constants/NavigationTypes'
 import { contentAlignment } from '../constants/contentDirection'

diff --git a/native/src/components/NewsHeader.tsx b/native/src/components/NewsHeader.tsx
@@ -2,7 +2,8 @@ import React, { memo, ReactElement } from 'react'
 import { useTranslation } from 'react-i18next'
 import styled from 'styled-components/native'
 
-import { CityModel, LOCAL_NEWS_TYPE, NewsType, TU_NEWS_TYPE } from 'api-client'
+import { LOCAL_NEWS_TYPE, NewsType, TU_NEWS_TYPE } from 'shared'
+import { CityModel } from 'shared/api'
 
 import { TuNewsActiveIcon, TuNewsInactiveIcon } from '../assets'
 import Caption from './Caption'

diff --git a/native/src/components/NewsListItem.tsx b/native/src/components/NewsListItem.tsx
@@ -2,7 +2,7 @@ import React, { ReactElement } from 'react'
 import { useTranslation } from 'react-i18next'
 import styled from 'styled-components/native'
 
-import { LocalNewsModel, TunewsModel } from 'api-client'
+import { LocalNewsModel, TunewsModel } from 'shared/api'
 
 import { ArrowBackIcon } from '../assets'
 import { EXCERPT_MAX_LINES } from '../constants'

diff --git a/native/src/components/OpeningEntry.tsx b/native/src/components/OpeningEntry.tsx
@@ -2,7 +2,7 @@ import React, { ReactElement } from 'react'
 import { useTranslation } from 'react-i18next'
 import styled from 'styled-components/native'
 
-import { TimeSlot } from 'api-client/src/types'
+import { TimeSlot } from 'shared/api/types'
 
 import { contentDirection } from '../constants/contentDirection'
 

diff --git a/native/src/components/OpeningHours.tsx b/native/src/components/OpeningHours.tsx
@@ -4,7 +4,8 @@ import { useTranslation } from 'react-i18next'
 import { Text } from 'react-native'
 import styled from 'styled-components/native'
 
-import { OpeningHoursModel, weekdays } from 'api-client'
+import { weekdays } from 'shared'
+import { OpeningHoursModel } from 'shared/api'
 
 import { contentDirection } from '../constants/contentDirection'
 import Collapsible from './Collapsible'

diff --git a/native/src/components/OrganizationContentInfo.tsx b/native/src/components/OrganizationContentInfo.tsx
@@ -3,7 +3,7 @@ import { Trans, useTranslation } from 'react-i18next'
 import { View } from 'react-native'
 import styled from 'styled-components/native'
 
-import { OrganizationModel } from 'api-client'
+import { OrganizationModel } from 'shared/api'
 
 import HighlightBox from './HighlightBox'
 import Link from './Link'

diff --git a/native/src/components/PoiDetails.tsx b/native/src/components/PoiDetails.tsx
@@ -2,7 +2,8 @@ import React, { ReactElement } from 'react'
 import { useTranslation } from 'react-i18next'
 import styled from 'styled-components/native'
 
-import { GeoJsonPoi, PoiModel } from 'api-client'
+import { GeoJsonPoi } from 'shared'
+import { PoiModel } from 'shared/api'
 
 import { MailIcon, PhoneIcon, PoiThumbnailPlaceholderLarge, WebsiteIcon } from '../assets'
 import AddressInfo from './AddressInfo'

diff --git a/native/src/components/PoiFiltersModal.tsx b/native/src/components/PoiFiltersModal.tsx
@@ -3,7 +3,7 @@ import { useTranslation } from 'react-i18next'
 import { SvgUri } from 'react-native-svg'
 import styled from 'styled-components/native'
 
-import { PoiCategoryModel, PoiModel } from 'api-client'
+import { PoiCategoryModel, PoiModel } from 'shared/api'
 
 import { ClockIcon } from '../assets'
 import Modal from './Modal'