Skip to content

TSM-05: convert base service hydration layer to TypeScript #562

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
Justin Hammond (Justintime50) wants to merge 3 commits into from
+33 −28
Draft

TSM-05: convert base service hydration layer to TypeScript #562

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f32cb50
step5: convert base service hydration layer to ts
Justintime50 Aug 6, 2026
dbd1878
tsm-05: remove ts-nocheck from base hydration layers
Justintime50 Aug 7, 2026
7833d53
tsm-05: remove ts-nocheck and stabilize base typing
Justintime50 Aug 7, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 0 additions & 27 deletions src/models/easypost_object.js
View file
Open in desktop

This file was deleted.

32 changes: 32 additions & 0 deletions src/models/easypost_object.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
/**
* An EasyPostObject is the base class for all EasyPost API resources.
* @internal
* @abstract
*/
export default class EasyPostObject {
static id: string;
static object: string;
static mode: string;
static created_at: string;
static updated_at: string;
static _params: Record<string, unknown>;

static [Symbol.hasInstance](instance: unknown): boolean {
if (instance == null || typeof instance !== 'object') {
return false;
}

const modelConstructor = (instance as Record<symbol, unknown>)[
Symbol.for('easypost.modelConstructor')
];

@ralexmatthews Alex Matthews (ralexmatthews) Aug 11, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

suggestion:
You can use a type predicate function here, so that way you don't need to keep casting.

const isSymbolRecord = (value: unknown) value is Record<symbol, unknown> =>
  instance != null && typeof instance === 'object';
// ...
static [Symbol.hasInstance](instance: unknown): boolean {
  if (!isSymbolRecord(instance)) {
    return false;
  }

  const modelConstructor = instance[Symbol.for('easypost.modelConstructor')];

if (typeof modelConstructor === 'function') {
return modelConstructor === this;
}

// Fallback for plain API payloads that include object names like "Address" or "Shipment".
return (
typeof (instance as Record<string, unknown>).object === 'string' &&
(instance as Record<string, unknown>).object === this.name
);
}
}
2 changes: 1 addition & 1 deletion src/services/base_service.js → src/services/base_service.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -207,7 +207,7 @@ export default (easypostClient) =>
* @param {*} params The parameters passed when fetching the response.
* @returns {*} A plain object or array suitable for JSON serialization.
*/
static _convertToEasyPostObject(response, params) {
static _convertToEasyPostObject(response, params = {}) {
const modelResponse = this._buildEasyPostObject(response, params);

return this._toPlainEasyPostObject(modelResponse);
Expand Down