@nxtedition/types 23.1.1 → 23.1.3

package/dist/app.d.ts

@@ -14,7 +14,13 @@ export interface ElectronHubApi {
     triggerUpdate: (latestVersion: string) => void;
     controlDownloadItem: (id: string, action: "pause" | "resume" | "cancel") => void;
     openInApp: (...args: unknown[]) => void;
-    installDavinciPlugin: (url: string) => Promise<void>;
+    installDavinciPlugin: (url: string) => Promise<{
+        davinciPath: string;
+        pluginsPath: string;
+        zipSize: number;
+    } | {
+        message: string;
+    }>;
     downloadFile: (options: DownloadFileOptions) => void;
     showItemInFolder: (fullPath: string) => void;
     openPath: (path: string) => void;

package/dist/common/index.d.ts

@@ -22,6 +22,7 @@ export * from './subtitle-style.ts';
 export * from './subtitle.ts';
 export * from './error.ts';
 export * from './user-notification.ts';
+export * from './widget.ts';
 export interface Message {
     level: number;
     code: string;

package/dist/common/index.js

@@ -22,3 +22,4 @@ export * from "./subtitle-style.js";
 export * from "./subtitle.js";
 export * from "./error.js";
 export * from "./user-notification.js";
+export * from "./widget.js";

package/dist/common/panel-property.d.ts

@@ -1,29 +1,2 @@
-import type { Nxtpression } from './nxtpression.ts';
-export interface PanelProperty<Value = unknown> {
-    /** Specifying what type of data will be entered into the field. */
-    type: "array" | "asset" | "boolean" | "datetime" | "number" | "string" | "object" | "rpc";
-    /** User-friendly title of the property. This will be used as the field's label in the UI. */
-    title?: string;
-    description?: string;
-    domain?: string;
-    path?: string;
-    computed?: Nxtpression<Value>;
-    /** An object specifying where to index the data. Adding this will effectively make the data searchable. */
-    index?: {
-        /** A string specifying the user-friendly title of the search property. This is what users will see when creating search filters and bookmarks. */
-        label: string;
-        /** A string specifying where to store the data in the search index. Note that this should be a globally unique value in the system. Typically you'd use `{domain}.{path}` and you should prefer English in camel case */
-        path: string;
-    };
-    /** If present, indicates that the user must specify a value for the asset to be treated as valid. */
-    required?: boolean;
-    oneOf?: Array<{
-        const?: Value;
-        title?: string;
-    }>;
-    anyOf?: Array<{
-        const?: Value;
-        title?: string;
-    }>;
-    enum?: Value[];
-}
+import type { BaseSchemaProperty } from './schema-property.ts';
+export type PanelProperty<Value = unknown> = BaseSchemaProperty<Value>;

package/dist/common/render-scene.d.ts

@@ -6,22 +6,30 @@ export interface RenderSceneObject {
     input?: {
         type?: string;
         file?: string | null;
+        video?: {
+            alpha?: RenderSceneAlpha | null;
+            interlaced?: RenderSceneInterlaced | null;
+        };
+        proxy?: string | null;
+        proxyManifest?: string | null;
+        proxyFile?: string | null;
+        manifest?: string | null;
     } | null;
     lang?: string;
     subtitle?: string;
-    subtitleTracks?: {
-        [trackId: string]: {
-            style?: string | null;
-            styleOverrides?: SubtitleStyle;
-        };
-    };
+    graphics?: string;
+    subtitleTracks?: RenderSceneSubtitleTracks;
     video?: {
-        crop?: {
-            x?: number;
-            y?: number;
-            width?: number;
-            height?: number;
-        };
+        filters?: RenderSceneFilters;
+        crop?: RenderSceneCrop;
+        orientation?: number;
+        /** @deprecated Use input.video.interlaced */
+        interlaced?: RenderSceneInterlaced | null;
+        /** @deprecated Use input.video.alpha */
+        alpha?: RenderSceneAlpha | null;
+    };
+    audio?: {
+        pan?: number[][];
     };
     start?: number;
     end?: number;
@@ -29,4 +37,56 @@ export interface RenderSceneObject {
         language?: string;
         pan?: number[];
     };
+    /** @deprecated Use video.crop instead */
+    crop?: RenderSceneCrop;
+    /** @deprecated Use video.filters instead */
+    filters?: RenderSceneFilters;
+    /** @deprecated Use video.orientation instead */
+    orientation?: number;
+    /** @deprecated Use video.orientation instead */
+    rotate?: number;
+    /** @deprecated Use input.video.interlaced instead */
+    interlaced?: RenderSceneInterlaced | null;
+    /** @deprecated Use input.video.alpha instead */
+    alpha?: RenderSceneAlpha | null;
+}
+export interface RenderSceneCrop {
+    x?: number;
+    y?: number;
+    width?: number;
+    height?: number;
+}
+export type RenderSceneInterlaced = false | "tff" | "bff";
+/** true = premultiplied alpha, 'straight' = straight alpha, null/undefined = auto */
+export type RenderSceneAlpha = boolean | "straight";
+export interface RenderSceneFilters {
+    eq?: {
+        brightness?: number;
+        contrast?: number;
+        gamma?: number;
+        saturation?: number;
+    };
+    hue?: {
+        h?: number;
+        s?: number;
+        b?: number;
+    };
+    colorbalance?: {
+        rs?: number;
+        gs?: number;
+        bs?: number;
+        rm?: number;
+        gm?: number;
+        bm?: number;
+        rh?: number;
+        gh?: number;
+        bh?: number;
+    };
+}
+export type RenderSceneSubtitleTracks = {
+    [trackId: string]: RenderSceneSubtitleTrack;
+};
+export interface RenderSceneSubtitleTrack {
+    style?: string | null;
+    styleOverrides?: SubtitleStyle;
 }

package/dist/common/schema-property.d.ts

@@ -1,5 +1,37 @@
-import type { PanelProperty, Nxtpression } from '../';
-export interface SchemaProperty extends PanelProperty {
+import type { Nxtpression } from './nxtpression.ts';
+import type { WidgetOptions, WidgetType } from './widget.ts';
+export interface BaseSchemaProperty<Value = unknown> {
+    domain?: string;
+    path?: string;
+    /** Specifying what type of data will be entered into the field. */
+    type?: "array" | "asset" | "boolean" | "datetime" | "number" | "string" | "object" | "rpc" | undefined;
+    /** User-friendly title of the property. This will be used as the field's label in the UI. */
+    title?: string;
+    description?: string;
+    /** If present, indicates that the user must specify a value for the asset to be treated as valid. */
+    required?: boolean;
+    oneOf?: Array<BaseSchemaProperty>;
+    anyOf?: Array<BaseSchemaProperty>;
+    enum?: ReadonlyArray<Value>;
+    widget?: WidgetType | WidgetOptions;
+    placeholder?: string;
+    helpText?: string;
+    invalid?: boolean;
+    emptyValue?: Value;
+    minItems?: number;
+    maxItems?: number;
+    items?: BaseSchemaProperty<Value>;
+    properties?: Record<string, BaseSchemaProperty<unknown>>;
+    computed?: Nxtpression<Value>;
+    /** An object specifying where to index the data. Adding this will effectively make the data searchable. */
+    index?: {
+        /** A string specifying the user-friendly title of the search property. This is what users will see when creating search filters and bookmarks. */
+        label: string;
+        /** A string specifying where to store the data in the search index. Note that this should be a globally unique value in the system. Typically you'd use `{domain}.{path}` and you should prefer English in camel case */
+        path: string;
+    };
+}
+export interface SchemaProperty<Value = unknown> extends BaseSchemaProperty<Value> {
     recordName?: Nxtpression<string, {
         id: string;
     }>;
@@ -7,6 +39,6 @@ export interface SchemaProperty extends PanelProperty {
         id: string;
         value: unknown;
     }>;
-    default?: unknown;
-    const?: unknown;
+    default?: Value;
+    const?: Value;
 }

package/dist/common/settings.d.ts

@@ -9,6 +9,18 @@ export interface Settings {
         overrideUserContact?: boolean;
         overrideUserLogin?: boolean;
     };
+    graphics?: {
+        width?: number;
+        height?: number;
+    };
+    googleWhitelist?: Array<{
+        domain?: string;
+    }>;
+    googleUserRoles?: string[];
+    azureWhitelist?: Array<{
+        domain?: string;
+    }>;
+    azureUserRoles?: string[];
     module?: {
         editor?: string;
         tabs?: ModuleTabs;
@@ -30,10 +42,10 @@ export interface Settings {
         map?: {
             clustering?: boolean;
             zoom?: number;
-            center?: {
-                lat?: number;
-                lon?: number;
-            };
+            center?: [
+                number,
+                number
+            ];
         };
         createMenu?: {
             sortOrder?: string[];
@@ -118,44 +130,20 @@ export interface Settings {
         countFloatedDuration?: boolean;
     };
     history?: boolean;
-    keymap?: {
-        display?: {
-            [actionKey: string]: KeymapSetting;
-        };
-        browser?: {
-            [actionKey: string]: KeymapSetting;
-        };
-        gallery?: {
-            [actionKey: string]: KeymapSetting;
-        };
-        global?: {
-            [actionKey: string]: KeymapSetting;
-        };
-        player?: {
-            [actionKey: string]: KeymapSetting;
-        };
-        script?: {
-            [actionKey: string]: KeymapSetting;
-        };
-        codeEditor?: {
-            [actionKey: string]: KeymapSetting;
-        };
-        bookmarks?: {
-            [actionKey: string]: KeymapSetting;
-        };
-        edit?: {
-            [actionKey: string]: KeymapSetting;
-        };
-        rundown?: {
-            [actionKey: string]: KeymapSetting;
-        };
-        segment?: {
-            [actionKey: string]: KeymapSetting;
-        };
-    };
+    keymap?: SettingsKeymap;
     media?: {
+        volume?: number;
+        muted?: boolean;
+        graphics?: boolean;
+        waveform?: boolean;
         defaultFrameRate?: number;
+        dropFrame?: boolean;
         placeholder?: string;
+        warnSubclipDuration?: number;
+        displayAspectRatioPresets?: Array<{
+            label?: string;
+            value?: string;
+        }>;
         guide?: {
             mask?: boolean;
             actionSafe?: boolean;
@@ -302,7 +290,23 @@ export interface Settings {
     }>;
     plugins?: {
         adobe?: {
+            videoBin?: string;
+            imageBin?: string;
+            audioBin?: string;
+            timelineBin?: string;
+            clipBin?: string;
+            downloadPath?: string;
+            renderPath?: string;
+            renderPresetPath?: string;
+            videoRenderPreset?: string;
+            imageRenderPreset?: string;
+            audioRenderPreset?: string;
+            forceRender?: boolean;
             useProxies?: boolean;
+            deleteIntermediateFiles?: boolean;
+            bodymovin?: {
+                template?: string;
+            };
         };
         rive?: {
             template?: string;
@@ -312,6 +316,7 @@ export interface Settings {
     debug?: boolean;
     featurePreview?: {
         collections?: boolean;
+        aiMetadata?: boolean;
         semanticSearch?: boolean;
         ameRemoteRendering?: boolean;
     };
@@ -333,8 +338,11 @@ export interface Settings {
         hideInAssetMenu?: boolean;
         assetRoute?: boolean;
         devWarnings?: boolean;
+        downloadFiles?: boolean;
+        supportPortal?: boolean;
         multiplexWebSockets?: boolean;
         systemHealth?: boolean;
+        systemHealthIgnore?: boolean;
     };
     notifications?: {
         events?: {
@@ -374,6 +382,14 @@ export interface Settings {
     shotbox?: {
         layout?: string;
     };
+    performance?: {
+        /** List of message identifiers to ignore in overall health aggregation (format: "serviceName:messageText") */
+        ignoredMessages?: string[];
+    };
+    app?: {
+        enableUpdate?: boolean;
+        autoUpdate?: boolean;
+    };
 }
 export type SettingsPaths = Paths<Settings>;
 interface ModuleTabs {
@@ -388,10 +404,19 @@ interface ModuleTabsSettingsValue {
 interface SettingsPanelStoreTab extends ModuleTabsSettingsValue {
     activeSectionIndex?: number;
 }
-interface KeymapSetting {
+export type SettingsKeymap = Record<string, SettingsKeymapScope>;
+export interface SettingsKeymapEntry {
     title?: string;
-    sequence?: string;
+    sequence?: string | (string | [
+        string,
+        unknown
+    ])[] | null | undefined;
+    schema?: Record<string, any>;
+    stopCallback?: boolean;
 }
+export declare const isSettingsKeymapEntry: (input: unknown) => input is SettingsKeymapEntry;
+export type SettingsKeymapScope = Record<string, SettingsKeymapEntry>;
+export declare const isSettingsKeymapScope: (input: unknown) => input is SettingsKeymapScope;
 export interface AudioMappingPreset {
     id: string;
     title: string;

package/dist/common/settings.js

@@ -1 +1,18 @@
-export {};
+import typia from 'typia';
+export const isSettingsKeymapEntry = (() => { const _io0 = input => (undefined === input.title || "string" === typeof input.title) && (null === input.sequence || undefined === input.sequence || "string" === typeof input.sequence || Array.isArray(input.sequence) && input.sequence.every(elem => null !== elem && undefined !== elem && ("string" === typeof elem || Array.isArray(elem) && (elem.length === 2 && "string" === typeof elem[0] && true)))) && (undefined === input.schema || "object" === typeof input.schema && null !== input.schema && false === Array.isArray(input.schema) && _io1(input.schema)) && (undefined === input.stopCallback || "boolean" === typeof input.stopCallback); const _io1 = input => Object.keys(input).every(key => {
+    const value = input[key];
+    if (undefined === value)
+        return true;
+    return true;
+}); return input => "object" === typeof input && null !== input && false === Array.isArray(input) && _io0(input); })();
+export const isSettingsKeymapScope = (() => { const _io0 = input => Object.keys(input).every(key => {
+    const value = input[key];
+    if (undefined === value)
+        return true;
+    return "object" === typeof value && null !== value && false === Array.isArray(value) && _io1(value);
+}); const _io1 = input => (undefined === input.title || "string" === typeof input.title) && (null === input.sequence || undefined === input.sequence || "string" === typeof input.sequence || Array.isArray(input.sequence) && input.sequence.every(elem => null !== elem && undefined !== elem && ("string" === typeof elem || Array.isArray(elem) && (elem.length === 2 && "string" === typeof elem[0] && true)))) && (undefined === input.schema || "object" === typeof input.schema && null !== input.schema && false === Array.isArray(input.schema) && _io2(input.schema)) && (undefined === input.stopCallback || "boolean" === typeof input.stopCallback); const _io2 = input => Object.keys(input).every(key => {
+    const value = input[key];
+    if (undefined === value)
+        return true;
+    return true;
+}); return input => "object" === typeof input && null !== input && false === Array.isArray(input) && _io0(input); })();

package/dist/common/widget.d.ts

@@ -0,0 +1,16 @@
+export type WidgetType = string;
+export interface WidgetOptions {
+    type?: WidgetType;
+    readOnly?: boolean;
+    [key: string]: unknown;
+}
+export type WidgetLayout = string | WidgetLayoutDivider | WidgetLayoutItem | WidgetLayout[];
+export interface WidgetLayoutItem {
+    property: string;
+    width?: string | number;
+    widget?: WidgetType | WidgetOptions;
+}
+export interface WidgetLayoutDivider {
+    type: "divider";
+    title?: string;
+}

package/dist/common/widget.js

@@ -0,0 +1 @@
+export {};