@uniformdev/tms-sdk 19.135.1-alpha.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.
Files changed (7) hide show
  1. package/LICENSE.txt +2 -0
  2. package/dist/index.d.mts +121 -0
  3. package/dist/index.d.ts +121 -0
  4. package/dist/index.esm.js +1014 -0
  5. package/dist/index.js +1043 -0
  6. package/dist/index.mjs +1014 -0
  7. package/package.json +44 -0
package/LICENSE.txt ADDED
@@ -0,0 +1,2 @@
1
+ © 2024 Uniform Systems, Inc. All Rights Reserved.
2
+ See details of Uniform Systems, Inc. Master Subscription Agreement here: https://uniform.dev/eula
package/dist/index.d.mts ADDED
@@ -0,0 +1,121 @@
1
+ import { ComponentInstance, RootComponentInstance, EntryData, CanvasClient, CompositionGetResponse, ContentClient, Entry } from '@uniformdev/canvas';
2
+ import { CanvasEditorEntityType } from '@uniformdev/mesh-sdk';
3
+
4
+ type ComponentTranslationPayload = Pick<ComponentInstance, '_id' | 'type' | 'parameters' | 'slots' | '_overrides'>;
5
+ type EntityType = CanvasEditorEntityType;
6
+ type TranslationPayload = {
7
+ schemaVersion: number;
8
+ metadata: {
9
+ uniformProjectId: string;
10
+ uniformSourceLocale: string;
11
+ uniformTargetLocale: string;
12
+ uniformReleaseId?: string;
13
+ targetLang: string;
14
+ entityType: EntityType;
15
+ entity: {
16
+ id: string;
17
+ slug: string | null | undefined;
18
+ };
19
+ };
20
+ components: {
21
+ [componentId: string]: ComponentTranslationPayload | undefined;
22
+ };
23
+ custom?: Record<string, unknown>;
24
+ };
25
+ type EntityTranslationResult<TResult = unknown> = {
26
+ result?: TResult;
27
+ updated: boolean;
28
+ errorKind?: 'unknown' | 'invalid-args' | 'project-id-mismatch' | 'entity-id-mismatch' | 'entity-locales-mismatch';
29
+ errorText?: string;
30
+ };
31
+ type MaybePromise<T> = T | Promise<T> | PromiseLike<T>;
32
+
33
+ type CollectTranslationPayloadResult = {
34
+ payload?: TranslationPayload;
35
+ errorKind?: 'unknown' | 'invalid-args' | 'entity-source-locale-missing';
36
+ errorText?: string;
37
+ };
38
+ declare const collectTranslationPayload: ({ uniformProjectId, uniformSourceLocale, uniformTargetLocale, uniformReleaseId, targetLang, entity, entityType, }: {
39
+ uniformProjectId: string;
40
+ uniformSourceLocale: string;
41
+ uniformTargetLocale: string;
42
+ uniformReleaseId: string | undefined;
43
+ targetLang: string;
44
+ entity: RootComponentInstance | EntryData;
45
+ entityType: EntityType;
46
+ }) => CollectTranslationPayloadResult;
47
+
48
+ declare const getCompositionForTranslation: ({ canvasClient, compositionId, releaseId, state, }: {
49
+ canvasClient: CanvasClient;
50
+ compositionId: string;
51
+ releaseId?: string;
52
+ state?: number;
53
+ }) => Promise<CompositionGetResponse | undefined>;
54
+
55
+ declare const getEntryForTranslation: ({ contentClient, entryId, releaseId, pattern, state, }: {
56
+ contentClient: ContentClient;
57
+ entryId: string;
58
+ releaseId?: string;
59
+ pattern?: boolean;
60
+ state?: number;
61
+ }) => Promise<Entry | undefined>;
62
+
63
+ type MergeCompositionTranslationToUniformOptions = {
64
+ canvasClient: CanvasClient;
65
+ translationPayload: TranslationPayload;
66
+ updateComposition?: (args: {
67
+ canvasClient: CanvasClient;
68
+ translationPayload: TranslationPayload;
69
+ composition: Parameters<CanvasClient['updateComposition']>[0];
70
+ }) => MaybePromise<boolean>;
71
+ onNotFound?: (args: {
72
+ translationPayload: TranslationPayload;
73
+ }) => MaybePromise<void>;
74
+ onNotTranslatedResult?: (status: Pick<EntityTranslationResult, 'updated' | 'errorKind' | 'errorText'>) => MaybePromise<void>;
75
+ };
76
+ declare const mergeCompositionTranslationToUniform: ({ canvasClient, translationPayload, updateComposition, onNotFound, onNotTranslatedResult, }: MergeCompositionTranslationToUniformOptions) => Promise<{
77
+ translationMerged: boolean;
78
+ entityId?: string;
79
+ }>;
80
+
81
+ type MergeEntryTranslationToUniformOptions = {
82
+ contentClient: ContentClient;
83
+ translationPayload: TranslationPayload;
84
+ updateEntry?: (args: {
85
+ contentClient: ContentClient;
86
+ translationPayload: TranslationPayload;
87
+ entry: Parameters<ContentClient['upsertEntry']>[0];
88
+ }) => MaybePromise<boolean>;
89
+ onNotFound?: (args: {
90
+ translationPayload: TranslationPayload;
91
+ }) => MaybePromise<void>;
92
+ onNotTranslatedResult?: (status: Pick<EntityTranslationResult, 'updated' | 'errorKind' | 'errorText'>) => MaybePromise<void>;
93
+ };
94
+ declare const mergeEntryTranslationToUniform: ({ contentClient, translationPayload, updateEntry, onNotFound, onNotTranslatedResult, }: MergeEntryTranslationToUniformOptions) => Promise<{
95
+ translationMerged: boolean;
96
+ entityId?: string;
97
+ }>;
98
+
99
+ type MergeTranslationToUniformOptions = {
100
+ translationPayload: TranslationPayload;
101
+ onNotFound?: (args: {
102
+ translationPayload: TranslationPayload;
103
+ }) => MaybePromise<void>;
104
+ onNotTranslatedResult?: (status: Pick<EntityTranslationResult, 'updated' | 'errorKind' | 'errorText'>) => MaybePromise<void>;
105
+ } & Pick<MergeEntryTranslationToUniformOptions, 'contentClient' | 'updateEntry'> & Pick<MergeCompositionTranslationToUniformOptions, 'canvasClient' | 'updateComposition'>;
106
+ declare const mergeTranslationToUniform: ({ canvasClient, contentClient, translationPayload, updateComposition, updateEntry, onNotFound, onNotTranslatedResult, }: MergeTranslationToUniformOptions) => Promise<{
107
+ translationMerged: boolean;
108
+ entityId?: string;
109
+ }>;
110
+
111
+ declare const translateComposition: ({ composition, translationPayload, }: {
112
+ composition: CompositionGetResponse;
113
+ translationPayload: TranslationPayload;
114
+ }) => EntityTranslationResult<CompositionGetResponse>;
115
+
116
+ declare const translateEntry: ({ entry, translationPayload, }: {
117
+ entry: Entry;
118
+ translationPayload: TranslationPayload;
119
+ }) => EntityTranslationResult<Entry>;
120
+
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 };
package/dist/index.d.ts ADDED
@@ -0,0 +1,121 @@
1
+ import { ComponentInstance, RootComponentInstance, EntryData, CanvasClient, CompositionGetResponse, ContentClient, Entry } from '@uniformdev/canvas';
2
+ import { CanvasEditorEntityType } from '@uniformdev/mesh-sdk';
3
+
4
+ type ComponentTranslationPayload = Pick<ComponentInstance, '_id' | 'type' | 'parameters' | 'slots' | '_overrides'>;
5
+ type EntityType = CanvasEditorEntityType;
6
+ type TranslationPayload = {
7
+ schemaVersion: number;
8
+ metadata: {
9
+ uniformProjectId: string;
10
+ uniformSourceLocale: string;
11
+ uniformTargetLocale: string;
12
+ uniformReleaseId?: string;
13
+ targetLang: string;
14
+ entityType: EntityType;
15
+ entity: {
16
+ id: string;
17
+ slug: string | null | undefined;
18
+ };
19
+ };
20
+ components: {
21
+ [componentId: string]: ComponentTranslationPayload | undefined;
22
+ };
23
+ custom?: Record<string, unknown>;
24
+ };
25
+ type EntityTranslationResult<TResult = unknown> = {
26
+ result?: TResult;
27
+ updated: boolean;
28
+ errorKind?: 'unknown' | 'invalid-args' | 'project-id-mismatch' | 'entity-id-mismatch' | 'entity-locales-mismatch';
29
+ errorText?: string;
30
+ };
31
+ type MaybePromise<T> = T | Promise<T> | PromiseLike<T>;
32
+
33
+ type CollectTranslationPayloadResult = {
34
+ payload?: TranslationPayload;
35
+ errorKind?: 'unknown' | 'invalid-args' | 'entity-source-locale-missing';
36
+ errorText?: string;
37
+ };
38
+ declare const collectTranslationPayload: ({ uniformProjectId, uniformSourceLocale, uniformTargetLocale, uniformReleaseId, targetLang, entity, entityType, }: {
39
+ uniformProjectId: string;
40
+ uniformSourceLocale: string;
41
+ uniformTargetLocale: string;
42
+ uniformReleaseId: string | undefined;
43
+ targetLang: string;
44
+ entity: RootComponentInstance | EntryData;
45
+ entityType: EntityType;
46
+ }) => CollectTranslationPayloadResult;
47
+
48
+ declare const getCompositionForTranslation: ({ canvasClient, compositionId, releaseId, state, }: {
49
+ canvasClient: CanvasClient;
50
+ compositionId: string;
51
+ releaseId?: string;
52
+ state?: number;
53
+ }) => Promise<CompositionGetResponse | undefined>;
54
+
55
+ declare const getEntryForTranslation: ({ contentClient, entryId, releaseId, pattern, state, }: {
56
+ contentClient: ContentClient;
57
+ entryId: string;
58
+ releaseId?: string;
59
+ pattern?: boolean;
60
+ state?: number;
61
+ }) => Promise<Entry | undefined>;
62
+
63
+ type MergeCompositionTranslationToUniformOptions = {
64
+ canvasClient: CanvasClient;
65
+ translationPayload: TranslationPayload;
66
+ updateComposition?: (args: {
67
+ canvasClient: CanvasClient;
68
+ translationPayload: TranslationPayload;
69
+ composition: Parameters<CanvasClient['updateComposition']>[0];
70
+ }) => MaybePromise<boolean>;
71
+ onNotFound?: (args: {
72
+ translationPayload: TranslationPayload;
73
+ }) => MaybePromise<void>;
74
+ onNotTranslatedResult?: (status: Pick<EntityTranslationResult, 'updated' | 'errorKind' | 'errorText'>) => MaybePromise<void>;
75
+ };
76
+ declare const mergeCompositionTranslationToUniform: ({ canvasClient, translationPayload, updateComposition, onNotFound, onNotTranslatedResult, }: MergeCompositionTranslationToUniformOptions) => Promise<{
77
+ translationMerged: boolean;
78
+ entityId?: string;
79
+ }>;
80
+
81
+ type MergeEntryTranslationToUniformOptions = {
82
+ contentClient: ContentClient;
83
+ translationPayload: TranslationPayload;
84
+ updateEntry?: (args: {
85
+ contentClient: ContentClient;
86
+ translationPayload: TranslationPayload;
87
+ entry: Parameters<ContentClient['upsertEntry']>[0];
88
+ }) => MaybePromise<boolean>;
89
+ onNotFound?: (args: {
90
+ translationPayload: TranslationPayload;
91
+ }) => MaybePromise<void>;
92
+ onNotTranslatedResult?: (status: Pick<EntityTranslationResult, 'updated' | 'errorKind' | 'errorText'>) => MaybePromise<void>;
93
+ };
94
+ declare const mergeEntryTranslationToUniform: ({ contentClient, translationPayload, updateEntry, onNotFound, onNotTranslatedResult, }: MergeEntryTranslationToUniformOptions) => Promise<{
95
+ translationMerged: boolean;
96
+ entityId?: string;
97
+ }>;
98
+
99
+ type MergeTranslationToUniformOptions = {
100
+ translationPayload: TranslationPayload;
101
+ onNotFound?: (args: {
102
+ translationPayload: TranslationPayload;
103
+ }) => MaybePromise<void>;
104
+ onNotTranslatedResult?: (status: Pick<EntityTranslationResult, 'updated' | 'errorKind' | 'errorText'>) => MaybePromise<void>;
105
+ } & Pick<MergeEntryTranslationToUniformOptions, 'contentClient' | 'updateEntry'> & Pick<MergeCompositionTranslationToUniformOptions, 'canvasClient' | 'updateComposition'>;
106
+ declare const mergeTranslationToUniform: ({ canvasClient, contentClient, translationPayload, updateComposition, updateEntry, onNotFound, onNotTranslatedResult, }: MergeTranslationToUniformOptions) => Promise<{
107
+ translationMerged: boolean;
108
+ entityId?: string;
109
+ }>;
110
+
111
+ declare const translateComposition: ({ composition, translationPayload, }: {
112
+ composition: CompositionGetResponse;
113
+ translationPayload: TranslationPayload;
114
+ }) => EntityTranslationResult<CompositionGetResponse>;
115
+
116
+ declare const translateEntry: ({ entry, translationPayload, }: {
117
+ entry: Entry;
118
+ translationPayload: TranslationPayload;
119
+ }) => EntityTranslationResult<Entry>;
120
+
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 };