politeshop 0.0.1

package/dist/schema/polite.d.ts

@@ -0,0 +1,809 @@
+/**
+ * Zod schemas for POLITE API (*.polite.edu.sg) responses.
+ * Adapted from https://docs.valence.desire2learn.com/reference.html.
+ * These schemas only cover the parts of the API used by POLITEShop.
+ */
+import { z } from "zod";
+/** Response from GET /d2l/lp/auth/oauth2/token */
+export declare const brightspaceToken: z.ZodObject<{
+    access_token: z.ZodString;
+    expires_at: z.ZodNumber;
+}, "strip", z.ZodTypeAny, {
+    access_token: string;
+    expires_at: number;
+}, {
+    access_token: string;
+    expires_at: number;
+}>;
+export type BrightspaceToken = z.infer<typeof brightspaceToken>;
+/** https://docs.valence.desire2learn.com/res/user.html#User.WhoAmIUser */
+export declare const whoAmIUser: z.ZodObject<{
+    Identifier: z.ZodString;
+    FirstName: z.ZodString;
+    LastName: z.ZodString;
+    /** POLITEMall uses this as the user's email address. */
+    UniqueName: z.ZodString;
+    ProfileIdentifier: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    Identifier: string;
+    FirstName: string;
+    LastName: string;
+    UniqueName: string;
+    ProfileIdentifier: string;
+}, {
+    Identifier: string;
+    FirstName: string;
+    LastName: string;
+    UniqueName: string;
+    ProfileIdentifier: string;
+}>;
+export type WhoAmIUser = z.infer<typeof whoAmIUser>;
+/** https://docs.valence.desire2learn.com/res/orgunit.html#Org.Organization */
+export declare const organization: z.ZodObject<{
+    Identifier: z.ZodString;
+    Name: z.ZodString;
+    TimeZone: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    Identifier: string;
+    Name: string;
+    TimeZone: string;
+}, {
+    Identifier: string;
+    Name: string;
+    TimeZone: string;
+}>;
+export type Organization = z.infer<typeof organization>;
+/** https://docs.valence.desire2learn.com/res/enroll.html#Enrollment.MyOrgUnitInfo */
+export declare const myOrgUnitInfo: z.ZodObject<{
+    OrgUnit: z.ZodObject<{
+        Id: z.ZodNumber;
+        Type: z.ZodObject<{
+            Id: z.ZodNumber;
+            Code: z.ZodString;
+            Name: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            Name: string;
+            Id: number;
+            Code: string;
+        }, {
+            Name: string;
+            Id: number;
+            Code: string;
+        }>;
+        Name: z.ZodString;
+        Code: z.ZodNullable<z.ZodString>;
+        HomeUrl: z.ZodNullable<z.ZodString>;
+        ImageUrl: z.ZodNullable<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        Name: string;
+        Id: number;
+        Type: {
+            Name: string;
+            Id: number;
+            Code: string;
+        };
+        Code: string | null;
+        HomeUrl: string | null;
+        ImageUrl: string | null;
+    }, {
+        Name: string;
+        Id: number;
+        Type: {
+            Name: string;
+            Id: number;
+            Code: string;
+        };
+        Code: string | null;
+        HomeUrl: string | null;
+        ImageUrl: string | null;
+    }>;
+}, "strip", z.ZodTypeAny, {
+    OrgUnit: {
+        Name: string;
+        Id: number;
+        Type: {
+            Name: string;
+            Id: number;
+            Code: string;
+        };
+        Code: string | null;
+        HomeUrl: string | null;
+        ImageUrl: string | null;
+    };
+}, {
+    OrgUnit: {
+        Name: string;
+        Id: number;
+        Type: {
+            Name: string;
+            Id: number;
+            Code: string;
+        };
+        Code: string | null;
+        HomeUrl: string | null;
+        ImageUrl: string | null;
+    };
+}>;
+export type MyOrgUnitInfo = z.infer<typeof myOrgUnitInfo>;
+export declare const courseParent: z.ZodObject<{
+    CourseOfferingId: z.ZodString;
+    Semester: z.ZodObject<{
+        Identifier: z.ZodString;
+        Name: z.ZodString;
+        Code: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        Identifier: string;
+        Name: string;
+        Code: string;
+    }, {
+        Identifier: string;
+        Name: string;
+        Code: string;
+    }>;
+    Department: z.ZodObject<{
+        Identifier: z.ZodString;
+        Name: z.ZodString;
+        Code: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        Identifier: string;
+        Name: string;
+        Code: string;
+    }, {
+        Identifier: string;
+        Name: string;
+        Code: string;
+    }>;
+}, "strip", z.ZodTypeAny, {
+    CourseOfferingId: string;
+    Semester: {
+        Identifier: string;
+        Name: string;
+        Code: string;
+    };
+    Department: {
+        Identifier: string;
+        Name: string;
+        Code: string;
+    };
+}, {
+    CourseOfferingId: string;
+    Semester: {
+        Identifier: string;
+        Name: string;
+        Code: string;
+    };
+    Department: {
+        Identifier: string;
+        Name: string;
+        Code: string;
+    };
+}>;
+export type CourseParent = z.infer<typeof courseParent>;
+declare const richText: z.ZodObject<{
+    Text: z.ZodString;
+    Html: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    Text: string;
+    Html: string;
+}, {
+    Text: string;
+    Html: string;
+}>;
+export type RichText = z.infer<typeof richText>;
+/**
+ * `ToC.Topic` of https://docs.valence.desire2learn.com/res/content.html#ToC.TableOfContents
+ *
+ * ActivityType values:
+ *   1 = File / ContentService
+ *   2 = Link (web embed)
+ *   3 = Dropbox (submission)
+ *   4 = Quiz
+ */
+export declare const tocTopic: z.ZodIntersection<z.ZodObject<{
+    Identifier: z.ZodString;
+    /** Same identifier as `Identifier`, but as a number. */
+    TopicId: z.ZodNumber;
+    Title: z.ZodString;
+    Description: z.ZodObject<{
+        Text: z.ZodString;
+        Html: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        Text: string;
+        Html: string;
+    }, {
+        Text: string;
+        Html: string;
+    }>;
+    ActivityType: z.ZodNumber;
+    TypeIdentifier: z.ZodEnum<["Link", "File", "ContentService"]>;
+    Unread: z.ZodBoolean;
+    ToolId: z.ZodNullable<z.ZodNumber>;
+    ToolItemId: z.ZodNullable<z.ZodNumber>;
+    SortOrder: z.ZodNumber;
+}, "strip", z.ZodTypeAny, {
+    Identifier: string;
+    TopicId: number;
+    Title: string;
+    Description: {
+        Text: string;
+        Html: string;
+    };
+    ActivityType: number;
+    TypeIdentifier: "Link" | "File" | "ContentService";
+    Unread: boolean;
+    ToolId: number | null;
+    ToolItemId: number | null;
+    SortOrder: number;
+}, {
+    Identifier: string;
+    TopicId: number;
+    Title: string;
+    Description: {
+        Text: string;
+        Html: string;
+    };
+    ActivityType: number;
+    TypeIdentifier: "Link" | "File" | "ContentService";
+    Unread: boolean;
+    ToolId: number | null;
+    ToolItemId: number | null;
+    SortOrder: number;
+}>, z.ZodUnion<[z.ZodObject<{
+    IsBroken: z.ZodLiteral<false>;
+    Url: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    IsBroken: false;
+    Url: string;
+}, {
+    IsBroken: false;
+    Url: string;
+}>, z.ZodObject<{
+    IsBroken: z.ZodLiteral<true>;
+    Url: z.ZodNullable<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    IsBroken: true;
+    Url: string | null;
+}, {
+    IsBroken: true;
+    Url: string | null;
+}>]>>;
+export type TOCTopic = z.infer<typeof tocTopic>;
+declare const baseModule: z.ZodObject<{
+    ModuleId: z.ZodNumber;
+    Title: z.ZodString;
+    Description: z.ZodObject<{
+        Text: z.ZodString;
+        Html: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        Text: string;
+        Html: string;
+    }, {
+        Text: string;
+        Html: string;
+    }>;
+    SortOrder: z.ZodNumber;
+    Topics: z.ZodArray<z.ZodIntersection<z.ZodObject<{
+        Identifier: z.ZodString;
+        /** Same identifier as `Identifier`, but as a number. */
+        TopicId: z.ZodNumber;
+        Title: z.ZodString;
+        Description: z.ZodObject<{
+            Text: z.ZodString;
+            Html: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            Text: string;
+            Html: string;
+        }, {
+            Text: string;
+            Html: string;
+        }>;
+        ActivityType: z.ZodNumber;
+        TypeIdentifier: z.ZodEnum<["Link", "File", "ContentService"]>;
+        Unread: z.ZodBoolean;
+        ToolId: z.ZodNullable<z.ZodNumber>;
+        ToolItemId: z.ZodNullable<z.ZodNumber>;
+        SortOrder: z.ZodNumber;
+    }, "strip", z.ZodTypeAny, {
+        Identifier: string;
+        TopicId: number;
+        Title: string;
+        Description: {
+            Text: string;
+            Html: string;
+        };
+        ActivityType: number;
+        TypeIdentifier: "Link" | "File" | "ContentService";
+        Unread: boolean;
+        ToolId: number | null;
+        ToolItemId: number | null;
+        SortOrder: number;
+    }, {
+        Identifier: string;
+        TopicId: number;
+        Title: string;
+        Description: {
+            Text: string;
+            Html: string;
+        };
+        ActivityType: number;
+        TypeIdentifier: "Link" | "File" | "ContentService";
+        Unread: boolean;
+        ToolId: number | null;
+        ToolItemId: number | null;
+        SortOrder: number;
+    }>, z.ZodUnion<[z.ZodObject<{
+        IsBroken: z.ZodLiteral<false>;
+        Url: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        IsBroken: false;
+        Url: string;
+    }, {
+        IsBroken: false;
+        Url: string;
+    }>, z.ZodObject<{
+        IsBroken: z.ZodLiteral<true>;
+        Url: z.ZodNullable<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        IsBroken: true;
+        Url: string | null;
+    }, {
+        IsBroken: true;
+        Url: string | null;
+    }>]>>, "many">;
+}, "strip", z.ZodTypeAny, {
+    Title: string;
+    Description: {
+        Text: string;
+        Html: string;
+    };
+    SortOrder: number;
+    ModuleId: number;
+    Topics: ({
+        Identifier: string;
+        TopicId: number;
+        Title: string;
+        Description: {
+            Text: string;
+            Html: string;
+        };
+        ActivityType: number;
+        TypeIdentifier: "Link" | "File" | "ContentService";
+        Unread: boolean;
+        ToolId: number | null;
+        ToolItemId: number | null;
+        SortOrder: number;
+    } & ({
+        IsBroken: false;
+        Url: string;
+    } | {
+        IsBroken: true;
+        Url: string | null;
+    }))[];
+}, {
+    Title: string;
+    Description: {
+        Text: string;
+        Html: string;
+    };
+    SortOrder: number;
+    ModuleId: number;
+    Topics: ({
+        Identifier: string;
+        TopicId: number;
+        Title: string;
+        Description: {
+            Text: string;
+            Html: string;
+        };
+        ActivityType: number;
+        TypeIdentifier: "Link" | "File" | "ContentService";
+        Unread: boolean;
+        ToolId: number | null;
+        ToolItemId: number | null;
+        SortOrder: number;
+    } & ({
+        IsBroken: false;
+        Url: string;
+    } | {
+        IsBroken: true;
+        Url: string | null;
+    }))[];
+}>;
+export type TOCModule = z.infer<typeof baseModule> & {
+    Modules: TOCModule[];
+};
+/**
+ * Brightspace calls these "Module" objects but POLITEShop calls them "activity folders".
+ * `ToC.Module` of https://docs.valence.desire2learn.com/res/content.html#ToC.TableOfContents
+ */
+export declare const tocModule: z.ZodType<TOCModule>;
+/** https://docs.valence.desire2learn.com/res/content.html#ToC.TableOfContents */
+export declare const tableOfContents: z.ZodObject<{
+    Modules: z.ZodArray<z.ZodType<TOCModule, z.ZodTypeDef, TOCModule>, "many">;
+}, "strip", z.ZodTypeAny, {
+    Modules: TOCModule[];
+}, {
+    Modules: TOCModule[];
+}>;
+export type TableOfContents = z.infer<typeof tableOfContents>;
+/** https://docs.valence.desire2learn.com/res/dropbox.html#Dropbox.EntityDropbox */
+export declare const entityDropbox: z.ZodObject<{
+    CompletionDate: z.ZodNullable<z.ZodString>;
+    Submissions: z.ZodArray<z.ZodObject<{
+        Id: z.ZodNumber;
+        SubmissionDate: z.ZodNullable<z.ZodDate>;
+        Comment: z.ZodObject<{
+            Text: z.ZodString;
+            Html: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            Text: string;
+            Html: string;
+        }, {
+            Text: string;
+            Html: string;
+        }>;
+        Files: z.ZodArray<z.ZodObject<{
+            FileId: z.ZodNumber;
+            FileName: z.ZodString;
+            Size: z.ZodNumber;
+        }, "strip", z.ZodTypeAny, {
+            FileId: number;
+            FileName: string;
+            Size: number;
+        }, {
+            FileId: number;
+            FileName: string;
+            Size: number;
+        }>, "many">;
+    }, "strip", z.ZodTypeAny, {
+        Id: number;
+        SubmissionDate: Date | null;
+        Comment: {
+            Text: string;
+            Html: string;
+        };
+        Files: {
+            FileId: number;
+            FileName: string;
+            Size: number;
+        }[];
+    }, {
+        Id: number;
+        SubmissionDate: Date | null;
+        Comment: {
+            Text: string;
+            Html: string;
+        };
+        Files: {
+            FileId: number;
+            FileName: string;
+            Size: number;
+        }[];
+    }>, "many">;
+}, "strip", z.ZodTypeAny, {
+    CompletionDate: string | null;
+    Submissions: {
+        Id: number;
+        SubmissionDate: Date | null;
+        Comment: {
+            Text: string;
+            Html: string;
+        };
+        Files: {
+            FileId: number;
+            FileName: string;
+            Size: number;
+        }[];
+    }[];
+}, {
+    CompletionDate: string | null;
+    Submissions: {
+        Id: number;
+        SubmissionDate: Date | null;
+        Comment: {
+            Text: string;
+            Html: string;
+        };
+        Files: {
+            FileId: number;
+            FileName: string;
+            Size: number;
+        }[];
+    }[];
+}>;
+export type EntityDropbox = z.infer<typeof entityDropbox>;
+/** https://docs.valence.desire2learn.com/res/dropbox.html#Dropbox.DropboxFolder */
+export declare const dropboxFolder: z.ZodObject<{
+    Id: z.ZodNumber;
+    Name: z.ZodString;
+    CustomInstructions: z.ZodObject<{
+        Text: z.ZodString;
+        Html: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        Text: string;
+        Html: string;
+    }, {
+        Text: string;
+        Html: string;
+    }>;
+    Attachments: z.ZodArray<z.ZodObject<{
+        FileId: z.ZodNumber;
+        FileName: z.ZodString;
+        Size: z.ZodNumber;
+    }, "strip", z.ZodTypeAny, {
+        FileId: number;
+        FileName: string;
+        Size: number;
+    }, {
+        FileId: number;
+        FileName: string;
+        Size: number;
+    }>, "many">;
+    DueDate: z.ZodNullable<z.ZodDate>;
+    SubmissionType: z.ZodLiteral<0>;
+    CompletionType: z.ZodNumber;
+    Availability: z.ZodNullable<z.ZodObject<{
+        StartDate: z.ZodNullable<z.ZodDate>;
+        EndDate: z.ZodNullable<z.ZodDate>;
+        StartDateAvailabilityType: z.ZodNullable<z.ZodNumber>;
+        EndDateAvailabilityType: z.ZodNullable<z.ZodNumber>;
+    }, "strip", z.ZodTypeAny, {
+        StartDate: Date | null;
+        EndDate: Date | null;
+        StartDateAvailabilityType: number | null;
+        EndDateAvailabilityType: number | null;
+    }, {
+        StartDate: Date | null;
+        EndDate: Date | null;
+        StartDateAvailabilityType: number | null;
+        EndDateAvailabilityType: number | null;
+    }>>;
+}, "strip", z.ZodTypeAny, {
+    Name: string;
+    Id: number;
+    CustomInstructions: {
+        Text: string;
+        Html: string;
+    };
+    Attachments: {
+        FileId: number;
+        FileName: string;
+        Size: number;
+    }[];
+    DueDate: Date | null;
+    SubmissionType: 0;
+    CompletionType: number;
+    Availability: {
+        StartDate: Date | null;
+        EndDate: Date | null;
+        StartDateAvailabilityType: number | null;
+        EndDateAvailabilityType: number | null;
+    } | null;
+}, {
+    Name: string;
+    Id: number;
+    CustomInstructions: {
+        Text: string;
+        Html: string;
+    };
+    Attachments: {
+        FileId: number;
+        FileName: string;
+        Size: number;
+    }[];
+    DueDate: Date | null;
+    SubmissionType: 0;
+    CompletionType: number;
+    Availability: {
+        StartDate: Date | null;
+        EndDate: Date | null;
+        StartDateAvailabilityType: number | null;
+        EndDateAvailabilityType: number | null;
+    } | null;
+}>;
+export type DropboxFolder = z.infer<typeof dropboxFolder>;
+/** https://docs.valence.desire2learn.com/res/quiz.html#Quiz.QuizReadData */
+export declare const quizReadData: z.ZodObject<{
+    QuizId: z.ZodNumber;
+    Name: z.ZodString;
+    Instructions: z.ZodObject<{
+        Text: z.ZodObject<{
+            Text: z.ZodString;
+            Html: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            Text: string;
+            Html: string;
+        }, {
+            Text: string;
+            Html: string;
+        }>;
+        IsDisplayed: z.ZodBoolean;
+    }, "strip", z.ZodTypeAny, {
+        Text: {
+            Text: string;
+            Html: string;
+        };
+        IsDisplayed: boolean;
+    }, {
+        Text: {
+            Text: string;
+            Html: string;
+        };
+        IsDisplayed: boolean;
+    }>;
+    Description: z.ZodObject<{
+        Text: z.ZodObject<{
+            Text: z.ZodString;
+            Html: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            Text: string;
+            Html: string;
+        }, {
+            Text: string;
+            Html: string;
+        }>;
+        IsDisplayed: z.ZodBoolean;
+    }, "strip", z.ZodTypeAny, {
+        Text: {
+            Text: string;
+            Html: string;
+        };
+        IsDisplayed: boolean;
+    }, {
+        Text: {
+            Text: string;
+            Html: string;
+        };
+        IsDisplayed: boolean;
+    }>;
+    StartDate: z.ZodDate;
+    EndDate: z.ZodDate;
+    DueDate: z.ZodNullable<z.ZodDate>;
+    SortOrder: z.ZodNumber;
+    SubmissionTimeLimit: z.ZodObject<{
+        IsEnforced: z.ZodBoolean;
+        ShowClock: z.ZodBoolean;
+        TimeLimitValue: z.ZodNumber;
+    }, "strip", z.ZodTypeAny, {
+        IsEnforced: boolean;
+        ShowClock: boolean;
+        TimeLimitValue: number;
+    }, {
+        IsEnforced: boolean;
+        ShowClock: boolean;
+        TimeLimitValue: number;
+    }>;
+    AttemptsAllowed: z.ZodObject<{
+        IsUnlimited: z.ZodBoolean;
+        NumberOfAttemptsAllowed: z.ZodNullable<z.ZodNumber>;
+    }, "strip", z.ZodTypeAny, {
+        IsUnlimited: boolean;
+        NumberOfAttemptsAllowed: number | null;
+    }, {
+        IsUnlimited: boolean;
+        NumberOfAttemptsAllowed: number | null;
+    }>;
+    CalcTypeId: z.ZodNumber;
+    Shuffle: z.ZodBoolean;
+}, "strip", z.ZodTypeAny, {
+    Name: string;
+    Description: {
+        Text: {
+            Text: string;
+            Html: string;
+        };
+        IsDisplayed: boolean;
+    };
+    SortOrder: number;
+    DueDate: Date | null;
+    StartDate: Date;
+    EndDate: Date;
+    QuizId: number;
+    Instructions: {
+        Text: {
+            Text: string;
+            Html: string;
+        };
+        IsDisplayed: boolean;
+    };
+    SubmissionTimeLimit: {
+        IsEnforced: boolean;
+        ShowClock: boolean;
+        TimeLimitValue: number;
+    };
+    AttemptsAllowed: {
+        IsUnlimited: boolean;
+        NumberOfAttemptsAllowed: number | null;
+    };
+    CalcTypeId: number;
+    Shuffle: boolean;
+}, {
+    Name: string;
+    Description: {
+        Text: {
+            Text: string;
+            Html: string;
+        };
+        IsDisplayed: boolean;
+    };
+    SortOrder: number;
+    DueDate: Date | null;
+    StartDate: Date;
+    EndDate: Date;
+    QuizId: number;
+    Instructions: {
+        Text: {
+            Text: string;
+            Html: string;
+        };
+        IsDisplayed: boolean;
+    };
+    SubmissionTimeLimit: {
+        IsEnforced: boolean;
+        ShowClock: boolean;
+        TimeLimitValue: number;
+    };
+    AttemptsAllowed: {
+        IsUnlimited: boolean;
+        NumberOfAttemptsAllowed: number | null;
+    };
+    CalcTypeId: number;
+    Shuffle: boolean;
+}>;
+export type QuizReadData = z.infer<typeof quizReadData>;
+/**
+ * Wraps a schema in an
+ * [ObjectListPage](https://docs.valence.desire2learn.com/basic/apicall.html#Api.ObjectListPage).
+ */
+export declare function objectListPage<T extends z.ZodTypeAny>(s: T): z.ZodObject<{
+    Next: z.ZodNullable<z.ZodString>;
+    Objects: z.ZodArray<T, "many">;
+}, "strip", z.ZodTypeAny, {
+    Next: string | null;
+    Objects: T["_output"][];
+}, {
+    Next: string | null;
+    Objects: T["_input"][];
+}>;
+export type ObjectListPage<T> = {
+    Next: string | null;
+    Objects: T[];
+};
+/**
+ * Wraps a schema in a
+ * [PagedResultSet](https://docs.valence.desire2learn.com/basic/apicall.html#Api.PagedResultSet).
+ */
+export declare function pagedResultSet<T extends z.ZodTypeAny>(s: T): z.ZodObject<{
+    PagingInfo: z.ZodObject<{
+        Bookmark: z.ZodString;
+        HasMoreItems: z.ZodBoolean;
+    }, "strip", z.ZodTypeAny, {
+        Bookmark: string;
+        HasMoreItems: boolean;
+    }, {
+        Bookmark: string;
+        HasMoreItems: boolean;
+    }>;
+    Items: z.ZodArray<T, "many">;
+}, "strip", z.ZodTypeAny, {
+    PagingInfo: {
+        Bookmark: string;
+        HasMoreItems: boolean;
+    };
+    Items: T["_output"][];
+}, {
+    PagingInfo: {
+        Bookmark: string;
+        HasMoreItems: boolean;
+    };
+    Items: T["_input"][];
+}>;
+export type PagedResultSet<T> = {
+    PagingInfo: {
+        Bookmark: string;
+        HasMoreItems: boolean;
+    };
+    Items: T[];
+};
+export {};
+//# sourceMappingURL=polite.d.ts.map