feat(mongodb-helpers): add key deletion

Signed-off-by: Álvaro Orduna León <[email protected]>

Author: alorle

packages/leemons-mongodb-helpers/src/index.js

@@ -1,10 +1,11 @@
-const { mongoDBPaginate, EMPTY_PAGINATED_RESULT } = require('./mongoDBPaginate');
-const mongoDBPaginateAggregationPipeline = require('./mongoDBPaginateAggregationPipeline');
-const { getKeyValueModel } = require('./key-value/getKeyValueModel');
+const { deleteKey } = require('./key-value/deleteKey');
 const { getKey } = require('./key-value/getKey');
+const { getKeyValueModel } = require('./key-value/getKeyValueModel');
 const { hasKey } = require('./key-value/hasKey');
-const { setKey } = require('./key-value/setKey');
 const { hasKeys } = require('./key-value/hasKeys');
+const { setKey } = require('./key-value/setKey');
+const { mongoDBPaginate, EMPTY_PAGINATED_RESULT } = require('./mongoDBPaginate');
+const mongoDBPaginateAggregationPipeline = require('./mongoDBPaginateAggregationPipeline');
 
 module.exports = {
   mongoDBPaginate,
@@ -15,4 +16,5 @@ module.exports = {
   hasKey,
   setKey,
   hasKeys,
+  deleteKey,
 };

packages/leemons-mongodb-helpers/src/key-value/deleteKey.js

@@ -0,0 +1,17 @@
+/**
+ * @typedef {import('mongoose').Model} Model
+ * @typedef {import('mongoose').DeleteResult} DeleteResult
+ *
+ * Deletes a key from the key-value store.
+ *
+ * @param {Model} model - The model to delete the key from.
+ * @param {string} key - The key to delete.
+ * @returns {Promise<DeleteResult>} A promise that resolves to the result of the delete operation.
+ */
+function deleteKey(model, key) {
+  return model.deleteOne({ key });
+}
+
+module.exports = {
+  deleteKey,
+};

packages/leemons-mongodb-helpers/src/types.d.ts

@@ -34,6 +34,7 @@ export type SetKeyQueryResult = {
 export function getKey<T>(model: Model<T>, key: string): Promise<GetKeyQueryResult<T>>;
 export function hasKey(model: Model<unknown>, key: string): Promise<boolean>;
 export function setKey<T>(model: Model<T>, key: string, value?: T): Promise<SetKeyQueryResult>;
+export function deleteKey<T>(model: Model<T>, key: string): Promise<DeleteResult>;
 
 export type GetKeyValueModel = {
   id: string;

packages/leemons-mongodb-helpers/types/index.d.ts

@@ -1,6 +1,6 @@
 /* eslint-disable @typescript-eslint/no-explicit-any */
 import { Model, PaginatedQueryResult } from '@leemons/mongodb';
-import { FilterQuery, SortOrder } from 'mongoose';
+import { FilterQuery, SortOrder, DeleteResult } from 'mongoose';
 
 type Params<M extends Model<any> = Model<any>, R = object> = {
   model: M;
@@ -44,6 +44,7 @@ export type SetKeyQueryResult = {
 export function getKey<T>(model: Model<T>, key: string): Promise<GetKeyQueryResult<T>>;
 export function hasKey(model: Model<unknown>, key: string): Promise<boolean>;
 export function setKey<T>(model: Model<T>, key: string, value?: T): Promise<SetKeyQueryResult>;
+export function deleteKey<T>(model: Model<T>, key: string): Promise<DeleteResult>;
 
 export type GetKeyValueModel = {
   id: string;