@mindful-web/export-framework 1.57.0 → 1.68.7

package/admin/components/document.marko.js

@@ -2,7 +2,7 @@
 "use strict";
 
 var marko_template = module.exports = require("marko/dist/html").t(__filename),
-    marko_componentType = "/@mindful-web/export-framework$1.57.0/admin/components/document.marko",
+    marko_componentType = "/@mindful-web/export-framework$1.68.7/admin/components/document.marko",
     marko_renderer = require("marko/dist/runtime/components/renderer"),
     styles_template = require("./styles.marko"),
     marko_loadTag = require("marko/dist/runtime/helpers/load-tag"),
@@ -42,7 +42,7 @@ marko_template._ = marko_renderer(render, {
   });
 
 marko_template.meta = {
-    id: "/@mindful-web/export-framework$1.57.0/admin/components/document.marko",
+    id: "/@mindful-web/export-framework$1.68.7/admin/components/document.marko",
     tags: [
       "./styles.marko",
       "marko/dist/core-tags/components/init-components-tag",

package/admin/components/export.marko.js

@@ -2,7 +2,7 @@
 "use strict";
 
 var marko_template = module.exports = require("marko/dist/html").t(__filename),
-    marko_componentType = "/@mindful-web/export-framework$1.57.0/admin/components/export.marko",
+    marko_componentType = "/@mindful-web/export-framework$1.68.7/admin/components/export.marko",
     marko_renderer = require("marko/dist/runtime/components/renderer"),
     helpers_escape_xml = require("marko/dist/runtime/html/helpers/escape-xml"),
     marko_escapeXml = helpers_escape_xml.x,
@@ -28,5 +28,5 @@ marko_template._ = marko_renderer(render, {
   });
 
 marko_template.meta = {
-    id: "/@mindful-web/export-framework$1.57.0/admin/components/export.marko"
+    id: "/@mindful-web/export-framework$1.68.7/admin/components/export.marko"
   };

package/admin/components/styles.marko.js

@@ -2,7 +2,7 @@
 "use strict";
 
 var marko_template = module.exports = require("marko/dist/html").t(__filename),
-    marko_componentType = "/@mindful-web/export-framework$1.57.0/admin/components/styles.marko",
+    marko_componentType = "/@mindful-web/export-framework$1.68.7/admin/components/styles.marko",
     marko_renderer = require("marko/dist/runtime/components/renderer");
 
 function render(input, out, __component, component, state) {
@@ -17,5 +17,5 @@ marko_template._ = marko_renderer(render, {
   });
 
 marko_template.meta = {
-    id: "/@mindful-web/export-framework$1.57.0/admin/components/styles.marko"
+    id: "/@mindful-web/export-framework$1.68.7/admin/components/styles.marko"
   };

package/admin/templates/index.marko.js

@@ -2,7 +2,7 @@
 "use strict";
 
 var marko_template = module.exports = require("marko/dist/html").t(__filename),
-    marko_componentType = "/@mindful-web/export-framework$1.57.0/admin/templates/index.marko",
+    marko_componentType = "/@mindful-web/export-framework$1.68.7/admin/templates/index.marko",
     marko_renderer = require("marko/dist/runtime/components/renderer"),
     marko_forOf = require("marko/dist/runtime/helpers/for-of"),
     export_template = require("../components/export.marko"),
@@ -82,7 +82,7 @@ marko_template._ = marko_renderer(render, {
   });
 
 marko_template.meta = {
-    id: "/@mindful-web/export-framework$1.57.0/admin/templates/index.marko",
+    id: "/@mindful-web/export-framework$1.68.7/admin/templates/index.marko",
     tags: [
       "../components/export.marko",
       "../components/document.marko"

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mindful-web/export-framework",
-  "version": "1.57.0",
+  "version": "1.68.7",
   "description": "Core framework for Mindful Web Exports.",
   "author": "Josh Worden <josh@parameter1.com>",
   "main": "src/index.js",
@@ -23,6 +23,7 @@
     "@mindful-web/tenant-context": "^1.0.0",
     "@mindful-web/utils": "^1.57.0",
     "@mindful-web/web-common": "^1.57.0",
+    "aws-sdk": "^2.1693.0",
     "express": "^4.18.2",
     "graphql": "^14.7.0",
     "graphql-tag": "^2.12.6",
@@ -32,7 +33,8 @@
     "moment": "^2.29.1",
     "moment-timezone": "^0.5.40",
     "node-fetch": "^2.6.9",
-    "recursive-readdir": "^2.2.3"
+    "recursive-readdir": "^2.2.3",
+    "zip-folder": "^1.0.0"
   },
   "peerDependencies": {
     "@mindful-web/marko-core": "^1.0.0"
@@ -40,5 +42,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "9c22257ffa98b3558deb5f6b8cb5088a89fc78f1"
+  "gitHead": "102f5970279bda3f1473132df51b82381eb6dc46"
 }

package/utils/README.md

@@ -0,0 +1,29 @@
+# common utilities
+
+| Module                       | When to reach for it                                                                                          |
+| ---------------------------- | ------------------------------------------------------------------------------------------------------------- |
+| `retrieve-companies`         | Paginated companies query with optional filters (magazineSchedule, descendantSectionIds, taxonomy). Has a JSDoc with per-site examples. |
+| `retrieve-sections`          | Fetch a section + its descendant tree by alias. Most category-style exports use this.                          |
+| `get-child-sections`         | Walk a section's immediate children.                                                                          |
+| `format-text`                | Normalize HTML entities and Unicode for InDesign-tagged text output.                                          |
+| `replace-characters`         | Lower-level helper used by `format-text`; rarely imported directly.                                           |
+| `image-handler`              | Download images to a tmp dir, zip the result, optionally upload to S3 (`downloadImages`, `zipItUp`, `uploadToS3`). |
+| `abbreviation-to-name`       | Object-form state/province lookup, e.g. `{ us: { AL: 'Alabama', ... }, canada: { ... } }`. Use when consumers look up by abbreviation key. |
+| `state-abbreviations-list`   | Array-form `[{ key, name }, ...]` of the same data. Use when consumers iterate the list (e.g. to render in display order). |
+| `state-name-to-abrev`        | Reverse lookup (name → 2-letter code), including Canadian provinces.                                          |
+| `country-to-abbreviation`    | Array of `{ abbreviation, name }` country entries.                                                            |
+| `load-exports`               | _Framework-internal._ Boot-time loader used by [start-server.js](../start-server.js). Recursively scans the site's `exportPath`, matches files against `coreConfig.fileExtensions`, and returns descriptors `{ key, route, format, filename, fn, name, site? }`. Memoized as a singleton promise — not intended for per-request use. |
+| `website-factory`            | _Framework-internal._ Wraps a site record with `get` / `getAsArray` / `getAsObject` accessors (backed by `@mindful-web/object-path`) so [express/template-router.js](../express/template-router.js) can expose a uniform `website` helper to export functions. |
+
+## Patterns
+
+Several of these started life as duplicated per-site files. They were
+consolidated here once they were byte-identical across 3+ sites. When a util
+would otherwise need to vary per-site, prefer the **options-object pattern**
+demonstrated by `retrieve-companies`:
+
+- The exported function takes an `options` object with documented defaults
+- Per-site behavior expressed by importing the function and passing different
+  options — typically via a per-site `utils/retrieve-companies-options.js`
+- This keeps the function shared while letting each site customize behavior
+  without forking the file

package/utils/abbreviation-to-name.js

@@ -0,0 +1,71 @@
+module.exports = {
+  us: {
+    AL: 'Alabama',
+    AK: 'Alaska',
+    AZ: 'Arizona',
+    AR: 'Arkansas',
+    CA: 'California',
+    CO: 'Colorado',
+    CT: 'Connecticut',
+    DE: 'Delaware',
+    DC: 'District of Columbia',
+    FL: 'Florida',
+    GA: 'Georgia',
+    HI: 'Hawaii',
+    ID: 'Idaho',
+    IL: 'Illinois',
+    IN: 'Indiana',
+    IA: 'Iowa',
+    KS: 'Kansas',
+    KY: 'Kentucky',
+    LA: 'Louisiana',
+    ME: 'Maine',
+    MD: 'Maryland',
+    MA: 'Massachusetts',
+    MI: 'Michigan',
+    MN: 'Minnesota',
+    MS: 'Mississippi',
+    MO: 'Missouri',
+    MT: 'Montana',
+    NE: 'Nebraska',
+    NV: 'Nevada',
+    NH: 'New Hampshire',
+    NJ: 'New Jersey',
+    NM: 'New Mexico',
+    NY: 'New York',
+    NC: 'North Carolina',
+    ND: 'North Dakota',
+    OH: 'Ohio',
+    OK: 'Oklahoma',
+    OR: 'Oregon',
+    PA: 'Pennsylvania',
+    RI: 'Rhode Island',
+    SC: 'South Carolina',
+    SD: 'South Dakota',
+    TN: 'Tennessee',
+    TX: 'Texas',
+    UT: 'Utah',
+    VT: 'Vermont',
+    VA: 'Virginia',
+    WA: 'Washington',
+    WV: 'West Virginia',
+    WI: 'Wisconsin',
+    WY: 'Wyoming',
+  },
+  canada: {
+    AB: 'Alberta',
+    BC: 'British Columbia',
+    MB: 'Manitoba',
+    NB: 'New Brunswick',
+    NL: 'Newfoundland and Labrador',
+    NF: 'Newfoundland and Labrador',
+    NT: 'Northwest Territories',
+    NS: 'Nova Scotia',
+    NU: 'Nunavut',
+    ON: 'Ontario',
+    PE: 'Prince Edward Island',
+    QC: 'Quebec',
+    SK: 'Saskatchewan',
+    YT: 'Yukon',
+  },
+};