lumen-framework 3.0.0

package/dist/types/constants.d.ts

@@ -0,0 +1,7 @@
+export declare const CWD: string;
+export declare const PID: number;
+export declare const PORT: number;
+export declare const NODE_ENV: string;
+export declare const DATABASE_URL: string | undefined;
+export declare const LUMEN_CONSOLE: string | boolean;
+export declare const PLATFORM: NodeJS.Platform;

package/dist/types/errors/controller-missing-error.d.ts

@@ -0,0 +1,7 @@
+/**
+ * @private
+ */
+declare class ControllerMissingError extends ReferenceError {
+    constructor(resource: string);
+}
+export default ControllerMissingError;

package/dist/types/errors/serializer-missing-error.d.ts

@@ -0,0 +1,7 @@
+/**
+ * @private
+ */
+declare class SerializerMissingError extends ReferenceError {
+    constructor(resource: string);
+}
+export default SerializerMissingError;

package/dist/types/index.d.ts

@@ -0,0 +1,6 @@
+export { Model } from './packages/database';
+export { default as Logger } from './packages/logger';
+export { default as Controller } from './packages/controller';
+export { default as Serializer } from './packages/serializer';
+export { default as Application } from './packages/application';
+export { default as lumenify } from './packages/lumenify';

package/dist/types/interfaces.d.ts

@@ -0,0 +1,12 @@
+export interface Lumen$Collection<T> {
+    size: number;
+    has(key: T): boolean;
+    clear(): void;
+    delete(key: T): boolean;
+    values(): Iterator<T>;
+}
+export interface Chain<T> {
+    pipe<U>(handler: (value: T) => U): Chain<U>;
+    value(): T;
+    construct<U>(constructor: new (value: T) => U): Chain<U>;
+}

package/dist/types/packages/application/index.d.ts

@@ -0,0 +1,97 @@
+import type Logger from '../logger';
+import type Router from '../router';
+import type Server from '../server';
+import type Controller from '../controller';
+import type Serializer from '../serializer';
+import type Database from '../database';
+import type { Model, ModelClass } from '../database';
+import type { FreezeableMap } from '../freezeable';
+import type { Application$opts } from './interfaces';
+/**
+ * @class Application
+ * @public
+ */
+declare class Application {
+    /**
+     * The path of `Application` instance.
+     *
+     * @property path
+     * @type {String}
+     * @public
+     */
+    path: string;
+    /**
+     * The port that an `Application` instance is listening for incomming HTTP
+     * requests.
+     *
+     * @property port
+     * @type {Number}
+     * @public
+     */
+    port: number;
+    /**
+     * A reference to the `Database` instance.
+     *
+     * @property store
+     * @type {Database}
+     * @private
+     */
+    store: Database;
+    /**
+     * A reference to the `Logger` instance.
+     *
+     * @property logger
+     * @type {Logger}
+     * @private
+     */
+    logger: Logger;
+    /**
+     * A reference to the `Router` instance.
+     *
+     * @property router
+     * @type {Router}
+     * @private
+     */
+    router: Router;
+    /**
+     * A reference to the `Server` instance.
+     *
+     * @property server
+     * @type {Server}
+     * @private
+     */
+    server: Server;
+    /**
+     * A map containing each `Model` class.
+     *
+     * @property models
+     * @type {Map}
+     * @private
+     */
+    models: FreezeableMap<string, ModelClass>;
+    /**
+     * A map containing each `Controller` instance.
+     *
+     * @property controllers
+     * @type {Map}
+     * @private
+     */
+    controllers: FreezeableMap<string, Controller>;
+    /**
+     * A map containing each `Serializer` instance.
+     *
+     * @property serializers
+     * @type {Map}
+     * @private
+     */
+    serializers: FreezeableMap<string, Serializer<Model>>;
+    /**
+     * @method constructor
+     * @param {Object} config
+     * @return {Promise}
+     * @public
+     */
+    constructor(opts: Application$opts);
+}
+export default Application;
+export type { Application$opts, Application$Class, Application$factoryOpts } from './interfaces';

package/dist/types/packages/application/initialize.d.ts

@@ -0,0 +1,6 @@
+import type Application from './index';
+import type { Application$opts } from './index';
+/**
+ * @private
+ */
+export default function initialize<T extends Application>(app: T, { path, port, logging, database, server: serverConfig }: Application$opts): Promise<T>;

package/dist/types/packages/application/interfaces.d.ts

@@ -0,0 +1,16 @@
+import type { Config } from '../config';
+import type Database from '../database';
+import type { Database$config, Model } from '../database';
+import type Controller from '../controller';
+import type Serializer from '../serializer';
+export type Application$opts = Config & {
+    path: string;
+    port: string | number;
+    database: Database$config;
+};
+export type Application$Class<T> = new (...args: Array<any>) => T;
+export type Application$factoryOpts<T extends Controller | Serializer<Model>> = {
+    key: string;
+    store: Database;
+    parent?: T | null;
+};

package/dist/types/packages/application/utils/create-controller.d.ts

@@ -0,0 +1,12 @@
+import type Database from '../../database';
+import type { Model } from '../../database';
+import type Controller from '../../controller';
+import type Serializer from '../../serializer';
+import type { Bundle$Namespace } from '../../loader';
+import type { Application$Class } from '../index';
+export default function createController<T extends Controller>(constructor: Application$Class<T>, opts: {
+    key: string;
+    store: Database;
+    parent?: Controller | null;
+    serializers: Bundle$Namespace<Serializer<Model>>;
+}): T;

package/dist/types/packages/application/utils/create-serializer.d.ts

@@ -0,0 +1,4 @@
+import type Serializer from '../../serializer';
+import type { Model } from '../../database';
+import type { Application$Class, Application$factoryOpts } from '../index';
+export default function createSerializer<T extends Serializer<Model>>(constructor: Application$Class<T>, opts: Application$factoryOpts<T>): T;

package/dist/types/packages/application/utils/normalize-port.d.ts

@@ -0,0 +1,4 @@
+/**
+ * @private
+ */
+export default function normalizePort(port?: string | number): number;

package/dist/types/packages/cli/commands/build.d.ts

@@ -0,0 +1 @@
+export declare function build(useStrict?: boolean): Promise<void>;

package/dist/types/packages/cli/commands/create.d.ts

@@ -0,0 +1,4 @@
+/**
+ * @private
+ */
+export declare function create(name: string, database: string): Promise<void>;

package/dist/types/packages/cli/commands/dbcreate.d.ts

@@ -0,0 +1,4 @@
+/**
+ * @private
+ */
+export declare function dbcreate(): Promise<unknown>;

package/dist/types/packages/cli/commands/dbdrop.d.ts

@@ -0,0 +1,4 @@
+/**
+ * @private
+ */
+export declare function dbdrop(): Promise<unknown>;

package/dist/types/packages/cli/commands/dbmigrate.d.ts

@@ -0,0 +1,4 @@
+/**
+ * @private
+ */
+export declare function dbmigrate(): Promise<boolean>;

package/dist/types/packages/cli/commands/dbrollback.d.ts

@@ -0,0 +1,4 @@
+/**
+ * @private
+ */
+export declare function dbrollback(): Promise<void>;

package/dist/types/packages/cli/commands/dbseed.d.ts

@@ -0,0 +1,4 @@
+/**
+ * @private
+ */
+export declare function dbseed(): Promise<unknown>;

package/dist/types/packages/cli/commands/destroy.d.ts

@@ -0,0 +1,11 @@
+/**
+ * @private
+ */
+export declare function destroyType(type: string, name: string): Promise<void>;
+/**
+ * @private
+ */
+export declare function destroy({ type, name }: {
+    type: string;
+    name: string;
+}): Promise<void>;

package/dist/types/packages/cli/commands/generate.d.ts

@@ -0,0 +1,10 @@
+import type { Generator$opts } from '../generator';
+/**
+ * @private
+ */
+export declare function generate({ cwd, name, type, attrs }: {
+    cwd?: Generator$opts['cwd'];
+    name: Generator$opts['name'];
+    type: Generator$opts['type'];
+    attrs?: Generator$opts['attrs'];
+}): Promise<void>;

package/dist/types/packages/cli/commands/index.d.ts

@@ -0,0 +1,12 @@
+export { build } from './build';
+export { create } from './create';
+export { dbcreate } from './dbcreate';
+export { dbdrop } from './dbdrop';
+export { dbmigrate } from './dbmigrate';
+export { dbrollback } from './dbrollback';
+export { dbseed } from './dbseed';
+export { destroy } from './destroy';
+export { generate } from './generate';
+export { repl } from './repl';
+export { serve } from './serve';
+export { test } from './test';

package/dist/types/packages/cli/commands/repl.d.ts

@@ -0,0 +1 @@
+export declare function repl(): Promise<void>;

package/dist/types/packages/cli/commands/serve.d.ts

@@ -0,0 +1,8 @@
+/**
+ * @private
+ */
+export declare function serve({ hot, cluster, useStrict }: {
+    hot: boolean;
+    cluster: boolean;
+    useStrict: boolean;
+}): Promise<void>;

package/dist/types/packages/cli/commands/test.d.ts

@@ -0,0 +1,4 @@
+/**
+ * @private
+ */
+export declare function test(): Promise<void>;

package/dist/types/packages/cli/constants.d.ts

@@ -0,0 +1,2 @@
+export declare const VALID_DATABASES: string[];
+export declare const CONNECTION_STRING_MESSAGE: string;

package/dist/types/packages/cli/errors/database-config-missing.d.ts

@@ -0,0 +1,4 @@
+declare class DatabaseConfigMissingError extends ReferenceError {
+    constructor(environment: string);
+}
+export default DatabaseConfigMissingError;

package/dist/types/packages/cli/generator/constants.d.ts

@@ -0,0 +1,5 @@
+/**
+ * TODO: Update the 'routes.js' file when generating a resource within a
+ *       namespace.
+ */
+export declare const NAMESPACED_RESOURCE_MESSAGE: string;

package/dist/types/packages/cli/generator/index.d.ts

@@ -0,0 +1,11 @@
+import type { Generator$opts } from './interfaces';
+/**
+ * @private
+ */
+export declare function runGenerator({ cwd, type, name, attrs }: {
+    cwd: Generator$opts['cwd'];
+    type: Generator$opts['type'];
+    name: Generator$opts['name'];
+    attrs: Generator$opts['attrs'];
+}): Promise<void>;
+export type { Generator, Generator$opts, Generator$template } from './interfaces';

package/dist/types/packages/cli/generator/interfaces.d.ts

@@ -0,0 +1,9 @@
+export type Generator$opts = {
+    cwd: string;
+    type: string;
+    name: string;
+    attrs: Array<string>;
+    onConflict(text: string): Promise<string | boolean>;
+};
+export type Generator = (opts: Generator$opts) => Promise<void>;
+export type Generator$template = (name: string, attrs: Array<string>) => string;

package/dist/types/packages/cli/generator/utils/create-generator.d.ts

@@ -0,0 +1,9 @@
+import type { Generator, Generator$template } from '../index';
+/**
+ * @private
+ */
+export default function createGenerator({ dir, template, hasConflict }: {
+    dir: string;
+    template: Generator$template;
+    hasConflict?: (path: string) => Promise<boolean>;
+}): Generator;

package/dist/types/packages/cli/generator/utils/generate-type.d.ts

@@ -0,0 +1,33 @@
+import type { Generator$opts } from '../index';
+/**
+ * @private
+ */
+export declare function controller(opts: Generator$opts): Promise<void>;
+/**
+ * @private
+ */
+export declare function serializer(opts: Generator$opts): Promise<void>;
+/**
+ * @private
+ */
+export declare function migration(opts: Generator$opts): Promise<void>;
+/**
+ * @private
+ */
+export declare function modelMigration(opts: Generator$opts): Promise<void>;
+/**
+ * @private
+ */
+export declare function model(opts: Generator$opts): Promise<void>;
+/**
+ * @private
+ */
+export declare function middleware(opts: Generator$opts): Promise<void>;
+/**
+ * @private
+ */
+export declare function util(opts: Generator$opts): Promise<void>;
+/**
+ * @private
+ */
+export declare function resource(opts: Generator$opts): Promise<void>;

package/dist/types/packages/cli/generator/utils/generator-for.d.ts

@@ -0,0 +1,2 @@
+import type { Generator } from '../index';
+export default function generatorFor(type: string): Generator;

package/dist/types/packages/cli/generator/utils/log.d.ts

@@ -0,0 +1,4 @@
+/**
+ * @private
+ */
+export default function log(data: string | Error): void;

package/dist/types/packages/cli/generator/utils/migration-conflict.d.ts

@@ -0,0 +1,6 @@
+import type { Generator$opts } from '../index';
+export declare function detectConflict(path: string): Promise<boolean>;
+export declare function createConflictResolver({ cwd, onConflict }: {
+    cwd: Generator$opts['cwd'];
+    onConflict: Generator$opts['onConflict'];
+}): Generator$opts['onConflict'];

package/dist/types/packages/cli/templates/application.d.ts

@@ -0,0 +1,5 @@
+/**
+ * @private
+ */
+declare const _default: (name: string) => string;
+export default _default;

package/dist/types/packages/cli/templates/config.d.ts

@@ -0,0 +1,5 @@
+/**
+ * @private
+ */
+declare const _default: (name: string, env: string) => string;
+export default _default;

package/dist/types/packages/cli/templates/controller.d.ts

@@ -0,0 +1,5 @@
+/**
+ * @private
+ */
+declare const _default: (name: string, attrs: Array<string>) => string;
+export default _default;

package/dist/types/packages/cli/templates/database.d.ts

@@ -0,0 +1,5 @@
+/**
+ * @private
+ */
+declare const _default: (name: string, driver: string) => string;
+export default _default;

package/dist/types/packages/cli/templates/empty-migration.d.ts

@@ -0,0 +1,5 @@
+/**
+ * @private
+ */
+declare const _default: () => string;
+export default _default;

package/dist/types/packages/cli/templates/eslint-config.d.ts

@@ -0,0 +1,5 @@
+/**
+ * @private
+ */
+declare const _default: () => string;
+export default _default;

package/dist/types/packages/cli/templates/gitignore.d.ts

@@ -0,0 +1,5 @@
+/**
+ * @private
+ */
+declare const _default: () => string;
+export default _default;

package/dist/types/packages/cli/templates/license.d.ts

@@ -0,0 +1,5 @@
+/**
+ * @private
+ */
+declare const _default: () => string;
+export default _default;

package/dist/types/packages/cli/templates/middleware.d.ts

@@ -0,0 +1,5 @@
+/**
+ * @private
+ */
+declare const _default: (name: string) => string;
+export default _default;

package/dist/types/packages/cli/templates/model-migration.d.ts

@@ -0,0 +1,5 @@
+/**
+ * @private
+ */
+declare const _default: (name: string, attrs: Array<string> | string) => string;
+export default _default;

package/dist/types/packages/cli/templates/model.d.ts

@@ -0,0 +1,5 @@
+/**
+ * @private
+ */
+declare const _default: (name: string, attrs: Array<string>) => string;
+export default _default;

package/dist/types/packages/cli/templates/package-json.d.ts

@@ -0,0 +1,5 @@
+/**
+ * @private
+ */
+declare const _default: (name: string, driver: string) => string;
+export default _default;

package/dist/types/packages/cli/templates/readme.d.ts

@@ -0,0 +1,5 @@
+/**
+ * @private
+ */
+declare const _default: (name: string) => string;
+export default _default;

package/dist/types/packages/cli/templates/routes.d.ts

@@ -0,0 +1,5 @@
+/**
+ * @private
+ */
+declare const _default: () => string;
+export default _default;

package/dist/types/packages/cli/templates/seed.d.ts

@@ -0,0 +1,5 @@
+/**
+ * @private
+ */
+declare const _default: () => string;
+export default _default;

package/dist/types/packages/cli/templates/serializer.d.ts

@@ -0,0 +1,5 @@
+/**
+ * @private
+ */
+declare const _default: (name: string, attrs: Array<string>) => string;
+export default _default;

package/dist/types/packages/cli/templates/util.d.ts

@@ -0,0 +1,5 @@
+/**
+ * @private
+ */
+declare const _default: (name: string) => string;
+export default _default;

package/dist/types/packages/cli/utils/create-prompt.d.ts

@@ -0,0 +1,4 @@
+export default function createPrompt(): {
+    question(text: string): Promise<boolean>;
+    close(): void;
+};

package/dist/types/packages/cli/utils/driver-for.d.ts

@@ -0,0 +1 @@
+export default function driverFor(database?: string): string;

package/dist/types/packages/cli/utils/indent.d.ts

@@ -0,0 +1 @@
+export default function indent(amount?: number): string;

package/dist/types/packages/compiler/index.d.ts

@@ -0,0 +1,11 @@
+/**
+ * @private
+ */
+type CompileOptions = {
+    useStrict?: boolean;
+};
+/**
+ * @private
+ */
+export declare function compile(dir: string, env: string, opts?: CompileOptions): Promise<void>;
+export {};

package/dist/types/packages/compiler/interfaces.d.ts

@@ -0,0 +1 @@
+export type Compiler$manifestWriter = (value: string | Array<string>, resolveName?: (value: string) => string, resolveExport?: (value: string) => string) => Promise<void>;

package/dist/types/packages/compiler/utils/create-boot-script.d.ts

@@ -0,0 +1,6 @@
+/**
+ * @private
+ */
+export default function createBootScript(dir: string, { useStrict }: {
+    useStrict: boolean;
+}): Promise<void>;

package/dist/types/packages/compiler/utils/create-manifest.d.ts

@@ -0,0 +1,6 @@
+/**
+ * @private
+ */
+export default function createManifest(dir: string, assets: Map<string, Array<string> | string>, { useStrict }: {
+    useStrict: boolean;
+}): Promise<void>;

package/dist/types/packages/compiler/utils/format-name.d.ts

@@ -0,0 +1,5 @@
+/**
+ * @private
+ */
+declare const formatName: (source: string) => string;
+export default formatName;

package/dist/types/packages/config/index.d.ts

@@ -0,0 +1,3 @@
+import type { Config } from './interfaces';
+export declare function createDefaultConfig(): Config;
+export type { Config } from './interfaces';

package/dist/types/packages/config/interfaces.d.ts

@@ -0,0 +1,6 @@
+import type { Logger$config } from '../logger';
+import type { Server$config } from '../server';
+export type Config = {
+    logging: Logger$config;
+    server: Server$config;
+};

package/dist/types/packages/controller/constants.d.ts

@@ -0,0 +1,2 @@
+import type { Controller$builtIn } from './index';
+export declare const BUILT_IN_ACTIONS: ReadonlyArray<Controller$builtIn>;