@micro-cms/resource-module 1.0.0

package/dist/index.d.mts

@@ -0,0 +1,5 @@
+import { CmsModule } from '@micro-cms/types';
+
+declare const createResourceModule: () => CmsModule;
+
+export { createResourceModule };

package/dist/index.d.ts

@@ -0,0 +1,5 @@
+import { CmsModule } from '@micro-cms/types';
+
+declare const createResourceModule: () => CmsModule;
+
+export { createResourceModule };

package/dist/index.js

@@ -0,0 +1,102 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  createResourceModule: () => createResourceModule
+});
+module.exports = __toCommonJS(index_exports);
+var createResourceModule = () => {
+  return {
+    manifest: {
+      name: "@micro-cms/resource-module",
+      version: "1.0.0",
+      provides: ["route-provider"],
+      requires: ["database-adapter"]
+    },
+    async load(context) {
+      const db = context.runtime.getCapability("database-adapter");
+      if (!db) {
+        console.error("Resource Module failed to load: database-adapter not found");
+        return;
+      }
+      const routes = [
+        // Introspection
+        {
+          method: "GET",
+          path: "/api/schema",
+          handler: async (req, res) => {
+            const schema = await db.introspect();
+            res.json(schema);
+          },
+          middleware: ["admin-auth"]
+        },
+        // Generic List
+        {
+          method: "GET",
+          path: "/api/resources/:resource",
+          handler: async (req, res) => {
+            const { resource } = req.params;
+            const { page, limit, sort, ...filter } = req.query;
+            const result = await db.find(resource, {
+              page: Number(page) || 1,
+              limit: Number(limit) || 10,
+              sort,
+              filter
+            });
+            res.json(result);
+          },
+          middleware: ["admin-auth"]
+        },
+        // Generic Get One
+        {
+          method: "GET",
+          path: "/api/resources/:resource/:id",
+          handler: async (req, res) => {
+            const { resource, id } = req.params;
+            const item = await db.findById(resource, id);
+            if (!item) return res.status(404).json({ error: "Not found" });
+            res.json(item);
+          },
+          middleware: ["admin-auth"]
+        },
+        // Generic Create
+        {
+          method: "POST",
+          path: "/api/resources/:resource",
+          handler: async (req, res) => {
+            const { resource } = req.params;
+            const item = await db.create(resource, req.body);
+            res.status(201).json(item);
+          },
+          middleware: ["admin-auth"]
+        }
+      ];
+      context.runtime.register("route-provider", {
+        getRoutes: () => routes
+      });
+      console.log("Resource Module loaded and registered routes.");
+    }
+  };
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  createResourceModule
+});

package/dist/index.mjs

@@ -0,0 +1,77 @@
+// src/index.ts
+var createResourceModule = () => {
+  return {
+    manifest: {
+      name: "@micro-cms/resource-module",
+      version: "1.0.0",
+      provides: ["route-provider"],
+      requires: ["database-adapter"]
+    },
+    async load(context) {
+      const db = context.runtime.getCapability("database-adapter");
+      if (!db) {
+        console.error("Resource Module failed to load: database-adapter not found");
+        return;
+      }
+      const routes = [
+        // Introspection
+        {
+          method: "GET",
+          path: "/api/schema",
+          handler: async (req, res) => {
+            const schema = await db.introspect();
+            res.json(schema);
+          },
+          middleware: ["admin-auth"]
+        },
+        // Generic List
+        {
+          method: "GET",
+          path: "/api/resources/:resource",
+          handler: async (req, res) => {
+            const { resource } = req.params;
+            const { page, limit, sort, ...filter } = req.query;
+            const result = await db.find(resource, {
+              page: Number(page) || 1,
+              limit: Number(limit) || 10,
+              sort,
+              filter
+            });
+            res.json(result);
+          },
+          middleware: ["admin-auth"]
+        },
+        // Generic Get One
+        {
+          method: "GET",
+          path: "/api/resources/:resource/:id",
+          handler: async (req, res) => {
+            const { resource, id } = req.params;
+            const item = await db.findById(resource, id);
+            if (!item) return res.status(404).json({ error: "Not found" });
+            res.json(item);
+          },
+          middleware: ["admin-auth"]
+        },
+        // Generic Create
+        {
+          method: "POST",
+          path: "/api/resources/:resource",
+          handler: async (req, res) => {
+            const { resource } = req.params;
+            const item = await db.create(resource, req.body);
+            res.status(201).json(item);
+          },
+          middleware: ["admin-auth"]
+        }
+      ];
+      context.runtime.register("route-provider", {
+        getRoutes: () => routes
+      });
+      console.log("Resource Module loaded and registered routes.");
+    }
+  };
+};
+export {
+  createResourceModule
+};

package/package.json

@@ -0,0 +1,18 @@
+{
+  "name": "@micro-cms/resource-module",
+  "version": "1.0.0",
+  "description": "Standardized CRUD and Schema routes for Micro-CMS",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "build": "tsup src/index.ts --format cjs,esm --dts"
+  },
+  "peerDependencies": {
+    "@micro-cms/types": "workspace:*",
+    "@micro-cms/core": "workspace:*"
+  },
+  "devDependencies": {
+    "typescript": "^5.3.3",
+    "tsup": "^8.0.2"
+  }
+}

package/src/index.ts

@@ -0,0 +1,80 @@
+import { CmsModule, CmsContext, RouteProvider, RouteDefinition, DataProvider } from '@micro-cms/types';
+
+export const createResourceModule = (): CmsModule => {
+  return {
+    manifest: {
+      name: '@micro-cms/resource-module',
+      version: '1.0.0',
+      provides: ['route-provider'],
+      requires: ['database-adapter']
+    },
+    async load(context: CmsContext) {
+      const db = context.runtime.getCapability<DataProvider>('database-adapter');
+      
+      if (!db) {
+        console.error('Resource Module failed to load: database-adapter not found');
+        return;
+      }
+
+      const routes: RouteDefinition[] = [
+        // Introspection
+        {
+          method: 'GET',
+          path: '/api/schema',
+          handler: async (req, res) => {
+            const schema = await db.introspect();
+            res.json(schema);
+          },
+          middleware: ['admin-auth']
+        },
+        // Generic List
+        {
+          method: 'GET',
+          path: '/api/resources/:resource',
+          handler: async (req, res) => {
+            const { resource } = req.params;
+            const { page, limit, sort, ...filter } = req.query;
+            const result = await db.find(resource, {
+              page: Number(page) || 1,
+              limit: Number(limit) || 10,
+              sort: sort as string,
+              filter
+            });
+            res.json(result);
+          },
+          middleware: ['admin-auth']
+        },
+        // Generic Get One
+        {
+          method: 'GET',
+          path: '/api/resources/:resource/:id',
+          handler: async (req, res) => {
+            const { resource, id } = req.params;
+            const item = await db.findById(resource, id);
+            if (!item) return res.status(404).json({ error: 'Not found' });
+            res.json(item);
+          },
+          middleware: ['admin-auth']
+        },
+        // Generic Create
+        {
+          method: 'POST',
+          path: '/api/resources/:resource',
+          handler: async (req, res) => {
+            const { resource } = req.params;
+            const item = await db.create(resource, req.body);
+            res.status(201).json(item);
+          },
+          middleware: ['admin-auth']
+        }
+      ];
+
+      // Register the routes as a capability
+      context.runtime.register('route-provider', {
+        getRoutes: () => routes
+      } as RouteProvider);
+
+      console.log('Resource Module loaded and registered routes.');
+    }
+  };
+};

package/tsconfig.json

@@ -0,0 +1,10 @@
+{
+  "extends": "../../tsconfig.base.json",
+  "compilerOptions": {
+    "baseUrl": ".",
+    "outDir": "./dist",
+    "rootDir": "./src"
+  },
+  "include": ["src/**/*.ts"],
+  "exclude": ["node_modules", "dist"]
+}