@satisfactory-dev/docs.json.ts 0.10.0 → 0.11.0

package/lib/TypeDefinitionWriter.js

@@ -26,13 +26,15 @@ export class TypeDefinitionWriter {
     prepared = false;
     data_discovery;
     docs;
-    constructor(docs) {
+    version;
+    constructor(docs, version) {
         this.docs = docs;
-        this.data_discovery = new DataDiscovery(docs);
+        this.data_discovery = new DataDiscovery(docs, version);
+        this.version = version;
     }
     get discovery() {
         if (!this._discovery) {
-            const schema = this.docs.schema();
+            const schema = this.docs.schema(this.version);
             const type_definition_discover = require_non_empty_array([
                 ...TypeDefinitionDiscovery.standard_jsonschema_discovery(this.docs.ajv),
                 ...TypeDefinitionDiscovery.custom_parsing_discovery(this.docs.ajv),
@@ -41,7 +43,7 @@ export class TypeDefinitionWriter {
                 return new TypeDefinitionDiscovery([
                     ...TypesDiscovery.standard_jsonschema_discovery(schema),
                     ...TypesDiscovery.custom_parsing_types(schema),
-                ], type_definition_discover, this.docs);
+                ], type_definition_discover, this.docs, this.version);
             }));
         }
         return this._discovery;
@@ -54,8 +56,8 @@ export class TypeDefinitionWriter {
         const discovery = await this.discovery;
         performance.measure(`${this.constructor.name}.write() discovery`, `${this.constructor.name}.write() start`);
         performance.mark(`${this.constructor.name}.write() start`);
-        await writeFile(`${__dirname}/../types-progress.md`, await discovery.generate_markdown());
-        await writeFile(`${__dirname}/../data-progress.md`, await this.data_discovery.generate_markdown());
+        await writeFile(`${__dirname}/../types-progress--${this.version}.md`, await discovery.generate_markdown());
+        await writeFile(`${__dirname}/../data-progress--${this.version}.md`, await this.data_discovery.generate_markdown());
         performance.measure(`${this.constructor.name}.write() generate_markdown`, `${this.constructor.name}.write() start`);
         if (cleanup) {
             performance.mark(`${this.constructor.name}.write() start`);
@@ -66,7 +68,7 @@ export class TypeDefinitionWriter {
         }
         performance.mark(`${this.constructor.name}.write() start`);
         const types = await discovery.discover_type_$defs();
-        const schema = await this.docs.schema();
+        const schema = await this.docs.schema(this.version);
         if (types.missing_classes.length > 0
             || types.missing_types.length > 0) {
             throw new NoMatchError({
@@ -88,7 +90,7 @@ export class TypeDefinitionWriter {
         }
         const files = await FilesGenerator.merge_files([
             discovery,
-            new DocsFiles(validations, discovery),
+            new DocsFiles(validations, discovery, this.version),
             new FromArray([
                 ...legacy_UnrealEngineString_module.CustomGenerators(),
                 string_starts_with,
@@ -101,7 +103,7 @@ export class TypeDefinitionWriter {
         const auto_imports = new DocsTsAutoImports(files);
         const import_tracker = auto_imports.generate();
         performance.measure(`${this.constructor.name}.write() auto_imports`, `${this.constructor.name}.write() start`);
-        await writeFile(`${__dirname}/../imports-come-from.json`, auto_imports.imports_come_from);
+        await writeFile(`${__dirname}/../imports-come-from.${this.version}.json`, auto_imports.imports_come_from);
         const printer = ts.createPrinter({
             newLine: ts.NewLineKind.LineFeed,
         });
@@ -211,7 +213,7 @@ export class TypeDefinitionWriter {
         }
         performance.measure(`${this.constructor.name}.write() actually write files`, `${this.constructor.name}.write() start`);
         performance.mark(`${this.constructor.name}.write() start`);
-        await writeFile(`${__dirname}/../data-progress.md`, await this.data_discovery.generate_markdown());
+        await writeFile(`${__dirname}/../data-progress--${this.version}.md`, await this.data_discovery.generate_markdown());
         performance.measure(`${this.constructor.name}.write() generate_markdown`, `${this.constructor.name}.write() start`);
         performance.mark(`${this.constructor.name}.write() start`);
         await eslint_generated_types(parent_folder);
@@ -233,4 +235,3 @@ export class TypeDefinitionWriter {
             && ts.isIdentifier(heritage[0][0].expression));
     }
 }
-//# sourceMappingURL=TypeDefinitionWriter.js.map

package/lib/TypesDiscovery/CandidatesDiscovery.js

@@ -11,4 +11,3 @@ export class PropertyDependentDiscovery extends CandidatesDiscovery {
         this.property = property;
     }
 }
-//# sourceMappingURL=CandidatesDiscovery.js.map

package/lib/TypesDiscovery/CustomParsingTypes/UnrealEngineString.js

@@ -15,4 +15,3 @@ export class UnrealEngineString extends CandidatesDiscovery {
         return undefined;
     }
 }
-//# sourceMappingURL=UnrealEngineString.js.map

package/lib/TypesDiscovery/CustomParsingTypes/typed_string.js

@@ -31,4 +31,3 @@ export class typed_string extends CandidatesDiscovery {
                     && object_has_non_empty_array_property(maybe.typed_string, 'prefixItems', value_is_non_array_object))));
     }
 }
-//# sourceMappingURL=typed_string.js.map

package/lib/TypesDiscovery/JsonSchema/$ref.js

@@ -29,4 +29,3 @@ export class $ref extends CandidatesDiscovery {
         return undefined;
     }
 }
-//# sourceMappingURL=$ref.js.map

package/lib/TypesDiscovery/JsonSchema/const.js

@@ -19,4 +19,3 @@ export class ConstString extends CandidatesDiscovery {
             && 2 === Object.keys(maybe).length);
     }
 }
-//# sourceMappingURL=const.js.map

package/lib/TypesDiscovery/JsonSchema/enum.js

@@ -19,4 +19,3 @@ export class EnumString extends CandidatesDiscovery {
             && 2 === Object.keys(maybe).length);
     }
 }
-//# sourceMappingURL=enum.js.map

package/lib/TypesDiscovery/JsonSchema/properties.js

@@ -11,4 +11,3 @@ export class properties extends CandidatesDiscovery {
         return undefined;
     }
 }
-//# sourceMappingURL=properties.js.map

package/lib/TypesDiscovery/non_array_object_property.js

@@ -8,4 +8,3 @@ export class non_array_object_property extends PropertyDependentDiscovery {
         return undefined;
     }
 }
-//# sourceMappingURL=non_array_object_property.js.map

package/lib/TypesDiscovery/non_empty_array_property.js

@@ -8,4 +8,3 @@ export class non_empty_array_property extends PropertyDependentDiscovery {
         return undefined;
     }
 }
-//# sourceMappingURL=non_empty_array_property.js.map

package/lib/TypesDiscovery.d.ts

@@ -1,12 +1,13 @@
 import { SchemaObject } from 'ajv/dist/2020';
 import { CandidatesDiscovery } from './TypesDiscovery/CandidatesDiscovery';
-import { DocsDataItem, DocsTsGenerator } from './DocsTsGenerator';
+import { docs_versions, DocsDataItem, DocsTsGenerator } from './DocsTsGenerator';
 import { local_ref } from './StringStartsWith';
 export declare class TypesDiscovery {
     private discovery;
     private readonly candidates_discovery;
     private readonly docs;
-    constructor(candidates_discovery: [CandidatesDiscovery, ...CandidatesDiscovery[]], docs: DocsTsGenerator);
+    private readonly version;
+    constructor(candidates_discovery: [CandidatesDiscovery, ...CandidatesDiscovery[]], docs: DocsTsGenerator, version: keyof docs_versions);
     discover_types(): Promise<{
         discovered_types: local_ref<string>[];
         missed_types: string[];
@@ -16,7 +17,7 @@ export declare class TypesDiscovery {
         CandidatesDiscovery,
         ...CandidatesDiscovery[]
     ]);
-    static generate_is_NativeClass(docs: DocsTsGenerator): Promise<import("ajv/dist/types").ValidateFunction<DocsDataItem>>;
+    static generate_is_NativeClass(docs: DocsTsGenerator, version: keyof docs_versions): Promise<import("ajv/dist/types").ValidateFunction<DocsDataItem>>;
     static standard_jsonschema_discovery(schema: SchemaObject): ([
         CandidatesDiscovery,
         ...CandidatesDiscovery[]

package/lib/TypesDiscovery.js

@@ -13,13 +13,15 @@ export class TypesDiscovery {
     discovery;
     candidates_discovery;
     docs;
-    constructor(candidates_discovery, docs) {
+    version;
+    constructor(candidates_discovery, docs, version) {
         this.candidates_discovery = candidates_discovery;
         this.docs = docs;
+        this.version = version;
     }
     async discover_types() {
         if (!this.discovery) {
-            const schema = await this.docs.schema();
+            const schema = await this.docs.schema(this.version);
             const discovered_types = new Set();
             this.discover_types_from(schema, schema, discovered_types);
             this.discovery = Promise.resolve({
@@ -48,8 +50,8 @@ export class TypesDiscovery {
             new typed_string(schema),
         ];
     }
-    static async generate_is_NativeClass(docs) {
-        const schema = await docs.schema();
+    static async generate_is_NativeClass(docs, version) {
+        const schema = await docs.schema(version);
         if (!object_has_property(schema, '$defs', value_is_non_array_object)) {
             throw new Error('Schema appears to have no $defs');
         }
@@ -74,4 +76,3 @@ export class TypesDiscovery {
         ];
     }
 }
-//# sourceMappingURL=TypesDiscovery.js.map

package/lib/TypesGeneration/validators.js

@@ -23,4 +23,3 @@ export const StringPassedRegExp = {
         ts.factory.createMappedTypeNode(undefined, ts.factory.createTypeParameterDeclaration(undefined, 'pseudo_key', type_reference_node('pattern')), undefined, undefined, create_type('never'), undefined),
     ])),
 };
-//# sourceMappingURL=validators.js.map

package/lib/TypesGeneration.js

@@ -50,4 +50,3 @@ export class ImportTracker {
         }
     }
 }
-//# sourceMappingURL=TypesGeneration.js.map

package/lib/__dirname.js

@@ -3,4 +3,3 @@ import { fileURLToPath, } from "node:url";
 export function __dirname_from_meta(meta) {
     return fileURLToPath(dirname(meta.url));
 }
-//# sourceMappingURL=__dirname.js.map

package/lib/generator.js

@@ -1,4 +1,3 @@
 export * from './DocsTsGenerator';
 export * from './DocsValidation';
 export * from './TypeDefinitionWriter';
-//# sourceMappingURL=generator.js.map

package/lib/helpers.js

@@ -1,5 +1,5 @@
 import { existsSync, } from 'node:fs';
-import { DocsTsGenerator, } from './DocsTsGenerator';
+import { DocsTsGenerator, DocsTsGeneratorVersion, } from './DocsTsGenerator';
 import { __dirname_from_meta, } from './__dirname';
 import Ajv from 'ajv/dist/2020';
 import { configure_ajv, } from './DocsValidation';
@@ -18,12 +18,21 @@ const ajv = new Ajv({
 configure_ajv(ajv);
 export const docs = new DocsTsGenerator({
     ajv,
-    docs_path: `${__dirname}/../data/Docs.json`,
-    cache_path: `${__dirname}/../data/`,
+    docs_versions: {
+        version_1_0_0_0: new DocsTsGeneratorVersion({
+            docs_path: `${__dirname}/../data/1.0/en-US.json`,
+            cache_path: `${__dirname}/../data/1.0/`,
+            UnrealEngineString_quote_mode: 'double',
+        }),
+        update8: new DocsTsGeneratorVersion({
+            docs_path: `${__dirname}/../data/update8/Docs.json`,
+            cache_path: `${__dirname}/../data/update8/`,
+            UnrealEngineString_quote_mode: 'original',
+        }),
+    },
 });
 export const skip_because_docs_dot_json_not_yet_bundled = {
-    skip: existsSync(`${__dirname}/../data/Docs.json`)
+    skip: existsSync(`${__dirname}/../data/update8/Docs.json`)
         ? false
         : 'Docs.json not yet bundled!',
 };
-//# sourceMappingURL=helpers.js.map

package/lib/index.js

@@ -1,4 +1,3 @@
 export * from './CustomParsingTypes/CustomPairingTypes';
 export * from './Exceptions';
 export * from './StringStartsWith';
-//# sourceMappingURL=index.js.map

package/package.json

@@ -15,7 +15,8 @@
   "scripts": {
     "test": "ts-node ./tests.ts",
     "generate": "ts-node ./generate-typescript-types.ts",
-    "validate": "ts-node validate-Docs.ts"
+    "validate": "ts-node validate-Docs.ts",
+    "validate--version-1": "ts-node validate-Docs--1.0.ts"
   },
   "devDependencies": {
     "@satisfactory-dev/custom-assert": "^0.2.3",
@@ -37,5 +38,5 @@
     "typescript": "~5.5.2",
     "typescript-eslint": "^8.2.0"
   },
-  "version": "0.10.0"
+  "version": "0.11.0"
 }