@objectstack/client 5.2.0 → 6.1.1

package/dist/index.d.mts

@@ -264,13 +264,13 @@ interface ClientConfig {
      */
     debug?: boolean;
     /**
-     * Active project id (UUID of `sys_project`). When present, the
-     * client injects an `X-Project-Id` header on every request so the
+     * Active project id (UUID of `sys_environment`). When present, the
+     * client injects an `X-Environment-Id` header on every request so the
      * server's tenant router can resolve the physical data-plane database.
      *
      * @see docs/adr/0002-project-database-isolation.md
      */
-    projectId?: string;
+    environmentId?: string;
 }
 /**
  * Discovery Result
@@ -374,7 +374,7 @@ interface StandardError {
 declare class ObjectStackClient {
     private baseUrl;
     private token?;
-    private projectId?;
+    private environmentId?;
     private fetchImpl;
     private discoveryInfo?;
     private logger;
@@ -607,12 +607,12 @@ declare class ObjectStackClient {
      * through this API.
      *
      * Endpoints:
-     * - GET    /api/v1/cloud/projects            → list environments
-     * - GET    /api/v1/cloud/projects/:id        → get one (with database info)
-     * - POST   /api/v1/cloud/projects            → provision a new project
-     * - PATCH  /api/v1/cloud/projects/:id        → update (displayName, plan, status, …)
-     * - POST   /api/v1/cloud/projects/:id/activate → set as session's active project
-     * - POST   /api/v1/cloud/projects/:id/credentials/rotate → rotate credential
+     * - GET    /api/v1/cloud/environments            → list environments
+     * - GET    /api/v1/cloud/environments/:id        → get one (with database info)
+     * - POST   /api/v1/cloud/environments            → provision a new project
+     * - PATCH  /api/v1/cloud/environments/:id        → update (displayName, plan, status, …)
+     * - POST   /api/v1/cloud/environments/:id/activate → set as session's active project
+     * - POST   /api/v1/cloud/environments/:id/credentials/rotate → rotate credential
      *
      * @see docs/adr/0002-project-database-isolation.md
      */
@@ -655,7 +655,7 @@ declare class ObjectStackClient {
             is_default?: boolean;
             is_system?: boolean;
             storage_limit_mb?: number;
-            clone_from_project_id?: string;
+            clone_from_environment_id?: string;
             template_id?: string;
             metadata?: Record<string, unknown>;
         }) => Promise<{
@@ -671,13 +671,13 @@ declare class ObjectStackClient {
         /**
          * Cascade-delete a project: cleans up credential/member/package_installation
          * rows, releases the physical database via the provisioning adapter, and
-         * removes the `sys_project` row. Default projects require `force: true`.
+         * removes the `sys_environment` row. Default projects require `force: true`.
          */
         delete: (id: string, opts?: {
             force?: boolean;
         }) => Promise<{
             deleted: boolean;
-            projectId: string;
+            environmentId: string;
             warnings: string[];
         }>;
         /**
@@ -745,7 +745,7 @@ declare class ObjectStackClient {
          * Branches without a head row (e.g. all rows demoted) are omitted.
          */
         listBranches: (id: string) => Promise<{
-            projectId: string;
+            environmentId: string;
             branches: Array<{
                 branch: string;
                 headCommitId: string;
@@ -761,7 +761,7 @@ declare class ObjectStackClient {
          * 409 if `to` already has rows.
          */
         renameBranch: (id: string, from: string, to: string) => Promise<{
-            projectId: string;
+            environmentId: string;
             from: string;
             to: string;
             renamed: number;
@@ -773,7 +773,7 @@ declare class ObjectStackClient {
          * deleted.
          */
         deleteBranch: (id: string, name: string) => Promise<{
-            projectId: string;
+            environmentId: string;
             branch: string;
             demoted: number;
             totalRevisions: number;
@@ -783,7 +783,7 @@ declare class ObjectStackClient {
          * Marks the target revision is_current=true and demotes the prior one.
          */
         activateRevision: (id: string, commitId: string) => Promise<{
-            projectId: string;
+            environmentId: string;
             commitId: string;
             activated: boolean;
             previousCommitId: string | null;
@@ -904,12 +904,12 @@ declare class ObjectStackClient {
      * Project-scoped client factory.
      *
      * Returns a thin wrapper around the data / meta / packages namespaces that
-     * prefixes every request with `/api/v1/projects/:projectId/...`. Use this
+     * prefixes every request with `/api/v1/environments/:environmentId/...`. Use this
      * when the server has `enableProjectScoping: true` in its REST API config.
      *
      * Backward compatibility: `client.data.*`, `client.meta.*`, and
      * `client.packages.*` continue to work unchanged; they hit unscoped routes
-     * and rely on hostname / `X-Project-Id` header / session resolution.
+     * and rely on hostname / `X-Environment-Id` header / session resolution.
      *
      * @example
      * ```ts
@@ -918,7 +918,7 @@ declare class ObjectStackClient {
      * const objects = await scoped.meta.getItems('object');
      * ```
      */
-    project(projectId: string): ScopedProjectClient;
+    project(environmentId: string): ScopedProjectClient;
     /** @internal */
     _baseUrl(): string;
     /** @internal */
@@ -1241,7 +1241,7 @@ declare class ObjectStackClient {
      * Update the active project id used for subsequent requests.
      * Pass `undefined` to clear (falls back to the session default).
      */
-    setProjectId(projectId: string | undefined): void;
+    setProjectId(environmentId: string | undefined): void;
     /**
      * Current active project id (if set).
      */
@@ -1924,7 +1924,7 @@ declare class ObjectStackClient {
  * Project-scoped sub-client.
  *
  * Wraps an {@link ObjectStackClient} and prefixes every request with
- * `/api/v1/projects/:projectId/...` so a single client instance can talk to
+ * `/api/v1/environments/:environmentId/...` so a single client instance can talk to
  * multiple projects without mutating global state.
  *
  * The scoped client exposes the same shape as the `data`, `meta`, `batch`,
@@ -1935,9 +1935,9 @@ declare class ObjectStackClient {
  */
 declare class ScopedProjectClient {
     private readonly parent;
-    private readonly projectId;
-    constructor(parent: ObjectStackClient, projectId: string);
-    /** The projectId this client is scoped to. */
+    private readonly environmentId;
+    constructor(parent: ObjectStackClient, environmentId: string);
+    /** The environmentId this client is scoped to. */
     getProjectId(): string;
     /** Prefix segment inserted between the baseUrl and the resource path. */
     private scope;
@@ -2005,7 +2005,7 @@ declare class ScopedProjectClient {
      * Automation (Flow) operations scoped to this project.
      *
      * Thin wrapper around the dispatcher's automation routes, mounted under
-     * `/api/v1/projects/:projectId/automation/...`. Surface mirrors the methods
+     * `/api/v1/environments/:environmentId/automation/...`. Surface mirrors the methods
      * needed by Studio's Flow viewer: read flow definition, execute (trigger),
      * list runs, fetch a single run.
      */

package/dist/index.d.ts

@@ -264,13 +264,13 @@ interface ClientConfig {
      */
     debug?: boolean;
     /**
-     * Active project id (UUID of `sys_project`). When present, the
-     * client injects an `X-Project-Id` header on every request so the
+     * Active project id (UUID of `sys_environment`). When present, the
+     * client injects an `X-Environment-Id` header on every request so the
      * server's tenant router can resolve the physical data-plane database.
      *
      * @see docs/adr/0002-project-database-isolation.md
      */
-    projectId?: string;
+    environmentId?: string;
 }
 /**
  * Discovery Result
@@ -374,7 +374,7 @@ interface StandardError {
 declare class ObjectStackClient {
     private baseUrl;
     private token?;
-    private projectId?;
+    private environmentId?;
     private fetchImpl;
     private discoveryInfo?;
     private logger;
@@ -607,12 +607,12 @@ declare class ObjectStackClient {
      * through this API.
      *
      * Endpoints:
-     * - GET    /api/v1/cloud/projects            → list environments
-     * - GET    /api/v1/cloud/projects/:id        → get one (with database info)
-     * - POST   /api/v1/cloud/projects            → provision a new project
-     * - PATCH  /api/v1/cloud/projects/:id        → update (displayName, plan, status, …)
-     * - POST   /api/v1/cloud/projects/:id/activate → set as session's active project
-     * - POST   /api/v1/cloud/projects/:id/credentials/rotate → rotate credential
+     * - GET    /api/v1/cloud/environments            → list environments
+     * - GET    /api/v1/cloud/environments/:id        → get one (with database info)
+     * - POST   /api/v1/cloud/environments            → provision a new project
+     * - PATCH  /api/v1/cloud/environments/:id        → update (displayName, plan, status, …)
+     * - POST   /api/v1/cloud/environments/:id/activate → set as session's active project
+     * - POST   /api/v1/cloud/environments/:id/credentials/rotate → rotate credential
      *
      * @see docs/adr/0002-project-database-isolation.md
      */
@@ -655,7 +655,7 @@ declare class ObjectStackClient {
             is_default?: boolean;
             is_system?: boolean;
             storage_limit_mb?: number;
-            clone_from_project_id?: string;
+            clone_from_environment_id?: string;
             template_id?: string;
             metadata?: Record<string, unknown>;
         }) => Promise<{
@@ -671,13 +671,13 @@ declare class ObjectStackClient {
         /**
          * Cascade-delete a project: cleans up credential/member/package_installation
          * rows, releases the physical database via the provisioning adapter, and
-         * removes the `sys_project` row. Default projects require `force: true`.
+         * removes the `sys_environment` row. Default projects require `force: true`.
          */
         delete: (id: string, opts?: {
             force?: boolean;
         }) => Promise<{
             deleted: boolean;
-            projectId: string;
+            environmentId: string;
             warnings: string[];
         }>;
         /**
@@ -745,7 +745,7 @@ declare class ObjectStackClient {
          * Branches without a head row (e.g. all rows demoted) are omitted.
          */
         listBranches: (id: string) => Promise<{
-            projectId: string;
+            environmentId: string;
             branches: Array<{
                 branch: string;
                 headCommitId: string;
@@ -761,7 +761,7 @@ declare class ObjectStackClient {
          * 409 if `to` already has rows.
          */
         renameBranch: (id: string, from: string, to: string) => Promise<{
-            projectId: string;
+            environmentId: string;
             from: string;
             to: string;
             renamed: number;
@@ -773,7 +773,7 @@ declare class ObjectStackClient {
          * deleted.
          */
         deleteBranch: (id: string, name: string) => Promise<{
-            projectId: string;
+            environmentId: string;
             branch: string;
             demoted: number;
             totalRevisions: number;
@@ -783,7 +783,7 @@ declare class ObjectStackClient {
          * Marks the target revision is_current=true and demotes the prior one.
          */
         activateRevision: (id: string, commitId: string) => Promise<{
-            projectId: string;
+            environmentId: string;
             commitId: string;
             activated: boolean;
             previousCommitId: string | null;
@@ -904,12 +904,12 @@ declare class ObjectStackClient {
      * Project-scoped client factory.
      *
      * Returns a thin wrapper around the data / meta / packages namespaces that
-     * prefixes every request with `/api/v1/projects/:projectId/...`. Use this
+     * prefixes every request with `/api/v1/environments/:environmentId/...`. Use this
      * when the server has `enableProjectScoping: true` in its REST API config.
      *
      * Backward compatibility: `client.data.*`, `client.meta.*`, and
      * `client.packages.*` continue to work unchanged; they hit unscoped routes
-     * and rely on hostname / `X-Project-Id` header / session resolution.
+     * and rely on hostname / `X-Environment-Id` header / session resolution.
      *
      * @example
      * ```ts
@@ -918,7 +918,7 @@ declare class ObjectStackClient {
      * const objects = await scoped.meta.getItems('object');
      * ```
      */
-    project(projectId: string): ScopedProjectClient;
+    project(environmentId: string): ScopedProjectClient;
     /** @internal */
     _baseUrl(): string;
     /** @internal */
@@ -1241,7 +1241,7 @@ declare class ObjectStackClient {
      * Update the active project id used for subsequent requests.
      * Pass `undefined` to clear (falls back to the session default).
      */
-    setProjectId(projectId: string | undefined): void;
+    setProjectId(environmentId: string | undefined): void;
     /**
      * Current active project id (if set).
      */
@@ -1924,7 +1924,7 @@ declare class ObjectStackClient {
  * Project-scoped sub-client.
  *
  * Wraps an {@link ObjectStackClient} and prefixes every request with
- * `/api/v1/projects/:projectId/...` so a single client instance can talk to
+ * `/api/v1/environments/:environmentId/...` so a single client instance can talk to
  * multiple projects without mutating global state.
  *
  * The scoped client exposes the same shape as the `data`, `meta`, `batch`,
@@ -1935,9 +1935,9 @@ declare class ObjectStackClient {
  */
 declare class ScopedProjectClient {
     private readonly parent;
-    private readonly projectId;
-    constructor(parent: ObjectStackClient, projectId: string);
-    /** The projectId this client is scoped to. */
+    private readonly environmentId;
+    constructor(parent: ObjectStackClient, environmentId: string);
+    /** The environmentId this client is scoped to. */
     getProjectId(): string;
     /** Prefix segment inserted between the baseUrl and the resource path. */
     private scope;
@@ -2005,7 +2005,7 @@ declare class ScopedProjectClient {
      * Automation (Flow) operations scoped to this project.
      *
      * Thin wrapper around the dispatcher's automation routes, mounted under
-     * `/api/v1/projects/:projectId/automation/...`. Surface mirrors the methods
+     * `/api/v1/environments/:environmentId/automation/...`. Surface mirrors the methods
      * needed by Studio's Flow viewer: read flow definition, execute (trigger),
      * list runs, fetch a single run.
      */