@nxtedition/types 23.0.39 → 23.0.41

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

@@ -0,0 +1,145 @@
+import type { Message, RenderSceneObject, RenderProfileObject } from '../../common/index.ts';
+import type { Nxtpression } from '../../common/index.ts';
+export interface PublishDomainRecords {
+    [":publish"]: PublishRecord;
+    [":publish.stats?"]: PublishStatsRecord;
+    [":publish.methods?"]: PublishDomainMethodsRecord;
+    [":publish.accepts"]: PublishDomainAcceptsProvidedRecord;
+}
+export type PublishRecord = YoutubePublishRecord | FacebookPublishRecord | FilePublishRecord | FilePublishRecordLegacy;
+export type PublishStatsRecord = YoutubePublishStatsRecord | FacebookPublishStatsRecord | FilePublishStatsRecord;
+export interface PublishDomainMethodsRecord {
+    [key: string]: {
+        rpcId: string;
+        rpcData: Record<string, unknown>;
+    };
+}
+/**
+ * render preset + overrides
+ */
+export interface PublishRender {
+    preset?: string;
+    type: string;
+    scene?: RenderSceneObject;
+    profile?: RenderProfileObject;
+}
+interface PublishRecordCommon<Type extends PublishRecord["type"]> {
+    type: Type;
+    asset?: string;
+    connection?: string;
+    render?: PublishRender;
+    draft?: Record<string, unknown>;
+    published?: Record<string, unknown>;
+    remote?: Record<string, unknown>;
+    error?: {
+        method: string;
+    } | null;
+    messages?: Message[];
+}
+export interface PublishStatsRecordCommon {
+    status?: string;
+    substatus?: string;
+    messages?: Message[];
+    retrieved?: Record<string, unknown>;
+    defaults?: Record<string, unknown>;
+}
+export interface YoutubePublishRecord extends PublishRecordCommon<"youtube"> {
+    draft?: {
+        snippet?: {
+            title?: string;
+            tags?: string[];
+            description?: string;
+        };
+    };
+}
+export interface YoutubePublishStatsRecord extends PublishStatsRecordCommon {
+}
+export interface FacebookPublishRecord extends PublishRecordCommon<"facebook"> {
+    pageId?: string;
+}
+export interface FacebookPublishStatsRecord extends PublishStatsRecordCommon {
+}
+export interface FilePublishRecord extends PublishRecordCommon<"file"> {
+    directory?: string;
+    filename?: string;
+    renders?: Record<string, FilePublishRender>;
+    draft?: FilePublishDraft;
+    remote?: FilePublishRemote;
+    published?: FilePublishPublished;
+}
+export interface FilePublishRecordLegacy extends PublishRecordCommon<"file"> {
+    directory?: string;
+    filename?: string;
+    draft?: FilePublishDraft;
+    remote?: FilePublishRemoteLegacy;
+    published?: FilePublishPublished;
+    renders?: undefined;
+}
+export interface FilePublishRemoteLegacy extends Record<string, unknown> {
+    id?: string;
+    path: string;
+    filename: string;
+    directory?: string;
+    subtitle?: {
+        path: string;
+    };
+    metafile?: {
+        path: string;
+    };
+}
+export type FilePublishRender = Nxtpression<ResolvedFilePublishRender, {
+    publish: FilePublishRecord;
+    directory: string;
+    name: string;
+}>;
+export interface ResolvedFilePublishRender extends Omit<PublishRender, "preset"> {
+    preset?: string;
+    name?: string;
+    path: string;
+    collisionStrategy?: "overwrite" | "skip";
+    ignoreEmptyScene?: boolean;
+}
+export interface FilePublishPublished extends Record<string, unknown> {
+    directory?: string;
+    filename: string;
+}
+export interface FilePublishDraft extends Record<string, unknown> {
+    directory?: string;
+    filename?: string;
+}
+export interface FilePublishRemote extends Record<string, unknown> {
+    directory?: string;
+    filename?: string;
+    renders?: Record<string, FilePublishRemoteRender>;
+}
+export interface FilePublishRemoteRender {
+    path?: string;
+    messages?: Message[];
+    query?: unknown;
+    size?: number;
+    hash?: string;
+    source?: string;
+}
+export interface FilePublishStatsRecord extends PublishStatsRecordCommon {
+    retrieved?: FilePublishRetrieved;
+    defaults?: FilePublishDefaults;
+}
+export interface FilePublishRetrieved extends Record<string, unknown> {
+    filename?: string;
+    directory?: string;
+    renders?: Record<string, FilePublishRetrievedRender>;
+}
+export interface FilePublishRetrievedRender {
+    path: string;
+    size?: number;
+    hash?: string;
+}
+export interface FilePublishDefaults extends Record<string, unknown> {
+    directory: string;
+    filename: string;
+    renders: Record<string, FilePublishRender>;
+}
+export interface PublishDomainAcceptsProvidedRecord {
+    value?: unknown;
+}
+export {};

package/dist/records/domains/publish.js

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

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

@@ -0,0 +1,12 @@
+export interface PublishedDomainRecords {
+    [":published"]: PublishedRecord;
+}
+export interface PublishedRecord {
+    type: string;
+    parent: string;
+    asset: string[];
+    time: number;
+    connection: string;
+    user?: string;
+    error?: boolean;
+}

package/dist/records/domains/published.js

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

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

@@ -0,0 +1,5 @@
+import type { RenderPresetObject } from '../../common/index.ts';
+export interface RenderPresetDomainRecords {
+    ":render-preset": RenderPresetDomainRecord;
+}
+export type RenderPresetDomainRecord = RenderPresetObject;

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

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

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

@@ -0,0 +1,115 @@
+import type { RenderSceneObject, RenderProfileObject } from '../../common/index.ts';
+export interface RenderDomainRecords {
+    ":render.stats?": RenderDomainStatsRecord;
+    ":render.query?": RenderDomainQueryRecord;
+    ":render.result?": RenderDomainResultRecord;
+    ":render.schedulers?": RenderDomainSchedulersRecord;
+}
+export interface RenderDomainStatsRecord {
+    progress?: number | null;
+    error?: Array<Record<string, unknown>> | null;
+    status?: string | string[] | null;
+    lag?: number | null;
+    available?: boolean | null;
+    toobusy?: boolean | null;
+    cpuAvailable?: boolean | null;
+    cpuComputeAvailable?: number | null;
+    cpuComputeReservation?: number | null;
+    cpuCompute?: number | null;
+    cpuComputeLimit?: number | null;
+    cpuComputeTotal?: number | null;
+    cpuComputeValue?: number | null;
+    cpuMemoryAvailable?: number | null;
+    cpuMemoryReservation?: number | null;
+    cpuMemory?: number | null;
+    cpuMemoryLimit?: number | null;
+    cpuMemoryValue?: number | null;
+    cpuMemoryTotal?: number | null;
+    gpuType?: string | null;
+    gpuAvailable?: boolean | null;
+    gpuComputeAvailable?: number | null;
+    gpuComputeReservation?: number | null;
+    gpuCompute?: number | null;
+    gpuComputeLimit?: number | null;
+    gpuComputeValue?: number | null;
+    gpuComputeTotal?: number | null;
+    gpuMemoryAvailable?: number | null;
+    gpuMemoryReservation?: number | null;
+    gpuMemory?: number | null;
+    gpuMemoryLimit?: number | null;
+    gpuMemoryValue?: number | null;
+    gpuMemoryTotal?: number | null;
+    gpuQueueAvailable?: number | null;
+    gpuQueueReservation?: number | null;
+    gpuQueueLimit?: number | null;
+    gpuQueueValue?: number | null;
+    gpuQueueTotal?: number | null;
+    gpuEncoder?: number | null;
+    gpuEncoderLimit?: number | null;
+    gpuEncoderValue?: number | null;
+    gpuEncoderTotal?: number | null;
+    gpuDecoder?: number | null;
+    gpuDecoderLimit?: number | null;
+    gpuDecoderValue?: number | null;
+    gpuDecoderTotal?: number | null;
+    netAvailable?: boolean | null;
+    netTransferAvailable?: number | null;
+    netTransferReservation?: number | null;
+    netTransfer?: number | null;
+    netTransferLimit?: number | null;
+    netTransferValue?: number | null;
+    netTransferTotal?: number | null;
+    cpu?: number | null;
+    memory?: number | null;
+    activeCount: number | null;
+    totalCount: number | null;
+    gpuStat?: RenderDomainGpuStats | null;
+    cpuStat?: RenderDomainCpuStats | null;
+    netStat?: RenderDomainNetStats | null;
+    limits?: unknown;
+    taskset?: string;
+}
+export interface RenderDomainGpuStats {
+    [key: string]: unknown;
+}
+export interface RenderDomainCpuStats {
+    cpu: {
+        idle: number;
+        total: number;
+    };
+    mem: {
+        used: number;
+        total: number;
+        arcstats: {
+            size: number | null;
+        };
+        meminfo: {
+            [key: string]: unknown;
+        };
+    };
+}
+export interface RenderDomainNetStats {
+    used: number;
+    type?: string;
+    dev?: {
+        used: number;
+    };
+}
+export interface RenderDomainQueryRecord {
+    type: string;
+    title: string;
+    parent?: string;
+    description: {
+        scene: RenderSceneObject;
+        profile: RenderProfileObject;
+    };
+}
+export interface RenderDomainResultRecord {
+    [key: string]: unknown;
+    url?: string;
+    result?: unknown;
+    error?: null | Record<string, unknown> | Array<Record<string, unknown>>;
+}
+export interface RenderDomainSchedulersRecord {
+    [key: string]: number[];
+}

package/dist/records/domains/render.js

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

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

@@ -0,0 +1,6 @@
+export interface RevsDomainRecords {
+    ":revs?": RevsRecord;
+}
+export interface RevsRecord {
+    value?: string[];
+}

package/dist/records/domains/revs.js

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

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

@@ -0,0 +1,6 @@
+export interface RoleDomainRecords {
+    ":role.tags": RoleTagsRecord;
+}
+export interface RoleTagsRecord {
+    value: string[];
+}

package/dist/records/domains/role.js

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

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

@@ -0,0 +1,101 @@
+import type { SerializedEditorState, SerializedLexicalNode } from 'lexical';
+/**
+ * A base64 encoded string representing a complete Yjs document state.
+ * This is created using `Y.encodeStateAsUpdate()` and is used for
+ * persistence and versioning.
+ */
+type YjsSnapshot = string;
+export interface ScriptDomainRecords {
+    ":script": ScriptRecord;
+    ":script?": ScriptEditorStateRecord;
+    ":script.revisions?": ScriptRevisionsRecord;
+    ":script.revision": ScriptRevisionRecord;
+    ":script.revision?": ScriptEditorStateRevisionRecord;
+    ":script.content?": ScriptContentRecord;
+    ":script.text?": ScriptTextRecord;
+    ":script.children": ScriptChildrenRecord;
+}
+export interface ScriptRecord {
+    value: YjsSnapshot;
+}
+export interface ScriptEditorStateRecord {
+    value: SerializedEditorState;
+}
+interface ScriptRevision {
+    id: string;
+    userId: string;
+}
+export interface ScriptRevisionsRecord {
+    value: ScriptRevision[];
+}
+export interface ScriptRevisionRecord {
+    $parent: string;
+    scriptId: string;
+    userId: string;
+    value: YjsSnapshot;
+}
+export interface ScriptEditorStateRevisionRecord {
+    $parent: string;
+    scriptId: string;
+    userId: string;
+    value: SerializedEditorState;
+}
+export interface EventNodeContent {
+    type: "event";
+    id: string;
+    mixin: string;
+    children: EventNodeContent[];
+}
+export interface TextNodeContent {
+    type: "text" | "link" | "autolink";
+    text: string;
+    style?: string;
+    format?: number;
+}
+export interface ElementNodeContent {
+    type: SerializedLexicalNode["type"];
+    children: TextNodeContent[];
+}
+export interface ListItemNodeContent {
+    type: "listitem";
+    value: number;
+    checked?: boolean;
+    children: TextNodeContent[];
+}
+export interface ListNodeContent {
+    type: "list";
+    listType: "bullet" | "number" | "check";
+    tag: "ul" | "ol";
+    children: ListItemNodeContent[];
+}
+export interface ParagraphNodeContent extends ElementNodeContent {
+    type: "paragraph";
+}
+export interface CommentNodeContent extends ElementNodeContent {
+    type: "comment";
+}
+export interface HeadingNodeContent extends ElementNodeContent {
+    type: "heading";
+    tag: "h1" | "h2" | "h3";
+}
+export interface QuoteNodeContent extends ElementNodeContent {
+    type: "quote";
+}
+export interface HorizontalRuleContent {
+    type: "horizontalrule";
+}
+export type NodeContent = EventNodeContent | TextNodeContent | ParagraphNodeContent | CommentNodeContent | ListNodeContent | ListItemNodeContent | HeadingNodeContent | HorizontalRuleContent | QuoteNodeContent;
+export interface ScriptContentRecord {
+    nodes: NodeContent[];
+}
+export interface ScriptTextRecord {
+    content: string;
+    graphics: string;
+}
+/**
+ * A record for non-script automation assets that can have child events.
+ */
+export interface ScriptChildrenRecord {
+    value?: string[];
+}
+export {};

package/dist/records/domains/script.js

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

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

@@ -0,0 +1,9 @@
+export interface SearchDomainRecords {
+    ":search?": SearchRecord;
+}
+export interface SearchRecord {
+    hits: string[];
+    total?: number;
+    relation?: string;
+    error?: string;
+}

package/dist/records/domains/search.js

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

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

@@ -0,0 +1,5 @@
+import type { Settings } from '../../common/index.ts';
+export interface SettingsDomainRecords {
+    ":settings": SettingsRecord;
+}
+export type SettingsRecord = Settings;

package/dist/records/domains/settings.js

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

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

@@ -0,0 +1,10 @@
+export interface StoryboardDomainRecords {
+    ":storyboard": StoryboardDomainRecord;
+    ":storyboard.pipelines": StoryboardDomainPipelinesRecord;
+}
+export interface StoryboardDomainRecord {
+    [key: string]: unknown;
+}
+export interface StoryboardDomainPipelinesRecord {
+    value?: string[];
+}

package/dist/records/domains/storyboard.js

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

package/dist/records/domains/subtitle-style.d.ts

@@ -0,0 +1,13 @@
+import type { SubtitleStyle } from '../../common/subtitle-style.ts';
+export interface SubtitleStyleDomainRecords {
+    ":subtitle-style": SubtitleStyleDomainRecord;
+}
+export interface SubtitleStyleDomainRecord extends SubtitleStyle {
+    scaledBorderAndShadow?: boolean;
+    futureWordWrapping?: boolean;
+    previewSettings?: {
+        aspectRatio?: string;
+        backgroundAssetId?: string;
+        text?: string;
+    };
+}

package/dist/records/domains/subtitle-style.js

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

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

@@ -0,0 +1,12 @@
+export interface SubtitleDomainRecords {
+    ":subtitle": SubtitleDomainRecord;
+}
+export interface SubtitleDomainRecord {
+    value?: Array<{
+        lang?: string;
+        start: number;
+        end: number;
+        text?: string;
+    }>;
+    style?: unknown;
+}

package/dist/records/domains/subtitle.js

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

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

@@ -0,0 +1,10 @@
+export interface TemplateDomainRecords {
+    ":template": TemplateRecord;
+}
+export interface TemplateRecord {
+    mixin?: string[];
+    properties?: Record<string, TemplateProperty>;
+}
+export interface TemplateProperty {
+    path?: string;
+}

package/dist/records/domains/template.js

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

package/dist/records/domains/user-notification-status.d.ts

@@ -0,0 +1,30 @@
+export interface UserNotificationStatusDomainRecords {
+    ":_user-notification-status": UserNotificationStatusDomainRecord;
+}
+export interface UserNotificationStatusDomainRecord {
+    assignee?: UserNotificationStatusAssignee;
+    published?: UserNotificationStatusPublished;
+    comment?: UserNotificationStatusComment;
+}
+export interface UserNotificationStatusAssignee {
+    /**
+     * Array of user ID:s that was assigned to the assed last time it was
+     * considered for notifications.
+     */
+    value?: string[];
+}
+export interface UserNotificationStatusComment {
+    /**
+     * When array of user ID:s: Indicates which users have been considered for
+     * notifications about this comment. When `true`: Indicates that we have
+     * considered this comment for notifications, but we don't know which users
+     * have been notified.
+     */
+    value?: string[] | true;
+}
+export interface UserNotificationStatusPublished {
+    /**
+     * If `true`, this published asset has been considered for notifications.
+     */
+    value?: true;
+}

package/dist/records/domains/user-notification-status.js

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

package/dist/records/domains/user-notification.d.ts

@@ -0,0 +1,69 @@
+import { type NotificationReason } from '../../common/user-notification.ts';
+export interface UserNotificationDomainRecords {
+    ":user-notification": UserNotificationRecord;
+    ":user-notification.readAt": UserNotificationDomainReadAtRecord;
+}
+export interface UserNotificationCommon {
+    /** The user that the notification is for. */
+    userId: string;
+    /** The type of the notification, which will determine the shape of the payload. */
+    type: string;
+    /** Type specific data. */
+    payload: object;
+    /** When the notification was created. */
+    timestamp: string;
+    /** For what reasons the notification was created. */
+    reasons: NotificationReason[];
+    /**
+     * Asset that triggered this notification. Not necessarily the same asset that
+     * the notification is mainly about.
+     */
+    triggerId?: string;
+}
+export interface UserNotificationAssigned extends UserNotificationCommon {
+    type: "assigned";
+    payload: {
+        assetId: string;
+        actionBy?: string;
+    };
+}
+export interface UserNotificationUnassigned extends UserNotificationCommon {
+    type: "unassigned";
+    payload: {
+        assetId: string;
+        actionBy?: string;
+    };
+}
+export interface UserNotificationComment extends UserNotificationCommon {
+    type: "comment";
+    payload: {
+        commentId: string;
+    };
+}
+export interface UserNotificationAddedToSearch extends UserNotificationCommon {
+    type: "added-to-search";
+    payload: {
+        searchId: string;
+        assetId: string;
+    };
+}
+export interface UserNotificationPublishSucceeded extends UserNotificationCommon {
+    type: "publishSucceeded";
+    payload: {
+        /** The user that published the asset. */
+        userId?: string;
+        /** The asset that was published. */
+        assetId: string;
+        /** The publish asset representing the publish. */
+        publishId: string;
+        /** The connection that was used to publish the asset. */
+        connectionId: string;
+    };
+}
+export type UserNotificationRecord = UserNotificationAssigned | UserNotificationUnassigned | UserNotificationComment | UserNotificationAddedToSearch | UserNotificationPublishSucceeded;
+export interface UserNotificationDomainReadAtRecord {
+    /**
+     * ISO8601 date string. If set, the user has marked the notification as read at that timestamp.
+     */
+    value?: string;
+}

package/dist/records/domains/user-notification.js

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

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

@@ -0,0 +1,23 @@
+export interface UserDomainRecords {
+    ":user": UserDomainRecord;
+    ":user.latestSeenNotification": UserDomainLatestSeenNotificationRecord;
+    ":user.receivedNotifications?": UserDomainReceivedNotificationsProvidedRecord;
+    ":user.unseenNotifications?": UserDomainUnseenNotificationsRecord;
+}
+export interface UserDomainRecord {
+    username?: string;
+    roles?: string[];
+}
+export interface UserDomainLatestSeenNotificationRecord {
+    value?: string;
+}
+export interface UserDomainReceivedNotificationsProvidedRecord {
+    /**
+     * IDs of notifications the user has received.
+     */
+    value?: string[];
+}
+export interface UserDomainUnseenNotificationsRecord {
+    hasUnseen?: boolean;
+    latestReceived?: string;
+}

package/dist/records/domains/user.js

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