mulguard 1.2.3 → 1.2.4

package/LICENSE

@@ -0,0 +1,70 @@
+
+---
+
+**Mulverse M.U.V GENERAL PUBLIC LICENSE**
+
+**Version 1.0**
+
+**Copyright (C) [2022] Mulverse Inc.**
+
+**1. Definitions**
+
+1.1 **"Software"** refers to the Mulverse software distributed under this license, including all associated files, documentation, and any updates or modifications.
+
+1.2 **"You"** means the individual or entity who receives or uses the Software.
+
+1.3 **"Distribution"** refers to any form of sharing or redistribution of the Software, including copies or derivative works.
+
+**2. Permissions**
+
+2.1 **Use**: You are granted the right to use the Software for any purpose.
+
+2.2 **Copy and Distribution**: You may distribute copies of the Software, either in its original form or as modified, provided that all copies include the same license terms.
+
+2.3 **Modification**: You may modify the Software and distribute the modified versions, provided that the modified Software is also licensed under this Mulverse M.U.V General Public License and that you include a prominent notice stating the changes made.
+
+**3. Copyleft**
+
+3.1 **Source Code**: If you distribute the Software or any derivative works, you must either include the source code or make it available in a manner specified by this license.
+
+3.2 **License Continuity**: All copies and derivative works of the Software must be distributed under the terms of this Mulverse M.U.V General Public License. You must include a copy of this license with all distributions.
+
+**4. Conditions**
+
+4.1 **Attribution**: You must provide appropriate credit to Mulverse Inc., including a notice that the Software is licensed under the Mulverse M.U.V General Public License.
+
+4.2 **No Warranty**: The Software is provided "as is," without any warranty of any kind. Mulverse Inc. disclaims all warranties and conditions, including but not limited to implied warranties of merchantability and fitness for a particular purpose.
+
+4.3 **No Additional Restrictions**: You may not impose any additional restrictions on the rights granted by this license. This includes, but is not limited to, additional licenses or agreements.
+
+**5. Termination**
+
+5.1 **Automatic Termination**: If you breach any of the terms of this license, your rights under this license will be terminated automatically.
+
+5.2 **Reinstatement**: You may be reinstated if you cure the breach and notify Mulverse Inc. of the cure within 30 days of the termination.
+
+**6. Patent Grant**
+
+6.1 **Patent License**: You grant to Mulverse Inc. a non-exclusive, royalty-free license to any patents you may hold that are necessary to use the Software.
+
+**7. Indemnity**
+
+7.1 **Indemnification**: You agree to indemnify and hold Mulverse Inc. harmless from any claims, damages, or liabilities arising from your use or distribution of the Software.
+
+**8. Governing Law**
+
+8.1 **Jurisdiction**: This license shall be governed by and construed in accordance with the laws of [Your Jurisdiction].
+
+**9. Miscellaneous**
+
+9.1 **Severability**: If any provision of this license is held to be invalid or unenforceable, the remaining provisions will remain in effect.
+
+9.2 **Entire Agreement**: This license constitutes the entire agreement between you and Mulverse Inc. regarding the Software and supersedes all prior agreements and understandings.
+
+**10. Contact**
+
+10.1 **Inquiries**: For any questions or concerns regarding this license, please contact Mulverse Inc. at [Contact Information].
+
+**End of License**
+
+---

package/README.md

@@ -18,4 +18,55 @@
 
 ---
 
+## Installation
+
+### From npm (Recommended)
+
+```bash
+npm install mulguard
+# or
+pnpm add mulguard
+# or
+yarn add mulguard
+```
+
+### From Source (Development)
+
+If you're installing from the source code (monorepo), you need to use **pnpm** because the package uses `workspace:*` protocol:
+
+```bash
+# Install pnpm if you don't have it
+npm install -g pnpm
+
+# From the monorepo root
+pnpm install
+```
+
+If you encounter the error `Unsupported URL Type "workspace:"` when using npm:
+
+1. **Use pnpm instead** (recommended):
+
+   ```bash
+   pnpm install
+   ```
+
+2. **Or fix the workspace protocol manually**:
+   ```bash
+   # From packages/mulguard directory
+   node scripts/fix-workspace.js
+   npm install
+   ```
+
+### Troubleshooting
+
+**Error: `Unsupported URL Type "workspace:"`**
+
+This error occurs when trying to install from source code using npm instead of pnpm. Solutions:
+
+- **Option 1**: Use pnpm (recommended for monorepo development)
+- **Option 2**: Install from npm registry (if the package is published)
+- **Option 3**: Run the fix script: `node packages/mulguard/scripts/fix-workspace.js`
+
+---
+
 Check out the documentation at [mulverse.com](https://mulverse.com) or visit the [Mulverse Network](https://mulverse.com) for more information.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mulguard",
-  "version": "1.2.3",
+  "version": "1.2.4",
   "description": "Authentication for Next.js with Backend-First Architecture",
   "homepage": "https://mulverse.com/packages/mulguard",
   "repository": "https://github.com/mulverse/mulverse.git",
@@ -65,17 +65,6 @@
     "oidc",
     "mulguard"
   ],
-  "scripts": {
-    "build": "pnpm clean && pnpm providers && node ../../node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/bin/tsc",
-    "clean": "node -e \"const fs = require('fs'); const path = require('path'); ['*.js', '*.d.ts*', 'lib', 'providers'].forEach(p => { try { if (fs.existsSync(p)) fs.rmSync(p, {recursive: true, force: true}); } catch(e) {} });\"",
-    "dev": "pnpm providers && tsc -w",
-    "test": "vitest run -c ../utils/vitest.config.ts",
-    "test:watch": "vitest -c ../utils/vitest.config.ts",
-    "test:e2e": "playwright test",
-    "providers": "node ../utils/scripts/providers",
-    "prepack": "node scripts/prepack.js",
-    "postpack": "node scripts/postpack.js"
-  },
   "files": [
     "*.d.ts*",
     "*.js",
@@ -88,7 +77,7 @@
     "access": "public"
   },
   "dependencies": {
-    "@mulverse/mulguard-core": "^1.0.4"
+    "@mulverse/mulguard-core": "^1.0.5"
   },
   "peerDependencies": {
     "@simplewebauthn/browser": "^9.0.1",
@@ -115,5 +104,15 @@
     "nodemailer": "^7.0.7",
     "react": "^18.2.0",
     "typescript": "5.3.3"
+  },
+  "scripts": {
+    "build": "pnpm clean && pnpm providers && node ../../node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/bin/tsc",
+    "clean": "node -e \"const fs = require('fs'); const path = require('path'); ['*.js', '*.d.ts*', 'lib', 'providers'].forEach(p => { try { if (fs.existsSync(p)) fs.rmSync(p, {recursive: true, force: true}); } catch(e) {} });\"",
+    "dev": "pnpm providers && tsc -w",
+    "test": "vitest run -c ../utils/vitest.config.ts",
+    "test:watch": "vitest -c ../utils/vitest.config.ts",
+    "test:e2e": "playwright test",
+    "providers": "node ../utils/scripts/providers",
+    "preinstall": "node scripts/preinstall.js"
   }
-}
+}