@micro-cms/types 1.0.20 → 1.0.22

package/README.md

@@ -0,0 +1,46 @@
+# @micro-cms/types
+
+Standardized TypeScript interfaces and type definitions for the Micro-CMS ecosystem. This package ensures strict contracts between modules, the runtime, and front-end components.
+
+## Installation
+
+```bash
+pnpm add @micro-cms/types
+```
+
+## Key Definitions
+
+### 1. Schema System
+Defines the `Entity`, `Field`, and `Schema` structures used to drive the Admin UI and validation logic.
+
+### 2. Module System
+- **`CmsModule`**: The interface every module must implement.
+- **`ModuleManifest`**: Metadata about a module, including its capabilities (`provides`) and requirements (`requires`).
+- **`CmsContext`**: The object passed to a module during load, containing access to the runtime, events, and shared state.
+
+### 3. Capabilities
+Contracts for common system functionalities:
+- **`DataProvider`**: For database adapters.
+- **`RouteProvider`**: For contributing API endpoints.
+- **`PaymentProvider`**: For blockchain payment integrations.
+
+### 4. Event System
+Types for the staged event bus, including `EventStage` (`validation`, `processing`, `notification`) and `SubscriptionOptions`.
+
+## Usage
+
+This package is typically used as a `devDependency` in other modules to ensure type safety:
+
+```typescript
+import { CmsModule, CmsContext } from '@micro-cms/types';
+
+export default {
+  manifest: {
+    name: 'my-module',
+    provides: ['custom-capability']
+  },
+  async load(context: CmsContext) {
+    // ...
+  }
+} as CmsModule;
+```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@micro-cms/types",
-  "version": "1.0.20",
+  "version": "1.0.22",
   "main": "dist/index.js",
   "module": "dist/index.mjs",
   "types": "dist/index.d.ts",
@@ -22,5 +22,14 @@
   "devDependencies": {
     "typescript": "^5.0.0",
     "tsup": "^8.0.2"
-  }
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/teamoremi/micro-cms.git",
+    "directory": "packages/types"
+  },
+  "bugs": {
+    "url": "https://github.com/teamoremi/micro-cms/issues"
+  },
+  "homepage": "https://github.com/teamoremi/micro-cms/tree/master/packages/types#readme"
 }