@skyux/docs-tools 4.9.3 → 4.9.7

package/CHANGELOG.md

@@ -1,3 +1,20 @@
+# 4.9.7 (2021-12-03)
+
+- Fixed the `SkyDocsCodeExamplesEditorService` to set wildcard versions (e.g. '*') of SKY UX packages to `^4`. [#188](https://github.com/blackbaud/skyux-docs-tools/pull/188)
+
+# 4.9.6 (2021-09-21)
+
+- Fixed the `SkyDocsSourceCodeService` to handle both encoded and decoded URI strings for the source code. [#173](https://github.com/blackbaud/skyux-docs-tools/pull/173)
+
+# 4.9.5 (2021-08-25)
+
+- Fixed the NPM release. [#172](https://github.com/blackbaud/skyux-docs-tools/pull/172)
+
+# 4.9.4 (2021-08-25)
+
+- [This release is broken. Upgrade to version `4.9.5`.]
+- Fixed the `SkyDocsTypeDocAdapterService` to handle default values generated by `typedoc@~0.20.0`. [#170](https://github.com/blackbaud/skyux-docs-tools/pull/170)
+
 # 4.9.3 (2021-08-13)
 
 - Fixed the `SkyDocsTypeDocAdapterService` to use `SkyDocsTypeDefinitionsProvider.anchorIds` if the `anchorId` property has not been set on the individual type definitions. [#167](https://github.com/blackbaud/skyux-docs-tools/pull/167)

package/bundles/skyux-docs-tools.umd.js

@@ -345,7 +345,20 @@
             return sourceCode
                 .filter(function (file) { return file.filePath.indexOf(path) === 0; })
                 .map(function (file) {
-                file.rawContents = decodeURIComponent(file.rawContents);
+                // TODO: Remove decoding after migrating to Angular CLI. Code examples will not be encoded for SKY UX 5 libraries.
+                // SKY UX 4 libraries will return rawContents encoded, while later libraries will
+                // return rawContents decoded. Check if the contents need decoded before returning them.
+                var decodedContents;
+                try {
+                    decodedContents = decodeURIComponent(file.rawContents);
+                    if (decodedContents !== file.rawContents) {
+                        file.rawContents = decodedContents;
+                    }
+                }
+                catch (error) {
+                    // Pre-decoded contents may contain characters like '%' that would throw errors.
+                    // In these cases, pass along the original rawContents.
+                }
                 return file;
             });
         };
@@ -461,7 +474,7 @@
         };
         SkyDocsCodeExamplesEditorService.prototype.getPayload = function (codeExample) {
             var angularVersion = '^9.0.0';
-            var skyuxVersion = '*';
+            var skyuxVersion = '^4';
             var defaultDependencies = {
                 '@angular/animations': angularVersion,
                 '@angular/common': angularVersion,
@@ -492,6 +505,16 @@
                 'zone.js': '~0.11.4'
             };
             var mergedDependencies = Object.assign({}, defaultDependencies, codeExample.packageDependencies);
+            // Ensure any @skyux dependencies list the correct version of SKY UX.
+            // e.g. `"@skyux/core": "*"` --> `"@skyux/core": "4.0.0"`
+            for (var packageName in mergedDependencies) {
+                if (mergedDependencies.hasOwnProperty(packageName)) {
+                    var version = mergedDependencies[packageName];
+                    if (version === '*' && /^(@blackbaud\/skyux-lib-|@skyux)/.test(packageName)) {
+                        mergedDependencies[packageName] = skyuxVersion;
+                    }
+                }
+            }
             var files = this.parseStackBlitzFiles(codeExample.sourceCode, mergedDependencies, codeExample.theme);
             return {
                 files: files,
@@ -2578,7 +2601,16 @@
                 : property.name;
         };
         SkyDocsTypeDocAdapterService.prototype.getDefaultValue = function (child, tags) {
-            return tags.defaultValue || child.defaultValue || undefined;
+            if (tags.defaultValue) {
+                return tags.defaultValue;
+            }
+            // TypeDoc version 0.20.x stopped auto-generating initializers for the default value
+            // (and replaced them with "...") due to the complicated logic it required.
+            // See: https://github.com/TypeStrong/typedoc/issues/1552
+            if (child.defaultValue === '...') {
+                return;
+            }
+            return child.defaultValue;
         };
         SkyDocsTypeDocAdapterService.prototype.getAnchorId = function (entry) {
             var _a;