adminforgex 0.1.0

package/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Changelog
+
+## 0.1.0
+
+- Initial public release.

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Aftab Ahmad Khan
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,35 @@
+# adminforgex
+
+**Topics:** `admin` · `adminforgex` · `crud` · `dashboard` · `mern-packages` · `merndev` · `nodejs` · `npm-pm` · `observability` · `schema` · `typescript`
+
+**Auto admin panel generator (core)** — describe models once (`path`, `fields`, optional relations) and emit a versioned **JSON manifest** your React/Next admin shell can render as CRUD tables + forms.
+
+## Install
+
+```bash
+npm install adminforgex
+```
+
+## Example
+
+```typescript
+import { adminModel, buildAdminManifest } from "adminforgex";
+
+const manifest = buildAdminManifest([
+  adminModel({
+    name: "Order",
+    path: "/api/orders",
+    fields: [
+      { key: "_id", type: "id", readonly: true },
+      { key: "total", type: "number" },
+      { key: "userId", type: "id", relation: { resource: "User", labelField: "email" } },
+    ],
+  }),
+]);
+
+// expose manifest.json from your API or bundle it in the admin app
+```
+
+## License
+
+MIT

package/dist/index.cjs

@@ -0,0 +1,41 @@
+"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 src_exports = {};
+__export(src_exports, {
+  adminModel: () => adminModel,
+  adminforgex: () => adminforgex,
+  buildAdminManifest: () => buildAdminManifest
+});
+module.exports = __toCommonJS(src_exports);
+function adminModel(def) {
+  return def;
+}
+function buildAdminManifest(models, generatedAt = (/* @__PURE__ */ new Date()).toISOString()) {
+  return { version: 1, generatedAt, models };
+}
+var adminforgex = { adminModel, buildAdminManifest };
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  adminModel,
+  adminforgex,
+  buildAdminManifest
+});
+//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts"],"sourcesContent":["export type AdminFieldType = \"string\" | \"number\" | \"boolean\" | \"date\" | \"id\" | \"json\";\n\nexport interface AdminFieldDef {\n  key: string;\n  label?: string;\n  type: AdminFieldType;\n  readonly?: boolean;\n  relation?: { resource: string; labelField?: string };\n}\n\nexport interface AdminModelDef {\n  /** Singular resource name */\n  name: string;\n  /** API base path, e.g. `/api/users` */\n  path: string;\n  fields: AdminFieldDef[];\n}\n\nexport interface AdminManifest {\n  version: 1;\n  generatedAt: string;\n  models: AdminModelDef[];\n}\n\nexport function adminModel(def: AdminModelDef): AdminModelDef {\n  return def;\n}\n\n/** Produce a portable admin manifest for UI generators. */\nexport function buildAdminManifest(models: AdminModelDef[], generatedAt = new Date().toISOString()): AdminManifest {\n  return { version: 1, generatedAt, models };\n}\n\nexport const adminforgex = { adminModel, buildAdminManifest };\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAwBO,SAAS,WAAW,KAAmC;AAC5D,SAAO;AACT;AAGO,SAAS,mBAAmB,QAAyB,eAAc,oBAAI,KAAK,GAAE,YAAY,GAAkB;AACjH,SAAO,EAAE,SAAS,GAAG,aAAa,OAAO;AAC3C;AAEO,IAAM,cAAc,EAAE,YAAY,mBAAmB;","names":[]}

package/dist/index.d.cts

@@ -0,0 +1,32 @@
+type AdminFieldType = "string" | "number" | "boolean" | "date" | "id" | "json";
+interface AdminFieldDef {
+    key: string;
+    label?: string;
+    type: AdminFieldType;
+    readonly?: boolean;
+    relation?: {
+        resource: string;
+        labelField?: string;
+    };
+}
+interface AdminModelDef {
+    /** Singular resource name */
+    name: string;
+    /** API base path, e.g. `/api/users` */
+    path: string;
+    fields: AdminFieldDef[];
+}
+interface AdminManifest {
+    version: 1;
+    generatedAt: string;
+    models: AdminModelDef[];
+}
+declare function adminModel(def: AdminModelDef): AdminModelDef;
+/** Produce a portable admin manifest for UI generators. */
+declare function buildAdminManifest(models: AdminModelDef[], generatedAt?: string): AdminManifest;
+declare const adminforgex: {
+    adminModel: typeof adminModel;
+    buildAdminManifest: typeof buildAdminManifest;
+};
+
+export { type AdminFieldDef, type AdminFieldType, type AdminManifest, type AdminModelDef, adminModel, adminforgex, buildAdminManifest };

package/dist/index.d.ts

@@ -0,0 +1,32 @@
+type AdminFieldType = "string" | "number" | "boolean" | "date" | "id" | "json";
+interface AdminFieldDef {
+    key: string;
+    label?: string;
+    type: AdminFieldType;
+    readonly?: boolean;
+    relation?: {
+        resource: string;
+        labelField?: string;
+    };
+}
+interface AdminModelDef {
+    /** Singular resource name */
+    name: string;
+    /** API base path, e.g. `/api/users` */
+    path: string;
+    fields: AdminFieldDef[];
+}
+interface AdminManifest {
+    version: 1;
+    generatedAt: string;
+    models: AdminModelDef[];
+}
+declare function adminModel(def: AdminModelDef): AdminModelDef;
+/** Produce a portable admin manifest for UI generators. */
+declare function buildAdminManifest(models: AdminModelDef[], generatedAt?: string): AdminManifest;
+declare const adminforgex: {
+    adminModel: typeof adminModel;
+    buildAdminManifest: typeof buildAdminManifest;
+};
+
+export { type AdminFieldDef, type AdminFieldType, type AdminManifest, type AdminModelDef, adminModel, adminforgex, buildAdminManifest };

package/dist/index.js

@@ -0,0 +1,14 @@
+// src/index.ts
+function adminModel(def) {
+  return def;
+}
+function buildAdminManifest(models, generatedAt = (/* @__PURE__ */ new Date()).toISOString()) {
+  return { version: 1, generatedAt, models };
+}
+var adminforgex = { adminModel, buildAdminManifest };
+export {
+  adminModel,
+  adminforgex,
+  buildAdminManifest
+};
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts"],"sourcesContent":["export type AdminFieldType = \"string\" | \"number\" | \"boolean\" | \"date\" | \"id\" | \"json\";\n\nexport interface AdminFieldDef {\n  key: string;\n  label?: string;\n  type: AdminFieldType;\n  readonly?: boolean;\n  relation?: { resource: string; labelField?: string };\n}\n\nexport interface AdminModelDef {\n  /** Singular resource name */\n  name: string;\n  /** API base path, e.g. `/api/users` */\n  path: string;\n  fields: AdminFieldDef[];\n}\n\nexport interface AdminManifest {\n  version: 1;\n  generatedAt: string;\n  models: AdminModelDef[];\n}\n\nexport function adminModel(def: AdminModelDef): AdminModelDef {\n  return def;\n}\n\n/** Produce a portable admin manifest for UI generators. */\nexport function buildAdminManifest(models: AdminModelDef[], generatedAt = new Date().toISOString()): AdminManifest {\n  return { version: 1, generatedAt, models };\n}\n\nexport const adminforgex = { adminModel, buildAdminManifest };\n"],"mappings":";AAwBO,SAAS,WAAW,KAAmC;AAC5D,SAAO;AACT;AAGO,SAAS,mBAAmB,QAAyB,eAAc,oBAAI,KAAK,GAAE,YAAY,GAAkB;AACjH,SAAO,EAAE,SAAS,GAAG,aAAa,OAAO;AAC3C;AAEO,IAAM,cAAc,EAAE,YAAY,mBAAmB;","names":[]}

package/package.json

@@ -0,0 +1,64 @@
+{
+  "name": "adminforgex",
+  "version": "0.1.0",
+  "description": "adminforgex — Admin panel generator core: JSON manifest of models, fields, and routes for CRUD UIs (React/Next adapters plug in separately).",
+  "license": "MIT",
+  "type": "module",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE",
+    "CHANGELOG.md"
+  ],
+  "scripts": {
+    "build": "tsup",
+    "test": "vitest run",
+    "typecheck": "tsc --noEmit",
+    "prepublishOnly": "npm run build"
+  },
+  "keywords": [
+    "admin",
+    "adminforgex",
+    "crud",
+    "dashboard",
+    "mern-packages",
+    "merndev",
+    "nodejs",
+    "npm-pm",
+    "observability",
+    "schema",
+    "typescript"
+  ],
+  "devDependencies": {
+    "@types/node": "^20.11.0",
+    "tsup": "^8.0.0",
+    "typescript": "^5.4.0",
+    "vitest": "^1.4.0"
+  },
+  "engines": {
+    "node": ">=18"
+  },
+  "author": "Aftab Ahmad Khan (https://github.com/aftab-ahmad-khan-dev)",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/NPM-Packages-Modules/mern.git",
+    "directory": "adminforgex"
+  },
+  "bugs": {
+    "url": "https://github.com/NPM-Packages-Modules/mern/issues"
+  },
+  "homepage": "https://github.com/NPM-Packages-Modules/mern/tree/main/adminforgex",
+  "publishConfig": {
+    "access": "public"
+  }
+}