sodas-sdk 1.0.0 → 1.1.11
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.
- package/dist/SODAS_SDK_CLASS/DCAT/dcatResource.d.ts +6 -13
- package/dist/SODAS_SDK_CLASS/dcatClass.d.ts +1 -0
- package/dist/SODAS_SDK_FILE/sodasSDKFile.d.ts +1 -0
- package/dist/__tests__/core/auth.medium.test.d.ts +1 -0
- package/dist/__tests__/setting/testEnvironmentConfig.d.ts +2 -3
- package/dist/core/auth.d.ts +47 -0
- package/dist/core/error.d.ts +1 -18
- package/dist/core/init.d.ts +2 -14
- package/dist/core/type.d.ts +1 -1
- package/dist/index.browser.js +1367 -4805
- package/dist/index.browser.js.map +1 -1
- package/dist/index.d.ts +8 -35
- package/dist/index.legacy.browser.js +1377 -4826
- package/dist/index.legacy.browser.js.map +1 -1
- package/dist/index.legacy.node.cjs +1374 -4812
- package/dist/index.legacy.node.cjs.map +1 -1
- package/dist/index.node.js +1364 -4802
- package/dist/index.node.js.map +1 -1
- package/package.json +3 -3
- package/dist/SODAS_SDK_CLASS/PROF/options.d.ts +0 -98
- package/dist/SODAS_SDK_CLASS/PROF/profile.d.ts +0 -74
- package/dist/SODAS_SDK_CLASS/PROF/resourceDescriptor.d.ts +0 -83
- package/dist/SODAS_SDK_CLASS/SODAS/template.d.ts +0 -56
- package/dist/SODAS_SDK_CLASS/SODAS/templateArtifact.d.ts +0 -36
- package/dist/SODAS_SDK_CLASS/SODAS/templateDetail.d.ts +0 -42
- package/dist/__tests__/SODAS_SDK_CLASS/DCAT/profile.small.test.d.ts +0 -1
- package/dist/__tests__/SODAS_SDK_CLASS/PROF/functionality/ai_mappping.test.d.ts +0 -1
- package/dist/__tests__/SODAS_SDK_CLASS/PROF/functionality/common.test.d.ts +0 -1
- package/dist/__tests__/SODAS_SDK_CLASS/PROF/functionality/constraint.test.d.ts +0 -1
- package/dist/__tests__/SODAS_SDK_CLASS/PROF/functionality/example.test.d.ts +0 -1
- package/dist/__tests__/SODAS_SDK_CLASS/PROF/functionality/mapping.test.d.ts +0 -1
- package/dist/__tests__/SODAS_SDK_CLASS/PROF/functionality/schema.test.d.ts +0 -1
- package/dist/__tests__/SODAS_SDK_CLASS/PROF/functionality/schema.utiliity.d.ts +0 -6
- package/dist/__tests__/SODAS_SDK_CLASS/PROF/functionality/specification.test.d.ts +0 -1
- package/dist/__tests__/SODAS_SDK_CLASS/PROF/functionality/staticOptions.test.d.ts +0 -1
- package/dist/__tests__/SODAS_SDK_CLASS/PROF/functionality/type.test.d.ts +0 -1
- package/dist/__tests__/SODAS_SDK_CLASS/PROF/functionality/type.utility.d.ts +0 -8
- package/dist/__tests__/SODAS_SDK_CLASS/PROF/functionality/validation.test.d.ts +0 -1
- package/dist/__tests__/SODAS_SDK_CLASS/PROF/functionality/vocabulary.test.d.ts +0 -1
- package/dist/__tests__/SODAS_SDK_CLASS/PROF/profile/CRUD.medium.test.d.ts +0 -1
- package/dist/__tests__/SODAS_SDK_CLASS/PROF/profile/LIST.big.test.d.ts +0 -1
- package/dist/__tests__/SODAS_SDK_CLASS/PROF/profile/deleteAssociated.medium.test.d.ts +0 -1
- package/dist/__tests__/SODAS_SDK_CLASS/PROF/profile/extended.small.test.d.ts +0 -2
- package/dist/__tests__/SODAS_SDK_CLASS/PROF/profile/small.test.d.ts +0 -1
- package/dist/__tests__/SODAS_SDK_CLASS/PROF/profile/updateWithResourceDescriptor.medium.test.d.ts +0 -1
- package/dist/__tests__/SODAS_SDK_CLASS/PROF/profile/withResourceDescriptor.medium.test.d.ts +0 -1
- package/dist/__tests__/SODAS_SDK_CLASS/PROF/resourceDescriptor/CRUD.medium.test.d.ts +0 -1
- package/dist/__tests__/SODAS_SDK_CLASS/PROF/resourceDescriptor/LIST.big.test.d.ts +0 -1
- package/dist/__tests__/SODAS_SDK_CLASS/PROF/resourceDescriptor/deleteAssociated.medium.test.d.ts +0 -1
- package/dist/__tests__/SODAS_SDK_CLASS/PROF/resourceDescriptor/extended.small.test.d.ts +0 -2
- package/dist/__tests__/SODAS_SDK_CLASS/PROF/resourceDescriptor/small.test.d.ts +0 -1
- package/dist/__tests__/SODAS_SDK_CLASS/PROF/resourceDescriptor/updateWithFileArtifact.medium.test.d.ts +0 -1
- package/dist/__tests__/SODAS_SDK_CLASS/PROF/resourceDescriptor/updateWithTemplateArtifact.medium.test.d.ts +0 -1
- package/dist/__tests__/SODAS_SDK_CLASS/PROF/resourceDescriptor/withFileArtifact.CRD.medium.test.d.ts +0 -1
- package/dist/__tests__/SODAS_SDK_CLASS/PROF/resourceDescriptor/withTemplateArtifact.CRD.medium.test.d.ts +0 -1
- package/dist/__tests__/SODAS_SDK_CLASS/SODAS/template/CRUD.medium.test.d.ts +0 -1
- package/dist/__tests__/SODAS_SDK_CLASS/SODAS/template/LIST.big.test.d.ts +0 -1
- package/dist/__tests__/SODAS_SDK_CLASS/SODAS/template/defaultTemplate.medium.test.d.ts +0 -1
- package/dist/__tests__/SODAS_SDK_CLASS/SODAS/template/deleteAssociated.medium.test.d.ts +0 -1
- package/dist/__tests__/SODAS_SDK_CLASS/SODAS/template/small.test.d.ts +0 -1
- package/dist/__tests__/SODAS_SDK_CLASS/SODAS/template/updateWithDetail.medium.test.d.ts +0 -1
- package/dist/__tests__/SODAS_SDK_CLASS/SODAS/template/withDetail.medium.test.d.ts +0 -1
- package/dist/__tests__/SODAS_SDK_CLASS/SODAS/templateArtifact/CRUD.medium.test.d.ts +0 -1
- package/dist/__tests__/SODAS_SDK_CLASS/SODAS/templateArtifact/LIST.big.test.d.ts +0 -1
- package/dist/__tests__/SODAS_SDK_CLASS/SODAS/templateArtifact/deleteAssociated.medium.test.d.ts +0 -1
- package/dist/__tests__/SODAS_SDK_CLASS/SODAS/templateArtifact/small.test.d.ts +0 -1
- package/dist/__tests__/SODAS_SDK_CLASS/SODAS/templateDetail/CRUD.medium.test.d.ts +0 -1
- package/dist/__tests__/SODAS_SDK_CLASS/SODAS/templateDetail/LIST.big.test.d.ts +0 -1
- package/dist/__tests__/SODAS_SDK_CLASS/SODAS/templateDetail/small.test.d.ts +0 -1
- package/dist/__tests__/utility/profile.d.ts +0 -12
- package/dist/__tests__/utility/resourceDescriptor.d.ts +0 -15
- package/dist/__tests__/utility/template.d.ts +0 -9
- package/dist/__tests__/utility/templateArtifact.d.ts +0 -11
- package/dist/__tests__/utility/templateDetail.d.ts +0 -8
- package/dist/utility/createDefaultTemplates.d.ts +0 -2
- package/dist/utility/defaultTemplates/constraint.d.ts +0 -14
- package/dist/utility/defaultTemplates/example.d.ts +0 -9
- package/dist/utility/defaultTemplates/mapping.d.ts +0 -9
- package/dist/utility/defaultTemplates/schema.d.ts +0 -28
- package/dist/utility/defaultTemplates/specification.d.ts +0 -8
- package/dist/utility/defaultTemplates/type.d.ts +0 -9
- package/dist/utility/defaultTemplates/validation.d.ts +0 -8
- package/dist/utility/defaultTemplates/vocabulary.d.ts +0 -11
|
@@ -1,7 +1,6 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { ExtraMetadataType, MultiLanguageField, MultiLanguageKeywords } from "../../core/type";
|
|
2
2
|
import ThumbnailFile from "../../SODAS_SDK_FILE/thumbnailFile";
|
|
3
3
|
import DCAT_MODEL, { DCAT_MODEL_DTO } from "../dcatClass";
|
|
4
|
-
import Profile from "../PROF/profile";
|
|
5
4
|
import VersionInfo, { VersionInfoDTO } from "./versionInfo";
|
|
6
5
|
export interface DCAT_RESOURCE_DTO extends DCAT_MODEL_DTO {
|
|
7
6
|
ResourceType?: string;
|
|
@@ -32,8 +31,7 @@ export interface DCAT_RESOURCE_DTO extends DCAT_MODEL_DTO {
|
|
|
32
31
|
Type?: string;
|
|
33
32
|
HasPolicy?: any[];
|
|
34
33
|
IssuerID?: string;
|
|
35
|
-
|
|
36
|
-
InstanceValue?: InstanceValueType;
|
|
34
|
+
ExtraMetadata?: ExtraMetadataType;
|
|
37
35
|
VersionInfo?: VersionInfoDTO[];
|
|
38
36
|
}
|
|
39
37
|
declare abstract class DCAT_RESOURCE extends DCAT_MODEL {
|
|
@@ -66,8 +64,7 @@ declare abstract class DCAT_RESOURCE extends DCAT_MODEL {
|
|
|
66
64
|
private Type;
|
|
67
65
|
private HasPolicy;
|
|
68
66
|
private IssuerID;
|
|
69
|
-
private
|
|
70
|
-
private InstanceValue;
|
|
67
|
+
private ExtraMetadata;
|
|
71
68
|
private VersionInfos;
|
|
72
69
|
toDTO(): DCAT_RESOURCE_DTO;
|
|
73
70
|
populateFromDTO(dto: DCAT_MODEL_DTO): Promise<void>;
|
|
@@ -76,13 +73,13 @@ declare abstract class DCAT_RESOURCE extends DCAT_MODEL {
|
|
|
76
73
|
updateDBRecord(): Promise<void>;
|
|
77
74
|
setThumbnailForBrowser(file: File): void;
|
|
78
75
|
setThumbnailForNode(thumbnailPath: string): void;
|
|
76
|
+
get assetID(): string;
|
|
79
77
|
get versionInfos(): VersionInfo[];
|
|
80
78
|
get isVersionOf(): string;
|
|
81
79
|
get previousVersionID(): string;
|
|
82
80
|
get nextVersionID(): string;
|
|
83
81
|
set previousVersion(previousVersion: DCAT_RESOURCE);
|
|
84
82
|
get resourceType(): string;
|
|
85
|
-
get assetID(): string;
|
|
86
83
|
get datahubID(): string;
|
|
87
84
|
get thumbnailURL(): string;
|
|
88
85
|
get accessRights(): string;
|
|
@@ -118,12 +115,8 @@ declare abstract class DCAT_RESOURCE extends DCAT_MODEL {
|
|
|
118
115
|
set hasPolicy(value: any[]);
|
|
119
116
|
get issuerID(): string;
|
|
120
117
|
set issuerID(value: string);
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
getDATAProfile(): Promise<Profile | null>;
|
|
124
|
-
setDATAProfile(profile: Profile): void;
|
|
125
|
-
setInstanceValue(name: string, value: string): void;
|
|
126
|
-
getInstanceValue(name: string): string | undefined;
|
|
118
|
+
setExtraMetadata(name: string, value: string): void;
|
|
119
|
+
getExtraMetadata(name: string): string | undefined;
|
|
127
120
|
getTitle(languageCode?: string): string;
|
|
128
121
|
setTitle(title: string, languageCode?: string): void;
|
|
129
122
|
removeTitle(languageCode?: string): void;
|
|
@@ -22,6 +22,7 @@ declare abstract class DCAT_MODEL extends SODAS_SDK_CLASS {
|
|
|
22
22
|
static getAllDBRecords<GENERIC_DCAT_MODEL extends DCAT_MODEL>(this: DCAT_MODEL_STATIC<GENERIC_DCAT_MODEL>): Promise<GENERIC_DCAT_MODEL[]>;
|
|
23
23
|
createDBRecord(): Promise<void>;
|
|
24
24
|
static getDBRecord<GENERIC_DCAT_MODEL extends DCAT_MODEL>(this: DCAT_MODEL_STATIC<GENERIC_DCAT_MODEL>, ID: IDType): Promise<GENERIC_DCAT_MODEL>;
|
|
25
|
+
static getDBRecordByAssetID<GENERIC_DCAT_MODEL extends DCAT_MODEL>(this: DCAT_MODEL_STATIC<GENERIC_DCAT_MODEL>, assetID: IDType): Promise<GENERIC_DCAT_MODEL>;
|
|
25
26
|
updateDBRecord(): Promise<void>;
|
|
26
27
|
deleteDBRecord(): Promise<void>;
|
|
27
28
|
get createdAt(): Date;
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
import "../setting/testEnvironmentConfig";
|
|
@@ -1,5 +1,4 @@
|
|
|
1
|
-
export declare const
|
|
1
|
+
export declare const TEST_SODAS_PROFILE_API_URL: string;
|
|
2
2
|
export declare const TEST_GOVERNANCE_API_URL: string;
|
|
3
|
-
export declare const
|
|
4
|
-
export declare function getAccessToken(): Promise<string>;
|
|
3
|
+
export declare const TEST_LEGACY_DATAHUB_API_URL: string;
|
|
5
4
|
export declare function setBearerTokenForTest(): Promise<void>;
|
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
declare class Config {
|
|
2
|
+
private static instance;
|
|
3
|
+
private governanceToken;
|
|
4
|
+
private legacyDatahubToken;
|
|
5
|
+
private governanceBaseUrl;
|
|
6
|
+
private sodasProfileBaseUrl;
|
|
7
|
+
private legacyDatahubBaseUrl;
|
|
8
|
+
private constructor();
|
|
9
|
+
/**
|
|
10
|
+
* Explicitly configure the SDK with the given API URLs.
|
|
11
|
+
* This is the preferred way to set API URLs instead of using configureAPIURL.
|
|
12
|
+
*/
|
|
13
|
+
static configure(datahubApiUrl: string, governanceApiUrl: string, legacyDatahubApiUrl: string): Config;
|
|
14
|
+
/**
|
|
15
|
+
* Get the singleton instance of Config, using environment variables.
|
|
16
|
+
*/
|
|
17
|
+
static getInstance(): Config;
|
|
18
|
+
/**
|
|
19
|
+
* Initialize all SDK class API URLs based on the configured base URLs.
|
|
20
|
+
*/
|
|
21
|
+
private initializeAPIURLs;
|
|
22
|
+
/**
|
|
23
|
+
* Login to the Governance portal and store the access token.
|
|
24
|
+
*/
|
|
25
|
+
loginGovernance(id: string, password: string): Promise<void>;
|
|
26
|
+
/**
|
|
27
|
+
* Login to the Datahub portal and store the access token.
|
|
28
|
+
*/
|
|
29
|
+
loginLegacyDatahub(id: string, password: string): Promise<void>;
|
|
30
|
+
/**
|
|
31
|
+
* Logout from the Governance portal and clear the stored token.
|
|
32
|
+
*/
|
|
33
|
+
logoutGovernance(): Promise<void>;
|
|
34
|
+
/**
|
|
35
|
+
* Logout from the Datahub portal and clear the stored token.
|
|
36
|
+
*/
|
|
37
|
+
logoutLegacyDatahub(): Promise<void>;
|
|
38
|
+
/**
|
|
39
|
+
* Get the current Governance access token.
|
|
40
|
+
*/
|
|
41
|
+
getGovernanceToken(): string | null;
|
|
42
|
+
/**
|
|
43
|
+
* Get the current Datahub access token.
|
|
44
|
+
*/
|
|
45
|
+
getLegacyDatahubToken(): string | null;
|
|
46
|
+
}
|
|
47
|
+
export default Config;
|
package/dist/core/error.d.ts
CHANGED
|
@@ -1,7 +1,5 @@
|
|
|
1
|
-
import Profile from "../SODAS_SDK_CLASS/PROF/profile";
|
|
2
|
-
import ResourceDescriptor from "../SODAS_SDK_CLASS/PROF/resourceDescriptor";
|
|
3
1
|
import SODAS_SDK_CLASS from "../SODAS_SDK_CLASS/sodasSDKClass";
|
|
4
|
-
import {
|
|
2
|
+
import { ResourceDescriptorRole } from "./type";
|
|
5
3
|
export declare class AlreadyRecordedError extends Error {
|
|
6
4
|
constructor(instance: SODAS_SDK_CLASS);
|
|
7
5
|
}
|
|
@@ -20,15 +18,9 @@ export declare class InvalidDateObjectError extends Error {
|
|
|
20
18
|
export declare class InvalidDateStringError extends Error {
|
|
21
19
|
constructor(str: string);
|
|
22
20
|
}
|
|
23
|
-
export declare class InvalidTemplateArtifactRow extends Error {
|
|
24
|
-
constructor(index: number, missing_keys: string[], extra_keys: string[]);
|
|
25
|
-
}
|
|
26
21
|
export declare class InvalidTypeError extends Error {
|
|
27
22
|
constructor(value: any, expectedType: string);
|
|
28
23
|
}
|
|
29
|
-
export declare class InvalidProfileTypeError extends Error {
|
|
30
|
-
constructor(profile: Profile, expectedType: ProfileType);
|
|
31
|
-
}
|
|
32
24
|
export declare class InvalidValueError extends Error {
|
|
33
25
|
constructor(value: any);
|
|
34
26
|
}
|
|
@@ -38,9 +30,6 @@ export declare class NamedTermNotExistError extends Error {
|
|
|
38
30
|
export declare class NeedToImplementError extends Error {
|
|
39
31
|
constructor();
|
|
40
32
|
}
|
|
41
|
-
export declare class NeedToSetTemplateError extends Error {
|
|
42
|
-
constructor();
|
|
43
|
-
}
|
|
44
33
|
export declare class NeedToSetFieldError extends Error {
|
|
45
34
|
constructor(value: any, field: string);
|
|
46
35
|
}
|
|
@@ -56,9 +45,6 @@ export declare class NotRecordedArgumentError extends Error {
|
|
|
56
45
|
export declare class NotRecordedYetError extends Error {
|
|
57
46
|
constructor(instance: SODAS_SDK_CLASS);
|
|
58
47
|
}
|
|
59
|
-
export declare class NotTemplateBasedResourceDescriptor extends Error {
|
|
60
|
-
constructor(resourceDescriptor: ResourceDescriptor);
|
|
61
|
-
}
|
|
62
48
|
export declare class RecordNotFoundError extends Error {
|
|
63
49
|
constructor();
|
|
64
50
|
}
|
|
@@ -77,9 +63,6 @@ export declare class RetryLimitReachedError extends Error {
|
|
|
77
63
|
export declare class SwitchSameIndexError extends Error {
|
|
78
64
|
constructor(index: number);
|
|
79
65
|
}
|
|
80
|
-
export declare class TemplateDetailFunctionalityAlreadyExist extends Error {
|
|
81
|
-
constructor(functionlaty: TemplateDetailFunctionality);
|
|
82
|
-
}
|
|
83
66
|
export declare class UnexpectedResponseFormatError extends Error {
|
|
84
67
|
constructor(response: any);
|
|
85
68
|
}
|
package/dist/core/init.d.ts
CHANGED
|
@@ -1,20 +1,8 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Initializes API URLs for various DTO classes by removing trailing slashes
|
|
3
|
-
* and setting them as base URLs for API interactions.
|
|
4
|
-
*
|
|
5
|
-
* @param {string} DATAHUB_API_URL - The base API URL for the DataHub services.
|
|
6
|
-
* @param {string} GOVERNANCE_PORTAL_API_URL - The base API URL for the Governance Portal services.
|
|
7
|
-
* @returns {void}
|
|
8
|
-
*/
|
|
9
|
-
export declare let QUALITY_API_URL: string;
|
|
10
|
-
export declare function configureSDKAPIURL(url: string): void;
|
|
11
|
-
export declare function configureGovernanceAPIURL(GOVERNANCE_PORTAL_API_URL: string): void;
|
|
12
|
-
export declare function configureDatahubAPIURL(DATAHUB_API_URL: string): void;
|
|
13
|
-
export declare function configureAPIURL(DATAHUB_API_URL: string, GOVERNANCE_PORTAL_API_URL: string): void;
|
|
14
1
|
/**
|
|
15
2
|
* Sets the Bearer token for API authentication across multiple DTO classes.
|
|
16
3
|
*
|
|
17
4
|
* @param {string} token - The Bearer token used for API authentication.
|
|
18
5
|
* @returns {void}
|
|
19
6
|
*/
|
|
20
|
-
export declare function
|
|
7
|
+
export declare function setGovernanceBearerToken(token: string): void;
|
|
8
|
+
export declare function setLegacyDatahubBearerToken(token: string): void;
|
package/dist/core/type.d.ts
CHANGED
|
@@ -45,7 +45,7 @@ export type MultiLanguageField = {
|
|
|
45
45
|
export type MultiLanguageKeywords = {
|
|
46
46
|
[languageCode: string]: string[];
|
|
47
47
|
};
|
|
48
|
-
export type
|
|
48
|
+
export type ExtraMetadataType = {
|
|
49
49
|
[MetaFieldName: string]: string;
|
|
50
50
|
};
|
|
51
51
|
export declare enum ResourceDescriptorRole {
|