@popoverai/dotrequirements 0.38.3 → 0.38.4
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.
|
@@ -5,5 +5,5 @@
|
|
|
5
5
|
* request is validated against; the CLI can't import the backend, so this
|
|
6
6
|
* is that text, and a test keeps the two the same.
|
|
7
7
|
*/
|
|
8
|
-
export declare const REQUEST_CONTRACT = "Ask the person to decide something about the outcome you are drafting or reviewing. A choice presents options with a recommendation. The person may answer in their own words instead of picking an option, and their words are then the decision you work from. One decision per request: if two things need deciding, ask twice.\n\nA request is JSON with a \"kind\" and the fields of that kind:\n\nchoice:\n question (text, up to 200 characters): The question, phrased as a question in the words the person will read it, not as a topic.\n options (list, at least 2): The live alternatives. More than four makes deciding harder; give more only when each is a genuine choice. Leave out anything you have already ruled out.\n name (text, up to 200 characters): The option as you would say it to the person: a noun phrase they can repeat back, not a label.\n benefits (list of text, each up to 200 characters): What is better if this option is taken. One line each, in your own words.\n costs (list of text, each up to 200 characters): What is worse if this option is taken: what it would take to build, and what the person lives with afterwards. Effort is a cost like any other.\n note (text, up to 600 characters, optional): Anything you learned or checked about this option that is not a benefit or a cost. Leave it out when there is nothing to add.\n action (object, optional): An action you may take only with the person's permission, which choosing this option gives. Once they choose it, take it with `dotreq solution approval complete <decision>`. Leave it out for anything you may do yourself.\n tool (text, up to 200 characters): The action, by name.
|
|
8
|
+
export declare const REQUEST_CONTRACT = "Ask the person to decide something about the outcome you are drafting or reviewing. A choice presents options with a recommendation. The person may answer in their own words instead of picking an option, and their words are then the decision you work from. One decision per request: if two things need deciding, ask twice.\n\nA request is JSON with a \"kind\" and the fields of that kind:\n\nchoice:\n question (text, up to 200 characters): The question, phrased as a question in the words the person will read it, not as a topic.\n options (list, at least 2): The live alternatives. More than four makes deciding harder; give more only when each is a genuine choice. Leave out anything you have already ruled out.\n name (text, up to 200 characters): The option as you would say it to the person: a noun phrase they can repeat back, not a label.\n benefits (list of text, each up to 200 characters): What is better if this option is taken. One line each, in your own words.\n costs (list of text, each up to 200 characters): What is worse if this option is taken: what it would take to build, and what the person lives with afterwards. Effort is a cost like any other.\n note (text, up to 600 characters, optional): Anything you learned or checked about this option that is not a benefit or a cost. Leave it out when there is nothing to add.\n action (object, optional): An action you may take only with the person's permission, which choosing this option gives. Once they choose it, take it with `dotreq solution approval complete <decision>`. Leave it out for anything you may do yourself.\n tool (text, up to 200 characters): The action, by name. Those that need the person's permission: \"fix\", starting a fix, and \"make with you\", making the outcome you're on with the person and the solution's agent instead (args: { outcome }), when it needs their judgement more than your best guess (CONVO-8).\n args (object): The action's arguments, as it takes them: a fix's are below.\n recommendation (object): Which option you would take, and the one reason why.\n option (text, up to 200 characters): The name of the option you recommend, exactly as it appears in options.\n because (text, up to 200 characters): The one reason that carries it, in one line. The full reasoning belongs in background.\n background (text, up to 4000 characters): What the person needs to know to decide well that the options do not already say. Include only context that would substantially change the quality of the decision. The person reads this after the options, so do not reiterate them.\n\nThe args of a \"fix\" action:\n name (text, up to 120 characters): A short name for the fix, from what it puts right, as \"dice below the controls\".\n words (text, up to 2000 characters): What you found, in your own words.\n plan (text, up to 2000 characters): The fix as you would put it to the person, in a sentence or two.\n redo (list, at least 1): The outcomes the fix redoes, and what would change in each.\n outcome (text, up to 200 characters): An outcome to redo, by its name.\n change (text, up to 2000 characters): What would change in it.\n rerun (list of text, each up to 200 characters): The outcomes that await the ones redone and should run again from them. Empty when none should.";
|
|
9
9
|
//# sourceMappingURL=contract.d.ts.map
|
|
@@ -17,7 +17,7 @@ choice:
|
|
|
17
17
|
costs (list of text, each up to 200 characters): What is worse if this option is taken: what it would take to build, and what the person lives with afterwards. Effort is a cost like any other.
|
|
18
18
|
note (text, up to 600 characters, optional): Anything you learned or checked about this option that is not a benefit or a cost. Leave it out when there is nothing to add.
|
|
19
19
|
action (object, optional): An action you may take only with the person's permission, which choosing this option gives. Once they choose it, take it with \`dotreq solution approval complete <decision>\`. Leave it out for anything you may do yourself.
|
|
20
|
-
tool (text, up to 200 characters): The action, by name.
|
|
20
|
+
tool (text, up to 200 characters): The action, by name. Those that need the person's permission: "fix", starting a fix, and "make with you", making the outcome you're on with the person and the solution's agent instead (args: { outcome }), when it needs their judgement more than your best guess (CONVO-8).
|
|
21
21
|
args (object): The action's arguments, as it takes them: a fix's are below.
|
|
22
22
|
recommendation (object): Which option you would take, and the one reason why.
|
|
23
23
|
option (text, up to 200 characters): The name of the option you recommend, exactly as it appears in options.
|
package/dist/schema/browser.d.ts
CHANGED
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
export { buildRequirementMarkdown, buildRequirementsMarkdown, DEFAULT_DELIMITER, } from "./builder.js";
|
|
7
7
|
export type { ConvexRequirement } from "./conversions.js";
|
|
8
8
|
export { buildMetadata, constructKey, convexToRequirements, extractRequirementKeys, groupByRoot, parseKey, requirementsToConvex, } from "./conversions.js";
|
|
9
|
-
export { DELIMITER_PATTERN, type ExtractedRequirementBlock, extractRequirementBlocks, findRequirementById, flattenRequirementTree, getAllRequirements, parseCriterionLine, parseRequirementBlock, parseRequirementBlocksFromMarkdown, parseRootLine, ROOT_LABEL_MARKER, splitRequirementFenceContent, stripFrontmatterBlock, } from "./parser-core.js";
|
|
9
|
+
export { DELIMITER_PATTERN, type ExtractedRequirementBlock, extractFrontmatterBlock, extractRequirementBlocks, findRequirementById, flattenRequirementTree, getAllRequirements, parseCriterionLine, parseRequirementBlock, parseRequirementBlocksFromMarkdown, parseRootLine, ROOT_LABEL_MARKER, splitRequirementFenceContent, stripFrontmatterBlock, } from "./parser-core.js";
|
|
10
10
|
export { carriesBranchVersion } from "./provenance.js";
|
|
11
11
|
export type { Metadata, ParsedCriterion, RequirementKey, RequirementNode, RequirementPrefix, RequirementsFile, } from "./schemas.js";
|
|
12
12
|
export { buildRequirementKey, canonicalRequirementKey, MetadataSchema, normalizePrefix, ParsedCriterionSchema, parseRequirementKey, REQUIREMENT_KEY_PATTERN, REQUIREMENT_PREFIX_PATTERN, RequirementKeySchema, RequirementNodeSchema, RequirementPrefixSchema, RequirementsFileSchema, ValidationError, validateKey, validateMetadata, validatePrefix, validateRequirementNode, validateRequirementsFile, } from "./schemas.js";
|
package/dist/schema/browser.js
CHANGED
|
@@ -8,12 +8,14 @@ export { buildRequirementMarkdown, buildRequirementsMarkdown, DEFAULT_DELIMITER,
|
|
|
8
8
|
export { buildMetadata, constructKey, convexToRequirements, extractRequirementKeys, groupByRoot, parseKey, requirementsToConvex, } from "./conversions.js";
|
|
9
9
|
// Parser core (pure TypeScript - browser-safe, no fs dependency)
|
|
10
10
|
// These functions parse markdown strings directly without file I/O
|
|
11
|
-
export { DELIMITER_PATTERN,
|
|
11
|
+
export { DELIMITER_PATTERN,
|
|
12
|
+
// With stripFrontmatterBlock: a requirements file read from a repository
|
|
13
|
+
// in the browser (SOLDOC-12), and one the solution's agent submits, read
|
|
14
|
+
// from its checkout (BRANCH-1.0).
|
|
15
|
+
extractFrontmatterBlock, extractRequirementBlocks, findRequirementById, flattenRequirementTree, getAllRequirements, parseCriterionLine, parseRequirementBlock, parseRequirementBlocksFromMarkdown, parseRootLine,
|
|
12
16
|
// The web reaches parser-core only through this entry point, so without this
|
|
13
17
|
// its readers have no way to import the marker and must hard-code it.
|
|
14
|
-
ROOT_LABEL_MARKER, splitRequirementFenceContent,
|
|
15
|
-
// A requirements file read from a repository in the browser (SOLDOC-12).
|
|
16
|
-
stripFrontmatterBlock, } from "./parser-core.js";
|
|
18
|
+
ROOT_LABEL_MARKER, splitRequirementFenceContent, stripFrontmatterBlock, } from "./parser-core.js";
|
|
17
19
|
// Whether a publish that says it lands a branch version matches it
|
|
18
20
|
// (BRANCH-7.11), checked by the web app's merge and by the backend alike
|
|
19
21
|
export { carriesBranchVersion } from "./provenance.js";
|
package/package.json
CHANGED