@augment-vir/common 31.28.0 → 31.29.1

package/dist/augments/prisma/base-prisma-types.d.ts

@@ -1,20 +1,4 @@
 import { type AnyFunction, type AnyObject } from '@augment-vir/core';
-/**
- * A base type for Prisma model payloads because Prisma doesn't give us one. This currently only
- * includes the properties that are used within this package.
- *
- * Note: this omits the `composites` property because I don't have any examples of what those
- * actually are.
- *
- * @category Prisma : Common
- * @category Package : @augment-vir/common
- * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
- */
-export type BasePrismaPayload = {
-    name: string;
-    objects: Record<string, BasePrismaPayload | BasePrismaPayload[] | null>;
-    scalars: AnyObject;
-};
 /**
  * Base Prisma client type that all `PrismaClient` instances should be able to match, with enough
  * data that it'll omit random accidental objects.
@@ -36,3 +20,18 @@ export type BasePrismaClient = {
 } & {
     [ModelName in string]: any;
 };
+/**
+ * Base Prisma.TypeMap type.
+ *
+ * @category Prisma : Common
+ * @category Package : @augment-vir/common
+ * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
+ */
+export type BaseTypeMap = {
+    model: Record<string, {
+        payload: {
+            scalars: AnyObject;
+            objects: AnyObject;
+        };
+    }>;
+};

package/dist/augments/prisma/prisma-basic-model.d.ts

@@ -1,5 +1,4 @@
-import { type BasePrismaClient } from './base-prisma-types.js';
-import { type PrismaModelName } from './prisma-model-name.js';
+import { type BaseTypeMap } from './base-prisma-types.js';
 /**
  * A basic model entry with only its immediate properties.
  *
@@ -16,7 +15,7 @@ import { type PrismaModelName } from './prisma-model-name.js';
  *
  * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
  */
-export type PrismaBasicModel<PrismaClient extends BasePrismaClient, Model extends PrismaModelName<PrismaClient>> = PrismaClient['model'][Model]['payload']['scalars'];
+export type PrismaBasicModel<TypeMap extends BaseTypeMap, Model extends keyof TypeMap['model']> = TypeMap['model'][Model]['payload']['scalars'];
 /**
  * Basic model entries for all models in the database.
  *
@@ -24,6 +23,6 @@ export type PrismaBasicModel<PrismaClient extends BasePrismaClient, Model extend
  * @category Package : @augment-vir/common
  * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
  */
-export type PrismaAllBasicModels<PrismaClient extends BasePrismaClient> = Partial<{
-    [ModelName in PrismaModelName<PrismaClient>]: PrismaBasicModel<PrismaClient, ModelName>[];
-}>;
+export type PrismaAllBasicModels<TypeMap extends BaseTypeMap> = {
+    [ModelName in keyof TypeMap['model']]: PrismaBasicModel<TypeMap, ModelName>;
+};

package/dist/augments/prisma/prisma-full-model.d.ts

@@ -1,37 +1,30 @@
-import { type BasePrismaClient, type BasePrismaPayload } from './base-prisma-types.js';
-import { type PrismaModelName } from './prisma-model-name.js';
+import { type BaseTypeMap } from './base-prisma-types.js';
+import { type PrismaBasicModel } from './prisma-basic-model.js';
 /**
- * A full model entry with all relations from the given Prisma type map and model name.
+ * Gets the full model type with all nested models for Prisma.
  *
  * @category Prisma : Common
  * @category Package : @augment-vir/common
- * @example
- *
- * ```ts
- * import {type Prisma} from '@prisma/client';
- * import {type FullPrismaModel} from '@augment-vir/common';
- *
- * function doThing(fullModel: FullModel<Prisma.TypeMap, 'User'>) {}
- * ```
- *
  * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
  */
-export type PrismaFullModel<PrismaClient extends BasePrismaClient, Model extends PrismaModelName<PrismaClient>> = ExpandPrismaTypeMapPayload<PrismaClient[Model][symbol]['types']['payload']>;
+export type PrismaFullModel<TypeMap extends BaseTypeMap, Model extends keyof TypeMap['model']> = PrismaBasicModel<TypeMap, Model> & ExpandModelObjects<TypeMap['model'][Model]['payload']['objects'], TypeMap>;
 /**
- * Expand a Prisma payload into its scalars and recursive relations.
+ * Expand a model's objects (nested models).
  *
- * @category Prisma : Common : Util
+ * @category Prisma : Common
  * @category Package : @augment-vir/common
  * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
  */
-export type ExpandPrismaTypeMapPayload<Payload extends BasePrismaPayload> = Payload['scalars'] & {
-    [Key in keyof Payload['objects']]: ExpandPotentialArrayPrismaTypeMapPayload<NonNullable<Payload['objects'][Key]>> | (null extends Payload['objects'][Key] ? null : never);
+export type ExpandModelObjects<Objects, TypeMap extends BaseTypeMap> = {
+    [Key in keyof Objects]: Objects[Key] extends ReadonlyArray<infer Entry> ? ExpandModel<TypeMap, Entry>[] : ExpandModel<TypeMap, Objects[Key]>;
 };
 /**
- * Expand a payload that might be inside of an array, keeping it inside of an array if it is.
+ * Expand a model entry from {@link ExpandModelObjects}.
  *
- * @category Prisma : Common : Util
+ * @category Prisma : Common
  * @category Package : @augment-vir/common
  * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
  */
-export type ExpandPotentialArrayPrismaTypeMapPayload<PayloadWrapper extends BasePrismaPayload | BasePrismaPayload[]> = PayloadWrapper extends (infer ActualPayload extends BasePrismaPayload)[] ? ExpandPrismaTypeMapPayload<ActualPayload>[] : PayloadWrapper extends BasePrismaPayload ? ExpandPrismaTypeMapPayload<PayloadWrapper> : never;
+export type ExpandModel<TypeMap extends BaseTypeMap, Entry> = Entry extends Readonly<{
+    name: infer ModelName extends keyof TypeMap['model'];
+}> ? PrismaFullModel<TypeMap, ModelName> : never;

package/dist/augments/prisma/prisma-model-create.d.ts

@@ -1,4 +1,5 @@
-import { type BasePrismaClient } from './base-prisma-types.js';
+import { type FirstLetterLowercase } from '@augment-vir/core';
+import { type BasePrismaClient, type BaseTypeMap } from './base-prisma-types.js';
 import { type PrismaModelName } from './prisma-model-name.js';
 /**
  * Use this to define mock entries that _shouldn't_ be saved to the database so that we can easily
@@ -74,7 +75,7 @@ export declare const prismaModelCreateOmitId: unique symbol;
  *
  * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
  */
-export type PrismaModelCreate<PrismaClient extends BasePrismaClient, Model extends PrismaModelName<PrismaClient>> = NonNullable<Parameters<PrismaClient[Model]['create']>[0]> extends {
+export type PrismaModelCreate<PrismaClient extends BasePrismaClient, TypeMap extends BaseTypeMap, Model extends PrismaModelName<TypeMap>> = NonNullable<Parameters<PrismaClient[FirstLetterLowercase<Model>]['create']>[0]> extends {
     data?: infer Data;
 } ? NonNullable<Data> & Partial<{
     [prismaModelCreateExclude]: true;
@@ -108,8 +109,8 @@ export type PrismaModelCreate<PrismaClient extends BasePrismaClient, Model exten
  *
  * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
  */
-export type PrismaKeyedModelCreate<PrismaClient extends BasePrismaClient, Model extends PrismaModelName<PrismaClient>> = {
-    [EntryName in string]: PrismaModelCreate<PrismaClient, Model>;
+export type PrismaKeyedModelCreate<PrismaClient extends BasePrismaClient, TypeMap extends BaseTypeMap, Model extends PrismaModelName<TypeMap>> = {
+    [EntryName in string]: PrismaModelCreate<PrismaClient, TypeMap, Model>;
 };
 /**
  * Model create data stored by model name in either array or keyed form. Used in
@@ -154,6 +155,6 @@ export type PrismaKeyedModelCreate<PrismaClient extends BasePrismaClient, Model
  *
  * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
  */
-export type PrismaAllModelsCreate<PrismaClient extends BasePrismaClient> = Readonly<Partial<{
-    [Model in PrismaModelName<PrismaClient>]: Readonly<PrismaKeyedModelCreate<PrismaClient, Model>> | ReadonlyArray<Readonly<PrismaModelCreate<PrismaClient, Model>>>;
+export type PrismaAllModelsCreate<PrismaClient extends BasePrismaClient, TypeMap extends BaseTypeMap> = Readonly<Partial<{
+    [Model in PrismaModelName<TypeMap>]: Readonly<PrismaKeyedModelCreate<PrismaClient, TypeMap, Model>> | ReadonlyArray<Readonly<PrismaModelCreate<PrismaClient, TypeMap, Model>>>;
 }>>;

package/dist/augments/prisma/prisma-model-name.d.ts

@@ -1,4 +1,4 @@
-import { type BasePrismaClient } from './base-prisma-types.js';
+import { type BaseTypeMap } from './base-prisma-types.js';
 /**
  * Extracts all model names from a generated `PrismaClient`.
  *
@@ -15,4 +15,4 @@ import { type BasePrismaClient } from './base-prisma-types.js';
  *
  * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
  */
-export type PrismaModelName<PrismaClient extends BasePrismaClient> = Exclude<keyof PrismaClient, `$${string}` | symbol>;
+export type PrismaModelName<TypeMap extends BaseTypeMap> = Extract<keyof TypeMap['model'], string>;

package/dist/augments/string/casing/capitalization.d.ts

@@ -10,6 +10,7 @@ export declare function maybeCapitalize(input: string, casingOptions: Pick<Casin
 /**
  * Capitalize the first letter of the input.
  *
+ * @deprecated Prefer `setFirstLetterCasing`.
  * @category String
  * @category Package : @augment-vir/common
  * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)

package/dist/augments/string/casing/capitalization.js

@@ -6,11 +6,13 @@
  * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
  */
 export function maybeCapitalize(input, casingOptions) {
+    // eslint-disable-next-line sonarjs/deprecation, @typescript-eslint/no-deprecated
     return casingOptions.capitalizeFirstLetter ? capitalizeFirstLetter(input) : input;
 }
 /**
  * Capitalize the first letter of the input.
  *
+ * @deprecated Prefer `setFirstLetterCasing`.
  * @category String
  * @category Package : @augment-vir/common
  * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)

package/dist/augments/string/casing/casing.d.ts

@@ -1,4 +1,4 @@
-import { type PartialWithUndefined } from '@augment-vir/core';
+import { type FirstLetterLowercase, type FirstLetterUppercase, type PartialWithUndefined } from '@augment-vir/core';
 /**
  * Options for casing functions in `@augment-vir/common`.
  *
@@ -33,6 +33,22 @@ export declare enum StringCase {
     Upper = "upper",
     Lower = "lower"
 }
+/**
+ * Convert the first letter of a string to either lower or uppercase.
+ *
+ * @category String
+ * @category Package : @augment-vir/common
+ * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
+ */
+export type FirstLetterCase<SpecificCase extends StringCase, Value extends string> = SpecificCase extends StringCase.Lower ? FirstLetterLowercase<Value> : FirstLetterUppercase<Value>;
+/**
+ * Set the first letter of the input to uppercase or lowercase.
+ *
+ * @category String
+ * @category Package : @augment-vir/common
+ * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
+ */
+export declare function setFirstLetterCasing<const SpecificCase extends StringCase, const Value extends string>(input: Value, stringCase: SpecificCase): FirstLetterCase<SpecificCase, Value>;
 /**
  * Indicates whether the given string has different lower and upper case variants. (Some strings
  * don't, such as all numbers or `'√'`.)

package/dist/augments/string/casing/casing.js

@@ -20,6 +20,23 @@ export var StringCase;
     StringCase["Upper"] = "upper";
     StringCase["Lower"] = "lower";
 })(StringCase || (StringCase = {}));
+/**
+ * Set the first letter of the input to uppercase or lowercase.
+ *
+ * @category String
+ * @category Package : @augment-vir/common
+ * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
+ */
+export function setFirstLetterCasing(input, stringCase) {
+    if (!input.length) {
+        return '';
+    }
+    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+    const firstLetter = input[0];
+    return ((stringCase === StringCase.Upper
+        ? firstLetter.toUpperCase()
+        : firstLetter.toLowerCase()) + input.slice(1));
+}
 /**
  * Indicates whether the given string has different lower and upper case variants. (Some strings
  * don't, such as all numbers or `'√'`.)

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@augment-vir/common",
-    "version": "31.28.0",
+    "version": "31.29.1",
     "description": "A collection of augments, helpers types, functions, and classes for any JavaScript environment.",
     "keywords": [
         "augment",
@@ -40,8 +40,8 @@
         "test:web": "virmator --no-deps test web"
     },
     "dependencies": {
-        "@augment-vir/assert": "^31.28.0",
-        "@augment-vir/core": "^31.28.0",
+        "@augment-vir/assert": "^31.29.1",
+        "@augment-vir/core": "^31.29.1",
         "@date-vir/duration": "^7.3.2",
         "ansi-styles": "^6.2.1",
         "deepcopy-esm": "^2.1.1",