onlinescoutmanager 1.0.0

package/dist/index.cjs

@@ -0,0 +1,365 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  OSMAuthError: () => OSMAuthError,
+  OSMClient: () => OSMClient,
+  OSMError: () => OSMError
+});
+module.exports = __toCommonJS(index_exports);
+
+// src/errors.ts
+var OSMError = class extends Error {
+  status;
+  body;
+  constructor(message, status, body) {
+    super(message);
+    this.name = "OSMError";
+    this.status = status;
+    this.body = body;
+  }
+};
+var OSMAuthError = class extends OSMError {
+  constructor(message = "Not authorized \u2014 call client.authorize() first") {
+    super(message, 401);
+    this.name = "OSMAuthError";
+  }
+};
+
+// src/resources/attendance.ts
+var AttendanceResource = class {
+  constructor(client) {
+    this.client = client;
+  }
+  async get(sectionId, termId, section) {
+    return this.client.post(
+      "/ext/members/attendance/?action=get",
+      { sectionid: sectionId, termid: termId, section }
+    );
+  }
+  async getBadgeRequirements(sectionId, section, date) {
+    return this.client.post(
+      "/ext/members/attendance/?action=getAttendanceBadgeRequirements",
+      { sectionid: sectionId, section, date }
+    );
+  }
+  async update(params) {
+    return this.client.post(
+      `/ext/members/attendance/?action=update&sectionid=${params.sectionId}&termid=${params.termId}`,
+      {
+        scouts: JSON.stringify(params.scoutIds),
+        selectedDate: params.selectedDate,
+        present: params.present,
+        section: params.section,
+        sectionid: params.sectionId,
+        completedBadges: JSON.stringify(params.completedBadges ?? []),
+        customData: JSON.stringify(params.customData ?? [])
+      }
+    );
+  }
+};
+
+// src/resources/badges.ts
+var BadgesResource = class {
+  constructor(client) {
+    this.client = client;
+  }
+  async getTagCloud(sectionId, termId, section) {
+    return this.client.post(
+      "/ext/programme/clouds/?action=getBadgeTagCloud",
+      { sectionid: sectionId, termid: termId, section }
+    );
+  }
+};
+
+// src/resources/custom-data.ts
+var CustomDataResource = class {
+  constructor(client) {
+    this.client = client;
+  }
+  async get(sectionId, memberId) {
+    return this.client.post(
+      "/ext/customdata/?action=getData",
+      {
+        section_id: sectionId,
+        associated_id: memberId,
+        associated_type: "member",
+        context: "members",
+        group_order: "section"
+      }
+    );
+  }
+  async update(sectionId, memberId, groupId, data) {
+    const body = {
+      section_id: sectionId,
+      associated_id: memberId,
+      associated_type: "member",
+      group_id: groupId,
+      context: "members"
+    };
+    for (const [key, value] of Object.entries(data)) {
+      body[`data[${key}]`] = value;
+    }
+    return this.client.post(
+      "/ext/customdata/?action=update",
+      body
+    );
+  }
+};
+
+// src/resources/dashboard.ts
+var DashboardResource = class {
+  constructor(client) {
+    this.client = client;
+  }
+  async getNextThings(sectionId, termId, section) {
+    return this.client.post(
+      "/ext/dashboard/?action=getNextThings",
+      { sectionid: sectionId, termid: termId, section }
+    );
+  }
+};
+
+// src/resources/email.ts
+var EmailResource = class {
+  constructor(client) {
+    this.client = client;
+  }
+  async getContacts(sectionId) {
+    return this.client.post(
+      "/ext/members/email/?action=getSelectedEmailsFromContacts",
+      { sectionid: sectionId }
+    );
+  }
+  async sendTemplate(sectionId, subject, emails, edits) {
+    return this.client.post(
+      "/ext/members/email/?action=sendTemplate",
+      {
+        sectionid: sectionId,
+        subject,
+        emails: JSON.stringify(emails),
+        edits: JSON.stringify(edits)
+      }
+    );
+  }
+};
+
+// src/resources/members.ts
+var MembersResource = class {
+  constructor(client) {
+    this.client = client;
+  }
+  async list(sectionId, termId) {
+    return this.client.post(
+      "/ext/members/contact/?action=getListOfMembers",
+      { sectionid: sectionId, termid: termId }
+    );
+  }
+  async get(sectionId, scoutId) {
+    return this.client.post(
+      "/ext/members/contact/?action=getIndividual",
+      {
+        sectionid: sectionId,
+        scoutid: scoutId,
+        context: "members"
+      }
+    );
+  }
+  async getTransfers(sectionId) {
+    return this.client.post(
+      "/ext/members/contact/?action=getMemberTransfers",
+      { sectionid: sectionId }
+    );
+  }
+  async getPatrols(sectionId, termId) {
+    return this.client.post(
+      "/ext/members/patrols/?action=getPatrolsWithPeople",
+      { sectionid: sectionId, termid: termId }
+    );
+  }
+  async getCensus(sectionId, termId) {
+    return this.client.post(
+      "/ext/members/census/?action=getDetails",
+      { sectionid: sectionId, termid: termId }
+    );
+  }
+  async getFlexiRecords(sectionId, archived = false) {
+    return this.client.post(
+      "/ext/members/flexirecords/?action=getPatrolsWithPeople",
+      { sectionid: sectionId, archived: archived ? "y" : "n" }
+    );
+  }
+  async getDeletable(sectionId) {
+    return this.client.get(
+      `/v3/members/review/deletion/${sectionId}`
+    );
+  }
+};
+
+// src/resources/programme.ts
+var ProgrammeResource = class {
+  constructor(client) {
+    this.client = client;
+  }
+  async getSummary(sectionId, termId) {
+    return this.client.post(
+      "/ext/programme/?action=getProgrammeSummary",
+      { sectionid: sectionId, termid: termId }
+    );
+  }
+  async getDetails(sectionId, eveningId) {
+    return this.client.post(
+      "/ext/programme/?action=getProgramme",
+      { sectionid: sectionId, eveningid: eveningId }
+    );
+  }
+  async getParentRotaMembers(sectionId, eveningId) {
+    return this.client.post(
+      "/ext/programme/?action=getMembersForParentRota",
+      { sectionid: sectionId, eveningid: eveningId }
+    );
+  }
+  async getAttachments(sectionId, eveningId) {
+    return this.client.post(
+      "/ext/programme/?action=programmeAttachmentsManifest",
+      { sectionid: sectionId, eveningid: eveningId }
+    );
+  }
+  async updateMeeting(sectionId, eveningId, parts) {
+    return this.client.post(
+      "/ext/programme/?action=editEveningParts",
+      {
+        sectionid: sectionId,
+        eveningid: eveningId,
+        parts: JSON.stringify(parts)
+      }
+    );
+  }
+};
+
+// src/resources/sections.ts
+var SectionsResource = class {
+  constructor(client) {
+    this.client = client;
+  }
+  async list() {
+    return this.client.post(
+      "/ext/members/sectionplanning/?action=listSections"
+    );
+  }
+  async getTerms() {
+    return this.client.post("/api.php?action=getTerms");
+  }
+};
+
+// src/client.ts
+var DEFAULT_BASE_URL = "https://www.onlinescoutmanager.co.uk";
+var OSMClient = class {
+  apiId;
+  token;
+  baseUrl;
+  auth = null;
+  members;
+  attendance;
+  programme;
+  sections;
+  badges;
+  dashboard;
+  customData;
+  email;
+  constructor(options) {
+    this.apiId = options.apiId;
+    this.token = options.token;
+    this.baseUrl = (options.baseUrl ?? DEFAULT_BASE_URL).replace(/\/+$/, "");
+    this.members = new MembersResource(this);
+    this.attendance = new AttendanceResource(this);
+    this.programme = new ProgrammeResource(this);
+    this.sections = new SectionsResource(this);
+    this.badges = new BadgesResource(this);
+    this.dashboard = new DashboardResource(this);
+    this.customData = new CustomDataResource(this);
+    this.email = new EmailResource(this);
+  }
+  get isAuthorized() {
+    return this.auth !== null;
+  }
+  async authorize(email, password) {
+    const data = await this.post(
+      "/users.php?action=authorise",
+      { email, password },
+      true
+    );
+    this.auth = { userid: data.userid, secret: data.secret };
+  }
+  async post(path, body = {}, skipAuth = false) {
+    const params = new URLSearchParams({
+      apiid: this.apiId,
+      token: this.token,
+      ...body
+    });
+    if (!skipAuth) {
+      if (!this.auth) throw new OSMAuthError();
+      params.set("userid", this.auth.userid);
+      params.set("secret", this.auth.secret);
+    }
+    const url = `${this.baseUrl}${path}`;
+    const response = await fetch(url, {
+      method: "POST",
+      headers: { "Content-Type": "application/x-www-form-urlencoded" },
+      body: params.toString()
+    });
+    if (!response.ok) {
+      const text = await response.text().catch(() => "");
+      throw new OSMError(
+        `OSM API error: ${response.status} ${response.statusText}`,
+        response.status,
+        text
+      );
+    }
+    return response.json();
+  }
+  async get(path, query = {}) {
+    if (!this.auth) throw new OSMAuthError();
+    const params = new URLSearchParams(query);
+    const url = `${this.baseUrl}${path}?${params.toString()}`;
+    const response = await fetch(url, {
+      method: "GET",
+      headers: {
+        Authorization: `${this.auth.userid}:${this.auth.secret}`
+      }
+    });
+    if (!response.ok) {
+      const text = await response.text().catch(() => "");
+      throw new OSMError(
+        `OSM API error: ${response.status} ${response.statusText}`,
+        response.status,
+        text
+      );
+    }
+    return response.json();
+  }
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  OSMAuthError,
+  OSMClient,
+  OSMError
+});