mirror of
https://github.com/gristlabs/grist-core.git
synced 2026-03-02 04:09:24 +00:00
(core) add an access token mechanism to help with attachments in custom widgets
Summary:
With this, a custom widget can render an attachment by doing:
```
const tokenInfo = await grist.docApi.getAccessToken({readOnly: true});
const img = document.getElementById('the_image');
const id = record.C[0]; // get an id of an attachment
const src = `${tokenInfo.baseUrl}/attachments/${id}/download?auth=${tokenInfo.token}`;
img.setAttribute('src', src)
```
The access token expires after a few mins, so if a user right-clicks on an image
to save it, they may get access denied unless they refresh the page. A little awkward,
but s3 pre-authorized links behave similarly and it generally isn't a deal-breaker.
Test Plan: added tests
Reviewers: dsagal
Reviewed By: dsagal
Subscribers: dsagal
Differential Revision: https://phab.getgrist.com/D3488
This commit is contained in:
@@ -20,7 +20,8 @@
|
||||
|
||||
import { ColumnsToMap, CustomSectionAPI, InteractionOptions, InteractionOptionsRequest,
|
||||
WidgetColumnMap } from './CustomSectionAPI';
|
||||
import { GristAPI, GristDocAPI, GristView, RPC_GRISTAPI_INTERFACE } from './GristAPI';
|
||||
import { AccessTokenOptions, AccessTokenResult, GristAPI, GristDocAPI,
|
||||
GristView, RPC_GRISTAPI_INTERFACE } from './GristAPI';
|
||||
import { RowRecord } from './GristData';
|
||||
import { ImportSource, ImportSourceAPI, InternalImportSourceAPI } from './InternalImportSourceAPI';
|
||||
import { decodeObject, mapValues } from './objtypes';
|
||||
@@ -158,6 +159,14 @@ export function getTable(tableId?: string): TableOperations {
|
||||
}, {});
|
||||
}
|
||||
|
||||
/**
|
||||
* Get an access token, for making API calls outside of the custom widget
|
||||
* API. There is no caching of tokens.
|
||||
*/
|
||||
export async function getAccessToken(options?: AccessTokenOptions): Promise<AccessTokenResult> {
|
||||
return docApi.getAccessToken(options || {});
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the current selected table (for custom widgets).
|
||||
*/
|
||||
|
||||
Reference in New Issue
Block a user