clark-orm - npm Package Compare versions

Comparing version 3.5.0 to 3.5.1

dist/app.d.ts

@@ -0,1 +1,2 @@
+import { Emitter } from '@adonisjs/events/build/src/Emitter/index.js';
 import { Database } from '@adonisjs/lucid/build/src/Database/index.js';
@@ -12,4 +13,5 @@ export { ModelPaginator } from '@adonisjs/lucid/build/src/Orm/Paginator/index.js';
     BaseModel: LucidModel;
+    Event: Emitter;
 };
 
 export { defineConfig };

dist/app.js

@@ -61,3 +61,4 @@ "use strict";
     Database: database,
-    BaseModel: import_BaseModel.BaseModel
+    BaseModel: import_BaseModel.BaseModel,
+    Event: emitter
   };
@@ -64,0 +65,0 @@ }

package.json

 {
   "name": "clark-orm",
-  "version": "3.5.0",
+  "version": "3.5.1",
   "private": false,
@@ -12,2 +12,7 @@ "description": "ClarkORM",
   ],
+  "scripts": {
+    "dev": "tsc --watch",
+    "build": "rimraf ./dist && tsup src/app.ts --format esm,cjs --dts",
+    "prepublishOnly": "npm run build"
+  },
   "keywords": [
@@ -33,8 +38,4 @@ "lucid",
   "devDependencies": {
-    "@swc/core": "^1.3.92",
-    "@types/gulp": "4.0.14",
-    "@types/gulp-replace": "1.1.0",
     "@typescript-eslint/eslint-plugin": "6.7.4",
     "@typescript-eslint/parser": "6.7.4",
-    "adonis-preset-ts": "^2.1.0",
     "eslint": "8.50.0",
@@ -45,10 +46,4 @@ "eslint-config-prettier": "9.0.0",
     "eslint-plugin-standard": "5.0.0",
-    "gulp": "4.0.2",
-    "gulp-cli": "2.3.0",
-    "gulp-replace": "1.1.4",
-    "gulp-shell": "0.8.0",
-    "knex": "^2.5.1",
     "prettier": "3.0.3",
     "rimraf": "5.0.5",
-    "ts-node": "10.9.1",
     "tsup": "^7.2.0",
@@ -65,7 +60,3 @@ "typescript": "5.2.2"
     "reflect-metadata": "0.1.13"
-  },
-  "scripts": {
-    "dev": "tsc --watch",
-    "build": "rimraf ./dist && tsup src/app.ts --format esm,cjs --dts"
   }
-}
+}

readme.md

@@ -26,5 +26,25 @@ [![npm version](https://img.shields.io/npm/v/clark-orm.svg?style=flat)](https://www.npmjs.com/package/clark-orm)
 
+Here you can configure your connection like [Adonis Lucid](https://docs.adonisjs.com/guides/database/introduction#drivers-config)
 ```ts
+import { defineConfig } from "clark-orm";
+
+export const { BaseModel, Event, Database } = defineConfig({
+  connection: "sqlite",
+  connections: {
+    sqlite: {
+      client: "sqlite",
+      healthCheck: false,
+      debug: false,
+      useNullAsDefault: true,
+      connection: {
+        filename: "./db.sqlite",
+      },
+    },
+  },
+})
+```
+
+```ts
 import { DateTime } from "luxon";
-import { BaseModel, column } from "clark-orm/Orm";
+import { BaseModel, column } from "clark-orm";
 
@@ -48,32 +68,4 @@ export class CityModel extends BaseModel {
 
-Lucid has a lot of options, but what do you can do using ClarkORM? We offer some things that you can use like you would use with Lucid:
-```js
-clark-orm/Orm
-clark-orm/Database
-clark-orm/Factory
-clark-orm/Event
-```
-
 You can learn more about the models [here](https://preview.adonisjs.com/guides/models/introduction).
 
-*We use the knexfile.ts in the root of your project because Lucid ORM is built on top of knex*
-```ts
-import { defineConfig } from 'clark-orm';
-
-export default defineConfig({
-  connection: 'sqlite',
-  connections: {
-    sqlite: {
-      client: 'sqlite',
-      connection: {
-        filename: './db.sqlite',
-      },
-      useNullAsDefault: true,
-      healthCheck: false,
-      debug: false,
-    },
-  },
-});
-```
-
 ## Extra
@@ -80,0 +72,0 @@

Fixed alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Improved metrics

Dev dependency count

11

decreased by-47.62%

Lines of code

127

increased by3.25%

Number of medium supply chain risk alerts

0

decreased by-100%

Worsened metrics

Total package byte prevSize

9390

decreased by-1.75%

Number of lines in readme file

74

decreased by-9.76%

No dependency changes