@backstage/cli-node 0.2.8 → 0.2.9-next.0

package/dist/roles/PackageRoles.cjs.js

@@ -0,0 +1,155 @@
+'use strict';
+
+var zod = require('zod');
+
+const packageRoleInfos = [
+  {
+    role: "frontend",
+    platform: "web",
+    output: ["bundle"]
+  },
+  {
+    role: "backend",
+    platform: "node",
+    output: ["bundle"]
+  },
+  {
+    role: "cli",
+    platform: "node",
+    output: ["cjs"]
+  },
+  {
+    role: "web-library",
+    platform: "web",
+    output: ["types", "esm"]
+  },
+  {
+    role: "node-library",
+    platform: "node",
+    output: ["types", "cjs"]
+  },
+  {
+    role: "common-library",
+    platform: "common",
+    output: ["types", "esm", "cjs"]
+  },
+  {
+    role: "frontend-plugin",
+    platform: "web",
+    output: ["types", "esm"]
+  },
+  {
+    role: "frontend-plugin-module",
+    platform: "web",
+    output: ["types", "esm"]
+  },
+  {
+    role: "frontend-dynamic-container",
+    // experimental
+    platform: "web",
+    output: ["bundle"]
+  },
+  {
+    role: "backend-plugin",
+    platform: "node",
+    output: ["types", "cjs"]
+  },
+  {
+    role: "backend-plugin-module",
+    platform: "node",
+    output: ["types", "cjs"]
+  }
+];
+const readSchema = zod.z.object({
+  name: zod.z.string().optional(),
+  backstage: zod.z.object({
+    role: zod.z.string().optional()
+  }).optional()
+});
+const detectionSchema = zod.z.object({
+  name: zod.z.string().optional(),
+  scripts: zod.z.object({
+    start: zod.z.string().optional(),
+    build: zod.z.string().optional()
+  }).optional(),
+  publishConfig: zod.z.object({
+    main: zod.z.string().optional(),
+    types: zod.z.string().optional(),
+    module: zod.z.string().optional()
+  }).optional(),
+  main: zod.z.string().optional(),
+  types: zod.z.string().optional(),
+  module: zod.z.string().optional()
+});
+class PackageRoles {
+  /**
+   * Get the associated info for a package role.
+   */
+  static getRoleInfo(role) {
+    const roleInfo = packageRoleInfos.find((r) => r.role === role);
+    if (!roleInfo) {
+      throw new Error(`Unknown package role '${role}'`);
+    }
+    return roleInfo;
+  }
+  /**
+   * Given package JSON data, get the package role.
+   */
+  static getRoleFromPackage(pkgJson) {
+    const pkg = readSchema.parse(pkgJson);
+    if (pkg.backstage) {
+      const { role } = pkg.backstage;
+      if (!role) {
+        throw new Error(
+          `Package ${pkg.name} must specify a role in the "backstage" field`
+        );
+      }
+      return this.getRoleInfo(role).role;
+    }
+    return void 0;
+  }
+  /**
+   * Attempt to detect the role of a package from its package.json.
+   */
+  static detectRoleFromPackage(pkgJson) {
+    const pkg = detectionSchema.parse(pkgJson);
+    if (pkg.scripts?.start?.includes("app:serve")) {
+      return "frontend";
+    }
+    if (pkg.scripts?.build?.includes("backend:bundle")) {
+      return "backend";
+    }
+    if (pkg.name?.includes("plugin-") && pkg.name?.includes("-backend-module-")) {
+      return "backend-plugin-module";
+    }
+    if (pkg.name?.includes("plugin-") && pkg.name?.includes("-module-")) {
+      return "frontend-plugin-module";
+    }
+    if (pkg.scripts?.start?.includes("plugin:serve")) {
+      return "frontend-plugin";
+    }
+    if (pkg.scripts?.start?.includes("backend:dev")) {
+      return "backend-plugin";
+    }
+    const mainEntry = pkg.publishConfig?.main || pkg.main;
+    const moduleEntry = pkg.publishConfig?.module || pkg.module;
+    const typesEntry = pkg.publishConfig?.types || pkg.types;
+    if (typesEntry) {
+      if (mainEntry && moduleEntry) {
+        return "common-library";
+      }
+      if (moduleEntry || mainEntry?.endsWith(".esm.js")) {
+        return "web-library";
+      }
+      if (mainEntry) {
+        return "node-library";
+      }
+    } else if (mainEntry) {
+      return "cli";
+    }
+    return void 0;
+  }
+}
+
+exports.PackageRoles = PackageRoles;
+//# sourceMappingURL=PackageRoles.cjs.js.map

package/dist/roles/PackageRoles.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PackageRoles.cjs.js","sources":["../../src/roles/PackageRoles.ts"],"sourcesContent":["/*\n * Copyright 2022 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { z } from 'zod';\nimport { PackageRole, PackageRoleInfo } from './types';\n\nconst packageRoleInfos: PackageRoleInfo[] = [\n  {\n    role: 'frontend',\n    platform: 'web',\n    output: ['bundle'],\n  },\n  {\n    role: 'backend',\n    platform: 'node',\n    output: ['bundle'],\n  },\n  {\n    role: 'cli',\n    platform: 'node',\n    output: ['cjs'],\n  },\n  {\n    role: 'web-library',\n    platform: 'web',\n    output: ['types', 'esm'],\n  },\n  {\n    role: 'node-library',\n    platform: 'node',\n    output: ['types', 'cjs'],\n  },\n  {\n    role: 'common-library',\n    platform: 'common',\n    output: ['types', 'esm', 'cjs'],\n  },\n  {\n    role: 'frontend-plugin',\n    platform: 'web',\n    output: ['types', 'esm'],\n  },\n  {\n    role: 'frontend-plugin-module',\n    platform: 'web',\n    output: ['types', 'esm'],\n  },\n  {\n    role: 'frontend-dynamic-container' as PackageRole, // experimental\n    platform: 'web',\n    output: ['bundle'],\n  },\n  {\n    role: 'backend-plugin',\n    platform: 'node',\n    output: ['types', 'cjs'],\n  },\n  {\n    role: 'backend-plugin-module',\n    platform: 'node',\n    output: ['types', 'cjs'],\n  },\n];\n\nconst readSchema = z.object({\n  name: z.string().optional(),\n  backstage: z\n    .object({\n      role: z.string().optional(),\n    })\n    .optional(),\n});\n\nconst detectionSchema = z.object({\n  name: z.string().optional(),\n  scripts: z\n    .object({\n      start: z.string().optional(),\n      build: z.string().optional(),\n    })\n    .optional(),\n  publishConfig: z\n    .object({\n      main: z.string().optional(),\n      types: z.string().optional(),\n      module: z.string().optional(),\n    })\n    .optional(),\n  main: z.string().optional(),\n  types: z.string().optional(),\n  module: z.string().optional(),\n});\n\n/**\n * Utilities for working with Backstage package roles.\n *\n * @public\n */\nexport class PackageRoles {\n  /**\n   * Get the associated info for a package role.\n   */\n  static getRoleInfo(role: string): PackageRoleInfo {\n    const roleInfo = packageRoleInfos.find(r => r.role === role);\n    if (!roleInfo) {\n      throw new Error(`Unknown package role '${role}'`);\n    }\n    return roleInfo;\n  }\n\n  /**\n   * Given package JSON data, get the package role.\n   */\n  static getRoleFromPackage(pkgJson: unknown): PackageRole | undefined {\n    const pkg = readSchema.parse(pkgJson);\n\n    if (pkg.backstage) {\n      const { role } = pkg.backstage;\n      if (!role) {\n        throw new Error(\n          `Package ${pkg.name} must specify a role in the \"backstage\" field`,\n        );\n      }\n\n      return this.getRoleInfo(role).role;\n    }\n\n    return undefined;\n  }\n\n  /**\n   * Attempt to detect the role of a package from its package.json.\n   */\n  static detectRoleFromPackage(pkgJson: unknown): PackageRole | undefined {\n    const pkg = detectionSchema.parse(pkgJson);\n\n    if (pkg.scripts?.start?.includes('app:serve')) {\n      return 'frontend';\n    }\n    if (pkg.scripts?.build?.includes('backend:bundle')) {\n      return 'backend';\n    }\n    if (\n      pkg.name?.includes('plugin-') &&\n      pkg.name?.includes('-backend-module-')\n    ) {\n      return 'backend-plugin-module';\n    }\n    if (pkg.name?.includes('plugin-') && pkg.name?.includes('-module-')) {\n      return 'frontend-plugin-module';\n    }\n    if (pkg.scripts?.start?.includes('plugin:serve')) {\n      return 'frontend-plugin';\n    }\n    if (pkg.scripts?.start?.includes('backend:dev')) {\n      return 'backend-plugin';\n    }\n\n    const mainEntry = pkg.publishConfig?.main || pkg.main;\n    const moduleEntry = pkg.publishConfig?.module || pkg.module;\n    const typesEntry = pkg.publishConfig?.types || pkg.types;\n    if (typesEntry) {\n      if (mainEntry && moduleEntry) {\n        return 'common-library';\n      }\n      if (moduleEntry || mainEntry?.endsWith('.esm.js')) {\n        return 'web-library';\n      }\n      if (mainEntry) {\n        return 'node-library';\n      }\n    } else if (mainEntry) {\n      return 'cli';\n    }\n\n    return undefined;\n  }\n}\n"],"names":["z"],"mappings":";;;;AAmBA,MAAM,gBAAsC,GAAA;AAAA,EAC1C;AAAA,IACE,IAAM,EAAA,UAAA;AAAA,IACN,QAAU,EAAA,KAAA;AAAA,IACV,MAAA,EAAQ,CAAC,QAAQ,CAAA;AAAA,GACnB;AAAA,EACA;AAAA,IACE,IAAM,EAAA,SAAA;AAAA,IACN,QAAU,EAAA,MAAA;AAAA,IACV,MAAA,EAAQ,CAAC,QAAQ,CAAA;AAAA,GACnB;AAAA,EACA;AAAA,IACE,IAAM,EAAA,KAAA;AAAA,IACN,QAAU,EAAA,MAAA;AAAA,IACV,MAAA,EAAQ,CAAC,KAAK,CAAA;AAAA,GAChB;AAAA,EACA;AAAA,IACE,IAAM,EAAA,aAAA;AAAA,IACN,QAAU,EAAA,KAAA;AAAA,IACV,MAAA,EAAQ,CAAC,OAAA,EAAS,KAAK,CAAA;AAAA,GACzB;AAAA,EACA;AAAA,IACE,IAAM,EAAA,cAAA;AAAA,IACN,QAAU,EAAA,MAAA;AAAA,IACV,MAAA,EAAQ,CAAC,OAAA,EAAS,KAAK,CAAA;AAAA,GACzB;AAAA,EACA;AAAA,IACE,IAAM,EAAA,gBAAA;AAAA,IACN,QAAU,EAAA,QAAA;AAAA,IACV,MAAQ,EAAA,CAAC,OAAS,EAAA,KAAA,EAAO,KAAK,CAAA;AAAA,GAChC;AAAA,EACA;AAAA,IACE,IAAM,EAAA,iBAAA;AAAA,IACN,QAAU,EAAA,KAAA;AAAA,IACV,MAAA,EAAQ,CAAC,OAAA,EAAS,KAAK,CAAA;AAAA,GACzB;AAAA,EACA;AAAA,IACE,IAAM,EAAA,wBAAA;AAAA,IACN,QAAU,EAAA,KAAA;AAAA,IACV,MAAA,EAAQ,CAAC,OAAA,EAAS,KAAK,CAAA;AAAA,GACzB;AAAA,EACA;AAAA,IACE,IAAM,EAAA,4BAAA;AAAA;AAAA,IACN,QAAU,EAAA,KAAA;AAAA,IACV,MAAA,EAAQ,CAAC,QAAQ,CAAA;AAAA,GACnB;AAAA,EACA;AAAA,IACE,IAAM,EAAA,gBAAA;AAAA,IACN,QAAU,EAAA,MAAA;AAAA,IACV,MAAA,EAAQ,CAAC,OAAA,EAAS,KAAK,CAAA;AAAA,GACzB;AAAA,EACA;AAAA,IACE,IAAM,EAAA,uBAAA;AAAA,IACN,QAAU,EAAA,MAAA;AAAA,IACV,MAAA,EAAQ,CAAC,OAAA,EAAS,KAAK,CAAA;AAAA,GACzB;AACF,CAAA,CAAA;AAEA,MAAM,UAAA,GAAaA,MAAE,MAAO,CAAA;AAAA,EAC1B,IAAM,EAAAA,KAAA,CAAE,MAAO,EAAA,CAAE,QAAS,EAAA;AAAA,EAC1B,SAAA,EAAWA,MACR,MAAO,CAAA;AAAA,IACN,IAAM,EAAAA,KAAA,CAAE,MAAO,EAAA,CAAE,QAAS,EAAA;AAAA,GAC3B,EACA,QAAS,EAAA;AACd,CAAC,CAAA,CAAA;AAED,MAAM,eAAA,GAAkBA,MAAE,MAAO,CAAA;AAAA,EAC/B,IAAM,EAAAA,KAAA,CAAE,MAAO,EAAA,CAAE,QAAS,EAAA;AAAA,EAC1B,OAAA,EAASA,MACN,MAAO,CAAA;AAAA,IACN,KAAO,EAAAA,KAAA,CAAE,MAAO,EAAA,CAAE,QAAS,EAAA;AAAA,IAC3B,KAAO,EAAAA,KAAA,CAAE,MAAO,EAAA,CAAE,QAAS,EAAA;AAAA,GAC5B,EACA,QAAS,EAAA;AAAA,EACZ,aAAA,EAAeA,MACZ,MAAO,CAAA;AAAA,IACN,IAAM,EAAAA,KAAA,CAAE,MAAO,EAAA,CAAE,QAAS,EAAA;AAAA,IAC1B,KAAO,EAAAA,KAAA,CAAE,MAAO,EAAA,CAAE,QAAS,EAAA;AAAA,IAC3B,MAAQ,EAAAA,KAAA,CAAE,MAAO,EAAA,CAAE,QAAS,EAAA;AAAA,GAC7B,EACA,QAAS,EAAA;AAAA,EACZ,IAAM,EAAAA,KAAA,CAAE,MAAO,EAAA,CAAE,QAAS,EAAA;AAAA,EAC1B,KAAO,EAAAA,KAAA,CAAE,MAAO,EAAA,CAAE,QAAS,EAAA;AAAA,EAC3B,MAAQ,EAAAA,KAAA,CAAE,MAAO,EAAA,CAAE,QAAS,EAAA;AAC9B,CAAC,CAAA,CAAA;AAOM,MAAM,YAAa,CAAA;AAAA;AAAA;AAAA;AAAA,EAIxB,OAAO,YAAY,IAA+B,EAAA;AAChD,IAAA,MAAM,WAAW,gBAAiB,CAAA,IAAA,CAAK,CAAK,CAAA,KAAA,CAAA,CAAE,SAAS,IAAI,CAAA,CAAA;AAC3D,IAAA,IAAI,CAAC,QAAU,EAAA;AACb,MAAA,MAAM,IAAI,KAAA,CAAM,CAAyB,sBAAA,EAAA,IAAI,CAAG,CAAA,CAAA,CAAA,CAAA;AAAA,KAClD;AACA,IAAO,OAAA,QAAA,CAAA;AAAA,GACT;AAAA;AAAA;AAAA;AAAA,EAKA,OAAO,mBAAmB,OAA2C,EAAA;AACnE,IAAM,MAAA,GAAA,GAAM,UAAW,CAAA,KAAA,CAAM,OAAO,CAAA,CAAA;AAEpC,IAAA,IAAI,IAAI,SAAW,EAAA;AACjB,MAAM,MAAA,EAAE,IAAK,EAAA,GAAI,GAAI,CAAA,SAAA,CAAA;AACrB,MAAA,IAAI,CAAC,IAAM,EAAA;AACT,QAAA,MAAM,IAAI,KAAA;AAAA,UACR,CAAA,QAAA,EAAW,IAAI,IAAI,CAAA,6CAAA,CAAA;AAAA,SACrB,CAAA;AAAA,OACF;AAEA,MAAO,OAAA,IAAA,CAAK,WAAY,CAAA,IAAI,CAAE,CAAA,IAAA,CAAA;AAAA,KAChC;AAEA,IAAO,OAAA,KAAA,CAAA,CAAA;AAAA,GACT;AAAA;AAAA;AAAA;AAAA,EAKA,OAAO,sBAAsB,OAA2C,EAAA;AACtE,IAAM,MAAA,GAAA,GAAM,eAAgB,CAAA,KAAA,CAAM,OAAO,CAAA,CAAA;AAEzC,IAAA,IAAI,GAAI,CAAA,OAAA,EAAS,KAAO,EAAA,QAAA,CAAS,WAAW,CAAG,EAAA;AAC7C,MAAO,OAAA,UAAA,CAAA;AAAA,KACT;AACA,IAAA,IAAI,GAAI,CAAA,OAAA,EAAS,KAAO,EAAA,QAAA,CAAS,gBAAgB,CAAG,EAAA;AAClD,MAAO,OAAA,SAAA,CAAA;AAAA,KACT;AACA,IACE,IAAA,GAAA,CAAI,MAAM,QAAS,CAAA,SAAS,KAC5B,GAAI,CAAA,IAAA,EAAM,QAAS,CAAA,kBAAkB,CACrC,EAAA;AACA,MAAO,OAAA,uBAAA,CAAA;AAAA,KACT;AACA,IAAI,IAAA,GAAA,CAAI,MAAM,QAAS,CAAA,SAAS,KAAK,GAAI,CAAA,IAAA,EAAM,QAAS,CAAA,UAAU,CAAG,EAAA;AACnE,MAAO,OAAA,wBAAA,CAAA;AAAA,KACT;AACA,IAAA,IAAI,GAAI,CAAA,OAAA,EAAS,KAAO,EAAA,QAAA,CAAS,cAAc,CAAG,EAAA;AAChD,MAAO,OAAA,iBAAA,CAAA;AAAA,KACT;AACA,IAAA,IAAI,GAAI,CAAA,OAAA,EAAS,KAAO,EAAA,QAAA,CAAS,aAAa,CAAG,EAAA;AAC/C,MAAO,OAAA,gBAAA,CAAA;AAAA,KACT;AAEA,IAAA,MAAM,SAAY,GAAA,GAAA,CAAI,aAAe,EAAA,IAAA,IAAQ,GAAI,CAAA,IAAA,CAAA;AACjD,IAAA,MAAM,WAAc,GAAA,GAAA,CAAI,aAAe,EAAA,MAAA,IAAU,GAAI,CAAA,MAAA,CAAA;AACrD,IAAA,MAAM,UAAa,GAAA,GAAA,CAAI,aAAe,EAAA,KAAA,IAAS,GAAI,CAAA,KAAA,CAAA;AACnD,IAAA,IAAI,UAAY,EAAA;AACd,MAAA,IAAI,aAAa,WAAa,EAAA;AAC5B,QAAO,OAAA,gBAAA,CAAA;AAAA,OACT;AACA,MAAA,IAAI,WAAe,IAAA,SAAA,EAAW,QAAS,CAAA,SAAS,CAAG,EAAA;AACjD,QAAO,OAAA,aAAA,CAAA;AAAA,OACT;AACA,MAAA,IAAI,SAAW,EAAA;AACb,QAAO,OAAA,cAAA,CAAA;AAAA,OACT;AAAA,eACS,SAAW,EAAA;AACpB,MAAO,OAAA,KAAA,CAAA;AAAA,KACT;AAEA,IAAO,OAAA,KAAA,CAAA,CAAA;AAAA,GACT;AACF;;;;"}

package/dist/run.cjs.js

@@ -0,0 +1,9 @@
+'use strict';
+
+var child_process = require('child_process');
+var util = require('util');
+
+const execFile = util.promisify(child_process.execFile);
+
+exports.execFile = execFile;
+//# sourceMappingURL=run.cjs.js.map

package/dist/run.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"run.cjs.js","sources":["../src/run.ts"],"sourcesContent":["/*\n * Copyright 2020 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { execFile as execFileCb } from 'child_process';\nimport { promisify } from 'util';\n\nexport const execFile = promisify(execFileCb);\n"],"names":["promisify","execFileCb"],"mappings":";;;;;AAmBa,MAAA,QAAA,GAAWA,eAAUC,sBAAU;;;;"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/cli-node",
-  "version": "0.2.8",
+  "version": "0.2.9-next.0",
   "description": "Node.js library for Backstage CLIs",
   "backstage": {
     "role": "node-library"
@@ -31,9 +31,9 @@
     "test": "backstage-cli package test"
   },
   "dependencies": {
-    "@backstage/cli-common": "^0.1.14",
-    "@backstage/errors": "^1.2.4",
-    "@backstage/types": "^1.1.1",
+    "@backstage/cli-common": "0.1.14",
+    "@backstage/errors": "1.2.4",
+    "@backstage/types": "1.1.1",
     "@manypkg/get-packages": "^1.1.3",
     "@yarnpkg/parsers": "^3.0.0",
     "fs-extra": "^11.2.0",
@@ -41,7 +41,7 @@
     "zod": "^3.22.4"
   },
   "devDependencies": {
-    "@backstage/backend-test-utils": "^1.0.0",
-    "@backstage/cli": "^0.27.1"
+    "@backstage/backend-test-utils": "1.0.1-next.2",
+    "@backstage/cli": "0.28.0-next.2"
   }
 }