@shoperzz/common 0.0.2 → 0.0.3-beta.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/.turbo/turbo-build.log +1 -1
- package/CHANGELOG.md +7 -1
- package/README.md +27 -18
- package/package.json +1 -1
package/.turbo/turbo-build.log
CHANGED
package/CHANGELOG.md
CHANGED
package/README.md
CHANGED
|
@@ -1,15 +1,30 @@
|
|
|
1
|
-
|
|
1
|
+
<div align="center">
|
|
2
|
+
<img src="../../assets/logos/LOGO-COLORED-SVG.svg" alt="Shoperzz" width="300" />
|
|
3
|
+
<br/>
|
|
4
|
+
<p>
|
|
5
|
+
<strong>@shoperzz/common</strong><br/>
|
|
6
|
+
Universal utilities and types for the Shoperzz ecosystem.
|
|
7
|
+
</p>
|
|
2
8
|
|
|
3
|
-
>
|
|
9
|
+
<div>
|
|
10
|
+
<img src="https://img.shields.io/badge/TypeScript-007ACC?style=flat-square&logo=typescript&logoColor=white" alt="TypeScript">
|
|
11
|
+
<img src="https://img.shields.io/badge/pnpm-F69220?style=flat-square&logo=pnpm&logoColor=white" alt="pnpm">
|
|
12
|
+
<img src="https://img.shields.io/npm/v/@shoperzz/common?style=flat-square&logo=npm&color=CB3837" alt="npm version">
|
|
13
|
+
</div>
|
|
14
|
+
</div>
|
|
4
15
|
|
|
5
|
-
|
|
16
|
+
<br/>
|
|
6
17
|
|
|
7
|
-
##
|
|
18
|
+
## Narrative Synthesis
|
|
8
19
|
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
20
|
+
@shoperzz/common provides the essential building blocks used across all Shoperzz packages and plugins. It ensures strict type safety, consistent error handling, and shared utility functions, acting as the "glue" that maintains architectural cohesion in the monorepo.
|
|
21
|
+
|
|
22
|
+
## Key Technical Capabilities
|
|
23
|
+
|
|
24
|
+
- **Shared Domain Types**: Centralized definitions for order states, payment results, and customer profiles.
|
|
25
|
+
- **Validation Logic**: Universal Zod-based validators for Africa-specific data formats.
|
|
26
|
+
- **Security Utils**: Standardized encryption, hashing, and token handling.
|
|
27
|
+
- **Constants & Enums**: The single source of truth for framework-wide configurations.
|
|
13
28
|
|
|
14
29
|
## Installation
|
|
15
30
|
|
|
@@ -17,16 +32,10 @@ This package serves as the "source of truth" for all contracts between the Shope
|
|
|
17
32
|
pnpm add @shoperzz/common
|
|
18
33
|
```
|
|
19
34
|
|
|
20
|
-
##
|
|
35
|
+
## Governance
|
|
21
36
|
|
|
22
|
-
|
|
23
|
-
import { IShopperzzPlugin, PluginConfig } from "@shoperzz/common";
|
|
24
|
-
|
|
25
|
-
export class MyPlugin implements IShopperzzPlugin {
|
|
26
|
-
// Implementation
|
|
27
|
-
}
|
|
28
|
-
```
|
|
37
|
+
This package follows the Elite Release Protocol. Versions and tags are managed automatically by the Shoperzz Release Bot.
|
|
29
38
|
|
|
30
|
-
|
|
39
|
+
---
|
|
31
40
|
|
|
32
|
-
GPL-3.0-or-later © Shoperzz
|
|
41
|
+
[License: GPL-3.0-or-later](../../LICENSE.md) © Shoperzz
|