scratch-storage 2.3.283 → 3.0.0

package/src/{Asset.js → memoizedToString.ts}

@@ -1,7 +1,18 @@
+import {AssetId} from './Asset';
+
+declare function require(name: 'fastestsmallesttextencoderdecoder'): {
+    TextEncoder: typeof TextEncoder,
+    TextDecoder: typeof TextDecoder
+};
+
+declare function require(name: 'base64-js'): {
+    fromByteArray: (data: Uint8Array) => string;
+};
+
 // Use JS implemented TextDecoder and TextEncoder if it is not provided by the
 // browser.
-let _TextDecoder;
-let _TextEncoder;
+let _TextDecoder: typeof TextDecoder;
+let _TextEncoder: typeof TextEncoder;
 if (typeof TextDecoder === 'undefined' || typeof TextEncoder === 'undefined') {
     // Wait to require the text encoding polyfill until we know it's needed.
     // eslint-disable-next-line global-require
@@ -13,8 +24,6 @@ if (typeof TextDecoder === 'undefined' || typeof TextEncoder === 'undefined') {
     _TextEncoder = TextEncoder;
 }
 
-const md5 = require('js-md5');
-
 const memoizedToString = (function () {
     /**
      * The maximum length of a chunk before encoding it into base64.
@@ -30,10 +39,10 @@ const memoizedToString = (function () {
      * An array cache of bytes to characters.
      * @const {?Array.<string>}
      */
-    let fromCharCode = null;
+    let fromCharCode: string[] | null = null;
 
     const strings = {};
-    return (assetId, data) => {
+    return (assetId: AssetId, data: Uint8Array) => {
         if (!Object.prototype.hasOwnProperty.call(strings, assetId)) {
             if (typeof btoa === 'undefined') {
                 // Use a library that does not need btoa to run.
@@ -74,73 +83,4 @@ const memoizedToString = (function () {
     };
 }());
 
-class Asset {
-    /**
-     * Construct an Asset.
-     * @param {AssetType} assetType - The type of this asset (sound, image, etc.)
-     * @param {string} assetId - The ID of this asset.
-     * @param {DataFormat} [dataFormat] - The format of the data (WAV, PNG, etc.); required iff `data` is present.
-     * @param {Buffer} [data] - The in-memory data for this asset; optional.
-     * @param {bool} [generateId] - Whether to create id from an md5 hash of data
-     */
-    constructor (assetType, assetId, dataFormat, data, generateId) {
-        /** @type {AssetType} */
-        this.assetType = assetType;
-
-        /** @type {string} */
-        this.assetId = assetId;
-
-        this.setData(data, dataFormat || assetType.runtimeFormat, generateId);
-
-        /** @type {Asset[]} */
-        this.dependencies = [];
-    }
-
-    setData (data, dataFormat, generateId) {
-        if (data && !dataFormat) {
-            throw new Error('Data provided without specifying its format');
-        }
-
-        /** @type {DataFormat} */
-        this.dataFormat = dataFormat;
-
-        /** @type {Buffer} */
-        this.data = data;
-
-        if (generateId) this.assetId = md5(data);
-
-        // Mark as clean only if set is being called without generateId
-        // If a new id is being generated, mark this asset as not clean
-        this.clean = !generateId;
-    }
-
-    /**
-     * @returns {string} - This asset's data, decoded as text.
-     */
-    decodeText () {
-        const decoder = new _TextDecoder();
-        return decoder.decode(this.data);
-    }
-
-    /**
-     * Same as `setData` but encodes text first.
-     * @param {string} data - the text data to encode and store.
-     * @param {DataFormat} dataFormat - the format of the data (DataFormat.SVG for example).
-     * @param {bool} generateId - after setting data, set the id to an md5 of the data?
-     */
-    encodeTextData (data, dataFormat, generateId) {
-        const encoder = new _TextEncoder();
-        this.setData(encoder.encode(data), dataFormat, generateId);
-    }
-
-    /**
-     * @param {string} [contentType] - Optionally override the content type to be included in the data URI.
-     * @returns {string} - A data URI representing the asset's data.
-     */
-    encodeDataURI (contentType) {
-        contentType = contentType || this.assetType.contentType;
-        return `data:${contentType};base64,${memoizedToString(this.assetId, this.data)}`;
-    }
-}
-
-module.exports = Asset;
+export {memoizedToString, _TextEncoder, _TextDecoder};

package/src/scratchFetch.js

@@ -103,8 +103,6 @@ const unsetMetadata = name => {
 };
 
 module.exports = {
-    default: scratchFetch,
-
     Headers: crossFetch.Headers,
     RequestMetadata,
     applyMetadata,

package/src/types.d.ts

@@ -0,0 +1,3 @@
+declare module '*.png?arrayBuffer';
+declare module '*.wav?arrayBuffer';
+declare module '*.svg?arrayBuffer';

package/test/integration/download-known-assets.test.js

@@ -1,6 +1,6 @@
 const md5 = require('js-md5');
 
-const ScratchStorage = require('../../src/index.js');
+const ScratchStorage = require('../../src/index').ScratchStorage;
 
 test('constructor', () => {
     const storage = new ScratchStorage();

package/test/unit/add-helper.test.js

@@ -1,4 +1,4 @@
-const ScratchStorage = require('../../src');
+const {ScratchStorage} = require('../../src/ScratchStorage');
 
 /**
  * Simulate a storage helper, adding log messages when "load" is called rather than actually loading anything.

package/test/unit/fetch-tool.test.js

@@ -2,7 +2,7 @@ const TextDecoder = require('util').TextDecoder;
 
 jest.mock('cross-fetch');
 const mockFetch = require('cross-fetch');
-const FetchTool = require('../../src/FetchTool.js');
+const {FetchTool} = require('../../src/FetchTool');
 
 test('send success returns response.text()', async () => {
     const tool = new FetchTool();

package/test/unit/load-default-assets.test.js

@@ -1,6 +1,6 @@
 const md5 = require('js-md5');
 
-const ScratchStorage = require('../../dist/node/scratch-storage');
+const {ScratchStorage} = require('../../src/ScratchStorage');
 
 // Hash and file size of each default asset
 const knownSizes = {

package/test/unit/metadata.test.js

@@ -14,7 +14,7 @@ beforeEach(() => {
 });
 
 test('get without metadata', async () => {
-    const FetchTool = require('../../src/FetchTool.js');
+    const {FetchTool} = require('../../src/FetchTool');
     const tool = new FetchTool();
 
     const mockFetchTestData = {};
@@ -26,7 +26,7 @@ test('get without metadata', async () => {
 });
 
 test('get with metadata', async () => {
-    const FetchTool = require('../../src/FetchTool.js');
+    const {FetchTool} = require('../../src/FetchTool');
     const ScratchFetch = require('../../src/scratchFetch');
     const {RequestMetadata, setMetadata} = ScratchFetch;
 
@@ -46,7 +46,7 @@ test('get with metadata', async () => {
 });
 
 test('send without metadata', async () => {
-    const FetchTool = require('../../src/FetchTool.js');
+    const {FetchTool} = require('../../src/FetchTool');
     const tool = new FetchTool();
 
     const mockFetchTestData = {};
@@ -58,7 +58,7 @@ test('send without metadata', async () => {
 });
 
 test('send with metadata', async () => {
-    const FetchTool = require('../../src/FetchTool.js');
+    const {FetchTool} = require('../../src/FetchTool');
     const ScratchFetch = require('../../src/scratchFetch');
     const {RequestMetadata, setMetadata} = ScratchFetch;
 
@@ -78,7 +78,7 @@ test('send with metadata', async () => {
 });
 
 test('selectively delete metadata', async () => {
-    const FetchTool = require('../../src/FetchTool.js');
+    const {FetchTool} = require('../../src/FetchTool');
     const ScratchFetch = require('../../src/scratchFetch');
     const {RequestMetadata, setMetadata, unsetMetadata} = ScratchFetch;
 
@@ -111,7 +111,7 @@ test('selectively delete metadata', async () => {
 });
 
 test('metadata has case-insensitive keys', async () => {
-    const FetchTool = require('../../src/FetchTool.js');
+    const {FetchTool} = require('../../src/FetchTool');
     const ScratchFetch = require('../../src/scratchFetch');
     const {setMetadata} = ScratchFetch;
 

package/tsconfig.json

@@ -0,0 +1,29 @@
+{
+  "include": ["src"],
+  "compilerOptions": {
+    /* Visit https://aka.ms/tsconfig to read more about this file */
+
+    /* Language and Environment */
+    "target": "ESNext",
+
+    /* Modules */
+    "module": "Preserve",
+    "types": ["./src/types.d.ts"],
+
+    /* Emit */
+    "declaration": true,
+    "sourceMap": true,
+    "outDir": "./dist/types/",
+
+    /* Interop Constraints */
+    "esModuleInterop": true,
+    "forceConsistentCasingInFileNames": true,
+
+    /* Type Checking */
+    "strict": true,
+    "noImplicitAny": false,
+
+    /* Completeness */
+    "skipLibCheck": true
+  }
+}

package/tsconfig.test.json

@@ -0,0 +1,11 @@
+{
+  "include": ["test"],
+  "extends": ["./tsconfig.json"],
+  "compilerOptions": {
+    /* Visit https://aka.ms/tsconfig to read more about this file */
+
+    /* Modules */
+    "module": "CommonJS",
+    "types": ["jest", "./src/types.d.ts"],
+  }
+}

package/webpack.config.js

@@ -1,80 +1,73 @@
 const path = require('path');
-const UglifyJsPlugin = require('uglifyjs-webpack-plugin');
+const webpack = require('webpack');
 
-const base = {
-    mode: process.env.NODE_ENV === 'production' ? 'production' : 'development',
-    devtool: 'cheap-module-source-map',
-    module: {
-        rules: [
-            {
-                include: [
-                    path.resolve('src')
-                ],
-                test: /\.js$/,
-                loader: 'babel-loader',
-                options: {
-                    plugins: [
-                        '@babel/plugin-transform-runtime'
-                    ],
-                    presets: [
-                        ['@babel/preset-env', {targets: {browsers: ['last 3 versions', 'Safari >= 8', 'iOS >= 8']}}]
-                    ],
-                    // Consider a file a "module" if import/export statements are present, or else consider it a
-                    // "script". Fixes "Cannot assign to read only property 'exports'" when using
-                    // @babel/plugin-transform-runtime with CommonJS files.
-                    sourceType: 'unambiguous'
-                }
-            },
-            {
-                test: /\.(png|svg|wav)$/,
-                loader: 'arraybuffer-loader'
+const ScratchWebpackConfigBuilder = require('scratch-webpack-configuration');
+
+const baseConfig = new ScratchWebpackConfigBuilder(
+    {
+        rootPath: path.resolve(__dirname),
+        enableReact: false,
+        enableTs: true,
+        shouldSplitChunks: false
+    })
+    .setTarget('browserslist')
+    .merge({
+        resolve: {
+            fallback: {
+                Buffer: require.resolve('buffer/')
             }
-        ]
-    },
-    optimization: {
-        minimizer: [
-            new UglifyJsPlugin({
-                include: /\.min\.js$/,
-                sourceMap: true
-            })
-        ]
-    },
-    plugins: []
-};
+        }
+    });
 
-module.exports = [
-    // Web-compatible
-    Object.assign({}, base, {
-        target: 'web',
-        entry: {
-            'scratch-storage': './src/index.js',
-            'scratch-storage.min': './src/index.js'
-        },
+if (!process.env.CI) {
+    baseConfig.addPlugin(new webpack.ProgressPlugin());
+}
+
+// Web-compatible
+const webConfig = baseConfig.clone()
+    .merge({
         output: {
             library: 'ScratchStorage',
             libraryTarget: 'umd',
-            path: path.resolve('dist', 'web'),
-            filename: '[name].js'
+            path: path.resolve(__dirname, 'dist', 'web'),
+            filename: '[name].js',
+            clean: false
         }
-    }),
+    });
 
-    // Node-compatible
-    Object.assign({}, base, {
-        target: 'node',
+const webNonMinConfig = webConfig.clone()
+    .merge({
         entry: {
-            'scratch-storage': './src/index.js'
+            'scratch-storage': path.join(__dirname, './src/index.ts')
+        },
+        optimization: {
+            minimize: false
+        }
+    });
+
+const webMinConfig = webConfig.clone()
+    .merge({
+        entry: {
+            'scratch-storage.min': path.join(__dirname, './src/index.ts')
+        },
+        optimization: {
+            minimize: true
+        }
+    });
+
+// Node-compatible
+const nodeConfig = baseConfig.clone()
+    .merge({
+        entry: {
+            'scratch-storage': path.join(__dirname, './src/index.ts')
         },
         output: {
-            library: 'ScratchStorage',
             libraryTarget: 'commonjs2',
-            path: path.resolve('dist', 'node'),
-            filename: '[name].js'
-        },
-        externals: {
-            'base64-js': true,
-            'js-md5': true,
-            'localforage': true,
-            'text-encoding': true
+            path: path.resolve(__dirname, 'dist', 'node'),
+            filename: '[name].js',
+            clean: false
         }
     })
-];
+    .addExternals(['base64-js', 'js-md5', 'localforage', 'text-encoding']);
+
+module.exports = [webNonMinConfig.get(), webMinConfig.get(), nodeConfig.get()];