@evercam/api 1.0.0-003291add

package/dist/api/types/widget.d.ts

@@ -0,0 +1,252 @@
+import { CameraExid, PaginationParams } from "@evercam/api/types";
+import type { JsonObject } from "@evercam/api/types";
+import { VideoWallPresetGridConfig } from "@evercam/api/types/videoWall";
+export declare enum DelayUnit {
+    Minute = "Minutes",
+    Hour = "Hours",
+    Day = "Days"
+}
+export declare enum CommonWidgetSettingsKeys {
+    Width = "width",
+    WidthResolution = "resolution",
+    Height = "height",
+    HeightResolution = "heightResolution"
+}
+export declare enum RecordingsWidgetSettingsKeys {
+    DarkMode = "darkMode",
+    Calendar = "calendar",
+    HasDelay = "hasDelay",
+    Delay = "delay",
+    DelayUnit = "delayUnit",
+    HasRange = "hasRange",
+    DateRange = "dateRange",
+    Width = "width",
+    WidthResolution = "resolution",
+    Height = "height",
+    HeightResolution = "heightResolution"
+}
+export declare enum LiveViewWidgetSettingsKeys {
+    Fullscreen = "fullscreen",
+    Download = "download",
+    Zoom = "zoom",
+    Playpause = "playpause",
+    Refresh = "refresh",
+    Width = "width",
+    WidthResolution = "resolution",
+    Height = "height",
+    HeightResolution = "heightResolution"
+}
+export declare enum BimCompareWidgetSettingsKeys {
+    Timeline = "timeline",
+    Calendar = "calendar",
+    DarkMode = "darkMode",
+    Width = "width",
+    WidthResolution = "resolution",
+    Height = "height",
+    HeightResolution = "heightResolution"
+}
+export declare enum VideoWallWidgetSettingsKeys {
+    Preset = "preset",
+    RefreshRate = "refreshRate",
+    Width = "width",
+    WidthResolution = "resolution",
+    Height = "height",
+    HeightResolution = "heightResolution"
+}
+export declare enum ThreeSixtyKeys {
+    DateId = "dateId",
+    DateLocked = "dateLocked",
+    FloorId = "floorId",
+    FloorLocked = "floorLocked",
+    Marker = "markerId",
+    MarkerLocked = "markerLocked",
+    MediaLocked = "mediaLocked",
+    Width = "width",
+    WidthResolution = "resolution",
+    Height = "height",
+    HeightResolution = "heightResolution"
+}
+export type CommonWidgetSettings = {
+    width: number;
+    resolution: string;
+    height: number;
+    heightResolution: string;
+};
+export type RecordingsWidgetSettings = CommonWidgetSettings & {
+    darkMode: boolean;
+    calendar: boolean;
+    hasDelay: boolean;
+    delay: number;
+    delayUnit: DelayUnit;
+    hasRange: boolean;
+    dateRange: [string, string] | null;
+};
+export type LiveViewWidgetSettings = CommonWidgetSettings & {
+    fullscreen: boolean;
+    download: boolean;
+    zoom: boolean;
+    playpause: boolean;
+    refresh: number;
+};
+export type BimCompareWidgetSettings = CommonWidgetSettings & {
+    timeline: boolean;
+    darkMode: boolean;
+};
+export type VideoWallWidgetSettingsObject = CommonWidgetSettings & {
+    preset: VideoWallPresetGridConfig;
+    refreshRate: number;
+    allowCellFullscreen: boolean;
+    allowFitContent: boolean;
+    allowForceAspectRatio: boolean;
+    allowFullscreen: boolean;
+    cameras: CameraExid[];
+    description: string;
+    global: boolean;
+    visibility: string;
+};
+export type ThreeSixtyWidgetSettings = CommonWidgetSettings & {
+    dateId: string;
+    floorId: string;
+    markerId: string;
+};
+export type WidgetSettings = RecordingsWidgetSettings | LiveViewWidgetSettings | BimCompareWidgetSettings | VideoWallWidgetSettingsObject | ThreeSixtyWidgetSettings;
+export declare enum WidgetType {
+    LiveWidget = "Live View",
+    Recording = "Recordings",
+    BimCompare = "BIM Compare",
+    VideoWall = "Video Wall",
+    ThreeSixty = "360"
+}
+export declare const WidgetTypesByResource: {
+    camera: WidgetType[];
+    project: WidgetType[];
+};
+export type WidgetsListRequestPayload = PaginationParams & {
+    userId: number;
+    projectId: number;
+    cameraId: number;
+    active: boolean;
+    settings: WidgetSettings;
+    widgetType: WidgetType;
+    domainRestricted: boolean;
+    allowedOrigin: string;
+};
+export type Widget = {
+    id: number;
+    ressources: {
+        camera?: {
+            id: number;
+            exid: string;
+            name: string;
+        };
+        project?: {
+            id: number;
+            exid: string;
+            name: string;
+        };
+    };
+    widgetType: WidgetType;
+    settings: WidgetSettings;
+    allowedOrigin: string;
+    domainRestricted: boolean;
+    active: boolean;
+    user: {
+        id: number;
+        email: string;
+        firstname: string;
+        lastname: string;
+    };
+    insertedAt: string;
+    updatedAt: string;
+};
+export type WidgetFull = {
+    id: number;
+    ressources: {
+        camera?: {
+            id: number;
+            exid: string;
+            name: string;
+        };
+        project?: {
+            id: number;
+            exid: string;
+            name: string;
+        };
+    };
+    widgetType: WidgetType;
+    widgetKey: string;
+    widgetId: string;
+    active: boolean;
+    user: {
+        id: number;
+        email: string;
+    };
+    settings: WidgetSettings;
+    sessionSettings: JsonObject | null;
+    allowedOrigin: string;
+    domainRestricted: boolean;
+    insertedAt: string;
+    updatedAt: string;
+};
+export type WidgetSessionSettingsPayload = {
+    sessionSettings: JsonObject;
+};
+export type AdminWidgetResourceCamera = {
+    id: number;
+    exid: string;
+    name: string;
+};
+export type AdminWidgetResourceProject = {
+    id: number;
+    exid: string;
+    name: string;
+    featureFlags: string[];
+};
+export type AdminWidgetResourcePreset = {
+    id: number;
+    name: string;
+    exid: string;
+    config: JsonObject;
+};
+export type AdminWidgetResources = {
+    camera?: AdminWidgetResourceCamera | null;
+    project?: AdminWidgetResourceProject | null;
+    preset?: AdminWidgetResourcePreset | null;
+};
+export type AdminWidgetUser = {
+    id: number;
+    email: string;
+    firstname: string;
+    lastname: string;
+};
+export type AdminWidget = {
+    id: number;
+    active: boolean;
+    public: boolean;
+    user: AdminWidgetUser;
+    description: string | null;
+    insertedAt: string;
+    updatedAt: string;
+    settings: WidgetSettings;
+    ressources: AdminWidgetResources;
+    seenAt?: string;
+    showDashboardLink?: boolean;
+    domainRestricted: boolean;
+    widgetType: WidgetType;
+    allowedOrigin: string | null;
+};
+export type AdminWidgetFull = AdminWidget & {
+    widgetKey: string;
+    widgetId: string;
+};
+export type WidgetPayload = {
+    ressources: {
+        cameraId?: number;
+        projectId?: number;
+    };
+    widgetType: WidgetType;
+    active: boolean;
+    settings: WidgetSettings;
+    domainRestricted: boolean;
+    allowedOrigin: string;
+};

package/dist/api/types/xweather.d.ts

@@ -0,0 +1,12 @@
+export type XWeatherCreatePayload = {
+    stationId: string;
+    clientId: string;
+    clientSecret: string;
+};
+export type XWeatherResponse = {
+    id?: number;
+    provider: "xweather";
+    config: object;
+    insertedAt?: string;
+    updatedAt?: string;
+};

package/dist/api/utils.d.ts

@@ -0,0 +1,10 @@
+export type Falsy = "" | null | undefined | false;
+export interface QueryParams {
+    [k: string]: string | number | boolean | string[] | Falsy;
+}
+export declare const toQueryString: <T extends Record<string, unknown>>(paramsObject?: T | QueryParams, { forceSnakeCase, forceArrayBrackets }?: {
+    forceSnakeCase?: boolean | undefined;
+    forceArrayBrackets?: boolean | undefined;
+}) => string | undefined;
+export declare function queryStringToObject(queryString?: string): QueryParams;
+export declare function capitalizeFirstLetter(inputString: string): string;

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export * from './api/index'
+export {}