vercel-api-js 0.15.0 → 0.16.1

package/.turbo/turbo-build.log

@@ -1,5 +1,5 @@
 
-> vercel-api-js@0.15.0 build /home/runner/work/openapi-clients/openapi-clients/packages/vercel-api-js
+> vercel-api-js@0.16.1 build /home/runner/work/openapi-clients/openapi-clients/packages/vercel-api-js
 > rimraf dist && tsup
 
 CLI Building entry: src/index.ts
@@ -11,12 +11,12 @@
 CJS Build start
 ESM Build start
 ESM dist/index.mjs     26.59 KB
-ESM dist/index.mjs.map 596.65 KB
-ESM ⚡️ Build success in 107ms
+ESM dist/index.mjs.map 604.06 KB
+ESM ⚡️ Build success in 167ms
 CJS dist/index.js     27.58 KB
-CJS dist/index.js.map 596.88 KB
-CJS ⚡️ Build success in 148ms
+CJS dist/index.js.map 604.29 KB
+CJS ⚡️ Build success in 190ms
 DTS Build start
-DTS ⚡️ Build success in 6620ms
-DTS dist/index.d.ts  865.38 KB
-DTS dist/index.d.mts 865.38 KB
+DTS ⚡️ Build success in 10785ms
+DTS dist/index.d.ts  876.21 KB
+DTS dist/index.d.mts 876.21 KB

package/CHANGELOG.md

@@ -1,5 +1,22 @@
 # vercel-api-js
 
+## 0.16.1
+
+### Patch Changes
+
+- 5d3c268: Add 'observabilityEvent' to AuthUser type
+
+## 0.16.0
+
+### Minor Changes
+
+- bfcf8aa: Add support for microfrontends in the 'getDeployment' and 'createDeployment' endpoints
+- 1e5d876: Add observabilityConfiguration and observabilityData to various project endpoints
+
+### Patch Changes
+
+- 445b9fc: Add new 'v0-web' option to source field in deployment API
+
 ## 0.15.0
 
 ### Minor Changes

package/dist/index.d.mts

@@ -229,7 +229,7 @@ type AuthUser = {
     softBlock: {
         blockedAt: number;
         reason: 'BLOCKED_FOR_PLATFORM_ABUSE' | 'ENTERPRISE_TRIAL_ENDED' | 'FAIR_USE_LIMITS_EXCEEDED' | 'SUBSCRIPTION_CANCELED' | 'SUBSCRIPTION_EXPIRED' | 'UNPAID_INVOICE';
-        blockedDueToOverageType?: 'analyticsUsage' | 'artifacts' | 'bandwidth' | 'blobStores' | 'blobTotalAdvancedRequests' | 'blobTotalAvgSizeInBytes' | 'blobTotalGetResponseObjectSizeInBytes' | 'blobTotalSimpleRequests' | 'buildMinute' | 'dataCacheRead' | 'dataCacheRevalidation' | 'dataCacheWrite' | 'edgeConfigRead' | 'edgeConfigWrite' | 'edgeFunctionExecutionUnits' | 'edgeMiddlewareInvocations' | 'edgeRequest' | 'edgeRequestAdditionalCpuDuration' | 'fastDataTransfer' | 'fastOriginTransfer' | 'functionDuration' | 'functionInvocation' | 'logDrainsVolume' | 'monitoringMetric' | 'postgresComputeTime' | 'postgresDataStorage' | 'postgresDataTransfer' | 'postgresDatabase' | 'postgresWrittenData' | 'serverlessFunctionExecution' | 'sourceImages' | 'storageRedisTotalBandwidthInBytes' | 'storageRedisTotalCommands' | 'storageRedisTotalDailyAvgStorageInBytes' | 'storageRedisTotalDatabases' | 'wafOwaspExcessBytes' | 'wafOwaspRequests' | 'wafRateLimitRequest' | 'webAnalyticsEvent';
+        blockedDueToOverageType?: 'analyticsUsage' | 'artifacts' | 'bandwidth' | 'blobStores' | 'blobTotalAdvancedRequests' | 'blobTotalAvgSizeInBytes' | 'blobTotalGetResponseObjectSizeInBytes' | 'blobTotalSimpleRequests' | 'buildMinute' | 'dataCacheRead' | 'dataCacheRevalidation' | 'dataCacheWrite' | 'edgeConfigRead' | 'edgeConfigWrite' | 'edgeFunctionExecutionUnits' | 'edgeMiddlewareInvocations' | 'edgeRequest' | 'edgeRequestAdditionalCpuDuration' | 'fastDataTransfer' | 'fastOriginTransfer' | 'functionDuration' | 'functionInvocation' | 'logDrainsVolume' | 'monitoringMetric' | 'observabilityEvent' | 'postgresComputeTime' | 'postgresDataStorage' | 'postgresDataTransfer' | 'postgresDatabase' | 'postgresWrittenData' | 'serverlessFunctionExecution' | 'sourceImages' | 'storageRedisTotalBandwidthInBytes' | 'storageRedisTotalCommands' | 'storageRedisTotalDailyAvgStorageInBytes' | 'storageRedisTotalDatabases' | 'wafOwaspExcessBytes' | 'wafOwaspRequests' | 'wafRateLimitRequest' | 'webAnalyticsEvent';
     } | null;
     /**
      * An object containing billing infomation associated with the User account.
@@ -307,6 +307,14 @@ type AuthUser = {
          * An object containing infomation related to the amount of platform resources may be allocated to the User account.
          */
         cronJobsPerProject?: number;
+        /**
+         * An object containing infomation related to the amount of platform resources may be allocated to the User account.
+         */
+        microfrontendGroupsPerTeam?: number;
+        /**
+         * An object containing infomation related to the amount of platform resources may be allocated to the User account.
+         */
+        microfrontendProjectsPerGroup?: number;
     };
     /**
      * Prefix that will be used in the URL of "Preview" deployments created by the User account.
@@ -2551,6 +2559,7 @@ type UpdateProjectDataCacheResponse = {
         notificationCustomerBudget?: ACLAction[];
         notificationStatementOfReasons?: ACLAction[];
         oauth2Connection?: ACLAction[];
+        observabilityConfiguration?: ACLAction[];
         openTelemetryEndpoint?: ACLAction[];
         paymentMethod?: ACLAction[];
         permissions?: ACLAction[];
@@ -2625,6 +2634,7 @@ type UpdateProjectDataCacheResponse = {
         passwordProtection?: ACLAction[];
         optionsAllowlist?: ACLAction[];
         job?: ACLAction[];
+        observabilityData?: ACLAction[];
         project?: ACLAction[];
         projectFromV0?: ACLAction[];
         projectAccessGroup?: ACLAction[];
@@ -3110,7 +3120,7 @@ declare const getDeployment: (variables: GetDeploymentVariables, signal?: AbortS
     readySubstate?: "STAGED" | "PROMOTED";
     regions: string[];
     softDeletedByRetention?: boolean;
-    source?: "api-trigger-git-deploy" | "cli" | "clone/repo" | "git" | "import" | "import/repo" | "redeploy";
+    source?: "api-trigger-git-deploy" | "cli" | "clone/repo" | "git" | "import" | "import/repo" | "redeploy" | "v0-web";
     target?: "staging" | "production" | null;
     undeletedAt?: number;
     url: string;
@@ -3252,6 +3262,46 @@ declare const getDeployment: (variables: GetDeploymentVariables, signal?: AbortS
             };
         };
     } | Record<string, any>[];
+    microfrontends?: {
+        /**
+         * Whether this project is the default application for the microfrontends group. The default application is the one that is used as the top level shell for the microfrontends group and hosts the other microfrontends.
+         */
+        isDefaultApp?: boolean;
+        /**
+         * A path that is used to take screenshots and as the default path in preview links when a domain for this microfrontend is shown in the UI.
+         */
+        defaultRoute?: string;
+        /**
+         * The group of microfrontends that this project belongs to. Each microfrontend project must belong to a microfrontends group that is the set of microfrontends that are used together.
+         */
+        groupIds: string[];
+    } | {
+        /**
+         * A map of the other applications that are part of this group. Only defined on the default application. The field is set after deployments have been created, so can be undefined, but should be there for a successful deployment.
+         */
+        applications?: {
+            [key: string]: {
+                /**
+                 * This is the production alias, it will always show the most up to date of each application.
+                 */
+                productionHost: string;
+                /**
+                 * Use the fixed deploymentAlias and deploymentHost so that the microfrontend preview stays in sync with the deployment. These are only present for mono-repos when a single commit creates multiple deployments. If they are not present, productionHost will be used.
+                 */
+                deploymentAlias?: string;
+                deploymentHost?: string;
+            };
+        };
+        isDefaultApp: boolean;
+        /**
+         * A path that is used to take screenshots and as the default path in preview links when a domain for this microfrontend is shown in the UI.
+         */
+        defaultRoute?: string;
+        /**
+         * The group of microfrontends that this project belongs to. Each microfrontend project must belong to a microfrontends group that is the set of microfrontends that are used together.
+         */
+        groupIds: string[];
+    };
 } | {
     alias?: string[];
     aliasAssigned: boolean;
@@ -3402,7 +3452,7 @@ declare const getDeployment: (variables: GetDeploymentVariables, signal?: AbortS
     readySubstate?: "STAGED" | "PROMOTED";
     regions: string[];
     softDeletedByRetention?: boolean;
-    source?: "api-trigger-git-deploy" | "cli" | "clone/repo" | "git" | "import" | "import/repo" | "redeploy";
+    source?: "api-trigger-git-deploy" | "cli" | "clone/repo" | "git" | "import" | "import/repo" | "redeploy" | "v0-web";
     target?: "staging" | "production" | null;
     undeletedAt?: number;
     url: string;
@@ -3597,7 +3647,7 @@ type CreateDeploymentResponse = {
         framework?: string | null;
     };
     readyState: 'BUILDING' | 'CANCELED' | 'ERROR' | 'INITIALIZING' | 'QUEUED' | 'READY';
-    source?: 'api-trigger-git-deploy' | 'cli' | 'clone/repo' | 'git' | 'import' | 'import/repo' | 'redeploy';
+    source?: 'api-trigger-git-deploy' | 'cli' | 'clone/repo' | 'git' | 'import' | 'import/repo' | 'redeploy' | 'v0-web';
     target?: 'production' | 'staging' | null;
     /**
      * Since November 2023 this field defines a set of regions that we will deploy the lambda to passively Lambdas will be deployed to these regions but only invoked if all of the primary `regions` are marked as out of service
@@ -3648,6 +3698,46 @@ type CreateDeploymentResponse = {
     };
     projectId: string;
     ownerId: string;
+    microfrontends?: {
+        /**
+         * Whether this project is the default application for the microfrontends group. The default application is the one that is used as the top level shell for the microfrontends group and hosts the other microfrontends.
+         */
+        isDefaultApp?: boolean;
+        /**
+         * A path that is used to take screenshots and as the default path in preview links when a domain for this microfrontend is shown in the UI.
+         */
+        defaultRoute?: string;
+        /**
+         * The group of microfrontends that this project belongs to. Each microfrontend project must belong to a microfrontends group that is the set of microfrontends that are used together.
+         */
+        groupIds: string[];
+    } | {
+        /**
+         * A map of the other applications that are part of this group. Only defined on the default application. The field is set after deployments have been created, so can be undefined, but should be there for a successful deployment.
+         */
+        applications?: {
+            [key: string]: {
+                /**
+                 * This is the production alias, it will always show the most up to date of each application.
+                 */
+                productionHost: string;
+                /**
+                 * Use the fixed deploymentAlias and deploymentHost so that the microfrontend preview stays in sync with the deployment. These are only present for mono-repos when a single commit creates multiple deployments. If they are not present, productionHost will be used.
+                 */
+                deploymentAlias?: string;
+                deploymentHost?: string;
+            };
+        };
+        isDefaultApp: boolean;
+        /**
+         * A path that is used to take screenshots and as the default path in preview links when a domain for this microfrontend is shown in the UI.
+         */
+        defaultRoute?: string;
+        /**
+         * The group of microfrontends that this project belongs to. Each microfrontend project must belong to a microfrontends group that is the set of microfrontends that are used together.
+         */
+        groupIds: string[];
+    };
     monorepoManager?: string | null;
     functions?: {
         [key: string]: {
@@ -4200,7 +4290,7 @@ type CancelDeploymentResponse = {
     readySubstate?: 'PROMOTED' | 'STAGED';
     regions: string[];
     softDeletedByRetention?: boolean;
-    source?: 'api-trigger-git-deploy' | 'cli' | 'clone/repo' | 'git' | 'import' | 'import/repo' | 'redeploy';
+    source?: 'api-trigger-git-deploy' | 'cli' | 'clone/repo' | 'git' | 'import' | 'import/repo' | 'redeploy' | 'v0-web';
     target?: 'production' | 'staging' | null;
     type: 'LAMBDAS';
     undeletedAt?: number;
@@ -4343,6 +4433,46 @@ type CancelDeploymentResponse = {
             };
         };
     } | Record<string, any>[];
+    microfrontends?: {
+        /**
+         * Whether this project is the default application for the microfrontends group. The default application is the one that is used as the top level shell for the microfrontends group and hosts the other microfrontends.
+         */
+        isDefaultApp?: boolean;
+        /**
+         * A path that is used to take screenshots and as the default path in preview links when a domain for this microfrontend is shown in the UI.
+         */
+        defaultRoute?: string;
+        /**
+         * The group of microfrontends that this project belongs to. Each microfrontend project must belong to a microfrontends group that is the set of microfrontends that are used together.
+         */
+        groupIds: string[];
+    } | {
+        /**
+         * A map of the other applications that are part of this group. Only defined on the default application. The field is set after deployments have been created, so can be undefined, but should be there for a successful deployment.
+         */
+        applications?: {
+            [key: string]: {
+                /**
+                 * This is the production alias, it will always show the most up to date of each application.
+                 */
+                productionHost: string;
+                /**
+                 * Use the fixed deploymentAlias and deploymentHost so that the microfrontend preview stays in sync with the deployment. These are only present for mono-repos when a single commit creates multiple deployments. If they are not present, productionHost will be used.
+                 */
+                deploymentAlias?: string;
+                deploymentHost?: string;
+            };
+        };
+        isDefaultApp: boolean;
+        /**
+         * A path that is used to take screenshots and as the default path in preview links when a domain for this microfrontend is shown in the UI.
+         */
+        defaultRoute?: string;
+        /**
+         * The group of microfrontends that this project belongs to. Each microfrontend project must belong to a microfrontends group that is the set of microfrontends that are used together.
+         */
+        groupIds: string[];
+    };
 };
 type CancelDeploymentVariables = {
     pathParams: CancelDeploymentPathParams;
@@ -8433,6 +8563,7 @@ type GetProjectsResponse = {
             notificationCustomerBudget?: ACLAction[];
             notificationStatementOfReasons?: ACLAction[];
             oauth2Connection?: ACLAction[];
+            observabilityConfiguration?: ACLAction[];
             openTelemetryEndpoint?: ACLAction[];
             paymentMethod?: ACLAction[];
             permissions?: ACLAction[];
@@ -8507,6 +8638,7 @@ type GetProjectsResponse = {
             passwordProtection?: ACLAction[];
             optionsAllowlist?: ACLAction[];
             job?: ACLAction[];
+            observabilityData?: ACLAction[];
             project?: ACLAction[];
             projectFromV0?: ACLAction[];
             projectAccessGroup?: ACLAction[];
@@ -9204,6 +9336,7 @@ type CreateProjectResponse = {
         notificationCustomerBudget?: ACLAction[];
         notificationStatementOfReasons?: ACLAction[];
         oauth2Connection?: ACLAction[];
+        observabilityConfiguration?: ACLAction[];
         openTelemetryEndpoint?: ACLAction[];
         paymentMethod?: ACLAction[];
         permissions?: ACLAction[];
@@ -9278,6 +9411,7 @@ type CreateProjectResponse = {
         passwordProtection?: ACLAction[];
         optionsAllowlist?: ACLAction[];
         job?: ACLAction[];
+        observabilityData?: ACLAction[];
         project?: ACLAction[];
         projectFromV0?: ACLAction[];
         projectAccessGroup?: ACLAction[];
@@ -10107,6 +10241,7 @@ type GetProjectResponse = {
         notificationCustomerBudget?: ACLAction[];
         notificationStatementOfReasons?: ACLAction[];
         oauth2Connection?: ACLAction[];
+        observabilityConfiguration?: ACLAction[];
         openTelemetryEndpoint?: ACLAction[];
         paymentMethod?: ACLAction[];
         permissions?: ACLAction[];
@@ -10181,6 +10316,7 @@ type GetProjectResponse = {
         passwordProtection?: ACLAction[];
         optionsAllowlist?: ACLAction[];
         job?: ACLAction[];
+        observabilityData?: ACLAction[];
         project?: ACLAction[];
         projectFromV0?: ACLAction[];
         projectAccessGroup?: ACLAction[];
@@ -10885,6 +11021,7 @@ type UpdateProjectResponse = {
         notificationCustomerBudget?: ACLAction[];
         notificationStatementOfReasons?: ACLAction[];
         oauth2Connection?: ACLAction[];
+        observabilityConfiguration?: ACLAction[];
         openTelemetryEndpoint?: ACLAction[];
         paymentMethod?: ACLAction[];
         permissions?: ACLAction[];
@@ -10959,6 +11096,7 @@ type UpdateProjectResponse = {
         passwordProtection?: ACLAction[];
         optionsAllowlist?: ACLAction[];
         job?: ACLAction[];
+        observabilityData?: ACLAction[];
         project?: ACLAction[];
         projectFromV0?: ACLAction[];
         projectAccessGroup?: ACLAction[];
@@ -16105,7 +16243,7 @@ type GetDeploymentsResponse = {
          *
          * @example cli
          */
-        source?: 'api-trigger-git-deploy' | 'cli' | 'clone/repo' | 'git' | 'import' | 'import/repo' | 'redeploy';
+        source?: 'api-trigger-git-deploy' | 'cli' | 'clone/repo' | 'git' | 'import' | 'import/repo' | 'redeploy' | 'v0-web';
         /**
          * In which state is the deployment.
          *
@@ -17871,7 +18009,7 @@ declare const operationsByTag: {
             readySubstate?: "STAGED" | "PROMOTED";
             regions: string[];
             softDeletedByRetention?: boolean;
-            source?: "api-trigger-git-deploy" | "cli" | "clone/repo" | "git" | "import" | "import/repo" | "redeploy";
+            source?: "api-trigger-git-deploy" | "cli" | "clone/repo" | "git" | "import" | "import/repo" | "redeploy" | "v0-web";
             target?: "staging" | "production" | null;
             undeletedAt?: number;
             url: string;
@@ -18013,6 +18151,46 @@ declare const operationsByTag: {
                     };
                 };
             } | Record<string, any>[];
+            microfrontends?: {
+                /**
+                 * Whether this project is the default application for the microfrontends group. The default application is the one that is used as the top level shell for the microfrontends group and hosts the other microfrontends.
+                 */
+                isDefaultApp?: boolean;
+                /**
+                 * A path that is used to take screenshots and as the default path in preview links when a domain for this microfrontend is shown in the UI.
+                 */
+                defaultRoute?: string;
+                /**
+                 * The group of microfrontends that this project belongs to. Each microfrontend project must belong to a microfrontends group that is the set of microfrontends that are used together.
+                 */
+                groupIds: string[];
+            } | {
+                /**
+                 * A map of the other applications that are part of this group. Only defined on the default application. The field is set after deployments have been created, so can be undefined, but should be there for a successful deployment.
+                 */
+                applications?: {
+                    [key: string]: {
+                        /**
+                         * This is the production alias, it will always show the most up to date of each application.
+                         */
+                        productionHost: string;
+                        /**
+                         * Use the fixed deploymentAlias and deploymentHost so that the microfrontend preview stays in sync with the deployment. These are only present for mono-repos when a single commit creates multiple deployments. If they are not present, productionHost will be used.
+                         */
+                        deploymentAlias?: string;
+                        deploymentHost?: string;
+                    };
+                };
+                isDefaultApp: boolean;
+                /**
+                 * A path that is used to take screenshots and as the default path in preview links when a domain for this microfrontend is shown in the UI.
+                 */
+                defaultRoute?: string;
+                /**
+                 * The group of microfrontends that this project belongs to. Each microfrontend project must belong to a microfrontends group that is the set of microfrontends that are used together.
+                 */
+                groupIds: string[];
+            };
         } | {
             alias?: string[];
             aliasAssigned: boolean;
@@ -18163,7 +18341,7 @@ declare const operationsByTag: {
             readySubstate?: "STAGED" | "PROMOTED";
             regions: string[];
             softDeletedByRetention?: boolean;
-            source?: "api-trigger-git-deploy" | "cli" | "clone/repo" | "git" | "import" | "import/repo" | "redeploy";
+            source?: "api-trigger-git-deploy" | "cli" | "clone/repo" | "git" | "import" | "import/repo" | "redeploy" | "v0-web";
             target?: "staging" | "production" | null;
             undeletedAt?: number;
             url: string;
@@ -20138,7 +20316,7 @@ declare const operationsByPath: {
         readySubstate?: "STAGED" | "PROMOTED";
         regions: string[];
         softDeletedByRetention?: boolean;
-        source?: "api-trigger-git-deploy" | "cli" | "clone/repo" | "git" | "import" | "import/repo" | "redeploy";
+        source?: "api-trigger-git-deploy" | "cli" | "clone/repo" | "git" | "import" | "import/repo" | "redeploy" | "v0-web";
         target?: "staging" | "production" | null;
         undeletedAt?: number;
         url: string;
@@ -20268,6 +20446,22 @@ declare const operationsByPath: {
                 };
             };
         } | Record<string, any>[];
+        microfrontends?: {
+            isDefaultApp?: boolean;
+            defaultRoute?: string;
+            groupIds: string[];
+        } | {
+            applications?: {
+                [key: string]: {
+                    productionHost: string;
+                    deploymentAlias?: string;
+                    deploymentHost?: string;
+                };
+            };
+            isDefaultApp: boolean;
+            defaultRoute?: string;
+            groupIds: string[];
+        };
     } | {
         alias?: string[];
         aliasAssigned: boolean;
@@ -20406,7 +20600,7 @@ declare const operationsByPath: {
         readySubstate?: "STAGED" | "PROMOTED";
         regions: string[];
         softDeletedByRetention?: boolean;
-        source?: "api-trigger-git-deploy" | "cli" | "clone/repo" | "git" | "import" | "import/repo" | "redeploy";
+        source?: "api-trigger-git-deploy" | "cli" | "clone/repo" | "git" | "import" | "import/repo" | "redeploy" | "v0-web";
         target?: "staging" | "production" | null;
         undeletedAt?: number;
         url: string;
@@ -21856,7 +22050,7 @@ declare class VercelApi {
             readySubstate?: "STAGED" | "PROMOTED";
             regions: string[];
             softDeletedByRetention?: boolean;
-            source?: "api-trigger-git-deploy" | "cli" | "clone/repo" | "git" | "import" | "import/repo" | "redeploy";
+            source?: "api-trigger-git-deploy" | "cli" | "clone/repo" | "git" | "import" | "import/repo" | "redeploy" | "v0-web";
             target?: "staging" | "production" | null;
             undeletedAt?: number;
             url: string;
@@ -21986,6 +22180,22 @@ declare class VercelApi {
                     };
                 };
             } | Record<string, any>[];
+            microfrontends?: {
+                isDefaultApp?: boolean;
+                defaultRoute?: string;
+                groupIds: string[];
+            } | {
+                applications?: {
+                    [key: string]: {
+                        productionHost: string;
+                        deploymentAlias?: string;
+                        deploymentHost?: string;
+                    };
+                };
+                isDefaultApp: boolean;
+                defaultRoute?: string;
+                groupIds: string[];
+            };
         } | {
             alias?: string[];
             aliasAssigned: boolean;
@@ -22124,7 +22334,7 @@ declare class VercelApi {
             readySubstate?: "STAGED" | "PROMOTED";
             regions: string[];
             softDeletedByRetention?: boolean;
-            source?: "api-trigger-git-deploy" | "cli" | "clone/repo" | "git" | "import" | "import/repo" | "redeploy";
+            source?: "api-trigger-git-deploy" | "cli" | "clone/repo" | "git" | "import" | "import/repo" | "redeploy" | "v0-web";
             target?: "staging" | "production" | null;
             undeletedAt?: number;
             url: string;