ducimusipsa 1.0.0

package/docs/src/sass/_icons.scss

@@ -0,0 +1,157 @@
+$type-icons: (object-literal),  (class),  ('class.tsd-has-type-parameter'),
+   (interface),  ('interface.tsd-has-type-parameter'),
+   (module, external-module),  (enumeration),  (enumeration-member),
+   (signature),  (type-alias);
+
+$member-icons: (variable, property),  (get-signature),  (set-signature),
+   (accessor),  (function, method, call-signature),
+   ('function.tsd-has-type-parameter', 'method.tsd-has-type-parameter'),
+   (constructor, constructor-signature),  (index-signature),  (event),
+   (property),  (function, method, call-signature),  (event);
+
+@mixin retina () {
+  @media (-webkit-min-device-pixel-ratio: 1.5),
+    (min-device-pixel-ratio: 1.5),
+    (min-resolution: 144dpi) {
+    @content;
+  }
+}
+
+// parameter
+// type-literal
+// type-parameter
+
+.tsd-kind-icon {
+  display: inline-block;
+  position: relative;
+  padding-left: 20px;
+  text-indent: -20px;
+
+  &:before {
+    content: '';
+    display: inline-block;
+    vertical-align: middle;
+    width: 17px;
+    height: 17px;
+    margin: 0 3px 2px 0;
+    background-image: url(../img/icons.png);
+
+    @include retina {
+      background-image: url(../img/icons@2x.png);
+      background-size: 238px 204px;
+    }
+  }
+}
+
+.tsd-signature.tsd-kind-icon:before {
+  background-position: 0 -153px;
+}
+
+$icon-size: 17px;
+$type: -0 * $icon-size;
+$type-protected: -1 * $icon-size;
+$type-private: -2 * $icon-size;
+$member-class-public: -3 * $icon-size;
+$member-class-public-inherited: -4 * $icon-size;
+$member-class-protected: -5 * $icon-size;
+$member-class-protected-inherited: -6 * $icon-size;
+$member-private: -7 * $icon-size;
+$member: -8 * $icon-size;
+$member-protected: -9 * $icon-size;
+$member-enum: -10 * $icon-size;
+$member-enum-protected: -11 * $icon-size;
+$member-interface: -12 * $icon-size;
+$member-interface-inherited: -13 * $icon-size;
+
+@for $index from 1 through length($type-icons) {
+  @each $kind in nth($type-icons, $index) {
+    $selector: '.tsd-kind-' + $kind;
+    $offset: -#{17 * ($index)}px;
+
+    #{$selector} {
+      > .tsd-kind-icon:before {
+        background-position: $type $offset;
+      }
+
+      &.tsd-is-protected > .tsd-kind-icon:before {
+        background-position: $type-protected $offset;
+      }
+
+      &.tsd-is-private > .tsd-kind-icon:before {
+        background-position: $type-private $offset;
+      }
+    }
+  }
+}
+
+@for $index from 1 through length($member-icons) {
+  @each $kind in nth($member-icons, $index) {
+    $offset: -#{17 * ($index - 1)}px;
+    $selector: '.tsd-kind-' + $kind;
+    @if $index == 10 {
+      $selector: '.tsd-is-static';
+    } @else if $index > 10 {
+      $selector: '.tsd-is-static.tsd-kind-' + $kind;
+    }
+
+    #{$selector} {
+      > .tsd-kind-icon:before {
+        background-position: $member $offset;
+      }
+
+      &.tsd-is-protected > .tsd-kind-icon:before {
+        background-position: $member-protected $offset;
+      }
+
+      &.tsd-is-private > .tsd-kind-icon:before {
+        background-position: $member-private $offset;
+      }
+
+      &.tsd-parent-kind-class {
+        > .tsd-kind-icon:before {
+          background-position: $member-class-public $offset;
+        }
+
+        &.tsd-is-inherited > .tsd-kind-icon:before {
+          background-position: $member-class-public-inherited $offset;
+        }
+
+        &.tsd-is-protected > .tsd-kind-icon:before {
+          background-position: $member-class-protected $offset;
+        }
+
+        &.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before {
+          background-position: $member-class-protected-inherited $offset;
+        }
+
+        &.tsd-is-private > .tsd-kind-icon:before {
+          background-position: $member-private $offset;
+        }
+      }
+
+      &.tsd-parent-kind-enumeration {
+        > .tsd-kind-icon:before {
+          background-position: $member-enum $offset;
+        }
+
+        &.tsd-is-protected > .tsd-kind-icon:before {
+          background-position: $member-enum-protected $offset;
+        }
+
+        &.tsd-is-private > .tsd-kind-icon:before {
+          background-position: $member-private $offset;
+        }
+      }
+
+      &.tsd-parent-kind-interface {
+        > .tsd-kind-icon:before {
+          background-position: $member-interface $offset;
+        }
+
+        &.tsd-is-inherited > .tsd-kind-icon:before {
+          background-position: $member-interface-inherited $offset;
+        }
+      }
+    }
+  }
+}

package/docs/src/sass/style.scss

@@ -0,0 +1,169 @@
+@import "_icons.scss";
+@import "_highlight.scss";
+
+[v-cloak],
+[hide] {
+  display: none;
+}
+
+tr:hover .table-link,
+.method-panel:hover header .table-link {
+  display: block;
+}
+
+.method-panel header .table-link {
+  left: -0.875rem;
+  top: 1.75rem;
+}
+
+td,
+.method-panel {
+  position: relative;
+}
+
+tr:target,
+.panel:target {
+  background: #efe397;
+}
+
+.table-link {
+  position: absolute;
+  left: -1.25rem;
+  top: 50%;
+  margin-top: -0.8375rem;
+  display: none;
+  border-radius: 50%;
+  background: white;
+  border: 1px solid #cccccc;
+  color: #0079c1;
+  width: 1.675rem;
+  height: 1.675rem;
+  text-align: center;
+  line-height: 1.675rem;
+  &:hover {
+    color: white;
+    background: #005e95;
+    border: 1px solid #005e95;
+  }
+  .svg-icon {
+    vertical-align: auto;
+    padding: 0;
+    width: 1rem;
+    height: 1rem;
+    top: 2px;
+    position: relative;
+  }
+}
+
+.api-search-result {
+  border: 1px solid transparent;
+  padding: 0.25rem;
+
+  &.is-selected {
+    background: #f8f8f8;
+    border: 1px solid #0079c1;
+  }
+}
+
+.text-purple {
+  color: #7461a8;
+}
+
+.sub-nav {
+  background: #005e95;
+}
+
+.api-param-comment {
+  p {
+    margin-bottom: 0;
+  }
+}
+
+.api-function-comment {
+  p {
+    margin-bottom: 0.5rem;
+  }
+}
+
+.api-package-content-list {
+  margin-left: 1.1375rem;
+}
+
+a > code {
+  color: #0079c1;
+  &:hover {
+    color: #005e95;
+  }
+}
+
+.no-wrap {
+  white-space: nowrap;
+}
+
+.method-table-signatures {
+  margin: 0;
+  li {
+    margin: 0;
+  }
+}
+
+.package-contents {
+  display: grid;
+  grid-gap: 10px;
+}
+
+/* no grid support? */
+
+.package-contents {
+  display: flex;
+  flex-wrap: wrap;
+}
+
+.package-contents {
+  display: grid;
+  margin: 0 auto;
+  grid-template-columns: repeat(auto-fill, minmax(25ch, 1fr));
+}
+
+.package-contents li {
+  /* needed for the flex layout*/
+  flex: 1 1 200px;
+}
+
+/* We need to set the margin used on flex items to 0 as we have gaps in grid.  */
+@supports (display: grid) {
+  .package-contents > * {
+    margin: 0;
+  }
+}
+
+.type-child-list {
+  margin: 0;
+}
+
+.type-child-name {
+  float: left;
+  clear: left;
+  padding: 0 0.25rem 0 1rem;
+  margin: 0;
+}
+
+.type-child-type {
+  float: left;
+  clear: right;
+  margin: 0;
+}
+
+.api-toggle-button {
+  padding: 0.1rem 0.1rem;
+}
+
+.api-list-item {
+  white-space: nowrap;
+}
+
+.list-item-active {
+  border-width: 1px;
+  border-color: #0079c1;
+  border-style: solid
+}

package/jasmine.json

@@ -0,0 +1,7 @@
+{
+  "spec_dir": "packages",
+  "spec_files": ["*/{src,test}/**/*.test.ts"],
+  "helpers": ["../support/test-helpers.js"],
+  "stopSpecOnExpectationFailure": false,
+  "random": false
+}

package/karma.conf.js

@@ -0,0 +1,100 @@
+// Karma configuration
+// Generated on Thu Jul 13 2017 11:01:30 GMT-0700 (PDT)
+const fs = require("fs");
+
+module.exports = function(config) {
+  config.set({
+    // base path that will be used to resolve all patterns (eg. files, exclude)
+    basePath: "",
+
+    // frameworks to use
+    // available frameworks: https://npmjs.org/browse/keyword/karma-adapter
+    frameworks: ["jasmine", "karma-typescript"],
+
+    // list of files / patterns to load in the browser
+    files: ["packages/*/{src,test}/**/*.ts"],
+
+    // list of files to exclude
+    exclude: [],
+
+    karmaTypescriptConfig: {
+      reports: {
+        lcovonly: "coverage",
+        html: "coverage",
+        text: ""
+      },
+      compilerOptions: {
+        module: "commonjs"
+      },
+      tsconfig: "./tsconfig.json",
+      bundlerOptions: {
+        transforms: [require("karma-typescript-es6-transform")()],
+        resolve: {
+          // karmas resolver cant figure out the symlinked deps from lerna
+          // so we need to manually alias each package here.
+          alias: fs
+            .readdirSync("packages")
+            .filter(p => p[0] !== ".")
+            .reduce((alias, p) => {
+              alias[`@esri/${p}`] = `packages/${p}/src/index.ts`;
+              return alias;
+            }, {})
+        }
+      }
+    },
+
+    // coveralls uses this one. still need to figure out how to DRY this up.
+    coverageReporter: {
+      type: 'lcov',
+      dir: 'coverage/'
+    },
+
+    // preprocess matching files before serving them to the browser
+    // available preprocessors: https://npmjs.org/browse/keyword/karma-preprocessor
+    preprocessors: {
+      "**/*.ts": ["karma-typescript"] // *.tsx for React Jsx
+    },
+
+    // test results reporter to use
+    // possible values: 'dots', 'progress'
+    // available reporters: https://npmjs.org/browse/keyword/karma-reporter
+    reporters: ["jasmine-diff", "dots", "karma-typescript", "coverage", "coveralls"],
+
+    // web server port
+    port: 9876,
+
+    // enable / disable colors in the output (reporters and logs)
+    colors: true,
+
+    // level of logging
+    // possible values: config.LOG_DISABLE || config.LOG_ERROR || config.LOG_WARN || config.LOG_INFO || config.LOG_DEBUG
+    logLevel: config.LOG_INFO,
+
+    // enable / disable watching file and executing tests whenever any file changes
+    autoWatch: true,
+
+    // start these browsers
+    // available browser launchers: https://npmjs.org/browse/keyword/karma-launcher
+    browsers: [
+      // 'Chrome',
+      // 'ChromeCanary',
+      // 'Firefox',
+      // 'Safari',
+      // 'IE'
+    ],
+
+    // Continuous Integration mode
+    // if true, Karma captures browsers, runs the tests and exits
+    singleRun: false,
+
+    // Concurrency level
+    // how many browsers should be started simultaneously
+    concurrency: Infinity,
+    customLaunchers: {
+      ChromeHeadlessCI: {
+        base: 'ChromeHeadless',
+        flags: ['--no-sandbox']
+      }
+    },
+  });
+};

package/lerna.json

@@ -0,0 +1,8 @@
+{
+  "lerna": "2.0.0",
+  "packages": [
+    "packages/*",
+    "demos/*"
+  ],
+  "version": "1.14.1"
+}

package/notes/README.md

@@ -0,0 +1,88 @@
+# Testing
+
+* Use `npm test` as normal to run all tests.
+* `npm test` will run `lerna run test` which will in turn will execute `npm test` in each package if it exists with the root of the package as the `process.cwd()`
+* Browser based tests are setup to run with Karma as a test runner as Jasmine as the testing framework. There is a common config that all packages can use in the root folder called `karma.conf.js`.
+* Node tests use the `jasmine` CLI tool. Each package will require a `jasmine.json` to tell jasmine where the test files are for that package. The `jasmine.json` should register the `support/register-tsnode.js` helper so TypeScript files are compiled before the tests execute.
+* Currently the Node tests take quite awhile. I think this is becuase the `ignore` param isn't being respected and thus the entirety of `node_modules` get processed by TypeScript. This needs to happen in order to make `lodash-es` work.
+
+# Build
+
+The build system currently builds for 3 seperate targets:
+
+* Common JS bundle for Node.js
+* A UMD bundle for CommonJS, AMD and a global variable for browsers
+* ES5 files in the ES2015 module syntax for use with Rollup and Webpack 2.
+
+Like with tests running `npm run build` will run `lerna run build` which will run `npm run build` in each package. Currently `npm run build:node` and `npm run build:umd` both use the shared rollup configurations in `rollup.config.*.js`. `npm run build:esm` uses a `tsconfig.json` file in the root of hte repo that extends the base `tsconfig.json` file. This `tsconfig.json` tells the Typescript compiler where to out the output files and generated `.d.ts` type declarations.
+
+These 4 outputs (2, rollup builds, ES2015 modules and type declarations) are referenced by their respective fields in `package.json`:
+
+```js
+{
+  // ...
+
+  "main": "dist/node/bundle.cjs.js",
+  "browser": "dist/browser/bundle.umd.js",
+  "module": "dist/esm/index.js",
+  "js:next": "dist/esm/index.js",
+  "types": "dist/types/index.d.ts",
+
+  // ...
+}
+```
+
+Currently we are bundling Node in order to use `lodash-es` as a utility library which needs to be bundled in.
+
+The ES2015 build also has the references to `form-data` and `url-search-params` removed. Rollup handles ignoring these in the UMD and CJS builds but TypeScript is not a bundler so these needed to be removed some other way. If we run into issues with sourcemaps this replacement process might need to be replaced by a custom script with [`magic-string`](https://github.com/Rich-Harris/magic-string).
+
+# Support files
+
+There are several general support files needed for various operations of the Typescript compiler to prevent errors:
+
+* `support/json.d.ts` - make the typescript compiler happy when you `import` JSON files `import * as sharingRestInfo from './mocks/sharing-rest-info.json';`
+* `support/lodash-es.d.ts` - currently `@types/lodash-es` has issues https://github.com/DefinitelyTyped/DefinitelyTyped/issues/15227 so this is an alternate typings file
+* `register-tsnode.js` - enables on-the-fly compilation of Typescript in Node.js, used by the Jasmine tests
+* `url-search-params.d.ts` - typings for the `url-search-params` module which is used to emulate `URLSearchParams` in Node.js
+
+# Doc system
+
+[Typedoc](https://github.com/TypeStrong/typedoc) leaves much to be desired figuring out how TypeDoc is organizing the source files is next to impossible and there is almost no doc. It does appear to be usable since project like Dojo 2 and Maquette use it however figuring out how to generate the docs in a struture that looks good is pretty beyond me after looking at it for a few hours.
+
+A potentially better option might be to just use JSDoc and work from the compiled ES2015 source. I will look into this later.
+
+# Release system
+
+the release process has been entirely automated.
+
+the command below bumps the version in each individual package.json file and parses all `npm run c` invoked commit messages since the last release to update the changelog.
+
+```bash
+npm run release:prepare
+```
+
+afterwards, you can display a diff to give you a sense of what will be committed to master when you actually publish.
+
+```bash
+npm run release:review
+```
+
+the last command increments the version in the root package.json, pushes the new tag to GitHub and publishes a release of each individual package on npm.
+
+```bash
+npm run release:publish
+```
+
+# Potential improvements
+
+* Finding a decent alternative to `lodash/defaults` without broken typings would be ideal. This forces all kinds of weirdness on us.
+* Figure out why the Node tests take so long (might be becuase of hacks needed for `lodash-es`) `lerna run test:node`
+* Since we are importing `lodash-es` we need to use `karma-typescript-es6-transform` to transform the ES2015 module syntax into CommonJS. We should look into if this is necessary at all (i.e. replace `lodash-es`) or think about replacing it with https://github.com/jlmakes/karma-rollup-preprocessor.
+
+# Thoughts
+
+Basic utility libraries are going to be a problem. Most recommendation are to use something like `import defaults = require('lodash/defaults')` because you are importing a common JS module. However if you use this syntax you cannot have Typescript compile ES2015 modules which is goal for us. Not every library publishes itself as ES2015 modules.
+
+We need to make a call on what we bundle into the library (`Promise`, `fetch`) ect... Do we ask people to bring their own polyfills or do we bundle them ourselves for simplicity. If we want to do both it will likely complicate the builds a great deal.
+
+

package/package.json

@@ -0,0 +1,129 @@
+{
+  "name": "ducimusipsa",
+  "version": "1.0.0",
+  "description": "Compact, modular JavaScript wrappers for the ArcGIS REST API that run in Node.js and modern browsers.",
+  "devDependencies": {
+    "@types/es6-promise": "0.0.32",
+    "@types/fetch-mock": "^6.0.4",
+    "@types/jasmine": "^2.8.2",
+    "@types/node": "^6.0.95",
+    "acetate": "^2.0.0",
+    "acetate-cli": "^1.0.1",
+    "changelog-parser": "^2.1.0",
+    "cheerio": "^1.0.0-rc.2",
+    "commitizen": "^2.10.0",
+    "concurrently": "^3.5.1",
+    "cpx": "^1.5.0",
+    "cross-spawn": "^5.1.0",
+    "cz-lerna-changelog": "github:patrickarlt/cz-lerna-changelog#3fe7650a2e2e624b1f46e5031c96119759698288",
+    "date-fns": "^1.29.0",
+    "fetch-mock": "^5.13.1",
+    "gh-pages": "^1.1.0",
+    "gh-release": "^3.4.0",
+    "husky": "^0.14.3",
+    "inspect-process": "^0.5.0",
+    "jasmine": "^2.8.0",
+    "jasmine-core": "^2.8.0",
+    "karma": "^2.0.2",
+    "karma-chrome-launcher": "^2.2.0",
+    "karma-coverage": "^1.1.1",
+    "karma-coveralls": "1.1.2",
+    "karma-firefox-launcher": "^1.1.0",
+    "karma-ie-launcher": "^1.0.0",
+    "karma-jasmine": "^1.1.1",
+    "karma-jasmine-diff-reporter": "^1.1.1",
+    "karma-safari-launcher": "^1.0.0",
+    "karma-typescript": "^3.0.9",
+    "karma-typescript-es6-transform": "^1.0.3",
+    "lerna": "^2.5.1",
+    "lint-staged": "^4.3.0",
+    "minimatch": "^3.0.4",
+    "node-sass": "^4.9.0",
+    "onchange": "^3.3.0",
+    "prettier": "^1.14.3",
+    "resolve": "^1.5.0",
+    "rimraf": "^2.6.2",
+    "rollup": "^0.66.4",
+    "rollup-plugin-commonjs": "^8.2.6",
+    "rollup-plugin-filesize": "^5.0.1",
+    "rollup-plugin-json": "^2.3.0",
+    "rollup-plugin-node-resolve": "^3.0.3",
+    "rollup-plugin-typescript2": "^0.4.6",
+    "rollup-plugin-uglify": "^3.0.0",
+    "shelljs": "^0.7.8",
+    "slug": "^0.9.1",
+    "ts-node": "^3.3.0",
+    "tslint": "^5.11.0",
+    "tslint-config-prettier": "^1.6.0",
+    "tslint-config-standard": "^6.0.1",
+    "typedoc": "^0.12.0",
+    "typescript": "^3.0.0"
+  },
+  "dependencies": {
+    "es6-promise": "^4.2.1",
+    "isomorphic-fetch": "^2.2.1",
+    "isomorphic-form-data": "^2.0.0",
+    "tslib": "^1.8.1"
+  },
+  "lint-staged": {
+    "*.ts": [
+      "prettier --write --parser typescript --tab-width 2 --use-tabs false",
+      "tslint --project tsconfig.json",
+      "git add"
+    ]
+  },
+  "scripts": {
+    "build": "lerna run build",
+    "test": "npm run test:node && npm run test:chrome",
+    "test:chrome:debug": "karma start --auto-watch --no-single-run --browsers=Chrome",
+    "test:chrome": "karma start --single-run --browsers=Chrome",
+    "test:chrome:ci": "karma start --single-run --browsers ChromeHeadlessCI karma.conf.js",
+    "test:firefox": "karma start --single-run --browsers=Firefox",
+    "test:node": "jasmine --config=jasmine.json",
+    "test:node:debug": "inspect jasmine --config=jasmine.json",
+    "test:ci": "npm run lint && npm run test:node && npm run test:chrome:ci && npm run test:firefox",
+    "test:all": "npm run test:node && npm run test:firefox && npm run test:chrome",
+    "docs:build": "rimraf docs/build && npm run docs:typedoc && npm run docs:build:acetate && npm run docs:build:sass && npm run docs:build:images && npm run docs:build:js",
+    "docs:build:acetate": "ENV=prod acetate build --config docs/acetate.config.js",
+    "docs:build:sass": "node-sass --output docs/build/arcgis-rest-js/css --source-map true --source-map-contents docs/src/sass",
+    "docs:build:images": "cpx \"docs/src/**/*.{png,jpg,jpeg,gif,svg,webm,ogg}\" docs/build/arcgis-rest-js",
+    "docs:build:js": "cpx \"docs/src/**/{api-search,nav-toggle}.js\" docs/build/arcgis-rest-js",
+    "docs:deploy": "npm run docs:build && node support/deploy-doc-site.js",
+    "docs:typedoc": "node docs/build-typedoc.js",
+    "docs:dev:typedoc": "onchange -v 'packages/*/src/**/*.ts' -- npm run docs:typedoc",
+    "predocs:serve": "npm run docs:typedoc",
+    "docs:serve": "rimraf docs/build && concurrently \"npm run docs:dev:js\" \"npm run docs:dev:images\" \"npm run docs:dev:acetate\" \"npm run docs:dev:sass\" \"npm run docs:dev:typedoc\"",
+    "docs:dev:images": "cpx \"docs/src/**/*.{png,jpg,jpeg,gif,svg,webm,ogg}\" docs/build/arcgis-rest-js -w",
+    "docs:dev:acetate": "acetate server --log=debug --config docs/acetate.config.js",
+    "predocs:dev:sass": "npm run docs:build:sass",
+    "docs:dev:sass": "node-sass --watch --recursive --output docs/build/arcgis-rest-js/css --source-map true --source-map-contents docs/src/sass",
+    "docs:dev:js": "cpx \"docs/src/**/{api-search,nav-toggle}.js\" docs/build/arcgis-rest-js -w",
+    "lint": "tslint --project tsconfig.json",
+    "lint:fix": "tslint --project tsconfig.json --fix",
+    "prettify": "prettier --write --parser typescript --tab-width 2 --use-tabs false \"packages/**/+(src|test)/**/*.ts\"",
+    "precommit": "lint-staged",
+    "bootstrap": "lerna bootstrap",
+    "postinstall": "npm run bootstrap",
+    "prerelease:prepare": "git fetch --all && lerna bootstrap && npm test",
+    "release:prepare": "lerna publish --skip-git --skip-npm --yes && node ./support/changelog.js",
+    "release:review": "git --no-pager diff --word-diff",
+    "release:publish": "./support/publish.sh",
+    "c": "git-cz",
+    "dev": "support/dev.sh"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/NellieKihn/ducimusipsa.git"
+  },
+  "license": "Apache-2.0",
+  "bugs": {
+    "url": "https://github.com/NellieKihn/ducimusipsa.git/issues"
+  },
+  "homepage": "https://github.com/NellieKihn/ducimusipsa.git",
+  "config": {
+    "commitizen": {
+      "path": "./node_modules/cz-lerna-changelog"
+    }
+  },
+  "author": "EvertZulauf"
+}