@stryke/types 0.0.1

package/dist/utility-types/user.cjs

@@ -0,0 +1,11 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.UserType = void 0;
+const UserType = exports.UserType = {
+  INTERNAL: "internal",
+  EXTERNAL: "external",
+  SERVICE: "service"
+};

package/dist/utility-types/user.d.ts

@@ -0,0 +1,30 @@
+export type UserType = "internal" | "external" | "service";
+export declare const UserType: {
+    INTERNAL: UserType;
+    EXTERNAL: UserType;
+    SERVICE: UserType;
+};
+export interface UserBase {
+    /**
+     * The user's ID.
+     */
+    id: string;
+    /**
+     * The user's full name.
+     */
+    username?: string;
+    /**
+     * The user's type.
+     *
+     * @defaultValue "external"
+     */
+    type: UserType;
+    /**
+     * The user's email address.
+     */
+    email?: string;
+    /**
+     * The user's role.
+     */
+    role?: string;
+}

package/dist/utility-types/user.mjs

@@ -0,0 +1 @@
+export const UserType={INTERNAL:"internal",EXTERNAL:"external",SERVICE:"service"};

package/dist/utility-types/utilities.cjs

@@ -0,0 +1 @@
+"use strict";

package/dist/utility-types/utilities.d.ts

@@ -0,0 +1,53 @@
+import type { Primitive } from "./base";
+export type Nullable<T> = T | null;
+export type IsNullable<T> = [null] extends [T] ? true : false;
+export type RequiredByKey<T, K extends keyof T> = Omit<T, K> & Required<Pick<T, K>>;
+export type NoInfer<T> = [T][T extends any ? 0 : never];
+type Narrowable = string | number | bigint | boolean;
+type NarrowRaw<A> = (A extends [] ? [] : never) | (A extends Narrowable ? A : never) | {
+    [K in keyof A]: A[K] extends Function ? A[K] : NarrowRaw<A[K]>;
+};
+export type Narrow<A> = Try<A, [], NarrowRaw<A>>;
+export type Try<A1, A2, Catch = never> = A1 extends A2 ? A1 : Catch;
+export type Pretty<T> = {
+    [K in keyof T]: T[K];
+} & {};
+export type ComputeRange<N extends number, Result extends unknown[] = []> = Result["length"] extends N ? Result : ComputeRange<N, [...Result, Result["length"]]>;
+export type Index40 = ComputeRange<40>[number];
+/**
+ * A utility type for specifying a name/value pair.
+ */
+export interface NameValuePair<TValue, TName = string> {
+    /**
+     * The name of the pair
+     */
+    name: TName;
+    /**
+     * The value of the pair
+     */
+    value: TValue;
+}
+/**
+ * Ask TS to re-check that `A1` extends `A2`.
+ * And if it fails, `A2` will be enforced anyway.
+ * Can also be used to add constraints on parameters.
+ *
+ * @example
+ * ```ts
+ * import { Cast } from '@stryke/types'
+ *
+ * type test0 = Cast<'42', string> // '42'
+ * type test1 = Cast<'42', number> // number
+ * ```
+ *
+ * @param A1 - to check against
+ * @param A2 - to cast to
+ * @returns `A1 | A2`
+ */
+export type Cast<A1 extends any, A2 extends any> = A1 extends A2 ? A1 : A2;
+export type DeepReadonly<T> = T extends Primitive ? T : T extends Array<infer U> ? DeepReadonlyArray<U> : DeepReadonlyObject<T>;
+export type DeepReadonlyArray<T> = ReadonlyArray<DeepReadonly<T>>;
+export type DeepReadonlyObject<T> = {
+    readonly [K in keyof T]: DeepReadonly<T[K]>;
+};
+export {};

package/dist/utility-types/validations.cjs

@@ -0,0 +1 @@
+"use strict";

package/dist/utility-types/validations.d.ts

@@ -0,0 +1,16 @@
+import type { MessageDetails, MessageType } from "./messages";
+export type ValidationDetails<TMessageType extends typeof MessageType.ERROR | typeof MessageType.WARNING | typeof MessageType.INFO | typeof MessageType.HELP | typeof MessageType.SUCCESS = typeof MessageType.ERROR | typeof MessageType.WARNING | typeof MessageType.INFO | typeof MessageType.HELP | typeof MessageType.SUCCESS> = MessageDetails<TMessageType> & {
+    /**
+     * The field path that the message is related to.
+     *
+     * @remarks
+     * If `undefined` or `null`, the message is not related to a specific field - in this case it is likely a global/form message.
+     */
+    field?: string | null;
+};
+export type ErrorValidationDetails = ValidationDetails<typeof MessageType.ERROR>;
+export type WarningValidationDetails = ValidationDetails<typeof MessageType.WARNING>;
+export type InfoValidationDetails = ValidationDetails<typeof MessageType.INFO>;
+export type HelpValidationDetails = ValidationDetails<typeof MessageType.HELP>;
+export type SuccessValidationDetails = ValidationDetails<typeof MessageType.SUCCESS>;
+export type InferValidationType<TMessageType extends MessageType> = TMessageType extends typeof MessageType.ERROR ? ErrorValidationDetails : TMessageType extends typeof MessageType.WARNING ? WarningValidationDetails : TMessageType extends typeof MessageType.INFO ? InfoValidationDetails : TMessageType extends typeof MessageType.SUCCESS ? SuccessValidationDetails : ValidationDetails;