@labeleer/api 1.0.1 → 1.0.3

package/dist/generated/zod.gen.js

@@ -0,0 +1,650 @@
+// This file is auto-generated by @hey-api/openapi-ts
+import * as z from 'zod';
+export const zBooleanish = z.boolean().default(false);
+export const zCreateCommentRequestBody = z.object({
+    projectId: z.string(),
+    keyId: z.string(),
+    comment: z.string().min(1).max(1024),
+    commentId: z.string(),
+});
+export const zDeleteCommentRequestQuery = z.object({
+    commentId: z.string(),
+    projectId: z.string(),
+});
+export const zDeleteTranslationRequestQuery = z.object({
+    projectId: z.string(),
+    keyId: z.string(),
+});
+export const zDeleteTranslationsRequestBody = z.object({
+    projectId: z.string(),
+    keys: z.array(z.string()).min(1),
+});
+export const zErrorResponse = z.object({
+    error: z.string(),
+    details: z.string().optional(),
+});
+export const zGetCommentsRequestQuery = z.object({
+    projectId: z.string(),
+    keyId: z.string(),
+});
+export const zGetLocalesRequestQuery = z.object({
+    projectId: z.string(),
+});
+export const zGetTranslationRequestQuery = z.object({
+    projectId: z.string(),
+    keyId: z.string(),
+});
+export const zGetTranslationTagsRequestQuery = z.object({
+    projectId: z.string(),
+    keyId: z.string(),
+});
+export const zInvitationProject = z.object({
+    id: z.string(),
+    name: z.string(),
+    description: z.string().optional(),
+});
+export const zInvitedBy = z.object({
+    user_id: z.string(),
+    name: z.string(),
+    thumbnail_url: z.string().optional(),
+    email: z.string(),
+});
+export const zInviteUserRequestBody = z.object({
+    email: z
+        .email()
+        .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,}$/),
+});
+export const zLocale = z.enum([
+    'af_ZA',
+    'am_ET',
+    'ar_SA',
+    'ar_EG',
+    'ar_AE',
+    'ar_MA',
+    'ha_NG',
+    'ig_NG',
+    'om_ET',
+    'ps_AF',
+    'so_SO',
+    'sw_KE',
+    'sw_TZ',
+    'wo_SN',
+    'xh_ZA',
+    'yo_NG',
+    'yo_BJ',
+    'zu_ZA',
+    'az_AZ',
+    'hy_AM',
+    'ka_GE',
+    'kk_KZ',
+    'ky_KG',
+    'tk_TM',
+    'ug_CN',
+    'uz_UZ',
+    'ks_IN',
+    'ks_PK',
+    'be_BY',
+    'bg_BG',
+    'bs_BA',
+    'cs_CZ',
+    'hr_HR',
+    'lt_LT',
+    'lv_LV',
+    'mk_MK',
+    'pl_PL',
+    'ru_RU',
+    'sk_SK',
+    'sl_SI',
+    'sq_AL',
+    'sr_RS',
+    'sr_BA',
+    'sr_ME',
+    'uk_UA',
+    'ca_ES',
+    'cy_GB',
+    'da_DK',
+    'de_DE',
+    'de_AT',
+    'de_CH',
+    'el_GR',
+    'et_EE',
+    'eu_ES',
+    'fi_FI',
+    'ga_IE',
+    'gl_ES',
+    'hu_HU',
+    'is_IS',
+    'it_IT',
+    'it_CH',
+    'mt_MT',
+    'nl_NL',
+    'nl_BE',
+    'no_NO',
+    'nn_NO',
+    'ro_RO',
+    'sv_SE',
+    'en_US',
+    'en_GB',
+    'en_AU',
+    'en_CA',
+    'en_NZ',
+    'en_IN',
+    'en_IE',
+    'en_ZA',
+    'en_SG',
+    'fr_FR',
+    'fr_CA',
+    'fr_BE',
+    'fr_CH',
+    'fr_MA',
+    'es_ES',
+    'es_MX',
+    'es_AR',
+    'es_CO',
+    'es_CL',
+    'es_PE',
+    'es_VE',
+    'es_US',
+    'pt_PT',
+    'pt_BR',
+    'as_IN',
+    'bho_IN',
+    'bn_BD',
+    'bn_IN',
+    'dv_MV',
+    'fa_IR',
+    'fa_AF',
+    'gu_IN',
+    'he_IL',
+    'hi_IN',
+    'kn_IN',
+    'ku_TR',
+    'ku_IR',
+    'ku_IQ',
+    'ku_SY',
+    'mai_IN',
+    'ml_IN',
+    'mr_IN',
+    'ne_NP',
+    'pa_IN',
+    'pa_PK',
+    'sd_IN',
+    'sd_PK',
+    'si_LK',
+    'ta_IN',
+    'te_IN',
+    'ur_PK',
+    'ur_IN',
+    'bo_CN',
+    'bo_IN',
+    'dz_BT',
+    'id_ID',
+    'ja_JP',
+    'jv_ID',
+    'km_KH',
+    'ko_KR',
+    'lo_LA',
+    'mn_MN',
+    'ms_MY',
+    'ms_BN',
+    'my_MM',
+    'su_ID',
+    'th_TH',
+    'tl_PH',
+    'vi_VN',
+    'zh_CN',
+    'zh_TW',
+    'zh_HK',
+    'zh_SG',
+    'gug_PY',
+    'yi_US',
+    'yi_IL',
+    'yi_DE',
+    'tr_TR',
+]);
+export const zCreateLocaleRequestBody = z.object({
+    projectId: z.string(),
+    locale: zLocale,
+});
+export const zCreateProjectRequestBody = z.object({
+    name: z.string().min(1).max(50),
+    description: z.string().max(200).optional(),
+    locales: z.array(zLocale).optional(),
+});
+export const zDeleteLocaleRequestBody = z.object({
+    projectId: z.string(),
+    locale: zLocale,
+});
+export const zGenerateTranslationsRequestQuery = z.object({
+    project_id: z.string(),
+    key: z.string(),
+    from_locale: zLocale,
+    to_locale: zLocale,
+});
+export const zLanguageItem = z.object({
+    id: z.string(),
+    locale: zLocale,
+    is_reference: z.boolean(),
+});
+export const zCreateLocaleResponse = z.object({
+    data: z.array(zLanguageItem),
+});
+export const zGetLocaleResponse = z.object({
+    data: z.array(zLanguageItem),
+});
+export const zPagination = z.object({
+    offset: z.number(),
+    count: z.number(),
+    total_count: z.number(),
+    has_next: z.boolean(),
+});
+export const zPermissionCategory = z.enum([
+    'translations',
+    'languages',
+    'collaborators',
+    'project',
+]);
+export const zPermissionRole = z.enum(['viewer', 'editor']);
+export const zPlurality = z.enum([
+    'zero',
+    'one',
+    'two',
+    'few',
+    'many',
+    'other',
+]);
+export const zProjectFeature = z.enum(['auto-translate', 'suggestions']);
+export const zProjectPermissions = z.record(z.string(), zPermissionRole);
+export const zCreateAccessTokenRequestBody = z.object({
+    permissions: zProjectPermissions,
+});
+export const zGetUserPermissionsResponse = z.object({
+    data: zProjectPermissions,
+});
+export const zRole = z.enum(['owner', 'collaborator']);
+export const zCollaborator = z.object({
+    id: z.string(),
+    name: z.string(),
+    email: z.string(),
+    thumbnail_url: z.url().optional(),
+    role: zRole,
+});
+export const zSuccessResponse = z.object({
+    success: z.boolean(),
+});
+export const zTimestamp = z.iso
+    .datetime()
+    .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))$/);
+export const zComment = z.object({
+    id: z.string(),
+    key_id: z.string(),
+    project_id: z.string(),
+    created_on: zTimestamp,
+    edited_on: zTimestamp.optional(),
+    user: z.object({
+        id: z.string(),
+        name: z.string(),
+        email: z.string(),
+        thumbnail_url: z.string().optional(),
+    }),
+    content: z.string(),
+});
+export const zGetCommentsResponse = z.object({
+    data: z.array(zComment),
+});
+export const zInvitation = z.object({
+    id: z.string(),
+    role: zRole,
+    invited_on: zTimestamp,
+    project: zInvitationProject,
+    invited_by: zInvitedBy,
+});
+export const zGetInvitationsResponse = z.object({
+    data: z.array(zInvitation),
+});
+export const zProject = z.object({
+    id: z.string(),
+    description: z.string().optional(),
+    name: z.string(),
+    created_on: zTimestamp,
+    features: z.array(zProjectFeature),
+    updated_on: zTimestamp.optional(),
+    owner_user_id: z.string(),
+    created_by: zCollaborator,
+    users: z.array(zCollaborator),
+});
+export const zCreateProjectResponse = z.object({
+    data: zProject,
+});
+export const zGetProjectsResponse = z.object({
+    data: z.array(zProject),
+});
+export const zProjectApiKeyDetails = z.object({
+    id: z.string(),
+    name: z.string().optional(),
+    start: z.string(),
+    enabled: z.boolean(),
+    permissions: zProjectPermissions,
+    created_on: zTimestamp,
+    last_request: zTimestamp.optional(),
+    request_count: z.number(),
+    expires_on: zTimestamp.optional(),
+});
+export const zCreateAccessTokenResponse = z.object({
+    key: z.string(),
+    details: zProjectApiKeyDetails,
+});
+export const zTranslationsExportRequestQuery = z.object({
+    projectId: z.string(),
+    format: z.enum([
+        'json',
+        'yaml',
+        'ts',
+        'po',
+        'android_strings',
+        'apple_strings',
+        'xliff',
+        'xcstrings',
+    ]),
+    file_name: z.string().optional(),
+    include_tags: zBooleanish.optional(),
+    include_untranslated: zBooleanish.optional(),
+    include_description: zBooleanish.optional(),
+});
+export const zTranslationTags = z.array(z.string());
+export const zExtendedTranslationItem = z.object({
+    key: z.string(),
+    key_id: z.string(),
+    translations: z.record(z.string(), z.string()),
+    plurals: z.record(z.string(), z.record(z.string(), z.string())),
+    comment_count: z.number(),
+    description: z.string().nullish(),
+    tags: zTranslationTags,
+    created_at: zTimestamp,
+    updated_at: zTimestamp.optional(),
+    created_by: z
+        .object({
+        id: z.string(),
+        name: z.string(),
+        email: z.string(),
+        thumbnail: z.string().optional(),
+    })
+        .optional(),
+});
+export const zGetTranslationDataResponse = z.object({
+    data: zExtendedTranslationItem,
+});
+export const zGetTranslationTagsResponse = z.object({
+    data: zTranslationTags,
+});
+export const zTranslationExportItem = z.object({
+    key: z.string(),
+    tags: zTranslationTags,
+    description: z.string().optional(),
+    translations: z.record(z.string(), z.string()),
+    plurals: z.record(z.string(), z.record(z.string(), z.string())),
+});
+export const zTranslationItem = z.object({
+    key: z.string(),
+    key_id: z.string(),
+    translations: z.record(z.string(), z.string()),
+    plurals: z.record(z.string(), z.record(z.string(), z.string())),
+    comment_count: z.number(),
+    description: z.string().nullish(),
+    tags: zTranslationTags,
+});
+export const zGetTranslationsResponse = z.object({
+    data: z.array(zTranslationItem),
+    pagination: zPagination,
+});
+export const zUpdateAccessTokenPermissionsRequestBody = z.object({
+    permissions: zProjectPermissions,
+});
+export const zUpdateAccessTokenPermissionsResponse = z.object({
+    details: zProjectApiKeyDetails,
+});
+export const zUpdateInvitationStatusRequestBody = z.object({
+    invitationId: z.string(),
+    status: z.enum(['accepted', 'declined']),
+});
+export const zUpdateProjectResponse = z.object({
+    name: z.string().min(3).max(50),
+    description: z.string().max(200).optional(),
+});
+export const zUpdateReferenceLocaleRequestBody = z.object({
+    projectId: z.string(),
+    locale: zLocale,
+});
+export const zUpdateTranslationRequestBody = z.object({
+    projectId: z.string(),
+    keyId: z.string(),
+    newKeyName: z.string().min(4).max(512),
+});
+export const zUpdateTranslationsRequestBody = z.object({
+    projectId: z.string(),
+    entries: z.record(z.string(), z.object({
+        tags: z.array(z.string()).optional(),
+        description: z.string().optional(),
+        translations: z.record(z.string(), z.string()),
+        plurals: z
+            .record(z.string(), z.record(z.string(), z.string()))
+            .optional(),
+    })),
+});
+export const zUpdateTranslationTagsRequestBody = z.object({
+    projectId: z.string(),
+    keyId: z.string(),
+    tags: z.array(z.string().max(32)).min(1),
+});
+export const zUpdateTranslationTagsResponse = z.object({
+    data: zTranslationTags,
+});
+export const zUpdateUserPermissionsRequestBody = z.object({
+    permissions: zProjectPermissions,
+});
+export const zUser = z.object({
+    id: z.string(),
+    name: z.string(),
+    email: z.string(),
+    thumbnail_url: z.url().optional(),
+});
+/**
+ * Ok
+ */
+export const zGetInvitationsResponse2 = zGetInvitationsResponse;
+export const zRespondToInvitationBody = zUpdateInvitationStatusRequestBody;
+/**
+ * Resource Created
+ */
+export const zRespondToInvitationResponse = zSuccessResponse;
+export const zRevokeAccessTokenPath = z.object({
+    projectId: z.string(),
+});
+/**
+ * Ok
+ */
+export const zRevokeAccessTokenResponse = zSuccessResponse;
+export const zUpdateAccessTokenBody = zUpdateAccessTokenPermissionsRequestBody;
+export const zUpdateAccessTokenPath = z.object({
+    projectId: z.string(),
+});
+/**
+ * Ok
+ */
+export const zUpdateAccessTokenResponse = zUpdateAccessTokenPermissionsResponse;
+export const zCreateAccessTokenBody = zCreateAccessTokenRequestBody;
+export const zCreateAccessTokenPath = z.object({
+    projectId: z.string(),
+});
+/**
+ * Resource Created
+ */
+export const zCreateAccessTokenResponse2 = zCreateAccessTokenResponse;
+export const zInviteUserToProjectBody = zInviteUserRequestBody;
+export const zInviteUserToProjectPath = z.object({
+    projectId: z.string(),
+});
+/**
+ * Ok
+ */
+export const zInviteUserToProjectResponse = zSuccessResponse;
+export const zDeleteProjectPath = z.object({
+    projectId: z.string(),
+});
+/**
+ * Ok
+ */
+export const zDeleteProjectResponse = zSuccessResponse;
+export const zUpdateProjectBody = zUpdateProjectResponse;
+export const zUpdateProjectPath = z.object({
+    projectId: z.string(),
+});
+/**
+ * Ok
+ */
+export const zUpdateProjectResponse2 = zSuccessResponse;
+export const zRemoveUserFromProjectPath = z.object({
+    projectId: z.string(),
+    userId: z.string(),
+});
+/**
+ * Ok
+ */
+export const zRemoveUserFromProjectResponse = zSuccessResponse;
+export const zGetUserProjectPermissionsPath = z.object({
+    projectId: z.string(),
+    userId: z.string(),
+});
+/**
+ * Ok
+ */
+export const zGetUserProjectPermissionsResponse = zGetUserPermissionsResponse;
+export const zUpdateUserPermissionsBody = zUpdateUserPermissionsRequestBody;
+export const zUpdateUserPermissionsPath = z.object({
+    projectId: z.string(),
+    userId: z.string(),
+});
+/**
+ * Ok
+ */
+export const zUpdateUserPermissionsResponse = zSuccessResponse;
+/**
+ * Ok
+ */
+export const zGetProjectsResponse2 = zGetProjectsResponse;
+export const zCreateProjectBody = zCreateProjectRequestBody;
+/**
+ * Resource Created
+ */
+export const zCreateProjectResponse2 = zCreateProjectResponse;
+export const zGenerateTranslationsQuery = z.object({
+    project_id: z.string(),
+    key: z.string(),
+    from_locale: zLocale,
+    to_locale: zLocale,
+});
+/**
+ * Ok
+ */
+export const zGenerateTranslationsResponse = z.string();
+export const zDeleteTranslationQuery = z.object({
+    projectId: z.string(),
+    keyId: z.string(),
+});
+/**
+ * Ok
+ */
+export const zDeleteTranslationResponse = zSuccessResponse;
+export const zGetTranslationQuery = z.object({
+    projectId: z.string(),
+    keyId: z.string(),
+});
+/**
+ * Ok
+ */
+export const zGetTranslationResponse = zGetTranslationDataResponse;
+export const zRenameTranslationKeyBody = zUpdateTranslationRequestBody;
+/**
+ * Ok
+ */
+export const zRenameTranslationKeyResponse = zSuccessResponse;
+export const zGetTranslationTagsQuery = z.object({
+    projectId: z.string(),
+    keyId: z.string(),
+});
+/**
+ * Ok
+ */
+export const zGetTranslationTagsResponse2 = zGetTranslationTagsResponse;
+export const zUpdateTranslationTagsBody = zUpdateTranslationTagsRequestBody;
+/**
+ * Ok
+ */
+export const zUpdateTranslationTagsResponse2 = zUpdateTranslationTagsResponse;
+export const zExportTranslationsQuery = z.object({
+    projectId: z.string(),
+    format: z.enum([
+        'json',
+        'yaml',
+        'ts',
+        'po',
+        'android_strings',
+        'apple_strings',
+        'xliff',
+        'xcstrings',
+    ]),
+    file_name: z.string().optional(),
+    include_tags: zBooleanish.optional(),
+    include_untranslated: zBooleanish.optional(),
+    include_description: zBooleanish.optional(),
+});
+export const zExportTranslationsResponse = z.union([z.string(), z.void()]);
+export const zDeleteLocaleQuery = z.object({
+    projectId: z.string(),
+    locale: zLocale,
+});
+/**
+ * Ok
+ */
+export const zDeleteLocaleResponse = zSuccessResponse;
+export const zGetLocalesQuery = z.object({
+    projectId: z.string(),
+});
+/**
+ * Ok
+ */
+export const zGetLocalesResponse = zGetLocaleResponse;
+export const zUpdateReferenceLocaleBody = zUpdateReferenceLocaleRequestBody;
+/**
+ * Ok
+ */
+export const zUpdateReferenceLocaleResponse = zSuccessResponse;
+export const zAddLocaleBody = zCreateLocaleRequestBody;
+/**
+ * Resource Created
+ */
+export const zAddLocaleResponse = zCreateLocaleResponse;
+export const zDeleteTranslationsBody = zDeleteTranslationsRequestBody;
+/**
+ * Ok
+ */
+export const zDeleteTranslationsResponse = zSuccessResponse;
+export const zGetTranslationsQuery = z.object({
+    projectId: z.string(),
+    limit: z.string().optional(),
+    offset: z.string().optional(),
+    q: z.string().optional(),
+    tags: z.string().optional(),
+    lang: z.string().optional(),
+    case_sensitive: zBooleanish.optional(),
+    untranslated_only: zBooleanish.optional(),
+});
+/**
+ * Ok
+ */
+export const zGetTranslationsResponse2 = zGetTranslationsResponse;
+export const zUpdateTranslationsBody = zUpdateTranslationsRequestBody;
+/**
+ * Resource Created
+ */
+export const zUpdateTranslationsResponse = zSuccessResponse;

package/dist/index.js

@@ -0,0 +1,2 @@
+export * from './generated/types/index.js';
+export * from './wrapper.js';

package/dist/wrapper.d.ts

@@ -0,0 +1,51 @@
+import { addLocale, createAccessToken, deleteLocale, deleteTranslation, deleteTranslations, exportTranslations, generateTranslations, getLocales, getProjects, getTranslation, getTranslations, getTranslationTags, getUserProjectPermissions, inviteUserToProject, removeUserFromProject, renameTranslationKey, revokeAccessToken, updateAccessToken, updateReferenceLocale, updateTranslations, updateTranslationTags, updateUserPermissions } from './generated/index.js';
+declare const wrapper: {
+    projects: {
+        get: typeof getProjects;
+    };
+    project: {
+        collaborators: {
+            invite: typeof inviteUserToProject;
+            remove: typeof removeUserFromProject;
+            permissions: {
+                get: typeof getUserProjectPermissions;
+                set: typeof updateUserPermissions;
+            };
+        };
+        translations: {
+            get: typeof getTranslations;
+            update: typeof updateTranslations;
+            delete: typeof deleteTranslations;
+            export: typeof exportTranslations;
+            locales: {
+                reference: {
+                    set: typeof updateReferenceLocale;
+                };
+                add: typeof addLocale;
+                get: typeof getLocales;
+                delete: typeof deleteLocale;
+            };
+        };
+        translation: {
+            generate: typeof generateTranslations;
+            get: typeof getTranslation;
+            delete: typeof deleteTranslation;
+            key: {
+                rename: typeof renameTranslationKey;
+            };
+            tags: {
+                update: typeof updateTranslationTags;
+                get: typeof getTranslationTags;
+            };
+        };
+        accessToken: {
+            create: typeof createAccessToken;
+            revoke: typeof revokeAccessToken;
+            permissions: {
+                set: typeof updateAccessToken;
+            };
+        };
+    };
+};
+export { wrapper as labeleer };
+export default wrapper;