sandstone 1.1.0 → 1.1.2

package/src/variables/Objective.ts

@@ -53,7 +53,7 @@ export class _RawObjectiveClass implements NBTSerializable {
 
   toJSON = this.toString
 
-  toNBT = this.toString
+  toNBT = () => `'${this.toString}'`
 
   __call__ = this.ScoreHolder
 }

package/src/variables/Score.ts

@@ -18,7 +18,7 @@ import * as util from 'util'
 import { MacroArgument } from '../core/Macro'
 import type { SandstonePack } from '../pack'
 import { add, formatDebugString } from '../utils'
-import type { ComponentClass } from './abstractClasses'
+import type { TextComponentClass } from './abstractClasses'
 import { SelectorPickClass } from './abstractClasses'
 import type { DATA_TYPES, DataPointClass } from './Data'
 import type { ObjectiveClass } from './Objective'
@@ -70,7 +70,10 @@ type Tuple<T, N extends number, A extends T[] = []> = (
   : Tuple<T, N, [...A, T]>
 )
 
-export class Score extends MacroArgument implements ConditionClass, ComponentClass, NBTSerializable {
+export class Score extends MacroArgument implements ConditionClass, TextComponentClass, NBTSerializable {
+  declare readonly __textComponentClassBrand: true
+  declare readonly __conditionClassBrand: true
+
   commands: SandstoneCommands<false>
 
   constructor(
@@ -96,7 +99,7 @@ export class Score extends MacroArgument implements ConditionClass, ComponentCla
   }
 
   toNBT() {
-    return nbtResolver(this._toChatComponent() as NBTObject).toString()
+    return nbtResolver(this._toChatComponent()).toString()
   }
 
   toJSON() {
@@ -108,7 +111,7 @@ export class Score extends MacroArgument implements ConditionClass, ComponentCla
    */
   _toChatComponent(): JSONTextComponent {
     return {
-      score: { name: this.target, objective: this.objective.name },
+      score: { name: `${this.target}` as `${any}${string}`, objective: this.objective },
     }
   }
 
@@ -502,6 +505,7 @@ export class Score extends MacroArgument implements ConditionClass, ComponentCla
 
     if (typeof args[0] === 'number') {
       return {
+        __conditionClassBrand: true as const,
         _toMinecraftCondition: () =>
           new this.sandstonePack.conditions.Score(this.sandstonePack.core, [
             `${playerScore.target}`,
@@ -514,6 +518,7 @@ export class Score extends MacroArgument implements ConditionClass, ComponentCla
 
     const endArgs = args[1] ? args : [args[0]]
     return {
+      __conditionClassBrand: true as const,
       // eslint-disable-next-line max-len
       _toMinecraftCondition: () =>
         new this.sandstonePack.conditions.Score(this.sandstonePack.core, [
@@ -665,6 +670,7 @@ export class Score extends MacroArgument implements ConditionClass, ComponentCla
    * @param range The range to compare the current score against.
    */
   matches = (range: Range<false>) => ({
+    __conditionClassBrand: true as const,
     _toMinecraftCondition: () =>
       new this.sandstonePack.conditions.Score(this.sandstonePack.core, [
         `${this.target}`,
@@ -675,7 +681,8 @@ export class Score extends MacroArgument implements ConditionClass, ComponentCla
   })
 
   match = (minimum: number, maximum: number, callback: (num: number) => any) => {
-    const { MCFunction, Macro } = this.sandstonePack
+    const { MCFunction, Macro, core } = this.sandstonePack
+    const { getCurrentMCFunctionOrThrow } = core
 
     if (maximum > 1000) {
       console.warn(
@@ -689,12 +696,14 @@ export class Score extends MacroArgument implements ConditionClass, ComponentCla
     // oxlint-disable-next-line no-this-alias
     const score = this
 
-    for (let i = minimum; i < maximum; i++) {
-      MCFunction(`__sandstone:score_match/${matcher}/${i}`, () => callback(i))
+    const parent = getCurrentMCFunctionOrThrow()
+
+    for (let i = minimum; i <= maximum; i++) {
+      MCFunction(`./score_match/${matcher}/${i}`, () => callback(i))
     }
 
-    return MCFunction(`__sandstone:score_match/${matcher}`, [score], () =>
-      Macro.returnCmd.run.functionCmd(Macro`__sandstone:score_match/${matcher}/${score}`),
+    return MCFunction(`./score_match/${matcher}`, [score], () =>
+      Macro.returnCmd.run.functionCmd(Macro`${parent.resource.name}/score_match/${matcher}/${score}`),
     )
   }
 

package/src/variables/Selector.ts

@@ -302,6 +302,9 @@ export class SelectorClass<
   IsSingle extends boolean = false,
   IsPlayer extends boolean = false,
 > implements ConditionTextComponentClass, SelectorPickClass<IsSingle, IsPlayer>, ConditionClass, NBTSerializable {
+  declare readonly __textComponentClassBrand: true
+  declare readonly __conditionClassBrand: true
+
   /**
    * Phantom brand property for TypeScript to distinguish between different
    * SelectorClass type parameter combinations. Does not exist at runtime.
@@ -409,22 +412,29 @@ export class SelectorClass<
       distance: (range_: Range<MACRO>) => result.push(['distance', rangeParser(this.sandstonePack.core, range_)]),
     } as const
 
-    for (const [baseName, modifier] of Object.entries(modifiers)) {
-      const name = baseName as keyof typeof args
-      const value = args[name]
-
-      if (value !== undefined) {
-        modifier(value as any)
-        delete args[name]
-      }
-    }
-
-    Object.entries(args).forEach(([key, value]) => {
-      if (value !== undefined) {
+    Object.entries(args).forEach(([key_, value]) => {
+      const key = key_ as Extract<keyof typeof args, string>
+      if (key in modifiers) {
+        const modifierName = key as keyof typeof modifiers
+        modifiers[modifierName](value as any)
+      } else if (value !== undefined) {
         result.push([key, `${value}`])
       }
     })
 
+    // TODO: This probably should do more than drag the type to the front
+    const entityType = result.findIndex(([key]) => key === 'type')
+
+    if (entityType !== -1) {
+      result.unshift(...result.splice(entityType, 1))
+    }
+
+    const predicate = result.findIndex(([key]) => key === 'predicate')
+
+    if (predicate !== -1) {
+      result.push(...result.splice(predicate, 1))
+    }
+
     return `${this.target}[${result.map(([key, value]) => `${key}=${value}`).join(', ')}]`
   }
 
@@ -457,7 +467,7 @@ export class SelectorClass<
   }
 
   toNBT() {
-    return this.toString()
+    return `'${this.toString()}'`
   }
 
   [util.inspect.custom]() {

package/src/variables/Trigger.ts

@@ -18,7 +18,7 @@ export class TriggerClass<HANDLE extends TriggerHandler> {
     protected readonly callback: HANDLE,
     public readonly pollingEvery: number,
   ) {
-    this.objective = new ObjectiveClass(sandstoneCore.pack, name, 'dummy', undefined, { creator: 'sandstone' })
+    this.objective = new ObjectiveClass(sandstoneCore.pack, name, 'trigger', undefined, { creator: 'sandstone' })
 
     const { registerNewObjective, MCFunction, commands } = sandstoneCore.pack
 
@@ -32,13 +32,13 @@ export class TriggerClass<HANDLE extends TriggerHandler> {
     }
 
     sandstoneCore.checkTriggers[pollingEvery].push(() => {
-      commands.execute.as(`@a[scores={${name}=1..}]`).run(() => {
+      commands.execute.as(`@a[scores={${name}=1..}]`).at('@s').run(() => {
         const score = this.objective('@s')
 
         if (callback instanceof _RawMCFunctionClass || typeof callback === 'function') {
           callback()
         } else if (callback[0] === 'num') {
-          score.match(1, callback[1], callback[2])
+          score.match(1, callback[1], callback[2])()
         } else {
           callback[1](score)
         }

package/src/variables/UUID.ts

@@ -2,11 +2,11 @@
 /* eslint-disable no-plusplus */
 /* eslint-disable max-len */
 
-import type { JSONTextComponent, NBTSerializable } from 'sandstone/arguments'
+import type { JSONTextComponent } from 'sandstone/arguments'
 import type { ExecuteCommand } from 'sandstone/commands'
 import { createDeferredMacroExecute, ExecuteCommand as ExecuteCommandClass } from 'sandstone/commands/implementations/entity/execute'
 import type { SandstoneCore } from 'sandstone/core'
-import type { ConditionTextComponentClass } from './abstractClasses'
+import type { ConditionClass } from './abstractClasses'
 import { SelectorPickClass } from './abstractClasses'
 import type { DataPointClass } from './Data'
 import { NBTIntArray } from './nbt'
@@ -74,7 +74,10 @@ export type UUIDOptions = {
 }
 
 export class UUIDClass<PrimarySource extends 'known' | 'scores' | 'selector' | 'data'>
-implements ConditionTextComponentClass, SelectorPickClass<true, boolean>, NBTSerializable {
+implements ConditionClass, SelectorPickClass<true, boolean> {
+  declare readonly __textComponentClassBrand: true
+  declare readonly __conditionClassBrand: true
+
   /**
    * Phantom brand property for TypeScript type discrimination.
    * Uses `boolean` for player since a UUID can reference any entity type.
@@ -542,7 +545,7 @@ implements ConditionTextComponentClass, SelectorPickClass<true, boolean>, NBTSer
     const selector = this._toSelector()
 
     if (typeof selector === 'string') {
-      return selector
+      return `'${selector}'`
     }
     return selector.toNBT()
   }

package/src/variables/abstractClasses.ts

@@ -3,7 +3,13 @@ import type { ConditionNode } from '../flow'
 import type { SelectorClass } from './Selector'
 import type { NBTSerializable } from 'sandstone/arguments'
 
-export class ComponentClass {
+export class TextComponentClass {
+  /**
+   * Phantom brand property for TypeScript to identify instances of `TextComponentClass`
+   * (and subclasses). Does not exist at runtime.
+   */
+  declare readonly __textComponentClassBrand: true
+
   /**
    * @internal
    */
@@ -12,6 +18,12 @@ export class ComponentClass {
   }
 }
 export class ConditionClass {
+  /**
+   * Phantom brand property for TypeScript to identify instances of `ConditionClass`
+   * (and subclasses). Does not exist at runtime.
+   */
+  declare readonly __conditionClassBrand: true
+
   /**
    * @internal
    */
@@ -20,13 +32,19 @@ export class ConditionClass {
   }
 }
 
-export class SelectorPickClass<IsSingle extends boolean, IsPlayer extends boolean> implements NBTSerializable {
+export class SelectorPickClass<IsSingle extends boolean, IsPlayer extends boolean> implements NBTSerializable, TextComponentClass {
   /**
    * Phantom brand property for TypeScript to distinguish between different
    * SelectorPickClass type parameter combinations. Does not exist at runtime.
    */
   declare readonly __selectorPickBrand: { single: IsSingle; player: IsPlayer }
 
+  /**
+   * Phantom brand property for TypeScript to identify instances of `TextComponentClass`
+   * (and subclasses). Does not exist at runtime.
+   */
+  declare readonly __textComponentClassBrand: true
+
   /**
    * @internal
    */
@@ -39,9 +57,27 @@ export class SelectorPickClass<IsSingle extends boolean, IsPlayer extends boolea
   toNBT(): string {
     throw new Error('Not implemented')
   }
+  /**
+   * @internal
+   */
+  _toChatComponent(): JSONTextComponent {
+    throw new Error('Not implemented')
+  }
 }
 
-export class ConditionTextComponentClass extends ComponentClass implements ConditionClass {
+export class ConditionTextComponentClass extends TextComponentClass implements ConditionClass {
+  /**
+   * Phantom brand property for TypeScript to identify instances of `TextComponentClass`
+   * (and subclasses). Does not exist at runtime.
+   */
+  declare readonly __textComponentClassBrand: true
+
+  /**
+   * Phantom brand property for TypeScript to identify instances of `ConditionClass`
+   * (and subclasses). Does not exist at runtime.
+   */
+  declare readonly __conditionClassBrand: true
+
   /**
    * @internal
    */

package/src/variables/nbt/NBTs.ts

@@ -368,8 +368,8 @@ interface NBTInterface {
    *
    * @example
    *
-   * >>> NBT.stringify({ Invisible: NBT.byte(1) })
-   * '{ Invisible: 1b }'
+   * >>> NBT.stringify({ Invisible: true })
+   * '{ Invisible: true }'
    *
    * >>> NBT.stringify({ Rotation: NBT.float([ 90, 0 ]) })
    * '{ Rotation: [90f, 0f] }'
@@ -386,8 +386,8 @@ interface NBTInterface {
    *
    * @example
    *
-   * >>> NBT.parse(`{ Invisible: NBT.byte(1) }`)
-   * { Invisible: 1b }
+   * >>> NBT.parse(`{ Invisible: true }`)
+   * { Invisible: true }
    *
    * >>> const inv = NBT.parse(`[{ Slot: 1b, Count: 1, id: 'minecraft:dirt' }]`)
    * [{ Slot: 1b, Count: 1, id: 'minecraft:dirt' }]
@@ -404,8 +404,8 @@ interface NBTInterface {
    *   *
    * @example
    *
-   * >>> NBT`{ Invisible: NBT.byte(1) }`
-   * { Invisible: 1b }
+   * >>> NBT`{ Invisible: true }`
+   * { Invisible: true }
    *
    * >>> const inv = NBT`[{ Slot: 1b, Count: 1, id: 'minecraft:dirt' }]`
    * [{ Slot: 1b, Count: 1, id: 'minecraft:dirt' }]
@@ -550,7 +550,7 @@ const resolve = (nbt: NBTObject | MacroArgument): ResolvedNBT => {
     }
     if (nbt.constructor.name !== 'Object') {
       if ('toString' in nbt) {
-        return new ResolvedNBT(`${toString}`, false)
+        return new ResolvedNBT(`'${nbt}'`, false)
       } else {
         /* @ts-ignore */
         throw new Error(`[nbtResolver] A ${nbt.constructor?.name} was passed in as an NBT value. Hint: define toNBT or toString if this was intentional`)
@@ -564,12 +564,36 @@ const resolve = (nbt: NBTObject | MacroArgument): ResolvedNBT => {
     .map(([key, value]) => {
       const resolved = resolve(value as NBTObject)
       if (resolved.containsMacro) containsMacro = true
-      return `${key}:${resolved.value}`
+      return `${formatKey(key)}:${resolved.value}`
     })
     .join(',')
   return new ResolvedNBT(`{${objectStr}}`, containsMacro)
 }
 
+// SNBT unquoted keys allow many chars, but `,`, `:`, `;`, `.`, `[`, `]`, `{`, `}` collide with the syntax. Quote any key containing those.
+const SNBT_KEY_REQUIRED_QUOTE_CHARS = /[:,;.\[\]{}'"]/
+
+const formatKey = (key: string): string => {
+  // If the user already wrapped the key in matching quotes, trust them and leave it alone.
+  if (
+    (key.startsWith('"') && key.endsWith('"'))
+    || (key.startsWith("'") && key.endsWith("'"))
+  ) {
+    return key
+  }
+  if (!SNBT_KEY_REQUIRED_QUOTE_CHARS.test(key)) {
+    return key
+  }
+  // Prefer single quotes. Switch to double if key only contains a `'`; if both, escape the `'` inside single.
+  if (key.includes("'")) {
+    if (key.includes('"')) {
+      return `'${key.replace(/'/g, "\\'")}'`
+    }
+    return `"${key}"`
+  }
+  return `'${key}'`
+}
+
 /**
  * Resolves a Sandstone NBT value into its Minecraft SNBT string form.
  *

package/tsconfig.json

@@ -0,0 +1,27 @@
+{
+  "include": ["src"],
+  "compilerOptions": {
+    "paths": {
+      "sandstone": [
+        "./src/sandstone.ts"
+      ],
+      "sandstone/*": [
+        "./src/*"
+      ],
+    },
+    "module": "preserve",
+    "target": "ESNEXT",
+    "strict": true,
+    "allowSyntheticDefaultImports": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "forceConsistentCasingInFileNames": true,
+    "stripInternal": true,
+    "moduleResolution": "bundler",
+    "declaration": true,
+    "outDir": "./dist",
+    "rootDir": "src",
+    "emitDeclarationOnly": true,
+    "allowImportingTsExtensions": true
+  }
+}

package/dist/_internal/types/core/resources/datapack/decoratedPotPattern.d.ts

@@ -1,24 +0,0 @@
-import { type SymbolResource } from "../../../arguments/index.js";
-import { ContainerNode } from "../../nodes.js";
-import type { SandstoneCore } from "../../sandstoneCore.js";
-import type { ResourceClassArguments, ResourceNode } from "../resource.js";
-import { ResourceClass } from "../resource.js";
-/**
- * A node representing a Minecraft decorated pot pattern.
- */
-export declare class DecoratedPotPatternNode extends ContainerNode implements ResourceNode<DecoratedPotPatternClass> {
-    resource: DecoratedPotPatternClass;
-    constructor(sandstoneCore: SandstoneCore, resource: DecoratedPotPatternClass);
-    getValue: () => string;
-}
-export type DecoratedPotPatternClassArguments = {
-    /**
-     * The decorated pot pattern's JSON.
-     */
-    json: SymbolResource[(typeof DecoratedPotPatternClass)['resourceType']];
-} & ResourceClassArguments<'default'>;
-export declare class DecoratedPotPatternClass extends ResourceClass<DecoratedPotPatternNode> {
-    static readonly resourceType: "decorated_pot_pattern";
-    decoratedPotPatternJSON: NonNullable<DecoratedPotPatternClassArguments['json']>;
-    constructor(sandstoneCore: SandstoneCore, name: string, args: DecoratedPotPatternClassArguments);
-}

package/dist/_internal/types/core/resources/datapack/slotSource.d.ts

@@ -1,24 +0,0 @@
-import { type SymbolResource } from "../../../arguments/index.js";
-import { ContainerNode } from "../../nodes.js";
-import type { SandstoneCore } from "../../sandstoneCore.js";
-import type { ResourceClassArguments, ResourceNode } from "../resource.js";
-import { ResourceClass } from "../resource.js";
-/**
- * A node representing a Minecraft slot source.
- */
-export declare class SlotSourceNode extends ContainerNode implements ResourceNode<SlotSourceClass> {
-    resource: SlotSourceClass;
-    constructor(sandstoneCore: SandstoneCore, resource: SlotSourceClass);
-    getValue: () => string;
-}
-export type SlotSourceClassArguments = {
-    /**
-     * The slot source's JSON.
-     */
-    json: NonNullable<SymbolResource[(typeof SlotSourceClass)['resourceType']]>;
-} & ResourceClassArguments<'default'>;
-export declare class SlotSourceClass extends ResourceClass<SlotSourceNode> {
-    static readonly resourceType: "slot_source";
-    slotSourceJSON: NonNullable<SlotSourceClassArguments['json']>;
-    constructor(sandstoneCore: SandstoneCore, name: string, args: SlotSourceClassArguments);
-}