@termix-ssh/plugin-sdk 1.0.4 → 1.0.6

package/README.md

@@ -1,6 +1,6 @@
 <div align="center">
 
-<img src="https://raw.githubusercontent.com/Termix-SSH/Termix/main/public/icon.svg" width="120" height="120" alt="Termix Logo" />
+<img src="https://termix.site/img/logo.svg" width="120" alt="Termix Logo" />
 
 <h1>Termix Plugin SDK</h1>
 
@@ -28,6 +28,7 @@ npm install --save-dev @termix-ssh/plugin-sdk
 
 ```bash
 npx termix-plugin build                  # bundle dist/backend.js and dist/frontend.js
+npx termix-plugin patch                  # apply the plugin's dependency patches (build does this too)
 npx termix-plugin test                   # run the plugin's Vitest suite
 npx termix-plugin validate               # check manifest.json and the files it names
 npx termix-plugin openapi                # write dist/openapi.json from @openapi comments

package/cli/commands/build.mjs

@@ -108,13 +108,6 @@ const HOST_DIR = path.join(
 const THEME_CSS = path.join(HOST_DIR, "theme.css");
 const CORE_CLASSES = path.join(HOST_DIR, "core-classes.json");
 
-/**
- * Compiles the Tailwind classes the plugin's frontend uses into
- * dist/frontend.css, against the theme core ships in the SDK. Core only
- * compiles its own classes, so a class no core file happens to use would
- * otherwise have no CSS at all. Appended to whatever CSS the bundle already
- * produced (a library's stylesheet the plugin imports).
- */
 /**
  * Moves a plugin's Tailwind layers under their own names. Core orders
  * termix-plugin-utilities above its base styles and below its own utilities,
@@ -136,6 +129,13 @@ function readCoreClasses() {
   return new Set(JSON.parse(fs.readFileSync(CORE_CLASSES, "utf8")));
 }
 
+/**
+ * Compiles the Tailwind classes the plugin's frontend uses into
+ * dist/frontend.css, against the theme core ships in the SDK. Core only
+ * compiles its own classes, so a class no core file happens to use would
+ * otherwise have no CSS at all. Appended to whatever CSS the bundle already
+ * produced (a library's stylesheet the plugin imports).
+ */
 export async function buildTailwind(cwd, outDir) {
   const { compile, optimize } = await import("@tailwindcss/node");
   const { Scanner } = await import("@tailwindcss/oxide");

package/cli/commands/migrations.mjs

@@ -17,7 +17,7 @@
 
 import fs from "node:fs";
 import path from "node:path";
-import { fileURLToPath } from "node:url";
+import { fileURLToPath, pathToFileURL } from "node:url";
 import * as esbuild from "esbuild";
 import { BACKEND_EXTERNALS } from "../lib/externals.mjs";
 import { readManifest, resolveEntry } from "../lib/plugin-dir.mjs";
@@ -53,7 +53,7 @@ async function loadDefinitions(cwd) {
       external: BACKEND_EXTERNALS,
     });
 
-    const module = await import(`file://${outfile.split(path.sep).join("/")}`);
+    const module = await import(pathToFileURL(outfile).href);
     const tables = module.tables ?? module.default;
     if (!Array.isArray(tables)) {
       throw new Error(

package/cli/commands/validate.mjs

@@ -218,6 +218,11 @@ async function validateMigrations(cwd, pluginId) {
   const present = DIALECTS.filter((dialect) =>
     fs.existsSync(path.join(root, dialect)),
   );
+  for (const dialect of DIALECTS) {
+    if (present.length > 0 && !present.includes(dialect)) {
+      problems.push(`migrations/${dialect} is missing`);
+    }
+  }
 
   const byDialect = new Map();
   for (const dialect of present) {

package/dist/changelog.d.ts

@@ -52,7 +52,9 @@ export declare function parseChangelog(markdown: string): {
 };
 /**
  * Checks a CHANGELOG.md. With a manifest version, the newest release has to
- * be that version, so a release never ships without its notes.
+ * be that version, so a release never ships without its notes. A beta like
+ * 1.1.0-beta.2 gets its notes from git, so it only needs the newest release
+ * to be 1.1.0 or older.
  */
 export declare function validateChangelog(markdown: string, manifestVersion?: string): string[];
 /**

package/dist/changelog.js

@@ -145,7 +145,9 @@ export function parseChangelog(markdown) {
 }
 /**
  * Checks a CHANGELOG.md. With a manifest version, the newest release has to
- * be that version, so a release never ships without its notes.
+ * be that version, so a release never ships without its notes. A beta like
+ * 1.1.0-beta.2 gets its notes from git, so it only needs the newest release
+ * to be 1.1.0 or older.
  */
 export function validateChangelog(markdown, manifestVersion) {
     const { changelog, problems } = parseChangelog(markdown);
@@ -154,7 +156,15 @@ export function validateChangelog(markdown, manifestVersion) {
         return problems;
     }
     const newest = changelog.releases[0].version;
-    if (manifestVersion && newest !== manifestVersion) {
+    const base = manifestVersion
+        ? semver.valid(semver.coerce(manifestVersion))
+        : null;
+    const betaOk = !!manifestVersion &&
+        !!semver.prerelease(manifestVersion) &&
+        !!base &&
+        !!semver.valid(newest) &&
+        semver.lte(newest, base);
+    if (manifestVersion && newest !== manifestVersion && !betaOk) {
         problems.push(`the newest release is ${newest}, but the manifest version is ${manifestVersion}`);
     }
     return problems;

package/dist/db.d.ts

@@ -37,7 +37,7 @@ interface Builder<T extends PluginColumn = PluginColumn> {
 }
 /** Auto-incrementing surrogate key: integer on sqlite, serial, auto_increment. */
 export declare const id: () => Builder<PluginColumn>;
-/** Unbounded string. Never indexable: MySQL cannot index TEXT. */
+/** Unbounded string, LONGTEXT on MySQL. Never indexable: MySQL cannot index TEXT. */
 export declare const text: () => Builder<PluginColumn>;
 /** Bounded string. Indexable on every engine. */
 export declare const varchar: (length?: number) => Builder<PluginColumn>;

package/dist/db.js

@@ -28,7 +28,7 @@ function builder(column) {
 }
 /** Auto-incrementing surrogate key: integer on sqlite, serial, auto_increment. */
 export const id = () => builder({ type: "id", primaryKey: true, notNull: true });
-/** Unbounded string. Never indexable: MySQL cannot index TEXT. */
+/** Unbounded string, LONGTEXT on MySQL. Never indexable: MySQL cannot index TEXT. */
 export const text = () => builder({ type: "text" });
 /** Bounded string. Indexable on every engine. */
 export const varchar = (length = KEY_LENGTH) => builder({ type: "varchar", length });

package/dist/ddl.js

@@ -67,10 +67,13 @@ function columnType(dialect, column, keyed) {
             // text/json column, so in practice this only catches a primary key.
             if (keyed && dialect !== "sqlite")
                 return `varchar(${KEY_LENGTH})`;
+            // MySQL TEXT stops at 64KB, so free text, json and secrets go long.
+            if (dialect === "mysql" && column.type !== "timestamp")
+                return "longtext";
             return "text";
     }
 }
-/** Column types that are TEXT on MySQL when nothing keys them. */
+/** Column types that are TEXT or LONGTEXT on MySQL when nothing keys them. */
 const TEXT_ON_MYSQL = new Set([
     "text",
     "json",