Added sample typed client

Author: oskardudycz

samples/simple-ts/package-lock.json

@@ -10,6 +10,7 @@
     "build:ts:watch": "tsc  --watch",
     "start": "tsx ./src/index.ts",
     "start:shim": "tsx ./src/shim.ts",
+    "start:typed": "tsx ./src/typedClient.ts",
     "lint": "npm run lint:eslint && npm run lint:prettier",
     "lint:prettier": "prettier --check \"**/**/!(*.d).{ts,json,md}\"",
     "lint:eslint": "eslint '**/*.ts'",
@@ -23,7 +24,8 @@
     "test:watch": "run-p test:unit:watch test:int:watch test:e2e:watch",
     "test:unit:watch": "glob -d -c \"node --import tsx --test --watch\" **/*.unit.spec.ts",
     "test:int:watch": "glob -d -c \"node --import tsx --test --watch\" **/*.int.spec.ts",
-    "test:e2e:watch": "glob -d -c \"node --import tsx --test --watch\" **/*.e2e.spec.ts"
+    "test:e2e:watch": "glob -d -c \"node --import tsx --test --watch\" **/*.e2e.spec.ts",
+    "migrate": "pongo migrate run --config ./dist/pongo.config.js --connectionString postgresql://postgres:postgres@localhost:5432/postgres"
   },
   "repository": {
     "type": "git",
@@ -60,6 +62,6 @@
     "dist"
   ],
   "dependencies": {
-    "@event-driven-io/pongo": "0.12.4"
+    "@event-driven-io/pongo": "0.14.4"
   }
 }

samples/simple-ts/package.json

@@ -0,0 +1,11 @@
+import { pongoSchema } from '@event-driven-io/pongo';
+
+export type User = { _id?: string; name: string; age: number };
+
+export default {
+  schema: pongoSchema.client({
+    database: pongoSchema.db({
+      users: pongoSchema.collection<User>('users'),
+    }),
+  }),
+};

samples/simple-ts/src/pongo.config.ts

@@ -0,0 +1,39 @@
+import { pongoClient } from '@event-driven-io/pongo';
+import { v4 as uuid } from 'uuid';
+import config from './pongo.config';
+
+const connectionString =
+  'postgresql://postgres:postgres@localhost:5432/postgres';
+
+const pongo = pongoClient(connectionString, {
+  schema: { definition: config.schema, autoMigration: 'CreateOrUpdate' },
+});
+const pongoDb = pongo.database;
+
+const users = pongoDb.users;
+const roger = { name: 'Roger', age: 30 };
+const anita = { name: 'Anita', age: 25 };
+const cruella = { _id: uuid(), name: 'Cruella', age: 40 };
+
+// Inserting
+await users.insertOne(roger);
+await users.insertOne(cruella);
+
+const { insertedId } = await users.insertOne(anita);
+const anitaId = insertedId!;
+
+// Updating
+await users.updateOne({ _id: anitaId }, { $set: { age: 31 } });
+
+// Deleting
+await users.deleteOne({ _id: cruella._id });
+
+// Finding by Id
+const anitaFromDb = await users.findOne({ _id: anitaId });
+console.log(JSON.stringify(anitaFromDb));
+
+// Finding more
+const usersFromDB = await users.find({ age: { $lt: 40 } });
+console.log(JSON.stringify(usersFromDB));
+
+await pongo.close();

samples/simple-ts/src/typedClient.ts

@@ -10,7 +10,12 @@ export default defineConfig({
   skipNodeModulesBundle: true,
   target: 'esnext',
   outDir: 'dist', //env === 'production' ? 'dist' : 'lib',
-  entry: ['src/index.ts'],
+  entry: [
+    'src/index.ts',
+    'src/pongo.config.ts',
+    'src/typedClient.ts',
+    'src/shim.ts',
+  ],
   sourcemap: true,
   tsconfig: 'tsconfig.json', // workaround for https://github.com/egoist/tsup/issues/571#issuecomment-1760052931
 });