@playcanvas/attribute-parser 1.0.3 → 1.0.4

package/package.json

@@ -5,7 +5,7 @@
   "engines": {
     "node": ">=18.0.0"
   },
-  "version": "1.0.3",
+  "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
@@ -54,6 +55,9 @@ export class JSDocParser {
         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/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/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;
+    });
+});