@kestra-io/create-artifact-sdk 0.0.1 → 0.0.2

package/README.md

@@ -22,10 +22,8 @@ The CLI will:
 1. **Detect your plugin** — reads `settings.gradle[.kts]` to find the plugin group id (e.g. `io.kestra.plugin.redis`).
 2. **Ask which task** you want to add a custom UI for (e.g. `list.ListPop`).
 3. **Ask which UI module** to customize:
-   - `topology-details` — panel shown when a task node is selected in the topology view
+   - `topology-details` — panel shown when a task node is displayed in the topology view
    - `log-details` — panel shown in the log view for a task execution
-   - `metrics-details` — panel shown in the metrics tab for a task execution
-   - `trigger-details` — panel shown when a trigger node is selected
 4. **Show a summary** and ask for confirmation before writing anything.
 5. **Scaffold the `ui/` directory** with:
    - `package.json` (with all required dependencies)

package/bin/create.js

@@ -16,23 +16,26 @@ import pc from "picocolors";
 import path from "node:path";
 import fs from "node:fs";
 
-import { detectContext } from "../src/context.js";
-import { UI_MODULES, deriveComponentName } from "../src/modules.js";
+import { detectContext } from "@kestra-io/artifact-sdk";
 import {
-  scaffoldPackageJson,
-  scaffoldMainTs,
+  UI_MODULES,
+  deriveComponentName,
+  findKestraTasks,
+  scaffoldComponent,
+  scaffoldStory,
   scaffoldAppVue,
   scaffoldViteConfig,
-  scaffoldComponent,
+} from "@kestra-io/artifact-sdk";
+import {
+  scaffoldPackageJson,
+  scaffoldMainTs,
   scaffoldIndexHtml,
   scaffoldTsConfig,
   scaffoldStorybookMain,
   scaffoldStorybookPreview,
-  scaffoldStory,
   scaffoldGitignore,
 } from "../src/scaffold.js";
 import { npmInstall } from "../src/runner.js";
-import { findKestraTasks } from "../src/find-kestra-tasks.js";
 
 // ---------------------------------------------------------------------------
 // Helpers

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kestra-io/create-artifact-sdk",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "description": "Scaffold a Kestra plugin custom UI package",
   "keywords": [
     "kestra",
@@ -11,10 +11,10 @@
   "license": "MIT",
   "repository": {
     "type": "git",
-    "url": "https://github.com/kestra-io/artifact-sdk.git"
+    "url": "git+https://github.com/kestra-io/artifact-sdk.git"
   },
   "bin": {
-    "create-artifact-sdk": "./bin/create.js"
+    "create-artifact-sdk": "bin/create.js"
   },
   "files": [
     "bin",

package/src/scaffold.js

@@ -3,7 +3,7 @@ import path from "node:path";
 import { fileURLToPath } from "node:url";
 
 const __dirname = path.dirname(fileURLToPath(import.meta.url));
-const TEMPLATES_DIR = path.resolve(__dirname, "../templates");
+const STATIC_DIR = path.resolve(__dirname, "../templates/static");
 
 // ---------------------------------------------------------------------------
 // Internal helpers
@@ -15,30 +15,7 @@ function write(filePath, content) {
 }
 
 function readStatic(name) {
-  return fs.readFileSync(path.join(TEMPLATES_DIR, "static", name), "utf8");
-}
-
-function readDynamic(name) {
-  return fs.readFileSync(path.join(TEMPLATES_DIR, "dynamic", name), "utf8");
-}
-
-function readStarter(name) {
-  // get the root of the starters directory, which is in @kestra-io/artifact-sdk
-  const startersDir = path.dirname(
-    require.resolve("@kestra-io/artifact-sdk/starters/placeholder.txt"),
-  );
-  return fs.readFileSync(path.join(startersDir, name), "utf8");
-}
-
-/**
- * Replace all `{{key}}` placeholders in a template string with the
- * corresponding values from the `vars` object.
- */
-function render(template, vars) {
-  return template.replace(/\{\{(\w+)\}\}/g, (_, key) => {
-    if (!(key in vars)) throw new Error(`Template variable "{{${key}}}" has no value.`);
-    return vars[key];
-  });
+  return fs.readFileSync(path.join(STATIC_DIR, name), "utf8");
 }
 
 // ---------------------------------------------------------------------------
@@ -105,7 +82,30 @@ export function scaffoldTsConfig(uiDir) {
 }
 
 // ---------------------------------------------------------------------------
-// Static files — read verbatim from templates/static/
+// index.html  (inlined — single {{pluginName}} substitution)
+// ---------------------------------------------------------------------------
+
+export function scaffoldIndexHtml(uiDir, pluginName) {
+  const content = [
+    `<!doctype html>`,
+    `<html lang="en">`,
+    `  <head>`,
+    `    <meta charset="UTF-8" />`,
+    `    <meta name="viewport" content="width=device-width, initial-scale=1.0" />`,
+    `    <title>${pluginName} — Plugin UI Dev</title>`,
+    `  </head>`,
+    `  <body>`,
+    `    <div id="app"></div>`,
+    `    <script type="module" src="/src/main.ts"></script>`,
+    `  </body>`,
+    `</html>`,
+    ``,
+  ].join("\n");
+  write(path.join(uiDir, "index.html"), content);
+}
+
+// ---------------------------------------------------------------------------
+// Static files — read verbatim from templates
 // ---------------------------------------------------------------------------
 
 export function scaffoldMainTs(uiDir) {
@@ -123,72 +123,3 @@ export function scaffoldStorybookPreview(uiDir) {
 export function scaffoldGitignore(uiDir) {
   write(path.join(uiDir, ".gitignore"), readStatic("gitignore"));
 }
-
-// ---------------------------------------------------------------------------
-// Dynamic files — rendered from templates/dynamic/*.hbs
-// ---------------------------------------------------------------------------
-
-export function scaffoldAppVue(uiDir, componentName, moduleValue) {
-  const content = render(readDynamic("App.vue.hbs"), {
-    componentName,
-    moduleValue,
-  });
-  write(path.join(uiDir, "src", "App.vue"), content);
-}
-
-export function scaffoldIndexHtml(uiDir, pluginName) {
-  const content = render(readDynamic("index.html.hbs"), { pluginName });
-  write(path.join(uiDir, "index.html"), content);
-}
-
-export function scaffoldViteConfig(
-  uiDir,
-  pluginId,
-  taskType,
-  moduleValue,
-  componentName,
-  additionalProperties,
-) {
-  const hasAdditional = Object.keys(additionalProperties).length > 0;
-  const additionalPropertiesStr = hasAdditional
-    ? "\n        additionalProperties: " +
-      JSON.stringify(additionalProperties, null, 2).split("\n").join("\n        ") +
-      ","
-    : "";
-
-  const content = render(readDynamic("vite.config.ts.hbs"), {
-    pluginId,
-    taskType,
-    moduleValue,
-    componentName,
-    additionalProperties: additionalPropertiesStr,
-  });
-  write(path.join(uiDir, "vite.config.ts"), content);
-}
-
-export function scaffoldStory(uiDir, componentName, moduleValue) {
-  const content = render(readDynamic("Component.stories.ts.hbs"), {
-    componentName,
-    moduleValue,
-  });
-  write(path.join(uiDir, "src", `${componentName}.stories.ts`), content);
-}
-
-// ---------------------------------------------------------------------------
-// Component — copied from templates/starters/ with fallback
-// ---------------------------------------------------------------------------
-
-export function scaffoldComponent(uiDir, componentName, starterFile) {
-  let content;
-  try {
-    content = readStarter(starterFile);
-  } catch {
-    // Fallback used before @kestra-io/artifact-sdk is published
-    const uiType = starterFile.replace(".vue", "");
-    content = render(readDynamic("Component.fallback.vue.hbs"), {
-      componentName,
-      uiType,
-    });
-  }
-  write(path.join(uiDir, "src", "components", `${componentName}.vue`), content);
-}

package/src/context.js

@@ -1,75 +0,0 @@
-import fs from "node:fs";
-import path from "node:path";
-
-/**
- * Walk upward from `startDir` looking for a settings.gradle or settings.gradle.kts file.
- * Returns { dir, file, content } or null if not found within `maxLevels`.
- */
-function findGradleSettings(startDir, maxLevels = 2) {
-  let dir = startDir;
-  for (let i = 0; i <= maxLevels; i++) {
-    for (const name of ["settings.gradle.kts", "settings.gradle"]) {
-      const candidate = path.join(dir, name);
-      if (fs.existsSync(candidate)) {
-        return { dir, file: candidate, content: fs.readFileSync(candidate, "utf8") };
-      }
-    }
-    const parent = path.dirname(dir);
-    if (parent === dir) break; // filesystem root
-    dir = parent;
-  }
-  return null;
-}
-
-/**
- * Extract the rootProject.name value from a Gradle settings file.
- * Handles both:
- *   rootProject.name = "my-plugin"   (Groovy)
- *   rootProject.name = "my-plugin"   (KTS)
- */
-function extractPluginName(content) {
-  const match = content.match(/rootProject\.name\s*=\s*["']([^"']+)["']/);
-  return match ? match[1] : null;
-}
-
-/**
- * Derive a Java-style plugin group id from the project name.
- * e.g. "plugin-redis" → "io.kestra.plugin.redis"
- * If the name already looks like a group id, return as-is.
- */
-function derivePluginId(name) {
-  if (name.includes(".")) return name;
-  // strip leading "plugin-" or "kestra-plugin-" if present
-  const stripped = name.replace(/^(kestra-)?plugin-/i, "");
-  return `io.kestra.plugin.${stripped}`;
-}
-
-export function detectContext(cwd = process.cwd()) {
-  const gradle = findGradleSettings(cwd);
-
-  let pluginRoot = null;
-  let pluginName = null;
-  let pluginId = null;
-  let uiDirExists = false;
-  let gradleFile = null;
-
-  if (gradle) {
-    pluginRoot = gradle.dir;
-    gradleFile = gradle.file;
-    pluginName = extractPluginName(gradle.content);
-    if (pluginName) {
-      pluginId = derivePluginId(pluginName);
-    }
-    uiDirExists = fs.existsSync(path.join(pluginRoot, "ui"));
-  }
-
-  return {
-    cwd,
-    pluginRoot, // absolute path to the directory containing settings.gradle
-    gradleFile, // absolute path to the settings.gradle file
-    pluginName, // raw name from rootProject.name, e.g. "plugin-redis"
-    pluginId, // derived group id, e.g. "io.kestra.plugin.redis"
-    uiDirExists, // whether ui/ already exists in pluginRoot
-    uiDir: pluginRoot ? path.join(pluginRoot, "ui") : null,
-  };
-}

package/src/find-kestra-tasks.js

@@ -1,97 +0,0 @@
-import { readdir, readFile } from "node:fs/promises";
-import { join, extname } from "node:path";
-
-// ---------------------------------------------------------------------------
-// Heuristics (mirrors the GitHub version)
-// ---------------------------------------------------------------------------
-
-const TASK_ANNOTATIONS = [/@Plugin\s*\(/, /@Schema\s*\(/];
-
-const TASK_SUPERTYPES = [
-  /implements\s+Task\b/,
-  /extends\s+\w*(Task|Trigger|Condition)\b/,
-  /implements\s+RunnableTask/,
-  /implements\s+FlowableTask/,
-  /implements\s+TriggerInterface/,
-];
-
-const EXCLUDE = [
-  /^\s*(public\s+)?abstract\s+class/m, // abstract classes
-  /^\s*public\s+interface\s+/m, // interfaces
-  /package\s+.*\.tests?[.;]/, // test packages
-];
-
-function isTaskClass(source) {
-  if (EXCLUDE.some((re) => re.test(source))) return false;
-  return (
-    TASK_ANNOTATIONS.some((re) => re.test(source)) || TASK_SUPERTYPES.some((re) => re.test(source))
-  );
-}
-
-function extractFullClassName(source, filePath) {
-  const packageMatch = source.match(/^\s*package\s+([\w.]+)\s*;/m);
-  const pkg = packageMatch ? packageMatch[1] : null;
-  if (!pkg || !pkg.startsWith("io.kestra.plugin.")) return null;
-
-  const classMatch = source.match(/public\s+(?:final\s+)?class\s+(\w+)/);
-  const className = classMatch
-    ? classMatch[1]
-    : filePath
-        .split("/")
-        .pop()
-        .replace(/\.java$/, "");
-
-  return `${pkg}.${className}`;
-}
-
-// ---------------------------------------------------------------------------
-// Recursive .java file collector
-// ---------------------------------------------------------------------------
-
-async function collectJavaFiles(dir, results = []) {
-  const entries = await readdir(dir, { withFileTypes: true });
-  await Promise.all(
-    entries.map((entry) => {
-      const full = join(dir, entry.name);
-      if (entry.isDirectory()) return collectJavaFiles(full, results);
-      if (entry.isFile() && extname(entry.name) === ".java") results.push(full);
-    }),
-  );
-  return results;
-}
-
-// ---------------------------------------------------------------------------
-// Main exported function
-// ---------------------------------------------------------------------------
-
-/**
- * Scans a local Kestra plugin source tree and returns the class names of all
- * concrete task / trigger / condition classes found.
- *
- * @param {string} srcRoot  Path to the source root, e.g. "/path/to/plugin/src"
- *                          or the deeper Java root like "…/src/main/java".
- *                          The function accepts either — it will descend into
- *                          src/main/java automatically if `srcRoot` points at
- *                          the broader `src` directory.
- * @returns {Promise<string[]>}  Sorted array of fully-qualified class names (e.g. `io.kestra.plugin.jdbc.mysql.Query`).
- */
-export async function findKestraTasks(srcRoot) {
-  // Normalise: if the caller passed the broad `src` dir, step into main/java.
-  const javaRoot = srcRoot.endsWith("/src") ? join(srcRoot, "main", "java") : srcRoot;
-
-  const files = await collectJavaFiles(javaRoot);
-
-  const classNames = (
-    await Promise.all(
-      files.map(async (filePath) => {
-        const source = await readFile(filePath, "utf8");
-        if (!isTaskClass(source)) return null;
-        return extractFullClassName(source, filePath);
-      }),
-    )
-  )
-    .filter(Boolean)
-    .sort();
-
-  return classNames;
-}

package/src/modules.js

@@ -1,26 +0,0 @@
-import { UI_MODULES } from "@kestra-io/artifact-sdk";
-
-/**
- * Derive a PascalCase component name from a task type and a UI module.
- *
- * The task type is the short dotted form: e.g. "list.ListPop"
- * The module suffix is e.g. "TopologyDetails"
- *
- * Steps:
- *   1. Split on "." → ["list", "ListPop"]
- *   2. PascalCase each segment → ["List", "ListPop"]
- *   3. Join + append suffix → "ListListPopTopologyDetails"
- */
-export function deriveComponentName(taskType, moduleSuffix) {
-  const segments = taskType.split(".").map((s) => s.charAt(0).toUpperCase() + s.slice(1));
-  return segments.join("") + moduleSuffix;
-}
-
-/**
- * Look up a UI_MODULES entry by its value string.
- */
-export function findModule(value) {
-  return UI_MODULES[value];
-}
-
-export { UI_MODULES };

package/templates/dynamic/App.vue.hbs

@@ -1,14 +0,0 @@
-<script setup lang="ts">
-import {{componentName}} from "./components/{{componentName}}.vue";
-
-// Default props for local development — adjust to match your task's real output
-const props = {
-  // TODO: populate with realistic sample data for the "{{moduleValue}}" UI
-};
-</script>
-
-<template>
-  <div style="padding: 1rem; font-family: sans-serif">
-    <{{componentName}} v-bind="props" />
-  </div>
-</template>

package/templates/dynamic/Component.fallback.vue.hbs

@@ -1,15 +0,0 @@
-<script setup lang="ts">
-  // TODO: define props matching the "{{uiType}}" contract
-  // from @kestra-io/artifact-sdk once the SDK is published.
-  defineProps<Record<string, unknown>>();
-</script>
-
-<template>
-  <div class="kestra-custom-ui">
-    <p>✏️ Customize this component for your task.</p>
-  </div>
-</template>
-
-<style scoped>
-  .kestra-custom-ui { padding: 1rem; }
-</style>

package/templates/dynamic/Component.stories.ts.hbs

@@ -1,20 +0,0 @@
-import type { Meta, StoryObj } from "@storybook/vue3";
-import {{componentName}} from "./components/{{componentName}}.vue";
-
-const meta: Meta<typeof {{componentName}}> = {
-  title: "Plugin UI / {{moduleValue}} / {{componentName}}",
-  component: {{componentName}},
-  tags: ["autodocs"],
-  argTypes: {
-    // TODO: define argTypes matching your component's props
-  },
-};
-
-export default meta;
-type Story = StoryObj<typeof {{componentName}}>;
-
-export const Default: Story = {
-  args: {
-    // TODO: populate with realistic sample data
-  },
-};

package/templates/dynamic/index.html.hbs

@@ -1,12 +0,0 @@
-<!doctype html>
-<html lang="en">
-  <head>
-    <meta charset="UTF-8" />
-    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>{{pluginName}} — Plugin UI Dev</title>
-  </head>
-  <body>
-    <div id="app"></div>
-    <script type="module" src="/src/main.ts"></script>
-  </body>
-</html>

package/templates/dynamic/vite.config.ts.hbs

@@ -1,13 +0,0 @@
-import { defaultViteConfig } from "@kestra-io/artifact-sdk";
-
-export default defaultViteConfig({
-  plugin: "{{pluginId}}",
-  exposes: {
-    "{{taskType}}": [
-      {
-        uiModule: "{{moduleValue}}",
-        path: "./src/components/{{componentName}}.vue",{{additionalProperties}}
-      },
-    ],
-  },
-});