All files / symbol-qr-library/src QRCodeDataSchema.ts

100% Statements 7/7
100% Branches 0/0
100% Functions 3/3
100% Lines 7/7

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70                                                  1x             52x                                         1x     52x   52x               1x   1x  
/**
 * Copyright 2019 NEM
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
// internal dependencies
import {QRCode} from '../index';
 
/**
 * Class `QRCodeDataSchema` describes a QR Code's data
 * schema. The schema defines obligatory fields and their
 * format.
 *
 * @since 0.3.0
 */
abstract class QRCodeDataSchema {
 
    /**
     * The AccountQR QR Code version
     *
     * @var {number}
     */
    public readonly VERSION = 3;
 
    constructor() {}
 
    /// region Abstract Methods
    /**
     * The `getData()` method returns an object
     * that will be stored in the `data` field of
     * the underlying QR Code JSON content.
     *
     * @return {any}
     */
    public abstract getData(qr: QRCode): any;
    /// end-region Abstract Methods
 
    /**
     * The `toObject()` method returns a JSON object
     * with required fields.
     *
     * @return {any}
     */
    public toObject(qr: QRCode): any {
 
        // read data from child-classes
        const data = this.getData(qr);
 
        return {
            "v": this.VERSION,
            "type": qr.type,
            "network_id": qr.networkType,
            "chain_id": qr.generationHash,
            "data": data,
        };
    }
}
 
export {QRCodeDataSchema};