@soleil-se/config-svelte 1.7.0 → 1.8.0

package/CHANGELOG.md

@@ -5,6 +5,17 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.8.0] - 2021-11-xx
+
+### Changed
+
+- Improvements for passing server data to the app.
+- Remove `hydrate` option since we're never using SSR in config apps.
+
+### Fixed
+
+- Properly target div with id `app_root` when rendering app.
+
 ## [1.7.0] - 2021-09-24
 
 ### Added

package/createConfigApp/index.js

@@ -1,15 +1,14 @@
 import 'focus-visible';
 
-export default function createConfigApp(App, { hydrate = true } = {}) {
+export default function createConfigApp(App) {
   window.setValues = (values) => {
     window.CONFIG_VALUES = values;
     const app = new App({
-      target: document.querySelector('#app_root, body'),
+      target: document.querySelector('#app_root') || document.querySelector('body'),
       props: {
-        ...window.CONFIG_APP_DATA,
+        ...window.CONFIG_APP_PROPS,
         values,
       },
-      hydrate,
     });
 
     return app;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@soleil-se/config-svelte",
-  "version": "1.7.0",
+  "version": "1.8.0",
   "main": "./index.js",
   "module": "./index.js",
   "svelte": "./index.js",

package/server/index.js

@@ -1,3 +1,23 @@
-/* Might add more exports in the future */
-/* eslint-disable import/prefer-default-export */
-export { default as createAppData } from './createAppData';
+/**
+ * Creates a HTML string for passing data to the app.
+ * @param {object} props Props to be passed to the app.
+ * @returns {string} HTML string to make props available to the app.
+ */
+export function createAppProps(props) {
+  return `
+<script> 
+  window.CONFIG_APP_PROPS = ${JSON.stringify(props)};
+</script>
+<div id="app_root"></div>
+  `;
+}
+
+/**
+ * Creates a HTML string for passing data to the app.
+ * @param {object} data Data to be passed to the app.
+ * @deprecated Use `createAppProps` instead.
+ * @returns {string} HTML string to make data available to the config app.
+ */
+export function createAppData(data) {
+  return createAppProps(data);
+}

package/utils/getAppProps.js

@@ -0,0 +1,9 @@
+/**
+ * Get app props value or object that is passed to app when rendering.
+ * @export
+ * @param {string} [key] - Key for value.
+ * @return {*|object} - Value or object.
+ */
+export default function getAppProps(key) {
+  return key ? window.CONFIG_APP_PROPS[key] : window.CONFIG_APP_PROPS;
+}

package/utils/index.js

@@ -5,3 +5,4 @@ export { default as addPrefix } from './addPrefix';
 export { default as pluckPrefix } from './pluckPrefix';
 export { default as triggerInput } from './triggerInput';
 export { default as createI18n } from './createI18n';
+export { default as getAppProps } from './getAppProps';

package/server/createAppData/index.js

@@ -1,8 +0,0 @@
-export default function createAppData(data) {
-  return `
-<script> 
-  window.CONFIG_APP_DATA = ${JSON.stringify(data)};
-</script>
-<div id="app_root"></div>
-  `;
-}