@jarkkojs/readseek-api 0.9.5

package/LICENSE

@@ -0,0 +1,176 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS

package/README.md

@@ -0,0 +1,47 @@
+# @jarkkojs/readseek-api
+
+Shared, host-agnostic ReadSeek API pieces for CLI contract metadata, parameter
+validation, pure argv builders, platform package resolution, and bounded Node
+or Bun process invocation.
+
+This package intentionally excludes host permissions, cache management, install
+flows, session state, and TUI rendering.
+
+Repository plugins consume this source directly: Pi and OpenCode inline it into
+their published bundles, and the Claude marketplace plugin imports the monorepo
+sibling sources. External consumers install the published package.
+
+## Install
+
+```bash
+npm install @jarkkojs/readseek-api
+```
+
+`@jarkkojs/readseek` arrives as a dependency.
+
+## Exports
+
+- Contract: tool descriptions, shared parameter text, and enums
+- Validation: git selection, refs name/scope, vision level/mode, edit variants
+- Argv builders: `digest`, `view`, `search`, `def`, `refs`, `edit`, `rename`, line locations
+- Platform: binary name, platform package map, and default or caller-injected module resolution
+- Process: Node and Bun runners with timeout, cancellation, stdin, cwd, hard
+  stdout/stderr caps, no shell, and strict JSON/error cleanup
+
+## Example
+
+```ts
+import {
+  buildDigestArgs,
+  resolveReadSeekBinaryFromPackages,
+  runReadSeekNodeJson,
+} from "@jarkkojs/readseek-api";
+
+const binary = resolveReadSeekBinaryFromPackages();
+const args = buildDigestArgs({ path: "src/index.ts", select: "map" });
+const envelope = await runReadSeekNodeJson(binary, args);
+```
+
+## License
+
+Apache-2.0

package/dist/argv.d.ts

@@ -0,0 +1,81 @@
+import type { DigestFacet, DocumentNodeKind, VisionAnalysisMode, VisionLevel, VisionMode } from "./contract.ts";
+import { type GitSelectionInput } from "./validation.ts";
+export declare function buildLineLocation(line: number, column?: number): string;
+export declare function appendGitSelectionArgs(args: string[], input: GitSelectionInput): string[];
+export type ApplyPlanHashOrder = "plan-hash-first" | "apply-first";
+export type ApplyPlanHashInput = {
+    apply?: boolean;
+    planHash?: string;
+    flagOrder?: ApplyPlanHashOrder;
+};
+export declare function appendApplyAndPlanHash(args: string[], input: ApplyPlanHashInput): string[];
+export type DigestArgsInput = {
+    path: string;
+    select?: DigestFacet | DigestFacet[] | string;
+    at?: string;
+    end?: number;
+    limit?: number;
+    language?: string;
+    visionMode?: VisionMode;
+    visionLevel?: VisionLevel;
+    stdinName?: string;
+    readseekDir?: string;
+};
+export declare function buildDigestArgs(input: DigestArgsInput): string[];
+export type ViewArgsInput = {
+    path: string;
+    node?: string;
+    page?: number;
+    kind?: DocumentNodeKind | string;
+    depth?: number;
+    outline?: boolean;
+    visionMode?: VisionAnalysisMode;
+    visionLevel?: VisionLevel;
+    format?: "json" | "text";
+    readseekDir?: string;
+};
+export declare function buildViewArgs(input: ViewArgsInput): string[];
+export type SearchArgsInput = {
+    path: string;
+    pattern: string;
+    language?: string;
+} & GitSelectionInput;
+export declare function buildSearchArgs(input: SearchArgsInput): string[];
+export type DefArgsInput = {
+    path: string;
+    name: string;
+    language?: string;
+    format?: "plain" | "json";
+} & GitSelectionInput;
+export declare function buildDefArgs(input: DefArgsInput): string[];
+export type RefsArgsInput = {
+    path: string;
+    name?: string;
+    scope?: boolean;
+    line?: number;
+    column?: number;
+    language?: string;
+    format?: "plain" | "json";
+} & GitSelectionInput;
+export declare function buildRefsArgs(input: RefsArgsInput): string[];
+export type EditArgsInput = {
+    path: string;
+    apply?: boolean;
+    planHash?: string;
+    language?: string;
+    requestFromStdin?: boolean;
+    flagOrder?: ApplyPlanHashOrder;
+};
+export declare function buildEditArgs(input: EditArgsInput): string[];
+export type RenameArgsInput = {
+    path: string;
+    to: string;
+    line: number;
+    column?: number;
+    workspace?: string;
+    apply?: boolean;
+    planHash?: string;
+    language?: string;
+    flagOrder?: ApplyPlanHashOrder;
+} & GitSelectionInput;
+export declare function buildRenameArgs(input: RenameArgsInput): string[];

package/dist/contract.d.ts

@@ -0,0 +1,111 @@
+export declare const DIGEST_FACETS: readonly ["metadata", "content", "map", "diagnostics", "identity"];
+export type DigestFacet = (typeof DIGEST_FACETS)[number];
+export declare const VISION_MODES: readonly ["none", "all", "ocr", "caption", "objects"];
+export type VisionMode = (typeof VISION_MODES)[number];
+export declare const VISION_ANALYSIS_MODES: readonly ["all", "ocr", "caption", "objects"];
+export type VisionAnalysisMode = (typeof VISION_ANALYSIS_MODES)[number];
+export declare const VISION_LEVELS: readonly ["low", "medium", "high"];
+export type VisionLevel = (typeof VISION_LEVELS)[number];
+export declare const DOCUMENT_NODE_KINDS: readonly ["artifact", "footer", "header", "heading", "marginal_label", "page", "page_number", "paragraph", "section", "structural_section"];
+export type DocumentNodeKind = (typeof DOCUMENT_NODE_KINDS)[number];
+export declare const EDIT_VARIANTS: readonly ["set_line", "replace_lines", "insert_after", "replace", "replace_symbol"];
+export type EditVariant = (typeof EDIT_VARIANTS)[number];
+export declare const GIT_SELECTION_FLAGS: readonly ["cached", "others", "ignored"];
+export type GitSelectionFlag = (typeof GIT_SELECTION_FLAGS)[number];
+export declare const TOOL_NAMES: readonly ["read", "edit", "write", "grep", "digest", "view", "search", "def", "refs", "rename"];
+export type ToolName = (typeof TOOL_NAMES)[number];
+export declare const PARAM_DESCRIPTIONS: {
+    readonly path: "Absolute or relative file path";
+    readonly searchPath: "File or directory to search; defaults to the current directory";
+    readonly language: "Language override when auto-detection is ambiguous";
+    readonly languageOverride: "Language override";
+    readonly languageSymbol: "Language override for symbol replacement";
+    readonly pattern: "AST pattern (ast-grep style), such as console.log($$$ARGS)";
+    readonly grepPattern: "Regex pattern; set literal for exact text";
+    readonly name: "Qualified or unqualified symbol name";
+    readonly refsName: "Identifier to find references for";
+    readonly scope: "Restrict results to the binding at the cursor";
+    readonly line: "One-based cursor line; required with scope";
+    readonly renameLine: "One-based cursor line of the symbol to rename";
+    readonly column: "One-based cursor byte column for disambiguation";
+    readonly cached: "In a Git repository, search tracked/indexed files";
+    readonly others: "In a Git repository, search untracked files";
+    readonly ignored: "With others=true, include ignored untracked files";
+    readonly select: "Facets: metadata, content, map, diagnostics, identity (default content)";
+    readonly selectComma: "Comma-separated facets: metadata, content, map, diagnostics, identity";
+    readonly at: "Location: line:N[:COLUMN], hash:HASH[:COLUMN], or symbol:NAME";
+    readonly end: "Last line to include";
+    readonly limit: "Maximum number of lines to include";
+    readonly offset: "One-based starting line";
+    readonly readLimit: "Maximum lines to return";
+    readonly symbolRead: "Symbol name to read";
+    readonly bundle: "Include related symbols from the same file; requires symbol";
+    readonly image: "Standalone image mode: none, all, ocr, caption, objects. Required for standalone images.";
+    readonly visionModeDigest: "Standalone image mode: none, all, caption, objects, or ocr";
+    readonly visionModeView: "Analyze selected assets: all, ocr, caption, or objects";
+    readonly visionLevel: "Vision inference level: low (default), medium, or high";
+    readonly node: "Node ID to use as the view root";
+    readonly page: "One-based source page";
+    readonly kind: "Node kind filter";
+    readonly depth: "Maximum depth below selected roots";
+    readonly outline: "Return outline nodes only";
+    readonly edits: "Use set_line, replace_lines, insert_after, replace_symbol, or replace";
+    readonly editVariant: "Exactly one nested edit variant";
+    readonly setLine: "Replace one line: {\"set_line\":{\"anchor\":\"LINE:HASH\",\"new_text\":\"...\"}}";
+    readonly replaceLines: "Replace a range: {\"replace_lines\":{\"start_anchor\":\"LINE:HASH\",\"end_anchor\":\"LINE:HASH\",\"new_text\":\"...\"}}";
+    readonly insertAfter: "Insert text: {\"insert_after\":{\"anchor\":\"LINE:HASH\",\"new_text\":\"...\"}}";
+    readonly replace: "Replace text: {\"replace\":{\"old_text\":\"...\",\"new_text\":\"...\"}}";
+    readonly replaceSymbol: "Replace a symbol: {\"replace_symbol\":{\"symbol\":\"name\",\"new_body\":\"...\"}}";
+    readonly anchor: "Fresh LINE:HASH anchor for the line to replace";
+    readonly startAnchor: "Fresh LINE:HASH anchor for the first line in the range";
+    readonly endAnchor: "Fresh LINE:HASH anchor for the last line in the range";
+    readonly insertAnchor: "Fresh LINE:HASH anchor for the line after which to insert";
+    readonly newTextLine: "Replacement text; use an empty string to delete the line";
+    readonly newTextRange: "Replacement text; use an empty string to delete the range";
+    readonly newTextInsert: "Text to insert after the anchored line";
+    readonly oldText: "Exact text to find";
+    readonly newText: "Replacement text";
+    readonly all: "Replace every exact match";
+    readonly symbol: "Mapped symbol name";
+    readonly newBody: "Complete replacement body for the symbol";
+    readonly apply: "When supported by the host, apply the verified plan instead of previewing only";
+    readonly planHash: "Require the apply plan to match this dry-run plan hash";
+    readonly workspace: "Rename across the project";
+    readonly to: "New symbol name";
+    readonly postEditVerify: "Read back and verify persisted content";
+    readonly content: "Complete text file content";
+    readonly glob: "File-name glob, such as *.ts";
+    readonly ignoreCase: "Ignore case";
+    readonly literal: "Treat pattern literally";
+    readonly context: "Surrounding lines for each match";
+    readonly matchLimit: "Maximum matches to return";
+    readonly summary: "Return per-file counts";
+    readonly grepScope: "Group matches by enclosing symbol";
+    readonly scopeContext: "Context lines within each symbol";
+};
+export declare const TOOL_DESCRIPTIONS: {
+    readonly read: "Read anchored text by range or symbol. Standalone images require an explicit mode. Use it before edits to obtain fresh `LINE:HASH` anchors; use `view` for documents and `digest` with the map facet for structural outlines.";
+    readonly edit: "Edit existing text files with fresh `LINE:HASH` anchors. Read or search first when no fresh anchors are available. Each `edits[]` item must use exactly one nested object: `{\"set_line\":{\"anchor\":\"LINE:HASH\",\"new_text\":\"...\"}}`, `{\"replace_lines\":{\"start_anchor\":\"LINE:HASH\",\"end_anchor\":\"LINE:HASH\",\"new_text\":\"...\"}}`, `{\"insert_after\":{\"anchor\":\"LINE:HASH\",\"new_text\":\"...\"}}`, `{\"replace_symbol\":{\"symbol\":\"name\",\"new_body\":\"...\"}}`, or `{\"replace\":{\"old_text\":\"...\",\"new_text\":\"...\"}}`.";
+    readonly write: "Create or replace a complete text file and return `LINE:HASH` anchors. Use `edit` for small changes to an existing file.";
+    readonly grep: "Search text or regex in files and return edit-ready `LINE:HASH` anchors. Use for identifiers, strings, configuration, errors, comments, and documentation.";
+    readonly digest: "Digest source content and images into the native CLI envelope. Returns metadata plus requested facets unchanged from `readseek digest`; use for structural maps, diagnostics, and cursor identity.";
+    readonly view: "Digest a document's structure or selected content. Start with the overview, then narrow by page, node, kind, or depth instead of reading the whole document. PDF is the first supported document format.";
+    readonly search: "Search code by AST structure using ast-grep-style patterns. Results include line hashes usable as `LINE:HASH` anchors. Use `grep` for identifiers, strings, comments, configuration, documentation, or other plain text and regex.";
+    readonly def: "Go to a symbol definition or declaration by name. Accepts qualified or unqualified names; use this instead of text search for functions, methods, classes, types, and other declarations.";
+    readonly refs: "Find references or usages of an identifier by name or cursor binding. Results include enclosing symbols and line hashes usable as `LINE:HASH` anchors. Without cursor scope, results are identifier-name matches; with scope, they follow one binding and exclude shadows. Use text search for literals, and use this before renaming or deleting a symbol.";
+    readonly rename: "Rename a symbol at a source location. Resolvable same-named bindings are preserved; verified edits apply by default. Set `apply: false` to preview the plan before changing files.";
+};
+export declare function renderToolDescription(name: ToolName, aliases?: Readonly<Partial<Record<ToolName, string>>>): string;
+export type JsonSchema = {
+    type: "object";
+    properties: Record<string, unknown>;
+    required?: string[];
+    additionalProperties?: boolean;
+};
+export type ToolContract = {
+    name: ToolName;
+    title: string;
+    description: string;
+    inputSchema: JsonSchema;
+};
+export declare const TOOL_CONTRACTS: readonly ToolContract[];

package/dist/index.d.ts

@@ -0,0 +1,8 @@
+export { DIGEST_FACETS, DOCUMENT_NODE_KINDS, EDIT_VARIANTS, GIT_SELECTION_FLAGS, PARAM_DESCRIPTIONS, TOOL_CONTRACTS, TOOL_DESCRIPTIONS, TOOL_NAMES, renderToolDescription, VISION_ANALYSIS_MODES, VISION_LEVELS, VISION_MODES, type DigestFacet, type DocumentNodeKind, type EditVariant, type GitSelectionFlag, type JsonSchema, type ToolContract, type ToolName, type VisionAnalysisMode, type VisionLevel, type VisionMode, } from "./contract.ts";
+export { validateExactlyOneEditVariant, validateGitSelection, validateRefsNameVsScope, validateVisionLevelVsMode, type EditObject, type GitSelectionInput, type RefsScopeInput, type ValidationResult, type VisionInput, } from "./validation.ts";
+export { appendApplyAndPlanHash, appendGitSelectionArgs, buildDefArgs, buildDigestArgs, buildEditArgs, buildLineLocation, buildRefsArgs, buildRenameArgs, buildSearchArgs, buildViewArgs, type ApplyPlanHashInput, type ApplyPlanHashOrder, type DefArgsInput, type DigestArgsInput, type EditArgsInput, type RefsArgsInput, type RenameArgsInput, type SearchArgsInput, type ViewArgsInput, } from "./argv.ts";
+export { READSEEK_PLATFORM_PACKAGES, readSeekBinaryName, readSeekPlatformKey, resolveReadSeekBinaryFromPackages, type ModuleResolver, } from "./platform.ts";
+export { cleanReadSeekErrorText, parseReadSeekJson, } from "./json.ts";
+export { DEFAULT_MAX_OUTPUT_BYTES, DEFAULT_READSEEK_TIMEOUT_MS, ensureSuccessfulStdout, failureFromProcessResult, parseSuccessfulJson, resolveProcessLimits, type ProcessRunOptions, type ProcessRunResult, } from "./process.ts";
+export { runReadSeekNode, runReadSeekNodeJson, runReadSeekNodeText, } from "./process-node.ts";
+export { runReadSeekBun, runReadSeekBunJson, runReadSeekBunText, } from "./process-bun.ts";