@stacksjs/config 0.59.1 → 0.59.2

package/dist/config.d.ts

@@ -0,0 +1,7 @@
+import type { StacksOptions } from '@stacksjs/types';
+import defaults from './defaults';
+import overrides from './overrides';
+export declare const config: StacksOptions;
+export declare const ai: Partial<import("@stacksjs/types").AiOptions>, analytics: Partial<import("@stacksjs/types").AnalyticsOptions>, app: Partial<import("@stacksjs/types").AppOptions>, cache: Partial<import("@stacksjs/types").CacheOptions>, cloud: Partial<import("@stacksjs/types").CloudOptions>, cli: Partial<import("@stacksjs/types").BinaryOptions>, database: Partial<import("@stacksjs/types").DatabaseOptions>, dns: Partial<import("@stacksjs/types").DnsOptions>, docs: import("@stacksjs/types").DocsUserConfig, email: Partial<import("@stacksjs/types").EmailOptions>, git: Partial<import("@stacksjs/types").GitOptions>, hashing: Partial<import("@stacksjs/types").HashingOptions>, library: Partial<import("@stacksjs/types").LibraryOptions>, logger: Partial<import("@stacksjs/types").LoggerOptions>, notification: Partial<import("@stacksjs/types").NotificationOptions>, payment: Partial<import("@stacksjs/types").PaymentOptions>, ports: import("@stacksjs/types").Ports, queue: import("@stacksjs/types").DeepPartial<import("@stacksjs/types").QueueOptions>, security: import("@stacksjs/types").DeepPartial<import("@stacksjs/types").SecurityOptions>, searchEngine: Partial<import("@stacksjs/types").SearchEngineOptions>, services: Partial<import("@stacksjs/types").ServicesOptions>, storage: Partial<import("@stacksjs/types").StorageOptions>, team: import("@stacksjs/types").Team, ui: Partial<import("@stacksjs/types").UiOptions>;
+export { defaults, overrides };
+export * from './helpers';

package/dist/defaults.d.ts

@@ -0,0 +1,343 @@
+declare const _default: {
+    ai: {
+        deploy: false;
+        models: ("amazon.titan-embed-text-v1" | "amazon.titan-text-express-v1" | "amazon.titan-embed-image-v1" | "amazon.titan-image-generator-v1" | "anthropic.claude-v1" | "anthropic.claude-v2" | "anthropic.claude-v2:1" | "anthropic.claude-instant-v1" | "meta.llama2-13b-chat-v1" | "meta.llama2-70b-chat-v1")[];
+    };
+    analytics: {
+        driver: undefined;
+    };
+    app: {
+        name: string;
+        description: string;
+        env: string;
+        url: string;
+        debug: true;
+        key: string;
+        timezone: string;
+        locale: string;
+        fallbackLocale: "en";
+        cipher: string;
+        docMode: false;
+        redirectUrls: never[];
+        maintenanceMode: false;
+    };
+    cli: {
+        name: string;
+        command: string;
+        description: string;
+        source: string;
+        deploy: false;
+    };
+    cache: {
+        driver: string;
+        prefix: string;
+        ttl: number;
+        drivers: {
+            redis: {
+                connection: string;
+                host: string;
+                port: number;
+                username: string;
+                password: string;
+            };
+        };
+    };
+    cloud: {
+        type: "serverless";
+        driver: "aws";
+        storage: {};
+        environments: ("development" | "staging" | "production")[];
+        firewall: {
+            enabled: true;
+            countryCodes: never[];
+            ipAddresses: never[];
+            queryString: never[];
+            httpHeaders: never[];
+            rateLimitPerMinute: number;
+            useIpReputationLists: true;
+            useKnownBadInputsRuleSet: true;
+        };
+        cdn: {
+            allowedMethods: "GET_HEAD";
+            cachedMethods: "GET_HEAD";
+            minTtl: number;
+            defaultTtl: number;
+            maxTtl: number;
+            compress: true;
+            priceClass: "PriceClass_All";
+            originShieldRegion: string;
+            cookieBehavior: "none";
+            allowList: {
+                cookies: never[];
+                headers: never[];
+                queryStrings: never[];
+            };
+            realtimeLogs: {
+                enabled: true;
+                samplingRate: number;
+            };
+        };
+        api: {
+            deploy: false;
+            prefix: string;
+            description: string;
+            prewarm: true;
+            memorySize: number;
+            timeout: number;
+        };
+        fileSystem: false;
+    };
+    database: {
+        default: string;
+        name: string;
+        connections: {
+            sqlite: {
+                database: string;
+                prefix: string;
+            };
+        };
+    };
+    dns: {
+        driver: "aws";
+        a: never[];
+        aaaa: never[];
+        cname: never[];
+        mx: never[];
+        txt: never[];
+    };
+    docs: {
+        lang: string;
+        title: string;
+        description: string;
+        lastUpdated: true;
+        deploy: false;
+        themeConfig: {
+            editLink: {
+                pattern: string;
+                text: string;
+            };
+            footer: {
+                message: string;
+                copyright: string;
+            };
+        };
+    };
+    email: {
+        from: {
+            name: string;
+            address: string;
+        };
+        mailboxes: never[];
+        server: {
+            scan: true;
+        };
+    };
+    git: {
+        hooks: {
+            'pre-commit': string;
+        };
+        scopes: string[];
+        messages: {
+            type: string;
+            scope: string;
+            customScope: string;
+            subject: string;
+            body: string;
+            breaking: string;
+            footerPrefixesSelect: string;
+            customFooterPrefixes: string;
+            footer: string;
+            confirmCommit: string;
+        };
+        types: {
+            value: string;
+            name: string;
+            emoji: string;
+        }[];
+    };
+    hashing: {
+        driver: "argon2";
+        bcrypt: {
+            rounds: number;
+            cost: number;
+        };
+        argon2: {
+            memory: number;
+            threads: number;
+            time: number;
+        };
+    };
+    library: {
+        name: string;
+        owner: string;
+        repository: string;
+        license: "MIT";
+        author: string;
+        contributors: string[];
+        defaultLanguage: "en";
+        vueComponents: {
+            name: string;
+            description: string;
+            keywords: string[];
+            tags: {
+                name: string[];
+                description: string;
+                attributes: {
+                    name: string;
+                    description: string;
+                }[];
+            }[];
+        };
+        webComponents: {
+            name: string;
+            description: string;
+            keywords: string[];
+            tags: {
+                name: string[];
+                description: string;
+                attributes: {
+                    name: string;
+                    description: string;
+                }[];
+            }[];
+        };
+        functions: {
+            name: string;
+            description: string;
+            keywords: string[];
+            shouldGenerateSourcemap: false;
+            functions: string[];
+        };
+    };
+    logger: {
+        level: 3;
+        logFilePath: string;
+        errorsPath: string;
+    };
+    notification: {
+        default: string;
+    };
+    payment: {
+        driver: "stripe";
+    };
+    ports: {
+        frontend: number;
+        backend: number;
+        admin: number;
+        library: number;
+        desktop: number;
+        email: number;
+        docs: number;
+        inspect: number;
+        api: number;
+        systemTray: number;
+    };
+    queue: {
+        default: "sync";
+        connections: {
+            sync: {
+                driver: "sync";
+            };
+            database: {
+                driver: "database";
+                table: "jobs";
+                queue: "default";
+                retry_after: 90;
+            };
+            redis: {
+                driver: "redis";
+                connection: "default";
+                queue: "default";
+                retry_after: 90;
+            };
+            sqs: {
+                driver: "sqs";
+                key: "";
+                secret: "";
+                prefix: "";
+                suffix: "";
+                queue: "default";
+                region: "us-east-1";
+            };
+        };
+    };
+    searchEngine: {
+        driver: "meilisearch";
+    };
+    security: {
+        firewall: {
+            enabled: true;
+            countryCodes: never[];
+            ipAddresses: never[];
+            queryString: never[];
+            httpHeaders: never[];
+            rateLimitPerMinute: number;
+            useIpReputationLists: true;
+            useKnownBadInputsRuleSet: true;
+        };
+    };
+    services: {
+        aws: {
+            accountId: string;
+            appId: string;
+            apiKey: string;
+            region: string;
+        };
+        algolia: {
+            appId: string;
+            apiKey: string;
+        };
+        meilisearch: {
+            appId: string;
+            apiKey: string;
+        };
+        stripe: {
+            appId: string;
+            apiKey: string;
+        };
+        planetscale: {
+            appId: string;
+            apiKey: string;
+        };
+        supabase: {
+            appId: string;
+            apiKey: string;
+        };
+    };
+    storage: {
+        driver: "s3";
+    };
+    team: {
+        name: string;
+        members: {
+            'Chris Breuer': string;
+        };
+    };
+    ui: {
+        shortcuts: [string, string][];
+        safelist: string;
+        trigger: string;
+        classPrefix: string;
+        reset: "tailwind";
+        icons: "heroicons"[];
+        fonts: {
+            email: {
+                title: string;
+                text: string;
+            };
+            desktop: {
+                title: string;
+                text: string;
+            };
+            mobile: {
+                title: string;
+                text: string;
+            };
+            web: {
+                title: string;
+                text: string;
+            };
+        };
+    };
+};
+export default _default;

package/dist/helpers.d.ts

@@ -0,0 +1,37 @@
+import type { AppConfig, CacheConfig, CdnConfig, ChatConfig, CliConfig, DatabaseConfig, DependenciesConfig, DnsConfig, EmailConfig, Events, GitConfig, HashingConfig, JobConfig, LibraryConfig, Model, NotificationConfig, PaymentConfig, QueueConfig, SearchEngineConfig, SecurityConfig, ServicesConfig, SmsConfig, StacksConfig, StorageConfig, UiConfig } from '@stacksjs/types';
+import { config } from '.';
+export type LocalUrlType = 'frontend' | 'backend' | 'api' | 'admin' | 'library' | 'email' | 'docs' | 'inspect' | 'desktop';
+export declare function localUrl({ domain, type, localhost, https, network, }?: {
+    domain?: string | undefined;
+    type?: config.LocalUrlType | undefined;
+    localhost?: boolean | undefined;
+    https?: boolean | undefined;
+    network?: boolean | undefined;
+}): Promise<any>;
+export declare function defineStacksConfig(config: StacksConfig): Partial<import("@stacksjs/types").StacksOptions>;
+export declare function defineApp(config: AppConfig): Partial<import("@stacksjs/types").AppOptions>;
+export declare function defineCache(config: CacheConfig): Partial<import("@stacksjs/types").CacheOptions>;
+export declare function defineCdn(config: CdnConfig): Partial<import("@stacksjs/types").CdnOptions>;
+export declare function defineChat(config: ChatConfig): import("@stacksjs/types/dist/chat.js").ChatOptions;
+export declare function defineCli(config: CliConfig): import("@stacksjs/types").CliOptions;
+export declare function defineJob(config: JobConfig): import("@stacksjs/types").JobOptions;
+export declare function defineCronJob(config: JobConfig): import("@stacksjs/types").JobOptions;
+export declare function defineDatabase(config: DatabaseConfig): Partial<import("@stacksjs/types").DatabaseOptions>;
+export declare function defineDependencies(config: DependenciesConfig): import("@stacksjs/types").DependenciesOptions;
+export declare function defineDns(config: DnsConfig): Partial<import("@stacksjs/types").DnsOptions>;
+export declare function defineEmailConfig(config: EmailConfig): Partial<import("@stacksjs/types").EmailOptions>;
+export declare function defineEmail(config: EmailConfig): Partial<import("@stacksjs/types").EmailOptions>;
+export declare function defineGit(config: GitConfig): Partial<import("@stacksjs/types").GitOptions>;
+export declare function defineHashing(config: HashingConfig): Partial<import("@stacksjs/types").HashingOptions>;
+export declare function defineLibrary(config: LibraryConfig): Partial<import("@stacksjs/types").LibraryOptions>;
+export declare function defineNotification(config: NotificationConfig): Partial<import("@stacksjs/types").NotificationOptions>;
+export declare function definePayment(config: PaymentConfig): Partial<import("@stacksjs/types").PaymentOptions>;
+export declare function defineQueue(config: QueueConfig): import("@stacksjs/types").DeepPartial<import("@stacksjs/types").QueueOptions>;
+export declare function defineSearchEngine(config: SearchEngineConfig): Partial<import("@stacksjs/types").SearchEngineOptions>;
+export declare function defineSecurity(config: SecurityConfig): import("@stacksjs/types").DeepPartial<import("@stacksjs/types").SecurityOptions>;
+export declare function defineServices(config: ServicesConfig): Partial<import("@stacksjs/types").ServicesOptions>;
+export declare function defineSms(config: SmsConfig): SmsConfig;
+export declare function defineStorage(config: StorageConfig): Partial<import("@stacksjs/types").StorageOptions>;
+export declare function defineUi(config: UiConfig): Partial<import("@stacksjs/types").UiOptions>;
+export declare function defineModel(config: Model): Partial<import("@stacksjs/types").ModelOptions>;
+export declare function defineEvents(config: Events): Events;

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export * as config from './config';
+export * from './config';