@uniformdev/tms-sdk 19.153.1-alpha.1 → 19.153.1-alpha.7
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 +16 -15
- package/dist/index.d.ts +16 -15
- package/dist/index.esm.js +11 -11
- package/dist/index.js +11 -11
- package/dist/index.mjs +11 -11
- package/package.json +3 -3
package/dist/index.d.mts
CHANGED
|
@@ -27,6 +27,7 @@ type EntityTranslationResult<TResult = unknown> = {
|
|
|
27
27
|
errorKind?: 'unknown' | 'invalid-args' | 'project-id-mismatch' | 'entity-id-mismatch' | 'entity-locales-mismatch';
|
|
28
28
|
errorText?: string;
|
|
29
29
|
};
|
|
30
|
+
type MaybePromise<T> = T | Promise<T> | PromiseLike<T>;
|
|
30
31
|
|
|
31
32
|
type CollectTranslationPayloadResult = {
|
|
32
33
|
payload?: TranslationPayload;
|
|
@@ -53,18 +54,18 @@ type Options$1 = {
|
|
|
53
54
|
getCurrentComposition?: (args: {
|
|
54
55
|
canvasClient: CanvasClient;
|
|
55
56
|
translationPayload: TranslationPayload;
|
|
56
|
-
}) =>
|
|
57
|
-
onMissingComposition?: (args: {
|
|
58
|
-
translationPayload: TranslationPayload;
|
|
59
|
-
}) => Promise<void>;
|
|
60
|
-
onCompositionTranslationResult?: (result: EntityTranslationResult<CompositionGetResponse>) => Promise<EntityTranslationResult<CompositionGetResponse>>;
|
|
57
|
+
}) => MaybePromise<CompositionGetResponse | undefined>;
|
|
61
58
|
updateComposition?: (args: {
|
|
62
59
|
canvasClient: CanvasClient;
|
|
63
60
|
translationPayload: TranslationPayload;
|
|
64
61
|
composition: Parameters<CanvasClient['updateComposition']>[0];
|
|
65
|
-
}) =>
|
|
62
|
+
}) => MaybePromise<boolean>;
|
|
63
|
+
onMissingCurrent?: (args: {
|
|
64
|
+
translationPayload: TranslationPayload;
|
|
65
|
+
}) => MaybePromise<void>;
|
|
66
|
+
onTranslationResult?: (result: EntityTranslationResult<CompositionGetResponse>) => MaybePromise<EntityTranslationResult<CompositionGetResponse>>;
|
|
66
67
|
};
|
|
67
|
-
declare const mergeCompositionTranslationToUniform: ({ canvasClient, translationPayload, getCurrentComposition,
|
|
68
|
+
declare const mergeCompositionTranslationToUniform: ({ canvasClient, translationPayload, getCurrentComposition, updateComposition, onMissingCurrent, onTranslationResult, }: Options$1) => Promise<{
|
|
68
69
|
translationMerged: boolean;
|
|
69
70
|
entityId?: string | undefined;
|
|
70
71
|
}>;
|
|
@@ -75,18 +76,18 @@ type Options = {
|
|
|
75
76
|
getCurrentEntry?: (args: {
|
|
76
77
|
contentClient: ContentClient;
|
|
77
78
|
translationPayload: TranslationPayload;
|
|
78
|
-
}) =>
|
|
79
|
-
onMissingEntry?: (args: {
|
|
80
|
-
translationPayload: TranslationPayload;
|
|
81
|
-
}) => Promise<void>;
|
|
82
|
-
onEntryTranslationResult?: (result: EntityTranslationResult<Entry>) => Promise<EntityTranslationResult<Entry>>;
|
|
79
|
+
}) => MaybePromise<Entry | undefined>;
|
|
83
80
|
updateEntry?: (args: {
|
|
84
81
|
contentClient: ContentClient;
|
|
85
82
|
translationPayload: TranslationPayload;
|
|
86
83
|
entry: Parameters<ContentClient['upsertEntry']>[0];
|
|
87
|
-
}) =>
|
|
84
|
+
}) => MaybePromise<boolean>;
|
|
85
|
+
onMissingCurrent?: (args: {
|
|
86
|
+
translationPayload: TranslationPayload;
|
|
87
|
+
}) => MaybePromise<void>;
|
|
88
|
+
onTranslationResult?: (result: EntityTranslationResult<Entry>) => MaybePromise<EntityTranslationResult<Entry>>;
|
|
88
89
|
};
|
|
89
|
-
declare const mergeEntryTranslationToUniform: ({ contentClient, translationPayload, getCurrentEntry,
|
|
90
|
+
declare const mergeEntryTranslationToUniform: ({ contentClient, translationPayload, getCurrentEntry, onMissingCurrent, onTranslationResult, updateEntry, }: Options) => Promise<{
|
|
90
91
|
translationMerged: boolean;
|
|
91
92
|
entityId?: string | undefined;
|
|
92
93
|
}>;
|
|
@@ -103,4 +104,4 @@ declare const translateEntry: ({ entry, translationPayload, overrideModifiedTarg
|
|
|
103
104
|
overrideModifiedTargetLocale: boolean;
|
|
104
105
|
}) => EntityTranslationResult<Entry>;
|
|
105
106
|
|
|
106
|
-
export { type CollectTranslationPayloadResult, type ComponentTranslationPayload, type EntityTranslationResult, type TranslationPayload, collectTranslationPayload, mergeCompositionTranslationToUniform, mergeEntryTranslationToUniform, translateComposition, translateEntry };
|
|
107
|
+
export { type CollectTranslationPayloadResult, type ComponentTranslationPayload, type EntityTranslationResult, type MaybePromise, type TranslationPayload, collectTranslationPayload, mergeCompositionTranslationToUniform, mergeEntryTranslationToUniform, translateComposition, translateEntry };
|
package/dist/index.d.ts
CHANGED
|
@@ -27,6 +27,7 @@ type EntityTranslationResult<TResult = unknown> = {
|
|
|
27
27
|
errorKind?: 'unknown' | 'invalid-args' | 'project-id-mismatch' | 'entity-id-mismatch' | 'entity-locales-mismatch';
|
|
28
28
|
errorText?: string;
|
|
29
29
|
};
|
|
30
|
+
type MaybePromise<T> = T | Promise<T> | PromiseLike<T>;
|
|
30
31
|
|
|
31
32
|
type CollectTranslationPayloadResult = {
|
|
32
33
|
payload?: TranslationPayload;
|
|
@@ -53,18 +54,18 @@ type Options$1 = {
|
|
|
53
54
|
getCurrentComposition?: (args: {
|
|
54
55
|
canvasClient: CanvasClient;
|
|
55
56
|
translationPayload: TranslationPayload;
|
|
56
|
-
}) =>
|
|
57
|
-
onMissingComposition?: (args: {
|
|
58
|
-
translationPayload: TranslationPayload;
|
|
59
|
-
}) => Promise<void>;
|
|
60
|
-
onCompositionTranslationResult?: (result: EntityTranslationResult<CompositionGetResponse>) => Promise<EntityTranslationResult<CompositionGetResponse>>;
|
|
57
|
+
}) => MaybePromise<CompositionGetResponse | undefined>;
|
|
61
58
|
updateComposition?: (args: {
|
|
62
59
|
canvasClient: CanvasClient;
|
|
63
60
|
translationPayload: TranslationPayload;
|
|
64
61
|
composition: Parameters<CanvasClient['updateComposition']>[0];
|
|
65
|
-
}) =>
|
|
62
|
+
}) => MaybePromise<boolean>;
|
|
63
|
+
onMissingCurrent?: (args: {
|
|
64
|
+
translationPayload: TranslationPayload;
|
|
65
|
+
}) => MaybePromise<void>;
|
|
66
|
+
onTranslationResult?: (result: EntityTranslationResult<CompositionGetResponse>) => MaybePromise<EntityTranslationResult<CompositionGetResponse>>;
|
|
66
67
|
};
|
|
67
|
-
declare const mergeCompositionTranslationToUniform: ({ canvasClient, translationPayload, getCurrentComposition,
|
|
68
|
+
declare const mergeCompositionTranslationToUniform: ({ canvasClient, translationPayload, getCurrentComposition, updateComposition, onMissingCurrent, onTranslationResult, }: Options$1) => Promise<{
|
|
68
69
|
translationMerged: boolean;
|
|
69
70
|
entityId?: string | undefined;
|
|
70
71
|
}>;
|
|
@@ -75,18 +76,18 @@ type Options = {
|
|
|
75
76
|
getCurrentEntry?: (args: {
|
|
76
77
|
contentClient: ContentClient;
|
|
77
78
|
translationPayload: TranslationPayload;
|
|
78
|
-
}) =>
|
|
79
|
-
onMissingEntry?: (args: {
|
|
80
|
-
translationPayload: TranslationPayload;
|
|
81
|
-
}) => Promise<void>;
|
|
82
|
-
onEntryTranslationResult?: (result: EntityTranslationResult<Entry>) => Promise<EntityTranslationResult<Entry>>;
|
|
79
|
+
}) => MaybePromise<Entry | undefined>;
|
|
83
80
|
updateEntry?: (args: {
|
|
84
81
|
contentClient: ContentClient;
|
|
85
82
|
translationPayload: TranslationPayload;
|
|
86
83
|
entry: Parameters<ContentClient['upsertEntry']>[0];
|
|
87
|
-
}) =>
|
|
84
|
+
}) => MaybePromise<boolean>;
|
|
85
|
+
onMissingCurrent?: (args: {
|
|
86
|
+
translationPayload: TranslationPayload;
|
|
87
|
+
}) => MaybePromise<void>;
|
|
88
|
+
onTranslationResult?: (result: EntityTranslationResult<Entry>) => MaybePromise<EntityTranslationResult<Entry>>;
|
|
88
89
|
};
|
|
89
|
-
declare const mergeEntryTranslationToUniform: ({ contentClient, translationPayload, getCurrentEntry,
|
|
90
|
+
declare const mergeEntryTranslationToUniform: ({ contentClient, translationPayload, getCurrentEntry, onMissingCurrent, onTranslationResult, updateEntry, }: Options) => Promise<{
|
|
90
91
|
translationMerged: boolean;
|
|
91
92
|
entityId?: string | undefined;
|
|
92
93
|
}>;
|
|
@@ -103,4 +104,4 @@ declare const translateEntry: ({ entry, translationPayload, overrideModifiedTarg
|
|
|
103
104
|
overrideModifiedTargetLocale: boolean;
|
|
104
105
|
}) => EntityTranslationResult<Entry>;
|
|
105
106
|
|
|
106
|
-
export { type CollectTranslationPayloadResult, type ComponentTranslationPayload, type EntityTranslationResult, type TranslationPayload, collectTranslationPayload, mergeCompositionTranslationToUniform, mergeEntryTranslationToUniform, translateComposition, translateEntry };
|
|
107
|
+
export { type CollectTranslationPayloadResult, type ComponentTranslationPayload, type EntityTranslationResult, type MaybePromise, type TranslationPayload, collectTranslationPayload, mergeCompositionTranslationToUniform, mergeEntryTranslationToUniform, translateComposition, translateEntry };
|
package/dist/index.esm.js
CHANGED
|
@@ -331,9 +331,9 @@ var mergeCompositionTranslationToUniform = async ({
|
|
|
331
331
|
canvasClient,
|
|
332
332
|
translationPayload,
|
|
333
333
|
getCurrentComposition = defaultGetCurrentComposition,
|
|
334
|
-
|
|
335
|
-
|
|
336
|
-
|
|
334
|
+
updateComposition = defaultUpdateComposition,
|
|
335
|
+
onMissingCurrent,
|
|
336
|
+
onTranslationResult
|
|
337
337
|
}) => {
|
|
338
338
|
if (!translationPayload) {
|
|
339
339
|
return { translationMerged: false };
|
|
@@ -348,7 +348,7 @@ var mergeCompositionTranslationToUniform = async ({
|
|
|
348
348
|
translationPayload
|
|
349
349
|
});
|
|
350
350
|
if (!composition) {
|
|
351
|
-
await (
|
|
351
|
+
await (onMissingCurrent == null ? void 0 : onMissingCurrent({
|
|
352
352
|
translationPayload
|
|
353
353
|
}));
|
|
354
354
|
return { translationMerged: false, entityId };
|
|
@@ -358,8 +358,8 @@ var mergeCompositionTranslationToUniform = async ({
|
|
|
358
358
|
translationPayload,
|
|
359
359
|
overrideModifiedTargetLocale
|
|
360
360
|
});
|
|
361
|
-
if (
|
|
362
|
-
translationResult = await
|
|
361
|
+
if (onTranslationResult) {
|
|
362
|
+
translationResult = await onTranslationResult(translationResult);
|
|
363
363
|
}
|
|
364
364
|
const { updated, errorKind, result: translatedComposition } = translationResult;
|
|
365
365
|
if (translatedComposition && updated && !errorKind) {
|
|
@@ -490,8 +490,8 @@ var mergeEntryTranslationToUniform = async ({
|
|
|
490
490
|
contentClient,
|
|
491
491
|
translationPayload,
|
|
492
492
|
getCurrentEntry = defaultGetCurrentEntry,
|
|
493
|
-
|
|
494
|
-
|
|
493
|
+
onMissingCurrent,
|
|
494
|
+
onTranslationResult,
|
|
495
495
|
updateEntry = defaultUpdateEntry
|
|
496
496
|
}) => {
|
|
497
497
|
if (!translationPayload) {
|
|
@@ -507,7 +507,7 @@ var mergeEntryTranslationToUniform = async ({
|
|
|
507
507
|
translationPayload
|
|
508
508
|
});
|
|
509
509
|
if (!entry) {
|
|
510
|
-
await (
|
|
510
|
+
await (onMissingCurrent == null ? void 0 : onMissingCurrent({
|
|
511
511
|
translationPayload
|
|
512
512
|
}));
|
|
513
513
|
return { translationMerged: false, entityId };
|
|
@@ -517,8 +517,8 @@ var mergeEntryTranslationToUniform = async ({
|
|
|
517
517
|
translationPayload,
|
|
518
518
|
overrideModifiedTargetLocale
|
|
519
519
|
});
|
|
520
|
-
if (
|
|
521
|
-
translationResult = await
|
|
520
|
+
if (onTranslationResult) {
|
|
521
|
+
translationResult = await onTranslationResult(translationResult);
|
|
522
522
|
}
|
|
523
523
|
const { updated, errorKind, result: translatedEntry } = translationResult;
|
|
524
524
|
if (translatedEntry && updated && !errorKind) {
|
package/dist/index.js
CHANGED
|
@@ -358,9 +358,9 @@ var mergeCompositionTranslationToUniform = async ({
|
|
|
358
358
|
canvasClient,
|
|
359
359
|
translationPayload,
|
|
360
360
|
getCurrentComposition = defaultGetCurrentComposition,
|
|
361
|
-
|
|
362
|
-
|
|
363
|
-
|
|
361
|
+
updateComposition = defaultUpdateComposition,
|
|
362
|
+
onMissingCurrent,
|
|
363
|
+
onTranslationResult
|
|
364
364
|
}) => {
|
|
365
365
|
if (!translationPayload) {
|
|
366
366
|
return { translationMerged: false };
|
|
@@ -375,7 +375,7 @@ var mergeCompositionTranslationToUniform = async ({
|
|
|
375
375
|
translationPayload
|
|
376
376
|
});
|
|
377
377
|
if (!composition) {
|
|
378
|
-
await (
|
|
378
|
+
await (onMissingCurrent == null ? void 0 : onMissingCurrent({
|
|
379
379
|
translationPayload
|
|
380
380
|
}));
|
|
381
381
|
return { translationMerged: false, entityId };
|
|
@@ -385,8 +385,8 @@ var mergeCompositionTranslationToUniform = async ({
|
|
|
385
385
|
translationPayload,
|
|
386
386
|
overrideModifiedTargetLocale
|
|
387
387
|
});
|
|
388
|
-
if (
|
|
389
|
-
translationResult = await
|
|
388
|
+
if (onTranslationResult) {
|
|
389
|
+
translationResult = await onTranslationResult(translationResult);
|
|
390
390
|
}
|
|
391
391
|
const { updated, errorKind, result: translatedComposition } = translationResult;
|
|
392
392
|
if (translatedComposition && updated && !errorKind) {
|
|
@@ -517,8 +517,8 @@ var mergeEntryTranslationToUniform = async ({
|
|
|
517
517
|
contentClient,
|
|
518
518
|
translationPayload,
|
|
519
519
|
getCurrentEntry = defaultGetCurrentEntry,
|
|
520
|
-
|
|
521
|
-
|
|
520
|
+
onMissingCurrent,
|
|
521
|
+
onTranslationResult,
|
|
522
522
|
updateEntry = defaultUpdateEntry
|
|
523
523
|
}) => {
|
|
524
524
|
if (!translationPayload) {
|
|
@@ -534,7 +534,7 @@ var mergeEntryTranslationToUniform = async ({
|
|
|
534
534
|
translationPayload
|
|
535
535
|
});
|
|
536
536
|
if (!entry) {
|
|
537
|
-
await (
|
|
537
|
+
await (onMissingCurrent == null ? void 0 : onMissingCurrent({
|
|
538
538
|
translationPayload
|
|
539
539
|
}));
|
|
540
540
|
return { translationMerged: false, entityId };
|
|
@@ -544,8 +544,8 @@ var mergeEntryTranslationToUniform = async ({
|
|
|
544
544
|
translationPayload,
|
|
545
545
|
overrideModifiedTargetLocale
|
|
546
546
|
});
|
|
547
|
-
if (
|
|
548
|
-
translationResult = await
|
|
547
|
+
if (onTranslationResult) {
|
|
548
|
+
translationResult = await onTranslationResult(translationResult);
|
|
549
549
|
}
|
|
550
550
|
const { updated, errorKind, result: translatedEntry } = translationResult;
|
|
551
551
|
if (translatedEntry && updated && !errorKind) {
|
package/dist/index.mjs
CHANGED
|
@@ -331,9 +331,9 @@ var mergeCompositionTranslationToUniform = async ({
|
|
|
331
331
|
canvasClient,
|
|
332
332
|
translationPayload,
|
|
333
333
|
getCurrentComposition = defaultGetCurrentComposition,
|
|
334
|
-
|
|
335
|
-
|
|
336
|
-
|
|
334
|
+
updateComposition = defaultUpdateComposition,
|
|
335
|
+
onMissingCurrent,
|
|
336
|
+
onTranslationResult
|
|
337
337
|
}) => {
|
|
338
338
|
if (!translationPayload) {
|
|
339
339
|
return { translationMerged: false };
|
|
@@ -348,7 +348,7 @@ var mergeCompositionTranslationToUniform = async ({
|
|
|
348
348
|
translationPayload
|
|
349
349
|
});
|
|
350
350
|
if (!composition) {
|
|
351
|
-
await (
|
|
351
|
+
await (onMissingCurrent == null ? void 0 : onMissingCurrent({
|
|
352
352
|
translationPayload
|
|
353
353
|
}));
|
|
354
354
|
return { translationMerged: false, entityId };
|
|
@@ -358,8 +358,8 @@ var mergeCompositionTranslationToUniform = async ({
|
|
|
358
358
|
translationPayload,
|
|
359
359
|
overrideModifiedTargetLocale
|
|
360
360
|
});
|
|
361
|
-
if (
|
|
362
|
-
translationResult = await
|
|
361
|
+
if (onTranslationResult) {
|
|
362
|
+
translationResult = await onTranslationResult(translationResult);
|
|
363
363
|
}
|
|
364
364
|
const { updated, errorKind, result: translatedComposition } = translationResult;
|
|
365
365
|
if (translatedComposition && updated && !errorKind) {
|
|
@@ -490,8 +490,8 @@ var mergeEntryTranslationToUniform = async ({
|
|
|
490
490
|
contentClient,
|
|
491
491
|
translationPayload,
|
|
492
492
|
getCurrentEntry = defaultGetCurrentEntry,
|
|
493
|
-
|
|
494
|
-
|
|
493
|
+
onMissingCurrent,
|
|
494
|
+
onTranslationResult,
|
|
495
495
|
updateEntry = defaultUpdateEntry
|
|
496
496
|
}) => {
|
|
497
497
|
if (!translationPayload) {
|
|
@@ -507,7 +507,7 @@ var mergeEntryTranslationToUniform = async ({
|
|
|
507
507
|
translationPayload
|
|
508
508
|
});
|
|
509
509
|
if (!entry) {
|
|
510
|
-
await (
|
|
510
|
+
await (onMissingCurrent == null ? void 0 : onMissingCurrent({
|
|
511
511
|
translationPayload
|
|
512
512
|
}));
|
|
513
513
|
return { translationMerged: false, entityId };
|
|
@@ -517,8 +517,8 @@ var mergeEntryTranslationToUniform = async ({
|
|
|
517
517
|
translationPayload,
|
|
518
518
|
overrideModifiedTargetLocale
|
|
519
519
|
});
|
|
520
|
-
if (
|
|
521
|
-
translationResult = await
|
|
520
|
+
if (onTranslationResult) {
|
|
521
|
+
translationResult = await onTranslationResult(translationResult);
|
|
522
522
|
}
|
|
523
523
|
const { updated, errorKind, result: translatedEntry } = translationResult;
|
|
524
524
|
if (translatedEntry && updated && !errorKind) {
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@uniformdev/tms-sdk",
|
|
3
|
-
"version": "19.153.1-alpha.
|
|
3
|
+
"version": "19.153.1-alpha.7+f044ed03fa",
|
|
4
4
|
"description": "Uniform Translation Management System SDK",
|
|
5
5
|
"license": "SEE LICENSE IN LICENSE.txt",
|
|
6
6
|
"main": "./dist/index.js",
|
|
@@ -33,7 +33,7 @@
|
|
|
33
33
|
"access": "public"
|
|
34
34
|
},
|
|
35
35
|
"dependencies": {
|
|
36
|
-
"@uniformdev/canvas": "19.153.1-alpha.
|
|
36
|
+
"@uniformdev/canvas": "19.153.1-alpha.7+f044ed03fa",
|
|
37
37
|
"dequal": "2.0.3",
|
|
38
38
|
"immer": "10.0.4",
|
|
39
39
|
"uuid": "9.0.1"
|
|
@@ -41,5 +41,5 @@
|
|
|
41
41
|
"devDependencies": {
|
|
42
42
|
"@types/uuid": "9.0.4"
|
|
43
43
|
},
|
|
44
|
-
"gitHead": "
|
|
44
|
+
"gitHead": "f044ed03fac543671ed2db1869cc173618f4d46c"
|
|
45
45
|
}
|