@uniformdev/tms-sdk 20.48.1-alpha.27 → 20.48.1-alpha.33.sha-eb3f272086
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/index.d.mts +19 -11
- package/dist/index.d.ts +19 -11
- package/dist/index.esm.js +733 -35
- package/dist/index.js +716 -37
- package/dist/index.mjs +733 -35
- package/package.json +12 -9
package/dist/index.d.mts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { ComponentInstance, RootComponentInstance, EntryData,
|
|
1
|
+
import { ComponentInstance, RootComponentInstance, EntryData, CompositionManagementClient, CompositionGetResponse, EntryManagementClient, Entry } from '@uniformdev/canvas';
|
|
2
2
|
import { CanvasEditorEntityType } from '@uniformdev/mesh-sdk';
|
|
3
3
|
|
|
4
4
|
type ComponentTranslationPayload = Pick<ComponentInstance, '_id' | 'type' | 'parameters' | 'slots' | '_overrides'>;
|
|
@@ -29,13 +29,20 @@ type EntityTranslationResult<TResult = unknown> = {
|
|
|
29
29
|
errorText?: string;
|
|
30
30
|
};
|
|
31
31
|
type MaybePromise<T> = T | Promise<T> | PromiseLike<T>;
|
|
32
|
+
type CollectTranslationConfig = {
|
|
33
|
+
/**
|
|
34
|
+
* By default, if target locale value exists and different from source locale value, it will be skipped for translation.
|
|
35
|
+
* If `true`, target locale value mismatch will be ignored.
|
|
36
|
+
*/
|
|
37
|
+
ignoreTargetLocaleValueMismatch?: boolean;
|
|
38
|
+
};
|
|
32
39
|
|
|
33
40
|
type CollectTranslationPayloadResult = {
|
|
34
41
|
payload?: TranslationPayload;
|
|
35
42
|
errorKind?: 'unknown' | 'invalid-args' | 'entity-source-locale-missing';
|
|
36
43
|
errorText?: string;
|
|
37
44
|
};
|
|
38
|
-
declare const collectTranslationPayload: ({ uniformProjectId, uniformSourceLocale, uniformTargetLocale, uniformReleaseId, targetLang, entity, entityType, }: {
|
|
45
|
+
declare const collectTranslationPayload: ({ uniformProjectId, uniformSourceLocale, uniformTargetLocale, uniformReleaseId, targetLang, entity, entityType, config, }: {
|
|
39
46
|
uniformProjectId: string;
|
|
40
47
|
uniformSourceLocale: string;
|
|
41
48
|
uniformTargetLocale: string;
|
|
@@ -43,17 +50,18 @@ declare const collectTranslationPayload: ({ uniformProjectId, uniformSourceLocal
|
|
|
43
50
|
targetLang: string;
|
|
44
51
|
entity: RootComponentInstance | EntryData;
|
|
45
52
|
entityType: EntityType;
|
|
53
|
+
config?: CollectTranslationConfig;
|
|
46
54
|
}) => CollectTranslationPayloadResult;
|
|
47
55
|
|
|
48
56
|
declare const getCompositionForTranslation: ({ canvasClient, compositionId, releaseId, state, }: {
|
|
49
|
-
canvasClient:
|
|
57
|
+
canvasClient: CompositionManagementClient;
|
|
50
58
|
compositionId: string;
|
|
51
59
|
releaseId?: string;
|
|
52
60
|
state?: number;
|
|
53
61
|
}) => Promise<CompositionGetResponse | undefined>;
|
|
54
62
|
|
|
55
63
|
declare const getEntryForTranslation: ({ contentClient, entryId, releaseId, pattern, state, }: {
|
|
56
|
-
contentClient:
|
|
64
|
+
contentClient: EntryManagementClient;
|
|
57
65
|
entryId: string;
|
|
58
66
|
releaseId?: string;
|
|
59
67
|
pattern?: boolean;
|
|
@@ -61,12 +69,12 @@ declare const getEntryForTranslation: ({ contentClient, entryId, releaseId, patt
|
|
|
61
69
|
}) => Promise<Entry | undefined>;
|
|
62
70
|
|
|
63
71
|
type MergeCompositionTranslationToUniformOptions = {
|
|
64
|
-
canvasClient:
|
|
72
|
+
canvasClient: CompositionManagementClient;
|
|
65
73
|
translationPayload: TranslationPayload;
|
|
66
74
|
updateComposition?: (args: {
|
|
67
|
-
canvasClient:
|
|
75
|
+
canvasClient: CompositionManagementClient;
|
|
68
76
|
translationPayload: TranslationPayload;
|
|
69
|
-
composition: Parameters<
|
|
77
|
+
composition: Parameters<CompositionManagementClient['save']>[0];
|
|
70
78
|
}) => MaybePromise<boolean>;
|
|
71
79
|
onNotFound?: (args: {
|
|
72
80
|
translationPayload: TranslationPayload;
|
|
@@ -79,12 +87,12 @@ declare const mergeCompositionTranslationToUniform: ({ canvasClient, translation
|
|
|
79
87
|
}>;
|
|
80
88
|
|
|
81
89
|
type MergeEntryTranslationToUniformOptions = {
|
|
82
|
-
contentClient:
|
|
90
|
+
contentClient: EntryManagementClient;
|
|
83
91
|
translationPayload: TranslationPayload;
|
|
84
92
|
updateEntry?: (args: {
|
|
85
|
-
contentClient:
|
|
93
|
+
contentClient: EntryManagementClient;
|
|
86
94
|
translationPayload: TranslationPayload;
|
|
87
|
-
entry: Parameters<
|
|
95
|
+
entry: Parameters<EntryManagementClient['save']>[0];
|
|
88
96
|
}) => MaybePromise<boolean>;
|
|
89
97
|
onNotFound?: (args: {
|
|
90
98
|
translationPayload: TranslationPayload;
|
|
@@ -118,4 +126,4 @@ declare const translateEntry: ({ entry, translationPayload, }: {
|
|
|
118
126
|
translationPayload: TranslationPayload;
|
|
119
127
|
}) => EntityTranslationResult<Entry>;
|
|
120
128
|
|
|
121
|
-
export { type CollectTranslationPayloadResult, type ComponentTranslationPayload, type EntityTranslationResult, type EntityType, type MaybePromise, type MergeCompositionTranslationToUniformOptions, type MergeEntryTranslationToUniformOptions, type MergeTranslationToUniformOptions, type TranslationPayload, collectTranslationPayload, getCompositionForTranslation, getEntryForTranslation, mergeCompositionTranslationToUniform, mergeEntryTranslationToUniform, mergeTranslationToUniform, translateComposition, translateEntry };
|
|
129
|
+
export { type CollectTranslationConfig, type CollectTranslationPayloadResult, type ComponentTranslationPayload, type EntityTranslationResult, type EntityType, type MaybePromise, type MergeCompositionTranslationToUniformOptions, type MergeEntryTranslationToUniformOptions, type MergeTranslationToUniformOptions, type TranslationPayload, collectTranslationPayload, getCompositionForTranslation, getEntryForTranslation, mergeCompositionTranslationToUniform, mergeEntryTranslationToUniform, mergeTranslationToUniform, translateComposition, translateEntry };
|
package/dist/index.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { ComponentInstance, RootComponentInstance, EntryData,
|
|
1
|
+
import { ComponentInstance, RootComponentInstance, EntryData, CompositionManagementClient, CompositionGetResponse, EntryManagementClient, Entry } from '@uniformdev/canvas';
|
|
2
2
|
import { CanvasEditorEntityType } from '@uniformdev/mesh-sdk';
|
|
3
3
|
|
|
4
4
|
type ComponentTranslationPayload = Pick<ComponentInstance, '_id' | 'type' | 'parameters' | 'slots' | '_overrides'>;
|
|
@@ -29,13 +29,20 @@ type EntityTranslationResult<TResult = unknown> = {
|
|
|
29
29
|
errorText?: string;
|
|
30
30
|
};
|
|
31
31
|
type MaybePromise<T> = T | Promise<T> | PromiseLike<T>;
|
|
32
|
+
type CollectTranslationConfig = {
|
|
33
|
+
/**
|
|
34
|
+
* By default, if target locale value exists and different from source locale value, it will be skipped for translation.
|
|
35
|
+
* If `true`, target locale value mismatch will be ignored.
|
|
36
|
+
*/
|
|
37
|
+
ignoreTargetLocaleValueMismatch?: boolean;
|
|
38
|
+
};
|
|
32
39
|
|
|
33
40
|
type CollectTranslationPayloadResult = {
|
|
34
41
|
payload?: TranslationPayload;
|
|
35
42
|
errorKind?: 'unknown' | 'invalid-args' | 'entity-source-locale-missing';
|
|
36
43
|
errorText?: string;
|
|
37
44
|
};
|
|
38
|
-
declare const collectTranslationPayload: ({ uniformProjectId, uniformSourceLocale, uniformTargetLocale, uniformReleaseId, targetLang, entity, entityType, }: {
|
|
45
|
+
declare const collectTranslationPayload: ({ uniformProjectId, uniformSourceLocale, uniformTargetLocale, uniformReleaseId, targetLang, entity, entityType, config, }: {
|
|
39
46
|
uniformProjectId: string;
|
|
40
47
|
uniformSourceLocale: string;
|
|
41
48
|
uniformTargetLocale: string;
|
|
@@ -43,17 +50,18 @@ declare const collectTranslationPayload: ({ uniformProjectId, uniformSourceLocal
|
|
|
43
50
|
targetLang: string;
|
|
44
51
|
entity: RootComponentInstance | EntryData;
|
|
45
52
|
entityType: EntityType;
|
|
53
|
+
config?: CollectTranslationConfig;
|
|
46
54
|
}) => CollectTranslationPayloadResult;
|
|
47
55
|
|
|
48
56
|
declare const getCompositionForTranslation: ({ canvasClient, compositionId, releaseId, state, }: {
|
|
49
|
-
canvasClient:
|
|
57
|
+
canvasClient: CompositionManagementClient;
|
|
50
58
|
compositionId: string;
|
|
51
59
|
releaseId?: string;
|
|
52
60
|
state?: number;
|
|
53
61
|
}) => Promise<CompositionGetResponse | undefined>;
|
|
54
62
|
|
|
55
63
|
declare const getEntryForTranslation: ({ contentClient, entryId, releaseId, pattern, state, }: {
|
|
56
|
-
contentClient:
|
|
64
|
+
contentClient: EntryManagementClient;
|
|
57
65
|
entryId: string;
|
|
58
66
|
releaseId?: string;
|
|
59
67
|
pattern?: boolean;
|
|
@@ -61,12 +69,12 @@ declare const getEntryForTranslation: ({ contentClient, entryId, releaseId, patt
|
|
|
61
69
|
}) => Promise<Entry | undefined>;
|
|
62
70
|
|
|
63
71
|
type MergeCompositionTranslationToUniformOptions = {
|
|
64
|
-
canvasClient:
|
|
72
|
+
canvasClient: CompositionManagementClient;
|
|
65
73
|
translationPayload: TranslationPayload;
|
|
66
74
|
updateComposition?: (args: {
|
|
67
|
-
canvasClient:
|
|
75
|
+
canvasClient: CompositionManagementClient;
|
|
68
76
|
translationPayload: TranslationPayload;
|
|
69
|
-
composition: Parameters<
|
|
77
|
+
composition: Parameters<CompositionManagementClient['save']>[0];
|
|
70
78
|
}) => MaybePromise<boolean>;
|
|
71
79
|
onNotFound?: (args: {
|
|
72
80
|
translationPayload: TranslationPayload;
|
|
@@ -79,12 +87,12 @@ declare const mergeCompositionTranslationToUniform: ({ canvasClient, translation
|
|
|
79
87
|
}>;
|
|
80
88
|
|
|
81
89
|
type MergeEntryTranslationToUniformOptions = {
|
|
82
|
-
contentClient:
|
|
90
|
+
contentClient: EntryManagementClient;
|
|
83
91
|
translationPayload: TranslationPayload;
|
|
84
92
|
updateEntry?: (args: {
|
|
85
|
-
contentClient:
|
|
93
|
+
contentClient: EntryManagementClient;
|
|
86
94
|
translationPayload: TranslationPayload;
|
|
87
|
-
entry: Parameters<
|
|
95
|
+
entry: Parameters<EntryManagementClient['save']>[0];
|
|
88
96
|
}) => MaybePromise<boolean>;
|
|
89
97
|
onNotFound?: (args: {
|
|
90
98
|
translationPayload: TranslationPayload;
|
|
@@ -118,4 +126,4 @@ declare const translateEntry: ({ entry, translationPayload, }: {
|
|
|
118
126
|
translationPayload: TranslationPayload;
|
|
119
127
|
}) => EntityTranslationResult<Entry>;
|
|
120
128
|
|
|
121
|
-
export { type CollectTranslationPayloadResult, type ComponentTranslationPayload, type EntityTranslationResult, type EntityType, type MaybePromise, type MergeCompositionTranslationToUniformOptions, type MergeEntryTranslationToUniformOptions, type MergeTranslationToUniformOptions, type TranslationPayload, collectTranslationPayload, getCompositionForTranslation, getEntryForTranslation, mergeCompositionTranslationToUniform, mergeEntryTranslationToUniform, mergeTranslationToUniform, translateComposition, translateEntry };
|
|
129
|
+
export { type CollectTranslationConfig, type CollectTranslationPayloadResult, type ComponentTranslationPayload, type EntityTranslationResult, type EntityType, type MaybePromise, type MergeCompositionTranslationToUniformOptions, type MergeEntryTranslationToUniformOptions, type MergeTranslationToUniformOptions, type TranslationPayload, collectTranslationPayload, getCompositionForTranslation, getEntryForTranslation, mergeCompositionTranslationToUniform, mergeEntryTranslationToUniform, mergeTranslationToUniform, translateComposition, translateEntry };
|