various fixes

README.md

@@ -89,3 +89,6 @@ When the **Scheduled job** is executed, it checks the collection status, to avoi
 already in sync. You can always trigger a new deployment manually.
 
 <img src="https://raw.githubusercontent.com/askorama/orama-plugin-strapi/main/misc/assets/deploy.gif" alt="Manual deploy" width="600" />
+
+---
+## Advanced usage

admin/src/components/SchemaMapper/index.js

@@ -1,6 +1,7 @@
 import React from 'react'
 import {
   Box,
+  Button,
   Checkbox,
   Flex,
   Switch,
@@ -119,7 +120,7 @@ const SchemaMapper = ({ collection, contentTypeSchema, onSchemaChange }) => {
       setSelectedAttributes([])
       setSearchableAttributes([])
     } else {
-      setSelectedAttributes(schemaAttributes)
+      setSelectedAttributes(schemaAttributes.map((field) => field.field))
     }
   }
 
@@ -136,8 +137,16 @@ const SchemaMapper = ({ collection, contentTypeSchema, onSchemaChange }) => {
       <Box>
         {/*TODO: style this*/}
         {collection.hasSettings && (
-          <Typography variant="gamma" color="grey-600">
-            The schema is handled by the Orama Cloud plugin settings.
+          <Typography variant="omega">
+            This is handled by the Orama Cloud plugin settings, under{' '}
+            <code
+              style={{
+                color: 'orange'
+              }}
+            >
+              config/plugins.js
+            </code>{' '}
+            directory.
           </Typography>
         )}
         {!collection.hasSettings && (
@@ -175,7 +184,7 @@ const SchemaMapper = ({ collection, contentTypeSchema, onSchemaChange }) => {
                   </Td>
                   <Td
                     onClick={() => onCheck(field)}
-                    style={{ cursor: "pointer", display: "flex", alignItems: "center" }}
+                    style={{ cursor: 'pointer', display: 'flex', alignItems: 'center' }}
                   >
                     <Typography textColor="neutral800">{field}</Typography>
                     {!searchable && (

admin/src/pages/PluginSettings/index.js

@@ -98,13 +98,6 @@ const HomePage = () => {
     if (currentCollection) {
       const contentType = contentTypes.find((ct) => ct.value === currentCollection.entity)
       setCurrentContentType(contentType)
-
-      if (contentType?.availableRelations.length === 0) {
-        setCurrentCollection({
-          ...currentCollection,
-          includedRelations: []
-        })
-      }
     }
   }, [currentCollection])
 

server/services/orama-manager.js

@@ -53,8 +53,9 @@ class OramaManager {
     }
 
     if (
-      (collectionSettings.schema && !collectionSettings.transformer) ||
-      (!collectionSettings.schema && collectionSettings.transformer)
+      collectionSettings &&
+      ((collectionSettings.schema && !collectionSettings.transformer) ||
+        (!collectionSettings.schema && collectionSettings.transformer))
     ) {
       this.strapi.log.error(`ERROR: Both schema and transformer are required in the collection settings`)
       return false
@@ -77,7 +78,7 @@ class OramaManager {
       return entries
     }
 
-    return entries.map(transformer)
+    return entries.map((entry) => transformer(entry))
   }
 
   /*

server/services/orama-manager.test.js

@@ -3,7 +3,10 @@ const { CloudManager } = require('@oramacloud/client')
 const { mockCollection, mockNotValidCollection } = require('../__mocks__/collection')
 const { mockedTestRecord } = require('../__mocks__/content-types')
 
-const titleTransformer = jest.fn((title) => title.toUpperCase())
+const mockTransformer = jest.fn((entry) => ({
+  ...entry,
+  title: entry.title.toUpperCase()
+}))
 
 const strapi = {
   plugin: jest.fn().mockReturnThis(),
@@ -109,6 +112,46 @@ describe('OramaManager', () => {
       )
     })
 
+    it('should return false if collection has settings but schema is missing', () => {
+      strapi.config.get = jest.fn((string) => {
+        if (string === 'plugin.orama-cloud.privateApiKey') return 'mockPrivateApiKey'
+        if (string === 'plugin.orama-cloud.collectionSettings')
+          return {
+            [mockCollection.indexId]: {
+              transformer: mockTransformer
+            }
+          }
+      })
+      oramaManager = new OramaManager({ strapi })
+
+      const result = oramaManager.validate(mockCollection)
+
+      expect(result).toBe(false)
+      expect(strapi.log.error).toHaveBeenCalledWith(
+        `ERROR: Both schema and transformer are required in the collection settings`
+      )
+    })
+
+    it('should return false if collection has settings but transformer is missing', () => {
+      strapi.config.get = jest.fn((string) => {
+        if (string === 'plugin.orama-cloud.privateApiKey') return 'mockPrivateApiKey'
+        if (string === 'plugin.orama-cloud.collectionSettings')
+          return {
+            [mockCollection.indexId]: {
+              schema: {}
+            }
+          }
+      })
+      oramaManager = new OramaManager({ strapi })
+
+      const result = oramaManager.validate(mockCollection)
+
+      expect(result).toBe(false)
+      expect(strapi.log.error).toHaveBeenCalledWith(
+        `ERROR: Both schema and transformer are required in the collection settings`
+      )
+    })
+
     it('should return true if all validations pass', () => {
       const result = oramaManager.validate(mockCollection)
 
@@ -129,9 +172,10 @@ describe('OramaManager', () => {
         if (string === 'plugin.orama-cloud.collectionSettings')
           return {
             indexId: {
-              documentsTransformer: {
-                title: titleTransformer
-              }
+              schema: {
+                title: 'string'
+              },
+              transformer: mockTransformer
             }
           }
       })
@@ -234,7 +278,7 @@ describe('OramaManager', () => {
 
       expect(insert).toHaveBeenCalledWith([{ id: 1, title: 'Test Entry' }])
       expect(documentsTransformerSpy).toHaveBeenCalledWith(mockCollection.indexId, [{ id: 1, title: 'Test Entry' }])
-      expect(titleTransformer).not.toHaveBeenCalledWith('Test Entry')
+      expect(mockTransformer).not.toHaveBeenCalledWith('Test Entry')
     })
 
     it('should call documentsTransformer fn if declared in plugin config', async () => {
@@ -243,9 +287,8 @@ describe('OramaManager', () => {
         if (string === 'plugin.orama-cloud.collectionSettings')
           return {
             [mockCollection.indexId]: {
-              documentsTransformer: {
-                title: titleTransformer
-              }
+              schema: {},
+              transformer: mockTransformer
             }
           }
       })
@@ -259,7 +302,7 @@ describe('OramaManager', () => {
       })
 
       expect(documentsTransformerSpy).toHaveBeenCalledWith(mockCollection.indexId, [{ id: 1, title: 'Test Entry' }])
-      expect(titleTransformer).toHaveBeenCalledWith('Test Entry')
+      expect(mockTransformer).toHaveBeenCalledWith({ id: 1, title: 'Test Entry' })
       expect(insert).toHaveBeenCalledWith([{ id: 1, title: 'TEST ENTRY' }])
     })
 

utils/index.js

@@ -1,4 +1,3 @@
-const { collection } = require('../server/content-types')
 const getSelectedPropsFromObj = ({ props, obj }) => {
   return props.reduce((acc, field) => {
     if (field.includes('.')) {