@archildata/api-types 0.0.1 → 0.0.3

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/index.d.ts +57 -0
  2. package/package.json +1 -1
package/index.d.ts CHANGED
@@ -333,6 +333,11 @@ export interface components {
333
333
  * @example data/
334
334
  */
335
335
  bucketPrefix?: string;
336
+ /**
337
+ * @description Bucket region
338
+ * @example us-east-1
339
+ */
340
+ bucketRegion?: string;
336
341
  };
337
342
  /**
338
343
  * Google Cloud Storage
@@ -361,6 +366,11 @@ export interface components {
361
366
  * @example data/
362
367
  */
363
368
  bucketPrefix?: string;
369
+ /**
370
+ * @description Bucket region
371
+ * @example auto
372
+ */
373
+ bucketRegion?: string;
364
374
  };
365
375
  /**
366
376
  * Cloudflare R2
@@ -394,6 +404,11 @@ export interface components {
394
404
  * @example data/
395
405
  */
396
406
  bucketPrefix?: string;
407
+ /**
408
+ * @description Bucket region
409
+ * @example auto
410
+ */
411
+ bucketRegion?: string;
397
412
  };
398
413
  /**
399
414
  * S3-Compatible
@@ -427,6 +442,11 @@ export interface components {
427
442
  * @example data/
428
443
  */
429
444
  bucketPrefix?: string;
445
+ /**
446
+ * @description Bucket region
447
+ * @example auto
448
+ */
449
+ bucketRegion?: string;
430
450
  };
431
451
  /**
432
452
  * Azure Blob Storage
@@ -485,6 +505,15 @@ export interface components {
485
505
  * @description Deprecated. Last 4 characters of the token. Required when principal is provided; ignored when the server generates the token.
486
506
  */
487
507
  tokenSuffix?: string;
508
+ /** @description Optional time-to-live for the token as a Go duration string (e.g. "1h", "30m", "24h"). The server computes expiresAt = now + ttl. Maximum 365 days ("8760h"). Expired tokens are rejected at mount time but remain visible in the disk's authorized users list. Mutually exclusive with expiresAt. */
509
+ ttl?: string;
510
+ /**
511
+ * Format: date-time
512
+ * @description Optional absolute expiration time as an RFC3339 timestamp (e.g. "2026-07-15T00:00:00Z"). Must be in the future. Mutually exclusive with ttl.
513
+ */
514
+ expiresAt?: string;
515
+ /** @description When true, the token can only be used for a single mount authentication. After the first successful mount, subsequent attempts are rejected. Consumed tokens remain visible in the disk's authorized users list. */
516
+ oneUse?: boolean;
488
517
  };
489
518
  AwsStsUser: {
490
519
  /**
@@ -494,6 +523,15 @@ export interface components {
494
523
  type: "awssts";
495
524
  /** @description IAM principal ARN */
496
525
  principal: string;
526
+ /** @description Optional time-to-live as a Go duration string (e.g. "1h", "30m"). Maximum 365 days ("8760h"). Mutually exclusive with expiresAt. */
527
+ ttl?: string;
528
+ /**
529
+ * Format: date-time
530
+ * @description Optional absolute expiration time as an RFC3339 timestamp. Must be in the future. Mutually exclusive with ttl.
531
+ */
532
+ expiresAt?: string;
533
+ /** @description When true, the credential can only be used for a single mount authentication. */
534
+ oneUse?: boolean;
497
535
  };
498
536
  DiskUser: components["schemas"]["TokenUser"] | components["schemas"]["AwsStsUser"];
499
537
  DiskResponse: {
@@ -597,6 +635,8 @@ export interface components {
597
635
  bucketEndpoint?: string;
598
636
  /** @description Prefix within the bucket */
599
637
  bucketPrefix?: string;
638
+ /** @description Bucket region */
639
+ bucketRegion?: string;
600
640
  /** @description Session identifier for IAM-authorized mounts */
601
641
  sessionId?: string;
602
642
  };
@@ -630,6 +670,23 @@ export interface components {
630
670
  identifier?: string;
631
671
  /** Format: date-time */
632
672
  createdAt?: string;
673
+ /**
674
+ * Format: date-time
675
+ * @description When the token expires. Absent for tokens without a TTL.
676
+ */
677
+ expiresAt?: string;
678
+ /** @description Whether this token is single-use. */
679
+ oneUse?: boolean;
680
+ /**
681
+ * Format: date-time
682
+ * @description When the one-use token was consumed (first successful mount auth). Absent if the token has not been consumed or is not one-use.
683
+ */
684
+ consumedAt?: string;
685
+ /**
686
+ * @description Current lifecycle status of the token.
687
+ * @enum {string}
688
+ */
689
+ status?: "active" | "expired" | "consumed";
633
690
  };
634
691
  /** @description All API responses use a standard envelope with `success: boolean` and `data` (on success) or `error: string` (on failure). The ApiResponse_* schemas each define the specific `data` shape for their endpoint. */
635
692
  ApiResponse_DiskList: {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@archildata/api-types",
3
- "version": "0.0.1",
3
+ "version": "0.0.3",
4
4
  "description": "API types for the Archil control plane",
5
5
  "type": "module",
6
6
  "types": "index.d.ts",