Refactor into unscoped packages

Author: richardweaver

package.json

@@ -25,7 +25,7 @@
   "devDependencies": {
     "eslint-config-custom": "*",
     "prettier": "latest",
-    "turbo": "1.10.7"
+    "turbo": "1.10.12"
   },
   "engines": {
     "node": ">=14.0.0"

packages/strapi-plugin-search/.npmignore renamed to packages/strapi-plugin-search-index/.npmignore

@@ -0,0 +1 @@
+export * from './types';

packages/strapi-plugin-search/CHANGELOG.md renamed to packages/strapi-plugin-search-index/CHANGELOG.md

@@ -1,5 +1,5 @@
 {
-  "name": "@rixw/strapi-plugin-search",
+  "name": "strapi-plugin-search-index",
   "version": "0.3.8",
   "description": "Site search engine integration plugin for Strapi",
   "keywords": [
@@ -21,15 +21,12 @@
     "url": "https://github.com/rixw"
   },
   "scripts": {
-    "build": "tsc -p tsconfig.json",
-    "prepare": "yarn clean && yarn build && node dist/setup-package.js",
+    "build": "yarn clean && tsc -p tsconfig.json && node dist/setup-package.js",
     "clean": "rm -rf dist"
   },
   "peerDependencies": {
     "@strapi/strapi": "^4.11.4"
   },
-  "main": "dist/index.js",
-  "types": "dist/index.d.ts",
   "devDependencies": {
     "@strapi/typescript-utils": "^4.11.4",
     "strapi-typed": "^1.0.16",
@@ -40,9 +37,14 @@
     "directory": "dist"
   },
   "strapi": {
-    "name": "strapi-plugin-search",
-    "description": "Strapi plugin to interface with site search engines",
+    "name": "search-index",
+    "description": "Strapi plugin to index to site search engines",
     "kind": "plugin",
-    "displayName": "Search"
-  }
+    "displayName": "Search Index"
+  },
+  "files": [
+    "./dist"
+  ],
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts"
 }

packages/strapi-plugin-search/README.md renamed to packages/strapi-plugin-search-index/README.md

@@ -4,14 +4,15 @@ import { StrapiContext } from 'strapi-typed';
  * Bootstraps search plugin
  */
 const bootstrap = async ({ strapi }: StrapiContext) => {
-  strapi.log.log('Search plugin bootstrapping...');
+  strapi.log.log('Search Index plugin bootstrapping...');
   try {
-    const search = strapi.plugin('search');
+    const search = strapi.plugin('search-index');
+    console.log('search-index bootstrap search', search);
     await search.service('provider').loadProvider();
     await search.service('lifecycle').loadLifecycleMethods();
-    strapi.log.log('Search plugin bootstrapped');
+    strapi.log.log('Search Index plugin bootstrapped');
   } catch (error) {
-    strapi.log.error(`Search plugin bootstrap failed. ${(error as Error).message}`);
+    strapi.log.error(`Search Index plugin bootstrap failed. ${(error as Error).message}`);
   }
 };
 

packages/strapi-plugin-search-index/index.ts

@@ -5,7 +5,7 @@ import { Strapi } from '@strapi/strapi';
 
 declare var strapi: Strapi;
 
-const config = {
+export default {
   /**
    * Default plugin configuration
    */
@@ -23,5 +23,3 @@ const config = {
    */
   validator: (config: PluginConfig) => validateConfig(config),
 };
-
-export default config;

packages/strapi-plugin-search/package.json renamed to packages/strapi-plugin-search-index/package.json

@@ -3,7 +3,4 @@
 import lifecycle from './lifecycle';
 import provider from './provider';
 
-export default {
-  lifecycle,
-  provider,
-};
+export default { lifecycle, provider };

packages/strapi-plugin-search/server/bootstrap.ts renamed to packages/strapi-plugin-search-index/server/bootstrap.ts

@@ -25,22 +25,27 @@ const lifecycle = (): Lifecycle =>
      * Load provider methods into lifecycles
      */
     async loadLifecycleMethods() {
-      const provider = strapi.plugin('search').provider;
+      strapi.log.log('Loading lifecycle methods...');
+      console.log('Loading lifecycle methods...');
+      const provider = strapi.plugin('search-index').provider;
       const {
         excludedFields = [],
         prefix: indexPrefix = '',
         contentTypes,
-      } = strapi.config.get('plugin.search') as PluginConfig;
+      } = strapi.config.get('plugin.search-index') as PluginConfig;
 
       // Loop over configured contentTypes in ./config/plugins.js
       contentTypes &&
         contentTypes.forEach((contentType) => {
+          strapi.log.log('Loading lifecycle methods for content type:', contentType);
+          console.log('Loading lifecycle methods for content type:', contentType);
           const { name, index, prefix: idPrefix = '', fields = [] } = contentType;
 
           if (strapi.contentTypes[name]) {
             const indexName = indexPrefix + (index ? index : name);
 
             const checkPublicationState = (event: AfterEvent) => {
+              strapi.log.log('checkPublicationState', event);
               if (
                 event.result &&
                 has('publishedAt', event.result) &&
@@ -61,6 +66,7 @@ const lifecycle = (): Lifecycle =>
               models: [name],
 
               async afterCreate(event: Event) {
+                strapi.log.log('afterCreate', event);
                 checkPublicationState(event as AfterEvent)
                   ? provider.create({
                       indexName,
@@ -82,6 +88,7 @@ const lifecycle = (): Lifecycle =>
               // },
 
               async afterUpdate(event) {
+                strapi.log.log('afterUpdate', event);
                 checkPublicationState(event as AfterEvent)
                   ? provider.create({
                       indexName,
@@ -104,6 +111,7 @@ const lifecycle = (): Lifecycle =>
               // },
 
               async afterDelete(event) {
+                strapi.log.log('afterDelete', event);
                 provider.delete({ indexName, id: idPrefix + (event as AfterEvent).result.id });
               },
 

packages/strapi-plugin-search/server/config/index.ts renamed to packages/strapi-plugin-search-index/server/config/index.ts

@@ -17,7 +17,8 @@ const provider = () => ({
    * @param {string} [pluginConfig.resolve] - Path to provider
    */
   async loadProvider(pluginConfig: PluginConfig): Promise<void> {
-    pluginConfig = pluginConfig ? pluginConfig : strapi.config.get('plugin.search');
+    strapi.log.log('loadProvider', pluginConfig);
+    pluginConfig = pluginConfig ? pluginConfig : strapi.config.get('plugin.search-index');
 
     try {
       // Todo implement v4 package loader logic
@@ -32,10 +33,10 @@ const provider = () => ({
         providerInstance.updateMany = wrapMethodWithError(providerInstance.updateMany);
         providerInstance.deleteMany = wrapMethodWithError(providerInstance.deleteMany);
         providerInstance.clear = wrapMethodWithError(providerInstance.clear);
-        strapi.plugin('search').provider = providerInstance;
+        strapi.plugin('search-index').provider = providerInstance;
       }
     } catch (error) {
-      strapi.plugin('search').provider = null;
+      strapi.plugin('search-index').provider = null;
       throw new Error(
         `Search plugin could not load provider '${pluginConfig.provider}': ${
           (error as Error).message
@@ -51,14 +52,15 @@ const provider = () => ({
    * @param {object} parameters - Parameters to pass to findMany
    */
   async rebuild(specificTypes: string[], parameters: object) {
+    strapi.log.log('rebuild', specificTypes, parameters);
     strapi.log.info('Rebuilding search indexes...');
     try {
       const {
         excludedFields = [],
         prefix: indexPrefix = '',
         contentTypes,
-      } = strapi.config.get('plugin.search') as PluginConfig;
-      const pluginInstance = strapi.plugin('search').provider;
+      } = strapi.config.get('plugin.search-index') as PluginConfig;
+      const pluginInstance = strapi.plugin('search-index').provider;
       const rebuildTypes = contentTypes.filter(
         (contentType) => !specificTypes || specificTypes.includes(contentType.name),
       );

packages/strapi-plugin-search/server/services/index.ts renamed to packages/strapi-plugin-search-index/server/services/index.ts

@@ -37,7 +37,7 @@ const validateConfig = (config: PluginConfig) => {
       .validateSync(config);
   } catch (error) {
     throw new Error(
-      `Search plugin ConfigValidationError: ${(error as { errors: string[] }).errors}`,
+      `Search Index plugin ConfigValidationError: ${(error as { errors: string[] }).errors}`,
     );
   }
 };

packages/strapi-plugin-search/server/services/lifecycle.ts renamed to packages/strapi-plugin-search-index/server/services/lifecycle.ts

@@ -0,0 +1,14 @@
+import bootstrap from './server/bootstrap';
+import config from './server/config';
+import services from './server/services';
+
+export = () => ({
+  register: ({ strapi }) => {
+    strapi.log.log('Top level register');
+  },
+  bootstrap: ({ strapi }) => {
+    strapi.log.log('Top level bootstrap');
+  },
+  config,
+  services,
+});

packages/strapi-plugin-search/server/services/provider.ts renamed to packages/strapi-plugin-search-index/server/services/provider.ts

@@ -10,7 +10,7 @@
     "./server/**/*",
     "./strapi-server.*",
     "./setup-package.ts",
-    "types/index.d.ts",
+    "./types/**/*",
   ],
   "exclude": [
     "dist/**/*",

packages/strapi-plugin-search/server/utils/error.ts renamed to packages/strapi-plugin-search-index/server/utils/error.ts

@@ -0,0 +1,13 @@
+public/
+coverage/
+.circleci/
+.github/
+.nvmrc
+.eslintrc
+codecov.yml
+*.map
+*.spec.*
+setup-package.*
+**/__tests__/**
+**/__mocks__/** 
+tsconfig.*

packages/strapi-plugin-search/server/utils/sanitize.ts renamed to packages/strapi-plugin-search-index/server/utils/sanitize.ts

@@ -6,7 +6,7 @@ import {
   DeleteManyProps,
   DeleteProps,
   ProviderInstance,
-} from '@rixw/strapi-plugin-search';
+} from 'strapi-plugin-search-index';
 
 declare var strapi: {
   log: {

packages/strapi-plugin-search/server/utils/validate.ts renamed to packages/strapi-plugin-search-index/server/utils/validate.ts

@@ -1,13 +1,13 @@
 {
   "name": "@rixw/strapi-provider-search-algolia",
-  "version": "0.3.7",
+  "version": "0.3.8",
   "description": "This is the description of the plugin.",
   "keywords": [
     "strapi",
     "search",
     "algolia"
   ],
-  "homepage": "https://github.com/rixw/strapi-utils/strapi-provider-search-algolia",
+  "homepage": "https://github.com/rixw/strapi-utils/strapi-provider-search-index-algolia",
   "bugs": "https://github.com/rixw/strapi-utils/issues",
   "repository": {
     "type": "git",
@@ -24,12 +24,12 @@
   "types": "./dist/index.d.ts",
   "scripts": {
     "build": "tsc -p tsconfig.json",
-    "prepare": "yarn clean && yarn build",
+    "prebuild": "yarn clean",
     "clean": "rm -rf dist"
   },
   "dependencies": {
     "algoliasearch": "^4.17.0",
-    "@rixw/strapi-plugin-search": "*"
+    "strapi-plugin-search-index": "*"
   },
   "devDependencies": {
     "tsconfig": "*"
@@ -38,6 +38,8 @@
     "access": "public"
   },
   "strapi": {
-    "isProvider": true
+    "name": "algolia",
+    "isProvider": true,
+    "displayName": "Algolia Provider"
   }
 }

packages/strapi-plugin-search/setup-package.ts renamed to packages/strapi-plugin-search-index/setup-package.ts

@@ -0,0 +1,16 @@
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[{package.json,*.yml}]
+indent_style = space
+indent_size = 2
+
+[*.md]
+trim_trailing_whitespace = false

packages/strapi-plugin-search-index/strapi-server.ts

@@ -0,0 +1,7 @@
+HOST=0.0.0.0
+PORT=1337
+APP_KEYS="toBeModified1,toBeModified2"
+API_TOKEN_SALT=tobemodified
+ADMIN_JWT_SECRET=tobemodified
+TRANSFER_TOKEN_SALT=tobemodified
+JWT_SECRET=tobemodified

packages/strapi-plugin-search/tsconfig.json renamed to packages/strapi-plugin-search-index/tsconfig.json

@@ -0,0 +1,3 @@
+.cache
+build
+**/node_modules/**

packages/strapi-plugin-search/types/index.d.ts renamed to packages/strapi-plugin-search-index/types/index.d.ts

@@ -0,0 +1,27 @@
+{
+  "parser": "babel-eslint",
+  "extends": "eslint:recommended",
+  "env": {
+    "commonjs": true,
+    "es6": true,
+    "node": true,
+    "browser": false
+  },
+  "parserOptions": {
+    "ecmaFeatures": {
+      "experimentalObjectRestSpread": true,
+      "jsx": false
+    },
+    "sourceType": "module"
+  },
+  "globals": {
+    "strapi": true
+  },
+  "rules": {
+    "indent": ["error", 2, { "SwitchCase": 1 }],
+    "linebreak-style": ["error", "unix"],
+    "no-console": 0,
+    "quotes": ["error", "single"],
+    "semi": ["error", "always"]
+  }
+}