@devkong/cli 0.0.16 → 0.0.17-0

package/assets/python-install.bat

@@ -23,5 +23,4 @@ cd %EXTENSION_DIR%
 
 call .venv\Scripts\activate.bat
 
-%PIP_CMD% install -r requirements.txt
-%PIP_CMD% install -r requirements-dev.txt
+%PIP_CMD% install -r requirements.txt -r requirements-dev.txt

package/index.js

@@ -66902,9 +66902,12 @@ function getProfile(profileName = "default") {
   const profile = availableProfiles[profileName] || {
     kongBaseUrl: urlText("")
   };
-  profile.kongBaseUrl = urlText(optionalEnv("KONG_BASE_URL")) || profile.kongBaseUrl;
+  profile.kongBaseUrl = profile.kongBaseUrl || urlText(optionalEnv("KONG_BASE_URL"));
   return profile;
 }
+function printProfile(profile) {
+  console.info(`Current profile=${profile}, baseUrl=${getProfile(profile).kongBaseUrl}`);
+}
 
 // packages/kong-cli/src/commands/configureCommand.ts
 var ConfigureCommand = class {
@@ -69696,7 +69699,6 @@ var InstallCommand = class {
         title: "Installing dependencies with pip",
         task: async (_2, task) => {
           const scriptPath = this.scriptPath();
-          task.output = `${scriptPath} ${workspaceDirectory}`;
           await spawnCommand(
             `${scriptPath} ${workspaceDirectory}`,
             new ListrTaskLogger(task, this.verbose ? 3 /* DEBUG */ : 0 /* INFO */),
@@ -69755,10 +69757,58 @@ var ManagementClient = class {
     const url2 = joinUrlAndPath(this.baseUrl, "v1/extensions", extensionId, "/snapshots/versions");
     return (await axios_default.get(url2, API_HEADERS)).data;
   }
+  async getExtensionSnapshotAliases(extensionId) {
+    const url2 = joinUrlAndPath(this.baseUrl, "v1/extensions", extensionId, "/aliases");
+    return (await axios_default.get(url2, API_HEADERS)).data;
+  }
 };
 
-// packages/kong-cli/src/commands/listExtensionSnapshotCommand.ts
-var ListExtensionSnapshotCommand = class {
+// packages/kong-cli/src/commands/listAliasesCommand.ts
+var ListAliasesCommand = class {
+  constructor(profile, verbose) {
+    this.profile = profile;
+    this.verbose = verbose;
+    this.managementClient = new ManagementClient(this.profile.kongBaseUrl);
+  }
+  async execute() {
+    await new Listr(
+      [
+        {
+          title: "List extension aliases",
+          task: async (ctx, task) => {
+            const kongJson = getKongJson();
+            const aliases = await this.managementClient.getExtensionSnapshotAliases(kongJson.id);
+            if (aliases.length === 0) {
+              task.output = "No aliases available";
+            } else {
+              const result = [];
+              for (const alias of aliases) {
+                for (const item of alias.use) {
+                  result.push(`${alias.name}, ${item.snapshot.version}, ${item.balance}%`);
+                }
+              }
+              task.output = result.join("\n");
+            }
+          },
+          rendererOptions: {
+            persistentOutput: true
+          }
+        }
+      ],
+      {
+        renderer: "default",
+        rendererOptions: {
+          logger: new ListrLogger({
+            processOutput: new ProcessOutput(process.stderr, process.stderr)
+          })
+        }
+      }
+    ).run();
+  }
+};
+
+// packages/kong-cli/src/commands/listVersionsCommand.ts
+var ListVersionsCommand = class {
   constructor(profile, verbose) {
     this.verbose = verbose;
     this.managementClient = new ManagementClient(profile.kongBaseUrl);
@@ -69952,7 +70002,7 @@ var PublicClient = class {
   }
 };
 
-// packages/kong-cli/src/commands/setExtensionAliasCommand.ts
+// packages/kong-cli/src/commands/setAliasCommand.ts
 function validateName(value) {
   if (isEmpty(value)) {
     throw new AppError("The alias name should not be empty.");
@@ -69963,7 +70013,7 @@ function validateName(value) {
     );
   }
 }
-var SetExtensionAliasCommand = class {
+var SetAliasCommand = class {
   constructor(profile) {
     this.publicClient = new PublicClient(profile.kongBaseUrl);
     this.managementClient = new ManagementClient(profile.kongBaseUrl);
@@ -70068,6 +70118,7 @@ async function main() {
     "Build and automatically tag the current code with an incremented version, ready for selection in extension aliases"
   ).addOption(new Option("--profile <name>", "Configured Kong profile to use").default("default")).addOption(new Option("--verbose", "Show full logs during command execution")).addOption(new Option("--notes [text]", "Optional version notes").default("")).action(async (options) => {
     try {
+      printProfile(options.profile);
       const kongJson = getKongJson();
       await new PublishVersionCommand(getProfile(options.profile), options.verbose).execute(
         kongJson.name,
@@ -70079,24 +70130,28 @@ async function main() {
   });
   const listVersionsCommand = new Command("list-versions").description("List available versions").addOption(new Option("--profile <name>", "Configured Kong profile to use").default("default")).addOption(new Option("--verbose", "Show full logs during command execution")).action(async (options) => {
     try {
-      await new ListExtensionSnapshotCommand(
-        getProfile(options.profile),
-        options.verbose
-      ).execute();
+      printProfile(options.profile);
+      await new ListVersionsCommand(getProfile(options.profile), options.verbose).execute();
     } catch (ex) {
       printError("list-versions command failed", ex);
     }
   });
   const setAliasCommand = new Command("set-alias").description("Assign alias to an extension").argument("alias-name", "Alias name to assign").argument("extension-version", "Extension version to use. Should be one of existing versions").addOption(new Option("--profile <name>", "Configured Kong profile to use").default("default")).action(async (aliasName, extensionVersion, options) => {
     try {
-      await new SetExtensionAliasCommand(getProfile(options.profile)).execute(
-        aliasName,
-        extensionVersion
-      );
+      printProfile(options.profile);
+      await new SetAliasCommand(getProfile(options.profile)).execute(aliasName, extensionVersion);
     } catch (ex) {
       printError("set-alias command failed", ex);
     }
   });
+  const listAliasesCommand = new Command("list-aliases").description("List available extension aliases").addOption(new Option("--profile <name>", "Configured Kong profile to use").default("default")).action(async (options) => {
+    try {
+      printProfile(options.profile);
+      await new ListAliasesCommand(getProfile(options.profile), options.verbose).execute();
+    } catch (ex) {
+      printError("list-aliases command failed", ex);
+    }
+  });
   const cli = new Command().version(getPresetVersion()).description("CLI to support creating and publishing Kong extensions");
   cli.addCommand(generateCommand);
   cli.addCommand(configureCommand);
@@ -70104,6 +70159,7 @@ async function main() {
   cli.addCommand(publishVersionCommand);
   cli.addCommand(listVersionsCommand);
   cli.addCommand(setAliasCommand);
+  cli.addCommand(listAliasesCommand);
   cli.parse(process.argv);
 }
 main();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@devkong/cli",
-  "version": "0.0.16",
+  "version": "0.0.17-0",
   "type": "commonjs",
   "main": "./index.js",
   "typings": "./index.d.ts",

package/packages/kong-cli/src/commands/listAliasesCommand.d.ts

@@ -0,0 +1,8 @@
+import { Profile } from "../common/profile";
+export declare class ListAliasesCommand {
+    private profile;
+    private verbose;
+    private readonly managementClient;
+    constructor(profile: Profile, verbose: boolean);
+    execute(): Promise<void>;
+}

package/packages/kong-cli/src/commands/{listExtensionSnapshotCommand.d.ts → listVersionsCommand.d.ts}

@@ -1,5 +1,5 @@
 import { Profile } from "../common/profile";
-export declare class ListExtensionSnapshotCommand {
+export declare class ListVersionsCommand {
     private verbose;
     private readonly managementClient;
     constructor(profile: Profile, verbose: boolean);

package/packages/kong-cli/src/commands/{setExtensionAliasCommand.d.ts → setAliasCommand.d.ts}

@@ -1,5 +1,5 @@
 import { Profile } from "../common/profile";
-export declare class SetExtensionAliasCommand {
+export declare class SetAliasCommand {
     private publicClient;
     private managementClient;
     constructor(profile: Profile);

package/packages/kong-cli/src/common/profile.d.ts

@@ -7,3 +7,4 @@ export type ConfigProfiles = Record<ProfileName, Profile>;
 export declare function loadProfiles(): ConfigProfiles;
 export declare function saveProfiles(profiles: ConfigProfiles): void;
 export declare function getProfile(profileName?: string): Profile;
+export declare function printProfile(profile: string): void;

package/packages/kong-cli/src/services/managementClient.d.ts

@@ -1,4 +1,4 @@
-import { AppExtension, AppExtensionSnapshot, AppExtensionSnapshotDetails } from "@kong/contract";
+import { AppExtension, AppExtensionAlias, AppExtensionSnapshot, AppExtensionSnapshotDetails } from "@kong/contract";
 import { Optional, UrlText } from "@kong/ts";
 export declare class ManagementClient {
     private readonly baseUrl;
@@ -6,4 +6,5 @@ export declare class ManagementClient {
     createExtensionSnapshot(extensionId: AppExtension["id"], extensionName: AppExtension["name"], snapshot: Omit<AppExtensionSnapshotDetails, "id">): Promise<void>;
     getExtensionSnapshot(extensionName: AppExtension["name"], extensionSnapshotVersion: AppExtensionSnapshot["version"]): Promise<Optional<AppExtensionSnapshotDetails>>;
     getExtensionSnapshotVersions(extensionId: AppExtension["id"]): Promise<AppExtensionSnapshot[]>;
+    getExtensionSnapshotAliases(extensionId: AppExtension["id"]): Promise<AppExtensionAlias[]>;
 }

package/packages/kong-spec/src/lib/kongSpec.d.ts

@@ -111,6 +111,7 @@ export interface KongSpecStateCompensate extends KongSpecStateBase, KongSpecSupp
 }
 export interface KongSpecCondition extends KongSpecSupportsTransition, KongSpecSupportsTransition {
     id: Distinct<string, "KongSpecConditionId">;
+    description: string;
     match: JqFilter;
 }
 export interface KongSpecStateSwitch extends KongSpecStateBase, KongSpecCanBeUsedForCompensation, KongSpecSupportsTransition {

package/packages/kong-ts-contract/src/index.d.ts

@@ -18,5 +18,6 @@ export type { AppProject } from "./lib/appProject";
 export type { AppTestCase } from "./lib/appTestCase";
 export type { AppTestCaseDetails } from "./lib/appTestCaseDetails";
 export type { AppTestCaseMatchFeature } from "./lib/appTestCaseMatchFeature";
+export type { AppTestResult } from "./lib/appTestResult";
 export type { AppWorkspace } from "./lib/appWorkspace";
 export type { SdkExtensionAlias } from "./lib/sdkExtensionAlias";

package/packages/kong-ts-contract/src/lib/appTestCase.d.ts

@@ -1,8 +1,10 @@
-import { Entity, User, UtcDateTime } from "@kong/ts";
+import { Entity, JsonObject, User, UtcDateTime } from "@kong/ts";
 export interface AppTestCase extends Entity {
     id: number;
     title: string;
     tags: string[];
+    inputPayload: JsonObject;
+    expectedResult: JsonObject;
     created: UtcDateTime;
     updated: UtcDateTime;
     createdBy: User["name"];

package/packages/kong-ts-contract/src/lib/appTestResult.d.ts

@@ -0,0 +1,12 @@
+import { JsonObject, User, UtcDateTime } from "@kong/ts";
+import { AppTestCase } from "./appTestCase";
+export interface AppTestResult {
+    id?: number;
+    testCaseId: AppTestCase["id"];
+    testRunId: number;
+    actualResult: JsonObject;
+    created: UtcDateTime;
+    updated: UtcDateTime;
+    createdBy: User["name"];
+    updatedBy: User["name"];
+}