3.1.0 (#98)

* feat: add useWordPress hook

* refactor: clean up

* chore: update

* docs: update example

* docs: update urls

* docs: update example

* docs: update example

* docs: update example

* chore: v3.1.0

Author: JB1905

CHANGELOG.md

@@ -1,5 +1,11 @@
 # react-wordpress-hooks Changelog
 
+## 3.1.0 (2020-06-01)
+
+#### New Feature
+
+- added `useWordPress` hook
+
 ## 3.0.2 (2020-04-19)
 
 #### Repository Changes

docs/block-revisions.md

@@ -8,7 +8,7 @@ menu: Hooks
 
 ### useRetrieveBlockRevisions
 
-[Available options](https://developer.wordpress.org/rest-api/reference/wp_block-revisions/#retrieve-a-wp_block-revision)
+[Available options](https://developer.wordpress.org/rest-api/reference/block-revisions/#retrieve-a-wp_block-revision)
 
 ```jsx
 const { data, loading, error } = useRetrieveBlockRevisions(
@@ -19,7 +19,7 @@ const { data, loading, error } = useRetrieveBlockRevisions(
 
 ### useCreateBlockRevisions
 
-[Available options](https://developer.wordpress.org/rest-api/reference/wp_block-revisions/#create-a-wp_block-revision)
+[Available options](https://developer.wordpress.org/rest-api/reference/block-revisions/#create-a-wp_block-revision)
 
 ```jsx
 const { data, loading, error } = useCreateBlockRevisions(
@@ -30,7 +30,7 @@ const { data, loading, error } = useCreateBlockRevisions(
 
 ### useRetrieveBlockRevision
 
-[Available options](https://developer.wordpress.org/rest-api/reference/wp_block-revisions/#retrieve-a-wp_block-revision-2)
+[Available options](https://developer.wordpress.org/rest-api/reference/block-revisions/#retrieve-a-wp_block-revision-2)
 
 ```jsx
 const { data, loading, error } = useRetrieveBlockRevision(

docs/blocks.md

@@ -7,7 +7,7 @@ menu: Hooks
 
 ### useBlocks
 
-[Available options](https://developer.wordpress.org/rest-api/reference/wp_blocks/#list-wp_blocks)
+[Available options](https://developer.wordpress.org/rest-api/reference/blocks/#list-wp_blocks)
 
 Default query (latest 10 blocks):
 
@@ -37,7 +37,7 @@ const { data, loading, error } = useComments(/* array of block ids */);
 
 ### useCreateBlock
 
-[Available options](https://developer.wordpress.org/rest-api/reference/wp_blocks/#create-a-wp_block)
+[Available options](https://developer.wordpress.org/rest-api/reference/blocks/#create-a-wp_block)
 
 ```jsx
 const { data, loading, error } = useCreateBlock({
@@ -47,7 +47,7 @@ const { data, loading, error } = useCreateBlock({
 
 ### useRetrieveBlock
 
-[Available options](https://developer.wordpress.org/rest-api/reference/wp_blocks/#retrieve-a-wp_block)
+[Available options](https://developer.wordpress.org/rest-api/reference/blocks/#retrieve-a-wp_block)
 
 ```jsx
 const { data, loading, error } = useRetrieveBlock({
@@ -57,7 +57,7 @@ const { data, loading, error } = useRetrieveBlock({
 
 ### useUpdateBlock
 
-[Available options](https://developer.wordpress.org/rest-api/reference/wp_blocks/#update-a-wp_block)
+[Available options](https://developer.wordpress.org/rest-api/reference/blocks/#update-a-wp_block)
 
 ```jsx
 const { data, loading, error } = useUpdateBlock({
@@ -67,7 +67,7 @@ const { data, loading, error } = useUpdateBlock({
 
 ### useDeleteBlock
 
-[Available options](https://developer.wordpress.org/rest-api/reference/wp_blocks/#delete-a-wp_block)
+[Available options](https://developer.wordpress.org/rest-api/reference/blocks/#delete-a-wp_block)
 
 ```jsx
 const { data, loading, error } = useDeleteBlock(

docs/wordpress.md

@@ -0,0 +1,20 @@
+---
+route: /hooks/wordpress
+menu: Hooks
+---
+
+## Custom Endpoints
+
+### useWordPress
+
+This hook allows you to use custom endpoints or create manual requests to WordPress REST API
+
+[Read more about custom enpoints](https://developer.wordpress.org/rest-api/extending-the-rest-api/adding-custom-endpoints/)
+
+```jsx
+const { data, loading, error } = useWordPress({
+  // endpoint (e.g.: slides)
+  // options (request option params)
+  // requsetMethod: (e.g.: GET, POST)
+});
+```

package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-wordpress-hooks",
-  "version": "3.0.2",
+  "version": "3.1.0",
   "description": "Set of hooks for WordPress REST API",
   "author": "Jakub Biesiada",
   "license": "MIT",
@@ -36,16 +36,16 @@
   "devDependencies": {
     "@rollup/plugin-node-resolve": "^8.0.0",
     "@types/react": "^16.9.35",
-    "@typescript-eslint/parser": "^3.0.0",
+    "@typescript-eslint/parser": "^3.1.0",
     "docz": "^2.3.1",
     "eslint": "^7.1.0",
     "eslint-config-prettier": "^6.11.0",
     "eslint-plugin-prettier": "^3.1.3",
     "eslint-plugin-react": "^7.20.0",
-    "eslint-plugin-react-hooks": "^4.0.2",
-    "gh-pages": "^2.2.0",
+    "eslint-plugin-react-hooks": "^4.0.4",
+    "gh-pages": "^3.0.0",
     "husky": "^4.2.5",
-    "lint-staged": "^10.2.6",
+    "lint-staged": "^10.2.7",
     "prettier": "^2.0.5",
     "react": "^16.13.1",
     "react-dom": "^16.13.1",

src/hooks/useApiRequest.ts

@@ -79,6 +79,7 @@ export const useApiRequest = ({
         }
       } catch (err) {
         setLoading(false);
+
         setError(err);
       }
     }

src/hooks/useWordPress.ts

@@ -0,0 +1,21 @@
+import { useApiRequest } from './useApiRequest';
+
+type UseWordPress = {
+  readonly endpoint: string;
+  readonly options?: number | object;
+  readonly requsetMethod?: string;
+};
+
+export const useWordPress = ({
+  endpoint,
+  options,
+  requsetMethod,
+}: UseWordPress) => {
+  const { data, loading, error } = useApiRequest({
+    endpoint,
+    options,
+    requsetMethod,
+  });
+
+  return { data, loading, error };
+};

src/index.ts

@@ -17,4 +17,6 @@ export * from './hooks/useSettings';
 export * from './hooks/useThemes';
 export * from './hooks/useSearch';
 
+export * from './hooks/useWordPress';
+
 export { WordPressProvider } from './context';

yarn.lock

@@ -1483,13 +1483,13 @@
     eslint-scope "^5.0.0"
     eslint-utils "^2.0.0"
 
-"@typescript-eslint/experimental-utils@3.0.0":
-  version "3.0.0"
-  resolved "https://registry.yarnpkg.com/@typescript-eslint/experimental-utils/-/experimental-utils-3.0.0.tgz#1ddf53eeb61ac8eaa9a77072722790ac4f641c03"
-  integrity sha512-BN0vmr9N79M9s2ctITtChRuP1+Dls0x/wlg0RXW1yQ7WJKPurg6X3Xirv61J2sjPif4F8SLsFMs5Nzte0WYoTQ==
+"@typescript-eslint/experimental-utils@3.1.0":
+  version "3.1.0"
+  resolved "https://registry.yarnpkg.com/@typescript-eslint/experimental-utils/-/experimental-utils-3.1.0.tgz#2d5dba7c2ac2a3da3bfa3f461ff64de38587a872"
+  integrity sha512-Zf8JVC2K1svqPIk1CB/ehCiWPaERJBBokbMfNTNRczCbQSlQXaXtO/7OfYz9wZaecNvdSvVADt6/XQuIxhC79w==
   dependencies:
     "@types/json-schema" "^7.0.3"
-    "@typescript-eslint/typescript-estree" "3.0.0"
+    "@typescript-eslint/typescript-estree" "3.1.0"
     eslint-scope "^5.0.0"
     eslint-utils "^2.0.0"
 
@@ -1503,14 +1503,14 @@
     "@typescript-eslint/typescript-estree" "2.27.0"
     eslint-visitor-keys "^1.1.0"
 
-"@typescript-eslint/parser@^3.0.0":
-  version "3.0.0"
-  resolved "https://registry.yarnpkg.com/@typescript-eslint/parser/-/parser-3.0.0.tgz#fe9fdf18a1155c02c04220c14506a320cb6c6944"
-  integrity sha512-8RRCA9KLxoFNO0mQlrLZA0reGPd/MsobxZS/yPFj+0/XgMdS8+mO8mF3BDj2ZYQj03rkayhSJtF1HAohQ3iylw==
+"@typescript-eslint/parser@^3.1.0":
+  version "3.1.0"
+  resolved "https://registry.yarnpkg.com/@typescript-eslint/parser/-/parser-3.1.0.tgz#9c02ba5d88ad2355672f39e6cd4176f172dd47f8"
+  integrity sha512-NcDSJK8qTA2tPfyGiPes9HtVKLbksmuYjlgGAUs7Ld2K0swdWibnCq9IJx9kJN8JJdgUJSorFiGaPHBgH81F/Q==
   dependencies:
     "@types/eslint-visitor-keys" "^1.0.0"
-    "@typescript-eslint/experimental-utils" "3.0.0"
-    "@typescript-eslint/typescript-estree" "3.0.0"
+    "@typescript-eslint/experimental-utils" "3.1.0"
+    "@typescript-eslint/typescript-estree" "3.1.0"
     eslint-visitor-keys "^1.1.0"
 
 "@typescript-eslint/[email protected]":
@@ -1526,10 +1526,10 @@
     semver "^6.3.0"
     tsutils "^3.17.1"
 
-"@typescript-eslint/typescript-estree@3.0.0":
-  version "3.0.0"
-  resolved "https://registry.yarnpkg.com/@typescript-eslint/typescript-estree/-/typescript-estree-3.0.0.tgz#fa40e1b76ccff880130be054d9c398e96004bf42"
-  integrity sha512-nevQvHyNghsfLrrByzVIH4ZG3NROgJ8LZlfh3ddwPPH4CH7W4GAiSx5qu+xHuX5pWsq6q/eqMc1io840ZhAnUg==
+"@typescript-eslint/typescript-estree@3.1.0":
+  version "3.1.0"
+  resolved "https://registry.yarnpkg.com/@typescript-eslint/typescript-estree/-/typescript-estree-3.1.0.tgz#eaff52d31e615e05b894f8b9d2c3d8af152a5dd2"
+  integrity sha512-+4nfYauqeQvK55PgFrmBWFVYb6IskLyOosYEmhH3mSVhfBp9AIJnjExdgDmKWoOBHRcPM8Ihfm2BFpZf0euUZQ==
   dependencies:
     debug "^4.1.1"
     eslint-visitor-keys "^1.1.0"
@@ -4788,10 +4788,10 @@ eslint-plugin-react-hooks@^1.7.0:
   resolved "https://registry.yarnpkg.com/eslint-plugin-react-hooks/-/eslint-plugin-react-hooks-1.7.0.tgz#6210b6d5a37205f0b92858f895a4e827020a7d04"
   integrity sha512-iXTCFcOmlWvw4+TOE8CLWj6yX1GwzT0Y6cUfHHZqWnSk144VmVIRcVGtUAzrLES7C798lmvnt02C7rxaOX1HNA==
 
-eslint-plugin-react-hooks@^4.0.2:
-  version "4.0.2"
-  resolved "https://registry.yarnpkg.com/eslint-plugin-react-hooks/-/eslint-plugin-react-hooks-4.0.2.tgz#03700ca761eacc1b6436074c456f90a8e331ff28"
-  integrity sha512-kAMRjNztrLW1rK+81X1NwMB2LqG+nc7Q8AibnG8/VyWhQK8SP6JotCFG+HL4u1EjziplxVz4jARdR8gGk8pLDA==
+eslint-plugin-react-hooks@^4.0.4:
+  version "4.0.4"
+  resolved "https://registry.yarnpkg.com/eslint-plugin-react-hooks/-/eslint-plugin-react-hooks-4.0.4.tgz#aed33b4254a41b045818cacb047b81e6df27fa58"
+  integrity sha512-equAdEIsUETLFNCmmCkiCGq6rkSK5MoJhXFPFYeUebcjKgBmWWcgVOqZyQC8Bv1BwVCnTq9tBxgJFgAJTWoJtA==
 
 eslint-plugin-react@^7.19.0:
   version "7.19.0"
@@ -6194,10 +6194,10 @@ getpass@^0.1.1:
   dependencies:
     assert-plus "^1.0.0"
 
-gh-pages@^2.2.0:
-  version "2.2.0"
-  resolved "https://registry.yarnpkg.com/gh-pages/-/gh-pages-2.2.0.tgz#74ebeaca8d2b9a11279dcbd4a39ddfff3e6caa24"
-  integrity sha512-c+yPkNOPMFGNisYg9r4qvsMIjVYikJv7ImFOhPIVPt0+AcRUamZ7zkGRLHz7FKB0xrlZ+ddSOJsZv9XAFVXLmA==
+gh-pages@^3.0.0:
+  version "3.0.0"
+  resolved "https://registry.yarnpkg.com/gh-pages/-/gh-pages-3.0.0.tgz#65f3ccd424bfbc7906f31c4bdb524a1147fa8da2"
+  integrity sha512-oaOfVcrSwnqoWUgZ6cmCDM6mUuWyOSG+SHjqxGBawN0F3SKaF5NwbeYDG+w2RNXO2HJ/5Iam4o7dP5NAtoHuwQ==
   dependencies:
     async "^2.6.1"
     commander "^2.18.0"
@@ -8020,10 +8020,10 @@ lines-and-columns@^1.1.6:
   resolved "https://registry.yarnpkg.com/lines-and-columns/-/lines-and-columns-1.1.6.tgz#1c00c743b433cd0a4e80758f7b64a57440d9ff00"
   integrity sha1-HADHQ7QzzQpOgHWPe2SldEDZ/wA=
 
-lint-staged@^10.2.6:
-  version "10.2.6"
-  resolved "https://registry.yarnpkg.com/lint-staged/-/lint-staged-10.2.6.tgz#7d9658bd89dee946a859cbfc6e09566a9fb50b53"
-  integrity sha512-2oEBWyPZHkdyjKcIv2U6ay80Q52ZMlZZrUnfsV0WTVcgzPlt3o2t5UFy2v8ETUTsIDZ0xSJVnffWCgD3LF6xTQ==
+lint-staged@^10.2.7:
+  version "10.2.7"
+  resolved "https://registry.yarnpkg.com/lint-staged/-/lint-staged-10.2.7.tgz#6e47860af3d86a6a01849cbf8ba80f7754aae6eb"
+  integrity sha512-srod2bTpF8riaLz+Bgr6v0mI/nSntE8M9jbh4WwAhoosx0G7RKEUIG7mI5Nu5SMbTF9o8GROPgK0Lhf5cDnUUw==
   dependencies:
     chalk "^4.0.0"
     cli-truncate "2.1.0"