@minecraft/creator-tools
Version:
Minecraft Creator Tools command line and libraries.
199 lines (198 loc) • 6.71 kB
JavaScript
"use strict";
// Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.
var __importDefault = (this && this.__importDefault) || function (mod) {
return (mod && mod.__esModule) ? mod : { "default": mod };
};
Object.defineProperty(exports, "__esModule", { value: true });
const ste_events_1 = require("ste-events");
const Utilities_1 = __importDefault(require("../core/Utilities"));
const StorageUtilities_1 = __importDefault(require("../storage/StorageUtilities"));
const Log_1 = __importDefault(require("../core/Log"));
class PersonaManifestDefinition {
_file;
_id;
_isLoaded = false;
_loadedWithComments = false;
definition;
_onLoaded = new ste_events_1.EventDispatcher();
get isLoaded() {
return this._isLoaded;
}
get file() {
return this._file;
}
set file(newFile) {
this._file = newFile;
}
get onLoaded() {
return this._onLoaded.asEvent();
}
get description() {
if (!this.definition || !this.definition.header) {
return undefined;
}
return this.definition.header.description;
}
set description(newDescription) {
if (this.definition && this.definition.header && newDescription) {
this.definition.header.description = newDescription;
}
}
get packScope() {
if (!this.definition || !this.definition.header) {
return undefined;
}
return this.definition.header.pack_scope;
}
get productType() {
if (!this.definition || !this.definition.metadata) {
return undefined;
}
return this.definition.metadata.product_type;
}
get name() {
if (this.definition && this.definition.header) {
return this.definition.header.name;
}
return undefined;
}
set name(newName) {
if (this.definition && this.definition.header && newName) {
this.definition.header.name = newName;
}
}
get uuid() {
if (this.definition && this.definition.header) {
return this.definition.header.uuid;
}
return this._id;
}
set uuid(newId) {
if (this.definition && this.definition.header && newId) {
this.definition.header.uuid = newId;
}
this._id = newId;
}
ensureHeaderForProject(project) {
return this.ensureHeader(project.title, project.description);
}
get minEngineVersion() {
if (!this.definition || !this.definition.header || !this.definition.header.min_engine_version) {
return undefined;
}
return this.definition.header.min_engine_version;
}
setMinEngineVersion(versionArray, project) {
const header = this.ensureHeaderForProject(project);
header.min_engine_version = versionArray;
}
static async ensureOnFile(file, loadHandler) {
let rmj;
if (file.manager === undefined) {
rmj = new PersonaManifestDefinition();
rmj.file = file;
file.manager = rmj;
}
if (file.manager !== undefined && file.manager instanceof PersonaManifestDefinition) {
rmj = file.manager;
if (!rmj.isLoaded) {
if (loadHandler) {
rmj.onLoaded.subscribe(loadHandler);
}
await rmj.load();
}
}
return rmj;
}
persist() {
if (this._file === undefined) {
return false;
}
if (!this.definition) {
Log_1.default.unexpectedUndefined("PMRDP");
return false;
}
return this._file.setObjectContentIfSemanticallyDifferent(this.definition);
}
ensureDefinition(name, description) {
if (!this.definition) {
this.definition = {
format_version: 2,
header: {
name: name,
description: description,
version: [0, 0, 1],
min_engine_version: [1, 20, 10],
uuid: Utilities_1.default.createUuid(),
},
modules: [],
dependencies: [],
};
}
}
ensureHeader(name, description) {
this.ensureDefinition(name, description);
if (!this.definition) {
throw new Error();
}
if (!this.definition.header) {
this.definition.header = this.getDefaultHeader(name, description);
}
return this.definition.header;
}
getDefaultHeader(name, description) {
return {
name: name,
description: description,
version: [0, 0, 1],
min_engine_version: [1, 20, 10],
uuid: Utilities_1.default.createUuid(),
};
}
async save() {
if (this._file === undefined) {
return;
}
if (this.persist()) {
await this._file.saveContent(false);
}
}
/**
* Loads the definition from the file.
* @param preserveComments If true, uses comment-preserving JSON parsing for edit/save cycles.
* If false (default), uses efficient standard JSON parsing.
* Can be called again with true to "upgrade" a read-only load to read/write.
*/
async load(preserveComments = false) {
// If already loaded with comments, we have the "best" version - nothing more to do
if (this._isLoaded && this._loadedWithComments) {
return;
}
// If already loaded without comments and caller doesn't need comments, we're done
if (this._isLoaded && !preserveComments) {
return;
}
if (this._file === undefined) {
return;
}
if (!this._file.isContentLoaded) {
await this._file.loadContent();
}
if (this._file.content === null || this._file.content instanceof Uint8Array) {
this._isLoaded = true;
this._loadedWithComments = preserveComments;
this._onLoaded.dispatch(this, this);
return;
}
this.uuid = this._file.name;
// Use comment-preserving parser only when needed for editing
this.definition = preserveComments
? StorageUtilities_1.default.getJsonObjectWithComments(this._file)
: StorageUtilities_1.default.getJsonObject(this._file);
this._isLoaded = true;
this._loadedWithComments = preserveComments;
this._onLoaded.dispatch(this, this);
}
}
exports.default = PersonaManifestDefinition;