CAP STORAGE AWS

Table of Contents

• Requirements
• Installation
• Implementation into a module
• Configuration AWS S3
• Tags
• Inputs
• Services

CAP STORAGE AWS is a module for Angular, with this module you can upload images to AWS S3.

Requirements

CAP STORAGE AWS use bootstrap's classes. To be able to display the component in the right way, bootstrap should have been installed in the project. In case you don't have bootstrap installed, you can run the following command or read their documentation:

npm install bootstrap

One's that you installed bootstrap you have to configure the angular.json and write into styles

"styles": [
  "node_modules/bootstrap/dist/css/bootstrap.min.css",
  "styles.scss"
]

Important!

Before to install the dependency you should have the following script into the polyfills.ts file:

(window as any).global = window;

After that you may encounter compilation issues when using the typings provided by the SDK in an Angular project created using the Angular CLI.

To resolve these issues, either add "types": ["node"] to the project's tsconfig.app.json file, or remove the "types" field entirely.

Installation

write the following command:

npm install cap-storage-aws

Use

To use this module go-to the app module and into the sections' import and put the AWS module.

import { CapStorageAWS } from 'cap-storage-aws';

After that, add into modules' array with your credentials. Example:

CapStorageAWS.forRoot({
    bucket: 'your-bocket',
    accessKeyId: 'your-accessKeyID',
    secretAccessKey: 'your-secretAccessKey',
    region: 'your-region',
    folder: 'your-folder',
    endpoint: 'endpoint' 
})

Note

The endopoint it's optional, if you don't want to save the data into a DB it's not need it into the forRoot.

Configuration

We recommend creating a specific folder into your bucket for save your images. In your bucket go the section of permissions, after that, go to CORS configuration and write the following code:

<?xml version="1.0" encoding="UTF-8"?>
<CORSConfiguration xmlns="http://s3.amazonaws.com/doc/2006-03-01/">
<CORSRule>
    <AllowedOrigin>*</AllowedOrigin>
    <AllowedMethod>HEAD</AllowedMethod>
    <AllowedMethod>GET</AllowedMethod>
    <AllowedMethod>POST</AllowedMethod>
    <ExposeHeader>ETag</ExposeHeader>
    <ExposeHeader>x-amz-meta-custom-header</ExposeHeader>
    <AllowedHeader>*</AllowedHeader>
</CORSRule>
</CORSConfiguration>

Tags

Cap Upload

Tag to upload images into an Amazon bucket.

Example of implementation

<cap-upload></cap-upload>

Cap Upload Drag and Drop

This tag use an external dependency called ngx-file-drop. Tag to upload any kind of file Example of implementation

<cap-upload-drag-drop></cap-upload-drag-drop>

Inputs

fields | Param | Description | | --- | --- | | name | It's the name of the field that makes reference on your DB.| | association | It's the reference of the data exposed for the module, it could be id, name or url. In case that you don't want an assosiation with data exposed you could use none.| | value | Value or the field that has 'none' association.|

Structure:

[
  {
    name: string;
    association: string;
    value?: any;
  }
]

Example

app.component.html

<cap-upload [fields]="dbFields"></cap-upload>

<cap-upload-drag-drop [fields]="dbFields"></cap-upload-drag-drop>

app.component.ts

let aux: IDbFields[] = [
      {
        name: 'SACAP__UUID__c',
        association: 'id'
      },
      {
        name: 'SACAP__URL__c',
        association: 'url',
      },
      {
        name: 'SACAP__Name__c',
        association: 'name',
      },
      {
        name: 'SACAP__CAP_User__c__SACAP__UUID__c',
        association: 'none',
        value: '12'
      },
    ]
    this.dbFields = [...aux]

token | Param | Description | | --- | --- | | token | Recives the token to make the http request.|

Example

app.component.html

<cap-upload [token]="token"></cap-upload>

<cap-upload-drag-drop [token]="token"></cap-upload-drag-drop>

localStorageRef | Param | Description | | --- | --- | | key | Object name's that has the credentials saved into the localStorage.| | reference | Property name's that makes reference to the token.|

Structure:

{
  key: string;
  reference: string;
}

Example

app.component.html

<cap-upload [localStorageRef]="localStorage"></cap-upload>

<cap-upload-drag-drop [localStorageRef]="localStorage"></cap-upload-drag-drop>

app.component.ts

localStorage: ILocalStorage = {
    key: 'User',
    reference: 'token'
};

Services

This module contains a storage service, this services expose a method to upload images and get the images of the bucket. Method getFiles Example to get images

import { StorageService } from 'cap-storage-aws/src/services/storage.service';

constructor( private _fileUpload: StorageService ) {
        this.showFiles()
    }
    ngOnInit() {}

    getFiles(){
        this.images = this._fileUpload.getFiles();
    }

Method upload The upload method receives 2 parameters: A file(image) to upload and a callback, this callback it's for the event On for know when the image upload it's complete.

upload(file:any, fn:any){

}