@graf-research/adf-codegen-model-typeorm 0.0.13 → 0.0.15

package/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2024 ADF Language. https://adf-lang.com
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

package/README.md

@@ -0,0 +1,110 @@
+# TypeORM - ADF Code Generator
+
+Generator kode [ADF](https://github.com/Graf-Research/adf-core) untuk model [TypeORM](https://github.com/typeorm/typeorm) dalam format Typescript.
+
+**Modul ADF yang digunakan**
+
+`Table` `Enum`
+
+**Penggunaan CLI (Command Line)**
+
+```bash
+npx @graf-research/adf-codegen-model-typeorm <file/url ADF> <folder output>
+```
+
+## Instalasi
+
+```bash
+npm install --save @graf-research/adf-codegen-model-typeorm
+```
+
+## Fungsi
+
+```typescript
+import { Model } from "@graf-research/adf-core";
+
+type MapModelNameFilePath = {[key: string]: string};
+
+interface CodegenFileOutput {
+  filename: string
+  content: string
+}
+
+interface ItemOutput {
+  files: CodegenFileOutput[]
+  map: MapModelNameFilePath
+}
+
+interface Output {
+  table: ItemOutput
+  enum: ItemOutput
+}
+
+function TypeORMModel.compile(list_model: Model.Item[]): Output
+```
+
+## Paduan TypeORM
+
+Untuk menggunakan fitur auto generated-migration TypeORM konfigurasi antara data source harus sesuai. Pada generator ini kode yang di-generate akan muncul pada dua folder besar yaitu:
+- &lt;folder output&gt;/model/table/*.ts
+- &lt;folder output&gt;/model/enum/*.ts
+
+Berikut salah satu contoh kofigurasi Data Source dan Script `package.json`
+
+#### data-source.ts
+```typescript
+import { DataSource, DataSourceOptions } from "typeorm";
+ 
+const config: DataSourceOptions = {
+  type: "postgres",
+  host: 'localhost',
+  port: 5432,
+  username: '<username>',
+  password: '<password>',
+  database: '<database name>',
+  synchronize: false,
+  logging: false,
+  migrations: [
+    __dirname + '/migration/**.ts'
+  ],
+  entities: [
+    __dirname + '/<folder output>/model/**/*.{ts,js}'
+  ]
+};
+
+export const AppDataSource = new DataSource(config);
+```
+
+#### package.json
+```json
+{
+  ...
+  "scripts": {
+    ...
+    "typeorm": "typeorm-ts-node-commonjs",
+    "generate-migration": "npm run typeorm migration:generate -- $1 -d ./data-source.ts",
+    "migrate": "npm run typeorm migration:run -- -d ./data-source.ts"
+  },
+  ...
+}
+```
+
+##### Generate Migration
+
+Untuk men-generate file migration TypeORM gunakan script `generate-migration` dengan output folder `migration` seperti konfigurasi pada `data-source.ts`, misalnya sebuah file migration dengan nama `Init.ts`:
+
+```bash
+npm run generate-migration migration/Init
+```
+
+akan menghasilkan file migration `migration/Init.ts`
+
+##### Menjalankan Migration
+
+Untuk menjalankan file migration TypeORM gunakan script `migrate`, contoh:
+
+```bash
+npm run migrate
+```
+
+akan mengeksekusi sql script dari file-file migration.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@graf-research/adf-codegen-model-typeorm",
-  "version": "0.0.13",
+  "version": "0.0.15",
   "main": "dist/index.js",
   "scripts": {
     "build": "rm -rf dist && tsc",
@@ -26,7 +26,7 @@
     "typescript": "^5.6.3"
   },
   "dependencies": {
-    "@graf-research/adf-core": "^0.0.15",
+    "@graf-research/adf-core": "^0.0.16",
     "axios": "^1.7.7",
     "lodash": "^4.17.21"
   }