@patimweb/pi-abap-fs 1.0.0

package/src/tools/abap-where-used.ts

@@ -0,0 +1,65 @@
+/**
+ * abap_where_used tool — Find where an ABAP object is used.
+ */
+
+import { Type } from "typebox";
+import { resolveObject, withClient } from "../client.ts";
+import { resolveConfig } from "../config.ts";
+import { formatUsageReferences } from "../formatting/formatters.ts";
+
+export const AbapWhereUsedTool = {
+  name: "abap_where_used",
+  label: "Find ABAP Object Usage",
+  description:
+    "Find where an ABAP object is referenced (where-used list). Provide the object name or URL. Returns the list of referencing objects.",
+  parameters: Type.Object({
+    profile: Type.Optional(
+      Type.String({
+        description: "Profile name to use. Uses active profile if omitted.",
+      }),
+    ),
+    name: Type.Optional(
+      Type.String({ description: "Object name, e.g. 'ZCL_MY_CLASS'" }),
+    ),
+    objectUrl: Type.Optional(
+      Type.String({
+        description:
+          "Object URL, e.g. '/sap/bc/adt/oo/classes/zcl_my_class'. Takes precedence over name.",
+      }),
+    ),
+    type: Type.Optional(
+      Type.String({ description: "Optional type hint for search, e.g. 'CLAS/OC'." }),
+    ),
+  }),
+
+  async execute(
+    _toolCallId: string,
+    params: { profile?: string; name?: string; objectUrl?: string; type?: string },
+    _signal: AbortSignal,
+  ) {
+    const config = resolveConfig(params.profile);
+    const { resolved, references } = await withClient(config, async (client) => {
+      const resolved = await resolveObject(client, params);
+      const references = await client.usageReferences(resolved.mainInclude);
+      return { resolved, references };
+    });
+
+    return {
+      content: [
+        {
+          type: "text" as const,
+          text: formatUsageReferences(references),
+        },
+      ],
+      details: {
+        name: resolved.name,
+        count: references.length,
+        references: references.map((r) => ({
+          name: r["adtcore:name"] || r.objectIdentifier,
+          type: r["adtcore:type"],
+          description: r["adtcore:description"],
+        })),
+      },
+    };
+  },
+};

package/src/tools/abap-write.ts

@@ -0,0 +1,120 @@
+/**
+ * abap_write tool — Write source code to an ABAP object.
+ *
+ * Self-contained: resolves the object, locks it, writes the source, then
+ * unlocks it. If a lockHandle is provided, the caller owns the lock and it
+ * is NOT unlocked automatically.
+ */
+
+import { Type } from "typebox";
+import { resolveObject, withClient } from "../client.ts";
+import { resolveConfig } from "../config.ts";
+
+export const AbapWriteTool = {
+  name: "abap_write",
+  label: "Write ABAP Source",
+  description:
+    "Write (save) source code to an ABAP object. Provide the object (name or objectUrl), the full new source, and optionally a transport request number. If a lockHandle from a previous abap_lock call is provided, that lock is used and left in place; otherwise the object is locked, written, and unlocked automatically. Use abap_activate afterwards to activate the change.",
+  parameters: Type.Object({
+    profile: Type.Optional(
+      Type.String({
+        description: "Profile name to use. Uses active profile if omitted.",
+      }),
+    ),
+    name: Type.Optional(
+      Type.String({ description: "Object name, e.g. 'ZCL_MY_CLASS'" }),
+    ),
+    objectUrl: Type.Optional(
+      Type.String({
+        description:
+          "Object URL, e.g. '/sap/bc/adt/oo/classes/zcl_my_class'. Takes precedence over name.",
+      }),
+    ),
+    type: Type.Optional(
+      Type.String({ description: "Optional type hint for search, e.g. 'CLAS/OC'." }),
+    ),
+    source: Type.String({
+      description: "The full new source code to write.",
+    }),
+    transport: Type.Optional(
+      Type.String({
+        description:
+          "Transport / correction request number, e.g. 'DEVK900123'. Only used when a new lock is taken.",
+      }),
+    ),
+    lockHandle: Type.Optional(
+      Type.String({
+        description:
+          "Optional lock handle from a previous abap_lock call. When provided, the lock is used and NOT released automatically.",
+      }),
+    ),
+  }),
+
+  async execute(
+    _toolCallId: string,
+    params: {
+      profile?: string;
+      name?: string;
+      objectUrl?: string;
+      type?: string;
+      source: string;
+      transport?: string;
+      lockHandle?: string;
+    },
+    _signal: AbortSignal,
+  ) {
+    const config = resolveConfig(params.profile);
+
+    const result = await withClient(
+      config,
+      async (client) => {
+        const resolved = await resolveObject(client, params);
+
+        let lockHandle = params.lockHandle;
+        let selfLocked = false;
+        if (!lockHandle) {
+          const lock = await client.lock(resolved.objectUrl, "MODIFY");
+          lockHandle = lock.LOCK_HANDLE;
+          selfLocked = true;
+        }
+
+        try {
+          await client.setObjectSource(
+            resolved.mainInclude,
+            params.source,
+            lockHandle,
+            params.transport,
+          );
+        } finally {
+          if (selfLocked) {
+            await client.unLock(resolved.objectUrl, lockHandle);
+          }
+        }
+
+        return { resolved, selfLocked };
+      },
+      { stateful: true },
+    );
+
+    return {
+      content: [
+        {
+          type: "text" as const,
+          text:
+            `Source written to ${result.resolved.name}. ` +
+            (result.selfLocked
+              ? "Lock released automatically."
+              : "Lock left in place (caller owns it).") +
+            " Use abap_activate to activate the change.",
+        },
+      ],
+      details: {
+        name: result.resolved.name,
+        type: result.resolved.type,
+        objectUrl: result.resolved.objectUrl,
+        lines: params.source.split("\n").length,
+        lockReleased: result.selfLocked,
+      },
+    };
+  },
+};

package/src/types.ts

@@ -0,0 +1,55 @@
+/**
+ * Data types for the pi ABAP FS extension.
+ *
+ * All domain data is represented as plain immutable-shaped interfaces.
+ * No behavior — just data.
+ */
+
+// Configuration
+
+export interface AbapProfile {
+  /** ADT base URL, e.g. http://vhcalnplci.bti.local:8000 */
+  readonly url: string;
+  /** SAP logon user (e.g. DEVELOPER) */
+  readonly username: string;
+  /** Password (stored in ~/.pi/abap-config.json with 0600 permissions) */
+  readonly password: string;
+  /** SAP client / mandant, e.g. "001" */
+  readonly client?: string;
+  /** Logon language key, e.g. "EN" */
+  readonly language?: string;
+  /** Accept self-signed TLS certificates (on-premise dev systems). Defaults to false. */
+  readonly allowUnauthorized?: boolean;
+}
+
+export interface AbapProfiles {
+  readonly profiles: Record<string, AbapProfile>;
+  readonly activeProfile: string | null;
+}
+
+// Operation errors
+
+export class AbapNotConfiguredError extends Error {
+  constructor() {
+    super(
+      "No SAP connection configured. Use the abap_setup tool first.",
+    );
+    this.name = "AbapNotConfiguredError";
+  }
+}
+
+export class AbapObjectNotFoundError extends Error {
+  constructor(name: string) {
+    super(`No ABAP object found matching "${name}".`);
+    this.name = "AbapObjectNotFoundError";
+  }
+}
+
+export class AbapProfileNotFoundError extends Error {
+  constructor(name: string, available: ReadonlyArray<string>) {
+    super(
+      `Profile "${name}" not found. Available: ${available.join(", ") || "none"}`,
+    );
+    this.name = "AbapProfileNotFoundError";
+  }
+}

package/tsconfig.json

@@ -0,0 +1,17 @@
+{
+  "compilerOptions": {
+    "target": "ES2022",
+    "module": "NodeNext",
+    "moduleResolution": "NodeNext",
+    "lib": ["ES2022"],
+    "types": ["node"],
+    "strict": true,
+    "skipLibCheck": true,
+    "noEmit": true,
+    "allowImportingTsExtensions": true,
+    "verbatimModuleSyntax": true,
+    "esModuleInterop": true,
+    "forceConsistentCasingInFileNames": true
+  },
+  "include": ["index.ts", "src/**/*.ts", "tests/**/*.ts"]
+}