@camera.ui/server 0.0.48 → 0.0.50-internal.0

package/src/api/types/index.ts

@@ -0,0 +1,675 @@
+import type { AuthConfig } from '@camera.ui/rpc-common';
+import type { CameraExtension, CameraExtensions, DetectionZone, ProbeConfig, SchemaConfig } from '@camera.ui/types';
+import type { Readable } from 'node:stream';
+import type { PLUGIN_STATUS, PluginContract } from '../../plugins/types.js';
+import type { LoggingLevel } from '../../services/config/types.js';
+import type { DBCamera, DBCamviewLayout, DBRoles, DBUser } from '../database/types.js';
+import type { ApplicationResponse, DeviceSourceType } from '../go2rtc/types.js';
+import type { RestoreBackupInput } from '../schemas/backup.schema.js';
+import type { CreateCameraInput, PairCameraInput, PatchCameraInput, PreviewCameraInput } from '../schemas/cameras.schema.js';
+import type { PatchConfigInput } from '../schemas/config.schema.js';
+import type { PatchGo2RtcConfigInput } from '../schemas/go2rtc.schema.js';
+import type { DetectAudioInput, DetectMotionInput, DetectObjectInput } from '../schemas/plugins.schema.js';
+import type { PatchStorateInput, SetStorageInput, SubmitStorageInput } from '../schemas/storage.schema.js';
+import type { PatchSystemInput } from '../schemas/system.schema.js';
+import type {
+  CreateShortcutInput,
+  CreateUserInput,
+  CreateViewInput,
+  LoginUserInput,
+  PatchShortcutInput,
+  PatchUserInput,
+  PatchViewInput,
+} from '../schemas/users.schema.js';
+
+export interface BusboyFileStream extends Readable {
+  truncated: boolean;
+  bytesRead: number;
+}
+
+export interface UiNotification {
+  _id: string;
+  title: string;
+  text: string;
+  timestamp: number;
+  type: LoggingLevel;
+  link?: string;
+}
+
+export interface JwtTokenEncoded {
+  readonly _id: string;
+  access_token: string;
+  refresh_token: string;
+  token_type: string;
+  expires_in: number;
+  expires_at: Date;
+}
+
+export interface UserData extends JwtTokenEncoded {
+  username: string;
+  avatar: string;
+  role: DBRoles;
+  rememberMe: boolean;
+  singleSession: boolean;
+  firstLogin: boolean;
+  sessionTimer: number;
+}
+
+export interface JwtPayload {
+  _id: string;
+  // avatar: string;
+  username: string;
+  // role: DBRoles;
+  // singleSession: boolean;
+  rememberMe: boolean;
+  // firstLogin: boolean;
+  sessionTimer: number;
+}
+
+export interface JwtRefreshPayload {
+  _id: string;
+}
+
+export interface ClientData {
+  _id: string;
+  access_token: string;
+  address?: string;
+  device?: string;
+}
+
+export const enum REFRESH_TOKEN {
+  EXPIRES_IN = '7d',
+}
+
+export interface CameraCamviewSettings {
+  enabled: boolean;
+  mode: InterfaceStreamMode;
+  imageRefreshTimer: number;
+}
+
+export type InterfaceStreamMode = 'live' | 'snapshot';
+
+export interface JwtTokenDecoded {
+  _id: string;
+  username: string;
+  // avatar: string;
+  // role: DBRoles;
+  // singleSession: boolean;
+  // firstLogin: boolean;
+  rememberMe: boolean;
+  sessionTimer: number;
+  exp: Readonly<number>;
+  iat: Readonly<number>;
+}
+
+export interface JwtRefreshTokenDecoded {
+  _id: string;
+  expires_in: number;
+  expires_at: Date;
+  exp: Readonly<number>;
+  iat: Readonly<number>;
+}
+
+export interface JwtTokenResponse {
+  access_token: string;
+  refresh_token: string;
+}
+
+export interface JwtTokenClientData {
+  token: JwtTokenEncoded;
+  clientData?: ClientData;
+}
+
+export type LogoutResponse = 'OK';
+
+export interface SessionResponse {
+  status: 'OK';
+  statusCode: undefined;
+  message: undefined;
+}
+
+export interface SessionExpiredResponse {
+  status: undefined;
+  statusCode: number;
+  message: string;
+}
+
+export type SessionStatus = SessionResponse | SessionExpiredResponse;
+
+export interface Pagination {
+  pageSize: number;
+  startIndex: number;
+  endIndex: number;
+  totalItems: number;
+  currentPage: number;
+  totalPages: number;
+  nextPageQuery?: string | null;
+  prevPageQuery?: string | null;
+}
+
+export interface PaginationResponse {
+  pagination: Pagination;
+  result: any[];
+}
+
+export interface UsersResponse {
+  pagination: Pagination;
+  result: DBUser[];
+}
+
+export interface ViewsResponse {
+  pagination: Pagination;
+  result: DBCamviewLayout[];
+}
+
+export interface CamerasResponse {
+  pagination: Pagination;
+  result: DBCamera[];
+}
+
+export interface PluginExtension {
+  pluginName: string;
+  displayName: string;
+  type: CameraExtension[];
+}
+
+export interface PluginExtensionConfig extends PluginExtension, SchemaConfig {}
+
+export interface ExtensionsResponse {
+  pagination: Pagination;
+  result: PluginExtension[];
+}
+
+export interface PluginsProgress {
+  pluginName: string;
+  action: 'install' | 'update' | 'uninstall';
+  version: string;
+}
+
+export interface PluginsResponse {
+  pagination: Pagination;
+  result: CameraUiPlugin[];
+}
+
+export interface PluginsProgressResponse {
+  pagination: Pagination;
+  result: PluginsProgress[];
+}
+
+export interface FrameWorkerResponse {
+  pagination: Pagination;
+  result: FrameWorker[];
+}
+
+export interface PluginContractCamera {
+  name: string;
+  extensions: CameraExtensions;
+}
+
+export interface PluginContractResponse {
+  contract: PluginContract;
+  cameras: PluginContractCamera[];
+}
+
+export interface Go2RtcInfoAuth {
+  username: string;
+  password: string;
+}
+
+export interface Go2RtcInfo {
+  url: string;
+  wsURL: string;
+  port: number;
+  info: ApplicationResponse;
+  auth: Partial<Go2RtcInfoAuth>;
+}
+
+export interface NatsInfo {
+  // servers: string[];
+  auth: AuthConfig;
+}
+
+export interface TokenClientDataResponse {
+  pagination: Pagination;
+  result: JwtTokenClientData[];
+}
+
+export interface PaginationQuery {
+  start?: number;
+  page?: number;
+  pageSize?: number;
+}
+
+export interface PaginationRequest {
+  Querystring: PaginationQuery;
+}
+
+export interface AuthParamsRequest {
+  Params: { id: string; username?: string };
+}
+
+export interface AuthLoginRequest {
+  Querystring: { username?: string; password?: string; token?: string };
+}
+
+export interface AuthNewLoginRequest {
+  Body: LoginUserInput;
+}
+
+export interface AuthRefreshRequest {
+  Body: { refresh_token: string };
+}
+
+export interface CamerasParamsRequest {
+  Params: { cameraname: string };
+}
+
+export interface CamerasStreamRequest {
+  Params: { cameraid: string; sourcename: string };
+}
+
+export interface CameraSnapshotQueryRequest {
+  Querystring: { forceNew?: boolean };
+}
+
+export interface CameraDiscoverQueryRequest {
+  Querystring: { type?: DeviceSourceType; src?: string };
+}
+
+export interface CameraProbeSourceQueryRequest {
+  Querystring: ProbeConfig;
+}
+
+export interface CameraSourceParamsRequest {
+  Params: { sourcename: string };
+}
+
+export interface CamerasParamsIdRequest {
+  Params: { cameraid: string };
+}
+
+export interface CamerasExtensionsParamsRequest {
+  Params: { cameraname: string; pluginname: string; scope?: string };
+}
+
+export interface CamerasExtensionsRequest {
+  Querystring: { type: CameraExtension };
+}
+
+export interface CameraZoneInsertPatchRequest {
+  Body: DetectionZone[];
+}
+
+export interface CamerasInsertRequest {
+  Body: CreateCameraInput;
+}
+
+export interface CameraPairRequest {
+  Body: PairCameraInput;
+}
+
+export interface CamerasPreviewRequest {
+  Body: PreviewCameraInput;
+}
+
+export interface CamerasPatchRequest {
+  Body: PatchCameraInput;
+}
+
+export interface StoragePatchRequest {
+  Body: PatchStorateInput;
+}
+
+export interface StorageSetRequest {
+  Body: SetStorageInput;
+}
+
+export interface StorageSubmitRequest {
+  Body: SubmitStorageInput;
+}
+
+export interface ConfigRequest {
+  Querystring: { json?: boolean };
+}
+
+export interface ConfigPatchRequest {
+  Body: PatchConfigInput;
+}
+
+export interface Go2RtcConfigPatchRequest {
+  Body: PatchGo2RtcConfigInput;
+}
+
+export interface FilesParamsRequest {
+  Params: { file: string };
+}
+
+export interface PluginsParamsIdRequest {
+  Params: { pluginid: string };
+}
+
+export interface PluginsParamsNameRequest {
+  Params: { scope?: string; pluginname: string };
+}
+
+export interface FrameWorkerParamsNameRequest {
+  Params: { frameworkername: string };
+}
+
+export interface PluginsParamsRemoveRequest {
+  Querystring: { removeStorage?: boolean };
+}
+
+export interface PluginsQuery {
+  pluginname?: string;
+  pluginversion?: string;
+}
+
+export interface PluginsQueryRequest {
+  Querystring: PluginsQuery;
+}
+
+export interface PluginsInsertRequest {
+  Body: { pluginname: string; pluginversion?: string };
+}
+
+export interface PluginsConfigPatchRequest {
+  Body: Record<string, any>;
+}
+
+export interface PluginsActionRequest {
+  Body: { actionId: string; payload: any };
+}
+
+export interface PluginsDetectMotionRequest {
+  Body: DetectMotionInput;
+}
+
+export interface PluginsDetectObjectRequest {
+  Body: DetectObjectInput;
+}
+
+export interface PluginsDetectAudioRequest {
+  Body: DetectAudioInput;
+}
+
+export interface PluginsInterfaceQueryType {
+  type: 'objectDetection' | 'motionDetection' | 'audioDetection';
+}
+
+export interface UsersParamsRequest {
+  Params: { username: string };
+}
+
+export interface UsersInsertRequest {
+  Body: CreateUserInput & { avatar: string };
+}
+
+export interface UsersPatchRequest {
+  Body: PatchUserInput & { avatar: string };
+}
+
+export interface SystemPatchRequest {
+  Body: PatchSystemInput;
+}
+
+export interface ServerUpdateRequest {
+  Body: { version: string };
+}
+
+export interface ViewsParamsRequest {
+  Params: { viewid: string };
+}
+
+export interface ViewsInsertRequest {
+  Body: CreateViewInput;
+}
+
+export interface ViewsPatchRequest {
+  Body: PatchViewInput;
+}
+
+export interface ShortcutParamsRequest {
+  Params: { shortcutid: string };
+}
+
+export interface ShortcutInsertRequest {
+  Body: CreateShortcutInput;
+}
+
+export interface ShortcutPatchRequest {
+  Body: PatchShortcutInput;
+}
+
+export interface BackupCreateRequest {
+  Body: { localStorage: Partial<UiLocalStorage> };
+}
+
+export interface PluginBackupInfo {
+  id: string;
+  name: string;
+  version: string;
+}
+
+export interface BackupInfo {
+  timestamp: number;
+  platform: string;
+  node: string;
+  version: string;
+  plugins: PluginBackupInfo[];
+  localStorage: Partial<UiLocalStorage>;
+}
+
+export interface BackupStorage {
+  backupDirectory: string;
+  backupFile: string;
+  backupFileName: string;
+}
+
+export type SupportedLanguageAbbreviatons = 'de' | 'en';
+
+export type SupportedThemes = 'light' | 'dark';
+
+export interface ConfigSettings {
+  zoom: number; // 8 - 20
+}
+
+export interface ConsoleSettings {
+  zoom: number; // 8 - 20
+}
+
+export type CamviewSettingsLayoutMode = 'dnd' | 'view';
+
+export type SettingsViews = 'account' | 'appearance' | 'user' | 'recordings' | 'backup' | 'system';
+
+export interface CamviewSettings {
+  dragDisabled?: boolean;
+  viewid?: string;
+}
+
+export interface CamerasSettings {
+  showEvents: boolean;
+}
+
+export interface InterfaceSettinges {
+  showBottomBarOnMobile: boolean;
+  selectedSettingsView: SettingsViews;
+  navbarStayCollapsed: boolean;
+}
+
+export interface UiSettingsLocalStorage {
+  cameras: CamerasSettings;
+  camview: CamviewSettings;
+  config: ConfigSettings;
+  console: ConsoleSettings;
+  interface: InterfaceSettinges;
+}
+
+export interface ThemeLocalStorage {
+  theme: SupportedThemes;
+  autoMode: boolean;
+}
+
+export interface UiLocalStorage {
+  ui: UiSettingsLocalStorage;
+  theme: ThemeLocalStorage;
+  locale: SupportedLanguageAbbreviatons;
+}
+
+export interface BackupRestoreRequest {
+  Body: RestoreBackupInput;
+}
+
+export interface INpmPluginState {
+  updateAvailable: boolean;
+  betaUpdateAvailable: boolean;
+  lastUpdated?: string;
+  latestVersion?: string;
+}
+
+export interface INpmPerson {
+  name?: string;
+  email?: string;
+  homepage?: string;
+  username?: string;
+  url?: string;
+}
+
+export interface IPackageJson {
+  name: string;
+  displayName?: string;
+  version: string;
+  description?: string;
+  keywords?: string[];
+  homepage?: string;
+  bugs?: string | { email?: string; url?: string };
+  license?: string;
+  author?: string | INpmPerson;
+  maintainers?: INpmPerson[];
+  contributors?: string[] | INpmPerson[];
+  files?: string[];
+  main?: string;
+  bin?: string | Record<string, string>;
+  repository?: string | { type: string; url: string };
+  scripts?: Record<string, string>;
+  dependencies?: Record<string, string>;
+  devDependencies?: Record<string, string>;
+  peerDependencies?: Record<string, string>;
+  optionalDependencies?: Record<string, string>;
+  bundledDependencies?: string[];
+  engines?: Record<string, string>;
+  os?: string[];
+  cpu?: string[];
+  preferGlobal?: boolean;
+  private?: boolean;
+  publishConfig?: { registry?: string };
+  exports?: Record<string, any>;
+  type?: 'module';
+  'camera.ui'?: PluginContract;
+}
+
+export interface INpmRegistryModule {
+  _id: string;
+  _rev: string;
+  name: string;
+  'dist-tags': {
+    latest: string;
+    [key: string]: string;
+  };
+  versions: Record<string, IPackageJson>;
+  time: {
+    created: string;
+    modified: string;
+    [key: string]: string;
+  };
+  maintainers: INpmPerson[];
+  description: string;
+  homepage: string;
+  keywords: string[];
+  repository: { type: string; url: string };
+  author: INpmPerson;
+  bugs: { email?: string; url?: string };
+  license: string;
+  readme: string;
+  readmeFilename: string;
+}
+
+export interface INpmSearchResults {
+  objects: INpmSearchResultItem[];
+}
+
+export interface INpmSearchResultItem {
+  package: {
+    name: string;
+    scoped: string;
+    version: string;
+    description: string;
+    keywords: string[];
+    date: string;
+    links: {
+      npm: string;
+      homebridge?: string;
+      repository?: string;
+      bugs?: string;
+    };
+    author: INpmPerson;
+    publisher: INpmPerson;
+    maintainers: INpmPerson[];
+  };
+  flags: {
+    unstable: boolean;
+  };
+  score: {
+    final: number;
+    detail: {
+      quality: number;
+      popularity: number;
+      maintenance: number;
+    };
+  };
+  searchScore: number;
+}
+
+export interface PluginLinks {
+  npm: string;
+  homepage: string;
+}
+
+export interface PluginEngines {
+  node: string;
+  'camera.ui': string;
+}
+
+export interface CameraUiPlugin {
+  id: string;
+  pluginName: string;
+  private: boolean;
+  displayName: string;
+  description?: string;
+  publicPackage?: boolean;
+  installedVersion?: string;
+  latestVersion?: string;
+  lastUpdated?: string;
+  availableVersions?: string[];
+  installPath?: string;
+  globalInstall?: boolean;
+  disabled?: boolean;
+  links?: {
+    npm?: string;
+    homepage?: string;
+    bugs?: string;
+  };
+  author?: string;
+  engines?: {
+    'camera.ui'?: string;
+    node?: string;
+  };
+  'camera.ui': PluginContract;
+  isPython: boolean;
+  isNode: boolean;
+}
+
+export interface FrameWorker {
+  name: string;
+  status: PLUGIN_STATUS;
+}