fix: expose types for all TS resolution modes, fix SvelteComponent export (#8721)

also add some legacy import paths which should be changed in usage sites ASAP

---------

Co-authored-by: Simon H <5968653+dummdidumm@users.noreply.github.com>
Co-authored-by: Simon Holthausen <simon.holthausen@vercel.com>
pull/8733/head
gtmnayan 2 years ago committed by GitHub
parent aec4137d72
commit cc82d5ddcb
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

@ -0,0 +1,5 @@
---
'svelte': patch
---
fix: ensure types are loaded with all TS settings

@ -0,0 +1,5 @@
---
'svelte': patch
---
fix: export correct SvelteComponent type

@ -7,3 +7,12 @@
_actual*.* _actual*.*
_output _output
/types /types
action.d.ts
animate.d.ts
compiler.d.ts
easing.d.ts
index.d.ts
motion.d.ts
store.d.ts
transition.d.ts

@ -11,7 +11,6 @@
"compiler.*", "compiler.*",
"register.js", "register.js",
"index.d.ts", "index.d.ts",
"internal.d.ts",
"store.d.ts", "store.d.ts",
"animate.d.ts", "animate.d.ts",
"transition.d.ts", "transition.d.ts",
@ -47,7 +46,6 @@
"import": "./src/runtime/easing/index.js" "import": "./src/runtime/easing/index.js"
}, },
"./internal": { "./internal": {
"types": "./types/index.d.ts",
"import": "./src/runtime/internal/index.js" "import": "./src/runtime/internal/index.js"
}, },
"./motion": { "./motion": {

@ -1,11 +1,26 @@
import * as fs from 'fs';
import { createBundle } from 'dts-buddy'; import { createBundle } from 'dts-buddy';
// It may look weird, but the imports MUST be ending with index.js to be properly resolved in all TS modes
for (const name of ['action', 'animate', 'easing', 'motion', 'store', 'transition']) {
fs.writeFileSync(`${name}.d.ts`, `import './types/index.js';`);
}
fs.writeFileSync('index.d.ts', `import './types/index.js';`);
fs.writeFileSync('compiler.d.ts', `import './types/index.js';`);
// TODO: some way to mark these as deprecated
fs.mkdirSync('./types/compiler', { recursive: true });
fs.writeFileSync('./types/compiler/preprocess.d.ts', `import '../index.js';`);
fs.writeFileSync('./types/compiler/interfaces.d.ts', `import '../index.js';`);
await createBundle({ await createBundle({
output: 'types/index.d.ts', output: 'types/index.d.ts',
modules: { modules: {
svelte: 'src/runtime/public.d.ts', svelte: 'src/runtime/public.d.ts',
'svelte/compiler': 'src/compiler/public.d.ts', 'svelte/compiler': 'src/compiler/public.d.ts',
'svelte/types/compiler/preprocess': 'src/compiler/preprocess/public.d.ts', 'svelte/types/compiler/preprocess': 'src/compiler/preprocess/public.d.ts',
'svelte/types/compiler/interfaces': 'src/compiler/interfaces.d.ts',
'svelte/action': 'src/runtime/action/public.d.ts', 'svelte/action': 'src/runtime/action/public.d.ts',
'svelte/animate': 'src/runtime/animate/public.d.ts', 'svelte/animate': 'src/runtime/animate/public.d.ts',
'svelte/easing': 'src/runtime/easing/index.js', 'svelte/easing': 'src/runtime/easing/index.js',
@ -14,3 +29,11 @@ await createBundle({
'svelte/transition': 'src/runtime/transition/public.d.ts' 'svelte/transition': 'src/runtime/transition/public.d.ts'
} }
}); });
// There's no way to tell in JS that a class can have arbitrary properties, so we need to add that manually
const types = fs.readFileSync('types/index.d.ts', 'utf-8');
fs.writeFileSync(
'types/index.d.ts',
// same line to not affect source map
types.replace(/export class SvelteComponent<[^{]*{/, '$& [prop: string]: any;')
);

@ -1,3 +1,3 @@
declare module '*.svelte' { declare module '*.svelte' {
export { SvelteComponentDev as default } from 'svelte/internal'; export { SvelteComponent as default } from 'svelte';
} }

@ -1,4 +1,5 @@
export { export {
SvelteComponentDev as SvelteComponent,
onMount, onMount,
onDestroy, onDestroy,
beforeUpdate, beforeUpdate,
@ -9,6 +10,5 @@ export {
hasContext, hasContext,
tick, tick,
createEventDispatcher, createEventDispatcher,
SvelteComponentDev as SvelteComponent,
SvelteComponentTyped SvelteComponentTyped
} from './internal/index.js'; } from './internal/index.js';

@ -424,7 +424,6 @@ export function create_custom_element(
* *
* @template {Record<string, any>} [Props=any] * @template {Record<string, any>} [Props=any]
* @template {Record<string, any>} [Events=any] * @template {Record<string, any>} [Events=any]
* @implements Record<string, any>
*/ */
export class SvelteComponent { export class SvelteComponent {
/** /**

@ -295,7 +295,7 @@ export function construct_svelte_component_dev(component, props) {
* @template {Record<string, any>} [Props=any] * @template {Record<string, any>} [Props=any]
* @template {Record<string, any>} [Events=any] * @template {Record<string, any>} [Events=any]
* @template {Record<string, any>} [Slots=any] * @template {Record<string, any>} [Slots=any]
* @extends SvelteComponent<Props, Events> * @extends {SvelteComponent<Props, Events>}
*/ */
export class SvelteComponentDev extends SvelteComponent { export class SvelteComponentDev extends SvelteComponent {
/** /**
@ -350,7 +350,7 @@ export class SvelteComponentDev extends SvelteComponent {
* @template {Record<string, any>} [Events=any] * @template {Record<string, any>} [Events=any]
* @template {Record<string, any>} [Slots=any] * @template {Record<string, any>} [Slots=any]
* @deprecated Use `SvelteComponent` instead. See PR for more information: https://github.com/sveltejs/svelte/pull/8512 * @deprecated Use `SvelteComponent` instead. See PR for more information: https://github.com/sveltejs/svelte/pull/8512
* @extends SvelteComponentDev<Props, Events, Slots> * @extends {SvelteComponentDev<Props, Events, Slots>}
*/ */
export class SvelteComponentTyped extends SvelteComponentDev {} export class SvelteComponentTyped extends SvelteComponentDev {}

@ -91,5 +91,3 @@ export interface EventDispatcher<EventMap extends Record<string, any>> {
: [type: Type, parameter: EventMap[Type], options?: DispatchOptions] : [type: Type, parameter: EventMap[Type], options?: DispatchOptions]
): boolean; ): boolean;
} }
export * from './index.js';

@ -1,10 +1,27 @@
import './ambient.js'; import './ambient.js';
// Types written in this particular order to work around a dts-buddy bug where it doesn't handle the
// SvelteComponentDev as SvelteComponent alias correctly.
// If that's fixed, we can do export * from './index.js' instead.
export {
SvelteComponent,
SvelteComponentTyped,
onMount,
onDestroy,
beforeUpdate,
afterUpdate,
setContext,
getContext,
getAllContexts,
hasContext,
tick,
createEventDispatcher
} from './index.js';
export type { export type {
ComponentConstructorOptions, ComponentConstructorOptions,
ComponentEvents, ComponentEvents,
ComponentProps, ComponentProps,
ComponentType ComponentType
} from './internal/public.js'; } from './internal/public.js';
export * from './index.js';

@ -9,6 +9,7 @@
"baseUrl": ".", "baseUrl": ".",
"paths": { "paths": {
"svelte": ["."],
"svelte/*": ["*"] "svelte/*": ["*"]
}, },
"allowJs": true, "allowJs": true,

Loading…
Cancel
Save