chore(avatar): re-expose public typedef

vnphanquang · Jul 9, 2024 · a2f8449 · a2f8449
1 parent 28126b5
commit a2f8449
Show file tree

Hide file tree

Showing 8 changed files with 26 additions and 13 deletions.
diff --git a/.changeset/twenty-coins-destroy.md b/.changeset/twenty-coins-destroy.md
@@ -0,0 +1,5 @@
+---
+'@svelte-put/avatar': patch
+---
+
+re-expose public typedef (following https://github.com/Rich-Harris/dts-buddy/pull/82)
diff --git a/packages/avatar/src/Avatar.svelte b/packages/avatar/src/Avatar.svelte
@@ -1,7 +1,7 @@
 <script>
 	import { resolveAlt, resolveSize, resolveSrc, DEFINITIVE_FALLBACK } from './avatar.utils.js';
 
-	/** @type {import('./types').AvatarProps} */
+	/** @type {import('./types.public').AvatarProps} */
 	let { src, gravatar, uiAvatar, fallback, size, alt, class: cls = '', img, ...rest } = $props();
 
 	let rAlt = $derived(resolveAlt(alt, gravatar, uiAvatar, src));
@@ -59,3 +59,4 @@
 		aspect-ratio: 1 / 1;
 	}
 </style>
+
diff --git a/packages/avatar/src/Avatar.svelte.d.ts b/packages/avatar/src/Avatar.svelte.d.ts
@@ -1,6 +1,7 @@
 import type { Component } from 'svelte';
 
-import { AvatarProps } from './types';
+import { AvatarProps } from './types.public';
 
 declare const Avatar: Component<AvatarProps>;
 export default Avatar;
+
diff --git a/packages/avatar/src/avatar.helpers.js b/packages/avatar/src/avatar.helpers.js
@@ -2,8 +2,7 @@ import md5 from 'md5';
 
 /**
  * Builds a {@link https://ui-avatars.com | UIAvatar } url
- *
- * @param {string | import('./types').UIAvatarOptions} input - name for UIAvatar or object of options
+ * @param {string | import('./types.public').UIAvatarOptions} input - name for UIAvatar or object of options
  * @returns {string} the constructed UIAvatar URL
  */
 export function uiAvatar(input) {
@@ -24,13 +23,12 @@ export function uiAvatar(input) {
 
 /**
  * Builds a {@link https://en.gravatar.com/site/implement/images | Gravatar } url
- *
- * @param {string | import('./types').GravatarOptions} input - email for Gravatar or object of options
+ * @param {string | import('./types.public').GravatarOptions} input - email for Gravatar or object of options
  * @returns {string} the constructed Gravatar URL
  */
 export function gravatar(input) {
 	let email = '';
-	/** @type {Omit<import('./types').GravatarOptions, 'email'>} */
+	/** @type {Omit<import('./types.public').GravatarOptions, 'email'>} */
 	let options = {};
 	if (typeof input === 'string') {
 		email = input;
@@ -46,3 +44,4 @@ export function gravatar(input) {
 
 	return output;
 }
+
diff --git a/packages/avatar/src/avatar.utils.js b/packages/avatar/src/avatar.utils.js
@@ -46,8 +46,8 @@ function nonNullableFilter(value) {
 /**
  * @package
  * @param {string | undefined} alt
- * @param {import('./types').AvatarProps['gravatar'] | undefined} gravatar
- * @param {import('./types').AvatarProps['uiAvatar'] | undefined} uiAvatar
+ * @param {import('./types.public').AvatarProps['gravatar'] | undefined} gravatar
+ * @param {import('./types.public').AvatarProps['uiAvatar'] | undefined} uiAvatar
  * @param {string | undefined } src
  * @returns {string}
  */
@@ -71,8 +71,8 @@ export function resolveAlt(
  * @param {number} fallback
  * @param {number | undefined} size
  * @param {string | undefined} src
- * @param {import('./types').AvatarProps['gravatar'] | undefined} gravatar
- * @param {import('./types').AvatarProps['uiAvatar'] | undefined} uiAvatar
+ * @param {import('./types.public').AvatarProps['gravatar'] | undefined} gravatar
+ * @param {import('./types.public').AvatarProps['uiAvatar'] | undefined} uiAvatar
  * @returns {number}
  */
 export function resolveSize(
@@ -98,8 +98,8 @@ export const DEFINITIVE_FALLBACK = 'https://www.gravatar.com/avatar?d=mp';
 /**
  * @package
  * @param {string | undefined} src
- * @param {import('./types').AvatarProps['gravatar'] | undefined} gravatar
- * @param {import('./types').AvatarProps['uiAvatar'] | undefined} uiAvatar
+ * @param {import('./types.public').AvatarProps['gravatar'] | undefined} gravatar
+ * @param {import('./types.public').AvatarProps['uiAvatar'] | undefined} uiAvatar
  * @param {string | undefined} fallback
  * @returns {string[]}
  */
@@ -128,3 +128,4 @@ export function resolveSrc(
 
 	return [src, rGravatar, rUIAvatar, fallback].filter(nonNullableFilter);
 }
+
diff --git a/packages/avatar/src/index.js b/packages/avatar/src/index.js
@@ -1,2 +1,4 @@
 export { default as Avatar } from './Avatar.svelte';
 export { gravatar, uiAvatar } from './avatar.helpers.js';
+export * from './types.public.js'
+
diff --git a/packages/avatar/src/types.d.ts → packages/avatar/src/types.public.d.ts b/packages/avatar/src/types.d.ts → packages/avatar/src/types.public.d.ts
@@ -101,3 +101,4 @@ export interface AvatarProps extends HTMLImgAttributes {
 	alt?: string;
 	img?: Snippet<[{ src: string; size: number; alt: string; sources: string[] }]>;
 }
+
diff --git a/packages/avatar/src/types.public.js b/packages/avatar/src/types.public.js
@@ -0,0 +1,3 @@
+/** to provide typing only, see types.public.d.ts */
+export {};
+
Original file line number	Diff line number	Diff line change
Expand Up		@@ -101,3 +101,4 @@ export interface AvatarProps extends HTMLImgAttributes {
		alt?: string;
		img?: Snippet<[{ src: string; size: number; alt: string; sources: string[] }]>;
		}
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		/** to provide typing only, see types.public.d.ts */
		export {};