@nxtedition/types 23.1.5 → 23.1.7

package/dist/common/index.d.ts

@@ -16,7 +16,9 @@ export * from './render-preset.ts';
 export * from './render-profile.ts';
 export * from './render-query.ts';
 export * from './render-scene.ts';
+export * from './report.ts';
 export * from './rule.ts';
+export * from './rss.ts';
 export * from './schema-property.ts';
 export * from './search.ts';
 export * from './settings.ts';

package/dist/common/index.js

@@ -16,7 +16,9 @@ export * from "./render-preset.js";
 export * from "./render-profile.js";
 export * from "./render-query.js";
 export * from "./render-scene.js";
+export * from "./report.js";
 export * from "./rule.js";
+export * from "./rss.js";
 export * from "./schema-property.js";
 export * from "./search.js";
 export * from "./settings.js";

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

@@ -1,2 +1,35 @@
-import type { BaseSchemaProperty } from './schema-property.ts';
-export type PanelProperty<Value = unknown> = BaseSchemaProperty<Value>;
+import type { Nxtpression } from './nxtpression.ts';
+import type { WidgetOptions, WidgetType } from './widget.ts';
+export 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;
+    };
+}
+export 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;
+}

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

@@ -22,6 +22,7 @@ export interface RenderSceneObject {
     video?: {
         filters?: RenderSceneFilters;
         crop?: RenderSceneCrop;
+        focus?: RenderSceneFocus;
         orientation?: number;
         /** @deprecated Use input.video.interlaced */
         interlaced?: RenderSceneInterlaced | null;
@@ -57,6 +58,10 @@ export interface RenderSceneCrop {
     width?: number;
     height?: number;
 }
+export interface RenderSceneFocus {
+    x?: number;
+    y?: number;
+}
 export type RenderSceneInterlaced = false | "tff" | "bff";
 /** true = premultiplied alpha, 'straight' = straight alpha, null/undefined = auto */
 export type RenderSceneAlpha = boolean | "straight";

package/dist/common/report.d.ts

@@ -0,0 +1,85 @@
+import type { Nxtpression } from './nxtpression.ts';
+import type { RssOptions } from './rss.ts';
+export 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>;
+}
+export interface ReportRssOptions extends Partial<RssOptions> {
+    namespaces?: Record<string, string>;
+}
+export declare const isXmlExpandable: (input: unknown) => input is ExpandObject;
+export type ExpandObject = {
+    [key: string]: any;
+} | any[];
+/**
+ * @link https://oozcitak.github.io/xmlbuilder2/builder-functions.html#builder-options
+ */
+export 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/builder-functions.html#settings-related-to-value-conversions
+ */
+interface ConvertOptions {
+    att?: string;
+    ins?: string;
+    text?: string;
+    cdata?: string;
+    comment?: string;
+}
+/**
+ * @link https://oozcitak.github.io/xmlbuilder2/serialization.html#serialization-settings
+ */
+interface XMLWriterOptions {
+    wellFormed?: boolean;
+    format?: "xml";
+    headless?: boolean;
+    prettyPrint?: boolean;
+    indent?: string;
+    newline?: string;
+    offset?: number;
+    width?: number;
+    allowEmptyTags?: boolean;
+    indentTextOnlyNodes?: boolean;
+    spaceBeforeSlash?: boolean;
+}
+export interface ReportProgress {
+    token: string;
+    count?: number;
+    progress?: number;
+    complete?: boolean;
+    hits?: number;
+    total?: number;
+    error?: string | null;
+}
+export declare const isReportProgress: (input: unknown) => input is ReportProgress;
+export {};

package/dist/common/report.js

@@ -0,0 +1,8 @@
+import typia from 'typia';
+export const isXmlExpandable = (() => { const _io0 = input => Object.keys(input).every(key => {
+    const value = input[key];
+    if (undefined === value)
+        return true;
+    return true;
+}); return input => null !== input && undefined !== input && (Array.isArray(input) || "object" === typeof input && null !== input && false === Array.isArray(input) && _io0(input)); })();
+export const isReportProgress = (() => { const _io0 = input => "string" === typeof input.token && (undefined === input.count || "number" === typeof input.count) && (undefined === input.progress || "number" === typeof input.progress) && (undefined === input.complete || "boolean" === typeof input.complete) && (undefined === input.hits || "number" === typeof input.hits) && (undefined === input.total || "number" === typeof input.total) && (null === input.error || undefined === input.error || "string" === typeof input.error); return input => "object" === typeof input && null !== input && _io0(input); })();

package/dist/common/rss.d.ts

@@ -0,0 +1,70 @@
+export 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;
+}
+export declare const isRssOptions: (input: unknown) => input is RssOptions;
+export interface RssItem {
+    title?: string;
+    id?: string;
+    link?: string;
+    date?: string | number;
+    description?: string;
+    content?: string;
+    category?: RssCategory[];
+    guid?: string;
+    image?: string | RssEnclosure;
+    audio?: string | RssEnclosure;
+    video?: string | RssEnclosure;
+    enclosure?: RssEnclosure;
+    author?: RssAuthor[];
+    contributor?: RssAuthor[];
+    published?: string | number;
+    copyright?: string;
+    extensions?: RssExtension[];
+}
+export declare const isRssItem: (input: unknown) => input is RssItem;
+export interface RssEnclosure {
+    url: string;
+    type?: string;
+    length?: number;
+    title?: string;
+    duration?: number;
+}
+export interface RssAuthor {
+    name?: string;
+    email?: string;
+    link?: string;
+    avatar?: string;
+}
+export interface RssCategory {
+    name?: string;
+    domain?: string;
+    scheme?: string;
+    term?: string;
+}
+export interface RssExtension {
+    name: string;
+    objects: any;
+}

package/dist/common/rss.js

@@ -0,0 +1,11 @@
+// mostly compat with 'feed' package
+import typia from 'typia';
+export const isRssOptions = (() => { const _io0 = input => (undefined === input.id || "string" === typeof input.id) && "string" === typeof input.title && (undefined === input.updated || "string" === typeof input.updated || "number" === typeof input.updated) && (undefined === input.generator || "string" === typeof input.generator) && (undefined === input.language || "string" === typeof input.language) && (undefined === input.ttl || "number" === typeof input.ttl) && (undefined === input.stylesheet || "string" === typeof input.stylesheet) && (undefined === input.feed || "string" === typeof input.feed) && (undefined === input.feedLinks || "object" === typeof input.feedLinks && null !== input.feedLinks && false === Array.isArray(input.feedLinks) && _io1(input.feedLinks)) && (undefined === input.hub || "string" === typeof input.hub) && (undefined === input.docs || "string" === typeof input.docs) && (undefined === input.podcast || "boolean" === typeof input.podcast) && (undefined === input.category || "string" === typeof input.category) && (undefined === input.author || "object" === typeof input.author && null !== input.author && false === Array.isArray(input.author) && _io2(input.author)) && (undefined === input.link || "string" === typeof input.link) && (undefined === input.description || "string" === typeof input.description) && (undefined === input.image || "string" === typeof input.image) && (undefined === input.favicon || "string" === typeof input.favicon) && (undefined === input.copyright || "string" === typeof input.copyright); const _io1 = input => (undefined === input.rss || "string" === typeof input.rss) && (undefined === input.atom || "string" === typeof input.atom) && (undefined === input.json || "string" === typeof input.json) && Object.keys(input).every(key => {
+    if (["rss", "atom", "json"].some(prop => key === prop))
+        return true;
+    const value = input[key];
+    if (undefined === value)
+        return true;
+    return undefined === value || "string" === typeof value;
+}); const _io2 = input => (undefined === input.name || "string" === typeof input.name) && (undefined === input.email || "string" === typeof input.email) && (undefined === input.link || "string" === typeof input.link) && (undefined === input.avatar || "string" === typeof input.avatar); return input => "object" === typeof input && null !== input && _io0(input); })();
+export const isRssItem = (() => { const _io0 = input => (undefined === input.title || "string" === typeof input.title) && (undefined === input.id || "string" === typeof input.id) && (undefined === input.link || "string" === typeof input.link) && (undefined === input.date || "string" === typeof input.date || "number" === typeof input.date) && (undefined === input.description || "string" === typeof input.description) && (undefined === input.content || "string" === typeof input.content) && (undefined === input.category || Array.isArray(input.category) && input.category.every(elem => "object" === typeof elem && null !== elem && false === Array.isArray(elem) && _io1(elem))) && (undefined === input.guid || "string" === typeof input.guid) && (null !== input.image && (undefined === input.image || "string" === typeof input.image || "object" === typeof input.image && null !== input.image && _io2(input.image))) && (null !== input.audio && (undefined === input.audio || "string" === typeof input.audio || "object" === typeof input.audio && null !== input.audio && _io2(input.audio))) && (null !== input.video && (undefined === input.video || "string" === typeof input.video || "object" === typeof input.video && null !== input.video && _io2(input.video))) && (undefined === input.enclosure || "object" === typeof input.enclosure && null !== input.enclosure && _io2(input.enclosure)) && (undefined === input.author || Array.isArray(input.author) && input.author.every(elem => "object" === typeof elem && null !== elem && false === Array.isArray(elem) && _io3(elem))) && (undefined === input.contributor || Array.isArray(input.contributor) && input.contributor.every(elem => "object" === typeof elem && null !== elem && false === Array.isArray(elem) && _io3(elem))) && (undefined === input.published || "string" === typeof input.published || "number" === typeof input.published) && (undefined === input.copyright || "string" === typeof input.copyright) && (undefined === input.extensions || Array.isArray(input.extensions) && input.extensions.every(elem => "object" === typeof elem && null !== elem && _io4(elem))); const _io1 = input => (undefined === input.name || "string" === typeof input.name) && (undefined === input.domain || "string" === typeof input.domain) && (undefined === input.scheme || "string" === typeof input.scheme) && (undefined === input.term || "string" === typeof input.term); const _io2 = input => "string" === typeof input.url && (undefined === input.type || "string" === typeof input.type) && (undefined === input.length || "number" === typeof input.length) && (undefined === input.title || "string" === typeof input.title) && (undefined === input.duration || "number" === typeof input.duration); const _io3 = input => (undefined === input.name || "string" === typeof input.name) && (undefined === input.email || "string" === typeof input.email) && (undefined === input.link || "string" === typeof input.link) && (undefined === input.avatar || "string" === typeof input.avatar); const _io4 = input => "string" === typeof input.name && true; return input => "object" === typeof input && null !== input && false === Array.isArray(input) && _io0(input); })();

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

@@ -1,28 +1,15 @@
 import type { Nxtpression } from './nxtpression.ts';
 import type { WidgetOptions, WidgetType } from './widget.ts';
-export interface BaseSchemaProperty<Value = unknown> {
+export interface SchemaRootProperty<Value = unknown> extends NxtpressionSchemaProperty<Value> {
     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>;
+    recordName?: Nxtpression<string, {
+        id: string;
+    }>;
+    setter?: Nxtpression<(value: unknown) => void, {
+        id: string;
+        value: 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. */
@@ -31,14 +18,31 @@ export interface BaseSchemaProperty<Value = unknown> {
         path: string;
     };
 }
-export interface SchemaProperty<Value = unknown> extends BaseSchemaProperty<Value> {
-    recordName?: Nxtpression<string, {
-        id: string;
-    }>;
-    setter?: Nxtpression<(value: unknown) => void, {
+export type NxtpressionSchemaProperty<Value = unknown> = {
+    [K in keyof SchemaProperty<Value>]: Nxtpression<SchemaProperty<Value>[K], {
         id: string;
-        value: unknown;
     }>;
+};
+export 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;
 }