@aleph-alpha/settings-kit 0.1.0 → 1.0.0

package/dist/index.js

@@ -1,7 +1,52 @@
 import { createToggleUnit, defineSettingUnit } from "./generators/index.js";
-import { _ } from "./SettingToggleUnit.vue_vue_type_script_setup_true_lang-BM7-6aXj.js";
+import { _, a, b, S, c, d, e, f, g, h, i, j, k, l, m, n, o, p, q, r, s, t, u, v, w, x, y, z, A, B, C, D, E, F, G, H, I, J, K, L } from "./SkLayoutPage-DGbCpQFm.js";
+import { _ as _2 } from "./SkLayout.vue_vue_type_script_setup_true_lang-ZjV2AMdR.js";
+import { U, U as U2 } from "./UseFileConvertor-DN6cCXNi.js";
+import "vue";
 export {
-  _ as SettingToggleUnit,
+  _ as SkField,
+  a as SkGroup,
+  b as SkItem,
+  _2 as SkLayout,
+  S as SkLayoutPage,
+  c as SkPage,
+  d as SkSection,
+  U as UseFileConvertor,
+  e as byOrder,
+  f as checkFieldConstraints,
+  g as createFieldInput,
+  h as createStateManager,
   createToggleUnit,
-  defineSettingUnit
+  i as defaultBlocks,
+  defineSettingUnit,
+  j as evaluateCondition,
+  k as evaluateFieldRules,
+  l as evaluateRuleStates,
+  m as keysOf,
+  n as layoutIdSegment,
+  o as layoutPageId,
+  p as provideControls,
+  q as provideSettingsLocale,
+  r as provideSkLayoutContext,
+  s as resolveConstraintMessage,
+  t as resolveControlDefinition,
+  u as resolveFieldControl,
+  v as resolveLayout,
+  w as resolveLocalizedText,
+  x as settingsFormSessionKey,
+  y as skControlRegistryKey,
+  z as skLayoutContextKey,
+  A as toNavigation,
+  B as useControlRegistry,
+  C as useFieldInheritance,
+  D as useFieldValidator,
+  U2 as useFileConvertor,
+  E as useSettingField,
+  F as useSettingsForm,
+  G as useSettingsFormSession,
+  H as useSettingsLayout,
+  I as useSettingsLocale,
+  J as useStateManager,
+  K as validateFieldRules,
+  L as validateLayout
 };

package/dist/service/index.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=index.d.ts.map

package/dist/service/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/service/index.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,CAAC"}

package/dist/shell/SkShell.vue.d.ts

@@ -0,0 +1,80 @@
+import type { ResolvedCategory, ResolvedPage, SettingsLayout } from '../core/layout';
+import type { SettingField, StandardSchemaV1, StateManager } from '../core/types';
+import type { SkLayoutActionEvent, SkLayoutBlocks } from '../components/SkLayout/context';
+import type { SkShellLabels } from './labels';
+type __VLS_Props = {
+    /** Category > page > section > group > item delivered with the fields. */
+    layout: SettingsLayout;
+    /** State manager to read and stage in; see `useSettingsLayout`. */
+    session?: StateManager;
+    /** Field descriptors; registered into the session, or its `fields`. */
+    fields?: SettingField[];
+    /**
+     * URL prefix of the settings pages: a page is published as
+     * `${base}/<category>/<page>`. With a host router, the shell only
+     * navigates within the route that rendered it.
+     */
+    base?: string;
+    /** Destination of the back control; without it, `back` is emitted. */
+    backHref?: string;
+    /** Text the chrome renders; merged over the kit wording in the current locale. */
+    labels?: Partial<SkShellLabels>;
+    /** External validators per setting key. */
+    validators?: Record<string, StandardSchemaV1>;
+    /** Replacement components per layout level. */
+    blocks?: Partial<SkLayoutBlocks>;
+    /** Heading level of page titles; sections and groups follow. */
+    headingLevel?: number;
+};
+type __VLS_Slots = {
+    /** Product mark at the start of the top bar. */
+    logo?: () => unknown;
+    /** Account menu at the end of the top bar. */
+    profile?: () => unknown;
+    /** Content sidebar, for pages with `presentation.sidebar`. */
+    sidebar?: (props: {
+        page: ResolvedPage;
+        category: ResolvedCategory;
+    }) => unknown;
+    /** Shown when the layout has no pages. */
+    empty?: () => unknown;
+};
+type __VLS_ModelProps = {
+    /** Id (`<category>/<page>`) of the page on screen. */
+    'page'?: string;
+};
+type __VLS_PublicProps = __VLS_Props & __VLS_ModelProps;
+declare const __VLS_base: import("vue").DefineComponent<__VLS_PublicProps, {
+    /** The layout model: session, resolved tree, navigation, validator. */
+    model: import("..").SettingsLayoutModel;
+    /** Opens a page by id, updating the URL where the shell may. */
+    openPage: (id: string | undefined) => void;
+}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+    action: (event: SkLayoutActionEvent) => any;
+    error: (error: unknown) => any;
+    "update:page": (value: string | undefined) => any;
+    back: () => any;
+}, string, import("vue").PublicProps, Readonly<__VLS_PublicProps> & Readonly<{
+    onAction?: ((event: SkLayoutActionEvent) => any) | undefined;
+    onError?: ((error: unknown) => any) | undefined;
+    "onUpdate:page"?: ((value: string | undefined) => any) | undefined;
+    onBack?: (() => any) | undefined;
+}>, {
+    base: string;
+    fields: SettingField[];
+    validators: Record<string, StandardSchemaV1>;
+    session: StateManager;
+    blocks: Partial<SkLayoutBlocks>;
+    headingLevel: number;
+    backHref: string;
+    labels: Partial<SkShellLabels>;
+}, {}, {}, {}, 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;
+    };
+};
+//# sourceMappingURL=SkShell.vue.d.ts.map

package/dist/shell/SkShell.vue.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"SkShell.vue.d.ts","sourceRoot":"","sources":["../../src/shell/SkShell.vue"],"names":[],"mappings":"AAoMA,OAAO,KAAK,EACV,gBAAgB,EAChB,YAAY,EACZ,cAAc,EACf,MAAM,gBAAgB,CAAC;AACxB,OAAO,KAAK,EACV,YAAY,EACZ,gBAAgB,EAChB,YAAY,EACb,MAAM,eAAe,CAAC;AAGvB,OAAO,KAAK,EACV,mBAAmB,EACnB,cAAc,EACf,MAAM,gCAAgC,CAAC;AAGxC,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAgB9C,KAAK,WAAW,GAAG;IACf,0EAA0E;IAC1E,MAAM,EAAE,cAAc,CAAC;IACvB,mEAAmE;IACnE,OAAO,CAAC,EAAE,YAAY,CAAC;IACvB,uEAAuE;IACvE,MAAM,CAAC,EAAE,YAAY,EAAE,CAAC;IACxB;;;;OAIG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,sEAAsE;IACtE,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,kFAAkF;IAClF,MAAM,CAAC,EAAE,OAAO,CAAC,aAAa,CAAC,CAAC;IAChC,2CAA2C;IAC3C,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAC;IAC9C,+CAA+C;IAC/C,MAAM,CAAC,EAAE,OAAO,CAAC,cAAc,CAAC,CAAC;IACjC,gEAAgE;IAChE,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB,CAAC;AA+BJ,KAAK,WAAW,GAAG;IACjB,gDAAgD;IAChD,IAAI,CAAC,EAAE,MAAM,OAAO,CAAC;IACrB,8CAA8C;IAC9C,OAAO,CAAC,EAAE,MAAM,OAAO,CAAC;IACxB,8DAA8D;IAC9D,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE;QAChB,IAAI,EAAE,YAAY,CAAC;QACnB,QAAQ,EAAE,gBAAgB,CAAC;KAC5B,KAAK,OAAO,CAAC;IACd,0CAA0C;IAC1C,KAAK,CAAC,EAAE,MAAM,OAAO,CAAC;CACvB,CAAC;AAmEF,KAAK,gBAAgB,GAAG;IACxB,sDAAsD;IACtD,MAAM,CAAC,EAAE,MAAM,CAAC;CACf,CAAC;AAeF,KAAK,iBAAiB,GAAG,WAAW,GAAG,gBAAgB,CAAC;AA4GxD,QAAA,MAAM,UAAU;IAtId,uEAAuE;;IAEvE,gEAAgE;;;;;;;;;;;;;UAnHvD,MAAM;YANJ,YAAY,EAAE;gBAYV,MAAM,CAAC,MAAM,EAAE,gBAAgB,CAAC;aAdnC,YAAY;YAgBb,OAAO,CAAC,cAAc,CAAC;kBAEjB,MAAM;cARV,MAAM;YAER,OAAO,CAAC,aAAa,CAAC;6EAwPjC,CAAC;AACH,QAAA,MAAM,YAAY,EAAS,eAAe,CAAC,OAAO,UAAU,EAAE,WAAW,CAAC,CAAC;wBACtD,OAAO,YAAY;AAAxC,wBAAyC;AAWzC,KAAK,eAAe,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,GAAG;IAChC,QAAO;QACN,MAAM,EAAE,CAAC,CAAC;KACV,CAAA;CACD,CAAC"}

package/dist/shell/SkShellFrame.vue.d.ts

@@ -0,0 +1,46 @@
+import type { LayoutNavigationNode, LayoutSidebarMode } from '../core/layout';
+import type { SkShellLabels } from './labels';
+type __VLS_Props = {
+    /** Categories > pages, as built by `toNavigation`. */
+    navigation: LayoutNavigationNode[];
+    /** Id of the page on screen. */
+    activeId?: string;
+    /** `href` of a page link. */
+    hrefOf: (id: string) => string;
+    /** Column split while the content sidebar is shown. */
+    sidebarMode?: LayoutSidebarMode;
+    /** Destination of the back control; else a button emitting `back`. */
+    backHref?: string;
+    /** Text the chrome renders. */
+    labels: SkShellLabels;
+};
+type __VLS_Slots = {
+    /** Product mark at the start of the top bar. */
+    logo?: () => unknown;
+    /** Account menu at the end of the top bar. */
+    profile?: () => unknown;
+    /** The page. */
+    default?: () => unknown;
+    /** Content sidebar beside the page. */
+    sidebar?: () => unknown;
+};
+declare const __VLS_base: import("vue").DefineComponent<__VLS_Props, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+    navigate: (id: string) => any;
+    back: () => any;
+}, string, import("vue").PublicProps, Readonly<__VLS_Props> & Readonly<{
+    onNavigate?: ((id: string) => any) | undefined;
+    onBack?: (() => any) | undefined;
+}>, {
+    sidebarMode: LayoutSidebarMode;
+    activeId: string;
+    backHref: string;
+}, {}, {}, {}, 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;
+    };
+};
+//# sourceMappingURL=SkShellFrame.vue.d.ts.map

package/dist/shell/SkShellFrame.vue.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"SkShellFrame.vue.d.ts","sourceRoot":"","sources":["../../src/shell/SkShellFrame.vue"],"names":[],"mappings":"AAsWA,OAAO,KAAK,EAAE,oBAAoB,EAAE,iBAAiB,EAAE,MAAM,gBAAgB,CAAC;AAC9E,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAa9C,KAAK,WAAW,GAAG;IACf,sDAAsD;IACtD,UAAU,EAAE,oBAAoB,EAAE,CAAC;IACnC,gCAAgC;IAChC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,6BAA6B;IAC7B,MAAM,EAAE,CAAC,EAAE,EAAE,MAAM,KAAK,MAAM,CAAC;IAC/B,uDAAuD;IACvD,WAAW,CAAC,EAAE,iBAAiB,CAAC;IAChC,sEAAsE;IACtE,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,+BAA+B;IAC/B,MAAM,EAAE,aAAa,CAAC;CACvB,CAAC;AAcJ,KAAK,WAAW,GAAG;IACjB,gDAAgD;IAChD,IAAI,CAAC,EAAE,MAAM,OAAO,CAAC;IACrB,8CAA8C;IAC9C,OAAO,CAAC,EAAE,MAAM,OAAO,CAAC;IACxB,gBAAgB;IAChB,OAAO,CAAC,EAAE,MAAM,OAAO,CAAC;IACxB,uCAAuC;IACvC,OAAO,CAAC,EAAE,MAAM,OAAO,CAAC;CACzB,CAAC;AAyqBF,QAAA,MAAM,UAAU;;;;;;;iBArsBE,iBAAiB;cAJpB,MAAM;cAMN,MAAM;6EAusBnB,CAAC;AACH,QAAA,MAAM,YAAY,EAAS,eAAe,CAAC,OAAO,UAAU,EAAE,WAAW,CAAC,CAAC;wBACtD,OAAO,YAAY;AAAxC,wBAAyC;AAWzC,KAAK,eAAe,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,GAAG;IAChC,QAAO;QACN,MAAM,EAAE,CAAC,CAAC;KACV,CAAA;CACD,CAAC"}

package/dist/shell/SkShellNav.vue.d.ts

@@ -0,0 +1,19 @@
+import type { LayoutNavigationNode } from '../core/layout';
+type __VLS_Props = {
+    /** Page nodes of one category. */
+    nodes: LayoutNavigationNode[];
+    /** Id of the page on screen. */
+    activeId?: string;
+    /** `href` of a page link. */
+    hrefOf: (id: string) => string;
+    /** Appended to the name of a page with errors. */
+    pageHasErrors: string;
+};
+declare const __VLS_export: import("vue").DefineComponent<__VLS_Props, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+    navigate: (id: string) => any;
+}, string, import("vue").PublicProps, Readonly<__VLS_Props> & Readonly<{
+    onNavigate?: ((id: string) => any) | undefined;
+}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
+declare const _default: typeof __VLS_export;
+export default _default;
+//# sourceMappingURL=SkShellNav.vue.d.ts.map

package/dist/shell/SkShellNav.vue.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"SkShellNav.vue.d.ts","sourceRoot":"","sources":["../../src/shell/SkShellNav.vue"],"names":[],"mappings":"AA4EA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,gBAAgB,CAAC;AAU3D,KAAK,WAAW,GAAG;IACjB,kCAAkC;IAClC,KAAK,EAAE,oBAAoB,EAAE,CAAC;IAC9B,gCAAgC;IAChC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,6BAA6B;IAC7B,MAAM,EAAE,CAAC,EAAE,EAAE,MAAM,KAAK,MAAM,CAAC;IAC/B,kDAAkD;IAClD,aAAa,EAAE,MAAM,CAAC;CACvB,CAAC;AAqIF,QAAA,MAAM,YAAY;;;;kFAGhB,CAAC;wBACkB,OAAO,YAAY;AAAxC,wBAAyC"}

package/dist/shell/history.d.ts

@@ -0,0 +1,9 @@
+import type { InjectionKey } from 'vue';
+import type { RouterHistory } from 'vue-router';
+/**
+ * Provide a history for the shells below. When set, a shell syncs the active
+ * page through it and leaves any host router untouched. Stories and tests
+ * pass `createMemoryHistory()` so the page keeps its own URL.
+ */
+export declare const skShellHistoryKey: InjectionKey<RouterHistory>;
+//# sourceMappingURL=history.d.ts.map

package/dist/shell/history.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"history.d.ts","sourceRoot":"","sources":["../../src/shell/history.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,KAAK,CAAC;AACxC,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AAEhD;;;;GAIG;AACH,eAAO,MAAM,iBAAiB,EAAE,YAAY,CAAC,aAAa,CAC9B,CAAC"}

package/dist/shell/index.d.ts

@@ -0,0 +1,12 @@
+export { default as SkShell } from './SkShell.vue';
+export { default as SkShellFrame } from './SkShellFrame.vue';
+export { default as SkShellNav } from './SkShellNav.vue';
+export { skShellHistoryKey } from './history';
+export { defaultShellLabels } from './labels';
+export type { SkShellLabels } from './labels';
+export { normalizeShellBase, pagePath, shellPath, splitLocation, } from './location';
+export { createShellRoutes, findShellRoute, normalizeRoutePath, } from './routes';
+export type { ShellRoute } from './routes';
+export { useShellLocation } from './useShellLocation';
+export type { ShellLocation, UseShellLocationOptions, } from './useShellLocation';
+//# sourceMappingURL=index.d.ts.map

package/dist/shell/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/shell/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,OAAO,IAAI,OAAO,EAAE,MAAM,eAAe,CAAC;AACnD,OAAO,EAAE,OAAO,IAAI,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAC7D,OAAO,EAAE,OAAO,IAAI,UAAU,EAAE,MAAM,kBAAkB,CAAC;AACzD,OAAO,EAAE,iBAAiB,EAAE,MAAM,WAAW,CAAC;AAC9C,OAAO,EAAE,kBAAkB,EAAE,MAAM,UAAU,CAAC;AAC9C,YAAY,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAC9C,OAAO,EACL,kBAAkB,EAClB,QAAQ,EACR,SAAS,EACT,aAAa,GACd,MAAM,YAAY,CAAC;AACpB,OAAO,EACL,iBAAiB,EACjB,cAAc,EACd,kBAAkB,GACnB,MAAM,UAAU,CAAC;AAClB,YAAY,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AAC3C,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AACtD,YAAY,EACV,aAAa,EACb,uBAAuB,GACxB,MAAM,oBAAoB,CAAC"}