synqauth 0.3.0 → 0.4.0

package/README.md

@@ -19,7 +19,7 @@ It asks Synq for a development sign-in: an org of your own with one app, on `htt
 - writes the app's keys to `.env.local` (`SYNQ_ISSUER`, `SYNQ_CLIENT_ID`, `SYNQ_CLIENT_SECRET`, `SYNQ_APP_URL`, `SYNQ_SESSION_SECRET` and `SYNQ_CLAIM_TOKEN`), and makes sure git ignores it: it adds `.env*.local` to your app's `.gitignore` only where git doesn't ignore the file already (outside a git repo, where `.gitignore` doesn't say so)
 - adds `@synqauth/nextjs` with your package manager
 - adds `synq.config.ts`, `lib/synq.ts`, the route mount at `app/api/auth/[...synq]/route.ts`, and a page at `/synq` that signs you in and shows who
-- makes your `dev` script serve https (`next dev --experimental-https`), which Synq's development redirect URIs need
+- makes your `dev` script serve https (`next dev --experimental-https`), which Synq's development redirect URIs need, and makes sure git ignores the local key and certificate Next.js makes for it in `certificates/`: it adds `/certificates/` to your app's `.gitignore` only where git doesn't ignore them already. Next.js adds that line itself only to a `.gitignore` your app's folder has, which an app in a workspace often lacks
 
 It never overwrites a file you have, and stops before making anything when `.env.local` already has Synq's values (`--force` makes another).
 

package/dist/bin.js

@@ -1,5 +1,5 @@
 #!/usr/bin/env node
-import { t as main } from "./cli-C7dDFb81.js";
+import { n as main } from "./cli-sOLw5xeI.js";
 //#region src/bin.ts
 process.exitCode = await main(process.argv.slice(2));
 //#endregion

package/dist/{cli-C7dDFb81.js → cli-sOLw5xeI.js}

@@ -146,6 +146,13 @@ const HOST_MAP = [
 		staging: null,
 		preview: "https://preview.burnandclaim.com"
 	},
+	{
+		product: "mollyverse",
+		surface: "api",
+		production: ["https://api.mollyverse.art"],
+		staging: null,
+		preview: "https://preview-api.mollyverse.art"
+	},
 	{
 		product: "mollyverse",
 		surface: "website",
@@ -441,6 +448,42 @@ function withEnvLocalLine(gitignore) {
 	const head = gitignore === "" || gitignore.endsWith("\n") ? gitignore : `${gitignore}\n`;
 	return `${head}${head === "" ? "" : "\n"}# Local secrets, such as Synq's (npx synqauth init)\n.env*.local\n`;
 }
+/** Where `next dev --experimental-https` keeps the key mkcert made it, in the app's folder. */
+const CERTIFICATES_KEY = "certificates/localhost-key.pem";
+/**
+* Whether a `.gitignore`'s text keeps `certificates/` out of git. Next adds
+* `certificates` itself, but only to a `.gitignore` in the app's own folder
+* that exists already (AERO-2745).
+*/
+function ignoresCertificates(gitignore) {
+	let ignored = false;
+	for (const line of gitignore.split(/\r?\n/).map((line) => line.trim())) {
+		if (line.startsWith("!")) ignored = false;
+		if ([
+			"certificates",
+			"certificates/",
+			"certificates/*",
+			"certificates/**",
+			"/certificates",
+			"/certificates/",
+			"/certificates/*",
+			"/certificates/**",
+			"**/certificates",
+			"**/certificates/",
+			"*.pem"
+		].includes(line)) ignored = true;
+	}
+	return ignored;
+}
+/** `.gitignore`'s text with `/certificates/` added, when it doesn't ignore `certificates/` yet. */
+function withCertificatesIgnored(gitignore) {
+	return ignoresCertificates(gitignore) ? void 0 : withCertificatesLine(gitignore);
+}
+/** `.gitignore`'s text with `/certificates/` added under a comment, keeping every byte it had. */
+function withCertificatesLine(gitignore) {
+	const head = gitignore === "" || gitignore.endsWith("\n") ? gitignore : `${gitignore}\n`;
+	return `${head}${head === "" ? "" : "\n"}# The local HTTPS key and certificate of next dev --experimental-https\n/certificates/\n`;
+}
 //#endregion
 //#region src/nextjs.ts
 /**
@@ -717,7 +760,7 @@ async function init(options) {
 	const envPath = join(project.dir, ".env.local");
 	const envText = existsSync(envPath) ? readFileSync(envPath, "utf8") : "";
 	const present = synqNamesIn(envText);
-	if (present.length > 0 && !options.force) throw new InitError(`This project has Synq already: .env.local sets ${present.join(", ")}. Run ${CLI_NAME} init --force to make another development sign-in.`, "has_synq");
+	if (present.length > 0 && !options.force) throw new InitError(`This project has Synq already: .env.local sets ${present.join(", ")}. Run ${options.rerun ?? `synqauth init`} --force to make another development sign-in.`, "has_synq");
 	const made = await createClaimableOrg(apiOriginFor("synq", options.stage, options.env), {
 		name: project.name,
 		appType: "web",
@@ -753,16 +796,28 @@ async function init(options) {
 	}
 	const written = [".env.local"];
 	const run = options.run ?? runIn;
-	const gitSays = await run([
-		"git",
-		"check-ignore",
-		"-q",
-		".env.local"
-	], project.dir, { quiet: true });
 	const gitignorePath = join(project.dir, ".gitignore");
 	const gitignore = existsSync(gitignorePath) ? readFileSync(gitignorePath, "utf8") : "";
-	const ignored = gitSays === 0 ? void 0 : gitSays === 1 ? withEnvLocalLine(gitignore) : withEnvLocalIgnored(gitignore);
-	if (ignored !== void 0) {
+	let ignored = gitignore;
+	for (const [path, line, unlessIgnored] of [[
+		".env.local",
+		withEnvLocalLine,
+		withEnvLocalIgnored
+	], [
+		CERTIFICATES_KEY,
+		withCertificatesLine,
+		withCertificatesIgnored
+	]]) {
+		const gitSays = await run([
+			"git",
+			"check-ignore",
+			"-q",
+			path
+		], project.dir, { quiet: true });
+		if (gitSays === 0) continue;
+		ignored = gitSays === 1 ? line(ignored) : unlessIgnored(ignored) ?? ignored;
+	}
+	if (ignored !== gitignore) {
 		writeFileSync(gitignorePath, ignored);
 		written.push(".gitignore");
 	}
@@ -842,8 +897,23 @@ function runIn(command, cwd, { quiet = false } = {}) {
 }
 //#endregion
 //#region src/cli.ts
-const VERSION = "0.3.0";
-const HELP = `Usage: npx ${CLI_NAME} init [options]
+const VERSION = "0.4.0";
+/** How a person runs init again with an option, for each entry: `<this> --force`. */
+const RERUN = {
+	synqauth: `${CLI_NAME} init`,
+	"create-synq": "npm create synq --"
+};
+const USAGE = {
+	synqauth: `Usage: npx ${CLI_NAME} init [options]`,
+	"create-synq": `Usage: npm create synq -- [options]
+       pnpm create synq [options]
+       yarn create synq [options]
+
+With npm, options go after --, as in npm create synq -- --force.`
+};
+/** The help, in the words of the command that ran it. */
+function help(entry = "synqauth") {
+	return `${USAGE[entry]}
 
 Gives your Next.js app a working Synq sign-in, with no account: a development
 sign-in you claim later by signing up.
@@ -854,12 +924,15 @@ Options:
   --stage <s>    Which Synq: production (the default), preview, staging or local
   -h, --help     Show this
   -v, --version  Show the version`;
+}
 const console_ = {
 	out: (line) => process.stdout.write(`${line}\n`),
 	err: (line) => process.stderr.write(`${line}\n`)
 };
 async function main(argv, context = {}) {
 	const output = context.output ?? console_;
+	const entry = context.entry ?? "synqauth";
+	const HELP = help(entry);
 	let parsed;
 	try {
 		parsed = parse(argv);
@@ -872,16 +945,22 @@ async function main(argv, context = {}) {
 		output.out(VERSION);
 		return 0;
 	}
-	const [command] = parsed.positionals;
+	const [command, ...extra] = entry === "create-synq" ? ["init", ...parsed.positionals] : parsed.positionals;
 	if (parsed.values.help || command === void 0) {
 		output.out(HELP);
 		return command === void 0 && !parsed.values.help ? 2 : 0;
 	}
-	if (command !== "init" || parsed.positionals.length > 1) {
+	if (command !== "init") {
 		output.err(`${CLI_NAME} has no command "${command}".`);
 		output.err(HELP);
 		return 2;
 	}
+	if (extra.length > 0) {
+		const ran = entry === "create-synq" ? "npm create synq" : `${CLI_NAME} init`;
+		output.err(`${ran} takes options only, not "${extra.join(" ")}": run it in your Next.js app's folder.`);
+		output.err(HELP);
+		return 2;
+	}
 	const stage = parsed.values.stage;
 	if (!STAGES.includes(stage)) {
 		output.err(`--stage must be one of ${STAGES.join(", ")}.`);
@@ -896,7 +975,8 @@ async function main(argv, context = {}) {
 			install: parsed.values["no-install"] !== true,
 			version: VERSION,
 			fetch: context.fetch,
-			run: context.run
+			run: context.run,
+			rerun: RERUN[entry]
 		});
 		for (const line of summary(result)) output.out(line);
 		return result.installed === false ? 1 : 0;
@@ -947,4 +1027,4 @@ function summary(result) {
 	return lines;
 }
 //#endregion
-export { init as a, InitError as i, summary as n, SynqApiError as o, CLI_NAME as r, main as t };
+export { InitError as a, CLI_NAME as i, main as n, init as o, summary as r, SynqApiError as s, help as t };

package/dist/index.d.ts

@@ -77,6 +77,11 @@ type InitOptions = {
   run?: (command: readonly string[], cwd: string, options?: {
     quiet?: boolean;
   }) => Promise<number>;
+  /**
+   * The command that runs init again, which a hint follows with an option:
+   * `synqauth init` (the default), or `npm create synq --` when create-synq ran it.
+   */
+  rerun?: string;
   now?: () => Date;
 };
 type InitResult = {
@@ -105,6 +110,10 @@ export declare class InitError extends Error {
 export declare function init(options: InitOptions): Promise<InitResult>;
 //#endregion
 //#region src/cli.d.ts
+/** Which command ran it: `npx synqauth init`, or `npm create synq` (the create-synq package). */
+type Entry = 'synqauth' | 'create-synq';
+/** The help, in the words of the command that ran it. */
+export declare function help(entry?: Entry): string;
 type Output = {
   out: (line: string) => void;
   err: (line: string) => void;
@@ -115,8 +124,10 @@ export declare function main(argv: readonly string[], context?: {
   output?: Output;
   run?: Parameters<typeof init>[0]['run'];
   fetch?: typeof fetch;
+  /** `create-synq`: argv is init's options alone, and the help names `npm create synq`. */
+  entry?: Entry;
 }): Promise<number>;
 /** What init did, and what to do next, in the order a developer reads it. */
 export declare function summary(result: InitResult): string[];
 //#endregion
-export type { InitOptions, InitResult, Stage };
+export type { Entry, InitOptions, InitResult, Stage };

package/dist/index.js

@@ -1,2 +1,2 @@
-import { a as init, i as InitError, n as summary, o as SynqApiError, r as CLI_NAME, t as main } from "./cli-C7dDFb81.js";
-export { CLI_NAME, InitError, SynqApiError, init, main, summary };
+import { a as InitError, i as CLI_NAME, n as main, o as init, r as summary, s as SynqApiError, t as help } from "./cli-sOLw5xeI.js";
+export { CLI_NAME, InitError, SynqApiError, help, init, main, summary };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "synqauth",
-  "version": "0.3.0",
+  "version": "0.4.0",
   "description": "Synq's command line: npx synqauth init gives your Next.js app a working sign-in, with no account until you claim it.",
   "license": "MIT",
   "repository": {