nanosplash 2.3.3 → 2.5.1

package/src/style.sass

@@ -1,14 +1,17 @@
 $z-index-regular: 1
 $z-index-fullscreen: 2
+$text-color: #5a6685
 $bg-color: rgba(White, 0.8)
 
 %blur
   overflow: hidden
   filter: blur(5px)
 
+// Wraps the content replaced by Nanosplash
 .ns-wrapper
   position: relative
 
+// Only active while in fullscreen mode
 .ns-fs
   top: 0
   left: 0
@@ -17,10 +20,11 @@ $bg-color: rgba(White, 0.8)
   min-height: 100vh
   z-index: $z-index-fullscreen
 
-// Fullscreen content blur
+// Blurs the wrapped content
 body .ns-fs ~ *, .ns-blur
   @extend %blur
 
+// Nanosplash window containing image and text
 .ns-window
   top: 0
   left: 0
@@ -33,26 +37,52 @@ body .ns-fs ~ *, .ns-blur
   z-index: $z-index-regular
   background-color: $bg-color
 
+// Image
 .ns-img
-  max-width: 9rem
+  width: 9rem
   max-height: 9rem
-  margin-bottom: 1rem
+  margin-bottom: 2em
 
+// Text container containing text and spinner
+.ns-text-container
+  display: flex
+  justify-content: center
+  align-items: center
+
+// Text node
 .ns-text
-  color: #333
   display: flex
-  text-align: center
-  &::after
-    margin-left: 0.25em
-    content: '\00a0\00a0\00a0'
-    animation: anim 1s infinite
+  justify-content: center
+  color: $text-color
+
+// Spinner node
+.ns-spinner
+  display: flex
+  margin-left: 1em
+  width: 1em
+  height: 1em
+  & > svg
+    animation: Rotate 2s linear infinite
+    position: relative
+    width: inherit
+    height: inherit
+    stroke-width: 8
+  & .path
+    stroke: $text-color
+    stroke-linecap: round
+    animation: Dash 1.5s ease-in-out infinite
 
-@keyframes anim
+// Spinner animations:
+@keyframes Rotate
+  100%
+    transform: rotate(360deg)
+@keyframes Dash
   0%
-    content: '\00a0\00a0\00a0'
-  30%
-    content: '.\00a0\00a0'
-  60%
-    content: '..\00a0'
-  90%
-    content: '...'
+    stroke-dasharray: 1, 150
+    stroke-dashoffset: 0
+  50%
+    stroke-dasharray: 90, 150
+    stroke-dashoffset: -35
+  100%
+    stroke-dasharray: 90, 150
+    stroke-dashoffset: -124

package/src/types.d.ts

@@ -1,38 +1,42 @@
-import {Nanosplash} from "./Core/Nanosplash";
+import Nanosplash from "./Core/Nanosplash";
 import {SplashInstance} from "./Core/SplashInstance";
 import {ShowInterface} from "./Interfaces/ShowInterface";
 import {ContextualAPIInterface} from "./Interfaces/ContextualAPIInterface";
+import {NanosplashInterface} from "./Interfaces/NanosplashInterface";
 
 declare global {
 	interface Window {
+		Nanosplash: typeof Nanosplash
+		installNanosplash: (options?: NanosplashOptions) => void
 		ns: Nanosplash
 	}
 }
 
-type Destination = Node | string
-type SplashJob = [Promise<any>, string]
+export type Destination = Node | string
+export type SplashJob = [Promise<any>, string]
 
 /**
  * @internal
  */
-export type HTMLElementTag = keyof HTMLElementTagNameMap
+export type ElementTag = keyof HTMLElementTagNameMap | keyof SVGElementTagNameMap
 
 /**
  * @internal
  */
 type CSSProperty = keyof CSSStyleDeclaration
 
-type ShowFunction = (text: string) => ContextualAPIInterface
-type ProgressFunction = (...[]: SplashJob[]) => ContextualAPIInterface
-type WhileFunction = (asyncTask: Promise<any>) => ShowInterface
-type StrategyObject = {
+export type ShowFunction = (text: string) => ContextualAPIObject
+export type ProgressFunction = (...[]: SplashJob[]) => ContextualAPIObject
+export type WhileFunction = (asyncTask: Promise<any>) => ShowInterface
+export type StrategyObject = {
     show: ShowFunction,
     progress: ProgressFunction,
     while: WhileFunction
 }
-type ImgFunction = (src: string) => StrategyObject
-type InsideFunction = (selector: string) => ContextualAPIInterface
-type ContextualAPIObject = {
+
+export type InsideFunction = (selector: string) => ContextualAPIInterface
+
+export type ContextualAPIObject = {
 	getId: () => string,
 	inside?: InsideFunction,
 	remove: () => void
@@ -43,7 +47,12 @@ type ContextualAPIObject = {
 	setImgSrc: (src?: string) => SplashInstance
 }
 
-declare module 'nanosplash' {
-	class Nanosplash {}
-	class SplashInstance {}
+export type InstanceIterationCallback = (id: string, splashInstance: SplashInstance, i: number) => boolean
+
+export type NanosplashOptions = {
+	imgSrc?: string,
+	spinner?: boolean,
+	fontSize?: string
 }
+
+export default Nanosplash

package/tsconfig.json

@@ -1,6 +1,7 @@
 {
   "compilerOptions": {
     "target": "es6",
+    "types": ["vitest/globals"],
     "module": "ESNext",
     "lib": ["ESNext", "DOM"],
     "moduleResolution": "Node",

package/update-all.sh

@@ -1,3 +1,3 @@
 #!/usr/bin/env bash
-yarn remove @types/jest @types/jsdom autoprefixer cssnano jest jsdom jest-environment-jsdom postcss sass ts-jest ts-node typedoc typescript vite
-yarn add -D @types/jest @types/jsdom autoprefixer cssnano jest jsdom jest-environment-jsdom postcss sass ts-jest ts-node typedoc typescript vite
+yarn remove @types/jsdom autoprefixer cssnano jsdom postcss sass ts-jest ts-node typedoc typescript vite vitest
+yarn add -D @types/jsdom autoprefixer cssnano jsdom postcss sass ts-jest ts-node typedoc typescript vite vitest

package/vite.config.ts

@@ -0,0 +1,16 @@
+import { defineConfig } from 'vitest/config'
+
+export default defineConfig({
+    test: {
+        globals: true,
+        environment: 'jsdom',
+        coverage: {
+            reporter: ['text', 'html'],
+            exclude: [
+                'node_modules/',
+                'dist/',
+                'docs/',
+            ],
+        },
+    }
+})

package/vite.mod.config.js

@@ -10,16 +10,16 @@ export default defineConfig({
 			formats: ['es', 'cjs'],
 		},
 		outDir: 'dist/module',
-		cssCodeSplit: true,
+		cssCodeSplit: false,
 		minify: 'terser',
 		terserOptions: {
 			parse: {
-				bare_returns: true,
+				bare_returns: false,
 			},
 			compress: {
 				keep_fargs: false,
 				keep_fnames: false,
-				keep_classnames: false,
+				keep_classnames: true,
 				module: true,
 				passes: 3,
 				toplevel: true,
@@ -37,9 +37,12 @@ export default defineConfig({
 						'setText',
 						'getImgSrc',
 						'setImgSrc',
+						'showSpinner',
+						'setFontSize',
+						'getFontSize',
+						'spinnerIsVisible',
 						'moveTo',
 						'delete',
-						'img',
 						'show',
 						'inside',
 						'remove',
@@ -48,17 +51,13 @@ export default defineConfig({
 						'delete',
 						'hideAll',
 						'hide',
+						'getFromDestinationNode',
+						'getDestination'
 					],
 				}
 			},
-			format: {
-				// wrap_iife: true
-			},
-			sourceMap: {
-				// source map options
-			},
 			ecma: 2015, // specify one of: 5, 2015, 2016, etc.
-			keep_classnames: false,
+			keep_classnames: true,
 			keep_fnames: false,
 			ie8: false,
 			module: true,

package/dist/module/Nanosplash.css

@@ -1 +0,0 @@
-@charset "UTF-8";.ns-blur,body .ns-fs~*{filter:blur(5px);overflow:hidden}.ns-wrapper{position:relative}.ns-fs{left:0;min-height:100vh;min-width:100%;position:fixed;top:0;z-index:2}.ns-window{align-items:center;background-color:#fffc;display:flex;height:100%;justify-content:center;left:0;position:absolute;top:0;width:100%;z-index:1}.ns-img{margin-bottom:1rem;max-height:9rem;max-width:9rem}.ns-text{color:#333;display:flex;text-align:center}.ns-text:after{-webkit-animation:anim 1s infinite;animation:anim 1s infinite;content:"\a0\a0\a0";margin-left:.25em}@-webkit-keyframes anim{0%{content:"\a0\a0\a0"}30%{content:".\a0\a0"}60%{content:"..\a0"}90%{content:"..."}}@keyframes anim{0%{content:"\a0\a0\a0"}30%{content:".\a0\a0"}60%{content:"..\a0"}90%{content:"..."}}

package/jest.config.ts

@@ -1,194 +0,0 @@
-/*
- * For a detailed explanation regarding each configuration property and type check, visit:
- * https://jestjs.io/docs/configuration
- */
-
-export default {
-	// All imported modules in your tests should be mocked automatically
-	// automock: false,
-
-	// Stop running tests after `n` failures
-	// bail: 0,
-
-	// The directory where Jest should store its cached dependency information
-	// cacheDirectory: "/private/var/folders/zc/vybtlxpn4dn4wr85nb3sh7lh0000gn/T/jest_dx",
-
-	// Automatically clear mock calls and instances between every test
-	clearMocks: true,
-
-	// Indicates whether the coverage information should be collected while executing the test
-	collectCoverage: true,
-
-	// An array of glob patterns indicating a set of files for which coverage information should be collected
-	// collectCoverageFrom: undefined,
-
-	// The directory where Jest should output its coverage files
-	coverageDirectory: 'coverage',
-
-	// An array of regexp pattern strings used to skip coverage collection
-	// coveragePathIgnorePatterns: [
-	//   "/node_modules/"
-	// ],
-
-	// Indicates which provider should be used to instrument code for coverage
-	coverageProvider: 'v8',
-
-	// A list of reporter names that Jest uses when writing coverage reports
-	// coverageReporters: [
-	//   "json",
-	//   "text",
-	//   "lcov",
-	//   "clover"
-	// ],
-
-	// An object that configures minimum threshold enforcement for coverage results
-	// coverageThreshold: undefined,
-
-	// A path to a custom dependency extractor
-	// dependencyExtractor: undefined,
-
-	// Make calling deprecated APIs throw helpful error messages
-	// errorOnDeprecated: false,
-
-	// Force coverage collection from ignored files using an array of glob patterns
-	// forceCoverageMatch: [],
-
-	// A path to a module which exports an async function that is triggered once before all test suites
-	// globalSetup: undefined,
-
-	// A path to a module which exports an async function that is triggered once after all test suites
-	// globalTeardown: undefined,
-
-	// A set of global variables that need to be available in all test environments
-	// globals: {},
-
-	// The maximum amount of workers used to run your tests. Can be specified as % or a number. E.g. maxWorkers: 10% will use 10% of your CPU amount + 1 as the maximum worker number. maxWorkers: 2 will use a maximum of 2 workers.
-	// maxWorkers: "50%",
-
-	// An array of directory names to be searched recursively up from the requiring module's location
-	// moduleDirectories: [
-	//   "node_modules"
-	// ],
-
-	// An array of file extensions your modules use
-	// moduleFileExtensions: [
-	//   "js",
-	//   "jsx",
-	//   "ts",
-	//   "tsx",
-	//   "json",
-	//   "node"
-	// ],
-
-	// A map from regular expressions to module names or to arrays of module names that allow to stub out resources with a single module
-	// moduleNameMapper: {},
-
-	// An array of regexp pattern strings, matched against all module paths before considered 'visible' to the module loader
-	// modulePathIgnorePatterns: [],
-
-	// Activates notifications for test results
-	// notify: false,
-
-	// An enum that specifies notification mode. Requires { notify: true }
-	// notifyMode: "failure-change",
-
-	// A preset that is used as a base for Jest's configuration
-	preset: 'ts-jest',
-
-	// Run tests from one or more projects
-	// projects: undefined,
-
-	// Use this configuration option to add custom reporters to Jest
-	// reporters: undefined,
-
-	// Automatically reset mock state between every test
-	// resetMocks: false,
-
-	// Reset the module registry before running each individual test
-	// resetModules: false,
-
-	// A path to a custom resolver
-	// resolver: undefined,
-
-	// Automatically restore mock state between every test
-	// restoreMocks: false,
-
-	// The root directory that Jest should scan for tests and modules within
-	// rootDir: undefined,
-
-	// A list of paths to directories that Jest should use to search for files in
-	// roots: [
-	//   "<rootDir>"
-	// ],
-
-	// Allows you to use a custom runner instead of Jest's default test runner
-	// runner: "jest-runner",
-
-	// The paths to modules that run some code to configure or set up the testing environment before each test
-	// setupFiles: [],
-
-	// A list of paths to modules that run some code to configure or set up the testing framework before each test
-	// setupFilesAfterEnv: [],
-
-	// The number of seconds after which a test is considered as slow and reported as such in the results.
-	// slowTestThreshold: 5,
-
-	// A list of paths to snapshot serializer modules Jest should use for snapshot testing
-	// snapshotSerializers: [],
-
-	// The test environment that will be used for testing
-	testEnvironment: 'jsdom',
-
-	// Options that will be passed to the testEnvironment
-	// testEnvironmentOptions: {},
-
-	// Adds a location field to test results
-	// testLocationInResults: false,
-
-	// The glob patterns Jest uses to detect test files
-	// testMatch: [
-	//   "**/__tests__/**/*.[jt]s?(x)",
-	//   "**/?(*.)+(spec|test).[tj]s?(x)"
-	// ],
-
-	// An array of regexp pattern strings that are matched against all test paths, matched tests are skipped
-	// testPathIgnorePatterns: [
-	//   "/node_modules/"
-	// ],
-
-	// The regexp pattern or array of patterns that Jest uses to detect test files
-	// testRegex: [],
-
-	// This option allows the use of a custom results processor
-	// testResultsProcessor: undefined,
-
-	// This option allows use of a custom test runner
-	// testRunner: "jest-circus/runner",
-
-	// This option sets the URL for the jsdom environment. It is reflected in properties such as location.href
-	// testURL: "http://localhost",
-
-	// Setting this value to "fake" allows the use of fake timers for functions such as "setTimeout"
-	// timers: "real",
-
-	// A map from regular expressions to paths to transformers
-	// transform: undefined,
-
-	// An array of regexp pattern strings that are matched against all source file paths, matched files will skip transformation
-	// transformIgnorePatterns: [
-	//   "/node_modules/",
-	//   "\\.pnp\\.[^\\/]+$"
-	// ],
-
-	// An array of regexp pattern strings that are matched against all modules before the module loader will automatically return a mock for them
-	// unmockedModulePathPatterns: undefined,
-
-	// Indicates whether each individual test should be reported during the run
-	// verbose: undefined,
-
-	// An array of regexp patterns that are matched against all source file paths before re-running tests in watch mode
-	// watchPathIgnorePatterns: [],
-
-	// Whether to use watchman for file crawling
-	// watchman: true,
-}

package/src/Interfaces/ImageInterface.ts

@@ -1,5 +0,0 @@
-import {ImgFunction} from "../types";
-
-export interface ImageInterface {
-    img: ImgFunction
-}

package/src/repositories/NanosplashRepository.ts

@@ -1,39 +0,0 @@
-import {get} from "../utilities/dom";
-import {SplashInstance} from "../Core/SplashInstance";
-import {ContextualAPIObject, Destination} from "../types";
-
-export class NanosplashRepository {
-    public static destinationToNode(destination: Destination): HTMLElement
-    {
-        if (typeof destination === 'string') {
-            const element = get<HTMLElement>(destination)
-            if (!element) {
-                throw new Error(`No match with ${destination}`)
-            }
-            return element
-        } else if (destination instanceof Node) {
-            return destination as HTMLElement
-        }
-        throw new Error('Destination argument must string or Node')
-    }
-
-    public static createContextualApiObject(splash: SplashInstance): ContextualAPIObject
-    {
-        const ctx = {
-            getId: () => splash.getId(),
-            remove: () => splash.delete(),
-            moveTo: (selector: string) => splash.moveTo(selector),
-            getText: () => splash.getText(),
-            setText: (text: string) => splash.setText(text),
-            getImgSrc: () => splash.getImgSrc(),
-            setImgSrc: (src?: string) => splash.setImgSrc(src)
-        }
-        return {
-            ...ctx,
-            inside: (selector: string) => {
-                splash.moveTo(selector)
-                return ctx
-            },
-        }
-    }
-}

package/src/utilities/dom.ts

@@ -1,26 +0,0 @@
-import {HTMLElementTag} from "../types";
-
-export function get<T>(selector: string): HTMLElement | T | null {
-    return document.querySelector(selector) as HTMLElement | T | null
-}
-
-export function move(source: Node, destination: Node, asFirstChild: boolean = false): void
-{
-    if (source && destination) {
-        (destination.hasChildNodes() && asFirstChild)
-            ? destination.insertBefore(source, destination.firstChild)
-            : destination.appendChild(source)
-    }
-}
-
-export const mk = (tag: HTMLElementTag) => document.createElement(tag)
-
-export function addClass(node: HTMLElement, ...classes: string[]): void
-{
-    node.classList.add(...classes)
-}
-
-export function setAttr(node: HTMLElement, attribute: string, value: string): void
-{
-    node.setAttribute(attribute, value)
-}