schoolinfo API

packages/datadirect-puppeteer/src/api.ts

@@ -2,3 +2,4 @@ export * as assessment from './api/assessment.js';
 export * as Assignment2 from './api/Assignment2.js';
 export * as datadirect from './api/datadirect.js';
 export * as LtiTool from './api/LtiTool.js';
+export * as schoolinfo from './api/schoolinfo.js';

packages/datadirect-puppeteer/src/api/schoolinfo.ts

@@ -0,0 +1,4 @@
+import { schoolparams as S } from 'datadirect/dist/api/schoolinfo.js';
+import { fetchViaPuppeteer } from './fetchViaPuppeteer.js';
+
+export const schoolparams = fetchViaPuppeteer<S.Payload, S.Response>(S);

packages/datadirect/src/api.ts

@@ -3,3 +3,4 @@ export * as Assignment2 from './api/Assignment2.js';
 export * as datadirect from './api/datadirect.js';
 export * as Endpoint from './api/Endpoint.js';
 export * as LtiTool from './api/LtiTool.js';
+export * as schoolinfo from './api/schoolinfo.js';

packages/datadirect/src/api/schoolinfo.ts

@@ -0,0 +1 @@
+export * as schoolparams from './schoolinfo/schoolparams.js';

packages/datadirect/src/api/schoolinfo/schoolparams.ts

@@ -0,0 +1,8 @@
+import * as Endpoint from '../Endpoint.js';
+import { Payload } from './schoolparams/Payload.js';
+
+export * from './schoolparams/Payload.js';
+export * from './schoolparams/Response.js';
+
+export const prepare: Endpoint.Prepare<Payload> = (payload, base?: string) =>
+  Endpoint.prepare({ payload, base, path: '/api/schoolinfo/schoolparams' });

packages/datadirect/src/api/schoolinfo/schoolparams/Payload.ts

@@ -0,0 +1 @@
+export type Payload = { all?: boolean };

packages/datadirect/src/api/schoolinfo/schoolparams/Response.ts

@@ -0,0 +1,42 @@
+export type Response = {
+  SchoolId: number;
+  SchoolName: string;
+  HoursFromServer: number;
+  AppLocaleId: number;
+  LocaleId: number;
+  Timezone: string;
+  DatabaseTimezone: string;
+  LiveUrl: URLString;
+  Username: string;
+  PortalMyBeforeSchool: boolean;
+  PortalDisplayLabel: string;
+  MailboxName: EmailString;
+  HelplinkText: string;
+  SignInOption: number;
+  LocalDateTime: DateTimeString;
+  ServerDateTime: DateTimeString;
+  IndividualMessageEnabled: boolean;
+  BulkMessageEnabled: boolean;
+  BulkEmailEnabled: boolean;
+  HasPodiumSite: boolean;
+  PodiumFrontendStatus: 2;
+  NameFormat: string;
+  ShowFeaturedContent: NumericBoolean;
+  ShowRecentActivity: NumericBoolean;
+  ShowScoreboard: NumericBoolean;
+  ShowArchivedContent: NumericBoolean;
+  AppCultureName: string;
+  CultureName: string;
+  EncCookieSiteUrl: string;
+  ShowAttendance: NumericBoolean;
+  BBSiteID: NumericString;
+  AllowRubricBankAdd: boolean;
+  IsSmallCollege: boolean;
+  MobileSiteInd: boolean;
+  SSLInd: boolean;
+  LoginRedirectInd: boolean;
+  LoginNameLabel: string;
+  DbNum: number;
+  DbDate: DateTimeString;
+  TestSchool: boolean;
+};

packages/myschoolapp-reporting/src/workflows/Download/Spider.ts

@@ -93,6 +93,10 @@ export class Spider {
               exclude,
               haltOnError
             });
+            /*
+             * FIXME FileName files in topics are at /ftpimages/:SchoolId/topics/:FileName
+             *   :SchoolId can be determined by calling `/api/schoolinfo/schoolparams`
+             */
           } else if (
             /Url$/i.test(key) ||
             (/FilePath$/i.test(key) &&