/
file.ts
198 lines (171 loc) · 5.32 KB
/
file.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
/*
* Copyright (c) 2018 by Filestack.
* Some rights reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { Security, Session } from '../client';
import { request } from './request';
import { removeEmpty } from '../utils';
import { FilestackError } from './../../filestack_error';
import { getValidator, MetadataParamsSchema, RetrieveParamsSchema } from './../../schema';
/**
* Remove given file
*
* @private
* @param session
* @param handle
* @param security
*/
export const remove = (session: Session, handle?: string, skipStorage?: boolean, security?: Security): Promise<any> => {
if (!handle || typeof handle !== 'string') {
throw new FilestackError('A valid Filestack handle is required for remove');
}
if (!(session.policy && session.signature) && (!security || !(security.policy && security.signature))) {
throw new FilestackError('Security policy and signature are required for remove');
}
const fileApiUrl = session.urls.fileApiUrl;
const baseURL = `${fileApiUrl}/${handle}`;
const options: any = {
key: session.apikey,
policy: (security && security.policy) || session.policy,
signature: (security && security.signature) || session.signature,
};
if (skipStorage) {
options.skip_storage = true;
}
return request.delete(baseURL, {
params: removeEmpty(options),
});
};
export interface MetadataOptions {
size?: boolean;
mimetype?: boolean;
filename?: boolean;
width?: boolean;
height?: boolean;
uploaded?: boolean;
writeable?: boolean;
cloud?: boolean;
sourceUrl?: boolean;
md5?: boolean;
sha1?: boolean;
sha224?: boolean;
sha256?: boolean;
sha384?: boolean;
sha512?: boolean;
location?: boolean;
path?: boolean;
container?: boolean;
exif?: boolean;
}
/**
* Returns file metadata
*
* @private
* @param session
* @param handle
* @param opts
* @param security
*/
export const metadata = (session: Session, handle?: string, opts?: MetadataOptions, security?: Security): Promise<any> => {
if (!handle || typeof handle !== 'string') {
throw new FilestackError('A valid Filestack handle is required for metadata');
}
const validateRes = getValidator(MetadataParamsSchema)(opts);
if (validateRes.errors.length) {
throw new FilestackError(`Invalid metadata params`, validateRes.errors);
}
const options: any = { ...opts };
options.source_url = options.sourceUrl; // source_url is snake_case
options.policy = (security && security.policy) || session.policy;
options.signature = (security && security.signature) || session.signature;
const baseURL = `${session.urls.fileApiUrl}/${handle}/metadata`;
return new Promise((resolve, reject) => {
request
.get(baseURL, { params: removeEmpty(options) })
.then(res => resolve({ ...res.data, handle }))
.catch(reject);
});
};
/**
* @private
*/
enum ERequestMethod {
get = 'get',
head = 'head',
}
/**
* @private
*/
enum EResponseType {
blob = 'blob',
json = 'json',
}
export interface RetrieveOptions {
metadata?: boolean;
head?: boolean;
dl?: boolean;
extension?: string;
cache?: boolean;
}
/**
* Returns file information
*
* @private
* @param session
* @param handle
* @param options
* @param security
*/
export const retrieve = (session: Session, handle: string, options: RetrieveOptions = {}, security?: Security): Promise<Object | Blob> => {
if (!handle || handle.length === 0 || typeof handle !== 'string') {
throw new FilestackError('File handle is required');
}
const validateRes = getValidator(RetrieveParamsSchema)(options);
if (validateRes.errors.length) {
throw new FilestackError(`Invalid retrieve params`, validateRes.errors);
}
const requestOptions: any = { ...options };
requestOptions.key = session.apikey;
requestOptions.policy = (security && security.policy) || session.policy;
requestOptions.signature = (security && security.signature) || session.signature;
let method: ERequestMethod = ERequestMethod.get;
if (requestOptions.head) {
method = ERequestMethod.head;
delete requestOptions.head;
}
let extension;
if (requestOptions.extension && requestOptions.extension.length) {
extension = requestOptions.extension;
delete requestOptions.extension;
}
let metadata;
if (requestOptions.metadata) {
if (method === ERequestMethod.head) {
throw new FilestackError('Head and metadata options cannot be used together');
}
metadata = requestOptions.metadata;
delete requestOptions.metadata;
}
const baseURL = `${session.urls.fileApiUrl}/${handle}` + (extension ? `+${extension}` : '') + (metadata ? '/metadata' : '');
return new Promise((resolve, reject) => {
request({
url: baseURL,
method,
params: removeEmpty(requestOptions),
})
.then(res => resolve(method === ERequestMethod.head ? res.headers : res.data))
.catch(reject);
});
};