@stackbit/sdk 0.7.17-staging.1 → 1.0.0-develop.0

package/src/config/config-loader.ts

@@ -42,7 +42,7 @@ import type { Config, StackbitConfigWithPaths, SSGRunOptions, Model, PageModel,
 import { extendModelsWithPresetsIds, loadPresets } from './presets-loader';
 import {
     LoadStackbitConfigResult,
-    StopConfigWatch,
+    WithReloadAndDestroy,
     LATEST_STACKBIT_VERSION,
     STACKBIT_CONFIG_JS_FILES,
     STACKBIT_CONFIG_YAML_FILES,
@@ -53,11 +53,13 @@ import {
 
 const CONTENT_ENGINE_DEFAULT_PORT = 7070;
 
-export interface ConfigWithModelsPresetsResult {
+export type ConfigWithModelsPresetsResult = {
     valid: boolean;
     config: Config | null;
     errors: ConfigError[];
-}
+};
+
+export type ConfigWithModelsPresetsResultWithReloadDestroy = WithReloadAndDestroy<ConfigWithModelsPresetsResult>;
 
 export async function loadConfigWithModelsPresetsAndValidate({
     dirPath,
@@ -73,7 +75,7 @@ export async function loadConfigWithModelsPresetsAndValidate({
     watchCallback?: (result: ConfigWithModelsPresetsResult) => void;
     logger?: Logger;
     isForcedGitCSI?: boolean;
-}): Promise<ConfigWithModelsPresetsResult & StopConfigWatch> {
+}): Promise<ConfigWithModelsPresetsResultWithReloadDestroy> {
     const configResult = await loadConfigWithModels({
         dirPath,
         stackbitConfigESBuildOutDir,
@@ -87,18 +89,26 @@ export async function loadConfigWithModelsPresetsAndValidate({
     });
 
     const configLoaderResult = await processConfigLoaderResult({ configResult, dirPath, modelsSource, logger, isForcedGitCSI });
+    const reload = configResult.reload;
     return {
         ...configLoaderResult,
-        stop: configResult.stop,
-        reload: configResult.reload
+        destroy: configResult.destroy,
+        reload: reload
+            ? async () => {
+                  const configResult = await reload();
+                  return processConfigLoaderResult({ configResult, dirPath, modelsSource, logger, isForcedGitCSI });
+              }
+            : undefined
     };
 }
 
-export type ConfigWithModelsResult = {
+export type LoadConfigWithModelsResult = {
     config: Config | null;
     errors: (ConfigLoadError | StackbitConfigNotFoundError | ModelLoadError | ConfigValidationError)[];
 };
 
+export type LoadConfigWithModelsResultWithReloadDestroy = WithReloadAndDestroy<LoadConfigWithModelsResult>;
+
 export async function loadConfigWithModels({
     dirPath,
     stackbitConfigESBuildOutDir,
@@ -107,10 +117,10 @@ export async function loadConfigWithModels({
 }: {
     dirPath: string;
     stackbitConfigESBuildOutDir?: string;
-    watchCallback?: (result: ConfigWithModelsResult) => void;
+    watchCallback?: (result: LoadConfigWithModelsResult) => void;
     logger?: Logger;
-}): Promise<ConfigWithModelsResult & StopConfigWatch> {
-    const wrapConfigResult = async (configResult: LoadConfigResult): Promise<ConfigWithModelsResult> => {
+}): Promise<LoadConfigWithModelsResultWithReloadDestroy> {
+    const wrapConfigResult = async (configResult: LoadConfigResult): Promise<LoadConfigWithModelsResult> => {
         if (!configResult.config) {
             return {
                 config: null,
@@ -133,11 +143,17 @@ export async function loadConfigWithModels({
     });
 
     const wrappedResult = await wrapConfigResult(rawConfigResult);
+    const reload = rawConfigResult.reload;
 
     return {
         ...wrappedResult,
-        stop: rawConfigResult.stop,
-        reload: rawConfigResult.reload
+        destroy: rawConfigResult.destroy,
+        reload: reload
+            ? async () => {
+                  const configResult = await reload();
+                  return wrapConfigResult(configResult);
+              }
+            : undefined
     };
 }
 
@@ -151,6 +167,8 @@ export type LoadConfigResult =
           errors: (ConfigLoadError | StackbitConfigNotFoundError)[];
       };
 
+export type LoadConfigResultWithReloadDestroy = WithReloadAndDestroy<LoadConfigResult>;
+
 export async function loadConfig({
     dirPath,
     stackbitConfigESBuildOutDir,
@@ -161,8 +179,8 @@ export async function loadConfig({
     stackbitConfigESBuildOutDir?: string;
     watchCallback?: (result: LoadConfigResult) => void;
     logger?: Logger;
-}): Promise<LoadConfigResult & StopConfigWatch> {
-    const normalizeConfigResult = (rawConfigResult: StackbitConfigLoaderResult): LoadConfigResult => {
+}): Promise<LoadConfigResultWithReloadDestroy> {
+    const normalizeConfigResult = (rawConfigResult: LoadConfigFromDirResult): LoadConfigResult => {
         if (!rawConfigResult.config) {
             return {
                 config: null,
@@ -183,7 +201,7 @@ export async function loadConfig({
         dirPath,
         stackbitConfigESBuildOutDir,
         watchCallback: watchCallback
-            ? async (rawConfigResult: StackbitConfigLoaderResult) => {
+            ? async (rawConfigResult: LoadConfigFromDirResult) => {
                   const normalizedResult = await normalizeConfigResult(rawConfigResult);
                   watchCallback(normalizedResult);
               }
@@ -192,11 +210,17 @@ export async function loadConfig({
     });
 
     const normalizedResult = await normalizeConfigResult(rawConfigResult);
+    const reload = rawConfigResult.reload;
 
     return {
         ...normalizedResult,
-        stop: rawConfigResult.stop,
-        reload: rawConfigResult.reload
+        destroy: rawConfigResult.destroy,
+        reload: reload
+            ? async () => {
+                  const rawConfigResult = await reload();
+                  return normalizeConfigResult(rawConfigResult);
+              }
+            : undefined
     };
 }
 
@@ -207,7 +231,7 @@ async function processConfigLoaderResult({
     logger,
     isForcedGitCSI
 }: {
-    configResult: ConfigWithModelsResult;
+    configResult: LoadConfigWithModelsResult;
     dirPath: string;
     modelsSource?: ModelsSource;
     logger?: Logger;
@@ -305,7 +329,7 @@ export function validateAndNormalizeConfig(config: Config, isForcedGitCSI?: bool
     });
 }
 
-export type StackbitConfigLoaderResult =
+export type LoadConfigFromDirResult =
     | {
           config: StackbitConfigWithPaths;
           error: null;
@@ -315,6 +339,8 @@ export type StackbitConfigLoaderResult =
           error: ConfigLoadError | StackbitConfigNotFoundError;
       };
 
+export type LoadConfigFromDirResultWithReloadDestroy = WithReloadAndDestroy<LoadConfigFromDirResult>;
+
 export async function loadConfigFromDir({
     dirPath,
     stackbitConfigESBuildOutDir,
@@ -323,10 +349,10 @@ export async function loadConfigFromDir({
 }: {
     dirPath: string;
     stackbitConfigESBuildOutDir?: string;
-    watchCallback?: (result: StackbitConfigLoaderResult) => void;
+    watchCallback?: (result: LoadConfigFromDirResult) => void;
     logger?: Logger;
-}): Promise<StackbitConfigLoaderResult & StopConfigWatch> {
-    function wrapResult(result: LoadStackbitConfigResult, configFilePath: string): StackbitConfigLoaderResult {
+}): Promise<LoadConfigFromDirResultWithReloadDestroy> {
+    function wrapResult(result: LoadStackbitConfigResult, configFilePath: string): LoadConfigFromDirResult {
         if (result.error) {
             return {
                 config: null,
@@ -351,7 +377,6 @@ export async function loadConfigFromDir({
             logger?.debug(`loading Stackbit configuration from ${stackbitYamlPath}`);
             const result = await loadStackbitYamlFromDir(dirPath);
             let close: () => Promise<void> = async () => void 0;
-            let reload: () => void = () => void 0;
             let stopped = false;
 
             if (watchCallback) {
@@ -387,15 +412,15 @@ export async function loadConfigFromDir({
                     throttledFileChange.cancel();
                     watcher.close();
                 };
-                reload = () => {
-                    throttledFileChange();
-                };
             }
 
             return {
                 ...wrapResult(result, stackbitYamlPath),
-                stop: close,
-                reload: reload
+                destroy: close,
+                reload: async () => {
+                    const result = await loadStackbitYamlFromDir(dirPath);
+                    return wrapResult(result, stackbitYamlPath);
+                }
             };
         }
     } catch (error: any) {
@@ -421,7 +446,17 @@ export async function loadConfigFromDir({
                       }
                     : undefined
             });
-            return Object.assign(wrapResult(configResult, configFilePath), { stop: configResult.stop });
+            const reload = configResult.reload;
+            return {
+                ...wrapResult(configResult, configFilePath),
+                destroy: configResult.destroy,
+                reload: reload
+                    ? async () => {
+                          const result = await reload();
+                          return wrapResult(result, configFilePath);
+                      }
+                    : undefined
+            };
         }
     } catch (error: any) {
         return {

package/src/index.ts

@@ -9,7 +9,7 @@ export * from './consts';
 export * from './config/config-loader-static';
 export { loadPresets, getPresetDirs, extendModelsWithPresetsIds } from './config/presets-loader';
 export {
-    StopConfigWatch,
+    DestroyConfigWatch,
     findStackbitConfigFile,
     isStackbitYamlFile,
     convertToYamlConfig,
@@ -23,10 +23,13 @@ export {
 export {
     loadConfig,
     LoadConfigResult,
+    LoadConfigResultWithReloadDestroy,
+    loadConfigFromDir,
+    LoadConfigFromDirResult,
+    LoadConfigFromDirResultWithReloadDestroy,
     loadConfigWithModelsPresetsAndValidate,
     ConfigWithModelsPresetsResult,
-    loadConfigFromDir,
-    StackbitConfigLoaderResult,
+    ConfigWithModelsPresetsResultWithReloadDestroy,
     mergeConfigModelsWithExternalModels
 } from './config/config-loader';
 export { validateConfig } from './config/config-validator';