@dcl/sdk-commands 7.0.0-4293371227.commit-54082c6 → 7.0.0-4295573637.commit-6d503ad

package/dist/logic/get-free-port.js

@@ -3,18 +3,18 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.previewPort = void 0;
+exports.getPort = void 0;
 const portfinder_1 = __importDefault(require("portfinder"));
-async function previewPort() {
-    let resolvedPort = 0;
+async function getPort(port = 0, failoverPort = 2044) {
+    let resolvedPort = port && Number.isInteger(port) ? port : 0;
     if (!resolvedPort) {
         try {
-            resolvedPort = await portfinder_1.default.getPortPromise();
+            resolvedPort = await portfinder_1.default.getPortPromise({ port: resolvedPort });
         }
         catch (e) {
-            resolvedPort = 2044;
+            resolvedPort = failoverPort;
         }
     }
     return resolvedPort;
 }
-exports.previewPort = previewPort;
+exports.getPort = getPort;

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

@@ -1,6 +1,5 @@
 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.
  *
@@ -17,5 +16,4 @@ 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,13 +3,12 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.b64HashingFunction = exports.getSceneJson = exports.getProjectContentMappings = exports.normalizeDecentralandFilename = exports.getPublishableFiles = void 0;
+exports.b64HashingFunction = 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.
  *
@@ -60,6 +59,7 @@ hashingFunction) {
         if (usedFilenames.has(normalizedFile)) {
             throw new error_1.CliError(`DuplicatedFilenameError: the file ${file} exists with a different casing. Please manually remove one occurrence`);
         }
+        usedFilenames.add(normalizedFile);
         ret.push({
             file: normalizedFile,
             hash: await hashingFunction(absolutePath)
@@ -68,11 +68,5 @@ hashingFunction) {
     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/project-validations.js

@@ -16,7 +16,7 @@ async function assertValidProjectFolder(components, projectRoot) {
     switch (true) {
         // case wearable
         case await components.fs.fileExists((0, path_1.resolve)(projectRoot, 'scene.json')): {
-            return { scene: await (0, scene_validations_1.validateSceneJson)(components, projectRoot) };
+            return { scene: await (0, scene_validations_1.getValidSceneJson)(components, projectRoot) };
         }
         default: {
             throw new error_1.CliError(`UnknownProjectKind: the kind of project of the folder ${projectRoot} cannot be identified`);

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

@@ -1,17 +1,32 @@
+/// <reference types="node" />
 import { Scene } from '@dcl/schemas';
 import { CliComponents } from '../components';
+export interface IFile {
+    path: string;
+    content: Buffer;
+    size: number;
+}
 export declare const SCENE_FILE = "scene.json";
+export declare const MAX_FILE_SIZE_BYTES: number;
 /**
  * Composes the path to the `scene.json` file based on the provided path.
  * @param projectRoot The path to the directory containing the scene file.
  */
 export declare function getSceneFilePath(projectRoot: string): string;
-export declare function assertValidScene(scene: Scene): Scene;
+export declare function assertValidScene(scene: Scene): void;
 /**
- * Fails the execution if one of the parcel data is invalid
+ * Get valid Scene JSON
  */
-export declare function validateSceneJson(components: Pick<CliComponents, 'fs' | 'logger'>, projectRoot: string): Promise<Scene>;
+export declare function getValidSceneJson(components: Pick<CliComponents, 'fs' | 'logger'>, projectRoot: string): Promise<Scene>;
 export declare function getBaseCoords(scene: Scene): {
     x: number;
     y: number;
 };
+/**
+ * Returns a promise of an array of objects containing the path and the content for all the files in the project.
+ * All the paths added to the `.dclignore` file will be excluded from the results.
+ * Windows directory separators are replaced for POSIX separators.
+ * @param ignoreFile The contents of the .dclignore file
+ */
+export declare function getFiles(components: Pick<CliComponents, 'fs' | 'logger'>, dir: string): Promise<IFile[]>;
+export declare function validateFilesSizes(files: IFile[]): void;

package/dist/logic/scene-validations.js

@@ -1,12 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getBaseCoords = exports.validateSceneJson = exports.assertValidScene = exports.getSceneFilePath = exports.SCENE_FILE = void 0;
+exports.validateFilesSizes = exports.getFiles = exports.getBaseCoords = exports.getValidSceneJson = exports.assertValidScene = exports.getSceneFilePath = exports.MAX_FILE_SIZE_BYTES = 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';
+exports.MAX_FILE_SIZE_BYTES = 50 * 1e6; // 50mb
 /**
  * Composes the path to the `scene.json` file based on the provided path.
  * @param projectRoot The path to the directory containing the scene file.
@@ -46,22 +47,23 @@ function assertValidScene(scene) {
     if (!scene.main?.endsWith('.js')) {
         throw new error_1.CliError(`Main scene format file (${scene.main}) is not a supported format`);
     }
-    return scene;
 }
 exports.assertValidScene = assertValidScene;
 /**
- * Fails the execution if one of the parcel data is invalid
+ * Get valid Scene JSON
  */
-async function validateSceneJson(components, projectRoot) {
+async function getValidSceneJson(components, projectRoot) {
     try {
-        const sceneJson = await (0, project_files_1.getSceneJson)(components, projectRoot);
-        return assertValidScene(sceneJson);
+        const sceneJsonRaw = await components.fs.readFile(getSceneFilePath(projectRoot), 'utf8');
+        const sceneJson = JSON.parse(sceneJsonRaw);
+        assertValidScene(sceneJson);
+        return sceneJson;
     }
     catch (err) {
         throw new error_1.CliError(`Error reading the scene.json file: ${err.message}`);
     }
 }
-exports.validateSceneJson = validateSceneJson;
+exports.getValidSceneJson = getValidSceneJson;
 function getBaseCoords(scene) {
     const [x, y] = scene.scene.base
         .replace(/\ /g, '')
@@ -70,3 +72,34 @@ function getBaseCoords(scene) {
     return { x, y };
 }
 exports.getBaseCoords = getBaseCoords;
+/**
+ * Returns a promise of an array of objects containing the path and the content for all the files in the project.
+ * All the paths added to the `.dclignore` file will be excluded from the results.
+ * Windows directory separators are replaced for POSIX separators.
+ * @param ignoreFile The contents of the .dclignore file
+ */
+async function getFiles(components, dir) {
+    const files = await (0, project_files_1.getPublishableFiles)(components, dir);
+    const data = [];
+    for (let i = 0; i < files.length; i++) {
+        const file = files[i];
+        const filePath = (0, path_1.resolve)(dir, file);
+        const stat = await components.fs.stat(filePath);
+        const content = await components.fs.readFile(filePath);
+        data.push({
+            path: file.replace(/\\/g, '/'),
+            content: Buffer.from(content),
+            size: stat.size
+        });
+    }
+    return data;
+}
+exports.getFiles = getFiles;
+function validateFilesSizes(files) {
+    for (const { path, size } of files) {
+        if (size > exports.MAX_FILE_SIZE_BYTES) {
+            throw new error_1.CliError(`Maximum file size exceeded: '${path}' is larger than ${exports.MAX_FILE_SIZE_BYTES / 1e6}MB`);
+        }
+    }
+}
+exports.validateFilesSizes = validateFilesSizes;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dcl/sdk-commands",
-  "version": "7.0.0-4293371227.commit-54082c6",
+  "version": "7.0.0-4295573637.commit-6d503ad",
   "description": "",
   "scripts": {
     "build": "tsc -p tsconfig.json",
@@ -16,8 +16,9 @@
   "author": "Decentraland",
   "license": "Apache-2.0",
   "dependencies": {
-    "@dcl/dcl-rollup": "7.0.6-4293371227.commit-54082c6",
+    "@dcl/dcl-rollup": "7.0.6-4295573637.commit-6d503ad",
     "@dcl/hashing": "1.1.3",
+    "@dcl/linker-dapp": "0.7.0",
     "@dcl/mini-comms": "1.0.1-20230216163137.commit-a4c75be",
     "@dcl/protocol": "1.0.0-4114477251.commit-ccb88d6",
     "@dcl/schemas": "6.10.0",
@@ -29,6 +30,7 @@
     "arg": "5.0.2",
     "chokidar": "^3.5.3",
     "colorette": "^2.0.19",
+    "dcl-catalyst-client": "^14.0.9",
     "extract-zip": "2.0.1",
     "ignore": "^5.2.4",
     "node-fetch": "^2.6.8",
@@ -49,5 +51,8 @@
     "displayName": "SDK",
     "tsconfig": "./tsconfig.json"
   },
-  "commit": "54082c63f87b970864c7e4eab94db193656d6aaa"
+  "files": [
+    "dist"
+  ],
+  "commit": "6d503ad455f1a93eca45772ca3ba698f7ad6e089"
 }

package/src/commands/build/index.ts

@@ -1,77 +0,0 @@
-import { resolve } from 'path'
-import { CliComponents } from '../../components'
-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' | 'dclInfoConfig' | 'analytics'>
-}
-
-export const args = getArgs({
-  '--watch': Boolean,
-  '-w': '--watch',
-  '--production': Boolean,
-  '-p': '--production',
-  '--skip-install': Boolean,
-  '--dir': String
-})
-
-export 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'
-  `
-}
-
-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)
-
-  if (shouldInstallDeps && !options.args['--skip-install']) {
-    await installDependencies(options.components, projectRoot)
-  }
-
-  const watch = !!options.args['--watch']
-
-  const watchingFuture = future<any>()
-
-  await compile({
-    project: projectRoot,
-    watch,
-    production: !!options.args['--production'],
-    watchingFuture
-  })
-
-  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
-
-  // track stuff...
-  // https://github.com/decentraland/cli/blob/main/src/commands/build.ts
-}

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

@@ -1,150 +0,0 @@
-import { resolve } from 'path'
-import { getArgs } from '../../logic/args'
-import { hashV1 } from '@dcl/hashing'
-import { CliComponents } from '../../components'
-import { assertValidProjectFolder } from '../../logic/project-validations'
-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' | 'dclInfoConfig' | 'analytics'>
-}
-
-export const args = getArgs({
-  '--dir': String,
-  '--destination': String,
-  '--timestamp': String,
-  '--realmName': String,
-  '--baseUrl': String
-})
-
-export 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
-`
-}
-
-export async function main(options: Options) {
-  const { fs, logger } = options.components
-  const projectRoot = resolve(process.cwd(), options.args['--dir'] || '.')
-  const destDirectory = resolve(process.cwd(), options.args['--destination'] || '.')
-  const willCreateRealm = !!args['--realmName']
-  let currentStep = 1
-  const maxSteps = 3 + (willCreateRealm ? 1 : 0)
-
-  if (willCreateRealm && !args['--baseUrl']) {
-    throw new CliError(`--baseUrl is mandatory when --realmName is provided`)
-  }
-
-  if (willCreateRealm && !/^[a-z][a-z0-9-/]*$/i.test(args['--realmName']!)) {
-    throw new CliError(`--realmName has invalid characters`)
-  }
-
-  printProgressStep(logger, 'Reading project files...', currentStep++, maxSteps)
-
-  await fs.mkdir(destDirectory, { recursive: true })
-  if (!(await fs.directoryExists(destDirectory))) {
-    throw new CliError(`The destination path ${destDirectory} is not a directory`)
-  }
-
-  const project = await assertValidProjectFolder(options.components, projectRoot)
-  const filesToExport = await getProjectContentMappings(options.components, projectRoot, async (file) => {
-    return await hashV1(fs.createReadStream(resolve(projectRoot, file)))
-  })
-
-  printProgressStep(logger, 'Copying files...', currentStep++, maxSteps)
-
-  for (const { file, hash } of filesToExport) {
-    const src = resolve(projectRoot, file)
-    const dst = resolve(destDirectory, hash)
-
-    if (src.startsWith(destDirectory)) continue
-
-    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: Omit<Entity, 'id'> = {
-    content: filesToExport,
-    pointers: [],
-    timestamp: args['--timestamp'] ? new Date(args['--timestamp']).getTime() : Date.now(),
-    type: EntityType.SCENE,
-    // for now, the only valid export is for scenes
-    metadata: project.scene,
-    version: 'v3'
-  }
-
-  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 hashV1(entityRaw)
-  const dst = resolve(destDirectory, entityId)
-  await fs.writeFile(dst, entityRaw)
-
-  printProgressInfo(logger, `> ${entityId} -> [ENTITY FILE]`)
-
-  let urn = `urn:decentraland:entity:${entityId}`
-
-  if (args['--baseUrl']) {
-    urn += '?baseUrl=' + args['--baseUrl']
-    // baseUrl must end with /
-    if (!urn.endsWith('/')) urn += '/'
-  }
-
-  if (willCreateRealm) {
-    // prepare the realm object
-    printProgressStep(logger, 'Creating realm file...', currentStep++, maxSteps)
-    const realm = createStaticRealm()
-    const realmName = args['--realmName']!
-
-    realm.configurations!.scenesUrn = [urn]
-    realm.configurations!.realmName = realmName
-
-    // write the realm file
-    const realmDirectory = resolve(destDirectory, realmName)
-    await fs.mkdir(realmDirectory, { recursive: true })
-    if (!(await fs.directoryExists(realmDirectory))) {
-      throw new CliError(`The destination path ${realmDirectory} is not a directory`)
-    }
-    const dst = resolve(realmDirectory, 'about')
-    await fs.writeFile(dst, JSON.stringify(realm, null, 2))
-    printProgressInfo(logger, `> ${realmName}/about -> [REALM FILE]`)
-  }
-
-  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

@@ -1,68 +0,0 @@
-import { join, resolve } from 'path'
-
-import { getArgs } from '../../logic/args'
-import { CliError } from '../../logic/error'
-import { CliComponents } from '../../components'
-import { isDirectoryEmpty, download, extract } from '../../logic/fs'
-
-import { get as getRepo } from './repos'
-import { installDependencies, needsDependencies } from '../../logic/project-validations'
-
-interface Options {
-  args: typeof args
-  components: Pick<CliComponents, 'fetch' | 'fs' | 'logger' | 'dclInfoConfig' | 'analytics'>
-}
-
-export const args = getArgs({
-  '--yes': Boolean,
-  '-y': '--yes',
-  '--dir': String,
-  '--skip-install': Boolean
-})
-
-export async function help() {}
-
-export async function main(options: Options) {
-  const dir = resolve(process.cwd(), options.args['--dir'] || '.')
-  const isEmpty = await isDirectoryEmpty(options.components, dir)
-  const yes = options.args['--yes']
-
-  if (!isEmpty && !yes) {
-    throw new 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 } = getRepo(scene)
-  const zip = await download(options.components, url, join(dir, `${scene}.zip`))
-  await extract(zip, dir)
-  await options.components.fs.unlink(zip)
-  await moveFilesFromDirs(options.components, dir, contentFolders)
-
-  // npm install
-  const shouldInstallDeps = await needsDependencies(options.components, dir)
-  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) => {
-  const files = await components.fs.readdir(folder)
-  await Promise.all(
-    files.map(($) => {
-      const filePath = resolve(folder, $)
-      return components.fs.rename(filePath, resolve(dir, $))
-    })
-  )
-  await components.fs.rmdir(folder)
-}
-
-const moveFilesFromDirs = async (components: Pick<CliComponents, 'fs'>, dir: string, folders: string[]) => {
-  await Promise.all(
-    folders.map(($) => {
-      const folderPath = resolve(dir, $)
-      return moveFilesFromDir(components, dir, folderPath)
-    })
-  )
-}

package/src/commands/init/repos.ts

@@ -1,17 +0,0 @@
-type Scene = 'scene-template'
-
-type Repos = {
-  [key in Scene]: {
-    url: string
-    contentFolders: string[]
-  }
-}
-
-const REPOS: Repos = {
-  'scene-template': {
-    url: 'https://github.com/decentraland/sdk7-scene-template/archive/refs/heads/main.zip',
-    contentFolders: ['sdk7-scene-template-main']
-  }
-}
-
-export const get = (scene: Scene): Repos[Scene] => REPOS[scene]