@sillsdev/docu-notion 0.14.0-alpha.12 → 0.14.0-alpha.14

package/README.md

@@ -90,7 +90,9 @@ One of the big attractions of Notion for large documentation projects is that yo
 
 ## Slugs
 
-By default, pages will be given a slug based on the Notion id. For a human-readable URL, add a notion property named `Slug` to your database pages and enter a value in there that will work well in a URL. That is, no spaces, ?, #, /, etc.
+By default, pages will be given a slug based on the Notion ID. For a human-readable URL, add a notion property named `Slug` to your database pages and enter a value in there that will work well in a URL. That is, no spaces, ?, #, /, etc.
+
+See `Options` to require slugs in Notion.
 
 ## Known Limitations
 
@@ -130,7 +132,8 @@ Options:
 | -l, --log-level <level>               |           | Log level (choices: `info`, `verbose`, `debug`)                                                                                                                                                                    |
 | -i, --img-output-path <string>        |           | Path to directory where images will be stored. If this is not included, images will be placed in the same directory as the document that uses them, which then allows for localization of screenshots.             |
 | -p, --img-prefix-in-markdown <string> |           | When referencing an image from markdown, prefix with this path instead of the full img-output-path. Should be used only in conjunction with --img-output-path.                                                     |
-| -h, --help                            |           | display help for command                                                                                                                                                                                           |
+| --require-slugs                       |           | If set, docu-notion will fail if any pages it would otherwise publish are missing a slug in Notion. |
+| -h, --help                            |           | display help for command                              |
 
 # Plugins
 

package/dist/images.js

@@ -38,7 +38,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.cleanupOldImages = exports.parseImageBlock = exports.markdownToMDImageTransformer = exports.standardImageTransformer = exports.initImageHandling = void 0;
 const fs = __importStar(require("fs-extra"));
 const file_type_1 = __importDefault(require("file-type"));
-const node_fetch_1 = __importDefault(require("node-fetch"));
+const axios_1 = __importDefault(require("axios"));
 const Path = __importStar(require("path"));
 const MakeImagePersistencePlan_1 = require("./MakeImagePersistencePlan");
 const log_1 = require("./log");
@@ -131,9 +131,12 @@ function processImageBlock(imageBlock, pathToParentDocument, relativePathToThisP
 }
 function readPrimaryImage(imageSet) {
     return __awaiter(this, void 0, void 0, function* () {
-        const response = yield (0, node_fetch_1.default)(imageSet.primaryUrl);
-        const arrayBuffer = yield response.arrayBuffer();
-        imageSet.primaryBuffer = Buffer.from(arrayBuffer);
+        // In Mar 2024, we started having a problem getting a particular gif from imgur using
+        // node-fetch. Switching to axios resolved it. I don't know why.
+        const response = yield axios_1.default.get(imageSet.primaryUrl, {
+            responseType: "arraybuffer",
+        });
+        imageSet.primaryBuffer = Buffer.from(response.data, "utf-8");
         imageSet.fileType = yield file_type_1.default.fromBuffer(imageSet.primaryBuffer);
     });
 }
@@ -145,7 +148,7 @@ function saveImage(imageSet) {
             // if we have a urls for the localized screenshot, download it
             if ((localizedImage === null || localizedImage === void 0 ? void 0 : localizedImage.url.length) > 0) {
                 (0, log_1.verbose)(`Retrieving ${localizedImage.iso632Code} version...`);
-                const response = yield (0, node_fetch_1.default)(localizedImage.url);
+                const response = yield fetch(localizedImage.url);
                 const arrayBuffer = yield response.arrayBuffer();
                 buffer = Buffer.from(arrayBuffer);
             }

package/dist/pull.d.ts

@@ -8,6 +8,7 @@ export type DocuNotionOptions = {
     imgOutputPath: string;
     imgPrefixInMarkdown: string;
     statusTag: string;
+    requireSlugs?: boolean;
 };
 export declare function notionPull(options: DocuNotionOptions): Promise<void>;
 export declare function executeWithRateLimitAndRetries<T>(label: string, asyncFunction: () => Promise<T>): Promise<T>;

package/dist/pull.js

@@ -54,6 +54,7 @@ const counts = {
     skipped_because_empty: 0,
     skipped_because_status: 0,
     skipped_because_level_cannot_have_content: 0,
+    error_because_no_slug: 0,
 };
 function notionPull(options) {
     return __awaiter(this, void 0, void 0, function* () {
@@ -127,10 +128,16 @@ function outputPages(options, config, pages) {
                 ++context.counts.skipped_because_status;
             }
             else {
+                if (options.requireSlugs && !page.hasExplicitSlug) {
+                    (0, log_1.error)(`Page "${page.nameOrTitle}" is missing a required slug. (--require-slugs is set.)`);
+                    ++counts.error_because_no_slug;
+                }
                 const markdown = yield (0, transform_1.getMarkdownForPage)(config, context, page);
                 writePage(page, markdown);
             }
         }
+        if (counts.error_because_no_slug > 0)
+            (0, process_1.exit)(1);
         (0, log_1.info)(`Finished processing ${pages.length} pages`);
         (0, log_1.info)(JSON.stringify(counts));
     });

package/dist/run.js

@@ -61,7 +61,8 @@ function run() {
             "debug",
         ]))
             .option("-i, --img-output-path  <string>", "Path to directory where images will be stored. If this is not included, images will be placed in the same directory as the document that uses them, which then allows for localization of screenshots.")
-            .option("-p, --img-prefix-in-markdown <string>", "When referencing an image from markdown, prefix with this path instead of the full img-output-path. Should be used only in conjunction with --img-output-path.");
+            .option("-p, --img-prefix-in-markdown <string>", "When referencing an image from markdown, prefix with this path instead of the full img-output-path. Should be used only in conjunction with --img-output-path.")
+            .option("--require-slugs", "If set, docu-notion will fail if any pages it would otherwise publish are missing a slug in Notion.", false);
         commander_1.program.showHelpAfterError();
         commander_1.program.parse();
         (0, log_1.setLogLevel)(commander_1.program.opts().logLevel);

package/package.json

@@ -12,7 +12,7 @@
     "tsc": "tsc",
     "// test out with a private sample notion db": "",
     "large-site-test": "npm run ts -- -n $SIL_BLOOM_DOCS_NOTION_TOKEN -r $SIL_BLOOM_DOCS_NOTION_ROOT_PAGE  --locales en,fr   --log-level debug",
-    "pull-test-tagged": "npm run ts -- -n $DOCU_NOTION_INTEGRATION_TOKEN -r $DOCU_NOTION_TEST_ROOT_PAGE_ID  --log-level debug --status-tag test",
+    "pull-test-tagged": "npm run ts -- -n $DOCU_NOTION_INTEGRATION_TOKEN -r $DOCU_NOTION_TEST_ROOT_PAGE_ID  --log-level info --status-tag test",
     "pull-test-css": "npm run ts -- --css-output-directory ./test/css -n $DOCU_NOTION_INTEGRATION_TOKEN -r $DOCU_NOTION_TEST_ROOT_PAGE_ID  --log-level debug --status-tag test",
     "pull-sample-site": "npm run ts -- -n $DOCU_NOTION_INTEGRATION_TOKEN -r $DOCU_NOTION_SAMPLE_ROOT_PAGE  --log-level debug",
     "// test with a semi-stable/public site:": "",
@@ -20,26 +20,25 @@
     "pull-sample-with-paths": "npm run ts -- -n $DOCU_NOTION_INTEGRATION_TOKEN -r $DOCU_NOTION_SAMPLE_ROOT_PAGE -m ./sample --img-output-path ./sample_img"
   },
   "//file-type": "have to use this version before they switched to ESM, which gives a compile error related to require()",
-  "//node-fetch@2.6.6file-type": "have to use this version before they switched to ESM, which gives a compile error related to require()",
   "//chalk@4": "also ESM related problem",
   "//notion-client@4": "also ESM related problem",
   "//note: ts-node": "really is a runtime dependency",
   "dependencies": {
     "@notionhq/client": "2.2.3",
+    "axios": "^1.6.8",
     "chalk": "^4.1.2",
     "commander": "^9.2.0",
     "cosmiconfig": "^8.0.0",
     "cosmiconfig-typescript-loader": "^4.3.0",
-    "file-type": "16.5.1",
+    "file-type": "16.5.3",
     "fs-extra": "^10.1.0",
     "limiter": "^2.1.0",
     "markdown-table": "^2.0.0",
-    "node-fetch": "2.6.6",
     "notion-client": "^4",
     "notion-to-md": "3.1.1",
     "path": "^0.12.7",
-    "ts-node": "^10.2.1",
-    "sanitize-filename": "^1.6.3"
+    "sanitize-filename": "^1.6.3",
+    "ts-node": "^10.2.1"
   },
   "devDependencies": {
     "@types/fs-extra": "^9.0.13",
@@ -91,5 +90,5 @@
   "volta": {
     "node": "18.16.0"
   },
-  "version": "0.14.0-alpha.12"
+  "version": "0.14.0-alpha.14"
 }