@lakutata/orm 0.0.0-stage → 3.0.0-beta.0

package/dist/types/providers/migration/GenerateMigration.d.ts

@@ -0,0 +1,59 @@
+import { Provider } from '@lakutata/core';
+import { type DataSourceOptions } from 'typeorm/data-source/DataSourceOptions.js';
+export declare class GenerateMigration extends Provider {
+    #private;
+    protected readonly path: string;
+    protected readonly dataSourceName: string;
+    protected readonly dataSource: DataSourceOptions;
+    protected readonly pretty: boolean;
+    protected readonly outputJs: boolean;
+    protected readonly esm: boolean;
+    protected readonly dryRun: boolean;
+    protected readonly check: boolean;
+    protected readonly timestamp: number;
+    protected readonly exitProcess: boolean;
+    protected get extension(): string;
+    protected get filename(): string;
+    /**
+     * Initializer
+     * @protected
+     */
+    /**
+     * The migrations generated by the run (its databases share the process)
+     */
+    protected static generated: number;
+    protected init(): Promise<void>;
+    /**
+     * Destroyer
+     * @protected
+     */
+    protected destroy(): Promise<void>;
+    protected handle(): Promise<void>;
+    /**
+     * The module the migrations import their types from: @lakutata/orm when the project depends on it, otherwise
+     * lakutata/orm (the migrations of the projects depending on lakutata)
+     */
+    protected static migrationModule(): string;
+    /**
+     * Escape a query for a template literal of the migration: its backslashes, its backticks and its interpolations
+     * (the defaults and the comments of the columns are in the queries)
+     * @param query
+     */
+    protected static escapeTemplateLiteral(query: string): string;
+    /**
+     * Formats query parameters for migration queries if parameters actually exist
+     */
+    protected static queryParams(parameters: any[] | undefined): string;
+    /**
+     * Gets contents of the migration file.
+     */
+    protected static getTemplate(name: string, timestamp: number, upSqls: string[], downSqls: string[]): string;
+    /**
+     * Gets contents of the migration file in Javascript.
+     */
+    protected static getJavascriptTemplate(name: string, timestamp: number, upSqls: string[], downSqls: string[], esm: boolean): string;
+    /**
+     *
+     */
+    protected static prettifyQuery(query: string): string;
+}

package/dist/types/types/MigrationRunOptions.d.ts

@@ -0,0 +1,19 @@
+/**
+ * How {@link Database.runMigrations} and {@link Database.undoLastMigration} run the migrations: in transactions or not,
+ * for real or only recorded.
+ */
+export type MigrationRunOptions = {
+    /**
+     * The transactions wrapping the migrations: `'all'` runs them all in one transaction (one failure rolls them all
+     * back), `'each'` runs each one in its own transaction (the ones before a failure stay applied), `'none'` runs them
+     * without a transaction. A migration may override it with its own `transaction` property.
+     * @default The `migrationsTransactionMode` of the connection options for `runMigrations()`, else `'all'`
+     */
+    transaction?: 'all' | 'none' | 'each';
+    /**
+     * Record the migrations as run (or remove them as reverted) in the migrations table without running their `up()`
+     * (or `down()`): for a database whose schema is already up to date.
+     * @default false
+     */
+    fake?: boolean;
+};

package/package.json

@@ -1,6 +1,83 @@
 {
   "name": "@lakutata/orm",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "3.0.0-beta.0",
+  "description": "The ORM of the lakutata framework, on TypeORM: the Database component and provider, the entity decorators and the generation of the migrations.",
+  "type": "module",
+  "main": "./dist/cjs/exports/ORM.js",
+  "types": "./dist/cjs/exports/ORM.d.ts",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/types/exports/ORM.d.ts",
+        "default": "./dist/esm/exports/ORM.js"
+      },
+      "require": {
+        "types": "./dist/cjs/exports/ORM.d.ts",
+        "default": "./dist/cjs/exports/ORM.js"
+      }
+    },
+    "./decorator/orm": {
+      "import": {
+        "types": "./dist/types/exports/ORMDecorators.d.ts",
+        "default": "./dist/esm/exports/ORMDecorators.js"
+      },
+      "require": {
+        "types": "./dist/cjs/exports/ORMDecorators.d.ts",
+        "default": "./dist/cjs/exports/ORMDecorators.js"
+      }
+    },
+    "./com/database": {
+      "import": {
+        "types": "./dist/types/exports/DatabaseComponent.d.ts",
+        "default": "./dist/esm/exports/DatabaseComponent.js"
+      },
+      "require": {
+        "types": "./dist/cjs/exports/DatabaseComponent.d.ts",
+        "default": "./dist/cjs/exports/DatabaseComponent.js"
+      }
+    },
+    "./provider/database": {
+      "import": {
+        "types": "./dist/types/exports/DatabaseProvider.d.ts",
+        "default": "./dist/esm/exports/DatabaseProvider.js"
+      },
+      "require": {
+        "types": "./dist/cjs/exports/DatabaseProvider.d.ts",
+        "default": "./dist/cjs/exports/DatabaseProvider.js"
+      }
+    },
+    "./package.json": "./package.json"
+  },
+  "scripts": {
+    "clean": "node -e \"require('node:fs').rmSync('dist', {recursive: true, force: true})\"",
+    "build:cjs": "tsc -p tsconfig.cjs.json",
+    "build:esm": "tsc -p tsconfig.esm.json",
+    "build:cjs-pkg": "node ../../scripts/package-build/cjs-package.mjs",
+    "build:js": "npm run build:cjs && npm run build:esm && npm run build:cjs-pkg",
+    "rebuild": "npm run clean && npm run build:js",
+    "compile": "npm run rebuild",
+    "test:unit": "npm run compile && node --test \"dist/esm/tests/*.spec.js\"",
+    "test:integration": "npm run compile && node --test --test-concurrency=1 \"dist/esm/tests/integration/*.spec.js\""
+  },
+  "dependencies": {
+    "@sqltools/formatter": "^1.2.5",
+    "ansis": "4.2.0",
+    "reflect-metadata": "0.2.2",
+    "typeorm": "0.3.31"
+  },
+  "peerDependencies": {
+    "@lakutata/core": "3.0.0-beta.0",
+    "@lakutata/utils": "3.0.0-beta.0"
+  },
+  "engines": {
+    "node": ">=22"
+  },
+  "files": [
+    "dist",
+    "!dist/*/tests",
+    "*.md",
+    "LICENSE",
+    "package.json",
+    "THIRD_PARTY_NOTICES.md"
+  ]
+}