@bouzu/shared 0.0.1 → 0.0.2

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) zhong666 <hi@zhong666.me> and bouzu contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,57 @@
+# @bouzu/shared
+
+[![npm version][npm-version-src]][npm-version-href]
+[![npm downloads][npm-downloads-src]][npm-downloads-href]
+[![bundle][bundle-src]][bundle-href]
+[![JSDocs][jsdocs-src]][jsdocs-href]
+
+## Usage
+
+Install package:
+
+```sh
+# npm
+npm install @bouzu/shared
+
+# yarn
+yarn add @bouzu/shared
+
+# pnpm
+pnpm install @bouzu/shared
+```
+
+Import:
+
+```js
+// ESM
+import * as shared from '@bouzu/shared'
+
+// CommonJS
+const shared = require('@bouzu/shared')
+```
+
+## Development
+
+- Clone this repository
+- Install latest LTS version of [Node.js](https://nodejs.org/en/)
+- Enable [Corepack](https://github.com/nodejs/corepack) using `corepack enable`
+- Install dependencies using `pnpm install`
+- Run interactive tests using `pnpm dev`
+
+## License
+
+Made with 💛
+
+Published under [MIT License](./LICENSE).
+
+
+<!-- Badges -->
+
+[npm-version-src]: https://img.shields.io/npm/v/@bouzu/shared?style=flat&colorA=18181B&colorB=F0DB4F
+[npm-version-href]: https://npmjs.com/package/@bouzu/shared
+[npm-downloads-src]: https://img.shields.io/npm/dm/@bouzu/shared?style=flat&colorA=18181B&colorB=F0DB4F
+[npm-downloads-href]: https://npmjs.com/package/@bouzu/shared
+[bundle-src]: https://img.shields.io/bundlephobia/minzip/@bouzu/shared?style=flat&colorA=18181B&colorB=F0DB4F
+[bundle-href]: https://bundlephobia.com/result?p=@bouzu/shared
+[jsdocs-src]: https://img.shields.io/badge/jsDocs.io-reference-18181B?style=flat&colorA=18181B&colorB=F0DB4F
+[jsdocs-href]: https://www.jsdocs.io/package/@bouzu/shared

package/dist/index.cjs

@@ -54,13 +54,12 @@ function checkSizeEqual(a, b) {
   return a.width === b.width && a.height === b.height;
 }
 
-var RectCorner = /* @__PURE__ */ ((RectCorner2) => {
-  RectCorner2["TopLeft"] = "TopLeft";
-  RectCorner2["TopRight"] = "TopRight";
-  RectCorner2["BottomLeft"] = "BottomLeft";
-  RectCorner2["BottomRight"] = "BottomRight";
-  return RectCorner2;
-})(RectCorner || {});
+const RectCorner = {
+  TopLeft: "TopLeft",
+  TopRight: "TopRight",
+  BottomLeft: "BottomLeft",
+  BottomRight: "BottomRight"
+};
 function createRect(x = 0, y = 0, width = 0, height = 0) {
   return {
     ...createPoint(x, y),
@@ -93,13 +92,13 @@ function getRectBottomRight(rect) {
 }
 function getRectPointByRectCorner(rect, corner) {
   switch (corner) {
-    case "TopLeft" /* TopLeft */:
+    case RectCorner.TopLeft:
       return getRectTopLeft(rect);
-    case "TopRight" /* TopRight */:
+    case RectCorner.TopRight:
       return getRectTopRight(rect);
-    case "BottomLeft" /* BottomLeft */:
+    case RectCorner.BottomLeft:
       return getRectBottomLeft(rect);
-    case "BottomRight" /* BottomRight */:
+    case RectCorner.BottomRight:
       return getRectBottomRight(rect);
     default:
       throw new TypeError(`Not match corner: ${corner}`);
@@ -147,6 +146,10 @@ function toPoint(rect) {
   return createPoint(rect.x, rect.y);
 }
 
+function isObject(val) {
+  return Object.prototype.toString.call(val) === "[object Object]";
+}
+
 exports.RectCorner = RectCorner;
 exports.checkLayoutInvalidate = checkLayoutInvalidate;
 exports.checkPointEqual = checkPointEqual;
@@ -174,6 +177,7 @@ exports.getRectMaxY = getRectMaxY;
 exports.getRectPointByRectCorner = getRectPointByRectCorner;
 exports.getRectTopLeft = getRectTopLeft;
 exports.getRectTopRight = getRectTopRight;
+exports.isObject = isObject;
 exports.noop = noop;
 exports.toPoint = toPoint;
 exports.toSize = toSize;

package/dist/index.d.cts

@@ -0,0 +1,65 @@
+import { ValueOf } from 'type-fest';
+
+declare function noop(): void;
+
+type Previous<T> = [
+    {
+        readonly curr: T | undefined;
+        readonly prev: T | undefined;
+    },
+    (val: T) => void
+];
+declare function usePrevious<T>(val?: T): Previous<T>;
+
+type WithoutFirstParameter<T> = T extends (arg1: any, ...args: infer U) => any ? U : any;
+declare function execLastTick<TTickFn extends typeof setTimeout | typeof queueMicrotask | typeof requestAnimationFrame, TFn extends (...args: any) => any>(tickFn: TTickFn, fn: TFn, ...tickFnArgs: WithoutFirstParameter<TTickFn>): (...args: Parameters<TFn>) => void;
+
+interface Point {
+    x: number;
+    y: number;
+}
+declare function createPoint(x?: number, y?: number): Point;
+declare function checkPointOrigin(p: Point): boolean;
+declare function checkPointEqual(a: Point, b: Point): boolean;
+
+interface Size {
+    width: number;
+    height: number;
+}
+declare function createSize(width?: number, height?: number): Size;
+declare function checkSizeEqual(a: Size, b: Size): boolean;
+
+type Rect = Size & Point;
+declare const RectCorner: {
+    readonly TopLeft: "TopLeft";
+    readonly TopRight: "TopRight";
+    readonly BottomLeft: "BottomLeft";
+    readonly BottomRight: "BottomRight";
+};
+type RectCornerValue = ValueOf<typeof RectCorner>;
+declare function createRect(x?: number, y?: number, width?: number, height?: number): Rect;
+declare function cloneRect(rect: Rect): Rect;
+declare function getRectMaxX(rect: Rect): number;
+declare function getRectMaxY(rect: Rect): number;
+declare function getRectArea(rect: Rect): number;
+declare function getRectTopLeft(rect: Rect): Point;
+declare function getRectTopRight(rect: Rect): Point;
+declare function getRectBottomLeft(rect: Rect): Point;
+declare function getRectBottomRight(rect: Rect): Point;
+declare function getRectPointByRectCorner(rect: Rect, corner: RectCornerValue): Point;
+declare function checkRectIntersectsX(a: Rect, b: Rect): boolean;
+declare function checkRectIntersectsY(a: Rect, b: Rect): boolean;
+declare function checkRectIntersects(a: Rect, b: Rect): boolean;
+declare function checkRectContains(a: Rect, b: Rect): boolean;
+declare function checkRectContainsPoint(a: Rect, p: Point): boolean;
+declare function getRectCornerInOther(a: Rect, b: Rect): RectCornerValue | null;
+declare function checkRectEqual(a: Rect, b: Rect): boolean;
+declare function checkRectEqualPoint(r: Rect, p: Point | Rect): boolean;
+declare function checkRectEqualSize(r: Rect, s: Size | Rect): boolean;
+declare function checkLayoutInvalidate(newRect: Rect, oldRect: Rect): boolean;
+declare function toSize(rect: Rect): Size;
+declare function toPoint(rect: Rect): Point;
+
+declare function isObject(val: unknown): val is Record<PropertyKey, any>;
+
+export { type Point, type Previous, type Rect, RectCorner, type RectCornerValue, type Size, checkLayoutInvalidate, checkPointEqual, checkPointOrigin, checkRectContains, checkRectContainsPoint, checkRectEqual, checkRectEqualPoint, checkRectEqualSize, checkRectIntersects, checkRectIntersectsX, checkRectIntersectsY, checkSizeEqual, cloneRect, createPoint, createRect, createSize, execLastTick, getRectArea, getRectBottomLeft, getRectBottomRight, getRectCornerInOther, getRectMaxX, getRectMaxY, getRectPointByRectCorner, getRectTopLeft, getRectTopRight, isObject, noop, toPoint, toSize, usePrevious };

package/dist/index.d.mts

@@ -0,0 +1,65 @@
+import { ValueOf } from 'type-fest';
+
+declare function noop(): void;
+
+type Previous<T> = [
+    {
+        readonly curr: T | undefined;
+        readonly prev: T | undefined;
+    },
+    (val: T) => void
+];
+declare function usePrevious<T>(val?: T): Previous<T>;
+
+type WithoutFirstParameter<T> = T extends (arg1: any, ...args: infer U) => any ? U : any;
+declare function execLastTick<TTickFn extends typeof setTimeout | typeof queueMicrotask | typeof requestAnimationFrame, TFn extends (...args: any) => any>(tickFn: TTickFn, fn: TFn, ...tickFnArgs: WithoutFirstParameter<TTickFn>): (...args: Parameters<TFn>) => void;
+
+interface Point {
+    x: number;
+    y: number;
+}
+declare function createPoint(x?: number, y?: number): Point;
+declare function checkPointOrigin(p: Point): boolean;
+declare function checkPointEqual(a: Point, b: Point): boolean;
+
+interface Size {
+    width: number;
+    height: number;
+}
+declare function createSize(width?: number, height?: number): Size;
+declare function checkSizeEqual(a: Size, b: Size): boolean;
+
+type Rect = Size & Point;
+declare const RectCorner: {
+    readonly TopLeft: "TopLeft";
+    readonly TopRight: "TopRight";
+    readonly BottomLeft: "BottomLeft";
+    readonly BottomRight: "BottomRight";
+};
+type RectCornerValue = ValueOf<typeof RectCorner>;
+declare function createRect(x?: number, y?: number, width?: number, height?: number): Rect;
+declare function cloneRect(rect: Rect): Rect;
+declare function getRectMaxX(rect: Rect): number;
+declare function getRectMaxY(rect: Rect): number;
+declare function getRectArea(rect: Rect): number;
+declare function getRectTopLeft(rect: Rect): Point;
+declare function getRectTopRight(rect: Rect): Point;
+declare function getRectBottomLeft(rect: Rect): Point;
+declare function getRectBottomRight(rect: Rect): Point;
+declare function getRectPointByRectCorner(rect: Rect, corner: RectCornerValue): Point;
+declare function checkRectIntersectsX(a: Rect, b: Rect): boolean;
+declare function checkRectIntersectsY(a: Rect, b: Rect): boolean;
+declare function checkRectIntersects(a: Rect, b: Rect): boolean;
+declare function checkRectContains(a: Rect, b: Rect): boolean;
+declare function checkRectContainsPoint(a: Rect, p: Point): boolean;
+declare function getRectCornerInOther(a: Rect, b: Rect): RectCornerValue | null;
+declare function checkRectEqual(a: Rect, b: Rect): boolean;
+declare function checkRectEqualPoint(r: Rect, p: Point | Rect): boolean;
+declare function checkRectEqualSize(r: Rect, s: Size | Rect): boolean;
+declare function checkLayoutInvalidate(newRect: Rect, oldRect: Rect): boolean;
+declare function toSize(rect: Rect): Size;
+declare function toPoint(rect: Rect): Point;
+
+declare function isObject(val: unknown): val is Record<PropertyKey, any>;
+
+export { type Point, type Previous, type Rect, RectCorner, type RectCornerValue, type Size, checkLayoutInvalidate, checkPointEqual, checkPointOrigin, checkRectContains, checkRectContainsPoint, checkRectEqual, checkRectEqualPoint, checkRectEqualSize, checkRectIntersects, checkRectIntersectsX, checkRectIntersectsY, checkSizeEqual, cloneRect, createPoint, createRect, createSize, execLastTick, getRectArea, getRectBottomLeft, getRectBottomRight, getRectCornerInOther, getRectMaxX, getRectMaxY, getRectPointByRectCorner, getRectTopLeft, getRectTopRight, isObject, noop, toPoint, toSize, usePrevious };

package/dist/index.d.ts

@@ -1,3 +1,5 @@
+import { ValueOf } from 'type-fest';
+
 declare function noop(): void;
 
 type Previous<T> = [
@@ -28,12 +30,13 @@ declare function createSize(width?: number, height?: number): Size;
 declare function checkSizeEqual(a: Size, b: Size): boolean;
 
 type Rect = Size & Point;
-declare enum RectCorner {
-    TopLeft = "TopLeft",
-    TopRight = "TopRight",
-    BottomLeft = "BottomLeft",
-    BottomRight = "BottomRight"
-}
+declare const RectCorner: {
+    readonly TopLeft: "TopLeft";
+    readonly TopRight: "TopRight";
+    readonly BottomLeft: "BottomLeft";
+    readonly BottomRight: "BottomRight";
+};
+type RectCornerValue = ValueOf<typeof RectCorner>;
 declare function createRect(x?: number, y?: number, width?: number, height?: number): Rect;
 declare function cloneRect(rect: Rect): Rect;
 declare function getRectMaxX(rect: Rect): number;
@@ -43,13 +46,13 @@ declare function getRectTopLeft(rect: Rect): Point;
 declare function getRectTopRight(rect: Rect): Point;
 declare function getRectBottomLeft(rect: Rect): Point;
 declare function getRectBottomRight(rect: Rect): Point;
-declare function getRectPointByRectCorner(rect: Rect, corner: RectCorner): Point;
+declare function getRectPointByRectCorner(rect: Rect, corner: RectCornerValue): Point;
 declare function checkRectIntersectsX(a: Rect, b: Rect): boolean;
 declare function checkRectIntersectsY(a: Rect, b: Rect): boolean;
 declare function checkRectIntersects(a: Rect, b: Rect): boolean;
 declare function checkRectContains(a: Rect, b: Rect): boolean;
 declare function checkRectContainsPoint(a: Rect, p: Point): boolean;
-declare function getRectCornerInOther(a: Rect, b: Rect): RectCorner | null;
+declare function getRectCornerInOther(a: Rect, b: Rect): RectCornerValue | null;
 declare function checkRectEqual(a: Rect, b: Rect): boolean;
 declare function checkRectEqualPoint(r: Rect, p: Point | Rect): boolean;
 declare function checkRectEqualSize(r: Rect, s: Size | Rect): boolean;
@@ -57,4 +60,6 @@ declare function checkLayoutInvalidate(newRect: Rect, oldRect: Rect): boolean;
 declare function toSize(rect: Rect): Size;
 declare function toPoint(rect: Rect): Point;
 
-export { Point, Previous, Rect, RectCorner, Size, checkLayoutInvalidate, checkPointEqual, checkPointOrigin, checkRectContains, checkRectContainsPoint, checkRectEqual, checkRectEqualPoint, checkRectEqualSize, checkRectIntersects, checkRectIntersectsX, checkRectIntersectsY, checkSizeEqual, cloneRect, createPoint, createRect, createSize, execLastTick, getRectArea, getRectBottomLeft, getRectBottomRight, getRectCornerInOther, getRectMaxX, getRectMaxY, getRectPointByRectCorner, getRectTopLeft, getRectTopRight, noop, toPoint, toSize, usePrevious };
+declare function isObject(val: unknown): val is Record<PropertyKey, any>;
+
+export { type Point, type Previous, type Rect, RectCorner, type RectCornerValue, type Size, checkLayoutInvalidate, checkPointEqual, checkPointOrigin, checkRectContains, checkRectContainsPoint, checkRectEqual, checkRectEqualPoint, checkRectEqualSize, checkRectIntersects, checkRectIntersectsX, checkRectIntersectsY, checkSizeEqual, cloneRect, createPoint, createRect, createSize, execLastTick, getRectArea, getRectBottomLeft, getRectBottomRight, getRectCornerInOther, getRectMaxX, getRectMaxY, getRectPointByRectCorner, getRectTopLeft, getRectTopRight, isObject, noop, toPoint, toSize, usePrevious };

package/dist/index.mjs

@@ -52,13 +52,12 @@ function checkSizeEqual(a, b) {
   return a.width === b.width && a.height === b.height;
 }
 
-var RectCorner = /* @__PURE__ */ ((RectCorner2) => {
-  RectCorner2["TopLeft"] = "TopLeft";
-  RectCorner2["TopRight"] = "TopRight";
-  RectCorner2["BottomLeft"] = "BottomLeft";
-  RectCorner2["BottomRight"] = "BottomRight";
-  return RectCorner2;
-})(RectCorner || {});
+const RectCorner = {
+  TopLeft: "TopLeft",
+  TopRight: "TopRight",
+  BottomLeft: "BottomLeft",
+  BottomRight: "BottomRight"
+};
 function createRect(x = 0, y = 0, width = 0, height = 0) {
   return {
     ...createPoint(x, y),
@@ -91,13 +90,13 @@ function getRectBottomRight(rect) {
 }
 function getRectPointByRectCorner(rect, corner) {
   switch (corner) {
-    case "TopLeft" /* TopLeft */:
+    case RectCorner.TopLeft:
       return getRectTopLeft(rect);
-    case "TopRight" /* TopRight */:
+    case RectCorner.TopRight:
       return getRectTopRight(rect);
-    case "BottomLeft" /* BottomLeft */:
+    case RectCorner.BottomLeft:
       return getRectBottomLeft(rect);
-    case "BottomRight" /* BottomRight */:
+    case RectCorner.BottomRight:
       return getRectBottomRight(rect);
     default:
       throw new TypeError(`Not match corner: ${corner}`);
@@ -145,4 +144,8 @@ function toPoint(rect) {
   return createPoint(rect.x, rect.y);
 }
 
-export { RectCorner, checkLayoutInvalidate, checkPointEqual, checkPointOrigin, checkRectContains, checkRectContainsPoint, checkRectEqual, checkRectEqualPoint, checkRectEqualSize, checkRectIntersects, checkRectIntersectsX, checkRectIntersectsY, checkSizeEqual, cloneRect, createPoint, createRect, createSize, execLastTick, getRectArea, getRectBottomLeft, getRectBottomRight, getRectCornerInOther, getRectMaxX, getRectMaxY, getRectPointByRectCorner, getRectTopLeft, getRectTopRight, noop, toPoint, toSize, usePrevious };
+function isObject(val) {
+  return Object.prototype.toString.call(val) === "[object Object]";
+}
+
+export { RectCorner, checkLayoutInvalidate, checkPointEqual, checkPointOrigin, checkRectContains, checkRectContainsPoint, checkRectEqual, checkRectEqualPoint, checkRectEqualSize, checkRectIntersects, checkRectIntersectsX, checkRectIntersectsY, checkSizeEqual, cloneRect, createPoint, createRect, createSize, execLastTick, getRectArea, getRectBottomLeft, getRectBottomRight, getRectCornerInOther, getRectMaxX, getRectMaxY, getRectPointByRectCorner, getRectTopLeft, getRectTopRight, isObject, noop, toPoint, toSize, usePrevious };

package/package.json

@@ -1,15 +1,23 @@
 {
   "name": "@bouzu/shared",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "private": false,
   "author": "zhong666 <hi@zhong666.me>",
   "license": "MIT",
+  "homepage": "https://bouzu.zhong666.me",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/aa900031/bouzu"
+  },
+  "bugs": {
+    "url": "https://github.com/aa900031/bouzu/issues"
+  },
   "sideEffects": false,
   "exports": {
     ".": {
       "types": "./dist/index.d.ts",
-      "require": "./dist/index.cjs",
-      "import": "./dist/index.mjs"
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.cjs"
     }
   },
   "main": "./dist/index.cjs",
@@ -21,7 +29,15 @@
   "publishConfig": {
     "access": "public"
   },
+  "dependencies": {
+    "type-fest": "^3.13.1"
+  },
+  "devDependencies": {
+    "@bouzu/release-it-config": "0.1.0",
+    "@bouzu/tsconfig": "0.1.0"
+  },
   "scripts": {
-    "build": "unbuild"
+    "build": "unbuild",
+    "release": "release-it --ci"
   }
 }