Initial commit

.gitignore

@@ -0,0 +1 @@
+.DS_Store

LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

README.md

@@ -0,0 +1,3 @@
+# Kottster
+
+Simple low-code platform for building robust admin dashboards fast ⚡

common/.gitignore

@@ -0,0 +1,133 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+.pnpm-debug.log*
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+*.lcov
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# Snowpack dependency directory (https://snowpack.dev/)
+web_modules/
+
+# TypeScript cache
+*.tsbuildinfo
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional stylelint cache
+.stylelintcache
+
+# Microbundle cache
+.rpt2_cache/
+.rts2_cache_cjs/
+.rts2_cache_es/
+.rts2_cache_umd/
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variable files
+.env
+.env.development.local
+.env.test.local
+.env.production.local
+.env.local
+
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+.parcel-cache
+
+# Next.js build output
+.next
+out
+
+# Nuxt.js build / generate output
+.nuxt
+dist
+
+# Gatsby files
+.cache/
+# Comment in the public line in if your project uses Gatsby and not Next.js
+# https://nextjs.org/blog/next-9-1#public-directory-support
+# public
+
+# vuepress build output
+.vuepress/dist
+
+# vuepress v2.x temp and cache directory
+.temp
+.cache
+
+# Docusaurus cache and generated files
+.docusaurus
+
+# Serverless directories
+.serverless/
+
+# FuseBox cache
+.fusebox/
+
+# DynamoDB Local files
+.dynamodb/
+
+# TernJS port file
+.tern-port
+
+# Stores VSCode versions used for testing VSCode extensions
+.vscode-test
+
+# yarn v2
+.yarn/cache
+.yarn/unplugged
+.yarn/build-state.yml
+.yarn/install-state.gz
+.pnp.*
+
+# Others
+.DS_Store

common/.husky/pre-commit

@@ -0,0 +1 @@
+npm run lint

common/eslint.config.js

@@ -0,0 +1,9 @@
+// @ts-check
+
+const eslint = require('@eslint/js')
+const tseslint = require('typescript-eslint')
+
+module.exports = tseslint.config(
+  eslint.configs.recommended,
+  ...tseslint.configs.recommended,
+);

common/lib/constants/dataSourceTypes.ts

@@ -0,0 +1,34 @@
+import { DataSourceType, DataSourceTypeInfo } from "../models/dataSource.model";
+
+export const dataSourceTypes: DataSourceTypeInfo[] = [
+  {
+    type: DataSourceType.postgres,
+    name: 'PostgreSQL',
+    icon: '/icons/postgresql.svg',
+  },
+  {
+    type: DataSourceType.mysql,
+    name: 'MySQL',
+    icon: '/icons/mysql.svg',
+  },
+  {
+    type: DataSourceType.mariadb,
+    name: 'MariaDB',
+    icon: '/icons/mariadb.svg',
+  },
+  {
+    type: DataSourceType.mssql,
+    name: 'Microsoft SQL',
+    icon: '/icons/mssql.svg',
+  },
+  {
+    type: DataSourceType.oracle,
+    name: 'Oracle',
+    icon: '/icons/oracle.svg',
+  },
+  {
+    type: DataSourceType.sqlite,
+    name: 'SQLite',
+    icon: '/icons/sqlite.svg',
+  },
+];

common/lib/index.ts

@@ -0,0 +1,16 @@
+#!/usr/bin/env node
+
+// Models
+export * from './models/appSchema.model';
+export * from './models/component.model';
+export * from './models/page.module';
+export * from './models/procedure.model';
+export * from './models/stage.model';
+export * from './models/config.model';
+export * from './models/dataSource.model';
+
+// Utils
+export * from './utils/getEnvOrThrow';
+
+// Constants
+export * from './constants/dataSourceTypes';

common/lib/models/appSchema.model.ts

@@ -0,0 +1,16 @@
+import { PublicDataSource } from "./dataSource.model";
+import { Page } from "./page.module";
+import { Procedure } from "./procedure.model";
+
+// Contains basic page information
+export interface AppSchema {
+  version: number;
+  pages: Page[];
+}
+
+// Contains full page information and full procedures
+export interface FullAppSchema extends AppSchema {
+  id: string;
+  dataSources: PublicDataSource[];
+  procedures: Procedure[];
+}

common/lib/models/component.model.ts

@@ -0,0 +1,7 @@
+export interface Component {
+  id: string;
+}
+
+export interface FullComponent extends Component {
+  code: string;
+}

common/lib/models/config.model.ts

@@ -0,0 +1,5 @@
+import { BuildOptions } from 'esbuild/lib/main'
+
+export interface Config {
+  esbuildOptions: BuildOptions;
+}

common/lib/models/dataSource.model.ts

@@ -0,0 +1,31 @@
+export enum DataSourceType {
+  postgres = 'postgres',
+  mysql = 'mysql',
+  mariadb = 'mariadb',
+  mssql = 'mssql',
+  oracle = 'oracle',
+  sqlite = 'sqlite',
+}
+
+export enum DataSourceClientType {
+  knex_pg = 'knex_pg', // PostgreSQL
+  knex_mysql2 = 'knex_mysql2', // MySQL, MariaDB
+  knex_tedious = 'knex_tedious', // MSSQL
+}
+
+export interface DataSourceTypeInfo {
+  type: DataSourceType;
+  name: string;
+  icon: string;
+}
+
+export interface DataSource {
+  type: DataSourceType;
+  contextPropName: string;
+
+  clientType: DataSourceClientType;
+  client: unknown;
+}
+
+// Available in the public API
+export interface PublicDataSource extends Omit<DataSource, 'client' | 'clientType'> {}

common/lib/models/page.module.ts

@@ -0,0 +1,29 @@
+interface File {
+  fileContent: string;
+  filePath: string;
+  fileName: string; 
+  
+  // Only when return from server
+  absoluteFilePath?: string;
+  
+  // Whether this file is the entry file of the page (e.g. index.jsx)
+  isEntryFile?: boolean;
+}
+
+interface Directory {
+  dirPath: string;
+  dirName: string;
+  files: File[];
+  dirs: Directory[];
+}
+
+export interface PageStructure {
+  pageId: string;
+  rootDir: Directory;
+}
+
+export interface Page {
+  id: string;
+  name: string;
+  icon: string;
+}

common/lib/models/procedure.model.ts

@@ -0,0 +1,16 @@
+export interface ProcedureStructure {
+  procedureName: string;
+  file: {
+    fileContent: string;
+    fileName: string; 
+    filePath: string;
+  };
+}
+
+export interface Procedure {
+  procedureName: string;
+}
+
+export interface RegisteredProcedure extends Procedure {
+  function: unknown;
+}

common/lib/models/stage.model.ts

@@ -0,0 +1,4 @@
+export enum Stage {
+  development = 'development',
+  production = 'production',
+}

common/lib/utils/getEnvOrThrow.ts

@@ -0,0 +1,15 @@
+/**
+ * Get an environment variable or throw an error if it is not set.
+ * @param key The key of the environment variable
+ * @returns The value of the environment variable
+ * @throws Error if the environment variable is not set
+ */
+export function getEnvOrThrow(key: string): string {
+  const value = process.env[key];
+
+  if (!value) {
+    throw new Error(`Environment variable ${key} is not set. Please set it in a .env file or pass it as a command line argument.`);
+  }
+
+  return value;
+}

common/package.json

@@ -0,0 +1,25 @@
+{
+  "name": "@kottster/common",
+  "version": "1.0.0",
+  "main": "dist/index.js",
+  "license": "Apache-2.0",
+  "scripts": {
+    "clean": "rimraf ./dist",
+    "build": "npm run clean && tsc",
+    "lint": "npx eslint ./lib",
+    "prepare": "husky"
+  },
+  "dependencies": {
+    "esbuild": "^0.23.0"
+  },
+  "devDependencies": {
+    "@eslint/js": "^9.7.0",
+    "@types/eslint__js": "^8.42.3",
+    "@types/node": "^20.14.11",
+    "eslint": "^9.7.0",
+    "husky": "^9.1.1",
+    "rimraf": "^5.0.5",
+    "typescript": "^5.5.3",
+    "typescript-eslint": "^7.16.1"
+  }
+}

common/tsconfig.json

@@ -0,0 +1,27 @@
+{
+  "compilerOptions": {
+    "module": "commonjs",
+    "moduleResolution": "node",
+    "declaration": true,
+    "removeComments": true,
+    "emitDecoratorMetadata": true,
+    "experimentalDecorators": true,
+    "allowSyntheticDefaultImports": true,
+    "target": "ESNext",
+    "sourceMap": true,
+    "outDir": "./dist",
+    "lib": [
+      "ES5", "ES2015", "ES2020"
+    ],
+    "esModuleInterop": true,
+    "baseUrl": "./",
+    "incremental": true,
+    "skipLibCheck": true,
+    "strictNullChecks": true,
+    "noImplicitAny": true,
+    "strictBindCallApply": false,
+    "forceConsistentCasingInFileNames": false,
+    "noFallthroughCasesInSwitch": false
+  },
+  "include": ["./lib/**/*"]
+}