firstly 0.0.1 → 0.0.2

package/CHANGELOG.md

@@ -0,0 +1,8 @@
+# firstly
+
+## 0.0.2
+
+### Patch Changes
+
+- [`f127fc7`](https://github.com/jycouet/firstly/commit/f127fc78e00f6464d8fbbebc10f3ffb43402fcc3)
+  Thanks [@jycouet](https://github.com/jycouet)! - publish firstly for the first time ;)

package/LICENSE

@@ -0,0 +1,18 @@
+The MIT License (MIT)
+
+Copyright © 2022 Jean-Yves Couët
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and
+associated documentation files (the “Software”), to deal in the Software without restriction,
+including without limitation the rights to use, copy, modify, merge, publish, distribute,
+sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial
+portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT
+NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES
+OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,12 @@
+# ⚡ firstly
+
+[![](https://img.shields.io/npm/v/firstly?color=&logo=npm)](https://www.npmjs.com/package/firstly)
+[![](https://img.shields.io/npm/dm/firstly?&logo=npm)](https://www.npmjs.com/package/firstly)
+
+## 📖 Read the doc
+
+[![](https://img.shields.io/badge/Documentation%20of-remult%20kit-FF3E00.svg?style=flat&logo=stackblitz&logoColor=FF3E00)](https://firstly.fun)
+
+## ⭐️ Join us
+
+[![GitHub Repo stars](https://img.shields.io/github/stars/jycouet/firstly?logo=github&label=firstly&color=#4ACC31)](https://github.com/jycouet/firstly)

package/esm/KitBaseEnum.d.ts

@@ -0,0 +1,35 @@
+import { type IdFilter } from 'remult';
+import type { ClassType, FindOptionsBase } from 'remult';
+export type KitIcon = {
+    data?: string | string[];
+    size?: string | number;
+    class?: string | string[];
+    style?: string | string[];
+    caption?: string;
+};
+export type KitBaseEnumOptions<Entity = any> = {
+    caption?: string;
+    icon?: KitIcon;
+    where?: IdFilter<Entity> | FindOptionsBase<Entity>['where'];
+    class?: string;
+};
+export declare class KitBaseEnum<Entity = any> {
+    id: string;
+    caption?: string;
+    icon?: KitIcon;
+    where?: IdFilter<Entity> | FindOptionsBase<Entity>['where'];
+    class?: string;
+    constructor(_id: string | number, options?: KitBaseEnumOptions<Entity>);
+    getWhere: () => this | Entity[] | {
+        $ne?: Entity | Entity[] | undefined;
+        '!='?: Entity | Entity[] | undefined;
+        $in?: Entity[] | undefined;
+        $nin?: Entity[] | undefined;
+    } | {
+        $id: import("remult").ValueFilter<Entity extends {
+            id?: number | undefined;
+        } ? number : string>;
+    } | import("remult").EntityFilter<Entity> | NonNullable<Entity>;
+}
+export declare const getEnum: <T extends KitBaseEnum<any>>(baseEnum: ClassType<T>, id: string | undefined | null) => T | undefined;
+export declare const getEnums: <T extends KitBaseEnum<any>>(baseEnum: ClassType<T>) => T[];

package/esm/KitBaseEnum.js

@@ -0,0 +1,32 @@
+import { getValueList } from 'remult';
+export class KitBaseEnum {
+    id;
+    caption;
+    icon;
+    where;
+    class;
+    constructor(_id, options) {
+        this.id = _id.toString();
+        this.caption = options?.caption ?? this.id;
+        this.icon = options?.icon;
+        this.where = options?.where;
+        this.class = options?.class;
+        if (options?.icon && options.icon.caption === undefined) {
+            options.icon.caption = options?.caption;
+        }
+    }
+    getWhere = () => {
+        return this.where ? this.where : this;
+    };
+}
+export const getEnum = (baseEnum, id) => {
+    if (!id) {
+        return undefined;
+    }
+    // @ts-ignore
+    const found = getValueList(baseEnum).find((c) => c.id === id);
+    return found;
+};
+export const getEnums = (baseEnum) => {
+    return getValueList(baseEnum) || [];
+};

package/esm/KitEntity.d.ts

@@ -0,0 +1,2 @@
+import { type EntityOptions } from 'remult';
+export declare function KitEntity<entityType>(key: string, options: EntityOptions<entityType extends new (...args: any) => any ? InstanceType<entityType> : entityType>): (target: any, info?: import("remult/src/remult3/remult3").ClassDecoratorContextStub<entityType extends infer T ? T extends entityType ? T extends new (...args: any) => any ? T : never : never : never> | undefined) => any;

package/esm/KitEntity.js

@@ -0,0 +1,24 @@
+import { Entity } from 'remult';
+export function KitEntity(key, options) {
+    const toAllow = (permission) => {
+        if (permission) {
+            if (Array.isArray(permission)) {
+                return permission.map((p) => p.id);
+            }
+            return permission.id;
+        }
+        return undefined;
+    };
+    return Entity(key, {
+        ...options,
+        allowApiCrud: options.allowApiCrud ?? toAllow(options.permissionApiCrud),
+        allowApiDelete: options.allowApiDelete ?? toAllow(options.permissionApiDelete),
+        allowApiInsert: options.allowApiInsert ?? toAllow(options.permissionApiInsert),
+        allowApiRead: options.allowApiRead ?? toAllow(options.permissionApiRead),
+        allowApiUpdate: options.allowApiUpdate ?? toAllow(options.permissionApiUpdate),
+        // saved: async (item, e) => {
+        //   console.log('was saved')
+        //   await options?.saved?.(item, e)
+        // },
+    });
+}

package/esm/KitFields.d.ts

@@ -0,0 +1,10 @@
+import { type FieldOptions, type FieldValidator, type StringFieldOptions } from 'remult';
+export declare function addValidator(validators: FieldOptions['validate'], newValidator: FieldOptions['validate'], atStart?: boolean): FieldValidator<any, any> | FieldValidator<any, any>[] | undefined;
+export declare class KitFields {
+    static string<entityType = unknown, valueType = string>(o?: StringFieldOptions<entityType, valueType> & FieldOptions<entityType, valueType>): import("remult").ClassFieldDecorator<entityType, valueType | undefined>;
+    static currency<entityType = any, valueType = any>(o?: FieldOptions<entityType> & FieldOptions<entityType>): import("remult").ClassFieldDecorator<entityType, number | undefined>;
+    static dateOnly<entityType = any>(o?: FieldOptions<entityType, Date>): import("remult").ClassFieldDecorator<entityType, Date | undefined>;
+    static arrayEnum<enumType = any, entityType = any>(enumClass: enumType, o?: FieldOptions<entityType, any[]>): import("remult").ClassFieldDecorator<entityType, any[] | undefined>;
+    static arrayEnumToGql<enumType = any, entityType = any>(enumClass: enumType, o?: FieldOptions<entityType, any[]>): import("remult").ClassFieldDecorator<entityType, any[] | undefined>;
+    static arrayValueList<enumType = any, entityType = any>(enumClass: enumType, o?: FieldOptions<entityType, any[]>): import("remult").ClassFieldDecorator<entityType, any[] | undefined>;
+}

package/esm/KitFields.js

@@ -0,0 +1,196 @@
+import { Fields, Validators, } from 'remult';
+import { displayCurrency } from './formats';
+import { getEnums } from './KitBaseEnum';
+// Translate default messages
+// REMULT P3 JYC: I need to set this here the one of my app are not overwriting these...
+// It look like I have 2 remult loaded... But even trying to remove one, I still have the issue
+Validators.unique.defaultMessage = 'Existe déjà!';
+Validators.required.defaultMessage = 'Obligatoire!';
+export function addValidator(validators, newValidator, atStart = false) {
+    if (!newValidator)
+        return validators;
+    const newValidators = Array.isArray(newValidator) ? newValidator : [newValidator];
+    const validatorsArray = Array.isArray(validators) ? validators : validators ? [validators] : [];
+    return atStart ? [...newValidators, ...validatorsArray] : [...validatorsArray, ...newValidators];
+}
+// static string<entityType = any, valueType = string>(
+//   ...param: Parameters<typeof Fields.string<entityType, valueType>>
+// ) {
+export class KitFields {
+    static string(o) {
+        // const f = Fields.string(...param)
+        // f.validate = addValidator(f.validate, Validators.required)
+        // return f
+        // empty if there is nothing coming here.
+        if (o === undefined) {
+            o = {};
+        }
+        const validate = [];
+        if (o.includeInApi !== false &&
+            (!o.allowNull || o.required) &&
+            // if require: false is explicitly set, then we don't need to add required validator
+            o.required !== false) {
+            // REMULT P2 JYC (Open an issue): to repro + issue type issue? - Probably typescript
+            // @ts-ignore
+            validate.push(Validators.required);
+        }
+        // let's add original validate if any
+        if (o.validate) {
+            if (Array.isArray(o.validate)) {
+                validate.push(...o.validate);
+            }
+            else {
+                validate.push(o.validate);
+            }
+        }
+        // let's return the field
+        return Fields.string({ ...o, validate });
+    }
+    static currency(o) {
+        // let's return the field
+        return Fields.number({
+            ...o,
+            step: '0.01',
+            suffix: undefined,
+            suffixEdit: '€',
+            inputType: 'number',
+            displayValue: displayCurrency,
+            // REMULT P2: all default valueConverter are removed if I set one?
+            valueConverter: {
+                toInput(val, inputType) {
+                    const valStr = String(val);
+                    if (valStr.includes('.')) {
+                        const [left, right] = valStr.split('.');
+                        // Take only the 2 first digits after the dot
+                        return `${left}.${right.slice(0, 2)}`;
+                    }
+                    return valStr;
+                },
+                fromDb(val) {
+                    if (val) {
+                        return parseFloat(val.toString());
+                    }
+                    return val;
+                },
+            },
+        });
+    }
+    static dateOnly(o) {
+        // empty if there is nothing coming here.
+        if (o === undefined) {
+            o = {};
+        }
+        const validate = [];
+        if (o.includeInApi !== false &&
+            (!o.allowNull || o.required) &&
+            // if require: false is explicitly set, then we don't need to add required validator
+            o.required !== false) {
+            // REMULT P2 JYC (Open an issue): to repro + issue type issue? - Probably typescript
+            // @ts-ignore
+            validate.push(Validators.required);
+        }
+        // let's add original validate if any
+        if (o.validate) {
+            if (Array.isArray(o.validate)) {
+                validate.push(...o.validate);
+            }
+            else {
+                validate.push(o.validate);
+            }
+        }
+        o.inputType = 'dateOnly';
+        // let's return the field
+        return Fields.dateOnly({ ...o, validate });
+    }
+    static arrayEnum(enumClass, o) {
+        return Fields.json(() => Array, {
+            ...o,
+            inputType: 'selectArrayEnum',
+            allowNull: false,
+            valueConverter: {
+                fromDb: (v) => {
+                    if (!v)
+                        return [];
+                    const keys = v
+                        .slice(1, -1)
+                        .split(',')
+                        .map((s) => {
+                        // @ts-ignore
+                        return enumClass[s];
+                    })
+                        .filter((p) => p !== undefined);
+                    return keys;
+                },
+                toDb: (v) => {
+                    const arr = Array.isArray(v) ? v : [v];
+                    return `{${[...new Set((arr ?? []).map((c) => c.id))].join(',')}}`;
+                },
+                displayValue: (v) => {
+                    // TODO to transform in enum & item one day
+                    return v.map((c) => c.caption).join(', ');
+                },
+                // REMULT P2 Noam: how to do this in an official way?
+                // @ts-ignore
+                values: getEnums(enumClass),
+            },
+        });
+    }
+    static arrayEnumToGql(enumClass, o) {
+        return Fields.json(() => Array, {
+            ...o,
+            inputType: 'selectArrayEnum',
+            allowNull: false,
+            valueConverter: {
+                fromDb: (v) => {
+                    if (!v)
+                        return [];
+                    const keys = v.slice(1, -1).split(',');
+                    return keys;
+                },
+                toDb: (v) => {
+                    const arr = Array.isArray(v) ? v : [v];
+                    return `{${[...new Set((arr ?? []).map((c) => c.id))].join(',')}}`;
+                },
+                displayValue: (v) => {
+                    // TODO to transform in enum & item one day
+                    return v.map((c) => c.caption).join(', ');
+                },
+                // REMULT P2 Noam: how to do this in an official way?
+                // @ts-ignore
+                values: getEnums(enumClass),
+            },
+        });
+    }
+    static arrayValueList(enumClass, o) {
+        return Fields.json(() => Array, {
+            ...o,
+            inputType: 'selectArrayEnum',
+            allowNull: false,
+            valueConverter: {
+                fromDb: (v) => {
+                    if (!v)
+                        return [];
+                    const keys = v
+                        // @ts-ignore
+                        .map((s) => {
+                        // @ts-ignore
+                        return enumClass[s];
+                    })
+                        .filter((p) => p !== undefined);
+                    return keys;
+                },
+                toDb: (v) => {
+                    const arr = Array.isArray(v) ? v : [v];
+                    return `{${[...new Set((arr ?? []).map((c) => c.id))].join(',')}}`;
+                },
+                displayValue: (v) => {
+                    // Nice to have a oneLiner, but if you want custom style, just take the array and do what you want
+                    return v.map((c) => c.caption).join(', ');
+                },
+                // REMULT P2 Noam: how to do this in an official way?
+                // @ts-ignore
+                values: getEnums(enumClass),
+            },
+        });
+    }
+}

package/esm/ROUTES.d.ts

@@ -0,0 +1,88 @@
+/**
+ * This file was generated by 'vite-plugin-kit-routes'
+ *
+ *      >> DO NOT EDIT THIS FILE MANUALLY <<
+ */
+type ParamValue = string | number | undefined;
+/**
+ * Append search params to a string
+ */
+export declare const appendSp: (sp?: Record<string, ParamValue | ParamValue[]>, prefix?: '?' | '&') => string;
+/**
+ * get the current search params
+ *
+ * Could be use like this:
+ * ```
+ * route("/cities", { page: 2 }, { ...currentSP() })
+ * ```
+ */
+export declare const currentSp: () => Record<string, string>;
+type NonFunctionKeys<T> = {
+    [K in keyof T]: T[K] extends Function ? never : K;
+}[keyof T];
+type FunctionKeys<T> = {
+    [K in keyof T]: T[K] extends Function ? K : never;
+}[keyof T];
+type FunctionParams<T> = T extends (...args: infer P) => any ? P : never;
+declare const AllObjs: {
+    kit_sign_in: string;
+    remult_admin: string;
+    github: (params?: {
+        owner?: (string | number);
+        repo?: (string | number);
+    }) => string;
+    "/": string;
+    "/remult": string;
+    "/remult/auth": string;
+    "/remult/enum": string;
+    "/remult/select": string;
+    "/ui": string;
+};
+type AllTypes = typeof AllObjs;
+/**
+ * To be used like this:
+ * ```ts
+ * import { route } from './ROUTES'
+ *
+ * route('site_id', { id: 1 })
+ * ```
+ */
+export declare function route<T extends FunctionKeys<AllTypes>>(key: T, ...params: FunctionParams<AllTypes[T]>): string;
+export declare function route<T extends NonFunctionKeys<AllTypes>>(key: T): string;
+/**
+* Add this type as a generic of the vite plugin `kitRoutes<KIT_ROUTES>`.
+*
+* Full example:
+* ```ts
+* import type { KIT_ROUTES } from './ROUTES'
+* import { kitRoutes } from 'vite-plugin-kit-routes'
+*
+* kitRoutes<KIT_ROUTES>({
+*  PAGES: {
+*    // here, key of object will be typed!
+*  }
+* })
+* ```
+*/
+export type KIT_ROUTES = {
+    PAGES: {
+        '/': never;
+        '/remult': never;
+        '/remult/auth': never;
+        '/remult/enum': never;
+        '/remult/select': never;
+        '/ui': never;
+    };
+    SERVERS: Record<string, never>;
+    ACTIONS: Record<string, never>;
+    LINKS: {
+        'kit_sign_in': never;
+        'remult_admin': never;
+        'github': 'owner' | 'repo';
+    };
+    Params: {
+        owner: never;
+        repo: never;
+    };
+};
+export {};

package/esm/ROUTES.js

@@ -0,0 +1,98 @@
+/* eslint-disable */
+/**
+ * This file was generated by 'vite-plugin-kit-routes'
+ *
+ *      >> DO NOT EDIT THIS FILE MANUALLY <<
+ */
+/**
+ * PAGES
+ */
+const PAGES = {
+    "/": `/`,
+    "/remult": `/remult`,
+    "/remult/auth": `/remult/auth`,
+    "/remult/enum": `/remult/enum`,
+    "/remult/select": `/remult/select`,
+    "/ui": `/ui`
+};
+/**
+ * SERVERS
+ */
+const SERVERS = {};
+/**
+ * ACTIONS
+ */
+const ACTIONS = {};
+/**
+ * LINKS
+ */
+const LINKS = {
+    "kit_sign_in": `/kit/auth/sign-in`,
+    "remult_admin": `/api/admin`,
+    "github": (params) => {
+        params = params ?? {};
+        params.owner = params.owner ?? "jycouet";
+        params.repo = params.repo ?? "firstly";
+        return `https://github.com/${params.owner}/${params.repo}`;
+    }
+};
+/**
+ * Append search params to a string
+ */
+export const appendSp = (sp, prefix = '?') => {
+    if (sp === undefined)
+        return '';
+    const params = new URLSearchParams();
+    const append = (n, v) => {
+        if (v !== undefined) {
+            params.append(n, String(v));
+        }
+    };
+    for (const [name, val] of Object.entries(sp)) {
+        if (Array.isArray(val)) {
+            for (const v of val) {
+                append(name, v);
+            }
+        }
+        else {
+            append(name, val);
+        }
+    }
+    const formatted = params.toString();
+    if (formatted) {
+        return `${prefix}${formatted}`;
+    }
+    return '';
+};
+/**
+ * get the current search params
+ *
+ * Could be use like this:
+ * ```
+ * route("/cities", { page: 2 }, { ...currentSP() })
+ * ```
+ */
+export const currentSp = () => {
+    const params = new URLSearchParams(window.location.search);
+    const record = {};
+    for (const [key, value] of params.entries()) {
+        record[key] = value;
+    }
+    return record;
+};
+function StringOrUndefined(val) {
+    if (val === undefined) {
+        return undefined;
+    }
+    return String(val);
+}
+const AllObjs = { ...PAGES, ...ACTIONS, ...SERVERS, ...LINKS };
+export function route(key, ...params) {
+    if (AllObjs[key] instanceof Function) {
+        const element = AllObjs[key];
+        return element(...params);
+    }
+    else {
+        return AllObjs[key];
+    }
+}

package/esm/SqlDatabase/LogToConsoleCustom.d.ts

@@ -0,0 +1 @@
+export declare const LogToConsoleCustom: (duration: number, query: string, args: Record<string, any>, short?: boolean) => string | undefined;

package/esm/SqlDatabase/LogToConsoleCustom.js

@@ -0,0 +1,102 @@
+import { bgCyan, cyan, green, Log, magenta, yellow } from '@kitql/helpers';
+const typeQuery = new Map([
+    // CRUD
+    ['INSERT', '⚪'], // Used to insert new data into a database.
+    ['SELECT', '🔵'], // Used to select data from a database and retrieve it.
+    ['COUNT ', '🟦'], // Used to count data from a database and retrieve it.
+    ['UPDATE', '🟣'], // Used to update existing data within a database.
+    ['DELETE', '🟤'], // Used to delete existing data from a database.
+    // Additional
+    ['CREATE', '🟩'], // Used to create a new table, or database.
+    ['ALTER', '🟨'], // Used to modify an existing database object, such as a table.
+    ['DROP', '🟥'], // Used to delete an entire table or database.
+    ['TRUNCATE', '⬛'], // Used to remove all records from a table, including all spaces allocated for the records are removed.
+    ['GRANT', '🟪'], // Used to give a specific user permission to perform certain tasks.
+    ['REVOKE', '🟫'], // Used to take back permissions from a user.
+]);
+const keys = ['FROM', 'WHERE', 'LIMIT', 'OFFSET'];
+const typeQueryKey = Array.from(typeQuery.keys());
+export const LogToConsoleCustom = (duration, query, args, short = true) => {
+    const rawSql = query
+        .replace(/(\r\n|\n|\r|\t)/gm, ' ')
+        .replace(/  +/g, ' ')
+        .trim();
+    const s = rawSql.split(' ');
+    let first = s[0].toUpperCase();
+    if (s.includes('count(*)')) {
+        first = 'COUNT ';
+    }
+    const tables = [];
+    const listArgs = [];
+    for (let i = 0; i < s.length; i++) {
+        const up = s[i].toUpperCase();
+        if (keys.includes(up)) {
+            s[i] = magenta(up);
+        }
+        else if (typeQueryKey.includes(up)) {
+            s[i] = cyan(up);
+        }
+        if (up === 'FROM') {
+            tables.push(s[i + 1]); // let's do it before color
+            s[i + 1] = green(s[i + 1]);
+        }
+        else if (up === 'INSERT') {
+            tables.push(s[i + 2]); // let's do it before color
+        }
+        else if (up === 'UPDATE') {
+            tables.push(s[i + 1]); // let's do it before color
+        }
+        else if (up === 'LIMIT') {
+            s[i + 1] = yellow(s[i + 1]);
+        }
+        else if (up === 'OFFSET') {
+            s[i + 1] = yellow(s[i + 1]);
+        }
+        else if (up === 'ORDER' && s[i + 1].toUpperCase() === 'BY') {
+            s[i] = magenta('ORDER');
+            s[i + 1] = magenta('BY');
+        }
+        const regex = /\$\d+/g;
+        const matches = s[i].match(regex);
+        if (matches && matches.length > 0) {
+            // and it's a match with [$ somthing]
+            // let newMatches = s[i]
+            matches.reverse().forEach((keys) => {
+                s[i] = s[i].replace(keys, yellow("'" + args[keys] + "'"));
+            });
+            listArgs.push(s[i - 2].replaceAll('"', '') + ': ' + s[i]);
+        }
+    }
+    const final_s = s.join(' ').replace(/  +/g, ' ');
+    // args replace
+    // const listArgs = []
+    // for (const arg in args) {
+    // 	listArgs.push(yellow(args[arg]))
+    // 	final_s = final_s.replace(arg, yellow(args[arg]))
+    // }
+    const uniqueTables = [...new Set(tables)];
+    const mainTable = uniqueTables[uniqueTables.length - 1];
+    const subTables = uniqueTables.slice(0, -1);
+    const time = ` ${bgCyan((duration * 1000).toFixed(0).padStart(3) + ' ms ')}`;
+    let toLog = '';
+    if (short) {
+        toLog =
+            `${typeQuery.get(first) || '💢'}` +
+                `${time}` +
+                ` ${cyan(first)} ${green(mainTable?.replaceAll('"', ''))}` +
+                `${listArgs.length > 0 ? ` { ${listArgs.join(', ')} }` : ``}` +
+                `${subTables.length > 0 ? magenta(` (sub: ${subTables.join(', ')})`) : ``}`;
+    }
+    else {
+        toLog = `${typeQuery.get(first) || '💢'}` + time + ` ${final_s}`;
+    }
+    // Filter out a few things
+    const filterOutTable = ['"auth_user"', '"auth_user_session"'];
+    const OnoOfFiltered = tables.length === 1 && filterOutTable.includes(tables[0]);
+    if (!OnoOfFiltered) {
+        // console.log(`toLogLong`, toLogLong)
+        log.info(toLog);
+        return toLog;
+    }
+};
+const log = new Log('');