UNPKG

@crowdin/app-project-module

Version:

Module that generates for you all common endpoints for serving standalone Crowdin App

97 lines (96 loc) 6.79 kB
import { Storage } from '.'; import { IntegrationConfig, IntegrationCredentials, IntegrationFilesSnapshot, IntegrationSyncSettings, IntegrationWebhooks, Provider } from '../modules/integration/types'; import { CreateJobParams, GetActiveJobsParams, GetAllJobsParams, GetFileTranslationCache, GetFileTranslationCacheByLanguageParams, GetJobParams, GetUnsyncedFiles, IntegrationSyncedData, Job, TranslationCache, UnsyncedFiles, UpdateJobParams, UpdateTranslationCacheParams } from '../modules/integration/util/types'; import { CrowdinCredentials } from '../types'; import { UserErrors } from './types'; export interface SQLiteStorageConfig { dbFolder: string; } export declare class SQLiteStorage implements Storage { private config; private db; tables: { crowdin_credentials: string; integration_credentials: string; sync_settings: string; app_metadata: string; files_snapshot: string; webhooks: string; user_errors: string; integration_settings: string; job: string; translation_file_cache: string; unsynced_files: string; synced_data: string; }; constructor(config: SQLiteStorageConfig); private addColumn; private updateTables; migrate(skipOnboarding?: boolean): Promise<void>; saveCrowdinCredentials(credentials: CrowdinCredentials): Promise<void>; updateCrowdinCredentials(credentials: CrowdinCredentials): Promise<void>; getCrowdinCredentials(id: string): Promise<CrowdinCredentials | undefined>; getAllCrowdinCredentials(): Promise<CrowdinCredentials[]>; deleteCrowdinCredentials(id: string): Promise<void>; saveIntegrationCredentials(id: string, credentials: any, crowdinId: string): Promise<void>; updateIntegrationCredentials(id: string, credentials: any): Promise<void>; updateIntegrationManagers(id: string, managers: any): Promise<void>; getIntegrationCredentials(id: string): Promise<IntegrationCredentials | undefined>; getAllIntegrationCredentials(crowdinId: string): Promise<IntegrationCredentials[]>; deleteIntegrationCredentials(id: string): Promise<void>; deleteAllIntegrationCredentials(crowdinId: string): Promise<void>; saveMetadata(id: string, metadata: any, crowdinId: string): Promise<void>; updateMetadata(id: string, metadata: any, crowdinId: string): Promise<void>; getMetadata(id: string): Promise<any | undefined>; getAllMetadata(): Promise<any[] | undefined>; deleteMetadata(id: string): Promise<void>; getSyncSettingsByProvider(integrationId: string, provider: Provider): Promise<IntegrationSyncSettings | undefined>; getSyncSettingsBySchedule(type: string, schedule: string): Promise<IntegrationSyncSettings[]>; saveSyncSettings(files: any, integrationId: string, crowdinId: string, type: string, provider: Provider): Promise<void>; updateSyncSettings(files: any, integrationId: string, crowdinId: string, type: string, provider: Provider): Promise<void>; getSyncSettings(integrationId: string, crowdinId: string, type: string, provider: Provider): Promise<IntegrationSyncSettings | undefined>; saveFilesSnapshot(files: any, integrationId: string, crowdinId: string, provider: Provider): Promise<void>; updateFilesSnapshot(files: any, integrationId: string, crowdinId: string, provider: Provider): Promise<void>; getFilesSnapshot(integrationId: string, crowdinId: string, provider: Provider): Promise<IntegrationFilesSnapshot | undefined>; getAllWebhooks(integrationId: string, crowdinId: string, provider: Provider): Promise<IntegrationWebhooks[] | undefined>; getWebhooks(fileId: string, integrationId: string, crowdinId: string, provider: Provider): Promise<IntegrationWebhooks | undefined>; saveWebhooks(fileId: string, integrationId: string, crowdinId: string, provider: Provider): Promise<void>; deleteWebhooks(fileIds: any[], integrationId: string, crowdinId: string, provider: Provider): Promise<void>; getAllUserErrors(crowdinId: string, integrationId?: string): Promise<UserErrors[] | undefined>; saveUserError(action: string, message: string, data: any, createdAt: string, crowdinId: string, integrationId?: string): Promise<void>; deleteUserErrors(date: string, crowdinId: string, integrationId?: string): Promise<void>; deleteAllUsersErrorsOlderThan(date: string): Promise<void>; saveIntegrationConfig(integrationId: string, crowdinId: string, config: any): Promise<void>; getAllIntegrationConfigs(crowdinId: string): Promise<IntegrationConfig[]>; getIntegrationConfig(integrationId: string): Promise<IntegrationConfig | undefined>; updateIntegrationConfig(integrationId: string, config: any): Promise<void>; createJob(params: CreateJobParams): Promise<string>; updateJob({ id, progress, status, info, data, attempt, errors, processedEntities, }: UpdateJobParams): Promise<void>; getJob(params: GetJobParams): Promise<Job | undefined>; getActiveJobs(params: GetActiveJobsParams): Promise<Job[] | undefined>; deleteFinishedJobs(): Promise<void>; getAllInProgressJobs(): Promise<Job[] | undefined>; getAllJobs({ integrationId, crowdinId, limit, offset }: GetAllJobsParams): Promise<Job[] | undefined>; saveTranslationCache(params: TranslationCache): Promise<void>; getFileTranslationCache(params: GetFileTranslationCache): Promise<TranslationCache[] | undefined>; getFileTranslationCacheByLanguage(params: GetFileTranslationCacheByLanguageParams): Promise<TranslationCache | undefined>; updateTranslationCache(params: UpdateTranslationCacheParams): Promise<void>; saveUnsyncedFiles(params: UnsyncedFiles): Promise<void>; getUnsyncedFiles(params: GetUnsyncedFiles): Promise<UnsyncedFiles | undefined>; updateUnsyncedFiles(params: UnsyncedFiles): Promise<void>; registerCustomTable(tableName: string, schema: Record<string, string>): Promise<void>; insertRecord(tableName: string, data: Record<string, any>): Promise<void>; selectRecords(tableName: string, options?: { columns?: string[]; whereClause?: string; orderBy?: string; limit?: number; offset?: number; distinct?: boolean; }, params?: any[]): Promise<any[]>; updateRecord(tableName: string, data: Record<string, any>, whereClause: string, params?: any[]): Promise<void>; deleteRecord(tableName: string, whereClause: string, params?: any[]): Promise<void>; saveSyncedData(files: any, integrationId: string, crowdinId: string, type: string): Promise<void>; updateSyncedData(files: any, integrationId: string, crowdinId: string, type: string): Promise<void>; getSyncedData(integrationId: string, crowdinId: string, type: string): Promise<IntegrationSyncedData | undefined>; }