treefarmstudio / astro-sanity

This is a helper package to integrate Astro and Sanity
https://www.npmjs.com/package/astro-sanity
MIT License
102 stars 10 forks source link

Fixing TypeScript Declaration Issue in 'astro-sanity' Package #28

Open ps-kate opened 11 months ago

ps-kate commented 11 months ago

Hey there! 👋

I ran into an issue with the 'astro-sanity' package (version 1.1.7) while working on my project. It seems there's a problem with TypeScript type declarations that results in a errors and warnings:

src/pages/posts/index.astro:6:39 - error ts(7016): Could not find a declaration file for module 'astro-sanity'. '/Users/***/Sites/***/node_modules/astro-sanity/dist/astro-sanity.mjs' implicitly has an 'any' type.
  There are types at '/Users/***/Sites/***/node_modules/astro-sanity/dist/index.d.ts', but this result could not be resolved when respecting package.json "exports". The 'astro-sanity' library may need to update its package.json or typings.

Here's the fix that worked for me:

diff --git a/node_modules/astro-sanity/package.json b/node_modules/astro-sanity/package.json
index 2b4b11a..5fc451e 100644
--- a/node_modules/astro-sanity/package.json
+++ b/node_modules/astro-sanity/package.json
@@ -10,7 +10,8 @@
   "exports": {
     ".": {
       "import": "./dist/astro-sanity.mjs",
-      "require": "./dist/astro-sanity.js"
+      "require": "./dist/astro-sanity.js",
+      "types": "./dist/index.d.ts"
     }
   },
   "files": [

I've created this pull request to address the issue and help others who might face the same problem. Let's get this fix merged!

Best regards, Kate

brandondeweese commented 11 months ago

Issue still exists.

adstr123 commented 10 months ago

Bumping as its happening for me too

chris-nowicki commented 10 months ago

This is still happening for me as well.