scratch-sb1-converter/src/sb1-file-packets.js

Scratch 1 (.sb) to Scratch 2 (.sb2) conversion library for Scratch 3.0

import {assert} from './util/assert';

import {Packet} from './coders/byte-packets';
import {FixedAsciiString, Uint8, Uint32BE} from './coders/byte-primitives';

/**
 * @augments Packet
 */
class SB1Signature extends Packet.extend({
    /**
     * 10 byte ascii string equaling `'ScratchV01'` or `'ScratchV02'`.
     * @type {string}
     * @memberof SB1Signature#
     */
    version: new FixedAsciiString(10),

    /**
     * Number of bytes in the info block.
     * @type {number}
     * @memberof SB1Signature#
     */
    infoByteLength: Uint32BE
}) {
    /**
     * Is this a valid SB1Signature?
     * @method
     * @throws {AssertionError} Throws if it is not valid.
     */
    validate () {
        assert.validate(
            this.equals({version: 'ScratchV01'}) ||
            this.equals({version: 'ScratchV02'}),
            'Invalid Scratch file signature.'
        );
    }
}

Packet.initConstructor(SB1Signature);

class SB1Header extends Packet.extend({
    ObjS: new FixedAsciiString(4),
    ObjSValue: Uint8,
    Stch: new FixedAsciiString(4),
    StchValue: Uint8,
    numObjects: Uint32BE
}) {
    validate () {
        assert.validate(
            this.equals({
                ObjS: 'ObjS',
                ObjSValue: 1,
                Stch: 'Stch',
                StchValue: 1
            }),
            'Invalid Scratch file info packet header.'
        );
    }
}

Packet.initConstructor(SB1Header);

export {SB1Signature, SB1Header};