@kgalexander/mcreate 0.0.3 → 0.0.5

package/README.md

@@ -2,9 +2,15 @@
 
 mcreate package
 
+## Installation
+
+```bash
+npm install @kgalexander/mcreate
+```
+
 ## Local Development with npm link
 
-When using `npm link` to develop these packages locally with a Next.js application, you need to configure Next.js to resolve symlinked packages outside the project directory.
+When using `npm link` to develop this package locally with a Next.js application, you need to configure Next.js to resolve symlinked packages outside the project directory.
 
 ### Setup
 
@@ -17,16 +23,16 @@ When using `npm link` to develop these packages locally with a Next.js applicati
 2. Link it in your Next.js project:
    ```bash
    cd your-nextjs-project
-   npm link mcreate
+   npm link @kgalexander/mcreate
    ```
 
-3. Update your projects `next.config.ts` to support external symlinks:
+3. Update your project's `next.config.ts` to support external symlinks:
    ```ts
    import type { NextConfig } from "next";
    import path from "path";
 
    const nextConfig: NextConfig = {
-     transpilePackages: ['mcreate'],
+     transpilePackages: ['@kgalexander/mcreate'],
      outputFileTracingRoot: path.join(__dirname, "../"),
    };
 
@@ -38,3 +44,44 @@ When using `npm link` to develop these packages locally with a Next.js applicati
 ### Why is this needed?
 
 Turbopack (used by Next.js) doesn't support reading files or symlinks outside your project directory by default. The `outputFileTracingRoot` option expands the allowed directory scope to include the linked packages.
+
+## Deploying to Vercel
+
+**Important:** The `outputFileTracingRoot` configuration breaks Vercel deployments. Before deploying:
+
+1. Remove `outputFileTracingRoot` from your `next.config.ts`:
+   ```ts
+   import type { NextConfig } from "next";
+
+   const nextConfig: NextConfig = {
+     transpilePackages: ['@kgalexander/mcreate'],
+   };
+
+   export default nextConfig;
+   ```
+
+2. Run `npm install` to ensure the package is installed from npm (not linked)
+
+3. Deploy to Vercel
+
+### Quick Toggle
+
+You can keep both configurations in your `next.config.ts` and comment/uncomment as needed:
+
+```ts
+import type { NextConfig } from "next";
+import path from "path";
+
+// Production config (for Vercel deployment)
+const nextConfig: NextConfig = {
+  transpilePackages: ['@kgalexander/mcreate'],
+};
+
+// Local development config (for npm link)
+// const nextConfig: NextConfig = {
+//   transpilePackages: ['@kgalexander/mcreate'],
+//   outputFileTracingRoot: path.join(__dirname, "../"),
+// };
+
+export default nextConfig;
+```

package/dist/index.d.mts

@@ -0,0 +1,5 @@
+import * as react_jsx_runtime from 'react/jsx-runtime';
+
+declare function Editor(): react_jsx_runtime.JSX.Element;
+
+export { Editor };

package/dist/index.d.ts

@@ -0,0 +1,5 @@
+import * as react_jsx_runtime from 'react/jsx-runtime';
+
+declare function Editor(): react_jsx_runtime.JSX.Element;
+
+export { Editor };

package/dist/index.js

@@ -0,0 +1,35 @@
+"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.tsx
+var index_exports = {};
+__export(index_exports, {
+  Editor: () => Editor
+});
+module.exports = __toCommonJS(index_exports);
+
+// src/Editor.tsx
+var import_jsx_runtime = require("react/jsx-runtime");
+function Editor() {
+  return /* @__PURE__ */ (0, import_jsx_runtime.jsx)("div", { children: /* @__PURE__ */ (0, import_jsx_runtime.jsx)("h1", { children: "Editor v0.0.5" }) });
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  Editor
+});

package/dist/index.mjs

@@ -0,0 +1,8 @@
+// src/Editor.tsx
+import { jsx } from "react/jsx-runtime";
+function Editor() {
+  return /* @__PURE__ */ jsx("div", { children: /* @__PURE__ */ jsx("h1", { children: "Editor v0.0.5" }) });
+}
+export {
+  Editor
+};

package/package.json

@@ -1,10 +1,25 @@
 {
   "name": "@kgalexander/mcreate",
-  "version": "0.0.3",
+  "version": "0.0.5",
   "description": "Maillow email template editor",
-  "main": "index.js",
+  "main": "./dist/index.js",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "access": "public",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "build": "tsup",
+    "dev": "tsup --watch",
+    "prepublishOnly": "npm run build"
   },
   "repository": {
     "type": "git",
@@ -15,5 +30,15 @@
   "bugs": {
     "url": "https://github.com/Kga-6/mpackages/issues"
   },
-  "homepage": "https://github.com/Kga-6/mpackages/tree/main/packages/mcreate"
+  "homepage": "https://github.com/Kga-6/mpackages/tree/main/packages/mcreate",
+  "peerDependencies": {
+    "react": ">=18.0.0",
+    "react-dom": ">=18.0.0"
+  },
+  "devDependencies": {
+    "@types/react": "^19.2.10",
+    "@types/react-dom": "^19.2.3",
+    "tsup": "^8.5.1",
+    "typescript": "^5.9.3"
+  }
 }

package/index.js

@@ -1,7 +0,0 @@
-function MaillowCreate() {
-  console.log('mcreate');
-
-  return "mcreate package is ready!";
-}
-
-module.exports = MaillowCreate;