@vegan-friendly/strapi-plugin-elasticsearch 0.2.4 → 0.2.6

package/dist/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@vegan-friendly/strapi-plugin-elasticsearch",
-    "version": "0.2.4-alpha.1",
+    "version": "0.2.6",
     "description": "A Strapi plugin to enable using Elasticsearch with Strapi CMS.",
     "homepage": "https://github.com/vegan-friendly/strapi-plugin-elasticsearch",
     "strapi": {
@@ -40,7 +40,8 @@
         "@elastic/elasticsearch": "^8.9.0",
         "@strapi/design-system": "^1.19.0",
         "humanize-duration": "^3.32.1",
-        "markdown-to-txt": "^2.0.1"
+        "markdown-to-txt": "^2.0.1",
+        "yup": "^1.6.1"
     },
     "peerDependencies": {
         "@strapi/strapi": "^4.0.0"

package/dist/server/bootstrap.js

@@ -146,6 +146,9 @@ exports.default = async ({ strapi }) => {
     }
     catch (err) {
         console.error('An error was encountered while initializing the strapi-plugin-elasticsearch plugin.');
+        if (err.name == 'ValidationError') {
+            throw err; // fail strapi startup if the config is invalid
+        }
         console.error(err);
     }
 };

package/dist/server/index.d.ts

@@ -151,7 +151,7 @@ declare const _default: {
             strapi: any;
         }) => {
             rebuildIndex(): Promise<boolean>;
-            indexCollection(collectionName: any, indexName?: null): Promise<boolean>;
+            indexCollection(collectionName: any, indexName?: string | null): Promise<boolean>;
             indexPendingData(): Promise<boolean>;
         };
         logIndexing: ({ strapi }: {

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

@@ -114,7 +114,8 @@ exports.default = ({ strapi }) => ({
                 id: itemId,
                 document: itemData,
             });
-            await client.indices.refresh({ index: iName });
+            //indices.refresh is an expensive operation. and ES is doing this once a second anyway (see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-refresh.html)
+            // await client!.indices.refresh({ index: iName });
         }
         catch (err) {
             console.log('strapi-plugin-elasticsearch : Error encountered while indexing data to ElasticSearch.');
@@ -126,14 +127,13 @@ exports.default = ({ strapi }) => ({
         const pluginConfig = await strapi.config.get('plugin.elasticsearch');
         return await this.indexDataToSpecificIndex({ itemId, itemData }, pluginConfig.indexAliasName);
     },
-    async removeItemFromIndex({ itemId }) {
-        const pluginConfig = await strapi.config.get('plugin.elasticsearch');
+    async removeItemFromIndex({ indexName, itemId }) {
         try {
             await client.delete({
-                index: pluginConfig.indexAliasName,
+                index: indexName,
                 id: itemId,
             });
-            await client.indices.refresh({ index: pluginConfig.indexAliasName });
+            await client.indices.refresh({ index: indexName });
         }
         catch (err) {
             if (err?.meta?.statusCode === 404)

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

@@ -47,7 +47,7 @@ declare const _default: {
         strapi: any;
     }) => {
         rebuildIndex(): Promise<boolean>;
-        indexCollection(collectionName: any, indexName?: null): Promise<boolean>;
+        indexCollection(collectionName: any, indexName?: string | null): Promise<boolean>;
         indexPendingData(): Promise<boolean>;
     };
     logIndexing: ({ strapi }: {

package/dist/server/services/perform-indexing.d.ts

@@ -2,7 +2,7 @@ declare const _default: ({ strapi }: {
     strapi: any;
 }) => {
     rebuildIndex(): Promise<boolean>;
-    indexCollection(collectionName: any, indexName?: null): Promise<boolean>;
+    indexCollection(collectionName: any, indexName?: string | null): Promise<boolean>;
     indexPendingData(): Promise<boolean>;
 };
 export default _default;

package/dist/server/services/perform-indexing.js

@@ -101,6 +101,7 @@ exports.default = ({ strapi }) => ({
         const logIndexingService = strapi.plugins['elasticsearch'].services.logIndexing;
         const esInterface = strapi.plugins['elasticsearch'].services.esInterface;
         const helper = strapi.plugins['elasticsearch'].services.helper;
+        const indexAlias = await strapi.config.get('plugin.elasticsearch').indexAliasName;
         const recs = await scheduleIndexingService.getItemsPendingToBeIndexed();
         const fullSiteIndexing = recs.filter((r) => r.full_site_indexing === true).length > 0;
         if (fullSiteIndexing) {
@@ -137,7 +138,7 @@ exports.default = ({ strapi }) => ({
                                     collectionName: col,
                                     itemId: recs[r].item_id,
                                 });
-                                await esInterface.removeItemFromIndex({ itemId: indexItemId });
+                                await esInterface.removeItemFromIndex({ indexName: indexAlias, itemId: indexItemId });
                                 await scheduleIndexingService.markIndexingTaskComplete(recs[r].id);
                             }
                         } //index the entire collection

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

@@ -22,7 +22,7 @@ exports.default = ({ strapi }) => {
                 throw new Error(`Virtual collection not found: ${collectionName}`);
             }
             try {
-                const results = await collection.extractById([itemId]);
+                const results = await collection.extractByIds([itemId]);
                 if (!results || !Array.isArray(results) || results.length === 0) {
                     strapi.log.warn(`No data extracted for ${collectionName} with ID ${itemId}`);
                     return null;
@@ -30,7 +30,7 @@ exports.default = ({ strapi }) => {
                 const itemData = results[0];
                 const esInterface = getElasticsearchService();
                 const helper = getHelperService();
-                const indexItemId = helper.getIndexItemId({ collectionName, itemId });
+                const indexItemId = collection.getIndexItemId(itemId, collectionName);
                 const indexName = await helper.getCurrentIndexName(collection.indexAlias);
                 await esInterface.indexDataToSpecificIndex({ itemId: indexItemId, itemData }, indexName);
                 strapi.log.debug(`Indexed virtual item: ${collectionName}:${itemId}`);
@@ -81,7 +81,7 @@ exports.default = ({ strapi }) => {
                     }
                     const operations = [];
                     for (const itemData of pageData) {
-                        const itemId = helper.getIndexItemId({ collectionName, itemId: itemData.id });
+                        const itemId = collection.getIndexItemId(itemData.id, collectionName);
                         operations.push({ itemId, itemData });
                     }
                     if (operations.length > 0) {
@@ -113,15 +113,24 @@ exports.default = ({ strapi }) => {
             const { model, result } = event;
             const registry = getRegistryService();
             // Find virtual collections that should be triggered by this model
-            const affectedCollections = registry.findTriggersByCollection(model);
+            const affectedCollections = registry.findTriggersByCollection(model.uid);
             for (const collection of affectedCollections) {
                 // Find the specific trigger for this collection
-                const trigger = collection.triggers.find((t) => t.collection === model);
-                if (trigger && trigger.getIdsToReindex) {
-                    // Get IDs that need to be reindexed
-                    const idsToReindex = await trigger.getIdsToReindex(result);
-                    // Reindex each item
-                    for (const id of idsToReindex) {
+                const trigger = collection.triggers.find((t) => t.collection === model.uid);
+                if (trigger?.getIdsToReindex == null) {
+                    strapi.log.error(`Trigger for ${collection.collectionName} (triggered by ${model.uid}) does not have getIdsToReindex function.`);
+                    return;
+                }
+                // Get IDs that need to be reindexed
+                const idsToReindex = await trigger.getIdsToReindex(result);
+                // Reindex each item
+                for (const id of idsToReindex) {
+                    const isDelete = event.action?.toLowerCase()?.includes('delete') && trigger.alsoTriggerDelete && id === result.id;
+                    if (isDelete) {
+                        //delete the item from the index, if the item being delete is the one being reindexed
+                        await this.deleteItem(collection.collectionName, id);
+                    }
+                    else {
                         await this.indexItem(collection.collectionName, id);
                     }
                 }
@@ -132,13 +141,16 @@ exports.default = ({ strapi }) => {
          */
         async deleteItem(collectionName, itemId) {
             const registry = getRegistryService();
+            const helper = getHelperService();
             const collection = registry.get(collectionName);
             if (!collection) {
                 throw new Error(`Virtual collection not found: ${collectionName}`);
             }
             try {
                 const esInterface = getElasticsearchService();
-                await esInterface.removeItemFromIndex({ itemId });
+                const indexItemId = collection.getIndexItemId(itemId, collectionName);
+                const indexName = collection.indexAlias || (await helper.getCurrentIndexName());
+                await esInterface.removeItemFromIndex({ indexName, itemId: indexItemId });
                 strapi.log.debug(`Deleted indexed item: ${collectionName}:${itemId}`);
                 return true;
             }

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

@@ -1,5 +1,56 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
 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(),
+    collectionName: yup.string().required(),
+    extractData: isFunction().required(),
+    extractByIds: isFunction().required(),
+    getIndexItemId: isFunction(),
+    triggers: yup
+        .array()
+        .of(yup.object({
+        collection: yup.string().required(),
+        getIdsToReindex: isFunction(),
+        alsoTriggerDelete: yup.boolean().default(false),
+    }))
+        .default([]),
+    mappings: yup.object().default({}),
+});
 /**
  * Service to handle indexing of virtual collections
  */
@@ -12,17 +63,24 @@ exports.default = ({ strapi }) => {
     // const get = (collectionName) => {
     //   return getAll().find((collection) => collection.collectionName === collectionName);
     // };
+    let config;
     return {
         getAll() {
-            const config = strapi.plugin('elasticsearch').config('virtualCollections');
-            return config || [];
+            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 });
+                    collectionConfig.getIndexItemId = collectionConfig.getIndexItemId || ((id) => helper.getIndexItemId({ collectionName: collectionConfig.collectionName, itemId: id }));
+                    return { ...defaultConf, ...collectionConfig };
+                });
+            }
+            return config;
         },
         get(collectionName) {
             return this.getAll().find((collection) => collection.collectionName === collectionName) ?? null;
         },
-        register: function (config) {
-            throw new Error('Function not implemented.');
-        },
         findTriggersByCollection: function (collectionUID) {
             return this.getAll().filter((collection) => {
                 return collection.triggers.some((trigger) => trigger.collection === collectionUID);

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

@@ -61,6 +61,7 @@ export interface EsInterfaceService {
      * @returns A promise that resolves when the item is removed.
      */
     removeItemFromIndex(data: {
+        indexName: string;
         itemId: string;
     }): Promise<any>;
     /**

package/dist/server/types/helper-service.type.d.ts

@@ -21,8 +21,8 @@ export interface HelperService {
         collectionName: string;
         itemId: number;
     }): string;
-    getCurrentIndexName(indexAlias?: string): Promise<string>;
-    getIncrementedIndexName(indexPrefix: string): Promise<string>;
+    getCurrentIndexName(indexPrefix?: string): Promise<string>;
+    getIncrementedIndexName(indexPrefix?: string): Promise<string>;
     deleteOldIndices(indexAlias?: string): Promise<string[]>;
     modifySubfieldsConfigForExtractor(collectionConfig: object): object;
     extractDataToIndex(args: {

package/dist/server/types/helper-service.type.js

@@ -1,7 +1,2 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-let a = {
-    a: 1,
-};
-const example = { foo: "bar" };
-a = example;

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

@@ -1,5 +1,5 @@
 import { MappingTypeMapping } from '@elastic/elasticsearch/lib/api/types';
-export type VirtualCollectionConfig<T extends StrapiEntity> = {
+export type VirtualCollectionConfig = {
     /**
      * Optional -
      * The alias of the latest index in Elasticsearch.
@@ -11,12 +11,40 @@ export type VirtualCollectionConfig<T extends StrapiEntity> = {
      * Omit this property if you want to use the default index for all collections.
      */
     indexAlias?: string;
+    /**
+     * The name of the virtual-collection.
+     * You can use whatever name you want, but it's recommended to use the underlying collection api name,
+     * e.g 'api::restaurants.restaurants'.
+     */
     collectionName: string;
-    extractData: (page: number, pageSize?: number) => Promise<T[]>;
-    extractById: (ids: number[]) => Promise<T[]>;
+    extractData: (page: number, pageSize?: number) => Promise<StrapiEntity[]>;
+    extractByIds: (ids: number[]) => Promise<StrapiEntity[]>;
+    /**
+     *  Optional -
+     * A function that takes an item and returns the id of the item to be used in the index.
+     * The default is <collectionName>::<itemId>
+     *
+     * @param itemId itemId in strapi
+     * @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;
     triggers: Array<{
+        /**
+         * collection name to listen to for changes.
+         */
         collection: string;
-        getIdsToReindex: (result: any) => Promise<number[]>;
+        /**
+         * gets an event on the given collection, and returns the ids of virtual-collection items to be reindexed.
+         * @param event - The event object containing the data to be indexed.
+         * @returns ids of the items to be reindexed.
+         */
+        getIdsToReindex: (event: any) => Promise<number[]>;
+        /**
+         * 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.
+         */
+        alsoTriggerDelete?: boolean;
     }>;
     /**
      * Optional schema to be sent to Elasticsearch when creating the index.
@@ -25,19 +53,13 @@ export type VirtualCollectionConfig<T extends StrapiEntity> = {
     mappings?: MappingTypeMapping;
 };
 export interface VirtualCollectionsRegistryService {
-    /**
-     * Register a virtual collection
-     * @param config - The configuration for the virtual collection
-     * @returns The current instance of the registry
-     */
-    register<T extends StrapiEntity>(config: VirtualCollectionConfig<T>): this;
     /**
      * get all registered virtual collections
      * @returns An array of all registered virtual collections
      */
-    getAll(): Array<VirtualCollectionConfig<any>>;
-    get(collectionName: string): VirtualCollectionConfig<any> | null;
-    findTriggersByCollection(collectionUID: string): Array<VirtualCollectionConfig<any>>;
+    getAll(): Array<VirtualCollectionConfig>;
+    get(collectionName: string): VirtualCollectionConfig | null;
+    findTriggersByCollection(collectionUID: string): Array<VirtualCollectionConfig>;
 }
 export type StrapiEntity = {
     id: number;
@@ -58,7 +80,7 @@ export interface VirtualCollectionsIndexerService {
      * Reindex all items in a virtual collection.
      * @param collection - The virtual collection config.
      */
-    reindex<T extends StrapiEntity>(collection: VirtualCollectionConfig<T>): Promise<any>;
+    reindex(collection: VirtualCollectionConfig): Promise<any>;
     /**
      * Handle a trigger event from a collection.
      * @param event - The trigger event.
@@ -70,5 +92,5 @@ export interface VirtualCollectionsIndexerService {
      * @param itemId - The id of the item to be deleted.
      * @returns A promise that resolves to a boolean indicating success.
      */
-    deleteItem(collectionName: string, itemId: string): Promise<boolean>;
+    deleteItem(collectionName: string, itemId: number): Promise<boolean>;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vegan-friendly/strapi-plugin-elasticsearch",
-  "version": "0.2.4",
+  "version": "0.2.6",
   "description": "A Strapi plugin to enable using Elasticsearch with Strapi CMS.",
   "homepage": "https://github.com/vegan-friendly/strapi-plugin-elasticsearch",
   "strapi": {
@@ -40,7 +40,8 @@
     "@elastic/elasticsearch": "^8.9.0",
     "@strapi/design-system": "^1.19.0",
     "humanize-duration": "^3.32.1",
-    "markdown-to-txt": "^2.0.1"
+    "markdown-to-txt": "^2.0.1",
+    "yup": "^1.6.1"
   },
   "peerDependencies": {
     "@strapi/strapi": "^4.0.0"

package/dist/admin/index.d.ts

@@ -1,8 +0,0 @@
-declare const _default: {
-    register(app: any): void;
-    bootstrap(app: any): void;
-    registerTrads({ locales }: {
-        locales: any;
-    }): Promise<any[]>;
-};
-export default _default;

package/dist/admin/index.js

@@ -1,92 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || (function () {
-    var ownKeys = function(o) {
-        ownKeys = Object.getOwnPropertyNames || function (o) {
-            var ar = [];
-            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
-            return ar;
-        };
-        return ownKeys(o);
-    };
-    return function (mod) {
-        if (mod && mod.__esModule) return mod;
-        var result = {};
-        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
-        __setModuleDefault(result, mod);
-        return result;
-    };
-})();
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const helper_plugin_1 = require("@strapi/helper-plugin");
-const package_json_1 = __importDefault(require("../package.json"));
-const pluginId_1 = __importDefault(require("./pluginId"));
-const Initializer_1 = __importDefault(require("./src/components/Initializer"));
-const PluginIcon_1 = __importDefault(require("./src/components/PluginIcon"));
-const name = package_json_1.default.strapi.name;
-exports.default = {
-    register(app) {
-        app.addMenuLink({
-            to: `/plugins/${pluginId_1.default}`,
-            icon: PluginIcon_1.default,
-            intlLabel: {
-                id: `${pluginId_1.default}.plugin.name`,
-                defaultMessage: 'Elasticsearch',
-            },
-            Component: async () => {
-                const component = await Promise.resolve().then(() => __importStar(require(/* webpackChunkName: "[request]" */ './src/pages/App')));
-                return component;
-            },
-            permissions: [
-            // Uncomment to set the permissions of the plugin here
-            // {
-            //   action: '', // the action name should be plugin::plugin-name.actionType
-            //   subject: null,
-            // },
-            ],
-        });
-        app.registerPlugin({
-            id: pluginId_1.default,
-            initializer: Initializer_1.default,
-            isReady: false,
-            name,
-        });
-    },
-    bootstrap(app) { },
-    async registerTrads({ locales }) {
-        const importedTrads = await Promise.all(locales.map((locale) => {
-            return Promise.resolve(`${
-            /* webpackChunkName: "translation-[request]" */ `./translations/${locale}.json`}`).then(s => __importStar(require(s))).then(({ default: data }) => {
-                return {
-                    data: (0, helper_plugin_1.prefixPluginTranslations)(data, pluginId_1.default),
-                    locale,
-                };
-            })
-                .catch(() => {
-                return {
-                    data: {},
-                    locale,
-                };
-            });
-        }));
-        return Promise.resolve(importedTrads);
-    },
-};

package/dist/admin/pluginId.d.ts

@@ -1,2 +0,0 @@
-declare const pluginId: string;
-export default pluginId;

package/dist/admin/pluginId.js

@@ -1,8 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const package_json_1 = __importDefault(require("../package.json"));
-const pluginId = package_json_1.default.strapi.name;
-exports.default = pluginId;

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

@@ -1,30 +0,0 @@
-export type VirtualCollectionConfig<T extends {}> = {
-    indexName: string;
-    collectionName: string;
-    extractData: (page: number, pageSize?: number) => Promise<T[]>;
-    extractById: (ids: number[]) => Promise<T[]>;
-    triggers: Array<{
-        collection: string;
-        getIdsToReindex: (result: any) => Promise<number[]>;
-    }>;
-    mapToIndex: (item: T) => Promise<object>;
-};
-export interface VirtualCollectionsRegistryService {
-    /**
-     * Initialize indexes for all registered virtual collections
-     */
-    initializeIndexes(): Promise<void>;
-    /**
-     * Register a virtual collection
-     * @param config - The configuration for the virtual collection
-     * @returns The current instance of the registry
-     */
-    register<T extends {}>(config: VirtualCollectionConfig<T>): this;
-    /**
-     * get all registered virtual collections
-     * @returns An array of all registered virtual collections
-     */
-    getAll(): Array<VirtualCollectionConfig<any>>;
-    get(collectionName: string): VirtualCollectionConfig<any> | null;
-    findTriggersByCollection(collectionUID: string): Array<VirtualCollectionConfig<any>>;
-}

package/dist/server/types/virtual-collections.js

@@ -1,2 +0,0 @@
-'use strict';
-Object.defineProperty(exports, "__esModule", { value: true });