@uniformdev/tms-sdk 19.153.1-alpha.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.txt +2 -0
- package/dist/index.d.mts +106 -0
- package/dist/index.d.ts +106 -0
- package/dist/index.esm.js +566 -0
- package/dist/index.js +594 -0
- package/dist/index.mjs +566 -0
- package/package.json +45 -0
package/LICENSE.txt
ADDED
package/dist/index.d.mts
ADDED
|
@@ -0,0 +1,106 @@
|
|
|
1
|
+
import { ComponentInstance, RootComponentInstance, EntryData, CanvasClient, CompositionGetResponse, ContentClient, Entry } from '@uniformdev/canvas';
|
|
2
|
+
|
|
3
|
+
type ComponentTranslationPayload = Pick<ComponentInstance, 'type' | 'parameters' | '_overrides'>;
|
|
4
|
+
type TranslationPayload = {
|
|
5
|
+
schemaVersion: number;
|
|
6
|
+
metadata: {
|
|
7
|
+
uniformProjectId: string;
|
|
8
|
+
uniformSourceLocale: string;
|
|
9
|
+
uniformTargetLocale: string;
|
|
10
|
+
uniformReleaseId?: string;
|
|
11
|
+
targetLang: string;
|
|
12
|
+
entityType: 'composition' | 'entry';
|
|
13
|
+
entity: {
|
|
14
|
+
id: string;
|
|
15
|
+
slug: string | null | undefined;
|
|
16
|
+
};
|
|
17
|
+
overrideModifiedTargetLocale: boolean;
|
|
18
|
+
};
|
|
19
|
+
components: {
|
|
20
|
+
[componentId: string]: ComponentTranslationPayload | undefined;
|
|
21
|
+
};
|
|
22
|
+
custom?: Record<string, unknown>;
|
|
23
|
+
};
|
|
24
|
+
type EntityTranslationResult<TResult = unknown> = {
|
|
25
|
+
result?: TResult;
|
|
26
|
+
updated: boolean;
|
|
27
|
+
errorKind?: 'unknown' | 'invalid-args' | 'project-id-mismatch' | 'entity-id-mismatch' | 'entity-locales-mismatch';
|
|
28
|
+
errorText?: string;
|
|
29
|
+
};
|
|
30
|
+
|
|
31
|
+
type CollectTranslationPayloadResult = {
|
|
32
|
+
payload?: TranslationPayload;
|
|
33
|
+
errorKind?: 'unknown' | 'invalid-args' | 'entity-source-locale-missing';
|
|
34
|
+
errorText?: string;
|
|
35
|
+
};
|
|
36
|
+
declare const collectTranslationPayload: ({ uniformProjectId, uniformSourceLocale, uniformTargetLocale, uniformReleaseId, targetLang, entity, entityType, overrideModifiedTargetLocale, }: {
|
|
37
|
+
uniformProjectId: string;
|
|
38
|
+
uniformSourceLocale: string;
|
|
39
|
+
uniformTargetLocale: string;
|
|
40
|
+
uniformReleaseId: string | undefined;
|
|
41
|
+
targetLang: string;
|
|
42
|
+
entity: RootComponentInstance | EntryData;
|
|
43
|
+
entityType: 'composition' | 'entry';
|
|
44
|
+
/**
|
|
45
|
+
* Ignore modified content in target locales and collect all supported parameters for translation
|
|
46
|
+
*/
|
|
47
|
+
overrideModifiedTargetLocale: boolean;
|
|
48
|
+
}) => CollectTranslationPayloadResult;
|
|
49
|
+
|
|
50
|
+
type Options$1 = {
|
|
51
|
+
canvasClient: CanvasClient;
|
|
52
|
+
translationPayload: TranslationPayload;
|
|
53
|
+
getCurrentComposition?: (args: {
|
|
54
|
+
canvasClient: CanvasClient;
|
|
55
|
+
translationPayload: TranslationPayload;
|
|
56
|
+
}) => Promise<CompositionGetResponse | undefined>;
|
|
57
|
+
onMissingComposition?: (args: {
|
|
58
|
+
translationPayload: TranslationPayload;
|
|
59
|
+
}) => Promise<void>;
|
|
60
|
+
onCompositionTranslationResult?: (result: EntityTranslationResult<CompositionGetResponse>) => Promise<EntityTranslationResult<CompositionGetResponse>>;
|
|
61
|
+
updateComposition?: (args: {
|
|
62
|
+
canvasClient: CanvasClient;
|
|
63
|
+
translationPayload: TranslationPayload;
|
|
64
|
+
composition: Parameters<CanvasClient['updateComposition']>[0];
|
|
65
|
+
}) => Promise<boolean>;
|
|
66
|
+
};
|
|
67
|
+
declare const mergeCompositionTranslationToUniform: ({ canvasClient, translationPayload, getCurrentComposition, onMissingComposition, onCompositionTranslationResult, updateComposition, }: Options$1) => Promise<{
|
|
68
|
+
translationMerged: boolean;
|
|
69
|
+
entityId?: string | undefined;
|
|
70
|
+
}>;
|
|
71
|
+
|
|
72
|
+
type Options = {
|
|
73
|
+
contentClient: ContentClient;
|
|
74
|
+
translationPayload: TranslationPayload;
|
|
75
|
+
getCurrentEntry?: (args: {
|
|
76
|
+
contentClient: ContentClient;
|
|
77
|
+
translationPayload: TranslationPayload;
|
|
78
|
+
}) => Promise<Entry | undefined>;
|
|
79
|
+
onMissingEntry?: (args: {
|
|
80
|
+
translationPayload: TranslationPayload;
|
|
81
|
+
}) => Promise<void>;
|
|
82
|
+
onEntryTranslationResult?: (result: EntityTranslationResult<Entry>) => Promise<EntityTranslationResult<Entry>>;
|
|
83
|
+
updateEntry?: (args: {
|
|
84
|
+
contentClient: ContentClient;
|
|
85
|
+
translationPayload: TranslationPayload;
|
|
86
|
+
entry: Parameters<ContentClient['upsertEntry']>[0];
|
|
87
|
+
}) => Promise<boolean>;
|
|
88
|
+
};
|
|
89
|
+
declare const mergeEntryTranslationToUniform: ({ contentClient, translationPayload, getCurrentEntry, onMissingEntry, onEntryTranslationResult, updateEntry, }: Options) => Promise<{
|
|
90
|
+
translationMerged: boolean;
|
|
91
|
+
entityId?: string | undefined;
|
|
92
|
+
}>;
|
|
93
|
+
|
|
94
|
+
declare const translateComposition: ({ composition, translationPayload, overrideModifiedTargetLocale, }: {
|
|
95
|
+
composition: CompositionGetResponse;
|
|
96
|
+
translationPayload: TranslationPayload;
|
|
97
|
+
overrideModifiedTargetLocale: boolean;
|
|
98
|
+
}) => EntityTranslationResult<CompositionGetResponse>;
|
|
99
|
+
|
|
100
|
+
declare const translateEntry: ({ entry, translationPayload, overrideModifiedTargetLocale, }: {
|
|
101
|
+
entry: Entry;
|
|
102
|
+
translationPayload: TranslationPayload;
|
|
103
|
+
overrideModifiedTargetLocale: boolean;
|
|
104
|
+
}) => EntityTranslationResult<Entry>;
|
|
105
|
+
|
|
106
|
+
export { type CollectTranslationPayloadResult, type ComponentTranslationPayload, type EntityTranslationResult, type TranslationPayload, collectTranslationPayload, mergeCompositionTranslationToUniform, mergeEntryTranslationToUniform, translateComposition, translateEntry };
|
package/dist/index.d.ts
ADDED
|
@@ -0,0 +1,106 @@
|
|
|
1
|
+
import { ComponentInstance, RootComponentInstance, EntryData, CanvasClient, CompositionGetResponse, ContentClient, Entry } from '@uniformdev/canvas';
|
|
2
|
+
|
|
3
|
+
type ComponentTranslationPayload = Pick<ComponentInstance, 'type' | 'parameters' | '_overrides'>;
|
|
4
|
+
type TranslationPayload = {
|
|
5
|
+
schemaVersion: number;
|
|
6
|
+
metadata: {
|
|
7
|
+
uniformProjectId: string;
|
|
8
|
+
uniformSourceLocale: string;
|
|
9
|
+
uniformTargetLocale: string;
|
|
10
|
+
uniformReleaseId?: string;
|
|
11
|
+
targetLang: string;
|
|
12
|
+
entityType: 'composition' | 'entry';
|
|
13
|
+
entity: {
|
|
14
|
+
id: string;
|
|
15
|
+
slug: string | null | undefined;
|
|
16
|
+
};
|
|
17
|
+
overrideModifiedTargetLocale: boolean;
|
|
18
|
+
};
|
|
19
|
+
components: {
|
|
20
|
+
[componentId: string]: ComponentTranslationPayload | undefined;
|
|
21
|
+
};
|
|
22
|
+
custom?: Record<string, unknown>;
|
|
23
|
+
};
|
|
24
|
+
type EntityTranslationResult<TResult = unknown> = {
|
|
25
|
+
result?: TResult;
|
|
26
|
+
updated: boolean;
|
|
27
|
+
errorKind?: 'unknown' | 'invalid-args' | 'project-id-mismatch' | 'entity-id-mismatch' | 'entity-locales-mismatch';
|
|
28
|
+
errorText?: string;
|
|
29
|
+
};
|
|
30
|
+
|
|
31
|
+
type CollectTranslationPayloadResult = {
|
|
32
|
+
payload?: TranslationPayload;
|
|
33
|
+
errorKind?: 'unknown' | 'invalid-args' | 'entity-source-locale-missing';
|
|
34
|
+
errorText?: string;
|
|
35
|
+
};
|
|
36
|
+
declare const collectTranslationPayload: ({ uniformProjectId, uniformSourceLocale, uniformTargetLocale, uniformReleaseId, targetLang, entity, entityType, overrideModifiedTargetLocale, }: {
|
|
37
|
+
uniformProjectId: string;
|
|
38
|
+
uniformSourceLocale: string;
|
|
39
|
+
uniformTargetLocale: string;
|
|
40
|
+
uniformReleaseId: string | undefined;
|
|
41
|
+
targetLang: string;
|
|
42
|
+
entity: RootComponentInstance | EntryData;
|
|
43
|
+
entityType: 'composition' | 'entry';
|
|
44
|
+
/**
|
|
45
|
+
* Ignore modified content in target locales and collect all supported parameters for translation
|
|
46
|
+
*/
|
|
47
|
+
overrideModifiedTargetLocale: boolean;
|
|
48
|
+
}) => CollectTranslationPayloadResult;
|
|
49
|
+
|
|
50
|
+
type Options$1 = {
|
|
51
|
+
canvasClient: CanvasClient;
|
|
52
|
+
translationPayload: TranslationPayload;
|
|
53
|
+
getCurrentComposition?: (args: {
|
|
54
|
+
canvasClient: CanvasClient;
|
|
55
|
+
translationPayload: TranslationPayload;
|
|
56
|
+
}) => Promise<CompositionGetResponse | undefined>;
|
|
57
|
+
onMissingComposition?: (args: {
|
|
58
|
+
translationPayload: TranslationPayload;
|
|
59
|
+
}) => Promise<void>;
|
|
60
|
+
onCompositionTranslationResult?: (result: EntityTranslationResult<CompositionGetResponse>) => Promise<EntityTranslationResult<CompositionGetResponse>>;
|
|
61
|
+
updateComposition?: (args: {
|
|
62
|
+
canvasClient: CanvasClient;
|
|
63
|
+
translationPayload: TranslationPayload;
|
|
64
|
+
composition: Parameters<CanvasClient['updateComposition']>[0];
|
|
65
|
+
}) => Promise<boolean>;
|
|
66
|
+
};
|
|
67
|
+
declare const mergeCompositionTranslationToUniform: ({ canvasClient, translationPayload, getCurrentComposition, onMissingComposition, onCompositionTranslationResult, updateComposition, }: Options$1) => Promise<{
|
|
68
|
+
translationMerged: boolean;
|
|
69
|
+
entityId?: string | undefined;
|
|
70
|
+
}>;
|
|
71
|
+
|
|
72
|
+
type Options = {
|
|
73
|
+
contentClient: ContentClient;
|
|
74
|
+
translationPayload: TranslationPayload;
|
|
75
|
+
getCurrentEntry?: (args: {
|
|
76
|
+
contentClient: ContentClient;
|
|
77
|
+
translationPayload: TranslationPayload;
|
|
78
|
+
}) => Promise<Entry | undefined>;
|
|
79
|
+
onMissingEntry?: (args: {
|
|
80
|
+
translationPayload: TranslationPayload;
|
|
81
|
+
}) => Promise<void>;
|
|
82
|
+
onEntryTranslationResult?: (result: EntityTranslationResult<Entry>) => Promise<EntityTranslationResult<Entry>>;
|
|
83
|
+
updateEntry?: (args: {
|
|
84
|
+
contentClient: ContentClient;
|
|
85
|
+
translationPayload: TranslationPayload;
|
|
86
|
+
entry: Parameters<ContentClient['upsertEntry']>[0];
|
|
87
|
+
}) => Promise<boolean>;
|
|
88
|
+
};
|
|
89
|
+
declare const mergeEntryTranslationToUniform: ({ contentClient, translationPayload, getCurrentEntry, onMissingEntry, onEntryTranslationResult, updateEntry, }: Options) => Promise<{
|
|
90
|
+
translationMerged: boolean;
|
|
91
|
+
entityId?: string | undefined;
|
|
92
|
+
}>;
|
|
93
|
+
|
|
94
|
+
declare const translateComposition: ({ composition, translationPayload, overrideModifiedTargetLocale, }: {
|
|
95
|
+
composition: CompositionGetResponse;
|
|
96
|
+
translationPayload: TranslationPayload;
|
|
97
|
+
overrideModifiedTargetLocale: boolean;
|
|
98
|
+
}) => EntityTranslationResult<CompositionGetResponse>;
|
|
99
|
+
|
|
100
|
+
declare const translateEntry: ({ entry, translationPayload, overrideModifiedTargetLocale, }: {
|
|
101
|
+
entry: Entry;
|
|
102
|
+
translationPayload: TranslationPayload;
|
|
103
|
+
overrideModifiedTargetLocale: boolean;
|
|
104
|
+
}) => EntityTranslationResult<Entry>;
|
|
105
|
+
|
|
106
|
+
export { type CollectTranslationPayloadResult, type ComponentTranslationPayload, type EntityTranslationResult, type TranslationPayload, collectTranslationPayload, mergeCompositionTranslationToUniform, mergeEntryTranslationToUniform, translateComposition, translateEntry };
|