@devkong/cli 0.0.67-alpha.7 → 0.0.67-alpha.9

package/assets/python-install.bat

@@ -1,28 +1,28 @@
-@echo off
-
-set EXTENSION_DIR=%1
-echo %EXTENSION_DIR%
-
-where python >nul 2>&1
-if %errorlevel% equ 0 (
-    set PYTHON_CMD=python
-) else (
-    set PYTHON_CMD=python3
-)
-
-where pip >nul 2>&1
-if %errorlevel% equ 0 (
-    set PIP_CMD=pip
-) else (
-    set PIP_CMD=pip3
-)
-
-cd %EXTENSION_DIR%
-
-%PYTHON_CMD% -m venv .venv
-
-call .venv\Scripts\activate.bat
-
-%PIP_CMD% freeze > requirements-lock.txt
-%PIP_CMD% install --default-timeout=120 -r requirements.txt -r requirements-dev.txt
-%PIP_CMD% freeze > requirements-lock.txt
+@echo off
+
+set EXTENSION_DIR=%1
+echo %EXTENSION_DIR%
+
+where python >nul 2>&1
+if %errorlevel% equ 0 (
+    set PYTHON_CMD=python
+) else (
+    set PYTHON_CMD=python3
+)
+
+cd %EXTENSION_DIR%
+
+REM Recreate the venv from scratch so a stale interpreter path (e.g. left over
+REM after a Python upgrade or a moved/copied project) can't leave pip pointing
+REM at a missing binary.
+%PYTHON_CMD% -m venv --clear .venv
+if errorlevel 1 exit /b 1
+
+call .venv\Scripts\activate.bat
+
+REM Invoke pip via `python -m pip` rather than the pip/pip3 wrapper so we don't
+REM depend on the wrapper script's (possibly stale) shebang.
+python -m pip freeze > requirements-lock.txt
+python -m pip install --default-timeout=120 -r requirements.txt -r requirements-dev.txt
+if errorlevel 1 exit /b 1
+python -m pip freeze > requirements-lock.txt

package/assets/python-install.sh

@@ -1,4 +1,5 @@
 #!/bin/bash
+set -e
 
 EXTENSION_DIR=$1
 
@@ -8,18 +9,17 @@ else
     PYTHON_CMD="python3"
 fi
 
-if [ -x "$(command -v python)" ]; then
-    PIP_CMD="pip"
-else
-    PIP_CMD="pip3"
-fi
-
 cd "$EXTENSION_DIR" || exit
 
-$PYTHON_CMD -m venv .venv
+# Recreate the venv from scratch so a stale interpreter path (e.g. left over
+# after a Python/nvm/pyenv upgrade) can't leave pip pointing at a missing
+# binary, which fails with "cannot execute: required file not found".
+$PYTHON_CMD -m venv --clear .venv
 
 source .venv/bin/activate
 
-$PIP_CMD freeze > requirements-lock.txt
-$PIP_CMD install --default-timeout=120 -r requirements-dev.txt -r requirements.txt
-$PIP_CMD freeze > requirements-lock.txt
+# Invoke pip via `python -m pip` rather than the pip/pip3 wrapper so we don't
+# depend on the wrapper script's (possibly stale) shebang.
+python -m pip freeze > requirements-lock.txt
+python -m pip install --default-timeout=120 -r requirements-dev.txt -r requirements.txt
+python -m pip freeze > requirements-lock.txt

package/index.js

@@ -60845,14 +60845,14 @@ var ConfigureCommand = class {
     const { profileName } = await dist_default14.prompt({
       type: "select",
       name: "profileName",
-      message: "Select a profile to configure:",
+      message: "select a profile to configure:",
       choices: [...profileNames, "Create a new profile"]
     });
     if (profileName === "Create a new profile") {
       const { newProfileName } = await dist_default14.prompt({
         type: "input",
         name: "newProfileName",
-        message: "Enter name for the new profile:",
+        message: "enter name for the new profile:",
         validate: (input) => profileNames.includes(input) ? "Profile already exists!" : true
       });
       return [newProfileName, createEmptyProfile()];
@@ -60863,20 +60863,20 @@ var ConfigureCommand = class {
     const answerUrl = await dist_default14.prompt({
       type: "input",
       name: "kongUrl",
-      message: `Enter URL for profile "${name}":`,
+      message: `enter URL for profile "${name}":`,
       default: profile.kongBaseUrl
     });
     const answerUserName = await dist_default14.prompt({
       type: "input",
       name: "userName",
-      message: `Enter user name for profile "${name}":`,
+      message: `enter user name for profile "${name}":`,
       default: profile.userName
     });
     const answerPassword = await dist_default14.prompt({
       type: "password",
       name: "password",
       mask: "*",
-      message: `Enter password for user "${answerUserName.userName}":`,
+      message: `enter password for user "${answerUserName.userName}":`,
       default: ""
     });
     const updated = {
@@ -60888,7 +60888,7 @@ var ConfigureCommand = class {
       const entry = new import_keyring.Entry(updated.kongBaseUrl, updated.userName);
       entry.setPassword(answerPassword.password);
     }
-    console.log(`Configuration for profile "${name}" has been updated`);
+    console.log(`configuration for profile "${name}" has been updated`);
     return updated;
   }
 };
@@ -62923,7 +62923,7 @@ var InstallCommand = class {
   async execute(workspaceDirectory) {
     await new Listr([
       {
-        title: "Installing dependencies with pip",
+        title: "installing dependencies with pip",
         task: async (_2, task) => {
           const scriptPath = this.scriptPath();
           await spawnCommandWithArgs(
@@ -63119,17 +63119,19 @@ var ListAliasesCommand = class {
     await new Listr(
       [
         {
-          title: "List extension aliases",
+          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";
+              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}%`);
+                  result.push(
+                    `${alias.name}, ${item.snapshot.version}, ${item.balance ? `${item.balance}%` : "shadow"}`
+                  );
                 }
               }
               task.output = result.join("\n");
@@ -63165,12 +63167,12 @@ var ListVersionsCommand = class {
     await new Listr(
       [
         {
-          title: "List extension snapshot versions",
+          title: "list extension snapshot versions",
           task: async (ctx, task) => {
             const kongJson = getKongJson();
             const versions = await this.managementClient.getExtensionSnapshotVersions(kongJson.id);
             if (versions.length === 0) {
-              task.output = "No versions available";
+              task.output = "no versions available";
             } else {
               const result = [];
               for (const ver of versions) {
@@ -63261,7 +63263,7 @@ var PublishVersionCommand = class {
     const kongJson = getKongJson();
     if (kongJson.sdk === "kotlin" && !this.contractPath) {
       yield {
-        title: "Build extension",
+        title: "build extension",
         task: async (ctx, task) => {
           const logger = new ListrTaskLogger(task, this.verbose ? 3 /* DEBUG */ : 0 /* INFO */);
           const cmdText = this.getKotlinBuildCmdTask();
@@ -63272,7 +63274,7 @@ var PublishVersionCommand = class {
       };
     }
     yield {
-      title: "Generate schema",
+      title: "generate schema",
       task: async (ctx, task) => {
         const logger = new ListrTaskLogger(task, this.verbose ? 3 /* DEBUG */ : 0 /* INFO */);
         if (this.contractPath) {
@@ -63287,13 +63289,13 @@ var PublishVersionCommand = class {
       rendererOptions: this.defaultRendererOptions
     };
     yield {
-      title: "Get publish details",
+      title: "get publish details",
       task: async (ctx) => {
         ctx.publishDetails = await this.registryClient.getPublishDetails(appName);
       }
     };
     yield {
-      title: "Docker login",
+      title: "docker login",
       task: async (ctx, task) => {
         const publishDetails = ctx.publishDetails;
         const regUrl = this.resolveRegistryUrl(publishDetails.repoName);
@@ -63305,7 +63307,7 @@ var PublishVersionCommand = class {
       rendererOptions: this.defaultRendererOptions
     };
     yield {
-      title: "Docker build",
+      title: "docker build",
       task: async (ctx, task) => {
         const publishDetails = ctx.publishDetails;
         const regUrl = this.resolveRegistryUrl(publishDetails.repoName);
@@ -63318,7 +63320,7 @@ var PublishVersionCommand = class {
       rendererOptions: this.defaultRendererOptions
     };
     yield {
-      title: "Docker push",
+      title: "docker push",
       task: async (ctx, task) => {
         const cmd = this.dockerPushCmdText(ctx.fullImageName);
         await spawnCommand(
@@ -63329,7 +63331,7 @@ var PublishVersionCommand = class {
       rendererOptions: this.defaultRendererOptions
     };
     yield {
-      title: "Save publish details",
+      title: "save publish details",
       task: async (ctx, task) => {
         const publishDetails = ctx.publishDetails;
         let autoGeneratedContract;
@@ -63398,7 +63400,7 @@ var PublishVersionCommand = class {
         });
         await this.managementClient.createExtensionSnapshot(kongJson.id, snapshot);
         task.output = [
-          `The version ${publishDetails.imageVersion} has been successfully published!`,
+          `the version ${publishDetails.imageVersion} has been successfully published!`,
           joinUrlAndPath(this.profile.kongBaseUrl, "/extensions/aliases")
         ].join("\n");
       },
@@ -63522,7 +63524,6 @@ function validateName(value) {
 }
 var DEPLOY_STEPS = [
   "create deployment",
-  "health check",
   "save deployment details",
   "deployment completed"
 ];
@@ -63553,7 +63554,7 @@ var SetAliasCommand = class {
     await new Listr(
       [
         {
-          title: "Get snapshot details",
+          title: "get snapshot details",
           task: async (ctx, task) => {
             ctx.kongJson = getKongJson();
             ctx.snapshot = await this.managementClient.getExtensionSnapshot(
@@ -63566,7 +63567,7 @@ var SetAliasCommand = class {
           }
         },
         {
-          title: "Assign extension alias",
+          title: "assign extension alias",
           task: async (ctx, task) => {
             const now = utcNow(DEFAULT_TIMEZONE);
             const aliasUse = {
@@ -63596,7 +63597,6 @@ var SetAliasCommand = class {
               updatedBy: ""
             };
             await this.publicClient.assignExtensionAlias(ctx.kongJson.id, alias);
-            task.output = joinUrlAndPath(this.profile.kongBaseUrl, "/extensions/aliases");
             this.pollDeploymentSteps(steps, ctx.kongJson.id, aliasName, startedAt, timeoutSeconds);
           },
           rendererOptions: { persistentOutput: true }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@devkong/cli",
-  "version": "0.0.67-alpha.7",
+  "version": "0.0.67-alpha.9",
   "type": "commonjs",
   "main": "./index.js",
   "typings": "./index.d.ts",

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

@@ -1,7 +1,7 @@
 export { makeServerlessJavaAppProps, serverlessFlowBuilder, stringifyServerlessFlow, } from "./lib/kongServerless";
 export type { FloweyServerlessBuilder } from "./lib/kongServerless";
 export type { KongSpecJobSession } from "./lib/kongSession";
-export type { KongSpecAction, KongSpecActionCallFunction, KongSpecActionCallProcess, KongSpecActionDelay, KongSpecActionInject, KongSpecActionSendEvent, KongSpecAnnotation, KongSpecBranch, KongSpecCache, KongSpecCallModel, KongSpecCircuitBreaker, KongSpecCondition, KongSpecEffect, KongSpecEffectStatus, KongSpecError, KongSpecEventBroker, KongSpecEventConnection, KongSpecFeatureCompensation, KongSpecFlow, KongSpecFunctionRef, KongSpecHowToInvoke, KongSpecHowToOutput, KongSpecHowToStore, KongSpecOutputAppend, KongSpecProcessRef, KongSpecRecord, KongSpecRecordHeader, KongSpecRetry, KongSpecRule, KongSpecSecretRef, KongSpecSecretType, KongSpecState, KongSpecStateCallFunction, KongSpecStateCallProcess, KongSpecStateCompensate, KongSpecStateDelay, KongSpecStateExit, KongSpecStateFail, KongSpecStateForeach, KongSpecStateInject, KongSpecStateParallel, KongSpecStateResult, KongSpecStateRule, KongSpecStateSendEvent, KongSpecStateStart, KongSpecStateSucceed, KongSpecStateSwitch, KongSpecStateWaitEvent, KongSpecStoreRetryControl, KongSpecSupportsActions, KongSpecSupportsErrors, KongSpecSupportsInvoke, KongSpecSupportsOutputSample, KongSpecSupportsOutputStore, KongSpecSupportsTransition, } from "./lib/kongSpec";
+export type { KongSpecAction, KongSpecActionCallFunction, KongSpecActionCallProcess, KongSpecActionDelay, KongSpecActionInject, KongSpecActionSendEvent, KongSpecAnnotation, KongSpecBranch, KongSpecCache, KongSpecCallModel, KongSpecCircuitBreaker, KongSpecCondition, KongSpecEffect, KongSpecEffectStatus, KongSpecError, KongSpecEventBroker, KongSpecEventConnection, KongSpecFeatureCompensation, KongSpecFlow, KongSpecFunctionRef, KongSpecHowToInvoke, KongSpecHowToOutput, KongSpecHowToStore, KongSpecOutputAppend, KongSpecProcessRef, KongSpecRecord, KongSpecRecordHeader, KongSpecRetry, KongSpecRule, KongSpecSecretRef, KongSpecSecretType, KongSpecState, KongSpecStateCallFunction, KongSpecStateCallProcess, KongSpecStateCompensate, KongSpecStateDelay, KongSpecStateExit, KongSpecStateFail, KongSpecStateForeach, KongSpecStateInject, KongSpecStateParallel, KongSpecStateResult, KongSpecStateRule, KongSpecStateSendEvent, KongSpecStateStart, KongSpecStateSucceed, KongSpecStateSwitch, KongSpecStateWaitEvent, KongSpecStoreRetryControl, KongSpecSupportsActions, KongSpecSupportsErrors, KongSpecSupportsInvoke, KongSpecSupportsOutputSample, KongSpecSupportsOutputStore, KongSpecSupportsTaskMode, KongSpecSupportsTransition, } from "./lib/kongSpec";
 export { KongSpecBuild } from "./lib/kongSpecBuild";
 export { KongSpecDoc } from "./lib/kongSpecDoc";
 export { KongSpecEnv } from "./lib/kongSpecEnv";
@@ -14,5 +14,7 @@ export { KongSpecRef } from "./lib/kongSpecRef";
 export type { KongSpecActionPath, KongSpecStatePath } from "./lib/kongSpecRef";
 export { convertSpecToServerless } from "./lib/kongSpecToServerless";
 export { findSourceState, getActions, getConnectedExitStates, getDependencies, outputAggregator, outputAggregatorUnsafe, parallelStateOutputAggregator, parallelStateOutputAggregatorUnsafe, quoteSecretReferences, traverseFlowUp, } from "./lib/kongSpecUtils";
+export { getKongFunctionOperations, getKongFunctionOperationSchema, getKongSpecXUI, getKongSpecXUIComponentConfig, isKongFunctionContractSchema, } from "./lib/kongSpecFunctionContract";
+export type { KongSpecXUIComponentConfig, KongSpecXUIConfig, KongSpecXUIFormConfig, KongSpecXUISecretConfig, } from "./lib/kongSpecFunctionContract";
 export { validate } from "./lib/kongSpecValidate";
 export type { KongSpecValidationIssue, KongSpecValidators } from "./lib/kongSpecValidate";

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

@@ -106,7 +106,10 @@ export interface KongSpecSupportsDataGuards {
 export interface KongSpecSupportsOutputSample {
     outputSample: Optional<JsonText>;
 }
-export interface KongSpecCallModel extends KongSpecSupportsInput, KongSpecSupportsOutputFilter, KongSpecSupportsOutputStore, KongSpecSupportsOutputAppend, KongSpecSupportsOutputSample, KongSpecSupportsDataGuards, KongSpecSupportsInvoke {
+export interface KongSpecSupportsTaskMode {
+    mode: "blocking" | "non-blocking";
+}
+export interface KongSpecCallModel extends KongSpecSupportsInput, KongSpecSupportsOutputFilter, KongSpecSupportsOutputStore, KongSpecSupportsOutputAppend, KongSpecSupportsOutputSample, KongSpecSupportsDataGuards, KongSpecSupportsTaskMode, KongSpecSupportsInvoke {
 }
 export interface KongSpecSupportsErrors {
     errors: KongSpecError[];

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

@@ -15,6 +15,7 @@ export declare class KongSpecDoc {
     static aboutIdentify: string;
     static aboutSizeLimit: (bytes: string) => string;
     static aboutCallFunction: string;
+    static aboutMode: string;
     static aboutCallProcess: string;
     static aboutCompensate: string;
     static aboutFail: string;

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

@@ -0,0 +1,26 @@
+import { Optional } from "@kong/ts";
+import { JSONSchema7 } from "json-schema";
+import { KongSpecSecretType } from "./kongSpec";
+export interface KongSpecXUISecretConfig {
+    purpose: string;
+    types: Array<KongSpecSecretType>;
+}
+export interface KongSpecXUIComponentConfig {
+    type: "TEXT_AREA";
+}
+export type KongSpecXUIFormConfig = Record<string, KongSpecXUIComponentConfig>;
+export interface KongSpecXUIConfig {
+    version?: number;
+    secrets: Array<KongSpecXUISecretConfig>;
+    form: KongSpecXUIFormConfig;
+}
+/** Reads the `x-ui` block of a schema, if present. */
+export declare function getKongSpecXUI(schema: Optional<JSONSchema7> | null): Optional<KongSpecXUIConfig>;
+/** Reads the `x-ui.form` component config for a property path (e.g. `[".notes"]`). */
+export declare function getKongSpecXUIComponentConfig(schema: Optional<JSONSchema7> | null, path: string[]): Optional<KongSpecXUIComponentConfig>;
+/** True when the schema describes a KongFunctionContract (i.e. it exposes a `request` envelope). */
+export declare function isKongFunctionContractSchema(schema: Optional<JSONSchema7> | null): boolean;
+/** The operation names of a contract schema — all object properties except `request`. */
+export declare function getKongFunctionOperations(schema: Optional<JSONSchema7> | null): string[];
+/** The sub-schema describing the payload of a single operation. */
+export declare function getKongFunctionOperationSchema(schema: Optional<JSONSchema7> | null, operation: string): Optional<JSONSchema7>;

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

@@ -8,7 +8,7 @@ interface TestItem {
 interface Dependency {
     type: "function" | "process";
     tenant: SessionTenant;
-    basedOn: KongSpecFunctionRef["basedOn"] | KongSpecFunctionRef["basedOn"];
+    basedOn: KongSpecFunctionRef["basedOn"] | KongSpecProcessRef["basedOn"];
     aliasName: KongSpecFunctionRef["aliasName"] | KongSpecProcessRef["aliasName"];
     usage: Array<KongSpecAction["name"] | KongSpecState["name"]>;
 }

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

@@ -1,5 +1,5 @@
 import { AppSnapshot } from "./appSnapshot";
 export interface AppAliasUse {
     snapshot: AppSnapshot;
-    balance: number;
+    balance: number | null;
 }

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

@@ -3,7 +3,7 @@ import { AppAliasUse } from "./appAliasUse";
 import { AppSnapshotDetails } from "./appSnapshotDetails";
 export interface AppAliasUseDetails extends AppAliasUse {
     snapshot: AppSnapshotDetails;
-    balance: number;
+    balance: number | null;
     inputFilter?: JqFilter;
     outputFilter?: JqFilter;
 }