@azure-tools/typespec-ts 0.54.0 → 0.54.2

package/dist/src/modular/helpers/client-option-helpers.js

@@ -0,0 +1,103 @@
+const CLIENT_OPTION_DECORATOR_NAME = "Azure.ClientGenerator.Core.@clientOption";
+/**
+ * Extracts all header client options from a decorated type.
+ * Parses @clientOption("header", "x-ms-error-code:errorCode", "javascript") decorators.
+ *
+ * @param type - A decorated SDK type (typically an SdkModelType for error models)
+ * @returns Array of header-to-property mappings
+ */
+export function getHeaderClientOptions(type) {
+    const results = [];
+    for (const decorator of type.decorators) {
+        if (decorator.name !== CLIENT_OPTION_DECORATOR_NAME) {
+            continue;
+        }
+        if (decorator.arguments["name"] !== "header") {
+            continue;
+        }
+        const value = decorator.arguments["value"];
+        if (typeof value !== "string") {
+            continue;
+        }
+        const parsed = parseHeaderMapping(value);
+        if (parsed) {
+            results.push(parsed);
+        }
+    }
+    return results;
+}
+/**
+ * Checks if a model type has any header client options defined.
+ */
+export function hasHeaderClientOptions(type) {
+    return getHeaderClientOptions(type).length > 0;
+}
+/**
+ * Parses a header mapping string like "x-ms-error-code:errorCode"
+ * into its header name and property name components.
+ *
+ * @returns parsed mapping or undefined if the format is invalid
+ */
+function parseHeaderMapping(value) {
+    const colonIndex = value.indexOf(":");
+    if (colonIndex <= 0 || colonIndex >= value.length - 1) {
+        return undefined;
+    }
+    const headerName = value.substring(0, colonIndex).trim();
+    const propertyName = value.substring(colonIndex + 1).trim();
+    if (!headerName || !propertyName) {
+        return undefined;
+    }
+    return { headerName, propertyName };
+}
+/**
+ * Collects header client options from all exception types in an operation.
+ * Deduplicates by property name.
+ */
+export function getExceptionHeaderClientOptions(exceptions) {
+    const results = [];
+    const seenProperties = new Set();
+    for (const exception of exceptions ?? []) {
+        if (!exception.type || exception.type.kind !== "model") {
+            continue;
+        }
+        const model = exception.type;
+        const options = getHeaderClientOptions(model);
+        const dedupedOptions = options.filter((opt) => {
+            if (seenProperties.has(opt.propertyName)) {
+                return false;
+            }
+            seenProperties.add(opt.propertyName);
+            return true;
+        });
+        if (dedupedOptions.length > 0) {
+            results.push({ model, options: dedupedOptions });
+        }
+    }
+    return results;
+}
+/**
+ * Gets the header name for the restErrorCodeHeader client option.
+ * When present, the emitter generates code to set `error.code` from the specified header.
+ *
+ * Usage: @clientOption("restErrorCodeHeader", "x-ms-error-code", "javascript")
+ *
+ * @param type - A decorated SDK type (typically an SdkModelType for error models)
+ * @returns The header name string, or undefined if the option is not set
+ */
+export function getRestErrorCodeHeader(type) {
+    for (const decorator of type.decorators) {
+        if (decorator.name !== CLIENT_OPTION_DECORATOR_NAME) {
+            continue;
+        }
+        if (decorator.arguments["name"] !== "restErrorCodeHeader") {
+            continue;
+        }
+        const value = decorator.arguments["value"];
+        if (typeof value === "string") {
+            return value;
+        }
+    }
+    return undefined;
+}
+//# sourceMappingURL=client-option-helpers.js.map

package/dist/src/modular/helpers/client-option-helpers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"client-option-helpers.js","sourceRoot":"","sources":["../../../../src/modular/helpers/client-option-helpers.ts"],"names":[],"mappings":"AAYA,MAAM,4BAA4B,GAAG,0CAA0C,CAAC;AAEhF;;;;;;GAMG;AACH,MAAM,UAAU,sBAAsB,CAAC,IAAmB;IACxD,MAAM,OAAO,GAAyB,EAAE,CAAC;IACzC,KAAK,MAAM,SAAS,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;QACxC,IAAI,SAAS,CAAC,IAAI,KAAK,4BAA4B,EAAE,CAAC;YACpD,SAAS;QACX,CAAC;QACD,IAAI,SAAS,CAAC,SAAS,CAAC,MAAM,CAAC,KAAK,QAAQ,EAAE,CAAC;YAC7C,SAAS;QACX,CAAC;QACD,MAAM,KAAK,GAAG,SAAS,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;QAC3C,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;YAC9B,SAAS;QACX,CAAC;QACD,MAAM,MAAM,GAAG,kBAAkB,CAAC,KAAK,CAAC,CAAC;QACzC,IAAI,MAAM,EAAE,CAAC;YACX,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACvB,CAAC;IACH,CAAC;IACD,OAAO,OAAO,CAAC;AACjB,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,sBAAsB,CAAC,IAAmB;IACxD,OAAO,sBAAsB,CAAC,IAAI,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC;AACjD,CAAC;AAED;;;;;GAKG;AACH,SAAS,kBAAkB,CAAC,KAAa;IACvC,MAAM,UAAU,GAAG,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IACtC,IAAI,UAAU,IAAI,CAAC,IAAI,UAAU,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACtD,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,MAAM,UAAU,GAAG,KAAK,CAAC,SAAS,CAAC,CAAC,EAAE,UAAU,CAAC,CAAC,IAAI,EAAE,CAAC;IACzD,MAAM,YAAY,GAAG,KAAK,CAAC,SAAS,CAAC,UAAU,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;IAC5D,IAAI,CAAC,UAAU,IAAI,CAAC,YAAY,EAAE,CAAC;QACjC,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,OAAO,EAAE,UAAU,EAAE,YAAY,EAAE,CAAC;AACtC,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,+BAA+B,CAC7C,UAA2C;IAE3C,MAAM,OAAO,GAA6D,EAAE,CAAC;IAC7E,MAAM,cAAc,GAAG,IAAI,GAAG,EAAU,CAAC;IAEzC,KAAK,MAAM,SAAS,IAAI,UAAU,IAAI,EAAE,EAAE,CAAC;QACzC,IAAI,CAAC,SAAS,CAAC,IAAI,IAAI,SAAS,CAAC,IAAI,CAAC,IAAI,KAAK,OAAO,EAAE,CAAC;YACvD,SAAS;QACX,CAAC;QACD,MAAM,KAAK,GAAG,SAAS,CAAC,IAAoB,CAAC;QAC7C,MAAM,OAAO,GAAG,sBAAsB,CAAC,KAAK,CAAC,CAAC;QAC9C,MAAM,cAAc,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE;YAC5C,IAAI,cAAc,CAAC,GAAG,CAAC,GAAG,CAAC,YAAY,CAAC,EAAE,CAAC;gBACzC,OAAO,KAAK,CAAC;YACf,CAAC;YACD,cAAc,CAAC,GAAG,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;YACrC,OAAO,IAAI,CAAC;QACd,CAAC,CAAC,CAAC;QACH,IAAI,cAAc,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC9B,OAAO,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,OAAO,EAAE,cAAc,EAAE,CAAC,CAAC;QACnD,CAAC;IACH,CAAC;IACD,OAAO,OAAO,CAAC;AACjB,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,sBAAsB,CAAC,IAAmB;IACxD,KAAK,MAAM,SAAS,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;QACxC,IAAI,SAAS,CAAC,IAAI,KAAK,4BAA4B,EAAE,CAAC;YACpD,SAAS;QACX,CAAC;QACD,IAAI,SAAS,CAAC,SAAS,CAAC,MAAM,CAAC,KAAK,qBAAqB,EAAE,CAAC;YAC1D,SAAS;QACX,CAAC;QACD,MAAM,KAAK,GAAG,SAAS,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;QAC3C,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;YAC9B,OAAO,KAAK,CAAC;QACf,CAAC;IACH,CAAC;IACD,OAAO,SAAS,CAAC;AACnB,CAAC"}

package/dist/src/modular/helpers/docs-helpers.d.ts

@@ -0,0 +1,3 @@
+export declare function getFixmeForMultilineDocs(fixme: string[]): string[];
+export declare function getDocsFromDescription(description?: string): string[];
+//# sourceMappingURL=docs-helpers.d.ts.map

package/dist/src/modular/helpers/docs-helpers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"docs-helpers.d.ts","sourceRoot":"","sources":["../../../../src/modular/helpers/docs-helpers.ts"],"names":[],"mappings":"AAAA,wBAAgB,wBAAwB,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,MAAM,EAAE,CAElE;AAED,wBAAgB,sBAAsB,CAAC,WAAW,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAKrE"}

package/dist/src/modular/helpers/docs-helpers.js

@@ -0,0 +1,10 @@
+export function getFixmeForMultilineDocs(fixme) {
+    return fixme.map((fixme) => ` @fixme ${fixme}`);
+}
+export function getDocsFromDescription(description) {
+    if (!description || description.trim().length === 0) {
+        return [];
+    }
+    return [description];
+}
+//# sourceMappingURL=docs-helpers.js.map

package/dist/src/modular/helpers/docs-helpers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"docs-helpers.js","sourceRoot":"","sources":["../../../../src/modular/helpers/docs-helpers.ts"],"names":[],"mappings":"AAAA,MAAM,UAAU,wBAAwB,CAAC,KAAe;IACtD,OAAO,KAAK,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,WAAW,KAAK,EAAE,CAAC,CAAC;AAClD,CAAC;AAED,MAAM,UAAU,sBAAsB,CAAC,WAAoB;IACzD,IAAI,CAAC,WAAW,IAAI,WAAW,CAAC,IAAI,EAAE,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACpD,OAAO,EAAE,CAAC;IACZ,CAAC;IACD,OAAO,CAAC,WAAW,CAAC,CAAC;AACvB,CAAC"}

package/dist/src/modular/helpers/example-value-helpers.d.ts

@@ -0,0 +1,83 @@
+import { SdkClientInitializationType, SdkClientType, SdkExampleValue, SdkHttpOperationExample, SdkHttpParameterExampleValue, SdkServiceOperation } from "@azure-tools/typespec-client-generator-core";
+import { SourceFile } from "ts-morph";
+import { SdkContext } from "../../utils/interfaces.js";
+import { ServiceOperation } from "../../utils/operation-util.js";
+/**
+ * Common interfaces for both samples and tests
+ */
+export interface CommonValue {
+    name: string;
+    value: string;
+    isOptional: boolean;
+    onClient: boolean;
+}
+export interface ClientEmitOptions {
+    client: SdkClientType<SdkServiceOperation>;
+    generatedFiles: SourceFile[];
+    classicalMethodPrefix?: string;
+    subFolder?: string;
+    hierarchies?: string[];
+}
+/**
+ * Build parameter value map from example
+ */
+export declare function buildParameterValueMap(example: SdkHttpOperationExample): Record<string, SdkHttpParameterExampleValue>;
+/**
+ * Prepare a common value for tests
+ */
+export declare function prepareCommonValue(name: string, value: SdkExampleValue | string, isOptional?: boolean, onClient?: boolean): CommonValue;
+/**
+ * Get credential value for samples
+ */
+export declare function getCredentialSampleValue(dpgContext: SdkContext, initialization: SdkClientInitializationType): CommonValue | undefined;
+/**
+ * Get credential value for tests
+ */
+export declare function getCredentialTestValue(dpgContext: SdkContext, initialization: SdkClientInitializationType): CommonValue | undefined;
+/**
+ * Serialize example value to string representation for tests.
+ * Note: This is a simplified serializer for tests that does NOT handle plainDate
+ * as Date objects (it stays as string), which is the expected behavior for tests.
+ */
+export declare function serializeExampleValue(value: SdkExampleValue): string;
+/**
+ * Escape special characters to spaces (for samples)
+ */
+export declare function escapeSpecialCharToSpace(str: string): string;
+/**
+ * Generate descriptive names based on operation names
+ */
+export declare function getDescriptiveName(method: {
+    doc?: string;
+    oriName?: string;
+    name: string;
+}, exampleName: string, type: "sample" | "test"): string;
+/**
+ * Common logic for preparing parameters for tests
+ */
+export declare function prepareCommonParameters(dpgContext: SdkContext, method: ServiceOperation, parameterMap: Record<string, SdkHttpParameterExampleValue>, topLevelClient: SdkClientType<SdkServiceOperation>): CommonValue[];
+/**
+ * Common client and method iteration logic
+ */
+export declare function iterateClientsAndMethods(dpgContext: SdkContext, callback: (dpgContext: SdkContext, method: ServiceOperation, options: ClientEmitOptions) => SourceFile | undefined): SourceFile[];
+/**
+ * Generate common method call logic
+ */
+export declare function generateMethodCall(method: ServiceOperation, parameters: CommonValue[], options: ClientEmitOptions, dpgContext?: SdkContext): {
+    methodCall: string;
+    clientParams: string[];
+    clientParamDefs: string[];
+};
+/**
+ * Common source file creation logic
+ */
+export declare function createSourceFile(dpgContext: SdkContext, method: ServiceOperation, options: ClientEmitOptions, type: "sample" | "test", fileName: string): SourceFile;
+/**
+ * Generate assertions for a specific value (recursive for nested objects)
+ */
+export declare function generateAssertionsForValue(value: SdkExampleValue, path: string, maxDepth?: number, currentDepth?: number): string[];
+/**
+ * Generate response assertions based on the example responses
+ */
+export declare function generateResponseAssertions(example: SdkHttpOperationExample, resultVariableName: string, isPaging?: boolean): string[];
+//# sourceMappingURL=example-value-helpers.d.ts.map

package/dist/src/modular/helpers/example-value-helpers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"example-value-helpers.d.ts","sourceRoot":"","sources":["../../../../src/modular/helpers/example-value-helpers.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,2BAA2B,EAC3B,aAAa,EACb,eAAe,EACf,uBAAuB,EACvB,4BAA4B,EAE5B,mBAAmB,EACpB,MAAM,6CAA6C,CAAC;AAErD,OAAO,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AAMtC,OAAO,EAAE,UAAU,EAAE,MAAM,2BAA2B,CAAC;AACvD,OAAO,EAA2B,gBAAgB,EAAE,MAAM,+BAA+B,CAAC;AAO1F;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,UAAU,EAAE,OAAO,CAAC;IACpB,QAAQ,EAAE,OAAO,CAAC;CACnB;AAED,MAAM,WAAW,iBAAiB;IAChC,MAAM,EAAE,aAAa,CAAC,mBAAmB,CAAC,CAAC;IAC3C,cAAc,EAAE,UAAU,EAAE,CAAC;IAC7B,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAC/B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;CACxB;AAED;;GAEG;AACH,wBAAgB,sBAAsB,CACpC,OAAO,EAAE,uBAAuB,GAC/B,MAAM,CAAC,MAAM,EAAE,4BAA4B,CAAC,CAI9C;AAED;;GAEG;AACH,wBAAgB,kBAAkB,CAChC,IAAI,EAAE,MAAM,EACZ,KAAK,EAAE,eAAe,GAAG,MAAM,EAC/B,UAAU,CAAC,EAAE,OAAO,EACpB,QAAQ,CAAC,EAAE,OAAO,GACjB,WAAW,CAOb;AAED;;GAEG;AACH,wBAAgB,wBAAwB,CACtC,UAAU,EAAE,UAAU,EACtB,cAAc,EAAE,2BAA2B,GAC1C,WAAW,GAAG,SAAS,CA+BzB;AAED;;GAEG;AACH,wBAAgB,sBAAsB,CACpC,UAAU,EAAE,UAAU,EACtB,cAAc,EAAE,2BAA2B,GAC1C,WAAW,GAAG,SAAS,CAoCzB;AAED;;;;GAIG;AACH,wBAAgB,qBAAqB,CAAC,KAAK,EAAE,eAAe,GAAG,MAAM,CA+GpE;AAuBD;;GAEG;AACH,wBAAgB,wBAAwB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAK5D;AAED;;GAEG;AACH,wBAAgB,kBAAkB,CAChC,MAAM,EAAE;IAAE,GAAG,CAAC,EAAE,MAAM,CAAC;IAAC,OAAO,CAAC,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,EACxD,WAAW,EAAE,MAAM,EACnB,IAAI,EAAE,QAAQ,GAAG,MAAM,GACtB,MAAM,CAcR;AAED;;GAEG;AACH,wBAAgB,uBAAuB,CACrC,UAAU,EAAE,UAAU,EACtB,MAAM,EAAE,gBAAgB,EACxB,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,4BAA4B,CAAC,EAC1D,cAAc,EAAE,aAAa,CAAC,mBAAmB,CAAC,GACjD,WAAW,EAAE,CAiJf;AAED;;GAEG;AACH,wBAAgB,wBAAwB,CACtC,UAAU,EAAE,UAAU,EACtB,QAAQ,EAAE,CACR,UAAU,EAAE,UAAU,EACtB,MAAM,EAAE,gBAAgB,EACxB,OAAO,EAAE,iBAAiB,KACvB,UAAU,GAAG,SAAS,GAC1B,UAAU,EAAE,CA4Bd;AAED;;GAEG;AACH,wBAAgB,kBAAkB,CAChC,MAAM,EAAE,gBAAgB,EACxB,UAAU,EAAE,WAAW,EAAE,EACzB,OAAO,EAAE,iBAAiB,EAC1B,UAAU,CAAC,EAAE,UAAU,GACtB;IAAE,UAAU,EAAE,MAAM,CAAC;IAAC,YAAY,EAAE,MAAM,EAAE,CAAC;IAAC,eAAe,EAAE,MAAM,EAAE,CAAA;CAAE,CAuD3E;AAED;;GAEG;AACH,wBAAgB,gBAAgB,CAC9B,UAAU,EAAE,UAAU,EACtB,MAAM,EAAE,gBAAgB,EACxB,OAAO,EAAE,iBAAiB,EAC1B,IAAI,EAAE,QAAQ,GAAG,MAAM,EACvB,QAAQ,EAAE,MAAM,GACf,UAAU,CAeZ;AAED;;GAEG;AACH,wBAAgB,0BAA0B,CACxC,KAAK,EAAE,eAAe,EACtB,IAAI,EAAE,MAAM,EACZ,QAAQ,GAAE,MAAU,EACpB,YAAY,GAAE,MAAU,GACvB,MAAM,EAAE,CAiIV;AAED;;GAEG;AACH,wBAAgB,0BAA0B,CACxC,OAAO,EAAE,uBAAuB,EAChC,kBAAkB,EAAE,MAAM,EAC1B,QAAQ,GAAE,OAAe,GACxB,MAAM,EAAE,CA6DV"}