@nxtedition/types 23.0.19 → 23.0.20

package/dist/common/nxtpression.d.ts

@@ -1,5 +1,5 @@
 import { type AssertionGuard as __AssertionGuard } from "typia";
-export type Nxtpression<ReturnValue = string, Context extends object = object> = String & {
+export type Nxtpression<ReturnValue = string, Context extends object = object> = (String & {
     /**
      * 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.
@@ -10,7 +10,7 @@ export type Nxtpression<ReturnValue = string, Context extends object = object> =
      * it is only here to make sure the generic Context won't get stripped.
      */
     __returnValue?: ReturnValue;
-};
+}) | string;
 export declare const isNxtpression: (input: unknown) => input is Nxtpression<string, object>;
 export declare const assertNxtpression: (input: unknown) => Nxtpression<string, object>;
 export declare const randomNxtpression: () => string;

package/dist/common/nxtpression.js

@@ -11,7 +11,7 @@ export const isNxtpression = input => {
         return true;
     });
     const $io1 = input => true;
-    return "object" === typeof input && null !== input && $io0(input);
+    return null !== input && undefined !== input && ("string" === typeof input || "object" === typeof input && null !== input && $io0(input));
 };
 export const assertNxtpression = (input, errorFactory) => {
     const __is = input => {
@@ -26,7 +26,7 @@ export const assertNxtpression = (input, errorFactory) => {
             return true;
         });
         const $io1 = input => true;
-        return "object" === typeof input && null !== input && $io0(input);
+        return null !== input && undefined !== input && ("string" === typeof input || "object" === typeof input && null !== input && $io0(input));
     };
     if (false === __is(input))
         ((input, _path, _exceptionable = true) => {
@@ -63,15 +63,23 @@ export const assertNxtpression = (input, errorFactory) => {
                 return true;
             }));
             const $ao1 = (input, _path, _exceptionable = true) => true;
-            return ("object" === typeof input && null !== input || $guard(true, {
+            return (null !== input || $guard(true, {
                 path: _path + "",
-                expected: "Nxtpression<string, object>",
+                expected: "(String & { __context?: object | undefined; __returnValue?: string | undefined; } | string)",
+                value: input
+            }, errorFactory)) && (undefined !== input || $guard(true, {
+                path: _path + "",
+                expected: "(String & { __context?: object | undefined; __returnValue?: string | undefined; } | string)",
+                value: input
+            }, errorFactory)) && ("string" === typeof input || ("object" === typeof input && null !== input || $guard(true, {
+                path: _path + "",
+                expected: "(String & { __context?: object | undefined; __returnValue?: string | undefined; } | string)",
                 value: input
             }, errorFactory)) && $ao0(input, _path + "", true) || $guard(true, {
                 path: _path + "",
-                expected: "Nxtpression<string, object>",
+                expected: "(String & { __context?: object | undefined; __returnValue?: string | undefined; } | string)",
                 value: input
-            }, errorFactory);
+            }, errorFactory));
         })(input, "$input", true);
     return input;
 };
@@ -94,7 +102,10 @@ export const randomNxtpression = generator => {
         return output;
     };
     const $ro1 = (_recursive = false, _depth = 0) => {};
-    return $ro0();
+    return $pick([
+        () => (generator?.customs ?? $generator.customs)?.string?.([]) ?? (generator?.string ?? $generator.string)(),
+        () => $ro0()
+    ])();
 };
 export const assertGuardNxtpression = (input, errorFactory) => {
     const __is = input => {
@@ -109,7 +120,7 @@ export const assertGuardNxtpression = (input, errorFactory) => {
             return true;
         });
         const $io1 = input => true;
-        return "object" === typeof input && null !== input && $io0(input);
+        return null !== input && undefined !== input && ("string" === typeof input || "object" === typeof input && null !== input && $io0(input));
     };
     if (false === __is(input))
         ((input, _path, _exceptionable = true) => {
@@ -146,26 +157,44 @@ export const assertGuardNxtpression = (input, errorFactory) => {
                 return true;
             }));
             const $ao1 = (input, _path, _exceptionable = true) => true;
-            return ("object" === typeof input && null !== input || $guard(true, {
+            return (null !== input || $guard(true, {
+                path: _path + "",
+                expected: "(String & { __context?: object | undefined; __returnValue?: string | undefined; } | string)",
+                value: input
+            }, errorFactory)) && (undefined !== input || $guard(true, {
+                path: _path + "",
+                expected: "(String & { __context?: object | undefined; __returnValue?: string | undefined; } | string)",
+                value: input
+            }, errorFactory)) && ("string" === typeof input || ("object" === typeof input && null !== input || $guard(true, {
                 path: _path + "",
-                expected: "Nxtpression<string, object>",
+                expected: "(String & { __context?: object | undefined; __returnValue?: string | undefined; } | string)",
                 value: input
             }, errorFactory)) && $ao0(input, _path + "", true) || $guard(true, {
                 path: _path + "",
-                expected: "Nxtpression<string, object>",
+                expected: "(String & { __context?: object | undefined; __returnValue?: string | undefined; } | string)",
                 value: input
-            }, errorFactory);
+            }, errorFactory));
         })(input, "$input", true);
 };
 export const stringifyNxtpression = input => {
     const $io1 = input => true;
     const $string = __typia.json.createStringify.string;
+    const $throws = __typia.json.createStringify.throws;
     const $tail = __typia.json.createStringify.tail;
     const $so0 = input => `{${$tail(`${undefined === input.__context ? "" : `"__context":${undefined !== input.__context ? "{}" : undefined},`}${undefined === input.__returnValue ? "" : `"__returnValue":${undefined !== input.__returnValue ? $string(input.__returnValue) : undefined},`}"length":${input.length},${Object.entries(input).map(([key, value]) => { if (undefined === value)
         return ""; if (["__context", "__returnValue", "length"].some(regular => regular === key))
         return ""; if (RegExp(/^[+-]?\d+(?:\.\d+)?(?:[eE][+-]?\d+)?$/).test(key))
         return `${JSON.stringify(key)}:${$string(value)}`; return ""; }).filter(str => "" !== str).join(",")}`)}}`;
-    return $so0(input);
+    return (() => {
+        if ("string" === typeof input)
+            return $string(input);
+        if ("object" === typeof input && null !== input)
+            return $so0(input);
+        $throws({
+            expected: "(String & { __context?: object | undefined; __returnValue?: string | undefined; } | string)",
+            value: input
+        });
+    })();
 };
 export const assertStringifyNxtpression = (input, errorFactory) => { const assert = (input, errorFactory) => {
     const __is = input => {
@@ -180,7 +209,7 @@ export const assertStringifyNxtpression = (input, errorFactory) => { const asser
             return true;
         });
         const $io1 = input => true;
-        return "object" === typeof input && null !== input && $io0(input);
+        return null !== input && undefined !== input && ("string" === typeof input || "object" === typeof input && null !== input && $io0(input));
     };
     if (false === __is(input))
         ((input, _path, _exceptionable = true) => {
@@ -217,24 +246,42 @@ export const assertStringifyNxtpression = (input, errorFactory) => { const asser
                 return true;
             }));
             const $ao1 = (input, _path, _exceptionable = true) => true;
-            return ("object" === typeof input && null !== input || $guard(true, {
+            return (null !== input || $guard(true, {
+                path: _path + "",
+                expected: "(String & { __context?: object | undefined; __returnValue?: string | undefined; } | string)",
+                value: input
+            }, errorFactory)) && (undefined !== input || $guard(true, {
                 path: _path + "",
-                expected: "Nxtpression<string, object>",
+                expected: "(String & { __context?: object | undefined; __returnValue?: string | undefined; } | string)",
+                value: input
+            }, errorFactory)) && ("string" === typeof input || ("object" === typeof input && null !== input || $guard(true, {
+                path: _path + "",
+                expected: "(String & { __context?: object | undefined; __returnValue?: string | undefined; } | string)",
                 value: input
             }, errorFactory)) && $ao0(input, _path + "", true) || $guard(true, {
                 path: _path + "",
-                expected: "Nxtpression<string, object>",
+                expected: "(String & { __context?: object | undefined; __returnValue?: string | undefined; } | string)",
                 value: input
-            }, errorFactory);
+            }, errorFactory));
         })(input, "$input", true);
     return input;
 }; const stringify = input => {
     const $io1 = input => true;
     const $string = __typia.json.createAssertStringify.string;
+    const $throws = __typia.json.createAssertStringify.throws;
     const $tail = __typia.json.createAssertStringify.tail;
     const $so0 = input => `{${$tail(`${undefined === input.__context ? "" : `"__context":${undefined !== input.__context ? "{}" : undefined},`}${undefined === input.__returnValue ? "" : `"__returnValue":${undefined !== input.__returnValue ? $string(input.__returnValue) : undefined},`}"length":${input.length},${Object.entries(input).map(([key, value]) => { if (undefined === value)
         return ""; if (["__context", "__returnValue", "length"].some(regular => regular === key))
         return ""; if (RegExp(/^[+-]?\d+(?:\.\d+)?(?:[eE][+-]?\d+)?$/).test(key))
         return `${JSON.stringify(key)}:${$string(value)}`; return ""; }).filter(str => "" !== str).join(",")}`)}}`;
-    return $so0(input);
+    return (() => {
+        if ("string" === typeof input)
+            return $string(input);
+        if ("object" === typeof input && null !== input)
+            return $so0(input);
+        $throws({
+            expected: "(String & { __context?: object | undefined; __returnValue?: string | undefined; } | string)",
+            value: input
+        });
+    })();
 }; return stringify(assert(input, errorFactory)); };

package/dist/domains/index.d.ts

@@ -13,6 +13,7 @@ import type { EventDomainRecords } from './event.js';
 import type { FileDomainRecords } from './file.js';
 import type { GeneralDomainRecords } from './general.js';
 import type { MediaDomainRecords } from './media.js';
+import type { PanelDomainRecords } from './panel.js';
 import type { PermissionDomainRecords } from './permission.js';
 import type { PipelinePresetDomainRecords } from './pipeline-preset.js';
 import type { PipelineDomainRecords } from './pipeline.js';
@@ -46,6 +47,7 @@ export * from './event.js';
 export * from './file.js';
 export * from './general.js';
 export * from './media.js';
+export * from './panel.js';
 export * from './permission.js';
 export * from './pipeline-preset.js';
 export * from './pipeline.js';
@@ -64,4 +66,4 @@ export * from './template.js';
 export * from './user-notification-status.js';
 export * from './user-notification.js';
 export * from './user.js';
-export type DomainRecords = AssetDomainRecords & BundleDomainRecords & CloneDomainRecords & CommentReactionDomainRecords & CommentReadMarkDomainRecords & CommentDomainRecords & ConnectionDomainRecords & ContactDomainRecords & DeepstreamDomainRecords & DesignDomainRecords & EditDomainRecords & EventDomainRecords & FileDomainRecords & GeneralDomainRecords & MediaDomainRecords & PermissionDomainRecords & PipelinePresetDomainRecords & PipelineDomainRecords & PlanningDomainRecords & PublishDomainRecords & PublishedDomainRecords & RenderPresetDomainRecords & RevsDomainRecords & RoleDomainRecords & ScriptDomainRecords & SearchDomainRecords & SettingsDomainRecords & StoryboardDomainRecords & SubtitleStyleDomainRecords & TemplateDomainRecords & UserNotificationStatusDomainRecords & UserNotificationDomainRecords & UserDomainRecords;
+export type DomainRecords = AssetDomainRecords & BundleDomainRecords & CloneDomainRecords & CommentReactionDomainRecords & CommentReadMarkDomainRecords & CommentDomainRecords & ConnectionDomainRecords & ContactDomainRecords & DeepstreamDomainRecords & DesignDomainRecords & EditDomainRecords & EventDomainRecords & FileDomainRecords & GeneralDomainRecords & MediaDomainRecords & PanelDomainRecords & PermissionDomainRecords & PipelinePresetDomainRecords & PipelineDomainRecords & PlanningDomainRecords & PublishDomainRecords & PublishedDomainRecords & RenderPresetDomainRecords & RevsDomainRecords & RoleDomainRecords & ScriptDomainRecords & SearchDomainRecords & SettingsDomainRecords & StoryboardDomainRecords & SubtitleStyleDomainRecords & TemplateDomainRecords & UserNotificationStatusDomainRecords & UserNotificationDomainRecords & UserDomainRecords;

package/dist/domains/index.js

@@ -13,6 +13,7 @@ export * from './event.js';
 export * from './file.js';
 export * from './general.js';
 export * from './media.js';
+export * from './panel.js';
 export * from './permission.js';
 export * from './pipeline-preset.js';
 export * from './pipeline.js';

package/dist/domains/panel.d.ts

@@ -0,0 +1,104 @@
+import { type AssertionGuard as __AssertionGuard } from "typia";
+import { Nxtpression } from '../common/nxtpression.js';
+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 declare const isPanelDomainPanelRecord: (input: unknown) => input is PanelDomainPanelRecord;
+export declare const assertPanelDomainPanelRecord: (input: unknown) => PanelDomainPanelRecord;
+export declare const randomPanelDomainPanelRecord: () => PanelDomainPanelRecord;
+export declare const assertGuardPanelDomainPanelRecord: __AssertionGuard<PanelDomainPanelRecord>;
+export declare const stringifyPanelDomainPanelRecord: (input: PanelDomainPanelRecord) => string;
+export declare const assertStringifyPanelDomainPanelRecord: (input: unknown) => string;
+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 declare const isPanelProperty: (input: unknown) => input is PanelProperty;
+export declare const assertPanelProperty: (input: unknown) => PanelProperty;
+export declare const randomPanelProperty: () => PanelProperty;
+export declare const assertGuardPanelProperty: __AssertionGuard<PanelProperty>;
+export declare const stringifyPanelProperty: (input: PanelProperty) => string;
+export declare const assertStringifyPanelProperty: (input: unknown) => string;
+export type PanelLayout = string | PanelLayoutDivider | PanelLayoutItem | PanelLayout[];
+export declare const isPanelLayout: (input: unknown) => input is PanelLayout;
+export declare const assertPanelLayout: (input: unknown) => PanelLayout;
+export declare const randomPanelLayout: () => PanelLayout;
+export declare const assertGuardPanelLayout: __AssertionGuard<PanelLayout>;
+export declare const stringifyPanelLayout: (input: PanelLayout) => string;
+export declare const assertStringifyPanelLayout: (input: unknown) => string;
+export interface PanelLayoutItem {
+    property: string;
+    width?: string | number;
+    widget?: LayoutWidget;
+}
+export declare const isPanelLayoutItem: (input: unknown) => input is PanelLayoutItem;
+export declare const assertPanelLayoutItem: (input: unknown) => PanelLayoutItem;
+export declare const randomPanelLayoutItem: () => PanelLayoutItem;
+export declare const assertGuardPanelLayoutItem: __AssertionGuard<PanelLayoutItem>;
+export declare const stringifyPanelLayoutItem: (input: PanelLayoutItem) => string;
+export declare const assertStringifyPanelLayoutItem: (input: unknown) => string;
+export interface PanelLayoutDivider {
+    type: "divider";
+    title?: string;
+}
+export declare const isPanelLayoutDivider: (input: unknown) => input is PanelLayoutDivider;
+export declare const assertPanelLayoutDivider: (input: unknown) => PanelLayoutDivider;
+export declare const randomPanelLayoutDivider: () => PanelLayoutDivider;
+export declare const assertGuardPanelLayoutDivider: __AssertionGuard<PanelLayoutDivider>;
+export declare const stringifyPanelLayoutDivider: (input: PanelLayoutDivider) => string;
+export declare const assertStringifyPanelLayoutDivider: (input: unknown) => string;
+export type LayoutWidget = WidgetType | WidgetItem;
+export declare const isLayoutWidget: (input: unknown) => input is LayoutWidget;
+export declare const assertLayoutWidget: (input: unknown) => LayoutWidget;
+export declare const randomLayoutWidget: () => LayoutWidget;
+export declare const assertGuardLayoutWidget: __AssertionGuard<LayoutWidget>;
+export declare const stringifyLayoutWidget: (input: LayoutWidget) => string;
+export declare const assertStringifyLayoutWidget: (input: unknown) => string;
+export type WidgetType = "default" | "assetTypes" | "assetTags" | "geopoint" | "poster" | "textarea" | "tags";
+export declare const isWidgetType: (input: unknown) => input is WidgetType;
+export declare const assertWidgetType: (input: unknown) => WidgetType;
+export declare const randomWidgetType: () => WidgetType;
+export declare const assertGuardWidgetType: __AssertionGuard<WidgetType>;
+export declare const stringifyWidgetType: (input: WidgetType) => string;
+export declare const assertStringifyWidgetType: (input: unknown) => string;
+export interface WidgetItem {
+    type: WidgetType;
+    readOnly?: boolean;
+}
+export declare const isWidgetItem: (input: unknown) => input is WidgetItem;
+export declare const assertWidgetItem: (input: unknown) => WidgetItem;
+export declare const randomWidgetItem: () => WidgetItem;
+export declare const assertGuardWidgetItem: __AssertionGuard<WidgetItem>;
+export declare const stringifyWidgetItem: (input: WidgetItem) => string;
+export declare const assertStringifyWidgetItem: (input: unknown) => string;