@cumulus/api-client 13.4.0 → 14.1.0
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/granules.d.ts +12 -10
- package/granules.d.ts.map +1 -1
- package/granules.js +13 -11
- package/granules.js.map +1 -1
- package/package.json +5 -5
- package/src/granules.ts +17 -15
- package/src/types.ts +1 -1
- package/tsconfig.tsbuildinfo +1 -1
- package/types.d.ts +1 -1
- package/types.d.ts.map +1 -1
package/granules.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import pRetry from 'p-retry';
|
|
2
|
-
import {
|
|
2
|
+
import { ApiGranuleRecord, GranuleId, GranuleStatus } from '@cumulus/types/api/granules';
|
|
3
3
|
import { ApiGatewayLambdaHttpProxyResponse, InvokeApiFunction } from './types';
|
|
4
4
|
declare type AssociateExecutionRequest = {
|
|
5
5
|
granuleId: string;
|
|
@@ -47,7 +47,7 @@ export declare const getGranule: (params: {
|
|
|
47
47
|
[key: string]: string;
|
|
48
48
|
} | undefined;
|
|
49
49
|
callback?: InvokeApiFunction | undefined;
|
|
50
|
-
}) => Promise<
|
|
50
|
+
}) => Promise<ApiGranuleRecord>;
|
|
51
51
|
/**
|
|
52
52
|
* Wait for a granule to be present in the database (using pRetry)
|
|
53
53
|
*
|
|
@@ -69,7 +69,7 @@ export declare const waitForGranule: (params: {
|
|
|
69
69
|
}) => Promise<void>;
|
|
70
70
|
/**
|
|
71
71
|
* Reingest a granule from the Cumulus API
|
|
72
|
-
*
|
|
72
|
+
* PATCH /granules/{}
|
|
73
73
|
*
|
|
74
74
|
* @param {Object} params - params
|
|
75
75
|
* @param {string} params.prefix - the prefix configured for the stack
|
|
@@ -91,7 +91,7 @@ export declare const reingestGranule: (params: {
|
|
|
91
91
|
}) => Promise<ApiGatewayLambdaHttpProxyResponse>;
|
|
92
92
|
/**
|
|
93
93
|
* Removes a granule from CMR via the Cumulus API
|
|
94
|
-
*
|
|
94
|
+
* PATCH /granules/{granuleId}
|
|
95
95
|
*
|
|
96
96
|
* @param {Object} params - params
|
|
97
97
|
* @param {string} params.prefix - the prefix configured for the stack
|
|
@@ -109,7 +109,7 @@ export declare const removeFromCMR: (params: {
|
|
|
109
109
|
}) => Promise<ApiGatewayLambdaHttpProxyResponse>;
|
|
110
110
|
/**
|
|
111
111
|
* Run a workflow with the given granule as the payload
|
|
112
|
-
*
|
|
112
|
+
* PATCH /granules/{granuleId}
|
|
113
113
|
*
|
|
114
114
|
* @param {Object} params - params
|
|
115
115
|
* @param {string} params.prefix - the prefix configured for the stack
|
|
@@ -150,7 +150,7 @@ export declare const deleteGranule: (params: {
|
|
|
150
150
|
}) => Promise<ApiGatewayLambdaHttpProxyResponse>;
|
|
151
151
|
/**
|
|
152
152
|
* Move a granule via the API
|
|
153
|
-
*
|
|
153
|
+
* PATCH /granules/{granuleId}
|
|
154
154
|
*
|
|
155
155
|
* @param {Object} params - params
|
|
156
156
|
* @param {string} params.prefix - the prefix configured for the stack
|
|
@@ -217,12 +217,14 @@ export declare const listGranules: (params: {
|
|
|
217
217
|
*/
|
|
218
218
|
export declare const createGranule: (params: {
|
|
219
219
|
prefix: string;
|
|
220
|
-
body:
|
|
220
|
+
body: ApiGranuleRecord;
|
|
221
221
|
callback?: InvokeApiFunction;
|
|
222
222
|
}) => Promise<ApiGatewayLambdaHttpProxyResponse>;
|
|
223
223
|
/**
|
|
224
|
-
* Update granule in cumulus.
|
|
225
|
-
*
|
|
224
|
+
* Update granule in cumulus via PATCH request. Existing values will
|
|
225
|
+
* not be overwritten if not specified, null values will be removed and in
|
|
226
|
+
* some cases replaced with defaults.
|
|
227
|
+
* PATCH /granules/{granuleId}
|
|
226
228
|
* @param {Object} params - params
|
|
227
229
|
* @param {Object} [params.body] - granule to pass the API lambda
|
|
228
230
|
* @param {Function} params.callback - async function to invoke the api lambda
|
|
@@ -233,7 +235,7 @@ export declare const createGranule: (params: {
|
|
|
233
235
|
*/
|
|
234
236
|
export declare const updateGranule: (params: {
|
|
235
237
|
prefix: string;
|
|
236
|
-
body:
|
|
238
|
+
body: ApiGranuleRecord;
|
|
237
239
|
callback?: InvokeApiFunction;
|
|
238
240
|
}) => Promise<ApiGatewayLambdaHttpProxyResponse>;
|
|
239
241
|
/**
|
package/granules.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"granules.d.ts","sourceRoot":"","sources":["src/granules.ts"],"names":[],"mappings":"AAAA,OAAO,MAAM,MAAM,SAAS,CAAC;AAE7B,OAAO,EAAE,
|
|
1
|
+
{"version":3,"file":"granules.d.ts","sourceRoot":"","sources":["src/granules.ts"],"names":[],"mappings":"AAAA,OAAO,MAAM,MAAM,SAAS,CAAC;AAE7B,OAAO,EAAE,gBAAgB,EAAE,SAAS,EAAE,aAAa,EAAE,MAAM,6BAA6B,CAAC;AAIzF,OAAO,EAAE,iCAAiC,EAAE,iBAAiB,EAAE,MAAM,SAAS,CAAC;AAI/E,aAAK,yBAAyB,GAAG;IAC/B,SAAS,EAAE,MAAM,CAAA;IACjB,YAAY,EAAE,MAAM,CAAA;IACpB,YAAY,EAAE,MAAM,CAAA;CACrB,CAAC;AAEF;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,kBAAkB;YACrB,MAAM;eACH,SAAS;;;;;MAGlB,QAAQ,iCAAiC,CAiB5C,CAAC;AAEF;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,UAAU;YACb,MAAM;eACH,SAAS;;;;;MAGlB,QAAQ,gBAAgB,CAG3B,CAAC;AAEF;;;;;;;;;;GAUG;AACH,eAAO,MAAM,cAAc,WAAkB;IAC3C,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,SAAS,CAAC;IACrB,MAAM,CAAC,EAAE,aAAa,CAAC;IACvB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,aAAa,CAAC,EAAE,OAAO,OAAO,CAAC;IAC/B,QAAQ,CAAC,EAAE,iBAAiB,CAAA;CAC7B,kBAwCA,CAAC;AAEF;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,eAAe,WAAkB;IAC5C,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,SAAS,CAAC;IACrB,YAAY,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAClC,YAAY,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAClC,QAAQ,CAAC,EAAE,iBAAiB,CAAA;CAC7B,KAAG,QAAQ,iCAAiC,CAmB5C,CAAC;AAEF;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,aAAa,WAAkB;IAC1C,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,SAAS,CAAC;IACrB,QAAQ,CAAC,EAAE,iBAAiB,CAAA;CAC7B,KAAG,QAAQ,iCAAiC,CAe5C,CAAC;AAEF;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,aAAa,WAAkB;IAC1C,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,SAAS,CAAC;IACrB,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,iBAAiB,CAAA;CAC7B,KAAG,QAAQ,iCAAiC,CAqB5C,CAAC;AAEF;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,aAAa,WAAkB;IAC1C,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,SAAS,CAAC;IACrB,aAAa,CAAC,EAAE,OAAO,OAAO,CAAC;IAC/B,QAAQ,CAAC,EAAE,iBAAiB,CAAA;CAC7B,KAAG,QAAQ,iCAAiC,CAgB5C,CAAC;AAEF;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,WAAW,WAAkB;IACxC,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,SAAS,CAAC;IACrB,YAAY,EAAE,OAAO,EAAE,CAAC;IACxB,QAAQ,CAAC,EAAE,iBAAiB,CAAA;CAC7B,KAAG,QAAQ,iCAAiC,CAoB5C,CAAC;AAEF;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,sBAAsB,WAAkB;IACnD,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,SAAS,CAAC;IACrB,QAAQ,CAAC,EAAE,iBAAiB,CAAA;CAC7B,KAAG,QAAQ,iCAAiC,CAM5C,CAAC;AAEF;;;;;;;;;;GAUG;AACH,eAAO,MAAM,YAAY;YACf,MAAM;;;;;;MAMZ,QAAQ,iCAAiC,CAY5C,CAAC;AAEF;;;;;;;;;;GAUG;AACH,eAAO,MAAM,aAAa,WAAkB;IAC1C,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,gBAAgB,CAAC;IACvB,QAAQ,CAAC,EAAE,iBAAiB,CAAA;CAC7B,KAAG,QAAQ,iCAAiC,CAa5C,CAAC;AAEF;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,aAAa,WAAkB;IAC1C,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,gBAAgB,CAAC;IACvB,QAAQ,CAAC,EAAE,iBAAiB,CAAA;CAC7B,KAAG,QAAQ,iCAAiC,CAc5C,CAAC;AAEF;;;;;;;;;;GAUG;AACH,eAAO,MAAM,6BAA6B,WAAkB;IAC1D,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,yBAAyB,CAAC;IAChC,QAAQ,CAAC,EAAE,iBAAiB,CAAA;CAC7B,KAAG,QAAQ,iCAAiC,CAa5C,CAAC;AAEF;;;;;;;;;;GAUG;AACH,eAAO,MAAM,YAAY,WAAkB;IACzC,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,CAAC,EAAE,iBAAiB,CAAA;CAC7B,KAAG,QAAQ,iCAAiC,CAgB5C,CAAC;AAEF;;;;;;;;;;GAUG;AACH,eAAO,MAAM,kBAAkB,WAAkB;IAC/C,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,OAAO,CAAC;IACd,QAAQ,CAAC,EAAE,iBAAiB,CAAA;CAC7B,KAAG,QAAQ,iCAAiC,CAgB5C,CAAC;AAEF,eAAO,MAAM,oBAAoB,WAAkB;IACjD,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,OAAO,CAAC;IACd,QAAQ,CAAC,EAAE,iBAAiB,CAAA;CAC7B,KAAG,QAAQ,iCAAiC,CAgB5C,CAAC;AAEF;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,aAAa,WAAkB;IAC1C,MAAM,EAAE,MAAM,CAAC;IACf,GAAG,EAAE,MAAM,EAAE,CAAC;IACd,YAAY,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,EAAE,iBAAiB,CAAA;CAC7B,KAAG,QAAQ,iCAAiC,CAe5C,CAAC"}
|
package/granules.js
CHANGED
|
@@ -91,7 +91,7 @@ const waitForGranule = async (params) => {
|
|
|
91
91
|
exports.waitForGranule = waitForGranule;
|
|
92
92
|
/**
|
|
93
93
|
* Reingest a granule from the Cumulus API
|
|
94
|
-
*
|
|
94
|
+
* PATCH /granules/{}
|
|
95
95
|
*
|
|
96
96
|
* @param {Object} params - params
|
|
97
97
|
* @param {string} params.prefix - the prefix configured for the stack
|
|
@@ -109,7 +109,7 @@ const reingestGranule = async (params) => {
|
|
|
109
109
|
return await callback({
|
|
110
110
|
prefix: prefix,
|
|
111
111
|
payload: {
|
|
112
|
-
httpMethod: '
|
|
112
|
+
httpMethod: 'PATCH',
|
|
113
113
|
resource: '/{proxy+}',
|
|
114
114
|
path: `/granules/${granuleId}`,
|
|
115
115
|
headers: {
|
|
@@ -126,7 +126,7 @@ const reingestGranule = async (params) => {
|
|
|
126
126
|
exports.reingestGranule = reingestGranule;
|
|
127
127
|
/**
|
|
128
128
|
* Removes a granule from CMR via the Cumulus API
|
|
129
|
-
*
|
|
129
|
+
* PATCH /granules/{granuleId}
|
|
130
130
|
*
|
|
131
131
|
* @param {Object} params - params
|
|
132
132
|
* @param {string} params.prefix - the prefix configured for the stack
|
|
@@ -142,7 +142,7 @@ const removeFromCMR = async (params) => {
|
|
|
142
142
|
return await callback({
|
|
143
143
|
prefix: prefix,
|
|
144
144
|
payload: {
|
|
145
|
-
httpMethod: '
|
|
145
|
+
httpMethod: 'PATCH',
|
|
146
146
|
resource: '/{proxy+}',
|
|
147
147
|
path: `/granules/${granuleId}`,
|
|
148
148
|
headers: {
|
|
@@ -155,7 +155,7 @@ const removeFromCMR = async (params) => {
|
|
|
155
155
|
exports.removeFromCMR = removeFromCMR;
|
|
156
156
|
/**
|
|
157
157
|
* Run a workflow with the given granule as the payload
|
|
158
|
-
*
|
|
158
|
+
* PATCH /granules/{granuleId}
|
|
159
159
|
*
|
|
160
160
|
* @param {Object} params - params
|
|
161
161
|
* @param {string} params.prefix - the prefix configured for the stack
|
|
@@ -172,7 +172,7 @@ const applyWorkflow = async (params) => {
|
|
|
172
172
|
return await callback({
|
|
173
173
|
prefix: prefix,
|
|
174
174
|
payload: {
|
|
175
|
-
httpMethod: '
|
|
175
|
+
httpMethod: 'PATCH',
|
|
176
176
|
resource: '/{proxy+}',
|
|
177
177
|
headers: {
|
|
178
178
|
'Content-Type': 'application/json',
|
|
@@ -212,7 +212,7 @@ const deleteGranule = async (params) => {
|
|
|
212
212
|
exports.deleteGranule = deleteGranule;
|
|
213
213
|
/**
|
|
214
214
|
* Move a granule via the API
|
|
215
|
-
*
|
|
215
|
+
* PATCH /granules/{granuleId}
|
|
216
216
|
*
|
|
217
217
|
* @param {Object} params - params
|
|
218
218
|
* @param {string} params.prefix - the prefix configured for the stack
|
|
@@ -229,7 +229,7 @@ const moveGranule = async (params) => {
|
|
|
229
229
|
return await callback({
|
|
230
230
|
prefix: prefix,
|
|
231
231
|
payload: {
|
|
232
|
-
httpMethod: '
|
|
232
|
+
httpMethod: 'PATCH',
|
|
233
233
|
resource: '/{proxy+}',
|
|
234
234
|
headers: {
|
|
235
235
|
'Content-Type': 'application/json',
|
|
@@ -309,8 +309,10 @@ const createGranule = async (params) => {
|
|
|
309
309
|
};
|
|
310
310
|
exports.createGranule = createGranule;
|
|
311
311
|
/**
|
|
312
|
-
* Update granule in cumulus.
|
|
313
|
-
*
|
|
312
|
+
* Update granule in cumulus via PATCH request. Existing values will
|
|
313
|
+
* not be overwritten if not specified, null values will be removed and in
|
|
314
|
+
* some cases replaced with defaults.
|
|
315
|
+
* PATCH /granules/{granuleId}
|
|
314
316
|
* @param {Object} params - params
|
|
315
317
|
* @param {Object} [params.body] - granule to pass the API lambda
|
|
316
318
|
* @param {Function} params.callback - async function to invoke the api lambda
|
|
@@ -324,7 +326,7 @@ const updateGranule = async (params) => {
|
|
|
324
326
|
return await callback({
|
|
325
327
|
prefix,
|
|
326
328
|
payload: {
|
|
327
|
-
httpMethod: '
|
|
329
|
+
httpMethod: 'PATCH',
|
|
328
330
|
resource: '/{proxy+}',
|
|
329
331
|
path: `/granules/${body.granuleId}`,
|
|
330
332
|
headers: { 'Content-Type': 'application/json' },
|
package/granules.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"granules.js","sourceRoot":"","sources":["src/granules.ts"],"names":[],"mappings":";;;;;;AAAA,sDAA6B;AAG7B,6DAAqC;AAErC,yDAA+C;AAG/C,MAAM,MAAM,GAAG,IAAI,gBAAM,CAAC,EAAE,MAAM,EAAE,sBAAsB,EAAE,CAAC,CAAC;AAQ9D;;;;;;;;;;;;GAYG;AACI,MAAM,kBAAkB,GAAG,KAAK,EAAE,MAKxC,EAA8C,EAAE;IAC/C,MAAM,EACJ,MAAM,EACN,SAAS,EACT,KAAK,EACL,QAAQ,GAAG,4BAAS,GACrB,GAAG,MAAM,CAAC;IAEX,OAAO,MAAM,QAAQ,CAAC;QACpB,MAAM,EAAE,MAAM;QACd,OAAO,EAAE;YACP,UAAU,EAAE,KAAK;YACjB,QAAQ,EAAE,WAAW;YACrB,IAAI,EAAE,aAAa,SAAS,EAAE;YAC9B,GAAG,CAAC,KAAK,IAAI,EAAE,qBAAqB,EAAE,KAAK,EAAE,CAAC;SAC/C;KACF,CAAC,CAAC;AACL,CAAC,CAAC;AAtBW,QAAA,kBAAkB,sBAsB7B;AAEF;;;;;;;;;;;;GAYG;AACI,MAAM,UAAU,GAAG,KAAK,EAAE,MAKhC,
|
|
1
|
+
{"version":3,"file":"granules.js","sourceRoot":"","sources":["src/granules.ts"],"names":[],"mappings":";;;;;;AAAA,sDAA6B;AAG7B,6DAAqC;AAErC,yDAA+C;AAG/C,MAAM,MAAM,GAAG,IAAI,gBAAM,CAAC,EAAE,MAAM,EAAE,sBAAsB,EAAE,CAAC,CAAC;AAQ9D;;;;;;;;;;;;GAYG;AACI,MAAM,kBAAkB,GAAG,KAAK,EAAE,MAKxC,EAA8C,EAAE;IAC/C,MAAM,EACJ,MAAM,EACN,SAAS,EACT,KAAK,EACL,QAAQ,GAAG,4BAAS,GACrB,GAAG,MAAM,CAAC;IAEX,OAAO,MAAM,QAAQ,CAAC;QACpB,MAAM,EAAE,MAAM;QACd,OAAO,EAAE;YACP,UAAU,EAAE,KAAK;YACjB,QAAQ,EAAE,WAAW;YACrB,IAAI,EAAE,aAAa,SAAS,EAAE;YAC9B,GAAG,CAAC,KAAK,IAAI,EAAE,qBAAqB,EAAE,KAAK,EAAE,CAAC;SAC/C;KACF,CAAC,CAAC;AACL,CAAC,CAAC;AAtBW,QAAA,kBAAkB,sBAsB7B;AAEF;;;;;;;;;;;;GAYG;AACI,MAAM,UAAU,GAAG,KAAK,EAAE,MAKhC,EAA6B,EAAE;IAC9B,MAAM,QAAQ,GAAG,MAAM,IAAA,0BAAkB,EAAC,MAAM,CAAC,CAAC;IAClD,OAAO,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;AACnC,CAAC,CAAC;AARW,QAAA,UAAU,cAQrB;AAEF;;;;;;;;;;GAUG;AACI,MAAM,cAAc,GAAG,KAAK,EAAE,MAOpC,EAAE,EAAE;IACH,MAAM,EACJ,MAAM,EACN,SAAS,EACT,MAAM,EACN,OAAO,GAAG,EAAE,EACZ,aAAa,GAAG,EAAE,EAClB,QAAQ,GAAG,4BAAS,GACrB,GAAG,MAAM,CAAC;IAEX,MAAM,IAAA,iBAAM,EACV,KAAK,IAAI,EAAE;QACT,MAAM,SAAS,GAAG,MAAM,IAAA,0BAAkB,EAAC,EAAE,MAAM,EAAE,SAAS,EAAE,QAAQ,EAAE,CAAC,CAAC;QAE5E,IAAI,SAAS,CAAC,UAAU,KAAK,GAAG,EAAE;YAChC,MAAM,IAAI,iBAAM,CAAC,UAAU,CAAC,0CAA0C,CAAC,CAAC;SACzE;QAED,IAAI,SAAS,CAAC,UAAU,KAAK,GAAG,EAAE;YAChC,MAAM,IAAI,KAAK,CAAC,WAAW,SAAS,gCAAgC,SAAS,CAAC,UAAU,eAAe,CAAC,CAAC;SAC1G;QAED,IAAI,MAAM,EAAE;YACV,MAAM,aAAa,GAAG,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC;YAExD,IAAI,MAAM,KAAK,aAAa,EAAE;gBAC5B,MAAM,IAAI,KAAK,CAAC,kBAAkB,aAAa,+CAA+C,CAAC,CAAC;aACjG;SACF;QAED,MAAM,CAAC,IAAI,CAAC,WAAW,SAAS,6BAA6B,CAAC,CAAC,CAAC,mBAAmB;IACrF,CAAC,EACD;QACE,OAAO;QACP,eAAe,EAAE,CAAC,CAAC,EAAE,EAAE;YACrB,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC;QAC1B,CAAC;QACD,GAAG,aAAa;KACjB,CACF,CAAC;AACJ,CAAC,CAAC;AA/CW,QAAA,cAAc,kBA+CzB;AAEF;;;;;;;;;;;;;;GAcG;AACI,MAAM,eAAe,GAAG,KAAK,EAAE,MAMrC,EAA8C,EAAE;IAC/C,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,YAAY,EAAE,YAAY,EAAE,QAAQ,GAAG,4BAAS,EAAE,GAAG,MAAM,CAAC;IAEvF,OAAO,MAAM,QAAQ,CAAC;QACpB,MAAM,EAAE,MAAM;QACd,OAAO,EAAE;YACP,UAAU,EAAE,OAAO;YACnB,QAAQ,EAAE,WAAW;YACrB,IAAI,EAAE,aAAa,SAAS,EAAE;YAC9B,OAAO,EAAE;gBACP,cAAc,EAAE,kBAAkB;aACnC;YACD,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC;gBACnB,MAAM,EAAE,UAAU;gBAClB,YAAY;gBACZ,YAAY;aACb,CAAC;SACH;KACF,CAAC,CAAC;AACL,CAAC,CAAC;AAzBW,QAAA,eAAe,mBAyB1B;AAEF;;;;;;;;;;;;GAYG;AACI,MAAM,aAAa,GAAG,KAAK,EAAE,MAInC,EAA8C,EAAE;IAC/C,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,QAAQ,GAAG,4BAAS,EAAE,GAAG,MAAM,CAAC;IAE3D,OAAO,MAAM,QAAQ,CAAC;QACpB,MAAM,EAAE,MAAM;QACd,OAAO,EAAE;YACP,UAAU,EAAE,OAAO;YACnB,QAAQ,EAAE,WAAW;YACrB,IAAI,EAAE,aAAa,SAAS,EAAE;YAC9B,OAAO,EAAE;gBACP,cAAc,EAAE,kBAAkB;aACnC;YACD,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE,MAAM,EAAE,eAAe,EAAE,CAAC;SAClD;KACF,CAAC,CAAC;AACL,CAAC,CAAC;AAnBW,QAAA,aAAa,iBAmBxB;AAEF;;;;;;;;;;;;;GAaG;AACI,MAAM,aAAa,GAAG,KAAK,EAAE,MAMnC,EAA8C,EAAE;IAC/C,MAAM,EACJ,MAAM,EACN,SAAS,EACT,QAAQ,EACR,IAAI,EACJ,QAAQ,GAAG,4BAAS,GACrB,GAAG,MAAM,CAAC;IAEX,OAAO,MAAM,QAAQ,CAAC;QACpB,MAAM,EAAE,MAAM;QACd,OAAO,EAAE;YACP,UAAU,EAAE,OAAO;YACnB,QAAQ,EAAE,WAAW;YACrB,OAAO,EAAE;gBACP,cAAc,EAAE,kBAAkB;aACnC;YACD,IAAI,EAAE,aAAa,SAAS,EAAE;YAC9B,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE,MAAM,EAAE,eAAe,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;SAClE;KACF,CAAC,CAAC;AACL,CAAC,CAAC;AA3BW,QAAA,aAAa,iBA2BxB;AAEF;;;;;;;;;;;;;GAaG;AACI,MAAM,aAAa,GAAG,KAAK,EAAE,MAKnC,EAA8C,EAAE;IAC/C,MAAM,EACJ,aAAa,EACb,MAAM,EACN,SAAS,EACT,QAAQ,GAAG,4BAAS,GACrB,GAAG,MAAM,CAAC;IACX,OAAO,MAAM,QAAQ,CAAC;QACpB,MAAM,EAAE,MAAM;QACd,OAAO,EAAE;YACP,UAAU,EAAE,QAAQ;YACpB,QAAQ,EAAE,WAAW;YACrB,IAAI,EAAE,aAAa,SAAS,EAAE;SAC/B;QACD,aAAa;KACd,CAAC,CAAC;AACL,CAAC,CAAC;AArBW,QAAA,aAAa,iBAqBxB;AAEF;;;;;;;;;;;;;GAaG;AACI,MAAM,WAAW,GAAG,KAAK,EAAE,MAKjC,EAA8C,EAAE;IAC/C,MAAM,EACJ,MAAM,EACN,SAAS,EACT,YAAY,EACZ,QAAQ,GAAG,4BAAS,GACrB,GAAG,MAAM,CAAC;IAEX,OAAO,MAAM,QAAQ,CAAC;QACpB,MAAM,EAAE,MAAM;QACd,OAAO,EAAE;YACP,UAAU,EAAE,OAAO;YACnB,QAAQ,EAAE,WAAW;YACrB,OAAO,EAAE;gBACP,cAAc,EAAE,kBAAkB;aACnC;YACD,IAAI,EAAE,aAAa,SAAS,EAAE;YAC9B,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,YAAY,EAAE,CAAC;SACvD;KACF,CAAC,CAAC;AACL,CAAC,CAAC;AAzBW,QAAA,WAAW,eAyBtB;AAEF;;;;;;;;;;;GAWG;AACI,MAAM,sBAAsB,GAAG,KAAK,EAAE,MAI5C,EAA8C,EAAE;IAC/C,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,QAAQ,GAAG,4BAAS,EAAE,GAAG,MAAM,CAAC;IAE3D,0CAA0C;IAC1C,MAAM,IAAA,qBAAa,EAAC,EAAE,MAAM,EAAE,SAAS,EAAE,QAAQ,EAAE,CAAC,CAAC;IACrD,OAAO,IAAA,qBAAa,EAAC,EAAE,MAAM,EAAE,SAAS,EAAE,QAAQ,EAAE,CAAC,CAAC;AACxD,CAAC,CAAC;AAVW,QAAA,sBAAsB,0BAUjC;AAEF;;;;;;;;;;GAUG;AACI,MAAM,YAAY,GAAG,KAAK,EAAE,MAOlC,EAA8C,EAAE;IAC/C,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,GAAG,4BAAS,EAAE,GAAG,MAAM,CAAC;IAEvD,OAAO,MAAM,QAAQ,CAAC;QACpB,MAAM,EAAE,MAAM;QACd,OAAO,EAAE;YACP,UAAU,EAAE,KAAK;YACjB,QAAQ,EAAE,WAAW;YACrB,IAAI,EAAE,WAAW;YACjB,qBAAqB,EAAE,KAAK;SAC7B;KACF,CAAC,CAAC;AACL,CAAC,CAAC;AAnBW,QAAA,YAAY,gBAmBvB;AAEF;;;;;;;;;;GAUG;AACI,MAAM,aAAa,GAAG,KAAK,EAAE,MAInC,EAA8C,EAAE;IAC/C,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,QAAQ,GAAG,4BAAS,EAAE,GAAG,MAAM,CAAC;IAEtD,OAAO,MAAM,QAAQ,CAAC;QACpB,MAAM;QACN,OAAO,EAAE;YACP,UAAU,EAAE,MAAM;YAClB,QAAQ,EAAE,WAAW;YACrB,IAAI,EAAE,WAAW;YACjB,OAAO,EAAE,EAAE,cAAc,EAAE,kBAAkB,EAAE;YAC/C,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;SAC3B;KACF,CAAC,CAAC;AACL,CAAC,CAAC;AAjBW,QAAA,aAAa,iBAiBxB;AAEF;;;;;;;;;;;;GAYG;AACI,MAAM,aAAa,GAAG,KAAK,EAAE,MAInC,EAA8C,EAAE;IAC/C,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,QAAQ,GAAG,4BAAS,EAAE,GAAG,MAAM,CAAC;IAEtD,OAAO,MAAM,QAAQ,CAAC;QACpB,MAAM;QACN,OAAO,EAAE;YACP,UAAU,EAAE,OAAO;YACnB,QAAQ,EAAE,WAAW;YACrB,IAAI,EAAE,aAAa,IAAI,CAAC,SAAS,EAAE;YACnC,OAAO,EAAE,EAAE,cAAc,EAAE,kBAAkB,EAAE;YAC/C,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;SAC3B;QACD,mBAAmB,EAAE,CAAC,GAAG,EAAE,GAAG,CAAC;KAChC,CAAC,CAAC;AACL,CAAC,CAAC;AAlBW,QAAA,aAAa,iBAkBxB;AAEF;;;;;;;;;;GAUG;AACI,MAAM,6BAA6B,GAAG,KAAK,EAAE,MAInD,EAA8C,EAAE;IAC/C,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,QAAQ,GAAG,4BAAS,EAAE,GAAG,MAAM,CAAC;IAEtD,OAAO,MAAM,QAAQ,CAAC;QACpB,MAAM;QACN,OAAO,EAAE;YACP,UAAU,EAAE,MAAM;YAClB,QAAQ,EAAE,WAAW;YACrB,IAAI,EAAE,aAAa,IAAI,CAAC,SAAS,aAAa;YAC9C,OAAO,EAAE,EAAE,cAAc,EAAE,kBAAkB,EAAE;YAC/C,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;SAC3B;KACF,CAAC,CAAC;AACL,CAAC,CAAC;AAjBW,QAAA,6BAA6B,iCAiBxC;AAEF;;;;;;;;;;GAUG;AACI,MAAM,YAAY,GAAG,KAAK,EAAE,MAIlC,EAA8C,EAAE;IAC/C,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,QAAQ,GAAG,4BAAS,EAAE,GAAG,MAAM,CAAC;IAEtD,OAAO,MAAM,QAAQ,CAAC;QACpB,MAAM,EAAE,MAAM;QACd,OAAO,EAAE;YACP,UAAU,EAAE,MAAM;YAClB,QAAQ,EAAE,WAAW;YACrB,OAAO,EAAE;gBACP,cAAc,EAAE,kBAAkB;aACnC;YACD,IAAI,EAAE,gBAAgB;YACtB,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;SAC3B;QACD,mBAAmB,EAAE,GAAG;KACzB,CAAC,CAAC;AACL,CAAC,CAAC;AApBW,QAAA,YAAY,gBAoBvB;AAEF;;;;;;;;;;GAUG;AACI,MAAM,kBAAkB,GAAG,KAAK,EAAE,MAIxC,EAA8C,EAAE;IAC/C,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,QAAQ,GAAG,4BAAS,EAAE,GAAG,MAAM,CAAC;IAEtD,OAAO,MAAM,QAAQ,CAAC;QACpB,MAAM,EAAE,MAAM;QACd,OAAO,EAAE;YACP,UAAU,EAAE,MAAM;YAClB,QAAQ,EAAE,WAAW;YACrB,OAAO,EAAE;gBACP,cAAc,EAAE,kBAAkB;aACnC;YACD,IAAI,EAAE,sBAAsB;YAC5B,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;SAC3B;QACD,mBAAmB,EAAE,GAAG;KACzB,CAAC,CAAC;AACL,CAAC,CAAC;AApBW,QAAA,kBAAkB,sBAoB7B;AAEK,MAAM,oBAAoB,GAAG,KAAK,EAAE,MAI1C,EAA8C,EAAE;IAC/C,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,QAAQ,GAAG,4BAAS,EAAE,GAAG,MAAM,CAAC;IAEtD,OAAO,MAAM,QAAQ,CAAC;QACpB,MAAM,EAAE,MAAM;QACd,OAAO,EAAE;YACP,UAAU,EAAE,MAAM;YAClB,QAAQ,EAAE,WAAW;YACrB,OAAO,EAAE;gBACP,cAAc,EAAE,kBAAkB;aACnC;YACD,IAAI,EAAE,wBAAwB;YAC9B,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;SAC3B;QACD,mBAAmB,EAAE,GAAG;KACzB,CAAC,CAAC;AACL,CAAC,CAAC;AApBW,QAAA,oBAAoB,wBAoB/B;AAEF;;;;;;;;;;;;;GAaG;AACI,MAAM,aAAa,GAAG,KAAK,EAAE,MAKnC,EAA8C,EAAE;IAC/C,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,YAAY,EAAE,QAAQ,GAAG,4BAAS,EAAE,GAAG,MAAM,CAAC;IACnE,OAAO,MAAM,QAAQ,CAAC;QACpB,MAAM,EAAE,MAAM;QACd,OAAO,EAAE;YACP,UAAU,EAAE,MAAM;YAClB,QAAQ,EAAE,WAAW;YACrB,IAAI,EAAE,iBAAiB;YACvB,OAAO,EAAE;gBACP,cAAc,EAAE,kBAAkB;aACnC;YACD,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE,GAAG,EAAE,YAAY,EAAE,CAAC;SAC5C;QACD,mBAAmB,EAAE,GAAG;KACzB,CAAC,CAAC;AACL,CAAC,CAAC;AApBW,QAAA,aAAa,iBAoBxB"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@cumulus/api-client",
|
|
3
|
-
"version": "
|
|
3
|
+
"version": "14.1.0",
|
|
4
4
|
"description": "API client for working with the Cumulus archive API",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"GIBS",
|
|
@@ -38,12 +38,12 @@
|
|
|
38
38
|
"author": "Cumulus Authors",
|
|
39
39
|
"license": "Apache-2.0",
|
|
40
40
|
"dependencies": {
|
|
41
|
-
"@cumulus/aws-client": "
|
|
42
|
-
"@cumulus/logger": "
|
|
41
|
+
"@cumulus/aws-client": "14.1.0",
|
|
42
|
+
"@cumulus/logger": "14.1.0",
|
|
43
43
|
"p-retry": "^2.0.0"
|
|
44
44
|
},
|
|
45
45
|
"devDependencies": {
|
|
46
|
-
"@cumulus/types": "
|
|
46
|
+
"@cumulus/types": "14.1.0"
|
|
47
47
|
},
|
|
48
|
-
"gitHead": "
|
|
48
|
+
"gitHead": "d97b5b37913944c0f0ecf958f2a567ec3714816c"
|
|
49
49
|
}
|
package/src/granules.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import pRetry from 'p-retry';
|
|
2
2
|
|
|
3
|
-
import {
|
|
3
|
+
import { ApiGranuleRecord, GranuleId, GranuleStatus } from '@cumulus/types/api/granules';
|
|
4
4
|
import Logger from '@cumulus/logger';
|
|
5
5
|
|
|
6
6
|
import { invokeApi } from './cumulusApiClient';
|
|
@@ -69,7 +69,7 @@ export const getGranule = async (params: {
|
|
|
69
69
|
granuleId: GranuleId,
|
|
70
70
|
query?: { [key: string]: string },
|
|
71
71
|
callback?: InvokeApiFunction
|
|
72
|
-
}): Promise<
|
|
72
|
+
}): Promise<ApiGranuleRecord> => {
|
|
73
73
|
const response = await getGranuleResponse(params);
|
|
74
74
|
return JSON.parse(response.body);
|
|
75
75
|
};
|
|
@@ -136,7 +136,7 @@ export const waitForGranule = async (params: {
|
|
|
136
136
|
|
|
137
137
|
/**
|
|
138
138
|
* Reingest a granule from the Cumulus API
|
|
139
|
-
*
|
|
139
|
+
* PATCH /granules/{}
|
|
140
140
|
*
|
|
141
141
|
* @param {Object} params - params
|
|
142
142
|
* @param {string} params.prefix - the prefix configured for the stack
|
|
@@ -161,7 +161,7 @@ export const reingestGranule = async (params: {
|
|
|
161
161
|
return await callback({
|
|
162
162
|
prefix: prefix,
|
|
163
163
|
payload: {
|
|
164
|
-
httpMethod: '
|
|
164
|
+
httpMethod: 'PATCH',
|
|
165
165
|
resource: '/{proxy+}',
|
|
166
166
|
path: `/granules/${granuleId}`,
|
|
167
167
|
headers: {
|
|
@@ -178,7 +178,7 @@ export const reingestGranule = async (params: {
|
|
|
178
178
|
|
|
179
179
|
/**
|
|
180
180
|
* Removes a granule from CMR via the Cumulus API
|
|
181
|
-
*
|
|
181
|
+
* PATCH /granules/{granuleId}
|
|
182
182
|
*
|
|
183
183
|
* @param {Object} params - params
|
|
184
184
|
* @param {string} params.prefix - the prefix configured for the stack
|
|
@@ -199,7 +199,7 @@ export const removeFromCMR = async (params: {
|
|
|
199
199
|
return await callback({
|
|
200
200
|
prefix: prefix,
|
|
201
201
|
payload: {
|
|
202
|
-
httpMethod: '
|
|
202
|
+
httpMethod: 'PATCH',
|
|
203
203
|
resource: '/{proxy+}',
|
|
204
204
|
path: `/granules/${granuleId}`,
|
|
205
205
|
headers: {
|
|
@@ -212,7 +212,7 @@ export const removeFromCMR = async (params: {
|
|
|
212
212
|
|
|
213
213
|
/**
|
|
214
214
|
* Run a workflow with the given granule as the payload
|
|
215
|
-
*
|
|
215
|
+
* PATCH /granules/{granuleId}
|
|
216
216
|
*
|
|
217
217
|
* @param {Object} params - params
|
|
218
218
|
* @param {string} params.prefix - the prefix configured for the stack
|
|
@@ -242,7 +242,7 @@ export const applyWorkflow = async (params: {
|
|
|
242
242
|
return await callback({
|
|
243
243
|
prefix: prefix,
|
|
244
244
|
payload: {
|
|
245
|
-
httpMethod: '
|
|
245
|
+
httpMethod: 'PATCH',
|
|
246
246
|
resource: '/{proxy+}',
|
|
247
247
|
headers: {
|
|
248
248
|
'Content-Type': 'application/json',
|
|
@@ -292,7 +292,7 @@ export const deleteGranule = async (params: {
|
|
|
292
292
|
|
|
293
293
|
/**
|
|
294
294
|
* Move a granule via the API
|
|
295
|
-
*
|
|
295
|
+
* PATCH /granules/{granuleId}
|
|
296
296
|
*
|
|
297
297
|
* @param {Object} params - params
|
|
298
298
|
* @param {string} params.prefix - the prefix configured for the stack
|
|
@@ -320,7 +320,7 @@ export const moveGranule = async (params: {
|
|
|
320
320
|
return await callback({
|
|
321
321
|
prefix: prefix,
|
|
322
322
|
payload: {
|
|
323
|
-
httpMethod: '
|
|
323
|
+
httpMethod: 'PATCH',
|
|
324
324
|
resource: '/{proxy+}',
|
|
325
325
|
headers: {
|
|
326
326
|
'Content-Type': 'application/json',
|
|
@@ -400,7 +400,7 @@ export const listGranules = async (params: {
|
|
|
400
400
|
*/
|
|
401
401
|
export const createGranule = async (params: {
|
|
402
402
|
prefix: string,
|
|
403
|
-
body:
|
|
403
|
+
body: ApiGranuleRecord,
|
|
404
404
|
callback?: InvokeApiFunction
|
|
405
405
|
}): Promise<ApiGatewayLambdaHttpProxyResponse> => {
|
|
406
406
|
const { prefix, body, callback = invokeApi } = params;
|
|
@@ -418,8 +418,10 @@ export const createGranule = async (params: {
|
|
|
418
418
|
};
|
|
419
419
|
|
|
420
420
|
/**
|
|
421
|
-
* Update granule in cumulus.
|
|
422
|
-
*
|
|
421
|
+
* Update granule in cumulus via PATCH request. Existing values will
|
|
422
|
+
* not be overwritten if not specified, null values will be removed and in
|
|
423
|
+
* some cases replaced with defaults.
|
|
424
|
+
* PATCH /granules/{granuleId}
|
|
423
425
|
* @param {Object} params - params
|
|
424
426
|
* @param {Object} [params.body] - granule to pass the API lambda
|
|
425
427
|
* @param {Function} params.callback - async function to invoke the api lambda
|
|
@@ -430,7 +432,7 @@ export const createGranule = async (params: {
|
|
|
430
432
|
*/
|
|
431
433
|
export const updateGranule = async (params: {
|
|
432
434
|
prefix: string,
|
|
433
|
-
body:
|
|
435
|
+
body: ApiGranuleRecord,
|
|
434
436
|
callback?: InvokeApiFunction
|
|
435
437
|
}): Promise<ApiGatewayLambdaHttpProxyResponse> => {
|
|
436
438
|
const { prefix, body, callback = invokeApi } = params;
|
|
@@ -438,7 +440,7 @@ export const updateGranule = async (params: {
|
|
|
438
440
|
return await callback({
|
|
439
441
|
prefix,
|
|
440
442
|
payload: {
|
|
441
|
-
httpMethod: '
|
|
443
|
+
httpMethod: 'PATCH',
|
|
442
444
|
resource: '/{proxy+}',
|
|
443
445
|
path: `/granules/${body.granuleId}`,
|
|
444
446
|
headers: { 'Content-Type': 'application/json' },
|
package/src/types.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import pRetry from 'p-retry';
|
|
2
2
|
|
|
3
|
-
export type HttpMethod = 'DELETE' | 'GET' | 'POST' | 'PUT';
|
|
3
|
+
export type HttpMethod = 'DELETE' | 'GET' | 'POST' | 'PUT' | 'PATCH';
|
|
4
4
|
|
|
5
5
|
// https://docs.aws.amazon.com/apigateway/latest/developerguide/set-up-lambda-proxy-integrations.html
|
|
6
6
|
export interface ApiGatewayLambdaProxyPayload {
|