@extravirgin/payload-plugin-meilisearch 0.0.1 → 0.0.2

package/src/indexCollections.ts

@@ -1,155 +0,0 @@
-import { CollectionConfig, Field } from "payload/dist/exports/types";
-import { PluginTypes } from "./types";
-import { MeiliSearch } from 'meilisearch';
-import  { compile } from 'html-to-text';
-import {
-  LexicalRichTextAdapter,
-  convertLexicalToHTML,
-  consolidateHTMLConverters,
-} from '@payloadcms/richtext-lexical';
-
-export const indexCollections = (collections: CollectionConfig[], config: PluginTypes) : CollectionConfig[] => {
-  
-  const getIndexName = (collectionSlug: string) => `${config?.indexPrefix ?? ''}${collectionSlug}`;
-  
-  const meilisearch = new MeiliSearch({
-    host: config.host,
-    apiKey: config.apiKey,
-  });
-  
-  return collections.map((collection) => {
-
-    if(config?.collections && !config?.collections.find(c => c.slug === collection.slug)) {
-      return collection;
-    }
-    
-    return {
-      ...collection,
-      hooks: {
-        ...(collection.hooks || {}),
-        afterChange: [
-          ...(collection.hooks?.afterChange || []),
-          async ({ doc, operation, req }) => {
-            await upsertIndex(meilisearch, getIndexName(collection.slug));
-            const index = meilisearch.index(getIndexName(collection.slug));
-            if (operation === 'create' || operation === 'update') {
-              const transformedDoc = { ...await transformDocumentForMeilisearch(doc, collection.fields, req), id: doc.id };
-              await index.addDocuments([transformedDoc]);
-            } else if (operation === 'delete') {
-              await index.deleteDocument(doc.id);
-            }
-          },
-        ],
-      },
-    };
-  });
-}
-
-async function upsertIndex(client: MeiliSearch, indexUID: string) {
-  try {
-    // Attempt to retrieve the index
-    await client.getIndex(indexUID)
-  } catch (error) {
-    // Check if the error is because the index was not found
-    // @ts-ignore
-    if (error?.cause?.code === 'index_not_found') {
-      // Index doesn't exist; create it
-      await client.createIndex(indexUID, {
-        primaryKey: 'id',
-      })
-      console.log(`Index '${indexUID}' has been created.`)
-    } else {
-      // Rethrow any other errors
-      throw error
-    }
-  }
-}
-
-
-const options = {
-  wordwrap: 130,
-  // ...
-};
-
-const compiledConvert = compile(options);
-
-// Helper function to extract text from HTML in nodejs
-function extractTextFromHTML(html: string): string {
-  return compiledConvert(html);
-}
-
-// Helper function to transform a document for Meilisearch indexing
-async function transformDocumentForMeilisearch(doc: any, fields: Field[], req: Request): Promise<any> {
-
-  const transformedDoc: any = {};
-
-  await Promise.all(fields.map(async (field) => {
-    if (field.type === 'richText') {
-      // For rich text fields, convert Lexical to HTML, then extract text
-
-      const lexicalAdapter: LexicalRichTextAdapter =
-      field.editor as LexicalRichTextAdapter
-
-      const sanitizedServerEditorConfig: any = lexicalAdapter.editorConfig
-
-      const html = await convertLexicalToHTML({
-        converters: consolidateHTMLConverters({editorConfig: sanitizedServerEditorConfig}),
-        data: doc[field.name],
-      });
-
-      transformedDoc[field.name] = extractTextFromHTML(html);
-
-    } else if (field.type === 'array' && field.fields) {
-      // For array fields, transform each item
-      transformedDoc[field.name] = await Promise.all(
-        (doc[field.name] || []).map((item: any) => 
-          transformDocumentForMeilisearch(item, field.fields, req)
-        )
-      );
-    } else if (field.type === 'tabs') {
-      // For tab fields, transform each tab
-      (await Promise.all(
-        field.tabs.map(async (tab, index) => {
-          return await transformDocumentForMeilisearch(doc, tab.fields, req)
-        })
-      )).forEach((t) => Object.assign(transformedDoc, t));
-    } else if (field.type === 'blocks') {
-
-      // For block fields, transform each block
-      transformedDoc[field.name] = await Promise.all(
-        (doc[field.name] || []).map(async (block: any) => {
-          const fields = field.blocks.find(b => b.slug === block.blockType)?.fields
-
-          if (!fields) {
-            return {
-              type: block.blockType,
-              data: "",
-            }
-          }
-
-          return {
-            type: block.blockType,
-            data: await transformDocumentForMeilisearch(block, fields, req),
-          };
-        })
-      );
-
-    } else if (field.type === 'group' && field.fields) {
-      // For group fields, transform the nested fields
-      transformedDoc[field.name] = await transformDocumentForMeilisearch(doc[field.name], field.fields, req);
-    } else if (field.type === 'relationship' || field.type === 'upload') {
-      // For relationship and upload fields, just include the ID
-      transformedDoc[field.name] = doc[field.name]?.id || doc[field.name];
-    } else {
-      // For other field types, include as-is
-      try {
-        // @ts-ignore
-        transformedDoc[field.name] = doc[field.name];
-      } catch(err) {
-        console.log(err, field, doc)
-      }
-    }
-  }));
-
-  return transformedDoc;
-}

package/src/mocks/mockFile.js

@@ -1 +0,0 @@
-module.exports = {}

package/src/onInitExtension.ts

@@ -1,16 +0,0 @@
-import type { Payload } from 'payload/dist/payload'
-
-import type { PluginTypes } from './types'
-
-export const onInitExtension = (pluginOptions: PluginTypes, payload: Payload): void => {
-  const { express: app } = payload
-
-  if (!app) return
-
-  try {
-    // You can use the existing express app here to add middleware, routes, etc.
-    // app.use(...)
-  } catch (err: unknown) {
-    payload.logger.error({ msg: 'Error in onInitExtension', err })
-  }
-}

package/src/plugin.ts

@@ -1,67 +0,0 @@
-import type { Config, Plugin } from 'payload/config'
-
-import { onInitExtension } from './onInitExtension'
-import type { PluginTypes } from './types'
-import { extendWebpackConfig } from './webpack'
-import { indexCollections } from './indexCollections'
-
-type PluginType = (pluginOptions: PluginTypes) => Plugin
-
-export const meilisearchPlugin =
-  (pluginOptions: PluginTypes): Plugin =>
-    (incomingConfig) => {
-      let config = { ...incomingConfig }
-
-      // If you need to add a webpack alias, use this function to extend the webpack config
-      const webpack = extendWebpackConfig(incomingConfig)
-
-      config.admin = {
-        ...(config.admin || {}),
-        // If you extended the webpack config, add it back in here
-        // If you did not extend the webpack config, you can remove this line
-        webpack,
-
-        // Add additional admin config here
-      }
-
-      // If the plugin is disabled, return the config without modifying it
-      // The order of this check is important, we still want any webpack extensions to be applied even if the plugin is disabled
-      if (pluginOptions.enabled === false) {
-        return config
-      }
-
-      config.collections = [
-        ...(indexCollections(config.collections || [], pluginOptions)),
-      ]
-
-      config.endpoints = [
-        ...(config.endpoints || []),
-        // {
-        //   path: '/custom-endpoint',
-        //   method: 'get',
-        //   root: true,
-        //   handler: (req, res): void => {
-        //     res.json({ message: 'Here is a custom endpoint' });
-        //   },
-        // },
-        // Add additional endpoints here
-      ]
-
-      config.globals = [
-        ...(config.globals || []),
-        // Add additional globals here
-      ]
-
-      config.hooks = {
-        ...(config.hooks || {}),
-        // Add additional hooks here
-      }
-
-      config.onInit = async payload => {
-        if (incomingConfig.onInit) await incomingConfig.onInit(payload)
-        // Add additional onInit code by using the onInitExtension function
-        onInitExtension(pluginOptions, payload)
-      }
-
-      return config
-    }

package/src/types.ts

@@ -1,20 +0,0 @@
-export interface PluginTypes {
-  /**
-   * Enable or disable plugin
-   * @default false
-   */
-  enabled?: boolean
-  host: string;
-  apiKey: string;
-  indexPrefix?: string;
-  collections?: PluginCollectionConfig[];
-}
-
-export interface PluginCollectionConfig {
-  slug: string;
-}
-
-
-export interface NewCollectionTypes {
-  title: string
-}

package/src/webpack.ts

@@ -1,28 +0,0 @@
-import path from 'path'
-import type { Config } from 'payload/config'
-import type { Configuration as WebpackConfig } from 'webpack'
-
-export const extendWebpackConfig =
-  (config: Config): ((webpackConfig: WebpackConfig) => WebpackConfig) =>
-  webpackConfig => {
-    const existingWebpackConfig =
-      typeof config.admin?.webpack === 'function'
-        ? config.admin.webpack(webpackConfig)
-        : webpackConfig
-
-    const mockModulePath = path.resolve(__dirname, './mocks/mockFile.js')
-
-    const newWebpack = {
-      ...existingWebpackConfig,
-      resolve: {
-        ...(existingWebpackConfig.resolve || {}),
-        alias: {
-          ...(existingWebpackConfig.resolve?.alias ? existingWebpackConfig.resolve.alias : {}),
-          // Add additional aliases here like so:
-          [path.resolve(__dirname, './yourFileHere')]: mockModulePath,
-        },
-      },
-    }
-
-    return newWebpack
-  }

package/tsconfig.json

@@ -1,23 +0,0 @@
-{
-  "compilerOptions": {
-    "lib": [
-      "dom",
-      "dom.iterable",
-      "esnext"
-    ],
-    "target": "es5",
-    "outDir": "./dist",
-    "allowJs": true,
-    "module": "commonjs",
-    "sourceMap": true,
-    "jsx": "react",
-    "esModuleInterop": true,
-    "declaration": true,
-    "declarationDir": "./dist",
-    "skipLibCheck": true,
-    "strict": true,
-  },
-  "include": [
-    "src/**/*",
-  ],
-}