@vuetify/one 2.1.1 → 2.2.0

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/README.md CHANGED
@@ -1,69 +1,79 @@
1
- # essentials
1
+ <div align="center">
2
+ <picture>
3
+ <source media="(prefers-color-scheme: dark)" srcset="https://vuetifyjs.b-cdn.net/docs/images/logos/vone-logo-dark.png">
4
+ <img alt="Vuetify One Logo" src="https://vuetifyjs.b-cdn.net/docs/images/logos/vone-logo-light.png" height="150">
5
+ </picture>
6
+ </div>
2
7
 
3
- ## Project setup
8
+ [![npm version](https://img.shields.io/npm/v/@vuetify/one.svg)](https://www.npmjs.com/package/@vuetify/one)
9
+ [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
4
10
 
5
- ```
6
- # yarn
7
- yarn
11
+ ## Overview
8
12
 
9
- # npm
10
- npm install
13
+ A collection of reusable components designed to seamlessly integrate Vuetify One services throughout the Vuetify ecosystem
11
14
 
12
- # pnpm
13
- pnpm install
15
+ ## Project Setup
14
16
 
15
- # bun
16
- bun install
17
- ```
17
+ ```bash
18
+ git clone https://github.com/vuetifyjs/one.git
18
19
 
19
- ### Compiles and hot-reloads for development
20
+ cd one
20
21
 
22
+ pnpm install
21
23
  ```
22
- # yarn
23
- yarn dev
24
24
 
25
- # npm
26
- npm run dev
25
+ ## Development
27
26
 
28
- # pnpm
27
+ ```bash
29
28
  pnpm dev
29
+ ```
30
+
31
+ ## Building for Production
30
32
 
31
- # bun
32
- bun run dev
33
+ ```bash
34
+ pnpm build
33
35
  ```
34
36
 
35
- ### Compiles and minifies for production
37
+ ## Linting
36
38
 
39
+
40
+ ```bash
41
+ pnpm lint
37
42
  ```
38
- # yarn
39
- yarn build
40
43
 
41
- # npm
42
- npm run build
44
+ ## Usage
43
45
 
44
- # pnpm
45
- pnpm build
46
+ ```js
47
+ import { VoAppBar, VoAuthBtn, VoSocialFooter } from '@vuetify/one'
46
48
 
47
- # bun
48
- bun run build
49
+ export default {
50
+ components: {
51
+ VoAppBar,
52
+ VoAuthBtn,
53
+ VoSocialFooter
54
+ }
55
+ }
49
56
  ```
57
+ ## Store Integration
50
58
 
51
- ### Lints and fixes files
59
+ ```js
60
+ import { useAuthStore, useOneStore, useProductsStore } from '@vuetify/one'
52
61
 
62
+ const authStore = useAuthStore()
63
+ const oneStore = useOneStore()
53
64
  ```
54
- # yarn
55
- yarn lint
56
65
 
57
- # npm
58
- npm run lint
66
+ ## License
59
67
 
60
- # pnpm
61
- pnpm lint
68
+ [MIT](http://opensource.org/licenses/MIT)
62
69
 
63
- # bun
64
- bun run lint
65
- ```
70
+ Copyright (c) 2016-present Vuetify LLC
71
+
72
+ ----
66
73
 
67
- ### Customize configuration
74
+ This project exists and thrives thanks to all the wonderful people who contribute 😍
68
75
 
69
- See [Configuration Reference](https://vitejs.dev/config/).
76
+ <br><br>
77
+ <a href="https://github.com/vuetifyjs/one/graphs/contributors">
78
+ <img src="https://contrib.rocks/image?repo=vuetifyjs/one" />
79
+ </a>
package/dist/index.d.ts CHANGED
@@ -20,6 +20,124 @@ type Team = {
20
20
  picture: string;
21
21
  };
22
22
  };
23
+ declare const useTeamStore: pinia.StoreDefinition<"team", Pick<{
24
+ team: globalThis.Ref<{
25
+ id: string;
26
+ name: string;
27
+ inviteCode: string;
28
+ members: {
29
+ id: string;
30
+ name: string;
31
+ picture: string;
32
+ }[];
33
+ owner: {
34
+ id: string;
35
+ name: string;
36
+ picture: string;
37
+ };
38
+ } | null, Team | {
39
+ id: string;
40
+ name: string;
41
+ inviteCode: string;
42
+ members: {
43
+ id: string;
44
+ name: string;
45
+ picture: string;
46
+ }[];
47
+ owner: {
48
+ id: string;
49
+ name: string;
50
+ picture: string;
51
+ };
52
+ } | null>;
53
+ teamInviteDialog: globalThis.Ref<boolean, boolean>;
54
+ teamInviteCode: globalThis.ComputedRef<string>;
55
+ hasTeamAccess: globalThis.ComputedRef<boolean>;
56
+ isTeamOwner: globalThis.ComputedRef<boolean>;
57
+ isLoading: vue.ShallowRef<boolean, boolean>;
58
+ removeFromTeam: (id: string) => Promise<void>;
59
+ leaveTeam: () => Promise<void>;
60
+ joinTeam: () => Promise<void>;
61
+ clearTeamQuery: () => void;
62
+ }, "team" | "isLoading" | "teamInviteDialog">, Pick<{
63
+ team: globalThis.Ref<{
64
+ id: string;
65
+ name: string;
66
+ inviteCode: string;
67
+ members: {
68
+ id: string;
69
+ name: string;
70
+ picture: string;
71
+ }[];
72
+ owner: {
73
+ id: string;
74
+ name: string;
75
+ picture: string;
76
+ };
77
+ } | null, Team | {
78
+ id: string;
79
+ name: string;
80
+ inviteCode: string;
81
+ members: {
82
+ id: string;
83
+ name: string;
84
+ picture: string;
85
+ }[];
86
+ owner: {
87
+ id: string;
88
+ name: string;
89
+ picture: string;
90
+ };
91
+ } | null>;
92
+ teamInviteDialog: globalThis.Ref<boolean, boolean>;
93
+ teamInviteCode: globalThis.ComputedRef<string>;
94
+ hasTeamAccess: globalThis.ComputedRef<boolean>;
95
+ isTeamOwner: globalThis.ComputedRef<boolean>;
96
+ isLoading: vue.ShallowRef<boolean, boolean>;
97
+ removeFromTeam: (id: string) => Promise<void>;
98
+ leaveTeam: () => Promise<void>;
99
+ joinTeam: () => Promise<void>;
100
+ clearTeamQuery: () => void;
101
+ }, "teamInviteCode" | "hasTeamAccess" | "isTeamOwner">, Pick<{
102
+ team: globalThis.Ref<{
103
+ id: string;
104
+ name: string;
105
+ inviteCode: string;
106
+ members: {
107
+ id: string;
108
+ name: string;
109
+ picture: string;
110
+ }[];
111
+ owner: {
112
+ id: string;
113
+ name: string;
114
+ picture: string;
115
+ };
116
+ } | null, Team | {
117
+ id: string;
118
+ name: string;
119
+ inviteCode: string;
120
+ members: {
121
+ id: string;
122
+ name: string;
123
+ picture: string;
124
+ }[];
125
+ owner: {
126
+ id: string;
127
+ name: string;
128
+ picture: string;
129
+ };
130
+ } | null>;
131
+ teamInviteDialog: globalThis.Ref<boolean, boolean>;
132
+ teamInviteCode: globalThis.ComputedRef<string>;
133
+ hasTeamAccess: globalThis.ComputedRef<boolean>;
134
+ isTeamOwner: globalThis.ComputedRef<boolean>;
135
+ isLoading: vue.ShallowRef<boolean, boolean>;
136
+ removeFromTeam: (id: string) => Promise<void>;
137
+ leaveTeam: () => Promise<void>;
138
+ joinTeam: () => Promise<void>;
139
+ clearTeamQuery: () => void;
140
+ }, "removeFromTeam" | "leaveTeam" | "joinTeam" | "clearTeamQuery">>;
23
141
 
24
142
  interface Sponsorship {
25
143
  id: string;
@@ -582,6 +700,142 @@ declare const useBinsStore: pinia.StoreDefinition<"bins", Pick<{
582
700
  }>;
583
701
  }, "find" | "get" | "delete" | "update" | "create" | "updateOrCreate">>;
584
702
 
703
+ interface SendowlDownloadItem {
704
+ name: string;
705
+ url: string;
706
+ type: 'product';
707
+ accessible: boolean;
708
+ downloadable: boolean;
709
+ }
710
+ interface SendowlDownload {
711
+ id: number;
712
+ download_items: SendowlDownloadItem[];
713
+ order_name: string;
714
+ created_at: string;
715
+ download_url: string;
716
+ }
717
+ declare const useDownloadsStore: pinia.StoreDefinition<"downloads", Pick<{
718
+ all: globalThis.Ref<{
719
+ id: number;
720
+ download_items: {
721
+ name: string;
722
+ url: string;
723
+ type: "product";
724
+ accessible: boolean;
725
+ downloadable: boolean;
726
+ }[];
727
+ order_name: string;
728
+ created_at: string;
729
+ download_url: string;
730
+ }[], SendowlDownload[] | {
731
+ id: number;
732
+ download_items: {
733
+ name: string;
734
+ url: string;
735
+ type: "product";
736
+ accessible: boolean;
737
+ downloadable: boolean;
738
+ }[];
739
+ order_name: string;
740
+ created_at: string;
741
+ download_url: string;
742
+ }[]>;
743
+ isLoading: vue.ShallowRef<boolean, boolean>;
744
+ index: () => Promise<{
745
+ id: number;
746
+ download_items: {
747
+ name: string;
748
+ url: string;
749
+ type: "product";
750
+ accessible: boolean;
751
+ downloadable: boolean;
752
+ }[];
753
+ order_name: string;
754
+ created_at: string;
755
+ download_url: string;
756
+ }[]>;
757
+ }, "isLoading" | "all">, Pick<{
758
+ all: globalThis.Ref<{
759
+ id: number;
760
+ download_items: {
761
+ name: string;
762
+ url: string;
763
+ type: "product";
764
+ accessible: boolean;
765
+ downloadable: boolean;
766
+ }[];
767
+ order_name: string;
768
+ created_at: string;
769
+ download_url: string;
770
+ }[], SendowlDownload[] | {
771
+ id: number;
772
+ download_items: {
773
+ name: string;
774
+ url: string;
775
+ type: "product";
776
+ accessible: boolean;
777
+ downloadable: boolean;
778
+ }[];
779
+ order_name: string;
780
+ created_at: string;
781
+ download_url: string;
782
+ }[]>;
783
+ isLoading: vue.ShallowRef<boolean, boolean>;
784
+ index: () => Promise<{
785
+ id: number;
786
+ download_items: {
787
+ name: string;
788
+ url: string;
789
+ type: "product";
790
+ accessible: boolean;
791
+ downloadable: boolean;
792
+ }[];
793
+ order_name: string;
794
+ created_at: string;
795
+ download_url: string;
796
+ }[]>;
797
+ }, never>, Pick<{
798
+ all: globalThis.Ref<{
799
+ id: number;
800
+ download_items: {
801
+ name: string;
802
+ url: string;
803
+ type: "product";
804
+ accessible: boolean;
805
+ downloadable: boolean;
806
+ }[];
807
+ order_name: string;
808
+ created_at: string;
809
+ download_url: string;
810
+ }[], SendowlDownload[] | {
811
+ id: number;
812
+ download_items: {
813
+ name: string;
814
+ url: string;
815
+ type: "product";
816
+ accessible: boolean;
817
+ downloadable: boolean;
818
+ }[];
819
+ order_name: string;
820
+ created_at: string;
821
+ download_url: string;
822
+ }[]>;
823
+ isLoading: vue.ShallowRef<boolean, boolean>;
824
+ index: () => Promise<{
825
+ id: number;
826
+ download_items: {
827
+ name: string;
828
+ url: string;
829
+ type: "product";
830
+ accessible: boolean;
831
+ downloadable: boolean;
832
+ }[];
833
+ order_name: string;
834
+ created_at: string;
835
+ download_url: string;
836
+ }[]>;
837
+ }, "index">>;
838
+
585
839
  declare const useHttpStore: pinia.StoreDefinition<"http", {
586
840
  url: string;
587
841
  }, {}, {
@@ -592,6 +846,40 @@ declare const useHttpStore: pinia.StoreDefinition<"http", {
592
846
  delete(url: string, options?: RequestInit): Promise<Response>;
593
847
  }>;
594
848
 
849
+ interface Notification {
850
+ id: string;
851
+ slug: string;
852
+ title: string;
853
+ created_at: string;
854
+ metadata: {
855
+ active: boolean;
856
+ text: string;
857
+ emoji: string;
858
+ color: {
859
+ key: string;
860
+ value: string;
861
+ };
862
+ action: string;
863
+ action_text: string;
864
+ attributes: Record<string, any>;
865
+ };
866
+ }
867
+ interface NotificationsState {
868
+ all: Ref<Notification[]>;
869
+ aall: Ref<Notification[]>;
870
+ record: Ref<Notification | undefined>;
871
+ isLoading: ShallowRef<boolean>;
872
+ index: () => Promise<Notification[]>;
873
+ admin: () => Promise<Notification[]>;
874
+ show: (slug: string) => Promise<Notification>;
875
+ store: (data: FormData) => Promise<Notification>;
876
+ update: (id: string, data: FormData) => Promise<Notification>;
877
+ destroy: (id: string) => Promise<void>;
878
+ read: ComputedRef<Notification[]>;
879
+ unread: ComputedRef<Notification[]>;
880
+ }
881
+ declare const useNotificationsStore: pinia.StoreDefinition<"notifications", Pick<NotificationsState, "isLoading" | "all" | "aall" | "record">, Pick<NotificationsState, "read" | "unread">, Pick<NotificationsState, "show" | "admin" | "destroy" | "index" | "store" | "update">>;
882
+
595
883
  interface SubscriptionItemPlan {
596
884
  id: string;
597
885
  amount: number;
@@ -1711,6 +1999,56 @@ declare const useSettingsStore: pinia.StoreDefinition<"settings", Pick<{
1711
1999
  CDN_URL: string;
1712
2000
  }, never>>;
1713
2001
 
2002
+ interface SiteState {
2003
+ id: Ref<string[]>;
2004
+ url: Ref<string>;
2005
+ }
2006
+ declare const useSiteStore: pinia.StoreDefinition<"site", Pick<SiteState, keyof SiteState>, Pick<SiteState, never>, Pick<SiteState, never>>;
2007
+
2008
+ interface Sponsor {
2009
+ id: string;
2010
+ status: 'published' | 'draft';
2011
+ modified_at: string;
2012
+ created_at: string;
2013
+ slug: string;
2014
+ title: string;
2015
+ metadata: {
2016
+ active: boolean;
2017
+ href: string;
2018
+ start_date: string | null;
2019
+ source: string;
2020
+ name: string;
2021
+ level: {
2022
+ key: string;
2023
+ value: string;
2024
+ } | null;
2025
+ tier: string;
2026
+ end_date: string | null;
2027
+ logodark: {
2028
+ url: string;
2029
+ } | null;
2030
+ logolight: {
2031
+ url: string;
2032
+ } | null;
2033
+ };
2034
+ }
2035
+ type SponsorState = {
2036
+ isLoading: Ref<boolean>;
2037
+ all: Ref<Sponsor[]>;
2038
+ aall: Ref<Sponsor[]>;
2039
+ record: Ref<Sponsor | undefined>;
2040
+ sponsors: Ref<Sponsor[]>;
2041
+ byTier: ComputedRef<Record<string, Sponsor[]>>;
2042
+ bySlug: (slug: string) => Sponsor | undefined;
2043
+ admin: () => Promise<Sponsor[]>;
2044
+ index: () => Promise<Sponsor[]>;
2045
+ show: (id: string) => Promise<Sponsor>;
2046
+ store: (data: FormData) => Promise<Sponsor>;
2047
+ update: (id: string, data: FormData) => Promise<Sponsor>;
2048
+ destroy: () => Promise<void>;
2049
+ };
2050
+ declare const useSponsorsStore: pinia.StoreDefinition<"sponsors", Pick<SponsorState, "isLoading" | "all" | "aall" | "record" | "sponsors">, Pick<SponsorState, "byTier">, Pick<SponsorState, "show" | "admin" | "destroy" | "index" | "store" | "update" | "bySlug">>;
2051
+
1714
2052
  interface Spot {
1715
2053
  id: string;
1716
2054
  status: 'published' | 'draft';
@@ -1932,4 +2270,4 @@ declare function createOne(): {
1932
2270
  };
1933
2271
  declare function one(id: string[], url: string): (context: PiniaPluginContext) => void;
1934
2272
 
1935
- export { aliases, createOne, one, useAuthStore, useBannersStore, useBinsStore, useHttpStore, useOneStore, useProductsStore, usePromotionsStore, useQueueStore, useSettingsStore, useSpotsStore, useUserStore };
2273
+ export { aliases, createOne, one, useAuthStore, useBannersStore, useBinsStore, useDownloadsStore, useHttpStore, useNotificationsStore, useOneStore, useProductsStore, usePromotionsStore, useQueueStore, useSettingsStore, useSiteStore, useSponsorsStore, useSpotsStore, useTeamStore, useUserStore };