tool-shack 0.0.14 → 0.0.17

package/dist/browser/index.d.ts

@@ -0,0 +1,7 @@
+export * from './isPushNotificationSupported.js';
+export * from './isScrollBehaviorSupported.js';
+export * from './isShareSupported.js';
+export * from './isTabFocused.js';
+export * from './isTouchSupported.js';
+export * from './preferColorScheme.js';
+export * from './tabFocusListener.js';

package/dist/browser/index.js

@@ -1,4 +1,5 @@
 export * from './isPushNotificationSupported.js';
+export * from './isScrollBehaviorSupported.js';
 export * from './isShareSupported.js';
 export * from './isTabFocused.js';
 export * from './isTouchSupported.js';

package/dist/browser/interfaces/isTouchSupported.d.ts

@@ -0,0 +1,3 @@
+export interface IExtendedWindow extends Window {
+    DocumentTouch: any;
+}

package/dist/browser/isPushNotificationSupported.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Check if user's browser supports push notifications
+ *
+ * @returns Boolean indicating if user's browser supports push notifications
+ */
+export declare const isPushNotificationSupported: () => boolean;

package/dist/browser/isScrollBehaviorSupported.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Check if user's browser supports setting scroll behavior
+ *
+ * @returns Boolean indicating if user's browser supports setting scroll behavior
+ */
+export declare const isScrollBehaviorSupported: () => boolean;

package/dist/browser/isScrollBehaviorSupported.js

@@ -0,0 +1,7 @@
+/**
+ * Check if user's browser supports setting scroll behavior
+ *
+ * @returns Boolean indicating if user's browser supports setting scroll behavior
+ */
+export const isScrollBehaviorSupported = () => !!('scrollBehavior' in document.documentElement.style);
+//# sourceMappingURL=isScrollBehaviorSupported.js.map

package/dist/browser/isShareSupported.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Check if user's browser supports navigator share
+ *
+ * @returns Boolean indicating if user's browser supports navigator share
+ */
+export declare const isShareSupported: () => boolean;

package/dist/browser/isTabFocused.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Check if current browser tab is in focus
+ *
+ * @returns Boolean indicating if current browser tab is in focus
+ */
+export declare const isTabFocused: () => boolean;

package/dist/browser/isTouchSupported.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Check if user's browser supports touch events
+ *
+ * @returns Boolean indicating if user's browser supports touch events
+ */
+export declare const isTouchSupported: () => boolean;

package/dist/browser/preferColorScheme.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Check if user prefers light color scheme
+ *
+ * @returns Boolean indicating if user prefers light color scheme
+ */
+export declare const preferLightColorScheme: () => boolean;
+/**
+ * Check if user prefers dark color scheme
+ *
+ * @returns Boolean indicating if user prefers dark color scheme
+ */
+export declare const preferDarkColorScheme: () => boolean;
+/**
+ * Check what color scheme (light or dark) is prefered by user
+ *
+ * @returns String indicating prefered light color scheme ('light') or dark color scheme ('dark')
+ */
+export declare const preferColorScheme: () => 'light' | 'dark';

package/dist/browser/tabFocusListener.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Set callbacks for if current browser tab is in focus
+ *
+ * @param focusCallback Function to be called when current browser tab goes into focus
+ * @param blurCallback Function to be called when current browser tab goes out of focus
+ * @returns void
+ */
+export declare const tabFocusListener: (focusCallback?: () => void, blurCallback?: () => void) => void;

package/dist/dateTime/dateAsIso.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Return date in ISO format with timezone
+ *
+ * @param date Date to be converted
+ * @returns ISO format with timezone
+ */
+export declare const dateAsIso: (date: Date) => string;

package/dist/dateTime/index.d.ts

@@ -0,0 +1,3 @@
+export * from './interfaces/index.js';
+export * from './dateAsIso.js';
+export * from './parseDuration.js';

package/dist/dateTime/interfaces/index.d.ts

@@ -0,0 +1 @@
+export * from './parseDuration.js';

package/dist/dateTime/interfaces/parseDuration.d.ts

@@ -0,0 +1,7 @@
+export interface IDuration {
+    days: number;
+    hours: number;
+    minutes: number;
+    seconds: number;
+    milliseconds: number;
+}

package/dist/dateTime/parseDuration.d.ts

@@ -0,0 +1,8 @@
+import { IDuration } from './interfaces/parseDuration.js';
+/**
+ * Parse duration in milliseconds into days, hours, minutes, seconds, milliseconds
+ *
+ * @param durationInMs Integer of duration in milliseconds
+ * @returns Object containing days, hours, minutes, seconds and milliseconds of provided duration
+ */
+export declare const parseDuration: (durationInMs: number) => IDuration;

package/dist/dom/addAsyncEventListener.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Listen to events fired on elements that may currently not exist in the DOM
+ *
+ * @param elementSelector Selector for element(s) to match event target
+ * @param listeners List of event types and related callback(s)
+ * @param acceptBubbling Boolean switch to allow bubbling or accept only direct element match
+ * @returns void
+ */
+export declare const addAsyncEventListener: (elementSelector: string, listeners: Record<string, EventListener | EventListener[]>, acceptBubbling?: boolean) => void;

package/dist/dom/addClickOutsideListener.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Add event listener to listen to clicks outside of given element
+ *
+ * @param element Node element outside which to listen to clicks
+ * @param fn Function to trigger when clicked outside
+ * @returns void
+ */
+export declare const addClickOutsideListener: (element: HTMLElement, fn: () => any) => void;

package/dist/dom/addEventListener.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Add event listener(s) to one or more Node elements
+ *
+ * @param element One or multiple Node element(s) to set listener(s) for
+ * @param listeners List of event types and related callback(s)
+ * @returns void
+ */
+export declare const addEventListener: (element: HTMLElement | HTMLElement[] | NodeListOf<HTMLElement> | HTMLCollectionOf<HTMLElement>, listeners: Record<string, EventListenerOrEventListenerObject | EventListenerOrEventListenerObject[]>) => void;

package/dist/dom/appendAfter.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Append given node after reference node in the DOM
+ *
+ * @param newNode New node element to be appended
+ * @param referenceNode Reference node element
+ * @returns Result of the action
+ */
+export declare const appendAfter: (newNode: HTMLElement, referenceNode: HTMLElement) => boolean;

package/dist/dom/appendBefore.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Append given node before reference node in the DOM
+ *
+ * @param newNode New node element to be appended
+ * @param referenceNode Reference node element
+ * @returns Result of the action
+ */
+export declare const appendBefore: (newNode: HTMLElement, referenceNode: HTMLElement) => boolean;

package/dist/dom/createElement.d.ts

@@ -0,0 +1,9 @@
+import { IExtendingElementProps } from './interfaces/createElement.js';
+/**
+ * Method for creating Node element and assigning multiple parameters, event listeners & children in one method call
+ *
+ * @param tagName Node tag name
+ * @param props List of attributes, event listeners or/and children to assign to the newly created element
+ * @returns Resulting Node element
+ */
+export declare const createElement: <T = HTMLElement>(tagName: string, props?: (Partial<Omit<T, "style" | "children" | "dataset">> & IExtendingElementProps) | undefined) => T;

package/dist/dom/fireEvent.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Manually fire event on Node element
+ *
+ * @param element Node element on which should be fired event
+ * @param eventType Type name of event that should be fired
+ * @returns Result of the action
+ */
+export declare const fireEvent: (element: HTMLElement, eventType: string) => boolean;

package/dist/dom/index.d.ts

@@ -0,0 +1,8 @@
+export * from './interfaces/index.js';
+export * from './addAsyncEventListener.js';
+export * from './addClickOutsideListener.js';
+export * from './addEventListener.js';
+export * from './appendAfter.js';
+export * from './appendBefore.js';
+export * from './createElement.js';
+export * from './fireEvent.js';

package/dist/dom/interfaces/createElement.d.ts

@@ -0,0 +1,9 @@
+export declare type TAriaLabelKey = 'atomic' | 'busy' | 'controls' | 'current' | 'describedby' | 'details' | 'disables' | 'dropeffect' | 'errormessage' | 'expanded' | 'flowto' | 'grabbed' | 'haspopup' | 'hidden' | 'invalid' | 'keyshortcuts' | 'label' | 'labelledby' | 'live' | 'modal' | 'owns' | 'relevant' | 'roledescription';
+export interface IExtendingElementProps {
+    children?: HTMLElement[];
+    listeners?: Record<string, EventListenerOrEventListenerObject | EventListenerOrEventListenerObject[]>;
+    role?: string;
+    aria?: Partial<Record<TAriaLabelKey, string>>;
+    dataset?: Record<string, string>;
+    style?: Record<string, string | number>;
+}

package/dist/dom/interfaces/index.d.ts

@@ -0,0 +1 @@
+export * from './createElement.js';

package/dist/general/index.d.ts

@@ -0,0 +1,3 @@
+export * from './isEmpty.js';
+export * from './isNil.js';
+export * from './isValidJson.js';

package/dist/general/isEmpty.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Check if given value is empty
+ *
+ * @param value Value to be checked
+ * @returns Boolean indicating if given value is empty
+ */
+export declare const isEmpty: (value: any) => boolean;

package/dist/general/isNil.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Check if value is equal to null or undefined
+ *
+ * @param value Value to be checked
+ * @returns Boolean indicating if value is equal to null or undefined
+ */
+export declare const isNil: (value: any) => boolean;

package/dist/general/isValidJson.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Check if string is valid JSON
+ *
+ * @param value String value to be checked
+ * @returns Boolean indicating if string value is a valid JSON
+ */
+export declare const isValidJson: (value: string) => boolean;

package/dist/index.d.ts

@@ -0,0 +1,6 @@
+export * from './browser/index.js';
+export * from './dateTime/index.js';
+export * from './dom/index.js';
+export * from './general/index.js';
+export * from './schedule/index.js';
+export * from './string/index.js';

package/dist/schedule/index.d.ts

@@ -0,0 +1,2 @@
+export * from './runAnimation.js';
+export * from './runAsync.js';

package/dist/schedule/runAnimation.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Run function as animation using requestAnimationFrame
+ *
+ * @param fn Function to be run as animation
+ * @param autoStart If animation should start right away or just return callbacks
+ * @returns Callbacks to start animation (startAnimation) and stop animation (stopAnimation)
+ */
+export declare const runAnimation: (fn: () => any, autoStart?: boolean) => {
+    startAnimation: () => void;
+    stopAnimation: () => void;
+};

package/dist/schedule/runAsync.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Run function in asynchronously in Worker
+ *
+ * @param fn Function to be run asynchronously
+ * @returns Promise of expected result
+ */
+export declare const runAsync: <T>(fn: () => any) => Promise<T>;

package/dist/string/byteSize.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Return size of string in bytes
+ *
+ * @param value String to be sized
+ * @returns Byte size of given string
+ */
+export declare const byteSize: (value: string) => number;

package/dist/string/escapeHTML.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Escape special HTML related characters from string
+ *
+ * @param html String containing HTML related characters
+ * @returns Safe string with escaped HTML related characters
+ */
+export declare const escapeHTML: (html: string) => string;

package/dist/string/index.d.ts

@@ -0,0 +1,5 @@
+export * from './byteSize.js';
+export * from './escapeHTML.js';
+export * from './removeDiacritics.js';
+export * from './slugify.js';
+export * from './truncate.js';

package/dist/string/removeDiacritics.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Remove diacritics & accents from string
+ *
+ * @param value String from which should be removed diacritics & accents
+ * @returns ASCII string with removed diacritics & accents
+ */
+export declare const removeDiacritics: (value: string) => string;

package/dist/string/slugify.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Create slug from given string
+ *
+ * @param value String to be slugified
+ * @param separator One character to be used as separator (if provided longer than one character, will be automatically shortened), dash ('-') by default
+ * @returns Slugified string
+ */
+export declare const slugify: (value: string, separator?: string) => string;

package/dist/string/truncate.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Truncate string to maximum given length if needed and append string at the end (by default "...")
+ *
+ * @param value String value to be truncated
+ * @param maxLength Maximum allowed length
+ * @param appendedString String to append at the end, be default "..."
+ * @returns Truncated value if needed otherwise original value
+ */
+export declare const truncate: (value: string, maxLength: number, appendedString?: string) => string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "tool-shack",
-  "version": "0.0.14",
+  "version": "0.0.17",
   "description": "Collection of usefull functions to ease work",
   "author": {
     "name": "David Myška",
@@ -19,24 +19,30 @@
   "module": "dist/index.js",
   "main": "dist/index.js",
   "exports": {
-    "default": "./dist/index.js"
+    "./package.json": {
+      "default": "./package.json"
+    },
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    }
   },
   "files": [
     "dist/**/*.js",
+    "dist/**/*.d.ts",
     "src/**/*.ts"
   ],
   "scripts": {
-    "build": "rm -rf dist && tsc-esm .",
+    "build": "rm -rf dist && tsc -b .",
     "format": "pretty-quick",
     "generate-docs": "rm -rf docs && typedoc --name \"Tool-Shack\" --readme README.md src/*/index.ts",
     "prepare": "husky install"
   },
   "devDependencies": {
-    "@digitak/tsc-esm": "^3.1.2",
-    "husky": "^7.0.4",
-    "prettier": "^2.6.2",
+    "husky": "^8.0.1",
+    "prettier": "^2.7.1",
     "pretty-quick": "^3.1.3",
-    "typedoc": "^0.22.13",
-    "typescript": "^4.6.3"
+    "typedoc": "^0.23.11",
+    "typescript": "^4.8.2"
   }
 }

package/src/browser/index.ts

@@ -1,6 +1,7 @@
-export * from './isPushNotificationSupported';
-export * from './isShareSupported';
-export * from './isTabFocused';
-export * from './isTouchSupported';
-export * from './preferColorScheme';
-export * from './tabFocusListener';
+export * from './isPushNotificationSupported.js';
+export * from './isScrollBehaviorSupported.js';
+export * from './isShareSupported.js';
+export * from './isTabFocused.js';
+export * from './isTouchSupported.js';
+export * from './preferColorScheme.js';
+export * from './tabFocusListener.js';

package/src/browser/isScrollBehaviorSupported.ts

@@ -0,0 +1,7 @@
+/**
+ * Check if user's browser supports setting scroll behavior
+ *
+ * @returns Boolean indicating if user's browser supports setting scroll behavior
+ */
+export const isScrollBehaviorSupported = (): boolean =>
+  !!('scrollBehavior' in document.documentElement.style);

package/src/browser/isTouchSupported.ts

@@ -1,4 +1,4 @@
-import { IExtendedWindow } from './interfaces/isTouchSupported';
+import { IExtendedWindow } from './interfaces/isTouchSupported.js';
 
 /**
  * Check if user's browser supports touch events

package/src/browser/tabFocusListener.ts

@@ -1,4 +1,4 @@
-import { isTabFocused } from './isTabFocused';
+import { isTabFocused } from './isTabFocused.js';
 
 /**
  * Set callbacks for if current browser tab is in focus

package/src/dateTime/index.ts

@@ -1,4 +1,4 @@
-export * from './interfaces';
+export * from './interfaces/index.js';
 
-export * from './dateAsIso';
-export * from './parseDuration';
+export * from './dateAsIso.js';
+export * from './parseDuration.js';

package/src/dateTime/interfaces/index.ts

@@ -1 +1 @@
-export * from './parseDuration';
+export * from './parseDuration.js';

package/src/dateTime/parseDuration.ts

@@ -1,4 +1,4 @@
-import { IDuration } from './interfaces/parseDuration';
+import { IDuration } from './interfaces/parseDuration.js';
 
 /**
  * Parse duration in milliseconds into days, hours, minutes, seconds, milliseconds

package/src/dom/createElement.ts

@@ -1,4 +1,4 @@
-import { IExtendingElementProps } from './interfaces/createElement';
+import { IExtendingElementProps } from './interfaces/createElement.js';
 
 /**
  * Method for creating Node element and assigning multiple parameters, event listeners & children in one method call

package/src/dom/index.ts

@@ -1,9 +1,9 @@
-export * from './interfaces';
+export * from './interfaces/index.js';
 
-export * from './addAsyncEventListener';
-export * from './addClickOutsideListener';
-export * from './addEventListener';
-export * from './appendAfter';
-export * from './appendBefore';
-export * from './createElement';
-export * from './fireEvent';
+export * from './addAsyncEventListener.js';
+export * from './addClickOutsideListener.js';
+export * from './addEventListener.js';
+export * from './appendAfter.js';
+export * from './appendBefore.js';
+export * from './createElement.js';
+export * from './fireEvent.js';

package/src/dom/interfaces/index.ts

@@ -1 +1 @@
-export * from './createElement';
+export * from './createElement.js';

package/src/general/index.ts

@@ -1,3 +1,3 @@
-export * from './isEmpty';
-export * from './isNil';
-export * from './isValidJson';
+export * from './isEmpty.js';
+export * from './isNil.js';
+export * from './isValidJson.js';

package/src/general/isEmpty.ts

@@ -1,4 +1,4 @@
-import { isNil } from './isNil';
+import { isNil } from './isNil.js';
 
 /**
  * Check if given value is empty

package/src/index.ts

@@ -1,6 +1,6 @@
-export * from './browser';
-export * from './dateTime';
-export * from './dom';
-export * from './general';
-export * from './schedule';
-export * from './string';
+export * from './browser/index.js';
+export * from './dateTime/index.js';
+export * from './dom/index.js';
+export * from './general/index.js';
+export * from './schedule/index.js';
+export * from './string/index.js';

package/src/schedule/index.ts

@@ -1,2 +1,2 @@
-export * from './runAnimation';
-export * from './runAsync';
+export * from './runAnimation.js';
+export * from './runAsync.js';

package/src/string/index.ts

@@ -1,5 +1,5 @@
-export * from './byteSize';
-export * from './escapeHTML';
-export * from './removeDiacritics';
-export * from './slugify';
-export * from './truncate';
+export * from './byteSize.js';
+export * from './escapeHTML.js';
+export * from './removeDiacritics.js';
+export * from './slugify.js';
+export * from './truncate.js';

package/src/string/slugify.ts

@@ -1,4 +1,4 @@
-import { removeDiacritics } from './removeDiacritics';
+import { removeDiacritics } from './removeDiacritics.js';
 
 /**
  * Create slug from given string