Merge branch 'release/0.3.0'

Author: Decipher

.circleci/config.yml

@@ -11,6 +11,10 @@ jobs:
     steps:
       - checkout
 
+      - run:
+          name: Install Codecov
+          command: npm install codecov
+
       - restore_cache:
           keys:
           - v1-dependencies-{{ checksum "package.json" }}
@@ -22,6 +26,10 @@ jobs:
           name: Run tests
           command: npm test
 
+      - run:
+          name: Upload coverage report
+          command: npx codecov
+
       - save_cache:
           paths:
             - node_modules

.gitignore

@@ -1 +1,4 @@
-node_modules
+coverage
+node_modules
+.nuxt
+.vscode

README.md

@@ -1,8 +1,11 @@
 # Drupal JSON:API Entities
 
 [![CircleCI](https://circleci.com/gh/Realityloop/drupal_jsonapi_entities.svg?style=svg)](https://circleci.com/gh/Realityloop/drupal_jsonapi_entities)
+[![Known Vulnerabilities](https://snyk.io//test/github/Realityloop/drupal_jsonapi_entities/badge.svg?targetFile=package.json)](https://snyk.io//test/github/Realityloop/drupal_jsonapi_entities?targetFile=package.json)
+[![codecov](https://codecov.io/gh/Realityloop/drupal_jsonapi_entities/branch/develop/graph/badge.svg)](https://codecov.io/gh/Realityloop/drupal_jsonapi_entities)
 
-Pull Drupal Entity form and field schemas into your Node.js app with ease.
+Build a Drupal Entity form/view field schema from your Drupal JSON:API entitiy
+with ease.
 
 ## Installation
 
@@ -35,7 +38,7 @@ The constructor takes two arguments:
 ### getFormSchema()
 
 ```js
-const schema = await drupalEntities.getFormSchema(entityType, bundle, mode)
+const formSchema = await drupalEntities.getFormSchema(entityType, bundle, mode)
 ```
 
 The method takes three arguments:
@@ -50,6 +53,7 @@ Returns a JSON object:
   - **cardinality**: Allowed number of values.
   - **description**: Help text.
   - **id**: Machine name.
+  - **property**: True if field is a property on the Drupal entity.
   - **label**: Label.
   - **required**: Required field.
   - **settings**: Merged object of field settings.
@@ -58,10 +62,11 @@ Returns a JSON object:
   - **group**: (optional) Group.
 - **groups**: An array of Drupal Field Group module group objects, sorted by weight.
   - **children**: Array of fields in group.
+  - **format_settings**: Settings for the display of the group.
+  - **format_type**: Type of group for display.
   - **id**: Machine name.
   - **label**: Label.
-  - **weight**: Form display weight.
-- **keys**: An array of field keys.
+  - **weight**: Weight.
 
 #### Drupal requirements
 
@@ -76,10 +81,58 @@ Permissions:
 - `administer display modes`
 - `administer ENTITY_TYPE fields`
 
+### getViewSchema()
+
+```js
+const viewSchema = await drupalEntities.getViewSchema(entityType, bundle, mode)
+```
+
+The method takes three arguments:
+
+- `entityType`: The Drupal entity type ID.
+- `bundle`: The Drupal bundle ID for the entity type.
+- `mode`: The view display mode. Default: `default`.
+
+Returns a JSON object:
+
+- **fields**: An array of field objects, sorted by weight.
+  - **description**: Help text.
+  - **id**: Machine name.
+  - **property**: True if field is a property on the Drupal entity.
+  - **label**: Label.
+  - **labelPosition**: Label position.
+  - **required**: Required field.
+  - **settings**: Merged object of field settings.
+  - **thirdPartySettings**: Settings of any third party modules.
+  - **type**: Field type machine name.
+  - **weight**: Form display field weight.
+  - **group**: (optional) Group.
+- **groups**: An array of Drupal Field Group module group objects, sorted by weight.
+  - **children**: Array of fields in group.
+  - **format_settings**: Settings for the display of the group.
+  - **format_type**: Type of group for display.
+  - **id**: Machine name.
+  - **label**: Label.
+  - **weight**: Weight.
+
+#### Drupal requirements
+
+JSON:API resources:
+
+- `entity_form_display--entity_form_display`
+- `entity_view_display--entity_view_display`
+- `field_config--field_config`
+- `field_storage_config--field_storage_config`
+
+Permissions:
+
+- `administer display modes`
+- `administer ENTITY_TYPE fields`
+
 ## Nuxt.js module
 
 Drupal JSON:API Entities provides a Nuxt.js module for easily caching the
-schema.
+schema(s).
 
 ### Getting started with Nuxt.js
 
@@ -106,17 +159,34 @@ module.exports = {
 }
 ```
 
-Add a `drupalJSONAPIEntities` section to your `nuxt.config.js` file.
+Add a `drupalJSONAPIEntities` section to your `nuxt.config.js` file in the
+following format for all required Entity types, Bundles, Schema types and
+Modes:
 
 ```js
 module.exports = {
   drupalJSONAPIEntities: {
-    'entityType': { 'bundle': ['mode'] }
+    'entityType': { 'bundle': { 'type': [ 'mode' ] } }
+  }
+}
+```
+
+Example:
+```js
+module.exports = {
+  drupalJSONAPIEntities: {
+    'node': {
+      'recipe': {
+        form: [ 'default' ],
+        view: [ 'default' ],
+      }
+    }
   }
 }
 ```
 
-The module provides a plugin, which returns the Drupal JSON:API Entities schema.
+The module provides a plugin, which returns the Drupal JSON:API Entities
+schema(s).
 
 ```js
 this.$drupalJSONAPIEntities()

nuxt/__fixtures__/nuxt.config.js

@@ -0,0 +1,20 @@
+const path = require('path')
+
+module.exports = {
+  srcDir: __dirname,
+  rootDir: path.resolve(__dirname),
+  buildDir: path.resolve(__dirname, '.nuxt'),
+  dev: false,
+
+  modules: [
+    {
+      handler: require('../index').default,
+      options: {
+        baseUrl: 'https://example.com'
+      }
+    }
+  ],
+  drupalJSONAPIEntities: {
+    node: [ 'recipe' ]
+  }
+}