1
0
mirror of synced 2026-02-04 12:08:33 -05:00

Compare commits

...

3 Commits

Author SHA1 Message Date
beerose
b905270875 Update pnpm-lock.yaml 2022-06-23 12:56:21 +02:00
github-actions[bot]
96ea5291e4 Version Packages (alpha) (#3454)
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
2022-06-23 12:54:23 +02:00
Aleksandra
9c2e7d372c Import useRouter form next/router in useParams.tsx (#3453) 2022-06-23 12:47:01 +02:00
21 changed files with 176 additions and 128 deletions

View File

@@ -0,0 +1,5 @@
---
"@blitzjs/next": patch
---
Use `useRouter` from next/router in useParams function

View File

@@ -27,6 +27,7 @@
"dirty-monkeys-greet",
"eleven-humans-sort",
"empty-berries-rule",
"empty-turkeys-wave",
"fair-wombats-sneeze",
"famous-kings-explain",
"fast-trainers-kneel",

View File

@@ -29,7 +29,7 @@
"@blitzjs/rpc": "workspace:*",
"@hookform/resolvers": "2.8.8",
"@prisma/client": "3.9.0",
"blitz": "workspace:2.0.0-alpha.41",
"blitz": "workspace:2.0.0-alpha.42",
"next": "12.1.6-canary.17",
"prisma": "3.9.0",
"react": "18.0.0",

View File

@@ -1,5 +1,11 @@
# @blitzjs/auth
## 2.0.0-alpha.42
### Patch Changes
- blitz@2.0.0-alpha.42
## 2.0.0-alpha.41
### Patch Changes

View File

@@ -1,6 +1,6 @@
{
"name": "@blitzjs/auth",
"version": "2.0.0-alpha.41",
"version": "2.0.0-alpha.42",
"scripts": {
"build": "unbuild",
"predev": "wait-on -d 250 ../blitz/dist/index-server.d.ts",
@@ -26,7 +26,7 @@
"@types/secure-password": "3.1.1",
"b64-lite": "1.4.0",
"bad-behavior": "1.0.1",
"blitz": "2.0.0-alpha.41",
"blitz": "2.0.0-alpha.42",
"cookie": "0.4.1",
"cookie-session": "2.0.0",
"debug": "4.3.3",
@@ -39,7 +39,7 @@
"url": "0.11.0"
},
"devDependencies": {
"@blitzjs/config": "workspace:2.0.0-alpha.41",
"@blitzjs/config": "workspace:2.0.0-alpha.42",
"@testing-library/react": "13.0.0",
"@testing-library/react-hooks": "7.0.2",
"@types/cookie": "0.4.1",

View File

@@ -1,5 +1,12 @@
# @blitzjs/next
## 2.0.0-alpha.42
### Patch Changes
- 9c2e7d37: Use `useRouter` from next/router in useParams function
- @blitzjs/rpc@2.0.0-alpha.42
## 2.0.0-alpha.41
### Patch Changes

View File

@@ -1,6 +1,6 @@
{
"name": "@blitzjs/next",
"version": "2.0.0-alpha.41",
"version": "2.0.0-alpha.42",
"scripts": {
"build": "unbuild",
"dev": "pnpm predev && pnpm watch unbuild src --wait=0.2",
@@ -23,7 +23,7 @@
"eslint.js"
],
"dependencies": {
"@blitzjs/rpc": "2.0.0-alpha.41",
"@blitzjs/rpc": "2.0.0-alpha.42",
"@types/hoist-non-react-statics": "3.3.1",
"debug": "4.3.3",
"fs-extra": "10.0.1",
@@ -32,7 +32,7 @@
"superjson": "1.8.0"
},
"devDependencies": {
"@blitzjs/config": "workspace:2.0.0-alpha.41",
"@blitzjs/config": "workspace:2.0.0-alpha.42",
"@testing-library/dom": "8.13.0",
"@testing-library/jest-dom": "5.16.3",
"@testing-library/react": "13.0.0",
@@ -42,7 +42,7 @@
"@types/react": "18.0.1",
"@types/react-dom": "17.0.14",
"@types/testing-library__react-hooks": "4.0.0",
"blitz": "2.0.0-alpha.41",
"blitz": "2.0.0-alpha.42",
"cross-spawn": "7.0.3",
"find-up": "4.1.0",
"next": "12.1.6-canary.17",

View File

@@ -1,9 +1,8 @@
/**
* @vitest-environment jsdom
*/
import React from "react"
import {describe, it, expect, vi} from "vitest"
import {describe, it, expect, vi, afterEach} from "vitest"
import {extractRouterParams, useParam, useParams} from "./use-params"
import {renderHook as defaultRenderHook} from "@testing-library/react-hooks"
import {NextRouter} from "next/router"
@@ -16,6 +15,14 @@ type RenderHookOptions = DefaultHookParams[1] & {
dehydratedState?: unknown
}
// This is the router query object which includes route params
const query = {
id: "1",
cat: "category",
slug: ["example", "multiple", "slugs"],
empty: "",
}
const mockRouter: NextRouter = {
basePath: "",
pathname: "/",
@@ -54,6 +61,10 @@ export function renderHook(
}
describe("extractRouterParams", () => {
afterEach(() => {
vi.clearAllMocks()
})
it("returns proper params", () => {
const routerQuery = {
id: "1",
@@ -81,92 +92,99 @@ describe("extractRouterParams", () => {
})
describe("useParams", () => {
afterEach(() => {
vi.clearAllMocks()
})
it("works without parameter", () => {
// This is the router query object which includes route params
const query = {
id: "1",
cat: "category",
slug: ["example", "multiple", "slugs"],
empty: "",
}
const {result} = renderHook(() => useParams(), {router: {query}})
expect(result.current).toEqual({
id: "1",
cat: "category",
slug: ["example", "multiple", "slugs"],
empty: "",
vi.mock("next/router", () => {
return {
useRouter: vi.fn(() => ({...mockRouter, query})),
}
})
})
it("works with string", () => {
// This is the router query object which includes route params
const query = {
id: "1",
cat: "category",
slug: ["example", "multiple", "slugs"],
empty: "",
}
it("works with string", () => {
vi.mock("next/router", () => {
return {
useRouter: vi.fn(() => ({...mockRouter, query})),
}
})
const {result} = renderHook(() => useParams("string"), {
router: {query},
const {result} = renderHook(() => useParams("string"), {
router: {query},
})
expect(result.current).toEqual({
id: "1",
cat: "category",
empty: "",
})
})
expect(result.current).toEqual({
id: "1",
cat: "category",
empty: "",
})
})
it("works with number", () => {
// This is the router query object which includes route params
const query = {
id: "1",
cat: "category",
slug: ["example", "multiple", "slugs"],
empty: "",
}
it("works with string", () => {
vi.mock("next/router", () => {
return {
useRouter: vi.fn(() => ({...mockRouter, query})),
}
})
const {result} = renderHook(() => useParams("number"), {
router: {query},
const {result} = renderHook(() => useParams("string"), {
router: {query},
})
expect(result.current).toEqual({
id: "1",
cat: "category",
empty: "",
})
})
expect(result.current).toEqual({
id: 1,
cat: undefined,
slug: undefined,
})
})
it("works with array", () => {
// This is the router query object which includes route params
const query = {
id: "1",
cat: "category",
slug: ["example", "multiple", "slugs"],
empty: "",
}
it("works with number", () => {
vi.mock("next/router", () => {
return {
useRouter: vi.fn(() => ({...mockRouter, query})),
}
})
const {result} = renderHook(() => useParams("array"), {
router: {query},
const {result} = renderHook(() => useParams("number"), {
router: {query},
})
expect(result.current).toEqual({
id: 1,
cat: undefined,
slug: undefined,
})
})
expect(result.current).toEqual({
id: ["1"],
cat: ["category"],
slug: ["example", "multiple", "slugs"],
empty: [""],
it("works with array", () => {
vi.mock("next/router", () => {
return {
useRouter: vi.fn(() => ({...mockRouter, query})),
}
})
const {result} = renderHook(() => useParams("array"), {
router: {query},
})
expect(result.current).toEqual({
id: ["1"],
cat: ["category"],
slug: ["example", "multiple", "slugs"],
empty: [""],
})
})
})
})
describe("useParam", () => {
afterEach(() => {
vi.clearAllMocks()
})
it("works without parameter", () => {
// This is the router query object which includes route params
const query = {
id: "1",
cat: "category",
slug: ["example", "multiple", "slugs"],
empty: "",
}
vi.mock("next/router", () => {
return {
useRouter: vi.fn(() => ({...mockRouter, query})),
}
})
let {result} = renderHook(() => useParam("id"), {router: {query}})
expect(result.current).toEqual("1")
@@ -183,13 +201,11 @@ describe("useParam", () => {
})
it("works with string", () => {
// This is the router query object which includes route params
const query = {
id: "1",
cat: "category",
slug: ["example", "multiple", "slugs"],
empty: "",
}
vi.mock("next/router", () => {
return {
useRouter: vi.fn(() => ({...mockRouter, query})),
}
})
let {result} = renderHook(() => useParam("id", "string"), {
router: {query},

View File

@@ -1,21 +1,10 @@
import {NextRouter} from "next/router"
import {useRouter} from "next/router"
import {ParsedUrlQuery} from "querystring"
import React from "react"
import {RouterContext} from "./router-context"
type Dict<T> = Record<string, T | undefined>
type ReturnTypes = "string" | "number" | "array"
/**
* `useRouter` is a React hook used to access `router` object within components
*
* @returns `router` object
* @see Docs {@link https://blitzjs.com/docs/router#router-object | router}
*/
export function useRouter(): NextRouter {
return React.useContext(RouterContext)
}
/*
* Based on the code of https://github.com/lukeed/qss
*/

View File

@@ -1,5 +1,12 @@
# @blitzjs/rpc
## 2.0.0-alpha.42
### Patch Changes
- @blitzjs/auth@2.0.0-alpha.42
- blitz@2.0.0-alpha.42
## 2.0.0-alpha.41
### Patch Changes

View File

@@ -1,6 +1,6 @@
{
"name": "@blitzjs/rpc",
"version": "2.0.0-alpha.41",
"version": "2.0.0-alpha.42",
"scripts": {
"build": "unbuild",
"predev": "wait-on -d 250 ../blitz/dist/index-server.d.ts && wait-on -d 250 ../blitz-auth/dist/index-browser.d.ts",
@@ -20,7 +20,7 @@
"dist/**"
],
"dependencies": {
"@blitzjs/auth": "2.0.0-alpha.41",
"@blitzjs/auth": "2.0.0-alpha.42",
"b64-lite": "1.4.0",
"bad-behavior": "1.0.1",
"chalk": "^4.1.0",
@@ -30,11 +30,11 @@
"zod": "3.10.1"
},
"devDependencies": {
"@blitzjs/config": "workspace:2.0.0-alpha.41",
"@blitzjs/config": "workspace:2.0.0-alpha.42",
"@types/debug": "4.1.7",
"@types/react": "18.0.1",
"@types/react-dom": "17.0.14",
"blitz": "2.0.0-alpha.41",
"blitz": "2.0.0-alpha.42",
"next": "12.1.6-canary.17",
"react": "18.0.0",
"react-dom": "18.0.0",
@@ -43,7 +43,7 @@
"watch": "1.0.2"
},
"peerDependencies": {
"blitz": "2.0.0-alpha.41",
"blitz": "2.0.0-alpha.42",
"next": "*"
},
"publishConfig": {

View File

@@ -1,5 +1,11 @@
# blitz
## 2.0.0-alpha.42
### Patch Changes
- @blitzjs/generator@2.0.0-alpha.42
## 2.0.0-alpha.41
### Patch Changes

View File

@@ -1,6 +1,6 @@
{
"name": "blitz",
"version": "2.0.0-alpha.41",
"version": "2.0.0-alpha.42",
"scripts": {
"build": "unbuild",
"dev": "watch unbuild src --wait=0.2",
@@ -23,7 +23,7 @@
"blitz": "bin/blitz"
},
"dependencies": {
"@blitzjs/generator": "2.0.0-alpha.41",
"@blitzjs/generator": "2.0.0-alpha.42",
"arg": "5.0.1",
"chalk": "^4.1.0",
"console-table-printer": "2.10.0",
@@ -52,7 +52,7 @@
"watchpack": "2.1.1"
},
"devDependencies": {
"@blitzjs/config": "workspace:2.0.0-alpha.41",
"@blitzjs/config": "workspace:2.0.0-alpha.42",
"@types/cookie": "0.4.1",
"@types/cross-spawn": "6.0.2",
"@types/debug": "4.1.7",

View File

@@ -1,5 +1,12 @@
# @blitzjs/codemod
## 2.0.0-alpha.42
### Patch Changes
- @blitzjs/generator@2.0.0-alpha.42
- blitz@2.0.0-alpha.42
## 2.0.0-alpha.41
### Patch Changes

View File

@@ -1,6 +1,6 @@
{
"name": "@blitzjs/codemod",
"version": "2.0.0-alpha.41",
"version": "2.0.0-alpha.42",
"scripts": {
"build": "unbuild",
"dev": "watch unbuild src --wait=0.2",
@@ -25,9 +25,9 @@
"@babel/plugin-proposal-class-properties": "7.17.12",
"@babel/plugin-syntax-jsx": "7.17.12",
"@babel/plugin-syntax-typescript": "7.17.12",
"@blitzjs/generator": "2.0.0-alpha.41",
"@blitzjs/generator": "2.0.0-alpha.42",
"arg": "5.0.1",
"blitz": "2.0.0-alpha.41",
"blitz": "2.0.0-alpha.42",
"chalk": "^4.1.0",
"cross-spawn": "7.0.3",
"debug": "4.3.3",

View File

@@ -1,5 +1,7 @@
# @blitzjs/config
## 2.0.0-alpha.42
## 2.0.0-alpha.41
## 2.0.0-alpha.40

View File

@@ -1,7 +1,7 @@
{
"name": "@blitzjs/config",
"private": true,
"version": "2.0.0-alpha.41",
"version": "2.0.0-alpha.42",
"license": "MIT",
"dependencies": {
"@typescript-eslint/eslint-plugin": "5.9.1",

View File

@@ -1,5 +1,7 @@
# @blitzjs/generator
## 2.0.0-alpha.42
## 2.0.0-alpha.41
## 2.0.0-alpha.40

View File

@@ -1,6 +1,6 @@
{
"name": "@blitzjs/generator",
"version": "2.0.0-alpha.41",
"version": "2.0.0-alpha.42",
"scripts": {
"dev": "watch unbuild src --wait=0.2",
"build": "unbuild && pnpm build:templates",
@@ -45,7 +45,7 @@
"vinyl": "2.2.1"
},
"devDependencies": {
"@blitzjs/config": "2.0.0-alpha.41",
"@blitzjs/config": "2.0.0-alpha.42",
"@juanm04/cpx": "2.0.1",
"@types/babel__core": "7.1.19",
"@types/diff": "5.0.2",

View File

@@ -25,7 +25,7 @@
"@typescript-eslint/parser": "5.9.1"
},
"devDependencies": {
"@blitzjs/config": "2.0.0-alpha.41",
"@blitzjs/config": "2.0.0-alpha.42",
"@types/react": "18.0.1",
"@types/react-dom": "17.0.14",
"react": "18.0.0",

30
pnpm-lock.yaml generated
View File

@@ -50,7 +50,7 @@ importers:
"@types/node": 17.0.16
"@types/preview-email": 2.0.1
"@types/react": 18.0.1
blitz: workspace:2.0.0-alpha.41
blitz: workspace:2.0.0-alpha.42
eslint: 7.32.0
husky: 7.0.4
jest: 27.5.1
@@ -432,8 +432,8 @@ importers:
packages/blitz:
specifiers:
"@blitzjs/config": workspace:2.0.0-alpha.41
"@blitzjs/generator": 2.0.0-alpha.41
"@blitzjs/config": workspace:2.0.0-alpha.42
"@blitzjs/generator": 2.0.0-alpha.42
"@types/cookie": 0.4.1
"@types/cross-spawn": 6.0.2
"@types/debug": 4.1.7
@@ -539,7 +539,7 @@ importers:
packages/blitz-auth:
specifiers:
"@blitzjs/config": workspace:2.0.0-alpha.41
"@blitzjs/config": workspace:2.0.0-alpha.42
"@testing-library/react": 13.0.0
"@testing-library/react-hooks": 7.0.2
"@types/b64-lite": 1.3.0
@@ -553,7 +553,7 @@ importers:
"@types/secure-password": 3.1.1
b64-lite: 1.4.0
bad-behavior: 1.0.1
blitz: 2.0.0-alpha.41
blitz: 2.0.0-alpha.42
cookie: 0.4.1
cookie-session: 2.0.0
debug: 4.3.3
@@ -604,8 +604,8 @@ importers:
packages/blitz-next:
specifiers:
"@blitzjs/config": workspace:2.0.0-alpha.41
"@blitzjs/rpc": 2.0.0-alpha.41
"@blitzjs/config": workspace:2.0.0-alpha.42
"@blitzjs/rpc": 2.0.0-alpha.42
"@testing-library/dom": 8.13.0
"@testing-library/jest-dom": 5.16.3
"@testing-library/react": 13.0.0
@@ -616,7 +616,7 @@ importers:
"@types/react": 18.0.1
"@types/react-dom": 17.0.14
"@types/testing-library__react-hooks": 4.0.0
blitz: 2.0.0-alpha.41
blitz: 2.0.0-alpha.42
cross-spawn: 7.0.3
debug: 4.3.3
find-up: 4.1.0
@@ -665,14 +665,14 @@ importers:
packages/blitz-rpc:
specifiers:
"@blitzjs/auth": 2.0.0-alpha.41
"@blitzjs/config": workspace:2.0.0-alpha.41
"@blitzjs/auth": 2.0.0-alpha.42
"@blitzjs/config": workspace:2.0.0-alpha.42
"@types/debug": 4.1.7
"@types/react": 18.0.1
"@types/react-dom": 17.0.14
b64-lite: 1.4.0
bad-behavior: 1.0.1
blitz: 2.0.0-alpha.41
blitz: 2.0.0-alpha.42
chalk: ^4.1.0
debug: 4.3.3
next: 12.1.6-canary.17
@@ -714,12 +714,12 @@ importers:
"@babel/plugin-syntax-typescript": 7.17.12
"@babel/preset-env": 7.12.10
"@blitzjs/config": workspace:*
"@blitzjs/generator": 2.0.0-alpha.41
"@blitzjs/generator": 2.0.0-alpha.42
"@types/jscodeshift": 0.11.2
"@types/node": 17.0.16
arg: 5.0.1
ast-types: 0.14.2
blitz: 2.0.0-alpha.41
blitz: 2.0.0-alpha.42
chalk: ^4.1.0
cross-spawn: 7.0.3
debug: 4.3.3
@@ -774,7 +774,7 @@ importers:
"@babel/plugin-transform-typescript": 7.12.1
"@babel/preset-env": 7.12.10
"@babel/types": 7.12.10
"@blitzjs/config": 2.0.0-alpha.41
"@blitzjs/config": 2.0.0-alpha.42
"@juanm04/cpx": 2.0.1
"@mrleebo/prisma-ast": 0.2.6
"@types/babel__core": 7.1.19
@@ -865,7 +865,7 @@ importers:
packages/pkg-template:
specifiers:
"@blitzjs/config": 2.0.0-alpha.41
"@blitzjs/config": 2.0.0-alpha.42
"@types/react": 18.0.1
"@types/react-dom": 17.0.14
"@typescript-eslint/eslint-plugin": 5.9.1