@budibase/shared-core 2.9.19-alpha.0 → 2.9.20

package/dist/constants.d.ts

@@ -0,0 +1,93 @@
+export declare const OperatorOptions: {
+    Equals: {
+        value: string;
+        label: string;
+    };
+    NotEquals: {
+        value: string;
+        label: string;
+    };
+    Empty: {
+        value: string;
+        label: string;
+    };
+    NotEmpty: {
+        value: string;
+        label: string;
+    };
+    StartsWith: {
+        value: string;
+        label: string;
+    };
+    Like: {
+        value: string;
+        label: string;
+    };
+    MoreThan: {
+        value: string;
+        label: string;
+    };
+    LessThan: {
+        value: string;
+        label: string;
+    };
+    Contains: {
+        value: string;
+        label: string;
+    };
+    NotContains: {
+        value: string;
+        label: string;
+    };
+    In: {
+        value: string;
+        label: string;
+    };
+    ContainsAny: {
+        value: string;
+        label: string;
+    };
+};
+export declare const SqlNumberTypeRangeMap: {
+    integer: {
+        max: number;
+        min: number;
+    };
+    int: {
+        max: number;
+        min: number;
+    };
+    smallint: {
+        max: number;
+        min: number;
+    };
+    mediumint: {
+        max: number;
+        min: number;
+    };
+};
+export declare enum SocketEvent {
+    UserUpdate = "UserUpdate",
+    UserDisconnect = "UserDisconnect",
+    Heartbeat = "Heartbeat"
+}
+export declare enum GridSocketEvent {
+    RowChange = "RowChange",
+    TableChange = "TableChange",
+    SelectTable = "SelectTable",
+    SelectCell = "SelectCell"
+}
+export declare enum BuilderSocketEvent {
+    SelectApp = "SelectApp",
+    TableChange = "TableChange",
+    DatasourceChange = "DatasourceChange",
+    LockTransfer = "LockTransfer",
+    ScreenChange = "ScreenChange",
+    AppMetadataChange = "AppMetadataChange",
+    SelectResource = "SelectResource",
+    AppPublishChange = "AppPublishChange",
+    AutomationChange = "AutomationChange"
+}
+export declare const SocketSessionTTL = 60;
+export declare const ValidQueryNameRegex: RegExp;
+export declare const ValidColumnNameRegex: RegExp;

package/dist/filters.d.ts

@@ -0,0 +1,94 @@
+import { Datasource, FieldType, SortDirection, SortType } from "@budibase/types";
+import { SqlNumberTypeRangeMap } from "./constants";
+/**
+ * Returns the valid operator options for a certain data type
+ * @param type the data type
+ */
+export declare const getValidOperatorsForType: (type: FieldType, field: string, datasource: Datasource & {
+    tableId: any;
+}) => {
+    value: string;
+    label: string;
+}[];
+/**
+ * Operators which do not support empty strings as values
+ */
+export declare const NoEmptyFilterStrings: (keyof QueryFields)[];
+declare type Filter = {
+    operator: keyof Query;
+    field: string;
+    type: any;
+    value: any;
+    externalType: keyof typeof SqlNumberTypeRangeMap;
+};
+declare type Query = QueryFields & QueryConfig;
+declare type QueryFields = {
+    string?: {
+        [key: string]: string;
+    };
+    fuzzy?: {
+        [key: string]: string;
+    };
+    range?: {
+        [key: string]: {
+            high: number | string;
+            low: number | string;
+        };
+    };
+    equal?: {
+        [key: string]: any;
+    };
+    notEqual?: {
+        [key: string]: any;
+    };
+    empty?: {
+        [key: string]: any;
+    };
+    notEmpty?: {
+        [key: string]: any;
+    };
+    oneOf?: {
+        [key: string]: any[];
+    };
+    contains?: {
+        [key: string]: any[];
+    };
+    notContains?: {
+        [key: string]: any[];
+    };
+    containsAny?: {
+        [key: string]: any[];
+    };
+};
+declare type QueryConfig = {
+    allOr?: boolean;
+};
+/**
+ * Builds a lucene JSON query from the filter structure generated in the builder
+ * @param filter the builder filter structure
+ */
+export declare const buildLuceneQuery: (filter: Filter[]) => Query;
+/**
+ * Performs a client-side lucene search on an array of data
+ * @param docs the data
+ * @param query the JSON lucene query
+ */
+export declare const runLuceneQuery: (docs: any[], query?: Query) => any[];
+/**
+ * Performs a client-side sort from the equivalent server-side lucene sort
+ * parameters.
+ * @param docs the data
+ * @param sort the sort column
+ * @param sortOrder the sort order ("ascending" or "descending")
+ * @param sortType the type of sort ("string" or "number")
+ */
+export declare const luceneSort: (docs: any[], sort: string, sortOrder: SortDirection, sortType?: SortType) => any[];
+/**
+ * Limits the specified docs to the specified number of rows from the equivalent
+ * server-side lucene limit parameters.
+ * @param docs the data
+ * @param limit the number of docs to limit to
+ */
+export declare const luceneLimit: (docs: any[], limit: string) => any[];
+export declare const hasFilters: (query?: Query) => boolean;
+export {};

package/dist/helpers/helpers.d.ts

@@ -0,0 +1,29 @@
+import { User } from "@budibase/types";
+/**
+ * Gets a key within an object. The key supports dot syntax for retrieving deep
+ * fields - e.g. "a.b.c".
+ * Exact matches of keys with dots in them take precedence over nested keys of
+ * the same path - e.g. getting "a.b" from { "a.b": "foo", a: { b: "bar" } }
+ * will return "foo" over "bar".
+ * @param obj the object
+ * @param key the key
+ * @return {*|null} the value or null if a value was not found for this key
+ */
+export declare const deepGet: (obj: {
+    [x: string]: any;
+}, key: string) => any;
+/**
+ * Gets the initials to show in a user avatar.
+ * @param user the user
+ */
+export declare const getUserInitials: (user: User) => string;
+/**
+ * Gets a deterministic colour for a particular user
+ * @param user the user
+ */
+export declare const getUserColor: (user: User) => string;
+/**
+ * Gets a friendly label to describe who a user is.
+ * @param user the user
+ */
+export declare const getUserLabel: (user: User) => string;

package/dist/helpers/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./helpers";
+export * from "./integrations";

package/dist/helpers/integrations.d.ts

@@ -0,0 +1,3 @@
+import { Datasource, SourceName } from "@budibase/types";
+export declare function isGoogleSheets(type: SourceName): boolean;
+export declare function isSQL(datasource: Datasource): boolean;

package/dist/index.d.ts

@@ -0,0 +1,5 @@
+export * from "./constants";
+export * as dataFilters from "./filters";
+export * as helpers from "./helpers";
+export * as utils from "./utils";
+export * as sdk from "./sdk";