@abapify/adt-plugin-gcts 0.4.0 → 0.4.3

package/dist/index.d.mts

@@ -0,0 +1,166 @@
+import { AdtPlugin, AdtPlugin as AdtPlugin$1, FormatHandler, FormatHandler as FormatHandler$1, FormatPlugin, FormatPlugin as FormatPlugin$1, ParsedFormatFilename, SerializedFile, SerializedFile as SerializedFile$1 } from "@abapify/adt-plugin";
+import { AdkClass, AdkDataElement, AdkDomain, AdkFunctionGroup, AdkInterface, AdkKind, AdkObject, AdkPackage, AdkProgram, AdkTable, AdkTableType } from "@abapify/adk";
+//#region src/lib/format/types.d.ts
+/**
+ * gCTS / AFF format type definitions.
+ *
+ * The gCTS on-disk layout is essentially the layout documented by the AFF
+ * project (`SAP/abap-file-formats`): object-type subdirectory, JSON metadata,
+ * source files with AFF-specific extensions (`.abap`, `.acds`, ...).
+ *
+ * This plugin intentionally targets the AFF format so that a single plugin
+ * id (`gcts`) covers both gCTS-exported repos and AFF-exported repos. See
+ * `AGENTS.md` for the rationale and the open question tracked in
+ * `docs/roadmap/epics/e06-gcts-format-plugin.md`.
+ */
+/** Header common to every AFF/gCTS metadata JSON file. */
+interface GctsHeader {
+  /** AFF format version (e.g. `1.0`). */
+  formatVersion: string;
+  /** Description of the object. */
+  description?: string;
+  /** Master language (ISO code, lowercase — e.g. `en`). */
+  originalLanguage?: string;
+  /** ABAP language version (e.g. `standard`, `cloudDevelopment`). */
+  abapLanguageVersion?: string;
+  /** Indicates whether the object source is Unicode. */
+  [key: string]: unknown;
+}
+/**
+ * Top-level shape of an AFF/gCTS metadata JSON file.
+ *
+ * Concrete handlers tighten this with per-type payload shapes.
+ */
+interface GctsMetadata<_TPayload extends object = object> {
+  /** Format header (mandatory on every file). */
+  header: GctsHeader;
+  /** Type-specific payload. Extended per ABAP object type. */
+  [payloadKey: string]: unknown;
+}
+/** Convenience helper for concrete metadata shapes. */
+type WithHeader<TPayload extends object> = {
+  header: GctsHeader;
+} & TPayload;
+//#endregion
+//#region src/lib/format/filename.d.ts
+/** Metadata extension for all AFF/gCTS objects. */
+declare const METADATA_EXTENSION = "json";
+/** Fixed filename for package metadata (AFF / gCTS convention). */
+declare const PACKAGE_FILENAME = "package.devc.json";
+/**
+ * Build the AFF/gCTS on-disk filename for an object.
+ *
+ * @param name     Object name (case preserved — AFF normalises to lowercase)
+ * @param type     ABAP object type code (CLAS, INTF, ...)
+ * @param kind     `"metadata"` (default) or `"source"`.
+ * @param suffix   Optional sub-include suffix (e.g. `locals_def` for CLAS).
+ */
+declare function gctsFilename(name: string, type: string, kind?: 'metadata' | 'source', suffix?: string): string;
+/**
+ * Parse an AFF/gCTS filename back into its components.
+ *
+ * Returns `undefined` if the filename does not look like a known AFF/gCTS
+ * artefact — callers should skip unknown files (e.g. `README.md`).
+ */
+declare function parseGctsFilename(filename: string): ParsedFormatFilename | undefined;
+/**
+ * Translate an ADT object URI (e.g. `/sap/bc/adt/oo/classes/zcl_foo`) to
+ * the AFF/gCTS on-disk path (e.g. `zcl_foo/zcl_foo.clas.json`).
+ *
+ * Matches the `adtUriToAbapGitPath` helper in the abapGit plugin.
+ */
+declare function adtUriToGctsPath(uri: string): string | undefined;
+//#endregion
+//#region src/lib/handlers/base.d.ts
+type AbapObjectType = string;
+type AdkObjectClass<T extends AdkObject = AdkObject> = {
+  new (...args: any[]): T;
+  readonly kind: AdkKind;
+};
+/**
+ * Lazy source entry.
+ *
+ * `content` may be a string, a promise, or a thunk returning either — the
+ * factory awaits whichever form the handler returns.
+ */
+interface GctsSourceEntry {
+  suffix?: string;
+  content: string | Promise<string> | (() => string | Promise<string>);
+}
+/**
+ * Extra file emitted alongside the standard metadata + source files.
+ * Used by compound handlers (e.g. FUGR emitting per-function-module files).
+ * `path` is relative to the object directory.
+ */
+interface GctsExtraFile {
+  path: string;
+  content: string | Promise<string> | (() => string | Promise<string>);
+}
+/**
+ * Handler definition for a single ABAP object type.
+ *
+ * The shape intentionally mirrors the abapGit `HandlerDefinition` so that
+ * anyone familiar with the sister plugin can move between them with minimal
+ * friction. The `toMetadata` function is the only required hook: it maps an
+ * ADK object to the JSON metadata shape for the target type.
+ */
+interface GctsHandlerDefinition<T extends AdkObject, M extends GctsMetadata = GctsMetadata> {
+  /** Map ADK object → JSON metadata payload (including the required `header`). */
+  toMetadata(object: T): M;
+  /** Optional: single primary source file. */
+  getSource?(object: T): string | Promise<string>;
+  /** Optional: multiple source files (e.g. CLAS includes). */
+  getSources?(object: T): GctsSourceEntry[];
+  /** Optional: extra files with full paths (e.g. FUGR per-FM .func.json). */
+  getExtraFiles?(object: T): GctsExtraFile[] | Promise<GctsExtraFile[]>;
+  /** Optional: custom metadata filename (e.g. `package.devc.json` for DEVC). */
+  metadataFileName?: string | ((object: T) => string);
+  /**
+   * Optional: inverse mapping used during deserialization.
+   *
+   * `fromMetadata` receives the parsed JSON payload and returns a partial
+   * ADK-data projection. `setSources` mirrors abapGit's behaviour: it stages
+   * source content on the ADK object for later deploy.
+   */
+  fromMetadata?(metadata: M): {
+    name: string;
+  } & Record<string, unknown>;
+  suffixToSourceKey?: Record<string, string>;
+  setSources?(object: T, sources: Record<string, string>): void;
+}
+/** Runtime shape of a gCTS handler after `createHandler` processing. */
+interface GctsHandler<T extends AdkObject = AdkObject> extends FormatHandler$1 {
+  readonly type: AbapObjectType;
+  readonly fileExtension: string;
+  readonly schema: {
+    parse(raw: string): unknown;
+    build(data: unknown): string;
+  };
+  serialize(object: T): Promise<SerializedFile$1[]>;
+  fromAbapGit?(values: unknown): {
+    name: string;
+  } & Record<string, unknown>;
+  setSources?(object: T, sources: Record<string, string>): void;
+}
+/** Look up a handler (full-type first, then main-type fallback). */
+declare function getHandler(type: AbapObjectType): GctsHandler | undefined;
+/** `true` iff the given object type has a registered handler. */
+declare function isSupported(type: AbapObjectType): boolean;
+/** Snapshot of all registered object types. */
+declare function getSupportedTypes(): AbapObjectType[];
+/**
+ * Register a handler for an ADK class (preferred — `type` is derived from
+ * the static `kind`) or an explicit type string (for types without an ADK
+ * class, e.g. DOMA/DTEL).
+ */
+declare function createHandler<T extends AdkObject, M extends GctsMetadata = GctsMetadata>(adkClass: AdkObjectClass<T>, definition: GctsHandlerDefinition<T, M>): GctsHandler<T>;
+declare function createHandler<T extends AdkObject, M extends GctsMetadata = GctsMetadata>(type: AbapObjectType, definition: GctsHandlerDefinition<T, M>): GctsHandler<T>;
+//#endregion
+//#region src/lib/format/gcts-format.d.ts
+declare const gctsFormatPlugin: FormatPlugin$1;
+//#endregion
+//#region src/lib/gcts-plugin.d.ts
+declare const gctsPlugin: AdtPlugin$1;
+//#endregion
+export { type AdtPlugin, type FormatHandler, type FormatPlugin, type GctsHandler, type GctsHandlerDefinition, type GctsHeader, type GctsMetadata, gctsPlugin as GctsPlugin, gctsPlugin as default, gctsPlugin, type GctsSourceEntry, METADATA_EXTENSION, PACKAGE_FILENAME, type SerializedFile, type WithHeader, adtUriToGctsPath, createHandler, gctsFilename, gctsFormatPlugin, getHandler, getSupportedTypes, isSupported, parseGctsFilename };
+//# sourceMappingURL=index.d.mts.map

package/dist/index.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.mts","names":[],"sources":["../src/lib/format/types.ts","../src/lib/format/filename.ts","../src/lib/handlers/base.ts","../src/lib/format/gcts-format.ts","../src/lib/gcts-plugin.ts"],"mappings":";;;;;;;;;;;;;;;;UAciB;;EAEf;;EAEA;;EAEA;;EAEA;;GAEC;;;;;;;UAQc,aAAa;;EAE5B,QAAQ;;GAEP;;;KAIS,WAAW;EACrB,QAAQ;IACN;;;;cCNS;;cAGA;;;;;;;;;iBAUG,aACd,cACA,cACA,8BACA;;;;;;;iBAmBc,kBACd,mBACC;;;;;;;iBAwEa,iBAAiB;;;KC9HrB;KAEA,eAAe,UAAU,YAAY;UACvC,cAAc;WACb,MAAM;;;;;;;;UASA;EACf;EACA,kBAAkB,kCAAkC;;;;;;;UAQrC;EACf;EACA,kBAAkB,kCAAkC;;;;;;;;;;UAWrC,sBACf,UAAU,WACV,UAAU,eAAe;;EAGzB,WAAW,QAAQ,IAAI;;EAGvB,WAAW,QAAQ,aAAa;;EAGhC,YAAY,QAAQ,IAAI;;EAGxB,eAAe,QAAQ,IAAI,kBAAkB,QAAQ;;EAGrD,8BAA8B,QAAQ;;;;;;;;EAStC,cAAc,UAAU;IAAM;MAAiB;EAC/C,oBAAoB;EACpB,YAAY,QAAQ,GAAG,SAAS;;;UAIjB,YACf,UAAU,YAAY,mBACd;WACC,MAAM;WACN;WACA;IACP,MAAM;IACN,MAAM;;EAER,UAAU,QAAQ,IAAI,QAAQ;EAC9B,aAAa;IAAoB;MAAiB;EAClD,YAAY,QAAQ,GAAG,SAAS;;;iBAMlB,WAAW,MAAM,iBAAiB;;iBAKlC,YAAY,MAAM;;iBAKlB,qBAAqB;;;;;;iBAsBrB,cACd,UAAU,WACV,UAAU,eAAe,cAEzB,UAAU,eAAe,IACzB,YAAY,sBAAsB,GAAG,KACpC,YAAY;iBACC,cACd,UAAU,WACV,UAAU,eAAe,cAEzB,MAAM,gBACN,YAAY,sBAAsB,GAAG,KACpC,YAAY;;;cCpIF,kBAAkB;;;cCIlB,YAAY"}