@sap/artifact-management-types 1.49.0 → 1.50.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sap/artifact-management-types",
-  "version": "1.49.0",
+  "version": "1.50.0",
   "description": "Type signatures for artifact management",
   "types": "./src/index.d.ts",
   "main": "./src/index.d.ts",
@@ -10,7 +10,7 @@
     "pack": "npm run modify-types-import && npm pack"
   },
   "dependencies": {
-    "@sap/artifact-management-base-types": "1.49.0"
+    "@sap/artifact-management-base-types": "1.50.0"
   },
   "devDependencies": {
     "gulp": "4.0.2"

package/src/plugins/dataproduct/InfoList.d.ts

@@ -0,0 +1,37 @@
+/**
+ * Error and warning message definitions for Data Product plugin
+ */
+export declare const InfoList: Readonly<{
+    ERR_DPD_FILE_INVALID: {
+        code: string;
+        description: string;
+    };
+    ERR_DPD_HEADER_MISSING: {
+        code: string;
+        description: string;
+    };
+    ERR_DPD_NAME_UNDEFINED: {
+        code: string;
+        description: string;
+    };
+    ERR_DPD_NAMESPACE_UNDEFINED: {
+        code: string;
+        description: string;
+    };
+    ERR_DPD_VERSION_UNDEFINED: {
+        code: string;
+        description: string;
+    };
+    ERR_DATAPRODUCTS_FOLDER_EMPTY: {
+        code: string;
+        description: string;
+    };
+    WARN_DPD_TITLE_UNDEFINED: {
+        code: string;
+        description: string;
+    };
+    WARN_DPD_DESCRIPTION_UNDEFINED: {
+        code: string;
+        description: string;
+    };
+}>;

package/src/plugins/dataproduct/index.d.ts

@@ -0,0 +1,8 @@
+import { Plugin } from '@sap/artifact-management-base-types';
+/**
+ * Data Product Plugin for Artifact Management.
+ * Provides support for Data Product projects containing .dpd files.
+ */
+declare const DataProductPlugin: Plugin;
+export default DataProductPlugin;
+export { InfoList } from './InfoList';

package/src/plugins/dataproduct/readers/DataProductItemReader.d.ts

@@ -0,0 +1,24 @@
+import { Item, ProjectEntityReaderReadOptions } from '@sap/artifact-management-base-types';
+/**
+ * Item reader for individual .dpd files.
+ * Extracts metadata from each data product definition file.
+ */
+export default class DataProductItemReader {
+    matchConditions: {
+        filePatterns: string[];
+    };
+    types: string[];
+    tags: string[];
+    /**
+     * Read all .dpd files in the current directory and extract their metadata.
+     */
+    read({ fs }: ProjectEntityReaderReadOptions): Promise<Item[]>;
+    /**
+     * Parse a .dpd file and create an Item from it.
+     */
+    private parseDataProductFile;
+    /**
+     * Create an error item when parsing fails.
+     */
+    private createErrorItem;
+}

package/src/plugins/dataproduct/readers/DataProductModuleReader.d.ts

@@ -0,0 +1,17 @@
+import { DetectionMechanism, KeyIn, ModuleData, ModuleReader, ModuleType, ProjectEntityReaderReadOptions } from '@sap/artifact-management-base-types';
+import DataProductItemReader from './DataProductItemReader';
+/**
+ * Module reader for the dataProducts folder.
+ * Reads the dataProducts folder and its .dpd files.
+ */
+export default class DataProductModuleReader extends ModuleReader {
+    supportedProjectType: string[];
+    getType(): KeyIn<typeof ModuleType>;
+    getDetectionMechanism(): DetectionMechanism;
+    matchConditions: {
+        requiredFilePatterns: string[];
+    };
+    itemReaders: DataProductItemReader[];
+    tags: string[];
+    read({ fs }: ProjectEntityReaderReadOptions): Promise<ModuleData | undefined>;
+}

package/src/plugins/dataproduct/readers/DataProductProjectReader.d.ts

@@ -0,0 +1,16 @@
+import { DetectionMechanism, KeyIn, ProjectData, ProjectReader, ProjectReaderOptions, ProjectType } from '@sap/artifact-management-base-types';
+import DataProductModuleReader from './DataProductModuleReader';
+/**
+ * Project reader for Data Product projects.
+ * Detects projects that have a 'dataProducts' folder directly under root
+ * containing .dpd files.
+ */
+export default class DataProductProjectReader extends ProjectReader {
+    constructor();
+    getType(): KeyIn<typeof ProjectType>;
+    getDetectionMechanism(): DetectionMechanism;
+    additionalModuleReaders: DataProductModuleReader[][];
+    tags: string[];
+    moduleSearchPattern(): Promise<string[]>;
+    read({ fs }: ProjectReaderOptions): Promise<ProjectData | undefined>;
+}

package/src/plugins/dataproduct/types/DataProductDefinition.d.ts

@@ -0,0 +1,96 @@
+/**
+ * TypeScript interfaces for Data Product Definition (.dpd) files
+ */
+/**
+ * Header section of the data product definition
+ */
+export interface DataProductHeader {
+    name: string;
+    namespace: string;
+    version: string;
+    title?: string;
+    description?: string;
+    shortDescription?: string;
+    type?: string;
+    category?: string;
+}
+/**
+ * Output port configuration
+ */
+export interface DataProductOutputPort {
+    name: string;
+    protocol: string;
+}
+/**
+ * Input port configuration
+ */
+export interface DataProductInputPort {
+    name?: string;
+    protocol?: string;
+}
+/**
+ * Meta information
+ */
+export interface DataProductMeta {
+    creator?: string;
+}
+/**
+ * Data source definition
+ */
+export interface DataProductDataSource {
+    name: string;
+    definition?: Record<string, unknown>;
+}
+/**
+ * Source configuration
+ */
+export interface DataProductSource {
+    systemTypes?: string[];
+    systemId?: string;
+    dataSourceType?: string;
+    dataSources?: DataProductDataSource[];
+}
+/**
+ * Target configuration
+ */
+export interface DataProductTarget {
+    definition?: {
+        definitions?: Record<string, unknown>;
+    };
+}
+/**
+ * Transformation configuration
+ */
+export interface DataProductTransformation {
+    transformers?: Record<string, unknown>;
+}
+/**
+ * Main definition structure
+ */
+export interface DataProductDefinitionContent {
+    header: DataProductHeader;
+    dataProductDefinitionInterop?: string;
+    inputPorts?: DataProductInputPort[];
+    outputPorts?: DataProductOutputPort[];
+    meta?: DataProductMeta;
+    source?: DataProductSource;
+    target?: DataProductTarget;
+    transformation?: DataProductTransformation;
+}
+/**
+ * Root structure of a .dpd file
+ */
+export interface DataProductFile {
+    definition: DataProductDefinitionContent;
+}
+/**
+ * Extracted information from a data product for Project API
+ */
+export interface DataProductInfo {
+    id: string;
+    title: string;
+    namespace: string;
+    version: string;
+    majorVersion: string;
+    description?: string;
+}