@greypan/js-kit 1.1.1 → 1.2.0

package/src/timer/debounce.ts

@@ -1,92 +0,0 @@
-/**
- * @description remeda debounce 废弃了，这是 remeda 官方提供的替代封装
- * @link https://github.com/remeda/remeda/blob/main/packages/remeda/src/funnel.remeda-debounce.test.ts#L10
- */
-import { funnel } from 'remeda'
-
-type StrictFunction = (...args: never) => unknown
-type Debouncer<F extends StrictFunction, IsNullable extends boolean = true> = {
-  readonly call: (...args: Parameters<F>) => ReturnType<F> | (true extends IsNullable ? undefined : never)
-  readonly cancel: () => void
-  readonly flush: () => ReturnType<F> | undefined
-  readonly isPending: boolean
-  readonly cachedValue: ReturnType<F> | undefined
-}
-
-type DebounceOptions = {
-  readonly waitMs?: number
-  readonly maxWaitMs?: number
-}
-
-export function debounce<F extends StrictFunction>(
-  func: F,
-  options: DebounceOptions & { readonly timing?: 'trailing' }
-): Debouncer<F>
-export function debounce<F extends StrictFunction>(
-  func: F,
-  options:
-    | (DebounceOptions & { readonly timing: 'both' })
-    | (Omit<DebounceOptions, 'maxWaitMs'> & { readonly timing: 'leading' })
-): Debouncer<F, false /* call CAN'T return null */>
-export function debounce<F extends StrictFunction>(
-  func: F,
-  {
-    timing,
-    waitMs,
-    maxWaitMs
-  }: DebounceOptions & {
-    readonly timing?: 'both' | 'leading' | 'trailing'
-  }
-) {
-  if (maxWaitMs !== undefined && waitMs !== undefined && maxWaitMs < waitMs) {
-    throw new Error(`debounce: maxWaitMs (${maxWaitMs.toString()}) cannot be less than waitMs (${waitMs.toString()})`)
-  }
-
-  let cachedValue: ReturnType<F> | undefined
-
-  const debouncingFunnel = funnel(
-    (args: Parameters<F>) => {
-      // Every time the function is invoked the cached value is updated.
-      // @ts-expect-error [ts2345, ts2322] -- TypeScript infers the generic sub-
-      // types too eagerly, making itself blind to the fact that the types
-      // match here.
-      cachedValue = func(...args)
-    },
-    {
-      // Debounce stores the latest args it was called with for the next
-      // invocation of the callback.
-      reducer: (_, ...args: Parameters<F>) => args,
-      minQuietPeriodMs: waitMs ?? maxWaitMs ?? 0,
-      ...(maxWaitMs !== undefined && { maxBurstDurationMs: maxWaitMs }),
-      ...(timing === 'leading'
-        ? { triggerAt: 'start' }
-        : timing === 'both'
-          ? { triggerAt: 'both' }
-          : { triggerAt: 'end' })
-    }
-  )
-
-  return {
-    call: (...args: Parameters<F>) => {
-      debouncingFunnel.call(...args)
-      return cachedValue
-    },
-
-    flush: () => {
-      debouncingFunnel.flush()
-      return cachedValue
-    },
-
-    cancel: () => {
-      debouncingFunnel.cancel()
-    },
-
-    get isPending() {
-      return !debouncingFunnel.isIdle
-    },
-
-    get cachedValue() {
-      return cachedValue
-    }
-  }
-}

package/src/timer/index.ts

@@ -1,2 +0,0 @@
-export * from './controllable-interval'
-export * from './debounce'

package/src/url/__tests__/url.spec.ts

@@ -1,152 +0,0 @@
-import { describe, expect, it } from 'vite-plus/test'
-
-import { urlParse, urlStringify } from '..'
-
-describe('url 单元测试', () => {
-  describe('urlParse 测试', () => {
-    it('应当能够解析带 Hash 的 URL', () => {
-      expect(urlParse('https://developer.mozilla.org/en-US/docs/Web/API/URL/URL#specifications')).toEqual({
-        base: 'https://developer.mozilla.org/en-US/docs/Web/API/URL/URL',
-        query: {},
-        hash: '#specifications'
-      })
-      expect(urlParse('https://www.deepl.com/en/translator#en/zh/placeholder')).toEqual({
-        base: 'https://www.deepl.com/en/translator',
-        query: {},
-        hash: '#en/zh/placeholder'
-      })
-    })
-
-    it('应当能够解析带 Query 参数的 URL', () => {
-      expect(urlParse('https://segmentfault.com/search?q=xyz&w=123&e=aaa')).toEqual({
-        base: 'https://segmentfault.com/search',
-        query: {
-          q: 'xyz',
-          w: '123',
-          e: 'aaa'
-        },
-        hash: ''
-      })
-    })
-
-    it('应当能够解析仅包含路径（相对路径）的 URL', () => {
-      expect(urlParse('/search?q=xyz&w=123&e=aaa#heading-1')).toEqual({
-        base: '/search',
-        query: {
-          q: 'xyz',
-          w: '123',
-          e: 'aaa'
-        },
-        hash: '#heading-1'
-      })
-    })
-
-    it('应当能够对 Query 参数进行自动解码 (decode)', () => {
-      expect(
-        urlParse('https://developer.mozilla.org/en-US/docs/Web/API/URL/URL?%E9%94%AE1=%E5%80%BC1&%E9%94%AE2=%E5%80%BC2')
-      ).toEqual({
-        base: 'https://developer.mozilla.org/en-US/docs/Web/API/URL/URL',
-        query: {
-          键1: '值1',
-          键2: '值2'
-        },
-        hash: ''
-      })
-    })
-  })
-
-  describe('urlStringify 测试', () => {
-    it('应当能够处理可选的参数成员 (仅 base、base+query、base+hash)', () => {
-      expect(
-        urlStringify({
-          base: 'https://developer.mozilla.org/en-US/docs/Web/API/URL/URL'
-        })
-      ).toBe('https://developer.mozilla.org/en-US/docs/Web/API/URL/URL')
-
-      expect(
-        urlStringify({
-          base: 'https://developer.mozilla.org/en-US/docs/Web/API/URL/URL',
-          query: {
-            q: 'xyz',
-            w: '123',
-            e: 'aaa'
-          }
-        })
-      ).toBe('https://developer.mozilla.org/en-US/docs/Web/API/URL/URL?q=xyz&w=123&e=aaa')
-
-      expect(
-        urlStringify({
-          base: 'https://www.deepl.com/en/translator',
-          hash: '#en/zh/placeholder'
-        })
-      ).toBe('https://www.deepl.com/en/translator#en/zh/placeholder')
-    })
-
-    it('应当能够完整序列化包含 base, query 和 hash 的对象', () => {
-      expect(
-        urlStringify({
-          base: 'https://developer.mozilla.org/en-US/docs/Web/API/URL/URL',
-          query: {
-            q: 'xyz',
-            w: '123',
-            e: 'aaa'
-          },
-          hash: '#specifications'
-        })
-      ).toBe('https://developer.mozilla.org/en-US/docs/Web/API/URL/URL?q=xyz&w=123&e=aaa#specifications')
-    })
-
-    it('应当能够对 Query 参数进行自动编码 (encode)', () => {
-      expect(
-        urlStringify({
-          base: 'https://developer.mozilla.org/en-US/docs/Web/API/URL/URL',
-          query: {
-            键1: '值1',
-            键2: '值2'
-          },
-          hash: ''
-        })
-      ).toBe('https://developer.mozilla.org/en-US/docs/Web/API/URL/URL?%E9%94%AE1=%E5%80%BC1&%E9%94%AE2=%E5%80%BC2')
-    })
-  })
-
-  describe('urlParse|urlStringify 边缘情况与容错测试', () => {
-    it('urlParse: 应当按照 URL 标准处理纯净 URL (自动补全根路径斜杠)', () => {
-      const res = urlParse('https://google.com')
-      expect(res.base).toBe('https://google.com/')
-    })
-
-    it('urlParse: 应当处理 Query 只有键没有值的情况', () => {
-      const res = urlParse('https://test.com?debug&source=web')
-      expect(res.base).toBe('https://test.com/')
-      expect(res.query).toEqual({
-        debug: '',
-        source: 'web'
-      })
-    })
-
-    it('urlParse: 重复键应当采用“覆盖”策略（保留最后一个）', () => {
-      const url = 'https://test.com?id=1&id=2&id=3'
-      const res = urlParse(url)
-      expect(res.query).toEqual({ id: '3' })
-    })
-
-    it('urlStringify: 应当处理 Hash 不带 # 前缀的情况 (自动补全)', () => {
-      expect(
-        urlStringify({
-          base: 'https://test.com/',
-          hash: 'section1'
-        })
-      ).toBe('https://test.com/#section1')
-    })
-
-    it('urlStringify: 应当能正确处理带斜杠的标准 base', () => {
-      expect(
-        urlStringify({
-          base: 'https://test.com/',
-          query: { a: 1 }
-        })
-      ).toBe('https://test.com/?a=1')
-    })
-  })
-})

package/src/url/index.ts

@@ -1,44 +0,0 @@
-import { isNullish, omitBy } from 'remeda'
-
-type QueryValue = string | number | boolean | undefined | null
-interface URLObject {
-  base: string
-  query: Record<string, QueryValue>
-  hash: string
-}
-
-export function urlParse(url = ''): URLObject {
-  const isRelative = !/^(https?:)?\/\//.test(url)
-
-  try {
-    // 如果 url 是相对路径，就借用 http://n.n 作为 base
-    const parsed = new URL(url, isRelative ? 'http://n.n' : undefined)
-
-    return {
-      base: isRelative ? parsed.pathname : `${parsed.origin}${parsed.pathname}`,
-      query: Object.fromEntries(parsed.searchParams),
-      hash: parsed.hash
-    }
-  } catch {
-    throw new Error('Invalid URL.')
-  }
-}
-
-export function urlStringify(opts: Partial<URLObject>, omitNil = true): string {
-  const { base = '', query = {}, hash = '' } = opts
-
-  const cleanQuery = omitNil ? omitBy(query, isNullish) : query
-  const params = new URLSearchParams()
-
-  Object.entries(cleanQuery).forEach(([key, val]) => {
-    params.append(key, String(val))
-  })
-
-  // 修复 Hash 自动补全 # 的问题
-  const normalizedHash = hash ? (hash.startsWith('#') ? hash : `#${hash}`) : ''
-  const queryString = params.toString()
-  if (!queryString) return base + normalizedHash
-
-  const connector = base.includes('?') ? '&' : '?'
-  return `${base}${connector}${queryString}${normalizedHash}`
-}

package/src/utility-types/index.ts

@@ -1,19 +0,0 @@
-export type ValueOf<T> = T[keyof T]
-
-export type ArrayItem<T extends unknown[]> = T extends (infer R)[] ? R : never
-
-export type ArgumentType<T> = T extends (...args: (infer R)[]) => unknown ? R : never
-
-export type DeepPartial<T> = Partial<{
-  [K in keyof T]: DeepPartial<T[K]>
-}>
-
-export type DeepRequired<T> = Required<{
-  [K in keyof T]: DeepRequired<T[K]>
-}>
-
-export type ClassPropertyTypes<T> = {
-  [K in keyof T]: T[K]
-}
-
-export type Equal<X, Y> = (<T>() => T extends X ? 1 : 2) extends <T>() => T extends Y ? 1 : 2 ? true : false

package/tsconfig.app.json

@@ -1,11 +0,0 @@
-{
-  "compilerOptions": {
-    "paths": {
-      "@/*": ["./src/*"]
-    },
-    "tsBuildInfoFile": "./node_modules/.tmp/tsconfig.app.tsbuildinfo"
-  },
-  "exclude": ["src/**/__tests__"],
-  "extends": "@vue/tsconfig/tsconfig.dom.json",
-  "include": ["src/**/*"]
-}

package/tsconfig.json

@@ -1,8 +0,0 @@
-{
-  "files": [],
-  "references": [
-    { "path": "./tsconfig.node.json" },
-    { "path": "./tsconfig.app.json" },
-    { "path": "./tsconfig.vitest.json" }
-  ]
-}

package/tsconfig.node.json

@@ -1,18 +0,0 @@
-{
-  "compilerOptions": {
-    "module": "ESNext",
-    "moduleResolution": "Bundler",
-    "noEmit": true,
-    "tsBuildInfoFile": "./node_modules/.tmp/tsconfig.node.tsbuildinfo",
-    "types": ["node"]
-  },
-  "extends": "@tsconfig/node24/tsconfig.json",
-  "include": [
-    "vite.config.*",
-    "vitest.config.*",
-    "cypress.config.*",
-    "nightwatch.conf.*",
-    "playwright.config.*",
-    "eslint.config.*"
-  ]
-}

package/tsconfig.vitest.json

@@ -1,10 +0,0 @@
-{
-  "compilerOptions": {
-    "lib": [],
-    "tsBuildInfoFile": "./node_modules/.tmp/tsconfig.vitest.tsbuildinfo",
-    "types": ["node", "jsdom"]
-  },
-  "exclude": [],
-  "extends": "./tsconfig.app.json",
-  "include": ["src/**/__tests__"]
-}

package/vite.config.ts

@@ -1,32 +0,0 @@
-import { resolve } from 'node:path'
-
-import dts from 'vite-plugin-dts'
-import { type UserConfig } from 'vite-plus'
-
-export default {
-  resolve: {
-    tsconfigPaths: true
-  },
-  plugins: [
-    dts({
-      tsconfigPath: './tsconfig.app.json'
-    })
-  ],
-  build: {
-    sourcemap: true,
-    lib: {
-      entry: resolve(import.meta.dirname, 'src/index.ts'),
-      formats: ['es']
-    },
-    rollupOptions: {
-      external: [],
-      output: {
-        preserveModules: true,
-        // 指定源码根目录，这样 dist 下就不会多出一层 'src' 目录
-        preserveModulesRoot: 'src',
-        dir: 'dist',
-        entryFileNames: '[name].js'
-      }
-    }
-  }
-} satisfies UserConfig