@dizmo/dcs-client-library 4.0.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.
- package/LICENSE +13 -0
- package/README.md +67 -0
- package/dist/data/errorTypes/errorTypes.de.d.ts +3 -0
- package/dist/data/errorTypes/errorTypes.de.js +20 -0
- package/dist/data/errorTypes/errorTypes.en.d.ts +3 -0
- package/dist/data/errorTypes/errorTypes.en.js +20 -0
- package/dist/data/errorTypes/errorTypes.es.d.ts +3 -0
- package/dist/data/errorTypes/errorTypes.es.js +4 -0
- package/dist/data/errorTypes/errorTypes.fr.d.ts +3 -0
- package/dist/data/errorTypes/errorTypes.fr.js +4 -0
- package/dist/data/errorTypes/errorTypes.it.d.ts +3 -0
- package/dist/data/errorTypes/errorTypes.it.js +4 -0
- package/dist/data/errorTypes.dev.d.ts +3 -0
- package/dist/data/errorTypes.dev.js +71 -0
- package/dist/helper/api.d.ts +2 -0
- package/dist/helper/api.js +25 -0
- package/dist/helper/httpHelper.d.ts +32 -0
- package/dist/helper/httpHelper.js +145 -0
- package/dist/helper/language.d.ts +5 -0
- package/dist/helper/language.js +69 -0
- package/dist/helper/parse.d.ts +8 -0
- package/dist/helper/parse.js +28 -0
- package/dist/helper/token.d.ts +1 -0
- package/dist/helper/token.js +28 -0
- package/dist/helper/transform.d.ts +3 -0
- package/dist/helper/transform.js +18 -0
- package/dist/helper/validate.d.ts +4 -0
- package/dist/helper/validate.js +21 -0
- package/dist/index.d.ts +11 -0
- package/dist/index.js +15 -0
- package/dist/modules/allocations.d.ts +29 -0
- package/dist/modules/allocations.js +148 -0
- package/dist/modules/analytics.d.ts +7 -0
- package/dist/modules/analytics.js +33 -0
- package/dist/modules/configurator.d.ts +8 -0
- package/dist/modules/configurator.js +10 -0
- package/dist/modules/dcs.d.ts +32 -0
- package/dist/modules/dcs.js +130 -0
- package/dist/modules/events.d.ts +5 -0
- package/dist/modules/events.js +10 -0
- package/dist/modules/items.d.ts +21 -0
- package/dist/modules/items.js +70 -0
- package/dist/modules/language.d.ts +18 -0
- package/dist/modules/language.js +106 -0
- package/dist/modules/needs.d.ts +12 -0
- package/dist/modules/needs.js +35 -0
- package/dist/modules/packages.d.ts +16 -0
- package/dist/modules/packages.js +71 -0
- package/dist/modules/templates.d.ts +19 -0
- package/dist/modules/templates.js +64 -0
- package/dist/modules/translations.d.ts +6 -0
- package/dist/modules/translations.js +17 -0
- package/dist/types/types.d.ts +589 -0
- package/dist/types/types.js +1 -0
- package/package.json +24 -0
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
import { CreateNeed, Need, UpdateNeed, UpdateResult } from "../types/types";
|
|
2
|
+
declare function createNeed(need: CreateNeed): Promise<UpdateResult>;
|
|
3
|
+
declare function deleteNeed(needId: string): Promise<void>;
|
|
4
|
+
declare function updateNeed(needId: string, needUpdate: UpdateNeed): Promise<void>;
|
|
5
|
+
declare function getNeeds(type: string): Promise<Need[]>;
|
|
6
|
+
export declare const needs: {
|
|
7
|
+
createNeed: typeof createNeed;
|
|
8
|
+
deleteNeed: typeof deleteNeed;
|
|
9
|
+
updateNeed: typeof updateNeed;
|
|
10
|
+
getNeeds: typeof getNeeds;
|
|
11
|
+
};
|
|
12
|
+
export {};
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
import { getData, getRequestOptions } from "../helper/httpHelper";
|
|
2
|
+
import { getToken } from "../helper/token";
|
|
3
|
+
import { validateObject, validateString } from "../helper/validate";
|
|
4
|
+
async function createNeed(need) {
|
|
5
|
+
validateObject(need, "Function: createNeed, Value: need");
|
|
6
|
+
const token = await getToken();
|
|
7
|
+
const requestOptions = getRequestOptions("POST", token, need);
|
|
8
|
+
return (await getData(`/needs/need/`, requestOptions));
|
|
9
|
+
}
|
|
10
|
+
async function deleteNeed(needId) {
|
|
11
|
+
validateString(needId, "Function: deleteNeed, Value: needId");
|
|
12
|
+
const token = await getToken();
|
|
13
|
+
const requestOptions = getRequestOptions("DELETE", token);
|
|
14
|
+
await getData(`/needs/need/${needId}`, requestOptions);
|
|
15
|
+
}
|
|
16
|
+
async function updateNeed(needId, needUpdate) {
|
|
17
|
+
validateString(needId, "Function: updateNeed, Value: needId");
|
|
18
|
+
validateObject(needUpdate, "Function: updateNeed, Value: needUpdate");
|
|
19
|
+
const token = await getToken();
|
|
20
|
+
const requestOptions = getRequestOptions("PUT", token, needUpdate);
|
|
21
|
+
await getData(`/needs/need/${needId}`, requestOptions);
|
|
22
|
+
}
|
|
23
|
+
async function getNeeds(type) {
|
|
24
|
+
validateString(type, "Function: getNeeds, Value: type");
|
|
25
|
+
const token = await getToken();
|
|
26
|
+
const body = { type };
|
|
27
|
+
const requestOptions = getRequestOptions("POST", token, body);
|
|
28
|
+
return (await getData(`/needs/getneeds`, requestOptions));
|
|
29
|
+
}
|
|
30
|
+
export const needs = {
|
|
31
|
+
createNeed,
|
|
32
|
+
deleteNeed,
|
|
33
|
+
updateNeed,
|
|
34
|
+
getNeeds
|
|
35
|
+
};
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
import { BulkOperationResult, CreatePackage, PackageFilter, PackageResult, PackagesResult, UpdatePackage, UpdateResult } from "../types/types.js";
|
|
2
|
+
declare function getPackage(packageId: string): Promise<PackageResult>;
|
|
3
|
+
declare function getPackages(packageFilter: PackageFilter): Promise<PackagesResult[]>;
|
|
4
|
+
declare function updatePackage(packageId: string, packageInfo: UpdatePackage): Promise<UpdateResult>;
|
|
5
|
+
declare function deletePackage(packageId: string): Promise<UpdateResult>;
|
|
6
|
+
declare function createPackage(packageInfo: CreatePackage): Promise<PackageResult>;
|
|
7
|
+
declare function instantiatePackage(packageId: string, rootItemId: string, startTimestamp: number, allocName?: boolean): Promise<BulkOperationResult>;
|
|
8
|
+
export declare const packages: {
|
|
9
|
+
getPackage: typeof getPackage;
|
|
10
|
+
getPackages: typeof getPackages;
|
|
11
|
+
updatePackage: typeof updatePackage;
|
|
12
|
+
deletePackage: typeof deletePackage;
|
|
13
|
+
createPackage: typeof createPackage;
|
|
14
|
+
instantiatePackage: typeof instantiatePackage;
|
|
15
|
+
};
|
|
16
|
+
export {};
|
|
@@ -0,0 +1,71 @@
|
|
|
1
|
+
import { getToken } from "../helper/token.js";
|
|
2
|
+
import { getRequestOptions, getData } from "../helper/httpHelper.js";
|
|
3
|
+
import { validateString, validateObject, validateNumber, } from "../helper/validate.js";
|
|
4
|
+
import { bulkOperation } from "./allocations.js";
|
|
5
|
+
async function getPackage(packageId) {
|
|
6
|
+
validateString(packageId, "Function: getPackage, Value: packageId");
|
|
7
|
+
const token = await getToken();
|
|
8
|
+
const requestOptions = getRequestOptions("GET", token);
|
|
9
|
+
return (await getData(`/packages/package/${packageId}`, requestOptions));
|
|
10
|
+
}
|
|
11
|
+
async function getPackages(packageFilter) {
|
|
12
|
+
validateObject(packageFilter, "Function: getPackages, Value: packageFilter");
|
|
13
|
+
const token = await getToken();
|
|
14
|
+
const requestOptions = getRequestOptions("GET", token);
|
|
15
|
+
const queryParams = new URLSearchParams(packageFilter).toString();
|
|
16
|
+
const url = `/packages/packages${queryParams ? `?${queryParams}` : ""}`;
|
|
17
|
+
return (await getData(url, requestOptions));
|
|
18
|
+
}
|
|
19
|
+
async function updatePackage(packageId, packageInfo) {
|
|
20
|
+
validateString(packageId, "Function: updatePackage, Value: packageId");
|
|
21
|
+
validateObject(packageInfo, "Function: updatePackage, Value: packageInfo");
|
|
22
|
+
const token = await getToken();
|
|
23
|
+
const requestOptions = getRequestOptions("PUT", token, packageInfo);
|
|
24
|
+
return (await getData(`/packages/package/${packageId}`, requestOptions));
|
|
25
|
+
}
|
|
26
|
+
async function deletePackage(packageId) {
|
|
27
|
+
validateString(packageId, "Function: deletePackage, Value: packageId");
|
|
28
|
+
const token = await getToken();
|
|
29
|
+
const requestOptions = getRequestOptions("DELETE", token);
|
|
30
|
+
return (await getData(`/packages/package/${packageId}`, requestOptions));
|
|
31
|
+
}
|
|
32
|
+
async function createPackage(packageInfo) {
|
|
33
|
+
validateObject(packageInfo, "Function: createPackage, Value: packageInfo");
|
|
34
|
+
const token = await getToken();
|
|
35
|
+
const requestOptions = getRequestOptions("POST", token, packageInfo);
|
|
36
|
+
return (await getData(`/packages/package`, requestOptions));
|
|
37
|
+
}
|
|
38
|
+
async function instantiatePackage(packageId, rootItemId, startTimestamp, allocName = true) {
|
|
39
|
+
validateString(packageId, "Function: instantiatePackage, Value: packageId");
|
|
40
|
+
validateString(rootItemId, "Function: instantiatePackage, Value: rootItemId");
|
|
41
|
+
validateNumber(startTimestamp, "Function: instantiatePackage, Value: startTimestamp");
|
|
42
|
+
const packageInfo = await getPackage(packageId);
|
|
43
|
+
const createAllocs = packageInfo.packageAllocations
|
|
44
|
+
.filter((alloc) => alloc.leafData !== undefined)
|
|
45
|
+
.map((alloc) => ({
|
|
46
|
+
item1Id: rootItemId,
|
|
47
|
+
item2Id: alloc.leafId,
|
|
48
|
+
from: startTimestamp + alloc.startOffset,
|
|
49
|
+
to: startTimestamp + alloc.startOffset + alloc.duration,
|
|
50
|
+
name: allocName ? packageInfo.name : "",
|
|
51
|
+
}));
|
|
52
|
+
return await bulkOperation({ create: createAllocs }, {
|
|
53
|
+
type: "package",
|
|
54
|
+
skipUndefined: true,
|
|
55
|
+
retryArguments: {
|
|
56
|
+
packageId,
|
|
57
|
+
rootItemId,
|
|
58
|
+
startTimestamp,
|
|
59
|
+
allocName,
|
|
60
|
+
},
|
|
61
|
+
conflicting_allocations: [],
|
|
62
|
+
});
|
|
63
|
+
}
|
|
64
|
+
export const packages = {
|
|
65
|
+
getPackage,
|
|
66
|
+
getPackages,
|
|
67
|
+
updatePackage,
|
|
68
|
+
deletePackage,
|
|
69
|
+
createPackage,
|
|
70
|
+
instantiatePackage,
|
|
71
|
+
};
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
import { DeleteResult, RawTemplate, TemplateFilter, TemplateInput, TemplateResult } from "../types/types.js";
|
|
2
|
+
declare function getTemplateById(templateId: string): Promise<TemplateResult>;
|
|
3
|
+
declare function getAllTemplates(): Promise<TemplateResult[]>;
|
|
4
|
+
declare function updateTemplate(templateId: string, templateInfo: TemplateInput): Promise<TemplateResult>;
|
|
5
|
+
declare function deleteTemplate(templateId: string): Promise<DeleteResult>;
|
|
6
|
+
declare function createTemplate(templateProperties: TemplateInput): Promise<TemplateResult>;
|
|
7
|
+
/**
|
|
8
|
+
* DEPRECATED: use getTemplateById or getAllTemplates
|
|
9
|
+
*/
|
|
10
|
+
declare function getTemplates(filter?: TemplateFilter): Promise<RawTemplate[]>;
|
|
11
|
+
export declare const templates: {
|
|
12
|
+
getTemplateById: typeof getTemplateById;
|
|
13
|
+
getAllTemplates: typeof getAllTemplates;
|
|
14
|
+
updateTemplate: typeof updateTemplate;
|
|
15
|
+
deleteTemplate: typeof deleteTemplate;
|
|
16
|
+
createTemplate: typeof createTemplate;
|
|
17
|
+
getTemplates: typeof getTemplates;
|
|
18
|
+
};
|
|
19
|
+
export {};
|
|
@@ -0,0 +1,64 @@
|
|
|
1
|
+
import { getToken } from "../helper/token.js";
|
|
2
|
+
import { getRequestOptions, getData } from "../helper/httpHelper.js";
|
|
3
|
+
import { validateString, validateObject } from "../helper/validate.js";
|
|
4
|
+
import parse from "../helper/parse.js";
|
|
5
|
+
async function getTemplateById(templateId) {
|
|
6
|
+
validateString(templateId, "Function: getTemplateById, Value: templateId");
|
|
7
|
+
const token = await getToken();
|
|
8
|
+
const bodyObj = {
|
|
9
|
+
filter: {
|
|
10
|
+
name: templateId,
|
|
11
|
+
},
|
|
12
|
+
};
|
|
13
|
+
const requestOptions = getRequestOptions("POST", token, bodyObj);
|
|
14
|
+
const result = (await getData("/templates/template", requestOptions));
|
|
15
|
+
return parse.template(result);
|
|
16
|
+
}
|
|
17
|
+
async function getAllTemplates() {
|
|
18
|
+
const token = await getToken();
|
|
19
|
+
const bodyObj = {
|
|
20
|
+
filter: {},
|
|
21
|
+
};
|
|
22
|
+
const requestOptions = getRequestOptions("POST", token, bodyObj);
|
|
23
|
+
const result = (await getData("/templates/template", requestOptions));
|
|
24
|
+
return parse.templates(result);
|
|
25
|
+
}
|
|
26
|
+
async function updateTemplate(templateId, templateInfo) {
|
|
27
|
+
validateString(templateId, "Function: updateTemplate, Value: templateId");
|
|
28
|
+
validateObject(templateInfo, "Function: updateTemplate, Value: templateInfo");
|
|
29
|
+
const token = await getToken();
|
|
30
|
+
const requestOptions = getRequestOptions("POST", token, templateInfo);
|
|
31
|
+
return (await getData(`/templates/template/${templateId}`, requestOptions));
|
|
32
|
+
}
|
|
33
|
+
async function deleteTemplate(templateId) {
|
|
34
|
+
validateString(templateId, "Function: deleteTemplate, Value: templateId");
|
|
35
|
+
const token = await getToken();
|
|
36
|
+
const requestOptions = getRequestOptions("DELETE", token);
|
|
37
|
+
return (await getData(`/templates/template/${templateId}`, requestOptions));
|
|
38
|
+
}
|
|
39
|
+
async function createTemplate(templateProperties) {
|
|
40
|
+
validateObject(templateProperties, "Function: createTemplate, Value: templateProperties");
|
|
41
|
+
const token = await getToken();
|
|
42
|
+
const requestOptions = getRequestOptions("POST", token, templateProperties);
|
|
43
|
+
return (await getData(`/templates/create`, requestOptions));
|
|
44
|
+
}
|
|
45
|
+
/**
|
|
46
|
+
* DEPRECATED: use getTemplateById or getAllTemplates
|
|
47
|
+
*/
|
|
48
|
+
async function getTemplates(filter = {}) {
|
|
49
|
+
validateObject(filter, "Function: getTemplates, Value: filter");
|
|
50
|
+
const token = await getToken();
|
|
51
|
+
const bodyObj = {
|
|
52
|
+
filter: filter,
|
|
53
|
+
};
|
|
54
|
+
const requestOptions = getRequestOptions("POST", token, bodyObj);
|
|
55
|
+
return (await getData("/templates/template", requestOptions));
|
|
56
|
+
}
|
|
57
|
+
export const templates = {
|
|
58
|
+
getTemplateById,
|
|
59
|
+
getAllTemplates,
|
|
60
|
+
updateTemplate,
|
|
61
|
+
deleteTemplate,
|
|
62
|
+
createTemplate,
|
|
63
|
+
getTemplates,
|
|
64
|
+
};
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
import { getData, getRequestOptions } from "../helper/httpHelper";
|
|
2
|
+
import { getToken } from "../helper/token";
|
|
3
|
+
import { validateObject } from "../helper/validate";
|
|
4
|
+
async function translate(input) {
|
|
5
|
+
validateObject(input, "Function: translate, Value: input");
|
|
6
|
+
const token = await getToken();
|
|
7
|
+
const requestOptions = getRequestOptions("POST", token, input);
|
|
8
|
+
const response = (await getData(`/translations/translate/`, requestOptions));
|
|
9
|
+
return Array.isArray(response)
|
|
10
|
+
? response.map((elem) => {
|
|
11
|
+
return { text: elem.text, detectedSourceLang: elem.detectedSourceLang };
|
|
12
|
+
})
|
|
13
|
+
: { text: response.text, detectedSourceLang: response.detectedSourceLang };
|
|
14
|
+
}
|
|
15
|
+
export const translations = {
|
|
16
|
+
translate,
|
|
17
|
+
};
|