@etsoo/shared 1.1.48 → 1.1.51

package/README.md

@@ -74,7 +74,7 @@ ETSOO Extended abstract history class
 |replaceState|Modifies the current history entry|
 
 ## DataTypes
-Data type definitions and type safe functions
+Data type definitions and type safe functions. ListItemType and ListItemType1 are sugar types.
 
 |Name|Description|
 |---:|---|

package/__tests__/DataTypes.ts

@@ -1,4 +1,4 @@
-import { DataTypes } from '../src/DataTypes';
+import { DataTypes, IdDefaultType, LabelDefaultType } from '../src/DataTypes';
 
 test('Tests for DI', () => {
     const item: DataTypes.DIS<'id', number> & DataTypes.DIS<'label', string> = {
@@ -132,3 +132,25 @@ test('Tests for isSimpleType', () => {
     expect(DataTypes.isSimpleType(['a', 'b', 'c'])).toBeTruthy();
     expect(DataTypes.isSimpleType({})).toBeFalsy();
 });
+
+test('Tests for IdDefaultType', () => {
+    const test = <T extends object, F extends keyof T = IdDefaultType<T>>(
+        obj: T,
+        field?: F
+    ) => {
+        const f = field ?? ('id' as F);
+        return obj[f];
+    };
+
+    type D = { label: string; name: string; id: number };
+    const data: D = {
+        label: 'label',
+        name: 'name',
+        id: 1
+    };
+    const v = test<D>(data);
+    expect(typeof v).toBe('number');
+
+    const v1 = test<D, LabelDefaultType<D>>(data, 'label');
+    expect(v1).toBe('label');
+});

package/lib/cjs/DataTypes.d.ts

@@ -180,7 +180,7 @@ export declare namespace DataTypes {
     /**
      * Get specific type keys
      */
-    type Keys<T, R = string | number> = {
+    type Keys<T extends object, R = string | number> = {
         [k in keyof T]: T[k] extends R ? k : never;
     }[keyof T];
     /**
@@ -325,3 +325,23 @@ export declare namespace DataTypes {
      */
     function isSimpleType(input: unknown, includeArray?: boolean): boolean;
 }
+/**
+ * List item with number id type
+ */
+export declare type ListType = DataTypes.IdLabelItem<number>;
+/**
+ * List item with string id type
+ */
+export declare type ListType1 = DataTypes.IdLabelItem<string>;
+/**
+ * Id default type
+ */
+export declare type IdDefaultType<T extends object> = T extends {
+    id: number | string;
+} ? DataTypes.Keys<T> & 'id' : DataTypes.Keys<T>;
+/**
+ * Label default type
+ */
+export declare type LabelDefaultType<T extends object> = T extends {
+    label: string;
+} ? DataTypes.Keys<T, string> & 'label' : DataTypes.Keys<T, string>;

package/lib/mjs/DataTypes.d.ts

@@ -180,7 +180,7 @@ export declare namespace DataTypes {
     /**
      * Get specific type keys
      */
-    type Keys<T, R = string | number> = {
+    type Keys<T extends object, R = string | number> = {
         [k in keyof T]: T[k] extends R ? k : never;
     }[keyof T];
     /**
@@ -325,3 +325,23 @@ export declare namespace DataTypes {
      */
     function isSimpleType(input: unknown, includeArray?: boolean): boolean;
 }
+/**
+ * List item with number id type
+ */
+export declare type ListType = DataTypes.IdLabelItem<number>;
+/**
+ * List item with string id type
+ */
+export declare type ListType1 = DataTypes.IdLabelItem<string>;
+/**
+ * Id default type
+ */
+export declare type IdDefaultType<T extends object> = T extends {
+    id: number | string;
+} ? DataTypes.Keys<T> & 'id' : DataTypes.Keys<T>;
+/**
+ * Label default type
+ */
+export declare type LabelDefaultType<T extends object> = T extends {
+    label: string;
+} ? DataTypes.Keys<T, string> & 'label' : DataTypes.Keys<T, string>;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@etsoo/shared",
-    "version": "1.1.48",
+    "version": "1.1.51",
     "description": "TypeScript shared utilities and functions",
     "main": "lib/cjs/index.js",
     "module": "lib/mjs/index.js",
@@ -64,6 +64,6 @@
         "jest": "^28.1.3",
         "jest-environment-jsdom": "^28.1.3",
         "ts-jest": "^28.0.8",
-        "typescript": "^4.7.4"
+        "typescript": "^4.8.2"
     }
 }

package/src/DataTypes.ts

@@ -231,7 +231,7 @@ export namespace DataTypes {
     /**
      * Get specific type keys
      */
-    export type Keys<T, R = string | number> = {
+    export type Keys<T extends object, R = string | number> = {
         [k in keyof T]: T[k] extends R ? k : never;
     }[keyof T];
 
@@ -646,3 +646,27 @@ export namespace DataTypes {
         return true;
     }
 }
+
+/**
+ * List item with number id type
+ */
+export type ListType = DataTypes.IdLabelItem<number>;
+
+/**
+ * List item with string id type
+ */
+export type ListType1 = DataTypes.IdLabelItem<string>;
+
+/**
+ * Id default type
+ */
+export type IdDefaultType<T extends object> = T extends { id: number | string }
+    ? DataTypes.Keys<T> & 'id'
+    : DataTypes.Keys<T>;
+
+/**
+ * Label default type
+ */
+export type LabelDefaultType<T extends object> = T extends { label: string }
+    ? DataTypes.Keys<T, string> & 'label'
+    : DataTypes.Keys<T, string>;