typedarray.prototype.slice 1.0.0

package/.editorconfig

@@ -0,0 +1,13 @@
+root = true
+
+[*]
+indent_style = tab;
+insert_final_newline = true;
+quote_type = auto;
+space_after_anonymous_functions = true;
+space_after_control_statements = true;
+spaces_around_operators = true;
+trim_trailing_whitespace = true;
+spaces_in_brackets = false;
+end_of_line = lf;
+

package/.eslintrc

@@ -0,0 +1,55 @@
+{
+	"root": true,
+
+	"extends": "@ljharb",
+
+	"globals": {
+		"Float32Array": false,
+		"Float64Array": false,
+		"Int16Array": false,
+		"Int32Array": false,
+		"Int8Array": false,
+		"Uint16Array": false,
+		"Uint32Array": false,
+		"Uint8Array": false,
+		"Uint8ClampedArray": false,
+	},
+
+	"rules": {
+		"func-style": 0,
+		"id-length": 0,
+		"max-lines-per-function": 0,
+		"max-params": 0,
+		"max-statements": 0,
+		"multiline-comment-style": 0,
+		"new-cap": [2, {
+			"capIsNewExceptions": [
+				"Get",
+				"GetIntrinsic",
+				"GetValueFromBuffer",
+				"IsDetachedBuffer",
+				"Set",
+				"SetValueInBuffer",
+				"ToIntegerOrInfinity",
+				"ToString",
+				"TypedArrayElementSize",
+				"TypedArrayElementType",
+				"TypedArraySpeciesCreate",
+				"ValidateTypedArray",
+			],
+		}],
+	},
+
+	"overrides": [
+		{
+			"files": "test/**",
+			"globals": {
+				"ArrayBuffer": false,
+				"Uint8Array": false,
+			},
+			"rules": {
+				"max-lines-per-function": 0,
+			},
+		},
+	],
+}

package/.nycrc

@@ -0,0 +1,9 @@
+{
+	"all": true,
+	"check-coverage": false,
+	"reporter": ["text-summary", "text", "html", "json"],
+	"exclude": [
+		"coverage",
+		"test"
+	]
+}

package/CHANGELOG.md

@@ -0,0 +1,18 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## v1.0.0 - 2023-07-18
+
+### Commits
+
+- Initial implementation, tests, readme [`7684f32`](https://github.com/es-shims/TypedArray.prototype.slice/commit/7684f32983b444734c6293af807fcf5f3e20a9ad)
+- Initial commit [`e4ff962`](https://github.com/es-shims/TypedArray.prototype.slice/commit/e4ff962b319dbc568f48e312e0396130e91d5df4)
+- [Fix] node v0.11.4 - 3 have an own slice method that works incorrectly [`361b2c6`](https://github.com/es-shims/TypedArray.prototype.slice/commit/361b2c6046f756fb6f6851b0d8759b5e88324521)
+- [Fix] `node < v0.6` lacks proper toString behavior on Typed Arrays [`bcf30f9`](https://github.com/es-shims/TypedArray.prototype.slice/commit/bcf30f916c59d2744f5a0c2e8a9ea38da2092413)
+- npm init [`a24ef46`](https://github.com/es-shims/TypedArray.prototype.slice/commit/a24ef465139926277e5b85b8d9b17e96070aa6c8)
+- [Fix] update `es-abstract` and move it to runtime deps [`b70eb79`](https://github.com/es-shims/TypedArray.prototype.slice/commit/b70eb7926485148733d56bec6c9ce91ac820bd0d)
+- Only apps should have lockfiles [`3361cbe`](https://github.com/es-shims/TypedArray.prototype.slice/commit/3361cbe1c5a986a194f250360cfd4a52a2e255a5)

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 ECMAScript Shims
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,65 @@
+# ArrayBuffer.prototype.slice <sup>[![Version Badge][npm-version-svg]][package-url]</sup>
+
+[![github actions][actions-image]][actions-url]
+[![coverage][codecov-image]][codecov-url]
+[![License][license-image]][license-url]
+[![Downloads][downloads-image]][downloads-url]
+
+[![npm badge][npm-badge-png]][package-url]
+
+An ES spec-compliant `ArrayBuffer.prototype.slice` shim. Invoke its "shim" method to shim ArrayBuffer.prototype.slice if it is unavailable.
+
+This package implements the [es-shim API](https://github.com/es-shims/api) interface. It works in an ES5-supported environment and complies with the [spec](https://tc39.es/ecma262/#sec-arraybuffer.prototype.slice).
+
+Most common usage:
+```js
+var assert = require('assert');
+var slice = require('typedarray.prototype.slice');
+
+var arr = new Uint8Array([1, 2, 3]);
+
+var arr2 = slice(arr);
+
+arr2[0] = 2;
+arr2[1] = 3;
+
+assert.deepEqual(arr, new Uint8Array([1, 2, 3]));
+assert.deepEqual(arr2, new Uint8Array([2, 3, 3]));
+assert.notEqual(arr.buffer, arr2.buffer);
+
+if (!ArrayBuffer.prototype.transfer) {
+	slice.shim();
+}
+
+var arr3 = arr.slice();
+arr3[0] = 2;
+arr3[1] = 3;
+
+assert.deepEqual(arr, new Uint8Array([1, 2, 3]));
+assert.deepEqual(arr3, new Uint8Array([2, 3, 3]));
+assert.notEqual(arr.buffer, arr3.buffer);
+```
+
+## Engines where this is needed
+
+	- node v0.11.4 - v4: no prototype or own `slice` method
+	- node < v0.11.3: own `slice` method that fails to clone the underlying buffer
+
+## Tests
+Simply clone the repo, `npm install`, and run `npm test`
+
+[package-url]: https://npmjs.org/package/arraybuffer.prototype.slice
+[npm-version-svg]: https://versionbadg.es/es-shims/ArrayBuffer.prototype.slice.svg
+[deps-svg]: https://david-dm.org/es-shims/ArrayBuffer.prototype.slice.svg
+[deps-url]: https://david-dm.org/es-shims/ArrayBuffer.prototype.slice
+[dev-deps-svg]: https://david-dm.org/es-shims/ArrayBuffer.prototype.slice/dev-status.svg
+[dev-deps-url]: https://david-dm.org/es-shims/ArrayBuffer.prototype.slice#info=devDependencies
+[npm-badge-png]: https://nodei.co/npm/arraybuffer.prototype.slice.png?downloads=true&stars=true
+[license-image]: https://img.shields.io/npm/l/arraybuffer.prototype.slice.svg
+[license-url]: LICENSE
+[downloads-image]: https://img.shields.io/npm/dm/arraybuffer.prototype.slice.svg
+[downloads-url]: https://npm-stat.com/charts.html?package=arraybuffer.prototype.slice
+[codecov-image]: https://codecov.io/gh/es-shims/ArrayBuffer.prototype.slice/branch/main/graphs/badge.svg
+[codecov-url]: https://app.codecov.io/gh/es-shims/ArrayBuffer.prototype.slice/
+[actions-image]: https://img.shields.io/endpoint?url=https://github-actions-badge-u3jn4tfpocch.runkit.sh/es-shims/ArrayBuffer.prototype.slice
+[actions-url]: https://github.com/es-shims/ArrayBuffer.prototype.slice/actions

package/auto.js

@@ -0,0 +1,3 @@
+'use strict';
+
+require('./shim')();

package/implementation.js

@@ -0,0 +1,94 @@
+'use strict';
+
+var GetIntrinsic = require('get-intrinsic');
+
+var $TypeError = GetIntrinsic('%TypeError%');
+
+var Get = require('es-abstract/2023/Get');
+var GetValueFromBuffer = require('es-abstract/2023/GetValueFromBuffer');
+var IsDetachedBuffer = require('es-abstract/2023/IsDetachedBuffer');
+var max = require('es-abstract/2023/max');
+var min = require('es-abstract/2023/min');
+var Set = require('es-abstract/2023/Set');
+var SetValueInBuffer = require('es-abstract/2023/SetValueInBuffer');
+var ToIntegerOrInfinity = require('es-abstract/2023/ToIntegerOrInfinity');
+var ToString = require('es-abstract/2023/ToString');
+var TypedArrayElementSize = require('es-abstract/2023/TypedArrayElementSize');
+var TypedArrayElementType = require('es-abstract/2023/TypedArrayElementType');
+var TypedArraySpeciesCreate = require('es-abstract/2023/TypedArraySpeciesCreate');
+var ValidateTypedArray = require('es-abstract/2023/ValidateTypedArray');
+
+var typedArrayBuffer = require('typed-array-buffer');
+var typedArrayByteOffset = require('typed-array-byte-offset');
+
+// https://tc39.es/ecma262/#sec-%typedarray%.prototype.slice
+
+module.exports = function slice(start, end) {
+	var O = this; // step 1
+
+	ValidateTypedArray(O); // step 2
+
+	// 3. Let len be O.[[ArrayLength]].
+	var len = O.length; // steps 3
+
+	var relativeStart = ToIntegerOrInfinity(start); // step 4
+
+	var k;
+	if (relativeStart === -Infinity) {
+		k = 0; // step 5
+	} else if (relativeStart < 0) {
+		k = max(len + relativeStart, 0); // step 6
+	} else {
+		k = min(relativeStart, len); // step 7
+	}
+
+	var relativeEnd = typeof end === 'undefined' ? len : ToIntegerOrInfinity(end); // step 8
+
+	var final;
+	if (relativeEnd === -Infinity) {
+		final = 0; // step 9
+	} else if (relativeEnd < 0) {
+		final = max(len + relativeEnd, 0); // step 10
+	} else {
+		final = min(relativeEnd, len); // step 11
+	}
+
+	var count = max(final - k, 0); // step 12
+
+	var A = TypedArraySpeciesCreate(O, [count]); // step 13
+
+	if (count > 0) { // step 14
+		if (IsDetachedBuffer(typedArrayBuffer(O))) {
+			throw new $TypeError('Cannot use a Typed Array with an underlying ArrayBuffer that is detached'); // step 14.a
+		}
+		var srcType = TypedArrayElementType(O); // step 14.b
+		var targetType = TypedArrayElementType(A); // step 14.c
+		if (srcType === targetType) { // step 14.d
+			//  1. NOTE: The transfer must be performed in a manner that preserves the bit-level encoding of the source data.
+			var srcBuffer = typedArrayBuffer(O); // step 14.d.ii
+			var targetBuffer = typedArrayBuffer(A); // step 14.d.iii
+			var elementSize = TypedArrayElementSize(O); // step 14.d.iv
+			var srcByteOffset = typedArrayByteOffset(O); // step 14.d.v
+			var srcByteIndex = (k * elementSize) + srcByteOffset; // step 14.d.vi
+			var targetByteIndex = typedArrayByteOffset(A); // step 14.d.vii
+			var limit = targetByteIndex + (count * elementSize); // step 14.d.viii
+			while (targetByteIndex < limit) { // step 14.d.ix
+				var value = GetValueFromBuffer(srcBuffer, srcByteIndex, 'Uint8', true, 'Unordered'); // step 14.d.ix.1
+				SetValueInBuffer(targetBuffer, targetByteIndex, 'Uint8', value, true, 'Unordered'); // step 14.d.ix.2
+				srcByteIndex += 1; // step 14.d.ix.3
+				targetByteIndex += 1; // step 14.d.ix.4
+			}
+		} else { // step 14.e
+			var n = 0; // step 14.e.i
+			while (k < final) { // step 14.e.ii
+				var Pk = ToString(k); // step 14.e.ii.1
+				var kValue = Get(O, Pk); // step 14.e.ii.2
+				Set(A, ToString(n), kValue, true); // step 14.e.ii.3
+				k += 1; // step 14.e.ii.4
+				n += 1; // step 14.e.ii.5
+			}
+		}
+	}
+
+	return A; // step 15
+};

package/index.js

@@ -0,0 +1,18 @@
+'use strict';
+
+var define = require('define-properties');
+var callBind = require('call-bind');
+
+var implementation = require('./implementation');
+var getPolyfill = require('./polyfill');
+var shim = require('./shim');
+
+var bound = callBind(getPolyfill());
+
+define(bound, {
+	getPolyfill: getPolyfill,
+	implementation: implementation,
+	shim: shim
+});
+
+module.exports = bound;

package/package.json

@@ -0,0 +1,102 @@
+{
+	"name": "typedarray.prototype.slice",
+	"version": "1.0.0",
+	"description": "ES spec-compliant shim for TypedArray.prototype.slice",
+	"author": "Jordan Harband <ljharb@gmail.com>",
+	"funding": {
+		"url": "https://github.com/sponsors/ljharb"
+	},
+	"license": "MIT",
+	"main": "index.js",
+	"exports": {
+		".": "./index.js",
+		"./auto": "./auto.js",
+		"./polyfill": "./polyfill.js",
+		"./implementation": "./implementation.js",
+		"./shim": "./shim.js",
+		"./package.json": "./package.json"
+	},
+	"scripts": {
+		"prepack": "npmignore --auto --commentLines=autogenerated",
+		"prepublish": "not-in-publish || npm run prepublishOnly",
+		"prepublishOnly": "safe-publish-latest",
+		"pretest": "npm run lint",
+		"test": "npm run tests-only",
+		"posttest": "aud --production",
+		"tests-only": "nyc tape 'test/**/*.js'",
+		"prelint": "eclint check $(git ls-files | xargs find 2> /dev/null | grep -vE 'node_modules|\\.git')",
+		"lint": "eslint --ext=js,mjs .",
+		"postlint": "evalmd README.md && es-shim-api --bound",
+		"version": "auto-changelog && git add CHANGELOG.md",
+		"postversion": "auto-changelog && git add CHANGELOG.md && git commit --no-edit --amend && git tag -f \"v$(node -e \"console.log(require('./package.json').version)\")\""
+	},
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/es-shims/TypedArray.prototype.slice.git"
+	},
+	"homepage": "https://github.com/es-shims/TypedArray.prototype.slice#readme",
+	"bugs": {
+		"url": "https://github.com/es-shims/TypedArray.prototype.slice/issues"
+	},
+	"keywords": [
+		"javascript",
+		"ecmascript",
+		"TypedArray.prototype.slice",
+		"polyfill",
+		"shim",
+		"Typed Arrays",
+		"array",
+		"buffer",
+		"TypedArray#slice",
+		"slice",
+		"typed array",
+		"es-shim API"
+	],
+	"dependencies": {
+		"call-bind": "^1.0.2",
+		"define-properties": "^1.2.0",
+		"es-abstract": "^1.22.1",
+		"get-intrinsic": "^1.2.1",
+		"typed-array-buffer": "^1.0.0",
+		"typed-array-byte-offset": "^1.0.0"
+	},
+	"devDependencies": {
+		"@es-shims/api": "^2.4.2",
+		"@ljharb/eslint-config": "^21.1.0",
+		"aud": "^2.0.3",
+		"auto-changelog": "^2.4.0",
+		"available-typed-arrays": "^1.0.5",
+		"eclint": "^2.8.1",
+		"es-value-fixtures": "^1.4.2",
+		"eslint": "=8.8.0",
+		"evalmd": "^0.0.19",
+		"for-each": "^0.3.3",
+		"functions-have-names": "^1.2.3",
+		"has-strict-mode": "^1.0.1",
+		"in-publish": "^2.0.1",
+		"npmignore": "^0.3.0",
+		"nyc": "^10.3.2",
+		"object-inspect": "^1.12.3",
+		"safe-publish-latest": "^2.0.0",
+		"tape": "^5.6.6"
+	},
+	"testling": {
+		"files": "test/index.js"
+	},
+	"engines": {
+		"node": ">= 0.4"
+	},
+	"auto-changelog": {
+		"output": "CHANGELOG.md",
+		"template": "keepachangelog",
+		"unreleased": false,
+		"commitLimit": false,
+		"backfillLimit": false,
+		"hideCredit": true
+	},
+	"publishConfig": {
+		"ignore": [
+			".github/workflows"
+		]
+	}
+}

package/polyfill.js

@@ -0,0 +1,7 @@
+'use strict';
+
+var implementation = require('./implementation');
+
+module.exports = function getPolyfill() {
+	return (typeof Uint8Array === 'function' && Uint8Array.prototype.slice) || implementation;
+};

package/shim.js

@@ -0,0 +1,20 @@
+'use strict';
+
+var define = require('define-properties');
+var getProto = require('es-abstract/helpers/getProto');
+
+var getPolyfill = require('./polyfill');
+
+module.exports = function shimTypedArraySlice() {
+	if (typeof Uint8Array === 'function') {
+		var polyfill = getPolyfill();
+		var proto = getProto(Uint8Array.prototype);
+		define(
+			proto,
+			{ slice: polyfill },
+			{ slice: function () { return proto.slice !== polyfill; } }
+		);
+	}
+
+	return polyfill;
+};

package/test/implementation.js

@@ -0,0 +1,25 @@
+'use strict';
+
+var implementation = require('../implementation');
+var callBind = require('call-bind');
+var test = require('tape');
+var hasStrictMode = require('has-strict-mode')();
+var runTests = require('./tests');
+
+test('as a function', function (t) {
+	t.test('bad array/this value', { skip: !hasStrictMode }, function (st) {
+		/* eslint no-useless-call: 0 */
+		st['throws'](function () { implementation.call(undefined); }, TypeError, 'undefined is not an object');
+		st['throws'](function () { implementation.call(null); }, TypeError, 'null is not an object');
+
+		st.end();
+	});
+
+	t.test('Typed Array support', { skip: typeof Uint8Array === 'undefined' }, function (st) {
+		runTests(callBind(implementation), st);
+
+		st.end();
+	});
+
+	t.end();
+});

package/test/index.js

@@ -0,0 +1,22 @@
+'use strict';
+
+var index = require('../');
+var test = require('tape');
+var runTests = require('./tests');
+
+test('as a function', function (t) {
+	t.test('bad array/this value', function (st) {
+		st['throws'](function () { index(undefined); }, TypeError, 'undefined is not an object');
+		st['throws'](function () { index(null); }, TypeError, 'null is not an object');
+
+		st.end();
+	});
+
+	t.test('Typed Array support', { skip: typeof Uint8Array === 'undefined' }, function (st) {
+		runTests(index, st);
+
+		st.end();
+	});
+
+	t.end();
+});

package/test/shimmed.js

@@ -0,0 +1,56 @@
+'use strict';
+
+require('../auto');
+
+var test = require('tape');
+var defineProperties = require('define-properties');
+var callBind = require('call-bind');
+
+var isEnumerable = Object.prototype.propertyIsEnumerable;
+var functionsHaveNames = require('functions-have-names')();
+var hasStrictMode = require('has-strict-mode')();
+var getProto = require('es-abstract/helpers/getProto');
+
+var runTests = require('./tests');
+
+test('shimmed', function (t) {
+	t.test('Typed Array support', { skip: typeof Uint8Array === 'undefined' }, function (st) {
+		var proto = getProto(Uint8Array.prototype);
+		var method = proto.slice;
+
+		st.equal(method.length, 2, 'TypedArray#slice has a length of 2');
+
+		st.test('Function name', { skip: !functionsHaveNames }, function (s2t) {
+			s2t.equal(method.name, 'slice', 'TypedArray#slice name "slice"');
+			s2t.end();
+		});
+
+		st.test('enumerability', { skip: !defineProperties.supportsDescriptors }, function (et) {
+			et.equal(false, isEnumerable.call(proto, 'slice'), 'TypedArray#slice is not enumerable');
+			et.end();
+		});
+
+		st.test('bad array/this value', { skip: !hasStrictMode }, function (s2t) {
+			/* eslint no-useless-call: 0 */
+			s2t['throws'](function () { return method.call(undefined); }, TypeError, 'undefined is not an object');
+			s2t['throws'](function () { return method.call(null); }, TypeError, 'null is not an object');
+			s2t.end();
+		});
+
+		t.test('has the correct descriptor', { skip: !Object.getOwnPropertyDescriptor }, function (s2t) {
+			var descriptor = Object.getOwnPropertyDescriptor(proto, 'slice');
+
+			s2t.equal(descriptor.configurable, true);
+			s2t.equal(descriptor.enumerable, false);
+			s2t.equal(typeof descriptor.value, 'function');
+			s2t.equal(descriptor.writable, true);
+			s2t.end();
+		});
+
+		runTests(callBind(method), st);
+
+		st.end();
+	});
+
+	t.end();
+});

package/test/tests.js

@@ -0,0 +1,49 @@
+'use strict';
+
+var inspect = require('object-inspect');
+// var IsDetachedBuffer = require('es-abstract/2023/IsDetachedBuffer');
+
+var forEach = require('for-each');
+var availableTypedArrays = require('available-typed-arrays')();
+var v = require('es-value-fixtures');
+
+module.exports = function runTests(slice, t) {
+	forEach(v.primitives.concat(v.objects), function (nonTA) {
+		t['throws'](
+			function () { slice(nonTA); },
+			TypeError,
+			inspect(nonTA) + ' is not a Typed Array'
+		);
+	});
+
+	t.test('Typed Arrays', { skip: availableTypedArrays.length === 0 }, function (st) {
+		forEach(availableTypedArrays, function (name) {
+			st.test(name, function (s2t) {
+				var TA = global[name];
+				var isBigInt = name.slice(0, 3) === 'Big';
+
+				var ta = new TA(isBigInt ? [BigInt(1), BigInt(2), BigInt(3)] : [1, 2, 3]);
+
+				var copy = slice(ta);
+				s2t.notEqual(copy, ta, 'returns a new instance when sliced with no args');
+				s2t.ok(copy instanceof TA, 'returns an instance of the same type when sliced with no args');
+				s2t.deepEqual(copy, ta, 'returns a new instance with the same values when sliced with no args');
+				s2t.notEqual(copy.buffer, ta.buffer, 'the new instance has a different buffer than the original when sliced with no args');
+
+				var subset = slice(ta, 1);
+				s2t.notEqual(subset, ta, 'returns a new instance when sliced with a start index');
+				s2t.ok(copy instanceof TA, 'returns an instance of the same type when sliced with a start index');
+				s2t.deepEqual(
+					subset,
+					new TA(isBigInt ? [BigInt(2), BigInt(3)] : [2, 3]),
+					'returns a new instance with the expected subset of values when sliced with a start index'
+				);
+				s2t.notEqual(copy.buffer, ta.buffer, 'the new instance has a different buffer than the original when sliced with a start index');
+
+				s2t.end();
+			});
+		});
+
+		return st.end();
+	});
+};