node-s3tables 0.0.5 → 0.0.7

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

@@ -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;
@@ -187,7 +191,15 @@ interface SetCurrentCommitParams {
 }
 declare function setCurrentCommit(params: SetCurrentCommitParams): Promise<JSONObject>;
 
+declare class IcebergHttpError extends Error {
+    status: number;
+    text?: string;
+    body?: JSONObject;
+    constructor(status: number, body: JSONValue, message: string);
+}
+
 declare const _default: {
+    IcebergHttpError: typeof IcebergHttpError;
     getMetadata: typeof getMetadata;
     addSchema: typeof addSchema;
     addPartitionSpec: typeof addPartitionSpec;
@@ -196,5 +208,5 @@ declare const _default: {
     setCurrentCommit: typeof setCurrentCommit;
 };
 
-export { 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 { 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, IcebergUpdateResponse, SetCurrentCommitParams, TableLocation };

package/dist/index.js

@@ -1022,11 +1022,19 @@ function parse(text) {
     return LosslessJson__namespace.parse(text, null, customNumberParser);
 }
 
-class HttpError extends Error {
+class IcebergHttpError extends Error {
     status;
-    constructor(status, message) {
+    text;
+    body;
+    constructor(status, body, message) {
         super(message);
         this.status = status;
+        if (typeof body === 'string') {
+            this.text = body;
+        }
+        else if (body && typeof body === 'object') {
+            this.body = body;
+        }
     }
 }
 async function icebergRequest(params) {
@@ -1068,15 +1076,15 @@ async function icebergRequest(params) {
     }
     const res = await fetch(url, fetch_opts);
     const text = await res.text();
+    const ret = res.headers.get('content-type') === 'application/json'
+        ? _parse(text)
+        : text;
     if (!res.ok) {
         if (res.status) {
-            throw new HttpError(res.status, `request failed: ${res.statusText} ${text}`);
+            throw new IcebergHttpError(res.status, ret, `request failed: ${res.statusText} ${text}`);
         }
         throw new Error(`request failed: ${res.statusText} ${text}`);
     }
-    const ret = res.headers.get('content-type') === 'application/json'
-        ? _parse(text)
-        : text;
     return ret;
 }
 function _parse(text) {
@@ -1296,7 +1304,9 @@ async function addDataFiles(params) {
             };
         }
         catch (e) {
-            if (e instanceof HttpError && e.status === 409 && try_count < retry_max) ;
+            if (e instanceof IcebergHttpError &&
+                e.status === 409 &&
+                try_count < retry_max) ;
             else {
                 throw e;
             }
@@ -1358,6 +1368,7 @@ function _randomBigInt64() {
 }
 
 var index = {
+    IcebergHttpError,
     getMetadata,
     addSchema,
     addPartitionSpec,
@@ -1366,6 +1377,7 @@ var index = {
     setCurrentCommit,
 };
 
+exports.IcebergHttpError = IcebergHttpError;
 exports.addDataFiles = addDataFiles;
 exports.addManifest = addManifest;
 exports.addPartitionSpec = addPartitionSpec;

package/package.json

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