Updated repository so that it can be published to npm. Added GitHUb action for package release

Author: lordofdestiny

.github/workflows/release-package.yml

@@ -0,0 +1,43 @@
+name: Publish to GitHub Package Registry
+
+on:
+  release:
+    types: [created]
+  workflow_dispatch:
+
+permissions:
+  packages: read
+  contents: read
+
+jobs:
+  build-and-test:
+    name: Run Jest Unit Tests
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 20
+      - run: npm ci
+      - run: npm test
+
+  publish-gpr:
+    name: Publish to GitHub Package Registry
+    needs: build-and-test
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          registry-url: https://npm.pkg.github.com/
+          scope: @lordofdestiny
+          access: public
+      - run: npm ci
+      - run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{secrets.GITHUB_TOKEN}}
+

.github/workflows/static.yml

@@ -1,12 +1,8 @@
-# Simple workflow for deploying static content to GitHub Pages
-name: Generate and deploy TypeDoc to GitHub Pages
+name: Generate Docs for GitHub Pages
 
 on:
-  # Runs on pushes targeting the default branch
   push:
     branches: ["main"]
-
-  # Allows you to run this workflow manually from the Actions tab
   workflow_dispatch:
 
 # Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
@@ -22,7 +18,6 @@ concurrency:
   cancel-in-progress: false
 
 jobs:
-  # Single deploy job since we're just deploying
   deploy:
     environment:
       name: github-pages
@@ -34,13 +29,15 @@ jobs:
       - name: Setup Node.js environment
         uses: actions/setup-node@v4.0.2
         with:
-          # Version Spec of the version to use. Examples: 12.x, 10.15.1, >=10.15.0.
-          node-version: 18
+          node-version: 20
           cache: 'npm'         
       - run: npm ci
-      - run: npm run docs
-      - run: npm run coverage:badges
-      - run: node scripts/extract-coverage.js >> $GITHUB_ENV
+      - name: Generate Docs
+        run: npm run docs
+      - name: Extract coverage
+        run: |
+          npm run coverage:badges
+          node scripts/extract-coverage.js >> $GITHUB_ENV
       - name: Create coverage badges
         uses: schneegans/dynamic-badges-action@v1.7.0
         with:
@@ -61,7 +58,6 @@ jobs:
       - name: Upload artifact
         uses: actions/upload-pages-artifact@v3
         with:
-          # Upload entire repository
           path: './docs'
       - name: Deploy to GitHub Pages
         id: deployment

.gitignore

@@ -1,4 +1,5 @@
 node_modules
 dist
 coverage
-docs
+docs
+*.tgz

.npmignore

@@ -0,0 +1,13 @@
+.idea/
+scripts/
+__tests__/
+coverage/
+docs/
+.github/
+.gitattributes
+tsconfig.*
+typedoc.json
+jest.config.js
+*.tgz
+!scripts/preinstall.js
+.npmrc

.npmrc

@@ -0,0 +1 @@
+https://npm.pkg.github.com/:_authToken=${NPM_SECRET}

README.md

@@ -17,19 +17,61 @@ and Rust's <a href="https://doc.rust-lang.org/std/iter/trait.Iterator.html" targ
 Library is still in development and not yet ready for production use. It's mostly feature complete,
 but there are still some missing methods and some methods, like `cycle` and `reverse`.
 
-Library is written in TypeScript and is intended to be used with TypeScript. It's not yet published.
+Library is written in TypeScript and compiled to ES6. You can use it in both Node.js and the browser,
+with both TypeScript and JavaScript.
 
-Focus of the library was more on the API design and less on performance.
+All methods are lazy and return a new Stream object. Even so, 
+focus of the library was more on the API design and less on performance.
 
-All methods are lazy and return a new Stream object.
+Library is heavily tested with Jest.
 
-All methods are heavily tested with Jest.
+## Examples
+
+```typescript
+import { Stream } from 'streams-ts';
+
+const arr = [1, 2, 3, 4, 5, 6, 7, 8, 9, 10];
+
+const result = Stream.from(arr)
+    .filter(x => x % 2 === 0)
+    .map(x => x * 2)
+    .toArray();
+
+console.log(result); // [4, 8, 12, 16, 20]
+
+const result2 = Stream.from(arr)
+    .filter(x => x % 2 === 0)
+    .map(x => x * 2)
+    .reduce((acc, x) => acc + x, 0);
+
+console.log(result2); // 60
+
+const result3 = Stream.from(arr)
+    .filter(x => x % 2 === 0)
+    .map(x => x * 2)
+    .findFirst();
+
+console.log(result3); // 4
+
+const result4 = Stream.from(arr)
+    .chunk(2)
+    .toMap()
+
+console.log(result4); // Map { 1 => 2, 3 => 4, 5 => 6, 7 => 8, 9 => 10 }
+```
 
 ## Installation
 
-Library is not yet published. You can always download the source code and copy it to your project.
+To install the library, you can use npm, to install from the public npm registry:
+
+```npm install streams-ts```
+
+or from the GitHub repository:
+
+```npm install lordofdestiny/streams-ts```
+
 
-[comment]: <> (```npm install streams-ts```)
+For mor examples, check the tests or the documentation.
 
 ## Building
 
@@ -48,7 +90,6 @@ If you want, you can also build the library in watch mode:
 If you decide to clone the repository, you can run tests with:
 
 ```
-npm install
 npm test
 ```
 
@@ -64,7 +105,7 @@ This opens a browser with coverage report.
 
 ## Documentation
 
-#### *_[Official documentation is avilable at here](https://streams-ts.github.io/streams-ts/)_*
+#### *_[Official documentation is avilable at here](https://lordofdestiny.github.io/streams-ts/)_*
 
 You can also generate documentation from the source code by using:
 
@@ -75,7 +116,6 @@ After that, you can open `docs/index.html` in your browser or by running
 ```npm run docs:open```
 
 You can check the tests for more examples.
-   
 
 ## Clean build results
 
@@ -89,41 +129,4 @@ You can check the tests for more examples.
 
 ### Coverage
 
-```npm run clean:coverage```
-
-## Examples
-
-```typescript
-import { Stream } from 'streams-ts';
-
-const arr = [1, 2, 3, 4, 5, 6, 7, 8, 9, 10];
-
-const result = Stream.from(arr)
-    .filter(x => x % 2 === 0)
-    .map(x => x * 2)
-    .toArray();
-
-console.log(result); // [4, 8, 12, 16, 20]
-
-const result2 = Stream.from(arr)
-    .filter(x => x % 2 === 0)
-    .map(x => x * 2)
-    .reduce((acc, x) => acc + x, 0);
-
-console.log(result2); // 60
-
-const result3 = Stream.from(arr)
-    .filter(x => x % 2 === 0)
-    .map(x => x * 2)
-    .findFirst();
-
-console.log(result3); // 4
-
-const result4 = Stream.from(arr)
-    .slide(2)
-    .toMap()
-
-console.log(result4); // Map { 1 => 2, 3 => 4, 5 => 6, 7 => 8, 9 => 10 }
-```
-
-For mor examples, check the tests or the documentation.
+```npm run clean:coverage```

package-lock.json

@@ -1,9 +1,14 @@
 {
   "name": "streams-ts",
   "version": "1.0.0",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "author": "lordofdestiny",
+  "license": "MIT",
   "description": "Streams library for TS",
-  "main": "index.js",
   "scripts": {
+    "preinstall": "node scripts/preinstall.js",
+    "prepublish": "npm run build",
     "build": "tsc --build tsconfig.build.json && tsc-alias",
     "build:watch": "concurrently --kill-others \"tsc --build tsconfig.build.json --watch\" \"tsc-alias -w\"",
     "test": "jest",
@@ -18,14 +23,21 @@
     "clean:docs": "ts-node scripts/clean.ts docs",
     "clean": "ts-node scripts/clean.ts dist coverage docs"
   },
-  "keywords": ["typescript", "npm", "Stream API", "streams", "streams-ts"],
+  "keywords": [
+    "typescript",
+    "npm",
+    "Stream API",
+    "streams",
+    "streams-ts"
+  ],
   "homepage": "lordofdestiny.github.io/streams-ts",
   "repository": {
     "type": "git",
-    "url": "github:lordofdestiny/streams-ts.git"
+    "url": "git+https://github.com/lordofdestiny/streams-ts.git"
+  },
+  "publishConfig": {
+    "access": "public"
   },
-  "author": "lordofdestiny",
-  "license": "MIT",
   "devDependencies": {
     "@jest/globals": "^29.7.0",
     "@tsconfig/node18": "^18.2.2",

package.json

@@ -0,0 +1 @@
+console.log("Thanks for installing me!")

scripts/preinstall.js

@@ -3,7 +3,9 @@
   "$schema": "https://json.schemastore.org/tsconfig",
   "compilerOptions": {
     "lib": [
-      "ES2023",
+      "ES2015",
+      "ES2015.Iterable",
+      "ES2015.Collection"
     ],
     "declaration": true,
     "module": "NodeNext",