merge from main

Author: SKairinos

CHANGELOG.md

@@ -1,3 +1,10 @@
+## [1.27.7](https://github.com/ocadotechnology/codeforlife-package-javascript/compare/v1.27.6...v1.27.7) (2024-06-03)
+
+
+### Bug Fixes
+
+* api types ([#41](https://github.com/ocadotechnology/codeforlife-package-javascript/issues/41)) ([444a51f](https://github.com/ocadotechnology/codeforlife-package-javascript/commit/444a51f488863c0f23e0fb32a1b9d87c7bc76c34))
+
 ## [1.27.6](https://github.com/ocadotechnology/codeforlife-package-javascript/compare/v1.27.5...v1.27.6) (2024-05-31)
 
 

lib/cjs/api/models.d.ts

@@ -0,0 +1,41 @@
+import { COUNTRY_ISO_CODES, UK_COUNTIES } from '../helpers/general';
+import type { Model } from '../helpers/rtkQuery';
+export type User = Model<number, {
+    password: string;
+    last_login?: Date;
+    first_name: string;
+    last_name?: string;
+    email?: string;
+    is_staff: boolean;
+    is_active: boolean;
+    date_joined: Date;
+    requesting_to_join_class?: string;
+    teacher?: Teacher;
+    student?: Student;
+}>;
+export type Teacher = Model<number, {
+    user: number;
+    school?: number;
+    is_admin: boolean;
+}>;
+export type Student = Model<number, {
+    user: number;
+    school: number;
+    klass: string;
+}>;
+export type School = Model<number, {
+    name: string;
+    country?: (typeof COUNTRY_ISO_CODES)[number];
+    uk_county?: (typeof UK_COUNTIES)[number];
+}>;
+export type Class = Model<string, {
+    name: string;
+    teacher: number;
+    school: number;
+    read_classmates_data: boolean;
+    receive_requests_until?: Date;
+}>;
+export type AuthFactor = Model<number, {
+    user: number;
+    type: 'otp';
+}>;

lib/cjs/api/models.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

lib/cjs/api/urls.d.ts

@@ -0,0 +1,5 @@
+declare const urls: Record<string, {
+    list: string;
+    detail: string;
+}>;
+export default urls;

lib/cjs/api/urls.js

@@ -0,0 +1,33 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+var urls = {
+    user: {
+        list: 'users/',
+        detail: 'users/<id>/'
+    },
+    teacher: {
+        list: 'users/teachers/',
+        detail: 'users/teachers/<id>/'
+    },
+    student: {
+        list: 'users/students/',
+        detail: 'users/students/<id>/'
+    },
+    school: {
+        list: 'schools/',
+        detail: 'schools/<id>/'
+    },
+    class: {
+        list: 'classes/',
+        detail: 'classes/<id>/'
+    },
+    otpBypassToken: {
+        list: 'otp-bypass-tokens/',
+        detail: 'otp-bypass-tokens/<id>/'
+    },
+    authFactor: {
+        list: 'auth-factors/',
+        detail: 'auth-factors/<id>/'
+    }
+};
+exports.default = urls;

lib/esm/api/models.d.ts

@@ -0,0 +1,41 @@
+import { COUNTRY_ISO_CODES, UK_COUNTIES } from '../helpers/general';
+import type { Model } from '../helpers/rtkQuery';
+export type User = Model<number, {
+    password: string;
+    last_login?: Date;
+    first_name: string;
+    last_name?: string;
+    email?: string;
+    is_staff: boolean;
+    is_active: boolean;
+    date_joined: Date;
+    requesting_to_join_class?: string;
+    teacher?: Teacher;
+    student?: Student;
+}>;
+export type Teacher = Model<number, {
+    user: number;
+    school?: number;
+    is_admin: boolean;
+}>;
+export type Student = Model<number, {
+    user: number;
+    school: number;
+    klass: string;
+}>;
+export type School = Model<number, {
+    name: string;
+    country?: (typeof COUNTRY_ISO_CODES)[number];
+    uk_county?: (typeof UK_COUNTIES)[number];
+}>;
+export type Class = Model<string, {
+    name: string;
+    teacher: number;
+    school: number;
+    read_classmates_data: boolean;
+    receive_requests_until?: Date;
+}>;
+export type AuthFactor = Model<number, {
+    user: number;
+    type: 'otp';
+}>;

lib/esm/api/models.js

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

lib/esm/api/urls.d.ts

@@ -0,0 +1,5 @@
+declare const urls: Record<string, {
+    list: string;
+    detail: string;
+}>;
+export default urls;

lib/esm/api/urls.js

@@ -0,0 +1,31 @@
+var urls = {
+    user: {
+        list: 'users/',
+        detail: 'users/<id>/'
+    },
+    teacher: {
+        list: 'users/teachers/',
+        detail: 'users/teachers/<id>/'
+    },
+    student: {
+        list: 'users/students/',
+        detail: 'users/students/<id>/'
+    },
+    school: {
+        list: 'schools/',
+        detail: 'schools/<id>/'
+    },
+    class: {
+        list: 'classes/',
+        detail: 'classes/<id>/'
+    },
+    otpBypassToken: {
+        list: 'otp-bypass-tokens/',
+        detail: 'otp-bypass-tokens/<id>/'
+    },
+    authFactor: {
+        list: 'auth-factors/',
+        detail: 'auth-factors/<id>/'
+    }
+};
+export default urls;

package.json

@@ -1,6 +1,6 @@
 {
   "name": "codeforlife",
-  "version": "1.27.6",
+  "version": "1.27.7",
   "private": true,
   "description": "Common frontend code",
   "main": "./lib/cjs/index.js",

src/api/index.ts

@@ -1,15 +1,15 @@
-import baseQuery from './baseQuery'
-import endpoints from './endpoints'
+import baseQuery from "./baseQuery"
+import endpoints from "./endpoints"
 import type {
   AuthFactor,
   Class,
   School,
   Student,
   Teacher,
-  User
-} from './models'
-import tagTypes from './tagTypes'
-import urls from './urls'
+  User,
+} from "./models"
+import tagTypes from "./tagTypes"
+import urls from "./urls"
 
 export {
   baseQuery,
@@ -21,6 +21,5 @@ export {
   type School,
   type Student,
   type Teacher,
-  type User
+  type User,
 }
-