Skip to content

Missing TypeScript Type Definitions for FactSet SDK Packages #18

@will-pavefinance

Description

@will-pavefinance
  • Package Name: all TypeScript packages
  • Package Version:
  • Package Language: JavaScript (with an expectation of TypeScript support)
  • Operating System: macOS

Describe the bug
The @factset/sdk-factsetprices (and likely all others) npm package does not include TypeScript type definitions (.d.ts files). This omission leads to a lack of type safety, IntelliSense, and autocompletion when using the library in a TypeScript project. TypeScript infers the any type for the library's modules and functions, which undermines the benefits of using TypeScript.

To Reproduce
Steps to reproduce the behavior:

  1. Initialize a new Node.js project with TypeScript.
  2. Install the package: npm install @factset/sdk-factsetprices
  3. Create a TypeScript file (e.g., index.ts) and attempt to import and use the package:
    import * as FactSetPrices from '@factset/sdk-factsetprices';
    
    // Example: Attempt to use a function or class from the library
    // const pricesApi = new FactSetPrices.PricesApi(); // This line would show type errors or lack autocompletion
  4. Observe that there is no type information for FactSetPrices or its members.

Expected behavior
The @factset/sdk-factsetprices package should provide TypeScript type definitions. This could be achieved by:

  1. Bundling declaration files (e.g., index.d.ts) within the npm package.

This would enable compile-time type checking, autocompletion, and a better overall developer experience for TypeScript users.

Screenshots
N/A (The issue is with missing type files, not a visual bug).

Additional context

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions