@lokalise/tm-sdk 10.0.0 → 10.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/README.md
CHANGED
|
@@ -33,9 +33,16 @@ const client = new TranslationMemoryClient({
|
|
|
33
33
|
To create new records, call `upsertRecords()` method:
|
|
34
34
|
|
|
35
35
|
```typescript
|
|
36
|
+
const requestContext = {
|
|
37
|
+
reqId: randomUUID(),
|
|
38
|
+
logger: globalLogger,
|
|
39
|
+
}
|
|
40
|
+
const ownerGroupId = {
|
|
41
|
+
ownerId: randomUUID(), // must be UUID
|
|
42
|
+
groupId: 'my-group-id'
|
|
43
|
+
}
|
|
36
44
|
const records = [
|
|
37
45
|
{
|
|
38
|
-
ownerId: '018dac6e-bff7-689a-f0ba-e84f49c5e432',
|
|
39
46
|
sourceLocale: 'en',
|
|
40
47
|
targetLocale: 'de',
|
|
41
48
|
sourcePrevContent: 'Localization meets AI',
|
|
@@ -45,12 +52,18 @@ const records = [
|
|
|
45
52
|
'Save money, speed up your market entry, and charm customers in every language.',
|
|
46
53
|
},
|
|
47
54
|
]
|
|
48
|
-
|
|
55
|
+
|
|
56
|
+
client.upsertRecords(requestContext, ownerGroupId, records)
|
|
49
57
|
```
|
|
50
58
|
|
|
51
59
|
To search for exact matching records, you can use `findMatches()` API.
|
|
52
60
|
|
|
53
61
|
```typescript
|
|
62
|
+
const requestContext = {
|
|
63
|
+
reqId: randomUUID(),
|
|
64
|
+
logger: globalLogger,
|
|
65
|
+
}
|
|
66
|
+
const ownerId = randomUUID()
|
|
54
67
|
const searchRequest = {
|
|
55
68
|
sourceText: 'Your one-stop solution for AI-powered translations and automated localization.',
|
|
56
69
|
sourceLocale: 'en',
|
|
@@ -63,7 +76,7 @@ const searchRequest = {
|
|
|
63
76
|
* targetText: 'Ihre Lösung aus einer Hand für KI-gestützte Übersetzungen.'
|
|
64
77
|
* }]
|
|
65
78
|
*/
|
|
66
|
-
const matches = client.findMatches(
|
|
79
|
+
const matches = client.findMatches(requestContext, ownerId, searchRequest)
|
|
67
80
|
```
|
|
68
81
|
|
|
69
82
|
You can also use `bulkFindMatches()` and `bulkFindMatchesIterative()` APIs to perform the same kind of lookup for
|
|
@@ -18,10 +18,11 @@ export type TranslationMemoryClientContext = {
|
|
|
18
18
|
export declare class TranslationMemoryClient {
|
|
19
19
|
private readonly maxFindMatchesRequestSize;
|
|
20
20
|
private readonly isEnabled;
|
|
21
|
+
private readonly errorReporter?;
|
|
21
22
|
private readonly httpClient;
|
|
23
|
+
private readonly pathPrefix;
|
|
22
24
|
private readonly headers;
|
|
23
25
|
private readonly retryConfig;
|
|
24
|
-
private readonly errorReporter?;
|
|
25
26
|
constructor(config: TranslationMemoryClientConfig);
|
|
26
27
|
findMatches(context: TranslationMemoryClientContext, ownerId: string, request: FindMatchesRequest): Promise<TranslationMemoryRecord[]>;
|
|
27
28
|
bulkFindMatches(context: TranslationMemoryClientContext, ownerId: string, { filters, options }: BulkFindMatchesRequest): Promise<BulkTranslationMemoryMatches[]>;
|
|
@@ -6,13 +6,17 @@ import { TranslationMemoryClientError } from "./errors/TranslationMemoryClientEr
|
|
|
6
6
|
export class TranslationMemoryClient {
|
|
7
7
|
maxFindMatchesRequestSize = 20;
|
|
8
8
|
isEnabled;
|
|
9
|
+
errorReporter;
|
|
9
10
|
httpClient;
|
|
11
|
+
pathPrefix;
|
|
10
12
|
headers;
|
|
11
13
|
retryConfig;
|
|
12
|
-
errorReporter;
|
|
13
14
|
constructor(config) {
|
|
14
15
|
this.isEnabled = config.isEnabled ?? true;
|
|
15
|
-
|
|
16
|
+
const parsedUrl = new URL(config.baseUrl);
|
|
17
|
+
const baseUrl = parsedUrl.origin;
|
|
18
|
+
this.pathPrefix = parsedUrl.pathname;
|
|
19
|
+
this.httpClient = buildClient(baseUrl);
|
|
16
20
|
this.headers = {
|
|
17
21
|
'Content-Type': 'application/json',
|
|
18
22
|
Authorization: `Bearer ${config.jwtToken}`,
|
|
@@ -38,6 +42,7 @@ export class TranslationMemoryClient {
|
|
|
38
42
|
return [];
|
|
39
43
|
try {
|
|
40
44
|
const response = await sendByGetRoute(this.httpClient, getTranslationMemoryMatchesContract, {
|
|
45
|
+
pathPrefix: this.pathPrefix,
|
|
41
46
|
pathParams: { ownerId },
|
|
42
47
|
headers: this.headers,
|
|
43
48
|
queryParams: transformToKebabCase(request),
|
|
@@ -79,6 +84,7 @@ export class TranslationMemoryClient {
|
|
|
79
84
|
}
|
|
80
85
|
try {
|
|
81
86
|
const response = await sendByGetRoute(this.httpClient, getTranslationMemoryRecordsContract, {
|
|
87
|
+
pathPrefix: this.pathPrefix,
|
|
82
88
|
pathParams: { ownerId },
|
|
83
89
|
queryParams: transformToKebabCase(query) ?? {},
|
|
84
90
|
headers: this.headers,
|
|
@@ -104,6 +110,7 @@ export class TranslationMemoryClient {
|
|
|
104
110
|
return;
|
|
105
111
|
try {
|
|
106
112
|
await sendByPayloadRoute(this.httpClient, putTranslationMemoryRecordsContract, {
|
|
113
|
+
pathPrefix: this.pathPrefix,
|
|
107
114
|
pathParams: ownerGroupId,
|
|
108
115
|
body: recordsToInsert,
|
|
109
116
|
headers: this.headers,
|
|
@@ -127,6 +134,7 @@ export class TranslationMemoryClient {
|
|
|
127
134
|
return;
|
|
128
135
|
try {
|
|
129
136
|
await sendByPayloadRoute(this.httpClient, postDeleteTranslationMemoryRecordsContract, {
|
|
137
|
+
pathPrefix: this.pathPrefix,
|
|
130
138
|
pathParams: { ownerId },
|
|
131
139
|
body: { recordIds },
|
|
132
140
|
headers: this.headers,
|
|
@@ -163,6 +171,7 @@ export class TranslationMemoryClient {
|
|
|
163
171
|
}
|
|
164
172
|
try {
|
|
165
173
|
const response = await sendByPayloadRoute(this.httpClient, postBulkFindMatchesContract, {
|
|
174
|
+
pathPrefix: this.pathPrefix,
|
|
166
175
|
pathParams: { ownerId },
|
|
167
176
|
body: request,
|
|
168
177
|
headers: this.headers,
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"TranslationMemoryClient.js","sourceRoot":"","sources":["../../src/sdk/TranslationMemoryClient.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,WAAW,EACX,qBAAqB,EACrB,cAAc,EACd,kBAAkB,GACnB,MAAM,+BAA+B,CAAA;AAEtC,OAAO,EAAsB,aAAa,EAAE,MAAM,qBAAqB,CAAA;AAEvE,OAAO,EAEL,mCAAmC,EACnC,mCAAmC,EACnC,2BAA2B,EAC3B,0CAA0C,EAC1C,mCAAmC,GAIpC,MAAM,0BAA0B,CAAA;AACjC,OAAO,EAAE,KAAK,EAAE,oBAAoB,EAAE,MAAM,mCAAmC,CAAA;AAG/E,OAAO,EAAE,4BAA4B,EAAE,MAAM,0CAA0C,CAAA;AAqBvF,MAAM,OAAO,uBAAuB;IACjB,yBAAyB,GAAG,EAAE,CAAA;IAE9B,SAAS,CAAS;IAClB,UAAU,CAAQ;IAClB,OAAO,CAAyB;IAChC,WAAW,CAAa;
|
|
1
|
+
{"version":3,"file":"TranslationMemoryClient.js","sourceRoot":"","sources":["../../src/sdk/TranslationMemoryClient.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,WAAW,EACX,qBAAqB,EACrB,cAAc,EACd,kBAAkB,GACnB,MAAM,+BAA+B,CAAA;AAEtC,OAAO,EAAsB,aAAa,EAAE,MAAM,qBAAqB,CAAA;AAEvE,OAAO,EAEL,mCAAmC,EACnC,mCAAmC,EACnC,2BAA2B,EAC3B,0CAA0C,EAC1C,mCAAmC,GAIpC,MAAM,0BAA0B,CAAA;AACjC,OAAO,EAAE,KAAK,EAAE,oBAAoB,EAAE,MAAM,mCAAmC,CAAA;AAG/E,OAAO,EAAE,4BAA4B,EAAE,MAAM,0CAA0C,CAAA;AAqBvF,MAAM,OAAO,uBAAuB;IACjB,yBAAyB,GAAG,EAAE,CAAA;IAE9B,SAAS,CAAS;IAClB,aAAa,CAAgB;IAE7B,UAAU,CAAQ;IAClB,UAAU,CAAQ;IAClB,OAAO,CAAyB;IAChC,WAAW,CAAa;IAEzC,YAAY,MAAqC;QAC/C,IAAI,CAAC,SAAS,GAAG,MAAM,CAAC,SAAS,IAAI,IAAI,CAAA;QAEzC,MAAM,SAAS,GAAG,IAAI,GAAG,CAAC,MAAM,CAAC,OAAO,CAAC,CAAA;QACzC,MAAM,OAAO,GAAG,SAAS,CAAC,MAAM,CAAA;QAChC,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC,QAAQ,CAAA;QACpC,IAAI,CAAC,UAAU,GAAG,WAAW,CAAC,OAAO,CAAC,CAAA;QAEtC,IAAI,CAAC,OAAO,GAAG;YACb,cAAc,EAAE,kBAAkB;YAClC,aAAa,EAAE,UAAU,MAAM,CAAC,QAAQ,EAAE;SAC3C,CAAA;QACD,IAAI,CAAC,WAAW,GAAG;YACjB,cAAc,EAAE,KAAK;YACrB,WAAW,EAAE,CAAC;YACd,2BAA2B,EAAE,GAAG;YAChC,kBAAkB,EAAE;gBAClB,GAAG,EAAE,kBAAkB;gBACvB,GAAG,EAAE,sBAAsB;gBAC3B,GAAG,EAAE,oBAAoB;gBACzB,GAAG,EAAE,wBAAwB;gBAC7B,GAAG,EAAE,sBAAsB;gBAC3B,GAAG,EAAE,mBAAmB;aACzB;YACD,GAAG,MAAM,CAAC,WAAW;SACtB,CAAA;QACD,IAAI,CAAC,aAAa,GAAG,MAAM,CAAC,aAAa,CAAA;IAC3C,CAAC;IAED,KAAK,CAAC,WAAW,CACf,OAAuC,EACvC,OAAe,EACf,OAA2B;QAE3B,IAAI,CAAC,IAAI,CAAC,SAAS;YAAE,OAAO,EAAE,CAAA;QAE9B,IAAI,CAAC;YACH,MAAM,QAAQ,GAAG,MAAM,cAAc,CACnC,IAAI,CAAC,UAAU,EACf,mCAAmC,EACnC;gBACE,UAAU,EAAE,IAAI,CAAC,UAAU;gBAC3B,UAAU,EAAE,EAAE,OAAO,EAAE;gBACvB,OAAO,EAAE,IAAI,CAAC,OAAO;gBACrB,WAAW,EAAE,oBAAoB,CAAC,OAAO,CAAC;aAC3C,EACD;gBACE,UAAU,EAAE,OAAO,CAAC,UAAU;gBAC9B,YAAY,EAAE,uBAAuB;gBACrC,WAAW,EAAE,IAAI,CAAC,WAAW;gBAC7B,gBAAgB,EAAE,IAAI;gBACtB,YAAY,EAAE,IAAI;aACnB,CACF,CAAA;YAED,OAAO,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAA;QAClC,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,MAAM,IAAI,CAAC,WAAW,CAAC,CAAC,EAAE,OAAO,CAAC,CAAA;QACpC,CAAC;IACH,CAAC;IAED,KAAK,CAAC,eAAe,CACnB,OAAuC,EACvC,OAAe,EACf,EAAE,OAAO,EAAE,OAAO,EAA0B;QAE5C,MAAM,QAAQ,GAAmC,EAAE,CAAA;QACnD,KAAK,MAAM,IAAI,IAAI,KAAK,CAAC,OAAO,EAAE,IAAI,CAAC,yBAAyB,CAAC,EAAE,CAAC;YAClE,MAAM,eAAe,GAAG,MAAM,IAAI,CAAC,uBAAuB,CAAC,OAAO,EAAE,OAAO,EAAE;gBAC3E,OAAO,EAAE,IAAI;gBACb,OAAO;aACR,CAAC,CAAA;YACF,QAAQ,CAAC,IAAI,CAAC,GAAG,eAAe,CAAC,CAAA;QACnC,CAAC;QAED,OAAO,QAAQ,CAAA;IACjB,CAAC;IAED,KAAK,CAAC,CAAC,wBAAwB,CAC7B,OAAuC,EACvC,OAAe,EACf,EAAE,OAAO,EAAE,OAAO,EAA0B;QAE5C,KAAK,MAAM,IAAI,IAAI,KAAK,CAAC,OAAO,EAAE,IAAI,CAAC,yBAAyB,CAAC,EAAE,CAAC;YAClE,MAAM,MAAM,IAAI,CAAC,uBAAuB,CAAC,OAAO,EAAE,OAAO,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC,CAAA;QACxF,CAAC;IACH,CAAC;IAED,KAAK,CAAC,UAAU,CACd,OAAuC,EACvC,OAAe,EACf,KAAuB;QAEvB,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC;YACpB,OAAO;gBACL,OAAO,EAAE,EAAE;gBACX,IAAI,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE;aACnB,CAAA;QACH,CAAC;QAED,IAAI,CAAC;YACH,MAAM,QAAQ,GAAG,MAAM,cAAc,CACnC,IAAI,CAAC,UAAU,EACf,mCAAmC,EACnC;gBACE,UAAU,EAAE,IAAI,CAAC,UAAU;gBAC3B,UAAU,EAAE,EAAE,OAAO,EAAE;gBACvB,WAAW,EAAE,oBAAoB,CAAC,KAAK,CAAC,IAAI,EAAE;gBAC9C,OAAO,EAAE,IAAI,CAAC,OAAO;aACtB,EACD;gBACE,UAAU,EAAE,OAAO,CAAC,UAAU;gBAC9B,YAAY,EAAE,sBAAsB;gBACpC,WAAW,EAAE,IAAI,CAAC,WAAW;gBAC7B,gBAAgB,EAAE,IAAI;gBACtB,YAAY,EAAE,IAAI;aACnB,CACF,CAAA;YAED,OAAO,EAAE,OAAO,EAAE,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,EAAE,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,CAAA;QAChF,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,MAAM,IAAI,CAAC,WAAW,CAAC,CAAC,EAAE,OAAO,CAAC,CAAA;QACpC,CAAC;IACH,CAAC;IAED,KAAK,CAAC,aAAa,CACjB,OAAuC,EACvC,YAA4B,EAC5B,OAA2C;QAE3C,IAAI,CAAC,IAAI,CAAC,SAAS;YAAE,OAAM;QAE3B,iCAAiC;QACjC,MAAM,eAAe,GAAG,OAAO,CAAC,MAAM,CACpC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,UAAU,CAAC,IAAI,EAAE,CAAC,MAAM,GAAG,CAAC,IAAI,MAAM,CAAC,UAAU,CAAC,IAAI,EAAE,CAAC,MAAM,GAAG,CAAC,CACvF,CAAA;QACD,IAAI,eAAe,CAAC,MAAM,KAAK,CAAC;YAAE,OAAM;QAExC,IAAI,CAAC;YACH,MAAM,kBAAkB,CACtB,IAAI,CAAC,UAAU,EACf,mCAAmC,EACnC;gBACE,UAAU,EAAE,IAAI,CAAC,UAAU;gBAC3B,UAAU,EAAE,YAAY;gBACxB,IAAI,EAAE,eAAe;gBACrB,OAAO,EAAE,IAAI,CAAC,OAAO;aACtB,EACD;gBACE,UAAU,EAAE,OAAO,CAAC,UAAU;gBAC9B,YAAY,EAAE,mCAAmC;gBACjD,WAAW,EAAE,IAAI,CAAC,WAAW;gBAC7B,gBAAgB,EAAE,IAAI;gBACtB,YAAY,EAAE,IAAI;aACnB,CACF,CAAA;QACH,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,MAAM,IAAI,CAAC,WAAW,CAAC,CAAC,EAAE,OAAO,CAAC,CAAA;QACpC,CAAC;IACH,CAAC;IAED,KAAK,CAAC,aAAa,CACjB,OAAuC,EACvC,OAAe,EACf,SAAmB;QAEnB,IAAI,CAAC,IAAI,CAAC,SAAS;YAAE,OAAM;QAE3B,+BAA+B;QAC/B,IAAI,SAAS,CAAC,MAAM,KAAK,CAAC;YAAE,OAAM;QAElC,IAAI,CAAC;YACH,MAAM,kBAAkB,CACtB,IAAI,CAAC,UAAU,EACf,0CAA0C,EAC1C;gBACE,UAAU,EAAE,IAAI,CAAC,UAAU;gBAC3B,UAAU,EAAE,EAAE,OAAO,EAAE;gBACvB,IAAI,EAAE,EAAE,SAAS,EAAE;gBACnB,OAAO,EAAE,IAAI,CAAC,OAAO;aACtB,EACD;gBACE,UAAU,EAAE,OAAO,CAAC,UAAU;gBAC9B,YAAY,EAAE,yBAAyB;gBACvC,WAAW,EAAE,IAAI,CAAC,WAAW;gBAC7B,gBAAgB,EAAE,IAAI;gBACtB,YAAY,EAAE,IAAI;aACnB,CACF,CAAA;QACH,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,MAAM,IAAI,CAAC,WAAW,CAAC,CAAC,EAAE,OAAO,CAAC,CAAA;QACpC,CAAC;IACH,CAAC;IAEO,KAAK,CAAC,uBAAuB,CACnC,OAAuC,EACvC,OAAe,EACf,OAA+B;QAE/B,MAAM,MAAM,GAAmC,EAAE,CAAA;QACjD,IAAI,CAAC,IAAI,CAAC,SAAS;YAAE,OAAO,MAAM,CAAA;QAElC,IAAI,OAAO,CAAC,OAAO,EAAE,kBAAkB,EAAE,CAAC;YACxC,MAAM,EAAE,YAAY,EAAE,eAAe,EAAE,GAAG,OAAO,CAAC,OAAO,CAAC,MAAM,CAC9D,CAAC,GAAG,EAAE,MAAM,EAAE,EAAE;gBACd,MAAM,IAAI,GACR,MAAM,CAAC,UAAU,CAAC,IAAI,EAAE,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC,CAAC,GAAG,CAAC,eAAe,CAAA;gBAChF,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;gBACjB,OAAO,GAAG,CAAA;YACZ,CAAC,EACD;gBACE,YAAY,EAAE,EAA6B;gBAC3C,eAAe,EAAE,EAA6B;aAC/C,CACF,CAAA;YAED,MAAM,CAAC,IAAI,CACT,GAAG,YAAY,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;gBAC/B,QAAQ,EAAE,MAAM,CAAC,QAAQ;gBACzB,OAAO,EAAE,EAAE;aACZ,CAAC,CAAC,CACJ,CAAA;YACD,OAAO,CAAC,OAAO,GAAG,eAAe,CAAA;QACnC,CAAC;QAED,IAAI,CAAC;YACH,MAAM,QAAQ,GAAG,MAAM,kBAAkB,CACvC,IAAI,CAAC,UAAU,EACf,2BAA2B,EAC3B;gBACE,UAAU,EAAE,IAAI,CAAC,UAAU;gBAC3B,UAAU,EAAE,EAAE,OAAO,EAAE;gBACvB,IAAI,EAAE,OAAO;gBACb,OAAO,EAAE,IAAI,CAAC,OAAO;aACtB,EACD;gBACE,UAAU,EAAE,OAAO,CAAC,UAAU;gBAC9B,YAAY,EAAE,4BAA4B;gBAC1C,WAAW,EAAE,IAAI,CAAC,WAAW;gBAC7B,gBAAgB,EAAE,IAAI;gBACtB,YAAY,EAAE,IAAI;aACnB,CACF,CAAA;YACD,MAAM,CAAC,IAAI,CAAC,GAAG,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;YACzC,OAAO,MAAM,CAAA;QACf,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,MAAM,IAAI,CAAC,WAAW,CAAC,CAAC,EAAE,OAAO,CAAC,CAAA;QACpC,CAAC;IACH,CAAC;IAEO,WAAW,CAAC,CAAU,EAAE,OAAuC;QACrE,IAAI,KAAwB,CAAA;QAC5B,IAAI,CAAC,YAAY,KAAK,EAAE,CAAC;YACvB,KAAK,GAAG,qBAAqB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,4BAA4B,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;QAC5E,CAAC;aAAM,CAAC;YACN,KAAK,GAAG,IAAI,aAAa,CAAC;gBACxB,OAAO,EAAE,eAAe;gBACxB,SAAS,EAAE,eAAe;gBAC1B,OAAO,EAAE,EAAE,KAAK,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE;aACtC,CAAC,CAAA;QACJ,CAAC;QAED,IAAI,CAAC,aAAa,EAAE,MAAM,CAAC;YACzB,KAAK;YACL,OAAO,EAAE;gBACP,KAAK,EAAE,OAAO,CAAC,UAAU,EAAE,KAAK;gBAChC,GAAG,OAAO,CAAC,QAAQ;aACpB;SACF,CAAC,CAAA;QACF,OAAO,KAAK,CAAA;IACd,CAAC;CACF"}
|