sintfacilis 1.0.0

package/docs/acetate.config.js

@@ -0,0 +1,262 @@
+const path = require("path");
+const fs = require("fs");
+const { inspect } = require("util");
+const _ = require("lodash");
+
+const IS_DEV = process.env.ENV !== "prod";
+
+module.exports = function(acetate) {
+  /**
+   * Load SRI hashes.
+   */
+  let srihashes;
+  fs.readFile("docs/src/srihashes.json", (err, data) => {
+    srihashes = err
+      ? {
+          packages: {}
+        }
+      : JSON.parse(data);
+  });
+
+  /**
+   * Load all .html and markdown pages in the `src` folder, assigning them a
+   * default layout.
+   */
+  acetate.load("**/*.+(html|md)", {
+    basePath: "arcgis-rest-js",
+    metadata: {
+      layout: "_layout:main"
+    }
+  });
+
+  acetate.metadata("**/*", {
+    isDev: IS_DEV
+  });
+
+  /**
+   * Add a different layout for guides. Add an array of `titleSegments` to go
+   * inbetween the page title and the "Esri REST JS" title suffix.
+   */
+  acetate.metadata("guides/**/*", {
+    layout: "guides/_layout:content",
+    titleSegments: ["Guide"]
+  });
+
+  /**
+   * Now we need to make a new query called `guides` that will be used to render
+   * the guide navigation.
+   */
+  acetate.query(
+    /**
+     * results will be accessible as `queries.guides` in templates
+     */
+    "guides",
+    /**
+     * start by getting all markdown pages in the `guides` folder
+     */
+    "guides/**/*.md",
+    /**
+     * Now map over each page extracting values from it into a new array.
+     */
+    page => {
+      return {
+        title: page.navTitle || page.title,
+        order: page.order,
+        group: page.group,
+        url: page.url
+      };
+    },
+    /**
+     * Now reduce our array from the previous step sorting the items into sections
+     * based on their `group` property.
+     */
+    (sections, item) => {
+      if (!item.group) {
+        return sections;
+      }
+
+      // does this items `section` already have a `section` in `sections`?
+      const idx = _.findIndex(sections, section => section.id === item.group);
+
+      if (idx >= 0) {
+        // if it does push this item into it.
+        sections[idx].items.push(item);
+      } else {
+        // if it does not push a new `section` into `sections`.
+        sections.push({
+          name: _.startCase(item.group.replace(/\d-/, "")),
+          id: item.group,
+          items: [item]
+        });
+      }
+
+      /**
+       * sort our sections by their `id` (which starts with a number) an sort
+       * each sections items by their `order` property
+       */
+      return _(sections)
+        .sortBy("id")
+        .map(section => {
+          section.items = _.sortBy(section.items, "order");
+          return section;
+        })
+        .value();
+    },
+    /**
+     * The initial value for the above reduce function.
+     */
+    []
+  );
+
+  /**
+   * Load the typedoc.json file as a page in Acetate. This makes the watcher
+   * start looking for changes and we can listen for the events later.
+   */
+  acetate.load("typedoc.json", {
+    basePath: "arcgis-rest-js",
+    metadata: {
+      layout: false,
+      prettyUrl: false
+    }
+  });
+
+  /**
+   * Use Acetates generate helper to generate a page for each `declaration`
+   * and `package` in the typedoc.json and generate the search index file
+   */
+  acetate.generate((createPage, callback) => {
+    fs.readFile(
+      path.join(acetate.root, "src", "typedoc.json"),
+      (e, contents) => {
+        const typedoc = JSON.parse(contents.toString());
+
+        const declarationPages = typedoc.declarations.map(declaration => {
+          return createPage.fromTemplate(
+            declaration.src,
+            path.join(acetate.sourceDir, "api", "_declaration.html"),
+            Object.assign({}, declaration, {
+              layout: "api/_layout:content"
+            })
+          );
+        });
+
+        const packagePages = typedoc.packages.map(package => {
+          return createPage.fromTemplate(
+            package.src,
+            path.join(acetate.sourceDir, "api", "_package.html"),
+            Object.assign({}, package, {
+              layout: "api/_layout:content"
+            })
+          );
+        });
+
+        const searchIndex = createPage.fromTemplateString(
+          "arcgis-rest-js/js/index.js",
+          `const ESRI_REST_API_REF_INDEX = ${JSON.stringify(
+            typedoc.quickSearchIndex
+          )}`,
+          path.join(acetate.sourceDir, "js", "index.js"),
+          { layout: false, prettyUrl: false }
+        );
+
+        // once all the pages have been generated provide them to Acetate.
+        Promise.all(declarationPages.concat(packagePages)).then(pages => {
+          callback(null, pages.concat(searchIndex));
+        });
+      }
+    );
+  });
+
+  /**
+   * Also register typedoc.json as a global data object called `typedoc`.
+   */
+  acetate.data("typedoc", "typedoc.json");
+
+  /**
+   * Register some tools for working with the typedoc output.
+   */
+  acetate.global("API_TOOLS", {
+    findById: function(typedoc, id) {
+      return typedoc.index[id];
+    },
+    findByName: function(typedoc, name) {
+      return typedoc.declarations.find(c => c.name === name);
+    },
+    findChildById: function(id, children) {
+      return children.find(c => c.id === id);
+    }
+  });
+
+  acetate.filter("findPackage", (typedoc, name) => {
+    return typedoc.packages.find(p => p.pkg.name === name).pkg;
+  });
+
+  /**
+   * Listen for changes, if we see a change in typedoc.json we know we need to
+   * regenerate all the dymanically generated pages so reload this config file.
+   */
+  acetate.on("watcher:change", page => {
+    if (page.src === "typedoc.json") {
+      acetate.reloadConfig();
+    }
+  });
+
+  /**
+   * Template helper for safely inspecting objects with circular references.
+   */
+  acetate.filter("inspect", function(obj) {
+    return inspect(obj, { depth: 3 });
+  });
+
+  // without the '.js' on the end, for the benefit of the AMD sample
+  acetate.helper("cdnUrl", function(context, package) {
+    return `https://unpkg.com/${
+      package.name
+    }@${package.version}/dist/umd/${package.name.replace("@esri/arcgis-rest-", "")}.umd`;
+  });
+
+  // <code> friendly script tag string
+  acetate.helper("scriptTag", function(context, package) {
+    return acetate.nunjucks.renderString(
+      `{% highlight "html" %}<script src="https://unpkg.com/${package.name}@${
+        package.version
+      }/dist/umd/${package.name.replace(
+        "@esri/arcgis-rest-",
+        ""
+      )}.umd.min.js"></script>{% endhighlight %}`
+    );
+  });
+
+  // CDN with SRI only if hash exists
+  acetate.helper("scriptTagSRI", function(context, package) {
+    const hash = srihashes.packages[package.name];
+    if (hash) {
+      return acetate.nunjucks.renderString(`
+        {%highlight "html" %}
+        <script src="https://unpkg.com/${package.name}@${
+        package.version
+      }/dist/umd/${package.name.replace(
+        "@esri/arcgis-rest-",
+        ""
+      )}.umd.min.js" integrity="${hash}" crossorigin="anonymous"></script>{% endhighlight %}`);
+    } else {
+      return "";
+    }
+  });
+
+  acetate.helper("npmInstallCmd", function(context, package) {
+    const peers = package.peerDependencies
+      ? Object.keys(package.peerDependencies).map(
+          pkg => `${pkg}@${package.peerDependencies[pkg]} `
+        )
+      : [];
+    return `npm install ${package.name} ${peers.join(" ")}`;
+  });
+
+  acetate.filter("stripThisFromParams", function(params) {
+    if (!params || !params.length) {
+      return [];
+    }
+    return params.filter(p => p.name !== "this");
+  });
+};

package/docs/build-typedoc.js

@@ -0,0 +1,434 @@
+const spawn = require("cross-spawn");
+const { join } = require("path");
+const { readFile, writeFile } = require("fs");
+const _ = require("lodash");
+const OUTPUT = join(process.cwd(), "docs", "src", `typedoc.json`);
+const { prettyifyUrl } = require("acetate/lib/utils.js");
+const slug = require("slug");
+const minimatch = require("minimatch");
+const cheerio = require("cheerio");
+const MarkdownIt = require("markdown-it");
+const md = new MarkdownIt();
+
+(function generateTypeDoc() {
+  return new Promise((resolve, reject) => {
+    const typedoc = spawn(
+      "typedoc",
+      [
+        "-json",
+        OUTPUT,
+        "--exclude",
+        "**/*test.ts",
+        "--ignoreCompilerErrors",
+        "--module",
+        "common",
+        "--tsconfig",
+        "./tsconfig.json",
+        "--excludePrivate"
+      ],
+      {
+        stdio: "inherit"
+      }
+    );
+
+    typedoc.on("close", code => {
+      if (code !== 0) {
+        reject(code);
+        return;
+      }
+
+      readFile(OUTPUT, (error, content) => {
+        if (error) {
+          reject(error);
+          return;
+        }
+
+        resolve(JSON.parse(content.toString()));
+      });
+    });
+  })
+    .then(json => {
+      /**
+       * `json.children` will be a list of all TypeScript files in our project.
+       * We dont care about the files, we just need all their children so we reduce
+       * to a single list of everything in the entire project.
+       */
+      return json.children.reduce(
+        (allChildren, fileChildren) => allChildren.concat(fileChildren),
+        []
+      );
+    })
+    .then(children => {
+      /**
+       * We dont want TypeScript files that have been symlinked into `node_modules`
+       * folders by Lerna so ignore any child whose source file has `node_modules`
+       * in its `fileName`
+       */
+      return children.filter(
+        c => !minimatch(c.sources[0].fileName, "**/node_modules/**")
+      );
+    })
+    .then(children => {
+      /**
+       * We now only want children that are actual source files, not tests, so
+       * filter out all children without `src` in their path.
+       */
+      return children.filter(c =>
+        minimatch(c.sources[0].fileName, "**/src/**/*.ts")
+      );
+    })
+    .then(children => {
+      /**
+       * Some children might be empty so there is nothing to document in them.
+       * For example most `index.ts` files don't have anything besides `import`
+       * or `export` so we can safely filter these children out.
+       */
+      return children.filter(c => !!c.children);
+    })
+    .then(children => {
+      /**
+       * The `name` of each child is wrapped in extra quote marks remove these
+       * quote marks and add `.ts` back to the end of the `name`,
+       */
+      return children.map(child => {
+        child.name = child.name.replace(/"/g, "") + ".ts";
+        return child;
+      });
+    })
+    .then(children => {
+      /**
+       * Now determine which `package` each of our children belongs to based on
+       * its name.
+       */
+      return children.map(child => {
+        child.name = _.first(child.name.split("/"));
+        child.package = child.name;
+        return child;
+      });
+    })
+    .then(children => {
+      /**
+       * `children` is currently a list of all TypeScript source files in
+       * `packages`. `children.children` is an array of all declarations in that
+       * source file. We need to concat all `children.children` arrays together
+       * into a giant array of all declarations in all packages.
+       */
+      return children.reduce((allChildren, child) => {
+        if (!child.children) {
+          console.log(child);
+          return allChildren;
+        }
+        return allChildren.concat(
+          child.children.map(c => {
+            c.package = child.package;
+            return c;
+          })
+        );
+      }, []);
+    })
+    .then(declarations => {
+      /**
+       * Next we remove all children that are not exported out of their files.
+       */
+      return declarations.filter(
+        declaration => declaration.flags && declaration.flags.isExported
+      );
+    })
+    .then(declarations => {
+      const blacklist = [
+        "genericSearch",
+        "appendCustomParams",
+        "requiresFormData",
+        "processParams",
+        "encodeParam",
+        "encodeQueryString",
+        "encodeFormData",
+        "warn",
+        "cleanUrl",
+        "checkForErrors",
+        "determineOwner",
+        "isItemOwner",
+        "isOrgAdmin"
+      ];
+      /**
+       * Next we remove any declarations we want to blacklist from the API ref
+       */
+      return declarations.filter(
+        declaration => !blacklist.includes(declaration.name)
+      );
+    })
+    .then(declarations => {
+      /**
+       * Now that we have a list of all declarations across the entire project
+       * we can begin to generate additional information about each declaration.
+       * For example we can now determine the `src` of the page that will
+       * be generated for this declaration. Each `declaration` will also have
+       * `children` which we can generate and define an `icon` property for. These
+       * additional properties, `src`, `pageUrl`, `icon` and `children` are then
+       * merged into the `declaration`. This also adds a `title`, `description`
+       * and `titleSegments` to each page which are used in the template for SEO.
+       */
+      return declarations.map(declaration => {
+        const abbreviatedPackageName = declaration.package.replace(
+          "arcgis-rest-",
+          ""
+        );
+        const src = `arcgis-rest-js/api/${abbreviatedPackageName}/${
+          declaration.name
+        }.html`;
+        let children;
+
+        if (declaration.children) {
+          children = declaration.children.map(child => {
+            child.icon = `tsd-kind-${slug(
+              child.kindString
+            ).toLowerCase()} tsd-parent-kind-${slug(
+              declaration.kindString
+            ).toLowerCase()}`;
+
+            if (child.flags.isPrivate) {
+              child.icon += ` tsd-is-private`;
+            }
+
+            if (child.flags.isProtected) {
+              child.icon += ` tsd-is-protected`;
+            }
+
+            if (child.flags.isStatic) {
+              child.icon += ` tsd-is-static`;
+            }
+
+            if (child.signatures) {
+              child.signatures = child.signatures.map(sig => {
+                sig.icon = child.icon;
+                return sig;
+              });
+            }
+
+            return child;
+          });
+        }
+
+        declaration.title = declaration.name;
+        declaration.titleSegments = ["API Reference"];
+        declaration.description =
+          declaration.comment && declaration.comment.shortText
+            ? cheerio
+                .load(md.render(declaration.comment.shortText))
+                .text()
+                .replace("\n", "")
+            : "API Reference documentation for ${child.name}, part of ${declaration.package}.";
+
+        return Object.assign(declaration, {
+          src,
+          pageUrl: prettyifyUrl(src),
+          icon: `tsd-kind-${slug(declaration.kindString).toLowerCase()}`,
+          children
+        });
+      });
+    })
+    .then(declarations => {
+      /**
+       * We now have a list of `declarations` that will be used to generate the
+       * individual API reference pages, but we still need to generate a landing
+       * page for each `package`. Return a new object with our `declarations` and
+       * a new property `packages` which is an array of every `package` with a
+       * page `src`, a `pageUrl`, an `icon` and a list of `declarations`. This
+       * also adds a `title`, `description` and `titleSegments` to each page
+       * which are used in the template for SEO.
+       */
+      return {
+        declarations,
+        packages: _(declarations)
+          .map(d => d.package)
+          .uniq()
+          .reduce((packages, package) => {
+            const abbreviatedPackageName = package.replace("arcgis-rest-", "");
+            const src = `arcgis-rest-js/api/${abbreviatedPackageName}.html`;
+            const pkg = require(`${process.cwd()}/packages/${package}/package.json`);
+
+            packages.push({
+              package,
+              pkg,
+              title: package,
+              description: pkg.description,
+              titleSegments: ["API Reference"],
+              name: package,
+              declarations: declarations
+                .filter(d => d.package === package)
+                .sort((da, db) => {
+                  const types = [
+                    "Class",
+                    "Function",
+                    "Object literal",
+                    "Variable",
+                    "Enumeration",
+                    "Type alias",
+                    "Interface"
+                  ];
+
+                  const aIndex = types.findIndex(t => da.kindString === t);
+                  const bIndex = types.findIndex(t => db.kindString === t);
+
+                  if (aIndex > bIndex) {
+                    return 1;
+                  } else if (aIndex < bIndex) {
+                    return -1;
+                  } else {
+                    return 0;
+                  }
+                }),
+              icon: "tsd-kind-module",
+              src,
+              pageUrl: prettyifyUrl(src)
+            });
+            return packages;
+          }, [])
+      };
+    })
+    .then(api => {
+      /**
+       * Since we generated the TypeDoc for the entire project at once each
+       * `declaration` has a unique numerical `id` property. We occasionally
+       * need to lookup a declaration by its `id` so we can prebuild an index of
+       * them here.
+       */
+      api.index = api.declarations.reduce((index, declaration) => {
+        index[declaration.id] = declaration;
+        return index;
+      }, {});
+
+      return api;
+    })
+    .then(api => {
+      /**
+       * In order to power the API reference quick search we can build an array
+       * of all declarations and child items
+       */
+      api.quickSearchIndex = api.declarations.reduce(
+        (quickSearchIndex, declaration) => {
+          if (declaration.children) {
+            quickSearchIndex = quickSearchIndex.concat(
+              declaration.children.map(child => {
+                return {
+                  title: `${declaration.name}.${child.name}`,
+                  url: `${declaration.pageUrl}#${child.name}`,
+                  icon: child.icon
+                };
+              })
+            );
+          }
+
+          return quickSearchIndex.concat([
+            {
+              title: declaration.name,
+              url: declaration.pageUrl,
+              icon: declaration.icon
+            }
+          ]);
+        },
+        []
+      );
+
+      return api;
+    })
+    .then(api => {
+      /**
+       * Next we can sort the children of each declaration to sort by required/optional/inherited
+       */
+      api.declarations = api.declarations.map(declaration => {
+        if (declaration.children) {
+          declaration.children.sort((ca, cb) => {
+            const aIndex = rankChild(ca);
+            const bIndex = rankChild(cb);
+
+            if (aIndex > bIndex) {
+              return 1; // sort a below b
+            } else if (aIndex < bIndex) {
+              return -1; // sort a above b
+            } else {
+              return 0;
+            }
+            // return 0;
+          });
+        }
+
+        if (declaration.groups) {
+          declaration.groups.forEach(group => {
+            if (group.children) {
+              group.children.sort((ca, cb) => {
+                const childA = declaration.children.find(c => c.id === ca);
+                const childB = declaration.children.find(c => c.id === cb);
+
+                const aIndex = rankChild(childA);
+                const bIndex = rankChild(childB);
+
+                if (aIndex > bIndex) {
+                  return 1;
+                } else if (aIndex < bIndex) {
+                  return -1;
+                } else {
+                  return 0;
+                }
+                // return 0;
+              });
+            }
+          });
+        }
+
+        return declaration;
+      });
+
+      return api;
+    })
+    .then(api => {
+      /**
+       * Our final object looks like this:
+       *
+       * {
+       *   packages: [Array of packages.],
+       *   declarations: [Array of each exported declaration accross all source files.]
+       *   index: { Object mapping each declaration.id as a key with the declaration as its value}
+       * }
+       *
+       * We now export this to the Acetate source directory.
+       */
+      return new Promise((resolve, reject) => {
+        writeFile(OUTPUT, JSON.stringify(api, null, 2), e => {
+          if (e) {
+            reject(e);
+            return;
+          }
+
+          resolve(api);
+        });
+      });
+    })
+    .catch(e => {
+      console.error(e);
+    });
+})();
+
+function rankChild(child) {
+  const { isPrivate, isOptional, isStatic } = child
+    ? child.flags
+    : {};
+
+  const isInherited = child.inheritedFrom ? true : false;
+
+  let score = 0;
+
+  if (isPrivate) {
+    score += 30;
+  }
+  if (isStatic) {
+    score -= 15;
+  }
+  if (!isInherited) {
+    score -= 5;
+  }
+  if (!isOptional) {
+    score -= 15;
+  }
+  return score;
+}