@cccsaurora/howler-ui 3.1.0-dev.1493 → 3.1.0-dev.1607

package/api/search/user.d.ts

@@ -1,7 +1,35 @@
-import type { HowlerSearchRequest, HowlerSearchResponse } from '@cccsaurora/howler-ui/api/search';
+import type { HowlerSearchRequest } from '@cccsaurora/howler-ui/api/search';
 import type { HowlerUser } from '@cccsaurora/howler-ui/models/entities/HowlerUser';
 export type HowlerApiUser = Omit<HowlerUser, 'username'> & {
     uname: string;
 };
 export declare const uri: () => string;
-export declare const post: (request?: HowlerSearchRequest) => Promise<HowlerSearchResponse<HowlerUser>>;
+export declare const post: (request?: HowlerSearchRequest) => Promise<{
+    items: {
+        avatar?: string;
+        is_admin?: boolean;
+        name: string;
+        email: string;
+        api_quota?: number;
+        classification?: string;
+        apikeys?: [string, string[], string][];
+        groups?: string[];
+        roles?: string[];
+        type: string[];
+        has_password?: boolean;
+        is_active?: boolean;
+        favourite_views?: string[];
+        favourite_analytics?: string[];
+        dashboard?: {
+            entry_id: string;
+            type: 'view' | 'analytic';
+            config: string;
+        }[];
+        refresh_rate?: number;
+        uname: string;
+        username: string;
+    }[];
+    offset: number;
+    rows: number;
+    total: number;
+}>;

package/api/search/user.js

@@ -8,6 +8,9 @@ export const post = async (request) => {
         ...request,
         query: request?.query || 'name:*'
     });
+    if (!response) {
+        throw new Error('Search response was empty.');
+    }
     return {
         ...response,
         items: response.items.map((i) => ({ ...i, username: i.uname }))

package/api/search/view.d.ts

@@ -1,4 +1,4 @@
 import type { HowlerSearchRequest, HowlerSearchResponse } from '@cccsaurora/howler-ui/api/search';
 import type { View } from '@cccsaurora/howler-ui/models/entities/generated/View';
 export declare const uri: () => string;
-export declare const post: (request?: HowlerSearchRequest) => Promise<HowlerSearchResponse<View>>;
+export declare const post: (request?: HowlerSearchRequest) => Promise<HowlerSearchResponse<View> | undefined>;

package/api/socket/viewers.d.ts

@@ -1,2 +1,2 @@
 export declare const uri: (entityId?: string) => string;
-export declare const get: (entityId: string) => Promise<string[]>;
+export declare const get: (entityId: string) => Promise<string[] | undefined>;

package/api/socket/viewers.js

@@ -3,6 +3,6 @@ import { uri as parentUri } from '@cccsaurora/howler-ui/api/socket';
 export const uri = (entityId) => {
     return entityId ? joinAllUri(parentUri(), 'viewers', entityId) : joinAllUri(parentUri(), 'viewers');
 };
-export const get = async (entityId) => {
+export const get = (entityId) => {
     return hget(uri(entityId));
 };

package/api/template/index.d.ts

@@ -2,6 +2,6 @@ import { type HowlerRefreshParam } from '@cccsaurora/howler-ui/api';
 import type { Template } from '@cccsaurora/howler-ui/models/entities/generated/Template';
 export declare const uri: (id?: string) => string;
 export declare const get: () => Promise<Template[]>;
-export declare const post: (newData: Partial<Template>, refresh?: HowlerRefreshParam) => Promise<Template>;
-export declare const put: (id: string, newFields: string[], refresh?: HowlerRefreshParam) => Promise<Template>;
-export declare const del: (id: string, refresh?: HowlerRefreshParam) => Promise<void>;
+export declare const post: (newData: Partial<Template>, refresh?: HowlerRefreshParam) => Promise<Template | undefined>;
+export declare const put: (id: string, newFields: string[], refresh?: HowlerRefreshParam) => Promise<Template | undefined>;
+export declare const del: (id: string, refresh?: HowlerRefreshParam) => Promise<void | undefined>;

package/api/template/index.js

@@ -2,8 +2,8 @@ import { hdelete, hget, hpost, hput, joinAllUri, joinUri, uri as parentUri } fro
 export const uri = (id) => {
     return id ? joinAllUri(parentUri(), 'template', id) : joinUri(parentUri(), 'template');
 };
-export const get = () => {
-    return hget(uri());
+export const get = async () => {
+    return (await hget(uri())) ?? [];
 };
 export const post = (newData, refresh) => {
     return hpost(uri(), newData, undefined, refresh ? new URLSearchParams({ refresh }) : undefined);

package/api/user/avatar/index.d.ts

@@ -1,2 +1,2 @@
 export declare const uri: (username: string) => string;
-export declare const get: (username: string) => Promise<string>;
+export declare const get: (username: string) => Promise<string | undefined>;

package/api/user/groups.d.ts

@@ -3,4 +3,4 @@ export type GroupDetailsResponse = {
     name: string;
 }[];
 export declare const uri: () => string;
-export declare const get: () => Promise<GroupDetailsResponse>;
+export declare const get: () => Promise<GroupDetailsResponse | undefined>;

package/api/user/index.d.ts

@@ -4,8 +4,8 @@ import * as groups from '@cccsaurora/howler-ui/api/user/groups';
 import * as whoami from '@cccsaurora/howler-ui/api/user/whoami';
 import type { HowlerUser } from '@cccsaurora/howler-ui/models/entities/HowlerUser';
 export declare const uri: (username?: string) => string;
-export declare const get: (username: string) => Promise<HowlerUser>;
+export declare const get: (username: string) => Promise<HowlerUser | undefined>;
 export declare const put: (username: string, newData: Partial<HowlerUser> | {
     new_pass: string;
-}, refresh?: HowlerRefreshParam) => Promise<any>;
+}, refresh?: HowlerRefreshParam) => Promise<HowlerUser | undefined>;
 export { avatar, groups, whoami };

package/api/user/whoami.d.ts

@@ -1,3 +1,3 @@
 import type { HowlerUser } from '@cccsaurora/howler-ui/models/entities/HowlerUser';
 export declare const uri: () => string;
-export declare const get: () => Promise<HowlerUser>;
+export declare const get: () => Promise<HowlerUser | undefined>;

package/api/utils/createPermissionsApi.d.ts

@@ -0,0 +1,10 @@
+export type PermissionData = {
+    privilege: string;
+    user_ids: string[];
+};
+type ParentUri = (id: string) => string;
+declare const createPermissionsApi: <T>(parentUri: ParentUri) => {
+    put: (id: string, data: PermissionData) => Promise<T | undefined>;
+    delete: (id: string, data: PermissionData) => Promise<T | undefined>;
+};
+export default createPermissionsApi;

package/api/utils/createPermissionsApi.js

@@ -0,0 +1,10 @@
+// eslint-disable-next-line import/no-cycle
+import { hdelete, hput, joinAllUri } from '@cccsaurora/howler-ui/api';
+const createPermissionsApi = (parentUri) => {
+    const uri = (id) => joinAllUri(parentUri(id), 'permission');
+    return {
+        put: (id, data) => hput(uri(id), data),
+        delete: (id, data) => hdelete(uri(id), data)
+    };
+};
+export default createPermissionsApi;

package/api/v2/case/index.d.ts

@@ -2,8 +2,8 @@ import * as items from '@cccsaurora/howler-ui/api/v2/case/items';
 import * as rules from '@cccsaurora/howler-ui/api/v2/case/rules';
 import type { Case } from '@cccsaurora/howler-ui/models/entities/generated/Case';
 export declare const uri: (id?: string) => string;
-export declare const get: (id: string) => Promise<Case>;
-export declare const post: (newData: Partial<Case>) => Promise<Case>;
-export declare const put: (id: string, _case: Partial<Case>) => Promise<Case>;
-export declare const del: (id: string) => Promise<void>;
+export declare const get: (id: string) => Promise<Case | undefined>;
+export declare const post: (newData: Partial<Case>) => Promise<Case | undefined>;
+export declare const put: (id: string, _case: Partial<Case>) => Promise<Case | undefined>;
+export declare const del: (id: string) => Promise<void | undefined>;
 export { items, rules };

package/api/v2/case/items.d.ts

@@ -1,9 +1,9 @@
 import type { Case } from '@cccsaurora/howler-ui/models/entities/generated/Case';
 import type { Item } from '@cccsaurora/howler-ui/models/entities/generated/Item';
 export declare const uri: (id: string) => string;
-export declare const post: (id: string, newData: Item) => Promise<Case>;
-export declare const del: (id: string, ids: string | string[], force?: boolean) => Promise<Case>;
+export declare const post: (id: string, newData: Item) => Promise<Case | undefined>;
+export declare const del: (id: string, ids: string | string[], force?: boolean) => Promise<Case | undefined>;
 export declare const put: (caseId: string, id: string, payload?: {
     name?: string;
     parent?: string;
-}) => Promise<Case>;
+}) => Promise<Case | undefined>;

package/api/v2/case/rules.d.ts

@@ -1,6 +1,6 @@
 import type { Case } from '@cccsaurora/howler-ui/models/entities/generated/Case';
 import type { Rule } from '@cccsaurora/howler-ui/models/entities/generated/Rule';
 export declare const uri: (caseId: string, ruleId?: string) => string;
-export declare const post: (caseId: string, ruleData: Partial<Rule>) => Promise<Case>;
-export declare const del: (caseId: string, ruleId: string) => Promise<Case>;
-export declare const put: (caseId: string, ruleId: string, data: Partial<Rule>) => Promise<Case>;
+export declare const post: (caseId: string, ruleData: Partial<Rule>) => Promise<Case | undefined>;
+export declare const del: (caseId: string, ruleId: string) => Promise<Case | undefined>;
+export declare const put: (caseId: string, ruleId: string, data: Partial<Rule>) => Promise<Case | undefined>;

package/api/v2/fuzzy.d.ts

@@ -14,4 +14,4 @@ export type FuzzySearchItem<T = Hit | Event | Case> = T & {
     _score: number;
 };
 export declare const uri: () => string;
-export declare const post: (request: FuzzySearchRequest) => Promise<HowlerSearchResponse<FuzzySearchItem>>;
+export declare const post: <R = Hit | Event | Case>(request: FuzzySearchRequest) => Promise<HowlerSearchResponse<FuzzySearchItem<R>> | undefined>;

package/api/v2/search/facet.d.ts

@@ -1,3 +1,3 @@
 import type { HowlerFacetSearchRequest, HowlerFacetSearchResponse } from '@cccsaurora/howler-ui/api/search/facet';
 export declare const uri: (indexes: string[]) => string;
-export declare const post: (indexes: string | string[], request?: HowlerFacetSearchRequest) => Promise<HowlerFacetSearchResponse>;
+export declare const post: (indexes: string | string[], request?: HowlerFacetSearchRequest) => Promise<HowlerFacetSearchResponse | undefined>;

package/api/v2/search/index.d.ts

@@ -2,5 +2,5 @@ import type { HowlerSearchRequest, HowlerSearchResponse } from '@cccsaurora/howl
 import * as facet from './facet';
 export type SearchIndex = 'hit' | 'event' | 'case';
 export declare const uri: (indexes: string[]) => string;
-export declare const post: <T = any>(indexes: SearchIndex | SearchIndex[], request?: HowlerSearchRequest) => Promise<HowlerSearchResponse<T>>;
+export declare const post: <T>(indexes: SearchIndex | SearchIndex[], request?: HowlerSearchRequest) => Promise<HowlerSearchResponse<T> | undefined>;
 export { facet };

package/api/view/favourite.d.ts

@@ -1,7 +1,5 @@
 export declare const uri: (id: string) => string;
-export declare const del: (id: string) => Promise<{
-    success: boolean;
-}>;
+export declare const del: (id: string) => Promise<void | undefined>;
 export declare const post: (id: string) => Promise<{
     success: boolean;
-}>;
+} | undefined>;

package/api/view/index.d.ts

@@ -2,8 +2,12 @@ import { type HowlerRefreshParam } from '@cccsaurora/howler-ui/api';
 import * as favourite from '@cccsaurora/howler-ui/api/view/favourite';
 import type { View } from '@cccsaurora/howler-ui/models/entities/generated/View';
 export declare const uri: (id?: string) => string;
-export declare const get: () => Promise<View[]>;
-export declare const post: (newData: Partial<View>, refresh?: HowlerRefreshParam) => Promise<View>;
-export declare const put: (id: string, partialView: Partial<Omit<View, 'view_id'>>, refresh?: HowlerRefreshParam) => Promise<View>;
-export declare const del: (id: string, refresh?: HowlerRefreshParam) => Promise<void>;
-export { favourite };
+export declare const get: () => Promise<View[] | undefined>;
+export declare const post: (newData: Partial<View>, refresh?: HowlerRefreshParam) => Promise<View | undefined>;
+export declare const put: (id: string, partialView: Partial<Omit<View, 'view_id'>>, refresh?: HowlerRefreshParam) => Promise<View | undefined>;
+export declare const del: (id: string, refresh?: HowlerRefreshParam) => Promise<void | undefined>;
+declare const permission: {
+    put: (id: string, data: import("../utils/createPermissionsApi").PermissionData) => Promise<View | undefined>;
+    delete: (id: string, data: import("../utils/createPermissionsApi").PermissionData) => Promise<View | undefined>;
+};
+export { favourite, permission };

package/api/view/index.js

@@ -1,5 +1,6 @@
 import { hdelete, hget, hpost, hput, joinAllUri, joinUri, uri as parentUri } from '@cccsaurora/howler-ui/api';
 import * as favourite from '@cccsaurora/howler-ui/api/view/favourite';
+import createPermissionsApi from '../utils/createPermissionsApi';
 export const uri = (id) => {
     return id ? joinAllUri(parentUri(), 'view', id) : joinUri(parentUri(), 'view');
 };
@@ -15,4 +16,5 @@ export const put = (id, partialView, refresh) => {
 export const del = (id, refresh) => {
     return hdelete(uri(id), undefined, undefined, refresh ? new URLSearchParams({ refresh }) : undefined);
 };
-export { favourite };
+const permission = createPermissionsApi(uri);
+export { favourite, permission };

package/branding/AppBrand.d.ts

@@ -73,7 +73,7 @@ export declare const SIZES: {
     };
 };
 export declare const BRAND_APPLICATIONS: readonly ['analyticalplatform', 'assemblyline', 'howler'];
-export declare const BRAND_SIZES: string[];
+export declare const BRAND_SIZES: readonly ['xlarge', 'large', 'medium', 'small', 'xsmall'];
 export declare const BRAND_VARIANTS: readonly ['app', 'logo', 'banner-vertical', 'banner-horizontal'];
 export type BrandApplication = (typeof BRAND_APPLICATIONS)[number];
 export type BrandVariant = (typeof BRAND_VARIANTS)[number];
@@ -82,4 +82,4 @@ export declare const AppBrand: ({ application, variant, size }: {
     application: BrandApplication;
     variant: BrandVariant;
     size?: BrandSize;
-}) => import("react/jsx-runtime").JSX.Element;
+}) => import("react").JSX.Element;

package/branding/AppBrand.js

@@ -76,10 +76,10 @@ export const SIZES = {
     }
 };
 export const BRAND_APPLICATIONS = ['analyticalplatform', 'assemblyline', 'howler'];
-export const BRAND_SIZES = Object.keys(SIZES).filter(s => s !== 'app');
+export const BRAND_SIZES = ['xlarge', 'large', 'medium', 'small', 'xsmall'];
 export const BRAND_VARIANTS = ['app', 'logo', 'banner-vertical', 'banner-horizontal'];
 const AppLogo = ({ src, application, variant, size = 'small' }) => {
-    return (_jsx("img", { src: src, alt: `${application} logo`, style: { ...SIZES[size].icon, marginLeft: variant === 'app' && -7 } }));
+    return (_jsx("img", { src: src, alt: `${application} logo`, style: { ...SIZES[size].icon, marginLeft: variant === 'app' ? -7 : undefined } }));
 };
 const AppName = ({ src, application, size = 'small' }) => {
     return _jsx("img", { src: src, alt: application, style: { ...SIZES[size].name } });
@@ -96,8 +96,6 @@ export const AppBrand = ({ application, variant, size = 'small' }) => {
     if (variant === 'logo') {
         return (_jsx(Stack, { direction: "row", alignItems: "center", children: _jsx(AppLogo, { application: application, src: logoSrc, variant: variant, size: size }) }));
     }
-    if (variant === 'app') {
-        size = 'app';
-    }
-    return (_jsxs(Stack, { direction: variant.endsWith('horizontal') || variant === 'app' ? 'row' : 'column', alignItems: "center", style: { width: 'fit-content' }, children: [_jsx(AppLogo, { application: application, src: logoSrc, variant: variant, size: size }), _jsx("div", { style: SIZES[size].divider }), _jsx(AppName, { application: application, src: nameSrc, size: size })] }));
+    const appSize = variant === 'app' ? 'app' : size;
+    return (_jsxs(Stack, { direction: variant.endsWith('horizontal') || variant === 'app' ? 'row' : 'column', alignItems: "center", style: { width: 'fit-content' }, children: [_jsx(AppLogo, { application: application, src: logoSrc, variant: variant, size: appSize }), _jsx("div", { style: SIZES[appSize].divider }), _jsx(AppName, { application: application, src: nameSrc, size: appSize })] }));
 };