feat: initial version

Author: Gozala

.github/workflows/node.js.yml

@@ -0,0 +1,66 @@
+# This workflow will do a clean install of node dependencies, build the source code and run tests across different versions of node
+# For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions
+
+name: Node.js CI
+
+on:
+  push:
+    branches: [default]
+  pull_request:
+    branches: [default]
+
+jobs:
+  test:
+    name: Build & Test
+    runs-on: ${{ matrix.os }}
+
+    strategy:
+      matrix:
+        node-version: [10.x, 12.x, 14.x]
+        os: [ubuntu-latest, windows-latest, macos-latest]
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v1
+        with:
+          node-version: ${{ matrix.node-version }}
+      - name: Cache node_modules
+        id: cache-modules
+        uses: actions/cache@v1
+        with:
+          path: node_modules
+          key: ${{ matrix.node-version }}-${{ runner.OS }}-build-${{ hashFiles('package.json') }}
+      - name: Install
+        if: steps.cache-modules.outputs.cache-hit != 'true'
+        run: npm install
+      - name: Type Check
+        run: npm run check --if-present
+      - name: Test ES
+        run: npm run test:es --if-present
+      - name: Test CommonJS
+        run: npm run test:cjs --if-present
+  publish:
+    name: Publish
+    needs: test
+    runs-on: ubuntu-latest
+    if: github.event_name == 'push' && github.ref == 'refs/heads/default'
+    steps:
+      - uses: actions/checkout@v2
+      - name: Cache node_modules
+        id: cache-modules
+        uses: actions/cache@v1
+        with:
+          path: node_modules
+          key: 12.x-${{ runner.OS }}-build-${{ hashFiles('package.json') }}
+      - name: Install
+        if: steps.cache-modules.outputs.cache-hit != 'true'
+        run: npm install
+      - name: Test
+        run: npm test
+
+      - name: Publish
+        uses: mikeal/merge-release@master
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          NPM_AUTH_TOKEN: ${{ secrets.NPM_AUTH_TOKEN }}

Readme.md

@@ -0,0 +1,35 @@
+# web-encoding
+
+![Node.js CI][node.js ci]
+[![package][version.icon] ![downloads][downloads.icon]][package.url]
+[![styled with prettier][prettier.icon]][prettier.url]
+
+This package provides [TextEncoder][] and [TextDecoder][] [Encoding Standard][]
+APIs in a universal package. In the browsers it just exposes existing globals,
+in nodejs it exposes globals in newer node versions and ones from `util` module
+in older versions.
+
+Package also works as ES module and CommonJS module.
+
+### Usage
+
+```js
+import { TextEncoder, TextDecoder } from "web-encoding"
+```
+
+## Install
+
+    npm install web-encoding
+
+[node.js ci]: https://github.com/Gozala/web-encoding/workflows/Node.js%20CI/badge.svg
+[version.icon]: https://img.shields.io/npm/v/web-encoding.svg
+[downloads.icon]: https://img.shields.io/npm/dm/web-encoding.svg
+[package.url]: https://npmjs.org/package/web-encoding
+[downloads.image]: https://img.shields.io/npm/dm/web-encoding.svg
+[downloads.url]: https://npmjs.org/package/web-encoding
+[prettier.icon]: https://img.shields.io/badge/styled_with-prettier-ff69b4.svg
+[prettier.url]: https://github.com/prettier/prettier
+[ts-jsdoc]: https://www.typescriptlang.org/docs/handbook/jsdoc-supported-types.html
+[textencoder]: https://developer.mozilla.org/en-US/docs/Web/API/TextEncoder
+[textdecoder]: https://developer.mozilla.org/en-US/docs/Web/API/TextDecoder
+[encoding standard]: https://encoding.spec.whatwg.org/

package.json

@@ -0,0 +1,35 @@
+{
+  "name": "web-encoding",
+  "version": "1.0.0",
+  "description": "TextEncoder and TextDecoder APIs from Encoding Standard APIs in a universal package",
+  "keywords": [
+    "TextEncoder",
+    "TextDecoder"
+  ],
+  "type": "module",
+  "browser": "./src/lib.browser.js",
+  "main": "./src/lib.cjs",
+  "module": "./src/lib.js",
+  "types": "./src/lib.d.ts",
+  "exports": {
+    ".": {
+      "import": "./src/lib.js",
+      "require": "./src/lib.cjs.js",
+      "browser": "./src/lib.browser.js"
+    }
+  },
+  "scripts": {
+    "test:node": "mocha test/test-*.spec.cjs",
+    "test:browser": "polendina --cleanup test/test-*.cjs",
+    "test:es": "mocha test/test-*.spec.js",
+    "test:cjs": "npm run test:node && npm run test:browser",
+    "test": "npm run test:es && npm run test:cjs"
+  },
+  "license": "MIT",
+  "author": "Irakli Gozalishvili <[email protected]>",
+  "homepage": "https://github.com/gozala/web-encoding",
+  "devDependencies": {
+    "mocha": "^8.0.1",
+    "polendina": "^1.0.0"
+  }
+}

src/lib.browser.js

@@ -0,0 +1,4 @@
+"use strict"
+
+exports.TextEncoder = TextEncoder
+exports.TextDecoder = TextDecoder

src/lib.cjs

@@ -0,0 +1,7 @@
+"use strict"
+
+exports.TextEncoder =
+  typeof TextEncoder !== "undefined" ? TextEncoder : require("util").TextEncoder
+
+exports.TextDecoder =
+  typeof TextDecoder !== "undefined" ? TextDecoder : require("util").TextDecoder

src/lib.d.ts

@@ -0,0 +1 @@
+export { TextEncoder, TextDecoder }

src/lib.js

@@ -0,0 +1,9 @@
+"use strict"
+
+// In node `export { TextEncoder }` throws:
+// "Export 'TextEncoder' is not definedin module"
+// To workaround we first define constants and then export with as.
+const Encoder = TextEncoder
+const Decoder = TextDecoder
+
+export { Encoder as TextEncoder, Decoder as TextDecoder }

test/test-lib.spec.cjs

@@ -0,0 +1,28 @@
+const { TextEncoder, TextDecoder } = require("..")
+const assert = require("assert")
+
+describe("text encode/decode", () => {
+  const data = Uint8Array.from([
+    104,
+    101,
+    108,
+    108,
+    111,
+    32,
+    119,
+    111,
+    114,
+    108,
+    100,
+  ])
+
+  it("can encode text", () => {
+    const bytes = new TextEncoder().encode("hello world")
+    assert.deepStrictEqual(bytes, data)
+  })
+
+  it("can decode text", () => {
+    const text = new TextDecoder().decode(data)
+    assert.equal(text, "hello world")
+  })
+})

test/test-lib.spec.js

@@ -0,0 +1,28 @@
+import { TextEncoder, TextDecoder } from "../src/lib.js"
+import assert from "assert"
+
+describe("text encode/decode", () => {
+  const data = Uint8Array.from([
+    104,
+    101,
+    108,
+    108,
+    111,
+    32,
+    119,
+    111,
+    114,
+    108,
+    100,
+  ])
+
+  it("can encode text", () => {
+    const bytes = new TextEncoder().encode("hello world")
+    assert.deepStrictEqual(bytes, data)
+  })
+
+  it("can decode text", () => {
+    const text = new TextDecoder().decode(data)
+    assert.equal(text, "hello world")
+  })
+})