fix: use TypeScript syntax in source code

[SimenB]

Using export = (which is a TypeScript thing) tsc will output the export itself, and we can also get correct types instead of copying the actual types file.

Diff (after running prettier on the generated file)

diff --git c/dist/jimp.cjs w/dist/jimp.cjs
index 6b084d2..fd6e0e7 100644
--- c/dist/jimp.cjs
+++ w/dist/jimp.cjs
@@ -31293,7 +31293,6 @@
         function (r) {
           return r && r.__esModule ? r : { default: r };
         };
-      Object.defineProperty(i, "__esModule", { value: true });
       const s = o(a(1099));
       class JIMPBUffer {
         constructor(r, ...i) {
diff --git c/dist/jimp.d.ts w/dist/jimp.d.ts
index 08877f8..cf15fc8 100644
--- c/dist/jimp.d.ts
+++ w/dist/jimp.d.ts
@@ -1,50 +1,2 @@
-/**
- * While there is nothing in these typings that prevent it from running in TS 2.8 even,
- * due to the complexity of the typings anything lower than TS 3.1 will only see
- * Jimp as `any`. In order to test the strict versions of these types in our typing
- * test suite, the version has been bumped to 3.1
- */
-
-import {
-  Jimp as JimpType,
-  Bitmap,
-  RGB,
-  RGBA,
-  UnionToIntersection,
-  GetPluginVal,
-  GetPluginConst,
-  GetPluginEncoders,
-  GetPluginDecoders,
-  JimpConstructors
-} from '@jimp/core';
-import typeFn from '@jimp/types';
-import pluginFn from '@jimp/plugins';
-
-type Types = ReturnType<typeof typeFn>;
-type Plugins = ReturnType<typeof pluginFn>;
-
-type IntersectedPluginTypes = UnionToIntersection<
-  GetPluginVal<Types> | GetPluginVal<Plugins>
->;
-
-type IntersectedPluginConsts = UnionToIntersection<
-  GetPluginConst<Types> | GetPluginConst<Plugins>
->;
-
-type IntersectedPluginEncoders = UnionToIntersection<
-  GetPluginEncoders<Types> | GetPluginEncoders<Plugins>
->;
-
-type IntersectedPluginDecoders = UnionToIntersection<
-  GetPluginDecoders<Types> | GetPluginDecoders<Plugins>
->;
-
-type Jimp = JimpType & IntersectedPluginTypes;
-
-declare const Jimp: JimpConstructors & IntersectedPluginConsts & {
-  prototype: Jimp;
-  encoders: IntersectedPluginEncoders;
-  decoders: IntersectedPluginDecoders;
-};
-
-export = Jimp;
+import jimp from 'jimp/es';
+export = jimp;

---

My hope is that this miiight make #42 easier as we're not copying stuff, but who knows 🙂 Regardless, it's cleaner to produce a declaration file instead of copying it

[SimenB]

using this forces it on consumers as well (the types use export = https://www.runpkg.com/[email protected]/types/ts3.1/index.d.ts#50)

[pi0]

Seems a good idea 😊

[pi0]

Thanks for the PR @SimenB ❤️ I really love the changes and idea of not copying the dts file. But to keep type issue away from ncc/webpack, what do you think we simply make a .d.ts file with two expected lines and expose in pkg? This way we can keep using more ESM friendly syntax in src/jimp.ts and change bundler if needed later.

[SimenB]

This isn't really connected to the bundler, but TypeScript itself.

Main issue here is that we import jimp/es which fakes being ES Modules (it uses require: https://www.runpkg.com/[email protected]/es/index.js#3) but the types are for the CJS version

[SimenB]

OK, this works (previous version needed a manual .default)

new diff

diff --git c/dist/jimp.cjs w/dist/jimp.cjs
index 6b084d2..167a3a1 100644
--- c/dist/jimp.cjs
+++ w/dist/jimp.cjs
@@ -11865,7 +11865,7 @@
         ]);
       });
     },
-    1099: (r, i, a) => {
+    3794: (r, i, a) => {
       "use strict";
       var o = a(3298);
       Object.defineProperty(i, "__esModule", { value: true });
@@ -11878,6 +11878,7 @@
         plugins: [u["default"]],
       });
       i.default = v;
+      r.exports = i.default;
     },
     8541: (r, i, a) => {
       var o = a(9179),
@@ -31286,15 +31287,9 @@
         r.exports.writerState = o;
       }.call(this));
     },
-    2919: function (r, i, a) {
+    2919: (r, i, a) => {
       "use strict";
-      var o =
-        (this && this.__importDefault) ||
-        function (r) {
-          return r && r.__esModule ? r : { default: r };
-        };
-      Object.defineProperty(i, "__esModule", { value: true });
-      const s = o(a(1099));
+      const o = a(3794);
       class JIMPBUffer {
         constructor(r, ...i) {
           if (i.length) {
@@ -31307,7 +31302,7 @@
         }
       }
       globalThis.JIMPBUffer = JIMPBUffer;
-      r.exports = s.default;
+      r.exports = o;
     },
     2274: (r) => {
       "use strict";
diff --git c/dist/jimp.d.ts w/dist/jimp.d.ts
index 08877f8..9fea319 100644
--- c/dist/jimp.d.ts
+++ w/dist/jimp.d.ts
@@ -1,50 +1,2 @@
-/**
- * While there is nothing in these typings that prevent it from running in TS 2.8 even,
- * due to the complexity of the typings anything lower than TS 3.1 will only see
- * Jimp as `any`. In order to test the strict versions of these types in our typing
- * test suite, the version has been bumped to 3.1
- */
-
-import {
-  Jimp as JimpType,
-  Bitmap,
-  RGB,
-  RGBA,
-  UnionToIntersection,
-  GetPluginVal,
-  GetPluginConst,
-  GetPluginEncoders,
-  GetPluginDecoders,
-  JimpConstructors
-} from '@jimp/core';
-import typeFn from '@jimp/types';
-import pluginFn from '@jimp/plugins';
-
-type Types = ReturnType<typeof typeFn>;
-type Plugins = ReturnType<typeof pluginFn>;
-
-type IntersectedPluginTypes = UnionToIntersection<
-  GetPluginVal<Types> | GetPluginVal<Plugins>
->;
-
-type IntersectedPluginConsts = UnionToIntersection<
-  GetPluginConst<Types> | GetPluginConst<Plugins>
->;
-
-type IntersectedPluginEncoders = UnionToIntersection<
-  GetPluginEncoders<Types> | GetPluginEncoders<Plugins>
->;
-
-type IntersectedPluginDecoders = UnionToIntersection<
-  GetPluginDecoders<Types> | GetPluginDecoders<Plugins>
->;
-
-type Jimp = JimpType & IntersectedPluginTypes;
-
-declare const Jimp: JimpConstructors & IntersectedPluginConsts & {
-  prototype: Jimp;
-  encoders: IntersectedPluginEncoders;
-  decoders: IntersectedPluginDecoders;
-};
-
-export = Jimp;
+import jimp = require('jimp');
+export = jimp;

[SimenB]

"ESM friendly syntax" is sorta broken by module.exports = jimp (i.e. explicit CJS) - mixing both types in the same module is sorta smelly - just accepting it's CJS and migrating to proper ESM later (when jimp is native ESM) seems better to me 🙂

[SimenB]

/es isn't actually ESM, it's still CJS. So loading the thing that doesn't try to pretend (too hard) it's ESM when it's not works out better 🙂

[SimenB]

FWIW, I tried to bundle into ESM, but it seems to not work as then the entire file needs to be ESM and jimp uses __dirname. Might be something we can fix with some ncc/webpack option, dunno

(although passing DIRNAME as env makes it work, DIRNAME=`pwd` node -e 'import("./dist/jimp.mjs").then(console.log)')

[pi0]

jimp uses __dirname

We might be able to inject a CJS context using mlly but I guess needs escaping webpack module wrapper and some more steps!

"ESM friendly syntax" is sorta broken by module.exports = jimp (i.e. explicit CJS) - mixing both types in the same module is sorta smelly - just accepting it's CJS and migrating to proper ESM later (when jimp is native ESM) seems better to me 🙂

Makes sense to do ESM improvement later. I was just wondering can we directly add a (CJS) .d.ts file to the project and keep the source/ts syntax cjs-free? The final ncc bundle seems a valid CJS module.

[SimenB]

Being require free but not exports free seems weird to me, but of course it'll work out 🙂 So if that's what you want you should go for it