@rails/activestorage 7.0.8 → 7.1.0-beta1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md
CHANGED
|
@@ -6,11 +6,11 @@ Files can be uploaded from the server to the cloud or directly from the client t
|
|
|
6
6
|
|
|
7
7
|
Image files can furthermore be transformed using on-demand variants for quality, aspect ratio, size, or any other [MiniMagick](https://github.com/minimagick/minimagick) or [Vips](https://www.rubydoc.info/gems/ruby-vips/Vips/Image) supported transformation.
|
|
8
8
|
|
|
9
|
-
You can read more about Active Storage in the [Active Storage Overview](https://
|
|
9
|
+
You can read more about Active Storage in the [Active Storage Overview](https://guides.rubyonrails.org/active_storage_overview.html) guide.
|
|
10
10
|
|
|
11
11
|
## Compared to other storage solutions
|
|
12
12
|
|
|
13
|
-
A key difference to how Active Storage works compared to other attachment solutions in Rails is through the use of built-in [Blob](https://github.com/rails/rails/blob/main/activestorage/app/models/active_storage/blob.rb) and [Attachment](https://github.com/rails/rails/blob/main/activestorage/app/models/active_storage/attachment.rb) models (backed by Active Record). This means existing application models do not need to be modified with additional columns to associate with files. Active Storage uses polymorphic associations via the `Attachment` join model, which then connects to the actual `Blob`.
|
|
13
|
+
A key difference to how Active Storage works compared to other attachment solutions in \Rails is through the use of built-in [Blob](https://github.com/rails/rails/blob/main/activestorage/app/models/active_storage/blob.rb) and [Attachment](https://github.com/rails/rails/blob/main/activestorage/app/models/active_storage/attachment.rb) models (backed by Active Record). This means existing application models do not need to be modified with additional columns to associate with files. Active Storage uses polymorphic associations via the `Attachment` join model, which then connects to the actual `Blob`.
|
|
14
14
|
|
|
15
15
|
`Blob` models store attachment metadata (filename, content-type, etc.), and their identifier key in the storage service. Blob models do not store the actual binary data. They are intended to be immutable in spirit. One file, one blob. You can associate the same blob with multiple application models as well. And if you want to do transformations of a given `Blob`, the idea is that you'll simply create a new one, rather than attempt to mutate the existing one (though of course you can delete the previous version later if you don't need it).
|
|
16
16
|
|
|
@@ -144,11 +144,11 @@ Active Storage, with its included JavaScript library, supports uploading directl
|
|
|
144
144
|
|
|
145
145
|
1. Include the Active Storage JavaScript in your application's JavaScript bundle or reference it directly.
|
|
146
146
|
|
|
147
|
-
Requiring directly without bundling through the asset pipeline in the application
|
|
147
|
+
Requiring directly without bundling through the asset pipeline in the application HTML with autostart:
|
|
148
148
|
```html
|
|
149
149
|
<%= javascript_include_tag "activestorage" %>
|
|
150
150
|
```
|
|
151
|
-
Requiring via importmap-rails without bundling through the asset pipeline in the application
|
|
151
|
+
Requiring via importmap-rails without bundling through the asset pipeline in the application HTML without autostart as ESM:
|
|
152
152
|
```ruby
|
|
153
153
|
# config/importmap.rb
|
|
154
154
|
pin "@rails/activestorage", to: "activestorage.esm.js"
|
|
@@ -508,7 +508,7 @@ function toArray(value) {
|
|
|
508
508
|
}
|
|
509
509
|
|
|
510
510
|
class BlobRecord {
|
|
511
|
-
constructor(file, checksum, url) {
|
|
511
|
+
constructor(file, checksum, url, customHeaders = {}) {
|
|
512
512
|
this.file = file;
|
|
513
513
|
this.attributes = {
|
|
514
514
|
filename: file.name,
|
|
@@ -522,6 +522,9 @@ class BlobRecord {
|
|
|
522
522
|
this.xhr.setRequestHeader("Content-Type", "application/json");
|
|
523
523
|
this.xhr.setRequestHeader("Accept", "application/json");
|
|
524
524
|
this.xhr.setRequestHeader("X-Requested-With", "XMLHttpRequest");
|
|
525
|
+
Object.keys(customHeaders).forEach((headerKey => {
|
|
526
|
+
this.xhr.setRequestHeader(headerKey, customHeaders[headerKey]);
|
|
527
|
+
}));
|
|
525
528
|
const csrfToken = getMetaValue("csrf-token");
|
|
526
529
|
if (csrfToken != undefined) {
|
|
527
530
|
this.xhr.setRequestHeader("X-CSRF-Token", csrfToken);
|
|
@@ -604,11 +607,12 @@ class BlobUpload {
|
|
|
604
607
|
let id = 0;
|
|
605
608
|
|
|
606
609
|
class DirectUpload {
|
|
607
|
-
constructor(file, url, delegate) {
|
|
610
|
+
constructor(file, url, delegate, customHeaders = {}) {
|
|
608
611
|
this.id = ++id;
|
|
609
612
|
this.file = file;
|
|
610
613
|
this.url = url;
|
|
611
614
|
this.delegate = delegate;
|
|
615
|
+
this.customHeaders = customHeaders;
|
|
612
616
|
}
|
|
613
617
|
create(callback) {
|
|
614
618
|
FileChecksum.create(this.file, ((error, checksum) => {
|
|
@@ -616,7 +620,7 @@ class DirectUpload {
|
|
|
616
620
|
callback(error);
|
|
617
621
|
return;
|
|
618
622
|
}
|
|
619
|
-
const blob = new BlobRecord(this.file, checksum, this.url);
|
|
623
|
+
const blob = new BlobRecord(this.file, checksum, this.url, this.customHeaders);
|
|
620
624
|
notify(this.delegate, "directUploadWillCreateBlobWithXHR", blob.xhr);
|
|
621
625
|
blob.create((error => {
|
|
622
626
|
if (error) {
|
|
@@ -841,4 +845,4 @@ function autostart() {
|
|
|
841
845
|
|
|
842
846
|
setTimeout(autostart, 1);
|
|
843
847
|
|
|
844
|
-
export { DirectUpload, start };
|
|
848
|
+
export { DirectUpload, DirectUploadController, DirectUploadsController, start };
|
|
@@ -503,7 +503,7 @@
|
|
|
503
503
|
}
|
|
504
504
|
}
|
|
505
505
|
class BlobRecord {
|
|
506
|
-
constructor(file, checksum, url) {
|
|
506
|
+
constructor(file, checksum, url, customHeaders = {}) {
|
|
507
507
|
this.file = file;
|
|
508
508
|
this.attributes = {
|
|
509
509
|
filename: file.name,
|
|
@@ -517,6 +517,9 @@
|
|
|
517
517
|
this.xhr.setRequestHeader("Content-Type", "application/json");
|
|
518
518
|
this.xhr.setRequestHeader("Accept", "application/json");
|
|
519
519
|
this.xhr.setRequestHeader("X-Requested-With", "XMLHttpRequest");
|
|
520
|
+
Object.keys(customHeaders).forEach((headerKey => {
|
|
521
|
+
this.xhr.setRequestHeader(headerKey, customHeaders[headerKey]);
|
|
522
|
+
}));
|
|
520
523
|
const csrfToken = getMetaValue("csrf-token");
|
|
521
524
|
if (csrfToken != undefined) {
|
|
522
525
|
this.xhr.setRequestHeader("X-CSRF-Token", csrfToken);
|
|
@@ -596,11 +599,12 @@
|
|
|
596
599
|
}
|
|
597
600
|
let id = 0;
|
|
598
601
|
class DirectUpload {
|
|
599
|
-
constructor(file, url, delegate) {
|
|
602
|
+
constructor(file, url, delegate, customHeaders = {}) {
|
|
600
603
|
this.id = ++id;
|
|
601
604
|
this.file = file;
|
|
602
605
|
this.url = url;
|
|
603
606
|
this.delegate = delegate;
|
|
607
|
+
this.customHeaders = customHeaders;
|
|
604
608
|
}
|
|
605
609
|
create(callback) {
|
|
606
610
|
FileChecksum.create(this.file, ((error, checksum) => {
|
|
@@ -608,7 +612,7 @@
|
|
|
608
612
|
callback(error);
|
|
609
613
|
return;
|
|
610
614
|
}
|
|
611
|
-
const blob = new BlobRecord(this.file, checksum, this.url);
|
|
615
|
+
const blob = new BlobRecord(this.file, checksum, this.url, this.customHeaders);
|
|
612
616
|
notify(this.delegate, "directUploadWillCreateBlobWithXHR", blob.xhr);
|
|
613
617
|
blob.create((error => {
|
|
614
618
|
if (error) {
|
|
@@ -816,6 +820,8 @@
|
|
|
816
820
|
}
|
|
817
821
|
setTimeout(autostart, 1);
|
|
818
822
|
exports.DirectUpload = DirectUpload;
|
|
823
|
+
exports.DirectUploadController = DirectUploadController;
|
|
824
|
+
exports.DirectUploadsController = DirectUploadsController;
|
|
819
825
|
exports.start = start;
|
|
820
826
|
Object.defineProperty(exports, "__esModule", {
|
|
821
827
|
value: true
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@rails/activestorage",
|
|
3
|
-
"version": "7.0
|
|
3
|
+
"version": "7.1.0-beta1",
|
|
4
4
|
"description": "Attach cloud and local files in Rails applications",
|
|
5
5
|
"module": "app/assets/javascripts/activestorage.esm.js",
|
|
6
6
|
"main": "app/assets/javascripts/activestorage.js",
|
package/src/blob_record.js
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { getMetaValue } from "./helpers"
|
|
2
2
|
|
|
3
3
|
export class BlobRecord {
|
|
4
|
-
constructor(file, checksum, url) {
|
|
4
|
+
constructor(file, checksum, url, customHeaders = {}) {
|
|
5
5
|
this.file = file
|
|
6
6
|
|
|
7
7
|
this.attributes = {
|
|
@@ -17,6 +17,9 @@ export class BlobRecord {
|
|
|
17
17
|
this.xhr.setRequestHeader("Content-Type", "application/json")
|
|
18
18
|
this.xhr.setRequestHeader("Accept", "application/json")
|
|
19
19
|
this.xhr.setRequestHeader("X-Requested-With", "XMLHttpRequest")
|
|
20
|
+
Object.keys(customHeaders).forEach((headerKey) => {
|
|
21
|
+
this.xhr.setRequestHeader(headerKey, customHeaders[headerKey])
|
|
22
|
+
})
|
|
20
23
|
|
|
21
24
|
const csrfToken = getMetaValue("csrf-token")
|
|
22
25
|
if (csrfToken != undefined) {
|
package/src/direct_upload.js
CHANGED
|
@@ -5,11 +5,12 @@ import { BlobUpload } from "./blob_upload"
|
|
|
5
5
|
let id = 0
|
|
6
6
|
|
|
7
7
|
export class DirectUpload {
|
|
8
|
-
constructor(file, url, delegate) {
|
|
8
|
+
constructor(file, url, delegate, customHeaders = {}) {
|
|
9
9
|
this.id = ++id
|
|
10
10
|
this.file = file
|
|
11
11
|
this.url = url
|
|
12
12
|
this.delegate = delegate
|
|
13
|
+
this.customHeaders = customHeaders
|
|
13
14
|
}
|
|
14
15
|
|
|
15
16
|
create(callback) {
|
|
@@ -19,7 +20,7 @@ export class DirectUpload {
|
|
|
19
20
|
return
|
|
20
21
|
}
|
|
21
22
|
|
|
22
|
-
const blob = new BlobRecord(this.file, checksum, this.url)
|
|
23
|
+
const blob = new BlobRecord(this.file, checksum, this.url, this.customHeaders)
|
|
23
24
|
notify(this.delegate, "directUploadWillCreateBlobWithXHR", blob.xhr)
|
|
24
25
|
|
|
25
26
|
blob.create(error => {
|
package/src/index.js
CHANGED
|
@@ -1,6 +1,8 @@
|
|
|
1
1
|
import { start } from "./ujs"
|
|
2
2
|
import { DirectUpload } from "./direct_upload"
|
|
3
|
-
|
|
3
|
+
import { DirectUploadController } from "./direct_upload_controller"
|
|
4
|
+
import { DirectUploadsController } from "./direct_uploads_controller"
|
|
5
|
+
export { start, DirectUpload, DirectUploadController, DirectUploadsController }
|
|
4
6
|
|
|
5
7
|
function autostart() {
|
|
6
8
|
if (window.ActiveStorage) {
|