node-opcua-generator 2.70.0 → 2.71.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,808 +1,808 @@
1
- "use strict";
2
- /* istanbul ignore file */
3
- /**
4
- * @module node-opcua-generator
5
- */
6
- Object.defineProperty(exports, "__esModule", { value: true });
7
- exports.produce_TScript_code = exports.writeStructuredType = exports.get_class_JScript_filename = exports.get_class_TScript_filename = void 0;
8
- // tslint:disable:max-line-length
9
- // tslint:disable:max-depth
10
- const os = require("os");
11
- const path = require("path");
12
- const fs = require("fs");
13
- const node_opcua_assert_1 = require("node-opcua-assert");
14
- const node_opcua_factory_1 = require("node-opcua-factory");
15
- const node_opcua_constants_1 = require("node-opcua-constants");
16
- const node_opcua_debug_1 = require("node-opcua-debug");
17
- const node_opcua_nodeid_1 = require("node-opcua-nodeid");
18
- const node_opcua_utils_1 = require("node-opcua-utils");
19
- const write_func_1 = require("./utils/write_func");
20
- const index_1 = require("./utils/index");
21
- const produceComment = false;
22
- const debugLog = (0, node_opcua_debug_1.make_debugLog)(__filename);
23
- const generatedObjectSchema = {};
24
- function quotify(str) {
25
- return '"' + str + '"';
26
- }
27
- function makeFieldType(field) {
28
- return "{" + field.fieldType + (field.isArray ? "[" : "") + (field.isArray ? "]" : "") + "}";
29
- }
30
- function convertToJavascriptCode(obj) {
31
- const lines = [];
32
- if (typeof obj === "object" && !(obj instanceof Array)) {
33
- lines.push("{");
34
- for (const prop of Object.keys(obj)) {
35
- lines.push(prop, ": ", convertToJavascriptCode(obj[prop]), ",");
36
- }
37
- lines.push("}");
38
- }
39
- else if (obj instanceof Array) {
40
- lines.push("[");
41
- for (const prop of obj) {
42
- lines.push(convertToJavascriptCode(prop), ",");
43
- }
44
- lines.push("]");
45
- // tslint:disable:no-empty
46
- }
47
- else if (typeof obj === "function") {
48
- /** */
49
- }
50
- else {
51
- lines.push(JSON.stringify(obj));
52
- }
53
- return lines.join("");
54
- }
55
- function get_class_folder(schemaName, optionalFolder) {
56
- let folder;
57
- if (optionalFolder) {
58
- if (!fs.existsSync(optionalFolder)) {
59
- fs.mkdirSync(optionalFolder);
60
- if (!fs.existsSync(optionalFolder)) {
61
- throw new Error("get_class_TScript_filename: Cannot find folder " + optionalFolder);
62
- }
63
- }
64
- folder = optionalFolder;
65
- }
66
- else {
67
- folder = exports.folder_for_generated_file;
68
- throw new Error("get_class_javascript_filename : DEPRECATED ");
69
- }
70
- return folder;
71
- }
72
- function get_class_TScript_filename(schemaName, optionalFolder) {
73
- const folder = get_class_folder(schemaName, optionalFolder);
74
- return path.join(folder, "_" + schemaName + ".ts");
75
- }
76
- exports.get_class_TScript_filename = get_class_TScript_filename;
77
- function get_class_JScript_filename(schemaName, optionalFolder) {
78
- const folder = get_class_folder(schemaName, optionalFolder);
79
- return path.join(folder, "_" + schemaName + ".js");
80
- }
81
- exports.get_class_JScript_filename = get_class_JScript_filename;
82
- function get_class_TScript_filename_local(schemaName) {
83
- let schema = (0, node_opcua_factory_1.getStructuredTypeSchema)(schemaName);
84
- if (!schema) {
85
- schema = generatedObjectSchema[schemaName];
86
- if (!schema) {
87
- throw new Error("cannot find script file for " + schemaName);
88
- }
89
- return "./_" + schemaName;
90
- }
91
- let generateTypeScriptSource = "/* fix me schema.prototype.schema.generate_ts_source*/";
92
- if (!generateTypeScriptSource) {
93
- const folder = "."; // exports.folder_for_generated_file;
94
- generateTypeScriptSource = path.join(folder, "_" + schemaName + ".ts");
95
- }
96
- return generateTypeScriptSource;
97
- }
98
- function write_enumeration_setter(write, schema, field, member) {
99
- const capMember = (0, node_opcua_utils_1.capitalizeFirstLetter)(member);
100
- write(` public set${capMember}(value: any): ${field.fieldType} {`);
101
- write(` const coercedValue = _enumeration${field.fieldType}.get(value);`);
102
- write(` /* istanbul ignore next */`);
103
- write(` if (coercedValue === undefined || coercedValue === null) {`);
104
- write(` throw new Error("value cannot be coerced to ${field.fieldType} :" + value);`);
105
- write(` }`);
106
- write(` this.${member} = coercedValue.value as ${field.fieldType};`);
107
- write(` return this.${member};`);
108
- write(` }`);
109
- }
110
- function write_enumeration_fast_init(write, schema, field, member, i) {
111
- write(` this.${member} = 0 as ${field.fieldType};`);
112
- }
113
- function write_enumeration(write, schema, field, member, i) {
114
- (0, node_opcua_assert_1.assert)(!field.isArray); // would not work in this case
115
- const capMember = (0, node_opcua_utils_1.capitalizeFirstLetter)(member);
116
- write(` this.${field.name} = this.set${capMember}(initialize_field(schema.fields[${i}], options?.${field.name}));`);
117
- }
118
- function write_complex_fast_init(write, schema, field, member) {
119
- if (field.isArray) {
120
- write(` this.${member} = null; /* null array */`);
121
- }
122
- else {
123
- write(` this.${member} = new ${field.fieldType}(null);`);
124
- }
125
- }
126
- function write_complex(write, schema, field, member /*, i*/) {
127
- if (field.isArray) {
128
- if (Object.prototype.hasOwnProperty.call(field, "defaultValue")) {
129
- // todo: fix me => should call field defaultValue in the live version
130
- write(` this.${member} = []; // should default`);
131
- }
132
- else {
133
- write(` this.${member} = [];`);
134
- }
135
- write(` if (options.${member}) {`);
136
- write(` assert(Array.isArray(options.${member}));`);
137
- write(` this.${member} = options.${member}.map((e: any) => new ${field.fieldType}(e));`);
138
- // write(` self.${member} = options.${member}.map(function(e){ return construct${field.fieldType}(e); } );`);
139
- write(" }");
140
- }
141
- else {
142
- if (field.defaultValue === null || field.fieldType === schema.name) {
143
- write(` this.${member} = (options.${member}) ? new ${field.fieldType}( options.${member}) : null;`);
144
- // xx write(` self.${member} = (options.${member}) ? construct${field.fieldType}( options.${member}) : null;`);
145
- }
146
- else {
147
- write(` this.${member} = new ${field.fieldType}(options.${member});`);
148
- // xx write(` self.${member} = construct${field.fieldType}(options.${member});`);
149
- }
150
- }
151
- }
152
- function write_basic(write, schema, field, member, i) {
153
- (0, node_opcua_assert_1.assert)(field.category === node_opcua_factory_1.FieldCategory.basic);
154
- if (field.isArray) {
155
- // write(`this.${member} = [];`);
156
- // write(`if (options.${member}) {`);
157
- // write(` assert(Array.isArray(options.${member}));`);
158
- // write(` this.${member} = options.browsePath.map(e => field.coerce(e) );`);
159
- // write(`}`);
160
- write(` this.${member} = initialize_field_array(schema.fields[${i}], options?.${field.name});`);
161
- }
162
- else {
163
- write(` this.${member} = initialize_field(schema.fields[${i}], options?.${field.name});`);
164
- }
165
- }
166
- function write_basic_fast_init(write, schema, field, member, i) {
167
- if (field.isArray) {
168
- // write(`this.${member} = [];`);
169
- // write(`if (options.${member}) {`);
170
- // write(` assert(Array.isArray(options.${member}));`);
171
- // write(` this.${member} = options.browsePath.map(e => field.coerce(e) );`);
172
- // write(`}`);
173
- write(` this.${member} = []`);
174
- }
175
- else {
176
- switch (field.schema.name) {
177
- case "Variant":
178
- write(` this.${member} = new Variant(null);`);
179
- break;
180
- case "UABoolean":
181
- case "Boolean":
182
- write(` this.${member} = false;`);
183
- break;
184
- case "UAString":
185
- write(` this.${member} = null;`);
186
- break;
187
- case "ExpandedNodeId":
188
- write(` this.${member} = new ExpandedNodeId(null);`);
189
- break;
190
- case "NodeId":
191
- write(` this.${member} = new NodeId(null);`);
192
- break;
193
- case "QualifiedName":
194
- write(` this.${member} = new QualifiedName(null);`);
195
- break;
196
- case "DateTime":
197
- write(` this.${member} = new Date();`);
198
- break;
199
- case "ByteString":
200
- write(` this.${member} = Buffer.alloc(0);`);
201
- break;
202
- case "StatusCode":
203
- write(` this.${member} = StatusCodes.Good;`);
204
- break;
205
- case "DiagnosticInfo":
206
- case "ExtensionObject":
207
- write(` this.${member} = null;`);
208
- break;
209
- case "NumericRange":
210
- write(` this.${member} = new NumericRange(null);`);
211
- break;
212
- case "LocalizedText":
213
- write(` this.${member} = new LocalizedText(null);`);
214
- break;
215
- case "Guid":
216
- write(` this.${member} = "";`);
217
- break;
218
- case "UInt64":
219
- write(` this.${member} = [];`);
220
- break;
221
- case "Int64":
222
- write(` this.${member} = [];`);
223
- break;
224
- case "DataValue":
225
- write(` this.${member} = new DataValue(null);`);
226
- break;
227
- default:
228
- write(` this.${member} = 0;`);
229
- }
230
- }
231
- }
232
- function write_fast_init_member(write, schema, field, i) {
233
- const member = field.name;
234
- switch (field.category) {
235
- case node_opcua_factory_1.FieldCategory.enumeration:
236
- write_enumeration_fast_init(write, schema, field, member, i);
237
- break;
238
- case node_opcua_factory_1.FieldCategory.basic:
239
- write_basic_fast_init(write, schema, field, member, i);
240
- break;
241
- case node_opcua_factory_1.FieldCategory.complex:
242
- write_complex_fast_init(write, schema, field, member);
243
- break;
244
- }
245
- }
246
- function write_constructor(write, schema) {
247
- const baseClass = schema.baseType;
248
- const className = schema.name;
249
- write("");
250
- const n = schema.fields.length;
251
- if (produceComment) {
252
- write(" /**");
253
- if (schema.documentation && schema.documentation.length > 0) {
254
- write(" * " + schema.documentation);
255
- }
256
- let def = "";
257
- for (let i = 0; i < n; i++) {
258
- const field = schema.fields[i];
259
- const fieldType = field.fieldType;
260
- const documentation = field.documentation ? field.documentation : "";
261
- def = "";
262
- if (field.defaultValue !== undefined) {
263
- if (typeof field.defaultValue === "function") {
264
- def = " = " + field.defaultValue();
265
- }
266
- else {
267
- def = " = " + field.defaultValue;
268
- }
269
- }
270
- const ft = makeFieldType(field);
271
- // xx write(" * @param [options." + field.name + def + "] " + ft + " " + documentation);
272
- }
273
- write(" */");
274
- }
275
- write(` constructor(options?: ${className}Options | null) {`);
276
- write("");
277
- if (baseClass) {
278
- if (baseClass === "BaseUAObject") {
279
- write(" super();");
280
- }
281
- else {
282
- write(" super(options);");
283
- }
284
- write("");
285
- }
286
- // detect de-serialization constructor
287
- // -----------------------------------------------------------------------------------------------------------------
288
- // Special case when options === null => fast constructor for de-serialization
289
- // -----------------------------------------------------------------------------------------------------------------
290
- write(` if (options === null) {`);
291
- for (let i = 0; i < n; i++) {
292
- const field = schema.fields[i];
293
- write_fast_init_member(write, schema, field, i);
294
- }
295
- write(" return;");
296
- write(" }");
297
- write(` const schema = ${className}.schema;`);
298
- if (typeof schema.constructHook === "function") {
299
- write(` options = schema.constructHook(options) as ${className}Options;`);
300
- }
301
- else {
302
- write(` options = (schema.constructHook ? schema.constructHook(options) as ${className}Options: options ) || {};`);
303
- }
304
- // write(" if (options === undefined) { options = {}; }");
305
- write(" /* istanbul ignore next */");
306
- write(" if (parameters.debugSchemaHelper) {");
307
- write(" check_options_correctness_against_schema(this, schema, options);");
308
- write(" }");
309
- // -----------------------------------------------------------------------------------------------------------------
310
- for (let i = 0; i < n; i++) {
311
- const field = schema.fields[i];
312
- const member = field.name;
313
- if (produceComment) {
314
- write("");
315
- write(" /**");
316
- const documentation = field.documentation ? field.documentation : "";
317
- if (documentation && documentation.length > 0) {
318
- write(" * ", documentation);
319
- }
320
- if (produceComment) {
321
- write(" * @property ", field.name);
322
- // write(" * @type {", (field.isArray ? "Array[" : "") + field.fieldType + (field.isArray ? " ]" : "")+"}");
323
- write(" * @type " + makeFieldType(field));
324
- }
325
- if (field.defaultValue !== undefined && typeof field.defaultValue !== "function") {
326
- write(" * @default ", field.defaultValue);
327
- }
328
- write(" */");
329
- }
330
- switch (field.category) {
331
- case node_opcua_factory_1.FieldCategory.enumeration:
332
- write_enumeration(write, schema, field, member, i);
333
- break;
334
- case node_opcua_factory_1.FieldCategory.complex:
335
- write_complex(write, schema, field, member);
336
- break;
337
- default:
338
- write_basic(write, schema, field, member, i);
339
- break;
340
- }
341
- }
342
- write(" }");
343
- }
344
- function write_possible_fields(write, className, possibleFields) {
345
- write(" public static possibleFields: string[] = [");
346
- write(" " + possibleFields.map(quotify).join("," + os.EOL + " "));
347
- write(" ];");
348
- }
349
- function write_isValid(write, schema) {
350
- // ---------------------------------------
351
- if (typeof schema.isValid === "function") {
352
- if (produceComment) {
353
- write(" /**");
354
- write(" *");
355
- write(" * verify that all object attributes values are valid according to schema");
356
- write(" * @method isValid");
357
- write(" * @return {Boolean}");
358
- write(" */");
359
- }
360
- write(" isValid(): boolean { return schema.isValid(this); };");
361
- }
362
- }
363
- function write_encode(write, schema) {
364
- if (typeof schema.encode === "function") {
365
- write(" public encode(stream: OutputBinaryStream): void {");
366
- write(" " + "schema" + ".encode(this, stream);");
367
- write(" }");
368
- }
369
- else {
370
- if (produceComment) {
371
- write(" /**");
372
- write(" * encode the object into a binary stream");
373
- write(" * @method encode");
374
- write(" *");
375
- write(" * @param stream {BinaryStream}");
376
- write(" */");
377
- }
378
- write(" public encode(stream: OutputBinaryStream): void {");
379
- write(" /* NEEDED */ super.encode(stream);");
380
- const n = schema.fields.length;
381
- for (let i = 0; i < n; i++) {
382
- const field = schema.fields[i];
383
- const member = field.name;
384
- switch (field.category) {
385
- case node_opcua_factory_1.FieldCategory.enumeration:
386
- case node_opcua_factory_1.FieldCategory.basic:
387
- if (field.isArray) {
388
- write(` encodeArray(this.${member}, stream, encode${field.fieldType});`);
389
- }
390
- else {
391
- write(` encode${field.fieldType}(this.${member}, stream);`);
392
- }
393
- break;
394
- case node_opcua_factory_1.FieldCategory.complex:
395
- if (field.isArray) {
396
- write(` encodeArray(this.${member}, stream, (obj, stream1) => { obj.encode(stream1); });`);
397
- }
398
- else {
399
- write(` this.${member}.encode(stream);`);
400
- }
401
- break;
402
- }
403
- }
404
- write(" }");
405
- }
406
- }
407
- function write_decode(write, schema) {
408
- // --------------------------------------------------------------
409
- // implement decode
410
- function write_field(field, member, i) {
411
- if (field.category === node_opcua_factory_1.FieldCategory.enumeration || field.category === node_opcua_factory_1.FieldCategory.basic) {
412
- if (field.isArray) {
413
- write(" this." + member + " = decodeArray(stream, decode" + field.fieldType + ");");
414
- }
415
- else {
416
- if (false) {
417
- write(" this." + member + ".decode(stream);");
418
- }
419
- else {
420
- if (typeof field.decode === "function") {
421
- write(" this." + member + " = " + "schema" + ".fields[" + i + "].decode(stream);");
422
- }
423
- else {
424
- write(" this." + member + " = decode" + field.fieldType + "(stream, this." + member + ");");
425
- }
426
- }
427
- }
428
- }
429
- else {
430
- (0, node_opcua_assert_1.assert)(field.category === node_opcua_factory_1.FieldCategory.complex);
431
- if (field.isArray) {
432
- write(" this." + member + " = decodeArray(stream, (stream1: BinaryStream) => {");
433
- write(" const obj = new " + field.fieldType + "(null);");
434
- write(" obj.decode(stream1);");
435
- write(" return obj;");
436
- write(" });");
437
- }
438
- else {
439
- write(" this." + member + ".decode(stream);");
440
- // xx write(" this." + member + ".decode(stream);");
441
- }
442
- }
443
- }
444
- // ---------------------------------------------------------------
445
- if (typeof schema.decode === "function") {
446
- if (produceComment) {
447
- write(" /**");
448
- write(" * decode the object from a binary stream");
449
- write(" * @method decode");
450
- write(" *");
451
- write(" * @param stream {BinaryStream}");
452
- write(" */");
453
- }
454
- write(" public decode(stream: BinaryStream): void {");
455
- write(" " + "schema" + ".decode(this,stream);");
456
- write(" }");
457
- if (typeof schema.decodeDebug !== "function") {
458
- throw new Error("schema decode requires also to provide a decodeDebug " + schema.name);
459
- }
460
- write(" public decodeDebug(stream: BinaryStream, options: any): void {");
461
- write(" " + "schema" + ".decodeDebug(this,stream,options);");
462
- write(" }");
463
- }
464
- else {
465
- if (produceComment) {
466
- write(" /**");
467
- write(" * decode the object from a binary stream");
468
- write(" * @method decode");
469
- write(" *");
470
- write(" * @param stream {BinaryStream}");
471
- write(" */");
472
- }
473
- write(" public decode(stream: BinaryStream): void {");
474
- write(" // call base class implementation first");
475
- write(" /* NEEDED !!! */ super.decode(stream);");
476
- const n = schema.fields.length;
477
- for (let i = 0; i < n; i++) {
478
- const field = schema.fields[i];
479
- const fieldType = field.fieldType;
480
- const member = field.name;
481
- write_field(field, member, i);
482
- }
483
- write(" }");
484
- }
485
- }
486
- function hasEnumeration(schema) {
487
- for (const field of schema.fields) {
488
- if (field.category === node_opcua_factory_1.FieldCategory.enumeration) {
489
- return true;
490
- }
491
- }
492
- return false;
493
- }
494
- function hasComplex(schema) {
495
- for (const field of schema.fields) {
496
- if (field.category === node_opcua_factory_1.FieldCategory.complex) {
497
- return true;
498
- }
499
- }
500
- return false;
501
- }
502
- function write_class_constructor_options(write, schema) {
503
- const n = schema.fields.length;
504
- for (let i = 0; i < n; i++) {
505
- const field = schema.fields[i];
506
- const member = field.name;
507
- const arrayOpt = field.isArray ? "[] | null" : "";
508
- switch (field.category) {
509
- case node_opcua_factory_1.FieldCategory.enumeration: {
510
- write(` ${member}?: ${field.fieldType}${arrayOpt};`);
511
- break;
512
- }
513
- case node_opcua_factory_1.FieldCategory.basic: {
514
- if (field.fieldType === "ExtensionObject") {
515
- write(` ${member}?: (${field.fieldType} | null)${arrayOpt};`);
516
- }
517
- else if (field.fieldType === "DiagnosticInfo") {
518
- write(` ${member}?: (${field.fieldType} | null)${arrayOpt};`);
519
- }
520
- else if (field.fieldType === "Variant" ||
521
- field.fieldType === "DataValue" ||
522
- field.fieldType === "NodeId" ||
523
- field.fieldType === "QualifiedName" ||
524
- field.fieldType === "LocalizedText") {
525
- write(` ${member}?: (${field.fieldType}Like | null)${arrayOpt};`);
526
- }
527
- else {
528
- write(` ${member}?: ${field.fieldType} ${arrayOpt};`);
529
- }
530
- break;
531
- }
532
- case node_opcua_factory_1.FieldCategory.complex: {
533
- write(` ${member}?: ${field.fieldType}Options ${arrayOpt};`);
534
- break;
535
- }
536
- }
537
- }
538
- }
539
- function write_declare_class_member(write, schema) {
540
- const n = schema.fields.length;
541
- for (let i = 0; i < n; i++) {
542
- const field = schema.fields[i];
543
- const member = field.name;
544
- const arrayOpt = field.isArray ? "[] | null" : "";
545
- switch (field.category) {
546
- case node_opcua_factory_1.FieldCategory.enumeration: {
547
- write(` public ${member}: ${field.fieldType}${arrayOpt};`);
548
- break;
549
- }
550
- case node_opcua_factory_1.FieldCategory.basic: {
551
- if (field.fieldType === "DiagnosticInfo") {
552
- write(` public ${member}: (${field.fieldType} | null)${arrayOpt};`);
553
- }
554
- else if (field.fieldType === "ExtensionObject") {
555
- write(` public ${member}: (${field.fieldType} | null)${arrayOpt};`);
556
- }
557
- else {
558
- write(` public ${member}: ${field.fieldType}${arrayOpt};`);
559
- }
560
- break;
561
- }
562
- case node_opcua_factory_1.FieldCategory.complex: {
563
- write(` public ${member}: ${field.fieldType}${arrayOpt};`);
564
- break;
565
- }
566
- }
567
- }
568
- }
569
- function write_enumerations(write, schema) {
570
- if (!hasEnumeration(schema)) {
571
- return;
572
- }
573
- write("");
574
- write(" // Define Enumeration setters");
575
- const n = schema.fields.length;
576
- for (let i = 0; i < n; i++) {
577
- const field = schema.fields[i];
578
- const member = field.name;
579
- if (field.category === node_opcua_factory_1.FieldCategory.enumeration) {
580
- write_enumeration_setter(write, schema, field, member);
581
- }
582
- }
583
- }
584
- function write_expose_encoder_decoder(write, schema) {
585
- write("");
586
- write('import { BinaryStream, OutputBinaryStream } from "node-opcua-binary-stream";');
587
- write('import { ExpandedNodeId, NodeId } from "node-opcua-nodeid";');
588
- const n = schema.fields.length;
589
- const done = {};
590
- for (let i = 0; i < n; i++) {
591
- const field = schema.fields[i];
592
- const fieldType = field.fieldType;
593
- if (!(fieldType in done)) {
594
- done[fieldType] = field;
595
- switch (field.category) {
596
- case node_opcua_factory_1.FieldCategory.basic:
597
- break;
598
- case node_opcua_factory_1.FieldCategory.enumeration:
599
- write("const _enumeration" + field.fieldType + " = " + 'getEnumeration("' + field.fieldType + '");');
600
- write("const encode" +
601
- field.fieldType +
602
- ': (value: any, stream: OutputBinaryStream) => void = getEnumeration("' +
603
- field.fieldType +
604
- '").encode;');
605
- write("const decode" +
606
- field.fieldType +
607
- ': (stream: BinaryStream) => void = getEnumeration("' +
608
- field.fieldType +
609
- '").decode;');
610
- break;
611
- case node_opcua_factory_1.FieldCategory.complex:
612
- write("const encode" +
613
- field.fieldType +
614
- ': (value: any, stream: OutputBinaryStream) => void = getBuildInType("' +
615
- field.fieldType +
616
- '").encode;');
617
- write("const decode" +
618
- field.fieldType +
619
- ': (stream: BinaryStream) => void = getBuildInType("' +
620
- field.fieldType +
621
- '").decode;');
622
- break;
623
- }
624
- }
625
- }
626
- }
627
- function writeStructuredType(write, schema) {
628
- const className = schema.name;
629
- const baseClass = schema.baseType;
630
- const dataTypeNodeId = getDataTypeNodeId(schema);
631
- const encodingBinaryNodeId = getEncodingBinaryId(schema);
632
- const encodingXmlNodeId = getEncodingXmlId(schema);
633
- const encodingJsonNodeId = getEncodingJsonId(schema);
634
- const needRegistration = encodingBinaryNodeId.value !== 0;
635
- // ----------------------------------------------- Options
636
- if (baseClass === "BaseUAObject" || baseClass === "ExtensionObject" || baseClass === "DataTypeDefinition") {
637
- write(`export interface ${className}Options {`);
638
- }
639
- else {
640
- write(`export interface ${className}Options extends ${baseClass}Options {`);
641
- }
642
- {
643
- write_class_constructor_options(write, schema);
644
- }
645
- write(`}`);
646
- write(`export class ${className} extends ${baseClass} {`);
647
- {
648
- write(` public static get schema(): StructuredTypeSchema { return schema${className}; }`);
649
- const possibleFields = (0, node_opcua_factory_1.extract_all_fields)(schema);
650
- write_possible_fields(write, className, possibleFields);
651
- // -------------------------------------------------------------------------
652
- // - encodingDefaultBinary
653
- // -------------------------------------------------------------------------
654
- write(` public static dataTypeNodeId = makeExpandedNodeId(${dataTypeNodeId.value}, ${dataTypeNodeId.namespace});`);
655
- if (encodingBinaryNodeId) {
656
- write(` public static encodingDefaultBinary = makeExpandedNodeId(${encodingBinaryNodeId.value}, ${encodingBinaryNodeId.namespace});`);
657
- }
658
- if (encodingXmlNodeId) {
659
- write(` public static encodingDefaultXml = makeExpandedNodeId(${encodingXmlNodeId.value}, ${encodingXmlNodeId.namespace});`);
660
- }
661
- else {
662
- write(" public static encodingDefaultXml = null;");
663
- }
664
- if (encodingJsonNodeId) {
665
- write(` public static encodingDefaultJson = makeExpandedNodeId(${encodingJsonNodeId.value}, ${encodingJsonNodeId.namespace});`);
666
- }
667
- else {
668
- write(" public static encodingDefaultJson = null;");
669
- }
670
- // xx write(` static schema = schema${className};`);
671
- write_declare_class_member(write, schema);
672
- write_constructor(write, schema);
673
- write_encode(write, schema);
674
- write_decode(write, schema);
675
- write_enumerations(write, schema);
676
- write_isValid(write, schema);
677
- write(` public get schema(): StructuredTypeSchema { return schema${className}; }`);
678
- }
679
- write("}");
680
- if (dataTypeNodeId) {
681
- write(`${className}.schema.dataTypeNodeId = ${className}.dataTypeNodeId;`);
682
- }
683
- if (encodingBinaryNodeId) {
684
- write(`${className}.schema.encodingDefaultBinary = ${className}.encodingDefaultBinary;`);
685
- }
686
- if (encodingXmlNodeId) {
687
- write(`${className}.schema.encodingDefaultXml = ${className}.encodingDefaultXml;`);
688
- }
689
- if (encodingJsonNodeId) {
690
- write(`${className}.schema.encodingDefaultJson = ${className}.encodingDefaultJson;`);
691
- }
692
- if (needRegistration) {
693
- write(`registerClassDefinition( ${className}.dataTypeNodeId, "${className}", ${className});`);
694
- }
695
- }
696
- exports.writeStructuredType = writeStructuredType;
697
- function getDataTypeNodeId(schema) {
698
- const className = schema.name;
699
- const encodingBinaryId = node_opcua_constants_1.DataTypeIds[className];
700
- return (0, node_opcua_nodeid_1.coerceNodeId)(encodingBinaryId);
701
- }
702
- function getEncodingBinaryId(schema) {
703
- const className = schema.name;
704
- const encodingBinaryId = node_opcua_constants_1.ObjectIds[className + "_Encoding_DefaultBinary"];
705
- return (0, node_opcua_nodeid_1.coerceNodeId)(encodingBinaryId);
706
- }
707
- function getEncodingXmlId(schema) {
708
- const className = schema.name;
709
- const encodingXmlId = node_opcua_constants_1.ObjectIds[className + "_Encoding_DefaultXml"];
710
- return (0, node_opcua_nodeid_1.coerceNodeId)(encodingXmlId);
711
- }
712
- function getEncodingJsonId(schema) {
713
- const className = schema.name;
714
- const encodingXmlId = node_opcua_constants_1.ObjectIds[className + "_Encoding_DefaultJson"];
715
- return (0, node_opcua_nodeid_1.coerceNodeId)(encodingXmlId);
716
- }
717
- /* eslint complexity:[0,50], max-statements: [1, 254]*/
718
- function produce_TScript_code(schema, localSchemaFile, generatedTypescriptFilename) {
719
- const className = schema.name;
720
- generatedObjectSchema[className] = generatedTypescriptFilename;
721
- schema.baseType = schema.baseType || "BaseUAObject";
722
- const baseClass = schema.baseType;
723
- (0, node_opcua_factory_1.check_schema_correctness)(schema);
724
- const f = new index_1.LineFile1();
725
- const write = (0, write_func_1.makeWrite)(f);
726
- const complexTypes = schema.fields.filter((field) => field.category === node_opcua_factory_1.FieldCategory.complex && field.fieldType !== schema.name);
727
- const folderForSourceFile = path.dirname(generatedTypescriptFilename);
728
- // -------------------------------------------------------------------------
729
- // - insert common requires
730
- // -------------------------------------------------------------------------
731
- write("/**");
732
- write(" * @module node-opcua-address-space.types");
733
- write(" */");
734
- write("/* istanbul ignore file */\n");
735
- write('import { assert } from "node-opcua-assert";');
736
- write('import * as util from "util";');
737
- write('import { makeNodeId, makeExpandedNodeId } from "node-opcua-nodeid";');
738
- write(`import {`);
739
- write(` parameters,`);
740
- write(` check_options_correctness_against_schema,`);
741
- write(` resolve_schema_field_types,`);
742
- write(` initialize_field,`);
743
- write(` initialize_field_array,`);
744
- write(` generate_new_id,`);
745
- write(` getBuildInType,`);
746
- write(` registerClassDefinition,`);
747
- write(` getStructuredTypeSchema,`);
748
- write(` BaseUAObject,`);
749
- write(` getEnumeration`);
750
- write(` } from "node-opcua-factory";`);
751
- write('import { encodeArray, decodeArray } from "node-opcua-basic-types";');
752
- // xx write('import { BaseUAObject } from "node-opcua-factory";');
753
- write("/* tslint:disable:no-this-assignment */");
754
- write("/* tslint:disable:max-classes-per-file */");
755
- const schemaObjName = schema.name + "_Schema";
756
- write(`import { ${schemaObjName} } from "${localSchemaFile}";`);
757
- write("const schema = " + schemaObjName + ";");
758
- // -------------------------------------------------------------------------
759
- // - insert definition of complex type used by this class
760
- // -------------------------------------------------------------------------
761
- const tmpMap = {};
762
- for (const field of complexTypes) {
763
- if (Object.prototype.hasOwnProperty.call(tmpMap, field.fieldType)) {
764
- continue;
765
- }
766
- tmpMap[field.fieldType] = 1;
767
- const filename = get_class_TScript_filename_local(field.fieldType);
768
- const localFilename = (0, index_1.normalize_require_file)(folderForSourceFile, filename);
769
- if (fs.existsSync(filename)) {
770
- // xx write("const " + field.fieldType + ' = require("' + local_filename + '").' + field.fieldType + ";");
771
- write(`import { ${field.fieldType} } from "${localFilename}";`);
772
- }
773
- else {
774
- write(`import { ${field.fieldType} } from "../source/imports";`);
775
- }
776
- }
777
- // -------------------------------------------------------------------------
778
- // - insert definition of base class
779
- // -------------------------------------------------------------------------
780
- if (baseClass !== "BaseUAObject") {
781
- const filename = get_class_TScript_filename_local(baseClass);
782
- const localFilename = (0, index_1.normalize_require_file)(folderForSourceFile, filename);
783
- // xx console.log(" ===> filename", filename, localFilename, fs.existsSync(filename));
784
- if (fs.existsSync(filename)) {
785
- (0, node_opcua_assert_1.assert)(!localFilename.match(/\\/));
786
- write("import { " + baseClass + ' } from "' + localFilename + '";');
787
- }
788
- else {
789
- write("const " + baseClass + ' = getStructureTypeConstructor("' + baseClass + '");');
790
- }
791
- }
792
- write_expose_encoder_decoder(write, schema);
793
- writeStructuredType(write, schema);
794
- f.saveFormat(generatedTypescriptFilename, (code) => {
795
- return code;
796
- /*
797
- const options: prettier.Options = {
798
- bracketSpacing: true,
799
- insertPragma: true,
800
- parser: "typescript",
801
- printWidth: 120
802
- };
803
- return prettier.format(code, options);
804
- */
805
- });
806
- }
807
- exports.produce_TScript_code = produce_TScript_code;
1
+ "use strict";
2
+ /* istanbul ignore file */
3
+ /**
4
+ * @module node-opcua-generator
5
+ */
6
+ Object.defineProperty(exports, "__esModule", { value: true });
7
+ exports.produce_TScript_code = exports.writeStructuredType = exports.get_class_JScript_filename = exports.get_class_TScript_filename = void 0;
8
+ // tslint:disable:max-line-length
9
+ // tslint:disable:max-depth
10
+ const os = require("os");
11
+ const path = require("path");
12
+ const fs = require("fs");
13
+ const node_opcua_assert_1 = require("node-opcua-assert");
14
+ const node_opcua_factory_1 = require("node-opcua-factory");
15
+ const node_opcua_constants_1 = require("node-opcua-constants");
16
+ const node_opcua_debug_1 = require("node-opcua-debug");
17
+ const node_opcua_nodeid_1 = require("node-opcua-nodeid");
18
+ const node_opcua_utils_1 = require("node-opcua-utils");
19
+ const write_func_1 = require("./utils/write_func");
20
+ const index_1 = require("./utils/index");
21
+ const produceComment = false;
22
+ const debugLog = (0, node_opcua_debug_1.make_debugLog)(__filename);
23
+ const generatedObjectSchema = {};
24
+ function quotify(str) {
25
+ return '"' + str + '"';
26
+ }
27
+ function makeFieldType(field) {
28
+ return "{" + field.fieldType + (field.isArray ? "[" : "") + (field.isArray ? "]" : "") + "}";
29
+ }
30
+ function convertToJavascriptCode(obj) {
31
+ const lines = [];
32
+ if (typeof obj === "object" && !(obj instanceof Array)) {
33
+ lines.push("{");
34
+ for (const prop of Object.keys(obj)) {
35
+ lines.push(prop, ": ", convertToJavascriptCode(obj[prop]), ",");
36
+ }
37
+ lines.push("}");
38
+ }
39
+ else if (obj instanceof Array) {
40
+ lines.push("[");
41
+ for (const prop of obj) {
42
+ lines.push(convertToJavascriptCode(prop), ",");
43
+ }
44
+ lines.push("]");
45
+ // tslint:disable:no-empty
46
+ }
47
+ else if (typeof obj === "function") {
48
+ /** */
49
+ }
50
+ else {
51
+ lines.push(JSON.stringify(obj));
52
+ }
53
+ return lines.join("");
54
+ }
55
+ function get_class_folder(schemaName, optionalFolder) {
56
+ let folder;
57
+ if (optionalFolder) {
58
+ if (!fs.existsSync(optionalFolder)) {
59
+ fs.mkdirSync(optionalFolder);
60
+ if (!fs.existsSync(optionalFolder)) {
61
+ throw new Error("get_class_TScript_filename: Cannot find folder " + optionalFolder);
62
+ }
63
+ }
64
+ folder = optionalFolder;
65
+ }
66
+ else {
67
+ folder = exports.folder_for_generated_file;
68
+ throw new Error("get_class_javascript_filename : DEPRECATED ");
69
+ }
70
+ return folder;
71
+ }
72
+ function get_class_TScript_filename(schemaName, optionalFolder) {
73
+ const folder = get_class_folder(schemaName, optionalFolder);
74
+ return path.join(folder, "_" + schemaName + ".ts");
75
+ }
76
+ exports.get_class_TScript_filename = get_class_TScript_filename;
77
+ function get_class_JScript_filename(schemaName, optionalFolder) {
78
+ const folder = get_class_folder(schemaName, optionalFolder);
79
+ return path.join(folder, "_" + schemaName + ".js");
80
+ }
81
+ exports.get_class_JScript_filename = get_class_JScript_filename;
82
+ function get_class_TScript_filename_local(schemaName) {
83
+ let schema = (0, node_opcua_factory_1.getStructuredTypeSchema)(schemaName);
84
+ if (!schema) {
85
+ schema = generatedObjectSchema[schemaName];
86
+ if (!schema) {
87
+ throw new Error("cannot find script file for " + schemaName);
88
+ }
89
+ return "./_" + schemaName;
90
+ }
91
+ let generateTypeScriptSource = "/* fix me schema.prototype.schema.generate_ts_source*/";
92
+ if (!generateTypeScriptSource) {
93
+ const folder = "."; // exports.folder_for_generated_file;
94
+ generateTypeScriptSource = path.join(folder, "_" + schemaName + ".ts");
95
+ }
96
+ return generateTypeScriptSource;
97
+ }
98
+ function write_enumeration_setter(write, schema, field, member) {
99
+ const capMember = (0, node_opcua_utils_1.capitalizeFirstLetter)(member);
100
+ write(` public set${capMember}(value: any): ${field.fieldType} {`);
101
+ write(` const coercedValue = _enumeration${field.fieldType}.get(value);`);
102
+ write(` /* istanbul ignore next */`);
103
+ write(` if (coercedValue === undefined || coercedValue === null) {`);
104
+ write(` throw new Error("value cannot be coerced to ${field.fieldType} :" + value);`);
105
+ write(` }`);
106
+ write(` this.${member} = coercedValue.value as ${field.fieldType};`);
107
+ write(` return this.${member};`);
108
+ write(` }`);
109
+ }
110
+ function write_enumeration_fast_init(write, schema, field, member, i) {
111
+ write(` this.${member} = 0 as ${field.fieldType};`);
112
+ }
113
+ function write_enumeration(write, schema, field, member, i) {
114
+ (0, node_opcua_assert_1.assert)(!field.isArray); // would not work in this case
115
+ const capMember = (0, node_opcua_utils_1.capitalizeFirstLetter)(member);
116
+ write(` this.${field.name} = this.set${capMember}(initialize_field(schema.fields[${i}], options?.${field.name}));`);
117
+ }
118
+ function write_complex_fast_init(write, schema, field, member) {
119
+ if (field.isArray) {
120
+ write(` this.${member} = null; /* null array */`);
121
+ }
122
+ else {
123
+ write(` this.${member} = new ${field.fieldType}(null);`);
124
+ }
125
+ }
126
+ function write_complex(write, schema, field, member /*, i*/) {
127
+ if (field.isArray) {
128
+ if (Object.prototype.hasOwnProperty.call(field, "defaultValue")) {
129
+ // todo: fix me => should call field defaultValue in the live version
130
+ write(` this.${member} = []; // should default`);
131
+ }
132
+ else {
133
+ write(` this.${member} = [];`);
134
+ }
135
+ write(` if (options.${member}) {`);
136
+ write(` assert(Array.isArray(options.${member}));`);
137
+ write(` this.${member} = options.${member}.map((e: any) => new ${field.fieldType}(e));`);
138
+ // write(` self.${member} = options.${member}.map(function(e){ return construct${field.fieldType}(e); } );`);
139
+ write(" }");
140
+ }
141
+ else {
142
+ if (field.defaultValue === null || field.fieldType === schema.name) {
143
+ write(` this.${member} = (options.${member}) ? new ${field.fieldType}( options.${member}) : null;`);
144
+ // xx write(` self.${member} = (options.${member}) ? construct${field.fieldType}( options.${member}) : null;`);
145
+ }
146
+ else {
147
+ write(` this.${member} = new ${field.fieldType}(options.${member});`);
148
+ // xx write(` self.${member} = construct${field.fieldType}(options.${member});`);
149
+ }
150
+ }
151
+ }
152
+ function write_basic(write, schema, field, member, i) {
153
+ (0, node_opcua_assert_1.assert)(field.category === node_opcua_factory_1.FieldCategory.basic);
154
+ if (field.isArray) {
155
+ // write(`this.${member} = [];`);
156
+ // write(`if (options.${member}) {`);
157
+ // write(` assert(Array.isArray(options.${member}));`);
158
+ // write(` this.${member} = options.browsePath.map(e => field.coerce(e) );`);
159
+ // write(`}`);
160
+ write(` this.${member} = initialize_field_array(schema.fields[${i}], options?.${field.name});`);
161
+ }
162
+ else {
163
+ write(` this.${member} = initialize_field(schema.fields[${i}], options?.${field.name});`);
164
+ }
165
+ }
166
+ function write_basic_fast_init(write, schema, field, member, i) {
167
+ if (field.isArray) {
168
+ // write(`this.${member} = [];`);
169
+ // write(`if (options.${member}) {`);
170
+ // write(` assert(Array.isArray(options.${member}));`);
171
+ // write(` this.${member} = options.browsePath.map(e => field.coerce(e) );`);
172
+ // write(`}`);
173
+ write(` this.${member} = []`);
174
+ }
175
+ else {
176
+ switch (field.schema.name) {
177
+ case "Variant":
178
+ write(` this.${member} = new Variant(null);`);
179
+ break;
180
+ case "UABoolean":
181
+ case "Boolean":
182
+ write(` this.${member} = false;`);
183
+ break;
184
+ case "UAString":
185
+ write(` this.${member} = null;`);
186
+ break;
187
+ case "ExpandedNodeId":
188
+ write(` this.${member} = new ExpandedNodeId(null);`);
189
+ break;
190
+ case "NodeId":
191
+ write(` this.${member} = new NodeId(null);`);
192
+ break;
193
+ case "QualifiedName":
194
+ write(` this.${member} = new QualifiedName(null);`);
195
+ break;
196
+ case "DateTime":
197
+ write(` this.${member} = new Date();`);
198
+ break;
199
+ case "ByteString":
200
+ write(` this.${member} = Buffer.alloc(0);`);
201
+ break;
202
+ case "StatusCode":
203
+ write(` this.${member} = StatusCodes.Good;`);
204
+ break;
205
+ case "DiagnosticInfo":
206
+ case "ExtensionObject":
207
+ write(` this.${member} = null;`);
208
+ break;
209
+ case "NumericRange":
210
+ write(` this.${member} = new NumericRange(null);`);
211
+ break;
212
+ case "LocalizedText":
213
+ write(` this.${member} = new LocalizedText(null);`);
214
+ break;
215
+ case "Guid":
216
+ write(` this.${member} = "";`);
217
+ break;
218
+ case "UInt64":
219
+ write(` this.${member} = [];`);
220
+ break;
221
+ case "Int64":
222
+ write(` this.${member} = [];`);
223
+ break;
224
+ case "DataValue":
225
+ write(` this.${member} = new DataValue(null);`);
226
+ break;
227
+ default:
228
+ write(` this.${member} = 0;`);
229
+ }
230
+ }
231
+ }
232
+ function write_fast_init_member(write, schema, field, i) {
233
+ const member = field.name;
234
+ switch (field.category) {
235
+ case node_opcua_factory_1.FieldCategory.enumeration:
236
+ write_enumeration_fast_init(write, schema, field, member, i);
237
+ break;
238
+ case node_opcua_factory_1.FieldCategory.basic:
239
+ write_basic_fast_init(write, schema, field, member, i);
240
+ break;
241
+ case node_opcua_factory_1.FieldCategory.complex:
242
+ write_complex_fast_init(write, schema, field, member);
243
+ break;
244
+ }
245
+ }
246
+ function write_constructor(write, schema) {
247
+ const baseClass = schema.baseType;
248
+ const className = schema.name;
249
+ write("");
250
+ const n = schema.fields.length;
251
+ if (produceComment) {
252
+ write(" /**");
253
+ if (schema.documentation && schema.documentation.length > 0) {
254
+ write(" * " + schema.documentation);
255
+ }
256
+ let def = "";
257
+ for (let i = 0; i < n; i++) {
258
+ const field = schema.fields[i];
259
+ const fieldType = field.fieldType;
260
+ const documentation = field.documentation ? field.documentation : "";
261
+ def = "";
262
+ if (field.defaultValue !== undefined) {
263
+ if (typeof field.defaultValue === "function") {
264
+ def = " = " + field.defaultValue();
265
+ }
266
+ else {
267
+ def = " = " + field.defaultValue;
268
+ }
269
+ }
270
+ const ft = makeFieldType(field);
271
+ // xx write(" * @param [options." + field.name + def + "] " + ft + " " + documentation);
272
+ }
273
+ write(" */");
274
+ }
275
+ write(` constructor(options?: ${className}Options | null) {`);
276
+ write("");
277
+ if (baseClass) {
278
+ if (baseClass === "BaseUAObject") {
279
+ write(" super();");
280
+ }
281
+ else {
282
+ write(" super(options);");
283
+ }
284
+ write("");
285
+ }
286
+ // detect de-serialization constructor
287
+ // -----------------------------------------------------------------------------------------------------------------
288
+ // Special case when options === null => fast constructor for de-serialization
289
+ // -----------------------------------------------------------------------------------------------------------------
290
+ write(` if (options === null) {`);
291
+ for (let i = 0; i < n; i++) {
292
+ const field = schema.fields[i];
293
+ write_fast_init_member(write, schema, field, i);
294
+ }
295
+ write(" return;");
296
+ write(" }");
297
+ write(` const schema = ${className}.schema;`);
298
+ if (typeof schema.constructHook === "function") {
299
+ write(` options = schema.constructHook(options) as ${className}Options;`);
300
+ }
301
+ else {
302
+ write(` options = (schema.constructHook ? schema.constructHook(options) as ${className}Options: options ) || {};`);
303
+ }
304
+ // write(" if (options === undefined) { options = {}; }");
305
+ write(" /* istanbul ignore next */");
306
+ write(" if (parameters.debugSchemaHelper) {");
307
+ write(" check_options_correctness_against_schema(this, schema, options);");
308
+ write(" }");
309
+ // -----------------------------------------------------------------------------------------------------------------
310
+ for (let i = 0; i < n; i++) {
311
+ const field = schema.fields[i];
312
+ const member = field.name;
313
+ if (produceComment) {
314
+ write("");
315
+ write(" /**");
316
+ const documentation = field.documentation ? field.documentation : "";
317
+ if (documentation && documentation.length > 0) {
318
+ write(" * ", documentation);
319
+ }
320
+ if (produceComment) {
321
+ write(" * @property ", field.name);
322
+ // write(" * @type {", (field.isArray ? "Array[" : "") + field.fieldType + (field.isArray ? " ]" : "")+"}");
323
+ write(" * @type " + makeFieldType(field));
324
+ }
325
+ if (field.defaultValue !== undefined && typeof field.defaultValue !== "function") {
326
+ write(" * @default ", field.defaultValue);
327
+ }
328
+ write(" */");
329
+ }
330
+ switch (field.category) {
331
+ case node_opcua_factory_1.FieldCategory.enumeration:
332
+ write_enumeration(write, schema, field, member, i);
333
+ break;
334
+ case node_opcua_factory_1.FieldCategory.complex:
335
+ write_complex(write, schema, field, member);
336
+ break;
337
+ default:
338
+ write_basic(write, schema, field, member, i);
339
+ break;
340
+ }
341
+ }
342
+ write(" }");
343
+ }
344
+ function write_possible_fields(write, className, possibleFields) {
345
+ write(" public static possibleFields: string[] = [");
346
+ write(" " + possibleFields.map(quotify).join("," + os.EOL + " "));
347
+ write(" ];");
348
+ }
349
+ function write_isValid(write, schema) {
350
+ // ---------------------------------------
351
+ if (typeof schema.isValid === "function") {
352
+ if (produceComment) {
353
+ write(" /**");
354
+ write(" *");
355
+ write(" * verify that all object attributes values are valid according to schema");
356
+ write(" * @method isValid");
357
+ write(" * @return {Boolean}");
358
+ write(" */");
359
+ }
360
+ write(" isValid(): boolean { return schema.isValid(this); };");
361
+ }
362
+ }
363
+ function write_encode(write, schema) {
364
+ if (typeof schema.encode === "function") {
365
+ write(" public encode(stream: OutputBinaryStream): void {");
366
+ write(" " + "schema" + ".encode(this, stream);");
367
+ write(" }");
368
+ }
369
+ else {
370
+ if (produceComment) {
371
+ write(" /**");
372
+ write(" * encode the object into a binary stream");
373
+ write(" * @method encode");
374
+ write(" *");
375
+ write(" * @param stream {BinaryStream}");
376
+ write(" */");
377
+ }
378
+ write(" public encode(stream: OutputBinaryStream): void {");
379
+ write(" /* NEEDED */ super.encode(stream);");
380
+ const n = schema.fields.length;
381
+ for (let i = 0; i < n; i++) {
382
+ const field = schema.fields[i];
383
+ const member = field.name;
384
+ switch (field.category) {
385
+ case node_opcua_factory_1.FieldCategory.enumeration:
386
+ case node_opcua_factory_1.FieldCategory.basic:
387
+ if (field.isArray) {
388
+ write(` encodeArray(this.${member}, stream, encode${field.fieldType});`);
389
+ }
390
+ else {
391
+ write(` encode${field.fieldType}(this.${member}, stream);`);
392
+ }
393
+ break;
394
+ case node_opcua_factory_1.FieldCategory.complex:
395
+ if (field.isArray) {
396
+ write(` encodeArray(this.${member}, stream, (obj, stream1) => { obj.encode(stream1); });`);
397
+ }
398
+ else {
399
+ write(` this.${member}.encode(stream);`);
400
+ }
401
+ break;
402
+ }
403
+ }
404
+ write(" }");
405
+ }
406
+ }
407
+ function write_decode(write, schema) {
408
+ // --------------------------------------------------------------
409
+ // implement decode
410
+ function write_field(field, member, i) {
411
+ if (field.category === node_opcua_factory_1.FieldCategory.enumeration || field.category === node_opcua_factory_1.FieldCategory.basic) {
412
+ if (field.isArray) {
413
+ write(" this." + member + " = decodeArray(stream, decode" + field.fieldType + ");");
414
+ }
415
+ else {
416
+ if (false) {
417
+ write(" this." + member + ".decode(stream);");
418
+ }
419
+ else {
420
+ if (typeof field.decode === "function") {
421
+ write(" this." + member + " = " + "schema" + ".fields[" + i + "].decode(stream);");
422
+ }
423
+ else {
424
+ write(" this." + member + " = decode" + field.fieldType + "(stream, this." + member + ");");
425
+ }
426
+ }
427
+ }
428
+ }
429
+ else {
430
+ (0, node_opcua_assert_1.assert)(field.category === node_opcua_factory_1.FieldCategory.complex);
431
+ if (field.isArray) {
432
+ write(" this." + member + " = decodeArray(stream, (stream1: BinaryStream) => {");
433
+ write(" const obj = new " + field.fieldType + "(null);");
434
+ write(" obj.decode(stream1);");
435
+ write(" return obj;");
436
+ write(" });");
437
+ }
438
+ else {
439
+ write(" this." + member + ".decode(stream);");
440
+ // xx write(" this." + member + ".decode(stream);");
441
+ }
442
+ }
443
+ }
444
+ // ---------------------------------------------------------------
445
+ if (typeof schema.decode === "function") {
446
+ if (produceComment) {
447
+ write(" /**");
448
+ write(" * decode the object from a binary stream");
449
+ write(" * @method decode");
450
+ write(" *");
451
+ write(" * @param stream {BinaryStream}");
452
+ write(" */");
453
+ }
454
+ write(" public decode(stream: BinaryStream): void {");
455
+ write(" " + "schema" + ".decode(this,stream);");
456
+ write(" }");
457
+ if (typeof schema.decodeDebug !== "function") {
458
+ throw new Error("schema decode requires also to provide a decodeDebug " + schema.name);
459
+ }
460
+ write(" public decodeDebug(stream: BinaryStream, options: any): void {");
461
+ write(" " + "schema" + ".decodeDebug(this,stream,options);");
462
+ write(" }");
463
+ }
464
+ else {
465
+ if (produceComment) {
466
+ write(" /**");
467
+ write(" * decode the object from a binary stream");
468
+ write(" * @method decode");
469
+ write(" *");
470
+ write(" * @param stream {BinaryStream}");
471
+ write(" */");
472
+ }
473
+ write(" public decode(stream: BinaryStream): void {");
474
+ write(" // call base class implementation first");
475
+ write(" /* NEEDED !!! */ super.decode(stream);");
476
+ const n = schema.fields.length;
477
+ for (let i = 0; i < n; i++) {
478
+ const field = schema.fields[i];
479
+ const fieldType = field.fieldType;
480
+ const member = field.name;
481
+ write_field(field, member, i);
482
+ }
483
+ write(" }");
484
+ }
485
+ }
486
+ function hasEnumeration(schema) {
487
+ for (const field of schema.fields) {
488
+ if (field.category === node_opcua_factory_1.FieldCategory.enumeration) {
489
+ return true;
490
+ }
491
+ }
492
+ return false;
493
+ }
494
+ function hasComplex(schema) {
495
+ for (const field of schema.fields) {
496
+ if (field.category === node_opcua_factory_1.FieldCategory.complex) {
497
+ return true;
498
+ }
499
+ }
500
+ return false;
501
+ }
502
+ function write_class_constructor_options(write, schema) {
503
+ const n = schema.fields.length;
504
+ for (let i = 0; i < n; i++) {
505
+ const field = schema.fields[i];
506
+ const member = field.name;
507
+ const arrayOpt = field.isArray ? "[] | null" : "";
508
+ switch (field.category) {
509
+ case node_opcua_factory_1.FieldCategory.enumeration: {
510
+ write(` ${member}?: ${field.fieldType}${arrayOpt};`);
511
+ break;
512
+ }
513
+ case node_opcua_factory_1.FieldCategory.basic: {
514
+ if (field.fieldType === "ExtensionObject") {
515
+ write(` ${member}?: (${field.fieldType} | null)${arrayOpt};`);
516
+ }
517
+ else if (field.fieldType === "DiagnosticInfo") {
518
+ write(` ${member}?: (${field.fieldType} | null)${arrayOpt};`);
519
+ }
520
+ else if (field.fieldType === "Variant" ||
521
+ field.fieldType === "DataValue" ||
522
+ field.fieldType === "NodeId" ||
523
+ field.fieldType === "QualifiedName" ||
524
+ field.fieldType === "LocalizedText") {
525
+ write(` ${member}?: (${field.fieldType}Like | null)${arrayOpt};`);
526
+ }
527
+ else {
528
+ write(` ${member}?: ${field.fieldType} ${arrayOpt};`);
529
+ }
530
+ break;
531
+ }
532
+ case node_opcua_factory_1.FieldCategory.complex: {
533
+ write(` ${member}?: ${field.fieldType}Options ${arrayOpt};`);
534
+ break;
535
+ }
536
+ }
537
+ }
538
+ }
539
+ function write_declare_class_member(write, schema) {
540
+ const n = schema.fields.length;
541
+ for (let i = 0; i < n; i++) {
542
+ const field = schema.fields[i];
543
+ const member = field.name;
544
+ const arrayOpt = field.isArray ? "[] | null" : "";
545
+ switch (field.category) {
546
+ case node_opcua_factory_1.FieldCategory.enumeration: {
547
+ write(` public ${member}: ${field.fieldType}${arrayOpt};`);
548
+ break;
549
+ }
550
+ case node_opcua_factory_1.FieldCategory.basic: {
551
+ if (field.fieldType === "DiagnosticInfo") {
552
+ write(` public ${member}: (${field.fieldType} | null)${arrayOpt};`);
553
+ }
554
+ else if (field.fieldType === "ExtensionObject") {
555
+ write(` public ${member}: (${field.fieldType} | null)${arrayOpt};`);
556
+ }
557
+ else {
558
+ write(` public ${member}: ${field.fieldType}${arrayOpt};`);
559
+ }
560
+ break;
561
+ }
562
+ case node_opcua_factory_1.FieldCategory.complex: {
563
+ write(` public ${member}: ${field.fieldType}${arrayOpt};`);
564
+ break;
565
+ }
566
+ }
567
+ }
568
+ }
569
+ function write_enumerations(write, schema) {
570
+ if (!hasEnumeration(schema)) {
571
+ return;
572
+ }
573
+ write("");
574
+ write(" // Define Enumeration setters");
575
+ const n = schema.fields.length;
576
+ for (let i = 0; i < n; i++) {
577
+ const field = schema.fields[i];
578
+ const member = field.name;
579
+ if (field.category === node_opcua_factory_1.FieldCategory.enumeration) {
580
+ write_enumeration_setter(write, schema, field, member);
581
+ }
582
+ }
583
+ }
584
+ function write_expose_encoder_decoder(write, schema) {
585
+ write("");
586
+ write('import { BinaryStream, OutputBinaryStream } from "node-opcua-binary-stream";');
587
+ write('import { ExpandedNodeId, NodeId } from "node-opcua-nodeid";');
588
+ const n = schema.fields.length;
589
+ const done = {};
590
+ for (let i = 0; i < n; i++) {
591
+ const field = schema.fields[i];
592
+ const fieldType = field.fieldType;
593
+ if (!(fieldType in done)) {
594
+ done[fieldType] = field;
595
+ switch (field.category) {
596
+ case node_opcua_factory_1.FieldCategory.basic:
597
+ break;
598
+ case node_opcua_factory_1.FieldCategory.enumeration:
599
+ write("const _enumeration" + field.fieldType + " = " + 'getEnumeration("' + field.fieldType + '");');
600
+ write("const encode" +
601
+ field.fieldType +
602
+ ': (value: any, stream: OutputBinaryStream) => void = getEnumeration("' +
603
+ field.fieldType +
604
+ '").encode;');
605
+ write("const decode" +
606
+ field.fieldType +
607
+ ': (stream: BinaryStream) => void = getEnumeration("' +
608
+ field.fieldType +
609
+ '").decode;');
610
+ break;
611
+ case node_opcua_factory_1.FieldCategory.complex:
612
+ write("const encode" +
613
+ field.fieldType +
614
+ ': (value: any, stream: OutputBinaryStream) => void = getBuildInType("' +
615
+ field.fieldType +
616
+ '").encode;');
617
+ write("const decode" +
618
+ field.fieldType +
619
+ ': (stream: BinaryStream) => void = getBuildInType("' +
620
+ field.fieldType +
621
+ '").decode;');
622
+ break;
623
+ }
624
+ }
625
+ }
626
+ }
627
+ function writeStructuredType(write, schema) {
628
+ const className = schema.name;
629
+ const baseClass = schema.baseType;
630
+ const dataTypeNodeId = getDataTypeNodeId(schema);
631
+ const encodingBinaryNodeId = getEncodingBinaryId(schema);
632
+ const encodingXmlNodeId = getEncodingXmlId(schema);
633
+ const encodingJsonNodeId = getEncodingJsonId(schema);
634
+ const needRegistration = encodingBinaryNodeId.value !== 0;
635
+ // ----------------------------------------------- Options
636
+ if (baseClass === "BaseUAObject" || baseClass === "ExtensionObject" || baseClass === "DataTypeDefinition") {
637
+ write(`export interface ${className}Options {`);
638
+ }
639
+ else {
640
+ write(`export interface ${className}Options extends ${baseClass}Options {`);
641
+ }
642
+ {
643
+ write_class_constructor_options(write, schema);
644
+ }
645
+ write(`}`);
646
+ write(`export class ${className} extends ${baseClass} {`);
647
+ {
648
+ write(` public static get schema(): StructuredTypeSchema { return schema${className}; }`);
649
+ const possibleFields = (0, node_opcua_factory_1.extract_all_fields)(schema);
650
+ write_possible_fields(write, className, possibleFields);
651
+ // -------------------------------------------------------------------------
652
+ // - encodingDefaultBinary
653
+ // -------------------------------------------------------------------------
654
+ write(` public static dataTypeNodeId = makeExpandedNodeId(${dataTypeNodeId.value}, ${dataTypeNodeId.namespace});`);
655
+ if (encodingBinaryNodeId) {
656
+ write(` public static encodingDefaultBinary = makeExpandedNodeId(${encodingBinaryNodeId.value}, ${encodingBinaryNodeId.namespace});`);
657
+ }
658
+ if (encodingXmlNodeId) {
659
+ write(` public static encodingDefaultXml = makeExpandedNodeId(${encodingXmlNodeId.value}, ${encodingXmlNodeId.namespace});`);
660
+ }
661
+ else {
662
+ write(" public static encodingDefaultXml = null;");
663
+ }
664
+ if (encodingJsonNodeId) {
665
+ write(` public static encodingDefaultJson = makeExpandedNodeId(${encodingJsonNodeId.value}, ${encodingJsonNodeId.namespace});`);
666
+ }
667
+ else {
668
+ write(" public static encodingDefaultJson = null;");
669
+ }
670
+ // xx write(` static schema = schema${className};`);
671
+ write_declare_class_member(write, schema);
672
+ write_constructor(write, schema);
673
+ write_encode(write, schema);
674
+ write_decode(write, schema);
675
+ write_enumerations(write, schema);
676
+ write_isValid(write, schema);
677
+ write(` public get schema(): StructuredTypeSchema { return schema${className}; }`);
678
+ }
679
+ write("}");
680
+ if (dataTypeNodeId) {
681
+ write(`${className}.schema.dataTypeNodeId = ${className}.dataTypeNodeId;`);
682
+ }
683
+ if (encodingBinaryNodeId) {
684
+ write(`${className}.schema.encodingDefaultBinary = ${className}.encodingDefaultBinary;`);
685
+ }
686
+ if (encodingXmlNodeId) {
687
+ write(`${className}.schema.encodingDefaultXml = ${className}.encodingDefaultXml;`);
688
+ }
689
+ if (encodingJsonNodeId) {
690
+ write(`${className}.schema.encodingDefaultJson = ${className}.encodingDefaultJson;`);
691
+ }
692
+ if (needRegistration) {
693
+ write(`registerClassDefinition( ${className}.dataTypeNodeId, "${className}", ${className});`);
694
+ }
695
+ }
696
+ exports.writeStructuredType = writeStructuredType;
697
+ function getDataTypeNodeId(schema) {
698
+ const className = schema.name;
699
+ const encodingBinaryId = node_opcua_constants_1.DataTypeIds[className];
700
+ return (0, node_opcua_nodeid_1.coerceNodeId)(encodingBinaryId);
701
+ }
702
+ function getEncodingBinaryId(schema) {
703
+ const className = schema.name;
704
+ const encodingBinaryId = node_opcua_constants_1.ObjectIds[className + "_Encoding_DefaultBinary"];
705
+ return (0, node_opcua_nodeid_1.coerceNodeId)(encodingBinaryId);
706
+ }
707
+ function getEncodingXmlId(schema) {
708
+ const className = schema.name;
709
+ const encodingXmlId = node_opcua_constants_1.ObjectIds[className + "_Encoding_DefaultXml"];
710
+ return (0, node_opcua_nodeid_1.coerceNodeId)(encodingXmlId);
711
+ }
712
+ function getEncodingJsonId(schema) {
713
+ const className = schema.name;
714
+ const encodingXmlId = node_opcua_constants_1.ObjectIds[className + "_Encoding_DefaultJson"];
715
+ return (0, node_opcua_nodeid_1.coerceNodeId)(encodingXmlId);
716
+ }
717
+ /* eslint complexity:[0,50], max-statements: [1, 254]*/
718
+ function produce_TScript_code(schema, localSchemaFile, generatedTypescriptFilename) {
719
+ const className = schema.name;
720
+ generatedObjectSchema[className] = generatedTypescriptFilename;
721
+ schema.baseType = schema.baseType || "BaseUAObject";
722
+ const baseClass = schema.baseType;
723
+ (0, node_opcua_factory_1.check_schema_correctness)(schema);
724
+ const f = new index_1.LineFile1();
725
+ const write = (0, write_func_1.makeWrite)(f);
726
+ const complexTypes = schema.fields.filter((field) => field.category === node_opcua_factory_1.FieldCategory.complex && field.fieldType !== schema.name);
727
+ const folderForSourceFile = path.dirname(generatedTypescriptFilename);
728
+ // -------------------------------------------------------------------------
729
+ // - insert common requires
730
+ // -------------------------------------------------------------------------
731
+ write("/**");
732
+ write(" * @module node-opcua-address-space.types");
733
+ write(" */");
734
+ write("/* istanbul ignore file */\n");
735
+ write('import { assert } from "node-opcua-assert";');
736
+ write('import * as util from "util";');
737
+ write('import { makeNodeId, makeExpandedNodeId } from "node-opcua-nodeid";');
738
+ write(`import {`);
739
+ write(` parameters,`);
740
+ write(` check_options_correctness_against_schema,`);
741
+ write(` resolve_schema_field_types,`);
742
+ write(` initialize_field,`);
743
+ write(` initialize_field_array,`);
744
+ write(` generate_new_id,`);
745
+ write(` getBuildInType,`);
746
+ write(` registerClassDefinition,`);
747
+ write(` getStructuredTypeSchema,`);
748
+ write(` BaseUAObject,`);
749
+ write(` getEnumeration`);
750
+ write(` } from "node-opcua-factory";`);
751
+ write('import { encodeArray, decodeArray } from "node-opcua-basic-types";');
752
+ // xx write('import { BaseUAObject } from "node-opcua-factory";');
753
+ write("/* tslint:disable:no-this-assignment */");
754
+ write("/* tslint:disable:max-classes-per-file */");
755
+ const schemaObjName = schema.name + "_Schema";
756
+ write(`import { ${schemaObjName} } from "${localSchemaFile}";`);
757
+ write("const schema = " + schemaObjName + ";");
758
+ // -------------------------------------------------------------------------
759
+ // - insert definition of complex type used by this class
760
+ // -------------------------------------------------------------------------
761
+ const tmpMap = {};
762
+ for (const field of complexTypes) {
763
+ if (Object.prototype.hasOwnProperty.call(tmpMap, field.fieldType)) {
764
+ continue;
765
+ }
766
+ tmpMap[field.fieldType] = 1;
767
+ const filename = get_class_TScript_filename_local(field.fieldType);
768
+ const localFilename = (0, index_1.normalize_require_file)(folderForSourceFile, filename);
769
+ if (fs.existsSync(filename)) {
770
+ // xx write("const " + field.fieldType + ' = require("' + local_filename + '").' + field.fieldType + ";");
771
+ write(`import { ${field.fieldType} } from "${localFilename}";`);
772
+ }
773
+ else {
774
+ write(`import { ${field.fieldType} } from "../source/imports";`);
775
+ }
776
+ }
777
+ // -------------------------------------------------------------------------
778
+ // - insert definition of base class
779
+ // -------------------------------------------------------------------------
780
+ if (baseClass !== "BaseUAObject") {
781
+ const filename = get_class_TScript_filename_local(baseClass);
782
+ const localFilename = (0, index_1.normalize_require_file)(folderForSourceFile, filename);
783
+ // xx console.log(" ===> filename", filename, localFilename, fs.existsSync(filename));
784
+ if (fs.existsSync(filename)) {
785
+ (0, node_opcua_assert_1.assert)(!localFilename.match(/\\/));
786
+ write("import { " + baseClass + ' } from "' + localFilename + '";');
787
+ }
788
+ else {
789
+ write("const " + baseClass + ' = getStructureTypeConstructor("' + baseClass + '");');
790
+ }
791
+ }
792
+ write_expose_encoder_decoder(write, schema);
793
+ writeStructuredType(write, schema);
794
+ f.saveFormat(generatedTypescriptFilename, (code) => {
795
+ return code;
796
+ /*
797
+ const options: prettier.Options = {
798
+ bracketSpacing: true,
799
+ insertPragma: true,
800
+ parser: "typescript",
801
+ printWidth: 120
802
+ };
803
+ return prettier.format(code, options);
804
+ */
805
+ });
806
+ }
807
+ exports.produce_TScript_code = produce_TScript_code;
808
808
  //# sourceMappingURL=factory_code_generator.js.map