@soleil-se/app-util 5.9.0 → 5.10.0

package/CHANGELOG.md

@@ -7,6 +7,10 @@ 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.9.1] - 2025-03-27
+
+- Update type definitions.
+
 ## [5.9.0] - 2025-03-17
 
 - Add `idPrefix` when rendering Svelte on the server to avoid conflicts with other apps.

package/client/index.d.ts

@@ -1,2 +1,3 @@
-export { default as fetchJson } from "./fetch-json";
-export { getUrlParam, getUrlParams, setUrlParams, updateUrlParams, clearUrlParams } from "./url-params";
+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/3/index.d.ts

@@ -1 +1 @@
-export { render } from "../4";
+export { render } from "../4";

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

@@ -1,21 +1,21 @@
-/** @typedef {import('svelte').SvelteComponent} Component */
-/**
- * Renders a client side Svelte application.
- * @param {Component} 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.
- * @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.
- * @return {Component} Initialized Svelte component.
- */
-export function render(App: Component, { target, props, intro, hydrate, }?: {
-    target?: string;
-    props?: string;
-    hydrate?: boolean;
-    intro?: boolean;
-}): Component;
-export type Component = import('svelte').SvelteComponent;
+/** @typedef {import('svelte').SvelteComponent} Component */
+/**
+ * Renders a client side Svelte application.
+ * @param {Component} 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 {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.
+ * @return {Component} Initialized Svelte component.
+ */
+export function render(App: Component, { target, props, intro, hydrate, }?: {
+    target?: HTMLElement;
+    props?: object;
+    hydrate?: boolean;
+    intro?: boolean;
+}): Component;
+export type Component = import('svelte').SvelteComponent;

package/client/svelte/4/index.js

@@ -4,8 +4,8 @@ import { setAppProps } from '../../../common';
  * Renders a client side Svelte application.
  * @param {Component} 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.
+ * @param {HTMLElement} [settings.target] Target where app should be mounted.
+ * @param {object} [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,20 @@
-/** @typedef {import('svelte').Component} Component */
-/**
- * Renders a client side Svelte application.
- * @param {Component} 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.
- * @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, }?: {
-    target?: string;
-    props?: string;
-    hydrate?: boolean;
-    intro?: boolean;
-}): void;
-export type Component = import('svelte').Component;
+/** @typedef {import('svelte').Component} Component */
+/**
+ * Renders a client side Svelte application.
+ * @param {Component} 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 {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, }?: {
+    target?: HTMLElement;
+    props?: object;
+    hydrate?: boolean;
+    intro?: boolean;
+}): void;
+export type Component = import('svelte').Component;

package/client/svelte/5/index.js

@@ -9,8 +9,8 @@ import { setAppProps } from '../../../common';
  * Renders a client side Svelte application.
  * @param {Component} 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.
+ * @param {HTMLElement} [settings.target] Target where app should be mounted.
+ * @param {object} [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

@@ -1,21 +1,21 @@
-/**
- * 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 {object} [settings={}] Settings object.
- * @param {string} [settings.target] Target where app should be mounted.
- * @param {string} [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.
- * @return {import('svelte').SvelteComponent} Initialized Svelte component.
- */
-export function render(App: import('svelte').SvelteComponent, settings?: {
-    target?: string;
-    props?: string;
-    hydrate?: boolean;
-    intro?: boolean;
-}): import('svelte').SvelteComponent;
+/**
+ * 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 {object} [settings={}] Settings object.
+ * @param {string} [settings.target] Target where app should be mounted.
+ * @param {string} [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.
+ * @return {import('svelte').SvelteComponent} Initialized Svelte component.
+ */
+export function render(App: import('svelte').SvelteComponent, settings?: {
+    target?: string;
+    props?: string;
+    hydrate?: boolean;
+    intro?: boolean;
+}): import('svelte').SvelteComponent;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@soleil-se/app-util",
-  "version": "5.9.0",
+  "version": "5.10.0",
   "description": "Utility functions for WebApps, RESTApps and Widgets in Sitevision.",
   "main": "./common/index.js",
   "author": "Soleil AB",
@@ -24,5 +24,6 @@
   },
   "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": "b4e8a1acb4927528583fc91406a32175b669afd8"
 }

package/server/index.d.ts

@@ -1,6 +1,6 @@
-/**
- * Require a module natively.
- * @param {string} module
- * @returns any
- */
-export function nativeRequire(module: string): any;
+/**
+ * Require a module natively.
+ * @param {string} module
+ * @returns any
+ */
+export function nativeRequire(module: string): any;

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

@@ -1 +1 @@
-export { render } from "../4";
+export { render } from "../4";

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.
- * @return {string} HTML for the server rendered app.
- */
-export function render(App: Component, props: object): string;
-export type Component = import('svelte').SvelteComponent;
+/** @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.
+ * @return {string} HTML for the server rendered app.
+ */
+export function render(App: Component, props: object): string;
+export type Component = import('svelte').SvelteComponent;

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

@@ -1,9 +1,9 @@
-/** @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.
- * @return {string} HTML for the server rendered app.
- */
-export function render(App: Component, props: object): string;
-export type Component = import('svelte').Component;
+/** @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.
+ * @return {string} HTML for the server rendered app.
+ */
+export function render(App: Component, props: object): string;
+export type Component = import('svelte').Component;

package/server/svelte/index.d.ts

@@ -1,9 +1,9 @@
-/**
- * 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 {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;
+/**
+ * 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 {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;