@budibase/shared-core 2.8.29 → 2.8.31-alpha.0

package/package.json

@@ -1,45 +1,31 @@
 {
   "name": "@budibase/shared-core",
-  "version": "2.8.29",
+  "version": "2.8.31-alpha.0",
   "description": "Shared data utils",
-  "main": "dist/cjs/src/index.js",
-  "types": "dist/mjs/src/index.d.ts",
+  "main": "src/index.ts",
+  "types": "src/index.ts",
   "exports": {
     ".": {
-      "import": "./dist/mjs/src/index.js",
-      "require": "./dist/cjs/src/index.js"
-    },
-    "./package.json": "./dist/mjs/package.json"
+      "import": "./dist/index.js",
+      "require": "./src/index.ts"
+    }
   },
   "author": "Budibase",
   "license": "GPL-3.0",
   "scripts": {
     "prebuild": "rimraf dist/",
-    "build": "tsc -p tsconfig.build.json && tsc -p tsconfig-cjs.build.json",
+    "build": "tsc -p tsconfig.build.json",
     "build:dev": "yarn prebuild && tsc --build --watch --preserveWatchOutput",
-    "dev:builder": "yarn prebuild && concurrently \"tsc -p tsconfig.build.json --watch\" \"tsc -p tsconfig-cjs.build.json --watch\""
+    "dev:builder": "yarn prebuild && tsc -p tsconfig.json --watch --preserveWatchOutput",
+    "check:types": "tsc -p tsconfig.json --noEmit --paths null"
   },
   "dependencies": {
-    "@budibase/types": "2.8.29"
+    "@budibase/types": "2.8.31-alpha.0"
   },
   "devDependencies": {
     "concurrently": "^7.6.0",
     "rimraf": "3.0.2",
     "typescript": "4.7.3"
   },
-  "nx": {
-    "targets": {
-      "build": {
-        "dependsOn": [
-          {
-            "projects": [
-              "@budibase/types"
-            ],
-            "target": "build"
-          }
-        ]
-      }
-    }
-  },
-  "gitHead": "c5b487659606add604ff3211f422c26c4924bc35"
+  "gitHead": "38e2c52eb34c0fae42da6e7f346996c379cd281f"
 }

package/src/constants.ts

@@ -86,7 +86,13 @@ export enum BuilderSocketEvent {
   TableChange = "TableChange",
   DatasourceChange = "DatasourceChange",
   LockTransfer = "LockTransfer",
+  ScreenChange = "ScreenChange",
+  AppMetadataChange = "AppMetadataChange",
+  SelectResource = "SelectResource",
+  AppPublishChange = "AppPublishChange",
+  AutomationChange = "AutomationChange",
 }
 
 export const SocketSessionTTL = 60
+export const ValidQueryNameRegex = /^[^()]*$/
 export const ValidColumnNameRegex = /^[_a-zA-Z0-9\s]*$/g

package/src/index.ts

@@ -2,3 +2,4 @@ export * from "./constants"
 export * as dataFilters from "./filters"
 export * as helpers from "./helpers"
 export * as utils from "./utils"
+export * as sdk from "./sdk"

package/src/sdk/documents/applications.ts

@@ -0,0 +1,35 @@
+import { DocumentType, prefixed } from "@budibase/types"
+
+const APP_PREFIX = prefixed(DocumentType.APP)
+const APP_DEV_PREFIX = prefixed(DocumentType.APP_DEV)
+
+export function getDevAppID(appId: string) {
+  if (!appId) {
+    throw new Error("No app ID provided")
+  }
+  if (appId.startsWith(APP_DEV_PREFIX)) {
+    return appId
+  }
+  // split to take off the app_ element, then join it together incase any other app_ exist
+  const split = appId.split(APP_PREFIX)
+  split.shift()
+  const rest = split.join(APP_PREFIX)
+  return `${APP_DEV_PREFIX}${rest}`
+}
+
+/**
+ * Convert a development app ID to a deployed app ID.
+ */
+export function getProdAppID(appId: string) {
+  if (!appId) {
+    throw new Error("No app ID provided")
+  }
+  if (!appId.startsWith(APP_DEV_PREFIX)) {
+    return appId
+  }
+  // split to take off the app_dev element, then join it together incase any other app_ exist
+  const split = appId.split(APP_DEV_PREFIX)
+  split.shift()
+  const rest = split.join(APP_DEV_PREFIX)
+  return `${APP_PREFIX}${rest}`
+}

package/src/sdk/documents/index.ts

@@ -0,0 +1,2 @@
+export * as applications from "./applications"
+export * as users from "./users"

package/src/sdk/documents/users.ts

@@ -0,0 +1,62 @@
+import { ContextUser, User } from "@budibase/types"
+import { getProdAppID } from "./applications"
+
+// checks if a user is specifically a builder, given an app ID
+export function isBuilder(user: User | ContextUser, appId?: string): boolean {
+  if (!user) {
+    return false
+  }
+  if (user.builder?.global) {
+    return true
+  } else if (appId && user.builder?.apps?.includes(getProdAppID(appId))) {
+    return true
+  }
+  return false
+}
+
+export function isGlobalBuilder(user: User | ContextUser): boolean {
+  return (isBuilder(user) && !hasAppBuilderPermissions(user)) || isAdmin(user)
+}
+
+// alias for hasAdminPermission, currently do the same thing
+// in future whether someone has admin permissions and whether they are
+// an admin for a specific resource could be separated
+export function isAdmin(user: User | ContextUser): boolean {
+  if (!user) {
+    return false
+  }
+  return hasAdminPermissions(user)
+}
+
+export function isAdminOrBuilder(
+  user: User | ContextUser,
+  appId?: string
+): boolean {
+  return isBuilder(user, appId) || isAdmin(user)
+}
+
+// check if they are a builder within an app (not necessarily a global builder)
+export function hasAppBuilderPermissions(user?: User | ContextUser): boolean {
+  if (!user) {
+    return false
+  }
+  const appLength = user.builder?.apps?.length
+  const isGlobalBuilder = !!user.builder?.global
+  return !isGlobalBuilder && appLength != null && appLength > 0
+}
+
+// checks if a user is capable of building any app
+export function hasBuilderPermissions(user?: User | ContextUser): boolean {
+  if (!user) {
+    return false
+  }
+  return user.builder?.global || hasAppBuilderPermissions(user)
+}
+
+// checks if a user is capable of being an admin
+export function hasAdminPermissions(user?: User | ContextUser): boolean {
+  if (!user) {
+    return false
+  }
+  return !!user.admin?.global
+}

package/src/sdk/index.ts

@@ -0,0 +1 @@
+export * from "./documents"

package/tsconfig.build.json

@@ -1,8 +1,25 @@
 {
-  "extends": "./tsconfig-base.build.json",
   "compilerOptions": {
-    "module": "esnext",
-    "outDir": "dist/mjs/src",
-    "target": "esnext"
-  }
+    "target": "es6",
+    "moduleResolution": "node",
+    "lib": ["es2020"],
+    "strict": true,
+    "noImplicitAny": true,
+    "esModuleInterop": true,
+    "resolveJsonModule": true,
+    "incremental": true,
+    "sourceMap": true,
+    "declaration": true,
+    "types": ["node"],
+    "outDir": "dist",
+    "skipLibCheck": true
+  },
+  "include": ["**/*.js", "**/*.ts"],
+  "exclude": [
+    "node_modules",
+    "dist",
+    "**/*.spec.ts",
+    "**/*.spec.js",
+    "__mocks__"
+  ]
 }

package/tsconfig.json

@@ -1,10 +1,13 @@
 {
   "extends": "./tsconfig.build.json",
   "compilerOptions": {
-    "composite": true,
     "baseUrl": ".",
+    "rootDir": "./src",
+    "composite": true,
+    "tsBuildInfoFile": "dist/tsconfig.tsbuildinfo",
     "paths": {
-      "@budibase/types": ["../types/src"]
+      "@budibase/types": ["../../types/src"]
     }
-  }
+  },
+  "exclude": ["node_modules", "dist"]
 }

package/dist/cjs/src/constants.d.ts

@@ -1,87 +0,0 @@
-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"
-}
-export declare const SocketSessionTTL = 60;
-export declare const ValidColumnNameRegex: RegExp;

package/dist/cjs/src/constants.js

@@ -1,94 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ValidColumnNameRegex = exports.SocketSessionTTL = exports.BuilderSocketEvent = exports.GridSocketEvent = exports.SocketEvent = exports.SqlNumberTypeRangeMap = exports.OperatorOptions = void 0;
-exports.OperatorOptions = {
-    Equals: {
-        value: "equal",
-        label: "Equals",
-    },
-    NotEquals: {
-        value: "notEqual",
-        label: "Not equals",
-    },
-    Empty: {
-        value: "empty",
-        label: "Is empty",
-    },
-    NotEmpty: {
-        value: "notEmpty",
-        label: "Is not empty",
-    },
-    StartsWith: {
-        value: "string",
-        label: "Starts with",
-    },
-    Like: {
-        value: "fuzzy",
-        label: "Like",
-    },
-    MoreThan: {
-        value: "rangeLow",
-        label: "More than or equal to",
-    },
-    LessThan: {
-        value: "rangeHigh",
-        label: "Less than or equal to",
-    },
-    Contains: {
-        value: "contains",
-        label: "Contains",
-    },
-    NotContains: {
-        value: "notContains",
-        label: "Does not contain",
-    },
-    In: {
-        value: "oneOf",
-        label: "Is in",
-    },
-    ContainsAny: {
-        value: "containsAny",
-        label: "Has any",
-    },
-};
-exports.SqlNumberTypeRangeMap = {
-    integer: {
-        max: 2147483647,
-        min: -2147483648,
-    },
-    int: {
-        max: 2147483647,
-        min: -2147483648,
-    },
-    smallint: {
-        max: 32767,
-        min: -32768,
-    },
-    mediumint: {
-        max: 8388607,
-        min: -8388608,
-    },
-};
-var SocketEvent;
-(function (SocketEvent) {
-    SocketEvent["UserUpdate"] = "UserUpdate";
-    SocketEvent["UserDisconnect"] = "UserDisconnect";
-    SocketEvent["Heartbeat"] = "Heartbeat";
-})(SocketEvent = exports.SocketEvent || (exports.SocketEvent = {}));
-var GridSocketEvent;
-(function (GridSocketEvent) {
-    GridSocketEvent["RowChange"] = "RowChange";
-    GridSocketEvent["TableChange"] = "TableChange";
-    GridSocketEvent["SelectTable"] = "SelectTable";
-    GridSocketEvent["SelectCell"] = "SelectCell";
-})(GridSocketEvent = exports.GridSocketEvent || (exports.GridSocketEvent = {}));
-var BuilderSocketEvent;
-(function (BuilderSocketEvent) {
-    BuilderSocketEvent["SelectApp"] = "SelectApp";
-    BuilderSocketEvent["TableChange"] = "TableChange";
-    BuilderSocketEvent["DatasourceChange"] = "DatasourceChange";
-    BuilderSocketEvent["LockTransfer"] = "LockTransfer";
-})(BuilderSocketEvent = exports.BuilderSocketEvent || (exports.BuilderSocketEvent = {}));
-exports.SocketSessionTTL = 60;
-exports.ValidColumnNameRegex = /^[_a-zA-Z0-9\s]*$/g;
-//# sourceMappingURL=constants.js.map

package/dist/cjs/src/constants.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../../src/constants.ts"],"names":[],"mappings":";;;AAAa,QAAA,eAAe,GAAG;IAC7B,MAAM,EAAE;QACN,KAAK,EAAE,OAAO;QACd,KAAK,EAAE,QAAQ;KAChB;IACD,SAAS,EAAE;QACT,KAAK,EAAE,UAAU;QACjB,KAAK,EAAE,YAAY;KACpB;IACD,KAAK,EAAE;QACL,KAAK,EAAE,OAAO;QACd,KAAK,EAAE,UAAU;KAClB;IACD,QAAQ,EAAE;QACR,KAAK,EAAE,UAAU;QACjB,KAAK,EAAE,cAAc;KACtB;IACD,UAAU,EAAE;QACV,KAAK,EAAE,QAAQ;QACf,KAAK,EAAE,aAAa;KACrB;IACD,IAAI,EAAE;QACJ,KAAK,EAAE,OAAO;QACd,KAAK,EAAE,MAAM;KACd;IACD,QAAQ,EAAE;QACR,KAAK,EAAE,UAAU;QACjB,KAAK,EAAE,uBAAuB;KAC/B;IACD,QAAQ,EAAE;QACR,KAAK,EAAE,WAAW;QAClB,KAAK,EAAE,uBAAuB;KAC/B;IACD,QAAQ,EAAE;QACR,KAAK,EAAE,UAAU;QACjB,KAAK,EAAE,UAAU;KAClB;IACD,WAAW,EAAE;QACX,KAAK,EAAE,aAAa;QACpB,KAAK,EAAE,kBAAkB;KAC1B;IACD,EAAE,EAAE;QACF,KAAK,EAAE,OAAO;QACd,KAAK,EAAE,OAAO;KACf;IACD,WAAW,EAAE;QACX,KAAK,EAAE,aAAa;QACpB,KAAK,EAAE,SAAS;KACjB;CACF,CAAA;AAEY,QAAA,qBAAqB,GAAG;IACnC,OAAO,EAAE;QACP,GAAG,EAAE,UAAU;QACf,GAAG,EAAE,CAAC,UAAU;KACjB;IACD,GAAG,EAAE;QACH,GAAG,EAAE,UAAU;QACf,GAAG,EAAE,CAAC,UAAU;KACjB;IACD,QAAQ,EAAE;QACR,GAAG,EAAE,KAAK;QACV,GAAG,EAAE,CAAC,KAAK;KACZ;IACD,SAAS,EAAE;QACT,GAAG,EAAE,OAAO;QACZ,GAAG,EAAE,CAAC,OAAO;KACd;CACF,CAAA;AAED,IAAY,WAIX;AAJD,WAAY,WAAW;IACrB,wCAAyB,CAAA;IACzB,gDAAiC,CAAA;IACjC,sCAAuB,CAAA;AACzB,CAAC,EAJW,WAAW,GAAX,mBAAW,KAAX,mBAAW,QAItB;AAED,IAAY,eAKX;AALD,WAAY,eAAe;IACzB,0CAAuB,CAAA;IACvB,8CAA2B,CAAA;IAC3B,8CAA2B,CAAA;IAC3B,4CAAyB,CAAA;AAC3B,CAAC,EALW,eAAe,GAAf,uBAAe,KAAf,uBAAe,QAK1B;AAED,IAAY,kBAKX;AALD,WAAY,kBAAkB;IAC5B,6CAAuB,CAAA;IACvB,iDAA2B,CAAA;IAC3B,2DAAqC,CAAA;IACrC,mDAA6B,CAAA;AAC/B,CAAC,EALW,kBAAkB,GAAlB,0BAAkB,KAAlB,0BAAkB,QAK7B;AAEY,QAAA,gBAAgB,GAAG,EAAE,CAAA;AACrB,QAAA,oBAAoB,GAAG,oBAAoB,CAAA"}

package/dist/cjs/src/filters.d.ts

@@ -1,94 +0,0 @@
-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 {};