Tilda-sync NPM

Неофициальная библиотека для автоматической синхронизации проекта Tilda.cc → Node.js и его запуска.

Библиотека работает на базе Tilda API (официальная документация). Важно: допускается не более 150 запросов в час.

Установка

npm i tilda-sync

Подготовка на стороне Tilda

Перейдите в настройки сайта, выберите вкладку «Экспорт»
Во вкладке API Integration сгенерируйте Публичный и Секретный ключи. При необходимости, укажите путь ссылки для Webhook'а, который будет уведомлять сервер об изменениях в проекте.
Вернитесь обратно во вкладку «Экспорт». Перейдите в «Специальные настройки экспорта».
Заполните все поля, устанавливающие пути для файлов: например, путь для изображений /img, путь для JS файлов /js, путь для CSS файлов /css.
«Путь ко всем страницам» должен быть настроен, если вы планируете, чтобы сайт был доступен по отличному от корневого пути сайта на Тильде. Например, сайта на Тильде https://mysite.tilda.ws вы планируете разместить по адресу https://mysite.com/custom/. В таком случае заполните поле так: /custom. Если вы планируете разместить проект по адресу https://mysite.com/, можете НЕ заполнять это поле, этот путь поддерживается по умолчанию.
Сохраните все настройки.

Использование

Инициализируйте клиент, указав ключи, полученные в кабинете Тильды

import TildaSync from 'tilda-sync';

let tildaSync = new TildaSync({
	publicKey: 'YOUR_PUBLIC_KEY',
	secretKey: 'YOUR_SECRET_KEY',
	debug: true, // опционально: вкл./выкл. сообщения в консоль
});

Базовые запросы

Вы можете использовать все задокументированные API-запросы

Список доступных проектов

let projectsList = await tildaSync.getProjectsList()

Получить информацию о проекте (вкл. .htaccess)

let projectData = await tildaSync.getProjectExport('PROJECT_ID')

Получить список страниц в проекте

let projectPages = await tildaSync.getPagesList('PROJECT_ID')

Информация о странице (body html)

let page = await tildaSync.getPage('PAGE_ID')

Полная информация о странице (head, body html, header/footer)

let pageFull = await tildaSync.getPageFull('PAGE_ID')

Информация о странице для экспорта (body html, files)

let pageExport = await tildaSync.getPageExport('PAGE_ID')

Полная информация о странице для экспорта (head, body html, header/footer, files)

let pageFullExport = await tildaSync.getPageFullExport('PAGE_ID')

Полный импорт проекта

tildaSync.importProject(projectId, folder, routerFile)

Позволяет импортировать весь проект, сохранив в указанную папку все статичные файлы, а также создав JSON-файл с маршрутами проекта. Аргументы:

projectId (String) — ID проекта на Тильде ('1234567')
folder (String) — папка назначения импорта ('/my-project') по умолчанию: ID проекта
routerFile (Object) — настройки импорта файла маршрутов (парсинг .htaccess файла в формате JSON) по умолчанию: { isEnabled: true, path: folder, filename: 'pages' + projectId + '.json'}

routerFile.isEnabled (Boolean) — вкл./выкл. генерацию файла маршрутов по умолчанияю: true
routerFile.path (String) — место сохранения файла по умолчанию: folder
routerFile.filename (String) — название файла сохранения маршрутов проекта по умолчанию: 'pages' + projectId + '.json'

Пример использования:

try {
    let importResult = await tildaSync.importProject('1234567', './../public/');
    console.log(importResult)
} catch (err) {
    console.log(err)
}

Обратите внимание, что js, css, img будут сохранены в подпапку, указанную в настройках экспорта в кабинете Tilda.
Кол-во запросов к Tilda API при выполнении алгоритм: 2 запроса + 1 запрос * кол-во страниц проекта. Учитывайте, что максимальное кол-во обращений в час — 150.

Полный импорт страницы

tildaSync.importPage(pageId, folder, options)

Позволяет импортировать одну страницу проекта, сохранив в указанную папку все статичные файлы. Аргументы:

pageId (String) — ID страницы на Тильде ('1234567')
folder (String) — папка назначения импорта ('/my-project') по умолчанию: "imported_pages"
options (Object) — дополнительные настройки по умолчанию: { downloadStatics: true }

options.downloadStatics (Boolean) — вкл./выкл. скачивание static-файлов страницы по умолчанияю: true

Пример использования:

try {
    let pageImportResult = await tildaSync.importPage('2342345', './../your-folder');
    console.log(pageImportResult)
} catch (err) {
    console.log(err)
}

Запуск проекта на Node.js + Express

Данный пакет позволяет осуществить запуск импортированного проекта.

Разместите импортированные static-файлы (js, css, img) в папку для публичных файлов вашего проекта (обычно это /public/ или /static/). Как это делается на Express?.

TildaRouter(routingFile, options)

routingFile (String) — путь к файлу маршрутов, иипортированному ранее с tildaSync.importProject (например, pages1234567.json)
options (Object) — дополнительные настройки
options.pathToHTMLs (String) — расположение импортированных файлов html
options.pageIndex (String) — имя страницы, которая должны быть главной по умолчанию: по данным Тильды
options.page404 (String) — имя страницы, отображаемой при ошибке 404 по умолчанию: по данным Тильды

Инициализируйте TildaRouter:

import { TildaRouter } from 'tilda-sync'

let tildaRouter = new TildaRouter('pagesPROJECT_ID.json', {
    pathToHTMLs: './public',
    pageIndex: 'mainpage', // опционально
    page404: 'not-found-error' // опционально
})

Теперь вы можете использовать контроллер для маршрутизации:

app.get('*', tildaRouter.controller)

// или 

router.get('*', tildaRouter.controller)

Если вы хотите, чтобы проект был доступен только по определенному маршруту (например, /example/), укажите его:

app.get('/example', tildaRouter.controller)
app.get('/example/*', tildaRouter.controller)

// или 

router.get('/example', tildaRouter.controller)
router.get('/example/*', tildaRouter.controller)

Не забывайте, что в этом случае в настройках Тильды вы должны указать аналогичный путь в поле «Путь ко всем страницам сайта». Это необходимо, чтобы все ссылки проекта работали корректно.

tildaRouter.updateRoutes()

В случае, если файл маршрутов был изменен, и вам необходимо обновить правила маршрутизации из файла, вызовите метод updateRoutes объекта tildaRouter:

tildaRouter.updateRoutes()

Автоматическая синхронизация проекта

Вы также можете настроить автоматическую синхронизацию проекта с Тильдой. В случае опубликованных изменений в проекте, Тильда отправит уведомление, после чего можно запланировать новый импорт.

В настройках сайта в Тильде, укажите URL для webhook'а, на который будет отправлено уведомление (GET-запрос).
Настройте контроллер на соответствующий URL, который ответит Тильде ok.
Запустите импорт заново при получение webhook'a.
После завершения импорта, обновите маршруты (если используете TildaRouter).

Пример реализации:

app.get('/webhook/tilda-project-updated/', (req, res) => {
    res.send('ok')

    const { projectId, pageId, publicKey, published } = req.query

    // После ответа проверьте publicKey и запланируйте (!) импорт проекта.
    // Не стоит запускать импорт проекта каждый раз, когда получаете webhook.
    // Например, запланируйте импорт страницы tildaSync.importPage(pageId, './../your-folder')
    // или импорт всего проекта tildaSync.importProject(projectId, './../your-folder')
})

О подписке на Tilda

Tilda API предполагает наличие платного тарифа не ниже Business. Импорт проекта на собственный сервер не освобождает вас от оплаты подписки. Некоторые функции обращаются к бэкенду Тильды (личный кабинет, заявки, потоки, каталог товаров и пр.), для их работы нужна оплаченная подписка.

TODOs

Автоматическая маршрутизация на Express
Полный импорт одной страницы по ID
Обработчик Webhook'а и автоматические ре-импорт в случае изменений проекта

Связь с автором

Если понадобится помощь, пишите: https://t.me/leshatour

tilda.cc tilda tilda publishing

@everything-registry/sub-chunk-2944 @infinitebrahmanuniverse/nolb-til

1.0.0

3 years ago