@coinbase-sample/prime-sdk-ts 0.6.3 → 0.7.0

package/dist/types/shared/enumRegistry.d.ts

@@ -0,0 +1,74 @@
+/**
+ * Copyright 2025-present Coinbase Global, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *  http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+/**
+ * Registry for managing discovered enums and providing lookup capabilities
+ */
+export declare class EnumRegistry {
+    private enums;
+    private enumsByValue;
+    private enumsByKey;
+    constructor();
+    /**
+     * Automatically discover and register all enums from the model/enums directory
+     */
+    private populateEnums;
+    /**
+     * Check if an object is a valid TypeScript enum
+     */
+    private isValidEnum;
+    /**
+     * Index enum values and keys for fast lookup
+     */
+    private indexEnumValues;
+    /**
+     * Get a specific enum by name
+     */
+    getEnum(enumName: string): Record<string, string> | null;
+    /**
+     * Get all registered enum names
+     */
+    getAllEnumNames(): string[];
+    /**
+     * Find enum by value (exact match)
+     */
+    findEnumByValue(value: string): {
+        enum: Record<string, string>;
+        name: string;
+    } | null;
+    /**
+     * Find enum by key (exact match)
+     */
+    findEnumByKey(key: string): {
+        enum: Record<string, string>;
+        name: string;
+    } | null;
+    /**
+     * Get statistics about discovered enums
+     */
+    getStats(): {
+        totalEnums: number;
+        totalValues: number;
+        totalKeys: number;
+    };
+    /**
+     * Get detailed information about all enums
+     */
+    getEnumDetails(): Record<string, {
+        values: string[];
+        keys: string[];
+    }>;
+}
+export declare const enumRegistry: EnumRegistry;

package/dist/types/shared/enumValidationCore.d.ts

@@ -0,0 +1,68 @@
+/**
+ * Copyright 2025-present Coinbase Global, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *  http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+/**
+ * Error thrown when a request contains invalid enum values
+ */
+export declare class DynamicEnumValidationError extends Error {
+    field: string;
+    value: string;
+    enumName: string;
+    validValues: string[];
+    validKeys?: string[] | undefined;
+    constructor(field: string, value: string, enumName: string, validValues: string[], validKeys?: string[] | undefined);
+}
+/**
+ * Configuration for dynamic validation behavior
+ */
+export interface DynamicValidationConfig {
+    enabled: boolean;
+    strict: boolean;
+    autoNormalize: boolean;
+    logWarnings: boolean;
+    serviceName?: string;
+}
+/**
+ * Information about a field that contains enum values
+ */
+export interface FieldTypeInfo {
+    fieldName: string;
+    enumName: string;
+    isOptional: boolean;
+    isArray: boolean;
+}
+/**
+ * Check if a value is valid for a specific enum (includes normalization)
+ */
+export declare function isValueValidForEnum(value: string, enumObject: Record<string, string>): boolean;
+/**
+ * Detects the enum type for a field based on field name patterns and value analysis
+ */
+export declare function detectEnumType(fieldName: string, value: string, serviceName?: string): {
+    enum: Record<string, string>;
+    name: string;
+} | null;
+/**
+ * Analyzes a single field to determine if it's an enum
+ */
+export declare function analyzeField(fieldName: string, value: any, serviceName?: string): FieldTypeInfo | null;
+/**
+ * Validate and normalize a single enum value
+ */
+export declare function validateEnumValue(value: string, enumObject: Record<string, string>, enumName: string, fieldName: string, config: DynamicValidationConfig): {
+    isValid: boolean;
+    normalizedValue?: string;
+    error?: string;
+};

package/dist/types/shared/enumValidators.d.ts

@@ -0,0 +1,117 @@
+/**
+ * Copyright 2025-present Coinbase Global, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *  http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+/**
+ * Convenient enum validators for common Prime API enums.
+ * These provide pre-configured validation for frequently used enum types.
+ *
+ * Note: Most users should use the dynamic validation system instead, which
+ * automatically handles all enums. These validators are useful for explicit
+ * control or when you need to validate individual enum values.
+ */
+import { normalizeEnumValue } from './enumHelpers';
+import { OrderType } from '../model/enums/OrderType';
+import { OrderSide } from '../model/enums/OrderSide';
+import { OrderStatus } from '../model/enums/OrderStatus';
+import { TransactionType } from '../model/enums/TransactionType';
+import { TimeInForceType } from '../model/enums/TimeInForceType';
+/**
+ * Order-related enum helpers
+ */
+export declare const OrderEnums: {
+    /**
+     * Validates and normalizes order type values
+     * Accepts: 'market', 'limit', 'twap', 'block', 'vwap', 'stopLimit', 'rfq' (case-insensitive)
+     */
+    getOrderType: (input: string) => OrderType | undefined;
+    requireOrderType: (input: string) => OrderType;
+    isValidOrderType: (input: string) => boolean;
+    /**
+     * Validates and normalizes order side values
+     * Accepts: 'buy', 'sell' (case-insensitive)
+     */
+    getOrderSide: (input: string) => OrderSide | undefined;
+    requireOrderSide: (input: string) => OrderSide;
+    isValidOrderSide: (input: string) => boolean;
+    /**
+     * Validates and normalizes order status values
+     * Accepts: 'open', 'filled', 'cancelled', 'expired', 'failed', 'pending' (case-insensitive)
+     */
+    getOrderStatus: (input: string) => OrderStatus | undefined;
+    requireOrderStatus: (input: string) => OrderStatus;
+    isValidOrderStatus: (input: string) => boolean;
+    /**
+     * Validates and normalizes time in force type values
+     * Accepts: 'good_until_cancelled', 'good_until_time', 'immediate_or_cancel', 'fill_or_kill' (case-insensitive)
+     */
+    getTimeInForceType: (input: string) => TimeInForceType | undefined;
+    requireTimeInForceType: (input: string) => TimeInForceType;
+    isValidTimeInForceType: (input: string) => boolean;
+};
+/**
+ * Transaction-related enum helpers
+ */
+export declare const TransactionEnums: {
+    /**
+     * Validates and normalizes transaction type values
+     * Accepts various transaction types like 'deposit', 'withdrawal', 'internalDeposit', etc. (case-insensitive)
+     */
+    getTransactionType: (input: string) => TransactionType | undefined;
+    requireTransactionType: (input: string) => TransactionType;
+    isValidTransactionType: (input: string) => boolean;
+};
+/**
+ * Utility for creating custom enum validators for any enum type
+ *
+ * @param enumObject - The enum object to create validators for
+ * @param enumName - Name of the enum for error messages
+ * @returns Object with validation methods
+ *
+ * @example
+ * import { WalletType } from '../model/enums/WalletType';
+ *
+ * const WalletValidators = createEnumValidators(WalletType, 'WalletType');
+ * WalletValidators.get('trading'); // Gets WalletType value
+ * WalletValidators.require('custody'); // Gets WalletType value or throws
+ * WalletValidators.isValid('invalid'); // false
+ */
+export declare function createEnumValidators<T extends Record<string, string>>(enumObject: T, enumName: string): {
+    get: (input: string) => T[keyof T] | undefined;
+    require: (input: string) => T[keyof T];
+    isValid: (input: string) => boolean;
+    values: string[];
+    keys: string[];
+};
+/**
+ * Convenience function to normalize any string to enum format
+ * Useful for debugging or preparing values for API calls
+ *
+ * @example
+ * toEnumFormat('marketOrder') // 'MARKET_ORDER'
+ * toEnumFormat('buy') // 'BUY'
+ * toEnumFormat('stop-limit') // 'STOP_LIMIT'
+ */
+export { normalizeEnumValue as toEnumFormat };
+/**
+ * @deprecated Use the dynamic validation system instead.
+ *
+ * Most users should prefer:
+ * ```javascript
+ * import { dynamicValidateRequest } from '@coinbase/prime-sdk';
+ * const validated = dynamicValidateRequest(request);
+ * ```
+ *
+ * This provides automatic validation for all enum fields without manual configuration.
+ */

package/dist/types/shared/fieldMapping.d.ts

@@ -0,0 +1,35 @@
+/**
+ * Copyright 2025-present Coinbase Global, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *  http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+/**
+ * Generate field name variations for plural/singular matching
+ */
+export declare function getFieldNameVariations(fieldName: string): string[];
+/**
+ * Extract context clues from field names to resolve enum ambiguity
+ */
+export declare function extractContextClues(fieldName: string): string[];
+/**
+ * Find enum with context awareness to resolve collisions
+ */
+export declare function findEnumWithContext(fieldName: string, allEnumNames: string[]): string | null;
+/**
+ * Dynamically find enum name based on field name patterns
+ */
+export declare function findEnumByFieldName(fieldName: string): string | null;
+/**
+ * Get direct field-to-enum mapping with service context and fallback to essential mappings
+ */
+export declare function getDirectEnumMapping(fieldName: string, serviceName?: string): string | null;

package/dist/types/shared/serviceContext.d.ts

@@ -0,0 +1,46 @@
+/**
+ * Copyright 2025-present Coinbase Global, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *  http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+/**
+ * Service context for enhanced enum field detection
+ */
+/**
+ * Service-specific enum mappings to resolve ambiguous field names
+ */
+export interface ServiceEnumContext {
+    serviceName: string;
+    fieldMappings: Record<string, string>;
+    description?: string;
+}
+/**
+ * Registry of service contexts for accurate enum detection
+ */
+export declare const SERVICE_CONTEXTS: Record<string, ServiceEnumContext>;
+/**
+ * Get service context by service name
+ */
+export declare function getServiceContext(serviceName: string): ServiceEnumContext | null;
+/**
+ * Resolve field to enum using service context
+ */
+export declare function resolveFieldWithServiceContext(fieldName: string, serviceName?: string): string | null;
+/**
+ * Get all available service contexts
+ */
+export declare function getAllServiceContexts(): Record<string, ServiceEnumContext>;
+/**
+ * Check if a service has context defined
+ */
+export declare function hasServiceContext(serviceName: string): boolean;

package/dist/types/staking/index.d.ts

@@ -14,12 +14,14 @@
  * limitations under the License.
  */
 import { IPrimeApiClient, CoinbaseCallOptions } from '../clients';
-import { CreateStakeRequest, CreateStakeResponse, CreateUnstakeRequest, CreateUnstakeResponse, CreatePortfolioStakeRequest, CreatePortfolioStakeResponse, CreatePortfolioUnstakeRequest, CreatePortfolioUnstakeResponse } from './types';
+import { CreateStakeRequest, CreateStakeResponse, CreateUnstakeRequest, CreateUnstakeResponse, CreatePortfolioStakeRequest, CreatePortfolioStakeResponse, CreatePortfolioUnstakeRequest, CreatePortfolioUnstakeResponse, QueryTransactionValidatorsRequest, QueryTransactionValidatorsResponse, ClaimRewardsRequest, ClaimRewardsResponse } from './types';
 export interface IStakingService {
     createStake(request: CreateStakeRequest, options?: CoinbaseCallOptions): Promise<CreateStakeResponse>;
     createUnstake(request: CreateUnstakeRequest, options?: CoinbaseCallOptions): Promise<CreateUnstakeResponse>;
     createPortfolioStake(request: CreatePortfolioStakeRequest, options?: CoinbaseCallOptions): Promise<CreatePortfolioStakeResponse>;
     createPortfolioUnstake(request: CreatePortfolioUnstakeRequest, options?: CoinbaseCallOptions): Promise<CreatePortfolioUnstakeResponse>;
+    queryTransactionValidators(request: QueryTransactionValidatorsRequest, options?: CoinbaseCallOptions): Promise<QueryTransactionValidatorsResponse>;
+    claimRewards(request: ClaimRewardsRequest, options?: CoinbaseCallOptions): Promise<ClaimRewardsResponse>;
 }
 export declare class StakingService implements IStakingService {
     private client;
@@ -28,4 +30,6 @@ export declare class StakingService implements IStakingService {
     createUnstake(request: CreateUnstakeRequest, options?: CoinbaseCallOptions): Promise<CreateUnstakeResponse>;
     createPortfolioStake(request: CreatePortfolioStakeRequest, options?: CoinbaseCallOptions): Promise<CreatePortfolioStakeResponse>;
     createPortfolioUnstake(request: CreatePortfolioUnstakeRequest, options?: CoinbaseCallOptions): Promise<CreatePortfolioUnstakeResponse>;
+    queryTransactionValidators(request: QueryTransactionValidatorsRequest, options?: CoinbaseCallOptions): Promise<QueryTransactionValidatorsResponse>;
+    claimRewards(request: ClaimRewardsRequest, options?: CoinbaseCallOptions): Promise<ClaimRewardsResponse>;
 }

package/dist/types/staking/types.d.ts

@@ -14,7 +14,8 @@
  * limitations under the License.
  */
 import { Brand } from '../shared/brand';
-import { StakingInitiateResponse, StakingInitiateRequest, StakingUnstakeResponse, PortfolioStakingInitiateRequest, PortfolioStakingInitiateResponse, PortfolioStakingUnstakeRequest, PortfolioStakingUnstakeResponse } from 'src/model/';
+import { BasePaginatedRequest, PaginatedResponseMethods } from '../shared/paginatedResponse';
+import { StakingInitiateResponse, StakingInitiateRequest, StakingUnstakeResponse, PortfolioStakingInitiateRequest, PortfolioStakingInitiateResponse, PortfolioStakingUnstakeRequest, PortfolioStakingUnstakeResponse, ListTransactionValidatorsResponse as internalListTransactionValidatorsResponse, StakingClaimRewardsRequest as internalStakingClaimRewardsRequest, StakingClaimRewardsResponse as internalStakingClaimRewardsResponse } from 'src/model/';
 export type CreateStakeRequest = StakingInitiateRequest & {
     portfolioId: string;
     walletId: string;
@@ -33,3 +34,14 @@ export type CreatePortfolioUnstakeRequest = PortfolioStakingUnstakeRequest & {
     portfolioId: string;
 };
 export type CreatePortfolioUnstakeResponse = Brand<PortfolioStakingUnstakeResponse, 'CreatePortfolioUnstakeResponse'>;
+export type QueryTransactionValidatorsRequest = BasePaginatedRequest & {
+    portfolioId: string;
+    transactionIds: string[];
+};
+export type BaseQueryTransactionValidatorsResponse = Brand<internalListTransactionValidatorsResponse, 'BaseQueryTransactionValidatorsResponse'>;
+export type QueryTransactionValidatorsResponse = BaseQueryTransactionValidatorsResponse & PaginatedResponseMethods<QueryTransactionValidatorsRequest, BaseQueryTransactionValidatorsResponse, any>;
+export type ClaimRewardsRequest = internalStakingClaimRewardsRequest & {
+    portfolioId: string;
+    walletId: string;
+};
+export type ClaimRewardsResponse = Brand<internalStakingClaimRewardsResponse, 'ClaimRewardsResponse'>;

package/dist/types/wallets/types.d.ts

@@ -15,7 +15,7 @@
  */
 import { Brand } from '../shared/brand';
 import { WalletType, WalletDepositInstructionType } from '../model/enums/';
-import { GetWalletsResponse, GetWalletResponse as internalGet, GetWalletAddressesResponse as internalGetAddresses, GetWalletDepositInstructionsResponse as internalGetInstructs, CreateWalletRequest as internalCreate, CreateWalletResponse as internalCreateResp, BlockchainAddress } from '../model/';
+import { GetWalletsResponse, GetWalletResponse as internalGet, ListWalletAddressesResponse as internalGetAddresses, GetWalletDepositInstructionsResponse as internalGetInstructs, CreateWalletRequest as internalCreate, CreateWalletResponse as internalCreateResp, BlockchainAddress } from '../model/';
 import { Pagination } from '../shared/pagination';
 import { BasePaginatedRequest, PaginatedResponseMethods } from '../shared/paginatedResponse';
 export type ListWalletsRequest = Pagination & {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@coinbase-sample/prime-sdk-ts",
-  "version": "0.6.3",
+  "version": "0.7.0",
   "main": "dist/index.js",
   "types": "dist/types/index.d.ts",
   "exports": {
@@ -39,9 +39,10 @@
     "build": "tsc",
     "lint": "eslint . --ext .js,.ts",
     "format": "prettier --write \"**/*.{js,ts,tsx,json,css,md}\"",
-    "gen-types": "openapi-generator-cli generate -i apiSpec/prime-public-api-spec.yaml -g typescript-node --global-property models -o apiSpec/types --additional-properties=supportsES6=true --additional-properties=snapshot=true && cd apiSpec && node generateTypes.js",
+    "fetch-spec": "curl -o apiSpec/prime-public-api-spec.yaml https://api.prime.coinbase.com/v1/openapi.yaml",
+    "gen-types": "openapi-generator generate -i apiSpec/prime-public-api-spec.yaml -g typescript-node --global-property models -o apiSpec/types --additional-properties=supportsES6=true --additional-properties=snapshot=true && cd apiSpec && node generateTypes.js",
     "replace-model": "rm -r src/model && cp -r apiSpec/types/processed src/model",
-    "update-spec": "npm run gen-types && npm run replace-model"
+    "update-spec": "npm run fetch-spec && npm run gen-types && npm run replace-model"
   },
   "files": [
     "dist/"
@@ -67,6 +68,6 @@
     "typescript": "^5.9.2"
   },
   "dependencies": {
-    "@coinbase-sample/core-ts": "^0.2.0"
+    "@coinbase-sample/core-ts": "^0.2.1"
   }
 }