@scm-manager/ui-api 3.5.0 → 3.5.1-20240910-131436

package/build/index.d.ts

@@ -715,7 +715,7 @@ declare const useSearchHelpContent: (language: string) => {
     error: Error | undefined;
 };
 declare const useSearchSyntaxContent: (language: string) => {
-    data: "### Modifiers\n\nNote: You can not use wildcards as the first character of a search.\n\n|Definition|Example|\n|----------|-------|\n|? - single character Wildcard|\"Ultimate?Repo\" – finds e.g. `Ultimate-Repo`, `Ultimate Repo`, `Ultimate+Repo`|\n|* - multiple character Wildcard|\"Ultimat*y\" - finds e.g. `Ultimate Repository`, `Ultimate-Special-Repository`, `Ultimately`|\n\n### Ranges\n\nRange Queries allow one to match documents whose field(s) values are between the lower and upper bound specified by the Range Query. Range Queries can be inclusive or exclusive of the upper and lower bounds. Sorting is done lexicographically.\n\nRanges are not reserved to numerical fields. \n\n|Definition|Example|\n|----------|-------|\n|[ … TO … ] - inclusive range|\"creationDate:[1609459200000 TO 1612137600000]\" – finds e.G. repositories created between 2021-01-01 and 2021-02-01|\n|{… TO …} - exclusive range|\"name:{Aida TO Carmen}\" – finds e.G. repositories with names between Aida and Carmen, excluding these to values|\n\n### Boosting\n\nBoosting allows you to control the relevance of a document by boosting its term. \n\n|Definition|Example|\n|----------|-------|\n|term^number|\"ultimate^2 repository\" – makes the term `ultimate` more relevant|\n\nBy default, the boost factor is 1. Although the boost factor must be positive, it can be less than 1 (e.g. 0.2)\n\nBy default Repository names are boosted by 1.5, namespace by 1.25.\n\n## Boolean Operators\n\nNote: Logical Operators must be entered in upper case (e.g. \"AND\").\n\n|Operator|Definition|Example|\n|--------|----------|-------|\n|AND|Both terms must be included|\"Ultimate AND Repository\" – finds e.g. `Ultimate Repository`, `Ultimate Special Repository`|\n|OR|At least one of the terms must be included|\"Ultimate OR Repository\" – finds e.g. `Ultimate Repository`, `Ultimate User`, `Special Repository`|\n|NOT|Following term may not be included, \"!\" may be used alternatively|\"Ultimate NOT Repository\" – finds e.g. `Ultimate user`, excludes e.g. `Ultimate Repository`|\n|–|Excludes following term from search|\"Ultimate Repository -Special\" – finds e.g. `Ultimate Repository`, excludes e.g. `Ultimate Special Repository`|\n|+|Following term must be included|\"Ultimate +Repository\" – finds e.g. `my Repository`, `Ultimate Repository`|\n\n## Grouping\n\nSearch supports using parentheses to group clauses to form sub queries. This can be very useful if you want to control the boolean logic for a query.\n\n|Definition|Example|\n|----------|-------|\n|() – terms inside parentheses are grouped together|\"(Ultimate OR my) AND Repository\" – finds e.g. `Ultimate Repository`, `my Repository`, excludes e.g. `Super Repository`. Either \"Ultimate\" or “My” must exist, “Repository” must always exist|\n\n## Phrases\n\nA phrase is a group of terms in a certain order. If you want to search for certain phrases then you can use the `\"` operator.\n\n|Definition|Example|\n|----------|-------|\n|\"\" - terms inside the quotes are searched for as a phrase|\"Ultimate Repository\" – finds `Ultimate Repository` but not `Repository Ultimate`, `Ultimate` or `Repository`|\n\n" | "## Modifikatoren\n\nHinweis: Sie können keine Wildcards als erstes Zeichen einer Suche verwenden.\n\n|Definition|Beispiel|\n|----------|--------|\n|? - Einzelzeichen-Wildcard|\"Ultimate?Repo\" - findet z.B. `Ultimate-Repo`, `Ultimate Repo`, `Ultimate+Repo`|\n|* - mehrstelliger Platzhalter|\"Ultimat*y\" - findet z.B. `Ultimate Repository`, `Ultimates-Spezial-Repository`, `Ultimate`|\n\n### Bereiche\n\nBereichsabfragen ermöglichen den Abgleich von Dokumenten, deren Feldwerte zwischen der unteren und der oberen Grenze liegen, die in der Bereichsabfrage angegeben sind. Bereichsabfragen können die obere und untere Grenze einschließen oder ausschließen. Die Sortierung erfolgt lexikografisch.\n\nBereiche sind nicht auf numerische Felder beschränkt. \n\n|Definition|Beispiel|\n|----------|--------|\n|[ … TO … ] - inklusiver Bereich|\"creationDate:[1609459200000 TO 1612137600000]\" – findet z.B. Repositories, die zwischen dem 01.01.2021 und dem 01.02.2021 angelegt wurden|\n|{… TO …} - ausschließender Bereich|\"name:{Aida TO Carmen}\" – findet Namen zwischen Aida und Carmen, jedoch ohne die beiden Namen einzuschließen|\n\n## Boosten\n\nMit dem Boosting können Sie die Relevanz eines Dokuments steuern, indem Sie seinen Term verstärken.\n\n|Definition|Beispiel|\n|----------|--------|\n|Begriff^Zahl|\"ultimate^2 repository\" – erhöht die Relevanz von `ultimate`|\n\nStandardmäßig ist der Boost-Faktor 1. Obwohl der Boost-Faktor positiv sein muss, kann er kleiner als 1 sein (z. B. 0,2)\n\nStandardmäßig werden Repository-Namen um 1,5 und Namespace-Namen um 1,25 geboostet.\n\n## Boolesche Operatoren\n\nHinweis: Logische Operatoren müssen in Großbuchstaben eingegeben werden (z. B. „AND\").\n\n|Operator|Definition|Beispiel|\n|--------|----------|--------|\n|AND|Beide Terme müssen enthalten sein|\"Ultimate AND Repository\" – findet z.B. `Ultimate Repository`, `Ultimate Special Repository`|\n|OR|Mindestens einer der Terme muss enthalten sein|\"Ultimate OR Repository\" – findet z.B. `Ultimate Repository`, `Ultimate User`, `Special Repository`|\n|NOT|Der nachfolgende Term darf nicht enthalten sein, „!\" kann alternativ verwendet werden|\"Ultimate NOT Repository\" – findet z.B. `Ultimate user`, nicht jedoch z.B. `Ultimate Repository`|\n|–|Schließt den folgenden Term von der Suche aus|\"Ultimate Repository -Special\" – findet z.B. `Ultimate Repository`, schließt z.B. `Ultimate Special Repository` aus|\n|+|Der folgende Term muss enthalten sein|\"Ultimate +Repository\" – findet z.B. `my Repository`, `Ultimate Repository`|\n\n## Gruppieren\n\nDie Suche unterstützt die Verwendung von Klammern zur Gruppierung von Begriffen, um Teilabfragen zu bilden. Dies kann sehr nützlich sein, wenn Sie die boolesche Logik für eine Abfrage steuern möchten.\n\n|Definition|Beispiel|\n|----------|--------|\n|() – Terme zwischen den Klammern werden gruppiert|\"(Ultimate OR my) AND Repository\" – findet z.B. `Ultimate Repository`, `my Repository`, schließt z.B. Super Repository. Entweder \"Ultimate\" oder \"My\" müssen im Ergebnis existieren, \"Repository\" muss immer enthalten sein|\n\n## Phrasen\n\nEine Phrase ist eine Gruppe von Begriffen in einer bestimmten Reihenfolge. Falls man nach einer bestimmten Phrase suchen will, dann kann der `\"`-Operator genutzt werden.\n\n|Definition|Beispiel|\n|----------|--------|\n|\"\" - Begriffe innerhalb der Anführungszeichen werden als Phrase gesucht|\"Ultimate Repository\" – findet `Ultimate Repository` aber nicht `Repository Ultimate`, `Ultimate` oder `Repository`|\n\n" | undefined;
+    data: "### Word Split\n\nSCM-Manager is built for code, and in code one often uses \"CamelCase\" words. To make it easier to search for these words,\nwe split them into separate words for the search. This means that searching for `SomeManager` will also match the term\n`SomeRepositoryManager`. If you want to avoid this, you can simply type your words in small letters only. In the example\nabove, searching for `somemanager` will only match the term `SomeManager` but not `SomeRepositoryManager`.\n\n### Modifiers\n\nNote: You can not use wildcards as the first character of a search.\n\n|Definition|Example|\n|----------|-------|\n|? - single character Wildcard|\"Ultimate?Repo\" – finds e.g. `Ultimate-Repo`, `Ultimate Repo`, `Ultimate+Repo`|\n|* - multiple character Wildcard|\"Ultimat*y\" - finds e.g. `Ultimate Repository`, `Ultimate-Special-Repository`, `Ultimately`|\n\n### Ranges\n\nRange Queries allow one to match documents whose field(s) values are between the lower and upper bound specified by the Range Query. Range Queries can be inclusive or exclusive of the upper and lower bounds. Sorting is done lexicographically.\n\nRanges are not reserved to numerical fields. \n\n|Definition|Example|\n|----------|-------|\n|[ … TO … ] - inclusive range|\"creationDate:[1609459200000 TO 1612137600000]\" – finds e.G. repositories created between 2021-01-01 and 2021-02-01|\n|{… TO …} - exclusive range|\"name:{Aida TO Carmen}\" – finds e.G. repositories with names between Aida and Carmen, excluding these to values|\n\n### Boosting\n\nBoosting allows you to control the relevance of a document by boosting its term. \n\n|Definition|Example|\n|----------|-------|\n|term^number|\"ultimate^2 repository\" – makes the term `ultimate` more relevant|\n\nBy default, the boost factor is 1. Although the boost factor must be positive, it can be less than 1 (e.g. 0.2)\n\nBy default Repository names are boosted by 1.5, namespace by 1.25.\n\n## Boolean Operators\n\nNote: Logical Operators must be entered in upper case (e.g. \"AND\").\n\n|Operator|Definition|Example|\n|--------|----------|-------|\n|AND|Both terms must be included|\"Ultimate AND Repository\" – finds e.g. `Ultimate Repository`, `Ultimate Special Repository`|\n|OR|At least one of the terms must be included|\"Ultimate OR Repository\" – finds e.g. `Ultimate Repository`, `Ultimate User`, `Special Repository`|\n|NOT|Following term may not be included, \"!\" may be used alternatively|\"Ultimate NOT Repository\" – finds e.g. `Ultimate user`, excludes e.g. `Ultimate Repository`|\n|–|Excludes following term from search|\"Ultimate Repository -Special\" – finds e.g. `Ultimate Repository`, excludes e.g. `Ultimate Special Repository`|\n|+|Following term must be included|\"Ultimate +Repository\" – finds e.g. `my Repository`, `Ultimate Repository`|\n\n## Grouping\n\nSearch supports using parentheses to group clauses to form sub queries. This can be very useful if you want to control the boolean logic for a query.\n\n|Definition|Example|\n|----------|-------|\n|() – terms inside parentheses are grouped together|\"(Ultimate OR my) AND Repository\" – finds e.g. `Ultimate Repository`, `my Repository`, excludes e.g. `Super Repository`. Either \"Ultimate\" or “My” must exist, “Repository” must always exist|\n\n## Phrases\n\nA phrase is a group of terms in a certain order. If you want to search for certain phrases then you can use the `\"` operator.\n\nPlease keep in mind, that words are split when they use \"CamelCase\" (like mentioned in the chapter \"Word Split\") even when they are enclosed with `\"`.\n\n|Definition|Example|\n|----------|-------|\n|\"\" - terms inside the quotes are searched for as a phrase|\"Ultimate Repository\" – finds `Ultimate Repository` but not `Repository Ultimate`, `Ultimate` or `Repository`|\n\n" | "## Aufteilug von Wörtern\n\nDer SCM-Manager ist für Code entwickelt und in Code verwendet man oft \"CamelCase\" Wörter. Um die Suche nach diesen Wörtern\nzu erleichtern, werden sie für die Suche in separate Wörter aufgeteilt. Das bedeutet, dass die Suche nach `SomeManager`\nauch den Begriff `SomeRepositoryManager` findet. Wenn Sie dies vermeiden möchten, können Sie Ihre Wörter einfach nur\nin Kleinbuchstaben eingeben. Im obigen Beispiel findet die Suche nach `somemanager` nur den Begriff `SomeManager`,\naber nicht `SomeRepositoryManager`.\n\n## Modifikatoren\n\nHinweis: Sie können keine Wildcards als erstes Zeichen einer Suche verwenden.\n\n|Definition|Beispiel|\n|----------|--------|\n|? - Einzelzeichen-Wildcard|\"Ultimate?Repo\" - findet z.B. `Ultimate-Repo`, `Ultimate Repo`, `Ultimate+Repo`|\n|* - mehrstelliger Platzhalter|\"Ultimat*y\" - findet z.B. `Ultimate Repository`, `Ultimates-Spezial-Repository`, `Ultimate`|\n\n### Bereiche\n\nBereichsabfragen ermöglichen den Abgleich von Dokumenten, deren Feldwerte zwischen der unteren und der oberen Grenze liegen, die in der Bereichsabfrage angegeben sind. Bereichsabfragen können die obere und untere Grenze einschließen oder ausschließen. Die Sortierung erfolgt lexikografisch.\n\nBereiche sind nicht auf numerische Felder beschränkt. \n\n|Definition|Beispiel|\n|----------|--------|\n|[ … TO … ] - inklusiver Bereich|\"creationDate:[1609459200000 TO 1612137600000]\" – findet z.B. Repositories, die zwischen dem 01.01.2021 und dem 01.02.2021 angelegt wurden|\n|{… TO …} - ausschließender Bereich|\"name:{Aida TO Carmen}\" – findet Namen zwischen Aida und Carmen, jedoch ohne die beiden Namen einzuschließen|\n\n## Boosten\n\nMit dem Boosting können Sie die Relevanz eines Dokuments steuern, indem Sie seinen Term verstärken.\n\n|Definition|Beispiel|\n|----------|--------|\n|Begriff^Zahl|\"ultimate^2 repository\" – erhöht die Relevanz von `ultimate`|\n\nStandardmäßig ist der Boost-Faktor 1. Obwohl der Boost-Faktor positiv sein muss, kann er kleiner als 1 sein (z. B. 0,2)\n\nStandardmäßig werden Repository-Namen um 1,5 und Namespace-Namen um 1,25 geboostet.\n\n## Boolesche Operatoren\n\nHinweis: Logische Operatoren müssen in Großbuchstaben eingegeben werden (z. B. „AND\").\n\n|Operator|Definition|Beispiel|\n|--------|----------|--------|\n|AND|Beide Terme müssen enthalten sein|\"Ultimate AND Repository\" – findet z.B. `Ultimate Repository`, `Ultimate Special Repository`|\n|OR|Mindestens einer der Terme muss enthalten sein|\"Ultimate OR Repository\" – findet z.B. `Ultimate Repository`, `Ultimate User`, `Special Repository`|\n|NOT|Der nachfolgende Term darf nicht enthalten sein, „!\" kann alternativ verwendet werden|\"Ultimate NOT Repository\" – findet z.B. `Ultimate user`, nicht jedoch z.B. `Ultimate Repository`|\n|–|Schließt den folgenden Term von der Suche aus|\"Ultimate Repository -Special\" – findet z.B. `Ultimate Repository`, schließt z.B. `Ultimate Special Repository` aus|\n|+|Der folgende Term muss enthalten sein|\"Ultimate +Repository\" – findet z.B. `my Repository`, `Ultimate Repository`|\n\n## Gruppieren\n\nDie Suche unterstützt die Verwendung von Klammern zur Gruppierung von Begriffen, um Teilabfragen zu bilden. Dies kann sehr nützlich sein, wenn Sie die boolesche Logik für eine Abfrage steuern möchten.\n\n|Definition|Beispiel|\n|----------|--------|\n|() – Terme zwischen den Klammern werden gruppiert|\"(Ultimate OR my) AND Repository\" – findet z.B. `Ultimate Repository`, `my Repository`, schließt z.B. Super Repository. Entweder \"Ultimate\" oder \"My\" müssen im Ergebnis existieren, \"Repository\" muss immer enthalten sein|\n\n## Phrasen\n\nEine Phrase ist eine Gruppe von Begriffen in einer bestimmten Reihenfolge. Falls man nach einer bestimmten Phrase suchen will, dann kann der `\"`-Operator genutzt werden.\n\nBitte beachten Sie, dass Wörter getrennt werden, wenn sie \"CamelCase\" verwenden (wie im Abschnitt \"Aufteilug von Wörtern\" erwähnt), auch wenn sie mit `\"` umschlossen sind.\n\n|Definition|Beispiel|\n|----------|--------|\n|\"\" - Begriffe innerhalb der Anführungszeichen werden als Phrase gesucht|\"Ultimate Repository\" – findet `Ultimate Repository` aber nicht `Repository Ultimate`, `Ultimate` oder `Repository`|\n\n" | undefined;
     isLoading: boolean;
     error: Error | undefined;
 };

package/build/index.js

@@ -2911,7 +2911,14 @@ var import_react_query29 = require("react-query");
 var import_react9 = require("react");
 
 // src/help/search/syntax.en.ts
-var syntax_en_default = `### Modifiers
+var syntax_en_default = `### Word Split
+
+SCM-Manager is built for code, and in code one often uses "CamelCase" words. To make it easier to search for these words,
+we split them into separate words for the search. This means that searching for \`SomeManager\` will also match the term
+\`SomeRepositoryManager\`. If you want to avoid this, you can simply type your words in small letters only. In the example
+above, searching for \`somemanager\` will only match the term \`SomeManager\` but not \`SomeRepositoryManager\`.
+
+### Modifiers
 
 Note: You can not use wildcards as the first character of a search.
 
@@ -2967,6 +2974,8 @@ Search supports using parentheses to group clauses to form sub queries. This can
 
 A phrase is a group of terms in a certain order. If you want to search for certain phrases then you can use the \`"\` operator.
 
+Please keep in mind, that words are split when they use "CamelCase" (like mentioned in the chapter "Word Split") even when they are enclosed with \`"\`.
+
 |Definition|Example|
 |----------|-------|
 |"" - terms inside the quotes are searched for as a phrase|"Ultimate Repository" \u2013 finds \`Ultimate Repository\` but not \`Repository Ultimate\`, \`Ultimate\` or \`Repository\`|
@@ -2974,7 +2983,15 @@ A phrase is a group of terms in a certain order. If you want to search for certa
 `;
 
 // src/help/search/syntax.de.ts
-var syntax_de_default = `## Modifikatoren
+var syntax_de_default = `## Aufteilug von W\xF6rtern
+
+Der SCM-Manager ist f\xFCr Code entwickelt und in Code verwendet man oft "CamelCase" W\xF6rter. Um die Suche nach diesen W\xF6rtern
+zu erleichtern, werden sie f\xFCr die Suche in separate W\xF6rter aufgeteilt. Das bedeutet, dass die Suche nach \`SomeManager\`
+auch den Begriff \`SomeRepositoryManager\` findet. Wenn Sie dies vermeiden m\xF6chten, k\xF6nnen Sie Ihre W\xF6rter einfach nur
+in Kleinbuchstaben eingeben. Im obigen Beispiel findet die Suche nach \`somemanager\` nur den Begriff \`SomeManager\`,
+aber nicht \`SomeRepositoryManager\`.
+
+## Modifikatoren
 
 Hinweis: Sie k\xF6nnen keine Wildcards als erstes Zeichen einer Suche verwenden.
 
@@ -3030,6 +3047,8 @@ Die Suche unterst\xFCtzt die Verwendung von Klammern zur Gruppierung von Begriff
 
 Eine Phrase ist eine Gruppe von Begriffen in einer bestimmten Reihenfolge. Falls man nach einer bestimmten Phrase suchen will, dann kann der \`"\`-Operator genutzt werden.
 
+Bitte beachten Sie, dass W\xF6rter getrennt werden, wenn sie "CamelCase" verwenden (wie im Abschnitt "Aufteilug von W\xF6rtern" erw\xE4hnt), auch wenn sie mit \`"\` umschlossen sind.
+
 |Definition|Beispiel|
 |----------|--------|
 |"" - Begriffe innerhalb der Anf\xFChrungszeichen werden als Phrase gesucht|"Ultimate Repository" \u2013 findet \`Ultimate Repository\` aber nicht \`Repository Ultimate\`, \`Ultimate\` oder \`Repository\`|

package/build/index.mjs

@@ -2719,7 +2719,14 @@ import { useQueries, useQuery as useQuery25 } from "react-query";
 import { useEffect as useEffect6, useState as useState3 } from "react";
 
 // src/help/search/syntax.en.ts
-var syntax_en_default = `### Modifiers
+var syntax_en_default = `### Word Split
+
+SCM-Manager is built for code, and in code one often uses "CamelCase" words. To make it easier to search for these words,
+we split them into separate words for the search. This means that searching for \`SomeManager\` will also match the term
+\`SomeRepositoryManager\`. If you want to avoid this, you can simply type your words in small letters only. In the example
+above, searching for \`somemanager\` will only match the term \`SomeManager\` but not \`SomeRepositoryManager\`.
+
+### Modifiers
 
 Note: You can not use wildcards as the first character of a search.
 
@@ -2775,6 +2782,8 @@ Search supports using parentheses to group clauses to form sub queries. This can
 
 A phrase is a group of terms in a certain order. If you want to search for certain phrases then you can use the \`"\` operator.
 
+Please keep in mind, that words are split when they use "CamelCase" (like mentioned in the chapter "Word Split") even when they are enclosed with \`"\`.
+
 |Definition|Example|
 |----------|-------|
 |"" - terms inside the quotes are searched for as a phrase|"Ultimate Repository" \u2013 finds \`Ultimate Repository\` but not \`Repository Ultimate\`, \`Ultimate\` or \`Repository\`|
@@ -2782,7 +2791,15 @@ A phrase is a group of terms in a certain order. If you want to search for certa
 `;
 
 // src/help/search/syntax.de.ts
-var syntax_de_default = `## Modifikatoren
+var syntax_de_default = `## Aufteilug von W\xF6rtern
+
+Der SCM-Manager ist f\xFCr Code entwickelt und in Code verwendet man oft "CamelCase" W\xF6rter. Um die Suche nach diesen W\xF6rtern
+zu erleichtern, werden sie f\xFCr die Suche in separate W\xF6rter aufgeteilt. Das bedeutet, dass die Suche nach \`SomeManager\`
+auch den Begriff \`SomeRepositoryManager\` findet. Wenn Sie dies vermeiden m\xF6chten, k\xF6nnen Sie Ihre W\xF6rter einfach nur
+in Kleinbuchstaben eingeben. Im obigen Beispiel findet die Suche nach \`somemanager\` nur den Begriff \`SomeManager\`,
+aber nicht \`SomeRepositoryManager\`.
+
+## Modifikatoren
 
 Hinweis: Sie k\xF6nnen keine Wildcards als erstes Zeichen einer Suche verwenden.
 
@@ -2838,6 +2855,8 @@ Die Suche unterst\xFCtzt die Verwendung von Klammern zur Gruppierung von Begriff
 
 Eine Phrase ist eine Gruppe von Begriffen in einer bestimmten Reihenfolge. Falls man nach einer bestimmten Phrase suchen will, dann kann der \`"\`-Operator genutzt werden.
 
+Bitte beachten Sie, dass W\xF6rter getrennt werden, wenn sie "CamelCase" verwenden (wie im Abschnitt "Aufteilug von W\xF6rtern" erw\xE4hnt), auch wenn sie mit \`"\` umschlossen sind.
+
 |Definition|Beispiel|
 |----------|--------|
 |"" - Begriffe innerhalb der Anf\xFChrungszeichen werden als Phrase gesucht|"Ultimate Repository" \u2013 findet \`Ultimate Repository\` aber nicht \`Repository Ultimate\`, \`Ultimate\` oder \`Repository\`|

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scm-manager/ui-api",
-  "version": "3.5.0",
+  "version": "3.5.1-20240910-131436",
   "description": "React hook api for the SCM-Manager backend",
   "main": "build/index.js",
   "module": "build/index.mjs",
@@ -29,7 +29,7 @@
     "tsup": "^5.12.6"
   },
   "dependencies": {
-    "@scm-manager/ui-types": "3.5.0",
+    "@scm-manager/ui-types": "3.5.1-20240910-131436",
     "fetch-mock-jest": "^1.5.1",
     "gitdiff-parser": "^0.2.2",
     "query-string": "6.14.1",