@skeletonizer/utils 1.0.0 → 1.1.1

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2023 Luka Varga
+Copyright (c) 2024 Luka Varga
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -89,13 +89,13 @@ type TSchemaConfig<T extends object> = {
 The `repeat` property specifies the number of times the skeleton part of the component should be repeated whilst in loading state. Eg. if you pass a single `div` inside the skeleton-projected content, and set `repeat` to `5`, there will be 5 `div`s in the skeletonized content when `showSkeleton` is `true`. 
 The `schemaGenerator` property is a function that requires you to return the skeleton structure based on the provided schema configuration. It is a generic function that accepts an object of `T` and expects you to return a mirrored shape where all underlying primitive props should be of shape `SchemaItem<T[K]>`. 
 
-For example, if you want to render 10 students that have borrowed a book from a library, where the underlying data of each student looks like:
+For example, if you want to render 10 (ex)students that have borrowed a book from a library, where the underlying data of each (ex)student looks like:
 
 ```typescript
 type TStudentLibraryMember = {
   name: string;
   age: number;
-  isStudent: boolean;
+  exStudent: boolean;
   profilePicture: string | null;
   booksBorrowed: Array<{ title: string; id: number }>;
 };
@@ -109,7 +109,7 @@ const studentLibraryMemberSchemaGenerator: TSchemaConfig<TStudentLibraryMember>
   schemaGenerator: () => ({
     name: new SchemaItem<string>().words(2),
     age: new SchemaItem<number>().number(18, 30),
-    isStudent: new SchemaItem<boolean>().boolean(),
+    exStudent: new SchemaItem<boolean>().boolean(),
     profilePicture: new SchemaItem().identical('https://your-placeholder-image.jpg'),
     booksBorrowed: Array.from({ length: 3 }, () => ({
       title: new SchemaItem<string>().words(new SchemaItem<number>().number(3, 10).value),
@@ -122,7 +122,7 @@ const studentLibraryMemberSchemaGenerator: TSchemaConfig<TStudentLibraryMember>
 Note: the underlying types must match - eg. you cannot use `name: new SchemaItem<number>().number(18, 30)` in the above example since the underlying type of the `name` property defined by `TStudentLibraryMember` is `string`. This ensures you can safely operate on the generated data in the skeletonized content.
 
 ## colorSchema
-Generally speaking, you shouldn't need to adjust the color scheme of the skeletonized component in most cases. However, should you need to, the color scheme of the skeletonized views can be customized by providing the `colorScheme` input bound property to the `SkeletonizerSkeletonComponent`.
+Generally speaking, you shouldn't need to adjust the color scheme of the skeletonized component in most cases. However, should you need to, the color scheme of the skeletonized views can be customized by providing the `colorSchema` input bound property to the `SkeletonizerSkeletonComponent`.
 You can provide a custom color scheme by providing an object with the following shape:
 
 ```typescript

package/dist/src/types/schema.types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"schema.types.d.ts","sourceRoot":"","sources":["../../../src/types/schema.types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,qBAAqB,CAAC;AAEzD,MAAM,MAAM,gBAAgB,CAAC,CAAC,SAAS,MAAM,IAAI,MAAM,kBAAkB,CAAC,CAAC,CAAC,CAAC;AAE7E,MAAM,MAAM,aAAa,CAAC,CAAC,SAAS,MAAM,IAAI;IAC5C,MAAM,EAAE,MAAM,CAAC;IACf,eAAe,EAAE,gBAAgB,CAAC,CAAC,CAAC,CAAC;CACtC,CAAC"}
+{"version":3,"file":"schema.types.d.ts","sourceRoot":"","sources":["../../../src/types/schema.types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,qBAAqB,CAAC;AAEzD,MAAM,MAAM,gBAAgB,CAAC,CAAC,SAAS,MAAM,IAAI,MAAM,kBAAkB,CAAC,CAAC,CAAC,CAAC;AAG7E,MAAM,MAAM,aAAa,CAAC,CAAC,SAAS,MAAM,IAAI;IAC5C,MAAM,EAAE,MAAM,CAAC;IACf,eAAe,EAAE,gBAAgB,CAAC,CAAC,CAAC,CAAC;CACtC,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@skeletonizer/utils",
-  "version": "1.0.0",
+  "version": "1.1.1",
   "description": "Utils for all skeletonizer packages",
   "author": "Luka Varga",
   "license": "MIT",
@@ -21,7 +21,8 @@
   "exports": {
     "import": "./dist/utils.mjs",
     "require": "./dist/utils.umd.js",
-    "types": "./dist/src/index.d.ts"
+    "types": "./dist/src/index.d.ts",
+    "default": "./dist/utils.mjs"
   },
   "publishConfig": {
     "access": "public"
@@ -40,8 +41,8 @@
     "type-check": "vitest --typecheck.only --watch=false",
     "style-lint": "stylelint 'src/**/*.?(css|scss)' --color",
     "style-lintfix": "stylelint 'src/**/*.?(css|scss)' --color --fix",
-    "lint": "eslint --ext .ts src/ && npm run style-lint",
-    "lintfix": "npm run style-lintfix && eslint --ext .ts src/ --fix",
+    "lint": "eslint src/ && npm run style-lint",
+    "lintfix": "npm run style-lintfix && eslint src/ --fix",
     "lint-staged": "lint-staged"
   },
   "lint-staged": {
@@ -49,10 +50,10 @@
     "**/*.{ts,js}": "eslint --fix"
   },
   "devDependencies": {
-    "@vitest/coverage-istanbul": "2.1.2",
-    "sass": "^1.72.0",
-    "vite-plugin-dts": "^4.2.3",
-    "vitest": "2.1.2"
+    "@vitest/coverage-istanbul": "2.1.4",
+    "sass": "^1.80.5",
+    "vite-plugin-dts": "^4.3.0",
+    "vitest": "2.1.4"
   },
-  "gitHead": "b991aef461188aebee063efb7df47e70c58b0772"
+  "gitHead": "a0b3a5c3b3d12cec97f9bf22830437ce1166c2a3"
 }