auth 0.0.9 → 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Auth.js
+
+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

@@ -1,175 +1,32 @@
+# Auth.js CLI
 
+The CLI tool by [Auth.js](https://authjs.dev) to supercharge your authentication workflow.
 
-## Features
+## Installation
 
-- share items with multiple users
-- creating account tokens with access to specific collections & items
-	- used for locking down public access to certain features.
-	- ability to add expiration for tokens
-- 
+You don't need to install this package, run any of the following commands:
 
-```javascript
-
-var mongoose = require("mongoose"),
-step         = require("step"),
-Schema       = mongoose.Schema,
-ObjectId     = Schema.Types.ObjectId;
-
-
-var auth = require("auth").connect({
-	connection: mongoose.createConnection("mongodb://localhost/auth-test")
-});
-
-var Post = new Schema({
-	message: String
-});
-	
-//make the post ownable
-Post.plugin(auth.ownable);
-
-step(
-	function() {
-		auth.signup({ email: "me@email.com", password: "password" }, this);
-	},
-	function(err, account) {
-		this.account = account;
-		var post = new Post({
-			message: "Hello World!"
-		});
-
-		//make the account OWN the post
-		account.own(post);
-
-		post.save(this);
-	},
-	function() {
-		Post.find(this.account.ownQuery(), this);
-	},
-	function(err, post) {
-		console.log(post.message); //Hello World!
-	}
-);
-```
-
-
-## auth API
-
-### auth auth.connect(options)
-	
-- options
-	`connection` - mongodb connection
-
-### auth.Account.signup(account, onCreated)
-
-creates a new user
-
-### auth.Account.login(credentals, onLogin)
-
-Logs the user in with u/p, or a token
-
-Example:
-
-```javascript
-auth.Account.login({ token: tokenKey }, onLogin);
-auth.Account.login({ email: "email", password: "password" }, onLogin);
+```sh
+npx auth
 ```
 
-## Account API
+## Usage
 
-### account.getMainToken(callback)
+<!-- TODO: Generate by running `node index.js --help` and writing this -->
 
-returns the main access token with super privileges. No restrictions to collections & items.
+```sh
+Usage: auth [options] [command]
 
-```javascript
-user.getMainToken(function(null, token) {
-	console.log(token.key); //key used to login
-	console.log(token.ttl); // -1 = no expiration date.
-	console.log(token.scope); //[ { collectionName: null, item: null, access: ["GET", "POST", "PUT", "DELETE", "SUPER"]}]
-})
-```
-
-### account.createToken(options, callback)
-
-- `options` - options for the token
-	- `item` - the item to grant access to (optional)
-	- `collectionName` - the collection 
-	- `ttl` - time in MS for expiration 
-	- `access` - (array) scope access. default is `access.all()`
+Options:
+  -V, --version          output the version number
+  -h, --help             display help for command
 
-```javascript
-
-//only give access to the posts collection, and only allow reading items
-user.createToken({ item: Posts.collection.name, access: [access.POST] }, function(err, token) {
-	console.log(token.scope); //[ { collectionName: "posts", item: null, access: ["GET"]}]
-});
+Commands:
+  secret [options]       Generate a random string.
+  framework [framework]  Clone a framework template.
+  help [command]         display help for command
 ```
 
-### account.ownItem(item)
-
-makes the account an owner of an item with SUPER privileges on item
-
-```javascript
-var p = new Post({ message: "hello!" });
-user.ownItem(p);
-p.save();
-```
-
-### account.shareItem(item, access)
-
-Shares an item with another user
-
-- `item` - item to own
-- `access` - access level for the given item. Blank = ALL privileges.
-
-```javascript
-var access = require("auth").access;
-Post.findOne({message:"hello!"}, function(err, post) {
-	user2.shareItem(post, [access.GET]); //ability to only see item
-	post.save();
-});
-```
-
-### account.authorized(item, access)
-
-returns TRUE if the account has access to the item. Note that the result can be variable
-depending if whether the given user logs in with a restricted login token. See below.
-
-```javascript
-
-//logged 
-user2.authorized(post); //TRUE
-user2.authorized(post, [access.POST]); //FALSE
-user2.authorized(post, [access.GET]); //TRUE
-user2.authorized(post, [access.GET, access.POST]); //TRUE
-
-
-//login with the post owner, but restrict access with the created
-//token above.
-User.login({ token: aboveTokenKey }, function(err, user) {
-	user.authorized(post, [access.TRUE]); //FALSE
-	user.authorized(post, [access.POST]); //FALSE
-})
-```
-
-### Error account.unauthorized(callback)
-
-Tiny flow-control utility.
-
-### account.addToSearch(query)
-
-adds account to the given search. For example:
-
-```javascript
-
-Post.findOne(user.addToSearch(), function(err, post) {
-	user.authorized(post); //TRUE
-})
-
-## TODO
+## Acknowledgements
 
-- make sub-schemas ownable
-- sharing whole collections (job & timer)
-- custom authentication schema
-- validation of credentials (email/pass)
-- Auth.lockdown - prevent models from being saved or serialized if unauthorized
-- hooks with [passport](https://github.com/jaredhanson/passport)
+Special thanks to Craig for the `auth` package name on npm.

package/index.js

@@ -0,0 +1,75 @@
+import { InvalidArgumentError } from "commander"
+import { Command } from "commander"
+// import pkg from "./package.json" assert { type: "json" }
+
+import fs from "fs/promises"
+const pkg = JSON.parse(await fs.readFile("./package.json"))
+const { name, description, version } = pkg
+
+try {
+  // TODO: Remove when Node.js 18 is not maintained anymore
+  globalThis.crypto ??= (await import("crypto")).webcrypto
+} catch {}
+
+/** Web compatible method to create a random string of a given length */
+export function randomString(size = 32) {
+  const bytes = crypto.getRandomValues(new Uint8Array(size))
+  return Buffer.from(bytes, "base64").toString("base64")
+}
+
+const program = new Command()
+
+program.name(name).description(description).version(version)
+
+program
+  .command("secret")
+  .option("--raw", "Output the string without any formatting.")
+  .description("Generate a random string.")
+  .action((options) => {
+    const value = randomString()
+    if (options.raw) return console.log(value)
+    // TODO: Detect framework, check for existing value, and write automatically
+    console.log(`
+Secret generated. Copy it to your .env/.env.local file (depending on your framework):
+
+AUTH_SECRET=${value}`)
+  })
+
+// TODO: Get this programmatically
+const frameworks = {
+  nextjs: {
+    src: "https://github.com/nextauthjs/next-auth-example",
+    demo: "https://next-auth-example.vercel.app",
+  },
+  sveltekit: {
+    src: "https://github.com/nextauthjs/sveltekit-auth-example",
+    demo: "https://sveltekit-auth-example.vercel.app",
+  },
+  express: {
+    src: "https://github.com/nextauthjs/express-auth-example",
+    demo: "https://express-auth-example.vercel.app",
+  },
+}
+
+program
+  .command("framework")
+  .argument("[framework]", "The framework to use.", (value) => {
+    if (!value) return value
+    if (Object.keys(frameworks).includes(value)) return value
+    throw new InvalidArgumentError(
+      `Valid frameworks are: ${supportedFrameworks.join(", ")}`
+    )
+  })
+  .description("Clone a framework template.")
+  .action((framework) => {
+    if (!framework) {
+      return console.log(`
+Supported frameworks are: ${Object.keys(frameworks).join(", ")}`)
+    }
+    const { src, demo } = frameworks[framework]
+    console.log(`
+Source code: ${src}
+Deployed demo: ${demo}`)
+  })
+
+program.parse(process.argv)

package/package.json

@@ -1,33 +1,28 @@
 {
   "name": "auth",
-  "version": "0.0.9",
-  "description": "ERROR: No README.md file found!",
-  "main": "./lib/index.js",
-  "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+  "description": "The CLI tool by Auth.js to supercharge your authentication workflow.",
+  "homepage": "https://cli.authjs.dev",
+  "version": "1.0.0",
+  "type": "module",
+  "bin": {
+    "auth": "index.js"
   },
-  "repository": {
-    "type": "git",
-    "url": "git://github.com/crcn/node-auth.git"
-  },
-  "author": "",
-  "license": "BSD",
+  "files": [
+    "*.d.ts*",
+    "*.js",
+    "lib",
+    "src"
+  ],
+  "keywords": [
+    "authjs",
+    "cli"
+  ],
+  "author": "Balázs Orbán <info@balazsorban.com>",
+  "license": "MIT",
   "dependencies": {
-    "outcome": "0.0.x",
-    "step": "0.0.x",
-    "structr": "0.2.x",
-    "underscore": "1.4.x",
-    "dsync": "0.0.x",
-    "vine": "0.1.x",
-    "dustjs-linkedin": "1.1.x",
-    "seq": "0.3.x",
-    "comerr": "0.0.x",
-    "verify": "0.0.x"
+    "commander": "11.1.0"
   },
-  "browserify": "./browser/index.js",
-  "devDependencies": {
-    "plugin": "*",
-    "plugin-express": "0.0.x",
-    "plugin-mongodb": "0.0.x"
+  "prettier": {
+    "semi": false
   }
-}
+}

package/.cupboard

@@ -1,2 +0,0 @@
-[commands]
-proj = subl .

package/.npmignore

@@ -1,2 +0,0 @@
-node_modules
-.DS_Store

package/browser/account.js

@@ -1,70 +0,0 @@
-var structr = require("structr"),
-_ = require("underscore");
-
-exports.connect = function(host) {
-
-	var host = window.location.protocol + "//" + window.location.host;
-
-	if(window.location.port && String(window.location.port).length > 0) {
-		host += ":" + window.location.port;
-	}
-
-
-
-	var Account;
-	return Account = structr({
-
-		/**
-		 */
-
-		"__construct": function(data) {
-			_.extend(this, data);
-		},
-
-		/**
-		 */
-
-		"save": function() {
-			//TODO
-		},
-
-		/**
-		 */
-
-		"static login": function(data, onLogin) {
-
-			if(arguments.length == 1) {
-				onLogin = data;
-				data = {};
-			}
-
-			$.ajax({
-				type: "GET",
-				data: data,
-				url: host + "/account.json",
-				success: function(resp) {
-					if(resp.errors) return onLogin(resp.errors);
-					onLogin(null, new Account(resp.result));
-				}
-			})
-		},
-
-
-		/**
-		 */
-
-		"static signup": function(data, onSignup) {
-			$.ajax({
-				type: "POST",
-				data: data,
-				url: host + "/account.json",
-				success: function(resp) {
-					if(resp.errors) return onLogin(resp.errors);
-					onLogin(null, new Account(resp.result));
-				}
-			})
-		}
-	});
-}
-
-

package/browser/index.js

@@ -1,13 +0,0 @@
-
-
-exports.connect = function(host) {
-	if(arguments.length == 0) {
-		host = window.location.origin;
-	}
-
-
-
-	return {
-		Account: require("./account").connect(host)
-	};
-}

package/docs/issues.md

@@ -1,4 +0,0 @@
-- How do we make sure that users are the owner's of particular documents?
-	- How do we do this efficiently?
-- How do we grant privileges for documents without writing a ton of code for each sharable collection?
-	- timer that checks for privileges to grant & remove at set intervals

package/docs/pseudo-1.js

@@ -1,19 +0,0 @@
-var auth = require("auth").init({
-	collections: {
-		profile: "profile",
-		sessions: "session",
-		friends: "friends"
-	},
-	connection: dbconnection
-});
-
-	
-
-auth.collections.register("friends");
-
-
-
-var profile = auth.signup()
-
-
-

package/examples/ex1.js

@@ -1,72 +0,0 @@
-var mongoose = require("mongoose"),
-step = require("step"),
-outcome = require("outcome");
-
-var auth = require("../").init({
-	connection: mongoose.connect("mongodb://localhost:27017/auth")
-});
-
-
-auth.connection.model("friends", new mongoose.Schema({
-	name: String,
-	last: String
-}))
-
-
-auth.sharedCollections.add("friends");
-
-
-var on = outcome.error(function(err) {
-	console.error(err.stack);
-}),
-user,
-user2;
-
-
-
-
-
-step(
-
-	/**
-	 */
-
-	function() {
-		auth.signup({ username: "craig", email: "craig.j.condon@gmail.com", password: "test" }, this);
-	},
-
-	/**
-	 */
-
-	on.success(function(data) {
-		user = data.user;
-		auth.signup({ username: "john", email: "craig.j.condon+test@gmail.com", password: "test"}, this);
-	}),
-
-	/**
-	 */
-
-	on.success(function(data) {
-		user2 = data.user;
-
-		//thrown into a job
-		user.grantPermission(user2, ["*:friends"]);
-
-		//wait for permissions to be granted
-		auth.worker.once("grant", this);
-	}),
-
-	/**
-	 */
-
-	on.success(function() {
-		auth.sandbox("*:friends").login({ username: "john", password: "test" }, this);
-	}),
-
-	/**
-	 */
-
-	on.success(function(data) {
-		console.log(data.token.scopes);
-	})
-);

package/examples/ex2.js

@@ -1,62 +0,0 @@
-var step = require("step"),
-mongoose = require("mongoose");
-
-require("./models");
-
-var auth = require("../").connect({
-	connection: mongoose.createConnection("mongodb://localhost/auth-test")
-});
-
-var user1, user2, post, Post = auth.connection.model("posts");
-
-
-step(
-	function() {
-		console.log("u1");
-		auth.signup({ email: "me@email.com", password: "password" }, this);
-	},
-	function(err, u1) {
-		user1 = u1;
-		console.log("u2");
-		auth.signup({ email: "me@email2.com", password: "password" }, this);
-	},
-	function(err, u2) {
-		user2 = u2;
-		if(err) consoe.log(err.stack)
-		post = new Post({title:"test", message:"hello"});
-		user1.ownItem(post);
-		post.save(this);
-	},
-	function(err) {
-		if(err) consoe.log(err.stack)
-		Post.findOne(user1.addToSearch(), this);
-
-	},
-	function(err, p) {
-		post = p;
-
-		if(!user1.hasItemAccess(p)) return user1.unauthorized(this);
-
-		user2.lockdownItem(p);
-		console.log(JSON.stringify(p))
-
-		//share with my friend
-		user2.shareItem(p);
-		p.save(this);
-	},
-	function(err) {
-		console.log(err)
-		post.fetchOwner(this);
-	},
-	function(err, u) {
-		console.log(err);
-		user1 = u;
-		this();
-	},
-	function(err) {
-		console.log(err);
-		user1.remove();
-		user2.remove();
-	}
-)
-

package/examples/models.js

@@ -1,17 +0,0 @@
-var mongoose = require("mongoose"),
-auth         = require("../"),
-Schema       = mongoose.Schema;
-
-exports.Comment = new Schema({
-	message: String
-});
-
-exports.Post = new Schema({
-	title: String,
-	message: String,
-	comments: [exports.Comment]
-});
-
-
-exports.Post.plugin(auth.ownable);
-mongoose.model("posts", exports.Post);

package/examples/plugin-1.js

@@ -1,14 +0,0 @@
-var plugin = require("plugin");
-
-
-plugin().
-params({
-	http: {
-		port: 8085
-	},
-	mongodb: "mongodb://localhost/auth-tes"
-}).
-require("plugin-express").
-require("plugin-mongodb").
-require(__dirname + "/../").
-load();

package/examples/pseduo.js

@@ -1,6 +0,0 @@
-
-
-
-router.on("-method=DELETE groups/:group/items/:item", function(req, res, mw) {
-	
-});

package/examples/pseudo-2.js

@@ -1,2 +0,0 @@
-var auth = require("auth");
-