@stacksjs/types 0.37.3

package/LICENSE.md

@@ -0,0 +1,21 @@
+# MIT License
+
+Copyright (c) 2022 Open Web Foundation
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,59 @@
+# Stacks Types
+
+This package contains the Stacks TypeScript types.
+
+## ☘️ Features
+
+wip
+
+- ⚡️
+
+wip
+
+## 🤖 Usage
+
+wip
+
+```bash
+pnpm i -D @stacksjs/types
+```
+
+Now, you can use it in your project:
+
+```js
+// import * as types from '@stacksjs/types'
+
+// wip
+```
+
+Learn more in the docs.
+
+## 🧪 Testing
+
+```bash
+pnpm test
+```
+
+## 📈 Changelog
+
+Please see our [releases](https://github.com/stacksjs/stacksjs/releases) page for more information on what has changed recently.
+
+## 💪🏼 Contributing
+
+Please see [CONTRIBUTING](../../.github/CONTRIBUTING.md) for details.
+
+## 🏝 Community
+
+For help, discussion about best practices, or any other conversation that would benefit from being searchable:
+
+[Discussions on GitHub](https://github.com/stacksjs/stacks/discussions)
+
+For casual chit-chat with others using this package:
+
+[Join the Open Web Discord Server](https://discord.ow3.org)
+
+## 📄 License
+
+The MIT License (MIT). Please see [LICENSE](https://github.com/stacksjs/stacks/tree/main/LICENSE.md) for more information.
+
+Made with ❤️

package/dist/app.d.ts

@@ -0,0 +1,119 @@
+/**
+ * ### Application Options
+ *
+ * This configuration defines all of your application options. Because Stacks is full-typed,
+ * you may hover any of the options below and the definitions will be provided. In case
+ * you have any questions, feel free to reach out via Discord or GitHub Discussions.
+ */
+export interface AppOptions {
+    /**
+     * ### Application Name
+     *
+     * This value is the name of your application. This value is used when the
+     * framework needs to place the application's name in a log or any
+     * other location as required by the application or its packages.
+     *
+     * @default string "Stacks"
+     */
+    name: string;
+    /**
+     * ### Application Environment
+     *
+     * This value determines the "environment" your application is currently
+     * running in. This may determine how you prefer to configure various
+     * services the application utilizes. Set this in your ".env" file
+     *
+     * @default "local"
+     */
+    env?: 'development' | 'production' | 'local';
+    /**
+     * ### Application URL
+     *
+     * This URL is used by the console to properly generate URLs when using
+     * the Artisan command line tool. You should set this to the root of
+     * your application so that it is used when running Artisan tasks.
+     *
+     * @default string "https://localhost"
+     * @example
+     * https://hello-world.test
+     */
+    url?: string;
+    /**
+     * ### Application Debug Mode
+     *
+     * When your application is in debug mode, detailed error messages with
+     * stack traces will be shown on every error that occurs within your
+     * application. If disabled, a simple generic error page is shown.
+     *
+     * @default false
+     */
+    debug: boolean;
+    /**
+     * ### Application Port
+     *
+     * This port is used when Stacks creates a server you. You should set
+     * a port that's not already in use by your machine. Stacks defaults
+     * to a memorable port that likely is free on your end: 3333.
+     *
+     * @default number 3333
+     */
+    port: number;
+    /**
+     * ### Encryption Key
+     *
+     * This key is used by the Stacks encrypter service and should be set to
+     * a random, 32 character string, otherwise these encrypted strings will
+     * not be safe. Please do this before deploying an application!
+     */
+    key?: string;
+    /**
+     * ### Application Timezone
+     *
+     * Here you may specify the default timezone for your application, which
+     * will be used by Stacks and date-time functions. We have gone ahead
+     * and set this to a sensible default for you out of the box.
+     *
+     * @default string "UTC"
+     */
+    timezone?: string;
+    /**
+     * ### Application Locale Configuration
+     *
+     * The application locale determines the default locale that will be used
+     * by the translation service provider. You are free to set this value
+     * to any of the locales which will be supported by the application.
+     *
+     * @default string "en"
+     * @example
+     * de // ./lang/de.yml needs to be present for this
+     */
+    locale?: string;
+    /**
+     * ### Application Fallback Locale
+     *
+     * The fallback locale determines the locale to use when the current one
+     * is not available. You may change the value to correspond to any of
+     * the language folders that are provided through your application.
+     *
+     * @default string "en"
+     */
+    fallbackLocale: 'en';
+    /**
+     * ### Integrated Development Environment
+     *
+     * Currently, only VS Code is fully supported. While you may use Stacks with
+     * any editor, some of its tooling is VS Code specific. Hence, for the
+     * best experience, VS Code is currently the recommended editor.
+     *
+     * @default string "vscode"
+     */
+    editor: string;
+    /**
+     * ### Cipher
+     *
+     * Description WIP.
+     *
+     * @default string "aes-256-cbc"
+     */
+    cipher: string;
+}

package/dist/auto-imports.d.ts

@@ -0,0 +1,2 @@
+import type { Options } from 'unplugin-auto-import/types';
+export declare type AutoImportsOptions = Options;

package/dist/build.d.ts

@@ -0,0 +1,2 @@
+import type { UserConfig } from 'vite';
+export declare type ViteConfig = UserConfig;

package/dist/cli.d.ts

@@ -0,0 +1,48 @@
+/**
+ * The parsed command-line arguments
+ */
+export interface StacksOptions {
+    componentsSrcPath?: string;
+    dtsPath?: string;
+    extensions?: string[];
+}
+/**
+ * The available npm scripts within the Stacks toolkit.
+ */
+export declare const enum NpmScript {
+    Build = "build",
+    BuildComponents = "build:components",
+    BuildWebComponents = "build:web-components",
+    BuildFunctions = "build:functions",
+    BuildDocs = "build:docs",
+    BuildStacks = "build:stacks",
+    Dev = "dev",
+    DevComponents = "dev:components",
+    DevDocs = "dev:docs",
+    Fresh = "fresh",
+    Update = "update",
+    UpdateDependencies = "update:dependencies",
+    UpdateFramework = "update:framework",
+    UpdatePackageManager = "update:package-manager",
+    Lint = "lint",
+    LintFix = "lint:fix",
+    MakeStack = "make:stack",
+    Test = "test",
+    TestTypes = "test:types",
+    TestCoverage = "test:coverage",
+    Generate = "generate",
+    GenerateEntries = "generate:entries",
+    GenerateVueCompat = "generate:vue-compatibility",
+    GenerateWebTypes = "generate:web-types",
+    GenerateVsCodeCustomData = "generate:vscode-custom-data",
+    GenerateIdeHelpers = "generate:ide-helpers",
+    GenerateComponentMeta = "generate:component-meta",
+    Release = "release",
+    Commit = "commit",
+    Example = "example",
+    ExampleVue = "example:vue",
+    ExampleWebComponents = "example:web-components",
+    KeyGenerate = "key:generate",
+    TypesFix = "types:fix",
+    TypesGenerate = "types:generate"
+}

package/dist/cli.mjs

@@ -0,0 +1,38 @@
+export var NpmScript = /* @__PURE__ */ ((NpmScript2) => {
+  NpmScript2["Build"] = "build";
+  NpmScript2["BuildComponents"] = "build:components";
+  NpmScript2["BuildWebComponents"] = "build:web-components";
+  NpmScript2["BuildFunctions"] = "build:functions";
+  NpmScript2["BuildDocs"] = "build:docs";
+  NpmScript2["BuildStacks"] = "build:stacks";
+  NpmScript2["Dev"] = "dev";
+  NpmScript2["DevComponents"] = "dev:components";
+  NpmScript2["DevDocs"] = "dev:docs";
+  NpmScript2["Fresh"] = "fresh";
+  NpmScript2["Update"] = "update";
+  NpmScript2["UpdateDependencies"] = "update:dependencies";
+  NpmScript2["UpdateFramework"] = "update:framework";
+  NpmScript2["UpdatePackageManager"] = "update:package-manager";
+  NpmScript2["Lint"] = "lint";
+  NpmScript2["LintFix"] = "lint:fix";
+  NpmScript2["MakeStack"] = "make:stack";
+  NpmScript2["Test"] = "test";
+  NpmScript2["TestTypes"] = "test:types";
+  NpmScript2["TestCoverage"] = "test:coverage";
+  NpmScript2["Generate"] = "generate";
+  NpmScript2["GenerateEntries"] = "generate:entries";
+  NpmScript2["GenerateVueCompat"] = "generate:vue-compatibility";
+  NpmScript2["GenerateWebTypes"] = "generate:web-types";
+  NpmScript2["GenerateVsCodeCustomData"] = "generate:vscode-custom-data";
+  NpmScript2["GenerateIdeHelpers"] = "generate:ide-helpers";
+  NpmScript2["GenerateComponentMeta"] = "generate:component-meta";
+  NpmScript2["Release"] = "release";
+  NpmScript2["Commit"] = "commit";
+  NpmScript2["Example"] = "example";
+  NpmScript2["ExampleVue"] = "example:vue";
+  NpmScript2["ExampleWebComponents"] = "example:web-components";
+  NpmScript2["KeyGenerate"] = "key:generate";
+  NpmScript2["TypesFix"] = "types:fix";
+  NpmScript2["TypesGenerate"] = "types:generate";
+  return NpmScript2;
+})(NpmScript || {});

package/dist/components.d.ts

@@ -0,0 +1,61 @@
+import type { Options } from 'unplugin-vue-components';
+export interface TagOption {
+    /**
+     * ### Tag Name
+     *
+     * This is the name of the component to be included in your library build.
+     * When defining a tag, ensure that the name corresponds to a file within
+     * root component directory.
+     *
+     * @example
+     * {
+     *   tags: [{
+     *     name: 'HelloWorld' // results in `<HelloWorld />`
+     *   }]
+     * }
+     *
+     * @example
+     * {
+     *   tags: [{
+     *     name: ['HelloWorld', 'AppHelloWorld'] // results in `<AppHelloWorld />`
+     *   }]
+     * }
+     * @see https://stacksjs.dev/docs/components
+     */
+    name: string | string[];
+    /**
+     * ### Tag Description
+     *
+     * This is the description of your component. This value is
+     * used when to provide additional information to IDEs.
+     *
+     * @example
+     * {
+     *   name: 'HelloWorld' // results in `<HelloWorld />`
+     * }
+     * @see https://stacksjs.dev/docs/components
+     */
+    description?: string;
+    /**
+     * ### Tag Attributes
+     *
+     * These are your component's attributes. While it's an optional field, you should aim
+     * to define all of your component attributes here, to provide as much context
+     * to your IDEs as possible, when actually using the library as an end-user.
+     *
+     * @example
+     * {
+     *   attributes: {
+     *     name: 'greeting',
+     *     description: 'The way to greet the user.',
+     *   }
+     * }
+     * @see https://stacksjs.dev/docs/components
+     */
+    attributes?: {
+        name: string;
+        description: string;
+    }[];
+}
+export declare type TagsOptions = TagOption[];
+export declare type ComponentOptions = Options;

package/dist/deploy.d.ts

@@ -0,0 +1,11 @@
+export interface DeployOptions {
+    /**
+     * ### Deployment Host
+     *
+     * The host to deploy to.
+     *
+     * @default string 'netlify'
+     * @see https://stacksjs.dev/docs/components
+     */
+    host: 'netlify' | 'vercel';
+}

package/dist/docs.d.ts

@@ -0,0 +1,2 @@
+import type { UserConfig } from 'vitepress';
+export declare type DocsConfig = UserConfig;

package/dist/exit-code.d.ts

@@ -0,0 +1,10 @@
+/**
+ * CLI exit codes.
+ *
+ * @see https://nodejs.org/api/process.html#process_exit_codes
+ */
+export declare enum ExitCode {
+    Success = 0,
+    FatalError = 1,
+    InvalidArgument = 9
+}

package/dist/exit-code.mjs

@@ -0,0 +1,6 @@
+export var ExitCode = /* @__PURE__ */ ((ExitCode2) => {
+  ExitCode2[ExitCode2["Success"] = 0] = "Success";
+  ExitCode2[ExitCode2["FatalError"] = 1] = "FatalError";
+  ExitCode2[ExitCode2["InvalidArgument"] = 9] = "InvalidArgument";
+  return ExitCode2;
+})(ExitCode || {});

package/dist/fs.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Describes a plain-text file.
+ */
+export interface TextFile {
+    path: string;
+    data: string;
+}
+/**
+ * Describes a JSON file.
+ */
+export interface JsonFile {
+    path: string;
+    data: unknown;
+    indent: string;
+    newline: string | undefined;
+}

package/dist/git.d.ts

@@ -0,0 +1,128 @@
+/**
+ * ### Git Options
+ *
+ * This configuration defines all of your git options. Because Stacks is full-typed, you may
+ * hover any of the options below and the definitions will be provided. In case you
+ * have any questions, feel free to reach out via Discord or GitHub Discussions.
+ */
+export interface GitOptions {
+    /**
+     * ### Git Hooks
+     *
+     * The git hooks to use.
+     *
+     * @see https://git-scm.com/docs/githooks
+     * @example
+     * ```ts
+     * git: {
+     *   hooks: {
+     *    'pre-commit': 'lint-staged',
+     *   }
+     * }
+     * ```
+     */
+    hooks: GitHooks;
+    /**
+     * ### Git Commit Scopes
+     *
+     * The git commit scopes to use.
+     *
+     * @see https://stacksjs.dev/docs/git/scopes
+     * @example
+     * git: [
+     *   scopes: [
+     *     '', 'ci', 'deps', 'dx', 'release', 'readme', 'test', 'actions', 'build', 'cli',
+     *     'config', 'examples', 'functions', 'modules', 'pages', 'router', 'scripts',
+     *     'ui', 'utils', 'arrays', 'collections', 'fs', 'objects', 'strings',
+     *   ]
+     * ]
+     */
+    scopes: string[];
+    /**
+     * ### Git Commit Types
+     *
+     * The git commit types to use.
+     *
+     * @default array
+     * @see https://stacksjs.dev/docs/git/types
+     * @see https://www.conventionalcommits.org/en/v1.0.0/
+     * @example
+     * ```ts
+     * git: [
+     *   types: [
+     *     'build', 'chore', 'ci', 'docs', 'feat', 'fix', 'perf', 'refactor', 'revert', 'style', 'test',
+     *    ]
+     * ]
+     * ```
+     */
+    types: {
+        value: string;
+        name: string;
+        emoji: string;
+    }[];
+    /**
+     * ### Messages—Options
+     *
+     * The git messages/prompts to use.
+     *
+     * @default object
+     * @example
+     * ```ts
+     * messages: {
+     *   type: 'Select the type of change that you\'re committing:',
+     *   scope: 'Denote the SCOPE of this change:',
+     *   subject: 'Write a SHORT, IMPERATIVE tense description of the change:\n',
+     *   body: 'Provide a LONGER description of the change (optional). Use "|" to break new line:\n',
+     *   breaking: 'List any BREAKING CHANGES (optional):\n',
+     *   footer: 'List any ISSUES CLOSED by this change (optional). E.g.: #31, #34:\n',
+     *   confirmCommit: 'Are you sure you want to proceed with the commit above?',
+     * }
+     * ```
+     * @see https://stacksjs.dev/docs/git/messages
+     */
+    messages: {
+        type: string;
+        scope: string;
+        customScope: string;
+        subject: string;
+        body: string;
+        breaking: string;
+        footerPrefixsSelect: string;
+        customFooterPrefixs: string;
+        footer: string;
+        confirmCommit: string;
+    };
+}
+interface Hooks {
+    'applypatch-msg'?: string;
+    'pre-applypatch'?: string;
+    'post-applypatch'?: string;
+    'pre-commit'?: string;
+    'pre-merge-commit'?: string;
+    'prepare-commit-msg'?: string;
+    'commit-msg'?: string;
+    'post-commit'?: string;
+    'pre-rebase'?: string;
+    'post-checkout'?: string;
+    'post-merge'?: string;
+    'pre-push'?: string;
+    'pre-receive'?: string;
+    'update'?: string;
+    'proc-receive'?: string;
+    'post-receive'?: string;
+    'post-update'?: string;
+    'reference-transaction'?: string;
+    'push-to-checkout'?: string;
+    'pre-auto-gc'?: string;
+    'post-rewrite'?: string;
+    'sendemail-validate'?: string;
+    'fsmonitor-watchman'?: string;
+    'p4-changelist'?: string;
+    'p4-prepare-changelist'?: string;
+    'p4-post-changelist'?: string;
+    'p4-pre-submit'?: string;
+    'post-index-change'?: string;
+}
+export interface GitHooks extends Hooks {
+}
+export {};

package/dist/hashing.d.ts

@@ -0,0 +1,101 @@
+/**
+ * The Stacks runtime provides secure Bcrypt & Argon2 hashing for storing user passwords.
+ * If you are using one of the Laravel application starter kits, Bcrypt will be used for
+ * registration and authentication by default.
+ *
+ * Bcrypt is a great choice for hashing passwords because its "work factor" is adjustable, which
+ * means that the time it takes to generate a hash can be increased as hardware power increases.
+ * When hashing passwords, slow is good. The longer an algorithm takes to hash a password, the
+ * longer it takes malicious users to generate "rainbow tables" of all possible string hash
+ * values that may be used in brute force attacks against applications.
+ *
+ * @see https://stacksjs.dev/docs/hashing
+ */
+export interface HashingOptions {
+    /**
+     * ### Hashing Driver
+     *
+     * This option controls the default hash driver that will be used to hash
+     * passwords for your application. By default, the bcrypt algorithm is
+     * used; however, you remain free to modify this option if you wish.
+     *
+     * @see https://stacksjs.dev/docs/hashing
+     */
+    driver: 'argon' | 'bcrypt';
+    /**
+     * ### Bcrypt Option
+     *
+     * Here you may specify the configuration options that should be used when
+     * passwords are hashed using the Bcrypt algorithm. This will allow you
+     * to control the amount of time it takes to hash the given password.
+     *
+     * @see https://stacksjs.dev/docs/hashing
+     */
+    bcrypt?: BcryptOptions;
+    /**
+     * ### Argon Options
+     *
+     * Here you may specify the configuration options that should be used when
+     * passwords are hashed using the Argon algorithm. These will allow you
+     * to control the amount of time it takes to hash the given password.
+     *
+     * @see https://stacksjs.dev/docs/hashing
+     */
+    argon?: ArgonOptions;
+}
+/**
+ * ### Bcrypt Options
+ *
+ * Here you may specify the configuration options that should be used when
+ * passwords are hashed using the Bcrypt algorithm. This will allow you
+ * to control the amount of time it takes to hash the given password.
+ *
+ * @see https://stacksjs.dev/docs/hashing
+ */
+export interface BcryptOptions {
+    /**
+     * Bcrypt salt rounds.
+     *
+     * @default number 10
+     * @see https://stacksjs.dev/docs/hashing
+     */
+    rounds?: number;
+}
+/**
+ * ### Argon Options
+ *
+ * Here you may specify the configuration options that should be used when
+ * passwords are hashed using the Argon algorithm. These will allow you
+ * to control the amount of time it takes to hash the given password.
+ *
+ * @see https://stacksjs.dev/docs/hashing
+ */
+export interface ArgonOptions {
+    /**
+     * ### Argon Memory
+     *
+     * Amount of memory (in kibibytes) to use.
+     *
+     * @default number 65536
+     * @see https://stacksjs.dev/docs/hashing
+     */
+    memory?: number;
+    /**
+     * ### Argon Parallelism
+     *
+     * Degree of parallelism (i.e. number of threads).
+     *
+     * @default number 1
+     * @see https://stacksjs.dev/docs/hashing
+     */
+    threads?: number;
+    /**
+     * ### Argon time
+     *
+     * Execution time.
+     *
+     * @default number 1
+     * @see https://stacksjs.dev/docs/hashing
+     */
+    time?: number;
+}

package/dist/i18n.d.ts

@@ -0,0 +1,19 @@
+interface VitePluginVueI18nOptions {
+    forceStringify?: boolean;
+    runtimeOnly?: boolean;
+    compositionOnly?: boolean;
+    fullInstall?: boolean;
+    include?: string | string[];
+    defaultSFCLang?: 'json' | 'json5' | 'yml' | 'yaml';
+    globalSFCScope?: boolean;
+    useVueI18nImportName?: boolean;
+}
+/**
+ * ### Internationalization Options
+ *
+ * The i18n option.
+ *
+ * @see https://github.com/intlify/bundle-tools/blob/main/packages/vite-plugin-vue-i18n/src/options.ts
+ */
+export declare type i18nOptions = VitePluginVueI18nOptions;
+export {};