@xstd/constructor-types 1.0.0

package/CONTRIBUTING.md

@@ -0,0 +1,89 @@
+# Contributing
+
+This projet is open to everyone. Feel free to test the library, share it, improve it, and create merge requests.
+
+## Getting started
+
+### Tools
+
+#### [nvm](https://github.com/nvm-sh/nvm)
+
+We recommend using [nvm](https://github.com/nvm-sh/nvm) to manage your Node.js versions.
+
+```shell
+curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.40.3/install.sh | bash
+```
+
+#### [Node](https://nodejs.org)
+
+```shell
+nvm use
+
+# Verify the Node.js version:
+node -v
+```
+
+#### [Yarn](https://yarnpkg.com)
+
+```shell
+corepack enable yarn
+
+# Verify Yarn version:
+yarn -v
+
+# Install the dependencies:
+yarn install
+```
+
+### Environment variables
+
+```shell
+# Copy the example file into .env:
+cp .env.example .env
+```
+
+And replace the corresponding variables:
+
+- [NPM_TOKEN](https://docs.npmjs.com/creating-and-viewing-access-tokens)
+
+### Code
+
+- The source code is located in the `src` directory.
+- The projet uses [prettier](https://prettier.io/) to format the code. You'll want to enable and configure it in your IDE.
+- The tests run with [vitest](https://vitest.dev)
+
+### Commands
+
+- `fb:build`: builds the library.
+  - converts the typescript files into javascript files, copies the scss files, and assembles all the assets to create a package ready to be published.
+  - some files are handled differently:
+    - `*.protected.{ts,scss}` or `**/*.protected/**`: these files are exported under `package-name/protected`
+      - this is indented to expose parts of the code that should be restricted to advanced users only, or shared to other libraries requiring _internal_ control.
+    - `*.private.{ts,scss}` or `/*.private/**`: these files are **not** exported.
+      - this is indented to consume parts of the code internally, and not expose them publicly.
+- `fb:format`: formats the code using `prettier`.
+- `fb:test`: runs the tests using `vitest`.
+- `fb:test:coverage`: runs the tests with coverage.
+  - by default, 100% code coverage is required, to enforce good quality.
+- `fb:bench`: runs the bench tests.
+- `fb:typedoc`: generates the documentation.
+  - if the library exposes publicly only a few and/or simple parts, the documentation may be defined in the `README.md` instead.
+- `fb:prod`: builds the lib in `prod` mode.
+  - builds and publishes the lib on npm as a _prod_ version.
+- `fb:dev`: builds the lib in `dev` mode.
+  - builds and publishes the lib on a local `verdaccio` with a `dev` tag.
+  - a local `verdaccio` is used to debug/test your library in another project:
+    - it is better than `npm link`, as it enforce a specific version, and allows some dependencies to be `dev` too.
+- `fb:rc`: builds the lib in `rc` mode.
+  - builds and publishes the lib on npm with a `rc` tag.
+  - to test before production and final release
+
+### To create an MR
+
+1. fork the repository
+1. add the feature/fix by modifying the code in the `src/` directory
+1. add/write some tests until 100% code coverage is reached (run the tests with `yarn fb:test:coverage`)
+1. format the code, using the command `yarn fb:format`
+1. commit and push your work following the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) convention
+1. create an MR from your repository to the upstream repository, explaining clearly what was added/fixed.
+

package/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2026 Valentin Richard
+
+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.

package/README.md

@@ -0,0 +1,20 @@
+[![npm (scoped)](https://img.shields.io/npm/v/@xstd/constructor-types.svg)](https://www.npmjs.com/package/@xstd/constructor-types)
+![npm](https://img.shields.io/npm/dm/@xstd/constructor-types.svg)
+![NPM](https://img.shields.io/npm/l/@xstd/constructor-types.svg)
+![npm type definitions](https://img.shields.io/npm/types/@xstd/constructor-types.svg)
+
+## @xstd/constructor-types
+
+Typescript class constructor types
+
+## 📦 Installation
+
+```shell
+yarn add @xstd/constructor-types
+# or
+npm install @xstd/constructor-types --save
+```
+
+## 📜 Documentation
+
+TODO

package/abstract-constructor.d.ts

@@ -0,0 +1,2 @@
+export type AbstractConstructor<GArguments extends readonly any[], GInstance> = abstract new (...args: GArguments) => GInstance;
+export type GenericAbstractConstructor = AbstractConstructor<any, any>;

package/abstract-constructor.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=abstract-constructor.js.map

package/abstract-constructor.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"abstract-constructor.js","sourceRoot":"","sources":["../src/abstract-constructor.ts"],"names":[],"mappings":""}

package/constructor.d.ts

@@ -0,0 +1,2 @@
+export type Constructor<GArguments extends readonly any[], GInstance> = abstract new (...args: GArguments) => GInstance;
+export type GenericConstructor = Constructor<any, any>;

package/constructor.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=constructor.js.map

package/constructor.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"constructor.js","sourceRoot":"","sources":["../src/constructor.ts"],"names":[],"mappings":""}

package/index.d.ts

@@ -0,0 +1,2 @@
+export * from './abstract-constructor.ts';
+export * from './constructor.ts';

package/index.js

@@ -0,0 +1,3 @@
+export * from "./abstract-constructor.js";
+export * from "./constructor.js";
+//# sourceMappingURL=index.js.map

package/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,2BAA2B,CAAC;AAC1C,cAAc,kBAAkB,CAAC"}

package/package.json

@@ -0,0 +1,50 @@
+{
+  "name": "@xstd/constructor-types",
+  "version": "1.0.0",
+  "type": "module",
+  "main": "./index.js",
+  "scripts": {
+    "fb:build": "node fabrique/actions/cli/build.cli.js",
+    "fb:format": "prettier --write --ignore-unknown --config ./.prettierrc \"src/**/*.{js,jsx,ts,tsx,html,css,scss}\"",
+    "fb:test": "vitest",
+    "fb:test:coverage": "vitest run --coverage",
+    "fb:bench": "vitest bench",
+    "fb:typedoc": "typedoc --options typedoc.json --tsconfig tsconfig.json",
+    "fb:prod": "node --env-file='.env' fabrique/actions/cli/build-and-publish.cli.js --mode prod",
+    "fb:dev": "node fabrique/actions/cli/build-and-publish.cli.js --mode dev",
+    "fb:rc": "node --env-file='.env' fabrique/actions/cli/build-and-publish.cli.js --mode rc",
+    "fb:node:dev": "node --experimental-strip-types --watch src/main.ts",
+    "fb:node:dev:inspect": "node --experimental-strip-types --watch --inspect src/main.ts"
+  },
+  "description": "Typescript class constructor types",
+  "keywords": [],
+  "author": "Valentin Richard",
+  "license": "MIT",
+  "access": "public",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/xstd-js/constructor-types.git"
+  },
+  "devDependencies": {
+    "@types/node": "^25.5.0",
+    "@vitest/coverage-istanbul": "^4.1.0",
+    "prettier": "^3.8.1",
+    "prettier-plugin-organize-imports": "^4.3.0",
+    "typedoc": "^0.28.17",
+    "typescript": "^5.9.3",
+    "vitest": "^4.1.0"
+  },
+  "packageManager": "yarn@4.13.0",
+  "fabrique": {
+    "version": "1.2.3",
+    "type": "lib"
+  },
+  "exports": {
+    ".": {
+      "types": "./index.d.ts",
+      "default": "./index.js"
+    }
+  },
+  "typings": "./index.d.ts",
+  "types": "./index.d.ts"
+}