@nxtedition/types 23.0.39 → 23.0.41

package/dist/records/domains/contact.d.ts

@@ -0,0 +1,9 @@
+export interface ContactDomainRecords {
+    ":contact": ContactRecord;
+}
+export interface ContactRecord {
+    title?: string;
+    email?: string;
+    firstName?: string;
+    lastName?: string;
+}

package/dist/records/domains/contact.js

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

package/dist/records/domains/deepstream.d.ts

@@ -0,0 +1,7 @@
+export interface DeepstreamDomainRecords {
+    ":deepstream.replicate": DeepstreamDomainReplicateRecord;
+}
+export interface DeepstreamDomainReplicateRecord {
+    synced?: boolean;
+    since?: string | 0 | null;
+}

package/dist/records/domains/deepstream.js

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

package/dist/records/domains/design.d.ts

@@ -0,0 +1,11 @@
+export interface DesignDomainRecords {
+    ":design": DesignDomainRecord;
+}
+export interface DesignDomainRecord<Id = string, Key = string, Value = unknown> {
+    rows: DesignViewRow<Id, Key, Value>[];
+}
+export interface DesignViewRow<Id = string, Key = string, Value = void> {
+    id: Id;
+    key: Key;
+    value: Value;
+}

package/dist/records/domains/design.js

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

package/dist/records/domains/edit.d.ts

@@ -0,0 +1,10 @@
+export interface EditDomainRecords {
+    ":edit": EditRecord;
+}
+export interface EditRecord {
+    nodes: object;
+    tracks: object[];
+    transitions: object;
+    active?: boolean;
+    changeId?: string;
+}

package/dist/records/domains/edit.js

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

package/dist/records/domains/event.d.ts

@@ -0,0 +1,66 @@
+export type JsonPrimitive = string | number | boolean | null;
+export type JsonValue = JsonPrimitive | JsonValue[] | {
+    [key: string]: JsonValue;
+};
+export interface EventDomainRecords {
+    ":event": EventRecord;
+    ":event._template?": EventTemplateRecord;
+    ":event.overlay?": EventOverlayRecord;
+    ":event.template?": EventTemplateRecord;
+    ":event.duration?": EventDurationRecord;
+    ":event.children?": EventChildrenRecord;
+    ":event.props?": EventPropsRecord;
+}
+export interface EventRecord {
+    start?: number;
+    end?: number;
+    duration?: number;
+    text?: string;
+    lang?: string;
+    style?: string;
+    styleOverrides?: SubtitleEventStyleOverrides;
+}
+export interface EventTemplateRecord {
+    mixin?: string[];
+    properties?: object;
+    layout?: {
+        title?: string;
+    };
+}
+export interface EventDurationRecord {
+    scheduled?: number;
+    actual?: number;
+    in?: number;
+    out?: number | null;
+}
+export interface EventChildrenRecord {
+    value: string[];
+}
+type EventProps = {
+    source?: string;
+    cueCard?: boolean | string;
+    startTime?: number;
+};
+export type EventPropsRecord = EventProps & Record<Exclude<string, keyof EventProps>, JsonValue>;
+export interface EventOverlayRecord {
+    [eventId: string]: {
+        data: EventPropsRecord;
+    };
+}
+export interface SubtitleEventStyleOverrides {
+    marginL?: string;
+    marginR?: string;
+    marginV?: string;
+    alignment?: string;
+    fontname?: string;
+    fontsize?: string;
+    primaryColour?: string;
+    secondaryColour?: string;
+    outlineColour?: string;
+    backColour?: string;
+    bold?: string;
+    italic?: string;
+    underline?: string;
+    strikeOut?: string;
+}
+export {};

package/dist/records/domains/event.js

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

package/dist/records/domains/file.d.ts

@@ -0,0 +1,26 @@
+import type { FileStats, NxtError } from '../../common/index.ts';
+export interface FileDomainRecords {
+    ":file.replicate": FileReplicateRecord;
+    ":file.restrictions": FileRestrictionsRecord;
+    ":file.stats?": FileDomainStatsRecord;
+}
+export interface FileReplicateRecord {
+    replicas: string[];
+    error: NxtError | null;
+}
+export interface FileReplica {
+    name: string;
+    status: "ok" | "error";
+    error: NxtError | null;
+}
+export interface FileRestrictionsRecord {
+    [restrictionId: string]: {
+        asset: string;
+        date: string;
+        user: string;
+        text: string;
+        start: number;
+        end: number;
+    };
+}
+export type FileDomainStatsRecord = FileStats;

package/dist/records/domains/file.js

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

package/dist/records/domains/general.d.ts

@@ -0,0 +1,41 @@
+export interface GeneralDomainRecords {
+    ":general.title": GeneralTitleRecord;
+    ":general.tags": GeneralTagsRecord;
+    ":general.created": GeneralCreatedRecord;
+    ":general.poster": GeneralPosterRecord;
+    ":general.status": GeneralStatusRecord;
+    ":general.description": GeneralDescriptionRecord;
+}
+export interface GeneralTitleRecord {
+    value?: string;
+}
+/**
+ * Record holding manually added tags
+ */
+export interface GeneralTagsRecord {
+    /**
+     * Manually added tags
+     */
+    value?: string[];
+}
+export interface GeneralCreatedRecord {
+    time?: string;
+    user?: string;
+    origin?: string;
+}
+export interface GeneralPosterRecord {
+    input?: {
+        type?: string;
+        file?: string;
+    };
+    preset?: string;
+}
+export type GeneralStatusRecord = {
+    [messageId: string]: GeneralStatusRecordValue;
+};
+export interface GeneralStatusRecordValue {
+    expose?: boolean;
+}
+export interface GeneralDescriptionRecord {
+    value?: string;
+}

package/dist/records/domains/general.js

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

package/dist/records/domains/index.d.ts

@@ -0,0 +1,77 @@
+import type { AssetDomainRecords } from './asset.ts';
+import type { BundleDomainRecords } from './bundle.ts';
+import type { CloneDomainRecords } from './clone.ts';
+import type { CommentReactionDomainRecords } from './comment-reaction.ts';
+import type { CommentReadMarkDomainRecords } from './comment-read-mark.ts';
+import type { CommentDomainRecords } from './comment.ts';
+import type { ConnectionDomainRecords } from './connection.ts';
+import type { ContactDomainRecords } from './contact.ts';
+import type { DeepstreamDomainRecords } from './deepstream.ts';
+import type { DesignDomainRecords } from './design.ts';
+import type { EditDomainRecords } from './edit.ts';
+import type { EventDomainRecords } from './event.ts';
+import type { FileDomainRecords } from './file.ts';
+import type { GeneralDomainRecords } from './general.ts';
+import type { MediaDomainRecords } from './media.ts';
+import type { MonitorDomainRecords } from './monitor.ts';
+import type { PanelDomainRecords } from './panel.ts';
+import type { PermissionDomainRecords } from './permission.ts';
+import type { PipelinePresetDomainRecords } from './pipeline-preset.ts';
+import type { PipelineDomainRecords } from './pipeline.ts';
+import type { PlanningDomainRecords } from './planning.ts';
+import type { PrompterDomainRecords } from './prompter.ts';
+import type { PublishDomainRecords } from './publish.ts';
+import type { PublishedDomainRecords } from './published.ts';
+import type { RenderPresetDomainRecords } from './render-preset.ts';
+import type { RenderDomainRecords } from './render.ts';
+import type { RevsDomainRecords } from './revs.ts';
+import type { RoleDomainRecords } from './role.ts';
+import type { ScriptDomainRecords } from './script.ts';
+import type { SearchDomainRecords } from './search.ts';
+import type { SettingsDomainRecords } from './settings.ts';
+import type { StoryboardDomainRecords } from './storyboard.ts';
+import type { SubtitleStyleDomainRecords } from './subtitle-style.ts';
+import type { SubtitleDomainRecords } from './subtitle.ts';
+import type { TemplateDomainRecords } from './template.ts';
+import type { UserNotificationStatusDomainRecords } from './user-notification-status.ts';
+import type { UserNotificationDomainRecords } from './user-notification.ts';
+import type { UserDomainRecords } from './user.ts';
+export * from './asset.ts';
+export * from './bundle.ts';
+export * from './clone.ts';
+export * from './comment-reaction.ts';
+export * from './comment-read-mark.ts';
+export * from './comment.ts';
+export * from './connection.ts';
+export * from './contact.ts';
+export * from './deepstream.ts';
+export * from './design.ts';
+export * from './edit.ts';
+export * from './event.ts';
+export * from './file.ts';
+export * from './general.ts';
+export * from './media.ts';
+export * from './monitor.ts';
+export * from './panel.ts';
+export * from './permission.ts';
+export * from './pipeline-preset.ts';
+export * from './pipeline.ts';
+export * from './planning.ts';
+export * from './prompter.ts';
+export * from './publish.ts';
+export * from './published.ts';
+export * from './render-preset.ts';
+export * from './render.ts';
+export * from './revs.ts';
+export * from './role.ts';
+export * from './script.ts';
+export * from './search.ts';
+export * from './settings.ts';
+export * from './storyboard.ts';
+export * from './subtitle-style.ts';
+export * from './subtitle.ts';
+export * from './template.ts';
+export * from './user-notification-status.ts';
+export * from './user-notification.ts';
+export * from './user.ts';
+export type DomainRecords = AssetDomainRecords & BundleDomainRecords & CloneDomainRecords & CommentReactionDomainRecords & CommentReadMarkDomainRecords & CommentDomainRecords & ConnectionDomainRecords & ContactDomainRecords & DeepstreamDomainRecords & DesignDomainRecords & EditDomainRecords & EventDomainRecords & FileDomainRecords & GeneralDomainRecords & MediaDomainRecords & MonitorDomainRecords & PanelDomainRecords & PermissionDomainRecords & PipelinePresetDomainRecords & PipelineDomainRecords & PlanningDomainRecords & PrompterDomainRecords & PublishDomainRecords & PublishedDomainRecords & RenderPresetDomainRecords & RenderDomainRecords & RevsDomainRecords & RoleDomainRecords & ScriptDomainRecords & SearchDomainRecords & SettingsDomainRecords & StoryboardDomainRecords & SubtitleStyleDomainRecords & SubtitleDomainRecords & TemplateDomainRecords & UserNotificationStatusDomainRecords & UserNotificationDomainRecords & UserDomainRecords;

package/dist/records/domains/index.js

@@ -0,0 +1,38 @@
+export * from "./asset.js";
+export * from "./bundle.js";
+export * from "./clone.js";
+export * from "./comment-reaction.js";
+export * from "./comment-read-mark.js";
+export * from "./comment.js";
+export * from "./connection.js";
+export * from "./contact.js";
+export * from "./deepstream.js";
+export * from "./design.js";
+export * from "./edit.js";
+export * from "./event.js";
+export * from "./file.js";
+export * from "./general.js";
+export * from "./media.js";
+export * from "./monitor.js";
+export * from "./panel.js";
+export * from "./permission.js";
+export * from "./pipeline-preset.js";
+export * from "./pipeline.js";
+export * from "./planning.js";
+export * from "./prompter.js";
+export * from "./publish.js";
+export * from "./published.js";
+export * from "./render-preset.js";
+export * from "./render.js";
+export * from "./revs.js";
+export * from "./role.js";
+export * from "./script.js";
+export * from "./search.js";
+export * from "./settings.js";
+export * from "./storyboard.js";
+export * from "./subtitle-style.js";
+export * from "./subtitle.js";
+export * from "./template.js";
+export * from "./user-notification-status.js";
+export * from "./user-notification.js";
+export * from "./user.js";

package/dist/records/domains/media.d.ts

@@ -0,0 +1,64 @@
+import type { Operation } from 'rfc6902';
+import type { NxtError, MediaType, RenderPreset, RenderSceneObject } from '../../common/index.ts';
+export interface MediaDomainRecords {
+    ":media.source": MediaSourceRecord;
+    ":media.consolidate": MediaDomainConsolidateRecord;
+    ":media.renders?": MediaRendersRecord;
+    ":media.transcriptChanges": MediaTranscriptChangesRecord;
+    ":media.font": MediaFontRecord;
+    ":media.restrictions?": MediaRestrictionsRecord;
+    ":media.probe?": MediaProbeRecord;
+    ":media.updateSubtitles?": MediaDomainUpdateSubtitlesRecord;
+    ":media.updateGraphics?": MediaDomainUpdateGraphicsRecord;
+}
+export type MediaSourceRecord = RenderSceneObject;
+export interface MediaDomainConsolidateRecord {
+    source?: unknown;
+    target?: unknown;
+    preset?: RenderPreset;
+    error?: unknown;
+}
+export interface MediaRendersRecord {
+    children: MediaRenderRecordValue[];
+}
+export interface MediaRenderRecordValue {
+    id?: string;
+    title?: string;
+    children?: MediaRenderRecordValue[];
+}
+export type MediaTranscriptChangesRecord = {
+    [patchKey: string]: MediaTranscriptChangesRecordValue;
+};
+export interface MediaTranscriptChangesRecordValue {
+    patch?: Operation[];
+}
+export interface MediaFontRecord {
+    sampleText?: string;
+}
+export interface MediaRestrictionsRecord {
+    [restrictionId: string]: {
+        asset: string;
+        date: string;
+        user: string;
+        text: string;
+        start: number;
+        end: number;
+        file: string;
+    };
+}
+export interface MediaProbeRecord {
+    duration?: number | null;
+    error: NxtError | null;
+    type: MediaType;
+    live?: boolean | null;
+    url?: string | null;
+    subtitle?: {
+        codec?: string | null;
+    };
+}
+export interface MediaDomainUpdateSubtitlesRecord {
+    [key: string]: unknown;
+}
+export interface MediaDomainUpdateGraphicsRecord {
+    [key: string]: unknown;
+}

package/dist/records/domains/media.js

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

package/dist/records/domains/monitor.d.ts

@@ -0,0 +1,116 @@
+export interface MonitorDomainRecords {
+    ":monitor.stats?": MonitorStatsRecord;
+}
+export interface MonitorStatsRecord {
+    gpu: unknown;
+    proc: MonitorStatsProcInfo;
+    buddyinfo: MonitorStatsBuddyInfo;
+    meminfo: MonitorStatsMemInfo;
+    net: MonitorStatsNetworkInfo;
+    var: {
+        used: number;
+        available: number;
+        timestamp: number;
+    };
+}
+export interface MonitorStatsProcInfoCpu {
+    [key: string]: string | number | boolean | null;
+}
+export interface MonitorStatsProcInfo {
+    cpu: MonitorStatsProcInfoCpu | null;
+    cpus?: MonitorStatsProcInfoCpu[];
+    threads: number;
+    load: number[] | null;
+    interrupts?: number[] | null;
+    contextSwitches: number | null;
+    bootTime: number | null;
+    processes: number | null;
+    running: number | null;
+    blocked: number | null;
+    softirqs: unknown;
+    cmdline: unknown;
+    timestamp: number;
+    total: number | null;
+    idle: number | null;
+    active: number | null;
+    utilization: number | null;
+}
+export interface MonitorStatsBuddyInfo {
+    normal?: number[];
+    high?: number[];
+    timestamp: number;
+}
+export interface MonitorStatsMemInfo {
+    [key: string]: string | number | boolean | null;
+}
+export interface NetworkInterfaceInfo {
+    name: string;
+    timestamp?: number;
+    rxBytes?: number;
+    rxBytesOrigin?: number;
+    rxBytesSec?: number;
+    rxBytesValue?: number;
+    rxDropped?: number;
+    rxDroppedOrigin?: number;
+    rxDroppedSec?: number;
+    rxDroppedValue?: number;
+    rxErrors?: number;
+    rxErrorsOrigin?: number;
+    rxErrorsSec?: number;
+    rxErrorsValue?: number;
+    rxPackets?: number;
+    rxPacketsOrigin?: number;
+    rxPacketsSec?: number;
+    rxPacketsValue?: number;
+    txBytes?: number;
+    txBytesOrigin?: number;
+    txBytesSec?: number;
+    txBytesValue?: number;
+    txDropped?: number;
+    txDroppedOrigin?: number;
+    txDroppedSec?: number;
+    txDroppedValue?: number;
+    txErrors?: number;
+    txErrorsOrigin?: number;
+    txErrorsSec?: number;
+    txErrorsValue?: number;
+}
+export interface MonitorStatsNetworkInfo {
+    softnet: {
+        timestamp: number;
+        squeezed?: number;
+        squeezedDay?: number;
+        squeezedHour?: number;
+        processed?: number;
+        processedDay?: number;
+        processedHour?: number;
+        processedMinute?: number;
+        cpus: Array<{
+            cpu: number;
+            processed?: number;
+            dropped?: number;
+            squeezed?: number;
+        }>;
+    };
+    sockstat: {
+        timestamp: number;
+        sockets?: Record<string, unknown>;
+        tcp?: Record<string, unknown>;
+        udp?: Record<string, unknown>;
+        udplite?: Record<string, unknown>;
+        raw?: Record<string, unknown>;
+        frag?: Record<string, unknown>;
+    };
+    bonding: Array<NetworkInterfaceInfo & {
+        slaves: string[];
+        name: string;
+        [key: string]: unknown;
+    }>;
+    eth: Array<NetworkInterfaceInfo & {
+        speed?: number;
+        rxUnicastBytes?: number;
+        rxMulticastBytes?: number;
+        rxBroadcastBytes?: number;
+        [key: string]: unknown;
+    }>;
+}

package/dist/records/domains/monitor.js

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

package/dist/records/domains/panel.d.ts

@@ -0,0 +1,55 @@
+import type { Nxtpression } from '../../common/nxtpression.ts';
+export interface PanelDomainRecords {
+    ":panel": PanelDomainPanelRecord;
+}
+export interface PanelDomainPanelRecord {
+    title?: string;
+    supports?: string[] | string;
+    priority?: number;
+    editorPriority?: number;
+    properties?: {
+        [key: string]: PanelProperty;
+    };
+    layout?: {
+        panel?: PanelLayout;
+        editor?: PanelLayout;
+    };
+    filter?: Nxtpression;
+    expand?: Nxtpression;
+}
+export interface PanelProperty {
+    /** 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<unknown>;
+    /** 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?: unknown[];
+}
+export type PanelLayout = string | PanelLayoutDivider | PanelLayoutItem | PanelLayout[];
+export interface PanelLayoutItem {
+    property: string;
+    width?: string | number;
+    widget?: LayoutWidget;
+}
+export interface PanelLayoutDivider {
+    type: "divider";
+    title?: string;
+}
+export type LayoutWidget = WidgetType | WidgetItem;
+export type WidgetType = "default" | "assetTypes" | "assetTags" | "geopoint" | "poster" | "textarea" | "tags";
+export interface WidgetItem {
+    type: WidgetType;
+    readOnly?: boolean;
+}

package/dist/records/domains/panel.js

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

package/dist/records/domains/permission.d.ts

@@ -0,0 +1,25 @@
+export interface PermissionDomainRecords {
+    ":permission?": ProvidedPermissionRecord;
+    ":permission": PermissionRecord;
+}
+export interface ProvidedPermissionRecord {
+    permissions: PermissionRecordPermisson[];
+}
+export type PermissionRecord = PermissionRecordPermisson;
+export type PermissionRecordPermisson = TagPermission | AssetPermission | RpcPermission;
+export interface TagPermission {
+    type: "tag";
+    method?: undefined;
+    tags: string[];
+}
+export declare const isTagPermission: (input: unknown) => input is TagPermission;
+export interface AssetPermission {
+    type: "asset";
+    method: string;
+    tags?: undefined;
+}
+export interface RpcPermission {
+    type: "rpc";
+    method: string;
+    tags?: undefined;
+}

package/dist/records/domains/permission.js

@@ -0,0 +1,2 @@
+import typia from "typia";
+export const isTagPermission = (() => { const _io0 = input => "tag" === input.type && (null !== input.method && undefined === input.method) && (Array.isArray(input.tags) && input.tags.every(elem => "string" === typeof elem)); return input => "object" === typeof input && null !== input && _io0(input); })();

package/dist/records/domains/pipeline-preset.d.ts

@@ -0,0 +1,10 @@
+import type { PipelineSortMode } from '../../common/index.ts';
+export interface PipelinePresetDomainRecords {
+    ":pipeline-preset": PipelinePresetDomainRecord;
+}
+export interface PipelinePresetDomainRecord {
+    createMenuItems?: string[] | null;
+    color?: string;
+    tags?: string[];
+    sortMode?: PipelineSortMode;
+}

package/dist/records/domains/pipeline-preset.js

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

package/dist/records/domains/pipeline.d.ts

@@ -0,0 +1,17 @@
+export interface PipelineDomainRecords {
+    ":pipeline": PipelineDomainRecord;
+    ":pipeline.items": PipelineDomainItemsRecord;
+}
+export interface PipelineDomainRecord {
+    dummy?: boolean;
+    assetType?: "pipeline" | "collection";
+    preset?: string;
+    color?: string;
+    tags?: string[];
+    type?: string;
+    bookmarkId?: string;
+    hiddenCreateMenuItems?: Record<string, unknown>;
+}
+export interface PipelineDomainItemsRecord {
+    value?: string[];
+}

package/dist/records/domains/pipeline.js

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

package/dist/records/domains/planning.d.ts

@@ -0,0 +1,14 @@
+export interface PlanningDomainRecords {
+    ":planning": PlanningRecord;
+    ":planning.assignees": PlanningAssigneesRecord;
+    ":planning.deadline": PlanningDeadlineRecord;
+}
+export interface PlanningRecord {
+    deadline?: string | null;
+}
+export interface PlanningAssigneesRecord {
+    value?: string[];
+}
+export interface PlanningDeadlineRecord {
+    value: string | null;
+}

package/dist/records/domains/planning.js

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

package/dist/records/domains/prompter.d.ts

@@ -0,0 +1,18 @@
+export interface PrompterDomainRecords {
+    ":prompter": PrompterDomainRecord;
+}
+export interface PrompterDomainRecord {
+    asset: string;
+    primaryColor: string;
+    secondaryColor: string;
+    backgroundColor: string;
+    fontFamily?: string;
+    fontFamilies?: string[];
+    genericFontFamily?: string;
+    fontSize: number;
+    lineHeight: number;
+    markerPosition: number;
+    padding: number;
+    dummy?: boolean;
+    showInfo?: boolean;
+}

package/dist/records/domains/prompter.js

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