pangea-lib 4.0.511 → 4.0.513

package/dist/types/i18n/messages/index.d.ts

@@ -31,7 +31,7 @@ declare const _default: {
             danger: string;
         };
     };
-    apiConnectionsError: {
+    apiError: {
         es: {
             INTERNAL_SERVER_ERROR: string;
             DUPLICATE_KEY: string;
@@ -44,7 +44,7 @@ declare const _default: {
             UNAUTHORIZED: string;
         };
     };
-    apiConnectionsSuccess: {
+    apiSuccess: {
         es: {
             _LOGIN: string;
         };

package/dist/types/main.d.ts

@@ -13,7 +13,7 @@ export default install;
 export { App };
 export * from './alert-danger';
 export * from './alert-info';
-export * from './api-connections';
+export * from './api';
 export * from './composables';
 export * from './helpers';
 export * from './i18n';

package/dist/types/types/api.types.d.ts

@@ -0,0 +1,39 @@
+import { Ref } from 'vue';
+import { AxiosError, AxiosBasicCredentials } from 'axios';
+import { BaseModel } from '../models/base-model.model';
+import { BaseParams } from '../models/base-params.models';
+import { BaseResponse } from '../models/base-response.models';
+import { ExtractConstructor } from 'pangea-helpers';
+import { ClassWithConstructor } from '.';
+
+export type HttpMethod = 'get' | 'post' | 'put' | 'patch' | 'delete';
+export type ApiMethod = 'getOne' | 'getMany' | 'postOne' | 'postMany' | 'putOne' | 'putMany' | 'deleteOne' | 'deleteMany';
+export type CallConfig<SuccessRes, TCount = undefined> = {
+    success?: (data: SuccessRes, totalCount?: TCount) => void;
+    error?: (err: AxiosError) => void;
+    noDisplayError?: boolean;
+    noThrowError?: boolean;
+    isLoading?: Ref<boolean>;
+    basicAuth?: AxiosBasicCredentials;
+};
+export type Headers = Record<string, string>;
+export type GetCustomHeaders = () => Headers;
+export type ApiConfig = {
+    getCustomHeaders?: GetCustomHeaders;
+};
+export type EndpointParams = typeof BaseParams;
+export type EndpointResponse = typeof BaseModel | typeof BaseResponse | ClassWithConstructor | undefined;
+export type EndpointMeta = {
+    sendAsFormData?: boolean;
+};
+export type Endpoint = {
+    params?: EndpointParams;
+    response: EndpointResponse;
+    meta?: EndpointMeta;
+};
+export type Endpoints = Record<string, Partial<Record<ApiMethod, Endpoint>>>;
+export type EndpointName<AE extends Endpoints, CM extends ApiMethod> = {
+    [K in keyof AE]: CM extends keyof AE[K] ? K : never;
+}[keyof AE];
+export type ParamsOf<AE extends Endpoints, EN extends EndpointName<AE, CM>, CM extends ApiMethod> = EN extends keyof AE ? CM extends keyof AE[EN] ? 'params' extends keyof AE[EN][CM] ? InstanceType<ExtractConstructor<AE[EN][CM]['params']>> : never : never : any;
+export type ResponseOf<AE extends Endpoints, EN extends EndpointName<AE, CM>, CM extends ApiMethod> = EN extends keyof AE ? CM extends keyof AE[EN] ? 'response' extends keyof AE[EN][CM] ? InstanceType<ExtractConstructor<AE[EN][CM]['response']>> : never : never : any;

package/dist/types/types/app-config.types.d.ts

@@ -25,7 +25,7 @@ export type AppConfig = {
         useAuthStore: AuthStoreDefinition;
     };
     i18n: {
-        apiConnectionsError: I18nFn;
-        apiConnectionsSuccess: I18nFn;
+        apiError: I18nFn;
+        apiSuccess: I18nFn;
     } & Record<string, I18nFn>;
 };

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

@@ -1,4 +1,4 @@
-export * from './api-connections.types';
+export * from './api.types';
 export * from './app-config.types';
 export * from './app-options.types';
 export * from './auth-store.types';

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "pangea-lib",
   "description": "",
-  "version": "4.0.511",
+  "version": "4.0.513",
   "author": "Gianfranco Raselli",
   "license": "ISC",
   "homepage": "https://github.com/GianfrancoRaselli/pangea-lib#readme",

package/dist/types/api-connections/create-api-connections.d.ts

@@ -1,38 +0,0 @@
-import { Arrayify } from 'pangea-helpers';
-import { Id } from '../types';
-import { ApiConfig, ApiEndpoints, ApiEndpointName, ApiEndpointParams, ApiEndpointResponse, ApiConnectionsConfig } from '../types/api-connections.types';
-
-export declare function createApiConnections<AE extends ApiEndpoints>(endpoints: AE, appVersion: string, apiConnectionsConfig?: ApiConnectionsConfig): {
-    getOne<T extends ApiEndpointName<AE, "getOne">>(url: T, id?: Id, params?: ApiEndpointParams<AE, T, "getOne">, apiConfig?: ApiConfig<ApiEndpointResponse<AE, T, "getOne">>): Promise<{
-        data: ApiEndpointResponse<AE, T, "getOne">;
-        totalCount: undefined;
-    }>;
-    getMany<T_1 extends ApiEndpointName<AE, "getMany">>(url: T_1, params?: ApiEndpointParams<AE, T_1, "getMany">, apiConfig?: ApiConfig<Arrayify<ApiEndpointResponse<AE, T_1, "getMany">>, number>): Promise<{
-        data: Arrayify<ApiEndpointResponse<AE, T_1, "getMany">>;
-        totalCount: number;
-    }>;
-    postOne<T_2 extends ApiEndpointName<AE, "postOne">>(url: T_2, params?: ApiEndpointParams<AE, T_2, "postOne">, apiConfig?: ApiConfig<ApiEndpointResponse<AE, T_2, "postOne">>): Promise<{
-        data: ApiEndpointResponse<AE, T_2, "postOne">;
-        totalCount: undefined;
-    }>;
-    postMany<T_3 extends ApiEndpointName<AE, "postMany">>(url: T_3, params: ApiEndpointParams<AE, T_3, "postMany">[], apiConfig?: ApiConfig<ApiEndpointResponse<AE, T_3, "postMany">>): Promise<{
-        data: ApiEndpointResponse<AE, T_3, "postMany">;
-        totalCount: undefined;
-    }>;
-    putOne<T_4 extends ApiEndpointName<AE, "putOne">>(url: T_4, id?: Id, params?: ApiEndpointParams<AE, T_4, "putOne">, apiConfig?: ApiConfig<ApiEndpointResponse<AE, T_4, "putOne">>): Promise<{
-        data: ApiEndpointResponse<AE, T_4, "putOne">;
-        totalCount: undefined;
-    }>;
-    putMany<T_5 extends ApiEndpointName<AE, "putMany">>(url: T_5, params: ApiEndpointParams<AE, T_5, "putMany">[], apiConfig?: ApiConfig<ApiEndpointResponse<AE, T_5, "putMany">>): Promise<{
-        data: ApiEndpointResponse<AE, T_5, "putMany">;
-        totalCount: undefined;
-    }>;
-    deleteOne<T_6 extends ApiEndpointName<AE, "deleteOne">>(url: T_6, id?: Id, apiConfig?: ApiConfig<ApiEndpointResponse<AE, T_6, "deleteOne">>): Promise<{
-        data: ApiEndpointResponse<AE, T_6, "deleteOne">;
-        totalCount: undefined;
-    }>;
-    deleteMany<T_7 extends ApiEndpointName<AE, "deleteMany">>(url: T_7, ids: Id[], apiConfig?: ApiConfig<ApiEndpointResponse<AE, T_7, "deleteMany">>): Promise<{
-        data: ApiEndpointResponse<AE, T_7, "deleteMany">;
-        totalCount: undefined;
-    }>;
-};

package/dist/types/api-connections/index.d.ts

@@ -1 +0,0 @@
-export { createApiConnections } from './create-api-connections';

package/dist/types/api-connections/methods/call-axios.d.ts

@@ -1,4 +0,0 @@
-import { default as axios, AxiosRequestConfig } from 'axios';
-import { ApiMethod } from '../../types/api-connections.types';
-
-export declare function callAxios(method: ApiMethod, url: string, params?: object, config?: AxiosRequestConfig): Promise<axios.AxiosResponse<any, any>>;

package/dist/types/api-connections/methods/connect-to-api.d.ts

@@ -1,7 +0,0 @@
-import { PlainObject } from 'pangea-helpers';
-import { ApiMethod, ApiConfig, EndpointSettings, ApiConnectionsConfig } from '../../types/api-connections.types';
-
-export declare function connectToApi<T extends ApiMethod, SuccessRes, TCount>(method: T, url: string, endpointSettings: EndpointSettings, params: PlainObject | Array<any>, appVersion: string, apiConnectionsConfig: ApiConnectionsConfig | undefined, apiConfig?: ApiConfig<SuccessRes, TCount>): Promise<{
-    data: SuccessRes;
-    totalCount: TCount;
-}>;

package/dist/types/api-connections/methods/convert-json-to-model.d.ts

@@ -1,3 +0,0 @@
-import { EndpointSettingsResponse } from '../../types/api-connections.types';
-
-export declare function convertJsonToModel(Model: EndpointSettingsResponse, jsonData: any): any;

package/dist/types/api-connections/methods/get-finals.d.ts

@@ -1,6 +0,0 @@
-import { PlainObject } from 'pangea-helpers';
-import { Id } from '../../types';
-import { EndpointSettingsParams } from '../../types/api-connections.types';
-
-export declare function getFinalUrl(url: string, id?: Id): string;
-export declare function getFinalParams(Model: EndpointSettingsParams, params: PlainObject | PlainObject[]): import('../../models').BaseParams;

package/dist/types/types/api-connections.types.d.ts

@@ -1,39 +0,0 @@
-import { Ref } from 'vue';
-import { AxiosError, AxiosBasicCredentials } from 'axios';
-import { BaseModel } from '../models/base-model.model';
-import { BaseParams } from '../models/base-params.models';
-import { BaseResponse } from '../models/base-response.models';
-import { ExtractConstructor } from 'pangea-helpers';
-import { ClassWithConstructor } from '.';
-
-export type ApiMethod = 'get' | 'post' | 'put' | 'patch' | 'delete';
-export type ApiConnectionMethod = 'getOne' | 'getMany' | 'postOne' | 'postMany' | 'putOne' | 'putMany' | 'deleteOne' | 'deleteMany';
-export type ApiConfig<SuccessRes, TCount = undefined> = {
-    success?: (data: SuccessRes, totalCount?: TCount) => void;
-    error?: (err: AxiosError) => void;
-    noDisplayError?: boolean;
-    noThrowError?: boolean;
-    isLoading?: Ref<boolean>;
-    basicAuth?: AxiosBasicCredentials;
-};
-export type Headers = Record<string, string>;
-export type GetCustomHeaders = () => Headers;
-export type ApiConnectionsConfig = {
-    getCustomHeaders?: GetCustomHeaders;
-};
-export type EndpointSettingsParams = typeof BaseParams;
-export type EndpointSettingsResponse = typeof BaseModel | typeof BaseResponse | ClassWithConstructor | undefined;
-export type EndpointSettingsMeta = {
-    sendAsFormData?: boolean;
-};
-export type EndpointSettings = {
-    params?: EndpointSettingsParams;
-    response: EndpointSettingsResponse;
-    meta?: EndpointSettingsMeta;
-};
-export type ApiEndpoints = Record<string, Partial<Record<ApiConnectionMethod, EndpointSettings>>>;
-export type ApiEndpointName<AE extends ApiEndpoints, CM extends ApiConnectionMethod> = {
-    [K in keyof AE]: CM extends keyof AE[K] ? K : never;
-}[keyof AE];
-export type ApiEndpointParams<AE extends ApiEndpoints, EN extends ApiEndpointName<AE, CM>, CM extends ApiConnectionMethod> = EN extends keyof AE ? CM extends keyof AE[EN] ? 'params' extends keyof AE[EN][CM] ? InstanceType<ExtractConstructor<AE[EN][CM]['params']>> : never : never : any;
-export type ApiEndpointResponse<AE extends ApiEndpoints, EN extends ApiEndpointName<AE, CM>, CM extends ApiConnectionMethod> = EN extends keyof AE ? CM extends keyof AE[EN] ? 'response' extends keyof AE[EN][CM] ? InstanceType<ExtractConstructor<AE[EN][CM]['response']>> : never : never : any;