sodas-sdk 1.0.0

package/dist/core/type.d.ts

@@ -0,0 +1,95 @@
+export type IDType = string & {
+    __iriBrand: never;
+};
+export declare function asID(value: string): IDType;
+export declare function asIDs(values: string[]): IDType[];
+export type IRIType = string & {
+    __iriBrand: never;
+};
+export declare function asIRI(value: string): IRIType;
+/**
+ * Branded type for a valid ISO 8601 date-time string.
+ * Example: "2025-01-08T09:04:51.008Z" or "2025-01-08T18:10:01.292602+09:00"
+ */
+export type DateString = string & {
+    __iriBrand: never;
+};
+/**
+ * Converts a Date object to a DateString (ISO 8601 format).
+ *
+ * @param {Date} date - The Date object to convert.
+ * @returns {DateString} - The validated ISO 8601 date-time string.
+ * @throws {Error} - Throws an error if the Date object is invalid.
+ */
+export declare function toDateString(date: Date | null): DateString;
+/**
+ * Converts a DateString to a JavaScript Date object.
+ *
+ * @param {DateString} dateString - The ISO 8601 date-time string to convert.
+ * @returns {Date} - The corresponding JavaScript Date object.
+ */
+export declare function toDate(dateString: DateString): Date;
+export type TemplateArtifactRow = {
+    [K in TemplateDetailFunctionality]?: any;
+};
+export type TemplateArtifactValue = Array<TemplateArtifactRow>;
+/**
+ * Represents a multilingual field where each key is a language code (e.g., "en", "ko") and the value is a string.
+ */
+export type MultiLanguageField = {
+    [languageCode: string]: string;
+};
+/**
+ * Represents multilingual keywords where each key is a language code and the value is an array of strings.
+ */
+export type MultiLanguageKeywords = {
+    [languageCode: string]: string[];
+};
+export type InstanceValueType = {
+    [MetaFieldName: string]: string;
+};
+export declare enum ResourceDescriptorRole {
+    VOCABULARY = "vocabulary",
+    TYPE = "type",
+    SCHEMA = "schema",
+    CONSTRAINT = "constraint",
+    VALIDATION = "validation",
+    MAPPING = "mapping",
+    EXAMPLE = "example",
+    SPECIFICATION = "specification",
+    GUIDANCE = "guidance"
+}
+export declare enum ProfileType {
+    DCAT = "dcat",
+    DATA = "data"
+}
+export declare enum ArtifactType {
+    TEMPLATE = "template",
+    FILE = "file"
+}
+export declare enum TemplateDetailFunctionality {
+    ORIGIN = "origin",
+    NAMESPACE = "namespaceIRI",
+    TERM = "term",
+    DESCRIPTION = "description",//EXAMPLE and SCHEMA ALSO
+    NAME = "name",//SCHEMA ALSO
+    LABEL = "label",
+    VALUE = "value",//EXAMPLE ALSO
+    TYPE = "type",//CONSTRAINT ALSO
+    REQUIRED = "required",//CONSTRAINT ALSO
+    FIELD_TERM = "fieldTerm",
+    FIELD = "field",//EXAMPLE and MAPPING ALSO
+    REGEX = "regex",
+    MEASURE = "measure",
+    TARGET_PROFILE = "targetProfile",
+    TARGET_FIELD = "targetField",
+    CONVERSION = "conversion"
+}
+export type PaginatedResponse<GENERIC_SODAS_SDK_CLASS> = {
+    total: number;
+    list: GENERIC_SODAS_SDK_CLASS[];
+};
+export declare enum SortOrder {
+    ASC = "ASC",
+    DESC = "DESC"
+}

package/dist/core/util.d.ts

@@ -0,0 +1,58 @@
+import { AxiosError, AxiosResponse } from "axios";
+/**
+ * Enumeration to differentiate between `ID` and `IRI`.
+ *
+ * @enum {string}
+ */
+/**
+ * Handles errors by logging the details and re-throwing the error.
+ *
+ * @param {any} error - The error object to handle.
+ * @throws {any} - Re-throws the provided error after logging it.
+ */
+export declare function handleError(error: any): never;
+export declare function handleAxiosError(error: AxiosError): never;
+/**
+ * Removes all properties from an object, effectively making it empty.
+ *
+ * This function deletes all own properties of the provided object,
+ * and remove the prototype also.
+ * leaving the object in an unusable state.
+ *
+ * @param {object} obj - The object whose properties will be deleted.
+ * @returns {void}
+ *
+ * @example
+ * const obj = { id: 123, name: "Test" };
+ * destroy(obj);
+ * console.log(obj); // Output: {}
+ */
+export declare function destroy(obj: any): void;
+/**
+ * Creates a deep copy of the given instance, preserving the prototype chain and handling nested objects.
+ *
+ * This function recursively copies all properties of the instance, ensuring that nested objects
+ * and arrays are also deeply copied. The returned object retains the same prototype as the original instance.
+ *
+ * @template T - The type of the instance to be copied.
+ * @param {T} instance - The instance to be deeply copied.
+ * @returns {T} A new instance that is a deep copy of the original, with the same prototype.
+ */
+export declare function deepCopy<T>(instance: T): T;
+export declare const LARGE_ENOUGH_NUMBER = 10000;
+interface RetryResponse {
+    errorCode: string;
+    flag: string;
+    [key: string]: any;
+}
+/**
+ * A function to repeatedly try an Axios request until the response meets specific criteria.
+ * @param requestFn - A function that executes an Axios request and returns a response.
+ * @param maxRetries - Maximum number of retries before giving up.
+ * @param delayMs - Delay between retries in milliseconds.
+ * @returns The Axios response that meets the criteria.
+ * @throws Error if the maximum number of retries is reached or if an error occurs.
+ */
+export declare function retryRequest<GENERIC_RETRY_RESPONSE extends RetryResponse>(requestFn: () => Promise<AxiosResponse<GENERIC_RETRY_RESPONSE>>, maxRetries?: number, delayMs?: number): Promise<AxiosResponse<GENERIC_RETRY_RESPONSE>>;
+export declare function sleep(ms: number): Promise<void>;
+export {};

package/dist/core/values.d.ts

@@ -0,0 +1,24 @@
+export declare enum ORIGIN_VALUES {
+    EXISTING = "existing",
+    APPENDING = "appending"
+}
+export declare enum BASIC_TYPE_VALUES {
+    DATE = "date",
+    CELCIUS = "celcius",
+    FAHRENT = "fahrent",
+    mph = "mph",
+    MPS = "mps",
+    inHg = "inHg",
+    hPa = "hPa",
+    in = "in",
+    mm = "mm",
+    microgram = "microgram"
+}
+export declare enum MEASURE_VALUES {
+    CONSTRAINT = "constraint",
+    YDATA = "y-data"
+}
+export declare enum CONVERSION_VALUES {
+    HTML = "html",
+    PDF = "pdf"
+}