npm - @alloy-js/csharp - Versions diffs - 0.18.0-dev.16 → 0.18.0-dev.18 - Mend

@alloy-js/csharp 0.18.0-dev.16 → 0.18.0-dev.18

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (60) hide show

package/src/components/var/declaration.tsx ADDED Viewed

@@ -0,0 +1,47 @@
+import { Children, DeclarationProps, Name, Refkey } from "@alloy-js/core";
+import { useCSharpNamePolicy } from "../../name-policy.js";
+import { Declaration } from "../Declaration.jsx";
+/** Props for {@link VarDeclaration} component */
+export interface VarDeclarationProps
+  extends Omit<DeclarationProps, "nameKind"> {
+  /** Variable name */
+  name: string;
+  /** Type of the variable declaration. If not specified, defaults to "var" */
+  type?: Children;
+  /** Variable refkey */
+  refkey?: Refkey;
+  /** Variable value */
+  children?: Children;
+}
+/**
+ * Render a variable declaration
+ *
+ * @example with var
+ * ```tsx
+ * <VarDeclaration name="myVar">42</VarDeclaration>
+ * ```
+ * This will render:
+ * ```csharp
+ * var myVar = 42;
+ * ```
+ *
+ * @example with type
+ * ```tsx
+ * <VarDeclaration name="myVar" type="int">42</VarDeclaration>
+ * ```
+ * This will render:
+ * ```csharp
+ * int myVar = 42;
+ * ```
+ */
+export function VarDeclaration(props: VarDeclarationProps) {
+  const name = useCSharpNamePolicy().getName(props.name, "variable");
+  return (
+    <Declaration name={name} refkey={props.refkey}>
+      {props.type ?? "var"} <Name /> = {props.children};
+    </Declaration>
+  );
+}

package/src/name-policy.ts CHANGED Viewed

@@ -5,6 +5,7 @@ import * as changecase from "change-case";
 export type CSharpElements =
   | "class"
   | "constant"
+  | "variable"
   | "enum"
   | "enum-member"
   | "function"

package/temp/api.json CHANGED Viewed

@@ -777,29 +777,24 @@
             {
               "kind": "PropertySignature",
               "canonicalReference": "@alloy-js/csharp!ClassDeclarationProps#typeParameters:member",
-              "docComment": "",
+              "docComment": "/**\n * Type parameters for the class\n *\n * @example\n * ```tsx\n * <ClassDeclaration name=\"MyClass\" typeParameters={[\"T\"]} />\n * ```\n *\n * This will produce:\n * ```csharp\n * public class MyClass<T>\n * ```\n *\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
                   "text": "typeParameters?: "
                 },
-                {
-                  "kind": "Reference",
-                  "text": "Record",
-                  "canonicalReference": "!Record:type"
-                },
                 {
                   "kind": "Content",
-                  "text": "<string, "
+                  "text": "(string | "
                 },
                 {
                   "kind": "Reference",
-                  "text": "core.Refkey",
-                  "canonicalReference": "@alloy-js/core!Refkey:type"
+                  "text": "TypeParameterProps",
+                  "canonicalReference": "@alloy-js/csharp!TypeParameterProps:interface"
                 },
                 {
                   "kind": "Content",
-                  "text": ">"
+                  "text": ")[]"
                 },
                 {
                   "kind": "Content",
@@ -812,7 +807,7 @@
               "name": "typeParameters",
               "propertyTypeTokenRange": {
                 "startIndex": 1,
-                "endIndex": 5
+                "endIndex": 4
               }
             }
           ],
@@ -1433,6 +1428,42 @@
                 "startIndex": 1,
                 "endIndex": 2
               }
+            },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@alloy-js/csharp!ClassMethodProps#typeParameters:member",
+              "docComment": "/**\n * Type parameters for the method\n *\n * @example\n * ```tsx\n * <InterfaceMethod name=\"Test\" typeParameters={[\"T\"]} />\n * ```\n *\n * This will produce:\n * ```csharp\n * public void Test<T>()\n * ```\n *\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "typeParameters?: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "("
+                },
+                {
+                  "kind": "Reference",
+                  "text": "TypeParameterProps",
+                  "canonicalReference": "@alloy-js/csharp!TypeParameterProps:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": " | string)[]"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": true,
+              "releaseTag": "Public",
+              "name": "typeParameters",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 4
+              }
             }
           ],
           "extendsTokenRanges": [
@@ -1675,7 +1706,7 @@
             },
             {
               "kind": "Content",
-              "text": "\"class\" | \"constant\" | \"enum\" | \"enum-member\" | \"function\" | \"interface\" | \"record\" | \"class-member-private\" | \"class-member-public\" | \"class-method\" | \"class-property\" | \"parameter\" | \"type-parameter\""
+              "text": "\"class\" | \"constant\" | \"variable\" | \"enum\" | \"enum-member\" | \"function\" | \"interface\" | \"record\" | \"class-member-private\" | \"class-member-public\" | \"class-method\" | \"class-property\" | \"parameter\" | \"type-parameter\""
             },
             {
               "kind": "Content",
@@ -4525,29 +4556,24 @@
             {
               "kind": "PropertySignature",
               "canonicalReference": "@alloy-js/csharp!InterfaceDeclarationProps#typeParameters:member",
-              "docComment": "",
+              "docComment": "/**\n * Type parameters for the interface\n *\n * @example\n * ```tsx\n * <InterfaceDeclaration name=\"IList\" typeParameters={[\"T\"]} />\n * ```\n *\n * This will produce:\n * ```csharp\n * public interface IList<T>\n * ```\n *\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
                   "text": "typeParameters?: "
                 },
-                {
-                  "kind": "Reference",
-                  "text": "Record",
-                  "canonicalReference": "!Record:type"
-                },
                 {
                   "kind": "Content",
-                  "text": "<string, "
+                  "text": "("
                 },
                 {
                   "kind": "Reference",
-                  "text": "core.Refkey",
-                  "canonicalReference": "@alloy-js/core!Refkey:type"
+                  "text": "TypeParameterProps",
+                  "canonicalReference": "@alloy-js/csharp!TypeParameterProps:interface"
                 },
                 {
                   "kind": "Content",
-                  "text": ">"
+                  "text": " | string)[]"
                 },
                 {
                   "kind": "Content",
@@ -4560,7 +4586,7 @@
               "name": "typeParameters",
               "propertyTypeTokenRange": {
                 "startIndex": 1,
-                "endIndex": 5
+                "endIndex": 4
               }
             }
           ],
@@ -4883,6 +4909,42 @@
                 "startIndex": 1,
                 "endIndex": 2
               }
+            },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@alloy-js/csharp!InterfaceMethodProps#typeParameters:member",
+              "docComment": "/**\n * Type parameters for the method\n *\n * @example\n * ```tsx\n * <InterfaceMethod name=\"Test\" typeParameters={[\"T\"]} />\n * ```\n *\n * This will produce:\n * ```csharp\n * public void Test<T>()\n * ```\n *\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "typeParameters?: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "("
+                },
+                {
+                  "kind": "Reference",
+                  "text": "TypeParameterProps",
+                  "canonicalReference": "@alloy-js/csharp!TypeParameterProps:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": " | string)[]"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": true,
+              "releaseTag": "Public",
+              "name": "typeParameters",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 4
+              }
             }
           ],
           "extendsTokenRanges": [
@@ -7437,6 +7499,133 @@
           ],
           "extendsTokenRanges": []
         },
+        {
+          "kind": "Interface",
+          "canonicalReference": "@alloy-js/csharp!TypeParameterProps:interface",
+          "docComment": "/**\n * Information for a TypeScript generic type parameter.\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export interface TypeParameterProps "
+            }
+          ],
+          "fileUrlPath": "src/components/type-parameters/type-parameter.tsx",
+          "releaseTag": "Public",
+          "name": "TypeParameterProps",
+          "preserveMemberOrder": false,
+          "members": [
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@alloy-js/csharp!TypeParameterProps#constraints:member",
+              "docComment": "/**\n * The parameter constraint\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "readonly constraints?: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "Children",
+                  "canonicalReference": "@alloy-js/core!Children:type"
+                },
+                {
+                  "kind": "Content",
+                  "text": " | "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "Children",
+                  "canonicalReference": "@alloy-js/core!Children:type"
+                },
+                {
+                  "kind": "Content",
+                  "text": "[]"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": true,
+              "isOptional": true,
+              "releaseTag": "Public",
+              "name": "constraints",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 5
+              }
+            },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@alloy-js/csharp!TypeParameterProps#name:member",
+              "docComment": "/**\n * The name of the type parameter.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "readonly name: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": true,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "name",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@alloy-js/csharp!TypeParameterProps#refkey:member",
+              "docComment": "/**\n * A refkey or array of refkeys for this type parameter.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "readonly refkey?: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "Refkey",
+                  "canonicalReference": "@alloy-js/core!Refkey:type"
+                },
+                {
+                  "kind": "Content",
+                  "text": " | "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "Refkey",
+                  "canonicalReference": "@alloy-js/core!Refkey:type"
+                },
+                {
+                  "kind": "Content",
+                  "text": "[]"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": true,
+              "isOptional": true,
+              "releaseTag": "Public",
+              "name": "refkey",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 5
+              }
+            }
+          ],
+          "extendsTokenRanges": []
+        },
         {
           "kind": "Function",
           "canonicalReference": "@alloy-js/csharp!useCSharpNamePolicy:function(1)",
@@ -7670,6 +7859,209 @@
             }
           ],
           "extendsTokenRanges": []
+        },
+        {
+          "kind": "Function",
+          "canonicalReference": "@alloy-js/csharp!VarDeclaration:function(1)",
+          "docComment": "/**\n * Render a variable declaration\n *\n * @example\n *\n *  with var\n * ```tsx\n * <VarDeclaration name=\"myVar\">42</VarDeclaration>\n * ```\n *\n * This will render:\n * ```csharp\n * var myVar = 42;\n * ```\n *\n * @example\n *\n *  with type\n * ```tsx\n * <VarDeclaration name=\"myVar\" type=\"int\">42</VarDeclaration>\n * ```\n *\n * This will render:\n * ```csharp\n * int myVar = 42;\n * ```\n *\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export declare function VarDeclaration(props: "
+            },
+            {
+              "kind": "Reference",
+              "text": "VarDeclarationProps",
+              "canonicalReference": "@alloy-js/csharp!VarDeclarationProps:interface"
+            },
+            {
+              "kind": "Content",
+              "text": "): "
+            },
+            {
+              "kind": "Reference",
+              "text": "Children",
+              "canonicalReference": "@alloy-js/core!Children:type"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "fileUrlPath": "src/components/var/declaration.tsx",
+          "returnTypeTokenRange": {
+            "startIndex": 3,
+            "endIndex": 4
+          },
+          "releaseTag": "Public",
+          "overloadIndex": 1,
+          "parameters": [
+            {
+              "parameterName": "props",
+              "parameterTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isOptional": false
+            }
+          ],
+          "name": "VarDeclaration"
+        },
+        {
+          "kind": "Interface",
+          "canonicalReference": "@alloy-js/csharp!VarDeclarationProps:interface",
+          "docComment": "/**\n * Props for {@link VarDeclaration} component\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export interface VarDeclarationProps extends "
+            },
+            {
+              "kind": "Reference",
+              "text": "Omit",
+              "canonicalReference": "!Omit:type"
+            },
+            {
+              "kind": "Content",
+              "text": "<"
+            },
+            {
+              "kind": "Reference",
+              "text": "DeclarationProps",
+              "canonicalReference": "@alloy-js/core!DeclarationProps:type"
+            },
+            {
+              "kind": "Content",
+              "text": ", \"nameKind\">"
+            },
+            {
+              "kind": "Content",
+              "text": " "
+            }
+          ],
+          "fileUrlPath": "src/components/var/declaration.tsx",
+          "releaseTag": "Public",
+          "name": "VarDeclarationProps",
+          "preserveMemberOrder": false,
+          "members": [
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@alloy-js/csharp!VarDeclarationProps#children:member",
+              "docComment": "/**\n * Variable value\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "children?: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "Children",
+                  "canonicalReference": "@alloy-js/core!Children:type"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": true,
+              "releaseTag": "Public",
+              "name": "children",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@alloy-js/csharp!VarDeclarationProps#name:member",
+              "docComment": "/**\n * Variable name\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "name: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "name",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@alloy-js/csharp!VarDeclarationProps#refkey:member",
+              "docComment": "/**\n * Variable refkey\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "refkey?: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "Refkey",
+                  "canonicalReference": "@alloy-js/core!Refkey:type"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": true,
+              "releaseTag": "Public",
+              "name": "refkey",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@alloy-js/csharp!VarDeclarationProps#type:member",
+              "docComment": "/**\n * Type of the variable declaration. If not specified, defaults to \"var\"\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "type?: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "Children",
+                  "canonicalReference": "@alloy-js/core!Children:type"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": true,
+              "releaseTag": "Public",
+              "name": "type",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            }
+          ],
+          "extendsTokenRanges": [
+            {
+              "startIndex": 1,
+              "endIndex": 5
+            }
+          ]
         }
       ]
     }