@girs/modulemd-2.0 2.0.0-4.0.0-rc.6 → 2.0.0-4.0.0-rc.7

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.
package/README.md CHANGED
@@ -5,7 +5,7 @@
5
5
  ![downloads/week](https://img.shields.io/npm/dw/@girs/modulemd-2.0)
6
6
 
7
7
 
8
- GJS TypeScript type definitions for Modulemd-2.0, generated from library version 2.0.0 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v4.0.0-rc.6.
8
+ GJS TypeScript type definitions for Modulemd-2.0, generated from library version 2.0.0 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v4.0.0-rc.7.
9
9
 
10
10
  ## Install
11
11
 
package/modulemd-2.0.d.ts CHANGED
@@ -446,8 +446,8 @@ export namespace Modulemd {
446
446
  */
447
447
  function read_packager_file(
448
448
  yaml_path: string,
449
- module_name?: string | null,
450
- module_stream?: string | null,
449
+ module_name: string | null,
450
+ module_stream: string | null,
451
451
  ): [GObject.GType, GObject.Object];
452
452
  /**
453
453
  * @param yaml_string A YAML string containing a packager document.
@@ -458,8 +458,8 @@ export namespace Modulemd {
458
458
  */
459
459
  function read_packager_string(
460
460
  yaml_string: string,
461
- module_name?: string | null,
462
- module_stream?: string | null,
461
+ module_name: string | null,
462
+ module_stream: string | null,
463
463
  ): [GObject.GType, GObject.Object];
464
464
  /**
465
465
  * @returns A {@link GLib.Quark} used to identify an error in the modulemd yaml domain.
@@ -662,8 +662,14 @@ export namespace Modulemd {
662
662
 
663
663
  // Properties
664
664
 
665
+ /**
666
+ * @default __BUILDOPTS_RPM_MACROS_UNSET__
667
+ */
665
668
  get rpm_macros(): string;
666
669
  set rpm_macros(val: string);
670
+ /**
671
+ * @default __BUILDOPTS_RPM_MACROS_UNSET__
672
+ */
667
673
  get rpmMacros(): string;
668
674
  set rpmMacros(val: string);
669
675
 
@@ -790,14 +796,24 @@ export namespace Modulemd {
790
796
 
791
797
  // Properties
792
798
 
799
+ /**
800
+ * @default false
801
+ */
793
802
  get buildonly(): boolean;
794
803
  set buildonly(val: boolean);
804
+ /**
805
+ * @default 0
806
+ */
795
807
  get buildorder(): number;
796
808
  set buildorder(val: bigint | number);
797
809
  /**
798
810
  * @construct-only
811
+ * @default __UNSET__
799
812
  */
800
813
  get name(): string;
814
+ /**
815
+ * @default __UNSET__
816
+ */
801
817
  get rationale(): string;
802
818
  set rationale(val: string);
803
819
 
@@ -843,7 +859,7 @@ export namespace Modulemd {
843
859
  * @param key An optional new key for the copied component which is used as the lookup key when this component is attached to a {@link Modulemd.ModuleStream}.
844
860
  * @virtual
845
861
  */
846
- vfunc_copy(key?: string | null): Component;
862
+ vfunc_copy(key: string | null): Component;
847
863
  /**
848
864
  * @param self_2 A {@link Modulemd.Component} object.
849
865
  * @virtual
@@ -857,7 +873,7 @@ export namespace Modulemd {
857
873
  * @param name The name of this component. Note that this is different from the key used to save this component to a {@link Modulemd.ModuleStream}. If this value is set, it adds a "name:" attribute to this component. This is used in bootstrapping cases where the key is a different name used to differentiate multiple ordered builds of the same component name. This function is currently only implemented for {@link Modulemd.ComponentRpm} and has no effect on other {@link Modulemd.Component} types.
858
874
  * @virtual
859
875
  */
860
- vfunc_set_name(name?: string | null): void;
876
+ vfunc_set_name(name: string | null): void;
861
877
  /**
862
878
  * Verifies that all stored values are internally consistent and that the
863
879
  * component is sufficiently-complete for emitting. This function is called
@@ -881,7 +897,7 @@ export namespace Modulemd {
881
897
  * @param key An optional new key for the copied component which is used as the lookup key when this component is attached to a {@link Modulemd.ModuleStream}.
882
898
  * @returns A newly-allocated copy of `self`.
883
899
  */
884
- copy(key?: string | null): Component;
900
+ copy(key: string | null): Component;
885
901
  /**
886
902
  * @param self_2 A {@link Modulemd.Component} object.
887
903
  * @returns TRUE, if both the objects are equal. FALSE, otherwise.
@@ -922,11 +938,11 @@ export namespace Modulemd {
922
938
  /**
923
939
  * @param name The name of this component. Note that this is different from the key used to save this component to a {@link Modulemd.ModuleStream}. If this value is set, it adds a "name:" attribute to this component. This is used in bootstrapping cases where the key is a different name used to differentiate multiple ordered builds of the same component name. This function is currently only implemented for {@link Modulemd.ComponentRpm} and has no effect on other {@link Modulemd.Component} types.
924
940
  */
925
- set_name(name?: string | null): void;
941
+ set_name(name: string | null): void;
926
942
  /**
927
943
  * @param rationale The reason that this component is part of the stream.
928
944
  */
929
- set_rationale(rationale?: string | null): void;
945
+ set_rationale(rationale: string | null): void;
930
946
  /**
931
947
  * Verifies that all stored values are internally consistent and that the
932
948
  * component is sufficiently-complete for emitting. This function is called
@@ -963,8 +979,14 @@ export namespace Modulemd {
963
979
 
964
980
  // Properties
965
981
 
982
+ /**
983
+ * @default __UNSET_COMPONENT_MODULE__
984
+ */
966
985
  // This accessor conflicts with a field or function name in a parent class or interface.
967
986
  ref: string | any;
987
+ /**
988
+ * @default __UNSET_COMPONENT_MODULE__
989
+ */
968
990
  get repository(): string;
969
991
  set repository(val: string);
970
992
 
@@ -1019,11 +1041,11 @@ export namespace Modulemd {
1019
1041
  /**
1020
1042
  * @param ref The commit ID in the SCM repository.
1021
1043
  */
1022
- set_ref(ref?: string | null): void;
1044
+ set_ref(ref: string | null): void;
1023
1045
  /**
1024
1046
  * @param repository The URI of the SCM repository.
1025
1047
  */
1026
- set_repository(repository?: string | null): void;
1048
+ set_repository(repository: string | null): void;
1027
1049
  }
1028
1050
 
1029
1051
  namespace ComponentRpm {
@@ -1060,16 +1082,34 @@ export namespace Modulemd {
1060
1082
 
1061
1083
  // Properties
1062
1084
 
1085
+ /**
1086
+ * @default false
1087
+ */
1063
1088
  get buildroot(): boolean;
1064
1089
  set buildroot(val: boolean);
1090
+ /**
1091
+ * @default __UNSET_COMPONENT_RPM__
1092
+ */
1065
1093
  get cache(): string;
1066
1094
  set cache(val: string);
1095
+ /**
1096
+ * @default __UNSET_COMPONENT_RPM__
1097
+ */
1067
1098
  // This accessor conflicts with a field or function name in a parent class or interface.
1068
1099
  ref: string | any;
1100
+ /**
1101
+ * @default __UNSET_COMPONENT_RPM__
1102
+ */
1069
1103
  get repository(): string;
1070
1104
  set repository(val: string);
1105
+ /**
1106
+ * @default false
1107
+ */
1071
1108
  get srpm_buildroot(): boolean;
1072
1109
  set srpm_buildroot(val: boolean);
1110
+ /**
1111
+ * @default false
1112
+ */
1073
1113
  get srpmBuildroot(): boolean;
1074
1114
  set srpmBuildroot(val: boolean);
1075
1115
 
@@ -1179,15 +1219,15 @@ export namespace Modulemd {
1179
1219
  /**
1180
1220
  * @param cache The lookaside cache URL.
1181
1221
  */
1182
- set_cache(cache?: string | null): void;
1222
+ set_cache(cache: string | null): void;
1183
1223
  /**
1184
1224
  * @param ref The commit ID in the SCM repository.
1185
1225
  */
1186
- set_ref(ref?: string | null): void;
1226
+ set_ref(ref: string | null): void;
1187
1227
  /**
1188
1228
  * @param repository The URI of the SCM repository.
1189
1229
  */
1190
- set_repository(repository?: string | null): void;
1230
+ set_repository(repository: string | null): void;
1191
1231
  /**
1192
1232
  * @param srpm_buildroot The {@link Modulemd.ComponentRpm.srpm_buildroot} flag to set for `self`.
1193
1233
  */
@@ -1220,14 +1260,17 @@ export namespace Modulemd {
1220
1260
 
1221
1261
  /**
1222
1262
  * @read-only
1263
+ * @default 0
1223
1264
  */
1224
1265
  get mdversion(): number;
1225
1266
  /**
1226
1267
  * @construct-only
1268
+ * @default __NAME_UNSET__
1227
1269
  */
1228
1270
  get module_name(): string;
1229
1271
  /**
1230
1272
  * @construct-only
1273
+ * @default __NAME_UNSET__
1231
1274
  */
1232
1275
  get moduleName(): string;
1233
1276
 
@@ -1396,43 +1439,43 @@ export namespace Modulemd {
1396
1439
  * @param profile_name The name of the default profile to add.
1397
1440
  * @param intent The name of the system intent to add profile defaults to. If NULL, this sets the generic fallback profiles for the stream. System intents are deprecated and calls with this non-NULL argument will become void in the future.
1398
1441
  */
1399
- add_default_profile_for_stream(stream_name: string, profile_name: string, intent?: string | null): void;
1442
+ add_default_profile_for_stream(stream_name: string, profile_name: string, intent: string | null): void;
1400
1443
  /**
1401
1444
  * @param stream_name The name of the string to retrieve the default profiles for.
1402
1445
  * @param intent The name of the system intent for which to retrieve the profile defaults for this stream. System intents are deprecated and this argument will be ignored in the future.
1403
1446
  * @returns A sorted {@link GObject.Strv} list of unique profiles to be installed by default for this stream. NULL, if this stream_name is not present in the defaults.
1404
1447
  */
1405
- get_default_profiles_for_stream(stream_name: string, intent?: string | null): string[];
1448
+ get_default_profiles_for_stream(stream_name: string, intent: string | null): string[];
1406
1449
  /**
1407
1450
  * @param intent The name of the system intent whose default stream will be retrieved. If left NULL or the specified intent has no different default, it will return the generic default stream for this module. System intents are deprecated and this argument will be ignored in the future.
1408
1451
  * @returns The name of the default stream for this module.
1409
1452
  */
1410
- get_default_stream(intent?: string | null): string;
1453
+ get_default_stream(intent: string | null): string;
1411
1454
  /**
1412
1455
  * @param intent The name of the system intent whose stream profiles will be retrieved. If left NULL or the specified intent has no separate defaults for this module, it will return the generic stream profiles. System intents are deprecated and this argument will be ignored in the future.
1413
1456
  * @returns A sorted {@link GObject.Strv} list of unique stream names for which default profiles have been assigned.
1414
1457
  */
1415
- get_streams_with_default_profiles(intent?: string | null): string[];
1458
+ get_streams_with_default_profiles(intent: string | null): string[];
1416
1459
  /**
1417
1460
  * Removes this stream from the list of profiles entirely. It will not appear
1418
1461
  * in the output document.
1419
1462
  * @param stream_name The name of the module stream from which to remove default profiles.
1420
1463
  * @param intent The name of the system intent from which to remove the profile defaults for this stream. System intents are deprecated and calls with this non-NULL arugment will become void in the future.
1421
1464
  */
1422
- remove_default_profiles_for_stream(stream_name: string, intent?: string | null): void;
1465
+ remove_default_profiles_for_stream(stream_name: string, intent: string | null): void;
1423
1466
  /**
1424
1467
  * Set the default stream for this module.
1425
1468
  * @param default_stream The name of the default stream for this module. If NULL, it will remove the default stream.
1426
1469
  * @param intent If non-NULL, this indicates the system intent to apply this default stream. If NULL, it will be added as common defaults. System intents are deprecated and calls with this non-NULL argument will become void in the future.
1427
1470
  */
1428
- set_default_stream(default_stream?: string | null, intent?: string | null): void;
1471
+ set_default_stream(default_stream: string | null, intent: string | null): void;
1429
1472
  /**
1430
1473
  * Sets the default profiles for `stream_name` to the empty set. When output to
1431
1474
  * a file, it will appear as `stream_name: []`.
1432
1475
  * @param stream_name The name of the module stream for which to empty default profiles.
1433
1476
  * @param intent The name of the system intent from which to clear the profile defaults for this stream. System intents are deprecated and calls with this non-NULL argument will become void in the future.
1434
1477
  */
1435
- set_empty_default_profiles_for_stream(stream_name: string, intent?: string | null): void;
1478
+ set_empty_default_profiles_for_stream(stream_name: string, intent: string | null): void;
1436
1479
  }
1437
1480
 
1438
1481
  namespace Dependencies {
@@ -1581,10 +1624,12 @@ export namespace Modulemd {
1581
1624
 
1582
1625
  /**
1583
1626
  * @construct-only
1627
+ * @default null
1584
1628
  */
1585
1629
  get module_name(): string;
1586
1630
  /**
1587
1631
  * @construct-only
1632
+ * @default null
1588
1633
  */
1589
1634
  get moduleName(): string;
1590
1635
 
@@ -1654,7 +1699,7 @@ export namespace Modulemd {
1654
1699
  * @param context The stream context to look up obsoletes for.
1655
1700
  * @returns The newest active obsoletes attached to this module with specified stream and context (when eol_date is not set or it already occured the obsoletes is active). If no context is passed it matches obsoletes without context.
1656
1701
  */
1657
- get_newest_active_obsoletes(stream: string, context?: string | null): Obsoletes;
1702
+ get_newest_active_obsoletes(stream: string, context: string | null): Obsoletes;
1658
1703
  /**
1659
1704
  * @returns A list of all obsoletes attached to this module. These are pointers to the internal memory objects and must not be modified or freed.
1660
1705
  */
@@ -1676,8 +1721,8 @@ export namespace Modulemd {
1676
1721
  get_stream_by_NSVCA(
1677
1722
  stream_name: string,
1678
1723
  version: bigint | number,
1679
- context?: string | null,
1680
- arch?: string | null,
1724
+ context: string | null,
1725
+ arch: string | null,
1681
1726
  ): ModuleStream;
1682
1727
  /**
1683
1728
  * @returns An ordered {@link GObject.Strv} list of stream names in this module.
@@ -1704,8 +1749,8 @@ export namespace Modulemd {
1704
1749
  remove_streams_by_NSVCA(
1705
1750
  stream_name: string,
1706
1751
  version: bigint | number,
1707
- context?: string | null,
1708
- arch?: string | null,
1752
+ context: string | null,
1753
+ arch: string | null,
1709
1754
  ): void;
1710
1755
  /**
1711
1756
  * @param stream_name The name of the stream to retrieve.
@@ -1717,8 +1762,8 @@ export namespace Modulemd {
1717
1762
  search_streams(
1718
1763
  stream_name: string,
1719
1764
  version: bigint | number,
1720
- context?: string | null,
1721
- arch?: string | null,
1765
+ context: string | null,
1766
+ arch: string | null,
1722
1767
  ): ModuleStream[];
1723
1768
  /**
1724
1769
  * All arguments to this method will be compared using
@@ -1730,16 +1775,16 @@ export namespace Modulemd {
1730
1775
  * @returns The list of stream objects matching all of the requested parameters. This function cannot fail, but it may return a zero-length list if no matches were found. The returned streams will be in a predictable order, sorted first by module name, then stream name, then by version (highest first), then by context and finally by architecture.
1731
1776
  */
1732
1777
  search_streams_by_glob(
1733
- stream_name?: string | null,
1734
- version?: string | null,
1735
- context?: string | null,
1736
- arch?: string | null,
1778
+ stream_name: string | null,
1779
+ version: string | null,
1780
+ context: string | null,
1781
+ arch: string | null,
1737
1782
  ): ModuleStream[];
1738
1783
  /**
1739
1784
  * @param nsvca_pattern A [glob](https://www.mankier.com/3/glob) pattern to match against the NSVCA strings of the {@link Modulemd.ModuleStream} objects in this module. If NULL, this will match all NSVCAs.
1740
1785
  * @returns An array of {@link Modulemd.ModuleStream} objects whose NSVCA string matches the provided pattern. This function cannot fail, but may return an array of zero entries if the pattern did not match any streams. The returned streams will be in a predictable order, sorted first by module name, then stream name, then by version (highest first), then by context and finally by architecture.
1741
1786
  */
1742
- search_streams_by_nsvca_glob(nsvca_pattern?: string | null): ModuleStream[];
1787
+ search_streams_by_nsvca_glob(nsvca_pattern: string | null): ModuleStream[];
1743
1788
  /**
1744
1789
  * @returns TRUE if validation passed, FALSE and sets `error` if failed.
1745
1790
  */
@@ -1844,7 +1889,7 @@ export namespace Modulemd {
1844
1889
  * @param intent The name of the system intent whose default stream will be retrieved. If left NULL or the specified intent has no separate default, it will return the generic default stream for this module. System intents are deprecated and this argument will be ignored in the future.
1845
1890
  * @returns A {@link GLib.HashTable} with the module name as the key and the default stream as the value for all modules with a default stream in the index. Modules without a default stream will not appear in this table.
1846
1891
  */
1847
- get_default_streams(intent?: string | null): GLib.HashTable<string, string>;
1892
+ get_default_streams(intent: string | null): GLib.HashTable<string, string>;
1848
1893
  /**
1849
1894
  * @returns The metadata version of {@link Modulemd.Defaults} in use for this index.
1850
1895
  */
@@ -1887,17 +1932,17 @@ export namespace Modulemd {
1887
1932
  * @returns The list of stream objects matching all of the requested parameters. This function cannot fail, but it may return a zero-length list if no matches were found. The returned streams will be in a predictable order, sorted first by module name, then stream name, then by version (highest first), then by context and finally by architecture.
1888
1933
  */
1889
1934
  search_streams(
1890
- module_name?: string | null,
1891
- stream_name?: string | null,
1892
- version?: string | null,
1893
- context?: string | null,
1894
- arch?: string | null,
1935
+ module_name: string | null,
1936
+ stream_name: string | null,
1937
+ version: string | null,
1938
+ context: string | null,
1939
+ arch: string | null,
1895
1940
  ): ModuleStream[];
1896
1941
  /**
1897
1942
  * @param nsvca_pattern A [glob](https://www.mankier.com/3/glob) pattern to match against the NSVCA strings of the {@link Modulemd.ModuleStream} objects in this module. If NULL, this will match all NSVCAs.
1898
1943
  * @returns The list of stream objects matching all of the requested parameters. This function cannot fail, but it may return a zero-length list if no matches were found. The returned streams will be in a predictable order, sorted first by module name, then stream name, then by version (highest first), then by context and finally by architecture.
1899
1944
  */
1900
- search_streams_by_nsvca_glob(nsvca_pattern?: string | null): ModuleStream[];
1945
+ search_streams_by_nsvca_glob(nsvca_pattern: string | null): ModuleStream[];
1901
1946
  /**
1902
1947
  * This function will open the directory at `path` and iterate through it,
1903
1948
  * adding any files with the suffix ".yaml" to `self`. If `overrides_path` is
@@ -1914,7 +1959,7 @@ export namespace Modulemd {
1914
1959
  * @param overrides_path If non-`null`, the path to a directory containing defaults documents that should override those in `path`.
1915
1960
  * @returns `true` if all ".yaml" files in the directory were imported successfully (this includes if no ".yaml" files were present). `false` if one or more files could not be read successfully and sets `error` appropriately.
1916
1961
  */
1917
- update_from_defaults_directory(path: string, strict: boolean, overrides_path?: string | null): boolean;
1962
+ update_from_defaults_directory(path: string, strict: boolean, overrides_path: string | null): boolean;
1918
1963
  /**
1919
1964
  * @param yaml_file A name of a YAML file containing the module metadata and other related information such as default streams.
1920
1965
  * @param strict Whether the parser should return failure if it encounters an unknown mapping key or if it should ignore it.
@@ -2073,30 +2118,44 @@ export namespace Modulemd {
2073
2118
 
2074
2119
  // Properties
2075
2120
 
2121
+ /**
2122
+ * @default null
2123
+ */
2076
2124
  get arch(): string;
2077
2125
  set arch(val: string);
2126
+ /**
2127
+ * @default null
2128
+ */
2078
2129
  get context(): string;
2079
2130
  set context(val: string);
2080
2131
  /**
2081
2132
  * @read-only
2133
+ * @default 0
2082
2134
  */
2083
2135
  get mdversion(): number;
2084
2136
  /**
2085
2137
  * @construct-only
2138
+ * @default null
2086
2139
  */
2087
2140
  get module_name(): string;
2088
2141
  /**
2089
2142
  * @construct-only
2143
+ * @default null
2090
2144
  */
2091
2145
  get moduleName(): string;
2092
2146
  /**
2093
2147
  * @construct-only
2148
+ * @default null
2094
2149
  */
2095
2150
  get stream_name(): string;
2096
2151
  /**
2097
2152
  * @construct-only
2153
+ * @default null
2098
2154
  */
2099
2155
  get streamName(): string;
2156
+ /**
2157
+ * @default 0
2158
+ */
2100
2159
  get version(): number;
2101
2160
  set version(val: bigint | number);
2102
2161
 
@@ -2117,8 +2176,8 @@ export namespace Modulemd {
2117
2176
 
2118
2177
  static ['new'](
2119
2178
  mdversion: bigint | number,
2120
- module_name?: string | null,
2121
- module_stream?: string | null,
2179
+ module_name: string | null,
2180
+ module_stream: string | null,
2122
2181
  ): ModuleStream;
2123
2182
 
2124
2183
  // Signals
@@ -2161,8 +2220,8 @@ export namespace Modulemd {
2161
2220
  static read_file(
2162
2221
  path: string,
2163
2222
  strict: boolean,
2164
- module_name?: string | null,
2165
- module_stream?: string | null,
2223
+ module_name: string | null,
2224
+ module_stream: string | null,
2166
2225
  ): ModuleStream;
2167
2226
  /**
2168
2227
  * Create a {@link Modulemd.ModuleStream} object from a YAML string.
@@ -2181,8 +2240,8 @@ export namespace Modulemd {
2181
2240
  static read_string(
2182
2241
  yaml_string: string,
2183
2242
  strict: boolean,
2184
- module_name?: string | null,
2185
- module_stream?: string | null,
2243
+ module_name: string | null,
2244
+ module_stream: string | null,
2186
2245
  ): ModuleStream;
2187
2246
 
2188
2247
  // Virtual methods
@@ -2200,7 +2259,7 @@ export namespace Modulemd {
2200
2259
  * @param module_stream An optional new name for the copied stream.
2201
2260
  * @virtual
2202
2261
  */
2203
- vfunc_copy(module_name?: string | null, module_stream?: string | null): ModuleStream;
2262
+ vfunc_copy(module_name: string | null, module_stream: string | null): ModuleStream;
2204
2263
  /**
2205
2264
  * @param module_name A module name.
2206
2265
  * @param stream_name The stream of the module.
@@ -2240,7 +2299,7 @@ export namespace Modulemd {
2240
2299
  * @param module_stream An optional new name for the copied stream.
2241
2300
  * @returns A newly-allocated {@link Modulemd.ModuleStream} object that is a complete copy of `self`, optionally with a new stream name.
2242
2301
  */
2243
- copy(module_name?: string | null, module_stream?: string | null): ModuleStream;
2302
+ copy(module_name: string | null, module_stream: string | null): ModuleStream;
2244
2303
  /**
2245
2304
  * @param module_name A module name.
2246
2305
  * @param stream_name The stream of the module.
@@ -2293,11 +2352,11 @@ export namespace Modulemd {
2293
2352
  /**
2294
2353
  * @param arch Module architecture. Indicates to which processor architecture this {@link Modulemd.ModuleStream} applies.
2295
2354
  */
2296
- set_arch(arch?: string | null): void;
2355
+ set_arch(arch: string | null): void;
2297
2356
  /**
2298
2357
  * @param context Module context flag. The context flag serves to distinguish module builds with the same name, stream and version and plays an important role in automatic module stream name expansion.
2299
2358
  */
2300
- set_context(context?: string | null): void;
2359
+ set_context(context: string | null): void;
2301
2360
  /**
2302
2361
  * @param version The version of this {@link Modulemd.ModuleStream}.
2303
2362
  */
@@ -2357,14 +2416,26 @@ export namespace Modulemd {
2357
2416
 
2358
2417
  // Properties
2359
2418
 
2419
+ /**
2420
+ * @default null
2421
+ */
2360
2422
  get arch(): string;
2361
2423
  set arch(val: string);
2362
2424
  get buildopts(): Buildopts;
2363
2425
  set buildopts(val: Buildopts);
2426
+ /**
2427
+ * @default null
2428
+ */
2364
2429
  get community(): string;
2365
2430
  set community(val: string);
2431
+ /**
2432
+ * @default null
2433
+ */
2366
2434
  get documentation(): string;
2367
2435
  set documentation(val: string);
2436
+ /**
2437
+ * @default null
2438
+ */
2368
2439
  get tracker(): string;
2369
2440
  set tracker(val: string);
2370
2441
 
@@ -2383,7 +2454,7 @@ export namespace Modulemd {
2383
2454
 
2384
2455
  _init(...args: any[]): void;
2385
2456
 
2386
- static ['new'](module_name?: string | null, module_stream?: string | null): ModuleStreamV1;
2457
+ static ['new'](module_name: string | null, module_stream: string | null): ModuleStreamV1;
2387
2458
  // Conflicted with Modulemd.ModuleStream.new
2388
2459
 
2389
2460
  static ['new'](...args: never[]): any;
@@ -2531,7 +2602,7 @@ export namespace Modulemd {
2531
2602
  * @param locale The name of the locale to use when translating the string. If NULL, it will determine the locale with a system call to `setlocale(LC_MESSAGES, NULL)` and return that. If the caller wants the untranslated string, they should pass `"C"` for the locale.
2532
2603
  * @returns The module description, translated to the requested locale if available. Translation information is managed by the {@link Modulemd.Translation} and {@link Modulemd.TranslationEntry} objects.
2533
2604
  */
2534
- get_description(locale?: string | null): string;
2605
+ get_description(locale: string | null): string;
2535
2606
  /**
2536
2607
  * @returns The module documentation website address.
2537
2608
  */
@@ -2606,7 +2677,7 @@ export namespace Modulemd {
2606
2677
  * @param locale The name of the locale to use when translating the string. If NULL, it will determine the locale with a system call to `setlocale(LC_MESSAGES, NULL)` and return that. If the caller wants the untranslated string, they should pass `"C"` for the locale.
2607
2678
  * @returns The module summary, translated to the requested locale if available. Translation information is managed by the {@link Modulemd.Translation} and {@link Modulemd.TranslationEntry} objects.
2608
2679
  */
2609
- get_summary(locale?: string | null): string;
2680
+ get_summary(locale: string | null): string;
2610
2681
  /**
2611
2682
  * @returns The module bug tracker website address.
2612
2683
  */
@@ -2679,7 +2750,7 @@ export namespace Modulemd {
2679
2750
  * Set the module description.
2680
2751
  * @param description The untranslated description of this module.
2681
2752
  */
2682
- set_description(description?: string | null): void;
2753
+ set_description(description: string | null): void;
2683
2754
  /**
2684
2755
  * Set the module documentation website address.
2685
2756
  * @param documentation The upstream documentation website for this module.
@@ -2695,7 +2766,7 @@ export namespace Modulemd {
2695
2766
  * Set the module summary.
2696
2767
  * @param summary The untranslated summary of this module.
2697
2768
  */
2698
- set_summary(summary?: string | null): void;
2769
+ set_summary(summary: string | null): void;
2699
2770
  /**
2700
2771
  * Set the module bug tracker website address.
2701
2772
  * @param tracker The upstream bug tracker website for this module.
@@ -2750,18 +2821,36 @@ export namespace Modulemd {
2750
2821
 
2751
2822
  // Properties
2752
2823
 
2824
+ /**
2825
+ * @default null
2826
+ */
2753
2827
  get arch(): string;
2754
2828
  set arch(val: string);
2755
2829
  get buildopts(): Buildopts;
2756
2830
  set buildopts(val: Buildopts);
2831
+ /**
2832
+ * @default null
2833
+ */
2757
2834
  get community(): string;
2758
2835
  set community(val: string);
2836
+ /**
2837
+ * @default null
2838
+ */
2759
2839
  get documentation(): string;
2760
2840
  set documentation(val: string);
2841
+ /**
2842
+ * @default false
2843
+ */
2761
2844
  get static_context(): boolean;
2762
2845
  set static_context(val: boolean);
2846
+ /**
2847
+ * @default false
2848
+ */
2763
2849
  get staticContext(): boolean;
2764
2850
  set staticContext(val: boolean);
2851
+ /**
2852
+ * @default null
2853
+ */
2765
2854
  get tracker(): string;
2766
2855
  set tracker(val: string);
2767
2856
 
@@ -2780,7 +2869,7 @@ export namespace Modulemd {
2780
2869
 
2781
2870
  _init(...args: any[]): void;
2782
2871
 
2783
- static ['new'](module_name?: string | null, module_stream?: string | null): ModuleStreamV2;
2872
+ static ['new'](module_name: string | null, module_stream: string | null): ModuleStreamV2;
2784
2873
  // Conflicted with Modulemd.ModuleStream.new
2785
2874
 
2786
2875
  static ['new'](...args: never[]): any;
@@ -2931,7 +3020,7 @@ export namespace Modulemd {
2931
3020
  * @param locale The name of the locale to use when translating the string. If NULL, it will determine the locale with a system call to `setlocale(LC_MESSAGES, NULL)` and return that. If the caller wants the untranslated string, they should pass `"C"` for the locale.
2932
3021
  * @returns The module description, translated to the requested locale if available. Translation information is managed by the {@link Modulemd.Translation} and {@link Modulemd.TranslationEntry} objects.
2933
3022
  */
2934
- get_description(locale?: string | null): string;
3023
+ get_description(locale: string | null): string;
2935
3024
  /**
2936
3025
  * @returns The module documentation website address.
2937
3026
  */
@@ -3002,7 +3091,7 @@ export namespace Modulemd {
3002
3091
  * @param locale The name of the locale to use when translating the string. If NULL, it will determine the locale with a system call to `setlocale(LC_MESSAGES, NULL)` and return that. If the caller wants the untranslated string, they should pass `"C"` for the locale.
3003
3092
  * @returns The module summary, translated to the requested locale if available. Translation information is managed by the {@link Modulemd.Translation} and {@link Modulemd.TranslationEntry} objects.
3004
3093
  */
3005
- get_summary(locale?: string | null): string;
3094
+ get_summary(locale: string | null): string;
3006
3095
  /**
3007
3096
  * @returns The module bug tracker website address.
3008
3097
  */
@@ -3060,7 +3149,7 @@ export namespace Modulemd {
3060
3149
  * @param profile_pattern A globbing pattern to locate one or more profiles in this {@link Modulemd.ModuleStreamV2} object. The names will be compared using [fnmatch(3)](https://www.mankier.com/3/fnmatch).
3061
3150
  * @returns The list of {@link Modulemd.Profile} objects whose name matched `profile_pattern`. This function cannot fail, but it may return a zero-length list if no matches were found. The returned profiles will be sorted alphabetically by profile name.
3062
3151
  */
3063
- search_profiles(profile_pattern?: string | null): Profile[];
3152
+ search_profiles(profile_pattern: string | null): Profile[];
3064
3153
  /**
3065
3154
  * Set the module artifact architecture.
3066
3155
  * @param arch The module artifact architecture.
@@ -3085,7 +3174,7 @@ export namespace Modulemd {
3085
3174
  * Set the module description.
3086
3175
  * @param description The untranslated description of this module.
3087
3176
  */
3088
- set_description(description?: string | null): void;
3177
+ set_description(description: string | null): void;
3089
3178
  /**
3090
3179
  * Set the module documentation website address.
3091
3180
  * @param documentation The upstream documentation website for this module.
@@ -3106,7 +3195,7 @@ export namespace Modulemd {
3106
3195
  * Set the module summary.
3107
3196
  * @param summary The untranslated summary of this module.
3108
3197
  */
3109
- set_summary(summary?: string | null): void;
3198
+ set_summary(summary: string | null): void;
3110
3199
  /**
3111
3200
  * Set the module bug tracker website address.
3112
3201
  * @param tracker The upstream bug tracker website for this module.
@@ -3175,50 +3264,89 @@ export namespace Modulemd {
3175
3264
 
3176
3265
  // Properties
3177
3266
 
3267
+ /**
3268
+ * @default 0
3269
+ */
3178
3270
  get eol_date(): number;
3179
3271
  set eol_date(val: bigint | number);
3272
+ /**
3273
+ * @default 0
3274
+ */
3180
3275
  get eolDate(): number;
3181
3276
  set eolDate(val: bigint | number);
3182
3277
  /**
3183
3278
  * @construct-only
3279
+ * @default 0
3184
3280
  */
3185
3281
  get mdversion(): number;
3186
3282
  /**
3187
3283
  * @construct-only
3284
+ * @default __obsoletes_VALUE_UNSET__
3188
3285
  */
3189
3286
  get message(): string;
3287
+ /**
3288
+ * @default 0
3289
+ */
3190
3290
  get modified(): number;
3191
3291
  set modified(val: bigint | number);
3292
+ /**
3293
+ * @default null
3294
+ */
3192
3295
  get module_context(): string;
3193
3296
  set module_context(val: string);
3297
+ /**
3298
+ * @default null
3299
+ */
3194
3300
  get moduleContext(): string;
3195
3301
  set moduleContext(val: string);
3196
3302
  /**
3197
3303
  * @construct-only
3304
+ * @default __obsoletes_VALUE_UNSET__
3198
3305
  */
3199
3306
  get module_name(): string;
3200
3307
  /**
3201
3308
  * @construct-only
3309
+ * @default __obsoletes_VALUE_UNSET__
3202
3310
  */
3203
3311
  get moduleName(): string;
3204
3312
  /**
3205
3313
  * @construct-only
3314
+ * @default __obsoletes_VALUE_UNSET__
3206
3315
  */
3207
3316
  get module_stream(): string;
3208
3317
  /**
3209
3318
  * @construct-only
3319
+ * @default __obsoletes_VALUE_UNSET__
3210
3320
  */
3211
3321
  get moduleStream(): string;
3322
+ /**
3323
+ * @default null
3324
+ */
3212
3325
  get obsoleted_by_module_name(): string;
3213
3326
  set obsoleted_by_module_name(val: string);
3327
+ /**
3328
+ * @default null
3329
+ */
3214
3330
  get obsoletedByModuleName(): string;
3215
3331
  set obsoletedByModuleName(val: string);
3332
+ /**
3333
+ * @default null
3334
+ */
3216
3335
  get obsoleted_by_module_stream(): string;
3217
3336
  set obsoleted_by_module_stream(val: string);
3337
+ /**
3338
+ * @default null
3339
+ */
3218
3340
  get obsoletedByModuleStream(): string;
3219
3341
  set obsoletedByModuleStream(val: string);
3342
+ /**
3343
+ * @default false
3344
+ */
3220
3345
  get override_previous(): boolean;
3221
3346
  set override_previous(val: boolean);
3347
+ /**
3348
+ * @default false
3349
+ */
3222
3350
  get overridePrevious(): boolean;
3223
3351
  set overridePrevious(val: boolean);
3224
3352
 
@@ -3316,7 +3444,7 @@ export namespace Modulemd {
3316
3444
  /**
3317
3445
  * @param module_context The name of the module context to which this obsoletes applies.
3318
3446
  */
3319
- set_module_context(module_context?: string | null): void;
3447
+ set_module_context(module_context: string | null): void;
3320
3448
  /**
3321
3449
  * Sets both obsoleted by module name and stream because having one without
3322
3450
  * the other is invalid.
@@ -3607,7 +3735,7 @@ export namespace Modulemd {
3607
3735
  * Sets the module's long description.
3608
3736
  * @param description A complete description of the module.
3609
3737
  */
3610
- set_description(description?: string | null): void;
3738
+ set_description(description: string | null): void;
3611
3739
  /**
3612
3740
  * Set the module documentation website address.
3613
3741
  * @param documentation The upstream documentation website for this module.
@@ -3627,7 +3755,7 @@ export namespace Modulemd {
3627
3755
  * Sets the module's short description.
3628
3756
  * @param summary A short description of the module.
3629
3757
  */
3630
- set_summary(summary?: string | null): void;
3758
+ set_summary(summary: string | null): void;
3631
3759
  /**
3632
3760
  * Set the module bug tracker website address.
3633
3761
  * @param tracker The upstream bug tracker website for this module.
@@ -3668,6 +3796,7 @@ export namespace Modulemd {
3668
3796
 
3669
3797
  /**
3670
3798
  * @construct-only
3799
+ * @default __PROFILE_NAME_UNSET__
3671
3800
  */
3672
3801
  get name(): string;
3673
3802
 
@@ -3733,7 +3862,7 @@ export namespace Modulemd {
3733
3862
  * @param locale The name of the locale to use when translating the string. If NULL, it will determine the locale with a system call to `setlocale(LC_MESSAGES, NULL)` and return that. If the caller wants the untranslated string, they should pass `"C"` for the locale.
3734
3863
  * @returns The description of this profile translated into the language specified by the locale if it is available, otherwise it returns the C.UTF-8 original. Translation information is managed by the {@link Modulemd.Translation} and {@link Modulemd.TranslationEntry} objects.
3735
3864
  */
3736
- get_description(locale?: string | null): string;
3865
+ get_description(locale: string | null): string;
3737
3866
  /**
3738
3867
  * @returns The name of this profile.
3739
3868
  */
@@ -3758,7 +3887,7 @@ export namespace Modulemd {
3758
3887
  /**
3759
3888
  * @param description The untranslated description of this profile.
3760
3889
  */
3761
- set_description(description?: string | null): void;
3890
+ set_description(description: string | null): void;
3762
3891
  /**
3763
3892
  * Calling this function indicates that this profile should not be considered
3764
3893
  * one of the default profiles for this stream. This is the normal state of
@@ -3799,18 +3928,34 @@ export namespace Modulemd {
3799
3928
 
3800
3929
  // Properties
3801
3930
 
3931
+ /**
3932
+ * @default null
3933
+ */
3802
3934
  get arch(): string;
3803
3935
  set arch(val: string);
3936
+ /**
3937
+ * @default 0
3938
+ */
3804
3939
  get epoch(): number;
3805
3940
  set epoch(val: bigint | number);
3941
+ /**
3942
+ * @default null
3943
+ */
3806
3944
  get name(): string;
3807
3945
  set name(val: string);
3808
3946
  /**
3809
3947
  * @read-only
3948
+ * @default null
3810
3949
  */
3811
3950
  get nevra(): string;
3951
+ /**
3952
+ * @default null
3953
+ */
3812
3954
  get release(): string;
3813
3955
  set release(val: string);
3956
+ /**
3957
+ * @default null
3958
+ */
3814
3959
  get version(): string;
3815
3960
  set version(val: string);
3816
3961
 
@@ -3939,6 +4084,7 @@ export namespace Modulemd {
3939
4084
 
3940
4085
  /**
3941
4086
  * @construct-only
4087
+ * @default __NAME_UNSET__
3942
4088
  */
3943
4089
  get name(): string;
3944
4090
 
@@ -4014,7 +4160,7 @@ export namespace Modulemd {
4014
4160
  * or NULL, the EOL will be unset.
4015
4161
  * @param date The date this service level ends.
4016
4162
  */
4017
- set_eol(date?: GLib.Date | null): void;
4163
+ set_eol(date: GLib.Date | null): void;
4018
4164
  /**
4019
4165
  * @param year The year this service level ends.
4020
4166
  * @param month The month this service level ends.
@@ -4115,26 +4261,34 @@ export namespace Modulemd {
4115
4261
 
4116
4262
  // Properties
4117
4263
 
4264
+ /**
4265
+ * @default 0
4266
+ */
4118
4267
  get modified(): number;
4119
4268
  set modified(val: bigint | number);
4120
4269
  /**
4121
4270
  * @construct-only
4271
+ * @default __TRANSLATION_VALUE_UNSET__
4122
4272
  */
4123
4273
  get module_name(): string;
4124
4274
  /**
4125
4275
  * @construct-only
4276
+ * @default __TRANSLATION_VALUE_UNSET__
4126
4277
  */
4127
4278
  get moduleName(): string;
4128
4279
  /**
4129
4280
  * @construct-only
4281
+ * @default __TRANSLATION_VALUE_UNSET__
4130
4282
  */
4131
4283
  get module_stream(): string;
4132
4284
  /**
4133
4285
  * @construct-only
4286
+ * @default __TRANSLATION_VALUE_UNSET__
4134
4287
  */
4135
4288
  get moduleStream(): string;
4136
4289
  /**
4137
4290
  * @construct-only
4291
+ * @default 0
4138
4292
  */
4139
4293
  get version(): number;
4140
4294
 
@@ -4239,12 +4393,19 @@ export namespace Modulemd {
4239
4393
 
4240
4394
  // Properties
4241
4395
 
4396
+ /**
4397
+ * @default __LOCALE_UNSET__
4398
+ */
4242
4399
  get description(): string;
4243
4400
  set description(val: string);
4244
4401
  /**
4245
4402
  * @construct-only
4403
+ * @default __LOCALE_UNSET__
4246
4404
  */
4247
4405
  get locale(): string;
4406
+ /**
4407
+ * @default __LOCALE_UNSET__
4408
+ */
4248
4409
  get summary(): string;
4249
4410
  set summary(val: string);
4250
4411
 
@@ -4320,17 +4481,17 @@ export namespace Modulemd {
4320
4481
  /**
4321
4482
  * @param description The description of this module stream translated into the language specified by locale.
4322
4483
  */
4323
- set_description(description?: string | null): void;
4484
+ set_description(description: string | null): void;
4324
4485
  /**
4325
4486
  * Adds a profile name translation.
4326
4487
  * @param profile_name The name of the profile.
4327
4488
  * @param profile_description The translated description of the profile.
4328
4489
  */
4329
- set_profile_description(profile_name: string, profile_description?: string | null): void;
4490
+ set_profile_description(profile_name: string, profile_description: string | null): void;
4330
4491
  /**
4331
4492
  * @param summary The summary of this module translated appropriately for this locale.
4332
4493
  */
4333
- set_summary(summary?: string | null): void;
4494
+ set_summary(summary: string | null): void;
4334
4495
  }
4335
4496
 
4336
4497
  /**
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@girs/modulemd-2.0",
3
- "version": "2.0.0-4.0.0-rc.6",
3
+ "version": "2.0.0-4.0.0-rc.7",
4
4
  "description": "GJS TypeScript type definitions for Modulemd-2.0, generated from library version 2.0.0",
5
5
  "type": "module",
6
6
  "module": "modulemd-2.0.js",
@@ -31,9 +31,9 @@
31
31
  "test": "tsc --project tsconfig.json"
32
32
  },
33
33
  "dependencies": {
34
- "@girs/gjs": "4.0.0-rc.6",
35
- "@girs/gobject-2.0": "2.88.0-4.0.0-rc.6",
36
- "@girs/glib-2.0": "2.88.0-4.0.0-rc.6" },
34
+ "@girs/gjs": "4.0.0-rc.7",
35
+ "@girs/gobject-2.0": "2.88.0-4.0.0-rc.7",
36
+ "@girs/glib-2.0": "2.88.0-4.0.0-rc.7" },
37
37
  "devDependencies": {
38
38
  "typescript": "*"
39
39
  },