4.0.83 • Published 4 months ago

scratch-storage v4.0.83

Weekly downloads
1,196
License
AGPL-3.0-only
Repository
github
Last release
4 months ago

scratch-storage

Scratch Storage is a library for loading and storing project and asset files for Scratch 3.0

CircleCI

Coverage Status Greenkeeper badge

Installation

This requires you to have Node.js installed.

In your own Node.js environment/application:

npm install https://github.com/scratchfoundation/scratch-storage.git

If you want to edit/play yourself (requires Git):

git clone https://github.com/scratchfoundation/scratch-storage.git
cd scratch-storage
npm install

Using scratch-storage

From HTML

<script src="scratch-storage/dist/web/scratch-storage.js"></script>
<script>
    var storage = new Scratch.Storage();
    // continue to "Storage API Quick Start" section below
</script>

From Node.js / Webpack

var storage = require('scratch-storage');
// continue to "Storage API Quick Start" section below

Storage API Quick Start

Once you have an instance of scratch-storage, add some web sources. For each source you'll need to provide a function to generate a URL for a supported type of asset:

/**
 * @param {Asset} asset - calculate a URL for this asset.
 * @returns {string} a URL to download a project asset (PNG, WAV, etc.)
 */
var getAssetUrl = function (asset) {
    var assetUrlParts = [
        'https://assets.example.com/path/to/assets/',
        asset.assetId,
        '.',
        asset.dataFormat,
        '/get/'
    ];
    return assetUrlParts.join('');
};

Then, let the storage module know about your source:

storage.addWebStore(
    [AssetType.ImageVector, AssetType.ImageBitmap, AssetType.Sound],
    getAssetUrl);

If you're using ES6 you may be able to simplify all of the above quite a bit:

storage.addWebStore(
    [AssetType.ImageVector, AssetType.ImageBitmap, AssetType.Sound],
    asset => `https://assets.example.com/path/to/assets/${asset.assetId}.${asset.dataFormat}/get/`);

Once the storage module is aware of the sources you need, you can start loading assets:

storage.load(AssetType.Sound, soundId).then(function (soundAsset) {
    // `soundAsset` is an `Asset` object. File contents are stored in `soundAsset.data`.
});

If you'd like to use scratch-storage with scratch-vm you must "attach" the storage module to the VM:

vm.attachStorage(storage);

Testing

To run all tests:

npm test

To show test coverage:

npm run coverage

Committing

This project uses semantic release to ensure version bumps follow semver so that projects using the config don't break unexpectedly.

In order to automatically determine the type of version bump necessary, semantic release expects commit messages to be formatted following conventional-changelog.

<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>

subject and body are your familiar commit subject and body. footer is where you would include BREAKING CHANGE and ISSUES FIXED sections if applicable.

type is one of:

  • fix: A bug fix Causes a patch release (0.0.x)
  • feat: A new feature Causes a minor release (0.x.0)
  • docs: Documentation only changes
  • style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
  • refactor: A code change that neither fixes a bug nor adds a feature
  • perf: A code change that improves performance May or may not cause a minor release. It's not clear.
  • test: Adding missing tests or correcting existing tests
  • ci: Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs)
  • chore: Other changes that don't modify src or test files
  • revert: Reverts a previous commit

Use the commitizen CLI to make commits formatted in this way:

npm install -g commitizen
npm install

Now you're ready to make commits using git cz.

Breaking changes

If you're committing a change that makes an API change, or will otherwise require changes to existing code, ensure your commit specifies a breaking change. In your commit body, prefix the changes with "BREAKING CHANGE: " This will cause a major version bump so downstream projects must choose to upgrade and will not break the build unexpectedly.

Donate

We provide Scratch free of charge, and want to keep it that way! Please consider making a donation to support our continued engineering, design, community, and resource development efforts. Donations of any size are appreciated. Thank you!

4.0.5

8 months ago

4.0.4

8 months ago

4.0.7

8 months ago

4.0.6

8 months ago

4.0.1

8 months ago

4.0.0

8 months ago

4.0.3

8 months ago

4.0.2

8 months ago

4.0.9

8 months ago

4.0.8

8 months ago

4.0.63

5 months ago

4.0.62

5 months ago

4.0.65

5 months ago

4.0.64

5 months ago

4.0.61

5 months ago

4.0.60

5 months ago

4.0.67

5 months ago

4.0.66

5 months ago

4.0.69

5 months ago

4.0.68

5 months ago

4.0.52

5 months ago

4.0.51

5 months ago

4.0.54

5 months ago

4.0.53

5 months ago

4.0.50

5 months ago

4.0.59

5 months ago

4.0.56

5 months ago

4.0.55

5 months ago

4.0.58

5 months ago

4.0.57

5 months ago

4.0.81

4 months ago

4.0.80

4 months ago

4.0.83

4 months ago

4.0.82

4 months ago

4.0.74

5 months ago

4.0.73

5 months ago

4.0.76

4 months ago

4.0.75

5 months ago

4.0.70

5 months ago

4.0.72

5 months ago

4.0.71

5 months ago

4.0.78

4 months ago

4.0.77

4 months ago

4.0.79

4 months ago

4.0.19

8 months ago

4.0.21

8 months ago

4.0.20

8 months ago

4.0.27

6 months ago

4.0.26

7 months ago

4.0.29

6 months ago

4.0.28

6 months ago

4.0.23

7 months ago

4.0.22

8 months ago

4.0.25

7 months ago

4.0.24

7 months ago

4.0.10

8 months ago

4.0.16

8 months ago

4.0.15

8 months ago

4.0.18

8 months ago

4.0.17

8 months ago

4.0.12

8 months ago

4.0.11

8 months ago

4.0.14

8 months ago

4.0.13

8 months ago

4.0.41

6 months ago

4.0.40

6 months ago

4.0.43

6 months ago

4.0.42

6 months ago

4.0.49

5 months ago

4.0.48

6 months ago

4.0.45

6 months ago

4.0.44

6 months ago

4.0.47

6 months ago

4.0.46

6 months ago

4.0.30

6 months ago

4.0.32

6 months ago

4.0.31

6 months ago

4.0.38

6 months ago

4.0.37

6 months ago

4.0.39

6 months ago

4.0.34

6 months ago

4.0.33

6 months ago

4.0.36

6 months ago

4.0.35

6 months ago

3.0.12

9 months ago

3.0.13

9 months ago

3.0.10

9 months ago

3.0.11

9 months ago

3.0.16

9 months ago

3.0.17

9 months ago

3.0.14

9 months ago

3.0.15

9 months ago

3.0.23

8 months ago

3.0.24

8 months ago

3.0.21

9 months ago

3.0.22

8 months ago

3.0.27

8 months ago

3.0.28

8 months ago

3.0.25

8 months ago

3.0.26

8 months ago

3.0.20

9 months ago

3.0.18

9 months ago

3.0.19

9 months ago

3.0.34

8 months ago

3.0.35

8 months ago

3.0.32

8 months ago

3.0.33

8 months ago

3.0.38

8 months ago

3.0.39

8 months ago

3.0.36

8 months ago

3.0.37

8 months ago

3.0.30

8 months ago

3.0.31

8 months ago

3.0.29

8 months ago

3.0.8

9 months ago

3.0.9

9 months ago

3.0.4

9 months ago

3.0.3

9 months ago

3.0.2

9 months ago

3.0.7

9 months ago

3.0.6

9 months ago

3.0.5

9 months ago

2.3.284

9 months ago

2.3.283

9 months ago

3.0.1

9 months ago

3.0.0

9 months ago

2.3.282

9 months ago

2.3.281

9 months ago

2.3.280

9 months ago

2.3.271

10 months ago

2.3.270

10 months ago

2.3.273

10 months ago

2.3.272

10 months ago

2.3.279

9 months ago

2.3.278

9 months ago

2.3.275

10 months ago

2.3.274

10 months ago

2.3.277

10 months ago

2.3.276

10 months ago

2.3.239

11 months ago

2.3.238

11 months ago

2.3.240

11 months ago

2.3.246

10 months ago

2.3.245

10 months ago

2.3.248

10 months ago

2.3.247

10 months ago

2.3.242

11 months ago

2.3.241

11 months ago

2.3.244

11 months ago

2.3.243

11 months ago

2.3.229

11 months ago

2.3.235

11 months ago

2.3.234

11 months ago

2.3.237

11 months ago

2.3.236

11 months ago

2.3.231

11 months ago

2.3.230

11 months ago

2.3.233

11 months ago

2.3.232

11 months ago

2.3.260

10 months ago

2.3.262

10 months ago

2.3.261

10 months ago

2.3.268

10 months ago

2.3.267

10 months ago

2.3.269

10 months ago

2.3.264

10 months ago

2.3.263

10 months ago

2.3.266

10 months ago

2.3.265

10 months ago

2.3.249

10 months ago

2.3.251

10 months ago

2.3.250

10 months ago

2.3.257

10 months ago

2.3.256

10 months ago

2.3.259

10 months ago

2.3.258

10 months ago

2.3.253

10 months ago

2.3.252

10 months ago

2.3.255

10 months ago

2.3.254

10 months ago

2.3.161

1 year ago

2.3.160

1 year ago

2.3.163

1 year ago

2.3.162

1 year ago

2.3.169

1 year ago

2.3.168

1 year ago

2.3.165

1 year ago

2.3.164

1 year ago

2.3.167

1 year ago

2.3.166

1 year ago

2.3.150

1 year ago

2.3.152

1 year ago

2.3.151

1 year ago

2.3.158

1 year ago

2.3.157

1 year ago

2.3.159

1 year ago

2.3.154

1 year ago

2.3.153

1 year ago

2.3.156

1 year ago

2.3.155

1 year ago

2.3.183

1 year ago

2.3.182

1 year ago

2.3.185

1 year ago

2.3.184

1 year ago

2.3.181

1 year ago

2.3.180

1 year ago

2.3.187

1 year ago

2.3.186

1 year ago

2.3.189

1 year ago

2.3.188

1 year ago

2.3.172

1 year ago

2.3.171

1 year ago

2.3.174

1 year ago

2.3.173

1 year ago

2.3.170

1 year ago

2.3.179

1 year ago

2.3.176

1 year ago

2.3.175

1 year ago

2.3.178

1 year ago

2.3.177

1 year ago

2.3.118

1 year ago

2.3.119

1 year ago

2.3.125

1 year ago

2.3.124

1 year ago

2.3.127

1 year ago

2.3.126

1 year ago

2.3.121

1 year ago

2.3.120

1 year ago

2.3.123

1 year ago

2.3.122

1 year ago

2.3.228

11 months ago

2.3.227

11 months ago

2.3.139

1 year ago

2.3.141

1 year ago

2.3.140

1 year ago

2.3.147

1 year ago

2.3.146

1 year ago

2.3.149

1 year ago

2.3.148

1 year ago

2.3.143

1 year ago

2.3.142

1 year ago

2.3.145

1 year ago

2.3.144

1 year ago

2.3.129

1 year ago

2.3.128

1 year ago

2.3.130

1 year ago

2.3.136

1 year ago

2.3.135

1 year ago

2.3.138

1 year ago

2.3.137

1 year ago

2.3.132

1 year ago

2.3.131

1 year ago

2.3.134

1 year ago

2.3.133

1 year ago

2.3.202

12 months ago

2.3.201

12 months ago

2.3.204

12 months ago

2.3.203

12 months ago

2.3.200

12 months ago

2.3.217

11 months ago

2.3.216

11 months ago

2.3.219

11 months ago

2.3.218

11 months ago

2.3.224

11 months ago

2.3.223

11 months ago

2.3.226

11 months ago

2.3.225

11 months ago

2.3.220

11 months ago

2.3.222

11 months ago

2.3.221

11 months ago

2.3.209

12 months ago

2.3.206

12 months ago

2.3.205

12 months ago

2.3.208

12 months ago

2.3.207

12 months ago

2.3.213

11 months ago

2.3.212

11 months ago

2.3.215

11 months ago

2.3.214

11 months ago

2.3.211

11 months ago

2.3.210

11 months ago

2.3.194

12 months ago

2.3.193

12 months ago

2.3.196

12 months ago

2.3.195

12 months ago

2.3.190

1 year ago

2.3.192

12 months ago

2.3.191

12 months ago

2.3.198

12 months ago

2.3.197

12 months ago

2.3.199

12 months ago

2.3.117

1 year ago

2.3.116

1 year ago

2.3.115

1 year ago

2.3.114

1 year ago

2.3.113

1 year ago

2.3.112

1 year ago

2.3.111

1 year ago

2.3.109

1 year ago

2.3.108

1 year ago

2.3.110

1 year ago

2.3.107

1 year ago

2.3.105

1 year ago

2.3.106

1 year ago

2.3.103

1 year ago

2.3.102

1 year ago

2.3.104

1 year ago

2.3.101

1 year ago

2.3.100

1 year ago

2.3.99

1 year ago

2.3.97

1 year ago

2.3.98

1 year ago

2.3.96

1 year ago

2.3.95

1 year ago

2.3.93

1 year ago

2.3.94

1 year ago

2.3.92

1 year ago

2.3.91

1 year ago

2.3.90

1 year ago

2.3.89

1 year ago

2.3.88

1 year ago

2.3.86

1 year ago

2.3.87

1 year ago

2.3.85

1 year ago

2.3.84

1 year ago

2.3.83

1 year ago

2.3.82

1 year ago

2.3.80

1 year ago

2.3.81

1 year ago

2.3.79

1 year ago

2.3.78

1 year ago

2.3.77

1 year ago

2.3.76

1 year ago

2.3.75

1 year ago

2.3.74

1 year ago

2.3.73

1 year ago

2.3.72

1 year ago

2.3.71

1 year ago

2.3.69

1 year ago

2.3.70

1 year ago

2.3.68

1 year ago

2.3.67

1 year ago

2.3.66

1 year ago

2.3.64

1 year ago

2.3.63

1 year ago

2.3.65

1 year ago

2.3.62

1 year ago

2.3.60

1 year ago

2.3.61

1 year ago

2.3.59

1 year ago

2.3.57

1 year ago

2.3.56

1 year ago

2.3.58

1 year ago

2.3.55

1 year ago

2.3.53

1 year ago

2.3.54

1 year ago

2.3.49

1 year ago

2.3.52

1 year ago

2.3.51

1 year ago

2.3.50

1 year ago

2.3.48

1 year ago

2.3.47

1 year ago

2.3.46

1 year ago

2.3.45

1 year ago

2.3.44

1 year ago

2.3.43

1 year ago

2.3.42

1 year ago

2.3.41

1 year ago

2.3.40

1 year ago

2.3.39

1 year ago

2.3.38

1 year ago

2.3.35

1 year ago

2.3.37

1 year ago

2.3.36

1 year ago

2.3.34

1 year ago

2.3.33

1 year ago

2.3.31

1 year ago

2.3.32

1 year ago

2.3.30

1 year ago

2.3.29

1 year ago

2.3.28

1 year ago

2.3.27

1 year ago

2.3.26

1 year ago

2.3.25

1 year ago

2.3.24

1 year ago

2.3.23

1 year ago

2.3.20

1 year ago

2.3.22

1 year ago

2.3.21

1 year ago

2.3.17

1 year ago

2.3.16

1 year ago

2.3.19

1 year ago

2.3.18

1 year ago

2.3.15

1 year ago

2.3.13

1 year ago

2.3.12

1 year ago

2.3.14

1 year ago

2.3.11

1 year ago

2.3.10

1 year ago

2.3.8

1 year ago

2.3.7

1 year ago

2.3.9

1 year ago

2.3.2

1 year ago

2.3.4

1 year ago

2.3.3

1 year ago

2.3.6

1 year ago

2.3.5

1 year ago

2.3.0

2 years ago

2.3.1

2 years ago

2.2.1

2 years ago

2.2.0

2 years ago

2.1.0

2 years ago

2.0.2

3 years ago

2.0.1

3 years ago

2.0.0

3 years ago

1.3.6

3 years ago

1.3.5

4 years ago

1.3.4

4 years ago

1.3.3

5 years ago

1.3.2

6 years ago

1.3.1

6 years ago

1.3.0

6 years ago

1.2.2

7 years ago

1.2.1

7 years ago

1.2.0

7 years ago

1.1.0

7 years ago

1.0.5

7 years ago

1.0.4

7 years ago

1.0.3

7 years ago

1.0.2

7 years ago

1.0.1

7 years ago

1.0.0

7 years ago

0.5.1

7 years ago

0.5.0

7 years ago

0.4.1

7 years ago

0.4.0

8 years ago

0.3.0

8 years ago

0.2.1

8 years ago

0.2.0

8 years ago

0.1.0

8 years ago