ENH Simplify APIs

_config.php

@@ -5,5 +5,4 @@
 
 // Avoid creating global variables
 call_user_func(function () {
-
 });

client/src/boot/index.js

@@ -1,14 +1,9 @@
 /* global document */
 /* eslint-disable */
-import Config from 'lib/Config';
 import registerReducers from './registerReducers';
 import registerComponents from './registerComponents';
-import registerQueries from './registerQueries';
 
 document.addEventListener('DOMContentLoaded', () => {
   registerComponents();
-
-  registerQueries();
-
   registerReducers();
 });

client/src/components/LinkField/LinkField.js

@@ -1,13 +1,13 @@
-import React, { Fragment, useState } from 'react';
+import React, { Fragment, useState, useEffect } from 'react';
 import { compose } from 'redux';
-import { inject, injectGraphql, loadComponent } from 'lib/Injector';
+import { inject, loadComponent } from 'lib/Injector';
 import fieldHolder from 'components/FieldHolder/FieldHolder';
 
-const LinkField = ({ id, loading, Loading, data, LinkPicker, onChange, types, linkDescription, ...props }) => {
-  if (loading) {
-    return <Loading />;
-  }
-
+const LinkField = ({ id, onChange, dataStr, Loading, LinkPicker }) => {
+  // params id, onChange, dataStr come from entwine/JsonField.js
+  // params LinkPicker, Loading come from inject(['LinkPicker', 'Loading'])
+  const [types, setTypes] = useState([]);
+  const [description, setDescription] = useState(null);
   const [editing, setEditing] = useState(false);
   const [newTypeKey, setNewTypeKey] = useState('');
 
@@ -19,6 +19,32 @@ const LinkField = ({ id, loading, Loading, data, LinkPicker, onChange, types, li
     onChange(event, { id, value: {} });
   };
 
+  // Utility function to make a GET request to the server
+  const fetchData = (path, onFetched) => {
+    (async () => fetch(path))()
+      .then(response => response.json())
+      .then(onFetched);
+  };
+
+  // Request types data from server on initial load of component
+  useEffect(() => {
+    fetchData('/admin/linkfield/types', (responseJson) => setTypes(responseJson));
+  }, []);
+
+  // Request description of the link from the server when `editing` variable changes to false
+  // and on initial load of component
+  useEffect(() => {
+    if (!editing) {
+      const path = `/admin/linkfield/description?data=${encodeURI(dataStr)}`;
+      fetchData(path, (responseJson) => setDescription(responseJson.description));
+    }
+  }, [editing]);
+
+  if (types.length === 0 || description === null) {
+    return <Loading />;
+  }
+
+  const data = JSON.parse(dataStr);
   const { typeKey } = data;
   const type = types[typeKey];
   const modalType = newTypeKey ? types[newTypeKey] : type;
@@ -31,7 +57,7 @@ const LinkField = ({ id, loading, Loading, data, LinkPicker, onChange, types, li
 
   const linkProps = {
     title,
-    link: type ? { type, title, description: linkDescription } : undefined,
+    link: type ? { type, title, description } : undefined,
     onEdit: () => { setEditing(true); },
     onClear,
     onSelect: (key) => {
@@ -83,8 +109,6 @@ const stringifyData = (Component) => (({ data, value, ...props }) => {
 
 export default compose(
   inject(['LinkPicker', 'Loading']),
-  injectGraphql('readLinkTypes'),
   stringifyData,
-  injectGraphql('readLinkDescription'),
   fieldHolder
 )(LinkField);

src/Controllers/LinkFieldController.php

@@ -0,0 +1,77 @@
+<?php
+
+namespace SilverStripe\LinkField\Controllers;
+
+use SilverStripe\Control\Controller;
+use SilverStripe\Control\HTTPRequest;
+use SilverStripe\Control\HTTPResponse;
+use SilverStripe\Control\HTTPResponse_Exception;
+use SilverStripe\LinkField\Type\Registry;
+
+/**
+ * Endpoint for /admin/linkfield/<action>
+ *
+ * Routing to this controller is done via Extensions/LeftAndMain.php in the linkfield() method
+ */
+class LinkFieldController extends Controller
+{
+    private static array $allowed_actions = [
+        'description',
+        'types',
+    ];
+
+    /**
+     * Used for requests to /admin/linkfield/description?data={json}
+     */
+    public function description(HTTPRequest $request): HTTPResponse
+    {
+        $jsonStr = $request->getVar('data');
+        // data will be an empty array if there is no existing link which is a valid use case
+        $data = json_decode($jsonStr, true);
+        $description = '';
+        if (json_last_error() !== JSON_ERROR_NONE) {
+            throw new HTTPResponse_Exception('data is not a valid JSON string');
+        }
+        if (array_key_exists('typeKey', $data)) {
+            $typeKey = $data['typeKey'];
+            /** @var Type $type */
+            $type = Registry::singleton()->byKey($typeKey);
+            if (!$type) {
+                throw new HTTPResponse_Exception('typeKey is not allowed');
+            }
+            $description = $type->generateLinkDescription($data);
+        }
+        return $this->jsonResponse([
+            'description' => $description
+        ]);
+    }
+
+    /**
+     * Used for requests to /admin/linkfield/types
+     */
+    public function types(): HTTPResponse
+    {
+        $data = [];
+        /** @var Type $type */
+        foreach (Registry::singleton()->list() as $key => $type) {
+            $data[$key] = [
+                'key' => $key,
+                'handlerName' => $type->LinkTypeHandlerName(),
+                'title' => $type->LinkTypeTile()
+            ];
+        }
+        return $this->jsonResponse($data);
+    }
+
+    /**
+     * Create a JSON response to send back to the browser
+     */
+    private function jsonResponse(array $data)
+    {
+        $response = $this->getOwner()->getResponse();
+        $jsonStr = json_encode($data, JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE);
+        $response->setBody($jsonStr);
+        $response->addHeader('Content-type', 'application/json');
+        return $response;
+    }
+}

src/Extensions/LeftAndMain.php

@@ -4,12 +4,17 @@
 
 use SilverStripe\Core\Extension;
 use SilverStripe\LinkField\Type\Registry;
+use SilverStripe\LinkField\Controllers\LinkFieldController;
 
 /**
  * Register a new Form Schema in LeftAndMain.
  */
 class LeftAndMain extends Extension
 {
+    private static $allowed_actions = [
+        'linkfield',
+    ];
+
     public function init()
     {
         // Get the Link Registry to load all the JS requirements for managing Links.
@@ -22,4 +27,12 @@ public function updateClientConfig(&$clientConfig)
             'schemaUrl' => $this->getOwner()->Link('methodSchema/Modals/DynamicLink'),
         ];
     }
+
+    /**
+     * Route requests to /admin/linkfield to LinkFieldController
+     */
+    public function linkfield(): LinkFieldController
+    {
+        return LinkFieldController::create();
+    }
 }