This does not contain support for TypeScript

[mohit-sankhla2002]

Overall this repository does feel a bomb upon the whole tracking-more paradigm. Only one thing that it lacks is the support for ts. No person will use this without a .d.ts file.

[brianzinn]

yeah, but surprising something written 2 years ago wouldn't just be written in typescript in the first place - or at least have typings bundled with the package.

there's also no @types available. here is what I am using:

declare module 'trackingmore-sdk-nodejs' {

  /**
   * @see https://github.com/TrackingMore-API/trackingmore-sdk-nodejs?tab=readme-ov-file#response-code
   */
  export type ResponseMeta = {
    code: number
    message: string
  }

  export type Courier = {
    /**
     * This is what you send when you want to create a tracking
     * @see trackings.createTracking
     */
    courier_code: string
    courier_country_iso2: string
    courier_logo: string
    courier_name: string
    courier_phone: string
    courier_type: string
    courier_url: string
    default_language: string
    /**
     * ???
     */
    optional_fields: any[]
    support_language: string[]
    /**
     * ???
     */
    tracking_required_fields: any[]
  }

  export default class TrackingMore {
    constructor(apiKey: string);

    /**
     * @see https://github.com/TrackingMore-API/trackingmore-sdk-nodejs?tab=readme-ov-file#couriers
     */
    couriers: {
      getAllCouriers: () => Promise<{
        data: Courier[],
        meta: ResponseMeta
      }>
      detect: (params: { tracking_number: string }) => Promise<{
        data: Courier[],
        meta: ResponseMeta
      }>
    }

    /**
     * @see https://github.com/TrackingMore-API/trackingmore-sdk-nodejs?tab=readme-ov-file#trackings
     */
    trackings: {
      createTracking: (params: {
        tracking_number: string,
        courier_code: string,
        order_number?: string,
        customer_name?: string,
        title?: string,
        language?: string,
        note?: string
      }) => Promise<{
        meta: ResponseMeta,
        data: {
          courier_code: string
          /**
           * ISO date
           */
          created_at: string
          /**
           * ie: 'pending'. this should be 'pending' |elivered' | 'exception' ...?
           */
          delivery_status: string
          /**
           * matches tracking number, i think unless you provide an order_number.
           */
          order_number: string
          tracking_number: string
        }
      }>
      get: (params: { tracking_number: string }) => Promise<{ status: string }>
    }
  }
}

There are some typos in the above. I put a drop-in replacement in #2 that also fixes a bug. I know the typings aren't 100%, but it meets all my use cases so far.