@sprawlify/vue 0.0.63 → 0.0.64

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.ts CHANGED
@@ -1,7 +1,8 @@
1
1
  import { Machine, MachineSchema, Service, mergeProps } from "@sprawlify/primitives/core";
2
2
  import * as _sprawlify_primitives_types0 from "@sprawlify/primitives/types";
3
3
  import * as Vue from "vue";
4
- import { ComputedRef, Ref } from "vue";
4
+ import { ComponentPublicInstance, ComputedRef, MaybeRef, MaybeRefOrGetter, Ref, UnwrapRef } from "vue";
5
+ import { FilterOptions, FilterReturn, Locale } from "@sprawlify/primitives/i18n-utils";
5
6
 
6
7
  //#region src/core/normalize-props.d.ts
7
8
  type ReservedProps = {
@@ -16,7 +17,101 @@ type PropTypes = Vue.NativeElements & {
16
17
  declare const normalizeProps: _sprawlify_primitives_types0.NormalizeProps<PropTypes>;
17
18
  //#endregion
18
19
  //#region src/core/machine.d.ts
19
- type MaybeRef<T> = T | Ref<T> | ComputedRef<T>;
20
- declare function useMachine<T extends MachineSchema>(machine: Machine<T>, userProps?: MaybeRef<Partial<T["props"]>>): Service<T>;
20
+ type MaybeRef$1<T> = T | Ref<T> | ComputedRef<T>;
21
+ declare function useMachine<T extends MachineSchema>(machine: Machine<T>, userProps?: MaybeRef$1<Partial<T["props"]>>): Service<T>;
21
22
  //#endregion
22
- export { PropTypes, mergeProps, normalizeProps, useMachine };
23
+ //#region src/providers/environment/use-environment-context.d.ts
24
+ type RootNode = ShadowRoot | Document | Node;
25
+ interface UseEnvironmentContext {
26
+ /**
27
+ * The root node of the application.
28
+ * This is used to determine the window and document objects.
29
+ */
30
+ getRootNode(): RootNode;
31
+ /**
32
+ * The document context for the root node.
33
+ */
34
+ getDocument(): Document;
35
+ /**
36
+ * The window context for the root node.
37
+ */
38
+ getWindow(): Window & typeof globalThis;
39
+ }
40
+ declare const DEFAULT_ENVIRONMENT: ComputedRef<UseEnvironmentContext>;
41
+ //#endregion
42
+ //#region src/providers/environment/environment-provider.vue.d.ts
43
+ interface EnvironmentProviderProps {
44
+ value?: RootNode | (() => RootNode);
45
+ }
46
+ declare var __VLS_1: {};
47
+ type __VLS_Slots = {} & {
48
+ default?: (props: typeof __VLS_1) => any;
49
+ };
50
+ declare const __VLS_base: Vue.DefineComponent<EnvironmentProviderProps, {}, {}, {}, {}, Vue.ComponentOptionsMixin, Vue.ComponentOptionsMixin, {}, string, Vue.PublicProps, Readonly<EnvironmentProviderProps> & Readonly<{}>, {}, {}, {}, {}, string, Vue.ComponentProvideOptions, false, {}, any>;
51
+ declare const __VLS_export$1: __VLS_WithSlots$1<typeof __VLS_base, __VLS_Slots>;
52
+ declare const _default: typeof __VLS_export$1;
53
+ type __VLS_WithSlots$1<T, S> = T & {
54
+ new (): {
55
+ $slots: S;
56
+ };
57
+ };
58
+ //#endregion
59
+ //#region src/providers/locale/locale-provider.vue.d.ts
60
+ interface LocaleProviderProps {
61
+ locale: string;
62
+ }
63
+ declare const _default$1: typeof __VLS_export;
64
+ declare const __VLS_export: __VLS_WithSlots<Vue.DefineComponent<LocaleProviderProps, {}, {}, {}, {}, Vue.ComponentOptionsMixin, Vue.ComponentOptionsMixin, {}, string, Vue.PublicProps, Readonly<LocaleProviderProps> & Readonly<{}>, {}, {}, {}, {}, string, Vue.ComponentProvideOptions, false, {}, any>, {
65
+ default?: (props: {}) => any;
66
+ }>;
67
+ type __VLS_WithSlots<T, S> = T & {
68
+ new (): {
69
+ $slots: S;
70
+ };
71
+ };
72
+ //#endregion
73
+ //#region src/providers/locale/use-collator.d.ts
74
+ interface UseCollatorProps extends Intl.CollatorOptions {
75
+ locale?: string;
76
+ }
77
+ interface UseCollatorReturn extends ComputedRef<Intl.Collator> {}
78
+ declare function useCollator(propsOrFn?: MaybeRef<UseCollatorProps>): UseCollatorReturn;
79
+ //#endregion
80
+ //#region src/providers/locale/use-filter.d.ts
81
+ interface UseFilterProps extends FilterOptions {}
82
+ declare function useFilter(props: UseFilterProps): UseFilterReturn;
83
+ interface UseFilterReturn extends ComputedRef<FilterReturn> {}
84
+ //#endregion
85
+ //#region src/providers/locale/use-locale-context.d.ts
86
+ interface LocaleContext extends Locale {}
87
+ declare const DEFAULT_LOCALE: ComputedRef<LocaleContext>;
88
+ //#endregion
89
+ //#region src/types.d.ts
90
+ type Optional<T, K extends keyof T> = Pick<Partial<T>, K> & Omit<T, K>;
91
+ type Assign<T, U> = Omit<T, keyof U> & U;
92
+ type EmitFn<T> = <K extends keyof T>(event: K, ...args: T[K] extends any[] ? T[K] : never) => void;
93
+ type BooleanKey<T> = { [K in keyof T]: boolean extends NonNullable<T[K]> ? K : never }[keyof T];
94
+ type BooleanDefaults<T> = { [K in BooleanKey<T>]: undefined };
95
+ type MaybePromise<T> = T | Promise<T>;
96
+ //#endregion
97
+ //#region src/utils/create-context.d.ts
98
+ type CreateContextReturn<T> = [(opts: T) => void, (fallback?: T) => T, symbol];
99
+ declare const createContext: <T>(id: string) => CreateContextReturn<T>;
100
+ //#endregion
101
+ //#region src/utils/use-emits-as-props.d.ts
102
+ declare function useEmitAsProps<Name extends string>(emit: (name: Name, ...args: any[]) => void): Record<string, any>;
103
+ //#endregion
104
+ //#region src/utils/use-forward-expose.d.ts
105
+ declare function useForwardExpose(): {
106
+ forwardRef: (ref: Element | ComponentPublicInstance | null) => void;
107
+ currentRef: Vue.Ref<Element | ComponentPublicInstance | null | undefined, Element | ComponentPublicInstance | null | undefined>;
108
+ currentElement: Vue.ComputedRef<HTMLElement>;
109
+ };
110
+ //#endregion
111
+ //#region src/utils/use-forward-props.d.ts
112
+ declare function useForwardProps<T extends MaybeRefOrGetter<Record<string, any>>, U extends UnwrapRef<T>>(props: T): Vue.ComputedRef<U>;
113
+ //#endregion
114
+ //#region src/utils/use-forward-props-emits.d.ts
115
+ declare function useForwardPropsEmits<T extends Parameters<typeof useForwardProps>[0], Name extends string>(props: T, emit?: (name: Name, ...args: any[]) => void): Vue.ComputedRef<any>;
116
+ //#endregion
117
+ export { Assign, BooleanDefaults, DEFAULT_ENVIRONMENT, DEFAULT_LOCALE, EmitFn, _default as EnvironmentProvider, type EnvironmentProviderProps, type LocaleContext, _default$1 as LocaleProvider, type LocaleProviderProps, MaybePromise, Optional, PropTypes, type RootNode, type UseCollatorProps, type UseCollatorReturn, type UseEnvironmentContext, type UseFilterProps, type UseFilterReturn, createContext, mergeProps, normalizeProps, useCollator, useEmitAsProps, useEnvironmentContext, useFilter, useForwardExpose, useForwardProps, useForwardPropsEmits, useLocaleContext, useMachine };
package/dist/index.js CHANGED
@@ -1,7 +1,9 @@
1
1
  import { INIT_STATE, MachineStatus, createScope, mergeProps } from "@sprawlify/primitives/core";
2
2
  import { createNormalizer } from "@sprawlify/primitives/types";
3
3
  import { compact, ensure, isEqual, isFunction, isString, toArray, warn } from "@sprawlify/primitives/utils";
4
- import { computed, nextTick, onBeforeUnmount, onMounted, onUnmounted, shallowRef, toValue, watch } from "vue";
4
+ import { Fragment, camelize, computed, createCommentVNode, createElementBlock, defineComponent, getCurrentInstance, inject, nextTick, onBeforeUnmount, onMounted, onUnmounted, openBlock, provide, ref, renderSlot, shallowRef, toHandlerKey, toRef, toValue, watch } from "vue";
5
+ import { getDocument, getWindow } from "@sprawlify/primitives/dom-query";
6
+ import { createCollator, createFilter, isRTL } from "@sprawlify/primitives/i18n-utils";
5
7
 
6
8
  //#region src/core/normalize-props.ts
7
9
  function toCase(txt) {
@@ -334,4 +336,218 @@ const flush = (fn) => {
334
336
  };
335
337
 
336
338
  //#endregion
337
- export { mergeProps, normalizeProps, useMachine };
339
+ //#region src/utils/run-if-fn.ts
340
+ const isFunction$1 = (value) => typeof value === "function";
341
+ const runIfFn = (valueOrFn, ...args) => isFunction$1(valueOrFn) ? valueOrFn(...args) : valueOrFn;
342
+
343
+ //#endregion
344
+ //#region src/utils/create-context.ts
345
+ const createContext = (id) => {
346
+ const contextId = Symbol(id);
347
+ const provider = (value) => provide(contextId, value);
348
+ const consumer = (fallback) => inject(contextId, fallback);
349
+ return [
350
+ provider,
351
+ consumer,
352
+ contextId
353
+ ];
354
+ };
355
+
356
+ //#endregion
357
+ //#region src/providers/environment/use-environment-context.ts
358
+ const [EnvironmentContextProvider, useEnvironmentContext] = createContext("EnvironmentContext");
359
+ const DEFAULT_ENVIRONMENT = computed(() => ({
360
+ getRootNode: () => document,
361
+ getDocument: () => document,
362
+ getWindow: () => window
363
+ }));
364
+
365
+ //#endregion
366
+ //#region src/providers/environment/environment-provider.vue?vue&type=script&setup=true&lang.ts
367
+ var environment_provider_vue_vue_type_script_setup_true_lang_default = /* @__PURE__ */ defineComponent({
368
+ __name: "environment-provider",
369
+ props: { value: {
370
+ type: Function,
371
+ required: false,
372
+ skipCheck: true
373
+ } },
374
+ setup(__props) {
375
+ const props = __props;
376
+ const spanRef = ref(null);
377
+ const getRootNode = () => runIfFn(props.value) ?? spanRef.value?.getRootNode() ?? document;
378
+ EnvironmentContextProvider(computed(() => ({
379
+ getRootNode,
380
+ getDocument: () => getDocument(getRootNode()),
381
+ getWindow: () => getWindow(getRootNode())
382
+ })));
383
+ return (_ctx, _cache) => {
384
+ return openBlock(), createElementBlock(Fragment, null, [renderSlot(_ctx.$slots, "default"), !props.value ? (openBlock(), createElementBlock("span", {
385
+ key: 0,
386
+ hidden: "",
387
+ ref_key: "spanRef",
388
+ ref: spanRef
389
+ }, null, 512)) : createCommentVNode("v-if", true)], 64);
390
+ };
391
+ }
392
+ });
393
+
394
+ //#endregion
395
+ //#region src/providers/environment/environment-provider.vue
396
+ var environment_provider_default = environment_provider_vue_vue_type_script_setup_true_lang_default;
397
+
398
+ //#endregion
399
+ //#region src/providers/locale/use-locale-context.ts
400
+ const DEFAULT_LOCALE = computed(() => ({
401
+ dir: "ltr",
402
+ locale: "en-US"
403
+ }));
404
+ const [LocaleContextProvider, useLocaleContext] = createContext("LocaleContext");
405
+
406
+ //#endregion
407
+ //#region src/providers/locale/locale-provider.vue?vue&type=script&setup=true&lang.ts
408
+ var locale_provider_vue_vue_type_script_setup_true_lang_default = /* @__PURE__ */ defineComponent({
409
+ __name: "locale-provider",
410
+ props: { locale: {
411
+ type: String,
412
+ required: true
413
+ } },
414
+ setup(__props) {
415
+ const props = __props;
416
+ LocaleContextProvider(computed(() => ({
417
+ locale: props.locale,
418
+ dir: isRTL(props.locale) ? "rtl" : "ltr"
419
+ })));
420
+ return (_ctx, _cache) => {
421
+ return renderSlot(_ctx.$slots, "default");
422
+ };
423
+ }
424
+ });
425
+
426
+ //#endregion
427
+ //#region src/providers/locale/locale-provider.vue
428
+ var locale_provider_default = locale_provider_vue_vue_type_script_setup_true_lang_default;
429
+
430
+ //#endregion
431
+ //#region src/providers/locale/use-collator.ts
432
+ function useCollator(propsOrFn = {}) {
433
+ const env = useLocaleContext();
434
+ return computed(() => {
435
+ const props = toValue(propsOrFn);
436
+ const locale = props.locale ?? env.value.locale;
437
+ const { locale: _, ...options } = props;
438
+ return createCollator(locale, options);
439
+ });
440
+ }
441
+
442
+ //#endregion
443
+ //#region src/providers/locale/use-filter.ts
444
+ function useFilter(props) {
445
+ const env = useLocaleContext(DEFAULT_LOCALE);
446
+ const locale = computed(() => props.locale ?? env.value.locale);
447
+ return computed(() => createFilter({
448
+ ...props,
449
+ locale: locale.value
450
+ }));
451
+ }
452
+
453
+ //#endregion
454
+ //#region src/utils/use-emits-as-props.ts
455
+ function useEmitAsProps(emit) {
456
+ const vm = getCurrentInstance();
457
+ const events = vm?.type.emits;
458
+ const result = {};
459
+ if (!events?.length) console.warn(`No emitted event found. Please check component: ${vm?.type.__name}`);
460
+ for (const event of events) result[toHandlerKey(camelize(event))] = (...arg) => emit(event, ...arg);
461
+ return result;
462
+ }
463
+
464
+ //#endregion
465
+ //#region src/utils/unref-element.ts
466
+ function unrefElement(elRef) {
467
+ const plain = toValue(elRef);
468
+ return plain?.$el ?? plain;
469
+ }
470
+
471
+ //#endregion
472
+ //#region src/utils/use-forward-expose.ts
473
+ const isElement = (el) => Object.prototype.hasOwnProperty.call(el, "nodeName") && typeof el.nodeName === "string";
474
+ function useForwardExpose() {
475
+ const instance = getCurrentInstance();
476
+ const currentRef = ref();
477
+ const currentElement = computed(() => {
478
+ return ["#text", "#comment"].includes(currentRef.value?.$el.nodeName) ? currentRef.value?.$el.nextElementSibling : unrefElement(currentRef);
479
+ });
480
+ const localExpose = Object.assign({}, instance.exposed);
481
+ const ret = {};
482
+ for (const key in instance.props) Object.defineProperty(ret, key, {
483
+ enumerable: true,
484
+ configurable: true,
485
+ get: () => instance.props[key]
486
+ });
487
+ if (Object.keys(localExpose).length > 0) for (const key in localExpose) Object.defineProperty(ret, key, {
488
+ enumerable: true,
489
+ configurable: true,
490
+ get: () => localExpose[key]
491
+ });
492
+ Object.defineProperty(ret, "$el", {
493
+ enumerable: true,
494
+ configurable: true,
495
+ get: () => instance.vnode.el
496
+ });
497
+ instance.exposed = ret;
498
+ function forwardRef(ref) {
499
+ currentRef.value = ref;
500
+ if (isElement(ref) || !ref) return;
501
+ Object.defineProperty(ret, "$el", {
502
+ enumerable: true,
503
+ configurable: true,
504
+ get: () => ref.$el
505
+ });
506
+ instance.exposed = ret;
507
+ }
508
+ return {
509
+ forwardRef,
510
+ currentRef,
511
+ currentElement
512
+ };
513
+ }
514
+
515
+ //#endregion
516
+ //#region src/utils/use-forward-props.ts
517
+ function useForwardProps(props) {
518
+ const vm = getCurrentInstance();
519
+ const defaultProps = Object.keys(vm?.type.props ?? {}).reduce((prev, curr) => {
520
+ const defaultValue = (vm?.type.props[curr]).default;
521
+ if (defaultValue !== void 0) prev[curr] = defaultValue;
522
+ return prev;
523
+ }, {});
524
+ const refProps = toRef(props);
525
+ return computed(() => {
526
+ const preservedProps = {};
527
+ const assignedProps = vm?.vnode.props ?? {};
528
+ Object.keys(assignedProps).forEach((key) => {
529
+ preservedProps[camelize(key)] = assignedProps[key];
530
+ });
531
+ return Object.keys({
532
+ ...defaultProps,
533
+ ...preservedProps
534
+ }).reduce((prev, curr) => {
535
+ if (refProps.value[curr] !== void 0) prev[curr] = refProps.value[curr];
536
+ return prev;
537
+ }, {});
538
+ });
539
+ }
540
+
541
+ //#endregion
542
+ //#region src/utils/use-forward-props-emits.ts
543
+ function useForwardPropsEmits(props, emit) {
544
+ const parsedProps = useForwardProps(props);
545
+ const emitsAsProps = emit ? useEmitAsProps(emit) : {};
546
+ return computed(() => ({
547
+ ...parsedProps.value,
548
+ ...emitsAsProps
549
+ }));
550
+ }
551
+
552
+ //#endregion
553
+ export { DEFAULT_ENVIRONMENT, DEFAULT_LOCALE, environment_provider_default as EnvironmentProvider, locale_provider_default as LocaleProvider, createContext, mergeProps, normalizeProps, useCollator, useEmitAsProps, useEnvironmentContext, useFilter, useForwardExpose, useForwardProps, useForwardPropsEmits, useLocaleContext, useMachine };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@sprawlify/vue",
3
- "version": "0.0.63",
3
+ "version": "0.0.64",
4
4
  "type": "module",
5
5
  "description": "Vue wrapper for primitives.",
6
6
  "author": "sprawlify <npm@sprawlify.com>",
@@ -9,14 +9,8 @@
9
9
  "types": "./dist/index.d.ts",
10
10
  "exports": {
11
11
  ".": {
12
- "import": {
13
- "types": "./dist/index.d.ts",
14
- "default": "./dist/index.js"
15
- },
16
- "require": {
17
- "types": "./dist/index.d.ts",
18
- "default": "./dist/index.cjs"
19
- }
12
+ "types": "./dist/index.d.ts",
13
+ "default": "./dist/index.js"
20
14
  }
21
15
  },
22
16
  "files": [
@@ -26,7 +20,7 @@
26
20
  "access": "public"
27
21
  },
28
22
  "dependencies": {
29
- "@sprawlify/primitives": "0.0.63"
23
+ "@sprawlify/primitives": "0.0.64"
30
24
  },
31
25
  "peerDependencies": {
32
26
  "vue": ">=3.0.0"