@jungvonmatt/contentful-config 3.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Jung von Matt TECH (https://www.jvm.com/)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,51 @@
+[![NPM version][npm-image]][npm-url]
+
+# JvM Contentful config loader
+
+Tool for loading and managing Contentful configurations with support for environment variables and interactive prompts.
+
+## Getting started
+
+### Install
+
+```bash
+npm install @jungvonmatt/contentful-config
+```
+
+## Usage
+
+### Basic Example
+
+```js
+import { loadContentfulConfig } from '@jungvonmatt/contentful-config';
+
+// Load configuration from multiple sources:
+// - contentful-cli configuration file (~/.contentfulrc.json)
+// - environment variables (CONTENTFUL_SPACE_ID, etc.)
+// - project configuration files (myapp.config.js, .myapprc, etc.)
+const { config } = await loadContentfulConfig('myapp');
+
+console.log(config.spaceId); // Contentful Space ID
+console.log(config.environmentId); // Contentful Environment ID (defaults to 'master')
+console.log(config.accessToken); // Content Delivery API Token
+console.log(config.previewAccessToken); // Content Preview API Token
+console.log(config.managementToken); // Content Management API Token
+```
+
+### With Required Values
+
+```js
+import { loadContentfulConfig } from '@jungvonmatt/contentful-config';
+
+// If required values are not found in configuration files or 
+// environment variables, an interactive prompt will be displayed
+const { config } = await loadContentfulConfig('myapp', {
+  required: ['spaceId', 'accessToken']
+});
+
+// The configuration now contains all required values,
+// either from existing sources or user input
+```
+
+[npm-url]: https://www.npmjs.com/package/@jungvonmatt/contentful-config
+[npm-image]: https://img.shields.io/npm/v/@jungvonmatt/contentful-config.svg

package/dist/contentful.d.ts

@@ -0,0 +1,19 @@
+import type { SetRequired } from 'type-fest';
+import type { ClientOptions, Space } from 'contentful-management';
+import contentful from 'contentful-management';
+export type ContentfulOptions = {
+    accessToken: ClientOptions['accessToken'];
+    host?: ClientOptions['host'];
+    managementToken?: ClientOptions['accessToken'];
+    previewAccessToken?: ClientOptions['accessToken'];
+    environmentId?: string;
+    activeEnvironmentId?: string;
+    spaceId?: string;
+    activeSpaceId?: string;
+};
+export declare const getSpaces: (options: ContentfulOptions) => Promise<Space[]>;
+export declare const getSpace: (options: SetRequired<ContentfulOptions, "spaceId">) => Promise<Space>;
+export declare const getEnvironments: (options: SetRequired<ContentfulOptions, "spaceId">) => Promise<contentful.Environment[]>;
+export declare const getEnvironment: (options: SetRequired<ContentfulOptions, "spaceId" | "environmentId">) => Promise<contentful.Environment>;
+export declare const getApiKey: (options: SetRequired<ContentfulOptions, "spaceId">) => Promise<string>;
+export declare const getPreviewApiKey: (options: SetRequired<ContentfulOptions, "spaceId">) => Promise<string>;

package/dist/contentful.js

@@ -0,0 +1,62 @@
+import contentful from 'contentful-management';
+let client;
+const getClient = (options) => {
+    const { accessToken, managementToken, host } = options || {};
+    if (client) {
+        return client;
+    }
+    const params = {
+        accessToken: managementToken || accessToken,
+    };
+    if (host) {
+        params.host = host;
+    }
+    if (params.accessToken) {
+        client = contentful.createClient(params);
+        return client;
+    }
+    throw new Error('You need to login first. Run npx contentful login or pass the contentful management token');
+};
+export const getSpaces = async (options) => {
+    const client = getClient(options);
+    const { items: spaces } = await client.getSpaces();
+    return spaces;
+};
+export const getSpace = async (options) => {
+    const { spaceId } = options || {};
+    const client = getClient(options);
+    return client.getSpace(spaceId);
+};
+export const getEnvironments = async (options) => {
+    const space = await getSpace(options);
+    const { items: environments } = await space.getEnvironments();
+    return environments;
+};
+export const getEnvironment = async (options) => {
+    const { environmentId, spaceId } = options || {};
+    const space = await getSpace(options);
+    const { items: environments } = await space.getEnvironments();
+    const environmentIds = (environments || []).map((env) => env.sys.id);
+    if (environmentId && environmentIds.includes(environmentId)) {
+        return space.getEnvironment(environmentId);
+    }
+    if (environmentId && !environmentIds.includes(environmentId)) {
+        throw new Error(`Environment "${environmentId}" is not available in space ${spaceId}"`);
+    }
+    throw new Error('Missing required parameter: environmentId');
+};
+export const getApiKey = async (options) => {
+    const space = await getSpace(options);
+    const { items: apiKeys = [] } = (await space.getApiKeys()) || {};
+    const [apiKey] = apiKeys;
+    const { accessToken } = apiKey || {};
+    return accessToken;
+};
+export const getPreviewApiKey = async (options) => {
+    const space = await getSpace(options);
+    const { items: previewApiKeys = [] } = await space.getPreviewApiKeys();
+    const [previewApiKey] = previewApiKeys;
+    const { accessToken: previewAccessToken } = previewApiKey;
+    return previewAccessToken;
+};
+//# sourceMappingURL=contentful.js.map

package/dist/contentful.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"contentful.js","sourceRoot":"","sources":["../src/contentful.ts"],"names":[],"mappings":"AAEA,OAAO,UAAU,MAAM,uBAAuB,CAAC;AAE/C,IAAI,MAAiB,CAAC;AAgBtB,MAAM,SAAS,GAAG,CAAC,OAA0B,EAAE,EAAE;IAC/C,MAAM,EAAE,WAAW,EAAE,eAAe,EAAE,IAAI,EAAE,GAAG,OAAO,IAAI,EAAE,CAAC;IAE7D,IAAI,MAAM,EAAE,CAAC;QACX,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,MAAM,MAAM,GAAkB;QAC5B,WAAW,EAAE,eAAe,IAAI,WAAW;KAC5C,CAAC;IAEF,IAAI,IAAI,EAAE,CAAC;QACT,MAAM,CAAC,IAAI,GAAG,IAAI,CAAC;IACrB,CAAC;IAED,IAAI,MAAM,CAAC,WAAW,EAAE,CAAC;QACvB,MAAM,GAAG,UAAU,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC;QACzC,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,MAAM,IAAI,KAAK,CACb,2FAA2F,CAC5F,CAAC;AACJ,CAAC,CAAC;AAKF,MAAM,CAAC,MAAM,SAAS,GAAG,KAAK,EAAE,OAA0B,EAAoB,EAAE;IAC9E,MAAM,MAAM,GAAG,SAAS,CAAC,OAAO,CAAC,CAAC;IAElC,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,MAAM,MAAM,CAAC,SAAS,EAAE,CAAC;IAEnD,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC;AAKF,MAAM,CAAC,MAAM,QAAQ,GAAG,KAAK,EAAE,OAAkD,EAAE,EAAE;IACnF,MAAM,EAAE,OAAO,EAAE,GAAG,OAAO,IAAI,EAAE,CAAC;IAClC,MAAM,MAAM,GAAG,SAAS,CAAC,OAAO,CAAC,CAAC;IAClC,OAAO,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;AAClC,CAAC,CAAC;AAKF,MAAM,CAAC,MAAM,eAAe,GAAG,KAAK,EAAE,OAAkD,EAAE,EAAE;IAC1F,MAAM,KAAK,GAAG,MAAM,QAAQ,CAAC,OAAO,CAAC,CAAC;IACtC,MAAM,EAAE,KAAK,EAAE,YAAY,EAAE,GAAG,MAAM,KAAK,CAAC,eAAe,EAAE,CAAC;IAE9D,OAAO,YAAY,CAAC;AACtB,CAAC,CAAC;AAKF,MAAM,CAAC,MAAM,cAAc,GAAG,KAAK,EACjC,OAAoE,EACpE,EAAE;IACF,MAAM,EAAE,aAAa,EAAE,OAAO,EAAE,GAAG,OAAO,IAAI,EAAE,CAAC;IACjD,MAAM,KAAK,GAAG,MAAM,QAAQ,CAAC,OAAO,CAAC,CAAC;IAEtC,MAAM,EAAE,KAAK,EAAE,YAAY,EAAE,GAAG,MAAM,KAAK,CAAC,eAAe,EAAE,CAAC;IAE9D,MAAM,cAAc,GAAG,CAAC,YAAY,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;IAErE,IAAI,aAAa,IAAI,cAAc,CAAC,QAAQ,CAAC,aAAa,CAAC,EAAE,CAAC;QAC5D,OAAO,KAAK,CAAC,cAAc,CAAC,aAAa,CAAC,CAAC;IAC7C,CAAC;IAED,IAAI,aAAa,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,aAAa,CAAC,EAAE,CAAC;QAC7D,MAAM,IAAI,KAAK,CAAC,gBAAgB,aAAa,+BAA+B,OAAO,GAAG,CAAC,CAAC;IAC1F,CAAC;IAED,MAAM,IAAI,KAAK,CAAC,2CAA2C,CAAC,CAAC;AAC/D,CAAC,CAAC;AAKF,MAAM,CAAC,MAAM,SAAS,GAAG,KAAK,EAAE,OAAkD,EAAE,EAAE;IACpF,MAAM,KAAK,GAAG,MAAM,QAAQ,CAAC,OAAO,CAAC,CAAC;IAEtC,MAAM,EAAE,KAAK,EAAE,OAAO,GAAG,EAAE,EAAE,GAAG,CAAC,MAAM,KAAK,CAAC,UAAU,EAAE,CAAC,IAAI,EAAE,CAAC;IACjE,MAAM,CAAC,MAAM,CAAC,GAAG,OAAO,CAAC;IACzB,MAAM,EAAE,WAAW,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;IAErC,OAAO,WAAW,CAAC;AACrB,CAAC,CAAC;AAKF,MAAM,CAAC,MAAM,gBAAgB,GAAG,KAAK,EAAE,OAAkD,EAAE,EAAE;IAC3F,MAAM,KAAK,GAAG,MAAM,QAAQ,CAAC,OAAO,CAAC,CAAC;IAEtC,MAAM,EAAE,KAAK,EAAE,cAAc,GAAG,EAAE,EAAE,GAAG,MAAM,KAAK,CAAC,iBAAiB,EAAE,CAAC;IACvE,MAAM,CAAC,aAAa,CAAC,GAAG,cAAc,CAAC;IACvC,MAAM,EAAE,WAAW,EAAE,kBAAkB,EAAE,GAAG,aAAuB,CAAC;IAEpE,OAAO,kBAAkB,CAAC;AAC5B,CAAC,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,42 @@
+import type { LoadConfigOptions } from '@jungvonmatt/config-loader';
+import { type ContentfulOptions } from './contentful.js';
+export declare const getPromts: (data: Partial<ContentfulOptions>) => ({
+    type: string;
+    name: string;
+    message: string;
+    initial: string | (() => Promise<string>);
+    choices?: undefined;
+    skip?: undefined;
+} | {
+    type: string;
+    name: string;
+    message: string;
+    choices: (answers: Partial<ContentfulOptions>) => Promise<{
+        name: string;
+        value: string;
+    }[]>;
+    initial: string;
+    skip?: undefined;
+} | {
+    type: string;
+    name: string;
+    message: string;
+    choices: (answers: Partial<ContentfulOptions>) => Promise<string[]>;
+    initial: string;
+    skip?: undefined;
+} | {
+    type: string;
+    name: string;
+    message: string;
+    skip(answers: Partial<ContentfulOptions>): boolean;
+    initial: (answers: Partial<ContentfulOptions>) => Promise<string>;
+    choices?: undefined;
+})[];
+type LoadContentfulConfigOptions<T extends Record<string, any> = ContentfulOptions> = Omit<LoadConfigOptions<T>, 'name'>;
+export declare const loadContentfulConfig: <T extends Record<string, any> = ContentfulOptions>(name: string, options?: LoadContentfulConfigOptions<T>) => Promise<{
+    config: T;
+    isEmpty: boolean;
+    filepath: string | undefined;
+    missing: string[];
+}>;
+export {};

package/dist/index.js

@@ -0,0 +1,113 @@
+import { homedir } from 'node-homedir';
+import { getApiKey, getEnvironments, getPreviewApiKey, getSpaces, } from './contentful.js';
+export const getPromts = (data) => {
+    return [
+        {
+            type: 'input',
+            name: 'managementToken',
+            message: 'Management Token',
+            initial: data.managementToken,
+        },
+        {
+            type: 'select',
+            name: 'spaceId',
+            message: 'Space ID',
+            choices: async (answers) => {
+                const token = data.managementToken || answers.managementToken;
+                if (token) {
+                    const spaces = await getSpaces({ accessToken: token });
+                    return spaces.map((space) => ({
+                        name: `${space.name} (${space.sys.id})`,
+                        value: space.sys.id,
+                    }));
+                }
+                return [];
+            },
+            initial: data?.spaceId ?? data?.activeSpaceId,
+        },
+        {
+            type: 'select',
+            name: 'environmentId',
+            message: 'Environment ID',
+            choices: async (answers) => {
+                const token = data.managementToken || answers.managementToken;
+                const spaceId = answers.spaceId || data.spaceId;
+                if (token && spaceId) {
+                    const environments = await getEnvironments({ accessToken: token, spaceId });
+                    return environments.map((environment) => environment.sys.id);
+                }
+                return [];
+            },
+            initial: data?.environmentId || data?.activeEnvironmentId,
+        },
+        {
+            type: 'input',
+            name: 'accessToken',
+            message: 'Content Delivery API - access token',
+            skip(answers) {
+                return !answers.spaceId && !data.spaceId;
+            },
+            initial: async (answers) => {
+                if (data.accessToken) {
+                    return typeof data.accessToken === 'function' ? data.accessToken() : data.accessToken;
+                }
+                const token = data.managementToken || answers.managementToken;
+                const spaceId = answers.spaceId || data.spaceId;
+                if (token && spaceId) {
+                    return getApiKey({ accessToken: token, spaceId });
+                }
+            },
+        },
+        {
+            type: 'input',
+            name: 'previewAccessToken',
+            message: 'Content Preview API - access token',
+            skip(answers) {
+                return !answers.spaceId && !data.spaceId;
+            },
+            initial: async (answers) => {
+                if (data.previewAccessToken) {
+                    return typeof data.previewAccessToken === 'function'
+                        ? data.previewAccessToken()
+                        : data.previewAccessToken;
+                }
+                const token = data.managementToken || answers.managementToken;
+                const spaceId = answers.spaceId || data.spaceId;
+                if (token && spaceId) {
+                    return getPreviewApiKey({ accessToken: token, spaceId });
+                }
+            },
+        },
+    ];
+};
+export const loadContentfulConfig = async (name, options = {}) => {
+    const { loadConfig } = await import('@jungvonmatt/config-loader');
+    const contentfulCliOptions = await loadConfig({
+        name: 'contentful',
+        cwd: homedir(),
+    });
+    const result = await loadConfig({
+        ...options,
+        name,
+        defaultConfig: {
+            environmentId: 'master',
+            host: 'api.contentful.com',
+            ...contentfulCliOptions.config,
+            ...options?.defaultConfig,
+        },
+        envMap: {
+            CONTENTFUL_SPACE_ID: 'spaceId',
+            CONTENTFUL_ENVIRONMENT_ID: 'environmentId',
+            CONTENTFUL_MANAGEMENT_TOKEN: 'managementToken',
+            CONTENTFUL_PREVIEW_TOKEN: 'previewAccessToken',
+            CONTENTFUL_PREVIEW_ACCESS_TOKEN: 'previewAccessToken',
+            CONTENTFUL_DELIVERY_TOKEN: 'accessToken',
+            CONTENTFUL_DELIVERY_ACCESS_TOKEN: 'accessToken',
+            CONTENTFUL_HOST: 'host',
+            ...options?.envMap,
+        },
+        prompts: getPromts,
+    });
+    return { ...result, config: result.config };
+};
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AAEvC,OAAO,EAEL,SAAS,EACT,eAAe,EACf,gBAAgB,EAChB,SAAS,GACV,MAAM,iBAAiB,CAAC;AAEzB,MAAM,CAAC,MAAM,SAAS,GAAG,CAAC,IAAgC,EAAE,EAAE;IAC5D,OAAO;QACL;YACE,IAAI,EAAE,OAAO;YACb,IAAI,EAAE,iBAAiB;YACvB,OAAO,EAAE,kBAAkB;YAC3B,OAAO,EAAE,IAAI,CAAC,eAAe;SAC9B;QACD;YACE,IAAI,EAAE,QAAQ;YACd,IAAI,EAAE,SAAS;YACf,OAAO,EAAE,UAAU;YACnB,OAAO,EAAE,KAAK,EAAE,OAAmC,EAAE,EAAE;gBACrD,MAAM,KAAK,GAAG,IAAI,CAAC,eAAe,IAAI,OAAO,CAAC,eAAe,CAAC;gBAC9D,IAAI,KAAK,EAAE,CAAC;oBACV,MAAM,MAAM,GAAG,MAAM,SAAS,CAAC,EAAE,WAAW,EAAE,KAAK,EAAE,CAAC,CAAC;oBACvD,OAAO,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;wBAC5B,IAAI,EAAE,GAAG,KAAK,CAAC,IAAI,KAAK,KAAK,CAAC,GAAG,CAAC,EAAE,GAAG;wBACvC,KAAK,EAAE,KAAK,CAAC,GAAG,CAAC,EAAE;qBACpB,CAAC,CAAC,CAAC;gBACN,CAAC;gBAED,OAAO,EAAE,CAAC;YACZ,CAAC;YACD,OAAO,EAAE,IAAI,EAAE,OAAO,IAAI,IAAI,EAAE,aAAa;SAC9C;QACD;YACE,IAAI,EAAE,QAAQ;YACd,IAAI,EAAE,eAAe;YACrB,OAAO,EAAE,gBAAgB;YACzB,OAAO,EAAE,KAAK,EAAE,OAAmC,EAAE,EAAE;gBACrD,MAAM,KAAK,GAAG,IAAI,CAAC,eAAe,IAAI,OAAO,CAAC,eAAe,CAAC;gBAC9D,MAAM,OAAO,GAAG,OAAO,CAAC,OAAO,IAAI,IAAI,CAAC,OAAO,CAAC;gBAChD,IAAI,KAAK,IAAI,OAAO,EAAE,CAAC;oBACrB,MAAM,YAAY,GAAG,MAAM,eAAe,CAAC,EAAE,WAAW,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC,CAAC;oBAC5E,OAAO,YAAY,CAAC,GAAG,CAAC,CAAC,WAAW,EAAE,EAAE,CAAC,WAAW,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;gBAC/D,CAAC;gBAED,OAAO,EAAE,CAAC;YACZ,CAAC;YACD,OAAO,EAAE,IAAI,EAAE,aAAa,IAAI,IAAI,EAAE,mBAAmB;SAC1D;QACD;YACE,IAAI,EAAE,OAAO;YACb,IAAI,EAAE,aAAa;YACnB,OAAO,EAAE,qCAAqC;YAC9C,IAAI,CAAC,OAAmC;gBACtC,OAAO,CAAC,OAAO,CAAC,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC;YAC3C,CAAC;YACD,OAAO,EAAE,KAAK,EAAE,OAAmC,EAAE,EAAE;gBACrD,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;oBACrB,OAAO,OAAO,IAAI,CAAC,WAAW,KAAK,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC;gBACxF,CAAC;gBAED,MAAM,KAAK,GAAG,IAAI,CAAC,eAAe,IAAI,OAAO,CAAC,eAAe,CAAC;gBAC9D,MAAM,OAAO,GAAG,OAAO,CAAC,OAAO,IAAI,IAAI,CAAC,OAAO,CAAC;gBAChD,IAAI,KAAK,IAAI,OAAO,EAAE,CAAC;oBACrB,OAAO,SAAS,CAAC,EAAE,WAAW,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC,CAAC;gBACpD,CAAC;YACH,CAAC;SACF;QACD;YACE,IAAI,EAAE,OAAO;YACb,IAAI,EAAE,oBAAoB;YAC1B,OAAO,EAAE,oCAAoC;YAC7C,IAAI,CAAC,OAAmC;gBACtC,OAAO,CAAC,OAAO,CAAC,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC;YAC3C,CAAC;YACD,OAAO,EAAE,KAAK,EAAE,OAAmC,EAAE,EAAE;gBACrD,IAAI,IAAI,CAAC,kBAAkB,EAAE,CAAC;oBAC5B,OAAO,OAAO,IAAI,CAAC,kBAAkB,KAAK,UAAU;wBAClD,CAAC,CAAC,IAAI,CAAC,kBAAkB,EAAE;wBAC3B,CAAC,CAAC,IAAI,CAAC,kBAAkB,CAAC;gBAC9B,CAAC;gBAED,MAAM,KAAK,GAAG,IAAI,CAAC,eAAe,IAAI,OAAO,CAAC,eAAe,CAAC;gBAC9D,MAAM,OAAO,GAAG,OAAO,CAAC,OAAO,IAAI,IAAI,CAAC,OAAO,CAAC;gBAChD,IAAI,KAAK,IAAI,OAAO,EAAE,CAAC;oBACrB,OAAO,gBAAgB,CAAC,EAAE,WAAW,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC,CAAC;gBAC3D,CAAC;YACH,CAAC;SACF;KACF,CAAC;AACJ,CAAC,CAAC;AAOF,MAAM,CAAC,MAAM,oBAAoB,GAAG,KAAK,EACvC,IAAY,EACZ,UAA0C,EAAE,EAC5C,EAAE;IACF,MAAM,EAAE,UAAU,EAAE,GAAG,MAAM,MAAM,CAAC,4BAA4B,CAAC,CAAC;IAIlE,MAAM,oBAAoB,GAAG,MAAM,UAAU,CAAI;QAC/C,IAAI,EAAE,YAAY;QAClB,GAAG,EAAE,OAAO,EAAE;KACf,CAAC,CAAC;IAEH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAI;QACjC,GAAG,OAAO;QACV,IAAI;QACJ,aAAa,EAAE;YACb,aAAa,EAAE,QAAQ;YACvB,IAAI,EAAE,oBAAoB;YAC1B,GAAG,oBAAoB,CAAC,MAAM;YAC9B,GAAG,OAAO,EAAE,aAAa;SAC1B;QACD,MAAM,EAAE;YACN,mBAAmB,EAAE,SAAS;YAC9B,yBAAyB,EAAE,eAAe;YAC1C,2BAA2B,EAAE,iBAAiB;YAC9C,wBAAwB,EAAE,oBAAoB;YAC9C,+BAA+B,EAAE,oBAAoB;YACrD,yBAAyB,EAAE,aAAa;YACxC,gCAAgC,EAAE,aAAa;YAC/C,eAAe,EAAE,MAAM;YACvB,GAAG,OAAO,EAAE,MAAM;SACV;QACV,OAAO,EAAE,SAAS;KACnB,CAAC,CAAC;IAEH,OAAO,EAAE,GAAG,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,MAAW,EAAE,CAAC;AACnD,CAAC,CAAC"}

package/package.json

@@ -0,0 +1,45 @@
+{
+  "name": "@jungvonmatt/contentful-config",
+  "version": "3.0.0",
+  "main": "./dist/index.js",
+  "type": "module",
+  "exports": "./dist/index.js",
+  "bin": {
+    "contentful-typings": "./dist/cli.js"
+  },
+  "files": [
+    "src",
+    "dist"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "engines": {
+    "node": ">=18"
+  },
+  "scripts": {
+    "clean": "rimraf ./dist",
+    "test": "jest",
+    "lint": "eslint --color src --fix --ext .ts",
+    "precompile": "npm run clean",
+    "compile": "tsc --build",
+    "watch": "tsc --build --watch"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/jungvonmatt/contentful-ssg.git"
+  },
+  "author": "",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/jungvonmatt/contentful-ssg/issues"
+  },
+  "homepage": "https://github.com/jungvonmatt/contentful-ssg#readme",
+  "dependencies": {
+    "@jungvonmatt/config-loader": "^0.1.0",
+    "contentful-management": "^11.12.1",
+    "node-homedir": "^2.0.0",
+    "type-fest": "^4.41.0"
+  },
+  "gitHead": "31f9f440b9e48364b7e11372ca0accf55c8ff368"
+}

package/src/contentful.ts

@@ -0,0 +1,124 @@
+import type { SetRequired } from 'type-fest';
+import type { ApiKey, ClientAPI, ClientOptions, Space } from 'contentful-management';
+import contentful from 'contentful-management';
+
+let client: ClientAPI;
+
+export type ContentfulOptions = {
+  accessToken: ClientOptions['accessToken'];
+  host?: ClientOptions['host'];
+  managementToken?: ClientOptions['accessToken'];
+  previewAccessToken?: ClientOptions['accessToken'];
+  environmentId?: string;
+  activeEnvironmentId?: string;
+  spaceId?: string;
+  activeSpaceId?: string;
+};
+
+/**
+ * Get contentful management client api
+ */
+const getClient = (options: ContentfulOptions) => {
+  const { accessToken, managementToken, host } = options || {};
+
+  if (client) {
+    return client;
+  }
+
+  const params: ClientOptions = {
+    accessToken: managementToken || accessToken,
+  };
+
+  if (host) {
+    params.host = host;
+  }
+
+  if (params.accessToken) {
+    client = contentful.createClient(params);
+    return client;
+  }
+
+  throw new Error(
+    'You need to login first. Run npx contentful login or pass the contentful management token',
+  );
+};
+
+/**
+ * Get Contentful spaces
+ */
+export const getSpaces = async (options: ContentfulOptions): Promise<Space[]> => {
+  const client = getClient(options);
+
+  const { items: spaces } = await client.getSpaces();
+
+  return spaces;
+};
+
+/**
+ * Get Contentful space
+ */
+export const getSpace = async (options: SetRequired<ContentfulOptions, 'spaceId'>) => {
+  const { spaceId } = options || {};
+  const client = getClient(options);
+  return client.getSpace(spaceId);
+};
+
+/**
+ * Get Contentful environments
+ */
+export const getEnvironments = async (options: SetRequired<ContentfulOptions, 'spaceId'>) => {
+  const space = await getSpace(options);
+  const { items: environments } = await space.getEnvironments();
+
+  return environments;
+};
+
+/**
+ * Get Contentful environment
+ */
+export const getEnvironment = async (
+  options: SetRequired<ContentfulOptions, 'spaceId' | 'environmentId'>,
+) => {
+  const { environmentId, spaceId } = options || {};
+  const space = await getSpace(options);
+
+  const { items: environments } = await space.getEnvironments();
+
+  const environmentIds = (environments || []).map((env) => env.sys.id);
+
+  if (environmentId && environmentIds.includes(environmentId)) {
+    return space.getEnvironment(environmentId);
+  }
+
+  if (environmentId && !environmentIds.includes(environmentId)) {
+    throw new Error(`Environment "${environmentId}" is not available in space ${spaceId}"`);
+  }
+
+  throw new Error('Missing required parameter: environmentId');
+};
+
+/**
+ * Fetch api key from contentful
+ */
+export const getApiKey = async (options: SetRequired<ContentfulOptions, 'spaceId'>) => {
+  const space = await getSpace(options);
+
+  const { items: apiKeys = [] } = (await space.getApiKeys()) || {};
+  const [apiKey] = apiKeys;
+  const { accessToken } = apiKey || {};
+
+  return accessToken;
+};
+
+/**
+ * Fetch preview api key from contentful
+ */
+export const getPreviewApiKey = async (options: SetRequired<ContentfulOptions, 'spaceId'>) => {
+  const space = await getSpace(options);
+
+  const { items: previewApiKeys = [] } = await space.getPreviewApiKeys();
+  const [previewApiKey] = previewApiKeys;
+  const { accessToken: previewAccessToken } = previewApiKey as ApiKey;
+
+  return previewAccessToken;
+};

package/src/index.ts

@@ -0,0 +1,138 @@
+import { homedir } from 'node-homedir';
+import type { LoadConfigOptions } from '@jungvonmatt/config-loader';
+import {
+  type ContentfulOptions,
+  getApiKey,
+  getEnvironments,
+  getPreviewApiKey,
+  getSpaces,
+} from './contentful.js';
+
+export const getPromts = (data: Partial<ContentfulOptions>) => {
+  return [
+    {
+      type: 'input',
+      name: 'managementToken',
+      message: 'Management Token',
+      initial: data.managementToken,
+    },
+    {
+      type: 'select',
+      name: 'spaceId',
+      message: 'Space ID',
+      choices: async (answers: Partial<ContentfulOptions>) => {
+        const token = data.managementToken || answers.managementToken;
+        if (token) {
+          const spaces = await getSpaces({ accessToken: token });
+          return spaces.map((space) => ({
+            name: `${space.name} (${space.sys.id})`,
+            value: space.sys.id,
+          }));
+        }
+
+        return [];
+      },
+      initial: data?.spaceId ?? data?.activeSpaceId,
+    },
+    {
+      type: 'select',
+      name: 'environmentId',
+      message: 'Environment ID',
+      choices: async (answers: Partial<ContentfulOptions>) => {
+        const token = data.managementToken || answers.managementToken;
+        const spaceId = answers.spaceId || data.spaceId;
+        if (token && spaceId) {
+          const environments = await getEnvironments({ accessToken: token, spaceId });
+          return environments.map((environment) => environment.sys.id);
+        }
+
+        return [];
+      },
+      initial: data?.environmentId || data?.activeEnvironmentId,
+    },
+    {
+      type: 'input',
+      name: 'accessToken',
+      message: 'Content Delivery API - access token',
+      skip(answers: Partial<ContentfulOptions>) {
+        return !answers.spaceId && !data.spaceId;
+      },
+      initial: async (answers: Partial<ContentfulOptions>) => {
+        if (data.accessToken) {
+          return typeof data.accessToken === 'function' ? data.accessToken() : data.accessToken;
+        }
+
+        const token = data.managementToken || answers.managementToken;
+        const spaceId = answers.spaceId || data.spaceId;
+        if (token && spaceId) {
+          return getApiKey({ accessToken: token, spaceId });
+        }
+      },
+    },
+    {
+      type: 'input',
+      name: 'previewAccessToken',
+      message: 'Content Preview API - access token',
+      skip(answers: Partial<ContentfulOptions>) {
+        return !answers.spaceId && !data.spaceId;
+      },
+      initial: async (answers: Partial<ContentfulOptions>) => {
+        if (data.previewAccessToken) {
+          return typeof data.previewAccessToken === 'function'
+            ? data.previewAccessToken()
+            : data.previewAccessToken;
+        }
+
+        const token = data.managementToken || answers.managementToken;
+        const spaceId = answers.spaceId || data.spaceId;
+        if (token && spaceId) {
+          return getPreviewApiKey({ accessToken: token, spaceId });
+        }
+      },
+    },
+  ];
+};
+
+type LoadContentfulConfigOptions<T extends Record<string, any> = ContentfulOptions> = Omit<
+  LoadConfigOptions<T>,
+  'name'
+>;
+
+export const loadContentfulConfig = async <T extends Record<string, any> = ContentfulOptions>(
+  name: string,
+  options: LoadContentfulConfigOptions<T> = {},
+) => {
+  const { loadConfig } = await import('@jungvonmatt/config-loader');
+
+  // Load global contentful config stored in a .contentfulrc.json file in the home directory
+  // https://www.contentful.com/developers/docs/tutorials/cli/config-management/
+  const contentfulCliOptions = await loadConfig<T>({
+    name: 'contentful',
+    cwd: homedir(),
+  });
+
+  const result = await loadConfig<T>({
+    ...options,
+    name,
+    defaultConfig: {
+      environmentId: 'master',
+      host: 'api.contentful.com',
+      ...contentfulCliOptions.config,
+      ...options?.defaultConfig,
+    },
+    envMap: {
+      CONTENTFUL_SPACE_ID: 'spaceId',
+      CONTENTFUL_ENVIRONMENT_ID: 'environmentId',
+      CONTENTFUL_MANAGEMENT_TOKEN: 'managementToken',
+      CONTENTFUL_PREVIEW_TOKEN: 'previewAccessToken',
+      CONTENTFUL_PREVIEW_ACCESS_TOKEN: 'previewAccessToken',
+      CONTENTFUL_DELIVERY_TOKEN: 'accessToken',
+      CONTENTFUL_DELIVERY_ACCESS_TOKEN: 'accessToken',
+      CONTENTFUL_HOST: 'host',
+      ...options?.envMap,
+    } as const,
+    prompts: getPromts,
+  });
+
+  return { ...result, config: result.config as T };
+};