Compare commits

..

No commits in common. "master" and "v2.0.10" have entirely different histories.

13 changed files with 4712 additions and 8810 deletions

View File

@ -6,8 +6,8 @@ on:
- '**' - '**'
env: env:
IMAGE: code.foss.global/host.today/ht-docker-node:npmci IMAGE: registry.gitlab.com/hosttoday/ht-docker-node:npmci
NPMCI_COMPUTED_REPOURL: https://${{gitea.repository_owner}}:${{secrets.GITEA_TOKEN}}@/${{gitea.repository}}.git NPMCI_COMPUTED_REPOURL: https://${{gitea.repository_owner}}:${{secrets.GITEA_TOKEN}}@gitea.lossless.digital/${{gitea.repository}}.git
NPMCI_TOKEN_NPM: ${{secrets.NPMCI_TOKEN_NPM}} NPMCI_TOKEN_NPM: ${{secrets.NPMCI_TOKEN_NPM}}
NPMCI_TOKEN_NPM2: ${{secrets.NPMCI_TOKEN_NPM2}} NPMCI_TOKEN_NPM2: ${{secrets.NPMCI_TOKEN_NPM2}}
NPMCI_GIT_GITHUBTOKEN: ${{secrets.NPMCI_GIT_GITHUBTOKEN}} NPMCI_GIT_GITHUBTOKEN: ${{secrets.NPMCI_GIT_GITHUBTOKEN}}
@ -26,7 +26,7 @@ jobs:
- name: Install pnpm and npmci - name: Install pnpm and npmci
run: | run: |
pnpm install -g pnpm pnpm install -g pnpm
pnpm install -g @ship.zone/npmci pnpm install -g @shipzone/npmci
- name: Run npm prepare - name: Run npm prepare
run: npmci npm prepare run: npmci npm prepare

View File

@ -6,8 +6,8 @@ on:
- '*' - '*'
env: env:
IMAGE: code.foss.global/host.today/ht-docker-node:npmci IMAGE: registry.gitlab.com/hosttoday/ht-docker-node:npmci
NPMCI_COMPUTED_REPOURL: https://${{gitea.repository_owner}}:${{secrets.GITEA_TOKEN}}@/${{gitea.repository}}.git NPMCI_COMPUTED_REPOURL: https://${{gitea.repository_owner}}:${{secrets.GITEA_TOKEN}}@gitea.lossless.digital/${{gitea.repository}}.git
NPMCI_TOKEN_NPM: ${{secrets.NPMCI_TOKEN_NPM}} NPMCI_TOKEN_NPM: ${{secrets.NPMCI_TOKEN_NPM}}
NPMCI_TOKEN_NPM2: ${{secrets.NPMCI_TOKEN_NPM2}} NPMCI_TOKEN_NPM2: ${{secrets.NPMCI_TOKEN_NPM2}}
NPMCI_GIT_GITHUBTOKEN: ${{secrets.NPMCI_GIT_GITHUBTOKEN}} NPMCI_GIT_GITHUBTOKEN: ${{secrets.NPMCI_GIT_GITHUBTOKEN}}
@ -26,7 +26,7 @@ jobs:
- name: Prepare - name: Prepare
run: | run: |
pnpm install -g pnpm pnpm install -g pnpm
pnpm install -g @ship.zone/npmci pnpm install -g @shipzone/npmci
npmci npm prepare npmci npm prepare
- name: Audit production dependencies - name: Audit production dependencies
@ -54,7 +54,7 @@ jobs:
- name: Prepare - name: Prepare
run: | run: |
pnpm install -g pnpm pnpm install -g pnpm
pnpm install -g @ship.zone/npmci pnpm install -g @shipzone/npmci
npmci npm prepare npmci npm prepare
- name: Test stable - name: Test stable
@ -82,7 +82,7 @@ jobs:
- name: Prepare - name: Prepare
run: | run: |
pnpm install -g pnpm pnpm install -g pnpm
pnpm install -g @ship.zone/npmci pnpm install -g @shipzone/npmci
npmci npm prepare npmci npm prepare
- name: Release - name: Release
@ -104,7 +104,7 @@ jobs:
- name: Prepare - name: Prepare
run: | run: |
pnpm install -g pnpm pnpm install -g pnpm
pnpm install -g @ship.zone/npmci pnpm install -g @shipzone/npmci
npmci npm prepare npmci npm prepare
- name: Code quality - name: Code quality
@ -119,6 +119,6 @@ jobs:
run: | run: |
npmci node install stable npmci node install stable
npmci npm install npmci npm install
pnpm install -g @git.zone/tsdoc pnpm install -g @gitzone/tsdoc
npmci command tsdoc npmci command tsdoc
continue-on-error: true continue-on-error: true

3
.gitignore vendored
View File

@ -3,6 +3,7 @@
# artifacts # artifacts
coverage/ coverage/
public/ public/
pages/
# installs # installs
node_modules/ node_modules/
@ -16,4 +17,4 @@ node_modules/
dist/ dist/
dist_*/ dist_*/
#------# custom # custom

View File

@ -1,121 +0,0 @@
# Changelog
## 2025-04-06 - 2.0.12 - fix(ci/config)
Update CI workflow environment variables, refine package metadata, and improve configuration settings
- Updated workflow YAML files to use new IMAGE and npmci package names
- Adjusted package.json homepage, added bugs field and pnpm overrides
- Minor formatting improvements in readme.md and .gitignore
- Enhanced tsconfig with baseUrl and paths for improved module resolution
## 2025-04-06 - 2.0.11 - fix(dependencies)
Update dependency names and versions in CI workflows and package configuration
- Rename devDependency packages from '@gitzone/*' to '@git.zone/*' for consistency
- Bump '@types/node' from '^20.4.8' to '^22.14.0'
- Upgrade 'mongodb-memory-server' from '^8.14.0' to '^10.1.4'
- Add 'packageManager' field in package.json
- Introduce pnpm-workspace.yaml with 'onlyBuiltDependencies' configuration
## 2024-05-29 - 2.0.10 - misc
Various updates to project configuration and documentation.
- update description
- update tsconfig
- update npmextra.json: githost (applied on three occasions)
## 2023-08-08 - 2.0.9 - core
Core fix.
- fix(core): update
## 2023-08-08 - 2.0.8 - core
Core fix.
- fix(core): update
## 2023-08-08 - 2.0.7 - core & org
Combined changes for core stability and organization improvements.
- fix(core): update
- switch to new org scheme (recorded twice)
## 2022-06-08 - 2.0.6 - core
Core fix.
- fix(core): update
## 2022-06-08 - 2.0.5 - core
Core fix.
- fix(core): update
## 2022-06-06 - 2.0.4 - core
Core fix.
- fix(core): update
## 2022-06-06 - 2.0.3 - core
Core fix.
- fix(core): update
## 2022-06-03 - 2.0.2 - core
Core fix.
- fix(core): update
## 2022-05-19 - 2.0.1 - core
Core fix.
- fix(core): update
## 2022-05-18 - 2.0.0 - core
Core fix.
- fix(core): update
## 2022-05-17 - 1.0.9 - core
Breaking change for module format.
- BREAKING CHANGE(core): switch to esm
## 2022-05-17 - 1.0.8 - core
Core fix.
- fix(core): update
## 2021-12-21 - 1.0.7 - core
Core fix.
- fix(core): update
## 2021-12-20 - 1.0.6 - core
Core fix.
- fix(core): update
## 2021-12-20 - 1.0.5 - core
Core fix.
- fix(core): update
## 2021-12-20 - 1.0.4 - core
Core fix.
- fix(core): update
## 2021-12-20 - 1.0.3 - core
Core fix.
- fix(core): update
## 2021-12-20 - 1.0.2 - no notable changes
These version bumps did not include additional modifications.
- version update only
## 2021-12-20 - 1.0.1 - core
Core fix.
- fix(core): update

View File

@ -2,29 +2,17 @@
"gitzone": { "gitzone": {
"projectType": "npm", "projectType": "npm",
"module": { "module": {
"githost": "code.foss.global", "githost": "gitlab.com",
"gitscope": "push.rocks", "gitscope": "push.rocks",
"gitrepo": "smartmongo", "gitrepo": "smartmongo",
"description": "A module for creating and managing a local MongoDB instance for testing purposes.", "description": "create a local mongodb for testing",
"npmPackagename": "@push.rocks/smartmongo", "npmPackagename": "@push.rocks/smartmongo",
"license": "MIT", "license": "MIT",
"projectDomain": "push.rocks", "projectDomain": "push.rocks"
"keywords": [
"mongodb",
"testing",
"local database",
"replica set",
"memory server",
"database management",
"typescript"
]
} }
}, },
"npmci": { "npmci": {
"npmGlobalTools": [], "npmGlobalTools": [],
"npmAccessLevel": "public" "npmAccessLevel": "public"
},
"tsdoc": {
"legal": "\n## License and Legal Information\n\nThis repository contains open-source code that is licensed under the MIT License. A copy of the MIT License can be found in the [license](license) file within this repository. \n\n**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.\n\n### Trademarks\n\nThis project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH and are not included within the scope of the MIT license granted herein. Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines, and any usage must be approved in writing by Task Venture Capital GmbH.\n\n### Company Information\n\nTask Venture Capital GmbH \nRegistered at District court Bremen HRB 35230 HB, Germany\n\nFor any legal inquiries or if you require further information, please contact us via email at hello@task.vc.\n\nBy using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.\n"
} }
} }

View File

@ -1,8 +1,8 @@
{ {
"name": "@push.rocks/smartmongo", "name": "@push.rocks/smartmongo",
"version": "2.0.12", "version": "2.0.10",
"private": false, "private": false,
"description": "A module for creating and managing a local MongoDB instance for testing purposes.", "description": "create a local mongodb for testing",
"main": "dist_ts/index.js", "main": "dist_ts/index.js",
"typings": "dist_ts/index.d.ts", "typings": "dist_ts/index.d.ts",
"type": "module", "type": "module",
@ -14,19 +14,19 @@
"buildDocs": "tsdoc" "buildDocs": "tsdoc"
}, },
"devDependencies": { "devDependencies": {
"@git.zone/tsbuild": "^2.1.66", "@gitzone/tsbuild": "^2.1.66",
"@git.zone/tsbundle": "^2.0.8", "@gitzone/tsbundle": "^2.0.8",
"@git.zone/tsrun": "^1.2.44", "@gitzone/tsrun": "^1.2.44",
"@git.zone/tstest": "^1.0.77", "@gitzone/tstest": "^1.0.77",
"@push.rocks/tapbundle": "^5.0.12", "@push.rocks/tapbundle": "^5.0.12",
"@types/node": "^22.14.0" "@types/node": "^20.4.8"
}, },
"dependencies": { "dependencies": {
"@push.rocks/mongodump": "^1.0.7", "@push.rocks/mongodump": "^1.0.7",
"@push.rocks/smartdata": "^5.0.23", "@push.rocks/smartdata": "^5.0.23",
"@push.rocks/smartpath": "^5.0.11", "@push.rocks/smartpath": "^5.0.11",
"@push.rocks/smartpromise": "^4.0.3", "@push.rocks/smartpromise": "^4.0.3",
"mongodb-memory-server": "^10.1.4" "mongodb-memory-server": "^8.14.0"
}, },
"browserslist": [ "browserslist": [
"last 1 chrome versions" "last 1 chrome versions"
@ -42,26 +42,5 @@
"cli.js", "cli.js",
"npmextra.json", "npmextra.json",
"readme.md" "readme.md"
], ]
"keywords": [
"mongodb",
"testing",
"local database",
"replica set",
"memory server",
"database management",
"typescript"
],
"homepage": "https://code.foss.global/push.rocks/smartmongo#readme",
"repository": {
"type": "git",
"url": "https://code.foss.global/push.rocks/smartmongo.git"
},
"packageManager": "pnpm@10.7.0+sha512.6b865ad4b62a1d9842b61d674a393903b871d9244954f652b8842c2b553c72176b278f64c463e52d40fff8aba385c235c8c9ecf5cc7de4fd78b8bb6d49633ab6",
"bugs": {
"url": "https://code.foss.global/push.rocks/smartmongo/issues"
},
"pnpm": {
"overrides": {}
}
} }

13142
pnpm-lock.yaml generated

File diff suppressed because it is too large Load Diff

View File

@ -1,4 +0,0 @@
onlyBuiltDependencies:
- esbuild
- mongodb-memory-server
- puppeteer

View File

@ -1 +0,0 @@

117
readme.md
View File

@ -1,104 +1,37 @@
# @push.rocks/smartmongo # @push.rocks/smartmongo
create a local mongodb for testing create a local mongodb for testing
## Install ## Availabililty and Links
* [npmjs.org (npm package)](https://www.npmjs.com/package/@push.rocks/smartmongo)
* [gitlab.com (source)](https://gitlab.com/push.rocks/smartmongo)
* [github.com (source mirror)](https://github.com/push.rocks/smartmongo)
* [docs (typedoc)](https://push.rocks.gitlab.io/smartmongo/)
To start using @push.rocks/smartmongo in your project, you first need to install it via npm. You can do this by running the following command in your terminal: ## Status for master
```bash Status Category | Status Badge
npm install @push.rocks/smartmongo --save-dev -- | --
``` GitLab Pipelines | [![pipeline status](https://gitlab.com/push.rocks/smartmongo/badges/master/pipeline.svg)](https://lossless.cloud)
GitLab Pipline Test Coverage | [![coverage report](https://gitlab.com/push.rocks/smartmongo/badges/master/coverage.svg)](https://lossless.cloud)
This will add `@push.rocks/smartmongo` as a development dependency to your project because it's typically used for testing purposes. npm | [![npm downloads per month](https://badgen.net/npm/dy/@push.rocks/smartmongo)](https://lossless.cloud)
Snyk | [![Known Vulnerabilities](https://badgen.net/snyk/push.rocks/smartmongo)](https://lossless.cloud)
TypeScript Support | [![TypeScript](https://badgen.net/badge/TypeScript/>=%203.x/blue?icon=typescript)](https://lossless.cloud)
node Support | [![node](https://img.shields.io/badge/node->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
Code Style | [![Code Style](https://badgen.net/badge/style/prettier/purple)](https://lossless.cloud)
PackagePhobia (total standalone install weight) | [![PackagePhobia](https://badgen.net/packagephobia/install/@push.rocks/smartmongo)](https://lossless.cloud)
PackagePhobia (package size on registry) | [![PackagePhobia](https://badgen.net/packagephobia/publish/@push.rocks/smartmongo)](https://lossless.cloud)
BundlePhobia (total size when bundled) | [![BundlePhobia](https://badgen.net/bundlephobia/minzip/@push.rocks/smartmongo)](https://lossless.cloud)
## Usage ## Usage
The `@push.rocks/smartmongo` package provides a convenient way to spin up a local MongoDB instance, primarily for testing purposes. It's designed to simplify the process of configuring and managing a MongoDB replica set during development or in CI/CD pipelines. Below, we present a comprehensive guide on how to utilize the full feature set of this module, employing ESM syntax and TypeScript. Use TypeScript for best in class intellisense
### Setting Up ## Contribution
To get started, you must first import the `SmartMongo` class from the package. This class is responsible for handling the MongoDB instances. We are always happy for code contributions. If you are not the code contributing type that is ok. Still, maintaining Open Source repositories takes considerable time and thought. If you like the quality of what we do and our modules are useful to you we would appreciate a little monthly contribution: You can [contribute one time](https://lossless.link/contribute-onetime) or [contribute monthly](https://lossless.link/contribute). :)
```typescript For further information read the linked docs at the top of this readme.
import { SmartMongo } from '@push.rocks/smartmongo';
```
### Creating and Starting a MongoDB Instance ## Legal
> MIT licensed | **©** [Task Venture Capital GmbH](https://task.vc)
With `SmartMongo`, you can easily create and start a MongoDB replica set. You can specify the number of replica instances; however, if not specified, it defaults to 1. | By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)
```typescript
async function setupMongoDB() {
const smartMongoInstance = await SmartMongo.createAndStart(1); // Number of replicas is optional
return smartMongoInstance;
}
const myDbInstance = await setupMongoDB();
```
After invoking `createAndStart`, an instance of MongoDB is spun up and is ready for use. The `createAndStart` function returns a `SmartMongo` instance which can be interacted with for further operations.
### Accessing MongoDB Connection Information
After instantiation, you might want to connect your application or test suite to the MongoDB instance. The `getMongoDescriptor` method facilitates this by providing essential connection details.
```typescript
const mongoDescriptor = await myDbInstance.getMongoDescriptor();
console.log(mongoDescriptor.mongoDbUrl); // Use this URL to connect with Mongoose or MongoDB clients.
```
### Stopping and Cleaning Up
Once your tests have completed or you're done using the MongoDB instance, its crucial to properly stop and clean up the resources. `@push.rocks/smartmongo` provides two methods for this purpose:
1. **stop()**: Stops the MongoDB instance without persisting any data.
```typescript
await myDbInstance.stop();
```
2. **stopAndDumpToDir(dirPath)**: Stops the MongoDB instance and persists the data to the specified directory. This is useful if you need to examine the data post-test or reuse it in subsequent runs.
```typescript
await myDbInstance.stopAndDumpToDir('./path/to/dump');
```
### Advanced Usage
`@push.rocks/smartmongo` also provides advanced features for dumping the database and configuring MongoDB replica sets. These features can be particularly useful for complex testing scenarios or when specific MongoDB behaviors need to be emulated.
#### Dumping Data
To dump the MongoDB data for inspection or backup purposes, use the `stopAndDumpToDir` method. This method optionally takes a function to customize the naming scheme of the dumped files based on the document content.
```typescript
await myDbInstance.stopAndDumpToDir('./path/to/dump', (doc) => {
return `customNameBasedOnDoc-${doc._id}.bson`;
});
```
Using `@push.rocks/smartmongo` significantly simplifies the process of managing MongoDB instances for local testing environments. It abstracts away the complexity of starting, operating, and tearing down MongoDB replica sets, allowing developers to focus on building and testing their applications.
### Conclusion
`@push.rocks/smartmongo` serves as a powerful tool in a developer's arsenal for efficiently configuring, running, and managing MongoDB instances in testing scenarios. By following the above guide, developers can leverage MongoDB in their projects with minimal setup and gain valuable insights into their applications' data interactions in a controlled and reproducible environment.
## License and Legal Information
This repository contains open-source code that is licensed under the MIT License. A copy of the MIT License can be found in the [license](license) file within this repository.
**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.
### Trademarks
This project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH and are not included within the scope of the MIT license granted herein. Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines, and any usage must be approved in writing by Task Venture Capital GmbH.
### Company Information
Task Venture Capital GmbH
Registered at District court Bremen HRB 35230 HB, Germany
For any legal inquiries or if you require further information, please contact us via email at hello@task.vc.
By using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.

View File

@ -1,8 +1,8 @@
/** /**
* autocreated commitinfo by @push.rocks/commitinfo * autocreated commitinfo by @pushrocks/commitinfo
*/ */
export const commitinfo = { export const commitinfo = {
name: '@push.rocks/smartmongo', name: '@push.rocks/smartmongo',
version: '2.0.12', version: '2.0.10',
description: 'A module for creating and managing a local MongoDB instance for testing purposes.' description: 'create a local mongodb for testing'
} }

View File

@ -58,11 +58,11 @@ export class SmartMongo {
public async stopAndDumpToDir( public async stopAndDumpToDir(
dirArg: string, dirArg: string,
nameFunctionArg?: (doc: any) => string, nameFunctionArg?: (doc: any) => string,
emptyDirArg = true, emptyDirArg = true
) { ) {
const mongodumpInstance = new plugins.mongodump.MongoDump(); const mongodumpInstance = new plugins.mongodump.MongoDump();
const mongodumpTarget = await mongodumpInstance.addMongoTargetByMongoDescriptor( const mongodumpTarget = await mongodumpInstance.addMongoTargetByMongoDescriptor(
await this.getMongoDescriptor(), await this.getMongoDescriptor()
); );
await mongodumpTarget.dumpAllCollectionsToDir(dirArg, nameFunctionArg, emptyDirArg); await mongodumpTarget.dumpAllCollectionsToDir(dirArg, nameFunctionArg, emptyDirArg);
await mongodumpInstance.stop(); await mongodumpInstance.stop();

View File

@ -3,14 +3,7 @@
"experimentalDecorators": true, "experimentalDecorators": true,
"useDefineForClassFields": false, "useDefineForClassFields": false,
"target": "ES2022", "target": "ES2022",
"module": "NodeNext", "module": "ES2022",
"moduleResolution": "NodeNext", "moduleResolution": "nodenext"
"esModuleInterop": true, }
"verbatimModuleSyntax": true,
"baseUrl": ".",
"paths": {}
},
"exclude": [
"dist_*/**/*.d.ts"
]
} }