mixpeek 0.81.447 → 0.81.449
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.
|
@@ -12,7 +12,7 @@
|
|
|
12
12
|
import type { CreateBlobRequest } from './create-blob-request';
|
|
13
13
|
import type { EdgeModel } from './edge-model';
|
|
14
14
|
/**
|
|
15
|
-
* Request model for creating a bucket object. Objects can be created with blobs from two sources: 1. Direct data (URLs, base64) - Use CreateBlobRequest.data field 2. Upload references - Use CreateBlobRequest.upload_id field (from POST /buckets/{id}/uploads) Upload Reference Workflow: For large files or client-side uploads, use the presigned URL workflow: 1. POST /buckets/{id}/uploads → Returns {upload_id, presigned_url} 2. User uploads file to presigned_url (client-side) 3. POST /uploads/{upload_id}/confirm → Validates upload 4. POST /buckets/{id}/objects with upload_id in blobs (this endpoint) Use Cases: - Single blob with direct data (simple) - Multiple blobs from presigned uploads (recommended for large files) - Mix of direct data and upload references - Combine multiple uploads into one object See Also: - CreateBlobRequest for blob field documentation - POST /buckets/{id}/uploads for presigned URL generation
|
|
15
|
+
* Request model for creating a bucket object. Objects can be created with blobs from two sources: 1. Direct data (URLs, base64) - Use CreateBlobRequest.data field 2. Upload references - Use CreateBlobRequest.upload_id field (from POST /buckets/{id}/uploads) Upload Reference Workflow: For large files or client-side uploads, use the presigned URL workflow: 1. POST /buckets/{id}/uploads → Returns {upload_id, presigned_url} 2. User uploads file to presigned_url (client-side) 3. POST /uploads/{upload_id}/confirm → Validates upload 4. POST /buckets/{id}/objects with upload_id in blobs (this endpoint) Use Cases: - Single blob with direct data (simple) - Multiple blobs from presigned uploads (recommended for large files) - Mix of direct data and upload references - Combine multiple uploads into one object BACKE-3565: a thin subclass of shared.buckets.objects.models.CreateObjectRequest. It inherits the shared fields (key_prefix, blobs, skip_duplicates, canonicalize_source, force_remirror) and the ONE canonical ``normalize_blobs`` validator, adding only the api-surface fields below (idempotency_key, edges). Being a subclass, the field surface can only be a SUPERSET of the shared model, so a consumer reading a field one twin declares can never find the other twin omitting it (the BACKE-3564 bug shape). See Also: - CreateBlobRequest for blob field documentation - POST /buckets/{id}/uploads for presigned URL generation
|
|
16
16
|
* @export
|
|
17
17
|
* @interface CreateObjectRequest
|
|
18
18
|
*/
|
|
@@ -30,18 +30,6 @@ export interface CreateObjectRequest {
|
|
|
30
30
|
* @memberof CreateObjectRequest
|
|
31
31
|
*/
|
|
32
32
|
'blobs'?: Array<CreateBlobRequest>;
|
|
33
|
-
/**
|
|
34
|
-
* Typed, directed relationships from this object to other objects (customer-owned, root-level — never `_internal`). Populated by source adapters from companion/sidecar files, or directly on upsert. Flows to the document + MVS payload so the `traverse_edge` retriever stage can follow it.
|
|
35
|
-
* @type {Array<EdgeModel>}
|
|
36
|
-
* @memberof CreateObjectRequest
|
|
37
|
-
*/
|
|
38
|
-
'edges'?: Array<EdgeModel>;
|
|
39
|
-
/**
|
|
40
|
-
* Client-generated idempotency key for safe retries. If an object with the same idempotency_key already exists in this bucket, the existing object is returned instead of creating a duplicate. Use a UUID or deterministic hash per object.
|
|
41
|
-
* @type {string}
|
|
42
|
-
* @memberof CreateObjectRequest
|
|
43
|
-
*/
|
|
44
|
-
'idempotency_key'?: string;
|
|
45
33
|
/**
|
|
46
34
|
* Skip duplicate blobs, if a blob with the same hash already exists, it will be skipped.
|
|
47
35
|
* @type {boolean}
|
|
@@ -60,5 +48,17 @@ export interface CreateObjectRequest {
|
|
|
60
48
|
* @memberof CreateObjectRequest
|
|
61
49
|
*/
|
|
62
50
|
'force_remirror'?: boolean;
|
|
51
|
+
/**
|
|
52
|
+
* Typed, directed relationships from this object to other objects (customer-owned, root-level — never `_internal`). Populated by source adapters from companion/sidecar files, or directly on upsert. Flows to the document + MVS payload so the `traverse_edge` retriever stage can follow it.
|
|
53
|
+
* @type {Array<EdgeModel>}
|
|
54
|
+
* @memberof CreateObjectRequest
|
|
55
|
+
*/
|
|
56
|
+
'edges'?: Array<EdgeModel>;
|
|
57
|
+
/**
|
|
58
|
+
* Client-generated idempotency key for safe retries. If an object with the same idempotency_key already exists in this bucket, the existing object is returned instead of creating a duplicate. Use a UUID or deterministic hash per object.
|
|
59
|
+
* @type {string}
|
|
60
|
+
* @memberof CreateObjectRequest
|
|
61
|
+
*/
|
|
62
|
+
'idempotency_key'?: string;
|
|
63
63
|
}
|
|
64
64
|
//# sourceMappingURL=create-object-request.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"create-object-request.d.ts","sourceRoot":"","sources":["../../models/create-object-request.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;GAUG;AAKH,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,uBAAuB,CAAC;AAG/D,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AAE9C;;;;GAIG;AACH,MAAM,WAAW,mBAAmB;IAChC,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;IAEnB;;;;OAIG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;;;OAIG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,iBAAiB,CAAC,CAAC;IACnC;;;;OAIG;IACH,
|
|
1
|
+
{"version":3,"file":"create-object-request.d.ts","sourceRoot":"","sources":["../../models/create-object-request.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;GAUG;AAKH,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,uBAAuB,CAAC;AAG/D,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AAE9C;;;;GAIG;AACH,MAAM,WAAW,mBAAmB;IAChC,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;IAEnB;;;;OAIG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;;;OAIG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,iBAAiB,CAAC,CAAC;IACnC;;;;OAIG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B;;;;OAIG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAChC;;;;OAIG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B;;;;OAIG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC,CAAC;IAC3B;;;;OAIG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC9B"}
|
package/package.json
CHANGED