@foundrykit/seo-plugin 0.0.0-stage → 0.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (71) hide show
  1. package/README.md +270 -2
  2. package/dist/components/JsonLdEditor.d.ts +2 -0
  3. package/dist/components/JsonLdEditor.js +1184 -0
  4. package/dist/components/JsonLdEditor.js.map +1 -0
  5. package/dist/components/JsonLdTemplateRowLabel.d.ts +2 -0
  6. package/dist/components/JsonLdTemplateRowLabel.js +12 -0
  7. package/dist/components/JsonLdTemplateRowLabel.js.map +1 -0
  8. package/dist/components/MetaDescriptionComponent.d.ts +8 -0
  9. package/dist/components/MetaDescriptionComponent.js +101 -0
  10. package/dist/components/MetaDescriptionComponent.js.map +1 -0
  11. package/dist/components/MetaTitleComponent.d.ts +9 -0
  12. package/dist/components/MetaTitleComponent.js +193 -0
  13. package/dist/components/MetaTitleComponent.js.map +1 -0
  14. package/dist/components/OverviewComponent.d.ts +8 -0
  15. package/dist/components/OverviewComponent.js +64 -0
  16. package/dist/components/OverviewComponent.js.map +1 -0
  17. package/dist/components/PreviewComponent.d.ts +8 -0
  18. package/dist/components/PreviewComponent.js +51 -0
  19. package/dist/components/PreviewComponent.js.map +1 -0
  20. package/dist/exports/client.d.ts +6 -0
  21. package/dist/exports/client.js +8 -0
  22. package/dist/exports/client.js.map +1 -0
  23. package/dist/exports/next.d.ts +2 -0
  24. package/dist/exports/next.js +3 -0
  25. package/dist/exports/next.js.map +1 -0
  26. package/dist/exports/rsc.d.ts +1 -0
  27. package/dist/exports/rsc.js +5 -0
  28. package/dist/exports/rsc.js.map +1 -0
  29. package/dist/fields.d.ts +67 -0
  30. package/dist/fields.js +220 -0
  31. package/dist/fields.js.map +1 -0
  32. package/dist/global.d.ts +6 -0
  33. package/dist/global.js +93 -0
  34. package/dist/global.js.map +1 -0
  35. package/dist/helpers.d.ts +44 -0
  36. package/dist/helpers.js +23 -0
  37. package/dist/helpers.js.map +1 -0
  38. package/dist/helpers.test.d.ts +1 -0
  39. package/dist/helpers.test.js +234 -0
  40. package/dist/helpers.test.js.map +1 -0
  41. package/dist/hooks/autoAlternates.d.ts +18 -0
  42. package/dist/hooks/autoAlternates.js +63 -0
  43. package/dist/hooks/autoAlternates.js.map +1 -0
  44. package/dist/hooks/autoAlternates.test.d.ts +1 -0
  45. package/dist/hooks/autoAlternates.test.js +225 -0
  46. package/dist/hooks/autoAlternates.test.js.map +1 -0
  47. package/dist/hooks/generateMeta.d.ts +17 -0
  48. package/dist/hooks/generateMeta.js +58 -0
  49. package/dist/hooks/generateMeta.js.map +1 -0
  50. package/dist/hooks/generateMeta.test.d.ts +1 -0
  51. package/dist/hooks/generateMeta.test.js +132 -0
  52. package/dist/hooks/generateMeta.test.js.map +1 -0
  53. package/dist/hooks/ogImageGenerator.d.ts +19 -0
  54. package/dist/hooks/ogImageGenerator.js +96 -0
  55. package/dist/hooks/ogImageGenerator.js.map +1 -0
  56. package/dist/index.d.ts +87 -0
  57. package/dist/index.js +269 -0
  58. package/dist/index.js.map +1 -0
  59. package/dist/jsonld.d.ts +83 -0
  60. package/dist/jsonld.js +179 -0
  61. package/dist/jsonld.js.map +1 -0
  62. package/dist/jsonld.test.d.ts +1 -0
  63. package/dist/jsonld.test.js +214 -0
  64. package/dist/jsonld.test.js.map +1 -0
  65. package/dist/metadata.d.ts +53 -0
  66. package/dist/metadata.js +114 -0
  67. package/dist/metadata.js.map +1 -0
  68. package/dist/metadata.test.d.ts +1 -0
  69. package/dist/metadata.test.js +286 -0
  70. package/dist/metadata.test.js.map +1 -0
  71. package/package.json +100 -3
@@ -0,0 +1,58 @@
1
+ /**
2
+ * beforeChange hook — auto-populates meta.title and meta.url when:
3
+ * - generateTitle is configured and meta.title is empty
4
+ * - generateURL is configured and meta.url is empty
5
+ *
6
+ * Existing values are never overwritten — the editor always wins.
7
+ * Both functions are called in parallel for efficiency.
8
+ */ export const buildGenerateMetaHook = ({ collectionSlug, generateTitle, generateURL })=>{
9
+ return async ({ data, req })=>{
10
+ const meta = data.meta ?? {};
11
+ const safeCall = async (fn, onError)=>{
12
+ try {
13
+ return await fn();
14
+ } catch (err) {
15
+ onError(err);
16
+ return null;
17
+ }
18
+ };
19
+ const [generatedTitle, generatedURL] = await Promise.all([
20
+ // Only call generateTitle if the field is currently empty
21
+ generateTitle && !meta.title ? safeCall(()=>generateTitle({
22
+ collectionSlug,
23
+ data,
24
+ req
25
+ }), (err)=>req.payload.logger.error({
26
+ err,
27
+ msg: '[seo-plugin] generateTitle threw an error'
28
+ })) : null,
29
+ // Only call generateURL if the field is currently empty
30
+ generateURL && !meta.url ? safeCall(()=>generateURL({
31
+ collectionSlug,
32
+ data,
33
+ req
34
+ }), (err)=>req.payload.logger.error({
35
+ err,
36
+ msg: '[seo-plugin] generateURL threw an error'
37
+ })) : null
38
+ ]);
39
+ // Only patch the data object if something was actually generated
40
+ if (!generatedTitle && !generatedURL) {
41
+ return data;
42
+ }
43
+ return {
44
+ ...data,
45
+ meta: {
46
+ ...meta,
47
+ ...generatedTitle ? {
48
+ title: generatedTitle
49
+ } : {},
50
+ ...generatedURL ? {
51
+ url: generatedURL
52
+ } : {}
53
+ }
54
+ };
55
+ };
56
+ };
57
+
58
+ //# sourceMappingURL=generateMeta.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"sources":["../../src/hooks/generateMeta.ts"],"sourcesContent":["import type { CollectionBeforeChangeHook } from 'payload';\n\nimport type { GenerateTitleArgs, GenerateURLArgs } from '../index.js';\n\ntype BuildGenerateMetaHookArgs = {\n collectionSlug: string;\n generateTitle?: (\n args: GenerateTitleArgs\n ) => string | null | Promise<string | null>;\n generateURL?: (\n args: GenerateURLArgs\n ) => string | null | Promise<string | null>;\n};\n\n/**\n * beforeChange hook — auto-populates meta.title and meta.url when:\n * - generateTitle is configured and meta.title is empty\n * - generateURL is configured and meta.url is empty\n *\n * Existing values are never overwritten — the editor always wins.\n * Both functions are called in parallel for efficiency.\n */\nexport const buildGenerateMetaHook = ({\n collectionSlug,\n generateTitle,\n generateURL,\n}: BuildGenerateMetaHookArgs): CollectionBeforeChangeHook => {\n return async ({ data, req }) => {\n const meta = (data.meta as Record<string, unknown>) ?? {};\n\n const safeCall = async (\n fn: () => string | null | Promise<string | null>,\n onError: (err: unknown) => void\n ): Promise<null | string> => {\n try {\n return await fn();\n } catch (err) {\n onError(err);\n return null;\n }\n };\n\n const [generatedTitle, generatedURL] = await Promise.all([\n // Only call generateTitle if the field is currently empty\n generateTitle && !meta.title\n ? safeCall(\n () => generateTitle({ collectionSlug, data, req }),\n err =>\n req.payload.logger.error({\n err,\n msg: '[seo-plugin] generateTitle threw an error',\n })\n )\n : null,\n\n // Only call generateURL if the field is currently empty\n generateURL && !meta.url\n ? safeCall(\n () => generateURL({ collectionSlug, data, req }),\n err =>\n req.payload.logger.error({\n err,\n msg: '[seo-plugin] generateURL threw an error',\n })\n )\n : null,\n ]);\n\n // Only patch the data object if something was actually generated\n if (!generatedTitle && !generatedURL) {\n return data;\n }\n\n return {\n ...data,\n meta: {\n ...meta,\n ...(generatedTitle ? { title: generatedTitle } : {}),\n ...(generatedURL ? { url: generatedURL } : {}),\n },\n };\n };\n};\n"],"names":["buildGenerateMetaHook","collectionSlug","generateTitle","generateURL","data","req","meta","safeCall","fn","onError","err","generatedTitle","generatedURL","Promise","all","title","payload","logger","error","msg","url"],"mappings":"AAcA;;;;;;;CAOC,GACD,OAAO,MAAMA,wBAAwB,CAAC,EACpCC,cAAc,EACdC,aAAa,EACbC,WAAW,EACe;IAC1B,OAAO,OAAO,EAAEC,IAAI,EAAEC,GAAG,EAAE;QACzB,MAAMC,OAAO,AAACF,KAAKE,IAAI,IAAgC,CAAC;QAExD,MAAMC,WAAW,OACfC,IACAC;YAEA,IAAI;gBACF,OAAO,MAAMD;YACf,EAAE,OAAOE,KAAK;gBACZD,QAAQC;gBACR,OAAO;YACT;QACF;QAEA,MAAM,CAACC,gBAAgBC,aAAa,GAAG,MAAMC,QAAQC,GAAG,CAAC;YACvD,0DAA0D;YAC1DZ,iBAAiB,CAACI,KAAKS,KAAK,GACxBR,SACE,IAAML,cAAc;oBAAED;oBAAgBG;oBAAMC;gBAAI,IAChDK,CAAAA,MACEL,IAAIW,OAAO,CAACC,MAAM,CAACC,KAAK,CAAC;oBACvBR;oBACAS,KAAK;gBACP,MAEJ;YAEJ,wDAAwD;YACxDhB,eAAe,CAACG,KAAKc,GAAG,GACpBb,SACE,IAAMJ,YAAY;oBAAEF;oBAAgBG;oBAAMC;gBAAI,IAC9CK,CAAAA,MACEL,IAAIW,OAAO,CAACC,MAAM,CAACC,KAAK,CAAC;oBACvBR;oBACAS,KAAK;gBACP,MAEJ;SACL;QAED,iEAAiE;QACjE,IAAI,CAACR,kBAAkB,CAACC,cAAc;YACpC,OAAOR;QACT;QAEA,OAAO;YACL,GAAGA,IAAI;YACPE,MAAM;gBACJ,GAAGA,IAAI;gBACP,GAAIK,iBAAiB;oBAAEI,OAAOJ;gBAAe,IAAI,CAAC,CAAC;gBACnD,GAAIC,eAAe;oBAAEQ,KAAKR;gBAAa,IAAI,CAAC,CAAC;YAC/C;QACF;IACF;AACF,EAAE"}
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1,132 @@
1
+ import { describe, expect, it, vi } from 'vitest';
2
+ import { buildGenerateMetaHook } from './generateMeta.js';
3
+ const mockReq = {
4
+ payload: {
5
+ logger: {
6
+ error: vi.fn()
7
+ }
8
+ }
9
+ };
10
+ const runHook = (hook, data)=>hook({
11
+ collection: {},
12
+ context: {},
13
+ data,
14
+ operation: 'create',
15
+ req: mockReq
16
+ });
17
+ describe('buildGenerateMetaHook', ()=>{
18
+ it('returns data unchanged when neither generateTitle nor generateURL is configured', async ()=>{
19
+ const hook = buildGenerateMetaHook({
20
+ collectionSlug: 'posts'
21
+ });
22
+ const data = {
23
+ title: 'Hello',
24
+ meta: {}
25
+ };
26
+ const result = await runHook(hook, data);
27
+ expect(result).toEqual(data);
28
+ });
29
+ it('populates meta.title when empty and generateTitle is configured', async ()=>{
30
+ const hook = buildGenerateMetaHook({
31
+ collectionSlug: 'posts',
32
+ generateTitle: ({ data })=>`${data.title} | My Site`
33
+ });
34
+ const result = await runHook(hook, {
35
+ title: 'Hello',
36
+ meta: {}
37
+ });
38
+ expect(result.meta.title).toBe('Hello | My Site');
39
+ });
40
+ it('does not overwrite meta.title when already set', async ()=>{
41
+ const hook = buildGenerateMetaHook({
42
+ collectionSlug: 'posts',
43
+ generateTitle: ()=>'Generated title'
44
+ });
45
+ const result = await runHook(hook, {
46
+ meta: {
47
+ title: 'Existing title'
48
+ }
49
+ });
50
+ expect(result.meta.title).toBe('Existing title');
51
+ });
52
+ it('populates meta.url when empty and generateURL is configured', async ()=>{
53
+ const hook = buildGenerateMetaHook({
54
+ collectionSlug: 'posts',
55
+ generateURL: ({ data })=>`https://example.com/posts/${data.slug}`
56
+ });
57
+ const result = await runHook(hook, {
58
+ slug: 'my-post',
59
+ meta: {}
60
+ });
61
+ expect(result.meta.url).toBe('https://example.com/posts/my-post');
62
+ });
63
+ it('does not overwrite meta.url when already set', async ()=>{
64
+ const hook = buildGenerateMetaHook({
65
+ collectionSlug: 'posts',
66
+ generateURL: ()=>'https://example.com/generated'
67
+ });
68
+ const result = await runHook(hook, {
69
+ meta: {
70
+ url: 'https://example.com/existing'
71
+ }
72
+ });
73
+ expect(result.meta.url).toBe('https://example.com/existing');
74
+ });
75
+ it('populates both title and url in parallel', async ()=>{
76
+ const hook = buildGenerateMetaHook({
77
+ collectionSlug: 'posts',
78
+ generateTitle: ({ data })=>`${data.title} | Site`,
79
+ generateURL: ({ data })=>`https://example.com/${data.slug}`
80
+ });
81
+ const result = await runHook(hook, {
82
+ title: 'Hello',
83
+ slug: 'hello',
84
+ meta: {}
85
+ });
86
+ expect(result.meta.title).toBe('Hello | Site');
87
+ expect(result.meta.url).toBe('https://example.com/hello');
88
+ });
89
+ it('skips title but still generates url when title is already set', async ()=>{
90
+ const hook = buildGenerateMetaHook({
91
+ collectionSlug: 'posts',
92
+ generateTitle: ()=>'Generated',
93
+ generateURL: ({ data })=>`https://example.com/${data.slug}`
94
+ });
95
+ const result = await runHook(hook, {
96
+ slug: 'hello',
97
+ meta: {
98
+ title: 'Existing'
99
+ }
100
+ });
101
+ expect(result.meta.title).toBe('Existing');
102
+ expect(result.meta.url).toBe('https://example.com/hello');
103
+ });
104
+ it('returns null from generateTitle gracefully and still sets url', async ()=>{
105
+ const hook = buildGenerateMetaHook({
106
+ collectionSlug: 'posts',
107
+ generateTitle: ()=>null,
108
+ generateURL: ()=>'https://example.com/page'
109
+ });
110
+ const result = await runHook(hook, {
111
+ meta: {}
112
+ });
113
+ expect(result.meta.title).toBeUndefined();
114
+ expect(result.meta.url).toBe('https://example.com/page');
115
+ });
116
+ it('logs and continues when generateTitle throws', async ()=>{
117
+ const hook = buildGenerateMetaHook({
118
+ collectionSlug: 'posts',
119
+ generateTitle: ()=>{
120
+ throw new Error('boom');
121
+ },
122
+ generateURL: ()=>'https://example.com/page'
123
+ });
124
+ const result = await runHook(hook, {
125
+ meta: {}
126
+ });
127
+ expect(mockReq.payload.logger.error).toHaveBeenCalled();
128
+ expect(result.meta.url).toBe('https://example.com/page');
129
+ });
130
+ });
131
+
132
+ //# sourceMappingURL=generateMeta.test.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"sources":["../../src/hooks/generateMeta.test.ts"],"sourcesContent":["import { describe, expect, it, vi } from 'vitest';\n\nimport { buildGenerateMetaHook } from './generateMeta.js';\n\nconst mockReq = {\n payload: {\n logger: { error: vi.fn() },\n },\n} as any;\n\nconst runHook = (\n hook: ReturnType<typeof buildGenerateMetaHook>,\n data: Record<string, unknown>\n) =>\n hook({\n collection: {} as any,\n context: {},\n data,\n operation: 'create',\n req: mockReq,\n });\n\ndescribe('buildGenerateMetaHook', () => {\n it('returns data unchanged when neither generateTitle nor generateURL is configured', async () => {\n const hook = buildGenerateMetaHook({ collectionSlug: 'posts' });\n const data = { title: 'Hello', meta: {} };\n const result = await runHook(hook, data);\n expect(result).toEqual(data);\n });\n\n it('populates meta.title when empty and generateTitle is configured', async () => {\n const hook = buildGenerateMetaHook({\n collectionSlug: 'posts',\n generateTitle: ({ data }) => `${data.title} | My Site`,\n });\n const result = await runHook(hook, { title: 'Hello', meta: {} });\n expect((result as any).meta.title).toBe('Hello | My Site');\n });\n\n it('does not overwrite meta.title when already set', async () => {\n const hook = buildGenerateMetaHook({\n collectionSlug: 'posts',\n generateTitle: () => 'Generated title',\n });\n const result = await runHook(hook, { meta: { title: 'Existing title' } });\n expect((result as any).meta.title).toBe('Existing title');\n });\n\n it('populates meta.url when empty and generateURL is configured', async () => {\n const hook = buildGenerateMetaHook({\n collectionSlug: 'posts',\n generateURL: ({ data }) => `https://example.com/posts/${data.slug}`,\n });\n const result = await runHook(hook, { slug: 'my-post', meta: {} });\n expect((result as any).meta.url).toBe('https://example.com/posts/my-post');\n });\n\n it('does not overwrite meta.url when already set', async () => {\n const hook = buildGenerateMetaHook({\n collectionSlug: 'posts',\n generateURL: () => 'https://example.com/generated',\n });\n const result = await runHook(hook, {\n meta: { url: 'https://example.com/existing' },\n });\n expect((result as any).meta.url).toBe('https://example.com/existing');\n });\n\n it('populates both title and url in parallel', async () => {\n const hook = buildGenerateMetaHook({\n collectionSlug: 'posts',\n generateTitle: ({ data }) => `${data.title} | Site`,\n generateURL: ({ data }) => `https://example.com/${data.slug}`,\n });\n const result = await runHook(hook, {\n title: 'Hello',\n slug: 'hello',\n meta: {},\n });\n expect((result as any).meta.title).toBe('Hello | Site');\n expect((result as any).meta.url).toBe('https://example.com/hello');\n });\n\n it('skips title but still generates url when title is already set', async () => {\n const hook = buildGenerateMetaHook({\n collectionSlug: 'posts',\n generateTitle: () => 'Generated',\n generateURL: ({ data }) => `https://example.com/${data.slug}`,\n });\n const result = await runHook(hook, {\n slug: 'hello',\n meta: { title: 'Existing' },\n });\n expect((result as any).meta.title).toBe('Existing');\n expect((result as any).meta.url).toBe('https://example.com/hello');\n });\n\n it('returns null from generateTitle gracefully and still sets url', async () => {\n const hook = buildGenerateMetaHook({\n collectionSlug: 'posts',\n generateTitle: () => null,\n generateURL: () => 'https://example.com/page',\n });\n const result = await runHook(hook, { meta: {} });\n expect((result as any).meta.title).toBeUndefined();\n expect((result as any).meta.url).toBe('https://example.com/page');\n });\n\n it('logs and continues when generateTitle throws', async () => {\n const hook = buildGenerateMetaHook({\n collectionSlug: 'posts',\n generateTitle: () => {\n throw new Error('boom');\n },\n generateURL: () => 'https://example.com/page',\n });\n const result = await runHook(hook, { meta: {} });\n expect(mockReq.payload.logger.error).toHaveBeenCalled();\n expect((result as any).meta.url).toBe('https://example.com/page');\n });\n});\n"],"names":["describe","expect","it","vi","buildGenerateMetaHook","mockReq","payload","logger","error","fn","runHook","hook","data","collection","context","operation","req","collectionSlug","title","meta","result","toEqual","generateTitle","toBe","generateURL","slug","url","toBeUndefined","Error","toHaveBeenCalled"],"mappings":"AAAA,SAASA,QAAQ,EAAEC,MAAM,EAAEC,EAAE,EAAEC,EAAE,QAAQ,SAAS;AAElD,SAASC,qBAAqB,QAAQ,oBAAoB;AAE1D,MAAMC,UAAU;IACdC,SAAS;QACPC,QAAQ;YAAEC,OAAOL,GAAGM,EAAE;QAAG;IAC3B;AACF;AAEA,MAAMC,UAAU,CACdC,MACAC,OAEAD,KAAK;QACHE,YAAY,CAAC;QACbC,SAAS,CAAC;QACVF;QACAG,WAAW;QACXC,KAAKX;IACP;AAEFL,SAAS,yBAAyB;IAChCE,GAAG,mFAAmF;QACpF,MAAMS,OAAOP,sBAAsB;YAAEa,gBAAgB;QAAQ;QAC7D,MAAML,OAAO;YAAEM,OAAO;YAASC,MAAM,CAAC;QAAE;QACxC,MAAMC,SAAS,MAAMV,QAAQC,MAAMC;QACnCX,OAAOmB,QAAQC,OAAO,CAACT;IACzB;IAEAV,GAAG,mEAAmE;QACpE,MAAMS,OAAOP,sBAAsB;YACjCa,gBAAgB;YAChBK,eAAe,CAAC,EAAEV,IAAI,EAAE,GAAK,GAAGA,KAAKM,KAAK,CAAC,UAAU,CAAC;QACxD;QACA,MAAME,SAAS,MAAMV,QAAQC,MAAM;YAAEO,OAAO;YAASC,MAAM,CAAC;QAAE;QAC9DlB,OAAO,AAACmB,OAAeD,IAAI,CAACD,KAAK,EAAEK,IAAI,CAAC;IAC1C;IAEArB,GAAG,kDAAkD;QACnD,MAAMS,OAAOP,sBAAsB;YACjCa,gBAAgB;YAChBK,eAAe,IAAM;QACvB;QACA,MAAMF,SAAS,MAAMV,QAAQC,MAAM;YAAEQ,MAAM;gBAAED,OAAO;YAAiB;QAAE;QACvEjB,OAAO,AAACmB,OAAeD,IAAI,CAACD,KAAK,EAAEK,IAAI,CAAC;IAC1C;IAEArB,GAAG,+DAA+D;QAChE,MAAMS,OAAOP,sBAAsB;YACjCa,gBAAgB;YAChBO,aAAa,CAAC,EAAEZ,IAAI,EAAE,GAAK,CAAC,0BAA0B,EAAEA,KAAKa,IAAI,EAAE;QACrE;QACA,MAAML,SAAS,MAAMV,QAAQC,MAAM;YAAEc,MAAM;YAAWN,MAAM,CAAC;QAAE;QAC/DlB,OAAO,AAACmB,OAAeD,IAAI,CAACO,GAAG,EAAEH,IAAI,CAAC;IACxC;IAEArB,GAAG,gDAAgD;QACjD,MAAMS,OAAOP,sBAAsB;YACjCa,gBAAgB;YAChBO,aAAa,IAAM;QACrB;QACA,MAAMJ,SAAS,MAAMV,QAAQC,MAAM;YACjCQ,MAAM;gBAAEO,KAAK;YAA+B;QAC9C;QACAzB,OAAO,AAACmB,OAAeD,IAAI,CAACO,GAAG,EAAEH,IAAI,CAAC;IACxC;IAEArB,GAAG,4CAA4C;QAC7C,MAAMS,OAAOP,sBAAsB;YACjCa,gBAAgB;YAChBK,eAAe,CAAC,EAAEV,IAAI,EAAE,GAAK,GAAGA,KAAKM,KAAK,CAAC,OAAO,CAAC;YACnDM,aAAa,CAAC,EAAEZ,IAAI,EAAE,GAAK,CAAC,oBAAoB,EAAEA,KAAKa,IAAI,EAAE;QAC/D;QACA,MAAML,SAAS,MAAMV,QAAQC,MAAM;YACjCO,OAAO;YACPO,MAAM;YACNN,MAAM,CAAC;QACT;QACAlB,OAAO,AAACmB,OAAeD,IAAI,CAACD,KAAK,EAAEK,IAAI,CAAC;QACxCtB,OAAO,AAACmB,OAAeD,IAAI,CAACO,GAAG,EAAEH,IAAI,CAAC;IACxC;IAEArB,GAAG,iEAAiE;QAClE,MAAMS,OAAOP,sBAAsB;YACjCa,gBAAgB;YAChBK,eAAe,IAAM;YACrBE,aAAa,CAAC,EAAEZ,IAAI,EAAE,GAAK,CAAC,oBAAoB,EAAEA,KAAKa,IAAI,EAAE;QAC/D;QACA,MAAML,SAAS,MAAMV,QAAQC,MAAM;YACjCc,MAAM;YACNN,MAAM;gBAAED,OAAO;YAAW;QAC5B;QACAjB,OAAO,AAACmB,OAAeD,IAAI,CAACD,KAAK,EAAEK,IAAI,CAAC;QACxCtB,OAAO,AAACmB,OAAeD,IAAI,CAACO,GAAG,EAAEH,IAAI,CAAC;IACxC;IAEArB,GAAG,iEAAiE;QAClE,MAAMS,OAAOP,sBAAsB;YACjCa,gBAAgB;YAChBK,eAAe,IAAM;YACrBE,aAAa,IAAM;QACrB;QACA,MAAMJ,SAAS,MAAMV,QAAQC,MAAM;YAAEQ,MAAM,CAAC;QAAE;QAC9ClB,OAAO,AAACmB,OAAeD,IAAI,CAACD,KAAK,EAAES,aAAa;QAChD1B,OAAO,AAACmB,OAAeD,IAAI,CAACO,GAAG,EAAEH,IAAI,CAAC;IACxC;IAEArB,GAAG,gDAAgD;QACjD,MAAMS,OAAOP,sBAAsB;YACjCa,gBAAgB;YAChBK,eAAe;gBACb,MAAM,IAAIM,MAAM;YAClB;YACAJ,aAAa,IAAM;QACrB;QACA,MAAMJ,SAAS,MAAMV,QAAQC,MAAM;YAAEQ,MAAM,CAAC;QAAE;QAC9ClB,OAAOI,QAAQC,OAAO,CAACC,MAAM,CAACC,KAAK,EAAEqB,gBAAgB;QACrD5B,OAAO,AAACmB,OAAeD,IAAI,CAACO,GAAG,EAAEH,IAAI,CAAC;IACxC;AACF"}
@@ -0,0 +1,19 @@
1
+ import type { CollectionAfterChangeHook } from 'payload';
2
+ import type { GenerateOgImageArgs } from '../index.js';
3
+ type BuildOgImageHookArgs = {
4
+ collectionSlug: string;
5
+ mediaCollection: string;
6
+ generateOgImage?: (args: GenerateOgImageArgs) => Buffer | null | Promise<Buffer | null>;
7
+ };
8
+ /**
9
+ * afterChange hook — generates and saves an OG image when:
10
+ * 1. The global-seo document has enableOgGenerator = true
11
+ * 2. The document has no meta.image set
12
+ * 3. A generateOgImage function is configured on the plugin
13
+ *
14
+ * The generated Buffer is saved to the configured media collection via
15
+ * Payload's local API and the resulting media ID is written back to
16
+ * meta.image on the document.
17
+ */
18
+ export declare const buildOgImageHook: ({ collectionSlug, mediaCollection, generateOgImage, }: BuildOgImageHookArgs) => CollectionAfterChangeHook;
19
+ export {};
@@ -0,0 +1,96 @@
1
+ /**
2
+ * afterChange hook — generates and saves an OG image when:
3
+ * 1. The global-seo document has enableOgGenerator = true
4
+ * 2. The document has no meta.image set
5
+ * 3. A generateOgImage function is configured on the plugin
6
+ *
7
+ * The generated Buffer is saved to the configured media collection via
8
+ * Payload's local API and the resulting media ID is written back to
9
+ * meta.image on the document.
10
+ */ export const buildOgImageHook = ({ collectionSlug, mediaCollection, generateOgImage })=>{
11
+ return async ({ doc, req })=>{
12
+ // Nothing to do if no generator configured
13
+ if (!generateOgImage) {
14
+ return doc;
15
+ }
16
+ // Skip if the doc already has a meta image
17
+ if (doc?.meta?.image) {
18
+ return doc;
19
+ }
20
+ // Check the global-seo toggle
21
+ let enabled = false;
22
+ try {
23
+ const globalSeo = await req.payload.findGlobal({
24
+ slug: 'global-seo',
25
+ depth: 0
26
+ });
27
+ enabled = Boolean(globalSeo.enableOgGenerator);
28
+ } catch {
29
+ // global-seo may not exist yet, skip silently
30
+ return doc;
31
+ }
32
+ if (!enabled) {
33
+ return doc;
34
+ }
35
+ // Call the user-supplied generator
36
+ let imageBuffer = null;
37
+ try {
38
+ imageBuffer = await generateOgImage({
39
+ doc,
40
+ collectionSlug
41
+ });
42
+ } catch (err) {
43
+ req.payload.logger.error({
44
+ err,
45
+ msg: '[seo-plugin] generateOgImage threw an error'
46
+ });
47
+ return doc;
48
+ }
49
+ if (!imageBuffer) {
50
+ return doc;
51
+ }
52
+ // Save the buffer to the media collection
53
+ let mediaDoc;
54
+ try {
55
+ const filename = `og-${collectionSlug}-${doc.id ?? Date.now()}.png`;
56
+ mediaDoc = await req.payload.create({
57
+ collection: mediaCollection,
58
+ data: {},
59
+ file: {
60
+ data: imageBuffer,
61
+ mimetype: 'image/png',
62
+ name: filename,
63
+ size: imageBuffer.length
64
+ }
65
+ });
66
+ } catch (err) {
67
+ req.payload.logger.error({
68
+ err,
69
+ msg: '[seo-plugin] Failed to save OG image to media collection'
70
+ });
71
+ return doc;
72
+ }
73
+ // Write meta.image back to the document
74
+ try {
75
+ const updated = await req.payload.update({
76
+ id: doc.id,
77
+ collection: collectionSlug,
78
+ data: {
79
+ meta: {
80
+ ...doc.meta ?? {},
81
+ image: mediaDoc.id
82
+ }
83
+ }
84
+ });
85
+ return updated;
86
+ } catch (err) {
87
+ req.payload.logger.error({
88
+ err,
89
+ msg: '[seo-plugin] Failed to write meta.image back to document'
90
+ });
91
+ return doc;
92
+ }
93
+ };
94
+ };
95
+
96
+ //# sourceMappingURL=ogImageGenerator.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"sources":["../../src/hooks/ogImageGenerator.ts"],"sourcesContent":["import type { CollectionAfterChangeHook } from 'payload';\n\nimport type { GenerateOgImageArgs } from '../index.js';\n\ntype BuildOgImageHookArgs = {\n collectionSlug: string;\n mediaCollection: string;\n generateOgImage?: (\n args: GenerateOgImageArgs\n ) => Buffer | null | Promise<Buffer | null>;\n};\n\n/**\n * afterChange hook — generates and saves an OG image when:\n * 1. The global-seo document has enableOgGenerator = true\n * 2. The document has no meta.image set\n * 3. A generateOgImage function is configured on the plugin\n *\n * The generated Buffer is saved to the configured media collection via\n * Payload's local API and the resulting media ID is written back to\n * meta.image on the document.\n */\nexport const buildOgImageHook = ({\n collectionSlug,\n mediaCollection,\n generateOgImage,\n}: BuildOgImageHookArgs): CollectionAfterChangeHook => {\n return async ({ doc, req }) => {\n // Nothing to do if no generator configured\n if (!generateOgImage) {\n return doc;\n }\n\n // Skip if the doc already has a meta image\n if (doc?.meta?.image) {\n return doc;\n }\n\n // Check the global-seo toggle\n let enabled = false;\n try {\n const globalSeo = await req.payload.findGlobal({\n slug: 'global-seo',\n depth: 0,\n });\n enabled = Boolean(\n (globalSeo as Record<string, unknown>).enableOgGenerator\n );\n } catch {\n // global-seo may not exist yet, skip silently\n return doc;\n }\n\n if (!enabled) {\n return doc;\n }\n\n // Call the user-supplied generator\n let imageBuffer: Buffer | null = null;\n try {\n imageBuffer = await generateOgImage({ doc, collectionSlug });\n } catch (err) {\n req.payload.logger.error({\n err,\n msg: '[seo-plugin] generateOgImage threw an error',\n });\n return doc;\n }\n\n if (!imageBuffer) {\n return doc;\n }\n\n // Save the buffer to the media collection\n let mediaDoc: Record<string, unknown>;\n try {\n const filename = `og-${collectionSlug}-${doc.id ?? Date.now()}.png`;\n mediaDoc = (await req.payload.create({\n collection: mediaCollection,\n data: {},\n file: {\n data: imageBuffer,\n mimetype: 'image/png',\n name: filename,\n size: imageBuffer.length,\n },\n })) as Record<string, unknown>;\n } catch (err) {\n req.payload.logger.error({\n err,\n msg: '[seo-plugin] Failed to save OG image to media collection',\n });\n return doc;\n }\n\n // Write meta.image back to the document\n try {\n const updated = await req.payload.update({\n id: doc.id,\n collection: collectionSlug,\n data: {\n meta: {\n ...(doc.meta ?? {}),\n image: mediaDoc.id,\n },\n },\n });\n return updated;\n } catch (err) {\n req.payload.logger.error({\n err,\n msg: '[seo-plugin] Failed to write meta.image back to document',\n });\n return doc;\n }\n };\n};\n"],"names":["buildOgImageHook","collectionSlug","mediaCollection","generateOgImage","doc","req","meta","image","enabled","globalSeo","payload","findGlobal","slug","depth","Boolean","enableOgGenerator","imageBuffer","err","logger","error","msg","mediaDoc","filename","id","Date","now","create","collection","data","file","mimetype","name","size","length","updated","update"],"mappings":"AAYA;;;;;;;;;CASC,GACD,OAAO,MAAMA,mBAAmB,CAAC,EAC/BC,cAAc,EACdC,eAAe,EACfC,eAAe,EACM;IACrB,OAAO,OAAO,EAAEC,GAAG,EAAEC,GAAG,EAAE;QACxB,2CAA2C;QAC3C,IAAI,CAACF,iBAAiB;YACpB,OAAOC;QACT;QAEA,2CAA2C;QAC3C,IAAIA,KAAKE,MAAMC,OAAO;YACpB,OAAOH;QACT;QAEA,8BAA8B;QAC9B,IAAII,UAAU;QACd,IAAI;YACF,MAAMC,YAAY,MAAMJ,IAAIK,OAAO,CAACC,UAAU,CAAC;gBAC7CC,MAAM;gBACNC,OAAO;YACT;YACAL,UAAUM,QACR,AAACL,UAAsCM,iBAAiB;QAE5D,EAAE,OAAM;YACN,8CAA8C;YAC9C,OAAOX;QACT;QAEA,IAAI,CAACI,SAAS;YACZ,OAAOJ;QACT;QAEA,mCAAmC;QACnC,IAAIY,cAA6B;QACjC,IAAI;YACFA,cAAc,MAAMb,gBAAgB;gBAAEC;gBAAKH;YAAe;QAC5D,EAAE,OAAOgB,KAAK;YACZZ,IAAIK,OAAO,CAACQ,MAAM,CAACC,KAAK,CAAC;gBACvBF;gBACAG,KAAK;YACP;YACA,OAAOhB;QACT;QAEA,IAAI,CAACY,aAAa;YAChB,OAAOZ;QACT;QAEA,0CAA0C;QAC1C,IAAIiB;QACJ,IAAI;YACF,MAAMC,WAAW,CAAC,GAAG,EAAErB,eAAe,CAAC,EAAEG,IAAImB,EAAE,IAAIC,KAAKC,GAAG,GAAG,IAAI,CAAC;YACnEJ,WAAY,MAAMhB,IAAIK,OAAO,CAACgB,MAAM,CAAC;gBACnCC,YAAYzB;gBACZ0B,MAAM,CAAC;gBACPC,MAAM;oBACJD,MAAMZ;oBACNc,UAAU;oBACVC,MAAMT;oBACNU,MAAMhB,YAAYiB,MAAM;gBAC1B;YACF;QACF,EAAE,OAAOhB,KAAK;YACZZ,IAAIK,OAAO,CAACQ,MAAM,CAACC,KAAK,CAAC;gBACvBF;gBACAG,KAAK;YACP;YACA,OAAOhB;QACT;QAEA,wCAAwC;QACxC,IAAI;YACF,MAAM8B,UAAU,MAAM7B,IAAIK,OAAO,CAACyB,MAAM,CAAC;gBACvCZ,IAAInB,IAAImB,EAAE;gBACVI,YAAY1B;gBACZ2B,MAAM;oBACJtB,MAAM;wBACJ,GAAIF,IAAIE,IAAI,IAAI,CAAC,CAAC;wBAClBC,OAAOc,SAASE,EAAE;oBACpB;gBACF;YACF;YACA,OAAOW;QACT,EAAE,OAAOjB,KAAK;YACZZ,IAAIK,OAAO,CAACQ,MAAM,CAACC,KAAK,CAAC;gBACvBF;gBACAG,KAAK;YACP;YACA,OAAOhB;QACT;IACF;AACF,EAAE"}
@@ -0,0 +1,87 @@
1
+ import type { CollectionSlug, Config } from 'payload';
2
+ import { MetaAlternatesField, MetaDescriptionField, MetaImageField, MetaJsonLdField, MetaNofollowField, MetaNoindexField, MetaPreviewField, MetaTitleField, MetaUrlField, OverviewField, structuredDataRow } from './fields.js';
3
+ export type GenerateAlternateURLArgs = {
4
+ collectionSlug: string;
5
+ doc: Record<string, unknown>;
6
+ locale: string;
7
+ };
8
+ export type GenerateOgImageArgs = {
9
+ collectionSlug: string;
10
+ doc: Record<string, unknown>;
11
+ };
12
+ export type GenerateTitleArgs = {
13
+ collectionSlug: string;
14
+ data: Record<string, unknown>;
15
+ req: import('payload').PayloadRequest;
16
+ };
17
+ export type GenerateURLArgs = {
18
+ collectionSlug: string;
19
+ data: Record<string, unknown>;
20
+ req: import('payload').PayloadRequest;
21
+ };
22
+ export type SeoPluginConfig = {
23
+ /**
24
+ * Collections to inject the `meta` SEO group into.
25
+ * Set a collection slug to `true` to enable.
26
+ */
27
+ collections?: Partial<Record<CollectionSlug, true>>;
28
+ /**
29
+ * Disable the plugin without uninstalling it.
30
+ * Keeps DB schema consistent for migrations.
31
+ * @default false
32
+ */
33
+ disabled?: boolean;
34
+ /**
35
+ * Build the URL for an auto-generated alternate.
36
+ * Called once per locale for each document on read.
37
+ * Return null to skip a locale.
38
+ */
39
+ generateAlternateURL?: (args: GenerateAlternateURLArgs) => null | Promise<null | string> | string;
40
+ /**
41
+ * Called when the OG image generator is enabled and a document has no
42
+ * meta.image set. Return a Buffer (PNG/JPEG) to save as the OG image,
43
+ * or null to skip generation for this document.
44
+ */
45
+ generateOgImage?: (args: GenerateOgImageArgs) => Buffer | null | Promise<Buffer | null>;
46
+ /**
47
+ * Auto-populate meta.title on save when the field is empty.
48
+ * Return a string to set the title, or null to skip.
49
+ */
50
+ generateTitle?: (args: GenerateTitleArgs) => string | null | Promise<string | null>;
51
+ /**
52
+ * Auto-populate meta.url (canonical URL) on save when the field is empty.
53
+ * Return a string to set the URL, or null to skip.
54
+ */
55
+ generateURL?: (args: GenerateURLArgs) => string | null | Promise<string | null>;
56
+ /**
57
+ * BCP 47 locale codes used when auto-generating hreflang alternates.
58
+ * Required for auto-alternates to work.
59
+ * @example ['en', 'fr', 'de']
60
+ */
61
+ locales?: string[];
62
+ /**
63
+ * Media collection slug(s) used for the image picker.
64
+ * @default ['media']
65
+ */
66
+ mediaCollection?: string[];
67
+ /**
68
+ * When true, injects the SEO fields into a dedicated "SEO" tab using Payload's Tabs Field.
69
+ * If the collection's first field is already a `tabs` field, the SEO tab is appended to it.
70
+ * Otherwise a new tabs field is created with a "Content" tab wrapping existing fields and
71
+ * an "SEO" tab containing the meta fields.
72
+ * @default false
73
+ */
74
+ tabbedUI?: boolean;
75
+ };
76
+ export type { Alternate, DocWithMeta, GlobalSeoDefaults, ResolvedMeta, } from './helpers.js';
77
+ export { resolveMeta } from './helpers.js';
78
+ export type { ArticleJsonLdArgs, BreadcrumbItem, JsonLdBase, OrganizationJsonLdArgs, ProductJsonLdArgs, WebPageJsonLdArgs, } from './jsonld.js';
79
+ export { articleJsonLd, breadcrumbJsonLd, buildJsonLd, organizationJsonLd, productJsonLd, webPageJsonLd, } from './jsonld.js';
80
+ export type { MetadataResult, ToNextMetadataOptions } from './metadata.js';
81
+ export { toNextMetadata } from './metadata.js';
82
+ export { MetaAlternatesField, MetaDescriptionField, MetaImageField, MetaJsonLdField, MetaNofollowField, MetaNoindexField, MetaPreviewField, MetaTitleField, MetaUrlField, OverviewField, structuredDataRow, };
83
+ export declare const seoPlugin: (pluginOptions: SeoPluginConfig) => (incomingConfig: Config) => Config;
84
+ /** @deprecated Renamed to `seoPlugin`. */
85
+ export declare const advancedSeoPlugin: (pluginOptions: SeoPluginConfig) => (incomingConfig: Config) => Config;
86
+ /** @deprecated Renamed to `SeoPluginConfig`. */
87
+ export type AdvancedSeoPluginConfig = SeoPluginConfig;