decidim-api 0.28.2 → 0.29.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bfc163b3464d9c6c0e338f0696ed973109f91ecc3afe8a69102521517b1fda36
-  data.tar.gz: cf99822454e41597390c2df809bc5976d54b0a2e5de7aca957acf8a97b7f6db9
+  metadata.gz: a4f9bdaae8d166f02a55ec472fe0e400d2046f6cb38713381466c572e5f17c5b
+  data.tar.gz: 1b0c10c1c0e0ef7c8661465ace0d185d914173475bf33f6ec6fcb04f03bf626e
 SHA512:
-  metadata.gz: 1c8536ee5c6ea50a30cbd1a66805b5988729b20f1872e5d845099a565e32a30120ee2c5e8e29bef8c7c391c1d56e1cade748885d738d94358ea16903361495ab
-  data.tar.gz: 216ed5e3f45b3812ca21dcf8ebdf83521bf5e61196f00d4cc53387e433367eef35ff691750cbbf59b5f330ec57f4de52d40fc063cdc57630a9f0aee526bb6369
+  metadata.gz: 57da850dc9496e413f1c7c033a51bedb4258414a426bada0e4f41b986ed1cca6d06fc6b5b5f0707f0eaf854b5c802590c3107564fbd79eff04db9fb16873aed4
+  data.tar.gz: 2293c845d89f6ffc9662e67edccf170ae02e4639915b18df8b8cda8441bf9e4375551ee2b492df36be26a97b8b4f7d6ec863a7e5294937c1442cae3215a630ac

data/app/packs/entrypoints/decidim_api_docs.scss

@@ -59,8 +59,7 @@ em {
   bottom: 0;
   width: 250px;
   padding: 0;
-  overflow-x: hidden;
-  overflow-y: scroll;
+  overflow: hidden scroll;
   -webkit-overflow-scrolling: touch;
   -ms-overflow-style: none;
   border-right: 1px solid #eee;

data/app/packs/entrypoints/decidim_api_graphiql.js

@@ -1,85 +1,100 @@
-/* eslint-disable require-jsdoc */
+/* eslint-disable require-jsdoc, react/no-deprecated */
 
 import "entrypoints/decidim_api_graphiql.scss";
 // Styles from node_modules/graphiql/graphiql.css
 // It needs to be done in JS because postcss-import does not find files in node_modules/
-import "graphiql/graphiql.css"
+import "graphiql/graphiql.css";
 
 import React from "react";
-import ReactDOM from "react-dom";
+import { createRoot } from "react-dom/client";
 
-import GraphiQL from "graphiql";
-import Configuration from "src/decidim/configuration"
+import { GraphiQL } from "graphiql"; // eslint-disable-line no-unused-vars
+import Configuration from "src/decidim/configuration";
 
 window.Decidim = window.Decidim || {};
-window.Decidim.config = new Configuration()
+window.Decidim.config = new Configuration();
 
 let parameters = {};
 
 // Parse the search string to get url parameters.
 const search = window.location.search;
-search.substr(1).split("&").forEach(function (entry) {
-  let eq = entry.indexOf("=");
-  if (eq >= 0) {
-    parameters[decodeURIComponent(entry.slice(0, eq))] =
-      decodeURIComponent(entry.slice(eq + 1));
-  }
-});
+search.
+  substr(1).
+  split("&").
+  forEach(function (entry) {
+    let eq = entry.indexOf("=");
+    if (eq >= 0) {
+      parameters[decodeURIComponent(entry.slice(0, eq))] = decodeURIComponent(
+        entry.slice(eq + 1)
+      );
+    }
+  });
 // if variables was provided, try to format it.
 if (parameters.variables) {
   try {
-    parameters.variables =
-      JSON.stringify(JSON.parse(parameters.variables), null, 2);
+    parameters.variables = JSON.stringify(
+      JSON.parse(parameters.variables),
+      null,
+      2
+    );
   } catch (error) {
     // Do nothing, we want to display the invalid JSON as a string, rather
     // than present an error.
   }
 }
 
-const updateURL = function() {
-  const newSearch = Object.keys(parameters).map(function (key) {
-    return `${encodeURIComponent(key)}=${encodeURIComponent(parameters[key])}`;
-  }).join("&");
+const updateURL = function () {
+  const newSearch = Object.keys(parameters).
+    map(function (key) {
+      return `${encodeURIComponent(
+        key
+      )}=${encodeURIComponent(parameters[key])}`;
+    }).
+    join("&");
 
   history.replaceState(null, null, `?${newSearch}`);
-}
+};
 
 // When the query and variables string is edited, update the URL bar so
 // that it can be easily shared
-const onEditQuery = function(newQuery) {
+const onEditQuery = function (newQuery) {
   parameters.query = newQuery;
   updateURL();
-}
+};
 
-const onEditVariables = function(newVariables) {
+const onEditVariables = function (newVariables) {
   parameters.variables = newVariables;
   updateURL();
-}
+};
 
 // Defines a GraphQL fetcher using the fetch API.
-const graphQLFetcher = function(graphQLParams) {
+const graphQLFetcher = function (graphQLParams) {
   const graphQLEndpoint = window.Decidim.config.get("graphql_endpoint");
   return fetch(graphQLEndpoint, {
     method: "post",
     headers: JSON.parse(window.Decidim.config.get("request_headers")),
     body: JSON.stringify(graphQLParams),
     credentials: "include"
-  }).then(function(response) {
+  }).then(function (response) {
     try {
       return response.json();
     } catch (error) {
       return {
-        "status": response.status,
-        "message": "The server responded with invalid JSON, this is probably a server-side error",
-        "response": response.text()
+        status: response.status,
+        message:
+          "The server responded with invalid JSON, this is probably a server-side error",
+        response: response.text()
       };
     }
-  })
-}
+  });
+};
 
 window.addEventListener("DOMContentLoaded", () => {
-  // Render <GraphiQL /> into the body.
-  ReactDOM.render(
+  const container = document.getElementById("graphiql-container");
+
+  const root = createRoot(container);
+
+  root.render(
     React.createElement(GraphiQL, {
       fetcher: graphQLFetcher,
       defaultQuery: window.Decidim.config.get("default_query"),
@@ -87,7 +102,6 @@ window.addEventListener("DOMContentLoaded", () => {
       variables: parameters.variables,
       onEditQuery: onEditQuery,
       onEditVariables: onEditVariables
-    }),
-    document.getElementById("graphiql-container")
-  )
+    })
+  );
 });

data/app/views/decidim/api/documentation/show.html.erb

@@ -1,7 +1,7 @@
 <div class="content">
   <div class="version">Decidim <%= Decidim.version %></div>
 
-  <h1><%= current_organization.name %> API documentation</h1>
+  <h1><%= current_organization_name %> API documentation</h1>
   <% if defined?(graphiql_path) %>
     <%= link_to "Explore the API interactively with GraphiQL", graphiql_path %>
   <% end %>

data/app/views/layouts/decidim/api/documentation.html.erb

@@ -1,6 +1,6 @@
 <html>
   <head>
-    <title><%= current_organization.name %> - API Documentation</title>
+    <title><%= current_organization_name %> - API Documentation</title>
     <%= stylesheet_pack_tag("decidim_api_docs") %>
   </head>
   <body>

data/config/routes.rb

@@ -5,5 +5,5 @@ Decidim::Api::Engine.routes.draw do
   get "/docs", to: "documentation#show", as: :documentation
   get "/docs/*path", to: "documentation#show"
   get "/", to: redirect("/api/docs")
-  post "/" => "queries#create", as: :root
+  post "/" => "queries#create", :as => :root
 end

data/decidim-api.gemspec

@@ -19,7 +19,7 @@ Gem::Specification.new do |s|
     "homepage_uri" => "https://decidim.org",
     "source_code_uri" => "https://github.com/decidim/decidim"
   }
-  s.required_ruby_version = "~> 3.1.0"
+  s.required_ruby_version = "~> 3.2.0"
 
   s.name = "decidim-api"
   s.summary = "Decidim API module"
@@ -32,11 +32,9 @@ Gem::Specification.new do |s|
     end
   end
 
-  s.add_dependency "commonmarker", "~> 0.23.0", ">= 0.23.9"
   s.add_dependency "decidim-core", Decidim::Api.version
-  # Graphql version 2.1 breaks graphql-client compatibility See https://github.com/github/graphql-client/pull/310
-  s.add_dependency "graphql", "~> 2.0.0"
-  s.add_dependency "graphql-docs", "~> 3.0.1"
+  s.add_dependency "graphql", "~> 2.2.6"
+  s.add_dependency "graphql-docs", "~> 4.0"
   s.add_dependency "rack-cors", "~> 1.0"
 
   s.add_development_dependency "decidim-comments", Decidim::Api.version

data/lib/decidim/api/graphiql/config.rb

@@ -7,7 +7,7 @@ module Decidim
         # @example Adding a header to the request
         #    config.headers["My-Header"] = -> (view_context) { "My-Value" }
         #
-        # @return [Hash<String => Proc>] Keys are headers to include in GraphQL requests, values are `->(view_context) { ... }` procs to determin values
+        # @return [Hash<String => Proc>] Keys are headers to include in GraphQL requests, values are `->(view_context) { ... }` procs to determine values
         attr_accessor :headers
 
         attr_accessor :query_params, :initial_query, :csrf, :title, :logo

data/lib/decidim/api/test/shared_examples/statistics_examples.rb

@@ -16,13 +16,12 @@ shared_examples "implements stats type" do
           { "name" => "results_count", "value" => 0 },
           { "name" => "debates_count", "value" => 0 },
           { "name" => "sortitions_count", "value" => 0 },
-          { "name" => "posts_count", "value" => 0 },
-          { "name" => "elections_count", "value" => 0 }
+          { "name" => "posts_count", "value" => 0 }
         ]
       }
     end
 
-    it "executes sucessfully" do
+    it "executes successfully" do
       expect { response }.not_to raise_error
     end
 

data/lib/decidim/api/test/type_context.rb

@@ -3,6 +3,7 @@
 shared_context "with a graphql class type" do
   let!(:current_organization) { create(:organization) }
   let!(:current_user) { create(:user, organization: current_organization) }
+  let!(:current_component) { create(:component) }
   let(:model) { OpenStruct.new({}) }
   let(:type_class) { described_class }
   let(:variables) { {} }
@@ -26,7 +27,8 @@ shared_context "with a graphql class type" do
       root_value:,
       context: {
         current_organization:,
-        current_user:
+        current_user:,
+        current_component:
       },
       variables:
     )

data/lib/decidim/api/version.rb

@@ -4,7 +4,7 @@ module Decidim
   # This holds the decidim-api version.
   module Api
     def self.version
-      "0.28.2"
+      "0.29.0.rc1"
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: decidim-api
 version: !ruby/object:Gem::Version
-  version: 0.28.2
+  version: 0.29.0.rc1
 platform: ruby
 authors:
 - Josep Jaume Rey Peroy
@@ -12,68 +12,48 @@ bindir: bin
 cert_chain: []
 date: 2024-07-16 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: commonmarker
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.23.0
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.23.9
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.23.0
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.23.9
 - !ruby/object:Gem::Dependency
   name: decidim-core
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.28.2
+        version: 0.29.0.rc1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.28.2
+        version: 0.29.0.rc1
 - !ruby/object:Gem::Dependency
   name: graphql
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: 2.2.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: 2.2.6
 - !ruby/object:Gem::Dependency
   name: graphql-docs
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.1
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.1
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: rack-cors
   requirement: !ruby/object:Gem::Requirement
@@ -94,42 +74,42 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.28.2
+        version: 0.29.0.rc1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.28.2
+        version: 0.29.0.rc1
 - !ruby/object:Gem::Dependency
   name: decidim-dev
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.28.2
+        version: 0.29.0.rc1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.28.2
+        version: 0.29.0.rc1
 - !ruby/object:Gem::Dependency
   name: decidim-participatory_processes
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.28.2
+        version: 0.29.0.rc1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.28.2
+        version: 0.29.0.rc1
 description: API engine for decidim
 email:
 - josepjaume@gmail.com
@@ -197,14 +177,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - "~>"
     - !ruby/object:Gem::Version
-      version: 3.1.0
+      version: 3.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: Decidim API module