lupine.api 1.1.57 → 1.1.59

package/src/api/api-shared-storage.ts

@@ -1,64 +1,64 @@
-/**
- * A persistent storage for the Api (stored in primary process)
- */
-import { IAppSharedStorage } from '../models';
-import { SimpleStorageDataProps } from '../models';
-import { apiCache } from './api-cache';
-
-// ApiSharedStorage is used in api module to store variables under appName scope, but is stored in one place - primary process
-export class ApiSharedStorage {
-  private storage: IAppSharedStorage | undefined;
-
-  public setAppSharedStorage(storage: IAppSharedStorage): void {
-    this.storage = storage;
-  }
-  public getAppSharedStorage(): IAppSharedStorage {
-    if (!this.storage) {
-      throw new Error('AppSharedStorage not initialized');
-    }
-    return this.storage;
-  }
-
-  // called from primary before exit, or from api to save changes
-  async save() {
-    const appName = apiCache.getAppName();
-    await this.getAppSharedStorage().save(appName);
-  }
-
-  get(key: string): Promise<string> {
-    const appName = apiCache.getAppName();
-    return this.getAppSharedStorage().get(appName, key);
-  }
-  getWeb(key: string): Promise<string> {
-    const appName = apiCache.getAppName();
-    return this.getAppSharedStorage().getWeb(appName, key);
-  }
-  getApi(key: string): Promise<string> {
-    const appName = apiCache.getAppName();
-    return this.getAppSharedStorage().getApi(appName, key);
-  }
-  getWebAll(): Promise<SimpleStorageDataProps> {
-    const appName = apiCache.getAppName();
-    return this.getAppSharedStorage().getWebAll(appName);
-  }
-  getWithPrefix(prefixKey: string): Promise<SimpleStorageDataProps> {
-    const appName = apiCache.getAppName();
-    return this.getAppSharedStorage().getWithPrefix(appName, prefixKey);
-  }
-
-  set(key: string, value: any) {
-    const appName = apiCache.getAppName();
-    return this.getAppSharedStorage().set(appName, key, value);
-  }
-  setWeb(key: string, value: any) {
-    const appName = apiCache.getAppName();
-    return this.getAppSharedStorage().setWeb(appName, key, value);
-  }
-  setApi(key: string, value: any) {
-    const appName = apiCache.getAppName();
-    return this.getAppSharedStorage().setApi(appName, key, value);
-  }
-}
-
-// this can be used in app, but in api, it should use getAppStorage()
-export const apiStorage = /* @__PURE__ */ new ApiSharedStorage();
+/**
+ * A persistent storage for the Api (stored in primary process)
+ */
+import { IAppSharedStorage } from '../models';
+import { SimpleStorageDataProps } from '../models';
+import { apiCache } from './api-cache';
+
+// ApiSharedStorage is used in api module to store variables under appName scope, but is stored in one place - primary process
+export class ApiSharedStorage {
+  private storage: IAppSharedStorage | undefined;
+
+  public setAppSharedStorage(storage: IAppSharedStorage): void {
+    this.storage = storage;
+  }
+  public getAppSharedStorage(): IAppSharedStorage {
+    if (!this.storage) {
+      throw new Error('AppSharedStorage not initialized');
+    }
+    return this.storage;
+  }
+
+  // called from primary before exit, or from api to save changes
+  async save() {
+    const appName = apiCache.getAppName();
+    await this.getAppSharedStorage().save(appName);
+  }
+
+  get(key: string): Promise<string> {
+    const appName = apiCache.getAppName();
+    return this.getAppSharedStorage().get(appName, key);
+  }
+  getWeb(key: string): Promise<string> {
+    const appName = apiCache.getAppName();
+    return this.getAppSharedStorage().getWeb(appName, key);
+  }
+  getApi(key: string): Promise<string> {
+    const appName = apiCache.getAppName();
+    return this.getAppSharedStorage().getApi(appName, key);
+  }
+  getWebAll(): Promise<SimpleStorageDataProps> {
+    const appName = apiCache.getAppName();
+    return this.getAppSharedStorage().getWebAll(appName);
+  }
+  getWithPrefix(prefixKey: string): Promise<SimpleStorageDataProps> {
+    const appName = apiCache.getAppName();
+    return this.getAppSharedStorage().getWithPrefix(appName, prefixKey);
+  }
+
+  set(key: string, value: any) {
+    const appName = apiCache.getAppName();
+    return this.getAppSharedStorage().set(appName, key, value);
+  }
+  setWeb(key: string, value: any) {
+    const appName = apiCache.getAppName();
+    return this.getAppSharedStorage().setWeb(appName, key, value);
+  }
+  setApi(key: string, value: any) {
+    const appName = apiCache.getAppName();
+    return this.getAppSharedStorage().setApi(appName, key, value);
+  }
+}
+
+// this can be used in app, but in api, it should use getAppStorage()
+export const apiStorage = /* @__PURE__ */ new ApiSharedStorage();

package/src/api/async-storage.ts

@@ -1,5 +1,5 @@
-// It is similar to a thread-local storage in other languages.
-import { AsyncLocalStorage } from 'node:async_hooks';
-import { AsyncStorageProps } from '../models/async-storage-props';
-
-export const asyncLocalStorage = new AsyncLocalStorage<AsyncStorageProps>();
+// It is similar to a thread-local storage in other languages.
+import { AsyncLocalStorage } from 'node:async_hooks';
+import { AsyncStorageProps } from '../models/async-storage-props';
+
+export const asyncLocalStorage = new AsyncLocalStorage<AsyncStorageProps>();

package/src/api/debug-service.ts

@@ -1,56 +1,56 @@
-import { IncomingMessage } from 'http';
-import { Duplex } from 'stream';
-import { MiniWebSocket } from './mini-web-socket';
-import { ShellService } from './shell-service';
-
-// This is only used in debug mode (no clusters)
-export class DebugService {
-  static clientRefreshFlag = Date.now();
-  static miniWebSocket = new MiniWebSocket(this.onMessage.bind(this));
-  static shellMap = new Map<Duplex, ShellService>();
-
-  public static onMessage(msg: string, socket: Duplex) {
-    try {
-      const json = JSON.parse(msg);
-      if (json.message === 'get-flag') {
-        this.miniWebSocket.sendMessage(
-          socket,
-          JSON.stringify({
-            message: 'flag',
-            flag: DebugService.clientRefreshFlag,
-          })
-        );
-      } else if (json.message === 'shell') {
-        console.log(json);
-        let shell: ShellService;
-        if (this.shellMap.has(socket)) {
-          shell = this.shellMap.get(socket)!;
-        } else {
-          shell = new ShellService(socket, this.miniWebSocket);
-          this.shellMap.set(socket, shell);
-          socket.on('close', () => {
-            shell.stop();
-            this.shellMap.delete(socket);
-          });
-        }
-        shell.cmd(json.cmd);
-      }
-    } catch (error) {
-      console.error(error);
-    }
-  }
-
-  public static handleUpgrade(req: IncomingMessage, socket: Duplex, head: Buffer) {
-    this.miniWebSocket.handleUpgrade(req, socket, head);
-
-    // socket.write(JSON.stringify({ message: 'flag', flag: DebugService.clientRefreshFlag }));
-  }
-
-  // broadcast to all frontend clients
-  public static broadcastRefresh() {
-    console.log(`${process.pid} - broadcast refresh request to clients.`);
-    this.clientRefreshFlag = Date.now();
-    const msg = { message: 'Refresh', flag: this.clientRefreshFlag };
-    this.miniWebSocket.broadcast(JSON.stringify(msg));
-  }
-}
+import { IncomingMessage } from 'http';
+import { Duplex } from 'stream';
+import { MiniWebSocket } from './mini-web-socket';
+import { ShellService } from './shell-service';
+
+// This is only used in debug mode (no clusters)
+export class DebugService {
+  static clientRefreshFlag = Date.now();
+  static miniWebSocket = new MiniWebSocket(this.onMessage.bind(this));
+  static shellMap = new Map<Duplex, ShellService>();
+
+  public static onMessage(msg: string, socket: Duplex) {
+    try {
+      const json = JSON.parse(msg);
+      if (json.message === 'get-flag') {
+        this.miniWebSocket.sendMessage(
+          socket,
+          JSON.stringify({
+            message: 'flag',
+            flag: DebugService.clientRefreshFlag,
+          })
+        );
+      } else if (json.message === 'shell') {
+        console.log(json);
+        let shell: ShellService;
+        if (this.shellMap.has(socket)) {
+          shell = this.shellMap.get(socket)!;
+        } else {
+          shell = new ShellService(socket, this.miniWebSocket);
+          this.shellMap.set(socket, shell);
+          socket.on('close', () => {
+            shell.stop();
+            this.shellMap.delete(socket);
+          });
+        }
+        shell.cmd(json.cmd);
+      }
+    } catch (error) {
+      console.error(error);
+    }
+  }
+
+  public static handleUpgrade(req: IncomingMessage, socket: Duplex, head: Buffer) {
+    this.miniWebSocket.handleUpgrade(req, socket, head);
+
+    // socket.write(JSON.stringify({ message: 'flag', flag: DebugService.clientRefreshFlag }));
+  }
+
+  // broadcast to all frontend clients
+  public static broadcastRefresh() {
+    console.log(`${process.pid} - broadcast refresh request to clients.`);
+    this.clientRefreshFlag = Date.now();
+    const msg = { message: 'Refresh', flag: this.clientRefreshFlag };
+    this.miniWebSocket.broadcast(JSON.stringify(msg));
+  }
+}

package/src/api/encode-html.ts

@@ -1,27 +1,27 @@
-export const encodeHtml = (str: string): string => {
-  return str.replace(
-    /[&<>'"]/g,
-    (tag) =>
-      ({
-        '&': '&amp;',
-        '<': '&lt;',
-        '>': '&gt;',
-        "'": '&#39;',
-        '"': '&quot;',
-      }[tag] || '')
-  );
-};
-
-export const decodeHtml = (str: string): string => {
-  return str.replace(
-    /&(\D+);/gi,
-    (tag) =>
-      ({
-        '&amp;': '&',
-        '&lt;': '<',
-        '&gt;': '>',
-        '&#39;': "'",
-        '&quot;': '"',
-      }[tag] || '')
-  );
-};
+export const encodeHtml = (str: string): string => {
+  return str.replace(
+    /[&<>'"]/g,
+    (tag) =>
+      ({
+        '&': '&amp;',
+        '<': '&lt;',
+        '>': '&gt;',
+        "'": '&#39;',
+        '"': '&quot;',
+      }[tag] || '')
+  );
+};
+
+export const decodeHtml = (str: string): string => {
+  return str.replace(
+    /&(\D+);/gi,
+    (tag) =>
+      ({
+        '&amp;': '&',
+        '&lt;': '<',
+        '&gt;': '>',
+        '&#39;': "'",
+        '&quot;': '"',
+      }[tag] || '')
+  );
+};

package/src/api/handle-status.ts

@@ -1,75 +1,75 @@
-import { ServerResponse } from 'http';
-import { encodeHtml } from './encode-html';
-import { IsType } from '../lib';
-
-export const handler200 = (res: ServerResponse, msg: string | object, title = '', contentType?: string) => {
-  handlerResponse(res, 200, title, msg, contentType);
-};
-
-export const handler304 = (res: ServerResponse, msg?: string | object, contentType?: string) => {
-  handlerResponse(res, 304, '304 Not Modified', msg, contentType);
-};
-
-export const handler400 = (res: ServerResponse, msg?: string | object, contentType?: string) => {
-  handlerResponse(res, 400, '400 Bad Request', msg, contentType);
-};
-
-export const handler403 = (res: ServerResponse, msg?: string | object, contentType?: string) => {
-  handlerResponse(res, 403, '403 Forbidden', msg, contentType);
-};
-
-export const handler405 = (res: ServerResponse, msg?: string | object, contentType?: string) => {
-  handlerResponse(res, 405, '405 Method Not Allowed', msg, contentType);
-};
-
-export const handler404 = (res: ServerResponse, msg?: string | object, contentType?: string) => {
-  handlerResponse(res, 404, '404 Not Found', msg, contentType);
-};
-
-export const handler416 = (res: ServerResponse, msg?: string | object, contentType?: string) => {
-  handlerResponse(res, 416, '416 Range Not Satisfiable', msg, contentType);
-};
-
-export const handler500 = (res: ServerResponse, msg?: string | object, contentType?: string) => {
-  handlerResponse(res, 500, '500 Internal Server Error', msg, contentType);
-};
-
-export const handler503 = (res: ServerResponse, msg?: string | object, contentType?: string) => {
-  handlerResponse(res, 503, '503 Service Unavailable', msg, contentType);
-};
-
-export const handlerResponse = (
-  res: ServerResponse,
-  statusCode: number,
-  title: string,
-  msg?: string | object,
-  contentType?: string
-) => {
-  res.statusCode = statusCode;
-  if (res.writable) {
-    try {
-      res.setHeader('content-type', contentType || 'text/html');
-    } catch (e) {
-      // errors may have been triggered when headers being sent already
-    }
-  }
-
-  const text = IsType.isObject(msg) ? JSON.stringify(msg) : (msg as string);
-  const html = contentType === 'application/json' ? msg : generateHtml(title, text || title);
-  res.end(html);
-};
-
-export const generateHtml = (title: string, message: string) => {
-  return `${[
-    '<!doctype html>',
-    '<html>',
-    '  <head>',
-    '    <meta charset="utf-8">',
-    `    <title>${title}</title>`,
-    '  </head>',
-    '  <body>',
-    `      <p>${encodeHtml(message)}</p>`,
-    '  </body>',
-    '</html>',
-  ].join('\n')}\n`;
-};
+import { ServerResponse } from 'http';
+import { encodeHtml } from './encode-html';
+import { IsType } from '../lib';
+
+export const handler200 = (res: ServerResponse, msg: string | object, title = '', contentType?: string) => {
+  handlerResponse(res, 200, title, msg, contentType);
+};
+
+export const handler304 = (res: ServerResponse, msg?: string | object, contentType?: string) => {
+  handlerResponse(res, 304, '304 Not Modified', msg, contentType);
+};
+
+export const handler400 = (res: ServerResponse, msg?: string | object, contentType?: string) => {
+  handlerResponse(res, 400, '400 Bad Request', msg, contentType);
+};
+
+export const handler403 = (res: ServerResponse, msg?: string | object, contentType?: string) => {
+  handlerResponse(res, 403, '403 Forbidden', msg, contentType);
+};
+
+export const handler405 = (res: ServerResponse, msg?: string | object, contentType?: string) => {
+  handlerResponse(res, 405, '405 Method Not Allowed', msg, contentType);
+};
+
+export const handler404 = (res: ServerResponse, msg?: string | object, contentType?: string) => {
+  handlerResponse(res, 404, '404 Not Found', msg, contentType);
+};
+
+export const handler416 = (res: ServerResponse, msg?: string | object, contentType?: string) => {
+  handlerResponse(res, 416, '416 Range Not Satisfiable', msg, contentType);
+};
+
+export const handler500 = (res: ServerResponse, msg?: string | object, contentType?: string) => {
+  handlerResponse(res, 500, '500 Internal Server Error', msg, contentType);
+};
+
+export const handler503 = (res: ServerResponse, msg?: string | object, contentType?: string) => {
+  handlerResponse(res, 503, '503 Service Unavailable', msg, contentType);
+};
+
+export const handlerResponse = (
+  res: ServerResponse,
+  statusCode: number,
+  title: string,
+  msg?: string | object,
+  contentType?: string
+) => {
+  res.statusCode = statusCode;
+  if (res.writable) {
+    try {
+      res.setHeader('content-type', contentType || 'text/html');
+    } catch (e) {
+      // errors may have been triggered when headers being sent already
+    }
+  }
+
+  const text = IsType.isObject(msg) ? JSON.stringify(msg) : (msg as string);
+  const html = contentType === 'application/json' ? msg : generateHtml(title, text || title);
+  res.end(html);
+};
+
+export const generateHtml = (title: string, message: string) => {
+  return `${[
+    '<!doctype html>',
+    '<html>',
+    '  <head>',
+    '    <meta charset="utf-8">',
+    `    <title>${title}</title>`,
+    '  </head>',
+    '  <body>',
+    `      <p>${encodeHtml(message)}</p>`,
+    '  </body>',
+    '</html>',
+  ].join('\n')}\n`;
+};

package/src/api/index.ts

@@ -1,16 +1,15 @@
-export * from './api-cache';
-export * from './api-helper';
-export * from './api-module';
-export * from './api-router';
-export * from './api-shared-storage';
-export * from './async-storage';
-export * from './debug-service';
-export * from './encode-html';
-export * from './handle-status';
-export * from './mini-web-socket';
-export * from './server-content-type';
-export * from './server-render';
-export * from './simple-storage';
-export * from './static-server';
-export * from './to-client-delivery';
-
+export * from './api-cache';
+export * from './api-helper';
+export * from './api-module';
+export * from './api-router';
+export * from './api-shared-storage';
+export * from './async-storage';
+export * from './debug-service';
+export * from './encode-html';
+export * from './handle-status';
+export * from './mini-web-socket';
+export * from './server-content-type';
+export * from './server-render';
+export * from './simple-storage';
+export * from './static-server';
+export * from './to-client-delivery';