@infomaker/printoverview-s3-client-js
v1.1.6
Published
Connect to a printoverview backend over grpc
Downloads
11
Keywords
Readme
Print Overview Service
In a S3 bucket object, previews and thumbs, are structured under an organization for being deliverd to a Dasboard Agent
Background
This service, a lambda, is responsible for deliver preview and thumbs to a dashboard agent.
Auth
For accessing this service, right permissions has to be met.
S3 Structure
This is a Saas solution. Therefore, all previews and thumbs is hosted in the same bucket for all customers. When authenticated, the organization is fetched from the token. From the organization there is a corresponding bucket. Within that bucket there can be a underlying structure with products. Each "folder" is a product that should be returned when asked for. Under each product is another "folder" with publication dates. In each "folder" with publicationdates is a metadatafile describing the publication.
Methods
Consume data
GetProducts()
GetPublicationDates(product)
GetData(product, publicationdate)
Produce data
CreateDataUpload(product, date, metadata)
SetPublicationUploaded()
SetPublicationUpdated()
Metadatafile
Metadatafile for a publication
{
"group": [
{
"name": "Product 1, Part 1, Edition 1",
"pages": [
{
"name": "2002-03-28-GT-ED1-01",
"hasFiles": true,
"fileExt": ".jpg",
"previewFile": "preview1.jpg",
"thumbFile": "thumb1.jpg",
"pageInfo": {"status": "1"}
},
{
"name": "2002-03-28-GT-ED1-02",
"hasFiles": true,
"fileExt": ".jpg",
"previewFile": "preview2.jpg",
"thumbFile": "thumb2.jpg",
"pageInfo": {"status": "1"}
}
]
},
{
"name": "Product 1, Part 1, Edition 2",
"pages": [
{
"name": "2002-03-28-GT-ED2-01",
"hasFiles": true,
"fileExt": ".jpg",
"previewFile": "preview3.jpg",
"thumbFile": "thumb3.jpg",
"pageInfo": {"status": "1"}
}
]
}
]
}
CLI Client
There is a CLI client printoverview-s3-client which can be downloaded via brew:
$ brew tap infomaker/core
$ brew install infomaker/core/printoverview-s3-client