@focus-reactive/payload-plugin-translator 0.3.0 → 0.5.0

package/dist/server/modules/translation-providers/OpenAITranslation.provider.js

@@ -1,21 +1,21 @@
-import OpenAI from 'openai';
-import { isObject } from '../../shared';
+import OpenAI from "openai";
+import { isObject } from "../../shared";
 /** @deprecated Use `createOpenAIProvider` function instead */ export class OpenAITranslationProvider {
-    config;
     openAiClient;
+    config;
     constructor(config){
-        this.config = config;
         this.openAiClient = new OpenAI({
             apiKey: config.apiKey
         });
+        this.config = config;
     }
     async translate(content, souceLng, targetLng) {
         if (this.config.dryRun) {
-            console.info('[DRY RUN] Translation simulation:', {
+            console.info("[DRY RUN] Translation simulation:", {
                 content,
                 sourceLang: souceLng,
                 targetLang: targetLng,
-                provider: 'OpenAI'
+                provider: "OpenAI"
             });
             const timeout = this.getDryRunTimeout();
             if (timeout > 0) await new Promise((resolve)=>setTimeout(resolve, timeout));
@@ -26,21 +26,21 @@ import { isObject } from '../../shared';
         const chatCompletion = await this.openAiClient.chat.completions.create({
             messages: [
                 {
-                    role: 'system',
+                    role: "system",
                     content: systemPrompt
                 },
                 {
-                    role: 'user',
+                    role: "user",
                     content: JSON.stringify(content)
                 }
             ],
-            model: this.config.model ?? 'gpt-4o',
+            model: this.config.model ?? "gpt-4o",
             temperature: 0,
             top_p: 1,
             frequency_penalty: 0,
             presence_penalty: 0,
             response_format: {
-                type: 'json_object'
+                type: "json_object"
             }
         });
         const translatedContent = chatCompletion.choices[0].message.content;
@@ -54,7 +54,7 @@ import { isObject } from '../../shared';
     /**
    * Builds the system prompt for translation.
    */ buildSystemPrompt(sourceLang, targetLang) {
-        const defaultPrompt = `Translate the values from the JSON that the user will send you${sourceLang ? ` from ${sourceLang}` : ''} into ${targetLang}. Keep all JSON keys exactly as they are, only translate the values.
+        const defaultPrompt = `Translate the values from the JSON that the user will send you${sourceLang ? ` from ${sourceLang}` : ""} into ${targetLang}. Keep all JSON keys exactly as they are, only translate the values.
 The response should be a valid JSON object with the same structure and keys as the input, but with translated values.
 Maintain any special formatting, placeholders, or variables within the values if they exist.`;
         if (this.config.systemPrompt) {
@@ -71,17 +71,17 @@ Maintain any special formatting, placeholders, or variables within the values if
    * If dryRun is an object with transform, returns it.
    * If dryRun is true, returns the default transformer that reverses text.
    */ getDryRunTransformer() {
-        if (typeof this.config.dryRun === 'object' && this.config.dryRun.transform) {
+        if (typeof this.config.dryRun === "object" && this.config.dryRun.transform) {
             return this.config.dryRun.transform;
         }
-        return (text)=>text.split('').reverse().join('');
+        return (text)=>text.split("").reverse().join("");
     }
     /**
    * Returns the timeout for dry run mode.
    * If dryRun is an object with timeout, returns it.
    * Otherwise returns 0 (no delay).
    */ getDryRunTimeout() {
-        if (typeof this.config.dryRun === 'object' && this.config.dryRun.timeout) {
+        if (typeof this.config.dryRun === "object" && this.config.dryRun.timeout) {
             return this.config.dryRun.timeout;
         }
         return 0;
@@ -89,7 +89,7 @@ Maintain any special formatting, placeholders, or variables within the values if
     async createMockTranslation(content, transformer) {
         try {
             const mockTranslation = await this.transformObjectValues(content, async (value)=>{
-                if (typeof value === 'string' && value.trim()) return transformer(value);
+                if (typeof value === "string" && value.trim()) return transformer(value);
                 return value;
             });
             return mockTranslation;

package/dist/types/AccessGuard.d.ts

@@ -1,10 +1,33 @@
-import type { BasePayload, TypedUser } from 'payload';
+import type { BasePayload, TypedUser } from "payload";
+/**
+ * The request context an {@link AccessGuard} receives when deciding whether to
+ * allow a translation API call.
+ */
 export type AccessGuardRequest = {
+    /** Incoming request headers (e.g. for token/cookie checks). */
     headers: Headers;
+    /** The authenticated user, or `null`/`undefined` if the request is anonymous. */
     user?: TypedUser | null;
+    /** The Payload instance, for any DB/permission lookups the guard needs. */
     payload: BasePayload;
 };
+/**
+ * Gate for the translation API endpoints. Provide one via `translatorPlugin({ access })`
+ * to control who may trigger translations; omit it to leave the endpoints open.
+ *
+ * @example
+ * ```ts
+ * const adminsOnly: AccessGuard = {
+ *   check: ({ req }) => req.user?.role === 'admin',
+ * }
+ * translatorPlugin({ collections, translationProvider, runner, access: adminsOnly })
+ * ```
+ */
 export interface AccessGuard {
+    /**
+     * Return `true` to allow the request, `false` to reject it with `403 Forbidden`.
+     * May be async (e.g. to query permissions).
+     */
     check<R extends AccessGuardRequest>({ req }: {
         req: R;
     }): Promise<boolean> | boolean;

package/dist/types/AccessGuard.js

@@ -1,3 +1,14 @@
-export { };
+/**
+ * Gate for the translation API endpoints. Provide one via `translatorPlugin({ access })`
+ * to control who may trigger translations; omit it to leave the endpoints open.
+ *
+ * @example
+ * ```ts
+ * const adminsOnly: AccessGuard = {
+ *   check: ({ req }) => req.user?.role === 'admin',
+ * }
+ * translatorPlugin({ collections, translationProvider, runner, access: adminsOnly })
+ * ```
+ */ export { };
 
 //# sourceMappingURL=AccessGuard.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@focus-reactive/payload-plugin-translator",
-  "version": "0.3.0",
+  "version": "0.5.0",
   "description": "Translation plugin for Payload CMS 3.x. Automatically translate your localized content using any translation provider.",
   "type": "module",
   "license": "MIT",