payload-intl 0.0.7 → 0.1.0

package/README.md

@@ -148,24 +148,6 @@ export default {
 
 Here's a complete example showing how to integrate payload-intl using next-intl and S3 storage:
 
-```typescript
-// i18n/messages.ts
-export const messages = {
-  UserProfile: {
-    title: "Hello {firstName}",
-    description:
-      "Welcome back, {firstName}! You have {count, plural, =0 {no messages} one {# message} other {# messages}}.",
-  },
-  Navigation: {
-    home: "Home",
-    about: "About",
-  },
-  richText: {
-    welcome: "$RICH$",
-  },
-} as const;
-```
-
 ```typescript
 // payload.config.ts
 import { s3Storage } from "@payloadcms/storage-s3";
@@ -183,7 +165,6 @@ export default buildConfig({
   plugins: [
     intlPlugin({
       schema: messages,
-      tabs: true,
       hooks: {
         afterUpdate: () => revalidateTag("messages"),
       },
@@ -191,7 +172,10 @@ export default buildConfig({
     s3Storage({
       collections: {
         messages: {
-          prefix: "messages",
+          prefix: "messages", // or anything else you want
+          // generate a publicly available URL to the file
+          generateFileURL: async ({ filename, prefix }) =>
+            `.../${prefix}/${filename}`,
         },
       },
     }),
@@ -199,21 +183,30 @@ export default buildConfig({
 });
 ```
 
-### 3. Set up next-intl type augmentation
+```typescript
+// i18n/messages.ts
+export const messages = {
+  UserProfile: {
+    title: "Hello {firstName}",
+    description:
+      "Welcome back, {firstName}! You have {count, plural, =0 {no messages} one {# message} other {# messages}}.",
+  },
+  // ...
+} as const;
+```
 
 ```typescript
 // i18n/global.ts
-import type { messages } from "./messages";
+import type messages from "./messages";
 
 declare module "next-intl" {
   interface AppConfig {
     Messages: typeof messages;
+    // ...
   }
 }
 ```
 
-### 4. Configure next-intl request handler
-
 ```typescript
 // i18n/request.ts
 import { getRequestConfig } from "next-intl/server";
@@ -230,10 +223,8 @@ export default getRequestConfig(async ({ locale }) => {
 });
 ```
 
-### 5. Create server-side message fetcher
-
 ```typescript
-// server/messages.ts
+// server.ts
 "use server";
 
 import config from "@payload-config";
@@ -243,8 +234,15 @@ import { fetchMessages } from "payload-intl";
 
 export const fetchCachedMessages = unstable_cache(
   async (locale: string) => {
+    // Node.js
     const payload = await getPayload({ config });
     return await fetchMessages(payload, locale);
+
+    // Edge runtime
+    const response = await fetch(
+      `${process.env.PAYLOAD_API_URL}/intl-plugin/en`,
+    );
+    return await response.json();
   },
   ["messages"],
   {

package/dist/requests/fetchMessages.js

@@ -1,29 +1,27 @@
 import { getPluginContext as s } from "../utils/config.js";
-async function a(t, e) {
+async function a(n, e) {
   const {
     docs: [r]
-  } = await t.find({
-    collection: s(t.config).collectionSlug,
+  } = await n.find({
+    collection: s(n.config).collectionSlug,
     where: { locale: { equals: e } }
   });
   if (!r)
     return console.warn(`No messages found for locale ${e}`), {};
-  const { url: o } = r, n = await fetch(o, {
-    credentials: "include"
-  });
-  if (!n.ok)
+  const { url: o } = r, t = await fetch(o);
+  if (!t.ok)
     throw new Error(
       `Could not fetch messages for locale "${e}": The page returned an error.
 
 ${o}`
     );
-  if (n.headers.get("content-type") !== "application/json")
+  if (t.headers.get("content-type") !== "application/json")
     throw new Error(
       `Could not fetch messages for locale "${e}": The page did not return a JSON file.
 
 ${o}`
     );
-  return await n.json();
+  return await t.json();
 }
 export {
   a as fetchMessages

package/dist/requests/fetchMessages.js.map

@@ -1 +1 @@
-{"version":3,"file":"fetchMessages.js","sources":["../../src/requests/fetchMessages.ts"],"sourcesContent":["import type { BasePayload } from \"payload\";\n\nimport { getPluginContext } from \"@/utils/config\";\n\nimport type { Messages } from \"../types\";\n\nexport async function fetchMessages(\n  payload: BasePayload,\n  locale: string,\n): Promise<Messages> {\n  const {\n    docs: [doc],\n  } = await payload.find({\n    collection: getPluginContext(payload.config).collectionSlug,\n    where: { locale: { equals: locale } },\n  });\n\n  if (!doc) {\n    console.warn(`No messages found for locale ${locale}`);\n    return {};\n  }\n\n  const { url } = doc as unknown as { url: string };\n\n  const response = await fetch(url, {\n    credentials: \"include\",\n  });\n\n  if (!response.ok) {\n    throw new Error(\n      `Could not fetch messages for locale \"${locale}\": The page returned an error.\\n\\n${url}`,\n    );\n  }\n\n  if (response.headers.get(\"content-type\") !== \"application/json\") {\n    throw new Error(\n      `Could not fetch messages for locale \"${locale}\": The page did not return a JSON file.\\n\\n${url}`,\n    );\n  }\n\n  return await response.json();\n}\n"],"names":["fetchMessages","payload","locale","doc","getPluginContext","url","response"],"mappings":";AAMA,eAAsBA,EACpBC,GACAC,GACmB;AACnB,QAAM;AAAA,IACJ,MAAM,CAACC,CAAG;AAAA,EAAA,IACR,MAAMF,EAAQ,KAAK;AAAA,IACrB,YAAYG,EAAiBH,EAAQ,MAAM,EAAE;AAAA,IAC7C,OAAO,EAAE,QAAQ,EAAE,QAAQC,IAAO;AAAA,EAAE,CACrC;AAED,MAAI,CAACC;AACH,mBAAQ,KAAK,gCAAgCD,CAAM,EAAE,GAC9C,CAAA;AAGT,QAAM,EAAE,KAAAG,MAAQF,GAEVG,IAAW,MAAM,MAAMD,GAAK;AAAA,IAChC,aAAa;AAAA,EAAA,CACd;AAED,MAAI,CAACC,EAAS;AACZ,UAAM,IAAI;AAAA,MACR,wCAAwCJ,CAAM;AAAA;AAAA,EAAqCG,CAAG;AAAA,IAAA;AAI1F,MAAIC,EAAS,QAAQ,IAAI,cAAc,MAAM;AAC3C,UAAM,IAAI;AAAA,MACR,wCAAwCJ,CAAM;AAAA;AAAA,EAA8CG,CAAG;AAAA,IAAA;AAInG,SAAO,MAAMC,EAAS,KAAA;AACxB;"}
+{"version":3,"file":"fetchMessages.js","sources":["../../src/requests/fetchMessages.ts"],"sourcesContent":["import type { BasePayload } from \"payload\";\n\nimport { getPluginContext } from \"@/utils/config\";\n\nimport type { Messages } from \"../types\";\n\nexport async function fetchMessages(\n  payload: BasePayload,\n  locale: string,\n): Promise<Messages> {\n  const {\n    docs: [doc],\n  } = await payload.find({\n    collection: getPluginContext(payload.config).collectionSlug,\n    where: { locale: { equals: locale } },\n  });\n\n  if (!doc) {\n    console.warn(`No messages found for locale ${locale}`);\n    return {};\n  }\n\n  const { url } = doc as unknown as { url: string };\n\n  const response = await fetch(url);\n\n  if (!response.ok) {\n    throw new Error(\n      `Could not fetch messages for locale \"${locale}\": The page returned an error.\\n\\n${url}`,\n    );\n  }\n\n  if (response.headers.get(\"content-type\") !== \"application/json\") {\n    throw new Error(\n      `Could not fetch messages for locale \"${locale}\": The page did not return a JSON file.\\n\\n${url}`,\n    );\n  }\n\n  return await response.json();\n}\n"],"names":["fetchMessages","payload","locale","doc","getPluginContext","url","response"],"mappings":";AAMA,eAAsBA,EACpBC,GACAC,GACmB;AACnB,QAAM;AAAA,IACJ,MAAM,CAACC,CAAG;AAAA,EAAA,IACR,MAAMF,EAAQ,KAAK;AAAA,IACrB,YAAYG,EAAiBH,EAAQ,MAAM,EAAE;AAAA,IAC7C,OAAO,EAAE,QAAQ,EAAE,QAAQC,IAAO;AAAA,EAAE,CACrC;AAED,MAAI,CAACC;AACH,mBAAQ,KAAK,gCAAgCD,CAAM,EAAE,GAC9C,CAAA;AAGT,QAAM,EAAE,KAAAG,MAAQF,GAEVG,IAAW,MAAM,MAAMD,CAAG;AAEhC,MAAI,CAACC,EAAS;AACZ,UAAM,IAAI;AAAA,MACR,wCAAwCJ,CAAM;AAAA;AAAA,EAAqCG,CAAG;AAAA,IAAA;AAI1F,MAAIC,EAAS,QAAQ,IAAI,cAAc,MAAM;AAC3C,UAAM,IAAI;AAAA,MACR,wCAAwCJ,CAAM;AAAA;AAAA,EAA8CG,CAAG;AAAA,IAAA;AAInG,SAAO,MAAMC,EAAS,KAAA;AACxB;"}

package/package.json

@@ -1,8 +1,21 @@
 {
   "name": "payload-intl",
-  "version": "0.0.7",
+  "version": "0.1.0",
   "description": "Payload Plugin for I18N using ICU Messages",
   "license": "MIT",
+  "author": "Michael Zeltner",
+  "keywords": [
+    "payload",
+    "intl",
+    "i18n",
+    "internationalization",
+    "localization",
+    "react",
+    "next.js",
+    "translation",
+    "translations",
+    "icu"
+  ],
   "type": "module",
   "exports": {
     ".": {