@cdktn/provider-generator 0.24.0-pre.87 → 0.24.0-pre.89

package/build/get/generator/models/provider-function-model.d.ts

@@ -0,0 +1,102 @@
+import { FunctionSignature } from "@cdktn/commons";
+/**
+ * A provider-defined function parameter (positional or the trailing
+ * variadic one), mapped to the jsii-safe TypeScript type used in the
+ * generated method signature.
+ */
+export interface ProviderFunctionParameterModel {
+    readonly terraformName: string;
+    readonly name: string;
+    readonly tsType: string;
+    /**
+     * The JSDoc type expression emitted inside the `@param {...}` braces.
+     * A pure type expression only - prose (Terraform list/set semantics,
+     * `cdktn.Token.nullValue()` guidance) belongs in `docstringNote`.
+     */
+    readonly docstringType: string;
+    /**
+     * Prose appended after the parameter name (and `description`, if any) in
+     * the emitted `@param` line - e.g. set-ordering semantics or how to pass
+     * an explicit Terraform `null`. Official JSDoc places only the type
+     * expression inside the braces, so this must never be folded into
+     * `docstringType`.
+     */
+    readonly docstringNote?: string;
+    readonly description?: string;
+    /**
+     * True when this (fixed, non-variadic) parameter is emitted as a
+     * jsii-optional TypeScript parameter (`name?: T`) - see the
+     * is_nullable/trailing-compatibility handling in `applyNullability`.
+     * Never set on the variadic parameter: an array parameter can't be `?`.
+     */
+    readonly optional?: boolean;
+}
+/**
+ * A single provider-defined function, mapped to a static method on the
+ * generated `<Provider>ProviderFunctions` class.
+ */
+export interface ProviderFunctionModel {
+    readonly terraformName: string;
+    readonly methodName: string;
+    readonly description?: string;
+    readonly summary?: string;
+    /**
+     * Terraform (>=1.8) deprecation message for the function, surfaced as an
+     * `@deprecated` JSDoc tag. OpenTofu never emits this field - see
+     * `FunctionSignature.deprecation_message`.
+     */
+    readonly deprecationMessage?: string;
+    readonly returnTsType: string;
+    /**
+     * The `@returns {...}` JSDoc type, describing the conceptual/Terraform
+     * shape of the return value - see `mapReturnType`. This deliberately can
+     * differ from `returnTsType` (e.g. a `bool` return is declared
+     * `cdktn.IResolvable` but documented as `boolean | IResolvable`), the same
+     * way a parameter's `docstringType` can differ from its `tsType`.
+     */
+    readonly returnDocstringType: string;
+    /**
+     * Prose appended after the `@returns {...}` braces (e.g. Terraform
+     * list/set semantics) - the return-side counterpart of a parameter's
+     * `docstringNote`.
+     */
+    readonly returnDocstringNote?: string;
+    /**
+     * Wraps the `cdktn.TerraformProviderFunction.invoke(...)` call expression
+     * into the method's `return` statement (e.g. wrapping it in
+     * `cdktn.Token.asString(...)`, or returning it unwrapped for `bool`).
+     */
+    readonly wrapReturn: (invokeExpression: string) => string;
+    readonly parameters: ProviderFunctionParameterModel[];
+    readonly variadicParameter?: ProviderFunctionParameterModel;
+}
+/**
+ * All provider-defined functions of a single provider, mapped to a single
+ * generated `providers/<provider>/provider-functions/index.ts` file.
+ */
+export interface ProviderFunctionsModel {
+    readonly providerName: string;
+    readonly className: string;
+    readonly functions: ProviderFunctionModel[];
+}
+/**
+ * Throws if the provider's own config schema declares an attribute whose
+ * generated property name (see `AttributeModel.name` /
+ * `escapeAttributeName`) is exactly "functions", while the provider also
+ * declares provider-defined functions. That combination would collide with
+ * the memoized `functions` getter `ResourceEmitter` emits on the provider
+ * class (see `resource-emitter.ts`'s `emitFunctionsGetter`) - one would
+ * silently shadow the other. Same loud-failure convention as
+ * `assertNoMethodNameCollisions`/`assertNoParameterNameCollisions` above:
+ * generation is aborted rather than silently picking a winner.
+ */
+export declare function assertNoFunctionsGetterCollision(providerName: string, attributeNames: string[]): void;
+/**
+ * Builds the model for a provider's `provider-functions/index.ts` file from
+ * its provider schema `functions` map. Returns `undefined` when the provider
+ * declares no functions - callers should skip emitting the file entirely.
+ */
+export declare function buildProviderFunctionsModel(providerName: string, functions: {
+    [name: string]: FunctionSignature;
+} | undefined): ProviderFunctionsModel | undefined;
+//# sourceMappingURL=provider-function-model.d.ts.map