@azure-tools/typespec-rust 0.39.1 → 0.40.0

package/dist/src/tcgcadapter/adapter.js

@@ -183,7 +183,7 @@ export class Adapter {
             needsCoreAndSerde = true;
         }
         for (const sdkEnum of this.ctx.sdkPackage.enums) {
-            if ((sdkEnum.usage & tcgc.UsageFlags.ApiVersionEnum) === tcgc.UsageFlags.ApiVersionEnum) {
+            if ((sdkEnum.usage & tcgc.UsageFlags.ApiVersionEnum) !== 0) {
                 // we skip generating the enums for API
                 // versions as we expose it as a String
                 continue;
@@ -401,12 +401,11 @@ export class Adapter {
             stack = new Array();
         }
         let modelFlags = rust.ModelFlags.Unspecified;
-        if ((model.usage & tcgc.UsageFlags.Input) === tcgc.UsageFlags.Input) {
+        if ((model.usage & tcgc.UsageFlags.Input) !== 0) {
             modelFlags |= rust.ModelFlags.Input;
         }
         // include error and LRO polling types as output types
-        if ((model.usage & tcgc.UsageFlags.Output) === tcgc.UsageFlags.Output ||
-            (model.usage & tcgc.UsageFlags.LroPolling) === tcgc.UsageFlags.LroPolling) {
+        if ((model.usage & tcgc.UsageFlags.Output) !== 0 || (model.usage & tcgc.UsageFlags.LroPolling) !== 0) {
             modelFlags |= rust.ModelFlags.Output;
         }
         rustModel = new rust.Model(modelName, model.access === 'internal' ? 'pubCrate' : 'pub', modelFlags, this.adaptNamespace(model.namespace));
@@ -1328,7 +1327,7 @@ export class Adapter {
      * @returns a Rust client
      */
     recursiveAdaptClient(client, parent) {
-        var _a, _b, _c, _d, _e, _f, _g;
+        var _a, _b, _c, _d, _e, _f, _g, _h;
         let clientName = client.name;
         // NOTE: if the client has the @clientName decorator applied then use that verbatim
         if (parent && !hasClientNameDecorator(client.decorators)) {
@@ -1355,6 +1354,12 @@ export class Adapter {
         rustClient.docs = this.adaptDocs(client.summary, client.doc);
         rustClient.parent = parent;
         rustClient.fields.push(new rust.StructField('pipeline', 'pubCrate', new rust.ExternalType(this.crate, 'Pipeline', 'azure_core::http')));
+        // check if omitEndpointMethod was set to true
+        const omitEndpointMethod = (_a = client.decorators.find(d => d.name === 'Azure.ClientGenerator.Core.@clientOption'
+            && d.arguments['name'] === 'omitEndpointMethod')) === null || _a === void 0 ? void 0 : _a.arguments['value'];
+        if (omitEndpointMethod === true) {
+            rustClient.omitEndpointMethod = omitEndpointMethod;
+        }
         // InitializedByFlags.CustomizeCode means the client is instantiable
         // but the constructor is to be omitted (i.e. hand-written).
         if (client.clientInitialization.initializedBy === tcgc.InitializedByFlags.CustomizeCode || client.clientInitialization.initializedBy & tcgc.InitializedByFlags.Individually) {
@@ -1461,7 +1466,10 @@ export class Adapter {
                                 const endpointName = hasClientNameDecorator(templateArg.decorators) ? utils.snakeCaseName(templateArg.name) : 'endpoint';
                                 const adaptedParam = new rust.ClientEndpointParameter(endpointName);
                                 adaptedParam.docs = this.adaptDocs(param.summary, param.doc);
-                                ctorParams.push(adaptedParam);
+                                // for ARM, the endpoint is derived from cloud config at runtime; don't expose it as a ctor param
+                                if (this.crate.type !== 'azure-arm') {
+                                    ctorParams.push(adaptedParam);
+                                }
                                 const endpointField = new rust.StructField(endpointName, 'pubCrate', new rust.Url(this.crate));
                                 rustClient.endpoint = endpointField;
                                 rustClient.fields.push(endpointField);
@@ -1480,9 +1488,9 @@ export class Adapter {
                             }
                             const clientParam = this.adaptClientParameter(templateArg, rustClient.constructable);
                             if (clientParam.kind !== 'clientSupplementalEndpoint') {
-                                throw new AdapterError('InternalError', `unexpected client parameter kind ${clientParam.kind}`, (_a = templateArg.__raw) === null || _a === void 0 ? void 0 : _a.node);
+                                throw new AdapterError('InternalError', `unexpected client parameter kind ${clientParam.kind}`, (_b = templateArg.__raw) === null || _b === void 0 ? void 0 : _b.node);
                             }
-                            (_b = rustClient.constructable.endpoint) === null || _b === void 0 ? void 0 : _b.parameters.push(clientParam);
+                            (_c = rustClient.constructable.endpoint) === null || _c === void 0 ? void 0 : _c.parameters.push(clientParam);
                             ctorParams.push(clientParam);
                         }
                         break;
@@ -1496,7 +1504,7 @@ export class Adapter {
                                 continue;
                             }
                             else {
-                                throw new AdapterError('UnsupportedTsp', 'found optional apiVersion parameter with no default value', (_c = param.__raw) === null || _c === void 0 ? void 0 : _c.node);
+                                throw new AdapterError('UnsupportedTsp', 'found optional apiVersion parameter with no default value', (_d = param.__raw) === null || _d === void 0 ? void 0 : _d.node);
                             }
                         }
                         const clientParam = this.adaptClientParameter(param, rustClient.constructable);
@@ -1506,7 +1514,7 @@ export class Adapter {
                     }
                 }
             }
-            if (authType === AuthTypes.Default || (authType & AuthTypes.NoAuth) === AuthTypes.NoAuth) {
+            if (authType === AuthTypes.Default || (authType & AuthTypes.NoAuth) !== 0) {
                 const ctorWithNoCredential = new rust.Constructor('with_no_credential');
                 ctorWithNoCredential.docs.summary = `Creates a new ${rustClient.name} requiring no authentication.`;
                 rustClient.constructable.constructors.push(ctorWithNoCredential);
@@ -1549,7 +1557,7 @@ export class Adapter {
                         cur = cur.parent;
                     }
                     if (!constructable || !cur) {
-                        throw new AdapterError('InternalError', `didn't find constructable client for apiVersion in client ${rustClient.name}`, (_d = prop.__raw) === null || _d === void 0 ? void 0 : _d.node);
+                        throw new AdapterError('InternalError', `didn't find constructable client for apiVersion in client ${rustClient.name}`, (_e = prop.__raw) === null || _e === void 0 ? void 0 : _e.node);
                     }
                     rustClient.fields.push(new rust.StructField(utils.snakeCaseName(prop.name), 'pubCrate', this.getStringType()));
                     // we use the client name as a prefix to disambiguate the params in the parent
@@ -1569,7 +1577,7 @@ export class Adapter {
         else {
             throw new AdapterError('InternalError', `uninstantiatable client ${client.name} has no parent`);
         }
-        for (const child of (_e = client.children) !== null && _e !== void 0 ? _e : []) {
+        for (const child of (_f = client.children) !== null && _f !== void 0 ? _f : []) {
             const subClient = this.recursiveAdaptClient(child, rustClient);
             this.adaptClientAccessor(client, child, rustClient, subClient);
         }
@@ -1581,7 +1589,7 @@ export class Adapter {
                     code: 'LroPagingNotSupported',
                     severity: 'warning',
                     message: `skip emitting Paging LRO ${method.name}`,
-                    target: (_g = (_f = method.__raw) === null || _f === void 0 ? void 0 : _f.node) !== null && _g !== void 0 ? _g : tsp.NoTarget,
+                    target: (_h = (_g = method.__raw) === null || _g === void 0 ? void 0 : _g.node) !== null && _h !== void 0 ? _h : tsp.NoTarget,
                 });
                 continue;
             }
@@ -1604,11 +1612,14 @@ export class Adapter {
             throw new AdapterError('InternalError', `no flows defined for credential type ${cred.type}`, cred.model);
         }
         const scopes = new Array();
-        for (const scope of cred.flows[0].scopes) {
-            scopes.push(scope.value);
-        }
-        if (scopes.length === 0) {
-            throw new AdapterError('InternalError', 'scopes must contain at least one entry', cred.model);
+        // for ARM, scopes are derived from cloud config at runtime; ignore TypeSpec-defined scopes
+        if (this.crate.type !== 'azure-arm') {
+            for (const scope of cred.flows[0].scopes) {
+                scopes.push(scope.value);
+            }
+            if (scopes.length === 0) {
+                throw new AdapterError('InternalError', 'scopes must contain at least one entry', cred.model);
+            }
         }
         const ctorTokenCredential = new rust.Constructor('new');
         const tokenCredParam = new rust.ClientCredentialParameter('credential', new rust.Arc(new rust.TokenCredential(this.crate, scopes)));
@@ -1694,23 +1705,37 @@ export class Adapter {
      * @param rustClient the client to which the method belongs
      */
     adaptMethod(method, rustClient) {
-        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q, _r, _s, _t, _u, _v, _w;
+        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q, _r, _s, _t, _u, _v, _w, _x, _y;
         let srcMethodName = method.name;
-        if (method.kind === 'paging' && !srcMethodName.match(/^list/i)) {
-            const chunks = utils.deconstruct(srcMethodName);
-            if (chunks[0] === 'get') {
-                chunks[0] = 'list';
+        // NOTE: if the method has the @clientName decorator applied then skip fixing up the name
+        if (!hasClientNameDecorator(method.decorators)) {
+            if (method.kind === 'paging' && !srcMethodName.match(/^list/i)) {
+                const chunks = utils.deconstruct(srcMethodName);
+                if (chunks[0] === 'get') {
+                    chunks[0] = 'list';
+                }
+                else {
+                    chunks.unshift('list');
+                }
+                srcMethodName = utils.camelCase(chunks);
+                this.ctx.program.reportDiagnostic({
+                    code: 'PagingMethodRename',
+                    severity: 'warning',
+                    message: `renamed paging method from ${method.name} to ${srcMethodName}`,
+                    target: (_b = (_a = method.__raw) === null || _a === void 0 ? void 0 : _a.node) !== null && _b !== void 0 ? _b : tsp.NoTarget,
+                });
+            }
+            else if ((method.kind === 'lro' || method.kind === 'lropaging') && !srcMethodName.match(/^begin/i)) {
+                const chunks = utils.deconstruct(srcMethodName);
+                chunks.unshift('begin');
+                srcMethodName = utils.camelCase(chunks);
+                this.ctx.program.reportDiagnostic({
+                    code: 'PollingMethodRename',
+                    severity: 'warning',
+                    message: `renamed polling method from ${method.name} to ${srcMethodName}`,
+                    target: (_d = (_c = method.__raw) === null || _c === void 0 ? void 0 : _c.node) !== null && _d !== void 0 ? _d : tsp.NoTarget,
+                });
             }
-            else {
-                chunks.unshift('list');
-            }
-            srcMethodName = utils.camelCase(chunks);
-            this.ctx.program.reportDiagnostic({
-                code: 'PagingMethodRename',
-                severity: 'warning',
-                message: `renamed paging method from ${method.name} to ${srcMethodName}`,
-                target: (_b = (_a = method.__raw) === null || _a === void 0 ? void 0 : _a.node) !== null && _b !== void 0 ? _b : tsp.NoTarget,
-            });
         }
         const languageIndependentName = method.crossLanguageDefinitionId;
         const methodName = naming.getEscapedReservedName(utils.snakeCaseName(srcMethodName), 'fn');
@@ -1719,7 +1744,7 @@ export class Adapter {
             // if the method was renamed then ensure it doesn't collide
             for (const existingMethod of rustClient.methods) {
                 if (existingMethod.name === methodName) {
-                    throw new AdapterError('NameCollision', `renamed method ${srcMethodName} collides with an existing method`, (_c = method.__raw) === null || _c === void 0 ? void 0 : _c.node);
+                    throw new AdapterError('NameCollision', `renamed method ${srcMethodName} collides with an existing method`, (_e = method.__raw) === null || _e === void 0 ? void 0 : _e.node);
                 }
             }
         }
@@ -1773,20 +1798,20 @@ export class Adapter {
                                 lroFinalResultStrategy = new rust.LroFinalResultStrategyHeader('operation-location');
                                 break;
                             case FinalStateValue.customLink:
-                                if (((_d = method.lroMetadata.statusMonitorStep) === null || _d === void 0 ? void 0 : _d.kind) === "nextOperationLink") {
+                                if (((_f = method.lroMetadata.statusMonitorStep) === null || _f === void 0 ? void 0 : _f.kind) === "nextOperationLink") {
                                     const customHeaderName = method.lroMetadata.statusMonitorStep.target.property.name;
                                     if (customHeaderName.trim() === '') {
-                                        throw new AdapterError('UnsupportedTsp', `lroMetadata.finalStateVia === customLink && customHeaderName === "${customHeaderName}"`, (_e = method.__raw) === null || _e === void 0 ? void 0 : _e.node);
+                                        throw new AdapterError('UnsupportedTsp', `lroMetadata.finalStateVia === customLink && customHeaderName === "${customHeaderName}"`, (_g = method.__raw) === null || _g === void 0 ? void 0 : _g.node);
                                     }
                                     lroFinalResultStrategy = new rust.LroFinalResultStrategyHeader(customHeaderName);
                                 }
                                 else {
-                                    throw new AdapterError('UnsupportedTsp', `lroMetadata.finalStateVia === customLink && lroMetadata.statusMonitorStep?.kind === "${(_f = method.lroMetadata.statusMonitorStep) === null || _f === void 0 ? void 0 : _f.kind}"`, (_g = method.__raw) === null || _g === void 0 ? void 0 : _g.node);
+                                    throw new AdapterError('UnsupportedTsp', `lroMetadata.finalStateVia === customLink && lroMetadata.statusMonitorStep?.kind === "${(_h = method.lroMetadata.statusMonitorStep) === null || _h === void 0 ? void 0 : _h.kind}"`, (_j = method.__raw) === null || _j === void 0 ? void 0 : _j.node);
                                 }
                                 break;
                             default:
                                 /* eslint-disable-next-line @typescript-eslint/restrict-template-expressions */
-                                throw new AdapterError('UnsupportedTsp', `lroMetadata.finalStateVia ${method.lroMetadata.finalStateVia} NYI`, (_h = method.__raw) === null || _h === void 0 ? void 0 : _h.node);
+                                throw new AdapterError('UnsupportedTsp', `lroMetadata.finalStateVia ${method.lroMetadata.finalStateVia} NYI`, (_k = method.__raw) === null || _k === void 0 ? void 0 : _k.node);
                         }
                         lroFinalResultStrategy.propertyName = method.lroMetadata.finalResultPath;
                     }
@@ -1794,7 +1819,7 @@ export class Adapter {
                 }
                 break;
             default:
-                throw new AdapterError('UnsupportedTsp', `method kind ${method.kind} NYI`, (_j = method.__raw) === null || _j === void 0 ? void 0 : _j.node);
+                throw new AdapterError('UnsupportedTsp', `method kind ${method.kind} NYI`, (_l = method.__raw) === null || _l === void 0 ? void 0 : _l.node);
         }
         rustMethod.docs = this.adaptDocs(method.summary, method.doc);
         rustClient.methods.push(rustMethod);
@@ -1841,7 +1866,7 @@ export class Adapter {
                 else {
                     fieldType = this.getOptionType(adaptedParam.type);
                 }
-                const optionsField = new rust.StructField(adaptedParam.name, pub, fieldType);
+                const optionsField = new rust.StructField(adaptedParam.name, adaptAccessFlags(methodParam.access), fieldType);
                 optionsField.docs = adaptedParam.docs;
                 rustMethod.options.type.type.fields.push(optionsField);
             }
@@ -1915,7 +1940,7 @@ export class Adapter {
                     if (!fieldOptional) {
                         if (!paramGroup) {
                             if (param.type.kind !== 'model') {
-                                throw new AdapterError('InternalError', `expected model type for parameter group but got ${param.type.kind}`, (_k = param.__raw) === null || _k === void 0 ? void 0 : _k.node);
+                                throw new AdapterError('InternalError', `expected model type for parameter group but got ${param.type.kind}`, (_m = param.__raw) === null || _m === void 0 ? void 0 : _m.node);
                             }
                             const groupName = utils.capitalize(param.type.name).replace(/\W/g, '');
                             const paramName = naming.getEscapedReservedName(utils.snakeCaseName(param.name), 'param', reservedParams);
@@ -1960,7 +1985,7 @@ export class Adapter {
                 }
             }
             else {
-                throw new AdapterError('InternalError', `didn't find operation parameter for method ${method.name} parameter ${param.name}`, (_l = param.__raw) === null || _l === void 0 ? void 0 : _l.node);
+                throw new AdapterError('InternalError', `didn't find operation parameter for method ${method.name} parameter ${param.name}`, (_o = param.__raw) === null || _o === void 0 ? void 0 : _o.node);
             }
         }
         // client params aren't included in method.parameters so
@@ -2043,16 +2068,16 @@ export class Adapter {
         const responseFormat = getResponseFormat();
         if (method.kind === 'paging') {
             if (responseFormat !== 'JsonFormat' && responseFormat !== 'XmlFormat') {
-                throw new AdapterError('InternalError', `paged method ${method.name} unexpected response format ${responseFormat}`, (_m = method.__raw) === null || _m === void 0 ? void 0 : _m.node);
+                throw new AdapterError('InternalError', `paged method ${method.name} unexpected response format ${responseFormat}`, (_p = method.__raw) === null || _p === void 0 ? void 0 : _p.node);
             }
             // for paged methods, tcgc models method.response.type as an Array<T>.
             // however, we want the synthesized paged response envelope type instead.
             const synthesizedType = method.operation.responses[0].type;
             if (!synthesizedType) {
-                throw new AdapterError('InternalError', `paged method ${method.name} has no synthesized response type`, (_o = method.__raw) === null || _o === void 0 ? void 0 : _o.node);
+                throw new AdapterError('InternalError', `paged method ${method.name} has no synthesized response type`, (_q = method.__raw) === null || _q === void 0 ? void 0 : _q.node);
             }
             else if (synthesizedType.kind !== 'model') {
-                throw new AdapterError('UnsupportedTsp', `paged method ${method.name} synthesized response type has unexpected kind ${synthesizedType.kind}`, (_p = method.__raw) === null || _p === void 0 ? void 0 : _p.node);
+                throw new AdapterError('UnsupportedTsp', `paged method ${method.name} synthesized response type has unexpected kind ${synthesizedType.kind}`, (_r = method.__raw) === null || _r === void 0 ? void 0 : _r.node);
             }
             const synthesizedModel = this.getModel(synthesizedType, new Array());
             const modelNs = this.adaptNamespace(synthesizedType.namespace);
@@ -2061,7 +2086,7 @@ export class Adapter {
             }
             // for the pager response type, remove the Option<T> around the Vec<T> for the page items
             if (!method.pagingMetadata.pageItemsSegments) {
-                throw new AdapterError('InternalError', `paged method ${method.name} has no pageItemsSegments`, (_q = method.__raw) === null || _q === void 0 ? void 0 : _q.node);
+                throw new AdapterError('InternalError', `paged method ${method.name} has no pageItemsSegments`, (_s = method.__raw) === null || _s === void 0 ? void 0 : _s.node);
             }
             // unwrap all of the segments for the paged response
             let unwrappedCount = 0;
@@ -2072,13 +2097,13 @@ export class Adapter {
                 switch (responseFormat) {
                     case 'JsonFormat':
                         if (segment.kind !== 'property' || !segment.serializationOptions.json) {
-                            throw new AdapterError('InternalError', `paged method ${method.name} is missing JSON serialization data`, (_r = method.__raw) === null || _r === void 0 ? void 0 : _r.node);
+                            throw new AdapterError('InternalError', `paged method ${method.name} is missing JSON serialization data`, (_t = method.__raw) === null || _t === void 0 ? void 0 : _t.node);
                         }
                         serde = segment.serializationOptions.json.name;
                         break;
                     case 'XmlFormat':
                         if (segment.kind !== 'property' || !segment.serializationOptions.xml) {
-                            throw new AdapterError('InternalError', `paged method ${method.name} is missing XML serialization data`, (_s = method.__raw) === null || _s === void 0 ? void 0 : _s.node);
+                            throw new AdapterError('InternalError', `paged method ${method.name} is missing XML serialization data`, (_u = method.__raw) === null || _u === void 0 ? void 0 : _u.node);
                         }
                         serde = segment.serializationOptions.xml.name;
                         break;
@@ -2091,7 +2116,7 @@ export class Adapter {
                     if (field.serde === serde) {
                         // check if this has already been unwrapped (e.g. type is shared across operations)
                         if (field.type.kind === 'option') {
-                            field.type = (field.type).type;
+                            field.type = field.type.type;
                             field.flags |= rust.ModelFieldFlags.PageItems;
                         }
                         // move to the next segment
@@ -2104,7 +2129,7 @@ export class Adapter {
                 }
             }
             if (unwrappedCount !== method.pagingMetadata.pageItemsSegments.length) {
-                throw new AdapterError('InternalError', `failed to unwrap paged items for method ${method.name}`, (_t = method.__raw) === null || _t === void 0 ? void 0 : _t.node);
+                throw new AdapterError('InternalError', `failed to unwrap paged items for method ${method.name}`, (_v = method.__raw) === null || _v === void 0 ? void 0 : _v.node);
             }
             this.crate.addDependency(new rust.CrateDependency('async-trait'));
             // default to nextLink. will update it as required when we have that info
@@ -2137,7 +2162,7 @@ export class Adapter {
             const statusModel = this.getModel(method.lroMetadata.pollingInfo.responseModel, undefined, `${rustClient.name}${utils.pascalCase(rustMethod.name, false)}OperationStatus`);
             const statusType = this.typeToWireType(statusModel);
             if (statusType.kind !== 'model') {
-                throw new AdapterError('InternalError', `status type for an LRO method '${method.name}' is not a model`, (_u = method.__raw) === null || _u === void 0 ? void 0 : _u.node);
+                throw new AdapterError('InternalError', `status type for an LRO method '${method.name}' is not a model`, (_w = method.__raw) === null || _w === void 0 ? void 0 : _w.node);
             }
             // the adapted type likely comes from core which means
             // it will be in the root namespace.  since we emit these
@@ -2194,10 +2219,10 @@ export class Adapter {
             // can't do this until the method has been completely adapted
             const pageableMethod = rustMethod;
             pageableMethod.strategy = this.adaptPageableMethodStrategy(method, paramsMap, responseHeadersMap);
-            if (((_v = pageableMethod.strategy) === null || _v === void 0 ? void 0 : _v.kind) === 'nextLink') {
+            if (((_x = pageableMethod.strategy) === null || _x === void 0 ? void 0 : _x.kind) === 'nextLink') {
                 pageableMethod.strategy.reinjectedParams = this.adaptPageableMethodReinjectionParams(method, paramsMap);
             }
-            else if (((_w = pageableMethod.strategy) === null || _w === void 0 ? void 0 : _w.kind) === 'continuationToken') {
+            else if (((_y = pageableMethod.strategy) === null || _y === void 0 ? void 0 : _y.kind) === 'continuationToken') {
                 // set the continuation type to token on the Pager and the PagerOptions field in the method options
                 pageableMethod.returns.type.continuation = 'token';
                 for (const field of pageableMethod.options.type.type.fields) {
@@ -2546,6 +2571,7 @@ export class Adapter {
             case 'path':
                 {
                     paramType = this.typeToWireType(paramType);
+                    // eslint-disable-next-line no-useless-assignment
                     let style = 'simple';
                     const tspStyleString = opParam.style;
                     if (!['simple', 'path', 'label', 'matrix'].includes(tspStyleString)) {
@@ -2820,6 +2846,8 @@ function recursiveKeyName(root, type) {
             return `${root}-${type.kind}-${type.name}`;
         case 'enumValue':
             return `${root}-${type.type.name}-${type.name}`;
+        case 'external':
+            return `${root}-${type.path}::${type.name}`;
         case 'hashmap':
             return recursiveKeyName(`${root}-${type.kind}`, type.type);
         case 'offsetDateTime':
@@ -2941,7 +2969,8 @@ export function formatVisibility(visibility) {
         combined |= v;
     }
     // if all lifecycle flags are set, there's no restriction
-    if ((combined & http.Visibility.All) === http.Visibility.All) {
+    const allFlagsSet = http.Visibility.All;
+    if ((combined & http.Visibility.All) === allFlagsSet) {
         return undefined;
     }
     // flags are checked in sorted order: Create, Delete, Query, Read, Update