@abapify/adt-plugin-abapgit 0.4.1 → 0.4.4

package/README.md

@@ -4,6 +4,30 @@
 
 abapGit format plugin for ADT — serializes ABAP objects to Git-compatible XML/ABAP files.
 
+## Pure materialization
+
+The registered `abapgitFormatPlugin` can produce a desired object tree without
+filesystem, ADT, or Git side effects. Explicit source components override
+mutable ADK source getters, while existing XSD-backed handlers continue to
+produce metadata:
+
+```typescript
+const { files } = await abapgitFormatPlugin.materialize({
+  object: adkClass,
+  objectType: 'CLAS',
+  packagePath: ['ZROOT', 'ZROOT_FEATURE'],
+  sources: {
+    main: selectedMainSource,
+    definitions: selectedLocalDefinitions,
+  },
+  formatOptions: { folderLogic: 'prefix' },
+});
+```
+
+Paths are rooted below `src/`, ordered deterministically, and annotated with
+their semantic role and source-component identity. Existing filesystem import
+and Git-to-SAP export APIs remain unchanged.
+
 ## Architecture Overview
 
 ```

package/dist/index.d.mts

@@ -1,8 +1,7 @@
-import { AbapObjectType, AdtPlugin, AdtPlugin as AdtPlugin$1, ExportContext, ExportResult, FormatPlugin, ImportContext, ImportResult } from "@abapify/adt-plugin";
+import { AbapObjectType, AdtPlugin, AdtPlugin as AdtPlugin$1, ExportContext, ExportResult, FormatMaterializationInput, FormatMaterializationResult, FormatPlugin, FormatSerializeOptions, ImportContext, ImportResult, MaterializedFormatFile } from "@abapify/adt-plugin";
 import { AdkObject } from "@abapify/adk";
 import { SchemaLike, TypedSchema } from "@abapify/ts-xsd";
-import { createAbapGitResolver as createFindingResolver } from "@abapify/adt-atc";
-
+import { adtUriToAbapGitPath, createAbapGitResolver as createFindingResolver } from "@abapify/adt-atc";
 //#region src/lib/format-plugin.d.ts
 declare const abapgitFormatPlugin: FormatPlugin;
 //#endregion
@@ -111,8 +110,10 @@ interface ObjectHandler<T extends AdkObject = AdkObject, TSchema extends AbapGit
   readonly schema: TSchema;
   /** Map abapGit file suffix to source key */
   readonly suffixToSourceKey?: Record<string, string>;
+  /** Whether this handler treats an explicit `sources` map as authoritative. */
+  readonly supportsExplicitSources?: boolean;
   /** Serialize object to files (SAP → Git) */
-  serialize(object: T): Promise<SerializedFile[]>;
+  serialize(object: T, options?: FormatSerializeOptions): Promise<SerializedFile[]>;
   /**
    * Map abapGit values to ADK data (Git → SAP)
    * Return type includes name (required) plus any ADK data fields
@@ -120,6 +121,14 @@ interface ObjectHandler<T extends AdkObject = AdkObject, TSchema extends AbapGit
   fromAbapGit?(values: InferValuesType<TSchema>): Partial<InferAdkData<T>> & {
     name: string;
   };
+  /**
+   * Map AFF JSON metadata to ADK data (Git → SAP)
+   * Used when the metadata file is `.json` (ABAP File Format) instead of legacy `.xml`.
+   * Receives the parsed JSON object and returns the full payload including name.
+   */
+  fromAffJson?(json: Record<string, unknown>): Partial<InferAdkData<T>> & {
+    name: string;
+  };
   /**
    * Set source files on ADK object during deserialization (Git → SAP)
    * Symmetric counterpart to getSources
@@ -145,15 +154,26 @@ declare function isSupported(type: AbapObjectType$1): boolean;
  */
 declare function getSupportedTypes(): AbapObjectType$1[];
 //#endregion
-//#region src/lib/deserializer.d.ts
+//#region src/lib/filename-parser.d.ts
+/**
+ * abapGit filename parsing utilities.
+ *
+ * Extracted into a standalone module so it can be unit-tested without
+ * pulling in the full handler/schema dependency chain.
+ */
 /**
  * abapGit file naming convention:
  * - XML metadata: {name}.{type}.xml (e.g., zcl_myclass.clas.xml)
+ * - AFF JSON metadata: {name}.{type}.json (e.g., zfoo.bdef.json)
  * - Source code: {name}.{type}.abap (e.g., zcl_myclass.clas.abap)
  * - Source includes: {name}.{type}.{suffix}.abap (e.g., zcl_myclass.clas.testclasses.abap)
+ * - AFF source files: {name}.{type}.abdl, {name}.{type}.acds, {name}.{type}.asrvd
  */
 /**
  * Parse abapGit filename to extract object info
+ *
+ * Supports both legacy XML metadata (.xml) and AFF JSON metadata (.json),
+ * plus source file extensions (.abap, .abdl, .acds, .asrvd).
  */
 declare function parseAbapGitFilename(filename: string): {
   name: string;
@@ -162,25 +182,6 @@ declare function parseAbapGitFilename(filename: string): {
   extension: string;
 } | null;
 //#endregion
-//#region src/lib/filename/adt-uri-to-path.d.ts
-/**
- * Convert an ADT URI to an on-disk abapGit filename.
- *
- * abapGit stores objects as `<name>.<type>.<ext>` inside `src/`.
- * Classes have additional includes serialised as
- * `<name>.clas.<suffix>.abap`. Function modules become
- * `<group>.fugr.<fm_name>.abap`. Namespaces are rendered as
- * `(namespace)name`.
- *
- * Returns `null` for URIs we don't recognise; callers may warn or fall
- * back to a synthetic path.
- */
-/**
- * Convert an ADT URI to the abapGit on-disk filename (lower-cased,
- * namespace-aware). Returns `null` when the URI shape is not recognised.
- */
-declare function adtUriToAbapGitPath(uri: string): string | null;
-//#endregion
 //#region src/lib/handlers/xml-format.d.ts
 /**
  * XML formatting utilities for abapGit serialization.
@@ -219,5 +220,5 @@ declare function moveNamespaceToAbap(xml: string): string;
  */
 declare function formatAbapGitXml(xml: string): string;
 //#endregion
-export { abapGitPlugin as AbapGitPlugin, abapGitPlugin, abapGitPlugin as default, type AbapObjectType, type AdtPlugin, type ExportContext, type ExportResult, type FolderLogic, type ImportContext, type ImportResult, type ObjectHandler, type SerializedFile, abapgitFormatPlugin, adtUriToAbapGitPath, createFindingResolver, formatAbapGitXml, formatXmlAttributes, getHandler, getSupportedTypes, isSupported, moveNamespaceToAbap, parseAbapGitFilename, parseAbapGitMetadata, resolvePackageFromDir, reverseResolveRootPackage };
+export { abapGitPlugin as AbapGitPlugin, abapGitPlugin, abapGitPlugin as default, type AbapObjectType, type AdtPlugin, type ExportContext, type ExportResult, type FolderLogic, type FormatMaterializationInput, type FormatMaterializationResult, type ImportContext, type ImportResult, type MaterializedFormatFile, type ObjectHandler, type SerializedFile, abapgitFormatPlugin, adtUriToAbapGitPath, createFindingResolver, formatAbapGitXml, formatXmlAttributes, getHandler, getSupportedTypes, isSupported, moveNamespaceToAbap, parseAbapGitFilename, parseAbapGitMetadata, resolvePackageFromDir, reverseResolveRootPackage };
 //# sourceMappingURL=index.d.mts.map

package/dist/index.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.mts","names":[],"sources":["../src/lib/format-plugin.ts","../src/lib/folder-logic.ts","../src/lib/abapgit.ts","../src/lib/handlers/abapgit-schema.ts","../src/lib/handlers/base.ts","../src/lib/deserializer.ts","../src/lib/filename/adt-uri-to-path.ts","../src/lib/handlers/xml-format.ts"],"mappings":";;;;;;cAoBa,mBAAA,EAAqB,YAAA;;;;;;;;;AAAlC;;KCXY,WAAA;;AA6CZ;;iBAAgB,oBAAA,CAAqB,UAAA;EACnC,WAAA,EAAa,WAAA;EACb,cAAA;AAAA;;;;;AAsBF;;;;;;;;;;iBAAgB,qBAAA,CACd,OAAA,UACA,WAAA,EAAa,WAAA,EACb,WAAA;;;;;;;;;;;;;iBA2Cc,yBAAA,CACd,UAAA,UACA,MAAA,UACA,WAAA,EAAa,WAAA;;;;;AD3Gf;;;cEmIa,aAAA,EAAe,WAAA;;;;;;;;;AD9I5B;UEYiB,aAAA,2BAGL,UAAA,GAAa,UAAA,UACf,WAAA,CAAY,KAAA,EAAO,CAAA;;WAElB,OAAA,EAAS,OAAA;AAAA;AFiGpB;AAAA,KEtDY,eAAA,MACV,CAAA,SAAU,aAAA,qBAAkC,CAAA;;;;;;;KCnDlC,YAAA,MACV,CAAA,SAAU,SAAA,sBAA+B,CAAA;;;;KAsB/B,gBAAA;;AHmCZ;;UG9BiB,cAAA;EHgCS;EG9BxB,IAAA;EH8Ba;EG5Bb,OAAA;EH6BA;EG3BA,QAAA,GAAW,cAAA;AAAA;AHsEb;;;;;;AAAA,UG7DiB,aAAA,WACL,SAAA,GAAY,SAAA,kBACN,aAAA,qBAAkC,aAAA;EH8DlD;EAAA,SGxDS,IAAA,EAAM,gBAAA;EHwDS;EAAA,SGtDf,aAAA;;WAEA,MAAA,EAAQ,OAAA;EF4EN;EAAA,SE1EF,iBAAA,GAAoB,MAAA;;EAE7B,SAAA,CAAU,MAAA,EAAQ,CAAA,GAAI,OAAA,CAAQ,cAAA;EFuN9B;;;;EElNA,WAAA,EACE,MAAA,EAAQ,eAAA,CAAgB,OAAA,IACvB,OAAA,CAAQ,YAAA,CAAa,CAAA;IAAQ,IAAA;EAAA;ED9DtB;;;;ECoEV,UAAA,EAAY,MAAA,EAAQ,CAAA,EAAG,OAAA,EAAS,MAAA;AAAA;;;;;;;;iBAyBlB,UAAA,CAAW,IAAA,EAAM,gBAAA,GAAiB,aAAA;;;AD/ClD;;;iBCwDgB,WAAA,CAAY,IAAA,EAAM,gBAAA;;;;iBAOlB,iBAAA,CAAA,GAAqB,gBAAA;;;;;;AH5HrC;;;;;AA6CA;iBIvBgB,oBAAA,CAAqB,QAAA;EACnC,IAAA;EACA,IAAA;EACA,MAAA;EACA,SAAA;AAAA;;;;;;;;;ALfF;;;;;;;;ACXA;;iBKwKgB,mBAAA,CAAoB,GAAA;;;;;;;;;AN7JpC;;;;;;;;ACXA;;;;;AA6CA;;;iBMGgB,mBAAA,CAAoB,GAAA;;;;;;;iBA8DpB,mBAAA,CAAoB,GAAA;;;;;;iBA8BpB,gBAAA,CAAiB,GAAA"}
+{"version":3,"file":"index.d.mts","names":[],"sources":["../src/lib/format-plugin.ts","../src/lib/folder-logic.ts","../src/lib/abapgit.ts","../src/lib/handlers/abapgit-schema.ts","../src/lib/handlers/base.ts","../src/lib/filename-parser.ts","../src/lib/handlers/xml-format.ts"],"mappings":";;;;;cAgGa,qBAAqB;;;;;;;;;;;KCvFtB;;;;iBA6CI,qBAAqB;EACnC,aAAa;EACb;;;;;;;;;;;;;;;;iBAsBc,sBACd,iBACA,aAAa,aACb;;;;;;;;;;;;;iBA2Cc,0BACd,oBACA,gBACA,aAAa;;;;;;;;cCwBF,eAAe;;;;;;;;;;UClIX,cACf,OACA,SACA,UAAU,aAAa,oBACf,YAAY,OAAO;;WAElB,SAAS;;;KA2CR,gBAAgB,KAC1B,UAAU,6BAA6B,KAAK;;;;;;;KC/ClC,aAAa,KACvB,UAAU,gBAAgB,UAAU,KAAK;;;;KAsB/B;;;;UAKK;;EAEf;;EAEA;;EAEA,WAAW;;;;;;;;UASI,cACf,UAAU,YAAY,WACtB,gBAAgB,kCAAkC;;WAMzC,MAAM;;WAEN;;WAEA,QAAQ;;WAER,oBAAoB;;WAEpB;;EAET,UACE,QAAQ,GACR,UAAU,yBACT,QAAQ;;;;;EAKX,aACE,QAAQ,gBAAgB,WACvB,QAAQ,aAAa;IAAQ;;;;;;;EAOhC,aAAa,MAAM,0BAA0B,QAAQ,aAAa;IAChE;;;;;;EAOF,YAAY,QAAQ,GAAG,SAAS;;;;;;;;;iBAyBlB,WAAW,MAAM,mBAAiB;;;;;;iBASlC,YAAY,MAAM;;;;iBAOlB,qBAAqB;;;;;;;;;;;;;;;;;;;;;;;iBCjIrB,qBAAqB;EACnC;EACA;EACA;EACA;;;;;;;;;;;;;;;;;;;;;;;;;;iBC+Bc,oBAAoB;;;;;;;iBA8DpB,oBAAoB;;;;;;iBA8BpB,iBAAiB"}