Package Exports

@aneuhold/core-ts-db-lib
@aneuhold/core-ts-db-lib/lib/documents/common/ApiKey
@aneuhold/core-ts-db-lib/lib/documents/common/ApiKey.js
@aneuhold/core-ts-db-lib/lib/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@aneuhold/core-ts-db-lib) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Personal Core Database Library

npm

This is used to export types used in various places for database interactions in personal projects.

Document structure

Project-specific documents can be held in a single collection. So those should inherit from the BaseDocumentWithType class.

When different document types are held under a specific collection, they should get their own folder.

Guidelines

Note that documents cannot have really special types or classes with functions. For example Set cannot be used.

Updating an existing document

If a property is being moved or a new required property is added, then take the following steps

Update the document
Update the validator
Push the changes to NPM
Go to be-ts-db-lib and update the versions there with yarn upgrade:core
Update the migration service in that repo and double check it looks okay
Run the migration with yarn migrate:dry then yarn migrate
Run validation to ensure everything is alright with yarn validate:dry then yarn validate if needed
Run tests
Update tests if needed then re-validate
Push a new version of the be-ts-db-lib to NPM
Pull the new versions into digital-ocean-functions and deploy
Pull the new versions into core-ts-api-lib and push to NPM
Pull the new versions into any relevant frontends and deploy
Test out the frontends to make sure it works okay and double check MongoDB directly