@labeleer/api 1.0.2 → 1.0.3

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.
@@ -1,22 +1,59 @@
1
1
  // This file is auto-generated by @hey-api/openapi-ts
2
2
  import * as z from 'zod';
3
+ export const zBooleanish = z.boolean().default(false);
4
+ export const zCreateCommentRequestBody = z.object({
5
+ projectId: z.string(),
6
+ keyId: z.string(),
7
+ comment: z.string().min(1).max(1024),
8
+ commentId: z.string(),
9
+ });
10
+ export const zDeleteCommentRequestQuery = z.object({
11
+ commentId: z.string(),
12
+ projectId: z.string(),
13
+ });
14
+ export const zDeleteTranslationRequestQuery = z.object({
15
+ projectId: z.string(),
16
+ keyId: z.string(),
17
+ });
18
+ export const zDeleteTranslationsRequestBody = z.object({
19
+ projectId: z.string(),
20
+ keys: z.array(z.string()).min(1),
21
+ });
3
22
  export const zErrorResponse = z.object({
4
23
  error: z.string(),
5
24
  details: z.string().optional(),
6
25
  });
7
- export const zSuccessResponse = z.object({
8
- success: z.boolean(),
26
+ export const zGetCommentsRequestQuery = z.object({
27
+ projectId: z.string(),
28
+ keyId: z.string(),
29
+ });
30
+ export const zGetLocalesRequestQuery = z.object({
31
+ projectId: z.string(),
32
+ });
33
+ export const zGetTranslationRequestQuery = z.object({
34
+ projectId: z.string(),
35
+ keyId: z.string(),
36
+ });
37
+ export const zGetTranslationTagsRequestQuery = z.object({
38
+ projectId: z.string(),
39
+ keyId: z.string(),
40
+ });
41
+ export const zInvitationProject = z.object({
42
+ id: z.string(),
43
+ name: z.string(),
44
+ description: z.string().optional(),
45
+ });
46
+ export const zInvitedBy = z.object({
47
+ user_id: z.string(),
48
+ name: z.string(),
49
+ thumbnail_url: z.string().optional(),
50
+ email: z.string(),
51
+ });
52
+ export const zInviteUserRequestBody = z.object({
53
+ email: z
54
+ .email()
55
+ .regex(/^(?:[A-Za-z0-9_'+\-]+\.)*[A-Za-z0-9_'+\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$/),
9
56
  });
10
- export const zPermissionCategory = z.enum([
11
- 'translations',
12
- 'languages',
13
- 'collaborators',
14
- 'project',
15
- ]);
16
- export const zPermissionRole = z.enum(['viewer', 'editor']);
17
- export const zProjectPermissions = z.record(z.string(), zPermissionRole);
18
- export const zRole = z.enum(['owner', 'collaborator']);
19
- export const zProjectFeature = z.enum(['auto-translate', 'suggestions']);
20
57
  export const zLocale = z.enum([
21
58
  'af_ZA',
22
59
  'am_ET',
@@ -165,9 +202,49 @@ export const zLocale = z.enum([
165
202
  'yi_DE',
166
203
  'tr_TR',
167
204
  ]);
168
- export const zTimestamp = z.iso
169
- .datetime()
170
- .regex(/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$/);
205
+ export const zCreateLocaleRequestBody = z.object({
206
+ projectId: z.string(),
207
+ locale: zLocale,
208
+ });
209
+ export const zCreateProjectRequestBody = z.object({
210
+ name: z.string().min(1).max(50),
211
+ description: z.string().max(200).optional(),
212
+ locales: z.array(zLocale).optional(),
213
+ });
214
+ export const zDeleteLocaleRequestBody = z.object({
215
+ projectId: z.string(),
216
+ locale: zLocale,
217
+ });
218
+ export const zGenerateTranslationsRequestQuery = z.object({
219
+ project_id: z.string(),
220
+ key: z.string(),
221
+ from_locale: zLocale,
222
+ to_locale: zLocale,
223
+ });
224
+ export const zLanguageItem = z.object({
225
+ id: z.string(),
226
+ locale: zLocale,
227
+ is_reference: z.boolean(),
228
+ });
229
+ export const zCreateLocaleResponse = z.object({
230
+ data: z.array(zLanguageItem),
231
+ });
232
+ export const zGetLocaleResponse = z.object({
233
+ data: z.array(zLanguageItem),
234
+ });
235
+ export const zPagination = z.object({
236
+ offset: z.number(),
237
+ count: z.number(),
238
+ total_count: z.number(),
239
+ has_next: z.boolean(),
240
+ });
241
+ export const zPermissionCategory = z.enum([
242
+ 'translations',
243
+ 'languages',
244
+ 'collaborators',
245
+ 'project',
246
+ ]);
247
+ export const zPermissionRole = z.enum(['viewer', 'editor']);
171
248
  export const zPlurality = z.enum([
172
249
  'zero',
173
250
  'one',
@@ -176,17 +253,15 @@ export const zPlurality = z.enum([
176
253
  'many',
177
254
  'other',
178
255
  ]);
179
- export const zPagination = z.object({
180
- offset: z.number(),
181
- count: z.number(),
182
- totalCount: z.number(),
256
+ export const zProjectFeature = z.enum(['auto-translate', 'suggestions']);
257
+ export const zProjectPermissions = z.record(z.string(), zPermissionRole);
258
+ export const zCreateAccessTokenRequestBody = z.object({
259
+ permissions: zProjectPermissions,
183
260
  });
184
- export const zUser = z.object({
185
- id: z.string(),
186
- name: z.string(),
187
- email: z.string(),
188
- thumbnail_url: z.url().optional(),
261
+ export const zGetUserPermissionsResponse = z.object({
262
+ data: zProjectPermissions,
189
263
  });
264
+ export const zRole = z.enum(['owner', 'collaborator']);
190
265
  export const zCollaborator = z.object({
191
266
  id: z.string(),
192
267
  name: z.string(),
@@ -194,6 +269,39 @@ export const zCollaborator = z.object({
194
269
  thumbnail_url: z.url().optional(),
195
270
  role: zRole,
196
271
  });
272
+ export const zSuccessResponse = z.object({
273
+ success: z.boolean(),
274
+ });
275
+ export const zTimestamp = z.iso
276
+ .datetime()
277
+ .regex(/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$/);
278
+ export const zComment = z.object({
279
+ id: z.string(),
280
+ key_id: z.string(),
281
+ project_id: z.string(),
282
+ created_on: zTimestamp,
283
+ edited_on: zTimestamp.optional(),
284
+ user: z.object({
285
+ id: z.string(),
286
+ name: z.string(),
287
+ email: z.string(),
288
+ thumbnail_url: z.string().optional(),
289
+ }),
290
+ content: z.string(),
291
+ });
292
+ export const zGetCommentsResponse = z.object({
293
+ data: z.array(zComment),
294
+ });
295
+ export const zInvitation = z.object({
296
+ id: z.string(),
297
+ role: zRole,
298
+ invited_on: zTimestamp,
299
+ project: zInvitationProject,
300
+ invited_by: zInvitedBy,
301
+ });
302
+ export const zGetInvitationsResponse = z.object({
303
+ data: z.array(zInvitation),
304
+ });
197
305
  export const zProject = z.object({
198
306
  id: z.string(),
199
307
  description: z.string().optional(),
@@ -205,41 +313,52 @@ export const zProject = z.object({
205
313
  created_by: zCollaborator,
206
314
  users: z.array(zCollaborator),
207
315
  });
208
- export const zInvitationProject = z.object({
209
- id: z.string(),
210
- name: z.string(),
211
- description: z.string().optional(),
316
+ export const zCreateProjectResponse = z.object({
317
+ data: zProject,
212
318
  });
213
- export const zInvitedBy = z.object({
214
- user_id: z.string(),
215
- name: z.string(),
216
- thumbnail_url: z.string().optional(),
217
- email: z.string(),
319
+ export const zGetProjectsResponse = z.object({
320
+ data: z.array(zProject),
218
321
  });
219
- export const zInvitation = z.object({
322
+ export const zProjectApiKeyDetails = z.object({
220
323
  id: z.string(),
221
- role: zRole,
222
- invited_on: zTimestamp,
223
- project: zInvitationProject,
224
- invited_by: zInvitedBy,
324
+ name: z.string().optional(),
325
+ start: z.string(),
326
+ enabled: z.boolean(),
327
+ permissions: zProjectPermissions,
328
+ created_on: zTimestamp,
329
+ last_request: zTimestamp.optional(),
330
+ request_count: z.number(),
331
+ expires_on: zTimestamp.optional(),
225
332
  });
226
- export const zTranslationTags = z.array(z.string());
227
- export const zTranslationItem = z.object({
333
+ export const zCreateAccessTokenResponse = z.object({
228
334
  key: z.string(),
229
- key_id: z.string(),
230
- translations: z.record(z.string(), z.string()),
231
- plurals: z.record(z.string(), z.record(z.string(), z.string())),
232
- comment_count: z.number(),
233
- description: z.string().optional(),
234
- tags: zTranslationTags,
335
+ details: zProjectApiKeyDetails,
235
336
  });
337
+ export const zTranslationsExportRequestQuery = z.object({
338
+ projectId: z.string(),
339
+ format: z.enum([
340
+ 'json',
341
+ 'yaml',
342
+ 'ts',
343
+ 'po',
344
+ 'android_strings',
345
+ 'apple_strings',
346
+ 'xliff',
347
+ 'xcstrings',
348
+ ]),
349
+ file_name: z.string().optional(),
350
+ include_tags: zBooleanish.optional(),
351
+ include_untranslated: zBooleanish.optional(),
352
+ include_description: zBooleanish.optional(),
353
+ });
354
+ export const zTranslationTags = z.array(z.string());
236
355
  export const zExtendedTranslationItem = z.object({
237
356
  key: z.string(),
238
357
  key_id: z.string(),
239
358
  translations: z.record(z.string(), z.string()),
240
359
  plurals: z.record(z.string(), z.record(z.string(), z.string())),
241
360
  comment_count: z.number(),
242
- description: z.string().optional(),
361
+ description: z.string().nullish(),
243
362
  tags: zTranslationTags,
244
363
  created_at: zTimestamp,
245
364
  updated_at: zTimestamp.optional(),
@@ -252,6 +371,12 @@ export const zExtendedTranslationItem = z.object({
252
371
  })
253
372
  .optional(),
254
373
  });
374
+ export const zGetTranslationDataResponse = z.object({
375
+ data: zExtendedTranslationItem,
376
+ });
377
+ export const zGetTranslationTagsResponse = z.object({
378
+ data: zTranslationTags,
379
+ });
255
380
  export const zTranslationExportItem = z.object({
256
381
  key: z.string(),
257
382
  tags: zTranslationTags,
@@ -259,125 +384,41 @@ export const zTranslationExportItem = z.object({
259
384
  translations: z.record(z.string(), z.string()),
260
385
  plurals: z.record(z.string(), z.record(z.string(), z.string())),
261
386
  });
262
- export const zLanguageItem = z.object({
263
- id: z.string(),
264
- locale: zLocale,
265
- is_reference: z.boolean(),
266
- });
267
- export const zComment = z.object({
268
- id: z.string(),
387
+ export const zTranslationItem = z.object({
388
+ key: z.string(),
269
389
  key_id: z.string(),
270
- project_id: z.string(),
271
- created_on: zTimestamp,
272
- edited_on: zTimestamp.optional(),
273
- user: z.object({
274
- id: z.string(),
275
- name: z.string(),
276
- email: z.string(),
277
- thumbnail_url: z.string().optional(),
278
- }),
279
- content: z.string(),
390
+ translations: z.record(z.string(), z.string()),
391
+ plurals: z.record(z.string(), z.record(z.string(), z.string())),
392
+ comment_count: z.number(),
393
+ description: z.string().nullish(),
394
+ tags: zTranslationTags,
280
395
  });
281
- export const zProjectApiKeyDetails = z.object({
282
- id: z.string(),
283
- name: z.string().optional(),
284
- start: z.string(),
285
- enabled: z.boolean(),
286
- permissions: zProjectPermissions,
287
- created_on: zTimestamp,
288
- last_request: zTimestamp.optional(),
289
- request_count: z.number(),
290
- expires_on: zTimestamp.optional(),
396
+ export const zGetTranslationsResponse = z.object({
397
+ data: z.array(zTranslationItem),
398
+ pagination: zPagination,
291
399
  });
292
- export const zBooleanish = z.boolean().default(false);
293
- export const zGetInvitationsResponse = z.object({
294
- data: z.array(zInvitation),
400
+ export const zUpdateAccessTokenPermissionsRequestBody = z.object({
401
+ permissions: zProjectPermissions,
295
402
  });
296
- export const zCreateAccessTokenResponse = z.object({
297
- key: z.string(),
403
+ export const zUpdateAccessTokenPermissionsResponse = z.object({
298
404
  details: zProjectApiKeyDetails,
299
405
  });
300
- export const zUpdateAccessTokenResponse = z.object({
301
- details: zProjectApiKeyDetails,
406
+ export const zUpdateInvitationStatusRequestBody = z.object({
407
+ invitationId: z.string(),
408
+ status: z.enum(['accepted', 'declined']),
302
409
  });
303
410
  export const zUpdateProjectResponse = z.object({
304
411
  name: z.string().min(3).max(50),
305
- description: z.string().max(500).optional(),
306
- });
307
- export const zGetUserPermissionsResponse = z.object({
308
- data: zProjectPermissions,
309
- });
310
- export const zUpdateUserPermissionsRequestBody = z.object({
311
- permissions: z.object({
312
- translations: z.enum(['viewer', 'editor']).optional(),
313
- languages: z.enum(['viewer', 'editor']).optional(),
314
- collaborators: z.enum(['viewer', 'editor']).optional(),
315
- project: z.enum(['viewer', 'editor']).optional(),
316
- }),
317
- });
318
- export const zCreateProjectRequest = z.object({
319
- name: z.string().min(1).max(50),
320
- description: z.string().max(500).optional(),
321
- locales: z.array(zLocale).optional(),
322
- });
323
- export const zCreateProjectResponse = z.object({
324
- data: zProject,
325
- });
326
- export const zGetProjectsResponse = z.object({
327
- data: z.array(zProject),
328
- });
329
- export const zGetTranslationDataResponse = z.object({
330
- data: zExtendedTranslationItem,
331
- });
332
- export const zGetTranslationTagsRequest = z.object({
333
- projectId: z.string(),
334
- keyId: z.string(),
335
- });
336
- export const zGetTranslationTagsResponse = z.object({
337
- data: zTranslationTags,
338
- });
339
- export const zUpdateTranslationTagsRequestBody = z.object({
340
- projectId: z.string(),
341
- keyId: z.string(),
342
- tags: z.array(z.string().max(32)).min(1),
343
- });
344
- export const zUpdateTranslationTagsResponse = z.object({
345
- data: zTranslationTags,
346
- });
347
- export const zTranslationsExportRequestQuery = z.object({
348
- projectId: z.string(),
349
- format: z.enum([
350
- 'json',
351
- 'yaml',
352
- 'ts',
353
- 'po',
354
- 'android_strings',
355
- 'apple_strings',
356
- 'xliff',
357
- 'xcstrings',
358
- ]),
359
- file_name: z.string().optional(),
360
- include_tags: zBooleanish.optional(),
361
- include_untranslated: zBooleanish.optional(),
362
- include_description: zBooleanish.optional(),
363
- });
364
- export const zGetLocaleResponse = z.object({
365
- data: z.array(zLanguageItem),
366
- });
367
- export const zCreateLocaleRequestBody = z.object({
368
- projectId: z.string(),
369
- locale: zLocale,
370
- });
371
- export const zCreateLocaleResponse = z.object({
372
- data: z.array(zLanguageItem),
412
+ description: z.string().max(200).optional(),
373
413
  });
374
414
  export const zUpdateReferenceLocaleRequestBody = z.object({
375
415
  projectId: z.string(),
376
416
  locale: zLocale,
377
417
  });
378
- export const zGetTranslationsResponse = z.object({
379
- data: z.array(zTranslationItem),
380
- pagination: zPagination,
418
+ export const zUpdateTranslationRequestBody = z.object({
419
+ projectId: z.string(),
420
+ keyId: z.string(),
421
+ newKeyName: z.string().min(4).max(512),
381
422
  });
382
423
  export const zUpdateTranslationsRequestBody = z.object({
383
424
  projectId: z.string(),
@@ -390,18 +431,28 @@ export const zUpdateTranslationsRequestBody = z.object({
390
431
  .optional(),
391
432
  })),
392
433
  });
393
- export const zDeleteTranslationsRequestBody = z.object({
434
+ export const zUpdateTranslationTagsRequestBody = z.object({
394
435
  projectId: z.string(),
395
- keys: z.array(z.string()).min(1),
436
+ keyId: z.string(),
437
+ tags: z.array(z.string().max(32)).min(1),
438
+ });
439
+ export const zUpdateTranslationTagsResponse = z.object({
440
+ data: zTranslationTags,
441
+ });
442
+ export const zUpdateUserPermissionsRequestBody = z.object({
443
+ permissions: zProjectPermissions,
444
+ });
445
+ export const zUser = z.object({
446
+ id: z.string(),
447
+ name: z.string(),
448
+ email: z.string(),
449
+ thumbnail_url: z.url().optional(),
396
450
  });
397
451
  /**
398
452
  * Ok
399
453
  */
400
454
  export const zGetInvitationsResponse2 = zGetInvitationsResponse;
401
- export const zRespondToInvitationBody = z.object({
402
- invitationId: z.string(),
403
- status: z.enum(['accepted', 'declined']),
404
- });
455
+ export const zRespondToInvitationBody = zUpdateInvitationStatusRequestBody;
405
456
  /**
406
457
  * Resource Created
407
458
  */
@@ -413,29 +464,15 @@ export const zRevokeAccessTokenPath = z.object({
413
464
  * Ok
414
465
  */
415
466
  export const zRevokeAccessTokenResponse = zSuccessResponse;
416
- export const zUpdateAccessTokenBody = z.object({
417
- permissions: z.object({
418
- translations: z.enum(['viewer', 'editor']).optional(),
419
- languages: z.enum(['viewer', 'editor']).optional(),
420
- collaborators: z.enum(['viewer', 'editor']).optional(),
421
- project: z.enum(['viewer', 'editor']).optional(),
422
- }),
423
- });
467
+ export const zUpdateAccessTokenBody = zUpdateAccessTokenPermissionsRequestBody;
424
468
  export const zUpdateAccessTokenPath = z.object({
425
469
  projectId: z.string(),
426
470
  });
427
471
  /**
428
472
  * Ok
429
473
  */
430
- export const zUpdateAccessTokenResponse2 = zUpdateAccessTokenResponse;
431
- export const zCreateAccessTokenBody = z.object({
432
- permissions: z.object({
433
- translations: z.enum(['viewer', 'editor']).optional(),
434
- languages: z.enum(['viewer', 'editor']).optional(),
435
- collaborators: z.enum(['viewer', 'editor']).optional(),
436
- project: z.enum(['viewer', 'editor']).optional(),
437
- }),
438
- });
474
+ export const zUpdateAccessTokenResponse = zUpdateAccessTokenPermissionsResponse;
475
+ export const zCreateAccessTokenBody = zCreateAccessTokenRequestBody;
439
476
  export const zCreateAccessTokenPath = z.object({
440
477
  projectId: z.string(),
441
478
  });
@@ -443,16 +480,12 @@ export const zCreateAccessTokenPath = z.object({
443
480
  * Resource Created
444
481
  */
445
482
  export const zCreateAccessTokenResponse2 = zCreateAccessTokenResponse;
446
- export const zInviteUserToProjectBody = z.object({
447
- email: z
448
- .email()
449
- .regex(/^(?:[A-Za-z0-9_'+\-]+\.)*[A-Za-z0-9_'+\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$/),
450
- });
483
+ export const zInviteUserToProjectBody = zInviteUserRequestBody;
451
484
  export const zInviteUserToProjectPath = z.object({
452
485
  projectId: z.string(),
453
486
  });
454
487
  /**
455
- * Resource Created
488
+ * Ok
456
489
  */
457
490
  export const zInviteUserToProjectResponse = zSuccessResponse;
458
491
  export const zDeleteProjectPath = z.object({
@@ -499,7 +532,7 @@ export const zUpdateUserPermissionsResponse = zSuccessResponse;
499
532
  * Ok
500
533
  */
501
534
  export const zGetProjectsResponse2 = zGetProjectsResponse;
502
- export const zCreateProjectBody = zCreateProjectRequest;
535
+ export const zCreateProjectBody = zCreateProjectRequestBody;
503
536
  /**
504
537
  * Resource Created
505
538
  */
@@ -530,11 +563,7 @@ export const zGetTranslationQuery = z.object({
530
563
  * Ok
531
564
  */
532
565
  export const zGetTranslationResponse = zGetTranslationDataResponse;
533
- export const zRenameTranslationKeyBody = z.object({
534
- projectId: z.string(),
535
- keyId: z.string(),
536
- newKeyName: z.string().min(4).max(512),
537
- });
566
+ export const zRenameTranslationKeyBody = zUpdateTranslationRequestBody;
538
567
  /**
539
568
  * Ok
540
569
  */
@@ -585,16 +614,16 @@ export const zGetLocalesQuery = z.object({
585
614
  * Ok
586
615
  */
587
616
  export const zGetLocalesResponse = zGetLocaleResponse;
588
- export const zAddLocaleBody = zCreateLocaleRequestBody;
589
- /**
590
- * Resource Created
591
- */
592
- export const zAddLocaleResponse = zCreateLocaleResponse;
593
617
  export const zUpdateReferenceLocaleBody = zUpdateReferenceLocaleRequestBody;
594
618
  /**
595
619
  * Ok
596
620
  */
597
621
  export const zUpdateReferenceLocaleResponse = zSuccessResponse;
622
+ export const zAddLocaleBody = zCreateLocaleRequestBody;
623
+ /**
624
+ * Resource Created
625
+ */
626
+ export const zAddLocaleResponse = zCreateLocaleResponse;
598
627
  export const zDeleteTranslationsBody = zDeleteTranslationsRequestBody;
599
628
  /**
600
629
  * Ok
package/package.json CHANGED
@@ -2,7 +2,7 @@
2
2
  "name": "@labeleer/api",
3
3
  "type": "module",
4
4
  "description": "Wrapper for Labeleer API interaction",
5
- "version": "1.0.2",
5
+ "version": "1.0.3",
6
6
  "private": false,
7
7
  "homepage": "https://labeleer.com",
8
8
  "license": "MIT",