@satisfactory-dev/docs.json.ts 0.7.2 → 0.9.1

package/lib/DocsTsGenerator.d.ts

@@ -21,6 +21,7 @@ export declare class DocsTsGenerator {
     private readonly cache_path;
     private readonly docs_path;
     readonly ajv: Ajv;
+    readonly types_from_module: string | undefined;
     static readonly PERF_EARLY_RETURN = "Early Return of Docs.json";
     static readonly PERF_FAILURE = "Failure to load Docs.json";
     static readonly PERF_FILE_PARSED = "Docs.json contents parsed";
@@ -30,10 +31,11 @@ export declare class DocsTsGenerator {
     static readonly PERF_VALIDATION_FINISHED = "Docs.json validation finished";
     static readonly PERF_VALIDATION_PRECOMPILE = "Docs.json validation pre-compilation started";
     static readonly PERF_VALIDATION_STARTED = "Docs.json validation started";
-    constructor({ ajv, docs_path, cache_path, }: {
+    constructor({ ajv, docs_path, cache_path, types_from_module, }: {
         ajv: Ajv;
         docs_path: string | DocsData;
         cache_path?: string;
+        types_from_module?: string;
     });
     definition($ref: string): Promise<SchemaObject>;
     get(): Promise<DocsData>;

package/lib/DocsTsGenerator.js

@@ -28,6 +28,7 @@ export class DocsTsGenerator {
     cache_path;
     docs_path;
     ajv;
+    types_from_module;
     static PERF_EARLY_RETURN = 'Early Return of Docs.json';
     static PERF_FAILURE = 'Failure to load Docs.json';
     static PERF_FILE_PARSED = 'Docs.json contents parsed';
@@ -43,10 +44,11 @@ export class DocsTsGenerator {
     // raw JSON or path to UTF-16LE encoded Docs.json
     docs_path, 
     // optional cache folder path for cacheable resources
-    cache_path = undefined, }) {
+    cache_path = undefined, types_from_module = undefined, }) {
         this.ajv = ajv;
         this.docs_path = docs_path;
         this.cache_path = cache_path;
+        this.types_from_module = types_from_module;
     }
     async definition($ref) {
         const schema = await this.schema();

package/lib/FilesGenerator.js

@@ -33,5 +33,15 @@ export function guess_filename(ref) {
         || ref.startsWith('EditorCurveData--')) {
         return 'classes/base.ts';
     }
+    else if ([
+        'boolean',
+        'boolean-extended',
+        'integer-string',
+        'integer-string--signed',
+        'decimal-string',
+        'decimal-string--signed',
+    ].includes(ref)) {
+        return 'common/scalar.ts';
+    }
     return 'common/unassigned.ts';
 }

package/lib/TypeDefinitionWriter.js

@@ -202,8 +202,12 @@ export class TypeDefinitionWriter {
                     }, 'Error printing node!');
                 }
             }
-            await writeFile(file_name, await format_code(node_strings
-                .join('\n\n')));
+            let code = await format_code(node_strings
+                .join('\n\n'));
+            if (this.docs.types_from_module) {
+                code = code.replace(/} from '(?:\.\.\/)+(classes|common|utils)\//g, `} from '${this.docs.types_from_module}/$1`);
+            }
+            await writeFile(file_name, code);
         }
         performance.measure(`${this.constructor.name}.write() actually write files`, `${this.constructor.name}.write() start`);
         performance.mark(`${this.constructor.name}.write() start`);

package/package.json

@@ -36,5 +36,5 @@
     "typescript": "~5.5.2",
     "typescript-eslint": "^7.3.1"
   },
-  "version": "0.7.2"
+  "version": "0.9.1"
 }