@fern-api/php-dynamic-snippets 0.0.14 → 1.25.1

package/dist/index.d.cts

@@ -0,0 +1,164 @@
+import { AbstractDynamicSnippetsGeneratorContext, FernGeneratorExec, Options, AbstractAstNode, AbstractDynamicSnippetsGenerator } from '@fern-api/browser-compatible-base-generator';
+import { FernIr } from '@fern-api/dynamic-ir-sdk';
+import { php, BasePhpCustomConfigSchema } from '@fern-api/php-codegen';
+
+declare namespace DynamicTypeLiteralMapper {
+    interface Args {
+        typeReference: FernIr.dynamic.TypeReference;
+        value: unknown;
+        as?: ConvertedAs;
+    }
+    type ConvertedAs = "key";
+}
+declare class DynamicTypeLiteralMapper {
+    private context;
+    constructor({ context }: {
+        context: DynamicSnippetsGeneratorContext;
+    });
+    convert(args: DynamicTypeLiteralMapper.Args): php.TypeLiteral;
+    private convertLiteral;
+    private convertList;
+    private convertMap;
+    private convertNamed;
+    private convertDiscriminatedUnion;
+    private convertDiscriminatedUnionProperties;
+    private convertDiscriminatedUnionVariantArgs;
+    private getBaseFields;
+    private convertObject;
+    private convertEnum;
+    private getEnumValueName;
+    private convertUndiscriminatedUnion;
+    private findMatchingUndiscriminatedUnionType;
+    private convertUnknown;
+    private convertPrimitive;
+    private getValueAsNumber;
+    private getValueAsBoolean;
+}
+
+interface FilePropertyInfo {
+    fileFields: php.ConstructorField[];
+    bodyPropertyFields: php.ConstructorField[];
+}
+declare class FilePropertyMapper {
+    private context;
+    constructor({ context }: {
+        context: DynamicSnippetsGeneratorContext;
+    });
+    getFilePropertyInfo({ body, value }: {
+        body: FernIr.dynamic.FileUploadRequestBody;
+        value: unknown;
+    }): FilePropertyInfo;
+    private getSingleFileProperty;
+    private getArrayFileProperty;
+    private getBodyProperty;
+}
+
+declare class DynamicSnippetsGeneratorContext extends AbstractDynamicSnippetsGeneratorContext {
+    ir: FernIr.dynamic.DynamicIntermediateRepresentation;
+    customConfig: BasePhpCustomConfigSchema | undefined;
+    dynamicTypeLiteralMapper: DynamicTypeLiteralMapper;
+    filePropertyMapper: FilePropertyMapper;
+    rootNamespace: string;
+    constructor({ ir, config }: {
+        ir: FernIr.dynamic.DynamicIntermediateRepresentation;
+        config: FernGeneratorExec.GeneratorConfig;
+    });
+    clone(): DynamicSnippetsGeneratorContext;
+    getParameterName(name: FernIr.Name): string;
+    getPropertyName(name: FernIr.Name): string;
+    getMethodName(name: FernIr.Name): string;
+    getClassName(name: FernIr.Name): string;
+    getRootClientClassName(): string;
+    getEnvironmentsClassReference(): php.ClassReference;
+    getRequestNamespace(fernFilepath: FernIr.dynamic.FernFilepath): string;
+    getTypesNamespace(fernFilepath: FernIr.dynamic.FernFilepath): string;
+    getNamespace(fernFilepath: FernIr.dynamic.FernFilepath, suffix?: string): string;
+    getEnvironmentClassAccessFromID(environmentID: string): php.AstNode | undefined;
+    getEnvironmentClassReference(name: FernIr.Name): php.ClassReference;
+    private prependUnderscoreIfNeeded;
+    private getComputedClientName;
+    private getOrganizationPascalCase;
+}
+
+declare class EndpointSnippetGenerator {
+    private context;
+    constructor({ context }: {
+        context: DynamicSnippetsGeneratorContext;
+    });
+    generateSnippet({ endpoint, request }: {
+        endpoint: FernIr.dynamic.Endpoint;
+        request: FernIr.dynamic.EndpointSnippetRequest;
+    }): Promise<string>;
+    generateSnippetSync({ endpoint, request }: {
+        endpoint: FernIr.dynamic.Endpoint;
+        request: FernIr.dynamic.EndpointSnippetRequest;
+    }): string;
+    generateSnippetAst({ endpoint, request, options }: {
+        endpoint: FernIr.dynamic.Endpoint;
+        request: FernIr.dynamic.EndpointSnippetRequest;
+        options?: Options;
+    }): Promise<AbstractAstNode>;
+    buildCodeBlock({ endpoint, snippet }: {
+        endpoint: FernIr.dynamic.Endpoint;
+        snippet: FernIr.dynamic.EndpointSnippetRequest;
+    }): php.AstNode;
+    buildCodeBlockWithoutClient({ endpoint, snippet }: {
+        endpoint: FernIr.dynamic.Endpoint;
+        snippet: FernIr.dynamic.EndpointSnippetRequest;
+    }): php.AstNode;
+    private constructClient;
+    private callMethod;
+    private callMethodOnExistingClient;
+    /**
+     * Builds request options from snippet headers for per-request options.
+     * This is used when generating snippets for existing clients (e.g., wire tests)
+     * where headers should be passed as method call options rather than client constructor options.
+     * Only includes headers that are NOT already mapped to the request directly (i.e., not defined in the IR).
+     */
+    private getRequestOptions;
+    private getConstructorArgs;
+    private getConstructorAuthArgs;
+    private addError;
+    private addWarning;
+    private getConstructorBasicAuthArgs;
+    private getConstructorEnvironmentArg;
+    private getDefaultEnvironmentName;
+    private resolveMultiEnvironmentName;
+    private getBaseUrlPropertyName;
+    private getConstructorBaseUrlArgs;
+    private getBaseUrlArg;
+    private getConstructorBearerAuthArgs;
+    private getConstructorHeaderAuthArgs;
+    private getConstructorOAuthArgs;
+    private getConstructorInferredAuthArgs;
+    private getConstructorHeaderArgs;
+    private getConstructorHeaderArg;
+    private getMethodArgs;
+    private getMethodArgsForBodyRequest;
+    private getBodyRequestArg;
+    private getBytesBodyRequestArg;
+    private getMethodArgsForInlinedRequest;
+    private getFilePropertyInfo;
+    private getInlinedRequestArg;
+    private getInlinedRequestBodyConstructorFields;
+    private getFileUploadRequestBodyConstructorFields;
+    private getReferencedRequestBodyPropertyConstructorField;
+    private getReferencedRequestBodyPropertyTypeLiteral;
+    private getInlinedRequestBodyPropertyConstructorFields;
+    private getPathParameters;
+    private getMethod;
+    private getRootClientClassInstantiation;
+}
+
+declare class DynamicSnippetsGenerator extends AbstractDynamicSnippetsGenerator<DynamicSnippetsGeneratorContext, EndpointSnippetGenerator> {
+    constructor({ ir, config }: {
+        ir: FernIr.dynamic.DynamicIntermediateRepresentation;
+        config: FernGeneratorExec.GeneratorConfig;
+    });
+    generate(request: FernIr.dynamic.EndpointSnippetRequest): Promise<FernIr.dynamic.EndpointSnippetResponse>;
+    generateSync(request: FernIr.dynamic.EndpointSnippetRequest): FernIr.dynamic.EndpointSnippetResponse;
+    generateSnippetAst(request: FernIr.dynamic.EndpointSnippetRequest, options?: Options): Promise<AbstractAstNode>;
+    protected createSnippetGenerator(context: DynamicSnippetsGeneratorContext): EndpointSnippetGenerator;
+}
+
+export { DynamicSnippetsGenerator, EndpointSnippetGenerator };

package/dist/index.d.ts

@@ -0,0 +1,164 @@
+import { AbstractDynamicSnippetsGeneratorContext, FernGeneratorExec, Options, AbstractAstNode, AbstractDynamicSnippetsGenerator } from '@fern-api/browser-compatible-base-generator';
+import { FernIr } from '@fern-api/dynamic-ir-sdk';
+import { php, BasePhpCustomConfigSchema } from '@fern-api/php-codegen';
+
+declare namespace DynamicTypeLiteralMapper {
+    interface Args {
+        typeReference: FernIr.dynamic.TypeReference;
+        value: unknown;
+        as?: ConvertedAs;
+    }
+    type ConvertedAs = "key";
+}
+declare class DynamicTypeLiteralMapper {
+    private context;
+    constructor({ context }: {
+        context: DynamicSnippetsGeneratorContext;
+    });
+    convert(args: DynamicTypeLiteralMapper.Args): php.TypeLiteral;
+    private convertLiteral;
+    private convertList;
+    private convertMap;
+    private convertNamed;
+    private convertDiscriminatedUnion;
+    private convertDiscriminatedUnionProperties;
+    private convertDiscriminatedUnionVariantArgs;
+    private getBaseFields;
+    private convertObject;
+    private convertEnum;
+    private getEnumValueName;
+    private convertUndiscriminatedUnion;
+    private findMatchingUndiscriminatedUnionType;
+    private convertUnknown;
+    private convertPrimitive;
+    private getValueAsNumber;
+    private getValueAsBoolean;
+}
+
+interface FilePropertyInfo {
+    fileFields: php.ConstructorField[];
+    bodyPropertyFields: php.ConstructorField[];
+}
+declare class FilePropertyMapper {
+    private context;
+    constructor({ context }: {
+        context: DynamicSnippetsGeneratorContext;
+    });
+    getFilePropertyInfo({ body, value }: {
+        body: FernIr.dynamic.FileUploadRequestBody;
+        value: unknown;
+    }): FilePropertyInfo;
+    private getSingleFileProperty;
+    private getArrayFileProperty;
+    private getBodyProperty;
+}
+
+declare class DynamicSnippetsGeneratorContext extends AbstractDynamicSnippetsGeneratorContext {
+    ir: FernIr.dynamic.DynamicIntermediateRepresentation;
+    customConfig: BasePhpCustomConfigSchema | undefined;
+    dynamicTypeLiteralMapper: DynamicTypeLiteralMapper;
+    filePropertyMapper: FilePropertyMapper;
+    rootNamespace: string;
+    constructor({ ir, config }: {
+        ir: FernIr.dynamic.DynamicIntermediateRepresentation;
+        config: FernGeneratorExec.GeneratorConfig;
+    });
+    clone(): DynamicSnippetsGeneratorContext;
+    getParameterName(name: FernIr.Name): string;
+    getPropertyName(name: FernIr.Name): string;
+    getMethodName(name: FernIr.Name): string;
+    getClassName(name: FernIr.Name): string;
+    getRootClientClassName(): string;
+    getEnvironmentsClassReference(): php.ClassReference;
+    getRequestNamespace(fernFilepath: FernIr.dynamic.FernFilepath): string;
+    getTypesNamespace(fernFilepath: FernIr.dynamic.FernFilepath): string;
+    getNamespace(fernFilepath: FernIr.dynamic.FernFilepath, suffix?: string): string;
+    getEnvironmentClassAccessFromID(environmentID: string): php.AstNode | undefined;
+    getEnvironmentClassReference(name: FernIr.Name): php.ClassReference;
+    private prependUnderscoreIfNeeded;
+    private getComputedClientName;
+    private getOrganizationPascalCase;
+}
+
+declare class EndpointSnippetGenerator {
+    private context;
+    constructor({ context }: {
+        context: DynamicSnippetsGeneratorContext;
+    });
+    generateSnippet({ endpoint, request }: {
+        endpoint: FernIr.dynamic.Endpoint;
+        request: FernIr.dynamic.EndpointSnippetRequest;
+    }): Promise<string>;
+    generateSnippetSync({ endpoint, request }: {
+        endpoint: FernIr.dynamic.Endpoint;
+        request: FernIr.dynamic.EndpointSnippetRequest;
+    }): string;
+    generateSnippetAst({ endpoint, request, options }: {
+        endpoint: FernIr.dynamic.Endpoint;
+        request: FernIr.dynamic.EndpointSnippetRequest;
+        options?: Options;
+    }): Promise<AbstractAstNode>;
+    buildCodeBlock({ endpoint, snippet }: {
+        endpoint: FernIr.dynamic.Endpoint;
+        snippet: FernIr.dynamic.EndpointSnippetRequest;
+    }): php.AstNode;
+    buildCodeBlockWithoutClient({ endpoint, snippet }: {
+        endpoint: FernIr.dynamic.Endpoint;
+        snippet: FernIr.dynamic.EndpointSnippetRequest;
+    }): php.AstNode;
+    private constructClient;
+    private callMethod;
+    private callMethodOnExistingClient;
+    /**
+     * Builds request options from snippet headers for per-request options.
+     * This is used when generating snippets for existing clients (e.g., wire tests)
+     * where headers should be passed as method call options rather than client constructor options.
+     * Only includes headers that are NOT already mapped to the request directly (i.e., not defined in the IR).
+     */
+    private getRequestOptions;
+    private getConstructorArgs;
+    private getConstructorAuthArgs;
+    private addError;
+    private addWarning;
+    private getConstructorBasicAuthArgs;
+    private getConstructorEnvironmentArg;
+    private getDefaultEnvironmentName;
+    private resolveMultiEnvironmentName;
+    private getBaseUrlPropertyName;
+    private getConstructorBaseUrlArgs;
+    private getBaseUrlArg;
+    private getConstructorBearerAuthArgs;
+    private getConstructorHeaderAuthArgs;
+    private getConstructorOAuthArgs;
+    private getConstructorInferredAuthArgs;
+    private getConstructorHeaderArgs;
+    private getConstructorHeaderArg;
+    private getMethodArgs;
+    private getMethodArgsForBodyRequest;
+    private getBodyRequestArg;
+    private getBytesBodyRequestArg;
+    private getMethodArgsForInlinedRequest;
+    private getFilePropertyInfo;
+    private getInlinedRequestArg;
+    private getInlinedRequestBodyConstructorFields;
+    private getFileUploadRequestBodyConstructorFields;
+    private getReferencedRequestBodyPropertyConstructorField;
+    private getReferencedRequestBodyPropertyTypeLiteral;
+    private getInlinedRequestBodyPropertyConstructorFields;
+    private getPathParameters;
+    private getMethod;
+    private getRootClientClassInstantiation;
+}
+
+declare class DynamicSnippetsGenerator extends AbstractDynamicSnippetsGenerator<DynamicSnippetsGeneratorContext, EndpointSnippetGenerator> {
+    constructor({ ir, config }: {
+        ir: FernIr.dynamic.DynamicIntermediateRepresentation;
+        config: FernGeneratorExec.GeneratorConfig;
+    });
+    generate(request: FernIr.dynamic.EndpointSnippetRequest): Promise<FernIr.dynamic.EndpointSnippetResponse>;
+    generateSync(request: FernIr.dynamic.EndpointSnippetRequest): FernIr.dynamic.EndpointSnippetResponse;
+    generateSnippetAst(request: FernIr.dynamic.EndpointSnippetRequest, options?: Options): Promise<AbstractAstNode>;
+    protected createSnippetGenerator(context: DynamicSnippetsGeneratorContext): EndpointSnippetGenerator;
+}
+
+export { DynamicSnippetsGenerator, EndpointSnippetGenerator };