sodas-sdk 1.3.11 → 1.4.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -43,6 +43,7 @@ declare class Dataset extends DCAT_RESOURCE {
43
43
  */
44
44
  static configureAPIURL(url: string): void;
45
45
  static listUserDBRecords(pageNumber?: number, pageSize?: number, sortOrder?: SortOrder): Promise<PaginatedResponse<Dataset>>;
46
+ static getRDF(id: string, depth?: number): Promise<string>;
46
47
  static searchDBRecords(searchKeyword: string, pageNumber?: number, pageSize?: number, sortOrder?: SortOrder): Promise<PaginatedResponse<Dataset>>;
47
48
  toDTO(): DatasetDTO;
48
49
  populateFromDTO(dto: DCAT_MODEL_DTO): Promise<void>;
@@ -47,6 +47,7 @@ declare class DatasetSeries extends DCAT_RESOURCE {
47
47
  * @param {string} url - The base URL for the dataset API.
48
48
  */
49
49
  static configureAPIURL(url: string): void;
50
+ static getRDF(id: string, depth?: number): Promise<string>;
50
51
  static listUserDBRecords(pageNumber?: number, pageSize?: number, sortOrder?: SortOrder): Promise<PaginatedResponse<DatasetSeries>>;
51
52
  toDTO(): DatasetSeriesDTO;
52
53
  populateFromDTO(dto: DCAT_MODEL_DTO): Promise<void>;
@@ -0,0 +1,83 @@
1
+ import { IDType, PaginatedResponse, SortOrder } from "../../core/type";
2
+ import GOVERNANCE_MODEL, { GOVERNANCE_MODEL_DTO } from "../governanceClass";
3
+ export declare enum VALIDATION_TYPE {
4
+ DATA_TYPE = "data_type",
5
+ RANGE = "range",
6
+ PATTERN = "pattern",
7
+ UNIQUENESS = "uniqueness",
8
+ COMPLETENESS = "completeness",
9
+ LENGTH = "length",
10
+ ALLOWED_VALUES = "allowed_values",
11
+ OUTLIER = "outlier",
12
+ STATISTICAL = "statistical"
13
+ }
14
+ export declare enum EXPECTED_TYPE {
15
+ NUMERIC = "numeric",
16
+ STRING = "string",
17
+ DATETIME = "datetime"
18
+ }
19
+ export interface ValidationRule {
20
+ column: string;
21
+ name: string;
22
+ type: VALIDATION_TYPE;
23
+ }
24
+ export interface completnessValidationRule extends ValidationRule {
25
+ type: VALIDATION_TYPE.COMPLETENESS;
26
+ min_completeness: number;
27
+ weight: number;
28
+ }
29
+ export interface dataTypeValidationRule extends ValidationRule {
30
+ type: VALIDATION_TYPE.DATA_TYPE;
31
+ expected_type: EXPECTED_TYPE;
32
+ weight: number;
33
+ }
34
+ export interface uniquenessValidationRule extends ValidationRule {
35
+ type: VALIDATION_TYPE.UNIQUENESS;
36
+ weight: number;
37
+ }
38
+ export interface patternValidationRule extends ValidationRule {
39
+ type: VALIDATION_TYPE.PATTERN;
40
+ pattern: string;
41
+ weight: number;
42
+ }
43
+ export interface ValidationTemplateDTO extends GOVERNANCE_MODEL_DTO {
44
+ name: string;
45
+ description?: string;
46
+ validationRules: ValidationRule[];
47
+ }
48
+ declare class ValidationTemplate extends GOVERNANCE_MODEL {
49
+ private Name;
50
+ private Description;
51
+ private ValidationRules;
52
+ static configureAPIURL(url: string): void;
53
+ toDTO(): ValidationTemplateDTO;
54
+ populateFromFormData(data: any): Promise<void>;
55
+ populateFromDTO(dto: GOVERNANCE_MODEL_DTO): Promise<void>;
56
+ static listDBRecords(pageNumber?: number, pageSize?: number, sortOrder?: SortOrder, vocabularyID?: IDType): Promise<PaginatedResponse<ValidationTemplate>>;
57
+ get name(): string;
58
+ set name(value: string);
59
+ get description(): string;
60
+ set description(value: string);
61
+ get validationRules(): ValidationRule[];
62
+ set validationRules(value: ValidationRule[]);
63
+ static parseValidationRules(rawRules: any[]): ValidationRule[];
64
+ private ensureValidationRulesInitialized;
65
+ createRule(type: VALIDATION_TYPE): ValidationRule;
66
+ deleteRuleAt(index: number): void;
67
+ deleteRuleByTypeAt(type: VALIDATION_TYPE, index: number): void;
68
+ static groupValidationRulesByColumn(rules: ValidationRule[]): Record<string, ValidationRule[]>;
69
+ static groupValidationRulesByType(rules: ValidationRule[]): Record<VALIDATION_TYPE, ValidationRule[]>;
70
+ /**
71
+ * Parse escaped JSON string containing validation_rules to ValidationRule[]
72
+ * @param escapedString - Escaped JSON string like "validation_rules\":[{\"column\":\"class_label\",...}]"
73
+ * @returns Parsed ValidationRule array
74
+ */
75
+ static parseValidationRulesFromEscapedString(escapedString: string): ValidationRule[];
76
+ /**
77
+ * Convert ValidationRule[] to escaped JSON string
78
+ * @param rules - ValidationRule array to stringify
79
+ * @returns Escaped JSON string with format: "{\"validation_rules\":[...]}"
80
+ */
81
+ static stringifyValidationRulesToEscapedString(rules: ValidationRule[]): string;
82
+ }
83
+ export default ValidationTemplate;
@@ -0,0 +1,6 @@
1
+ import ValidationTemplate, { ValidationTemplateDTO } from "../../SODAS_SDK_CLASS/template/validation";
2
+ export declare function getTestCreateValidationTemplateDTO(index?: number, name?: string): ValidationTemplateDTO;
3
+ export declare function getTestUpdateValidationTemplateDTO(updating: ValidationTemplate, index?: number): ValidationTemplateDTO;
4
+ export declare function createTestValidationTemplate(index?: number, name?: string): Promise<ValidationTemplate>;
5
+ export declare function createNumberOfTestValidationTemplates(number?: number, name?: string): Promise<ValidationTemplate[]>;
6
+ export declare function deleteAllValidationTemplates(): Promise<void>;
@@ -59,10 +59,6 @@ export declare enum ResourceDescriptorRole {
59
59
  SPECIFICATION = "specification",
60
60
  GUIDANCE = "guidance"
61
61
  }
62
- export declare enum ProfileType {
63
- DCAT = "dcat",
64
- DATA = "data"
65
- }
66
62
  export declare enum ArtifactType {
67
63
  TEMPLATE = "template",
68
64
  FILE = "file"