@bikefinder/staff-sdk 0.11.1 → 0.13.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 +16 -2
- package/dist/{chunk-UBRRR6VL.js → chunk-WQGCHZBN.js} +80 -13
- package/dist/index.d.ts +3453 -180
- package/dist/index.js +1 -1
- package/dist/schemas.d.ts +3886 -642
- package/dist/schemas.js +13 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -4,12 +4,26 @@ Typed staff HTTP and WebSocket client for the [API](../../README.md). Version 0.
|
|
|
4
4
|
uses native oRPC contracts, Zod validation and async iterators. Customer apps use
|
|
5
5
|
[@bikefinder/sdk](../sdk/README.md). MCP invokes application workflows directly.
|
|
6
6
|
|
|
7
|
+
Version 0.13 adds compact tracker reads through `trackers.getDetails` and
|
|
8
|
+
`trackers.watchDetails`. Pass their `membership.revision` to
|
|
9
|
+
`trackers.members.list` and use `nextAfter` to continue. A revision conflict
|
|
10
|
+
means the roster changed or the tracker was recreated. Refresh the tracker
|
|
11
|
+
and start with its new membership revision. Deploy these API routes before
|
|
12
|
+
switching clients.
|
|
13
|
+
|
|
14
|
+
Version 0.12 returns the canonical bike, including its new revision, from
|
|
15
|
+
`client.api.trackers.bike.edit`. Bind the edit to the tracker resource with `trackerCreatedAt: tracker.createdAt`. Supply `expected` values for exactly the fields
|
|
16
|
+
in `changes`; the API compares them atomically and preserves unrelated edits.
|
|
17
|
+
An already-applied retry returns the current bike. Deploy the matching API before updating consumers.
|
|
18
|
+
The public `@bikefinder/staff-sdk/schemas` exports `errorData` and `errorRecovery`
|
|
19
|
+
for validating declared recovery instructions.
|
|
20
|
+
|
|
7
21
|
Version 0.11 adds `client.api.accounts.erasure.review`, `submit`, `get` and
|
|
8
22
|
`retry`. Review the exact customer and retention policy with the requester before
|
|
9
23
|
submitting `confirmation: "ERASE CUSTOMER"` and the returned `reviewVersion`.
|
|
10
24
|
Keep the same request UUID across retries. `running` and `blocked` are incomplete;
|
|
11
|
-
`cleanupAfter`
|
|
12
|
-
|
|
25
|
+
`cleanupAfter` records when access preparation finished; deletion starts immediately
|
|
26
|
+
without an in-flight allowance. The active-account gate rejects existing tokens without waiting for expiry. See the
|
|
13
27
|
[erasure workflow](../../docs/customer-erasure.md).
|
|
14
28
|
|
|
15
29
|
```ts
|
|
@@ -242,31 +242,38 @@ var tracker = z2.object({
|
|
|
242
242
|
factoryResetReports: z2.boolean()
|
|
243
243
|
})
|
|
244
244
|
});
|
|
245
|
+
var customerTrackerDetails = tracker.omit({ members: true }).extend({
|
|
246
|
+
membership: z2.object({
|
|
247
|
+
accountId: z2.string(),
|
|
248
|
+
activeMemberCount: z2.int().nonnegative()
|
|
249
|
+
})
|
|
250
|
+
});
|
|
245
251
|
|
|
246
|
-
//
|
|
247
|
-
import { oc } from "@orpc/contract";
|
|
252
|
+
// ../../../accounts/packages/client/src/contracts.ts
|
|
248
253
|
import { z as z3 } from "zod";
|
|
249
|
-
var
|
|
250
|
-
var
|
|
254
|
+
var documentId2 = z3.string().min(1).max(128).refine((v) => v.trim().length > 0 && ![".", ".."].includes(v) && !/[\\/\p{Cc}]/u.test(v) && !v.startsWith("__"), "Invalid document ID.");
|
|
255
|
+
var requestId2 = z3.guid().refine((v) => v !== "00000000-0000-0000-0000-000000000000", "Supply a nonempty request ID.").toLowerCase();
|
|
256
|
+
var erasureSelection = z3.strictObject({ accountId: documentId2 });
|
|
257
|
+
var erasureReference = z3.strictObject({ requestId: requestId2 });
|
|
251
258
|
var erasurePolicy = "anonymize-financial-records-cancel-subscriptions-preserve-shared-trackers-v1";
|
|
252
259
|
var erasureReview = z3.strictObject({
|
|
253
|
-
accountId:
|
|
260
|
+
accountId: documentId2,
|
|
254
261
|
email: z3.email(),
|
|
255
262
|
emails: z3.array(z3.email()).min(1),
|
|
256
|
-
accountIds: z3.array(
|
|
257
|
-
exclusiveTrackers: z3.array(
|
|
258
|
-
sharedTrackers: z3.array(
|
|
263
|
+
accountIds: z3.array(documentId2).min(1),
|
|
264
|
+
exclusiveTrackers: z3.array(documentId2),
|
|
265
|
+
sharedTrackers: z3.array(documentId2),
|
|
259
266
|
policy: z3.literal(erasurePolicy),
|
|
260
267
|
version: z3.string().regex(/^[a-f0-9]{64}$/)
|
|
261
268
|
});
|
|
262
269
|
var erasureSubmission = erasureReference.extend({
|
|
263
|
-
accountId:
|
|
270
|
+
accountId: documentId2,
|
|
264
271
|
reviewVersion: z3.string().regex(/^[a-f0-9]{64}$/),
|
|
265
272
|
confirmation: z3.literal("ERASE CUSTOMER")
|
|
266
273
|
});
|
|
267
274
|
var erasureSystems = ["access", "commerce", "support", "firebase", "aws", "auth0"];
|
|
268
275
|
var erasureOperation = z3.strictObject({
|
|
269
|
-
requestId,
|
|
276
|
+
requestId: requestId2,
|
|
270
277
|
state: z3.enum(["running", "blocked", "completed"]),
|
|
271
278
|
policy: z3.literal(erasurePolicy),
|
|
272
279
|
systems: z3.array(z3.strictObject({
|
|
@@ -278,6 +285,36 @@ var erasureOperation = z3.strictObject({
|
|
|
278
285
|
updatedAt: z3.iso.datetime(),
|
|
279
286
|
cleanupAfter: z3.iso.datetime().nullable()
|
|
280
287
|
});
|
|
288
|
+
var trackerTarget = z3.strictObject({
|
|
289
|
+
id: z3.string(),
|
|
290
|
+
createdAt: z3.string(),
|
|
291
|
+
serialNumber: z3.string().nullable(),
|
|
292
|
+
exclusive: z3.boolean()
|
|
293
|
+
});
|
|
294
|
+
var targetSchema = z3.strictObject({
|
|
295
|
+
review: erasureReview,
|
|
296
|
+
directoryCreatedAt: z3.string(),
|
|
297
|
+
trackers: z3.array(trackerTarget),
|
|
298
|
+
cutoff: z3.iso.datetime()
|
|
299
|
+
});
|
|
300
|
+
var directoryIdentity = z3.strictObject({ accountId: documentId2, accountIds: z3.array(documentId2).min(1), email: z3.email(), emails: z3.array(z3.email()).min(1), directoryCreatedAt: z3.string().min(1) });
|
|
301
|
+
var cleanupRequest = z3.discriminatedUnion("action", [
|
|
302
|
+
z3.strictObject({ action: z3.literal("review"), identity: directoryIdentity }),
|
|
303
|
+
z3.strictObject({ action: z3.enum(["access", "firebase", "aws", "support_select", "commerce_subscriptions", "commerce_orders", "commerce_privacy", "commerce_customer"]), target: targetSchema }),
|
|
304
|
+
z3.strictObject({ action: z3.literal("support_delete"), contactIds: z3.array(z3.int().positive()) })
|
|
305
|
+
]);
|
|
306
|
+
var controlRequest = z3.discriminatedUnion("action", [
|
|
307
|
+
z3.strictObject({ action: z3.literal("review"), actor: documentId2, input: erasureSelection }),
|
|
308
|
+
z3.strictObject({ action: z3.literal("submit"), actor: documentId2, input: erasureSubmission }),
|
|
309
|
+
z3.strictObject({ action: z3.literal("get"), actor: documentId2, input: erasureReference }),
|
|
310
|
+
z3.strictObject({ action: z3.literal("retry"), actor: documentId2, input: erasureReference })
|
|
311
|
+
]);
|
|
312
|
+
var failure = z3.strictObject({ status: z3.int().min(400).max(599), code: z3.string().regex(/^[a-z][a-z0-9_]{0,79}$/), message: z3.string().max(256) });
|
|
313
|
+
var completed = z3.strictObject({ completed: z3.literal(true) });
|
|
314
|
+
var batchCompletion = z3.strictObject({ completed: z3.boolean() });
|
|
315
|
+
|
|
316
|
+
// ../staff-contracts/src/erasure.ts
|
|
317
|
+
import { oc } from "@orpc/contract";
|
|
281
318
|
var erasureContract = {
|
|
282
319
|
review: oc.meta({ operation: "read" }).errors(apiErrors).input(erasureSelection).output(erasureReview),
|
|
283
320
|
submit: oc.errors(apiErrors).input(erasureSubmission).output(erasureOperation),
|
|
@@ -527,9 +564,15 @@ var bikeChanges = z10.strictObject({
|
|
|
527
564
|
);
|
|
528
565
|
var bikeEditInput = z10.strictObject({
|
|
529
566
|
deviceId: documentId,
|
|
530
|
-
|
|
567
|
+
trackerCreatedAt: z10.iso.datetime(),
|
|
568
|
+
expected: trackerBike.omit({ revision: true }).partial().strict(),
|
|
531
569
|
changes: bikeChanges
|
|
532
|
-
})
|
|
570
|
+
}).refine(({ expected, changes: changes2 }) => {
|
|
571
|
+
const fields = Object.entries(changes2).filter(([, value]) => value !== void 0).map(([key2]) => key2);
|
|
572
|
+
return fields.length === Object.keys(expected).length && fields.every(
|
|
573
|
+
(key2) => expected[key2] !== void 0
|
|
574
|
+
);
|
|
575
|
+
}, "Supply reviewed values for exactly the changed bike fields.");
|
|
533
576
|
var membershipName = z10.string().min(1).max(100).regex(/^[^\p{Cc}]+$/u).refine((value) => value.trim().length > 0, "Supply a display name.");
|
|
534
577
|
var trackerClaimInput = z10.strictObject({
|
|
535
578
|
deviceId: documentId,
|
|
@@ -547,7 +590,7 @@ var trackerMovementAlertsInput = z10.strictObject({
|
|
|
547
590
|
enabled: z10.boolean()
|
|
548
591
|
});
|
|
549
592
|
var trackerChangeContract = {
|
|
550
|
-
bike: { edit: oc8.errors(apiErrors).input(bikeEditInput).output(
|
|
593
|
+
bike: { edit: oc8.errors(apiErrors).input(bikeEditInput).output(trackerBike) },
|
|
551
594
|
movementAlerts: {
|
|
552
595
|
set: oc8.errors(apiErrors).input(trackerMovementAlertsInput).output(z10.void())
|
|
553
596
|
},
|
|
@@ -15373,6 +15416,21 @@ var staffTracker = z32.object({
|
|
|
15373
15416
|
isBlacklisted: z32.boolean().nullable()
|
|
15374
15417
|
}).nullable()
|
|
15375
15418
|
});
|
|
15419
|
+
var staffTrackerDetails = staffTracker.omit({ members: true }).extend({
|
|
15420
|
+
membership: z32.object({
|
|
15421
|
+
revision: z32.string(),
|
|
15422
|
+
memberCount: z32.int().nonnegative()
|
|
15423
|
+
})
|
|
15424
|
+
});
|
|
15425
|
+
var staffTrackerMemberPageInput = trackerInput.extend({
|
|
15426
|
+
revision: z32.string().regex(/^[0-9a-f]{64}$/),
|
|
15427
|
+
after: z32.string().min(1).optional(),
|
|
15428
|
+
limit: z32.int().min(1).max(100).default(50)
|
|
15429
|
+
});
|
|
15430
|
+
var staffTrackerMemberPage = z32.object({
|
|
15431
|
+
items: z32.array(trackerMember.extend({ accountId: z32.string() })),
|
|
15432
|
+
nextAfter: z32.string().nullable()
|
|
15433
|
+
});
|
|
15376
15434
|
|
|
15377
15435
|
// ../staff-contracts/src/gcp/diagnostics.ts
|
|
15378
15436
|
import { oc as oc22, eventIterator as eventIterator6 } from "@orpc/contract";
|
|
@@ -16142,9 +16200,12 @@ var trackerContract = {
|
|
|
16142
16200
|
...trackerChangeContract,
|
|
16143
16201
|
members: {
|
|
16144
16202
|
...trackerChangeContract.members,
|
|
16203
|
+
list: oc32.meta({ operation: "read" }).errors(apiErrors).input(staffTrackerMemberPageInput).output(staffTrackerMemberPage),
|
|
16145
16204
|
add: oc32.errors(apiErrors).input(trackerMemberAddInput).output(z44.void())
|
|
16146
16205
|
},
|
|
16147
16206
|
list: oc32.meta({ operation: "read" }).errors(apiErrors).input(staffTrackerPageInput).output(staffTrackerPage),
|
|
16207
|
+
getDetails: procedure4.meta({ operation: "read" }).output(staffTrackerDetails),
|
|
16208
|
+
watchDetails: procedure4.meta({ operation: "read" }).output(eventIterator7(staffTrackerDetails)),
|
|
16148
16209
|
get: procedure4.meta({ operation: "read" }).output(staffTracker),
|
|
16149
16210
|
watch: procedure4.meta({ operation: "read" }).output(eventIterator7(staffTracker))
|
|
16150
16211
|
};
|
|
@@ -16161,6 +16222,8 @@ var staffContract = {
|
|
|
16161
16222
|
|
|
16162
16223
|
export {
|
|
16163
16224
|
apiContractVersion,
|
|
16225
|
+
errorRecovery,
|
|
16226
|
+
errorData,
|
|
16164
16227
|
readIssue,
|
|
16165
16228
|
trackerBike,
|
|
16166
16229
|
trackerBattery,
|
|
@@ -16173,6 +16236,7 @@ export {
|
|
|
16173
16236
|
trackerSummary,
|
|
16174
16237
|
trackerPage,
|
|
16175
16238
|
tracker,
|
|
16239
|
+
customerTrackerDetails,
|
|
16176
16240
|
erasureSelection,
|
|
16177
16241
|
erasureReference,
|
|
16178
16242
|
erasurePolicy,
|
|
@@ -16263,6 +16327,9 @@ export {
|
|
|
16263
16327
|
staffTrackerSummary,
|
|
16264
16328
|
staffTrackerPage,
|
|
16265
16329
|
staffTracker,
|
|
16330
|
+
staffTrackerDetails,
|
|
16331
|
+
staffTrackerMemberPageInput,
|
|
16332
|
+
staffTrackerMemberPage,
|
|
16266
16333
|
trackerBatteryDiagnostics,
|
|
16267
16334
|
trackerLatestReport,
|
|
16268
16335
|
trackerStatistics,
|