[DEV-1951] Add urlreplacemap codec, + tests + mapping function

.changeset/healthy-cobras-type.md

@@ -0,0 +1,5 @@
+---
+"strapi-cms": minor
+---
+
+Add UrlReplaceMap as a single type

apps/nextjs-website/src/lib/strapi/__tests__/urlReplaceMap.test.ts

@@ -0,0 +1,78 @@
+import { UrlReplaceMapCodec } from '../codecs/UrlReplaceMapCodec';
+import * as Either from 'fp-ts/lib/Either';
+import { baseProductJson } from './fixtures/product';
+import { makeUrlReplaceMap } from '../makeProps/makeUrlReplaceMap';
+import { pipe } from 'fp-ts/lib/function';
+import { mediaRasterJson } from './fixtures/media';
+
+const strapiResponse = {
+  data: {
+    id: 1,
+    attributes: {
+      createdAt: '2024-09-30T10:12:44.888Z',
+      updatedAt: '2024-09-30T10:12:45.562Z',
+      publishedAt: '2024-09-30T10:12:45.561Z',
+      urlToGuide: [
+        {
+          id: 1,
+          url: 'aaaa',
+          version: '2',
+          guide: {
+            data: {
+              id: 1,
+              attributes: {
+                title: 'aaa',
+                slug: 'aaaa',
+                createdAt: '2024-09-30T10:12:08.182Z',
+                updatedAt: '2024-09-30T10:12:24.805Z',
+                publishedAt: '2024-09-30T10:12:24.802Z',
+                locale: 'en',
+                image: mediaRasterJson,
+                mobileImage: mediaRasterJson,
+                listItems: [
+                  { id: 1, text: 'rhhtrhrthrt' },
+                  { id: 2, text: 'fdsafdsagtyhtyh' },
+                  { id: 3, text: 'hrhrhthrtyrth' },
+                ],
+                product: baseProductJson,
+                versions: [],
+                seo: null,
+              },
+            },
+          },
+        },
+      ],
+    },
+  },
+  meta: {},
+};
+
+describe('UrlReplaceMapCodec', () => {
+  it('should decode strapi UrlReplaceMapCodec', () => {
+    const decodeResponse = UrlReplaceMapCodec.decode(strapiResponse);
+    expect(Either.isRight(decodeResponse)).toBeTruthy();
+  });
+
+  it('Should correctly convert the map into a record', () => {
+    const validation = UrlReplaceMapCodec.decode(strapiResponse);
+    const result = pipe(
+      validation,
+      Either.fold(
+        (left) => {
+          console.error('Error:', left);
+          return null; // or handle the error as needed
+        },
+        (right) => {
+          console.log('Success:', right);
+          return right;
+        }
+      )
+    );
+    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+    const urlReplaceMap = makeUrlReplaceMap(result!);
+
+    expect(urlReplaceMap).toEqual({
+      aaaa: 'firma-con-io/guides/aaaa/2',
+    });
+  });
+});

apps/nextjs-website/src/lib/strapi/codecs/UrlReplaceMapCodec.ts

@@ -0,0 +1,22 @@
+import * as t from 'io-ts/lib';
+import { GuideCodec } from './GuidesCodec';
+import { NullToUndefinedCodec } from './NullToUndefinedCodec';
+
+const UrlToGuideCodec = t.strict({
+  id: t.number,
+  url: t.string,
+  version: t.union([NullToUndefinedCodec, t.string]),
+  guide: t.strict({
+    data: GuideCodec,
+  }),
+});
+
+export const UrlReplaceMapCodec = t.strict({
+  data: t.strict({
+    attributes: t.strict({
+      urlToGuide: t.array(UrlToGuideCodec),
+    }),
+  }),
+});
+
+export type UrlReplaceMap = t.TypeOf<typeof UrlReplaceMapCodec>;

apps/nextjs-website/src/lib/strapi/fetches/fetchUrlReplaceMap.ts

@@ -0,0 +1,15 @@
+import { fetchFromStrapi } from '../fetchFromStrapi';
+import { UrlReplaceMapCodec } from '../codecs/UrlReplaceMapCodec';
+import qs from 'qs';
+
+const makeStrapiUrlReplaceMapPopulate = () =>
+  qs.stringify({
+    populate:
+      'urlToGuide.guide.*,urlToGuide.guide.image,urlToGuide.guide.mobileImage,urlToGuide.guide.listItems,urlToGuide.guide.product.*,urlToGuide.guide.versions.*,urlToGuide.guide.seo.*',
+  });
+
+export const fetchUrlReplaceMap = fetchFromStrapi(
+  'url-replace-map',
+  makeStrapiUrlReplaceMapPopulate(),
+  UrlReplaceMapCodec
+);

apps/nextjs-website/src/lib/strapi/makeProps/makeUrlReplaceMap.ts

@@ -0,0 +1,19 @@
+import { UrlReplaceMap } from '../codecs/UrlReplaceMapCodec';
+
+export type UrlReplacesMap = Record<string, string>;
+
+export function makeUrlReplaceMap(
+  urlReplacemap: UrlReplaceMap
+): UrlReplacesMap {
+  const map = urlReplacemap.data.attributes.urlToGuide.reduce((map, obj) => {
+    return {
+      ...map,
+      [obj.url]: `${
+        obj.guide.data?.attributes.product.data.attributes.slug
+      }/guides/${obj.guide.data?.attributes.slug}${
+        obj.version ? `/${obj.version}` : ''
+      }`,
+    };
+  }, {} as UrlReplacesMap);
+  return map;
+}

apps/strapi-cms/src/api/url-replace-map/content-types/url-replace-map/schema.json

@@ -0,0 +1,22 @@
+{
+  "kind": "singleType",
+  "collectionName": "url_replace_maps",
+  "info": {
+    "singularName": "url-replace-map",
+    "pluralName": "url-replace-maps",
+    "displayName": "UrlReplaceMap",
+    "description": ""
+  },
+  "options": {
+    "draftAndPublish": true
+  },
+  "pluginOptions": {},
+  "attributes": {
+    "urlToGuide": {
+      "displayName": "urlToGuide",
+      "type": "component",
+      "repeatable": true,
+      "component": "products.url-to-guide"
+    }
+  }
+}

apps/strapi-cms/src/api/url-replace-map/controllers/url-replace-map.ts

@@ -0,0 +1,9 @@
+/**
+ * url-replace-map controller
+ */
+
+import { factories } from '@strapi/strapi';
+
+export default factories.createCoreController(
+  'api::url-replace-map.url-replace-map'
+);

apps/strapi-cms/src/api/url-replace-map/routes/url-replace-map.ts

@@ -0,0 +1,9 @@
+/**
+ * url-replace-map router
+ */
+
+import { factories } from '@strapi/strapi';
+
+export default factories.createCoreRouter(
+  'api::url-replace-map.url-replace-map'
+);

apps/strapi-cms/src/api/url-replace-map/services/url-replace-map.ts

@@ -0,0 +1,9 @@
+/**
+ * url-replace-map service
+ */
+
+import { factories } from '@strapi/strapi';
+
+export default factories.createCoreService(
+  'api::url-replace-map.url-replace-map'
+);

apps/strapi-cms/src/components/products/url-to-guide.json

@@ -0,0 +1,22 @@
+{
+  "collectionName": "components_products_url_to_guides",
+  "info": {
+    "displayName": "urlToGuide",
+    "description": ""
+  },
+  "options": {},
+  "attributes": {
+    "url": {
+      "type": "string",
+      "required": true
+    },
+    "guide": {
+      "type": "relation",
+      "relation": "oneToOne",
+      "target": "api::guide.guide"
+    },
+    "version": {
+      "type": "string"
+    }
+  }
+}