@anzusystems/common-admin 0.0.5 → 0.0.7

package/dist/composables/filter/filterHelpers.d.ts

@@ -0,0 +1,20 @@
+import type { Filter, FilterBag, FilterVariant } from '../../types/Filter';
+import type { Pagination } from '../../types/Pagination';
+export interface MakeFilterOptions<T = any> {
+    name: string;
+    variant: FilterVariant;
+    titleT?: string;
+    default: T | null;
+    field: string;
+    multiple: boolean;
+    mandatory: boolean;
+    exclude: boolean;
+}
+export declare function makeFilterHelper<T = any>(system?: string, subject?: string): (options?: Partial<MakeFilterOptions<T>>) => Filter<T>;
+export declare function useFilterHelpers(): {
+    clearAllErrors: (filterBag: FilterBag) => void;
+    clearAll: (filterBag: FilterBag) => void;
+    clearOne: (filter: Filter) => void;
+    resetFilter: (filterBag: FilterBag, pagination: Pagination, callback?: any) => void;
+    submitFilter: (filterBag: FilterBag, pagination: Pagination, callback: () => any) => void;
+};

package/dist/composables/statusCodes.d.ts

@@ -0,0 +1,7 @@
+export declare const HTTP_STATUS_OK = 200;
+export declare const HTTP_STATUS_CREATED = 201;
+export declare const HTTP_STATUS_NO_CONTENT = 204;
+export declare const HTTP_STATUS_BAD_REQUEST = 400;
+export declare const HTTP_STATUS_UNAUTHORIZED = 401;
+export declare const HTTP_STATUS_UNPROCESSABLE_ENTITY = 422;
+export declare const HTTP_STATUS_VALID_ALL: number[];

package/dist/composables/system/alerts.d.ts

@@ -0,0 +1,17 @@
+import type { ApiErrors } from '../../composables/system/error';
+export declare const NEW_LINE_MARK = "\n";
+export type RecordWasType = 'created' | 'deleted' | 'updated' | 'published' | 'unpublished' | 'enabled' | 'disabled';
+export declare function useAlerts(): {
+    showSuccess: (message: string, duration?: number) => void;
+    showSuccessT: (translation: string, duration?: number) => void;
+    showError: (message: string, duration?: number) => void;
+    showErrorT: (translation: string, duration?: number) => void;
+    showInfo: (message: string, duration?: number) => void;
+    showInfoT: (translation: string, duration?: number) => void;
+    showWarning: (message: string, duration?: number) => void;
+    showWarningT: (translation: string, duration?: number) => void;
+    showValidationError: (duration?: number) => void;
+    showRecordWas: (variant: RecordWasType, duration?: number) => void;
+    showApiError: (errors: ApiErrors[], duration?: number, fieldIsTranslated?: boolean) => void;
+    showUnknownError: (duration?: number) => void;
+};

package/dist/composables/system/error.d.ts

@@ -0,0 +1,25 @@
+interface ValidationResponseDataFields {
+    [key: string]: string[];
+}
+export interface ValidationResponseData {
+    contextId: string;
+    error: string;
+    fields: ValidationResponseDataFields;
+}
+export interface ApiErrors {
+    field: string;
+    errors: string[];
+}
+interface Error {
+    response?: {
+        data?: {
+            error?: string;
+        };
+    };
+}
+export declare function useErrorHandler(): {
+    handleError: (error: unknown) => void;
+    handleValidationError: (error: Error, system?: string, entity?: string) => void;
+    isValidationError: (error: Error | any) => boolean;
+};
+export {};

package/dist/composables/system/pagination.d.ts

@@ -0,0 +1,14 @@
+import type { Pagination } from '../../types/Pagination';
+export declare function usePagination(): {
+    sortBy: string | null;
+    descending: boolean;
+    page: number;
+    rowsPerPage: number;
+    rowsNumber: number;
+    hasNextPage: boolean | null;
+    currentViewCount: number;
+    totalCount: number;
+};
+export declare function usePaginationAutoHide(pagination: Pagination): {
+    showPagination: import("vue").ComputedRef<boolean>;
+};

package/dist/composables/system/tableColumns.d.ts

@@ -0,0 +1,14 @@
+import type { Ref } from 'vue';
+export declare const DATETIME_AUTO_FORMAT_COLUMN_NAMES: string[];
+export declare const DATETIME_AUTO_LABEL_TRACKING: string[];
+export type ColumnConfig = {
+    name: string;
+    label?: string;
+    type?: 'default' | 'datetime';
+    getLabel?: (system: string | undefined, subject: string | undefined) => string | undefined;
+};
+export interface UseTableColumns {
+    availableColumns: Ref<ColumnConfig[]>;
+    get: (name: string) => ColumnConfig | undefined;
+}
+export declare function useTableColumns(config: ColumnConfig[]): UseTableColumns;

package/dist/create.d.ts

@@ -0,0 +1,11 @@
+import { type Ref } from 'vue';
+import { type I18n } from 'vue-i18n';
+interface Config {
+    i18nInstance: null | I18n;
+}
+export declare const commonAdminI18n: Ref<I18n<{}, {}, {}, string, boolean> | null>;
+export declare const useI18n: () => {
+    t: (key: string) => string;
+};
+export declare const createCommonAdmin: (config?: Config) => void;
+export {};

package/dist/lib.d.ts

@@ -1,18 +1,35 @@
 import ABooleanValue from './components/ABooleanValue.vue';
 import ARow from './components/ARow.vue';
-import PermissionGrantEditor from './components/permission/PermissionGrantEditor.vue';
-import PermissionValueChip from './components/permission/PermissionValueChip.vue';
+import ACard from './components/ACard.vue';
+import ATextField from './components/form/ATextField.vue';
+import ATextarea from './components/form/ATextarea.vue';
+import ABooleanToggle from './components/form/ABooleanToggle.vue';
+import ASystemEntityScope from './components/form/ASystemEntityScope.vue';
+import ADatatable from './components/ADatatable.vue';
+import ADatatablePagination from './components/ADatatablePagination.vue';
+import AFilterString from './components/filter/AFilterString.vue';
+import AFilterWrapper from './components/filter/AFilterWrapper.vue';
+import APermissionGrantEditor from './components/permission/APermissionGrantEditor.vue';
+import APermissionValueChip from './components/permission/APermissionValueChip.vue';
+import ADatetime from './components/ADatetime.vue';
+import ADatetimePicker from './components/ADatetimePicker.vue';
+import ARemoteAutocomplete from './components/form/ARemoteAutocomplete.vue';
+import AValueObjectOptionsSelect from './components/form/AValueObjectOptionsSelect.vue';
+import AFilterValueObjectOptionsSelect from './components/filter/AFilterValueObjectOptionsSelect.vue';
+import AFilterRemoteAutocomplete from './components/filter/AFilterRemoteAutocomplete.vue';
+import AFilterBooleanGroup from './components/filter/AFilterBooleanGroup.vue';
+import JobStatusChip from './components/job/JobStatusChip.vue';
 import { commonMessages } from './locales';
-import { setValueByPath, deletePropertyByPath, deepFreeze, simpleCloneObject, getValueByPath } from './utils/object';
-import { isEmpty, isEmptyObject, isObject, isEmptyArray, isArray, isBoolean, isDocId, isNull, isNotUndefined, isUndefined, isInt, isString, isNumber } from './utils/common';
-import { toInt, slugify, toFloat, splitOnFirstOccurrence, trimLength } from './utils/string';
-import { currentTimestamp, DATETIME_MAX, DATETIME_MIN, dateTimeEndOfDay, dateTimeStartOfDay, dateTimeNow, friendlyDateTime, newDateNow, prettyDateTime, dateToUtc, modifyMinutesOfDate, yearNow } from './utils/datetime';
+import { deepFreeze, deletePropertyByPath, getValueByPath, setValueByPath, simpleCloneObject } from './utils/object';
+import { isArray, isBoolean, isDocId, isEmpty, isEmptyArray, isEmptyObject, isInt, isNotUndefined, isNull, isNumber, isObject, isString, isUndefined } from './utils/common';
+import { normalizeForSlotName, slugify, splitOnFirstOccurrence, toFloat, toInt, toKebabCase, trimLength } from './utils/string';
+import { currentTimestamp, DATETIME_MAX, DATETIME_MIN, dateTimeEndOfDay, dateTimeNow, dateTimeStartOfDay, dateToUtc, friendlyDateTime, modifyMinutesOfDate, newDateNow, prettyDateTime, yearNow } from './utils/datetime';
 import { Grant, useGrant } from './model/valueObject/Grant';
 import { GrantOrigin, useGrantOrigin } from './model/valueObject/GrantOrigin';
 import { useAnzuUserFactory } from './model/factory/AnzuUserFactory';
 import { usePermissionConfigFactory } from './model/factory/PermissionConfigFactory';
 import { usePermissionGroupFactory } from './model/factory/PermissionGroupFactory';
-import type { IntegerId, DatetimeUTC, DatetimeUTCNullable, DocId, DocIdNullable, IntegerIdNullable } from './types/common';
+import type { DatetimeUTC, DatetimeUTCNullable, DocId, DocIdNullable, IntegerId, IntegerIdNullable } from './types/common';
 import type { Filter, FilterBag, FilterVariant } from './types/Filter';
 import type { Pagination } from './types/Pagination';
 import type { OwnerAware } from './types/OwnerAware';
@@ -23,11 +40,59 @@ import type { PermissionConfig, PermissionTranslationGroup } from './types/Permi
 import { type AnzuUserAndTimeTrackingAware } from './types/AnzuUserAndTimeTrackingAware';
 import type { PermissionGroup, PermissionGroupMinimal } from './types/PermissionGroup';
 import { type CreatedByAware, isCreatedByAware } from './types/CreatedByAware';
+import type { VuetifyIconValue } from './types/Vuetify';
+import { usePagination, usePaginationAutoHide } from './composables/system/pagination';
+import { makeFilterHelper, type MakeFilterOptions, useFilterHelpers } from './composables/filter/filterHelpers';
+import { SubjectScopeSymbol, SystemScopeSymbol } from './components/injectionKeys';
+import { prettyBytes } from './utils/file';
+import { isValidHTTPStatus } from './utils/response';
+import { HTTP_STATUS_BAD_REQUEST, HTTP_STATUS_CREATED, HTTP_STATUS_NO_CONTENT, HTTP_STATUS_OK, HTTP_STATUS_UNAUTHORIZED, HTTP_STATUS_UNPROCESSABLE_ENTITY } from './composables/statusCodes';
+import { AnzuApiResponseCodeError } from './model/error/AnzuApiResponseCodeError';
+import { AnzuApiValidationError } from './model/error/AnzuApiValidationError';
+import { AnzuFatalError } from './model/error/AnzuFatalError';
+import { apiAnyRequest } from './services/api/apiAnyRequest';
+import { apiCreateOne } from './services/api/apiCreateOne';
+import { apiDeleteOne } from './services/api/apiDeleteOne';
+import { apiFetchByIds } from './services/api/apiFetchByIds';
+import { apiFetchList } from './services/api/apiFetchList';
+import { apiFetchOne } from './services/api/apiFetchOne';
+import { apiUpdateOne } from './services/api/apiUpdateOne';
+import { useQueryBuilder } from './services/api/queryBuilder';
+import { useAlerts } from './composables/system/alerts';
+import { useErrorHandler } from './composables/system/error';
+import { useTableColumns } from './composables/system/tableColumns';
+import { createCommonAdmin } from './create';
+import { JobStatus, useJobStatus } from './model/valueObject/JobStatus';
+import type { Job } from './types/Job';
+import { useJobApi } from './services/api/job/jobApi';
+import { type JobResource, useJobResource } from './model/valueObject/JobResource';
 export { //           |        |       |           |       |
+ACard, //           |        |       |           |       |
 ARow, //           |        |       |           |       |
 ABooleanValue, //           |        |       |           |       |
-PermissionGrantEditor, //           |        |       |           |       |
-PermissionValueChip, //           |        |       |           |       |
+APermissionGrantEditor, //           |        |       |           |       |
+APermissionValueChip, //           |        |       |           |       |
+ASystemEntityScope, //           |        |       |           |       |
+ATextField, //           |        |       |           |       |
+ATextarea, //           |        |       |           |       |
+ADatetimePicker, //           |        |       |           |       |
+ARemoteAutocomplete, //           |        |       |           |       |
+AValueObjectOptionsSelect, //           |        |       |           |       |
+ABooleanToggle, //           |        |       |           |       |
+AFilterWrapper, //           |        |       |           |       |
+AFilterString, //           |        |       |           |       |
+AFilterRemoteAutocomplete, //           |        |       |           |       |
+AFilterValueObjectOptionsSelect, //           |        |       |           |       |
+AFilterBooleanGroup, //           |        |       |           |       |
+ADatetime, //           |        |       |           |       |
+ADatatable, //           |        |       |           |       |
+ADatatablePagination, //           |        |       |           |       |
+JobStatusChip, //           |        |       |           |       |
+usePagination, usePaginationAutoHide, //           |        |       |           |       |
+makeFilterHelper, useFilterHelpers, //           |        |       |           |       |
+useAlerts, //           |        |       |           |       |
+useErrorHandler, //           |        |       |           |       |
+useTableColumns, //           |        |       |           |       |
 Grant, useGrant, //           |        |       |           |       |
 GrantOrigin, useGrantOrigin, //           |        |       |           |       |
 IntegerId, //           |        |       |           |       |
@@ -51,6 +116,11 @@ PermissionConfig, //           |        |       |           |       |
 PermissionTranslationGroup, //           |        |       |           |       |
 PermissionGroup, //           |        |       |           |       |
 PermissionGroupMinimal, //           |        |       |           |       |
+VuetifyIconValue, //           |        |       |           |       |
+MakeFilterOptions, //           |        |       |           |       |
+Job, //           |        |       |           |       |
+JobStatus, //           |        |       |           |       |
+JobResource, //           |        |       |           |       |
 useAnzuUserFactory, //           |        |       |           |       |
 usePermissionConfigFactory, //           |        |       |           |       |
 usePermissionGroupFactory, //           |        |       |           |       |
@@ -77,6 +147,8 @@ slugify, //           |        |       |           |       |
 toFloat, //           |        |       |           |       |
 splitOnFirstOccurrence, //           |        |       |           |       |
 trimLength, //           |        |       |           |       |
+normalizeForSlotName, //           |        |       |           |       |
+toKebabCase, //           |        |       |           |       |
 currentTimestamp, //           |        |       |           |       |
 DATETIME_MAX, //           |        |       |           |       |
 DATETIME_MIN, //           |        |       |           |       |
@@ -89,4 +161,28 @@ prettyDateTime, //           |        |       |           |       |
 dateToUtc, //           |        |       |           |       |
 modifyMinutesOfDate, //           |        |       |           |       |
 yearNow, //           |        |       |           |       |
-commonMessages };
+prettyBytes, //           |        |       |           |       |
+isValidHTTPStatus, //           |        |       |           |       |
+apiAnyRequest, //           |        |       |           |       |
+apiCreateOne, //           |        |       |           |       |
+apiDeleteOne, //           |        |       |           |       |
+apiFetchByIds, //           |        |       |           |       |
+apiFetchList, //           |        |       |           |       |
+apiFetchOne, //           |        |       |           |       |
+apiUpdateOne, //           |        |       |           |       |
+useQueryBuilder, //           |        |       |           |       |
+useJobApi, //           |        |       |           |       |
+useJobResource, //           |        |       |           |       |
+useJobStatus, //           |        |       |           |       |
+commonMessages, //           |        |       |           |       |
+SystemScopeSymbol, SubjectScopeSymbol, //           |        |       |           |       |
+HTTP_STATUS_OK, //           |        |       |           |       |
+HTTP_STATUS_CREATED, //           |        |       |           |       |
+HTTP_STATUS_NO_CONTENT, //           |        |       |           |       |
+HTTP_STATUS_BAD_REQUEST, //           |        |       |           |       |
+HTTP_STATUS_UNAUTHORIZED, //           |        |       |           |       |
+HTTP_STATUS_UNPROCESSABLE_ENTITY, //           |        |       |           |       |
+AnzuApiResponseCodeError, //           |        |       |           |       |
+AnzuApiValidationError, //           |        |       |           |       |
+AnzuFatalError, //           |        |       |           |       |
+createCommonAdmin, };

package/dist/model/error/AnzuApiResponseCodeError.d.ts

@@ -0,0 +1,4 @@
+export declare class AnzuApiResponseCodeError extends Error {
+    private date;
+    constructor();
+}

package/dist/model/error/AnzuApiValidationError.d.ts

@@ -0,0 +1,4 @@
+export declare class AnzuApiValidationError extends Error {
+    private date;
+    constructor();
+}

package/dist/model/error/AnzuFatalError.d.ts

@@ -0,0 +1,4 @@
+export declare class AnzuFatalError extends Error {
+    private date;
+    constructor(message?: string);
+}

package/dist/model/valueObject/JobResource.d.ts

@@ -0,0 +1,11 @@
+import type { ValueObjectOption } from '../../types/ValueObject';
+export type JobResource = 'jobUserDataDelete' | `job${string}`;
+export declare function useJobResource<T extends JobResource = JobResource>(customJobs?: ValueObjectOption<T>[]): {
+    jobResourceOptions: import("vue").Ref<{
+        value: import("vue").UnwrapRef<T>;
+        title: string;
+        color?: string | undefined;
+        active?: false | undefined;
+    }[]>;
+    getJobResourceOption: (value: T) => ValueObjectOption<T>;
+};

package/dist/model/valueObject/JobStatus.d.ts

@@ -0,0 +1,18 @@
+import type { ValueObjectOption } from '../../types/ValueObject';
+export declare enum JobStatus {
+    Waiting = "waiting",
+    Processing = "processing",
+    AwaitingBatchProcess = "awaiting_batch_process",
+    Done = "done",
+    Error = "error",
+    Default = "waiting"
+}
+export declare function useJobStatus(): {
+    jobStatusOptions: import("vue").Ref<{
+        value: JobStatus;
+        title: string;
+        color?: string | undefined;
+        active?: false | undefined;
+    }[]>;
+    getJobStatusOption: (value: JobStatus) => ValueObjectOption<JobStatus>;
+};

package/dist/services/api/apiAnyRequest.d.ts

@@ -0,0 +1,7 @@
+import { type UrlParams } from '../../services/api/apiHelper';
+import type { AxiosInstance, AxiosRequestConfig, Method } from 'axios';
+/**
+ * @template T Type used for request payload, by default same as Response type
+ * @template R Response type override, optional
+ */
+export declare const apiAnyRequest: <T, R = T>(client: () => AxiosInstance, method: Method, urlTemplate: string | undefined, urlParams: UrlParams | undefined, object: T | null | undefined, system: string, entity: string, options?: AxiosRequestConfig) => Promise<R>;

package/dist/services/api/apiCreateOne.d.ts

@@ -0,0 +1,7 @@
+import { type UrlParams } from '../../services/api/apiHelper';
+import type { AxiosInstance, AxiosRequestConfig } from 'axios';
+/**
+ * @template T Type used for request payload, by default same as Response type
+ * @template R Response type override, optional
+ */
+export declare const apiCreateOne: <T, R = T>(client: () => AxiosInstance, object: T | Record<string, never> | undefined, urlTemplate: string, urlParams: UrlParams | undefined, system: string, entity: string, options?: AxiosRequestConfig) => Promise<R>;

package/dist/services/api/apiDeleteOne.d.ts

@@ -0,0 +1,7 @@
+import { type UrlParams } from '../../services/api/apiHelper';
+import type { AxiosInstance, AxiosRequestConfig } from 'axios';
+/**
+ * @template T Type used for request payload, by default same as Response type
+ * @template R Response type override, optional
+ */
+export declare const apiDeleteOne: <T, R = T>(client: () => AxiosInstance, urlTemplate: string, urlParams: UrlParams | undefined, system: string, entity: string, options?: AxiosRequestConfig) => Promise<R>;

package/dist/services/api/apiFetchByIds.d.ts

@@ -0,0 +1,3 @@
+import { type UrlParams } from '../../services/api/apiHelper';
+import type { AxiosInstance, AxiosRequestConfig } from 'axios';
+export declare const apiFetchByIds: <T, R = T>(client: () => AxiosInstance, ids: string[] | number[], urlTemplate: string, urlParams: UrlParams | undefined, system: string, entity: string, options?: AxiosRequestConfig, isSearchApi?: boolean) => Promise<R>;

package/dist/services/api/apiFetchList.d.ts

@@ -0,0 +1,9 @@
+import { type UrlParams } from '../../services/api/apiHelper';
+import type { FilterBag } from '../../types/Filter';
+import type { Pagination } from '../../types/Pagination';
+import type { AxiosInstance, AxiosRequestConfig } from 'axios';
+/**
+ * @template T Type used for request payload, by default same as Response type
+ * @template R Response type override, optional
+ */
+export declare const apiFetchList: <T, R = T>(client: () => AxiosInstance, urlTemplate: string, urlParams: UrlParams | undefined, pagination: Pagination, filterBag: FilterBag, system: string, entity: string, options?: AxiosRequestConfig) => Promise<R>;

package/dist/services/api/apiFetchOne.d.ts

@@ -0,0 +1,6 @@
+import { type UrlParams } from '../../services/api/apiHelper';
+import type { AxiosInstance, AxiosRequestConfig } from 'axios';
+/**
+ * @template R Response type
+ */
+export declare const apiFetchOne: <R>(client: () => AxiosInstance, urlTemplate: string, urlParams: UrlParams | undefined, system: string, entity: string, options?: AxiosRequestConfig) => Promise<R>;

package/dist/services/api/apiHelper.d.ts

@@ -0,0 +1,4 @@
+export type UrlParams = {
+    [key: string]: number | string;
+};
+export declare const replaceUrlParameters: (urlTemplate: string, urlParams: UrlParams, overrideUrlTemplate?: string) => string;

package/dist/services/api/apiUpdateOne.d.ts

@@ -0,0 +1,7 @@
+import { type UrlParams } from '../../services/api/apiHelper';
+import type { AxiosInstance, AxiosRequestConfig } from 'axios';
+/**
+ * @template T Type used for request payload, by default same as Response type
+ * @template R Response type override, optional
+ */
+export declare const apiUpdateOne: <T, R = T>(client: () => AxiosInstance, object: Record<string, never> | T | undefined, urlTemplate: string, urlParams: UrlParams | undefined, system: string, entity: string, options?: AxiosRequestConfig) => Promise<R>;

package/dist/services/api/job/jobApi.d.ts

@@ -0,0 +1,11 @@
+import { AxiosInstance } from 'axios';
+import { Pagination } from '../../../types/Pagination';
+import { FilterBag } from '../../../types/Filter';
+import { Job } from '../../../types/Job';
+export declare const ENTITY = "job";
+export declare function useJobApi<JobType extends Job = Job>(client: () => AxiosInstance, system: string): {
+    fetchJobList: (pagination: Pagination, filterBag: FilterBag) => Promise<JobType[]>;
+    fetchJob: (id: number) => Promise<JobType>;
+    createJob: (data: JobType) => Promise<JobType>;
+    deleteJob: (id: number) => Promise<JobType>;
+};

package/dist/services/api/queryBuilder.d.ts

@@ -0,0 +1,13 @@
+import type { FilterBag, FilterVariant } from '../../types/Filter';
+/**
+ * Docs: /doc/Admin-Cms-Doc/Filters.md
+ */
+export declare function useQueryBuilder(): {
+    querySetLimit: (value: number) => void;
+    querySetOffset: (page: number, limit: number) => void;
+    querySetOrder: (field: string | null, desc: boolean) => void;
+    queryAddFilter: (filterVariant: FilterVariant, field: string, value: string | number | boolean) => void;
+    querySetFilters: (filterBag: FilterBag) => void;
+    queryAdd: (key: string, value: any) => void;
+    queryBuild: () => string;
+};