API: use version_schema instead of single_version (#198)

The backend API response changed and `single_version` is deprecated now.

Closes #195

Author: humitos

.gitignore

@@ -2,3 +2,4 @@ node_modules/
 .direnv/
 .envrc
 .tool-versions
+/coverage/

dist/readthedocs-addons.js

@@ -14,7 +14,7 @@
       "programming_language": {
         "code": "words"
       },
-      "single_version": false
+      "versioning_scheme": "multiple_versions_with_translations"
     }
   },
   "versions": {

dist/readthedocs-addons.js.map

@@ -167,10 +167,15 @@ const addons_flyout = {
       properties: {
         current: {
           type: "object",
-          required: ["slug", "single_version"],
+          required: ["slug", "versioning_scheme"],
           properties: {
             slug: { type: "string" },
-            single_version: { type: "boolean" },
+            versioning_scheme: {
+              enum: [
+                "multiple_versions_with_translations",
+                "single_version_without_translations",
+              ],
+            },
           },
         },
       },
@@ -278,7 +283,12 @@ const addons_notifications = {
           type: "object",
           properties: {
             slug: { type: "string" },
-            single_version: { type: "boolean" },
+            versioning_scheme: {
+              enum: [
+                "multiple_versions_with_translations",
+                "single_version_without_translations",
+              ],
+            },
             // TODO: use ajv-formats URI type
             repository: {
               type: "object",

public/_/readthedocs-addons.json

@@ -67,7 +67,10 @@ export class FlyoutElement extends LitElement {
 
   renderHeader() {
     let version = nothing;
-    if (!this.config.projects.current.single_version) {
+    if (
+      this.config.projects.current.versioning_scheme !==
+      "single_version_without_translations"
+    ) {
       version = html`<span>v: ${this.config.versions.current.slug}</span>`;
     }
 
@@ -177,7 +180,8 @@ export class FlyoutElement extends LitElement {
   renderVersions() {
     if (
       !this.config.addons.flyout.versions.length ||
-      this.config.projects.current.single_version
+      this.config.projects.current.versioning_scheme ===
+        "single_version_without_translations"
     ) {
       return nothing;
     }

src/data-validation.js

@@ -67,7 +67,8 @@ export class NotificationElement extends LitElement {
 
     if (
       config.addons.non_latest_version_warning.enabled &&
-      !config.projects.current.single_version &&
+      config.projects.current.versioning_scheme !==
+        "single_version_without_translations" &&
       config.versions.current.type !== "external"
     ) {
       this.calculateStableLatestVersionWarning();

src/flyout.js

@@ -47,7 +47,7 @@
             projects: {
               current: {
                 slug: "project",
-                single_version: false,
+                versioning_scheme: "multiple_versions_with_translations",
               },
             },
             versions: {

src/notification.js

@@ -31,7 +31,7 @@ describe("Flyout addon", () => {
         projects: {
           current: {
             slug: "project",
-            single_version: false,
+            versioning_scheme: "multiple_versions_with_translations",
           },
         },
         versions: {
@@ -60,7 +60,7 @@ describe("Flyout addon", () => {
         projects: {
           current: {
             slug: "project",
-            single_version: false,
+            versioning_scheme: "multiple_versions_with_translations",
           },
         },
         versions: {

tests/flyout.test.html

@@ -31,7 +31,7 @@
             projects: {
               current: {
                 slug: "project",
-                single_version: false,
+                versioning_scheme: "multiple_versions_with_translations",
                 repository: {
                   url: "https://github.com/readthedocs/addons",
                 },