@vegan-friendly/strapi-plugin-elasticsearch 0.2.7 → 0.2.8

package/dist/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@vegan-friendly/strapi-plugin-elasticsearch",
-    "version": "0.2.7",
+    "version": "0.2.8",
     "description": "A Strapi plugin to enable using Elasticsearch with Strapi CMS.",
     "homepage": "https://github.com/vegan-friendly/strapi-plugin-elasticsearch",
     "strapi": {

package/dist/server/bootstrap.js

@@ -25,7 +25,12 @@ exports.default = async ({ strapi }) => {
             strapi.cron.add({
                 elasticsearchIndexing: {
                     task: async ({ strapi }) => {
-                        await indexer.indexPendingData();
+                        try {
+                            await indexer.indexPendingData();
+                        }
+                        catch (err) {
+                            strapi.log.error('Error while indexing data: ', err);
+                        }
                     },
                     options: {
                         rule: pluginConfig['indexingCronSchedule'],
@@ -119,6 +124,15 @@ exports.default = async ({ strapi }) => {
         const registry = strapi.service('plugin::elasticsearch.virtualCollectionsRegistry');
         // Setup lifecycle hooks
         const virtualCollections = registry.getAll();
+        // Check if indices exists, if not create them
+        virtualCollections.forEach(async (collection) => {
+            const indexName = await helper.getCurrentIndexName(collection.indexAlias);
+            const indexExists = await esInterface.listIndicesByPattern(indexName);
+            if (!indexExists.includes(indexName)) {
+                await esInterface.createIndex(indexName, collection.mappings);
+                strapi.log.info(`Created Elasticsearch index: ${indexName}`);
+            }
+        });
         // Create a set of all collections that need hooks
         const collectionsToHook = new Set();
         virtualCollections.forEach((collection) => {

package/dist/server/services/es-interface.js

@@ -156,10 +156,18 @@ exports.default = ({ strapi }) => ({
         }
     },
     async listIndicesByPattern(pattern = 'restaurants*') {
-        const results = await client.cat.indices({
-            index: pattern,
-            format: 'json',
-        });
-        return results.map((index) => index.index).filter((index) => index != null);
+        try {
+            const results = await client.cat.indices({
+                index: pattern,
+                format: 'json',
+            });
+            return results.map((index) => index.index).filter((index) => index != null);
+        }
+        catch (err) {
+            if (err?.message?.includes('index_not_found_exception')) {
+                return [];
+            }
+            throw err;
+        }
     },
 });

package/dist/server/services/virtual-collections-registry.js

@@ -36,16 +36,17 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const yup = __importStar(require("yup"));
 const isFunction = () => yup.mixed().test('is-function', `must be a function`, (value) => typeof value === 'function');
 const configSchema = yup.object({
-    indexAlias: yup.string().nullable(),
+    indexAlias: yup.string().notRequired().nonNullable(),
     collectionName: yup.string().required(),
     extractData: isFunction().required(),
     extractByIds: isFunction().required(),
     getIndexItemId: isFunction(),
     triggers: yup
         .array()
+        .optional()
         .of(yup.object({
         collection: yup.string().required(),
-        getIdsToReindex: isFunction(),
+        getIdsToReindex: isFunction().required(),
         alsoTriggerDelete: yup.boolean().default(false),
     }))
         .default([]),
@@ -69,9 +70,10 @@ exports.default = ({ strapi }) => {
             if (!config) {
                 const helper = strapi.plugin('elasticsearch').service('helper');
                 const defaultConf = configSchema.getDefault();
-                config = strapi.plugin('elasticsearch').config('virtualCollections') || [];
-                config = config.map((collection) => {
-                    const collectionConfig = configSchema.validateSync(collection, { strict: true });
+                const virtualCollectionsFactories = strapi.plugin('elasticsearch').config('virtualCollections') || [];
+                config = virtualCollectionsFactories.map((factory) => {
+                    let collectionConfig = factory(strapi);
+                    collectionConfig = configSchema.validateSync(collectionConfig, { stripUnknown: true });
                     collectionConfig.getIndexItemId = collectionConfig.getIndexItemId || ((id) => helper.getIndexItemId({ collectionName: collectionConfig.collectionName, itemId: id }));
                     return { ...defaultConf, ...collectionConfig };
                 });

package/dist/server/types/virtual-collections.type.d.ts

@@ -1,4 +1,9 @@
 import { MappingTypeMapping } from '@elastic/elasticsearch/lib/api/types';
+export type VirtualCollectionFactory = (strapi: any) => VirtualCollectionConfig;
+export type ExtractByIdsFunction = (ids: number[]) => Promise<StrapiEntity[]>;
+export type ExtractDataFunction = (page: number, pageSize?: number) => Promise<StrapiEntity[]>;
+export type GetIndexItemIdFunction = (itemId: number, collectionName: string) => string;
+export type GetIdsToIndexFunction = (event: any) => Promise<number[]>;
 export type VirtualCollectionConfig = {
     /**
      * Optional -
@@ -17,8 +22,8 @@ export type VirtualCollectionConfig = {
      * e.g 'api::restaurants.restaurants'.
      */
     collectionName: string;
-    extractData: (page: number, pageSize?: number) => Promise<StrapiEntity[]>;
-    extractByIds: (ids: number[]) => Promise<StrapiEntity[]>;
+    extractData: ExtractDataFunction;
+    extractByIds: ExtractByIdsFunction;
     /**
      *  Optional -
      * A function that takes an item and returns the id of the item to be used in the index.
@@ -28,7 +33,7 @@ export type VirtualCollectionConfig = {
      * @param collectionName collection name. you probably want to use this to create a unique id for the item, especially if it is saved to the default index.
      * @returns the id of the item to be used in the index, _id. must be unique accross the index.
      */
-    getIndexItemId?: (itemId: number, collectionName: string) => string;
+    getIndexItemId?: GetIndexItemIdFunction;
     triggers: Array<{
         /**
          * collection name to listen to for changes.
@@ -39,7 +44,7 @@ export type VirtualCollectionConfig = {
          * @param event - The event object containing the data to be indexed.
          * @returns ids of the items to be reindexed.
          */
-        getIdsToReindex: (event: any) => Promise<number[]>;
+        getIdsToReindex: GetIdsToIndexFunction;
         /**
          * if true, and the trigger is a delete event, the item of the virtual collection will be deleted as well if the id returned from getIdsToReindex match.
          * defaults to false.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vegan-friendly/strapi-plugin-elasticsearch",
-  "version": "0.2.7",
+  "version": "0.2.8",
   "description": "A Strapi plugin to enable using Elasticsearch with Strapi CMS.",
   "homepage": "https://github.com/vegan-friendly/strapi-plugin-elasticsearch",
   "strapi": {