Skip to content

feat: exporting AllRoutes set from generated ROUTES.ts #676

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jycouet merged 7 commits into from
Jul 25, 2024
Merged

feat: exporting AllRoutes set from generated ROUTES.ts #676

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
784caa2
feat: exporting AllObjs from generated ROUTES.ts
duducpp Jul 17, 2024
726ba27
feat: added AllRoutes type and set
duducpp Jul 17, 2024
e8a99d4
fix: backslash as string
duducpp Jul 17, 2024
8f3ce68
feat: returning key case regex fail
duducpp Jul 17, 2024
a6e286e
refactor: using better variable names
duducpp Jul 17, 2024
8fc841b
add "routes"
jycouet Jul 25, 2024
1c4ad59
add changeset
jycouet Jul 25, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/stupid-pugs-yawn.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"vite-plugin-kit-routes": patch
---

add routes as Set (with all routes options) & Routes type.
34 changes: 13 additions & 21 deletions packages/vite-plugin-kit-routes/src/lib/ROUTES.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,10 +46,7 @@ const PAGES = {
params?: { lang?: 'fr' | 'en' | 'hu' | 'at' | string; limit?: number },
sp?: Record<string, string | number>,
) => {
return `${params?.lang ? `/${params?.lang}` : ''}/site${appendSp({
...sp,
limit: params?.limit,
})}`
return `${params?.lang ? `/${params?.lang}` : ''}/site${appendSp({ ...sp, limit: params?.limit })}`
},
'/site/[id]': (params?: {
lang?: 'fr' | 'hu' | undefined
Expand All @@ -60,20 +57,15 @@ const PAGES = {
params = params ?? {}
params.lang = params.lang ?? 'fr'
params.id = params.id ?? 'Vienna'
return `${params?.lang ? `/${params?.lang}` : ''}/site/${params.id}${appendSp({
limit: params.limit,
demo: params.demo,
})}`
return `${params?.lang ? `/${params?.lang}` : ''}/site/${params.id}${appendSp({ limit: params.limit, demo: params.demo })}`
},
'/site_contract/[siteId]-[contractId]': (params: {
siteId: string | number
contractId: string | number
lang?: 'fr' | 'en' | 'hu' | 'at' | string
limit?: number
}) => {
return `${params?.lang ? `/${params?.lang}` : ''}/site_contract/${params.siteId}-${
params.contractId
}${appendSp({ limit: params.limit })}`
return `${params?.lang ? `/${params?.lang}` : ''}/site_contract/${params.siteId}-${params.contractId}${appendSp({ limit: params.limit })}`
},
'/a/[...rest]/z': (params: { rest: (string | number)[] }) => {
return `/a/${params.rest?.join('/')}/z`
Expand Down Expand Up @@ -123,18 +115,13 @@ const ACTIONS = {
lang?: 'fr' | 'en' | 'hu' | 'at' | string
limit?: number
}) => {
return `${params?.lang ? `/${params?.lang}` : ''}/contract/${params.id}${appendSp({
limit: params.limit,
})}`
return `${params?.lang ? `/${params?.lang}` : ''}/contract/${params.id}${appendSp({ limit: params.limit })}`
},
'create /site': (params?: {
lang?: 'fr' | 'en' | 'hu' | 'at' | string
redirectTo?: 'list' | 'new' | 'detail'
}) => {
return `${params?.lang ? `/${params?.lang}` : ''}/site?/create${appendSp(
{ redirectTo: params?.redirectTo },
'&',
)}`
return `${params?.lang ? `/${params?.lang}` : ''}/site?/create${appendSp({ redirectTo: params?.redirectTo }, '&')}`
},
'update /site/[id]': (params: {
id: string | number
Expand All @@ -158,9 +145,7 @@ const ACTIONS = {
extra?: 'A' | 'B'
}) => {
params.extra = params.extra ?? 'A'
return `${params?.lang ? `/${params?.lang}` : ''}/site_contract/${params.siteId}-${
params.contractId
}?/send${appendSp({ extra: params.extra }, '&')}`
return `${params?.lang ? `/${params?.lang}` : ''}/site_contract/${params.siteId}-${params.contractId}?/send${appendSp({ extra: params.extra }, '&')}`
},
}

Expand Down Expand Up @@ -247,6 +232,13 @@ type FunctionParams<T> = T extends (...args: infer P) => any ? P : never
const AllObjs = { ...PAGES, ...ACTIONS, ...SERVERS, ...LINKS }
type AllTypes = typeof AllObjs

export type Routes = keyof AllTypes extends `${string}/${infer Route}`
? `/${Route}`
: keyof AllTypes
export const routes = [
...new Set(Object.keys(AllObjs).map((route) => /^\/.*|[^ ]?\/.*$/.exec(route)?.[0] ?? route)),
] as Routes[]

/**
* To be used like this:
* ```ts
Expand Down
5 changes: 5 additions & 0 deletions packages/vite-plugin-kit-routes/src/lib/format.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,11 @@ type FunctionParams<T> = T extends (...args: infer P) => any ? P : never
const AllObjs = { ...PAGES, ...ACTIONS, ...SERVERS, ...LINKS }
type AllTypes = typeof AllObjs

export type Routes = keyof AllTypes extends \`\${string}/\${infer Route}\` ? \`/\${Route}\` : keyof AllTypes
export const routes = [
...new Set(Object.keys(AllObjs).map((route) => /^\\/.*|[^ ]?\\/.*$/.exec(route)?.[0] ?? route)),
] as Routes[]

/**
* To be used like this:
* \`\`\`ts
Expand Down
5 changes: 5 additions & 0 deletions packages/vite-plugin-kit-routes/src/test/ROUTES_base.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -173,6 +173,11 @@ type FunctionParams<T> = T extends (...args: infer P) => any ? P : never
const AllObjs = { ...PAGES, ...ACTIONS, ...SERVERS, ...LINKS }
type AllTypes = typeof AllObjs

export type Routes = keyof AllTypes extends `${string}/${infer Route}` ? `/${Route}` : keyof AllTypes
export const routes = [
...new Set(Object.keys(AllObjs).map((route) => /^\/.*|[^ ]?\/.*$/.exec(route)?.[0] ?? route)),
] as Routes[]

/**
* To be used like this:
* ```ts
Expand Down
5 changes: 5 additions & 0 deletions packages/vite-plugin-kit-routes/src/test/ROUTES_format-route-and-object-path.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -186,6 +186,11 @@ type FunctionParams<T> = T extends (...args: infer P) => any ? P : never
const AllObjs = { ...PAGES, ...ACTIONS, ...SERVERS, ...LINKS }
type AllTypes = typeof AllObjs

export type Routes = keyof AllTypes extends `${string}/${infer Route}` ? `/${Route}` : keyof AllTypes
export const routes = [
...new Set(Object.keys(AllObjs).map((route) => /^\/.*|[^ ]?\/.*$/.exec(route)?.[0] ?? route)),
] as Routes[]

/**
* To be used like this:
* ```ts
Expand Down
5 changes: 5 additions & 0 deletions packages/vite-plugin-kit-routes/src/test/ROUTES_format-route-and-object-path_shortened.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -187,6 +187,11 @@ type FunctionParams<T> = T extends (...args: infer P) => any ? P : never
const AllObjs = { ...PAGES, ...ACTIONS, ...SERVERS, ...LINKS }
type AllTypes = typeof AllObjs

export type Routes = keyof AllTypes extends `${string}/${infer Route}` ? `/${Route}` : keyof AllTypes
export const routes = [
...new Set(Object.keys(AllObjs).map((route) => /^\/.*|[^ ]?\/.*$/.exec(route)?.[0] ?? route)),
] as Routes[]

/**
* To be used like this:
* ```ts
Expand Down
5 changes: 5 additions & 0 deletions packages/vite-plugin-kit-routes/src/test/ROUTES_format-route-and-object-symbol.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -186,6 +186,11 @@ type FunctionParams<T> = T extends (...args: infer P) => any ? P : never
const AllObjs = { ...PAGES, ...ACTIONS, ...SERVERS, ...LINKS }
type AllTypes = typeof AllObjs

export type Routes = keyof AllTypes extends `${string}/${infer Route}` ? `/${Route}` : keyof AllTypes
export const routes = [
...new Set(Object.keys(AllObjs).map((route) => /^\/.*|[^ ]?\/.*$/.exec(route)?.[0] ?? route)),
] as Routes[]

/**
* To be used like this:
* ```ts
Expand Down
5 changes: 5 additions & 0 deletions packages/vite-plugin-kit-routes/src/test/ROUTES_format-route-and-object-symbol_shortened.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -187,6 +187,11 @@ type FunctionParams<T> = T extends (...args: infer P) => any ? P : never
const AllObjs = { ...PAGES, ...ACTIONS, ...SERVERS, ...LINKS }
type AllTypes = typeof AllObjs

export type Routes = keyof AllTypes extends `${string}/${infer Route}` ? `/${Route}` : keyof AllTypes
export const routes = [
...new Set(Object.keys(AllObjs).map((route) => /^\/.*|[^ ]?\/.*$/.exec(route)?.[0] ?? route)),
] as Routes[]

/**
* To be used like this:
* ```ts
Expand Down
5 changes: 5 additions & 0 deletions packages/vite-plugin-kit-routes/src/test/ROUTES_format-route-path-page-route-id.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -186,6 +186,11 @@ type FunctionParams<T> = T extends (...args: infer P) => any ? P : never
const AllObjs = { ...PAGES, ...ACTIONS, ...SERVERS, ...LINKS }
type AllTypes = typeof AllObjs

export type Routes = keyof AllTypes extends `${string}/${infer Route}` ? `/${Route}` : keyof AllTypes
export const routes = [
...new Set(Object.keys(AllObjs).map((route) => /^\/.*|[^ ]?\/.*$/.exec(route)?.[0] ?? route)),
] as Routes[]

/**
* To be used like this:
* ```ts
Expand Down
5 changes: 5 additions & 0 deletions packages/vite-plugin-kit-routes/src/test/ROUTES_format-route-path-page-route-id_shortened.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -187,6 +187,11 @@ type FunctionParams<T> = T extends (...args: infer P) => any ? P : never
const AllObjs = { ...PAGES, ...ACTIONS, ...SERVERS, ...LINKS }
type AllTypes = typeof AllObjs

export type Routes = keyof AllTypes extends `${string}/${infer Route}` ? `/${Route}` : keyof AllTypes
export const routes = [
...new Set(Object.keys(AllObjs).map((route) => /^\/.*|[^ ]?\/.*$/.exec(route)?.[0] ?? route)),
] as Routes[]

/**
* To be used like this:
* ```ts
Expand Down
5 changes: 5 additions & 0 deletions packages/vite-plugin-kit-routes/src/test/ROUTES_format-route-path.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -186,6 +186,11 @@ type FunctionParams<T> = T extends (...args: infer P) => any ? P : never
const AllObjs = { ...PAGES, ...ACTIONS, ...SERVERS, ...LINKS }
type AllTypes = typeof AllObjs

export type Routes = keyof AllTypes extends `${string}/${infer Route}` ? `/${Route}` : keyof AllTypes
export const routes = [
...new Set(Object.keys(AllObjs).map((route) => /^\/.*|[^ ]?\/.*$/.exec(route)?.[0] ?? route)),
] as Routes[]

/**
* To be used like this:
* ```ts
Expand Down
5 changes: 5 additions & 0 deletions packages/vite-plugin-kit-routes/src/test/ROUTES_format-route-path_shortened.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -187,6 +187,11 @@ type FunctionParams<T> = T extends (...args: infer P) => any ? P : never
const AllObjs = { ...PAGES, ...ACTIONS, ...SERVERS, ...LINKS }
type AllTypes = typeof AllObjs

export type Routes = keyof AllTypes extends `${string}/${infer Route}` ? `/${Route}` : keyof AllTypes
export const routes = [
...new Set(Object.keys(AllObjs).map((route) => /^\/.*|[^ ]?\/.*$/.exec(route)?.[0] ?? route)),
] as Routes[]

/**
* To be used like this:
* ```ts
Expand Down
5 changes: 5 additions & 0 deletions packages/vite-plugin-kit-routes/src/test/ROUTES_format-route-symbol.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -186,6 +186,11 @@ type FunctionParams<T> = T extends (...args: infer P) => any ? P : never
const AllObjs = { ...PAGES, ...ACTIONS, ...SERVERS, ...LINKS }
type AllTypes = typeof AllObjs

export type Routes = keyof AllTypes extends `${string}/${infer Route}` ? `/${Route}` : keyof AllTypes
export const routes = [
...new Set(Object.keys(AllObjs).map((route) => /^\/.*|[^ ]?\/.*$/.exec(route)?.[0] ?? route)),
] as Routes[]

/**
* To be used like this:
* ```ts
Expand Down
5 changes: 5 additions & 0 deletions packages/vite-plugin-kit-routes/src/test/ROUTES_format-route-symbol_shortened.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -187,6 +187,11 @@ type FunctionParams<T> = T extends (...args: infer P) => any ? P : never
const AllObjs = { ...PAGES, ...ACTIONS, ...SERVERS, ...LINKS }
type AllTypes = typeof AllObjs

export type Routes = keyof AllTypes extends `${string}/${infer Route}` ? `/${Route}` : keyof AllTypes
export const routes = [
...new Set(Object.keys(AllObjs).map((route) => /^\/.*|[^ ]?\/.*$/.exec(route)?.[0] ?? route)),
] as Routes[]

/**
* To be used like this:
* ```ts
Expand Down
5 changes: 5 additions & 0 deletions packages/vite-plugin-kit-routes/src/test/ROUTES_post-update.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -172,6 +172,11 @@ type FunctionParams<T> = T extends (...args: infer P) => any ? P : never
const AllObjs = { ...PAGES, ...ACTIONS, ...SERVERS, ...LINKS }
type AllTypes = typeof AllObjs

export type Routes = keyof AllTypes extends `${string}/${infer Route}` ? `/${Route}` : keyof AllTypes
export const routes = [
...new Set(Object.keys(AllObjs).map((route) => /^\/.*|[^ ]?\/.*$/.exec(route)?.[0] ?? route)),
] as Routes[]

/**
* To be used like this:
* ```ts
Expand Down