@shaper.org/core 1.0.1 → 1.0.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,4 +1,4 @@
1
- //#region src/iframe-post-message.d.ts
1
+ //#region src/client/iframe-post-message.d.ts
2
2
  type PostMessageType = "server-ready" | "all-routes" | "route-change" | "route-refresh";
3
3
  interface PostMessage {
4
4
  message: any;
@@ -35,14 +35,19 @@ interface RouteRefreshMessage extends PostMessage {
35
35
  }
36
36
  declare class IframePostMessageClient {
37
37
  authHost: string;
38
+ private receiveCallbacks;
38
39
  constructor();
39
40
  _ensure_route_file(route: RouteInfo): void;
40
41
  _send(message: PostMessage): void;
42
+ /**
43
+ * Allow consumers to register callbacks for incoming messages.
44
+ */
45
+ onMessage(callback: (event: MessageEvent<any>) => void): void;
46
+ onReceiveMessage(message: MessageEvent<any>): void;
41
47
  sendServerReady(): void;
42
48
  sendAllRoutes(routes: RouteInfo[]): void;
43
49
  sendRouteChange(route: RouteInfo): void;
44
50
  sendRouteRefresh(route: RouteInfo): void;
45
51
  }
46
- declare const iframePostMessageClient: IframePostMessageClient;
47
52
  //#endregion
48
- export { AllRoutesMessage, IframePostMessageClient, PostMessage, PostMessageType, RouteChangeMessage, RouteInfo, RouteRefreshMessage, ServerReadyMessage, iframePostMessageClient };
53
+ export { AllRoutesMessage, IframePostMessageClient, PostMessage, PostMessageType, RouteChangeMessage, RouteInfo, RouteRefreshMessage, ServerReadyMessage };
@@ -1,17 +1,35 @@
1
- //#region src/iframe-post-message.ts
1
+ //#region src/client/iframe-post-message.ts
2
2
  var IframePostMessageClient = class {
3
3
  authHost;
4
+ receiveCallbacks = [];
4
5
  constructor() {
5
6
  if (!import.meta.env) throw new Error("import.meta.env is not defined");
6
7
  const AUTH_HOST = import.meta.env.VITE_FRONT_URL;
7
8
  this.authHost = AUTH_HOST.endsWith("/") ? AUTH_HOST.slice(0, -1) : AUTH_HOST;
9
+ this.receiveCallbacks = [];
10
+ this.onReceiveMessage = this.onReceiveMessage.bind(this);
11
+ window.addEventListener("message", this.onReceiveMessage);
8
12
  }
9
13
  _ensure_route_file(route) {
10
- if (!route.file.startsWith("src")) throw Error(`Invalid route path, route path should be relative to the root got: ${route.file}`);
14
+ if (!route.file.startsWith("src")) throw Error(`Invalid route file, route file should be relative to the root got: ${route.file}`);
11
15
  }
12
16
  _send(message) {
13
17
  window.parent.postMessage(message, this.authHost);
14
18
  }
19
+ /**
20
+ * Allow consumers to register callbacks for incoming messages.
21
+ */
22
+ onMessage(callback) {
23
+ this.receiveCallbacks.push(callback);
24
+ }
25
+ onReceiveMessage(message) {
26
+ if (message.origin !== this.authHost) return;
27
+ for (const cb of this.receiveCallbacks) try {
28
+ cb(message);
29
+ } catch (err) {
30
+ console.error("Provided callback failed:", err);
31
+ }
32
+ }
15
33
  sendServerReady() {
16
34
  this._send({
17
35
  type: "server-ready",
@@ -43,7 +61,6 @@ var IframePostMessageClient = class {
43
61
  this._send(message);
44
62
  }
45
63
  };
46
- const iframePostMessageClient = new IframePostMessageClient();
47
64
 
48
65
  //#endregion
49
- export { IframePostMessageClient, iframePostMessageClient };
66
+ export { IframePostMessageClient };
@@ -0,0 +1,26 @@
1
+ import * as vite0 from "vite";
2
+ import { HmrContext, ViteDevServer } from "vite";
3
+
4
+ //#region src/node/hmr-events-plugin.d.ts
5
+ declare const HMREventsPlugin: () => {
6
+ name: string;
7
+ enforce: string;
8
+ resolveId(id: string): "virtual:hmr-events-plugin" | undefined;
9
+ load(id: string): string | undefined;
10
+ transformIndexHtml(html: string): {
11
+ html: string;
12
+ tags: {
13
+ tag: string;
14
+ injectTo: string;
15
+ type: string;
16
+ attrs: {
17
+ src: string;
18
+ type: string;
19
+ };
20
+ }[];
21
+ };
22
+ configureServer(server: ViteDevServer): void;
23
+ handleHotUpdate(ctx: HmrContext): vite0.ModuleNode[];
24
+ };
25
+ //#endregion
26
+ export { HMREventsPlugin };
@@ -0,0 +1,47 @@
1
+ import { fileURLToPath } from "url";
2
+
3
+ //#region src/node/hmr-events-plugin.ts
4
+ const HMREventsPlugin = () => {
5
+ return {
6
+ name: "hmr-events-plugin",
7
+ enforce: "pre",
8
+ resolveId(id) {
9
+ if (id === "virtual:hmr-events-plugin") return id;
10
+ },
11
+ load(id) {
12
+ if (id === "virtual:hmr-events-plugin") {
13
+ const runtimePath = fileURLToPath(new URL("../runtime/error-tracker", import.meta.url));
14
+ return `import ${JSON.stringify(runtimePath)};`;
15
+ }
16
+ },
17
+ transformIndexHtml(html) {
18
+ return {
19
+ html,
20
+ tags: [{
21
+ tag: "script",
22
+ injectTo: "body",
23
+ type: "module",
24
+ attrs: {
25
+ src: "/@id/virtual:hmr-events-plugin",
26
+ type: "module"
27
+ }
28
+ }]
29
+ };
30
+ },
31
+ configureServer(server) {
32
+ server.ws.on("breeze:beforeUpdate", (event) => {});
33
+ server.ws.on("breeze:afterUpdate", (event) => {
34
+ for (let eventMessage of event.data) console.log(eventMessage.message);
35
+ console.log("[breeze] end update");
36
+ });
37
+ },
38
+ handleHotUpdate(ctx) {
39
+ const { file, timestamp, read, server, modules } = ctx;
40
+ console.log(`[breeze] hmr update: ${file}`);
41
+ return modules;
42
+ }
43
+ };
44
+ };
45
+
46
+ //#endregion
47
+ export { HMREventsPlugin };
@@ -0,0 +1,166 @@
1
+ import { ViteHook } from "./vite-hook";
2
+ import { ViteMessage } from "./vite-message";
3
+
4
+ interface LogEvent {
5
+ type: "logEvent";
6
+ logLevel: string;
7
+ timestamp: number;
8
+ message: string;
9
+ }
10
+
11
+ interface UnhandledrejectionEvent {
12
+ type: "unhandledrejectionEvent";
13
+ message: string;
14
+ timestamp: number;
15
+ }
16
+
17
+ interface ErrorEvent {
18
+ type: "errorEvent";
19
+ lineno: number;
20
+ colno: number;
21
+ filename: string;
22
+ message: string;
23
+ timestamp: number;
24
+ }
25
+
26
+ type Event = LogEvent | UnhandledrejectionEvent | ErrorEvent;
27
+
28
+ class ErrorTracker {
29
+ eventsQueue: Event[];
30
+
31
+ public vHook: ViteHook;
32
+ public viteMessage: ViteMessage;
33
+
34
+ constructor() {
35
+ this.eventsQueue = [];
36
+
37
+ this.viteMessage = new ViteMessage();
38
+
39
+ this.vHook = new ViteHook();
40
+ }
41
+
42
+ isBlankScreen() {
43
+ const app = document.querySelector("div#app");
44
+ return app ? app.childElementCount === 0 : false;
45
+ }
46
+
47
+ start() {
48
+ this.handleError();
49
+ this.handleUnhandledrejection();
50
+ this.consoleInterception();
51
+
52
+ let startTimestamp: number;
53
+ this.vHook.onBeforeUpdate((data, timestamp) => {
54
+ startTimestamp = timestamp;
55
+ this.viteMessage.sendBeforeUpdate(data);
56
+ });
57
+
58
+ this.vHook.onError((data, timestamp) => {
59
+ console.debug(data);
60
+ });
61
+
62
+ this.vHook.onAfterUpdate((data, timestamp) => {
63
+ setTimeout(() => {
64
+ const endTimestamp = Date.now();
65
+
66
+ let events = this.eventsQueue.filter(
67
+ (event) =>
68
+ event.timestamp >= startTimestamp &&
69
+ event.timestamp <= endTimestamp,
70
+ );
71
+
72
+ this.viteMessage.sendAfterUpdate(events);
73
+
74
+ this.eventsQueue = [];
75
+ }, 5);
76
+ });
77
+ }
78
+
79
+ consoleInterception() {
80
+ const originalConsole = {
81
+ log: console.log,
82
+ warn: console.warn,
83
+ error: console.error,
84
+ trace: console.trace,
85
+ // debug: console.debug,
86
+ };
87
+
88
+ for (let logLevel of Object.keys(originalConsole)) {
89
+ console[logLevel] = function (...args) {
90
+ const logArgumentsString = args.map((arg) => {
91
+ if (arg) {
92
+ return arg.toString();
93
+ }
94
+ });
95
+
96
+ this.eventsQueue.push({
97
+ type: "logEvent",
98
+ logLevel,
99
+ timestamp: Date.now(),
100
+ message: logArgumentsString.join(" "),
101
+ });
102
+ originalConsole[logLevel].apply(this, args);
103
+ }.bind(this);
104
+ }
105
+ }
106
+
107
+ handleUnhandledrejection() {
108
+ window.addEventListener("unhandledrejection", (evt) => {
109
+ console.debug(evt);
110
+ const UnhandledrejectionMessage = {
111
+ type: "unhandledrejectionEvent",
112
+ message: evt.reason.stack || evt.reason.message,
113
+ timestamp: Date.now(),
114
+ };
115
+
116
+ this.eventsQueue.push(UnhandledrejectionMessage);
117
+ });
118
+ }
119
+
120
+ handleError() {
121
+ window.addEventListener("error", (evt) => {
122
+ let message;
123
+ if (evt.error) {
124
+ message = evt.error.stack || evt.error.message;
125
+ } else {
126
+ message = evt.message;
127
+ }
128
+
129
+ console.debug(evt);
130
+ const errorMessage = {
131
+ type: "errorEvent",
132
+ lineno: evt.lineno,
133
+ colno: evt.colno,
134
+ filename: evt.filename,
135
+ message: message,
136
+ timestamp: Date.now(),
137
+ };
138
+
139
+ this.eventsQueue.push(errorMessage);
140
+ });
141
+
142
+ // This handle the following kind of runtime error
143
+ // For now it's diffcult to know what to do because those errors are not sync with the HMR lifecyle
144
+ // Maybe use a queue
145
+ // <script setup lang="ts">
146
+ // import { onMounted } from 'vue';
147
+
148
+ // onMounted(() => {
149
+ // // This will trigger the error event because it happens at runtime
150
+ // setTimeout(() => {
151
+ // undefinedFunction(); // Runtime error - WILL trigger window.error
152
+ // }, 0);
153
+ // });
154
+ // </script>
155
+ }
156
+ }
157
+
158
+ const tracker = new ErrorTracker();
159
+ tracker.start();
160
+
161
+ // HMR listening
162
+ // const handleMessage = (event) => {
163
+ // console.log(event);
164
+ // };
165
+
166
+ // window.addEventListener("message", handleMessage);
@@ -0,0 +1,133 @@
1
+ import {
2
+ ErrorPayload,
3
+ FullReloadPayload,
4
+ PrunePayload,
5
+ UpdatePayload,
6
+ } from "vite/types/hmrPayload.js";
7
+ import { ViteHotContext } from "vite/types/hot.js";
8
+
9
+ type ViteUpdateCallback =
10
+ | ((data: UpdatePayload, timestamp: number) => void)
11
+ | null;
12
+
13
+ type VitePruneCallback =
14
+ | ((data: PrunePayload, timestamp: number) => void)
15
+ | null;
16
+
17
+ type VitFullReloadCallback =
18
+ | ((data: FullReloadPayload, timestamp: number) => void)
19
+ | null;
20
+
21
+ type ViteErrorCallback =
22
+ | ((data: ErrorPayload, timestamp: number) => void)
23
+ | null;
24
+
25
+ type ViteInvalidateCallback = ((data: any, timestamp: number) => void) | null;
26
+
27
+ type ViteWebSocketConnectCallback =
28
+ | ((data: any, timestamp: number) => void)
29
+ | null;
30
+
31
+ type ViteWebSocketDisconnectCallback =
32
+ | ((data: any, timestamp: number) => void)
33
+ | null;
34
+
35
+ class ViteHook {
36
+ private hmr: ViteHotContext | undefined;
37
+ constructor() {
38
+ this.hmr = import.meta.hot;
39
+ }
40
+ hotExists(hmr: ViteHotContext | undefined): hmr is ViteHotContext {
41
+ if (hmr) return true;
42
+ console.error("HotContext does not exists");
43
+ return false;
44
+ }
45
+
46
+ onBeforeUpdate(fn: ViteUpdateCallback = null) {
47
+ if (!this.hotExists(this.hmr)) return;
48
+
49
+ this.hmr.on("vite:beforeUpdate", (data: UpdatePayload) => {
50
+ const timestamp = Date.now();
51
+ console.debug("beforeUpdate");
52
+ fn && fn(data, timestamp);
53
+ });
54
+ }
55
+
56
+ onAfterUpdate(fn: ViteUpdateCallback = null) {
57
+ if (!this.hotExists(this.hmr)) return;
58
+
59
+ this.hmr.on("vite:afterUpdate", (data: UpdatePayload) => {
60
+ const timestamp = Date.now();
61
+ console.debug("afterUpdate");
62
+ fn && fn(data, timestamp);
63
+ });
64
+ }
65
+
66
+ onBeforePrune(fn: VitePruneCallback = null) {
67
+ if (!this.hotExists(this.hmr)) return;
68
+
69
+ this.hmr.on("vite:beforePrune", (data: PrunePayload) => {
70
+ const timestamp = Date.now();
71
+ console.debug("beforePrune");
72
+
73
+ fn && fn(data, timestamp);
74
+ });
75
+ }
76
+
77
+ onBeforeFullReload(fn: VitFullReloadCallback = null) {
78
+ if (!this.hotExists(this.hmr)) return;
79
+
80
+ this.hmr.on("vite:beforeFullReload", (data: FullReloadPayload) => {
81
+ const timestamp = Date.now();
82
+ console.debug("beforeFullReload");
83
+
84
+ fn && fn(data, timestamp);
85
+ });
86
+ }
87
+
88
+ onError(fn: ViteErrorCallback = null) {
89
+ if (!this.hotExists(this.hmr)) return;
90
+
91
+ this.hmr.on("vite:error", (data: ErrorPayload) => {
92
+ const timestamp = Date.now();
93
+ console.debug("error");
94
+
95
+ fn && fn(data, timestamp);
96
+ });
97
+ }
98
+
99
+ onInvalidate(fn: ViteInvalidateCallback = null) {
100
+ if (!this.hotExists(this.hmr)) return;
101
+
102
+ this.hmr.on("vite:invalidate", (data: any) => {
103
+ const timestamp = Date.now();
104
+ console.debug("invalidate");
105
+
106
+ fn && fn(data, timestamp);
107
+ });
108
+ }
109
+
110
+ onWsConnect(fn: ViteWebSocketConnectCallback = null) {
111
+ if (!this.hotExists(this.hmr)) return;
112
+
113
+ this.hmr.on("vite:ws:connect", (data: any) => {
114
+ const timestamp = Date.now();
115
+ console.debug("ws:connect");
116
+
117
+ fn && fn(data, timestamp);
118
+ });
119
+ }
120
+
121
+ onWsDisconnect(fn: ViteWebSocketDisconnectCallback = null) {
122
+ if (!this.hotExists(this.hmr)) return;
123
+
124
+ this.hmr.on("vite:ws:disconnect", (data: any) => {
125
+ const timestamp = Date.now();
126
+ console.debug(":ws:disconnect");
127
+
128
+ fn && fn(data, timestamp);
129
+ });
130
+ }
131
+ }
132
+
133
+ export { ViteHook };
@@ -0,0 +1,61 @@
1
+ import { ViteHotContext } from "vite/types/hot.js";
2
+
3
+ interface MessageEvent {
4
+ type: "custom";
5
+ event: string;
6
+ data: any;
7
+ }
8
+
9
+ enum MessageEventType {
10
+ BEFORE_UPDATE = "breeze:beforeUpdate",
11
+ AFTER_UPDATE = "breeze:afterUpdate",
12
+ ERROR = "breeze:error",
13
+ }
14
+
15
+ class ViteMessage {
16
+ private server: ViteHotContext | undefined;
17
+
18
+ constructor() {
19
+ this.server = import.meta.hot;
20
+ }
21
+
22
+ hotExists(server: ViteHotContext | undefined): server is ViteHotContext {
23
+ if (server) return true;
24
+ console.error("HotContext does not exists");
25
+ return false;
26
+ }
27
+
28
+ send(event: string, message: MessageEvent) {
29
+ if (!this.hotExists(this.server)) return;
30
+ this.server.send(event, message);
31
+ }
32
+
33
+ sendBeforeUpdate(data: any) {
34
+ if (!this.hotExists(this.server)) return;
35
+ this.server.send(MessageEventType.BEFORE_UPDATE, {
36
+ type: "custom",
37
+ event: MessageEventType.BEFORE_UPDATE,
38
+ data: data,
39
+ });
40
+ }
41
+
42
+ sendError(data: any) {
43
+ if (!this.hotExists(this.server)) return;
44
+ this.server.send(MessageEventType.ERROR, {
45
+ type: "custom",
46
+ event: MessageEventType.ERROR,
47
+ data: data,
48
+ });
49
+ }
50
+
51
+ sendAfterUpdate(data: any) {
52
+ if (!this.hotExists(this.server)) return;
53
+ this.server.send(MessageEventType.AFTER_UPDATE, {
54
+ type: "custom",
55
+ event: MessageEventType.AFTER_UPDATE,
56
+ data: data,
57
+ });
58
+ }
59
+ }
60
+
61
+ export { ViteMessage };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@shaper.org/core",
3
- "version": "1.0.1",
3
+ "version": "1.0.3",
4
4
  "description": "",
5
5
  "type": "module",
6
6
  "private": false,
@@ -12,6 +12,14 @@
12
12
  "import": "./dist/index.mjs",
13
13
  "types": "./dist/index.d.ts"
14
14
  },
15
+ "./client": {
16
+ "import": "./dist/client/index.mjs",
17
+ "types": "./dist/client/index.d.ts"
18
+ },
19
+ "./node": {
20
+ "import": "./dist/node/index.mjs",
21
+ "types": "./dist/node/index.d.ts"
22
+ },
15
23
  "./package.json": "./package.json"
16
24
  },
17
25
  "types": "./dist/index.d.ts",
@@ -36,12 +44,20 @@
36
44
  },
37
45
  "dependencies": {
38
46
  "@rolldown/pluginutils": "1.0.0-beta.50",
39
- "tsup": "^8.5.1"
47
+ "tsup": "^8.5.1",
48
+ "esbuild": "^0.27.0"
40
49
  },
41
50
  "tsdown": {
42
51
  "dts": true,
43
52
  "format": [
44
53
  "esm"
54
+ ],
55
+ "copy": [
56
+ "src/runtime/"
57
+ ],
58
+ "entry": [
59
+ "src/node/index.ts",
60
+ "src/client/index.ts"
45
61
  ]
46
62
  },
47
63
  "publishConfig": {