Page Builder for Strapi

https://github.com/wecre8websites/strapi-page-builder
Admin
Page Builder is a Strapi plugin that provides a visual, drag-and-drop page editor for building and...
Tokens:9,452
Snippets:37
Trust Score:4.5
License:MIT
Update:1 year ago
Show doc for...
Tokens:
Raw
### Install Strapi Page Builder Plugin using npm

Source: https://github.com/wecre8websites/strapi-page-builder/blob/master/README.md

Instructions to install the Strapi Page Builder plugin using npm within your Strapi project. This includes installing the package, building the project, and starting the development server.

```bash
npm install @wecre8websites/strapi-page-builder
npm run build
npm run develop
```

--------------------------------

### Template JSON Structure Example (TypeScript)

Source: https://context7.com/wecre8websites/strapi-page-builder/llms.txt

Provides an example of the JSON structure used to define templates, including 'content', 'root', and 'zones' sections. It also shows how to save a template using this structure.

```typescript
// Example template structure
const templateJson = {
  content: [
    {
      id: "hero-1",
      type: "hero",
      props: {
        title: "{{content.title}}",           // Dynamic data binding
        subtitle: "{{content.subtitle}}",
        backgroundImage: "{{content.image}}",
        ctaText: "Learn More",
        ctaLink: "/about"
      }
    },
    {
      id: "feature-grid-1",
      type: "featureGrid",
      props: {
        features: "{{content.features}}",     // Array binding
        columns: 3
      }
    }
  ],
  root: {
    type: "container",
    children: ["hero-1", "feature-grid-1"]
  },
  zones: {
    sidebar: {
      type: "zone",
      children: []
    }
  }
};

// Save template with this structure
await strapi.plugin('page-builder').service('editor').saveTemplate({
  templateId: 'existing-id',
  templateJson,
  contentType: 'api::page.page',
  locale: 'en'
});
```

--------------------------------

### Untitled

No description

--------------------------------

### Get All Templates (Content API)

Source: https://context7.com/wecre8websites/strapi-page-builder/llms.txt

A public API endpoint accessible without authentication to retrieve all available templates. Uses a GET request to `/api/page-builder/templates`. The response includes an array of template objects.

```bash
# GET /api/page-builder/templates
curl https://your-strapi.com/api/page-builder/templates

# Response
{
  "data": [
    {
      "id": 1,
      "documentId": "xyz789",
      "name": "api.article.homepage-hero",
      "shortName": "Homepage Hero",
      "contentType": "api::article.article",
      "json": { "content": [], "root": {}, "zones": {} },
      "locale": "en"
    }
  ]
}
```

--------------------------------

### GET /page-builder/settings

Source: https://context7.com/wecre8websites/strapi-page-builder/llms.txt

Retrieves current plugin configuration including API key, license status, and default content selection.

```APIDOC
## GET /page-builder/settings

### Description
Retrieves current plugin configuration including API key, license status, and default content selection.

### Method
GET

### Endpoint
/page-builder/settings

### Response
#### Success Response (200)
- **apiKey** (string) - The configured API key.
- **url** (string) - The configured editor URL.
- **defaultContentType** (string) - The configured default content type.
- **defaultContentId** (string) - The configured default content ID.
- **enforceTemplateShape** (boolean) - The configured template shape enforcement setting.
- **error** (string|null) - An error message if there is a configuration issue.

#### Response Example
```json
{
  "apiKey": "pb_1234567890abcdef",
  "url": "https://editor.example.com",
  "defaultContentType": "api::page.page",
  "defaultContentId": "home123",
  "enforceTemplateShape": true,
  "error": null
}
```
```

--------------------------------

### GET /api/page-builder/templates - Get All Templates (Content API)

Source: https://context7.com/wecre8websites/strapi-page-builder/llms.txt

Public API endpoint to retrieve all templates, accessible without authentication.

```APIDOC
## GET /api/page-builder/templates

### Description
Public API endpoint to retrieve all templates, accessible without authentication.

### Method
GET

### Endpoint
`/api/page-builder/templates`

### Parameters
None

### Request Example
```bash
curl https://your-strapi.com/api/page-builder/templates
```

### Response
#### Success Response (200)
- **data** (array) - An array of template objects.
  - **id** (integer) - The internal ID of the template.
  - **documentId** (string) - The unique identifier for the template.
  - **name** (string) - The name of the template.
  - **shortName** (string) - A short, human-readable name for the template.
  - **contentType** (string) - The content type associated with the template.
  - **json** (object) - The JSON structure of the template.
  - **locale** (string) - The locale of the template.

#### Response Example
```json
{
  "data": [
    {
      "id": 1,
      "documentId": "xyz789",
      "name": "api.article.homepage-hero",
      "shortName": "Homepage Hero",
      "contentType": "api::article.article",
      "json": { "content": [], "root": {}, "zones": {} },
      "locale": "en"
    }
  ]
}
```
```

--------------------------------

### Retrieve Strapi Page Builder Settings (TypeScript)

Source: https://context7.com/wecre8websites/strapi-page-builder/llms.txt

Fetches the current configuration settings for the Page Builder plugin, including the API key, license status, and default content selections. This GET request to `/page-builder/settings` allows you to inspect the plugin's active configuration.

```typescript
// GET /page-builder/settings

// Response
{
  "apiKey": "pb_1234567890abcdef",
  "url": "https://editor.example.com",
  "defaultContentType": "api::page.page",
  "defaultContentId": "home123",
  "enforceTemplateShape": true,
  "error": null
}
```

--------------------------------

### Define Plugin Permissions (TypeScript)

Source: https://context7.com/wecre8websites/strapi-page-builder/llms.txt

Lists the permission actions registered by the Page Builder plugin for role-based access control. It also shows an example of how to check if a user has a specific permission.

```typescript
// Permissions registered by the plugin
const permissions = [
  {
    action: 'plugin::page-builder.editor.read',
    displayName: 'Access Page Builder'
  },
  {
    action: 'plugin::page-builder.editor.edit',
    displayName: 'Edit template content'
  },
  {
    action: 'plugin::page-builder.editor.modify',
    displayName: 'Add & remove template components'
  },
  {
    action: 'plugin::page-builder.settings.modify',
    displayName: 'Access the Page Builder settings'
  }
];

// Check permissions in custom code
const hasAccess = await strapi.admin.services.permission.actionProvider.hasPermission(
  userContext,
  'plugin::page-builder.editor.read'
);
```

--------------------------------

### Untitled

No description

--------------------------------

### Get Available Content Types for Strapi Page Builder (TypeScript)

Source: https://context7.com/wecre8websites/strapi-page-builder/llms.txt

Retrieves a list of all Strapi content types that are configured with a template relation and can be used with the Page Builder plugin. This GET request to `/page-builder/settings/contentTypes` is useful for understanding which content can be managed via the visual editor.

```typescript
// GET /page-builder/settings/contentTypes

// Response
[
  {
    "uid": "api::article.article",
    "globalId": "Article",
    "source": "api",
    "kind": "collectionType"
  },
  {
    "uid": "api::page.page",
    "globalId": "Page",
    "source": "api",
    "kind": "singleType"
  }
]
```

--------------------------------

### GET /api/page-builder/templates/:id - Get Template by ID (Content API)

Source: https://context7.com/wecre8websites/strapi-page-builder/llms.txt

Public API endpoint to retrieve a specific template by its ID.

```APIDOC
## GET /api/page-builder/templates/:id

### Description
Public API endpoint to retrieve a specific template by its ID.

### Method
GET

### Endpoint
`/api/page-builder/templates/:id`

### Parameters
#### Path Parameters
- **id** (string) - Required - The `documentId` of the template to retrieve.

### Request Example
```bash
curl https://your-strapi.com/api/page-builder/templates/xyz789
```

### Response
#### Success Response (200)
- **data** (object) - The template object.
  - **id** (integer) - The internal ID of the template.
  - **documentId** (string) - The unique identifier for the template.
  - **name** (string) - The name of the template.
  - **shortName** (string) - A short, human-readable name for the template.
  - **contentType** (string) - The content type associated with the template.
  - **json** (object) - The JSON structure of the template.
  - **locale** (string) - The locale of the template.

#### Response Example
```json
{
  "data": {
    "id": 1,
    "documentId": "xyz789",
    "name": "api.article.homepage-hero",
    "shortName": "Homepage Hero",
    "contentType": "api::article.article",
    "json": { "content": [], "root": {}, "zones": {} },
    "locale": "en"
  }
}
```
```

--------------------------------

### Get Template by ID (Content API)

Source: https://context7.com/wecre8websites/strapi-page-builder/llms.txt

A public API endpoint for retrieving a specific template by its ID without requiring authentication. Uses a GET request to `/api/page-builder/templates/:id`. The response contains the details of the requested template.

```bash
# GET /api/page-builder/templates/:id
curl https://your-strapi.com/api/page-builder/templates/xyz789

# Response
{
  "data": {
    "id": 1,
    "documentId": "xyz789",
    "name": "api.article.homepage-hero",
    "shortName": "Homepage Hero",
    "contentType": "api::article.article",
    "json": { "content": [], "root": {}, "zones": {} },
    "locale": "en"
  }
}
```

--------------------------------

### Get Strapi Content API Endpoint

Source: https://context7.com/wecre8websites/strapi-page-builder/llms.txt

Searches and retrieves content documents for a specific content type using a POST request. Accepts searchQuery, locale, and titleField as optional parameters in the request body. Returns an array of matching content documents.

```typescript
// POST /page-builder/editor/content/:contentType
// Example: POST /page-builder/editor/content/api::article.article
// Request body
{
  "searchQuery": "React",
  "locale": "en",
  "titleField": "title"
}

// Response
[
  { "documentId": "abc123", "title": "React Best Practices" },
  { "documentId": "def456", "title": "Advanced React Patterns" }
]
```

--------------------------------

### Untitled

No description

--------------------------------

### GET /page-builder/settings/contentTypes

Source: https://context7.com/wecre8websites/strapi-page-builder/llms.txt

Returns all Strapi content types that have a template relation configured and are available for use with Page Builder.

```APIDOC
## GET /page-builder/settings/contentTypes

### Description
Returns all Strapi content types that have a template relation configured and are available for use with Page Builder.

### Method
GET

### Endpoint
/page-builder/settings/contentTypes

### Response
#### Success Response (200)
- Returns an array of content type objects, each containing:
  - **uid** (string) - The unique identifier of the content type.
  - **globalId** (string) - The global ID of the content type.
  - **source** (string) - The source of the content type (e.g., 'api').
  - **kind** (string) - The kind of the content type (e.g., 'collectionType', 'singleType').

#### Response Example
```json
[
  {
    "uid": "api::article.article",
    "globalId": "Article",
    "source": "api",
    "kind": "collectionType"
  },
  {
    "uid": "api::page.page",
    "globalId": "Page",
    "source": "api",
    "kind": "singleType"
  }
]
```
```

--------------------------------

### Untitled

No description

--------------------------------

### POST /page-builder/editor

Source: https://context7.com/wecre8websites/strapi-page-builder/llms.txt

Retrieves all necessary data for initializing the page builder editor, including available content types, templates, selected content, locales, and license information.

```APIDOC
## POST /page-builder/editor

### Description
Retrieves all necessary data for initializing the page builder editor, including available content types, templates, selected content, locales, and license information.

### Method
POST

### Endpoint
/page-builder/editor

### Parameters
#### Request Body
- **contentType** (string) - Required - The content type to retrieve data for.
- **contentId** (string) - Required - The ID of the content to retrieve data for.
- **templateId** (string) - Optional - The ID of the template to retrieve.
- **locale** (string) - Optional - The locale of the content to retrieve.

### Request Example
```json
{
  "contentType": "api::article.article",
  "contentId": "abc123",
  "templateId": "xyz789",
  "locale": "en"
}
```

### Response
#### Success Response (200)
- **token** (string) - A JWT token for authentication.
- **url** (string) - The URL of the page builder editor.
- **locales** (array) - A list of available locales.
- **contentTypes** (array) - A list of available content types.
- **contentType** (string) - The content type of the retrieved content.
- **contentId** (string) - The ID of the retrieved content.
- **contentData** (object) - The data of the retrieved content.
- **contentDocuments** (array) - A list of content documents.
- **templateId** (string) - The ID of the retrieved template.
- **templateJson** (object) - The JSON structure of the retrieved template.
- **templateDocuments** (array) - A list of template documents.
- **enforceTemplateShape** (boolean) - Whether to enforce the template shape.
- **errors** (object) - An object containing any errors encountered.

#### Response Example
```json
{
  "token": "eyJhbGciOiJIUzI1...",
  "url": "https://editor.example.com",
  "locales": [
    { "name": "English", "code": "en", "isDefault": true },
    { "name": "French", "code": "fr", "isDefault": false }
  ],
  "contentTypes": [
    {
      "uid": "api::article.article",
      "globalId": "Article",
      "source": "api",
      "kind": "collectionType"
    }
  ],
  "contentType": "api::article.article",
  "contentId": "abc123",
  "contentData": { "title": "My Article", "description": "..." },
  "contentDocuments": [
    { "documentId": "abc123", "title": "My Article" }
  ],
  "templateId": "xyz789",
  "templateJson": {
    "content": [],
    "root": {},
    "zones": {}
  },
  "templateDocuments": [
    { "documentId": "xyz789", "shortName": "Article Template" }
  ],
  "enforceTemplateShape": true,
  "errors": {
    "licenceError": null,
    "contentError": null
  }
}
```
```

--------------------------------

### POST /page-builder/settings

Source: https://context7.com/wecre8websites/strapi-page-builder/llms.txt

Configures the Page Builder plugin with API key, editor URL, default content type and content ID.

```APIDOC
## POST /page-builder/settings

### Description
Configures the Page Builder plugin with API key, editor URL, default content type and content ID.

### Method
POST

### Endpoint
/page-builder/settings

### Parameters
#### Request Body
- **apiKey** (string) - Required - The API key for the page builder.
- **url** (string) - Required - The URL of the page builder editor.
- **defaultContentType** (string) - Required - The default content type to use.
- **defaultContentId** (string) - Required - The default content ID to use.
- **enforceTemplateShape** (boolean) - Optional - Whether to enforce the template shape.

### Request Example
```json
{
  "apiKey": "pb_1234567890abcdef",
  "url": "https://editor.example.com",
  "defaultContentType": "api::page.page",
  "defaultContentId": "home123",
  "enforceTemplateShape": true
}
```

### Response
#### Success Response (200)
- **apiKey** (string) - The configured API key.
- **url** (string) - The configured editor URL.
- **defaultContentType** (string) - The configured default content type.
- **defaultContentId** (string) - The configured default content ID.
- **enforceTemplateShape** (boolean) - The configured template shape enforcement setting.
- **success** (boolean) - Indicates if the settings were saved successfully.
- **error** (string|null) - An error message if the save failed.

#### Response Example
```json
{
  "apiKey": "pb_1234567890abcdef",
  "url": "https://editor.example.com",
  "defaultContentType": "api::page.page",
  "defaultContentId": "home123",
  "enforceTemplateShape": true,
  "success": true,
  "error": null
}
```
```

--------------------------------

### List Settings Content Types (TypeScript)

Source: https://context7.com/wecre8websites/strapi-page-builder/llms.txt

Retrieves a list of all content types that are configured with template relations. This is useful for understanding which content types can utilize Page Builder functionality.

```typescript
const contentTypes = await strapi
  .plugin('page-builder')
  .service('editor')
  .getSettingsContentTypes();

contentTypes.forEach(ct => {
  console.log(`${ct.globalId} (${ct.uid}) - ${ct.kind}`);
});

// Example output:
// Article (api::article.article) - collectionType
// Page (api::page.page) - singleType
```

--------------------------------

### Retrieve Editor Data for Strapi Page Builder (TypeScript)

Source: https://context7.com/wecre8websites/strapi-page-builder/llms.txt

Fetches all necessary data for initializing the page builder editor. This includes available content types, templates, selected content, locale information, and license details. It requires a POST request to `/page-builder/editor` with content type, content ID, template ID, and locale in the request body.

```typescript
// POST /page-builder/editor
// Request body
{
  "contentType": "api::article.article",
  "contentId": "abc123",
  "templateId": "xyz789",
  "locale": "en"
}

// Response
{
  "token": "eyJhbGciOiJIUzI1...",
  "url": "https://editor.example.com",
  "locales": [
    { "name": "English", "code": "en", "isDefault": true },
    { "name": "French", "code": "fr", "isDefault": false }
  ],
  "contentTypes": [
    {
      "uid": "api::article.article",
      "globalId": "Article",
      "source": "api",
      "kind": "collectionType"
    }
  ],
  "contentType": "api::article.article",
  "contentId": "abc123",
  "contentData": { "title": "My Article", "description": "..." },
  "contentDocuments": [
    { "documentId": "abc123", "title": "My Article" }
  ],
  "templateId": "xyz789",
  "templateJson": {
    "content": [],
    "root": {},
    "zones": {}
  },
  "templateDocuments": [
    { "documentId": "xyz789", "shortName": "Article Template" }
  ],
  "enforceTemplateShape": true,
  "errors": {
    "licenceError": null,
    "contentError": null
  }
}
```

--------------------------------

### Untitled

No description

--------------------------------

### Untitled

No description

--------------------------------

### Untitled

No description

--------------------------------

### Editor Settings Content Type Internal Structure (TypeScript)

Source: https://context7.com/wecre8websites/strapi-page-builder/llms.txt

Outlines the internal structure of the 'editor' content type, which stores the Page Builder plugin's global configuration settings, such as API keys and default content types.

```typescript
// Internal structure: plugin::page-builder.editor
{
  apiKey: "pb_1234567890",
  defaultContentType: "api::page.page",
  defaultContentId: "home-page-id",
  enforceTemplateShape: true
}
```

--------------------------------

### Save Strapi Page Builder Settings (TypeScript)

Source: https://context7.com/wecre8websites/strapi-page-builder/llms.txt

Configures the Page Builder plugin by setting the API key, editor URL, and default content type and ID. This POST request to `/page-builder/settings` is essential for connecting the plugin to your Strapi instance and external services.

```typescript
// POST /page-builder/settings
// Request body
{
  "apiKey": "pb_1234567890abcdef",
  "url": "https://editor.example.com",
  "defaultContentType": "api::page.page",
  "defaultContentId": "home123",
  "enforceTemplateShape": true
}

// Response
{
  "apiKey": "pb_1234567890abcdef",
  "url": "https://editor.example.com",
  "defaultContentType": "api::page.page",
  "defaultContentId": "home123",
  "enforceTemplateShape": true,
  "success": true,
  "error": null
}
```

--------------------------------

### POST /page-builder/editor/templates

Source: https://context7.com/wecre8websites/strapi-page-builder/llms.txt

Creates a new template for a specific content type with optional duplication from an existing template.

```APIDOC
## POST /page-builder/editor/templates

### Description
Creates a new template for a specific content type with optional duplication from an existing template.

### Method
POST

### Endpoint
/page-builder/editor/templates

### Parameters
#### Request Body
- **templateName** (string) - Required - The name of the new template.
- **contentType** (string) - Required - The content type for which the template is being created.
- **duplicateId** (string) - Optional - The ID of an existing template to duplicate.
- **locale** (string) - Optional - The locale for the new template.
- **templateJson** (object) - Optional if `duplicateId` is provided - The JSON structure of the template.

### Request Example
```json
{
  "templateName": "Homepage Hero",
  "contentType": "api::page.page",
  "duplicateId": "existing-template-id",
  "locale": "en",
  "templateJson": {
    "content": [],
    "root": { "type": "container" },
    "zones": {}
  }
}
```

### Response
#### Success Response (200)
- **templateId** (string) - The ID of the newly created template.
- **templateJson** (object) - The JSON structure of the new template.
- **templateDocuments** (array) - A list of template documents associated with the new template.

#### Response Example
```json
{
  "templateId": "new-template-id",
  "templateJson": {
    "content": [],
    "root": { "type": "container" },
    "zones": {}
  },
  "templateDocuments": [
    { "documentId": "new-template-id", "shortName": "Homepage Hero" }
  ]
}
```
```

--------------------------------

### Manage Editor Settings (TypeScript)

Source: https://context7.com/wecre8websites/strapi-page-builder/llms.txt

Handles retrieving and saving plugin configuration, including API keys, default content types, and template shape enforcement. It interacts with the 'editor' service of the 'page-builder' plugin.

```typescript
// Get current settings
const settings = await strapi
  .plugin('page-builder')
  .service('editor')
  .getSettings();

console.log(settings.apiKey);
console.log(settings.url);
console.log(settings.defaultContentType);

// Save settings
const saveResult = await strapi
  .plugin('page-builder')
  .service('editor')
  .saveSettings({
    apiKey: 'pb_newkey123',
    url: 'https://new-editor.com',
    defaultContentType: 'api::page.page',
    defaultContentId: 'home-page-id',
    enforceTemplateShape: true
  });

if (saveResult.error) {
  console.error('Settings save failed:', saveResult.error);
}
```

--------------------------------

### Untitled

No description

--------------------------------

### Create New Template in Strapi Page Builder (TypeScript)

Source: https://context7.com/wecre8websites/strapi-page-builder/llms.txt

Creates a new page template for a specified content type. It supports optional duplication from an existing template and allows defining the template's structure via JSON. This POST request to `/page-builder/editor/templates` returns the new template's ID and structure.

```typescript
// POST /page-builder/editor/templates
// Request body
{
  "templateName": "Homepage Hero",
  "contentType": "api::page.page",
  "duplicateId": "existing-template-id", // optional
  "locale": "en",
  "templateJson": { // optional if duplicateId provided
    "content": [],
    "root": { "type": "container" },
    "zones": {}
  }
}

// Response
{
  "templateId": "new-template-id",
  "templateJson": {
    "content": [],
    "root": { "type": "container" },
    "zones": {}
  },
  "templateDocuments": [
    { "documentId": "new-template-id", "shortName": "Homepage Hero" }
  ]
}
```

--------------------------------

### POST /page-builder/editor/content/:contentType - Search and Retrieve Content

Source: https://context7.com/wecre8websites/strapi-page-builder/llms.txt

Searches and retrieves content documents for a specific content type with optional filtering.

```APIDOC
## POST /page-builder/editor/content/:contentType

### Description
Searches and retrieves content documents for a specific content type with optional filtering.

### Method
POST

### Endpoint
`/page-builder/editor/content/:contentType`

### Parameters
#### Path Parameters
- **contentType** (string) - Required - The content type to search within (e.g., `api::article.article`).

#### Request Body
- **searchQuery** (string) - Optional - The query string to search for within content.
- **locale** (string) - Optional - The locale of the content to retrieve.
- **titleField** (string) - Optional - The field to use for searching if `searchQuery` is provided.

### Request Example
```json
{
  "searchQuery": "React",
  "locale": "en",
  "titleField": "title"
}
```

### Response
#### Success Response (200)
- An array of content documents matching the criteria.
  - **documentId** (string) - The unique identifier for the content document.
  - **title** (string) - The title of the content document.

#### Response Example
```json
[
  { "documentId": "abc123", "title": "React Best Practices" },
  { "documentId": "def456", "title": "Advanced React Patterns" }
]
```
```

--------------------------------

### Editor Service - saveTemplate

Source: https://context7.com/wecre8websites/strapi-page-builder/llms.txt

Creates or updates templates with automatic locale handling and template shape enforcement.

```APIDOC
## Plugin Services: Editor Service - saveTemplate

### Description
Creates or updates templates with automatic locale handling and template shape enforcement.

### Method
`strapi.plugin('page-builder').service('editor').saveTemplate(options)`

### Parameters
- **options** (object) - An object containing the template data.
  - **templateName** (string) - Optional - The name for a new template.
  - **templateId** (string) - Optional - The ID of an existing template to update.
  - **duplicateId** (string) - Optional - The ID of an existing template to duplicate.
  - **contentType** (string) - Required - The content type associated with the template.
  - **locale** (string) - Required - The locale of the template.
  - **templateJson** (object) - Required - The JSON structure of the template.

### Usage Example
```typescript
// Create new template
const result = await strapi
  .plugin('page-builder')
  .service('editor')
  .saveTemplate({
    templateName: 'Article Layout',
    contentType: 'api::article.article',
    locale: 'en',
    templateJson: {
      content: [],
      root: { type: 'container' },
      zones: {}
    }
  });

// Update existing template
const updateResult = await strapi
  .plugin('page-builder')
  .service('editor')
  .saveTemplate({
    templateId: 'xyz789',
    templateJson: { /* updated structure */ },
    contentType: 'api::article.article',
    locale: 'en'
  });

// Duplicate template
const duplicated = await strapi
  .plugin('page-builder')
  .service('editor')
  .saveTemplate({
    templateName: 'New Template',
    contentType: 'api::page.page',
    duplicateId: 'existing-id',
    locale: 'en'
  });
```

### Response
Returns a result object indicating the success or failure of the template operation.
```

--------------------------------

### Untitled

No description

--------------------------------

### Editor Service - getEditorData

Source: https://context7.com/wecre8websites/strapi-page-builder/llms.txt

Aggregates all data required for the page builder editor interface, including license validation and content retrieval.

```APIDOC
## Plugin Services: Editor Service - getEditorData

### Description
Aggregates all data required for the page builder editor interface, including license validation and content retrieval.

### Method
`strapi.plugin('page-builder').service('editor').getEditorData(contentType, contentId, templateId, locale)`

### Parameters
- **contentType** (string) - Required - The content type of the page being edited.
- **contentId** (string) - Required - The ID of the content document.
- **templateId** (string) - Required - The ID of the template to use for the editor.
- **locale** (string) - Required - The locale of the content.

### Usage Example
```typescript
const editorData = await strapi
  .plugin('page-builder')
  .service('editor')
  .getEditorData(
    'api::article.article',  // contentType
    'abc123',                 // contentId
    'xyz789',                 // templateId
    'en'                      // locale
  );

// Returns GetEditorDataResponse with token, content, templates, and locales
console.log(editorData.contentData);
console.log(editorData.templateJson);
console.log(editorData.errors);
```

### Response
An object containing editor data, including:
- **token** (string) - Authentication token.
- **contentData** (object) - The content data for the editor.
- **templateJson** (object) - The JSON structure of the template.
- **templates** (array) - Available templates.
- **locales** (array) - Available locales.
- **errors** (array) - Any errors encountered during data aggregation.
```

--------------------------------

### PUT /page-builder/editor/templates/:templateId - Update Template

Source: https://context7.com/wecre8websites/strapi-page-builder/llms.txt

Updates an existing template's JSON structure with support for multi-locale synchronization.

```APIDOC
## PUT /page-builder/editor/templates/:templateId

### Description
Updates an existing template's JSON structure with support for multi-locale synchronization.

### Method
PUT

### Endpoint
`/page-builder/editor/templates/:templateId`

### Parameters
#### Path Parameters
- **templateId** (string) - Required - The ID of the template to update.

#### Request Body
- **templateJson** (object) - Required - The updated JSON structure for the template.
- **contentType** (string) - Required - The content type associated with the template.
- **locale** (string) - Optional - The locale of the template to update.

### Request Example
```json
{
  "templateJson": {
    "content": [
      {
        "id": "comp-1",
        "type": "hero",
        "props": {
          "title": "{{content.title}}",
          "image": "{{content.featuredImage}}"
        }
      }
    ],
    "root": { "type": "container", "children": ["comp-1"] },
    "zones": {}
  },
  "contentType": "api::page.page",
  "locale": "en"
}
```

### Response
#### Success Response (200)
- **templateId** (string) - The ID of the updated template.
- **templateJson** (object) - The updated JSON structure of the template.
- **templateDocuments** (array) - An array of template documents associated with the update.
  - **documentId** (string) - The ID of the document.
  - **shortName** (string) - The short name of the document.

#### Response Example
```json
{
  "templateId": "xyz789",
  "templateJson": { "content": [...], "root": {...}, "zones": {} },
  "templateDocuments": [
    { "documentId": "xyz789", "shortName": "Updated Template" }
  ]
}
```
```

--------------------------------

### Editor Service - getStrapiContent

Source: https://context7.com/wecre8websites/strapi-page-builder/llms.txt

Retrieves content documents for a specific content type with search and locale filtering.

```APIDOC
## Plugin Services: Editor Service - getStrapiContent

### Description
Retrieves content documents for a specific content type with search and locale filtering.

### Method
`strapi.plugin('page-builder').service('editor').getStrapiContent(contentType, searchQuery, locale, titleField)`

### Parameters
- **contentType** (string) - Required - The content type to search within.
- **searchQuery** (string) - Optional - The query string to search for within content.
- **locale** (string) - Optional - The locale of the content to retrieve.
- **titleField** (string) - Optional - The field to use for searching if `searchQuery` is provided.

### Usage Example
```typescript
const articles = await strapi
  .plugin('page-builder')
  .service('editor')
  .getStrapiContent(
    'api::article.article',  // contentType
    'React',                  // searchQuery (optional)
    'en',                     // locale (optional)
    'title'                   // titleField (optional)
  );

// Returns array of content documents
articles.forEach(article => {
  console.log(article.documentId, article.title);
});
```

### Response
An array of content documents matching the specified criteria.
```

--------------------------------

### Template Content Type Internal Structure (TypeScript)

Source: https://context7.com/wecre8websites/strapi-page-builder/llms.txt

Describes the internal structure of the 'template' content type used by the Page Builder plugin, including its unique identifier, associated content type, JSON structure, locale, and Strapi document ID.

```typescript
// Internal structure: plugin::page-builder.template
{
  name: "api.article.homepage-hero",          // Unique identifier
  shortName: "Homepage Hero",                  // Display name
  contentType: "api::article.article",         // Associated content type
  json: {                                      // Template structure (localized)
    content: [],
    root: {},
    zones: {}
  },
  locale: "en",                               // i18n locale
  documentId: "xyz789"                        // Strapi document ID
}
```
Tokens:
Raw