@argos-ci/core 2.9.2 → 2.10.0

package/dist/index.cjs

@@ -1,15 +1,14 @@
-exports.upload = async (...args)=>{
-    // @ts-ignore
-    const { upload } = await import('./index.mjs');
-    return upload(...args);
+exports.upload = async (...args) => {
+  const { upload } = await import("./index.js");
+  return upload(...args);
 };
-exports.finalize = async (...args)=>{
-    // @ts-ignore
-    const { finalize } = await import('./index.mjs');
-    return finalize(...args);
+
+exports.finalize = async (...args) => {
+  const { finalize } = await import("./index.js");
+  return finalize(...args);
 };
-exports.readConfig = async (...args)=>{
-    // @ts-ignore
-    const { readConfig } = await import('./index.mjs');
-    return readConfig(...args);
+
+exports.readConfig = async (...args) => {
+  const { readConfig } = await import("./index.js");
+  return readConfig(...args);
 };

package/dist/index.d.ts

@@ -1,4 +1,6 @@
-import { ArgosAPISchema } from "@argos-ci/api-client";
+import * as _argos_ci_util from '@argos-ci/util';
+import { ArgosAPISchema } from '@argos-ci/api-client';
+
 type BuildMetadata = ArgosAPISchema.components["schemas"]["BuildMetadata"];
 interface UploadParameters {
     /**
@@ -80,25 +82,25 @@ interface UploadParameters {
  */
 declare function upload(params: UploadParameters): Promise<{
     build: {
-        id: string;
+        id: ArgosAPISchema.components["schemas"]["BuildId"];
         number: number;
-        status: "accepted" | "rejected" | "stable" | "diffDetected" | "expired" | "pending" | "progress" | "error" | "aborted";
+        status: ("accepted" | "rejected") | ("stable" | "diffDetected") | ("expired" | "pending" | "progress" | "error" | "aborted");
         url: string;
         notification: {
             description: string;
             context: string;
             github: {
-                state: "pending" | "error" | "success" | "failure";
+                state: "pending" | "success" | "error" | "failure";
             };
             gitlab: {
-                state: "pending" | "success" | "running" | "failed" | "canceled";
+                state: "pending" | "running" | "success" | "failed" | "canceled";
             };
         } | null;
     };
     screenshots: {
         hash: string;
         optimizedPath: string;
-        metadata: import("@argos-ci/util").ScreenshotMetadata | null;
+        metadata: _argos_ci_util.ScreenshotMetadata | null;
         threshold: number | null;
         baseName: string | null;
         pwTrace: {
@@ -109,6 +111,134 @@ declare function upload(params: UploadParameters): Promise<{
         path: string;
     }[];
 }>;
+
+interface components {
+    schemas: {
+        /** @description SHA1 hash */
+        Sha1Hash: string;
+        /** @description SHA256 hash */
+        Sha256Hash: string;
+        /** @description Build */
+        Build: {
+            id: components["schemas"]["BuildId"];
+            /** @description The build number */
+            number: number;
+            /** @description The status of the build */
+            status: ("accepted" | "rejected") | ("stable" | "diffDetected") | ("expired" | "pending" | "progress" | "error" | "aborted");
+            /**
+             * Format: uri
+             * @description The URL of the build
+             */
+            url: string;
+            /** @description The notification payload for the build */
+            notification: {
+                description: string;
+                context: string;
+                github: {
+                    /** @enum {string} */
+                    state: "pending" | "success" | "error" | "failure";
+                };
+                gitlab: {
+                    /** @enum {string} */
+                    state: "pending" | "running" | "success" | "failed" | "canceled";
+                };
+            } | null;
+        };
+        /**
+         * @description A unique identifier for the build
+         * @example 12345
+         */
+        BuildId: string;
+        /** @description Error response */
+        Error: {
+            error: string;
+            details?: {
+                message: string;
+            }[];
+        };
+        /**
+         * @description A unique identifier for the build
+         * @example 12345
+         */
+        buildId: string;
+        /** @description Screenshot input */
+        ScreenshotInput: {
+            key: string;
+            name: string;
+            baseName?: string | null;
+            metadata?: {
+                url?: string;
+                viewport?: {
+                    width: number;
+                    height: number;
+                };
+                /** @enum {string} */
+                colorScheme?: "light" | "dark";
+                /** @enum {string} */
+                mediaType?: "screen" | "print";
+                test?: {
+                    id?: string;
+                    title: string;
+                    titlePath: string[];
+                    retries?: number;
+                    retry?: number;
+                    repeat?: number;
+                    location?: {
+                        file: string;
+                        line: number;
+                        column: number;
+                    };
+                } | null;
+                browser?: {
+                    name: string;
+                    version: string;
+                };
+                automationLibrary: {
+                    name: string;
+                    version: string;
+                };
+                sdk: {
+                    name: string;
+                    version: string;
+                };
+            } | null;
+            pwTraceKey?: string | null;
+            threshold?: number | null;
+        };
+        /** @description Build metadata */
+        BuildMetadata: {
+            testReport?: {
+                /** @enum {string} */
+                status: "passed" | "failed" | "timedout" | "interrupted";
+                stats?: {
+                    startTime?: string;
+                    duration?: number;
+                };
+            };
+        };
+        /** @description Project */
+        Project: {
+            id: string;
+            defaultBaseBranch: string;
+            hasRemoteContentAccess: boolean;
+        };
+        /** @description Page information */
+        PageInfo: {
+            /** @description Total number of items */
+            total: number;
+            /** @description Current page number */
+            page: number;
+            /** @description Number of items per page */
+            perPage: number;
+        };
+    };
+    responses: never;
+    parameters: never;
+    requestBodies: never;
+    headers: never;
+    pathItems: never;
+}
+
 type FinalizeParameters = {
     parallel?: {
         nonce: string;
@@ -118,23 +248,9 @@ type FinalizeParameters = {
  * Finalize pending builds.
  */
 declare function finalize(params: FinalizeParameters): Promise<{
-    builds: {
-        id: string;
-        number: number;
-        status: "accepted" | "rejected" | "stable" | "diffDetected" | "expired" | "pending" | "progress" | "error" | "aborted";
-        url: string;
-        notification: {
-            description: string;
-            context: string;
-            github: {
-                state: "pending" | "error" | "success" | "failure";
-            };
-            gitlab: {
-                state: "pending" | "success" | "running" | "failed" | "canceled";
-            };
-        } | null;
-    }[];
+    builds: components["schemas"]["Build"][];
 }>;
+
 interface Config {
     apiBaseUrl: string;
     commit: string;
@@ -160,4 +276,5 @@ interface Config {
     threshold: number | null;
 }
 declare function readConfig(options?: Partial<Config>): Promise<Config>;
-export { UploadParameters, upload, FinalizeParameters, finalize, Config, readConfig };
+
+export { type Config, type FinalizeParameters, type UploadParameters, finalize, readConfig, upload };