@node-in-layers/data 1.0.2

package/README.md

@@ -0,0 +1,343 @@
+# Data - A Node In Layers Package used for handling data and databases.
+
+This repository focuses on accessing and manipulating data, especially the ability to easily communicate with different databases. This package provides a high level interface for working with databases via the [functional-models](https://github.com/monolithst/functional-models) framework, particularly the [functional-models-orm](https://github.com/monolithst/functional-models-orm) functional object relational mapper (ORM) framework. It also provides access to the lower level database objects, for optimized direct querying.
+
+# How To Install
+
+`npm i @node-in-layers/data@latest`
+
+## Supported Databases
+
+- dynamo
+- memory
+- mongo
+- mysql
+- opensearch
+- postgres
+- sqlite
+
+## How To Add To a Node In Layers System
+
+To use this package you must do the following:
+
+1. Add it to the `apps` property.
+1. Add a `@node-in-layers/data` section to your configuration file.
+
+We recommend that you put the `data` app, as one of the earliest apps, it does not have any requirements, and subsequent packages likely want to use it.
+
+#### Example inside a `config.dev.mjs` file:
+
+```javascript
+import { CoreNamespace } from '@node-in-layers/core/index.js'
+import { DataNamespace } from '@node-in-layers/data/index.js'
+
+const core = {
+  systemName: 'my-system-name',
+  environment: 'dev',
+  apps: await Promise.all([
+    import('@node-in-layers/data/index.js'), // Right here
+    import('@node-in-layers/http/index.js'),
+    import('./src/my-local-app/index.js'),
+  ]),
+  layerOrder: ['services', 'features'],
+  logLevel: 'debug',
+  logFormat: 'json',
+}
+
+const data = {
+  databases: {
+    default: {
+      datastoreType: 'mysql',
+    },
+  },
+}
+
+export default () => ({
+  [CoreNamespace.root]: core,
+  [DataNamespace.root]: data,
+})
+```
+
+### Multiple Database Support
+
+This package has support for configuring multiple databases through the config file. There must be a "default" database, and any other database can be named and configured.
+
+In the following example we configure 3 databases. 1 is the default, the 2nd is a database for "caching" and the 3rd is a database that has "legacy data" in it.
+
+```javascript
+import { CoreNamespace } from '@node-in-layers/core/index.js'
+import { DataNamespace } from '@node-in-layers/data/index.js'
+
+const core = {
+  systemName: 'my-system-name',
+  environment: 'dev',
+  apps: await Promise.all([
+    import('@node-in-layers/data/index.js'), // Right here
+    import('@node-in-layers/http/index.js'),
+    import('./src/my-local-app/index.js'),
+  ]),
+  layerOrder: ['services', 'features'],
+  logLevel: 'debug',
+  logFormat: 'json',
+}
+
+const data = {
+  databases: {
+    default: {
+      datastoreType: 'mysql',
+    },
+    myCacheDb: {
+      datastoreType: 'dynamo',
+      awsRegion: 'us-east-1',
+    },
+    myLegacyData: {
+      datastoreType: 'sqlite',
+      filename: '/data/legacy.sqlite3',
+    },
+  },
+}
+
+export default () => ({
+  [CoreNamespace.root]: core,
+  [DataNamespace.root]: data,
+})
+```
+
+## How To Use
+
+There are 2 recommended uses of this package.
+
+1. The Model Cruds Interface
+1. Direct database access
+
+### The Model Cruds Interface
+
+The Model Cruds Interface (Create, Retrieve, Update, Delete, Search), is a series of wrappers over the top of the `functional-models-orm` framework, so that seamless integration with models can be used. Instead of having to work with the model instances directly, data can pass in and out of the database without having to know anything about how database interactions work.
+
+This interface can quickly wrap models at the service level, feature level and above, making it very easy to create model based REST APIS.
+
+#### A Quick Note About Designing a System Using Models
+
+It has been our experience that data models can and should be used throughout the system, however, the "orm" part of the models, it is recommended that they only be used at the services layer. The best way to do this, is where you need "non-orm" model use (validation, meta data, etc), we recommend using the ["noop" DatastoreProvider](https://github.com/monolithst/functional-models-orm/blob/master/src/datastore/noop.ts) that is made available with the `functional-models-orm` framework.
+
+In many other systems (such as Python's Django), when a developer uses the orm part of the modeling code (save/create/delete/etc), anywhere in the application, it can make it very difficult to optimize and understand bottlenecks of a system.
+
+<b>Node In Layers was designed from the beginning to fix this problem, by keeping each 'kind of code' in their appropriate layers. Database accessing code should go in services.</b>
+
+Here is how to use the Model Cruds Interface:
+
+```typescript
+import { loadSystem, Config, ServiceContext } from '@node-in-layers/core'
+import { memoizeValue } from '@node-in-layers/core/libs'
+import { DataNamespace, DataServicesLayer } from '@node-in-layers/data'
+import { createSimpleServiceModelWrappers } from '@node-in-layers/data/libs'
+import { OrmModelFactory, ormQueryBuilder } from 'functional-models-orm'
+import { TextProperty, UniqueIdProperty } from 'functional-models'
+import { FeaturesContext } from '@node-in-layers/core/index.js'
+
+type MyCustomModel = Readonly<{
+  id: string
+  name: string
+}>
+
+type AnotherModel = Readonly<{
+  id: string
+  name: string
+}>
+
+const createMyModels = ({ Model }: { Model: OrmModelFactory }) => {
+  const MyCustomModels = Model<MyCustomModel>('MyCustomModels', {
+    properties: {
+      id: UniqueIdProperty({ required: true }),
+      name: TextProperty({ required: true }),
+    },
+  })
+  const AnotherModels = Model<AnotherModel>('AnotherModels', {
+    properties: {
+      id: UniqueIdProperty({ required: true }),
+      name: TextProperty({ required: true }),
+    },
+  })
+  return {
+    MyCustomModels,
+    AnotherModels,
+  }
+}
+
+// Using this in a service.
+const myService = {
+  // Add DataServices as part of the context.
+  create: (context: ServiceContext<Config, DataServicesLayer>) => {
+    const dataContext = context.services[DataNamespace.root]
+
+    // A helper function so we don't have to get this more than once. We memoize it so its only executed once
+    const _getModels = memoizeValue(async () => {
+      // 1. Create your database instance/s
+      const databases = await dataContext.getDatabases()
+
+      // 2. Create an orm instance with your dbObjects
+      const orm = dataContext.getOrm(databases.default)
+
+      // 3. Create models
+      return createMyModels(orm)
+    })
+
+    // Example: CRUDS as a service - Here is a function makes the models available as service functions.
+    const getModelCruds = async () => {
+      const models = await _getModels()
+      // 4. Create Model Cruds Interface Wrapper.
+      const wrappedMyCustomModels = dataContext.modelCrudsService(
+        models.MyCustomModels
+      )
+      return {
+        [models.MyCustomModels.getName()]: wrappedMyCustomModels,
+      }
+
+      /* An alternative approach is wrapping all of them automagically */
+      return dataContext.modelCrudsServiceWrappers(models)
+    }
+
+    // Example: Using models in a service - Here is another function that uses the models to do a specific kind of search
+    const mySpecialSearch = async (value: string) => {
+      const models = await _getModels()
+      return models.AnotherModels.search(
+        ormQueryBuilder().property('name', value).take(1).compile()
+      ).then(i => i.instances[0])
+    }
+
+    return {
+      getModelCruds,
+      mySpecialSearch,
+    }
+  },
+}
+
+// An Example consumer of the model cruds interface.
+const myFeature = {
+  create: async (context: FeaturesContext<MyConfig>) => {
+    const myComplexFeature = async () => {
+      const myService = context.context['myService']
+      const modelServices = await myService.getModelServices()
+      // Creates and saves.
+      const myModel = await modelServices.MyCustomModels.create({
+        id: 'my-id',
+        name: 'my-custom-name',
+      })
+
+      // Get It back
+      const instance = await modelServices.MyCustomModels.retrieve('my-id')
+
+      // Use another service function that uses models.
+      const value = modelServices.mySpecialSearch(instance.name)
+
+      // Delete it.
+      await modelServices.myCustomModels.delete(instance.id)
+      return 'OK'
+    }
+    return {
+      myComplexFeature,
+    }
+  },
+}
+```
+
+### Direct Database Access
+
+All of the objects that provide database access to `functional-models-orm` is made available in the DatabaseObjects object that comes back from `getDatabases()`. These objects (such as `knexClient`, `opensearchClient`, `mongoClient`, etc) provide the ability to do direct queries on the database using the underlying objects.
+
+### Important SQL Notice
+
+The underlying libraries needed to make sql databases work are not bundled. In order to make one work (say sqlite), you must include it in your individual systems dependencies or devDependencies.
+
+## Configurations
+
+The following contains examples of configurations for each database:
+
+### Dynamo Database
+
+```typescript
+{
+  datastoreType: 'dynamo',
+  environment: Environment,
+  serviceName: PeteServiceName,
+  awsRegion: string
+  httpsAgentConfig?: {
+    keepAlive?: boolean
+    maxSockets?: number
+  }
+}
+```
+
+### Memory Database
+
+```typescript
+{
+  datastoreType: 'memory',
+}
+```
+
+### Mongo Database
+
+```typescript
+{
+  datastoreType: 'mongo',
+  environment: Environment,
+  serviceName: PeteServiceName,
+  host: string
+  port?: number
+  username?: string
+  password?: string
+}
+```
+
+### Mysql Database
+
+```typescript
+{
+  datastoreType: 'mysql',
+  environment: Environment,
+  serviceName: PeteServiceName,
+  host: string
+  port?: number
+  username?: string
+  password?: string
+}
+```
+
+### Opensearch Database
+
+```typescript
+{
+  datastoreType: 'opensearch',
+  environment: Environment,
+  serviceName: PeteServiceName,
+  username: string
+  password: string
+  host: string
+}
+```
+
+### Postgresql Database
+
+```typescript
+{
+  datastoreType: 'postgres',
+  environment: Environment,
+  serviceName: PeteServiceName,
+  host: string
+  port?: number
+  username?: string
+  password?: string
+}
+```
+
+### Sqlite3 Database
+
+```typescript
+{
+  datastoreType: 'sqlite',
+  environment: Environment,
+  serviceName: PeteServiceName,
+  filename: string
+}
+```

package/features.d.ts

@@ -0,0 +1,4 @@
+import { Config, FeaturesContext } from '@node-in-layers/core/index.js';
+import { DataServicesLayer, DataFeaturesLayer, DataFeatures } from './types.js';
+declare const create: (context: FeaturesContext<Config, DataServicesLayer, DataFeaturesLayer>) => DataFeatures;
+export { create };

package/features.js

@@ -0,0 +1,18 @@
+import merge from 'lodash/merge.js';
+const create = (
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+context) => {
+    const wrapModelCrudsService = (modelCruds, overrides) => {
+        return merge({}, modelCruds, overrides);
+    };
+    const wrapAllModelCrudsServices = (objs, overrides) => {
+        overrides = overrides || {};
+        return merge({}, objs, overrides);
+    };
+    return {
+        wrapModelCrudsService,
+        wrapAllModelCrudsServices,
+    };
+};
+export { create };
+//# sourceMappingURL=features.js.map

package/features.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"features.js","sourceRoot":"","sources":["../src/features.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,iBAAiB,CAAA;AAUnC,MAAM,MAAM,GAAG;AACb,6DAA6D;AAC7D,OAAsE,EACxD,EAAE;IAChB,MAAM,qBAAqB,GAAG,CAC5B,UAAkC,EAClC,SAA0C,EAC1C,EAAE;QACF,OAAO,KAAK,CAAC,EAAE,EAAE,UAAU,EAAE,SAAS,CAAC,CAAA;IACzC,CAAC,CAAA;IAED,MAAM,yBAAyB,GAAG,CAChC,IAA8C,EAC9C,SAA6D,EAC7D,EAAE;QACF,SAAS,GAAG,SAAS,IAAI,EAAE,CAAA;QAC3B,OAAO,KAAK,CAAC,EAAE,EAAE,IAAI,EAAE,SAAS,CAAC,CAAA;IACnC,CAAC,CAAA;IAED,OAAO;QACL,qBAAqB;QACrB,yBAAyB;KAC1B,CAAA;AACH,CAAC,CAAA;AAED,OAAO,EAAE,MAAM,EAAE,CAAA"}

package/index.d.ts

@@ -0,0 +1,5 @@
+import { DataNamespace } from './types.js';
+declare const name = DataNamespace.root;
+export { name };
+export * as features from './features.js';
+export * as types from './types.js';

package/index.js

@@ -0,0 +1,6 @@
+import { DataNamespace } from './types.js';
+const name = DataNamespace.root;
+export { name };
+export * as features from './features.js';
+export * as types from './types.js';
+//# sourceMappingURL=index.js.map

package/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,YAAY,CAAA;AAE1C,MAAM,IAAI,GAAG,aAAa,CAAC,IAAI,CAAA;AAE/B,OAAO,EAAE,IAAI,EAAE,CAAA;AACf,OAAO,KAAK,QAAQ,MAAM,eAAe,CAAA;AACzC,OAAO,KAAK,KAAK,MAAM,YAAY,CAAA"}

package/libs.d.ts

@@ -0,0 +1,9 @@
+import { Model } from 'functional-models/interfaces.js';
+declare const getSystemInfrastructureName: ({ environment, systemName, component, }: {
+    component?: string | undefined;
+    environment: string;
+    systemName: string;
+}) => string;
+declare const defaultGetTableNameForModel: (environment: string, systemName: string, model: Model<any> | string) => string;
+declare const getMongoCollectionNameForModel: () => (model: any | string) => string;
+export { getMongoCollectionNameForModel, defaultGetTableNameForModel, getSystemInfrastructureName, };

package/libs.js

@@ -0,0 +1,19 @@
+import kebabCase from 'lodash/kebabCase.js';
+import isString from 'lodash/isString.js';
+const getSystemInfrastructureName = ({ environment, systemName, component, }) => {
+    return component
+        ? kebabCase(`${systemName}-${component}-${environment}`)
+        : kebabCase(`${systemName}-${environment}`);
+};
+const defaultGetTableNameForModel = (environment, systemName, model) => {
+    const component = isString(model) ? model : model.getName();
+    return getSystemInfrastructureName({ systemName, environment, component });
+};
+const getMongoCollectionNameForModel = () => (model) => {
+    if (isString(model)) {
+        return kebabCase(model);
+    }
+    return kebabCase(model.getName());
+};
+export { getMongoCollectionNameForModel, defaultGetTableNameForModel, getSystemInfrastructureName, };
+//# sourceMappingURL=libs.js.map

package/libs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"libs.js","sourceRoot":"","sources":["../src/libs.ts"],"names":[],"mappings":"AACA,OAAO,SAAS,MAAM,qBAAqB,CAAA;AAC3C,OAAO,QAAQ,MAAM,oBAAoB,CAAA;AAEzC,MAAM,2BAA2B,GAAG,CAAC,EACnC,WAAW,EACX,UAAU,EACV,SAAS,GAKV,EAAE,EAAE;IACH,OAAO,SAAS;QACd,CAAC,CAAC,SAAS,CAAC,GAAG,UAAU,IAAI,SAAS,IAAI,WAAW,EAAE,CAAC;QACxD,CAAC,CAAC,SAAS,CAAC,GAAG,UAAU,IAAI,WAAW,EAAE,CAAC,CAAA;AAC/C,CAAC,CAAA;AAED,MAAM,2BAA2B,GAAG,CAClC,WAAmB,EACnB,UAAkB,EAClB,KAA0B,EAC1B,EAAE;IACF,MAAM,SAAS,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,EAAE,CAAA;IAC3D,OAAO,2BAA2B,CAAC,EAAE,UAAU,EAAE,WAAW,EAAE,SAAS,EAAE,CAAC,CAAA;AAC5E,CAAC,CAAA;AAED,MAAM,8BAA8B,GAAG,GAAG,EAAE,CAAC,CAAC,KAAmB,EAAE,EAAE;IACnE,IAAI,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;QACpB,OAAO,SAAS,CAAC,KAAK,CAAC,CAAA;IACzB,CAAC;IACD,OAAO,SAAS,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC,CAAA;AACnC,CAAC,CAAA;AAED,OAAO,EACL,8BAA8B,EAC9B,2BAA2B,EAC3B,2BAA2B,GAC5B,CAAA"}

package/package.json

@@ -0,0 +1,80 @@
+{
+  "name": "@node-in-layers/data",
+  "type": "module",
+  "version": "1.0.2",
+  "description": "A Node In Layers package used for handling databases.",
+  "main": "index.js",
+  "scripts": {
+    "build": "rm -Rf ./dist && tsc -p ./tsconfig.json && cp package.json ./dist && cp README.md ./dist",
+    "build:watch": "nodemon -e '*' --watch ./src --exec \"npm run build || exit 1\"",
+    "commit": "cz",
+    "dist": "npm run build && cd dist && npm publish",
+    "eslint": "eslint .",
+    "feature-tests": "./node_modules/.bin/cucumber-js -p default",
+    "prettier": "prettier --write .",
+    "test": "export TS_NODE_PROJECT='./tsconfig.test.json' && mocha -r tsx ./test/src/*.test.ts ./test/src/**/*.test.ts ./test/src/**/**/*.test.ts",
+    "test:coverage": "nyc --all --reporter cobertura --reporter text --reporter lcov --reporter html npm run test"
+  },
+  "config": {
+    "commitizen": {
+      "path": "./node_modules/cz-conventional-changelog"
+    }
+  },
+  "author": "",
+  "license": "ISC",
+  "devDependencies": {
+    "@cucumber/cucumber": "11.0.1",
+    "@eslint/compat": "^1.2.0",
+    "@eslint/eslintrc": "^3.1.0",
+    "@eslint/js": "^9.12.0",
+    "@istanbuljs/nyc-config-typescript": "^1.0.2",
+    "@types/chai-as-promised": "^8.0.1",
+    "@types/json-stringify-safe": "^5.0.3",
+    "@types/lodash": "^4.17.13",
+    "@types/mocha": "^9.1.1",
+    "@types/node": "^22.9.0",
+    "@types/proxyquire": "^1.3.31",
+    "@types/sinon": "^17.0.3",
+    "@typescript-eslint/eslint-plugin": "8.13.0",
+    "@typescript-eslint/parser": "8.13.0",
+    "argparse": "^2.0.1",
+    "chai": "^4.2.0",
+    "chai-as-promised": "^7.1.1",
+    "cz-conventional-changelog": "^3.3.0",
+    "eslint": "9.14.0",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-import-resolver-typescript": "^3.6.3",
+    "eslint-plugin-functional": "~7.1.0",
+    "eslint-plugin-import": "^2.31.0",
+    "globals": "^15.12.0",
+    "handlebars": "^4.7.8",
+    "js-yaml": "^4.1.0",
+    "mocha": "^11.0.1",
+    "nodemon": "^3.1.7",
+    "nyc": "^17.1.0",
+    "prettier": "^3.3.3",
+    "proxyquire": "^2.1.3",
+    "sinon": "^19.0.2",
+    "sinon-chai": "^3.5.0",
+    "source-map-support": "^0.5.21",
+    "ts-node": "^10.4.0",
+    "tsx": "^4.19.2",
+    "typescript": "5.3.3"
+  },
+  "dependencies": {
+    "@aws-sdk/client-dynamodb": "^3.721.0",
+    "@aws-sdk/lib-dynamodb": "^3.721.0",
+    "@node-in-layers/core": "^1.1.3",
+    "@opensearch-project/opensearch": "^2.13.0",
+    "functional-models": "^2.1.14",
+    "functional-models-orm": "^2.1.13",
+    "functional-models-orm-dynamo": "^2.1.7",
+    "functional-models-orm-elastic": "^1.0.5",
+    "functional-models-orm-mongo": "^2.0.7",
+    "functional-models-orm-sql": "^2.1.3",
+    "knex": "^3.1.0",
+    "lodash": "^4.17.21",
+    "modern-async": "^2.0.4",
+    "mongodb": "^6.12.0"
+  }
+}

package/services.d.ts

@@ -0,0 +1,4 @@
+import { ServicesContext } from '@node-in-layers/core/index.js';
+import { DataConfig, DataServices } from './types.js';
+declare const create: (context: ServicesContext<DataConfig>) => DataServices;
+export { create };

package/services.js

@@ -0,0 +1,251 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import https from 'node:https';
+import { memoizeValue } from '@node-in-layers/core/utils.js';
+import { orm, } from 'functional-models-orm';
+import { asyncMap } from 'modern-async';
+import merge from 'lodash/merge.js';
+import * as dynamo from '@aws-sdk/client-dynamodb';
+import * as libDynamo from '@aws-sdk/lib-dynamodb';
+import { Client as OpenSearchClient } from '@opensearch-project/opensearch';
+import { MongoClient } from 'mongodb';
+import knex from 'knex';
+import curry from 'lodash/curry.js';
+import omit from 'lodash/omit.js';
+import { datastoreProvider as dynamoDatastoreProvider } from 'functional-models-orm-dynamo';
+import { datastoreProvider as opensearchDatastoreProvider } from 'functional-models-orm-elastic';
+import { datastoreProvider as mongoDatastoreProvider } from 'functional-models-orm-mongo';
+import { datastoreProvider as sqlDatastoreProvider } from 'functional-models-orm-sql';
+import * as memoryDatastoreProvider from 'functional-models-orm/datastore/memory.js';
+import { SupportedDatabase, DataNamespace, } from './types.js';
+import { getSystemInfrastructureName, defaultGetTableNameForModel, getMongoCollectionNameForModel, } from './libs.js';
+const DEFAULT_MONGO_PORT = 27017;
+const createMongoConnectionString = ({ host, port, username, password, }) => {
+    return `mongodb://${username ? `${username}:${password}@` : ''}${host}:${port || DEFAULT_MONGO_PORT}`;
+};
+const createMongoDatabaseObjects = ({ environment, systemName, host, port, username, password, getTableNameForModel, }) => __awaiter(void 0, void 0, void 0, function* () {
+    const database = getSystemInfrastructureName({
+        environment,
+        systemName,
+    });
+    const connectionString = createMongoConnectionString({
+        host,
+        port,
+        username,
+        password,
+    });
+    const mongoClient = new MongoClient(connectionString);
+    yield mongoClient.connect();
+    const datastoreProvider = mongoDatastoreProvider({
+        mongoClient,
+        databaseName: database,
+        getCollectionNameForModel: curry(getTableNameForModel || getMongoCollectionNameForModel)(environment, systemName),
+    });
+    const cleanup = () => {
+        return mongoClient.close();
+    };
+    return {
+        mongoClient,
+        datastoreProvider,
+        cleanup,
+    };
+});
+const createMemoryDatabaseObjects = () => {
+    const datastoreProvider = memoryDatastoreProvider.default.default({});
+    return {
+        cleanup: () => Promise.resolve(),
+        datastoreProvider,
+    };
+};
+const createOpensearchDatabaseObjects = ({ environment, systemName, username, password, host, getTableNameForModel, }) => {
+    const node = `https://${username}:${password}@${host}`;
+    const client = new OpenSearchClient({
+        node,
+    });
+    return {
+        cleanup: () => Promise.resolve(),
+        opensearchClient: client,
+        datastoreProvider: opensearchDatastoreProvider.create({
+            client,
+            getIndexForModel: curry(getTableNameForModel || defaultGetTableNameForModel)(environment, systemName),
+        }),
+    };
+};
+const createSqlDatabaseObjects = (props) => {
+    const needsDatabase = props.datastoreType !== 'sqlite';
+    const knexConfig = Object.assign(Object.assign({ client: props.datastoreType }, (needsDatabase
+        ? {
+            database: getSystemInfrastructureName({
+                environment: props.environment,
+                systemName: props.systemName,
+            }),
+        }
+        : {})), { connection: Object.assign({}, omit(props, [
+            'datastoreType',
+            'environment',
+            'systemName',
+            'database',
+        ])) });
+    // @ts-ignore
+    const knexClient = knex(knexConfig);
+    const datastoreProvider = sqlDatastoreProvider({
+        knex: knexClient,
+        getTableNameForModel: curry(props.getTableNameForModel || defaultGetTableNameForModel)(props.environment, props.systemName),
+        //propertyTypeToParser: sqlParsers.BasicPropertyTypeToParser
+    });
+    return {
+        knexClient,
+        cleanup: () => Promise.resolve(),
+        datastoreProvider,
+    };
+};
+const createDynamoDatabaseObjects = ({ awsRegion, environment, systemName, httpsAgentConfig, getTableNameForModel, }) => {
+    const sslAgent = new https.Agent(httpsAgentConfig || {
+        keepAlive: true,
+        maxSockets: 50,
+    });
+    const awsConfig = {
+        region: awsRegion,
+        sslAgent,
+    };
+    const dynamoDbClient = new dynamo.DynamoDBClient(awsConfig);
+    const aws3 = Object.assign(Object.assign({}, dynamo), libDynamo);
+    const datastoreProvider = dynamoDatastoreProvider({
+        aws3: Object.assign(Object.assign({}, aws3), { dynamoDbClient }),
+        getTableNameForModel: curry(getTableNameForModel || defaultGetTableNameForModel)(environment, systemName),
+    });
+    return {
+        dynamoLibs: aws3,
+        dynamoDbClient,
+        datastoreProvider,
+        cleanup: () => Promise.resolve(),
+    };
+};
+const _supportedToDatastoreProviderFunc = {
+    [SupportedDatabase.memory]: createMemoryDatabaseObjects,
+    [SupportedDatabase.dynamo]: createDynamoDatabaseObjects,
+    [SupportedDatabase.mongo]: createMongoDatabaseObjects,
+    [SupportedDatabase.opensearch]: createOpensearchDatabaseObjects,
+    [SupportedDatabase.sqlite]: createSqlDatabaseObjects,
+    [SupportedDatabase.mysql]: createSqlDatabaseObjects,
+    [SupportedDatabase.postgres]: createSqlDatabaseObjects,
+};
+const createModelCrudsService = (model) => {
+    const update = (data) => {
+        return model
+            .create(data)
+            .save()
+            .then(instance => {
+            if (!instance) {
+                throw new Error(`Impossible situation`);
+            }
+            return instance.toObj();
+        });
+    };
+    const create = update;
+    const del = (id) => __awaiter(void 0, void 0, void 0, function* () {
+        const instance = yield model.retrieve(id);
+        if (!instance) {
+            return undefined;
+        }
+        yield instance.delete();
+        return undefined;
+    });
+    const retrieve = (id) => {
+        return model.retrieve(id).then(instance => {
+            if (!instance) {
+                return undefined;
+            }
+            return instance.toObj();
+        });
+    };
+    const search = (ormQuery) => {
+        return model.search(ormQuery).then((result) => __awaiter(void 0, void 0, void 0, function* () {
+            const instances = (yield asyncMap(result.instances, i => i.toObj()));
+            return {
+                instances,
+                page: result.page,
+            };
+        }));
+    };
+    return {
+        create,
+        update,
+        delete: del,
+        retrieve,
+        search,
+    };
+};
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+const create = (context) => {
+    const databases = context.config['@node-in-layers/data'].databases;
+    if (!databases) {
+        throw new Error(`Must include "${DataNamespace.root}.databases" inside of a config that uses the "${DataNamespace.root}" namespace`);
+    }
+    const modelCrudsServices = createModelCrudsService;
+    const modelCrudsServiceWrappers = (models) => {
+        return merge(models.map(m => {
+            return {
+                [m.getName()]: createModelCrudsService(m),
+            };
+        }));
+    };
+    const getDatabaseObjects = (props) => {
+        return Promise.resolve().then(() => {
+            const func = _supportedToDatastoreProviderFunc[props.datastoreType];
+            if (!func) {
+                throw new Error(`Unhandled type ${props.datastoreType}`);
+            }
+            return func(props);
+        });
+    };
+    const getOrm = (props) => {
+        const { Model, fetcher } = orm(props);
+        return {
+            Model,
+            fetcher,
+        };
+    };
+    const cleanup = () => __awaiter(void 0, void 0, void 0, function* () {
+        const databases = yield getDatabases();
+        yield asyncMap(Object.values(databases), d => d.cleanup(), 1);
+    });
+    const _getDatabases = () => __awaiter(void 0, void 0, void 0, function* () {
+        const neededProps = {
+            environment: context.config.environment,
+            systemName: context.config.systemName,
+        };
+        const defaultDbProps = merge(databases.default, neededProps);
+        const otherProps = omit(databases, 'default') || {};
+        const otherProps2 = Object.entries(otherProps).reduce((acc, [x, y]) => {
+            return merge(acc, { [x]: merge(y, neededProps) });
+        }, {});
+        const defaultDb = yield getDatabaseObjects(defaultDbProps);
+        const otherDatabases = yield Object.entries(otherProps2).reduce((accP, props) => __awaiter(void 0, void 0, void 0, function* () {
+            const acc = yield accP;
+            const dbObjects = yield getDatabaseObjects(props[1]);
+            return merge(acc, {
+                [props[0]]: dbObjects,
+            });
+        }), Promise.resolve({}));
+        return Object.assign({ default: defaultDb }, otherDatabases);
+    });
+    const getDatabases = () => memoizeValue(_getDatabases)();
+    return {
+        getDatabaseObjects,
+        getOrm,
+        getDatabases,
+        cleanup,
+        modelCrudsServices,
+        modelCrudsServiceWrappers,
+    };
+};
+export { create };
+//# sourceMappingURL=services.js.map

package/services.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"services.js","sourceRoot":"","sources":["../src/services.ts"],"names":[],"mappings":";;;;;;;;;AAAA,OAAO,KAAK,MAAM,YAAY,CAAA;AAC9B,OAAO,EAAE,YAAY,EAAE,MAAM,+BAA+B,CAAA;AAG5D,OAAO,EAEL,GAAG,GAGJ,MAAM,uBAAuB,CAAA;AAC9B,OAAO,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAA;AACvC,OAAO,KAAK,MAAM,iBAAiB,CAAA;AACnC,OAAO,KAAK,MAAM,MAAM,0BAA0B,CAAA;AAClD,OAAO,KAAK,SAAS,MAAM,uBAAuB,CAAA;AAClD,OAAO,EAAE,MAAM,IAAI,gBAAgB,EAAE,MAAM,gCAAgC,CAAA;AAC3E,OAAO,EAAE,WAAW,EAAE,MAAM,SAAS,CAAA;AACrC,OAAO,IAAI,MAAM,MAAM,CAAA;AACvB,OAAO,KAAK,MAAM,iBAAiB,CAAA;AACnC,OAAO,IAAI,MAAM,gBAAgB,CAAA;AACjC,OAAO,EAAE,iBAAiB,IAAI,uBAAuB,EAAE,MAAM,8BAA8B,CAAA;AAC3F,OAAO,EAAE,iBAAiB,IAAI,2BAA2B,EAAE,MAAM,+BAA+B,CAAA;AAChG,OAAO,EAAE,iBAAiB,IAAI,sBAAsB,EAAE,MAAM,6BAA6B,CAAA;AACzF,OAAO,EAAE,iBAAiB,IAAI,oBAAoB,EAAE,MAAM,2BAA2B,CAAA;AACrF,OAAO,KAAK,uBAAuB,MAAM,2CAA2C,CAAA;AACpF,OAAO,EAML,iBAAiB,EAGjB,aAAa,GAKd,MAAM,YAAY,CAAA;AACnB,OAAO,EACL,2BAA2B,EAC3B,2BAA2B,EAC3B,8BAA8B,GAC/B,MAAM,WAAW,CAAA;AAElB,MAAM,kBAAkB,GAAG,KAAK,CAAA;AAEhC,MAAM,2BAA2B,GAAG,CAAC,EACnC,IAAI,EACJ,IAAI,EACJ,QAAQ,EACR,QAAQ,GAMT,EAAE,EAAE;IACH,OAAO,aAAa,QAAQ,CAAC,CAAC,CAAC,GAAG,QAAQ,IAAI,QAAQ,GAAG,CAAC,CAAC,CAAC,EAAE,GAAG,IAAI,IACnE,IAAI,IAAI,kBACV,EAAE,CAAA;AACJ,CAAC,CAAA;AAED,MAAM,0BAA0B,GAAG,CAAO,EACxC,WAAW,EACX,UAAU,EACV,IAAI,EACJ,IAAI,EACJ,QAAQ,EACR,QAAQ,EACR,oBAAoB,GACM,EAE1B,EAAE;IACF,MAAM,QAAQ,GAAG,2BAA2B,CAAC;QAC3C,WAAW;QACX,UAAU;KACX,CAAC,CAAA;IACF,MAAM,gBAAgB,GAAG,2BAA2B,CAAC;QACnD,IAAI;QACJ,IAAI;QACJ,QAAQ;QACR,QAAQ;KACT,CAAC,CAAA;IACF,MAAM,WAAW,GAAG,IAAI,WAAW,CAAC,gBAAgB,CAAC,CAAA;IACrD,MAAM,WAAW,CAAC,OAAO,EAAE,CAAA;IAE3B,MAAM,iBAAiB,GAAG,sBAAsB,CAAC;QAC/C,WAAW;QACX,YAAY,EAAE,QAAQ;QACtB,yBAAyB,EAAE,KAAK,CAC9B,oBAAoB,IAAI,8BAA8B,CACvD,CAAC,WAAW,EAAE,UAAU,CAAC;KAC3B,CAAC,CAAA;IACF,MAAM,OAAO,GAAG,GAAG,EAAE;QACnB,OAAO,WAAW,CAAC,KAAK,EAAE,CAAA;IAC5B,CAAC,CAAA;IACD,OAAO;QACL,WAAW;QACX,iBAAiB;QACjB,OAAO;KACR,CAAA;AACH,CAAC,CAAA,CAAA;AAED,MAAM,2BAA2B,GAAG,GAAoB,EAAE;IACxD,MAAM,iBAAiB,GAAG,uBAAuB,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC,CAAA;IACrE,OAAO;QACL,OAAO,EAAE,GAAG,EAAE,CAAC,OAAO,CAAC,OAAO,EAAE;QAChC,iBAAiB;KAClB,CAAA;AACH,CAAC,CAAA;AAED,MAAM,+BAA+B,GAAG,CAAC,EACvC,WAAW,EACX,UAAU,EACV,QAAQ,EACR,QAAQ,EACR,IAAI,EACJ,oBAAoB,GACW,EAE9B,EAAE;IACH,MAAM,IAAI,GAAG,WAAW,QAAQ,IAAI,QAAQ,IAAI,IAAI,EAAE,CAAA;IACtD,MAAM,MAAM,GAAG,IAAI,gBAAgB,CAAC;QAClC,IAAI;KACL,CAAC,CAAA;IACF,OAAO;QACL,OAAO,EAAE,GAAG,EAAE,CAAC,OAAO,CAAC,OAAO,EAAE;QAChC,gBAAgB,EAAE,MAAM;QACxB,iBAAiB,EAAE,2BAA2B,CAAC,MAAM,CAAC;YACpD,MAAM;YACN,gBAAgB,EAAE,KAAK,CACrB,oBAAoB,IAAI,2BAA2B,CACpD,CAAC,WAAW,EAAE,UAAU,CAAC;SAC3B,CAAC;KACH,CAAA;AACH,CAAC,CAAA;AAED,MAAM,wBAAwB,GAAG,CAC/B,KAA8B,EACQ,EAAE;IACxC,MAAM,aAAa,GAAG,KAAK,CAAC,aAAa,KAAK,QAAQ,CAAA;IACtD,MAAM,UAAU,iCACd,MAAM,EAAE,KAAK,CAAC,aAAa,IACxB,CAAC,aAAa;QACf,CAAC,CAAC;YACE,QAAQ,EAAE,2BAA2B,CAAC;gBACpC,WAAW,EAAE,KAAK,CAAC,WAAW;gBAC9B,UAAU,EAAE,KAAK,CAAC,UAAU;aAC7B,CAAC;SACH;QACH,CAAC,CAAC,EAAE,CAAC,KACP,UAAU,oBACL,IAAI,CAAC,KAAK,EAAE;YACb,eAAe;YACf,aAAa;YACb,YAAY;YACZ,UAAU;SACX,CAAC,IAEL,CAAA;IACD,aAAa;IACb,MAAM,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC,CAAA;IACnC,MAAM,iBAAiB,GAAG,oBAAoB,CAAC;QAC7C,IAAI,EAAE,UAAU;QAChB,oBAAoB,EAAE,KAAK,CACzB,KAAK,CAAC,oBAAoB,IAAI,2BAA2B,CAC1D,CAAC,KAAK,CAAC,WAAW,EAAE,KAAK,CAAC,UAAU,CAAC;QACtC,4DAA4D;KAC7D,CAAC,CAAA;IAEF,OAAO;QACL,UAAU;QACV,OAAO,EAAE,GAAG,EAAE,CAAC,OAAO,CAAC,OAAO,EAAE;QAChC,iBAAiB;KAClB,CAAA;AACH,CAAC,CAAA;AAED,MAAM,2BAA2B,GAAG,CAAC,EACnC,SAAS,EACT,WAAW,EACX,UAAU,EACV,gBAAgB,EAChB,oBAAoB,GACO,EAG1B,EAAE;IACH,MAAM,QAAQ,GAAG,IAAI,KAAK,CAAC,KAAK,CAC9B,gBAAgB,IAAI;QAClB,SAAS,EAAE,IAAI;QACf,UAAU,EAAE,EAAE;KACf,CACF,CAAA;IAED,MAAM,SAAS,GAAG;QAChB,MAAM,EAAE,SAAS;QACjB,QAAQ;KACT,CAAA;IAED,MAAM,cAAc,GAAG,IAAI,MAAM,CAAC,cAAc,CAAC,SAAS,CAAC,CAAA;IAC3D,MAAM,IAAI,mCACL,MAAM,GACN,SAAS,CACb,CAAA;IAED,MAAM,iBAAiB,GAAG,uBAAuB,CAAC;QAChD,IAAI,kCACC,IAAI,KACP,cAAc,GACf;QACD,oBAAoB,EAAE,KAAK,CACzB,oBAAoB,IAAI,2BAA2B,CACpD,CAAC,WAAW,EAAE,UAAU,CAAC;KAC3B,CAAC,CAAA;IACF,OAAO;QACL,UAAU,EAAE,IAAI;QAChB,cAAc;QACd,iBAAiB;QACjB,OAAO,EAAE,GAAG,EAAE,CAAC,OAAO,CAAC,OAAO,EAAE;KACjC,CAAA;AACH,CAAC,CAAA;AAED,MAAM,iCAAiC,GAGnC;IACF,CAAC,iBAAiB,CAAC,MAAM,CAAC,EAAE,2BAA2B;IACvD,CAAC,iBAAiB,CAAC,MAAM,CAAC,EAAE,2BAA2B;IACvD,CAAC,iBAAiB,CAAC,KAAK,CAAC,EAAE,0BAA0B;IACrD,CAAC,iBAAiB,CAAC,UAAU,CAAC,EAAE,+BAA+B;IAC/D,CAAC,iBAAiB,CAAC,MAAM,CAAC,EAAE,wBAAwB;IACpD,CAAC,iBAAiB,CAAC,KAAK,CAAC,EAAE,wBAAwB;IACnD,CAAC,iBAAiB,CAAC,QAAQ,CAAC,EAAE,wBAAwB;CACvD,CAAA;AAED,MAAM,uBAAuB,GAAG,CAC9B,KAAkB,EACM,EAAE;IAC1B,MAAM,MAAM,GAAG,CAAC,IAAO,EAAc,EAAE;QACrC,OAAO,KAAK;aACT,MAAM,CAAC,IAAI,CAAC;aACZ,IAAI,EAAE;aACN,IAAI,CAAC,QAAQ,CAAC,EAAE;YACf,IAAI,CAAC,QAAQ,EAAE,CAAC;gBACd,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAA;YACzC,CAAC;YACD,OAAO,QAAQ,CAAC,KAAK,EAAkB,CAAA;QACzC,CAAC,CAAC,CAAA;IACN,CAAC,CAAA;IAED,MAAM,MAAM,GAAG,MAAM,CAAA;IAErB,MAAM,GAAG,GAAG,CAAO,EAAmB,EAAiB,EAAE;QACvD,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAA;QACzC,IAAI,CAAC,QAAQ,EAAE,CAAC;YACd,OAAO,SAAS,CAAA;QAClB,CAAC;QACD,MAAM,QAAQ,CAAC,MAAM,EAAE,CAAA;QACvB,OAAO,SAAS,CAAA;IAClB,CAAC,CAAA,CAAA;IAED,MAAM,QAAQ,GAAG,CAAC,EAAmB,EAA0B,EAAE;QAC/D,OAAO,KAAK,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE;YACxC,IAAI,CAAC,QAAQ,EAAE,CAAC;gBACd,OAAO,SAAS,CAAA;YAClB,CAAC;YACD,OAAO,QAAQ,CAAC,KAAK,EAAkB,CAAA;QACzC,CAAC,CAAC,CAAA;IACJ,CAAC,CAAA;IAED,MAAM,MAAM,GAAG,CAAC,QAAkB,EAA4B,EAAE;QAC9D,OAAO,KAAK,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,CAAM,MAAM,EAAC,EAAE;YAChD,MAAM,SAAS,GAAG,CAAC,MAAM,QAAQ,CAAC,MAAM,CAAC,SAAS,EAAE,CAAC,CAAC,EAAE,CACtD,CAAC,CAAC,KAAK,EAAE,CACV,CAA4B,CAAA;YAC7B,OAAO;gBACL,SAAS;gBACT,IAAI,EAAE,MAAM,CAAC,IAAI;aAClB,CAAA;QACH,CAAC,CAAA,CAAC,CAAA;IACJ,CAAC,CAAA;IAED,OAAO;QACL,MAAM;QACN,MAAM;QACN,MAAM,EAAE,GAAG;QACX,QAAQ;QACR,MAAM;KACP,CAAA;AACH,CAAC,CAAA;AAED,6DAA6D;AAC7D,MAAM,MAAM,GAAG,CAAC,OAAoC,EAAgB,EAAE;IACpE,MAAM,SAAS,GAAG,OAAO,CAAC,MAAM,CAAC,sBAAsB,CAAC,CAAC,SAAS,CAAA;IAClE,IAAI,CAAC,SAAS,EAAE,CAAC;QACf,MAAM,IAAI,KAAK,CACb,iBAAiB,aAAa,CAAC,IAAI,iDAAiD,aAAa,CAAC,IAAI,aAAa,CACpH,CAAA;IACH,CAAC;IAED,MAAM,kBAAkB,GAAG,uBAAuB,CAAA;IAElD,MAAM,yBAAyB,GAAG,CAChC,MAAuB,EACmB,EAAE;QAC5C,OAAO,KAAK,CACV,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE;YACb,OAAO;gBACL,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC,EAAE,uBAAuB,CAAC,CAAC,CAAC;aAC1C,CAAA;QACH,CAAC,CAAC,CACH,CAAA;IACH,CAAC,CAAA;IAED,MAAM,kBAAkB,GAAG,CACzB,KAA2B,EACiB,EAAE;QAC9C,OAAO,OAAO,CAAC,OAAO,EAAE,CAAC,IAAI,CAAC,GAAG,EAAE;YACjC,MAAM,IAAI,GAAG,iCAAiC,CAAC,KAAK,CAAC,aAAa,CAAC,CAAA;YACnE,IAAI,CAAC,IAAI,EAAE,CAAC;gBACV,MAAM,IAAI,KAAK,CAAC,kBAAkB,KAAK,CAAC,aAAa,EAAE,CAAC,CAAA;YAC1D,CAAC;YACD,OAAO,IAAI,CAAC,KAAK,CAAC,CAAA;QACpB,CAAC,CAAC,CAAA;IACJ,CAAC,CAAA;IAED,MAAM,MAAM,GAAG,CAAC,KAA+C,EAAE,EAAE;QACjE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,GAAG,GAAG,CAAC,KAAK,CAAC,CAAA;QACrC,OAAO;YACL,KAAK;YACL,OAAO;SACR,CAAA;IACH,CAAC,CAAA;IAED,MAAM,OAAO,GAAG,GAAS,EAAE;QACzB,MAAM,SAAS,GAAG,MAAM,YAAY,EAAE,CAAA;QACtC,MAAM,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,CAAA;IAC/D,CAAC,CAAA,CAAA;IAED,MAAM,aAAa,GAAG,GAAS,EAAE;QAC/B,MAAM,WAAW,GAAG;YAClB,WAAW,EAAE,OAAO,CAAC,MAAM,CAAC,WAAW;YACvC,UAAU,EAAE,OAAO,CAAC,MAAM,CAAC,UAAU;SACtC,CAAA;QACD,MAAM,cAAc,GAAG,KAAK,CAC1B,SAAS,CAAC,OAAO,EACjB,WAAW,CACY,CAAA;QACzB,MAAM,UAAU,GACd,IAAI,CAAC,SAAS,EAAE,SAAS,CAAC,IAAI,EAAE,CAAA;QAClC,MAAM,WAAW,GAAyC,MAAM,CAAC,OAAO,CACtE,UAAU,CACX,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE;YACvB,OAAO,KAAK,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,EAAE,WAAW,CAAC,EAAE,CAAC,CAAA;QACnD,CAAC,EAAE,EAAE,CAAyC,CAAA;QAE9C,MAAM,SAAS,GAAG,MAAM,kBAAkB,CAAC,cAAc,CAAC,CAAA;QAC1D,MAAM,cAAc,GAClB,MAAM,MAAM,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC,MAAM,CACtC,CAAO,IAAI,EAAE,KAAK,EAAE,EAAE;YACpB,MAAM,GAAG,GAAG,MAAM,IAAI,CAAA;YACtB,MAAM,SAAS,GAAG,MAAM,kBAAkB,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAA;YACpD,OAAO,KAAK,CAAC,GAAG,EAAE;gBAChB,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,SAAS;aACtB,CAAC,CAAA;QACJ,CAAC,CAAA,EACD,OAAO,CAAC,OAAO,CAAC,EAAqC,CAAC,CACvD,CAAA;QACH,uBACE,OAAO,EAAE,SAAS,IACf,cAAc,EAClB;IACH,CAAC,CAAA,CAAA;IAED,MAAM,YAAY,GAAG,GAAG,EAAE,CAAC,YAAY,CAAC,aAAa,CAAC,EAAE,CAAA;IAExD,OAAO;QACL,kBAAkB;QAClB,MAAM;QACN,YAAY;QACZ,OAAO;QACP,kBAAkB;QAClB,yBAAyB;KAC1B,CAAA;AACH,CAAC,CAAA;AAED,OAAO,EAAE,MAAM,EAAE,CAAA"}

package/types.d.ts

@@ -0,0 +1,167 @@
+import { FunctionalModel, Model, ModelFetcher } from 'functional-models/interfaces.js';
+import { DatastoreProvider, OrmModel, OrmModelFactory, OrmQuery } from 'functional-models-orm';
+import { Config } from '@node-in-layers/core/index.js';
+declare enum DataNamespace {
+    root = "@node-in-layers/data"
+}
+declare enum SupportedDatabase {
+    memory = "memory",
+    dynamo = "dynamo",
+    mongo = "mongo",
+    opensearch = "opensearch",
+    mysql = "mysql",
+    postgres = "postgres",
+    sqlite = "sqlite"
+}
+type BasicDatabaseProps = Readonly<{
+    environment: string;
+    systemName: string;
+    getTableNameForModel?: (systemName: string, environment: string, model: Model<any>) => string;
+}>;
+type KnexConfigProps = Readonly<{
+    username?: string;
+    port?: number;
+    host?: string;
+    password?: string;
+}>;
+type SqliteConfigProps = Readonly<{
+    filename: string;
+}>;
+type SqlDatabaseObjectsProps = Readonly<{
+    datastoreType: SupportedDatabase.mysql | SupportedDatabase.postgres | SupportedDatabase.sqlite;
+}> & BasicDatabaseProps & (KnexConfigProps | SqliteConfigProps);
+type MongoDatabaseObjectsProps = Readonly<{
+    host: string;
+    port?: number;
+    username?: string;
+    password?: string;
+}> & BasicDatabaseProps;
+type OpensearchDatabaseObjectsProps = Readonly<{
+    username: string;
+    password: string;
+    host: string;
+}> & BasicDatabaseProps;
+type DynamoDatabaseObjectsProps = Readonly<{
+    awsRegion: string;
+    httpsAgentConfig?: {
+        keepAlive?: boolean;
+        maxSockets?: number;
+    };
+}> & BasicDatabaseProps;
+type DatabaseObjectsProps = Readonly<{
+    datastoreType: SupportedDatabase;
+}> & BasicDatabaseProps & (DynamoDatabaseObjectsProps | OpensearchDatabaseObjectsProps | MongoDatabaseObjectsProps | SqlDatabaseObjectsProps);
+type SearchResult<T extends FunctionalModel> = Readonly<{
+    instances: readonly T[];
+    page?: any;
+}>;
+type NonProvidedDatabaseProps = Omit<DatabaseObjectsProps, 'systemName' | 'environment'>;
+type DefaultDatabaseProps = {
+    default: NonProvidedDatabaseProps;
+};
+type MultiDatabasesProps = DefaultDatabaseProps & Record<string, NonProvidedDatabaseProps>;
+/**
+ * A config that uses databases.
+ */
+type DataConfig = Config & {
+    [DataNamespace.root]: {
+        databases: DefaultDatabaseProps | MultiDatabasesProps;
+    };
+};
+/**
+ * Represents a set of database related objects. Both highlevel and low level.
+ * These objects can be utilized deep inside a services layer, to access data.
+ */
+type DatabaseObjects<T extends object = object> = {
+    /**
+     * This datastoreProvider is used for backing the ORM system.
+     */
+    datastoreProvider: DatastoreProvider;
+    /**
+     * A cleanup function that should run at the end of the application, that cleans up database connections.
+     */
+    cleanup: () => Promise<void>;
+} & T;
+/**
+ * An interface for making CRUDS (create/retrieve/update/delete/search) commands into a database.
+ */
+type ModelCrudsInterface<T extends FunctionalModel> = Readonly<{
+    /**
+     * Create either one item, or an array of items in a database
+     * @param data
+     */
+    create: (data: T) => Promise<T>;
+    /**
+     * Retrieve a single item from the database.
+     * @param id
+     */
+    retrieve: (id: string | number) => Promise<T | undefined>;
+    /**
+     * Updates a single item in the database
+     * @param data
+     */
+    update: (data: T) => Promise<T>;
+    /**
+     * Deletes an item from the database
+     * @param id
+     */
+    delete: (id: string | number) => Promise<void>;
+    /**
+     * Searches the corresponding table for this item.
+     * @param ormQuery
+     */
+    search: (ormQuery: OrmQuery) => Promise<SearchResult<T>>;
+}>;
+/**
+ * Data services.
+ */
+type DataServices = Readonly<{
+    getDatabaseObjects: (props: DatabaseObjectsProps) => Promise<DatabaseObjects> | DatabaseObjects;
+    getOrm: (props: {
+        datastoreProvider: DatastoreProvider;
+    }) => {
+        Model: OrmModelFactory;
+        fetcher: ModelFetcher;
+    };
+    /**
+     * Gets all databases. This is memoized, so on the first attempt, it will create connections to 1 or more databases
+     * and then give you access to those database objects for further use. Very useful in a services layer.
+     */
+    getDatabases: () => Promise<MultiDatabases>;
+    /**
+     * Runs cleanup on every database connection. Only run when the application is ending.
+     */
+    cleanup: () => Promise<void>;
+    modelCrudsServices: <T extends FunctionalModel>(model: OrmModel<T>) => ModelCrudsInterface<T>;
+    modelCrudsServiceWrappers: (models: OrmModel<any>[]) => Record<string, ModelCrudsInterface<any>>;
+}>;
+/**
+ * The services for the Data package.
+ */
+type DataServicesLayer = Readonly<{
+    [DataNamespace.root]: DataServices;
+}>;
+/**
+ * The Features for the Data package.
+ */
+type DataFeatures = Readonly<{
+    wrapModelCrudsService: <T extends FunctionalModel>(modelCruds: ModelCrudsInterface<T>, overrides: Partial<ModelCrudsInterface<T>>) => ModelCrudsInterface<T>;
+    wrapAllModelCrudsServices: (objs: Record<string, ModelCrudsInterface<any>>, overrides?: Record<string, ModelCrudsInterface<any>>) => Record<string, ModelCrudsInterface<any>>;
+}>;
+/**
+ * The Features Layer for the Data package.
+ */
+type DataFeaturesLayer = Readonly<{
+    [DataNamespace.root]: DataFeatures;
+}>;
+/**
+ * The default database configured.
+ */
+type DefaultDatabase = {
+    default: DatabaseObjects;
+};
+/**
+ * 1 or more databases configured
+ */
+type MultiDatabases = DefaultDatabase & Record<string, DatabaseObjects>;
+export { DataServices, DataFeatures, DataFeaturesLayer, DataNamespace, SupportedDatabase, MongoDatabaseObjectsProps, DatabaseObjectsProps, DynamoDatabaseObjectsProps, BasicDatabaseProps, OpensearchDatabaseObjectsProps, SqlDatabaseObjectsProps, KnexConfigProps, SqliteConfigProps, SearchResult, DatabaseObjects, ModelCrudsInterface, DataConfig, DataServicesLayer, MultiDatabasesProps, MultiDatabases, NonProvidedDatabaseProps, };

package/types.js

@@ -0,0 +1,16 @@
+var DataNamespace;
+(function (DataNamespace) {
+    DataNamespace["root"] = "@node-in-layers/data";
+})(DataNamespace || (DataNamespace = {}));
+var SupportedDatabase;
+(function (SupportedDatabase) {
+    SupportedDatabase["memory"] = "memory";
+    SupportedDatabase["dynamo"] = "dynamo";
+    SupportedDatabase["mongo"] = "mongo";
+    SupportedDatabase["opensearch"] = "opensearch";
+    SupportedDatabase["mysql"] = "mysql";
+    SupportedDatabase["postgres"] = "postgres";
+    SupportedDatabase["sqlite"] = "sqlite";
+})(SupportedDatabase || (SupportedDatabase = {}));
+export { DataNamespace, SupportedDatabase, };
+//# sourceMappingURL=types.js.map

package/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAaA,IAAK,aAEJ;AAFD,WAAK,aAAa;IAChB,8CAA6B,CAAA;AAC/B,CAAC,EAFI,aAAa,KAAb,aAAa,QAEjB;AAED,IAAK,iBAQJ;AARD,WAAK,iBAAiB;IACpB,sCAAiB,CAAA;IACjB,sCAAiB,CAAA;IACjB,oCAAe,CAAA;IACf,8CAAyB,CAAA;IACzB,oCAAe,CAAA;IACf,0CAAqB,CAAA;IACrB,sCAAiB,CAAA;AACnB,CAAC,EARI,iBAAiB,KAAjB,iBAAiB,QAQrB;AA8MD,OAAO,EAIL,aAAa,EACb,iBAAiB,GAiBlB,CAAA"}