@playcanvas/attribute-parser 1.0.2 → 1.0.4

package/package.json

@@ -5,7 +5,7 @@
   "engines": {
     "node": ">=18.0.0"
   },
-  "version": "1.0.2",
+  "version": "1.0.4",
   "dependencies": {
     "@microsoft/tsdoc": "^0.15.0",
     "@typescript/vfs": "^1.6.0",

package/src/global.types.js

@@ -0,0 +1,18 @@
+/**
+ * These types are use to extend the global types in the program being parsed.
+ * It's useful to add types to modules that are not written in TypeScript.
+ */
+
+// This allows http/s modules to be imported without TypeScript errors
+
+export default `
+declare module 'http://*' {
+  const value: any;
+  export default value;
+}
+
+declare module 'https://*' {
+  const value: any;
+  export default value;
+}
+`

package/src/index.js

@@ -1,6 +1,6 @@
 import * as ts from 'typescript';
 import { createSystem, createDefaultMapFromNodeModules, createVirtualTypeScriptEnvironment } from '@typescript/vfs';
-
+import globalTypes from './global.types.js';
 import { ScriptParser } from './parsers/script-parser.js';
 import { createDefaultMapFromCDN, flatMapAnyNodes, getExportedNodes, getType, inheritsFrom, isAliasedClassDeclaration } from './utils/ts-utils.js';
 
@@ -8,6 +8,7 @@ const toLowerCamelCase = str => str[0].toLowerCase() + str.substring(1);
 
 const COMPILER_OPTIONS = {
     strictPropertyInitialization: false, // Allow uninitialized properties
+    skipLibCheck: true, // Skip type checking of declaration files
     target: ts.ScriptTarget.ES2022, // If this version changes, the types must be updated in the /rollup.config.mjs
     module: ts.ModuleKind.CommonJS,
     checkJs: true, // Enable JSDoc parsing
@@ -32,14 +33,20 @@ export class JSDocParser {
      */
     _errors = [];
 
-    async init(basePath = '') {
+    /**
+     * Initializes the JSDocParser with the standard library files
+     * 
+     * @param {string} libPath - The path to standard library files
+     * @returns {Promise<JSDocParser>} - The initialized JSDocParser
+     */
+    async init(libPath = '') {
         if (this._env) {
-            return;
+            return this;
         }
 
         let fsMap;
-        if (basePath) {
-            fsMap = await createDefaultMapFromCDN({ target: ts.ScriptTarget.ES2022 }, basePath, ts);
+        if (libPath) {
+            fsMap = await createDefaultMapFromCDN({ target: ts.ScriptTarget.ES2022 }, libPath, ts);
         } else {
             fsMap = await createDefaultMapFromNodeModules(COMPILER_OPTIONS, ts);
         }
@@ -47,6 +54,11 @@ export class JSDocParser {
         // Set up the virtual file system and environment
         const system = createSystem(fsMap);
         this._env = createVirtualTypeScriptEnvironment(system, Array.from(fsMap.keys()), ts, COMPILER_OPTIONS);
+
+        // Add global types to the parser
+        this._env.createFile('/global.d.ts', globalTypes);
+
+        return this;
     }
 
     /**

package/src/parsers/script-parser.js

@@ -190,6 +190,11 @@ const mapAttributesToOutput = (attribute) => {
     // set the default value
     if (attribute.value !== undefined) attribute.default = attribute.value;
 
+    // Curve Attributes specifically should not expose a default value if it's an empty array
+    if (attribute.type === 'curve' && Array.isArray(attribute.value) && attribute.value.length === 0) {
+        delete attribute.default;
+    }
+
     // remove typeName from the output
     delete attribute.typeName;
     delete attribute.value;

package/test/fixtures/asset.invalid.js

@@ -21,6 +21,7 @@ class Example extends Script {
      * @resource
      */
     c;
+
 }
 
 export { Example };

package/test/fixtures/program.valid.js

@@ -0,0 +1,18 @@
+import { Script } from 'playcanvas';
+
+// The parser should ignore https imports and not throw an error
+import confetti from "https://esm.sh/canvas-confetti@1.6.0"
+
+class Example extends Script {
+    /**
+     * @attribute
+     * @type {boolean}
+     */
+    a = false;
+
+    initialize() {
+        confetti();
+    }
+}
+
+export { Example };

package/test/tests/valid/curve.test.js

@@ -27,7 +27,7 @@ describe('VALID: Curve attribute', function () {
         expect(data[0].example.attributes.a.name).to.equal('a');
         expect(data[0].example.attributes.a.type).to.equal('curve');
         expect(data[0].example.attributes.a.array).to.equal(false);
-        expect(data[0].example.attributes.a.default).to.eql([]);
+        expect(data[0].example.attributes.a.default).to.not.exist;
     });
 
     it('b: should be a curve attribute with a default value', function () {
@@ -43,7 +43,7 @@ describe('VALID: Curve attribute', function () {
         expect(data[0].example.attributes.c.name).to.equal('c');
         expect(data[0].example.attributes.c.type).to.equal('curve');
         expect(data[0].example.attributes.c.array).to.equal(false);
-        expect(data[0].example.attributes.c.default).to.eql([]);
+        expect(data[0].example.attributes.a.default).to.not.exist;
         expect(data[0].example.attributes.c.color).to.equal('r');
     });
 
@@ -52,7 +52,7 @@ describe('VALID: Curve attribute', function () {
         expect(data[0].example.attributes.d.name).to.equal('d');
         expect(data[0].example.attributes.d.type).to.equal('curve');
         expect(data[0].example.attributes.d.array).to.equal(false);
-        expect(data[0].example.attributes.d.default).to.eql([]);
+        expect(data[0].example.attributes.a.default).to.not.exist;
         expect(data[0].example.attributes.d.color).to.equal('rgb');
         expect(data[0].example.attributes.d.curves).to.deep.equal(['x', 'y', 'z']);
     });
@@ -63,7 +63,7 @@ describe('VALID: Curve attribute', function () {
         expect(data[0].example.attributes.e.type).to.equal('curve');
         expect(data[0].example.attributes.e.array).to.equal(true);
         expect(data[0].example.attributes.e.size).to.equal(2);
-        expect(data[0].example.attributes.e.default).equal(null);
+        expect(data[0].example.attributes.e.default).to.not.exist;
     });
 
     it('f: should be a curve attribute in an unsual format', function () {

package/test/tests/valid/program.test.js

@@ -0,0 +1,18 @@
+/* eslint-disable no-unused-expressions */
+import { describe, it, before } from 'mocha';
+import { expect } from 'chai';
+
+import { parseAttributes } from '../../utils.js';
+
+describe('VALID: Program ', function () {
+    let data;
+    before(async function () {
+        data = await parseAttributes('./program.valid.js');
+    });
+
+    it('only results should exist', function () {
+        expect(data).to.exist;
+        expect(data[0]).to.not.be.empty;
+        expect(data[1]).to.be.empty;
+    });
+});