@ueu/ueu-canvas 0.0.2

package/src/types.ts

@@ -0,0 +1,134 @@
+import {CanvasData, IUserData} from "@/canvasDataDefs";
+import {ITermData} from "@/term/Term";
+import {Page} from "@/content/pages/Page";
+
+export interface ICourseData extends CanvasData {
+    id: number,
+    sis_course_id?: string,
+    uuid: string,
+    name: string,
+    course_code: string,
+    original_name: string,
+    workflow_state: 'available' | 'unpublished' | 'completed' | 'deleted',
+    account_id: number,
+    root_account_id: number,
+    enrollment_term_id: number[] | number,
+    grading_periods?: CanvasData[] | null,
+    grading_standard_id: number,
+    grade_passback_setting?: "nightly_sync" | "disabled" | '',
+    created_at: string,
+    start_at: string,
+    end_at: string,
+    locale: string,
+    enrollments: number | null,
+    total_students?: number,
+    calendar: CanvasData,
+    default_view: 'feed' | 'wiki' | 'modules' | 'assignments' | 'syllabus',
+    syllabus_body?: string,
+    needs_grading_count?: number,
+    term?: ITermData,
+    course_progress: CanvasData,
+    apply_assignment_group_weights: boolean,
+    permissions: Record<string, boolean>,
+    public_description: string,
+    storage_quota_mb: number,
+    storage_quota_used_mb: number,
+    hide_final_grades: boolean,
+    license: string,
+    allow_student_assignment_edits: boolean,
+    allow_wiki_comments: boolean,
+    allow_student_forum_attachments: boolean,
+    open_enrollment: boolean,
+    self_enrollment: boolean,
+    restrict_enrollments_to_course_dates: boolean,
+    course_format: string,
+    access_restricted_by_date?: boolean
+    time_zone: string,
+    blueprint: boolean,
+    blueprint_restrictions: IBlueprintContentRestrictions,
+    blueprint_restrictions_by_object_type: {
+        assignment?: IBlueprintContentRestrictions,
+        attachment?: IBlueprintContentRestrictions,
+        discussion_topic?: IBlueprintContentRestrictions,
+        quiz?: IBlueprintContentRestrictions,
+        wiki_page?: IBlueprintContentRestrictions
+    }
+    template: boolean
+
+}
+
+export interface ICourseSettings {
+    "allow_student_discussion_topics": boolean,
+    "allow_student_forum_attachments": boolean,
+    "allow_student_discussion_editing": boolean,
+    "grading_standard_enabled": boolean,
+    "grading_standard_id": number,
+    "allow_student_organized_groups": boolean,
+    "hide_final_grades": boolean,
+    "hide_distribution_graphs": boolean,
+    "hide_sections_on_course_users_page": boolean,
+    "lock_all_announcements": boolean,
+    "usage_rights_required": boolean,
+    "homeroom_course": boolean,
+    "default_due_time": string,
+    "conditional_release": boolean,
+    show_announcements_on_home_page?: boolean
+}
+
+export interface ITabData {
+    id: string,
+    html_url: string,
+    full_url: string,
+    position: number,
+    hidden?: boolean,
+    visibility: string,
+    label: string,
+    type: string
+}
+
+export interface IBlueprintContentRestrictions {
+    content: boolean,
+    points: boolean,
+    due_dates: boolean,
+    availability_dates: boolean
+}
+
+export type SectionData = Partial<ICourseData>
+    & Pick<ICourseData, 'id'
+    | 'name'
+    | 'course_code'
+    | 'sis_course_id'
+>
+    & {
+    term_name: string,
+    teachers: {
+        id: number,
+        display_name:string,
+        anonymous_id: string,
+        avatar_image_url: string,
+        html_url: string,
+        pronouns: string
+    }
+}
+export type TopicPermissions = Record<string, any>
+export type FileAttachment = Record<string, any>
+export type ResizeImageMessage = {
+    src: string,
+    image: HTMLImageElement,
+    width: number,
+    height?: number
+}
+
+export interface IProfile {
+    user?: IUserData,
+    bio?: string | null,
+    displayName?: string | null,
+    image?: HTMLImageElement | null,
+    imageLink?: string | null,
+    sourcePage?: Page | null,
+
+}
+
+export interface IProfileWithUser extends IProfile {
+    user: IUserData
+}

package/src/users/getUserGenerator.ts

@@ -0,0 +1,39 @@
+import {getPagedDataGenerator} from "@/fetch/getPagedDataGenerator";
+import {IUserData} from "@/index";
+
+export type GetUserQueryParams = {
+    search_term?: string;
+    enrollment_type?: 'student' | 'teacher' | 'ta' | 'observer' | 'designer';
+    sort?: 'username' | 'email' | 'sis_id' | 'integration_id' | 'last_login';
+    order?: 'asc' | 'desc';
+    include_deleted_users?: boolean;
+}
+export type GetAccountUserGenConfig = {
+    accountId: number;
+    queryParams?: GetUserQueryParams;
+};
+
+export  type GetCourseUserGenConfig = {
+    courseId: number;
+    queryParams?: GetUserQueryParams;
+};
+
+export type GetUserGenConfig = GetAccountUserGenConfig | GetCourseUserGenConfig;
+
+export const getUserGenerator = (
+    config:GetUserGenConfig
+) => {
+    let url:string;
+
+    if('accountId' in config) {
+        url = `/api/v1/accounts/${config.accountId}/users`;
+    } else if('courseId' in config) {
+        url = `/api/v1/courses/${config.courseId}/users`;
+    } else {
+        throw new Error('config type not recognized')
+    }
+
+    return getPagedDataGenerator<IUserData[]>(url, {
+        queryParams: config,
+    });
+}

package/src/users/index.ts

@@ -0,0 +1 @@
+export * from './getUserGenerator'

package/tsconfig.json

@@ -0,0 +1,46 @@
+{
+  "compilerOptions": {
+    "target": "esNext",
+    "lib": [
+      "dom",
+      "dom.iterable",
+      "esnext"
+    ],
+    "declaration": true,
+    "declarationMap": true,
+    "outDir": "./dist",
+
+    "types": [
+      "jest",
+      "@testing-library/jest-dom"
+    ],
+    "baseUrl": "./src",
+    "paths": {
+      "@/*": [
+        "./*"
+      ],
+      "@canvas/*": [
+        "./*"
+      ]
+    },
+    "sourceMap": true,
+    "allowJs": true,
+    "skipLibCheck": false,
+    "esModuleInterop": true,
+    "allowSyntheticDefaultImports": true,
+    "strict": true,
+    "forceConsistentCasingInFileNames": true,
+    "noFallthroughCasesInSwitch": true,
+    "module": "es2020",
+    "moduleResolution": "node",
+    "resolveJsonModule": true,
+    "isolatedModules": true,
+    "noEmit": false,
+    "emitDeclarationOnly": false,
+    "jsx": "react-jsx"
+  },
+  "include": [
+    "src",
+    "tests"
+  ]
+}

package/webpack.config.js

@@ -0,0 +1,122 @@
+/* eslint-disable @typescript-eslint/no-require-imports,@/no-undef */
+//via https://medium.com/@tharshita13/creating-a-chrome-extension-with-react-a-step-by-step-guide-47fe9bab24a1
+
+const path = require("path");
+const HTMLPlugin = require("html-webpack-plugin");
+const CopyPlugin = require("copy-webpack-plugin");
+const webpack = require("webpack");
+const packageJson = require('./package.json');
+const {TsconfigPathsPlugin} = require("tsconfig-paths-webpack-plugin");
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+const dotenv = require('dotenv').config({path: __dirname + '/.env'})
+const isDevelopment = process.env.NODE_ENV !== 'production'
+const outputPath = path.resolve(__dirname, "./dist");
+
+const entry = './src/index.ts';
+const output = {
+    path: outputPath,
+    filename: 'index.js',
+    library: {
+        name: 'ueu_canvas',
+        type: 'umd',
+    },
+    globalObject: 'this',
+    clean: true,
+}
+
+const externals = {
+    assert: 'commonjs assert',     // Node core module
+    process: 'commonjs process',   // Node core module
+    jest: 'commonjs jest',         // Testing library
+    'jest-dom': 'commonjs jest-dom',
+    'jest-environment-jsdom': 'commonjs jest-environment-jsdom',
+    '@testing-library/jest-dom': 'commonjs @testing-library/jest-dom',
+    // Uncomment if you want to exclude the polyfill
+    // 'temporal-polyfill': 'commonjs temporal-polyfill',
+};
+
+
+const
+mjsRule = {
+    test: /\.mjs$/,
+    include: /node_modules/,
+    type: 'javascript/auto',
+};
+
+const tsRule = {
+    test: /\.tsx?$/,
+    use: [{
+        loader: "ts-loader",
+        options: {compilerOptions: {noEmit: false},}
+    }],
+    exclude: /node_modules|__test__/,
+};
+
+const _module = {
+    rules: [
+        mjsRule,
+        tsRule,
+    ],
+};
+
+//
+// function getHtmlPlugins(chunks) {
+//     return chunks.map(
+//         (chunk) =>
+//             new HTMLPlugin({
+//                 title: "React extension",
+//                 filename: `${chunk}.html`,
+//                 chunks: [chunk],
+//             })
+//     );
+// }
+
+const createPlugins = () => [
+    new webpack.ProvidePlugin({
+        process: require.resolve('process/browser'),
+    }),
+    // new webpack.SourceMapDevToolPlugin({
+    //     exclude: /node_modules/,
+    //     test: /\.(ts|js|s?[ca]ss|mjs|tsx)/,
+    //     filename: '[name][ext].map'
+    // }),
+    new webpack.NormalModuleReplacementPlugin(/node:/, (resource) => {
+        const mod = resource.request.replace(/^node:/, "");
+        switch (mod) {
+            case "assert":
+                resource.request = "assert";
+                break;
+        }
+    }),
+];
+
+
+module.exports = {
+    mode: isDevelopment ? 'development' : 'production',
+    performance: {
+        hints: isDevelopment ? false : 'warning'
+    },
+    cache: {
+        type: 'filesystem',
+        allowCollectingMemory: true,
+    },
+    externals,
+    entry,
+    output,
+    devtool: false,
+    module: _module,
+    plugins: createPlugins(),
+    resolve: {
+        extensions: [".tsx", ".ts", ".js", ".mjs"],
+        alias: {
+            config: path.resolve(__dirname, process.env.NODE_ENV || 'development'),
+        },
+        plugins: [
+            new TsconfigPathsPlugin({}),
+        ],
+    },
+    stats: {
+        errorDetails: true,
+    }
+    ,
+}