typed-array-byte-offset 1.0.1 → 1.0.3

package/CHANGELOG.md

@@ -5,6 +5,28 @@ 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.3](https://github.com/inspect-js/typed-array-byte-offset/compare/v1.0.2...v1.0.3) - 2024-11-21
+
+### Fixed
+
+- [Fix] avoid relying on `__proto__` accessor [`#4`](https://github.com/inspect-js/typed-array-byte-offset/issues/4)
+
+### Commits
+
+- [types] use shared config [`10b0823`](https://github.com/inspect-js/typed-array-byte-offset/commit/10b0823ecc13b95920cfa8f27fe61af5678fb67b)
+- [actions] split out node 10-20, and 20+ [`11554a9`](https://github.com/inspect-js/typed-array-byte-offset/commit/11554a96ca11b85c7ad87118e1d811bfde2b9f32)
+- [Dev Deps] update `@arethetypeswrong/cli`, `@ljharb/eslint-config`, `@types/object-inspect`, `auto-changelog`, `object-inspect`, `tape` [`c39dd06`](https://github.com/inspect-js/typed-array-byte-offset/commit/c39dd06d2868a724463722ff2f416b5c41171140)
+- [Tests] run tsc and `@arethetypeswrong/cli` in CI [`0b984aa`](https://github.com/inspect-js/typed-array-byte-offset/commit/0b984aa64c86f4bcb476b716cdd16d67c39b68ca)
+- [Tests] replace `aud` with `npm audit` [`512b59d`](https://github.com/inspect-js/typed-array-byte-offset/commit/512b59df0e567592282795bfec331193d828f2fc)
+
+## [v1.0.2](https://github.com/inspect-js/typed-array-byte-offset/compare/v1.0.1...v1.0.2) - 2024-02-20
+
+### Commits
+
+- add types [`9eecdd2`](https://github.com/inspect-js/typed-array-byte-offset/commit/9eecdd245b089610d6ad49ef63c9df2b58c3e8a6)
+- [actions] skip ls check on node < 10; remove redundant finisher [`4fb4c91`](https://github.com/inspect-js/typed-array-byte-offset/commit/4fb4c912f5eb8034f4e3705b30f3f7dcc7080039)
+- [Deps] update `available-typed-arrays`, `has-proto` [`805cee2`](https://github.com/inspect-js/typed-array-byte-offset/commit/805cee207d73e12d526ff23d2c161f38283a1ed9)
+
 ## [v1.0.1](https://github.com/inspect-js/typed-array-byte-offset/compare/v1.0.0...v1.0.1) - 2024-02-17
 
 ### Commits

package/index.d.ts

@@ -0,0 +1,17 @@
+type TypedArray =
+	| Int8Array
+	| Uint8Array
+	| Uint8ClampedArray
+	| Int16Array
+	| Uint16Array
+	| Int32Array
+	| Uint32Array
+	| Float32Array
+	| Float64Array
+	| BigInt64Array
+	| BigUint64Array;
+
+declare function typedArrayByteOffset(value: TypedArray): number;
+declare function typedArrayByteOffset(value: unknown): false;
+
+export = typedArrayByteOffset;

package/index.js

@@ -2,15 +2,20 @@
 
 var forEach = require('for-each');
 var callBind = require('call-bind');
+var gPO = require('reflect.getprototypeof/polyfill')();
 
 var typedArrays = require('available-typed-arrays')();
 
+/** @typedef {Int8Array | Uint8Array | Uint8ClampedArray | Int16Array | Uint16Array | Int32Array | Uint32Array | Float32Array | Float64Array | BigInt64Array | BigUint64Array} TypedArray */
+/** @typedef {(x: TypedArray) => number} ByteOffsetGetter */
+
+/** @type {Object.<typeof typedArrays, ByteOffsetGetter>} */
 var getters = {};
-var hasProto = require('has-proto')();
 
 var gOPD = require('gopd');
 var oDP = Object.defineProperty;
 if (gOPD) {
+	/** @type {ByteOffsetGetter} */
 	var getByteOffset = function (x) {
 		return x.byteOffset;
 	};
@@ -18,9 +23,11 @@ if (gOPD) {
 		// In Safari 7, Typed Array constructors are typeof object
 		if (typeof global[typedArray] === 'function' || typeof global[typedArray] === 'object') {
 			var Proto = global[typedArray].prototype;
+			// @ts-expect-error TS can't guarantee the callback is invoked sync
 			var descriptor = gOPD(Proto, 'byteOffset');
-			if (!descriptor && hasProto) {
-				var superProto = Proto.__proto__; // eslint-disable-line no-proto
+			if (!descriptor) {
+				var superProto = gPO(Proto);
+				// @ts-expect-error TS can't guarantee the callback is invoked sync
 				descriptor = gOPD(superProto, 'byteOffset');
 			}
 			// Opera 12.16 has a magic byteOffset data property on instances AND on Proto
@@ -29,6 +36,7 @@ if (gOPD) {
 			} else if (oDP) {
 				// this is likely an engine where instances have a magic byteOffset data property
 				var arr = new global[typedArray](2);
+				// @ts-expect-error TS can't guarantee the callback is invoked sync
 				descriptor = gOPD(arr, 'byteOffset');
 				if (descriptor && descriptor.configurable) {
 					oDP(arr, 'length', { value: 3 });
@@ -41,9 +49,10 @@ if (gOPD) {
 	});
 }
 
+/** @type {ByteOffsetGetter} */
 var tryTypedArrays = function tryAllTypedArrays(value) {
-	var foundOffset;
-	forEach(getters, function (getter) {
+	/** @type {number} */ var foundOffset;
+	forEach(getters, /** @type {(getter: ByteOffsetGetter) => void} */ function (getter) {
 		if (typeof foundOffset !== 'number') {
 			try {
 				var offset = getter(value);
@@ -53,11 +62,13 @@ var tryTypedArrays = function tryAllTypedArrays(value) {
 			} catch (e) {}
 		}
 	});
+	// @ts-expect-error TS can't guarantee the callback is invoked sync
 	return foundOffset;
 };
 
 var isTypedArray = require('is-typed-array');
 
+/** @type {import('.')} */
 module.exports = function typedArrayByteOffset(value) {
 	if (!isTypedArray(value)) {
 		return false;

package/package.json

@@ -1,12 +1,13 @@
 {
 	"name": "typed-array-byte-offset",
-	"version": "1.0.1",
+	"version": "1.0.3",
 	"description": "Robustly get the byte offset of a Typed Array",
 	"main": "index.js",
 	"exports": {
 		".": "./index.js",
 		"./package.json": "./package.json"
 	},
+	"types": "./index.d.ts",
 	"sideEffects": false,
 	"scripts": {
 		"prepack": "npmignore --auto --commentLines=autogenerated",
@@ -15,9 +16,10 @@
 		"pretest": "npm run lint",
 		"prelint": "evalmd README.md",
 		"lint": "eslint --ext=js,mjs .",
+		"postlint": "tsc -p . && attw -P",
 		"tests-only": "nyc tape 'test/**/*.js'",
 		"test": "npm run tests-only",
-		"posttest": "aud --production",
+		"posttest": "npx npm@'>=10.2' audit --production",
 		"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)\")\""
 	},
@@ -55,17 +57,28 @@
 	},
 	"homepage": "https://github.com/inspect-js/typed-array-byte-offset#readme",
 	"dependencies": {
-		"available-typed-arrays": "^1.0.6",
+		"available-typed-arrays": "^1.0.7",
 		"call-bind": "^1.0.7",
 		"for-each": "^0.3.3",
 		"gopd": "^1.0.1",
-		"has-proto": "^1.0.1",
-		"is-typed-array": "^1.1.13"
+		"has-proto": "^1.0.3",
+		"is-typed-array": "^1.1.13",
+		"reflect.getprototypeof": "^1.0.6"
 	},
 	"devDependencies": {
-		"@ljharb/eslint-config": "^21.1.0",
-		"aud": "^2.0.4",
-		"auto-changelog": "^2.4.0",
+		"@arethetypeswrong/cli": "^0.17.0",
+		"@ljharb/eslint-config": "^21.1.1",
+		"@ljharb/tsconfig": "^0.2.0",
+		"@types/call-bind": "^1.0.5",
+		"@types/es-abstract": "^1.17.9",
+		"@types/for-each": "^0.3.3",
+		"@types/gopd": "^1.0.3",
+		"@types/is-callable": "^1.1.2",
+		"@types/make-arrow-function": "^1.2.2",
+		"@types/make-generator-function": "^2.0.3",
+		"@types/object-inspect": "^1.13.0",
+		"@types/tape": "^5.6.4",
+		"auto-changelog": "^2.5.0",
 		"eslint": "=8.8.0",
 		"evalmd": "^0.0.19",
 		"in-publish": "^2.0.1",
@@ -74,9 +87,11 @@
 		"make-generator-function": "^2.0.0",
 		"npmignore": "^0.3.1",
 		"nyc": "^10.3.2",
-		"object-inspect": "^1.13.1",
+		"object-inspect": "^1.13.3",
+		"possible-typed-array-names": "^1.0.0",
 		"safe-publish-latest": "^2.0.0",
-		"tape": "^5.7.5"
+		"tape": "^5.9.0",
+		"typescript": "next"
 	},
 	"engines": {
 		"node": ">= 0.4"
@@ -94,7 +109,8 @@
 	},
 	"publishConfig": {
 		"ignore": [
-			".github/workflows"
+			".github/workflows",
+			"types"
 		]
 	}
 }

package/test/index.js

@@ -8,22 +8,11 @@ var arrowFn = require('make-arrow-function')();
 var forEach = require('for-each');
 var inspect = require('object-inspect');
 
-var typedArrayNames = [
-	'Int8Array',
-	'Uint8Array',
-	'Uint8ClampedArray',
-	'Int16Array',
-	'Uint16Array',
-	'Int32Array',
-	'Uint32Array',
-	'Float32Array',
-	'Float64Array',
-	'BigInt64Array',
-	'BigUint64Array'
-];
+var typedArrayNames = require('possible-typed-array-names');
 
 test('not arrays', function (t) {
 	t.test('non-number/string primitives', function (st) {
+		// @ts-expect-error
 		st.equal(false, typedArrayByteOffset(), 'undefined is not typed array');
 		st.equal(false, typedArrayByteOffset(null), 'null is not typed array');
 		st.equal(false, typedArrayByteOffset(false), 'false is not typed array');
@@ -78,6 +67,7 @@ test('Typed Arrays', function (t) {
 		var buffer = new ArrayBuffer(length);
 		var TypedArray = global[typedArray];
 		if (isCallable(TypedArray)) {
+			// @ts-expect-error hush, TS, TAs can take an optional byte offset arg
 			var arr = new TypedArray(buffer, byteOffset);
 			t.equal(typedArrayByteOffset(arr), byteOffset, 'new ' + typedArray + '(new ArrayBuffer(' + length + '), ' + byteOffset + ') is typed array of byte offset ' + byteOffset);
 		} else {

package/tsconfig.json

@@ -0,0 +1,10 @@
+{
+	"extends": "@ljharb/tsconfig",
+	"compilerOptions": {
+		"target": "ES2021",
+		"maxNodeModuleJsDepth": 0,
+	},
+	"exclude": [
+		"coverage",
+	],
+}