@skyux/docs-tools 4.9.5 → 4.10.0

package/CHANGELOG.md

@@ -1,3 +1,15 @@
+# 4.10.0 (2022-03-22)
+
+- Added an alert to redirect consumers to the main documentation site. [#202](https://github.com/blackbaud/skyux-docs-tools/pull/202)
+
+# 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)

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,
@@ -3116,7 +3139,7 @@
         SkyDocsDemoPageComponent = __decorate([
             core.Component({
                 selector: 'sky-docs-demo-page',
-                template: "<div class=\"sky-docs-demo-page\">\n  <stache\n    layout=\"sidebar\"\n    [pageTitle]=\"pageTitle\"\n    [showBreadcrumbs]=\"false\"\n    [showTableOfContents]=\"false\"\n    [sidebarRoutes]=\"sidebarRoutes\"\n  >\n    <ng-content\n      select=\"sky-docs-demo-page-summary\"\n    ></ng-content>\n\n    <ng-content\n      select=\"sky-docs-demo\"\n    ></ng-content>\n\n    <div\n      class=\"sky-docs-demo-page-main\"\n    >\n      <sky-tabset *ngIf=\"enableTabLayout else content\"\n        permalinkId=\"docs\"\n      >\n        <sky-tab tabHeading=\"Design\">\n          <ng-content\n            select=\"sky-docs-design-guidelines\"\n          ></ng-content>\n        </sky-tab>\n\n        <sky-tab tabHeading=\"Development\">\n          <ng-container\n            [ngTemplateOutlet]=\"content\"\n          ></ng-container>\n        </sky-tab>\n      </sky-tabset>\n    </div>\n  </stache>\n</div>\n\n<ng-template #content>\n  <sky-docs-demo-page-section *ngIf=\"moduleName\"\n    heading=\"Installation\"\n  >\n    <sky-docs-module-info\n      [gitRepoUrl]=\"gitRepoUrl\"\n      [moduleName]=\"moduleName\"\n      [packageName]=\"packageName\"\n      [packageUrl]=\"packageUrl\"\n    >\n      <ng-content\n        select=\"sky-docs-demo-page-module-info\"\n      ></ng-content>\n    </sky-docs-module-info>\n  </sky-docs-demo-page-section>\n\n  <ng-content></ng-content>\n\n  <sky-docs-demo-page-type-definitions\n    [moduleSourceCodePath]=\"moduleSourceCodePath\"\n  >\n  </sky-docs-demo-page-type-definitions>\n\n  <sky-docs-demo-page-section *ngIf=\"enableCodeExamples\"\n    heading=\"Code examples\"\n  >\n    <ng-content\n      select=\"sky-docs-code-examples\"\n    ></ng-content>\n  </sky-docs-demo-page-section>\n</ng-template>",
+                template: "<div class=\"sky-docs-demo-page\">\n  <stache\n    layout=\"sidebar\"\n    [pageTitle]=\"pageTitle\"\n    [showBreadcrumbs]=\"false\"\n    [showTableOfContents]=\"false\"\n    [sidebarRoutes]=\"sidebarRoutes\"\n  >\n    <sky-alert alertType=\"warning\">\n      This site describes an older version of the SKY UX framework, and we strongly recommend using the most recent version. For more information, see the <a href=\"https://developer.blackbaud.com/skyux\">primary SKY UX website</a>.\n    </sky-alert>\n\n    <ng-content\n      select=\"sky-docs-demo-page-summary\"\n    ></ng-content>\n\n    <ng-content\n      select=\"sky-docs-demo\"\n    ></ng-content>\n\n    <div\n      class=\"sky-docs-demo-page-main\"\n    >\n      <sky-tabset *ngIf=\"enableTabLayout else content\"\n        permalinkId=\"docs\"\n      >\n        <sky-tab tabHeading=\"Design\">\n          <ng-content\n            select=\"sky-docs-design-guidelines\"\n          ></ng-content>\n        </sky-tab>\n\n        <sky-tab tabHeading=\"Development\">\n          <ng-container\n            [ngTemplateOutlet]=\"content\"\n          ></ng-container>\n        </sky-tab>\n      </sky-tabset>\n    </div>\n  </stache>\n</div>\n\n<ng-template #content>\n  <sky-docs-demo-page-section *ngIf=\"moduleName\"\n    heading=\"Installation\"\n  >\n    <sky-docs-module-info\n      [gitRepoUrl]=\"gitRepoUrl\"\n      [moduleName]=\"moduleName\"\n      [packageName]=\"packageName\"\n      [packageUrl]=\"packageUrl\"\n    >\n      <ng-content\n        select=\"sky-docs-demo-page-module-info\"\n      ></ng-content>\n    </sky-docs-module-info>\n  </sky-docs-demo-page-section>\n\n  <ng-content></ng-content>\n\n  <sky-docs-demo-page-type-definitions\n    [moduleSourceCodePath]=\"moduleSourceCodePath\"\n  >\n  </sky-docs-demo-page-type-definitions>\n\n  <sky-docs-demo-page-section *ngIf=\"enableCodeExamples\"\n    heading=\"Code examples\"\n  >\n    <ng-content\n      select=\"sky-docs-code-examples\"\n    ></ng-content>\n  </sky-docs-demo-page-section>\n</ng-template>\n",
                 providers: [
                     SkyDocsDemoPageDomAdapterService
                 ],
@@ -3175,6 +3198,7 @@
                 imports: [
                     common.CommonModule,
                     router.RouterModule,
+                    indicators.SkyAlertModule,
                     skyuxLibCodeBlock.SkyCodeBlockModule,
                     skyuxLibCodeBlock.SkyCodeModule,
                     SkyDocsDemoModule,