Transfer repository to purescript-contrib

To transfer the repository, refactor to remove the dependencies
on __typelevel__ and __quickcheck-combinators__.

Prep for v11.

Repair some purs v0.14 warnings.

Author: jamesdbrock

.gitignore

@@ -8,3 +8,4 @@ yarn-error.log
 yarn.lock
 generated-docs/
 .spago/
+.psc-ide-port

CHANGELOG.md

@@ -0,0 +1,22 @@
+# v11 2021-06-21
+
+Jorge Acereda has graciously donated this package to __purescript-contrib__.
+For version 11, we have refactored this library so that it depends only on
+other packages in __purescript-contrib__.
+
+https://github.com/purescript-contrib/governance/issues/40
+
+We have removed the dependencies on these non-__purescript-contrib__ packages:
+
+* https://pursuit.purescript.org/packages/purescript-typelevel
+* https://pursuit.purescript.org/packages/purescript-quickcheck-combinators
+
+To upgrade to v11, you might need to do a few simple substitutions
+to the type declarations in your own dependent code:
+
+* Replace the type `AProxy` with `Proxy` from the Prelude.
+* Remove most of the `Nat` typeclass constraints. https://github.com/purescript-contrib/purescript-arraybuffer/issues/29
+* Replace any `BytesPerValue a b` typeclass constraints with `BytesPerType a`.
+
+In v11 of this package, we have also upgraded to PureScript v0.14.
+

README.md

@@ -1,12 +1,18 @@
 # purescript-arraybuffer
+[![CI](https://github.com/purescript-contrib/purescript-arraybuffer/workflows/CI/badge.svg?branch=main)](https://github.com/purescript-contrib/purescript-arraybuffer/actions?query=workflow%3ACI+branch%3Amain)
+[![Release](https://img.shields.io/github/release/purescript-contrib/purescript-arraybuffer.svg)](https://github.com/purescript-contrib/purescript-arraybuffer/releases)
+[![Pursuit](https://pursuit.purescript.org/packages/purescript-arraybuffer/badge)](https://pursuit.purescript.org/packages/purescript-arraybuffer)
+[![Maintainer: natefaubion](https://img.shields.io/badge/maintainer-jamesdbrock-teal.svg)](https://github.com/jamesdbrock)
 
 ArrayBuffer bindings for PureScript.
 
 
+
 ## Installation
 
+Install `arraybuffer` with [Spago](https://github.com/purescript/spago):
 ```
-	bower install purescript-arraybuffer
+spago install purescript-arraybuffer
 ```
 
 ## Documentation

package.json

@@ -1,6 +1,6 @@
 {
   "name": "purescript-arraybuffer",
-  "version": "9.0.0",
+  "version": "11.0.0",
   "main": "index.js",
   "repository": "[email protected]:jacereda/purescript-arraybuffer.git",
   "author": "https://github.com/jacereda",

packages.dhall

@@ -25,7 +25,7 @@ let additions =
       , "quickcheck"
       , "quickcheck-laws"
       ]
-    , repo = "https://github.com/zaquest/purescript-uint.git"
+    , repo = "https://github.com/purescript-contrib/purescript-uint.git"
     , version = "v5.1.4"
     }
   }

spago.dhall

@@ -13,14 +13,13 @@
   , "partial"
   , "prelude"
   , "quickcheck"
-  , "quickcheck-combinators"
   , "quickcheck-laws"
   , "refs"
   , "tailrec"
-  , "typelevel"
   , "typelevel-prelude"
   , "uint"
   , "unfoldable"
+  , "tuples"
   ]
 , packages = ./packages.dhall
 , sources = [ "src/**/*.purs", "test/**/*.purs" ]

src/Data/ArrayBuffer/ArrayBuffer.purs

@@ -1,6 +1,5 @@
 -- | This module represents the functional bindings to JavaScript's `ArrayBuffer`
 -- | objects. See [MDN's spec](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer) for details.
-
 module Data.ArrayBuffer.ArrayBuffer
   ( empty
   , byteLength

src/Data/ArrayBuffer/DataView.purs

@@ -1,9 +1,7 @@
 -- | This module represents the functional bindings to JavaScript's `DataView`
 -- | objects. See [MDN's spec](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/DataView) for details.
-
 module Data.ArrayBuffer.DataView
-       ( AProxy (..)
-       , Endian (..)
+       ( Endian(..)
        , buffer
        , byteLength
        , byteOffset
@@ -46,20 +44,25 @@ module Data.ArrayBuffer.DataView
        , whole
        ) where
 
-import Data.ArrayBuffer.Types (ArrayBuffer, ByteLength, ByteOffset, DataView, Float32, Float64, Int16, Int32, Int8, Uint16, Uint32, Uint8, kind ArrayViewType)
-import Data.ArrayBuffer.ValueMapping (class BinaryValue, class BytesPerValue, class ShowArrayViewType)
+import Data.ArrayBuffer.Types (ArrayBuffer, ByteLength, ByteOffset, DataView, Float32, Float64, Int16, Int32, Int8, Uint16, Uint32, Uint8)
+import Data.ArrayBuffer.ValueMapping (class BinaryValue, class BytesPerType, class ShowArrayViewType, byteWidth)
 import Data.Float32 (Float32) as F
 import Data.Maybe (Maybe)
 import Data.Nullable (Nullable, toMaybe)
 import Data.Symbol (SProxy(..), class IsSymbol, reflectSymbol)
-import Data.Typelevel.Num (toInt', class Nat)
 import Data.UInt (UInt)
 import Effect (Effect)
 import Effect.Uncurried (EffectFn2, EffectFn3, EffectFn4, runEffectFn2, runEffectFn3, runEffectFn4)
 import Prelude (class Eq, (<$>), (<>), (==))
 import Type.Proxy (Proxy(..))
 
+-- | Endianness of a multi-byte type. Little-Endian or Big-Endian.
+data Endian = LE | BE
 
+instance eqEndian :: Eq Endian where
+  eq LE LE = true
+  eq BE BE = true
+  eq _ _ = false
 
 -- | View mapping the whole `ArrayBuffer`.
 foreign import whole :: ArrayBuffer -> DataView
@@ -85,15 +88,6 @@ foreign import byteOffset :: DataView -> ByteOffset
 foreign import byteLength :: DataView -> ByteLength
 
 
-data AProxy (a :: ArrayViewType) = AProxy
-
-data Endian = LE | BE
-
-instance eqEndian :: Eq Endian where
-  eq LE LE = true
-  eq BE BE = true
-  eq _ _ = false
-
 
 getter :: forall t.
           { functionName :: String
@@ -115,38 +109,35 @@ foreign import getterImpl :: forall t
 
 
 
-get :: forall a name t b
+get :: forall a name t
      . BinaryValue a t
-    => BytesPerValue a b
+    => BytesPerType a
     => ShowArrayViewType a name
     => IsSymbol name
-    => Nat b
-    => Endian -> AProxy a -> DataView -> ByteOffset -> Effect (Maybe t)
+    => Endian -> Proxy a -> DataView -> ByteOffset -> Effect (Maybe t)
 get endian prx =
   let le = endian == LE
       pnm = "get" <> reflectSymbol (SProxy :: SProxy name)
-      bpv = toInt' (Proxy :: Proxy b)
+      bpv = byteWidth prx
   in getter { functionName: pnm
             , bytesPerValue: bpv
             , littleEndian: le
             }
 
-getBE :: forall a name t b
+getBE :: forall a name t
        . BinaryValue a t
-      => BytesPerValue a b
+      => BytesPerType a
       => ShowArrayViewType a name
       => IsSymbol name
-      => Nat b
-      => AProxy a -> DataView -> ByteOffset -> Effect (Maybe t)
+      => Proxy a -> DataView -> ByteOffset -> Effect (Maybe t)
 getBE = get BE
 
-getLE :: forall a name t b
+getLE :: forall a name t
        . BinaryValue a t
-      => BytesPerValue a b
+      => BytesPerType a
       => ShowArrayViewType a name
       => IsSymbol name
-      => Nat b
-      => AProxy a -> DataView -> ByteOffset -> Effect (Maybe t)
+      => Proxy a -> DataView -> ByteOffset -> Effect (Maybe t)
 getLE = get LE
 
 setter :: forall t.
@@ -162,152 +153,149 @@ foreign import setterImpl :: forall t
                                        } DataView ByteOffset t Boolean
 
 
-set :: forall a name t b
+set :: forall a name t
      . BinaryValue a t
-    => BytesPerValue a b
+    => BytesPerType a
     => ShowArrayViewType a name
     => IsSymbol name
-    => Nat b
-    => Endian -> AProxy a -> DataView -> ByteOffset -> t -> Effect Boolean
+    => Endian -> Proxy a -> DataView -> ByteOffset -> t -> Effect Boolean
 set endian prx =
   let le = endian == LE
       pnm = "set" <> reflectSymbol (SProxy :: SProxy name)
-      bpv = toInt' (Proxy :: Proxy b)
+      bpv = byteWidth prx
   in setter { functionName: pnm
             , bytesPerValue: bpv
             , littleEndian: le
             }
 
 -- | Fetch int8 value at a certain index in a `DataView`.
 getInt8 :: DataView -> ByteOffset -> Effect (Maybe Int)
-getInt8 = getLE (AProxy :: AProxy Int8)
+getInt8 = getLE (Proxy :: Proxy Int8)
 
 -- | Fetch big-endian int16 value at a certain index in a `DataView`.
 getInt16be :: DataView -> ByteOffset -> Effect (Maybe Int)
-getInt16be = getBE (AProxy :: AProxy Int16)
+getInt16be = getBE (Proxy :: Proxy Int16)
 
 -- | Fetch little-endian int16 value at a certain index in a `DataView`.
 getInt16le :: DataView -> ByteOffset -> Effect (Maybe Int)
-getInt16le = getLE (AProxy :: AProxy Int16)
+getInt16le = getLE (Proxy :: Proxy Int16)
 
 -- | Fetch big-endian int32 value at a certain index in a `DataView`.
 getInt32be :: DataView -> ByteOffset -> Effect (Maybe Int)
-getInt32be = getBE (AProxy :: AProxy Int32)
+getInt32be = getBE (Proxy :: Proxy Int32)
 
 -- | Fetch little-endian int32 value at a certain index in a `DataView`.
 getInt32le :: DataView -> ByteOffset -> Effect (Maybe Int)
-getInt32le = getLE (AProxy :: AProxy Int32)
+getInt32le = getLE (Proxy :: Proxy Int32)
 
 -- | Fetch uint8 value at a certain index in a `DataView`.
 getUint8 :: DataView -> ByteOffset -> Effect (Maybe UInt)
-getUint8 = getLE (AProxy :: AProxy Uint8)
+getUint8 = getLE (Proxy :: Proxy Uint8)
 
 -- | Fetch big-endian uint16 value at a certain index in a `DataView`.
 getUint16be :: DataView -> ByteOffset -> Effect (Maybe UInt)
-getUint16be = getBE (AProxy :: AProxy Uint16)
+getUint16be = getBE (Proxy :: Proxy Uint16)
 
 -- | Fetch little-endian uint16 value at a certain index in a `DataView`.
 getUint16le :: DataView -> ByteOffset -> Effect (Maybe UInt)
-getUint16le = getLE (AProxy :: AProxy Uint16)
+getUint16le = getLE (Proxy :: Proxy Uint16)
 
 -- | Fetch big-endian uint32 value at a certain index in a `DataView`.
 getUint32be :: DataView -> ByteOffset -> Effect (Maybe UInt)
-getUint32be = getBE (AProxy :: AProxy Uint32)
+getUint32be = getBE (Proxy :: Proxy Uint32)
 
 -- | Fetch little-endian uint32 value at a certain index in a `DataView`.
 getUint32le :: DataView -> ByteOffset -> Effect (Maybe UInt)
-getUint32le = getLE (AProxy :: AProxy Uint32)
+getUint32le = getLE (Proxy :: Proxy Uint32)
 
 -- | Fetch big-endian float32 value at a certain index in a `DataView`.
 getFloat32be :: DataView -> ByteOffset -> Effect (Maybe F.Float32)
-getFloat32be = getBE (AProxy :: AProxy Float32)
+getFloat32be = getBE (Proxy :: Proxy Float32)
 
 -- | Fetch little-endian float32 value at a certain index in a `DataView`.
 getFloat32le :: DataView -> ByteOffset -> Effect (Maybe F.Float32)
-getFloat32le = getLE (AProxy :: AProxy Float32)
+getFloat32le = getLE (Proxy :: Proxy Float32)
 
 -- | Fetch big-endian float64 value at a certain index in a `DataView`.
 getFloat64be :: DataView -> ByteOffset -> Effect (Maybe Number)
-getFloat64be = getBE (AProxy :: AProxy Float64)
+getFloat64be = getBE (Proxy :: Proxy Float64)
 
 -- | Fetch little-endian float64 value at a certain index in a `DataView`.
 getFloat64le :: DataView -> ByteOffset -> Effect (Maybe Number)
-getFloat64le = getLE (AProxy :: AProxy Float64)
+getFloat64le = getLE (Proxy :: Proxy Float64)
 
 
 -- | Store big-endian value at a certain index in a `DataView`.
-setBE :: forall a name t b
+setBE :: forall a name t
        . BinaryValue a t
-      => BytesPerValue a b
+      => BytesPerType a
       => ShowArrayViewType a name
       => IsSymbol name
-      => Nat b
-      => AProxy a -> DataView -> ByteOffset -> t -> Effect Boolean
+      => Proxy a -> DataView -> ByteOffset -> t -> Effect Boolean
 setBE = set BE
 
 -- | Store little-endian value at a certain index in a `DataView`.
-setLE :: forall a name t b
+setLE :: forall a name t
        . BinaryValue a t
-      => BytesPerValue a b
+      => BytesPerType a
       => ShowArrayViewType a name
       => IsSymbol name
-      => Nat b
-      => AProxy a -> DataView -> ByteOffset -> t -> Effect Boolean
+      => Proxy a -> DataView -> ByteOffset -> t -> Effect Boolean
 setLE = set LE
 
 -- | Store int8 value at a certain index in a `DataView`.
 setInt8 :: DataView -> ByteOffset -> Int -> Effect Boolean
-setInt8 = setLE (AProxy :: AProxy Int8)
+setInt8 = setLE (Proxy :: Proxy Int8)
 
 -- | Store big-endian int16 value at a certain index in a `DataView`.
 setInt16be :: DataView -> ByteOffset -> Int -> Effect Boolean
-setInt16be = setBE (AProxy :: AProxy Int16)
+setInt16be = setBE (Proxy :: Proxy Int16)
 
 -- | Store little-endian int16 value at a certain index in a `DataView`.
 setInt16le :: DataView -> ByteOffset -> Int -> Effect Boolean
-setInt16le = setLE (AProxy :: AProxy Int16)
+setInt16le = setLE (Proxy :: Proxy Int16)
 
 -- | Store big-endian int32 value at a certain index in a `DataView`.
 setInt32be :: DataView -> ByteOffset -> Int -> Effect Boolean
-setInt32be = setBE (AProxy :: AProxy Int32)
+setInt32be = setBE (Proxy :: Proxy Int32)
 
 -- | Store little-endian int32 value at a certain index in a `DataView`.
 setInt32le :: DataView -> ByteOffset -> Int -> Effect Boolean
-setInt32le = setLE (AProxy :: AProxy Int32)
+setInt32le = setLE (Proxy :: Proxy Int32)
 
 -- | Store uint8 value at a certain index in a `DataView`.
 setUint8 :: DataView -> ByteOffset -> UInt -> Effect Boolean
-setUint8 = setLE (AProxy :: AProxy Uint8)
+setUint8 = setLE (Proxy :: Proxy Uint8)
 
 
 -- | Store big-endian uint16 value at a certain index in a `DataView`.
 setUint16be :: DataView -> ByteOffset -> UInt -> Effect Boolean
-setUint16be = setBE (AProxy :: AProxy Uint16)
+setUint16be = setBE (Proxy :: Proxy Uint16)
 
 -- | Store little-endian uint16 value at a certain index in a `DataView`.
 setUint16le :: DataView -> ByteOffset -> UInt -> Effect Boolean
-setUint16le = setLE (AProxy :: AProxy Uint16)
+setUint16le = setLE (Proxy :: Proxy Uint16)
 
 -- | Store big-endian uint32 value at a certain index in a `DataView`.
 setUint32be :: DataView -> ByteOffset -> UInt -> Effect Boolean
-setUint32be = setBE (AProxy :: AProxy Uint32)
+setUint32be = setBE (Proxy :: Proxy Uint32)
 
 -- | Store little-endian uint32 value at a certain index in a `DataView`.
 setUint32le :: DataView -> ByteOffset -> UInt -> Effect Boolean
-setUint32le = setLE (AProxy :: AProxy Uint32)
+setUint32le = setLE (Proxy :: Proxy Uint32)
 
 -- | Store big-endian float32 value at a certain index in a `DataView`.
 setFloat32be :: DataView -> ByteOffset -> F.Float32 -> Effect Boolean
-setFloat32be = setBE (AProxy :: AProxy Float32)
+setFloat32be = setBE (Proxy :: Proxy Float32)
 
 -- | Store little-endian float32 value at a certain index in a `DataView`.
 setFloat32le :: DataView -> ByteOffset -> F.Float32 -> Effect Boolean
-setFloat32le = setLE (AProxy :: AProxy Float32)
+setFloat32le = setLE (Proxy :: Proxy Float32)
 
 -- | Store big-endian float64 value at a certain index in a `DataView`.
 setFloat64be :: DataView -> ByteOffset -> Number -> Effect Boolean
-setFloat64be = setBE (AProxy :: AProxy Float64)
+setFloat64be = setBE (Proxy :: Proxy Float64)
 
 -- | Store little-endian float64 value at a certain index in a `DataView`.
 setFloat64le :: DataView -> ByteOffset -> Number -> Effect Boolean
-setFloat64le = setLE (AProxy :: AProxy Float64)
+setFloat64le = setLE (Proxy :: Proxy Float64)