Refactor all internal structure by breaking the less amount of things

CHANGELOG.md

@@ -1,3 +1,8 @@
+# (upcoming) v0.15.0
+
+- `docs` path was changed for `apidocs`
+- **BC Break** all internal code structure has been changed.<br>This will **not** concern paths like `import {...} from '@orbitale/svelte-admin';`, as all library imports are still the same. However, you will have to update the loading of all the Typescript types from other files/directories.<br>The main reason for this change is to make sure the lib is better organized, but also the API docs are more readable just because of the code's structure.
+
 # v0.14.1
 
 - Fix DataTable types so they don't rely on Carbon types.
@@ -47,7 +52,7 @@
 
 # v0.9.0
 
-- **BC Break**: Definition options types have been renamed and merged in the `$lib/FieldDefinitions/definition.ts` file.
+- **BC Break**: Definition options types have been renamed and merged in the `$lib/Fields/index.ts` file.
 - Add `DateFilter` as a range of dates.
 - Add `BooleanFilter` with radio inputs.
 - Remove empty values from submitted filters.

README.md

@@ -3,7 +3,7 @@
 This package is an **admin generator** for your JS/TS/Svelte projects. It can consume a distant API, a localStorage, or even an RPC-based data storage (like when using [Tauri](https://tauri.app/)).
 
 | List                                                           | View                                                           | Edit                                                           |
-|----------------------------------------------------------------|----------------------------------------------------------------|----------------------------------------------------------------|
+| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
 | ![SvelteAdmin Backoffice List](./docs-src/backoffice_list.png) | ![SvelteAdmin Backoffice View](./docs-src/backoffice_view.png) | ![SvelteAdmin Backoffice Edit](./docs-src/backoffice_edit.png) |
 
 There is a [roadmap](#roadmap) at the end of this documentation to know what features are soon coming!

src/lib/actions.test.ts → src/lib/Actions.test.ts

@@ -1,9 +1,6 @@
-import { describe, it, expect, type TestOptions } from 'vitest';
-import { CallbackAction, UrlAction } from '$lib/actions';
-
-const testOpts: TestOptions = {
-	repeats: process.env.REPEAT ? parseInt(process.env.REPEAT) : undefined
-};
+import { describe, it, expect } from 'vitest';
+import { CallbackAction, UrlAction } from '$lib/Actions';
+import { testOptions } from '$lib/TestOptions';
 
 describe(
 	'URL actions',
@@ -39,7 +36,7 @@ describe(
 			expect(action.url(item, 'customId')).toBe('/test/val1?id=custom_identifier');
 		});
 	},
-	testOpts
+	testOptions
 );
 
 describe(
@@ -74,5 +71,5 @@ describe(
 			expect(baseItem.field).toBe('newValue');
 		});
 	},
-	testOpts
+	testOptions
 );

src/lib/actions.ts → src/lib/Actions.ts

@@ -1,6 +1,6 @@
 import type { ComponentType, SvelteComponent } from 'svelte';
-import type { KeyValueObject, Optional } from '$lib/genericTypes';
 import type { HTMLAnchorAttributes, HTMLButtonAttributes } from 'svelte/elements';
+import type { KeyValueObject, Optional } from '$lib/types';
 
 /** */
 export type ActionIcon = string | SvelteComponent | ComponentType;

src/lib/config/adminConfig.ts → src/lib/Config.ts

@@ -1,4 +1,4 @@
-import type { ThemeConfig } from '$lib/themes/ThemeConfig';
+import type { ThemeConfig } from '$lib/types';
 import carbon from '$lib/themes/carbon';
 
 /** */

src/lib/Crud/Operations.ts

@@ -3,12 +3,12 @@
  * @module
  */
 
-import type { FieldOptions, FieldInterface } from '$lib/FieldDefinitions/definition';
-import type { CrudDefinition } from '$lib/Crud/definition';
-import type { DashboardDefinition } from '$lib/Dashboard/definition';
-import type { Action } from '$lib/actions';
-import type { CrudTheme } from '$lib/themes/ThemeConfig';
-import { defaultPaginationOptions, type PaginationOptions } from '$lib/DataTable/Pagination';
+import type { FieldOptions, FieldInterface } from '$lib/Fields';
+import type { CrudDefinition } from '$lib/Crud/index';
+import type { DashboardDefinition } from '$lib/Dashboard';
+import type { Action } from '$lib/Actions';
+import type { CrudTheme } from '$lib/types';
+import { defaultPaginationOptions, type PaginationOptions } from '$lib/Pagination';
 import type { FilterInterface, FilterOptions } from '$lib/Filter';
 
 /** */
@@ -33,10 +33,12 @@ export interface CrudOperation {
 
 	/** */
 	get dashboard(): DashboardDefinition;
+
 	set dashboard(dashboard: DashboardDefinition);
 
 	/** */
 	get crud(): CrudDefinition<unknown>;
+
 	set crud(crud: CrudDefinition<unknown>);
 }
 

src/lib/Crud/definition.test.ts → src/lib/Crud/index.test.ts

@@ -1,9 +1,6 @@
-import { describe, it, expect, type TestOptions } from 'vitest';
+import { describe, it, expect } from 'vitest';
 import { CallbackStateProcessor, CallbackStateProvider, CrudDefinition, List } from '$lib';
-
-const testOpts: TestOptions = {
-	repeats: process.env.REPEAT ? parseInt(process.env.REPEAT) : undefined
-};
+import { testOptions } from '$lib/TestOptions';
 
 type Book = object;
 
@@ -83,5 +80,5 @@ describe(
 			);
 		});
 	},
-	testOpts
+	testOptions
 );

src/lib/Crud/definition.ts → src/lib/Crud/index.ts

@@ -1,7 +1,7 @@
 import type { CrudOperation } from '$lib/Crud/Operations';
-import type { StateProvider } from '$lib/State/Provider';
-import type { StateProcessor } from '$lib/State/Processor';
-import { type DashboardDefinition } from '$lib/Dashboard/definition';
+import type { StateProvider } from '$lib/StateProvider';
+import type { StateProcessor } from '$lib/StateProcessor';
+import { type DashboardDefinition } from '$lib/Dashboard';
 
 /** */
 export type CrudDefinitionOptionsArgument<EntityType> = {

src/lib/Dashboard/index.test.ts → src/lib/Dashboard.test.ts

@@ -1,15 +1,12 @@
-import { describe, it, expect, type TestOptions } from 'vitest';
+import { describe, it, expect } from 'vitest';
 import {
 	CallbackStateProcessor,
 	CallbackStateProvider,
 	CrudDefinition,
 	DashboardDefinition,
 	List
 } from '$lib';
-
-const testOpts: TestOptions = {
-	repeats: process.env.REPEAT ? parseInt(process.env.REPEAT) : undefined
-};
+import { testOptions } from '$lib/TestOptions';
 
 type Book = object;
 
@@ -33,5 +30,5 @@ describe(
 			expect(dashboard).toBeDefined();
 		});
 	},
-	testOpts
+	testOptions
 );

src/lib/Dashboard/definition.ts → src/lib/Dashboard.ts

@@ -1,17 +1,15 @@
 import { get, writable, type Writable } from 'svelte/store';
-
-import type { MenuLink } from '$lib/Menu/MenuLinks';
-import type { Dictionaries } from '$lib/admin_i18n';
-import type { CrudDefinition } from '$lib/Crud/definition';
-import { type AdminConfig, emptyAdminConfig } from '$lib/config/adminConfig';
+import type { MenuLink } from '$lib/Menu';
+import type { CrudDefinition } from '$lib/Crud';
+import type { Dictionaries } from '$lib/i18n';
+import { type AdminConfig, emptyAdminConfig } from '$lib/Config';
 
 /** */
 export type DashboardStores = {
 	sideMenu: Writable<Array<MenuLink>>;
 	topLeftMenu: Writable<Array<MenuLink>>;
 	topRightMenu: Writable<Array<MenuLink>>;
 };
-
 /**
  */
 export type DashboardDefinitionOptions = {

src/lib/DataTable/index.test.ts → src/lib/DataTable.test.ts

@@ -1,4 +1,4 @@
-import { describe, it, expect, type TestOptions } from 'vitest';
+import { describe, it, expect } from 'vitest';
 import {
 	List,
 	CheckboxField,
@@ -10,11 +10,8 @@ import {
 	ToggleField,
 	UrlField
 } from '$lib';
-import { Columns } from '$lib/FieldDefinitions/Columns';
-
-const testOpts: TestOptions = {
-	repeats: process.env.REPEAT ? parseInt(process.env.REPEAT) : undefined
-};
+import { Columns } from '$lib/Fields/Columns';
+import { testOptions } from '$lib/TestOptions';
 
 describe(
 	'DataTable',
@@ -53,5 +50,5 @@ describe(
 			expect(list).toBeDefined();
 		});
 	},
-	testOpts
+	testOptions
 );

src/lib/FieldDefinitions/Checkbox.ts → src/lib/Fields/Checkbox.ts

@@ -1,5 +1,6 @@
-import { type CommonFieldOptions, Field } from '$lib/FieldDefinitions/definition';
-import type { FormFieldTheme, ViewFieldTheme } from '$lib/themes/ThemeConfig';
+import { type CommonFieldOptions, Field } from '$lib/Fields';
+
+import type { FormFieldTheme, ViewFieldTheme } from '$lib/types';
 
 /** */
 export type CheckboxOptions = CommonFieldOptions;

src/lib/FieldDefinitions/Columns.ts → src/lib/Fields/Columns.ts

@@ -1,5 +1,6 @@
-import type { FieldInterface, FieldOptions } from '$lib/FieldDefinitions/definition';
-import type { FormFieldTheme, ViewFieldTheme } from '$lib/themes/ThemeConfig';
+import type { FieldInterface, FieldOptions } from '$lib/Fields';
+
+import type { FormFieldTheme, ViewFieldTheme } from '$lib/types';
 
 /** */
 export type ColumnOptions = FieldOptions & {

src/lib/FieldDefinitions/CrudEntity.ts → src/lib/Fields/CrudEntity.ts

@@ -1,6 +1,5 @@
-import { Field, type InputFieldOptions } from '$lib/FieldDefinitions/definition';
-import type { FormFieldTheme, ViewFieldTheme } from '$lib/themes/ThemeConfig';
-import type { KeyValueObject } from '$lib/genericTypes';
+import { Field, type InputFieldOptions } from '$lib/Fields';
+import type { FormFieldTheme, ViewFieldTheme, KeyValueObject } from '$lib/types';
 
 /** */
 export type CrudEntityOptions = InputFieldOptions & {

src/lib/FieldDefinitions/Date.ts → src/lib/Fields/Date.ts

@@ -1,5 +1,5 @@
-import { Field, type InputFieldOptions } from '$lib/FieldDefinitions/definition';
-import type { FormFieldTheme, ViewFieldTheme } from '$lib/themes/ThemeConfig';
+import { Field, type InputFieldOptions } from '$lib/Fields';
+import type { FormFieldTheme, ViewFieldTheme } from '$lib/types';
 
 /** */
 export type DateOptions = InputFieldOptions & {

src/lib/FieldDefinitions/KeyValueObject.ts → src/lib/Fields/KeyValueObject.ts

@@ -1,5 +1,5 @@
-import { Field, type InputFieldOptions } from '$lib/FieldDefinitions/definition';
-import type { FormFieldTheme, ViewFieldTheme } from '$lib/themes/ThemeConfig';
+import { Field, type InputFieldOptions } from '$lib/Fields';
+import type { FormFieldTheme, ViewFieldTheme } from '$lib/types';
 
 /** */
 export type ObjectOptions = InputFieldOptions & {

src/lib/FieldDefinitions/Number.ts → src/lib/Fields/Number.ts

@@ -1,5 +1,5 @@
-import { Field, type InputFieldOptions } from '$lib/FieldDefinitions/definition';
-import type { FormFieldTheme, ViewFieldTheme } from '$lib/themes/ThemeConfig';
+import { Field, type InputFieldOptions } from '$lib/Fields';
+import type { FormFieldTheme, ViewFieldTheme } from '$lib/types';
 
 /** */
 export type NumberOptions = InputFieldOptions & {

src/lib/FieldDefinitions/Tabs.ts → src/lib/Fields/Tabs.ts

@@ -1,5 +1,5 @@
-import type { FieldInterface, FieldOptions } from '$lib/FieldDefinitions/definition';
-import type { FormFieldTheme, ViewFieldTheme } from '$lib/themes/ThemeConfig';
+import type { FieldInterface, FieldOptions } from '$lib/Fields';
+import type { FormFieldTheme, ViewFieldTheme } from '$lib/types';
 
 /** */
 export type TabOptions = FieldOptions & {

src/lib/FieldDefinitions/Text.ts → src/lib/Fields/Text.ts

@@ -1,5 +1,5 @@
-import { Field, type InputFieldOptions } from '$lib/FieldDefinitions/definition';
-import type { FormFieldTheme, ViewFieldTheme } from '$lib/themes/ThemeConfig';
+import { Field, type InputFieldOptions } from '$lib/Fields';
+import type { FormFieldTheme, ViewFieldTheme } from '$lib/types';
 
 /** */
 export type TextOptions = InputFieldOptions & {

src/lib/FieldDefinitions/Textarea.ts → src/lib/Fields/Textarea.ts

@@ -1,6 +1,6 @@
-import { Field } from '$lib/FieldDefinitions/definition';
-import type { TextOptions } from '$lib/FieldDefinitions/Text';
-import type { FormFieldTheme, ViewFieldTheme } from '$lib/themes/ThemeConfig';
+import { Field } from '$lib/Fields';
+import type { TextOptions } from '$lib/Fields/Text';
+import type { FormFieldTheme, ViewFieldTheme } from '$lib/types';
 
 /** */
 export type TextareaOptions = TextOptions & {

src/lib/FieldDefinitions/Toggle.ts → src/lib/Fields/Toggle.ts

@@ -1,5 +1,5 @@
-import { type CommonFieldOptions, Field } from '$lib/FieldDefinitions/definition';
-import type { FormFieldTheme, ViewFieldTheme } from '$lib/themes/ThemeConfig';
+import { type CommonFieldOptions, Field } from '$lib/Fields';
+import type { FormFieldTheme, ViewFieldTheme } from '$lib/types';
 
 /** */
 export type ToggleOptions = CommonFieldOptions;

src/lib/FieldDefinitions/Url.ts → src/lib/Fields/Url.ts

@@ -1,5 +1,5 @@
-import { Field, type InputFieldOptions } from '$lib/FieldDefinitions/definition';
-import type { FormFieldTheme, ViewFieldTheme } from '$lib/themes/ThemeConfig';
+import { Field, type InputFieldOptions } from '$lib/Fields';
+import type { FormFieldTheme, ViewFieldTheme } from '$lib/types';
 
 /** */
 export type UrlOptions = InputFieldOptions & {

src/lib/FieldDefinitions/definition.ts → src/lib/Fields/index.ts

@@ -1,4 +1,4 @@
-import type { FormFieldTheme, ViewFieldTheme } from '$lib/themes/ThemeConfig';
+import type { FormFieldTheme, ViewFieldTheme } from '$lib/types';
 
 /** */
 export type FieldOptions = {

src/lib/Filter/index.ts → src/lib/Filter.ts

@@ -1,5 +1,4 @@
-import type { KeyValueObject } from '$lib/genericTypes';
-import type { FilterTheme } from '$lib/themes/ThemeConfig';
+import type { FilterTheme, KeyValueObject } from '$lib/types';
 
 /** */
 export type FilterOptions = KeyValueObject;

src/lib/Layout/Icon.svelte

@@ -1,5 +1,5 @@
 <script lang="ts">
-	import type { ActionIcon } from '$lib/actions';
+	import type { ActionIcon } from '$lib/Actions';
 	import { SvelteComponent } from 'svelte';
 
 	export let icon: ActionIcon;

src/lib/Menu/MenuLinks.ts → src/lib/Menu.ts

@@ -1,5 +1,5 @@
-import { type Action, type ActionIcon, type ActionOptions, DefaultAction } from '$lib/actions';
-import type { Optional } from '$lib/genericTypes';
+import { type Action, type ActionIcon, type ActionOptions, DefaultAction } from '$lib/Actions';
+import type { Optional } from '$lib/types';
 
 /** */
 export type MenuLink = Action;

src/lib/request.ts → src/lib/Request.ts

@@ -1,5 +1,5 @@
 import type { Page } from '@sveltejs/kit';
-import type { Optional } from '$lib/genericTypes';
+import type { Optional } from '$lib/types';
 
 /** */
 export type RequestParameters = {

src/lib/State/Processor.ts → src/lib/StateProcessor.ts

@@ -1,5 +1,5 @@
 import type { CrudOperation } from '$lib/Crud/Operations';
-import type { RequestParameters } from '$lib/request';
+import type { RequestParameters } from '$lib/Request';
 
 /** */
 export type StateProcessorInput<T> = T | Array<T> | null;

src/lib/State/Provider.ts → src/lib/StateProvider.ts

@@ -1,6 +1,6 @@
+import type { PaginatedResults } from '$lib/Pagination';
 import type { CrudOperation } from '$lib/Crud/Operations';
-import type { PaginatedResults } from '$lib/DataTable/Pagination';
-import type { RequestParameters } from '$lib/request';
+import type { RequestParameters } from '$lib/Request';
 
 /** */
 export type StateProviderResult<T> = Promise<T | PaginatedResults<T> | Array<T> | null>;

src/lib/TestOptions.ts

@@ -0,0 +1,5 @@
+import type { TestOptions } from 'vitest';
+
+export const testOptions: TestOptions = {
+	repeats: process.env.REPEAT ? parseInt(process.env.REPEAT) : undefined
+};

src/lib/admin_i18n.ts → src/lib/i18n.ts

@@ -1,6 +1,6 @@
 import { init, addMessages } from 'svelte-i18n';
 
-import type { KeyValueObject } from '$lib/genericTypes';
+import type { KeyValueObject } from '$lib/types';
 
 import en from '$lib/translations/en';
 import fr from '$lib/translations/fr';