create-nevela 0.1.2 → 0.1.4

package/template/laravel/src/Support/Releases.php

@@ -0,0 +1,45 @@
+<?php
+
+namespace Nevela\Laravel\Support;
+
+use Illuminate\Support\Facades\Http;
+use Throwable;
+
+/** What Packagist knows about nevela/laravel. */
+final class Releases
+{
+    private static string|null|false $latest = false;
+
+    /** The newest stable release, or null when Packagist can't be reached. Asked once per run. */
+    public static function latest(): ?string
+    {
+        if (self::$latest !== false) {
+            return self::$latest;
+        }
+        try {
+            $releases = Http::timeout(8)->get('https://repo.packagist.org/p2/nevela/laravel.json')->json('packages.nevela/laravel') ?? [];
+        } catch (Throwable) {
+            return self::$latest = null;
+        }
+
+        return self::$latest = self::newest(array_map(fn ($release) => (string) ($release['version'] ?? ''), $releases));
+    }
+
+    /**
+     * The highest x.y.z in a list of version names. Branches and pre-releases don't count.
+     *
+     * @param  list<string>  $names
+     */
+    public static function newest(array $names): ?string
+    {
+        $versions = [];
+        foreach ($names as $name) {
+            if (preg_match('/^v?(\d+\.\d+\.\d+)$/', $name, $m)) {
+                $versions[] = $m[1];
+            }
+        }
+        usort($versions, 'version_compare');
+
+        return $versions === [] ? null : end($versions);
+    }
+}

package/template/laravel/src/Support/TemplateSource.php

@@ -0,0 +1,144 @@
+<?php
+
+namespace Nevela\Laravel\Support;
+
+use Illuminate\Support\Facades\Http;
+use PharData;
+use RecursiveDirectoryIterator;
+use RecursiveIteratorIterator;
+use RuntimeException;
+use Throwable;
+
+/**
+ * The dashboard as it shipped in a given version of Nevela.
+ *
+ * Tried in order, so an update never depends on one place being up to date:
+ *
+ * 1. NEVELA_TEMPLATE_DIR, a folder of create-nevela-<version>.tgz files. For working on
+ *    Nevela itself, and for updating without a connection.
+ * 2. The create-nevela package on npm, which carries the dashboard.
+ * 3. The repository's own tag on GitHub. Tags are pushed before anything is published,
+ *    so this works in the gap between a release and its npm package.
+ */
+final class TemplateSource
+{
+    private const NPM = 'https://registry.npmjs.org/create-nevela/-/create-nevela-%s.tgz';
+
+    private const GITHUB = 'https://codeload.github.com/MarkColeMukisa/nevela/tar.gz/refs/tags/v%s';
+
+    /** Never part of an app's dashboard: build output, installs and local settings. */
+    private const NEVER = ['node_modules', '.next', '.env.local', 'tsconfig.tsbuildinfo', 'next-env.d.ts'];
+
+    /**
+     * @return array{files: array<string, string>, from: string} path => contents, and where it came from
+     */
+    public static function fetch(string $version): array
+    {
+        $dir = rtrim(sys_get_temp_dir(), '/\\').DIRECTORY_SEPARATOR.'nevela-template-'.$version.'-'.bin2hex(random_bytes(4));
+        mkdir($dir, 0775, true);
+        $archive = $dir.DIRECTORY_SEPARATOR.'template.tgz';
+        $tried = [];
+
+        try {
+            $local = rtrim((string) env('NEVELA_TEMPLATE_DIR', ''), '/\\');
+            if ($local !== '' && is_file("{$local}/create-nevela-{$version}.tgz")) {
+                copy("{$local}/create-nevela-{$version}.tgz", $archive);
+
+                return ['files' => self::read($archive, $dir, 'package/template/web', false), 'from' => 'NEVELA_TEMPLATE_DIR'];
+            }
+
+            foreach (['npm' => [self::NPM, 'package/template/web', false], 'GitHub' => [self::GITHUB, "nevela-{$version}/apps/web", true]] as $name => [$url, $root, $filter]) {
+                try {
+                    $response = Http::timeout(60)->get(sprintf($url, $version));
+                    if (! $response->successful()) {
+                        $tried[] = "{$name}: HTTP {$response->status()}";
+
+                        continue;
+                    }
+                    file_put_contents($archive, $response->body());
+
+                    return ['files' => self::read($archive, $dir.DIRECTORY_SEPARATOR.strtolower($name), $root, $filter), 'from' => $name];
+                } catch (Throwable $e) {
+                    $tried[] = "{$name}: ".$e->getMessage();
+                }
+            }
+
+            throw new RuntimeException("version {$version} was not found (".implode('; ', $tried).')');
+        } finally {
+            self::remove($dir);
+        }
+    }
+
+    /**
+     * Unpack an archive and read the dashboard out of it.
+     *
+     * @param  bool  $filter  Whether this is the repository's own apps/web, whose example resources aren't part of the template
+     * @return array<string, string>
+     */
+    private static function read(string $archive, string $into, string $root, bool $filter): array
+    {
+        if (! is_dir($into)) {
+            mkdir($into, 0775, true);
+        }
+        (new PharData($archive))->extractTo($into, null, true);
+        $base = $into.DIRECTORY_SEPARATOR.str_replace('/', DIRECTORY_SEPARATOR, $root);
+        if (! is_dir($base)) {
+            throw new RuntimeException('the archive has no dashboard in it');
+        }
+
+        $files = [];
+        foreach (new RecursiveIteratorIterator(new RecursiveDirectoryIterator($base, RecursiveDirectoryIterator::SKIP_DOTS)) as $file) {
+            $path = str_replace('\\', '/', substr($file->getPathname(), strlen($base) + 1));
+            if (array_intersect(explode('/', $path), self::NEVER) !== []) {
+                continue;
+            }
+            // npm can't carry .gitignore files, so its template holds them as _gitignore.
+            $path = preg_replace('#(^|/)_gitignore$#', '$1.gitignore', $path);
+            $files[$path] = (string) file_get_contents($file->getPathname());
+        }
+
+        return $filter ? self::withoutExamples($files) : $files;
+    }
+
+    /**
+     * The repository's dashboard has example resources in it (a Product, say). They are
+     * generated from Laravel, not part of what a new app is given.
+     *
+     * @param  array<string, string>  $files
+     * @return array<string, string>
+     */
+    public static function withoutExamples(array $files): array
+    {
+        $slugs = [];
+        foreach ($files as $path => $contents) {
+            if (preg_match('#^resources/[^/]+\.resource\.ts$#', $path) && preg_match('/slug:\s*"([^"]+)"/', $contents, $m)) {
+                $slugs[] = $m[1];
+            }
+        }
+
+        return array_filter($files, function (string $path) use ($slugs) {
+            if (preg_match('#^resources/[^/]+\.resource\.ts$#', $path) || $path === 'resources/index.ts') {
+                return false;
+            }
+            foreach ($slugs as $slug) {
+                if (str_starts_with($path, "app/dashboard/{$slug}/")) {
+                    return false;
+                }
+            }
+
+            return true;
+        }, ARRAY_FILTER_USE_KEY);
+    }
+
+    private static function remove(string $dir): void
+    {
+        if (! is_dir($dir)) {
+            return;
+        }
+        $items = new RecursiveIteratorIterator(new RecursiveDirectoryIterator($dir, RecursiveDirectoryIterator::SKIP_DOTS), RecursiveIteratorIterator::CHILD_FIRST);
+        foreach ($items as $item) {
+            $item->isDir() ? @rmdir($item->getPathname()) : @unlink($item->getPathname());
+        }
+        @rmdir($dir);
+    }
+}

package/template/web/app/auth-actions.ts

@@ -1,7 +1,7 @@
 "use server";
 
 import { cookies } from "next/headers";
-import { laravel, TOKEN_COOKIE } from "@/lib/laravel";
+import { API_URL, laravel, TOKEN_COOKIE } from "@/lib/laravel";
 
 export type SignInResult = { ok: true } | { ok: false; error: string };
 
@@ -17,12 +17,20 @@ export async function signInAction(email: string, password: string): Promise<Sig
   try {
     response = await laravel("auth/token", { method: "POST", body: { email, password }, token: null });
   } catch {
-    return { ok: false, error: "Can't reach the server. Check that the Laravel app is running." };
+    return { ok: false, error: `Can't reach the server at ${API_URL}. Start it with: php nevela dev` };
   }
   if (!response.ok) {
-    const body = (response.body ?? {}) as { error?: string; issues?: { message: string }[] };
+    const body = (response.body ?? {}) as { error?: string; message?: string; issues?: { message: string }[] };
     if (response.status === 429) return { ok: false, error: "Too many attempts. Wait a minute and try again." };
-    return { ok: false, error: body.issues?.[0]?.message ?? body.error ?? "Sign-in failed. Try again." };
+    if (response.status === 404 || response.status === 405) {
+      // Something answered, but it has no sign-in route: it isn't this app's API. Usually
+      // another program already had the port when the API was started.
+      return {
+        ok: false,
+        error: `${API_URL} is answered by a different program, not this app's API. Stop what is using that port, or start both with "php nevela dev", which picks a free one.`,
+      };
+    }
+    return { ok: false, error: body.issues?.[0]?.message ?? body.error ?? body.message ?? "Sign-in failed. Try again." };
   }
 
   const { token } = response.body as { token: string };

package/template/web/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nevela-web",
-  "version": "0.1.2",
+  "version": "0.1.4",
   "private": true,
   "type": "module",
   "scripts": {

package/template.mjs

@@ -1,94 +1,127 @@
-// Where the new app's files come from.
-//
-// Published to npm, this package carries a `template/` folder built by build-template.mjs.
-// Run from the repository, it reads apps/web and packages/laravel directly, so there is
-// one source for the dashboard and nothing to keep in sync by hand.
-
-import fs from 'node:fs';
-import path from 'node:path';
-import { fileURLToPath } from 'node:url';
-
-const here = path.dirname(fileURLToPath(import.meta.url));
-const bundled = path.join(here, 'template');
-const fromRepo = !fs.existsSync(bundled);
-
-export const sources = {
-  web: fromRepo ? path.resolve(here, '..', '..', 'apps', 'web') : path.join(bundled, 'web'),
-  laravel: fromRepo ? path.resolve(here, '..', 'laravel') : path.join(bundled, 'laravel'),
-};
-
-/** Never part of a new app: build output, installs and local settings. */
-const NEVER = new Set(['node_modules', '.next', '.env.local', 'tsconfig.tsbuildinfo', 'next-env.d.ts', 'vendor', '.phpunit.result.cache', '.phpunit.cache', 'composer.lock']);
-
-function copyTree(from, to, skip = () => false, relative = '') {
-  fs.mkdirSync(to, { recursive: true });
-  for (const entry of fs.readdirSync(from, { withFileTypes: true })) {
-    const inside = relative ? `${relative}/${entry.name}` : entry.name;
-    if (NEVER.has(entry.name) || skip(inside, entry)) continue;
-    const source = path.join(from, entry.name);
-    // npm leaves .gitignore files out of a published package, so the bundled template
-    // carries them as _gitignore (see buildTemplate) and they get their name back here.
-    const target = path.join(to, entry.name === '_gitignore' ? '.gitignore' : entry.name);
-    if (entry.isDirectory()) copyTree(source, target, skip, inside);
-    else if (entry.isFile()) fs.copyFileSync(source, target);
-  }
-}
-
-/**
- * What belongs to the framework repository's own example resources, not to a new app:
- * their descriptors, the registry that lists them, and their dashboard pages.
- */
-export function exampleResourceFilter(webRoot) {
-  const resources = path.join(webRoot, 'resources');
-  const slugs = new Set();
-  if (fs.existsSync(resources)) {
-    for (const file of fs.readdirSync(resources)) {
-      if (!file.endsWith('.resource.ts')) continue;
-      const slug = /slug:\s*"([^"]+)"/.exec(fs.readFileSync(path.join(resources, file), 'utf8'));
-      if (slug) slugs.add(slug[1]);
-    }
-  }
-  return (inside) =>
-    /^resources\/[^/]+\.resource\.ts$/.test(inside)
-    || inside === 'resources/index.ts'
-    || [...slugs].some((slug) => inside === `app/dashboard/${slug}`);
-}
-
-/** The dashboard, without the repository's example resources, named for the new app. */
-export function copyWebTemplate(to, { name, title }) {
-  copyTree(sources.web, to, exampleResourceFilter(sources.web));
-
-  const packageFile = path.join(to, 'package.json');
-  const manifest = JSON.parse(fs.readFileSync(packageFile, 'utf8'));
-  manifest.name = `${name}-web`;
-  fs.writeFileSync(packageFile, `${JSON.stringify(manifest, null, 2)}\n`);
-
-  const siteFile = path.join(to, 'lib', 'site.ts');
-  const site = fs.readFileSync(siteFile, 'utf8')
-    .replace('name: "Nevela"', `name: ${JSON.stringify(title)}`)
-    .replace('description: "Nevela keeps', `description: "${title.replace(/"/g, '')} keeps`);
-  fs.writeFileSync(siteFile, site);
-
-  // The generator fills this in; it has to exist for the first build.
-  fs.mkdirSync(path.join(to, 'resources'), { recursive: true });
-}
-
-/** The Laravel package, for installing by path until it is on Packagist. */
-export function copyLaravelPackage(to) {
-  copyTree(sources.laravel, to, (inside) => inside === 'tests' || inside === 'phpunit.xml');
-}
-
-/** Used by build-template.mjs: the same filtered copies, into this package's template/. */
-export function buildTemplate(to) {
-  copyTree(sources.web, path.join(to, 'web'), exampleResourceFilter(sources.web));
-  copyLaravelPackage(path.join(to, 'laravel'));
-  hideGitignores(to);
-}
-
-function hideGitignores(dir) {
-  for (const entry of fs.readdirSync(dir, { withFileTypes: true })) {
-    const full = path.join(dir, entry.name);
-    if (entry.isDirectory()) hideGitignores(full);
-    else if (entry.name === '.gitignore') fs.renameSync(full, path.join(dir, '_gitignore'));
-  }
-}
+// Where the new app's files come from.
+//
+// Published to npm, this package carries a `template/` folder built by build-template.mjs.
+// Run from the repository, it reads apps/web and packages/laravel directly, so there is
+// one source for the dashboard and nothing to keep in sync by hand.
+
+import crypto from 'node:crypto';
+import fs from 'node:fs';
+import path from 'node:path';
+import { fileURLToPath } from 'node:url';
+
+const here = path.dirname(fileURLToPath(import.meta.url));
+const bundled = path.join(here, 'template');
+// In a checkout the dashboard two folders up is the source, even when a template/ folder
+// is lying around from an earlier `npm pack`: that copy may be stale.
+const fromRepo = fs.existsSync(path.resolve(here, '..', '..', 'apps', 'web', 'package.json')) || !fs.existsSync(bundled);
+
+/** True when this is a checkout of the repository rather than the package from npm. */
+export const fromRepository = fromRepo;
+
+export const sources = {
+  web: fromRepo ? path.resolve(here, '..', '..', 'apps', 'web') : path.join(bundled, 'web'),
+  laravel: fromRepo ? path.resolve(here, '..', 'laravel') : path.join(bundled, 'laravel'),
+};
+
+/** Never part of a new app: build output, installs and local settings. */
+const NEVER = new Set(['node_modules', '.next', '.env.local', 'tsconfig.tsbuildinfo', 'next-env.d.ts', 'vendor', '.phpunit.result.cache', '.phpunit.cache', 'composer.lock']);
+
+function copyTree(from, to, skip = () => false, relative = '') {
+  fs.mkdirSync(to, { recursive: true });
+  for (const entry of fs.readdirSync(from, { withFileTypes: true })) {
+    const inside = relative ? `${relative}/${entry.name}` : entry.name;
+    if (NEVER.has(entry.name) || skip(inside, entry)) continue;
+    const source = path.join(from, entry.name);
+    // npm leaves .gitignore files out of a published package, so the bundled template
+    // carries them as _gitignore (see buildTemplate) and they get their name back here.
+    const target = path.join(to, entry.name === '_gitignore' ? '.gitignore' : entry.name);
+    if (entry.isDirectory()) copyTree(source, target, skip, inside);
+    else if (entry.isFile()) fs.copyFileSync(source, target);
+  }
+}
+
+/**
+ * What belongs to the framework repository's own example resources, not to a new app:
+ * their descriptors, the registry that lists them, and their dashboard pages.
+ */
+export function exampleResourceFilter(webRoot) {
+  const resources = path.join(webRoot, 'resources');
+  const slugs = new Set();
+  if (fs.existsSync(resources)) {
+    for (const file of fs.readdirSync(resources)) {
+      if (!file.endsWith('.resource.ts')) continue;
+      const slug = /slug:\s*"([^"]+)"/.exec(fs.readFileSync(path.join(resources, file), 'utf8'));
+      if (slug) slugs.add(slug[1]);
+    }
+  }
+  return (inside) =>
+    /^resources\/[^/]+\.resource\.ts$/.test(inside)
+    || inside === 'resources/index.ts'
+    || [...slugs].some((slug) => inside === `app/dashboard/${slug}`);
+}
+
+/** The dashboard, without the repository's example resources, named for the new app. */
+export function copyWebTemplate(to, { name, title }) {
+  copyTree(sources.web, to, exampleResourceFilter(sources.web));
+
+  const packageFile = path.join(to, 'package.json');
+  const manifest = JSON.parse(fs.readFileSync(packageFile, 'utf8'));
+  manifest.name = `${name}-web`;
+  fs.writeFileSync(packageFile, `${JSON.stringify(manifest, null, 2)}\n`);
+
+  const siteFile = path.join(to, 'lib', 'site.ts');
+  const site = fs.readFileSync(siteFile, 'utf8')
+    .replace('name: "Nevela"', `name: ${JSON.stringify(title)}`)
+    .replace('description: "Nevela keeps', `description: "${title.replace(/"/g, '')} keeps`);
+  fs.writeFileSync(siteFile, site);
+
+  // The generator fills this in; it has to exist for the first build.
+  fs.mkdirSync(path.join(to, 'resources'), { recursive: true });
+}
+
+/**
+ * A fingerprint of every template file, and the template's dependencies: what the app
+ * records in .nevela.json so that `nevela update` can tell, later and exactly, which
+ * files the developer changed. The same fingerprint the Laravel package computes: SHA-1
+ * with line endings ignored.
+ */
+export function templateRecord(version) {
+  const skip = exampleResourceFilter(sources.web);
+  const files = {};
+  const walk = (dir, relative = '') => {
+    for (const entry of fs.readdirSync(dir, { withFileTypes: true })) {
+      const inside = relative ? `${relative}/${entry.name}` : entry.name;
+      if (NEVER.has(entry.name) || skip(inside, entry)) continue;
+      if (entry.isDirectory()) walk(path.join(dir, entry.name), inside);
+      else if (entry.isFile()) {
+        const bytes = fs.readFileSync(path.join(dir, entry.name)).toString('latin1').replace(/\r\n/g, '\n');
+        files[inside.replace(/(^|\/)_gitignore$/, '$1.gitignore')] = crypto.createHash('sha1').update(bytes, 'latin1').digest('hex');
+      }
+    }
+  };
+  walk(sources.web);
+  const manifest = JSON.parse(fs.readFileSync(path.join(sources.web, 'package.json'), 'utf8'));
+  const dependencies = {};
+  for (const section of ['dependencies', 'devDependencies']) if (manifest[section]) dependencies[section] = manifest[section];
+  return { template: version, files: Object.fromEntries(Object.entries(files).sort(([a], [b]) => a.localeCompare(b))), dependencies };
+}
+
+/** The Laravel package, for installing by path until it is on Packagist. */
+export function copyLaravelPackage(to) {
+  copyTree(sources.laravel, to, (inside) => inside === 'tests' || inside === 'phpunit.xml');
+}
+
+/** Used by build-template.mjs: the same filtered copies, into this package's template/. */
+export function buildTemplate(to) {
+  copyTree(sources.web, path.join(to, 'web'), exampleResourceFilter(sources.web));
+  copyLaravelPackage(path.join(to, 'laravel'));
+  hideGitignores(to);
+}
+
+function hideGitignores(dir) {
+  for (const entry of fs.readdirSync(dir, { withFileTypes: true })) {
+    const full = path.join(dir, entry.name);
+    if (entry.isDirectory()) hideGitignores(full);
+    else if (entry.name === '.gitignore') fs.renameSync(full, path.join(dir, '_gitignore'));
+  }
+}