@dcl/sdk-commands 7.0.0-4217957637.commit-a393ef7

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2019 Metaverse Holdings Ltd.
+
+   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.

package/dist/commands/build/index.d.ts

@@ -0,0 +1,20 @@
+import { CliComponents } from '../../components';
+interface Options {
+    args: Omit<typeof args, '_'>;
+    components: Pick<CliComponents, 'fs' | 'logger'>;
+}
+export declare const args: import("arg").Result<{
+    '--help': BooleanConstructor;
+    '--json': BooleanConstructor;
+    '-h': string;
+} & {
+    '--watch': BooleanConstructor;
+    '-w': string;
+    '--production': BooleanConstructor;
+    '-p': string;
+    '--skip-install': BooleanConstructor;
+    '--dir': StringConstructor;
+}>;
+export declare function help(): string;
+export declare function main(options: Options): Promise<void>;
+export {};

package/dist/commands/build/index.js

@@ -0,0 +1,58 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.main = exports.help = exports.args = void 0;
+const path_1 = require("path");
+const args_1 = require("../../logic/args");
+const compile_1 = require("@dcl/dcl-rollup/compile");
+const fp_future_1 = __importDefault(require("fp-future"));
+const project_validations_1 = require("../../logic/project-validations");
+exports.args = (0, args_1.getArgs)({
+    '--watch': Boolean,
+    '-w': '--watch',
+    '--production': Boolean,
+    '-p': '--production',
+    '--skip-install': Boolean,
+    '--dir': String
+});
+function help() {
+    return `
+  Usage: 'sdk-commands build [options]'
+    Options:'
+      -h, --help                Displays complete help
+      -w, --watch               Watch for file changes and build on change
+      -p, --production          Build without sourcemaps
+      --skip-install            Skip installing dependencies
+      --dir                     Path to directory to build
+
+    Example:
+    - Build your scene:
+      '$ sdk-commands build'
+  `;
+}
+exports.help = help;
+async function main(options) {
+    const projectRoot = (0, path_1.resolve)(process.cwd(), options.args['--dir'] || '.');
+    await (0, project_validations_1.assertValidProjectFolder)(options.components, projectRoot);
+    const shouldInstallDeps = await (0, project_validations_1.needsDependencies)(options.components, projectRoot);
+    if (shouldInstallDeps && !options.args['--skip-install']) {
+        await (0, project_validations_1.installDependencies)(options.components, projectRoot);
+    }
+    const watch = !!options.args['--watch'];
+    const watchingFuture = (0, fp_future_1.default)();
+    await (0, compile_1.compile)({
+        project: projectRoot,
+        watch,
+        production: !!options.args['--production'],
+        watchingFuture
+    });
+    if (!watch) {
+        watchingFuture.resolve(null);
+    }
+    await watchingFuture;
+    // track stuff...
+    // https://github.com/decentraland/cli/blob/main/src/commands/build.ts
+}
+exports.main = main;

package/dist/commands/export-static/index.d.ts

@@ -0,0 +1,23 @@
+import { CliComponents } from '../../components';
+interface Options {
+    args: typeof args;
+    components: Pick<CliComponents, 'fetch' | 'fs' | 'logger'>;
+}
+export declare const args: import("arg").Result<{
+    '--help': BooleanConstructor;
+    '--json': BooleanConstructor;
+    '-h': string;
+} & {
+    '--dir': StringConstructor;
+    '--destination': StringConstructor;
+    '--timestamp': StringConstructor;
+    '--realmName': StringConstructor;
+    '--baseUrl': StringConstructor;
+}>;
+export declare function help(): Promise<string>;
+export declare function main(options: Options): Promise<{
+    urn: string;
+    entityId: string;
+    destination: string;
+}>;
+export {};

package/dist/commands/export-static/index.js

@@ -0,0 +1,119 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.main = exports.help = exports.args = void 0;
+const path_1 = require("path");
+const args_1 = require("../../logic/args");
+const hashing_1 = require("@dcl/hashing");
+const project_validations_1 = require("../../logic/project-validations");
+const project_files_1 = require("../../logic/project-files");
+const error_1 = require("../../logic/error");
+const schemas_1 = require("@dcl/schemas");
+const log_1 = require("../../components/log");
+const beautiful_logs_1 = require("../../logic/beautiful-logs");
+const realm_1 = require("../../logic/realm");
+exports.args = (0, args_1.getArgs)({
+    '--dir': String,
+    '--destination': String,
+    '--timestamp': String,
+    '--realmName': String,
+    '--baseUrl': String
+});
+async function help() {
+    return `
+  Usage:
+    sdk-commands export-static --dir <directory> --destination <directory>
+
+  Description:
+
+    Exports all the contents of the scene as if they were uploaded to a content server
+
+  Options:
+
+    --dir <directory>         The project's root folder to export
+    --destination <directory> A path in which all the assets will be stored
+    --timestamp <timestamp>   A date to use in the deployable entity. Defaults to now()
+    --realmName <name>        Creates a /<name>/about endpoint to expose the current deployment as a realm. Requires --baseUrl
+    --baseUrl <baseUrl>       It is the public URL in which the --destination directory will be avaiable
+`;
+}
+exports.help = help;
+async function main(options) {
+    const { fs, logger } = options.components;
+    const projectRoot = (0, path_1.resolve)(process.cwd(), options.args['--dir'] || '.');
+    const destDirectory = (0, path_1.resolve)(process.cwd(), options.args['--destination'] || '.');
+    const willCreateRealm = !!exports.args['--realmName'];
+    let currentStep = 1;
+    const maxSteps = 3 + (willCreateRealm ? 1 : 0);
+    if (willCreateRealm && !exports.args['--baseUrl']) {
+        throw new error_1.CliError(`--baseUrl is mandatory when --realmName is provided`);
+    }
+    if (willCreateRealm && !/^[a-z][a-z0-9-.]*$/i.test(exports.args['--realmName'])) {
+        throw new error_1.CliError(`--realmName has invalid characters`);
+    }
+    (0, beautiful_logs_1.printProgressStep)(logger, 'Reading project files...', currentStep++, maxSteps);
+    await fs.mkdir(destDirectory, { recursive: true });
+    if (!(await fs.directoryExists(destDirectory))) {
+        throw new error_1.CliError(`The destination path ${destDirectory} is not a directory`);
+    }
+    const project = await (0, project_validations_1.assertValidProjectFolder)(options.components, projectRoot);
+    const filesToExport = await (0, project_files_1.getProjectContentMappings)(options.components, projectRoot, async (file) => {
+        return await (0, hashing_1.hashV1)(fs.createReadStream((0, path_1.resolve)(projectRoot, file)));
+    });
+    (0, beautiful_logs_1.printProgressStep)(logger, 'Copying files...', currentStep++, maxSteps);
+    for (const { file, hash } of filesToExport) {
+        const src = (0, path_1.resolve)(projectRoot, file);
+        const dst = (0, path_1.resolve)(destDirectory, hash);
+        if (src.startsWith(destDirectory))
+            continue;
+        (0, beautiful_logs_1.printProgressInfo)(logger, `> ${hash} -> ${file}`);
+        if (!(await fs.fileExists(dst))) {
+            const content = await fs.readFile(src);
+            await fs.writeFile(dst, content);
+        }
+    }
+    // entity with ID are the deployed ones, when we generate the entity the ID is not
+    // available because it is the result of hashing the following structure
+    const entity = {
+        content: filesToExport,
+        pointers: [],
+        timestamp: exports.args['--timestamp'] ? new Date(exports.args['--timestamp']).getTime() : Date.now(),
+        type: schemas_1.EntityType.SCENE,
+        // for now, the only valid export is for scenes
+        metadata: project.scene,
+        version: 'v3'
+    };
+    (0, beautiful_logs_1.printProgressStep)(logger, 'Generating files...', currentStep++, maxSteps);
+    // create the entity file and get the entityId
+    const entityRaw = Buffer.from(JSON.stringify(entity), 'utf8');
+    const entityId = await (0, hashing_1.hashV1)(entityRaw);
+    const dst = (0, path_1.resolve)(destDirectory, entityId);
+    await fs.writeFile(dst, entityRaw);
+    (0, beautiful_logs_1.printProgressInfo)(logger, `> ${entityId} -> [ENTITY FILE]`);
+    let urn = `urn:decentraland:entity:${entityId}`;
+    if (exports.args['--baseUrl']) {
+        urn += '?baseUrl=' + exports.args['--baseUrl'];
+        // baseUrl must end with /
+        if (!urn.endsWith('/'))
+            urn += '/';
+    }
+    if (willCreateRealm) {
+        // prepare the realm object
+        (0, beautiful_logs_1.printProgressStep)(logger, 'Creating realm file...', currentStep++, maxSteps);
+        const realm = (0, realm_1.createStaticRealm)();
+        const realmName = exports.args['--realmName'];
+        realm.configurations.scenesUrn = [urn];
+        realm.configurations.realmName = realmName;
+        // write the realm file
+        const realmDirectory = (0, path_1.resolve)(destDirectory, realmName);
+        await fs.mkdir(realmDirectory, { recursive: true });
+        if (!(await fs.directoryExists(realmDirectory))) {
+            throw new error_1.CliError(`The destination path ${realmDirectory} is not a directory`);
+        }
+        const dst = (0, path_1.resolve)(realmDirectory, 'about');
+        await fs.writeFile(dst, JSON.stringify(realm, null, 2));
+        (0, beautiful_logs_1.printProgressInfo)(logger, `> ${realmName}/about -> [REALM FILE]`);
+    }
+    (0, beautiful_logs_1.printSuccess)(logger, `Export finished!`, `=> The entity URN is ${log_1.colors.bold(urn)}`);
+    return { urn, entityId, destination: destDirectory };
+}
+exports.main = main;

package/dist/commands/init/index.d.ts

@@ -0,0 +1,18 @@
+import { CliComponents } from '../../components';
+interface Options {
+    args: typeof args;
+    components: Pick<CliComponents, 'fetch' | 'fs' | 'logger'>;
+}
+export declare const args: import("arg").Result<{
+    '--help': BooleanConstructor;
+    '--json': BooleanConstructor;
+    '-h': string;
+} & {
+    '--yes': BooleanConstructor;
+    '-y': string;
+    '--dir': StringConstructor;
+    '--skip-install': BooleanConstructor;
+}>;
+export declare function help(): Promise<void>;
+export declare function main(options: Options): Promise<void>;
+export {};

package/dist/commands/init/index.js

@@ -0,0 +1,52 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.main = exports.help = exports.args = void 0;
+const path_1 = require("path");
+const args_1 = require("../../logic/args");
+const error_1 = require("../../logic/error");
+const fs_1 = require("../../logic/fs");
+const repos_1 = require("./repos");
+const project_validations_1 = require("../../logic/project-validations");
+exports.args = (0, args_1.getArgs)({
+    '--yes': Boolean,
+    '-y': '--yes',
+    '--dir': String,
+    '--skip-install': Boolean
+});
+async function help() { }
+exports.help = help;
+async function main(options) {
+    const dir = (0, path_1.resolve)(process.cwd(), options.args['--dir'] || '.');
+    const isEmpty = await (0, fs_1.isDirectoryEmpty)(options.components, dir);
+    const yes = options.args['--yes'];
+    if (!isEmpty && !yes) {
+        throw new error_1.CliError('The target directory specified is not empty. Run this command with --yes to override.');
+    }
+    // download and extract template project
+    const scene = 'scene-template';
+    const { url, contentFolders } = (0, repos_1.get)(scene);
+    const zip = await (0, fs_1.download)(options.components, url, (0, path_1.join)(dir, `${scene}.zip`));
+    await (0, fs_1.extract)(zip, dir);
+    await options.components.fs.unlink(zip);
+    await moveFilesFromDirs(options.components, dir, contentFolders);
+    // npm install
+    const shouldInstallDeps = await (0, project_validations_1.needsDependencies)(options.components, dir);
+    if (shouldInstallDeps && !options.args['--skip-install']) {
+        await (0, project_validations_1.installDependencies)(options.components, dir);
+    }
+}
+exports.main = main;
+const moveFilesFromDir = async (components, dir, folder) => {
+    const files = await components.fs.readdir(folder);
+    await Promise.all(files.map(($) => {
+        const filePath = (0, path_1.resolve)(folder, $);
+        return components.fs.rename(filePath, (0, path_1.resolve)(dir, $));
+    }));
+    await components.fs.rmdir(folder);
+};
+const moveFilesFromDirs = async (components, dir, folders) => {
+    await Promise.all(folders.map(($) => {
+        const folderPath = (0, path_1.resolve)(dir, $);
+        return moveFilesFromDir(components, dir, folderPath);
+    }));
+};

package/dist/commands/init/repos.d.ts

@@ -0,0 +1,9 @@
+type Scene = 'scene-template';
+type Repos = {
+    [key in Scene]: {
+        url: string;
+        contentFolders: string[];
+    };
+};
+export declare const get: (scene: Scene) => Repos[Scene];
+export {};

package/dist/commands/init/repos.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.get = void 0;
+const REPOS = {
+    'scene-template': {
+        url: 'https://github.com/decentraland/sdk7-scene-template/archive/refs/heads/main.zip',
+        contentFolders: ['sdk7-scene-template-main']
+    }
+};
+const get = (scene) => REPOS[scene];
+exports.get = get;

package/dist/commands/start/index.d.ts

@@ -0,0 +1,30 @@
+import { CliComponents } from '../../components';
+interface Options {
+    args: typeof args;
+    components: Pick<CliComponents, 'fetch' | 'fs' | 'logger'>;
+}
+export declare const args: import("arg").Result<{
+    '--help': BooleanConstructor;
+    '--json': BooleanConstructor;
+    '-h': string;
+} & {
+    '--dir': StringConstructor;
+    '--help': BooleanConstructor;
+    '--port': NumberConstructor;
+    '--no-debug': BooleanConstructor;
+    '--no-browser': BooleanConstructor;
+    '--no-watch': BooleanConstructor;
+    '--ci': BooleanConstructor;
+    '--skip-install': BooleanConstructor;
+    '--web3': BooleanConstructor;
+    '-h': string;
+    '-p': string;
+    '-d': string;
+    '-b': string;
+    '-w': string;
+    '--skip-build': BooleanConstructor;
+    '--desktop-client': BooleanConstructor;
+}>;
+export declare function help(): string;
+export declare function main(options: Options): Promise<void>;
+export {};