@stackbit/sdk 0.2.39-alpha.2 → 0.3.0

package/src/config/config-schema/style-field-schema.ts

@@ -59,10 +59,7 @@ const stylePropsSchema = Joi.object({
             label: Joi.string().required()
         })
     ),
-    fontSize: stylePropWithAll(
-        Joi.string().pattern(sizePattern),
-        arrayOf(Joi.string().pattern(sizePattern), Joi.number().integer().min(0).multiple(1))
-    ),
+    fontSize: stylePropWithAll(Joi.string().pattern(sizePattern), arrayOf(Joi.string().pattern(sizePattern), Joi.number().integer().min(0).multiple(1))),
     fontStyle: arrayOfStringsWithAll(...STYLE_PROPS_VALUES.fontStyle),
     fontWeight: stylePropWithAll(
         Joi.string().pattern(fontWeightPattern),

package/src/config/config-schema.ts

@@ -13,7 +13,7 @@ import {
     PresetSourceFiles,
     SanityImport,
     YamlBaseModel,
-    YamlConfig,
+    RawConfig,
     YamlConfigModel,
     YamlDataModel,
     YamlModel,
@@ -28,7 +28,7 @@ import {
     ModelsSourceSanity
 } from './config-types';
 
-function getConfigFromValidationState(state: Joi.State): YamlConfig {
+function getConfigFromValidationState(state: Joi.State): RawConfig {
     return _.last(state.ancestors)!;
 }
 
@@ -128,7 +128,7 @@ const validReferenceFieldGroups = Joi.string()
         errors: { wrap: { label: false } }
     });
 
-function getModelNamesForGroup(group: string, config: YamlConfig) {
+function getModelNamesForGroup(group: string, config: RawConfig) {
     const models = config.models ?? {};
     return _.reduce(
         models,
@@ -234,7 +234,9 @@ const contentfulImportSchema = Joi.object<ContentfulImport>({
     uploadAssets: Joi.boolean(),
     assetsDirectory: Joi.string(),
     spaceIdEnvVar: Joi.string(),
-    accessTokenEnvVar: Joi.string()
+    accessTokenEnvVar: Joi.string(),
+    deliveryTokenEnvVar: Joi.string(),
+    previewTokenEnvVar: Joi.string()
 }).and('uploadAssets', 'assetsDirectory');
 
 const sanityImportSchema = Joi.object<SanityImport>({
@@ -263,9 +265,7 @@ const presetSourceFilesSchema = Joi.object<PresetSourceFiles>({
 const presetSourceSchema = Joi.object<PresetSource>({
     type: Joi.string().valid('files').required()
 }).when('.type', {
-    switch: [
-        { is: 'files', then: presetSourceFilesSchema }
-    ]
+    switch: [{ is: 'files', then: presetSourceFilesSchema }]
 });
 
 const modelsSourceFilesSchema = Joi.object<ModelsSourceFiles>({
@@ -460,16 +460,15 @@ const listItemsSchema = Joi.object({
 const listFieldPartialSchema = Joi.object({
     type: Joi.string().valid('list').required(),
     controlType: Joi.string().valid('checkbox'),
-    items: Joi.any()
-        .when('..controlType', {
-            switch: [
-                {
-                    is: 'checkbox',
-                    then: enumFieldPartialSchema
-                }
-            ],
-            otherwise: listItemsSchema
-        })
+    items: Joi.any().when('..controlType', {
+        switch: [
+            {
+                is: 'checkbox',
+                then: enumFieldPartialSchema
+            }
+        ],
+        otherwise: listItemsSchema
+    })
 });
 
 const fieldSchema: Joi.ObjectSchema<Field> = fieldCommonPropsSchema.when('.type', {
@@ -720,7 +719,7 @@ const modelsSchema = Joi.object<ModelMap>()
         errors: { wrap: { label: false } }
     });
 
-export const stackbitConfigSchema = Joi.object<YamlConfig>({
+export const stackbitConfigSchema = Joi.object<RawConfig>({
     stackbitVersion: Joi.string().required(),
     ssgName: Joi.string().valid(...SSG_NAMES),
     ssgVersion: Joi.string(),

package/src/config/config-types.ts

@@ -2,19 +2,27 @@ import { StricterUnion } from '../utils';
 import { CMS_NAMES, FIELD_TYPES, SSG_NAMES, STYLE_PROPS } from './config-consts';
 
 export interface Config extends BaseConfig {
+    stackbitVersion: string;
     models: Model[];
     presets?: Record<string, Preset>;
+    hcrHandled?: boolean;
+    internalStackbitRunnerOptions?: SSGRunOptions;
+    dirPath: string;
+    filePath: string;
 }
 
-export interface YamlConfig extends BaseConfig {
+export interface RawConfig extends BaseConfig {
+    stackbitVersion?: string;
     models?: ModelMap;
 }
 
 interface BaseConfig {
-    stackbitVersion: string;
     ssgName?: typeof SSG_NAMES[number];
     ssgVersion?: string;
     nodeVersion?: string;
+    postGitCloneCommand?: string;
+    preInstallCommand?: string;
+    postInstallCommand?: string;
     devCommand?: string;
     cmsName?: typeof CMS_NAMES[number];
     import?: Import;
@@ -33,6 +41,16 @@ interface BaseConfig {
     contentModels?: ContentModelMap;
     presetSource?: PresetSource;
     modelsSource?: ModelsSource;
+    presetReferenceBehavior?: 'copyReference' | 'duplicateContents';
+    nonDuplicatableModels?: string[];
+    duplicatableModels?: string[];
+    contentSources?: any[]; // TODO: set to ContentSourceInterface[], move it to @stackbit/types first
+    mapModels?: (options: { models: Model[]; contentSourceType: string; contentSourceProjectId: string }) => Model[];
+
+    // DEPRECATED
+    noEncodeFields?: string[]; // DEPRECATED, for backward compatibility and typescript support
+    omitFields?: string[]; // DEPRECATED, for backward compatibility and typescript support
+    encodedFieldTypes?: string[]; // DEPRECATED, for backward compatibility and typescript support
 }
 
 export type Import = ContentfulImport | SanityImport;
@@ -44,6 +62,8 @@ export interface ContentfulImport {
     assetsDirectory?: string;
     spaceIdEnvVar?: string;
     accessTokenEnvVar?: string;
+    deliveryTokenEnvVar?: string;
+    previewTokenEnvVar?: string;
 }
 
 export interface SanityImport {
@@ -120,6 +140,15 @@ export interface Preset {
     data: Record<string, any>;
 }
 
+export interface SSGRunOptions {
+    displayName?: string;
+    triggerInstallFiles?: string[];
+    directPaths?: string[];
+    patterns?: {
+        doneStart?: string[];
+    };
+}
+
 /*******************
  *** Model Types ***
  *******************/

package/src/config/config-validator.ts

@@ -3,14 +3,16 @@ import Joi from 'joi';
 
 import { stackbitConfigSchema, contentModelsSchema } from './config-schema';
 import { ConfigValidationError } from './config-errors';
+import { RawConfigWithPaths } from './config-loader-utils';
+import { ContentModelMap, ModelMap } from './config-types';
 
 export interface ConfigValidationResult {
-    value: any;
+    value: RawConfigWithPaths;
     valid: boolean;
     errors: ConfigValidationError[];
 }
 
-export function validateConfig(config: any): ConfigValidationResult {
+export function validateConfig(config: RawConfigWithPaths): ConfigValidationResult {
     const validationOptions = { abortEarly: false };
     const validationResult = stackbitConfigSchema.validate(config, validationOptions);
     const value = validationResult.value;
@@ -24,7 +26,7 @@ export function validateConfig(config: any): ConfigValidationResult {
     };
 }
 
-export function validateContentModels(contentModels: any, models: any): ConfigValidationResult {
+export function validateContentModels(contentModels: ContentModelMap, models: ModelMap): ConfigValidationResult {
     const validationResult = contentModelsSchema.validate(
         { contentModels: contentModels },
         {

package/src/config/config-writer.ts

@@ -1,9 +1,9 @@
 import path from 'path';
 import fse from 'fs-extra';
 import yaml from 'js-yaml';
-import _ from 'lodash';
 
-import { Config, Model, YamlConfig, YamlModel, ModelMap } from './config-types';
+import { Config } from './config-types';
+import { convertToYamlConfig } from './config-loader-utils';
 
 const packageJson = require('../../package.json');
 
@@ -22,31 +22,3 @@ export async function writeConfig({ dirPath, config }: WriteConfigOptions) {
     const data = info + yamlString;
     await fse.outputFile(filePath, data);
 }
-
-export function convertToYamlConfig({ config }: { config: Config }): YamlConfig {
-    const yamlConfig: YamlConfig = _.cloneDeep(_.omit(config, 'models'));
-    if (!_.isEmpty(config.models)) {
-        yamlConfig.models = _.reduce(
-            config.models,
-            (yamlModels: ModelMap, model: Model) => {
-                if (model.type === 'image') {
-                    return yamlModels;
-                }
-                const yamlModel = _.omit(model, ['name', '__metadata']) as YamlModel;
-                if (yamlModel.type === 'page' && !yamlModel.hideContent && yamlModel.fields) {
-                    _.remove(yamlModel.fields, (field) => field.name === 'markdown_content');
-                }
-                if (yamlModel.type === 'page' && yamlModel.fields) {
-                    _.remove(yamlModel.fields, (field) => field.name === (config.pageLayoutKey || 'layout'));
-                }
-                if (yamlModel.type === 'data' && yamlModel.fields) {
-                    _.remove(yamlModel.fields, (field) => field.name === (config.objectTypeKey || 'type'));
-                }
-                yamlModels[model.name] = yamlModel;
-                return yamlModels;
-            },
-            {}
-        );
-    }
-    return yamlConfig;
-}

package/src/content/content-schema.ts

@@ -123,10 +123,7 @@ function joiSchemaForField(field: Field | FieldListItems, config: Config, fieldP
             fieldSchema = Joi.string().allow('', null);
             break;
         case 'image':
-            fieldSchema = Joi.alternatives([
-                Joi.string().allow('', null),
-                Joi.object()
-            ]);
+            fieldSchema = Joi.alternatives([Joi.string().allow('', null), Joi.object()]);
             break;
         case 'boolean':
             fieldSchema = Joi.boolean();
@@ -335,20 +332,22 @@ const textDecorationWrongValue = 'textDecoration.wrong.value';
 
 function stylePropTextDecorationSchema(styleConfig: any) {
     const values = styleConfig === '*' ? STYLE_PROPS_VALUES.textDecoration : styleConfig;
-    return Joi.string().custom((value: string, { error, errorsArray }: CustomHelpers & { errorsArray?: () => ErrorReport[] }) => {
-        const parts = value.split?.(' ');
-        const errors = errorsArray!();
-        parts.forEach((part) => {
-            if (!values.includes(part)) {
-                errors.push(error(textDecorationWrongValue));
+    return Joi.string()
+        .custom((value: string, { error, errorsArray }: CustomHelpers & { errorsArray?: () => ErrorReport[] }) => {
+            const parts = value.split?.(' ');
+            const errors = errorsArray!();
+            parts.forEach((part) => {
+                if (!values.includes(part)) {
+                    errors.push(error(textDecorationWrongValue));
+                }
+            });
+            return errors && errors.length ? errors : value;
+        })
+        .prefs({
+            messages: {
+                [textDecorationWrongValue]: `{{#label}} must be a space separated string values from [${values.join(', ')}]`
             }
         });
-        return errors && errors.length ? errors : value;
-    }).prefs({
-        messages: {
-            [textDecorationWrongValue]: `{{#label}} must be a space separated string values from [${values.join(', ')}]`
-        }
-    });
 }
 
 function stylePropSizeSchema(styleConfig: any) {
@@ -475,7 +474,7 @@ function stylePropOpacitySchema(styleConfig: any) {
     if (styleConfig === '*') {
         return Joi.number().integer().min(0).max(100).multiple(5);
     }
-     return Joi.number().valid(...parseRange(styleConfig, { userDefinedStep: false, defaultStep: 5 }));
+    return Joi.number().valid(...parseRange(styleConfig, { userDefinedStep: false, defaultStep: 5 }));
 }
 
 function parseRange(styleConfig: any, { userDefinedStep = true, defaultStep = 1 } = {}) {
@@ -508,4 +507,4 @@ function parseRange(styleConfig: any, { userDefinedStep = true, defaultStep = 1
         new Set<number>()
     );
     return Array.from(values);
-}
+}

package/src/index.ts

@@ -5,8 +5,10 @@ export * from './content/content-errors';
 export * from './config/config-errors';
 export * from './analyzer/file-browser';
 export * from './utils';
-export { loadConfig, loadConfigFromDir, extendConfig, ConfigLoaderOptions, ConfigLoaderResult } from './config/config-loader';
-export { writeConfig, WriteConfigOptions, convertToYamlConfig } from './config/config-writer';
+export * from './config/config-loader-static';
+export { RawConfigWithPaths, findStackbitConfigFile, isStackbitYamlFile, convertToYamlConfig } from './config/config-loader-utils';
+export { loadConfig, loadConfigFromDir, extendConfig, ConfigLoaderOptions, ConfigLoaderResult, ConfigLoaderResultWithStop } from './config/config-loader';
+export { writeConfig, WriteConfigOptions } from './config/config-writer';
 export { loadContent, ContentItem, ContentLoaderOptions, ContentLoaderResult } from './content/content-loader';
 export { matchSSG, SSGMatcherOptions, SSGMatchResult } from './analyzer/ssg-matcher';
 export { matchCMS, CMSMatcherOptions, CMSMatchResult } from './analyzer/cms-matcher';

package/src/utils/index.ts

@@ -9,7 +9,7 @@ type StricterUnionMember<T, Union, Keys extends string = UnionKeys<Union> extend
 
 export type StricterUnion<Union, Union2 = Union> = Union2 extends any ? StricterUnionMember<Union2, Union> : never;
 
-export type Logger = Pick<Console, 'log' | 'debug' | 'info' | 'warn' | 'error' | 'group' | 'groupEnd'>;
+export type Logger = Pick<Console, 'log' | 'debug' | 'info' | 'warn' | 'error'>;
 
 export * from './model-utils';
 export * from './model-matcher';

package/src/utils/model-extender.ts

@@ -21,12 +21,12 @@ export function extendModelArray(models: Model[]): { models: Model[]; errors: Co
     );
 }
 
-export function extendModelMap(models: ModelMap): { models: ModelMap; errors: ConfigValidationError[] } {
+export function extendModelMap(models?: ModelMap): { models: ModelMap; errors: ConfigValidationError[] } {
     const memorized = _.memoize(extendModel, (model, modelName) => modelName);
     return _.reduce(
         models,
         (result: { models: ModelMap; errors: ConfigValidationError[] }, model, modelName) => {
-            const { model: extendedModel, errors } = memorized(model, modelName, models);
+            const { model: extendedModel, errors } = memorized(model, modelName, models!);
             return {
                 models: _.assign(result.models, { [modelName]: extendedModel }),
                 errors: result.errors.concat(errors)