From bbe78747f30f103a0bae255b6835c39ae3adf651 Mon Sep 17 00:00:00 2001 From: Mason Payne Date: Thu, 11 Jun 2020 01:14:23 -0600 Subject: [PATCH] initial commit --- dist/example-def.d.ts | 3 ++ dist/example-def.js | 88 ++++++++++++++++++++++++++++++++ dist/processDef.d.ts | 31 ++++++++++++ dist/processDef.js | 60 ++++++++++++++++++++++ src/example-def.ts | 89 +++++++++++++++++++++++++++++++++ src/processDef.ts | 114 ++++++++++++++++++++++++++++++++++++++++++ tsconfig.json | 64 ++++++++++++++++++++++++ 7 files changed, 449 insertions(+) create mode 100644 dist/example-def.d.ts create mode 100644 dist/example-def.js create mode 100644 dist/processDef.d.ts create mode 100644 dist/processDef.js create mode 100644 src/example-def.ts create mode 100644 src/processDef.ts create mode 100644 tsconfig.json diff --git a/dist/example-def.d.ts b/dist/example-def.d.ts new file mode 100644 index 0000000..99665a5 --- /dev/null +++ b/dist/example-def.d.ts @@ -0,0 +1,3 @@ +import { SystemDef } from './processDef'; +declare let def: SystemDef; +export default def; diff --git a/dist/example-def.js b/dist/example-def.js new file mode 100644 index 0000000..a482f9e --- /dev/null +++ b/dist/example-def.js @@ -0,0 +1,88 @@ +"use strict"; +Object.defineProperty(exports, "__esModule", { value: true }); +var def = { + storage: { + tables: [ + { + name: "tasks", + relations: [ + { + type: 'belongs-to', + table: 'lists', + } + ], + columns: [ + { + name: "name", + type: "string", + nullable: false, + }, + { + name: "description", + type: "string", + nullable: true, + }, + { + name: "completed", + type: "boolean", + nullable: false, + }, + { + name: "completed_date", + type: "date", + nullable: true, + }, + { + name: "metadata", + type: "blob", + nullable: true, + } + ] + }, + { + name: "lists", + relations: [], + columns: [ + { + name: "name", + type: "string", + unique: false, + nullable: false, + }, + ] + }, + { + name: "users", + relations: [], + columns: [ + { + name: "name", + type: "string", + nullable: false, + }, + { + name: "password", + type: "string", + nullable: false, + } + ] + } + ], + relations: [ + { + left: 'lists', + relation: 'many-to-many', + right: 'users', + columns: [ + { + name: 'access', + type: 'string', + unique: false, + nullable: false, + } + ] + } + ] + } +}; +exports.default = def; diff --git a/dist/processDef.d.ts b/dist/processDef.d.ts new file mode 100644 index 0000000..b8927e3 --- /dev/null +++ b/dist/processDef.d.ts @@ -0,0 +1,31 @@ +interface SystemDef { + storage: StorageDef; +} +interface StorageDef { + tables: TableDef[]; + relations: ManyToManyDef[]; +} +interface TableDef { + name: string; + columns: ColumnDef[]; + relations: BelongsToDef[]; +} +interface ColumnDef { + name: string; + type: "blob" | "boolean" | "date" | "dateTIME" | "number" | "string"; + nullable: boolean; + unique?: boolean; + autoIncrement?: boolean; + default?: string; +} +interface BelongsToDef { + type: 'belongs-to'; + table: string; +} +interface ManyToManyDef { + left: string; + relation: 'many-to-many'; + right: string; + columns?: ColumnDef[]; +} +export { SystemDef }; diff --git a/dist/processDef.js b/dist/processDef.js new file mode 100644 index 0000000..b110aa0 --- /dev/null +++ b/dist/processDef.js @@ -0,0 +1,60 @@ +"use strict"; +var __importDefault = (this && this.__importDefault) || function (mod) { + return (mod && mod.__esModule) ? mod : { "default": mod }; +}; +Object.defineProperty(exports, "__esModule", { value: true }); +var example_def_1 = __importDefault(require("./example-def")); +function createDatabase(storageDef) { + var tableCreationQueries = []; + for (var i in storageDef.tables) { + tableCreationQueries.push(getTableCreationString(storageDef.tables[i])); + } + for (var i in storageDef.relations) { + tableCreationQueries.push(getTableRelationsCreationString(storageDef.relations[i])); + } + tableCreationQueries.map(function (query) { + console.log(query); + }); +} +function getTableCreationString(tableDef) { + var primaryKeyString = tableDef.name + "_id VARCHAR(36) PRIMARY KEY"; + var columnString = "" + primaryKeyString; + var defaultColumns = "created DATETIME NOT NULL DEFAULT NOW(), modified DATETIME NOT NULL DEFAULT NOW()"; + var indexString = ""; + // columns + for (var i in tableDef.columns) { + var column = tableDef.columns[i]; + columnString = columnString + ", " + createColumnString(column); + } + // relations + for (var i in tableDef.relations) { + var relation = tableDef.relations[i]; + columnString = columnString + ", " + relation.table + "_id VARCHAR(36)"; + } + // default created & modified + columnString = columnString + ", " + defaultColumns; + return "CREATE TABLE IF NOT EXISTS " + tableDef.name + " (" + columnString + (indexString !== '' ? ', ' + indexString : '') + ");"; +} +function createColumnString(column) { + var typeMap = { + "blob": "BLOB", + "boolean": "BOOLEAN", + "date": "DATE", + "dateTIME": "DATETIME", + "number": "INT", + "string": "VARCHAR(255)", + }; + return column.name + " " + typeMap[column.type] + (column.nullable ? '' : ' NOT NULL') + (column.default ? ' DEFAULT ' + column.default : '') + (column.autoIncrement ? ' AUTO_INCREMENT' : '') + (column.unique ? ' UNIQUE' : ''); +} +function getTableRelationsCreationString(relationsDef) { + var columnString = relationsDef.left + "_id VARCHAR(36) NOT NULL, " + relationsDef.right + "_id VARCHAR(36) NOT NULL"; + var indexString = "INDEX " + relationsDef.left + "_id_index (" + relationsDef.left + "_id), INDEX " + relationsDef.right + "_id_index (" + relationsDef.right + "_id)"; + if (relationsDef.columns && relationsDef.columns.length) { + for (var i in relationsDef.columns) { + var column = relationsDef.columns[i]; + columnString = columnString + ", " + createColumnString(column); + } + } + return "CREATE TABLE IF NOT EXISTS " + relationsDef.left + "_" + relationsDef.right + " (" + columnString + (indexString !== '' ? ', ' + indexString : '') + ");"; +} +createDatabase(example_def_1.default.storage); diff --git a/src/example-def.ts b/src/example-def.ts new file mode 100644 index 0000000..7e0b01f --- /dev/null +++ b/src/example-def.ts @@ -0,0 +1,89 @@ +import { SystemDef } from './processDef'; + +let def: SystemDef = { + storage: { + tables: [ + { + name: "tasks", + relations: [ + { + type: 'belongs-to', + table: 'lists', + } + ], + columns: [ + { + name: "name", + type: "string", + nullable: false, + }, + { + name: "description", + type: "string", + nullable: true, + }, + { + name: "completed", + type: "boolean", + nullable: false, + }, + { + name: "completed_date", + type: "date", + nullable: true, + }, + { + name: "metadata", + type: "blob", + nullable: true, + } + ] + }, + { + name: "lists", + relations: [], + columns: [ + { + name: "name", + type: "string", + unique: false, + nullable: false, + }, + ] + }, + { + name: "users", + relations: [], + columns: [ + { + name: "name", + type: "string", + nullable: false, + }, + { + name: "password", + type: "string", + nullable: false, + } + ] + } + ], + relations: [ + { + left: 'lists', + relation: 'many-to-many', + right: 'users', + columns: [ + { + name: 'access', + type: 'string', + unique: false, + nullable: false, + } + ] + } + ] + } +} + +export default def; diff --git a/src/processDef.ts b/src/processDef.ts new file mode 100644 index 0000000..e8b04fa --- /dev/null +++ b/src/processDef.ts @@ -0,0 +1,114 @@ + +import defs from './example-def'; + +function createDatabase(storageDef: StorageDef) { + let tableCreationQueries: string[] = []; + for (let i in storageDef.tables) { + tableCreationQueries.push(getTableCreationString(storageDef.tables[i])); + } + for (let i in storageDef.relations) { + tableCreationQueries.push(getTableRelationsCreationString(storageDef.relations[i])); + } + tableCreationQueries.map((query: string) => { + console.log(query); + }); +} + +function getTableCreationString(tableDef: TableDef): string { + let primaryKeyString: string = `${tableDef.name}_id VARCHAR(36) PRIMARY KEY`; + let columnString: string = `${primaryKeyString}`; + let defaultColumns: string = `created DATETIME NOT NULL DEFAULT NOW(), modified DATETIME NOT NULL DEFAULT NOW()` + let indexString: string = ``; + + // columns + for (let i in tableDef.columns) { + let column: ColumnDef = tableDef.columns[i]; + columnString = `${columnString}, ${createColumnString(column)}`; + } + + // relations + for (let i in tableDef.relations) { + let relation: BelongsToDef = tableDef.relations[i]; + columnString = `${columnString}, ${relation.table}_id VARCHAR(36)`; + } + + // default created & modified + columnString = `${columnString}, ${defaultColumns}`; + + return `CREATE TABLE IF NOT EXISTS ${tableDef.name} (${columnString}${indexString !== '' ? ', ' + indexString : ''});`; +} + +function createColumnString(column: ColumnDef) { + const typeMap: {[type: string]: string} = { + "blob": "BLOB", + "boolean": "BOOLEAN", + "date": "DATE", + "dateTIME": "DATETIME", + "number": "INT", + "string": "VARCHAR(255)", + }; + + return `${column.name} ${typeMap[column.type]}${column.nullable ? '' : ' NOT NULL'}${column.default ? ' DEFAULT ' + column.default : ''}${column.autoIncrement ? ' AUTO_INCREMENT' : ''}${column.unique ? ' UNIQUE' : ''}`; +} + +function getTableRelationsCreationString(relationsDef: ManyToManyDef): string { + let columnString: string = `${relationsDef.left}_id VARCHAR(36) NOT NULL, ${relationsDef.right}_id VARCHAR(36) NOT NULL`; + let indexString: string = `INDEX ${relationsDef.left}_id_index (${relationsDef.left}_id), INDEX ${relationsDef.right}_id_index (${relationsDef.right}_id)`; + + if (relationsDef.columns && relationsDef.columns.length) { + for (let i in relationsDef.columns) { + let column: ColumnDef = relationsDef.columns[i]; + columnString = `${columnString}, ${createColumnString(column)}`; + } + } + + return `CREATE TABLE IF NOT EXISTS ${relationsDef.left}_${relationsDef.right} (${columnString}${indexString !== '' ? ', ' + indexString : ''});`; +} + + +createDatabase(defs.storage); + + + + + +interface SystemDef { + storage: StorageDef; + // TODO: add Views, ACLs, Behaviors, UX +} + +interface StorageDef { + tables: TableDef[]; + relations: ManyToManyDef[]; +} + +interface TableDef { + name: string; + columns: ColumnDef[], + relations: BelongsToDef[], +} + +interface ColumnDef { + name: string; + type: "blob" | "boolean" | "date" | "dateTIME" | "number" | "string"; + nullable: boolean; + unique?: boolean; + autoIncrement?: boolean; + default?: string; +} + +interface BelongsToDef { + type: 'belongs-to'; + table: string; +} + +interface ManyToManyDef { + left: string; + relation: 'many-to-many'; + right: string; + columns?: ColumnDef[]; +} + +export { + SystemDef +} diff --git a/tsconfig.json b/tsconfig.json new file mode 100644 index 0000000..4e4408d --- /dev/null +++ b/tsconfig.json @@ -0,0 +1,64 @@ +{ + "compilerOptions": { + /* Basic Options */ + "target": "es5", /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019' or 'ESNEXT'. */ + "module": "commonjs", /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', or 'ESNext'. */ + // "lib": [], /* Specify library files to be included in the compilation. */ + // "allowJs": true, /* Allow javascript files to be compiled. */ + // "checkJs": true, /* Report errors in .js files. */ + // "jsx": "preserve", /* Specify JSX code generation: 'preserve', 'react-native', or 'react'. */ + "declaration": true, /* Generates corresponding '.d.ts' file. */ + // "declarationMap": true, /* Generates a sourcemap for each corresponding '.d.ts' file. */ + // "sourceMap": true, /* Generates corresponding '.map' file. */ + // "outFile": "./", /* Concatenate and emit output to single file. */ + "outDir": "./dist", /* Redirect output structure to the directory. */ + // "rootDir": "./", /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */ + // "composite": true, /* Enable project compilation */ + // "incremental": true, /* Enable incremental compilation */ + // "tsBuildInfoFile": "./", /* Specify file to store incremental compilation information */ + // "removeComments": true, /* Do not emit comments to output. */ + // "noEmit": true, /* Do not emit outputs. */ + // "importHelpers": true, /* Import emit helpers from 'tslib'. */ + // "downlevelIteration": true, /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */ + // "isolatedModules": true, /* Transpile each file as a separate module (similar to 'ts.transpileModule'). */ + + /* Strict Type-Checking Options */ + "strict": true, /* Enable all strict type-checking options. */ + // "noImplicitAny": true, /* Raise error on expressions and declarations with an implied 'any' type. */ + // "strictNullChecks": true, /* Enable strict null checks. */ + // "strictFunctionTypes": true, /* Enable strict checking of function types. */ + // "strictBindCallApply": true, /* Enable strict 'bind', 'call', and 'apply' methods on functions. */ + // "strictPropertyInitialization": true, /* Enable strict checking of property initialization in classes. */ + // "noImplicitThis": true, /* Raise error on 'this' expressions with an implied 'any' type. */ + // "alwaysStrict": true, /* Parse in strict mode and emit "use strict" for each source file. */ + + /* Additional Checks */ + // "noUnusedLocals": true, /* Report errors on unused locals. */ + // "noUnusedParameters": true, /* Report errors on unused parameters. */ + // "noImplicitReturns": true, /* Report error when not all code paths in function return a value. */ + // "noFallthroughCasesInSwitch": true, /* Report errors for fallthrough cases in switch statement. */ + + /* Module Resolution Options */ + // "moduleResolution": "node", /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */ + // "baseUrl": "./", /* Base directory to resolve non-absolute module names. */ + // "paths": {}, /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */ + // "rootDirs": [], /* List of root folders whose combined content represents the structure of the project at runtime. */ + // "typeRoots": [], /* List of folders to include type definitions from. */ + // "types": [], /* Type declaration files to be included in compilation. */ + // "allowSyntheticDefaultImports": true, /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */ + "esModuleInterop": true /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */ + // "preserveSymlinks": true, /* Do not resolve the real path of symlinks. */ + + /* Source Map Options */ + // "sourceRoot": "", /* Specify the location where debugger should locate TypeScript files instead of source locations. */ + // "mapRoot": "", /* Specify the location where debugger should locate map files instead of generated locations. */ + // "inlineSourceMap": true, /* Emit a single file with source maps instead of having a separate file. */ + // "inlineSources": true, /* Emit the source alongside the sourcemaps within a single file; requires '--inlineSourceMap' or '--sourceMap' to be set. */ + + /* Experimental Options */ + // "experimentalDecorators": true, /* Enables experimental support for ES7 decorators. */ + // "emitDecoratorMetadata": true, /* Enables experimental support for emitting type metadata for decorators. */ + }, + "include": ["src"], + "exclude": ["node_modules", "**/__tests__/*"] +}