@uides/stepwise 2.0.0-a594a958 → 2.0.0-a64dc016

package/schemas/resource/object-action.js

@@ -0,0 +1,24 @@
+import { boolean as external_valibot_boolean, literal, nullish, record, strictObject, string } from "valibot";
+import { FieldsSchema } from "../field/index.js";
+import { ObjectActionComponentSchema, ObjectActionHandlerSchema } from "./enums.js";
+const ObjectActionDisplaySchema = strictObject({
+    title: string(),
+    component: ObjectActionComponentSchema,
+    'component-params': record(string(), string()),
+    handler: nullish(ObjectActionHandlerSchema)
+});
+const ObjectActionSchema = strictObject({
+    display: record(string(), record(string(), ObjectActionDisplaySchema)),
+    arguments: nullish(FieldsSchema),
+    'argument-order': string(),
+    confirm: nullish(external_valibot_boolean())
+});
+const ObjectActionConfigDisplaySchema = strictObject({
+    title: nullish(string()),
+    component: literal('menu'),
+    icon: nullish(string())
+});
+const ObjectActionConfigSchema = strictObject({
+    display: record(string(), record(string(), ObjectActionConfigDisplaySchema))
+});
+export { ObjectActionConfigDisplaySchema, ObjectActionConfigSchema, ObjectActionDisplaySchema, ObjectActionSchema };

package/schemas/resource/resource-action.d.ts

@@ -0,0 +1,35 @@
+import * as v from 'valibot';
+export declare const ResourceActionPaginationSchema: v.StrictObjectSchema<{
+    readonly type: v.NullishSchema<v.PicklistSchema<["offset", "index-value"], undefined>, undefined>;
+    readonly limit: v.ArraySchema<v.NumberSchema<undefined>, undefined>;
+    readonly 'limit-default': v.NullishSchema<v.NumberSchema<undefined>, undefined>;
+    readonly count: v.NullishSchema<v.PicklistSchema<["on", "off", "estimate"], undefined>, undefined>;
+}, undefined>;
+export declare const ResourceActionDisplaySchema: v.StrictObjectSchema<{
+    readonly title: v.NullishSchema<v.StringSchema<undefined>, undefined>;
+    readonly component: v.PicklistSchema<["button", "auto", "inline-form"], undefined>;
+    readonly 'component-params': v.NullishSchema<v.RecordSchema<v.StringSchema<undefined>, v.StringSchema<undefined>, undefined>, undefined>;
+    readonly handler: v.PicklistSchema<["download", "load-data", "refresh-data", "show-message", "show-modal"], undefined>;
+    readonly pagination: v.NullishSchema<v.StrictObjectSchema<{
+        readonly type: v.NullishSchema<v.PicklistSchema<["offset", "index-value"], undefined>, undefined>;
+        readonly limit: v.ArraySchema<v.NumberSchema<undefined>, undefined>;
+        readonly 'limit-default': v.NullishSchema<v.NumberSchema<undefined>, undefined>;
+        readonly count: v.NullishSchema<v.PicklistSchema<["on", "off", "estimate"], undefined>, undefined>;
+    }, undefined>, undefined>;
+}, undefined>;
+export declare const ResourceActionSchema: v.StrictObjectSchema<{
+    readonly display: v.RecordSchema<v.StringSchema<undefined>, v.RecordSchema<v.StringSchema<undefined>, v.StrictObjectSchema<{
+        readonly title: v.NullishSchema<v.StringSchema<undefined>, undefined>;
+        readonly component: v.PicklistSchema<["button", "auto", "inline-form"], undefined>;
+        readonly 'component-params': v.NullishSchema<v.RecordSchema<v.StringSchema<undefined>, v.StringSchema<undefined>, undefined>, undefined>;
+        readonly handler: v.PicklistSchema<["download", "load-data", "refresh-data", "show-message", "show-modal"], undefined>;
+        readonly pagination: v.NullishSchema<v.StrictObjectSchema<{
+            readonly type: v.NullishSchema<v.PicklistSchema<["offset", "index-value"], undefined>, undefined>;
+            readonly limit: v.ArraySchema<v.NumberSchema<undefined>, undefined>;
+            readonly 'limit-default': v.NullishSchema<v.NumberSchema<undefined>, undefined>;
+            readonly count: v.NullishSchema<v.PicklistSchema<["on", "off", "estimate"], undefined>, undefined>;
+        }, undefined>, undefined>;
+    }, undefined>, undefined>, undefined>;
+    readonly arguments: v.NullishSchema<v.GenericSchema<import("../field/index.js").Fields>, undefined>;
+    readonly 'argument-order': v.NullishSchema<v.StringSchema<undefined>, undefined>;
+}, undefined>;

package/schemas/resource/resource-action.js

@@ -0,0 +1,29 @@
+import { array, nullish, number, picklist, record, strictObject, string } from "valibot";
+import { FieldsSchema } from "../field/index.js";
+import { ResourceActionComponentSchema, ResourceActionHandlerSchema } from "./enums.js";
+const ResourceActionPaginationSchema = strictObject({
+    type: nullish(picklist([
+        'offset',
+        'index-value'
+    ])),
+    limit: array(number()),
+    'limit-default': nullish(number()),
+    count: nullish(picklist([
+        'on',
+        'off',
+        'estimate'
+    ]))
+});
+const ResourceActionDisplaySchema = strictObject({
+    title: nullish(string()),
+    component: ResourceActionComponentSchema,
+    'component-params': nullish(record(string(), string())),
+    handler: ResourceActionHandlerSchema,
+    pagination: nullish(ResourceActionPaginationSchema)
+});
+const ResourceActionSchema = strictObject({
+    display: record(string(), record(string(), ResourceActionDisplaySchema)),
+    arguments: nullish(FieldsSchema),
+    'argument-order': nullish(string())
+});
+export { ResourceActionDisplaySchema, ResourceActionPaginationSchema, ResourceActionSchema };

package/schemas/resource/resource.d.ts

@@ -0,0 +1,133 @@
+import * as v from 'valibot';
+export declare const ResourceDisplaySchema: v.StrictObjectSchema<{
+    readonly title: v.StringSchema<undefined>;
+}, undefined>;
+export declare const ResourceInfoSchema: v.StrictObjectSchema<{
+    readonly fields: v.RecordSchema<v.StringSchema<undefined>, v.StrictObjectSchema<{
+        readonly display: v.RecordSchema<v.StringSchema<undefined>, v.RecordSchema<v.StringSchema<undefined>, v.StrictObjectSchema<{
+            readonly title: v.StringSchema<undefined>;
+            readonly component: v.PicklistSchema<["string", "boolean", "int", "three-block-date", "choice", "diff", "link"], undefined>;
+            readonly choices: v.NullishSchema<v.RecordSchema<v.StringSchema<undefined>, v.AnySchema, undefined>, undefined>;
+            readonly 'choices-order': v.NullishSchema<v.StringSchema<undefined>, undefined>;
+        }, undefined>, undefined>, undefined>;
+    }, undefined>, undefined>;
+    readonly 'field-order': v.StringSchema<undefined>;
+    readonly 'object-actions': v.RecordSchema<v.StringSchema<undefined>, v.StrictObjectSchema<{
+        readonly display: v.RecordSchema<v.StringSchema<undefined>, v.RecordSchema<v.StringSchema<undefined>, v.StrictObjectSchema<{
+            readonly title: v.StringSchema<undefined>;
+            readonly component: v.PicklistSchema<["button", "menu-action", "menu-action-show-details"], undefined>;
+            readonly 'component-params': v.RecordSchema<v.StringSchema<undefined>, v.StringSchema<undefined>, undefined>;
+            readonly handler: v.NullishSchema<v.PicklistSchema<["download", "redirect", "new-tab", "refresh-data", "refresh-item", "show-details", "show-message"], undefined>, undefined>;
+        }, undefined>, undefined>, undefined>;
+        readonly arguments: v.NullishSchema<v.GenericSchema<import("../index.js").Fields>, undefined>;
+        readonly 'argument-order': v.StringSchema<undefined>;
+        readonly confirm: v.NullishSchema<v.BooleanSchema<undefined>, undefined>;
+    }, undefined>, undefined>;
+    readonly 'object-actions-config': v.StrictObjectSchema<{
+        readonly display: v.RecordSchema<v.StringSchema<undefined>, v.RecordSchema<v.StringSchema<undefined>, v.StrictObjectSchema<{
+            readonly title: v.NullishSchema<v.StringSchema<undefined>, undefined>;
+            readonly component: v.LiteralSchema<"menu", undefined>;
+            readonly icon: v.NullishSchema<v.StringSchema<undefined>, undefined>;
+        }, undefined>, undefined>, undefined>;
+    }, undefined>;
+    readonly 'object-action-component': v.NullishSchema<v.StringSchema<undefined>, undefined>;
+    readonly 'object-action-order': v.StringSchema<undefined>;
+    readonly 'resource-actions': v.RecordSchema<v.StringSchema<undefined>, v.StrictObjectSchema<{
+        readonly display: v.RecordSchema<v.StringSchema<undefined>, v.RecordSchema<v.StringSchema<undefined>, v.StrictObjectSchema<{
+            readonly title: v.NullishSchema<v.StringSchema<undefined>, undefined>;
+            readonly component: v.PicklistSchema<["button", "auto", "inline-form"], undefined>;
+            readonly 'component-params': v.NullishSchema<v.RecordSchema<v.StringSchema<undefined>, v.StringSchema<undefined>, undefined>, undefined>;
+            readonly handler: v.PicklistSchema<["download", "load-data", "refresh-data", "show-message", "show-modal"], undefined>;
+            readonly pagination: v.NullishSchema<v.StrictObjectSchema<{
+                readonly type: v.NullishSchema<v.PicklistSchema<["offset", "index-value"], undefined>, undefined>;
+                readonly limit: v.ArraySchema<v.NumberSchema<undefined>, undefined>;
+                readonly 'limit-default': v.NullishSchema<v.NumberSchema<undefined>, undefined>;
+                readonly count: v.NullishSchema<v.PicklistSchema<["on", "off", "estimate"], undefined>, undefined>;
+            }, undefined>, undefined>;
+        }, undefined>, undefined>, undefined>;
+        readonly arguments: v.NullishSchema<v.GenericSchema<import("../index.js").Fields>, undefined>;
+        readonly 'argument-order': v.NullishSchema<v.StringSchema<undefined>, undefined>;
+    }, undefined>, undefined>;
+    readonly 'resource-action-order': v.StringSchema<undefined>;
+    readonly 'object-id': v.NullishSchema<v.StringSchema<undefined>, undefined>;
+    readonly display: v.RecordSchema<v.StringSchema<undefined>, v.RecordSchema<v.StringSchema<undefined>, v.StrictObjectSchema<{
+        readonly title: v.StringSchema<undefined>;
+    }, undefined>, undefined>, undefined>;
+}, undefined>;
+export declare const ResourceSchema: v.StrictObjectSchema<{
+    /** Unique identifier of the resource */
+    readonly refname: v.StringSchema<undefined>;
+    /** String, display name of resource */
+    readonly display_name: v.StringSchema<undefined>;
+    readonly entity_codename: v.StringSchema<undefined>;
+    readonly access_policy: v.PicklistSchema<["node", "tree"], undefined>;
+    readonly permission_role: v.StringSchema<undefined>;
+    /**
+     * Namespace spec of resource
+     *
+     * @see {@link Template.steps_spec} for a similar concept
+     */
+    readonly info: v.StrictObjectSchema<{
+        readonly fields: v.RecordSchema<v.StringSchema<undefined>, v.StrictObjectSchema<{
+            readonly display: v.RecordSchema<v.StringSchema<undefined>, v.RecordSchema<v.StringSchema<undefined>, v.StrictObjectSchema<{
+                readonly title: v.StringSchema<undefined>;
+                readonly component: v.PicklistSchema<["string", "boolean", "int", "three-block-date", "choice", "diff", "link"], undefined>;
+                readonly choices: v.NullishSchema<v.RecordSchema<v.StringSchema<undefined>, v.AnySchema, undefined>, undefined>;
+                readonly 'choices-order': v.NullishSchema<v.StringSchema<undefined>, undefined>;
+            }, undefined>, undefined>, undefined>;
+        }, undefined>, undefined>;
+        readonly 'field-order': v.StringSchema<undefined>;
+        readonly 'object-actions': v.RecordSchema<v.StringSchema<undefined>, v.StrictObjectSchema<{
+            readonly display: v.RecordSchema<v.StringSchema<undefined>, v.RecordSchema<v.StringSchema<undefined>, v.StrictObjectSchema<{
+                readonly title: v.StringSchema<undefined>;
+                readonly component: v.PicklistSchema<["button", "menu-action", "menu-action-show-details"], undefined>;
+                readonly 'component-params': v.RecordSchema<v.StringSchema<undefined>, v.StringSchema<undefined>, undefined>;
+                readonly handler: v.NullishSchema<v.PicklistSchema<["download", "redirect", "new-tab", "refresh-data", "refresh-item", "show-details", "show-message"], undefined>, undefined>;
+            }, undefined>, undefined>, undefined>;
+            readonly arguments: v.NullishSchema<v.GenericSchema<import("../index.js").Fields>, undefined>;
+            readonly 'argument-order': v.StringSchema<undefined>;
+            readonly confirm: v.NullishSchema<v.BooleanSchema<undefined>, undefined>;
+        }, undefined>, undefined>;
+        readonly 'object-actions-config': v.StrictObjectSchema<{
+            readonly display: v.RecordSchema<v.StringSchema<undefined>, v.RecordSchema<v.StringSchema<undefined>, v.StrictObjectSchema<{
+                readonly title: v.NullishSchema<v.StringSchema<undefined>, undefined>;
+                readonly component: v.LiteralSchema<"menu", undefined>;
+                readonly icon: v.NullishSchema<v.StringSchema<undefined>, undefined>;
+            }, undefined>, undefined>, undefined>;
+        }, undefined>;
+        readonly 'object-action-component': v.NullishSchema<v.StringSchema<undefined>, undefined>;
+        readonly 'object-action-order': v.StringSchema<undefined>;
+        readonly 'resource-actions': v.RecordSchema<v.StringSchema<undefined>, v.StrictObjectSchema<{
+            readonly display: v.RecordSchema<v.StringSchema<undefined>, v.RecordSchema<v.StringSchema<undefined>, v.StrictObjectSchema<{
+                readonly title: v.NullishSchema<v.StringSchema<undefined>, undefined>;
+                readonly component: v.PicklistSchema<["button", "auto", "inline-form"], undefined>;
+                readonly 'component-params': v.NullishSchema<v.RecordSchema<v.StringSchema<undefined>, v.StringSchema<undefined>, undefined>, undefined>;
+                readonly handler: v.PicklistSchema<["download", "load-data", "refresh-data", "show-message", "show-modal"], undefined>;
+                readonly pagination: v.NullishSchema<v.StrictObjectSchema<{
+                    readonly type: v.NullishSchema<v.PicklistSchema<["offset", "index-value"], undefined>, undefined>;
+                    readonly limit: v.ArraySchema<v.NumberSchema<undefined>, undefined>;
+                    readonly 'limit-default': v.NullishSchema<v.NumberSchema<undefined>, undefined>;
+                    readonly count: v.NullishSchema<v.PicklistSchema<["on", "off", "estimate"], undefined>, undefined>;
+                }, undefined>, undefined>;
+            }, undefined>, undefined>, undefined>;
+            readonly arguments: v.NullishSchema<v.GenericSchema<import("../index.js").Fields>, undefined>;
+            readonly 'argument-order': v.NullishSchema<v.StringSchema<undefined>, undefined>;
+        }, undefined>, undefined>;
+        readonly 'resource-action-order': v.StringSchema<undefined>;
+        readonly 'object-id': v.NullishSchema<v.StringSchema<undefined>, undefined>;
+        readonly display: v.RecordSchema<v.StringSchema<undefined>, v.RecordSchema<v.StringSchema<undefined>, v.StrictObjectSchema<{
+            readonly title: v.StringSchema<undefined>;
+        }, undefined>, undefined>, undefined>;
+    }, undefined>;
+    /**
+     * Resource actions
+     *
+     * Optional, only if resource has actions. The key is the action name,
+     * the value is the path of the corresponding handler.
+     */
+    readonly action_handlers: v.NullishSchema<v.RecordSchema<v.StringSchema<undefined>, v.StringSchema<undefined>, undefined>, undefined>;
+    /**
+     *
+     */
+    readonly allowed_actions_on_object: v.NullishSchema<v.StringSchema<undefined>, undefined>;
+}, undefined>;

package/schemas/resource/resource.js

@@ -0,0 +1,31 @@
+import { nullish, record, strictObject, string } from "valibot";
+import { AccessPolicySchema } from "./enums.js";
+import { ResourceFieldSchema } from "./field.js";
+import { ObjectActionConfigSchema, ObjectActionSchema } from "./object-action.js";
+import { ResourceActionSchema } from "./resource-action.js";
+const ResourceDisplaySchema = strictObject({
+    title: string()
+});
+const ResourceInfoSchema = strictObject({
+    fields: record(string(), ResourceFieldSchema),
+    'field-order': string(),
+    'object-actions': record(string(), ObjectActionSchema),
+    'object-actions-config': ObjectActionConfigSchema,
+    'object-action-component': nullish(string()),
+    'object-action-order': string(),
+    'resource-actions': record(string(), ResourceActionSchema),
+    'resource-action-order': string(),
+    'object-id': nullish(string()),
+    display: record(string(), record(string(), ResourceDisplaySchema))
+});
+const ResourceSchema = strictObject({
+    refname: string(),
+    display_name: string(),
+    entity_codename: string(),
+    access_policy: AccessPolicySchema,
+    permission_role: string(),
+    info: ResourceInfoSchema,
+    action_handlers: nullish(record(string(), string())),
+    allowed_actions_on_object: nullish(string())
+});
+export { ResourceDisplaySchema, ResourceInfoSchema, ResourceSchema };