feat(api): add online-services

examples/online-services.ts

@@ -0,0 +1,13 @@
+import * as crous from "../src";
+//                     ^^^^^^^^
+// Replace with:  from "crowous";
+// when using the package.
+
+void async function main() {
+  const identifier = "bordeaux";
+  const onlineServices = await crous.onlineServices(identifier);
+
+  for (const onlineService of onlineServices) {
+    console.log(`- ${onlineService.title} : ${onlineService.shortDescription ?? "(no description)"} @ ${onlineService.url}`);
+  }
+}();

src/api/index.ts

@@ -1,3 +1,4 @@
 export * from "./feeds";
 export * from "./news";
+export * from "./online-services";
 export * from "./restaurants";

src/api/online-services.ts

@@ -0,0 +1,13 @@
+import { defaultFetcher, type Fetcher } from "@literate.ink/utilities";
+import { Request } from "~/core/request";
+import { parseXML } from "~/core/xml";
+import type { OnlineService } from "~/models";
+import { decodeOnlineService } from "~/decoders/online-service";
+
+export const onlineServices = async (identifier: string, fetcher: Fetcher = defaultFetcher): Promise<Array<OnlineService>> => {
+  const request = new Request(`${identifier}/${identifier}-online.xml`);
+  const response = await fetcher(request);
+  const content = parseXML(response.content);
+
+  return content.root.online.map(decodeOnlineService);
+};

src/decoders/online-service.ts

@@ -0,0 +1,9 @@
+import type { OnlineService } from "~/models";
+
+export const decodeOnlineService = (xml: any): OnlineService => ({
+  id: xml.id,
+  imageURL: xml.image,
+  title: xml.title,
+  shortDescription: xml.short_desc || null,
+  url: xml.link
+});

src/models/index.ts

@@ -8,6 +8,7 @@ export * from "./meal";
 export * from "./menu";
 export * from "./moment";
 export * from "./news-article";
+export * from "./online-service";
 export * from "./payment-method";
 export * from "./restaurant-kind";
 export * from "./restaurant";

src/models/news-article.ts

@@ -1,4 +1,4 @@
-export type NewsArticle = {
+export type NewsArticle = Readonly<{
   id: string
   title: string
   publicationDate: Date
@@ -8,4 +8,4 @@ export type NewsArticle = {
    */
   content: string
   category: string
-};
+}>;

src/models/online-service.ts

@@ -0,0 +1,7 @@
+export type OnlineService = Readonly<{
+  id: string;
+  imageURL: string;
+  title: string;
+  shortDescription: string | null;
+  url: string;
+}>;