circuitscript 0.0.21 → 0.0.24

package/dist/types/utils.d.ts

@@ -0,0 +1,19 @@
+export declare class SimpleStopwatch {
+    startTime: Date;
+    constructor();
+    lap(): number;
+}
+export type BoundBox = {
+    xmin: number;
+    ymin: number;
+    xmax: number;
+    ymax: number;
+};
+export declare function resizeBounds(bounds: BoundBox, value: number): BoundBox;
+export declare function printBounds(bounds: BoundBox): string;
+export declare function resizeToNearestGrid(bounds: BoundBox, gridSize?: number): BoundBox;
+export declare function toNearestGrid(value: number, gridSize: number): number;
+export declare function getBoundsSize(bounds: BoundBox): {
+    width: number;
+    height: number;
+};

package/dist/types/visitor.d.ts

@@ -0,0 +1,135 @@
+import { ParseTreeVisitor, ParserRuleContext } from 'antlr4';
+import { Add_component_exprContext, AdditionExprContext, Assignment_exprContext, At_blockContext, At_block_pin_exprContext, At_block_pin_expression_complexContext, At_block_pin_expression_simpleContext, At_component_exprContext, Atom_exprContext, BinaryOperatorExprContext, Blank_exprContext, Path_blocksContext, Component_select_exprContext, Create_component_exprContext, Create_graphic_exprContext, DataExprContext, Data_expr_with_assignmentContext, Double_dot_property_set_exprContext, Frame_exprContext, Function_args_exprContext, Function_def_exprContext, Function_return_exprContext, Import_exprContext, Keyword_assignment_exprContext, MultiplyExprContext, Nested_propertiesContext, Net_namespace_exprContext, ParametersContext, Pin_select_expr2Context, Pin_select_exprContext, Point_exprContext, Property_exprContext, Property_key_exprContext, Property_set_exprContext, RoundedBracketsExprContext, ScriptContext, Single_line_propertyContext, Sub_exprContext, To_component_exprContext, Value_exprContext, Wire_exprContext, ValueAtomExprContext, UnaryOperatorExprContext } from './antlr/CircuitScriptParser.js';
+import { ExecutionContext } from './execute.js';
+import { ClassComponent } from './objects/ClassComponent.js';
+import { PinBlankValue } from './objects/ParamDefinition.js';
+import { PinTypes } from './objects/PinTypes.js';
+import { CallableParameter, ComplexType, ComponentPin, ComponentPinNet, FunctionDefinedParameter, ReferenceType, ValueType } from './objects/types.js';
+import { Logger } from './logger.js';
+import { Net } from './objects/Net.js';
+import { SymbolDrawingCommands } from './draw_symbols.js';
+export declare class MainVisitor extends ParseTreeVisitor<any> {
+    indentLevel: number;
+    startingContext: ExecutionContext;
+    executionStack: ExecutionContext[];
+    silent: boolean;
+    logger: Logger;
+    printStream: string[];
+    printToConsole: boolean;
+    acceptedDirections: string[];
+    pinTypesList: string[];
+    onImportFile: (visitor: MainVisitor, filePath: string) => {
+        hasError: boolean;
+        hasParseError: boolean;
+    };
+    constructor(silent?: boolean);
+    getExecutor(): ExecutionContext;
+    visit(ctx: ParserRuleContext): any;
+    handleError(ctx: ParserRuleContext, err: string | VisitorExecutionException): void;
+    visitScript(ctx: ScriptContext): any;
+    visitParameters(ctx: ParametersContext): CallableParameter[];
+    visitKeyword_assignment_expr(ctx: Keyword_assignment_exprContext): [
+        key: string,
+        value: any
+    ];
+    visitAssignment_expr(ctx: Assignment_exprContext): ComplexType;
+    setInstanceParam(object: ClassComponent, trailers: string[], value: any): void;
+    visitValue_expr(ctx: Value_exprContext): ValueType;
+    visitBlank_expr(ctx: Blank_exprContext): PinBlankValue;
+    visitPin_select_expr(ctx: Pin_select_exprContext): string | number | null;
+    visitAdd_component_expr(ctx: Add_component_exprContext): ComponentPin;
+    visitAt_component_expr(ctx: At_component_exprContext): ComponentPin;
+    visitTo_component_expr(ctx: To_component_exprContext): ComponentPin;
+    visitComponent_select_expr(ctx: Component_select_exprContext): ComponentPin;
+    visitPath_blocks(ctx: Path_blocksContext): ComponentPin;
+    visitBreak_keyword(): number;
+    visitCreate_component_expr(ctx: Create_component_exprContext): ClassComponent;
+    visitCreate_graphic_expr(ctx: Create_graphic_exprContext): SymbolDrawingCommands;
+    visitSub_expr(ctx: Sub_exprContext): [
+        id: string,
+        parameters: CallableParameter[]
+    ];
+    visitProperty_expr(ctx: Property_exprContext): Map<string, any>;
+    visitSingle_line_property(ctx: Single_line_propertyContext): any | any[];
+    visitNested_properties(ctx: Nested_propertiesContext): Map<string, any>;
+    visitProperty_key_expr(ctx: Property_key_exprContext): string | number;
+    visitData_expr_with_assignment(ctx: Data_expr_with_assignmentContext): [
+        component: ComplexType,
+        pin: string | number | null
+    ];
+    visitValueAtomExpr(ctx: ValueAtomExprContext): ComplexType;
+    visitUnaryOperatorExpr(ctx: UnaryOperatorExprContext): ComplexType;
+    visitDataExpr(ctx: DataExprContext): ComplexType;
+    visitBinaryOperatorExpr(ctx: BinaryOperatorExprContext): boolean | number;
+    visitMultiplyExpr(ctx: MultiplyExprContext): number;
+    visitAdditionExpr(ctx: AdditionExprContext): number;
+    visitFunction_args_expr(ctx: Function_args_exprContext): FunctionDefinedParameter[];
+    createNetResolver(executionStack: ExecutionContext[]): (netName: string, netNamespace: string) => {
+        found: boolean;
+        net?: Net;
+    };
+    visitFunction_def_expr(ctx: Function_def_exprContext): void;
+    private setupDefinedParameters;
+    visitFunction_return_expr(ctx: Function_return_exprContext): ComplexType;
+    visitAtom_expr(ctx: Atom_exprContext): ReferenceType;
+    visitPin_select_expr2(ctx: Pin_select_expr2Context): string | number;
+    visitAt_block_pin_expr(ctx: At_block_pin_exprContext): ComponentPin;
+    visitAt_block(ctx: At_blockContext): ComponentPin;
+    visitAt_block_pin_expression_simple(ctx: At_block_pin_expression_simpleContext): void;
+    visitAt_block_pin_expression_complex(ctx: At_block_pin_expression_complexContext): ComponentPin;
+    visitWire_expr(ctx: Wire_exprContext): void;
+    visitPoint_expr(ctx: Point_exprContext): ComponentPin;
+    visitImport_expr(ctx: Import_exprContext): void;
+    visitProperty_set_expr(ctx: Property_set_exprContext): void;
+    visitDouble_dot_property_set_expr(ctx: Double_dot_property_set_exprContext): void;
+    visitRoundedBracketsExpr(ctx: RoundedBracketsExprContext): any;
+    visitFrame_expr(ctx: Frame_exprContext): void;
+    visitNet_namespace_expr(ctx: Net_namespace_exprContext): string;
+    pinTypes: PinTypes[];
+    createImportFileHandler(directory: string, defaultLibsPath: string): ((visitor: MainVisitor, importPath: string) => {
+        hasError: boolean;
+        hasParseError: boolean;
+        pathExists: boolean;
+    });
+    private importLib;
+    private parseCreateComponentPins;
+    private parseCreateComponentParams;
+    private prepareStringValue;
+    print(...params: any[]): void;
+    printNets(): void;
+    dumpNets(): ComponentPinNet[];
+    dumpUniqueNets(): Net[];
+    dumpVariables(): Map<string, any>;
+    dumpInstances(): Map<string, ClassComponent>;
+    dump2(): {
+        name: string;
+        refdes: string;
+        pins: {};
+    }[];
+    getNetList(): NetListItem[];
+    getGraph(): {
+        sequence: any[];
+        nets: import("./objects/types.js").ComponentPinNetPair[];
+        components: ClassComponent[];
+    };
+    annotateComponents(): void;
+    private resolveNets;
+    private setComponentOrientation;
+    private getPropertyExprList;
+    private runExpressions;
+    private setupPrintFunction;
+    private getNetNamespace;
+}
+export type NetListItem = {
+    instanceName: string;
+    instance: ClassComponent;
+    pins: {
+        [key: string | number]: string;
+    };
+};
+export declare class VisitorExecutionException {
+    errorMessage: string;
+    context: ParserRuleContext;
+    constructor(context: ParserRuleContext, errorMessage: string);
+    print(scriptData: string): void;
+}

package/package.json

@@ -1,16 +1,26 @@
 {
     "name": "circuitscript",
-    "version": "0.0.21",
+    "version": "0.0.24",
     "description": "Interpreter for the circuitscript language",
     "homepage": "https://circuitscript.net",
     "engines": {
         "node": ">=16.0"
     },
-    "type": "module",
-    "main": "./build/src/main.js",
+    "main": "./dist/cjs/index.js",
+    "module": "./dist/esm/index.mjs",
+    "types": "./dist/types/index.d.ts",
     "bin": {
-        "circuitscript": "./build/src/main.js"
+        "circuitscript": "./dist/esm/main.mjs"
     },
+    "exports": {
+        ".": {
+            "require": "./dist/cjs/index.js",
+            "import": "./dist/esm/index.mjs"
+        }
+    },
+    "files": [
+        "dist"
+    ],
     "devDependencies": {
         "@types/figlet": "^1.5.8",
         "@types/jest": "~29.5",
@@ -27,15 +37,22 @@
         "source-map-support": "^0.5.21",
         "ts-api-utils": "~0.0.44",
         "ts-jest": "~29.1",
+        "ts2mjs": "^3.0.0",
         "typescript": "^5.4.5"
     },
     "scripts": {
         "start": "node build/src/main.js",
-        "clean": "rimraf coverage build tmp",
-        "build": "tsc -p tsconfig.json",
-        "build:watch": "tsc -w -p tsconfig.json",
-        "build:release": "npm run clean && tsc -p tsconfig.release.json",
-        "prebuild": "npm run lint",
+        "clean": "rimraf coverage build tmp dist",
+        "build": "npm run build:cjs || npm run build:esm",
+        "build:cjs": "tsc -p tsconfig.cjs.json",
+        "build:release:cjs": "tsc -p tsconfig.release.cjs.json",
+        "build:esm": "tsc -p tsconfig.esm.json || npm run rename:esm",
+        "build:release:esm": "tsc -p tsconfig.release.esm.json || npm run rename:esm",
+        "rename:esm": "npx ts2mjs ./dist/esm && rm -rf ./dist/esm/*.js && rm -rf ./dist/esm/**/*.js",
+        "build:watch": "tsc -w -p tsconfig.esm.json",
+        "build:watch:cjs": "tsc -w -p tsconfig.cjs.json",
+        "build:release": "npm run clean && npm run build:release:cjs || npm run build:release:esm",
+        "prebuild": "npm run lint || true",
         "lint": "eslint . --ext .ts --ext .mts",
         "test": "jest",
         "test-coverage": "jest --coverage",
@@ -49,15 +66,16 @@
     "boilerplate_author": "Jakub Synowiec <jsynowiec@users.noreply.github.com>",
     "license": "MIT",
     "dependencies": {
-        "@dagrejs/graphlib": "^2.1.13",
-        "@flatten-js/core": "^1.4.3",
-        "@svgdotjs/svg.js": "^3.2.0",
+        "@dagrejs/graphlib": "2.1.13",
+        "@flatten-js/core": "1.5.5",
+        "@svgdotjs/svg.js": "3.2.0",
         "antlr4": "^4.13.0",
         "commander": "^11.1.0",
         "express": "^4.18.2",
         "figlet": "^1.7.0",
         "lodash": "^4.17.21",
         "svgdom": "^0.1.14",
+        "this-file": "^2.0.3",
         "tslib": "~2.5",
         "ws": "^8.14.2"
     },

package/.editorconfig

@@ -1,15 +0,0 @@
-root = true
-
-[*]
-charset = utf-8
-end_of_line = lf
-trim_trailing_whitespace = true
-insert_final_newline = true
-
-[*.md]
-insert_final_newline = false
-trim_trailing_whitespace = false
-
-[*.{js,json,ts,mts,yml,yaml}]
-indent_size = 2
-indent_style = space

package/.eslintignore

@@ -1 +0,0 @@
-/**/*.js

package/.eslintrc.json

@@ -1,27 +0,0 @@
-{
-  "env": {
-    "browser": false,
-    "es6": true,
-    "node": true
-  },
-  "parser": "@typescript-eslint/parser",
-  "parserOptions": {
-    "project": "tsconfig.json",
-    "sourceType": "module",
-    "ecmaVersion": 2020
-  },
-  "plugins": ["@typescript-eslint", "jest"],
-  "extends": [
-    "eslint:recommended",
-    "plugin:@typescript-eslint/recommended",
-    "plugin:jest/recommended",
-    "prettier"
-  ],
-  "rules": {
-    // The following rule is enabled only to supplement the inline suppression
-    // examples, and because it is not a recommended rule, you should either
-    // disable it, or understand what it enforces.
-    // https://typescript-eslint.io/rules/explicit-function-return-type/
-    "@typescript-eslint/explicit-function-return-type": "warn"
-  }
-}

package/.gitlab-ci.yml

@@ -1,81 +0,0 @@
-image: node:18
-
-# variables:
-#   ARTIFACT_DOWNLOAD_ATTEMPTS: 2 # Number of retries for restoring saved artifacts.
-#   FORCE_COLOR: '1' # Whether to force colour output in compatible tooling.
-#   GET_SOURCES_ATTEMPTS: 2 # Number of retries for git commands.
-#   GIT_STRATEGY: fetch # How to pull submodules.
-#   GIT_SUBMODULE_STRATEGY: recursive # How to treat nested git submodules.
-#   RESTORE_CACHE_ATTEMPTS: 2 # Number of retries for restoring cached files.
-
-stages:
-  - prepare
-  - test_jest
-  - test_build
-  - publish
-
-.common_rules:
-  rules:
-    - if: $CI_COMMIT_TAG
-    # - if: $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH
-
-# Installs all dependencies.
-install:
-  stage: prepare
-  interruptible: true
-  retry: 1
-  dependencies: []
-  artifacts:
-    name: 'deps_$CI_COMMIT_REF_SLUG'
-    paths:
-      - node_modules/
-    when: on_success
-    expire_in: 12h
-  script:
-    - echo $CI_COMMIT_BRANCH
-    - echo $CI_COMMIT_TAG
-    - echo $CI_PIPELINE_SOURCE
-    - echo $CI_COMMIT_REF_NAME
-    - npm install --no-progress --no-audit --no-fund --verbose
-  rules:
-    - !reference [.common_rules, rules]
-
-test_jest:
-  stage: test_jest
-  interruptible: true
-  retry: 1
-  dependencies:
-    - install
-  script:
-    - npm run build:release || true
-    - npm run test
-  rules:
-    - !reference [.common_rules, rules]
-
-test_build:
-  stage: test_build
-  interruptible: true
-  retry: 1
-  dependencies:
-    - install
-  script:
-    - npm run build:release || true
-    - ls
-    - ls build
-    - node build/src/main.js
-  rules:
-    - !reference [.common_rules, rules]
-
-# Publishes the package to npm.
-publish:
-  stage: publish
-  interruptible: false
-  dependencies:
-    - install
-  script:
-    - npm config set -- '//registry.npmjs.org/:_authToken' "${NPM_AUTH_TOKEN}"
-    - npm run build:release || true
-    - npm publish --verbose
-  resource_group: 'deployment-$CI_COMMIT_REF_SLUG'
-  rules:
-    - !reference [.common_rules, rules]

package/.prettierignore

@@ -1,8 +0,0 @@
-*.md
-*.json
-.prettierrc
-
-build/*
-src/antlr/CircuitScriptLexer.ts
-src/antlr/CircuitScriptParser.ts
-src/antlr/CircuitScriptVisitor.ts

package/.prettierrc

@@ -1,16 +0,0 @@
-{
-    "singleQuote": true,
-    "trailingComma": "all",
-    "tabWidth": 4,
-    "semi": true,
-    "overrides": [
-        {
-            "files": [
-                "*.ts"
-            ],
-            "options": {
-                "parser": "typescript"
-            }
-        }
-    ]
-}