fix: updates to typescript w/n the env command #6905
+483
−118
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,224 @@ | ||
| import type { NetlifyAPI } from 'netlify' | ||
|
|
||
| import { Context } from './types.d.ts' | ||
|
|
||
| type ApiContext = Context | 'branch' | ||
|
|
||
| // Define the structure for the 'updated_by' field | ||
| interface UpdatedBy { | ||
| // Add specific properties here if known | ||
| // For now, we'll keep it generic | ||
| id: string; | ||
| full_name: string; | ||
| email: string; | ||
| avatar_url: string; | ||
| } | ||
|
|
||
| export type Value = Pick<EnvVarValue, 'value' | 'context' | 'context_parameter'> | ||
| // Define the structure for each item in the array | ||
|
|
||
| interface EnvVarValue { | ||
| value: string, | ||
| context: ApiContext, | ||
| context_parameter?: string, | ||
| id?: string, | ||
| } | ||
|
|
||
| export interface EnvVar { | ||
| key: string; | ||
| scopes: Scope[]; | ||
| values: EnvVarValue[]; | ||
| is_secret?: boolean; | ||
| updated_at?: string; | ||
| updated_by?: UpdatedBy; | ||
| } | ||
|
|
||
| interface GetEnvParams { | ||
| accountId: string, | ||
| siteId?: string, | ||
| context?: Context, | ||
| scope?: EnvironmentVariableScope | ||
| } | ||
|
|
||
| interface DeleteEnvVarValueParams { | ||
| accountId: string, | ||
| key: string, | ||
| id?: string, | ||
| siteId?: string | ||
| } | ||
|
|
||
| interface SetEnvVarValueBody { | ||
| context: string, | ||
| value: string, | ||
| contextParameter?: string, | ||
| } | ||
|
|
||
| interface SetEnvVarValueParams { | ||
| accountId: string, | ||
| key: string, | ||
| siteId?: string, | ||
| body: SetEnvVarValueBody | ||
| } | ||
|
|
||
| interface UpdateEnvVarBody { | ||
| key: string, | ||
| scopes: string[], | ||
| values: EnvVar[] | ||
| is_secret: boolean | ||
| } | ||
|
|
||
| interface UpdateEnvVarParams { | ||
| accountId: string, | ||
| key: string, | ||
| siteId?: string | ||
| body: EnvVar | ||
| } | ||
|
|
||
| interface createEnvVarParams { | ||
| accountId: string, | ||
| key?: string, | ||
| siteId?: string, | ||
| body: EnvVar[] | ||
| } | ||
|
|
||
| // Top-Level Interface | ||
| interface SiteInfo { | ||
| id: string; | ||
| state: string; | ||
| plan: string; | ||
| name: string; | ||
| custom_domain: string | null; | ||
| domain_aliases: string[]; | ||
| branch_deploy_custom_domain: string | null; | ||
| deploy_preview_custom_domain: string | null; | ||
| password: string | null; | ||
| notification_email: string | null; | ||
| url: string; | ||
| ssl_url: string; | ||
| admin_url: string; | ||
| screenshot_url: string; | ||
| created_at: string; | ||
| updated_at: string; | ||
| user_id: string; | ||
| session_id: string; | ||
| ssl: boolean; | ||
| force_ssl: boolean | null; | ||
| managed_dns: boolean; | ||
| deploy_url: string; | ||
| published_deploy: PublishedDeploy; | ||
| account_id: string; | ||
| account_name: string; | ||
| account_slug: string; | ||
| git_provider?: string; | ||
| deploy_hook: string; | ||
| capabilities: Capabilities; | ||
| processing_settings: ProcessingSettings; | ||
| build_settings: BuildSettings; | ||
| id_domain: string; | ||
| default_hooks_data?: DefaultHooksData; | ||
| build_image: string; | ||
| prerender: string | null; | ||
| functions_region: string; | ||
| feature_flags: FeatureFlags; | ||
| } | ||
|
|
||
| // Published Deploy Interface | ||
| interface PublishedDeploy { | ||
| id: string; | ||
| site_id: string; | ||
| user_id: string; | ||
| build_id: string; | ||
| state: string; | ||
| name: string; | ||
| url: string; | ||
| ssl_url: string; | ||
| admin_url: string; | ||
| deploy_url: string; | ||
| deploy_ssl_url: string; | ||
| screenshot_url: string; | ||
| review_id: number | null; | ||
| draft: boolean; | ||
| required: string[]; | ||
| required_functions: string[]; | ||
| error_message: string; | ||
| branch: string; | ||
| commit_ref: string; | ||
| commit_url: string; | ||
| skipped: boolean | null; | ||
| created_at: string; | ||
| updated_at: string; | ||
| published_at: string; | ||
| title: string; | ||
| context: string; | ||
| locked: boolean | null; | ||
| review_url: string | null; | ||
| framework: string; | ||
| function_schedules: FunctionSchedule[] | []; | ||
| } | ||
|
|
||
| // Function Schedule Interface | ||
| interface FunctionSchedule { | ||
| name: string; | ||
| cron: string; | ||
| } | ||
|
|
||
| // Capabilities Interface | ||
| interface Capabilities { | ||
| [key: string]: Record<string, unknown>; | ||
| } | ||
|
|
||
| // Processing Settings Interface | ||
|
There was a problem hiding this comment. You don't need all these comments, they're all basically just saying the name of the interfaces are |
||
| interface ProcessingSettings { | ||
| html: HTMLProcessingSettings; | ||
| } | ||
|
|
||
| // HTML Processing Settings Interface | ||
| interface HTMLProcessingSettings { | ||
| pretty_urls: boolean; | ||
| } | ||
|
|
||
| // Build Settings Interface | ||
| interface BuildSettings { | ||
| id: number; | ||
| provider: string; | ||
| deploy_key_id: string; | ||
| repo_path: string; | ||
| repo_branch: string; | ||
| dir: string; | ||
| functions_dir: string; | ||
| cmd: string; | ||
| allowed_branches: string[]; | ||
| public_repo: boolean; | ||
| private_logs: boolean; | ||
| repo_url: string; | ||
| env: EnvVariables; | ||
| installation_id: number; | ||
| stop_builds: boolean; | ||
| } | ||
|
|
||
| // Environment Variables Interface | ||
| interface EnvVariables { | ||
| [key: string]: string; | ||
| } | ||
|
|
||
| // Default Hooks Data Interface | ||
| interface DefaultHooksData { | ||
| access_token: string; | ||
| } | ||
|
|
||
| interface GetSiteParams { | ||
| siteId?: string, | ||
| feature_flags?: string | ||
| site_id?: string | ||
| } | ||
|
|
||
| export interface ExtendedNetlifyAPI extends NetlifyAPI { | ||
| getEnvVar(params: GetEnvVarParams): Promise<EnvVar> | ||
| getEnvVars( params: GetEnvParams): Promise<EnvVar[]> | ||
| deleteEnvVarValue( params: DeleteEnvVarValueParams ): Promise<void> | ||
| setEnvVarValue( params: SetEnvVarValueParams): Promise<EnvVar> | ||
| deleteEnvVar(params: DeleteEnvVarValueParams): Promise<void> | ||
| updateEnvVar(params: UpdateEnvVarParams): Promise<EnvVar> | ||
| createEnvVars(params: createEnvVarParams): Promise<EnvVar[]> | ||
| getSite(params: GetSiteParams): Promise<SiteInfo> | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This has been updated