1
0
Fork 0
mirror of synced 2024-06-26 10:00:41 +12:00

adding opengraph metatags for better shareable links

This commit is contained in:
Martin McKeaveney 2022-10-24 17:53:18 +01:00
parent c0aa506b43
commit 28a0392b11
13 changed files with 185 additions and 142 deletions

View file

@ -670,6 +670,11 @@ has@^1.0.3:
dependencies: dependencies:
function-bind "^1.1.1" function-bind "^1.1.1"
html5-qrcode@^2.2.1:
version "2.2.4"
resolved "https://registry.yarnpkg.com/html5-qrcode/-/html5-qrcode-2.2.4.tgz#99e4b36fbd8fbc4956036cf3f21ea3e98c3463d1"
integrity sha512-X8wVVsHpNb35tl7KcoCGAboc6Nep2VyT3CIMjFvrfWrHbHTC0yYTjE+DhO/VcswY2MfHy1uB7b1G9+L13gM6dQ==
htmlparser2@^6.0.0: htmlparser2@^6.0.0:
version "6.1.0" version "6.1.0"
resolved "https://registry.yarnpkg.com/htmlparser2/-/htmlparser2-6.1.0.tgz#c4d762b6c3371a05dbe65e94ae43a9f845fb8fb7" resolved "https://registry.yarnpkg.com/htmlparser2/-/htmlparser2-6.1.0.tgz#c4d762b6c3371a05dbe65e94ae43a9f845fb8fb7"

View file

@ -111,6 +111,8 @@ export const serveApp = async function (ctx: any) {
const App = require("./templates/BudibaseApp.svelte").default const App = require("./templates/BudibaseApp.svelte").default
const plugins = enrichPluginURLs(appInfo.usedPlugins) const plugins = enrichPluginURLs(appInfo.usedPlugins)
const { head, html, css } = App.render({ const { head, html, css } = App.render({
metaImage:
"https://res.cloudinary.com/daog6scxm/image/upload/v1666109324/meta-images/budibase-meta-image_uukc1m.png",
title: appInfo.name, title: appInfo.name,
production: env.isProd(), production: env.isProd(),
appId, appId,

View file

@ -1,6 +1,8 @@
<script> <script>
export let title = "" export let title = ""
export let favicon = "" export let favicon = ""
export let metaImage = ""
export let url = ""
export let clientLibPath export let clientLibPath
export let usedPlugins export let usedPlugins
@ -12,6 +14,14 @@
name="viewport" name="viewport"
content="width=device-width, initial-scale=1.0, viewport-fit=cover" content="width=device-width, initial-scale=1.0, viewport-fit=cover"
/> />
<!-- Opengraph Meta Tags -->
<meta name="twitter:card" content="summary_large_image" />
<meta name="twitter:image" content={metaImage} />
<meta name="twitter:title" content="{title} - built with Budibase" />
<meta property="og:site_name" content="Budibase" />
<meta property="og:title" content={title} />
<meta property="og:type" content="website" />
<meta property="og:image" content={metaImage} />
<title>{title}</title> <title>{title}</title>
<link rel="icon" type="image/png" href={favicon} /> <link rel="icon" type="image/png" href={favicon} />

View file

@ -8,8 +8,6 @@ import { AppPackageResponse } from "../fixtures/types/appPackage"
import { DeployConfig } from "../fixtures/types/deploy" import { DeployConfig } from "../fixtures/types/deploy"
import { responseMessage } from "../fixtures/types/responseMessage" import { responseMessage } from "../fixtures/types/responseMessage"
export default class AppApi { export default class AppApi {
api: InternalAPIClient api: InternalAPIClient

View file

@ -3,26 +3,26 @@ import { Row } from "@budibase/types"
import InternalAPIClient from "./InternalAPIClient" import InternalAPIClient from "./InternalAPIClient"
export default class RowsApi { export default class RowsApi {
api: InternalAPIClient api: InternalAPIClient
constructor(apiClient: InternalAPIClient) { constructor(apiClient: InternalAPIClient) {
this.api = apiClient this.api = apiClient
} }
async getAll(tableId: string): Promise<[Response, Row[]]> { async getAll(tableId: string): Promise<[Response, Row[]]> {
const response = await this.api.get(`/${tableId}/rows`) const response = await this.api.get(`/${tableId}/rows`)
const json = await response.json() const json = await response.json()
return [response, json] return [response, json]
} }
async add(tableId: string, body: any): Promise<[Response, Row]> { async add(tableId: string, body: any): Promise<[Response, Row]> {
const response = await this.api.post(`/${tableId}/rows`, { body }) const response = await this.api.post(`/${tableId}/rows`, { body })
const json = await response.json() const json = await response.json()
return [response, json] return [response, json]
} }
async delete(tableId: string, body: any): Promise<[Response, Row[]]> { async delete(tableId: string, body: any): Promise<[Response, Row[]]> {
const response = await this.api.del(`/${tableId}/rows/`, { body }) const response = await this.api.del(`/${tableId}/rows/`, { body })
const json = await response.json() const json = await response.json()
return [response, json] return [response, json]
} }
} }

View file

@ -1,23 +1,23 @@
import { Screen } from "@budibase/types" import { Screen } from "@budibase/types"
import { Response } from "node-fetch" import { Response } from "node-fetch"
import InternalAPIClient from "./InternalAPIClient" import InternalAPIClient from "./InternalAPIClient"
export default class ScreenApi {
api: InternalAPIClient
constructor(apiClient: InternalAPIClient) {
this.api = apiClient
}
async create(body: any): Promise<[Response, Screen]> {
const response = await this.api.post(`/screens`, { body })
const json = await response.json()
return [response, json]
}
async delete(screenId: string, rev: string): Promise<[Response, Screen]> { export default class ScreenApi {
const response = await this.api.del(`/screens/${screenId}/${rev}`) api: InternalAPIClient
const json = await response.json()
return [response, json] constructor(apiClient: InternalAPIClient) {
} this.api = apiClient
} }
async create(body: any): Promise<[Response, Screen]> {
const response = await this.api.post(`/screens`, { body })
const json = await response.json()
return [response, json]
}
async delete(screenId: string, rev: string): Promise<[Response, Screen]> {
const response = await this.api.del(`/screens/${screenId}/${rev}`)
const json = await response.json()
return [response, json]
}
}

View file

@ -3,38 +3,39 @@ import { Table } from "@budibase/types"
import InternalAPIClient from "./InternalAPIClient" import InternalAPIClient from "./InternalAPIClient"
import { responseMessage } from "../fixtures/types/responseMessage" import { responseMessage } from "../fixtures/types/responseMessage"
export default class TablesApi { export default class TablesApi {
api: InternalAPIClient api: InternalAPIClient
constructor(apiClient: InternalAPIClient) { constructor(apiClient: InternalAPIClient) {
this.api = apiClient this.api = apiClient
} }
async getAll(expectedNumber: Number): Promise<[Response, Table[]]> { async getAll(expectedNumber: Number): Promise<[Response, Table[]]> {
const response = await this.api.get(`/tables`) const response = await this.api.get(`/tables`)
const json = await response.json() const json = await response.json()
expect(response).toHaveStatusCode(200) expect(response).toHaveStatusCode(200)
expect(json.length).toBe(expectedNumber) expect(json.length).toBe(expectedNumber)
return [response, json] return [response, json]
} }
async getTableById(id: string): Promise<[Response, Table]> { async getTableById(id: string): Promise<[Response, Table]> {
const response = await this.api.get(`/tables/${id}`) const response = await this.api.get(`/tables/${id}`)
const json = await response.json() const json = await response.json()
return [response, json] return [response, json]
} }
async save(body: any): Promise<[Response, Table]> { async save(body: any): Promise<[Response, Table]> {
const response = await this.api.post(`/tables`, { body }) const response = await this.api.post(`/tables`, { body })
const json = await response.json() const json = await response.json()
return [response, json] return [response, json]
} }
async delete(id: string, revId: string): Promise<[Response, responseMessage]> {
const response = await this.api.del(`/tables/${id}/${revId}`)
const json = await response.json()
return [response, json]
}
async delete(
id: string,
revId: string
): Promise<[Response, responseMessage]> {
const response = await this.api.del(`/tables/${id}/${revId}`)
const json = await response.json()
return [response, json]
}
} }

View file

@ -1,8 +1,8 @@
import { Row } from "@budibase/types" import { Row } from "@budibase/types"
export const generateNewRowForTable = (tableId: string): Row => { export const generateNewRowForTable = (tableId: string): Row => {
return { return {
TestColumn: "TestRow", TestColumn: "TestRow",
tableId: tableId tableId: tableId,
} }
} }

View file

@ -3,32 +3,32 @@ import generator from "../../generator"
const randomId = generator.guid() const randomId = generator.guid()
const generateScreen = (roleId: string): any => ({ const generateScreen = (roleId: string): any => ({
showNavigation: true, showNavigation: true,
width: "Large", width: "Large",
name: randomId, name: randomId,
template: "createFromScratch", template: "createFromScratch",
props: { props: {
_id: randomId, _id: randomId,
_component: _component: "@budibase/standard-components/container",
"@budibase/standard-components/container", _styles: {
_styles: { normal: {},
normal: {}, hover: {},
hover: {}, active: {},
active: {}, selected: {},
selected: {}
},
_children: [],
_instanceName: "New Screen",
direction: "column",
hAlign: "stretch",
vAlign: "top",
size: "grow",
gap: "M"
}, routing: {
route: "/test",
roleId: roleId,
homeScreen: false
}, },
_children: [],
_instanceName: "New Screen",
direction: "column",
hAlign: "stretch",
vAlign: "top",
size: "grow",
gap: "M",
},
routing: {
route: "/test",
roleId: roleId,
homeScreen: false,
},
}) })
export default generateScreen export default generateScreen

View file

@ -1,34 +1,34 @@
import { Table } from "@budibase/types" import { Table } from "@budibase/types"
export const generateTable = (): Table => { export const generateTable = (): Table => {
return { return {
name: "Test Table", name: "Test Table",
schema: {}, schema: {},
sourceId: "bb_internal", sourceId: "bb_internal",
type: "internal", type: "internal",
dataImport: { dataImport: {
valid: true, valid: true,
schema: {} schema: {},
} },
} }
} }
export const generateNewColumnForTable = (tableData: any): Table => { export const generateNewColumnForTable = (tableData: any): Table => {
const newColumn = tableData const newColumn = tableData
newColumn.schema = { newColumn.schema = {
TestColumn: { TestColumn: {
type: "string", type: "string",
name: "TestColumn", name: "TestColumn",
constraints: { constraints: {
presence: { allowEmpty: false }, presence: { allowEmpty: false },
length: { maximum: null }, length: { maximum: null },
type: "string" type: "string",
} },
} },
} }
newColumn.indexes = { newColumn.indexes = {
0: "TestColumn" 0: "TestColumn",
} }
newColumn.updatedAt = new Date().toISOString() newColumn.updatedAt = new Date().toISOString()
return newColumn return newColumn
} }

View file

@ -1 +1,3 @@
export interface responseMessage { message: string } export interface responseMessage {
message: string
}

View file

@ -5,7 +5,10 @@ import InternalAPIClient from "../../../config/internal-api/TestConfiguration/In
import generateApp from "../../../config/internal-api/fixtures/applications" import generateApp from "../../../config/internal-api/fixtures/applications"
import generator from "../../../config/generator" import generator from "../../../config/generator"
import generateScreen from "../../../config/internal-api/fixtures/screens" import generateScreen from "../../../config/internal-api/fixtures/screens"
import { generateTable, generateNewColumnForTable } from "../../../config/internal-api/fixtures/table" import {
generateTable,
generateNewColumnForTable,
} from "../../../config/internal-api/fixtures/table"
import { generateNewRowForTable } from "../../../config/internal-api/fixtures/rows" import { generateNewRowForTable } from "../../../config/internal-api/fixtures/rows"
describe("Internal API - /applications endpoints", () => { describe("Internal API - /applications endpoints", () => {
@ -119,7 +122,7 @@ describe("Internal API - /applications endpoints", () => {
const [updateResponse, updatedApp] = await config.applications.update( const [updateResponse, updatedApp] = await config.applications.update(
<string>app.appId, <string>app.appId,
{ {
name: generator.word() name: generator.word(),
} }
) )
expect(updateResponse).toHaveStatusCode(200) expect(updateResponse).toHaveStatusCode(200)
@ -188,7 +191,9 @@ describe("Internal API - /applications endpoints", () => {
await config.tables.getAll(2) await config.tables.getAll(2)
// Add new table // Add new table
const [createdTableResponse, createdTableData] = await config.tables.save(generateTable()) const [createdTableResponse, createdTableData] = await config.tables.save(
generateTable()
)
expect(createdTableResponse).toHaveStatusCode(200) expect(createdTableResponse).toHaveStatusCode(200)
expect(createdTableData._id).toBeDefined() expect(createdTableData._id).toBeDefined()
expect(createdTableData._rev).toBeDefined() expect(createdTableData._rev).toBeDefined()
@ -197,20 +202,27 @@ describe("Internal API - /applications endpoints", () => {
await config.tables.getAll(3) await config.tables.getAll(3)
//Get information about the table //Get information about the table
const [tableInfoResponse, tableInfo] = await config.tables.getTableById(<string>createdTableData._id) const [tableInfoResponse, tableInfo] = await config.tables.getTableById(
<string>createdTableData._id
)
expect(tableInfoResponse).toHaveStatusCode(200) expect(tableInfoResponse).toHaveStatusCode(200)
expect(tableInfo._id).toEqual(createdTableData._id) expect(tableInfo._id).toEqual(createdTableData._id)
//Add Column to table //Add Column to table
const newColumn = generateNewColumnForTable(createdTableData) const newColumn = generateNewColumnForTable(createdTableData)
const [addColumnResponse, addColumnData] = await config.tables.save(newColumn) const [addColumnResponse, addColumnData] = await config.tables.save(
newColumn
)
expect(addColumnResponse).toHaveStatusCode(200) expect(addColumnResponse).toHaveStatusCode(200)
expect(addColumnData._id).toEqual(createdTableData._id) expect(addColumnData._id).toEqual(createdTableData._id)
expect(addColumnData.schema.TestColumn).toBeDefined() expect(addColumnData.schema.TestColumn).toBeDefined()
//Add Row to table //Add Row to table
const newRow = generateNewRowForTable(<string>addColumnData._id) const newRow = generateNewRowForTable(<string>addColumnData._id)
const [addRowResponse, addRowData] = await config.rows.add(<string>addColumnData._id, newRow) const [addRowResponse, addRowData] = await config.rows.add(
<string>addColumnData._id,
newRow
)
console.log(addRowData) console.log(addRowData)
expect(addRowResponse).toHaveStatusCode(200) expect(addRowResponse).toHaveStatusCode(200)
expect(addRowData._id).toBeDefined() expect(addRowData._id).toBeDefined()
@ -218,24 +230,32 @@ describe("Internal API - /applications endpoints", () => {
expect(addRowData.tableId).toEqual(addColumnData._id) expect(addRowData.tableId).toEqual(addColumnData._id)
//Get Row from table //Get Row from table
const [getRowResponse, getRowData] = await config.rows.getAll(<string>addColumnData._id) const [getRowResponse, getRowData] = await config.rows.getAll(
<string>addColumnData._id
)
expect(getRowResponse).toHaveStatusCode(200) expect(getRowResponse).toHaveStatusCode(200)
expect(getRowData.length).toEqual(1) expect(getRowData.length).toEqual(1)
//Delete Row from table //Delete Row from table
const rowToDelete = { const rowToDelete = {
rows: [ rows: [getRowData[0]],
getRowData[0]
]
} }
const [deleteRowResponse, deleteRowData] = await config.rows.delete(<string>addColumnData._id, rowToDelete) const [deleteRowResponse, deleteRowData] = await config.rows.delete(
<string>addColumnData._id,
rowToDelete
)
expect(deleteRowResponse).toHaveStatusCode(200) expect(deleteRowResponse).toHaveStatusCode(200)
expect(deleteRowData[0]._id).toEqual(getRowData[0]._id) expect(deleteRowData[0]._id).toEqual(getRowData[0]._id)
//Delete the table //Delete the table
const [deleteTableResponse, deleteTable] = await config.tables.delete(<string>addColumnData._id, <string>addColumnData._rev) const [deleteTableResponse, deleteTable] = await config.tables.delete(
<string>addColumnData._id,
<string>addColumnData._rev
)
expect(deleteTableResponse).toHaveStatusCode(200) expect(deleteTableResponse).toHaveStatusCode(200)
expect(deleteTable.message).toEqual(`Table ${createdTableData._id} deleted.`) expect(deleteTable.message).toEqual(
`Table ${createdTableData._id} deleted.`
)
//Table was deleted //Table was deleted
await config.tables.getAll(2) await config.tables.getAll(2)

View file

@ -5,7 +5,6 @@ import generateApp from "../../../config/internal-api/fixtures/applications"
import { Screen } from "@budibase/types" import { Screen } from "@budibase/types"
import generateScreen from "../../../config/internal-api/fixtures/screens" import generateScreen from "../../../config/internal-api/fixtures/screens"
describe("Internal API - /screens endpoints", () => { describe("Internal API - /screens endpoints", () => {
const api = new InternalAPIClient() const api = new InternalAPIClient()
const config = new TestConfiguration<Screen>(api) const config = new TestConfiguration<Screen>(api)
@ -27,7 +26,9 @@ describe("Internal API - /screens endpoints", () => {
const roleArray = ["BASIC", "POWER", "ADMIN", "PUBLIC"] const roleArray = ["BASIC", "POWER", "ADMIN", "PUBLIC"]
appConfig.applications.api.appId = app.appId appConfig.applications.api.appId = app.appId
for (let role in roleArray) { for (let role in roleArray) {
const [response, screen] = await config.screen.create(generateScreen(roleArray[role])) const [response, screen] = await config.screen.create(
generateScreen(roleArray[role])
)
expect(response).toHaveStatusCode(200) expect(response).toHaveStatusCode(200)
expect(screen.routing.roleId).toEqual(roleArray[role]) expect(screen.routing.roleId).toEqual(roleArray[role])
} }
@ -39,7 +40,9 @@ describe("Internal API - /screens endpoints", () => {
// Create Screen // Create Screen
appConfig.applications.api.appId = app.appId appConfig.applications.api.appId = app.appId
const [response, screen] = await config.screen.create(generateScreen("BASIC")) const [response, screen] = await config.screen.create(
generateScreen("BASIC")
)
// Check screen exists // Check screen exists
const [routesResponse, routes] = await appConfig.applications.getRoutes() const [routesResponse, routes] = await appConfig.applications.getRoutes()
@ -53,7 +56,9 @@ describe("Internal API - /screens endpoints", () => {
// Create Screen // Create Screen
appConfig.applications.api.appId = app.appId appConfig.applications.api.appId = app.appId
const [screenResponse, screen] = await config.screen.create(generateScreen("BASIC")) const [screenResponse, screen] = await config.screen.create(
generateScreen("BASIC")
)
// Delete Screen // Delete Screen
const [response] = await config.screen.delete(screen._id!, screen._rev!) const [response] = await config.screen.delete(screen._id!, screen._rev!)