@nxtedition/types 23.1.6 → 23.1.7

package/dist/nxtpression.d.ts

@@ -414,38 +414,6 @@ declare interface AuthDomainRecords {
     ":auth": AuthDomainRecord;
 }
 
-declare 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;
-    };
-}
-
 declare interface BundleDomainRecords {
     [":bundle"]: BundleRecord;
     [":bundle.revisions"]: BundleRevisionsRecord;
@@ -621,6 +589,17 @@ declare interface ContactRecord {
     address?: string;
 }
 
+/**
+ * @link https://oozcitak.github.io/xmlbuilder2/builder-functions.html#settings-related-to-value-conversions
+ */
+declare interface ConvertOptions {
+    att?: string;
+    ins?: string;
+    text?: string;
+    cdata?: string;
+    comment?: string;
+}
+
 declare interface CopyOperation {
     op: 'copy';
     from: string;
@@ -893,6 +872,10 @@ declare interface EventTemplateRecord {
 
 declare type ExactRecords = MiscRecords & MediaRecords & AssetRecords & MonitorRecords & StorageRecords;
 
+declare type ExpandObject = {
+    [key: string]: any;
+} | any[];
+
 declare interface FacebookConnectionDef extends ConnectionDef<"facebook"> {
     connection: FacebookConnectionRecord;
 }
@@ -2192,6 +2175,12 @@ export declare interface NxtpressionNxt {
     hash(value: unknown): string;
 }
 
+declare type NxtpressionSchemaProperty<Value = unknown> = {
+    [K in keyof SchemaProperty<Value>]: Nxtpression<SchemaProperty<Value>[K], {
+        id: string;
+    }>;
+};
+
 declare interface NxtStatusMessage {
     id: string;
     msg: string;
@@ -2428,21 +2417,77 @@ declare interface PanelDomainPanelRecord {
     priority?: number;
     editorPriority?: number;
     properties?: {
-        [key: string]: PanelProperty;
+        [key: string]: PanelRootProperty;
     };
     layout?: {
         panel?: WidgetLayout;
         editor?: WidgetLayout;
+        csv?: string[] | true;
+        json?: string[] | true;
+        xml?: string[] | true;
+        rss?: string[] | true;
     };
     filter?: Nxtpression;
-    expand?: Nxtpression;
+    expand?: Nxtpression<unknown>;
+    expandSkipEmpty?: boolean;
+    xml?: ReportXmlOptions;
+    rss?: ReportRssOptions;
+    /**
+     * For reports. Only when :publish#expand.type === 'published'.
+     * If an already expanded to :published record is connected to an ingestclip,
+     * expand further on all :published records of type 'event' that were created
+     * during the ingestclip's time range.
+     *
+     * The use case is to find e.g. music that was played during a broadcast of
+     * an ingestclip.
+     */
+    expandIngestclip?: boolean;
+    /**
+     * For reports, when :publish#expand.type === 'published'.
+     * Due to legacy reasons publishedTypes defaults to ['event'],
+     * if you want all types, set publishedTypes to null.
+     */
+    publishedTypes?: string[] | null;
 }
 
 declare interface PanelDomainRecords {
     ":panel": PanelDomainPanelRecord;
 }
 
-declare type PanelProperty<Value = unknown> = BaseSchemaProperty<Value>;
+declare interface PanelProperty<Value = unknown> {
+    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<PanelProperty>;
+    anyOf?: Array<PanelProperty>;
+    enum?: ReadonlyArray<Value>;
+    minItems?: number;
+    maxItems?: number;
+    items?: PanelProperty<Value>;
+    const?: Value;
+    properties?: Record<string, PanelProperty<unknown>>;
+    widget?: WidgetType | WidgetOptions;
+    placeholder?: string;
+    helpText?: string;
+    invalid?: boolean;
+    emptyValue?: Value;
+}
+
+declare interface PanelRootProperty<Value = unknown> extends Omit<PanelProperty<Value>, "const"> {
+    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;
+    };
+}
 
 declare interface ParagraphNodeContent extends ElementNodeContent {
     type: "paragraph";
@@ -3064,6 +3109,104 @@ declare interface ReplaceOperation {
     value: any;
 }
 
+declare interface ReportConnectionDef extends ConnectionDef<"report"> {
+    connection: ReportConnectionRecord;
+}
+
+declare interface ReportConnectionRecord extends ConnectionBase {
+    type?: "report";
+}
+
+declare interface ReportPublishDef extends PublishDef<"report"> {
+    publish: ReportPublishRecord;
+    stats: ReportPublishStatsRecord;
+}
+
+declare type ReportPublishExpandType = "published" | "deadlines" | "recurrence_date_range";
+
+declare type ReportPublishFormat = "csv" | "json" | "xml" | "rss";
+
+/**
+ * A report can be downloaded from `/report/${publishId}[/${route}]/report.${format}`.
+ *
+ * Search query parameters:
+ * - `start`: Date string parsable by `new Date()`. Overrides expand.start.
+ * - `end`: Date string parsable by `new Date()`. Overrides expand.end.
+ * - `token`: Unique identifier used to track report progress.
+ */
+declare interface ReportPublishRecord extends PublishRecordBase {
+    type?: "report";
+    searchId?: string;
+    /**
+     * If specified, for each search hit, additional rows will be added to the
+     * report, based on the expand type.
+     *
+     * If type: "published", the report will expand with one row per :published
+     * record that refers to the search hit and is within the date range.
+     * The expression context passed to the panel's computed fields
+     * will be extended with a `published` object containing data from the
+     * corresponding :published record. NOTE: By default it will only expand
+     * :published records of type: "event", unless a `filter` expression is
+     * specified on the panel.
+     *
+     * If type: "deadlines", the report will expand with one row per deadline
+     * provided by a search hit's :asset.deadline#value array. The expression
+     * context passed to the panel's computed fields will be extended with a
+     * `deadline` being a Date object corresponding to the deadline value.
+     *
+     * If type: "recurrence_date_range", the report will expand with one row
+     * per date specified by a search hit's :calendarevent record (which could
+     * be a recurrence expression evaluating to multiple dates) that falls within
+     * the specified date range. The expression context passed to the panel's
+     * computed fields will be extended with a `calendarevent` object with
+     * a `start` and `end` Date object.
+     */
+    expand?: {
+        type?: ReportPublishExpandType | "";
+        start?: string;
+        end?: string;
+    };
+    /** Asset ID */
+    panel?: string;
+    /** The report can be downloaded from `/report/${publishId}[/${route}]`. */
+    route?: string;
+    /** Field name to sort by */
+    sort?: string;
+    /** Sort order */
+    order?: "asc" | "desc";
+    /** Used by the hub, which passes it as filename extension to the download URL */
+    format?: ReportPublishFormat;
+    xml?: ReportXmlOptions;
+}
+
+declare interface ReportPublishStatsRecord extends PublishStatsRecordBase {
+    retrieved?: {
+        total?: number;
+        count?: number;
+    };
+}
+
+declare interface ReportRssOptions extends Partial<RssOptions> {
+    namespaces?: Record<string, string>;
+}
+
+declare interface ReportXmlOptions {
+    options?: XMLBuilderOptions;
+    formatterOptions?: XMLWriterOptions;
+    /**
+     * Should resolve to a JS object representing the root XML schema, as readable by xmlbuilder2.
+     */
+    rootSchema?: Nxtpression<ExpandObject, {
+        publishId: string;
+        items: unknown[];
+    }>;
+    /**
+     * Should resolve to a JS object representing the XML schema for each item, as readable by xmlbuilder2.
+     * Required for output to be generated.
+     */
+    itemSchema?: Nxtpression<ExpandObject>;
+}
+
 declare interface ResolvedFilePublishRender extends PublishRenderBase {
     name?: string;
     path: string;
@@ -3114,6 +3257,40 @@ declare interface RpcPermission {
     tags?: undefined;
 }
 
+declare interface RssAuthor {
+    name?: string;
+    email?: string;
+    link?: string;
+    avatar?: string;
+}
+
+declare interface RssOptions {
+    id?: string;
+    title: string;
+    updated?: string | number;
+    generator?: string;
+    language?: string;
+    ttl?: number;
+    stylesheet?: string;
+    feed?: string;
+    feedLinks?: {
+        rss?: string;
+        atom?: string;
+        json?: string;
+        [key: string]: string | undefined;
+    };
+    hub?: string;
+    docs?: string;
+    podcast?: boolean;
+    category?: string;
+    author?: RssAuthor;
+    link?: string;
+    description?: string;
+    image?: string;
+    favicon?: string;
+    copyright?: string;
+}
+
 declare interface SchemaDomainPanelRecord {
     title?: string;
     /**
@@ -3124,7 +3301,7 @@ declare interface SchemaDomainPanelRecord {
     domain?: string;
     priority?: number;
     properties?: {
-        [key: string]: SchemaProperty;
+        [key: string]: SchemaRootProperty;
     };
     layout?: {
         panel?: WidgetLayout;
@@ -3136,7 +3313,33 @@ declare interface SchemaDomainRecords {
     ":schema": SchemaDomainPanelRecord;
 }
 
-declare interface SchemaProperty<Value = unknown> extends BaseSchemaProperty<Value> {
+declare interface SchemaProperty<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;
+    /** If present, indicates that the user must specify a value for the asset to be treated as valid. */
+    required?: boolean;
+    oneOf?: Array<SchemaProperty>;
+    anyOf?: Array<SchemaProperty>;
+    enum?: ReadonlyArray<Value>;
+    minItems?: number;
+    maxItems?: number;
+    items?: SchemaProperty<Value>;
+    properties?: Record<string, SchemaProperty<unknown>>;
+    default?: Value;
+    const?: Value;
+    widget?: WidgetType | WidgetOptions;
+    placeholder?: string;
+    helpText?: string;
+    invalid?: boolean;
+    emptyValue?: Value;
+}
+
+declare interface SchemaRootProperty<Value = unknown> extends NxtpressionSchemaProperty<Value> {
+    domain?: string;
+    path?: string;
     recordName?: Nxtpression<string, {
         id: string;
     }>;
@@ -3144,8 +3347,13 @@ declare interface SchemaProperty<Value = unknown> extends BaseSchemaProperty<Val
         id: string;
         value: unknown;
     }>;
-    default?: Value;
-    const?: 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;
+    };
 }
 
 /**
@@ -4563,9 +4771,9 @@ export declare interface Underscore {
     fetch(options?: RequestInit, suspend?: boolean): (resource: string) => NxtpressionFetch;
 }
 
-declare type Union = FileConnectionDef | FacebookConnectionDef | ReutersConnectionDef | EmptyConnectionDef;
+declare type Union = FileConnectionDef | FacebookConnectionDef | ReportConnectionDef | ReutersConnectionDef | EmptyConnectionDef;
 
-declare type Union_2 = EmptyPublishDef | YoutubePublishDef | FacebookPublishDef | FilePublishDef | FileLegacyPublishDef;
+declare type Union_2 = EmptyPublishDef | ReportPublishDef | YoutubePublishDef | FacebookPublishDef | FilePublishDef | FileLegacyPublishDef;
 
 declare interface Unsubscribable {
     unsubscribe(): void;
@@ -4740,6 +4948,47 @@ declare interface WidgetOptions {
 
 declare type WidgetType = string;
 
+/**
+ * @link https://oozcitak.github.io/xmlbuilder2/builder-functions.html#builder-options
+ */
+declare interface XMLBuilderOptions {
+    [key: string]: unknown;
+    version?: "1.0";
+    encoding?: string | undefined;
+    standalone?: boolean | undefined;
+    keepNullNodes?: boolean;
+    keepNullAttributes?: boolean;
+    ignoreConverters?: boolean;
+    skipWhitespaceOnlyText?: boolean;
+    convert?: ConvertOptions;
+    defaultNamespace?: {
+        ele?: undefined | null | string;
+        att?: undefined | null | string;
+    };
+    namespaceAlias?: {
+        [key: string]: string | null | undefined;
+    };
+    invalidCharReplacement?: string | ((char: string, offset: number, str: string) => string) | undefined;
+    parser?: any;
+}
+
+/**
+ * @link https://oozcitak.github.io/xmlbuilder2/serialization.html#serialization-settings
+ */
+declare interface XMLWriterOptions {
+    wellFormed?: boolean;
+    format?: "xml";
+    headless?: boolean;
+    prettyPrint?: boolean;
+    indent?: string;
+    newline?: string;
+    offset?: number;
+    width?: number;
+    allowEmptyTags?: boolean;
+    indentTextOnlyNodes?: boolean;
+    spaceBeforeSlash?: boolean;
+}
+
 /**
  * A base64 encoded string representing a complete Yjs document state.
  * This is created using `Y.encodeStateAsUpdate()` and is used for

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

@@ -2,11 +2,13 @@ import type { FileConnectionDef } from './file/index.ts';
 export * from './file/index.ts';
 import type { FacebookConnectionDef } from './facebook.ts';
 export * from './facebook.ts';
+import type { ReportConnectionDef } from './report.ts';
+export * from './report.ts';
 import type { ReutersConnectionDef } from './reuters.ts';
 export * from './reuters.ts';
 import type { EmptyConnectionDef } from './empty.ts';
 export * from './empty.ts';
-type Union = FileConnectionDef | FacebookConnectionDef | ReutersConnectionDef | EmptyConnectionDef;
+type Union = FileConnectionDef | FacebookConnectionDef | ReportConnectionDef | ReutersConnectionDef | EmptyConnectionDef;
 export type ConnectionRecord = Union["connection"];
 export type MethodsRecord = Union["methods"];
 export type StatsRecord = Union["stats"];

package/dist/records/domains/connection/index.js

@@ -1,4 +1,5 @@
 export * from "./file/index.js";
 export * from "./facebook.js";
+export * from "./report.js";
 export * from "./reuters.js";
 export * from "./empty.js";

package/dist/records/domains/connection/report.d.ts

@@ -0,0 +1,7 @@
+import type { ConnectionDef, ConnectionBase } from './index.ts';
+export interface ReportConnectionDef extends ConnectionDef<"report"> {
+    connection: ReportConnectionRecord;
+}
+export interface ReportConnectionRecord extends ConnectionBase {
+    type?: "report";
+}

package/dist/records/domains/connection/report.js

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

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

@@ -1,4 +1,4 @@
-import type { Nxtpression, PanelProperty, WidgetLayout } from '../../common/index.ts';
+import type { Nxtpression, PanelRootProperty, WidgetLayout, ReportRssOptions, ReportXmlOptions } from '../../common/index.ts';
 export interface PanelDomainRecords {
     ":panel": PanelDomainPanelRecord;
 }
@@ -12,12 +12,35 @@ export interface PanelDomainPanelRecord {
     priority?: number;
     editorPriority?: number;
     properties?: {
-        [key: string]: PanelProperty;
+        [key: string]: PanelRootProperty;
     };
     layout?: {
         panel?: WidgetLayout;
         editor?: WidgetLayout;
+        csv?: string[] | true;
+        json?: string[] | true;
+        xml?: string[] | true;
+        rss?: string[] | true;
     };
     filter?: Nxtpression;
-    expand?: Nxtpression;
+    expand?: Nxtpression<unknown>;
+    expandSkipEmpty?: boolean;
+    xml?: ReportXmlOptions;
+    rss?: ReportRssOptions;
+    /**
+     * For reports. Only when :publish#expand.type === 'published'.
+     * If an already expanded to :published record is connected to an ingestclip,
+     * expand further on all :published records of type 'event' that were created
+     * during the ingestclip's time range.
+     *
+     * The use case is to find e.g. music that was played during a broadcast of
+     * an ingestclip.
+     */
+    expandIngestclip?: boolean;
+    /**
+     * For reports, when :publish#expand.type === 'published'.
+     * Due to legacy reasons publishedTypes defaults to ['event'],
+     * if you want all types, set publishedTypes to null.
+     */
+    publishedTypes?: string[] | null;
 }

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

@@ -7,9 +7,11 @@ import type { FileLegacyPublishDef } from './file-legacy.ts';
 export * from './file-legacy.ts';
 import type { FilePublishDef } from './file.ts';
 export * from './file.ts';
+import type { ReportPublishDef } from './report.ts';
+export * from './report.ts';
 import type { YoutubePublishDef } from './youtube.ts';
 export * from './youtube.ts';
-type Union = EmptyPublishDef | YoutubePublishDef | FacebookPublishDef | FilePublishDef | FileLegacyPublishDef;
+type Union = EmptyPublishDef | ReportPublishDef | YoutubePublishDef | FacebookPublishDef | FilePublishDef | FileLegacyPublishDef;
 export type PublishDefOfType<T extends string | null> = Union & {
     type: T;
 };

package/dist/records/domains/publish/index.js

@@ -2,4 +2,5 @@ export * from "./empty.js";
 export * from "./facebook.js";
 export * from "./file-legacy.js";
 export * from "./file.js";
+export * from "./report.js";
 export * from "./youtube.js";

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

@@ -0,0 +1,70 @@
+import type { PublishDef, PublishRecordBase, PublishStatsRecordBase } from './index.ts';
+import type { ReportXmlOptions } from '../../../common/report.ts';
+export interface ReportPublishDef extends PublishDef<"report"> {
+    publish: ReportPublishRecord;
+    stats: ReportPublishStatsRecord;
+}
+export type ReportPublishFormat = "csv" | "json" | "xml" | "rss";
+export declare const isReportPublishFormat: (input: unknown) => input is ReportPublishFormat;
+export type ReportPublishExpandType = "published" | "deadlines" | "recurrence_date_range";
+export declare const isReportPublishExpandType: (input: unknown) => input is ReportPublishExpandType;
+/**
+ * A report can be downloaded from `/report/${publishId}[/${route}]/report.${format}`.
+ *
+ * Search query parameters:
+ * - `start`: Date string parsable by `new Date()`. Overrides expand.start.
+ * - `end`: Date string parsable by `new Date()`. Overrides expand.end.
+ * - `token`: Unique identifier used to track report progress.
+ */
+export interface ReportPublishRecord extends PublishRecordBase {
+    type?: "report";
+    searchId?: string;
+    /**
+     * If specified, for each search hit, additional rows will be added to the
+     * report, based on the expand type.
+     *
+     * If type: "published", the report will expand with one row per :published
+     * record that refers to the search hit and is within the date range.
+     * The expression context passed to the panel's computed fields
+     * will be extended with a `published` object containing data from the
+     * corresponding :published record. NOTE: By default it will only expand
+     * :published records of type: "event", unless a `filter` expression is
+     * specified on the panel.
+     *
+     * If type: "deadlines", the report will expand with one row per deadline
+     * provided by a search hit's :asset.deadline#value array. The expression
+     * context passed to the panel's computed fields will be extended with a
+     * `deadline` being a Date object corresponding to the deadline value.
+     *
+     * If type: "recurrence_date_range", the report will expand with one row
+     * per date specified by a search hit's :calendarevent record (which could
+     * be a recurrence expression evaluating to multiple dates) that falls within
+     * the specified date range. The expression context passed to the panel's
+     * computed fields will be extended with a `calendarevent` object with
+     * a `start` and `end` Date object.
+     */
+    expand?: {
+        type?: ReportPublishExpandType | "";
+        start?: string;
+        end?: string;
+    };
+    /** Asset ID */
+    panel?: string;
+    /** The report can be downloaded from `/report/${publishId}[/${route}]`. */
+    route?: string;
+    /** Field name to sort by */
+    sort?: string;
+    /** Sort order */
+    order?: "asc" | "desc";
+    /** Used by the hub, which passes it as filename extension to the download URL */
+    format?: ReportPublishFormat;
+    xml?: ReportXmlOptions;
+}
+export declare const isReportPublishRecord: (input: unknown) => input is ReportPublishRecord;
+export declare const assertReportPublishRecord: (input: unknown) => ReportPublishRecord;
+export interface ReportPublishStatsRecord extends PublishStatsRecordBase {
+    retrieved?: {
+        total?: number;
+        count?: number;
+    };
+}