Skip to content

Commit 6b5a56b

Browse files
AndrewFossAWSAndrewFossAWS
authored
feat(module): create util-utf8 package (#4206)
1 parent aa73203 commit 6b5a56b

20 files changed

+448
-0
lines changed

‎packages/util-utf8/.gitignore

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
/node_modules/
2+
/build/
3+
/coverage/
4+
/docs/
5+
*.tsbuildinfo
6+
*.tgz
7+
*.log
8+
package-lock.json

‎packages/util-utf8/CHANGELOG.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# Change Log
2+
3+
All notable changes to this project will be documented in this file.
4+
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.

‎packages/util-utf8/LICENSE

Lines changed: 201 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,201 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.
175+
176+
END OF TERMS AND CONDITIONS
177+
178+
APPENDIX: How to apply the Apache License to your work.
179+
180+
To apply the Apache License to your work, attach the following
181+
boilerplate notice, with the fields enclosed by brackets "{}"
182+
replaced with your own identifying information. (Don't include
183+
the brackets!) The text should be enclosed in the appropriate
184+
comment syntax for the file format. We also recommend that a
185+
file or class name and description of purpose be included on the
186+
same "printed page" as the copyright notice for easier
187+
identification within third-party archives.
188+
189+
Copyright 2018-2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.
190+
191+
Licensed under the Apache License, Version 2.0 (the "License");
192+
you may not use this file except in compliance with the License.
193+
You may obtain a copy of the License at
194+
195+
http://www.apache.org/licenses/LICENSE-2.0
196+
197+
Unless required by applicable law or agreed to in writing, software
198+
distributed under the License is distributed on an "AS IS" BASIS,
199+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200+
See the License for the specific language governing permissions and
201+
limitations under the License.

‎packages/util-utf8/README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# @aws-sdk/util-utf8
2+
3+
[![NPM version](https://img.shields.io/npm/v/@aws-sdk/util-utf8/latest.svg)](https://www.npmjs.com/package/@aws-sdk/util-utf8)
4+
[![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/util-utf8.svg)](https://www.npmjs.com/package/@aws-sdk/util-utf8)

‎packages/util-utf8/jest.config.js

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
const base = require("../../jest.config.base.js");
2+
3+
module.exports = {
4+
...base,
5+
testMatch: ["**/*.spec.ts"],
6+
};

‎packages/util-utf8/package.json

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
{
2+
"name": "@aws-sdk/util-utf8",
3+
"version": "3.0.0",
4+
"description": "A UTF-8 string <-> UInt8Array converter",
5+
"main": "./dist-cjs/index.js",
6+
"module": "./dist-es/index.js",
7+
"scripts": {
8+
"build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
9+
"build:cjs": "tsc -p tsconfig.cjs.json",
10+
"build:es": "tsc -p tsconfig.es.json",
11+
"build:include:deps": "lerna run --scope $npm_package_name --include-dependencies build",
12+
"build:types": "tsc -p tsconfig.types.json",
13+
"build:types:downlevel": "downlevel-dts dist-types dist-types/ts3.4",
14+
"clean": "rimraf ./dist-* && rimraf *.tsbuildinfo",
15+
"test": "jest"
16+
},
17+
"author": {
18+
"name": "AWS SDK for JavaScript Team",
19+
"url": "https://aws.amazon.com/javascript/"
20+
},
21+
"license": "Apache-2.0",
22+
"dependencies": {
23+
"@aws-sdk/util-buffer-from": "*",
24+
"tslib": "^2.3.1"
25+
},
26+
"devDependencies": {
27+
"@tsconfig/recommended": "1.0.1",
28+
"concurrently": "7.0.0",
29+
"downlevel-dts": "0.10.1",
30+
"rimraf": "3.0.2",
31+
"typedoc": "0.19.2",
32+
"typescript": "~4.6.2"
33+
},
34+
"types": "./dist-types/index.d.ts",
35+
"engines": {
36+
"node": ">=14.0.0"
37+
},
38+
"typesVersions": {
39+
"<4.0": {
40+
"dist-types/*": [
41+
"dist-types/ts3.4/*"
42+
]
43+
}
44+
},
45+
"files": [
46+
"dist-*"
47+
],
48+
"browser": {
49+
"./dist-es/fromUtf8": "./dist-es/fromUtf8.browser",
50+
"./dist-es/toUtf8": "./dist-es/toUtf8.browser"
51+
},
52+
"react-native": {
53+
"./dist-es/fromUtf8": "./dist-es/fromUtf8.browser",
54+
"./dist-es/toUtf8": "./dist-es/toUtf8.browser"
55+
},
56+
"homepage": "https://github.com/aws/aws-sdk-js-v3/tree/main/packages/util-utf8",
57+
"repository": {
58+
"type": "git",
59+
"url": "https://github.com/aws/aws-sdk-js-v3.git",
60+
"directory": "packages/util-utf8"
61+
}
62+
}

‎packages/util-utf8/src/fromUtf8.browser.spec.ts

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
/**
2+
* @jest-environment jsdom
3+
*/
4+
import { fromUtf8 } from "./fromUtf8.browser";
5+
6+
declare const global: any;
7+
8+
describe("fromUtf8", () => {
9+
it("should use the Encoding API", () => {
10+
const expected = new Uint8Array(0);
11+
const encode = jest.fn().mockReturnValue(expected);
12+
(global as any).TextEncoder = jest.fn(() => ({ encode }));
13+
14+
expect(fromUtf8("ABC")).toBe(expected);
15+
});
16+
});

‎packages/util-utf8/src/fromUtf8.browser.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
export const fromUtf8 = (input: string): Uint8Array => new TextEncoder().encode(input);

‎packages/util-utf8/src/fromUtf8.spec.ts

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
import { fromUtf8 } from "./fromUtf8";
2+
3+
const utf8StringsToByteArrays: Record<string, Uint8Array> = {
4+
ABC: new Uint8Array(["A".charCodeAt(0), "B".charCodeAt(0), "C".charCodeAt(0)]),
5+
"🐎👱❤": new Uint8Array([240, 159, 144, 142, 240, 159, 145, 177, 226, 157, 164]),
6+
"☃💩": new Uint8Array([226, 152, 131, 240, 159, 146, 169]),
7+
"The rain in Spain falls mainly on the plain.": new Uint8Array([
8+
84, 104, 101, 32, 114, 97, 105, 110, 32, 105, 110, 32, 83, 112, 97, 105, 110, 32, 102, 97, 108, 108, 115, 32, 109,
9+
97, 105, 110, 108, 121, 32, 111, 110, 32, 116, 104, 101, 32, 112, 108, 97, 105, 110, 46,
10+
]),
11+
"دست‌نوشته‌ها نمی‌سوزند": new Uint8Array([
12+
216, 175, 216, 179, 216, 170, 226, 128, 140, 217, 134, 217, 136, 216, 180, 216, 170, 217, 135, 226, 128, 140, 217,
13+
135, 216, 167, 32, 217, 134, 217, 133, 219, 140, 226, 128, 140, 216, 179, 217, 136, 216, 178, 217, 134, 216, 175,
14+
]),
15+
"Рукописи не горят": new Uint8Array([
16+
208, 160, 209, 131, 208, 186, 208, 190, 208, 191, 208, 184, 209, 129, 208, 184, 32, 208, 189, 208, 181, 32, 208,
17+
179, 208, 190, 209, 128, 209, 143, 209, 130,
18+
]),
19+
};
20+
21+
describe("fromUtf8", () => {
22+
for (const string of Object.keys(utf8StringsToByteArrays)) {
23+
it(`should UTF-8 decode "${string}" to the correct value`, () => {
24+
expect(fromUtf8(string)).toEqual(utf8StringsToByteArrays[string]);
25+
});
26+
}
27+
28+
it("should throw when given a number", () => {
29+
expect(() => fromUtf8(255 as any)).toThrow();
30+
});
31+
});

‎packages/util-utf8/src/fromUtf8.ts

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
import { fromString } from "@aws-sdk/util-buffer-from";
2+
3+
export const fromUtf8 = (input: string): Uint8Array => {
4+
const buf = fromString(input, "utf8");
5+
return new Uint8Array(buf.buffer, buf.byteOffset, buf.byteLength / Uint8Array.BYTES_PER_ELEMENT);
6+
};

‎packages/util-utf8/src/index.ts

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
export * from "./fromUtf8";
2+
export * from "./toUint8Array";
3+
export * from "./toUtf8";

‎packages/util-utf8/src/toUint8Array.spec.ts

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
import { toUint8Array } from "./toUint8Array";
2+
3+
describe("toUint8Array", () => {
4+
it(`should convert string to Uint8Array`, () => {
5+
const expected = new Uint8Array([240, 159, 144, 142, 240, 159, 145, 177, 226, 157, 164]);
6+
expect(toUint8Array("🐎👱❤")).toStrictEqual(expected);
7+
});
8+
it(`should convert ArrayBuffer to Uint8Array`, () => {
9+
const input = new Uint32Array([240]);
10+
const expected = new Uint8Array([240, 0, 0, 0]);
11+
expect(toUint8Array(input)).toStrictEqual(expected);
12+
});
13+
});

‎packages/util-utf8/src/toUint8Array.ts

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
import { fromUtf8 } from "./fromUtf8";
2+
3+
export const toUint8Array = (data: string | ArrayBuffer | ArrayBufferView): Uint8Array => {
4+
if (typeof data === "string") {
5+
return fromUtf8(data);
6+
}
7+
8+
if (ArrayBuffer.isView(data)) {
9+
return new Uint8Array(data.buffer, data.byteOffset, data.byteLength / Uint8Array.BYTES_PER_ELEMENT);
10+
}
11+
12+
return new Uint8Array(data);
13+
};

‎packages/util-utf8/src/toUtf8.browser.spec.ts

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
/**
2+
* @jest-environment jsdom
3+
*/
4+
import { toUtf8 } from "./toUtf8.browser";
5+
6+
declare const global: any;
7+
8+
describe("toUtf8", () => {
9+
it("should use the Encoding API", () => {
10+
const expected = "ABC";
11+
const decode = jest.fn().mockReturnValue(expected);
12+
(global as any).TextDecoder = jest.fn(() => ({ decode }));
13+
14+
expect(toUtf8(new Uint8Array(0))).toBe(expected);
15+
});
16+
});

0 commit comments

Comments
 (0)