arc-1 0.6.10 → 0.7.0

package/dist/adt/rap-handlers.d.ts

@@ -0,0 +1,165 @@
+/**
+ * RAP behavior-pool handler scaffolding.
+ *
+ * Context — this module exists because on-prem RAP development has a tight
+ * contract between a BDEF (behavior definition source) and its behavior pool
+ * (the ABAP global class named in `managed implementation in class ZBP_...`).
+ * Every `action` / `determination` / `validation` / `authorization master`
+ * declared in the BDEF requires a matching METHOD signature inside a local
+ * handler class (`lhc_<alias>`). If any signature is missing, the class will
+ * not activate and the error reported by ADT doesn't tell the developer
+ * which signatures are missing — they see a generic "behavior pool does not
+ * implement the required method for ..." message.
+ *
+ * The exported helpers cooperate:
+ *   1. extractRapHandlerRequirements     — parse BDEF → list of required methods
+ *   2. findMissingRapHandlerRequirements — diff required vs. present in class
+ *   3. applyRapHandlerSignatures         — insert the missing METHODS lines
+ *   4. applyRapHandlerImplementationStubs — insert empty METHOD stubs
+ *   5. applyRapHandlerScaffold           — plan multi-include auto-apply
+ *
+ * The scaffolder writes declarations plus empty implementations only.
+ * Business logic remains the developer's responsibility and can be filled
+ * with edit_method.
+ *
+ * Naming convention: handler classes use the prefix `lhc_` (local handler
+ * class) followed by the lowercased alias from the BDEF. This is the RAP
+ * convention SAP's own templates use (see cl_abap_behavior_handler examples
+ * in /DMO/* and the "Create Behavior Implementation Class" wizard in ADT).
+ */
+export type RapHandlerKind = 'action' | 'determination' | 'validation' | 'instance_authorization' | 'global_authorization';
+export interface RapHandlerRequirement {
+    kind: RapHandlerKind;
+    methodName: string;
+    entityName: string;
+    entityAlias: string;
+    targetHandlerClass: string;
+    declarationLine: number;
+    signature: string;
+}
+export interface RapHandlerApplySkipped {
+    requirement: RapHandlerRequirement;
+    reason: string;
+}
+export interface RapHandlerApplyResult {
+    updatedSource: string;
+    inserted: RapHandlerRequirement[];
+    skipped: RapHandlerApplySkipped[];
+    changed: boolean;
+}
+export type RapHandlerSectionName = 'main' | 'definitions' | 'implementations';
+export interface RapHandlerSourceSections {
+    main: string;
+    definitions?: string;
+    implementations?: string;
+}
+export interface RapHandlerSectionApplyResults {
+    main: RapHandlerApplyResult;
+    definitions?: RapHandlerApplyResult;
+    implementations?: RapHandlerApplyResult;
+}
+export interface RapHandlerScaffoldPlan {
+    sections: RapHandlerSourceSections;
+    signatures: RapHandlerSectionApplyResults;
+    implementationStubs: RapHandlerSectionApplyResults;
+    unresolved: RapHandlerRequirement[];
+    changed: Record<RapHandlerSectionName, boolean>;
+    changedSections: RapHandlerSectionName[];
+    insertedSignatureCount: number;
+    insertedImplementationStubCount: number;
+}
+export declare function rapHandlerRequirementKey(requirement: RapHandlerRequirement): string;
+/**
+ * Extract RAP behavior-pool handler method requirements from interface BDEF source.
+ *
+ * For every behavior block (one per entity in the BDEF), this produces the
+ * exact METHOD signatures that the behavior pool's `lhc_<alias>` class must
+ * declare for the class to activate. The output is used by:
+ *   - findMissingRapHandlerRequirements: to diff against an existing class
+ *   - applyRapHandlerSignatures: to synthesize the missing METHODS lines
+ *
+ * The emitted signatures mirror what SAP's "Create Behavior Implementation"
+ * wizard would generate — same FOR MODIFY/FOR DETERMINE ON/FOR VALIDATE ON
+ * syntax, same `alias~method` entity reference, same RESULT clause only when
+ * the BDEF declares a `result` cardinality.
+ */
+export declare function extractRapHandlerRequirements(bdefSource: string): RapHandlerRequirement[];
+/**
+ * Parse method declarations (`METHODS ...`) per class definition.
+ *
+ * The returned Set contains BOTH:
+ *   1. Every declared METHOD name in the class (e.g. `submitforapproval`,
+ *      `set_status_accepted`, `validate_customer`)
+ *   2. Every RAP binding-key those methods are bound to (the action /
+ *      determination / validation / authorization referenced in the
+ *      `FOR ACTION <alias>~<name>` / `FOR <alias>~<name>` /
+ *      `FOR INSTANCE AUTHORIZATION ... FOR <alias>` clauses)
+ *
+ * Why both? Hand-crafted behavior pools (like SAP's own /DMO/BP_TRAVEL_M)
+ * routinely use semantic method names that differ from the BDEF action
+ * names — e.g. BDEF `action acceptTravel` bound to METHOD
+ * `set_status_accepted` via `FOR ACTION travel~acceptTravel`. The
+ * scaffolder's missing-requirement check compares by BDEF identifier, so if
+ * we only indexed method names, it would incorrectly report
+ * `accepttravel` as missing and try to inject a duplicate METHOD line.
+ *
+ * METHOD declarations can span multiple lines (one line for the name +
+ * continuation lines for FOR / IMPORTING / RESULT), so we join the
+ * statement up to its terminating `.` before pattern-matching the binding.
+ */
+export declare function parseClassDefinitionMethods(source: string): Map<string, Set<string>>;
+/**
+ * Determine which RAP handler requirements are missing from class definitions.
+ *
+ * If the target handler class (`lhc_<alias>`) doesn't exist in the source at
+ * all, every requirement for that class is reported missing so the caller
+ * can decide whether to create the class or fall through to another include
+ * (the scaffold flow searches `main` → `definitions` → `implementations`).
+ *
+ * Method-name comparison is case-insensitive because ABAP identifiers
+ * are — we normalize on both sides so `METHODS SubmitForApproval ...`
+ * matches a BDEF `action SubmitForApproval`.
+ */
+export declare function findMissingRapHandlerRequirements(requirements: RapHandlerRequirement[], classSource: string): RapHandlerRequirement[];
+export declare function findMissingRapHandlerImplementationStubs(requirements: RapHandlerRequirement[], classSource: string): RapHandlerRequirement[];
+/**
+ * Insert missing RAP handler signatures into matching `lhc_*` class definitions.
+ *
+ * Scope and contract:
+ *  - Only DEFINITION sections are modified. Use
+ *    applyRapHandlerImplementationStubs after this step when the scaffold
+ *    should be immediately patchable with edit_method.
+ *  - Requirements whose target class (`lhc_<alias>`) is not present in this
+ *    source are returned in `skipped`, not silently dropped. The caller can
+ *    then try another include (definitions/implementations) or surface a
+ *    clear error to the user.
+ *  - Edits are applied bottom-up (highest line index first) so that earlier
+ *    splice operations don't shift the indices of later ones.
+ *  - When a target class exists but has no PRIVATE SECTION at all, the
+ *    entire PRIVATE SECTION with the signatures is inserted just before
+ *    ENDCLASS — this covers freshly-generated behavior pools where ADT
+ *    produced a skeleton without method declarations.
+ */
+export declare function applyRapHandlerSignatures(classSource: string, requirements: RapHandlerRequirement[]): RapHandlerApplyResult;
+export declare function applyRapHandlerImplementationStubs(classSource: string, requirements: RapHandlerRequirement[], options?: {
+    createImplementationBlocks?: boolean;
+    definitionSource?: string;
+}): RapHandlerApplyResult;
+/**
+ * Build the complete auto-apply plan for a behavior pool without doing I/O.
+ *
+ * This is intentionally pure: the MCP handler owns safety checks, locks,
+ * linting, and ADT writes; this helper owns the RAP-specific sequencing:
+ *   1. insert missing METHODS declarations into whichever include contains
+ *      the matching `lhc_<alias> DEFINITION`
+ *   2. skip stubs whose declarations still could not be placed
+ *   3. insert empty METHOD stubs using the concrete ABAP method name from
+ *      existing/new declarations, including semantic names bound via
+ *      `FOR ACTION alias~ActionName`
+ *
+ * Keeping this plan here prevents `intent.ts` from duplicating RAP parser
+ * invariants such as "deferred classes are not editable" and "stub method
+ * names come from declarations, not necessarily from BDEF action names".
+ */
+export declare function applyRapHandlerScaffold(sections: RapHandlerSourceSections, missingSignatures: RapHandlerRequirement[], missingImplementationStubs: RapHandlerRequirement[]): RapHandlerScaffoldPlan;
+//# sourceMappingURL=rap-handlers.d.ts.map

package/dist/adt/rap-handlers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"rap-handlers.d.ts","sourceRoot":"","sources":["../../src/adt/rap-handlers.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AAEH,MAAM,MAAM,cAAc,GACtB,QAAQ,GACR,eAAe,GACf,YAAY,GACZ,wBAAwB,GACxB,sBAAsB,CAAC;AAE3B,MAAM,WAAW,qBAAqB;IACpC,IAAI,EAAE,cAAc,CAAC;IACrB,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;IACnB,WAAW,EAAE,MAAM,CAAC;IACpB,kBAAkB,EAAE,MAAM,CAAC;IAC3B,eAAe,EAAE,MAAM,CAAC;IACxB,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,sBAAsB;IACrC,WAAW,EAAE,qBAAqB,CAAC;IACnC,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,qBAAqB;IACpC,aAAa,EAAE,MAAM,CAAC;IACtB,QAAQ,EAAE,qBAAqB,EAAE,CAAC;IAClC,OAAO,EAAE,sBAAsB,EAAE,CAAC;IAClC,OAAO,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,MAAM,qBAAqB,GAAG,MAAM,GAAG,aAAa,GAAG,iBAAiB,CAAC;AAE/E,MAAM,WAAW,wBAAwB;IACvC,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED,MAAM,WAAW,6BAA6B;IAC5C,IAAI,EAAE,qBAAqB,CAAC;IAC5B,WAAW,CAAC,EAAE,qBAAqB,CAAC;IACpC,eAAe,CAAC,EAAE,qBAAqB,CAAC;CACzC;AAED,MAAM,WAAW,sBAAsB;IACrC,QAAQ,EAAE,wBAAwB,CAAC;IACnC,UAAU,EAAE,6BAA6B,CAAC;IAC1C,mBAAmB,EAAE,6BAA6B,CAAC;IACnD,UAAU,EAAE,qBAAqB,EAAE,CAAC;IACpC,OAAO,EAAE,MAAM,CAAC,qBAAqB,EAAE,OAAO,CAAC,CAAC;IAChD,eAAe,EAAE,qBAAqB,EAAE,CAAC;IACzC,sBAAsB,EAAE,MAAM,CAAC;IAC/B,+BAA+B,EAAE,MAAM,CAAC;CACzC;AAoED,wBAAgB,wBAAwB,CAAC,WAAW,EAAE,qBAAqB,GAAG,MAAM,CAEnF;AA0KD;;;;;;;;;;;;;GAaG;AACH,wBAAgB,6BAA6B,CAAC,UAAU,EAAE,MAAM,GAAG,qBAAqB,EAAE,CAkJzF;AA2KD;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,wBAAgB,2BAA2B,CAAC,MAAM,EAAE,MAAM,GAAG,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC,CA8BpF;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,iCAAiC,CAC/C,YAAY,EAAE,qBAAqB,EAAE,EACrC,WAAW,EAAE,MAAM,GAClB,qBAAqB,EAAE,CAQzB;AAED,wBAAgB,wCAAwC,CACtD,YAAY,EAAE,qBAAqB,EAAE,EACrC,WAAW,EAAE,MAAM,GAClB,qBAAqB,EAAE,CAWzB;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,yBAAyB,CACvC,WAAW,EAAE,MAAM,EACnB,YAAY,EAAE,qBAAqB,EAAE,GACpC,qBAAqB,CAkEvB;AAED,wBAAgB,kCAAkC,CAChD,WAAW,EAAE,MAAM,EACnB,YAAY,EAAE,qBAAqB,EAAE,EACrC,OAAO,GAAE;IAAE,0BAA0B,CAAC,EAAE,OAAO,CAAC;IAAC,gBAAgB,CAAC,EAAE,MAAM,CAAA;CAAO,GAChF,qBAAqB,CA8EvB;AAyED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,uBAAuB,CACrC,QAAQ,EAAE,wBAAwB,EAClC,iBAAiB,EAAE,qBAAqB,EAAE,EAC1C,0BAA0B,EAAE,qBAAqB,EAAE,GAClD,sBAAsB,CAgExB"}