need4deed-sdk 0.0.167 → 0.0.169

package/dist/constants/endpoints.d.ts

@@ -5,5 +5,6 @@ export declare enum Endpoint {
     VOLUNTEER = "/volunteer",
     OPTION = "/option",
     AGENT = "/agent",
-    REGISTER = "/register"
+    REGISTER = "/register",
+    STATISTICS = "/statistics"
 }

package/dist/constants/endpoints.js

@@ -9,8 +9,6 @@ var Endpoint;
     Endpoint["VOLUNTEER"] = "/volunteer";
     Endpoint["OPTION"] = "/option";
     Endpoint["AGENT"] = "/agent";
-    // Sub-path prefix, mounted under AGENT (mirrors the backend's
-    // `register(agentRegisterRoutes, { prefix: REGISTER })`). Compose as
-    // `Endpoint.AGENT + Endpoint.REGISTER` -> "/agent/register".
     Endpoint["REGISTER"] = "/register";
+    Endpoint["STATISTICS"] = "/statistics";
 })(Endpoint || (exports.Endpoint = Endpoint = {}));

package/dist/types/api/agent.d.ts

@@ -103,6 +103,7 @@ interface AgentGetList {
     unclaimed: boolean;
     lat: number | null;
     lon: number | null;
+    statusEngagement: AgentEngagementStatusType;
 }
 export type ApiAgentGetList = VoidableProps<AgentGetList, "district">;
 interface AgentGet extends AgentGetList {
@@ -112,7 +113,6 @@ interface AgentGet extends AgentGetList {
     representative: ApiRepresentativeGet;
     contacts: ApiAgentMembership[];
     services: Service[];
-    statusEngagement: AgentEngagementStatusType;
     agentDetails: AgentDetails;
     comments: ApiComment[];
     languages: ApiLanguage[];
@@ -144,6 +144,7 @@ export interface ApiAgentRegisterNew {
     addressStreet?: string;
     addressPostcode?: string;
     languages?: number[];
+    confirmSharedAddress?: boolean;
 }
 export type ApiAgentRegister = {
     agentId: number;

package/dist/types/api/agent.js

@@ -1,8 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.AgentMembershipStatus = exports.AgentTrustType = exports.AgentServiceType = exports.AgentVolunteerSearchType = exports.AgentEngagementStatusType = exports.AgentRoleType = exports.AgentOperatorType = exports.AgentTypeKey = void 0;
-// Canonical seed values for the `agent_type` reference table (see AgentType
-// below) — not used directly in any API contract.
 var AgentTypeKey;
 (function (AgentTypeKey) {
     AgentTypeKey["AE"] = "AE";
@@ -47,8 +45,6 @@ var AgentVolunteerSearchType;
     AgentVolunteerSearchType["NOT_NEEDED"] = "agent-not-needed";
     AgentVolunteerSearchType["VOLUNTEERS_FOUND"] = "agent-volunteers-found";
 })(AgentVolunteerSearchType || (exports.AgentVolunteerSearchType = AgentVolunteerSearchType = {}));
-// Canonical seed values for the `service` reference table (see Service
-// below) — not used directly in any API contract.
 var AgentServiceType;
 (function (AgentServiceType) {
     AgentServiceType["CHILDCARE"] = "childcare";

package/dist/types/api/event.d.ts

@@ -42,11 +42,11 @@ export interface ApiEventN4DGetList {
     description: string;
     shortDescription: string;
     linkRSVP: string;
+    hostName?: string;
     additionalTitle?: string;
     additionalInfo?: string[];
 }
 export interface ApiEventN4DGet extends ApiEventN4DGetList {
-    hostName?: string;
     time?: string;
     locationLink?: string;
     followUpText?: string;

package/dist/types/api/index.d.ts

@@ -18,6 +18,7 @@ export * from "./post-reply";
 export * from "./organization";
 export * from "./person";
 export * from "./profile";
+export * from "./statistics";
 export * from "./testimonial";
 export * from "./time";
 export * from "./translation";

package/dist/types/api/index.js

@@ -34,6 +34,7 @@ __exportStar(require("./post-reply"), exports);
 __exportStar(require("./organization"), exports);
 __exportStar(require("./person"), exports);
 __exportStar(require("./profile"), exports);
+__exportStar(require("./statistics"), exports);
 __exportStar(require("./testimonial"), exports);
 __exportStar(require("./time"), exports);
 __exportStar(require("./translation"), exports);

package/dist/types/api/opportunity.d.ts

@@ -112,15 +112,6 @@ export interface OpportunityLegacyFormDataProps {
     language: `${Lang}`;
 }
 export type OpportunityLegacyFormData = VoidableUndefined<OpportunityLegacyFormDataProps>;
-/**
- * Body for `POST /opportunity` — the dashboard's typed create-opportunity
- * form. Unlike `OpportunityLegacyFormData` (free-text/ISO-code strings from
- * the public form, resolved by title lookup), activities/skills/languages/
- * districts here are numeric option ids from `GET /option/*`, resolved by id.
- * Deliberately not derived from `OpportunityLegacyFormDataProps`: the two
- * shapes look similar but mean different things, and overloading one type for
- * both invites exactly the id-vs-title mismatch this type exists to prevent.
- */
 export interface OpportunityCreateFormDataProps {
     title: string;
     agent_id?: number;
@@ -215,18 +206,10 @@ export type ApiOpportunityPatch = VoidableProps<{
         time: string;
     };
     contact: {
-        /**
-         * Relinks the opportunity to a different Person already registered as a
-         * contact of the opportunity's agent. `name`/`phone`/`email`/
-         * `waysToContact` are derived from that Person and returned on
-         * `ApiOpportunityContact` — editing them directly goes through the
-         * agent-contact endpoints (`ApiAgentContactPatch`), not this field.
-         */
         id: number;
     };
     agent: {
         id?: number;
-        /** @deprecated free-text in-place edit; use `id` to re-link. BE only applies `name`. */
         name?: string;
     };
     accompanyingDetails: ApiOpportunityAccompanyingDetails;
@@ -241,11 +224,6 @@ export interface OpportunityVolunteer {
 export interface ApiOpportunityVolunteerGet extends OpportunityVolunteer {
     title: string;
 }
-/**
- * A volunteer linked to an opportunity, as surfaced on an agent's opportunity
- * list. Person fields (`name`, `avatarUrl`) are PII-masked per caller role by
- * the API, so they may be absent or redacted.
- */
 export interface ApiAgentOpportunityVolunteer {
     id: number;
     volunteerId: number;
@@ -253,10 +231,6 @@ export interface ApiAgentOpportunityVolunteer {
     name?: string;
     avatarUrl?: string;
 }
-/**
- * One of an agent's opportunities with the volunteers linked to it. Response
- * item of `GET /agent/:id/opportunity-linked`.
- */
 export interface ApiAgentOpportunity extends Pick<ApiOpportunityGetList, "volunteerType" | "languages" | "activities" | "availability" | "location" | "district"> {
     id: Id;
     title: string;

package/dist/types/api/statistics.d.ts

@@ -0,0 +1,45 @@
+import { OptionTitle } from "./common";
+export declare enum StatisticsMetric {
+    NEW_VOLUNTEERS = "new-volunteers",
+    REQUESTS = "requests",
+    LEAD_FROM = "lead-from"
+}
+export declare enum StatisticsGranularity {
+    MONTH = "month",
+    QUARTER = "quarter",
+    YEAR = "year"
+}
+export declare enum StatisticsGroupBy {
+    NONE = "none",
+    DISTRICT = "district",
+    OPPORTUNITY_TYPE = "opportunity-type",
+    VOLUNTEER_TYPE = "volunteer-type",
+    LEAD_FROM = "lead-from"
+}
+export declare const STATISTICS_TOTAL_KEY = "total";
+export declare const STATISTICS_UNKNOWN_KEY = "unknown";
+export interface ApiStatisticsQuery {
+    granularity: StatisticsGranularity;
+    from?: string;
+    to?: string;
+    groupBy?: StatisticsGroupBy;
+}
+export interface ApiStatisticsGroup {
+    key: string;
+    title: OptionTitle;
+}
+export interface ApiStatisticsPeriod {
+    period: string;
+    start: Date;
+    counts: Record<string, number>;
+    total: number;
+}
+export interface ApiStatisticsGet {
+    metric: StatisticsMetric;
+    granularity: StatisticsGranularity;
+    groupBy: StatisticsGroupBy;
+    allowedGroupBy: StatisticsGroupBy[];
+    groups: ApiStatisticsGroup[];
+    periods: ApiStatisticsPeriod[];
+    totalsBeforeTracking?: Record<string, number>;
+}

package/dist/types/api/statistics.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.STATISTICS_UNKNOWN_KEY = exports.STATISTICS_TOTAL_KEY = exports.StatisticsGroupBy = exports.StatisticsGranularity = exports.StatisticsMetric = void 0;
+// Periods are Europe/Berlin calendar periods, widened to whole periods.
+var StatisticsMetric;
+(function (StatisticsMetric) {
+    StatisticsMetric["NEW_VOLUNTEERS"] = "new-volunteers";
+    StatisticsMetric["REQUESTS"] = "requests";
+    // Counts ticked answers: one volunteer can tick several.
+    StatisticsMetric["LEAD_FROM"] = "lead-from";
+})(StatisticsMetric || (exports.StatisticsMetric = StatisticsMetric = {}));
+var StatisticsGranularity;
+(function (StatisticsGranularity) {
+    StatisticsGranularity["MONTH"] = "month";
+    StatisticsGranularity["QUARTER"] = "quarter";
+    StatisticsGranularity["YEAR"] = "year";
+})(StatisticsGranularity || (exports.StatisticsGranularity = StatisticsGranularity = {}));
+var StatisticsGroupBy;
+(function (StatisticsGroupBy) {
+    StatisticsGroupBy["NONE"] = "none";
+    StatisticsGroupBy["DISTRICT"] = "district";
+    StatisticsGroupBy["OPPORTUNITY_TYPE"] = "opportunity-type";
+    StatisticsGroupBy["VOLUNTEER_TYPE"] = "volunteer-type";
+    StatisticsGroupBy["LEAD_FROM"] = "lead-from";
+})(StatisticsGroupBy || (exports.StatisticsGroupBy = StatisticsGroupBy = {}));
+exports.STATISTICS_TOTAL_KEY = "total";
+exports.STATISTICS_UNKNOWN_KEY = "unknown";

package/dist/types/api/translation.js

@@ -1,25 +1,15 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.TranslationStatus = exports.TranslationOrigin = void 0;
-// Machine translation of user-entered content (be#1064). Each
-// field_translation row records where its text came from and, for machine
-// rows, where it is in the translation queue.
 var TranslationOrigin;
 (function (TranslationOrigin) {
-    // Seeded, pre-translated reference data (skills, activities, languages, ...).
     TranslationOrigin["REFERENCE"] = "reference";
-    // Produced by the machine-translation worker.
     TranslationOrigin["MACHINE"] = "machine";
-    // Written or confirmed by a person. Never overwritten by MT while the
-    // source text is unchanged.
     TranslationOrigin["HUMAN"] = "human";
 })(TranslationOrigin || (exports.TranslationOrigin = TranslationOrigin = {}));
 var TranslationStatus;
 (function (TranslationStatus) {
-    // Queued for the machine-translation worker; no usable text yet.
     TranslationStatus["PENDING"] = "pending";
     TranslationStatus["DONE"] = "done";
-    // Gave up (retries exhausted or output failed validation); readers fall
-    // back to the original text.
     TranslationStatus["FAILED"] = "failed";
 })(TranslationStatus || (exports.TranslationStatus = TranslationStatus = {}));

package/dist/types/api/trusted-domain.js

@@ -1,6 +1,2 @@
 "use strict";
-// Email-domain allowlist for agent self-registration. A registrant whose email
-// domain is on this list is treated as belonging to a known RAC organisation —
-// so a brand-new representative (whose org has no existing member yet) can still
-// register, and a join auto-approves to ACTIVE. Managed by COORDINATOR/ADMIN.
 Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/api/volunteer-audit-log.js

@@ -1,10 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VolunteerAuditLogType = void 0;
-// Read-only audit trail of things that change on a volunteer's record
-// (be#919). Distinct from ApiActivityLogGet/ApiActivityLogEntry
-// (./activity-log.ts), an unrelated hours-worked ledger per
-// opportunity-volunteer pairing that happens to share a similar name.
 var VolunteerAuditLogType;
 (function (VolunteerAuditLogType) {
     VolunteerAuditLogType["CONTACT_DETAILS_CHANGED"] = "contact_details_changed";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "need4deed-sdk",
-  "version": "0.0.167",
+  "version": "0.0.169",
   "description": "Need4Deed.org SDK",
   "type": "commonjs",
   "main": "dist/index.js",