@uides/stepwise 1.1.0-d0adc9fb → 2.0.0-07ee8440

package/src/schemas/fieldset/display-components.ts

@@ -1,70 +1,63 @@
 import * as v from 'valibot';
 import {
-  ComponentLayout,
-  DisplayLang,
-  nullish,
-  object,
+  ComponentLayoutSchema,
+  DisplayLangSchema,
 } from '@uides/stepwise/schemas/common';
 import {
-  OtherComponentParams,
-  TableComponentParams,
+  OtherComponentParamsSchema,
+  TableComponentParamsSchema,
 } from '@uides/stepwise/schemas/fieldset/component-params';
 import {
-  PdfOtherComponent,
-  PdfTableBasedComponent,
-  WebComponent,
+  PdfOtherComponentSchema,
+  PdfTableBasedComponentSchema,
+  WebComponentSchema,
 } from '@uides/stepwise/schemas/fieldset/enums';
 
-export const FieldsetWebDisplay = object({
+export const FieldsetWebDisplaySchema = v.strictObject({
   /** The explanatory title of the fieldset */
-  title: nullish(v.string()),
-  component: WebComponent,
-  'component-params': nullish(TableComponentParams),
-  layout: nullish(ComponentLayout),
+  title: v.nullish(v.string()),
+  component: WebComponentSchema,
+  'component-params': v.nullish(TableComponentParamsSchema),
+  layout: v.nullish(ComponentLayoutSchema),
 });
-export type FieldsetWebDisplay = v.Output<typeof FieldsetWebDisplay>;
+export type FieldsetWebDisplay = v.InferOutput<typeof FieldsetWebDisplaySchema>;
 
-export const FieldsetPdfDisplayTable = object({
+export const FieldsetPdfDisplayTableSchema = v.strictObject({
   /** The explanatory title of the fieldset */
-  title: nullish(v.string()),
-  component: PdfTableBasedComponent,
-  'component-params': nullish(TableComponentParams),
+  title: v.nullish(v.string()),
+  component: PdfTableBasedComponentSchema,
+  'component-params': v.nullish(TableComponentParamsSchema),
 });
-export type FieldsetPdfDisplayTable = v.Output<typeof FieldsetPdfDisplayTable>;
+export type FieldsetPdfDisplayTable = v.InferOutput<
+  typeof FieldsetPdfDisplayTableSchema
+>;
 
-export const FieldsetPdfDisplayOther = object({
+export const FieldsetPdfDisplayOtherSchema = v.strictObject({
   /** The explanatory title of the fieldset */
-  title: nullish(v.string()),
-  component: PdfOtherComponent,
-  'component-params': nullish(OtherComponentParams),
+  title: v.nullish(v.string()),
+  component: PdfOtherComponentSchema,
+  'component-params': v.nullish(OtherComponentParamsSchema),
 });
-export type FieldsetPdfDisplayOther = v.Output<typeof FieldsetPdfDisplayOther>;
+export type FieldsetPdfDisplayOther = v.InferOutput<
+  typeof FieldsetPdfDisplayOtherSchema
+>;
 
-export const FieldsetPdfDisplay = v.variant('component', [
-  FieldsetPdfDisplayTable,
-  FieldsetPdfDisplayOther,
+export const FieldsetPdfDisplaySchema = v.variant('component', [
+  FieldsetPdfDisplayTableSchema,
+  FieldsetPdfDisplayOtherSchema,
 ]);
-export type FieldsetPdfDisplay = v.Output<typeof FieldsetPdfDisplay>;
+export type FieldsetPdfDisplay = v.InferOutput<typeof FieldsetPdfDisplaySchema>;
 
-export const FieldsetDisplay = v.union([
-  v.object(
-    {
-      default: v.record(DisplayLang, FieldsetWebDisplay),
-    },
-    v.unknown()
-  ),
-  v.object(
-    {
-      web: v.record(DisplayLang, FieldsetWebDisplay),
-    },
-    v.unknown()
-  ),
-  v.object(
-    {
-      pdf: v.record(DisplayLang, FieldsetPdfDisplay),
-    },
-    v.unknown()
-  ),
+export const FieldsetDisplaySchema = v.union([
+  v.looseObject({
+    default: v.record(DisplayLangSchema, FieldsetWebDisplaySchema),
+  }),
+  v.looseObject({
+    web: v.record(DisplayLangSchema, FieldsetWebDisplaySchema),
+  }),
+  v.looseObject({
+    pdf: v.record(DisplayLangSchema, FieldsetPdfDisplaySchema),
+  }),
 ]);
 
-export type FieldsetDisplay = v.Output<typeof FieldsetDisplay>;
+export type FieldsetDisplay = v.InferOutput<typeof FieldsetDisplaySchema>;

package/src/schemas/fieldset/enums.ts

@@ -7,8 +7,8 @@ import * as v from 'valibot';
  * @value 'hidden' Hidden.
  * @value 'form' Form.
  */
-export const WebComponent = v.picklist(['values-list', 'hidden', 'form']);
-export type WebComponent = v.Output<typeof WebComponent>;
+export const WebComponentSchema = v.picklist(['values-list', 'hidden', 'form']);
+export type WebComponent = v.InferOutput<typeof WebComponentSchema>;
 
 /**
  * Pdf table-based component type.
@@ -21,7 +21,7 @@ export type WebComponent = v.Output<typeof WebComponent>;
  * @value 'hidden' Hidden.
  * @value 'custom' Custom.
  */
-export const PdfTableBasedComponent = v.picklist([
+export const PdfTableBasedComponentSchema = v.picklist([
   'values-list',
   'table',
   'one-liner-table',
@@ -30,7 +30,9 @@ export const PdfTableBasedComponent = v.picklist([
   'hidden',
   'custom',
 ]);
-export type PdfTableBasedComponent = v.Output<typeof PdfTableBasedComponent>;
+export type PdfTableBasedComponent = v.InferOutput<
+  typeof PdfTableBasedComponentSchema
+>;
 
 /**
  * Pdf component type.
@@ -39,5 +41,9 @@ export type PdfTableBasedComponent = v.Output<typeof PdfTableBasedComponent>;
  * @value 'common' Common.
  * @value 'plain-text' Plain text. Ideal for displaying fields with values that are large texts. It helps in displaying the text across multiple pages.
  */
-export const PdfOtherComponent = v.picklist(['header', 'common', 'plain-text']);
-export type PdfOtherComponent = v.Output<typeof PdfOtherComponent>;
+export const PdfOtherComponentSchema = v.picklist([
+  'header',
+  'common',
+  'plain-text',
+]);
+export type PdfOtherComponent = v.InferOutput<typeof PdfOtherComponentSchema>;

package/src/schemas/fieldset/index.ts

@@ -3,8 +3,7 @@ export * from '@uides/stepwise/schemas/fieldset/component-params';
 export * from '@uides/stepwise/schemas/fieldset/display-components';
 
 import * as v from 'valibot';
-import { nullish, object } from '@uides/stepwise/schemas/common';
-import { FieldsetDisplay } from '@uides/stepwise/schemas/fieldset/display-components';
+import { FieldsetDisplaySchema } from '@uides/stepwise/schemas/fieldset/display-components';
 
 /**
  * A set of fields
@@ -12,15 +11,15 @@ import { FieldsetDisplay } from '@uides/stepwise/schemas/fieldset/display-compon
  * In order to show fields in the UI, they must be grouped in a fieldset. This may be done,
  * by adding the field names in the `field-order` property of the fieldset.
  */
-export const Fieldset = object({
-  'field-order': nullish(v.string()), // TODO: Not optional in backend schema but optional in some templates
-  display: nullish(FieldsetDisplay),
+export const FieldsetSchema = v.strictObject({
+  'field-order': v.nullish(v.string()), // TODO: Not optional in backend schema but optional in some templates
+  display: v.nullish(FieldsetDisplaySchema),
 });
-export type Fieldset = v.Output<typeof Fieldset>;
+export type Fieldset = v.InferOutput<typeof FieldsetSchema>;
 export default Fieldset;
 
 export type Fieldsets = Record<string, Fieldset>;
-export const FieldsetsSchema = v.record(Fieldset) as v.BaseSchema<
-  Fieldsets,
-  Fieldsets
->;
+export const FieldsetsSchema = v.record(
+  v.string(),
+  FieldsetSchema
+) as v.GenericSchema<Fieldsets, Fieldsets>;

package/src/schemas/layout.ts

@@ -1,9 +1,7 @@
 import * as v from 'valibot';
 import {
-  DisplayLang,
-  DisplayMode,
-  nullish,
-  object,
+  DisplayLangSchema,
+  DisplayModeSchema,
 } from '@uides/stepwise/schemas/common';
 
 /**
@@ -18,7 +16,7 @@ import {
  * @value 'nav-link' Navigation link.
  * @value 'nav-info' Navigation info.
  */
-export const NavActionComponent = v.picklist([
+export const NavActionComponentSchema = v.picklist([
   'back-button',
   'entity-name',
   'button-link',
@@ -28,45 +26,58 @@ export const NavActionComponent = v.picklist([
   'nav-link',
   'nav-info',
 ]);
-export type NavActionComponent = v.Output<typeof NavActionComponent>;
+export type NavActionComponent = v.InferOutput<typeof NavActionComponentSchema>;
 
-export const NavActionDisplay = object({
-  label: nullish(v.string()),
-  component: NavActionComponent,
-  'component-params': nullish(v.record(v.any())),
+export const NavActionDisplaySchema = v.strictObject({
+  label: v.nullish(v.string()),
+  component: NavActionComponentSchema,
+  'component-params': v.nullish(v.record(v.string(), v.any())),
 });
-export type NavActionDisplay = v.Output<typeof NavActionDisplay>;
+export type NavActionDisplay = v.InferOutput<typeof NavActionDisplaySchema>;
 
-export const NavAction = object({
-  display: nullish(
-    v.record(DisplayMode, v.record(DisplayLang, NavActionDisplay))
+export const NavActionSchema = v.strictObject({
+  display: v.nullish(
+    v.record(
+      DisplayModeSchema,
+      v.record(DisplayLangSchema, NavActionDisplaySchema)
+    )
   ),
 });
-export type NavAction = v.Output<typeof NavAction>;
+export type NavAction = v.InferOutput<typeof NavActionSchema>;
 
-export const NavActionGroupParams = object({
-  expanded: nullish(v.boolean()),
-  'match-paths': nullish(v.array(v.string())),
+export const NavActionGroupParamsSchema = v.strictObject({
+  expanded: v.nullish(v.boolean()),
+  'match-paths': v.nullish(v.array(v.string())),
 });
-export type NavActionGroupParams = v.Output<typeof NavActionGroupParams>;
+export type NavActionGroupParams = v.InferOutput<
+  typeof NavActionGroupParamsSchema
+>;
 
-export const NavActionGroupDisplay = object({
-  label: nullish(v.string()),
-  component: NavActionComponent,
-  'component-params': nullish(NavActionGroupParams),
+export const NavActionGroupDisplaySchema = v.strictObject({
+  label: v.nullish(v.string()),
+  component: NavActionComponentSchema,
+  'component-params': v.nullish(NavActionGroupParamsSchema),
 });
-export type NavActionGroupDisplay = v.Output<typeof NavActionGroupDisplay>;
+export type NavActionGroupDisplay = v.InferOutput<
+  typeof NavActionGroupDisplaySchema
+>;
 
-export const NavActionGroup = object({
-  items: v.record(NavAction),
+export const NavActionGroupSchema = v.strictObject({
+  items: v.record(v.string(), NavActionSchema),
   'item-order': v.string(),
-  display: v.record(DisplayMode, v.record(DisplayLang, NavActionGroupDisplay)),
+  display: v.record(
+    DisplayModeSchema,
+    v.record(DisplayLangSchema, NavActionGroupDisplaySchema)
+  ),
 });
-export type NavActionGroup = v.Output<typeof NavActionGroup>;
+export type NavActionGroup = v.InferOutput<typeof NavActionGroupSchema>;
 
-export const Layout = object({
+export const LayoutSchema = v.strictObject({
   'nav-action-order': v.string(),
-  'nav-actions': v.record(v.union([NavAction, NavActionGroup])),
-  'landing-url': nullish(v.string()),
+  'nav-actions': v.record(
+    v.string(),
+    v.union([NavActionSchema, NavActionGroupSchema])
+  ),
+  'landing-url': v.nullish(v.string()),
 });
-export type Layout = v.Output<typeof Layout>;
+export type Layout = v.InferOutput<typeof LayoutSchema>;

package/src/schemas/outputs.ts

@@ -1,21 +1,22 @@
 import * as v from 'valibot';
-import { object, nullish } from '@uides/stepwise/schemas/common';
-import { DocumentData } from '@uides/stepwise/schemas/document';
+import { DocumentDataSchema } from '@uides/stepwise/schemas/document';
 
 /**
  * As defined in outputs/entry_schema.py
  */
-export const Entry = object({
+export const EntrySchema = v.strictObject({
   id: v.string(),
   gate_id: v.string(),
-  document: DocumentData,
-  'document-refs': nullish(v.record(v.record(v.any()))),
+  document: DocumentDataSchema,
+  'document-refs': v.nullish(
+    v.record(v.string(), v.record(v.string(), v.any()))
+  ),
 });
 
 /**
  * As defined in outputs/permission_schema.py
  */
-export const Permission = object({
+export const PermissionSchema = v.strictObject({
   gate_display_name: v.string(),
   gate_id: v.string(),
   afm: v.string(),

package/src/schemas/resource/enums.ts

@@ -11,7 +11,7 @@ import * as v from 'valibot';
  * @value `diff` Diff.
  * @value `link` Link.
  */
-export const ResourceFieldComponent = v.picklist([
+export const ResourceFieldComponentSchema = v.picklist([
   'string',
   'boolean',
   'int',
@@ -28,7 +28,7 @@ export const ResourceFieldComponent = v.picklist([
  * @value `menu-action` Menu action.
  * @value `menu-action-show-details` Menu action showing details.
  */
-export const ObjectActionComponent = v.picklist([
+export const ObjectActionComponentSchema = v.picklist([
   'button',
   'menu-action',
   'menu-action-show-details',
@@ -45,7 +45,7 @@ export const ObjectActionComponent = v.picklist([
  * @value `show-details` Show details.
  * @value `show-message` Show message.
  */
-export const ObjectActionHandler = v.picklist([
+export const ObjectActionHandlerSchema = v.picklist([
   'download',
   'redirect',
   'new-tab',
@@ -62,7 +62,7 @@ export const ObjectActionHandler = v.picklist([
  * @value `auto` Auto.
  * @value `inline-form` Inline form.
  */
-export const ResourceActionComponent = v.picklist([
+export const ResourceActionComponentSchema = v.picklist([
   'button',
   'auto',
   'inline-form',
@@ -77,7 +77,7 @@ export const ResourceActionComponent = v.picklist([
  * @value `show-message` Show message.
  * @value `show-modal` Show modal.
  */
-export const ResourceActionHandler = v.picklist([
+export const ResourceActionHandlerSchema = v.picklist([
   'download',
   'load-data',
   'refresh-data',
@@ -91,4 +91,4 @@ export const ResourceActionHandler = v.picklist([
  * @value `node` Node.
  * @value `tree` Tree.
  */
-export const AccessPolicy = v.picklist(['node', 'tree']);
+export const AccessPolicySchema = v.picklist(['node', 'tree']);

package/src/schemas/resource/field.ts

@@ -1,14 +1,16 @@
 import * as v from 'valibot';
-import { object, nullish } from '@uides/stepwise/schemas/common';
-import { ResourceFieldComponent } from '@uides/stepwise/schemas/resource/enums';
+import { ResourceFieldComponentSchema } from '@uides/stepwise/schemas/resource/enums';
 
-export const ResourceFieldDisplay = object({
+export const ResourceFieldDisplaySchema = v.strictObject({
   title: v.string(),
-  component: ResourceFieldComponent,
-  choices: nullish(v.record(v.any())),
-  'choices-order': nullish(v.string()),
+  component: ResourceFieldComponentSchema,
+  choices: v.nullish(v.record(v.string(), v.any())),
+  'choices-order': v.nullish(v.string()),
 });
 
-export const ResourceField = object({
-  display: v.record(v.record(ResourceFieldDisplay)),
+export const ResourceFieldSchema = v.strictObject({
+  display: v.record(
+    v.string(),
+    v.record(v.string(), ResourceFieldDisplaySchema)
+  ),
 });

package/src/schemas/resource/object-action.ts

@@ -1,31 +1,36 @@
 import * as v from 'valibot';
-import { object, nullish } from '@uides/stepwise/schemas/common';
 import { FieldsSchema } from '@uides/stepwise/schemas/field';
 import {
-  ObjectActionComponent,
-  ObjectActionHandler,
+  ObjectActionComponentSchema,
+  ObjectActionHandlerSchema,
 } from '@uides/stepwise/schemas/resource/enums';
 
-export const ObjectActionDisplay = object({
+export const ObjectActionDisplaySchema = v.strictObject({
   title: v.string(),
-  component: ObjectActionComponent,
-  'component-params': v.record(v.string()),
-  handler: nullish(ObjectActionHandler),
+  component: ObjectActionComponentSchema,
+  'component-params': v.record(v.string(), v.string()),
+  handler: v.nullish(ObjectActionHandlerSchema),
 });
 
-export const ObjectAction = object({
-  display: v.record(v.record(ObjectActionDisplay)),
-  arguments: nullish(FieldsSchema),
+export const ObjectActionSchema = v.strictObject({
+  display: v.record(
+    v.string(),
+    v.record(v.string(), ObjectActionDisplaySchema)
+  ),
+  arguments: v.nullish(FieldsSchema),
   'argument-order': v.string(),
-  confirm: nullish(v.boolean()),
+  confirm: v.nullish(v.boolean()),
 });
 
-export const ObjectActionConfigDisplay = object({
-  title: nullish(v.string()),
+export const ObjectActionConfigDisplaySchema = v.strictObject({
+  title: v.nullish(v.string()),
   component: v.literal('menu'),
-  icon: nullish(v.string()),
+  icon: v.nullish(v.string()),
 });
 
-export const ObjectActionConfig = object({
-  display: v.record(v.record(ObjectActionConfigDisplay)),
+export const ObjectActionConfigSchema = v.strictObject({
+  display: v.record(
+    v.string(),
+    v.record(v.string(), ObjectActionConfigDisplaySchema)
+  ),
 });

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

@@ -1,28 +1,30 @@
 import * as v from 'valibot';
-import { object, nullish } from '@uides/stepwise/schemas/common';
 import { FieldsSchema } from '@uides/stepwise/schemas/field';
 import {
-  ResourceActionComponent,
-  ResourceActionHandler,
+  ResourceActionComponentSchema,
+  ResourceActionHandlerSchema,
 } from '@uides/stepwise/schemas/resource/enums';
 
-export const ResourceActionPagination = object({
-  type: nullish(v.picklist(['offset', 'index-value'])),
+export const ResourceActionPaginationSchema = v.strictObject({
+  type: v.nullish(v.picklist(['offset', 'index-value'])),
   limit: v.array(v.number()),
-  'limit-default': nullish(v.number()),
-  count: nullish(v.picklist(['on', 'off', 'estimate'])),
+  'limit-default': v.nullish(v.number()),
+  count: v.nullish(v.picklist(['on', 'off', 'estimate'])),
 });
 
-export const ResourceActionDisplay = object({
-  title: nullish(v.string()),
-  component: ResourceActionComponent,
-  'component-params': nullish(v.record(v.string())),
-  handler: ResourceActionHandler,
-  pagination: nullish(ResourceActionPagination),
+export const ResourceActionDisplaySchema = v.strictObject({
+  title: v.nullish(v.string()),
+  component: ResourceActionComponentSchema,
+  'component-params': v.nullish(v.record(v.string(), v.string())),
+  handler: ResourceActionHandlerSchema,
+  pagination: v.nullish(ResourceActionPaginationSchema),
 });
 
-export const ResourceAction = object({
-  display: v.record(v.record(ResourceActionDisplay)),
-  arguments: nullish(FieldsSchema),
-  'argument-order': nullish(v.string()),
+export const ResourceActionSchema = v.strictObject({
+  display: v.record(
+    v.string(),
+    v.record(v.string(), ResourceActionDisplaySchema)
+  ),
+  arguments: v.nullish(FieldsSchema),
+  'argument-order': v.nullish(v.string()),
 });

package/src/schemas/resource/resource.ts

@@ -1,53 +1,52 @@
 import * as v from 'valibot';
-import { object, nullish } from '@uides/stepwise/schemas/common';
-import { AccessPolicy } from '@uides/stepwise/schemas/resource/enums';
-import { ResourceField } from '@uides/stepwise/schemas/resource/field';
+import { AccessPolicySchema } from '@uides/stepwise/schemas/resource/enums';
+import { ResourceFieldSchema } from '@uides/stepwise/schemas/resource/field';
 import {
-  ObjectAction,
-  ObjectActionConfig,
+  ObjectActionSchema,
+  ObjectActionConfigSchema,
 } from '@uides/stepwise/schemas/resource/object-action';
-import { ResourceAction } from '@uides/stepwise/schemas/resource/resource-action';
+import { ResourceActionSchema } from '@uides/stepwise/schemas/resource/resource-action';
 
-export const ResourceDisplay = object({
+export const ResourceDisplaySchema = v.strictObject({
   title: v.string(),
 });
 
-export const ResourceInfo = object({
-  fields: v.record(ResourceField),
+export const ResourceInfoSchema = v.strictObject({
+  fields: v.record(v.string(), ResourceFieldSchema),
   'field-order': v.string(),
-  'object-actions': v.record(ObjectAction),
-  'object-actions-config': ObjectActionConfig,
-  'object-action-component': nullish(v.string()),
+  'object-actions': v.record(v.string(), ObjectActionSchema),
+  'object-actions-config': ObjectActionConfigSchema,
+  'object-action-component': v.nullish(v.string()),
   'object-action-order': v.string(),
-  'resource-actions': v.record(ResourceAction),
+  'resource-actions': v.record(v.string(), ResourceActionSchema),
   'resource-action-order': v.string(),
-  'object-id': nullish(v.string()),
-  display: v.record(v.record(ResourceDisplay)),
+  'object-id': v.nullish(v.string()),
+  display: v.record(v.string(), v.record(v.string(), ResourceDisplaySchema)),
 });
 
-export const Resource = object({
+export const ResourceSchema = v.strictObject({
   /** Unique identifier of the resource */
   refname: v.string(),
   /** String, display name of resource */
   display_name: v.string(),
   entity_codename: v.string(),
-  access_policy: AccessPolicy,
+  access_policy: AccessPolicySchema,
   permission_role: v.string(),
   /**
    * Namespace spec of resource
    *
    * @see {@link Template.steps_spec} for a similar concept
    */
-  info: ResourceInfo,
+  info: ResourceInfoSchema,
   /**
    * Resource actions
    *
    * Optional, only if resource has actions. The key is the action name,
    * the value is the path of the corresponding handler.
    */
-  action_handlers: nullish(v.record(v.string())),
+  action_handlers: v.nullish(v.record(v.string(), v.string())),
   /**
    *
    */
-  allowed_actions_on_object: nullish(v.string()),
+  allowed_actions_on_object: v.nullish(v.string()),
 });