@dqc.ai/fiori-sdk 0.1.0

package/LICENSE

@@ -0,0 +1,6 @@
+Copyright (c) 2026 dqc.ai GmbH. All rights reserved.
+
+This software is proprietary and confidential. Unauthorized copying, distribution,
+or use of this software, via any medium, is strictly prohibited.
+
+For licensing inquiries, contact: support@dqc.ai

package/README.md

@@ -0,0 +1,209 @@
+# @dqc.ai/fiori-sdk
+
+> Real-time data quality validation for SAP Fiori applications — powered by [DQC](https://dqc.ai).
+
+## Overview
+
+The **DQC Fiori SDK** is a UI5 library that integrates DQC's Validation API directly into SAP Fiori apps. It enables **inline, real-time validation** of form data against centrally managed DQC rulesets — before the data is saved to SAP.
+
+- ✅ **Catch data quality issues at the point of entry** — not days later in a batch run
+- ✅ **Central rule management** — rules are maintained in DQC, not hard-coded in Fiori apps
+- ✅ **No ABAP changes required** — the SDK calls the DQC Validation API over HTTPS
+- ✅ **Works with any Fiori app** — Freestyle, Fiori Elements, or custom UI5 apps
+
+## Installation
+
+**Please reach out to the DQC team to get access.**
+
+Add the DQC Fiori SDK to your UI5 project:
+
+```json
+{
+  "dependencies": {
+    "@dqc.ai/fiori-sdk": "^0.1.0"
+  }
+}
+```
+
+Or load directly in `manifest.json`:
+
+```json
+{
+  "sap.ui5": {
+    "resourceRoots": {
+      "dqc.validation": "https://cdn.dqc.ai/<customer-id>/fiori-sdk/1.0/"
+    }
+  }
+}
+```
+
+## Quick Start
+
+```javascript
+// Component.js
+sap.ui.define([
+  "sap/ui/core/UIComponent",
+  "dqc/validation/DQCClient"
+], function(UIComponent, DQCClient) {
+  "use strict";
+
+  return UIComponent.extend("my.app.Component", {
+    init: function() {
+      UIComponent.prototype.init.apply(this, arguments);
+
+      // Initialize DQC Client
+      this._dqcClient = new DQCClient({
+        baseUrl: "https://your-dqc-instance.dqc.ai",
+        tenantId: "your-tenant-uuid",
+        apiKey: "your-api-key",
+        rulesetId: "your-ruleset-uuid"
+      });
+    }
+  });
+});
+```
+
+### Validate Form Data
+
+```javascript
+// In your controller
+onValidatePress: async function() {
+  var oModel = this.getView().getModel();
+  var oData = oModel.getProperty("/materialData");
+
+  try {
+    var oResult = await this._dqcClient.validate({
+      data: [
+        {
+          "MaterialNumber":  { type: "string",  value: oData.MaterialNumber },
+          "Description":     { type: "string",  value: oData.Description },
+          "Weight":          { type: "number",  value: oData.Weight },
+          "CreatedDate":     { type: "date",    value: oData.CreatedDate, date_format: "YYYY-MM-DD" }
+        }
+      ]
+    });
+
+    if (oResult.passed) {
+      MessageToast.show("Alle Prüfungen bestanden ✓");
+    } else {
+      this._dqcClient.applyIssues(this.getView(), oResult);
+    }
+  } catch (oError) {
+    MessageBox.error("Validierung fehlgeschlagen: " + oError.message);
+  }
+}
+```
+
+## API Reference
+
+### `DQCClient(config)`
+
+```javascript
+new DQCClient({
+  baseUrl: string,           // DQC platform URL
+  tenantId: string,          // Tenant UUID
+  apiKey?: string,           // API key authentication
+  destination?: string,      // SAP BTP Destination name (alternative to baseUrl + apiKey)
+  rulesetId?: string,        // Default ruleset (can override per call)
+  timeout?: number           // Request timeout in ms (default: 30000)
+})
+```
+
+### `validate(payload, options?)`
+
+Validates data against a DQC ruleset.
+
+| Parameter | Type | Description |
+|-----------|------|-------------|
+| `payload.data` | `Array<Object>` | Row objects. Each field: `{ type, value, date_format? }` |
+| `payload.rules_to_apply` | `string[]` | *(Optional)* Specific rule IDs. Empty = all rules |
+| `options.rulesetId` | `string` | *(Optional)* Override default ruleset |
+| `options.detailed` | `boolean` | *(Optional)* Detailed results (default: `true`) |
+
+**Returns:** `Promise<ValidationResponse>`
+
+```javascript
+{
+  request_id: "req-123",
+  passed: false,
+  total_rows_validated: 1,
+  total_issues: 2,
+  rule_results: [{
+    rule_id: "uuid",
+    rule_name: "Material Number Format",
+    rule_description: "Must match pattern MAT-XXXXXX",
+    total_issues: 1,
+    passed: false,
+    issues: [{
+      row_index: 0,
+      column_name: "MaterialNumber",
+      value: "12345",
+      expected_pattern: "MAT-\\d{6}",
+      error_message: "Material number does not match required format"
+    }]
+  }]
+}
+```
+
+### `applyIssues(view, validationResponse)`
+
+Sets `ValueState.Error` and `ValueStateText` on matching UI5 input controls automatically.
+
+### `clearIssues(view)`
+
+Resets all `ValueState` on controls previously marked by `applyIssues`.
+
+### `validateField(fieldName, value, type)`
+
+Validates a single field. Returns only issues for that field. Useful for `liveChange` handlers.
+
+## Authentication
+
+### API Key
+
+```javascript
+new DQCClient({
+  baseUrl: "https://your-instance.dqc.ai",
+  tenantId: "...",
+  apiKey: "dqc_ak_xxxxxxxxxxxx"
+});
+```
+
+⚠️ API keys in frontend code are visible to users. Use only for internal/intranet Fiori apps or combine with SAP BTP Destination Service.
+
+### SAP BTP Destination (Recommended for Production)
+
+Route requests through SAP BTP Destination Service — keeps credentials server-side.
+
+1. Create a Destination in SAP BTP Cockpit (`DQC_VALIDATION`, OAuth2ClientCredentials)
+2. Use in SDK:
+
+```javascript
+new DQCClient({
+  destination: "DQC_VALIDATION",
+  rulesetId: "your-ruleset-uuid"
+});
+```
+
+## Supported Environments
+
+| Environment | Support |
+|-------------|---------|
+| SAP Fiori Launchpad (on-premise) | ✅ |
+| SAP BTP / Fiori Launchpad (cloud) | ✅ |
+| SAP Work Zone | ✅ |
+| Standalone UI5 app | ✅ |
+| SAP Mobile Start | ✅ (via BTP Destination) |
+| SAPUI5 1.96+ / OpenUI5 | ✅ |
+
+## Documentation
+
+Full documentation: **[docs.dqc.ai/fiori-sdk](https://docs.dqc.ai/fiori-sdk)**
+
+## Status
+
+🚧 **Early Access** — This package is under active development. Contact [support@dqc.ai](mailto:support@dqc.ai) for early access and integration support.
+
+## License
+
+Proprietary — see [LICENSE](./LICENSE) for details.

package/index.d.ts

@@ -0,0 +1,66 @@
+/**
+ * @dqc.ai/fiori-sdk
+ * DQC Validation SDK for SAP Fiori
+ */
+
+export interface DQCClientConfig {
+  baseUrl?: string;
+  tenantId?: string;
+  apiKey?: string;
+  destination?: string;
+  rulesetId?: string;
+  language?: "de" | "en";
+  timeout?: number;
+  failMode?: "open" | "closed";
+  retries?: number;
+  retryDelay?: number;
+}
+
+export interface EntryDataType {
+  type: "string" | "number" | "date" | "boolean";
+  value: any;
+  date_format?: string;
+}
+
+export interface ValidatePayload {
+  data: Array<Record<string, EntryDataType>>;
+  rules_to_apply?: string[];
+}
+
+export interface ValidateOptions {
+  rulesetId?: string;
+  detailed?: boolean;
+}
+
+export interface ValidationIssue {
+  row_index: number;
+  column_name: string | null;
+  value: any;
+  expected_pattern: string | null;
+  error_message: string;
+}
+
+export interface RuleValidationResult {
+  rule_id: string;
+  rule_name: string;
+  rule_description: string | null;
+  total_issues: number;
+  issues: ValidationIssue[];
+  passed: boolean;
+}
+
+export interface ValidationResponse {
+  request_id: string;
+  total_rows_validated: number;
+  total_issues: number;
+  passed: boolean;
+  rule_results: RuleValidationResult[];
+}
+
+export declare class DQCClient {
+  constructor(config: DQCClientConfig);
+  validate(payload: ValidatePayload, options?: ValidateOptions): Promise<ValidationResponse>;
+  validateField(fieldName: string, value: any, type: string): Promise<ValidationIssue[]>;
+  applyIssues(view: any, validationResponse: ValidationResponse): void;
+  clearIssues(view: any): void;
+}

package/index.js

@@ -0,0 +1,60 @@
+/**
+ * @dqc.ai/fiori-sdk
+ *
+ * DQC Validation SDK for SAP Fiori
+ * Real-time data quality validation in UI5 applications.
+ *
+ * Documentation: https://docs.dqc.ai/fiori-sdk
+ * Support: support@dqc.ai
+ *
+ * @version 0.1.0
+ * @license SEE LICENSE IN LICENSE
+ */
+
+"use strict";
+
+class DQCClient {
+  constructor(config) {
+    this.baseUrl = config.baseUrl;
+    this.tenantId = config.tenantId;
+    this.rulesetId = config.rulesetId;
+    this._ready = false;
+
+    if (!config.baseUrl) {
+      console.warn(
+        "[@dqc.ai/fiori-sdk] This is a placeholder package. " +
+        "Full SDK coming soon — contact support@dqc.ai for early access."
+      );
+    }
+  }
+
+  async validate(/* payload, options */) {
+    throw new Error(
+      "[@dqc.ai/fiori-sdk] Not yet implemented. " +
+      "Full SDK coming soon — see https://docs.dqc.ai/fiori-sdk"
+    );
+  }
+
+  async validateField(/* fieldName, value, type */) {
+    throw new Error(
+      "[@dqc.ai/fiori-sdk] Not yet implemented. " +
+      "Full SDK coming soon — see https://docs.dqc.ai/fiori-sdk"
+    );
+  }
+
+  applyIssues(/* view, validationResponse */) {
+    throw new Error(
+      "[@dqc.ai/fiori-sdk] Not yet implemented. " +
+      "Full SDK coming soon — see https://docs.dqc.ai/fiori-sdk"
+    );
+  }
+
+  clearIssues(/* view */) {
+    throw new Error(
+      "[@dqc.ai/fiori-sdk] Not yet implemented. " +
+      "Full SDK coming soon — see https://docs.dqc.ai/fiori-sdk"
+    );
+  }
+}
+
+module.exports = { DQCClient };

package/package.json

@@ -0,0 +1,37 @@
+{
+  "name": "@dqc.ai/fiori-sdk",
+  "version": "0.1.0",
+  "description": "DQC Validation SDK for SAP Fiori — real-time data quality validation in UI5 apps",
+  "main": "index.js",
+  "types": "index.d.ts",
+  "keywords": [
+    "dqc",
+    "data-quality",
+    "sap",
+    "fiori",
+    "ui5",
+    "sapui5",
+    "openui5",
+    "validation",
+    "sap-btp"
+  ],
+  "author": "dqc.ai <code@dqc.ai> (https://dqc.ai)",
+  "license": "SEE LICENSE IN LICENSE",
+  "homepage": "https://docs.dqc.ai/fiori-sdk",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/dataqcompany/fiori-sdk"
+  },
+  "bugs": {
+    "url": "https://github.com/dataqcompany/fiori-sdk/issues"
+  },
+  "engines": {
+    "node": ">=16.0.0"
+  },
+  "files": [
+    "index.js",
+    "index.d.ts",
+    "README.md",
+    "LICENSE"
+  ]
+}