@budibase/frontend-core 3.16.0 → 3.17.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@budibase/frontend-core",
-  "version": "3.16.0",
+  "version": "3.17.0",
   "description": "Budibase frontend core libraries used in builder and client",
   "author": "Budibase",
   "license": "MPL-2.0",
@@ -17,5 +17,5 @@
     "shortid": "2.2.15",
     "socket.io-client": "^4.7.5"
   },
-  "gitHead": "d20f1f44d10db8eb79d7b7e47c670f3fce502547"
+  "gitHead": "1724cc3c4736c2c48e98aa490b47b2b6c28c05aa"
 }

package/src/api/index.ts

@@ -52,6 +52,7 @@ import { buildNavigationEndpoints } from "./navigation"
 import { buildWorkspaceAppEndpoints } from "./workspaceApps"
 import { buildResourceEndpoints } from "./resource"
 import { buildDeploymentEndpoints } from "./deploy"
+import { buildWorkspaceFavouriteEndpoints } from "./workspaceFavourites"
 import { buildRecaptchaEndpoints } from "./recaptcha"
 
 export type { APIClient } from "./types"
@@ -304,6 +305,7 @@ export const createAPIClient = (config: APIClientConfig = {}): APIClient => {
     oauth2: buildOAuth2Endpoints(API),
     navigation: buildNavigationEndpoints(API),
     workspaceApp: buildWorkspaceAppEndpoints(API),
+    workspace: buildWorkspaceFavouriteEndpoints(API),
     resource: buildResourceEndpoints(API),
     recaptcha: buildRecaptchaEndpoints(API),
   }

package/src/api/types.ts

@@ -39,6 +39,7 @@ import { NavigationEndpoints } from "./navigation"
 import { WorkspaceAppEndpoints } from "./workspaceApps"
 import { ResourceEndpoints } from "./resource"
 import { DeploymentEndpoints } from "./deploy"
+import { WorkspaceFavouriteEndpoints } from "./workspaceFavourites"
 import { RecaptchaEndpoints } from "./recaptcha"
 
 export enum HTTPMethod {
@@ -149,6 +150,7 @@ export type APIClient = BaseAPIClient &
     oauth2: OAuth2Endpoints
     navigation: NavigationEndpoints
     workspaceApp: WorkspaceAppEndpoints
+    workspace: WorkspaceFavouriteEndpoints
     deployment: DeploymentEndpoints
     recaptcha: RecaptchaEndpoints
   }

package/src/api/workspaceFavourites.ts

@@ -0,0 +1,36 @@
+import {
+  WorkspaceFavouriteResponse,
+  AddWorkspaceFavouriteResponse,
+  AddWorkspaceFavouriteRequest,
+} from "@budibase/types"
+import { BaseAPIClient } from "./types"
+
+export interface WorkspaceFavouriteEndpoints {
+  fetch: () => Promise<WorkspaceFavouriteResponse>
+  create: (
+    favourite: AddWorkspaceFavouriteRequest
+  ) => Promise<AddWorkspaceFavouriteResponse>
+  delete: (id: string, rev: string) => Promise<void>
+}
+
+// Add a workspace.favourite qualifier?
+export const buildWorkspaceFavouriteEndpoints = (
+  API: BaseAPIClient
+): WorkspaceFavouriteEndpoints => ({
+  fetch: async () => {
+    return await API.get({
+      url: "/api/workspace/favourites",
+    })
+  },
+  create: async favourite => {
+    return await API.post({
+      url: "/api/workspace/favourites",
+      body: favourite,
+    })
+  },
+  delete: async (id, rev) => {
+    return await API.delete({
+      url: `/api/workspace/favourites/${id}/${rev}`,
+    })
+  },
+})