@xbbg/core 1.4.1 → 1.4.2

package/dist/index.d.ts

@@ -74,6 +74,26 @@ interface StringPair {
     key: string;
     value: string;
 }
+type SeatType = 'BPS' | 'NONBPS' | 'INVALID';
+interface EntitlementReport {
+    entitled: boolean;
+    failedEids: number[];
+}
+interface BloombergMetadataError {
+    category?: string;
+    code?: string | number;
+    subcategory?: string;
+    message?: string;
+}
+interface BloombergFieldException extends BloombergMetadataError {
+    field?: string;
+}
+interface ResultMetadata {
+    metadata: Record<string, string>;
+    eidData?: Record<string, number[]>;
+    securityErrors?: Record<string, BloombergMetadataError>;
+    fieldExceptions?: Record<string, BloombergFieldException[]>;
+}
 interface ServerAddress {
     host: string;
     port: number;
@@ -185,6 +205,7 @@ interface RequestInput {
     options?: readonly StringPair[];
     fieldTypes?: readonly StringPair[];
     includeSecurityErrors?: boolean;
+    returnEids?: boolean;
     validateFields?: boolean;
     searchSpec?: string;
     fieldIds?: readonly string[];
@@ -237,6 +258,7 @@ interface BdpOptions {
     format?: string;
     backend?: BackendKind;
     includeSecurityErrors?: boolean;
+    returnEids?: boolean;
     validateFields?: boolean;
 }
 interface BdhOptions {
@@ -246,6 +268,7 @@ interface BdhOptions {
     kwargs?: OverridesMap;
     format?: string;
     backend?: BackendKind;
+    returnEids?: boolean;
     validateFields?: boolean;
 }
 interface BdibOptions {
@@ -508,6 +531,7 @@ interface NativeArrowZeroCopyBatch {
     readonly kind: 'zeroCopy';
     readonly numRows: number;
     readonly columns: NativeArrowColumn[];
+    readonly metadata: Record<string, string>;
 }
 type NativeUpdateValue = null | boolean | number | string;
 interface NativeSubscriptionUpdate {
@@ -641,6 +665,30 @@ declare class Engine {
      * session timeout) — prefer this factory in servers.
      */
     static connect(config?: EngineConfig): Promise<Engine>;
+    /**
+     * Return the Bloomberg identity seat type: "BPS", "NONBPS", or "INVALID".
+     *
+     * Identity operations authorize lazily using the engine auth config when
+     * configured, otherwise the Desktop terminal OS-logon user. The first call
+     * may block for a few seconds and transient failures are retryable.
+     */
+    seatType(): Promise<SeatType>;
+    /**
+     * Check whether the authorized identity is entitled to all supplied EIDs.
+     *
+     * Identity operations authorize lazily using the engine auth config when
+     * configured, otherwise the Desktop terminal OS-logon user. The first call
+     * may block for a few seconds and transient failures are retryable.
+     */
+    checkEntitlements(service: string, eids: readonly number[]): Promise<EntitlementReport>;
+    /**
+     * Return whether the authorized identity may use the Bloomberg service.
+     *
+     * Identity operations authorize lazily using the engine auth config when
+     * configured, otherwise the Desktop terminal OS-logon user. The first call
+     * may block for a few seconds and transient failures are retryable.
+     */
+    identityIsAuthorized(service: string): Promise<boolean>;
     request(params: RequestInput): Promise<unknown>;
     requestRaw(params: RequestInput): Promise<Buffer>;
     bdp(tickers: readonly string[], fields: readonly string[], options?: BdpOptions): Promise<unknown>;
@@ -792,4 +840,4 @@ declare function version(): string;
 declare const setLogLevel: (level: string) => void;
 declare const getLogLevel: () => string;
 
-export { type ActiveCdxOptions, ArrowSubscription, type AuthConfig, Backend, type BackendKind, type BdhOptions, type BdibOptions, type BdpOptions, type BdtickOptions, type BeqsOptions, type BfldsOptions, type BlkpOptions, BlpError, BlpInternalError, BlpLimitError, BlpRequestError, BlpSessionError, BlpTimeoutError, BlpValidationError, type BqlOptions, type BqrOptions, type BsrchOptions, type BtaOptions, CDX_INFO_FIELDS, CDX_PRICING_FIELDS, CDX_RISK_FIELDS, type CdxOptions, type CdxTickerInfo, type CorporateBondsOptions, type DateLike, type DateTimeLike, type DividendOptions, type DividendYieldOptions, Engine, type EngineConfig, type EtfHoldingsOptions, type ExchangeInfoResult, type ExchangeOverrideInput, FieldHandle, type FieldInfo, Format, type FormatKind, type FuturesCandidate, type FuturesCurveOptions, type FuturesResolveOptions, type FxPairInfo, type IndexMembersOptions, type MarketRule, type OverrideEntry, type OverrideNestedSource, type OverrideObject, type OverrideSource, OverrideSpec, type OverrideSpecLike, type OverrideValue, type OverridesInput, type OverridesMap, type PreferredsOptions, type PrimitiveValue, type RecipeBackendOptions, type RequestInput, type RequestOptions, type SecurityOverrideSpec, type ServerAddress, type SessionWindowsInfo, type Socks5Config, type StreamOptions, type StringPair, Subscription, type SubscriptionStats, Tick, type TickValue, type TickerParts, type TimeRange, type TlsConfig, type TurnoverOptions, type VolFieldSpec, type VolSurfaceOptions, type VolSurfacePreset, type YasOptions, abdh, abdib, abdp, abds, abdtick, asubscribe, bdh, bdib, bdp, bds, bdtick, blp, configure, connect, ext, formatDate, formatDateTime, getLogLevel, ovr, setLogLevel, subscribe, version, wrapError };
+export { type ActiveCdxOptions, ArrowSubscription, type AuthConfig, Backend, type BackendKind, type BdhOptions, type BdibOptions, type BdpOptions, type BdtickOptions, type BeqsOptions, type BfldsOptions, type BlkpOptions, type BloombergFieldException, type BloombergMetadataError, BlpError, BlpInternalError, BlpLimitError, BlpRequestError, BlpSessionError, BlpTimeoutError, BlpValidationError, type BqlOptions, type BqrOptions, type BsrchOptions, type BtaOptions, CDX_INFO_FIELDS, CDX_PRICING_FIELDS, CDX_RISK_FIELDS, type CdxOptions, type CdxTickerInfo, type CorporateBondsOptions, type DateLike, type DateTimeLike, type DividendOptions, type DividendYieldOptions, Engine, type EngineConfig, type EntitlementReport, type EtfHoldingsOptions, type ExchangeInfoResult, type ExchangeOverrideInput, FieldHandle, type FieldInfo, Format, type FormatKind, type FuturesCandidate, type FuturesCurveOptions, type FuturesResolveOptions, type FxPairInfo, type IndexMembersOptions, type MarketRule, type OverrideEntry, type OverrideNestedSource, type OverrideObject, type OverrideSource, OverrideSpec, type OverrideSpecLike, type OverrideValue, type OverridesInput, type OverridesMap, type PreferredsOptions, type PrimitiveValue, type RecipeBackendOptions, type RequestInput, type RequestOptions, type ResultMetadata, type SeatType, type SecurityOverrideSpec, type ServerAddress, type SessionWindowsInfo, type Socks5Config, type StreamOptions, type StringPair, Subscription, type SubscriptionStats, Tick, type TickValue, type TickerParts, type TimeRange, type TlsConfig, type TurnoverOptions, type VolFieldSpec, type VolSurfaceOptions, type VolSurfacePreset, type YasOptions, abdh, abdib, abdp, abds, abdtick, asubscribe, bdh, bdib, bdp, bds, bdtick, blp, configure, connect, ext, formatDate, formatDateTime, getLogLevel, ovr, setLogLevel, subscribe, version, wrapError };

package/dist/index.js

@@ -22,7 +22,7 @@ function tableFromNativeArrowBatch(batch) {
     return new apacheArrow.Field(column.name, type, column.nullable);
   });
   const children = batch.columns.map((column) => dataFromColumn(column, retainedBuffers));
-  const schema = new apacheArrow.Schema(fields);
+  const schema = new apacheArrow.Schema(fields, new Map(Object.entries(batch.metadata)));
   const structData = apacheArrow.makeData({
     children,
     length: batch.numRows,
@@ -1078,7 +1078,83 @@ var TA_DEFAULTS = Object.freeze({
 });
 var MKTDATA_SERVICE = "//blp/mktdata";
 function toArrowTableFromNative(batch) {
-  return tableFromNativeArrowBatch(batch);
+  return attachResultMetadata(tableFromNativeArrowBatch(batch), batch.metadata);
+}
+var METADATA_KEY_EID_DATA = "xbbg.eid_data";
+var METADATA_KEY_SECURITY_ERRORS = "xbbg.security_errors";
+var METADATA_KEY_FIELD_EXCEPTIONS = "xbbg.field_exceptions";
+function metadataRecordFromMap(metadata) {
+  return Object.fromEntries(metadata.entries());
+}
+function parseJsonMetadata(metadata, key, guard) {
+  const raw = metadata[key];
+  if (raw === void 0) {
+    return void 0;
+  }
+  try {
+    const parsed = JSON.parse(raw);
+    return guard(parsed) ? parsed : void 0;
+  } catch {
+    return void 0;
+  }
+}
+function isNumberArrayRecord(value) {
+  if (!isPlainObject(value)) {
+    return false;
+  }
+  return Object.values(value).every(
+    (entry) => Array.isArray(entry) && entry.every((eid) => typeof eid === "number")
+  );
+}
+function isMetadataError(value) {
+  if (!isPlainObject(value)) {
+    return false;
+  }
+  const { category, code, message, subcategory } = value;
+  return (category === void 0 || typeof category === "string") && (code === void 0 || typeof code === "string" || typeof code === "number") && (message === void 0 || typeof message === "string") && (subcategory === void 0 || typeof subcategory === "string");
+}
+function isMetadataErrorRecord(value) {
+  if (!isPlainObject(value)) {
+    return false;
+  }
+  return Object.values(value).every(isMetadataError);
+}
+function isFieldException(value) {
+  if (!isMetadataError(value)) {
+    return false;
+  }
+  if (!("field" in value)) {
+    return true;
+  }
+  return typeof value.field === "string";
+}
+function isFieldExceptionRecord(value) {
+  if (!isPlainObject(value)) {
+    return false;
+  }
+  return Object.values(value).every(
+    (entry) => Array.isArray(entry) && entry.every(isFieldException)
+  );
+}
+function attachResultMetadata(result, metadata) {
+  const eidData = parseJsonMetadata(metadata, METADATA_KEY_EID_DATA, isNumberArrayRecord);
+  const securityErrors = parseJsonMetadata(
+    metadata,
+    METADATA_KEY_SECURITY_ERRORS,
+    isMetadataErrorRecord
+  );
+  const fieldExceptions = parseJsonMetadata(
+    metadata,
+    METADATA_KEY_FIELD_EXCEPTIONS,
+    isFieldExceptionRecord
+  );
+  Object.defineProperties(result, {
+    eidData: { enumerable: true, value: eidData },
+    fieldExceptions: { enumerable: true, value: fieldExceptions },
+    metadata: { enumerable: true, value: { ...metadata } },
+    securityErrors: { enumerable: true, value: securityErrors }
+  });
+  return result;
 }
 function isPlainObject(value) {
   return typeof value === "object" && value !== null && !Array.isArray(value);
@@ -1086,6 +1162,12 @@ function isPlainObject(value) {
 function toRequestString(value) {
   return String(value);
 }
+function getLegacySecurityOverrides(params) {
+  if ("securityOverrides" in params) {
+    return params.securityOverrides;
+  }
+  return void 0;
+}
 function mapObjectToPairs(obj) {
   if (obj === void 0) {
     return void 0;
@@ -1556,13 +1638,15 @@ function normalizeBackend(backend) {
 }
 function ipcToBackend(buffer, backend) {
   const selected = normalizeBackend(backend);
+  const table = apacheArrow.tableFromIPC(buffer);
+  const metadata = metadataRecordFromMap(table.schema.metadata);
   if (selected === Backend.JSON) {
-    return [...apacheArrow.tableFromIPC(buffer)];
+    return attachResultMetadata([...table], metadata);
   }
   if (selected === Backend.POLARS) {
     return loadPolars().readIPC(buffer);
   }
-  return apacheArrow.tableFromIPC(buffer);
+  return attachResultMetadata(table, metadata);
 }
 var configuredEngineConfig;
 var configuredEnginePromise;
@@ -1798,14 +1882,52 @@ var Engine = class _Engine {
       throw wrapError(error);
     }
   }
+  /**
+   * Return the Bloomberg identity seat type: "BPS", "NONBPS", or "INVALID".
+   *
+   * Identity operations authorize lazily using the engine auth config when
+   * configured, otherwise the Desktop terminal OS-logon user. The first call
+   * may block for a few seconds and transient failures are retryable.
+   */
+  async seatType() {
+    try {
+      return await this.inner.seatType();
+    } catch (error) {
+      throw wrapError(error);
+    }
+  }
+  /**
+   * Check whether the authorized identity is entitled to all supplied EIDs.
+   *
+   * Identity operations authorize lazily using the engine auth config when
+   * configured, otherwise the Desktop terminal OS-logon user. The first call
+   * may block for a few seconds and transient failures are retryable.
+   */
+  async checkEntitlements(service, eids) {
+    try {
+      return await this.inner.checkEntitlements(service, eids);
+    } catch (error) {
+      throw wrapError(error);
+    }
+  }
+  /**
+   * Return whether the authorized identity may use the Bloomberg service.
+   *
+   * Identity operations authorize lazily using the engine auth config when
+   * configured, otherwise the Desktop terminal OS-logon user. The first call
+   * may block for a few seconds and transient failures are retryable.
+   */
+  async identityIsAuthorized(service) {
+    try {
+      return await this.inner.identityIsAuthorized(service);
+    } catch (error) {
+      throw wrapError(error);
+    }
+  }
   async request(params) {
     const backend = normalizeBackend(params.backend);
-    const {
-      backend: _discarded,
-      overrides,
-      securityOverrides: legacySecurityOverrides,
-      ...rest
-    } = params;
+    const { backend: _discarded, overrides, ...rest } = params;
+    const legacySecurityOverrides = getLegacySecurityOverrides(params);
     if (legacySecurityOverrides !== void 0) {
       throw new TypeError(
         'Use overrides: ovr({ "<SECURITY>": { ... } }) for per-security overrides'
@@ -1820,11 +1942,8 @@ var Engine = class _Engine {
     }
   }
   async requestRaw(params) {
-    const {
-      overrides,
-      securityOverrides: legacySecurityOverrides,
-      ...rest
-    } = params;
+    const { overrides, ...rest } = params;
+    const legacySecurityOverrides = getLegacySecurityOverrides(params);
     if (legacySecurityOverrides !== void 0) {
       throw new TypeError(
         'Use overrides: ovr({ "<SECURITY>": { ... } }) for per-security overrides'
@@ -1843,6 +1962,7 @@ var Engine = class _Engine {
       fields,
       format: options.format,
       includeSecurityErrors: Boolean(options.includeSecurityErrors),
+      returnEids: options.returnEids,
       kwargs: mapObjectToPairs(options.kwargs),
       operation: "ReferenceDataRequest",
       overrides: options.overrides,
@@ -1857,6 +1977,7 @@ var Engine = class _Engine {
       extractor: "bulk",
       fields,
       format: options.format,
+      returnEids: options.returnEids,
       kwargs: mapObjectToPairs(options.kwargs),
       operation: "ReferenceDataRequest",
       overrides: options.overrides,
@@ -1872,6 +1993,7 @@ var Engine = class _Engine {
       extractor: "histdata",
       fields,
       format: options.format,
+      returnEids: options.returnEids,
       kwargs: mapObjectToPairs(options.kwargs),
       operation: "HistoricalDataRequest",
       overrides: options.overrides,