@vegan-friendly/strapi-plugin-elasticsearch 0.2.0 → 0.2.2

package/dist/admin/src/components/SubNavigation/index.d.ts

@@ -1,4 +1,4 @@
 import React from 'react';
 export declare const SubNavigation: ({ activeUrl }: {
-    activeUrl: any;
+    activeUrl?: string | null;
 }) => React.JSX.Element;

package/dist/admin/src/components/SubNavigation/index.js

@@ -10,7 +10,7 @@ const design_system_1 = require("@strapi/design-system");
 const design_system_2 = require("@strapi/design-system");
 const react_router_dom_1 = require("react-router-dom");
 const pluginId_1 = __importDefault(require("../../pluginId"));
-const SubNavigation = ({ activeUrl }) => {
+const SubNavigation = ({ activeUrl = null }) => {
     const links = [
         {
             id: 1,

package/dist/admin/src/pages/ConfigureCollection/index.js

@@ -110,7 +110,7 @@ const ConfigureCollection = () => {
     const updateCollectionsConfig = ({ index, config }) => {
         setCollectionConfig({
             collectionName: collectionConfig.collectionName,
-            attributes: collectionConfig.attributes.map((e, idx) => index === idx ? config : e)
+            attributes: collectionConfig.attributes.map((e, idx) => (index === idx ? config : e)),
         });
     };
     const saveCollectionConfig = () => {
@@ -125,12 +125,16 @@ const ConfigureCollection = () => {
             saveConfigForCollection(collectionConfig.collectionName, data)
                 .then((resp) => {
                 toggleNotification({
-                    type: "success", message: "The collection configuration is saved.", timeout: 5000
+                    type: 'success',
+                    message: 'The collection configuration is saved.',
+                    timeout: 5000,
                 });
             })
                 .catch((err) => {
                 toggleNotification({
-                    type: "warning", message: err.message || "An error was encountered.", timeout: 5000
+                    type: 'warning',
+                    message: err.message || 'An error was encountered.',
+                    timeout: 5000,
                 });
                 console.log(err);
             })
@@ -147,7 +151,9 @@ const ConfigureCollection = () => {
                 .then((resp) => {
                 if (Object.keys(resp).length === 0) {
                     toggleNotification({
-                        type: "warning", message: 'No collection with the selected name exists.', timeout: 5000
+                        type: 'warning',
+                        message: 'No collection with the selected name exists.',
+                        timeout: 5000,
                     });
                 }
                 else {
@@ -162,7 +168,9 @@ const ConfigureCollection = () => {
             })
                 .catch((err) => {
                 toggleNotification({
-                    type: "warning", message: err.message || "An error was encountered.", timeout: 5000
+                    type: 'warning',
+                    message: err.message || 'An error was encountered.',
+                    timeout: 5000,
                 });
                 console.log(err);
             });

package/dist/admin/src/pages/ViewIndexingRunLog/index.js

@@ -51,7 +51,8 @@ const design_system_2 = require("@strapi/design-system");
 const design_system_3 = require("@strapi/design-system");
 const helper_plugin_1 = require("@strapi/helper-plugin");
 const loadRecentIndexingRuns = () => {
-    return axiosInstance_1.default.get(apiUrls_1.apiFetchRecentIndexingRunLog)
+    return axiosInstance_1.default
+        .get(apiUrls_1.apiFetchRecentIndexingRunLog)
         .then((resp) => resp.data)
         .then((data) => {
         return data;
@@ -71,17 +72,17 @@ const formattedDate = (dateString) => {
     const parts = dateTimeFormat.formatToParts(date);
     let formattedDate = '';
     parts.forEach((part) => {
-        if (part.type === "weekday")
+        if (part.type === 'weekday')
             formattedDate += `${part.value}, `;
-        if (part.type === "day")
+        if (part.type === 'day')
             formattedDate += `${part.value}/`;
-        if (part.type === "month")
+        if (part.type === 'month')
             formattedDate += `${part.value}/`;
-        if (part.type === "year")
+        if (part.type === 'year')
             formattedDate += `${part.value}  `;
-        if (part.type === "hour")
+        if (part.type === 'hour')
             formattedDate += `${part.value}:`;
-        if (part.type === "minute")
+        if (part.type === 'minute')
             formattedDate += `${part.value}`;
     });
     return formattedDate;
@@ -89,8 +90,7 @@ const formattedDate = (dateString) => {
 const ViewIndexingRunLog = () => {
     const [logTable, setLogTable] = (0, react_1.useState)(null);
     (0, react_1.useEffect)(() => {
-        loadRecentIndexingRuns()
-            .then(setLogTable);
+        loadRecentIndexingRuns().then(setLogTable);
     }, []);
     if (logTable === null)
         return react_1.default.createElement(helper_plugin_1.LoadingIndicatorPage, null);

package/dist/admin/src/utils/axiosInstance.js

@@ -12,11 +12,9 @@ const instance = axios_1.default.create({
     baseURL: process.env.STRAPI_ADMIN_BACKEND_URL,
 });
 instance.interceptors.request.use(async (config) => {
-    config.headers = {
-        'Authorization': `Bearer ${helper_plugin_1.auth.getToken()}`,
-        'Accept': 'application/json',
-        'Content-Type': 'application/json',
-    };
+    config.headers.set('Authorization', `Bearer ${helper_plugin_1.auth.getToken()}`);
+    config.headers.set('Accept', 'application/json');
+    config.headers.set('Content-Type', 'application/json');
     return config;
 }, error => {
     Promise.reject(error);

package/dist/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@vegan-friendly/strapi-plugin-elasticsearch",
-    "version": "0.2.0",
+    "version": "0.2.2",
     "description": "A Strapi plugin to enable using Elasticsearch with Strapi CMS.",
     "homepage": "https://github.com/vegan-friendly/strapi-plugin-elasticsearch",
     "strapi": {
@@ -37,8 +37,8 @@
     "dependencies": {
         "@elastic/elasticsearch": "^8.9.0",
         "@strapi/design-system": "^1.19.0",
-        "markdown-to-txt": "^2.0.1",
-        "pretty-ms": "^9.2.0"
+        "humanize-duration": "^3.32.1",
+        "markdown-to-txt": "^2.0.1"
     },
     "peerDependencies": {
         "@strapi/strapi": "^4.0.0"

package/dist/server/bootstrap.js

@@ -12,7 +12,7 @@ exports.default = async ({ strapi }) => {
         await configureIndexingService.initializeStrapiElasticsearch();
         if (!Object.keys(pluginConfig).includes('indexingCronSchedule'))
             console.warn('The plugin strapi-plugin-elasticsearch is enabled but the indexingCronSchedule is not configured.');
-        else if (!Object.keys(pluginConfig).includes('searchConnector'))
+        if (!Object.keys(pluginConfig).includes('searchConnector'))
             console.warn('The plugin strapi-plugin-elasticsearch is enabled but the searchConnector is not configured.');
         else {
             const connector = pluginConfig['searchConnector'];

package/dist/server/index.d.ts

@@ -185,9 +185,9 @@ declare const _default: {
                 collectionName: any;
                 itemId: any;
             }): string;
-            getCurrentIndexName(): Promise<string>;
-            getIncrementedIndexName(): Promise<string>;
-            storeCurrentIndexName(indexName: any): Promise<void>;
+            getCurrentIndexName(indexPrefix?: string): Promise<string>;
+            getIncrementedIndexName(indexPrefix?: string): Promise<string>;
+            storeCurrentIndexName(indexName: any, indexPrefix?: string): Promise<void>;
             modifySubfieldsConfigForExtractor(collectionConfig: any): any;
             extractDataToIndex({ collectionName, data, collectionConfig }: {
                 collectionName: any;

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

@@ -29,13 +29,14 @@ exports.default = ({ strapi }) => ({
             throw err;
         }
     },
-    async createIndex(indexName) {
+    async createIndex(indexName, mappings) {
         try {
             const exists = await client.indices.exists({ index: indexName });
             if (!exists) {
                 console.log('strapi-plugin-elasticsearch : Search index ', indexName, ' does not exist. Creating index.');
                 await client.indices.create({
                     index: indexName,
+                    mappings: mappings ?? undefined,
                 });
             }
         }
@@ -67,10 +68,10 @@ exports.default = ({ strapi }) => ({
             }
         }
     },
-    async attachAliasToIndex(indexName) {
+    async attachAliasToIndex(indexName, optionalAliasName, mappings) {
         try {
             const pluginConfig = await strapi.config.get('plugin.elasticsearch');
-            const aliasName = pluginConfig.indexAliasName;
+            const aliasName = optionalAliasName ? optionalAliasName : pluginConfig.indexAliasName;
             const aliasExists = await client.indices.existsAlias({ name: aliasName });
             if (aliasExists) {
                 console.log('strapi-plugin-elasticsearch : Alias with this name already exists, removing it.');
@@ -78,7 +79,7 @@ exports.default = ({ strapi }) => ({
             }
             const indexExists = await client.indices.exists({ index: indexName });
             if (!indexExists)
-                await this.createIndex(indexName);
+                await this.createIndex(indexName, mappings);
             console.log('strapi-plugin-elasticsearch : Attaching the alias ', aliasName, ' to index : ', indexName);
             await client.indices.putAlias({ index: indexName, name: aliasName });
         }

package/dist/server/services/helper.d.ts

@@ -22,9 +22,9 @@ declare const _default: ({ strapi }: {
         collectionName: any;
         itemId: any;
     }): string;
-    getCurrentIndexName(): Promise<string>;
-    getIncrementedIndexName(): Promise<string>;
-    storeCurrentIndexName(indexName: any): Promise<void>;
+    getCurrentIndexName(indexPrefix?: string): Promise<string>;
+    getIncrementedIndexName(indexPrefix?: string): Promise<string>;
+    storeCurrentIndexName(indexName: any, indexPrefix?: string): Promise<void>;
     modifySubfieldsConfigForExtractor(collectionConfig: any): any;
     extractDataToIndex({ collectionName, data, collectionConfig }: {
         collectionName: any;

package/dist/server/services/helper.js

@@ -6,6 +6,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 const fp_1 = require("lodash/fp");
 const transform_content_1 = __importDefault(require("./transform-content"));
+const defaultIndexPrefix = 'strapi-plugin-elasticsearch-index';
 const getPluginStore = () => {
     return strapi.store({
         environment: '',
@@ -14,7 +15,7 @@ const getPluginStore = () => {
     });
 };
 const getModelPopulationAttributes = (model) => {
-    if (model.uid === "plugin::upload.file") {
+    if (model.uid === 'plugin::upload.file') {
         const { related, ...attributes } = model.attributes;
         return attributes;
     }
@@ -192,34 +193,39 @@ exports.default = ({ strapi }) => ({
     getIndexItemId({ collectionName, itemId }) {
         return collectionName + '::' + itemId;
     },
-    async getCurrentIndexName() {
+    async getCurrentIndexName(indexPrefix = defaultIndexPrefix) {
         const pluginStore = getPluginStore();
         const settings = (await pluginStore.get({ key: 'configsettings' }));
-        let indexName = 'strapi-plugin-elasticsearch-index_000001';
+        let indexName = indexPrefix + '_000001';
         if (settings) {
             const objSettings = JSON.parse(settings);
             if (Object.keys(objSettings).includes('indexConfig')) {
                 const idxConfig = objSettings['indexConfig'];
-                indexName = idxConfig['name'];
+                if (idxConfig[indexPrefix]) {
+                    indexName = idxConfig[indexPrefix];
+                }
             }
         }
         return indexName;
     },
-    async getIncrementedIndexName() {
-        const currentIndexName = await this.getCurrentIndexName();
-        const number = parseInt(currentIndexName.split('index_')[1]);
-        return 'strapi-plugin-elasticsearch-index_' + String(number + 1).padStart(6, '0');
+    async getIncrementedIndexName(indexPrefix = defaultIndexPrefix) {
+        const currentIndexName = await this.getCurrentIndexName(indexPrefix);
+        const number = parseInt(currentIndexName.split(indexPrefix + '_')[1]);
+        return indexPrefix + '_' + String(number + 1).padStart(6, '0');
     },
-    async storeCurrentIndexName(indexName) {
+    async storeCurrentIndexName(indexName, indexPrefix = defaultIndexPrefix) {
         const pluginStore = getPluginStore();
         const settings = (await pluginStore.get({ key: 'configsettings' }));
         if (settings) {
             const objSettings = JSON.parse(settings);
-            objSettings['indexConfig'] = { name: indexName };
+            objSettings['indexConfig'] = {
+                ...objSettings['indexConfig'],
+                [indexPrefix]: indexName,
+            };
             await pluginStore.set({ key: 'configsettings', value: JSON.stringify(objSettings) });
         }
         else {
-            const newSettings = JSON.stringify({ indexConfig: { name: indexName } });
+            const newSettings = JSON.stringify({ indexConfig: { [indexPrefix]: indexName } });
             await pluginStore.set({ key: 'configsettings', value: newSettings });
         }
     },

package/dist/server/services/index.d.ts

@@ -81,9 +81,9 @@ declare const _default: {
             collectionName: any;
             itemId: any;
         }): string;
-        getCurrentIndexName(): Promise<string>;
-        getIncrementedIndexName(): Promise<string>;
-        storeCurrentIndexName(indexName: any): Promise<void>;
+        getCurrentIndexName(indexPrefix?: string): Promise<string>;
+        getIncrementedIndexName(indexPrefix?: string): Promise<string>;
+        storeCurrentIndexName(indexName: any, indexPrefix?: string): Promise<void>;
         modifySubfieldsConfigForExtractor(collectionConfig: any): any;
         extractDataToIndex({ collectionName, data, collectionConfig }: {
             collectionName: any;

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

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-const pretty_ms_1 = __importDefault(require("pretty-ms"));
+const humanize_duration_1 = __importDefault(require("humanize-duration"));
 /**
  * Service to handle indexing of virtual collections
  */
@@ -27,44 +27,44 @@ exports.default = ({ strapi }) => {
                     strapi.log.warn(`No data extracted for ${collectionName} with ID ${itemId}`);
                     return null;
                 }
-                const data = results[0];
-                const indexData = collection.mapToIndex ? data : data;
-                const esService = getElasticsearchService();
+                const itemData = results[0];
+                const esInterface = getElasticsearchService();
                 const helper = getHelperService();
                 const indexItemId = helper.getIndexItemId(collectionName, itemId);
-                await esService.indexDataToSpecificIndex({ itemId: indexItemId, itemData: indexData }, collection.indexName);
+                const indexName = await helper.getCurrentIndexName();
+                await esInterface.indexDataToSpecificIndex({ itemId: indexItemId, itemData }, indexName);
                 strapi.log.debug(`Indexed virtual item: ${collectionName}:${itemId}`);
-                return indexData;
+                return itemData;
             }
             catch (error) {
                 strapi.log.error(`Error indexing ${collectionName}:${itemId}: ${error?.message}`);
                 throw error;
             }
         },
-        async reindexAll(indexName) {
+        async reindexAll() {
+            const timestamp = Date.now();
             const registry = getRegistryService();
             const collections = registry.getAll();
             let totalIndexed = 0;
             for (const collection of collections) {
-                totalIndexed += await this.reindex(collection.collectionName, indexName);
+                totalIndexed += await this.reindex(collection);
             }
-            console.log(`strapi-plugin-elasticsearch : Reindexed ${totalIndexed} items across all ${collections.length} virtual collections`);
+            strapi.log.info(`strapi-plugin-elasticsearch : Reindexed ${totalIndexed} items across all ${collections.length} virtual collections. took ${(0, humanize_duration_1.default)(Date.now() - timestamp)} `);
             return totalIndexed;
         },
         /**
          * Reindex all items in a virtual collection
          */
-        async reindex(collectionName, indexName) {
-            const registry = getRegistryService();
-            const collection = registry.get(collectionName);
-            if (!collection) {
-                throw new Error(`Virtual collection not found: ${collectionName}`);
-            }
-            const timestamp = Date.now();
+        async reindex(collection) {
+            const collectionName = collection.collectionName;
+            const indexAlias = collection.indexAlias;
+            const helper = getHelperService();
+            const oldIndexName = await helper.getCurrentIndexName(indexAlias);
+            const newIndexName = await helper.getIncrementedIndexName(indexAlias);
+            let timestamp = Date.now();
             try {
-                const esService = getElasticsearchService();
-                const helper = getHelperService();
-                // await esService.createIndex(tempIndexName);
+                const esInterface = getElasticsearchService();
+                await esInterface.createIndex(newIndexName, collection.mappings);
                 let page = 0;
                 let hasMoreData = true;
                 let totalIndexed = 0;
@@ -75,22 +75,28 @@ exports.default = ({ strapi }) => {
                         break;
                     }
                     const operations = [];
-                    for (const item of pageData) {
-                        const itemId = helper.getIndexItemId({ collectionName, itemId: item.id });
-                        const itemData = collection.mapToIndex ? item : item;
+                    for (const itemData of pageData) {
+                        const itemId = helper.getIndexItemId({ collectionName, itemId: itemData.id });
                         operations.push({ itemId, itemData });
                     }
                     if (operations.length > 0) {
-                        await Promise.all(operations.map((op) => esService.indexDataToSpecificIndex(op, indexName)));
+                        await Promise.all(operations.map((op) => esInterface.indexDataToSpecificIndex(op, newIndexName)));
                     }
                     totalIndexed += pageData.length;
                     page++;
                 }
-                strapi.log.info(`Reindexed ${totalIndexed} items for virtual collection: ${collectionName}. took ${(0, pretty_ms_1.default)(Date.now() - timestamp)}`);
+                strapi.log.info(`Reindexed ${totalIndexed} items for virtual collection: ${collectionName}. took ${(0, humanize_duration_1.default)(Date.now() - timestamp)}. now updating alias.`);
+                timestamp = Date.now();
+                await esInterface.attachAliasToIndex(newIndexName, indexAlias, collection.mappings);
+                strapi.log.info(`Done attachAliasToIndex alias ${indexAlias} to index ${newIndexName}. took ${(0, humanize_duration_1.default)(Date.now() - timestamp)}`);
+                timestamp = Date.now();
+                await helper.storeCurrentIndexName(newIndexName, indexAlias);
+                await esInterface.deleteIndex(oldIndexName);
+                strapi.log.info(`Done deleting ${oldIndexName}. took ${(0, humanize_duration_1.default)(Date.now() - timestamp)}`);
                 return totalIndexed;
             }
             catch (error) {
-                strapi.log.error(`Error reindexing ${collectionName}: ${error?.message} after ${(0, pretty_ms_1.default)(Date.now() - timestamp)}`);
+                strapi.log.error(`Error reindexing ${collectionName}: ${error?.message} after ${(0, humanize_duration_1.default)(Date.now() - timestamp)}`);
                 throw error;
             }
         },
@@ -125,8 +131,8 @@ exports.default = ({ strapi }) => {
                 throw new Error(`Virtual collection not found: ${collectionName}`);
             }
             try {
-                const esService = getElasticsearchService();
-                await esService.removeItemFromIndex({ itemId });
+                const esInterface = getElasticsearchService();
+                await esInterface.removeItemFromIndex({ itemId });
                 strapi.log.debug(`Deleted indexed item: ${collectionName}:${itemId}`);
                 return true;
             }

package/dist/server/types/esInterface.type.d.ts

@@ -1,3 +1,4 @@
+import { MappingTypeMapping } from '@elastic/elasticsearch/lib/api/types';
 export interface EsInterfaceService {
     /**
      * Initializes the search engine connection.
@@ -15,7 +16,7 @@ export interface EsInterfaceService {
      * @param indexName - The name of the index to create.
      * @returns A promise that resolves when the index is created.
      */
-    createIndex(indexName: string): Promise<void>;
+    createIndex(indexName: string, mappings?: MappingTypeMapping): Promise<void>;
     /**
      * Deletes an index from the search engine.
      * @param indexName - The name of the index to delete.
@@ -25,9 +26,10 @@ export interface EsInterfaceService {
     /**
      * Attaches an alias to a specific index.
      * @param indexName - The index to which the alias should be attached.
+     * @param aliasName - Alias to attach. If not provided, alias from configuration 'indexAliasName' will be used.
      * @returns A promise that resolves when the alias is set.
      */
-    attachAliasToIndex(indexName: string): Promise<void>;
+    attachAliasToIndex(indexName: string, aliasName?: string, mappings?: MappingTypeMapping): Promise<void>;
     /**
      * Checks the connection status of the search engine.
      * @returns A promise that resolves with the connection status.

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

@@ -1,5 +1,12 @@
-export type VirtualCollectionConfig<T extends {}> = {
-    indexName: string;
+import { MappingTypeMapping } from '@elastic/elasticsearch/lib/api/types';
+export type VirtualCollectionConfig<T extends StrapiEntity> = {
+    /**
+     * The alias of the latest index in Elasticsearch.
+     * It also serves as a prefix to actual indexes created in Elasticsearch.
+     * The actuall index name will be the `${indexNameBase}_${ind}`, e.g `restaurants_000001` and so on.
+     * and the alias will be the `indexNameBase`.
+     */
+    indexAlias: string;
     collectionName: string;
     extractData: (page: number, pageSize?: number) => Promise<T[]>;
     extractById: (ids: number[]) => Promise<T[]>;
@@ -7,7 +14,11 @@ export type VirtualCollectionConfig<T extends {}> = {
         collection: string;
         getIdsToReindex: (result: any) => Promise<number[]>;
     }>;
-    mapToIndex?: (item: T) => Promise<object>;
+    /**
+     * Optional schema to be sent to Elasticsearch when creating the index.
+     * If you don't include this, ElasticSearch will automatically create a schema for you.
+     */
+    mappings?: MappingTypeMapping;
 };
 export interface VirtualCollectionsRegistryService {
     /**
@@ -15,7 +26,7 @@ export interface VirtualCollectionsRegistryService {
      * @param config - The configuration for the virtual collection
      * @returns The current instance of the registry
      */
-    register<T extends {}>(config: VirtualCollectionConfig<T>): this;
+    register<T extends StrapiEntity>(config: VirtualCollectionConfig<T>): this;
     /**
      * get all registered virtual collections
      * @returns An array of all registered virtual collections
@@ -24,6 +35,10 @@ export interface VirtualCollectionsRegistryService {
     get(collectionName: string): VirtualCollectionConfig<any> | null;
     findTriggersByCollection(collectionUID: string): Array<VirtualCollectionConfig<any>>;
 }
+export type StrapiEntity = {
+    id: number;
+    [key: string]: any;
+};
 export interface VirtualCollectionsIndexerService {
     /**
      * Index a single item from a virtual collection.
@@ -33,15 +48,13 @@ export interface VirtualCollectionsIndexerService {
     indexItem(collectionName: string, itemId: number): Promise<any>;
     /**
      * Reindex all items in a virtual collection index.
-     * @param indexName - The target index name.
      */
-    reindexAll(indexName: string): Promise<any>;
+    reindexAll(): Promise<any>;
     /**
      * Reindex all items in a virtual collection.
-     * @param collectionName - The name of the virtual collection.
-     * @param indexName - The target index name.
+     * @param collection - The virtual collection config.
      */
-    reindex(collectionName: string, indexName: string): Promise<any>;
+    reindex<T extends StrapiEntity>(collection: VirtualCollectionConfig<T>): Promise<any>;
     /**
      * Handle a trigger event from a collection.
      * @param event - The trigger event.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vegan-friendly/strapi-plugin-elasticsearch",
-  "version": "0.2.0",
+  "version": "0.2.2",
   "description": "A Strapi plugin to enable using Elasticsearch with Strapi CMS.",
   "homepage": "https://github.com/vegan-friendly/strapi-plugin-elasticsearch",
   "strapi": {
@@ -37,8 +37,8 @@
   "dependencies": {
     "@elastic/elasticsearch": "^8.9.0",
     "@strapi/design-system": "^1.19.0",
-    "markdown-to-txt": "^2.0.1",
-    "pretty-ms": "^9.2.0"
+    "humanize-duration": "^3.32.1",
+    "markdown-to-txt": "^2.0.1"
   },
   "peerDependencies": {
     "@strapi/strapi": "^4.0.0"
@@ -61,4 +61,4 @@
     "ts-node": "^10.9.2",
     "typescript": "^5.8.3"
   }
-}
+}