politeshop 0.0.1

package/dist/schema/polite.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"polite.d.ts","sourceRoot":"","sources":["../../schema/polite.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAIxB,kDAAkD;AAClD,eAAO,MAAM,gBAAgB;;;;;;;;;EAG3B,CAAC;AAEH,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gBAAgB,CAAC,CAAC;AAIhE,0EAA0E;AAC1E,eAAO,MAAM,UAAU;;;;IAIrB,wDAAwD;;;;;;;;;;;;;;;EAGxD,CAAC;AAEH,MAAM,MAAM,UAAU,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,UAAU,CAAC,CAAC;AAIpD,8EAA8E;AAC9E,eAAO,MAAM,YAAY;;;;;;;;;;;;EAIvB,CAAC;AAEH,MAAM,MAAM,YAAY,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,YAAY,CAAC,CAAC;AAIxD,qFAAqF;AACrF,eAAO,MAAM,aAAa;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAaxB,CAAC;AAEH,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,aAAa,CAAC,CAAC;AAE1D,eAAO,MAAM,YAAY;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAYvB,CAAC;AAEH,MAAM,MAAM,YAAY,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,YAAY,CAAC,CAAC;AAIxD,QAAA,MAAM,QAAQ;;;;;;;;;EAGZ,CAAC;AAEH,MAAM,MAAM,QAAQ,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,QAAQ,CAAC,CAAC;AAEhD;;;;;;;;GAQG;AACH,eAAO,MAAM,QAAQ;;IAGjB,wDAAwD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;KAezD,CAAC;AAEJ,MAAM,MAAM,QAAQ,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,QAAQ,CAAC,CAAC;AAEhD,QAAA,MAAM,UAAU;;;;;;;;;;;;;;;;QAnBZ,wDAAwD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAyB1D,CAAC;AAEH,MAAM,MAAM,SAAS,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,UAAU,CAAC,GAAG;IAAE,OAAO,EAAE,SAAS,EAAE,CAAA;CAAE,CAAC;AAE9E;;;GAGG;AACH,eAAO,MAAM,SAAS,EAAE,CAAC,CAAC,OAAO,CAAC,SAAS,CAEzC,CAAC;AAEH,iFAAiF;AACjF,eAAO,MAAM,eAAe;;;;;;EAE1B,CAAC;AAEH,MAAM,MAAM,eAAe,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,eAAe,CAAC,CAAC;AAU9D,mFAAmF;AACnF,eAAO,MAAM,aAAa;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAUxB,CAAC;AAEH,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,aAAa,CAAC,CAAC;AAE1D,mFAAmF;AACnF,eAAO,MAAM,aAAa;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAgBxB,CAAC;AAEH,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,aAAa,CAAC,CAAC;AAI1D,4EAA4E;AAC5E,eAAO,MAAM,YAAY;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EA0BvB,CAAC;AAEH,MAAM,MAAM,YAAY,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,YAAY,CAAC,CAAC;AAIxD;;;GAGG;AACH,wBAAgB,cAAc,CAAC,CAAC,SAAS,CAAC,CAAC,UAAU,EAAE,CAAC,EAAE,CAAC;;;;;;;;;GAK1D;AAED,MAAM,MAAM,cAAc,CAAC,CAAC,IAAI;IAAE,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IAAC,OAAO,EAAE,CAAC,EAAE,CAAA;CAAE,CAAC;AAEtE;;;GAGG;AACH,wBAAgB,cAAc,CAAC,CAAC,SAAS,CAAC,CAAC,UAAU,EAAE,CAAC,EAAE,CAAC;;;;;;;;;;;;;;;;;;;;;;;;GAQ1D;AAED,MAAM,MAAM,cAAc,CAAC,CAAC,IAAI;IAC9B,UAAU,EAAE;QAAE,QAAQ,EAAE,MAAM,CAAC;QAAC,YAAY,EAAE,OAAO,CAAA;KAAE,CAAC;IACxD,KAAK,EAAE,CAAC,EAAE,CAAC;CACZ,CAAC"}

package/dist/schema/polite.js

@@ -0,0 +1,197 @@
+/**
+ * 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";
+// ── Auth ──────────────────────────────────────────────────────────────────────
+/** Response from GET /d2l/lp/auth/oauth2/token */
+export const brightspaceToken = z.object({
+    access_token: z.string(),
+    expires_at: z.number(),
+});
+// ── Users ─────────────────────────────────────────────────────────────────────
+/** https://docs.valence.desire2learn.com/res/user.html#User.WhoAmIUser */
+export const whoAmIUser = z.object({
+    Identifier: z.string(),
+    FirstName: z.string(),
+    LastName: z.string(),
+    /** POLITEMall uses this as the user's email address. */
+    UniqueName: z.string(),
+    ProfileIdentifier: z.string(),
+});
+// ── Organization ──────────────────────────────────────────────────────────────
+/** https://docs.valence.desire2learn.com/res/orgunit.html#Org.Organization */
+export const organization = z.object({
+    Identifier: z.string(),
+    Name: z.string(),
+    TimeZone: z.string(),
+});
+// ── Enrollments ───────────────────────────────────────────────────────────────
+/** https://docs.valence.desire2learn.com/res/enroll.html#Enrollment.MyOrgUnitInfo */
+export const myOrgUnitInfo = z.object({
+    OrgUnit: z.object({
+        Id: z.number(),
+        Type: z.object({
+            Id: z.number(),
+            Code: z.string(),
+            Name: z.string(),
+        }),
+        Name: z.string(),
+        Code: z.string().nullable(),
+        HomeUrl: z.string().nullable(),
+        ImageUrl: z.string().nullable(),
+    }),
+});
+export const courseParent = z.object({
+    CourseOfferingId: z.string(),
+    Semester: z.object({
+        Identifier: z.string(),
+        Name: z.string(),
+        Code: z.string(),
+    }),
+    Department: z.object({
+        Identifier: z.string(),
+        Name: z.string(),
+        Code: z.string(),
+    }),
+});
+// ── Content / Table of Contents ───────────────────────────────────────────────
+const richText = z.object({
+    Text: z.string(),
+    Html: z.string(),
+});
+/**
+ * `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 const tocTopic = z
+    .object({
+    Identifier: z.string(),
+    /** Same identifier as `Identifier`, but as a number. */
+    TopicId: z.number(),
+    Title: z.string(),
+    Description: richText,
+    ActivityType: z.number(),
+    TypeIdentifier: z.enum(["Link", "File", "ContentService"]),
+    Unread: z.boolean(),
+    ToolId: z.number().nullable(),
+    ToolItemId: z.number().nullable(),
+    SortOrder: z.number(),
+})
+    .and(z
+    .object({ IsBroken: z.literal(false), Url: z.string() })
+    .or(z.object({ IsBroken: z.literal(true), Url: z.string().nullable() })));
+const baseModule = z.object({
+    ModuleId: z.number(),
+    Title: z.string(),
+    Description: richText,
+    SortOrder: z.number(),
+    Topics: tocTopic.array(),
+});
+/**
+ * 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 const tocModule = baseModule.extend({
+    Modules: z.lazy(() => tocModule.array()),
+});
+/** https://docs.valence.desire2learn.com/res/content.html#ToC.TableOfContents */
+export const tableOfContents = z.object({
+    Modules: tocModule.array(),
+});
+// ── Dropbox / Submissions ─────────────────────────────────────────────────────
+const file = z.object({
+    FileId: z.number(),
+    FileName: z.string(),
+    Size: z.number(),
+});
+/** https://docs.valence.desire2learn.com/res/dropbox.html#Dropbox.EntityDropbox */
+export const entityDropbox = z.object({
+    CompletionDate: z.string().nullable(),
+    Submissions: z
+        .object({
+        Id: z.number(),
+        SubmissionDate: z.coerce.date().nullable(),
+        Comment: richText,
+        Files: file.array(),
+    })
+        .array(),
+});
+/** https://docs.valence.desire2learn.com/res/dropbox.html#Dropbox.DropboxFolder */
+export const dropboxFolder = z.object({
+    Id: z.number(),
+    Name: z.string(),
+    CustomInstructions: richText,
+    Attachments: file.array(),
+    DueDate: z.coerce.date().nullable(),
+    SubmissionType: z.literal(0),
+    CompletionType: z.number(),
+    Availability: z
+        .object({
+        StartDate: z.coerce.date().nullable(),
+        EndDate: z.coerce.date().nullable(),
+        StartDateAvailabilityType: z.number().nullable(),
+        EndDateAvailabilityType: z.number().nullable(),
+    })
+        .nullable(),
+});
+// ── Quizzes ───────────────────────────────────────────────────────────────────
+/** https://docs.valence.desire2learn.com/res/quiz.html#Quiz.QuizReadData */
+export const quizReadData = z.object({
+    QuizId: z.number(),
+    Name: z.string(),
+    Instructions: z.object({
+        Text: richText,
+        IsDisplayed: z.boolean(),
+    }),
+    Description: z.object({
+        Text: richText,
+        IsDisplayed: z.boolean(),
+    }),
+    StartDate: z.coerce.date(),
+    EndDate: z.coerce.date(),
+    DueDate: z.coerce.date().nullable(),
+    SortOrder: z.number(),
+    SubmissionTimeLimit: z.object({
+        IsEnforced: z.boolean(),
+        ShowClock: z.boolean(),
+        TimeLimitValue: z.number(),
+    }),
+    AttemptsAllowed: z.object({
+        IsUnlimited: z.boolean(),
+        NumberOfAttemptsAllowed: z.number().nullable(),
+    }),
+    CalcTypeId: z.number(),
+    Shuffle: z.boolean(),
+});
+// ── Pagination helpers ────────────────────────────────────────────────────────
+/**
+ * Wraps a schema in an
+ * [ObjectListPage](https://docs.valence.desire2learn.com/basic/apicall.html#Api.ObjectListPage).
+ */
+export function objectListPage(s) {
+    return z.object({
+        Next: z.string().nullable(),
+        Objects: s.array(),
+    });
+}
+/**
+ * Wraps a schema in a
+ * [PagedResultSet](https://docs.valence.desire2learn.com/basic/apicall.html#Api.PagedResultSet).
+ */
+export function pagedResultSet(s) {
+    return z.object({
+        PagingInfo: z.object({
+            Bookmark: z.string(),
+            HasMoreItems: z.boolean(),
+        }),
+        Items: s.array(),
+    });
+}
+//# sourceMappingURL=polite.js.map

package/dist/schema/polite.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"polite.js","sourceRoot":"","sources":["../../schema/polite.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,iFAAiF;AAEjF,kDAAkD;AAClD,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,CAAC,MAAM,CAAC;IACvC,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE;IACxB,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE;CACvB,CAAC,CAAC;AAIH,iFAAiF;AAEjF,0EAA0E;AAC1E,MAAM,CAAC,MAAM,UAAU,GAAG,CAAC,CAAC,MAAM,CAAC;IACjC,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE;IACtB,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE;IACrB,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE;IACpB,wDAAwD;IACxD,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE;IACtB,iBAAiB,EAAE,CAAC,CAAC,MAAM,EAAE;CAC9B,CAAC,CAAC;AAIH,iFAAiF;AAEjF,8EAA8E;AAC9E,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,CAAC,MAAM,CAAC;IACnC,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE;IACtB,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;IAChB,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE;CACrB,CAAC,CAAC;AAIH,iFAAiF;AAEjF,qFAAqF;AACrF,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,CAAC,MAAM,CAAC;IACpC,OAAO,EAAE,CAAC,CAAC,MAAM,CAAC;QAChB,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE;QACd,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC;YACb,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE;YACd,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;YAChB,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;SACjB,CAAC;QACF,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;QAChB,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QAC3B,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QAC9B,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;KAChC,CAAC;CACH,CAAC,CAAC;AAIH,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,CAAC,MAAM,CAAC;IACnC,gBAAgB,EAAE,CAAC,CAAC,MAAM,EAAE;IAC5B,QAAQ,EAAE,CAAC,CAAC,MAAM,CAAC;QACjB,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE;QACtB,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;QAChB,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;KACjB,CAAC;IACF,UAAU,EAAE,CAAC,CAAC,MAAM,CAAC;QACnB,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE;QACtB,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;QAChB,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;KACjB,CAAC;CACH,CAAC,CAAC;AAIH,iFAAiF;AAEjF,MAAM,QAAQ,GAAG,CAAC,CAAC,MAAM,CAAC;IACxB,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;IAChB,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;CACjB,CAAC,CAAC;AAIH;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,QAAQ,GAAG,CAAC;KACtB,MAAM,CAAC;IACN,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE;IACtB,wDAAwD;IACxD,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE;IACnB,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;IACjB,WAAW,EAAE,QAAQ;IACrB,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE;IACxB,cAAc,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,MAAM,EAAE,gBAAgB,CAAC,CAAC;IAC1D,MAAM,EAAE,CAAC,CAAC,OAAO,EAAE;IACnB,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC7B,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACjC,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE;CACtB,CAAC;KACD,GAAG,CACF,CAAC;KACE,MAAM,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC;KACvD,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,CAC3E,CAAC;AAIJ,MAAM,UAAU,GAAG,CAAC,CAAC,MAAM,CAAC;IAC1B,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE;IACpB,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;IACjB,WAAW,EAAE,QAAQ;IACrB,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE;IACrB,MAAM,EAAE,QAAQ,CAAC,KAAK,EAAE;CACzB,CAAC,CAAC;AAIH;;;GAGG;AACH,MAAM,CAAC,MAAM,SAAS,GAAyB,UAAU,CAAC,MAAM,CAAC;IAC/D,OAAO,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,KAAK,EAAE,CAAC;CACzC,CAAC,CAAC;AAEH,iFAAiF;AACjF,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,CAAC,MAAM,CAAC;IACtC,OAAO,EAAE,SAAS,CAAC,KAAK,EAAE;CAC3B,CAAC,CAAC;AAIH,iFAAiF;AAEjF,MAAM,IAAI,GAAG,CAAC,CAAC,MAAM,CAAC;IACpB,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE;IAClB,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE;IACpB,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;CACjB,CAAC,CAAC;AAEH,mFAAmF;AACnF,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,CAAC,MAAM,CAAC;IACpC,cAAc,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACrC,WAAW,EAAE,CAAC;SACX,MAAM,CAAC;QACN,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE;QACd,cAAc,EAAE,CAAC,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC,QAAQ,EAAE;QAC1C,OAAO,EAAE,QAAQ;QACjB,KAAK,EAAE,IAAI,CAAC,KAAK,EAAE;KACpB,CAAC;SACD,KAAK,EAAE;CACX,CAAC,CAAC;AAIH,mFAAmF;AACnF,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,CAAC,MAAM,CAAC;IACpC,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE;IACd,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;IAChB,kBAAkB,EAAE,QAAQ;IAC5B,WAAW,EAAE,IAAI,CAAC,KAAK,EAAE;IACzB,OAAO,EAAE,CAAC,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC,QAAQ,EAAE;IACnC,cAAc,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC;IAC5B,cAAc,EAAE,CAAC,CAAC,MAAM,EAAE;IAC1B,YAAY,EAAE,CAAC;SACZ,MAAM,CAAC;QACN,SAAS,EAAE,CAAC,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC,QAAQ,EAAE;QACrC,OAAO,EAAE,CAAC,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC,QAAQ,EAAE;QACnC,yBAAyB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QAChD,uBAAuB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;KAC/C,CAAC;SACD,QAAQ,EAAE;CACd,CAAC,CAAC;AAIH,iFAAiF;AAEjF,4EAA4E;AAC5E,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,CAAC,MAAM,CAAC;IACnC,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE;IAClB,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;IAChB,YAAY,EAAE,CAAC,CAAC,MAAM,CAAC;QACrB,IAAI,EAAE,QAAQ;QACd,WAAW,EAAE,CAAC,CAAC,OAAO,EAAE;KACzB,CAAC;IACF,WAAW,EAAE,CAAC,CAAC,MAAM,CAAC;QACpB,IAAI,EAAE,QAAQ;QACd,WAAW,EAAE,CAAC,CAAC,OAAO,EAAE;KACzB,CAAC;IACF,SAAS,EAAE,CAAC,CAAC,MAAM,CAAC,IAAI,EAAE;IAC1B,OAAO,EAAE,CAAC,CAAC,MAAM,CAAC,IAAI,EAAE;IACxB,OAAO,EAAE,CAAC,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC,QAAQ,EAAE;IACnC,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE;IACrB,mBAAmB,EAAE,CAAC,CAAC,MAAM,CAAC;QAC5B,UAAU,EAAE,CAAC,CAAC,OAAO,EAAE;QACvB,SAAS,EAAE,CAAC,CAAC,OAAO,EAAE;QACtB,cAAc,EAAE,CAAC,CAAC,MAAM,EAAE;KAC3B,CAAC;IACF,eAAe,EAAE,CAAC,CAAC,MAAM,CAAC;QACxB,WAAW,EAAE,CAAC,CAAC,OAAO,EAAE;QACxB,uBAAuB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;KAC/C,CAAC;IACF,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE;IACtB,OAAO,EAAE,CAAC,CAAC,OAAO,EAAE;CACrB,CAAC,CAAC;AAIH,iFAAiF;AAEjF;;;GAGG;AACH,MAAM,UAAU,cAAc,CAAyB,CAAI;IACzD,OAAO,CAAC,CAAC,MAAM,CAAC;QACd,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QAC3B,OAAO,EAAE,CAAC,CAAC,KAAK,EAAE;KACnB,CAAC,CAAC;AACL,CAAC;AAID;;;GAGG;AACH,MAAM,UAAU,cAAc,CAAyB,CAAI;IACzD,OAAO,CAAC,CAAC,MAAM,CAAC;QACd,UAAU,EAAE,CAAC,CAAC,MAAM,CAAC;YACnB,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE;YACpB,YAAY,EAAE,CAAC,CAAC,OAAO,EAAE;SAC1B,CAAC;QACF,KAAK,EAAE,CAAC,CAAC,KAAK,EAAE;KACjB,CAAC,CAAC;AACL,CAAC"}

package/dist/schema/siren.d.ts

@@ -0,0 +1,66 @@
+import { z } from "zod";
+export type SirenLink = {
+    class?: string[];
+    rel: string[];
+    href: string;
+};
+export type SirenAction = {
+    href: string;
+    method: string;
+    name: string;
+    fields?: {
+        name: string;
+        type: string;
+        value?: any;
+        title?: string;
+    }[];
+    class?: string[];
+    title?: string;
+    type?: string;
+};
+export declare class SirenEntity {
+    class: (string | null | undefined)[];
+    rel?: string[];
+    actions?: SirenAction[];
+    entities?: SirenEntity[];
+    links?: SirenLink[];
+    properties?: Record<string, any>;
+    href?: string;
+    constructor(data: {
+        class: (string | null | undefined)[];
+        rel?: string[];
+        actions?: SirenAction[];
+        entities?: SirenEntity[];
+        links?: SirenLink[];
+        properties?: Record<string, any>;
+        href?: string;
+    });
+    findChild(query: {
+        class: string | string[];
+    } | {
+        rel: string | string[];
+    }): SirenEntity | undefined;
+    getChild(query: {
+        class: string | string[];
+    } | {
+        rel: string | string[];
+    }): SirenEntity;
+    findLink(query: {
+        class: string | string[];
+    } | {
+        rel: string | string[];
+    }): SirenLink | undefined;
+    getLink(query: {
+        class: string | string[];
+    } | {
+        rel: string | string[];
+    }): SirenLink;
+    findAction(query: {
+        name: string;
+    }): SirenAction | undefined;
+    getAction(query: {
+        name: string;
+    }): SirenAction;
+}
+export declare const sirenEntity: z.ZodType<SirenEntity, z.ZodTypeDef, unknown>;
+//# sourceMappingURL=siren.d.ts.map

package/dist/schema/siren.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"siren.d.ts","sourceRoot":"","sources":["../../schema/siren.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAKxB,MAAM,MAAM,SAAS,GAAG;IAAE,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;IAAC,GAAG,EAAE,MAAM,EAAE,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,CAAC;AAE1E,MAAM,MAAM,WAAW,GAAG;IACxB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,CAAC,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,GAAG,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,EAAE,CAAC;IACvE,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;IACjB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC;AAIF,qBAAa,WAAW;IACtB,KAAK,EAAE,CAAC,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC,EAAE,CAAC;IACrC,GAAG,CAAC,EAAE,MAAM,EAAE,CAAC;IACf,OAAO,CAAC,EAAE,WAAW,EAAE,CAAC;IACxB,QAAQ,CAAC,EAAE,WAAW,EAAE,CAAC;IACzB,KAAK,CAAC,EAAE,SAAS,EAAE,CAAC;IACpB,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IACjC,IAAI,CAAC,EAAE,MAAM,CAAC;gBAEF,IAAI,EAAE;QAChB,KAAK,EAAE,CAAC,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC,EAAE,CAAC;QACrC,GAAG,CAAC,EAAE,MAAM,EAAE,CAAC;QACf,OAAO,CAAC,EAAE,WAAW,EAAE,CAAC;QACxB,QAAQ,CAAC,EAAE,WAAW,EAAE,CAAC;QACzB,KAAK,CAAC,EAAE,SAAS,EAAE,CAAC;QACpB,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QACjC,IAAI,CAAC,EAAE,MAAM,CAAC;KACf;IAYD,SAAS,CACP,KAAK,EAAE;QAAE,KAAK,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;KAAE,GAAG;QAAE,GAAG,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;KAAE,GAC/D,WAAW,GAAG,SAAS;IAmB1B,QAAQ,CACN,KAAK,EAAE;QAAE,KAAK,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;KAAE,GAAG;QAAE,GAAG,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;KAAE,GAC/D,WAAW;IAWd,QAAQ,CACN,KAAK,EAAE;QAAE,KAAK,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;KAAE,GAAG;QAAE,GAAG,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;KAAE,GAC/D,SAAS,GAAG,SAAS;IAiBxB,OAAO,CACL,KAAK,EAAE;QAAE,KAAK,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;KAAE,GAAG;QAAE,GAAG,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;KAAE,GAC/D,SAAS;IASZ,UAAU,CAAC,KAAK,EAAE;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,GAAG,WAAW,GAAG,SAAS;IAI5D,SAAS,CAAC,KAAK,EAAE;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,GAAG,WAAW;CAKhD;AAID,eAAO,MAAM,WAAW,EAAE,CAAC,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC,CAAC,UAAU,EAAE,OAAO,CAuCnE,CAAC"}

package/dist/schema/siren.js

@@ -0,0 +1,112 @@
+import { z } from "zod";
+import { arrEq } from "../utils/array";
+// ── SirenEntity class ─────────────────────────────────────────────────────────
+export class SirenEntity {
+    class;
+    rel;
+    actions;
+    entities;
+    links;
+    properties;
+    href;
+    constructor(data) {
+        this.class = data.class;
+        this.rel = data.rel;
+        this.actions = data.actions;
+        this.entities = data.entities;
+        this.links = data.links;
+        this.properties = data.properties;
+        this.href = data.href;
+    }
+    // ── Sub-entity lookup ───────────────────────────────────────────────────────
+    findChild(query) {
+        if ("class" in query) {
+            const cls = query.class;
+            if (typeof cls === "string")
+                return this.entities?.find(({ class: c }) => c.includes(cls));
+            return this.entities?.find(({ class: c }) => arrEq(c, cls));
+        }
+        if ("rel" in query) {
+            const rel = query.rel;
+            if (typeof rel === "string")
+                return this.entities?.find(({ rel: r }) => r?.includes(rel));
+            return this.entities?.find(({ rel: r }) => r != null && arrEq(r, rel));
+        }
+    }
+    getChild(query) {
+        const result = this.findChild(query);
+        if (!result)
+            throw new Error(`No child entity found matching query: ${JSON.stringify(query)}`);
+        return result;
+    }
+    // ── Link lookup ─────────────────────────────────────────────────────────────
+    findLink(query) {
+        if ("class" in query) {
+            const cls = query.class;
+            if (typeof cls === "string")
+                return this.links?.find(({ class: c }) => c?.includes(cls));
+            return this.links?.find(({ class: c }) => c != null && arrEq(c, cls));
+        }
+        if ("rel" in query) {
+            const rel = query.rel;
+            if (typeof rel === "string")
+                return this.links?.find(({ rel: r }) => r.includes(rel));
+            return this.links?.find(({ rel: r }) => arrEq(r, rel));
+        }
+    }
+    getLink(query) {
+        const result = this.findLink(query);
+        if (!result)
+            throw new Error(`No link found matching query: ${JSON.stringify(query)}`);
+        return result;
+    }
+    // ── Action lookup ───────────────────────────────────────────────────────────
+    findAction(query) {
+        return this.actions?.find((a) => a.name === query.name);
+    }
+    getAction(query) {
+        const result = this.findAction(query);
+        if (!result)
+            throw new Error(`No action found with name: "${query.name}"`);
+        return result;
+    }
+}
+// ── Zod schema ────────────────────────────────────────────────────────────────
+export const sirenEntity = z.lazy(() => z
+    .object({
+    actions: z
+        .object({
+        href: z.string(),
+        method: z.string(),
+        name: z.string(),
+        fields: z
+            .object({
+            name: z.string(),
+            type: z.string(),
+            value: z.any(),
+            title: z.string().optional(),
+        })
+            .array()
+            .optional(),
+        class: z.string().array().optional(),
+        title: z.string().optional(),
+        type: z.string().optional(),
+    })
+        .array()
+        .optional(),
+    entities: sirenEntity.array().optional(),
+    links: z
+        .object({
+        class: z.string().array().optional(),
+        rel: z.string().array(),
+        href: z.string(),
+    })
+        .array()
+        .optional(),
+    rel: z.string().array().optional(),
+    properties: z.record(z.string(), z.any()).optional(),
+    class: z.string().nullable().array(),
+    href: z.string().optional(),
+})
+    .transform((data) => new SirenEntity(data)));
+//# sourceMappingURL=siren.js.map

package/dist/schema/siren.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"siren.js","sourceRoot":"","sources":["../../schema/siren.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,KAAK,EAAE,MAAM,gBAAgB,CAAC;AAgBvC,iFAAiF;AAEjF,MAAM,OAAO,WAAW;IACtB,KAAK,CAAgC;IACrC,GAAG,CAAY;IACf,OAAO,CAAiB;IACxB,QAAQ,CAAiB;IACzB,KAAK,CAAe;IACpB,UAAU,CAAuB;IACjC,IAAI,CAAU;IAEd,YAAY,IAQX;QACC,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC;QACxB,IAAI,CAAC,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC;QACpB,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC;QAC5B,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;QAC9B,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC;QACxB,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC;QAClC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC;IACxB,CAAC;IAED,+EAA+E;IAE/E,SAAS,CACP,KAAgE;QAEhE,IAAI,OAAO,IAAI,KAAK,EAAE,CAAC;YACrB,MAAM,GAAG,GAAG,KAAK,CAAC,KAAK,CAAC;YACxB,IAAI,OAAO,GAAG,KAAK,QAAQ;gBACzB,OAAO,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC;YAChE,OAAO,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,EAAE,EAAE,CAC1C,KAAK,CAAC,CAAa,EAAE,GAAe,CAAC,CACtC,CAAC;QACJ,CAAC;QACD,IAAI,KAAK,IAAI,KAAK,EAAE,CAAC;YACnB,MAAM,GAAG,GAAG,KAAK,CAAC,GAAG,CAAC;YACtB,IAAI,OAAO,GAAG,KAAK,QAAQ;gBACzB,OAAO,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,EAAE,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC;YAC/D,OAAO,IAAI,CAAC,QAAQ,EAAE,IAAI,CACxB,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,IAAI,IAAI,IAAI,KAAK,CAAC,CAAC,EAAE,GAAe,CAAC,CACvD,CAAC;QACJ,CAAC;IACH,CAAC;IAED,QAAQ,CACN,KAAgE;QAEhE,MAAM,MAAM,GAAG,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;QACrC,IAAI,CAAC,MAAM;YACT,MAAM,IAAI,KAAK,CACb,yCAAyC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,CACjE,CAAC;QACJ,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,+EAA+E;IAE/E,QAAQ,CACN,KAAgE;QAEhE,IAAI,OAAO,IAAI,KAAK,EAAE,CAAC;YACrB,MAAM,GAAG,GAAG,KAAK,CAAC,KAAK,CAAC;YACxB,IAAI,OAAO,GAAG,KAAK,QAAQ;gBACzB,OAAO,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,EAAE,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC;YAC9D,OAAO,IAAI,CAAC,KAAK,EAAE,IAAI,CACrB,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,IAAI,IAAI,IAAI,KAAK,CAAC,CAAC,EAAE,GAAe,CAAC,CACzD,CAAC;QACJ,CAAC;QACD,IAAI,KAAK,IAAI,KAAK,EAAE,CAAC;YACnB,MAAM,GAAG,GAAG,KAAK,CAAC,GAAG,CAAC;YACtB,IAAI,OAAO,GAAG,KAAK,QAAQ;gBACzB,OAAO,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC;YAC3D,OAAO,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,KAAK,CAAC,CAAC,EAAE,GAAe,CAAC,CAAC,CAAC;QACrE,CAAC;IACH,CAAC;IAED,OAAO,CACL,KAAgE;QAEhE,MAAM,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QACpC,IAAI,CAAC,MAAM;YACT,MAAM,IAAI,KAAK,CAAC,iCAAiC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;QAC5E,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,+EAA+E;IAE/E,UAAU,CAAC,KAAuB;QAChC,OAAO,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,KAAK,CAAC,IAAI,CAAC,CAAC;IAC1D,CAAC;IAED,SAAS,CAAC,KAAuB;QAC/B,MAAM,MAAM,GAAG,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;QACtC,IAAI,CAAC,MAAM;YAAE,MAAM,IAAI,KAAK,CAAC,+BAA+B,KAAK,CAAC,IAAI,GAAG,CAAC,CAAC;QAC3E,OAAO,MAAM,CAAC;IAChB,CAAC;CACF;AAED,iFAAiF;AAEjF,MAAM,CAAC,MAAM,WAAW,GACtB,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,CACV,CAAC;KACE,MAAM,CAAC;IACN,OAAO,EAAE,CAAC;SACP,MAAM,CAAC;QACN,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;QAChB,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE;QAClB,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;QAChB,MAAM,EAAE,CAAC;aACN,MAAM,CAAC;YACN,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;YAChB,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;YAChB,KAAK,EAAE,CAAC,CAAC,GAAG,EAAE;YACd,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;SAC7B,CAAC;aACD,KAAK,EAAE;aACP,QAAQ,EAAE;QACb,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE;QACpC,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QAC5B,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;KAC5B,CAAC;SACD,KAAK,EAAE;SACP,QAAQ,EAAE;IACb,QAAQ,EAAE,WAAW,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE;IACxC,KAAK,EAAE,CAAC;SACL,MAAM,CAAC;QACN,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE;QACpC,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,KAAK,EAAE;QACvB,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;KACjB,CAAC;SACD,KAAK,EAAE;SACP,QAAQ,EAAE;IACb,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE;IAClC,UAAU,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC,QAAQ,EAAE;IACpD,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IACpC,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CAC5B,CAAC;KACD,SAAS,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,WAAW,CAAC,IAAI,CAAC,CAAC,CAC9C,CAAC"}

package/dist/types.d.ts

@@ -0,0 +1,105 @@
+/**
+ * Domain types returned by the {@link POLITEShop} client. These are plain
+ * TypeScript interfaces, independent of any ORM or database schema.
+ */
+export interface User {
+    id: string;
+    name: string;
+}
+export interface Institution {
+    id: string;
+    name: string;
+}
+export interface Semester {
+    id: string;
+    name: string;
+}
+export interface Module {
+    id: string;
+    name: string;
+    code: string;
+}
+export interface ActivityFolder {
+    type: "folder";
+    id: string;
+    name: string;
+    description: string;
+    sortOrder: number;
+    contents: (AnyActivity | ActivityFolder)[];
+}
+interface BaseActivity {
+    id: string;
+    sortOrder: number;
+}
+export interface HTMLActivity extends BaseActivity {
+    type: "html";
+    name: string;
+    /** Raw HTML content of the activity page. */
+    content: string;
+}
+export interface WebEmbedActivity extends BaseActivity {
+    type: "web_embed";
+    name: string;
+    /** The URL to embed in an iframe. */
+    url: string;
+}
+export interface DocEmbedActivity extends BaseActivity {
+    type: "doc_embed";
+    name: string;
+    /** Original source file URL (e.g. .pptx, .docx, .pdf). */
+    sourceURL: string;
+    /** URL of a browser-renderable PDF preview generated by Brightspace, if available. */
+    previewURL?: string;
+    /** Expiry date of the preview URL, if it is time-limited. */
+    previewURLExpiry?: Date;
+}
+export interface VideoEmbedActivity extends BaseActivity {
+    type: "video_embed";
+    name: string;
+    /** Signed URL of the video file hosted on Brightspace Content Service / S3. */
+    sourceURL: string;
+    /** Expiry date of the source URL. */
+    sourceURLExpiry?: Date;
+    /** Signed URL of the video thumbnail. */
+    thumbnailURL: string;
+    /** Expiry date of the thumbnail URL. */
+    thumbnailURLExpiry?: Date;
+}
+export interface SubmissionActivity extends BaseActivity {
+    type: "submission";
+    /** ID of the dropbox folder this activity links to. */
+    dropboxId: string;
+}
+export interface QuizActivity extends BaseActivity {
+    type: "quiz";
+    /** ID of the quiz this activity links to. */
+    quizId: string;
+}
+export interface UnknownActivity extends BaseActivity {
+    type: "unknown";
+}
+export type AnyActivity = HTMLActivity | WebEmbedActivity | DocEmbedActivity | VideoEmbedActivity | SubmissionActivity | QuizActivity | UnknownActivity;
+export interface SubmissionDropbox {
+    id: string;
+    name: string;
+    moduleId: string;
+    description: string;
+    dueAt: Date | null;
+    opensAt?: Date | null;
+    closesAt?: Date | null;
+}
+export interface Submission {
+    id: string;
+    dropboxId: string;
+    submittedAt: Date | null;
+    comment?: string;
+}
+export interface Quiz {
+    id: string;
+    moduleId: string;
+    name: string;
+    description: string;
+    dueAt: Date | null;
+}
+export {};
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH,MAAM,WAAW,IAAI;IACnB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,WAAW;IAC1B,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;CACd;AAID,MAAM,WAAW,QAAQ;IACvB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,MAAM;IACrB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;CACd;AAID,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,QAAQ,CAAC;IACf,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,CAAC,WAAW,GAAG,cAAc,CAAC,EAAE,CAAC;CAC5C;AAID,UAAU,YAAY;IACpB,EAAE,EAAE,MAAM,CAAC;IACX,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,YAAa,SAAQ,YAAY;IAChD,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,6CAA6C;IAC7C,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,gBAAiB,SAAQ,YAAY;IACpD,IAAI,EAAE,WAAW,CAAC;IAClB,IAAI,EAAE,MAAM,CAAC;IACb,qCAAqC;IACrC,GAAG,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,gBAAiB,SAAQ,YAAY;IACpD,IAAI,EAAE,WAAW,CAAC;IAClB,IAAI,EAAE,MAAM,CAAC;IACb,0DAA0D;IAC1D,SAAS,EAAE,MAAM,CAAC;IAClB,sFAAsF;IACtF,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,6DAA6D;IAC7D,gBAAgB,CAAC,EAAE,IAAI,CAAC;CACzB;AAED,MAAM,WAAW,kBAAmB,SAAQ,YAAY;IACtD,IAAI,EAAE,aAAa,CAAC;IACpB,IAAI,EAAE,MAAM,CAAC;IACb,+EAA+E;IAC/E,SAAS,EAAE,MAAM,CAAC;IAClB,qCAAqC;IACrC,eAAe,CAAC,EAAE,IAAI,CAAC;IACvB,yCAAyC;IACzC,YAAY,EAAE,MAAM,CAAC;IACrB,wCAAwC;IACxC,kBAAkB,CAAC,EAAE,IAAI,CAAC;CAC3B;AAED,MAAM,WAAW,kBAAmB,SAAQ,YAAY;IACtD,IAAI,EAAE,YAAY,CAAC;IACnB,uDAAuD;IACvD,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,YAAa,SAAQ,YAAY;IAChD,IAAI,EAAE,MAAM,CAAC;IACb,6CAA6C;IAC7C,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,eAAgB,SAAQ,YAAY;IACnD,IAAI,EAAE,SAAS,CAAC;CACjB;AAED,MAAM,MAAM,WAAW,GACnB,YAAY,GACZ,gBAAgB,GAChB,gBAAgB,GAChB,kBAAkB,GAClB,kBAAkB,GAClB,YAAY,GACZ,eAAe,CAAC;AAIpB,MAAM,WAAW,iBAAiB;IAChC,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC;IACjB,WAAW,EAAE,MAAM,CAAC;IACpB,KAAK,EAAE,IAAI,GAAG,IAAI,CAAC;IACnB,OAAO,CAAC,EAAE,IAAI,GAAG,IAAI,CAAC;IACtB,QAAQ,CAAC,EAAE,IAAI,GAAG,IAAI,CAAC;CACxB;AAED,MAAM,WAAW,UAAU;IACzB,EAAE,EAAE,MAAM,CAAC;IACX,SAAS,EAAE,MAAM,CAAC;IAClB,WAAW,EAAE,IAAI,GAAG,IAAI,CAAC;IACzB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAID,MAAM,WAAW,IAAI;IACnB,EAAE,EAAE,MAAM,CAAC;IACX,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,KAAK,EAAE,IAAI,GAAG,IAAI,CAAC;CACpB"}

package/dist/types.js

@@ -0,0 +1,6 @@
+/**
+ * Domain types returned by the {@link POLITEShop} client. These are plain
+ * TypeScript interfaces, independent of any ORM or database schema.
+ */
+export {};
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../types.ts"],"names":[],"mappings":"AAAA;;;GAGG"}

package/dist/utils/array.d.ts

@@ -0,0 +1,5 @@
+/** Check if two arrays are equal (shallow). */
+export declare function arrEq<T>(a: T[], b: T[]): boolean;
+/** Split an array into consecutive chunks of at most `size` elements. */
+export declare function chunk<T>(arr: T[], size: number): T[][];
+//# sourceMappingURL=array.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"array.d.ts","sourceRoot":"","sources":["../../utils/array.ts"],"names":[],"mappings":"AAAA,+CAA+C;AAC/C,wBAAgB,KAAK,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,EAAE,CAAC,EAAE,GAAG,OAAO,CAEhD;AAED,yEAAyE;AACzE,wBAAgB,KAAK,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,EAAE,IAAI,EAAE,MAAM,GAAG,CAAC,EAAE,EAAE,CAMtD"}

package/dist/utils/array.js

@@ -0,0 +1,13 @@
+/** Check if two arrays are equal (shallow). */
+export function arrEq(a, b) {
+    return a.length === b.length && a.every((v, i) => v === b[i]);
+}
+/** Split an array into consecutive chunks of at most `size` elements. */
+export function chunk(arr, size) {
+    const result = [];
+    for (let i = 0; i < arr.length; i += size) {
+        result.push(arr.slice(i, i + size));
+    }
+    return result;
+}
+//# sourceMappingURL=array.js.map

package/dist/utils/array.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"array.js","sourceRoot":"","sources":["../../utils/array.ts"],"names":[],"mappings":"AAAA,+CAA+C;AAC/C,MAAM,UAAU,KAAK,CAAI,CAAM,EAAE,CAAM;IACrC,OAAO,CAAC,CAAC,MAAM,KAAK,CAAC,CAAC,MAAM,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AAChE,CAAC;AAED,yEAAyE;AACzE,MAAM,UAAU,KAAK,CAAI,GAAQ,EAAE,IAAY;IAC7C,MAAM,MAAM,GAAU,EAAE,CAAC;IACzB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,GAAG,CAAC,MAAM,EAAE,CAAC,IAAI,IAAI,EAAE,CAAC;QAC1C,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC;IACtC,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC"}

package/dist/utils/url.d.ts

@@ -0,0 +1,23 @@
+/**
+ * Return the last path component of a URL.
+ * e.g. `lastPathComponent("https://host.com/foo/bar/123")` → `"123"`
+ */
+export declare function lastPathComponent(url: string | URL): string;
+/**
+ * Parse the expiry date from a time-limited resource URL.
+ *
+ * Handles:
+ * - AWS S3 pre-signed URLs (`*.amazonaws.com`), which encode their expiry via
+ *   `X-Amz-Date` + `X-Amz-Expires` query parameters.
+ * - Brightspace Content Service URLs (`*.content-service.brightspace.com`),
+ *   which encode their expiry as a Unix timestamp in the `Expires` query parameter.
+ *
+ * Returns `undefined` if the URL does not contain recognisable expiry information.
+ */
+export declare function getURLExpiry(url: string): Date | undefined;
+/**
+ * If `url` is a string with no base URL, this returns `url` with
+ * the given `baseURL`. Otherwise, this returns `url` as-is.
+ */
+export declare function defaultToBaseURL(url: string | URL, baseURL: string | URL): URL;
+//# sourceMappingURL=url.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"url.d.ts","sourceRoot":"","sources":["../../utils/url.ts"],"names":[],"mappings":"AAEA;;;GAGG;AACH,wBAAgB,iBAAiB,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,GAAG,MAAM,CAG3D;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,YAAY,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAuB1D;AAED;;;GAGG;AACH,wBAAgB,gBAAgB,CAC9B,GAAG,EAAE,MAAM,GAAG,GAAG,EACjB,OAAO,EAAE,MAAM,GAAG,GAAG,GACpB,GAAG,CAML"}

package/dist/utils/url.js

@@ -0,0 +1,53 @@
+import { addSeconds, parse } from "date-fns";
+/**
+ * Return the last path component of a URL.
+ * e.g. `lastPathComponent("https://host.com/foo/bar/123")` → `"123"`
+ */
+export function lastPathComponent(url) {
+    if (typeof url === "string")
+        url = new URL(url);
+    return url.pathname.split("/").at(-1);
+}
+/**
+ * Parse the expiry date from a time-limited resource URL.
+ *
+ * Handles:
+ * - AWS S3 pre-signed URLs (`*.amazonaws.com`), which encode their expiry via
+ *   `X-Amz-Date` + `X-Amz-Expires` query parameters.
+ * - Brightspace Content Service URLs (`*.content-service.brightspace.com`),
+ *   which encode their expiry as a Unix timestamp in the `Expires` query parameter.
+ *
+ * Returns `undefined` if the URL does not contain recognisable expiry information.
+ */
+export function getURLExpiry(url) {
+    const urlObj = new URL(url);
+    if (urlObj.hostname.endsWith(".amazonaws.com")) {
+        const expiresIn = urlObj.searchParams.get("X-Amz-Expires");
+        if (!expiresIn)
+            return undefined;
+        const startDate = urlObj.searchParams.get("X-Amz-Date");
+        if (!startDate)
+            return undefined;
+        return addSeconds(parse(startDate, "yyyyMMdd'T'HHmmssX", new Date()), +expiresIn);
+    }
+    if (urlObj.hostname.endsWith("content-service.brightspace.com")) {
+        const expires = urlObj.searchParams.get("Expires");
+        if (!expires)
+            return undefined;
+        return new Date(+expires * 1000);
+    }
+    return undefined;
+}
+/**
+ * If `url` is a string with no base URL, this returns `url` with
+ * the given `baseURL`. Otherwise, this returns `url` as-is.
+ */
+export function defaultToBaseURL(url, baseURL) {
+    try {
+        return new URL(url);
+    }
+    catch {
+        return new URL(url, baseURL);
+    }
+}
+//# sourceMappingURL=url.js.map

package/dist/utils/url.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"url.js","sourceRoot":"","sources":["../../utils/url.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,KAAK,EAAE,MAAM,UAAU,CAAC;AAE7C;;;GAGG;AACH,MAAM,UAAU,iBAAiB,CAAC,GAAiB;IACjD,IAAI,OAAO,GAAG,KAAK,QAAQ;QAAE,GAAG,GAAG,IAAI,GAAG,CAAC,GAAG,CAAC,CAAC;IAChD,OAAO,GAAG,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAE,CAAC;AACzC,CAAC;AAED;;;;;;;;;;GAUG;AACH,MAAM,UAAU,YAAY,CAAC,GAAW;IACtC,MAAM,MAAM,GAAG,IAAI,GAAG,CAAC,GAAG,CAAC,CAAC;IAE5B,IAAI,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC,gBAAgB,CAAC,EAAE,CAAC;QAC/C,MAAM,SAAS,GAAG,MAAM,CAAC,YAAY,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC;QAC3D,IAAI,CAAC,SAAS;YAAE,OAAO,SAAS,CAAC;QAEjC,MAAM,SAAS,GAAG,MAAM,CAAC,YAAY,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;QACxD,IAAI,CAAC,SAAS;YAAE,OAAO,SAAS,CAAC;QAEjC,OAAO,UAAU,CACf,KAAK,CAAC,SAAS,EAAE,oBAAoB,EAAE,IAAI,IAAI,EAAE,CAAC,EAClD,CAAC,SAAS,CACX,CAAC;IACJ,CAAC;IAED,IAAI,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC,iCAAiC,CAAC,EAAE,CAAC;QAChE,MAAM,OAAO,GAAG,MAAM,CAAC,YAAY,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;QACnD,IAAI,CAAC,OAAO;YAAE,OAAO,SAAS,CAAC;QAC/B,OAAO,IAAI,IAAI,CAAC,CAAC,OAAO,GAAG,IAAI,CAAC,CAAC;IACnC,CAAC;IAED,OAAO,SAAS,CAAC;AACnB,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,gBAAgB,CAC9B,GAAiB,EACjB,OAAqB;IAErB,IAAI,CAAC;QACH,OAAO,IAAI,GAAG,CAAC,GAAG,CAAC,CAAC;IACtB,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,IAAI,GAAG,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;IAC/B,CAAC;AACH,CAAC"}