@nitrogenbuilder/connector-payload 0.1.0

package/dist/index.d.ts

@@ -0,0 +1,21 @@
+import type { Plugin } from "payload";
+export interface NitrogenConnectorPluginOptions {
+    /** Disable the plugin without removing it from config */
+    disabled?: boolean;
+    /**
+     * Existing Payload collections to enable Nitrogen editing on.
+     * The plugin will inject the required fields (nitrogenData, pageSettings, etc.)
+     * and generate API endpoints for each collection.
+     *
+     * Example: `collections: ['pages', 'blog-posts']`
+     */
+    collections?: string[];
+}
+export declare const nitrogenConnectorPlugin: (options?: NitrogenConnectorPluginOptions) => Plugin;
+export { NitrogenTemplates } from "./collections/NitrogenTemplates";
+export { NitrogenSettings } from "./globals/NitrogenSettings";
+export { NitrogenEditButton } from "./components/NitrogenEditButton";
+export { buildDynamicData, getNitrogenSettings } from "./endpoints/helpers";
+export { createCollectionEndpoints } from "./endpoints/collection-endpoints";
+export { nitrogen } from "@nitrogenbuilder/client-core";
+export type { ComponentSettings, ComponentSettingsToProps, } from "@nitrogenbuilder/types";

package/dist/index.js

@@ -0,0 +1,140 @@
+import { NitrogenTemplates } from "./collections/NitrogenTemplates";
+import { NitrogenSettings } from "./globals/NitrogenSettings";
+import { templatesEndpoints } from "./endpoints/templates";
+import { mediaEndpoints } from "./endpoints/media";
+import { nitrogenSettingsEndpoints } from "./endpoints/nitrogen-settings";
+import { allEndpoints } from "./endpoints/all";
+import { menuEndpoints } from "./endpoints/menu";
+import { createCollectionEndpoints } from "./endpoints/collection-endpoints";
+import { registerCollection } from "./collection-registry";
+/** Fields required by Nitrogen that will be injected into collections if missing */
+const nitrogenRequiredFields = [
+    {
+        name: "nitrogenData",
+        type: "json",
+        admin: { description: "Nitrogen page builder JSON module tree" },
+    },
+    {
+        name: "pageSettings",
+        type: "json",
+        admin: { description: "Page-level Nitrogen settings" },
+    },
+    { name: "title", type: "text", required: true },
+    { name: "slug", type: "text", required: true, unique: true, index: true },
+    {
+        name: "status",
+        type: "select",
+        options: [
+            { label: "Draft", value: "draft" },
+            { label: "Published", value: "published" },
+        ],
+        defaultValue: "draft",
+    },
+    { name: "author", type: "relationship", relationTo: "users" },
+];
+export const nitrogenConnectorPlugin = (options = {}) => (incomingConfig) => {
+    if (options.disabled) {
+        return incomingConfig;
+    }
+    const config = { ...incomingConfig };
+    // Add Nitrogen templates collection
+    config.collections = [...(config.collections || []), NitrogenTemplates];
+    // Add Nitrogen global settings
+    config.globals = [...(config.globals || []), NitrogenSettings];
+    // Add Nitrogen API endpoints
+    config.endpoints = [
+        ...(config.endpoints || []),
+        ...templatesEndpoints,
+        ...mediaEndpoints,
+        ...nitrogenSettingsEndpoints,
+        ...allEndpoints,
+        ...menuEndpoints,
+    ];
+    // Register templates collection
+    registerCollection("nitrogen-templates", "nitrogen-templates");
+    registerCollection("nitrogen_template", "nitrogen-templates");
+    // Process collections
+    const additionalCollections = options.collections || [];
+    for (const slug of additionalCollections) {
+        // Find the existing collection in the config
+        const existingIndex = (config.collections || []).findIndex((col) => col.slug === slug);
+        if (existingIndex === -1) {
+            console.warn(`[nitrogen-connector-payload] Collection "${slug}" not found in config. ` +
+                `Make sure it is defined before the nitrogen plugin runs.`);
+            continue;
+        }
+        // Inject missing fields — recurse into rows, tabs, groups, collapsibles
+        const existing = config.collections[existingIndex];
+        const existingFieldNames = new Set();
+        function collectFieldNames(fields) {
+            for (const f of fields) {
+                if ("name" in f && f.name) {
+                    existingFieldNames.add(f.name);
+                }
+                // Recurse into container field types
+                if ("fields" in f && Array.isArray(f.fields)) {
+                    collectFieldNames(f.fields);
+                }
+                if ("tabs" in f && Array.isArray(f.tabs)) {
+                    for (const tab of f.tabs) {
+                        if ("fields" in tab && Array.isArray(tab.fields)) {
+                            collectFieldNames(tab.fields);
+                        }
+                    }
+                }
+            }
+        }
+        collectFieldNames(existing.fields);
+        const fieldsToAdd = nitrogenRequiredFields.filter((f) => "name" in f && !existingFieldNames.has(f.name));
+        if (fieldsToAdd.length > 0) {
+            config.collections[existingIndex] = {
+                ...existing,
+                fields: [...existing.fields, ...fieldsToAdd],
+            };
+        }
+        // Inject NitrogenEditButton admin component
+        const col = config.collections[existingIndex];
+        const adminConfig = col.admin || {};
+        const components = adminConfig.components || {};
+        const edit = components.edit || {};
+        const beforeControls = "beforeDocumentControls" in edit
+            ? edit.beforeDocumentControls || []
+            : [];
+        config.collections[existingIndex] = {
+            ...col,
+            admin: {
+                ...adminConfig,
+                components: {
+                    ...components,
+                    edit: {
+                        ...edit,
+                        beforeDocumentControls: [
+                            ...beforeControls,
+                            {
+                                path: "nitrogen-connector-payload/components/NitrogenEditButton#NitrogenEditButton",
+                                clientProps: { collection: slug },
+                            },
+                        ],
+                    },
+                },
+            },
+        };
+        // Generate and register endpoints for this collection
+        const collectionEndpoints = createCollectionEndpoints(slug, slug);
+        config.endpoints = [...(config.endpoints || []), ...collectionEndpoints];
+        // Register in the collection registry for the `all` endpoint
+        registerCollection(slug, slug);
+    }
+    return config;
+};
+// Re-export for consumers who need direct access
+export { NitrogenTemplates } from "./collections/NitrogenTemplates";
+export { NitrogenSettings } from "./globals/NitrogenSettings";
+// Editor exports
+export { NitrogenEditButton } from "./components/NitrogenEditButton";
+// Helper exports for consumers building custom frontend routes
+export { buildDynamicData, getNitrogenSettings } from "./endpoints/helpers";
+// Collection endpoint factory for consumers who need custom endpoint generation
+export { createCollectionEndpoints } from "./endpoints/collection-endpoints";
+// Re-export @nitrogenbuilder packages for convenience
+export { nitrogen } from "@nitrogenbuilder/client-core";

package/dist/types.d.ts

@@ -0,0 +1,125 @@
+/**
+ * Nitrogen Connector — Shared Types
+ *
+ * Document interfaces matching the Payload collection/global schemas,
+ * plus request body shapes used by the API endpoints.
+ */
+import type { BuilderModule } from '@nitrogenbuilder/types';
+export type JsonObject = Record<string, unknown>;
+export type NitrogenModule = BuilderModule;
+interface NitrogenDocBase {
+    id: string | number;
+    title: string;
+    slug: string;
+    status?: 'draft' | 'published';
+    author?: string | number | {
+        id: string | number;
+        name?: string;
+        email?: string;
+    };
+    nitrogenData?: JsonObject | JsonObject[];
+    createdAt: string;
+    updatedAt: string;
+}
+export interface NitrogenPageDoc extends NitrogenDocBase {
+    pageSettings?: JsonObject;
+}
+export interface NitrogenTemplateDoc extends NitrogenDocBase {
+    templateType?: string;
+    associatedCollection?: string;
+    templateSettings?: JsonObject;
+}
+export interface NitrogenSettingsGlobal {
+    licenseKey?: string;
+    connectorToken?: string;
+    instanceUrl?: string;
+    frontendUrl?: string;
+    developmentUrl?: string;
+    nitrogenConfig?: NitrogenConfig;
+}
+export interface NitrogenConfig {
+    variables?: Array<{
+        name: string;
+        value?: string;
+    }>;
+    [key: string]: unknown;
+}
+export interface MediaDoc {
+    id: string | number;
+    filename?: string;
+    mimeType?: string;
+    alt?: string;
+    url?: string;
+    width?: number;
+    height?: number;
+    filesize?: number;
+    sizes?: {
+        thumbnail?: MediaSize;
+        medium?: MediaSize;
+        large?: MediaSize;
+        [key: string]: MediaSize | undefined;
+    };
+    createdAt: string;
+}
+export interface MediaSize {
+    url?: string;
+    width?: number;
+    height?: number;
+}
+export interface PageCreateRequestBody {
+    data?: {
+        title?: string;
+        slug?: string;
+        author?: string | number;
+    };
+    title?: string;
+    slug?: string;
+    author?: string | number;
+}
+export interface PageUpdateRequestBody {
+    data?: PageUpdateData;
+    title?: string;
+    author?: string | number;
+    data_content?: string | JsonObject[];
+    settings?: JsonObject;
+}
+interface PageUpdateData {
+    title?: string;
+    author?: string | number;
+    data?: string | JsonObject[];
+    settings?: JsonObject;
+}
+export interface TemplateUpdateRequestBody {
+    data?: TemplateUpdateData;
+    title?: string;
+    author?: string | number;
+    data_content?: string | JsonObject[];
+    templateType?: string;
+    settings?: JsonObject;
+}
+interface TemplateUpdateData {
+    title?: string;
+    author?: string | number;
+    data?: string | JsonObject[];
+    templateType?: string;
+    settings?: JsonObject;
+}
+export interface SlugLookupRequestBody {
+    slug?: string;
+    data?: {
+        slug?: string;
+    };
+}
+export interface MediaUpdateRequestBody {
+    id: string | number;
+    alt?: string;
+}
+export interface RenderDataRequestBody {
+    pageData?: NitrogenModule[];
+    requestedData?: JsonObject & {
+        id?: string | number;
+    };
+    /** Which Payload collection to fetch dynamic data from */
+    collection?: string;
+}
+export {};

package/dist/types.js

@@ -0,0 +1,7 @@
+/**
+ * Nitrogen Connector — Shared Types
+ *
+ * Document interfaces matching the Payload collection/global schemas,
+ * plus request body shapes used by the API endpoints.
+ */
+export {};

package/package.json

@@ -0,0 +1,49 @@
+{
+  "name": "@nitrogenbuilder/connector-payload",
+  "version": "0.1.0",
+  "description": "Nitrogen page builder connector plugin for Payload CMS 3.x",
+  "author": "Leonardo Dentzien <leo@torchmedia.ca>",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    },
+    "./editor": {
+      "types": "./dist/editor/index.d.ts",
+      "default": "./dist/editor/index.js"
+    },
+    "./frontend": {
+      "types": "./dist/frontend/index.d.ts",
+      "default": "./dist/frontend/index.js"
+    },
+    "./components/*": "./dist/components/*"
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "typecheck": "tsc --noEmit",
+    "prepublishOnly": "pnpm build"
+  },
+  "peerDependencies": {
+    "payload": "^3.0.0",
+    "next": "^15.0.0",
+    "react": "^19.0.0",
+    "@payloadcms/ui": "^3.0.0",
+    "@nitrogenbuilder/client-react": ">=0.3.0",
+    "@nitrogenbuilder/client-core": ">=0.3.0",
+    "@nitrogenbuilder/types": ">=0.3.0"
+  },
+  "devDependencies": {
+    "@types/react": "^19.0.0",
+    "@types/node": "^22.0.0",
+    "typescript": "^5.7.0",
+    "@nitrogenbuilder/client-react": "link:../monogen/packages/client-react",
+    "@nitrogenbuilder/client-core": "link:../monogen/packages/client-core",
+    "@nitrogenbuilder/types": "link:../monogen/packages/types"
+  }
+}