camera.ui3 0.0.3-1.alpha.0

package/dist/server/src/api/types/index.d.ts

@@ -0,0 +1,599 @@
+import type { AuthConfig, PLUGIN_STATUS, PluginContract } from '@camera.ui/plugineer';
+import type { CameraExtension, CameraZone, RootSchema } from '@camera.ui/types';
+import type { Readable } from 'node:stream';
+import type { LoggingLevel } from '../../services/config/types.js';
+import type { CameraExtensions, DBCamera, DBCamviewLayout, DBRoles, DBUser } from '../database/types.js';
+import type { ApplicationResponse } from '../go2rtc/types.js';
+import type { RestoreBackupInput } from '../schemas/backup.schema.js';
+import type { CreateCameraInput, 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 { 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 {
+    _id: string;
+    access_token: string;
+    refresh_token: string;
+    token_type: string;
+    expires_in: number;
+    expires_at: Date;
+}
+export interface JwtPayload {
+    _id: string;
+    avatar: string;
+    username: string;
+    role: DBRoles;
+    oneLogin: 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 declare const enum REFRESH_TOKEN {
+    EXPIRES_IN = "7d"
+}
+export declare const PAGINATION_DEFAULTS: PaginationQuery;
+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;
+    oneLogin: 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[];
+    builtIn?: boolean;
+    externPlugin?: boolean;
+}
+export interface PluginExtensionConfig extends PluginExtension {
+    rootSchema?: RootSchema;
+    config?: Record<string, any>;
+}
+export interface ExtensionsResponse {
+    pagination: Pagination;
+    result: PluginExtension[];
+}
+export interface PluginsResponse {
+    pagination: Pagination;
+    result: CameraUiPlugin[];
+}
+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 type PaginationRequest = {
+    Querystring: PaginationQuery;
+};
+export type DownloadLogRequest = {
+    Querystring: {
+        filter?: string;
+    };
+};
+export type AuthParamsRequest = {
+    Params: {
+        id: string;
+        username?: string;
+    };
+};
+export type AuthLoginRequest = {
+    Querystring: {
+        username?: string;
+        password?: string;
+        token?: string;
+    };
+};
+export type AuthNewLoginRequest = {
+    Body: LoginUserInput;
+};
+export type AuthRefreshRequest = {
+    Body: {
+        refresh_token: string;
+    };
+};
+export type AuthTokensRequest = {
+    Querystring: {
+        clientData?: boolean;
+    };
+};
+export type CamerasParamsRequest = {
+    Params: {
+        cameraname: string;
+    };
+};
+export type CameraSourceParamsRequest = {
+    Params: {
+        sourcename: string;
+    };
+};
+export type CamerasParamsIdRequest = {
+    Params: {
+        cameraid: string;
+    };
+};
+export type CameraZonesParamsRequest = {
+    Params: {
+        zonename: string;
+    };
+};
+export type CamerasExtensionsParamsRequest = {
+    Params: {
+        cameraname: string;
+        pluginname: string;
+        scope?: string;
+    };
+};
+export type CamerasExtensionsRequest = {
+    Querystring: {
+        type: CameraExtension;
+    };
+};
+export type CameraZoneInsertPatchRequest = {
+    Body: CameraZone;
+};
+export type CamerasInsertRequest = {
+    Body: CreateCameraInput;
+};
+export type CamerasPreviewRequest = {
+    Body: PreviewCameraInput;
+};
+export type CamerasPatchRequest = {
+    Body: PatchCameraInput;
+};
+export type ExtensionsPatchRequest = {
+    Body: Record<string, any>;
+};
+export type ExtensionsSubmitRequest = {
+    Body: {
+        configPath: string;
+    };
+};
+export type ConfigRequest = {
+    Querystring: {
+        json?: boolean;
+    };
+};
+export type ConfigPatchRequest = {
+    Body: PatchConfigInput;
+};
+export type Go2RtcConfigPatchRequest = {
+    Body: PatchGo2RtcConfigInput;
+};
+export type FilesParamsRequest = {
+    Params: {
+        file: string;
+    };
+};
+export type PluginsParamsIdRequest = {
+    Params: {
+        pluginid: string;
+    };
+};
+export type PluginsParamsNameRequest = {
+    Params: {
+        scope?: string;
+        pluginname: string;
+    };
+};
+export type FrameWorkerParamsNameRequest = {
+    Params: {
+        frameworkername: string;
+    };
+};
+export type PluginsParamsRemoveRequest = {
+    Querystring: {
+        removeStorage?: boolean;
+    };
+};
+export interface PluginsQuery {
+    pluginname?: string;
+    pluginversion?: string;
+}
+export type PluginsQueryRequest = {
+    Querystring: PluginsQuery;
+};
+export type PluginsInsertRequest = {
+    Body: {
+        pluginname: string;
+        pluginversion?: string;
+    };
+};
+export type PluginsConfigPatchRequest = {
+    Body: Record<string, any>;
+};
+export type PluginsActionRequest = {
+    Body: {
+        actionId: string;
+        payload: any;
+    };
+};
+export type PluginsDetectMotionRequest = {
+    Body: DetectMotionInput;
+};
+export type PluginsDetectObjectRequest = {
+    Body: DetectObjectInput;
+};
+export type PluginsDetectAudioRequest = {
+    Body: DetectAudioInput;
+};
+export interface PluginsInterfaceQueryType {
+    type: 'objectDetection' | 'motionDetection' | 'audioDetection';
+}
+export type PluginsInterfaceQuery = {
+    Querystring: {
+        type: PluginsInterfaceQueryType;
+    };
+};
+export type UsersParamsRequest = {
+    Params: {
+        username: string;
+    };
+};
+export type UsersInsertRequest = {
+    Body: CreateUserInput & {
+        avatar: string;
+    };
+};
+export type UsersPatchRequest = {
+    Body: PatchUserInput & {
+        avatar: string;
+    };
+};
+export type SystemPatchRequest = {
+    Body: PatchSystemInput;
+};
+export type ViewsParamsRequest = {
+    Params: {
+        viewid: string;
+    };
+};
+export type ViewsInsertRequest = {
+    Body: CreateViewInput;
+};
+export type ViewsPatchRequest = {
+    Body: PatchViewInput;
+};
+export type ShortcutParamsRequest = {
+    Params: {
+        shortcutid: string;
+    };
+};
+export type ShortcutInsertRequest = {
+    Body: CreateShortcutInput;
+};
+export type ShortcutPatchRequest = {
+    Body: PatchShortcutInput;
+};
+export type BackupCreateRequest = {
+    Body: {
+        localStorage: Partial<UiLocalStorage>;
+    };
+};
+export interface BackupInfo {
+    backupDirectory: string;
+    backupFile: string;
+    backupFileName: string;
+}
+export type SupportedLanguageAbbreviatons = 'de' | 'en';
+export type SupportedThemes = 'light' | 'dark';
+export interface ConfigSettings {
+    zoom: number;
+}
+export interface ConsoleSettings {
+    zoom: number;
+}
+export type CamviewSettingsLayoutMode = 'dnd' | 'view';
+export interface CamviewSettings {
+    dragDisabled?: boolean;
+    viewid?: string;
+}
+export interface UiSettingsLocalStorage {
+    config: ConfigSettings;
+    console: ConsoleSettings;
+    camview: CamviewSettings;
+}
+export interface ThemeLocalStorage {
+    theme: SupportedThemes;
+    autoMode: boolean;
+}
+export interface UiLocalStorage {
+    ui: UiSettingsLocalStorage;
+    theme: ThemeLocalStorage;
+    locale: SupportedLanguageAbbreviatons;
+}
+export type 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 | {
+        [key: string]: string;
+    };
+    repository?: string | {
+        type: string;
+        url: string;
+    };
+    scripts?: {
+        [key: string]: string;
+    };
+    dependencies?: {
+        [key: string]: string;
+    };
+    devDependencies?: {
+        [key: string]: string;
+    };
+    peerDependencies?: {
+        [key: string]: string;
+    };
+    optionalDependencies?: {
+        [key: string]: string;
+    };
+    bundledDependencies?: string[];
+    engines?: {
+        [key: string]: string;
+    };
+    os?: string[];
+    cpu?: string[];
+    preferGlobal?: boolean;
+    private?: boolean;
+    publishConfig?: {
+        registry?: string;
+    };
+    exports?: {
+        [key: string]: any;
+    };
+    type?: 'module';
+    'camera.ui'?: PluginContract;
+}
+export interface INpmRegistryModule {
+    _id: string;
+    _rev: string;
+    name: string;
+    'dist-tags': {
+        latest: string;
+        [key: string]: string;
+    };
+    versions: {
+        [key: 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;
+    };
+    author?: string;
+    engines?: {
+        'camera.ui'?: string;
+        node?: string;
+    };
+    'camera.ui'?: PluginContract;
+    isPython: boolean;
+    isNode: boolean;
+}
+export interface FrameWorker {
+    name: string;
+    status: PLUGIN_STATUS;
+}

package/dist/server/src/api/types/index.js

@@ -0,0 +1,9 @@
+export var REFRESH_TOKEN;
+(function (REFRESH_TOKEN) {
+    REFRESH_TOKEN["EXPIRES_IN"] = "7d";
+})(REFRESH_TOKEN || (REFRESH_TOKEN = {}));
+export const PAGINATION_DEFAULTS = {
+    page: 1,
+    pageSize: 5,
+};
+//# sourceMappingURL=index.js.map

package/dist/server/src/api/types/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../src/api/types/index.ts"],"names":[],"mappings":"AAmEA,MAAM,CAAN,IAAkB,aAEjB;AAFD,WAAkB,aAAa;IAC7B,kCAAiB,CAAA;AACnB,CAAC,EAFiB,aAAa,KAAb,aAAa,QAE9B;AAED,MAAM,CAAC,MAAM,mBAAmB,GAAoB;IAClD,IAAI,EAAE,CAAC;IACP,QAAQ,EAAE,CAAC;CACZ,CAAC"}

package/dist/server/src/api/utils/cameraSource.d.ts

@@ -0,0 +1,2 @@
+import type { CameraInputSettings, CameraRoles } from '@camera.ui/types';
+export declare const generateInternalCameraSources: (cameraName: string, sourceName: string, roles: CameraRoles[]) => CameraInputSettings[];

package/dist/server/src/api/utils/cameraSource.js

@@ -0,0 +1,34 @@
+import { createSourceName } from '@camera.ui/common';
+import { randomUUID } from 'crypto';
+export const generateInternalCameraSources = (cameraName, sourceName, roles) => {
+    const convertedSourceName = createSourceName(cameraName, sourceName);
+    const internalSourceNameAAC = `${sourceName} AAC`;
+    const internalSourceNameOPUS = `${sourceName} OPUS`;
+    const internalSourceNamePCMA = `${sourceName} PCMA`;
+    const ffmpegSourceUrlAAC = `ffmpeg:${convertedSourceName}#video=copy#audio=aac`;
+    const ffmpegSourceUrlOPUS = `ffmpeg:${convertedSourceName}#video=copy#audio=opus`;
+    const ffmpegSourceUrlPCMA = `ffmpeg:${convertedSourceName}#video=copy#audio=pcma`;
+    const aacSource = {
+        _id: randomUUID(),
+        name: internalSourceNameAAC,
+        urls: [ffmpegSourceUrlAAC],
+        roles,
+        internal: true,
+    };
+    const opusSource = {
+        _id: randomUUID(),
+        name: internalSourceNameOPUS,
+        urls: [ffmpegSourceUrlOPUS],
+        roles,
+        internal: true,
+    };
+    const pcmaSource = {
+        _id: randomUUID(),
+        name: internalSourceNamePCMA,
+        urls: [ffmpegSourceUrlPCMA],
+        roles,
+        internal: true,
+    };
+    return [aacSource, opusSource, pcmaSource];
+};
+//# sourceMappingURL=cameraSource.js.map

package/dist/server/src/api/utils/cameraSource.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cameraSource.js","sourceRoot":"","sources":["../../../../../src/api/utils/cameraSource.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAC;AACrD,OAAO,EAAE,UAAU,EAAE,MAAM,QAAQ,CAAC;AAIpC,MAAM,CAAC,MAAM,6BAA6B,GAAG,CAAC,UAAkB,EAAE,UAAkB,EAAE,KAAoB,EAAyB,EAAE;IACnI,MAAM,mBAAmB,GAAG,gBAAgB,CAAC,UAAU,EAAE,UAAU,CAAC,CAAC;IAErE,MAAM,qBAAqB,GAAG,GAAG,UAAU,MAAM,CAAC;IAClD,MAAM,sBAAsB,GAAG,GAAG,UAAU,OAAO,CAAC;IACpD,MAAM,sBAAsB,GAAG,GAAG,UAAU,OAAO,CAAC;IAEpD,MAAM,kBAAkB,GAAG,UAAU,mBAAmB,uBAAuB,CAAC;IAChF,MAAM,mBAAmB,GAAG,UAAU,mBAAmB,wBAAwB,CAAC;IAClF,MAAM,mBAAmB,GAAG,UAAU,mBAAmB,wBAAwB,CAAC;IAElF,MAAM,SAAS,GAAwB;QACrC,GAAG,EAAE,UAAU,EAAE;QACjB,IAAI,EAAE,qBAAqB;QAC3B,IAAI,EAAE,CAAC,kBAAkB,CAAC;QAC1B,KAAK;QACL,QAAQ,EAAE,IAAI;KACf,CAAC;IAEF,MAAM,UAAU,GAAwB;QACtC,GAAG,EAAE,UAAU,EAAE;QACjB,IAAI,EAAE,sBAAsB;QAC5B,IAAI,EAAE,CAAC,mBAAmB,CAAC;QAC3B,KAAK;QACL,QAAQ,EAAE,IAAI;KACf,CAAC;IAEF,MAAM,UAAU,GAAwB;QACtC,GAAG,EAAE,UAAU,EAAE;QACjB,IAAI,EAAE,sBAAsB;QAC5B,IAAI,EAAE,CAAC,mBAAmB,CAAC;QAC3B,KAAK;QACL,QAAQ,EAAE,IAAI;KACf,CAAC;IAEF,OAAO,CAAC,SAAS,EAAE,UAAU,EAAE,UAAU,CAAC,CAAC;AAC7C,CAAC,CAAC"}

package/dist/server/src/api/utils/cert.d.ts

@@ -0,0 +1,11 @@
+import forge from 'node-forge';
+export interface CertKey {
+    cert: string;
+    certPath: string;
+    key: string;
+    keyPath: string;
+}
+export declare const getCert: (forceNew?: boolean) => CertKey;
+export declare const createRootCA: (customAddresses?: string[]) => CertKey;
+export declare const createCSR: (addresses: string[], keys: forge.pki.rsa.KeyPair) => Partial<CertKey>;
+export declare const createCert: (customAddresses?: string[]) => CertKey;