nanosplash 2.5.0 → 2.5.3

package/src/{repositories → Repositories}/NanosplashRepository.ts

@@ -1,25 +1,42 @@
-import {addClass, get, mk} from "../utilities/dom";
+import Exception from "../Exceptions/Exception";
+import {addClass, get, mk} from "../Utilities/dom";
 import {SplashInstance} from "../Core/SplashInstance";
 import {ContextualAPIObject, Destination} from "../types";
+import DestinationException from "../Exceptions/DestinationException";
+import IllegalArgumentException from "../Exceptions/IllegalArgumentException";
 
 export class NanosplashRepository {
     /**
      * # Destination To Node
      * Converts a Destination type into an HTMLElement.
      * @param {Destination} destination Either a node or a CSS selector.
+     * @throws DestinationException
+     * @throws IllegalArgumentException
      */
     public static destinationToNode(destination: Destination): HTMLElement
     {
         if (typeof destination === 'string') {
-            const element = get<HTMLElement>(destination)
-            if (!element) {
-                throw new Error(`No match with ${destination}`)
+            try {
+                const element = get<HTMLElement>(destination)
+                if (!element) {
+                    throw new Exception(`No DOM match with ${destination}`)
+                }
+                return element
+            } catch (e) {
+                throw new DestinationException(
+                    `Destination (${destination}) is either invalid or non-existing in DOM`,
+                    destination,
+                    e as Exception
+                )
             }
-            return element
         } else if (destination instanceof Node) {
             return destination as HTMLElement
         }
-        throw new Error('Destination argument must string or Node')
+
+        throw new IllegalArgumentException(
+            `Destination (${destination}) must be either a Node or a CSS selector`,
+            destination
+        )
     }
 
     /**

package/src/{utilities → Tests}/dom.spec.ts

@@ -1,4 +1,5 @@
-import {addClass, get, mk, move, setAttr} from "./dom";
+import {test} from "vitest"
+import {addClass, get, mk, move, setAttr} from "../Utilities/dom"
 
 const resetDOM = () => document.body.innerHTML = ''
 

package/src/types.d.ts

@@ -25,8 +25,8 @@ export type ElementTag = keyof HTMLElementTagNameMap | keyof SVGElementTagNameMa
  */
 type CSSProperty = keyof CSSStyleDeclaration
 
-export type ShowFunction = (text: string) => ContextualAPIInterface
-export type ProgressFunction = (...[]: SplashJob[]) => ContextualAPIInterface
+export type ShowFunction = (text: string) => ContextualAPIObject
+export type ProgressFunction = (...[]: SplashJob[]) => ContextualAPIObject
 export type WhileFunction = (asyncTask: Promise<any>) => ShowInterface
 export type StrategyObject = {
     show: ShowFunction,
@@ -35,6 +35,7 @@ export type StrategyObject = {
 }
 
 export type InsideFunction = (selector: string) => ContextualAPIInterface
+
 export type ContextualAPIObject = {
 	getId: () => string,
 	inside?: InsideFunction,
@@ -51,7 +52,8 @@ export type InstanceIterationCallback = (id: string, splashInstance: SplashInsta
 export type NanosplashOptions = {
 	imgSrc?: string,
 	spinner?: boolean,
-	fontSize?: string
+	fontSize?: string,
+	debug?: boolean
 }
 
 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

@@ -14,12 +14,12 @@ export default defineConfig({
 		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,
@@ -28,10 +28,7 @@ export default defineConfig({
 			mangle: {
 				toplevel: true,
 				// Reserved class names
-				reserved: [
-					'Nanosplash',
-					'SplashInstance'
-				],
+				reserved: [],
 				properties: {
 					reserved: [
 						'ns',
@@ -59,14 +56,8 @@ export default defineConfig({
 					],
 				}
 			},
-			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/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,
-}