Merge pull request #121 from boazpoolman/fix/type-declarations-for-custom-exports

fix: generate type declarations for all exports with types field

Author: boazpoolman

.changeset/fix-type-declarations-for-custom-exports.md

@@ -0,0 +1,9 @@
+---
+'@strapi/sdk-plugin': patch
+---
+
+fix type declarations not being generated for custom exports
+
+Previously, only `./strapi-admin` and `./strapi-server` exports would produce `.d.ts` files when a `types` field was defined in `package.json`. Custom exports silently skipped type generation because no per-bundle tsconfig existed for them.
+
+The build now falls back to the project root `tsconfig.build.json` or `tsconfig.json` when no per-bundle tsconfig is found, so any export with a `types` field will correctly emit type declarations.

src/__tests__/e2e/build.test.ts

@@ -56,7 +56,7 @@ describe('build command', () => {
 
     afterEach(() => {
       // Clean up built files after each test
-      const filesToClean = ['index.mjs', 'index.js'];
+      const filesToClean = ['index.mjs', 'index.js', 'index.d.ts'];
       for (const file of filesToClean) {
         const typesFilePath = path.join(distTypesDir, file);
         if (fs.existsSync(typesFilePath)) {
@@ -96,5 +96,18 @@ describe('build command', () => {
       // CJS should NOT exist (not specified in exports for ./types)
       expect(fs.existsSync(path.join(distTypesDir, 'index.js'))).toBe(false);
     });
+
+    it('should generate type declarations for custom exports with types field', async () => {
+      const logger = createLogger({ silent: true, debug: false, timestamp: false });
+
+      await build({
+        cwd: fixturePath,
+        logger,
+        silent: true,
+      });
+
+      // Type declarations should be generated for the ./types custom export
+      expect(fs.existsSync(path.join(distTypesDir, 'index.d.ts'))).toBe(true);
+    });
   });
 });

src/__tests__/fixtures/custom-export-plugin/server/tsconfig.build.json

@@ -0,0 +1,9 @@
+{
+  "extends": "../tsconfig.json",
+  "include": ["./src"],
+  "exclude": ["**/*.test.ts"],
+  "compilerOptions": {
+    "rootDir": "../",
+    "outDir": "./dist"
+  }
+}

src/__tests__/fixtures/custom-export-plugin/tsconfig.build.json

@@ -0,0 +1,6 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "outDir": "./dist"
+  }
+}

src/__tests__/fixtures/custom-export-plugin/tsconfig.json

@@ -0,0 +1,10 @@
+{
+  "compilerOptions": {
+    "target": "ES2020",
+    "module": "ESNext",
+    "moduleResolution": "bundler",
+    "declaration": true,
+    "strict": true,
+    "skipLibCheck": true
+  }
+}

src/cli/commands/utils/build/vite-config.ts

@@ -103,9 +103,28 @@ export async function createViteConfig(options: ViteConfigOptions): Promise<Inli
   }
 
   // Add TypeScript declarations plugin if types are expected
-  if (bundle.output.types && bundle.tsconfig) {
-    const tsconfigPath = path.resolve(cwd, bundle.tsconfig);
-    if (fs.existsSync(tsconfigPath)) {
+  if (bundle.output.types) {
+    // Find an appropriate tsconfig: try per-bundle first, then fall back to root-level configs
+    let tsconfigPath: string | undefined;
+
+    if (bundle.tsconfig) {
+      const candidate = path.resolve(cwd, bundle.tsconfig);
+      if (fs.existsSync(candidate)) {
+        tsconfigPath = candidate;
+      }
+    }
+
+    if (!tsconfigPath) {
+      for (const fallback of ['tsconfig.build.json', 'tsconfig.json']) {
+        const candidate = path.resolve(cwd, fallback);
+        if (fs.existsSync(candidate)) {
+          tsconfigPath = candidate;
+          break;
+        }
+      }
+    }
+
+    if (tsconfigPath) {
       const { default: dts } = await import('vite-plugin-dts');
 
       // Output types to the correct location