@gjsify/esbuild-plugin-deepkit 0.0.2

package/README.md

@@ -0,0 +1,56 @@
+# @gjsify/esbuild-plugin-deepkit
+
+A [esbuild](https://esbuild.github.io/) plugin for the the compiler/transformer of [@deepkit/type](https://deepkit.io/library/type).
+
+## Example
+
+src/index.ts:
+```ts
+import { deserialize } from '@deepkit/type';
+
+interface Config {
+    color: string;
+}
+
+interface User {
+    id: number;
+    createdAt: Date;
+    firstName?: string;
+    lastName?: string;
+    config: Config;
+    username: string;
+}
+
+//deserialize JSON object to real instances
+const user = deserialize<User>({
+    id: 0,
+    username: 'peter',
+    createdAt: '2021-06-26T12:34:41.061Z',
+    config: {color: '#221122'},
+});
+
+
+console.log(user.createdAt instanceof Date); // true
+```
+
+esbuild.mjs:
+```js
+import { build } from 'esbuild';
+import { deepkitPlugin } from '@gjsify/esbuild-plugin-deepkit';
+
+build({
+    entryPoints: ['src/index.ts'],
+    bundle: true,
+    minify: true,
+    outfile: 'dist/index.js',
+    format: 'esm',
+    platform: "node",
+    external: ['@deepkit/type'],
+    plugins: [deepkitPlugin()],
+});
+```
+Start:
+```bash
+node dist/index.js
+-> true
+```

package/dist/cjs/index.cjs

@@ -0,0 +1 @@
+var g=Object.create;var i=Object.defineProperty;var D=Object.getOwnPropertyDescriptor;var O=Object.getOwnPropertyNames;var L=Object.getPrototypeOf,y=Object.prototype.hasOwnProperty;var h=(t,e)=>{for(var n in e)i(t,n,{get:e[n],enumerable:!0})},a=(t,e,n,r)=>{if(e&&typeof e=="object"||typeof e=="function")for(let o of O(e))!y.call(t,o)&&o!==n&&i(t,o,{get:()=>e[o],enumerable:!(r=D(e,o))||r.enumerable});return t};var k=(t,e,n)=>(n=t!=null?g(L(t)):{},a(e||!t||!t.__esModule?i(n,"default",{value:t,enumerable:!0}):n,t)),P=t=>a(i({},"__esModule",{value:!0}),t);var T={};h(T,{deepkitPlugin:()=>m,default:()=>A,transformExtern:()=>R});module.exports=P(T);var l=require("fs/promises"),c=k(require("@deepkit/type-compiler")),s=require("util");var p=t=>new TextDecoder().decode(t);var f=new c.DeepkitLoader,d=(...t)=>{console.log("printDiagnostics",(0,s.inspect)(t,!1,10,!0))},u={filter:/\.(m|c)?tsx?$/,namespace:"file"},R=(t,e,n)=>{if(!t.reflection||!n.contents||!u.filter.test(e.path)||e.pluginData?.isReflected)return n;let r=e.namespace+":"+e.path;try{let o=typeof n.contents=="string"?n.contents:p(n.contents);n.contents=f.transform(o,r),n.pluginData=n.pluginData||{},n.pluginData.isReflected=!0}catch(o){d({file:r,error:o})}return n},x=async t=>{let e;try{if(e=await(0,l.readFile)(t.path,"utf8"),t.pluginData?.isReflected)return{contents:e,loader:"ts",pluginData:{isReflected:!0}};e=f.transform(e,t.path)}catch(n){return d({file:t.path,error:n}),null}return{contents:e,loader:"ts",pluginData:{isReflected:!0}}},m=(t={})=>({name:"deepkit",setup(e){t.reflection=t.reflection===void 0?!0:t.reflection,t.reflection&&e.onLoad(u,x)}}),A=m;0&&(module.exports={deepkitPlugin,transformExtern});

package/dist/esm/index.mjs

@@ -0,0 +1 @@
+import{readFile as s}from"fs/promises";import*as a from"@deepkit/type-compiler";import{inspect as f}from"util";var i=t=>new TextDecoder().decode(t);var p=new a.DeepkitLoader,l=(...t)=>{console.log("printDiagnostics",f(t,!1,10,!0))},c={filter:/\.(m|c)?tsx?$/,namespace:"file"},L=(t,e,n)=>{if(!t.reflection||!n.contents||!c.filter.test(e.path)||e.pluginData?.isReflected)return n;let r=e.namespace+":"+e.path;try{let o=typeof n.contents=="string"?n.contents:i(n.contents);n.contents=p.transform(o,r),n.pluginData=n.pluginData||{},n.pluginData.isReflected=!0}catch(o){l({file:r,error:o})}return n},d=async t=>{let e;try{if(e=await s(t.path,"utf8"),t.pluginData?.isReflected)return{contents:e,loader:"ts",pluginData:{isReflected:!0}};e=p.transform(e,t.path)}catch(n){return l({file:t.path,error:n}),null}return{contents:e,loader:"ts",pluginData:{isReflected:!0}}},u=(t={})=>({name:"deepkit",setup(e){t.reflection=t.reflection===void 0?!0:t.reflection,t.reflection&&e.onLoad(c,d)}}),y=u;export{u as deepkitPlugin,y as default,L as transformExtern};

package/dist/types/index.d.ts

@@ -0,0 +1,16 @@
+import type { Plugin, OnLoadArgs, OnLoadResult } from 'esbuild';
+export interface DeepkitPluginOptions {
+    reflection?: boolean;
+}
+/**
+ * Use this method if you want to transform your typescript in any other plugin / onLoad callback method
+ * @param options +
+ * @param args
+ * @param result
+ * @returns
+ */
+export declare const transformExtern: (options: DeepkitPluginOptions, args: Partial<OnLoadArgs> & {
+    path: string;
+}, result: OnLoadResult) => OnLoadResult | null;
+export declare const deepkitPlugin: (options?: DeepkitPluginOptions) => Plugin;
+export default deepkitPlugin;

package/dist/types/utils.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Utf8Array to string
+ * @param array Utf-8 Array
+ * @returns The converted string
+ * @credits https://stackoverflow.com/a/41798356/1465919
+ * @credits https://stackoverflow.com/a/36949791/1465919
+ */
+export declare const Utf8ArrayToStr: (array: Uint8Array) => string;

package/esbuild.mjs

@@ -0,0 +1,46 @@
+import { build } from 'esbuild';
+import { readFile } from 'fs/promises';
+
+const pkg  = JSON.parse(
+    await readFile(
+      new URL('./package.json', import.meta.url)
+    )
+);
+
+const baseConfig = {
+    entryPoints: ['src/index.ts'],
+    bundle: true,
+    minify: true,
+    external: [
+        'fs',
+        'fs/promises',
+        'util',
+        'path',
+        'process',
+        'util',
+        'typescript',
+        '@deepkit/type-compiler',
+        'esbuild',
+        // '@gjsify/resolve-npm', can't be required in cjs builds
+        '@gjsify/esbuild-plugin-transform-ext',
+        '@gjsify/esbuild-plugin-deno-loader',
+        '@gjsify/esbuild-plugin-gjsify',
+    ]
+}
+
+if(pkg.main) {
+    build({
+        ...baseConfig,
+        outfile: pkg.main,
+        format: 'cjs',
+        platform: "node",
+    });
+}
+
+if(pkg.main) {
+    build({
+        ...baseConfig,
+        outfile: pkg.module,
+        format: 'esm',
+    });
+}

package/package.json

@@ -0,0 +1,29 @@
+{
+  "name": "@gjsify/esbuild-plugin-deepkit",
+  "version": "0.0.2",
+  "description": "Deepkit type compiler plugin for esbuild",
+  "type": "commonjs",
+  "main": "dist/cjs/index.cjs",
+  "module": "dist/esm/index.mjs",
+  "types": "dist/types/index.d.ts",
+  "scripts": {
+    "clear": "rm -rf dist tsconfig.tsbuildinfo",
+    "print:name": "echo '@gjsify/esbuild-plugin-deepkit'",
+    "build": "yarn print:name && yarn build:js && yarn build:types",
+    "build:js": "node esbuild.mjs",
+    "build:types": "yarn tsc --emitDeclarationOnly"
+  },
+  "keywords": [
+    "gjs",
+    "node",
+    "fs"
+  ],
+  "dependencies": {
+    "@deepkit/type-compiler": "^1.0.1-alpha.97"
+  },
+  "devDependencies": {
+    "@types/node": "^20.3.1",
+    "esbuild": "^0.18.2",
+    "typescript": "^5.1.3"
+  }
+}

package/src/index.ts

@@ -0,0 +1,83 @@
+import { readFile } from 'fs/promises';
+import * as DkType from '@deepkit/type-compiler';
+import { inspect } from 'util';
+import { Utf8ArrayToStr } from './utils.js';
+
+import type { Plugin, OnLoadArgs, OnLoadResult, OnLoadOptions } from 'esbuild';
+
+const loader = new DkType.DeepkitLoader();
+
+export interface DeepkitPluginOptions {
+  reflection?: boolean;
+}
+
+const printDiagnostics = (...args: any[]) => {
+  console.log("printDiagnostics", inspect(args, false, 10, true));
+}
+
+const deepkitPluginOnLoadOptions: OnLoadOptions = { filter: /\.(m|c)?tsx?$/, namespace: 'file'};
+
+/**
+ * Use this method if you want to transform your typescript in any other plugin / onLoad callback method
+ * @param options +
+ * @param args 
+ * @param result 
+ * @returns 
+ */
+export const transformExtern = (options: DeepkitPluginOptions, args: Partial<OnLoadArgs> & { path: string; }, result: OnLoadResult): OnLoadResult | null => {
+  if(!options.reflection || !result.contents || !deepkitPluginOnLoadOptions.filter.test(args.path) || args.pluginData?.isReflected) {
+    return result;
+  }
+
+  const path = args.namespace + ':' + args.path;
+
+  try {
+    const contentStr = typeof result.contents === 'string' ? result.contents : Utf8ArrayToStr(result.contents);
+    result.contents = loader.transform(contentStr, path);
+    result.pluginData = result.pluginData || {};
+    result.pluginData.isReflected = true;
+  } catch (error) {
+    printDiagnostics({ file: path, error });
+  }
+
+  return result;
+}
+
+const onLoad = async (args: OnLoadArgs): Promise<OnLoadResult | null | undefined> => {
+  let contents: string;
+
+  // console.debug("[deepkit] onLoad", args.path);
+
+  try {
+    contents = await readFile(args.path, 'utf8');
+    // If already reflected do nothing
+    if(args.pluginData?.isReflected) {
+      return { contents, loader: 'ts', pluginData: { isReflected: true } };
+    }
+
+    contents = loader.transform(contents, args.path);
+  } catch (error) {
+    printDiagnostics({ file: args.path, error });
+    return null;
+  }
+  
+  return { contents, loader: 'ts', pluginData: { isReflected: true } };
+}
+
+export const deepkitPlugin = (options: DeepkitPluginOptions = {}): Plugin => {
+  return {
+    name: 'deepkit',
+    setup(build) {
+      options.reflection = options.reflection === undefined ? true : options.reflection;
+
+      if (!options.reflection) {
+        return;
+      }
+
+      build.onLoad(deepkitPluginOnLoadOptions, onLoad);
+
+    }
+  }
+}
+
+export default deepkitPlugin;

package/src/utils.ts

@@ -0,0 +1,10 @@
+/**
+ * Utf8Array to string
+ * @param array Utf-8 Array 
+ * @returns The converted string
+ * @credits https://stackoverflow.com/a/41798356/1465919
+ * @credits https://stackoverflow.com/a/36949791/1465919
+ */
+export const Utf8ArrayToStr = (array: Uint8Array) => {
+    return new TextDecoder().decode(array);
+}

package/tsconfig.json

@@ -0,0 +1,12 @@
+{
+    "compilerOptions": {
+      "outDir": "dist",
+      "declarationDir": "dist/types",
+      "declaration": true,
+      "target": "ESNext",
+      "module": "ESNext",
+      "types": ["node"],
+      "moduleResolution": "bundler"
+    },
+    "files": ["src/index.ts"]
+}