Compare commits
33 Commits
@blitzjs/a
...
@blitzjs/c
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
b905270875 | ||
|
|
96ea5291e4 | ||
|
|
9c2e7d372c | ||
|
|
493d505b24 | ||
|
|
09da992bef | ||
|
|
bbac7906e8 | ||
|
|
21ca3a9b02 | ||
|
|
32274803d9 | ||
|
|
9ded8dacba | ||
|
|
80ffbeaa4c | ||
|
|
6bde1b07da | ||
|
|
b918055bf3 | ||
|
|
f9a2971f05 | ||
|
|
72b08f2269 | ||
|
|
2124a4d0c5 | ||
|
|
8aee25c58a | ||
|
|
f1003faf94 | ||
|
|
50468a3bb0 | ||
|
|
891d91bf4d | ||
|
|
f96c953457 | ||
|
|
a80d2a8f77 | ||
|
|
b336ad05f4 | ||
|
|
39ca0ef8bf | ||
|
|
4cad9cca25 | ||
|
|
b6fc940bf2 | ||
|
|
a946dd5889 | ||
|
|
e3750b049d | ||
|
|
fb01cc7788 | ||
|
|
ac8c412da2 | ||
|
|
dfd2408e95 | ||
|
|
9741287050 | ||
|
|
0e9c81abdc | ||
|
|
9e05d6e155 |
5
.changeset/bright-mangos-run.md
Normal file
5
.changeset/bright-mangos-run.md
Normal file
@@ -0,0 +1,5 @@
|
||||
---
|
||||
"@blitzjs/rpc": patch
|
||||
---
|
||||
|
||||
Add queryClient to RPC Plugin exports
|
||||
6
.changeset/eleven-humans-sort.md
Normal file
6
.changeset/eleven-humans-sort.md
Normal file
@@ -0,0 +1,6 @@
|
||||
---
|
||||
"@blitzjs/codemod": patch
|
||||
"@blitzjs/generator": patch
|
||||
---
|
||||
|
||||
codemod fixes
|
||||
5
.changeset/empty-turkeys-wave.md
Normal file
5
.changeset/empty-turkeys-wave.md
Normal file
@@ -0,0 +1,5 @@
|
||||
---
|
||||
"@blitzjs/next": patch
|
||||
---
|
||||
|
||||
Use `useRouter` from next/router in useParams function
|
||||
5
.changeset/fuzzy-jars-admire.md
Normal file
5
.changeset/fuzzy-jars-admire.md
Normal file
@@ -0,0 +1,5 @@
|
||||
---
|
||||
"@blitzjs/codemod": patch
|
||||
---
|
||||
|
||||
fix codemod for wrapping \_app arrow function & fix codemod for nested pages directory
|
||||
5
.changeset/gentle-dogs-reply.md
Normal file
5
.changeset/gentle-dogs-reply.md
Normal file
@@ -0,0 +1,5 @@
|
||||
---
|
||||
"@blitzjs/codemod": patch
|
||||
---
|
||||
|
||||
Update queryClient import in codemod
|
||||
5
.changeset/green-papayas-do.md
Normal file
5
.changeset/green-papayas-do.md
Normal file
@@ -0,0 +1,5 @@
|
||||
---
|
||||
"@blitzjs/generator": patch
|
||||
---
|
||||
|
||||
Update codemod and template with a new queryClient import location
|
||||
7
.changeset/lucky-cows-try.md
Normal file
7
.changeset/lucky-cows-try.md
Normal file
@@ -0,0 +1,7 @@
|
||||
---
|
||||
"blitz": patch
|
||||
"@blitzjs/auth": patch
|
||||
"@blitzjs/next": patch
|
||||
---
|
||||
|
||||
rename middleware type for blitz server plugin
|
||||
5
.changeset/nervous-beds-travel.md
Normal file
5
.changeset/nervous-beds-travel.md
Normal file
@@ -0,0 +1,5 @@
|
||||
---
|
||||
"@blitzjs/next": patch
|
||||
---
|
||||
|
||||
useParam & useParams functions now accessible from @blitzjs/next
|
||||
@@ -22,20 +22,28 @@
|
||||
"changesets": [
|
||||
"big-phones-bow",
|
||||
"breezy-cameras-double",
|
||||
"bright-mangos-run",
|
||||
"cool-doors-invent",
|
||||
"dirty-monkeys-greet",
|
||||
"eleven-humans-sort",
|
||||
"empty-berries-rule",
|
||||
"empty-turkeys-wave",
|
||||
"fair-wombats-sneeze",
|
||||
"famous-kings-explain",
|
||||
"fast-trainers-kneel",
|
||||
"flat-bees-approve",
|
||||
"four-meals-fry",
|
||||
"fuzzy-jars-admire",
|
||||
"gentle-dogs-reply",
|
||||
"great-months-train",
|
||||
"green-papayas-do",
|
||||
"healthy-rice-shout",
|
||||
"hot-drinks-approve",
|
||||
"lovely-colts-share",
|
||||
"lucky-cows-try",
|
||||
"modern-cameras-pull",
|
||||
"moody-squids-cheer",
|
||||
"nervous-beds-travel",
|
||||
"nice-starfishes-live",
|
||||
"nine-onions-admire",
|
||||
"ninety-pets-heal",
|
||||
@@ -45,6 +53,7 @@
|
||||
"poor-peas-lick",
|
||||
"poor-penguins-look",
|
||||
"poor-shrimps-think",
|
||||
"purple-singers-greet",
|
||||
"quiet-feet-travel",
|
||||
"rich-chairs-invent",
|
||||
"sharp-falcons-begin",
|
||||
@@ -53,14 +62,17 @@
|
||||
"small-socks-confess",
|
||||
"stupid-walls-sell",
|
||||
"swift-drinks-dress",
|
||||
"tame-keys-reply",
|
||||
"tasty-news-collect",
|
||||
"ten-rivers-burn",
|
||||
"tender-pianos-check",
|
||||
"thick-parrots-float",
|
||||
"thirty-countries-build",
|
||||
"twenty-beans-pump",
|
||||
"two-kiwis-help",
|
||||
"unlucky-papayas-sleep",
|
||||
"violet-bags-leave",
|
||||
"violet-lions-help",
|
||||
"weak-suns-shave",
|
||||
"wicked-ghosts-cough",
|
||||
"wise-frogs-give"
|
||||
|
||||
7
.changeset/purple-singers-greet.md
Normal file
7
.changeset/purple-singers-greet.md
Normal file
@@ -0,0 +1,7 @@
|
||||
---
|
||||
"@blitzjs/rpc": patch
|
||||
"@blitzjs/codemod": patch
|
||||
"@blitzjs/generator": patch
|
||||
---
|
||||
|
||||
getQueryClient function & queryClient codemod updates & shared plugin config
|
||||
5
.changeset/tame-keys-reply.md
Normal file
5
.changeset/tame-keys-reply.md
Normal file
@@ -0,0 +1,5 @@
|
||||
---
|
||||
"blitz": patch
|
||||
---
|
||||
|
||||
Add aliases for Blitz CLI commands
|
||||
5
.changeset/thick-parrots-float.md
Normal file
5
.changeset/thick-parrots-float.md
Normal file
@@ -0,0 +1,5 @@
|
||||
---
|
||||
"@blitzjs/codemod": patch
|
||||
---
|
||||
|
||||
allow extension catch in getAllFiles codemod util
|
||||
5
.changeset/violet-lions-help.md
Normal file
5
.changeset/violet-lions-help.md
Normal file
@@ -0,0 +1,5 @@
|
||||
---
|
||||
"@blitzjs/rpc": patch
|
||||
---
|
||||
|
||||
Add resolverBasePath to Blitz config to change the way rpc routes are generated
|
||||
1
.npmrc
1
.npmrc
@@ -6,3 +6,4 @@ public-hoist-pattern[]=*types*
|
||||
public-hoist-pattern[]=*eslint*
|
||||
public-hoist-pattern[]=@prettier/plugin-*
|
||||
public-hoist-pattern[]=*prettier-plugin-*
|
||||
strict-peer-dependencies=false
|
||||
|
||||
@@ -29,7 +29,7 @@
|
||||
"@blitzjs/rpc": "workspace:*",
|
||||
"@hookform/resolvers": "2.8.8",
|
||||
"@prisma/client": "3.9.0",
|
||||
"blitz": "workspace:2.0.0-alpha.32",
|
||||
"blitz": "workspace:2.0.0-alpha.42",
|
||||
"next": "12.1.6-canary.17",
|
||||
"prisma": "3.9.0",
|
||||
"react": "18.0.0",
|
||||
|
||||
@@ -10,6 +10,7 @@ module.exports = withBlitz(
|
||||
customServer: {
|
||||
hotReload: false,
|
||||
},
|
||||
resolverBasePath: "root",
|
||||
},
|
||||
}),
|
||||
)
|
||||
|
||||
@@ -1,5 +1,68 @@
|
||||
# @blitzjs/auth
|
||||
|
||||
## 2.0.0-alpha.42
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- blitz@2.0.0-alpha.42
|
||||
|
||||
## 2.0.0-alpha.41
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- blitz@2.0.0-alpha.41
|
||||
|
||||
## 2.0.0-alpha.40
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- blitz@2.0.0-alpha.40
|
||||
|
||||
## 2.0.0-alpha.39
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- Updated dependencies [b918055b]
|
||||
- blitz@2.0.0-alpha.39
|
||||
|
||||
## 2.0.0-alpha.38
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- blitz@2.0.0-alpha.38
|
||||
|
||||
## 2.0.0-alpha.37
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- a80d2a8f: rename middleware type for blitz server plugin
|
||||
- Updated dependencies [a80d2a8f]
|
||||
- blitz@2.0.0-alpha.37
|
||||
|
||||
## 2.0.0-alpha.36
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- blitz@2.0.0-alpha.36
|
||||
|
||||
## 2.0.0-alpha.35
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- blitz@2.0.0-alpha.35
|
||||
|
||||
## 2.0.0-alpha.34
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- blitz@2.0.0-alpha.34
|
||||
|
||||
## 2.0.0-alpha.33
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- blitz@2.0.0-alpha.33
|
||||
|
||||
## 2.0.0-alpha.32
|
||||
|
||||
### Patch Changes
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "@blitzjs/auth",
|
||||
"version": "2.0.0-alpha.32",
|
||||
"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.32",
|
||||
"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.32",
|
||||
"@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",
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
import type {BlitzServerPlugin, Middleware, Ctx} from "blitz"
|
||||
import type {BlitzServerPlugin, RequestMiddleware, Ctx} from "blitz"
|
||||
import {assert} from "blitz"
|
||||
import {IncomingMessage, ServerResponse} from "http"
|
||||
import {PublicData, SessionModel, SessionConfigMethods} from "../shared/types"
|
||||
@@ -101,7 +101,7 @@ export function AuthServerPlugin(options: AuthPluginOptions): BlitzServerPlugin<
|
||||
`The cookie prefix used has invalid characters. Only alphanumeric characters, "-" and "_" character are supported`,
|
||||
)
|
||||
|
||||
const blitzSessionMiddleware: Middleware<
|
||||
const blitzSessionMiddleware: RequestMiddleware<
|
||||
IncomingMessage,
|
||||
ServerResponse & {blitzCtx: Ctx}
|
||||
> = async (req, res, next) => {
|
||||
@@ -119,6 +119,6 @@ export function AuthServerPlugin(options: AuthPluginOptions): BlitzServerPlugin<
|
||||
return blitzSessionMiddleware
|
||||
}
|
||||
return {
|
||||
middlewares: [authPluginSessionMiddleware()],
|
||||
requestMiddlewares: [authPluginSessionMiddleware()],
|
||||
}
|
||||
}
|
||||
|
||||
@@ -8,7 +8,7 @@ import {
|
||||
connectMiddleware,
|
||||
Ctx,
|
||||
handleRequestWithMiddleware,
|
||||
Middleware,
|
||||
RequestMiddleware,
|
||||
MiddlewareResponse,
|
||||
secureProxyMiddleware,
|
||||
} from "blitz"
|
||||
@@ -79,9 +79,9 @@ export function passportAuth(config: BlitzPassportConfig): ApiHandler {
|
||||
|
||||
const passportMiddleware = passport.initialize()
|
||||
|
||||
const middleware: Middleware<ApiHandlerIncomingMessage, MiddlewareResponse<Ctx>>[] = [
|
||||
connectMiddleware(cookieSessionMiddleware as Middleware),
|
||||
connectMiddleware(passportMiddleware as Middleware),
|
||||
const middleware: RequestMiddleware<ApiHandlerIncomingMessage, MiddlewareResponse<Ctx>>[] = [
|
||||
connectMiddleware(cookieSessionMiddleware as RequestMiddleware),
|
||||
connectMiddleware(passportMiddleware as RequestMiddleware),
|
||||
connectMiddleware(passport.session()),
|
||||
]
|
||||
|
||||
|
||||
@@ -1,5 +1,71 @@
|
||||
# @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
|
||||
|
||||
- @blitzjs/rpc@2.0.0-alpha.41
|
||||
|
||||
## 2.0.0-alpha.40
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- 9ded8dac: useParam & useParams functions now accessible from @blitzjs/next
|
||||
- @blitzjs/rpc@2.0.0-alpha.40
|
||||
|
||||
## 2.0.0-alpha.39
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- @blitzjs/rpc@2.0.0-alpha.39
|
||||
|
||||
## 2.0.0-alpha.38
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- Updated dependencies [8aee25c5]
|
||||
- @blitzjs/rpc@2.0.0-alpha.38
|
||||
|
||||
## 2.0.0-alpha.37
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- a80d2a8f: rename middleware type for blitz server plugin
|
||||
- @blitzjs/rpc@2.0.0-alpha.37
|
||||
|
||||
## 2.0.0-alpha.36
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- Updated dependencies [4cad9cca]
|
||||
- @blitzjs/rpc@2.0.0-alpha.36
|
||||
|
||||
## 2.0.0-alpha.35
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- @blitzjs/rpc@2.0.0-alpha.35
|
||||
|
||||
## 2.0.0-alpha.34
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- Updated dependencies [dfd2408e]
|
||||
- @blitzjs/rpc@2.0.0-alpha.34
|
||||
|
||||
## 2.0.0-alpha.33
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- @blitzjs/rpc@2.0.0-alpha.33
|
||||
|
||||
## 2.0.0-alpha.32
|
||||
|
||||
### Patch Changes
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "@blitzjs/next",
|
||||
"version": "2.0.0-alpha.32",
|
||||
"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.32",
|
||||
"@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,21 +32,19 @@
|
||||
"superjson": "1.8.0"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@blitzjs/config": "workspace:2.0.0-alpha.32",
|
||||
"@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",
|
||||
"@testing-library/react-hooks": "7.0.2",
|
||||
"@testing-library/user-event": "13.5.0",
|
||||
"@types/lodash.frompairs": "4.0.6",
|
||||
"@types/node": "17.0.16",
|
||||
"@types/react": "18.0.1",
|
||||
"@types/react-dom": "17.0.14",
|
||||
"@types/testing-library__react-hooks": "4.0.0",
|
||||
"blitz": "2.0.0-alpha.32",
|
||||
"blitz": "2.0.0-alpha.42",
|
||||
"cross-spawn": "7.0.3",
|
||||
"find-up": "4.1.0",
|
||||
"lodash.frompairs": "4.0.1",
|
||||
"next": "12.1.6-canary.17",
|
||||
"react": "18.0.0",
|
||||
"react-dom": "18.0.0",
|
||||
|
||||
@@ -17,6 +17,7 @@ import {Router} from "next/router"
|
||||
|
||||
export * from "./error-boundary"
|
||||
export * from "./error-component"
|
||||
export * from "./use-params"
|
||||
export {Routes} from ".blitz"
|
||||
|
||||
const compose =
|
||||
|
||||
@@ -1,3 +1,4 @@
|
||||
import type {NextConfig} from "next"
|
||||
import {
|
||||
GetServerSideProps,
|
||||
GetServerSidePropsResult,
|
||||
@@ -7,21 +8,20 @@ import {
|
||||
NextApiResponse,
|
||||
} from "next"
|
||||
import type {
|
||||
Ctx as BlitzCtx,
|
||||
BlitzServerPlugin,
|
||||
Middleware,
|
||||
MiddlewareResponse,
|
||||
AsyncFunc,
|
||||
FirstParam,
|
||||
AddParameters,
|
||||
AsyncFunc,
|
||||
BlitzServerPlugin,
|
||||
Ctx as BlitzCtx,
|
||||
FirstParam,
|
||||
RequestMiddleware,
|
||||
MiddlewareResponse,
|
||||
} from "blitz"
|
||||
import {handleRequestWithMiddleware, startWatcher, stopWatcher} from "blitz"
|
||||
import type {NextConfig} from "next"
|
||||
import {getQueryKey, getInfiniteQueryKey, installWebpackConfig} from "@blitzjs/rpc"
|
||||
import {dehydrate} from "@blitzjs/rpc"
|
||||
import {dehydrate, getQueryKey, getInfiniteQueryKey, loaderClient, loaderServer} from "@blitzjs/rpc"
|
||||
import {DefaultOptions, QueryClient} from "react-query"
|
||||
import {IncomingMessage, ServerResponse} from "http"
|
||||
import {withSuperJsonProps} from "./superjson"
|
||||
import {ResolverBasePath} from "@blitzjs/rpc/src/index-server"
|
||||
|
||||
export * from "./index-browser"
|
||||
|
||||
@@ -38,7 +38,7 @@ export type NextApiHandler = (
|
||||
) => void | Promise<void>
|
||||
|
||||
type SetupBlitzOptions = {
|
||||
plugins: BlitzServerPlugin<Middleware, Ctx>[]
|
||||
plugins: BlitzServerPlugin<RequestMiddleware, Ctx>[]
|
||||
}
|
||||
|
||||
export type BlitzGSSPHandler<TProps> = ({
|
||||
@@ -60,7 +60,7 @@ export type BlitzAPIHandler = (
|
||||
) => ReturnType<NextApiHandler>
|
||||
|
||||
export const setupBlitzServer = ({plugins}: SetupBlitzOptions) => {
|
||||
const middlewares = plugins.flatMap((p) => p.middlewares)
|
||||
const middlewares = plugins.flatMap((p) => p.requestMiddlewares)
|
||||
const contextMiddleware = plugins.flatMap((p) => p.contextMiddleware).filter(Boolean)
|
||||
|
||||
const gSSP =
|
||||
@@ -133,12 +133,59 @@ export const setupBlitzServer = ({plugins}: SetupBlitzOptions) => {
|
||||
|
||||
export interface BlitzConfig extends NextConfig {
|
||||
blitz?: {
|
||||
resolverBasePath?: ResolverBasePath
|
||||
customServer?: {
|
||||
hotReload?: boolean
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
interface WebpackRuleOptions {
|
||||
resolverBasePath?: ResolverBasePath
|
||||
}
|
||||
|
||||
interface WebpackRule {
|
||||
test: RegExp
|
||||
use: Array<{
|
||||
loader: string
|
||||
options: WebpackRuleOptions
|
||||
}>
|
||||
}
|
||||
|
||||
interface InstallWebpackConfigOptions {
|
||||
webpackConfig: {
|
||||
module: {
|
||||
rules: WebpackRule[]
|
||||
}
|
||||
}
|
||||
nextConfig: BlitzConfig
|
||||
}
|
||||
|
||||
export function installWebpackConfig({webpackConfig, nextConfig}: InstallWebpackConfigOptions) {
|
||||
const options: WebpackRuleOptions = {
|
||||
resolverBasePath: nextConfig.blitz?.resolverBasePath,
|
||||
}
|
||||
|
||||
webpackConfig.module.rules.push({
|
||||
test: /\/\[\[\.\.\.blitz]]\.[jt]s$/,
|
||||
use: [
|
||||
{
|
||||
loader: loaderServer,
|
||||
options,
|
||||
},
|
||||
],
|
||||
})
|
||||
webpackConfig.module.rules.push({
|
||||
test: /[\\/](queries|mutations)[\\/]/,
|
||||
use: [
|
||||
{
|
||||
loader: loaderClient,
|
||||
options,
|
||||
},
|
||||
],
|
||||
})
|
||||
}
|
||||
|
||||
export function withBlitz(nextConfig: BlitzConfig = {}) {
|
||||
if (
|
||||
process.env.NODE_ENV !== "production" &&
|
||||
@@ -158,8 +205,8 @@ export function withBlitz(nextConfig: BlitzConfig = {}) {
|
||||
}
|
||||
|
||||
const config = Object.assign({}, nextConfig, {
|
||||
webpack: (config: any, options: any) => {
|
||||
installWebpackConfig(config)
|
||||
webpack: (config: InstallWebpackConfigOptions["webpackConfig"], options: any) => {
|
||||
installWebpackConfig({webpackConfig: config, nextConfig})
|
||||
if (typeof nextConfig.webpack === "function") {
|
||||
return nextConfig.webpack(config, options)
|
||||
}
|
||||
|
||||
@@ -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},
|
||||
|
||||
@@ -1,22 +1,10 @@
|
||||
import fromPairs from "lodash.frompairs"
|
||||
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
|
||||
*/
|
||||
@@ -81,7 +69,7 @@ function areQueryValuesEqual(value1: ParsedUrlQueryValue, value2: ParsedUrlQuery
|
||||
}
|
||||
|
||||
export function extractRouterParams(routerQuery: ParsedUrlQuery, asPathQuery: ParsedUrlQuery) {
|
||||
return fromPairs(
|
||||
return Object.fromEntries(
|
||||
Object.entries(routerQuery).filter(
|
||||
([key, value]) =>
|
||||
typeof asPathQuery[key] === "undefined" || !areQueryValuesEqual(value, asPathQuery[key]),
|
||||
|
||||
@@ -1,5 +1,80 @@
|
||||
# @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
|
||||
|
||||
- @blitzjs/auth@2.0.0-alpha.41
|
||||
- blitz@2.0.0-alpha.41
|
||||
|
||||
## 2.0.0-alpha.40
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- @blitzjs/auth@2.0.0-alpha.40
|
||||
- blitz@2.0.0-alpha.40
|
||||
|
||||
## 2.0.0-alpha.39
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- Updated dependencies [b918055b]
|
||||
- blitz@2.0.0-alpha.39
|
||||
- @blitzjs/auth@2.0.0-alpha.39
|
||||
|
||||
## 2.0.0-alpha.38
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- 8aee25c5: getQueryClient function & queryClient codemod updates & shared plugin config
|
||||
- blitz@2.0.0-alpha.38
|
||||
- @blitzjs/auth@2.0.0-alpha.38
|
||||
|
||||
## 2.0.0-alpha.37
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- Updated dependencies [a80d2a8f]
|
||||
- blitz@2.0.0-alpha.37
|
||||
- @blitzjs/auth@2.0.0-alpha.37
|
||||
|
||||
## 2.0.0-alpha.36
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- 4cad9cca: Add queryClient to RPC Plugin exports
|
||||
- blitz@2.0.0-alpha.36
|
||||
- @blitzjs/auth@2.0.0-alpha.36
|
||||
|
||||
## 2.0.0-alpha.35
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- blitz@2.0.0-alpha.35
|
||||
- @blitzjs/auth@2.0.0-alpha.35
|
||||
|
||||
## 2.0.0-alpha.34
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- dfd2408e: Add resolverBasePath to Blitz config to change the way rpc routes are generated
|
||||
- @blitzjs/auth@2.0.0-alpha.34
|
||||
- blitz@2.0.0-alpha.34
|
||||
|
||||
## 2.0.0-alpha.33
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- @blitzjs/auth@2.0.0-alpha.33
|
||||
- blitz@2.0.0-alpha.33
|
||||
|
||||
## 2.0.0-alpha.32
|
||||
|
||||
### Patch Changes
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "@blitzjs/rpc",
|
||||
"version": "2.0.0-alpha.32",
|
||||
"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.32",
|
||||
"@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.32",
|
||||
"@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.32",
|
||||
"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.32",
|
||||
"blitz": "2.0.0-alpha.42",
|
||||
"next": "*"
|
||||
},
|
||||
"publishConfig": {
|
||||
|
||||
@@ -2,11 +2,11 @@ export * from "./rpc"
|
||||
export {useQuery, usePaginatedQuery, useInfiniteQuery, useMutation} from "./react-query"
|
||||
export type {MutateFunction} from "./react-query"
|
||||
export {
|
||||
queryClient,
|
||||
getQueryKey,
|
||||
getInfiniteQueryKey,
|
||||
invalidateQuery,
|
||||
setQueryData,
|
||||
getQueryClient,
|
||||
} from "./react-query-utils"
|
||||
export {useQueryErrorResetBoundary, QueryClient} from "react-query"
|
||||
export {dehydrate} from "react-query/hydration"
|
||||
|
||||
@@ -54,8 +54,8 @@ export const initializeQueryClient = () => {
|
||||
})
|
||||
}
|
||||
|
||||
// Create internal QueryClient instance
|
||||
export const queryClient = initializeQueryClient()
|
||||
// Query client is initialised in `BlitzRpcPlugin`, and can only be used with BlitzRpcPlugin right now
|
||||
export const getQueryClient = () => globalThis.queryClient
|
||||
|
||||
function isRpcClient(f: any): f is RpcClient<any, any> {
|
||||
return !!f._isRpcClient
|
||||
@@ -176,7 +176,7 @@ export function invalidateQuery<TInput, TResult, T extends AsyncFunc>(
|
||||
// Params not provided, only use first query key item (url)
|
||||
queryKey = fullQueryKey[0]
|
||||
}
|
||||
return queryClient.invalidateQueries(queryKey)
|
||||
return getQueryClient().invalidateQueries(queryKey)
|
||||
}
|
||||
|
||||
export function setQueryData<TInput, TResult, T extends AsyncFunc>(
|
||||
@@ -184,15 +184,15 @@ export function setQueryData<TInput, TResult, T extends AsyncFunc>(
|
||||
params: TInput,
|
||||
newData: TResult | ((oldData: TResult | undefined) => TResult),
|
||||
opts: MutateOptions = {refetch: true},
|
||||
): Promise<void | ReturnType<typeof queryClient.invalidateQueries>> {
|
||||
): Promise<void | ReturnType<ReturnType<typeof getQueryClient>["invalidateQueries"]>> {
|
||||
if (typeof resolver === "undefined") {
|
||||
throw new Error("setQueryData is missing the first argument - it must be a resolver function")
|
||||
}
|
||||
const queryKey = getQueryKey(resolver, params)
|
||||
|
||||
return new Promise((res) => {
|
||||
queryClient.setQueryData(queryKey, newData)
|
||||
let result: void | ReturnType<typeof queryClient.invalidateQueries>
|
||||
getQueryClient().setQueryData(queryKey, newData)
|
||||
let result: void | ReturnType<ReturnType<typeof getQueryClient>["invalidateQueries"]>
|
||||
if (opts.refetch) {
|
||||
result = invalidateQuery(resolver, params)
|
||||
}
|
||||
|
||||
@@ -2,8 +2,8 @@ import {normalizePathTrailingSlash} from "next/dist/client/normalize-trailing-sl
|
||||
import {addBasePath} from "next/dist/shared/lib/router/router"
|
||||
import {deserialize, serialize} from "superjson"
|
||||
import {SuperJSONResult} from "superjson/dist/types"
|
||||
import {isServer, CSRFTokenMismatchError} from "blitz"
|
||||
import {getQueryKeyFromUrlAndParams, queryClient} from "./react-query-utils"
|
||||
import {CSRFTokenMismatchError, isServer} from "blitz"
|
||||
import {getQueryKeyFromUrlAndParams, getQueryClient} from "./react-query-utils"
|
||||
import {
|
||||
getAntiCSRFToken,
|
||||
getPublicDataStore,
|
||||
@@ -55,7 +55,7 @@ export function __internal_buildRpcClient({
|
||||
resolverType,
|
||||
routePath,
|
||||
}: BuildRpcClientParams): RpcClient {
|
||||
const fullRoutePath = normalizeApiRoute("/api/rpc/" + routePath)
|
||||
const fullRoutePath = normalizeApiRoute("/api/rpc" + routePath)
|
||||
|
||||
const httpClient: RpcClientBase = async (params, opts = {}) => {
|
||||
const debug = (await import("debug")).default("blitz:rpc")
|
||||
@@ -123,9 +123,9 @@ export function __internal_buildRpcClient({
|
||||
setTimeout(async () => {
|
||||
// Do these in the next tick to prevent various bugs like https://github.com/blitz-js/blitz/issues/2207
|
||||
debug("Invalidating react-query cache...")
|
||||
await queryClient.cancelQueries()
|
||||
await queryClient.resetQueries()
|
||||
queryClient.getMutationCache().clear()
|
||||
await getQueryClient().cancelQueries()
|
||||
await getQueryClient().resetQueries()
|
||||
getQueryClient().getMutationCache().clear()
|
||||
// We have a 100ms delay here to prevent unnecessary stale queries from running
|
||||
// This prevents the case where you logout on a page with
|
||||
// Page.authenticate = {redirectTo: '/login'}
|
||||
@@ -184,7 +184,7 @@ export function __internal_buildRpcClient({
|
||||
|
||||
if (!opts.fromQueryHook) {
|
||||
const queryKey = getQueryKeyFromUrlAndParams(routePath, params)
|
||||
queryClient.setQueryData(queryKey, data)
|
||||
getQueryClient().setQueryData(queryKey, data)
|
||||
}
|
||||
return data
|
||||
}
|
||||
|
||||
@@ -4,12 +4,10 @@ import {DefaultOptions, QueryClient} from "react-query"
|
||||
|
||||
export * from "./data-client/index"
|
||||
|
||||
export const queryClient = globalThis.queryClient
|
||||
|
||||
interface BlitzRpcOptions {
|
||||
reactQueryOptions?: DefaultOptions
|
||||
}
|
||||
export const BlitzRpcPlugin = createClientPlugin<BlitzRpcOptions, any>(
|
||||
export const BlitzRpcPlugin = createClientPlugin<BlitzRpcOptions, {queryClient: QueryClient}>(
|
||||
(options?: BlitzRpcOptions) => {
|
||||
const initializeQueryClient = () => {
|
||||
const {reactQueryOptions} = options || {}
|
||||
@@ -37,12 +35,14 @@ export const BlitzRpcPlugin = createClientPlugin<BlitzRpcOptions, any>(
|
||||
},
|
||||
})
|
||||
}
|
||||
|
||||
globalThis.queryClient = initializeQueryClient()
|
||||
const queryClient = initializeQueryClient()
|
||||
globalThis.queryClient = queryClient
|
||||
return {
|
||||
events: {},
|
||||
middleware: {},
|
||||
exports: () => {},
|
||||
exports: () => ({
|
||||
queryClient,
|
||||
}),
|
||||
}
|
||||
},
|
||||
)
|
||||
|
||||
@@ -1,7 +1,8 @@
|
||||
import {assert, Ctx, baseLogger, prettyMs, newLine} from "blitz"
|
||||
import {assert, baseLogger, Ctx, newLine, prettyMs} from "blitz"
|
||||
import {NextApiRequest, NextApiResponse} from "next"
|
||||
import {deserialize, serialize as superjsonSerialize} from "superjson"
|
||||
import chalk from "chalk"
|
||||
import {resolve} from "path"
|
||||
|
||||
// TODO - optimize end user server bundles by not exporting all client stuff here
|
||||
export * from "./index-browser"
|
||||
@@ -24,6 +25,7 @@ function getGlobalObject<T extends Record<string, unknown>>(key: string, default
|
||||
|
||||
type Resolver = (...args: unknown[]) => Promise<unknown>
|
||||
type ResolverFiles = Record<string, () => Promise<{default?: Resolver}>>
|
||||
export type ResolverBasePath = "queries|mutations" | "root" | undefined
|
||||
|
||||
// We define `global.__internal_blitzRpcResolverFiles` to ensure we use the same global object.
|
||||
// Needed for Next.js. I'm guessing that Next.js is including the `node_modules/` files in a seperate bundle than user files.
|
||||
@@ -47,21 +49,9 @@ export function __internal_addBlitzRpcResolver(
|
||||
return resolver
|
||||
}
|
||||
|
||||
import {resolve} from "path"
|
||||
const dir = __dirname + (() => "")() // trick to avoid `@vercel/ncc` to glob import
|
||||
const loaderServer = resolve(dir, "./loader-server.cjs")
|
||||
const loaderClient = resolve(dir, "./loader-client.cjs")
|
||||
|
||||
export function installWebpackConfig<T extends any[]>(config: {module?: {rules?: T}}) {
|
||||
config.module!.rules!.push({
|
||||
test: /\/\[\[\.\.\.blitz]]\.[jt]s$/,
|
||||
use: [{loader: loaderServer}],
|
||||
})
|
||||
config.module!.rules!.push({
|
||||
test: /[\\/](queries|mutations)[\\/]/,
|
||||
use: [{loader: loaderClient}],
|
||||
})
|
||||
}
|
||||
export const loaderServer = resolve(dir, "./loader-server.cjs")
|
||||
export const loaderClient = resolve(dir, "./loader-client.cjs")
|
||||
|
||||
// ----------
|
||||
// END LOADER
|
||||
|
||||
@@ -3,20 +3,13 @@ import {
|
||||
convertFilePathToResolverName,
|
||||
convertFilePathToResolverType,
|
||||
convertPageFilePathToRoutePath,
|
||||
Loader,
|
||||
LoaderOptions,
|
||||
toPosixPath,
|
||||
} from "./loader-utils"
|
||||
import {assert} from "blitz"
|
||||
import {posix} from "path"
|
||||
|
||||
// Subset of `import type { LoaderDefinitionFunction } from 'webpack'`
|
||||
type Loader = {
|
||||
_compiler?: {
|
||||
name: string
|
||||
context: string
|
||||
}
|
||||
resource: string
|
||||
cacheable: (enabled: boolean) => void
|
||||
}
|
||||
|
||||
export async function loader(this: Loader, input: string): Promise<string> {
|
||||
const compiler = this._compiler!
|
||||
@@ -25,8 +18,12 @@ export async function loader(this: Loader, input: string): Promise<string> {
|
||||
|
||||
const isSSR = compiler.name === "server"
|
||||
if (!isSSR) {
|
||||
const code = await transformBlitzRpcResolverClient(input, toPosixPath(id), toPosixPath(root))
|
||||
return code
|
||||
return await transformBlitzRpcResolverClient(
|
||||
input,
|
||||
toPosixPath(id),
|
||||
toPosixPath(root),
|
||||
this.query,
|
||||
)
|
||||
}
|
||||
|
||||
return input
|
||||
@@ -34,13 +31,18 @@ export async function loader(this: Loader, input: string): Promise<string> {
|
||||
|
||||
module.exports = loader
|
||||
|
||||
export async function transformBlitzRpcResolverClient(_src: string, id: string, root: string) {
|
||||
export async function transformBlitzRpcResolverClient(
|
||||
_src: string,
|
||||
id: string,
|
||||
root: string,
|
||||
options?: LoaderOptions,
|
||||
) {
|
||||
assertPosixPath(id)
|
||||
assertPosixPath(root)
|
||||
|
||||
const resolverFilePath = "/" + posix.relative(root, id)
|
||||
assertPosixPath(resolverFilePath)
|
||||
const routePath = convertPageFilePathToRoutePath(resolverFilePath)
|
||||
const routePath = convertPageFilePathToRoutePath(resolverFilePath, options?.resolverBasePath)
|
||||
const resolverName = convertFilePathToResolverName(resolverFilePath)
|
||||
const resolverType = convertFilePathToResolverType(resolverFilePath)
|
||||
|
||||
|
||||
@@ -1,23 +1,17 @@
|
||||
import {posix, join, dirname} from "path"
|
||||
import {dirname, join, posix} from "path"
|
||||
import {promises} from "fs"
|
||||
import {
|
||||
assertPosixPath,
|
||||
toPosixPath,
|
||||
buildPageExtensionRegex,
|
||||
getIsRpcFile,
|
||||
topLevelFoldersThatMayContainResolvers,
|
||||
convertPageFilePathToRoutePath,
|
||||
getIsRpcFile,
|
||||
Loader,
|
||||
LoaderOptions,
|
||||
topLevelFoldersThatMayContainResolvers,
|
||||
toPosixPath,
|
||||
} from "./loader-utils"
|
||||
|
||||
// Subset of `import type { LoaderDefinitionFunction } from 'webpack'`
|
||||
type Loader = {
|
||||
_compiler?: {
|
||||
name: string
|
||||
context: string
|
||||
}
|
||||
resource: string
|
||||
cacheable: (enabled: boolean) => void
|
||||
}
|
||||
|
||||
export async function loader(this: Loader, input: string): Promise<string> {
|
||||
const compiler = this._compiler!
|
||||
@@ -29,8 +23,13 @@ export async function loader(this: Loader, input: string): Promise<string> {
|
||||
this.cacheable(false)
|
||||
|
||||
const resolvers = await collectResolvers(root, ["ts", "js"])
|
||||
const code = await transformBlitzRpcServer(input, toPosixPath(id), toPosixPath(root), resolvers)
|
||||
return code
|
||||
return await transformBlitzRpcServer(
|
||||
input,
|
||||
toPosixPath(id),
|
||||
toPosixPath(root),
|
||||
resolvers,
|
||||
this.query,
|
||||
)
|
||||
}
|
||||
|
||||
return input
|
||||
@@ -43,6 +42,7 @@ export async function transformBlitzRpcServer(
|
||||
id: string,
|
||||
root: string,
|
||||
resolvers: string[],
|
||||
options?: LoaderOptions,
|
||||
) {
|
||||
assertPosixPath(id)
|
||||
assertPosixPath(root)
|
||||
@@ -55,7 +55,7 @@ export async function transformBlitzRpcServer(
|
||||
|
||||
for (let resolverFilePath of resolvers) {
|
||||
const relativeResolverPath = posix.relative(dirname(id), join(root, resolverFilePath))
|
||||
const routePath = convertPageFilePathToRoutePath(resolverFilePath)
|
||||
const routePath = convertPageFilePathToRoutePath(resolverFilePath, options?.resolverBasePath)
|
||||
code += `__internal_addBlitzRpcResolver('${routePath}', () => import('${relativeResolverPath}'));`
|
||||
code += "\n"
|
||||
}
|
||||
|
||||
24
packages/blitz-rpc/src/loader-utils.test.ts
Normal file
24
packages/blitz-rpc/src/loader-utils.test.ts
Normal file
@@ -0,0 +1,24 @@
|
||||
import {describe, expect, it} from "vitest"
|
||||
import {convertPageFilePathToRoutePath} from "./loader-utils"
|
||||
|
||||
const FILE_PATH = "app/queries/getData.ts"
|
||||
|
||||
describe("convertPageFilePathToRoutePath", () => {
|
||||
it("should return the full path when resolverBasePath is set to root", () => {
|
||||
const res = convertPageFilePathToRoutePath(FILE_PATH, "root")
|
||||
|
||||
expect(res).toEqual("app/queries/getData")
|
||||
})
|
||||
|
||||
it("should return the relative path when resolverBasePath is set to queries|mutations", () => {
|
||||
const res = convertPageFilePathToRoutePath(FILE_PATH, "queries|mutations")
|
||||
|
||||
expect(res).toEqual("/getData")
|
||||
})
|
||||
|
||||
it("should return the relative path when resolverBasePath is set to undefined", () => {
|
||||
const res = convertPageFilePathToRoutePath(FILE_PATH, undefined)
|
||||
|
||||
expect(res).toEqual("/getData")
|
||||
})
|
||||
})
|
||||
@@ -1,5 +1,20 @@
|
||||
import {assert} from "blitz"
|
||||
import {win32, posix, sep} from "path"
|
||||
import {posix, sep, win32} from "path"
|
||||
import {ResolverBasePath} from "./index-server"
|
||||
|
||||
export interface LoaderOptions {
|
||||
resolverBasePath?: ResolverBasePath
|
||||
}
|
||||
|
||||
export interface Loader {
|
||||
_compiler?: {
|
||||
name: string
|
||||
context: string
|
||||
}
|
||||
resource: string
|
||||
cacheable: (enabled: boolean) => void
|
||||
query: LoaderOptions
|
||||
}
|
||||
|
||||
export function assertPosixPath(path: string) {
|
||||
const errMsg = `Wrongly formatted path: ${path}`
|
||||
@@ -34,7 +49,14 @@ export function buildPageExtensionRegex(pageExtensions: string[]) {
|
||||
|
||||
const fileExtensionRegex = /\.([a-z]+)$/
|
||||
|
||||
export function convertPageFilePathToRoutePath(filePath: string) {
|
||||
export function convertPageFilePathToRoutePath(
|
||||
filePath: string,
|
||||
resolverBasePath: ResolverBasePath,
|
||||
) {
|
||||
if (resolverBasePath === "root") {
|
||||
return filePath.replace(fileExtensionRegex, "")
|
||||
}
|
||||
|
||||
return filePath
|
||||
.replace(/^.*?[\\/]queries[\\/]/, "/")
|
||||
.replace(/^.*?[\\/]mutations[\\/]/, "/")
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
import {Ctx} from "blitz"
|
||||
import {describe, it, expect} from "vitest"
|
||||
import {describe, expect, it} from "vitest"
|
||||
import {z} from "zod"
|
||||
import {ParserType, resolver} from "./resolver"
|
||||
|
||||
@@ -44,10 +44,9 @@ const asyncResolver = resolver.pipe(
|
||||
const resolverTest = async ({type}: {type?: ParserType}) => {
|
||||
const resolver1 = type === "sync" ? syncResolver : asyncResolver
|
||||
|
||||
const result1 = await resolver1(
|
||||
{email: "test@example.com"},
|
||||
{session: {$authorize: () => undefined} as Ctx},
|
||||
)
|
||||
const result1 = await resolver1({email: "test@example.com"}, {
|
||||
session: {$authorize: () => undefined},
|
||||
} as Ctx)
|
||||
expect(result1).toBe("test@example.com")
|
||||
|
||||
const resolver2 = resolver.pipe(
|
||||
@@ -55,9 +54,8 @@ const resolverTest = async ({type}: {type?: ParserType}) => {
|
||||
return input.email
|
||||
},
|
||||
)
|
||||
const result2 = await resolver2(
|
||||
{email: "test@example.com"},
|
||||
{session: {$authorize: () => undefined} as Ctx},
|
||||
)
|
||||
const result2 = await resolver2({email: "test@example.com"}, {
|
||||
session: {$authorize: () => undefined},
|
||||
} as Ctx)
|
||||
expect(result2).toBe("test@example.com")
|
||||
}
|
||||
|
||||
@@ -3,10 +3,14 @@
|
||||
*/
|
||||
import {assert, expect, test, beforeEach, describe, spyOn, it} from "vitest"
|
||||
|
||||
import {queryClient, invalidateQuery, setQueryData} from "../../src/data-client"
|
||||
import {getQueryClient, invalidateQuery, setQueryData} from "../../src/data-client"
|
||||
|
||||
import {getQueryCacheFunctions} from "../../src/data-client/react-query-utils"
|
||||
import {
|
||||
getQueryCacheFunctions,
|
||||
initializeQueryClient,
|
||||
} from "../../src/data-client/react-query-utils"
|
||||
import {buildQueryRpc} from "../blitz-test-utils"
|
||||
globalThis.queryClient = initializeQueryClient()
|
||||
|
||||
// eslint-disable-next-line require-await
|
||||
const isEmpty = async (arg: string): Promise<boolean> => {
|
||||
@@ -14,7 +18,7 @@ const isEmpty = async (arg: string): Promise<boolean> => {
|
||||
}
|
||||
|
||||
describe("getQueryCacheFunctions", () => {
|
||||
const spyRefetchQueries = spyOn(queryClient, "invalidateQueries")
|
||||
const spyRefetchQueries = spyOn(getQueryClient(), "invalidateQueries")
|
||||
|
||||
beforeEach(() => {
|
||||
spyRefetchQueries.mockReset()
|
||||
@@ -47,7 +51,7 @@ describe("getQueryCacheFunctions", () => {
|
||||
})
|
||||
|
||||
describe("invalidateQuery", () => {
|
||||
const spyRefetchQueries = spyOn(queryClient, "invalidateQueries")
|
||||
const spyRefetchQueries = spyOn(getQueryClient(), "invalidateQueries")
|
||||
|
||||
beforeEach(() => {
|
||||
spyRefetchQueries.mockReset()
|
||||
@@ -56,15 +60,15 @@ describe("invalidateQuery", () => {
|
||||
it("invalidates a query given resolver and params", async () => {
|
||||
await invalidateQuery(buildQueryRpc(isEmpty), "a")
|
||||
expect(spyRefetchQueries).toBeCalledTimes(1)
|
||||
const calledWith = spyRefetchQueries.mock.calls[0][0] as any
|
||||
const calledWith = spyRefetchQueries.mock.calls[0]![0] as any
|
||||
// json of the queryKey is "a"
|
||||
expect(calledWith[1].json).toEqual("a")
|
||||
})
|
||||
})
|
||||
|
||||
describe("setQueryData", () => {
|
||||
const spyRefetchQueries = spyOn(queryClient, "invalidateQueries")
|
||||
const spySetQueryData = spyOn(queryClient, "setQueryData")
|
||||
const spyRefetchQueries = spyOn(getQueryClient(), "invalidateQueries")
|
||||
const spySetQueryData = spyOn(getQueryClient(), "setQueryData")
|
||||
|
||||
beforeEach(() => {
|
||||
spyRefetchQueries.mockReset()
|
||||
@@ -88,7 +92,7 @@ describe("setQueryData", () => {
|
||||
expect(spyRefetchQueries).toBeCalledTimes(1)
|
||||
expect(spySetQueryData).toBeCalledTimes(1)
|
||||
|
||||
const invalidateCalledWith = spyRefetchQueries.mock.calls[0][0] as any
|
||||
const invalidateCalledWith = spyRefetchQueries.mock.calls[0]![0] as any
|
||||
expect(invalidateCalledWith[1].json).toEqual("params")
|
||||
|
||||
const calledWith = spySetQueryData.mock.calls[0] as Array<any>
|
||||
|
||||
@@ -1,5 +1,70 @@
|
||||
# blitz
|
||||
|
||||
## 2.0.0-alpha.42
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- @blitzjs/generator@2.0.0-alpha.42
|
||||
|
||||
## 2.0.0-alpha.41
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- @blitzjs/generator@2.0.0-alpha.41
|
||||
|
||||
## 2.0.0-alpha.40
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- @blitzjs/generator@2.0.0-alpha.40
|
||||
|
||||
## 2.0.0-alpha.39
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- b918055b: Add aliases for Blitz CLI commands
|
||||
- @blitzjs/generator@2.0.0-alpha.39
|
||||
|
||||
## 2.0.0-alpha.38
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- Updated dependencies [8aee25c5]
|
||||
- @blitzjs/generator@2.0.0-alpha.38
|
||||
|
||||
## 2.0.0-alpha.37
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- a80d2a8f: rename middleware type for blitz server plugin
|
||||
- @blitzjs/generator@2.0.0-alpha.37
|
||||
|
||||
## 2.0.0-alpha.36
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- Updated dependencies [4cad9cca]
|
||||
- @blitzjs/generator@2.0.0-alpha.36
|
||||
|
||||
## 2.0.0-alpha.35
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- Updated dependencies [e3750b04]
|
||||
- @blitzjs/generator@2.0.0-alpha.35
|
||||
|
||||
## 2.0.0-alpha.34
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- @blitzjs/generator@2.0.0-alpha.34
|
||||
|
||||
## 2.0.0-alpha.33
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- @blitzjs/generator@2.0.0-alpha.33
|
||||
|
||||
## 2.0.0-alpha.32
|
||||
|
||||
### Patch Changes
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "blitz",
|
||||
"version": "2.0.0-alpha.32",
|
||||
"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.32",
|
||||
"@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.32",
|
||||
"@blitzjs/config": "workspace:2.0.0-alpha.42",
|
||||
"@types/cookie": "0.4.1",
|
||||
"@types/cross-spawn": "6.0.2",
|
||||
"@types/debug": "4.1.7",
|
||||
|
||||
@@ -1,6 +1,5 @@
|
||||
import {NON_STANDARD_NODE_ENV} from "./utils/constants"
|
||||
import arg from "arg"
|
||||
import packageJson from "../../package.json"
|
||||
import {loadEnvConfig} from "../env-utils"
|
||||
import {getCommandBin} from "./utils/config"
|
||||
import spawn from "cross-spawn"
|
||||
@@ -10,7 +9,7 @@ import pkgDir from "pkg-dir"
|
||||
import {join} from "path"
|
||||
|
||||
const commonArgs = {
|
||||
// Types
|
||||
// Flags
|
||||
"--version": Boolean,
|
||||
"--help": Boolean,
|
||||
"--inspect": Boolean,
|
||||
@@ -25,9 +24,9 @@ const args = arg(commonArgs, {
|
||||
permissive: true,
|
||||
})
|
||||
|
||||
const defaultCommand = "dev"
|
||||
export type CliCommand = (argv?: string[]) => void
|
||||
const commands: {[command: string]: () => Promise<CliCommand>} = {
|
||||
|
||||
const commands = {
|
||||
dev: () => import("./commands/next/dev").then((i) => i.dev),
|
||||
build: () => import("./commands/next/build").then((i) => i.build),
|
||||
start: () => import("./commands/next/start").then((i) => i.start),
|
||||
@@ -36,25 +35,34 @@ const commands: {[command: string]: () => Promise<CliCommand>} = {
|
||||
codegen: () => import("./commands/codegen").then((i) => i.codegen),
|
||||
db: () => import("./commands/db").then((i) => i.db),
|
||||
}
|
||||
const foundCommand = Boolean(commands[args._[0] as string])
|
||||
const command = foundCommand ? (args._[0] as string) : defaultCommand
|
||||
const forwardedArgs = foundCommand ? args._.slice(1) : args._
|
||||
|
||||
const aliases: Record<string, keyof typeof commands> = {
|
||||
d: "dev",
|
||||
b: "build",
|
||||
s: "start",
|
||||
n: "new",
|
||||
g: "generate",
|
||||
}
|
||||
|
||||
type Command = keyof typeof commands
|
||||
type Alias = keyof typeof aliases
|
||||
const defaultCommand: Command = "dev"
|
||||
|
||||
const foundCommand = Boolean(commands[args._[0] as Command])
|
||||
const foundAlias = Boolean(aliases[args._[0] as Alias])
|
||||
let command: Command = defaultCommand
|
||||
if (foundCommand) {
|
||||
command = args._[0] as Command
|
||||
}
|
||||
if (foundAlias) {
|
||||
command = aliases[args._[0] as Alias] as Command
|
||||
}
|
||||
const forwardedArgs = foundCommand || foundAlias ? args._.slice(1) : args._
|
||||
|
||||
const globalBlitzPath = resolveFrom(__dirname, "blitz")
|
||||
const localBlitzPath = resolveFrom.silent(process.cwd(), "blitz")
|
||||
|
||||
const isInDevelopmentAsGloballyLinked = __dirname.includes("packages/blitz/dist")
|
||||
|
||||
let blitzPkgPath
|
||||
if (isInDevelopmentAsGloballyLinked) {
|
||||
blitzPkgPath = globalBlitzPath
|
||||
} else {
|
||||
// localBlitzPath won't exist if used outside a blitz app directory
|
||||
blitzPkgPath = localBlitzPath || globalBlitzPath
|
||||
}
|
||||
|
||||
async function runCommandFromBin() {
|
||||
const command = args._[0] as string
|
||||
let commandBin: string | null = null
|
||||
try {
|
||||
commandBin = await getCommandBin(command)
|
||||
@@ -96,10 +104,10 @@ async function printEnvInfo() {
|
||||
{showNotFound: true},
|
||||
)
|
||||
|
||||
const globalBlitzPkgJsonPath = pkgDir.sync(globalBlitzPath) as string
|
||||
const globalBlitzPkgJsonPath = pkgDir.sync(globalBlitzPath)
|
||||
const localBlitzPkgJsonPath = pkgDir.sync(localBlitzPath)
|
||||
|
||||
if (globalBlitzPkgJsonPath !== localBlitzPkgJsonPath) {
|
||||
if (globalBlitzPkgJsonPath && globalBlitzPkgJsonPath !== localBlitzPkgJsonPath) {
|
||||
// This branch won't run if user does `npx blitz` or `yarn blitz`
|
||||
const globalVersion = require(join(globalBlitzPkgJsonPath, "package.json")).version
|
||||
console.log(`Blitz version: ${globalVersion} (global)`)
|
||||
@@ -141,14 +149,16 @@ async function main() {
|
||||
if (process.env.NODE_ENV && !standardEnv.includes(process.env.NODE_ENV)) {
|
||||
console.warn(NON_STANDARD_NODE_ENV)
|
||||
}
|
||||
;(process.env as any).NODE_ENV = process.env.NODE_ENV || defaultEnv
|
||||
|
||||
process.env.NODE_ENV = process.env.NODE_ENV || defaultEnv
|
||||
|
||||
// Make sure commands gracefully respect termination signals (e.g. from Docker)
|
||||
process.on("SIGTERM", () => process.exit(0))
|
||||
process.on("SIGINT", () => process.exit(0))
|
||||
|
||||
if (foundCommand) {
|
||||
commands[command]?.()
|
||||
if (foundCommand || foundAlias) {
|
||||
const commandFn = commands[command] || aliases[command]
|
||||
commandFn?.()
|
||||
.then((exec: any) => exec(forwardedArgs))
|
||||
.then(() => {
|
||||
if (command === "build") {
|
||||
@@ -162,13 +172,21 @@ async function main() {
|
||||
})
|
||||
} else {
|
||||
if (args["--help"] && args._.length === 0) {
|
||||
// TODO: add back the generate command description once it's working
|
||||
// generate, g Generate new files for your Blitz project 🤠
|
||||
|
||||
console.log(`
|
||||
Usage
|
||||
$ blitz <command>
|
||||
|
||||
Available commands
|
||||
${Object.keys(commands).join(", ")}
|
||||
|
||||
dev, d Start a development server 🪄
|
||||
build, b Create a production build 🏗️
|
||||
start, s Start the production server 🐎
|
||||
new, n Create a new Blitz project ✨
|
||||
codegen Run the blitz codegen 🤖
|
||||
db Run database commands 🗄️
|
||||
|
||||
Options
|
||||
--env, -e App environment name
|
||||
--version, -v Version number
|
||||
|
||||
@@ -22,7 +22,7 @@ export interface MiddlewareResponse<C extends Ctx = Ctx> extends ServerResponse
|
||||
|
||||
export type MiddlewareNext = (error?: Error) => Promise<void> | void
|
||||
|
||||
export type Middleware<
|
||||
export type RequestMiddleware<
|
||||
TRequest extends IncomingMessage = IncomingMessage,
|
||||
TResponse = ServerResponse,
|
||||
> = {
|
||||
@@ -32,11 +32,11 @@ export type Middleware<
|
||||
}
|
||||
|
||||
export type BlitzServerPlugin<
|
||||
MiddlewareType = Middleware<any, any>,
|
||||
RequestMiddlewareType = RequestMiddleware<any, any>,
|
||||
TCtx extends Ctx = Ctx,
|
||||
TExports extends object = {},
|
||||
> = {
|
||||
middlewares: MiddlewareType[]
|
||||
requestMiddlewares: RequestMiddlewareType[]
|
||||
contextMiddleware?: (ctx: TCtx) => TCtx
|
||||
exports?: TExports
|
||||
}
|
||||
@@ -54,7 +54,7 @@ export function createServerPlugin<
|
||||
return pluginConstructor
|
||||
}
|
||||
|
||||
export function createSetupServer<TMiddleware extends Middleware, TExports extends object>(
|
||||
export function createSetupServer<TMiddleware extends RequestMiddleware, TExports extends object>(
|
||||
setupServerConstructor: (plugins: BlitzServerPlugin<TMiddleware>) => TExports,
|
||||
) {
|
||||
return setupServerConstructor
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
import {IncomingMessage, ServerResponse} from "http"
|
||||
import {compose, Ctx, Middleware, MiddlewareNext, MiddlewareResponse} from "./index-server"
|
||||
import {compose, Ctx, RequestMiddleware, MiddlewareNext, MiddlewareResponse} from "./index-server"
|
||||
|
||||
export async function handleRequestWithMiddleware<
|
||||
Req extends IncomingMessage = IncomingMessage,
|
||||
@@ -7,7 +7,7 @@ export async function handleRequestWithMiddleware<
|
||||
>(
|
||||
req: Req,
|
||||
res: Res,
|
||||
middleware: Middleware<Req, Res>[],
|
||||
middleware: RequestMiddleware<Req, Res>[],
|
||||
{
|
||||
throwOnError = true,
|
||||
stackPrintOnError = true,
|
||||
@@ -117,7 +117,7 @@ export async function handleRequestWithMiddleware<
|
||||
export function noCallbackHandler<
|
||||
Req extends IncomingMessage = IncomingMessage,
|
||||
Res = MiddlewareResponse,
|
||||
>(req: Req, res: Res, next: MiddlewareNext, middleware: Middleware<Req, Res>) {
|
||||
>(req: Req, res: Res, next: MiddlewareNext, middleware: RequestMiddleware<Req, Res>) {
|
||||
// Cast to any to call with two arguments for connect compatibility
|
||||
;(middleware as any)(req, res)
|
||||
return next()
|
||||
@@ -131,7 +131,7 @@ export function noCallbackHandler<
|
||||
export function withCallbackHandler<
|
||||
Req extends IncomingMessage = IncomingMessage,
|
||||
Res = MiddlewareResponse,
|
||||
>(req: Req, res: Res, next: MiddlewareNext, middleware: Middleware<Req, Res>) {
|
||||
>(req: Req, res: Res, next: MiddlewareNext, middleware: RequestMiddleware<Req, Res>) {
|
||||
return new Promise((resolve, reject) => {
|
||||
// Rule doesn't matter since we are inside new Promise()
|
||||
//eslint-disable-next-line @typescript-eslint/no-floating-promises
|
||||
@@ -150,14 +150,14 @@ export function withCallbackHandler<
|
||||
export function connectMiddleware<
|
||||
Req extends IncomingMessage = IncomingMessage,
|
||||
Res extends MiddlewareResponse = MiddlewareResponse,
|
||||
>(middleware: Middleware<Req, Res>): Middleware<Req, Res> {
|
||||
>(middleware: RequestMiddleware<Req, Res>): RequestMiddleware<Req, Res> {
|
||||
const handler = middleware.length < 3 ? noCallbackHandler : withCallbackHandler
|
||||
return function connectHandler(req: Req, res, next) {
|
||||
return handler(req, res, next, middleware)
|
||||
} as Middleware<Req, Res>
|
||||
} as RequestMiddleware<Req, Res>
|
||||
}
|
||||
|
||||
export const secureProxyMiddleware: Middleware<
|
||||
export const secureProxyMiddleware: RequestMiddleware<
|
||||
IncomingMessage & {protocol?: string},
|
||||
MiddlewareResponse
|
||||
> = function (
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
import {Middleware} from "./index-server"
|
||||
import {RequestMiddleware} from "./index-server"
|
||||
import * as path from "path"
|
||||
import * as fs from "fs"
|
||||
|
||||
@@ -76,7 +76,7 @@ export const setCookie = (name: string, value: string, expires: string) => {
|
||||
}
|
||||
export const deleteCookie = (name: string) => setCookie(name, "", "Thu, 01 Jan 1970 00:00:01 GMT")
|
||||
|
||||
export function compose(middleware: Middleware<any, any>[]) {
|
||||
export function compose(middleware: RequestMiddleware<any, any>[]) {
|
||||
if (!Array.isArray(middleware)) {
|
||||
throw new TypeError("Middleware stack must be an array!")
|
||||
}
|
||||
@@ -115,7 +115,7 @@ export function compose(middleware: Middleware<any, any>[]) {
|
||||
|
||||
// return next(result as any)
|
||||
return dispatch(0).then(next as any)
|
||||
} as Middleware
|
||||
} as RequestMiddleware
|
||||
}
|
||||
|
||||
function round(num: number, decimalPlaces: number) {
|
||||
|
||||
@@ -1,5 +1,85 @@
|
||||
# @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
|
||||
|
||||
- bbac7906: fix codemod for wrapping \_app arrow function & fix codemod for nested pages directory
|
||||
- @blitzjs/generator@2.0.0-alpha.41
|
||||
- blitz@2.0.0-alpha.41
|
||||
|
||||
## 2.0.0-alpha.40
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- @blitzjs/generator@2.0.0-alpha.40
|
||||
- blitz@2.0.0-alpha.40
|
||||
|
||||
## 2.0.0-alpha.39
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- Updated dependencies [b918055b]
|
||||
- blitz@2.0.0-alpha.39
|
||||
- @blitzjs/generator@2.0.0-alpha.39
|
||||
|
||||
## 2.0.0-alpha.38
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- 8aee25c5: getQueryClient function & queryClient codemod updates & shared plugin config
|
||||
- Updated dependencies [8aee25c5]
|
||||
- @blitzjs/generator@2.0.0-alpha.38
|
||||
- blitz@2.0.0-alpha.38
|
||||
|
||||
## 2.0.0-alpha.37
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- Updated dependencies [a80d2a8f]
|
||||
- blitz@2.0.0-alpha.37
|
||||
- @blitzjs/generator@2.0.0-alpha.37
|
||||
|
||||
## 2.0.0-alpha.36
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- 4cad9cca: Update queryClient import in codemod
|
||||
- Updated dependencies [4cad9cca]
|
||||
- @blitzjs/generator@2.0.0-alpha.36
|
||||
- blitz@2.0.0-alpha.36
|
||||
|
||||
## 2.0.0-alpha.35
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- e3750b04: codemod fixes
|
||||
- Updated dependencies [e3750b04]
|
||||
- @blitzjs/generator@2.0.0-alpha.35
|
||||
- blitz@2.0.0-alpha.35
|
||||
|
||||
## 2.0.0-alpha.34
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- @blitzjs/generator@2.0.0-alpha.34
|
||||
- blitz@2.0.0-alpha.34
|
||||
|
||||
## 2.0.0-alpha.33
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- 9e05d6e1: allow extension catch in getAllFiles codemod util
|
||||
- @blitzjs/generator@2.0.0-alpha.33
|
||||
- blitz@2.0.0-alpha.33
|
||||
|
||||
## 2.0.0-alpha.32
|
||||
|
||||
### Patch Changes
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "@blitzjs/codemod",
|
||||
"version": "2.0.0-alpha.32",
|
||||
"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.32",
|
||||
"@blitzjs/generator": "2.0.0-alpha.42",
|
||||
"arg": "5.0.1",
|
||||
"blitz": "2.0.0-alpha.32",
|
||||
"blitz": "2.0.0-alpha.42",
|
||||
"chalk": "^4.1.0",
|
||||
"cross-spawn": "7.0.3",
|
||||
"debug": "4.3.3",
|
||||
|
||||
@@ -11,10 +11,13 @@ import {
|
||||
getAllFiles,
|
||||
getCollectionFromSource,
|
||||
wrapDeclaration,
|
||||
findIdentifier,
|
||||
} from "./utils"
|
||||
import {log} from "blitz"
|
||||
|
||||
const isInternalBlitzMonorepoDevelopment = fs.existsSync(path.join(__dirname, "../../blitz-next"))
|
||||
const isInternalBlitzMonorepoDevelopment = fs.existsSync(
|
||||
path.join(__dirname, "../../../blitz-next"),
|
||||
)
|
||||
|
||||
const upgradeLegacy = async () => {
|
||||
let isTypescript = fs.existsSync(path.resolve("tsconfig.json"))
|
||||
@@ -61,7 +64,9 @@ const upgradeLegacy = async () => {
|
||||
j.assignmentExpression(
|
||||
"=",
|
||||
j.memberExpression(j.identifier("module"), j.identifier("exports")),
|
||||
j.callExpression(j.identifier("withBlitz"), []),
|
||||
j.callExpression(j.identifier("withBlitz"), [
|
||||
j.objectExpression([j.objectProperty(j.identifier("blitz"), j.objectExpression([]))]),
|
||||
]),
|
||||
),
|
||||
)
|
||||
parsedProgram.value.program.body.push(moduleExportExpression)
|
||||
@@ -129,7 +134,7 @@ const upgradeLegacy = async () => {
|
||||
GetServerSideProps: "next",
|
||||
InferGetServerSidePropsType: "next",
|
||||
GetServerSidePropsContext: "next",
|
||||
|
||||
AuthenticatedMiddlewareCtx: "@blitz/rpc",
|
||||
getAntiCSRFToken: "@blitzjs/rpc",
|
||||
useSession: "@blitzjs/auth",
|
||||
useAuthenticatedSession: "@blitzjs/auth",
|
||||
@@ -170,7 +175,7 @@ const upgradeLegacy = async () => {
|
||||
BlitzLayout: "@blitzjs/next",
|
||||
}
|
||||
|
||||
getAllFiles(appDir, [], [], [".css"]).forEach((filename) => {
|
||||
getAllFiles(appDir, [], [], [".ts", ".tsx", ".js", ".jsx"]).forEach((filename) => {
|
||||
const program = getCollectionFromSource(path.resolve(appDir, filename))
|
||||
const parsedProgram = program.get()
|
||||
|
||||
@@ -213,7 +218,7 @@ const upgradeLegacy = async () => {
|
||||
steps.push({
|
||||
name: "update NextJS' default imports",
|
||||
action: async () => {
|
||||
getAllFiles(appDir, [], [], [".css"]).forEach((file) => {
|
||||
getAllFiles(appDir, [], [], [".ts", ".tsx", ".js", ".jsx"]).forEach((file) => {
|
||||
const program = getCollectionFromSource(file)
|
||||
|
||||
const nextImage = findImport(program, "next/image")
|
||||
@@ -261,6 +266,71 @@ const upgradeLegacy = async () => {
|
||||
},
|
||||
})
|
||||
|
||||
steps.push({
|
||||
name: "change queryClient to getQueryClient()",
|
||||
action: async () => {
|
||||
getAllFiles(appDir, [], [], [".ts", ".tsx", ".js", ".jsx"]).forEach((file) => {
|
||||
const filepath = path.resolve(appDir, file)
|
||||
const program = getCollectionFromSource(filepath)
|
||||
|
||||
const findQueryClient = () => {
|
||||
return program.find(j.Identifier, (node) => node.name === "queryClient")
|
||||
}
|
||||
|
||||
findQueryClient().forEach((q) => {
|
||||
switch (q.name) {
|
||||
case "imported":
|
||||
q.value.name = "getQueryClient"
|
||||
break
|
||||
case "object":
|
||||
j(q).replaceWith(j.callExpression(j.identifier("getQueryClient"), []))
|
||||
break
|
||||
}
|
||||
})
|
||||
|
||||
fs.writeFileSync(path.resolve(appDir, file), program.toSource())
|
||||
})
|
||||
},
|
||||
})
|
||||
|
||||
steps.push({
|
||||
name: "change BlitzApiRequest to NextApiRequest",
|
||||
action: async () => {
|
||||
getAllFiles(path.join(appDir, "api"), [], [], [".ts", ".tsx", ".js", ".jsx"]).forEach(
|
||||
(file) => {
|
||||
const program = getCollectionFromSource(file)
|
||||
|
||||
findIdentifier(program, "BlitzApiRequest")
|
||||
.paths()
|
||||
.forEach((path) => {
|
||||
if (path.parentPath.parentPath.parentPath.value.type === "ImportDeclaration") {
|
||||
path.parentPath.parentPath.parentPath.value.source.value = "next"
|
||||
}
|
||||
path.value.name = "NextApiRequest"
|
||||
})
|
||||
findIdentifier(program, "BlitzApiResponse")
|
||||
.paths()
|
||||
.forEach((path) => {
|
||||
if (path.parentPath.parentPath.parentPath.value.type === "ImportDeclaration") {
|
||||
path.parentPath.parentPath.parentPath.value.source.value = "next"
|
||||
}
|
||||
path.value.name = "NextApiResponse"
|
||||
})
|
||||
findIdentifier(program, "BlitzApiHandler")
|
||||
.paths()
|
||||
.forEach((path) => {
|
||||
if (path.parentPath.parentPath.parentPath.value.type === "ImportDeclaration") {
|
||||
path.parentPath.parentPath.parentPath.value.source.value = "next"
|
||||
}
|
||||
path.value.name = "NextApiHandler"
|
||||
})
|
||||
|
||||
fs.writeFileSync(path.join(path.resolve(file)), program.toSource())
|
||||
},
|
||||
)
|
||||
},
|
||||
})
|
||||
|
||||
steps.push({
|
||||
name: "create blitz-server.ts and blitz-client.ts setup files",
|
||||
action: async () => {
|
||||
@@ -304,6 +374,35 @@ const upgradeLegacy = async () => {
|
||||
},
|
||||
})
|
||||
|
||||
steps.push({
|
||||
name: "Add cookiePrefix to blitz server",
|
||||
action: async () => {
|
||||
const blitzConfigProgram = getCollectionFromSource(blitzConfigFile)
|
||||
const cookieIdentifier = blitzConfigProgram.find(
|
||||
j.Identifier,
|
||||
(node) => node.name === "cookiePrefix",
|
||||
)
|
||||
if (cookieIdentifier.length) {
|
||||
const cookiePrefix = cookieIdentifier.get().parentPath.value.value.value
|
||||
const blitzClientProgram = getCollectionFromSource(
|
||||
path.join(appDir, `blitz-client.${isTypescript ? "ts" : "js"}`),
|
||||
)
|
||||
const cookieIdentifierBlitzClient = blitzClientProgram.find(
|
||||
j.Identifier,
|
||||
(node) => node.name === "cookiePrefix",
|
||||
)
|
||||
cookieIdentifierBlitzClient.get().parentPath.value.value.value = cookiePrefix
|
||||
|
||||
fs.writeFileSync(
|
||||
`${appDir}/blitz-client.${isTypescript ? "ts" : "js"}`,
|
||||
blitzClientProgram.toSource(),
|
||||
)
|
||||
} else {
|
||||
log.error("Cookie Prefix not found in blitz config file")
|
||||
}
|
||||
},
|
||||
})
|
||||
|
||||
steps.push({
|
||||
name: "create pages/api/rpc directory and add [[...blitz]].ts wildecard API route",
|
||||
action: async () => {
|
||||
@@ -366,24 +465,85 @@ const upgradeLegacy = async () => {
|
||||
const getAllPagesDirs = (dirPath: string) => {
|
||||
let files = fs.readdirSync(dirPath)
|
||||
|
||||
const pageDir = files.reduce((arr: {model: string; path: string}[], file: string) => {
|
||||
if (fs.statSync(dirPath + "/" + file).isDirectory()) {
|
||||
let subs = fs.readdirSync(dirPath + "/" + file)
|
||||
if (subs.includes("pages")) {
|
||||
arr.push({
|
||||
model: file,
|
||||
path: dirPath + "/" + file + "/pages",
|
||||
})
|
||||
const pageDir = files.reduce(
|
||||
(arr: {model: string; path: string; subModel?: string}[], file: string) => {
|
||||
if (fs.statSync(dirPath + "/" + file).isDirectory()) {
|
||||
let subs = fs.readdirSync(dirPath + "/" + file)
|
||||
|
||||
if (subs.includes("pages")) {
|
||||
// Go a level deeper into "pages"
|
||||
let subSubs = fs.readdirSync(dirPath + "/" + file + "/pages")
|
||||
|
||||
for (let dir of subSubs) {
|
||||
if (fs.statSync(dirPath + "/" + file + "/pages" + "/" + dir).isDirectory()) {
|
||||
// If directory structure is like: DIRECTORY/PAGES/DIRECTORY
|
||||
if (dir === file) {
|
||||
arr.push({
|
||||
model: file,
|
||||
path: dirPath + "/" + file + "/pages" + "/" + dir,
|
||||
})
|
||||
} else {
|
||||
// If there is another directory that doesn't have the same name
|
||||
arr.push({
|
||||
model: file,
|
||||
subModel: dir,
|
||||
path: dirPath + "/" + file + "/pages" + "/" + dir,
|
||||
})
|
||||
}
|
||||
} else {
|
||||
arr.push({
|
||||
model: file,
|
||||
path: dirPath + "/" + file + "/pages",
|
||||
})
|
||||
break
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
return arr
|
||||
}, [])
|
||||
return arr
|
||||
},
|
||||
[],
|
||||
)
|
||||
|
||||
return pageDir
|
||||
}
|
||||
|
||||
getAllPagesDirs(appDir).forEach((pages) => {
|
||||
fs.moveSync(pages.path, path.join(path.resolve("pages"), pages.model))
|
||||
if (pages.subModel) {
|
||||
// If the directory exists with a sub model (sub page directory), loop through the directory manually move each file/directory
|
||||
if (fs.existsSync(path.join(path.resolve("pages"), pages.model))) {
|
||||
let subs = fs.readdirSync(pages.path)
|
||||
subs.forEach((sub) => {
|
||||
fs.moveSync(
|
||||
path.join(pages.path, sub),
|
||||
path.join(path.resolve("pages"), pages.model, pages.subModel!, sub),
|
||||
)
|
||||
})
|
||||
} else {
|
||||
fs.moveSync(pages.path, path.join(path.resolve("pages"), pages.model, pages.subModel))
|
||||
}
|
||||
} else {
|
||||
// If the directory exists without a sub model (sub page directory), loop through the directory manually move each file/directory
|
||||
if (fs.existsSync(path.join(path.resolve("pages"), pages.model))) {
|
||||
let subs = fs.readdirSync(pages.path)
|
||||
subs.forEach((sub) => {
|
||||
fs.moveSync(
|
||||
path.join(pages.path, sub),
|
||||
path.join(path.resolve("pages"), pages.model, sub),
|
||||
)
|
||||
})
|
||||
} else {
|
||||
fs.moveSync(pages.path, path.join(path.resolve("pages"), pages.model))
|
||||
}
|
||||
}
|
||||
})
|
||||
|
||||
//Clean up
|
||||
getAllPagesDirs(appDir).forEach((page) => {
|
||||
let subs = fs.readdirSync(path.join(appDir, page.model))
|
||||
if (subs.includes("pages")) {
|
||||
fs.removeSync(path.join(appDir, page.model, "pages"))
|
||||
}
|
||||
})
|
||||
},
|
||||
})
|
||||
@@ -397,6 +557,8 @@ const upgradeLegacy = async () => {
|
||||
apiRoutes.forEach((dir) => {
|
||||
if (fs.statSync(appDir + "/api/" + dir).isDirectory()) {
|
||||
fs.moveSync(appDir + "/api/" + dir, path.join(path.resolve("pages"), "api", dir))
|
||||
} else {
|
||||
fs.moveSync(appDir + "/api/" + dir, path.join(path.resolve("pages"), "api", dir))
|
||||
}
|
||||
})
|
||||
}
|
||||
@@ -420,11 +582,57 @@ const upgradeLegacy = async () => {
|
||||
j.Identifier,
|
||||
(node) => node.name === "blitz" || node.escapedText === "blitz",
|
||||
)
|
||||
const findBlitzCustomServerLiteral = program
|
||||
.find(j.StringLiteral, (node) => node.value === "blitz/custom-server")
|
||||
.get()
|
||||
const findBlitzCustomServerLiteral = program.find(
|
||||
j.StringLiteral,
|
||||
(node) => node.value === "blitz/custom-server",
|
||||
)
|
||||
|
||||
findBlitzCustomServerLiteral.value.value = "next"
|
||||
if (findBlitzCustomServerLiteral.length === 0) {
|
||||
log.error(
|
||||
`Failed to find "blitz/custom-server" import in ${customServerDir}/index.${
|
||||
isTypescript ? "ts" : "js"
|
||||
}. You will need to update your custom server manually.`,
|
||||
)
|
||||
} else {
|
||||
findBlitzCustomServerLiteral.get().value.value = "next"
|
||||
findBlitzCall.forEach((hit) => {
|
||||
// Loops through the blitz calls. Check if its a call expression, require statement or import statement. Will check everything to next instead of blitz
|
||||
switch (hit.name) {
|
||||
case "callee":
|
||||
hit.value.name = "next"
|
||||
case "id":
|
||||
hit.value.name = "next"
|
||||
case "local":
|
||||
hit.value.name = "next"
|
||||
}
|
||||
})
|
||||
|
||||
fs.writeFileSync(
|
||||
path.join("server", `index.${isTypescript ? "ts" : "js"}`),
|
||||
program.toSource(),
|
||||
)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// If custom server file found outside dir
|
||||
if (fs.existsSync(customServerFile)) {
|
||||
const program = getCollectionFromSource(customServerFile)
|
||||
const findBlitzCall = program.find(
|
||||
j.Identifier,
|
||||
(node) => node.name === "blitz" || node.escapedText === "blitz",
|
||||
)
|
||||
const findBlitzCustomServerLiteral = program.find(
|
||||
j.StringLiteral,
|
||||
(node) => node.value === "blitz/custom-server",
|
||||
)
|
||||
|
||||
if (findBlitzCustomServerLiteral.length === 0) {
|
||||
log.error(
|
||||
`Failed to find "blitz/custom-server" import in ${customServerFile}. You will need to update your custom server manually.`,
|
||||
)
|
||||
} else {
|
||||
findBlitzCustomServerLiteral.get().value.value = "next"
|
||||
findBlitzCall.forEach((hit) => {
|
||||
// Loops through the blitz calls. Check if its a call expression, require statement or import statement. Will check everything to next instead of blitz
|
||||
switch (hit.name) {
|
||||
@@ -436,39 +644,9 @@ const upgradeLegacy = async () => {
|
||||
hit.value.name = "next"
|
||||
}
|
||||
})
|
||||
|
||||
fs.writeFileSync(
|
||||
path.join("server", `index.${isTypescript ? "ts" : "js"}`),
|
||||
program.toSource(),
|
||||
)
|
||||
fs.writeFileSync(customServerFile, program.toSource())
|
||||
}
|
||||
}
|
||||
|
||||
// If custom server file found outside dir
|
||||
if (fs.existsSync(customServerFile)) {
|
||||
const program = getCollectionFromSource(customServerFile)
|
||||
const findBlitzCall = program.find(
|
||||
j.Identifier,
|
||||
(node) => node.name === "blitz" || node.escapedText === "blitz",
|
||||
)
|
||||
const findBlitzCustomServerLiteral = program
|
||||
.find(j.StringLiteral, (node) => node.value === "blitz/custom-server")
|
||||
.get()
|
||||
|
||||
findBlitzCustomServerLiteral.value.value = "next"
|
||||
findBlitzCall.forEach((hit) => {
|
||||
// Loops through the blitz calls. Check if its a call expression, require statement or import statement. Will check everything to next instead of blitz
|
||||
switch (hit.name) {
|
||||
case "callee":
|
||||
hit.value.name = "next"
|
||||
case "id":
|
||||
hit.value.name = "next"
|
||||
case "local":
|
||||
hit.value.name = "next"
|
||||
}
|
||||
})
|
||||
fs.writeFileSync(customServerFile, program.toSource())
|
||||
}
|
||||
},
|
||||
})
|
||||
|
||||
@@ -477,7 +655,7 @@ const upgradeLegacy = async () => {
|
||||
action: async () => {
|
||||
//First check ./pages
|
||||
const pagesDir = path.resolve("pages")
|
||||
getAllFiles(pagesDir, [], [], [".css"]).forEach((file) => {
|
||||
getAllFiles(pagesDir, [], [], [".ts", ".tsx", ".js", ".jsx"]).forEach((file) => {
|
||||
const filepath = path.resolve(pagesDir, file)
|
||||
const program = getCollectionFromSource(filepath)
|
||||
|
||||
@@ -520,7 +698,7 @@ const upgradeLegacy = async () => {
|
||||
fs.writeFileSync(filepath, program.toSource())
|
||||
})
|
||||
|
||||
getAllFiles(appDir, [], [], [".css"]).forEach((file) => {
|
||||
getAllFiles(appDir, [], [], [".ts", ".tsx", ".js", ".jsx"]).forEach((file) => {
|
||||
const filepath = path.resolve(appDir, file)
|
||||
const program = getCollectionFromSource(filepath)
|
||||
|
||||
@@ -580,19 +758,38 @@ const upgradeLegacy = async () => {
|
||||
const program = getCollectionFromSource(
|
||||
path.join(pagesDir, `_app.${isTypescript ? "tsx" : "jsx"}`),
|
||||
)
|
||||
|
||||
const appFunction = program.find(j.FunctionDeclaration, (node) => {
|
||||
return node.id.name === "App"
|
||||
})
|
||||
|
||||
// Store the App function
|
||||
const storeFunction = {...appFunction.get().value}
|
||||
const appIdentifier = program.find(j.Identifier, (node) => {
|
||||
return node.name === "App"
|
||||
})
|
||||
|
||||
// Create a new withBlitz call expresion with an empty argument
|
||||
const withBlitzFunction = (appFunction.get().parentPath.value.declaration =
|
||||
j.expressionStatement(j.callExpression(j.identifier("withBlitz"), []))) as any
|
||||
// Push stored function above into the argument
|
||||
withBlitzFunction.expression.arguments.push(storeFunction)
|
||||
if (appFunction.length) {
|
||||
// Store the App function
|
||||
const storeFunction = {...appFunction.get().value}
|
||||
// Create a new withBlitz call expresion with an empty argument
|
||||
const withBlitzFunction = (appFunction.get().parentPath.value.declaration =
|
||||
j.expressionStatement(j.callExpression(j.identifier("withBlitz"), []))) as any
|
||||
// Push stored function above into the argument
|
||||
withBlitzFunction.expression.arguments.push(storeFunction)
|
||||
} else if (appIdentifier.length) {
|
||||
appIdentifier.forEach((a) => {
|
||||
switch (a.name) {
|
||||
case "declaration":
|
||||
const storeFunction = {...a.get().value}
|
||||
// Create a new withBlitz call expresion with an empty argument
|
||||
const withBlitzFunction = (a.get().parentPath.value.declaration =
|
||||
j.expressionStatement(j.callExpression(j.identifier("withBlitz"), []))) as any
|
||||
// Push stored function above into the argument
|
||||
withBlitzFunction.expression.arguments.push(storeFunction)
|
||||
break
|
||||
}
|
||||
})
|
||||
} else {
|
||||
log.error("App function not found")
|
||||
}
|
||||
|
||||
addNamedImport(program, "withBlitz", "app/blitz-client")
|
||||
|
||||
@@ -650,7 +847,7 @@ const upgradeLegacy = async () => {
|
||||
name: "wrap getServerSideProps, getStaticProps and API handlers with gSSP, gSP, and api",
|
||||
action: async () => {
|
||||
const pagesDir = path.resolve("pages")
|
||||
getAllFiles(pagesDir, [], ["api"]).forEach((file) => {
|
||||
getAllFiles(pagesDir, [], ["api"], [".ts", ".tsx", ".js", ".jsx"]).forEach((file) => {
|
||||
const program = getCollectionFromSource(file)
|
||||
|
||||
// 1. getServerSideProps
|
||||
@@ -674,7 +871,12 @@ const upgradeLegacy = async () => {
|
||||
|
||||
// 3. api
|
||||
if (fs.existsSync(path.join(pagesDir, "api"))) {
|
||||
getAllFiles(path.join(pagesDir, "api"), [], ["rpc"]).forEach((file) => {
|
||||
getAllFiles(
|
||||
path.join(pagesDir, "api"),
|
||||
[],
|
||||
["rpc"],
|
||||
[".ts", ".tsx", ".js", ".jsx"],
|
||||
).forEach((file) => {
|
||||
const program = getCollectionFromSource(file)
|
||||
|
||||
const defaultExportPath = findDefaultExportPath(program)
|
||||
@@ -697,7 +899,7 @@ const upgradeLegacy = async () => {
|
||||
action: async () => {
|
||||
let errors = 0
|
||||
|
||||
getAllFiles(appDir, [], ["components"], [".css"]).forEach((file) => {
|
||||
getAllFiles(appDir, [], ["components"], [".ts", ".tsx", ".js", ".jsx"]).forEach((file) => {
|
||||
const program = getCollectionFromSource(file)
|
||||
const middlewarePath = findVariable(program, "middleware")
|
||||
if (middlewarePath?.length) {
|
||||
@@ -712,32 +914,70 @@ const upgradeLegacy = async () => {
|
||||
},
|
||||
})
|
||||
|
||||
steps.push({
|
||||
name: "update root types file",
|
||||
action: async () => {
|
||||
const typeFile = path.join(process.cwd(), "types.ts")
|
||||
|
||||
if (fs.existsSync(typeFile)) {
|
||||
const program = getCollectionFromSource(typeFile)
|
||||
|
||||
const findDefaultCtx = () => {
|
||||
return program.find(j.Identifier, (node) => node)
|
||||
}
|
||||
|
||||
findDefaultCtx().forEach((path) => {
|
||||
if (path.value.name === "Ctx") {
|
||||
path.parentPath.parentPath.value.declaration.extends = []
|
||||
}
|
||||
if (path.value.name === "DefaultCtx" && path.name === "imported") {
|
||||
j(path.parentPath).remove()
|
||||
}
|
||||
})
|
||||
|
||||
const findBlitzLiteral = () => {
|
||||
return program.find(j.StringLiteral, (node) => node.value === "blitz")
|
||||
}
|
||||
|
||||
findBlitzLiteral()
|
||||
.paths()
|
||||
.forEach((path) => {
|
||||
path.value.value = "@blitzjs/auth"
|
||||
})
|
||||
|
||||
fs.writeFileSync(typeFile, program.toSource())
|
||||
} else {
|
||||
log.error("There is no type file")
|
||||
}
|
||||
},
|
||||
})
|
||||
|
||||
steps.push({
|
||||
name: "check for usages of invokeWithMiddleware",
|
||||
action: async () => {
|
||||
let errors = 0
|
||||
|
||||
getAllFiles(appDir, [], [], [".css"]).forEach((file) => {
|
||||
getAllFiles(appDir, [], [], [".ts", ".tsx", ".js", ".jsx"]).forEach((file) => {
|
||||
const program = getCollectionFromSource(file)
|
||||
const invokeWithMiddlewarePath = findCallExpression(program, "invokeWithMiddleware")
|
||||
if (invokeWithMiddlewarePath?.length) {
|
||||
console.error(`invokeWithMiddleware found at ${file}.`)
|
||||
log.error(`\n invokeWithMiddleware found at ${file}. \n`)
|
||||
errors++
|
||||
}
|
||||
})
|
||||
|
||||
getAllFiles(path.resolve("pages"), [], [], [".css"]).forEach((file) => {
|
||||
getAllFiles(path.resolve("pages"), [], [], [".ts", ".tsx", ".js", ".jsx"]).forEach((file) => {
|
||||
const program = getCollectionFromSource(file)
|
||||
const invokeWithMiddlewarePath = findCallExpression(program, "invokeWithMiddleware")
|
||||
if (invokeWithMiddlewarePath?.length) {
|
||||
console.error(`invokeWithMiddleware found at ${file}.`)
|
||||
log.error(`\n invokeWithMiddleware found at ${file}. \n`)
|
||||
errors++
|
||||
}
|
||||
})
|
||||
|
||||
if (errors > 0) {
|
||||
throw new Error(
|
||||
"invokeWithMiddleware is not supported. Use invokeWithCtx instead: https://canary.blitzjs.com/docs/resolver-server-utilities#invoke-with-ctx",
|
||||
"\n invokeWithMiddleware is not supported. \n Use invokeWithCtx instead: https://canary.blitzjs.com/docs/resolver-server-utilities#invoke-with-ctx \n Fix the files above, then run the codemod again.",
|
||||
)
|
||||
}
|
||||
},
|
||||
|
||||
@@ -9,9 +9,14 @@ import j, {
|
||||
ImportDeclaration,
|
||||
CallExpression,
|
||||
ImportSpecifier,
|
||||
Identifier,
|
||||
} from "jscodeshift"
|
||||
import {parseSync} from "@babel/core"
|
||||
|
||||
export function findIdentifier(program: Collection<any>, name: string): Collection<Identifier> {
|
||||
return program.find(j.Identifier, (node) => node.name === name)
|
||||
}
|
||||
|
||||
export function findFunction(
|
||||
program: Collection<any>,
|
||||
declarationName: string,
|
||||
@@ -192,17 +197,21 @@ export function getAllFiles(
|
||||
dirPath: string,
|
||||
accFiles: string[] = [],
|
||||
skipDirs?: string[],
|
||||
skipExt?: string[],
|
||||
allowedExt?: string[],
|
||||
) {
|
||||
let currentFiles = fs.readdirSync(dirPath)
|
||||
|
||||
currentFiles.forEach((file) => {
|
||||
if (fs.statSync(dirPath + "/" + file).isDirectory()) {
|
||||
if (!skipDirs?.includes(file)) {
|
||||
accFiles = getAllFiles(dirPath + "/" + file, accFiles, skipDirs, skipExt)
|
||||
accFiles = getAllFiles(dirPath + "/" + file, accFiles, skipDirs, allowedExt)
|
||||
}
|
||||
} else {
|
||||
if (!skipExt?.includes(path.extname(file))) {
|
||||
if (allowedExt?.length) {
|
||||
if (allowedExt?.includes(path.extname(file))) {
|
||||
accFiles.push(path.join(dirPath, "/", file))
|
||||
}
|
||||
} else {
|
||||
accFiles.push(path.join(dirPath, "/", file))
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,5 +1,25 @@
|
||||
# @blitzjs/config
|
||||
|
||||
## 2.0.0-alpha.42
|
||||
|
||||
## 2.0.0-alpha.41
|
||||
|
||||
## 2.0.0-alpha.40
|
||||
|
||||
## 2.0.0-alpha.39
|
||||
|
||||
## 2.0.0-alpha.38
|
||||
|
||||
## 2.0.0-alpha.37
|
||||
|
||||
## 2.0.0-alpha.36
|
||||
|
||||
## 2.0.0-alpha.35
|
||||
|
||||
## 2.0.0-alpha.34
|
||||
|
||||
## 2.0.0-alpha.33
|
||||
|
||||
## 2.0.0-alpha.32
|
||||
|
||||
## 2.0.0-alpha.31
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
{
|
||||
"name": "@blitzjs/config",
|
||||
"private": true,
|
||||
"version": "2.0.0-alpha.32",
|
||||
"version": "2.0.0-alpha.42",
|
||||
"license": "MIT",
|
||||
"dependencies": {
|
||||
"@typescript-eslint/eslint-plugin": "5.9.1",
|
||||
|
||||
@@ -1,5 +1,37 @@
|
||||
# @blitzjs/generator
|
||||
|
||||
## 2.0.0-alpha.42
|
||||
|
||||
## 2.0.0-alpha.41
|
||||
|
||||
## 2.0.0-alpha.40
|
||||
|
||||
## 2.0.0-alpha.39
|
||||
|
||||
## 2.0.0-alpha.38
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- 8aee25c5: getQueryClient function & queryClient codemod updates & shared plugin config
|
||||
|
||||
## 2.0.0-alpha.37
|
||||
|
||||
## 2.0.0-alpha.36
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- 4cad9cca: Update codemod and template with a new queryClient import location
|
||||
|
||||
## 2.0.0-alpha.35
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- e3750b04: codemod fixes
|
||||
|
||||
## 2.0.0-alpha.34
|
||||
|
||||
## 2.0.0-alpha.33
|
||||
|
||||
## 2.0.0-alpha.32
|
||||
|
||||
## 2.0.0-alpha.31
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "@blitzjs/generator",
|
||||
"version": "2.0.0-alpha.32",
|
||||
"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.32",
|
||||
"@blitzjs/config": "2.0.0-alpha.42",
|
||||
"@juanm04/cpx": "2.0.1",
|
||||
"@types/babel__core": "7.1.19",
|
||||
"@types/diff": "5.0.2",
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
import { NotFoundError, AuthenticationError } from "blitz"
|
||||
import { db } from "db"
|
||||
import db from "db"
|
||||
import { authenticateUser } from "./login"
|
||||
import { ChangePassword } from "../validations"
|
||||
import { resolver } from "@blitzjs/rpc"
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
import { db } from "db"
|
||||
import db from "db"
|
||||
import { hash256 } from "@blitzjs/auth"
|
||||
import forgotPassword from "./forgotPassword"
|
||||
import previewEmail from "preview-email"
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
import { generateToken, hash256 } from "@blitzjs/auth"
|
||||
import { resolver } from "@blitzjs/rpc"
|
||||
import { db } from "db"
|
||||
import db from "db"
|
||||
import { forgotPasswordMailer } from "mailers/forgotPasswordMailer"
|
||||
import { ForgotPassword } from "../validations"
|
||||
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
import resetPassword from "./resetPassword"
|
||||
import { db } from "db"
|
||||
import db from "db"
|
||||
import { SecurePassword, hash256 } from "@blitzjs/auth"
|
||||
|
||||
beforeEach(async () => {
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
import { SecurePassword, hash256 } from "@blitzjs/auth"
|
||||
import { db } from "db"
|
||||
import db from "db"
|
||||
import { ResetPassword } from "../validations"
|
||||
import login from "./login"
|
||||
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
import { db } from "db"
|
||||
import db from "db"
|
||||
import { SecurePassword } from "@blitzjs/auth"
|
||||
|
||||
export default async function signup(input, ctx) {
|
||||
|
||||
@@ -2,11 +2,13 @@ import { AuthClientPlugin } from "@blitzjs/auth"
|
||||
import { setupBlitzClient } from "@blitzjs/next"
|
||||
import { BlitzRpcPlugin } from "@blitzjs/rpc"
|
||||
|
||||
export const authConfig = {
|
||||
cookiePrefix: "__safeNameSlug__-cookie-prefix"
|
||||
}
|
||||
|
||||
export const { withBlitz } = setupBlitzClient({
|
||||
plugins: [
|
||||
AuthClientPlugin({
|
||||
cookiePrefix: "__safeNameSlug__-cookie-prefix",
|
||||
}),
|
||||
AuthClientPlugin(authConfig),
|
||||
BlitzRpcPlugin({}),
|
||||
],
|
||||
})
|
||||
|
||||
@@ -1,12 +1,13 @@
|
||||
import { setupBlitzServer } from "@blitzjs/next"
|
||||
import { AuthServerPlugin, PrismaStorage } from "@blitzjs/auth"
|
||||
import {db} from "db"
|
||||
import db from "db"
|
||||
import { simpleRolesIsAuthorized } from "@blitzjs/auth"
|
||||
import { authConfig } from "./blitz-client"
|
||||
|
||||
export const { gSSP, gSP, api } = setupBlitzServer({
|
||||
plugins: [
|
||||
AuthServerPlugin({
|
||||
cookiePrefix: "__safeNameSlug__-cookie-prefix",
|
||||
...authConfig,
|
||||
storage: PrismaStorage(db as any),
|
||||
isAuthorized: simpleRolesIsAuthorized,
|
||||
}),
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
import { Ctx } from "blitz"
|
||||
import { db } from "db"
|
||||
import db from "db"
|
||||
|
||||
export default async function getCurrentUser(_ = null, { session }: Ctx) {
|
||||
if (!session.userId) return null
|
||||
|
||||
@@ -5,4 +5,4 @@ const EnhancedPrisma = enhancePrisma(PrismaClient)
|
||||
|
||||
export * from "@prisma/client"
|
||||
const db = new EnhancedPrisma()
|
||||
export { db }
|
||||
export default db
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
import {Ctx} from "blitz"
|
||||
import { db } from "db"
|
||||
import db from "db"
|
||||
import {z} from "zod"
|
||||
|
||||
if (process.env.parentModel) {
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
import {Ctx} from "blitz"
|
||||
import { db } from "db"
|
||||
import db from "db"
|
||||
import {z} from "zod"
|
||||
|
||||
const Delete__ModelName__Input = z.object({
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
import { db } from "db"
|
||||
import db from "db"
|
||||
import {z} from "zod"
|
||||
|
||||
const Update__ModelName__Input = z.object({
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
import {Ctx, NotFoundError} from "blitz"
|
||||
import { db } from "db"
|
||||
import db from "db"
|
||||
import {z} from "zod"
|
||||
|
||||
const Get__ModelName__Input = z.object({
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
import {paginate, Ctx} from "blitz"
|
||||
import { db } from "db"
|
||||
import db from "db"
|
||||
import { Prisma } from "@prisma/client"
|
||||
|
||||
interface Get__ModelNames__Input
|
||||
|
||||
@@ -25,7 +25,7 @@
|
||||
"@typescript-eslint/parser": "5.9.1"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@blitzjs/config": "2.0.0-alpha.32",
|
||||
"@blitzjs/config": "2.0.0-alpha.42",
|
||||
"@types/react": "18.0.1",
|
||||
"@types/react-dom": "17.0.14",
|
||||
"react": "18.0.0",
|
||||
|
||||
973
pnpm-lock.yaml
generated
973
pnpm-lock.yaml
generated
File diff suppressed because it is too large
Load Diff
Reference in New Issue
Block a user