@uniformdev/tms-phrase 19.135.1-alpha.11

package/LICENSE.txt

@@ -0,0 +1,2 @@
+© 2024 Uniform Systems, Inc. All Rights Reserved.
+See details of Uniform Systems, Inc. Master Subscription Agreement here: https://uniform.dev/eula

package/dist/index.d.mts

@@ -0,0 +1,189 @@
+import { TranslationPayload } from '@uniformdev/tms-sdk';
+
+declare const buildPhraseJobFileName: ({ uniformProjectId, uniformEntityId, prefix, }: {
+    uniformProjectId: string;
+    uniformEntityId: string;
+    prefix?: string | null | undefined;
+}) => string | null;
+declare const parsePhraseJobFileName: (jobFileName: string) => {
+    uniformProjectId: string;
+    uniformEntityId: string;
+} | null;
+
+type AuthRequestPayload = {
+    apiHost: string;
+    userName: string;
+    password: string;
+};
+type PhraseAuthToken = {
+    token: string;
+    expires: number;
+};
+type SessionAuthToken = {
+    hash: string;
+    authToken: PhraseAuthToken;
+};
+type PhraseApiRequestPayload = {
+    phraseApiUrl: string;
+    method: 'GET' | 'POST' | 'PUT' | 'PATCH';
+    headers?: Record<string, string>;
+    body?: Record<string, unknown>;
+    apiToken?: string;
+};
+type ListApiResponse<TItem> = {
+    totalElements: number;
+    totalPages: number;
+    pageSize: number;
+    pageNumber: number;
+    numberOfElements: number;
+    content: TItem[];
+};
+type ProjectsResponseItem = {
+    uid: string;
+    id: string;
+    name: string;
+    sourceLang: string;
+    targetLangs: string[];
+};
+type JobsResponseItem = {
+    continuous: boolean;
+    dateCreated: string;
+    dateDue: string;
+    filename: string;
+    importStatus: {
+        status: string;
+        errorMessage?: string;
+    };
+    imported: boolean;
+    innerId: string;
+    originalFileDirectory: string;
+    owner: {
+        userName: string;
+        uid: string;
+        id: string;
+        firstName: string;
+    };
+    providers: {
+        type: 'string';
+        id: 'string';
+        uid: 'string';
+    }[];
+    serverTaskId: string;
+    sourceFileUid: string;
+    split: boolean;
+    status: JobStatus;
+    targetLang: string;
+    uid: string;
+};
+type ProjectProvider = {
+    id: string;
+    uid: string;
+} & ({
+    type: 'USER';
+    userName: string;
+    firstName: string;
+    lastName: string;
+    email: string;
+    active: boolean;
+} | {
+    type: 'VENDOR';
+    name: string;
+    defaultProjectOwnerId: number;
+});
+type ProjectFileImportSettings = {
+    inputCharset?: string;
+    outputCharset?: string;
+    zipCharset?: string;
+    fileFormat?: string;
+    autodetectMultilingualFiles?: boolean;
+    targetLength?: boolean;
+    targetLengthMax?: number;
+    targetLengthPercent?: boolean;
+    targetLengthPercentValue?: number;
+    json?: {
+        tagRegexp?: string;
+        htmlSubFilter?: boolean;
+        icuSubFilter?: boolean;
+        excludeKeyRegexp?: string;
+        includeKeyRegexp?: string;
+        contextNotePath?: string;
+        maxLenPath?: string;
+        contextKeyPath?: string;
+    };
+};
+type CreateJobApiResponse = {
+    jobs?: {
+        uid: string;
+    }[];
+};
+type JobStatus = 'NEW' | 'EMAILED' | 'ACCEPTED' | 'COMPLETED' | 'DELIVERED' | 'CANCELLED' | 'DECLINED' | 'REJECTED';
+type AsyncRequestIdApiResponse = {
+    asyncRequest?: {
+        id: string;
+    };
+};
+type PhraseWebhookPayload = {
+    event: string;
+    eventUid: string;
+    timestamp: number;
+    jobParts: {
+        id: string;
+        uid: string;
+        internalId: string;
+        status: WebhookJobStatus;
+        fileName: string;
+        project: {
+            uid: string;
+        };
+    }[];
+};
+type WebhookJobStatus = 'NEW' | 'EMAILED' | 'ASSIGNED' | 'COMPLETED_BY_LINGUIST' | 'COMPLETED' | 'CANCELLED' | 'DECLINED_BY_LINGUIST' | 'REJECTED_BY_LINGUIST';
+
+type PhraseTmsClientOptions = {
+    proxyUrl?: string;
+    apiHost: string;
+    userName: string;
+    password: string;
+};
+declare class PhraseTmsClient {
+    #private;
+    constructor(options: PhraseTmsClientOptions);
+    checkCredentials(): Promise<boolean>;
+    /**
+     * https://cloud.memsource.com/web/docs/api#operation/listProjects
+     */
+    listProjects(): Promise<ProjectsResponseItem[]>;
+    getProject(projectUid: string): Promise<ProjectsResponseItem | null>;
+    /**
+     * https://cloud.memsource.com/web/docs/api#operation/getImportSettingsForProject
+     */
+    getProjectFileImportSettings(projectUid: string): Promise<ProjectFileImportSettings | null>;
+    setProjectFileImportSettings(projectUid: string, importSettings: ProjectFileImportSettings): Promise<void>;
+    /**
+     * https://cloud.memsource.com/web/docs/api#operation/listPartsV2
+     */
+    listProjectJobs(projectUid: string, options?: {
+        status?: JobStatus[];
+        fileName?: string;
+    }): Promise<JobsResponseItem[]>;
+    listProjectProviders(projectUid: string): Promise<ProjectProvider[]>;
+    createTranslationJobFromPayload({ projectUid, dueDate, provider, payload, }: {
+        projectUid: string;
+        dueDate?: string;
+        provider?: ProjectProvider;
+        payload: TranslationPayload;
+    }): Promise<string | null>;
+    downloadTargetFile<TResult>({ projectUid, jobUid, getAsyncRequestMaxAttempts, getAsyncRequestDelayMs, }: {
+        projectUid: string;
+        jobUid: string;
+        getAsyncRequestMaxAttempts?: number;
+        getAsyncRequestDelayMs?: number;
+    }): Promise<TResult | null>;
+    setJobStatus({ projectUid, jobUid, jobStatus, }: {
+        projectUid: string;
+        jobUid: string;
+        jobStatus: JobStatus;
+    }): Promise<void>;
+}
+
+export { type AsyncRequestIdApiResponse, type AuthRequestPayload, type CreateJobApiResponse, type JobStatus, type JobsResponseItem, type ListApiResponse, type PhraseApiRequestPayload, type PhraseAuthToken, PhraseTmsClient, type PhraseTmsClientOptions, type PhraseWebhookPayload, type ProjectFileImportSettings, type ProjectProvider, type ProjectsResponseItem, type SessionAuthToken, buildPhraseJobFileName, parsePhraseJobFileName };

package/dist/index.d.ts

@@ -0,0 +1,189 @@
+import { TranslationPayload } from '@uniformdev/tms-sdk';
+
+declare const buildPhraseJobFileName: ({ uniformProjectId, uniformEntityId, prefix, }: {
+    uniformProjectId: string;
+    uniformEntityId: string;
+    prefix?: string | null | undefined;
+}) => string | null;
+declare const parsePhraseJobFileName: (jobFileName: string) => {
+    uniformProjectId: string;
+    uniformEntityId: string;
+} | null;
+
+type AuthRequestPayload = {
+    apiHost: string;
+    userName: string;
+    password: string;
+};
+type PhraseAuthToken = {
+    token: string;
+    expires: number;
+};
+type SessionAuthToken = {
+    hash: string;
+    authToken: PhraseAuthToken;
+};
+type PhraseApiRequestPayload = {
+    phraseApiUrl: string;
+    method: 'GET' | 'POST' | 'PUT' | 'PATCH';
+    headers?: Record<string, string>;
+    body?: Record<string, unknown>;
+    apiToken?: string;
+};
+type ListApiResponse<TItem> = {
+    totalElements: number;
+    totalPages: number;
+    pageSize: number;
+    pageNumber: number;
+    numberOfElements: number;
+    content: TItem[];
+};
+type ProjectsResponseItem = {
+    uid: string;
+    id: string;
+    name: string;
+    sourceLang: string;
+    targetLangs: string[];
+};
+type JobsResponseItem = {
+    continuous: boolean;
+    dateCreated: string;
+    dateDue: string;
+    filename: string;
+    importStatus: {
+        status: string;
+        errorMessage?: string;
+    };
+    imported: boolean;
+    innerId: string;
+    originalFileDirectory: string;
+    owner: {
+        userName: string;
+        uid: string;
+        id: string;
+        firstName: string;
+    };
+    providers: {
+        type: 'string';
+        id: 'string';
+        uid: 'string';
+    }[];
+    serverTaskId: string;
+    sourceFileUid: string;
+    split: boolean;
+    status: JobStatus;
+    targetLang: string;
+    uid: string;
+};
+type ProjectProvider = {
+    id: string;
+    uid: string;
+} & ({
+    type: 'USER';
+    userName: string;
+    firstName: string;
+    lastName: string;
+    email: string;
+    active: boolean;
+} | {
+    type: 'VENDOR';
+    name: string;
+    defaultProjectOwnerId: number;
+});
+type ProjectFileImportSettings = {
+    inputCharset?: string;
+    outputCharset?: string;
+    zipCharset?: string;
+    fileFormat?: string;
+    autodetectMultilingualFiles?: boolean;
+    targetLength?: boolean;
+    targetLengthMax?: number;
+    targetLengthPercent?: boolean;
+    targetLengthPercentValue?: number;
+    json?: {
+        tagRegexp?: string;
+        htmlSubFilter?: boolean;
+        icuSubFilter?: boolean;
+        excludeKeyRegexp?: string;
+        includeKeyRegexp?: string;
+        contextNotePath?: string;
+        maxLenPath?: string;
+        contextKeyPath?: string;
+    };
+};
+type CreateJobApiResponse = {
+    jobs?: {
+        uid: string;
+    }[];
+};
+type JobStatus = 'NEW' | 'EMAILED' | 'ACCEPTED' | 'COMPLETED' | 'DELIVERED' | 'CANCELLED' | 'DECLINED' | 'REJECTED';
+type AsyncRequestIdApiResponse = {
+    asyncRequest?: {
+        id: string;
+    };
+};
+type PhraseWebhookPayload = {
+    event: string;
+    eventUid: string;
+    timestamp: number;
+    jobParts: {
+        id: string;
+        uid: string;
+        internalId: string;
+        status: WebhookJobStatus;
+        fileName: string;
+        project: {
+            uid: string;
+        };
+    }[];
+};
+type WebhookJobStatus = 'NEW' | 'EMAILED' | 'ASSIGNED' | 'COMPLETED_BY_LINGUIST' | 'COMPLETED' | 'CANCELLED' | 'DECLINED_BY_LINGUIST' | 'REJECTED_BY_LINGUIST';
+
+type PhraseTmsClientOptions = {
+    proxyUrl?: string;
+    apiHost: string;
+    userName: string;
+    password: string;
+};
+declare class PhraseTmsClient {
+    #private;
+    constructor(options: PhraseTmsClientOptions);
+    checkCredentials(): Promise<boolean>;
+    /**
+     * https://cloud.memsource.com/web/docs/api#operation/listProjects
+     */
+    listProjects(): Promise<ProjectsResponseItem[]>;
+    getProject(projectUid: string): Promise<ProjectsResponseItem | null>;
+    /**
+     * https://cloud.memsource.com/web/docs/api#operation/getImportSettingsForProject
+     */
+    getProjectFileImportSettings(projectUid: string): Promise<ProjectFileImportSettings | null>;
+    setProjectFileImportSettings(projectUid: string, importSettings: ProjectFileImportSettings): Promise<void>;
+    /**
+     * https://cloud.memsource.com/web/docs/api#operation/listPartsV2
+     */
+    listProjectJobs(projectUid: string, options?: {
+        status?: JobStatus[];
+        fileName?: string;
+    }): Promise<JobsResponseItem[]>;
+    listProjectProviders(projectUid: string): Promise<ProjectProvider[]>;
+    createTranslationJobFromPayload({ projectUid, dueDate, provider, payload, }: {
+        projectUid: string;
+        dueDate?: string;
+        provider?: ProjectProvider;
+        payload: TranslationPayload;
+    }): Promise<string | null>;
+    downloadTargetFile<TResult>({ projectUid, jobUid, getAsyncRequestMaxAttempts, getAsyncRequestDelayMs, }: {
+        projectUid: string;
+        jobUid: string;
+        getAsyncRequestMaxAttempts?: number;
+        getAsyncRequestDelayMs?: number;
+    }): Promise<TResult | null>;
+    setJobStatus({ projectUid, jobUid, jobStatus, }: {
+        projectUid: string;
+        jobUid: string;
+        jobStatus: JobStatus;
+    }): Promise<void>;
+}
+
+export { type AsyncRequestIdApiResponse, type AuthRequestPayload, type CreateJobApiResponse, type JobStatus, type JobsResponseItem, type ListApiResponse, type PhraseApiRequestPayload, type PhraseAuthToken, PhraseTmsClient, type PhraseTmsClientOptions, type PhraseWebhookPayload, type ProjectFileImportSettings, type ProjectProvider, type ProjectsResponseItem, type SessionAuthToken, buildPhraseJobFileName, parsePhraseJobFileName };