@autobusal/common 1.23.0 → 1.24.0

package/CHANGELOG.md

@@ -1,5 +1,15 @@
 # Changelog
 
+## 1.24.0
+
+**`Policy` is now `Information`.**
+
+- `Policy` → `Information`, `useGetPolicy` → `useGetInformation`, and the endpoint behind it moves from `/api/routes/policy` to `/api/routes/information`. **Breaking**: update the import.
+- `RouteItem`'s `ReadPolicy` → `ReadInformation`, reading `route_item.information`.
+- Translation keys: `policy.title` → `information.title`, `route_item.policy` → `route_item.information`.
+
+The rename follows the Flexible Ticket model, where what a ticket permits comes from the add-on and the operator's own windows — not from this box.
+
 All notable changes to `@autobusal/common` are documented here. This project follows
 [Keep a Changelog](https://keepachangelog.com/) and [Semantic Versioning](https://semver.org/).
 

package/{Policy/Policy.tsx → Information/Information.tsx}

@@ -1,7 +1,7 @@
 import { TFunction } from 'i18next';
 import { sanitizeHtml } from '@autobusal/utilities';
 import Modal from '../Modal/Modal';
-import { useGetPolicy } from './services';
+import { useGetInformation } from './services';
 
 interface Props {
   id: number
@@ -9,20 +9,20 @@ interface Props {
   onClose: () => void
 }
 
-const Policy = ({ id, t, onClose }: Props): JSX.Element => {
-  const { data, isFetching } = useGetPolicy(id);
+const Information = ({ id, t, onClose }: Props): JSX.Element => {
+  const { data, isFetching } = useGetInformation(id);
 
   return (
     <Modal
       loading={ isFetching }
       width={ 750 }
-      title={ t('policy.title') }
+      title={ t('information.title') }
       content={
-        <div dangerouslySetInnerHTML={{ __html: sanitizeHtml(data?.policies) }} />
+        <div dangerouslySetInnerHTML={{ __html: sanitizeHtml(data?.information) }} />
       }
       onClose={ onClose }
     />
   );
 };
 
-export default Policy;
+export default Information;

package/{Policy → Information}/services.ts

@@ -1,13 +1,13 @@
 import { useQuery, UseQueryResult } from '@tanstack/react-query';
 import { apiClient } from '@autobusal/providers';
-import { PolicyData } from '@autobusal/providers/types/routes';
+import { InformationData } from '@autobusal/providers/types/routes';
 
-export const useGetPolicy = (id: number): UseQueryResult<PolicyData> => (
+export const useGetInformation = (id: number): UseQueryResult<InformationData> => (
   useQuery({
-    queryKey: ['route-policy', { id }],
+    queryKey: ['route-information', { id }],
     queryFn: async () => (
       await apiClient
-        .get('/api/routes/policy', {
+        .get('/api/routes/information', {
           params: { id }
         })
         .then(response => (

package/RouteItem/More/More.tsx

@@ -1,5 +1,5 @@
 import { TFunction } from 'i18next';
-import ReadPolicy from './ReadPolicy';
+import ReadInformation from './ReadInformation';
 import Schedule from './Schedule';
 import Transiting from './Transiting';
 import Douane from './Douane';
@@ -25,7 +25,7 @@ const More = ({ route, t }: Props): JSX.Element => (
     </Details>
 
     <Policy>
-      <ReadPolicy id={ route.id } t={ t } />
+      <ReadInformation id={ route.id } t={ t } />
     </Policy>
   </Container>
 );

package/RouteItem/More/{ReadPolicy.tsx → ReadInformation.tsx}

@@ -1,7 +1,7 @@
 import { useState } from 'react';
 import { TFunction } from 'i18next';
 import { IoDocumentText } from 'react-icons/io5';
-import Policy from '../../Policy/Policy';
+import Information from '../../Information/Information';
 import { ButtonPolicy } from './styles';
 
 interface Props {
@@ -9,19 +9,19 @@ interface Props {
   t: TFunction<'public'>
 }
 
-const ReadPolicy = ({ id, t }: Props): JSX.Element => {
+const ReadInformation = ({ id, t }: Props): JSX.Element => {
   const [ view, setView ] = useState<boolean>(false);
 
   return (
     <>
       <ButtonPolicy type="button" onClick={ () => setView(!view) }>
         <IoDocumentText />
-        { t('route_item.policy') }
+        { t('route_item.information') }
       </ButtonPolicy>
 
-      { view && <Policy id={ id } t={ t } onClose={ () => setView(false) } /> }
+      { view && <Information id={ id } t={ t } onClose={ () => setView(false) } /> }
     </>
   );
 };
 
-export default ReadPolicy;
+export default ReadInformation;

package/index.ts

@@ -27,7 +27,7 @@ import Passengers from './Passengers/Passengers';
 import Password from './Password/Password';
 import Rating from './Rating/Rating';
 import { setServerToday } from './Calendar/utilities/settings';
-import Policy from './Policy/Policy';
+import Information from './Information/Information';
 import Report from './Report/Report';
 import RouteFeature from './RouteFeature/RouteFeature';
 import Required from './Required/Required';
@@ -77,7 +77,7 @@ export {
   Password,
   Rating,
   setServerToday,
-  Policy,
+  Information,
   Report,
   RouteFeature,
   Required,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@autobusal/common",
-  "version": "1.23.0",
+  "version": "1.24.0",
   "author": "Ferjolt Ozuni",
   "type": "module",
   "main": "index.ts"