@ueu/ueu-canvas 0.0.2 → 0.0.4

package/dist/fetch/canvasDataFetchGenFunc.d.ts

@@ -0,0 +1,6 @@
+import { ICanvasCallConfig } from "@/canvasUtils";
+import { CanvasData } from "@/canvasDataDefs";
+type UrlFuncType<UrlParams extends Record<string, any>> = (args: UrlParams, config?: ICanvasCallConfig) => string;
+export declare function canvasDataFetchGenFunc<Content extends CanvasData, UrlParams extends Record<string, any>>(urlFunc: UrlFuncType<UrlParams>, defaultConfig?: ICanvasCallConfig): (args: UrlParams, config?: ICanvasCallConfig) => AsyncGenerator<Content, any, any>;
+export {};
+//# sourceMappingURL=canvasDataFetchGenFunc.d.ts.map

package/dist/fetch/canvasDataFetchGenFunc.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"canvasDataFetchGenFunc.d.ts","sourceRoot":"","sources":["../../src/fetch/canvasDataFetchGenFunc.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,iBAAiB,EAAC,MAAM,eAAe,CAAC;AAChD,OAAO,EAAC,UAAU,EAAC,MAAM,kBAAkB,CAAC;AAK5C,KAAK,WAAW,CAAC,SAAS,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,IAAI,CAAC,IAAI,EAAE,SAAS,EAAE,MAAM,CAAC,EAAE,iBAAiB,KAAK,MAAM,CAAA;AAEjH,wBAAgB,sBAAsB,CAClC,OAAO,SAAS,UAAU,EAC1B,SAAS,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EACvC,OAAO,EAAE,WAAW,CAAC,SAAS,CAAC,EAAE,aAAa,CAAC,EAAE,iBAAiB,IAE/C,MAAM,SAAS,EAAE,SAAS,iBAAiB,uCAK/D"}

package/dist/fetch/fetchJson.d.ts

@@ -0,0 +1,3 @@
+import { ICanvasCallConfig } from "@/canvasUtils";
+export declare function fetchJson<T = Record<string, any>>(url: string, config?: ICanvasCallConfig | null): Promise<T>;
+//# sourceMappingURL=fetchJson.d.ts.map

package/dist/fetch/fetchJson.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"fetchJson.d.ts","sourceRoot":"","sources":["../../src/fetch/fetchJson.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,iBAAiB,EAAC,MAAM,eAAe,CAAC;AAEhD,wBAAsB,SAAS,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EACnD,GAAG,EAAE,MAAM,EAAE,MAAM,GAAE,iBAAiB,GAAG,IAAW,GACrD,OAAO,CAAC,CAAC,CAAC,CAeZ"}

package/dist/fetch/getPagedDataGenerator.d.ts

@@ -0,0 +1,63 @@
+import { CanvasData } from "@/canvasDataDefs";
+import { ICanvasCallConfig } from "@/canvasUtils";
+/**
+ * @param url The entire path of the url
+ * @param config a configuration object of type ICanvasCallConfig
+ * @returns {Promise<Record<string, any>[]>}
+ */
+export declare function getPagedData<T extends CanvasData = CanvasData>(url: string, config?: ICanvasCallConfig | null): Promise<T[]>;
+/**
+ * Merges multiple asynchronous paginated data generators into a single generator.
+ *
+ * This function combines the results of multiple paginated data generators into a unified stream. Each generator
+ * is processed sequentially, and its results are yielded one by one as they become available. This allows for
+ * easy handling of multiple paginated API requests or data sources in parallel without needing to collect all
+ * results in memory at once.
+ *
+ * The function is particularly useful when dealing with multiple sources of paginated data (e.g., multiple API
+ * endpoints) that need to be processed as one continuous stream of results, without waiting for all pages from one
+ * source to finish before beginning to process the next.
+ *
+ * @template T - A type parameter that extends `CanvasData`, ensuring that the data being yielded is in a format consistent
+ *               with Canvas API data structures.
+ * @param {AsyncGenerator<T, T[], void>[]} generators - An array of asynchronous generators, each of which yields paginated
+ *               results of type `T`. These could represent different paginated data sources that are combined into a single stream.
+ *
+ * @yields {T} - The function yields items of type `T` as they are retrieved from each generator in sequence.
+ *
+ * @example
+ * // Example usage combining two paginated API responses into a single data stream
+ * const generator1 = fetchPagedDataFromSource1();
+ * const generator2 = fetchPagedDataFromSource2();
+ *
+ * for await (const data of mergePagedDataGenerators([generator1, generator2])) {
+ *     console.log(data); // Process each item from both generators as a single stream
+ * }
+ *
+ */
+export declare function mergePagedDataGenerators<T extends CanvasData = CanvasData, Return = T[]>(generators: AsyncGenerator<T, Return, void>[]): AsyncGenerator<T, void, unknown>;
+/**
+ * Async generator function that retrieves paged data from a Canvas API endpoint.
+ * It sends HTTP GET requests to the provided URL, processes the results, and iterates
+ * through all pages of data, yielding each individual item.
+ *
+ * The generator automatically handles pagination by examining the 'Link' header
+ * returned in each response and fetching the next page as long as a 'next' link is available.
+ *
+ * @template T - A generic type parameter extending CanvasData to represent the structure of the data.
+ * @param {string} url - The full URL for the API request. If the `queryParams` option is provided in the config, it appends the query parameters to the URL.
+ * @param {ICanvasCallConfig | null} [config=null] - Optional configuration object for the request, including query parameters and additional fetch options like headers.
+ * @yields {T} - Yields individual items of the retrieved data from each page, one at a time.
+ *
+ * @throws {Error} - If the request fails or the URL contains "undefined", a warning is logged to the console.
+ *
+ * @example
+ * ```
+ * const generator = getPagedDataGenerator<MyDataType>('https://canvas.example.com/api/data', config);
+ * for await (const item of generator) {
+ *     console.log(item);  // Handle each item individually
+ * }
+ * ```
+ */
+export declare function getPagedDataGenerator<T extends CanvasData = CanvasData>(url: string, config?: ICanvasCallConfig | null): AsyncGenerator<T>;
+//# sourceMappingURL=getPagedDataGenerator.d.ts.map

package/dist/fetch/getPagedDataGenerator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getPagedDataGenerator.d.ts","sourceRoot":"","sources":["../../src/fetch/getPagedDataGenerator.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,UAAU,EAAC,MAAM,kBAAkB,CAAC;AAC5C,OAAO,EAAC,iBAAiB,EAAyB,MAAM,eAAe,CAAC;AAExE;;;;GAIG;AACH,wBAAsB,YAAY,CAAC,CAAC,SAAS,UAAU,GAAG,UAAU,EAChE,GAAG,EAAE,MAAM,EAAE,MAAM,GAAE,iBAAiB,GAAG,IAAW,GACrD,OAAO,CAAC,CAAC,EAAE,CAAC,CASd;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,wBAAuB,wBAAwB,CAAC,CAAC,SAAS,UAAU,GAAG,UAAU,EAAE,MAAM,GAAG,CAAC,EAAE,EAAE,UAAU,EAAE,cAAc,CAAC,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,oCAM7I;AAmCD;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,wBAAuB,qBAAqB,CAAC,CAAC,SAAS,UAAU,GAAG,UAAU,EAC1E,GAAG,EAAE,MAAM,EAAE,MAAM,GAAE,iBAAiB,GAAG,IAAW,GACrD,cAAc,CAAC,CAAC,CAAC,CAiCnB"}

package/{src/fetch/index.ts → dist/fetch/index.d.ts}

@@ -3,3 +3,4 @@ export * from './getPagedDataGenerator';
 export * from './apiWriteConfig';
 export * from './apiGetConfig';
 export * from './fetchJson';
+//# sourceMappingURL=index.d.ts.map

package/dist/fetch/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/fetch/index.ts"],"names":[],"mappings":"AAAA,cAAc,SAAS,CAAC;AACxB,cAAc,yBAAyB,CAAC;AACxC,cAAc,kBAAkB,CAAC;AACjC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,aAAa,CAAC"}

package/dist/fetch/utils.d.ts

@@ -0,0 +1,4 @@
+import { ICanvasCallConfig } from "@/canvasUtils";
+export declare function overrideConfig<ConfigType extends ICanvasCallConfig | undefined>(source: ConfigType | undefined, override: ConfigType | undefined): ConfigType;
+export declare function fetchGetConfig<CallOptions extends Record<string, any>>(options: CallOptions, baseConfig?: ICanvasCallConfig<CallOptions>): ICanvasCallConfig<CallOptions>;
+//# sourceMappingURL=utils.d.ts.map

package/dist/fetch/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../src/fetch/utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAkB,iBAAiB,EAAC,MAAM,eAAe,CAAC;AAEjE,wBAAgB,cAAc,CAAC,UAAU,SAAS,iBAAiB,GAAG,SAAS,EAC3E,MAAM,EAAE,UAAU,GAAG,SAAS,EAC9B,QAAQ,EAAE,UAAU,GAAG,SAAS,cAInC;AAED,wBAAgB,cAAc,CAAC,WAAW,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAAE,OAAO,EAAE,WAAW,EAAE,UAAU,CAAC,EAAE,iBAAiB,CAAC,WAAW,CAAC,kCAIxI"}

package/dist/files.d.ts

@@ -0,0 +1,29 @@
+export interface IFile {
+    "id": number;
+    "uuid": string;
+    "folder_id": number;
+    "display_name": string;
+    "filename": string;
+    "content-type": string;
+    "url": string;
+    "size": number;
+    "created_at": string;
+    "updated_at": string;
+    "unlock_at"?: string;
+    "locked": boolean;
+    "hidden": boolean;
+    "lock_at"?: string;
+    "hidden_for_user": boolean;
+    "visibility_level"?: "course" | "institution" | "public" | "inherit";
+    "thumbnail_url"?: string | null;
+    "modified_at": string;
+    "mime_class": string;
+    "media_entry_id"?: string;
+    "locked_for_user": boolean;
+    "lock_info"?: any;
+    "lock_explanation"?: string;
+    "preview_url"?: string;
+}
+export declare function uploadFile(file: File, folderId: number, url: string): Promise<void>;
+export declare function uploadFile(file: File, path: string, url: string): Promise<void>;
+//# sourceMappingURL=files.d.ts.map

package/dist/files.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"files.d.ts","sourceRoot":"","sources":["../src/files.ts"],"names":[],"mappings":"AAGA,MAAM,WAAW,KAAK;IAClB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,WAAW,EAAE,MAAM,CAAC;IACpB,cAAc,EAAE,MAAM,CAAC;IACvB,UAAU,EAAE,MAAM,CAAC;IACnB,cAAc,EAAE,MAAM,CAAC;IACvB,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,YAAY,EAAE,MAAM,CAAC;IACrB,YAAY,EAAE,MAAM,CAAC;IACrB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,QAAQ,EAAE,OAAO,CAAC;IAClB,QAAQ,EAAE,OAAO,CAAC;IAClB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,iBAAiB,EAAE,OAAO,CAAC;IAC3B,kBAAkB,CAAC,EAAE,QAAQ,GAAG,aAAa,GAAG,QAAQ,GAAG,SAAS,CAAC;IACrE,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAChC,aAAa,EAAE,MAAM,CAAC;IAEtB,YAAY,EAAE,MAAM,CAAC;IAErB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,iBAAiB,EAAE,OAAO,CAAC;IAC3B,WAAW,CAAC,EAAE,GAAG,CAAC;IAClB,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,aAAa,CAAC,EAAE,MAAM,CAAA;CACzB;AAED,wBAAsB,UAAU,CAAC,IAAI,EAAE,IAAI,EAAE,QAAQ,EAAC,MAAM,EAAE,GAAG,EAAC,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;AACxF,wBAAsB,UAAU,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,EAAC,MAAM,EAAE,GAAG,EAAC,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA"}

package/dist/fixes/annotations.d.ts

@@ -0,0 +1,15 @@
+import { ContentFix } from "./index";
+import { Course } from "../course/Course";
+import { Page } from "@/content/pages/Page";
+declare const contentFixes: ContentFix[];
+/**
+ * Removes annotation placeholder text from Learning Materials in the course
+ * @param course
+ */
+declare function fixLmAnnotations(course: Course): Promise<{
+    fixedPages: Page[];
+    unchangedPages: Page[];
+    failedPages: Page[];
+}>;
+export { contentFixes, fixLmAnnotations };
+//# sourceMappingURL=annotations.d.ts.map

package/dist/fixes/annotations.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"annotations.d.ts","sourceRoot":"","sources":["../../src/fixes/annotations.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,UAAU,EAAgE,MAAM,SAAS,CAAC;AAElG,OAAO,EAAC,MAAM,EAAC,MAAM,kBAAkB,CAAC;AACxC,OAAO,EAAC,IAAI,EAAC,MAAM,sBAAsB,CAAC;AAiD1C,QAAA,MAAM,YAAY,EAAE,UAAU,EAM7B,CAAA;AAGD;;;GAGG;AACH,iBAAe,gBAAgB,CAAC,MAAM,EAAC,MAAM;;;;GAoC5C;AAGD,OAAO,EAAE,YAAY,EAAE,gBAAgB,EAAE,CAAC"}

package/dist/fixes/index.d.ts

@@ -0,0 +1,36 @@
+export type ContentFix<T = string> = {
+    preflightTests?: ((potentialOutput: T) => boolean)[];
+    tests?: ((potentialOutput: T) => boolean)[];
+    run: (value: T) => T;
+};
+export type FixFailureResult<T> = {
+    failedFixes: ContentFix<T>[];
+    output: T;
+};
+/**
+ * Runs through a series of Content Fixes. If all is well, passes the results into the next
+ * content fix.
+ * Each ContentFix can have tests and preflight tests. Preflight tests are run before the fix is attempted
+ * Tests are fun after.
+ * If any of these tests fail, that content fix is not run on the text, instead passing the previous value.
+ * @param fixes
+ * @param source
+ */
+export declare function runReplacements<T extends {
+    toString: () => string;
+} = string>(fixes: ContentFix<T>[], source: T): FixFailureResult<T>;
+export declare function findReplaceFunc(find: string | RegExp, replace: string): (source: string) => string;
+/**
+ * Returns a function that returns true if passed a string that contains the find value or matches the find RegEx, false otherwise
+ * @param find A regular expression to check the input string against, or a substring to check if the input string contains
+ * @param caseSensitive (string find only) whether to match the string case sensitive-ly
+ */
+export declare function inTest(find: string | RegExp, caseSensitive?: boolean): (source: string) => boolean;
+/**
+ * Returns a function that returns false if passed a string that contains the find value or matches the find RegEx, true otherwise
+ * @param find A regular expression to check the input string against, or a substring to check if the input string contains
+ * @param caseSensitive (string find only) whether to match the string case sensitive-ly
+ */
+export declare function notInTest(find: string | RegExp, caseSensitive?: boolean): (source: string) => boolean;
+export * from './annotations';
+//# sourceMappingURL=index.d.ts.map

package/dist/fixes/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/fixes/index.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,UAAU,CAAC,CAAC,GAAG,MAAM,IAAI;IACjC,cAAc,CAAC,EAAE,CAAC,CAAC,eAAe,EAAE,CAAC,KAAK,OAAO,CAAC,EAAE,CAAC;IACrD,KAAK,CAAC,EAAE,CAAC,CAAC,eAAe,EAAE,CAAC,KAAK,OAAO,CAAC,EAAE,CAAC;IAC5C,GAAG,EAAE,CAAC,KAAK,EAAE,CAAC,KAAK,CAAC,CAAA;CACvB,CAAA;AAED,MAAM,MAAM,gBAAgB,CAAC,CAAC,IAAI;IAC9B,WAAW,EAAE,UAAU,CAAC,CAAC,CAAC,EAAE,CAAC;IAC7B,MAAM,EAAE,CAAC,CAAA;CACZ,CAAA;AACD;;;;;;;;GAQG;AACH,wBAAgB,eAAe,CAAC,CAAC,SAAS;IAAC,QAAQ,EAAC,MAAI,MAAM,CAAA;CAAC,GAAG,MAAM,EAAE,KAAK,EAAE,UAAU,CAAC,CAAC,CAAC,EAAE,EAAE,MAAM,EAAE,CAAC,GAcvE,gBAAgB,CAAC,CAAC,CAAC,CACtD;AAED,wBAAgB,eAAe,CAAC,IAAI,EAAC,MAAM,GAAC,MAAM,EAAE,OAAO,EAAC,MAAM,IACtD,QAAQ,MAAM,YAIzB;AAED;;;;GAIG;AACH,wBAAgB,MAAM,CAAC,IAAI,EAAC,MAAM,GAAC,MAAM,EAAE,aAAa,UAAK,YAGrC,MAAM,aAQ7B;AAED;;;;GAIG;AACH,wBAAgB,SAAS,CAAC,IAAI,EAAE,MAAM,GAAC,MAAM,EAAE,aAAa,UAAO,YAG3C,MAAM,aAS7B;AAED,cAAc,eAAe,CAAA"}

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

@@ -1,15 +1,10 @@
-export {getTermsGenerator} from "@/term/getTermsGenerator";
-export {mockCourseData} from "@/course/__mocks__/mockCourseData";
+export { getTermsGenerator } from "@/term/getTermsGenerator";
+export { mockCourseData } from "@/course/__mocks__/mockCourseData";
 export * from "@/course/__mocks__/mockModuleData";
 export * from './baseCanvasObject';
-
-export {NotImplementedException} from './NotImplementedException';
-
+export { NotImplementedException } from './NotImplementedException';
 export * from './rubrics';
-
 export * from "./rubricTypes";
-
-
 export * from './canvasDataDefs';
 export * from './enrollments';
 export * from './term';
@@ -25,5 +20,5 @@ export * from './date';
 export * from './types';
 export * from './fetch';
 export * from './canvasUtils';
-
-export * as mocks from './__mocks__'
+export * as mocks from './__mocks__';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,iBAAiB,EAAC,MAAM,0BAA0B,CAAC;AAC3D,OAAO,EAAC,cAAc,EAAC,MAAM,mCAAmC,CAAC;AACjE,cAAc,mCAAmC,CAAC;AAClD,cAAc,oBAAoB,CAAC;AAEnC,OAAO,EAAC,uBAAuB,EAAC,MAAM,2BAA2B,CAAC;AAElE,cAAc,WAAW,CAAC;AAE1B,cAAc,eAAe,CAAC;AAG9B,cAAc,kBAAkB,CAAC;AACjC,cAAc,eAAe,CAAC;AAC9B,cAAc,QAAQ,CAAC;AACvB,cAAc,WAAW,CAAC;AAC1B,cAAc,UAAU,CAAC;AACzB,cAAc,SAAS,CAAC;AACxB,cAAc,WAAW,CAAC;AAC1B,cAAc,WAAW,CAAC;AAC1B,cAAc,SAAS,CAAC;AACxB,cAAc,WAAW,CAAC;AAC1B,cAAc,2BAA2B,CAAC;AAC1C,cAAc,QAAQ,CAAC;AACvB,cAAc,SAAS,CAAC;AACxB,cAAc,SAAS,CAAC;AACxB,cAAc,eAAe,CAAC;AAE9B,OAAO,KAAK,KAAK,MAAM,aAAa,CAAA"}