@spscommerce/utils 5.0.0-rc1 → 5.0.0

package/lib/number/constrain.d.ts

@@ -1,6 +1,7 @@
-/** Constrains a number to the given range. If the number is below the
- * low end of the range, the low end will be returned. If the number is
- * above the top end of the range, the top end will be returned. Otherwise
- * the number itself will be returned.
- */
-export declare function constrain(n: number, range: [number, number]): number;
+/**
+ * Constrains a number to the given range. If the number is below the
+ * low end of the range, the low end will be returned. If the number is
+ * above the top end of the range, the top end will be returned. Otherwise
+ * the number itself will be returned.
+ */
+export declare function constrain(n: number, range: [number, number]): number;

package/lib/number/decimal-round.d.ts

@@ -1,7 +1,7 @@
-/**
- * Progressively rounds `num` to `decimalPlaces` places. This differs from other
- * rounding methods out there such as lodash's, which are not progressive. For example,
- * `(0.149).toFixed(1)` and lodash `_.round(0.149, 1)` both return `0.1`, but this
- * function rounds `0.149` to `0.15` and then `0.15` to `0.2` and returns `0.2`.
- */
-export declare function decimalRound(num: number, decimalPlaces?: number): number;
+/**
+ * Progressively rounds `num` to `decimalPlaces` places. This differs from other
+ * rounding methods out there such as lodash's, which are not progressive. For example,
+ * `(0.149).toFixed(1)` and lodash `_.round(0.149, 1)` both return `0.1`, but this
+ * function rounds `0.149` to `0.15` and then `0.15` to `0.2` and returns `0.2`.
+ */
+export declare function decimalRound(num: number, decimalPlaces?: number): number;

package/lib/number/decimal-round.spec.d.ts

@@ -1 +1 @@
-export {};
+export {};

package/lib/number/index.d.ts

@@ -1,3 +1,3 @@
-export * from './constrain';
-export * from './decimal-round';
-export * from './to-file-size-string';
+export * from "./constrain";
+export * from "./decimal-round";
+export * from "./to-file-size-string";

package/lib/number/to-file-size-string.d.ts

@@ -1,4 +1,5 @@
-/** Converts a file size in bytes to a human-friendly string. For example,
- * `toFileSizeString(2048)` will return `"2.00KB"`.
- */
-export declare function toFileSizeString(n: number, precision?: number): string;
+/**
+ * Converts a file size in bytes to a human-friendly string. For example,
+ * `toFileSizeString(2048)` will return `"2.00KB"`.
+ */
+export declare function toFileSizeString(n: number, precision?: number): string;

package/lib/object/copy-property.d.ts

@@ -1,6 +1,6 @@
-/**
- * Copy a property from one object to another using its property descriptor.
- * In other words, if it's a getter/setter on `sourceObject` it'll be the same
- * getter/setter on `destObject`. If it's just a value it'll be just a value.
- */
-export declare function copyProperty(propName: PropertyKey, sourceObject: any, destObject: any): void;
+/**
+ * Copy a property from one object to another using its property descriptor.
+ * In other words, if it's a getter/setter on `sourceObject` it'll be the same
+ * getter/setter on `destObject`. If it's just a value it'll be just a value.
+ */
+export declare function copyProperty(propName: PropertyKey, sourceObject: any, destObject: any): void;

package/lib/object/copy-property.spec.d.ts

@@ -1 +1 @@
-export {};
+export {};

package/lib/object/crumble-path.d.ts

@@ -1,5 +1,6 @@
-/** Converts a path to crumbs.
- *  For example:
- *  "a.b[0].c" -> ["a", "b", "0", "c"]
- */
-export declare function crumblePath(path: string | PropertyKey | PropertyKey[]): PropertyKey[];
+/**
+ * Converts a path to crumbs.
+ *  For example:
+ *  "a.b[0].c" -> ["a", "b", "0", "c"]
+ */
+export declare function crumblePath(path: string | PropertyKey | PropertyKey[]): PropertyKey[];

package/lib/object/crumble-path.spec.d.ts

@@ -1 +1 @@
-export {};
+export {};

package/lib/object/deep-freeze.d.ts

@@ -1 +1 @@
-export declare function deepFreeze(obj: any): void;
+export declare function deepFreeze(obj: any): void;

package/lib/object/deep-freeze.spec.d.ts

@@ -1 +1 @@
-export {};
+export {};

package/lib/object/diff.d.ts

@@ -1,12 +1,12 @@
-export declare enum DiffChange {
-    ADDITION = 0,
-    DELETION = 1,
-    ALTERATION = 2
-}
-export interface DiffEntry {
-    type: DiffChange;
-    key: PropertyKey;
-    parentPath: Array<PropertyKey>;
-    objects: [object, object];
-}
-export declare function diff(o1: object, o2: object, parentPath?: Array<PropertyKey>): Array<DiffEntry>;
+export declare enum DiffChange {
+    ADDITION = 0,
+    DELETION = 1,
+    ALTERATION = 2
+}
+export interface DiffEntry {
+    type: DiffChange;
+    key: PropertyKey;
+    parentPath: PropertyKey[];
+    objects: [Record<PropertyKey, unknown>, Record<PropertyKey, unknown>];
+}
+export declare function diff(o1: Record<PropertyKey, unknown>, o2: Record<PropertyKey, unknown>, parentPath?: PropertyKey[]): DiffEntry[];

package/lib/object/diff.spec.d.ts

@@ -1 +1 @@
-export {};
+export {};

package/lib/object/for-each-entry-deep.d.ts

@@ -1,4 +1,4 @@
-/**
- * Recursively navigate a nested object & call `fn` for each key/value pair
- */
-export declare function forEachEntryDeep(object: any, fn: (key: string, value: any, object: any) => any): any;
+/**
+ * Recursively navigate a nested object & call `fn` for each key/value pair
+ */
+export declare function forEachEntryDeep(object: any, fn: (key: string, value: any, object: any) => any): any;

package/lib/object/for-each-entry-deep.spec.d.ts

@@ -1 +1 @@
-export {};
+export {};

package/lib/object/for-each-nested-object.d.ts

@@ -1,4 +1,4 @@
-/**
- * Recursively navigate a nested object & call `fn` for each subobject
- */
-export declare function forEachNestedObject(object: any, fn: (path: PropertyKey[], object: any) => any, path?: PropertyKey[]): any;
+/**
+ * Recursively navigate a nested object & call `fn` for each subobject
+ */
+export declare function forEachNestedObject(object: any, fn: (path: PropertyKey[], object: any) => any, path?: PropertyKey[]): any;

package/lib/object/for-each-nested-object.spec.d.ts

@@ -1 +1 @@
-export {};
+export {};

package/lib/object/get-path.d.ts

@@ -1,4 +1,5 @@
-/** Get the value at `path` starting from `object`.
- * Allows optional chaining, e.g. `get(obj, 'a.b?.c')`
- */
-export declare function getPath<T>(object: any, path: string | PropertyKey | PropertyKey[], defaultValue?: T, allOptional?: boolean): T;
+/**
+ * Get the value at `path` starting from `object`.
+ * Allows optional chaining, e.g. `get(obj, 'a.b?.c')`
+ */
+export declare function getPath<T>(object: any, path: string | PropertyKey | PropertyKey[], defaultValue?: T, allOptional?: boolean): T;

package/lib/object/get-path.spec.d.ts

@@ -1 +1 @@
-export {};
+export {};

package/lib/object/index.d.ts

@@ -1,13 +1,13 @@
-export * from './crumble-path';
-export * from './copy-property';
-export * from './deep-freeze';
-export * from './diff';
-export * from './for-each-entry-deep';
-export * from './for-each-nested-object';
-export * from './get-path';
-export * from './omit';
-export * from './set-path';
-export * from './traverse-path';
-export * from './merge-deep';
-export * from './merge-properties-deep';
-export * from './values';
+export * from "./crumble-path";
+export * from "./copy-property";
+export * from "./deep-freeze";
+export * from "./diff";
+export * from "./for-each-entry-deep";
+export * from "./for-each-nested-object";
+export * from "./get-path";
+export * from "./omit";
+export * from "./set-path";
+export * from "./traverse-path";
+export * from "./merge-deep";
+export * from "./merge-properties-deep";
+export * from "./values";

package/lib/object/merge-deep.d.ts

@@ -1,4 +1,4 @@
-/**
- * Recursive merge of any number of objects
- */
-export declare function mergeDeep(...objectsToMerge: any[]): any;
+/**
+ * Recursive merge of any number of objects
+ */
+export declare function mergeDeep(...objectsToMerge: any[]): any;

package/lib/object/merge-deep.spec.d.ts

@@ -1 +1 @@
-export {};
+export {};

package/lib/object/merge-properties-deep.d.ts

@@ -1,4 +1,4 @@
-/**
- * Recursive merge of any number of objects using `copyProperty()` rather than assignment
- */
-export declare function mergePropertiesDeep(...objectsToMerge: any[]): any;
+/**
+ * Recursive merge of any number of objects using `copyProperty()` rather than assignment
+ */
+export declare function mergePropertiesDeep(...objectsToMerge: any[]): any;

package/lib/object/merge-properties-deep.spec.d.ts

@@ -1 +1 @@
-export {};
+export {};

package/lib/object/omit.d.ts

@@ -1 +1 @@
-export declare function omit(obj: any, ...keys: Array<PropertyKey>): {};
+export declare function omit(obj: any, ...keys: PropertyKey[]): {};

package/lib/object/omit.spec.d.ts

@@ -1 +1 @@
-export {};
+export {};

package/lib/object/set-path.d.ts

@@ -1,2 +1,2 @@
-/** Set the value at `path` on `object`. */
-export declare function setPath(object: any, path: PropertyKey | PropertyKey[], newValue: any): void;
+/** Set the value at `path` on `object`. */
+export declare function setPath(object: any, path: PropertyKey | PropertyKey[], newValue: any): void;

package/lib/object/set-path.spec.d.ts

@@ -1 +1 @@
-export {};
+export {};

package/lib/object/traverse-path.d.ts

@@ -1,2 +1,2 @@
-/** Generator for iterating down a path on an object. */
-export declare function traversePath(object: any, path: any): Generator<any, void, unknown>;
+/** Generator for iterating down a path on an object. */
+export declare function traversePath(object: any, path: any): Generator<any, void, unknown>;

package/lib/object/values.d.ts

@@ -1,2 +1,2 @@
-/** Returns the values of an object. */
-export declare function values(object: any): any[];
+/** Returns the values of an object. */
+export declare function values(object: any): any[];

package/lib/object/values.spec.d.ts

@@ -1 +1 @@
-export {};
+export {};

package/lib/string/code.template-tag.d.ts

@@ -1,2 +1,2 @@
-/** Template tag function for making strings containing code blocks easier to deal with. */
-export declare function code(strings: TemplateStringsArray, ...interpolations: any[]): string;
+/** Template tag function for making strings containing code blocks easier to deal with. */
+export declare function code(strings: TemplateStringsArray, ...interpolations: unknown[]): string;

package/lib/string/index.d.ts

@@ -1,3 +1,3 @@
-export * from './code.template-tag';
-export * from './parse-file-size';
-export * from './template';
+export * from "./code.template-tag";
+export * from "./parse-file-size";
+export * from "./template";

package/lib/string/parse-file-size.d.ts

@@ -1,4 +1,5 @@
-/** Parses a string as a file size and returns the size in bytes. For example,
- * `parseFileSize("2KB")` will return `2048`.
- */
-export declare function parseFileSize(fileSize: string): number;
+/**
+ * Parses a string as a file size and returns the size in bytes. For example,
+ * `parseFileSize("2KB")` will return `2048`.
+ */
+export declare function parseFileSize(fileSize: string): number;

package/lib/string/template.d.ts

@@ -1,13 +1,15 @@
-/**
- *  Every string templating thing out there whether lodash, doT, handlebars, etc
- *  is extremely complicated to cover a variety of use cases. This just has two
- *  very simple features and great caution should be exercised in making it any more
- *  complex than that. A value can be interpolated like so:
- *  `<%= foo.bar %>`
- *  And a basic "if" conditional can be used like so:
- *  `<%? a?.b?.c %>This part will only appear if a.b.c is truthy!</%>`
- *  You can put interpolations inside a conditional, as you'd expect. That's it.
- */
-export declare function template(string: string): (data: any) => string;
-export declare function isTemplate(x: any): x is string;
-export declare function isTemplateFn(x: any): x is Function;
+declare type TemplateFn = (data: any) => string;
+/**
+ *  Every string templating thing out there whether lodash, doT, handlebars, etc
+ *  is extremely complicated to cover a variety of use cases. This just has two
+ *  very simple features and great caution should be exercised in making it any more
+ *  complex than that. A value can be interpolated like so:
+ *  `<%= foo.bar %>`
+ *  And a basic "if" conditional can be used like so:
+ *  `<%? a?.b?.c %>This part will only appear if a.b.c is truthy!</%>`
+ *  You can put interpolations inside a conditional, as you'd expect. That's it.
+ */
+export declare function template(string: string): TemplateFn;
+export declare function isTemplate(x: any): x is string;
+export declare function isTemplateFn(x: any): x is TemplateFn;
+export {};

package/lib/string/template.spec.d.ts

@@ -1 +1 @@
-export {};
+export {};

package/lib/typings.d.ts

@@ -1 +1 @@
-export declare type Eventually<T> = T | Promise<T>;
+export declare type Eventually<T> = T | Promise<T>;

package/package.json

@@ -1,34 +1,33 @@
 {
   "name": "@spscommerce/utils",
   "description": "Utility items for frontend projects.",
-  "version": "5.0.0-rc1",
+  "version": "5.0.0",
   "author": "SPS Commerce",
   "license": "UNLICENSED",
   "repository": "https://github.com/spscommerce/design-system/tree/main/packages/@spscommerce/utils",
   "homepage": "https://github.com/spscommerce/design-system/tree/main/packages/@spscommerce/utils#readme",
-  "scripts": {
-    "build": "yarn run build:rollup",
-    "build:rollup": "npx rollup -c rollup.config.js",
-    "clean": "git clean -fdX",
-    "pub": "node ../../../scripts/publish-package.js"
-  },
   "main": "./lib/index.cjs.js",
-  "module": "./lib/index.esm.js",
+  "module": "./lib/index.es.js",
   "types": "./lib/index.d.ts",
   "publishConfig": {
     "access": "public"
   },
-  "peerDependencies": {
+  "devDependencies": {
+    "raf-stub": "^2.0.2"
+  },
+  "dependencies": {
     "lodash.isempty": "^4.4.0",
     "lodash.isnil": "^4.0.0",
     "lodash.isplainobject": "^4.0.6",
     "lodash.padstart": "^4.6.1"
   },
-  "devDependencies": {
-    "lodash.isempty": "^4.4.0",
-    "lodash.isnil": "^4.0.0",
-    "lodash.isplainobject": "^4.0.6",
-    "lodash.padstart": "^4.6.1",
-    "raf-stub": "^2.0.2"
-  }
+  "scripts": {
+    "build": "pnpm run build:js && pnpm run build:types",
+    "build:js": "vite build",
+    "build:types": "tsc --emitDeclarationOnly --declaration --declarationDir lib",
+    "watch": "vite build --watch",
+    "clean": "git clean -fdX",
+    "pub": "pnpm pack && node ../../scripts/publish-package.js"
+  },
+  "readme": "[//]: # \"START_AUTOGENERATED\"\n\n## [@spscommerce/utils](https://github.com/spscommerce/design-system/tree/main/packages/@spscommerce/utils#readme)\n\n![release: 1.1.0](https://img.shields.io/badge/release-1.1.0-blue.svg?style=flat-square)\n![build: passing](https://img.shields.io/badge/build-passing-green.svg?style=flat-square)\n![tests: failing](https://img.shields.io/badge/tests-failing-red.svg?style=flat-square)\n\nUtility items for frontend projects. \n \n ### Installation \n \n ```shell\nnpm install --save @spscommerce/utils\n```\n\n#### Peer Dependencies\n\n<div class=\"row\">\n    <div class=\"col-5\"> \n    <table class=\"sps-table\">\n        <thead class=\"sps-table__head\">\n            <tr class=\"sps-table__row\">\n                <th class=\"sps-table__header\">\n                    <span class=\"sps-table__header-cell-body\">    \n                        Package\n                    </span>\n                </th>\n                <th class=\"sps-table__header text-right\">\n                    <span class=\"sps-table__header-cell-body\">    \n                        Version\n                    </span>\n                </th>\n            </tr>\n        </thead>\n        <tbody class=\"sps-table__body\">\n            <tr class=\"sps-table__row\"><td class=\"sps-table__cell\"><a href=\"https://lodash.com/\">lodash.isempty</a></td><td class=\"sps-table__cell text-right\">^4.4.0</td></tr>\n<tr class=\"sps-table__row\"><td class=\"sps-table__cell\"><a href=\"https://lodash.com/\">lodash.isnil</a></td><td class=\"sps-table__cell text-right\">^4.0.0</td></tr>\n<tr class=\"sps-table__row\"><td class=\"sps-table__cell\"><a href=\"https://lodash.com/\">lodash.isplainobject</a></td><td class=\"sps-table__cell text-right\">^4.0.6</td></tr>\n<tr class=\"sps-table__row\"><td class=\"sps-table__cell\"><a href=\"https://lodash.com/\">lodash.padstart</a></td><td class=\"sps-table__cell text-right\">^4.6.1</td></tr>\n        </tbody>\n    </table>\n    </div>\n    <div class=\"col-7\">\n        &nbsp;\n    </div>\n</div>\n\n[//]: # \"END_AUTOGENERATED\"\n"
 }

package/tsconfig.json

@@ -1,5 +1,5 @@
 {
-    "extends": "../../../tsconfig.json",
+    "extends": "../../tsconfig.base.json",
     "compilerOptions": {
         "baseUrl": "tsconfig",
         "rootDir": "src/",

package/vite.config.js

@@ -0,0 +1,20 @@
+import path from 'path';
+
+import { defineConfig } from 'vite';
+
+import pkg from './package.json';
+
+export default defineConfig({
+  build: {
+    lib: {
+      entry: path.resolve(__dirname, 'src/index.ts'),
+      formats: ['es', 'cjs'],
+      fileName: (format) => `index.${format}.js`,
+    },
+    outDir: path.resolve(__dirname, './lib'),
+    emptyOutDir: false,
+    rollupOptions: {
+      external: pkg.peerDependencies ? Object.keys(pkg.peerDependencies) : [],
+    },
+  },
+});

package/lib/decorators/debounced.spec.d.ts

@@ -1 +0,0 @@
-export {};