@globalbrain/sefirot 4.34.1 → 4.35.1

package/config/nuxt.js

@@ -56,5 +56,48 @@ export const baseConfig = {
 }
 
 export function defineConfig(config = {}) {
-  return vite.mergeConfig(baseConfig, config)
+  return mergeConfig(baseConfig, config)
+}
+
+/**
+ * @template T
+ * @param {T} a
+ * @param {Partial<T>} b
+ * @see https://github.com/vuejs/vitepress/blob/d4796a0373eb486766cf48e63fdf461681424d43/src/node/config.ts#L291
+ */
+function mergeConfig(a, b, isRoot = true) {
+  const merged = /** @type {any} */ ({ ...a })
+  for (const key in b) {
+    const value = /** @type {any} */ (b[key])
+    if (value == null) {
+      continue
+    }
+    const existing = merged[key]
+    if (Array.isArray(existing) && Array.isArray(value)) {
+      merged[key] = [...existing, ...value]
+      continue
+    }
+    if (isObject(existing) && isObject(value)) {
+      if (isRoot && key === 'vite') {
+        merged[key] = vite.mergeConfig(existing, value)
+      } else {
+        merged[key] = mergeConfig(existing, value, false)
+      }
+      continue
+    }
+    merged[key] = value
+  }
+  return merged
+}
+
+/**
+ * @param {unknown} value
+ * @return {value is Record<PropertyKey, unknown>}
+ * @see file://./../lib/support/Utils.ts#isObject
+ */
+function isObject(value) {
+  if (value == null || typeof value !== 'object') { return false }
+
+  const proto = Object.getPrototypeOf(value)
+  return proto === null || proto === Object.prototype
 }

package/config/vite.js

@@ -2,13 +2,12 @@
 /// <reference lib="esnext" />
 
 import { glob } from 'node:fs/promises'
-import path from 'node:path'
 import { fileURLToPath } from 'node:url'
 import MagicString from 'magic-string'
 import icons from 'unplugin-icons/vite'
 import * as vite from 'vite'
 
-const lib = `${path.resolve(import.meta.dirname, '../lib/')}/`
+const lib = fileURLToPath(new URL('../lib/', import.meta.url))
 // eslint-disable-next-line antfu/no-top-level-await
 const files = (await Array.fromAsync(glob(`**/*.ts`, { cwd: lib })))
   .filter((file) => !file.endsWith('.d.ts'))
@@ -41,7 +40,7 @@ export const baseConfig = {
 
   resolve: {
     alias: {
-      'sefirot/': fileURLToPath(new URL('../lib/', import.meta.url))
+      'sefirot/': lib
     },
 
     // list the client-side direct dependencies/peerDependencies which get bundled

package/lib/blocks/lens/FieldContext.ts

@@ -0,0 +1,5 @@
+import { type Lang } from '../../composables/Lang'
+
+export interface FieldContext {
+  lang: Lang
+}

package/lib/blocks/lens/FieldData.ts

@@ -0,0 +1,140 @@
+import { type Rule } from './Rule'
+
+/**
+ * Registry of all available field data types. This interface can be
+ * extended via declaration merging to add custom field types.
+ *
+ * @example
+ * declare module 'sefirot/pkg/lens/FieldData' {
+ *   interface FieldDataRegistry {
+ *     my_custom: MyCustomFieldData
+ *   }
+ * }
+ *
+ * interface MyCustomFieldData extends FieldDataBase {
+ *   type: 'my_custom'
+ *   customProp: string
+ * }
+ */
+export interface FieldDataRegistry {
+  content: ContentFieldData
+  date: DateFieldData
+  datetime: DatetimeFieldData
+  file_upload: FileUploadFieldData
+  id: IdFieldData
+  link: LinkFieldData
+  number: NumberFieldData
+  related_many: RelatedManyFieldData
+  select: SelectFieldData
+  slack_message: SlackMessageFieldData
+  text: TextFieldData
+  textarea: TextareaFieldData
+}
+
+export type FieldData = FieldDataRegistry[keyof FieldDataRegistry]
+
+export type FieldDataType = keyof FieldDataRegistry
+
+export interface FieldDataBase {
+  key: string
+  labelEn: string
+  labelJa: string
+  filterKey: string
+  sortable: boolean
+  freeze: boolean
+  width: number
+  required: boolean
+  rules: Rule[]
+}
+
+export interface ContentFieldData extends FieldDataBase {
+  type: 'content'
+  bodyEn: string
+  bodyJa: string
+}
+
+export interface DateFieldData extends FieldDataBase {
+  type: 'date'
+  placeholderEn: string | null
+  placeholderJa: string | null
+  helpEn: string | null
+  helpJa: string | null
+}
+
+export interface DatetimeFieldData extends FieldDataBase {
+  type: 'datetime'
+}
+
+export interface FileUploadFieldData extends FieldDataBase {
+  type: 'file_upload'
+  placeholderEn: string | null
+  placeholderJa: string | null
+  helpEn: string | null
+  helpJa: string | null
+}
+
+export interface IdFieldData extends FieldDataBase {
+  type: 'id'
+  prefix: string
+}
+
+export interface LinkFieldData extends FieldDataBase {
+  type: 'link'
+  placeholderEn: string | null
+  placeholderJa: string | null
+  helpEn: string | null
+  helpJa: string | null
+}
+
+export interface NumberFieldData extends FieldDataBase {
+  type: 'number'
+}
+
+export interface SelectFieldData extends FieldDataBase {
+  type: 'select'
+  displayAs: 'text' | 'state'
+  inputAs: 'dropdown' | 'radio'
+  placeholderEn: string | null
+  placeholderJa: string | null
+  helpEn: string | null
+  helpJa: string | null
+  options: SelectFieldDataOption[]
+  multiple: boolean
+}
+
+export interface SelectFieldDataOption {
+  mode: 'default' | 'mute' | 'info' | 'success' | 'warning' | 'danger'
+  value: string
+  labelEn: string
+  labelJa: string
+}
+
+export interface RelatedManyFieldData extends FieldDataBase {
+  type: 'related_many'
+  title: string
+  resourceEndpointMethod: 'get' | 'post'
+  resourceEndpointPath: string
+  resourceEndpointDataKey: string | null
+  resourceTitle: string
+}
+
+export interface SlackMessageFieldData extends FieldDataBase {
+  type: 'slack_message'
+}
+
+export interface TextFieldData extends FieldDataBase {
+  type: 'text'
+  placeholderEn: string | null
+  placeholderJa: string | null
+  helpEn: string | null
+  helpJa: string | null
+}
+
+export interface TextareaFieldData extends FieldDataBase {
+  type: 'textarea'
+  placeholderEn: string | null
+  placeholderJa: string | null
+  helpEn: string | null
+  helpJa: string | null
+  rows: number
+}

package/lib/blocks/lens/FieldRegistry.ts

@@ -0,0 +1,23 @@
+import { type FieldContext } from './FieldContext'
+import { type FieldData, type FieldDataType } from './FieldData'
+import { type Field } from './fields/Field'
+
+export type FieldProvider<T extends FieldData> = (ctx: FieldContext, fieldData: T) => Field<T>
+
+export type FieldDataFor<T extends FieldDataType> = Extract<FieldData, { type: T }>
+
+export class FieldRegistry {
+  private fields: Record<string, FieldProvider<any>> = {}
+
+  register<T extends FieldDataType>(type: T, provider: FieldProvider<FieldDataFor<T>>) {
+    this.fields[type] = provider
+  }
+
+  resolve<T extends FieldData>(fieldData: T): FieldProvider<T> {
+    const provider = this.fields[fieldData.type]
+    if (!provider) {
+      throw new Error(`Field "${fieldData.type}" is not registered in the FieldRegistry.`)
+    }
+    return provider
+  }
+}

package/lib/blocks/lens/FileDownloader.ts

@@ -0,0 +1 @@
+export type FileDownloader = (url: string) => Promise<any>

package/lib/blocks/lens/FilterOperator.ts

@@ -0,0 +1,33 @@
+export type FilterOperator =
+  | '='
+  | '!='
+  | '>'
+  | '>='
+  | '<'
+  | '<='
+  | 'in'
+
+export const FilterOperatorTextDict: Record<FilterOperator, string> = {
+  '=': 'Is',
+  '!=': 'Is not',
+  '>': 'Greater',
+  '>=': 'Greater or equal',
+  '<': 'Less',
+  '<=': 'Less or equal',
+  'in': 'In'
+}
+
+export interface FilterOperatorOption {
+  label: string
+  value: FilterOperator
+}
+
+export const FilterOperatorOptionDict: Record<FilterOperator, FilterOperatorOption> = {
+  '=': { label: 'Is', value: '=' },
+  '!=': { label: 'Is not', value: '!=' },
+  '>': { label: 'Greater', value: '>' },
+  '>=': { label: 'Greater or equal', value: '>=' },
+  '<': { label: 'Less', value: '<' },
+  '<=': { label: 'Less or equal', value: '<=' },
+  'in': { label: 'In', value: 'in' }
+}

package/lib/blocks/lens/LensQuery.ts

@@ -0,0 +1,10 @@
+export interface LensQuery {
+  entity: string
+  select: string[]
+  filters: any[]
+  sort: LensQuerySort[]
+  page: number
+  perPage: number
+}
+
+export type LensQuerySort = [key: string, direction: 'asc' | 'desc']

package/lib/blocks/lens/LensResult.ts

@@ -0,0 +1,20 @@
+import { type FieldData } from './FieldData'
+import { type LensQuery } from './LensQuery'
+
+export interface LensResult {
+  query: LensQuery
+  fields: Record<string, FieldData>
+  data: Record<string, any>[]
+  pagination: LensResultPaginationMeta
+}
+
+export interface LensResultPagination<T> {
+  data: T[]
+  meta: LensResultPaginationMeta
+}
+
+export interface LensResultPaginationMeta {
+  total: number
+  page: number
+  perPage: number
+}

package/lib/blocks/lens/ResourceFetcher.ts

@@ -0,0 +1,3 @@
+export type ResourceFetcher = (method: ResourceFetchMethod, url: string) => Promise<any>
+
+export type ResourceFetchMethod = 'get' | 'post'

package/lib/blocks/lens/Rule.ts

@@ -0,0 +1,12 @@
+export type Rule =
+  | MaxLengthRule
+  | RequiredRule
+
+export interface MaxLengthRule {
+  type: 'max_length'
+  length: number
+}
+
+export interface RequiredRule {
+  type: 'required'
+}