@soleil-se/app-util 5.9.1 → 5.10.1

package/CHANGELOG.md

@@ -7,6 +7,14 @@ 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).
 
+## [5.10.1] - 2025-06-26
+
+- Adjust types for rendering functions.
+
+## [5.10.0] - 2025-05-30
+
+- Add new utility function `preventDefault` to prevent default behavior of events in a more readable way.
+
 ## [5.9.1] - 2025-03-27
 
 - Update type definitions.

package/client/index.d.ts

@@ -1,2 +1,3 @@
 export { default as fetchJson } from "./fetch-json";
+export { default as preventDefault } from "./prevent-default";
 export { getUrlParam, getUrlParams, setUrlParams, updateUrlParams, clearUrlParams } from "./url-params";

package/client/index.js

@@ -7,3 +7,4 @@ export {
 } from './url-params';
 
 export { default as fetchJson } from './fetch-json';
+export { default as preventDefault } from './prevent-default';

package/client/prevent-default/index.d.ts

@@ -0,0 +1 @@
+export default function preventDefault(fn: any): (...args: any[]) => any;

package/client/prevent-default/index.js

@@ -0,0 +1,8 @@
+export default function preventDefault(fn) {
+  return function cb(...args) {
+    const event = /** @type {Event} */ (args[0]);
+    event.preventDefault();
+    // @ts-ignore
+    return fn?.apply(this, args);
+  };
+}

package/client/svelte/4/index.d.ts

@@ -1,10 +1,10 @@
 /** @typedef {import('svelte').SvelteComponent} Component */
 /**
  * Renders a client side Svelte application.
- * @param {Component} App Svelte app root component.
+ * @param {Component<any>} App Svelte app root component.
  * @param {object} [settings={}] Settings object.
  * @param {HTMLElement} [settings.target] Target where app should be mounted.
- * @param {object} [settings.props] Root component props.
+ * @param {Record<string, any>} [settings.props] Root component props.
  * @param {boolean} [settings.hydrate=target.hasChildNodes()] Instructs Svelte to upgrade existing
  * DOM (usually from server-side rendering) rather than creating new elements. By default the app
  * will hydrate when the target has any child nodes.
@@ -12,9 +12,9 @@
  * rather than waiting for subsequent state changes.
  * @return {Component} Initialized Svelte component.
  */
-export function render(App: Component, { target, props, intro, hydrate, }?: {
+export function render(App: any, { target, props, intro, hydrate, }?: {
     target?: HTMLElement;
-    props?: object;
+    props?: Record<string, any>;
     hydrate?: boolean;
     intro?: boolean;
 }): Component;

package/client/svelte/4/index.js

@@ -2,10 +2,10 @@ import { setAppProps } from '../../../common';
 /** @typedef {import('svelte').SvelteComponent} Component */
 /**
  * Renders a client side Svelte application.
- * @param {Component} App Svelte app root component.
+ * @param {Component<any>} App Svelte app root component.
  * @param {object} [settings={}] Settings object.
  * @param {HTMLElement} [settings.target] Target where app should be mounted.
- * @param {object} [settings.props] Root component props.
+ * @param {Record<string, any>} [settings.props] Root component props.
  * @param {boolean} [settings.hydrate=target.hasChildNodes()] Instructs Svelte to upgrade existing
  * DOM (usually from server-side rendering) rather than creating new elements. By default the app
  * will hydrate when the target has any child nodes.

package/client/svelte/5/index.d.ts

@@ -1,20 +1,18 @@
-/** @typedef {import('svelte').Component} Component */
 /**
  * Renders a client side Svelte application.
- * @param {Component} App Svelte app root component.
+ * @param {import('svelte').Component<any>} App Svelte app root component.
  * @param {object} [settings={}] Settings object.
  * @param {HTMLElement} [settings.target] Target where app should be mounted.
- * @param {object} [settings.props] Root component props.
+ * @param {Record<string, any>} [settings.props] Root component props.
  * @param {boolean} [settings.hydrate=target.hasChildNodes()] Instructs Svelte to upgrade existing
  * DOM (usually from server-side rendering) rather than creating new elements. By default the app
  * will hydrate when the target has any child nodes.
  * @param {boolean} [settings.intro=false] If true, will play transitions on initial render,
  * rather than waiting for subsequent state changes.
  */
-export function render(App: Component, { target, props, hydrate, intro, }?: {
+export function render(App: import('svelte').Component<any>, { target, props, hydrate, intro, }?: {
     target?: HTMLElement;
-    props?: object;
+    props?: Record<string, any>;
     hydrate?: boolean;
     intro?: boolean;
 }): void;
-export type Component = import('svelte').Component;

package/client/svelte/5/index.js

@@ -3,14 +3,12 @@ import { mount as svelteMount, hydrate as svelteHydrate } from 'svelte';
 
 import { setAppProps } from '../../../common';
 
-/** @typedef {import('svelte').Component} Component */
-
 /**
  * Renders a client side Svelte application.
- * @param {Component} App Svelte app root component.
+ * @param {import('svelte').Component<any>} App Svelte app root component.
  * @param {object} [settings={}] Settings object.
  * @param {HTMLElement} [settings.target] Target where app should be mounted.
- * @param {object} [settings.props] Root component props.
+ * @param {Record<string, any>} [settings.props] Root component props.
  * @param {boolean} [settings.hydrate=target.hasChildNodes()] Instructs Svelte to upgrade existing
  * DOM (usually from server-side rendering) rather than creating new elements. By default the app
  * will hydrate when the target has any child nodes.

package/client/svelte/index.d.ts

@@ -2,7 +2,7 @@
  * Renders a client side Svelte 3 or 4 application.
  * @deprecated Use rendering function for specific Svelte version instead.
  * `import { render } from '@soleil-api/webapp-util/client/svelte/{3|4|5}';`
- * @param {import('svelte').SvelteComponent} App Svelte app root component.
+ * @param {import('svelte').SvelteComponent<any>} App Svelte app root component.
  * @param {object} [settings={}] Settings object.
  * @param {string} [settings.target] Target where app should be mounted.
  * @param {string} [settings.props] Root component props.
@@ -13,7 +13,7 @@
  * rather than waiting for subsequent state changes.
  * @return {import('svelte').SvelteComponent} Initialized Svelte component.
  */
-export function render(App: import('svelte').SvelteComponent, settings?: {
+export function render(App: import('svelte').SvelteComponent<any>, settings?: {
     target?: string;
     props?: string;
     hydrate?: boolean;

package/client/svelte/index.js

@@ -4,7 +4,7 @@ import { render as render4 } from './4';
  * Renders a client side Svelte 3 or 4 application.
  * @deprecated Use rendering function for specific Svelte version instead.
  * `import { render } from '@soleil-api/webapp-util/client/svelte/{3|4|5}';`
- * @param {import('svelte').SvelteComponent} App Svelte app root component.
+ * @param {import('svelte').SvelteComponent<any>} App Svelte app root component.
  * @param {object} [settings={}] Settings object.
  * @param {string} [settings.target] Target where app should be mounted.
  * @param {string} [settings.props] Root component props.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@soleil-se/app-util",
-  "version": "5.9.1",
+  "version": "5.10.1",
   "description": "Utility functions for WebApps, RESTApps and Widgets in Sitevision.",
   "main": "./common/index.js",
   "author": "Soleil AB",
@@ -25,5 +25,5 @@
   "scripts": {
     "create-type-definitions": "node ../../utils/createTypeDefinitions.js ./common/index.js;./ ./client/index.js ./client/svelte/index.js ./client/svelte/3/index.js ./client/svelte/4/index.js ./client/svelte/5/index.js ./server/index.js ./server/svelte/index.js ./server/svelte/3/index.js ./server/svelte/4/index.js ./server/svelte/5/index.js"
   },
-  "gitHead": "6a93a0f9bd858a6e594cb5e106f524588f14e70b"
+  "gitHead": "b5a77ddf78f3a1d2204c44bdc4faef035e7961e9"
 }

package/server/svelte/4/index.d.ts

@@ -1,9 +1,9 @@
 /** @typedef {import('svelte').SvelteComponent} Component */
 /**
  * Returns HTML for a server rendered Svelte app.
- * @param {Component} App Svelte component that is root of app.
- * @param {object} props Props passed to root component.
+ * @param {Component<any>} App Svelte component that is root of app.
+ * @param {Record<string, any>} props Props passed to root component.
  * @return {string} HTML for the server rendered app.
  */
-export function render(App: Component, props: object): string;
+export function render(App: any, props: Record<string, any>): string;
 export type Component = import('svelte').SvelteComponent;

package/server/svelte/4/index.js

@@ -2,8 +2,8 @@ import { setAppProps } from '../../../common';
 /** @typedef {import('svelte').SvelteComponent} Component */
 /**
  * Returns HTML for a server rendered Svelte app.
- * @param {Component} App Svelte component that is root of app.
- * @param {object} props Props passed to root component.
+ * @param {Component<any>} App Svelte component that is root of app.
+ * @param {Record<string, any>} props Props passed to root component.
  * @return {string} HTML for the server rendered app.
  */
 export function render(App, props) {

package/server/svelte/5/index.d.ts

@@ -1,9 +1,7 @@
-/** @typedef {import('svelte').Component} Component */
 /**
  * Returns HTML for a server rendered Svelte app.
- * @param {Component} App Svelte component that is root of app.
- * @param {object} props Props passed to root component.
+ * @param {import('svelte').Component<any>} App Svelte component that is root of app.
+ * @param {Record<string, any>} props Props passed to root component.
  * @return {string} HTML for the server rendered app.
  */
-export function render(App: Component, props: object): string;
-export type Component = import('svelte').Component;
+export function render(App: import('svelte').Component<any>, props: Record<string, any>): string;

package/server/svelte/5/index.js

@@ -1,11 +1,10 @@
 import { render as svelteRender } from 'svelte/server';
 import { appId, setAppProps } from '../../../common';
 
-/** @typedef {import('svelte').Component} Component */
 /**
  * Returns HTML for a server rendered Svelte app.
- * @param {Component} App Svelte component that is root of app.
- * @param {object} props Props passed to root component.
+ * @param {import('svelte').Component<any>} App Svelte component that is root of app.
+ * @param {Record<string, any>} props Props passed to root component.
  * @return {string} HTML for the server rendered app.
  */
 export function render(App, props) {

package/server/svelte/index.d.ts

@@ -2,8 +2,8 @@
  * Returns HTML for a server rendered Svelte 3 or 4 app.
  * @deprecated Use rendering function for specific Svelte version instead.
  * `import { render } from '@soleil-api/webapp-util/server/svelte/{3|4|5}';`
- * @param {import('svelte').SvelteComponent} App Svelte component that is root of app.
+ * @param {import('svelte').SvelteComponent<any>} App Svelte component that is root of app.
  * @param {object} props Props passed to root component.
  * @return {string} HTML for the server rendered app.
  */
-export function render(App: import('svelte').SvelteComponent, props: object): string;
+export function render(App: import('svelte').SvelteComponent<any>, props: object): string;

package/server/svelte/index.js

@@ -4,7 +4,7 @@ import { render as render4 } from './4';
  * Returns HTML for a server rendered Svelte 3 or 4 app.
  * @deprecated Use rendering function for specific Svelte version instead.
  * `import { render } from '@soleil-api/webapp-util/server/svelte/{3|4|5}';`
- * @param {import('svelte').SvelteComponent} App Svelte component that is root of app.
+ * @param {import('svelte').SvelteComponent<any>} App Svelte component that is root of app.
  * @param {object} props Props passed to root component.
  * @return {string} HTML for the server rendered app.
  */