mirror of
https://github.com/optim-enterprises-bv/vault.git
synced 2025-11-01 19:17:58 +00:00
0b12cdcfd1
* Adding explicit MPL license for sub-package. This directory and its subdirectories (packages) contain files licensed with the MPLv2 `LICENSE` file in this directory and are intentionally licensed separately from the BSL `LICENSE` file at the root of this repository. * Adding explicit MPL license for sub-package. This directory and its subdirectories (packages) contain files licensed with the MPLv2 `LICENSE` file in this directory and are intentionally licensed separately from the BSL `LICENSE` file at the root of this repository. * Updating the license from MPL to Business Source License. Going forward, this project will be licensed under the Business Source License v1.1. Please see our blog post for more details at https://hashi.co/bsl-blog, FAQ at www.hashicorp.com/licensing-faq, and details of the license at www.hashicorp.com/bsl. * add missing license headers * Update copyright file headers to BUS-1.1 * Fix test that expected exact offset on hcl file --------- Co-authored-by: hashicorp-copywrite[bot] <110428419+hashicorp-copywrite[bot]@users.noreply.github.com> Co-authored-by: Sarah Thompson <sthompson@hashicorp.com> Co-authored-by: Brian Kassouf <bkassouf@hashicorp.com>
81 lines
2.6 KiB
JavaScript
81 lines
2.6 KiB
JavaScript
/**
|
|
* Copyright (c) HashiCorp, Inc.
|
|
* SPDX-License-Identifier: BUSL-1.1
|
|
*/
|
|
|
|
import Component from '@glimmer/component';
|
|
import { action } from '@ember/object';
|
|
import { inject as service } from '@ember/service';
|
|
import errorMessage from 'vault/utils/error-message';
|
|
import timestamp from 'vault/utils/timestamp';
|
|
import { tracked } from '@glimmer/tracking';
|
|
import { assert } from '@ember/debug';
|
|
/**
|
|
* @module DownloadButton
|
|
* DownloadButton components are an action button used to download data. Both the action text and icon are yielded.
|
|
* * NOTE: when using in an engine, remember to add the 'download' service to its dependencies (in /engine.js) and map to it in /app.js
|
|
* [ember-docs](https://ember-engines.com/docs/services)
|
|
* @example
|
|
* ```js
|
|
* <DownloadButton
|
|
* class="button"
|
|
* @data={{this.data}}
|
|
* @filename={{this.filename}}
|
|
* @mime={{this.mime}}
|
|
* @extension={{this.extension}}
|
|
* @stringify={{true}}
|
|
* >
|
|
* <Icon @name="download" />
|
|
* Download
|
|
* </DownloadButton>
|
|
* ```
|
|
* @param {string} [filename] - name of file that prefixes the ISO timestamp generated at download
|
|
* @param {string} [data] - data to download
|
|
* @param {function} [fetchData] - function that fetches data and returns download content
|
|
* @param {string} [extension='txt'] - file extension, the download service uses this to determine the mimetype
|
|
* @param {boolean} [stringify=false] - argument to stringify the data before passing to the File constructor
|
|
*/
|
|
|
|
export default class DownloadButton extends Component {
|
|
@service download;
|
|
@service flashMessages;
|
|
@tracked fetchedData;
|
|
|
|
constructor() {
|
|
super(...arguments);
|
|
const hasConflictingArgs = this.args.data && this.args.fetchData;
|
|
assert(
|
|
'Only pass either @data or @fetchData, passing both means @data will be overwritten by the return value of @fetchData',
|
|
!hasConflictingArgs
|
|
);
|
|
}
|
|
get filename() {
|
|
const ts = timestamp.now().toISOString();
|
|
return this.args.filename ? this.args.filename + '-' + ts : ts;
|
|
}
|
|
|
|
get content() {
|
|
if (this.args.stringify) {
|
|
return JSON.stringify(this.args.data, null, 2);
|
|
}
|
|
return this.fetchedData || this.args.data;
|
|
}
|
|
|
|
get extension() {
|
|
return this.args.extension || 'txt';
|
|
}
|
|
|
|
@action
|
|
async handleDownload() {
|
|
if (this.args.fetchData) {
|
|
this.fetchedData = await this.args.fetchData();
|
|
}
|
|
try {
|
|
this.download.miscExtension(this.filename, this.content, this.extension);
|
|
this.flashMessages.info(`Downloading ${this.filename}`);
|
|
} catch (error) {
|
|
this.flashMessages.danger(errorMessage(error, 'There was a problem downloading. Please try again.'));
|
|
}
|
|
}
|
|
}
|