Merge branch 'dev'

laravel-enso · Nov 20, 2019 · 05f58eb · 05f58eb
2 parents f2c7e91 + aa2a04d
commit 05f58eb
Show file tree

Hide file tree

Showing 6 changed files with 93 additions and 19 deletions.
diff --git a/.env.example b/.env.example
@@ -51,3 +51,5 @@ CACHE_LIFETIME=60
 RAVEN_DSN=
 
 ENSO_API_TOKEN=adrian
+
+TINY_MCE_API_KEY=
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,66 @@
 # Laravel Enso's Changelog
 
+## 3.7.2
+
+The main purpose of this release was to switch from using [tiptap](https://github.com/scrumpy/tiptap) to using [tinyMCE](https://www.tiny.cloud/) for our what-you-see-is-what-you-get editor VueJS component. 
+
+Through its dependency chain, after running `yarn upgrade` tiptap was breaking the build.
+
+As a bonus, tinyMCE should be better supported and the VueJS wrapper components for it are slimmer and cleaner.
+
+### front-end
+
+#### wysiwyg
+- drops tiptap in favour of tinyMCE (see more below)
+
+#### forms
+- updates the wyisiwyg field for the new tinyMCE powered wyisiwyg component
+
+#### calendar
+- reverts the resizing strategy
+
+### back-end
+
+#### companies
+- within the static `owner` method the company model is resolved from the service container so that if you're extending & binding the package model to a local model, you will obtain the local instance
+
+#### forms
+- adds support for tinyMCE customization within the form configuration and the json templates
+- fixes form params bug on create which caused the given parameter values to be ignored
+
+#### localisation
+- updated a couple of translation keys and values
+
+### Upgrade steps
+
+This is a non breaking upgrade:
+
+* run `composer update`
+* run `yarn upgrade && yarn` in `/client`
+* update the version to 3.7.2 in `config/enso/config.php`
+* update the `config/enso/forms.php` configuration file and add the new key:
+```
+|--------------------------------------------------------------------------
+| TinyMCE Api Key
+|--------------------------------------------------------------------------
+| If you're using the wysiwyg field you need to get a free api key from 
+| https://www.tiny.cloud/get-tiny/ first.
+| 
+*/
+
+'tinyMCEApiKey' => env('TINY_MCE_API_KEY', null),
+```
+
+If you were not using the `wysiwyg` component, there is nothing else for you to do.
+
+If you are using it, you will need to create an account on https://www.tiny.cloud/ ,
+get an API key and add your application domains.
+
+After obtaining your API key, add it to your `.env` file:
+```
+TINY_MCE_API_KEY=my-api-key
+```
+
 ## 3.7.1
 
 ### front-end

diff --git a/client/yarn.lock b/client/yarn.lock
@@ -9408,9 +9408,9 @@ ripemd160@^2.0.0, ripemd160@^2.0.1:
     inherits "^2.0.1"
 
 rope-sequence@^1.3.0:
-  version "1.3.0"
-  resolved "https://registry.yarnpkg.com/rope-sequence/-/rope-sequence-1.3.0.tgz#7b8bc1db96f8696f93db05282f799c6078eacce2"
-  integrity sha512-F+Y/pOSJn+illq+2dl2SqJYLil4lll3300mG3ISK3XNa1Ir0Kq+W1Ti0sWOeQGThm15bZsGDXyWF3osZJJ7x8Q==
+  version "1.3.2"
+  resolved "https://registry.yarnpkg.com/rope-sequence/-/rope-sequence-1.3.2.tgz#a19e02d72991ca71feb6b5f8a91154e48e3c098b"
+  integrity sha512-ku6MFrwEVSVmXLvy3dYph3LAMNS0890K7fabn+0YIRQ2T96T9F4gkFf0vf0WW0JUraNWwGRtInEpH7yO4tbQZg==
 
 run-async@^2.2.0:
   version "2.3.0"
@@ -11092,9 +11092,9 @@ vuex@^3.0.0, vuex@^3.1.0:
   integrity sha512-ha3jNLJqNhhrAemDXcmMJMKf1Zu4sybMPr9KxJIuOpVcsDQlTBYLLladav2U+g1AvdYDG5Gs0xBTb0M5pXXYFQ==
 
 w3c-keyname@^2.2.0:
-  version "2.2.0"
-  resolved "https://registry.yarnpkg.com/w3c-keyname/-/w3c-keyname-2.2.0.tgz#03ac9edf49c14e1325c3abec9251b7ab2f392b1f"
-  integrity sha512-/IjQxaDTusd1dmPycoHN8ZowRbW9KjJ9PC/oHft3dzFMyTBeXjcWQBLMI4N4t/bFvUdCHxQ3nByvKzzxqqvEIw==
+  version "2.2.1"
+  resolved "https://registry.yarnpkg.com/w3c-keyname/-/w3c-keyname-2.2.1.tgz#c4fe1a4b9e303c95e833b3d854b7d81070400db9"
+  integrity sha512-j5k4xGK6k8TCna/08778KUEL98WvTogiG/TN/YStl8GNeXg5tI3Dvq3+JjwJhP4l7ogs6KWo1VYEdc1Qaioy3Q==
 
 watchpack@^1.6.0:
   version "1.6.0"

diff --git a/composer.lock b/composer.lock
diff --git a/config/enso/config.php b/config/enso/config.php
@@ -1,7 +1,7 @@
 <?php
 
 return [
-    'version' => '3.7.1',
+    'version' => '3.7.2',
     'ownerCompanyId' => env('OWNER_COMPANY_ID', 1),
     'showQuote' => env('SHOW_QUOTE', true),
     'defaultRole' => 'admin',

diff --git a/config/enso/forms.php b/config/enso/forms.php
@@ -84,7 +84,7 @@
     |--------------------------------------------------------------------------
     | Select Placeholder
     |--------------------------------------------------------------------------
-    | Default select placeholder. Can be overriden by setting a custom one
+    | Default select placeholder. Can be overridden by setting a custom one
     | in the json template.
     |
     */
@@ -119,8 +119,19 @@
     |--------------------------------------------------------------------------
     | By default all form fields will have a conventional label. If this flag
     | is set to false the label will be used as placeholder. Can be
-    | overriden in each form template
+    | overridden in each form template
     */
 
     'labels' => 'true',
+
+    /*
+    |--------------------------------------------------------------------------
+    | TinyMCE Api Key
+    |--------------------------------------------------------------------------
+    | If you're using the wysiwyg field you need to get a free api key from
+    | https://www.tiny.cloud/get-tiny/ first.
+    |
+    */
+
+    'tinyMCEApiKey' => env('TINY_MCE_API_KEY', null),
 ];