@shakerquiz/guards 0.0.0-stage → 0.0.0

package/.github/workflows/publish.yml

@@ -0,0 +1,32 @@
+name: Publish @shakerquiz/guards
+
+on:
+  pull_request:
+    types: [closed]
+    branches:
+      - main
+  workflow_dispatch:
+
+permissions:
+  id-token: write
+  contents: write
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    if: github.event.pull_request.merged == true || github.event_name == 'workflow_dispatch'
+    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/bun.lock

@@ -0,0 +1,31 @@
+{
+  "lockfileVersion": 2,
+  "configVersion": 1,
+  "workspaces": {
+    "": {
+      "name": "guards",
+      "dependencies": {
+        "@shakerquiz/utilities": "4.0.122",
+        "@yurkimus/string-tag": "0.0.4",
+      },
+      "devDependencies": {
+        "@types/bun": "1.4.4",
+      },
+    },
+  },
+  "packages": {
+    "@shakerquiz/utilities": ["@shakerquiz/utilities@4.0.122", "", {}, "sha512-dNaiDNRQE7uq4YMqkiTBCK524tF8gGnZVq09aV2Nac1HVMMQ3iAQO9Ew3A2L/LxLFdjic8kY8009puCEwI825g=="],
+
+    "@types/bun": ["@types/bun@1.4.4", "", { "dependencies": { "bun-types": "1.4.4" } }, "sha512-9wkRDXUXK124pEnAutE6n/l18j+i9GC5IAHK8TmX/2nlySETmky0OU6yL5U8pW1AoKh++AN9auDCr647BfurjQ=="],
+
+    "@types/node": ["@types/node@26.6.6", "", { "dependencies": { "undici-types": "~8.9.0" } }, "sha512-MzQj+8Kx3XI40OmUAE6Qoh58ZMNstNNMwn2nfd3qWsfe7nDNSqJNzes4njhz6AHwrSHOffSLwXU6yb474Q4aog=="],
+
+    "@yurkimus/string-tag": ["@yurkimus/string-tag@0.0.4", "", {}, "sha512-X+FD6rYT3qNKcFTke3HNeQgFVEe/VhmwzBK3vGn9Z6Auxs1857eNplO1AYsfxpTE7Ql2nM2GyG54d5nx8t2guQ=="],
+
+    "bun-types": ["bun-types@1.4.4", "", { "dependencies": { "@types/node": "*", "undici-types": "*" } }, "sha512-yjrJh5oGX7mMPKGd19YXyIjmEuj4G4zNC30bs7PM9Az7NQ3ndF3j6hbeRdvJTRQEhJ/FYQwW0a2moweEi2hMxQ=="],
+
+    "undici-types": ["undici-types@8.12.3", "", {}, "sha512-EXE4ydL3S76dFb27UFjNVZHTyv/TLdATj/KUe29ptdcg6qXL48J2tZ3126E5kICj5jn781OR+XlVH1N6Mz8jbA=="],
+
+    "@types/node/undici-types": ["undici-types@8.9.0", "", {}, "sha512-KTDyRTYX8sWmKXAikPHHSyc63CRPETMctyjKFupcC6OBLXT3xsN0e9aF7m+mIXutFWpUXuedtowG7iLOzp0kQg=="],
+  }
+}

package/dprint.json

@@ -0,0 +1,27 @@
+{
+  "typescript": {
+    "quoteStyle": "preferSingle",
+    "semiColons": "asi",
+    "indentWidth": 2,
+    "useTabs": false,
+    "useBraces": "maintain",
+    "arrowFunction.useParentheses": "preferNone",
+    "importDeclaration.forceSingleLine": true,
+    "lineWidth": 120
+  },
+  "json": {},
+  "markdown": {},
+  "dockerfile": {},
+  "yaml": {},
+  "excludes": [
+    "**/node_modules",
+    "**/*-lock.json"
+  ],
+  "plugins": [
+    "https://plugins.dprint.dev/typescript-0.93.0.wasm",
+    "https://plugins.dprint.dev/json-0.19.3.wasm",
+    "https://plugins.dprint.dev/markdown-0.17.8.wasm",
+    "https://plugins.dprint.dev/dockerfile-0.3.2.wasm",
+    "https://plugins.dprint.dev/g-plane/pretty_yaml-v0.5.0.wasm"
+  ]
+}

package/jsconfig.json

@@ -0,0 +1,14 @@
+{
+  "compilerOptions": {
+    "target": "esnext",
+    "module": "esnext",
+    "moduleResolution": "bundler",
+    "allowJs": true,
+    "checkJs": true,
+    "paths": {
+      "source/*": [
+        "./source/*"
+      ]
+    }
+  }
+}

package/package.json

@@ -1,6 +1,23 @@
 {
+  "type": "module",
   "name": "@shakerquiz/guards",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.0.0",
+  "author": "yurkimus <yurkimus@gmail.com>",
+  "license": "ISC",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/shaker-quiz/guards.git"
+  },
+  "exports": {
+    ".": {
+      "default": "./source/index.js"
+    }
+  },
+  "dependencies": {
+    "@shakerquiz/utilities": "4.0.122",
+    "@yurkimus/string-tag": "0.0.4"
+  },
+  "devDependencies": {
+    "@types/bun": "1.4.4"
+  }
+}

package/source/guards/QUERY/channels.js

@@ -0,0 +1,18 @@
+import { Channel, Channels } from '@shakerquiz/utilities'
+import { guardBody } from 'source/utilities/guard-body.js'
+
+export const ChannelsQueryPropValidation = Object.freeze({
+  channel: value => Object.hasOwn(Channel, value),
+
+  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.`,
+})
+
+export const guardChannelsQueryBody = guardBody('Object', ChannelsQueryPropValidation, ChannelsQueryPropException)

package/source/guards/QUERY/participants.js

@@ -0,0 +1,31 @@
+import { Pattern } from '@shakerquiz/utilities'
+import { guardBody } from 'source/utilities/guard-body.js'
+
+export const ParticipantsQueryPropValidation = Object.freeze({
+  id: value =>
+    Array.isArray(value)
+      ? value.every(item => typeof item === 'string' && Pattern.UUID.test(item))
+      : value === 'Any',
+
+  mongo_id: value =>
+    Array.isArray(value)
+      ? value.every(item => typeof item === 'string')
+      : value === 'Any',
+
+  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.`,
+})
+
+export const guardParticipantsQueryBody = guardBody(
+  'Object',
+  ParticipantsQueryPropValidation,
+  ParticipantsQueryPropException,
+)

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

@@ -0,0 +1,17 @@
+import { guardBody } from 'source/utilities/guard-body.js'
+
+export const ChannelMailingMessagePropValidation = Object.freeze({
+  sender: value => typeof value === 'string' && value !== '',
+  recipient: 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.`,
+})
+
+export const guardChannelMailingMessageBody = guardBody(
+  'Object',
+  ChannelMailingMessagePropValidation,
+  ChannelMailingMessagePropException,
+)

package/source/guards/channel.js

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

package/source/guards/mailing.js

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

package/source/guards/message.js

@@ -0,0 +1,16 @@
+import { MessageKind } from '@shakerquiz/utilities'
+import { isStringTag } from '@yurkimus/string-tag'
+import { guardBody } from 'source/utilities/guard-body.js'
+
+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,
+})
+
+export const MessagePropException = Object.freeze({
+  kind: `Body.kind must be '${MessageKind.Inline}'.`,
+  content: `Body.content must be a non-empty object or array.`,
+})
+
+export const guardMessageBody = guardBody('Object', MessagePropValidation, MessagePropException)

package/source/guards/participant.js

@@ -0,0 +1,20 @@
+import { ParticipantChoice } from '@shakerquiz/utilities'
+import { guardBody } from 'source/utilities/guard-body.js'
+
+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),
+})
+
+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.`,
+})
+
+export const guardParticipantBody = guardBody('Object', ParticipantPropValidation, ParticipantPropException)

package/source/index.js

@@ -0,0 +1,7 @@
+export * from 'source/guards/channel-mailing-message.js'
+export * from 'source/guards/channel.js'
+export * from 'source/guards/mailing.js'
+export * from 'source/guards/message.js'
+export * from 'source/guards/participant.js'
+export * from 'source/guards/QUERY/channels.js'
+export * from 'source/guards/QUERY/participants.js'

package/source/utilities/guard-body.js

@@ -0,0 +1,29 @@
+import { isStringTag } from '@yurkimus/string-tag'
+
+/**
+ * @param {'Object'} stringTag
+ * @param {Record<string, (value: *) => boolean>} validation
+ * @param {Record<string, string>} exception
+ *
+ * @returns {(body: Record<string, *>, props: string[]) => string} The guard, which takes the body and the props of it to validate (each of them must be present and valid), and returns the message of the first violation, or '' (the neutral element) when there is none.
+ */
+export const guardBody = (stringTag, validation, exception) => (body, props) => {
+  if (body === undefined)
+    return 'Body must be valid JSON.'
+
+  if (!isStringTag(stringTag, body))
+    return `Body must be ${stringTag}.`
+
+  if (Object.keys(body).length === 0)
+    return 'Body must not be empty.'
+
+  for (let prop of Object.keys(body))
+    if (!Object.hasOwn(validation, prop))
+      return 'Body must not have additional props.'
+
+  for (let prop of props)
+    if (!validation[prop](body[prop]))
+      return exception[prop]
+
+  return ''
+}

package/README.md

@@ -1,3 +0,0 @@
-# Temporary Holding Version
-
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.