@nanoforge-dev/schematics 2.2.1-beta.88f48da → 2.3.0

package/dist/libs/project/files/ts/package.json.template

@@ -0,0 +1,24 @@
+{
+  "$schema": "https://json.schemastore.org/package.json",
+  "name": "<%= packageName %>",
+  "scripts": {
+    "dev": "nf dev",
+    "build": "nf build",
+    "start": "nf start"
+  },<% if (part === "server") { %>
+  "dependencies": {
+    "@nanoforge-dev/network": "<%= networkVersion %>"
+  },<% } %>
+  "devDependencies": {
+    "@nanoforge-dev/ecs": "<%= ecsVersion %>",<% if (part === "client") { %>
+    "@nanoforge-dev/graphics-2d": "<%= graphics2dVersion %>",
+    "@nanoforge-dev/input": "<%= inputVersion %>",
+    "@nanoforge-dev/network": "<%= networkVersion %>",<% } %>
+    "nanoforge": "<%= nanoforgeVersion %>"
+  },<% if (packageManager === "npm" && allowBuilds.length > 0) { %>
+  "allowScripts": {<% allowBuilds.forEach(function (pkg, i) { %>
+    "<%= pkg %>": true<% if (i < allowBuilds.length - 1) { %>,<% } %><% }); %>
+  },<% } %><% if (packageManager === "bun" && allowBuilds.length > 0) { %>
+  "trustedDependencies": [<% allowBuilds.forEach(function (pkg, i) { %>"<%= pkg %>"<% if (i < allowBuilds.length - 1) { %>, <% } %><% }); %>],<% } %>
+  "private": true
+}

package/dist/libs/project/files/ts/pnpm-workspace.yaml.template

@@ -0,0 +1,3 @@
+<% if (allowBuilds.length > 0) { %>allowBuilds:<% allowBuilds.forEach(function (pkg) { %>
+  <%= pkg %>: true<% }); %>
+<% } %>

package/dist/libs/project/files/ts/src/components/drawable-circle-2d.component.ts

@@ -0,0 +1,367 @@
+import type { EditorComponentManifest } from "@nanoforge-dev/ecs";
+import { Circle, type Layer } from "@nanoforge-dev/graphics-2d";
+import type { NfFile } from "nanoforge";
+
+export class DrawableCircle2D {
+  public readonly name: string = this.constructor.name;
+  shape: Circle;
+
+  constructor(
+    radius?: number,
+    visible?: boolean,
+    id?: string,
+    opacity?: number,
+    scaleX?: number,
+    scaleY?: number,
+    skewX?: number,
+    skewY?: number,
+    rotation?: number,
+    offsetX?: number,
+    offsetY?: number,
+    fillColor?: string,
+    private _fillPatternImage?: NfFile,
+    fillPatternX?: number,
+    fillPatternY?: number,
+    fillPatternOffsetX?: number,
+    fillPatternOffsetY?: number,
+    fillPatternScaleX?: number,
+    fillPatternScaleY?: number,
+    fillPatternRotation?: number,
+    fillPatternRepeat?: string,
+  ) {
+    this.shape = new Circle({
+      radius,
+      visible,
+      id,
+      opacity,
+      scaleX,
+      scaleY,
+      skewX,
+      skewY,
+      rotation,
+      offsetX,
+      offsetY,
+      fill: fillColor,
+      fillPatternImage: _fillPatternImage
+        ? Object.assign(new Image(), { src: _fillPatternImage.path })
+        : undefined,
+      fillPatternX,
+      fillPatternY,
+      fillPatternOffsetX,
+      fillPatternOffsetY,
+      fillPatternScaleX,
+      fillPatternScaleY,
+      fillPatternRotation,
+      fillPatternRepeat,
+    });
+  }
+
+  get radius() {
+    return this.shape.radius();
+  }
+  set radius(v: number) {
+    this.shape.radius(v);
+    this.redraw();
+  }
+  get visible() {
+    return this.shape.visible();
+  }
+  set visible(v: boolean) {
+    this.shape.visible(v);
+    this.redraw();
+  }
+  get id() {
+    return this.shape.id();
+  }
+  set id(v: string) {
+    this.shape.id(v);
+    this.redraw();
+  }
+  get opacity() {
+    return this.shape.opacity();
+  }
+  set opacity(v: number) {
+    this.shape.opacity(v);
+    this.redraw();
+  }
+  get scaleX() {
+    return this.shape.scaleX();
+  }
+  set scaleX(v: number) {
+    this.shape.scaleX(v);
+    this.redraw();
+  }
+  get scaleY() {
+    return this.shape.scaleY();
+  }
+  set scaleY(v: number) {
+    this.shape.scaleY(v);
+    this.redraw();
+  }
+  get skewX() {
+    return this.shape.skewX();
+  }
+  set skewX(v: number) {
+    this.shape.skewX(v);
+    this.redraw();
+  }
+  get skewY() {
+    return this.shape.skewY();
+  }
+  set skewY(v: number) {
+    this.shape.skewY(v);
+    this.redraw();
+  }
+  get rotation() {
+    return this.shape.rotation();
+  }
+  set rotation(v: number) {
+    this.shape.rotation(v);
+    this.redraw();
+  }
+  get offsetX() {
+    return this.shape.offsetX();
+  }
+  set offsetX(v: number) {
+    this.shape.offsetX(v);
+    this.redraw();
+  }
+  get offsetY() {
+    return this.shape.offsetY();
+  }
+  set offsetY(v: number) {
+    this.shape.offsetY(v);
+    this.redraw();
+  }
+  get fillColor() {
+    return this.shape.fill().toString();
+  }
+  set fillColor(v: string) {
+    this.shape.fill(v);
+    this.redraw();
+  }
+  get fillPatternImage(): NfFile | undefined {
+    return this._fillPatternImage;
+  }
+  set fillPatternImage(v: NfFile) {
+    this.shape.fillPatternImage(v ? Object.assign(new Image(), { src: v.path }) : undefined);
+    this.redraw();
+  }
+  get fillPatternX() {
+    return this.shape.fillPatternX();
+  }
+  set fillPatternX(v: number) {
+    this.shape.fillPatternX(v);
+    this.redraw();
+  }
+  get fillPatternY() {
+    return this.shape.fillPatternY();
+  }
+  set fillPatternY(v: number) {
+    this.shape.fillPatternY(v);
+    this.redraw();
+  }
+  get fillPatternOffsetX() {
+    return this.shape.fillPatternOffsetX();
+  }
+  set fillPatternOffsetX(v: number) {
+    this.shape.fillPatternOffsetX(v);
+    this.redraw();
+  }
+  get fillPatternOffsetY() {
+    return this.shape.fillPatternOffsetY();
+  }
+  set fillPatternOffsetY(v: number) {
+    this.shape.fillPatternOffsetY(v);
+    this.redraw();
+  }
+  get fillPatternScaleX() {
+    return this.shape.fillPatternScaleX();
+  }
+  set fillPatternScaleX(v: number) {
+    this.shape.fillPatternScaleX(v);
+    this.redraw();
+  }
+  get fillPatternScaleY() {
+    return this.shape.fillPatternScaleY();
+  }
+  set fillPatternScaleY(v: number) {
+    this.shape.fillPatternScaleY(v);
+    this.redraw();
+  }
+  get fillPatternRotation() {
+    return this.shape.fillPatternRotation();
+  }
+  set fillPatternRotation(v: number) {
+    this.shape.fillPatternRotation(v);
+    this.redraw();
+  }
+  get fillPatternRepeat() {
+    return this.shape.fillPatternRepeat();
+  }
+  set fillPatternRepeat(v: string) {
+    this.shape.fillPatternRepeat(v);
+    this.redraw();
+  }
+
+  public addToLayer(layer: Layer): void {
+    if (this.shape.getParent() !== layer) layer.add(this.shape);
+  }
+
+  private redraw() {
+    this.shape.getLayer()?.batchDraw();
+  }
+}
+// * Required to generate code
+export default DrawableCircle2D.name;
+
+// * Required for the editor to display the component and generate code
+export const EDITOR_COMPONENT_MANIFEST: EditorComponentManifest = {
+  name: "DrawableCircle2D",
+  description: "Graphically drawable circle 2D",
+  params: [
+    {
+      name: "radius",
+      type: "number",
+      description: "Radius of the circle in pixels",
+      default: 10,
+      optional: false,
+    },
+    {
+      name: "visible",
+      type: "boolean",
+      description: "Controls whether the node is rendered",
+      default: true,
+      optional: false,
+    },
+    {
+      name: "id",
+      type: "string",
+      description: "Unique identifier for the node, used with stage.findOne('#id')",
+      optional: true,
+    },
+    {
+      name: "opacity",
+      type: "number",
+      description: "Opacity from 0 (transparent) to 1 (fully opaque)",
+      default: 1,
+      optional: true,
+    },
+    {
+      name: "scaleX",
+      type: "number",
+      description: "Horizontal scale factor",
+      default: 1,
+      optional: true,
+    },
+    {
+      name: "scaleY",
+      type: "number",
+      description: "Vertical scale factor",
+      default: 1,
+      optional: true,
+    },
+    {
+      name: "skewX",
+      type: "number",
+      default: 0,
+      description: "Horizontal skew in radians, shears along the X axis",
+      optional: true,
+    },
+    {
+      name: "skewY",
+      type: "number",
+      default: 0,
+      description: "Vertical skew in radians, shears along the Y axis",
+      optional: true,
+    },
+    {
+      name: "rotation",
+      type: "number",
+      description:
+        "Rotation angle in degrees applied around the offset point (positive values rotate clockwise)",
+      default: 0,
+      optional: true,
+    },
+    {
+      name: "offsetX",
+      type: "number",
+      description: "Horizontal offset for the transform origin",
+      default: 0,
+      optional: true,
+    },
+    {
+      name: "offsetY",
+      type: "number",
+      description: "Vertical offset for the transform origin",
+      default: 0,
+      optional: true,
+    },
+    {
+      name: "fillColor",
+      type: "string",
+      description:
+        'Solid fill color as a CSS color string (e.g. "red", "#ff0000", "rgba(255,0,0,0.5)"), or a pre-built CanvasGradient object',
+      default: "red",
+      example: "rgb(255,255,255)",
+      optional: true,
+    },
+    {
+      name: "fillPatternImage",
+      type: "asset",
+      description: "Image element to use as a tiling pattern fill",
+      optional: true,
+    },
+    {
+      name: "fillPatternX",
+      type: "number",
+      description:
+        "Horizontal offset of the pattern origin relative to the shape's top-left corner, in pixels",
+      optional: true,
+    },
+    {
+      name: "fillPatternY",
+      type: "number",
+      description:
+        "Vertical offset of the pattern origin relative to the shape's top-left corner, in pixels",
+      optional: true,
+    },
+    {
+      name: "fillPatternOffsetX",
+      type: "number",
+      description: "Horizontally shifts the pattern image within the tile before repeating",
+      optional: true,
+    },
+    {
+      name: "fillPatternOffsetY",
+      type: "number",
+      description: "Vertically shifts the pattern image within the tile before repeating",
+      optional: true,
+    },
+    {
+      name: "fillPatternScaleX",
+      type: "number",
+      description: "Horizontal scale factor for the pattern tile",
+      optional: true,
+    },
+    {
+      name: "fillPatternScaleY",
+      type: "number",
+      description: "Vertical scale factor for the pattern tile",
+      optional: true,
+    },
+    {
+      name: "fillPatternRotation",
+      type: "number",
+      description: "Rotation of the pattern tile in degrees",
+      optional: true,
+    },
+    {
+      name: "fillPatternRepeat",
+      type: "string",
+      description:
+        'Repeat mode for the pattern. One of "repeat" (default), "repeat-x", "repeat-y", or "no-repeat"',
+      optional: true,
+    },
+  ],
+};

package/dist/libs/project/files/ts/src/components/position-2d.component.ts

@@ -0,0 +1,35 @@
+import type { EditorComponentManifest } from "@nanoforge-dev/ecs";
+
+export class Position2D {
+  name = this.constructor.name;
+
+  constructor(
+    public x: number,
+    public y: number,
+  ) {}
+}
+
+// * Required to generate code
+export default Position2D.name;
+
+// * Required for the editor to display the component and generate code
+export const EDITOR_COMPONENT_MANIFEST: EditorComponentManifest = {
+  name: "Position2D",
+  description: "Position of an entity in a 2 dimensional space in pixel",
+  params: [
+    {
+      type: "number",
+      name: "x",
+      description: "Horizontal position in pixel",
+      example: 4.2,
+      default: 0,
+    },
+    {
+      type: "number",
+      name: "y",
+      description: "Vertical position in pixel",
+      example: 67,
+      default: 0,
+    },
+  ],
+};

package/dist/libs/project/files/ts/src/main.ts

@@ -0,0 +1,39 @@
+import { NanoforgeFactory, type <%= part === "client" ? "ClientRunOptions" : "ServerRunOptions" %> } from "nanoforge";
+import { EcsLibrary } from "@nanoforge-dev/ecs/<%= part %>";<% if (part === "client") { %>
+import { Graphics2DLibrary } from "@nanoforge-dev/graphics-2d";
+import { InputLibrary } from "@nanoforge-dev/input";<% } %>
+import { <%= part === "client" ? "NetworkClientLibrary" : "NetworkServerLibrary" %> } from "@nanoforge-dev/network/<%= part %>";
+<% if (part === "client") { %>
+import { DrawableCircle2D } from "./components/drawable-circle-2d.component";<% } %>
+import { Position2D } from "./components/position-2d.component";<% if (part === "client") { %>
+import { draw2D } from "./systems/draw-2d.system";<% if (hasServer) { %>
+import { positionSync } from "./systems/position-sync.system";<% } %><% } else { %>
+import { move2D } from "./systems/move-2d.system";<% } %>
+
+export const main = async (options: <%= part === "client" ? "ClientRunOptions" : "ServerRunOptions" %>): Promise<void> => {
+  const app = NanoforgeFactory.<%= part === "client" ? "createClient" : "createServer" %>({ tickRate: 60 });
+
+  const ecs = new EcsLibrary();
+  app.use(ecs);<% if (part === "client") { %>
+  app.use(new Graphics2DLibrary());
+  app.use(new InputLibrary());<% } %>
+  app.use(new <%= part === "client" ? "NetworkClientLibrary" : "NetworkServerLibrary" %>());
+
+  await app.init(options);
+
+  const registry = ecs.registry;
+<% if (part === "client") { %>
+  const circle = registry.spawnEntity();
+  registry.addComponent(circle, new Position2D(500, 500));
+  registry.addComponent(circle, new DrawableCircle2D(75, true, undefined, undefined, undefined, undefined, undefined, undefined, undefined, undefined, undefined, "red"));
+
+  registry.addSystem(draw2D);<% if (hasServer) { %>
+  registry.addSystem(positionSync);<% } %>
+<% } else { %>
+  const entity = registry.spawnEntity();
+  registry.addComponent(entity, new Position2D(500, 500));
+
+  registry.addSystem(move2D);
+<% } %>
+  await app.run();
+};

package/dist/libs/project/files/ts/src/systems/draw-2d.system.ts

@@ -0,0 +1,25 @@
+import type { EditorSystemManifest, Registry } from "@nanoforge-dev/ecs";
+import { type Context } from "nanoforge";
+
+import { DrawableCircle2D } from "../components/drawable-circle-2d.component";
+import { Position2D } from "../components/position-2d.component";
+
+export function draw2D(registry: Registry, ctx: Context) {
+  const graphic2d = ctx.graphics;
+
+  const entities = registry.getZipper([Position2D, DrawableCircle2D]);
+
+  entities.forEach(({ Position2D, DrawableCircle2D }) => {
+    DrawableCircle2D.addToLayer(graphic2d.baseLayer);
+    DrawableCircle2D.shape.setPosition(Position2D);
+  });
+}
+// * Required to generate code
+export default draw2D.name;
+
+// * Required for the editor to display the system and generate code
+export const EDITOR_SYSTEM_MANIFEST: EditorSystemManifest = {
+  name: "draw2D",
+  description: "Draw every drawable component",
+  dependencies: ["Position2D", "DrawableCircle2D"],
+};

package/dist/libs/project/files/ts/src/systems/move-2d.system.ts

@@ -0,0 +1,26 @@
+import type { EditorSystemManifest, Registry } from "@nanoforge-dev/ecs";
+import { type Context } from "nanoforge";
+
+import { Position2D } from "../components/position-2d.component";
+
+export function move2D(registry: Registry, ctx: Context) {
+  const network = ctx.network;
+  const entities = registry.getZipper([Position2D]);
+
+  entities.forEach(({ Position2D }) => {
+    Position2D.x += 1;
+
+    network.tcp.sendToEverybody(
+      new TextEncoder().encode(JSON.stringify({ x: Position2D.x, y: Position2D.y })),
+    );
+  });
+}
+// * Required to generate code
+export default move2D.name;
+
+// * Required for the editor to display the system and generate code
+export const EDITOR_SYSTEM_MANIFEST: EditorSystemManifest = {
+  name: "move2D",
+  description: "Moves the entity and broadcasts its position to every connected client",
+  dependencies: ["Position2D"],
+};

package/dist/libs/project/files/ts/src/systems/position-sync.system.ts

@@ -0,0 +1,27 @@
+import type { EditorSystemManifest, Registry } from "@nanoforge-dev/ecs";
+import { type Context } from "nanoforge";
+
+import { Position2D } from "../components/position-2d.component";
+
+export function positionSync(registry: Registry, ctx: Context) {
+  const network = ctx.network;
+  const packets = network.tcp
+    .getReceivedPackets()
+    .map((packet) => JSON.parse(new TextDecoder().decode(packet)) as { x: number; y: number });
+
+  const [entity] = registry.getZipper([Position2D]);
+
+  packets.forEach((packet) => {
+    entity.Position2D.x = packet.x;
+    entity.Position2D.y = packet.y;
+  });
+}
+// * Required to generate code
+export default positionSync.name;
+
+// * Required for the editor to display the system and generate code
+export const EDITOR_SYSTEM_MANIFEST: EditorSystemManifest = {
+  name: "positionSync",
+  description: "Overwrites the local entity's position with the latest value received from the server",
+  dependencies: ["Position2D"],
+};

package/dist/libs/project/files/ts/tsconfig.json

@@ -0,0 +1,42 @@
+{
+  "$schema": "https://json.schemastore.org/tsconfig.json",<% if (workspace) { %>
+  "extends": "../../tsconfig.json",<% } else { %>
+  // Mapped from https://www.typescriptlang.org/tsconfig
+  "compilerOptions": {
+    // Type Checking
+    "allowUnreachableCode": <%= !strict %>,
+    "allowUnusedLabels": <%= !strict %>,
+    "exactOptionalPropertyTypes": <%= strict %>,
+    "noFallthroughCasesInSwitch": <%= strict %>,
+    "noImplicitOverride": <%= strict %>,
+    "noImplicitReturns": <%= strict %>,
+    "noPropertyAccessFromIndexSignature": <%= !strict %>,
+    "noUncheckedIndexedAccess": <%= strict %>,
+    "noUnusedLocals": <%= strict %>,
+    "noUnusedParameters": <%= strict %>,
+    "strict": <%= strict %>,
+
+    // Modules
+    "allowArbitraryExtensions": false,
+    "allowImportingTsExtensions": false,
+    "module": "ESNext",
+    "moduleResolution": "Bundler",
+    "resolveJsonModule": true,
+    "resolvePackageJsonExports": true,
+    "resolvePackageJsonImports": true,
+
+    // Interop Constraints
+    "allowSyntheticDefaultImports": true,
+    "esModuleInterop": false,
+    "forceConsistentCasingInFileNames": true,
+    "isolatedModules": true,
+
+    // Language and Environment
+    "experimentalDecorators": true,
+    "lib": ["ESNext", "esnext.disposable", "DOM"],
+    "target": "ESNext",
+    "useDefineForClassFields": true,
+  },<% } %>
+  "include": ["src"],
+  "exclude": ["node_modules", ".nanoforge", "dist"]
+}

package/dist/libs/project/project.factory.d.ts

@@ -0,0 +1,64 @@
+import { Rule } from "@angular-devkit/schematics";
+//#region src/libs/project/project.schema.d.ts
+interface ProjectSchema {
+  /**
+   * The type of project to generate
+   */
+  part: "client" | "server";
+  /**
+   * Name of the parent workspace, used to derive the project package name.
+   * Optional - when omitted, `name` is used as the whole package name
+   * instead of being appended to the workspace name.
+   */
+  workspaceName?: string | null;
+  /**
+   * Name used to derive the project package name. When `workspaceName` is
+   * set, the package name is `${workspaceName}-${name}` (replacing the
+   * previous `${workspaceName}-${part}` suffix). When `workspaceName` is
+   * absent, `name` becomes the whole package name. Defaults to `part`.
+   */
+  name?: string | null;
+  /**
+   * Full destination path for this project (e.g. "apps/client",
+   * "packages/player-client"). The caller is responsible for including any
+   * part-specific segment - it is not appended automatically.
+   */
+  directory: string;
+  /**
+   * NanoForge project language
+   */
+  language: "js" | "ts";
+  /**
+   * With strict mode
+   */
+  strict: boolean;
+  /**
+   * The used package manager
+   */
+  packageManager: "npm" | "yarn" | "pnpm" | "bun";
+  /**
+   * Whether this project is generated inside an existing NanoForge workspace
+   */
+  workspace: boolean;
+  /**
+   * Generate a Dockerfile for the project. Ignored when `workspace` is true - a project
+   * inside a workspace is built and run by the workspace's own Dockerfile instead.
+   */
+  docker: boolean;
+  /**
+   * Only meaningful when `part` is "client": whether the client syncs its
+   * entity position from a companion server instead of owning it locally.
+   * A server project always simulates and broadcasts its own position,
+   * regardless of this flag.
+   */
+  hasServer: boolean;
+  /**
+   * Add editor dependencies
+   */
+  editor: boolean;
+}
+//#endregion
+//#region src/libs/project/project.factory.d.ts
+export declare const main: (schema: ProjectSchema) => Rule;
+//#endregion
+//# sourceMappingURL=project.factory.d.ts.map

package/dist/libs/project/project.factory.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"project.factory.d.ts","names":[],"sources":["../../../src/libs/project/project.schema.d.ts","../../../src/libs/project/project.factory.ts"],"mappings":";;UAAiB;;;;EAIf;;;;;;EAOA;;;;;;;EAQA;;;;;;EAOA;;;;EAKA;;;;EAKA;;;;EAKA;;;;EAKA;;;;;EAMA;;;;;;;EAQA;;;;EAKA;;;;qBC6DW,OAAQ,QAAQ,kBAAgB"}