@tbs-fitness/contract 0.2.0 → 0.4.0

package/dist/esm/enums/index.js

@@ -18,6 +18,12 @@ export const ACCOUNT_STATUSES = [
 ];
 /** The statuses an administrator may set. Verification is never set by hand. */
 export const ADMIN_SETTABLE_ACCOUNT_STATUSES = ['active', 'disabled'];
+/**
+ * Where a user's time zone came from. `AUTO` was detected from their browser
+ * and may be updated when they sign in elsewhere. `MANUAL` was chosen by the
+ * user, and only the user changes it.
+ */
+export const TIMEZONE_SOURCES = ['AUTO', 'MANUAL'];
 export const TOKEN_TRANSPORTS = ['body', 'cookie'];
 export const AUDIT_OUTCOMES = ['success', 'failure'];
 export const FEATURE_FLAG_RULE_TYPES = [
@@ -26,3 +32,28 @@ export const FEATURE_FLAG_RULE_TYPES = [
     'trainer',
     'role',
 ];
+/**
+ * The ways a message can reach someone. WhatsApp and push are added here when
+ * their channel modules are built.
+ */
+export const COMMUNICATION_CHANNELS = ['EMAIL', 'SMS'];
+/**
+ * Every message the platform sends. Each has a catalogue entry in
+ * `@tbs-fitness/contract/communication` saying which channels may carry it and
+ * which variables its sender supplies.
+ */
+export const MESSAGE_TYPES = [
+    'auth.otp.signup_verification',
+    'auth.otp.password_reset',
+    'auth.password_reset_link',
+];
+/** What happened to one message on one channel. */
+export const DELIVERY_STATUSES = [
+    'sent',
+    'skipped_disabled',
+    'skipped_unreachable',
+    'failed',
+    'failed_missing_variables',
+];
+/** Only one version of a template per message type and channel is active. */
+export const TEMPLATE_STATUSES = ['draft', 'active', 'archived'];

package/dist/esm/feature-flags/feature-flag.dto.js

@@ -1,4 +1,5 @@
 import { z } from 'zod';
+import { instantInputSchema, utcTimestampSchema, } from '../common/date-time.schema.js';
 import { paginationQuerySchema } from '../common/pagination.schema.js';
 import { safeTextSchema } from '../common/safe-text.schema.js';
 import { APP_ENVIRONMENTS, FEATURE_FLAG_RULE_TYPES, ROLES, } from '../enums/index.js';
@@ -14,7 +15,7 @@ const keySchema = z
 const nameSchema = safeTextSchema(120);
 const descriptionSchema = safeTextSchema(500);
 const percentageSchema = z.number().int().min(0).max(100);
-const timestampSchema = z.iso.datetime({ offset: true });
+const timestampSchema = instantInputSchema;
 /** Lower-cased, so that it matches IDs as they come from the database. */
 const accountIdSchema = z.string().toLowerCase().pipe(z.uuid());
 const scheduleIsOrdered = ({ activationAt, expiresAt, }) => !activationAt || !expiresAt || new Date(activationAt) < new Date(expiresAt);
@@ -92,8 +93,8 @@ export const ruleResponseSchema = z.object({
     ruleType: z.enum(FEATURE_FLAG_RULE_TYPES),
     ruleValue: z.string(),
     enabled: z.boolean(),
-    createdAt: z.iso.datetime(),
-    updatedAt: z.iso.datetime(),
+    createdAt: utcTimestampSchema,
+    updatedAt: utcTimestampSchema,
 });
 export const flagResponseSchema = z.object({
     id: z.uuid(),
@@ -103,13 +104,13 @@ export const flagResponseSchema = z.object({
     environment: z.enum(APP_ENVIRONMENTS),
     enabled: z.boolean(),
     rolloutPercentage: z.number().int(),
-    activationAt: z.iso.datetime().nullable(),
-    expiresAt: z.iso.datetime().nullable(),
+    activationAt: utcTimestampSchema.nullable(),
+    expiresAt: utcTimestampSchema.nullable(),
     version: z.number().int(),
     createdBy: z.uuid(),
     updatedBy: z.uuid(),
-    createdAt: z.iso.datetime(),
-    updatedAt: z.iso.datetime(),
+    createdAt: utcTimestampSchema,
+    updatedAt: utcTimestampSchema,
     rules: z.array(ruleResponseSchema),
 });
 export const auditLogResponseSchema = z.object({
@@ -121,12 +122,12 @@ export const auditLogResponseSchema = z.object({
     action: z.string(),
     previousValue: z.record(z.string(), z.unknown()).nullable(),
     newValue: z.record(z.string(), z.unknown()).nullable(),
-    createdAt: z.iso.datetime(),
+    createdAt: utcTimestampSchema,
 });
 export const killSwitchResponseSchema = z.object({
     environment: z.enum(APP_ENVIRONMENTS),
     engaged: z.boolean(),
     reason: z.string().nullable(),
     updatedBy: z.uuid().nullable(),
-    updatedAt: z.iso.datetime().nullable(),
+    updatedAt: utcTimestampSchema.nullable(),
 });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tbs-fitness/contract",
-  "version": "0.2.0",
+  "version": "0.4.0",
   "description": "TBS API contract: Zod schemas, DTO types and enums shared by the backend, web and mobile apps",
   "license": "UNLICENSED",
   "type": "module",
@@ -13,6 +13,16 @@
     "dist"
   ],
   "exports": {
+    "./app-settings": {
+      "import": {
+        "types": "./dist/esm/app-settings/index.d.ts",
+        "default": "./dist/esm/app-settings/index.js"
+      },
+      "require": {
+        "types": "./dist/cjs/app-settings/index.d.ts",
+        "default": "./dist/cjs/app-settings/index.js"
+      }
+    },
     "./audit": {
       "import": {
         "types": "./dist/esm/audit/index.d.ts",
@@ -53,6 +63,16 @@
         "default": "./dist/cjs/common/index.js"
       }
     },
+    "./communication": {
+      "import": {
+        "types": "./dist/esm/communication/index.d.ts",
+        "default": "./dist/esm/communication/index.js"
+      },
+      "require": {
+        "types": "./dist/cjs/communication/index.d.ts",
+        "default": "./dist/cjs/communication/index.js"
+      }
+    },
     "./enums": {
       "import": {
         "types": "./dist/esm/enums/index.d.ts",