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

package/src/logic/project-validations.ts

@@ -0,0 +1,61 @@
+import { Scene } from '@dcl/schemas'
+import { resolve } from 'path'
+import { CliComponents } from '../components'
+import { CliError } from './error'
+import { exec } from './exec'
+import { validateSceneJson } from './scene-validations'
+
+/**
+ * Asserts that the projectRoot is a valid project
+ */
+export async function assertValidProjectFolder(
+  components: Pick<CliComponents, 'fs' | 'logger'>,
+  projectRoot: string
+): Promise<{ scene: Scene }> {
+  // no validations for now, only check that it exists
+  if (!(await components.fs.fileExists(resolve(projectRoot, 'package.json'))))
+    throw new CliError(`The project root doesn't have a package.json file`)
+
+  // now we will iterate over different file to evaluate the project kind
+  switch (true) {
+    // case wearable
+    case await components.fs.fileExists(resolve(projectRoot, 'scene.json')): {
+      return { scene: await validateSceneJson(components, projectRoot) }
+    }
+    default: {
+      throw new CliError(`UnknownProjectKind: the kind of project of the folder ${projectRoot} cannot be identified`)
+    }
+  }
+}
+
+/*
+ * Returns true if the project contains an empty node_modules folder
+ */
+export async function needsDependencies(components: Pick<CliComponents, 'fs'>, dir: string): Promise<boolean> {
+  const nodeModulesPath = resolve(dir, 'node_modules')
+  const hasNodeModulesFolder = await components.fs.directoryExists(nodeModulesPath)
+  const isNodeModulesEmpty = hasNodeModulesFolder && (await components.fs.readdir(nodeModulesPath)).length === 0
+
+  return !hasNodeModulesFolder || isNodeModulesEmpty
+}
+
+/* istanbul ignore next */
+export const npm = /^win/.test(process.platform) ? 'npm.cmd' : 'npm'
+
+/*
+ * Runs "npm install" for desired project
+ */
+export async function installDependencies(components: Pick<CliComponents, 'logger'>, directory: string): Promise<void> {
+  components.logger.info('Installing dependencies...')
+  // TODO: test in windows
+  await exec(directory, npm, ['install'])
+  components.logger.log('Installing dependencies... ✅')
+}
+
+/**
+ * Run NPM commands
+ */
+export async function npmRun(cwd: string, command: string, ...args: string[]): Promise<void> {
+  // TODO: test in windows
+  await exec(cwd, npm, ['run', command, '--silent', '--', ...args], { env: process.env as any })
+}

package/src/logic/realm.ts

@@ -0,0 +1,28 @@
+import { AboutResponse } from '@dcl/protocol/out-js/decentraland/bff/http_endpoints.gen'
+
+export function createStaticRealm(): AboutResponse {
+  return {
+    acceptingUsers: true,
+    bff: { healthy: false, publicUrl: `https://peer.decentraland.org/bff` },
+    comms: {
+      healthy: true,
+      protocol: 'v3',
+      fixedAdapter: `offline:offline`
+    },
+    configurations: {
+      networkId: 0,
+      globalScenesUrn: [],
+      scenesUrn: [],
+      realmName: 'SdkStaticExport'
+    },
+    content: {
+      healthy: true,
+      publicUrl: `https://peer.decentraland.org/content`
+    },
+    lambdas: {
+      healthy: true,
+      publicUrl: `https://peer.decentraland.org/lambdas`
+    },
+    healthy: true
+  }
+}

package/src/logic/scene-validations.ts

@@ -0,0 +1,73 @@
+import { resolve } from 'path'
+import { Scene } from '@dcl/schemas'
+import { CliError } from './error'
+import { getObject, inBounds, getBounds, areConnected } from './coordinates'
+import { CliComponents } from '../components'
+
+export const SCENE_FILE = 'scene.json'
+
+/**
+ * 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 function getSceneFilePath(projectRoot: string): string {
+  return resolve(projectRoot, SCENE_FILE)
+}
+
+export function assertValidScene(scene: Scene) {
+  if (!Scene.validate(scene)) {
+    const errors: string[] = []
+    if (Scene.validate.errors) {
+      for (const error of Scene.validate.errors) {
+        errors.push(`Error validating scene.json: ${error.message}`)
+      }
+    }
+    throw new CliError('Invalid scene.json file:\n' + errors.join('\n'))
+  }
+
+  const parcelSet = new Set(scene.scene?.parcels)
+
+  if (parcelSet.size < scene.scene?.parcels?.length) {
+    throw new CliError(`There are duplicated parcels at scene.json.`)
+  }
+
+  if (!parcelSet.has(scene.scene?.base)) {
+    throw new CliError(`Your base parcel ${scene.scene?.base} should be included on parcels attribute at scene.json`)
+  }
+
+  const objParcels = scene.scene?.parcels?.map(getObject)
+  objParcels.forEach(({ x, y }) => {
+    if (inBounds(x, y)) {
+      return
+    }
+    const { minX, maxX } = getBounds()
+    throw new CliError(`Coordinates ${x},${y} are outside of allowed limits (from ${minX} to ${maxX})`)
+  })
+
+  if (!areConnected(objParcels)) {
+    throw new CliError('Parcels described on scene.json are not connected. They should be one next to each other')
+  }
+
+  if (!scene.main?.endsWith('.js')) {
+    throw new CliError(`Main scene format file (${scene.main}) is not a supported format`)
+  }
+
+  return scene
+}
+
+/**
+ * Fails the execution if one of the parcel data is invalid
+ */
+export async function validateSceneJson(
+  components: Pick<CliComponents, 'fs' | 'logger'>,
+  projectRoot: string
+): Promise<Scene> {
+  try {
+    const sceneJsonRaw = await components.fs.readFile(getSceneFilePath(projectRoot), 'utf8')
+    const sceneJson = JSON.parse(sceneJsonRaw) as Scene
+
+    return assertValidScene(sceneJson)
+  } catch (err: any) {
+    throw new CliError(`Error reading the scene.json file: ${err.message}`)
+  }
+}

package/tsconfig.json

@@ -0,0 +1,28 @@
+{
+  "compilerOptions": {
+    "target": "ES2020",
+    "module": "commonjs",
+    "esModuleInterop": true,
+    "declaration": true,
+    "noUnusedLocals": true,
+    "stripInternal": true,
+    "skipLibCheck": true,
+    "forceConsistentCasingInFileNames": true,
+    "allowJs": true,
+    "resolveJsonModule": true,
+    "strict": true,
+    "types": [
+      "node",
+    ],
+    "lib": [
+      "es2020"
+    ],
+    "outDir": "./dist"
+  },
+  "include": [
+    "src"
+  ],
+  "exclude": [
+    "dist"
+  ]
+}