svelte-common 6.9.9 → 6.10.0

package/package.json

@@ -1,12 +1,15 @@
 {
   "name": "svelte-common",
-  "version": "6.9.9",
+  "version": "6.10.0",
   "publishConfig": {
     "access": "public",
     "provenance": true
   },
+  "types": "./types/module.d.mjs",
   "exports": {
     ".": {
+      "types": "./types/module.d.mjs",
+      "default": "./src/module.mjs",
       "svelte": "./src/index.svelte"
     },
     "./css": "./src/common.css"
@@ -29,7 +32,9 @@
   ],
   "license": "BSD-2-Clause",
   "scripts": {
-    "prepare": "vite build",
+    "prepare": "npm run prepare:vite && npm run prepare:typescript",
+    "prepare:vite": "vite build",
+    "prepare:typescript": "tsc --allowJs --declaration --emitDeclarationOnly --declarationDir types -t esnext -m esnext --module nodenext --moduleResolution nodenext --rootDir src ./src**/*.mjs",
     "start": "vite",
     "test": "npm run test:ava && npm run test:cafe",
     "test:cafe": "testcafe $BROWSER:headless tests/cafe/*-cafe.mjs -s build/test --page-request-timeout 5000 --app-init-delay 8000 --app vite",
@@ -51,22 +56,23 @@
     "@semantic-release/exec": "^6.0.3",
     "@semantic-release/release-notes-generator": "^12.1.0",
     "@sveltejs/vite-plugin-svelte": "^3.0.2",
-    "ava": "^6.1.1",
+    "ava": "^6.1.2",
     "c8": "^9.1.0",
     "documentation": "^14.0.3",
     "mf-styling": "^3.1.5",
-    "npm-pkgbuild": "^13.0.20",
+    "npm-pkgbuild": "^13.3.1",
     "semantic-release": "^23.0.2",
     "stylelint": "^16.2.1",
     "stylelint-config-standard": "^36.0.0",
     "svelte": "^4.2.12",
     "testcafe": "^3.5.0",
-    "vite": "^5.1.4",
-    "vite-plugin-compression2": "^0.12.0"
+    "typescript": "^5.3.3",
+    "vite": "^5.1.5",
+    "vite-plugin-compression2": "^1.0.0"
   },
   "optionalDependencies": {
     "mf-hosting-cloudflare": "^1.0.6",
-    "mf-hosting-frontend": "^2.2.5"
+    "mf-hosting-frontend": "^2.2.6"
   },
   "repository": {
     "type": "git",
@@ -141,7 +147,8 @@
       "arlac77/template-cloudflare",
       "arlac77/template-css",
       "arlac77/template-npm-pkgbuild",
-      "arlac77/template-svelte-component"
+      "arlac77/template-svelte-component",
+      "arlac77/template-typescript"
     ]
   }
 }

package/src/module.mjs

@@ -0,0 +1,5 @@
+export * from "./util.mjs";
+export * from "./sorting.mjs";
+export * from "./filter.mjs";
+export * from "./pagination.mjs";
+export * from "./service-worker.mjs";

package/types/filter.d.mts

@@ -0,0 +1,6 @@
+/**
+ * Generate filter function.
+ * @param {Object} [filterBy]
+ * @returns {Function}
+ */
+export function filter(filterBy?: any): Function;

package/types/module.d.mts

@@ -0,0 +1,5 @@
+export * from "./util.mjs";
+export * from "./sorting.mjs";
+export * from "./filter.mjs";
+export * from "./pagination.mjs";
+export * from "./service-worker.mjs";

package/types/pagination.d.mts

@@ -0,0 +1,65 @@
+export function pageNavigation(elem: any, pg: any): void;
+/**
+ * Generade actual sequence of page numbers to navigate to.
+ * @param {number} numberOfPages
+ * @param {number} currentPage
+ * @param {number} numberOfItems
+ * @return {Iterator<number>}
+ */
+export function navigationItems(numberOfPages: number, currentPage: number, numberOfItems?: number): Iterator<number>;
+/**
+ * Pagination support store.
+ * Pages go from 1 ... numberOfPages
+ * @param {Map|Set|Array|Store} data
+ * @param {Object} options
+ * @param {number} [options.itemsPerPage]
+ * @param {Function} [options.sorter]
+ * @param {Function} [options.filter]
+ */
+export class Pagination {
+    constructor(data: any, options: any);
+    set data(data: any);
+    fireSubscriptions(): void;
+    set filter(filter: any);
+    get filter(): any;
+    set sorter(sorter: any);
+    get sorter(): any;
+    /**
+     * Enshure that current page lies inside 1 ... numberOfPages
+     */
+    recalibrateCurrentPage(): void;
+    /**
+     * Set current page
+     * @param {number} n
+     */
+    set page(n: number);
+    /**
+     * @return {number} current page
+     */
+    get page(): number;
+    set itemsPerPage(n: number);
+    get itemsPerPage(): number;
+    subscribe(s: any): () => boolean;
+    /**
+     * Total number of items (filtered).
+     * @return {number}
+     */
+    get numberOfItems(): number;
+    /**
+     * @return {number}
+     */
+    get numberOfPages(): number;
+    /**
+     * Deliver items per page.
+     * @see {itemsPerPage}
+     * @return {number}
+     */
+    get length(): number;
+    /**
+     * @see @link https://getbootstrap.com/docs/4.0/components/pagination
+     * @see @link https://a11y-style-guide.com/style-guide/section-navigation.html#kssref-navigation-pagination
+     */
+    get pageNavigationElement(): HTMLElement;
+    [Symbol.iterator](): Generator<any, void, any>;
+    #private;
+}

package/types/service-worker.d.mts

@@ -0,0 +1,7 @@
+/**
+ * Create a store holding a service worker
+ * @param {string} script The URL of the service worker script
+ * @param {Object} options An object containing registration options
+ * @return {Object} store holding the service worker
+ */
+export function initializeServiceWorker(script: string, options: any): any;

package/types/sorting.d.mts

@@ -0,0 +1,32 @@
+/**
+ * Deliver next value in the order by cycle.
+ * SORT_NONE -> SORT_ASCENDING -> SORT_DESCENDING -> SORT_NONE ...
+ * @param {string} orderBy
+ * @returns {string} new order either SORT_NONE, SORT_ASCENDING or SORT_DESCENDING
+ */
+export function toggleOrderBy(orderBy: string): string;
+/**
+ * Add sortable toggle button to a th node.
+ * Synchronizes store value with the nodes "aria-sort" attribute.
+ * @param {Element} th the header node
+ * @param {WritableStore} store keep in sync with sorting properties
+ */
+export function sortable(th: Element, store: WritableStore): {
+    destroy(): void;
+};
+/**
+ * Generate a sort function for a given sort-by set.
+ * @param {Object|undefined} [sortBy]
+ * @param {Object} [getters]
+ * @return {Function|undefined} sorter
+ */
+export function sorter(sortBy?: any | undefined, getters?: any): Function | undefined;
+export const SORT_NONE: "none";
+export const SORT_ASCENDING: "ascending";
+export const SORT_DESCENDING: "descending";
+export const SORT_OTHER: "other";
+export namespace orderByCycle {
+    export { SORT_ASCENDING as none };
+    export { SORT_DESCENDING as ascending };
+    export { SORT_ASCENDING as descending };
+}

package/types/util.d.mts

@@ -0,0 +1,15 @@
+export function formatBytes(bytes: any, decimals?: number): string;
+export function formatDurationISO(seconds: any): string;
+export function formatDuration(seconds: any): string;
+export function formatSecondsSinceEpoch(sse: any): string;
+/**
+ * Create a derived store where all the object keys are prefixed.
+ * ```
+ * { a: 1, b: 2 } -> { foo_a: 1 foo_b: 2 } // prefix: foo_
+ * ```
+ * @param {WriteableStore} store we derive from
+ * @param {string} prefix for each key
+ * @returns {WriteableStore}
+ */
+export function keyPrefixStore(store: WriteableStore, prefix: string): WriteableStore;
+export const dateFormatter: Intl.DateTimeFormat;