need4deed-sdk 0.0.191 → 0.0.193

package/README.md

@@ -1,3 +1,9 @@
 # sdk
 
 Shared types for need4deed.org
+
+## Translation field names
+
+`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`.

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

@@ -215,7 +215,9 @@ export type ApiOpportunityPatch = VoidableProps<{
         name?: string;
     };
     accompanyingDetails: ApiOpportunityAccompanyingDetails;
-}>;
+}> & {
+    originalLanguage?: Lang;
+};
 export interface OpportunityVolunteer {
     id: number;
     status: OpportunityVolunteerStatusType;

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

@@ -1,4 +1,4 @@
-import { Lang } from "..";
+import { EntityTableName, Lang } from "..";
 export declare enum TranslationOrigin {
     REFERENCE = "reference",
     MACHINE = "machine",
@@ -17,12 +17,37 @@ export interface ApiFieldTranslation {
     status: TranslationStatus;
     lastErrorCode?: TranslationErrorCode;
 }
-export interface ApiFieldTranslationGet {
-    fieldName: string;
+export interface ApiOriginalLanguagePut {
+    language: Lang;
+}
+export type TranslationFieldsByEntity = {
+    [EntityTableName.OPPORTUNITY]: "title" | "info";
+    [EntityTableName.LANGUAGE]: "title";
+    [EntityTableName.CATEGORY]: "title" | "description";
+    [EntityTableName.ACTIVITY]: "title";
+    [EntityTableName.SKILL]: "title";
+    [EntityTableName.AGENT_TYPE]: "title";
+    [EntityTableName.SERVICE]: "title";
+    [EntityTableName.LEAD]: "title";
+};
+export type TranslatedEntityType = keyof TranslationFieldsByEntity;
+export interface ApiFieldTranslationGet<Entity extends TranslatedEntityType = TranslatedEntityType> {
+    fieldName: TranslationFieldsByEntity[Entity];
     original: string;
     originalLanguage?: Lang;
     translations: Partial<Record<Lang, ApiFieldTranslation>>;
 }
-export interface ApiOriginalLanguagePut {
-    language: Lang;
+export type ApiFieldTranslationPost = {
+    [Entity in TranslatedEntityType]: {
+        entityType: Entity;
+        entityId: number;
+        fieldName: TranslationFieldsByEntity[Entity];
+        language: Lang;
+        text: string;
+        original: string;
+    };
+}[TranslatedEntityType];
+export interface ApiFieldTranslationPatch {
+    text: string;
+    original: string;
 }

package/dist/types/api/translation.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.TranslationStatus = exports.TranslationOrigin = void 0;
+const __1 = require("..");
 var TranslationOrigin;
 (function (TranslationOrigin) {
     TranslationOrigin["REFERENCE"] = "reference";

package/dist/types/core.d.ts

@@ -69,7 +69,9 @@ export declare enum EntityTableName {
 export declare enum QueryParamsKeys {
     ACCOMPANYING = "accompanying",
     AVAILABILITY = "availability",
+    COMMUTE_OPPORTUNITY_ID = "commute-opportunity-id",
     COMMUTE_POSTCODE = "commute-postcode",
+    COMMUTE_VOLUNTEER_ID = "commute-volunteer-id",
     DISTRICT = "district",
     ENGAGEMENT = "engagement",
     GERMAN = "german",

package/dist/types/core.js

@@ -80,7 +80,9 @@ var QueryParamsKeys;
 (function (QueryParamsKeys) {
     QueryParamsKeys["ACCOMPANYING"] = "accompanying";
     QueryParamsKeys["AVAILABILITY"] = "availability";
+    QueryParamsKeys["COMMUTE_OPPORTUNITY_ID"] = "commute-opportunity-id";
     QueryParamsKeys["COMMUTE_POSTCODE"] = "commute-postcode";
+    QueryParamsKeys["COMMUTE_VOLUNTEER_ID"] = "commute-volunteer-id";
     QueryParamsKeys["DISTRICT"] = "district";
     QueryParamsKeys["ENGAGEMENT"] = "engagement";
     QueryParamsKeys["GERMAN"] = "german";

package/package.json

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