@focus-reactive/payload-plugin-visual-editing 1.0.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 (119) hide show
  1. package/README.md +264 -0
  2. package/dist/admin/VisualEditingBridgeProvider.d.ts +4 -0
  3. package/dist/admin/VisualEditingBridgeProvider.js +144 -0
  4. package/dist/admin/VisualEditingBridgeProvider.js.map +1 -0
  5. package/dist/admin/expandAndFocus.d.ts +6 -0
  6. package/dist/admin/expandAndFocus.js +356 -0
  7. package/dist/admin/expandAndFocus.js.map +1 -0
  8. package/dist/admin/index.d.ts +1 -0
  9. package/dist/admin/index.js +3 -0
  10. package/dist/admin/index.js.map +1 -0
  11. package/dist/admin/parseFieldPath.d.ts +4 -0
  12. package/dist/admin/parseFieldPath.js +25 -0
  13. package/dist/admin/parseFieldPath.js.map +1 -0
  14. package/dist/admin/resolveContainerChain.d.ts +30 -0
  15. package/dist/admin/resolveContainerChain.js +171 -0
  16. package/dist/admin/resolveContainerChain.js.map +1 -0
  17. package/dist/client/VisualEditingOverlay.d.ts +4 -0
  18. package/dist/client/VisualEditingOverlay.js +30 -0
  19. package/dist/client/VisualEditingOverlay.js.map +1 -0
  20. package/dist/client/VisualEditingProvider.d.ts +23 -0
  21. package/dist/client/VisualEditingProvider.js +68 -0
  22. package/dist/client/VisualEditingProvider.js.map +1 -0
  23. package/dist/client/VisualEditingToggle.d.ts +1 -0
  24. package/dist/client/VisualEditingToggle.js +163 -0
  25. package/dist/client/VisualEditingToggle.js.map +1 -0
  26. package/dist/client/buildAdminEditUrl.d.ts +7 -0
  27. package/dist/client/buildAdminEditUrl.js +9 -0
  28. package/dist/client/buildAdminEditUrl.js.map +1 -0
  29. package/dist/client/index.d.ts +11 -0
  30. package/dist/client/index.js +13 -0
  31. package/dist/client/index.js.map +1 -0
  32. package/dist/client/overlay/constants.d.ts +9 -0
  33. package/dist/client/overlay/constants.js +49 -0
  34. package/dist/client/overlay/constants.js.map +1 -0
  35. package/dist/client/overlay/createOverlay.d.ts +11 -0
  36. package/dist/client/overlay/createOverlay.js +80 -0
  37. package/dist/client/overlay/createOverlay.js.map +1 -0
  38. package/dist/client/overlay/editBadge.d.ts +21 -0
  39. package/dist/client/overlay/editBadge.js +99 -0
  40. package/dist/client/overlay/editBadge.js.map +1 -0
  41. package/dist/client/overlay/hoverController.d.ts +14 -0
  42. package/dist/client/overlay/hoverController.js +137 -0
  43. package/dist/client/overlay/hoverController.js.map +1 -0
  44. package/dist/client/overlay/markerExtractor.d.ts +8 -0
  45. package/dist/client/overlay/markerExtractor.js +47 -0
  46. package/dist/client/overlay/markerExtractor.js.map +1 -0
  47. package/dist/client/overlay/mutationPipeline.d.ts +10 -0
  48. package/dist/client/overlay/mutationPipeline.js +78 -0
  49. package/dist/client/overlay/mutationPipeline.js.map +1 -0
  50. package/dist/client/overlay/stegaBookkeeper.d.ts +11 -0
  51. package/dist/client/overlay/stegaBookkeeper.js +36 -0
  52. package/dist/client/overlay/stegaBookkeeper.js.map +1 -0
  53. package/dist/client/overlay/stegaScanner.d.ts +11 -0
  54. package/dist/client/overlay/stegaScanner.js +54 -0
  55. package/dist/client/overlay/stegaScanner.js.map +1 -0
  56. package/dist/client/overlay/targetRegistry.d.ts +34 -0
  57. package/dist/client/overlay/targetRegistry.js +70 -0
  58. package/dist/client/overlay/targetRegistry.js.map +1 -0
  59. package/dist/client/overlay/targetSelector.d.ts +2 -0
  60. package/dist/client/overlay/targetSelector.js +67 -0
  61. package/dist/client/overlay/targetSelector.js.map +1 -0
  62. package/dist/client/overlayClickHandler.d.ts +7 -0
  63. package/dist/client/overlayClickHandler.js +24 -0
  64. package/dist/client/overlayClickHandler.js.map +1 -0
  65. package/dist/client/useVisualEditingOverlay.d.ts +4 -0
  66. package/dist/client/useVisualEditingOverlay.js +21 -0
  67. package/dist/client/useVisualEditingOverlay.js.map +1 -0
  68. package/dist/client/withVisualEditingPath.d.ts +9 -0
  69. package/dist/client/withVisualEditingPath.js +17 -0
  70. package/dist/client/withVisualEditingPath.js.map +1 -0
  71. package/dist/constants.d.ts +16 -0
  72. package/dist/constants.js +15 -0
  73. package/dist/constants.js.map +1 -0
  74. package/dist/excludeValues.d.ts +6 -0
  75. package/dist/excludeValues.js +24 -0
  76. package/dist/excludeValues.js.map +1 -0
  77. package/dist/index.d.ts +13 -0
  78. package/dist/index.js +107 -0
  79. package/dist/index.js.map +1 -0
  80. package/dist/internal/afterOperationHook.d.ts +10 -0
  81. package/dist/internal/afterOperationHook.js +28 -0
  82. package/dist/internal/afterOperationHook.js.map +1 -0
  83. package/dist/internal/afterReadHook.d.ts +2 -0
  84. package/dist/internal/afterReadHook.js +16 -0
  85. package/dist/internal/afterReadHook.js.map +1 -0
  86. package/dist/internal/beforeOperationHook.d.ts +4 -0
  87. package/dist/internal/beforeOperationHook.js +16 -0
  88. package/dist/internal/beforeOperationHook.js.map +1 -0
  89. package/dist/internal/buildFieldSchema.d.ts +3 -0
  90. package/dist/internal/buildFieldSchema.js +67 -0
  91. package/dist/internal/buildFieldSchema.js.map +1 -0
  92. package/dist/internal/encodeStega.d.ts +7 -0
  93. package/dist/internal/encodeStega.js +171 -0
  94. package/dist/internal/encodeStega.js.map +1 -0
  95. package/dist/internal/enrichWithPathMeta.d.ts +4 -0
  96. package/dist/internal/enrichWithPathMeta.js +76 -0
  97. package/dist/internal/enrichWithPathMeta.js.map +1 -0
  98. package/dist/internal/filterEditableFields.d.ts +2 -0
  99. package/dist/internal/filterEditableFields.js +88 -0
  100. package/dist/internal/filterEditableFields.js.map +1 -0
  101. package/dist/internal/gate.d.ts +2 -0
  102. package/dist/internal/gate.js +15 -0
  103. package/dist/internal/gate.js.map +1 -0
  104. package/dist/internal/globalAfterReadHook.d.ts +10 -0
  105. package/dist/internal/globalAfterReadHook.js +19 -0
  106. package/dist/internal/globalAfterReadHook.js.map +1 -0
  107. package/dist/internal/markTerminalUploads.d.ts +13 -0
  108. package/dist/internal/markTerminalUploads.js +79 -0
  109. package/dist/internal/markTerminalUploads.js.map +1 -0
  110. package/dist/internal/schemaCache.d.ts +10 -0
  111. package/dist/internal/schemaCache.js +29 -0
  112. package/dist/internal/schemaCache.js.map +1 -0
  113. package/dist/internal/shared.d.ts +32 -0
  114. package/dist/internal/shared.js +55 -0
  115. package/dist/internal/shared.js.map +1 -0
  116. package/dist/internal/stripStegaHook.d.ts +2 -0
  117. package/dist/internal/stripStegaHook.js +29 -0
  118. package/dist/internal/stripStegaHook.js.map +1 -0
  119. package/package.json +105 -0
@@ -0,0 +1,79 @@
1
+ import { isMetaInfo, isPlainObject, META_KEY } from "./shared.js";
2
+ const UPLOAD_SCHEMA_PATTERN = /^upload:(.+)$/;
3
+ /**
4
+ * Walk the doc tree; for every descendant object with its own `_meta`, look up
5
+ * its collection's schema and descend into the data in parallel. Whenever the
6
+ * schema says an `upload:<slug>` field lives at a key and the data has a
7
+ * populated value there, flip that value's `_meta.terminal = true` so the outer
8
+ * stega encoder skips it (preserving its identity for client-side wrapper attrs).
9
+ */ export const markTerminalUploads = (data, resolveSchema)=>{
10
+ if (Array.isArray(data)) {
11
+ for (const item of data)markTerminalUploads(item, resolveSchema);
12
+ return;
13
+ }
14
+ if (!isPlainObject(data)) return;
15
+ const meta = data[META_KEY];
16
+ if (isMetaInfo(meta) && !meta.terminal) {
17
+ const schema = resolveSchema(meta.collectionSlug);
18
+ if (schema !== null) walkSchema(schema, data);
19
+ }
20
+ // Continue into non-meta children so we reach nested enriched docs whose
21
+ // walks haven't started yet (e.g. a relationship populated inside a block).
22
+ for(const key in data){
23
+ if (key === META_KEY) continue;
24
+ markTerminalUploads(data[key], resolveSchema);
25
+ }
26
+ };
27
+ const walkSchema = (schema, data)=>{
28
+ if (!isPlainObject(schema)) return;
29
+ for (const key of Object.keys(schema)){
30
+ const fieldSchema = schema[key];
31
+ const value = data[key];
32
+ if (value === undefined || value === null) continue;
33
+ if (typeof fieldSchema === "string") {
34
+ if (UPLOAD_SCHEMA_PATTERN.test(fieldSchema)) markUpload(value);
35
+ continue;
36
+ }
37
+ if (Array.isArray(value)) {
38
+ for (const item of value){
39
+ if (!isPlainObject(item)) continue;
40
+ const sub = pickSubSchemaForArrayItem(fieldSchema, item);
41
+ if (sub) walkSchema(sub, item);
42
+ }
43
+ continue;
44
+ }
45
+ if (isPlainObject(value)) {
46
+ walkSchema(fieldSchema, value);
47
+ }
48
+ }
49
+ };
50
+ // Blocks schemas are `{ <blockSlug>: <subSchema> }`; array rows share a single
51
+ // sub-schema regardless of row index, which `buildFieldSchema` also flattens to
52
+ // a single object under the array key. We disambiguate blocks via `blockType`.
53
+ const pickSubSchemaForArrayItem = (fieldSchema, item)=>{
54
+ if (typeof item.blockType === "string" && item.blockType in fieldSchema) {
55
+ const candidate = fieldSchema[item.blockType];
56
+ return isPlainObject(candidate) ? candidate : null;
57
+ }
58
+ return fieldSchema;
59
+ };
60
+ const markUpload = (value)=>{
61
+ let target = null;
62
+ if (isPlainObject(value)) {
63
+ // Polymorphic upload: unwrap {relationTo, value}
64
+ if (typeof value.relationTo === "string" && isPlainObject(value.value)) {
65
+ target = value.value;
66
+ } else {
67
+ target = value;
68
+ }
69
+ }
70
+ if (!target) return;
71
+ const meta = target[META_KEY];
72
+ if (!isMetaInfo(meta)) return;
73
+ target[META_KEY] = {
74
+ ...meta,
75
+ terminal: true
76
+ };
77
+ };
78
+
79
+ //# sourceMappingURL=markTerminalUploads.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"sources":["../../src/internal/markTerminalUploads.ts"],"sourcesContent":["import type { CollectionSlug } from \"payload\";\n\nimport { isMetaInfo, isPlainObject, META_KEY } from \"./shared.js\";\nimport type { PlainObject } from \"./shared.js\";\n\ntype SchemaNode = string | PlainObject;\ntype ResolveSchema = (slug: CollectionSlug) => SchemaNode | null;\n\nconst UPLOAD_SCHEMA_PATTERN = /^upload:(.+)$/;\n\n/**\n * Walk the doc tree; for every descendant object with its own `_meta`, look up\n * its collection's schema and descend into the data in parallel. Whenever the\n * schema says an `upload:<slug>` field lives at a key and the data has a\n * populated value there, flip that value's `_meta.terminal = true` so the outer\n * stega encoder skips it (preserving its identity for client-side wrapper attrs).\n */\nexport const markTerminalUploads = (data: unknown, resolveSchema: ResolveSchema): void => {\n if (Array.isArray(data)) {\n for (const item of data) markTerminalUploads(item, resolveSchema);\n return;\n }\n if (!isPlainObject(data)) return;\n\n const meta = data[META_KEY];\n if (isMetaInfo(meta) && !meta.terminal) {\n const schema = resolveSchema(meta.collectionSlug);\n if (schema !== null) walkSchema(schema, data);\n }\n\n // Continue into non-meta children so we reach nested enriched docs whose\n // walks haven't started yet (e.g. a relationship populated inside a block).\n for (const key in data) {\n if (key === META_KEY) continue;\n markTerminalUploads(data[key], resolveSchema);\n }\n};\n\nconst walkSchema = (schema: SchemaNode, data: PlainObject): void => {\n if (!isPlainObject(schema)) return;\n\n for (const key of Object.keys(schema)) {\n const fieldSchema = schema[key] as SchemaNode;\n const value = data[key];\n if (value === undefined || value === null) continue;\n\n if (typeof fieldSchema === \"string\") {\n if (UPLOAD_SCHEMA_PATTERN.test(fieldSchema)) markUpload(value);\n continue;\n }\n\n if (Array.isArray(value)) {\n for (const item of value) {\n if (!isPlainObject(item)) continue;\n const sub = pickSubSchemaForArrayItem(fieldSchema, item);\n if (sub) walkSchema(sub, item);\n }\n continue;\n }\n\n if (isPlainObject(value)) {\n walkSchema(fieldSchema, value);\n }\n }\n};\n\n// Blocks schemas are `{ <blockSlug>: <subSchema> }`; array rows share a single\n// sub-schema regardless of row index, which `buildFieldSchema` also flattens to\n// a single object under the array key. We disambiguate blocks via `blockType`.\nconst pickSubSchemaForArrayItem = (\n fieldSchema: PlainObject,\n item: PlainObject\n): PlainObject | null => {\n if (typeof item.blockType === \"string\" && item.blockType in fieldSchema) {\n const candidate = fieldSchema[item.blockType];\n return isPlainObject(candidate) ? candidate : null;\n }\n return fieldSchema;\n};\n\nconst markUpload = (value: unknown): void => {\n let target: PlainObject | null = null;\n\n if (isPlainObject(value)) {\n // Polymorphic upload: unwrap {relationTo, value}\n if (typeof value.relationTo === \"string\" && isPlainObject(value.value)) {\n target = value.value;\n } else {\n target = value;\n }\n }\n\n if (!target) return;\n\n const meta = target[META_KEY];\n if (!isMetaInfo(meta)) return;\n\n target[META_KEY] = { ...meta, terminal: true };\n};\n"],"names":["isMetaInfo","isPlainObject","META_KEY","UPLOAD_SCHEMA_PATTERN","markTerminalUploads","data","resolveSchema","Array","isArray","item","meta","terminal","schema","collectionSlug","walkSchema","key","Object","keys","fieldSchema","value","undefined","test","markUpload","sub","pickSubSchemaForArrayItem","blockType","candidate","target","relationTo"],"mappings":"AAEA,SAASA,UAAU,EAAEC,aAAa,EAAEC,QAAQ,QAAQ,cAAc;AAMlE,MAAMC,wBAAwB;AAE9B;;;;;;CAMC,GACD,OAAO,MAAMC,sBAAsB,CAACC,MAAeC;IACjD,IAAIC,MAAMC,OAAO,CAACH,OAAO;QACvB,KAAK,MAAMI,QAAQJ,KAAMD,oBAAoBK,MAAMH;QACnD;IACF;IACA,IAAI,CAACL,cAAcI,OAAO;IAE1B,MAAMK,OAAOL,IAAI,CAACH,SAAS;IAC3B,IAAIF,WAAWU,SAAS,CAACA,KAAKC,QAAQ,EAAE;QACtC,MAAMC,SAASN,cAAcI,KAAKG,cAAc;QAChD,IAAID,WAAW,MAAME,WAAWF,QAAQP;IAC1C;IAEA,yEAAyE;IACzE,4EAA4E;IAC5E,IAAK,MAAMU,OAAOV,KAAM;QACtB,IAAIU,QAAQb,UAAU;QACtBE,oBAAoBC,IAAI,CAACU,IAAI,EAAET;IACjC;AACF,EAAE;AAEF,MAAMQ,aAAa,CAACF,QAAoBP;IACtC,IAAI,CAACJ,cAAcW,SAAS;IAE5B,KAAK,MAAMG,OAAOC,OAAOC,IAAI,CAACL,QAAS;QACrC,MAAMM,cAAcN,MAAM,CAACG,IAAI;QAC/B,MAAMI,QAAQd,IAAI,CAACU,IAAI;QACvB,IAAII,UAAUC,aAAaD,UAAU,MAAM;QAE3C,IAAI,OAAOD,gBAAgB,UAAU;YACnC,IAAIf,sBAAsBkB,IAAI,CAACH,cAAcI,WAAWH;YACxD;QACF;QAEA,IAAIZ,MAAMC,OAAO,CAACW,QAAQ;YACxB,KAAK,MAAMV,QAAQU,MAAO;gBACxB,IAAI,CAAClB,cAAcQ,OAAO;gBAC1B,MAAMc,MAAMC,0BAA0BN,aAAaT;gBACnD,IAAIc,KAAKT,WAAWS,KAAKd;YAC3B;YACA;QACF;QAEA,IAAIR,cAAckB,QAAQ;YACxBL,WAAWI,aAAaC;QAC1B;IACF;AACF;AAEA,+EAA+E;AAC/E,gFAAgF;AAChF,+EAA+E;AAC/E,MAAMK,4BAA4B,CAChCN,aACAT;IAEA,IAAI,OAAOA,KAAKgB,SAAS,KAAK,YAAYhB,KAAKgB,SAAS,IAAIP,aAAa;QACvE,MAAMQ,YAAYR,WAAW,CAACT,KAAKgB,SAAS,CAAC;QAC7C,OAAOxB,cAAcyB,aAAaA,YAAY;IAChD;IACA,OAAOR;AACT;AAEA,MAAMI,aAAa,CAACH;IAClB,IAAIQ,SAA6B;IAEjC,IAAI1B,cAAckB,QAAQ;QACxB,iDAAiD;QACjD,IAAI,OAAOA,MAAMS,UAAU,KAAK,YAAY3B,cAAckB,MAAMA,KAAK,GAAG;YACtEQ,SAASR,MAAMA,KAAK;QACtB,OAAO;YACLQ,SAASR;QACX;IACF;IAEA,IAAI,CAACQ,QAAQ;IAEb,MAAMjB,OAAOiB,MAAM,CAACzB,SAAS;IAC7B,IAAI,CAACF,WAAWU,OAAO;IAEvBiB,MAAM,CAACzB,SAAS,GAAG;QAAE,GAAGQ,IAAI;QAAEC,UAAU;IAAK;AAC/C"}
@@ -0,0 +1,10 @@
1
+ import type { CollectionSlug, Payload } from "payload";
2
+ type Schema = Record<string, unknown>;
3
+ export type SchemaCache = {
4
+ get(slug: CollectionSlug, payload: Payload): Schema | null;
5
+ };
6
+ export type SchemaCacheOptions = {
7
+ excludeFieldNames?: string[];
8
+ };
9
+ export declare const createSchemaCache: (options?: SchemaCacheOptions) => SchemaCache;
10
+ export {};
@@ -0,0 +1,29 @@
1
+ import { buildFieldSchema } from "./buildFieldSchema.js";
2
+ import { filterEditableFields } from "./filterEditableFields.js";
3
+ const DEFAULT_INTERNAL_FIELD_NAMES = [
4
+ "_status",
5
+ "folder",
6
+ "slug"
7
+ ];
8
+ export const createSchemaCache = (options = {})=>{
9
+ const cache = new Map();
10
+ const internalFieldNames = new Set([
11
+ ...DEFAULT_INTERNAL_FIELD_NAMES,
12
+ ...options.excludeFieldNames ?? []
13
+ ]);
14
+ return {
15
+ get (slug, payload) {
16
+ const cached = cache.get(slug);
17
+ if (cached) return cached;
18
+ const config = payload.collections[slug]?.config ?? payload.config.globals.find((g)=>g.slug === slug);
19
+ if (config) {
20
+ const schema = buildFieldSchema(filterEditableFields(config.fields, internalFieldNames));
21
+ cache.set(slug, schema);
22
+ return schema;
23
+ }
24
+ return null;
25
+ }
26
+ };
27
+ };
28
+
29
+ //# sourceMappingURL=schemaCache.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"sources":["../../src/internal/schemaCache.ts"],"sourcesContent":["import type { CollectionSlug, Payload } from \"payload\";\n\nimport { buildFieldSchema } from \"./buildFieldSchema.js\";\nimport { filterEditableFields } from \"./filterEditableFields.js\";\n\ntype Schema = Record<string, unknown>;\n\nexport type SchemaCache = {\n get(slug: CollectionSlug, payload: Payload): Schema | null;\n};\n\nexport type SchemaCacheOptions = {\n excludeFieldNames?: string[];\n};\n\nconst DEFAULT_INTERNAL_FIELD_NAMES = [\"_status\", \"folder\", \"slug\"];\n\nexport const createSchemaCache = (options: SchemaCacheOptions = {}): SchemaCache => {\n const cache = new Map<string, Schema>();\n const internalFieldNames = new Set<string>([\n ...DEFAULT_INTERNAL_FIELD_NAMES,\n ...(options.excludeFieldNames ?? []),\n ]);\n\n return {\n get(slug, payload) {\n const cached = cache.get(slug);\n if (cached) return cached;\n\n const config =\n payload.collections[slug]?.config ?? payload.config.globals.find((g) => g.slug === slug);\n if (config) {\n const schema = buildFieldSchema(filterEditableFields(config.fields, internalFieldNames));\n cache.set(slug, schema);\n return schema;\n }\n\n return null;\n },\n };\n};\n"],"names":["buildFieldSchema","filterEditableFields","DEFAULT_INTERNAL_FIELD_NAMES","createSchemaCache","options","cache","Map","internalFieldNames","Set","excludeFieldNames","get","slug","payload","cached","config","collections","globals","find","g","schema","fields","set"],"mappings":"AAEA,SAASA,gBAAgB,QAAQ,wBAAwB;AACzD,SAASC,oBAAoB,QAAQ,4BAA4B;AAYjE,MAAMC,+BAA+B;IAAC;IAAW;IAAU;CAAO;AAElE,OAAO,MAAMC,oBAAoB,CAACC,UAA8B,CAAC,CAAC;IAChE,MAAMC,QAAQ,IAAIC;IAClB,MAAMC,qBAAqB,IAAIC,IAAY;WACtCN;WACCE,QAAQK,iBAAiB,IAAI,EAAE;KACpC;IAED,OAAO;QACLC,KAAIC,IAAI,EAAEC,OAAO;YACf,MAAMC,SAASR,MAAMK,GAAG,CAACC;YACzB,IAAIE,QAAQ,OAAOA;YAEnB,MAAMC,SACJF,QAAQG,WAAW,CAACJ,KAAK,EAAEG,UAAUF,QAAQE,MAAM,CAACE,OAAO,CAACC,IAAI,CAAC,CAACC,IAAMA,EAAEP,IAAI,KAAKA;YACrF,IAAIG,QAAQ;gBACV,MAAMK,SAASnB,iBAAiBC,qBAAqBa,OAAOM,MAAM,EAAEb;gBACpEF,MAAMgB,GAAG,CAACV,MAAMQ;gBAChB,OAAOA;YACT;YAEA,OAAO;QACT;IACF;AACF,EAAE"}
@@ -0,0 +1,32 @@
1
+ import type { CollectionSlug } from "payload";
2
+ export type PlainObject = Record<string, unknown>;
3
+ export declare const META_KEY = "_meta";
4
+ export declare const ROOT_ARRAY_TOKEN = "<array>";
5
+ export type DocKind = "collection" | "global";
6
+ export type VeIdentity = {
7
+ path: string;
8
+ collectionSlug: CollectionSlug;
9
+ kind: DocKind;
10
+ docId?: string;
11
+ };
12
+ export type MetaInfo = VeIdentity & {
13
+ terminal?: true;
14
+ };
15
+ export declare const isPlainObject: (value: unknown) => value is PlainObject;
16
+ export declare const isMetaInfo: (value: unknown) => value is MetaInfo;
17
+ export declare const spreadVeIdentity: (id: VeIdentity) => {
18
+ docId?: string | undefined;
19
+ path: string;
20
+ collectionSlug: string;
21
+ kind: DocKind;
22
+ };
23
+ export declare const toMetaInfo: (id: VeIdentity, options?: {
24
+ terminal?: true;
25
+ }) => MetaInfo;
26
+ export declare const toStegaPayload: (id: VeIdentity) => {
27
+ docId?: string | undefined;
28
+ path: string;
29
+ collectionSlug: string;
30
+ kind: DocKind;
31
+ };
32
+ export declare const fromStegaPayload: (decoded: unknown) => VeIdentity | null;
@@ -0,0 +1,55 @@
1
+ export const META_KEY = "_meta";
2
+ // Sentinel inserted into path segments when the enriched document root is an
3
+ // array, so `enrichWithPathMeta` and `encodeStega` agree on the shape.
4
+ export const ROOT_ARRAY_TOKEN = "<array>";
5
+ export const isPlainObject = (value)=>value !== null && typeof value === "object" && !Array.isArray(value);
6
+ export const isMetaInfo = (value)=>{
7
+ if (!isPlainObject(value)) return false;
8
+ return typeof value.path === "string" && typeof value.collectionSlug === "string";
9
+ };
10
+ // Omit `docId` when absent; globals never have one, and a literal `undefined`
11
+ // is not valid in stega payloads or DOM data attributes.
12
+ export const spreadVeIdentity = (id)=>({
13
+ path: id.path,
14
+ collectionSlug: id.collectionSlug,
15
+ kind: id.kind,
16
+ ...id.docId !== undefined && {
17
+ docId: id.docId
18
+ }
19
+ });
20
+ export const toMetaInfo = (id, options)=>{
21
+ const meta = {
22
+ path: id.path,
23
+ collectionSlug: id.collectionSlug,
24
+ kind: id.kind
25
+ };
26
+ if (id.docId !== undefined) {
27
+ meta.docId = id.docId;
28
+ }
29
+ if (options?.terminal) {
30
+ meta.terminal = true;
31
+ }
32
+ return meta;
33
+ };
34
+ export const toStegaPayload = (id)=>spreadVeIdentity(id);
35
+ export const fromStegaPayload = (decoded)=>{
36
+ if (!isPlainObject(decoded)) return null;
37
+ const { path, collectionSlug, kind, docId } = decoded;
38
+ if (typeof path !== "string" || typeof collectionSlug !== "string") {
39
+ return null;
40
+ }
41
+ if (kind !== "collection" && kind !== "global") {
42
+ return null;
43
+ }
44
+ const id = {
45
+ path,
46
+ collectionSlug: collectionSlug,
47
+ kind
48
+ };
49
+ if (typeof docId === "string") {
50
+ id.docId = docId;
51
+ }
52
+ return id;
53
+ };
54
+
55
+ //# sourceMappingURL=shared.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"sources":["../../src/internal/shared.ts"],"sourcesContent":["import type { CollectionSlug } from \"payload\";\n\nexport type PlainObject = Record<string, unknown>;\n\nexport const META_KEY = \"_meta\";\n\n// Sentinel inserted into path segments when the enriched document root is an\n// array, so `enrichWithPathMeta` and `encodeStega` agree on the shape.\nexport const ROOT_ARRAY_TOKEN = \"<array>\";\n\nexport type DocKind = \"collection\" | \"global\";\n\n// Minimal tuple that identifies an editable field anywhere in the pipeline.\n// Every transport bag (MetaInfo, stega payload, data-ve-* attrs, postMessage)\n// projects from this shape — `spreadVeIdentity` centralises the `docId` omission.\nexport type VeIdentity = {\n path: string;\n collectionSlug: CollectionSlug;\n kind: DocKind;\n docId?: string;\n};\n\n// Per-holder provenance. `docId` is absent for globals (their slug is the key).\n// `terminal` marks holders whose path already resolved to a leaf renderer (e.g.\n// rich text) — the encoder writes the path to `_meta` instead of re-encoding.\nexport type MetaInfo = VeIdentity & { terminal?: true };\n\nexport const isPlainObject = (value: unknown): value is PlainObject =>\n value !== null && typeof value === \"object\" && !Array.isArray(value);\n\nexport const isMetaInfo = (value: unknown): value is MetaInfo => {\n if (!isPlainObject(value)) return false;\n return typeof value.path === \"string\" && typeof value.collectionSlug === \"string\";\n};\n\n// Omit `docId` when absent; globals never have one, and a literal `undefined`\n// is not valid in stega payloads or DOM data attributes.\nexport const spreadVeIdentity = (id: VeIdentity) => ({\n path: id.path,\n collectionSlug: id.collectionSlug,\n kind: id.kind,\n ...(id.docId !== undefined && { docId: id.docId }),\n});\n\nexport const toMetaInfo = (id: VeIdentity, options?: { terminal?: true }): MetaInfo => {\n const meta: MetaInfo = {\n path: id.path,\n collectionSlug: id.collectionSlug,\n kind: id.kind,\n };\n if (id.docId !== undefined) {\n meta.docId = id.docId;\n }\n if (options?.terminal) {\n meta.terminal = true;\n }\n return meta;\n};\n\nexport const toStegaPayload = (id: VeIdentity) => spreadVeIdentity(id);\n\nexport const fromStegaPayload = (decoded: unknown) => {\n if (!isPlainObject(decoded)) return null;\n\n const { path, collectionSlug, kind, docId } = decoded;\n\n if (typeof path !== \"string\" || typeof collectionSlug !== \"string\") {\n return null;\n }\n if (kind !== \"collection\" && kind !== \"global\") {\n return null;\n }\n\n const id: VeIdentity = { path, collectionSlug: collectionSlug as CollectionSlug, kind };\n if (typeof docId === \"string\") {\n id.docId = docId;\n }\n return id;\n};\n"],"names":["META_KEY","ROOT_ARRAY_TOKEN","isPlainObject","value","Array","isArray","isMetaInfo","path","collectionSlug","spreadVeIdentity","id","kind","docId","undefined","toMetaInfo","options","meta","terminal","toStegaPayload","fromStegaPayload","decoded"],"mappings":"AAIA,OAAO,MAAMA,WAAW,QAAQ;AAEhC,6EAA6E;AAC7E,uEAAuE;AACvE,OAAO,MAAMC,mBAAmB,UAAU;AAmB1C,OAAO,MAAMC,gBAAgB,CAACC,QAC5BA,UAAU,QAAQ,OAAOA,UAAU,YAAY,CAACC,MAAMC,OAAO,CAACF,OAAO;AAEvE,OAAO,MAAMG,aAAa,CAACH;IACzB,IAAI,CAACD,cAAcC,QAAQ,OAAO;IAClC,OAAO,OAAOA,MAAMI,IAAI,KAAK,YAAY,OAAOJ,MAAMK,cAAc,KAAK;AAC3E,EAAE;AAEF,8EAA8E;AAC9E,yDAAyD;AACzD,OAAO,MAAMC,mBAAmB,CAACC,KAAoB,CAAA;QACnDH,MAAMG,GAAGH,IAAI;QACbC,gBAAgBE,GAAGF,cAAc;QACjCG,MAAMD,GAAGC,IAAI;QACb,GAAID,GAAGE,KAAK,KAAKC,aAAa;YAAED,OAAOF,GAAGE,KAAK;QAAC,CAAC;IACnD,CAAA,EAAG;AAEH,OAAO,MAAME,aAAa,CAACJ,IAAgBK;IACzC,MAAMC,OAAiB;QACrBT,MAAMG,GAAGH,IAAI;QACbC,gBAAgBE,GAAGF,cAAc;QACjCG,MAAMD,GAAGC,IAAI;IACf;IACA,IAAID,GAAGE,KAAK,KAAKC,WAAW;QAC1BG,KAAKJ,KAAK,GAAGF,GAAGE,KAAK;IACvB;IACA,IAAIG,SAASE,UAAU;QACrBD,KAAKC,QAAQ,GAAG;IAClB;IACA,OAAOD;AACT,EAAE;AAEF,OAAO,MAAME,iBAAiB,CAACR,KAAmBD,iBAAiBC,IAAI;AAEvE,OAAO,MAAMS,mBAAmB,CAACC;IAC/B,IAAI,CAAClB,cAAckB,UAAU,OAAO;IAEpC,MAAM,EAAEb,IAAI,EAAEC,cAAc,EAAEG,IAAI,EAAEC,KAAK,EAAE,GAAGQ;IAE9C,IAAI,OAAOb,SAAS,YAAY,OAAOC,mBAAmB,UAAU;QAClE,OAAO;IACT;IACA,IAAIG,SAAS,gBAAgBA,SAAS,UAAU;QAC9C,OAAO;IACT;IAEA,MAAMD,KAAiB;QAAEH;QAAMC,gBAAgBA;QAAkCG;IAAK;IACtF,IAAI,OAAOC,UAAU,UAAU;QAC7BF,GAAGE,KAAK,GAAGA;IACb;IACA,OAAOF;AACT,EAAE"}
@@ -0,0 +1,2 @@
1
+ import type { CollectionBeforeChangeHook, GlobalBeforeChangeHook } from "payload";
2
+ export declare const createStripStegaHook: () => CollectionBeforeChangeHook & GlobalBeforeChangeHook;
@@ -0,0 +1,29 @@
1
+ import { vercelStegaSplit } from "@vercel/stega";
2
+ import { META_KEY, isPlainObject } from "./shared.js";
3
+ // Defense in depth: strip stega from every write so zero-width chars can never
4
+ // reach the database, even if the gate ever mis-classifies a read. Idempotent.
5
+ export const createStripStegaHook = ()=>{
6
+ return ({ data })=>{
7
+ stripStega(data);
8
+ return data;
9
+ };
10
+ };
11
+ const stripStega = (value)=>{
12
+ if (Array.isArray(value)) {
13
+ for(let i = 0; i < value.length; i++){
14
+ const item = value[i];
15
+ if (typeof item === "string") value[i] = vercelStegaSplit(item).cleaned;
16
+ else stripStega(item);
17
+ }
18
+ return;
19
+ }
20
+ if (!isPlainObject(value)) return;
21
+ for(const key in value){
22
+ if (key === META_KEY) continue;
23
+ const current = value[key];
24
+ if (typeof current === "string") value[key] = vercelStegaSplit(current).cleaned;
25
+ else stripStega(current);
26
+ }
27
+ };
28
+
29
+ //# sourceMappingURL=stripStegaHook.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"sources":["../../src/internal/stripStegaHook.ts"],"sourcesContent":["import type { CollectionBeforeChangeHook, GlobalBeforeChangeHook } from \"payload\";\n\nimport { vercelStegaSplit } from \"@vercel/stega\";\n\nimport { META_KEY, isPlainObject } from \"./shared.js\";\n\n// Defense in depth: strip stega from every write so zero-width chars can never\n// reach the database, even if the gate ever mis-classifies a read. Idempotent.\nexport const createStripStegaHook = (): CollectionBeforeChangeHook & GlobalBeforeChangeHook => {\n return ({ data }: { data: unknown }) => {\n stripStega(data);\n return data;\n };\n};\n\nconst stripStega = (value: unknown): void => {\n if (Array.isArray(value)) {\n for (let i = 0; i < value.length; i++) {\n const item = value[i];\n if (typeof item === \"string\") value[i] = vercelStegaSplit(item).cleaned;\n else stripStega(item);\n }\n return;\n }\n\n if (!isPlainObject(value)) return;\n\n for (const key in value) {\n if (key === META_KEY) continue;\n const current = value[key];\n if (typeof current === \"string\") value[key] = vercelStegaSplit(current).cleaned;\n else stripStega(current);\n }\n};\n"],"names":["vercelStegaSplit","META_KEY","isPlainObject","createStripStegaHook","data","stripStega","value","Array","isArray","i","length","item","cleaned","key","current"],"mappings":"AAEA,SAASA,gBAAgB,QAAQ,gBAAgB;AAEjD,SAASC,QAAQ,EAAEC,aAAa,QAAQ,cAAc;AAEtD,+EAA+E;AAC/E,+EAA+E;AAC/E,OAAO,MAAMC,uBAAuB;IAClC,OAAO,CAAC,EAAEC,IAAI,EAAqB;QACjCC,WAAWD;QACX,OAAOA;IACT;AACF,EAAE;AAEF,MAAMC,aAAa,CAACC;IAClB,IAAIC,MAAMC,OAAO,CAACF,QAAQ;QACxB,IAAK,IAAIG,IAAI,GAAGA,IAAIH,MAAMI,MAAM,EAAED,IAAK;YACrC,MAAME,OAAOL,KAAK,CAACG,EAAE;YACrB,IAAI,OAAOE,SAAS,UAAUL,KAAK,CAACG,EAAE,GAAGT,iBAAiBW,MAAMC,OAAO;iBAClEP,WAAWM;QAClB;QACA;IACF;IAEA,IAAI,CAACT,cAAcI,QAAQ;IAE3B,IAAK,MAAMO,OAAOP,MAAO;QACvB,IAAIO,QAAQZ,UAAU;QACtB,MAAMa,UAAUR,KAAK,CAACO,IAAI;QAC1B,IAAI,OAAOC,YAAY,UAAUR,KAAK,CAACO,IAAI,GAAGb,iBAAiBc,SAASF,OAAO;aAC1EP,WAAWS;IAClB;AACF"}
package/package.json ADDED
@@ -0,0 +1,105 @@
1
+ {
2
+ "name": "@focus-reactive/payload-plugin-visual-editing",
3
+ "version": "1.0.0",
4
+ "description": "Visual editing for Payload CMS — click-to-edit overlays on your frontend via Vercel stega and a postMessage bridge back to the admin.",
5
+ "license": "MIT",
6
+ "author": "FocusReactive <ship@focusreactive.com>",
7
+ "keywords": [
8
+ "payload",
9
+ "payload-cms",
10
+ "payload-plugin",
11
+ "visual-editing",
12
+ "click-to-edit",
13
+ "live-preview",
14
+ "stega",
15
+ "nextjs"
16
+ ],
17
+ "private": false,
18
+ "publishConfig": {
19
+ "access": "public"
20
+ },
21
+ "repository": {
22
+ "type": "git",
23
+ "url": "https://github.com/focusreactive/payload-plugins",
24
+ "directory": "packages/payload-plugin-visual-editing"
25
+ },
26
+ "bugs": {
27
+ "url": "https://github.com/focusreactive/payload-plugins/issues"
28
+ },
29
+ "homepage": "https://github.com/focusreactive/payload-plugins/tree/main/packages/payload-plugin-visual-editing",
30
+ "type": "module",
31
+ "main": "./dist/index.js",
32
+ "types": "./dist/index.d.ts",
33
+ "files": [
34
+ "dist"
35
+ ],
36
+ "exports": {
37
+ ".": {
38
+ "import": "./dist/index.js",
39
+ "types": "./dist/index.d.ts"
40
+ },
41
+ "./admin": {
42
+ "import": "./dist/admin/index.js",
43
+ "types": "./dist/admin/index.d.ts"
44
+ },
45
+ "./client": {
46
+ "import": "./dist/client/index.js",
47
+ "types": "./dist/client/index.d.ts"
48
+ }
49
+ },
50
+ "typesVersions": {
51
+ "*": {
52
+ "admin": [
53
+ "./dist/admin/index.d.ts"
54
+ ],
55
+ "client": [
56
+ "./dist/client/index.d.ts"
57
+ ]
58
+ }
59
+ },
60
+ "scripts": {
61
+ "build": "bun run build:swc && bun run build:types",
62
+ "build:swc": "swc ./src -d ./dist --config-file .swcrc --strip-leading-paths",
63
+ "build:types": "tsc --emitDeclarationOnly --outDir dist",
64
+ "clean": "rm -rf dist",
65
+ "dev": "bun run build:swc -- --watch",
66
+ "lint": "ultracite check",
67
+ "lint:fix": "ultracite fix",
68
+ "format": "ultracite fix",
69
+ "format:check": "ultracite check",
70
+ "test": "vitest run",
71
+ "test:watch": "vitest",
72
+ "check-types": "tsgo --noEmit"
73
+ },
74
+ "peerDependencies": {
75
+ "@payloadcms/ui": "^3.79.0",
76
+ "next": "^14.0.0 || ^15.0.0 || ^16.0.0",
77
+ "payload": "^3.79.0",
78
+ "react": "^18.0.0 || ^19.0.0"
79
+ },
80
+ "peerDependenciesMeta": {
81
+ "next": {
82
+ "optional": true
83
+ }
84
+ },
85
+ "dependencies": {
86
+ "@vercel/stega": "^1.1.0"
87
+ },
88
+ "devDependencies": {
89
+ "@payloadcms/ui": "3.90.1",
90
+ "@swc/cli": "0.4.0",
91
+ "@swc/core": "1.7.0",
92
+ "@testing-library/react": "^16.0.0",
93
+ "@types/node": "22.19.9",
94
+ "@types/react": "19.2.9",
95
+ "@types/react-dom": "19.2.3",
96
+ "@vitejs/plugin-react": "^4.3.0",
97
+ "jsdom": "^25.0.0",
98
+ "next": "16.3.6",
99
+ "payload": "3.90.1",
100
+ "react": "19.2.1",
101
+ "react-dom": "19.2.1",
102
+ "typescript": "5.9.2",
103
+ "vitest": "^2.1.0"
104
+ }
105
+ }