Initial

Author: Smoren

.editorconfig

@@ -0,0 +1,11 @@
+# EditorConfig is awesome: http://EditorConfig.org
+
+root = true
+
+[*]
+indent_size = 2
+indent_style = space
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true

.github/workflows/test_master.yml

@@ -0,0 +1,49 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    branches:
+      - master
+      - dev
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node-version: [14.x, 16.x, 17.x, 18.x, 19.x, 20.x, 21.x]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ matrix.node-version }}
+
+      - name: Run tests
+        run: |
+          npm install
+          npm run test
+        env:
+          CI: true
+
+      - name: Upload coverage report to Coveralls
+        uses: coverallsapp/github-action@master
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          parallel: true
+
+  coveralls:
+    needs: build
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Coveralls finished
+        uses: coverallsapp/github-action@master
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          parallel-finished: true

.gitignore

@@ -0,0 +1,7 @@
+.idea
+node_modules
+dist
+package-lock.json
+coverage
+es
+lib

CHANGELOG.md

@@ -0,0 +1,3 @@
+# Collections View Change Log
+
+## v0.1.0 - TBD

LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Smoren
+
+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,2 @@
+# Collection View for TypeScript and JavaScript
+

jest.config.js

@@ -0,0 +1,5 @@
+/** @type {import('ts-jest').JestConfigWithTsJest} */
+module.exports = {
+  preset: "ts-jest",
+  testEnvironment: "node",
+};

package.json

@@ -0,0 +1,56 @@
+{
+  "name": "collections-view",
+  "version": "0.1.0",
+  "description": "TODO",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Smoren/collections-view-ts.git"
+  },
+  "author": {
+    "name": "Smoren",
+    "email": "ofigate@gmail.com",
+    "url": "https://github.com/Smoren"
+  },
+  "homepage": "https://github.com/Smoren/collections-view-ts#readme",
+  "bugs": {
+    "url": "https://github.com/Smoren/collections-view-ts/issues"
+  },
+  "main": "./lib/index.js",
+  "module": "./es/index.js",
+  "scripts": {
+    "build": "npm run build:commonjs && npm run build:es",
+    "build:commonjs": "rimraf lib && tsc --downlevelIteration --target es5 --outDir lib --module commonjs --declaration",
+    "build:es": "rimraf es && tsc --target es6 --outDir es --module es6",
+    "test": "jest --coverage",
+    "jest": "jest",
+    "format": "ts-scripts format",
+    "lint": "ts-scripts lint",
+    "prepublishOnly": "npm run build"
+  },
+  "files": [
+    "es",
+    "lib",
+    "src",
+    "tests/examples",
+    "tests/fixture.ts",
+    "tests/tools"
+  ],
+  "keywords": [
+    "collection",
+    "view"
+  ],
+  "devDependencies": {
+    "@borderless/ts-scripts": "^0.13.6",
+    "@types/jest": "^29.2.4",
+    "jest": "^29.3.1",
+    "rimraf": "^4.4.0",
+    "ts-expect": "^1.1.0",
+    "ts-jest": "^29.0.3",
+    "typescript": "^4.9.4"
+  },
+  "types": "./lib/index.d.ts",
+  "contributors": [],
+  "jsnext:main": "./es/index.js",
+  "sideEffects": false
+}

src/array-view.ts

@@ -0,0 +1,62 @@
+import { ArrayViewConfig } from "./types";
+
+class ExtendableProxy<T extends Object> {
+  public readonly target: T;
+
+  constructor(target: T, handler: ProxyHandler<T>) {
+    this.target = target;
+    return new Proxy(this, {
+      set(_, key, value, proxy) {
+        if (handler.set === undefined) {
+          return false;
+        }
+
+        return handler.set(target, key, value, proxy);
+      },
+      get(object, key, proxy) {
+        if (handler.get === undefined) {
+          return undefined;
+        }
+
+        return handler.get(target, key, proxy);
+      }
+    });
+  }
+}
+
+export class ArrayView<T> extends ExtendableProxy<Array<T>> {
+  constructor(target: Array<T>, config: ArrayViewConfig<T>) {
+    const {
+      index,
+      readonly = false,
+      fixed = false,
+      onOutOfRange = () => undefined,
+    } = config;
+
+    super(target, {
+      get(target, prop) {
+        const i = index(Number(prop), target);
+
+        if (i in target) {
+          return target[i];
+        }
+
+        return onOutOfRange(Number(prop));
+      },
+      set(target, prop, value): boolean {
+        const i = index(Number(prop), target);
+
+        if (readonly) {
+          return false;
+        }
+
+        if (fixed && !(i in target)) {
+          return false;
+        }
+
+        target[i] = value;
+        return true;
+      }
+    });
+  }
+}

src/types.ts

@@ -0,0 +1,8 @@
+export type RecordKey = string | number | symbol;
+
+export type ArrayViewConfig<T> = {
+  index: (i: number, target: Array<T>) => number;
+  readonly?: boolean;
+  fixed?: boolean;
+  onOutOfRange?: (i: number) => T | undefined;
+};

tests/examples/examples.test.ts

@@ -0,0 +1,15 @@
+import { expect } from "@jest/globals";
+import { ArrayView } from "../../src/array-view";
+
+it("First example", () => {
+  const input = [1, 2, 3];
+
+  const view = new ArrayView(input, {
+    index: (i, target) => target.length - 1 - i,
+  });
+
+  const actual = [];
+
+
+  expect(true).toBe(true);
+});

tsconfig.json

@@ -0,0 +1,20 @@
+{
+  "compilerOptions": {
+    "target": "ES6",
+    "module": "commonjs",
+    "moduleResolution": "Node",
+    "lib": ["es6", "es2018.asynciterable"],
+    "rootDir": "./src",
+    "allowJs": false,
+    "outDir": "./dist",
+    "esModuleInterop": true,
+    "forceConsistentCasingInFileNames": true,
+    "strict": true,
+    "skipLibCheck": true,
+    "sourceMap": true,
+    "inlineSources": true,
+    "declaration": true,
+    "isolatedModules": true
+  },
+  "exclude": ["tests"]
+}