Initial commit

Created with bitjson/typescript-starter@65f82a9

Author: Alexander Belov

.editorconfig

@@ -0,0 +1,15 @@
+# http://editorconfig.org
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+indent_size = 2
+indent_style = space
+insert_final_newline = true
+max_line_length = 80
+trim_trailing_whitespace = true
+
+[*.md]
+max_line_length = 0
+trim_trailing_whitespace = false

.github/CONTRIBUTING.md

@@ -0,0 +1,3 @@
+# Example Contributing Guidelines
+
+This is an example of GitHub's contributing guidelines file. Check out GitHub's [CONTRIBUTING.md help center article](https://help.github.com/articles/setting-guidelines-for-repository-contributors/) for more information.

.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,11 @@
+* **I'm submitting a ...**
+[ ] bug report
+[ ] feature request
+[ ] question about the decisions made in the repository
+[ ] question about how to use this project
+
+* **Summary**
+
+
+
+* **Other information** (e.g. detailed explanation, stacktraces, related issues, suggestions how to fix, links for us to have context, eg. StackOverflow, personal fork, etc.)

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,13 @@
+* **What kind of change does this PR introduce?** (Bug fix, feature, docs update, ...)
+
+
+
+* **What is the current behavior?** (You can also link to an open issue here)
+
+
+
+* **What is the new behavior (if this is a feature change)?**
+
+
+
+* **Other information**:

.gitignore

@@ -0,0 +1,11 @@
+node_modules
+build
+test
+src/**.js
+.idea/*
+
+coverage
+.nyc_output
+*.log
+
+package-lock.json

.npmignore

@@ -0,0 +1,14 @@
+src
+test
+tsconfig.json
+tsconfig.module.json
+tslint.json
+.travis.yml
+.github
+.prettierignore
+.vscode
+build/docs
+**/*.spec.*
+coverage
+.nyc_output
+*.log

.prettierignore

@@ -0,0 +1,2 @@
+# package.json is formatted by package managers, so we ignore it here
+package.json

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Alexander Belov
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,3 @@
+# @algo-js/segment-tree
+
+Segment Tree implementation in TypeScript

package.json

@@ -0,0 +1,95 @@
+{
+  "name": "@algo-js/segment-tree",
+  "version": "1.0.0",
+  "description": "Segment Tree implementation in TypeScript",
+  "main": "build/main/index.js",
+  "typings": "build/main/index.d.ts",
+  "module": "build/module/index.js",
+  "repository": "https://github.com/YOUR_GITHUB_USER_NAME/@algo-js/segment-tree",
+  "license": "MIT",
+  "keywords": [],
+  "scripts": {
+    "describe": "npm-scripts-info",
+    "build": "run-s clean && run-p build:*",
+    "build:main": "tsc -p tsconfig.json",
+    "build:module": "tsc -p tsconfig.module.json",
+    "fix": "run-s fix:*",
+    "fix:prettier": "prettier \"src/**/*.ts\" --write",
+    "fix:tslint": "tslint --fix --project .",
+    "test": "run-s build test:*",
+    "test:lint": "tslint --project . && prettier \"src/**/*.ts\" --list-different",
+    "test:unit": "nyc --silent ava",
+    "watch": "run-s clean build:main && run-p \"build:main -- -w\" \"test:unit -- --watch\"",
+    "cov": "run-s build test:unit cov:html && open-cli coverage/index.html",
+    "cov:html": "nyc report --reporter=html",
+    "cov:send": "nyc report --reporter=lcov && codecov",
+    "cov:check": "nyc report && nyc check-coverage --lines 100 --functions 100 --branches 100",
+    "doc": "run-s doc:html && open-cli build/docs/index.html",
+    "doc:html": "typedoc src/ --exclude **/*.spec.ts --target ES6 --mode file --out build/docs",
+    "doc:json": "typedoc src/ --exclude **/*.spec.ts --target ES6 --mode file --json build/docs/typedoc.json",
+    "doc:publish": "gh-pages -m \"[ci skip] Updates\" -d build/docs",
+    "version": "standard-version",
+    "reset": "git clean -dfx && git reset --hard && npm i",
+    "clean": "trash build test",
+    "prepare-release": "run-s reset test cov:check doc:html version doc:publish",
+    "preinstall": "node -e \"if(process.env.npm_execpath.indexOf('yarn') === -1) throw new Error('@algo-js/segment-tree must be installed with Yarn: https://yarnpkg.com/')\""
+  },
+  "scripts-info": {
+    "info": "Display information about the package scripts",
+    "build": "Clean and rebuild the project",
+    "fix": "Try to automatically fix any linting problems",
+    "test": "Lint and unit test the project",
+    "watch": "Watch and rebuild the project on save, then rerun relevant tests",
+    "cov": "Rebuild, run tests, then create and open the coverage report",
+    "doc": "Generate HTML API documentation and open it in a browser",
+    "doc:json": "Generate API documentation in typedoc JSON format",
+    "version": "Bump package.json version, update CHANGELOG.md, tag release",
+    "reset": "Delete all untracked files and reset the repo to the last commit",
+    "prepare-release": "One-step: clean, build, test, publish docs, and prep a release"
+  },
+  "engines": {
+    "node": ">=8.9"
+  },
+  "dependencies": {
+    "sha.js": "^2.4.11"
+  },
+  "devDependencies": {
+    "ava": "2.2.0",
+    "codecov": "^3.5.0",
+    "cz-conventional-changelog": "^2.1.0",
+    "gh-pages": "^2.0.1",
+    "npm-run-all": "^4.1.5",
+    "@bitjson/npm-scripts-info": "^1.0.0",
+    "nyc": "^14.1.1",
+    "prettier": "^1.18.2",
+    "standard-version": "^6.0.1",
+    "trash-cli": "^3.0.0",
+    "tslint": "^5.18.0",
+    "tslint-config-prettier": "^1.18.0",
+    "tslint-immutable": "^6.0.1",
+    "typescript": "^3.5.3"
+  },
+  "ava": {
+    "failFast": true,
+    "files": [
+      "build/main/**/*.spec.js"
+    ],
+    "sources": [
+      "build/main/**/*.js"
+    ]
+  },
+  "config": {
+    "commitizen": {
+      "path": "cz-conventional-changelog"
+    }
+  },
+  "prettier": {
+    "singleQuote": true
+  },
+  "nyc": {
+    "extends": "@istanbuljs/nyc-config-typescript",
+    "exclude": [
+      "**/*.spec.js"
+    ]
+  }
+}

src/index.ts

@@ -0,0 +1,3 @@
+export * from './lib/async';
+export * from './lib/hash';
+export * from './lib/number';

src/lib/async.spec.ts

@@ -0,0 +1,7 @@
+// tslint:disable:no-expression-statement
+import test from 'ava';
+import { asyncABC } from './async';
+
+test('getABC', async t => {
+  t.deepEqual(await asyncABC(), ['a', 'b', 'c']);
+});

src/lib/async.ts

@@ -0,0 +1,32 @@
+/**
+ * A sample async function (to demo Typescript's es7 async/await downleveling).
+ *
+ * ### Example (es imports)
+ * ```js
+ * import { asyncABC } from 'typescript-starter'
+ * console.log(await asyncABC())
+ * // => ['a','b','c']
+ * ```
+ *
+ * ### Example (commonjs)
+ * ```js
+ * var double = require('typescript-starter').asyncABC;
+ * asyncABC().then(console.log);
+ * // => ['a','b','c']
+ * ```
+ *
+ * @returns       a Promise which should contain `['a','b','c']`
+ */
+export async function asyncABC(): Promise<ReadonlyArray<string>> {
+  function somethingSlow(index: 0 | 1 | 2): Promise<string> {
+    const storage = 'abc'.charAt(index);
+    return new Promise<string>(resolve =>
+      // later...
+      resolve(storage)
+    );
+  }
+  const a = await somethingSlow(0);
+  const b = await somethingSlow(1);
+  const c = await somethingSlow(2);
+  return [a, b, c];
+}

src/lib/hash.spec.ts

@@ -0,0 +1,13 @@
+// tslint:disable:no-expression-statement no-object-mutation
+import test from 'ava';
+import { sha256, sha256Native } from './hash';
+
+test(
+  'sha256',
+  (t, input: string, expected: string) => {
+    t.is(sha256(input), expected);
+    t.is(sha256Native(input), expected);
+  },
+  'test',
+  '9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08'
+);

src/lib/hash.ts

@@ -0,0 +1,38 @@
+import { createHash } from 'crypto';
+import shaJs from 'sha.js';
+
+/**
+ * Calculate the sha256 digest of a string.
+ *
+ * ### Example (es imports)
+ * ```js
+ * import { sha256 } from 'typescript-starter'
+ * sha256('test')
+ * // => '9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08'
+ * ```
+ *
+ * @returns sha256 message digest
+ */
+export function sha256(message: string): string {
+  return shaJs('sha256')
+    .update(message)
+    .digest('hex');
+}
+
+/**
+ * A faster implementation of [[sha256]] which requires the native Node.js module. Browser consumers should use [[sha256]], instead.
+ *
+ * ### Example (es imports)
+ * ```js
+ * import { sha256Native as sha256 } from 'typescript-starter'
+ * sha256('test')
+ * // => '9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08'
+ * ```
+ *
+ * @returns sha256 message digest
+ */
+export function sha256Native(message: string): string {
+  return createHash('sha256')
+    .update(message)
+    .digest('hex');
+}

src/lib/number.spec.ts

@@ -0,0 +1,11 @@
+// tslint:disable:no-expression-statement
+import test from 'ava';
+import { double, power } from './number';
+
+test('double', t => {
+  t.is(double(2), 4);
+});
+
+test('power', t => {
+  t.is(power(2, 4), 16);
+});

src/lib/number.ts

@@ -0,0 +1,46 @@
+/**
+ * Multiplies a value by 2. (Also a full example of Typedoc's functionality.)
+ *
+ * ### Example (es module)
+ * ```js
+ * import { double } from 'typescript-starter'
+ * console.log(double(4))
+ * // => 8
+ * ```
+ *
+ * ### Example (commonjs)
+ * ```js
+ * var double = require('typescript-starter').double;
+ * console.log(double(4))
+ * // => 8
+ * ```
+ *
+ * @param value   Comment describing the `value` parameter.
+ * @returns       Comment describing the return type.
+ * @anotherNote   Some other value.
+ */
+export function double(value: number): number {
+  return value * 2;
+}
+
+/**
+ * Raise the value of the first parameter to the power of the second using the es7 `**` operator.
+ *
+ * ### Example (es module)
+ * ```js
+ * import { power } from 'typescript-starter'
+ * console.log(power(2,3))
+ * // => 8
+ * ```
+ *
+ * ### Example (commonjs)
+ * ```js
+ * var power = require('typescript-starter').power;
+ * console.log(power(2,3))
+ * // => 8
+ * ```
+ */
+export function power(base: number, exponent: number): number {
+  // This is a proposed es7 operator, which should be transpiled by Typescript
+  return base ** exponent;
+}

src/types/example.d.ts

@@ -0,0 +1,34 @@
+/**
+ * If you import a dependency which does not include its own type definitions,
+ * TypeScript will try to find a definition for it by following the `typeRoots`
+ * compiler option in tsconfig.json. For this project, we've configured it to
+ * fall back to this folder if nothing is found in node_modules/@types.
+ *
+ * Often, you can install the DefinitelyTyped
+ * (https://github.com/DefinitelyTyped/DefinitelyTyped) type definition for the
+ * dependency in question. However, if no one has yet contributed definitions
+ * for the package, you may want to declare your own. (If you're using the
+ * `noImplicitAny` compiler options, you'll be required to declare it.)
+ *
+ * This is an example type definition for the `sha.js` package, used in hash.ts.
+ *
+ * (This definition was primarily extracted from:
+ * https://github.com/DefinitelyTyped/DefinitelyTyped/blob/master/types/node/v8/index.d.ts
+ */
+declare module 'sha.js' {
+  export default function shaJs(algorithm: string): Hash;
+
+  type Utf8AsciiLatin1Encoding = 'utf8' | 'ascii' | 'latin1';
+  type HexBase64Latin1Encoding = 'latin1' | 'hex' | 'base64';
+
+  export interface Hash extends NodeJS.ReadWriteStream {
+    // tslint:disable:no-method-signature
+    update(
+      data: string | Buffer | DataView,
+      inputEncoding?: Utf8AsciiLatin1Encoding
+    ): Hash;
+    digest(): Buffer;
+    digest(encoding: HexBase64Latin1Encoding): string;
+    // tslint:enable:no-method-signature
+  }
+}