lupine.api 1.1.57 → 1.1.59

package/src/lib/utils/is-type.ts

@@ -1,48 +1,48 @@
-export class IsType {
-  static getType(obj: any) {
-    var type = typeof obj;
-    if (type === 'undefined') return 'undefined';
-    else if (type === 'string' || obj instanceof String) return 'string';
-    else if (type === 'number' || obj instanceof Number) return 'number';
-    else if (type === 'function' || obj instanceof Function) return 'function';
-    else if (!!obj && obj.constructor === Array) return 'array';
-    else if (obj && obj.nodeType === 1) return 'element';
-    else if (type === 'object') return 'object';
-    else return 'unknown';
-  }
-
-  static isArray(input: any) {
-    return input instanceof Array || Object.prototype.toString.call(input) === '[object Array]';
-  }
-
-  static isObject(input: any) {
-    // null is not object
-    return input !== null && Object.prototype.toString.call(input) === '[object Object]';
-  }
-
-  static isObjectEmpty(obj: any) {
-    if (Object.getOwnPropertyNames) {
-      return Object.getOwnPropertyNames(obj).length === 0;
-    } else {
-      var k;
-      for (k in obj) {
-        if (obj.hasOwnProperty(k)) {
-          return false;
-        }
-      }
-      return true;
-    }
-  }
-
-  static isUndefined(input: any) {
-    return input === void 0;
-  }
-
-  static isNumber(input: any) {
-    return typeof input === 'number' || Object.prototype.toString.call(input) === '[object Number]';
-  }
-
-  static isDate(input: any) {
-    return input instanceof Date || Object.prototype.toString.call(input) === '[object Date]';
-  }
-}
+export class IsType {
+  static getType(obj: any) {
+    var type = typeof obj;
+    if (type === 'undefined') return 'undefined';
+    else if (type === 'string' || obj instanceof String) return 'string';
+    else if (type === 'number' || obj instanceof Number) return 'number';
+    else if (type === 'function' || obj instanceof Function) return 'function';
+    else if (!!obj && obj.constructor === Array) return 'array';
+    else if (obj && obj.nodeType === 1) return 'element';
+    else if (type === 'object') return 'object';
+    else return 'unknown';
+  }
+
+  static isArray(input: any) {
+    return input instanceof Array || Object.prototype.toString.call(input) === '[object Array]';
+  }
+
+  static isObject(input: any) {
+    // null is not object
+    return input !== null && Object.prototype.toString.call(input) === '[object Object]';
+  }
+
+  static isObjectEmpty(obj: any) {
+    if (Object.getOwnPropertyNames) {
+      return Object.getOwnPropertyNames(obj).length === 0;
+    } else {
+      var k;
+      for (k in obj) {
+        if (obj.hasOwnProperty(k)) {
+          return false;
+        }
+      }
+      return true;
+    }
+  }
+
+  static isUndefined(input: any) {
+    return input === void 0;
+  }
+
+  static isNumber(input: any) {
+    return typeof input === 'number' || Object.prototype.toString.call(input) === '[object Number]';
+  }
+
+  static isDate(input: any) {
+    return input instanceof Date || Object.prototype.toString.call(input) === '[object Date]';
+  }
+}

package/src/lib/utils/load-env.ts

@@ -1,14 +1,14 @@
-import * as webEnv from '../../common-js/web-env.js';
-
-export const loadEnv = async (envFile: string, overrideEnv: boolean = false) => {
-  return webEnv.loadEnv(envFile, overrideEnv);
-};
-
-export const getWebEnv = (appName: string): { [k: string]: string } => {
-  return webEnv.getWebEnv(appName) as { [k: string]: string };
-};
-
-// // Replace <!--META-ENV-START-->...<!--META-ENV-END--> for mobile app and replace it again for web app
-// export const replaceWebEnv = (html: string, appName: string, addMetaTag: boolean) => {
-//   return webEnv.replaceWebEnv(html, appName, addMetaTag);
-// }
+import * as webEnv from '../../common-js/web-env.js';
+
+export const loadEnv = async (envFile: string, overrideEnv: boolean = false) => {
+  return webEnv.loadEnv(envFile, overrideEnv);
+};
+
+export const getWebEnv = (appName: string): { [k: string]: string } => {
+  return webEnv.getWebEnv(appName) as { [k: string]: string };
+};
+
+// // Replace <!--META-ENV-START-->...<!--META-ENV-END--> for mobile app and replace it again for web app
+// export const replaceWebEnv = (html: string, appName: string, addMetaTag: boolean) => {
+//   return webEnv.replaceWebEnv(html, appName, addMetaTag);
+// }

package/src/lib/utils/pad.ts

@@ -1,6 +1,6 @@
-export const padRight = (str: string, length: number, fillString: string) => {
-  return str.padEnd(length, fillString);
-};
-export const padLeft = (str: string, length: number, fillString: string) => {
-  return str.padStart(length, fillString);
-};
+export const padRight = (str: string, length: number, fillString: string) => {
+  return str.padEnd(length, fillString);
+};
+export const padLeft = (str: string, length: number, fillString: string) => {
+  return str.padStart(length, fillString);
+};

package/src/models/api-base.ts

@@ -1,5 +1,5 @@
-import { IApiRouter } from './api-router-props';
-
-export interface IApiBase {
-  getRouter(): IApiRouter;
-}
+import { IApiRouter } from './api-router-props';
+
+export interface IApiBase {
+  getRouter(): IApiRouter;
+}

package/src/models/api-module-props.ts

@@ -1,11 +1,10 @@
-import { ServerResponse } from 'http';
-import { AsyncStorageProps } from './async-storage-props';
-import { ServerRequest } from './locals-props';
-import { HostToPathProps } from './host-to-path-props';
-import { IAppCache } from './app-cache-props';
-import { IAppSharedStorage } from './app-shared-storage-props';
-;
-export interface IApiModule {
-  processApi(store: AsyncStorageProps, url: string, req: ServerRequest, res: ServerResponse): Promise<boolean>;
-  initApi(appConfig: HostToPathProps, appCache: IAppCache, appStorage: IAppSharedStorage): Promise<void>;
-}
+import { ServerResponse } from 'http';
+import { AsyncStorageProps } from './async-storage-props';
+import { ServerRequest } from './locals-props';
+import { HostToPathProps } from './host-to-path-props';
+import { IAppCache } from './app-cache-props';
+import { IAppSharedStorage } from './app-shared-storage-props';
+export interface IApiModule {
+  processApi(store: AsyncStorageProps, url: string, req: ServerRequest, res: ServerResponse): Promise<boolean>;
+  initApi(appConfig: HostToPathProps, appCache: IAppCache, appStorage: IAppSharedStorage): Promise<void>;
+}

package/src/models/api-router-props.ts

@@ -1,26 +1,26 @@
-import { ServerResponse } from 'http';
-import { ServerRequest } from './locals-props';
-
-export type ApiRouterCallback = (req: ServerRequest, res: ServerResponse, rootUrl?: string) => Promise<boolean>;
-
-export enum ApiRouterMethod {
-  ALL = 'ALL',
-  GET = 'GET',
-  POST = 'POST',
-}
-export type ApiRouterData = {
-  path: string;
-  handler: (ApiRouterCallback | IApiRouter)[];
-  method: ApiRouterMethod;
-  parameterVariables: string[];
-  parameterLength: number;
-};
-
-export interface IApiRouter {
-  get(path: string, ...handler: (ApiRouterCallback | IApiRouter)[]): void;
-  post(path: string, ...handler: (ApiRouterCallback | IApiRouter)[]): void;
-  use(path: string, ...handler: (ApiRouterCallback | IApiRouter)[]): void;
-  setFilter(filter: ApiRouterCallback): void;
-  findRoute(url: string, req: ServerRequest, res: ServerResponse, handleNotFound: boolean): Promise<boolean>;
-  handleRequest(url: string, req: ServerRequest, res: ServerResponse): Promise<boolean>;
-}
+import { ServerResponse } from 'http';
+import { ServerRequest } from './locals-props';
+
+export type ApiRouterCallback = (req: ServerRequest, res: ServerResponse, rootUrl?: string) => Promise<boolean>;
+
+export enum ApiRouterMethod {
+  ALL = 'ALL',
+  GET = 'GET',
+  POST = 'POST',
+}
+export type ApiRouterData = {
+  path: string;
+  handler: (ApiRouterCallback | IApiRouter)[];
+  method: ApiRouterMethod;
+  parameterVariables: string[];
+  parameterLength: number;
+};
+
+export interface IApiRouter {
+  get(path: string, ...handler: (ApiRouterCallback | IApiRouter)[]): void;
+  post(path: string, ...handler: (ApiRouterCallback | IApiRouter)[]): void;
+  use(path: string, ...handler: (ApiRouterCallback | IApiRouter)[]): void;
+  setFilter(filter: ApiRouterCallback): void;
+  findRoute(url: string, req: ServerRequest, res: ServerResponse, handleNotFound: boolean): Promise<boolean>;
+  handleRequest(url: string, req: ServerRequest, res: ServerResponse): Promise<boolean>;
+}

package/src/models/app-cache-props.ts

@@ -1,33 +1,33 @@
-// interface of AppCache
-
-export const AppCacheGlobal = 'APP_GLOBAL';
-
-export enum AppCacheKeys {
-  APP_DEBUG = 'APP_DEBUG',
-  // APP_ENV_FILE = 'APP_ENV_FILE', // app's env file, for api to reload
-  APP_LIST = 'APP_LIST', // all app names list
-  TEMPLATE = 'TEMPLATE',
-  APP_DATA = 'APP_DATA',
-  NODE_ENV = 'NODE_ENV',
-  API_MODULE = 'API_MODULE',
-  API_CONFIG = 'API_CONFIG',
-  RENDER_PAGE_FUNCTIONS = 'RENDER_PAGE_FUNCTIONS',
-
-  START_TIME = 'START_TIME',
-}
-
-export interface IAppCache {
-  clear(appName: string | undefined): void;
-  get(appName: string, key: string): any;
-  set(appName: string, key: string, value: any): void;
-  clearTemplateCache(): void;
-}
-const _savedCache: { appCache: IAppCache | null } = {
-  appCache: null,
-};
-export const getAppCache = (): IAppCache => {
-  return _savedCache.appCache!;
-};
-export const setAppCache = (cache: IAppCache) => {
-  _savedCache.appCache = cache;
-};
+// interface of AppCache
+
+export const AppCacheGlobal = 'APP_GLOBAL';
+
+export enum AppCacheKeys {
+  APP_DEBUG = 'APP_DEBUG',
+  // APP_ENV_FILE = 'APP_ENV_FILE', // app's env file, for api to reload
+  APP_LIST = 'APP_LIST', // all app names list
+  TEMPLATE = 'TEMPLATE',
+  APP_DATA = 'APP_DATA',
+  NODE_ENV = 'NODE_ENV',
+  API_MODULE = 'API_MODULE',
+  API_CONFIG = 'API_CONFIG',
+  RENDER_PAGE_FUNCTIONS = 'RENDER_PAGE_FUNCTIONS',
+
+  START_TIME = 'START_TIME',
+}
+
+export interface IAppCache {
+  clear(appName: string | undefined): void;
+  get(appName: string, key: string): any;
+  set(appName: string, key: string, value: any): void;
+  clearTemplateCache(): void;
+}
+const _savedCache: { appCache: IAppCache | null } = {
+  appCache: null,
+};
+export const getAppCache = (): IAppCache => {
+  return _savedCache.appCache!;
+};
+export const setAppCache = (cache: IAppCache) => {
+  _savedCache.appCache = cache;
+};

package/src/models/app-data-props.ts

@@ -1,10 +1,10 @@
-import { Db } from '../lib/db';
-
-export type AppDataProps = {
-  db: Db;
-  dbType: string;
-  dbFilename: string;
-  config: any;
-  dataPath: string;
-  webPath: string;
-};
+import { Db } from '../lib/db';
+
+export type AppDataProps = {
+  db: Db;
+  dbType: string;
+  dbFilename: string;
+  config: any;
+  dataPath: string;
+  webPath: string;
+};

package/src/models/app-helper-props.ts

@@ -1,6 +1,6 @@
-import { HostToPathProps } from './host-to-path-props';
-
-export type AppLoaderProps = {
-  serverRoot: string;
-  webHostMap: HostToPathProps[];
-};
+import { HostToPathProps } from './host-to-path-props';
+
+export type AppLoaderProps = {
+  serverRoot: string;
+  webHostMap: HostToPathProps[];
+};

package/src/models/app-shared-storage-props.ts

@@ -1,38 +1,38 @@
-import { ISimpleStorage, SimpleStorageDataProps } from './simple-storage-props';
-
-// interface of AppSharedStorage
-export const AppSharedStorageMessageId = 'AppSharedStorage';
-export type StorageMessageAction = 'get' | 'set' | 'load'  | 'save' | 'getWithPrefix';
-export interface StorageMessageFromSubProcess {
-  id: string;
-  pid: number | undefined;
-  workerId: number;
-  action: StorageMessageAction;
-  key: string;
-  prefixKey?: string;
-  value?: any;
-  uniqueKey?: string;
-  appName: string;
-  rootPath?: string;
-}
-
-// also used in packages\lupine.api\src\common-js\web-env.js
-export const AppSharedStorageWebPrefix = 'WEB.';
-export const AppSharedStorageApiPrefix = 'API.';
-
-export interface IAppSharedStorage {
-  // this is a worker and msg is from Primary (but when debug is on, it's primary)
-  messageFromPrimaryProcess(msgObject: any): void;
-  // this is primary, msg is from a client
-  messageFromSubProcess(msgObject: any): void;
-  load(appName: string, rootPath: string): Promise<void>;
-  save(appName?: string, exit?: boolean): Promise<void>;
-  get(appName: string, key: string): Promise<string>;
-  getWeb(appName: string, key: string): Promise<string>;
-  getApi(appName: string, key: string): Promise<string>;
-  getWebAll(appName: string): Promise<SimpleStorageDataProps>;
-  getWithPrefix(appName: string, prefixKey: string): Promise<SimpleStorageDataProps>;
-  set(appName: string, key: string, value: any): void;
-  setWeb(appName: string, key: string, value: any): void;
-  setApi(appName: string, key: string, value: any): void;
-}
+import { ISimpleStorage, SimpleStorageDataProps } from './simple-storage-props';
+
+// interface of AppSharedStorage
+export const AppSharedStorageMessageId = 'AppSharedStorage';
+export type StorageMessageAction = 'get' | 'set' | 'load' | 'save' | 'getWithPrefix';
+export interface StorageMessageFromSubProcess {
+  id: string;
+  pid: number | undefined;
+  workerId: number;
+  action: StorageMessageAction;
+  key: string;
+  prefixKey?: string;
+  value?: any;
+  uniqueKey?: string;
+  appName: string;
+  rootPath?: string;
+}
+
+// also used in packages\lupine.api\src\common-js\web-env.js
+export const AppSharedStorageWebPrefix = 'WEB.';
+export const AppSharedStorageApiPrefix = 'API.';
+
+export interface IAppSharedStorage {
+  // this is a worker and msg is from Primary (but when debug is on, it's primary)
+  messageFromPrimaryProcess(msgObject: any): void;
+  // this is primary, msg is from a client
+  messageFromSubProcess(msgObject: any): void;
+  load(appName: string, rootPath: string): Promise<void>;
+  save(appName?: string, exit?: boolean): Promise<void>;
+  get(appName: string, key: string): Promise<string>;
+  getWeb(appName: string, key: string): Promise<string>;
+  getApi(appName: string, key: string): Promise<string>;
+  getWebAll(appName: string): Promise<SimpleStorageDataProps>;
+  getWithPrefix(appName: string, prefixKey: string): Promise<SimpleStorageDataProps>;
+  set(appName: string, key: string, value: any): void;
+  setWeb(appName: string, key: string, value: any): void;
+  setApi(appName: string, key: string, value: any): void;
+}

package/src/models/app-start-props.ts

@@ -1,18 +1,18 @@
-import { RenderPageFunctionsType } from '../api';
-import { AppLoaderProps } from './app-helper-props';
-
-export type InitStartProps = {
-  bindIp: string;
-  httpPort: number;
-  httpsPort: number;
-  sslKeyPath: string;
-  sslCrtPath: string;
-};
-
-export type AppStartProps = {
-  debug: boolean;
-  appEnvFile: string;
-  apiConfig: AppLoaderProps;
-  serverConfig: InitStartProps;
-  renderPageFunctions: RenderPageFunctionsType;
-};
+import { RenderPageFunctionsType } from '../api';
+import { AppLoaderProps } from './app-helper-props';
+
+export type InitStartProps = {
+  bindIp: string;
+  httpPort: number;
+  httpsPort: number;
+  sslKeyPath: string;
+  sslCrtPath: string;
+};
+
+export type AppStartProps = {
+  debug: boolean;
+  appEnvFile: string;
+  apiConfig: AppLoaderProps;
+  serverConfig: InitStartProps;
+  renderPageFunctions: RenderPageFunctionsType;
+};

package/src/models/async-storage-props.ts

@@ -1,13 +1,13 @@
-import { LocalsProps } from './locals-props';
-import { HostToPathProps } from './host-to-path-props';
-
-// language code: https://www.andiamo.co.uk/resources/iso-language-codes/
-// English: en, Chinese (PRC): zh-cn, Chinese (Hong Kong): zh-hk, Chinese (Taiwan): zh-tw, Japanese: ja, Korean: ko
-export type AsyncStorageProps = {
-  uuid: string;
-  appName: string;
-  hostPath: HostToPathProps;
-  locals: LocalsProps;
-  lang: string;
-  [key: string]: any;
-};
+import { LocalsProps } from './locals-props';
+import { HostToPathProps } from './host-to-path-props';
+
+// language code: https://www.andiamo.co.uk/resources/iso-language-codes/
+// English: en, Chinese (PRC): zh-cn, Chinese (Hong Kong): zh-hk, Chinese (Taiwan): zh-tw, Japanese: ja, Korean: ko
+export type AsyncStorageProps = {
+  uuid: string;
+  appName: string;
+  hostPath: HostToPathProps;
+  locals: LocalsProps;
+  lang: string;
+  [key: string]: any;
+};

package/src/models/db-config.ts

@@ -1,30 +1,30 @@
-export interface DbConfig {
-  type: string;
-  host: string;
-  port: number;
-  user: string;
-  password: string;
-  database: string;
-  poolMin: number;
-  poolMax: number;
-  connectionTimeout: number;
-  tablePrefix: string;
-  filename?: string;
-}
-
-export const getDefaultDbConfig = (): DbConfig => {
-  // process.env may not be initialized at script starting
-  return {
-    type: process.env['DB_TYPE'] || 'sqlite',
-    host: '',
-    port: 0,
-    user: '',
-    password: '',
-    database: '',
-    poolMin: 1,
-    poolMax: 5,
-    connectionTimeout: 10000,
-    tablePrefix: '',
-    filename: process.env['DB_FILENAME'] || 'sqlite3.db',
-  };
-};
+export interface DbConfig {
+  type: string;
+  host: string;
+  port: number;
+  user: string;
+  password: string;
+  database: string;
+  poolMin: number;
+  poolMax: number;
+  connectionTimeout: number;
+  tablePrefix: string;
+  filename?: string;
+}
+
+export const getDefaultDbConfig = (): DbConfig => {
+  // process.env may not be initialized at script starting
+  return {
+    type: process.env['DB_TYPE'] || 'sqlite',
+    host: '',
+    port: 0,
+    user: '',
+    password: '',
+    database: '',
+    poolMin: 1,
+    poolMax: 5,
+    connectionTimeout: 10000,
+    tablePrefix: '',
+    filename: process.env['DB_FILENAME'] || 'sqlite3.db',
+  };
+};

package/src/models/host-to-path-props.ts

@@ -1,12 +1,12 @@
-import { DbConfig } from './db-config';
-
-export type HostToPathProps = {
-  hosts: string[];
-  // path: string;
-  webPath: string;
-  dataPath: string;
-  apiPath: string;
-  appName: string;
-  dbType: string;
-  dbConfig: DbConfig;
-};
+import { DbConfig } from './db-config';
+
+export type HostToPathProps = {
+  hosts: string[];
+  // path: string;
+  webPath: string;
+  dataPath: string;
+  apiPath: string;
+  appName: string;
+  dbType: string;
+  dbConfig: DbConfig;
+};

package/src/models/index.ts

@@ -1,16 +1,16 @@
-export * from './api-base';
-export * from './api-module-props';
-export * from './api-router-props';
-export * from './app-cache-props';
-export * from './app-data-props';
-export * from './app-helper-props';
-export * from './app-shared-storage-props';
-export * from './app-start-props';
-export * from './async-storage-props';
-export * from './db-config';
-export * from './host-to-path-props';
-export * from './json-object';
-export * from './locals-props';
-export * from './logger-props';
-export * from './simple-storage-props';
-export * from './to-client-delivery-props';
+export * from './api-base';
+export * from './api-module-props';
+export * from './api-router-props';
+export * from './app-cache-props';
+export * from './app-data-props';
+export * from './app-helper-props';
+export * from './app-shared-storage-props';
+export * from './app-start-props';
+export * from './async-storage-props';
+export * from './db-config';
+export * from './host-to-path-props';
+export * from './json-object';
+export * from './locals-props';
+export * from './logger-props';
+export * from './simple-storage-props';
+export * from './to-client-delivery-props';

package/src/models/json-object.ts

@@ -1,8 +1,8 @@
-export type JsonKeyValue = {
-  [key: string]: string | number | boolean | null | undefined | string[] | number[] | JsonKeyValue | JsonKeyValue[];
-};
-export type JsonObject =
-  | JsonKeyValue[]
-  | {
-      [key: string]: string | number | boolean | null | undefined | string[] | number[] | JsonKeyValue | JsonKeyValue[];
-    };
+export type JsonKeyValue = {
+  [key: string]: string | number | boolean | null | undefined | string[] | number[] | JsonKeyValue | JsonKeyValue[];
+};
+export type JsonObject =
+  | JsonKeyValue[]
+  | {
+      [key: string]: string | number | boolean | null | undefined | string[] | number[] | JsonKeyValue | JsonKeyValue[];
+    };