@ocxp/client 0.2.0 → 0.2.3

package/dist/index.d.cts

@@ -635,6 +635,18 @@ type ContentReadResponse = {
     metadata?: {
         [key: string]: unknown;
     } | null;
+    /**
+     * Version Id
+     *
+     * S3 version ID
+     */
+    version_id?: string | null;
+    /**
+     * Is Latest
+     *
+     * Whether this is the latest version
+     */
+    is_latest?: boolean | null;
 };
 /**
  * ContentStatsResponse
@@ -669,6 +681,10 @@ type ContentTreeNode = {
      * Name
      */
     name: string;
+    /**
+     * Path
+     */
+    path: string;
     /**
      * Type
      */
@@ -677,6 +693,10 @@ type ContentTreeNode = {
      * Size
      */
     size?: number | null;
+    /**
+     * Version Id
+     */
+    version_id?: string | null;
     /**
      * Children
      */
@@ -746,6 +766,12 @@ type ContentWriteResponse = {
      * Etag
      */
     etag?: string | null;
+    /**
+     * Version Id
+     *
+     * S3 version ID of the written object
+     */
+    version_id?: string | null;
 };
 /**
  * CreateMemoRequest
@@ -2510,6 +2536,8 @@ type BulkReadContentData = {
     path: {
         /**
          * Content Type
+         *
+         * Content type (mission, project, context, code, etc.)
          */
         content_type: string;
     };
@@ -2539,6 +2567,8 @@ type BulkWriteContentData = {
     path: {
         /**
          * Content Type
+         *
+         * Content type (mission, project, context, code, etc.)
          */
         content_type: string;
     };
@@ -2568,6 +2598,8 @@ type BulkDeleteContentData = {
     path: {
         /**
          * Content Type
+         *
+         * Content type (mission, project, context, code, etc.)
          */
         content_type: string;
     };
@@ -4268,6 +4300,8 @@ type ListContentData = {
     path: {
         /**
          * Content Type
+         *
+         * Content type (mission, project, context, code, etc.)
          */
         content_type: string;
     };
@@ -4314,6 +4348,8 @@ type QueryContentData = {
     path: {
         /**
          * Content Type
+         *
+         * Content type (mission, project, context, code, etc.)
          */
         content_type: string;
     };
@@ -4347,6 +4383,8 @@ type SearchContentData = {
     path: {
         /**
          * Content Type
+         *
+         * Content type (mission, project, context, code, etc.)
          */
         content_type: string;
     };
@@ -4389,6 +4427,8 @@ type GetContentTreeData = {
     path: {
         /**
          * Content Type
+         *
+         * Content type (mission, project, context, code, etc.)
          */
         content_type: string;
     };
@@ -4405,6 +4445,12 @@ type GetContentTreeData = {
          * Maximum tree depth
          */
         depth?: number;
+        /**
+         * Includeversions
+         *
+         * Include S3 version IDs for files
+         */
+        includeVersions?: boolean;
     };
     url: '/ocxp/context/{content_type}/tree';
 };
@@ -4431,6 +4477,8 @@ type GetContentStatsData = {
     path: {
         /**
          * Content Type
+         *
+         * Content type (mission, project, context, code, etc.)
          */
         content_type: string;
     };
@@ -4467,6 +4515,8 @@ type DeleteContentData = {
     path: {
         /**
          * Content Type
+         *
+         * Content type (mission, project, context, code, etc.)
          */
         content_type: string;
         /**
@@ -4527,6 +4577,8 @@ type ReadContentData = {
     path: {
         /**
          * Content Type
+         *
+         * Content type (mission, project, context, code, etc.)
          */
         content_type: string;
         /**
@@ -4534,7 +4586,14 @@ type ReadContentData = {
          */
         content_id: string;
     };
-    query?: never;
+    query?: {
+        /**
+         * Versionid
+         *
+         * S3 version ID to read a specific version
+         */
+        versionId?: string | null;
+    };
     url: '/ocxp/context/{content_type}/{content_id}';
 };
 type ReadContentErrors = {
@@ -4564,6 +4623,8 @@ type WriteContentData = {
     path: {
         /**
          * Content Type
+         *
+         * Content type (mission, project, context, code, etc.)
          */
         content_type: string;
         /**
@@ -5234,7 +5295,7 @@ declare const deleteContent: <ThrowOnError extends boolean = false>(options: Opt
 /**
  * Read content
  *
- * Reads content by type and path. Binary files are base64-encoded.
+ * Reads content by type and path. Binary files are base64-encoded. Use versionId param to read a specific version.
  */
 declare const readContent: <ThrowOnError extends boolean = false>(options: Options<ReadContentData, ThrowOnError>) => RequestResult<ReadContentResponses, ReadContentErrors, ThrowOnError, "fields">;
 /**
@@ -5450,8 +5511,9 @@ declare class OCXPClient {
     }>;
     /**
      * Get hierarchical tree structure from S3 context
+     * @param includeVersions - If true, includes S3 version IDs for files
      */
-    tree(type: ContentTypeValue, path?: string, depth?: number): Promise<ContentTreeResponse>;
+    tree(type: ContentTypeValue, path?: string, depth?: number, includeVersions?: boolean): Promise<ContentTreeResponse>;
     /**
      * Get content statistics
      */
@@ -5942,9 +6004,10 @@ declare class MissionNamespace {
     }>;
     /**
      * Get mission content tree structure from S3
-     * @example ocxp.mission.tree('subfolder', 5)
+     * @param includeVersions - If true, includes S3 version IDs for files
+     * @example ocxp.mission.tree('mission-id', 5, true)
      */
-    tree(path?: string, depth?: number): Promise<ContentTreeResponse>;
+    tree(path?: string, depth?: number, includeVersions?: boolean): Promise<ContentTreeResponse>;
 }
 /**
  * Project namespace for convenient project operations
@@ -6009,9 +6072,10 @@ declare class ProjectNamespace {
     removeMission(projectId: string, missionId: string): Promise<ProjectResponse>;
     /**
      * Get project content tree structure from S3
-     * @example ocxp.project.tree('subfolder', 5)
+     * @param includeVersions - If true, includes S3 version IDs for files
+     * @example ocxp.project.tree('subfolder', 5, true)
      */
-    tree(path?: string, depth?: number): Promise<ContentTreeResponse>;
+    tree(path?: string, depth?: number, includeVersions?: boolean): Promise<ContentTreeResponse>;
 }
 /**
  * Session namespace for convenient session operations
@@ -7071,6 +7135,7 @@ interface TreeNode {
     path: string;
     type: 'file' | 'directory';
     size?: number;
+    version_id?: string;
     children?: TreeNode[];
 }
 /**

package/dist/index.d.ts

@@ -635,6 +635,18 @@ type ContentReadResponse = {
     metadata?: {
         [key: string]: unknown;
     } | null;
+    /**
+     * Version Id
+     *
+     * S3 version ID
+     */
+    version_id?: string | null;
+    /**
+     * Is Latest
+     *
+     * Whether this is the latest version
+     */
+    is_latest?: boolean | null;
 };
 /**
  * ContentStatsResponse
@@ -669,6 +681,10 @@ type ContentTreeNode = {
      * Name
      */
     name: string;
+    /**
+     * Path
+     */
+    path: string;
     /**
      * Type
      */
@@ -677,6 +693,10 @@ type ContentTreeNode = {
      * Size
      */
     size?: number | null;
+    /**
+     * Version Id
+     */
+    version_id?: string | null;
     /**
      * Children
      */
@@ -746,6 +766,12 @@ type ContentWriteResponse = {
      * Etag
      */
     etag?: string | null;
+    /**
+     * Version Id
+     *
+     * S3 version ID of the written object
+     */
+    version_id?: string | null;
 };
 /**
  * CreateMemoRequest
@@ -2510,6 +2536,8 @@ type BulkReadContentData = {
     path: {
         /**
          * Content Type
+         *
+         * Content type (mission, project, context, code, etc.)
          */
         content_type: string;
     };
@@ -2539,6 +2567,8 @@ type BulkWriteContentData = {
     path: {
         /**
          * Content Type
+         *
+         * Content type (mission, project, context, code, etc.)
          */
         content_type: string;
     };
@@ -2568,6 +2598,8 @@ type BulkDeleteContentData = {
     path: {
         /**
          * Content Type
+         *
+         * Content type (mission, project, context, code, etc.)
          */
         content_type: string;
     };
@@ -4268,6 +4300,8 @@ type ListContentData = {
     path: {
         /**
          * Content Type
+         *
+         * Content type (mission, project, context, code, etc.)
          */
         content_type: string;
     };
@@ -4314,6 +4348,8 @@ type QueryContentData = {
     path: {
         /**
          * Content Type
+         *
+         * Content type (mission, project, context, code, etc.)
          */
         content_type: string;
     };
@@ -4347,6 +4383,8 @@ type SearchContentData = {
     path: {
         /**
          * Content Type
+         *
+         * Content type (mission, project, context, code, etc.)
          */
         content_type: string;
     };
@@ -4389,6 +4427,8 @@ type GetContentTreeData = {
     path: {
         /**
          * Content Type
+         *
+         * Content type (mission, project, context, code, etc.)
          */
         content_type: string;
     };
@@ -4405,6 +4445,12 @@ type GetContentTreeData = {
          * Maximum tree depth
          */
         depth?: number;
+        /**
+         * Includeversions
+         *
+         * Include S3 version IDs for files
+         */
+        includeVersions?: boolean;
     };
     url: '/ocxp/context/{content_type}/tree';
 };
@@ -4431,6 +4477,8 @@ type GetContentStatsData = {
     path: {
         /**
          * Content Type
+         *
+         * Content type (mission, project, context, code, etc.)
          */
         content_type: string;
     };
@@ -4467,6 +4515,8 @@ type DeleteContentData = {
     path: {
         /**
          * Content Type
+         *
+         * Content type (mission, project, context, code, etc.)
          */
         content_type: string;
         /**
@@ -4527,6 +4577,8 @@ type ReadContentData = {
     path: {
         /**
          * Content Type
+         *
+         * Content type (mission, project, context, code, etc.)
          */
         content_type: string;
         /**
@@ -4534,7 +4586,14 @@ type ReadContentData = {
          */
         content_id: string;
     };
-    query?: never;
+    query?: {
+        /**
+         * Versionid
+         *
+         * S3 version ID to read a specific version
+         */
+        versionId?: string | null;
+    };
     url: '/ocxp/context/{content_type}/{content_id}';
 };
 type ReadContentErrors = {
@@ -4564,6 +4623,8 @@ type WriteContentData = {
     path: {
         /**
          * Content Type
+         *
+         * Content type (mission, project, context, code, etc.)
          */
         content_type: string;
         /**
@@ -5234,7 +5295,7 @@ declare const deleteContent: <ThrowOnError extends boolean = false>(options: Opt
 /**
  * Read content
  *
- * Reads content by type and path. Binary files are base64-encoded.
+ * Reads content by type and path. Binary files are base64-encoded. Use versionId param to read a specific version.
  */
 declare const readContent: <ThrowOnError extends boolean = false>(options: Options<ReadContentData, ThrowOnError>) => RequestResult<ReadContentResponses, ReadContentErrors, ThrowOnError, "fields">;
 /**
@@ -5450,8 +5511,9 @@ declare class OCXPClient {
     }>;
     /**
      * Get hierarchical tree structure from S3 context
+     * @param includeVersions - If true, includes S3 version IDs for files
      */
-    tree(type: ContentTypeValue, path?: string, depth?: number): Promise<ContentTreeResponse>;
+    tree(type: ContentTypeValue, path?: string, depth?: number, includeVersions?: boolean): Promise<ContentTreeResponse>;
     /**
      * Get content statistics
      */
@@ -5942,9 +6004,10 @@ declare class MissionNamespace {
     }>;
     /**
      * Get mission content tree structure from S3
-     * @example ocxp.mission.tree('subfolder', 5)
+     * @param includeVersions - If true, includes S3 version IDs for files
+     * @example ocxp.mission.tree('mission-id', 5, true)
      */
-    tree(path?: string, depth?: number): Promise<ContentTreeResponse>;
+    tree(path?: string, depth?: number, includeVersions?: boolean): Promise<ContentTreeResponse>;
 }
 /**
  * Project namespace for convenient project operations
@@ -6009,9 +6072,10 @@ declare class ProjectNamespace {
     removeMission(projectId: string, missionId: string): Promise<ProjectResponse>;
     /**
      * Get project content tree structure from S3
-     * @example ocxp.project.tree('subfolder', 5)
+     * @param includeVersions - If true, includes S3 version IDs for files
+     * @example ocxp.project.tree('subfolder', 5, true)
      */
-    tree(path?: string, depth?: number): Promise<ContentTreeResponse>;
+    tree(path?: string, depth?: number, includeVersions?: boolean): Promise<ContentTreeResponse>;
 }
 /**
  * Session namespace for convenient session operations
@@ -7071,6 +7135,7 @@ interface TreeNode {
     path: string;
     type: 'file' | 'directory';
     size?: number;
+    version_id?: string;
     children?: TreeNode[];
 }
 /**

package/dist/index.js

@@ -1544,13 +1544,14 @@ var OCXPClient = class {
   // ============== Tree & Stats ==============
   /**
    * Get hierarchical tree structure from S3 context
+   * @param includeVersions - If true, includes S3 version IDs for files
    */
-  async tree(type, path, depth) {
+  async tree(type, path, depth, includeVersions) {
     const headers = await this.getHeaders();
     const response = await getContentTree({
       client: this.client,
       path: { content_type: type },
-      query: { path, depth },
+      query: { path, depth, includeVersions },
       headers
     });
     return extractData(response);
@@ -2497,10 +2498,11 @@ var MissionNamespace = class {
   }
   /**
    * Get mission content tree structure from S3
-   * @example ocxp.mission.tree('subfolder', 5)
+   * @param includeVersions - If true, includes S3 version IDs for files
+   * @example ocxp.mission.tree('mission-id', 5, true)
    */
-  async tree(path, depth) {
-    return this.client.tree("mission", path, depth);
+  async tree(path, depth, includeVersions) {
+    return this.client.tree("mission", path, depth, includeVersions);
   }
 };
 var ProjectNamespace = class {
@@ -2578,10 +2580,11 @@ var ProjectNamespace = class {
   }
   /**
    * Get project content tree structure from S3
-   * @example ocxp.project.tree('subfolder', 5)
+   * @param includeVersions - If true, includes S3 version IDs for files
+   * @example ocxp.project.tree('subfolder', 5, true)
    */
-  async tree(path, depth) {
-    return this.client.tree("project", path, depth);
+  async tree(path, depth, includeVersions) {
+    return this.client.tree("project", path, depth, includeVersions);
   }
 };
 var SessionNamespace = class {
@@ -3410,6 +3413,7 @@ var TreeNodeSchema = z.lazy(
     path: z.string(),
     type: z.enum(["file", "directory"]),
     size: z.number().optional(),
+    version_id: z.string().optional(),
     children: z.array(TreeNodeSchema).optional()
   })
 );