need4deed-sdk 0.0.195 → 0.0.197

package/README.md

@@ -7,3 +7,11 @@ Shared types for need4deed.org
 `TranslationFieldsByEntity` exports the registered translation fields for each entity. Backend registry validation can use this map to keep accepted fields aligned with the SDK.
 
 Opportunity translation endpoints use `info` for the field exposed as `description` by `ApiOpportunityGet` and `ApiOpportunityPatch`. Translation requests must use `info`; ordinary opportunity requests use `description`.
+
+## District aggregate contract
+
+District aggregate responses include every configured district, including
+districts with a count of zero. Volunteers are placed and counted in the
+district of their home postcode, not their preferred districts. Each volunteer
+is counted once. Aggregate requests use the same profile-specific `filter`
+types as district marker requests.

package/dist/types/api/district-aggregate.d.ts

@@ -0,0 +1,17 @@
+import { ApiAgentDistrictFilters, ApiDistrictMarkerFilters, ApiOpportunityDistrictFilters, ApiVolunteerDistrictFilters } from "./district-marker";
+export type ApiDistrictAggregateDistrict = {
+    districtId: number;
+    count: number;
+};
+export type ApiDistrictAggregateQuery<TFilters = ApiDistrictMarkerFilters> = {
+    filter?: TFilters;
+};
+export type ApiAgentDistrictAggregateQuery = ApiDistrictAggregateQuery<ApiAgentDistrictFilters>;
+export type ApiOpportunityDistrictAggregateQuery = ApiDistrictAggregateQuery<ApiOpportunityDistrictFilters>;
+export type ApiVolunteerDistrictAggregateQuery = ApiDistrictAggregateQuery<ApiVolunteerDistrictFilters>;
+export type ApiDistrictAggregate = {
+    districts: ApiDistrictAggregateDistrict[];
+    unassignedBerlin: number;
+    outsideBerlin: number;
+    remote: number;
+};

package/dist/types/api/district-aggregate.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/api/district-marker.d.ts

@@ -0,0 +1,41 @@
+import { EntityTableName, Id, Lang } from "../core";
+import { AgentType } from "./agent";
+import { ApiLanguage } from "./language";
+import { District } from "./location";
+import { ApiAvailability } from "./time";
+import { VolunteerType } from "./volunteer";
+export declare const apiDistrictMarkerMaxEntities = 500;
+export type ApiDistrictMarkerFilterValue = string | number | boolean | Array<string | number>;
+export type ApiAgentDistrictFilters = Partial<Record<"type" | "status" | "engagementStatus" | "services" | "volunteerSearch", ApiDistrictMarkerFilterValue>>;
+export type ApiOpportunityDistrictFilters = Partial<Record<"type" | "status" | "activity" | "skill" | "match" | "agentId" | "language" | "availability", ApiDistrictMarkerFilterValue>>;
+export type ApiVolunteerDistrictFilters = Partial<Record<"type" | "language" | "activity" | "skill" | "availability" | "engagement" | "match", ApiDistrictMarkerFilterValue>>;
+export type ApiDistrictMarkerFilters = ApiAgentDistrictFilters | ApiOpportunityDistrictFilters | ApiVolunteerDistrictFilters;
+export type ApiDistrictMarkerQuery<TFilters = ApiDistrictMarkerFilters> = {
+    districtId: number;
+    language: Lang;
+    filter?: TFilters;
+};
+export type ApiAgentDistrictMarkerQuery = ApiDistrictMarkerQuery<ApiAgentDistrictFilters>;
+export type ApiOpportunityDistrictMarkerQuery = ApiDistrictMarkerQuery<ApiOpportunityDistrictFilters>;
+export type ApiVolunteerDistrictMarkerQuery = ApiDistrictMarkerQuery<ApiVolunteerDistrictFilters>;
+export type ApiDistrictMarkerChild = {
+    id: Id;
+    title: string;
+    languages?: ApiLanguage[];
+    availability?: ApiAvailability[];
+    type?: AgentType;
+    statusTypes?: VolunteerType[];
+    district?: District;
+};
+export type ApiDistrictMarker = {
+    lat: number | null;
+    lon: number | null;
+    districtId: number;
+    children: Array<ApiDistrictMarkerChild>;
+    entity: EntityTableName.AGENT | EntityTableName.OPPORTUNITY | EntityTableName.VOLUNTEER;
+};
+export type ApiDistrictMarkerGet = {
+    markers: ApiDistrictMarker[];
+    total: number;
+    maxEntities: number;
+};

package/dist/types/api/district-marker.js

@@ -0,0 +1,4 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.apiDistrictMarkerMaxEntities = void 0;
+exports.apiDistrictMarkerMaxEntities = 500;

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

@@ -5,7 +5,9 @@ export * from "./appreciation";
 export * from "./comment";
 export * from "./common";
 export * from "./communication";
+export * from "./district-aggregate";
 export * from "./district-geometry";
+export * from "./district-marker";
 export * from "./document";
 export * from "./event";
 export * from "./language";

package/dist/types/api/index.js

@@ -21,7 +21,9 @@ __exportStar(require("./appreciation"), exports);
 __exportStar(require("./comment"), exports);
 __exportStar(require("./common"), exports);
 __exportStar(require("./communication"), exports);
+__exportStar(require("./district-aggregate"), exports);
 __exportStar(require("./district-geometry"), exports);
+__exportStar(require("./district-marker"), exports);
 __exportStar(require("./document"), exports);
 __exportStar(require("./event"), exports);
 __exportStar(require("./language"), exports);

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

@@ -125,6 +125,7 @@ export interface OpportunityCreateFormDataProps {
     accomp_information?: string;
     accomp_translation?: `${TranslatedIntoType}`;
     districtIds?: number[];
+    address?: ApiOpportunityAddress;
     languageIds: number[];
     activityIds: number[];
     skillIds: number[];
@@ -138,6 +139,11 @@ export interface OpportunityCreateFormDataProps {
     language: `${Lang}`;
 }
 export type OpportunityFormDataWithAgentSubmitter = VoidableUndefined<OpportunityCreateFormDataProps>;
+export interface ApiOpportunityAddress {
+    street: string;
+    postcode: string;
+    city: string;
+}
 export interface ApiOpportunityAgent {
     id: number;
     type: AgentType;
@@ -189,6 +195,7 @@ export interface ApiOpportunityGet extends ApiOpportunityGetList {
         time: string;
     };
     myMatchStatus?: OpportunityVolunteerStatusType | null;
+    address?: ApiOpportunityAddress | null;
 }
 export type ApiOpportunityLean = Omit<ApiOpportunityGet, "comments">;
 export type ApiOpportunityPatch = VoidableProps<{
@@ -215,6 +222,7 @@ export type ApiOpportunityPatch = VoidableProps<{
         name?: string;
     };
     accompanyingDetails: ApiOpportunityAccompanyingDetails;
+    address: ApiOpportunityAddress;
 }> & {
     originalLanguage?: Lang;
 };

package/package.json

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