@chelone/vue 0.0.0-stage → 0.1.0

package/dist/i18n/use-locale.js

@@ -0,0 +1,41 @@
+import { ref, getCurrentScope, onScopeDispose, readonly } from "vue";
+import { useCheloneContext, useCheloneI18n } from "../context.js";
+function useLocale() {
+  const { i18n } = useCheloneContext();
+  const locale = ref(i18n?.getLocale() ?? "en");
+  if (i18n && getCurrentScope()) {
+    onScopeDispose(
+      i18n.subscribe(() => {
+        locale.value = i18n.getLocale();
+      })
+    );
+  }
+  return readonly(locale);
+}
+function useSetLocale() {
+  const i18n = useCheloneI18n();
+  return (locale) => i18n.setLocale(locale);
+}
+function useLocaleState() {
+  return [useLocale(), useSetLocale()];
+}
+function useLocales() {
+  const { i18n } = useCheloneContext();
+  return (i18n?.getLocales() ?? []).map((locale) => ({
+    locale,
+    name: localeName(locale)
+  }));
+}
+function localeName(locale) {
+  try {
+    return new Intl.DisplayNames([locale], { type: "language" }).of(locale) ?? locale;
+  } catch {
+    return locale;
+  }
+}
+export {
+  useLocale,
+  useLocaleState,
+  useLocales,
+  useSetLocale
+};

package/dist/i18n/use-translatable.d.ts

@@ -0,0 +1,34 @@
+/**
+ * `useTranslatable` and the translatable context — the Vue bridge for core's
+ * `createTranslatableController`. The selected locale is a readonly ref fed by
+ * the controller's `subscribe`, so anything that reads it re-evaluates on
+ * `selectLocale`. A translatable form calls `provideTranslatable` and each
+ * translatable input or field below it reads `useTranslatableContext`.
+ */
+import { type MaybeRefOrGetter, type Ref } from "vue";
+export interface UseTranslatableOptions {
+    /**
+     * Rebuilds the controller when its entries change, not when the array does.
+     * Changing to an empty list is rejected as at setup, but a watcher cannot
+     * throw to the caller: Vue reports the error and the previous locales stay.
+     */
+    locales: MaybeRefOrGetter<readonly string[]>;
+    /**
+     * Ignored when it is not one of `locales`. Without it the start locale is the
+     * app locale when listed, else the first locale.
+     */
+    defaultLocale?: MaybeRefOrGetter<string | undefined>;
+}
+export interface TranslatableContext {
+    /** The current locales; a getter, so it follows a change of `locales`. */
+    readonly locales: readonly string[];
+    readonly selectedLocale: Readonly<Ref<string>>;
+    /** Throws when `locale` is not one of `locales`. */
+    selectLocale(locale: string): void;
+    /** `record` with each translation map replaced by its selected-locale value. */
+    getRecordForLocale<T extends object | null | undefined>(record: T): T extends object ? Record<string, unknown> : T;
+}
+export declare function useTranslatable(options: UseTranslatableOptions): TranslatableContext;
+export declare function provideTranslatable(context: TranslatableContext): void;
+/** The context a translatable form provided. Throws outside one. */
+export declare function useTranslatableContext(): TranslatableContext;

package/dist/i18n/use-translatable.js

@@ -0,0 +1,69 @@
+import { getRecordForLocale, createTranslatableController } from "@chelone/core";
+import { shallowRef, watch, toValue, onScopeDispose, computed, provide, inject } from "vue";
+import { useLocale } from "./use-locale.js";
+const TranslatableKey = /* @__PURE__ */ Symbol(
+  "chelone-translatable"
+);
+function useTranslatable(options) {
+  const appLocale = useLocale();
+  function build(preferred) {
+    const locales = toValue(options.locales);
+    const defaultLocale = toValue(options.defaultLocale);
+    const start = [preferred, defaultLocale, appLocale.value].find(
+      (locale) => locale !== void 0 && locales.includes(locale)
+    );
+    return createTranslatableController({ locales, defaultLocale: start });
+  }
+  let controller = build(void 0);
+  let release = () => {
+  };
+  const state = shallowRef(controller.getSnapshot());
+  function attach(next) {
+    release();
+    controller = next;
+    state.value = next.getSnapshot();
+    release = next.subscribe(() => {
+      state.value = next.getSnapshot();
+    });
+  }
+  attach(controller);
+  watch(
+    () => JSON.stringify(toValue(options.locales)),
+    () => {
+      const previous = controller;
+      attach(build(previous.getSnapshot().selectedLocale));
+      previous.destroy();
+    },
+    { flush: "sync" }
+  );
+  onScopeDispose(() => {
+    release();
+    controller.destroy();
+  });
+  const selectedLocale = computed(() => state.value.selectedLocale);
+  return {
+    get locales() {
+      return state.value.locales;
+    },
+    selectedLocale,
+    selectLocale: (locale) => controller.selectLocale(locale),
+    getRecordForLocale: (record) => getRecordForLocale(record, state.value.selectedLocale, state.value.locales)
+  };
+}
+function provideTranslatable(context) {
+  provide(TranslatableKey, context);
+}
+function useTranslatableContext() {
+  const context = inject(TranslatableKey, void 0);
+  if (!context) {
+    throw new Error(
+      "useTranslatableContext must be used under a component that calls provideTranslatable"
+    );
+  }
+  return context;
+}
+export {
+  provideTranslatable,
+  useTranslatable,
+  useTranslatableContext
+};

package/dist/i18n/use-translate.d.ts

@@ -0,0 +1,18 @@
+/**
+ * `useTranslate` — the Vue twin of `@chelone/react`'s `useTranslate`
+ * (`i18n-hooks.ts`). Returns a bound `translate(key, params?)` closure over the
+ * ambient i18n instance. When no i18n was passed to `<Admin>`, it degrades to an
+ * echo (`key => key`) so components (a label, a `<ValidationError>`) still
+ * render readable text in tests / i18n-less setups instead of throwing.
+ *
+ * The fallback is a core i18n over an empty catalog: it echoes the key on a
+ * miss, and honours the polyglot `{ _: message }` default (placeholders filled
+ * in) exactly as a real instance does, so ra-core style labels still read well.
+ *
+ * The returned `translate` reads the reactive locale from `useLocale`, so
+ * anything calling it re-evaluates on `i18n.setLocale`.
+ */
+/** The translate signature the components consume. */
+export type Translate = (key: string, params?: Record<string, unknown>) => string;
+/** A bound `translate` over the ambient i18n, or an echo when none is present. */
+export declare function useTranslate(): Translate;

package/dist/i18n/use-translate.js

@@ -0,0 +1,19 @@
+import { createI18n } from "@chelone/core";
+import { useCheloneContext } from "../context.js";
+import { useLocale } from "./use-locale.js";
+const echoI18n = createI18n({
+  locale: "en",
+  messages: { en: {} }
+});
+function useTranslate() {
+  const { i18n } = useCheloneContext();
+  const active = i18n ?? echoI18n;
+  const locale = useLocale();
+  return (key, params) => {
+    void locale.value;
+    return active.translate(key, params);
+  };
+}
+export {
+  useTranslate
+};

package/dist/index.d.ts

@@ -0,0 +1,85 @@
+export type { AdminProps } from "./admin/admin.vue.js";
+export { default as Admin } from "./admin/admin.vue.js";
+export type { AuthGateState, HandleAuthCallbackResult, UseAuthenticatedOptions, } from "./admin/auth-gate.js";
+export { useAuthenticated, useAuthGate, useHandleAuthCallback, } from "./admin/auth-gate.js";
+export type { CustomRoute } from "./admin/custom-routes.js";
+export type { ErrorFallbackProps } from "./admin/default-error-fallback.vue.js";
+export { default as DefaultErrorFallback } from "./admin/default-error-fallback.vue.js";
+export { HasDashboardKey, provideHasDashboard, useHasDashboard, } from "./admin/has-dashboard.js";
+export { default as NavigateToFirstResource } from "./admin/navigate-to-first-resource.vue.js";
+export type { ResourceProps } from "./admin/resource.vue.js";
+export { default as Resource } from "./admin/resource.vue.js";
+export type { ResourceDefinition, ResourceDefinitionView, ResourceRegistry, UseResourceDefinitionOptions, } from "./admin/resource-registry.js";
+export { createResourceRegistry, ResourceRegistryKey, useResourceDefinition, useResourceDefinitions, useResourceRegistry, } from "./admin/resource-registry.js";
+export { default as ShellErrorBoundary } from "./admin/shell-error-boundary.vue.js";
+export type { ArrayFieldState, ArrayInputContextValue, IteratorItem, UseArrayInputOptions, UseArrayInputResult, } from "./array/index.js";
+export { ArrayInputContextKey, IteratorRowContextKey, provideArrayInput, provideIteratorRow, useArrayInput, useIteratorItem, } from "./array/index.js";
+export type { UseOptionalIdentityResult } from "./auth/auth-hooks.js";
+export { useAuthState, useCanAccess, useGetIdentity, useLogin, useLogout, useOptionalIdentity, } from "./auth/auth-hooks.js";
+export type { LogoutIfAccessDenied, UsePermissionsOptions, UsePermissionsResult, } from "./auth/permissions-hooks.js";
+export { useLogoutIfAccessDenied, usePermissions, useWatchDataErrors, } from "./auth/permissions-hooks.js";
+export type { ChoiceRecord, ChoicesContextValue, InlineChoicesConfig, OptionText, UseChoicesContextOptions, UseChoicesOptions, UseChoicesResult, UseReferenceInputOptions, UseReferenceInputResult, } from "./choices/index.js";
+export { ChoicesContextKey, getChoicePath, provideChoicesContext, synthesizeInlineChoices, useChoices, useChoicesContext, useReferenceInput, } from "./choices/index.js";
+export * from "./components/index.js";
+export type { CommandMenuAction, CommandMenuContextValue, } from "./components/admin/layout/command-menu-context.js";
+export { useCommandMenu, useRegisterCommand, } from "./components/admin/layout/command-menu-context.js";
+export type { MenuAccessResult } from "./components/admin/layout/use-menu-access.js";
+export { useMenuAccess } from "./components/admin/layout/use-menu-access.js";
+export type { CheloneContextValue } from "./context.js";
+export { CheloneContextKey, provideCheloneContext, useCheloneAuthProvider, useCheloneContext, useCheloneI18n, useCheloneNotifications, useCheloneStore, useDataProvider, } from "./context.js";
+export type { UseCreateControllerOptions, UseCreateControllerReturn, UseDeleteControllerOptions, UseDeleteControllerReturn, UseEditControllerOptions, UseEditControllerReturn, UseInfiniteListControllerOptions, UseInfiniteListControllerReturn, UseListControllerOptions, UseListControllerReturn, UsePrevNextControllerOptions, UsePrevNextControllerReturn, UseReferenceManyFieldControllerOptions, UseReferenceManyFieldControllerReturn, UseReferenceOneFieldControllerOptions, UseReferenceOneFieldControllerReturn, UseShowControllerOptions, UseShowControllerReturn, } from "./controllers/index.js";
+export { toControllerContext, useCreateController, useDeleteController, useEditController, useInfiniteListController, useListController, usePrevNextController, useReferenceManyFieldController, useReferenceOneFieldController, useShowController, } from "./controllers/index.js";
+export { createCheloneHooks } from "./data/create-chelone-hooks.js";
+export { useInfiniteGetList } from "./data/infinite-queries.js";
+export { useCreate, useDelete, useDeleteMany, useUpdate, useUpdateMany, } from "./data/mutations.js";
+export { useGetList, useGetMany, useGetManyAggregate, useGetManyReference, useGetOne, } from "./data/queries.js";
+export type { RunUndoableOptions } from "./data/undoable.js";
+export { useUndoable } from "./data/undoable.js";
+export type { UseCheckForApplicationUpdateOptions } from "./data/use-check-for-application-update.js";
+export { useCheckForApplicationUpdate } from "./data/use-check-for-application-update.js";
+export { useIsOffline } from "./data/use-is-offline.js";
+export { useLoading, useRefresh } from "./data/use-refresh.js";
+export type { CheloneFormContextValue, FormGroupProviderProps, FormGroupsProviderProps, FormSubmit, OptionalSaveFormProps, TabbedFormProps, TabbedFormTabProps, UseFormOptions, UseFormReturn, UseInputOptions, UseInputReturn, UseTabbedFormResult, UseWizardFormResult, WarnWhenUnsavedChangesDecision, WizardFormProps, WizardFormStepProps, } from "./form/index.js";
+export { CheloneFormContextKey, decodePath, FormGroupProvider, FormGroupsProvider, firstFieldError, provideCheloneForm, provideFormGroup, provideFormGroups, provideSourceScope, SourceScopeKey, splatBase, TabbedForm, TabbedFormTab, useCheloneFormContext, useForm, useFormGroup, useFormGroupName, useFormGroups, useInput, useOptionalCheloneFormContext, useOptionalFormGroups, useRegisterFieldGroup, useSourceScope, useTabbedFormContext, useWarnWhenUnsavedChanges, useWizardForm, useWizardFormContext, useWrappedSource, WizardForm, WizardFormStep, } from "./form/index.js";
+export type { Subscribable } from "./form/subscribe-ref.js";
+export { subscribeStore, useSubscribable } from "./form/subscribe-ref.js";
+export { useLocale, useLocaleState, useLocales, useSetLocale, } from "./i18n/use-locale.js";
+export type { TranslatableContext, UseTranslatableOptions, } from "./i18n/use-translatable.js";
+export { provideTranslatable, useTranslatable, useTranslatableContext, } from "./i18n/use-translatable.js";
+export type { Translate } from "./i18n/use-translate.js";
+export { useTranslate } from "./i18n/use-translate.js";
+export { humanize, humanizeField, pluralize } from "./label/inflection.js";
+export type { GetRecordRepresentation } from "./label/use-get-record-representation.js";
+export { useGetRecordRepresentation } from "./label/use-get-record-representation.js";
+export type { GetResourceLabel } from "./label/use-get-resource-label.js";
+export { useGetResourceLabel } from "./label/use-get-resource-label.js";
+export type { TranslateLabel, TranslateLabelOptions, } from "./label/use-translate-label.js";
+export { useTranslateLabel } from "./label/use-translate-label.js";
+export { shallowEqual } from "./lib/shallow-equal.js";
+export { cn } from "./lib/utils.js";
+export { useInfiniteListContext } from "./list/infinite-list-context.js";
+export type { ListContextValue } from "./list/list-context.js";
+export { ListContextKey, provideListContext, useListContext, } from "./list/list-context.js";
+export type { UseDataTableColumnsOptions, UseDataTableColumnsResult, } from "./list/use-data-table-columns.js";
+export { useDataTableColumns } from "./list/use-data-table-columns.js";
+export type { UseListOptions } from "./list/use-list.js";
+export { useList } from "./list/use-list.js";
+export { useNotifications, useNotify } from "./notification-hooks.js";
+export { useGetListLive, useGetManyLive, useGetOneLive } from "./realtime/live.js";
+export type { UseLockOnMountOptions } from "./realtime/locks.js";
+export { useGetLock, useGetLockLive, useGetLocks, useGetLocksLive, useLock, useLockOnMount, useUnlock, } from "./realtime/locks.js";
+export type { UsePresenceOptions } from "./realtime/presence.js";
+export { usePresence } from "./realtime/presence.js";
+export type { UseSubscribeOptions } from "./realtime/subscribe.js";
+export { useOnReconnect, usePublish, useRealtimeStatus, useSubscribe, useSubscribeCallback, useSubscribeToRecord, useSubscribeToRecordList, } from "./realtime/subscribe.js";
+export type { RecordValue, UseRecordContextOptions, } from "./record/record-context.js";
+export { provideRecordContext, RecordContextKey, useRecordContext, } from "./record/record-context.js";
+export type { UseFieldValueOptions } from "./record/use-field-value.js";
+export { useFieldValue } from "./record/use-field-value.js";
+export type { UseResourceContextOptions } from "./resource-context.js";
+export { provideResourceContext, ResourceContextKey, useRequiredResource, useResourceContext, } from "./resource-context.js";
+export type { AdapterNavigate, AdapterNavigateOpts, LinkToType, Redirect, RedirectTo, RouterAdapter, RouterBlocker, ShouldBlock, UseGetPathForRecordOptions, UseMatchArgs, } from "./router/index.js";
+export { BasenameKey, provideVueRouterAdapter, RouterAdapterKey, useBasename, useBlocker, useCanBlock, useCreatePath, useGetPathForRecord, useLocation, useMatch, useNavigate, useParams, useRedirect, useRedirectOptional, useRouterAdapter, useRouterAdapterOptional, vueRouterAdapter, } from "./router/index.js";
+export { useMicroStore, useMicroStoreSelector } from "./store/use-micro-store.js";
+export { type UseSavedQueriesReturn, useSavedQueries, } from "./store/use-saved-queries.js";
+export { useStore, useStoreItem } from "./store/use-store-item.js";