@twin.org/nameof 0.0.2-next.8 → 0.0.2

package/docs/examples.md

@@ -1,74 +1,60 @@
-# @twin.org/nameof - Examples
+# Nameof Examples
 
-## `nameof<T>`
+Use these snippets for strongly typed name extraction patterns that remain safe during refactors.
 
-One of the internal transformers in the TypeScript compiler will reduce an interface to no code, which means that at runtime the type information is missing. So operations where you might like to find the name of a class/type etc are not available.
-
-We have many places in our code where we want to use the name of the class, we could do the following.
+## `nameof`
 
 ```typescript
-export class MyClass {
-  public static className(): string {
-    return 'MyClass';
-  }
-}
-console.log(MyClass.className()); // Outputs "MyClass"
-```
+import { nameof } from '@twin.org/nameof';
 
-But if you changed the name of the class you would have to make sure you also replaced all string instances where it was mentioned as well, this is prone to lots of errors.
+class AccountState {
+  public id!: string;
+}
 
-We can use the `nameof` transformer as follows.
+nameof<AccountState>(); // 'AccountState'
+```
 
 ```typescript
 import { nameof } from '@twin.org/nameof';
 
-export class MyClass {
-  public static className(): string {
-    return nameof<MyClass>();
-  }
+interface Profile {
+  displayName: string;
+  stats?: {
+    loginCount: number;
+  };
 }
-console.log(MyClass.className()); // Outputs "MyClass"
-```
-
-Now if we rename `MyClass` without updating the references in the `nameof` call we will get a compiler error, code auto refactoring would actually perform the rename for us.
 
-Since `nameof` is performed as a compile time transform, the actual code produced looks like this.
+const profile: Profile = {
+  displayName: 'Ari',
+  stats: {
+    loginCount: 12
+  }
+};
 
-```javascript
-export class MyClass {
-    static public className(): string {
-        return "MyClass";
-    }
-}
-console.log(MyClass.className()); // Outputs "MyClass"
+nameof(profile.displayName); // 'displayName'
+nameof(profile.stats?.loginCount); // 'stats.loginCount'
 ```
 
-This means there is no additional overheads in function calls at runtime.
-
-## `nameof(propName)`
-
-The `nameof(propName)` transform behaves in much the same way as `nameof<T>`, but instead works on properties passed to it.
+## `nameofKebabCase`
 
 ```typescript
-import { nameof } from '@twin.org/nameof';
+import { nameofKebabCase } from '@twin.org/nameof';
 
-export class MyClass {
-  public static propName(aProp: string): string {
-    return nameof(aProp);
-  }
+class ReportSummary {
+  public totalCount!: number;
 }
-console.log(MyClass.propName()); // Outputs "aProp"
+
+nameofKebabCase<ReportSummary>(); // 'report-summary'
 ```
 
-You can also used it with chained properties, nullish operators can also be used, but are removed.
+## `nameofCamelCase`
 
 ```typescript
-import { nameof } from '@twin.org/nameof';
+import { nameofCamelCase } from '@twin.org/nameof';
 
-export class MyClass {
-  public static propName(aProp: { inner?: boolean }): string {
-    return nameof(aProp?.inner);
-  }
+class UserProfileRecord {
+  public profileImageUrl!: string;
 }
-console.log(MyClass.propName()); // Outputs "aProp.inner"
+
+nameofCamelCase<UserProfileRecord>(); // 'userProfileRecord'
 ```

package/docs/reference/functions/nameofCamelCase.md

@@ -0,0 +1,31 @@
+# Function: nameofCamelCase()
+
+> **nameofCamelCase**\<`T`\>(`property?`, `replaceParent?`): `string`
+
+Placeholder method which substitutes the type name as a string at runtime.
+
+## Type Parameters
+
+### T
+
+`T`
+
+## Parameters
+
+### property?
+
+`unknown`
+
+The property to get the name of.
+
+### replaceParent?
+
+`string`
+
+Optional object name to replace the top level object of a property path.
+
+## Returns
+
+`string`
+
+The type name as a string.

package/docs/reference/functions/nameofKebabCase.md

@@ -0,0 +1,31 @@
+# Function: nameofKebabCase()
+
+> **nameofKebabCase**\<`T`\>(`property?`, `replaceParent?`): `string`
+
+Placeholder method which substitutes the type name as a string at runtime.
+
+## Type Parameters
+
+### T
+
+`T`
+
+## Parameters
+
+### property?
+
+`unknown`
+
+The property to get the name of.
+
+### replaceParent?
+
+`string`
+
+Optional object name to replace the top level object of a property path.
+
+## Returns
+
+`string`
+
+The type name as a string.

package/docs/reference/index.md

@@ -3,3 +3,5 @@
 ## Functions
 
 - [nameof](functions/nameof.md)
+- [nameofKebabCase](functions/nameofKebabCase.md)
+- [nameofCamelCase](functions/nameofCamelCase.md)

package/package.json

@@ -1,10 +1,10 @@
 {
 	"name": "@twin.org/nameof",
-	"version": "0.0.2-next.8",
-	"description": "Provides the definitions for the methods which are processed by the nameof-transformer",
+	"version": "0.0.2",
+	"description": "The definitions for the methods which are processed by the nameof-transformer",
 	"repository": {
 		"type": "git",
-		"url": "git+https://github.com/twinfoundation/framework.git",
+		"url": "git+https://github.com/iotaledger/framework.git",
 		"directory": "packages/nameof"
 	},
 	"author": "martyn.janes@iota.org",
@@ -13,21 +13,30 @@
 	"engines": {
 		"node": ">=20.0.0"
 	},
-	"main": "./dist/cjs/index.cjs",
-	"module": "./dist/esm/index.mjs",
+	"main": "./dist/es/index.js",
 	"types": "./dist/types/index.d.ts",
 	"exports": {
 		".": {
 			"types": "./dist/types/index.d.ts",
-			"require": "./dist/cjs/index.cjs",
-			"import": "./dist/esm/index.mjs"
+			"import": "./dist/es/index.js",
+			"default": "./dist/es/index.js"
 		}
 	},
 	"files": [
-		"dist/cjs",
-		"dist/esm",
+		"dist/es",
 		"dist/types",
 		"locales",
 		"docs"
-	]
+	],
+	"keywords": [
+		"twin",
+		"trade",
+		"iota",
+		"framework",
+		"blockchain"
+	],
+	"bugs": {
+		"url": "git+https://github.com/iotaledger/framework/issues"
+	},
+	"homepage": "https://twindev.org"
 }

package/dist/cjs/index.cjs

@@ -1,16 +0,0 @@
-'use strict';
-
-// Copyright 2024 IOTA Stiftung.
-// SPDX-License-Identifier: Apache-2.0.
-/**
- * Placeholder method which substitutes the type name as a string at runtime.
- * @param property The property to get the name of.
- * @param replaceParent Optional object name to replace the top level object of a property path.
- * @returns The type name as a string.
- */
-// eslint-disable-next-line @typescript-eslint/no-unused-vars
-function nameof(property, replaceParent) {
-    return "@twin.org/nameof-transformer is not in the build pipeline, you need to use a compiler that supports transformer plugins.";
-}
-
-exports.nameof = nameof;

package/dist/esm/index.mjs

@@ -1,14 +0,0 @@
-// Copyright 2024 IOTA Stiftung.
-// SPDX-License-Identifier: Apache-2.0.
-/**
- * Placeholder method which substitutes the type name as a string at runtime.
- * @param property The property to get the name of.
- * @param replaceParent Optional object name to replace the top level object of a property path.
- * @returns The type name as a string.
- */
-// eslint-disable-next-line @typescript-eslint/no-unused-vars
-function nameof(property, replaceParent) {
-    return "@twin.org/nameof-transformer is not in the build pipeline, you need to use a compiler that supports transformer plugins.";
-}
-
-export { nameof };