@availity/hooks 3.1.1 → 3.2.1

package/CHANGELOG.md

@@ -1,7 +1,35 @@
-# Change Log
+# Changelog
+
+This file was generated using [@jscutlery/semver](https://github.com/jscutlery/semver).
+
+## [3.2.1](https://github.com/Availity/availity-react/compare/@availity/hooks@3.2.0...@availity/hooks@3.2.1) (2022-05-24)
+
+
+### Bug Fixes
+
+* upgrade yup and update sb stories ([68aeafe](https://github.com/Availity/availity-react/commit/68aeafe4fd7d90d7c88dbb24636ba7770fe87aa3))
+
+
+
+# 3.2.0 (2022-02-18)
+
+
+### Features
+
+* **hooks:** add documentation to sidebar, some formatting ([fbd9964](https://github.com/Availity/availity-react/commit/fbd99648c18993394f773d8540c1be023acf6e5b))
+* **hooks:** add useWindowDimensionsHook ([203d9c0](https://github.com/Availity/availity-react/commit/203d9c0a31362ec084c94c4ae50ab4b6efbc876b))
+
+
+
+
+
+## [3.1.2](https://github.com/Availity/availity-react/compare/@availity/hooks@3.1.1...@availity/hooks@3.1.2) (2021-12-20)
+
+**Note:** Version bump only for package @availity/hooks
+
+
+
 
-All notable changes to this project will be documented in this file.
-See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
 ## 3.1.1 (2021-12-14)
 

package/README.md

@@ -3,5 +3,23 @@
 > Re-usable hooks for components and apps.
 
 [![Version](https://img.shields.io/npm/v/@availity/hooks.svg?style=for-the-badge)](https://www.npmjs.com/package/@availity/hooks)
+[![NPM Downloads](https://img.shields.io/npm/dt/@availity/hooks.svg?style=for-the-badge)](https://www.npmjs.com/package/@availity/hooks)
+[![Dependecy Status](https://img.shields.io/librariesio/release/npm/@availity/hooks?style=for-the-badge)](https://github.com/Availity/availity-react/blob/master/packages/hooks/package.json)
 
-## [Documentation](https://availity.github.io/availity-react/components/hooks/index)
+## Installation
+
+### NPM
+
+```bash
+npm install @availity/hooks
+```
+
+### Yarn
+
+```bash
+yarn add @availity/hooks
+```
+
+## Documentation
+
+Check out more documentation at [availity.github.io](https://availity.github.io/availity-react/components/hooks/index)

package/index.d.ts

@@ -7,3 +7,4 @@ export { default as useCurrentUser } from './types/useCurrentUser';
 export { default as useProviders } from './types/useProviders';
 export { default as usePermissions } from './types/usePermissions';
 export { default as useOrganizations } from './types/useOrganizations';
+export { default as useWindowDimensions } from './types/useWindowDimensions';

package/index.js

@@ -7,3 +7,4 @@ export { default as useCurrentUser } from './src/useCurrentUser';
 export { default as useProviders } from './src/useProviders';
 export { default as usePermissions } from './src/usePermissions';
 export { default as useOrganizations } from './src/useOrganizations';
+export { default as useWindowDimensions } from './src/useWindowDimensions';

package/jest.config.js

@@ -0,0 +1,7 @@
+const global = require('../../jest/global-config');
+
+module.exports = {
+  ...global,
+  displayName: 'hooks',
+  coverageDirectory: '../../coverage/hooks',
+};

package/package.json

@@ -1,29 +1,36 @@
 {
   "name": "@availity/hooks",
-  "version": "3.1.1",
+  "version": "3.2.1",
   "description": "A group of pre-built hooks that are common in most apps",
   "keywords": [
     "react",
-    "availity"
+    "availity",
+    "hooks"
   ],
+  "homepage": "https://availity.github.io/availity-react/components/hooks/index",
   "bugs": {
     "url": "https://github.com/Availity/availity-react/issues"
   },
   "repository": {
     "type": "git",
-    "url": "https://github.com/Availity/availity-react.git"
+    "url": "https://github.com/Availity/availity-react.git",
+    "directory": "packages/hooks"
   },
   "license": "MIT",
   "author": "Kyle Gray <kyle.gray@availity.com>",
   "main": "index.js",
   "types": "index.d.ts",
+  "scripts": {
+    "publish": "yarn npm publish --tolerate-republish --access public",
+    "publish:canary": "yarn npm publish --access public --tag canary"
+  },
   "dependencies": {
-    "prop-types": "^15.7.2",
-    "react-query": "^3.29.0"
+    "prop-types": "^15.8.1",
+    "react-query": "^3.39.0"
   },
   "devDependencies": {
-    "@availity/api-axios": "^6.0.0",
-    "axios": "^0.21.1",
+    "@availity/api-axios": "^7.0.1",
+    "axios": "^0.21.4",
     "react": "^17.0.2",
     "react-dom": "^17.0.2"
   },
@@ -34,6 +41,5 @@
   },
   "publishConfig": {
     "access": "public"
-  },
-  "gitHead": "9c6598bc46384f57279e6998de4a4a85fac04b27"
-}
+  }
+}

package/project.json

@@ -0,0 +1,36 @@
+{
+  "root": "packages/hooks",
+  "projectType": "library",
+  "targets": {
+    "test": {
+      "executor": "@nrwl/jest:jest",
+      "outputs": ["coverage/hooks"],
+      "options": { "jestConfig": "packages/hooks/jest.config.js", "passWithNoTests": true }
+    },
+    "version": {
+      "executor": "@jscutlery/semver:version",
+      "options": {
+        "preset": "angular",
+        "commitMessageFormat": "chore(${projectName}): release version ${version} [skip ci]",
+        "tagPrefix": "@availity/${projectName}@",
+        "baseBranch": "master"
+      }
+    },
+    "lint": {
+      "executor": "@nrwl/linter:eslint",
+      "options": {
+        "eslintConfig": ".eslintrc.yaml",
+        "lintFilePatterns": ["packages/hooks/**/*.{js,ts}"],
+        "silent": false,
+        "fix": false,
+        "cache": true,
+        "cacheLocation": "./node_modules/.cache/hooks/.eslintcache",
+        "maxWarnings": -1,
+        "quiet": false,
+        "noEslintrc": false,
+        "hasTypeAwareRules": true,
+        "cacheStrategy": "metadata"
+      }
+    }
+  }
+}

package/src/useWindowDimensions.js

@@ -0,0 +1,26 @@
+import { useEffect, useState } from 'react';
+
+const getWindowDimensions = () => {
+  const { innerWidth: width, innerHeight: height } = window;
+  return {
+    width,
+    height,
+  };
+};
+
+const useWindowDimensions = () => {
+  const [windowDimensions, setWindowDimensions] = useState(getWindowDimensions());
+
+  useEffect(() => {
+    const handleResize = () => {
+      setWindowDimensions(getWindowDimensions());
+    };
+
+    window.addEventListener('resize', handleResize);
+    return () => window.removeEventListener('resize', handleResize);
+  }, []);
+
+  return windowDimensions;
+};
+
+export default useWindowDimensions;

package/tsconfig.json

@@ -0,0 +1,5 @@
+{
+  "extends": "../../tsconfig.json",
+  "include": ["."],
+  "exclude": ["dist", "build", "node_modules"]
+}

package/tsconfig.spec.json

@@ -0,0 +1,10 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "outDir": "../../dist/out-tsc",
+    "module": "commonjs",
+    "types": ["jest", "node", "@testing-library/jest-dom"],
+    "allowJs": true
+  },
+  "include": ["**/*.test.js", "**/*.test.ts", "**/*.test.tsx", "**/*.d.ts"]
+}

package/types/useToggle.d.ts

@@ -1,3 +1,3 @@
-declare const useToggle: Function;
+declare const useToggle: (initialValue?: boolean) => [isToggled: boolean, toggle: (state?: boolean) => void];
 
 export default useToggle;

package/types/useWindowDimensions.d.ts

@@ -0,0 +1,8 @@
+export type Dimensions = {
+  width: number;
+  height: number;
+};
+
+declare function useWindowDimensions(): Dimensions;
+
+export default useWindowDimensions;

package/LICENSE

@@ -1,20 +0,0 @@
-Copyright (c) 2017-present Availity, LLC
-
-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.