Compare commits
31 Commits
blitz@2.0.
...
@blitzjs/a
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
891d91bf4d | ||
|
|
f96c953457 | ||
|
|
a80d2a8f77 | ||
|
|
b336ad05f4 | ||
|
|
39ca0ef8bf | ||
|
|
4cad9cca25 | ||
|
|
b6fc940bf2 | ||
|
|
a946dd5889 | ||
|
|
e3750b049d | ||
|
|
fb01cc7788 | ||
|
|
ac8c412da2 | ||
|
|
dfd2408e95 | ||
|
|
9741287050 | ||
|
|
0e9c81abdc | ||
|
|
9e05d6e155 | ||
|
|
17f70e65ef | ||
|
|
0ddc5a8169 | ||
|
|
e6fb09d494 | ||
|
|
d846fc6be9 | ||
|
|
f5e80e3835 | ||
|
|
17ce29e5e4 | ||
|
|
46d9f81adf | ||
|
|
994cfc6292 | ||
|
|
7811748526 | ||
|
|
ce45368334 | ||
|
|
4e9c1f60b6 | ||
|
|
508682c8f8 | ||
|
|
962eb58af6 | ||
|
|
17669b3af8 | ||
|
|
ec6299c36a | ||
|
|
6ac2d3412a |
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/famous-kings-explain.md
Normal file
5
.changeset/famous-kings-explain.md
Normal file
@@ -0,0 +1,5 @@
|
||||
---
|
||||
"@blitzjs/generator": patch
|
||||
---
|
||||
|
||||
updated nextjs version in generator & npmrc file
|
||||
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
|
||||
5
.changeset/healthy-rice-shout.md
Normal file
5
.changeset/healthy-rice-shout.md
Normal file
@@ -0,0 +1,5 @@
|
||||
---
|
||||
"blitz": patch
|
||||
---
|
||||
|
||||
detailed print env info
|
||||
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/olive-bees-buy.md
Normal file
5
.changeset/olive-bees-buy.md
Normal file
@@ -0,0 +1,5 @@
|
||||
---
|
||||
"@blitzjs/codemod": patch
|
||||
---
|
||||
|
||||
Fix templates source in RPC codemod step
|
||||
5
.changeset/olive-feet-rhyme.md
Normal file
5
.changeset/olive-feet-rhyme.md
Normal file
@@ -0,0 +1,5 @@
|
||||
---
|
||||
"@blitzjs/codemod": patch
|
||||
---
|
||||
|
||||
Add codemod to upgrade from legacy framework to the Blitz Toolkit
|
||||
@@ -12,6 +12,7 @@
|
||||
"@blitzjs/rpc": "2.0.0-alpha.0",
|
||||
"@blitzjs/config": "0.0.0",
|
||||
"@blitzjs/generator": "2.0.0-alpha.0",
|
||||
"@blitzjs/codemod": "2.0.0-alpha.0",
|
||||
"template": "0.0.0",
|
||||
"toolkit-app": "1.0.0",
|
||||
"test-qm": "0.0.0",
|
||||
@@ -21,21 +22,30 @@
|
||||
"changesets": [
|
||||
"big-phones-bow",
|
||||
"breezy-cameras-double",
|
||||
"bright-mangos-run",
|
||||
"cool-doors-invent",
|
||||
"dirty-monkeys-greet",
|
||||
"eleven-humans-sort",
|
||||
"empty-berries-rule",
|
||||
"fair-wombats-sneeze",
|
||||
"famous-kings-explain",
|
||||
"fast-trainers-kneel",
|
||||
"flat-bees-approve",
|
||||
"four-meals-fry",
|
||||
"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",
|
||||
"nice-starfishes-live",
|
||||
"nine-onions-admire",
|
||||
"ninety-pets-heal",
|
||||
"olive-bees-buy",
|
||||
"olive-feet-rhyme",
|
||||
"plenty-bottles-swim",
|
||||
"poor-peas-lick",
|
||||
"poor-penguins-look",
|
||||
@@ -43,16 +53,21 @@
|
||||
"quiet-feet-travel",
|
||||
"rich-chairs-invent",
|
||||
"sharp-falcons-begin",
|
||||
"shy-olives-hang",
|
||||
"silent-colts-reply",
|
||||
"small-socks-confess",
|
||||
"stupid-walls-sell",
|
||||
"swift-drinks-dress",
|
||||
"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"
|
||||
|
||||
6
.changeset/shy-olives-hang.md
Normal file
6
.changeset/shy-olives-hang.md
Normal file
@@ -0,0 +1,6 @@
|
||||
---
|
||||
"@blitzjs/rpc": patch
|
||||
"@blitzjs/generator": patch
|
||||
---
|
||||
|
||||
Update RPC plugin setup in templates
|
||||
6
.changeset/tasty-news-collect.md
Normal file
6
.changeset/tasty-news-collect.md
Normal file
@@ -0,0 +1,6 @@
|
||||
---
|
||||
"blitz": patch
|
||||
"@blitzjs/codemod": patch
|
||||
---
|
||||
|
||||
init codemod generator
|
||||
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-bags-leave.md
Normal file
5
.changeset/violet-bags-leave.md
Normal file
@@ -0,0 +1,5 @@
|
||||
---
|
||||
"@blitzjs/codemod": patch
|
||||
---
|
||||
|
||||
Update templates directory for codemod
|
||||
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
|
||||
|
||||
@@ -2,17 +2,11 @@ import { AuthClientPlugin } from "@blitzjs/auth"
|
||||
import { setupBlitzClient } from "@blitzjs/next"
|
||||
import { BlitzRpcPlugin } from "@blitzjs/rpc"
|
||||
|
||||
export const { withBlitz } = setupBlitzClient({
|
||||
export const { withBlitz, queryClient } = setupBlitzClient({
|
||||
plugins: [
|
||||
AuthClientPlugin({
|
||||
cookiePrefix: "web-cookie-prefix",
|
||||
}),
|
||||
BlitzRpcPlugin({
|
||||
reactQueryOptions: {
|
||||
queries: {
|
||||
staleTime: 7000,
|
||||
},
|
||||
},
|
||||
}),
|
||||
BlitzRpcPlugin({}),
|
||||
],
|
||||
})
|
||||
|
||||
@@ -29,7 +29,7 @@
|
||||
"@blitzjs/rpc": "workspace:*",
|
||||
"@hookform/resolvers": "2.8.8",
|
||||
"@prisma/client": "3.9.0",
|
||||
"blitz": "workspace:2.0.0-alpha.27",
|
||||
"blitz": "workspace:2.0.0-alpha.37",
|
||||
"next": "12.1.6-canary.17",
|
||||
"prisma": "3.9.0",
|
||||
"react": "18.0.0",
|
||||
|
||||
@@ -2,7 +2,7 @@ import {AuthClientPlugin} from "@blitzjs/auth"
|
||||
import {setupBlitzClient} from "@blitzjs/next"
|
||||
import {BlitzRpcPlugin} from "@blitzjs/rpc"
|
||||
|
||||
const {withBlitz} = setupBlitzClient({
|
||||
const {withBlitz, queryClient} = setupBlitzClient({
|
||||
plugins: [
|
||||
AuthClientPlugin({
|
||||
cookiePrefix: "webapp-cookie-prefix",
|
||||
@@ -17,4 +17,4 @@ const {withBlitz} = setupBlitzClient({
|
||||
],
|
||||
})
|
||||
|
||||
export {withBlitz}
|
||||
export {withBlitz, queryClient}
|
||||
|
||||
@@ -10,6 +10,7 @@ module.exports = withBlitz(
|
||||
customServer: {
|
||||
hotReload: false,
|
||||
},
|
||||
resolverBasePath: "root",
|
||||
},
|
||||
}),
|
||||
)
|
||||
|
||||
@@ -7,13 +7,7 @@ const {withBlitz} = setupBlitzClient({
|
||||
AuthClientPlugin({
|
||||
cookiePrefix: "no-suspense-tests-cookie-prefix",
|
||||
}),
|
||||
BlitzRpcPlugin({
|
||||
reactQueryOptions: {
|
||||
queries: {
|
||||
staleTime: 7000,
|
||||
},
|
||||
},
|
||||
}),
|
||||
BlitzRpcPlugin({}),
|
||||
],
|
||||
})
|
||||
|
||||
|
||||
@@ -7,13 +7,7 @@ const {withBlitz} = setupBlitzClient({
|
||||
AuthClientPlugin({
|
||||
cookiePrefix: "trailing-slash-tests-cookie-prefix",
|
||||
}),
|
||||
BlitzRpcPlugin({
|
||||
reactQueryOptions: {
|
||||
queries: {
|
||||
staleTime: 7000,
|
||||
},
|
||||
},
|
||||
}),
|
||||
BlitzRpcPlugin({}),
|
||||
],
|
||||
})
|
||||
|
||||
|
||||
@@ -80,21 +80,7 @@ const BlitzWrapper = ({plugins, children}) => {
|
||||
export function render(ui: RenderUI, {wrapper, router, ...options}: RenderOptions = {}) {
|
||||
if (!wrapper) {
|
||||
wrapper = ({children}) => {
|
||||
return (
|
||||
<BlitzWrapper
|
||||
plugins={[
|
||||
BlitzRpcPlugin({
|
||||
reactQueryOptions: {
|
||||
queries: {
|
||||
staleTime: 7000,
|
||||
},
|
||||
},
|
||||
}),
|
||||
]}
|
||||
>
|
||||
{children}
|
||||
</BlitzWrapper>
|
||||
)
|
||||
return <BlitzWrapper plugins={[BlitzRpcPlugin({})]}>{children}</BlitzWrapper>
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
@@ -1,5 +1,69 @@
|
||||
# @blitzjs/auth
|
||||
|
||||
## 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
|
||||
|
||||
- blitz@2.0.0-alpha.32
|
||||
|
||||
## 2.0.0-alpha.31
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- blitz@2.0.0-alpha.31
|
||||
|
||||
## 2.0.0-alpha.30
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- Updated dependencies [ce453683]
|
||||
- blitz@2.0.0-alpha.30
|
||||
|
||||
## 2.0.0-alpha.29
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- Updated dependencies [962eb58a]
|
||||
- blitz@2.0.0-alpha.29
|
||||
|
||||
## 2.0.0-alpha.28
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- blitz@2.0.0-alpha.28
|
||||
|
||||
## 2.0.0-alpha.27
|
||||
|
||||
### Patch Changes
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "@blitzjs/auth",
|
||||
"version": "2.0.0-alpha.27",
|
||||
"version": "2.0.0-alpha.37",
|
||||
"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.27",
|
||||
"blitz": "2.0.0-alpha.37",
|
||||
"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.27",
|
||||
"@blitzjs/config": "workspace:2.0.0-alpha.37",
|
||||
"@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,69 @@
|
||||
# @blitzjs/next
|
||||
|
||||
## 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
|
||||
|
||||
- @blitzjs/rpc@2.0.0-alpha.32
|
||||
|
||||
## 2.0.0-alpha.31
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- Updated dependencies [17ce29e5]
|
||||
- @blitzjs/rpc@2.0.0-alpha.31
|
||||
|
||||
## 2.0.0-alpha.30
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- @blitzjs/rpc@2.0.0-alpha.30
|
||||
|
||||
## 2.0.0-alpha.29
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- @blitzjs/rpc@2.0.0-alpha.29
|
||||
|
||||
## 2.0.0-alpha.28
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- @blitzjs/rpc@2.0.0-alpha.28
|
||||
|
||||
## 2.0.0-alpha.27
|
||||
|
||||
### Patch Changes
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "@blitzjs/next",
|
||||
"version": "2.0.0-alpha.27",
|
||||
"version": "2.0.0-alpha.37",
|
||||
"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.27",
|
||||
"@blitzjs/rpc": "2.0.0-alpha.37",
|
||||
"@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.27",
|
||||
"@blitzjs/config": "workspace:2.0.0-alpha.37",
|
||||
"@testing-library/dom": "8.13.0",
|
||||
"@testing-library/jest-dom": "5.16.3",
|
||||
"@testing-library/react": "13.0.0",
|
||||
@@ -43,7 +43,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.27",
|
||||
"blitz": "2.0.0-alpha.37",
|
||||
"cross-spawn": "7.0.3",
|
||||
"find-up": "4.1.0",
|
||||
"lodash.frompairs": "4.0.1",
|
||||
|
||||
@@ -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,5 +1,81 @@
|
||||
# @blitzjs/rpc
|
||||
|
||||
## 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
|
||||
|
||||
- @blitzjs/auth@2.0.0-alpha.32
|
||||
- blitz@2.0.0-alpha.32
|
||||
|
||||
## 2.0.0-alpha.31
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- 17ce29e5: Update RPC plugin setup in templates
|
||||
- blitz@2.0.0-alpha.31
|
||||
- @blitzjs/auth@2.0.0-alpha.31
|
||||
|
||||
## 2.0.0-alpha.30
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- Updated dependencies [ce453683]
|
||||
- blitz@2.0.0-alpha.30
|
||||
- @blitzjs/auth@2.0.0-alpha.30
|
||||
|
||||
## 2.0.0-alpha.29
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- Updated dependencies [962eb58a]
|
||||
- blitz@2.0.0-alpha.29
|
||||
- @blitzjs/auth@2.0.0-alpha.29
|
||||
|
||||
## 2.0.0-alpha.28
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- blitz@2.0.0-alpha.28
|
||||
- @blitzjs/auth@2.0.0-alpha.28
|
||||
|
||||
## 2.0.0-alpha.27
|
||||
|
||||
### Patch Changes
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "@blitzjs/rpc",
|
||||
"version": "2.0.0-alpha.27",
|
||||
"version": "2.0.0-alpha.37",
|
||||
"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.27",
|
||||
"@blitzjs/auth": "2.0.0-alpha.37",
|
||||
"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.27",
|
||||
"@blitzjs/config": "workspace:2.0.0-alpha.37",
|
||||
"@types/debug": "4.1.7",
|
||||
"@types/react": "18.0.1",
|
||||
"@types/react-dom": "17.0.14",
|
||||
"blitz": "2.0.0-alpha.27",
|
||||
"blitz": "2.0.0-alpha.37",
|
||||
"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.27",
|
||||
"blitz": "2.0.0-alpha.37",
|
||||
"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,
|
||||
queryClient,
|
||||
} from "./react-query-utils"
|
||||
export {useQueryErrorResetBoundary, QueryClient} from "react-query"
|
||||
export {dehydrate} from "react-query/hydration"
|
||||
|
||||
@@ -2,7 +2,7 @@ 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 {CSRFTokenMismatchError, isServer} from "blitz"
|
||||
import {getQueryKeyFromUrlAndParams, queryClient} from "./react-query-utils"
|
||||
import {
|
||||
getAntiCSRFToken,
|
||||
@@ -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")
|
||||
|
||||
@@ -4,14 +4,13 @@ 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>(
|
||||
({reactQueryOptions}: BlitzRpcOptions) => {
|
||||
export const BlitzRpcPlugin = createClientPlugin<BlitzRpcOptions, {queryClient: QueryClient}>(
|
||||
(options?: BlitzRpcOptions) => {
|
||||
const initializeQueryClient = () => {
|
||||
const {reactQueryOptions} = options || {}
|
||||
let suspenseEnabled = reactQueryOptions?.queries?.suspense ?? true
|
||||
if (!process.env.CLI_COMMAND_CONSOLE && !process.env.CLI_COMMAND_DB) {
|
||||
globalThis.__BLITZ_SUSPENSE_ENABLED = suspenseEnabled
|
||||
@@ -36,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")
|
||||
}
|
||||
|
||||
@@ -5,7 +5,10 @@ import {assert, expect, test, beforeEach, describe, spyOn, it} from "vitest"
|
||||
|
||||
import {queryClient, 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"
|
||||
|
||||
// eslint-disable-next-line require-await
|
||||
|
||||
@@ -1,5 +1,72 @@
|
||||
# blitz
|
||||
|
||||
## 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
|
||||
|
||||
- @blitzjs/generator@2.0.0-alpha.32
|
||||
|
||||
## 2.0.0-alpha.31
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- Updated dependencies [17ce29e5]
|
||||
- @blitzjs/generator@2.0.0-alpha.31
|
||||
|
||||
## 2.0.0-alpha.30
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- ce453683: init codemod generator
|
||||
- @blitzjs/generator@2.0.0-alpha.30
|
||||
|
||||
## 2.0.0-alpha.29
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- 962eb58a: detailed print env info
|
||||
- @blitzjs/generator@2.0.0-alpha.29
|
||||
|
||||
## 2.0.0-alpha.28
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- Updated dependencies [6ac2d341]
|
||||
- @blitzjs/generator@2.0.0-alpha.28
|
||||
|
||||
## 2.0.0-alpha.27
|
||||
|
||||
### Patch Changes
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "blitz",
|
||||
"version": "2.0.0-alpha.27",
|
||||
"version": "2.0.0-alpha.37",
|
||||
"scripts": {
|
||||
"build": "unbuild",
|
||||
"dev": "watch unbuild src --wait=0.2",
|
||||
@@ -23,7 +23,7 @@
|
||||
"blitz": "bin/blitz"
|
||||
},
|
||||
"dependencies": {
|
||||
"@blitzjs/generator": "2.0.0-alpha.27",
|
||||
"@blitzjs/generator": "2.0.0-alpha.37",
|
||||
"arg": "5.0.1",
|
||||
"chalk": "^4.1.0",
|
||||
"console-table-printer": "2.10.0",
|
||||
@@ -32,12 +32,14 @@
|
||||
"detect-port": "1.3.0",
|
||||
"dotenv": "16.0.0",
|
||||
"dotenv-expand": "8.0.3",
|
||||
"envinfo": "7.8.1",
|
||||
"esbuild": "0.14.34",
|
||||
"find-up": "4.1.0",
|
||||
"fs-extra": "10.0.1",
|
||||
"hasbin": "1.2.3",
|
||||
"npm-which": "3.0.1",
|
||||
"ora": "5.3.0",
|
||||
"os-name": "5.0.1",
|
||||
"p-event": "4.2.0",
|
||||
"pkg-dir": "5.0.0",
|
||||
"prompts": "2.4.2",
|
||||
@@ -50,11 +52,12 @@
|
||||
"watchpack": "2.1.1"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@blitzjs/config": "workspace:2.0.0-alpha.27",
|
||||
"@blitzjs/config": "workspace:2.0.0-alpha.37",
|
||||
"@types/cookie": "0.4.1",
|
||||
"@types/cross-spawn": "6.0.2",
|
||||
"@types/debug": "4.1.7",
|
||||
"@types/detect-port": "1.3.2",
|
||||
"@types/envinfo": "7.8.1",
|
||||
"@types/express": "4.17.13",
|
||||
"@types/fs-extra": "9.0.13",
|
||||
"@types/hasbin": "1.2.0",
|
||||
|
||||
@@ -295,7 +295,7 @@ const newApp: CliCommand = async (argv) => {
|
||||
|
||||
postInstallSteps.push("blitz dev")
|
||||
|
||||
console.log("Your new Blitz app is ready! Next steps:")
|
||||
console.log("\n Your new Blitz app is ready! Next steps:")
|
||||
postInstallSteps.forEach((step, index) => {
|
||||
console.log(chalk.yellow(` ${index + 1}. ${step}`))
|
||||
})
|
||||
|
||||
@@ -4,6 +4,10 @@ import packageJson from "../../package.json"
|
||||
import {loadEnvConfig} from "../env-utils"
|
||||
import {getCommandBin} from "./utils/config"
|
||||
import spawn from "cross-spawn"
|
||||
import {readdirSync} from "fs-extra"
|
||||
import resolveFrom from "resolve-from"
|
||||
import pkgDir from "pkg-dir"
|
||||
import {join} from "path"
|
||||
|
||||
const commonArgs = {
|
||||
// Types
|
||||
@@ -17,6 +21,9 @@ const commonArgs = {
|
||||
"-h": "--help",
|
||||
"-e": "--env",
|
||||
}
|
||||
const args = arg(commonArgs, {
|
||||
permissive: true,
|
||||
})
|
||||
|
||||
const defaultCommand = "dev"
|
||||
export type CliCommand = (argv?: string[]) => void
|
||||
@@ -29,84 +36,21 @@ const commands: {[command: string]: () => Promise<CliCommand>} = {
|
||||
codegen: () => import("./commands/codegen").then((i) => i.codegen),
|
||||
db: () => import("./commands/db").then((i) => i.db),
|
||||
}
|
||||
|
||||
const args = arg(commonArgs, {
|
||||
permissive: true,
|
||||
})
|
||||
|
||||
if (args["--env"]) {
|
||||
process.env.APP_ENV = args["--env"]
|
||||
}
|
||||
|
||||
loadEnvConfig(process.cwd(), undefined, {error: console.error, info: console.info})
|
||||
|
||||
// Version is inlined into the file using taskr build pipeline
|
||||
if (args["--version"]) {
|
||||
console.log(`Blitz.js v${packageJson.version}`)
|
||||
process.exit(0)
|
||||
}
|
||||
|
||||
const foundCommand = Boolean(commands[args._[0] as string])
|
||||
|
||||
const command = foundCommand ? (args._[0] as string) : defaultCommand
|
||||
const forwardedArgs = foundCommand ? args._.slice(1) : args._
|
||||
|
||||
if (args["--env"]) {
|
||||
process.env.APP_ENV = args["--env"]
|
||||
}
|
||||
const globalBlitzPath = resolveFrom(__dirname, "blitz")
|
||||
const localBlitzPath = resolveFrom.silent(process.cwd(), "blitz")
|
||||
|
||||
if (args["--help"]) {
|
||||
forwardedArgs.push("--help")
|
||||
}
|
||||
const isInDevelopmentAsGloballyLinked = __dirname.includes("packages/blitz/dist")
|
||||
|
||||
// env variable should default to dev unless the command is build or start
|
||||
const defaultEnv = command === "build" || command === "start" ? "production" : "development"
|
||||
|
||||
const standardEnv = ["production", "development", "test"]
|
||||
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
|
||||
|
||||
// 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]?.()
|
||||
.then((exec: any) => exec(forwardedArgs))
|
||||
.then(() => {
|
||||
if (command === "build") {
|
||||
// ensure process exits after build completes so open handles/connections
|
||||
// don't cause process to hang
|
||||
process.exit(0)
|
||||
}
|
||||
})
|
||||
.catch((err) => {
|
||||
console.log(err)
|
||||
})
|
||||
let blitzPkgPath
|
||||
if (isInDevelopmentAsGloballyLinked) {
|
||||
blitzPkgPath = globalBlitzPath
|
||||
} else {
|
||||
if (args["--help"] && args._.length === 0) {
|
||||
console.log(`
|
||||
Usage
|
||||
$ blitz <command>
|
||||
|
||||
Available commands
|
||||
${Object.keys(commands).join(", ")}
|
||||
|
||||
Options
|
||||
--env, -e App environment name
|
||||
--version, -v Version number
|
||||
--help, -h Displays this message
|
||||
|
||||
For more information run a command with the --help flag
|
||||
$ blitz build --help
|
||||
`)
|
||||
process.exit(0)
|
||||
} else {
|
||||
// If the command is not found, we assume it is a command from the bin
|
||||
void runCommandFromBin()
|
||||
}
|
||||
// localBlitzPath won't exist if used outside a blitz app directory
|
||||
blitzPkgPath = localBlitzPath || globalBlitzPath
|
||||
}
|
||||
|
||||
async function runCommandFromBin() {
|
||||
@@ -125,3 +69,122 @@ async function runCommandFromBin() {
|
||||
const result = spawn.sync(commandBin, process.argv.slice(3), {stdio: "inherit"})
|
||||
process.exit(result.status || 0)
|
||||
}
|
||||
|
||||
async function printEnvInfo() {
|
||||
const osName = await import("os-name")
|
||||
const envinfo = await import("envinfo")
|
||||
const pkgManager = readdirSync(process.cwd()).includes("pnpm-lock.yaml")
|
||||
? "pnpm"
|
||||
: readdirSync(process.cwd()).includes("yarn-lock.yaml")
|
||||
? "yarn"
|
||||
: "npm"
|
||||
|
||||
const env = await envinfo.default.run(
|
||||
{
|
||||
System: ["OS", "CPU", "Memory", "Shell"],
|
||||
Binaries: ["Node", "Yarn", "npm", "pnpm"],
|
||||
npmPackages: [
|
||||
"blitz",
|
||||
"typescript",
|
||||
"react",
|
||||
"react-dom",
|
||||
"prisma",
|
||||
"@prisma/client",
|
||||
"next",
|
||||
],
|
||||
},
|
||||
{showNotFound: true},
|
||||
)
|
||||
|
||||
const globalBlitzPkgJsonPath = pkgDir.sync(globalBlitzPath) as string
|
||||
const localBlitzPkgJsonPath = pkgDir.sync(localBlitzPath)
|
||||
|
||||
if (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)`)
|
||||
}
|
||||
|
||||
if (localBlitzPkgJsonPath) {
|
||||
const localVersion = require(join(localBlitzPkgJsonPath, "package.json")).version
|
||||
console.log(`Blitz version: ${localVersion} (local)`)
|
||||
}
|
||||
|
||||
console.log(
|
||||
`${osName.default()} | ${process.platform}-${process.arch} | Node: ${process.version}\n`,
|
||||
)
|
||||
console.log(`\n Package manager: ${pkgManager}`)
|
||||
console.log(env)
|
||||
process.exit(0)
|
||||
}
|
||||
|
||||
async function main() {
|
||||
loadEnvConfig(process.cwd(), undefined, {error: console.error, info: console.info})
|
||||
|
||||
// Version is inlined into the file using taskr build pipeline
|
||||
if (args["_"].length === 0 && args["--version"]) {
|
||||
await printEnvInfo()
|
||||
}
|
||||
|
||||
if (args["--env"]) {
|
||||
process.env.APP_ENV = args["--env"]
|
||||
}
|
||||
|
||||
if (args["--help"]) {
|
||||
forwardedArgs.push("--help")
|
||||
}
|
||||
|
||||
// env variable should default to dev unless the command is build or start
|
||||
const defaultEnv = command === "build" || command === "start" ? "production" : "development"
|
||||
|
||||
const standardEnv = ["production", "development", "test"]
|
||||
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
|
||||
|
||||
// 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]?.()
|
||||
.then((exec: any) => exec(forwardedArgs))
|
||||
.then(() => {
|
||||
if (command === "build") {
|
||||
// ensure process exits after build completes so open handles/connections
|
||||
// don't cause process to hang
|
||||
process.exit(0)
|
||||
}
|
||||
})
|
||||
.catch((err) => {
|
||||
console.log(err)
|
||||
})
|
||||
} else {
|
||||
if (args["--help"] && args._.length === 0) {
|
||||
console.log(`
|
||||
Usage
|
||||
$ blitz <command>
|
||||
|
||||
Available commands
|
||||
${Object.keys(commands).join(", ")}
|
||||
|
||||
Options
|
||||
--env, -e App environment name
|
||||
--version, -v Version number
|
||||
--help, -h Displays this message
|
||||
|
||||
For more information run a command with the --help flag
|
||||
$ blitz build --help
|
||||
`)
|
||||
process.exit(0)
|
||||
} else {
|
||||
// If the command is not found, we assume it is a command from the bin
|
||||
void runCommandFromBin()
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
main().catch((e) => {
|
||||
console.error(e)
|
||||
})
|
||||
|
||||
@@ -9,7 +9,7 @@ export * from "./types"
|
||||
export * from "./prisma-utils"
|
||||
export * from "./middleware"
|
||||
export * from "./paginate"
|
||||
export {baseLogger, newLine} from "./logging"
|
||||
export {baseLogger, newLine, log} from "./logging"
|
||||
export {startWatcher, stopWatcher} from "./cli/utils/routes-manifest"
|
||||
// const blitzConfig = findBlitzConfigDirectory() as string
|
||||
// const file = readFileSync(blitzConfig)
|
||||
@@ -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
|
||||
|
||||
@@ -149,6 +149,15 @@ const success = (msg: string) => {
|
||||
console.log(withCheck(c.green(msg)))
|
||||
}
|
||||
|
||||
/**
|
||||
* Logs a red error message to stdout.
|
||||
*
|
||||
* @param {string} msg
|
||||
*/
|
||||
const error = (msg: string) => {
|
||||
console.log(`${c.red(msg)}`)
|
||||
}
|
||||
|
||||
/**
|
||||
* Colorizes a variable for display.
|
||||
*
|
||||
@@ -173,6 +182,7 @@ export const log = {
|
||||
progress,
|
||||
spinner,
|
||||
success,
|
||||
error,
|
||||
variable,
|
||||
debug,
|
||||
Table,
|
||||
|
||||
@@ -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
packages/codemod/.eslintrc.js
Normal file
1
packages/codemod/.eslintrc.js
Normal file
@@ -0,0 +1 @@
|
||||
module.exports = require("@blitzjs/config/eslint")
|
||||
69
packages/codemod/CHANGELOG.md
Normal file
69
packages/codemod/CHANGELOG.md
Normal file
@@ -0,0 +1,69 @@
|
||||
# @blitzjs/codemod
|
||||
|
||||
## 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
|
||||
|
||||
- e6fb09d4: Fix templates source in RPC codemod step
|
||||
- @blitzjs/generator@2.0.0-alpha.32
|
||||
- blitz@2.0.0-alpha.32
|
||||
|
||||
## 2.0.0-alpha.31
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- 46d9f81a: Update templates directory for codemod
|
||||
- Updated dependencies [17ce29e5]
|
||||
- @blitzjs/generator@2.0.0-alpha.31
|
||||
- blitz@2.0.0-alpha.31
|
||||
|
||||
## 2.0.0-alpha.30
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- ce453683: Add codemod to upgrade from legacy framework to the Blitz Toolkit
|
||||
- ce453683: init codemod generator
|
||||
- Updated dependencies [ce453683]
|
||||
- blitz@2.0.0-alpha.30
|
||||
- @blitzjs/generator@2.0.0-alpha.30
|
||||
2
packages/codemod/bin/@blitzjs/codemod
Executable file
2
packages/codemod/bin/@blitzjs/codemod
Executable file
@@ -0,0 +1,2 @@
|
||||
#!/usr/bin/env node
|
||||
require("@blitzjs/codemod/dist/index.cjs")
|
||||
11
packages/codemod/build.config.ts
Normal file
11
packages/codemod/build.config.ts
Normal file
@@ -0,0 +1,11 @@
|
||||
import {BuildConfig} from "unbuild"
|
||||
|
||||
const config: BuildConfig = {
|
||||
entries: ["./src/index"],
|
||||
externals: ["index.cjs", "blitz"],
|
||||
declaration: true,
|
||||
rollup: {
|
||||
emitCJS: true,
|
||||
},
|
||||
}
|
||||
export default config
|
||||
51
packages/codemod/package.json
Normal file
51
packages/codemod/package.json
Normal file
@@ -0,0 +1,51 @@
|
||||
{
|
||||
"name": "@blitzjs/codemod",
|
||||
"version": "2.0.0-alpha.37",
|
||||
"scripts": {
|
||||
"build": "unbuild",
|
||||
"dev": "watch unbuild src --wait=0.2",
|
||||
"lint": "eslint . --fix",
|
||||
"test": "vitest run",
|
||||
"test-watch": "vitest",
|
||||
"clean": "rm -rf .turbo && rm -rf node_modules && rm -rf dist"
|
||||
},
|
||||
"main": "./dist/index.cjs",
|
||||
"module": "./dist/index.mjs",
|
||||
"browser": "./dist/index.mjs",
|
||||
"types": "./dist/index.d.ts",
|
||||
"sideEffects": false,
|
||||
"license": "MIT",
|
||||
"files": [
|
||||
"dist/**",
|
||||
"bin/**"
|
||||
],
|
||||
"bin": "bin/@blitzjs/codemod",
|
||||
"dependencies": {
|
||||
"@babel/core": "7.12.10",
|
||||
"@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.37",
|
||||
"arg": "5.0.1",
|
||||
"blitz": "2.0.0-alpha.37",
|
||||
"chalk": "^4.1.0",
|
||||
"cross-spawn": "7.0.3",
|
||||
"debug": "4.3.3",
|
||||
"esbuild": "0.14.34",
|
||||
"fs-extra": "10.0.1",
|
||||
"jscodeshift": "0.13.0",
|
||||
"prompts": "2.4.2"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@babel/preset-env": "7.12.10",
|
||||
"@blitzjs/config": "workspace:*",
|
||||
"@types/jscodeshift": "0.11.2",
|
||||
"@types/node": "17.0.16",
|
||||
"ast-types": "0.14.2",
|
||||
"unbuild": "0.6.9",
|
||||
"watch": "1.0.2"
|
||||
},
|
||||
"publishConfig": {
|
||||
"access": "public"
|
||||
}
|
||||
}
|
||||
9
packages/codemod/src/index.test.ts
Normal file
9
packages/codemod/src/index.test.ts
Normal file
@@ -0,0 +1,9 @@
|
||||
import {expect, describe, it} from "vitest"
|
||||
import spawn from "cross-spawn"
|
||||
|
||||
describe("codemod cli", () => {
|
||||
it("errors without codemod name", async () => {
|
||||
const run = spawn.sync("node", ["dist/index.cjs"], {encoding: "utf8"})
|
||||
expect(run.stdout).toContain("Codemod not found")
|
||||
})
|
||||
})
|
||||
31
packages/codemod/src/index.ts
Normal file
31
packages/codemod/src/index.ts
Normal file
@@ -0,0 +1,31 @@
|
||||
import arg from "arg"
|
||||
|
||||
const commonArgs = {
|
||||
// Types
|
||||
"--help": Boolean,
|
||||
|
||||
// Aliases
|
||||
"-h": "--help",
|
||||
}
|
||||
|
||||
const args = arg(commonArgs, {
|
||||
permissive: true,
|
||||
})
|
||||
|
||||
const commands: {[command: string]: () => Promise<() => void>} = {
|
||||
"upgrade-legacy": () => import("./upgrade-legacy").then((i) => i.upgradeLegacy),
|
||||
}
|
||||
|
||||
const foundCommand = Boolean(commands[args._[0] as string])
|
||||
const forwardedArgs = foundCommand ? args._.slice(1) : args._
|
||||
|
||||
if (foundCommand) {
|
||||
commands[args["_"][0] as string]?.()
|
||||
.then((exec: any) => exec(forwardedArgs))
|
||||
.catch((err) => {
|
||||
console.log(err)
|
||||
})
|
||||
} else {
|
||||
console.log("Codemod not found. Try one of these:")
|
||||
console.log(`${Object.keys(commands).map((c) => c)}`)
|
||||
}
|
||||
972
packages/codemod/src/upgrade-legacy.ts
Normal file
972
packages/codemod/src/upgrade-legacy.ts
Normal file
@@ -0,0 +1,972 @@
|
||||
import j, {ImportDeclaration} from "jscodeshift"
|
||||
import * as fs from "fs-extra"
|
||||
import path from "path"
|
||||
import {
|
||||
addNamedImport,
|
||||
findCallExpression,
|
||||
findDefaultExportPath,
|
||||
findFunction,
|
||||
findImport,
|
||||
findVariable,
|
||||
getAllFiles,
|
||||
getCollectionFromSource,
|
||||
wrapDeclaration,
|
||||
findIdentifier,
|
||||
} from "./utils"
|
||||
import {log} from "blitz"
|
||||
|
||||
const isInternalBlitzMonorepoDevelopment = fs.existsSync(
|
||||
path.join(__dirname, "../../../blitz-next"),
|
||||
)
|
||||
|
||||
const upgradeLegacy = async () => {
|
||||
let isTypescript = fs.existsSync(path.resolve("tsconfig.json"))
|
||||
let blitzConfigFile = `blitz.config.${isTypescript ? "ts" : "js"}`
|
||||
let isLegacyBlitz = fs.existsSync(path.resolve(blitzConfigFile))
|
||||
const appDir = path.resolve("app")
|
||||
let failedAt =
|
||||
fs.existsSync(path.resolve(".migration.json")) && fs.readJSONSync("./.migration.json").failedAt
|
||||
|
||||
let steps: {
|
||||
name: string
|
||||
action: () => Promise<void>
|
||||
}[] = []
|
||||
|
||||
// Add steps in order
|
||||
|
||||
steps.push({
|
||||
name: "move the config from blitz.config.ts to next.config.js",
|
||||
action: async () => {
|
||||
const program = getCollectionFromSource(blitzConfigFile)
|
||||
const parsedProgram = program.get()
|
||||
|
||||
// Clear file
|
||||
parsedProgram.value.program.body = []
|
||||
|
||||
// We create an object property eg. {withBlitz: withBlitz}
|
||||
let withBlitz = j.objectProperty(j.identifier("withBlitz"), j.identifier("withBlitz"))
|
||||
// Then set the shorthand to true so we get {withBlitz}
|
||||
withBlitz.shorthand = true
|
||||
|
||||
/* Declare the variable using the object above that equals to a require expression, eg.
|
||||
const {withBlitz} = require("@blitzjs/next")
|
||||
*/
|
||||
let blitzDeclare = j.variableDeclaration("const", [
|
||||
j.variableDeclarator(
|
||||
j.objectPattern([withBlitz]),
|
||||
j.callExpression(j.identifier("require"), [j.stringLiteral("@blitzjs/next")]),
|
||||
),
|
||||
])
|
||||
parsedProgram.value.program.body.push(blitzDeclare)
|
||||
|
||||
// Create the module.exports with the withBlitz callExpression and empty arguments. Giving us module.exports = withBlitz()
|
||||
let moduleExportExpression = j.expressionStatement(
|
||||
j.assignmentExpression(
|
||||
"=",
|
||||
j.memberExpression(j.identifier("module"), j.identifier("exports")),
|
||||
j.callExpression(j.identifier("withBlitz"), [
|
||||
j.objectExpression([j.objectProperty(j.identifier("blitz"), j.objectExpression([]))]),
|
||||
]),
|
||||
),
|
||||
)
|
||||
parsedProgram.value.program.body.push(moduleExportExpression)
|
||||
|
||||
fs.writeFileSync(path.resolve("next.config.js"), program.toSource())
|
||||
},
|
||||
})
|
||||
|
||||
steps.push({
|
||||
name: "update dependencies in package.json",
|
||||
action: async () => {
|
||||
let packageJsonPath = require(path.resolve("package.json"))
|
||||
packageJsonPath.dependencies["react"] = "latest"
|
||||
packageJsonPath.dependencies["react-dom"] = "latest"
|
||||
packageJsonPath.dependencies["@blitzjs/next"] = "alpha"
|
||||
packageJsonPath.dependencies["@blitzjs/rpc"] = "latest"
|
||||
packageJsonPath.dependencies["@blitzjs/auth"] = "latest"
|
||||
packageJsonPath.dependencies["blitz"] = "alpha"
|
||||
packageJsonPath.dependencies["next"] = "latest"
|
||||
packageJsonPath.dependencies["prisma"] = "latest"
|
||||
packageJsonPath.dependencies["@prisma/client"] = "latest"
|
||||
packageJsonPath.devDependencies["typescript"] = isTypescript && "latest"
|
||||
|
||||
fs.writeFileSync(path.resolve("package.json"), JSON.stringify(packageJsonPath, null, " "))
|
||||
},
|
||||
})
|
||||
|
||||
steps.push({
|
||||
name: "update project's imports",
|
||||
action: async () => {
|
||||
const specialImports: Record<string, string> = {
|
||||
Link: "next/link",
|
||||
Image: "next/image",
|
||||
Script: "next/script",
|
||||
|
||||
Document: "next/document",
|
||||
DocumentHead: "next/document",
|
||||
Html: "next/document",
|
||||
Main: "next/document",
|
||||
BlitzScript: "next/document",
|
||||
|
||||
AuthenticationError: "blitz",
|
||||
AuthorizationError: "blitz",
|
||||
CSRFTokenMismatchError: "blitz",
|
||||
NotFoundError: "blitz",
|
||||
formatZodError: "blitz",
|
||||
recursiveFormatZodErrors: "blitz",
|
||||
validateZodSchema: "blitz",
|
||||
enhancePrisma: "blitz",
|
||||
ErrorBoundary: "@blitzjs/next",
|
||||
ErrorFallbackProps: "@blitzjs/next",
|
||||
|
||||
paginate: "blitz",
|
||||
invokeWithMiddleware: "@blitzjs/rpc",
|
||||
passportAuth: "@blitzjs/auth",
|
||||
sessionMiddleware: "@blitzjs/auth",
|
||||
simpleRolesIsAuthorized: "@blitzjs/auth",
|
||||
getSession: "@blitzjs/auth",
|
||||
setPublicDataForUser: "@blitzjs/auth",
|
||||
SecurePassword: "@blitzjs/auth",
|
||||
hash256: "@blitzjs/auth",
|
||||
generateToken: "@blitzjs/auth",
|
||||
resolver: "@blitzjs/rpc",
|
||||
connectMiddleware: "blitz",
|
||||
GetServerSideProps: "next",
|
||||
InferGetServerSidePropsType: "next",
|
||||
GetServerSidePropsContext: "next",
|
||||
AuthenticatedMiddlewareCtx: "@blitz/rpc",
|
||||
getAntiCSRFToken: "@blitzjs/rpc",
|
||||
useSession: "@blitzjs/auth",
|
||||
useAuthenticatedSession: "@blitzjs/auth",
|
||||
useRedirectAuthenticated: "@blitzjs/auth",
|
||||
useAuthorize: "@blitzjs/auth",
|
||||
useQuery: "@blitzjs/rpc",
|
||||
useParam: "@blitzjs/next",
|
||||
usePaginatedQuery: "@blitzjs/rpc",
|
||||
useInfiniteQuery: "@blitzjs/rpc",
|
||||
useMutation: "@blitzjs/rpc",
|
||||
queryClient: "app/blitz-client",
|
||||
getQueryKey: "@blitzjs/rpc",
|
||||
getInfiniteQueryKey: "@blitzjs/rpc",
|
||||
invalidateQuery: "@blitzjs/rpc",
|
||||
setQueryData: "@blitzjs/rpc",
|
||||
useQueryErrorResetBoundary: "@blitzjs/rpc",
|
||||
QueryClient: "@blitzjs/rpc",
|
||||
dehydrate: "@blitzjs/rpc",
|
||||
invoke: "@blitzjs/rpc",
|
||||
Routes: "@blitzjs/next",
|
||||
useRouterQuery: "next/router",
|
||||
useRouter: "next/router",
|
||||
Router: "next/router",
|
||||
|
||||
Head: "next/head",
|
||||
|
||||
App: "next/app",
|
||||
|
||||
dynamic: "next/dynamic",
|
||||
noSSR: "next/dynamic",
|
||||
|
||||
getConfig: "next/config",
|
||||
setConfig: "next/config",
|
||||
|
||||
ErrorComponent: "@blitzjs/next",
|
||||
AppProps: "@blitzjs/next",
|
||||
BlitzPage: "@blitzjs/next",
|
||||
BlitzLayout: "@blitzjs/next",
|
||||
}
|
||||
|
||||
getAllFiles(appDir, [], [], [".ts", ".tsx", ".js", ".jsx"]).forEach((filename) => {
|
||||
const program = getCollectionFromSource(path.resolve(appDir, filename))
|
||||
const parsedProgram = program.get()
|
||||
|
||||
parsedProgram.value.program.body.forEach((e: ImportDeclaration) => {
|
||||
if (e.type === "ImportDeclaration") {
|
||||
if (e.source.value === "blitz") {
|
||||
const specifierIndexesToRemove: number[] = []
|
||||
e.specifiers?.slice().forEach((specifier: any, index) => {
|
||||
const importedName =
|
||||
specifier.imported.type === "StringLiteral"
|
||||
? specifier.imported.value
|
||||
: specifier.imported.name
|
||||
if (importedName in specialImports) {
|
||||
parsedProgram.value.program.body.unshift(
|
||||
j.importDeclaration(
|
||||
[specifier],
|
||||
j.stringLiteral(specialImports[importedName] as string),
|
||||
),
|
||||
)
|
||||
specifierIndexesToRemove.push(index)
|
||||
}
|
||||
})
|
||||
// Remove import from original blitz import deconstruct
|
||||
specifierIndexesToRemove.reverse().forEach((index) => {
|
||||
e.specifiers?.splice(index, 1)
|
||||
})
|
||||
// Removed left over "import 'blitz';"
|
||||
if (!e.specifiers?.length) {
|
||||
const index = parsedProgram.value.program.body.indexOf(e)
|
||||
parsedProgram.value.program.body.splice(index, 1)
|
||||
}
|
||||
}
|
||||
}
|
||||
})
|
||||
fs.writeFileSync(path.resolve(appDir, filename), program.toSource())
|
||||
})
|
||||
},
|
||||
})
|
||||
|
||||
steps.push({
|
||||
name: "update NextJS' default imports",
|
||||
action: async () => {
|
||||
getAllFiles(appDir, [], [], [".ts", ".tsx", ".js", ".jsx"]).forEach((file) => {
|
||||
const program = getCollectionFromSource(file)
|
||||
|
||||
const nextImage = findImport(program, "next/image")
|
||||
const nextLink = findImport(program, "next/link")
|
||||
const nextHead = findImport(program, "next/head")
|
||||
|
||||
if (nextImage?.length) {
|
||||
nextImage.remove()
|
||||
program
|
||||
.get()
|
||||
.value.program.body.unshift(
|
||||
j.importDeclaration(
|
||||
[j.importDefaultSpecifier(j.identifier("Image"))],
|
||||
j.stringLiteral("next/image"),
|
||||
),
|
||||
)
|
||||
}
|
||||
|
||||
if (nextLink?.length) {
|
||||
nextLink.remove()
|
||||
program
|
||||
.get()
|
||||
.value.program.body.unshift(
|
||||
j.importDeclaration(
|
||||
[j.importDefaultSpecifier(j.identifier("Link"))],
|
||||
j.stringLiteral("next/link"),
|
||||
),
|
||||
)
|
||||
}
|
||||
|
||||
if (nextHead?.length) {
|
||||
nextHead.remove()
|
||||
program
|
||||
.get()
|
||||
.value.program.body.unshift(
|
||||
j.importDeclaration(
|
||||
[j.importDefaultSpecifier(j.identifier("Head"))],
|
||||
j.stringLiteral("next/head"),
|
||||
),
|
||||
)
|
||||
}
|
||||
|
||||
fs.writeFileSync(path.join(path.resolve(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 () => {
|
||||
let appDirExist = fs.existsSync(appDir)
|
||||
|
||||
if (appDirExist) {
|
||||
const templatePath = path.join(
|
||||
require.resolve("@blitzjs/generator"),
|
||||
"..",
|
||||
"..",
|
||||
isInternalBlitzMonorepoDevelopment ? "templates" : "dist/templates",
|
||||
)
|
||||
const blitzServer = fs
|
||||
.readFileSync(path.join(templatePath, "app", "app", "blitz-server.ts"))
|
||||
.toString()
|
||||
const blitzClient = fs
|
||||
.readFileSync(path.join(templatePath, "app", "app", "blitz-client.ts"))
|
||||
.toString()
|
||||
|
||||
const replaceTemplateValues = (input: string) => {
|
||||
let result = input
|
||||
const token = `__safeNameSlug__`
|
||||
if (result.includes(token)) {
|
||||
result = result.replace(new RegExp(token, "g"), "blitz")
|
||||
}
|
||||
return result
|
||||
}
|
||||
|
||||
fs.writeFileSync(
|
||||
`${appDir}/blitz-server.${isTypescript ? "ts" : "js"}`,
|
||||
replaceTemplateValues(blitzServer),
|
||||
)
|
||||
|
||||
fs.writeFileSync(
|
||||
`${appDir}/blitz-client.${isTypescript ? "ts" : "js"}`,
|
||||
replaceTemplateValues(blitzClient),
|
||||
)
|
||||
} else {
|
||||
throw new Error("App directory doesn't exit")
|
||||
}
|
||||
},
|
||||
})
|
||||
|
||||
steps.push({
|
||||
name: "create pages/api/rpc directory and add [[...blitz]].ts wildecard API route",
|
||||
action: async () => {
|
||||
const pagesDir = path.resolve("pages/api/rpc")
|
||||
const templatePath = path.join(
|
||||
require.resolve("@blitzjs/generator"),
|
||||
"..",
|
||||
"..",
|
||||
isInternalBlitzMonorepoDevelopment ? "templates" : "dist/templates",
|
||||
)
|
||||
const rpcRoute = fs
|
||||
.readFileSync(path.join(templatePath, "app", "pages", "api", "rpc", "blitzrpcroute.ts"))
|
||||
.toString()
|
||||
|
||||
if (!fs.existsSync(pagesDir)) {
|
||||
fs.mkdirSync(pagesDir, {recursive: true})
|
||||
}
|
||||
|
||||
fs.writeFileSync(
|
||||
path.resolve(`${pagesDir}/[[...blitz]].${isTypescript ? "ts" : "js"}`),
|
||||
rpcRoute,
|
||||
)
|
||||
},
|
||||
})
|
||||
|
||||
steps.push({
|
||||
name: "move app/pages/ to the project root pages/ directory",
|
||||
action: async () => {
|
||||
const appDir = path.resolve("app")
|
||||
const subdirs = fs.readdirSync(appDir)
|
||||
|
||||
if (subdirs.includes("pages")) {
|
||||
const appPagesDir = fs.readdirSync(path.join(appDir, "pages"))
|
||||
appPagesDir.forEach((dir) => {
|
||||
fs.moveSync(
|
||||
path.resolve(path.join(appDir, "pages", dir)),
|
||||
path.resolve(path.join("pages", dir)),
|
||||
)
|
||||
})
|
||||
}
|
||||
|
||||
// Remove pages dir from the app dir after move is complete
|
||||
fs.removeSync(path.join(appDir, "pages"))
|
||||
},
|
||||
})
|
||||
|
||||
steps.push({
|
||||
name: "remove Babel config file",
|
||||
action: async () => {
|
||||
const babelConfig = fs.existsSync(path.resolve("babel.config.js"))
|
||||
if (babelConfig) {
|
||||
fs.removeSync(path.resolve("babel.config.js"))
|
||||
}
|
||||
},
|
||||
})
|
||||
|
||||
steps.push({
|
||||
name: "move all pages directories to one consolidated directory",
|
||||
action: async () => {
|
||||
const getAllPagesDirs = (dirPath: string) => {
|
||||
let files = fs.readdirSync(dirPath)
|
||||
|
||||
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 pageDir
|
||||
}
|
||||
|
||||
getAllPagesDirs(appDir).forEach((pages, index) => {
|
||||
if (pages.subModel) {
|
||||
fs.moveSync(pages.path, path.join(path.resolve("pages"), pages.model, pages.subModel))
|
||||
} else {
|
||||
fs.moveSync(pages.path, path.join(path.resolve("pages"), pages.model))
|
||||
}
|
||||
|
||||
// Delete left over pages directory
|
||||
let subs = fs.readdirSync(path.join(appDir, pages.model))
|
||||
// We can only delete a directory once 😅
|
||||
if (
|
||||
getAllPagesDirs(appDir)[index - 1]?.model !== getAllPagesDirs(appDir)[index]?.model &&
|
||||
index === getAllPagesDirs(appDir).length &&
|
||||
subs.includes("pages")
|
||||
) {
|
||||
fs.removeSync(path.join(appDir, pages.model, "pages"))
|
||||
}
|
||||
})
|
||||
},
|
||||
})
|
||||
|
||||
steps.push({
|
||||
name: "move API routes to pages/api directory",
|
||||
action: async () => {
|
||||
const apiRoutesExist = fs.existsSync(path.join(appDir, "api"))
|
||||
if (apiRoutesExist) {
|
||||
let apiRoutes = fs.readdirSync(path.join(appDir, "api"))
|
||||
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))
|
||||
}
|
||||
})
|
||||
}
|
||||
},
|
||||
})
|
||||
|
||||
steps.push({
|
||||
name: "update custom server to reference Next",
|
||||
action: async () => {
|
||||
const customServerDir = path.resolve("server")
|
||||
const customServerFile = path.resolve(`server.${isTypescript ? "ts" : "js"}`)
|
||||
|
||||
// If custom server is inside "server" dir
|
||||
if (fs.existsSync(customServerDir)) {
|
||||
if (fs.readdirSync("server").includes(`index.${isTypescript ? "ts" : "js"}`)) {
|
||||
const program = getCollectionFromSource(
|
||||
path.join("server", `index.${isTypescript ? "ts" : "js"}`),
|
||||
)
|
||||
|
||||
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 ${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) {
|
||||
case "callee":
|
||||
hit.value.name = "next"
|
||||
case "id":
|
||||
hit.value.name = "next"
|
||||
case "local":
|
||||
hit.value.name = "next"
|
||||
}
|
||||
})
|
||||
fs.writeFileSync(customServerFile, program.toSource())
|
||||
}
|
||||
}
|
||||
},
|
||||
})
|
||||
|
||||
steps.push({
|
||||
name: "convert useRouterQuery to useRouter",
|
||||
action: async () => {
|
||||
//First check ./pages
|
||||
const pagesDir = path.resolve("pages")
|
||||
getAllFiles(pagesDir, [], [], [".ts", ".tsx", ".js", ".jsx"]).forEach((file) => {
|
||||
const filepath = path.resolve(pagesDir, file)
|
||||
const program = getCollectionFromSource(filepath)
|
||||
|
||||
const parsedProgram = program.get()
|
||||
|
||||
const findRouterQueryImport = findImport(program, "next/router")
|
||||
findRouterQueryImport?.forEach((node) => {
|
||||
const getNode = node.get()
|
||||
getNode.value.specifiers.slice().forEach((specifier: any, index: number) => {
|
||||
const importedName =
|
||||
specifier.imported.type === "StringLiteral"
|
||||
? specifier.imported.value
|
||||
: specifier.imported.name
|
||||
if (importedName === "useRouterQuery") {
|
||||
addNamedImport(program, "useRouter", "next/router")
|
||||
getNode.value.specifiers.splice(index, 1)
|
||||
// Removed left overs
|
||||
if (!getNode.value.specifiers?.length) {
|
||||
const index = parsedProgram.value.program.body.indexOf(getNode.value)
|
||||
parsedProgram.value.program.body.splice(index, 1)
|
||||
}
|
||||
}
|
||||
})
|
||||
})
|
||||
|
||||
const findCallUseRouterQuery = program.find(
|
||||
j.CallExpression,
|
||||
(node) => node.callee.name === "useRouterQuery",
|
||||
)
|
||||
findCallUseRouterQuery.forEach((call) => {
|
||||
const nodePath = call.get()
|
||||
nodePath.parentPath.value.init = j.expressionStatement(
|
||||
j.memberExpression(
|
||||
j.callExpression(j.identifier("useRouter"), []),
|
||||
j.identifier("query"),
|
||||
),
|
||||
)
|
||||
})
|
||||
|
||||
fs.writeFileSync(filepath, program.toSource())
|
||||
})
|
||||
|
||||
getAllFiles(appDir, [], [], [".ts", ".tsx", ".js", ".jsx"]).forEach((file) => {
|
||||
const filepath = path.resolve(appDir, file)
|
||||
const program = getCollectionFromSource(filepath)
|
||||
|
||||
const parsedProgram = program.get()
|
||||
const findRouterQueryImport = program.find(
|
||||
j.ImportDeclaration,
|
||||
(node) => node.source.value === "next/router",
|
||||
)
|
||||
findRouterQueryImport.forEach((node) => {
|
||||
const getNode = node.get()
|
||||
getNode.value.specifiers.slice().forEach((specifier: any, index: number) => {
|
||||
const importedName =
|
||||
specifier.imported.type === "StringLiteral"
|
||||
? specifier.imported.value
|
||||
: specifier.imported.name
|
||||
if (importedName === "useRouterQuery") {
|
||||
parsedProgram.value.program.body.unshift(
|
||||
j.importDeclaration(
|
||||
[j.importSpecifier(j.identifier("useRouter"))],
|
||||
j.stringLiteral("next/router"),
|
||||
),
|
||||
)
|
||||
getNode.value.specifiers.splice(index, 1)
|
||||
// Removed left overs
|
||||
if (!getNode.value.specifiers?.length) {
|
||||
const index = parsedProgram.value.program.body.indexOf(getNode.value)
|
||||
parsedProgram.value.program.body.splice(index, 1)
|
||||
}
|
||||
}
|
||||
})
|
||||
})
|
||||
|
||||
const findCallUseRouterQuery = program.find(
|
||||
j.CallExpression,
|
||||
(node) => node.callee.name === "useRouterQuery",
|
||||
)
|
||||
findCallUseRouterQuery.forEach((call) => {
|
||||
const nodePath = call.get()
|
||||
nodePath.parentPath.value.init = j.expressionStatement(
|
||||
j.memberExpression(
|
||||
j.callExpression(j.identifier("useRouter"), []),
|
||||
j.identifier("query"),
|
||||
),
|
||||
)
|
||||
})
|
||||
|
||||
fs.writeFileSync(filepath, program.toSource())
|
||||
})
|
||||
},
|
||||
})
|
||||
|
||||
steps.push({
|
||||
name: "wrap App component with withBlitz HOC",
|
||||
action: async () => {
|
||||
const pagesDir = path.resolve("pages")
|
||||
|
||||
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}
|
||||
|
||||
// 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)
|
||||
|
||||
addNamedImport(program, "withBlitz", "app/blitz-client")
|
||||
|
||||
fs.writeFileSync(
|
||||
path.join(pagesDir, `_app.${isTypescript ? "tsx" : "jsx"}`),
|
||||
program.toSource(),
|
||||
)
|
||||
},
|
||||
})
|
||||
|
||||
steps.push({
|
||||
name: "update imports in the _document file",
|
||||
action: async () => {
|
||||
const pagesDir = path.resolve("pages")
|
||||
|
||||
if (fs.existsSync(path.join(pagesDir, `_document.${isTypescript ? "tsx" : "jsx"}`))) {
|
||||
const program = getCollectionFromSource(
|
||||
path.join(pagesDir, `_document.${isTypescript ? "tsx" : "jsx"}`),
|
||||
)
|
||||
|
||||
const importStatements = findImport(program, "next/document")
|
||||
importStatements?.remove()
|
||||
program
|
||||
.get()
|
||||
.value.program.body.unshift(
|
||||
j.importDeclaration(
|
||||
[
|
||||
j.importDefaultSpecifier(j.identifier("Document")),
|
||||
j.importSpecifier(j.identifier("Html")),
|
||||
j.importSpecifier(j.identifier("Head")),
|
||||
j.importSpecifier(j.identifier("Main")),
|
||||
j.importSpecifier(j.identifier("NextScript")),
|
||||
],
|
||||
j.stringLiteral("next/document"),
|
||||
),
|
||||
)
|
||||
|
||||
const documentHead = program
|
||||
.find(j.Identifier, (node) => node.name === "DocumentHead")
|
||||
.get()
|
||||
documentHead.value.name = "Head"
|
||||
|
||||
const blitzScript = program.find(j.Identifier, (node) => node.name === "BlitzScript").get()
|
||||
blitzScript.value.name = "NextScript"
|
||||
|
||||
fs.writeFileSync(
|
||||
path.join(pagesDir, `_document.${isTypescript ? "tsx" : "jsx"}`),
|
||||
program.toSource(),
|
||||
)
|
||||
}
|
||||
},
|
||||
})
|
||||
|
||||
steps.push({
|
||||
name: "wrap getServerSideProps, getStaticProps and API handlers with gSSP, gSP, and api",
|
||||
action: async () => {
|
||||
const pagesDir = path.resolve("pages")
|
||||
getAllFiles(pagesDir, [], ["api"], [".ts", ".tsx", ".js", ".jsx"]).forEach((file) => {
|
||||
const program = getCollectionFromSource(file)
|
||||
|
||||
// 1. getServerSideProps
|
||||
const getServerSidePropsPath = findFunction(program, "getServerSideProps")
|
||||
if (getServerSidePropsPath) {
|
||||
getServerSidePropsPath.forEach((path) =>
|
||||
wrapDeclaration(path, "getServerSideProps", "gSSP"),
|
||||
)
|
||||
addNamedImport(program, "gSSP", "app/blitz-server")
|
||||
}
|
||||
|
||||
// 2. getStaticProps
|
||||
const getStaticPropsPath = findFunction(program, "getStaticProps")
|
||||
if (getStaticPropsPath) {
|
||||
getStaticPropsPath.forEach((path) => wrapDeclaration(path, "getStaticProps", "gSP"))
|
||||
addNamedImport(program, "gSP", "app/blitz-server")
|
||||
}
|
||||
|
||||
fs.writeFileSync(path.join(path.resolve(file)), program.toSource())
|
||||
})
|
||||
|
||||
// 3. api
|
||||
if (fs.existsSync(path.join(pagesDir, "api"))) {
|
||||
getAllFiles(
|
||||
path.join(pagesDir, "api"),
|
||||
[],
|
||||
["rpc"],
|
||||
[".ts", ".tsx", ".js", ".jsx"],
|
||||
).forEach((file) => {
|
||||
const program = getCollectionFromSource(file)
|
||||
|
||||
const defaultExportPath = findDefaultExportPath(program)
|
||||
if (!defaultExportPath) {
|
||||
return
|
||||
}
|
||||
|
||||
const {node} = defaultExportPath
|
||||
node.declaration = j.callExpression(j.identifier("api"), [node.declaration as any])
|
||||
addNamedImport(program, "api", "app/blitz-server")
|
||||
|
||||
fs.writeFileSync(path.join(path.resolve(file)), program.toSource())
|
||||
})
|
||||
}
|
||||
},
|
||||
})
|
||||
|
||||
steps.push({
|
||||
name: "check for usages of a local middleware in resolvers files",
|
||||
action: async () => {
|
||||
let errors = 0
|
||||
|
||||
getAllFiles(appDir, [], ["components"], [".ts", ".tsx", ".js", ".jsx"]).forEach((file) => {
|
||||
const program = getCollectionFromSource(file)
|
||||
const middlewarePath = findVariable(program, "middleware")
|
||||
if (middlewarePath?.length) {
|
||||
console.error(`Local middleware found at ${file}`)
|
||||
errors++
|
||||
}
|
||||
})
|
||||
|
||||
if (errors > 0) {
|
||||
throw new Error("Local middleware is not supported")
|
||||
}
|
||||
},
|
||||
})
|
||||
|
||||
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, [], [], [".ts", ".tsx", ".js", ".jsx"]).forEach((file) => {
|
||||
const program = getCollectionFromSource(file)
|
||||
const invokeWithMiddlewarePath = findCallExpression(program, "invokeWithMiddleware")
|
||||
if (invokeWithMiddlewarePath?.length) {
|
||||
log.error(`\n invokeWithMiddleware found at ${file}. \n`)
|
||||
errors++
|
||||
}
|
||||
})
|
||||
|
||||
getAllFiles(path.resolve("pages"), [], [], [".ts", ".tsx", ".js", ".jsx"]).forEach((file) => {
|
||||
const program = getCollectionFromSource(file)
|
||||
const invokeWithMiddlewarePath = findCallExpression(program, "invokeWithMiddleware")
|
||||
if (invokeWithMiddlewarePath?.length) {
|
||||
log.error(`\n invokeWithMiddleware found at ${file}. \n`)
|
||||
errors++
|
||||
}
|
||||
})
|
||||
|
||||
if (errors > 0) {
|
||||
throw new Error(
|
||||
"\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.",
|
||||
)
|
||||
}
|
||||
},
|
||||
})
|
||||
|
||||
// steps.push({
|
||||
// name: "Update invokeMiddleware to invoke",
|
||||
// action: async () => {
|
||||
// getAllFiles(appDir, [], [], [".css"]).forEach((file) => {
|
||||
// const program = getCollectionFromSource(file)
|
||||
// const importSpecifier = findImportSpecifier(program, "invokeWithMiddleware")
|
||||
// importSpecifier?.paths().forEach((path) => {
|
||||
// path.get().value.imported.name = "invoke"
|
||||
// })
|
||||
|
||||
// const invokeWithMiddlewarePath = findCallExpression(program, "invokeWithMiddleware")
|
||||
// if (invokeWithMiddlewarePath?.length) {
|
||||
// invokeWithMiddlewarePath?.paths().forEach((path) => {
|
||||
// path.get().value.callee.name = "invoke"
|
||||
// if (path.get().value.arguments.length === 3) {
|
||||
// delete path.get().value.arguments[2]
|
||||
// }
|
||||
// })
|
||||
// }
|
||||
|
||||
// fs.writeFileSync(path.resolve(file), program.toSource())
|
||||
// })
|
||||
|
||||
// getAllFiles(path.resolve("pages"), [], [], [".css"]).forEach((file) => {
|
||||
// const program = getCollectionFromSource(file)
|
||||
// const importSpecifier = findImportSpecifier(program, "invokeWithMiddleware")
|
||||
// importSpecifier?.paths().forEach((path) => {
|
||||
// path.get().value.imported.name = "invoke"
|
||||
// })
|
||||
|
||||
// const invokeWithMiddlewarePath = findCallExpression(program, "invokeWithMiddleware")
|
||||
// if (invokeWithMiddlewarePath?.length) {
|
||||
// invokeWithMiddlewarePath?.paths().forEach((path) => {
|
||||
// path.get().value.callee.name = "invoke"
|
||||
// if (path.get().value.arguments.length === 3) {
|
||||
// delete path.get().value.arguments[2]
|
||||
// }
|
||||
// })
|
||||
// }
|
||||
|
||||
// fs.writeFileSync(path.resolve(file), program.toSource())
|
||||
// })
|
||||
// },
|
||||
// })
|
||||
|
||||
// Loop through steps and run the action
|
||||
if ((failedAt && failedAt < steps.length) || failedAt !== "SUCCESS" || isLegacyBlitz) {
|
||||
for (let [index, step] of steps.entries()) {
|
||||
// Ignore previous steps and continue at step that was failed
|
||||
if (failedAt && index + 1 < failedAt) {
|
||||
continue
|
||||
}
|
||||
const spinner = log.spinner(log.withBrand(`Running ${step.name}...`)).start()
|
||||
try {
|
||||
await step.action()
|
||||
} catch (err) {
|
||||
spinner.fail(`${step.name}`)
|
||||
log.error(err as string)
|
||||
failedAt = index + 1
|
||||
fs.writeJsonSync(".migration.json", {
|
||||
failedAt,
|
||||
})
|
||||
process.exit(1)
|
||||
}
|
||||
|
||||
spinner.succeed(`Successfully ran ${step.name}`)
|
||||
}
|
||||
|
||||
fs.writeJsonSync(".migration.json", {
|
||||
failedAt: "SUCCESS",
|
||||
})
|
||||
} else {
|
||||
if (failedAt === "SUCCESS") {
|
||||
log.withBrand("Migration already successful")
|
||||
process.exit(0)
|
||||
}
|
||||
log.error("Legacy blitz config file not found")
|
||||
}
|
||||
}
|
||||
|
||||
export {upgradeLegacy}
|
||||
243
packages/codemod/src/utils.ts
Normal file
243
packages/codemod/src/utils.ts
Normal file
@@ -0,0 +1,243 @@
|
||||
import path from "path"
|
||||
import * as fs from "fs-extra"
|
||||
import j, {
|
||||
ASTPath,
|
||||
Collection,
|
||||
FunctionDeclaration,
|
||||
VariableDeclaration,
|
||||
ExportDefaultDeclaration,
|
||||
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,
|
||||
): Collection<FunctionDeclaration> | Collection<VariableDeclaration> | null {
|
||||
const funcDeclaration = program.find(
|
||||
j.FunctionDeclaration,
|
||||
(node) => node.id.name === declarationName,
|
||||
)
|
||||
|
||||
const constDeclaration = program.find(
|
||||
j.VariableDeclaration,
|
||||
(node) => node.declarations[0].id.name === declarationName,
|
||||
)
|
||||
|
||||
const paths = funcDeclaration.length
|
||||
? funcDeclaration
|
||||
: constDeclaration.length
|
||||
? constDeclaration
|
||||
: null
|
||||
|
||||
return paths
|
||||
}
|
||||
|
||||
export function findVariable(
|
||||
program: Collection<any>,
|
||||
declarationName: string,
|
||||
): Collection<VariableDeclaration> | null {
|
||||
const constDeclaration = program.find(
|
||||
j.VariableDeclaration,
|
||||
(node) => node.declarations[0].id.name === declarationName,
|
||||
)
|
||||
|
||||
const paths = constDeclaration.length ? constDeclaration : null
|
||||
|
||||
return paths
|
||||
}
|
||||
|
||||
export function findImport(
|
||||
program: Collection<any>,
|
||||
declarationName: string,
|
||||
): Collection<ImportDeclaration> | null {
|
||||
const importDeclaration = program.find(
|
||||
j.ImportDeclaration,
|
||||
(node) => node.source.value === declarationName,
|
||||
)
|
||||
|
||||
const paths = importDeclaration.length ? importDeclaration : null
|
||||
|
||||
return paths
|
||||
}
|
||||
|
||||
export function findImportSpecifier(
|
||||
program: Collection<any>,
|
||||
declarationName: string,
|
||||
): Collection<ImportSpecifier> | null {
|
||||
const importSpecifier = program.find(
|
||||
j.ImportSpecifier,
|
||||
(node) => node.imported.name === declarationName,
|
||||
)
|
||||
|
||||
const paths = importSpecifier.length ? importSpecifier : null
|
||||
|
||||
return paths
|
||||
}
|
||||
|
||||
export function findCallExpression(
|
||||
program: Collection<any>,
|
||||
declarationName: string,
|
||||
): Collection<CallExpression> | null {
|
||||
const callExpression = program.find(
|
||||
j.CallExpression,
|
||||
(node) => node.callee.name === declarationName,
|
||||
)
|
||||
|
||||
const paths = callExpression.length ? callExpression : null
|
||||
|
||||
return paths
|
||||
}
|
||||
|
||||
export function findDefaultExportPath(
|
||||
program: Collection<any>,
|
||||
): ASTPath<ExportDefaultDeclaration> | null | undefined {
|
||||
const defaultDeclaration = program.find(j.ExportDefaultDeclaration)
|
||||
return defaultDeclaration.length ? defaultDeclaration.paths()[0] : null
|
||||
}
|
||||
|
||||
export function wrapDeclaration(
|
||||
path: ASTPath<FunctionDeclaration> | ASTPath<VariableDeclaration>,
|
||||
declaration: string,
|
||||
wrapper: string,
|
||||
) {
|
||||
if (path.node.type === "FunctionDeclaration") {
|
||||
// CASE 1
|
||||
// function myFunction()
|
||||
// TURNS INTO
|
||||
// const myFunction = wrapper(function myFunction () {})
|
||||
path.replace(
|
||||
j.variableDeclaration("const", [
|
||||
j.variableDeclarator(
|
||||
j.identifier(declaration),
|
||||
j.callExpression(j.identifier(wrapper), [
|
||||
j.functionExpression.from({
|
||||
id: path.node.id,
|
||||
async: path.node.async,
|
||||
body: path.node.body,
|
||||
params: path.node.params,
|
||||
typeParameters: path.node.typeParameters,
|
||||
defaults: path.node.defaults,
|
||||
expression: path.node.expression,
|
||||
generator: path.node.generator,
|
||||
returnType: path.node.returnType,
|
||||
rest: path.node.rest,
|
||||
comments: path.node.comments ?? null,
|
||||
}),
|
||||
]),
|
||||
),
|
||||
]),
|
||||
)
|
||||
} else if (path.node.type === "VariableDeclaration") {
|
||||
// CASE 2
|
||||
// const myFunction = () => {}
|
||||
// TURNS INTO
|
||||
// const myFunction = gSSP(() => {})
|
||||
for (const declaration of path.node.declarations) {
|
||||
if (declaration.type === "VariableDeclarator" && declaration.init) {
|
||||
const init = declaration.init
|
||||
|
||||
// Running the codemod twice should not wrap in `gSSP` twice.
|
||||
if (
|
||||
init.type === "CallExpression" &&
|
||||
init.callee.type === "Identifier" &&
|
||||
init.callee.name === wrapper
|
||||
) {
|
||||
// For 100% confidence, we could probably check if gSSP is imported from Blitz here
|
||||
// but this codemod adds the gSSP import.
|
||||
continue
|
||||
}
|
||||
|
||||
declaration.init = j.callExpression(j.identifier(wrapper), [init])
|
||||
|
||||
break
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
export function addNamedImport(
|
||||
program: Collection<any>,
|
||||
importStatement: string,
|
||||
importFrom: string,
|
||||
defaultSpecifier?: boolean,
|
||||
) {
|
||||
const existingImport = program.find(
|
||||
j.ImportDeclaration,
|
||||
(node) => node.source.value === importFrom,
|
||||
)
|
||||
|
||||
if (existingImport.length) {
|
||||
existingImport.get().value.specifiers.push(j.importSpecifier(j.identifier(importStatement)))
|
||||
} else {
|
||||
program
|
||||
.get()
|
||||
.value.program.body.unshift(
|
||||
defaultSpecifier
|
||||
? j.importDeclaration(
|
||||
[j.importDefaultSpecifier(j.identifier(importStatement))],
|
||||
j.stringLiteral(importFrom),
|
||||
)
|
||||
: j.importDeclaration(
|
||||
[j.importSpecifier(j.identifier(importStatement))],
|
||||
j.stringLiteral(importFrom),
|
||||
),
|
||||
)
|
||||
}
|
||||
}
|
||||
|
||||
export function getAllFiles(
|
||||
dirPath: string,
|
||||
accFiles: string[] = [],
|
||||
skipDirs?: 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, allowedExt)
|
||||
}
|
||||
} else {
|
||||
if (allowedExt?.length) {
|
||||
if (allowedExt?.includes(path.extname(file))) {
|
||||
accFiles.push(path.join(dirPath, "/", file))
|
||||
}
|
||||
} else {
|
||||
accFiles.push(path.join(dirPath, "/", file))
|
||||
}
|
||||
}
|
||||
})
|
||||
return accFiles
|
||||
}
|
||||
|
||||
export function getCollectionFromSource(filename: string) {
|
||||
const fileSource = fs.readFileSync(path.resolve(filename), {encoding: "utf-8"})
|
||||
return j(fileSource, {
|
||||
parser: {
|
||||
parse: (source: string) =>
|
||||
parseSync(source, {
|
||||
configFile: false,
|
||||
plugins: [require(`@babel/plugin-syntax-jsx`)],
|
||||
overrides: [
|
||||
{
|
||||
test: [`**/*.ts`, `**/*.tsx`],
|
||||
plugins: [[require(`@babel/plugin-syntax-typescript`), {isTSX: true}]],
|
||||
},
|
||||
],
|
||||
filename,
|
||||
parserOpts: {
|
||||
tokens: true, // recast uses this
|
||||
},
|
||||
}),
|
||||
},
|
||||
})
|
||||
}
|
||||
10
packages/codemod/tsconfig.json
Normal file
10
packages/codemod/tsconfig.json
Normal file
@@ -0,0 +1,10 @@
|
||||
{
|
||||
"extends": "@blitzjs/config/tsconfig.library.json",
|
||||
"compilerOptions": {
|
||||
"lib": ["DOM", "ES2015"],
|
||||
"esModuleInterop": true,
|
||||
"resolveJsonModule": true
|
||||
},
|
||||
"include": ["."],
|
||||
"exclude": ["dist", "build", "node_modules"]
|
||||
}
|
||||
@@ -1,5 +1,25 @@
|
||||
# @blitzjs/config
|
||||
|
||||
## 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
|
||||
|
||||
## 2.0.0-alpha.30
|
||||
|
||||
## 2.0.0-alpha.29
|
||||
|
||||
## 2.0.0-alpha.28
|
||||
|
||||
## 2.0.0-alpha.27
|
||||
|
||||
## 2.0.0-alpha.26
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
{
|
||||
"name": "@blitzjs/config",
|
||||
"private": true,
|
||||
"version": "2.0.0-alpha.27",
|
||||
"version": "2.0.0-alpha.37",
|
||||
"license": "MIT",
|
||||
"dependencies": {
|
||||
"@typescript-eslint/eslint-plugin": "5.9.1",
|
||||
|
||||
@@ -1,5 +1,41 @@
|
||||
# @blitzjs/generator
|
||||
|
||||
## 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
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- 17ce29e5: Update RPC plugin setup in templates
|
||||
|
||||
## 2.0.0-alpha.30
|
||||
|
||||
## 2.0.0-alpha.29
|
||||
|
||||
## 2.0.0-alpha.28
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- 6ac2d341: updated nextjs version in generator & npmrc file
|
||||
|
||||
## 2.0.0-alpha.27
|
||||
|
||||
## 2.0.0-alpha.26
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "@blitzjs/generator",
|
||||
"version": "2.0.0-alpha.27",
|
||||
"version": "2.0.0-alpha.37",
|
||||
"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.27",
|
||||
"@blitzjs/config": "2.0.0-alpha.37",
|
||||
"@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,17 +2,11 @@ import { AuthClientPlugin } from "@blitzjs/auth"
|
||||
import { setupBlitzClient } from "@blitzjs/next"
|
||||
import { BlitzRpcPlugin } from "@blitzjs/rpc"
|
||||
|
||||
export const { withBlitz } = setupBlitzClient({
|
||||
export const { withBlitz, queryClient } = setupBlitzClient({
|
||||
plugins: [
|
||||
AuthClientPlugin({
|
||||
cookiePrefix: "__safeNameSlug__-cookie-prefix",
|
||||
}),
|
||||
BlitzRpcPlugin({
|
||||
reactQueryOptions: {
|
||||
queries: {
|
||||
staleTime: 7000,
|
||||
},
|
||||
},
|
||||
}),
|
||||
BlitzRpcPlugin({}),
|
||||
],
|
||||
})
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
import { setupBlitzServer } from "@blitzjs/next"
|
||||
import { AuthServerPlugin, PrismaStorage } from "@blitzjs/auth"
|
||||
import {db} from "db"
|
||||
import db from "db"
|
||||
import { simpleRolesIsAuthorized } from "@blitzjs/auth"
|
||||
|
||||
export const { gSSP, gSP, api } = setupBlitzServer({
|
||||
|
||||
@@ -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,7 +1,9 @@
|
||||
save-exact=true
|
||||
legacy-peer-deps=true
|
||||
|
||||
strict-peer-dependencies=false
|
||||
side-effects-cache=false
|
||||
public-hoist-pattern[]=next
|
||||
public-hoist-pattern[]=secure-password
|
||||
public-hoist-pattern[]=*jest*
|
||||
public-hoist-pattern[]=@testing-library/*
|
||||
# Needed for Blitz to work properly. Don't remove the lines above.
|
||||
|
||||
@@ -27,7 +27,7 @@
|
||||
"@blitzjs/rpc": "latest",
|
||||
"@prisma/client": "3.9.0",
|
||||
"blitz": "alpha",
|
||||
"next": "12.1.1",
|
||||
"next": "12.1.6",
|
||||
"prisma": "3.9.0",
|
||||
"react": "18.0.0",
|
||||
"react-dom": "18.0.0",
|
||||
|
||||
@@ -27,7 +27,7 @@
|
||||
"@blitzjs/rpc": "latest",
|
||||
"@prisma/client": "3.9.0",
|
||||
"blitz": "alpha",
|
||||
"next": "12.1.1",
|
||||
"next": "12.1.6",
|
||||
"prisma": "3.9.0",
|
||||
"react": "18.0.0",
|
||||
"react-dom": "18.0.0",
|
||||
|
||||
@@ -1,7 +1,9 @@
|
||||
save-exact=true
|
||||
legacy-peer-deps=true
|
||||
|
||||
strict-peer-dependencies=false
|
||||
side-effects-cache=false
|
||||
public-hoist-pattern[]=next
|
||||
public-hoist-pattern[]=secure-password
|
||||
public-hoist-pattern[]=*jest*
|
||||
public-hoist-pattern[]=@testing-library/*
|
||||
# Needed for Blitz to work properly. Don't remove the lines above.
|
||||
@@ -20,7 +20,7 @@
|
||||
"dependencies": {
|
||||
"@blitzjs/next": "alpha",
|
||||
"blitz": "alpha",
|
||||
"next": "12.1.1",
|
||||
"next": "12.1.6",
|
||||
"react": "18.0.0",
|
||||
"react-dom": "18.0.0",
|
||||
"ts-node": "10.7.0"
|
||||
|
||||
@@ -22,7 +22,7 @@
|
||||
"dependencies": {
|
||||
"@blitzjs/next": "alpha",
|
||||
"blitz": "alpha",
|
||||
"next": "12.1.1",
|
||||
"next": "12.1.6",
|
||||
"react": "18.0.0",
|
||||
"react-dom": "18.0.0",
|
||||
"ts-node": "10.7.0"
|
||||
|
||||
@@ -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.27",
|
||||
"@blitzjs/config": "2.0.0-alpha.37",
|
||||
"@types/react": "18.0.1",
|
||||
"@types/react-dom": "17.0.14",
|
||||
"react": "18.0.0",
|
||||
|
||||
1242
pnpm-lock.yaml
generated
1242
pnpm-lock.yaml
generated
File diff suppressed because it is too large
Load Diff
Reference in New Issue
Block a user