sodas-sdk 1.1.13 → 1.4.0

package/dist/SODAS_SDK_CLASS/DCAT/dataService.d.ts

@@ -1,4 +1,4 @@
-import { IDType } from "../../core/type";
+import { IDType, PaginatedResponse, SortOrder } from "../../core/type";
 import { DCAT_MODEL_DTO } from "../dcatClass";
 import DCAT_RESOURCE, { DCAT_RESOURCE_DTO } from "./dcatResource";
 export interface DataServiceDTO extends DCAT_RESOURCE_DTO {
@@ -20,6 +20,7 @@ declare class DataService extends DCAT_RESOURCE {
      * @param {string} url - The base URL of the API.
      */
     static configureAPIURL(url: string): void;
+    static listUserDBRecords(pageNumber?: number, pageSize?: number, sortOrder?: SortOrder): Promise<PaginatedResponse<DataService>>;
     toDTO(): DataServiceDTO;
     populateFromDTO(dto: DCAT_MODEL_DTO): Promise<void>;
     get dataServiceID(): IDType;

package/dist/SODAS_SDK_CLASS/DCAT/dataset.d.ts

@@ -42,6 +42,8 @@ declare class Dataset extends DCAT_RESOURCE {
      * @param {string} url - The base URL for the dataset API.
      */
     static configureAPIURL(url: string): void;
+    static listUserDBRecords(pageNumber?: number, pageSize?: number, sortOrder?: SortOrder): Promise<PaginatedResponse<Dataset>>;
+    static getRDF(id: string, depth?: number): Promise<string>;
     static searchDBRecords(searchKeyword: string, pageNumber?: number, pageSize?: number, sortOrder?: SortOrder): Promise<PaginatedResponse<Dataset>>;
     toDTO(): DatasetDTO;
     populateFromDTO(dto: DCAT_MODEL_DTO): Promise<void>;

package/dist/SODAS_SDK_CLASS/DCAT/datasetSeries.d.ts

@@ -1,4 +1,4 @@
-import { IDType } from "../../core/type";
+import { IDType, PaginatedResponse, SortOrder } from "../../core/type";
 import { DCAT_MODEL_DTO } from "../dcatClass";
 import Dataset from "./dataset";
 import DCAT_RESOURCE, { DCAT_RESOURCE_DTO } from "./dcatResource";
@@ -47,6 +47,8 @@ declare class DatasetSeries extends DCAT_RESOURCE {
      * @param {string} url - The base URL for the dataset API.
      */
     static configureAPIURL(url: string): void;
+    static getRDF(id: string, depth?: number): Promise<string>;
+    static listUserDBRecords(pageNumber?: number, pageSize?: number, sortOrder?: SortOrder): Promise<PaginatedResponse<DatasetSeries>>;
     toDTO(): DatasetSeriesDTO;
     populateFromDTO(dto: DCAT_MODEL_DTO): Promise<void>;
     populateSeriesMembersFromDTO(dto: DatasetSeriesDTO): Promise<void>;

package/dist/SODAS_SDK_CLASS/template/validation.d.ts

@@ -0,0 +1,83 @@
+import { IDType, PaginatedResponse, SortOrder } from "../../core/type";
+import GOVERNANCE_MODEL, { GOVERNANCE_MODEL_DTO } from "../governanceClass";
+export declare enum VALIDATION_TYPE {
+    DATA_TYPE = "data_type",
+    RANGE = "range",
+    PATTERN = "pattern",
+    UNIQUENESS = "uniqueness",
+    COMPLETENESS = "completeness",
+    LENGTH = "length",
+    ALLOWED_VALUES = "allowed_values",
+    OUTLIER = "outlier",
+    STATISTICAL = "statistical"
+}
+export declare enum EXPECTED_TYPE {
+    NUMERIC = "numeric",
+    STRING = "string",
+    DATETIME = "datetime"
+}
+export interface ValidationRule {
+    column: string;
+    name: string;
+    type: VALIDATION_TYPE;
+}
+export interface completnessValidationRule extends ValidationRule {
+    type: VALIDATION_TYPE.COMPLETENESS;
+    min_completeness: number;
+    weight: number;
+}
+export interface dataTypeValidationRule extends ValidationRule {
+    type: VALIDATION_TYPE.DATA_TYPE;
+    expected_type: EXPECTED_TYPE;
+    weight: number;
+}
+export interface uniquenessValidationRule extends ValidationRule {
+    type: VALIDATION_TYPE.UNIQUENESS;
+    weight: number;
+}
+export interface patternValidationRule extends ValidationRule {
+    type: VALIDATION_TYPE.PATTERN;
+    pattern: string;
+    weight: number;
+}
+export interface ValidationTemplateDTO extends GOVERNANCE_MODEL_DTO {
+    name: string;
+    description?: string;
+    validationRules: ValidationRule[];
+}
+declare class ValidationTemplate extends GOVERNANCE_MODEL {
+    private Name;
+    private Description;
+    private ValidationRules;
+    static configureAPIURL(url: string): void;
+    toDTO(): ValidationTemplateDTO;
+    populateFromFormData(data: any): Promise<void>;
+    populateFromDTO(dto: GOVERNANCE_MODEL_DTO): Promise<void>;
+    static listDBRecords(pageNumber?: number, pageSize?: number, sortOrder?: SortOrder, vocabularyID?: IDType): Promise<PaginatedResponse<ValidationTemplate>>;
+    get name(): string;
+    set name(value: string);
+    get description(): string;
+    set description(value: string);
+    get validationRules(): ValidationRule[];
+    set validationRules(value: ValidationRule[]);
+    static parseValidationRules(rawRules: any[]): ValidationRule[];
+    private ensureValidationRulesInitialized;
+    createRule(type: VALIDATION_TYPE): ValidationRule;
+    deleteRuleAt(index: number): void;
+    deleteRuleByTypeAt(type: VALIDATION_TYPE, index: number): void;
+    static groupValidationRulesByColumn(rules: ValidationRule[]): Record<string, ValidationRule[]>;
+    static groupValidationRulesByType(rules: ValidationRule[]): Record<VALIDATION_TYPE, ValidationRule[]>;
+    /**
+     * Parse escaped JSON string containing validation_rules to ValidationRule[]
+     * @param escapedString - Escaped JSON string like "validation_rules\":[{\"column\":\"class_label\",...}]"
+     * @returns Parsed ValidationRule array
+     */
+    static parseValidationRulesFromEscapedString(escapedString: string): ValidationRule[];
+    /**
+     * Convert ValidationRule[] to escaped JSON string
+     * @param rules - ValidationRule array to stringify
+     * @returns Escaped JSON string with format: "{\"validation_rules\":[...]}"
+     */
+    static stringifyValidationRulesToEscapedString(rules: ValidationRule[]): string;
+}
+export default ValidationTemplate;

package/dist/__tests__/SODAS_SDK_CLASS/DCAT/dataService/userL.medium.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/__tests__/SODAS_SDK_CLASS/DCAT/dataset/rdf.medium.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/__tests__/SODAS_SDK_CLASS/DCAT/dataset/userL.medium.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/__tests__/SODAS_SDK_CLASS/DCAT/datasetSeries/rdf.medium.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/__tests__/SODAS_SDK_CLASS/DCAT/datasetSeries/userL.medium.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/__tests__/SODAS_SDK_CLASS/template/validation/CRUD.medium.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/__tests__/SODAS_SDK_CLASS/template/validation/LIST.big.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/__tests__/SODAS_SDK_CLASS/template/validation/escape.small.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/__tests__/SODAS_SDK_CLASS/template/validation/group.small.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/__tests__/SODAS_SDK_CLASS/template/validation/manageRules.small.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/__tests__/SODAS_SDK_CLASS/template/validation/parse.small.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/__tests__/utility/validation.d.ts

@@ -0,0 +1,6 @@
+import ValidationTemplate, { ValidationTemplateDTO } from "../../SODAS_SDK_CLASS/template/validation";
+export declare function getTestCreateValidationTemplateDTO(index?: number, name?: string): ValidationTemplateDTO;
+export declare function getTestUpdateValidationTemplateDTO(updating: ValidationTemplate, index?: number): ValidationTemplateDTO;
+export declare function createTestValidationTemplate(index?: number, name?: string): Promise<ValidationTemplate>;
+export declare function createNumberOfTestValidationTemplates(number?: number, name?: string): Promise<ValidationTemplate[]>;
+export declare function deleteAllValidationTemplates(): Promise<void>;