placementt-core 1.400.1022 → 1.400.1024

package/lib/index.d.ts

@@ -12,6 +12,7 @@ export * from "./surveys/types";
 export * from "./surveys/registry";
 export * from "./surveys/schedule";
 export * from "./skillsResolver";
+export * from "./lmi";
 export * from "./productResolver";
 export * from "./groups";
 export * from "./emailSections";

package/lib/index.js

@@ -32,6 +32,7 @@ __exportStar(require("./surveys/types"), exports);
 __exportStar(require("./surveys/registry"), exports);
 __exportStar(require("./surveys/schedule"), exports);
 __exportStar(require("./skillsResolver"), exports);
+__exportStar(require("./lmi"), exports);
 __exportStar(require("./productResolver"), exports);
 __exportStar(require("./groups"), exports);
 __exportStar(require("./emailSections"), exports);

package/lib/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;AACA,sDAAoC;AACpC,gEAA8C;AAC9C,0DAAwC;AACxC,2DAAyC;AACzC,kDAAgC;AAChC,uDAAqC;AACrC,4DAA0C;AAC1C,2DAAyC;AAEzC,oDAAkC;AAClC,8CAA4B;AAC5B,kDAAgC;AAChC,qDAAmC;AACnC,qDAAmC;AACnC,mDAAiC;AACjC,oDAAkC;AAClC,2CAAyB;AACzB,kDAAgC;AAChC,uDAAqC;AACrC,kDAAgC;AAChC,2DAAyC;AACzC,uDAAqC;AACrC,iDAA+B;AAC/B,8CAA4B;AAC5B,qDAAmC;AACnC,0CAAwB;AACxB,yCAAuB;AACvB,4DAA0C;AAC1C,kDAAgC;AAChC,iDAA+B;AAC/B,2CAAyB;AACzB,4DAA0C;AAC1C,oEAAiD;AACjD,yEAAuD;AACvD,kEAAgD;AAChD,kEAAgD;AAChD,oEAAkD;AAClD,yGAAuF;AACvF,0GAAwF;AACxF,+FAA6E;AAC7E,4DAA0C;AAC1C,oEAAkD;AAClD,iEAA+C;AAC/C,gEAA8C;AAC9C,2EAAyD;AACzD,6CAA2B;AAC3B,+CAA6B;AAC7B,8CAA4B;AAC5B,6DAAuE;AAA9D,2IAAA,OAAO,OAAuB"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;AACA,sDAAoC;AACpC,gEAA8C;AAC9C,0DAAwC;AACxC,2DAAyC;AACzC,kDAAgC;AAChC,uDAAqC;AACrC,4DAA0C;AAC1C,2DAAyC;AAEzC,oDAAkC;AAClC,8CAA4B;AAC5B,kDAAgC;AAChC,qDAAmC;AACnC,qDAAmC;AACnC,mDAAiC;AACjC,wCAAsB;AACtB,oDAAkC;AAClC,2CAAyB;AACzB,kDAAgC;AAChC,uDAAqC;AACrC,kDAAgC;AAChC,2DAAyC;AACzC,uDAAqC;AACrC,iDAA+B;AAC/B,8CAA4B;AAC5B,qDAAmC;AACnC,0CAAwB;AACxB,yCAAuB;AACvB,4DAA0C;AAC1C,kDAAgC;AAChC,iDAA+B;AAC/B,2CAAyB;AACzB,4DAA0C;AAC1C,oEAAiD;AACjD,yEAAuD;AACvD,kEAAgD;AAChD,kEAAgD;AAChD,oEAAkD;AAClD,yGAAuF;AACvF,0GAAwF;AACxF,+FAA6E;AAC7E,4DAA0C;AAC1C,oEAAkD;AAClD,iEAA+C;AAC/C,gEAA8C;AAC9C,2EAAyD;AACzD,6CAA2B;AAC3B,+CAA6B;AAC7B,8CAA4B;AAC5B,6DAAuE;AAA9D,2IAAA,OAAO,OAAuB"}

package/lib/lmi.d.ts

@@ -0,0 +1,21 @@
+import { JobRoleProfile } from "./callables/jobRoles";
+import { LmiOccupation } from "./typeDefinitions";
+/**
+ * The student-facing view of one LMI occupation.
+ *
+ * Lives in core because both readers now produce it: `jobRoles-getJobRoles` on
+ * the backend, and the "More information" popup on the web, which reads
+ * `lmiOccupations/{soc}` straight from Firestore rather than paying a cold
+ * function start to fetch one document by id. Shared so the two can't drift into
+ * showing a student different things depending on which door they came through.
+ *
+ * The shaping is presentation, not access control - the underlying data is
+ * public ONS / Nomis / IfATE reference data, and a signed-in client may read the
+ * collection. What it does is drop every field that means nothing to a
+ * fifteen-year-old (SOC codes, ONS region codes, source vintages) and rename the
+ * pay percentiles to words.
+ *
+ * @param {LmiOccupation} o the occupation document.
+ * @return {JobRoleProfile} the profile a student is shown.
+ */
+export declare function studentJobRoleProfile(o: LmiOccupation): JobRoleProfile;

package/lib/lmi.js

@@ -0,0 +1,57 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.studentJobRoleProfile = studentJobRoleProfile;
+/**
+ * The student-facing view of one LMI occupation.
+ *
+ * Lives in core because both readers now produce it: `jobRoles-getJobRoles` on
+ * the backend, and the "More information" popup on the web, which reads
+ * `lmiOccupations/{soc}` straight from Firestore rather than paying a cold
+ * function start to fetch one document by id. Shared so the two can't drift into
+ * showing a student different things depending on which door they came through.
+ *
+ * The shaping is presentation, not access control - the underlying data is
+ * public ONS / Nomis / IfATE reference data, and a signed-in client may read the
+ * collection. What it does is drop every field that means nothing to a
+ * fifteen-year-old (SOC codes, ONS region codes, source vintages) and rename the
+ * pay percentiles to words.
+ *
+ * @param {LmiOccupation} o the occupation document.
+ * @return {JobRoleProfile} the profile a student is shown.
+ */
+function studentJobRoleProfile(o) {
+    const national = o.salary?.national;
+    const salaryRegions = Object.values(o.salary?.byRegion ?? {})
+        .filter((r) => r.median !== null && r.median !== undefined)
+        .map((r) => ({ regionName: r.regionName, median: r.median }));
+    const employmentRegions = Object.values(o.employment?.byRegion ?? {})
+        .filter((r) => r.jobs !== null && r.jobs !== undefined)
+        .map((r) => ({ regionName: r.regionName, jobs: r.jobs }));
+    return {
+        soc: o.soc,
+        title: o.title,
+        description: o.description || undefined,
+        entryRoutes: o.entryRoutes || undefined,
+        ...(national ? {
+            salary: {
+                year: o.salary?.year,
+                lower: national.p10,
+                typical: national.median,
+                upper: national.p90,
+                ...(salaryRegions.length ? { byRegion: salaryRegions } : {}),
+            },
+        } : {}),
+        ...(employmentRegions.length ? {
+            employment: {
+                year: o.employment?.year,
+                byRegion: employmentRegions,
+            },
+        } : {}),
+        ...(o.skills?.length ? { skills: o.skills } : {}),
+        ...(o.apprenticeshipStandards?.length ? {
+            apprenticeshipStandards: o.apprenticeshipStandards
+                .map((s) => ({ name: s.name, level: s.level })),
+        } : {}),
+    };
+}
+//# sourceMappingURL=lmi.js.map

package/lib/lmi.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"lmi.js","sourceRoot":"","sources":["../src/lmi.ts"],"names":[],"mappings":";;AAqBA,sDAmCC;AArDD;;;;;;;;;;;;;;;;;GAiBG;AACH,SAAgB,qBAAqB,CAAC,CAAgB;IAClD,MAAM,QAAQ,GAAG,CAAC,CAAC,MAAM,EAAE,QAAQ,CAAC;IACpC,MAAM,aAAa,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,QAAQ,IAAI,EAAE,CAAC;SACxD,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,KAAK,IAAI,IAAI,CAAC,CAAC,MAAM,KAAK,SAAS,CAAC;SAC1D,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,EAAC,UAAU,EAAE,CAAC,CAAC,UAAU,EAAE,MAAM,EAAE,CAAC,CAAC,MAAM,EAAC,CAAC,CAAC,CAAC;IAChE,MAAM,iBAAiB,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,UAAU,EAAE,QAAQ,IAAI,EAAE,CAAC;SAChE,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,IAAI,IAAI,CAAC,CAAC,IAAI,KAAK,SAAS,CAAC;SACtD,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,EAAC,UAAU,EAAE,CAAC,CAAC,UAAU,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,EAAC,CAAC,CAAC,CAAC;IAE5D,OAAO;QACH,GAAG,EAAE,CAAC,CAAC,GAAG;QACV,KAAK,EAAE,CAAC,CAAC,KAAK;QACd,WAAW,EAAE,CAAC,CAAC,WAAW,IAAI,SAAS;QACvC,WAAW,EAAE,CAAC,CAAC,WAAW,IAAI,SAAS;QACvC,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC;YACX,MAAM,EAAE;gBACJ,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,IAAI;gBACpB,KAAK,EAAE,QAAQ,CAAC,GAAG;gBACnB,OAAO,EAAE,QAAQ,CAAC,MAAM;gBACxB,KAAK,EAAE,QAAQ,CAAC,GAAG;gBACnB,GAAG,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC,CAAC,EAAC,QAAQ,EAAE,aAAa,EAAC,CAAC,CAAC,CAAC,EAAE,CAAC;aAC7D;SACJ,CAAC,CAAC,CAAC,EAAE,CAAC;QACP,GAAG,CAAC,iBAAiB,CAAC,MAAM,CAAC,CAAC,CAAC;YAC3B,UAAU,EAAE;gBACR,IAAI,EAAE,CAAC,CAAC,UAAU,EAAE,IAAI;gBACxB,QAAQ,EAAE,iBAAiB;aAC9B;SACJ,CAAC,CAAC,CAAC,EAAE,CAAC;QACP,GAAG,CAAC,CAAC,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC,EAAC,MAAM,EAAE,CAAC,CAAC,MAAM,EAAC,CAAC,CAAC,CAAC,EAAE,CAAC;QAC/C,GAAG,CAAC,CAAC,CAAC,uBAAuB,EAAE,MAAM,CAAC,CAAC,CAAC;YACpC,uBAAuB,EAAE,CAAC,CAAC,uBAAuB;iBAC7C,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,EAAC,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC,KAAK,EAAC,CAAC,CAAC;SACpD,CAAC,CAAC,CAAC,EAAE,CAAC;KACV,CAAC;AACN,CAAC"}

package/package.json

@@ -2,7 +2,7 @@
   "private": false,
   "name": "placementt-core",
   "author": "Placementt",
-  "version": "1.400.1022",
+  "version": "1.400.1024",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
   "scripts": {

package/src/index.ts

@@ -14,6 +14,7 @@ export * from "./surveys/types";
 export * from "./surveys/registry";
 export * from "./surveys/schedule";
 export * from "./skillsResolver";
+export * from "./lmi";
 export * from "./productResolver";
 export * from "./groups";
 export * from "./emailSections";

package/src/lmi.ts

@@ -0,0 +1,57 @@
+import {JobRoleProfile} from "./callables/jobRoles";
+import {LmiOccupation} from "./typeDefinitions";
+
+/**
+ * The student-facing view of one LMI occupation.
+ *
+ * Lives in core because both readers now produce it: `jobRoles-getJobRoles` on
+ * the backend, and the "More information" popup on the web, which reads
+ * `lmiOccupations/{soc}` straight from Firestore rather than paying a cold
+ * function start to fetch one document by id. Shared so the two can't drift into
+ * showing a student different things depending on which door they came through.
+ *
+ * The shaping is presentation, not access control - the underlying data is
+ * public ONS / Nomis / IfATE reference data, and a signed-in client may read the
+ * collection. What it does is drop every field that means nothing to a
+ * fifteen-year-old (SOC codes, ONS region codes, source vintages) and rename the
+ * pay percentiles to words.
+ *
+ * @param {LmiOccupation} o the occupation document.
+ * @return {JobRoleProfile} the profile a student is shown.
+ */
+export function studentJobRoleProfile(o: LmiOccupation): JobRoleProfile {
+    const national = o.salary?.national;
+    const salaryRegions = Object.values(o.salary?.byRegion ?? {})
+        .filter((r) => r.median !== null && r.median !== undefined)
+        .map((r) => ({regionName: r.regionName, median: r.median}));
+    const employmentRegions = Object.values(o.employment?.byRegion ?? {})
+        .filter((r) => r.jobs !== null && r.jobs !== undefined)
+        .map((r) => ({regionName: r.regionName, jobs: r.jobs}));
+
+    return {
+        soc: o.soc,
+        title: o.title,
+        description: o.description || undefined,
+        entryRoutes: o.entryRoutes || undefined,
+        ...(national ? {
+            salary: {
+                year: o.salary?.year,
+                lower: national.p10,
+                typical: national.median,
+                upper: national.p90,
+                ...(salaryRegions.length ? {byRegion: salaryRegions} : {}),
+            },
+        } : {}),
+        ...(employmentRegions.length ? {
+            employment: {
+                year: o.employment?.year,
+                byRegion: employmentRegions,
+            },
+        } : {}),
+        ...(o.skills?.length ? {skills: o.skills} : {}),
+        ...(o.apprenticeshipStandards?.length ? {
+            apprenticeshipStandards: o.apprenticeshipStandards
+                .map((s) => ({name: s.name, level: s.level})),
+        } : {}),
+    };
+}