Skip to content

Commit

Permalink
feat(core): tres components typing auto generated
Browse files Browse the repository at this point in the history
  • Loading branch information
@alvarosabu
alvarosabu committed Mar 16, 2023
1 parent 968d394 commit 6736b4c
Show file tree
Hide file tree
Showing 9 changed files with 426 additions and 19 deletions.
286 changes: 286 additions & 0 deletions packages/tres/.tres/tres-components.d.ts
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,286 @@
import type { DefineComponent } from 'vue'
import { TresObject, TresColor, TresVectorProp } from '/@/types'
import type {
Mesh,
AmbientLight,
ArrowHelper,
AxesHelper,
Box3Helper,
BoxBufferGeometry,
BoxGeometry,
BoxHelper,
BufferGeometry,
CameraHelper,
CapsuleBufferGeometry,
CapsuleGeometry,
CircleBufferGeometry,
CircleGeometry,
ConeBufferGeometry,
ConeGeometry,
CylinderBufferGeometry,
CylinderGeometry,
DirectionalLight,
DirectionalLightHelper,
DodecahedronBufferGeometry,
DodecahedronGeometry,
EdgesGeometry,
ExtrudeBufferGeometry,
ExtrudeGeometry,
GridHelper,
HemisphereLight,
HemisphereLightHelper,
IcosahedronBufferGeometry,
IcosahedronGeometry,
InstancedBufferGeometry,
LatheBufferGeometry,
LatheGeometry,
Light,
LineBasicMaterial,
LineDashedMaterial,
Material,
MeshBasicMaterial,
MeshDepthMaterial,
MeshDistanceMaterial,
MeshLambertMaterial,
MeshMatcapMaterial,
MeshNormalMaterial,
MeshPhongMaterial,
MeshPhysicalMaterial,
MeshStandardMaterial,
MeshToonMaterial,
OctahedronBufferGeometry,
OctahedronGeometry,
PlaneBufferGeometry,
PlaneGeometry,
PlaneHelper,
PointLight,
PointLightHelper,
PointsMaterial,
PolarGridHelper,
PolyhedronBufferGeometry,
PolyhedronGeometry,
RawShaderMaterial,
RectAreaLight,
RingBufferGeometry,
RingGeometry,
ShaderMaterial,
ShadowMaterial,
ShapeBufferGeometry,
ShapeGeometry,
SkeletonHelper,
SphereBufferGeometry,
SphereGeometry,
SpotLight,
SpotLightHelper,
SpriteMaterial,
TetrahedronBufferGeometry,
TetrahedronGeometry,
TorusBufferGeometry,
TorusGeometry,
TorusKnotBufferGeometry,
TorusKnotGeometry,
TubeBufferGeometry,
TubeGeometry,
WireframeGeometry,
} from 'three'

type OverwrittenProps = 'position' | 'rotation' | 'scale' | 'color'

type TresModifiedObject = {
/**
* A Vector3 | Array | scalar representing the object's local position. Default is (0, 0, 0).
*
* @type {TresVectorProp}
*/
position: TresVectorProp
/**
* A Vector3 | Array | scalar representing the object's local rotation. Default is (0, 0, 0).
*
* @type {TresVectorProp}
*/
rotation: TresVectorProp
/**
* A Vector3 | Array | scalar representing the object's local scale. Default is (0, 0, 0).
*
* @type {TresVectorProp}
*/
scale: TresVectorProp
/**
* Color of the material, by default set to white (0xffffff).
*
* @type {TresColor}
*/
color: TresColor
}

declare module 'vue' {
export interface GlobalComponents {
TresMesh: DefineComponent<Partial<Omit<Mesh, OverwrittenProps> & TresModifiedObject>>
TresBoxBufferGeometry: DefineComponent<
Partial<Omit<BoxBufferGeometry['parameters'], OverwrittenProps> & TresModifiedObject>
>
TresBoxGeometry: DefineComponent<Partial<Omit<BoxGeometry['parameters'], OverwrittenProps> & TresModifiedObject>>
TresBufferGeometry: DefineComponent<
Partial<Omit<BufferGeometry['parameters'], OverwrittenProps> & TresModifiedObject>
>
TresCapsuleBufferGeometry: DefineComponent<
Partial<Omit<CapsuleBufferGeometry['parameters'], OverwrittenProps> & TresModifiedObject>
>
TresCapsuleGeometry: DefineComponent<
Partial<Omit<CapsuleGeometry['parameters'], OverwrittenProps> & TresModifiedObject>
>
TresCircleBufferGeometry: DefineComponent<
Partial<Omit<CircleBufferGeometry['parameters'], OverwrittenProps> & TresModifiedObject>
>
TresCircleGeometry: DefineComponent<
Partial<Omit<CircleGeometry['parameters'], OverwrittenProps> & TresModifiedObject>
>
TresConeBufferGeometry: DefineComponent<
Partial<Omit<ConeBufferGeometry['parameters'], OverwrittenProps> & TresModifiedObject>
>
TresConeGeometry: DefineComponent<Partial<Omit<ConeGeometry['parameters'], OverwrittenProps> & TresModifiedObject>>
TresCylinderBufferGeometry: DefineComponent<
Partial<Omit<CylinderBufferGeometry['parameters'], OverwrittenProps> & TresModifiedObject>
>
TresCylinderGeometry: DefineComponent<
Partial<Omit<CylinderGeometry['parameters'], OverwrittenProps> & TresModifiedObject>
>
TresDodecahedronBufferGeometry: DefineComponent<
Partial<Omit<DodecahedronBufferGeometry['parameters'], OverwrittenProps> & TresModifiedObject>
>
TresDodecahedronGeometry: DefineComponent<
Partial<Omit<DodecahedronGeometry['parameters'], OverwrittenProps> & TresModifiedObject>
>
TresEdgesGeometry: DefineComponent<
Partial<Omit<EdgesGeometry['parameters'], OverwrittenProps> & TresModifiedObject>
>
TresExtrudeBufferGeometry: DefineComponent<
Partial<Omit<ExtrudeBufferGeometry['parameters'], OverwrittenProps> & TresModifiedObject>
>
TresExtrudeGeometry: DefineComponent<
Partial<Omit<ExtrudeGeometry['parameters'], OverwrittenProps> & TresModifiedObject>
>
TresIcosahedronBufferGeometry: DefineComponent<
Partial<Omit<IcosahedronBufferGeometry['parameters'], OverwrittenProps> & TresModifiedObject>
>
TresIcosahedronGeometry: DefineComponent<
Partial<Omit<IcosahedronGeometry['parameters'], OverwrittenProps> & TresModifiedObject>
>
TresInstancedBufferGeometry: DefineComponent<
Partial<Omit<InstancedBufferGeometry['parameters'], OverwrittenProps> & TresModifiedObject>
>
TresLatheBufferGeometry: DefineComponent<
Partial<Omit<LatheBufferGeometry['parameters'], OverwrittenProps> & TresModifiedObject>
>
TresLatheGeometry: DefineComponent<
Partial<Omit<LatheGeometry['parameters'], OverwrittenProps> & TresModifiedObject>
>
TresOctahedronBufferGeometry: DefineComponent<
Partial<Omit<OctahedronBufferGeometry['parameters'], OverwrittenProps> & TresModifiedObject>
>
TresOctahedronGeometry: DefineComponent<
Partial<Omit<OctahedronGeometry['parameters'], OverwrittenProps> & TresModifiedObject>
>
TresPlaneBufferGeometry: DefineComponent<
Partial<Omit<PlaneBufferGeometry['parameters'], OverwrittenProps> & TresModifiedObject>
>
TresPlaneGeometry: DefineComponent<
Partial<Omit<PlaneGeometry['parameters'], OverwrittenProps> & TresModifiedObject>
>
TresPolyhedronBufferGeometry: DefineComponent<
Partial<Omit<PolyhedronBufferGeometry['parameters'], OverwrittenProps> & TresModifiedObject>
>
TresPolyhedronGeometry: DefineComponent<
Partial<Omit<PolyhedronGeometry['parameters'], OverwrittenProps> & TresModifiedObject>
>
TresRingBufferGeometry: DefineComponent<
Partial<Omit<RingBufferGeometry['parameters'], OverwrittenProps> & TresModifiedObject>
>
TresRingGeometry: DefineComponent<Partial<Omit<RingGeometry['parameters'], OverwrittenProps> & TresModifiedObject>>
TresShapeBufferGeometry: DefineComponent<
Partial<Omit<ShapeBufferGeometry['parameters'], OverwrittenProps> & TresModifiedObject>
>
TresShapeGeometry: DefineComponent<
Partial<Omit<ShapeGeometry['parameters'], OverwrittenProps> & TresModifiedObject>
>
TresSphereBufferGeometry: DefineComponent<
Partial<Omit<SphereBufferGeometry['parameters'], OverwrittenProps> & TresModifiedObject>
>
TresSphereGeometry: DefineComponent<
Partial<Omit<SphereGeometry['parameters'], OverwrittenProps> & TresModifiedObject>
>
TresTetrahedronBufferGeometry: DefineComponent<
Partial<Omit<TetrahedronBufferGeometry['parameters'], OverwrittenProps> & TresModifiedObject>
>
TresTetrahedronGeometry: DefineComponent<
Partial<Omit<TetrahedronGeometry['parameters'], OverwrittenProps> & TresModifiedObject>
>
TresTorusBufferGeometry: DefineComponent<
Partial<Omit<TorusBufferGeometry['parameters'], OverwrittenProps> & TresModifiedObject>
>
TresTorusGeometry: DefineComponent<
Partial<Omit<TorusGeometry['parameters'], OverwrittenProps> & TresModifiedObject>
>
TresTorusKnotBufferGeometry: DefineComponent<
Partial<Omit<TorusKnotBufferGeometry['parameters'], OverwrittenProps> & TresModifiedObject>
>
TresTorusKnotGeometry: DefineComponent<
Partial<Omit<TorusKnotGeometry['parameters'], OverwrittenProps> & TresModifiedObject>
>
TresTubeBufferGeometry: DefineComponent<
Partial<Omit<TubeBufferGeometry['parameters'], OverwrittenProps> & TresModifiedObject>
>
TresTubeGeometry: DefineComponent<Partial<Omit<TubeGeometry['parameters'], OverwrittenProps> & TresModifiedObject>>
TresWireframeGeometry: DefineComponent<
Partial<Omit<WireframeGeometry['parameters'], OverwrittenProps> & TresModifiedObject>
>
TresAmbientLight: DefineComponent<Partial<Omit<AmbientLight, OverwrittenProps> & TresModifiedObject>>
TresArrowHelper: DefineComponent<Partial<Omit<ArrowHelper, OverwrittenProps> & TresModifiedObject>>
TresAxesHelper: DefineComponent<Partial<Omit<AxesHelper, OverwrittenProps> & TresModifiedObject>>
TresBox3Helper: DefineComponent<Partial<Omit<Box3Helper, OverwrittenProps> & TresModifiedObject>>
TresBoxHelper: DefineComponent<Partial<Omit<BoxHelper, OverwrittenProps> & TresModifiedObject>>
TresCameraHelper: DefineComponent<Partial<Omit<CameraHelper, OverwrittenProps> & TresModifiedObject>>
TresDirectionalLight: DefineComponent<Partial<Omit<DirectionalLight, OverwrittenProps> & TresModifiedObject>>
TresDirectionalLightHelper: DefineComponent<
Partial<Omit<DirectionalLightHelper, OverwrittenProps> & TresModifiedObject>
>
TresGridHelper: DefineComponent<Partial<Omit<GridHelper, OverwrittenProps> & TresModifiedObject>>
TresHemisphereLight: DefineComponent<Partial<Omit<HemisphereLight, OverwrittenProps> & TresModifiedObject>>
TresHemisphereLightHelper: DefineComponent<
Partial<Omit<HemisphereLightHelper, OverwrittenProps> & TresModifiedObject>
>
TresLight: DefineComponent<Partial<Omit<Light, OverwrittenProps> & TresModifiedObject>>
TresLineBasicMaterial: DefineComponent<Partial<Omit<LineBasicMaterial, OverwrittenProps> & TresModifiedObject>>
TresLineDashedMaterial: DefineComponent<Partial<Omit<LineDashedMaterial, OverwrittenProps> & TresModifiedObject>>
TresMaterial: DefineComponent<Partial<Omit<Material, OverwrittenProps> & TresModifiedObject>>
TresMeshBasicMaterial: DefineComponent<Partial<Omit<MeshBasicMaterial, OverwrittenProps> & TresModifiedObject>>
TresMeshDepthMaterial: DefineComponent<Partial<Omit<MeshDepthMaterial, OverwrittenProps> & TresModifiedObject>>
TresMeshDistanceMaterial: DefineComponent<
Partial<Omit<MeshDistanceMaterial, OverwrittenProps> & TresModifiedObject>
>
TresMeshLambertMaterial: DefineComponent<Partial<Omit<MeshLambertMaterial, OverwrittenProps> & TresModifiedObject>>
TresMeshMatcapMaterial: DefineComponent<Partial<Omit<MeshMatcapMaterial, OverwrittenProps> & TresModifiedObject>>
TresMeshNormalMaterial: DefineComponent<Partial<Omit<MeshNormalMaterial, OverwrittenProps> & TresModifiedObject>>
TresMeshPhongMaterial: DefineComponent<Partial<Omit<MeshPhongMaterial, OverwrittenProps> & TresModifiedObject>>
TresMeshPhysicalMaterial: DefineComponent<
Partial<Omit<MeshPhysicalMaterial, OverwrittenProps> & TresModifiedObject>
>
TresMeshStandardMaterial: DefineComponent<
Partial<Omit<MeshStandardMaterial, OverwrittenProps> & TresModifiedObject>
>
TresMeshToonMaterial: DefineComponent<Partial<Omit<MeshToonMaterial, OverwrittenProps> & TresModifiedObject>>
TresPlaneHelper: DefineComponent<Partial<Omit<PlaneHelper, OverwrittenProps> & TresModifiedObject>>
TresPointLight: DefineComponent<Partial<Omit<PointLight, OverwrittenProps> & TresModifiedObject>>
TresPointLightHelper: DefineComponent<Partial<Omit<PointLightHelper, OverwrittenProps> & TresModifiedObject>>
TresPointsMaterial: DefineComponent<Partial<Omit<PointsMaterial, OverwrittenProps> & TresModifiedObject>>
TresPolarGridHelper: DefineComponent<Partial<Omit<PolarGridHelper, OverwrittenProps> & TresModifiedObject>>
TresRawShaderMaterial: DefineComponent<Partial<Omit<RawShaderMaterial, OverwrittenProps> & TresModifiedObject>>
TresRectAreaLight: DefineComponent<Partial<Omit<RectAreaLight, OverwrittenProps> & TresModifiedObject>>
TresShaderMaterial: DefineComponent<Partial<Omit<ShaderMaterial, OverwrittenProps> & TresModifiedObject>>
TresShadowMaterial: DefineComponent<Partial<Omit<ShadowMaterial, OverwrittenProps> & TresModifiedObject>>
TresSkeletonHelper: DefineComponent<Partial<Omit<SkeletonHelper, OverwrittenProps> & TresModifiedObject>>
TresSpotLight: DefineComponent<Partial<Omit<SpotLight, OverwrittenProps> & TresModifiedObject>>
TresSpotLightHelper: DefineComponent<Partial<Omit<SpotLightHelper, OverwrittenProps> & TresModifiedObject>>
TresSpriteMaterial: DefineComponent<Partial<Omit<SpriteMaterial, OverwrittenProps> & TresModifiedObject>>
}
}
15 changes: 0 additions & 15 deletions packages/tres/components.d.ts
View file

This file was deleted.

1 change: 1 addition & 0 deletions packages/tres/package.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,7 @@
"rollup-plugin-analyzer": "^4.0.0",
"rollup-plugin-visualizer": "^5.9.0",
"three": "latest",
"unplugin": "^1.3.1",
"vite": "^4.1.4",
"vite-plugin-banner": "^0.7.0",
"vite-plugin-dts": "2.1.0",
Expand Down
83 changes: 83 additions & 0 deletions packages/tres/plugins/vite-tres-types-plugin.ts
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,83 @@
import { createUnplugin } from 'unplugin'
import * as THREE from 'three'

import fs from 'fs'
import { join } from 'pathe'

export const unplugin = createUnplugin(() => {
return {
name: 'unplugin-tres',
apply: 'build',
configResolved(config) {
// Check if the output directory exists, if not create it
const outputDir = join(config.root, '.tres')
if (!fs.existsSync(outputDir)) {
fs.mkdirSync(outputDir)
}

const typeDefs = `
import type { DefineComponent } from 'vue'
import { TresObject, TresColor, TresVectorProp } from '/@/types'
import type {
Mesh,
${Object.keys(THREE)
.filter(
key =>
key.endsWith('Geometry') || key.endsWith('Material') || key.endsWith('Helper') || key.endsWith('Light'),
)
.join(',\n')}
} from 'three';
type OverwrittenProps = 'position' | 'rotation' | 'scale' | 'color'
type TresModifiedObject = {
/**
* A Vector3 | Array | scalar representing the object's local position. Default is (0, 0, 0).
*
* @type {TresVectorProp}
*/
position: TresVectorProp
/**
* A Vector3 | Array | scalar representing the object's local rotation. Default is (0, 0, 0).
*
* @type {TresVectorProp}
*/
rotation: TresVectorProp
/**
* A Vector3 | Array | scalar representing the object's local scale. Default is (0, 0, 0).
*
* @type {TresVectorProp}
*/
scale: TresVectorProp
/**
* Color of the material, by default set to white (0xffffff).
*
* @type {TresColor}
*/
color: TresColor
}
declare module 'vue' {
export interface GlobalComponents {
TresMesh: DefineComponent<Partial<Omit<Mesh, OverwrittenProps> & TresModifiedObject>>
${Object.keys(THREE)
.filter(key => key.endsWith('Geometry'))
.map(
key =>
`Tres${key}: DefineComponent<Partial<Omit<${key}['parameters'], OverwrittenProps> & TresModifiedObject>>`,
)
.join('\n')}
${Object.keys(THREE)
.filter(key => key.endsWith('Material') || key.endsWith('Helper') || key.endsWith('Light'))
.map(key => `Tres${key}: DefineComponent<Partial<Omit<${key}, OverwrittenProps > & TresModifiedObject>>`)
.join('\n')}
}
}
`

fs.writeFileSync(join(outputDir, 'tres-components.d.ts'), typeDefs)
},
}
})

export const ViteTresPlugin = unplugin.vite
Loading

0 comments on commit 6736b4c

Please sign in to comment.