@okam/core-lib 1.16.0 → 1.17.0

package/CHANGELOG.md

@@ -1,3 +1,20 @@
+## 1.17.0 (2025-07-24)
+
+### 🚀 Features
+
+- **directus-next:** /api/redirect route handler to fetch + cache directus redirects ([c21b953](https://github.com/OKAMca/stack/commit/c21b953))
+
+### 🩹 Fixes
+
+- update vite-plugin-dts to version 3 ([5d33c77](https://github.com/OKAMca/stack/commit/5d33c77))
+- package deps error ([b665a45](https://github.com/OKAMca/stack/commit/b665a45))
+- search field icon ([0850fde](https://github.com/OKAMca/stack/commit/0850fde))
+
+### ❤️ Thank You
+
+- Marie-Maxime Tanguay
+- Pierre-Olivier Clerson @poclerson
+
 ## 1.15.0 (2024-10-04)
 
 

package/api/json-api/index.d.ts

@@ -0,0 +1,3 @@
+export { JsonApiResponseFactory } from './json-api-response.factory';
+export type { JsonApiResponse, JsonApiErrorResponse, JsonApiSuccessResponse, JsonApiResponseMeta, JsonApiError, } from './json-api-response.types';
+export { isJsonApiErrorResponse, isJsonApiResponse, isJsonApiSuccessResponse } from './json-api.typeguard';

package/api/json-api/json-api-error.factory.d.ts

@@ -0,0 +1,6 @@
+import type { Exception } from '@tsed/exceptions';
+import type { JsonApiError } from './json-api-response.types';
+export declare class JsonApiErrorFactory {
+    static fromCatchVariable: (error: unknown, defaultHttpStatus?: number) => JsonApiError;
+    static fromTsedException: (exception: Exception | Error | string, defaultHttpStatus?: number) => JsonApiError;
+}

package/api/json-api/json-api-response.factory.d.ts

@@ -0,0 +1,5 @@
+import type { JsonApiError, JsonApiErrorResponse, JsonApiSuccessResponse } from './json-api-response.types';
+export declare class JsonApiResponseFactory {
+    static fromError: (errors: string | JsonApiError | JsonApiError[], httpStatus?: number) => JsonApiErrorResponse;
+    static fromSuccess: <T>(data: T, metadata?: JsonApiSuccessResponse<T>["meta"]) => JsonApiSuccessResponse<T>;
+}

package/api/json-api/json-api-response.types.d.ts

@@ -0,0 +1,33 @@
+/**
+ * @link https://jsonapi.org/format/#errors
+ */
+export type JsonApiError = {
+    /** a short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization. */
+    title: string;
+    /** a unique identifier for this particular occurrence of the problem. */
+    id?: string | number;
+    /** the HTTP status code applicable to this problem, expressed as a string value. */
+    status?: number;
+    /** an application-specific error code, expressed as a string value. */
+    code?: string;
+    /** a human-readable explanation specific to this occurrence of the problem. Like title, this field’s value can be localized. */
+    detail?: string;
+    /** a string indicating which URI query parameter caused the error. */
+    parameter?: string;
+    /** a meta object containing non-standard meta-information about the error. */
+    meta?: Record<string, unknown>;
+};
+export type JsonApiErrorResponse = {
+    success: false;
+    errors: JsonApiError[];
+};
+export type JsonApiResponseMeta = {
+    meta?: {
+        cacheHit?: boolean;
+    } & Record<string, string | number | boolean | Record<string, unknown>>;
+};
+export type JsonApiSuccessResponse<T> = {
+    success: true;
+    data: T;
+} & JsonApiResponseMeta;
+export type JsonApiResponse<T> = JsonApiErrorResponse | JsonApiSuccessResponse<T>;

package/api/json-api/json-api.typeguard.d.ts

@@ -0,0 +1,4 @@
+import type { JsonApiErrorResponse, JsonApiResponse, JsonApiSuccessResponse } from './json-api-response.types';
+export declare const isJsonApiResponse: <T = unknown>(val: unknown) => val is JsonApiResponse<T>;
+export declare const isJsonApiSuccessResponse: <T = unknown>(val: unknown) => val is JsonApiSuccessResponse<T>;
+export declare const isJsonApiErrorResponse: (val: unknown) => val is JsonApiErrorResponse;

package/hooks/index.d.ts

@@ -0,0 +1,2 @@
+export { usePromise } from './use-promise';
+export { useDeepCompareMemoize } from './use-deep-compare-memoize';

package/hooks/use-deep-compare-memoize.d.ts

@@ -0,0 +1,3 @@
+type SupportedValue = Record<string, unknown> | string | boolean | number | null;
+export declare function useDeepCompareMemoize(value: SupportedValue): SupportedValue;
+export {};

package/hooks/use-promise.d.ts

@@ -0,0 +1,13 @@
+export type AsyncFnParams<TParams> = TParams;
+export type AsyncFnWithParams<TResult, TParams extends Record<string, unknown>> = (variables: TParams) => Promise<TResult>;
+export type AsyncFnWithoutParams<TResult> = () => Promise<TResult>;
+export type AsyncFn<TResult, TParams extends Record<string, unknown> = Partial<Record<string, unknown>>> = AsyncFnWithParams<TResult, TParams> | AsyncFnWithoutParams<TResult>;
+export interface UsePromiseOptions<TResult> {
+    initialData?: TResult;
+}
+export declare function usePromise<TResult, TVariables extends Record<string, unknown> = Partial<Record<string, unknown>>>(promise: AsyncFn<TResult, TVariables>, params: AsyncFnParams<TVariables>, options?: UsePromiseOptions<TResult>): {
+    error: Error | null;
+    isLoading: boolean;
+    data: TResult | null;
+    reload: () => void;
+};

package/index.d.ts

@@ -8,3 +8,4 @@ export { createCtxNullable } from './utils/createContext';
 export { default as getNestedObjectValueOfKey } from './utils/object-find-deep-nested';
 export { default as checkObjectProperty } from './utils/object-property';
 export { capitalizeFirstLetter } from './utils/string-transform';
+export { normalizePath } from './utils/normalize-path';

package/index.js

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const s=require("react"),p=e=>{if(typeof e!="string"||!/\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}.\d{3}Z/.test(e))return!1;try{return new Date(e).toISOString()===e}catch{return!1}},c=(e,t=!0)=>typeof e=="string"&&(t?e.trim():e).length>0,b=e=>typeof e=="object"&&e!==null&&e.constructor===Object&&Object.getPrototypeOf(e)===Object.prototype,a=e=>typeof e=="number"&&Number.isSafeInteger(e),d=e=>typeof e=="number"&&!Number.isNaN(e)?!0:c(e)?!Number.isNaN(Number.parseInt(e,10)||Number.isNaN(Number.parseFloat(e))):!1,g=e=>{const t=typeof e=="string"&&/^-?\d+$/.test(e)?Number.parseInt(e,10):e;return a(t)},y=e=>a(e)&&e<600&&e>=100;class o{static isPresent(t,r){if(t==null)throw o.createException(r,"Value is null or undefined.")}static safeInteger(t,r){if(typeof t!="number"||!Number.isSafeInteger(t))throw o.createException(r,"Value is not a safe integer")}static nonEmptyString(t,r,n){if(!c(t,n??!0))throw o.createException(r)}static never(t,r){throw new Error(r??"Unexpected value")}static createException(t,r){throw typeof t=="string"||t===void 0?new Error(t??r??"Assertion did not pass."):t()}}function h(e,t){if([e,t].forEach((r,n)=>{if(!Number.isSafeInteger(r))throw new Error(`${n===0?"min":"max"} is not a valid integer`)}),t<e)throw new Error("Min cannot be greater than max");return e=Math.ceil(e),t=Math.floor(t),Math.floor(Math.random()*(t-e+1))+e}class N{static getRandom(t){return t[h(0,t.length-1)]}static removeItem(t,r){const n=t.indexOf(r);return n>-1&&t.splice(n,1),t}}function m(){const e=s.createContext(void 0);function t(){const r=s.useContext(e);if(r===void 0)throw new Error("useCtx must be inside a Provider");return r}return[t,e.Provider]}function x(){const e=s.createContext(void 0);function t(){const r=s.useContext(e);return r===void 0?{}:r}return[t,e.Provider]}function O(e){return typeof e=="object"&&e!==null&&!Array.isArray(e)}function f(e,t,r){const n=Object.keys(e);let i;i||(i=r);for(const u of n){const l=e[u];if(O(l)&&(i||(i=f(l,t,i))),u===t)return e[t]}return i}const w=(e,t)=>{const r=e[t];return r!=null&&typeof r=="object"&&Object.prototype.hasOwnProperty.call(e,t)?r:null};function I(e){return e.charAt(0).toUpperCase()+e.slice(1)}const P=e=>`I'm the @okam/shared-ui component telling ${e} !`;exports.ArrayUtils=N;exports.Asserts=o;exports.capitalizeFirstLetter=I;exports.checkObjectProperty=w;exports.createCtx=m;exports.createCtxNullable=x;exports.getNestedObjectValueOfKey=f;exports.isHttpStatusCode=y;exports.isIsoDateString=p;exports.isNonEmptyString=c;exports.isParsableNumeric=d;exports.isParsableSafeInteger=g;exports.isPlainObject=b;exports.isSafeInteger=a;exports.sayHello=P;
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const s=require("react"),d=t=>{if(typeof t!="string"||!/\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}.\d{3}Z/.test(t))return!1;try{return new Date(t).toISOString()===t}catch{return!1}},c=(t,e=!0)=>typeof t=="string"&&(e?t.trim():t).length>0,p=t=>typeof t=="object"&&t!==null&&t.constructor===Object&&Object.getPrototypeOf(t)===Object.prototype,a=t=>typeof t=="number"&&Number.isSafeInteger(t),b=t=>typeof t=="number"&&!Number.isNaN(t)?!0:c(t)?!Number.isNaN(Number.parseInt(t,10)||Number.isNaN(Number.parseFloat(t))):!1,g=t=>{const e=typeof t=="string"&&/^-?\d+$/.test(t)?Number.parseInt(t,10):t;return a(e)},h=t=>a(t)&&t<600&&t>=100;class i{static isPresent(e,r){if(e==null)throw i.createException(r,"Value is null or undefined.")}static safeInteger(e,r){if(typeof e!="number"||!Number.isSafeInteger(e))throw i.createException(r,"Value is not a safe integer")}static nonEmptyString(e,r,n){if(!c(e,n??!0))throw i.createException(r)}static never(e,r){throw new Error(r??"Unexpected value")}static createException(e,r){throw typeof e=="string"||e===void 0?new Error(e??r??"Assertion did not pass."):e()}}function y(t,e){if([t,e].forEach((r,n)=>{if(!Number.isSafeInteger(r))throw new Error(`${n===0?"min":"max"} is not a valid integer`)}),e<t)throw new Error("Min cannot be greater than max");return t=Math.ceil(t),e=Math.floor(e),Math.floor(Math.random()*(e-t+1))+t}class m{static getRandom(e){return e[y(0,e.length-1)]}static removeItem(e,r){const n=e.indexOf(r);return n>-1&&e.splice(n,1),e}}function N(){const t=s.createContext(void 0);function e(){const r=s.useContext(t);if(r===void 0)throw new Error("useCtx must be inside a Provider");return r}return[e,t.Provider]}function x(){const t=s.createContext(void 0);function e(){const r=s.useContext(t);return r===void 0?{}:r}return[e,t.Provider]}function P(t){return typeof t=="object"&&t!==null&&!Array.isArray(t)}function f(t,e,r){const n=Object.keys(t);let o;o||(o=r);for(const u of n){const l=t[u];if(P(l)&&(o||(o=f(l,e,o))),u===e)return t[e]}return o}const O=(t,e)=>{const r=t[e];return r!=null&&typeof r=="object"&&Object.prototype.hasOwnProperty.call(t,e)?r:null};function w(t){return t.charAt(0).toUpperCase()+t.slice(1)}function I(t){return t.split("/").reduceRight((n,o)=>n.length===0&&o===""?n:[o,...n],[]).join("/")}const j=t=>`I'm the @okam/shared-ui component telling ${t} !`;exports.ArrayUtils=m;exports.Asserts=i;exports.capitalizeFirstLetter=w;exports.checkObjectProperty=O;exports.createCtx=N;exports.createCtxNullable=x;exports.getNestedObjectValueOfKey=f;exports.isHttpStatusCode=h;exports.isIsoDateString=d;exports.isNonEmptyString=c;exports.isParsableNumeric=b;exports.isParsableSafeInteger=g;exports.isPlainObject=p;exports.isSafeInteger=a;exports.normalizePath=I;exports.sayHello=j;

package/index.mjs

@@ -7,10 +7,10 @@ const h = (t) => {
   } catch {
     return !1;
   }
-}, a = (t, e = !0) => typeof t == "string" && (e ? t.trim() : t).length > 0, g = (t) => typeof t == "object" && t !== null && t.constructor === Object && Object.getPrototypeOf(t) === Object.prototype, f = (t) => typeof t == "number" && Number.isSafeInteger(t), y = (t) => typeof t == "number" && !Number.isNaN(t) ? !0 : a(t) ? !Number.isNaN(Number.parseInt(t, 10) || Number.isNaN(Number.parseFloat(t))) : !1, N = (t) => {
+}, a = (t, e = !0) => typeof t == "string" && (e ? t.trim() : t).length > 0, g = (t) => typeof t == "object" && t !== null && t.constructor === Object && Object.getPrototypeOf(t) === Object.prototype, f = (t) => typeof t == "number" && Number.isSafeInteger(t), m = (t) => typeof t == "number" && !Number.isNaN(t) ? !0 : a(t) ? !Number.isNaN(Number.parseInt(t, 10) || Number.isNaN(Number.parseFloat(t))) : !1, y = (t) => {
   const e = typeof t == "string" && /^-?\d+$/.test(t) ? Number.parseInt(t, 10) : t;
   return f(e);
-}, m = (t) => f(t) && t < 600 && t >= 100;
+}, N = (t) => f(t) && t < 600 && t >= 100;
 class i {
   static isPresent(e, r) {
     if (e == null)
@@ -80,28 +80,32 @@ function d(t, e, r) {
   }
   return o;
 }
-const O = (t, e) => {
+const P = (t, e) => {
   const r = t[e];
   return r != null && typeof r == "object" && Object.prototype.hasOwnProperty.call(t, e) ? r : null;
 };
-function C(t) {
+function O(t) {
   return t.charAt(0).toUpperCase() + t.slice(1);
 }
-const j = (t) => `I'm the @okam/shared-ui component telling ${t} !`;
+function j(t) {
+  return t.split("/").reduceRight((n, o) => n.length === 0 && o === "" ? n : [o, ...n], []).join("/");
+}
+const C = (t) => `I'm the @okam/shared-ui component telling ${t} !`;
 export {
   x as ArrayUtils,
   i as Asserts,
-  C as capitalizeFirstLetter,
-  O as checkObjectProperty,
+  O as capitalizeFirstLetter,
+  P as checkObjectProperty,
   w as createCtx,
   I as createCtxNullable,
   d as getNestedObjectValueOfKey,
-  m as isHttpStatusCode,
+  N as isHttpStatusCode,
   h as isIsoDateString,
   a as isNonEmptyString,
-  y as isParsableNumeric,
-  N as isParsableSafeInteger,
+  m as isParsableNumeric,
+  y as isParsableSafeInteger,
   g as isPlainObject,
   f as isSafeInteger,
-  j as sayHello
+  j as normalizePath,
+  C as sayHello
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@okam/core-lib",
-  "version": "1.16.0",
+  "version": "1.17.0",
   "main": "./index.js",
   "types": "./index.d.ts",
   "license": "MIT",

package/utils/normalize-path.d.ts

@@ -0,0 +1 @@
+export declare function normalizePath(path: string): string;

package/utils/string-convert.d.ts

@@ -0,0 +1,4 @@
+export declare class StringConvert {
+    static toSafeInteger: (value: string | unknown) => number | null;
+    static toFloat: (value: string | unknown) => number | null;
+}

package/utils/typeUtils.d.ts

@@ -0,0 +1,4 @@
+export type Maybe<T> = T | null;
+export declare function isNonNullable<T>(x: T): x is NonNullable<T>;
+export declare function maybeWithDefault<T>(x: Maybe<T>, defaultValue: NonNullable<T>): NonNullable<T>;
+export declare function unknownToString(str: string | unknown): string;

package/utils/typeguards.d.ts

@@ -1,8 +1,8 @@
 export type IsoDateString = string;
-export declare const isIsoDateString: (dateStr: unknown) => dateStr is string;
+export declare const isIsoDateString: (dateStr: unknown) => dateStr is IsoDateString;
 export declare const isNonEmptyString: (v: unknown, trim?: boolean) => v is string;
 export declare const isPlainObject: <T = unknown, K extends string | number = string>(v: unknown) => v is Record<K, T>;
 export declare const isSafeInteger: (v: unknown) => v is number;
-export declare const isParsableNumeric: (v: unknown) => v is string | number;
-export declare const isParsableSafeInteger: (v: unknown) => v is string | number;
+export declare const isParsableNumeric: (v: unknown) => v is number | string;
+export declare const isParsableSafeInteger: (v: unknown) => v is number | string;
 export declare const isHttpStatusCode: (v: unknown) => v is number;