@vibexp/api-client 0.98.0 → 0.100.0

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.
@@ -76,25 +76,25 @@ export type PaginatedResponse = {
76
76
  total_pages: number;
77
77
  };
78
78
  /**
79
- * The complete status vocabulary shared by prompts, artifacts, blueprints and memories. Each resource type accepts a named subset of these values, never the whole set; see PromptStatus, ArtifactStatus, BlueprintStatus and MemoryStatus.
79
+ * The system status vocabulary shared by prompts, artifacts, blueprints and memories. Each resource type has a named subset of these values as its system statuses; see PromptStatus, ArtifactStatus, BlueprintStatus and MemoryStatus. A team's custom status may not reuse any of these values.
80
80
  */
81
81
  export type ResourceStatus = 'active' | 'draft' | 'archived' | 'published' | 'expired';
82
82
  /**
83
- * Publication status of a prompt. A prompt is only exposed over MCP once it is `published`.
83
+ * Status of a prompt. The system values are `draft` and `published`; a prompt is only exposed over MCP once it is `published`. A team may define further statuses of its own for prompts, so this is an open string: any other value must be one of the team's custom prompt statuses, or the request is rejected with 400.
84
84
  */
85
- export type PromptStatus = 'draft' | 'published';
85
+ export type PromptStatus = string;
86
86
  /**
87
- * Lifecycle status of an artifact.
87
+ * Status of an artifact. The system values are `active`, `draft` and `archived`. A team may define further statuses of its own for artifacts, so this is an open string: any other value must be one of the team's custom artifact statuses, or the request is rejected with 400.
88
88
  */
89
- export type ArtifactStatus = 'active' | 'draft' | 'archived';
89
+ export type ArtifactStatus = string;
90
90
  /**
91
- * Lifecycle status of a blueprint. `expired` marks a blueprint whose rules no longer apply but whose content is kept for reference.
91
+ * Status of a blueprint. The system values are `active` and `expired`; `expired` marks a blueprint whose rules no longer apply but whose content is kept for reference. A team may define further statuses of its own for blueprints, so this is an open string: any other value must be one of the team's custom blueprint statuses, or the request is rejected with 400.
92
92
  */
93
- export type BlueprintStatus = 'active' | 'expired';
93
+ export type BlueprintStatus = string;
94
94
  /**
95
- * Lifecycle status of a memory.
95
+ * Status of a memory. The system values are `active`, `draft` and `archived`. A team may define further statuses of its own for memories, so this is an open string: any other value must be one of the team's custom memory statuses, or the request is rejected with 400.
96
96
  */
97
- export type MemoryStatus = 'active' | 'draft' | 'archived';
97
+ export type MemoryStatus = string;
98
98
  /**
99
99
  * Per-source access counts for a single calendar day (UTC), zero-filled.
100
100
  */
@@ -6437,18 +6437,22 @@ export type AdminInstanceSearchSettings = {
6437
6437
  updated_by_name: string | null;
6438
6438
  /**
6439
6439
  * The stored row's optimistic-lock version; null when nothing is stored.
6440
- * Send it back as `expected_version` to reject a save that would
6441
- * overwrite someone else's change.
6440
+ * Send it back as `expected_version` (`0` when it is null) to reject a
6441
+ * save that would overwrite someone else's change.
6442
6442
  *
6443
6443
  */
6444
6444
  version: number | null;
6445
6445
  };
6446
6446
  /**
6447
6447
  * A whole replacement of the instance search ranking defaults. Every value is
6448
- * required. `expected_version` is optional: when present, the save is
6449
- * rejected with 409 unless it equals the stored version (and when nothing is
6450
- * stored, any `expected_version` other than null is a conflict). Omit it for
6451
- * last-write-wins.
6448
+ * required. `expected_version` is optional and makes the save a
6449
+ * compare-and-set:
6450
+ *
6451
+ * - omitted or null: last-write-wins, never a conflict.
6452
+ * - `0`: nothing may be stored yet; the save is rejected with 409 when a row
6453
+ * is stored. Send it when the `version` last read was null.
6454
+ * - a positive value: the save is rejected with 409 unless it equals the
6455
+ * stored `version`, and also when nothing is stored.
6452
6456
  *
6453
6457
  */
6454
6458
  export type AdminInstanceSearchSettingsUpdate = {
@@ -6459,7 +6463,10 @@ export type AdminInstanceSearchSettingsUpdate = {
6459
6463
  rank_half_life_days: number;
6460
6464
  rank_candidate_cap: number;
6461
6465
  /**
6462
- * The `version` the caller last read; omit or null for last-write-wins.
6466
+ * The `version` the caller last read. Send `0` when that `version` was
6467
+ * null, to save only while nothing is stored. Omit it or send null for
6468
+ * last-write-wins. A negative value matches nothing and is a 409.
6469
+ *
6463
6470
  */
6464
6471
  expected_version?: number | null;
6465
6472
  };
@@ -6542,18 +6549,22 @@ export type AdminInstanceAiSummarySettings = {
6542
6549
  updated_by_name: string | null;
6543
6550
  /**
6544
6551
  * The stored row's optimistic-lock version; null when nothing is stored.
6545
- * Send it back as `expected_version` to reject a save that would
6546
- * overwrite someone else's change.
6552
+ * Send it back as `expected_version` (`0` when it is null) to reject a
6553
+ * save that would overwrite someone else's change.
6547
6554
  *
6548
6555
  */
6549
6556
  version: number | null;
6550
6557
  };
6551
6558
  /**
6552
6559
  * A whole replacement of the instance AI summary settings. Every value is
6553
- * required. `expected_version` is optional: when present, the save is
6554
- * rejected with 409 unless it equals the stored version (and when nothing is
6555
- * stored, any `expected_version` other than null is a conflict). Omit it for
6556
- * last-write-wins.
6560
+ * required. `expected_version` is optional and makes the save a
6561
+ * compare-and-set:
6562
+ *
6563
+ * - omitted or null: last-write-wins, never a conflict.
6564
+ * - `0`: nothing may be stored yet; the save is rejected with 409 when a row
6565
+ * is stored. Send it when the `version` last read was null.
6566
+ * - a positive value: the save is rejected with 409 unless it equals the
6567
+ * stored `version`, and also when nothing is stored.
6557
6568
  *
6558
6569
  */
6559
6570
  export type AdminInstanceAiSummarySettingsUpdate = {
@@ -6565,7 +6576,10 @@ export type AdminInstanceAiSummarySettingsUpdate = {
6565
6576
  total_context_chars: number;
6566
6577
  request_timeout_ms: number;
6567
6578
  /**
6568
- * The `version` the caller last read; omit or null for last-write-wins.
6579
+ * The `version` the caller last read. Send `0` when that `version` was
6580
+ * null, to save only while nothing is stored. Omit it or send null for
6581
+ * last-write-wins. A negative value matches nothing and is a 409.
6582
+ *
6569
6583
  */
6570
6584
  expected_version?: number | null;
6571
6585
  };
@@ -6814,7 +6828,10 @@ export type AdminAuthAllowlist = {
6814
6828
  */
6815
6829
  active: boolean;
6816
6830
  /**
6817
- * The stored allowlist's own version; null when nothing is stored.
6831
+ * The stored allowlist's own version; null when nothing is stored. Send
6832
+ * it back as `expected_version` (`0` when it is null) to reject a save
6833
+ * that would overwrite someone else's change.
6834
+ *
6818
6835
  */
6819
6836
  version: number | null;
6820
6837
  /**
@@ -6835,17 +6852,23 @@ export type AdminAuthAllowlist = {
6835
6852
  * is a DNS name of at least two labels with no leading `@`. Storing two empty
6836
6853
  * lists means open access.
6837
6854
  *
6838
- * `expected_version` is optional: when present, the save is rejected with
6839
- * 409 unless it equals the stored allowlist's `version` (and when nothing is
6840
- * stored, any `expected_version` other than null is a conflict). Omit it for
6841
- * last-write-wins.
6855
+ * `expected_version` is optional and makes the save a compare-and-set:
6856
+ *
6857
+ * - omitted or null: last-write-wins, never a conflict.
6858
+ * - `0`: no allowlist may be stored yet; the save is rejected with 409 when
6859
+ * one is. Send it when the `version` last read was null.
6860
+ * - a positive value: the save is rejected with 409 unless it equals the
6861
+ * stored allowlist's `version`, and also when nothing is stored.
6842
6862
  *
6843
6863
  */
6844
6864
  export type AdminAuthAllowlistUpdate = {
6845
6865
  domains: Array<string>;
6846
6866
  emails: Array<string>;
6847
6867
  /**
6848
- * The `version` the caller last read; omit or null for last-write-wins.
6868
+ * The `version` the caller last read. Send `0` when that `version` was
6869
+ * null, to save only while nothing is stored. Omit it or send null for
6870
+ * last-write-wins. A negative value matches nothing and is a 409.
6871
+ *
6849
6872
  */
6850
6873
  expected_version?: number | null;
6851
6874
  };
@@ -7787,7 +7810,7 @@ export type ListArtifactsData = {
7787
7810
  */
7788
7811
  project_id?: string;
7789
7812
  /**
7790
- * Filter by status
7813
+ * Filter by status: one of the system statuses or one of the team's custom statuses for this resource type. Returns 400 for unknown values.
7791
7814
  */
7792
7815
  status?: ArtifactStatus;
7793
7816
  /**
@@ -7931,7 +7954,7 @@ export type ListArtifactsByProjectData = {
7931
7954
  */
7932
7955
  freshness?: 'stale';
7933
7956
  /**
7934
- * Filter by status
7957
+ * Filter by status: one of the system statuses or one of the team's custom statuses for this resource type. Returns 400 for unknown values.
7935
7958
  */
7936
7959
  status?: ArtifactStatus;
7937
7960
  /**
@@ -9194,7 +9217,7 @@ export type ListSpecLibrariesData = {
9194
9217
  */
9195
9218
  project_id?: string;
9196
9219
  /**
9197
- * Filter by status
9220
+ * Filter by status: one of the system statuses or one of the team's custom statuses for this resource type. Returns 400 for unknown values.
9198
9221
  */
9199
9222
  status?: BlueprintStatus;
9200
9223
  /**
@@ -9342,7 +9365,7 @@ export type ListSpecLibrariesByProjectData = {
9342
9365
  */
9343
9366
  freshness?: 'stale';
9344
9367
  /**
9345
- * Filter by status
9368
+ * Filter by status: one of the system statuses or one of the team's custom statuses for this resource type. Returns 400 for unknown values.
9346
9369
  */
9347
9370
  status?: BlueprintStatus;
9348
9371
  /**
@@ -9714,7 +9737,7 @@ export type ListPromptsData = {
9714
9737
  */
9715
9738
  search?: string;
9716
9739
  /**
9717
- * Filter by prompt status
9740
+ * Filter by status: one of the system statuses or one of the team's custom statuses for this resource type. Returns 400 for unknown values.
9718
9741
  */
9719
9742
  status?: PromptStatus;
9720
9743
  /**
package/dist/schema.d.ts CHANGED
@@ -5991,35 +5991,31 @@ export interface components {
5991
5991
  total_pages: number;
5992
5992
  };
5993
5993
  /**
5994
- * @description The complete status vocabulary shared by prompts, artifacts, blueprints and memories. Each resource type accepts a named subset of these values, never the whole set; see PromptStatus, ArtifactStatus, BlueprintStatus and MemoryStatus.
5994
+ * @description The system status vocabulary shared by prompts, artifacts, blueprints and memories. Each resource type has a named subset of these values as its system statuses; see PromptStatus, ArtifactStatus, BlueprintStatus and MemoryStatus. A team's custom status may not reuse any of these values.
5995
5995
  * @example active
5996
5996
  * @enum {string}
5997
5997
  */
5998
5998
  ResourceStatus: "active" | "draft" | "archived" | "published" | "expired";
5999
5999
  /**
6000
- * @description Publication status of a prompt. A prompt is only exposed over MCP once it is `published`.
6000
+ * @description Status of a prompt. The system values are `draft` and `published`; a prompt is only exposed over MCP once it is `published`. A team may define further statuses of its own for prompts, so this is an open string: any other value must be one of the team's custom prompt statuses, or the request is rejected with 400.
6001
6001
  * @example published
6002
- * @enum {string}
6003
6002
  */
6004
- PromptStatus: "draft" | "published";
6003
+ PromptStatus: string;
6005
6004
  /**
6006
- * @description Lifecycle status of an artifact.
6005
+ * @description Status of an artifact. The system values are `active`, `draft` and `archived`. A team may define further statuses of its own for artifacts, so this is an open string: any other value must be one of the team's custom artifact statuses, or the request is rejected with 400.
6007
6006
  * @example active
6008
- * @enum {string}
6009
6007
  */
6010
- ArtifactStatus: "active" | "draft" | "archived";
6008
+ ArtifactStatus: string;
6011
6009
  /**
6012
- * @description Lifecycle status of a blueprint. `expired` marks a blueprint whose rules no longer apply but whose content is kept for reference.
6010
+ * @description Status of a blueprint. The system values are `active` and `expired`; `expired` marks a blueprint whose rules no longer apply but whose content is kept for reference. A team may define further statuses of its own for blueprints, so this is an open string: any other value must be one of the team's custom blueprint statuses, or the request is rejected with 400.
6013
6011
  * @example active
6014
- * @enum {string}
6015
6012
  */
6016
- BlueprintStatus: "active" | "expired";
6013
+ BlueprintStatus: string;
6017
6014
  /**
6018
- * @description Lifecycle status of a memory.
6015
+ * @description Status of a memory. The system values are `active`, `draft` and `archived`. A team may define further statuses of its own for memories, so this is an open string: any other value must be one of the team's custom memory statuses, or the request is rejected with 400.
6019
6016
  * @example active
6020
- * @enum {string}
6021
6017
  */
6022
- MemoryStatus: "active" | "draft" | "archived";
6018
+ MemoryStatus: string;
6023
6019
  /** @description Per-source access counts for a single calendar day (UTC), zero-filled. */
6024
6020
  ResourceAccessDailyCount: {
6025
6021
  /**
@@ -13418,18 +13414,22 @@ export interface components {
13418
13414
  /**
13419
13415
  * Format: int64
13420
13416
  * @description The stored row's optimistic-lock version; null when nothing is stored.
13421
- * Send it back as `expected_version` to reject a save that would
13422
- * overwrite someone else's change.
13417
+ * Send it back as `expected_version` (`0` when it is null) to reject a
13418
+ * save that would overwrite someone else's change.
13423
13419
  * @example 4
13424
13420
  */
13425
13421
  version: number | null;
13426
13422
  };
13427
13423
  /**
13428
13424
  * @description A whole replacement of the instance search ranking defaults. Every value is
13429
- * required. `expected_version` is optional: when present, the save is
13430
- * rejected with 409 unless it equals the stored version (and when nothing is
13431
- * stored, any `expected_version` other than null is a conflict). Omit it for
13432
- * last-write-wins.
13425
+ * required. `expected_version` is optional and makes the save a
13426
+ * compare-and-set:
13427
+ *
13428
+ * - omitted or null: last-write-wins, never a conflict.
13429
+ * - `0`: nothing may be stored yet; the save is rejected with 409 when a row
13430
+ * is stored. Send it when the `version` last read was null.
13431
+ * - a positive value: the save is rejected with 409 unless it equals the
13432
+ * stored `version`, and also when nothing is stored.
13433
13433
  */
13434
13434
  AdminInstanceSearchSettingsUpdate: {
13435
13435
  recency_ranking_enabled: boolean;
@@ -13444,7 +13444,9 @@ export interface components {
13444
13444
  rank_candidate_cap: number;
13445
13445
  /**
13446
13446
  * Format: int64
13447
- * @description The `version` the caller last read; omit or null for last-write-wins.
13447
+ * @description The `version` the caller last read. Send `0` when that `version` was
13448
+ * null, to save only while nothing is stored. Omit it or send null for
13449
+ * last-write-wins. A negative value matches nothing and is a 409.
13448
13450
  */
13449
13451
  expected_version?: number | null;
13450
13452
  };
@@ -13540,18 +13542,22 @@ export interface components {
13540
13542
  /**
13541
13543
  * Format: int64
13542
13544
  * @description The stored row's optimistic-lock version; null when nothing is stored.
13543
- * Send it back as `expected_version` to reject a save that would
13544
- * overwrite someone else's change.
13545
+ * Send it back as `expected_version` (`0` when it is null) to reject a
13546
+ * save that would overwrite someone else's change.
13545
13547
  * @example 4
13546
13548
  */
13547
13549
  version: number | null;
13548
13550
  };
13549
13551
  /**
13550
13552
  * @description A whole replacement of the instance AI summary settings. Every value is
13551
- * required. `expected_version` is optional: when present, the save is
13552
- * rejected with 409 unless it equals the stored version (and when nothing is
13553
- * stored, any `expected_version` other than null is a conflict). Omit it for
13554
- * last-write-wins.
13553
+ * required. `expected_version` is optional and makes the save a
13554
+ * compare-and-set:
13555
+ *
13556
+ * - omitted or null: last-write-wins, never a conflict.
13557
+ * - `0`: nothing may be stored yet; the save is rejected with 409 when a row
13558
+ * is stored. Send it when the `version` last read was null.
13559
+ * - a positive value: the save is rejected with 409 unless it equals the
13560
+ * stored `version`, and also when nothing is stored.
13555
13561
  */
13556
13562
  AdminInstanceAISummarySettingsUpdate: {
13557
13563
  enabled: boolean;
@@ -13563,7 +13569,9 @@ export interface components {
13563
13569
  request_timeout_ms: number;
13564
13570
  /**
13565
13571
  * Format: int64
13566
- * @description The `version` the caller last read; omit or null for last-write-wins.
13572
+ * @description The `version` the caller last read. Send `0` when that `version` was
13573
+ * null, to save only while nothing is stored. Omit it or send null for
13574
+ * last-write-wins. A negative value matches nothing and is a 409.
13567
13575
  */
13568
13576
  expected_version?: number | null;
13569
13577
  };
@@ -13841,7 +13849,9 @@ export interface components {
13841
13849
  active: boolean;
13842
13850
  /**
13843
13851
  * Format: int64
13844
- * @description The stored allowlist's own version; null when nothing is stored.
13852
+ * @description The stored allowlist's own version; null when nothing is stored. Send
13853
+ * it back as `expected_version` (`0` when it is null) to reject a save
13854
+ * that would overwrite someone else's change.
13845
13855
  * @example 3
13846
13856
  */
13847
13857
  version: number | null;
@@ -13864,10 +13874,13 @@ export interface components {
13864
13874
  * is a DNS name of at least two labels with no leading `@`. Storing two empty
13865
13875
  * lists means open access.
13866
13876
  *
13867
- * `expected_version` is optional: when present, the save is rejected with
13868
- * 409 unless it equals the stored allowlist's `version` (and when nothing is
13869
- * stored, any `expected_version` other than null is a conflict). Omit it for
13870
- * last-write-wins.
13877
+ * `expected_version` is optional and makes the save a compare-and-set:
13878
+ *
13879
+ * - omitted or null: last-write-wins, never a conflict.
13880
+ * - `0`: no allowlist may be stored yet; the save is rejected with 409 when
13881
+ * one is. Send it when the `version` last read was null.
13882
+ * - a positive value: the save is rejected with 409 unless it equals the
13883
+ * stored allowlist's `version`, and also when nothing is stored.
13871
13884
  */
13872
13885
  AdminAuthAllowlistUpdate: {
13873
13886
  /**
@@ -13884,7 +13897,9 @@ export interface components {
13884
13897
  emails: string[];
13885
13898
  /**
13886
13899
  * Format: int64
13887
- * @description The `version` the caller last read; omit or null for last-write-wins.
13900
+ * @description The `version` the caller last read. Send `0` when that `version` was
13901
+ * null, to save only while nothing is stored. Omit it or send null for
13902
+ * last-write-wins. A negative value matches nothing and is a 409.
13888
13903
  */
13889
13904
  expected_version?: number | null;
13890
13905
  };
@@ -15231,7 +15246,7 @@ export interface operations {
15231
15246
  freshness?: "stale";
15232
15247
  /** @description Filter by project ID */
15233
15248
  project_id?: string;
15234
- /** @description Filter by status */
15249
+ /** @description Filter by status: one of the system statuses or one of the team's custom statuses for this resource type. Returns 400 for unknown values. */
15235
15250
  status?: components["schemas"]["ArtifactStatus"];
15236
15251
  /** @description Filter by type. An open string matched against the team's registered types (the system defaults work_reports, static_contexts and general, plus any custom types the team has added), not a fixed enum. */
15237
15252
  type?: string;
@@ -15412,7 +15427,7 @@ export interface operations {
15412
15427
  query?: {
15413
15428
  /** @description Filter to resources currently flagged stale by the team's freshness rules (epic #726). Omit for no freshness filtering. Returns 400 for any other value — a silently ignored filter would return the full list, which looks like a legitimate answer. */
15414
15429
  freshness?: "stale";
15415
- /** @description Filter by status */
15430
+ /** @description Filter by status: one of the system statuses or one of the team's custom statuses for this resource type. Returns 400 for unknown values. */
15416
15431
  status?: components["schemas"]["ArtifactStatus"];
15417
15432
  /** @description Filter by type. An open string matched against the team's registered types (the system defaults work_reports, static_contexts and general, plus any custom types the team has added), not a fixed enum. */
15418
15433
  type?: string;
@@ -17128,7 +17143,7 @@ export interface operations {
17128
17143
  project_name?: string;
17129
17144
  /** @description Filter by project ID. On this team-scoped variant the backend reads it only when a project is not already selected via a path parameter (i.e. not on listSpecLibrariesByProject). */
17130
17145
  project_id?: string;
17131
- /** @description Filter by status */
17146
+ /** @description Filter by status: one of the system statuses or one of the team's custom statuses for this resource type. Returns 400 for unknown values. */
17132
17147
  status?: components["schemas"]["BlueprintStatus"];
17133
17148
  /** @description Filter by type */
17134
17149
  type?: "general" | "claude-code" | "claude" | "cursor" | "codex";
@@ -17325,7 +17340,7 @@ export interface operations {
17325
17340
  query?: {
17326
17341
  /** @description Filter to resources currently flagged stale by the team's freshness rules (epic #726). Omit for no freshness filtering. Returns 400 for any other value — a silently ignored filter would return the full list, which looks like a legitimate answer. */
17327
17342
  freshness?: "stale";
17328
- /** @description Filter by status */
17343
+ /** @description Filter by status: one of the system statuses or one of the team's custom statuses for this resource type. Returns 400 for unknown values. */
17329
17344
  status?: components["schemas"]["BlueprintStatus"];
17330
17345
  /** @description Filter by type */
17331
17346
  type?: "general" | "claude-code" | "claude" | "cursor" | "codex";
@@ -17805,7 +17820,7 @@ export interface operations {
17805
17820
  limit?: number;
17806
17821
  /** @description Search term to filter prompts by name or description */
17807
17822
  search?: string;
17808
- /** @description Filter by prompt status */
17823
+ /** @description Filter by status: one of the system statuses or one of the team's custom statuses for this resource type. Returns 400 for unknown values. */
17809
17824
  status?: components["schemas"]["PromptStatus"];
17810
17825
  /**
17811
17826
  * @description Comma-separated list of labels to filter by. A resource matches when it carries at least one of the listed labels. At most 25 labels, each at most 50 characters; beyond that the request is rejected with 400.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@vibexp/api-client",
3
- "version": "0.98.0",
3
+ "version": "0.100.0",
4
4
  "description": "Typed VibeXP API client generated from the OpenAPI spec (openapi-fetch main entrypoint, axios SDK at ./axios)",
5
5
  "license": "MIT",
6
6
  "repository": {