feat(develop): merge to master

apps/web/src/api-clients/_common/composables/use-query-key.ts

@@ -0,0 +1,41 @@
+import type { ComputedRef } from 'vue';
+import { computed, reactive } from 'vue';
+
+
+import type { QueryKey } from '@tanstack/vue-query';
+
+import { useAppContextStore } from '@/store/app-context/app-context-store';
+import { useUserWorkspaceStore } from '@/store/app-context/workspace/user-workspace-store';
+
+/**
+ * Generates a computed query key for API requests, incorporating global parameters.
+ *
+ * @param primaryQueryKey - The primary key for the api query (e.g., 'private-dashboard/get'). It follows the `{api-resource-name}/{api-verb}` convention.
+ * @param additionalGlobalParams - Optional additional global parameters to include in the api query key.
+ * @returns A computed reference to the query key array.
+ */
+
+interface GlobalQueryParams {
+    workspaceId?: string;
+    isAdminMode?: boolean;
+}
+export const useAPIQueryKey = (
+    primaryQueryKey: string,
+    additionalGlobalParams?: Partial<GlobalQueryParams>,
+): ComputedRef<QueryKey> => {
+    const appContextStore = useAppContextStore();
+    const userWorkspaceStore = useUserWorkspaceStore();
+
+    const _state = reactive({
+        currentWorkdpaceId: computed<string|undefined>(() => userWorkspaceStore.getters.currentWorkspaceId),
+        isAdminMode: computed<boolean>(() => appContextStore.getters.isAdminMode),
+    });
+
+    const globalQueryParams = reactive<GlobalQueryParams>({
+        workspaceId: _state.currentWorkdpaceId,
+        isAdminMode: _state.isAdminMode,
+        ...additionalGlobalParams,
+    });
+
+    return computed<QueryKey>(() => [primaryQueryKey, { ...globalQueryParams }]);
+};

apps/web/src/api-clients/_common/composables/use-scoped-query.ts

@@ -0,0 +1,79 @@
+/**
+ * useScopedQuery - A custom wrapper around `useQuery` to enforce scope-based API fetching.
+ *
+ * ## Why this hook exists?
+ * This hook was created to integrate **scope-based API access control** with Vue Query.
+ * It ensures that queries are only executed when the user's granted scope matches the required scope.
+ * Additionally, it automatically handles loading states and prevents unnecessary queries.
+ *
+ * ## Functionality
+ * - Extends `useQuery` with **grant scope validation**.
+ * - Runs queries only when **the user’s scope is valid** and the app is **ready**.
+ * - Uses Vue’s **reactivity** to dynamically compute the `enabled` state.
+ * - Supports both **static and reactive `enabled` values**.
+ *
+ * ## Parameters:
+ * - `options`: Standard **Vue Query options** (`UseQueryOptions`).
+ * - `requiredScopes`: A list of **required grant scopes** to determine if the query should execute.
+ *
+ * ## Supported Query Options:
+ * The following options are commonly used within our team:
+ * - `queryKey`: **Unique key** to identify the query in the cache.
+ * - `queryFn`: **Function** to fetch data from the API.
+ * - `select`: **Transform function** to modify response data.
+ * - `initialData`: **Default value** for the query when no data is available.
+ * - `staleTime`: **Cache duration** before the query becomes stale.
+ * - `enabled`: **Boolean or reactive ref** to control when the query should execute.
+ *
+ * ## Example Usage:
+ *
+ * const myQuery = useScopedQuery({
+ *   queryKey: ['dashboard', dashboardId],
+ *   queryFn: () => fetchDashboardData(dashboardId),
+ *   select: (data) => data.results,
+ *   initialData: { results: [] },
+ *   staleTime: 1000 * 60 * 5, // 5 minutes
+ *   enabled: computed(() => isUserAuthorized.value),
+ * }, ['DOMAIN', 'WORKSPACE']);
+ *
+ */
+
+
+import type { MaybeRef } from '@vueuse/core';
+import { toValue } from '@vueuse/core';
+import { computed, reactive } from 'vue';
+
+import type {
+    UseQueryOptions,
+} from '@tanstack/vue-query';
+import { useQuery } from '@tanstack/vue-query';
+
+import type { GrantScope } from '@/schema/identity/token/type';
+
+import { useAppContextStore } from '@/store/app-context/app-context-store';
+import { useUserStore } from '@/store/user/user-store';
+
+export const useScopedQuery = <TQueryFnData = unknown, TError = unknown, TData = TQueryFnData>(
+    options: UseQueryOptions<TQueryFnData, TError, TData>,
+    requiredScopes: GrantScope[] = [],
+) => {
+    const appContextStore = useAppContextStore();
+    const userStore = useUserStore();
+
+    const _state = reactive({
+        currentGrantScope: computed<GrantScope>(() => userStore.state.currentGrantInfo?.scope || 'USER'),
+        isLoading: computed(() => appContextStore.getters.globalGrantLoading),
+        isValidScope: computed(() => requiredScopes.includes(_state.currentGrantScope)),
+    });
+
+    const queryEnabled = computed<boolean>(() => {
+        const _inheritedEnabled = options?.enabled as MaybeRef<boolean> | undefined;
+        if (_inheritedEnabled !== undefined && !toValue(_inheritedEnabled)) return false;
+        return _state.isValidScope && !_state.isLoading;
+    });
+
+    return useQuery<TQueryFnData, TError, TData>({
+        ...options,
+        enabled: queryEnabled,
+    });
+};

apps/web/src/schema/_common/type.ts → apps/web/src/api-clients/_common/schema/type.ts

@@ -1,4 +1,4 @@
-import type { RESOURCE_GROUP } from '@/schema/_common/constant';
+import type { RESOURCE_GROUP } from '@/api-clients/_common/schema/constant';
 
 export type ResourceGroupType = typeof RESOURCE_GROUP[keyof typeof RESOURCE_GROUP];
 

apps/web/src/schema/add-ons/favorite/list.ts → apps/web/src/api-clients/add-ons/favorite/schema/list.ts

@@ -1,5 +1,5 @@
-import type { ListResponse } from '@/schema/_common/api-verbs/list';
-import type { FavoriteModel } from '@/schema/add-ons/favorite/model';
+import type { ListResponse } from '@/api-clients/_common/schema/api-verbs/list';
+import type { FavoriteModel } from '@/api-clients/add-ons/favorite/schema/model';
 
 import type { FavoriteType } from '@/common/modules/favorites/favorite-button/type';
 

apps/web/src/schema/cost-analysis/budget-usage/api-verbs/analyze.ts → apps/web/src/api-clients/cost-analysis/budget-usage/schema/api-verbs/analyze.ts

@@ -1,6 +1,6 @@
 import type { Query } from '@cloudforet/core-lib/space-connector/type';
 
-import type { ResourceGroupType } from '@/schema/_common/type';
+import type { ResourceGroupType } from '@/api-clients/_common/schema/type';
 
 
 export interface BudgetUsageAnalyzeParameters {

apps/web/src/schema/cost-analysis/budget-usage/model.ts → apps/web/src/api-clients/cost-analysis/budget-usage/schema/model.ts

@@ -1,4 +1,4 @@
-import type { ResourceGroupType } from '@/schema/_common/type';
+import type { ResourceGroupType } from '@/api-clients/_common/schema/type';
 
 import type { Currency } from '@/store/display/type';
 

apps/web/src/schema/cost-analysis/budget/api-verbs/create.ts → apps/web/src/api-clients/cost-analysis/budget/schema/api-verbs/create.ts

@@ -1,8 +1,8 @@
-import type { Tags } from '@/schema/_common/model';
-import type { ResourceGroupType } from '@/schema/_common/type';
+import type { Tags } from '@/api-clients/_common/schema/model';
+import type { ResourceGroupType } from '@/api-clients/_common/schema/type';
 import type {
     BudgetNotification, BudgetPlannedLimit, BudgetTimeUnit, ProviderFilter,
-} from '@/schema/cost-analysis/budget/type';
+} from '@/api-clients/cost-analysis/budget/schema/type';
 
 export interface BudgetCreateParameters {
     data_source_id: string;

apps/web/src/schema/cost-analysis/budget/api-verbs/list.ts → apps/web/src/api-clients/cost-analysis/budget/schema/api-verbs/list.ts

@@ -1,6 +1,6 @@
 import type { Query } from '@cloudforet/core-lib/space-connector/type';
 
-import type { BudgetTimeUnit } from '@/schema/cost-analysis/budget/type';
+import type { BudgetTimeUnit } from '@/api-clients/cost-analysis/budget/schema/type';
 
 export interface BudgetListParameters {
     query?: Query

apps/web/src/schema/cost-analysis/budget/api-verbs/set-notification.ts → apps/web/src/api-clients/cost-analysis/budget/schema/api-verbs/set-notification.ts

@@ -1,4 +1,4 @@
-import type { BudgetNotification } from '@/schema/cost-analysis/budget/type';
+import type { BudgetNotification } from '@/api-clients/cost-analysis/budget/schema/type';
 
 export interface BudgetSetNotificationParameters {
     budget_id: string;

apps/web/src/schema/cost-analysis/budget/api-verbs/update.ts → apps/web/src/api-clients/cost-analysis/budget/schema/api-verbs/update.ts

@@ -1,5 +1,5 @@
-import type { Tags } from '@/schema/_common/model';
-import type { BudgetPlannedLimit } from '@/schema/cost-analysis/budget/type';
+import type { Tags } from '@/api-clients/_common/schema/model';
+import type { BudgetPlannedLimit } from '@/api-clients/cost-analysis/budget/schema/type';
 
 export interface BudgetUpdateParameters {
     budget_id: string;

apps/web/src/schema/cost-analysis/budget/model.ts → apps/web/src/api-clients/cost-analysis/budget/schema/model.ts

@@ -1,8 +1,8 @@
-import type { Tags } from '@/schema/_common/model';
-import type { ResourceGroupType } from '@/schema/_common/type';
+import type { Tags } from '@/api-clients/_common/schema/model';
+import type { ResourceGroupType } from '@/api-clients/_common/schema/type';
 import type {
     BudgetNotification, BudgetPlannedLimit, BudgetTimeUnit, ProviderFilter,
-} from '@/schema/cost-analysis/budget/type';
+} from '@/api-clients/cost-analysis/budget/schema/type';
 
 import type { Currency } from '@/store/display/type';
 

apps/web/src/api-clients/cost-analysis/cost-query-set/schema/api-verbs/create.ts

@@ -0,0 +1,10 @@
+import type { Tags } from '@/api-clients/_common/schema/model';
+import type { CostQuerySetOption } from '@/api-clients/cost-analysis/cost-query-set/schema/type';
+
+
+export interface CostQuerySetCreateParameters {
+    data_source_id: string;
+    name: string;
+    options: CostQuerySetOption;
+    tags?: Tags;
+}

apps/web/src/api-clients/cost-analysis/cost-query-set/schema/api-verbs/update.ts

@@ -0,0 +1,10 @@
+import type { Tags } from '@/api-clients/_common/schema/model';
+import type { CostQuerySetOption } from '@/api-clients/cost-analysis/cost-query-set/schema/type';
+
+
+export interface CostQuerySetUpdateParameters {
+    cost_query_set_id: string;
+    name?: string;
+    options?: CostQuerySetOption;
+    tags?: Tags;
+}

apps/web/src/schema/cost-analysis/cost-query-set/model.ts → apps/web/src/api-clients/cost-analysis/cost-query-set/schema/model.ts

@@ -1,5 +1,5 @@
-import type { Tags } from '@/schema/_common/model';
-import type { CostQuerySetOption } from '@/schema/cost-analysis/cost-query-set/type';
+import type { Tags } from '@/api-clients/_common/schema/model';
+import type { CostQuerySetOption } from '@/api-clients/cost-analysis/cost-query-set/schema/type';
 
 
 export interface CostQuerySetModel {

apps/web/src/schema/cost-analysis/cost-report-config/model.ts → apps/web/src/api-clients/cost-analysis/cost-report-config/schema/model.ts

@@ -1,4 +1,4 @@
-import type { CostReportConfigStatus } from '@/schema/cost-analysis/cost-report-config/type';
+import type { CostReportConfigStatus } from '@/api-clients/cost-analysis/cost-report-config/schema/type';
 import type { RoleType } from '@/schema/identity/role/type';
 
 import type { Currency } from '@/store/display/type';

apps/web/src/schema/cost-analysis/cost-report/api-verbs/list.ts → apps/web/src/api-clients/cost-analysis/cost-report/schema/api-verbs/list.ts

@@ -1,6 +1,6 @@
 import type { Query } from '@cloudforet/core-lib/space-connector/type';
 
-import type { CostReportStatus } from '@/schema/cost-analysis/cost-report/type';
+import type { CostReportStatus } from '@/api-clients/cost-analysis/cost-report/schema/type';
 
 
 export interface CostReportListParameters {

apps/web/src/schema/cost-analysis/cost-report/model.ts → apps/web/src/api-clients/cost-analysis/cost-report/schema/model.ts

@@ -1,4 +1,4 @@
-import type { CostReportStatus } from '@/schema/cost-analysis/cost-report/type';
+import type { CostReportStatus } from '@/api-clients/cost-analysis/cost-report/schema/type';
 
 import type { Currency } from '@/store/display/type';
 

apps/web/src/schema/cost-analysis/cost/model.ts → apps/web/src/api-clients/cost-analysis/cost/schema/model.ts

@@ -1,4 +1,4 @@
-import type { Tags } from '@/schema/_common/model';
+import type { Tags } from '@/api-clients/_common/schema/model';
 
 export interface CostModel {
     cost_id: string;

apps/web/src/schema/cost-analysis/data-source/api-verbs/list.ts → apps/web/src/api-clients/cost-analysis/data-source/schema/api-verbs/list.ts

@@ -1,6 +1,6 @@
 import type { Query } from '@cloudforet/core-lib/space-connector/type';
 
-import type { CostDataSourceState, CostDataSourceType } from '@/schema/cost-analysis/data-source/type';
+import type { CostDataSourceState, CostDataSourceType } from '@/api-clients/cost-analysis/data-source/schema/type';
 
 
 export interface CostDataSourceListParameters {

apps/web/src/schema/cost-analysis/data-source/model.ts → apps/web/src/api-clients/cost-analysis/data-source/schema/model.ts

@@ -1,9 +1,7 @@
 import type { JsonSchema } from '@cloudforet/mirinae/types/controls/forms/json-schema-form/type';
 
-import type { ResourceGroupType } from '@/schema/_common/type';
-import type {
-    CostDataSourceSecretType, CostDataSourceType, CostDataSourceSchedule,
-} from '@/schema/cost-analysis/data-source/type';
+import type { ResourceGroupType } from '@/api-clients/_common/schema/type';
+import type { CostDataSourceSecretType, CostDataSourceState, CostDataSourceType } from '@/api-clients/cost-analysis/data-source/schema/type';
 
 
 interface PluginInfoModel {
@@ -31,7 +29,7 @@
 export interface CostDataSourceModel {
     data_source_id: string;
     name: string;
     schedule: CostDataSourceSchedule;
     data_source_type: CostDataSourceType;
     provider: string;
     secret_type: CostDataSourceSecretType;

apps/web/src/schema/cost-analysis/data-source/type.ts → apps/web/src/api-clients/cost-analysis/data-source/schema/type.ts

@@ -1,4 +1,4 @@
-import type { COST_DATA_SOURCE_STATE, COST_DATA_SOURCE_TYPE, COST_DATA_SOURCE_SECRET_TYPE } from '@/schema/cost-analysis/data-source/constant';
+import type { COST_DATA_SOURCE_STATE, COST_DATA_SOURCE_TYPE, COST_DATA_SOURCE_SECRET_TYPE } from './constant';
 
 export type CostDataSourceState = typeof COST_DATA_SOURCE_STATE[keyof typeof COST_DATA_SOURCE_STATE];
 

apps/web/src/schema/cost-analysis/job/model.ts → apps/web/src/api-clients/cost-analysis/job/schema/model.ts

@@ -1,5 +1,6 @@
-import type { ResourceGroupType } from '@/schema/_common/type';
-import type { CostJobStatus } from '@/schema/cost-analysis/job/type';
+import type { ResourceGroupType } from '@/api-clients/_common/schema/type';
+import type { CostJobStatus } from '@/api-clients/cost-analysis/job/schema/type';
+
 
 interface SyncedAccount {
     account_id: string;

apps/web/src/schema/dashboard/_types/dashboard-type.ts → apps/web/src/api-clients/dashboard/_types/dashboard-type.ts

@@ -1,23 +1,25 @@
 import type {
     REFRESH_INTERVAL_OPTIONS_MAP,
     DASHBOARD_TYPE,
-} from '@/schema/dashboard/_constants/dashboard-constant';
-import type { DashboardGlobalVariable } from '@/schema/dashboard/_types/dashboard-global-variable-type';
+} from '@/api-clients/dashboard/_constants/dashboard-constant';
+import type { DashboardGlobalVariable } from '@/api-clients/dashboard/_types/dashboard-global-variable-type';
 import type {
     InheritOptions, WidgetOptions, WidgetSize,
-} from '@/schema/dashboard/_types/widget-type';
-import type { PrivateDashboardChangeFolderParameters } from '@/schema/dashboard/private-dashboard/api-verbs/change-folder';
-import type { PrivateDashboardCreateParameters } from '@/schema/dashboard/private-dashboard/api-verbs/create';
-import type { PrivateDashboardDeleteParameters } from '@/schema/dashboard/private-dashboard/api-verbs/delete';
-import type { PrivateDashboardListParameters } from '@/schema/dashboard/private-dashboard/api-verbs/list';
-import type { PrivateDashboardUpdateParameters } from '@/schema/dashboard/private-dashboard/api-verbs/update';
-import type { PrivateDashboardModel } from '@/schema/dashboard/private-dashboard/model';
-import type { PublicDashboardChangeFolderParameters } from '@/schema/dashboard/public-dashboard/api-verbs/change-folder';
-import type { PublicDashboardCreateParameters } from '@/schema/dashboard/public-dashboard/api-verbs/create';
-import type { PublicDashboardDeleteParameters } from '@/schema/dashboard/public-dashboard/api-verbs/delete';
-import type { PublicDashboardListParameters } from '@/schema/dashboard/public-dashboard/api-verbs/list';
-import type { PublicDashboardUpdateParameters } from '@/schema/dashboard/public-dashboard/api-verbs/update';
-import type { PublicDashboardModel } from '@/schema/dashboard/public-dashboard/model';
+} from '@/api-clients/dashboard/_types/widget-type';
+import type { PrivateDashboardChangeFolderParameters } from '@/api-clients/dashboard/private-dashboard/schema/api-verbs/change-folder';
+import type { PrivateDashboardCreateParameters } from '@/api-clients/dashboard/private-dashboard/schema/api-verbs/create';
+import type { PrivateDashboardDeleteParameters } from '@/api-clients/dashboard/private-dashboard/schema/api-verbs/delete';
+import type { PrivateDashboardGetParameters } from '@/api-clients/dashboard/private-dashboard/schema/api-verbs/get';
+import type { PrivateDashboardListParameters } from '@/api-clients/dashboard/private-dashboard/schema/api-verbs/list';
+import type { PrivateDashboardUpdateParameters } from '@/api-clients/dashboard/private-dashboard/schema/api-verbs/update';
+import type { PrivateDashboardModel } from '@/api-clients/dashboard/private-dashboard/schema/model';
+import type { PublicDashboardChangeFolderParameters } from '@/api-clients/dashboard/public-dashboard/schema/api-verbs/change-folder';
+import type { PublicDashboardCreateParameters } from '@/api-clients/dashboard/public-dashboard/schema/api-verbs/create';
+import type { PublicDashboardDeleteParameters } from '@/api-clients/dashboard/public-dashboard/schema/api-verbs/delete';
+import type { PublicDashboardGetParameters } from '@/api-clients/dashboard/public-dashboard/schema/api-verbs/get';
+import type { PublicDashboardListParameters } from '@/api-clients/dashboard/public-dashboard/schema/api-verbs/list';
+import type { PublicDashboardUpdateParameters } from '@/api-clients/dashboard/public-dashboard/schema/api-verbs/update';
+import type { PublicDashboardModel } from '@/api-clients/dashboard/public-dashboard/schema/model';
 
 import type { VariableModelType } from '@/lib/variable-models';
 import type { Value } from '@/lib/variable-models/_base/types';
@@ -27,12 +29,13 @@ export type DashboardFolderType = 'PUBLIC'|'PRIVATE';
 
 // eslint-disable-next-line @typescript-eslint/ban-ts-comment
 // @ts-ignore
-export type DashboardModel = PublicDashboardModel & PrivateDashboardModel;
+export type DashboardModel = PublicDashboardModel | PrivateDashboardModel;
 export type DashboardCreateParams = PublicDashboardCreateParameters | PrivateDashboardCreateParameters;
 export type DashboardChangeFolderParams = PublicDashboardChangeFolderParameters | PrivateDashboardChangeFolderParameters;
 export type DashboardListParams = PublicDashboardListParameters | PrivateDashboardListParameters;
 export type DashboardUpdateParams = PublicDashboardUpdateParameters | PrivateDashboardUpdateParameters;
 export type DashboardDeleteParams = PublicDashboardDeleteParameters | PrivateDashboardDeleteParameters;
+export type DashboardGetParams = PublicDashboardGetParameters | PrivateDashboardGetParameters;
 
 // dashboard variable schema types
 type VariableSelectionType = 'SINGLE' | 'MULTI';
@@ -67,8 +70,9 @@ export interface DashboardVariablesSchema {
 }
 
 export interface DashboardGlobalVariablesSchema {
-    properties: Record<string, DashboardGlobalVariable>;
+    properties: DashboardGlobalVariableSchemaProperties;
 }
+export type DashboardGlobalVariableSchemaProperties = Record<string, DashboardGlobalVariable>;
 
 // dashboard variables types
 export type DashboardVariables = SingleSelectDashboardVariables | MultiSelectDashboardVariables;

apps/web/src/api-clients/dashboard/_types/folder-type.ts

@@ -0,0 +1,14 @@
+import type { PrivateFolderCreateParameters } from '@/api-clients/dashboard/private-folder/schema/api-verbs/create';
+import type { PrivateFolderDeleteParameters } from '@/api-clients/dashboard/private-folder/schema/api-verbs/delete';
+import type { PrivateFolderUpdateParameters } from '@/api-clients/dashboard/private-folder/schema/api-verbs/update';
+import type { PrivateFolderModel } from '@/api-clients/dashboard/private-folder/schema/model';
+import type { PublicFolderCreateParameters } from '@/api-clients/dashboard/public-folder/schema/api-verbs/create';
+import type { PublicFolderDeleteParameters } from '@/api-clients/dashboard/public-folder/schema/api-verbs/delete';
+import type { PublicFolderUpdateParameters } from '@/api-clients/dashboard/public-folder/schema/api-verbs/update';
+import type { PublicFolderModel } from '@/api-clients/dashboard/public-folder/schema/model';
+
+
+export type FolderModel = PublicFolderModel | PrivateFolderModel;
+export type FolderCreateParams = PublicFolderCreateParameters | PrivateFolderCreateParameters;
+export type FolderUpdateParams = PublicFolderUpdateParameters | PrivateFolderUpdateParameters;
+export type FolderDeleteParams = PublicFolderDeleteParameters | PrivateFolderDeleteParameters;