@jskit-ai/agent-docs 0.1.34 → 0.1.36
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/package.json
CHANGED
|
@@ -822,7 +822,7 @@ Exports
|
|
|
822
822
|
- `createSessionId`
|
|
823
823
|
- `extractIssueTitle(value = "")`
|
|
824
824
|
- `extractIssueText(value = "")`
|
|
825
|
-
- `
|
|
825
|
+
- `extractIssueDetails(value = "")`
|
|
826
826
|
- `extractPlanText(value = "")`
|
|
827
827
|
- `inspectSession({ targetRoot = process.cwd(), sessionId } = {})`
|
|
828
828
|
- `inspectSessionDiff({ targetRoot = process.cwd(), sessionId } = {})`
|
|
@@ -839,13 +839,22 @@ Local functions
|
|
|
839
839
|
- `existingSessionContext({ targetRoot = process.cwd(), sessionId } = {})`
|
|
840
840
|
- `withExistingSession(input, handler)`
|
|
841
841
|
- `extractMarkedText(value = "", marker = "")`
|
|
842
|
+
- `extractMarkedField(value = "", fieldName = "")`
|
|
842
843
|
- `extractIssueCategory(value = "")`
|
|
843
844
|
- `extractUiImpact(value = "")`
|
|
844
845
|
- `extractAgentDecisions(value = "")`
|
|
845
846
|
- `normalizeIssueCategory(value = "")`
|
|
846
847
|
- `normalizeUiImpact(value = "")`
|
|
847
848
|
- `writePromptArtifact(paths, fileName, prompt)`
|
|
849
|
+
- `codexResultPath(paths, stepId)`
|
|
850
|
+
- `codexResponseContractForStep(stepId)`
|
|
851
|
+
- `requireCodexStepResult(paths, stepId, result, preconditions = [], contractOverride = null)`
|
|
848
852
|
- `commandText(command, args = [])`
|
|
853
|
+
- `cycleRootPath(paths, cycle)`
|
|
854
|
+
- `cyclePlanPath(paths, cycle)`
|
|
855
|
+
- `cyclePlanPromptFileName(cycle)`
|
|
856
|
+
- `cyclePlanExecutionPromptFileName(cycle)`
|
|
857
|
+
- `readCurrentPlan(paths)`
|
|
849
858
|
- `commandOutputSummary(output = "")`
|
|
850
859
|
- `appendCommandLog(paths, { args = [], command, cwd = "", kind = "command", result } = {})`
|
|
851
860
|
- `runLoggedCommand(paths, kind, command, args = [], options = {})`
|
|
@@ -871,19 +880,17 @@ Local functions
|
|
|
871
880
|
- `draftIssue(paths, options = {})`
|
|
872
881
|
- `titleFromIssue(issueText)`
|
|
873
882
|
- `createIssue(paths, _options = {}, context = {})`
|
|
874
|
-
- `
|
|
875
|
-
- `
|
|
883
|
+
- `renderIssueDetailsPrompt(paths, _options = {}, context = {})`
|
|
884
|
+
- `saveIssueDetails(paths, options = {}, context = {})`
|
|
876
885
|
- `makePlan(paths, options = {}, context = {})`
|
|
877
|
-
- `renderPlanExecutionPrompt(paths,
|
|
878
|
-
- `renderPlanFineTuningPrompt(paths, _options = {}, context = {})`
|
|
886
|
+
- `renderPlanExecutionPrompt(paths, options = {}, context = {})`
|
|
879
887
|
- `worktreeStatus(worktree)`
|
|
880
888
|
- `untrackedFiles(worktree)`
|
|
881
889
|
- `untrackedFileDiff(worktree, filePath)`
|
|
882
890
|
- `untrackedFilesDiff(worktree)`
|
|
883
|
-
- `acceptImplementationChanges(paths)`
|
|
884
891
|
- `commitWorktree(paths, { message, allowNoChanges = false } = {})`
|
|
885
|
-
- `
|
|
886
|
-
- `
|
|
892
|
+
- `uniqueChangedFileList(entries = [])`
|
|
893
|
+
- `changedFilesInWorktree(paths)`
|
|
887
894
|
- `changedFilesSinceBase(paths)`
|
|
888
895
|
- `nextReviewPassNumber(pass = "")`
|
|
889
896
|
- `readCurrentReviewPass(paths)`
|
|
@@ -893,24 +900,15 @@ Local functions
|
|
|
893
900
|
- `currentHead(paths)`
|
|
894
901
|
- `renderReviewPrompt(paths)`
|
|
895
902
|
- `acceptReviewChanges(paths, options = {})`
|
|
896
|
-
- `
|
|
897
|
-
- `runAutomatedChecks(paths, { stepId, label })`
|
|
898
|
-
- `readCheckResult(paths, stepId)`
|
|
899
|
-
- `maybeCommitCheckRepair(paths, { label, stepId })`
|
|
900
|
-
- `uiCheckAcceptStepId(stepId)`
|
|
901
|
-
- `uiCheckCommitStepId(stepId)`
|
|
902
|
-
- `uiCheckSourceStepId(stepId)`
|
|
903
|
-
- `uiCheckLabelForStep(stepId)`
|
|
903
|
+
- `runAutomatedChecks(paths, { stepId, label }, options = {}, context = {})`
|
|
904
904
|
- `writeUiCheckJson(paths, fileName, payload)`
|
|
905
905
|
- `runDeepUiCheck(paths, { stepId, label, phase }, options = {}, context = {})`
|
|
906
|
-
- `acceptUiCheckChanges(paths, { stepId }, _options = {}, context = {})`
|
|
907
|
-
- `commitUiCheckChanges(paths, { stepId }, _options = {}, context = {})`
|
|
908
906
|
- `userCheck(paths, options = {})`
|
|
907
|
+
- `readAcceptedChangesCommit(paths)`
|
|
908
|
+
- `commitAcceptedChanges(paths, _options = {}, context = {})`
|
|
909
909
|
- `updateBlueprint(paths, options = {}, context = {})`
|
|
910
910
|
- `readPackageJson(root)`
|
|
911
911
|
- `doctorCommandForWorktree(worktree)`
|
|
912
|
-
- `runDoctor(paths)`
|
|
913
|
-
- `maybeCommitDoctorRepair(paths)`
|
|
914
912
|
- `commitLinesSinceBase(paths)`
|
|
915
913
|
- `readCheckSummaries(paths)`
|
|
916
914
|
- `readUiCheckSummaries(paths)`
|
|
@@ -956,15 +954,20 @@ Exports
|
|
|
956
954
|
- `STEP_IDS`
|
|
957
955
|
- `STEP_LABEL_BY_ID`
|
|
958
956
|
- `STEP_PRECONDITION_NAMES`
|
|
957
|
+
- `ISSUE_DETAILS_CODEX_HANDOFF`
|
|
959
958
|
- `PLAN_EXECUTION_CODEX_HANDOFF`
|
|
960
|
-
- `PLAN_FINE_TUNING_CODEX_HANDOFF`
|
|
961
959
|
- `REVIEW_EXECUTION_CODEX_HANDOFF`
|
|
962
960
|
- `DEEP_UI_CHECK_CODEX_HANDOFF`
|
|
961
|
+
- `AUTOMATED_CHECK_REPAIR_CODEX_HANDOFF`
|
|
963
962
|
- `BLUEPRINT_CODEX_HANDOFF`
|
|
963
|
+
- `JSKIT_CLI_SHELL_COMMAND`
|
|
964
|
+
- `JSKIT_CLI_SHELL_RULE`
|
|
964
965
|
- `SESSION_STATE_RELATIVE_PATH`
|
|
965
966
|
Local functions
|
|
966
|
-
- `
|
|
967
|
-
- `
|
|
967
|
+
- `fieldResponseContract(outputDefinitions)`
|
|
968
|
+
- `codexHandoff(outputDefinition, { autoInject = false, promptActionLabel = "", promptIntroText = "", promptWaitingText = "", responseContract = undefined } = {})`
|
|
969
|
+
- `stepAutomationFor({ codex = undefined, id, kind, requiresExplicitRun = false })`
|
|
970
|
+
- `defineStep({ buttonLabel, codex = undefined, description, id, input = INPUT_NONE, kind = "automatic", label, nextCommandTemplate = DEFAULT_NEXT_COMMAND_TEMPLATE, preconditions = [], requiresExplicitRun = false, submitOptions = {}, automation = undefined, utilityActions = [], displayGroupId = "", displayGroupLabel = "" })`
|
|
968
971
|
|
|
969
972
|
### `src/server/sessionRuntime/io.js`
|
|
970
973
|
Exports
|
|
@@ -994,11 +997,11 @@ Local functions
|
|
|
994
997
|
### `src/server/sessionRuntime/preconditions.js`
|
|
995
998
|
Exports
|
|
996
999
|
- `applyPreconditions(paths, checks = [])`
|
|
1000
|
+
- `assertAcceptedChangesCommitted(paths)`
|
|
997
1001
|
- `assertActiveCycleExists(paths)`
|
|
998
1002
|
- `assertActiveCycleUserCheckPassed(paths)`
|
|
999
1003
|
- `assertBlueprintUpdateSatisfied(paths)`
|
|
1000
1004
|
- `assertDeepUiCheckSatisfied(paths)`
|
|
1001
|
-
- `assertDeepUiRecheckSatisfied(paths)`
|
|
1002
1005
|
- `assertDependenciesInstalled(paths)`
|
|
1003
1006
|
- `assertFinalReportExists(paths)`
|
|
1004
1007
|
- `assertGhAuth(targetRoot)`
|
|
@@ -1008,9 +1011,8 @@ Exports
|
|
|
1008
1011
|
- `assertIssueMetadataExists(paths)`
|
|
1009
1012
|
- `assertIssueTextExists(paths)`
|
|
1010
1013
|
- `assertIssueUrlExists(paths)`
|
|
1011
|
-
- `
|
|
1012
|
-
- `
|
|
1013
|
-
- `assertPlanDetailsExists(paths)`
|
|
1014
|
+
- `assertAutomatedChecksPassed(paths)`
|
|
1015
|
+
- `assertIssueDetailsExists(paths)`
|
|
1014
1016
|
- `assertPlanTextExists(paths)`
|
|
1015
1017
|
- `assertPrUrlExists(paths)`
|
|
1016
1018
|
- `assertReadyJskitApp(paths)`
|
|
@@ -1020,6 +1022,7 @@ Exports
|
|
|
1020
1022
|
- `ensureStudioGitExclude(targetRoot)`
|
|
1021
1023
|
- `hasWorktree`
|
|
1022
1024
|
Local functions
|
|
1025
|
+
- `jskitCommand(args = "")`
|
|
1023
1026
|
- `resolveGitCommonDirectory(targetRoot)`
|
|
1024
1027
|
- `pathExists(filePath)`
|
|
1025
1028
|
- `assertActiveCycleStepReceipt(paths, { code, id, message, stepId })`
|
|
@@ -1029,6 +1032,7 @@ Exports
|
|
|
1029
1032
|
- `readPromptTemplate(targetRoot, name)`
|
|
1030
1033
|
- `renderPrompt(paths, templateName, values = {})`
|
|
1031
1034
|
- `renderTemplate(source, values = {})`
|
|
1035
|
+
- `withShellCommandRule(template)`
|
|
1032
1036
|
|
|
1033
1037
|
### `src/server/sessionRuntime/responses.js`
|
|
1034
1038
|
Exports
|
|
@@ -1037,7 +1041,7 @@ Exports
|
|
|
1037
1041
|
- `buildStepDefinitions()`
|
|
1038
1042
|
- `createError({ code, message, repairCommand = "" })`
|
|
1039
1043
|
- `createPrecondition({ id, ok, message })`
|
|
1040
|
-
- `failSession(paths, { code, message, repairCommand = "", preconditions = [], status = SESSION_STATUS.BLOCKED, prompt = "" })`
|
|
1044
|
+
- `failSession(paths, { code, message, repairCommand = "", preconditions = [], status = SESSION_STATUS.BLOCKED, prompt = "", codex = undefined })`
|
|
1041
1045
|
- `markCurrentStep(paths, stepId)`
|
|
1042
1046
|
- `markStatus(paths, status)`
|
|
1043
1047
|
- `normalizeReviewPassNumber(value = "")`
|
|
@@ -1061,10 +1065,18 @@ Local functions
|
|
|
1061
1065
|
- `readWorkflowVersion(paths)`
|
|
1062
1066
|
- `cycleStepsRoot(paths, cycle)`
|
|
1063
1067
|
- `cycleRoot(paths, cycle)`
|
|
1068
|
+
- `cyclePlanPath(paths, cycle)`
|
|
1069
|
+
- `cyclePlanPromptFileName(cycle)`
|
|
1070
|
+
- `cyclePlanExecutionPromptFileName(cycle)`
|
|
1064
1071
|
- `parseJsonFileIfExists(filePath)`
|
|
1065
1072
|
- `readReviewPassNumbers(paths)`
|
|
1066
1073
|
- `readReviewPassInfo(paths, pass)`
|
|
1067
|
-
- `
|
|
1074
|
+
- `latestReviewPass(artifacts = {})`
|
|
1075
|
+
- `latestReviewPassIsPrompted(artifacts = {})`
|
|
1076
|
+
- `readPromptFromAbsolutePath(filePath = "")`
|
|
1077
|
+
- `readReviewPromptForStep(paths, artifacts = {})`
|
|
1078
|
+
- `promptArtifactForStep(paths, stepId)`
|
|
1079
|
+
- `readPromptForStep(paths, stepId, artifacts = {})`
|
|
1068
1080
|
- `readStepFileNames(stepsRoot)`
|
|
1069
1081
|
- `readCompletedSteps(paths)`
|
|
1070
1082
|
- `applyReviewPassCompletionOverlay(paths, completedSteps = [])`
|
|
@@ -1075,12 +1087,17 @@ Local functions
|
|
|
1075
1087
|
- `readWorktreeStatus(paths, worktreeReady)`
|
|
1076
1088
|
- `resolveNextStep(completedSteps = [])`
|
|
1077
1089
|
- `cloneContractValue(value)`
|
|
1090
|
+
- `publicCodexContract(codex = null)`
|
|
1091
|
+
- `stepRepeatabilityContract(stepId)`
|
|
1078
1092
|
- `publicStepDefinition(step, index)`
|
|
1079
1093
|
- `stepIsRetryableWhenBlocked(stepId)`
|
|
1080
1094
|
- `stepIsConditional(stepId)`
|
|
1095
|
+
- `activeCycleInfoFromArtifacts(artifacts = {})`
|
|
1096
|
+
- `uiCheckPromptedForStep(artifacts = {}, stepId = "")`
|
|
1081
1097
|
- `skipReasonForStep(stepId, artifacts = {})`
|
|
1082
1098
|
- `buildCurrentStepAction(stepId, artifacts = {})`
|
|
1083
|
-
- `
|
|
1099
|
+
- `rawCodexHandoff(stepId, artifacts = {})`
|
|
1100
|
+
- `buildCodexHandoff(stepId, artifacts = {})`
|
|
1084
1101
|
- `buildNextCommand(sessionId, stepId)`
|
|
1085
1102
|
|
|
1086
1103
|
### `src/server/sessionRuntime/worktrees.js`
|