@grafana/sign-plugin 3.1.0-canary.698.89df8be.0 → 3.1.0

package/CHANGELOG.md

@@ -1,3 +1,88 @@
+# v3.1.0 (Thu Mar 13 2025)
+
+#### 🚀 Enhancement
+
+- Feature: Consistent CLI output [#1597](https://github.com/grafana/plugin-tools/pull/1597) ([@jackw](https://github.com/jackw))
+
+#### Authors: 1
+
+- Jack Westbrook ([@jackw](https://github.com/jackw))
+
+---
+
+# v3.0.8 (Thu Jan 09 2025)
+
+#### 🐛 Bug Fix
+
+- Sign Plugin: Remove console.log on failed version check [#1444](https://github.com/grafana/plugin-tools/pull/1444) ([@jackw](https://github.com/jackw))
+
+#### Authors: 1
+
+- Jack Westbrook ([@jackw](https://github.com/jackw))
+
+---
+
+# v3.0.5 (Wed Dec 11 2024)
+
+#### 🐛 Bug Fix
+
+- fix(deps): update dependency proxy-agent to v6.5.0 [#1387](https://github.com/grafana/plugin-tools/pull/1387) ([@renovate[bot]](https://github.com/renovate[bot]))
+
+#### Authors: 1
+
+- [@renovate[bot]](https://github.com/renovate[bot])
+
+---
+
+# v3.0.4 (Wed Sep 25 2024)
+
+#### 🐛 Bug Fix
+
+- Feat: Adding provenance publish config [#1127](https://github.com/grafana/plugin-tools/pull/1127) ([@tolzhabayev](https://github.com/tolzhabayev))
+
+#### Authors: 1
+
+- Timur Olzhabayev ([@tolzhabayev](https://github.com/tolzhabayev))
+
+---
+
+# v3.0.3 (Tue Jul 09 2024)
+
+#### 🐛 Bug Fix
+
+- Adjust license text [#994](https://github.com/grafana/plugin-tools/pull/994) ([@academo](https://github.com/academo))
+
+#### Authors: 1
+
+- Esteban Beltran ([@academo](https://github.com/academo))
+
+---
+
+# v3.0.2 (Tue May 14 2024)
+
+#### 🐛 Bug Fix
+
+- Chore(deps): Bump proxy-agent from 6.3.1 to 6.4.0 [#792](https://github.com/grafana/plugin-tools/pull/792) ([@dependabot[bot]](https://github.com/dependabot[bot]))
+
+#### Authors: 1
+
+- [@dependabot[bot]](https://github.com/dependabot[bot])
+
+---
+
+# v3.0.1 (Thu Jan 25 2024)
+
+#### 🐛 Bug Fix
+
+- Build: Migrate plugin-e2e to Vitest and use tsconfigs/base configs [#694](https://github.com/grafana/plugin-tools/pull/694) ([@jackw](https://github.com/jackw) [@sunker](https://github.com/sunker))
+
+#### Authors: 2
+
+- Erik Sundell ([@sunker](https://github.com/sunker))
+- Jack Westbrook ([@jackw](https://github.com/jackw))
+
+---
+
 # v3.0.0 (Tue Jan 16 2024)
 
 #### 💥 Breaking Change

package/LICENSE

@@ -186,7 +186,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright [yyyy] [name of copyright owner]
+   Copyright 2024 Grafana Labs
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

package/README.md

@@ -48,7 +48,7 @@ In your plugin directory, run the following to create a MANIFEST.txt file in the
 npx @grafana/sign-plugin@latest --rootUrls https://example.com/grafana
 ```
 
-Alterntives:
+Alternatives:
 
 #### [`npx`](https://github.com/npm/npx)
 

package/dist/bin/run.js

@@ -1,11 +1,26 @@
 #!/usr/bin/env node
-import minimist from 'minimist';
-import { sign, version } from '../commands/index.js';
-const args = process.argv.slice(2);
-const argv = minimist(args);
-const commands = {
-    sign,
-    version,
+import "../chunk-5G4NZZCD.js";
+import {
+  sign
+} from "../chunk-MBEAHLAV.js";
+import {
+  version
+} from "../chunk-H643NG2Y.js";
+import "../chunk-KUNFRRHT.js";
+import "../chunk-RWF366QA.js";
+import "../chunk-CCIR4QK3.js";
+import "../chunk-JZ2A43R6.js";
+import "../chunk-W6EFWLCZ.js";
+import "../chunk-2Y3K42NH.js";
+import "../chunk-3RG5ZIWI.js";
+
+// src/bin/run.ts
+import minimist from "minimist";
+var args = process.argv.slice(2);
+var argv = minimist(args);
+var commands = {
+  sign,
+  version
 };
-const command = commands[argv._[0]] || commands.sign;
+var command = commands[argv._[0]] || commands.sign;
 command(argv);

package/dist/chunk-2Y3K42NH.js

@@ -0,0 +1,41 @@
+// src/utils/request.ts
+import https from "node:https";
+import { URL } from "node:url";
+import { ProxyAgent } from "proxy-agent";
+var agent = new ProxyAgent();
+async function postData(urlString, data, headers) {
+  return new Promise((resolve, reject) => {
+    const url = new URL(urlString);
+    const postData2 = JSON.stringify(data);
+    const options = {
+      hostname: url.hostname,
+      port: url.port || 443,
+      path: url.pathname,
+      method: "POST",
+      headers: {
+        ...headers,
+        "Content-Type": "application/json"
+      },
+      agent
+    };
+    const req = https.request(options, (res) => {
+      const chunks = [];
+      res.on("data", (chunk) => chunks.push(chunk));
+      res.on("end", () => {
+        const results = Buffer.concat(chunks);
+        resolve({
+          data: results.toString(),
+          status: res.statusCode ?? 200
+        });
+      });
+      res.on("error", reject);
+    });
+    req.on("error", reject);
+    req.write(postData2);
+    req.end();
+  });
+}
+
+export {
+  postData
+};

package/dist/chunk-3RG5ZIWI.js

@@ -0,0 +1,10 @@
+var __require = /* @__PURE__ */ ((x) => typeof require !== "undefined" ? require : typeof Proxy !== "undefined" ? new Proxy(x, {
+  get: (a, b) => (typeof require !== "undefined" ? require : a)[b]
+}) : x)(function(x) {
+  if (typeof require !== "undefined") return require.apply(this, arguments);
+  throw Error('Dynamic require of "' + x + '" is not supported');
+});
+
+export {
+  __require
+};

package/dist/chunk-CCIR4QK3.js

@@ -0,0 +1,140 @@
+import {
+  CURRENT_APP_VERSION
+} from "./chunk-JZ2A43R6.js";
+
+// ../../libs/output/src/index.mts
+import chalk from "chalk";
+import { EOL } from "os";
+function isCI() {
+  return process.env.CI && process.env.CI !== "false" || // Drone CI plus others
+  process.env.GITHUB_ACTIONS === "true";
+}
+if (isCI()) {
+  chalk.level = 0;
+}
+var Output = class {
+  appName;
+  appVersion;
+  constructor(name, version) {
+    this.appName = name;
+    this.appVersion = version;
+  }
+  write(str) {
+    process.stdout.write(str);
+  }
+  get separator() {
+    let separator = "";
+    for (let i = 0; i < process.stdout.columns - 1; i++) {
+      separator += "\u2014";
+    }
+    return separator;
+  }
+  addHorizontalLine(color) {
+    const separator = chalk.dim[color](this.separator);
+    this.write(`${separator}${EOL}`);
+  }
+  addNewLine() {
+    this.write(EOL);
+  }
+  writeTitle(color, title, withPrefix = true) {
+    if (withPrefix) {
+      this.write(`${this.addPrefix(color, title)}${EOL}`);
+    } else {
+      this.write(`${title}${EOL}`);
+    }
+  }
+  getStatusIcon(taskStatus) {
+    switch (taskStatus) {
+      case "success":
+        return chalk.green("\u2713");
+      case "failure":
+        return chalk.red("\u2A2F");
+      case "skipped":
+        return chalk.yellow("\u2212");
+    }
+  }
+  addPrefix(color, text) {
+    const namePrefix = chalk.reset.inverse.bold[color](` ${this.appName} `);
+    if (!this.appVersion) {
+      return `${namePrefix} ${text}`;
+    }
+    const nameAndVersionPrefix = chalk.reset.inverse.bold[color](` ${this.appName}@${this.appVersion} `);
+    return `${nameAndVersionPrefix} ${text}`;
+  }
+  writeBody(body) {
+    if (!body) {
+      return;
+    }
+    this.addNewLine();
+    body.forEach((line) => {
+      this.write(`${line}${EOL}`);
+    });
+  }
+  error({
+    title,
+    body,
+    link,
+    withPrefix = true
+  }) {
+    this.addNewLine();
+    this.writeTitle("red", chalk.red.bold(title), withPrefix);
+    this.writeBody(body);
+    if (link) {
+      this.addNewLine();
+      this.write(`${chalk.gray("Learn more about this error: ")}
+  ${chalk.cyan(link)}`);
+    }
+    this.addNewLine();
+  }
+  warning({
+    title,
+    body,
+    link,
+    withPrefix = true
+  }) {
+    this.addNewLine();
+    this.writeTitle("yellow", chalk.yellow.bold(title), withPrefix);
+    this.writeBody(body);
+    if (link) {
+      this.addNewLine();
+      this.write(`${chalk.gray("Learn more about this warning: ")}
+  ${this.formatUrl(link)}`);
+    }
+    this.addNewLine();
+  }
+  success({ title, body, withPrefix = true }) {
+    this.addNewLine();
+    this.writeTitle("green", chalk.green.bold(title), withPrefix);
+    this.writeBody(body);
+    this.addNewLine();
+  }
+  log({ title, body, withPrefix = true }) {
+    this.addNewLine();
+    this.writeTitle("cyan", chalk.cyan.bold(title), withPrefix);
+    this.writeBody(body);
+    this.addNewLine();
+  }
+  bulletList(list) {
+    return list.map((item) => {
+      return ` \u2022 ${item}`;
+    });
+  }
+  formatCode(code) {
+    return chalk.italic.cyan(code);
+  }
+  formatUrl(url) {
+    return chalk.reset.blue.underline(url);
+  }
+  statusList(status, list) {
+    return list.map((item) => {
+      return ` ${this.getStatusIcon(status)} ${item}`;
+    });
+  }
+};
+
+// src/utils/utils.output.ts
+var output = new Output("sign-plugin", CURRENT_APP_VERSION);
+
+export {
+  output
+};

package/dist/chunk-H643NG2Y.js

@@ -0,0 +1,17 @@
+import {
+  output
+} from "./chunk-CCIR4QK3.js";
+
+// src/commands/version.command.ts
+var version = async () => {
+  try {
+    output.log({ title: "" });
+  } catch (error) {
+    console.error(error);
+    process.exit(1);
+  }
+};
+
+export {
+  version
+};

package/dist/chunk-JZ2A43R6.js

@@ -0,0 +1,24 @@
+// ../../libs/version/src/index.mts
+import { findUpSync } from "find-up";
+import { readFileSync } from "node:fs";
+import { fileURLToPath } from "node:url";
+var __dirname = fileURLToPath(new URL(".", import.meta.url));
+function getVersion() {
+  const packageJsonPath = findUpSync("package.json", { cwd: __dirname });
+  if (!packageJsonPath) {
+    throw `Could not find package.json`;
+  }
+  const pkg = readFileSync(packageJsonPath, "utf8");
+  const { version } = JSON.parse(pkg);
+  if (!version) {
+    throw `Could not find the version of create-plugin`;
+  }
+  return version;
+}
+
+// src/utils/utils.version.ts
+var CURRENT_APP_VERSION = getVersion();
+
+export {
+  CURRENT_APP_VERSION
+};

package/dist/chunk-KUNFRRHT.js

@@ -0,0 +1,21 @@
+// src/utils/getCreatePluginVersion.ts
+import { existsSync, readFileSync } from "node:fs";
+import { resolve } from "node:path";
+var getCreatePluginVersion = () => {
+  try {
+    const currDir = process.cwd();
+    const crpcJSONPath = resolve(currDir, ".config", ".cprc.json");
+    if (!existsSync(crpcJSONPath)) {
+      return null;
+    }
+    const crpcJSON = readFileSync(crpcJSONPath, "utf-8");
+    const { version } = JSON.parse(crpcJSON);
+    return version;
+  } catch (err) {
+    return null;
+  }
+};
+
+export {
+  getCreatePluginVersion
+};

package/dist/chunk-MBEAHLAV.js

@@ -0,0 +1,75 @@
+import {
+  getCreatePluginVersion
+} from "./chunk-KUNFRRHT.js";
+import {
+  buildManifest,
+  saveManifest,
+  signManifest
+} from "./chunk-RWF366QA.js";
+import {
+  output
+} from "./chunk-CCIR4QK3.js";
+import {
+  CURRENT_APP_VERSION
+} from "./chunk-JZ2A43R6.js";
+import {
+  assertRootUrlIsValid
+} from "./chunk-W6EFWLCZ.js";
+
+// src/commands/sign.command.ts
+import chalk from "chalk";
+import { existsSync } from "node:fs";
+import path from "node:path";
+var sign = async (argv) => {
+  const distDir = argv.distDir ?? "dist";
+  const pluginDistDir = path.resolve(distDir);
+  const signatureType = argv.signatureType;
+  const rootUrls = argv.rootUrls?.split(",") ?? [];
+  if (!existsSync(pluginDistDir)) {
+    output.error({
+      title: "Plugin directory not found.",
+      body: [
+        `Directory ${chalk.bold(pluginDistDir)} not found.`,
+        "Make sure to build the plugin before attempting to sign it."
+      ]
+    });
+    process.exit(1);
+  }
+  try {
+    output.log({
+      title: "Signing plugin.",
+      body: [`Plugin found in ${pluginDistDir}`]
+    });
+    const manifest = await buildManifest(pluginDistDir);
+    if (signatureType) {
+      manifest.signatureType = signatureType;
+    }
+    if (rootUrls && rootUrls.length > 0) {
+      rootUrls.forEach(assertRootUrlIsValid);
+      manifest.rootUrls = rootUrls;
+    }
+    manifest.signPlugin = { version: CURRENT_APP_VERSION };
+    const createPluginVersion = getCreatePluginVersion();
+    if (createPluginVersion) {
+      manifest.createPlugin = { version: createPluginVersion };
+    }
+    const signedManifest = await signManifest(manifest);
+    saveManifest(pluginDistDir, signedManifest);
+    output.success({
+      title: `Plugin signed successsfully.`,
+      body: [`Signed manifest saved to ${pluginDistDir}.`]
+    });
+  } catch (err) {
+    if (err instanceof Error) {
+      output.error({
+        title: "Failed to sign plugin.",
+        body: [err.message]
+      });
+    }
+    process.exit(1);
+  }
+};
+
+export {
+  sign
+};

package/dist/chunk-RWF366QA.js

@@ -0,0 +1,115 @@
+import {
+  output
+} from "./chunk-CCIR4QK3.js";
+import {
+  postData
+} from "./chunk-2Y3K42NH.js";
+
+// src/utils/manifest.ts
+import crypto from "crypto";
+import { readFileSync, writeFileSync } from "node:fs";
+import fs from "node:fs/promises";
+import path from "node:path";
+import chalk from "chalk";
+var MANIFEST_FILE = "MANIFEST.txt";
+async function* walk(dir, baseDir) {
+  for await (const d of await fs.opendir(dir)) {
+    const entry = path.join(dir, d.name);
+    if (d.isDirectory()) {
+      yield* await walk(entry, baseDir);
+    } else if (d.isFile()) {
+      yield path.relative(baseDir, entry);
+    } else if (d.isSymbolicLink()) {
+      const realPath = await fs.realpath(entry);
+      if (!realPath.startsWith(baseDir)) {
+        throw new Error(
+          `symbolic link ${path.relative(baseDir, entry)} targets a file outside of the base directory: ${baseDir}`
+        );
+      }
+      const stats = await fs.stat(realPath);
+      if (stats.isFile()) {
+        yield path.relative(baseDir, entry);
+      }
+    }
+  }
+}
+async function buildManifest(dir) {
+  const pluginJson = JSON.parse(readFileSync(path.join(dir, "plugin.json"), { encoding: "utf8" }));
+  const manifest = {
+    plugin: pluginJson.id,
+    version: pluginJson.info.version,
+    files: {}
+  };
+  for await (const filePath of await walk(dir, dir)) {
+    if (filePath === MANIFEST_FILE) {
+      continue;
+    }
+    const sanitisedFilePath = filePath.split(path.sep).join(path.posix.sep);
+    manifest.files[sanitisedFilePath] = crypto.createHash("sha256").update(readFileSync(path.join(dir, filePath))).digest("hex");
+  }
+  return manifest;
+}
+async function signManifest(manifest) {
+  const GRAFANA_API_KEY = process.env.GRAFANA_API_KEY;
+  const GRAFANA_ACCESS_POLICY_TOKEN = process.env.GRAFANA_ACCESS_POLICY_TOKEN;
+  if (!GRAFANA_ACCESS_POLICY_TOKEN && !GRAFANA_API_KEY) {
+    output.error({
+      title: "Missing GRAFANA_ACCESS_POLICY_TOKEN.",
+      body: ["You must create a GRAFANA_ACCESS_POLICY_TOKEN env variable to sign plugins."],
+      link: "https://grafana.com/developers/plugin-tools/publish-a-plugin/sign-a-plugin#generate-an-access-policy-token"
+    });
+    process.exit(1);
+  }
+  if (GRAFANA_API_KEY) {
+    output.warning({
+      title: "Usage of GRAFANA_API_KEY is deprecated.",
+      body: ["Please migrate to using a GRAFANA_ACCESS_POLICY_TOKEN instead."],
+      link: "https://grafana.com/developers/plugin-tools/publish-a-plugin/sign-a-plugin"
+    });
+  }
+  const GRAFANA_COM_URL = process.env.GRAFANA_COM_URL || "https://grafana.com/api";
+  const url = GRAFANA_COM_URL + "/plugins/ci/sign";
+  const token = GRAFANA_ACCESS_POLICY_TOKEN ? GRAFANA_ACCESS_POLICY_TOKEN : GRAFANA_API_KEY;
+  try {
+    const info = await postData(url, manifest, {
+      Authorization: "Bearer " + token
+    });
+    if (info.status !== 200) {
+      const dataAsArray = Object.entries(JSON.parse(info.data)).map(([key, value]) => `${key}: ${value}`);
+      output.error({
+        title: "Error signing manifest.",
+        body: [
+          `Server responded with status code ${chalk.yellow(info.status)} along with:`,
+          ...output.bulletList(dataAsArray)
+        ]
+      });
+      process.exit(1);
+    }
+    return info.data;
+  } catch (err) {
+    const body = err.response?.data?.message ? [err.response.data.message] : [err.message];
+    output.error({
+      title: "Error signing manifest.",
+      body
+    });
+    process.exit(1);
+  }
+}
+function saveManifest(dir, signedManifest) {
+  try {
+    writeFileSync(path.join(dir, MANIFEST_FILE), signedManifest);
+    return true;
+  } catch (error) {
+    output.error({
+      title: "Error saving manifest",
+      body: [`Failed to write signed manifest to ${dir}.`]
+    });
+    process.exit(1);
+  }
+}
+
+export {
+  buildManifest,
+  signManifest,
+  saveManifest
+};

package/dist/chunk-W6EFWLCZ.js

@@ -0,0 +1,47 @@
+import {
+  __require
+} from "./chunk-3RG5ZIWI.js";
+
+// src/utils/pluginValidation.ts
+var validatePluginJson = (pluginJson) => {
+  if (!pluginJson.id) {
+    throw new Error("Plugin id is missing in plugin.json");
+  }
+  if (!pluginJson.info) {
+    throw new Error("Plugin info node is missing in plugin.json");
+  }
+  if (!pluginJson.info.version) {
+    throw new Error("Plugin info.version is missing in plugin.json");
+  }
+  const types = ["panel", "datasource", "app"];
+  const type = pluginJson.type;
+  if (!types.includes(type)) {
+    throw new Error("Invalid plugin type in plugin.json: " + type);
+  }
+  if (!pluginJson.id.endsWith("-" + type)) {
+    throw new Error("[plugin.json] id should end with: -" + type);
+  }
+};
+var getPluginJson = (path) => {
+  let pluginJson;
+  try {
+    pluginJson = __require(path);
+  } catch (e) {
+    throw new Error("Unable to find: " + path);
+  }
+  validatePluginJson(pluginJson);
+  return pluginJson;
+};
+var assertRootUrlIsValid = (rootUrl) => {
+  try {
+    new URL(rootUrl);
+  } catch (err) {
+    throw new Error(`${rootUrl} is not a valid URL`);
+  }
+};
+
+export {
+  validatePluginJson,
+  getPluginJson,
+  assertRootUrlIsValid
+};

package/dist/commands/index.js

@@ -1,2 +1,18 @@
-export * from './sign.command.js';
-export * from './version.command.js';
+import "../chunk-5G4NZZCD.js";
+import {
+  sign
+} from "../chunk-MBEAHLAV.js";
+import {
+  version
+} from "../chunk-H643NG2Y.js";
+import "../chunk-KUNFRRHT.js";
+import "../chunk-RWF366QA.js";
+import "../chunk-CCIR4QK3.js";
+import "../chunk-JZ2A43R6.js";
+import "../chunk-W6EFWLCZ.js";
+import "../chunk-2Y3K42NH.js";
+import "../chunk-3RG5ZIWI.js";
+export {
+  sign,
+  version
+};

package/dist/commands/sign.command.js

@@ -1,35 +1,13 @@
-import { existsSync } from 'node:fs';
-import path from 'node:path';
-import { getVersion } from '../utils/getVersion.js';
-import { buildManifest, saveManifest, signManifest } from '../utils/manifest.js';
-import { assertRootUrlIsValid } from '../utils/pluginValidation.js';
-export const sign = async (argv) => {
-    const distDir = argv.distDir ?? 'dist';
-    const pluginDistDir = path.resolve(distDir);
-    const signatureType = argv.signatureType;
-    const rootUrls = argv.rootUrls?.split(',') ?? [];
-    if (!existsSync(pluginDistDir)) {
-        throw new Error(`Plugin \`${distDir}\` directory is missing. Did you build the plugin before attempting to sign?`);
-    }
-    try {
-        console.log('Building manifest...');
-        const manifest = await buildManifest(pluginDistDir);
-        console.log('Signing manifest...');
-        if (signatureType) {
-            manifest.signatureType = signatureType;
-        }
-        if (rootUrls && rootUrls.length > 0) {
-            rootUrls.forEach(assertRootUrlIsValid);
-            manifest.rootUrls = rootUrls;
-        }
-        manifest.signPlugin = { version: getVersion() };
-        const signedManifest = await signManifest(manifest);
-        console.log('Saving signed manifest...');
-        saveManifest(pluginDistDir, signedManifest);
-        console.log('Signed successfully');
-    }
-    catch (err) {
-        console.warn(err);
-        process.exitCode = 1;
-    }
+import {
+  sign
+} from "../chunk-MBEAHLAV.js";
+import "../chunk-KUNFRRHT.js";
+import "../chunk-RWF366QA.js";
+import "../chunk-CCIR4QK3.js";
+import "../chunk-JZ2A43R6.js";
+import "../chunk-W6EFWLCZ.js";
+import "../chunk-2Y3K42NH.js";
+import "../chunk-3RG5ZIWI.js";
+export {
+  sign
 };

package/dist/commands/version.command.js

@@ -1,10 +1,9 @@
-import { getVersion } from '../utils/getVersion.js';
-export const version = async () => {
-    try {
-        console.log(getVersion());
-    }
-    catch (error) {
-        console.error(error);
-        process.exit(1);
-    }
+import {
+  version
+} from "../chunk-H643NG2Y.js";
+import "../chunk-CCIR4QK3.js";
+import "../chunk-JZ2A43R6.js";
+import "../chunk-3RG5ZIWI.js";
+export {
+  version
 };

package/dist/utils/getCreatePluginVersion.js

@@ -0,0 +1,7 @@
+import {
+  getCreatePluginVersion
+} from "../chunk-KUNFRRHT.js";
+import "../chunk-3RG5ZIWI.js";
+export {
+  getCreatePluginVersion
+};

package/dist/utils/manifest.js

@@ -1,85 +1,14 @@
-import crypto from 'crypto';
-import { readFileSync, writeFileSync } from 'node:fs';
-import fs from 'node:fs/promises';
-import path from 'node:path';
-import { postData } from './request.js';
-const MANIFEST_FILE = 'MANIFEST.txt';
-async function* walk(dir, baseDir) {
-    for await (const d of await fs.opendir(dir)) {
-        const entry = path.join(dir, d.name);
-        if (d.isDirectory()) {
-            yield* await walk(entry, baseDir);
-        }
-        else if (d.isFile()) {
-            yield path.relative(baseDir, entry);
-        }
-        else if (d.isSymbolicLink()) {
-            const realPath = await fs.realpath(entry);
-            if (!realPath.startsWith(baseDir)) {
-                throw new Error(`symbolic link ${path.relative(baseDir, entry)} targets a file outside of the base directory: ${baseDir}`);
-            }
-            const stats = await fs.stat(realPath);
-            if (stats.isFile()) {
-                yield path.relative(baseDir, entry);
-            }
-        }
-    }
-}
-export async function buildManifest(dir) {
-    const pluginJson = JSON.parse(readFileSync(path.join(dir, 'plugin.json'), { encoding: 'utf8' }));
-    const manifest = {
-        plugin: pluginJson.id,
-        version: pluginJson.info.version,
-        files: {},
-    };
-    for await (const filePath of await walk(dir, dir)) {
-        if (filePath === MANIFEST_FILE) {
-            continue;
-        }
-        const sanitisedFilePath = filePath.split(path.sep).join(path.posix.sep);
-        manifest.files[sanitisedFilePath] = crypto
-            .createHash('sha256')
-            .update(readFileSync(path.join(dir, filePath)))
-            .digest('hex');
-    }
-    return manifest;
-}
-export async function signManifest(manifest) {
-    const GRAFANA_API_KEY = process.env.GRAFANA_API_KEY;
-    const GRAFANA_ACCESS_POLICY_TOKEN = process.env.GRAFANA_ACCESS_POLICY_TOKEN;
-    if (!GRAFANA_ACCESS_POLICY_TOKEN && !GRAFANA_API_KEY) {
-        throw new Error('You must create a GRAFANA_ACCESS_POLICY_TOKEN env variable to sign plugins. Please see: https://grafana.com/developers/plugin-tools/publish-a-plugin/sign-a-plugin#generate-an-access-policy-token for instructions.');
-    }
-    if (GRAFANA_API_KEY) {
-        console.warn(`\x1b[33m%s\x1b[0m`, 'The usage of GRAFANA_API_KEY is deprecated, please consider using GRAFANA_ACCESS_POLICY_TOKEN instead. For more info visit https://grafana.com/developers/plugin-tools/publish-a-plugin/sign-a-plugin');
-    }
-    const GRAFANA_COM_URL = process.env.GRAFANA_COM_URL || 'https://grafana.com/api';
-    const url = GRAFANA_COM_URL + '/plugins/ci/sign';
-    const token = GRAFANA_ACCESS_POLICY_TOKEN ? GRAFANA_ACCESS_POLICY_TOKEN : GRAFANA_API_KEY;
-    try {
-        const info = await postData(url, manifest, {
-            Authorization: 'Bearer ' + token,
-        });
-        if (info.status !== 200) {
-            console.error('Error: ', info);
-            throw new Error('Error signing manifest');
-        }
-        return info.data;
-    }
-    catch (err) {
-        if (err.response?.data?.message) {
-            throw new Error('Error signing manifest: ' + err.response.data.message);
-        }
-        throw new Error('Error signing manifest: ' + err.message);
-    }
-}
-export function saveManifest(dir, signedManifest) {
-    try {
-        writeFileSync(path.join(dir, MANIFEST_FILE), signedManifest);
-        return true;
-    }
-    catch (error) {
-        console.error(error);
-        throw new Error('Error saving manifest');
-    }
-}
+import {
+  buildManifest,
+  saveManifest,
+  signManifest
+} from "../chunk-RWF366QA.js";
+import "../chunk-CCIR4QK3.js";
+import "../chunk-JZ2A43R6.js";
+import "../chunk-2Y3K42NH.js";
+import "../chunk-3RG5ZIWI.js";
+export {
+  buildManifest,
+  saveManifest,
+  signManifest
+};

package/dist/utils/pluginValidation.js

@@ -1,38 +1,11 @@
-export const validatePluginJson = (pluginJson) => {
-    if (!pluginJson.id) {
-        throw new Error('Plugin id is missing in plugin.json');
-    }
-    if (!pluginJson.info) {
-        throw new Error('Plugin info node is missing in plugin.json');
-    }
-    if (!pluginJson.info.version) {
-        throw new Error('Plugin info.version is missing in plugin.json');
-    }
-    const types = ['panel', 'datasource', 'app'];
-    const type = pluginJson.type;
-    if (!types.includes(type)) {
-        throw new Error('Invalid plugin type in plugin.json: ' + type);
-    }
-    if (!pluginJson.id.endsWith('-' + type)) {
-        throw new Error('[plugin.json] id should end with: -' + type);
-    }
-};
-export const getPluginJson = (path) => {
-    let pluginJson;
-    try {
-        pluginJson = require(path);
-    }
-    catch (e) {
-        throw new Error('Unable to find: ' + path);
-    }
-    validatePluginJson(pluginJson);
-    return pluginJson;
-};
-export const assertRootUrlIsValid = (rootUrl) => {
-    try {
-        new URL(rootUrl);
-    }
-    catch (err) {
-        throw new Error(`${rootUrl} is not a valid URL`);
-    }
+import {
+  assertRootUrlIsValid,
+  getPluginJson,
+  validatePluginJson
+} from "../chunk-W6EFWLCZ.js";
+import "../chunk-3RG5ZIWI.js";
+export {
+  assertRootUrlIsValid,
+  getPluginJson,
+  validatePluginJson
 };

package/dist/utils/request.js

@@ -1,36 +1,7 @@
-import https from 'node:https';
-import { URL } from 'node:url';
-import { ProxyAgent } from 'proxy-agent';
-const agent = new ProxyAgent();
-export async function postData(urlString, data, headers) {
-    return new Promise((resolve, reject) => {
-        const url = new URL(urlString);
-        const postData = JSON.stringify(data);
-        const options = {
-            hostname: url.hostname,
-            port: url.port || 443,
-            path: url.pathname,
-            method: 'POST',
-            headers: {
-                ...headers,
-                'Content-Type': 'application/json',
-            },
-            agent,
-        };
-        const req = https.request(options, (res) => {
-            const chunks = [];
-            res.on('data', (chunk) => chunks.push(chunk));
-            res.on('end', () => {
-                const results = Buffer.concat(chunks);
-                resolve({
-                    data: results.toString(),
-                    status: res.statusCode ?? 200,
-                });
-            });
-            res.on('error', reject);
-        });
-        req.on('error', reject);
-        req.write(postData);
-        req.end();
-    });
-}
+import {
+  postData
+} from "../chunk-2Y3K42NH.js";
+import "../chunk-3RG5ZIWI.js";
+export {
+  postData
+};

package/dist/utils/utils.output.js

@@ -0,0 +1,8 @@
+import {
+  output
+} from "../chunk-CCIR4QK3.js";
+import "../chunk-JZ2A43R6.js";
+import "../chunk-3RG5ZIWI.js";
+export {
+  output
+};

package/dist/utils/utils.version.js

@@ -0,0 +1,7 @@
+import {
+  CURRENT_APP_VERSION
+} from "../chunk-JZ2A43R6.js";
+import "../chunk-3RG5ZIWI.js";
+export {
+  CURRENT_APP_VERSION
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@grafana/sign-plugin",
-  "version": "3.1.0-canary.698.89df8be.0",
+  "version": "3.1.0",
   "repository": {
     "directory": "packages/sign-plugin",
     "url": "https://github.com/grafana/plugin-tools"
@@ -17,35 +17,29 @@
   },
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
-    "access": "public"
+    "access": "public",
+    "provenance": true
   },
   "scripts": {
     "clean": "rm -rf ./dist",
-    "build": "npm run clean && tsc && chmod +x ./dist/bin/run.js",
-    "dev": "nodemon --exec 'tsc'",
-    "lint": "eslint --cache --ext .js,.jsx,.ts,.tsx ./src",
+    "build": "tsup",
+    "dev": "tsup --watch ./src --watch '../../libs'",
+    "lint": "eslint --cache ./src",
     "lint:fix": "npm run lint -- --fix",
     "test": "vitest",
     "typecheck": "tsc --noEmit"
   },
   "dependencies": {
+    "chalk": "^5.3.0",
+    "find-up": "^7.0.0",
     "minimist": "^1.2.2",
-    "proxy-agent": "6.3.1"
+    "proxy-agent": "6.5.0"
   },
   "devDependencies": {
-    "@types/minimist": "^1.2.2"
-  },
-  "nodemonConfig": {
-    "watch": [
-      "src/**/*"
-    ],
-    "ext": "*",
-    "events": {
-      "start": "cls || clear"
-    }
+    "@types/minimist": "^1.2.5"
   },
   "engines": {
     "node": ">=20"
   },
-  "gitHead": "89df8be7ce8ffc3a78214ff9c00e1a8a55082187"
+  "gitHead": "b622bcaa222af1bf67aa602eb2accecad44f1afc"
 }

package/src/commands/sign.command.ts

@@ -1,9 +1,12 @@
+import chalk from 'chalk';
 import minimist from 'minimist';
 import { existsSync } from 'node:fs';
 import path from 'node:path';
-import { getVersion } from '../utils/getVersion.js';
+import { CURRENT_APP_VERSION } from '../utils/utils.version.js';
 import { buildManifest, saveManifest, signManifest } from '../utils/manifest.js';
 import { assertRootUrlIsValid } from '../utils/pluginValidation.js';
+import { getCreatePluginVersion } from '../utils/getCreatePluginVersion.js';
+import { output } from '../utils/utils.output.js';
 
 export const sign = async (argv: minimist.ParsedArgs) => {
   const distDir = argv.distDir ?? 'dist';
@@ -12,14 +15,23 @@ export const sign = async (argv: minimist.ParsedArgs) => {
   const rootUrls: string[] = argv.rootUrls?.split(',') ?? [];
 
   if (!existsSync(pluginDistDir)) {
-    throw new Error(`Plugin \`${distDir}\` directory is missing. Did you build the plugin before attempting to sign?`);
+    output.error({
+      title: 'Plugin directory not found.',
+      body: [
+        `Directory ${chalk.bold(pluginDistDir)} not found.`,
+        'Make sure to build the plugin before attempting to sign it.',
+      ],
+    });
+    process.exit(1);
   }
 
   try {
-    console.log('Building manifest...');
+    output.log({
+      title: 'Signing plugin.',
+      body: [`Plugin found in ${pluginDistDir}`],
+    });
     const manifest = await buildManifest(pluginDistDir);
 
-    console.log('Signing manifest...');
     if (signatureType) {
       manifest.signatureType = signatureType;
     }
@@ -28,15 +40,26 @@ export const sign = async (argv: minimist.ParsedArgs) => {
       manifest.rootUrls = rootUrls;
     }
 
-    manifest.signPlugin = { version: getVersion() };
+    manifest.signPlugin = { version: CURRENT_APP_VERSION };
+    const createPluginVersion = getCreatePluginVersion();
+    if (createPluginVersion) {
+      manifest.createPlugin = { version: createPluginVersion };
+    }
+
     const signedManifest = await signManifest(manifest);
 
-    console.log('Saving signed manifest...');
     saveManifest(pluginDistDir, signedManifest);
-
-    console.log('Signed successfully');
+    output.success({
+      title: `Plugin signed successsfully.`,
+      body: [`Signed manifest saved to ${pluginDistDir}.`],
+    });
   } catch (err) {
-    console.warn(err);
-    process.exitCode = 1;
+    if (err instanceof Error) {
+      output.error({
+        title: 'Failed to sign plugin.',
+        body: [err.message],
+      });
+    }
+    process.exit(1);
   }
 };

package/src/commands/version.command.ts

@@ -1,8 +1,8 @@
-import { getVersion } from '../utils/getVersion.js';
+import { output } from '../utils/utils.output.js';
 
 export const version = async () => {
   try {
-    console.log(getVersion());
+    output.log({ title: '' });
   } catch (error) {
     console.error(error);
     process.exit(1);

package/src/utils/getCreatePluginVersion.ts

@@ -0,0 +1,18 @@
+import { existsSync, readFileSync } from 'node:fs';
+import { resolve } from 'node:path';
+
+export const getCreatePluginVersion = () => {
+  try {
+    const currDir = process.cwd();
+    const crpcJSONPath = resolve(currDir, '.config', '.cprc.json');
+    if (!existsSync(crpcJSONPath)) {
+      return null;
+    }
+
+    const crpcJSON = readFileSync(crpcJSONPath, 'utf-8');
+    const { version } = JSON.parse(crpcJSON);
+    return version as string;
+  } catch (err) {
+    return null;
+  }
+};

package/src/utils/manifest.ts

@@ -3,6 +3,8 @@ import { readFileSync, writeFileSync } from 'node:fs';
 import fs from 'node:fs/promises';
 import path from 'node:path';
 import { postData } from './request.js';
+import { output } from './utils.output.js';
+import chalk from 'chalk';
 
 const MANIFEST_FILE = 'MANIFEST.txt';
 
@@ -19,6 +21,9 @@ export interface ManifestInfo {
   signPlugin?: {
     version: string;
   };
+  createPlugin?: {
+    version: string;
+  };
 }
 
 type RecursiveWalk = AsyncGenerator<string, void | RecursiveWalk>;
@@ -79,15 +84,19 @@ export async function signManifest(manifest: ManifestInfo): Promise<string> {
   const GRAFANA_ACCESS_POLICY_TOKEN = process.env.GRAFANA_ACCESS_POLICY_TOKEN;
 
   if (!GRAFANA_ACCESS_POLICY_TOKEN && !GRAFANA_API_KEY) {
-    throw new Error(
-      'You must create a GRAFANA_ACCESS_POLICY_TOKEN env variable to sign plugins. Please see: https://grafana.com/developers/plugin-tools/publish-a-plugin/sign-a-plugin#generate-an-access-policy-token for instructions.'
-    );
+    output.error({
+      title: 'Missing GRAFANA_ACCESS_POLICY_TOKEN.',
+      body: ['You must create a GRAFANA_ACCESS_POLICY_TOKEN env variable to sign plugins.'],
+      link: 'https://grafana.com/developers/plugin-tools/publish-a-plugin/sign-a-plugin#generate-an-access-policy-token',
+    });
+    process.exit(1);
   }
   if (GRAFANA_API_KEY) {
-    console.warn(
-      `\x1b[33m%s\x1b[0m`,
-      'The usage of GRAFANA_API_KEY is deprecated, please consider using GRAFANA_ACCESS_POLICY_TOKEN instead. For more info visit https://grafana.com/developers/plugin-tools/publish-a-plugin/sign-a-plugin'
-    );
+    output.warning({
+      title: 'Usage of GRAFANA_API_KEY is deprecated.',
+      body: ['Please migrate to using a GRAFANA_ACCESS_POLICY_TOKEN instead.'],
+      link: 'https://grafana.com/developers/plugin-tools/publish-a-plugin/sign-a-plugin',
+    });
   }
 
   const GRAFANA_COM_URL = process.env.GRAFANA_COM_URL || 'https://grafana.com/api';
@@ -99,17 +108,25 @@ export async function signManifest(manifest: ManifestInfo): Promise<string> {
       Authorization: 'Bearer ' + token,
     });
     if (info.status !== 200) {
-      console.error('Error: ', info);
-      throw new Error('Error signing manifest');
+      const dataAsArray = Object.entries(JSON.parse(info.data)).map(([key, value]) => `${key}: ${value}`);
+      output.error({
+        title: 'Error signing manifest.',
+        body: [
+          `Server responded with status code ${chalk.yellow(info.status)} along with:`,
+          ...output.bulletList(dataAsArray),
+        ],
+      });
+      process.exit(1);
     }
 
     return info.data;
   } catch (err: any) {
-    if (err.response?.data?.message) {
-      throw new Error('Error signing manifest: ' + err.response.data.message);
-    }
-
-    throw new Error('Error signing manifest: ' + err.message);
+    const body = err.response?.data?.message ? [err.response.data.message] : [err.message];
+    output.error({
+      title: 'Error signing manifest.',
+      body,
+    });
+    process.exit(1);
   }
 }
 
@@ -118,7 +135,10 @@ export function saveManifest(dir: string, signedManifest: string) {
     writeFileSync(path.join(dir, MANIFEST_FILE), signedManifest);
     return true;
   } catch (error) {
-    console.error(error);
-    throw new Error('Error saving manifest');
+    output.error({
+      title: 'Error saving manifest',
+      body: [`Failed to write signed manifest to ${dir}.`],
+    });
+    process.exit(1);
   }
 }

package/src/utils/utils.output.ts

@@ -0,0 +1,4 @@
+import { Output } from '@libs/output';
+import { CURRENT_APP_VERSION } from './utils.version.js';
+
+export const output = new Output('sign-plugin', CURRENT_APP_VERSION);

package/src/utils/utils.version.ts

@@ -0,0 +1,3 @@
+import { getVersion } from '@libs/version';
+
+export const CURRENT_APP_VERSION = getVersion();

package/dist/utils/getVersion.js

@@ -1,13 +0,0 @@
-import { readFileSync } from 'node:fs';
-import { resolve } from 'node:path';
-import { fileURLToPath } from 'node:url';
-const __dirname = fileURLToPath(new URL('.', import.meta.url));
-export const getVersion = () => {
-    const packageJsonPath = resolve(__dirname, '..', '..', 'package.json');
-    const pkg = readFileSync(packageJsonPath, 'utf8');
-    const { version } = JSON.parse(pkg);
-    if (!version) {
-        throw `Could not find the version of sign-plugin`;
-    }
-    return version;
-};

package/dist/utils/pluginValidation.test.js

@@ -1,13 +0,0 @@
-import { getPluginJson, validatePluginJson } from './pluginValidation.js';
-describe('pluginValidation', () => {
-    describe('plugin.json', () => {
-        test('missing plugin.json file', () => {
-            expect(() => getPluginJson(`${__dirname}/mocks/missing-plugin.json`)).toThrowError();
-        });
-    });
-    describe('validatePluginJson', () => {
-        test('missing "id" field in the plugin.json file', () => {
-            expect(() => validatePluginJson({})).toThrow('Plugin id is missing in plugin.json');
-        });
-    });
-});

package/src/utils/getVersion.ts

@@ -1,15 +0,0 @@
-import { readFileSync } from 'node:fs';
-import { resolve } from 'node:path';
-import { fileURLToPath } from 'node:url';
-
-const __dirname = fileURLToPath(new URL('.', import.meta.url));
-
-export const getVersion = () => {
-  const packageJsonPath = resolve(__dirname, '..', '..', 'package.json');
-  const pkg = readFileSync(packageJsonPath, 'utf8');
-  const { version } = JSON.parse(pkg);
-  if (!version) {
-    throw `Could not find the version of sign-plugin`;
-  }
-  return version;
-};