@soleil-se/config-svelte 1.29.2 → 1.30.0

package/CHANGELOG.md

@@ -8,6 +8,20 @@ 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.30.0] - 2026-02-18
+
+- Add a `res.render({})` call för `createAppProps` and `createAppContext` to correctly render the
+  size selector in widget configs.
+
+- Deprecate `createAppProps(props)`, use `createAppProps(props, res)` instead.
+  ```diff lang="js"
+  const props = { message: 'Hello from the server!' };
+  - res.send(createAppProps(props));
+  + createAppProps(props, res);
+  ```
+
+- Value in `Checkbox` component now has a default value of `undefined`.
+
 ## [1.29.2] - 2025-08-26
 
 - Update type definitions for Option.

package/components/Checkbox/Component.svelte

@@ -18,7 +18,7 @@
   /** @type {boolean} */
   export let show = true;
   /** @type {boolean} */
-  export let value;
+  export let value = undefined;
   value = name ? (values[name] ?? value ?? checked) : value;
 
   let className = '';

package/createTypeDefinitions.js

@@ -18,6 +18,21 @@ globSync('./components/*/types.d.ts').forEach((file) => {
   fs.copyFileSync(file, destinationPath);
 });
 
+function copyManualTypeFiles(dir) {
+  globSync(`./${dir}/**/*.js`)
+    .map((file) => file.replace(/\.js$/, '.d.ts'))
+    .filter((file) => fs.existsSync(file))
+    .forEach((file) => {
+      const relativePath = path.relative(dir, file);
+      const destinationPath = path.join('types', dir, relativePath);
+      const destinationDir = path.dirname(destinationPath);
+      console.log(`Found manual type definition file: ${file}, copying to ${destinationDir}`);
+      fs.mkdirSync(destinationDir, { recursive: true });
+      fs.copyFileSync(file, destinationPath);
+    });
+}
+
 ['actions', 'createConfigApp', 'server', 'utils'].forEach((dir) => {
   execSync(`npx -p typescript tsc ./${dir}/index.js --declaration --allowJs --emitDeclarationOnly --outDir types/${dir} --skipLibCheck`, { stdio: 'inherit' });
+  copyManualTypeFiles(dir);
 });

package/package.json

@@ -9,7 +9,7 @@
     "svelte"
   ],
   "homepage": "https://docs.soleil.se/packages/config-svelte",
-  "version": "1.29.2",
+  "version": "1.30.0",
   "main": "./index.js",
   "module": "./index.js",
   "svelte": "./index.js",
@@ -59,5 +59,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "a3096c1721a100b738bcfef9789da6ec2d51bd2c"
+  "gitHead": "405f8c7d65e72fb61520680b4a9815fb559f4b04"
 }

package/server/index.d.ts

@@ -0,0 +1,40 @@
+import type { Response } from  '@sitevision/api/common/router';
+
+/**
+ * Creates a HTML string for passing props to the app.
+ * @deprecated Use `createAppProps(props, res)` instead.
+ * @example
+ * // Before:
+ * res.send(createAppProps(props));
+ *
+ * // After:
+ * createAppProps(props, res);
+ * @param {Record<string, any>} props Props to be passed to the app.
+ * @returns {string} HTML string to make props available to the app.
+ */
+export function createAppProps(props: Record<string, any>): string;
+
+/**
+ * Creates app props that can be passed to the app.
+ * @param {Record<string, any>} props Props to be passed to the app.
+ * @param {Response} res Response from \@sitevision/common/router.
+ */
+export function createAppProps(props: Record<string, any>, res: Response): void;
+/**
+ * Creates a HTML string for passing data to the app.
+ * @param {Record<string, any>} data Data to be passed to the app.
+ * @deprecated Use `createAppProps` instead.
+ * @example
+ * // Before:
+ * res.send(createAppData(data));
+ *
+ * // After:
+ * createAppProps(data, res);
+ * @returns {string} HTML string to make data available to the config app.
+ */
+export function createAppData(data: Record<string, any>): string;
+/**
+ * Creates app context global variable.
+ * @param {Response} res Response from \@sitevision/common/router.
+ */
+export function createAppContext(res: Response): void;

package/server/index.js

@@ -1,14 +1,32 @@
-/* eslint-disable max-len */
-import { getCurrentPage } from '@sitevision/api/server/PortletContextUtil';
+import PortletContextUtil from '@sitevision/api/server/PortletContextUtil';
 import appInfo from '@sitevision/api/server/appInfo';
-import { getSite } from '@sitevision/api/server/ResourceLocatorUtil';
+import ResourceLocatorUtil from '@sitevision/api/server/ResourceLocatorUtil';
 
 /**
- * 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.
+ * @typedef {import('@sitevision/api/common/router').Response} Response
  */
-export function createAppProps(props) {
+
+let hasRendered = false;
+
+/**
+ * @param {Record<string, any>} props
+ * @param {Response} [res]
+ * @returns {string | void}
+ */
+export function createAppProps(props, res) {
+  if (res) {
+    if (appInfo.appType.toLowerCase() === 'widget' && !hasRendered) {
+      hasRendered = true;
+      res.render({}); // Need to call render to make sure the widget size selector is rendered.
+    }
+
+    res.send(`
+<script>
+  window.CONFIG_APP_PROPS = ${JSON.stringify(props)};
+</script>
+  `);
+    return '';
+  }
   return `
 <script>
   window.CONFIG_APP_PROPS = ${JSON.stringify(props)};
@@ -18,29 +36,39 @@ export function createAppProps(props) {
 }
 
 /**
- * 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.
+ * @param {Record<string, any>} data
+ * @returns {string}
  */
 export function createAppData(data) {
   return createAppProps(data);
 }
 
 /**
- * Creates app context global variable.
- * @param {import('@sitevision/api/common/router/index').Response} res Response from \@sitevision/common/router.
+ * @param {Response} res
+ * @returns {void}
  */
 export function createAppContext(res) {
-  const siteNode = getSite();
+  const siteNode = ResourceLocatorUtil.getSite();
 
   const context = {
     ...appInfo,
-    pageId: getCurrentPage().getIdentifier(),
+    pageId: PortletContextUtil.getCurrentPage().getIdentifier(),
     siteId: siteNode.getIdentifier(),
     siteName: siteNode.toString(),
+    jcrUuid: appInfo['jcr:uuid'],
+    jcrPrimaryType: appInfo['jcr:primaryType'],
+    addon: {
+      ...appInfo.addon,
+      jcrUuid: appInfo.addon['jcr:uuid'],
+      jcrPrimaryType: appInfo.addon['jcr:primaryType'],
+    },
   };
 
+  if (context.appType.toLowerCase() === 'widget' && !hasRendered) {
+    hasRendered = true;
+    res.render({}); // Need to call render to make sure the widget size selector is rendered.
+  }
+
   res.send(`
 <script>
   window.CONFIG_APP_CONTEXT = ${JSON.stringify(context)};

package/types/components/Checkbox/Component.svelte.d.ts

@@ -34,7 +34,7 @@ export type CheckboxProps = {
   /**
    * @default undefined
    */
-  value: boolean;
+  value?: boolean;
 
   /**
    * @default ''

package/types/server/index.d.ts

@@ -1,18 +1,40 @@
+import type { Response } from  '@sitevision/api/common/router';
+
 /**
- * Creates a HTML string for passing data to the app.
- * @param {object} props Props to be passed to the app.
+ * Creates a HTML string for passing props to the app.
+ * @deprecated Use `createAppProps(props, res)` instead.
+ * @example
+ * // Before:
+ * res.send(createAppProps(props));
+ *
+ * // After:
+ * createAppProps(props, res);
+ * @param {Record<string, any>} props Props to be passed to the app.
  * @returns {string} HTML string to make props available to the app.
  */
-export function createAppProps(props: object): string;
+export function createAppProps(props: Record<string, any>): string;
+
+/**
+ * Creates app props that can be passed to the app.
+ * @param {Record<string, any>} props Props to be passed to the app.
+ * @param {Response} res Response from \@sitevision/common/router.
+ */
+export function createAppProps(props: Record<string, any>, res: Response): void;
 /**
  * Creates a HTML string for passing data to the app.
- * @param {object} data Data to be passed to the app.
+ * @param {Record<string, any>} data Data to be passed to the app.
  * @deprecated Use `createAppProps` instead.
+ * @example
+ * // Before:
+ * res.send(createAppData(data));
+ *
+ * // After:
+ * createAppProps(data, res);
  * @returns {string} HTML string to make data available to the config app.
  */
-export function createAppData(data: object): string;
+export function createAppData(data: Record<string, any>): string;
 /**
  * Creates app context global variable.
- * @param {import('@sitevision/api/common/router/index').Response} res Response from \@sitevision/common/router.
+ * @param {Response} res Response from \@sitevision/common/router.
  */
-export function createAppContext(res: import("@sitevision/api/common/router/index").Response): void;
+export function createAppContext(res: Response): void;

package/types/utils/getAppContext.d.ts

@@ -1,7 +1,59 @@
+export type AppContextAddon = {
+    jcrUuid: string;
+    jcrPrimaryType: string;
+    displayName: string;
+};
+
+export type AppContextCertificate = {
+    signed: boolean;
+};
+
+export type AppContextRuntime = {
+    sitevisionVersion: string;
+    scriptEngineLanguageVersion: string;
+    scriptEngineName: string;
+    serverName: string;
+    scriptEngineVersion: string;
+};
+
+export type AppContext = {
+    appId: string;
+    contextNodeId: string;
+    servletPath: string;
+    portletId: string;
+    dashboardId: string;
+    appVersion: string;
+    maxUploadSizeInMB: number;
+    appHelpURL: string;
+    addon: AppContextAddon;
+    appName: string;
+    appDescription: string;
+    certificate: AppContextCertificate;
+    active: boolean;
+    runtime: AppContextRuntime;
+    jcrUuid: string;
+    requirePrivileged: boolean;
+    appIdentifier: string;
+    appAuthor: string;
+    appType: string;
+    appImportDate: number;
+    jcrPrimaryType: string;
+    csrfProtection: boolean;
+    pageId: string;
+    siteId: string;
+    siteName: string;
+};
+
+export type AppContextKey = "appId" | "contextNodeId" | "servletPath" | "portletId" | "dashboardId" | "appVersion" | "maxUploadSizeInMB" | "appHelpURL" | "addon" | "appName" | "appDescription" | "certificate" | "active" | "runtime" | "jcrUuid" | "requirePrivileged" | "appIdentifier" | "appAuthor" | "appType" | "appImportDate" | "jcrPrimaryType" | "csrfProtection" | "pageId" | "siteId" | "siteName";
+
 /**
- * Get app context value or object that is created for app when rendering.
- * @export
- * @param {string} [key] - Key for value.
- * @return {*|object} - Value or object.
+ * Get app context object that is created for app when rendering.
+ * @returns App context object.
  */
-export default function getAppContext(key?: string): any | object;
+export default function getAppContext(): AppContext;
+/**
+ * Get app context object that is created for app when rendering.
+ * @param key - Key of the app context property to retrieve.
+ * @returns App context object.
+ */
+export default function getAppContext<K extends keyof AppContext>(key: K): AppContext[K];

package/utils/getAppContext.d.ts

@@ -0,0 +1,59 @@
+export type AppContextAddon = {
+    jcrUuid: string;
+    jcrPrimaryType: string;
+    displayName: string;
+};
+
+export type AppContextCertificate = {
+    signed: boolean;
+};
+
+export type AppContextRuntime = {
+    sitevisionVersion: string;
+    scriptEngineLanguageVersion: string;
+    scriptEngineName: string;
+    serverName: string;
+    scriptEngineVersion: string;
+};
+
+export type AppContext = {
+    appId: string;
+    contextNodeId: string;
+    servletPath: string;
+    portletId: string;
+    dashboardId: string;
+    appVersion: string;
+    maxUploadSizeInMB: number;
+    appHelpURL: string;
+    addon: AppContextAddon;
+    appName: string;
+    appDescription: string;
+    certificate: AppContextCertificate;
+    active: boolean;
+    runtime: AppContextRuntime;
+    jcrUuid: string;
+    requirePrivileged: boolean;
+    appIdentifier: string;
+    appAuthor: string;
+    appType: string;
+    appImportDate: number;
+    jcrPrimaryType: string;
+    csrfProtection: boolean;
+    pageId: string;
+    siteId: string;
+    siteName: string;
+};
+
+export type AppContextKey = "appId" | "contextNodeId" | "servletPath" | "portletId" | "dashboardId" | "appVersion" | "maxUploadSizeInMB" | "appHelpURL" | "addon" | "appName" | "appDescription" | "certificate" | "active" | "runtime" | "jcrUuid" | "requirePrivileged" | "appIdentifier" | "appAuthor" | "appType" | "appImportDate" | "jcrPrimaryType" | "csrfProtection" | "pageId" | "siteId" | "siteName";
+
+/**
+ * Get app context object that is created for app when rendering.
+ * @returns App context object.
+ */
+export default function getAppContext(): AppContext;
+/**
+ * Get app context object that is created for app when rendering.
+ * @param key - Key of the app context property to retrieve.
+ * @returns App context object.
+ */
+export default function getAppContext<K extends keyof AppContext>(key: K): AppContext[K];

package/utils/getAppContext.js

@@ -1,9 +1,3 @@
-/**
- * Get app context value or object that is created for app when rendering.
- * @export
- * @param {string} [key] - Key for value.
- * @return {*|object} - Value or object.
- */
 export default function getAppContext(key) {
   if (!window.CONFIG_APP_CONTEXT) {
     console.warn(`App context is not created, add the following in config/index.js: