@shwfed/config 1.0.0

package/dist/runtime/components/form/schema.d.ts

@@ -0,0 +1,164 @@
+import { Schema } from 'effect';
+import type { Environment } from '../../vendor/cel-js/lib/index.js';
+import { type LayoutSetValue } from '../../share/layout.js';
+export { commonFieldFields } from './utils/common.js';
+export { getStructFieldTitle, getStructFieldDescription } from './utils/schema-meta.js';
+export { Align, LayoutSet, validatePlacements } from '../../share/layout.js';
+declare const KIND = "shwfed.component.form";
+type AnySchema = Schema.Schema<any, any, never>;
+/**
+ * The shared body of a form — fields + layouts only, with placement
+ * cross-validation. Used by `FormConfig` (top-level form) and re-used by
+ * nested field types that want to embed a mini-form (e.g. the list field's
+ * repeating unit).
+ *
+ * `configure` is used as-is; callers that want form-wide bindings like `now`
+ * are responsible for registering them before calling.
+ */
+export declare function FormUnit(configure: (env: Environment) => void): Schema.refine<{
+    readonly fields: readonly any[];
+    readonly layouts: readonly {
+        readonly name: string;
+        readonly layout: {
+            readonly style?: string | undefined;
+            readonly columns: number;
+            readonly gap?: number | undefined;
+            readonly rows?: number | undefined;
+            readonly placements: {
+                readonly [x: string]: {
+                    readonly area: readonly [readonly [number, number], readonly [number, number]];
+                    readonly v?: "stretch" | "center" | "end" | "start" | undefined;
+                    readonly h?: "stretch" | "center" | "end" | "start" | undefined;
+                };
+            };
+        };
+        readonly media?: string | undefined;
+    }[];
+}, Schema.Struct<{
+    fields: Schema.Array$<AnySchema>;
+    layouts: Schema.refine<readonly {
+        readonly name: string;
+        readonly layout: {
+            readonly style?: string | undefined;
+            readonly columns: number;
+            readonly gap?: number | undefined;
+            readonly rows?: number | undefined;
+            readonly placements: {
+                readonly [x: string]: {
+                    readonly area: readonly [readonly [number, number], readonly [number, number]];
+                    readonly v?: "stretch" | "center" | "end" | "start" | undefined;
+                    readonly h?: "stretch" | "center" | "end" | "start" | undefined;
+                };
+            };
+        };
+        readonly media?: string | undefined;
+    }[], Schema.Array$<Schema.Struct<{
+        name: Schema.SchemaClass<string, string, never>;
+        media: Schema.optional<Schema.Schema<string, string, never>>;
+        layout: Schema.Struct<{
+            columns: Schema.refine<number, Schema.filter<typeof Schema.Number>>;
+            rows: Schema.optional<Schema.refine<number, Schema.filter<typeof Schema.Number>>>;
+            gap: Schema.optional<Schema.refine<number, Schema.filter<typeof Schema.Number>>>;
+            style: Schema.optional<Schema.SchemaClass<string, string, never>>;
+            placements: Schema.Record$<typeof Schema.String, Schema.Struct<{
+                area: Schema.refine<readonly [readonly [number, number], readonly [number, number]], Schema.Tuple2<Schema.Tuple2<Schema.filter<Schema.filter<typeof Schema.Number>>, Schema.filter<Schema.filter<typeof Schema.Number>>>, Schema.Tuple2<Schema.filter<Schema.filter<typeof Schema.Number>>, Schema.filter<Schema.filter<typeof Schema.Number>>>>>;
+                h: Schema.optional<Schema.Literal<["start", "center", "end", "stretch"]>>;
+                v: Schema.optional<Schema.Literal<["start", "center", "end", "stretch"]>>;
+            }>>;
+        }>;
+    }>>>;
+}>>;
+export declare function FormConfig(configure: (env: Environment) => void): Schema.refine<{
+    readonly initial?: string | undefined;
+    readonly kind: "shwfed.component.form";
+    readonly fields: readonly any[];
+    readonly layouts: readonly {
+        readonly name: string;
+        readonly layout: {
+            readonly style?: string | undefined;
+            readonly columns: number;
+            readonly gap?: number | undefined;
+            readonly rows?: number | undefined;
+            readonly placements: {
+                readonly [x: string]: {
+                    readonly area: readonly [readonly [number, number], readonly [number, number]];
+                    readonly v?: "stretch" | "center" | "end" | "start" | undefined;
+                    readonly h?: "stretch" | "center" | "end" | "start" | undefined;
+                };
+            };
+        };
+        readonly media?: string | undefined;
+    }[];
+}, Schema.Struct<{
+    fields: Schema.Array$<AnySchema>;
+    layouts: Schema.refine<readonly {
+        readonly name: string;
+        readonly layout: {
+            readonly style?: string | undefined;
+            readonly columns: number;
+            readonly gap?: number | undefined;
+            readonly rows?: number | undefined;
+            readonly placements: {
+                readonly [x: string]: {
+                    readonly area: readonly [readonly [number, number], readonly [number, number]];
+                    readonly v?: "stretch" | "center" | "end" | "start" | undefined;
+                    readonly h?: "stretch" | "center" | "end" | "start" | undefined;
+                };
+            };
+        };
+        readonly media?: string | undefined;
+    }[], Schema.Array$<Schema.Struct<{
+        name: Schema.SchemaClass<string, string, never>;
+        media: Schema.optional<Schema.Schema<string, string, never>>;
+        layout: Schema.Struct<{
+            columns: Schema.refine<number, Schema.filter<typeof Schema.Number>>;
+            rows: Schema.optional<Schema.refine<number, Schema.filter<typeof Schema.Number>>>;
+            gap: Schema.optional<Schema.refine<number, Schema.filter<typeof Schema.Number>>>;
+            style: Schema.optional<Schema.SchemaClass<string, string, never>>;
+            placements: Schema.Record$<typeof Schema.String, Schema.Struct<{
+                area: Schema.refine<readonly [readonly [number, number], readonly [number, number]], Schema.Tuple2<Schema.Tuple2<Schema.filter<Schema.filter<typeof Schema.Number>>, Schema.filter<Schema.filter<typeof Schema.Number>>>, Schema.Tuple2<Schema.filter<Schema.filter<typeof Schema.Number>>, Schema.filter<Schema.filter<typeof Schema.Number>>>>>;
+                h: Schema.optional<Schema.Literal<["start", "center", "end", "stretch"]>>;
+                v: Schema.optional<Schema.Literal<["start", "center", "end", "stretch"]>>;
+            }>>;
+        }>;
+    }>>>;
+    kind: Schema.tag<"shwfed.component.form">;
+    initial: Schema.optional<Schema.Schema<string, string, never>>;
+}>>;
+export declare function createFormConfig(body: Omit<Schema.Schema.Type<ReturnType<typeof FormConfig>>, 'kind'>): {
+    initial?: string | undefined;
+    fields: readonly any[];
+    layouts: readonly {
+        readonly name: string;
+        readonly layout: {
+            readonly style?: string | undefined;
+            readonly columns: number;
+            readonly gap?: number | undefined;
+            readonly rows?: number | undefined;
+            readonly placements: {
+                readonly [x: string]: {
+                    readonly area: readonly [readonly [number, number], readonly [number, number]];
+                    readonly v?: "stretch" | "center" | "end" | "start" | undefined;
+                    readonly h?: "stretch" | "center" | "end" | "start" | undefined;
+                };
+            };
+        };
+        readonly media?: string | undefined;
+    }[];
+    kind: typeof KIND;
+};
+export declare function defaultFormConfig(): FormConfigValue;
+export type FieldValue = Readonly<{
+    id: string;
+    type: string;
+    compatibilityDate: string;
+}> & Readonly<Record<string, unknown>>;
+export type { AlignValue, PlacementValue, LayoutValue, LayoutSetValue } from '../../share/layout.js';
+export type FormUnitValue = Readonly<{
+    fields: ReadonlyArray<FieldValue>;
+    layouts: ReadonlyArray<LayoutSetValue>;
+}>;
+export type FormConfigValue = Readonly<{
+    kind: typeof KIND;
+    initial?: string;
+}> & FormUnitValue;

package/dist/runtime/components/form/schema.js

@@ -0,0 +1,77 @@
+import { Schema } from "effect";
+import { Expression } from "../../share/expression.js";
+import { allFieldSchemas } from "./utils/resolve.js";
+import { md } from "../../share/markdown.js";
+import {
+  LayoutSet,
+  validatePlacements
+} from "../../share/layout.js";
+export { commonFieldFields } from "./utils/common.js";
+export { getStructFieldTitle, getStructFieldDescription } from "./utils/schema-meta.js";
+export { Align, LayoutSet, validatePlacements } from "../../share/layout.js";
+const KIND = "shwfed.component.form";
+function unitFields(configure) {
+  const fieldSchemas = allFieldSchemas(configure);
+  const Field = fieldSchemas.length === 0 ? Schema.Never : fieldSchemas.length === 1 ? fieldSchemas[0] : Schema.Union(...fieldSchemas);
+  const AnnotatedField = Field.annotations({
+    description: "\u8868\u5355\u5B57\u6BB5\uFF0C\u7531 `type` \u5B57\u6BB5\u533A\u5206\u7C7B\u578B"
+  });
+  return {
+    fields: Schema.Array(AnnotatedField).annotations({
+      title: "\u5B57\u6BB5",
+      description: "\u8868\u5355\u5B57\u6BB5\u5217\u8868\uFF1B\u672A\u7ED1\u5B9A\u5230\u4EFB\u4F55\u5E03\u5C40\u7684\u5B57\u6BB5\u4E0D\u4F1A\u88AB\u6E32\u67D3"
+    }),
+    layouts: Schema.Array(LayoutSet(configure)).pipe(Schema.minItems(1)).annotations({
+      title: "\u5E03\u5C40",
+      description: "\u6309\u987A\u5E8F\u6392\u5217\u7684\u5E03\u5C40\u96C6\u5408\uFF1B\u6302\u8F7D\u65F6\u6309\u5E8F\u6C42\u503C\u5404\u9879 `media` CEL \u8868\u8FBE\u5F0F\uFF0C\u4F7F\u7528\u7B2C\u4E00\u4E2A\u4E3A `true` \u7684\u5E03\u5C40\uFF08\u5168\u90E8\u4E0D\u5339\u914D\u65F6\u56DE\u9000\u5230\u6700\u540E\u4E00\u9879\uFF09"
+    })
+  };
+}
+function unitPlacementsFilter(cfg) {
+  const items = cfg.fields.map((f) => ({ id: f.id }));
+  return validatePlacements(items, cfg.layouts, "\u5B57\u6BB5");
+}
+export function FormUnit(configure) {
+  return Schema.Struct(unitFields(configure)).pipe(Schema.filter(unitPlacementsFilter)).annotations({
+    title: "FormUnit",
+    description: "\u4E00\u7EC4\u8868\u5355\u5B57\u6BB5\u53CA\u5176\u5E03\u5C40"
+  });
+}
+export function FormConfig(configure) {
+  const formConfigure = (env) => {
+    env.registerVariable("now", "Date", { description: "\u5F53\u524D\u65E5\u671F/\u65F6\u95F4" });
+    configure(env);
+  };
+  const CelFormInitial = Expression({ configure: formConfigure, resultType: "dyn" });
+  return Schema.Struct({
+    kind: Schema.tag(KIND),
+    initial: Schema.optional(CelFormInitial.annotations({
+      title: "\u521D\u59CB\u503C",
+      description: md`
+        返回整个表单初始值的 CEL 表达式：
+
+        - 可以互相依赖，但是应当避免循环引用出现
+
+          考虑一个表单，包含了用户名 & 用户角色。特别的，一个用户可能有多个角色。我们可以默认填入当前登入人的用户名，随后再以此为依据，填入其默认的角色。
+
+        - 支持异步调用（如 \`http.get(...).json()\`）。运行时会等待表达式 resolve 后再触发依赖 \`form\` 的请求
+
+        - 如果配置了初始值，重置这个表单将**重置为其初始值，而非空**
+      `
+    })),
+    ...unitFields(formConfigure)
+  }).pipe(Schema.filter(unitPlacementsFilter)).annotations({
+    title: "FormConfig",
+    description: "Form \u7EC4\u4EF6\u5B8C\u6574\u914D\u7F6E"
+  });
+}
+export function createFormConfig(body) {
+  return { kind: KIND, ...body };
+}
+export function defaultFormConfig() {
+  return {
+    kind: KIND,
+    fields: [],
+    layouts: [{ name: "\u9ED8\u8BA4", layout: { columns: 1, placements: {} } }]
+  };
+}

package/dist/runtime/components/form/unit-config.d.vue.ts

@@ -0,0 +1,63 @@
+import type { FieldValue, FormUnitValue } from './schema.js';
+export type UnitExtra = {
+    id: string;
+    label: string;
+    icon: string;
+};
+export type UnitSelection = {
+    kind: 'extras';
+    id: string;
+} | {
+    kind: 'layout';
+} | {
+    kind: 'field';
+    id: string;
+};
+type __VLS_Props = {
+    /**
+     * Sidebar rows rendered above the layouts list. Each entry has a matching
+     * `extras-pane` slot keyed by `id`. Selection lives in the `selection`
+     * v-model — hosts read which extra is active via `selection.value`.
+     */
+    extras?: ReadonlyArray<UnitExtra>;
+};
+type __VLS_Slots = {
+    /** Pane content for the currently-selected extra. Receives `{ id }`. */
+    'extras-pane'(props: {
+        id: string;
+    }): unknown;
+};
+type __VLS_ModelProps = {
+    modelValue: FormUnitValue;
+    'selection'?: UnitSelection;
+};
+type __VLS_PublicProps = __VLS_Props & __VLS_ModelProps;
+declare const __VLS_base: import("vue").DefineComponent<__VLS_PublicProps, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+    "update:modelValue": (value: Readonly<{
+        fields: ReadonlyArray<FieldValue>;
+        layouts: readonly Readonly<{
+            name: string;
+            media?: string;
+            layout: import("./schema.js").LayoutValue;
+        }>[];
+    }>) => any;
+    "update:selection": (value: UnitSelection) => any;
+}, string, import("vue").PublicProps, Readonly<__VLS_PublicProps> & Readonly<{
+    "onUpdate:modelValue"?: ((value: Readonly<{
+        fields: ReadonlyArray<FieldValue>;
+        layouts: readonly Readonly<{
+            name: string;
+            media?: string;
+            layout: import("./schema.js").LayoutValue;
+        }>[];
+    }>) => any) | undefined;
+    "onUpdate:selection"?: ((value: UnitSelection) => any) | undefined;
+}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
+declare const __VLS_export: __VLS_WithSlots<typeof __VLS_base, __VLS_Slots>;
+declare const _default: typeof __VLS_export;
+export default _default;
+type __VLS_WithSlots<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};