@micro-cms/types 0.0.1

package/dist/index.d.ts

@@ -0,0 +1,72 @@
+export type FieldType = 'text' | 'number' | 'boolean' | 'date' | 'relation' | 'select';
+export interface FieldConstraints {
+    required?: boolean;
+    min?: number;
+    max?: number;
+    minLength?: number;
+    maxLength?: number;
+    options?: string[];
+}
+export interface Field {
+    name: string;
+    type: FieldType;
+    label?: string;
+    constraints?: FieldConstraints;
+    relation?: {
+        targetEntity: string;
+        displayField: string;
+    };
+}
+export interface Entity {
+    name: string;
+    fields: Field[];
+}
+export interface Schema {
+    entities: Entity[];
+}
+export type EventStage = 'validation' | 'processing' | 'notification' | 'default';
+export interface SubscriptionOptions {
+    priority?: number;
+    stage?: EventStage;
+    parallel?: boolean;
+}
+export interface ModuleManifest {
+    name: string;
+    version: string;
+    provides: string[];
+    requires?: string[];
+    optionalDependencies?: string[];
+    pairsWith?: Record<string, {
+        reason: string;
+        strength: 'required' | 'recommended' | 'compatible' | 'optional';
+        category?: string;
+    }>;
+    publishes?: Record<string, string>;
+}
+export interface CmsModule {
+    manifest: ModuleManifest;
+    load: (context: CmsContext) => void | Promise<void>;
+}
+export interface CmsContext {
+    runtime: {
+        register: (capability: string, implementation: any) => void;
+        getCapability: <T = any>(capability: string) => T | undefined;
+    };
+    events: {
+        emit: (event: string, payload: any, stage?: EventStage) => Promise<void>;
+        subscribe: (event: string, handler: (payload: any) => void | Promise<void>, options?: SubscriptionOptions) => void;
+    };
+    context: {
+        publish: (key: string, value: any) => void;
+        get: (key: string) => any;
+        subscribe: (key: string, handler: (value: any) => void) => void;
+    };
+    config: Record<string, any>;
+}
+export interface DataProvider {
+    introspect: () => Promise<Schema>;
+    find: (entity: string, query?: any) => Promise<any[]>;
+    create: (entity: string, data: any) => Promise<any>;
+    update: (entity: string, id: any, data: any) => Promise<any>;
+    delete: (entity: string, id: any) => Promise<any>;
+}

package/dist/index.js

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -0,0 +1,23 @@
+{
+  "name": "@micro-cms/types",
+  "version": "0.0.1",
+  "type": "module",
+  "main": "dist/index.js",
+  "module": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": ["dist"],
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+        "default": "./dist/index.js"
+    }
+  },
+  "scripts": {
+    "build": "tsc",
+    "prepare": "pnpm build"
+  },
+  "devDependencies": {
+    "typescript": "^5.0.0"
+  }
+}