@dismissible/nestjs-storage 0.0.2-canary.c91edbc.0 → 0.0.2-canary.d2f56d7.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +9 -11
- package/jest.config.ts +17 -0
- package/package.json +3 -3
- package/src/memory-storage.adapter.ts +6 -8
- package/src/storage.interface.ts +5 -5
package/README.md
CHANGED
|
@@ -49,28 +49,26 @@ You can implement your own storage adapter by implementing the `IDismissibleStor
|
|
|
49
49
|
```typescript
|
|
50
50
|
import { Injectable } from '@nestjs/common';
|
|
51
51
|
import { IDismissibleStorage, DISMISSIBLE_STORAGE_ADAPTER } from '@dismissible/nestjs-storage';
|
|
52
|
-
import { DismissibleItemDto
|
|
52
|
+
import { DismissibleItemDto } from '@dismissible/nestjs-dismissible-item';
|
|
53
53
|
import { DISMISSIBLE_LOGGER, IDismissibleLogger } from '@dismissible/nestjs-logger';
|
|
54
54
|
|
|
55
55
|
@Injectable()
|
|
56
|
-
export class MyCustomStorageAdapter
|
|
57
|
-
TMetadata extends BaseMetadata,
|
|
58
|
-
> implements IDismissibleStorage<TMetadata> {
|
|
56
|
+
export class MyCustomStorageAdapter implements IDismissibleStorage {
|
|
59
57
|
constructor(@Inject(DISMISSIBLE_LOGGER) private readonly logger: IDismissibleLogger) {}
|
|
60
58
|
|
|
61
|
-
async get(userId: string, itemId: string): Promise<DismissibleItemDto
|
|
59
|
+
async get(userId: string, itemId: string): Promise<DismissibleItemDto | null> {
|
|
62
60
|
// Your implementation
|
|
63
61
|
this.logger.debug('Getting item', { userId, itemId });
|
|
64
62
|
// ...
|
|
65
63
|
}
|
|
66
64
|
|
|
67
|
-
async create(item: DismissibleItemDto
|
|
65
|
+
async create(item: DismissibleItemDto): Promise<DismissibleItemDto> {
|
|
68
66
|
// Your implementation
|
|
69
67
|
this.logger.debug('Creating item', { itemId: item.id });
|
|
70
68
|
// ...
|
|
71
69
|
}
|
|
72
70
|
|
|
73
|
-
async update(item: DismissibleItemDto
|
|
71
|
+
async update(item: DismissibleItemDto): Promise<DismissibleItemDto> {
|
|
74
72
|
// Your implementation
|
|
75
73
|
this.logger.debug('Updating item', { itemId: item.id });
|
|
76
74
|
// ...
|
|
@@ -96,10 +94,10 @@ export class MyStorageModule {}
|
|
|
96
94
|
### IDismissibleStorage Interface
|
|
97
95
|
|
|
98
96
|
```typescript
|
|
99
|
-
interface IDismissibleStorage
|
|
100
|
-
get(userId: string, itemId: string): Promise<DismissibleItemDto
|
|
101
|
-
create(item: DismissibleItemDto
|
|
102
|
-
update(item: DismissibleItemDto
|
|
97
|
+
interface IDismissibleStorage {
|
|
98
|
+
get(userId: string, itemId: string): Promise<DismissibleItemDto | null>;
|
|
99
|
+
create(item: DismissibleItemDto): Promise<DismissibleItemDto>;
|
|
100
|
+
update(item: DismissibleItemDto): Promise<DismissibleItemDto>;
|
|
103
101
|
}
|
|
104
102
|
```
|
|
105
103
|
|
package/jest.config.ts
CHANGED
|
@@ -7,4 +7,21 @@ export default {
|
|
|
7
7
|
},
|
|
8
8
|
moduleFileExtensions: ['ts', 'js', 'html'],
|
|
9
9
|
coverageDirectory: '../../coverage/libs/storage',
|
|
10
|
+
collectCoverageFrom: [
|
|
11
|
+
'src/**/*.ts',
|
|
12
|
+
'!src/**/*.spec.ts',
|
|
13
|
+
'!src/**/*.interface.ts',
|
|
14
|
+
'!src/**/*.dto.ts',
|
|
15
|
+
'!src/**/*.enum.ts',
|
|
16
|
+
'!src/**/index.ts',
|
|
17
|
+
'!src/**/*.module.ts',
|
|
18
|
+
],
|
|
19
|
+
coverageThreshold: {
|
|
20
|
+
global: {
|
|
21
|
+
branches: 80,
|
|
22
|
+
functions: 80,
|
|
23
|
+
lines: 80,
|
|
24
|
+
statements: 80,
|
|
25
|
+
},
|
|
26
|
+
},
|
|
10
27
|
};
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@dismissible/nestjs-storage",
|
|
3
|
-
"version": "0.0.2-canary.
|
|
3
|
+
"version": "0.0.2-canary.d2f56d7.0",
|
|
4
4
|
"description": "In-memory storage adapter for Dismissible",
|
|
5
5
|
"main": "./src/index.js",
|
|
6
6
|
"types": "./src/index.d.ts",
|
|
@@ -13,8 +13,8 @@
|
|
|
13
13
|
},
|
|
14
14
|
"peerDependencies": {
|
|
15
15
|
"@nestjs/common": "^11.0.0",
|
|
16
|
-
"@dismissible/nestjs-logger": "^0.0.2-canary.
|
|
17
|
-
"@dismissible/nestjs-dismissible-item": "^0.0.2-canary.
|
|
16
|
+
"@dismissible/nestjs-logger": "^0.0.2-canary.d2f56d7.0",
|
|
17
|
+
"@dismissible/nestjs-dismissible-item": "^0.0.2-canary.d2f56d7.0"
|
|
18
18
|
},
|
|
19
19
|
"peerDependenciesMeta": {
|
|
20
20
|
"@nestjs/common": {
|
|
@@ -1,17 +1,15 @@
|
|
|
1
1
|
import { Injectable, Inject } from '@nestjs/common';
|
|
2
2
|
import { DISMISSIBLE_LOGGER, IDismissibleLogger } from '@dismissible/nestjs-logger';
|
|
3
3
|
import { IDismissibleStorage } from './storage.interface';
|
|
4
|
-
import {
|
|
4
|
+
import { DismissibleItemDto } from '@dismissible/nestjs-dismissible-item';
|
|
5
5
|
|
|
6
6
|
/**
|
|
7
7
|
* In-memory storage provider for dismissible items.
|
|
8
8
|
* Suitable for development and testing; not for production use.
|
|
9
9
|
*/
|
|
10
10
|
@Injectable()
|
|
11
|
-
export class MemoryStorageAdapter
|
|
12
|
-
|
|
13
|
-
> implements IDismissibleStorage<TMetadata> {
|
|
14
|
-
private readonly storage = new Map<string, DismissibleItemDto<TMetadata>>();
|
|
11
|
+
export class MemoryStorageAdapter implements IDismissibleStorage {
|
|
12
|
+
private readonly storage = new Map<string, DismissibleItemDto>();
|
|
15
13
|
|
|
16
14
|
constructor(@Inject(DISMISSIBLE_LOGGER) private readonly logger: IDismissibleLogger) {}
|
|
17
15
|
|
|
@@ -22,7 +20,7 @@ export class MemoryStorageAdapter<
|
|
|
22
20
|
return `${userId}:${itemId}`;
|
|
23
21
|
}
|
|
24
22
|
|
|
25
|
-
async get(userId: string, itemId: string): Promise<DismissibleItemDto
|
|
23
|
+
async get(userId: string, itemId: string): Promise<DismissibleItemDto | null> {
|
|
26
24
|
const key = this.createKey(userId, itemId);
|
|
27
25
|
this.logger.debug(`Storage get`, { userId, itemId, key });
|
|
28
26
|
|
|
@@ -37,14 +35,14 @@ export class MemoryStorageAdapter<
|
|
|
37
35
|
return item;
|
|
38
36
|
}
|
|
39
37
|
|
|
40
|
-
async create(item: DismissibleItemDto
|
|
38
|
+
async create(item: DismissibleItemDto): Promise<DismissibleItemDto> {
|
|
41
39
|
const key = this.createKey(item.userId, item.id);
|
|
42
40
|
this.logger.debug(`Storage create`, { userId: item.userId, itemId: item.id, key });
|
|
43
41
|
this.storage.set(key, item);
|
|
44
42
|
return item;
|
|
45
43
|
}
|
|
46
44
|
|
|
47
|
-
async update(item: DismissibleItemDto
|
|
45
|
+
async update(item: DismissibleItemDto): Promise<DismissibleItemDto> {
|
|
48
46
|
const key = this.createKey(item.userId, item.id);
|
|
49
47
|
this.logger.debug(`Storage update`, { userId: item.userId, itemId: item.id, key });
|
|
50
48
|
this.storage.set(key, item);
|
package/src/storage.interface.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { DismissibleItemDto } from '@dismissible/nestjs-dismissible-item';
|
|
2
2
|
|
|
3
3
|
/**
|
|
4
4
|
* Injection token for the storage provider.
|
|
@@ -9,26 +9,26 @@ export const DISMISSIBLE_STORAGE_ADAPTER = Symbol('DISMISSIBLE_STORAGE_ADAPTER')
|
|
|
9
9
|
* Interface for storage providers.
|
|
10
10
|
* Implementations handle the persistence of dismissible items.
|
|
11
11
|
*/
|
|
12
|
-
export interface IDismissibleStorage
|
|
12
|
+
export interface IDismissibleStorage {
|
|
13
13
|
/**
|
|
14
14
|
* Retrieve an item by user ID and item ID.
|
|
15
15
|
* @param userId The user identifier
|
|
16
16
|
* @param itemId The item identifier
|
|
17
17
|
* @returns The item or null if not found
|
|
18
18
|
*/
|
|
19
|
-
get(userId: string, itemId: string): Promise<DismissibleItemDto
|
|
19
|
+
get(userId: string, itemId: string): Promise<DismissibleItemDto | null>;
|
|
20
20
|
|
|
21
21
|
/**
|
|
22
22
|
* Create a new item.
|
|
23
23
|
* @param item The item to create (contains userId and id)
|
|
24
24
|
* @returns The created item
|
|
25
25
|
*/
|
|
26
|
-
create(item: DismissibleItemDto
|
|
26
|
+
create(item: DismissibleItemDto): Promise<DismissibleItemDto>;
|
|
27
27
|
|
|
28
28
|
/**
|
|
29
29
|
* Update an existing item.
|
|
30
30
|
* @param item The item to update (contains userId and id)
|
|
31
31
|
* @returns The updated item
|
|
32
32
|
*/
|
|
33
|
-
update(item: DismissibleItemDto
|
|
33
|
+
update(item: DismissibleItemDto): Promise<DismissibleItemDto>;
|
|
34
34
|
}
|