@groton/canvas-api 0.3.4 → 0.3.6

package/dist/Resources/Users.d.ts

@@ -345,6 +345,57 @@ export type PageViewLinks = {
      */
     account: number | string;
 };
+/**
+ * Error response structure returned by the API when validation or processing
+ * failures occur
+ */
+export type AsyncApiErrorResponse = {
+    /** Array of error messages describing what went wrong with the request */
+    errors: string[];
+};
+/** Response returned when successfully initiating a page views query */
+export type AsyncQueryResponse = {
+    /**
+     * URL endpoint to poll for query status updates
+     *
+     * Format: 'uri'
+     */
+    poll_url: string;
+};
+/** Response containing the current status of a page views query */
+export type AsyncQueryStatusResponse = {
+    /**
+     * The UUID of the query being polled
+     *
+     * Format: 'uuid'
+     */
+    query_id: string;
+    /** Current processing status of the query */
+    status: string;
+    /** The format that results will be returned in */
+    format: string;
+    /**
+     * URL to retrieve query results. Only present when status is 'finished'
+     *
+     * Format: 'uri'
+     */
+    results_url: string;
+};
+/** File download response containing page views query results */
+export type AsyncQueryResultsResponse = {
+    /**
+     * The query results data in the requested format (CSV or JSON)
+     *
+     * Format: 'binary'
+     */
+    content: string;
+    /** Suggested filename for the downloaded results */
+    filename: string;
+    /** MIME type of the response content */
+    content_type: string;
+    /** Content encoding if the response is compressed */
+    content_encoding: string;
+};
 export type CourseNickname = {
     /**
      * The ID of the course

package/dist/Resources/WhatIfGrades.d.ts

@@ -1,3 +1,4 @@
+import { JSONValue } from '@battis/typescript-tricks';
 export type Grade = {
     /**
      * The grade for the course
@@ -18,7 +19,7 @@ export type Grade = {
      */
     possible: number | string;
     /** The dropped grades for the course */
-    dropped: unknown;
+    dropped: JSONValue;
 };
 export type AssignmentGroupGrade = {
     /**
@@ -58,7 +59,7 @@ export type AssignmentGroupGrade = {
      */
     grade: number | string;
     /** The dropped grades for the Assignment Group */
-    dropped: unknown;
+    dropped: JSONValue;
 };
 export type GradeGroup = {
     submission_id: AssignmentGroupGrade;

package/dist/Resources/index.d.ts

@@ -1,9 +1,11 @@
+export * as AccessTokens from './AccessTokens.js';
 export * as AccountCalendars from './AccountCalendars.js';
 export * as AccountNotifications from './AccountNotifications.js';
 export * as AccountReports from './AccountReports.js';
 export * as AccountsLti from './Accounts(lti).js';
 export * as Accounts from './Accounts.js';
 export * as Admins from './Admins.js';
+export * as AiExperiences from './AiExperiences.js';
 export * as AnnouncementExternalFeeds from './AnnouncementExternalFeeds.js';
 export * as ApiTokenScopes from './ApiTokenScopes.js';
 export * as AppointmentGroups from './AppointmentGroups.js';
@@ -40,6 +42,7 @@ export * as EnrollmentTerms from './EnrollmentTerms.js';
 export * as EPortfolios from './EPortfolios.js';
 export * as EPubExports from './EPubExports.js';
 export * as ErrorReports from './ErrorReports.js';
+export * as ExternalTools from './ExternalTools.js';
 export * as Favorites from './Favorites.js';
 export * as FeatureFlags from './FeatureFlags.js';
 export * as Files from './Files.js';

package/dist/Resources/index.js

@@ -1,9 +1,11 @@
+export * as AccessTokens from './AccessTokens.js';
 export * as AccountCalendars from './AccountCalendars.js';
 export * as AccountNotifications from './AccountNotifications.js';
 export * as AccountReports from './AccountReports.js';
 export * as AccountsLti from './Accounts(lti).js';
 export * as Accounts from './Accounts.js';
 export * as Admins from './Admins.js';
+export * as AiExperiences from './AiExperiences.js';
 export * as AnnouncementExternalFeeds from './AnnouncementExternalFeeds.js';
 export * as ApiTokenScopes from './ApiTokenScopes.js';
 export * as AppointmentGroups from './AppointmentGroups.js';
@@ -40,6 +42,7 @@ export * as EnrollmentTerms from './EnrollmentTerms.js';
 export * as EPortfolios from './EPortfolios.js';
 export * as EPubExports from './EPubExports.js';
 export * as ErrorReports from './ErrorReports.js';
+export * as ExternalTools from './ExternalTools.js';
 export * as Favorites from './Favorites.js';
 export * as FeatureFlags from './FeatureFlags.js';
 export * as Files from './Files.js';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@groton/canvas-api",
-  "version": "0.3.4",
+  "version": "0.3.6",
   "description": "Typed access to Canvas LMS API with embedded documentation",
   "homepage": "https://github.com/groton-school/canvas-cli/tree/main/packages/api/canvas-api#readme",
   "repository": {
@@ -16,19 +16,18 @@
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "dependencies": {
-    "node-fetch": "^3.3.2",
-    "@groton/canvas-api.utilities": "0.2.0",
-    "@groton/canvas-api.client.base": "0.2.0"
+    "@groton/canvas-api.utilities": "0.2.1",
+    "@groton/canvas-api.client.base": "0.3.0"
   },
   "devDependencies": {
-    "@battis/descriptive-types": "^0.2.3",
-    "@battis/typescript-tricks": "^0.7.4",
-    "@tsconfig/node20": "^20.1.6",
-    "commit-and-tag-version": "^12.5.2",
+    "@battis/descriptive-types": "^0.2.6",
+    "@battis/typescript-tricks": "^0.7.6",
+    "@tsconfig/node24": "^24.0.3",
+    "commit-and-tag-version": "^12.6.1",
     "del-cli": "^6.0.0",
     "npm-run-all": "^4.1.5",
     "typescript": "~5.8.3",
-    "@groton/canvas-api.swagger-renderer": "0.1.2"
+    "@groton/canvas-api.swagger-renderer": "0.1.4"
   },
   "scripts": {
     "clean": "run-s clean:*",
@@ -36,8 +35,9 @@
     "clean:compilation": "del ./dist",
     "spec": "run-s spec:*",
     "spec:clean": "del ./spec",
-    "spec:download": "source .env; swagger-renderer download --instanceUrl \"$INSTANCE_URL\"",
+    "spec:download": "swagger-renderer download",
     "build": "run-s build:*",
+    "build:spec": "node -e \"if(!require('fs').existsSync('./spec')){process.exit(1)}\" || run-s spec",
     "build:clean": "run-s clean",
     "build:render": "swagger-renderer render --overridePath ./overrides.json --modelDirName Resources --operationsDirName Endpoints --map --logFilePath ./var/render.log",
     "build:compile": "tsc",