@ocxp/client 0.2.0 → 0.2.1

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 (5) hide show
  1. package/dist/index.cjs.map +1 -1
  2. package/dist/index.d.cts +49 -2
  3. package/dist/index.d.ts +49 -2
  4. package/dist/index.js.map +1 -1
  5. package/package.json +2 -2
package/dist/index.d.cts CHANGED
@@ -635,6 +635,18 @@ type ContentReadResponse = {
635
635
  metadata?: {
636
636
  [key: string]: unknown;
637
637
  } | null;
638
+ /**
639
+ * Version Id
640
+ *
641
+ * S3 version ID
642
+ */
643
+ version_id?: string | null;
644
+ /**
645
+ * Is Latest
646
+ *
647
+ * Whether this is the latest version
648
+ */
649
+ is_latest?: boolean | null;
638
650
  };
639
651
  /**
640
652
  * ContentStatsResponse
@@ -746,6 +758,12 @@ type ContentWriteResponse = {
746
758
  * Etag
747
759
  */
748
760
  etag?: string | null;
761
+ /**
762
+ * Version Id
763
+ *
764
+ * S3 version ID of the written object
765
+ */
766
+ version_id?: string | null;
749
767
  };
750
768
  /**
751
769
  * CreateMemoRequest
@@ -2510,6 +2528,8 @@ type BulkReadContentData = {
2510
2528
  path: {
2511
2529
  /**
2512
2530
  * Content Type
2531
+ *
2532
+ * Content type (mission, project, context, code, etc.)
2513
2533
  */
2514
2534
  content_type: string;
2515
2535
  };
@@ -2539,6 +2559,8 @@ type BulkWriteContentData = {
2539
2559
  path: {
2540
2560
  /**
2541
2561
  * Content Type
2562
+ *
2563
+ * Content type (mission, project, context, code, etc.)
2542
2564
  */
2543
2565
  content_type: string;
2544
2566
  };
@@ -2568,6 +2590,8 @@ type BulkDeleteContentData = {
2568
2590
  path: {
2569
2591
  /**
2570
2592
  * Content Type
2593
+ *
2594
+ * Content type (mission, project, context, code, etc.)
2571
2595
  */
2572
2596
  content_type: string;
2573
2597
  };
@@ -4268,6 +4292,8 @@ type ListContentData = {
4268
4292
  path: {
4269
4293
  /**
4270
4294
  * Content Type
4295
+ *
4296
+ * Content type (mission, project, context, code, etc.)
4271
4297
  */
4272
4298
  content_type: string;
4273
4299
  };
@@ -4314,6 +4340,8 @@ type QueryContentData = {
4314
4340
  path: {
4315
4341
  /**
4316
4342
  * Content Type
4343
+ *
4344
+ * Content type (mission, project, context, code, etc.)
4317
4345
  */
4318
4346
  content_type: string;
4319
4347
  };
@@ -4347,6 +4375,8 @@ type SearchContentData = {
4347
4375
  path: {
4348
4376
  /**
4349
4377
  * Content Type
4378
+ *
4379
+ * Content type (mission, project, context, code, etc.)
4350
4380
  */
4351
4381
  content_type: string;
4352
4382
  };
@@ -4389,6 +4419,8 @@ type GetContentTreeData = {
4389
4419
  path: {
4390
4420
  /**
4391
4421
  * Content Type
4422
+ *
4423
+ * Content type (mission, project, context, code, etc.)
4392
4424
  */
4393
4425
  content_type: string;
4394
4426
  };
@@ -4431,6 +4463,8 @@ type GetContentStatsData = {
4431
4463
  path: {
4432
4464
  /**
4433
4465
  * Content Type
4466
+ *
4467
+ * Content type (mission, project, context, code, etc.)
4434
4468
  */
4435
4469
  content_type: string;
4436
4470
  };
@@ -4467,6 +4501,8 @@ type DeleteContentData = {
4467
4501
  path: {
4468
4502
  /**
4469
4503
  * Content Type
4504
+ *
4505
+ * Content type (mission, project, context, code, etc.)
4470
4506
  */
4471
4507
  content_type: string;
4472
4508
  /**
@@ -4527,6 +4563,8 @@ type ReadContentData = {
4527
4563
  path: {
4528
4564
  /**
4529
4565
  * Content Type
4566
+ *
4567
+ * Content type (mission, project, context, code, etc.)
4530
4568
  */
4531
4569
  content_type: string;
4532
4570
  /**
@@ -4534,7 +4572,14 @@ type ReadContentData = {
4534
4572
  */
4535
4573
  content_id: string;
4536
4574
  };
4537
- query?: never;
4575
+ query?: {
4576
+ /**
4577
+ * Versionid
4578
+ *
4579
+ * S3 version ID to read a specific version
4580
+ */
4581
+ versionId?: string | null;
4582
+ };
4538
4583
  url: '/ocxp/context/{content_type}/{content_id}';
4539
4584
  };
4540
4585
  type ReadContentErrors = {
@@ -4564,6 +4609,8 @@ type WriteContentData = {
4564
4609
  path: {
4565
4610
  /**
4566
4611
  * Content Type
4612
+ *
4613
+ * Content type (mission, project, context, code, etc.)
4567
4614
  */
4568
4615
  content_type: string;
4569
4616
  /**
@@ -5234,7 +5281,7 @@ declare const deleteContent: <ThrowOnError extends boolean = false>(options: Opt
5234
5281
  /**
5235
5282
  * Read content
5236
5283
  *
5237
- * Reads content by type and path. Binary files are base64-encoded.
5284
+ * Reads content by type and path. Binary files are base64-encoded. Use versionId param to read a specific version.
5238
5285
  */
5239
5286
  declare const readContent: <ThrowOnError extends boolean = false>(options: Options<ReadContentData, ThrowOnError>) => RequestResult<ReadContentResponses, ReadContentErrors, ThrowOnError, "fields">;
5240
5287
  /**
package/dist/index.d.ts CHANGED
@@ -635,6 +635,18 @@ type ContentReadResponse = {
635
635
  metadata?: {
636
636
  [key: string]: unknown;
637
637
  } | null;
638
+ /**
639
+ * Version Id
640
+ *
641
+ * S3 version ID
642
+ */
643
+ version_id?: string | null;
644
+ /**
645
+ * Is Latest
646
+ *
647
+ * Whether this is the latest version
648
+ */
649
+ is_latest?: boolean | null;
638
650
  };
639
651
  /**
640
652
  * ContentStatsResponse
@@ -746,6 +758,12 @@ type ContentWriteResponse = {
746
758
  * Etag
747
759
  */
748
760
  etag?: string | null;
761
+ /**
762
+ * Version Id
763
+ *
764
+ * S3 version ID of the written object
765
+ */
766
+ version_id?: string | null;
749
767
  };
750
768
  /**
751
769
  * CreateMemoRequest
@@ -2510,6 +2528,8 @@ type BulkReadContentData = {
2510
2528
  path: {
2511
2529
  /**
2512
2530
  * Content Type
2531
+ *
2532
+ * Content type (mission, project, context, code, etc.)
2513
2533
  */
2514
2534
  content_type: string;
2515
2535
  };
@@ -2539,6 +2559,8 @@ type BulkWriteContentData = {
2539
2559
  path: {
2540
2560
  /**
2541
2561
  * Content Type
2562
+ *
2563
+ * Content type (mission, project, context, code, etc.)
2542
2564
  */
2543
2565
  content_type: string;
2544
2566
  };
@@ -2568,6 +2590,8 @@ type BulkDeleteContentData = {
2568
2590
  path: {
2569
2591
  /**
2570
2592
  * Content Type
2593
+ *
2594
+ * Content type (mission, project, context, code, etc.)
2571
2595
  */
2572
2596
  content_type: string;
2573
2597
  };
@@ -4268,6 +4292,8 @@ type ListContentData = {
4268
4292
  path: {
4269
4293
  /**
4270
4294
  * Content Type
4295
+ *
4296
+ * Content type (mission, project, context, code, etc.)
4271
4297
  */
4272
4298
  content_type: string;
4273
4299
  };
@@ -4314,6 +4340,8 @@ type QueryContentData = {
4314
4340
  path: {
4315
4341
  /**
4316
4342
  * Content Type
4343
+ *
4344
+ * Content type (mission, project, context, code, etc.)
4317
4345
  */
4318
4346
  content_type: string;
4319
4347
  };
@@ -4347,6 +4375,8 @@ type SearchContentData = {
4347
4375
  path: {
4348
4376
  /**
4349
4377
  * Content Type
4378
+ *
4379
+ * Content type (mission, project, context, code, etc.)
4350
4380
  */
4351
4381
  content_type: string;
4352
4382
  };
@@ -4389,6 +4419,8 @@ type GetContentTreeData = {
4389
4419
  path: {
4390
4420
  /**
4391
4421
  * Content Type
4422
+ *
4423
+ * Content type (mission, project, context, code, etc.)
4392
4424
  */
4393
4425
  content_type: string;
4394
4426
  };
@@ -4431,6 +4463,8 @@ type GetContentStatsData = {
4431
4463
  path: {
4432
4464
  /**
4433
4465
  * Content Type
4466
+ *
4467
+ * Content type (mission, project, context, code, etc.)
4434
4468
  */
4435
4469
  content_type: string;
4436
4470
  };
@@ -4467,6 +4501,8 @@ type DeleteContentData = {
4467
4501
  path: {
4468
4502
  /**
4469
4503
  * Content Type
4504
+ *
4505
+ * Content type (mission, project, context, code, etc.)
4470
4506
  */
4471
4507
  content_type: string;
4472
4508
  /**
@@ -4527,6 +4563,8 @@ type ReadContentData = {
4527
4563
  path: {
4528
4564
  /**
4529
4565
  * Content Type
4566
+ *
4567
+ * Content type (mission, project, context, code, etc.)
4530
4568
  */
4531
4569
  content_type: string;
4532
4570
  /**
@@ -4534,7 +4572,14 @@ type ReadContentData = {
4534
4572
  */
4535
4573
  content_id: string;
4536
4574
  };
4537
- query?: never;
4575
+ query?: {
4576
+ /**
4577
+ * Versionid
4578
+ *
4579
+ * S3 version ID to read a specific version
4580
+ */
4581
+ versionId?: string | null;
4582
+ };
4538
4583
  url: '/ocxp/context/{content_type}/{content_id}';
4539
4584
  };
4540
4585
  type ReadContentErrors = {
@@ -4564,6 +4609,8 @@ type WriteContentData = {
4564
4609
  path: {
4565
4610
  /**
4566
4611
  * Content Type
4612
+ *
4613
+ * Content type (mission, project, context, code, etc.)
4567
4614
  */
4568
4615
  content_type: string;
4569
4616
  /**
@@ -5234,7 +5281,7 @@ declare const deleteContent: <ThrowOnError extends boolean = false>(options: Opt
5234
5281
  /**
5235
5282
  * Read content
5236
5283
  *
5237
- * Reads content by type and path. Binary files are base64-encoded.
5284
+ * Reads content by type and path. Binary files are base64-encoded. Use versionId param to read a specific version.
5238
5285
  */
5239
5286
  declare const readContent: <ThrowOnError extends boolean = false>(options: Options<ReadContentData, ThrowOnError>) => RequestResult<ReadContentResponses, ReadContentErrors, ThrowOnError, "fields">;
5240
5287
  /**