@dcl/sdk-commands 7.0.0-4286109573.commit-baaf951 → 7.0.0-4293371227.commit-54082c6

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

@@ -1,7 +1,7 @@
 import { CliComponents } from '../../components';
 interface Options {
     args: Omit<typeof args, '_'>;
-    components: Pick<CliComponents, 'fs' | 'logger'>;
+    components: Pick<CliComponents, 'fs' | 'logger' | 'dclInfoConfig' | 'analytics'>;
 }
 export declare const args: import("arg").Result<{
     '--help': BooleanConstructor;

package/dist/commands/build/index.js

@@ -9,6 +9,8 @@ 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");
+const scene_validations_1 = require("../../logic/scene-validations");
+const project_files_1 = require("../../logic/project-files");
 exports.args = (0, args_1.getArgs)({
     '--watch': Boolean,
     '-w': '--watch',
@@ -51,6 +53,13 @@ async function main(options) {
     if (!watch) {
         watchingFuture.resolve(null);
     }
+    const sceneJson = await (0, project_files_1.getSceneJson)(options.components, projectRoot);
+    const coords = (0, scene_validations_1.getBaseCoords)(sceneJson);
+    await options.components.analytics.track('Build scene', {
+        projectHash: await (0, project_files_1.b64HashingFunction)(projectRoot),
+        coords,
+        isWorkspace: false
+    });
     await watchingFuture;
     // track stuff...
     // https://github.com/decentraland/cli/blob/main/src/commands/build.ts

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

@@ -1,7 +1,7 @@
 import { CliComponents } from '../../components';
 interface Options {
     args: typeof args;
-    components: Pick<CliComponents, 'fetch' | 'fs' | 'logger'>;
+    components: Pick<CliComponents, 'fetch' | 'fs' | 'logger' | 'dclInfoConfig' | 'analytics'>;
 }
 export declare const args: import("arg").Result<{
     '--help': BooleanConstructor;

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

@@ -11,6 +11,7 @@ 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");
+const scene_validations_1 = require("../../logic/scene-validations");
 exports.args = (0, args_1.getArgs)({
     '--dir': String,
     '--destination': String,
@@ -114,6 +115,12 @@ async function main(options) {
         (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)}`);
+    const sceneJson = await (0, project_files_1.getSceneJson)(options.components, projectRoot);
+    const coords = (0, scene_validations_1.getBaseCoords)(sceneJson);
+    await options.components.analytics.track('Export static', {
+        projectHash: await (0, project_files_1.b64HashingFunction)(projectRoot),
+        coords
+    });
     return { urn, entityId, destination: destDirectory };
 }
 exports.main = main;

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

@@ -1,7 +1,7 @@
 import { CliComponents } from '../../components';
 interface Options {
     args: typeof args;
-    components: Pick<CliComponents, 'fetch' | 'fs' | 'logger'>;
+    components: Pick<CliComponents, 'fetch' | 'fs' | 'logger' | 'dclInfoConfig' | 'analytics'>;
 }
 export declare const args: import("arg").Result<{
     '--help': BooleanConstructor;

package/dist/commands/init/index.js

@@ -34,6 +34,7 @@ async function main(options) {
     if (shouldInstallDeps && !options.args['--skip-install']) {
         await (0, project_validations_1.installDependencies)(options.components, dir);
     }
+    await options.components.analytics.track('Scene created', { projectType: scene, url });
 }
 exports.main = main;
 const moveFilesFromDir = async (components, dir, folder) => {

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

@@ -1,7 +1,7 @@
 import { CliComponents } from '../../components';
 interface Options {
     args: typeof args;
-    components: Pick<CliComponents, 'fetch' | 'fs' | 'logger'>;
+    components: Pick<CliComponents, 'fetch' | 'fs' | 'logger' | 'dclInfoConfig' | 'analytics'>;
 }
 export declare const args: import("arg").Result<{
     '--help': BooleanConstructor;

package/dist/commands/start/index.js

@@ -48,6 +48,7 @@ const log_1 = require("../../components/log");
 const file_watch_notifier_1 = require("./server/file-watch-notifier");
 const routes_1 = require("./server/routes");
 const ws_1 = require("./server/ws");
+const project_files_1 = require("../../logic/project-files");
 exports.args = (0, args_1.getArgs)({
     '--dir': String,
     '--help': Boolean,
@@ -102,7 +103,7 @@ async function main(options) {
     const skipBuild = exports.args['--skip-build'];
     const watch = !exports.args['--no-watch'];
     const enableWeb3 = exports.args['--web3'];
-    const baseCoords = { x: 0, y: 0 };
+    // TODO: FIX this hardcoded values ?
     const hasPortableExperience = false;
     // first run `npm run build`, this can be disabled with --skip-build
     if (!skipBuild) {
@@ -113,6 +114,8 @@ async function main(options) {
         await (0, build_1.main)({ ...options, args: { '--dir': projectRoot, '--watch': watch } });
     }
     await (0, scene_validations_1.validateSceneJson)(options.components, projectRoot);
+    const sceneJson = await (0, project_files_1.getSceneJson)(options.components, projectRoot);
+    const baseCoords = (0, scene_validations_1.getBaseCoords)(sceneJson);
     if (await (0, project_validations_1.needsDependencies)(options.components, projectRoot)) {
         const npmModulesPath = path.resolve(projectRoot, 'node_modules');
         throw new error_1.CliError(`Couldn\'t find ${npmModulesPath}, please run: npm install`);
@@ -164,6 +167,11 @@ async function main(options) {
             await startComponents();
             const networkInterfaces = os.networkInterfaces();
             const availableURLs = [];
+            await components.analytics.track('Preview started', {
+                projectHash: await (0, project_files_1.b64HashingFunction)(projectRoot),
+                coords: baseCoords,
+                isWorkspace: false
+            });
             components.logger.log(`Preview server is now running!`);
             components.logger.log('Available on:\n');
             Object.keys(networkInterfaces).forEach((dev) => {

package/dist/commands/start/server/endpoints.js

@@ -210,7 +210,6 @@ function serveFolders(components, router, baseFolders) {
         };
     });
 }
-const b64HashingFunction = async (str) => 'b64-' + Buffer.from(str).toString('base64');
 async function getAllPreviewWearables(components, { baseFolders, baseUrl }) {
     const wearablePathArray = [];
     for (const wearableDir of baseFolders) {
@@ -238,7 +237,7 @@ async function serveWearable(components, wearableJsonPath, baseUrl) {
         console.error(`Unable to validate wearable.json properly, please check it.`, errors);
         throw new Error(`Invalid wearable.json (${wearableJsonPath})`);
     }
-    const hashedFiles = await (0, project_files_1.getProjectContentMappings)(components, wearableDir, b64HashingFunction);
+    const hashedFiles = await (0, project_files_1.getProjectContentMappings)(components, wearableDir, project_files_1.b64HashingFunction);
     const thumbnailFiltered = hashedFiles.filter(($) => $?.file === 'thumbnail.png');
     const thumbnail = thumbnailFiltered.length > 0 && thumbnailFiltered[0]?.hash && `${baseUrl}/${thumbnailFiltered[0].hash}`;
     const wearableId = 'urn:8dc2d7ad-97e3-44d0-ba89-e8305d795a6a';
@@ -274,7 +273,7 @@ async function serveWearable(components, wearableJsonPath, baseUrl) {
 async function getSceneJson(components, projectRoots, pointers) {
     const requestedPointers = new Set(pointers);
     const resultEntities = [];
-    const allDeployments = await Promise.all(projectRoots.map(async (projectRoot) => fakeEntityV3FromFolder(components, projectRoot, b64HashingFunction)));
+    const allDeployments = await Promise.all(projectRoots.map(async (projectRoot) => fakeEntityV3FromFolder(components, projectRoot, project_files_1.b64HashingFunction)));
     for (const pointer of Array.from(requestedPointers)) {
         // get deployment by pointer
         const theDeployment = allDeployments.find(($) => $ && $.pointers.includes(pointer));

package/dist/components/analytics.d.ts

@@ -0,0 +1,38 @@
+import { Analytics } from '@segment/analytics-node';
+import { CliComponents } from '.';
+export type IAnalyticsComponent = {
+    get(): Analytics;
+    identify(): Promise<void>;
+    track<T extends keyof Events>(eventName: T, eventProps: Events[T]): Promise<void>;
+};
+type Events = {
+    'Scene created': {
+        projectType: string;
+        url: string;
+    };
+    'Preview started': {
+        projectHash: string;
+        coords: {
+            x: number;
+            y: number;
+        };
+        isWorkspace: boolean;
+    };
+    'Build scene': {
+        projectHash: string;
+        coords: {
+            x: number;
+            y: number;
+        };
+        isWorkspace: boolean;
+    };
+    'Export static': {
+        projectHash: string;
+        coords: {
+            x: number;
+            y: number;
+        };
+    };
+};
+export declare function createAnalyticsComponent({ dclInfoConfig }: Pick<CliComponents, 'dclInfoConfig'>): Promise<IAnalyticsComponent>;
+export {};

package/dist/components/analytics.js

@@ -0,0 +1,62 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createAnalyticsComponent = void 0;
+const uuid_1 = require("uuid");
+const analytics_node_1 = require("@segment/analytics-node");
+const fp_future_1 = __importDefault(require("fp-future"));
+const log_1 = require("./log");
+async function createAnalyticsComponent({ dclInfoConfig }) {
+    const USER_ID = 'sdk-commands-user';
+    const config = await dclInfoConfig.get();
+    const analytics = new analytics_node_1.Analytics({ writeKey: config.segmentKey ?? '' });
+    return {
+        get() {
+            return analytics;
+        },
+        async identify() {
+            if (!config.userId) {
+                console.log(`Decentraland CLI sends anonymous usage stats to improve their products, if you want to disable it change the configuration at ${log_1.colors.bold('~/.dclinfo')}\n`);
+                const userId = (0, uuid_1.v4)();
+                await dclInfoConfig.updateDCLInfo({ userId, trackStats: true });
+                analytics.identify({
+                    userId: USER_ID,
+                    traits: {
+                        devId: userId,
+                        createdAt: new Date()
+                    }
+                });
+            }
+        },
+        async track(eventName, eventProps) {
+            const trackFuture = (0, fp_future_1.default)();
+            const { userId, trackStats } = await dclInfoConfig.get();
+            if (!trackStats) {
+                return trackFuture.resolve();
+            }
+            const trackInfo = {
+                userId: USER_ID,
+                event: eventName,
+                properties: {
+                    ...eventProps,
+                    os: process.platform,
+                    nodeVersion: process.version,
+                    cliVersion: await dclInfoConfig.getVersion(),
+                    isCI: dclInfoConfig.isCI(),
+                    isEditor: dclInfoConfig.isEditor(),
+                    devId: userId
+                }
+            };
+            analytics.track(trackInfo, () => {
+                trackFuture.resolve();
+            });
+            if (!dclInfoConfig.isProduction()) {
+                console.log(trackInfo);
+            }
+            return trackFuture;
+        }
+    };
+}
+exports.createAnalyticsComponent = createAnalyticsComponent;

package/dist/components/dcl-info-config.d.ts

@@ -0,0 +1,11 @@
+import { CliComponents } from '.';
+import { DCLInfo } from '../logic/config';
+export type IDCLInfoConfigComponent = {
+    get(): Promise<DCLInfo>;
+    updateDCLInfo(value: Partial<DCLInfo>): Promise<Partial<DCLInfo>>;
+    getVersion(): Promise<string>;
+    isCI(): boolean;
+    isEditor(): boolean;
+    isProduction(): boolean;
+};
+export declare function createDCLInfoConfigComponent({ fs }: Pick<CliComponents, 'fs'>): Promise<IDCLInfoConfigComponent>;

package/dist/components/dcl-info-config.js

@@ -0,0 +1,75 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createDCLInfoConfigComponent = void 0;
+const path_1 = __importStar(require("path"));
+const config_1 = require("../logic/config");
+const fs_1 = require("../logic/fs");
+async function createDCLInfoConfigComponent({ fs }) {
+    function isProduction() {
+        return process.env.NODE_ENV === 'production' || __filename.includes('node_modules');
+    }
+    const defaultConfig = {
+        userId: '',
+        trackStats: false,
+        segmentKey: isProduction() ? 'sFdziRVDJo0taOnGzTZwafEL9nLIANZ3' : 'mjCV5Dc4VAKXLJAH5g7LyHyW1jrIR3to'
+    };
+    return {
+        async get() {
+            const dclInfoConfig = await (0, config_1.getDCLInfoConfig)({ fs });
+            const envConfig = (0, config_1.getEnvConfig)();
+            const config = { ...defaultConfig, ...dclInfoConfig, ...envConfig };
+            return config;
+        },
+        updateDCLInfo(value) {
+            return (0, fs_1.writeJSON)({ fs }, (0, config_1.getDclInfoPath)(), value);
+        },
+        async getVersion() {
+            try {
+                /* istanbul ignore next */
+                const sdkPath = path_1.default.dirname(require.resolve('@dcl/sdk/package.json', {
+                    paths: [process.cwd()]
+                }));
+                /* istanbul ignore next */
+                const packageJson = await (0, fs_1.readJSON)({ fs }, (0, path_1.resolve)(sdkPath, 'package.json'));
+                /* istanbul ignore next */
+                return packageJson.version ?? 'unknown';
+            }
+            catch (e) {
+                return 'unknown';
+            }
+        },
+        isEditor() {
+            return process.env.EDITOR === 'true';
+        },
+        isCI() {
+            return process.env.CI === 'true' || process.argv.includes('--ci') || process.argv.includes('--c');
+        },
+        isProduction() {
+            return isProduction();
+        }
+    };
+}
+exports.createDCLInfoConfigComponent = createDCLInfoConfigComponent;

package/dist/components/index.d.ts

@@ -1,9 +1,13 @@
 import { ILoggerComponent } from '@well-known-components/interfaces';
+import { IAnalyticsComponent } from './analytics';
+import { IDCLInfoConfigComponent } from './dcl-info-config';
 import { IFetchComponent } from './fetch';
 import { IFileSystemComponent } from './fs';
 export type CliComponents = {
     fs: IFileSystemComponent;
     fetch: IFetchComponent;
     logger: ILoggerComponent.ILogger;
+    dclInfoConfig: IDCLInfoConfigComponent;
+    analytics: IAnalyticsComponent;
 };
-export declare function initComponents(): CliComponents;
+export declare function initComponents(): Promise<CliComponents>;

package/dist/components/index.js

@@ -1,14 +1,20 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.initComponents = void 0;
+const analytics_1 = require("./analytics");
+const dcl_info_config_1 = require("./dcl-info-config");
 const fetch_1 = require("./fetch");
 const fs_1 = require("./fs");
 const log_1 = require("./log");
-function initComponents() {
+async function initComponents() {
+    const fsComponent = (0, fs_1.createFsComponent)();
+    const dclInfoConfig = await (0, dcl_info_config_1.createDCLInfoConfigComponent)({ fs: fsComponent });
     return {
-        fs: (0, fs_1.createFsComponent)(),
+        fs: fsComponent,
         fetch: (0, fetch_1.createFetchComponent)(),
-        logger: (0, log_1.createStdoutCliLogger)()
+        logger: (0, log_1.createStdoutCliLogger)(),
+        dclInfoConfig,
+        analytics: await (0, analytics_1.createAnalyticsComponent)({ dclInfoConfig })
     };
 }
 exports.initComponents = initComponents;

package/dist/index.js

@@ -24,7 +24,7 @@ async function main() {
     const args = (0, args_1.getArgs)();
     const command = process.argv[2];
     const needsHelp = args['--help'];
-    const components = (0, components_1.initComponents)();
+    const components = await (0, components_1.initComponents)();
     const commands = await (0, commands_1.getCommands)(components);
     if (!commands.includes(command)) {
         if (needsHelp) {
@@ -36,6 +36,7 @@ async function main() {
     // eslint-disable-next-line @typescript-eslint/no-var-requires
     const cmd = require(`${commands_1.COMMANDS_PATH}/${command}`);
     if (commandFnsAreValid(cmd)) {
+        await components.analytics.identify();
         const options = { args: cmd.args, components };
         if (needsHelp) {
             await cmd.help(options);

package/dist/logic/config.d.ts

@@ -0,0 +1,16 @@
+import { CliComponents } from '../components';
+export interface DCLInfo {
+    segmentKey?: string;
+    userId?: string;
+    trackStats?: boolean;
+}
+export declare const getDclInfoPath: () => string;
+/**
+ * Reads the contents of the `.dclinfo` file
+ */
+export declare function getDCLInfoConfig(components: Pick<CliComponents, 'fs'>): Promise<DCLInfo>;
+/**
+ * Config that can be override via ENV variables
+ */
+export declare function getEnvConfig(): Partial<DCLInfo>;
+export declare function removeEmptyKeys(obj: Record<string, unknown>): Record<string, unknown>;

package/dist/logic/config.js

@@ -0,0 +1,42 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.removeEmptyKeys = exports.getEnvConfig = exports.getDCLInfoConfig = exports.getDclInfoPath = void 0;
+const path_1 = __importDefault(require("path"));
+/* istanbul ignore next */
+const getDclInfoPath = () => path_1.default.resolve(process.env[process.platform === 'win32' ? 'USERPROFILE' : 'HOME'] ?? '', '.dclinfo');
+exports.getDclInfoPath = getDclInfoPath;
+/**
+ * Reads the contents of the `.dclinfo` file
+ */
+async function getDCLInfoConfig(components) {
+    try {
+        const content = await components.fs.readFile((0, exports.getDclInfoPath)(), 'utf8');
+        return JSON.parse(content);
+    }
+    catch (e) {
+        return {};
+    }
+}
+exports.getDCLInfoConfig = getDCLInfoConfig;
+/**
+ * Config that can be override via ENV variables
+ */
+function getEnvConfig() {
+    const { SEGMENT_KEY } = process.env;
+    const envConfig = {
+        segmentKey: SEGMENT_KEY
+    };
+    return removeEmptyKeys(envConfig);
+}
+exports.getEnvConfig = getEnvConfig;
+function removeEmptyKeys(obj) {
+    const result = {};
+    Object.keys(obj)
+        .filter((k) => !!obj[k])
+        .forEach((k) => (result[k] = obj[k]));
+    return result;
+}
+exports.removeEmptyKeys = removeEmptyKeys;

package/dist/logic/dcl-ignore.js

@@ -4,6 +4,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getDCLIgnorePatterns = exports.getDCLIgnoreFileContents = exports.defaultDclIgnore = void 0;
+/* istanbul ignore file */
 const path_1 = __importDefault(require("path"));
 exports.defaultDclIgnore = [
     '.*',

package/dist/logic/fs.d.ts

@@ -1,5 +1,6 @@
 import { IFileSystemComponent } from '../components/fs';
 import { IFetchComponent } from '../components/fetch';
+import { CliComponents } from '../components';
 /**
  * Check's if directory is empty
  * @param dir Directory to check for emptyness
@@ -22,3 +23,14 @@ export declare function download(components: {
  * @param dest Path to where to extract the zip file
  */
 export declare function extract(path: string, dest: string): Promise<string>;
+/**
+ * Reads a file and parses it's JSON content
+ * @param path The path to the subject json file
+ */
+export declare function readJSON<T>(components: Pick<CliComponents, 'fs'>, path: string): Promise<T>;
+/**
+ * Merges the provided content with a json file
+ * @param path The path to the subject json file
+ * @param content The content to be applied (as a plain object)
+ */
+export declare function writeJSON<T = unknown>(components: Pick<CliComponents, 'fs'>, path: string, content: Partial<T>): Promise<Partial<T>>;

package/dist/logic/fs.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.extract = exports.download = exports.isDirectoryEmpty = void 0;
+exports.writeJSON = exports.readJSON = exports.extract = exports.download = exports.isDirectoryEmpty = void 0;
 const extract_zip_1 = __importDefault(require("extract-zip"));
 const path_1 = require("path");
 /**
@@ -39,3 +39,31 @@ async function extract(path, dest) {
     return destPath;
 }
 exports.extract = extract;
+/**
+ * Reads a file and parses it's JSON content
+ * @param path The path to the subject json file
+ */
+async function readJSON(components, path) {
+    const content = await components.fs.readFile(path, 'utf-8');
+    return JSON.parse(content);
+}
+exports.readJSON = readJSON;
+/**
+ * Merges the provided content with a json file
+ * @param path The path to the subject json file
+ * @param content The content to be applied (as a plain object)
+ */
+async function writeJSON(components, path, content) {
+    let currentFile;
+    try {
+        currentFile = await readJSON(components, path);
+    }
+    catch (e) {
+        currentFile = {};
+    }
+    const newJson = { ...currentFile, ...content };
+    const strContent = JSON.stringify(newJson, null, 2);
+    await components.fs.writeFile(path, strContent);
+    return newJson;
+}
+exports.writeJSON = writeJSON;

package/dist/logic/project-files.d.ts

@@ -1,16 +1,21 @@
 import { ContentMapping } from '@dcl/schemas/dist/misc/content-mapping';
 import { CliComponents } from '../components';
+import { Scene } from '@dcl/schemas';
 /**
  * Returns an array of the publishable files for a given folder.
+ *
  */
 export declare function getPublishableFiles(components: Pick<CliComponents, 'fs'>, projectRoot: string): Promise<Array<string>>;
 /**
  * This function converts paths to decentraland-compatible paths.
  * - From windows separators to unix separators.
  * - All to lowercase
+ *
  */
 export declare function normalizeDecentralandFilename(filename: string): string;
 /**
  * Returns the content mappings for a specific project folder.
  */
 export declare function getProjectContentMappings(components: Pick<CliComponents, 'fs'>, projectRoot: string, hashingFunction: (filePath: string) => Promise<string>): Promise<ContentMapping[]>;
+export declare function getSceneJson(components: Pick<CliComponents, 'fs'>, projectRoot: string): Promise<Scene>;
+export declare const b64HashingFunction: (str: string) => Promise<string>;

package/dist/logic/project-files.js

@@ -3,15 +3,18 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getProjectContentMappings = exports.normalizeDecentralandFilename = exports.getPublishableFiles = void 0;
+exports.b64HashingFunction = exports.getSceneJson = exports.getProjectContentMappings = exports.normalizeDecentralandFilename = exports.getPublishableFiles = void 0;
 const dcl_ignore_1 = require("./dcl-ignore");
 const glob_1 = require("glob");
 const ignore_1 = __importDefault(require("ignore"));
 const path_1 = __importDefault(require("path"));
 const error_1 = require("./error");
+const scene_validations_1 = require("./scene-validations");
 /**
  * Returns an array of the publishable files for a given folder.
+ *
  */
+/* istanbul ignore next */
 async function getPublishableFiles(components, projectRoot) {
     const ignorePatterns = await (0, dcl_ignore_1.getDCLIgnorePatterns)(components, projectRoot);
     const ig = (0, ignore_1.default)().add(ignorePatterns);
@@ -29,7 +32,9 @@ exports.getPublishableFiles = getPublishableFiles;
  * This function converts paths to decentraland-compatible paths.
  * - From windows separators to unix separators.
  * - All to lowercase
+ *
  */
+/* istanbul ignore next */
 function normalizeDecentralandFilename(filename) {
     return filename.replace(/(\\)/g, '/').toLowerCase();
 }
@@ -37,7 +42,10 @@ exports.normalizeDecentralandFilename = normalizeDecentralandFilename;
 /**
  * Returns the content mappings for a specific project folder.
  */
-async function getProjectContentMappings(components, projectRoot, hashingFunction) {
+/* istanbul ignore next */
+async function getProjectContentMappings(components, projectRoot, 
+/* istanbul ignore next */
+hashingFunction) {
     const projectFiles = await getPublishableFiles(components, projectRoot);
     const ret = [];
     const usedFilenames = new Set();
@@ -60,3 +68,11 @@ async function getProjectContentMappings(components, projectRoot, hashingFunctio
     return ret;
 }
 exports.getProjectContentMappings = getProjectContentMappings;
+async function getSceneJson(components, projectRoot) {
+    const sceneJsonContent = await components.fs.readFile((0, scene_validations_1.getSceneFilePath)(projectRoot), 'utf8');
+    const sceneJson = JSON.parse(sceneJsonContent);
+    return sceneJson;
+}
+exports.getSceneJson = getSceneJson;
+const b64HashingFunction = async (str) => 'b64-' + Buffer.from(str).toString('base64');
+exports.b64HashingFunction = b64HashingFunction;

package/dist/logic/scene-validations.d.ts

@@ -11,3 +11,7 @@ export declare function assertValidScene(scene: Scene): Scene;
  * Fails the execution if one of the parcel data is invalid
  */
 export declare function validateSceneJson(components: Pick<CliComponents, 'fs' | 'logger'>, projectRoot: string): Promise<Scene>;
+export declare function getBaseCoords(scene: Scene): {
+    x: number;
+    y: number;
+};

package/dist/logic/scene-validations.js

@@ -1,10 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.validateSceneJson = exports.assertValidScene = exports.getSceneFilePath = exports.SCENE_FILE = void 0;
+exports.getBaseCoords = exports.validateSceneJson = exports.assertValidScene = exports.getSceneFilePath = exports.SCENE_FILE = void 0;
 const path_1 = require("path");
 const schemas_1 = require("@dcl/schemas");
 const error_1 = require("./error");
 const coordinates_1 = require("./coordinates");
+const project_files_1 = require("./project-files");
 exports.SCENE_FILE = 'scene.json';
 /**
  * Composes the path to the `scene.json` file based on the provided path.
@@ -53,8 +54,7 @@ exports.assertValidScene = assertValidScene;
  */
 async function validateSceneJson(components, projectRoot) {
     try {
-        const sceneJsonRaw = await components.fs.readFile(getSceneFilePath(projectRoot), 'utf8');
-        const sceneJson = JSON.parse(sceneJsonRaw);
+        const sceneJson = await (0, project_files_1.getSceneJson)(components, projectRoot);
         return assertValidScene(sceneJson);
     }
     catch (err) {
@@ -62,3 +62,11 @@ async function validateSceneJson(components, projectRoot) {
     }
 }
 exports.validateSceneJson = validateSceneJson;
+function getBaseCoords(scene) {
+    const [x, y] = scene.scene.base
+        .replace(/\ /g, '')
+        .split(',')
+        .map((a) => parseInt(a));
+    return { x, y };
+}
+exports.getBaseCoords = getBaseCoords;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dcl/sdk-commands",
-  "version": "7.0.0-4286109573.commit-baaf951",
+  "version": "7.0.0-4293371227.commit-54082c6",
   "description": "",
   "scripts": {
     "build": "tsc -p tsconfig.json",
@@ -16,11 +16,12 @@
   "author": "Decentraland",
   "license": "Apache-2.0",
   "dependencies": {
-    "@dcl/dcl-rollup": "7.0.6-4286109573.commit-baaf951",
+    "@dcl/dcl-rollup": "7.0.6-4293371227.commit-54082c6",
     "@dcl/hashing": "1.1.3",
     "@dcl/mini-comms": "1.0.1-20230216163137.commit-a4c75be",
     "@dcl/protocol": "1.0.0-4114477251.commit-ccb88d6",
     "@dcl/schemas": "6.10.0",
+    "@segment/analytics-node": "^1.0.0-beta.22",
     "@well-known-components/env-config-provider": "^1.2.0",
     "@well-known-components/http-server": "^2.0.0-20230216161243.commit-bfe3f0a",
     "@well-known-components/logger": "^3.1.2",
@@ -33,10 +34,12 @@
     "node-fetch": "^2.6.8",
     "open": "^8.4.0",
     "portfinder": "^1.0.32",
-    "undici": "^5.19.1"
+    "undici": "^5.19.1",
+    "uuid": "^9.0.0"
   },
   "devDependencies": {
     "@types/node-fetch": "^2.6.1",
+    "@types/uuid": "^9.0.1",
     "@types/ws": "^8.5.4"
   },
   "minCliVersion": "3.14.1",
@@ -46,5 +49,5 @@
     "displayName": "SDK",
     "tsconfig": "./tsconfig.json"
   },
-  "commit": "baaf951941795db25386cff7a620976efbcabbac"
+  "commit": "54082c63f87b970864c7e4eab94db193656d6aaa"
 }

package/src/commands/build/index.ts

@@ -4,10 +4,12 @@ import { getArgs } from '../../logic/args'
 import { compile } from '@dcl/dcl-rollup/compile'
 import future from 'fp-future'
 import { assertValidProjectFolder, installDependencies, needsDependencies } from '../../logic/project-validations'
+import { getBaseCoords } from '../../logic/scene-validations'
+import { b64HashingFunction, getSceneJson } from '../../logic/project-files'
 
 interface Options {
   args: Omit<typeof args, '_'>
-  components: Pick<CliComponents, 'fs' | 'logger'>
+  components: Pick<CliComponents, 'fs' | 'logger' | 'dclInfoConfig' | 'analytics'>
 }
 
 export const args = getArgs({
@@ -37,7 +39,6 @@ export function help() {
 
 export async function main(options: Options) {
   const projectRoot = resolve(process.cwd(), options.args['--dir'] || '.')
-
   await assertValidProjectFolder(options.components, projectRoot)
 
   const shouldInstallDeps = await needsDependencies(options.components, projectRoot)
@@ -60,6 +61,14 @@ export async function main(options: Options) {
   if (!watch) {
     watchingFuture.resolve(null)
   }
+  const sceneJson = await getSceneJson(options.components, projectRoot)
+  const coords = getBaseCoords(sceneJson)
+
+  await options.components.analytics.track('Build scene', {
+    projectHash: await b64HashingFunction(projectRoot),
+    coords,
+    isWorkspace: false
+  })
 
   await watchingFuture
 

package/src/commands/export-static/index.ts

@@ -3,16 +3,17 @@ import { getArgs } from '../../logic/args'
 import { hashV1 } from '@dcl/hashing'
 import { CliComponents } from '../../components'
 import { assertValidProjectFolder } from '../../logic/project-validations'
-import { getProjectContentMappings } from '../../logic/project-files'
+import { b64HashingFunction, getProjectContentMappings, getSceneJson } from '../../logic/project-files'
 import { CliError } from '../../logic/error'
 import { Entity, EntityType } from '@dcl/schemas'
 import { colors } from '../../components/log'
 import { printProgressInfo, printProgressStep, printSuccess } from '../../logic/beautiful-logs'
 import { createStaticRealm } from '../../logic/realm'
+import { getBaseCoords } from '../../logic/scene-validations'
 
 interface Options {
   args: typeof args
-  components: Pick<CliComponents, 'fetch' | 'fs' | 'logger'>
+  components: Pick<CliComponents, 'fetch' | 'fs' | 'logger' | 'dclInfoConfig' | 'analytics'>
 }
 
 export const args = getArgs({
@@ -137,6 +138,13 @@ export async function main(options: Options) {
   }
 
   printSuccess(logger, `Export finished!`, `=> The entity URN is ${colors.bold(urn)}`)
+  const sceneJson = await getSceneJson(options.components, projectRoot)
+  const coords = getBaseCoords(sceneJson)
+
+  await options.components.analytics.track('Export static', {
+    projectHash: await b64HashingFunction(projectRoot),
+    coords
+  })
 
   return { urn, entityId, destination: destDirectory }
 }

package/src/commands/init/index.ts

@@ -10,7 +10,7 @@ import { installDependencies, needsDependencies } from '../../logic/project-vali
 
 interface Options {
   args: typeof args
-  components: Pick<CliComponents, 'fetch' | 'fs' | 'logger'>
+  components: Pick<CliComponents, 'fetch' | 'fs' | 'logger' | 'dclInfoConfig' | 'analytics'>
 }
 
 export const args = getArgs({
@@ -44,6 +44,7 @@ export async function main(options: Options) {
   if (shouldInstallDeps && !options.args['--skip-install']) {
     await installDependencies(options.components, dir)
   }
+  await options.components.analytics.track('Scene created', { projectType: scene, url })
 }
 
 const moveFilesFromDir = async (components: Pick<CliComponents, 'fs'>, dir: string, folder: string) => {

package/src/commands/start/index.ts

@@ -7,7 +7,7 @@ import { CliComponents } from '../../components'
 import { main as build } from '../build'
 import { getArgs } from '../../logic/args'
 import { needsDependencies, npmRun } from '../../logic/project-validations'
-import { validateSceneJson } from '../../logic/scene-validations'
+import { getBaseCoords, validateSceneJson } from '../../logic/scene-validations'
 import { CliError } from '../../logic/error'
 import { previewPort } from '../../logic/get-free-port'
 import { ISignalerComponent, PreviewComponents } from './types'
@@ -22,10 +22,11 @@ import { createStdoutCliLogger } from '../../components/log'
 import { wireFileWatcherToWebSockets } from './server/file-watch-notifier'
 import { wireRouter } from './server/routes'
 import { createWsComponent } from './server/ws'
+import { b64HashingFunction, getSceneJson } from '../../logic/project-files'
 
 interface Options {
   args: typeof args
-  components: Pick<CliComponents, 'fetch' | 'fs' | 'logger'>
+  components: Pick<CliComponents, 'fetch' | 'fs' | 'logger' | 'dclInfoConfig' | 'analytics'>
 }
 
 export const args = getArgs({
@@ -83,7 +84,8 @@ export async function main(options: Options) {
   const skipBuild = args['--skip-build']
   const watch = !args['--no-watch']
   const enableWeb3 = args['--web3']
-  const baseCoords = { x: 0, y: 0 }
+
+  // TODO: FIX this hardcoded values ?
   const hasPortableExperience = false
 
   // first run `npm run build`, this can be disabled with --skip-build
@@ -97,6 +99,8 @@ export async function main(options: Options) {
   }
 
   await validateSceneJson(options.components, projectRoot)
+  const sceneJson = await getSceneJson(options.components, projectRoot)
+  const baseCoords = getBaseCoords(sceneJson)
 
   if (await needsDependencies(options.components, projectRoot)) {
     const npmModulesPath = path.resolve(projectRoot, 'node_modules')
@@ -154,7 +158,11 @@ export async function main(options: Options) {
 
       const networkInterfaces = os.networkInterfaces()
       const availableURLs: string[] = []
-
+      await components.analytics.track('Preview started', {
+        projectHash: await b64HashingFunction(projectRoot),
+        coords: baseCoords,
+        isWorkspace: false
+      })
       components.logger.log(`Preview server is now running!`)
       components.logger.log('Available on:\n')
 

package/src/commands/start/server/endpoints.ts

@@ -6,7 +6,7 @@ import { Entity, EntityType, Locale, Wearable } from '@dcl/schemas'
 import fetch, { Headers } from 'node-fetch'
 import { fetchEntityByPointer } from '../../../logic/catalyst-requests'
 import { CliComponents } from '../../../components'
-import { getProjectContentMappings } from '../../../logic/project-files'
+import { b64HashingFunction, getProjectContentMappings } from '../../../logic/project-files'
 
 function getCatalystUrl(): URL {
   return new URL('https://peer.decentraland.org')
@@ -227,8 +227,6 @@ function serveFolders(components: Pick<CliComponents, 'fs'>, router: Router<Prev
   })
 }
 
-const b64HashingFunction = async (str: string) => 'b64-' + Buffer.from(str).toString('base64')
-
 async function getAllPreviewWearables(
   components: Pick<CliComponents, 'fs'>,
   { baseFolders, baseUrl }: { baseFolders: string[]; baseUrl: string }

package/src/components/analytics.ts

@@ -0,0 +1,92 @@
+import { v4 as uuidv4 } from 'uuid'
+import { Analytics } from '@segment/analytics-node'
+import future from 'fp-future'
+
+import { CliComponents } from '.'
+import { colors } from './log'
+
+export type IAnalyticsComponent = {
+  get(): Analytics
+  identify(): Promise<void>
+  track<T extends keyof Events>(eventName: T, eventProps: Events[T]): Promise<void>
+}
+
+type Events = {
+  'Scene created': {
+    projectType: string
+    url: string
+  }
+  'Preview started': {
+    projectHash: string
+    coords: { x: number; y: number }
+    isWorkspace: boolean
+  }
+  'Build scene': {
+    projectHash: string
+    coords: { x: number; y: number }
+    isWorkspace: boolean
+  }
+  'Export static': {
+    projectHash: string
+    coords: { x: number; y: number }
+  }
+}
+
+export async function createAnalyticsComponent({
+  dclInfoConfig
+}: Pick<CliComponents, 'dclInfoConfig'>): Promise<IAnalyticsComponent> {
+  const USER_ID = 'sdk-commands-user'
+  const config = await dclInfoConfig.get()
+  const analytics: Analytics = new Analytics({ writeKey: config.segmentKey ?? '' })
+  return {
+    get() {
+      return analytics
+    },
+    async identify() {
+      if (!config.userId) {
+        console.log(
+          `Decentraland CLI sends anonymous usage stats to improve their products, if you want to disable it change the configuration at ${colors.bold(
+            '~/.dclinfo'
+          )}\n`
+        )
+
+        const userId = uuidv4()
+        await dclInfoConfig.updateDCLInfo({ userId, trackStats: true })
+        analytics.identify({
+          userId: USER_ID,
+          traits: {
+            devId: userId,
+            createdAt: new Date()
+          }
+        })
+      }
+    },
+    async track<T extends keyof Events>(eventName: T, eventProps: Events[T]) {
+      const trackFuture = future<void>()
+      const { userId, trackStats } = await dclInfoConfig.get()
+      if (!trackStats) {
+        return trackFuture.resolve()
+      }
+      const trackInfo = {
+        userId: USER_ID,
+        event: eventName,
+        properties: {
+          ...eventProps,
+          os: process.platform,
+          nodeVersion: process.version,
+          cliVersion: await dclInfoConfig.getVersion(),
+          isCI: dclInfoConfig.isCI(),
+          isEditor: dclInfoConfig.isEditor(),
+          devId: userId
+        }
+      }
+      analytics.track(trackInfo, () => {
+        trackFuture.resolve()
+      })
+      if (!dclInfoConfig.isProduction()) {
+        console.log(trackInfo)
+      }
+      return trackFuture
+    }
+  }
+}

package/src/components/dcl-info-config.ts

@@ -0,0 +1,63 @@
+import path, { resolve } from 'path'
+import { CliComponents } from '.'
+import { DCLInfo, getDCLInfoConfig, getDclInfoPath, getEnvConfig } from '../logic/config'
+import { readJSON, writeJSON } from '../logic/fs'
+
+export type IDCLInfoConfigComponent = {
+  get(): Promise<DCLInfo>
+  updateDCLInfo(value: Partial<DCLInfo>): Promise<Partial<DCLInfo>>
+  getVersion(): Promise<string>
+  isCI(): boolean
+  isEditor(): boolean
+  isProduction(): boolean
+}
+
+export async function createDCLInfoConfigComponent({
+  fs
+}: Pick<CliComponents, 'fs'>): Promise<IDCLInfoConfigComponent> {
+  function isProduction() {
+    return process.env.NODE_ENV === 'production' || __filename.includes('node_modules')
+  }
+  const defaultConfig: Partial<DCLInfo> = {
+    userId: '',
+    trackStats: false,
+    segmentKey: isProduction() ? 'sFdziRVDJo0taOnGzTZwafEL9nLIANZ3' : 'mjCV5Dc4VAKXLJAH5g7LyHyW1jrIR3to'
+  }
+
+  return {
+    async get() {
+      const dclInfoConfig = await getDCLInfoConfig({ fs })
+      const envConfig = getEnvConfig()
+      const config = { ...defaultConfig, ...dclInfoConfig, ...envConfig }
+      return config
+    },
+    updateDCLInfo(value: Partial<DCLInfo>) {
+      return writeJSON({ fs }, getDclInfoPath(), value)
+    },
+    async getVersion() {
+      try {
+        /* istanbul ignore next */
+        const sdkPath = path.dirname(
+          require.resolve('@dcl/sdk/package.json', {
+            paths: [process.cwd()]
+          })
+        )
+        /* istanbul ignore next */
+        const packageJson = await readJSON<{ version: string }>({ fs }, resolve(sdkPath, 'package.json'))
+        /* istanbul ignore next */
+        return packageJson.version ?? 'unknown'
+      } catch (e) {
+        return 'unknown'
+      }
+    },
+    isEditor() {
+      return process.env.EDITOR === 'true'
+    },
+    isCI() {
+      return process.env.CI === 'true' || process.argv.includes('--ci') || process.argv.includes('--c')
+    },
+    isProduction() {
+      return isProduction()
+    }
+  }
+}

package/src/components/index.ts

@@ -1,4 +1,6 @@
 import { ILoggerComponent } from '@well-known-components/interfaces'
+import { createAnalyticsComponent, IAnalyticsComponent } from './analytics'
+import { createDCLInfoConfigComponent, IDCLInfoConfigComponent } from './dcl-info-config'
 import { createFetchComponent, IFetchComponent } from './fetch'
 import { createFsComponent, IFileSystemComponent } from './fs'
 import { createStdoutCliLogger } from './log'
@@ -7,12 +9,18 @@ export type CliComponents = {
   fs: IFileSystemComponent
   fetch: IFetchComponent
   logger: ILoggerComponent.ILogger
+  dclInfoConfig: IDCLInfoConfigComponent
+  analytics: IAnalyticsComponent
 }
 
-export function initComponents(): CliComponents {
+export async function initComponents(): Promise<CliComponents> {
+  const fsComponent = createFsComponent()
+  const dclInfoConfig = await createDCLInfoConfigComponent({ fs: fsComponent })
   return {
-    fs: createFsComponent(),
+    fs: fsComponent,
     fetch: createFetchComponent(),
-    logger: createStdoutCliLogger()
+    logger: createStdoutCliLogger(),
+    dclInfoConfig,
+    analytics: await createAnalyticsComponent({ dclInfoConfig })
   }
 }

package/src/index.ts

@@ -41,7 +41,7 @@ async function main() {
   const args = getArgs()
   const command = process.argv[2]
   const needsHelp = args['--help']
-  const components: CliComponents = initComponents()
+  const components: CliComponents = await initComponents()
 
   const commands = await getCommands(components)
 
@@ -52,11 +52,11 @@ async function main() {
     }
     throw new CliError(`Command ${command} is invalid. ${helpMessage(commands)}`)
   }
-
   // eslint-disable-next-line @typescript-eslint/no-var-requires
   const cmd = require(`${COMMANDS_PATH}/${command}`)
 
   if (commandFnsAreValid(cmd)) {
+    await components.analytics.identify()
     const options = { args: cmd.args, components }
     if (needsHelp) {
       await cmd.help(options)

package/src/logic/config.ts

@@ -0,0 +1,45 @@
+import path from 'path'
+import { CliComponents } from '../components'
+
+export interface DCLInfo {
+  segmentKey?: string
+  userId?: string
+  trackStats?: boolean
+}
+
+/* istanbul ignore next */
+export const getDclInfoPath = () =>
+  path.resolve(process.env[process.platform === 'win32' ? 'USERPROFILE' : 'HOME'] ?? '', '.dclinfo')
+
+/**
+ * Reads the contents of the `.dclinfo` file
+ */
+export async function getDCLInfoConfig(components: Pick<CliComponents, 'fs'>): Promise<DCLInfo> {
+  try {
+    const content = await components.fs.readFile(getDclInfoPath(), 'utf8')
+    return JSON.parse(content) as DCLInfo
+  } catch (e) {
+    return {}
+  }
+}
+
+/**
+ * Config that can be override via ENV variables
+ */
+export function getEnvConfig(): Partial<DCLInfo> {
+  const { SEGMENT_KEY } = process.env
+
+  const envConfig = {
+    segmentKey: SEGMENT_KEY
+  }
+
+  return removeEmptyKeys(envConfig)
+}
+
+export function removeEmptyKeys(obj: Record<string, unknown>) {
+  const result: Record<string, unknown> = {}
+  Object.keys(obj)
+    .filter((k) => !!obj[k])
+    .forEach((k) => (result[k] = obj[k]))
+  return result
+}

package/src/logic/dcl-ignore.ts

@@ -1,3 +1,4 @@
+/* istanbul ignore file */
 import path from 'path'
 import { CliComponents } from '../components'
 

package/src/logic/fs.ts

@@ -2,6 +2,7 @@ import extractZip from 'extract-zip'
 import { resolve } from 'path'
 import { IFileSystemComponent } from '../components/fs'
 import { IFetchComponent } from '../components/fetch'
+import { CliComponents } from '../components'
 
 /**
  * Check's if directory is empty
@@ -39,3 +40,37 @@ export async function extract(path: string, dest: string): Promise<string> {
   await extractZip(resolve(path), { dir: destPath })
   return destPath
 }
+
+/**
+ * Reads a file and parses it's JSON content
+ * @param path The path to the subject json file
+ */
+export async function readJSON<T>(components: Pick<CliComponents, 'fs'>, path: string): Promise<T> {
+  const content = await components.fs.readFile(path, 'utf-8')
+  return JSON.parse(content) as T
+}
+
+/**
+ * Merges the provided content with a json file
+ * @param path The path to the subject json file
+ * @param content The content to be applied (as a plain object)
+ */
+export async function writeJSON<T = unknown>(
+  components: Pick<CliComponents, 'fs'>,
+  path: string,
+  content: Partial<T>
+): Promise<Partial<T>> {
+  let currentFile
+
+  try {
+    currentFile = await readJSON<T>(components, path)
+  } catch (e) {
+    currentFile = {}
+  }
+
+  const newJson = { ...currentFile, ...content }
+  const strContent = JSON.stringify(newJson, null, 2)
+
+  await components.fs.writeFile(path, strContent)
+  return newJson
+}

package/src/logic/project-files.ts

@@ -5,10 +5,14 @@ import { sync as globSync } from 'glob'
 import ignore from 'ignore'
 import path from 'path'
 import { CliError } from './error'
+import { getSceneFilePath } from './scene-validations'
+import { Scene } from '@dcl/schemas'
 
 /**
  * Returns an array of the publishable files for a given folder.
+ *
  */
+/* istanbul ignore next */
 export async function getPublishableFiles(
   components: Pick<CliComponents, 'fs'>,
   projectRoot: string
@@ -32,7 +36,9 @@ export async function getPublishableFiles(
  * This function converts paths to decentraland-compatible paths.
  * - From windows separators to unix separators.
  * - All to lowercase
+ *
  */
+/* istanbul ignore next */
 export function normalizeDecentralandFilename(filename: string) {
   return filename.replace(/(\\)/g, '/').toLowerCase()
 }
@@ -40,9 +46,11 @@ export function normalizeDecentralandFilename(filename: string) {
 /**
  * Returns the content mappings for a specific project folder.
  */
+/* istanbul ignore next */
 export async function getProjectContentMappings(
   components: Pick<CliComponents, 'fs'>,
   projectRoot: string,
+  /* istanbul ignore next */
   hashingFunction: (filePath: string) => Promise<string>
 ): Promise<ContentMapping[]> {
   const projectFiles = await getPublishableFiles(components, projectRoot)
@@ -74,3 +82,11 @@ export async function getProjectContentMappings(
 
   return ret
 }
+
+export async function getSceneJson(components: Pick<CliComponents, 'fs'>, projectRoot: string): Promise<Scene> {
+  const sceneJsonContent = await components.fs.readFile(getSceneFilePath(projectRoot), 'utf8')
+  const sceneJson = JSON.parse(sceneJsonContent) as Scene
+  return sceneJson
+}
+
+export const b64HashingFunction = async (str: string) => 'b64-' + Buffer.from(str).toString('base64')

package/src/logic/scene-validations.ts

@@ -3,6 +3,7 @@ import { Scene } from '@dcl/schemas'
 import { CliError } from './error'
 import { getObject, inBounds, getBounds, areConnected } from './coordinates'
 import { CliComponents } from '../components'
+import { getSceneJson } from './project-files'
 
 export const SCENE_FILE = 'scene.json'
 
@@ -63,11 +64,18 @@ export async function validateSceneJson(
   projectRoot: string
 ): Promise<Scene> {
   try {
-    const sceneJsonRaw = await components.fs.readFile(getSceneFilePath(projectRoot), 'utf8')
-    const sceneJson = JSON.parse(sceneJsonRaw) as Scene
+    const sceneJson = await getSceneJson(components, projectRoot)
 
     return assertValidScene(sceneJson)
   } catch (err: any) {
     throw new CliError(`Error reading the scene.json file: ${err.message}`)
   }
 }
+
+export function getBaseCoords(scene: Scene): { x: number; y: number } {
+  const [x, y] = scene.scene.base
+    .replace(/\ /g, '')
+    .split(',')
+    .map((a) => parseInt(a))
+  return { x, y }
+}