@logto/core-kit 2.5.0 → 2.5.1

package/declaration/index.ts

@@ -1,4 +1,3 @@
 /* eslint-disable import/no-unassigned-import */
-import './react-app.d';
 import './dom.d';
 /* eslint-enable import/no-unassigned-import */

package/lib/password-policy.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" resolution-mode="require"/>
 import { type webcrypto } from 'node:crypto';
 import { type DeepPartial } from '@silverhand/essentials';
 import { z } from 'zod';

package/lib/utils/url.d.ts

@@ -1,7 +1,34 @@
-export declare const validateRedirectUrl: (url: string, type: 'web' | 'mobile') => boolean;
+export declare const validateRedirectUrl: (url: string, type: "web" | "mobile") => boolean;
 export declare const validateUriOrigin: (url: string) => boolean;
 export declare const isValidUrl: (url?: string) => boolean;
 /**
  * Check if the given URL is localhost
  */
 export declare const isLocalhost: (url: string) => boolean;
+/**
+ * Check if the request URL is a file asset path.
+ * The check is based on the last segment of the URL path containing a dot, ignoring query params.
+ * Example:
+ * - `path/scripts.js` -> true
+ * - `path/index.html?query=param` -> true
+ * - `path` -> false
+ * - `path?email=abc@test.com` -> false
+ * @param url Request URL
+ * @returns Boolean value indicating if the request URL is a file asset path
+ */
+export declare const isFileAssetPath: (url: string) => boolean;
+/**
+ * Parse the "range" request header value to get the start, end, and count values.
+ * Example:
+ * - `range: bytes=0-499` -> { start: 0, end: 499, count: 500 }
+ * - `range: bytes=0-` -> { start: 0, end: undefined, count: undefined }
+ * - `range: invalid` -> Error: Range not satisfiable
+ * - Without range header -> { start: undefined, end: undefined, count: undefined }
+ * @param range Range request header value
+ * @returns Object containing start, end, and count values
+ */
+export declare const parseRange: (range: string) => {
+    start: number | undefined;
+    end: number | undefined;
+    count: number | undefined;
+};

package/lib/utils/url.js

@@ -32,3 +32,42 @@ export const isLocalhost = (url) => {
     const parsedUrl = new URL(url);
     return ['localhost', '127.0.0.1', '::1'].includes(parsedUrl.hostname);
 };
+/**
+ * Check if the request URL is a file asset path.
+ * The check is based on the last segment of the URL path containing a dot, ignoring query params.
+ * Example:
+ * - `path/scripts.js` -> true
+ * - `path/index.html?query=param` -> true
+ * - `path` -> false
+ * - `path?email=abc@test.com` -> false
+ * @param url Request URL
+ * @returns Boolean value indicating if the request URL is a file asset path
+ */
+export const isFileAssetPath = (url) => {
+    const pathWithoutQuery = url.split('?')[0];
+    return Boolean(pathWithoutQuery?.split('/').at(-1)?.includes('.'));
+};
+/**
+ * Parse the "range" request header value to get the start, end, and count values.
+ * Example:
+ * - `range: bytes=0-499` -> { start: 0, end: 499, count: 500 }
+ * - `range: bytes=0-` -> { start: 0, end: undefined, count: undefined }
+ * - `range: invalid` -> Error: Range not satisfiable
+ * - Without range header -> { start: undefined, end: undefined, count: undefined }
+ * @param range Range request header value
+ * @returns Object containing start, end, and count values
+ */
+export const parseRange = (range) => {
+    const rangeMatch = /bytes=(\d+)-(\d+)?/.exec(range);
+    if (range && !rangeMatch) {
+        throw new Error('Range not satisfiable.');
+    }
+    const start = rangeMatch?.[1] === undefined ? undefined : Number.parseInt(rangeMatch[1], 10);
+    const end = rangeMatch?.[2] === undefined ? undefined : Number.parseInt(rangeMatch[2], 10);
+    const count = end === undefined ? undefined : end - (start ?? 0) + 1;
+    return {
+        start,
+        end,
+        count,
+    };
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@logto/core-kit",
-  "version": "2.5.0",
+  "version": "2.5.1",
   "author": "Silverhand Inc. <contact@silverhand.io>",
   "homepage": "https://github.com/logto-io/toolkit#readme",
   "repository": {
@@ -39,7 +39,7 @@
     "color": "^4.2.3"
   },
   "optionalDependencies": {
-    "zod": "^3.22.4"
+    "zod": "^3.23.8"
   },
   "devDependencies": {
     "@silverhand/eslint-config": "6.0.1",
@@ -48,15 +48,15 @@
     "@silverhand/ts-config-react": "6.0.0",
     "@types/color": "^3.0.3",
     "@types/node": "^20.9.5",
-    "@types/react": "^18.0.31",
-    "@vitest/coverage-v8": "^1.4.0",
+    "@types/react": "^18.3.3",
+    "@vitest/coverage-v8": "^2.0.0",
     "eslint": "^8.56.0",
     "lint-staged": "^15.0.0",
     "postcss": "^8.4.31",
     "prettier": "^3.0.0",
     "stylelint": "^15.0.0",
-    "typescript": "^5.3.3",
-    "vitest": "^1.4.0"
+    "typescript": "^5.5.3",
+    "vitest": "^2.0.0"
   },
   "eslintConfig": {
     "extends": "@silverhand"

package/declaration/react-app.d.ts

@@ -1,65 +0,0 @@
-// Copied from react-scripts/lib/react-app.d.ts
-
-declare module '*.avif' {
-  const source: string;
-  export default source;
-}
-
-declare module '*.bmp' {
-  const source: string;
-  export default source;
-}
-
-declare module '*.gif' {
-  const source: string;
-  export default source;
-}
-
-declare module '*.jpg' {
-  const source: string;
-  export default source;
-}
-
-declare module '*.jpeg' {
-  const source: string;
-  export default source;
-}
-
-declare module '*.png' {
-  const source: string;
-  export default source;
-}
-
-declare module '*.webp' {
-  const source: string;
-  export default source;
-}
-
-declare module '*.svg' {
-  import * as React from 'react';
-
-  export const ReactComponent: React.FunctionComponent<
-    React.SVGProps<SVGSVGElement> & { title?: string }
-  >;
-
-  const source: string;
-  export default source;
-}
-
-declare module '*.module.css' {
-  const classes: Readonly<Record<string, string>>;
-  export default classes;
-  export = classes;
-}
-
-declare module '*.module.scss' {
-  const classes: Readonly<Record<string, string>>;
-  export default classes;
-  export = classes;
-}
-
-declare module '*.module.sass' {
-  const classes: Readonly<Record<string, string>>;
-  export default classes;
-  export = classes;
-}

package/lib/custom-jwt/error-handling.d.ts

@@ -1,7 +0,0 @@
-export declare const buildErrorResponse: (error: unknown) => {
-    message: string;
-    stack: string | undefined;
-} | {
-    message: string;
-    stack?: undefined;
-};

package/lib/custom-jwt/error-handling.js

@@ -1,9 +0,0 @@
-import { types } from 'node:util';
-export const buildErrorResponse = (error) => 
-/**
- * Use `isNativeError` to check if the error is an instance of `Error`.
- * If the error comes from `node:vm` module, then it will not be an instance of `Error` but can be captured by `isNativeError`.
- */
-types.isNativeError(error)
-    ? { message: error.message, stack: error.stack }
-    : { message: String(error) };

package/lib/custom-jwt/index.d.ts

@@ -1,2 +0,0 @@
-export * from './script-execution.js';
-export * from './error-handling.js';

package/lib/custom-jwt/index.js

@@ -1,2 +0,0 @@
-export * from './script-execution.js';
-export * from './error-handling.js';

package/lib/custom-jwt/script-execution.d.ts

@@ -1,10 +0,0 @@
-/**
- * This function is used to execute a named function in a customized code script in a local
- * virtual machine with the given payload as input.
- *
- * @param script Custom code snippet.
- * @param functionName The name of the function to be executed.
- * @param payload The input payload for the function.
- * @returns The result of the function execution.
- */
-export declare const runScriptFunctionInLocalVm: (script: string, functionName: string, payload: unknown) => Promise<unknown>;

package/lib/custom-jwt/script-execution.js

@@ -1,30 +0,0 @@
-import { runInNewContext } from 'node:vm';
-/**
- * This function is used to execute a named function in a customized code script in a local
- * virtual machine with the given payload as input.
- *
- * @param script Custom code snippet.
- * @param functionName The name of the function to be executed.
- * @param payload The input payload for the function.
- * @returns The result of the function execution.
- */
-export const runScriptFunctionInLocalVm = async (script, functionName, payload) => {
-    const globalContext = Object.freeze({
-        fetch: async (...args) => fetch(...args),
-    });
-    const customFunction = runInNewContext(script + `;${functionName};`, globalContext);
-    if (typeof customFunction !== 'function') {
-        throw new TypeError(`The script does not have a function named \`${functionName}\``);
-    }
-    /**
-     * We can not use top-level await in `vm`, use the following implementation instead.
-     *
-     * Ref:
-     * 1. https://github.com/nodejs/node/issues/40898
-     * 2. https://github.com/n-riesco/ijavascript/issues/173#issuecomment-693924098
-     */
-    const result = await runInNewContext('(async () => customFunction(payload))();', Object.freeze({ customFunction, payload }), 
-    // Limit the execution time to 3 seconds, throws error if the script takes too long to execute.
-    { timeout: 3000 });
-    return result;
-};