@jungvonmatt/contentful-ssg 1.0.4 → 1.4.0

package/dist/cli.js

@@ -2,6 +2,7 @@
 import path from 'path';
 import chalk from 'chalk';
 import { existsSync } from 'fs';
+import { readFile } from 'fs/promises';
 import { outputFile } from 'fs-extra';
 import prettier from 'prettier';
 import { Command } from 'commander';
@@ -44,7 +45,17 @@ program
     if (verified.directory?.startsWith('/')) {
         verified.directory = path.relative(process.cwd(), verified.directory);
     }
-    const environmentKeys = Object.keys(environmentConfig).filter((key) => environmentConfig[key] === verified[key]);
+    const environmentKeys = Object.keys(environmentConfig);
+    if (environmentConfig && existsSync('.env')) {
+        const envSource = await readFile('.env', 'utf8');
+        const nextEnvSource = envSource
+            .replace(/(CONTENTFUL_SPACE_ID\s*=\s*['"]?)[^'"]*(['"]?)/, `$1${verified.spaceId}$2`)
+            .replace(/(CONTENTFUL_ENVIRONMENT_ID\s*=\s*['"]?)[^'"]*(['"]?)/, `$1${verified.environmentId}$2`)
+            .replace(/(CONTENTFUL_MANAGEMENT_TOKEN\s*=\s*['"]?)[^'"]*(['"]?)/, `$1${verified.managementToken}$2`)
+            .replace(/(CONTENTFUL_PREVIEW_TOKEN\s*=\s*['"]?)[^'"]*(['"]?)/, `$1${verified.previewAccessToken}$2`)
+            .replace(/(CONTENTFUL_DELIVERY_TOKEN\s*=\s*['"]?)[^'"]*(['"]?)/, `$1${verified.accessToken}$2`);
+        await outputFile('.env', nextEnvSource);
+    }
     const cleanedConfig = omitKeys(verified, 'preview', 'verbose', 'rootDir', 'resolvedPlugins', 'host', 'managementToken', ...environmentKeys);
     let content = '';
     if (useTypescript) {

package/dist/lib/config.d.ts

@@ -1,3 +1,3 @@
 import type { Config, ContentfulConfig } from '../types.js';
-export declare const getEnvironmentConfig: () => ContentfulConfig;
+export declare const getEnvironmentConfig: (strict?: boolean) => ContentfulConfig;
 export declare const getConfig: (args?: Partial<Config>) => Promise<Config>;

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) => {
@@ -72,33 +73,34 @@ const loadConfig = async (moduleName) => {
     });
     return explorer.search();
 };
-export const getEnvironmentConfig = () => removeEmpty({
+export const getEnvironmentConfig = (strict = true) => removeEmpty({
     spaceId: process.env.CONTENTFUL_SPACE_ID,
     environmentId: process.env.CONTENTFUL_ENVIRONMENT_ID,
     managementToken: process.env.CONTENTFUL_MANAGEMENT_TOKEN,
     previewAccessToken: process.env.CONTENTFUL_PREVIEW_TOKEN,
     accessToken: process.env.CONTENTFUL_DELIVERY_TOKEN,
-});
+}, strict);
 export const getConfig = async (args) => {
     const defaultOptions = {
         environmentId: 'master',
         host: 'api.contentful.com',
         directory: resolve(process.cwd(), 'content'),
+        managedDirectories: [],
         plugins: [],
         resolvedPlugins: [],
     };
-    const environmentOptions = getEnvironmentConfig();
+    const environmentOptions = getEnvironmentConfig(false);
     let contentfulCliOptions = {};
     try {
         const contentfulConfig = await loadConfig('contentful');
-        if (!contentfulConfig.isEmpty) {
+        if (contentfulConfig && !contentfulConfig.isEmpty) {
             const { managementToken, activeSpaceId, activeEnvironmentId, host } = contentfulConfig.config;
             contentfulCliOptions = removeEmpty({
                 spaceId: activeSpaceId,
                 managementToken,
                 environmentId: activeEnvironmentId,
                 host,
-            });
+            }, false);
         }
     }
     catch (error) {
@@ -116,7 +118,7 @@ export const getConfig = async (args) => {
     args.rootDir = process.cwd();
     try {
         const configFile = await loadConfig('contentful-ssg');
-        if (!configFile.isEmpty) {
+        if (configFile && !configFile.isEmpty) {
             configFileOptions = configFile.config;
             args.rootDir = dirname(configFile.filepath);
             if (configFileOptions.directory && !isAbsolute(configFileOptions.directory)) {
@@ -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/lib/object.d.ts

@@ -5,7 +5,8 @@ export declare const isObject: (something: any) => boolean;
 export declare const getEntries: <T>(obj: T) => Entries<T>;
 export declare const fromEntries: <T = [string, unknown][]>(entries: Entries<T>) => T;
 export declare const omitKeys: <T, K extends keyof T>(obj: T, ...keys: K[]) => T;
-export declare const removeEmpty: <T>(iterable: T) => T;
+export declare const filterKeys: <T, K extends keyof T>(obj: T, ...keys: K[]) => T;
+export declare const removeEmpty: <T>(iterable: T, strict?: boolean) => T;
 export declare const snakeCaseKeys: <T>(iterable: T) => T;
 export declare const groupBy: <T extends Record<string, unknown>>(array: T[], key: keyof T) => Record<string, T[]>;
 export {};

package/dist/lib/object.js

@@ -8,14 +8,19 @@ export const omitKeys = (obj, ...keys) => {
     const filtered = entries.filter(([key]) => !keys.includes(key));
     return fromEntries(filtered);
 };
-export const removeEmpty = (iterable) => {
+export const filterKeys = (obj, ...keys) => {
+    const entries = getEntries(obj);
+    const filtered = entries.filter(([key]) => keys.includes(key));
+    return fromEntries(filtered);
+};
+export const removeEmpty = (iterable, strict = true) => {
     if (Array.isArray(iterable)) {
         return iterable
-            .filter((v) => v !== null && v !== undefined)
+            .filter((v) => v !== null && v !== undefined && (strict || Boolean(v)))
             .map((v) => (v === Object(v) ? removeEmpty(v) : v));
     }
     return fromEntries(getEntries(iterable)
-        .filter(([, v]) => v !== null && v !== undefined)
+        .filter(([, v]) => v !== null && v !== undefined && (strict || Boolean(v)))
         .map(([k, v]) => [k, v === Object(v) ? removeEmpty(v) : v]));
 };
 export const snakeCaseKeys = (iterable) => {

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.4",
+  "version": "1.4.0",
   "description": "",
   "main": "./dist/index.js",
   "type": "module",
@@ -8,10 +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",
@@ -23,6 +27,15 @@
       ".": [
         "./dist/types.d.ts"
       ],
+      "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"
       ],
@@ -38,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"
       ],
@@ -75,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",
@@ -139,5 +155,5 @@
       "module": "es2020"
     }
   },
-  "gitHead": "9da40bcd4fa8124cf7ae3ff6a2dcfca91c82c4fb"
+  "gitHead": "0d323f9884ae8fa48049e25bcd127954ee7988b8"
 }

package/src/cli.ts

@@ -4,6 +4,7 @@
 import path from 'path';
 import chalk from 'chalk';
 import { existsSync } from 'fs';
+import { readFile } from 'fs/promises';
 import { outputFile } from 'fs-extra';
 import prettier from 'prettier';
 import { Command } from 'commander';
@@ -67,9 +68,34 @@ program
         verified.directory = path.relative(process.cwd(), verified.directory);
       }
 
-      const environmentKeys: Array<keyof ContentfulConfig> = (
-        Object.keys(environmentConfig) as Array<keyof ContentfulConfig>
-      ).filter((key) => environmentConfig[key] === verified[key]);
+      const environmentKeys: Array<keyof ContentfulConfig> = Object.keys(
+        environmentConfig
+      ) as Array<keyof ContentfulConfig>;
+
+      // Update .env file
+      if (environmentConfig && existsSync('.env')) {
+        const envSource = await readFile('.env', 'utf8');
+        const nextEnvSource = envSource
+          .replace(/(CONTENTFUL_SPACE_ID\s*=\s*['"]?)[^'"]*(['"]?)/, `$1${verified.spaceId}$2`)
+          .replace(
+            /(CONTENTFUL_ENVIRONMENT_ID\s*=\s*['"]?)[^'"]*(['"]?)/,
+            `$1${verified.environmentId}$2`
+          )
+          .replace(
+            /(CONTENTFUL_MANAGEMENT_TOKEN\s*=\s*['"]?)[^'"]*(['"]?)/,
+            `$1${verified.managementToken}$2`
+          )
+          .replace(
+            /(CONTENTFUL_PREVIEW_TOKEN\s*=\s*['"]?)[^'"]*(['"]?)/,
+            `$1${verified.previewAccessToken}$2`
+          )
+          .replace(
+            /(CONTENTFUL_DELIVERY_TOKEN\s*=\s*['"]?)[^'"]*(['"]?)/,
+            `$1${verified.accessToken}$2`
+          );
+
+        await outputFile('.env', nextEnvSource);
+      }
 
       const cleanedConfig = omitKeys(
         verified,

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';
 
@@ -105,14 +106,17 @@ const loadConfig = async (moduleName: string): Promise<CosmiconfigResult> => {
   return explorer.search();
 };
 
-export const getEnvironmentConfig = (): ContentfulConfig =>
-  removeEmpty({
-    spaceId: process.env.CONTENTFUL_SPACE_ID!,
-    environmentId: process.env.CONTENTFUL_ENVIRONMENT_ID!,
-    managementToken: process.env.CONTENTFUL_MANAGEMENT_TOKEN!,
-    previewAccessToken: process.env.CONTENTFUL_PREVIEW_TOKEN!,
-    accessToken: process.env.CONTENTFUL_DELIVERY_TOKEN!,
-  });
+export const getEnvironmentConfig = (strict = true): ContentfulConfig =>
+  removeEmpty(
+    {
+      spaceId: process.env.CONTENTFUL_SPACE_ID!,
+      environmentId: process.env.CONTENTFUL_ENVIRONMENT_ID!,
+      managementToken: process.env.CONTENTFUL_MANAGEMENT_TOKEN!,
+      previewAccessToken: process.env.CONTENTFUL_PREVIEW_TOKEN!,
+      accessToken: process.env.CONTENTFUL_DELIVERY_TOKEN!,
+    },
+    strict
+  );
 
 /**
  * Get configuration
@@ -123,26 +127,30 @@ export const getConfig = async (args?: Partial<Config>): Promise<Config> => {
     environmentId: 'master',
     host: 'api.contentful.com',
     directory: resolve(process.cwd(), 'content'),
+    managedDirectories: [],
     plugins: [],
     resolvedPlugins: [],
   };
 
-  const environmentOptions = getEnvironmentConfig();
+  const environmentOptions = getEnvironmentConfig(false);
   let contentfulCliOptions: Partial<ContentfulConfig> = {};
 
   try {
     // Get configuration from contentful rc file (created by the contentful cli command)
     const contentfulConfig = await loadConfig('contentful');
-    if (!contentfulConfig.isEmpty) {
+    if (contentfulConfig && !contentfulConfig.isEmpty) {
       const { managementToken, activeSpaceId, activeEnvironmentId, host } =
         contentfulConfig.config as ContentfulRcConfig;
 
-      contentfulCliOptions = removeEmpty({
-        spaceId: activeSpaceId,
-        managementToken,
-        environmentId: activeEnvironmentId,
-        host,
-      });
+      contentfulCliOptions = removeEmpty(
+        {
+          spaceId: activeSpaceId,
+          managementToken,
+          environmentId: activeEnvironmentId,
+          host,
+        },
+        false
+      );
     }
   } catch (error: unknown) {
     if (typeof error === 'string') {
@@ -159,7 +167,7 @@ export const getConfig = async (args?: Partial<Config>): Promise<Config> => {
   try {
     // Get configuration from contentful-ssg rc file
     const configFile = await loadConfig('contentful-ssg');
-    if (!configFile.isEmpty) {
+    if (configFile && !configFile.isEmpty) {
       configFileOptions = configFile.config as Partial<Config>;
       args.rootDir = dirname(configFile.filepath);
       if (configFileOptions.directory && !isAbsolute(configFileOptions.directory)) {
@@ -191,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/lib/object.test.ts

@@ -1,5 +1,5 @@
 /* eslint-disable @typescript-eslint/naming-convention */
-import { isObject, omitKeys, removeEmpty, snakeCaseKeys, groupBy } from './object';
+import { isObject, omitKeys, filterKeys, removeEmpty, snakeCaseKeys, groupBy } from './object';
 
 test('isObject', async () => {
   const arr = [];
@@ -17,6 +17,11 @@ test('omitKeys', () => {
   expect(value).toEqual({ b: 2 });
 });
 
+test('filterKeys', () => {
+  const value = filterKeys({ a: 1, b: 2, c: 3 }, 'a', 'c');
+  expect(value).toEqual({ a: 1, c: 3 });
+});
+
 test('removeEmpty', () => {
   const value = removeEmpty({
     a: { c: undefined },
@@ -26,6 +31,16 @@ test('removeEmpty', () => {
   expect(value).toEqual({ a: {}, c: [1, { x: 1, z: [7] }, 3, 5] });
 });
 
+
+test('removeEmpty non-strict', () => {
+  const value = removeEmpty({
+    a: "",
+    b: 0,
+    c: 1,
+  }, false);
+  expect(value).toEqual({ c: 1 });
+});
+
 test('groupBy', () => {
   const value = groupBy(
     [

package/src/lib/object.ts

@@ -30,16 +30,27 @@ export const omitKeys = <T, K extends keyof T>(obj: T, ...keys: K[]): T => {
   return fromEntries(filtered);
 };
 
+/**
+ * Filter values by key from object
+ * @param {*} obj
+ * @param {*} keys
+ */
+export const filterKeys = <T, K extends keyof T>(obj: T, ...keys: K[]): T => {
+  const entries: Entries<T> = getEntries(obj);
+  const filtered = entries.filter(([key]) => keys.includes(key as K));
+  return fromEntries(filtered);
+};
+
 /**
  * Recursive remove empty items (null,undefined) from object
  * @param iterable Source object
  * @returns Cleaned object
  */
-export const removeEmpty = <T>(iterable: T): T => {
+export const removeEmpty = <T>(iterable: T, strict = true): T => {
   if (Array.isArray(iterable)) {
     return (
       iterable
-        .filter((v) => v !== null && v !== undefined)
+        .filter((v) => v !== null && v !== undefined && (strict || Boolean(v)))
         // eslint-disable-next-line @typescript-eslint/no-unsafe-return
         .map((v) => (v === Object(v) ? removeEmpty(v) : v)) as unknown as T
     );
@@ -47,7 +58,7 @@ export const removeEmpty = <T>(iterable: T): T => {
 
   return fromEntries(
     getEntries(iterable)
-      .filter(([, v]) => v !== null && v !== undefined)
+      .filter(([, v]) => v !== null && v !== undefined && (strict || Boolean(v)))
       .map(([k, v]) => [k, v === Object(v) ? removeEmpty(v) : v])
   );
 };

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[];