@nxtedition/types 23.1.2 → 23.1.4

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

@@ -3,12 +3,14 @@ export * from './block.ts';
 export * from './clone.ts';
 export * from './date.ts';
 export * from './file.ts';
+export * from './json-schema.ts';
 export * from './location.ts';
 export * from './nxtpression.ts';
 export * from './lock.ts';
 export * from './media.ts';
 export * from './panel-property.ts';
 export * from './pipeline.ts';
+export * from './print.ts';
 export * from './promoted-tag.ts';
 export * from './render-preset.ts';
 export * from './render-profile.ts';
@@ -22,6 +24,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

@@ -3,12 +3,14 @@ export * from "./block.js";
 export * from "./clone.js";
 export * from "./date.js";
 export * from "./file.js";
+export * from "./json-schema.js";
 export * from "./location.js";
 export * from "./nxtpression.js";
 export * from "./lock.js";
 export * from "./media.js";
 export * from "./panel-property.js";
 export * from "./pipeline.js";
+export * from "./print.js";
 export * from "./promoted-tag.js";
 export * from "./render-preset.js";
 export * from "./render-profile.js";
@@ -22,3 +24,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/json-schema.d.ts

@@ -0,0 +1,95 @@
+import type { JsonValue } from 'type-fest';
+declare const __jsonSchemaType: unique symbol;
+export type TypedJsonSchema<T> = JsonSchema & {
+    [__jsonSchemaType]?: T;
+};
+export type JsonSchema = JsonSchemaBoolean | JsonSchemaNumber | JsonSchemaInteger | JsonSchemaString | JsonSchemaArray | JsonSchemaTuple | JsonSchemaObject | JsonSchemaReference | JsonSchemaOneOf | JsonSchemaAnyOf | JsonSchemaEnum | JsonSchemaConst | JsonSchemaNull | JsonSchemaUnknown;
+export interface JsonSchemaBase {
+    title?: string;
+    description?: string;
+    /**
+     * Normal JSON schemas use either 'definitions' (older versions) or '$defs' (newer versions).
+     * However, OpenAPI and Typia instead uses 'components'. Since we use typia to generate JSON schemas,
+     * we use 'components' as well.
+     *
+     * In the case of OpenAPI and Typia the 'components' schemas are supplied outside the actual
+     * JSON schema. For better compatibility with other JSON schema tooling, we instead include it
+     * inside the JSON schema itself.
+     */
+    components?: {
+        schemas?: Record<string, JsonSchema>;
+    };
+}
+export interface JsonSchemaBoolean extends JsonSchemaBase {
+    type: "boolean";
+    default?: boolean;
+}
+export interface JsonSchemaInteger extends JsonSchemaBase {
+    type: "integer";
+    default?: number;
+    minimum?: number;
+    maximum?: number;
+    exclusiveMinimum?: number;
+    exclusiveMaximum?: number;
+    multipleOf?: number;
+}
+export interface JsonSchemaNumber extends JsonSchemaBase {
+    type: "number";
+    default?: number;
+    minimum?: number;
+    maximum?: number;
+    exclusiveMinimum?: number;
+    exclusiveMaximum?: number;
+    multipleOf?: number;
+}
+export interface JsonSchemaString extends JsonSchemaBase {
+    type: "string";
+    default?: string;
+    format?: string;
+    pattern?: string;
+    minLength?: number;
+    maxLength?: number;
+}
+export interface JsonSchemaArray extends JsonSchemaBase {
+    type: "array";
+    items: JsonSchema;
+    minItems?: number;
+    maxItems?: number;
+    uniqueItems?: boolean;
+}
+export interface JsonSchemaTuple extends JsonSchemaBase {
+    type: "array";
+    prefixItems: JsonSchema[];
+    additionalItems?: boolean | JsonSchema;
+    minItems?: number;
+    maxItems?: number;
+    uniqueItems?: boolean;
+}
+export interface JsonSchemaObject extends JsonSchemaBase {
+    type: "object";
+    properties?: Record<string, JsonSchema>;
+    additionalProperties?: boolean | JsonSchema;
+    required?: string[];
+}
+export interface JsonSchemaReference extends JsonSchemaBase {
+    $ref: string;
+}
+export interface JsonSchemaOneOf extends JsonSchemaBase {
+    oneOf: JsonSchema[];
+}
+export interface JsonSchemaAnyOf extends JsonSchemaBase {
+    anyOf: JsonSchema[];
+}
+export interface JsonSchemaEnum extends JsonSchemaBase {
+    enum: JsonValue[];
+}
+export interface JsonSchemaConst extends JsonSchemaBase {
+    const: JsonValue;
+}
+export interface JsonSchemaNull extends JsonSchemaBase {
+    type: "null";
+}
+export interface JsonSchemaUnknown extends JsonSchemaBase {
+    type?: undefined;
+}
+export {};

package/dist/common/json-schema.js

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

package/dist/common/nxtpression.d.ts

@@ -1,4 +1,4 @@
-export type Nxtpression<ReturnValue = unknown, Context extends object = object> = {
+export type Nxtpression<ReturnValue = unknown, Context extends Record<string, unknown> = Record<string, unknown>> = {
     /**
      * TS-HACK: this property doesn't really exist on the nxtpression string,
      * it is only here to make sure the generic Context won't get stripped.

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/print.d.ts

@@ -0,0 +1,30 @@
+export type PrintOptions = PrintScriptOptions | PrintRundownOptions;
+export type PageSize = "A5" | "A4" | "A3";
+export type PageOrientation = "landscape" | "portrait";
+export type PrintOptionalScriptNodes = "event" | "event-data" | "comment" | "heading" | "list" | "quote" | "paragraph" | "horizontalrule";
+interface PrintOptionsBase {
+    title: string;
+    horizontalMargin: number;
+    pageSize: PageSize;
+    orientation: PageOrientation;
+    fontSize: number;
+    fontFamily?: string;
+    hide: PrintOptionalScriptNodes[];
+}
+export interface PrintScriptOptions extends PrintOptionsBase {
+    type: "script";
+}
+export interface PrintRundownOptions extends PrintOptionsBase {
+    type: "rundown";
+    columns: PrintRundownColumn[];
+    rangeStart?: number;
+    rangeEnd?: number;
+    hide: Exclude<PrintOptionalScriptNodes, "event-data">[];
+}
+export interface PrintRundownColumn {
+    key: "id" | "title" | "time" | "duration" | "position" | "accDuration" | "type";
+    label: string;
+    width: string;
+    textAlign: "right" | "left" | "center";
+}
+export {};

package/dist/common/print.js

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

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

@@ -6,27 +6,88 @@ 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;
     transcribe?: {
         language?: string;
         pan?: number[];
+        diarization?: boolean;
     };
+    /** @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

@@ -3,12 +3,25 @@ import type { PipelineSortMode } from './pipeline.ts';
 import type { PromotedTag } from './promoted-tag.ts';
 import type { NotificationReason } from './user-notification.ts';
 import type { SubtitleStyle } from './subtitle-style.ts';
+import type { PrintOptions } from './print.ts';
 export interface Settings {
     autoLogoutTime?: number;
     permission?: {
         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 +43,10 @@ export interface Settings {
         map?: {
             clustering?: boolean;
             zoom?: number;
-            center?: {
-                lat?: number;
-                lon?: number;
-            };
+            center?: [
+                number,
+                number
+            ];
         };
         createMenu?: {
             sortOrder?: string[];
@@ -86,6 +99,7 @@ export interface Settings {
             sortBy?: "index" | "title";
             showPreview?: boolean;
         };
+        contentMaxWidth?: number;
         colorTags?: PromotedTag[];
         readType?: "characters" | "words" | "wordsPerMinute";
         readRate?: number;
@@ -118,44 +132,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;
@@ -295,6 +285,7 @@ export interface Settings {
     };
     print?: {
         fontFamilies?: string[];
+        presets?: Array<PrintOptions>;
     };
     hiddenPreviews?: Array<{
         id?: string;
@@ -302,7 +293,27 @@ export interface Settings {
     }>;
     plugins?: {
         adobe?: {
+            videoBin?: string;
+            imageBin?: string;
+            audioBin?: string;
+            timelineBin?: string;
+            clipBin?: string;
+            downloadPath?: string;
+            renderPath?: string;
+            renderPresetPath?: string;
+            renderPresets?: string[];
+            videoRenderPreset?: string;
+            imageRenderPreset?: string;
+            audioRenderPreset?: string;
+            forceRender?: boolean;
             useProxies?: boolean;
+            deleteIntermediateFiles?: boolean;
+            bodymovin?: {
+                template?: string;
+            };
+        };
+        ograf?: {
+            template?: string;
         };
         rive?: {
             template?: string;
@@ -312,6 +323,7 @@ export interface Settings {
     debug?: boolean;
     featurePreview?: {
         collections?: boolean;
+        aiMetadata?: boolean;
         semanticSearch?: boolean;
         ameRemoteRendering?: boolean;
     };
@@ -333,6 +345,8 @@ export interface Settings {
         hideInAssetMenu?: boolean;
         assetRoute?: boolean;
         devWarnings?: boolean;
+        downloadFiles?: boolean;
+        supportPortal?: boolean;
         multiplexWebSockets?: boolean;
         systemHealth?: boolean;
         systemHealthIgnore?: boolean;
@@ -376,8 +390,14 @@ export interface Settings {
         layout?: string;
     };
     performance?: {
-        /** List of message identifiers to ignore in overall health aggregation (format: "serviceName:messageText") */
-        ignoredMessages?: string[];
+        /** List of message identifiers to ignore warnings (format: "serviceName:messageText") */
+        ignoredWarnings?: string[];
+        /** List of message identifiers to ignore errors (format: "serviceName:messageText") */
+        ignoredErrors?: string[];
+    };
+    app?: {
+        enableUpdate?: boolean;
+        autoUpdate?: boolean;
     };
 }
 export type SettingsPaths = Paths<Settings>;
@@ -393,10 +413,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 {};