@studyportals/sp-connect-backend-contracts 1.0.0-beta.0 → 1.0.0-beta.1

package/README.md

@@ -1,11 +1,14 @@
 # @studyportals/sp-connect-backend-contracts
 
-Request and response contracts and business rules for the SP Connect API, published from
-the backend repository so that clients and the service cannot drift apart. Every payload is
-a zod schema with its type inferred from it, so `zod` is a peer dependency.
+Request and response types, error codes and business rules for the SP Connect API, published
+from the backend repository so that clients and the service cannot drift apart. The package has
+no runtime dependencies: it contains TypeScript types and constants only.
 
 ```ts
-import { SubmitQuestionRequestSchema, QUESTION_TEXT_MAX_LENGTH } from '@studyportals/sp-connect-backend-contracts';
+import {
+  QUESTION_TEXT_MAX_LENGTH,
+  QuestionErrorCode,
+} from '@studyportals/sp-connect-backend-contracts';
 import type { SubmitQuestionRequest } from '@studyportals/sp-connect-backend-contracts';
 ```
 

package/{contracts → dist/contracts}/config/routes.d.ts

@@ -1,4 +1,3 @@
 /** Stable public route constants. */
 export declare const API_PREFIX = "api";
 export declare const API_VERSION = "1";
-//# sourceMappingURL=routes.d.ts.map

package/{contracts → dist/contracts}/config/routes.js

@@ -1,4 +1,3 @@
 /** Stable public route constants. */
 export const API_PREFIX = 'api';
 export const API_VERSION = '1';
-//# sourceMappingURL=routes.js.map

package/{contracts → dist/contracts}/errors.d.ts

@@ -1,4 +1,3 @@
-import { z } from 'zod';
 /** Error codes the API returns that no module owns; module codes live in each module's contracts. */
 export declare const ErrorCode: {
     readonly Internal: "internal_error";
@@ -9,10 +8,8 @@ export type ErrorCode = (typeof ErrorCode)[keyof typeof ErrorCode];
  * `{ code, message, details? }` body of the API's own errors. Nest's built-in HTTP errors, such as
  * a 401 from the auth guard, keep Nest's `{ statusCode, message, error }` body instead.
  */
-export declare const ErrorResponseSchema: z.ZodObject<{
-    code: z.ZodString;
-    message: z.ZodString;
-    details: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean]>>>;
-}, z.core.$strip>;
-export type ErrorResponse = z.infer<typeof ErrorResponseSchema>;
-//# sourceMappingURL=errors.d.ts.map
+export interface ErrorResponse {
+    readonly code: string;
+    readonly message: string;
+    readonly details?: Record<string, string | number | boolean>;
+}

package/dist/contracts/errors.js

@@ -0,0 +1,5 @@
+/** Error codes the API returns that no module owns; module codes live in each module's contracts. */
+export const ErrorCode = {
+    Internal: 'internal_error',
+    InvalidRequestBody: 'request.invalid_body',
+};

package/{contracts → dist/contracts}/index.d.ts

@@ -1,11 +1,8 @@
 export { API_PREFIX, API_VERSION } from './config/routes.js';
-export { ErrorCode, ErrorResponseSchema } from './errors.js';
+export { ErrorCode } from './errors.js';
 export type { ErrorResponse } from './errors.js';
-export { ROLES, RoleSchema } from './roles.js';
+export { ROLES } from './roles.js';
 export type { Role } from './roles.js';
-export { CognitoPoolResponseSchema } from '../modules/auth/contracts/cognito-pool.js';
 export type { CognitoPoolResponse } from '../modules/auth/contracts/cognito-pool.js';
 export { EXTERNAL_ID_MAX_LENGTH, EXTERNAL_ID_PATTERN, QUESTION_TEXT_MAX_LENGTH, QUESTION_TEXT_MIN_LENGTH, QuestionErrorCode, } from '../modules/questions/contracts/question-rules.js';
-export { SubmitQuestionRequestSchema, SubmitQuestionResponseSchema, } from '../modules/questions/contracts/submit-question.js';
 export type { SubmitQuestionRequest, SubmitQuestionResponse, } from '../modules/questions/contracts/submit-question.js';
-//# sourceMappingURL=index.d.ts.map

package/dist/contracts/index.js

@@ -0,0 +1,4 @@
+export { API_PREFIX, API_VERSION } from './config/routes.js';
+export { ErrorCode } from './errors.js';
+export { ROLES } from './roles.js';
+export { EXTERNAL_ID_MAX_LENGTH, EXTERNAL_ID_PATTERN, QUESTION_TEXT_MAX_LENGTH, QUESTION_TEXT_MIN_LENGTH, QuestionErrorCode, } from '../modules/questions/contracts/question-rules.js';

package/dist/contracts/roles.d.ts

@@ -0,0 +1,2 @@
+export declare const ROLES: readonly ["student", "expert", "admin"];
+export type Role = (typeof ROLES)[number];

package/dist/contracts/roles.js

@@ -0,0 +1 @@
+export const ROLES = ['student', 'expert', 'admin'];

package/dist/modules/auth/contracts/cognito-pool.d.ts

@@ -0,0 +1,4 @@
+export interface CognitoPoolResponse {
+    readonly userPoolId: string;
+    readonly userPoolClientId: string;
+}

package/dist/modules/auth/contracts/cognito-pool.js

@@ -0,0 +1 @@
+export {};

package/{modules → dist/modules}/questions/contracts/question-rules.d.ts

@@ -1,3 +1,2 @@
 export { EXTERNAL_ID_MAX_LENGTH, EXTERNAL_ID_PATTERN, QUESTION_TEXT_MAX_LENGTH, QUESTION_TEXT_MIN_LENGTH, } from '../domain/question-constraints.js';
 export { QuestionErrorCode } from '../domain/question-error-codes.js';
-//# sourceMappingURL=question-rules.d.ts.map

package/{modules → dist/modules}/questions/contracts/question-rules.js

@@ -1,3 +1,2 @@
 export { EXTERNAL_ID_MAX_LENGTH, EXTERNAL_ID_PATTERN, QUESTION_TEXT_MAX_LENGTH, QUESTION_TEXT_MIN_LENGTH, } from '../domain/question-constraints.js';
 export { QuestionErrorCode } from '../domain/question-error-codes.js';
-//# sourceMappingURL=question-rules.js.map

package/dist/modules/questions/contracts/submit-question.d.ts

@@ -0,0 +1,11 @@
+/** Public request and response shapes owned and published by the questions module. */
+export interface SubmitQuestionRequest {
+    /** Up to `EXTERNAL_ID_MAX_LENGTH` characters matching `EXTERNAL_ID_PATTERN`. */
+    readonly programmeId: string;
+    /** `QUESTION_TEXT_MIN_LENGTH` to `QUESTION_TEXT_MAX_LENGTH` characters after trimming. */
+    readonly questionText: string;
+}
+export interface SubmitQuestionResponse {
+    /** A UUID. */
+    readonly questionId: string;
+}

package/dist/modules/questions/contracts/submit-question.js

@@ -0,0 +1 @@
+export {};

package/{modules → dist/modules}/questions/domain/question-constraints.d.ts

@@ -2,4 +2,3 @@ export declare const EXTERNAL_ID_MAX_LENGTH = 128;
 export declare const EXTERNAL_ID_PATTERN: RegExp;
 export declare const QUESTION_TEXT_MIN_LENGTH = 10;
 export declare const QUESTION_TEXT_MAX_LENGTH = 280;
-//# sourceMappingURL=question-constraints.d.ts.map

package/{modules → dist/modules}/questions/domain/question-constraints.js

@@ -2,4 +2,3 @@ export const EXTERNAL_ID_MAX_LENGTH = 128;
 export const EXTERNAL_ID_PATTERN = /^[A-Za-z0-9._:-]+$/;
 export const QUESTION_TEXT_MIN_LENGTH = 10;
 export const QUESTION_TEXT_MAX_LENGTH = 280;
-//# sourceMappingURL=question-constraints.js.map

package/{modules → dist/modules}/questions/domain/question-error-codes.d.ts

@@ -6,4 +6,3 @@ export declare const QuestionErrorCode: {
     readonly ProgrammeNotFound: "question.programme_not_found";
 };
 export type QuestionErrorCode = (typeof QuestionErrorCode)[keyof typeof QuestionErrorCode];
-//# sourceMappingURL=question-error-codes.d.ts.map

package/{modules → dist/modules}/questions/domain/question-error-codes.js

@@ -5,4 +5,3 @@ export const QuestionErrorCode = {
     InvalidText: 'question.invalid_text',
     ProgrammeNotFound: 'question.programme_not_found',
 };
-//# sourceMappingURL=question-error-codes.js.map

package/package.json

@@ -1,29 +1,24 @@
 {
   "name": "@studyportals/sp-connect-backend-contracts",
-  "version": "1.0.0-beta.0",
+  "version": "1.0.0-beta.1",
+  "description": "Public API contracts and business rules of the SP Connect backend.",
+  "license": "UNLICENSED",
   "type": "module",
   "publishConfig": {
     "access": "public"
   },
   "exports": {
     ".": {
-      "types": "./contracts/index.d.ts",
-      "import": "./contracts/index.js"
+      "types": "./dist/contracts/index.d.ts",
+      "import": "./dist/contracts/index.js"
     }
   },
   "files": [
-    "contracts/**/*.js",
-    "contracts/**/*.d.ts",
-    "modules/**/*.js",
-    "modules/**/*.d.ts"
+    "dist",
+    "!dist/*.tgz"
   ],
   "sideEffects": false,
   "engines": {
     "node": ">=20"
-  },
-  "peerDependencies": {
-    "zod": "^4.0.0"
-  },
-  "description": "Public API contracts and business rules of the SP Connect backend.",
-  "license": "UNLICENSED"
+  }
 }

package/contracts/errors.js

@@ -1,16 +0,0 @@
-import { z } from 'zod';
-/** Error codes the API returns that no module owns; module codes live in each module's contracts. */
-export const ErrorCode = {
-    Internal: 'internal_error',
-    InvalidRequestBody: 'request.invalid_body',
-};
-/**
- * `{ code, message, details? }` body of the API's own errors. Nest's built-in HTTP errors, such as
- * a 401 from the auth guard, keep Nest's `{ statusCode, message, error }` body instead.
- */
-export const ErrorResponseSchema = z.object({
-    code: z.string(),
-    message: z.string(),
-    details: z.record(z.string(), z.union([z.string(), z.number(), z.boolean()])).optional(),
-});
-//# sourceMappingURL=errors.js.map

package/contracts/index.js

@@ -1,7 +0,0 @@
-export { API_PREFIX, API_VERSION } from './config/routes.js';
-export { ErrorCode, ErrorResponseSchema } from './errors.js';
-export { ROLES, RoleSchema } from './roles.js';
-export { CognitoPoolResponseSchema } from '../modules/auth/contracts/cognito-pool.js';
-export { EXTERNAL_ID_MAX_LENGTH, EXTERNAL_ID_PATTERN, QUESTION_TEXT_MAX_LENGTH, QUESTION_TEXT_MIN_LENGTH, QuestionErrorCode, } from '../modules/questions/contracts/question-rules.js';
-export { SubmitQuestionRequestSchema, SubmitQuestionResponseSchema, } from '../modules/questions/contracts/submit-question.js';
-//# sourceMappingURL=index.js.map

package/contracts/roles.d.ts

@@ -1,9 +0,0 @@
-import { z } from 'zod';
-export declare const ROLES: readonly ["student", "expert", "admin"];
-export declare const RoleSchema: z.ZodEnum<{
-    student: "student";
-    expert: "expert";
-    admin: "admin";
-}>;
-export type Role = z.infer<typeof RoleSchema>;
-//# sourceMappingURL=roles.d.ts.map

package/contracts/roles.js

@@ -1,4 +0,0 @@
-import { z } from 'zod';
-export const ROLES = ['student', 'expert', 'admin'];
-export const RoleSchema = z.enum(ROLES);
-//# sourceMappingURL=roles.js.map

package/modules/auth/contracts/cognito-pool.d.ts

@@ -1,7 +0,0 @@
-import { z } from 'zod';
-export declare const CognitoPoolResponseSchema: z.ZodObject<{
-    userPoolId: z.ZodString;
-    userPoolClientId: z.ZodString;
-}, z.core.$strip>;
-export type CognitoPoolResponse = z.infer<typeof CognitoPoolResponseSchema>;
-//# sourceMappingURL=cognito-pool.d.ts.map

package/modules/auth/contracts/cognito-pool.js

@@ -1,6 +0,0 @@
-import { z } from 'zod';
-export const CognitoPoolResponseSchema = z.object({
-    userPoolId: z.string().min(1),
-    userPoolClientId: z.string().min(1),
-});
-//# sourceMappingURL=cognito-pool.js.map

package/modules/questions/contracts/submit-question.d.ts

@@ -1,12 +0,0 @@
-import { z } from 'zod';
-/** Public request and response shapes owned and published by the questions module. */
-export declare const SubmitQuestionRequestSchema: z.ZodObject<{
-    programmeId: z.ZodString;
-    questionText: z.ZodString;
-}, z.core.$strip>;
-export type SubmitQuestionRequest = z.infer<typeof SubmitQuestionRequestSchema>;
-export declare const SubmitQuestionResponseSchema: z.ZodObject<{
-    questionId: z.ZodUUID;
-}, z.core.$strip>;
-export type SubmitQuestionResponse = z.infer<typeof SubmitQuestionResponseSchema>;
-//# sourceMappingURL=submit-question.d.ts.map

package/modules/questions/contracts/submit-question.js

@@ -1,11 +0,0 @@
-import { z } from 'zod';
-import { EXTERNAL_ID_MAX_LENGTH, EXTERNAL_ID_PATTERN, QUESTION_TEXT_MAX_LENGTH, QUESTION_TEXT_MIN_LENGTH, } from './question-rules.js';
-/** Public request and response shapes owned and published by the questions module. */
-export const SubmitQuestionRequestSchema = z.object({
-    programmeId: z.string().trim().min(1).max(EXTERNAL_ID_MAX_LENGTH).regex(EXTERNAL_ID_PATTERN),
-    questionText: z.string().trim().min(QUESTION_TEXT_MIN_LENGTH).max(QUESTION_TEXT_MAX_LENGTH),
-});
-export const SubmitQuestionResponseSchema = z.object({
-    questionId: z.uuid(),
-});
-//# sourceMappingURL=submit-question.js.map