@ttoss/postgresdb 0.2.1 → 0.2.3

package/README.md

@@ -9,6 +9,16 @@ pnpm add @ttoss/postgresdb
 pnpm add -D @ttoss/postgresdb-cli
 ```
 
+### ESM only
+
+This package is [ESM only](https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c). Make sure to use it in an ESM environment.
+
+```json
+{
+  "type": "module"
+}
+```
+
 ## Usage
 
 ### Setup the database
@@ -107,6 +117,73 @@ const user = await db.User.create({
 
 All models are available in the `db` object.
 
+### Using in a monorepo
+
+If you want to use in a monorepo by sharing the models between packages, you need to create some configurations to make it work.
+
+#### On the `postgresdb` package
+
+1. Create your `postgresdb` package following the steps above.
+
+1. Exports your main file in the `package.json` file:
+
+   ```json
+   {
+     "type": "module",
+     "exports": "./src/index.ts"
+   }
+   ```
+
+1. Create a new file called `src/index.ts` with the following content to exports the `models` you've created:
+
+   ```typescript
+   export * as models from './models';
+   ```
+
+   _We recommend to not export the `db` object in this file because you may want to use different configurations in different packages._
+
+#### On the other packages
+
+1. Install `@ttoss/postgresdb` package:
+
+   ```bash
+   pnpm add @ttoss/postgresdb
+   ```
+
+1. Add your `postgresdb` package as a dependency. In the case you're using PNPM, you can use the [workspace protocol](https://pnpm.io/workspaces#workspace-protocol-workspace):
+
+   ```json
+   {
+     "dependencies": {
+       "@yourproject/postgresdb": "workspace:^"
+     }
+   }
+   ```
+
+1. Include the `postgresdb` package in the `include` field of the `tsconfig.json` file:
+
+   ```json
+   {
+     "include": ["src", "../postgresdb/src"]
+   }
+   ```
+
+   _This way, you can import the models using the `@yourproject/postgresdb` package._
+
+1. Create a new file called `src/db.ts` with the following content:
+
+   ```typescript
+   import { initialize } from '@ttoss/postgresdb';
+   import { models } from '@yourproject/postgresdb';
+
+   export const db = initialize({
+     models,
+     // other configurations
+   });
+   ```
+
+1. Use the `db` object to interact with the database.
+
 ## API
 
 ### `initialize(options: InitializeOptions): db`
@@ -122,3 +199,30 @@ All [Sequelize options](https://sequelize.org/api/v6/class/src/sequelize.js~sequ
 ### Sequelize decorators
 
 This package exports all decorators from [sequelize-typescript](https://www.npmjs.com/package/sequelize-typescript), i.e., `@Table`, `@Column`, `@ForeignKey`, etc.
+
+## Types
+
+### `ModelColumns<T>`
+
+A type that represents the columns of a model.
+
+```typescript
+import { Column, Model, type ModelColumns, Table } from '@ttoss/postgresdb';
+
+@Table
+class User extends Model<User> {
+  @Column
+  declare name?: string;
+
+  @Column
+  declare email: string;
+}
+
+/**
+ * UserColumns = {
+ *  name?: string;
+ *  email: string;
+ * }
+ */
+type UserColumns = ModelColumns<User>;
+```

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { ModelCtor, Sequelize, SequelizeOptions } from 'sequelize-typescript';
+import { ModelCtor, Sequelize, SequelizeOptions, Model } from 'sequelize-typescript';
 export * from 'sequelize-typescript';
 
 type Options<Models> = Omit<SequelizeOptions, 'models' | 'dialect'> & {
@@ -10,4 +10,6 @@ declare const initialize: <Models extends {
     sequelize: Sequelize;
 } & Models>;
 
-export { initialize };
+type ModelColumns<T> = Omit<T, keyof Model> & Pick<Model, 'id' | 'createdAt' | 'updatedAt'>;
+
+export { type ModelColumns, initialize };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ttoss/postgresdb",
-  "version": "0.2.1",
+  "version": "0.2.3",
   "description": "A library to handle PostgreSQL database connections and queries",
   "license": "MIT",
   "author": "ttoss",