@content-island/gatsby-source-plugin 0.2.1 → 0.3.0

package/README.md

@@ -0,0 +1,84 @@
+# @content-island/gatsby-source-plugin
+
+## Installation
+
+```bash
+npm install @content-island/gatsby-source-plugin
+```
+
+## Usage
+
+```javascript
+// In your gatsby-config.js
+
+module.exports = {
+  plugins: [
+    {
+      resolve: '@content-island/gatsby-source-plugin',
+      options: {
+        accessToken: process.env.CONTENT_ISLAND_ACCESS_TOKEN,
+      },
+    },
+  ],
+};
+```
+
+### Using with different environments
+
+```javascript
+// In your gatsby-config.js
+
+module.exports = {
+  plugins: [
+    {
+      resolve: '@content-island/gatsby-source-plugin',
+      options: {
+        accessToken: process.env.CONTENT_ISLAND_ACCESS_TOKEN,
+        domain: process.env.CONTENT_ISLAND_DOMAIN, // Default: api.contentisland.net
+        apiVersion: process.env.CONTENT_ISLAND_API_VERSION, // Default: 1.0
+      },
+    },
+  ],
+};
+```
+
+## Using with images transformer plugin
+
+```javascript
+// In your gatsby-config.js
+
+module.exports = {
+  plugins: [
+    {
+      resolve: '@content-island/gatsby-source-plugin',
+      options: {
+        accessToken: process.env.CONTENT_ISLAND_ACCESS_TOKEN,
+      },
+    },
+    'gatsby-plugin-sharp',
+    'gatsby-transformer-sharp',
+    'gatsby-plugin-image',
+  ],
+};
+```
+
+## Using with markdown transformer plugin
+
+```javascript
+// In your gatsby-config.js
+
+module.exports = {
+  plugins: [
+    {
+      resolve: '@content-island/gatsby-source-plugin',
+      options: {
+        accessToken: process.env.CONTENT_ISLAND_ACCESS_TOKEN,
+      },
+    },
+
+    'gatsby-transformer-remark',
+  ],
+};
+```
+
+> NOTE: You can combine images and markdown transformer together.

package/dist/helpers/content-island.helpers.js

@@ -16,7 +16,7 @@ let CONTENT_TYPES = [];
 // Fetch all content types from Content Island
 const getContentTypes = (client) => __awaiter(void 0, void 0, void 0, function* () {
     if (CONTENT_TYPES.length === 0) {
-        const project = yield client.get(api_client_1.API_URLS.project);
+        const project = yield client.getProject();
         CONTENT_TYPES = project.entities;
     }
     return CONTENT_TYPES;
@@ -24,10 +24,10 @@ const getContentTypes = (client) => __awaiter(void 0, void 0, void 0, function*
 let CONTENT_LIST = [];
 const getContentList = (pluginOptions) => __awaiter(void 0, void 0, void 0, function* () {
     if (CONTENT_LIST.length === 0) {
-        const client = (0, api_client_1.createContentIslandClient)(pluginOptions);
+        const client = (0, api_client_1.createClient)(pluginOptions);
         const contentTypes = yield getContentTypes(client);
         for (const contentType of contentTypes) {
-            const contents = yield client.get(api_client_1.API_URLS.contentList({ filterList: [`contentType=${contentType.name}`] }));
+            const contents = yield client.getContentList({ contentType: contentType.name });
             CONTENT_LIST = [...CONTENT_LIST, ...(0, mappers_1.mapContentListFromApiToVm)(contents)];
         }
     }

package/dist/mappers.js

@@ -1,11 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.mapContentListFromApiToVm = void 0;
+const apiModel = require("@content-island/api-client");
 const constants_1 = require("./constants");
-const mapFieldFromApiToVm = (fields) => {
-    return fields.reduce((result, field) => (Object.assign(Object.assign({}, result), { [field.name]: field.value })), {});
-};
-const mapFieldListFromApiToVm = (fields) => Array.isArray(fields) ? mapFieldFromApiToVm(fields) : {};
 const mapToMediaField = (field, gatsbyNodeType) => {
     return field.isArray
         ? {
@@ -29,7 +26,7 @@ const mapContentFromApiToVm = (content, isLocalized, language) => {
     const fields = isLocalized ? content.fields.filter(field => field.language === language) : content.fields;
     return {
         gatsbyNodeType,
-        gatsbyNode: Object.assign({ _id: content.id, _isContentIslandNode: true, _mediaFields: mapToPreprocessedFieldList(fields, gatsbyNodeType, 'media'), _markdownFields: mapToPreprocessedFieldList(fields, gatsbyNodeType, 'long-text'), _lastUpdate: content.lastUpdate, _isLocalized: isLocalized, _language: language }, mapFieldListFromApiToVm(fields)),
+        gatsbyNode: Object.assign({ _id: content.id, _isContentIslandNode: true, _mediaFields: mapToPreprocessedFieldList(fields, gatsbyNodeType, 'media'), _markdownFields: mapToPreprocessedFieldList(fields, gatsbyNodeType, 'long-text'), _lastUpdate: content.lastUpdate, _isLocalized: isLocalized, _language: language }, apiModel.mapFieldListToModel(fields)),
     };
 };
 const mapLocalizedContentFromApiToVm = (content) => {

package/dist/models/plugin-options.model.d.ts

@@ -1,8 +1,6 @@
 import type { PluginOptions as GatsbyDefaultPluginOptions, IPluginRefOptions } from 'gatsby';
-interface PluginOptionsKeys {
-    accessToken: string;
-    baseUrl?: string;
-}
+import { Options } from '@content-island/api-client';
+type PluginOptionsKeys = Options;
 /**
  * Gatsby expects the plugin options to be of type "PluginOptions" for gatsby-node APIs (e.g. sourceNodes)
  */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@content-island/gatsby-source-plugin",
-  "version": "0.2.1",
+  "version": "0.3.0",
   "description": "Content Island - B2B Gatsby Source Plugin",
   "private": false,
   "author": "Lemoncode",
@@ -27,7 +27,7 @@
     "build": "tsc"
   },
   "dependencies": {
-    "@content-island/api-client": "^0.2.1"
+    "@content-island/api-client": "^0.3.0"
   },
   "devDependencies": {
     "gatsby": "^5.12.4",