appsheet-to-nuxt-content
Save contents from AppSheet for use within nuxt-content.
AppSheet settings
Enable API
- Open "Manage" / "Integrations" / "IN: from cloud services to your app"
- Turn on "Enable"
- Generate access key by "Create Application Access Key"
refer:
Image
(It require when using image)
- Open "Security" / "Options"
- Turn off "Require Image and File URL Signing"
Following setting has requrire when no --image-url flag.
- Add virtual column that contained the image URL
refer: Displaying Images and Documents | AppSheet Help Center
Local settings
Column map
mapconfig.json(sample)
{
"cols":[
{
"srcName": "タイトル",
"dstName": "title",
"colType": "string"
},
{
"srcName": "画像",
"dstName": "image",
"colType": "image"
}
]
}Env variables
sample
SHEET2CONTENT_API_BASE_URL=https://api.appsheet.com/api/v2/
SHEET2CONTENT_APP_ID=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx
SHEET2CONTENT_MAP_COLS=path/to/mapcols.json
SHEET2CONTENT_ACCESS_KEY=xx-xxxxx-xxxxx-xxxxx-xxxxx-xxxxx-xxxxx-xxxxx-xxxxx
Following variable has requrire when use --image-url flag.
SHEET2CONTENT_APP_NAME=<app name>-xxxxxxx
Save contents
npx --package=@hankei6km/appsheet-to-nuxt-content -c \
'sheet2content save <table name> <contents dir> <iamges dir>'API
client(apiBaseURL, appId, appName, accessKey)
Return client instance for AppSheet.
apiBaseURL
Base URL to API endpoint.
appId
App Id to API endpoint.
appName
App Name to image adapter endpoint(It used to generate the Image URL).
accessKey
Access key to get contents.
returns
Client
saveRemoteContents(saveRemoteOptions)
Save remote contens.
saveRemoteOptions.client
AppSheet client.
tableName
Table name to save contents.
saveRemoteOptions.mapCols
Colmuns map.
saveRemoteOptions.dstContentDir
directory to save contents.
saveRemoteOptions.dstImagesDir
directory to save images.
saveRemoteOptions.staticRoot
root of static path to trim image path.
saveRemoteOptions.imageInfo
extract information of image(size, meta).
saveRemoteOptions.imageURL
generate image url from rel path to fetch image filee.
returns
Promise<Error | null>
Known Issues
- Partial downaload is not supported
License
MIT License
Copyright (c) 2021 hankei6km