Settings

settings: {
  handle: 'magazine',
  languages: {
    available: [
      {label: 'German', locale: 'de'},
      {label: 'English', locale: 'en'}
    ],
    defaultLanguage: {
      label: 'German',
      locale: 'de'
    },
    requiredOnCreation: true,
    translationWorkflow: true // shows "translate" icon on the toolbar
  },
  integrations: {
    // Kordiam Global Integration
    // For the legacy Kordiam Platform Integration see `settings.kordiam`
    // For further details see the "Kordiam Global Integration" guide
    kordiam: {
      enabled: true,
      credentials: {
        clientId: 'my-kordiam-client-id',
        clientSecret: {
          $secretRef: {
            name: 'my-kordiam-secret'
          }
        }
      },
      apiEndpoint: 'https://kordiam.app', // Optional, Defaults to 'https://kordiam.app'
      createDocumentFunction: 'myCreateDocumentFunction',
      createElementFunction: 'myCreateElementFunction',
      incomingElementToDocumentCommandsFunction: 'myIncomingElementToDocumentCommandsFunction',
      outgoingDocumentToElementFunction: 'myOutgoingDocumentToElementFunction',
      outgoingDocumentToElementEventSources: ['publish', 'unpublish', 'update'] // Default: ['publish', 'unpublish']
    },
    // NOTE: imatrics uses our secure $secretRef method that will be used by all plugins in future
    imatrics: {
      enabled: true,
      apiEndpoint: 'https://some.url.com',
      user: 'yourUser',
      key: {
        $secretRef: {
          name: 'imatrics-20211027'
        }
      },
      testEnvironment: false, // Added in: release-2024-09
      minchars: 20,
      language: {
        name: 'German',
        value: 'de'
      }
    },
    retresco: {
      enabled: true,
      apiEndpoint: 'https://<subdomain>.rtrsupport.de/',
      username: '<username>',
      password: {
        $secretRef: {
          name: '<secret-name>'
        }
      },
      enableLiveAnalysis: true,
      // The component.directive combinations used to extract specific strings.
      // The first match will be used, but multiple values can be provided so that many
      // content types can be supported.
      titleMatches: ['header.title'],
      supertitleMatches: ['header.catchline'],
      teaserMatches: ['header.lead', 'p.text'],
      maxTextLength: 100
    },
    comyan: {
      enabled: true,
      buttonLabel: 'open comyan',
      targetMediaType: 'image', // mandatory with release-2025-01
      mediaSystem: {
        additionalApiQueryString: 'foo=bar' // in case of proxy use, set `svcURLFormat=api`
        credentials: {
          username: 'user',
          password: {
            $secretRef: {
              name: '<secret-name>'
            }
          }
        },
        baseUrl: 'https://example.com/MediaSystem',
      },
      storageBaseUrl: 'https://storage.proxy.com/' // set this if comyan serves your images through a proxy
    },
    googleVision: {
      enabled: true,
      credentials: {
        type: 'service_account',
        project_id: 'your-project-123',
        private_key_id: '123',
        private_key: '-----BEGIN PRIVATEfoo bar-----END PRIVATE KEY-----\n',
        client_email: 'vision-api-dev@your-project-123.iam.gserviceaccount.com',
        client_id: '123',
        auth_uri: 'https://accounts.google.com/o/oauth2/auth',
        token_uri: 'https://oauth2.googleapis.com/token',
        auth_provider_x509_cert_url: 'https://www.googleapis.com/oauth2/v1/certs',
        client_x509_cert_url: 'https://www.googleapis.com/robot/v1/metadata/x509/vision-api-dev%40your-project-123.iam.gserviceaccount.com'
      },
      confidenceCliff: 0.7,
      language: {
        label: 'German',
        locale: 'de'
      },
      shouldDetectWeb: true
    }
  },

  // Kordiam Platform Integration (legacy)
  // For the new Kordiam Global Integration see `settings.integrations.kordiam`
  // For further details see the "Kordiam Platform Integration" guide
  kordiam: {
    enabled: true,
    credentials: {
      clientId: 'my-kordiam-client-id',
      clientSecret: {
        $secretRef: {
          name: 'my-kordiam-secret-ref'
        }
      }
    },
    titlePath: 'slug', // Default: "title"
    publicationStatus: {
      sync: false,
      publishedStatus: 5, // Deprecated
      unpublishedStatus: 1 // Deprecated
    },
    contentTypes: {
      standard: 'regular', // Required. The default content type to create.
      // Configuration of additional content types that can be created
      source: 'publication.type.name',
      mapping: [
        {
          source: 'article', // publication.type.name value
          target: 'regular' // Livingdocs content type handle
        }
      ]
    }
  },

  includeServices: [
    {
      handle: 'echo-service',
      rendering: {
        type: 'remote',
        url: 'http://localhost:3000',
        timeout: 3000
      },
      config: {
        foo: 'bar'
      },
      paramsSchema: [
        {
          type: 'li-text',
          handle: 'json',
          config: {
              maxLength: 200
          },
          ui: {
            config: {
              label: 'Json',
              placeholder: '{ "foo": "bar" }'
            }
          }
        }
      ],
      defaultParams: {
        title: 'defaultTitle'
      },
      blockEditorInteraction: 'initial'
    }
  ],

  webhooks: {
    active: true,
    configurations: [
      {
        active: true,
        handle: 'publish-hook',
        label: 'Publish Hook',
        description: '',
        url: 'https://foo.bar.com/my-webhook',
        secret: 'foo-bar',
        events: [{
          name: 'document.build',
          conditions: {
            deliveryHandles: ['web']
          }
        }]
      }
    ]
  },

  copy: [{
    source: {
      channelHandle: 'web',
      contentType: 'regular'
    },
    targets: [
      {
        channelHandle: 'web',
        contentType: 'kolumne',
        metadata: {
          map: [
            'title',
            'headline',
            'authors',
            'description',
            'teaserImage',
            'publishDate'
          ]
        },
        componentConversions: [
          {
            match: 'article-container',
            exclude: true
          },
          {
            match: 'head',
            result: [
              {
                component: 'catchline',
                directives: {title: {takeFrom: 'flag'}}
              },
              {
                component: 'headline',
                directives: {title: {takeFrom: 'title'}}
              }
            ]
          }
        ]
      }
    ]
  }],

  // This setting can be overwritten in the `contentType` config
  imageSourcePolicy: [
    {provider: 'upload', enabled: true},
    {provider: 'hugo', enabled: false},
    {
      provider: 'url',
      enabled: true,
      hosts: ['//pixabay.com']
    }
  ],

  // This setting can be overwritten in the `contentType` config
  videoSourcePolicy: [
    {provider: 'upload', enabled: false}
  ],

  // setup the push notification feature if applicable
  // for this to work you also must:
  // 1. configure firebase in the server-wide `pushNotifications` configuration
  // 2. have a metadata field with the (exact) name `pushNotifications`
  // IMPORTANT: value can not contain more than three comma separated entries
  // see firebase conditions for more details.
  pushNotifications: {
    topics: [
      {
        handle: 'breaking-news',
        label: 'Breaking News',
        value: 'ios_de_breakingnews, android_de_breakingnews'
      },
      {
        handle: 'sport',
        label: 'Sport',
        value: 'ios_de_sports, android_de_sports'
      }
    ]
  }

  editMode: 'default'
}

// NOTE: you need to choose a unique name, an easy way is to append the current date to the string 'imatrics-' as done below
npx livingdocs-server secret-add --project=<handle> --name=imatrics-20211027 --value=secretvalue
// -> this adds a new secret 'imatrics-20211027' to our encrypted secret store

imatrics: {
  ...
  key: {
    $secretRef: {
      name: 'imatrics-20211027'
    }
  },
  ...