fix(core): patch VueFlow slots after build and apply correct types

Signed-off-by: braks <78412429+bcakmakoglu@users.noreply.github.com>
This commit is contained in:
braks
2022-12-05 18:41:36 +01:00
committed by Braks
parent f3a6ab8417
commit 84f82b6ad5
2 changed files with 81 additions and 1 deletions
+2 -1
View File
@@ -24,7 +24,8 @@
"scripts": {
"prepare": "ts-patch install -s",
"build": "vite build",
"types": "pnpm prepare && vue-tsc --declaration --emitDeclarationOnly && tsc -p tsconfig.build.json && shx rm -rf tmp && pnpm lint:dist",
"types": "pnpm prepare && vue-tsc --declaration --emitDeclarationOnly && tsc -p tsconfig.build.json && shx rm -rf tmp && pnpm lint:dist && pnpm run patch",
"patch": "node patch/slots.js && pnpm lint:dist",
"theme": "postcss src/style.css -o dist/style.css && postcss src/theme-default.css -o dist/theme-default.css",
"lint": "eslint --ext \".js,.jsx,.ts,.tsx\" --fix --ignore-path ../../.gitignore .",
"lint:dist": "eslint --ext \".ts,.tsx\" -c .eslintrc.js --fix ./dist",
+79
View File
@@ -0,0 +1,79 @@
const { readFile, writeFile } = require('fs/promises')
const { resolve } = require('path')
/**
* This is a workaround until slots can be properly typed from inside the VueFlow component
* It will overwrite `{}` typings with the correct prop types and add slot types for dynamic node and edge slots
*/
async function content(path) {
return readFile(path, 'utf8')
}
const filePath = resolve(__dirname, '../dist/container/VueFlow/VueFlow.vue.d.ts')
const typeImportsString = `import type {
Connection,
EdgeChange,
EdgeMouseEvent,
EdgeUpdateEvent,
GraphEdge,
GraphNode,
NodeChange,
NodeDragEvent,
NodeMouseEvent,
OnConnectStartParams,
ViewpaneTransform,
VueFlowStore,
} from '../../types'`
const patchedTypeImports = `import type {
Connection,
ConnectionLineProps,
EdgeChange,
EdgeMouseEvent,
EdgeProps,
EdgeUpdateEvent,
GraphEdge,
GraphNode,
NodeChange,
NodeDragEvent,
NodeMouseEvent,
NodeProps,
OnConnectStartParams,
ViewpaneTransform,
VueFlowStore,
} from '../../types'`
const unpatchedSlots = `(new () => {
$slots: Record<string, {}> &
Record<string, {}> & {
'connection-line': (_: {}) => any
'zoom-pane': (_: {}) => any
'default': (_: {}) => any
}
})`
const patchedSlots = `(new () => {
$slots: Record<string, any> & {
'connection-line': (connectionLineProps: ConnectionLineProps) => any
'zoom-pane': () => any
'default': () => any
} & {
[key: \`node-\${string}\`]: (nodeProps: NodeProps) => any
} & {
[key: \`edge-\${string}\`]: (edgeProps: EdgeProps) => any
}
})`
const patchSlots = async () => {
const fileContents = await content(filePath)
const patchedFileContents = fileContents.replace(typeImportsString, patchedTypeImports).replace(unpatchedSlots, patchedSlots)
await writeFile(filePath, patchedFileContents)
}
patchSlots()
.then(() => console.log('slots patched'))
.catch(console.log)