@shoperzz/common 0.0.1 → 0.0.2
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/CHANGELOG.md +7 -0
- package/README.md +27 -8
- package/package.json +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,12 @@
|
|
|
1
1
|
# @shoperzz/common
|
|
2
2
|
|
|
3
|
+
## 0.0.2
|
|
4
|
+
|
|
5
|
+
### Patch Changes
|
|
6
|
+
|
|
7
|
+
- 7135ca9: docs(monorepo): professionalize package READMEs and finalize unified release infrastructure
|
|
8
|
+
- fd02ee3: docs(monorepo): align package licenses with GPL-3.0 standards
|
|
9
|
+
|
|
3
10
|
## 0.0.1
|
|
4
11
|
|
|
5
12
|
### Patch Changes
|
package/README.md
CHANGED
|
@@ -1,13 +1,32 @@
|
|
|
1
|
-
#
|
|
1
|
+
# @shoperzz/common
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
> Shared interfaces, types, and utilities for the Shoperzz ecosystem.
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
This package serves as the "source of truth" for all contracts between the Shoperzz core and its plugins. It ensures strict typing and architectural consistency across the entire monorepo.
|
|
6
6
|
|
|
7
|
-
|
|
8
|
-
- Global enums and constants (order statuses, permissions).
|
|
9
|
-
- Validation and security utilities (HMAC, JWT).
|
|
7
|
+
## Key Components
|
|
10
8
|
|
|
11
|
-
|
|
9
|
+
- **Interfaces**: Definitions for `ShoperzzPlugin`, `PaymentProvider`, `SmsProvider`, etc.
|
|
10
|
+
- **Universal Types**: Domain objects for orders, customers, and inventory.
|
|
11
|
+
- **Schemas**: Shared validation schemas for API and configuration.
|
|
12
|
+
- **Constants**: Framework-wide constants and error codes.
|
|
12
13
|
|
|
13
|
-
|
|
14
|
+
## Installation
|
|
15
|
+
|
|
16
|
+
```bash
|
|
17
|
+
pnpm add @shoperzz/common
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
## Usage
|
|
21
|
+
|
|
22
|
+
```typescript
|
|
23
|
+
import { IShopperzzPlugin, PluginConfig } from "@shoperzz/common";
|
|
24
|
+
|
|
25
|
+
export class MyPlugin implements IShopperzzPlugin {
|
|
26
|
+
// Implementation
|
|
27
|
+
}
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
## License
|
|
31
|
+
|
|
32
|
+
GPL-3.0-or-later © Shoperzz
|