@globalbrain/sefirot 3.35.3 → 3.37.0

package/lib/composables/Policy.ts

@@ -0,0 +1,26 @@
+import { type ComputedRef, computed } from 'vue'
+
+export type Policy<Code extends string | undefined = undefined> = ComputedRef<PolicyResponse<Code>>
+
+export interface PolicyResponse<Code extends string | undefined = undefined> {
+  ok: boolean | null
+  code?: Code
+  message?: string
+  is(code: Code): boolean
+}
+
+export interface PolicyHelpers<Code extends string | undefined = undefined> {
+  allow: (code?: Code, message?: string) => PolicyResponse<Code>
+  deny: (code?: Code, message?: string) => PolicyResponse<Code>
+  pending: (code?: Code, message?: string) => PolicyResponse<Code>
+}
+
+export function usePolicy<Code extends string | undefined = undefined>(
+  fn: (helpers: PolicyHelpers<Code>) => PolicyResponse<Code>
+): Policy<Code> {
+  return computed(() => fn({
+    allow: (code, message) => ({ ok: true, code, message, is: (c) => c === code }),
+    deny: (code, message) => ({ ok: false, code, message, is: (c) => c === code }),
+    pending: (code, message) => ({ ok: null, code, message, is: (c) => c === code })
+  }))
+}

package/lib/composables/V.ts

@@ -1,4 +1,9 @@
-import { type Validation, type ValidationArgs, useVuelidate } from '@vuelidate/core'
+import {
+  type Validation,
+  type ValidationArgs,
+  type GlobalConfig as VuelidateConfig,
+  useVuelidate
+} from '@vuelidate/core'
 import { type MaybeRefOrGetter, type Ref, computed, toValue } from 'vue'
 import { type Snackbar, useSnackbars } from '../stores/Snackbars'
 import { useTrans } from './Lang'
@@ -10,6 +15,7 @@ export interface V<
   validation: Ref<Validation<Rules, Data>>
   validate(): Promise<boolean>
   validateAndNotify(message?: Snackbar): Promise<boolean>
+  notify(message?: Snackbar): void
   reset(): void
 }
 
@@ -24,24 +30,24 @@ export interface ValidatableError {
   readonly $message: string | Ref<string>
 }
 
+export interface VNotification {
+  notify(message?: Snackbar): void
+}
+
 export function useV<
   Data extends { [key in keyof Rules]: any },
   Rules extends ValidationArgs = ValidationArgs
 >(
   data?: MaybeRefOrGetter<Data>,
-  rules?: MaybeRefOrGetter<Rules>
+  rules?: MaybeRefOrGetter<Rules>,
+  config?: VuelidateConfig
 ): V<Data, Rules> {
-  const { t } = useTrans({
-    en: { notify: 'Form contains errors. Please correct them and try again.' },
-    ja: { notify: 'フォームにエラーがあります。内容を確認し、再度お試しください。' }
-  })
-
-  const snackbars = useSnackbars()
+  const { notify } = useVNotification()
 
   const d = computed(() => toValue(data) ?? {})
   const r = computed(() => toValue(rules) ?? {})
 
-  const validation = useVuelidate(r, d) as any
+  const validation = useVuelidate(r, d, config) as any
 
   function reset(): void {
     validation.value.$reset()
@@ -55,10 +61,7 @@ export function useV<
     const valid = await validate()
 
     if (!valid) {
-      snackbars.push(message ?? {
-        mode: 'danger',
-        text: t.notify
-      })
+      notify(message)
     }
 
     return valid
@@ -68,6 +71,27 @@ export function useV<
     validation,
     validate,
     validateAndNotify,
+    notify,
     reset
   }
 }
+
+export function useVNotification(): VNotification {
+  const { t } = useTrans({
+    en: { notify: 'Form contains errors. Please correct them and try again.' },
+    ja: { notify: 'フォームにエラーがあります。内容を確認し、再度お試しください。' }
+  })
+
+  const snackbars = useSnackbars()
+
+  function notify(message?: Snackbar): void {
+    snackbars.push(message ?? {
+      mode: 'danger',
+      text: t.notify
+    })
+  }
+
+  return {
+    notify
+  }
+}

package/lib/validation/rules/index.ts

@@ -19,6 +19,7 @@ export { requiredHms } from './requiredHms'
 export { requiredIf } from './requiredIf'
 export { requiredYmd } from './requiredYmd'
 export { rule } from './rule'
+export { slackChannelName } from './slackChannelName'
 export { url } from './url'
 export { ymd } from './ymd'
 export { zeroOrNegativeInteger } from './zeroOrNegativeInteger'

package/lib/validation/rules/slackChannelName.ts

@@ -0,0 +1,15 @@
+import { createRule } from '../Rule'
+import { type SlackChannelNameOptions, slackChannelName as baseSlackChannelName } from '../validators'
+
+export const message = {
+  en: 'The slack channel name is invalid.',
+  ja: 'Slackチャンネル名の形式が正しくありません。'
+}
+
+export function slackChannelName(options?: SlackChannelNameOptions, msg?: string) {
+  return createRule({
+    message: ({ lang }) => msg ?? message[lang],
+    optional: true,
+    validation: (value) => baseSlackChannelName(value, options)
+  })
+}

package/lib/validation/validators/index.ts

@@ -17,6 +17,7 @@ export * from './required'
 export * from './requiredHms'
 export * from './requiredIf'
 export * from './requiredYmd'
+export * from './slackChannelName'
 export * from './url'
 export * from './ymd'
 export * from './zero'

package/lib/validation/validators/slackChannelName.ts

@@ -0,0 +1,16 @@
+import { isString } from '../../support/Utils'
+
+export interface SlackChannelNameOptions {
+  offset?: number
+}
+
+export function slackChannelName(value: unknown, options: SlackChannelNameOptions = {}): boolean {
+  if (!isString(value)) {
+    return false
+  }
+
+  const { offset = 0 } = options
+  const maxLength = /* Slack channel name max length */ 80 - offset
+
+  return new RegExp(`^[\\p{Ll}\\p{Lm}\\p{Lo}\\p{M}\\p{N}_-]{1,${maxLength}}$`, 'u').test(value)
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@globalbrain/sefirot",
-  "version": "3.35.3",
+  "version": "3.37.0",
   "packageManager": "pnpm@8.15.4",
   "description": "Vue Components for Global Brain Design System.",
   "author": "Kia Ishii <ka.ishii@globalbrains.com>",