payload-ai 0.0.1 → 0.0.4

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2023 Payload
+Copyright (c) 2024 wirewire
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -1,12 +1,133 @@
-# Payload Plugin Template
+# Payload AI
 
-Translate content to different languages using GPT.
+Translate content to different languages using OpenAI's GPT.
 
-Planned features:
+
+### How to install the plugin
+
+Install via npm:
+
+
+```
+npm install payload-ai
+```
+
+Or yarn:
+```
+yarn add payload-ai
+```
+
+To install the plugin, simply add it to your payload.config() in the Plugin array.
+
+```ts
+import payloadAi from 'payload-ai';
+
+export const config = buildConfig({
+  plugins: [
+    // You can pass options to the plugin
+    payloadAi({
+		  enabled: true,
+    }),
+  ]
+});
+```
+
+### Collection translation
+
+Add the `collections` where you want to enable the translation and the `fields`. It will translate each field (also nested fields) on every update of the default language.
+
+```ts
+plugins: [
+  aiTranslatorPlugin({
+    enabled: true,
+    collections: {
+      examples: {
+        // prompts: [myCollectionPrompt]
+        fields: [
+          'stringText', 
+          'richText',
+          {
+            "fieldWithCustomPrompt": 
+              {prompt: myPromptFunction}
+          }
+        ],
+      },
+    },
+  }),
+],
+```
+
+#### Use in hooks
+
+TODO: add documentation
+
+myCollectionPrompt = ({source}) => {
+
+  source()
+
+  return 
+}
+
+#### Custom prompts by Field
+
+Use the `prompt` function for each field to use a customized prompt. The function will allow you to use the following
+
+
+- `req`: Request
+- `doc` Document in languages
+-  `previousDoc` Old document (only available on Update)
+-  `targetDoc` The old target document
+- `collectionOptions`
+- `language`
+- translatorConfig
+  language: string,
+  sourceLanguage?: string,
+
+- targetField
+- sourceField
+
+
+```jsx
+customPrompt = ({sourceField}) => `Translate ${sourceField} to ${targetLanguage}.`
+```
+
+### Use with [payload-seo](https://payloadcms.com/docs/plugins/seo)
+
+```jsx
+
+
+import {generateTitle, generateDescription } from "payload-ai";
+
+seo({
+  collections: ['examples'],
+  // uploadsCollection: 'media',
+  generateTitle: generateTitle,
+  generateDescription: ({ doc }) => generateDescription,
+});
+```
+
+### String translation
+
+Use this to provide a [backend](https://github.com/i18next/i18next-http-backend) for [i18next](https://www.i18next.com) string translations.
+
+
+```jsx
+plugins: [
+  aiTranslatorPlugin({
+    enabled: true,
+    stringTranslation: {
+      enabled: true
+    }
+  }),
+],
+```
+
+### Generate SEO
+
+
+### Planned features
 
 - generate image alt text from GPT
-- generate by field
-- string translation using i18next
 - generate SEO Text
 - generate structured content
 - custom access control
@@ -20,26 +141,9 @@ To build your own Payload plugin, all you need is:
 * An understanding of the basic Payload concepts
 * And some JavaScript/Typescript experience
 
-## Background
-
-Here is a short recap on how to integrate plugins with Payload, to learn more visit the [plugin overview page](https://payloadcms.com/docs/plugins/overview).
 
-### How to install a plugin
 
-To install any plugin, simply add it to your payload.config() in the Plugin array.
-
-```ts
-import samplePlugin from 'sample-plugin';
 
-export const config = buildConfig({
-  plugins: [
-    // You can pass options to the plugin
-    samplePlugin({
-		  enabled: true,
-    }),
-  ]
-});
-```
 
 ### Initialization
 

package/dev/package.json

@@ -17,13 +17,15 @@
   },
   "dependencies": {
     "@payloadcms/bundler-webpack": "^1.0.0",
-    "@payloadcms/db-mongodb": "^1.0.0",
+    "@payloadcms/db-mongodb": "^1.2.0",
     "@payloadcms/plugin-cloud": "^2.0.0",
-    "@payloadcms/richtext-slate": "^1.0.0",
+    "@payloadcms/plugin-seo": "^1.0.15",
+    "@payloadcms/richtext-lexical": "^0.5.1",
+    "@payloadcms/richtext-slate": "^1.3.1",
     "cross-env": "^7.0.3",
     "dotenv": "^8.2.0",
     "express": "^4.17.1",
-    "payload": "^2.0.0"
+    "payload": "^2.7.0"
   },
   "devDependencies": {
     "@types/express": "^4.17.9",
@@ -32,4 +34,4 @@
     "ts-node": "^9.1.1",
     "typescript": "^4.8.4"
   }
-}
+}

package/dev/src/collections/Examples.ts

@@ -1,17 +1,34 @@
+import { lexicalEditor } from '@payloadcms/richtext-lexical'
 import { CollectionConfig } from 'payload/types'
 
 // Example Collection - For reference only, this must be added to payload.config.ts to be used.
 const Examples: CollectionConfig = {
   slug: 'examples',
   admin: {
-    useAsTitle: 'someField',
+    useAsTitle: 'title',
   },
   fields: [
     {
-      name: 'richText',
+      name: 'title',
       type: 'text',
       localized: true,
     },
+    {
+      name: 'contentRichText',
+      type: 'richText',
+      editor: lexicalEditor({}),
+      localized: true,
+    },
+    {
+      name: 'longText',
+      type: 'code',
+      localized: true,
+    },
+    {
+      name: 'doNotAutoTranslate',
+      type: 'code',
+      localized: true,
+    },
   ],
 }
 

package/dev/src/collections/ExamplesWithVersions.ts

@@ -0,0 +1,31 @@
+import { CollectionConfig } from 'payload/types'
+
+// Example Collection - For reference only, this must be added to payload.config.ts to be used.
+const ExamplesWithVersions: CollectionConfig = {
+  slug: 'examples-with-versions',
+  admin: {
+    useAsTitle: 'title',
+  },
+  versions: {
+    drafts: true,
+  },
+  fields: [
+    {
+      name: 'title',
+      type: 'text',
+      localized: true,
+    },
+    {
+      name: 'longText',
+      type: 'code',
+      localized: true,
+    },
+    {
+      name: 'doNotAutoTranslate',
+      type: 'code',
+      localized: true,
+    },
+  ],
+}
+
+export default ExamplesWithVersions

package/dev/src/payload.config.ts

@@ -4,8 +4,11 @@ import Users from './collections/Users'
 import Examples from './collections/Examples'
 import { mongooseAdapter } from '@payloadcms/db-mongodb'
 import { webpackBundler } from '@payloadcms/bundler-webpack'
-import { slateEditor } from '@payloadcms/richtext-slate'
-import { aiTranslatorPlugin } from '../../src/index'
+// import { slateEditor } from '@payloadcms/richtext-slate'
+import { lexicalEditor } from '@payloadcms/richtext-lexical'
+import { aiTranslatorPlugin, generateDescription, generateTitle } from '../../src/index'
+import ExamplesWithVersions from './collections/ExamplesWithVersions'
+import seo from '@payloadcms/plugin-seo'
 
 export default buildConfig({
   admin: {
@@ -27,10 +30,11 @@ export default buildConfig({
       return newConfig
     },
   },
-  editor: slateEditor({}),
-  collections: [Examples, Users],
+  editor: lexicalEditor({}),
+  // editor: slateEditor({}),
+  collections: [Examples, ExamplesWithVersions, Users],
   localization: {
-    locales: ['en', 'es', 'de'],
+    locales: ['en', 'de', 'ja' /* 'es','fr', 'it', 'ja'*/],
     defaultLocale: 'en',
     fallback: true,
   },
@@ -45,11 +49,19 @@ export default buildConfig({
       enabled: true,
       collections: {
         examples: {
-          fields: ['richText'],
-          // adapter: theAdapterToUse, // see docs for the adapter you want to use
+          fields: ['title', 'longText', 'jsonContent', 'contentRichText'],
+        },
+        'examples-with-versions': {
+          fields: ['title', 'longText', 'jsonContent'],
         },
       },
     }),
+    seo({
+      collections: ['examples'],
+      // uploadsCollection: 'media',
+      generateTitle: generateTitle,
+      generateDescription: generateDescription,
+    }),
   ],
   db: mongooseAdapter({
     url: process.env.DATABASE_URI,

package/dist/access/admins.d.ts

@@ -0,0 +1,4 @@
+import type { AccessArgs } from 'payload/config';
+type isAdmin = (args: AccessArgs<unknown, any>) => boolean;
+export declare const admins: isAdmin;
+export {};

package/dist/access/admins.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.admins = void 0;
+var checkRole_1 = require("./checkRole");
+var admins = function (_a) {
+    var user = _a.req.user;
+    if (!user)
+        return false;
+    return (0, checkRole_1.checkRole)(['admin'], user);
+};
+exports.admins = admins;
+//# sourceMappingURL=admins.js.map

package/dist/access/admins.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"admins.js","sourceRoot":"","sources":["../../src/access/admins.ts"],"names":[],"mappings":";;;AAEA,yCAAuC;AAKhC,IAAM,MAAM,GAAY,UAAC,EAAiB;QAAR,IAAI,cAAA;IAC3C,IAAI,CAAC,IAAI;QAAE,OAAO,KAAK,CAAA;IACvB,OAAO,IAAA,qBAAS,EAAC,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,CAAA;AACnC,CAAC,CAAA;AAHY,QAAA,MAAM,UAGlB"}

package/dist/access/adminsOrPublished.d.ts

@@ -0,0 +1,2 @@
+import type { Access } from 'payload/config';
+export declare const adminsOrPublished: Access;

package/dist/access/adminsOrPublished.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.adminsOrPublished = void 0;
+var checkRole_1 = require("./checkRole");
+var adminsOrPublished = function (_a) {
+    var user = _a.req.user;
+    if (user && (0, checkRole_1.checkRole)(['admin'], user)) {
+        return true;
+    }
+    return true;
+    return {
+        _status: {
+            equals: 'published',
+        },
+    };
+};
+exports.adminsOrPublished = adminsOrPublished;
+//# sourceMappingURL=adminsOrPublished.js.map

package/dist/access/adminsOrPublished.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"adminsOrPublished.js","sourceRoot":"","sources":["../../src/access/adminsOrPublished.ts"],"names":[],"mappings":";;;AAEA,yCAAuC;AAEhC,IAAM,iBAAiB,GAAW,UAAC,EAAiB;QAAR,IAAI,cAAA;IACrD,IAAI,IAAI,IAAI,IAAA,qBAAS,EAAC,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,EAAE;QACtC,OAAO,IAAI,CAAA;KACZ;IAED,OAAO,IAAI,CAAA;IACX,OAAO;QACL,OAAO,EAAE;YACP,MAAM,EAAE,WAAW;SACpB;KACF,CAAA;AACH,CAAC,CAAA;AAXY,QAAA,iBAAiB,qBAW7B"}

package/dist/access/anyone.d.ts

@@ -0,0 +1,2 @@
+import type { Access } from 'payload/config';
+export declare const anyone: Access;

package/dist/access/anyone.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.anyone = void 0;
+var anyone = function () { return true; };
+exports.anyone = anyone;
+//# sourceMappingURL=anyone.js.map

package/dist/access/anyone.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"anyone.js","sourceRoot":"","sources":["../../src/access/anyone.ts"],"names":[],"mappings":";;;AAEO,IAAM,MAAM,GAAW,cAAM,OAAA,IAAI,EAAJ,CAAI,CAAA;AAA3B,QAAA,MAAM,UAAqB"}

package/dist/access/checkRole.d.ts

@@ -0,0 +1 @@
+export declare const checkRole: (allRoles: any, user?: any) => boolean;

package/dist/access/checkRole.js

@@ -0,0 +1,18 @@
+"use strict";
+//import type { User } from '../../payload-types'
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.checkRole = void 0;
+var checkRole = function (allRoles /* User['roles'] = [] */, user) {
+    if (user) {
+        if (allRoles.some(function (role) {
+            var _a;
+            return (_a = user === null || user === void 0 ? void 0 : user.roles) === null || _a === void 0 ? void 0 : _a.some(function (individualRole) {
+                return individualRole === role;
+            });
+        }))
+            return true;
+    }
+    return false;
+};
+exports.checkRole = checkRole;
+//# sourceMappingURL=checkRole.js.map

package/dist/access/checkRole.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"checkRole.js","sourceRoot":"","sources":["../../src/access/checkRole.ts"],"names":[],"mappings":";AAAA,iDAAiD;;;AAE1C,IAAM,SAAS,GAAG,UAAC,QAAa,CAAC,wBAAwB,EAAE,IAAU;IAC1E,IAAI,IAAI,EAAE;QACR,IACE,QAAQ,CAAC,IAAI,CAAC,UAAC,IAAS;;YACtB,OAAO,MAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,KAAK,0CAAE,IAAI,CAAC,UAAC,cAAmB;gBAC3C,OAAO,cAAc,KAAK,IAAI,CAAA;YAChC,CAAC,CAAC,CAAA;QACJ,CAAC,CAAC;YAEF,OAAO,IAAI,CAAA;KACd;IAED,OAAO,KAAK,CAAA;AACd,CAAC,CAAA;AAbY,QAAA,SAAS,aAarB"}

package/dist/aiTranslate.d.ts

@@ -1,5 +1,7 @@
 import type { CollectionAfterChangeHook } from 'payload/types';
-declare const aiTranslate: ({ collection }: {
+declare const aiTranslateHook: ({ collectionOptions, collection }: {
+    collectionOptions: any;
     collection: object;
 }, fallback?: string) => CollectionAfterChangeHook;
-export default aiTranslate;
+export default aiTranslateHook;
+export declare function translateCollection({ req, doc, collection, previousDoc, context, collectionOptions, onlyMissing, }: any): Promise<void>;