autnam 1.0.0

package/prettier-package-json.config.cjs

@@ -0,0 +1,81 @@
+module.exports = {
+  keyOrder: [
+    /**
+     * Details
+     */
+    "$schema",
+    "private",
+    "name",
+    "version",
+    "description",
+    "license",
+    "keywords",
+    "type",
+
+    /**
+     * Configuration
+     */
+    "main",
+    "module",
+    "browser",
+    "unpkg",
+    "exports",
+    "types",
+    "sideEffects",
+    "man",
+    "preferGlobal",
+    "bin",
+    "files",
+    "directories",
+    "scripts",
+    "config",
+    "typings",
+    "eslintIgnore",
+    "lint-staged",
+
+    /**
+     * Constraints
+     */
+    "engines",
+    "engineStrict",
+    "os",
+    "cpu",
+
+    /**
+     * Dependencies
+     */
+    "dependencies",
+    "bundleDependencies",
+    "bundledDependencies",
+    "peerDependencies",
+    "peerDependenciesMeta",
+    "optionalDependencies",
+    "devDependencies",
+
+    /**
+     * Additional Info
+     */
+    "author",
+    "maintainers",
+    "contributors",
+    "homepage",
+    "repository",
+    "bugs",
+
+    /**
+     * Yarn specific
+     */
+    "workspaces",
+    "resolutions",
+
+    /**
+     * Package publishing configuration
+     */
+    "publishConfig",
+
+    /**
+     * Esri specific
+     */
+    "esri"
+  ]
+};

package/rollup.js

@@ -0,0 +1,152 @@
+import typescript from "rollup-plugin-typescript";
+import nodeResolve from "@rollup/plugin-node-resolve";
+import filesize from "rollup-plugin-filesize";
+import { terser } from "rollup-plugin-terser";
+
+import * as path from "path";
+import * as fs from "fs";
+
+/**
+ * Since Rollup runs inside each package we can just get the current
+ * package we are bundling.
+ */
+const pkg = require(path.join(process.cwd(), "package.json"));
+
+/**
+ * and dig out its name.
+ */
+const { name } = pkg;
+
+/**
+ * to construct a copyright banner
+ */
+
+const copyright = `/* @preserve
+* ${pkg.name} - v${pkg.version} - ${pkg.license}
+* Copyright (c) 2017-${new Date().getFullYear()} Esri, Inc.
+* ${new Date().toString()}
+*/`;
+
+/**
+ * The module name will be the name of the global variable used in UMD builds.
+ * All exported members of each package will be attached to this global.
+ */
+const moduleName = "arcgisRest";
+
+/**
+ * Now we need to discover all the `@esri/arcgis-rest-*` package names so we can create
+ * the `globals` and `externals` to pass to Rollup. @esri/arcgis-rest-fetch is excluded
+ * from this because we WANT to bundle it since it only contains references to global
+ * fetch
+ */
+const packageNames = fs
+  .readdirSync(path.join(__dirname, "packages"))
+  .filter((p) => p[0] !== ".")
+  .filter((p) => p !== "arcgis-rest-fetch")
+  .filter((p) => p !== "arcgis-rest-form-data")
+  .map((p) => {
+    return require(path.join(__dirname, "packages", p, "package.json")).name;
+  }, {});
+
+/**
+ * Rollup will use this map to determine where to lookup modules on the global
+ * window object when neither AMD or CommonJS is being used. This configuration
+ * will cause Rollup to lookup all imports from our packages on a single global
+ * `arcgisRest` object.
+ */
+const globals = packageNames.reduce((globals, p) => {
+  globals[p] = moduleName;
+  return globals;
+}, {});
+
+const baseConfig = {
+  input: "./src/index.ts",
+  context: "window",
+  inlineDynamicImports: true
+};
+
+const baseOutput = {
+  sourcemap: true,
+  banner: copyright,
+  name: moduleName,
+  extend: true // causes this module to extend the global specified by `moduleName`
+};
+
+const basePlugins = function () {
+  return [
+    typescript({
+      target: "ES2017" // force typescript compile target
+    }),
+    nodeResolve()
+  ];
+};
+
+const productionPlugins = function () {
+  return [
+    filesize(),
+    terser({
+      format: {
+        comments: function (node, comment) {
+          var text = comment.value;
+          var type = comment.type;
+          if (type == "comment2") {
+            // multiline comment
+            return /@preserve|@license|@cc_on/i.test(text);
+          }
+        }
+      }
+    })
+  ];
+};
+
+const packageName = name.replace("@esri/arcgis-rest-", "");
+
+const umdConfig = {
+  ...baseConfig,
+  output: {
+    file: `./dist/bundled/${packageName}.umd.js`,
+    format: "umd",
+    ...baseOutput,
+    globals
+  },
+  external: packageNames,
+  plugins: [...basePlugins()]
+};
+
+const umdMinConfig = {
+  ...baseConfig,
+  output: {
+    file: `./dist/bundled/${packageName}.umd.min.js`,
+    format: "umd",
+    ...baseOutput,
+    globals
+  },
+  external: packageNames,
+  plugins: [...basePlugins(), ...productionPlugins()]
+};
+
+const esmConfig = {
+  ...baseConfig,
+  output: {
+    file: `./dist/bundled/${packageName}.esm.js`,
+    format: "es",
+    ...baseOutput,
+    globals: name === "arcgis-rest-request" ? undefined : globals
+  },
+  external: name === "arcgis-rest-request" ? undefined : packageNames,
+  plugins: [...basePlugins()]
+};
+
+const esmMinConfig = {
+  ...baseConfig,
+  output: {
+    file: `./dist/bundled/${packageName}.esm.min.js`,
+    format: "es",
+    ...baseOutput,
+    globals: name === "arcgis-rest-request" ? undefined : globals
+  },
+  external: name === "arcgis-rest-request" ? undefined : packageNames,
+  plugins: [...basePlugins(), ...productionPlugins()]
+};
+
+export default [umdConfig, umdMinConfig, esmConfig, esmMinConfig];

package/scripts/create-dist-package-jsons.js

@@ -0,0 +1,17 @@
+/**
+ * Creates packages.jsons in the different dist folders to hint the correct module system to Node.
+ *
+ * Inspired by: https://www.sensedeep.com/blog/posts/2021/how-to-create-single-source-npm-module.html
+ */
+import { writeFile } from "fs/promises";
+import { join } from "path";
+
+writeFile(
+  join(process.cwd(), "dist", "esm", "package.json"),
+  JSON.stringify({ type: "module" }, null, 2)
+);
+
+writeFile(
+  join(process.cwd(), "dist", "cjs", "package.json"),
+  JSON.stringify({ type: "commonjs" }, null, 2)
+);

package/scripts/deploy-doc-site.js

@@ -0,0 +1,16 @@
+import ghpages from "gh-pages";
+
+ghpages.publish(
+  "docs/build",
+  {
+    branch: "gh-pages",
+    repo: "https://github.com/Esri/arcgis-rest-js.git"
+  },
+  function (err) {
+    if (err) {
+      console.log("uh oh", err);
+    } else {
+      console.log("Deployed docs site!");
+    }
+  }
+);

package/scripts/generate-sri-hashes.js

@@ -0,0 +1,52 @@
+/**
+ * Generate a JSON file containing hash of packages and sha384 hashes of minified umd dist files.
+ */
+import { join, resolve } from "path";
+import { readFile, writeFile } from "fs/promises";
+import { readFileSync } from "fs";
+import { generate } from "sri-toolbox";
+import getPackages from "./get-package-json.js";
+
+const OUTPUT = join(process.cwd(), `srihashes.json`);
+const VERSION = JSON.parse(readFileSync("package.json")).version;
+
+getPackages()
+  .then((packageJsons) => {
+    return Promise.all(
+      packageJsons
+        .filter((p) => !!p.unpkg)
+        .map((pkg) => {
+          return readFile(
+            resolve(join("packages", pkg.name.replace("@esri/", "")), pkg.unpkg)
+          ).then((data) => {
+            return {
+              pkg,
+              hash: generate(
+                {
+                  algorithms: ["sha384"]
+                },
+                data
+              )
+            };
+          });
+        })
+    );
+  })
+  .then((res) => {
+    const json = {
+      version: VERSION,
+      packages: {}
+    };
+    res.forEach(({ hash, pkg }) => {
+      if (hash) {
+        json.packages[pkg.name] = hash;
+      }
+    });
+    writeFile(OUTPUT, JSON.stringify(json, null, "  "), "utf8", (err) => {
+      if (err) throw err;
+    });
+  })
+  .catch((err) => {
+    console.log(err);
+    // make node happy to see `catch()`
+  });

package/scripts/get-package-json.js

@@ -0,0 +1,27 @@
+import { readFile } from "fs/promises";
+import { globby } from "globby";
+import pkgDir from "pkg-dir";
+import { join, dirname } from "path";
+
+const __dirname = dirname(new URL(import.meta.url).pathname);
+
+/**
+ * Returns an object like:
+ *
+ * {
+ *   packageName: package.json contents
+ * }
+ *
+ * For all packages in the packages/* folder.
+ */
+export default async function getPackages() {
+  const rootDir = await pkgDir(__dirname);
+  const packageFiles = await globby(join(rootDir, "packages/*/package.json"));
+  return Promise.all(
+    packageFiles.map((pkgPath) => {
+      return readFile(pkgPath).then((pkg) => {
+        return JSON.parse(pkg);
+      });
+    })
+  );
+}

package/scripts/run-demo-server.js

@@ -0,0 +1,21 @@
+import browserSync from "browser-sync";
+import { join, resolve, dirname } from "path";
+import getPackages from "./get-package-json.js";
+
+(async () => {
+  const cwd = process.cwd();
+  const packages = await getPackages();
+  const __dirname = dirname(new URL(import.meta.url).pathname);
+  const packageFolders = packages.map(({ name }) => {
+    return {
+      route: `/${name}`,
+      dir: resolve(join(__dirname, "../", "node_modules", name))
+    };
+  });
+
+  browserSync.create().init({
+    port: 8080,
+    server: cwd,
+    serveStatic: [...packageFolders]
+  });
+})();

package/scripts/test-helpers.ts

@@ -0,0 +1,20 @@
+/* Copyright (c) 2018 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+
+import { File } from "@esri/arcgis-rest-form-data";
+
+export const TOMORROW = (function () {
+  const now = new Date();
+  now.setDate(now.getDate() + 1);
+  return now;
+})();
+
+export const YESTERDAY = (function () {
+  const now = new Date();
+  now.setDate(now.getDate() - 1);
+  return now;
+})();
+
+export function attachmentFile(): any {
+  return new File(["foo"], "foo.txt", { type: "text/plain" });
+}

package/tsconfig.json

@@ -0,0 +1,62 @@
+{
+  "compilerOptions": {
+    /* Basic Options */
+    "target": "ES2017" /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', or 'ESNEXT'. */,
+    "module": "ESNEXT" /* Specify module code generation: 'commonjs', 'amd', 'system', 'umd', 'es2015', or 'ESNext'. */,
+    "lib": [
+      "DOM",
+      "ES2017"
+    ] /* Specify library files to be included in the compilation:  */,
+    // "allowJs": true,                       /* Allow javascript files to be compiled. */
+    // "checkJs": true,                       /* Report errors in .js files. */
+    // "jsx": "preserve",                     /* Specify JSX code generation: 'preserve', 'react-native', or 'react'. */
+    "sourceMap": true /* Generates corresponding '.map' file. */,
+    // "outFile": "./",                       /* Concatenate and emit output to single file. */
+    // "outDir": "./",                        /* Redirect output structure to the directory. */
+    // "rootDir": "./",                       /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */
+    // "removeComments": true,                /* Do not emit comments to output. */
+    // "noEmit": true,                        /* Do not emit outputs. */
+    "importHelpers": true /* Import emit helpers from 'tslib'. */,
+    // "downlevelIteration": true,            /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */
+    // "isolatedModules": true,               /* Transpile each file as a separate module (similar to 'ts.transpileModule'). */
+
+    /* Strict Type-Checking Options */
+    "strict": true /* Enable all strict type-checking options. */,
+    "noImplicitAny": true /* Raise error on expressions and declarations with an implied 'any' type. */,
+    "strictNullChecks": false /* Enable strict null checks. */,
+    // "noImplicitThis": true,                /* Raise error on 'this' expressions with an implied 'any' type. */
+    "alwaysStrict": true /* Parse in strict mode and emit "use strict" for each source file. */,
+
+    /* Additional Checks */
+    // "noUnusedLocals": true,                /* Report errors on unused locals. */
+    // "noUnusedParameters": true,            /* Report errors on unused parameters. */
+    // "noImplicitReturns": true,             /* Report error when not all code paths in function return a value. */
+    // "noFallthroughCasesInSwitch": true,    /* Report errors for fallthrough cases in switch statement. */
+
+    /* Module Resolution Options */
+    "moduleResolution": "node" /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */,
+    // "baseUrl": "./",                       /* Base directory to resolve non-absolute module names. */
+    // "paths": {},                           /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */
+    // "rootDirs": [],                        /* List of root folders whose combined content represents the structure of the project at runtime. */
+    "typeRoots": [
+      "./node_modules/@types"
+    ] /* List of folders to include type definitions from. */,
+    "types": [
+      "node",
+      "jasmine"
+    ], /* Type declaration files to be included in compilation. */
+    "allowSyntheticDefaultImports": true,  /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */
+
+    /* Source Map Options */
+    // "sourceRoot": "./",                    /* Specify the location where debugger should locate TypeScript files instead of source locations. */
+    // "mapRoot": "./",                       /* Specify the location where debugger should locate map files instead of generated locations. */
+    // "inlineSourceMap": true,               /* Emit a single file with source maps instead of having a separate file. */
+    "inlineSources": true,                 /* Emit the source alongside the sourcemaps within a single file; requires '--inlineSourceMap' or '--sourceMap' to be set. */
+
+    /* Experimental Options */
+    // "experimentalDecorators": true,        /* Enables experimental support for ES7 decorators. */
+    // "emitDecoratorMetadata": true,         /* Enables experimental support for emitting type metadata for decorators. */
+  },
+  "exclude": ["node_modules"],
+  "include": ["./node_modules/@types", "packages", "scripts"]
+}

package/typedoc.json

@@ -0,0 +1,14 @@
+{
+  "out": "typedoc",
+  "json": "typedoc/typedoc.json",
+  "logLevel": "Verbose",
+  "packages": [
+    "./packages/arcgis-rest-auth/",
+    "./packages/arcgis-rest-demographics/",
+    "./packages/arcgis-rest-feature-service/",
+    "./packages/arcgis-rest-geocoding/",
+    "./packages/arcgis-rest-portal/",
+    "./packages/arcgis-rest-request/",
+    "./packages/arcgis-rest-routing/"
+  ]
+}