oiu-core1 0.1.15

package/dist/init.d.ts

@@ -0,0 +1,63 @@
+import { ComponentType } from 'react';
+import { DevToolsEnhancerOptions, Slice } from '@reduxjs/toolkit';
+import { SetupOptions } from './utils';
+import { LangInfo } from './language';
+import { ProviderComponentType } from './theme';
+import { ColProps, PaginationProps, RowProps, SpinProps } from './components';
+export type RTKSetup = {
+    slices?: Slice[];
+    modules?: Array<Record<string, unknown>>;
+};
+export type RTKDevSetup = SetupOptions<DevToolsEnhancerOptions>;
+export type InitOIUOptions<Token, TSpinProps, TSkeletonProps, TColProps extends ColProps = ColProps, TRowProps extends RowProps = RowProps, TPaginationProps extends PaginationProps = PaginationProps> = {
+    /** Translation configuration */
+    translation: {
+        /** Default language information, this will be used if the browser language is set to an unknown language */
+        defaultLang: LangInfo;
+        /** Record of language code and its information. Example: { en: { code: 'en', locale: 'en-US' }, es: { code: 'es', locale: 'es-ES' } } */
+        langs: Record<string, LangInfo>;
+    };
+    /** Wait component configuration */
+    wait: {
+        /** Spin component to be used in the app */
+        spin: ComponentType<SpinProps<TSpinProps>>;
+        /** Default extra properties set to the spin component, this will ignored if there is spin extra props passed */
+        spinProps?: TSpinProps;
+        /** Skeleton component to be used in the app */
+        skeleton?: ComponentType<SpinProps<TSkeletonProps>>;
+        /** Default extra properties set to the skeleton component, this will ignored if there is skeleton extra props passed */
+        skeletonProps?: TSkeletonProps;
+    };
+    /** Custom component to wrap the app, this is useful if you want to wrap the app with a provider or something like that */
+    components: {
+        /** Column component to be used in the app, this will be used in the Grid component */
+        col?: ComponentType<TColProps>;
+        /** Row component to be used in the app, this will be used in the Grid component */
+        row?: ComponentType<TRowProps>;
+        /** Pagination component to be used in the app */
+        pagination?: ComponentType<TPaginationProps>;
+    };
+    themeProvider?: ProviderComponentType<Token>;
+};
+/**
+ * Initialize OIU library. This is global initialization that must be done only once in the app.
+ * @param defaultLang Default language used in the site en case the browser lang is set in unknow lang
+ * @param lang Record of language code and its information. Example: { en: { code: 'en', locale: 'en-US' }, es: { code: 'es', locale: 'es-ES' } }
+ * @param themeProvider Custom theme provider to wrap the app
+ */
+export declare function initOIU<Token, TSpinProps, TSkeletonProps>(options: InitOIUOptions<Token, TSpinProps, TSkeletonProps>): void;
+/**
+ * Hook to initialize OIU in the component
+ * @returns
+ */
+export declare function useInitOIU(defaultLocale: string, rtkOptions?: RTKSetup, devOptionsSetup?: RTKDevSetup): {
+    store: import("@reduxjs/toolkit").EnhancedStore<{
+        [x: string]: /*elided*/ any;
+    }, import("redux").UnknownAction, import("@reduxjs/toolkit").Tuple<[import("redux").StoreEnhancer<{
+        dispatch: import("redux-thunk").ThunkDispatch<{
+            [x: string]: /*elided*/ any;
+        }, undefined, import("redux").UnknownAction>;
+    }>, import("redux").StoreEnhancer]>>;
+    langInfo: LangInfo;
+};
+//# sourceMappingURL=init.d.ts.map

package/dist/init.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"init.d.ts","sourceRoot":"","sources":["../lib/init.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAW,MAAM,OAAO,CAAC;AAC/C,OAAO,EAAE,uBAAuB,EAAE,KAAK,EAAE,MAAM,kBAAkB,CAAC;AAElE,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AACvC,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAItC,OAAO,EAAiC,qBAAqB,EAAE,MAAM,SAAS,CAAC;AAC/E,OAAO,EAAa,QAAQ,EAAc,eAAe,EAAO,QAAQ,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AAI1G,MAAM,MAAM,QAAQ,GAAG;IACnB,MAAM,CAAC,EAAE,KAAK,EAAE,CAAC;IACjB,OAAO,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;CAC5C,CAAC;AACF,MAAM,MAAM,WAAW,GAAG,YAAY,CAAC,uBAAuB,CAAC,CAAC;AAEhE,MAAM,MAAM,cAAc,CACtB,KAAK,EACL,UAAU,EACV,cAAc,EACd,SAAS,SAAS,QAAQ,GAAG,QAAQ,EACrC,SAAS,SAAS,QAAQ,GAAG,QAAQ,EACrC,gBAAgB,SAAS,eAAe,GAAG,eAAe,IAC1D;IACA,gCAAgC;IAChC,WAAW,EAAE;QACT,4GAA4G;QAC5G,WAAW,EAAE,QAAQ,CAAC;QACtB,yIAAyI;QACzI,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;KACnC,CAAC;IACF,mCAAmC;IACnC,IAAI,EAAE;QACF,2CAA2C;QAC3C,IAAI,EAAE,aAAa,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC,CAAC;QAC3C,gHAAgH;QAChH,SAAS,CAAC,EAAE,UAAU,CAAC;QACvB,+CAA+C;QAC/C,QAAQ,CAAC,EAAE,aAAa,CAAC,SAAS,CAAC,cAAc,CAAC,CAAC,CAAC;QACpD,wHAAwH;QACxH,aAAa,CAAC,EAAE,cAAc,CAAC;KAClC,CAAC;IACF,0HAA0H;IAC1H,UAAU,EAAE;QACR,sFAAsF;QACtF,GAAG,CAAC,EAAE,aAAa,CAAC,SAAS,CAAC,CAAC;QAC/B,mFAAmF;QACnF,GAAG,CAAC,EAAE,aAAa,CAAC,SAAS,CAAC,CAAC;QAC/B,iDAAiD;QACjD,UAAU,CAAC,EAAE,aAAa,CAAC,gBAAgB,CAAC,CAAC;KAChD,CAAC;IACF,aAAa,CAAC,EAAE,qBAAqB,CAAC,KAAK,CAAC,CAAC;CAChD,CAAC;AACF;;;;;GAKG;AACH,wBAAgB,OAAO,CAAC,KAAK,EAAE,UAAU,EAAE,cAAc,EAAE,OAAO,EAAE,cAAc,CAAC,KAAK,EAAE,UAAU,EAAE,cAAc,CAAC,QAqBpH;AACD;;;GAGG;AACH,wBAAgB,UAAU,CAAC,aAAa,EAAE,MAAM,EAAE,UAAU,GAAE,QAAa,EAAE,eAAe,CAAC,EAAE,WAAW;;;;;;;;;EAoBzG"}

package/dist/language/index.d.ts

@@ -0,0 +1,75 @@
+import { IntlShape } from 'react-intl';
+export type GL = {
+    spin: {
+        loading: string;
+        config: string;
+        lang: string;
+        permission: string;
+        auth: string;
+        fetching: string;
+    };
+};
+/** Json path used to validate the language */
+export type JsonPath<T> = T extends object ? {
+    [K in keyof T]: K extends string ? (T[K] extends object ? `${K}.${JsonPath<T[K]>}` : `${K}`) : never;
+}[keyof T] : never;
+export type Dfn<T> = () => Promise<T>;
+export type LangInfo = {
+    /** Lang generic code like: es, en, ch */
+    code: string;
+    /** Especified the locale of the language: example es-es, en-US */
+    locale: string;
+};
+/**
+ * Check if the locale is registered
+ * @param locale Localte to be checked
+ * @returns
+ */
+export declare function isValidLocale(locale: string): boolean;
+/**
+ * Allow set the language translation by default. This multiples locales with a single code. This avoid the need to have
+ * several language file for diferent locales. This language must have the key _, this will be used by default if the language is not found.
+ * @example 'en' could be used for en-US, en-GB, etc.
+ * @param defaultLang Default language used in the site en case the browser lang is set in unknow lang
+ * @param langs Record of language code and its information. Example: { en: { code: 'en', locale: 'en-US' }, es: { code: 'es', locale: 'es-ES' } }
+ */
+export declare function setDefaultTranslation(defaultLang: LangInfo, langs: Record<string, LangInfo>): void;
+/** Return a component that will translate the given path.
+ * @param path
+ * @returns
+ */
+export declare function t<T>(path: JsonPath<T>): import("react/jsx-runtime").JSX.Element;
+/**
+ * Allow safe access to json key properties
+ * @param path
+ * @returns
+ */
+export declare function tkey<T>(path: JsonPath<T>): string;
+/**
+ * Allow safe access to text mapped with the json file properties
+ * @param path
+ * @returns
+ */
+export declare function ttext<T>(intl: IntlShape, path: JsonPath<T>): string;
+/**
+ * Get the language @see {@link LangInfo} for the given language code. Example: 'en', 'es', 'fr', 'en-GB', etc.
+ * @param lang
+ * @returns
+ */
+export declare function getLangInfo(locale: string): LangInfo;
+/**
+ * Load dynamic the json language file
+ * @param locale locale where the language is defined. Example: 'en', 'es', 'fr', 'en-GB', etc.
+ * @param en Dynamic import of the json file for the language. Example: () => import('./en.json')
+ * @param es Dynamic import of the json file for the language. Example: () => import('./es.json')
+ * @returns The corresponding language file for the given locale.
+ */
+export declare function getJsonLang<T>(locale: string, definition: Record<string, Dfn<T>>): Promise<T>;
+/** Get language defined by browser. */
+export declare function getBrowserLocale(): string;
+/**
+ * Get the current browser language translate to the valid code
+ * @returns
+ */
+export declare function getBrowserLangInfo(): LangInfo;
+//# sourceMappingURL=index.d.ts.map

package/dist/language/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../lib/language/index.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAoB,SAAS,EAAE,MAAM,YAAY,CAAC;AAMzD,MAAM,MAAM,EAAE,GAAG;IAGb,IAAI,EAAE;QACF,OAAO,EAAE,MAAM,CAAC;QAChB,MAAM,EAAE,MAAM,CAAC;QACf,IAAI,EAAE,MAAM,CAAC;QACb,UAAU,EAAE,MAAM,CAAC;QACnB,IAAI,EAAE,MAAM,CAAC;QACb,QAAQ,EAAE,MAAM,CAAC;KACpB,CAAC;CACL,CAAC;AACF,8CAA8C;AAC9C,MAAM,MAAM,QAAQ,CAAC,CAAC,IAAI,CAAC,SAAS,MAAM,GACpC;KAAG,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,SAAS,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,MAAM,GAAG,GAAG,CAAC,IAAI,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,GAAG,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK;CAAE,CAAC,MAAM,CAAC,CAAC,GACjH,KAAK,CAAC;AAEZ,MAAM,MAAM,GAAG,CAAC,CAAC,IAAI,MAAM,OAAO,CAAC,CAAC,CAAC,CAAC;AACtC,MAAM,MAAM,QAAQ,GAAG;IACnB,yCAAyC;IACzC,IAAI,EAAE,MAAM,CAAC;IACb,kEAAkE;IAClE,MAAM,EAAE,MAAM,CAAC;CAClB,CAAC;AAKF;;;;GAIG;AACH,wBAAgB,aAAa,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAGrD;AACD;;;;;;GAMG;AACH,wBAAgB,qBAAqB,CAAC,WAAW,EAAE,QAAQ,EAAE,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,QAK3F;AAID;;;GAGG;AACH,wBAAgB,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,QAAQ,CAAC,CAAC,CAAC,2CAErC;AACD;;;;GAIG;AACH,wBAAgB,IAAI,CAAC,CAAC,EAAE,IAAI,EAAE,QAAQ,CAAC,CAAC,CAAC,GAAG,MAAM,CAEjD;AACD;;;;GAIG;AACH,wBAAgB,KAAK,CAAC,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,QAAQ,CAAC,CAAC,CAAC,GAAG,MAAM,CAEnE;AAED;;;;GAIG;AACH,wBAAgB,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,QAAQ,CASpD;AAED;;;;;;GAMG;AACH,wBAAgB,WAAW,CAAC,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAQ7F;AAED,uCAAuC;AACvC,wBAAgB,gBAAgB,WAG/B;AACD;;;GAGG;AACH,wBAAgB,kBAAkB,aAKjC"}