chore: init facades & cleanup public interface of strapi/strapi

cli-tests/scripts/dts-export.js

@@ -9,7 +9,7 @@ const {
   },
   engine: { createTransferEngine },
 } = require('@strapi/data-transfer');
-const { strapiFactory } = require('@strapi/strapi');
+const { createStrapi, compileStrapi } = require('@strapi/strapi');
 const path = require('path');
 
 /**
@@ -77,8 +77,8 @@ const createDestinationProvider = (datasetPath) => {
 };
 
 const createStrapiInstance = async (logLevel = 'error') => {
-  const appContext = await strapiFactory.compile();
-  const app = strapiFactory(appContext);
+  const appContext = await compileStrapi();
+  const app = createStrapi(appContext);
 
   app.log.level = logLevel;
   return app.load();

e2e/scripts/dts-export.js

@@ -7,7 +7,7 @@ const {
   },
   engine: { createTransferEngine },
 } = require('@strapi/data-transfer');
-const { strapiFactory } = require('@strapi/strapi');
+const { createStrapi, compileStrapi } = require('@strapi/strapi');
 const { ALLOWED_CONTENT_TYPES } = require('../constants');
 
 /**
@@ -83,8 +83,8 @@ const createDestinationProvider = (filePath) =>
   });
 
 const createStrapiInstance = async (logLevel = 'error') => {
-  const appContext = await strapiFactory.compile();
-  const app = strapiFactory(appContext);
+  const appContext = await compileStrapi();
+  const app = createStrapi(appContext);
 
   app.log.level = logLevel;
   const loadedApp = await app.load();

examples/getstarted/src/api/address/controllers/address.js

@@ -1,4 +1,5 @@
 const { createCoreController } = require('@strapi/strapi').factories;
+const { strapi } = require('@strapi/strapi');
 
 module.exports = createCoreController('api::address.address', {
   async find(ctx) {

packages/core/core/.eslintignore

@@ -3,3 +3,4 @@ node_modules/
 jest.config.js
 dist/
 scripts/
+vite.config.mjs

packages/core/core/package.json

@@ -31,6 +31,20 @@
       "require": "./dist/index.js",
       "default": "./dist/index.js"
     },
+    "./strapi": {
+      "types": "./dist/facades/strapi.d.ts",
+      "source": "./src/facades/strapi.ts",
+      "import": "./dist/facades/strapi.mjs",
+      "require": "./dist/facades/strapi.js",
+      "default": "./dist/facades/strapi.js"
+    },
+    "./config": {
+      "types": "./dist/facades/config.d.ts",
+      "source": "./src/facades/config.ts",
+      "import": "./dist/facades/config.mjs",
+      "require": "./dist/facades/config.js",
+      "default": "./dist/facades/config.js"
+    },
     "./package.json": "./package.json"
   },
   "main": "./dist/index.js",
@@ -42,14 +56,14 @@
     "resources/"
   ],
   "scripts": {
-    "build": "run pack-up build && run copy-files",
+    "build": "vite build && run copy-files",
     "clean": "run -T rimraf ./dist",
     "copy-files": "copyfiles -u 1 -a 'src/**/*.html' 'src/**/*.png'  dist",
     "lint": "run -T eslint .",
     "prepublishOnly": "yarn clean && yarn build",
     "test:unit": "run -T jest",
     "test:unit:watch": "run -T jest --watch",
-    "watch": "pack-up watch"
+    "watch": "vite build -w"
   },
   "dependencies": {
     "@koa/cors": "3.4.3",
@@ -123,8 +137,11 @@
     "@types/node-schedule": "2.1.0",
     "@types/statuses": "2.0.1",
     "eslint-config-custom": "5.0.0-beta.0",
+    "rollup-plugin-node-externals": "7.1.1",
     "supertest": "6.3.3",
-    "tsconfig": "5.0.0-beta.0"
+    "tsconfig": "5.0.0-beta.0",
+    "vite": "5.1.6",
+    "vite-plugin-dts": "3.7.3"
   },
   "engines": {
     "node": ">=18.0.0 <=20.x.x",

packages/core/core/src/Strapi.ts

@@ -7,12 +7,11 @@ import { isFunction } from 'lodash/fp';
 import { Logger, createLogger } from '@strapi/logger';
 import { Database } from '@strapi/database';
 import { hooks } from '@strapi/utils';
-import type { Core, Modules, UID, Schema } from '@strapi/types';
+import type { Core, Modules, UID, Schema, Utils } from '@strapi/types';
 
 import loadConfiguration from './configuration';
 
 import * as factories from './factories';
-import compile from './compile';
 
 import * as utils from './utils';
 import * as registries from './registries';
@@ -158,6 +157,8 @@ class Strapi extends Container implements Core.Strapi {
   // @ts-expect-error - Assigned in constructor
   ee: Core.Strapi['ee'];
 
+  private loadedCallbacks: Utils.Function.Any[] = [];
+
   constructor(opts: StrapiOptions = {}) {
     super();
 
@@ -574,9 +575,17 @@ class Strapi extends Container implements Core.Strapi {
 
     this.isLoaded = true;
 
+    for (const cb of this.loadedCallbacks) {
+      await cb();
+    }
+
     return this as this & Required<Core.Strapi>;
   }
 
+  async loaded(cb: Utils.Function.Any) {
+    this.loadedCallbacks.push(cb);
+  }
+
   async startWebhooks() {
     const webhooks = await this.webhookStore?.findWebhooks();
     if (!webhooks) {
@@ -625,25 +634,11 @@ class Strapi extends Container implements Core.Strapi {
   }
 }
 
-interface StrapiOptions {
+export interface StrapiOptions {
   appDir?: string;
   distDir?: string;
   autoReload?: boolean;
   serveAdminPanel?: boolean;
 }
 
-interface Init {
-  (options?: StrapiOptions): Core.Strapi;
-  factories: typeof factories;
-  compile: typeof compile;
-}
-
-const initFn = (options: StrapiOptions = {}): Core.Strapi => {
-  const strapi = new Strapi(options);
-  global.strapi = strapi as LoadedStrapi;
-  return strapi;
-};
-
-const init: Init = Object.assign(initFn, { factories, compile });
-
-export default init;
+export default Strapi;

packages/core/core/src/facades/strapi.ts

@@ -0,0 +1,10 @@
+import type { Core } from '@strapi/types';
+
+// eslint-disable-next-line import/no-mutable-exports
+let strapi: Core.Strapi;
+
+export const setStrapiInstance = (strapiInstance: Core.Strapi) => {
+  strapi = strapiInstance;
+};
+
+export { strapi };

packages/core/core/src/index.ts

@@ -1,5 +1,17 @@
-import strapiFactory from './Strapi';
+import type { Core } from '@strapi/types';
 
+import Strapi, { type StrapiOptions } from './Strapi';
+import { setStrapiInstance } from './facades/strapi';
+
+export { default as compileStrapi } from './compile';
 export * as factories from './factories';
 
-export { strapiFactory };
+export const createStrapi = (options: StrapiOptions = {}): Core.Strapi => {
+  const strapi = new Strapi(options);
+  setStrapiInstance(strapi);
+
+  // TODO: deprecate and remove in next major
+  global.strapi = strapi as Core.LoadedStrapi;
+
+  return strapi;
+};

packages/core/core/vite.config.mjs

@@ -0,0 +1,29 @@
+import { defineConfig } from 'vite';
+import dts from 'vite-plugin-dts';
+import { nodeExternals } from 'rollup-plugin-node-externals';
+
+// TODO: support multi entry in pack-up
+
+export default defineConfig({
+  build: {
+    minify: false,
+    sourcemap: true,
+    lib: {
+      entry: ['src/index.ts', 'src/facades/strapi.ts'],
+    },
+    rollupOptions: {
+      output: {
+        interop: 'auto',
+        preserveModules: true,
+        preserveModulesRoot: 'src',
+      },
+      plugins: [nodeExternals()],
+    },
+  },
+  plugins: [
+    dts({
+      outDir: './dist',
+      tsconfigPath: './tsconfig.build.json',
+    }),
+  ],
+});

packages/core/data-transfer/src/strapi/providers/local-destination/__tests__/assets.test.ts

@@ -24,7 +24,7 @@ const transaction = jest.fn(async (cb) => {
   await cb({ trx, rollback });
 });
 
-const strapiFactory = getStrapiFactory({
+const createStrapi = getStrapiFactory({
   dirs: {
     static: {
       public: 'static/public/assets',
@@ -57,7 +57,7 @@ describe('Local Strapi Destination Provider - Get Assets Stream', () => {
 
   test('Returns a stream when assets restore is true', async () => {
     const provider = createLocalStrapiDestinationProvider({
-      getStrapi: () => strapiFactory(),
+      getStrapi: () => createStrapi(),
       strategy: 'restore',
       restore: {
         assets: true,
@@ -72,7 +72,7 @@ describe('Local Strapi Destination Provider - Get Assets Stream', () => {
 
   test('Throw an error if attempting to create stream while restore assets is false', async () => {
     const provider = createLocalStrapiDestinationProvider({
-      getStrapi: () => strapiFactory(),
+      getStrapi: () => createStrapi(),
       strategy: 'restore',
       restore: {
         assets: false,
@@ -96,7 +96,7 @@ describe('Local Strapi Destination Provider - Get Assets Stream', () => {
     };
     const provider = createLocalStrapiDestinationProvider({
       getStrapi: () =>
-        strapiFactory({
+        createStrapi({
           dirs: {
             static: {
               public: assetsDirectory,

packages/core/strapi/packup.config.ts

@@ -13,7 +13,9 @@ export default defineConfig({
     },
     {
       source: './src/cli/index.ts',
+      import: './dist/cli/index.ts',
       require: './dist/cli/index.js',
+      types: './dist/cli/index.d.ts',
       runtime: 'node',
     },
     {

packages/core/strapi/src/cli/commands/admin/__tests__/create-user.test.ts

@@ -26,11 +26,11 @@ const mock = {
 };
 
 jest.mock('@strapi/core', () => {
-  const strapiFactory: any = jest.fn(() => mock);
+  const createStrapi: any = jest.fn(() => mock);
 
-  strapiFactory.compile = jest.fn();
+  compileStrapi = jest.fn();
 
-  return { strapiFactory };
+  return { createStrapi };
 });
 
 describe('admin:create command', () => {

packages/core/strapi/src/cli/commands/admin/__tests__/reset-user-password.test.ts

@@ -17,13 +17,13 @@ const mock = {
 };
 
 jest.mock('@strapi/core', () => {
-  const strapiFactory = jest.fn(() => mock);
+  const createStrapi = jest.fn(() => mock);
 
-  Object.assign(strapiFactory, {
+  Object.assign(createStrapi, {
     compile: jest.fn(),
   });
 
-  return { strapiFactory };
+  return { createStrapi };
 });
 
 describe('admin:reset-password command', () => {

packages/core/strapi/src/cli/commands/admin/create-user.ts

@@ -2,7 +2,7 @@ import { createCommand } from 'commander';
 import { yup } from '@strapi/utils';
 import _ from 'lodash';
 import inquirer from 'inquirer';
-import { strapiFactory } from '@strapi/core';
+import { createStrapi, compileStrapi } from '@strapi/core';
 
 import { runAction } from '../../utils/helpers';
 import type { StrapiCommand } from '../../types';
@@ -73,8 +73,8 @@ const promptQuestions: inquirer.QuestionCollection<Answers> = [
 ];
 
 async function createAdmin({ email, password, firstname, lastname }: CmdOptions) {
-  const appContext = await strapiFactory.compile();
-  const app = await strapiFactory(appContext).load();
+  const appContext = await compileStrapi();
+  const app = await createStrapi(appContext).load();
 
   const user = await app.admin.services.user.exists({ email });
 

packages/core/strapi/src/cli/commands/admin/reset-user-password.ts

@@ -1,7 +1,7 @@
 import _ from 'lodash';
 import inquirer from 'inquirer';
 import { createCommand } from 'commander';
-import { strapiFactory } from '@strapi/core';
+import { createStrapi, compileStrapi } from '@strapi/core';
 
 import type { StrapiCommand } from '../../types';
 import { runAction } from '../../utils/helpers';
@@ -28,8 +28,8 @@ const promptQuestions: ReadonlyArray<inquirer.DistinctQuestion<Answers>> = [
 ];
 
 async function changePassword({ email, password }: CmdOptions) {
-  const appContext = await strapiFactory.compile();
-  const app = await strapiFactory(appContext).load();
+  const appContext = await compileStrapi();
+  const app = await createStrapi(appContext).load();
 
   await app.admin.services.user.resetPasswordByEmail(email, password);
 

packages/core/strapi/src/cli/commands/components/list.ts

@@ -1,14 +1,14 @@
 import { createCommand } from 'commander';
 import CLITable from 'cli-table3';
 import chalk from 'chalk';
-import { strapiFactory } from '@strapi/core';
+import { createStrapi, compileStrapi } from '@strapi/core';
 
 import type { StrapiCommand } from '../../types';
 import { runAction } from '../../utils/helpers';
 
 const action = async () => {
-  const appContext = await strapiFactory.compile();
-  const app = await strapiFactory(appContext).register();
+  const appContext = await compileStrapi();
+  const app = await createStrapi(appContext).register();
 
   const list = Object.keys(app.components);