@budibase/shared-core 3.9.2 → 3.9.4

package/dist/helpers/duplicate.d.ts

@@ -0,0 +1,39 @@
+/**
+ * Duplicates a name with respect to a collection of existing names
+ * e.g.
+ *    name           all names          result
+ *   ------        -----------         --------
+ * ("foo")       ["foo"]              "foo 1"
+ * ("foo")       ["foo", "foo 1"]     "foo 2"
+ * ("foo 1")     ["foo", "foo 1"]     "foo 2"
+ * ("foo")       ["foo", "foo 2"]     "foo 1"
+ *
+ * Repl
+ */
+export declare const duplicateName: (name: string, allNames: string[]) => string;
+/**
+ * More flexible alternative to the above function, which handles getting the
+ * next sequential name from an array of existing items while accounting for
+ * any type of prefix, and being able to deeply retrieve that name from the
+ * existing item array.
+ *
+ * Examples with a prefix of "foo":
+ * [] => "foo"
+ * ["foo"] => "foo2"
+ * ["foo", "foo6"] => "foo7"
+ *
+ * Examples with a prefix of "foo " (space at the end):
+ * [] => "foo"
+ * ["foo"] => "foo 2"
+ * ["foo", "foo 6"] => "foo 7"
+ *
+ * @param items the array of existing items
+ * @param prefix the string prefix of each name, including any spaces desired
+ * @param getName optional function to extract the name for an item, if not a
+ *  flat array of strings
+ */
+export declare const getSequentialName: <T extends unknown>(items: T[] | null, prefix: string | null, { getName, numberFirstItem, separator, }?: {
+    getName?: (item: T) => string;
+    numberFirstItem?: boolean;
+    separator?: string;
+}) => string;

package/dist/helpers/index.d.ts

@@ -7,3 +7,4 @@ export * as schema from "./schema";
 export * as views from "./views";
 export * as roles from "./roles";
 export * as lists from "./lists";
+export * from "./duplicate";

package/dist/helpers/tests/duplicate.test.d.ts

@@ -0,0 +1 @@
+export {};