@shakerquiz/guards 0.0.2 → 0.0.4

package/.github/workflows/publish.yml

@@ -18,15 +18,12 @@ jobs:
     steps:
       - uses: actions/checkout@v7
         with:
-          fetch-depth: 0
           ref: main
       - uses: actions/setup-node@v7
         with:
           node-version: lts/*
-      - uses: oven-sh/setup-bun@v2
       - run: git config user.name "github-actions[bot]"
       - run: git config user.email "github-actions[bot]@users.noreply.github.com"
       - run: npm version patch
-      - run: bun install --frozen-lockfile
       - run: npm publish --tag latest --access public
       - run: git push --follow-tags

package/package.json

@@ -1,7 +1,7 @@
 {
   "type": "module",
   "name": "@shakerquiz/guards",
-  "version": "0.0.2",
+  "version": "0.0.4",
   "author": "yurkimus <yurkimus@gmail.com>",
   "license": "ISC",
   "repository": {

package/source/guards/QUERY/channels.js

@@ -1,18 +1,24 @@
 import { Channel, Channels } from '@shakerquiz/utilities'
 import { guardBody } from '../../utilities/guard-body.js'
 
-export const ChannelsQueryPropValidation = Object.freeze({
-  channel: value => Object.hasOwn(Channel, value),
+export const ChannelsQueryProp = Object.freeze({
+  channel: 'channel',
+  id: 'id',
+})
 
-  id: value =>
+export const ChannelsQueryProps = Object.freeze(Object.values(ChannelsQueryProp))
+
+export const ChannelsQueryPropValidation = Object.freeze({
+  [ChannelsQueryProp.channel]: value => Object.hasOwn(Channel, value),
+  [ChannelsQueryProp.id]: value =>
     Array.isArray(value)
       ? value.every(item => typeof item === 'string')
       : value === 'Any',
 })
 
 export const ChannelsQueryPropException = Object.freeze({
-  channel: `Body.channel must be one of ${Channels.join(', ')}.`,
-  id: `Body.id must be 'Any' or an array of strings.`,
+  [ChannelsQueryProp.channel]: `Body.channel must be one of ${Channels.join(', ')}.`,
+  [ChannelsQueryProp.id]: `Body.id must be 'Any' or an array of strings.`,
 })
 
 export const guardChannelsQueryBody = guardBody('Object', ChannelsQueryPropValidation, ChannelsQueryPropException)

package/source/guards/QUERY/participants.js

@@ -1,27 +1,33 @@
 import { Pattern } from '@shakerquiz/utilities'
 import { guardBody } from '../../utilities/guard-body.js'
 
+export const ParticipantsQueryProp = Object.freeze({
+  id: 'id',
+  mongo_id: 'mongo_id',
+  username: 'username',
+})
+
+export const ParticipantsQueryProps = Object.freeze(Object.values(ParticipantsQueryProp))
+
 export const ParticipantsQueryPropValidation = Object.freeze({
-  id: value =>
+  [ParticipantsQueryProp.id]: value =>
     Array.isArray(value)
       ? value.every(item => typeof item === 'string' && Pattern.UUID.test(item))
       : value === 'Any',
-
-  mongo_id: value =>
+  [ParticipantsQueryProp.mongo_id]: value =>
     Array.isArray(value)
       ? value.every(item => typeof item === 'string')
       : value === 'Any',
-
-  username: value =>
+  [ParticipantsQueryProp.username]: value =>
     Array.isArray(value)
       ? value.every(item => typeof item === 'string')
       : value === 'Any',
 })
 
 export const ParticipantsQueryPropException = Object.freeze({
-  id: `Body.id must be 'Any' or an array of uuid.`,
-  mongo_id: `Body.mongo_id must be 'Any' or an array of strings.`,
-  username: `Body.username must be 'Any' or an array of strings.`,
+  [ParticipantsQueryProp.id]: `Body.id must be 'Any' or an array of uuid.`,
+  [ParticipantsQueryProp.mongo_id]: `Body.mongo_id must be 'Any' or an array of strings.`,
+  [ParticipantsQueryProp.username]: `Body.username must be 'Any' or an array of strings.`,
 })
 
 export const guardParticipantsQueryBody = guardBody(

package/source/guards/channel-mailing-message.js

@@ -1,13 +1,20 @@
 import { guardBody } from '../utilities/guard-body.js'
 
+export const ChannelMailingMessageProp = Object.freeze({
+  recipient: 'recipient',
+  sender: 'sender',
+})
+
+export const ChannelMailingMessageProps = Object.freeze(Object.values(ChannelMailingMessageProp))
+
 export const ChannelMailingMessagePropValidation = Object.freeze({
-  sender: value => typeof value === 'string' && value !== '',
-  recipient: value => typeof value === 'string' && value !== '',
+  [ChannelMailingMessageProp.recipient]: value => typeof value === 'string' && value !== '',
+  [ChannelMailingMessageProp.sender]: value => typeof value === 'string' && value !== '',
 })
 
 export const ChannelMailingMessagePropException = Object.freeze({
-  sender: `Body.sender must be a non-empty string.`,
-  recipient: `Body.recipient must be a non-empty string.`,
+  [ChannelMailingMessageProp.recipient]: `Body.recipient must be a non-empty string.`,
+  [ChannelMailingMessageProp.sender]: `Body.sender must be a non-empty string.`,
 })
 
 export const guardChannelMailingMessageBody = guardBody(

package/source/guards/channel.js

@@ -1,11 +1,17 @@
 import { guardBody } from '../utilities/guard-body.js'
 
+export const ChannelProp = Object.freeze({
+  id: 'id',
+})
+
+export const ChannelProps = Object.freeze(Object.values(ChannelProp))
+
 export const ChannelPropValidation = Object.freeze({
-  id: value => typeof value === 'string' && value !== '',
+  [ChannelProp.id]: value => typeof value === 'string' && value !== '',
 })
 
 export const ChannelPropException = Object.freeze({
-  id: `Body.id must be a non-empty string.`,
+  [ChannelProp.id]: `Body.id must be a non-empty string.`,
 })
 
 export const guardChannelBody = guardBody('Object', ChannelPropValidation, ChannelPropException)

package/source/guards/mailing.js

@@ -1,14 +1,21 @@
 import { Phase } from '@shakerquiz/utilities'
 import { guardBody } from '../utilities/guard-body.js'
 
+export const MailingProp = Object.freeze({
+  phase: 'phase',
+  reason: 'reason',
+})
+
+export const MailingProps = Object.freeze(Object.values(MailingProp))
+
 export const MailingPropValidation = Object.freeze({
-  phase: value => Object.hasOwn(Phase, value),
-  reason: value => typeof value === 'string',
+  [MailingProp.phase]: value => Object.hasOwn(Phase, value),
+  [MailingProp.reason]: value => typeof value === 'string',
 })
 
 export const MailingPropException = Object.freeze({
-  phase: `Body.phase must be a Phase.`,
-  reason: `Body.reason must be a string.`,
+  [MailingProp.phase]: `Body.phase must be a Phase.`,
+  [MailingProp.reason]: `Body.reason must be a string.`,
 })
 
 export const guardMailingBody = guardBody('Object', MailingPropValidation, MailingPropException)

package/source/guards/message.js

@@ -2,15 +2,22 @@ import { MessageKind } from '@shakerquiz/utilities'
 import { isStringTag } from '@yurkimus/string-tag'
 import { guardBody } from '../utilities/guard-body.js'
 
+export const MessageProp = Object.freeze({
+  content: 'content',
+  kind: 'kind',
+})
+
+export const MessageProps = Object.freeze(Object.values(MessageProp))
+
 export const MessagePropValidation = Object.freeze({
-  // Template is not implemented yet, so we handle only Inline messages.
-  kind: value => value === MessageKind.Inline,
-  content: value => (isStringTag('Object', value) || isStringTag('Array', value)) && Object.keys(value).length > 0,
+  [MessageProp.content]: value =>
+    (isStringTag('Object', value) || isStringTag('Array', value)) && Object.keys(value).length > 0,
+  [MessageProp.kind]: value => value === MessageKind.Inline,
 })
 
 export const MessagePropException = Object.freeze({
-  kind: `Body.kind must be '${MessageKind.Inline}'.`,
-  content: `Body.content must be a non-empty object or array.`,
+  [MessageProp.content]: `Body.content must be a non-empty object or array.`,
+  [MessageProp.kind]: `Body.kind must be '${MessageKind.Inline}'.`,
 })
 
 export const guardMessageBody = guardBody('Object', MessagePropValidation, MessagePropException)

package/source/guards/participant.js

@@ -1,20 +1,30 @@
 import { ParticipantChoice } from '@shakerquiz/utilities'
 import { guardBody } from '../utilities/guard-body.js'
 
+export const ParticipantProp = Object.freeze({
+  choice: 'choice',
+  first_name: 'first_name',
+  last_name: 'last_name',
+  mongo_id: 'mongo_id',
+  username: 'username',
+})
+
+export const ParticipantProps = Object.freeze(Object.values(ParticipantProp))
+
 export const ParticipantPropValidation = Object.freeze({
-  mongo_id: value => typeof value === 'string' && value !== '',
-  first_name: value => typeof value === 'string',
-  last_name: value => typeof value === 'string',
-  username: value => typeof value === 'string',
-  choice: value => Object.hasOwn(ParticipantChoice, value),
+  [ParticipantProp.choice]: value => Object.hasOwn(ParticipantChoice, value),
+  [ParticipantProp.first_name]: value => typeof value === 'string',
+  [ParticipantProp.last_name]: value => typeof value === 'string',
+  [ParticipantProp.mongo_id]: value => typeof value === 'string' && value !== '',
+  [ParticipantProp.username]: value => typeof value === 'string',
 })
 
 export const ParticipantPropException = Object.freeze({
-  mongo_id: `Body.mongo_id must be a non-empty string.`,
-  first_name: `Body.first_name must be a string.`,
-  last_name: `Body.last_name must be a string.`,
-  username: `Body.username must be a string.`,
-  choice: `Body.choice must be a ParticipantChoice.`,
+  [ParticipantProp.choice]: `Body.choice must be a ParticipantChoice.`,
+  [ParticipantProp.first_name]: `Body.first_name must be a string.`,
+  [ParticipantProp.last_name]: `Body.last_name must be a string.`,
+  [ParticipantProp.mongo_id]: `Body.mongo_id must be a non-empty string.`,
+  [ParticipantProp.username]: `Body.username must be a string.`,
 })
 
 export const guardParticipantBody = guardBody('Object', ParticipantPropValidation, ParticipantPropException)