onlinescoutmanager 1.0.0

package/dist/index.d.ts

@@ -0,0 +1,368 @@
+interface ClientOptions {
+    apiId: string;
+    token: string;
+    baseUrl?: string;
+}
+interface AuthCredentials {
+    userid: string;
+    secret: string;
+}
+interface AuthResponse {
+    userid: string;
+    secret: string;
+}
+interface MemberListItem {
+    scoutid: number;
+    firstname: string;
+    lastname: string;
+    full_name: string;
+    photo_guid: string;
+    patrolid: number;
+    patrol: string;
+    sectionid: number;
+    enddate: string | null;
+    age: string;
+    patrol_role_level_label: string;
+    active: boolean;
+}
+interface MembersList {
+    identifier: string;
+    photos: boolean;
+    items: MemberListItem[];
+}
+interface MemberDetail {
+    ok: boolean;
+    read_only: string[];
+    data: Record<string, unknown>;
+    meta: Record<string, unknown>[];
+}
+interface MemberTransfer {
+    direction: string;
+    member_id: number;
+    firstname: string;
+    lastname: string;
+    photo_guid: string;
+    type: string;
+    date: string;
+    section_id: number;
+    section_name: {
+        group: string;
+        section: string;
+    };
+    section_long: string;
+    mode: string;
+    id: string;
+}
+interface MemberTransfersResponse {
+    status: boolean;
+    error: string | null;
+    data: MemberTransfer[];
+    meta: unknown[];
+}
+interface PatrolMember {
+    firstname: string;
+    lastname: string;
+    scout_id: number;
+    scoutid: number;
+    photo_guid: string;
+    patrolid: number;
+    patrolleader: string;
+    patrol: string;
+    sectionid: number;
+    enddate: string | null;
+    age: string;
+    patrol_role_level_label: string;
+    active: number;
+    editable: boolean;
+}
+interface Patrol {
+    patrolid: string;
+    sectionid: string;
+    name: string;
+    active: string;
+    points: string;
+    census_costs: boolean;
+    members: PatrolMember[];
+}
+type PatrolsResponse = Record<string, Patrol>;
+interface CensusItem {
+    scoutid: string;
+    firstname: string;
+    lastname: string;
+    joined: string;
+    photo_guid: string | null;
+    sex: string;
+    ethnicity: string;
+    disabilities: string;
+    myscout: string;
+    raw_disabilities: string[];
+    _filterString: string;
+}
+interface CensusResponse {
+    identifier: string;
+    items: CensusItem[];
+}
+interface FlexiRecordItem {
+    extraid: string;
+    name: string;
+}
+interface FlexiRecordsResponse {
+    identifier: string;
+    label: string;
+    items: FlexiRecordItem[];
+}
+interface AttendanceItem {
+    firstname: string;
+    lastname: string;
+    patrolid: number;
+    active: boolean;
+    scoutid: number;
+    total: number;
+    [date: string]: unknown;
+}
+interface AttendanceResponse {
+    identifier: string;
+    label: string;
+    items: AttendanceItem[];
+    meetings: Record<string, string>;
+}
+interface AttendanceBadgeRequirement {
+    badge_id: string;
+    badgeName: string;
+    column_id: string;
+    name: string;
+    meetingdate: string;
+    section: string;
+    sectionid: number;
+}
+interface UpdateAttendanceParams {
+    sectionId: string;
+    termId: string;
+    scoutIds: number[];
+    selectedDate: string;
+    present: string;
+    section: string;
+    completedBadges?: unknown[];
+    customData?: unknown[];
+}
+interface ProgrammeSummaryItem {
+    eveningid: string;
+    sectionid: string;
+    title: string;
+    notesforparents: string;
+    parentsrequired: string;
+    meetingdate: string;
+    starttime: string;
+    endtime: string;
+    soft_deleted: string;
+}
+interface ProgrammeSummaryResponse {
+    items: ProgrammeSummaryItem[];
+}
+interface ProgrammeDetailItem {
+    eveningid: string;
+    sectionid: string;
+    title: string;
+    meetingdate: string;
+    starttime: string;
+    endtime: string;
+    help: {
+        scoutid: string;
+        scout: string;
+    }[];
+}
+interface ProgrammeDetailsResponse {
+    items: ProgrammeDetailItem[];
+    badgelinks: Record<string, unknown>;
+}
+interface ParentRotaMember {
+    scoutid: string;
+    firstname: string;
+    lastname: string;
+    photo_guid: string;
+    patrol_id: number;
+}
+interface ParentRotaResponse {
+    status: boolean;
+    error: string | null;
+    data: ParentRotaMember[];
+    meta: unknown[];
+}
+interface BadgeTagCloudResponse {
+    tags: Record<string, number>;
+    tag_count: number;
+    badges: Record<string, number>;
+}
+interface DashboardResponse {
+    conf: Record<string, number>;
+    is_full_admin: boolean;
+    permissions: Record<string, unknown>;
+    patrols: Record<string, unknown>[];
+    birthdays: Record<string, unknown>[];
+    programme: Record<string, unknown>[];
+    events: Record<string, unknown>[];
+    outstandingpayments: Record<string, unknown>[];
+    notepad: {
+        raw: string;
+        html: string;
+    };
+    [key: string]: unknown;
+}
+interface CustomDataColumn {
+    column_id: number;
+    type: string;
+    varname: string;
+    label: string;
+    value: string | null;
+}
+interface CustomDataGroup {
+    group_id: number;
+    group_type: string;
+    identifier: string;
+    name: string;
+    columns: CustomDataColumn[];
+}
+interface CustomDataResponse {
+    status: boolean;
+    error: string | null;
+    data: CustomDataGroup[];
+    meta: Record<string, unknown>;
+}
+interface CustomDataUpdateResponse {
+    status: boolean;
+    error: string | null;
+    data: Record<string, unknown>;
+    meta: Record<string, unknown>;
+}
+interface EmailContact {
+    emails: string[];
+    firstname: string;
+    lastname: string;
+    photo_guid: string;
+    member_id: number;
+}
+interface SelectedEmailsResponse {
+    emails: Record<string, EmailContact>;
+    count: number;
+    blocks: unknown[];
+    daily_limit_reached: boolean;
+}
+interface SectionsResponse {
+    [key: string]: unknown;
+}
+interface RiskAssessmentCategoriesResponse {
+    status: boolean;
+    error: string | null;
+    data: {
+        name: string;
+    }[];
+    meta: Record<string, unknown>;
+}
+interface DeletableMembersResponse {
+    status: boolean;
+    error: string | null;
+    data: {
+        firstname: string;
+        lastname: string;
+        date_deleted: string;
+        id: number;
+    }[];
+    meta: unknown[];
+}
+interface OkResponse {
+    ok: boolean;
+}
+
+declare class AttendanceResource {
+    private client;
+    constructor(client: OSMClient);
+    get(sectionId: string, termId: string, section: string): Promise<AttendanceResponse>;
+    getBadgeRequirements(sectionId: string, section: string, date: string): Promise<AttendanceBadgeRequirement[]>;
+    update(params: UpdateAttendanceParams): Promise<OkResponse>;
+}
+
+declare class BadgesResource {
+    private client;
+    constructor(client: OSMClient);
+    getTagCloud(sectionId: string, termId: string, section: string): Promise<BadgeTagCloudResponse>;
+}
+
+declare class CustomDataResource {
+    private client;
+    constructor(client: OSMClient);
+    get(sectionId: string, memberId: string): Promise<CustomDataResponse>;
+    update(sectionId: string, memberId: string, groupId: string, data: Record<string, string>): Promise<CustomDataUpdateResponse>;
+}
+
+declare class DashboardResource {
+    private client;
+    constructor(client: OSMClient);
+    getNextThings(sectionId: string, termId: string, section: string): Promise<DashboardResponse>;
+}
+
+declare class EmailResource {
+    private client;
+    constructor(client: OSMClient);
+    getContacts(sectionId: string): Promise<SelectedEmailsResponse>;
+    sendTemplate(sectionId: string, subject: string, emails: Record<string, unknown>, edits: Record<string, unknown>): Promise<OkResponse>;
+}
+
+declare class MembersResource {
+    private client;
+    constructor(client: OSMClient);
+    list(sectionId: string, termId: string): Promise<MembersList>;
+    get(sectionId: string, scoutId: string): Promise<MemberDetail>;
+    getTransfers(sectionId: string): Promise<MemberTransfersResponse>;
+    getPatrols(sectionId: string, termId: string): Promise<PatrolsResponse>;
+    getCensus(sectionId: string, termId: string): Promise<CensusResponse>;
+    getFlexiRecords(sectionId: string, archived?: boolean): Promise<FlexiRecordsResponse>;
+    getDeletable(sectionId: string): Promise<DeletableMembersResponse>;
+}
+
+declare class ProgrammeResource {
+    private client;
+    constructor(client: OSMClient);
+    getSummary(sectionId: string, termId: string): Promise<ProgrammeSummaryResponse>;
+    getDetails(sectionId: string, eveningId: string): Promise<ProgrammeDetailsResponse>;
+    getParentRotaMembers(sectionId: string, eveningId: string): Promise<ParentRotaResponse>;
+    getAttachments(sectionId: string, eveningId: string): Promise<unknown>;
+    updateMeeting(sectionId: string, eveningId: string, parts: Record<string, unknown>): Promise<ProgrammeDetailsResponse>;
+}
+
+declare class SectionsResource {
+    private client;
+    constructor(client: OSMClient);
+    list(): Promise<SectionsResponse>;
+    getTerms(): Promise<unknown>;
+}
+
+declare class OSMClient {
+    readonly apiId: string;
+    readonly token: string;
+    readonly baseUrl: string;
+    private auth;
+    readonly members: MembersResource;
+    readonly attendance: AttendanceResource;
+    readonly programme: ProgrammeResource;
+    readonly sections: SectionsResource;
+    readonly badges: BadgesResource;
+    readonly dashboard: DashboardResource;
+    readonly customData: CustomDataResource;
+    readonly email: EmailResource;
+    constructor(options: ClientOptions);
+    get isAuthorized(): boolean;
+    authorize(email: string, password: string): Promise<void>;
+    post<T>(path: string, body?: Record<string, string>, skipAuth?: boolean): Promise<T>;
+    get<T>(path: string, query?: Record<string, string>): Promise<T>;
+}
+
+declare class OSMError extends Error {
+    readonly status: number;
+    readonly body: unknown;
+    constructor(message: string, status: number, body?: unknown);
+}
+declare class OSMAuthError extends OSMError {
+    constructor(message?: string);
+}
+
+export { type AttendanceBadgeRequirement, type AttendanceItem, type AttendanceResponse, type AuthCredentials, type AuthResponse, type BadgeTagCloudResponse, type CensusItem, type CensusResponse, type ClientOptions, type CustomDataColumn, type CustomDataGroup, type CustomDataResponse, type CustomDataUpdateResponse, type DashboardResponse, type DeletableMembersResponse, type EmailContact, type FlexiRecordItem, type FlexiRecordsResponse, type MemberDetail, type MemberListItem, type MemberTransfer, type MemberTransfersResponse, type MembersList, OSMAuthError, OSMClient, OSMError, type OkResponse, type ParentRotaMember, type ParentRotaResponse, type Patrol, type PatrolMember, type PatrolsResponse, type ProgrammeDetailItem, type ProgrammeDetailsResponse, type ProgrammeSummaryItem, type ProgrammeSummaryResponse, type RiskAssessmentCategoriesResponse, type SectionsResponse, type SelectedEmailsResponse, type UpdateAttendanceParams };

package/dist/index.js

@@ -0,0 +1,336 @@
+// 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();
+  }
+};
+export {
+  OSMAuthError,
+  OSMClient,
+  OSMError
+};