deprecate packPluginFromManifest

src/cli/plugin/pack.ts

@@ -1,6 +1,6 @@
 import type yargs from "yargs";
 import type { CommandModule } from "yargs";
-import run from "../../plugin/packer/cli";
+import run from "../../plugin/packer/cli/cli";
 import { emitExperimentalWarning } from "../../utils/stability";
 
 const command = "pack";

src/plugin/packer/cli.ts → src/plugin/packer/cli/index.ts

@@ -5,12 +5,12 @@ import os from "os";
 import * as chokidar from "chokidar";
 import { mkdirp } from "mkdirp";
 import _debug from "debug";
-import packer from "./index";
-import { logger } from "../../utils/log";
-import { ManifestFactory } from "./manifest";
-import { generateErrorMessages } from "./manifest/validate";
-import { ContentsZip } from "./contents-zip";
-import type { PluginZipInterface } from "./plugin-zip";
+import packer from "../index";
+import { logger } from "../../../utils/log";
+import { ManifestFactory } from "../manifest";
+import { generateErrorMessages } from "../manifest/validate";
+import { ContentsZip } from "../contents-zip";
+import type { PluginZipInterface } from "../plugin-zip";
 
 const debug = _debug("cli");
 const writeFile = promisify(fs.writeFile);

src/plugin/packer/from-manifest/__tests__/fixtures/private.ppk

@@ -0,0 +1,15 @@
+-----BEGIN RSA PRIVATE KEY-----
+MIICWwIBAAKBgQDDH5jleaiQagMnSS6XjrOQCJIDhjutOV7fJyzrsGhIGhFnZk7y
+K5YAm+kfOMlCEUZNHavcfS3WrJRP5sanc6E0dobTXNBYVwx97pEZk1KPhPVCiVCC
+HBRPvef+Ai98o4aeSVamP6bD9aIZ51+prjcf0uh9+vzzm1XvqF9rgMkhkQIDAQAB
+AoGAT8GGmaXUxNLQXyqGpORreSBHrrEbi367zLMSpXQB7BbbrkwfUNWIBs+zxlNL
+0HmHJtZN/V4dcnYwWUiXQrL83OHdVgqgcUBKBX5znY9GJcPJoDM6ZhiYR7K79IQq
+eAzKCveFm3bhk9+mnOdiZO+q39IPE+3PPz3dQ1PNRwbCh8ECQQDtKstAHmfRcIwf
+4woOV+TllxRMDkexThxs/YWV+5Sq3lLUqOjJolLFdW1DwqQHjeyeN008C3IhNLyy
+1xeRLLydAkEA0p4gHlCnxUz9nVuRkz2Dk0GMpkdz156Opcf1nKUXar4CbdSp9gbJ
+LEBulEDRVop4nY6J4W5hW0bDjuPGnSR0hQJATpU2YVlxxtjG5S3iQBxpcJVdmVHF
++X7LNmXOZILGoNMnmOUatOy/BkRBXwlYNlSVSVtDkRityUjjGVLhsS2klQJAbkQY
+3qYtX69SK/sPuP2AkCzGPRu1e1JorkSEwzDvlJPL48JuBP9CfWdyPS2+K0etpBdG
++n32fHoM0hdQGV9HnQJAGed+BG6jxfXJe7KRhPoT3bF4lc4xmdXGfLMoutLqoZ8y
+GrKcvq1TcxsA/QSkvSGGEd0667t/9djFq1Ift02RMQ==
+-----END RSA PRIVATE KEY-----

src/plugin/packer/from-manifest/__tests__/fixtures/sample-plugin/manifest.json

@@ -0,0 +1,9 @@
+{
+  "manifest_version": 1,
+  "version": 1,
+  "type": "APP",
+  "name": {
+    "en": "sample extension"
+  },
+  "icon": "image/icon.png"
+}

src/plugin/packer/__tests__/pack-plugin-from-manifest.test.ts → src/plugin/packer/from-manifest/__tests__/pack-plugin-from-manifest.test.ts

@@ -1,13 +1,13 @@
 import path from "path";
 import fs from "fs";
-import packer from "../index";
+import packer from "../../index";
 import { packPluginFromManifest } from "../pack-plugin-from-manifest";
-import { ManifestFactory } from "../manifest";
-import { ContentsZip } from "../contents-zip";
+import { ManifestFactory } from "../../manifest";
+import { ContentsZip } from "../../contents-zip";
 
 const fixturesDir = path.join(__dirname, "fixtures");
 const ppkFilePath = path.join(fixturesDir, "private.ppk");
-const pluginDir = path.join(fixturesDir, "sample-plugin", "plugin-dir");
+const pluginDir = path.join(fixturesDir, "sample-plugin");
 
 describe("pack-plugin-from-manifest", () => {
   it("should be able to create a plugin from the manifest json path", async () => {

src/plugin/packer/from-manifest/pack-plugin-from-manifest.ts

@@ -0,0 +1,24 @@
+import path from "path";
+import packer from "../index";
+import { ManifestFactory } from "../manifest";
+import { ContentsZip } from "../contents-zip";
+import type { PluginZip } from "../plugin-zip";
+
+// TODO: We can consider deleting this function. Originally, it is used by webpack-plugin-kintone-plugin.
+//  In cli-kintone, it is no longer needed.
+//  ref. https://github.com/kintone/js-sdk/blob/fb125766efe1b0866dfb50d56a4aa80c1a8f0de8/packages/webpack-plugin-kintone-plugin/src/plugin.ts#L4
+//  ref.https://github.com/kintone-labs/plugin-packer/pull/49
+/**
+ * @deprecated
+ */
+export const packPluginFromManifest = async (
+  manifestJSONPath: string,
+  privateKey: string,
+): Promise<{ plugin: PluginZip; privateKey: string; id: string }> => {
+  const manifest = await ManifestFactory.loadJsonFile(manifestJSONPath);
+  const contentsZip = await ContentsZip.createFromManifest(
+    path.dirname(manifestJSONPath),
+    manifest,
+  );
+  return packer(contentsZip, privateKey);
+};