@a_team/prisma 3.0.22-win → 3.1.0-macos

package/README.md

@@ -1,58 +1,108 @@
-# @a_team/prisma
+# A.Team prisma library
 
-This package contains a shared Prisma schema, organized into [multiple files](https://www.prisma.io/blog/organize-your-prisma-schema-with-multi-file-support), to be used across multiple projects. By centralizing the schema definitions, we ensure consistency and reduce duplication of effort:
+- This package contains a shared Prisma schema, organized into [multiple files](https://www.prisma.io/blog/organize-your-prisma-schema-with-multi-file-support), to be used across multiple projects. 
+- By centralizing the schema definitions, we ensure consistency and reduce duplication of effort:
+    - **Consistency**: We are targeting the same MongoDB database. If we use different schema definition files, there's a risk of having inconsistent model definitions, which could lead to conflicts and data overrides.
+    - **Efficiency**: A single schema definition can reduce redundant work. Currently, the schema file has over 300 lines, and this could easily grow to 1000+ lines as we onboard more collections. By working collaboratively on a single schema definition, we can streamline our efforts and improve the overall quality.
 
-1. **Consistency**: We are targeting the same MongoDB database. If we use different schema definition files, there's a risk of having inconsistent model definitions, which could lead to conflicts and data overrides.
-1. **Efficiency**: A single schema definition can reduce redundant work. Currently, the schema file has over 300 lines, and this could easily grow to 1000+ lines as we onboard more collections. By working collaboratively on a single schema definition, we can streamline our efforts and improve the overall quality.
+### Installation
 
-## Installation
+- To install this package, add the following optional dependencies (where `X.Y.Z` represents the version):
 
-To install this package, use the following command:
-
-```sh
-yarn add @a_team/prisma
+```json
+"optionalDependencies": {
+    "@a_team/prisma-win": "npm:@a_team/prisma@X.Y.Z-win",
+    "@a_team/prisma-macos": "npm:@a_team/prisma@X.Y.Z-macos",
+    "@a_team/prisma-linux": "npm:@a_team/prisma@X.Y.Z-linux"
+}
 ```
 
-## Usage
+- Add the following script as `postinstall` & change per need in your service:
+
+```javascript
+const fs = require('fs');
+const path = require('path');
+
+const getPlatformPackage = () => {
+  switch (process.platform) {
+    case 'darwin':
+      return '@a_team/prisma-macos';
+    case 'win32':
+      return '@a_team/prisma-win';
+    default:
+      return '@a_team/prisma-linux';
+  }
+};
+
+const platformPackage = getPlatformPackage();
+const nodeModulesPath = path.join(__dirname, '..', 'node_modules');
+const sourcePath = path.join(nodeModulesPath, platformPackage);
+const targetPath = path.join(nodeModulesPath, '@a_team/prisma');
+
+if (fs.existsSync(sourcePath)) {
+  if (fs.existsSync(targetPath)) {
+    fs.rmSync(targetPath, { recursive: true, force: true });
+  }
+
+  fs.renameSync(sourcePath, targetPath);
+  console.log(`Renamed ${platformPackage} to @a_team/prisma`);
+} else {
+  console.error(`Platform-specific package ${platformPackage} not found`);
+  process.exit(1);
+}
 
-To use the shared Prisma client:
+```
 
-```typescript
-import { PrismaClient } from "@prisma/client";
+- The script above will link the required OS dependency as the main one.
 
-const prisma = new PrismaClient();
-```
+### Usage
 
-## Playground
+- To use the library:
 
-The playground is a dedicated space where you can test and experiment with the Prisma client and schema. It contains various scripts that demonstrate how to interact with your database models.
+```typescript
+import { ATeamPrismaClient } from '@a_team/prisma';
 
-Before running any playground scripts, make sure to set up your environment variables. First, copy the `.env.sample` file to `.env`:
+export class DbClient extends ATeamPrismaClient {
+  constructor(connectionUrl: string) {
+    super(connectionUrl);
+  }
 
-```sh
-cp .env.sample .env
+  async onModuleInit() {
+    await this.connect();
+  }
+
+  async onModuleDestroy() {
+    await this.disconnect();
+  }
+}
 ```
 
-Then, fill in the required environment variables in the `.env` file.
+### Playground
 
-To run a playground script, use the following command:
+- The playground is a dedicated space where you can test and experiment with the prisma client and schema. 
+- It contains various scripts that demonstrate how to interact with your database models.
+- Before running any playground scripts, make sure to set up your environment variables. First, copy the `.env.sample` file to `.env`:
 
 ```sh
-npx ts-node playground/missionSpec.ts
+cp .env.sample .env
 ```
 
-## Publishing
-
-To publish updates to this package, use the following command:
+- Then, fill in the required environment variables in the `.env` file.
+- To run a playground script, use the following command:
 
 ```sh
-yarn build && yarn publish
+npx ts-node playground/missionSpec.ts
 ```
 
-## Additional Information
+### Publishing a new version
 
-The package is available on npm at: [@a_team/prisma](https://www.npmjs.com/package/@a_team/prisma).
+- Pull the latest changes on the `main` branch and push the following tag to the repository:
 
-### Reference
+  ```bash
+  git tag v<major>.<minor>.<patch> # matches v0.0.1
+  git push origin tag v<major>.<minor>.<patch> # runs the publishing process
+  ```
 
-[Sharing Prisma Between Multiple Applications](https://medium.com/@nolawnchairs/sharing-prisma-between-multiple-applications-5c7a7d131519)
+- This tag creates the new package versions needed and pushes them towards the npm repository,
+- A `release` on the `github` repository is generated,
+- A slack notification is sent to the required channel with the release changes.