@stacksjs/types 0.37.3

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.
@@ -0,0 +1,21 @@
1
+ export * from './app';
2
+ export * from './auto-imports';
3
+ export * from './build';
4
+ export * from './components';
5
+ export * from './cli';
6
+ export * from './deploy';
7
+ export * from './docs';
8
+ export * from './exit-code';
9
+ export * from './fs';
10
+ export * from './git';
11
+ export * from './hashing';
12
+ export * from './i18n';
13
+ export * from './inspect';
14
+ export * from './layout';
15
+ export * from './library';
16
+ export * from './manifest';
17
+ export * from './markdown';
18
+ export * from './pages';
19
+ export * from './pwa';
20
+ export * from './ssg';
21
+ export * from './ui';
package/dist/index.mjs ADDED
@@ -0,0 +1,21 @@
1
+ export * from "./app.mjs";
2
+ export * from "./auto-imports.mjs";
3
+ export * from "./build.mjs";
4
+ export * from "./components.mjs";
5
+ export * from "./cli.mjs";
6
+ export * from "./deploy.mjs";
7
+ export * from "./docs.mjs";
8
+ export * from "./exit-code.mjs";
9
+ export * from "./fs.mjs";
10
+ export * from "./git.mjs";
11
+ export * from "./hashing.mjs";
12
+ export * from "./i18n.mjs";
13
+ export * from "./inspect.mjs";
14
+ export * from "./layout.mjs";
15
+ export * from "./library.mjs";
16
+ export * from "./manifest.mjs";
17
+ export * from "./markdown.mjs";
18
+ export * from "./pages.mjs";
19
+ export * from "./pwa.mjs";
20
+ export * from "./ssg.mjs";
21
+ export * from "./ui.mjs";
@@ -0,0 +1,9 @@
1
+ import type { Options } from 'vite-plugin-inspect';
2
+ /**
3
+ * ### Inspect Options
4
+ *
5
+ * The inspect options.
6
+ *
7
+ * @see https://github.com/intlify/bundle-tools/blob/main/packages/vite-plugin-vue-i18n/src/options.ts
8
+ */
9
+ export declare type InspectOptions = Options;
File without changes
@@ -0,0 +1,7 @@
1
+ import type { UserOptions } from 'vite-plugin-vue-layouts';
2
+ /**
3
+ * ### Layout Options
4
+ *
5
+ * The layout options.
6
+ */
7
+ export declare type LayoutOptions = UserOptions;
File without changes
@@ -0,0 +1,128 @@
1
+ import type { TagsOptions } from '.';
2
+ /**
3
+ * ### Library Options
4
+ *
5
+ * This configuration defines all of your library options. Because Stacks is full-typed, you
6
+ * may hover any of the options below and the definitions will be provided. In case you
7
+ * have any questions, feel free to reach out via Discord or GitHub Discussions.
8
+ */
9
+ export interface LibraryOptions {
10
+ /**
11
+ * The base name of your library/libraries.
12
+ */
13
+ name: string;
14
+ /**
15
+ * The name of your organization (parent).
16
+ */
17
+ parentName: string | null;
18
+ /**
19
+ * The path of your repository.
20
+ *
21
+ * @example
22
+ * "your-org/your-repo"
23
+ */
24
+ repository: string;
25
+ /**
26
+ * The list of accepted SPDX licenses.
27
+ * When developing OS packages, you may want to utilize an OSI approved license.
28
+ *
29
+ * @example
30
+ * "MIT"
31
+ * @see https://opensource.org/licenses
32
+ */
33
+ license: LicenseType;
34
+ /**
35
+ * The author's name of the library.
36
+ */
37
+ author: string;
38
+ /**
39
+ * A list of all the contributors.
40
+ */
41
+ contributors: string[];
42
+ /**
43
+ * The default language used within your stack.
44
+ */
45
+ defaultLanguage: LanguageCode;
46
+ /**
47
+ * The Vue component library options.
48
+ */
49
+ vueComponents: LibraryBuildOptions;
50
+ /**
51
+ * The Web Component library options.
52
+ */
53
+ webComponents: LibraryBuildOptions;
54
+ /**
55
+ * The Web Component library options.
56
+ */
57
+ functions: LibraryBuildOptions;
58
+ }
59
+ /**
60
+ * The list of available options to build your library.
61
+ */
62
+ export interface LibraryBuildOptions {
63
+ /**
64
+ * The name of your library as published to npm.
65
+ */
66
+ name: string;
67
+ /**
68
+ * The description of your library as published to npm.
69
+ */
70
+ description: string;
71
+ /**
72
+ * The keywords of your library as published to npm.
73
+ */
74
+ keywords: string[];
75
+ /**
76
+ * Should your library include an IIFE build?
77
+ * (Immediately Invoked Function Expression)
78
+ * @default false
79
+ */
80
+ shouldBuildIife?: boolean;
81
+ /**
82
+ * Should your library generate a sourcemap?
83
+ * @default false
84
+ */
85
+ shouldGenerateSourcemap?: boolean;
86
+ /**
87
+ * This is where you define the functions/composables that need to be included
88
+ * in your library. For example, including your `counter` function to be
89
+ * built would require `../functions/counter.ts` to be present.
90
+ */
91
+ functions?: string[];
92
+ /**
93
+ * This is where you define the components that need to be included in
94
+ * your library. For example, including your `HelloWorld` to be built
95
+ * would require `../components/HelloWorld.vue` to be present.
96
+ *
97
+ * @example
98
+ * {
99
+ * tags: [{
100
+ * name: 'HelloWorld' // export { default as HelloWorld } from './components/HelloWorld.vue'
101
+ * }]
102
+ * }
103
+ *
104
+ * @example
105
+ * {
106
+ * tags: [{
107
+ * name: ['HelloWorld', 'AppHelloWorld'] // export { default as AppHelloWorld } from './components/HelloWorld.vue'
108
+ * }]
109
+ * }
110
+ */
111
+ tags?: TagsOptions;
112
+ }
113
+ /**
114
+ * The name of your "Stack" which generally is your library name
115
+ * or a concatenation of your organization & library name.
116
+ */
117
+ export declare type StackName = string;
118
+ /**
119
+ * The list of accepted SPDX licenses.
120
+ * When developing OS packages, you may want to utilize an OSI approved license.
121
+ * @see https://opensource.org/licenses
122
+ */
123
+ export declare type LicenseType = 'CC-BY-NC-ND-2.0' | 'SGI-B-2.0' | 'LPPL-1.3c' | 'NIST-PD-fallback' | 'libtiff' | 'XSkat' | 'PDDL-1.0' | 'KiCad-libraries-exception' | 'CC-BY-NC-SA-1.0' | 'GFDL-1.1-no-invariants-only' | 'Xerox' | 'LPPL-1.1' | 'VOSTROM' | 'UCL-1.0' | 'ADSL' | 'OSL-2.0' | 'AAL' | 'FDK-AAC' | 'W3C-20150513' | 'AFL-1.1' | 'W3C' | 'Sleepycat' | 'CECILL-1.1' | 'mpich2' | 'SISSL' | 'NLOD-1.0' | 'ANTLR-PD' | 'GPL-3.0-only' | 'gnuplot' | 'NLOD-2.0' | 'BSD-3-Clause-Open-MPI' | 'LiLiQ-P-1.1' | 'BSD-3-Clause-Clear' | 'FSFUL' | 'CC-BY-NC-SA-2.0-UK' | 'CERN-OHL-S-2.0' | 'Spencer-94' | 'CERN-OHL-1.2' | 'GFDL-1.1-or-later' | 'AGPL-1.0-or-later' | 'Wsuipa' | 'AML' | 'BSD-2-Clause' | 'DSDP' | 'CC-BY-2.5' | 'MIT-CMU' | 'Beerware' | 'Sendmail' | 'TU-Berlin-1.0' | 'CNRI-Jython' | 'mplus' | 'CPOL-1.02' | 'BSD-3-Clause-No-Nuclear-License-2014' | 'ISC' | 'CC-BY-SA-4.0' | 'Eurosym' | 'LGPL-3.0-only' | 'OLDAP-1.3' | 'GFDL-1.1-invariants-or-later' | 'Glulxe' | 'SimPL-2.0' | 'CDLA-Permissive-2.0' | 'GPL-2.0-with-font-exception' | 'OGL-UK-2.0' | 'CC-BY-SA-3.0-DE' | 'CC-BY-ND-1.0' | 'GFDL-1.1' | 'CC-BY-4.0' | 'OpenSSL' | 'TU-Berlin-2.0' | 'DOC' | 'GFDL-1.2-no-invariants-or-later' | 'QPL-1.0' | 'OLDAP-2.8' | 'OML' | 'OLDAP-2.7' | 'NIST-PD' | 'Bitstream-Vera' | 'GFDL-1.2-or-later' | 'OFL-1.1-RFN' | 'Bahyph' | 'Barr' | 'COIL-1.0' | 'GFDL-1.3' | 'CECILL-B' | 'JPNIC' | 'Zed' | 'ICU' | 'CC-BY-NC-SA-2.5' | 'CC-BY-ND-3.0-DE' | 'bzip2-1.0.5' | 'SPL-1.0' | 'YPL-1.0' | 'OSET-PL-2.1' | 'Noweb' | 'RPSL-1.0' | 'BSD-3-Clause-LBNL' | 'CDLA-Sharing-1.0' | 'CECILL-1.0' | 'AMPAS' | 'APAFML' | 'CC-BY-ND-3.0' | 'D-FSL-1.0' | 'CC-BY-NC-3.0' | 'libpng-2.0' | 'PolyForm-Noncommercial-1.0.0' | 'dvipdfm' | 'GFDL-1.3-or-later' | 'OGTSL' | 'NPL-1.1' | 'GPL-3.0' | 'CERN-OHL-P-2.0' | 'BlueOak-1.0.0' | 'AGPL-3.0-or-later' | 'blessing' | 'ImageMagick' | 'APSL-2.0' | 'MIT-advertising' | 'curl' | 'CC0-1.0' | 'Zimbra-1.4' | 'SSPL-1.0' | 'psutils' | 'CC-BY-SA-2.0-UK' | 'PSF-2.0' | 'Net-SNMP' | 'NAIST-2003' | 'GFDL-1.2-invariants-or-later' | 'SGI-B-1.0' | 'NBPL-1.0' | 'GFDL-1.2-invariants-only' | 'W3C-19980720' | 'OFL-1.0-no-RFN' | 'NetCDF' | 'TMate' | 'NOSL' | 'CNRI-Python-GPL-Compatible' | 'BSD-1-Clause' | 'CC-BY-NC-SA-3.0-DE' | 'BSD-3-Clause-Modification' | 'GLWTPL' | 'GFDL-1.3-only' | 'OLDAP-2.2' | 'CC-BY-ND-4.0' | 'CC-BY-NC-ND-3.0-DE' | 'EUPL-1.0' | 'Linux-OpenIB' | 'LGPL-2.0-or-later' | 'OSL-1.1' | 'Spencer-86' | 'LGPL-2.0' | 'CC-PDDC' | 'CC-BY-NC-ND-3.0' | 'CDL-1.0' | 'Elastic-2.0' | 'CC-BY-2.0' | 'BSD-3-Clause-No-Military-License' | 'IJG' | 'LPPL-1.3a' | 'SAX-PD' | 'BitTorrent-1.0' | 'OLDAP-2.0' | 'Giftware' | 'C-UDA-1.0' | 'LGPL-2.0+' | 'Rdisc' | 'GPL-2.0-with-classpath-exception' | 'CC-BY-3.0-US' | 'CDDL-1.0' | 'Xnet' | 'CPL-1.0' | 'LGPL-3.0-or-later' | 'NASA-1.3' | 'BUSL-1.1' | 'etalab-2.0' | 'MIT-open-group' | 'OLDAP-1.4' | 'GFDL-1.1-invariants-only' | 'RPL-1.1' | 'CC-BY-NC-ND-2.5' | 'FSFULLR' | 'Saxpath' | 'NTP-0' | 'SISSL-1.2' | 'GPL-3.0-or-later' | 'Apache-1.1' | 'CC-BY-SA-2.1-JP' | 'AGPL-3.0-only' | 'GPL-2.0-with-autoconf-exception' | 'Artistic-2.0' | 'App-s2p' | 'Unicode-DFS-2015' | 'diffmark' | 'SNIA' | 'CC-BY-SA-2.5' | 'Linux-man-pages-copyleft' | 'HPND-sell-variant' | 'ZPL-2.1' | 'BSD-4-Clause-UC' | 'LAL-1.2' | 'AGPL-1.0-only' | 'MIT-enna' | 'Condor-1.1' | 'Naumen' | 'GFDL-1.3-no-invariants-or-later' | 'RPL-1.5' | 'PolyForm-Small-Business-1.0.0' | 'EFL-1.0' | 'MirOS' | 'CC-BY-2.5-AU' | 'Afmparse' | 'MPL-2.0-no-copyleft-exception' | 'LiLiQ-Rplus-1.1' | 'AFL-1.2' | 'OSL-1.0' | 'GPL-1.0-only' | 'APSL-1.0' | 'OGL-Canada-2.0' | 'CPAL-1.0' | 'Latex2e' | 'Zend-2.0' | 'Unlicense' | 'xpp' | 'CC-BY-NC-1.0' | 'GPL-3.0-with-autoconf-exception' | 'CC-BY-NC-SA-3.0' | 'TCP-wrappers' | 'SCEA' | 'SSH-short' | 'CC-BY-3.0-NL' | 'SchemeReport' | 'CC-BY-3.0' | 'MPL-2.0' | 'Unicode-TOU' | 'CC-BY-NC-ND-1.0' | 'Entessa' | 'BSD-3-Clause-No-Nuclear-License' | 'SWL' | 'GFDL-1.2-no-invariants-only' | 'Parity-7.0.0' | 'OLDAP-2.2.1' | 'SGI-B-1.1' | 'FTL' | 'OLDAP-2.4' | 'CC-BY-NC-4.0' | 'bzip2-1.0.6' | 'copyleft-next-0.3.0' | 'MakeIndex' | 'NRL' | 'GFDL-1.3-invariants-or-later' | 'CC-BY-NC-2.0' | 'SugarCRM-1.1.3' | 'AFL-2.1' | 'GPL-2.0-only' | 'GFDL-1.3-invariants-only' | 'TORQUE-1.1' | 'Ruby' | 'X11' | 'Borceux' | 'Libpng' | 'X11-distribute-modifications-variant' | 'Frameworx-1.0' | 'NCGL-UK-2.0' | 'CECILL-2.1' | 'CC-BY-3.0-AT' | 'CNRI-Python' | 'NCSA' | 'gSOAP-1.3b' | 'EUPL-1.1' | 'AMDPLPA' | 'Imlib2' | 'CDDL-1.1' | 'WTFPL' | 'LPL-1.0' | 'EPL-1.0' | 'BSD-3-Clause-Attribution' | 'OSL-3.0' | 'RHeCos-1.1' | 'PHP-3.0' | 'BSD-Protection' | 'CC-BY-NC-3.0-DE' | 'APL-1.0' | 'EUDatagrid' | 'GPL-1.0' | 'SHL-0.5' | 'CC-BY-SA-2.0' | 'CC-BY-SA-3.0-AT' | 'CC-BY-NC-SA-3.0-IGO' | 'Adobe-2006' | 'Newsletr' | 'Nunit' | 'Multics' | 'OGL-UK-1.0' | 'Vim' | 'eCos-2.0' | 'Zimbra-1.3' | 'eGenix' | 'IBM-pibs' | 'BitTorrent-1.1' | 'OFL-1.1-no-RFN' | 'psfrag' | 'CC-BY-ND-2.0' | 'SHL-0.51' | 'FreeBSD-DOC' | 'Python-2.0' | 'Mup' | 'BSD-4-Clause-Shortened' | 'CC-BY-NC-SA-4.0' | 'HPND' | 'OLDAP-2.6' | 'MPL-1.1' | 'GPL-2.0-with-GCC-exception' | 'HaskellReport' | 'ECL-1.0' | 'LGPL-2.1-or-later' | 'OFL-1.0' | 'APSL-1.1' | 'MITNFA' | 'CECILL-2.0' | 'Crossword' | 'Aladdin' | 'Baekmuk' | 'XFree86-1.1' | 'GPL-1.0-or-later' | 'CERN-OHL-W-2.0' | 'CC-BY-SA-1.0' | 'NTP' | 'PHP-3.01' | 'OCLC-2.0' | 'CC-BY-3.0-DE' | 'CC-BY-NC-2.5' | 'Zlib' | 'CATOSL-1.1' | 'LGPL-3.0+' | 'CAL-1.0' | 'NPL-1.0' | 'SMLNJ' | 'GPL-2.0+' | 'OLDAP-2.5' | 'JasPer-2.0' | 'GPL-2.0-or-later' | 'BSD-2-Clause-Patent' | 'MS-RL' | 'CUA-OPL-1.0' | 'IPA' | 'NLPL' | 'O-UDA-1.0' | 'MIT-Modern-Variant' | 'OLDAP-1.2' | 'BSD-2-Clause-FreeBSD' | 'Info-ZIP' | 'CC-BY-NC-SA-2.0-FR' | '0BSD' | 'Unicode-DFS-2016' | 'OFL-1.0-RFN' | 'Intel' | 'AFL-2.0' | 'GL2PS' | 'TAPR-OHL-1.0' | 'Apache-1.0' | 'MTLL' | 'Motosoto' | 'RSA-MD' | 'Community-Spec-1.0' | 'ODC-By-1.0' | 'zlib-acknowledgement' | 'DL-DE-BY-2.0' | 'VSL-1.0' | 'LiLiQ-R-1.1' | 'OPL-1.0' | 'GPL-3.0+' | 'MulanPSL-2.0' | 'APSL-1.2' | 'OGDL-Taiwan-1.0' | 'RSCPL' | 'OGC-1.0' | 'EFL-2.0' | 'CAL-1.0-Combined-Work-Exception' | 'MS-PL' | 'Plexus' | 'Sendmail-8.23' | 'Cube' | 'JSON' | 'EUPL-1.2' | 'Adobe-Glyph' | 'FreeImage' | 'Watcom-1.0' | 'Jam' | 'Hippocratic-2.1' | 'OLDAP-2.0.1' | 'CC-BY-NC-SA-2.0' | 'Nokia' | 'OCCT-PL' | 'ErlPL-1.1' | 'TOSL' | 'OSL-2.1' | 'ClArtistic' | 'xinetd' | 'GPL-3.0-with-GCC-exception' | 'ODbL-1.0' | 'MIT' | 'LGPL-2.1+' | 'LGPL-2.1-only' | 'CrystalStacker' | 'ECL-2.0' | 'LPPL-1.0' | 'iMatix' | 'CC-BY-NC-ND-3.0-IGO' | 'BSD-Source-Code' | 'Parity-6.0.0' | 'TCL' | 'Arphic-1999' | 'CC-BY-SA-3.0' | 'Caldera' | 'AGPL-1.0' | 'IPL-1.0' | 'LAL-1.3' | 'EPICS' | 'NGPL' | 'DRL-1.0' | 'BSD-2-Clause-NetBSD' | 'ZPL-1.1' | 'GD' | 'LPPL-1.2' | 'Dotseqn' | 'Spencer-99' | 'OLDAP-2.3' | 'YPL-1.1' | 'Fair' | 'Qhull' | 'GFDL-1.1-no-invariants-or-later' | 'CECILL-C' | 'MulanPSL-1.0' | 'OLDAP-1.1' | 'OLDAP-2.1' | 'LPL-1.02' | 'UPL-1.0' | 'Abstyles' | 'ZPL-2.0' | 'MIT-0' | 'LGPL-2.0-only' | 'GFDL-1.3-no-invariants-only' | 'AGPL-3.0' | 'EPL-2.0' | 'AFL-3.0' | 'CDLA-Permissive-1.0' | 'Artistic-1.0' | 'CC-BY-NC-ND-4.0' | 'HTMLTIDY' | 'Glide' | 'FSFAP' | 'LGPLLR' | 'OGL-UK-3.0' | 'GFDL-1.2' | 'SSH-OpenSSH' | 'GFDL-1.1-only' | 'MIT-feh' | 'MPL-1.0' | 'PostgreSQL' | 'OLDAP-2.2.2' | 'SMPPL' | 'OFL-1.1' | 'Leptonica' | 'CERN-OHL-1.1' | 'BSD-3-Clause-No-Nuclear-Warranty' | 'CC-BY-ND-2.5' | 'CC-BY-1.0' | 'GFDL-1.2-only' | 'OPUBL-1.0' | 'libselinux-1.0' | 'BSD-3-Clause' | 'ANTLR-PD-fallback' | 'copyleft-next-0.3.1' | 'GPL-1.0+' | 'wxWindows' | 'LGPL-3.0' | 'LGPL-2.1' | 'StandardML-NJ' | 'BSD-4-Clause' | 'GPL-2.0-with-bison-exception' | 'Apache-2.0' | 'Artistic-1.0-cl8' | 'GPL-2.0' | 'Intel-ACPI' | 'BSL-1.0' | 'Artistic-1.0-Perl' | 'BSD-2-Clause-Views' | 'Interbase-1.0' | 'NPOSL-3.0';
124
+ /**
125
+ * The list of accepted language codes.
126
+ * @see https://meta.wikimedia.org/wiki/Template:List_of_language_names_ordered_by_code
127
+ */
128
+ export declare type LanguageCode = 'aa' | 'ab' | 'af' | 'ak' | 'als' | 'am' | 'an' | 'ang' | 'ang' | 'ar' | 'arc' | 'as' | 'ast' | 'av' | 'awa' | 'ay' | 'az' | 'ba' | 'bar' | 'bat-smg' | 'bcl' | 'be' | 'be-x-old' | 'bg' | 'bh' | 'bi' | 'bm' | 'bn' | 'bo' | 'bpy' | 'br' | 'brx' | 'bs' | 'bug' | 'bxr' | 'ca' | 'cdo' | 'ce' | 'ceb' | 'ch' | 'cho' | 'chr' | 'chy' | 'ckb' | 'co' | 'cr' | 'cs' | 'csb' | 'cu' | 'cv' | 'cy' | 'da' | 'de' | 'diq' | 'dsb' | 'dv' | 'dz' | 'ee' | 'el' | 'en' | 'eo' | 'es' | 'et' | 'eu' | 'ext' | 'fa' | 'ff' | 'fi' | 'fiu-vro' | 'fj' | 'fo' | 'fr' | 'frp' | 'fur' | 'fy' | 'ga' | 'gan' | 'gbm' | 'gd' | 'gil' | 'gl' | 'gn' | 'got' | 'gu' | 'gv' | 'ha' | 'hak' | 'haw' | 'he' | 'hi' | 'ho' | 'hr' | 'ht' | 'hu' | 'hy' | 'hz' | 'ia' | 'id' | 'ie' | 'ig' | 'ii' | 'ik' | 'ilo' | 'inh' | 'io' | 'is' | 'it' | 'iu' | 'ja' | 'jbo' | 'jv' | 'ka' | 'kg' | 'ki' | 'kj' | 'kk' | 'kl' | 'km' | 'kn' | 'khw' | 'ko' | 'kr' | 'ks' | 'ksh' | 'ku' | 'kv' | 'kw' | 'ky' | 'la' | 'lad' | 'lan' | 'lb' | 'lg' | 'li' | 'lij' | 'lmo' | 'ln' | 'lo' | 'lzz' | 'lt' | 'lv' | 'map-bms' | 'mg' | 'man' | 'mh' | 'mi' | 'min' | 'mk' | 'ml' | 'mn' | 'mo' | 'mr' | 'mrh' | 'ms' | 'mt' | 'mus' | 'mwl' | 'my' | 'na' | 'nah' | 'nap' | 'nd' | 'nds' | 'nds-nl' | 'ne' | 'new' | 'ng' | 'nl' | 'nn' | 'no' | 'nr' | 'nso' | 'nrm' | 'nv' | 'ny' | 'oc' | 'oj' | 'om' | 'or' | 'os' | 'pa' | 'pag' | 'pam' | 'pap' | 'pdc' | 'pi' | 'pih' | 'pl' | 'pms' | 'ps' | 'pt' | 'qu' | 'rm' | 'rmy' | 'rn' | 'ro' | 'roa-rup' | 'ru' | 'rw' | 'sa' | 'sc' | 'scn' | 'sco' | 'sd' | 'se' | 'sg' | 'sh' | 'si' | 'sk' | 'sl' | 'sm' | 'sn' | 'so' | 'sq' | 'sr' | 'ss' | 'st' | 'su' | 'sv' | 'sw' | 'ta' | 'te' | 'tet' | 'tg' | 'th' | 'ti' | 'tk' | 'tl' | 'tlh' | 'tn' | 'to' | 'tpi' | 'tr' | 'ts' | 'tt' | 'tum' | 'tw' | 'ty' | 'udm' | 'ug' | 'uk' | 'ur' | 'uz' | 'uz_AF' | 've' | 'vi' | 'vec' | 'vls' | 'vo' | 'wa' | 'war' | 'wo' | 'xal' | 'xh' | 'xmf' | 'yi' | 'yo' | 'za' | 'zh' | 'zh-classical' | 'zh-min-nan' | 'zh-yue' | 'zu';
File without changes
@@ -0,0 +1,9 @@
1
+ /**
2
+ * The npm package manifest (package.json)
3
+ */
4
+ export interface Manifest {
5
+ name: string;
6
+ version: string;
7
+ description: string;
8
+ [key: string]: unknown;
9
+ }
File without changes
@@ -0,0 +1,167 @@
1
+ import type MarkdownIt from 'markdown-it';
2
+ import type { ComponentPluginOptions } from '@mdit-vue/plugin-component';
3
+ import type { FrontmatterPluginOptions } from '@mdit-vue/plugin-frontmatter';
4
+ import type { MarkdownItEnv } from '@mdit-vue/types';
5
+ import type { FilterPattern } from '@rollup/pluginutils';
6
+ /** a `<meta />` property in HTML is defined with the following name/values */
7
+ export interface MetaProperty {
8
+ key?: string;
9
+ /**
10
+ * the "name" property used by Facebook and other providers who
11
+ * use the Open Graph standards
12
+ */
13
+ property?: string;
14
+ /**
15
+ * used by google to identify the "name" of the name/value pair
16
+ */
17
+ itemprop?: string;
18
+ /**
19
+ * used by Twitter to indicate the "name" field in a meta properties
20
+ * name/value pairing
21
+ */
22
+ name?: string;
23
+ /**
24
+ * The value of the meta property
25
+ */
26
+ content?: any;
27
+ [key: string]: unknown;
28
+ }
29
+ /**
30
+ * Frontmatter content is represented as key/value dictionary
31
+ */
32
+ export interface Frontmatter {
33
+ title?: string;
34
+ name?: string;
35
+ description?: string;
36
+ meta?: MetaProperty[];
37
+ [key: string]: unknown;
38
+ }
39
+ export interface Options {
40
+ /**
41
+ * Explicitly set the Vue version
42
+ *
43
+ * @default auto detected
44
+ */
45
+ vueVersion?: string;
46
+ /**
47
+ * Enable head support, need to install @vueuse/head and register to App in main.js
48
+ *
49
+ * @default false
50
+ */
51
+ headEnabled?: boolean;
52
+ /**
53
+ * The head field in frontmatter used to be used for @vueuse/head
54
+ *
55
+ * When an empty string is passed, it will use the root properties of the frontmatter
56
+ *
57
+ * @default ''
58
+ */
59
+ headField?: string;
60
+ /**
61
+ * Parse for frontmatter
62
+ *
63
+ * @default true
64
+ */
65
+ frontmatter?: boolean;
66
+ /**
67
+ * Parse for excerpt
68
+ *
69
+ * If `true`, it will be passed to `frontmatterPreprocess` as `frontmatter.excerpt`, replacing the `excerpt` key in frontmatter, if there's any
70
+ *
71
+ * @default false
72
+ */
73
+ excerpt?: boolean;
74
+ /**
75
+ * Remove custom SFC block
76
+ *
77
+ * @default ['route', 'i18n']
78
+ */
79
+ customSfcBlocks?: string[];
80
+ /**
81
+ * Options passed to [@mdit-vue/plugin-component](https://github.com/mdit-vue/mdit-vue/tree/main/packages/plugin-component)
82
+ */
83
+ componentOptions?: ComponentPluginOptions;
84
+ /**
85
+ * Options passed to [@mdit-vue/plugin-frontmatter](https://github.com/mdit-vue/mdit-vue/tree/main/packages/plugin-frontmatter)
86
+ */
87
+ frontmatterOptions?: FrontmatterPluginOptions;
88
+ /**
89
+ * Custom function to provide defaults to the frontmatter and
90
+ * move certain attributes into the "meta" category.
91
+ *
92
+ * Note: _overriding this will remove built-in functionality setting
93
+ * "meta" properties and the built-in "head" support. Do this only
94
+ * if you know what you're doing._
95
+ */
96
+ frontmatterPreprocess?: (frontmatter: Frontmatter, options: ResolvedOptions) => {
97
+ head: Record<string, any>;
98
+ frontmatter: Frontmatter;
99
+ };
100
+ /**
101
+ * Expose frontmatter via expose API
102
+ *
103
+ * @default true
104
+ */
105
+ exposeFrontmatter?: boolean;
106
+ /**
107
+ * Expose excerpt via expose API
108
+ *
109
+ * @default false
110
+ */
111
+ exposeExcerpt?: boolean;
112
+ /**
113
+ * Add `v-pre` to `<code>` tag to escape curly brackets interpolation
114
+ *
115
+ * @see https://github.com/antfu/vite-plugin-vue-markdown/issues/14
116
+ * @default true
117
+ */
118
+ escapeCodeTagInterpolation?: boolean;
119
+ /**
120
+ * Options passed to Markdown It
121
+ */
122
+ markdownItOptions?: MarkdownIt.Options;
123
+ /**
124
+ * Plugins for Markdown It
125
+ */
126
+ markdownItUses?: (MarkdownIt.PluginSimple | [MarkdownIt.PluginSimple | MarkdownIt.PluginWithOptions<any>, any] | any)[];
127
+ /**
128
+ * A function providing the Markdown It instance gets the ability to apply custom
129
+ * settings/plugins
130
+ */
131
+ markdownItSetup?: (MarkdownIt: MarkdownIt) => void;
132
+ /**
133
+ * Class names for wrapper div
134
+ *
135
+ * @default 'markdown-body'
136
+ */
137
+ wrapperClasses?: string | string[];
138
+ /**
139
+ * Component name to wrapper with
140
+ *
141
+ * @default undefined
142
+ */
143
+ wrapperComponent?: string | undefined | null;
144
+ /**
145
+ * Custom transformations apply before and after the markdown transformation
146
+ */
147
+ transforms?: {
148
+ before?: (code: string, id: string) => string;
149
+ after?: (code: string, id: string) => string;
150
+ };
151
+ include?: FilterPattern;
152
+ exclude?: FilterPattern;
153
+ }
154
+ export interface ResolvedOptions extends Required<Options> {
155
+ wrapperClasses: string;
156
+ }
157
+ export interface MarkdownEnv extends MarkdownItEnv {
158
+ id: string;
159
+ }
160
+ /**
161
+ * ### Markdown Options
162
+ *
163
+ * The Markdown options.
164
+ *
165
+ * @see https://github.com/mdit-vue/vite-plugin-vue-markdown/blob/main/src/types.ts
166
+ */
167
+ export declare type MarkdownOptions = Options;
File without changes
@@ -0,0 +1,7 @@
1
+ import type { UserOptions } from 'vite-plugin-pages';
2
+ /**
3
+ * ### Pages Options
4
+ *
5
+ * The pages options.
6
+ */
7
+ export declare type PagesOptions = UserOptions;
package/dist/pages.mjs ADDED
File without changes
package/dist/pwa.d.ts ADDED
@@ -0,0 +1,7 @@
1
+ import type { Options } from 'vite-plugin-pwa';
2
+ /**
3
+ * ### PWA Options
4
+ *
5
+ * The PWA options.
6
+ */
7
+ export declare type PwaOptions = Options;
package/dist/pwa.mjs ADDED
File without changes
package/dist/ssg.d.ts ADDED
@@ -0,0 +1,2 @@
1
+ import { type ViteSSGContext } from 'vite-ssg';
2
+ export declare type UserModule = (ctx: ViteSSGContext) => void;
package/dist/ssg.mjs ADDED
File without changes
package/dist/ui.d.ts ADDED
@@ -0,0 +1,132 @@
1
+ import type { UserShortcuts } from 'unocss';
2
+ /**
3
+ * ### UI Engine Options
4
+ *
5
+ * This type defines all of your UI Engine options. Because Stacks is full-typed, you may
6
+ * hover any of the options below and the definitions will be provided. In case you
7
+ * have any questions, feel free to reach out via Discord or GitHub Discussions.
8
+ */
9
+ export interface UiOptions {
10
+ /**
11
+ * ### Shortcuts
12
+ *
13
+ * Shortcuts provide you with the ability to combine
14
+ * utility names for reusability purposes.
15
+ *
16
+ * @example
17
+ * ```ts
18
+ * shortcuts: {
19
+ * 'btn': 'px-4 py-2 rounded text-white bg-blue-500',
20
+ * 'btn-lg': 'btn px-6 py-3',
21
+ * }
22
+ */
23
+ shortcuts: Shortcuts;
24
+ /**
25
+ * ### Safelist
26
+ *
27
+ * Use the `safelist` option to ensure the generation of
28
+ * those utility classes. This is useful when certain
29
+ * class names don’t exist in your content files.
30
+ *
31
+ * @example
32
+ * ```ts
33
+ * safelist: [
34
+ * 'btn',
35
+ * 'btn-lg',
36
+ * 'btn-blue',
37
+ * 'btn-blue-500',
38
+ * ]
39
+ */
40
+ safelist: string;
41
+ /**
42
+ * ### Trigger String
43
+ *
44
+ * The "trigger string" defines the class name markup
45
+ * you want to add into your components.
46
+ *
47
+ * @default ':stx:'
48
+ *
49
+ * @example
50
+ * ```ts
51
+ * trigger: ':stx:'
52
+ * ```
53
+ */
54
+ trigger?: string;
55
+ /**
56
+ * ### Class Prefix
57
+ *
58
+ * The prefix for the compiled class name. When transforming
59
+ * all utility classes into a single class, this prefix
60
+ * will be added to the generated CSS class name.
61
+ *
62
+ * @default 'stx-'
63
+ *
64
+ * @example
65
+ * ```ts
66
+ * prefix: 'stx-'
67
+ * ```
68
+ */
69
+ classPrefix?: string;
70
+ /**
71
+ * ### Hash Function
72
+ *
73
+ * The hash function used to generate the class name.
74
+ *
75
+ * @example
76
+ * ```ts
77
+ * hash: (str: string) => {
78
+ * return str
79
+ * .split('')
80
+ * .reduce((a, b) => {
81
+ * a = ((a << 5) - a) + b.charCodeAt(0)
82
+ * return a & a
83
+ * }, 0)
84
+ * .toString(36)
85
+ * }
86
+ */
87
+ hashFn?: (str: string) => string;
88
+ /**
89
+ * ### CSS Resets—Preset
90
+ *
91
+ * Define a standard of reset CSS stylesheets. By default, the Tailwind
92
+ * reset styles are utilized. You may set this value to `null`
93
+ * if you prefer not applying any default stylesheets.
94
+ *
95
+ * @url https://www.npmjs.com/package/@unocss/reset
96
+ * @todo preset needs to be added via a Vite plugin on development & build
97
+ * @example
98
+ * ```ts
99
+ * reset: 'tailwind'
100
+ * ```
101
+ */
102
+ reset?: ResetPreset;
103
+ /**
104
+ * ### Icon Sets
105
+ *
106
+ * This value defines the icon sets you want to use. When using icons, they
107
+ * are displayed utilizing a technique called "icons in pure css."
108
+ * Learn more here https://antfu.me/posts/icons-in-pure-css.
109
+ *
110
+ * @see https://stacks.ow3.org/config/icons — list of available icon sets
111
+ * @todo implement this into Vite build flow
112
+ * @example
113
+ * ```ts
114
+ * icons: ['heroicons']
115
+ * ```
116
+ * @example
117
+ * ```html
118
+ * <i class="i-heroicons-outline-book-open w-8 h-8 text-gray-500" aria-hidden="true" />
119
+ * ```
120
+ */
121
+ icons: Record<string, () => Promise<any>>;
122
+ }
123
+ export declare type Shortcuts = UserShortcuts;
124
+ /**
125
+ * ### Style Reset — Preset
126
+ *
127
+ * This value sets the "reset preset." A preset defines certain
128
+ * CSS defaults to be applied.
129
+ *
130
+ * @default "tailwind"
131
+ */
132
+ export declare type ResetPreset = 'tailwind' | 'normalize' | 'sanitize' | 'eric-meyer' | 'antfu' | null;
package/dist/ui.mjs ADDED
File without changes
package/package.json ADDED
@@ -0,0 +1,59 @@
1
+ {
2
+ "name": "@stacksjs/types",
3
+ "type": "module",
4
+ "version": "0.37.3",
5
+ "packageManager": "pnpm@7.13.6",
6
+ "description": "The Stacks framework types.",
7
+ "author": "Chris Breuer",
8
+ "license": "MIT",
9
+ "funding": "https://github.com/sponsors/chrisbbreuer",
10
+ "homepage": "https://github.com/stacksjs/stacks/tree/main/.stacks/types#readme",
11
+ "repository": {
12
+ "type": "git",
13
+ "url": "git+https://github.com/stacksjs/stacks.git",
14
+ "directory": "./.stacks/types"
15
+ },
16
+ "bugs": {
17
+ "url": "https://github.com/stacksjs/stacks/issues"
18
+ },
19
+ "keywords": [
20
+ "types",
21
+ "stacks",
22
+ "framework",
23
+ "typescript"
24
+ ],
25
+ "main": "dist/index.mjs",
26
+ "module": "dist/index.mjs",
27
+ "types": "dist/index.d.ts",
28
+ "contributors": [
29
+ "Chris Breuer <chris@ow3.org>"
30
+ ],
31
+ "files": [
32
+ "dist"
33
+ ],
34
+ "engines": {
35
+ "node": ">=v18.10.0",
36
+ "pnpm": ">=7.13.6"
37
+ },
38
+ "dependencies": {
39
+ "@mdit-vue/plugin-component": "^0.11.1",
40
+ "@mdit-vue/plugin-frontmatter": "^0.11.1",
41
+ "@mdit-vue/types": "^0.11.0",
42
+ "@rollup/pluginutils": "^5.0.2",
43
+ "markdown-it": "^13.0.1",
44
+ "unplugin-auto-import": "^0.11.2",
45
+ "unplugin-vue-components": "^0.22.8",
46
+ "vite": "^3.1.8",
47
+ "vite-plugin-inspect": "^0.7.5",
48
+ "vite-plugin-vue-layouts": "^0.7.0",
49
+ "vitepress": "1.0.0-alpha.22"
50
+ },
51
+ "devDependencies": {
52
+ "mkdist": "^0.3.13"
53
+ },
54
+ "scripts": {
55
+ "build": "mkdist -d",
56
+ "dev": "mkdist -d",
57
+ "typecheck": "tsc --noEmit"
58
+ }
59
+ }