node-s3tables 0.0.6 → 0.0.8

package/README.md

@@ -81,10 +81,10 @@ Adds a new schema to an S3 table and sets it as current.
 - `params.fields` (IcebergSchemaField[]) - Array of schema fields
 - `params.credentials` (AwsCredentialIdentity, optional) - AWS credentials
 
-**Returns:** Promise<string>
+**Returns:** Promise<IcebergUpdateResponse>
 
 ```javascript
-await addSchema({
+const result = await addSchema({
   tableBucketARN: 'arn:aws:s3tables:us-west-2:123456789012:bucket/my-bucket',
   namespace: 'sales',
   name: 'daily_sales',
@@ -95,6 +95,9 @@ await addSchema({
     { id: 3, name: 'sales_amount', required: false, type: 'double' },
   ],
 });
+
+// result.metadata contains the updated table metadata
+// result['metadata-location'] contains the S3 path to the new metadata file
 ```
 
 ### addPartitionSpec(params)
@@ -110,7 +113,7 @@ Adds a new partition specification to an S3 table and sets it as default.
 - `params.fields` (IcebergPartitionField[]) - Array of partition fields
 - `params.credentials` (AwsCredentialIdentity, optional) - AWS credentials
 
-**Returns:** Promise<string>
+**Returns:** Promise<IcebergUpdateResponse>
 
 ```javascript
 await addPartitionSpec({
@@ -232,6 +235,15 @@ await setCurrentCommit({
 
 ## Type Definitions
 
+### IcebergUpdateResponse
+
+```typescript
+interface IcebergUpdateResponse {
+  metadata: IcebergMetadata;
+  'metadata-location': string;
+}
+```
+
 ### AddFileList
 
 ```typescript

package/dist/index.d.ts

@@ -87,7 +87,7 @@ interface IcebergMetadata {
     'default-spec-id': number;
     'partition-specs': IcebergPartitionSpec[];
     'last-partition-id': number;
-    'current-snapshot-id'?: bigint | number;
+    'current-snapshot-id': bigint | number;
     location: string;
 }
 
@@ -119,13 +119,6 @@ interface AddManifestParams {
 }
 declare function addManifest(params: AddManifestParams): Promise<ManifestListRecord>;
 
-type JSONPrimitive = string | number | boolean | null | bigint | undefined;
-type JSONValue = JSONPrimitive | JSONObject | JSONArray;
-interface JSONObject {
-    [key: string]: JSONValue;
-}
-type JSONArray = JSONValue[];
-
 type TableLocation = {
     tableArn: string;
 } | {
@@ -146,7 +139,11 @@ interface AddSchemaParams {
     schemaId: number;
     fields: IcebergSchemaField[];
 }
-declare function addSchema(params: AddSchemaParams): Promise<JSONObject>;
+interface IcebergUpdateResponse {
+    metadata: IcebergMetadata;
+    'metadata-location': string;
+}
+declare function addSchema(params: AddSchemaParams): Promise<IcebergUpdateResponse>;
 interface AddPartitionSpecParams {
     credentials?: AwsCredentialIdentity;
     tableBucketARN: string;
@@ -155,7 +152,14 @@ interface AddPartitionSpecParams {
     specId: number;
     fields: IcebergPartitionField[];
 }
-declare function addPartitionSpec(params: AddPartitionSpecParams): Promise<JSONObject>;
+declare function addPartitionSpec(params: AddPartitionSpecParams): Promise<IcebergUpdateResponse>;
+
+type JSONPrimitive = string | number | boolean | null | bigint | undefined;
+type JSONValue = JSONPrimitive | JSONObject | JSONArray;
+interface JSONObject {
+    [key: string]: JSONValue;
+}
+type JSONArray = JSONValue[];
 
 interface AddFileList {
     specId: number;
@@ -167,6 +171,7 @@ interface AddDataFilesParams {
     tableBucketARN: string;
     namespace: string;
     name: string;
+    snapshotId?: bigint;
     lists: AddFileList[];
     retryCount?: number;
 }
@@ -205,4 +210,4 @@ declare const _default: {
 };
 
 export { IcebergHttpError, addDataFiles, addManifest, addPartitionSpec, addSchema, _default as default, getMetadata, setCurrentCommit };
-export type { AddDataFilesParams, AddDataFilesResult, AddFile, AddFileList, AddManifestParams, AddPartitionSpecParams, AddSchemaParams, GetMetadataParams, IcebergComplexType, IcebergMetadata, IcebergPartitionField, IcebergPartitionSpec, IcebergPrimitiveType, IcebergSchema, IcebergSchemaField, IcebergSnapshot, IcebergSnapshotSummary, IcebergTransform, IcebergType, SetCurrentCommitParams, TableLocation };
+export type { AddDataFilesParams, AddDataFilesResult, AddFile, AddFileList, AddManifestParams, AddPartitionSpecParams, AddSchemaParams, GetMetadataParams, IcebergComplexType, IcebergMetadata, IcebergPartitionField, IcebergPartitionSpec, IcebergPrimitiveType, IcebergSchema, IcebergSchemaField, IcebergSnapshot, IcebergSnapshotSummary, IcebergTransform, IcebergType, IcebergUpdateResponse, SetCurrentCommitParams, TableLocation };

package/dist/index.js

@@ -1177,10 +1177,10 @@ async function addDataFiles(params) {
     if (!region) {
         throw new Error('bad tableBucketARN');
     }
-    const snapshot_id = _randomBigInt64();
+    const snapshot_id = params.snapshotId ?? _randomBigInt64();
     const metadata = await getMetadata(params);
     const bucket = metadata.location.split('/').slice(-1)[0];
-    const parent_snapshot_id = BigInt(metadata['current-snapshot-id'] ?? -1n);
+    const parent_snapshot_id = BigInt(metadata['current-snapshot-id']);
     const snapshot = metadata.snapshots.find((s) => s['snapshot-id'] === parent_snapshot_id) ??
         null;
     if (!bucket) {
@@ -1313,7 +1313,7 @@ async function addDataFiles(params) {
         }
         // we do a merge in the append only simultanious case
         const conflict_metadata = await getMetadata(params);
-        const conflict_snapshot_id = BigInt(conflict_metadata['current-snapshot-id'] ?? -1n);
+        const conflict_snapshot_id = BigInt(conflict_metadata['current-snapshot-id']);
         if (conflict_snapshot_id <= 0n) {
             throw new Error('conflict');
         }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "node-s3tables",
-  "version": "0.0.6",
+  "version": "0.0.8",
   "description": "node api for dealing with s3tables",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",