@maloma/listmonk 1.0.0 → 1.0.1

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.
Files changed (107) hide show
  1. package/README.md +14 -8
  2. package/dist/index.d.ts +5917 -63
  3. package/dist/index.js +765 -14271
  4. package/dist/testing/index.d.ts +900 -38
  5. package/dist/testing/index.js +1 -5
  6. package/package.json +38 -59
  7. package/dist/chunk-saezhne8.js +0 -14
  8. package/dist/chunk-saezhne8.js.map +0 -9
  9. package/dist/client.d.ts +0 -430
  10. package/dist/errors/api.d.ts +0 -178
  11. package/dist/errors/base.d.ts +0 -47
  12. package/dist/errors/configuration.d.ts +0 -49
  13. package/dist/errors/index.d.ts +0 -13
  14. package/dist/errors/network.d.ts +0 -69
  15. package/dist/errors/validation.d.ts +0 -57
  16. package/dist/http/auth.d.ts +0 -39
  17. package/dist/http/client.d.ts +0 -149
  18. package/dist/http/hooks.d.ts +0 -90
  19. package/dist/http/index.d.ts +0 -10
  20. package/dist/http/resource.d.ts +0 -100
  21. package/dist/http/sse.d.ts +0 -36
  22. package/dist/http/url.d.ts +0 -51
  23. package/dist/index.js.map +0 -120
  24. package/dist/resources/admin/admin.d.ts +0 -92
  25. package/dist/resources/admin/index.d.ts +0 -10
  26. package/dist/resources/admin/schemas.d.ts +0 -23
  27. package/dist/resources/admin/types.d.ts +0 -29
  28. package/dist/resources/bounces/bounces.d.ts +0 -262
  29. package/dist/resources/bounces/index.d.ts +0 -10
  30. package/dist/resources/bounces/schemas.d.ts +0 -86
  31. package/dist/resources/bounces/types.d.ts +0 -37
  32. package/dist/resources/campaigns/campaigns.d.ts +0 -339
  33. package/dist/resources/campaigns/index.d.ts +0 -10
  34. package/dist/resources/campaigns/schemas.d.ts +0 -374
  35. package/dist/resources/campaigns/types.d.ts +0 -111
  36. package/dist/resources/dashboard/dashboard.d.ts +0 -73
  37. package/dist/resources/dashboard/index.d.ts +0 -10
  38. package/dist/resources/dashboard/schemas.d.ts +0 -55
  39. package/dist/resources/dashboard/types.d.ts +0 -22
  40. package/dist/resources/import/import.d.ts +0 -215
  41. package/dist/resources/import/index.d.ts +0 -10
  42. package/dist/resources/import/schemas.d.ts +0 -109
  43. package/dist/resources/import/types.d.ts +0 -72
  44. package/dist/resources/lists/index.d.ts +0 -10
  45. package/dist/resources/lists/lists.d.ts +0 -180
  46. package/dist/resources/lists/schemas.d.ts +0 -176
  47. package/dist/resources/lists/types.d.ts +0 -56
  48. package/dist/resources/maintenance/index.d.ts +0 -10
  49. package/dist/resources/maintenance/maintenance.d.ts +0 -92
  50. package/dist/resources/maintenance/schemas.d.ts +0 -36
  51. package/dist/resources/maintenance/types.d.ts +0 -31
  52. package/dist/resources/media/index.d.ts +0 -10
  53. package/dist/resources/media/media.d.ts +0 -198
  54. package/dist/resources/media/schemas.d.ts +0 -48
  55. package/dist/resources/media/types.d.ts +0 -48
  56. package/dist/resources/public/index.d.ts +0 -10
  57. package/dist/resources/public/public.d.ts +0 -111
  58. package/dist/resources/public/schemas.d.ts +0 -52
  59. package/dist/resources/public/types.d.ts +0 -30
  60. package/dist/resources/settings/index.d.ts +0 -10
  61. package/dist/resources/settings/schemas.d.ts +0 -374
  62. package/dist/resources/settings/settings.d.ts +0 -106
  63. package/dist/resources/settings/types.d.ts +0 -78
  64. package/dist/resources/subscribers/index.d.ts +0 -10
  65. package/dist/resources/subscribers/schemas.d.ts +0 -360
  66. package/dist/resources/subscribers/subscribers.d.ts +0 -308
  67. package/dist/resources/subscribers/types.d.ts +0 -113
  68. package/dist/resources/templates/index.d.ts +0 -10
  69. package/dist/resources/templates/schemas.d.ts +0 -110
  70. package/dist/resources/templates/templates.d.ts +0 -225
  71. package/dist/resources/templates/types.d.ts +0 -45
  72. package/dist/resources/tx/index.d.ts +0 -10
  73. package/dist/resources/tx/schemas.d.ts +0 -67
  74. package/dist/resources/tx/tx.d.ts +0 -167
  75. package/dist/resources/tx/types.d.ts +0 -88
  76. package/dist/schemas/common.d.ts +0 -48
  77. package/dist/schemas/index.d.ts +0 -6
  78. package/dist/testing/errors.d.ts +0 -25
  79. package/dist/testing/factories/bounce.d.ts +0 -43
  80. package/dist/testing/factories/campaign.d.ts +0 -43
  81. package/dist/testing/factories/common.d.ts +0 -54
  82. package/dist/testing/factories/index.d.ts +0 -12
  83. package/dist/testing/factories/list.d.ts +0 -43
  84. package/dist/testing/factories/media.d.ts +0 -40
  85. package/dist/testing/factories/subscriber.d.ts +0 -43
  86. package/dist/testing/factories/template.d.ts +0 -40
  87. package/dist/testing/index.js.map +0 -32
  88. package/dist/testing/mock-client.d.ts +0 -119
  89. package/dist/testing/mock-function.d.ts +0 -28
  90. package/dist/testing/resources/admin.d.ts +0 -20
  91. package/dist/testing/resources/bounces.d.ts +0 -22
  92. package/dist/testing/resources/campaigns.d.ts +0 -31
  93. package/dist/testing/resources/dashboard.d.ts +0 -17
  94. package/dist/testing/resources/import.d.ts +0 -19
  95. package/dist/testing/resources/index.d.ts +0 -18
  96. package/dist/testing/resources/lists.d.ts +0 -24
  97. package/dist/testing/resources/maintenance.d.ts +0 -18
  98. package/dist/testing/resources/media.d.ts +0 -21
  99. package/dist/testing/resources/public.d.ts +0 -18
  100. package/dist/testing/resources/settings.d.ts +0 -19
  101. package/dist/testing/resources/subscribers.d.ts +0 -33
  102. package/dist/testing/resources/templates.d.ts +0 -24
  103. package/dist/testing/resources/tx.d.ts +0 -16
  104. package/dist/testing/types.d.ts +0 -138
  105. package/dist/types/config.d.ts +0 -59
  106. package/dist/types/index.d.ts +0 -7
  107. package/dist/types/pagination.d.ts +0 -37
package/README.md CHANGED
@@ -1,10 +1,12 @@
1
1
  # @maloma/listmonk
2
2
 
3
- [![npm version](https://img.shields.io/npm/v/@maloma/listmonk)](https://www.npmjs.com/package/@maloma/listmonk)
4
- [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)
5
- [![TypeScript](https://img.shields.io/badge/TypeScript-5.7+-blue)](https://www.typescriptlang.org/)
3
+ [![npm version](https://img.shields.io/npm/v/@maloma/listmonk?color=007ec6)](https://www.npmjs.com/package/@maloma/listmonk)
4
+ [![npm downloads](https://img.shields.io/npm/dm/@maloma/listmonk?color=007ec6)](https://www.npmjs.com/package/@maloma/listmonk)
5
+ [![License: MIT](https://img.shields.io/badge/License-MIT-007ec6)](LICENSE)
6
+ [![TypeScript](https://img.shields.io/badge/TypeScript-5.9+-007ec6)](https://www.typescriptlang.org/)
7
+ [![Built with Claude](https://img.shields.io/badge/Built_with-Claude-007ec6?style=flat&logo=claude&logoColor=007ec6)](https://anthropic.com/claude-code)
6
8
 
7
- Production-grade TypeScript SDK for the [listmonk](https://listmonk.app/) email marketing platform API.
9
+ TypeScript SDK for the [listmonk](https://listmonk.app/) email marketing platform API.
8
10
 
9
11
  ## Table of Contents
10
12
 
@@ -20,6 +22,7 @@ Production-grade TypeScript SDK for the [listmonk](https://listmonk.app/) email
20
22
  - [Pagination](#pagination)
21
23
  - [TypeScript](#typescript)
22
24
  - [Testing](#testing)
25
+ - [Security](#security)
23
26
  - [Contributing](#contributing)
24
27
  - [License](#license)
25
28
 
@@ -37,7 +40,7 @@ Production-grade TypeScript SDK for the [listmonk](https://listmonk.app/) email
37
40
  ## Requirements
38
41
 
39
42
  - **Node.js** 22+ or **Bun** 1.3+
40
- - **TypeScript** 5.7+ (optional, but recommended)
43
+ - **TypeScript** 5.9+ (optional, but recommended)
41
44
 
42
45
  ## Installation
43
46
 
@@ -381,8 +384,7 @@ const CustomSubscriberSchema = SubscriberSchema.extend({
381
384
 
382
385
  The SDK provides test utilities for unit testing applications without real API calls:
383
386
 
384
- ```bash
385
- # The testing module is included in the main package
387
+ ```typescript
386
388
  import { MockListmonkClient } from '@maloma/listmonk/testing';
387
389
  ```
388
390
 
@@ -513,6 +515,10 @@ const client = new Listmonk({
513
515
  });
514
516
  ```
515
517
 
518
+ ## Security
519
+
520
+ For security practices, vulnerability reporting, and supply chain verification (checksums, signatures, SBOM), see [SECURITY.md](SECURITY.md).
521
+
516
522
  ## Contributing
517
523
 
518
524
  Contributions are welcome! Please read our [Contributing Guide](CONTRIBUTING.md) for details on our code of conduct and the process for submitting pull requests.
@@ -530,7 +536,7 @@ bun test
530
536
  bun run typecheck
531
537
 
532
538
  # Lint
533
- bun run check
539
+ bun run lint
534
540
  ```
535
541
 
536
542
  ## License