@famgia/omnify-laravel 0.0.91 → 0.0.93

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.
package/dist/plugin.d.cts CHANGED
@@ -5,7 +5,17 @@ import { OmnifyPlugin } from '@famgia/omnify-types';
5
5
  *
6
6
  * Plugin for generating Laravel migration files and Eloquent models from Omnify schemas.
7
7
  *
8
- * @example
8
+ * @example Basic usage (Laravel at project root)
9
+ * ```typescript
10
+ * import { defineConfig } from '@famgia/omnify';
11
+ * import laravel from '@famgia/omnify-laravel/plugin';
12
+ *
13
+ * export default defineConfig({
14
+ * plugins: [laravel()], // Uses all defaults
15
+ * });
16
+ * ```
17
+ *
18
+ * @example Monorepo (Laravel in ./backend/)
9
19
  * ```typescript
10
20
  * import { defineConfig } from '@famgia/omnify';
11
21
  * import laravel from '@famgia/omnify-laravel/plugin';
@@ -13,9 +23,9 @@ import { OmnifyPlugin } from '@famgia/omnify-types';
13
23
  * export default defineConfig({
14
24
  * plugins: [
15
25
  * laravel({
16
- * migrationsPath: 'database/migrations',
17
- * modelsPath: 'app/Models',
18
- * connection: 'mysql',
26
+ * base: './backend/', // All paths relative to this
27
+ * generateRequests: true,
28
+ * generateResources: true,
19
29
  * }),
20
30
  * ],
21
31
  * });
@@ -27,22 +37,30 @@ import { OmnifyPlugin } from '@famgia/omnify-types';
27
37
  */
28
38
  interface LaravelPluginOptions {
29
39
  /**
30
- * Path for Laravel migration files.
40
+ * Base directory for Laravel project (relative to project root).
41
+ * All other paths will be relative to this base.
42
+ *
43
+ * @default '' (project root)
44
+ * @example './backend/' for monorepo with Laravel in backend folder
45
+ */
46
+ base?: string;
47
+ /**
48
+ * Path for Laravel migration files (relative to base).
31
49
  * @default 'database/migrations/omnify'
32
50
  */
33
51
  migrationsPath?: string;
34
52
  /**
35
- * Path for user-editable model files.
53
+ * Path for user-editable model files (relative to base).
36
54
  * @default 'app/Models'
37
55
  */
38
56
  modelsPath?: string;
39
57
  /**
40
- * Path for auto-generated base model files.
58
+ * Path for auto-generated base model files (relative to base).
41
59
  * @default 'app/Models/OmnifyBase'
42
60
  */
43
61
  baseModelsPath?: string;
44
62
  /**
45
- * Path for Laravel service provider files.
63
+ * Path for Laravel service provider files (relative to base).
46
64
  * @default 'app/Providers'
47
65
  */
48
66
  providersPath?: string;
package/dist/plugin.d.ts CHANGED
@@ -5,7 +5,17 @@ import { OmnifyPlugin } from '@famgia/omnify-types';
5
5
  *
6
6
  * Plugin for generating Laravel migration files and Eloquent models from Omnify schemas.
7
7
  *
8
- * @example
8
+ * @example Basic usage (Laravel at project root)
9
+ * ```typescript
10
+ * import { defineConfig } from '@famgia/omnify';
11
+ * import laravel from '@famgia/omnify-laravel/plugin';
12
+ *
13
+ * export default defineConfig({
14
+ * plugins: [laravel()], // Uses all defaults
15
+ * });
16
+ * ```
17
+ *
18
+ * @example Monorepo (Laravel in ./backend/)
9
19
  * ```typescript
10
20
  * import { defineConfig } from '@famgia/omnify';
11
21
  * import laravel from '@famgia/omnify-laravel/plugin';
@@ -13,9 +23,9 @@ import { OmnifyPlugin } from '@famgia/omnify-types';
13
23
  * export default defineConfig({
14
24
  * plugins: [
15
25
  * laravel({
16
- * migrationsPath: 'database/migrations',
17
- * modelsPath: 'app/Models',
18
- * connection: 'mysql',
26
+ * base: './backend/', // All paths relative to this
27
+ * generateRequests: true,
28
+ * generateResources: true,
19
29
  * }),
20
30
  * ],
21
31
  * });
@@ -27,22 +37,30 @@ import { OmnifyPlugin } from '@famgia/omnify-types';
27
37
  */
28
38
  interface LaravelPluginOptions {
29
39
  /**
30
- * Path for Laravel migration files.
40
+ * Base directory for Laravel project (relative to project root).
41
+ * All other paths will be relative to this base.
42
+ *
43
+ * @default '' (project root)
44
+ * @example './backend/' for monorepo with Laravel in backend folder
45
+ */
46
+ base?: string;
47
+ /**
48
+ * Path for Laravel migration files (relative to base).
31
49
  * @default 'database/migrations/omnify'
32
50
  */
33
51
  migrationsPath?: string;
34
52
  /**
35
- * Path for user-editable model files.
53
+ * Path for user-editable model files (relative to base).
36
54
  * @default 'app/Models'
37
55
  */
38
56
  modelsPath?: string;
39
57
  /**
40
- * Path for auto-generated base model files.
58
+ * Path for auto-generated base model files (relative to base).
41
59
  * @default 'app/Models/OmnifyBase'
42
60
  */
43
61
  baseModelsPath?: string;
44
62
  /**
45
- * Path for Laravel service provider files.
63
+ * Path for Laravel service provider files (relative to base).
46
64
  * @default 'app/Providers'
47
65
  */
48
66
  providersPath?: string;
package/dist/plugin.js CHANGED
@@ -1,6 +1,6 @@
1
1
  import {
2
2
  laravelPlugin
3
- } from "./chunk-EVW3645L.js";
3
+ } from "./chunk-U2QZI3HY.js";
4
4
  export {
5
5
  laravelPlugin as default,
6
6
  laravelPlugin
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@famgia/omnify-laravel",
3
- "version": "0.0.91",
3
+ "version": "0.0.93",
4
4
  "description": "Laravel migration and TypeScript type generator for omnify-schema",
5
5
  "type": "module",
6
6
  "main": "./dist/index.js",
@@ -25,9 +25,9 @@
25
25
  "README.md"
26
26
  ],
27
27
  "dependencies": {
28
- "@famgia/omnify-core": "0.0.82",
29
- "@famgia/omnify-types": "0.0.80",
30
- "@famgia/omnify-atlas": "0.0.76"
28
+ "@famgia/omnify-types": "0.0.82",
29
+ "@famgia/omnify-core": "0.0.84",
30
+ "@famgia/omnify-atlas": "0.0.78"
31
31
  },
32
32
  "scripts": {
33
33
  "build": "tsup",