@ido_kawaz/storage-client 4.0.0 → 5.0.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/README.md +1 -1
- package/dist/__tests__/config.test.js +59 -1
- package/dist/__tests__/config.test.js.map +1 -1
- package/dist/config.d.ts.map +1 -1
- package/dist/config.js +10 -15
- package/dist/config.js.map +1 -1
- package/package.json +3 -4
package/README.md
CHANGED
|
@@ -36,7 +36,7 @@ await client.uploadObject(
|
|
|
36
36
|
|
|
37
37
|
### `createStorageClientConfig(): StorageClientConfig`
|
|
38
38
|
|
|
39
|
-
Builds a validated `StorageClientConfig` from environment variables using
|
|
39
|
+
Builds a validated `StorageClientConfig` from environment variables using Zod.
|
|
40
40
|
|
|
41
41
|
Supported environment variables:
|
|
42
42
|
|
|
@@ -1,8 +1,19 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
const config_1 = require("../config");
|
|
4
|
+
const zod_1 = require("zod");
|
|
4
5
|
describe('createStorageClientConfig', () => {
|
|
5
6
|
const originalEnv = process.env;
|
|
7
|
+
const getThrownZodError = () => {
|
|
8
|
+
try {
|
|
9
|
+
(0, config_1.createStorageConfig)();
|
|
10
|
+
throw new Error('Expected createStorageConfig to throw');
|
|
11
|
+
}
|
|
12
|
+
catch (error) {
|
|
13
|
+
expect(error).toBeInstanceOf(zod_1.ZodError);
|
|
14
|
+
return error;
|
|
15
|
+
}
|
|
16
|
+
};
|
|
6
17
|
beforeEach(() => {
|
|
7
18
|
jest.resetModules();
|
|
8
19
|
process.env = { ...originalEnv };
|
|
@@ -45,7 +56,54 @@ describe('createStorageClientConfig', () => {
|
|
|
45
56
|
delete process.env.AWS_ENDPOINT;
|
|
46
57
|
delete process.env.AWS_ACCESS_KEY_ID;
|
|
47
58
|
delete process.env.AWS_SECRET_ACCESS_KEY;
|
|
48
|
-
|
|
59
|
+
const error = getThrownZodError();
|
|
60
|
+
expect(error.issues).toHaveLength(3);
|
|
61
|
+
expect(error.issues).toEqual(expect.arrayContaining([
|
|
62
|
+
expect.objectContaining({ path: ['AWS_ENDPOINT'], code: 'invalid_type', expected: 'string', received: 'undefined', message: 'Required' }),
|
|
63
|
+
expect.objectContaining({ path: ['AWS_ACCESS_KEY_ID'], code: 'invalid_type', expected: 'string', received: 'undefined', message: 'Required' }),
|
|
64
|
+
expect.objectContaining({ path: ['AWS_SECRET_ACCESS_KEY'], code: 'invalid_type', expected: 'string', received: 'undefined', message: 'Required' }),
|
|
65
|
+
]));
|
|
66
|
+
});
|
|
67
|
+
it('throws when endpoint is not a valid URL', () => {
|
|
68
|
+
process.env.AWS_ENDPOINT = 'not-a-url';
|
|
69
|
+
process.env.AWS_ACCESS_KEY_ID = 'key-id';
|
|
70
|
+
process.env.AWS_SECRET_ACCESS_KEY = 'secret';
|
|
71
|
+
const error = getThrownZodError();
|
|
72
|
+
expect(error.issues).toHaveLength(1);
|
|
73
|
+
expect(error.issues[0]).toMatchObject({
|
|
74
|
+
path: ['AWS_ENDPOINT'],
|
|
75
|
+
code: 'invalid_string',
|
|
76
|
+
validation: 'url',
|
|
77
|
+
message: 'Invalid url',
|
|
78
|
+
});
|
|
79
|
+
});
|
|
80
|
+
it('throws when part size is not a finite number', () => {
|
|
81
|
+
process.env.AWS_ENDPOINT = 'http://localhost:9000';
|
|
82
|
+
process.env.AWS_ACCESS_KEY_ID = 'key-id';
|
|
83
|
+
process.env.AWS_SECRET_ACCESS_KEY = 'secret';
|
|
84
|
+
process.env.AWS_PART_SIZE = 'invalid-number';
|
|
85
|
+
const error = getThrownZodError();
|
|
86
|
+
expect(error.issues).toHaveLength(1);
|
|
87
|
+
expect(error.issues[0]).toMatchObject({
|
|
88
|
+
path: ['AWS_PART_SIZE'],
|
|
89
|
+
code: 'invalid_type',
|
|
90
|
+
expected: 'number',
|
|
91
|
+
received: 'nan',
|
|
92
|
+
message: 'Expected number, received nan',
|
|
93
|
+
});
|
|
94
|
+
});
|
|
95
|
+
it('throws when max concurrency is not a finite number', () => {
|
|
96
|
+
process.env.AWS_ENDPOINT = 'http://localhost:9000';
|
|
97
|
+
process.env.AWS_ACCESS_KEY_ID = 'key-id';
|
|
98
|
+
process.env.AWS_SECRET_ACCESS_KEY = 'secret';
|
|
99
|
+
process.env.AWS_MAX_CONCURRENCY = 'Infinity';
|
|
100
|
+
const error = getThrownZodError();
|
|
101
|
+
expect(error.issues).toHaveLength(1);
|
|
102
|
+
expect(error.issues[0]).toMatchObject({
|
|
103
|
+
path: ['AWS_MAX_CONCURRENCY'],
|
|
104
|
+
code: 'not_finite',
|
|
105
|
+
message: 'Number must be finite',
|
|
106
|
+
});
|
|
49
107
|
});
|
|
50
108
|
});
|
|
51
109
|
//# sourceMappingURL=config.test.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"config.test.js","sourceRoot":"","sources":["../../src/__tests__/config.test.ts"],"names":[],"mappings":";;AAAA,sCAAgD;
|
|
1
|
+
{"version":3,"file":"config.test.js","sourceRoot":"","sources":["../../src/__tests__/config.test.ts"],"names":[],"mappings":";;AAAA,sCAAgD;AAChD,6BAA+B;AAE/B,QAAQ,CAAC,2BAA2B,EAAE,GAAG,EAAE;IACvC,MAAM,WAAW,GAAG,OAAO,CAAC,GAAG,CAAC;IAChC,MAAM,iBAAiB,GAAG,GAAa,EAAE;QACrC,IAAI,CAAC;YACD,IAAA,4BAAmB,GAAE,CAAC;YACtB,MAAM,IAAI,KAAK,CAAC,uCAAuC,CAAC,CAAC;QAC7D,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACb,MAAM,CAAC,KAAK,CAAC,CAAC,cAAc,CAAC,cAAQ,CAAC,CAAC;YACvC,OAAO,KAAiB,CAAC;QAC7B,CAAC;IACL,CAAC,CAAC;IAEF,UAAU,CAAC,GAAG,EAAE;QACZ,IAAI,CAAC,YAAY,EAAE,CAAC;QACpB,OAAO,CAAC,GAAG,GAAG,EAAE,GAAG,WAAW,EAAE,CAAC;IACrC,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,GAAG,EAAE;QACV,OAAO,CAAC,GAAG,GAAG,WAAW,CAAC;IAC9B,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,2CAA2C,EAAE,GAAG,EAAE;QACjD,OAAO,CAAC,GAAG,CAAC,YAAY,GAAG,uBAAuB,CAAC;QACnD,OAAO,CAAC,GAAG,CAAC,UAAU,GAAG,WAAW,CAAC;QACrC,OAAO,CAAC,GAAG,CAAC,iBAAiB,GAAG,QAAQ,CAAC;QACzC,OAAO,CAAC,GAAG,CAAC,qBAAqB,GAAG,QAAQ,CAAC;QAC7C,OAAO,CAAC,GAAG,CAAC,aAAa,GAAG,UAAU,CAAC;QACvC,OAAO,CAAC,GAAG,CAAC,mBAAmB,GAAG,GAAG,CAAC;QAEtC,MAAM,MAAM,GAAG,IAAA,4BAAmB,GAAE,CAAC;QAErC,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC;YACnB,QAAQ,EAAE,uBAAuB;YACjC,MAAM,EAAE,WAAW;YACnB,WAAW,EAAE;gBACT,WAAW,EAAE,QAAQ;gBACrB,eAAe,EAAE,QAAQ;aAC5B;YACD,QAAQ,EAAE,QAAQ;YAClB,cAAc,EAAE,CAAC;SACpB,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,mCAAmC,EAAE,GAAG,EAAE;QACzC,OAAO,CAAC,GAAG,CAAC,YAAY,GAAG,uBAAuB,CAAC;QACnD,OAAO,CAAC,GAAG,CAAC,iBAAiB,GAAG,QAAQ,CAAC;QACzC,OAAO,CAAC,GAAG,CAAC,qBAAqB,GAAG,QAAQ,CAAC;QAC7C,OAAO,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC;QAC9B,OAAO,OAAO,CAAC,GAAG,CAAC,aAAa,CAAC;QACjC,OAAO,OAAO,CAAC,GAAG,CAAC,mBAAmB,CAAC;QAEvC,MAAM,MAAM,GAAG,IAAA,4BAAmB,GAAE,CAAC;QAErC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QACxC,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,CAAC,GAAG,IAAI,GAAG,IAAI,CAAC,CAAC;QAC9C,MAAM,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAC1C,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,yCAAyC,EAAE,GAAG,EAAE;QAC/C,OAAO,OAAO,CAAC,GAAG,CAAC,YAAY,CAAC;QAChC,OAAO,OAAO,CAAC,GAAG,CAAC,iBAAiB,CAAC;QACrC,OAAO,OAAO,CAAC,GAAG,CAAC,qBAAqB,CAAC;QAEzC,MAAM,KAAK,GAAG,iBAAiB,EAAE,CAAC;QAElC,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;QACrC,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,OAAO,CACxB,MAAM,CAAC,eAAe,CAAC;YACnB,MAAM,CAAC,gBAAgB,CAAC,EAAE,IAAI,EAAE,CAAC,cAAc,CAAC,EAAE,IAAI,EAAE,cAAc,EAAE,QAAQ,EAAE,QAAQ,EAAE,QAAQ,EAAE,WAAW,EAAE,OAAO,EAAE,UAAU,EAAE,CAAC;YACzI,MAAM,CAAC,gBAAgB,CAAC,EAAE,IAAI,EAAE,CAAC,mBAAmB,CAAC,EAAE,IAAI,EAAE,cAAc,EAAE,QAAQ,EAAE,QAAQ,EAAE,QAAQ,EAAE,WAAW,EAAE,OAAO,EAAE,UAAU,EAAE,CAAC;YAC9I,MAAM,CAAC,gBAAgB,CAAC,EAAE,IAAI,EAAE,CAAC,uBAAuB,CAAC,EAAE,IAAI,EAAE,cAAc,EAAE,QAAQ,EAAE,QAAQ,EAAE,QAAQ,EAAE,WAAW,EAAE,OAAO,EAAE,UAAU,EAAE,CAAC;SACrJ,CAAC,CACL,CAAC;IACN,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,yCAAyC,EAAE,GAAG,EAAE;QAC/C,OAAO,CAAC,GAAG,CAAC,YAAY,GAAG,WAAW,CAAC;QACvC,OAAO,CAAC,GAAG,CAAC,iBAAiB,GAAG,QAAQ,CAAC;QACzC,OAAO,CAAC,GAAG,CAAC,qBAAqB,GAAG,QAAQ,CAAC;QAE7C,MAAM,KAAK,GAAG,iBAAiB,EAAE,CAAC;QAElC,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;QACrC,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC;YAClC,IAAI,EAAE,CAAC,cAAc,CAAC;YACtB,IAAI,EAAE,gBAAgB;YACtB,UAAU,EAAE,KAAK;YACjB,OAAO,EAAE,aAAa;SACzB,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,8CAA8C,EAAE,GAAG,EAAE;QACpD,OAAO,CAAC,GAAG,CAAC,YAAY,GAAG,uBAAuB,CAAC;QACnD,OAAO,CAAC,GAAG,CAAC,iBAAiB,GAAG,QAAQ,CAAC;QACzC,OAAO,CAAC,GAAG,CAAC,qBAAqB,GAAG,QAAQ,CAAC;QAC7C,OAAO,CAAC,GAAG,CAAC,aAAa,GAAG,gBAAgB,CAAC;QAE7C,MAAM,KAAK,GAAG,iBAAiB,EAAE,CAAC;QAElC,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;QACrC,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC;YAClC,IAAI,EAAE,CAAC,eAAe,CAAC;YACvB,IAAI,EAAE,cAAc;YACpB,QAAQ,EAAE,QAAQ;YAClB,QAAQ,EAAE,KAAK;YACf,OAAO,EAAE,+BAA+B;SAC3C,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,oDAAoD,EAAE,GAAG,EAAE;QAC1D,OAAO,CAAC,GAAG,CAAC,YAAY,GAAG,uBAAuB,CAAC;QACnD,OAAO,CAAC,GAAG,CAAC,iBAAiB,GAAG,QAAQ,CAAC;QACzC,OAAO,CAAC,GAAG,CAAC,qBAAqB,GAAG,QAAQ,CAAC;QAC7C,OAAO,CAAC,GAAG,CAAC,mBAAmB,GAAG,UAAU,CAAC;QAE7C,MAAM,KAAK,GAAG,iBAAiB,EAAE,CAAC;QAElC,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;QACrC,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC;YAClC,IAAI,EAAE,CAAC,qBAAqB,CAAC;YAC7B,IAAI,EAAE,YAAY;YAClB,OAAO,EAAE,uBAAuB;SACnC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;AACP,CAAC,CAAC,CAAC"}
|
package/dist/config.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AAGpD,MAAM,WAAW,aAAc,SAAQ,cAAc;IACjD,QAAQ,EAAE,MAAM,CAAC;IACjB,cAAc,EAAE,MAAM,CAAC;CAC1B;
|
|
1
|
+
{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AAGpD,MAAM,WAAW,aAAc,SAAQ,cAAc;IACjD,QAAQ,EAAE,MAAM,CAAC;IACjB,cAAc,EAAE,MAAM,CAAC;CAC1B;AAYD,eAAO,MAAM,mBAAmB,QAAO,aAYtC,CAAC"}
|
package/dist/config.js
CHANGED
|
@@ -1,23 +1,18 @@
|
|
|
1
1
|
"use strict";
|
|
2
|
-
var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
3
|
-
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
4
|
-
};
|
|
5
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
6
3
|
exports.createStorageConfig = void 0;
|
|
7
|
-
const
|
|
8
|
-
const StorageEnvSchema =
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
4
|
+
const zod_1 = require("zod");
|
|
5
|
+
const StorageEnvSchema = zod_1.z
|
|
6
|
+
.object({
|
|
7
|
+
AWS_ENDPOINT: zod_1.z.string().url(),
|
|
8
|
+
AWS_REGION: zod_1.z.string().default("us-east-1"),
|
|
9
|
+
AWS_ACCESS_KEY_ID: zod_1.z.string(),
|
|
10
|
+
AWS_SECRET_ACCESS_KEY: zod_1.z.string(),
|
|
11
|
+
AWS_PART_SIZE: zod_1.z.coerce.number().finite().default(5 * 1024 * 1024),
|
|
12
|
+
AWS_MAX_CONCURRENCY: zod_1.z.coerce.number().finite().default(4),
|
|
15
13
|
});
|
|
16
14
|
const createStorageConfig = () => {
|
|
17
|
-
const
|
|
18
|
-
if (error) {
|
|
19
|
-
throw error;
|
|
20
|
-
}
|
|
15
|
+
const value = StorageEnvSchema.parse(process.env);
|
|
21
16
|
return {
|
|
22
17
|
endpoint: value.AWS_ENDPOINT,
|
|
23
18
|
region: value.AWS_REGION,
|
package/dist/config.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"config.js","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"config.js","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":";;;AACA,6BAAwB;AAOxB,MAAM,gBAAgB,GAAG,OAAC;KACrB,MAAM,CAAC;IACJ,YAAY,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE;IAC9B,UAAU,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,OAAO,CAAC,WAAW,CAAC;IAC3C,iBAAiB,EAAE,OAAC,CAAC,MAAM,EAAE;IAC7B,qBAAqB,EAAE,OAAC,CAAC,MAAM,EAAE;IACjC,aAAa,EAAE,OAAC,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,MAAM,EAAE,CAAC,OAAO,CAAC,CAAC,GAAG,IAAI,GAAG,IAAI,CAAC;IAClE,mBAAmB,EAAE,OAAC,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,MAAM,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC;CAC7D,CAAC,CAAA;AAEC,MAAM,mBAAmB,GAAG,GAAkB,EAAE;IACnD,MAAM,KAAK,GAAG,gBAAgB,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IAClD,OAAO;QACH,QAAQ,EAAE,KAAK,CAAC,YAAY;QAC5B,MAAM,EAAE,KAAK,CAAC,UAAU;QACxB,WAAW,EAAE;YACT,WAAW,EAAE,KAAK,CAAC,iBAAiB;YACpC,eAAe,EAAE,KAAK,CAAC,qBAAqB;SAC/C;QACD,QAAQ,EAAE,KAAK,CAAC,aAAa;QAC7B,cAAc,EAAE,KAAK,CAAC,mBAAmB;KAC5C,CAAC;AACN,CAAC,CAAC;AAZW,QAAA,mBAAmB,uBAY9B"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@ido_kawaz/storage-client",
|
|
3
|
-
"version": "
|
|
3
|
+
"version": "5.0.0",
|
|
4
4
|
"description": "Storage client library for Kawaz Plus services",
|
|
5
5
|
"main": "dist/index.js",
|
|
6
6
|
"types": "dist/index.d.ts",
|
|
@@ -27,10 +27,9 @@
|
|
|
27
27
|
"dependencies": {
|
|
28
28
|
"@aws-sdk/client-s3": "^3.985.0",
|
|
29
29
|
"@aws-sdk/lib-storage": "^3.985.0",
|
|
30
|
-
"@types/joi": "^17.2.2",
|
|
31
30
|
"@types/ramda": "^0.31.1",
|
|
32
|
-
"
|
|
33
|
-
"
|
|
31
|
+
"ramda": "^0.32.0",
|
|
32
|
+
"zod": "^3.24.2"
|
|
34
33
|
},
|
|
35
34
|
"devDependencies": {
|
|
36
35
|
"@types/jest": "^30.0.0",
|