Plugin Architecture

import IMGLYEditor
import IMGLYEngine
import SwiftUI

// MARK: - Showcase

struct CustomFeaturePluginSolution: View {
  let settings = EngineSettings(license: secrets.licenseKey, // pass nil for evaluation mode with watermark
                                userID: "<your unique user id>",
                                baseURL: secrets.baseURL)

  static let imageURL = URL(string: "https://img.ly/static/ubq_samples/sample_1.jpg")!

  var body: some View {
    Editor(settings)
      .imgly.configuration {
        DesignEditorConfiguration()
        CustomFeaturePlugin(options: .init(imageURL: Self.imageURL))
      }
  }
}

// MARK: - Plugin

@MainActor
final class CustomFeaturePlugin: EditorConfiguration {
  struct Options {
    var imageURL: URL
  }


  private let options: Options

  init(options: Options) {
    self.options = options
    super.init()
  }

  // MARK: - Callbacks

  override var onCreate: OnCreate.Handler? {
    { _, existing in
      // Pre-setup work goes here.
      try await existing()
      // Post-setup work goes here.
    }
  }


  override var onExport: OnExport.Handler? {
    { engine, eventHandler, _ in
      let archive = try await engine.scene.saveToArchive()
      let url = try Self.writeArchiveToTempFile(archive)
      eventHandler.send(.shareFile(url))
    }
  }


  // MARK: - Components

  override var dock: Dock.Configuration? {
    let imageURL = options.imageURL
    return Dock.Configuration { builder in
      builder.modify { _, items in
        items.addFirst {
          Dock.Button(
            id: "com.example.dock.customFeature",
            action: { context in
              Task { try? await Self.addImageBlock(engine: context.engine, imageURL: imageURL) }
            },
            label: { _ in
              Label {
                Text("Image")
              } icon: {
                Image(systemName: "photo")
              }
            },
          )
        }
      }
    }
  }


  override var canvasMenu: CanvasMenu.Configuration? {
    CanvasMenu.Configuration { builder in
      builder.items { _ in }
    }
  }


  // MARK: - Helpers

  private static func addImageBlock(engine: Engine, imageURL: URL) async throws {
    guard let page = try engine.scene.getCurrentPage() else { return }
    let block = try engine.block.create(.graphic)
    let shape = try engine.block.createShape(.rect)
    let fill = try engine.block.createFill(.image)
    try engine.block.setShape(block, shape: shape)
    try engine.block.setURL(fill, property: "fill/image/imageFileURI", value: imageURL)
    try engine.block.setFill(block, fill: fill)
    try engine.block.setContentFillMode(block, mode: .cover)
    try engine.block.setWidthMode(block, mode: .percent)
    try engine.block.setWidth(block, value: 0.5)
    try engine.block.appendChild(to: page, child: block)
    if try engine.block.isAlignable([block]) {
      try engine.block.alignHorizontally([block], alignment: .center)
      try engine.block.alignVertically([block], alignment: .center)
    }
    try engine.block.setSelected(block, selected: true)
    try engine.editor.addUndoStep()
  }


  private static func writeArchiveToTempFile(_ archive: Blob) throws -> URL {
    let url = FileManager.default.temporaryDirectory
      .appendingPathComponent("custom-feature-\(UUID().uuidString)")
      .appendingPathExtension("scene.zip")
    try archive.write(to: url, options: [.atomic])
    return url
  }
}

#Preview {
  CustomFeaturePluginSolution()
}

Editor(settings)
  .imgly.configuration {
    DesignEditorConfiguration()
    CustomFeaturePlugin(options: .init(imageURL: Self.imageURL))
  }

struct Options {
  var imageURL: URL
}

override var onCreate: OnCreate.Handler? {
  { _, existing in
    // Pre-setup work goes here.
    try await existing()
    // Post-setup work goes here.
  }
}

override var dock: Dock.Configuration? {
  let imageURL = options.imageURL
  return Dock.Configuration { builder in
    builder.modify { _, items in
      items.addFirst {
        Dock.Button(
          id: "com.example.dock.customFeature",
          action: { context in
            Task { try? await Self.addImageBlock(engine: context.engine, imageURL: imageURL) }
          },
          label: { _ in
            Label {
              Text("Image")
            } icon: {
              Image(systemName: "photo")
            }
          },
        )
      }
    }
  }
}