@argos-ci/api-client 0.8.1-alpha.3 → 0.8.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/dist/index.d.ts +71 -55
  2. package/package.json +8 -5
package/dist/index.d.ts CHANGED
@@ -93,88 +93,72 @@ interface components {
93
93
  Sha1Hash: string;
94
94
  /** @description SHA256 hash */
95
95
  Sha256Hash: string;
96
- /** @description Build */
97
- Build: {
98
- id: components["schemas"]["BuildId"];
99
- /** @description The build number */
100
- number: number;
101
- /** @description The status of the build */
102
- status: ("accepted" | "rejected") | ("no-changes" | "changes-detected") | ("expired" | "pending" | "progress" | "error" | "aborted");
103
- /**
104
- * Format: uri
105
- * @description The URL of the build
106
- */
107
- url: string;
108
- /** @description The notification payload for the build */
109
- notification: {
110
- description: string;
111
- context: string;
112
- github: {
113
- /** @enum {string} */
114
- state: "pending" | "success" | "error" | "failure";
115
- };
116
- gitlab: {
117
- /** @enum {string} */
118
- state: "pending" | "running" | "success" | "failed" | "canceled";
119
- };
120
- } | null;
121
- };
122
96
  /**
123
97
  * @description A unique identifier for the build
124
98
  * @example 12345
125
99
  */
126
100
  BuildId: string;
127
- /** @description Error response */
128
- Error: {
129
- error: string;
130
- details?: {
131
- message: string;
132
- }[];
133
- };
134
- /**
135
- * @description A unique identifier for the build
136
- * @example 12345
137
- */
138
- buildId: string;
139
101
  /** @description Screenshot input */
140
102
  ScreenshotInput: {
141
103
  key: string;
142
104
  name: string;
143
105
  baseName?: string | null;
144
106
  metadata?: {
145
- url?: string;
146
- previewUrl?: string;
107
+ /** @description The URL of the page that was screenshotted */
108
+ url?: string | null;
109
+ /** @description An URL to an accessible preview of the screenshot */
110
+ previewUrl?: string | null;
147
111
  viewport?: {
112
+ /** @description The width of the viewport */
148
113
  width: number;
114
+ /** @description The height of the viewport */
149
115
  height: number;
150
- };
151
- /** @enum {string} */
152
- colorScheme?: "light" | "dark";
153
- /** @enum {string} */
154
- mediaType?: "screen" | "print";
155
- test?: {
156
- id?: string;
116
+ } | null;
117
+ /** @description The color scheme when the screenshot was taken */
118
+ colorScheme?: ("light" | "dark") | null;
119
+ /** @description The media type when the screenshot was taken */
120
+ mediaType?: ("screen" | "print") | null;
121
+ test?: ({
122
+ /** @description The unique identifier of the test */
123
+ id?: string | null;
124
+ /** @description The title of the test */
157
125
  title: string;
126
+ /** @description The path of titles leading to the test */
158
127
  titlePath: string[];
159
- retries?: number;
160
- retry?: number;
161
- repeat?: number;
128
+ /** @description The number of retries for the test */
129
+ retries?: number | null;
130
+ /** @description The current retry count */
131
+ retry?: number | null;
132
+ /** @description The repeat count for the test */
133
+ repeat?: number | null;
134
+ /** @description The location of the test in the source code */
162
135
  location?: {
136
+ /** @description The file where the test is located */
163
137
  file: string;
138
+ /** @description The line number in the file */
164
139
  line: number;
140
+ /** @description The column number in the file */
165
141
  column: number;
166
142
  };
167
- } | null;
143
+ } | null) | null;
168
144
  browser?: {
145
+ /** @description The name of the browser */
169
146
  name: string;
147
+ /** @description The version of the browser */
170
148
  version: string;
171
- };
149
+ } | null;
150
+ /** @description The automation library that generated the screenshot */
172
151
  automationLibrary: {
152
+ /** @description The name of the automation library */
173
153
  name: string;
154
+ /** @description The version of the automation library */
174
155
  version: string;
175
156
  };
157
+ /** @description The Argos SDK that generated the screenshot */
176
158
  sdk: {
159
+ /** @description The name of the Argos SDK */
177
160
  name: string;
161
+ /** @description The version of the Argos SDK */
178
162
  version: string;
179
163
  };
180
164
  } | null;
@@ -192,6 +176,39 @@ interface components {
192
176
  };
193
177
  };
194
178
  };
179
+ /** @description Build */
180
+ Build: {
181
+ id: components["schemas"]["BuildId"];
182
+ /** @description The build number */
183
+ number: number;
184
+ /** @description The status of the build */
185
+ status: ("accepted" | "rejected") | ("no-changes" | "changes-detected") | ("expired" | "pending" | "progress" | "error" | "aborted");
186
+ /**
187
+ * Format: uri
188
+ * @description The URL of the build
189
+ */
190
+ url: string;
191
+ /** @description The notification payload for the build */
192
+ notification: {
193
+ description: string;
194
+ context: string;
195
+ github: {
196
+ /** @enum {string} */
197
+ state: "pending" | "success" | "error" | "failure";
198
+ };
199
+ gitlab: {
200
+ /** @enum {string} */
201
+ state: "pending" | "running" | "success" | "failed" | "canceled";
202
+ };
203
+ } | null;
204
+ };
205
+ /** @description Error response */
206
+ Error: {
207
+ error: string;
208
+ details?: {
209
+ message: string;
210
+ }[];
211
+ };
195
212
  /** @description Project */
196
213
  Project: {
197
214
  id: string;
@@ -238,8 +255,7 @@ interface operations {
238
255
  referenceCommit?: string | null;
239
256
  referenceBranch?: string | null;
240
257
  parentCommits?: components["schemas"]["Sha1Hash"][] | null;
241
- /** @enum {string|null} */
242
- mode?: "ci" | "monitoring" | null;
258
+ mode?: ("ci" | "monitoring") | null;
243
259
  ciProvider?: string | null;
244
260
  argosSdk?: string | null;
245
261
  runId?: string | null;
@@ -395,7 +411,7 @@ interface operations {
395
411
  header?: never;
396
412
  path: {
397
413
  /** @description A unique identifier for the build */
398
- buildId: components["schemas"]["buildId"];
414
+ buildId: components["schemas"]["BuildId"];
399
415
  };
400
416
  cookie?: never;
401
417
  };
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@argos-ci/api-client",
3
3
  "description": "Argos API Client library.",
4
- "version": "0.8.1-alpha.3+d98d368",
4
+ "version": "0.8.2",
5
5
  "author": "Smooth Code",
6
6
  "license": "MIT",
7
7
  "repository": {
@@ -37,16 +37,19 @@
37
37
  "scripts": {
38
38
  "build-schema-types": "openapi-typescript https://api.argos-ci.com/v2/openapi.yaml -o src/schema.ts",
39
39
  "build-schema-types-dev": "NODE_TLS_REJECT_UNAUTHORIZED=0 openapi-typescript https://api.argos-ci.dev:4001/v2/openapi.yaml -o src/schema.ts",
40
- "build": "tsup"
40
+ "build": "tsup",
41
+ "check-types": "tsc",
42
+ "check-format": "prettier --check --ignore-unknown --ignore-path=../../.gitignore --ignore-path=../../.prettierignore .",
43
+ "lint": "eslint ."
41
44
  },
42
45
  "devDependencies": {
43
46
  "@types/debug": "^4.1.12",
44
47
  "@types/node": "^18.19.44",
45
- "openapi-typescript": "^7.5.2"
48
+ "openapi-typescript": "^7.6.1"
46
49
  },
47
50
  "dependencies": {
48
51
  "debug": "^4.4.0",
49
- "openapi-fetch": "0.13.4"
52
+ "openapi-fetch": "0.13.5"
50
53
  },
51
- "gitHead": "d98d368f95bee0eff3bd70ce945daf883f37f2d4"
54
+ "gitHead": "ecab2281c36828d0c43728e3ed98e1eefe227c99"
52
55
  }