@itcase/types 1.0.2 → 1.0.4

package/CHANGELOG.md

@@ -1,3 +1,19 @@
+## [1.0.4](https://github.com/ITCase/itcase-types/compare/v1.0.3...v1.0.4) (2025-06-04)
+
+### Features
+
+* add simple urls types ([3d28026](https://github.com/ITCase/itcase-types/commit/3d280261291d9f93ecb694de79ab0be5f9075d2d))
+
+## [1.0.3](https://github.com/ITCase/itcase-types/compare/v1.0.2...v1.0.3) (2025-05-13)
+
+### Fixes
+
+* add files to git ([a9bd6a6](https://github.com/ITCase/itcase-types/commit/a9bd6a613ec8e161179a7553d25232728fdd19e0))
+
+### Features
+
+* add simple "common" types ([e797bc4](https://github.com/ITCase/itcase-types/commit/e797bc4701a4e8f6e9f357b5ab7c7868f7b6c742))
+
 ## [1.0.2](https://github.com/ITCase/itcase-types/compare/v1.0.1...v1.0.2) (2025-04-21)
 
 ### Bug Fixes

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@itcase/types",
-  "version": "1.0.2",
+  "version": "1.0.4",
   "description": "unified type storage",
   "keywords": [
     "types"
@@ -8,7 +8,7 @@
   "license": "MIT",
   "private": false,
   "exports": {
-    ".": "./index.ts"
+    ".": "./types/index.ts"
   },
   "scripts": {
     "lint": "eslint types/",
@@ -16,6 +16,11 @@
     "prepare": "husky",
     "semantic-release": "semantic-release"
   },
+  "files": [
+    "types",
+    "README.md",
+    "CHANGELOG.md"
+  ],
   "repository": {
     "type": "git",
     "url": "https://github.com/ITCase/itcase-types.git"
@@ -24,20 +29,18 @@
     "access": "public",
     "registry": "https://registry.npmjs.org/"
   },
-  "dependencies": {
-    "@itcase/config": "^1.0.26"
-  },
   "devDependencies": {
-    "@commitlint/cli": "^19.8.0",
-    "@commitlint/config-conventional": "^19.8.0",
-    "@itcase/lint": "^1.1.4",
+    "@commitlint/cli": "^19.8.1",
+    "@commitlint/config-conventional": "^19.8.1",
+    "@itcase/config": "^1.0.41",
+    "@itcase/lint": "^1.1.9",
     "@semantic-release/changelog": "^6.0.3",
     "@semantic-release/git": "^10.0.1",
     "@semantic-release/release-notes-generator": "14.0.3",
     "conventional-changelog-conventionalcommits": "^8.0.0",
-    "eslint": "9.24.0",
+    "eslint": "9.26.0",
     "husky": "^9.1.7",
-    "lint-staged": "^15.5.1",
+    "lint-staged": "^16.0.0",
     "prettier": "^3.5.3",
     "semantic-release": "^24.2.3",
     "typescript": "^5.8.3"

package/types/common.ts

@@ -0,0 +1,59 @@
+/**
+ * Used for objects unique identifier as "id" property. Sometime id may be
+ * generated as random string(uuid) or number from the rest-api response.
+ * Or in some cases when JS convert number to string, e.g. cookies, search-params, etc.
+ */
+type Id = number | string
+
+/**
+ * Date
+ * @format ISO date: "2024-01-31"
+ */
+type DateIso = string
+
+/**
+ * Date and time
+ * @format ISO date and time: "2024-01-31T23:00:59.322230+03:00"
+ */
+type DateTimeIso = string
+
+/**
+ * URL to some endpoint. E.g.: to django rest framework
+ * @format relative URL: "/rest/{...}/some/"
+ */
+type RelativeUrl = string
+
+/**
+ * URL to some endpoint. E.g.: to django rest framework
+ * @format absolute URL: "https://itcase.pro/rest/{...}/some/"
+ */
+type AbsoluteUrl = string
+
+/**
+ * URL to file. E.g.: in django media folder
+ * @format relative URL: "/media/uploads/{...}/file_name.png"
+ */
+type ImageRelativeUrl = string
+
+/**
+ * URL to file. E.g.: in django media folder
+ * @format absolute URL: "https://itcase.pro/media/uploads/{...}/file_name.png"
+ */
+type ImageAbsoluteUrl = string
+
+/**
+ * Simple callback function that takes no arguments and returns nothing.
+ * This type is used for basic event handlers or asynchronous operations.
+ */
+type SimpleCallback = () => void
+
+export type {
+  Id,
+  DateIso,
+  DateTimeIso,
+  RelativeUrl,
+  AbsoluteUrl,
+  ImageRelativeUrl,
+  ImageAbsoluteUrl,
+  SimpleCallback,
+}

package/types/index.ts

@@ -17,6 +17,7 @@ export * from './vertical'
  *  files
  */
 export * from './appearanceKeys'
+export * from './common'
 export * from './direction'
 export * from './elevation'
 export * from './height'

package/.editorconfig

@@ -1,35 +0,0 @@
-# editorconfig.org
-root = true
-
-[*]
-indent_style = space
-indent_size = 2
-end_of_line = lf
-charset = utf-8
-trim_trailing_whitespace = true
-insert_final_newline = true
-
-[*.{css,js,jsx,mjs,ts,tsx}]
-indent_style = space
-indent_size = 2
-tab_size = 2
-end_of_line = lf
-charset = utf-8
-trim_trailing_whitespace = true
-insert_final_newline = true
-
-[*.{html,py}]
-indent_style = space
-indent_size = 4
-end_of_line = lf
-charset = utf-8
-trim_trailing_whitespace = true
-insert_final_newline = true
-
-[*.md]
-trim_trailing_whitespace = false
-
-[Makefile]
-indent_style = tab
-indent_size = 4
-

package/.github/workflows/publish.yaml

@@ -1,33 +0,0 @@
-name: "Publish Package to NPM Registry"
-
-on:
-  push:
-    branches:
-    - master
-
-
-jobs:
-  publish-npm:
-    runs-on: ubuntu-latest
-    env:
-      GIT_WORKFLOW: true
-      GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-      NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
-
-    steps:
-      - name: "Make Checkout"
-        uses: actions/checkout@v3
-        with:
-          fetch-depth: 0
-
-      - name: "Setup NodeJS"
-        uses: actions/setup-node@v3
-        with:
-          node-version: 20
-
-      - name: "Install dependencies"
-        run: npm install --force
-
-      - name: "Publish package"
-        shell: bash
-        run: npm run semantic-release

package/.husky/check_message

@@ -1,5 +0,0 @@
-#!/bin/bash
-
-if [[ $(git log --format=%B -n 1) =~ major:|minor:|patch: ]]; then
-  exit 0
-fi

package/.husky/post-commit

@@ -1,14 +0,0 @@
-#!/bin/bash
-
-/bin/bash ".husky/check_message"
-
-branch="$(git rev-parse --abbrev-ref HEAD)"
-
-if [ "$branch" = "master" ]; then
-  {
-    npx commitlint --edit &&
-    exit 0
-  } || {
-    /bin/bash ".husky/set_release_message"
-  }
-fi

package/.husky/post-merge

@@ -1,14 +0,0 @@
-#!/bin/bash
-
-/bin/bash ".husky/check_message"
-
-branch="$(git rev-parse --abbrev-ref HEAD)"
-
-if [ "$branch" = "master" ]; then
-  {
-    npx commitlint --edit &&
-    exit 0
-  } || {
-    /bin/bash ".husky/set_release_message"
-  }
-fi

package/.husky/pre-commit

@@ -1,6 +0,0 @@
-#!/bin/bash
-
-if grep --include=*.{json,css,html,py} --exclude-dir={dist,node_modules,bower_components,.git} -nri --color -B 1 -A 1 '<\{7\} HEAD\|^\=\.{7\}\|>\.{7\}' .; then
-  echo 'Fix conflicts'
-  exit 1
-else ./node_modules/lint-staged/bin/lint-staged.js; fi

package/.husky/pre-push

@@ -1,14 +0,0 @@
-#!/bin/dash
-
-if [ $GIT_WORKFLOW ]; then
-  exit 0
-fi
-
-/bin/bash ".husky/check_message"
-
-branch="$(git rev-parse --abbrev-ref HEAD)"
-
-if [ "$branch" = "master" ]; then
-  npx commitlint --edit &&
-  exit 0
-fi

package/.husky/set_release_message

@@ -1,43 +0,0 @@
-#!/bin/bash
-
-exec < /dev/tty
-
-function update_message {
-  commit_message=$(git log --format=%B -n 1)
-  new_commit_message="${1}: ${commit_message}"
-  git commit --amend -m "${new_commit_message}"
-  git log --format=%B -n 1
-}
-
-
-PS3='Select release type: '
-
-MAJOR='MAJOR version when you make incompatible API changes'
-MINOR='MINOR version when you add functionality in a backwards compatible manner'
-PATCH='PATCH version when you make backwards compatible bug fixes'
-CANCEL='Cancel'
-
-options=("${MAJOR}" "${MINOR}" "${PATCH}" "${CANCEL}")
-select opt in "${options[@]}"
-do
-  case $opt in
-    $MAJOR)
-      update_message 'major'
-      exit 0
-      ;;
-    $MINOR)
-      update_message 'minor'
-      exit 0
-      ;;
-    $PATCH)
-      update_message 'patch'
-      exit 0
-      ;;
-    $CANCEL)
-      exit 1
-      ;;
-    *) echo "invalid option $REPLY";;
-  esac
-done
-
-< /dev/tty

package/commitlint.config.mjs

@@ -1,3 +0,0 @@
-import commitlint from '@itcase/config/commitlint/index.js'
-
-export default commitlint

package/eslint.config.mjs

@@ -1,3 +0,0 @@
-import eslint from '@itcase/lint/eslint/index.js'
-
-export default eslint

package/index.ts

@@ -1 +0,0 @@
-export * from './types/index'

package/lint-staged.config.mjs

@@ -1,3 +0,0 @@
-import lintstaged from '@itcase/config/lint-staged/index.js'
-
-export default lintstaged

package/prettier.config.mjs

@@ -1,3 +0,0 @@
-import prettier from '@itcase/lint/prettier/index.js'
-
-export default prettier

package/release.config.mjs

@@ -1,3 +0,0 @@
-import semanticRelease from '@itcase/config/semantic-release/index.js'
-
-export default semanticRelease

package/tsconfig.json

@@ -1,23 +0,0 @@
-{
-  "compilerOptions": {
-    // Enforce consistent file casing
-    "forceConsistentCasingInFileNames": true,
-    // Treat each file as a separate module
-    "isolatedModules": true,
-    // Resolve modules using Node.js resolution algorithm
-    "moduleResolution": "node",
-    // Do not emit output files (for checking only)
-    "noEmit": true,
-    // Skip type checking of declaration files
-    "skipLibCheck": true,
-    // Enable strict type-checking options
-    "strict": true
-  },
-  // Include files from the 'src' directory for compilation
-  "include": [
-    "types"
-  ],
-  "exclude": [
-    "node_modules/**"
-  ]
-}