@jungvonmatt/contentful-ssg 1.0.5 → 1.4.8

package/dist/cli.js

@@ -16,8 +16,8 @@ const env = dotenv.config();
 dotenvExpand(env);
 const parseArgs = (cmd) => ({
     environment: cmd.env,
-    preview: Boolean(cmd.preview),
-    verbose: Boolean(cmd.verbose),
+    preview: cmd.preview,
+    verbose: cmd.verbose,
 });
 const errorHandler = (error, silence) => {
     if (!silence) {

package/dist/lib/config.js

@@ -4,6 +4,7 @@ import { cosmiconfig } from 'cosmiconfig';
 import mergeOptionsModule from 'merge-options';
 import { dirname, isAbsolute, resolve } from 'path';
 import slash from 'slash';
+import { reduceAsync } from './array.js';
 import { createRequire } from './create-require.js';
 import { isObject, removeEmpty } from './object.js';
 const typescriptLoader = async (filePath) => {
@@ -84,6 +85,7 @@ export const getConfig = async (args) => {
         environmentId: 'master',
         host: 'api.contentful.com',
         directory: resolve(process.cwd(), 'content'),
+        managedDirectories: [],
         plugins: [],
         resolvedPlugins: [],
     };
@@ -140,5 +142,10 @@ export const getConfig = async (args) => {
         ...result.resolvedPlugins,
         ...(await Promise.all((result.plugins || []).map(async (plugin) => resolvePlugin(plugin, result)))),
     ];
-    return { ...result, resolvedPlugins };
+    result.managedDirectories = [...result.managedDirectories, result.directory];
+    const hookedConfig = await reduceAsync(resolvedPlugins.filter((plugin) => typeof plugin.config === 'function'), async (prev, hooks) => {
+        const hook = hooks.config;
+        return hook(prev);
+    }, result);
+    return { ...hookedConfig, ...result, resolvedPlugins };
 };

package/dist/lib/file-manager.js

@@ -2,6 +2,7 @@ import { dirname, resolve, relative, join } from 'path';
 import ignore from 'ignore';
 import { readFile, readdir, lstat } from 'fs/promises';
 import { remove, outputFile } from 'fs-extra';
+import { existsSync } from 'fs';
 export class FileManager {
     ignoreBase = process.cwd();
     ignore;
@@ -25,7 +26,11 @@ export class FileManager {
             const ignorePatterns = await readFile(gitignore);
             this.ignore = ignore().add(ignorePatterns.toString('utf8'));
         }
-        const existing = await globby(`${this.config.directory}/**/*.*`);
+        const directories = [
+            ...new Set([...(this.config.managedDirectories || []), this.config.directory]),
+        ];
+        const globPattern = directories.map((directory) => resolve(this.config.rootDir || '', directory, '**/*.*'));
+        const existing = await globby(globPattern);
         this.files = new Set(existing.map((file) => resolve(file)));
     }
     async writeFile(file, data, options) {
@@ -51,7 +56,7 @@ export class FileManager {
             await Promise.all(recursiveRemovalPromises);
             fileNames = await readdir(directory);
         }
-        if (fileNames.length === 0 && directory !== this.config.directory) {
+        if (fileNames.length === 0 && ![this.config.directory, 'data'].includes(directory)) {
             await remove(directory);
         }
     }
@@ -59,6 +64,9 @@ export class FileManager {
         const promises = [...this.ignoredFiles].map(async (file) => this.deleteFile(file));
         await Promise.allSettled(promises);
         await this.removeEmptyDirectories(this.config.directory);
+        if (existsSync('data')) {
+            await this.removeEmptyDirectories('data');
+        }
         return true;
     }
 }

package/dist/types.d.ts

@@ -30,10 +30,12 @@ export interface ContentfulRcConfig {
     activeEnvironmentId: string;
     host: string;
 }
+export declare type ConfigHook = (config: Config) => Config | Promise<Config>;
 export declare type RuntimeHook = (runtimeContext: RuntimeContext) => Promise<Partial<RuntimeContext>> | Partial<RuntimeContext> | void;
 export declare type TransformHook<T> = (transformContext: TransformContext, runtimeContext?: RuntimeContext, prev?: T) => Promise<T> | T;
 export declare type ValidateHook = (transformContext: TransformContext, runtimeContext?: RuntimeContext) => Promise<boolean> | boolean;
 export interface Hooks {
+    config?: ConfigHook;
     before?: RuntimeHook;
     after?: RuntimeHook;
     transform?: TransformHook<KeyValueMap>;
@@ -46,6 +48,7 @@ export interface Hooks {
 export declare type Config = Partial<ContentfulConfig> & Hooks & {
     rootDir?: string;
     directory: string;
+    managedDirectories?: string[];
     verbose?: boolean;
     plugins?: Array<[string, KeyValueMap] | PluginInfo | string>;
     resolvedPlugins?: Hooks[];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jungvonmatt/contentful-ssg",
-  "version": "1.0.5",
+  "version": "1.4.8",
   "description": "",
   "main": "./dist/index.js",
   "type": "module",
@@ -8,11 +8,14 @@
   "exports": {
     ".": "./dist/index.js",
     "./lib/object": "./dist/lib/object.js",
+    "./lib/config": "./dist/lib/config.js",
     "./lib/array": "./dist/lib/array.js",
     "./lib/utils": "./dist/lib/utils.js",
+    "./lib/ui": "./dist/lib/ui.js",
     "./lib/contentful": "./dist/lib/contentful.js",
     "./lib/hook-manager": "./dist/lib/hook-manager.js",
     "./lib/file-manager": "./dist/lib/file-manager.js",
+    "./converter": "./dist/converter/index.js",
     "./converter/json": "./dist/converter/json.js",
     "./converter/yaml": "./dist/converter/yaml.js",
     "./converter/toml": "./dist/converter/toml.js",
@@ -27,6 +30,12 @@
       "lib/utils": [
         "./dist/lib/utils.d.ts"
       ],
+      "lib/ui": [
+        "./dist/lib/ui.d.ts"
+      ],
+      "lib/config": [
+        "./dist/lib/config.d.ts"
+      ],
       "lib/object": [
         "./dist/lib/object.d.ts"
       ],
@@ -42,6 +51,9 @@
       "lib/file-manager": [
         "./dist/lib/file-manager.d.ts"
       ],
+      "converter": [
+        "./dist/converter/index.d.ts"
+      ],
       "converter/json": [
         "./dist/converter/json.d.ts"
       ],
@@ -79,7 +91,7 @@
     "dist"
   ],
   "author": "Jung von Matt TECH GmbH",
-  "license": "ISC",
+  "license": "MIT",
   "dependencies": {
     "@contentful/rich-text-html-renderer": "^15.6.2",
     "@contentful/rich-text-types": "^15.6.2",
@@ -143,5 +155,5 @@
       "module": "es2020"
     }
   },
-  "gitHead": "03741b4add20ce95e1cd539bc46b7630cddcc2c3"
+  "gitHead": "28da6d98d1ba37a9bbaf6f1b22157c226be6d477"
 }

package/src/cli.ts

@@ -22,8 +22,8 @@ dotenvExpand(env);
 
 const parseArgs = (cmd) => ({
   environment: cmd.env as string,
-  preview: Boolean(cmd.preview),
-  verbose: Boolean(cmd.verbose),
+  preview: cmd.preview as boolean,
+  verbose: cmd.verbose as boolean,
 });
 
 type CommandError = Error & {

package/src/lib/config.ts

@@ -14,6 +14,7 @@ import type {
   PluginInfo,
   PluginModule,
 } from '../types.js';
+import { reduceAsync } from './array.js';
 import { createRequire } from './create-require.js';
 import { isObject, removeEmpty } from './object.js';
 
@@ -126,6 +127,7 @@ export const getConfig = async (args?: Partial<Config>): Promise<Config> => {
     environmentId: 'master',
     host: 'api.contentful.com',
     directory: resolve(process.cwd(), 'content'),
+    managedDirectories: [],
     plugins: [],
     resolvedPlugins: [],
   };
@@ -197,5 +199,17 @@ export const getConfig = async (args?: Partial<Config>): Promise<Config> => {
       (result.plugins || []).map(async (plugin) => resolvePlugin(plugin, result))
     )),
   ];
-  return { ...result, resolvedPlugins };
+
+  result.managedDirectories = [...result.managedDirectories, result.directory];
+
+  const hookedConfig = await reduceAsync(
+    resolvedPlugins.filter((plugin) => typeof plugin.config === 'function'),
+    async (prev: Config, hooks) => {
+      const hook = hooks.config;
+      return hook(prev);
+    },
+    result
+  );
+
+  return { ...hookedConfig, ...result, resolvedPlugins };
 };

package/src/lib/file-manager.ts

@@ -4,6 +4,7 @@ import { dirname, resolve, relative, join } from 'path';
 import ignore from 'ignore';
 import { readFile, readdir, lstat } from 'fs/promises';
 import { remove, outputFile } from 'fs-extra';
+import { existsSync } from 'fs';
 
 export class FileManager {
   ignoreBase: string = process.cwd();
@@ -38,8 +39,15 @@ export class FileManager {
       this.ignore = ignore().add(ignorePatterns.toString('utf8'));
     }
 
+    const directories = [
+      ...new Set([...(this.config.managedDirectories || []), this.config.directory]),
+    ];
+
+    const globPattern = directories.map((directory) =>
+      resolve(this.config.rootDir || '', directory, '**/*.*')
+    );
     // Create set of existing files
-    const existing = await globby(`${this.config.directory}/**/*.*`);
+    const existing = await globby(globPattern);
 
     this.files = new Set(existing.map((file) => resolve(file)));
   }
@@ -91,7 +99,7 @@ export class FileManager {
       fileNames = await readdir(directory);
     }
 
-    if (fileNames.length === 0 && directory !== this.config.directory) {
+    if (fileNames.length === 0 && ![this.config.directory, 'data'].includes(directory)) {
       await remove(directory);
     }
   }
@@ -101,6 +109,10 @@ export class FileManager {
 
     await Promise.allSettled(promises);
     await this.removeEmptyDirectories(this.config.directory);
+    if (existsSync('data')) {
+      await this.removeEmptyDirectories('data');
+    }
+
     return true;
   }
 }

package/src/types.ts

@@ -52,6 +52,8 @@ export interface ContentfulRcConfig {
   host: string;
 }
 
+export type ConfigHook = (config: Config) => Config | Promise<Config>;
+
 export type RuntimeHook = (
   runtimeContext: RuntimeContext
 ) => Promise<Partial<RuntimeContext>> | Partial<RuntimeContext> | void;
@@ -66,6 +68,7 @@ export type ValidateHook = (
 ) => Promise<boolean> | boolean;
 
 export interface Hooks {
+  config?: ConfigHook;
   before?: RuntimeHook;
   after?: RuntimeHook;
   transform?: TransformHook<KeyValueMap>;
@@ -80,6 +83,7 @@ export type Config = Partial<ContentfulConfig> &
   Hooks & {
     rootDir?: string;
     directory: string;
+    managedDirectories?: string[];
     verbose?: boolean;
     plugins?: Array<[string, KeyValueMap] | PluginInfo | string>;
     resolvedPlugins?: Hooks[];