@signa-so/sdk 0.8.0 → 0.14.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +2 -7
- package/dist/client.d.ts +11 -8
- package/dist/client.d.ts.map +1 -1
- package/dist/client.js +14 -10
- package/dist/client.js.map +1 -1
- package/dist/errors.d.ts +54 -1
- package/dist/errors.d.ts.map +1 -1
- package/dist/errors.js +80 -3
- package/dist/errors.js.map +1 -1
- package/dist/generated/api-types.d.ts +13861 -6608
- package/dist/generated/api-types.d.ts.map +1 -1
- package/dist/index.d.ts +2 -2
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +1 -1
- package/dist/index.js.map +1 -1
- package/dist/pagination.d.ts +23 -2
- package/dist/pagination.d.ts.map +1 -1
- package/dist/pagination.js +45 -4
- package/dist/pagination.js.map +1 -1
- package/dist/resources/citations.d.ts +33 -0
- package/dist/resources/citations.d.ts.map +1 -0
- package/dist/resources/citations.js +38 -0
- package/dist/resources/citations.js.map +1 -0
- package/dist/resources/credits.d.ts +7 -0
- package/dist/resources/credits.d.ts.map +1 -0
- package/dist/resources/credits.js +8 -0
- package/dist/resources/credits.js.map +1 -0
- package/dist/resources/deadlines.d.ts +38 -4
- package/dist/resources/deadlines.d.ts.map +1 -1
- package/dist/resources/deadlines.js +39 -2
- package/dist/resources/deadlines.js.map +1 -1
- package/dist/resources/entities.d.ts +6 -7
- package/dist/resources/entities.d.ts.map +1 -1
- package/dist/resources/entities.js +6 -7
- package/dist/resources/entities.js.map +1 -1
- package/dist/resources/events.d.ts.map +1 -1
- package/dist/resources/events.js +4 -1
- package/dist/resources/events.js.map +1 -1
- package/dist/resources/fees.d.ts +10 -0
- package/dist/resources/fees.d.ts.map +1 -0
- package/dist/resources/fees.js +14 -0
- package/dist/resources/fees.js.map +1 -0
- package/dist/resources/goods-services.d.ts +36 -2
- package/dist/resources/goods-services.d.ts.map +1 -1
- package/dist/resources/goods-services.js +37 -1
- package/dist/resources/goods-services.js.map +1 -1
- package/dist/resources/organization.d.ts +8 -1
- package/dist/resources/organization.d.ts.map +1 -1
- package/dist/resources/organization.js +9 -0
- package/dist/resources/organization.js.map +1 -1
- package/dist/resources/portfolios.d.ts +46 -20
- package/dist/resources/portfolios.d.ts.map +1 -1
- package/dist/resources/portfolios.js +39 -5
- package/dist/resources/portfolios.js.map +1 -1
- package/dist/resources/reconcile.d.ts +21 -1
- package/dist/resources/reconcile.d.ts.map +1 -1
- package/dist/resources/reconcile.js +21 -1
- package/dist/resources/reconcile.js.map +1 -1
- package/dist/resources/references.d.ts +63 -8
- package/dist/resources/references.d.ts.map +1 -1
- package/dist/resources/references.js +77 -10
- package/dist/resources/references.js.map +1 -1
- package/dist/resources/trademarks.d.ts +42 -4
- package/dist/resources/trademarks.d.ts.map +1 -1
- package/dist/resources/trademarks.js +284 -3
- package/dist/resources/trademarks.js.map +1 -1
- package/dist/resources/watches.d.ts +3 -7
- package/dist/resources/watches.d.ts.map +1 -1
- package/dist/resources/watches.js +2 -16
- package/dist/resources/watches.js.map +1 -1
- package/dist/types.d.ts +1202 -573
- package/dist/types.d.ts.map +1 -1
- package/dist/version.d.ts +1 -1
- package/dist/version.d.ts.map +1 -1
- package/dist/version.js +1 -1
- package/dist/version.js.map +1 -1
- package/package.json +3 -3
- package/dist/resources/saved-searches.d.ts +0 -22
- package/dist/resources/saved-searches.d.ts.map +0 -1
- package/dist/resources/saved-searches.js +0 -39
- package/dist/resources/saved-searches.js.map +0 -1
- package/dist/resources/suggest.d.ts +0 -16
- package/dist/resources/suggest.d.ts.map +0 -1
- package/dist/resources/suggest.js +0 -18
- package/dist/resources/suggest.js.map +0 -1
package/README.md
CHANGED
|
@@ -104,12 +104,6 @@ await signa.trademarks.search({
|
|
|
104
104
|
});
|
|
105
105
|
```
|
|
106
106
|
|
|
107
|
-
### `signa.suggest`
|
|
108
|
-
|
|
109
|
-
```ts
|
|
110
|
-
await signa.suggest.crossEntity({ q: 'nik' });
|
|
111
|
-
```
|
|
112
|
-
|
|
113
107
|
### `signa.references`
|
|
114
108
|
|
|
115
109
|
```ts
|
|
@@ -212,7 +206,8 @@ Configuration lives in two places:
|
|
|
212
206
|
- **Repo:** `.github/workflows/publish-sdk.yml` (the only workflow allowed to
|
|
213
207
|
publish).
|
|
214
208
|
- **npm:** npmjs.com → `@signa-so/sdk` → Settings → *Trusted Publisher*
|
|
215
|
-
(`
|
|
209
|
+
(`signa-so/signa`, workflow `publish-sdk.yml`; the trusted publisher must be
|
|
210
|
+
re-registered for the `signa-so` owner after the repo transfer). Publishing access is
|
|
216
211
|
"Require two-factor authentication or a granular access token with bypass
|
|
217
212
|
2fa enabled" — but with the trusted publisher, no token is ever needed.
|
|
218
213
|
|
package/dist/client.d.ts
CHANGED
|
@@ -1,21 +1,22 @@
|
|
|
1
|
+
import { Credits } from './resources/credits.js';
|
|
1
2
|
import type { ClientOptions } from './types.js';
|
|
2
|
-
import { SignaError, SignaAPIError, BadRequestError, AuthenticationError, PermissionError, NotFoundError, ConflictError, RateLimitError, InternalServerError, ConnectionError, TimeoutError } from './errors.js';
|
|
3
|
+
import { SignaError, SignaAPIError, BadRequestError, AuthenticationError, PermissionError, NotFoundError, ConflictError, GoneError, RateLimitError, InternalServerError, ConnectionError, TimeoutError } from './errors.js';
|
|
3
4
|
import { Trademarks } from './resources/trademarks.js';
|
|
4
5
|
import { Owners } from './resources/owners.js';
|
|
5
6
|
import { Entities } from './resources/entities.js';
|
|
6
7
|
import { Attorneys } from './resources/attorneys.js';
|
|
7
8
|
import { Firms } from './resources/firms.js';
|
|
8
9
|
import { Proceedings } from './resources/proceedings.js';
|
|
10
|
+
import { Citations } from './resources/citations.js';
|
|
9
11
|
import { Assignments } from './resources/assignments.js';
|
|
10
|
-
import { Suggest } from './resources/suggest.js';
|
|
11
12
|
import { References } from './resources/references.js';
|
|
12
13
|
import { Analytics } from './resources/analytics.js';
|
|
14
|
+
import { Fees } from './resources/fees.js';
|
|
13
15
|
import { Deadlines } from './resources/deadlines.js';
|
|
14
16
|
import { Oppositions } from './resources/oppositions.js';
|
|
15
17
|
import { Reconcile } from './resources/reconcile.js';
|
|
16
18
|
import { GoodsServices } from './resources/goods-services.js';
|
|
17
19
|
import { Portfolios } from './resources/portfolios.js';
|
|
18
|
-
import { SavedSearches } from './resources/saved-searches.js';
|
|
19
20
|
import { FeedbackResource } from './resources/feedback.js';
|
|
20
21
|
import { Watches } from './resources/watches.js';
|
|
21
22
|
import { Alerts } from './resources/alerts.js';
|
|
@@ -58,6 +59,7 @@ export declare class Signa {
|
|
|
58
59
|
static readonly PermissionError: typeof PermissionError;
|
|
59
60
|
static readonly NotFoundError: typeof NotFoundError;
|
|
60
61
|
static readonly ConflictError: typeof ConflictError;
|
|
62
|
+
static readonly GoneError: typeof GoneError;
|
|
61
63
|
static readonly RateLimitError: typeof RateLimitError;
|
|
62
64
|
static readonly InternalServerError: typeof InternalServerError;
|
|
63
65
|
static readonly ConnectionError: typeof ConnectionError;
|
|
@@ -74,15 +76,16 @@ export declare class Signa {
|
|
|
74
76
|
readonly firms: Firms;
|
|
75
77
|
/** Proceeding operations: retrieve, list. */
|
|
76
78
|
readonly proceedings: Proceedings;
|
|
79
|
+
/** Office-action citation operations: cross-mark list (ENG-338). */
|
|
80
|
+
readonly citations: Citations;
|
|
77
81
|
/** Assignment operations: retrieve, list. */
|
|
78
82
|
readonly assignments: Assignments;
|
|
79
|
-
/** Suggest operations: cross-entity typeahead. */
|
|
80
|
-
readonly suggest: Suggest;
|
|
81
83
|
/** Reference data: classifications, offices, jurisdictions, event types, design codes. */
|
|
82
84
|
readonly references: References;
|
|
83
85
|
readonly analytics: Analytics;
|
|
84
86
|
/** Deadline computation: batch maintenance deadline calculations. */
|
|
85
87
|
readonly deadlines: Deadlines;
|
|
88
|
+
readonly fees: Fees;
|
|
86
89
|
/** Opposition windows: batch opposition deadline calculations. */
|
|
87
90
|
readonly oppositions: Oppositions;
|
|
88
91
|
/** Reconciliation: compare caller records against register data. */
|
|
@@ -94,8 +97,6 @@ export declare class Signa {
|
|
|
94
97
|
readonly goodsServices: GoodsServices;
|
|
95
98
|
/** Portfolio management: CRUD, marks, deadlines. */
|
|
96
99
|
readonly portfolios: Portfolios;
|
|
97
|
-
/** Saved search management: CRUD, re-execute. */
|
|
98
|
-
readonly savedSearches: SavedSearches;
|
|
99
100
|
/** Customer feedback: submit data issues, bug reports, and feature requests. */
|
|
100
101
|
readonly feedback: FeedbackResource;
|
|
101
102
|
/**
|
|
@@ -123,7 +124,7 @@ export declare class Signa {
|
|
|
123
124
|
/** Event stream: list, retrieve with diffs. */
|
|
124
125
|
readonly events: Events;
|
|
125
126
|
/**
|
|
126
|
-
* Screening — INTERNAL/
|
|
127
|
+
* Screening — INTERNAL/alpha (`screening:read` scope). `checkListing` extracts
|
|
127
128
|
* candidate marks from listing text and returns a listing-level verdict.
|
|
128
129
|
*/
|
|
129
130
|
readonly screening: Screening;
|
|
@@ -131,6 +132,8 @@ export declare class Signa {
|
|
|
131
132
|
readonly compare: Compare;
|
|
132
133
|
/** Organization: identity, usage, API key management. */
|
|
133
134
|
readonly organization: Organization;
|
|
135
|
+
/** Published credit prices by API action. */
|
|
136
|
+
readonly credits: Credits;
|
|
134
137
|
/** @internal */
|
|
135
138
|
private readonly _config;
|
|
136
139
|
constructor(opts?: ClientOptions);
|
package/dist/client.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AAEhD,OAAO,EACL,UAAU,EACV,aAAa,EACb,eAAe,EACf,mBAAmB,EACnB,eAAe,EACf,aAAa,EACb,aAAa,EACb,cAAc,EACd,mBAAmB,EACnB,eAAe,EACf,YAAY,EACb,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,UAAU,EAAE,MAAM,2BAA2B,CAAC;AACvD,OAAO,EAAE,MAAM,EAAE,MAAM,uBAAuB,CAAC;AAC/C,OAAO,EAAE,QAAQ,EAAE,MAAM,yBAAyB,CAAC;AACnD,OAAO,EAAE,SAAS,EAAE,MAAM,0BAA0B,CAAC;AACrD,OAAO,EAAE,KAAK,EAAE,MAAM,sBAAsB,CAAC;AAC7C,OAAO,EAAE,WAAW,EAAE,MAAM,4BAA4B,CAAC;AACzD,OAAO,EAAE,
|
|
1
|
+
{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,wBAAwB,CAAC;AACjD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AAEhD,OAAO,EACL,UAAU,EACV,aAAa,EACb,eAAe,EACf,mBAAmB,EACnB,eAAe,EACf,aAAa,EACb,aAAa,EACb,SAAS,EACT,cAAc,EACd,mBAAmB,EACnB,eAAe,EACf,YAAY,EACb,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,UAAU,EAAE,MAAM,2BAA2B,CAAC;AACvD,OAAO,EAAE,MAAM,EAAE,MAAM,uBAAuB,CAAC;AAC/C,OAAO,EAAE,QAAQ,EAAE,MAAM,yBAAyB,CAAC;AACnD,OAAO,EAAE,SAAS,EAAE,MAAM,0BAA0B,CAAC;AACrD,OAAO,EAAE,KAAK,EAAE,MAAM,sBAAsB,CAAC;AAC7C,OAAO,EAAE,WAAW,EAAE,MAAM,4BAA4B,CAAC;AACzD,OAAO,EAAE,SAAS,EAAE,MAAM,0BAA0B,CAAC;AACrD,OAAO,EAAE,WAAW,EAAE,MAAM,4BAA4B,CAAC;AACzD,OAAO,EAAE,UAAU,EAAE,MAAM,2BAA2B,CAAC;AACvD,OAAO,EAAE,SAAS,EAAE,MAAM,0BAA0B,CAAC;AACrD,OAAO,EAAE,IAAI,EAAE,MAAM,qBAAqB,CAAC;AAC3C,OAAO,EAAE,SAAS,EAAE,MAAM,0BAA0B,CAAC;AACrD,OAAO,EAAE,WAAW,EAAE,MAAM,4BAA4B,CAAC;AACzD,OAAO,EAAE,SAAS,EAAE,MAAM,0BAA0B,CAAC;AACrD,OAAO,EAAE,aAAa,EAAE,MAAM,+BAA+B,CAAC;AAC9D,OAAO,EAAE,UAAU,EAAE,MAAM,2BAA2B,CAAC;AACvD,OAAO,EAAE,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AAC3D,OAAO,EAAE,OAAO,EAAE,MAAM,wBAAwB,CAAC;AACjD,OAAO,EAAE,MAAM,EAAE,MAAM,uBAAuB,CAAC;AAC/C,OAAO,EAAE,QAAQ,EAAE,MAAM,yBAAyB,CAAC;AACnD,OAAO,EAAE,MAAM,EAAE,MAAM,uBAAuB,CAAC;AAC/C,OAAO,EAAE,SAAS,EAAE,MAAM,0BAA0B,CAAC;AACrD,OAAO,EAAE,OAAO,EAAE,MAAM,wBAAwB,CAAC;AACjD,OAAO,EAAE,YAAY,EAAE,MAAM,6BAA6B,CAAC;AAM3D;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,qBAAa,KAAK;IAEhB,MAAM,CAAC,QAAQ,CAAC,UAAU,oBAAc;IACxC,MAAM,CAAC,QAAQ,CAAC,aAAa,uBAAiB;IAC9C,MAAM,CAAC,QAAQ,CAAC,eAAe,yBAAmB;IAClD,MAAM,CAAC,QAAQ,CAAC,mBAAmB,6BAAuB;IAC1D,MAAM,CAAC,QAAQ,CAAC,eAAe,yBAAmB;IAClD,MAAM,CAAC,QAAQ,CAAC,aAAa,uBAAiB;IAC9C,MAAM,CAAC,QAAQ,CAAC,aAAa,uBAAiB;IAC9C,MAAM,CAAC,QAAQ,CAAC,SAAS,mBAAa;IACtC,MAAM,CAAC,QAAQ,CAAC,cAAc,wBAAkB;IAChD,MAAM,CAAC,QAAQ,CAAC,mBAAmB,6BAAuB;IAC1D,MAAM,CAAC,QAAQ,CAAC,eAAe,yBAAmB;IAClD,MAAM,CAAC,QAAQ,CAAC,YAAY,sBAAgB;IAE5C,qDAAqD;IACrD,QAAQ,CAAC,UAAU,EAAE,UAAU,CAAC;IAEhC,oDAAoD;IACpD,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IAExB,uEAAuE;IACvE,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC;IAE5B,uDAAuD;IACvD,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAC;IAE9B,8DAA8D;IAC9D,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAC;IAEtB,6CAA6C;IAC7C,QAAQ,CAAC,WAAW,EAAE,WAAW,CAAC;IAElC,oEAAoE;IACpE,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAC;IAE9B,6CAA6C;IAC7C,QAAQ,CAAC,WAAW,EAAE,WAAW,CAAC;IAElC,0FAA0F;IAC1F,QAAQ,CAAC,UAAU,EAAE,UAAU,CAAC;IAChC,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAC;IAE9B,qEAAqE;IACrE,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAC;IAC9B,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC;IAEpB,kEAAkE;IAClE,QAAQ,CAAC,WAAW,EAAE,WAAW,CAAC;IAElC,oEAAoE;IACpE,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAC;IAE9B;;;OAGG;IACH,QAAQ,CAAC,aAAa,EAAE,aAAa,CAAC;IAEtC,oDAAoD;IACpD,QAAQ,CAAC,UAAU,EAAE,UAAU,CAAC;IAEhC,gFAAgF;IAChF,QAAQ,CAAC,QAAQ,EAAE,gBAAgB,CAAC;IAEpC;;;;;;;OAOG;IACH,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAE1B;;;;OAIG;IACH,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IAExB;;;;;OAKG;IACH,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC;IAE5B,+CAA+C;IAC/C,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IAExB;;;OAGG;IACH,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAC;IAE9B,8DAA8D;IAC9D,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAE1B,yDAAyD;IACzD,QAAQ,CAAC,YAAY,EAAE,YAAY,CAAC;IAEpC,6CAA6C;IAC7C,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAE1B,gBAAgB;IAChB,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAc;gBAE1B,IAAI,GAAE,aAAkB;CA0ErC"}
|
package/dist/client.js
CHANGED
|
@@ -1,20 +1,21 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { Credits } from './resources/credits.js';
|
|
2
|
+
import { SignaError, SignaAPIError, BadRequestError, AuthenticationError, PermissionError, NotFoundError, ConflictError, GoneError, RateLimitError, InternalServerError, ConnectionError, TimeoutError, } from './errors.js';
|
|
2
3
|
import { Trademarks } from './resources/trademarks.js';
|
|
3
4
|
import { Owners } from './resources/owners.js';
|
|
4
5
|
import { Entities } from './resources/entities.js';
|
|
5
6
|
import { Attorneys } from './resources/attorneys.js';
|
|
6
7
|
import { Firms } from './resources/firms.js';
|
|
7
8
|
import { Proceedings } from './resources/proceedings.js';
|
|
9
|
+
import { Citations } from './resources/citations.js';
|
|
8
10
|
import { Assignments } from './resources/assignments.js';
|
|
9
|
-
import { Suggest } from './resources/suggest.js';
|
|
10
11
|
import { References } from './resources/references.js';
|
|
11
12
|
import { Analytics } from './resources/analytics.js';
|
|
13
|
+
import { Fees } from './resources/fees.js';
|
|
12
14
|
import { Deadlines } from './resources/deadlines.js';
|
|
13
15
|
import { Oppositions } from './resources/oppositions.js';
|
|
14
16
|
import { Reconcile } from './resources/reconcile.js';
|
|
15
17
|
import { GoodsServices } from './resources/goods-services.js';
|
|
16
18
|
import { Portfolios } from './resources/portfolios.js';
|
|
17
|
-
import { SavedSearches } from './resources/saved-searches.js';
|
|
18
19
|
import { FeedbackResource } from './resources/feedback.js';
|
|
19
20
|
import { Watches } from './resources/watches.js';
|
|
20
21
|
import { Alerts } from './resources/alerts.js';
|
|
@@ -61,6 +62,7 @@ export class Signa {
|
|
|
61
62
|
static PermissionError = PermissionError;
|
|
62
63
|
static NotFoundError = NotFoundError;
|
|
63
64
|
static ConflictError = ConflictError;
|
|
65
|
+
static GoneError = GoneError;
|
|
64
66
|
static RateLimitError = RateLimitError;
|
|
65
67
|
static InternalServerError = InternalServerError;
|
|
66
68
|
static ConnectionError = ConnectionError;
|
|
@@ -77,15 +79,16 @@ export class Signa {
|
|
|
77
79
|
firms;
|
|
78
80
|
/** Proceeding operations: retrieve, list. */
|
|
79
81
|
proceedings;
|
|
82
|
+
/** Office-action citation operations: cross-mark list (ENG-338). */
|
|
83
|
+
citations;
|
|
80
84
|
/** Assignment operations: retrieve, list. */
|
|
81
85
|
assignments;
|
|
82
|
-
/** Suggest operations: cross-entity typeahead. */
|
|
83
|
-
suggest;
|
|
84
86
|
/** Reference data: classifications, offices, jurisdictions, event types, design codes. */
|
|
85
87
|
references;
|
|
86
88
|
analytics;
|
|
87
89
|
/** Deadline computation: batch maintenance deadline calculations. */
|
|
88
90
|
deadlines;
|
|
91
|
+
fees;
|
|
89
92
|
/** Opposition windows: batch opposition deadline calculations. */
|
|
90
93
|
oppositions;
|
|
91
94
|
/** Reconciliation: compare caller records against register data. */
|
|
@@ -97,8 +100,6 @@ export class Signa {
|
|
|
97
100
|
goodsServices;
|
|
98
101
|
/** Portfolio management: CRUD, marks, deadlines. */
|
|
99
102
|
portfolios;
|
|
100
|
-
/** Saved search management: CRUD, re-execute. */
|
|
101
|
-
savedSearches;
|
|
102
103
|
/** Customer feedback: submit data issues, bug reports, and feature requests. */
|
|
103
104
|
feedback;
|
|
104
105
|
/**
|
|
@@ -126,7 +127,7 @@ export class Signa {
|
|
|
126
127
|
/** Event stream: list, retrieve with diffs. */
|
|
127
128
|
events;
|
|
128
129
|
/**
|
|
129
|
-
* Screening — INTERNAL/
|
|
130
|
+
* Screening — INTERNAL/alpha (`screening:read` scope). `checkListing` extracts
|
|
130
131
|
* candidate marks from listing text and returns a listing-level verdict.
|
|
131
132
|
*/
|
|
132
133
|
screening;
|
|
@@ -134,6 +135,8 @@ export class Signa {
|
|
|
134
135
|
compare;
|
|
135
136
|
/** Organization: identity, usage, API key management. */
|
|
136
137
|
organization;
|
|
138
|
+
/** Published credit prices by API action. */
|
|
139
|
+
credits;
|
|
137
140
|
/** @internal */
|
|
138
141
|
_config;
|
|
139
142
|
constructor(opts = {}) {
|
|
@@ -181,16 +184,16 @@ export class Signa {
|
|
|
181
184
|
this.attorneys = new Attorneys(this._config);
|
|
182
185
|
this.firms = new Firms(this._config);
|
|
183
186
|
this.proceedings = new Proceedings(this._config);
|
|
187
|
+
this.citations = new Citations(this._config);
|
|
184
188
|
this.assignments = new Assignments(this._config);
|
|
185
|
-
this.suggest = new Suggest(this._config);
|
|
186
189
|
this.references = new References(this._config);
|
|
187
190
|
this.analytics = new Analytics(this._config);
|
|
188
191
|
this.deadlines = new Deadlines(this._config);
|
|
192
|
+
this.fees = new Fees(this._config);
|
|
189
193
|
this.oppositions = new Oppositions(this._config);
|
|
190
194
|
this.reconcile = new Reconcile(this._config);
|
|
191
195
|
this.goodsServices = new GoodsServices(this._config);
|
|
192
196
|
this.portfolios = new Portfolios(this._config);
|
|
193
|
-
this.savedSearches = new SavedSearches(this._config);
|
|
194
197
|
this.feedback = new FeedbackResource(this._config);
|
|
195
198
|
this.watches = new Watches(this._config);
|
|
196
199
|
this.alerts = new Alerts(this._config);
|
|
@@ -198,6 +201,7 @@ export class Signa {
|
|
|
198
201
|
this.events = new Events(this._config);
|
|
199
202
|
this.screening = new Screening(this._config);
|
|
200
203
|
this.compare = new Compare(this._config);
|
|
204
|
+
this.credits = new Credits(this._config);
|
|
201
205
|
this.organization = new Organization(this._config);
|
|
202
206
|
}
|
|
203
207
|
}
|
package/dist/client.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"client.js","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"client.js","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,wBAAwB,CAAC;AAGjD,OAAO,EACL,UAAU,EACV,aAAa,EACb,eAAe,EACf,mBAAmB,EACnB,eAAe,EACf,aAAa,EACb,aAAa,EACb,SAAS,EACT,cAAc,EACd,mBAAmB,EACnB,eAAe,EACf,YAAY,GACb,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,UAAU,EAAE,MAAM,2BAA2B,CAAC;AACvD,OAAO,EAAE,MAAM,EAAE,MAAM,uBAAuB,CAAC;AAC/C,OAAO,EAAE,QAAQ,EAAE,MAAM,yBAAyB,CAAC;AACnD,OAAO,EAAE,SAAS,EAAE,MAAM,0BAA0B,CAAC;AACrD,OAAO,EAAE,KAAK,EAAE,MAAM,sBAAsB,CAAC;AAC7C,OAAO,EAAE,WAAW,EAAE,MAAM,4BAA4B,CAAC;AACzD,OAAO,EAAE,SAAS,EAAE,MAAM,0BAA0B,CAAC;AACrD,OAAO,EAAE,WAAW,EAAE,MAAM,4BAA4B,CAAC;AACzD,OAAO,EAAE,UAAU,EAAE,MAAM,2BAA2B,CAAC;AACvD,OAAO,EAAE,SAAS,EAAE,MAAM,0BAA0B,CAAC;AACrD,OAAO,EAAE,IAAI,EAAE,MAAM,qBAAqB,CAAC;AAC3C,OAAO,EAAE,SAAS,EAAE,MAAM,0BAA0B,CAAC;AACrD,OAAO,EAAE,WAAW,EAAE,MAAM,4BAA4B,CAAC;AACzD,OAAO,EAAE,SAAS,EAAE,MAAM,0BAA0B,CAAC;AACrD,OAAO,EAAE,aAAa,EAAE,MAAM,+BAA+B,CAAC;AAC9D,OAAO,EAAE,UAAU,EAAE,MAAM,2BAA2B,CAAC;AACvD,OAAO,EAAE,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AAC3D,OAAO,EAAE,OAAO,EAAE,MAAM,wBAAwB,CAAC;AACjD,OAAO,EAAE,MAAM,EAAE,MAAM,uBAAuB,CAAC;AAC/C,OAAO,EAAE,QAAQ,EAAE,MAAM,yBAAyB,CAAC;AACnD,OAAO,EAAE,MAAM,EAAE,MAAM,uBAAuB,CAAC;AAC/C,OAAO,EAAE,SAAS,EAAE,MAAM,0BAA0B,CAAC;AACrD,OAAO,EAAE,OAAO,EAAE,MAAM,wBAAwB,CAAC;AACjD,OAAO,EAAE,YAAY,EAAE,MAAM,6BAA6B,CAAC;AAE3D,MAAM,gBAAgB,GAAG,sBAAsB,CAAC;AAChD,MAAM,eAAe,GAAG,MAAM,CAAC;AAC/B,MAAM,mBAAmB,GAAG,CAAC,CAAC;AAE9B;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,MAAM,OAAO,KAAK;IAChB,qEAAqE;IACrE,MAAM,CAAU,UAAU,GAAG,UAAU,CAAC;IACxC,MAAM,CAAU,aAAa,GAAG,aAAa,CAAC;IAC9C,MAAM,CAAU,eAAe,GAAG,eAAe,CAAC;IAClD,MAAM,CAAU,mBAAmB,GAAG,mBAAmB,CAAC;IAC1D,MAAM,CAAU,eAAe,GAAG,eAAe,CAAC;IAClD,MAAM,CAAU,aAAa,GAAG,aAAa,CAAC;IAC9C,MAAM,CAAU,aAAa,GAAG,aAAa,CAAC;IAC9C,MAAM,CAAU,SAAS,GAAG,SAAS,CAAC;IACtC,MAAM,CAAU,cAAc,GAAG,cAAc,CAAC;IAChD,MAAM,CAAU,mBAAmB,GAAG,mBAAmB,CAAC;IAC1D,MAAM,CAAU,eAAe,GAAG,eAAe,CAAC;IAClD,MAAM,CAAU,YAAY,GAAG,YAAY,CAAC;IAE5C,qDAAqD;IAC5C,UAAU,CAAa;IAEhC,oDAAoD;IAC3C,MAAM,CAAS;IAExB,uEAAuE;IAC9D,QAAQ,CAAW;IAE5B,uDAAuD;IAC9C,SAAS,CAAY;IAE9B,8DAA8D;IACrD,KAAK,CAAQ;IAEtB,6CAA6C;IACpC,WAAW,CAAc;IAElC,oEAAoE;IAC3D,SAAS,CAAY;IAE9B,6CAA6C;IACpC,WAAW,CAAc;IAElC,0FAA0F;IACjF,UAAU,CAAa;IACvB,SAAS,CAAY;IAE9B,qEAAqE;IAC5D,SAAS,CAAY;IACrB,IAAI,CAAO;IAEpB,kEAAkE;IACzD,WAAW,CAAc;IAElC,oEAAoE;IAC3D,SAAS,CAAY;IAE9B;;;OAGG;IACM,aAAa,CAAgB;IAEtC,oDAAoD;IAC3C,UAAU,CAAa;IAEhC,gFAAgF;IACvE,QAAQ,CAAmB;IAEpC;;;;;;;OAOG;IACM,OAAO,CAAU;IAE1B;;;;OAIG;IACM,MAAM,CAAS;IAExB;;;;;OAKG;IACM,QAAQ,CAAW;IAE5B,+CAA+C;IACtC,MAAM,CAAS;IAExB;;;OAGG;IACM,SAAS,CAAY;IAE9B,8DAA8D;IACrD,OAAO,CAAU;IAE1B,yDAAyD;IAChD,YAAY,CAAe;IAEpC,6CAA6C;IACpC,OAAO,CAAU;IAE1B,gBAAgB;IACC,OAAO,CAAc;IAEtC,YAAY,OAAsB,EAAE;QAClC,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,IAAI,OAAO,CAAC,eAAe,CAAC,CAAC;QACxD,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,MAAM,IAAI,UAAU,CAClB,iGAAiG,CAClG,CAAC;QACJ,CAAC;QAED,oEAAoE;QACpE,+DAA+D;QAC/D,4DAA4D;QAC5D,qEAAqE;QACrE,mEAAmE;QACnE,+CAA+C;QAC/C,EAAE;QACF,6DAA6D;QAC7D,iEAAiE;QACjE,iDAAiD;QACjD,IAAI,OAAQ,UAAmC,CAAC,MAAM,KAAK,WAAW,EAAE,CAAC;YACvE,MAAM,YAAY,GAAG,IAAI,CAAC,YAAY,KAAK,IAAI,IAAI,OAAO,CAAC,qBAAqB,CAAC,KAAK,GAAG,CAAC;YAC1F,IAAI,CAAC,YAAY,EAAE,CAAC;gBAClB,OAAO,CAAC,IAAI,CACV,8JAA8J,CAC/J,CAAC;YACJ,CAAC;QACH,CAAC;QAED,uBAAuB;QACvB,MAAM,UAAU,GAAG,IAAI,CAAC,WAAW,IAAI,mBAAmB,CAAC;QAC3D,IAAI,UAAU,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,UAAU,CAAC,EAAE,CAAC;YACpD,MAAM,IAAI,UAAU,CAAC,4CAA4C,CAAC,CAAC;QACrE,CAAC;QAED,uCAAuC;QACvC,MAAM,OAAO,GAAG,CAAC,IAAI,CAAC,QAAQ,IAAI,gBAAgB,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;QACxE,IAAI,OAAO,CAAC,UAAU,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAC,EAAE,CAAC;YACtG,MAAM,IAAI,UAAU,CAAC,gDAAgD,CAAC,CAAC;QACzE,CAAC;QAED,IAAI,CAAC,OAAO,GAAG;YACb,MAAM;YACN,OAAO;YACP,OAAO,EAAE,IAAI,CAAC,OAAO,IAAI,eAAe;YACxC,UAAU;YACV,KAAK,EAAE,IAAI,CAAC,KAAK,IAAI,KAAK;YAC1B,KAAK,EAAE,IAAI,CAAC,KAAK,IAAI,UAAU,CAAC,KAAK;SACtC,CAAC;QAEF,IAAI,CAAC,UAAU,GAAG,IAAI,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC/C,IAAI,CAAC,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACvC,IAAI,CAAC,QAAQ,GAAG,IAAI,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC3C,IAAI,CAAC,SAAS,GAAG,IAAI,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC7C,IAAI,CAAC,KAAK,GAAG,IAAI,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACrC,IAAI,CAAC,WAAW,GAAG,IAAI,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACjD,IAAI,CAAC,SAAS,GAAG,IAAI,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC7C,IAAI,CAAC,WAAW,GAAG,IAAI,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACjD,IAAI,CAAC,UAAU,GAAG,IAAI,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC/C,IAAI,CAAC,SAAS,GAAG,IAAI,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC7C,IAAI,CAAC,SAAS,GAAG,IAAI,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC7C,IAAI,CAAC,IAAI,GAAG,IAAI,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACnC,IAAI,CAAC,WAAW,GAAG,IAAI,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACjD,IAAI,CAAC,SAAS,GAAG,IAAI,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC7C,IAAI,CAAC,aAAa,GAAG,IAAI,aAAa,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACrD,IAAI,CAAC,UAAU,GAAG,IAAI,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC/C,IAAI,CAAC,QAAQ,GAAG,IAAI,gBAAgB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACnD,IAAI,CAAC,OAAO,GAAG,IAAI,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACzC,IAAI,CAAC,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACvC,IAAI,CAAC,QAAQ,GAAG,IAAI,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC3C,IAAI,CAAC,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACvC,IAAI,CAAC,SAAS,GAAG,IAAI,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC7C,IAAI,CAAC,OAAO,GAAG,IAAI,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACzC,IAAI,CAAC,OAAO,GAAG,IAAI,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACzC,IAAI,CAAC,YAAY,GAAG,IAAI,YAAY,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IACrD,CAAC;;AAGH,iFAAiF;AACjF,SAAS,OAAO,CAAC,IAAY;IAC3B,IAAI,OAAO,OAAO,KAAK,WAAW,IAAI,OAAO,CAAC,GAAG,EAAE,CAAC;QAClD,OAAO,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IAC3B,CAAC;IACD,OAAO,SAAS,CAAC;AACnB,CAAC"}
|
package/dist/errors.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import type { APIErrorBody } from './types.js';
|
|
1
|
+
import type { APIErrorBody, ExternalRefConflictErrorBody, ResourceQuotaExceededErrorBody } from './types.js';
|
|
2
2
|
/**
|
|
3
3
|
* Base error for all SDK errors. Thrown for client-side issues
|
|
4
4
|
* (missing config, invalid arguments) — not API errors.
|
|
@@ -33,6 +33,14 @@ export declare class NotFoundError extends SignaAPIError {
|
|
|
33
33
|
export declare class ConflictError extends SignaAPIError {
|
|
34
34
|
constructor(error: APIErrorBody, requestId: string, headers: Headers);
|
|
35
35
|
}
|
|
36
|
+
/**
|
|
37
|
+
* Thrown when a resource or checkpoint is permanently gone. Callers must
|
|
38
|
+
* branch on `error.type`: `entity_merged`, `endpoint_deprecated`, and
|
|
39
|
+
* `replay_window_expired` require different recovery paths.
|
|
40
|
+
*/
|
|
41
|
+
export declare class GoneError extends SignaAPIError {
|
|
42
|
+
constructor(error: APIErrorBody, requestId: string, headers: Headers);
|
|
43
|
+
}
|
|
36
44
|
export declare class RateLimitError extends SignaAPIError {
|
|
37
45
|
/** Seconds until the rate limit resets. Parsed from Retry-After header. */
|
|
38
46
|
readonly retry_after: number;
|
|
@@ -50,6 +58,30 @@ export declare class ConnectionError extends SignaError {
|
|
|
50
58
|
export declare class TimeoutError extends SignaError {
|
|
51
59
|
constructor(timeoutMs: number);
|
|
52
60
|
}
|
|
61
|
+
/**
|
|
62
|
+
* Thrown by `SignaList.toArray()` instead of returning a short array.
|
|
63
|
+
*
|
|
64
|
+
* - `reason: 'client_limit'`: called without a `limit` and the list holds more
|
|
65
|
+
* than the default safety cap (10,000 items).
|
|
66
|
+
* - `reason: 'server_window'`: the API ended the walk at its 10,000-row
|
|
67
|
+
* pagination window while more rows match (a relevance-ranked or sorted
|
|
68
|
+
* trademark search; the last page carries a `result_window_reached`
|
|
69
|
+
* warning), before `limit` was reached.
|
|
70
|
+
*
|
|
71
|
+
* `items` holds what was collected. For `client_limit`, pass
|
|
72
|
+
* `toArray({ limit })` (`Infinity` for every item) or iterate with
|
|
73
|
+
* `for await`. For `server_window`, narrow the query, or pull in bulk with a
|
|
74
|
+
* filter-only browse sorted by `family_updated_at`, which pages past 10,000.
|
|
75
|
+
*/
|
|
76
|
+
export declare class SignaTruncatedError<T = unknown> extends SignaError {
|
|
77
|
+
/** The items collected before the walk stopped. */
|
|
78
|
+
readonly items: T[];
|
|
79
|
+
/** The cap that was reached (10,000). */
|
|
80
|
+
readonly limit: number;
|
|
81
|
+
/** Which cap stopped the walk. */
|
|
82
|
+
readonly reason: 'client_limit' | 'server_window';
|
|
83
|
+
constructor(items: T[], limit: number, reason?: 'client_limit' | 'server_window');
|
|
84
|
+
}
|
|
53
85
|
/**
|
|
54
86
|
* Create the appropriate typed error from an HTTP error response.
|
|
55
87
|
* 5xx -> InternalServerError (carries actual status).
|
|
@@ -59,6 +91,27 @@ export declare function createAPIError(status: number, body: {
|
|
|
59
91
|
error: APIErrorBody;
|
|
60
92
|
request_id: string;
|
|
61
93
|
}, headers: Headers): SignaAPIError;
|
|
94
|
+
/**
|
|
95
|
+
* Narrow a caught error to the ENG-342 `external_ref_conflict` 409.
|
|
96
|
+
*
|
|
97
|
+
* Both `external_ref_conflict` and the generic `conflict` (reused
|
|
98
|
+
* `Idempotency-Key`) arrive as a {@link ConflictError}, and only the first is
|
|
99
|
+
* fixable by the caller — pick a different reference, or remove the mark and
|
|
100
|
+
* add it again to rebind.
|
|
101
|
+
*/
|
|
102
|
+
export declare function isExternalRefConflict(error: unknown): error is ConflictError & {
|
|
103
|
+
error: ExternalRefConflictErrorBody;
|
|
104
|
+
};
|
|
105
|
+
/**
|
|
106
|
+
* Narrow a caught error to a `resource_quota_exceeded` 409 and expose its
|
|
107
|
+
* machine-readable `quota_*` extras.
|
|
108
|
+
*
|
|
109
|
+
* Pass `scope` to match one cap only — e.g. `'managed_marks'` for the
|
|
110
|
+
* per-plan cap on distinct trademarks across all of an org's portfolios.
|
|
111
|
+
*/
|
|
112
|
+
export declare function isResourceQuotaExceeded(error: unknown, scope?: ResourceQuotaExceededErrorBody['quota_scope']): error is ConflictError & {
|
|
113
|
+
error: ResourceQuotaExceededErrorBody;
|
|
114
|
+
};
|
|
62
115
|
/**
|
|
63
116
|
* Returns true if this error is retryable (connection, timeout, 429, 5xx).
|
|
64
117
|
*
|
package/dist/errors.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,
|
|
1
|
+
{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,YAAY,EACZ,4BAA4B,EAC5B,8BAA8B,EAC/B,MAAM,YAAY,CAAC;AAEpB;;;GAGG;AACH,qBAAa,UAAW,SAAQ,KAAK;gBACvB,OAAO,EAAE,MAAM;CAI5B;AAED;;;GAGG;AACH,qBAAa,aAAc,SAAQ,UAAU;IAC3C,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,KAAK,EAAE,YAAY,CAAC;IAC7B,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAC5B,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;gBAEd,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,YAAY,EAAE,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO;CAUrF;AAID,qBAAa,eAAgB,SAAQ,aAAa;gBACpC,KAAK,EAAE,YAAY,EAAE,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO;CAIrE;AAED,qBAAa,mBAAoB,SAAQ,aAAa;gBACxC,KAAK,EAAE,YAAY,EAAE,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO;CAIrE;AAED,qBAAa,eAAgB,SAAQ,aAAa;gBACpC,KAAK,EAAE,YAAY,EAAE,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO;CAIrE;AAED,qBAAa,aAAc,SAAQ,aAAa;gBAClC,KAAK,EAAE,YAAY,EAAE,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO;CAIrE;AAED,uEAAuE;AACvE,qBAAa,aAAc,SAAQ,aAAa;gBAClC,KAAK,EAAE,YAAY,EAAE,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO;CAIrE;AAED;;;;GAIG;AACH,qBAAa,SAAU,SAAQ,aAAa;gBAC9B,KAAK,EAAE,YAAY,EAAE,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO;CAIrE;AAED,qBAAa,cAAe,SAAQ,aAAa;IAC/C,2EAA2E;IAC3E,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;gBAEjB,KAAK,EAAE,YAAY,EAAE,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO;CAKrE;AAED,qBAAa,mBAAoB,SAAQ,aAAa;gBACxC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,YAAY,EAAE,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO;CAIrF;AAED,6DAA6D;AAC7D,qBAAa,eAAgB,SAAQ,UAAU;IAC7C,SAAkB,KAAK,CAAC,EAAE,KAAK,CAAC;gBAEpB,OAAO,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,KAAK;CAK3C;AAED,yCAAyC;AACzC,qBAAa,YAAa,SAAQ,UAAU;gBAC9B,SAAS,EAAE,MAAM;CAI9B;AAED;;;;;;;;;;;;;;GAcG;AACH,qBAAa,mBAAmB,CAAC,CAAC,GAAG,OAAO,CAAE,SAAQ,UAAU;IAC9D,mDAAmD;IACnD,QAAQ,CAAC,KAAK,EAAE,CAAC,EAAE,CAAC;IACpB,yCAAyC;IACzC,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,kCAAkC;IAClC,QAAQ,CAAC,MAAM,EAAE,cAAc,GAAG,eAAe,CAAC;gBAEtC,KAAK,EAAE,CAAC,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,GAAE,cAAc,GAAG,eAAgC;CAajG;AAiBD;;;;GAIG;AACH,wBAAgB,cAAc,CAC5B,MAAM,EAAE,MAAM,EACd,IAAI,EAAE;IAAE,KAAK,EAAE,YAAY,CAAC;IAAC,UAAU,EAAE,MAAM,CAAA;CAAE,EACjD,OAAO,EAAE,OAAO,GACf,aAAa,CA0Bf;AAID;;;;;;;GAOG;AACH,wBAAgB,qBAAqB,CACnC,KAAK,EAAE,OAAO,GACb,KAAK,IAAI,aAAa,GAAG;IAAE,KAAK,EAAE,4BAA4B,CAAA;CAAE,CAElE;AAED;;;;;;GAMG;AACH,wBAAgB,uBAAuB,CACrC,KAAK,EAAE,OAAO,EACd,KAAK,CAAC,EAAE,8BAA8B,CAAC,aAAa,CAAC,GACpD,KAAK,IAAI,aAAa,GAAG;IAAE,KAAK,EAAE,8BAA8B,CAAA;CAAE,CAKpE;AAgBD;;;;;;;;;GASG;AACH,wBAAgB,WAAW,CAAC,KAAK,EAAE,OAAO,GAAG,OAAO,CAOnD"}
|
package/dist/errors.js
CHANGED
|
@@ -21,7 +21,9 @@ export class SignaAPIError extends SignaError {
|
|
|
21
21
|
super(`${status} ${error?.title ?? 'Error'}: ${error?.detail ?? 'Unknown error'}`);
|
|
22
22
|
this.name = 'SignaAPIError';
|
|
23
23
|
this.status = status;
|
|
24
|
-
this.error =
|
|
24
|
+
this.error =
|
|
25
|
+
error ??
|
|
26
|
+
{ type: 'unknown', title: 'Error', status, detail: 'Unknown error' };
|
|
25
27
|
this.request_id = requestId ?? 'unknown';
|
|
26
28
|
this.headers = headers;
|
|
27
29
|
}
|
|
@@ -58,6 +60,17 @@ export class ConflictError extends SignaAPIError {
|
|
|
58
60
|
this.name = 'ConflictError';
|
|
59
61
|
}
|
|
60
62
|
}
|
|
63
|
+
/**
|
|
64
|
+
* Thrown when a resource or checkpoint is permanently gone. Callers must
|
|
65
|
+
* branch on `error.type`: `entity_merged`, `endpoint_deprecated`, and
|
|
66
|
+
* `replay_window_expired` require different recovery paths.
|
|
67
|
+
*/
|
|
68
|
+
export class GoneError extends SignaAPIError {
|
|
69
|
+
constructor(error, requestId, headers) {
|
|
70
|
+
super(410, error, requestId, headers);
|
|
71
|
+
this.name = 'GoneError';
|
|
72
|
+
}
|
|
73
|
+
}
|
|
61
74
|
export class RateLimitError extends SignaAPIError {
|
|
62
75
|
/** Seconds until the rate limit resets. Parsed from Retry-After header. */
|
|
63
76
|
retry_after;
|
|
@@ -89,6 +102,40 @@ export class TimeoutError extends SignaError {
|
|
|
89
102
|
this.name = 'TimeoutError';
|
|
90
103
|
}
|
|
91
104
|
}
|
|
105
|
+
/**
|
|
106
|
+
* Thrown by `SignaList.toArray()` instead of returning a short array.
|
|
107
|
+
*
|
|
108
|
+
* - `reason: 'client_limit'`: called without a `limit` and the list holds more
|
|
109
|
+
* than the default safety cap (10,000 items).
|
|
110
|
+
* - `reason: 'server_window'`: the API ended the walk at its 10,000-row
|
|
111
|
+
* pagination window while more rows match (a relevance-ranked or sorted
|
|
112
|
+
* trademark search; the last page carries a `result_window_reached`
|
|
113
|
+
* warning), before `limit` was reached.
|
|
114
|
+
*
|
|
115
|
+
* `items` holds what was collected. For `client_limit`, pass
|
|
116
|
+
* `toArray({ limit })` (`Infinity` for every item) or iterate with
|
|
117
|
+
* `for await`. For `server_window`, narrow the query, or pull in bulk with a
|
|
118
|
+
* filter-only browse sorted by `family_updated_at`, which pages past 10,000.
|
|
119
|
+
*/
|
|
120
|
+
export class SignaTruncatedError extends SignaError {
|
|
121
|
+
/** The items collected before the walk stopped. */
|
|
122
|
+
items;
|
|
123
|
+
/** The cap that was reached (10,000). */
|
|
124
|
+
limit;
|
|
125
|
+
/** Which cap stopped the walk. */
|
|
126
|
+
reason;
|
|
127
|
+
constructor(items, limit, reason = 'client_limit') {
|
|
128
|
+
super(reason === 'client_limit'
|
|
129
|
+
? `toArray() stopped at its default cap of ${limit.toLocaleString('en-US')} items and more remain. ` +
|
|
130
|
+
'Pass toArray({ limit }) (Infinity for every item) or iterate with for await.'
|
|
131
|
+
: `The API ends this search at its ${limit.toLocaleString('en-US')}-row pagination window and more rows match. ` +
|
|
132
|
+
'Narrow the query, or pull in bulk with a filter-only browse sorted by family_updated_at, which pages past the window.');
|
|
133
|
+
this.name = 'SignaTruncatedError';
|
|
134
|
+
this.items = items;
|
|
135
|
+
this.limit = limit;
|
|
136
|
+
this.reason = reason;
|
|
137
|
+
}
|
|
138
|
+
}
|
|
92
139
|
// ── Factory: maps HTTP status to typed error ────────────────────────
|
|
93
140
|
const STATUS_ERROR_MAP = {
|
|
94
141
|
400: BadRequestError,
|
|
@@ -96,6 +143,7 @@ const STATUS_ERROR_MAP = {
|
|
|
96
143
|
403: PermissionError,
|
|
97
144
|
404: NotFoundError,
|
|
98
145
|
409: ConflictError,
|
|
146
|
+
410: GoneError,
|
|
99
147
|
429: RateLimitError,
|
|
100
148
|
};
|
|
101
149
|
/**
|
|
@@ -105,13 +153,17 @@ const STATUS_ERROR_MAP = {
|
|
|
105
153
|
*/
|
|
106
154
|
export function createAPIError(status, body, headers) {
|
|
107
155
|
// Structural validation — handle WAF/ALB/non-standard JSON
|
|
108
|
-
const error =
|
|
156
|
+
const error = body?.error && typeof body.error.type === 'string'
|
|
109
157
|
? body.error
|
|
110
158
|
: {
|
|
111
159
|
type: 'unknown',
|
|
112
160
|
title: 'Error',
|
|
113
161
|
status,
|
|
114
|
-
detail: body?.error?.message ??
|
|
162
|
+
detail: body?.error?.message ??
|
|
163
|
+
body?.error?.detail ??
|
|
164
|
+
body?.message ??
|
|
165
|
+
body?.detail ??
|
|
166
|
+
`HTTP ${status}`,
|
|
115
167
|
};
|
|
116
168
|
const requestId = body?.request_id ?? headers?.get?.('x-request-id') ?? 'unknown';
|
|
117
169
|
const ErrorClass = STATUS_ERROR_MAP[status];
|
|
@@ -123,6 +175,31 @@ export function createAPIError(status, body, headers) {
|
|
|
123
175
|
}
|
|
124
176
|
return new SignaAPIError(status, error, requestId, headers);
|
|
125
177
|
}
|
|
178
|
+
// ── Slug narrowing (409s a caller is expected to branch on) ─────────
|
|
179
|
+
/**
|
|
180
|
+
* Narrow a caught error to the ENG-342 `external_ref_conflict` 409.
|
|
181
|
+
*
|
|
182
|
+
* Both `external_ref_conflict` and the generic `conflict` (reused
|
|
183
|
+
* `Idempotency-Key`) arrive as a {@link ConflictError}, and only the first is
|
|
184
|
+
* fixable by the caller — pick a different reference, or remove the mark and
|
|
185
|
+
* add it again to rebind.
|
|
186
|
+
*/
|
|
187
|
+
export function isExternalRefConflict(error) {
|
|
188
|
+
return error instanceof SignaAPIError && error.error?.type === 'external_ref_conflict';
|
|
189
|
+
}
|
|
190
|
+
/**
|
|
191
|
+
* Narrow a caught error to a `resource_quota_exceeded` 409 and expose its
|
|
192
|
+
* machine-readable `quota_*` extras.
|
|
193
|
+
*
|
|
194
|
+
* Pass `scope` to match one cap only — e.g. `'managed_marks'` for the
|
|
195
|
+
* per-plan cap on distinct trademarks across all of an org's portfolios.
|
|
196
|
+
*/
|
|
197
|
+
export function isResourceQuotaExceeded(error, scope) {
|
|
198
|
+
if (!(error instanceof SignaAPIError) || error.error?.type !== 'resource_quota_exceeded') {
|
|
199
|
+
return false;
|
|
200
|
+
}
|
|
201
|
+
return scope === undefined || error.error.quota_scope === scope;
|
|
202
|
+
}
|
|
126
203
|
// ── Helpers ──────────────────────────────────────────────────────────
|
|
127
204
|
function parseRetryAfter(headers) {
|
|
128
205
|
const value = headers.get('retry-after');
|
package/dist/errors.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"errors.js","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"errors.js","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":"AAMA;;;GAGG;AACH,MAAM,OAAO,UAAW,SAAQ,KAAK;IACnC,YAAY,OAAe;QACzB,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,IAAI,GAAG,YAAY,CAAC;IAC3B,CAAC;CACF;AAED;;;GAGG;AACH,MAAM,OAAO,aAAc,SAAQ,UAAU;IAClC,MAAM,CAAS;IACf,KAAK,CAAe;IACpB,UAAU,CAAS;IACnB,OAAO,CAAU;IAE1B,YAAY,MAAc,EAAE,KAAmB,EAAE,SAAiB,EAAE,OAAgB;QAClF,KAAK,CAAC,GAAG,MAAM,IAAI,KAAK,EAAE,KAAK,IAAI,OAAO,KAAK,KAAK,EAAE,MAAM,IAAI,eAAe,EAAE,CAAC,CAAC;QACnF,IAAI,CAAC,IAAI,GAAG,eAAe,CAAC;QAC5B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,KAAK;YACR,KAAK;gBACJ,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,eAAe,EAAmB,CAAC;QACzF,IAAI,CAAC,UAAU,GAAG,SAAS,IAAI,SAAS,CAAC;QACzC,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;IACzB,CAAC;CACF;AAED,uEAAuE;AAEvE,MAAM,OAAO,eAAgB,SAAQ,aAAa;IAChD,YAAY,KAAmB,EAAE,SAAiB,EAAE,OAAgB;QAClE,KAAK,CAAC,GAAG,EAAE,KAAK,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;QACtC,IAAI,CAAC,IAAI,GAAG,iBAAiB,CAAC;IAChC,CAAC;CACF;AAED,MAAM,OAAO,mBAAoB,SAAQ,aAAa;IACpD,YAAY,KAAmB,EAAE,SAAiB,EAAE,OAAgB;QAClE,KAAK,CAAC,GAAG,EAAE,KAAK,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;QACtC,IAAI,CAAC,IAAI,GAAG,qBAAqB,CAAC;IACpC,CAAC;CACF;AAED,MAAM,OAAO,eAAgB,SAAQ,aAAa;IAChD,YAAY,KAAmB,EAAE,SAAiB,EAAE,OAAgB;QAClE,KAAK,CAAC,GAAG,EAAE,KAAK,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;QACtC,IAAI,CAAC,IAAI,GAAG,iBAAiB,CAAC;IAChC,CAAC;CACF;AAED,MAAM,OAAO,aAAc,SAAQ,aAAa;IAC9C,YAAY,KAAmB,EAAE,SAAiB,EAAE,OAAgB;QAClE,KAAK,CAAC,GAAG,EAAE,KAAK,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;QACtC,IAAI,CAAC,IAAI,GAAG,eAAe,CAAC;IAC9B,CAAC;CACF;AAED,uEAAuE;AACvE,MAAM,OAAO,aAAc,SAAQ,aAAa;IAC9C,YAAY,KAAmB,EAAE,SAAiB,EAAE,OAAgB;QAClE,KAAK,CAAC,GAAG,EAAE,KAAK,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;QACtC,IAAI,CAAC,IAAI,GAAG,eAAe,CAAC;IAC9B,CAAC;CACF;AAED;;;;GAIG;AACH,MAAM,OAAO,SAAU,SAAQ,aAAa;IAC1C,YAAY,KAAmB,EAAE,SAAiB,EAAE,OAAgB;QAClE,KAAK,CAAC,GAAG,EAAE,KAAK,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;QACtC,IAAI,CAAC,IAAI,GAAG,WAAW,CAAC;IAC1B,CAAC;CACF;AAED,MAAM,OAAO,cAAe,SAAQ,aAAa;IAC/C,2EAA2E;IAClE,WAAW,CAAS;IAE7B,YAAY,KAAmB,EAAE,SAAiB,EAAE,OAAgB;QAClE,KAAK,CAAC,GAAG,EAAE,KAAK,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;QACtC,IAAI,CAAC,IAAI,GAAG,gBAAgB,CAAC;QAC7B,IAAI,CAAC,WAAW,GAAG,eAAe,CAAC,OAAO,CAAC,CAAC;IAC9C,CAAC;CACF;AAED,MAAM,OAAO,mBAAoB,SAAQ,aAAa;IACpD,YAAY,MAAc,EAAE,KAAmB,EAAE,SAAiB,EAAE,OAAgB;QAClF,KAAK,CAAC,MAAM,EAAE,KAAK,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;QACzC,IAAI,CAAC,IAAI,GAAG,qBAAqB,CAAC;IACpC,CAAC;CACF;AAED,6DAA6D;AAC7D,MAAM,OAAO,eAAgB,SAAQ,UAAU;IAC3B,KAAK,CAAS;IAEhC,YAAY,OAAe,EAAE,KAAa;QACxC,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,IAAI,GAAG,iBAAiB,CAAC;QAC9B,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;IACrB,CAAC;CACF;AAED,yCAAyC;AACzC,MAAM,OAAO,YAAa,SAAQ,UAAU;IAC1C,YAAY,SAAiB;QAC3B,KAAK,CAAC,2BAA2B,SAAS,IAAI,CAAC,CAAC;QAChD,IAAI,CAAC,IAAI,GAAG,cAAc,CAAC;IAC7B,CAAC;CACF;AAED;;;;;;;;;;;;;;GAcG;AACH,MAAM,OAAO,mBAAiC,SAAQ,UAAU;IAC9D,mDAAmD;IAC1C,KAAK,CAAM;IACpB,yCAAyC;IAChC,KAAK,CAAS;IACvB,kCAAkC;IACzB,MAAM,CAAmC;IAElD,YAAY,KAAU,EAAE,KAAa,EAAE,SAA2C,cAAc;QAC9F,KAAK,CACH,MAAM,KAAK,cAAc;YACvB,CAAC,CAAC,2CAA2C,KAAK,CAAC,cAAc,CAAC,OAAO,CAAC,0BAA0B;gBAChG,8EAA8E;YAClF,CAAC,CAAC,mCAAmC,KAAK,CAAC,cAAc,CAAC,OAAO,CAAC,8CAA8C;gBAC5G,uHAAuH,CAC9H,CAAC;QACF,IAAI,CAAC,IAAI,GAAG,qBAAqB,CAAC;QAClC,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QACnB,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QACnB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;CACF;AAED,uEAAuE;AAEvE,MAAM,gBAAgB,GAGlB;IACF,GAAG,EAAE,eAAe;IACpB,GAAG,EAAE,mBAAmB;IACxB,GAAG,EAAE,eAAe;IACpB,GAAG,EAAE,aAAa;IAClB,GAAG,EAAE,aAAa;IAClB,GAAG,EAAE,SAAS;IACd,GAAG,EAAE,cAAc;CACpB,CAAC;AAEF;;;;GAIG;AACH,MAAM,UAAU,cAAc,CAC5B,MAAc,EACd,IAAiD,EACjD,OAAgB;IAEhB,2DAA2D;IAC3D,MAAM,KAAK,GACT,IAAI,EAAE,KAAK,IAAI,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,KAAK,QAAQ;QAChD,CAAC,CAAC,IAAI,CAAC,KAAK;QACZ,CAAC,CAAC;YACE,IAAI,EAAE,SAAS;YACf,KAAK,EAAE,OAAO;YACd,MAAM;YACN,MAAM,EACH,IAAI,EAAE,KAAa,EAAE,OAAO;gBAC5B,IAAI,EAAE,KAAa,EAAE,MAAM;gBAC3B,IAAY,EAAE,OAAO;gBACrB,IAAY,EAAE,MAAM;gBACrB,QAAQ,MAAM,EAAE;SACnB,CAAC;IACR,MAAM,SAAS,GAAG,IAAI,EAAE,UAAU,IAAI,OAAO,EAAE,GAAG,EAAE,CAAC,cAAc,CAAC,IAAI,SAAS,CAAC;IAElF,MAAM,UAAU,GAAG,gBAAgB,CAAC,MAAM,CAAC,CAAC;IAC5C,IAAI,UAAU,EAAE,CAAC;QACf,OAAO,IAAI,UAAU,CAAC,KAAK,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;IACnD,CAAC;IACD,IAAI,MAAM,IAAI,GAAG,EAAE,CAAC;QAClB,OAAO,IAAI,mBAAmB,CAAC,MAAM,EAAE,KAAK,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;IACpE,CAAC;IACD,OAAO,IAAI,aAAa,CAAC,MAAM,EAAE,KAAK,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;AAC9D,CAAC;AAED,uEAAuE;AAEvE;;;;;;;GAOG;AACH,MAAM,UAAU,qBAAqB,CACnC,KAAc;IAEd,OAAO,KAAK,YAAY,aAAa,IAAI,KAAK,CAAC,KAAK,EAAE,IAAI,KAAK,uBAAuB,CAAC;AACzF,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,uBAAuB,CACrC,KAAc,EACd,KAAqD;IAErD,IAAI,CAAC,CAAC,KAAK,YAAY,aAAa,CAAC,IAAI,KAAK,CAAC,KAAK,EAAE,IAAI,KAAK,yBAAyB,EAAE,CAAC;QACzF,OAAO,KAAK,CAAC;IACf,CAAC;IACD,OAAO,KAAK,KAAK,SAAS,IAAK,KAAK,CAAC,KAAwC,CAAC,WAAW,KAAK,KAAK,CAAC;AACtG,CAAC;AAED,wEAAwE;AAExE,SAAS,eAAe,CAAC,OAAgB;IACvC,MAAM,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC;IACzC,IAAI,CAAC,KAAK;QAAE,OAAO,EAAE,CAAC;IACtB,MAAM,OAAO,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC;IAC9B,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC;QAAE,OAAO,OAAO,CAAC;IAC3C,MAAM,IAAI,GAAG,IAAI,IAAI,CAAC,KAAK,CAAC,CAAC;IAC7B,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,EAAE,CAAC;QAClC,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,OAAO,EAAE,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC;IACtE,CAAC;IACD,OAAO,EAAE,CAAC;AACZ,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,UAAU,WAAW,CAAC,KAAc;IACxC,IAAI,KAAK,YAAY,eAAe,IAAI,KAAK,YAAY,YAAY;QAAE,OAAO,IAAI,CAAC;IACnF,IAAI,KAAK,YAAY,aAAa,EAAE,CAAC;QACnC,IAAI,KAAK,CAAC,KAAK,EAAE,SAAS,KAAK,KAAK;YAAE,OAAO,KAAK,CAAC;QACnD,OAAO,KAAK,CAAC,MAAM,KAAK,GAAG,IAAI,KAAK,CAAC,MAAM,IAAI,GAAG,CAAC;IACrD,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC"}
|