primitive-admin 1.2.0-alpha.15 → 1.2.0-alpha.16
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 +84 -0
- package/dist/src/commands/admins.js +1 -0
- package/dist/src/commands/admins.js.map +1 -1
- package/dist/src/commands/analytics.js +2 -4
- package/dist/src/commands/analytics.js.map +1 -1
- package/dist/src/commands/apps-transitions.d.ts +39 -0
- package/dist/src/commands/apps-transitions.js +198 -0
- package/dist/src/commands/apps-transitions.js.map +1 -0
- package/dist/src/commands/apps.d.ts +11 -0
- package/dist/src/commands/apps.js +50 -5
- package/dist/src/commands/apps.js.map +1 -1
- package/dist/src/commands/auth-sessions.js +2 -0
- package/dist/src/commands/auth-sessions.js.map +1 -1
- package/dist/src/commands/auth.js +5 -0
- package/dist/src/commands/auth.js.map +1 -1
- package/dist/src/commands/blob-buckets.js +2 -0
- package/dist/src/commands/blob-buckets.js.map +1 -1
- package/dist/src/commands/collections.js +2 -13
- package/dist/src/commands/collections.js.map +1 -1
- package/dist/src/commands/comparisons.js +2 -0
- package/dist/src/commands/comparisons.js.map +1 -1
- package/dist/src/commands/config.js +2 -0
- package/dist/src/commands/config.js.map +1 -1
- package/dist/src/commands/connections.js +2 -2
- package/dist/src/commands/connections.js.map +1 -1
- package/dist/src/commands/db3.js +79 -21
- package/dist/src/commands/db3.js.map +1 -1
- package/dist/src/commands/email-templates.js +2 -0
- package/dist/src/commands/email-templates.js.map +1 -1
- package/dist/src/commands/env.js +2 -0
- package/dist/src/commands/env.js.map +1 -1
- package/dist/src/commands/functions.js +45 -3
- package/dist/src/commands/functions.js.map +1 -1
- package/dist/src/commands/groups.js +2 -0
- package/dist/src/commands/groups.js.map +1 -1
- package/dist/src/commands/guides.js +2 -0
- package/dist/src/commands/guides.js.map +1 -1
- package/dist/src/commands/hosting.d.ts +8 -0
- package/dist/src/commands/hosting.js +346 -0
- package/dist/src/commands/hosting.js.map +1 -0
- package/dist/src/commands/init.js +2 -0
- package/dist/src/commands/init.js.map +1 -1
- package/dist/src/commands/integrations.js +2 -0
- package/dist/src/commands/integrations.js.map +1 -1
- package/dist/src/commands/locks.js +2 -0
- package/dist/src/commands/locks.js.map +1 -1
- package/dist/src/commands/metadata-category-configs.js +1 -1
- package/dist/src/commands/metadata-category-configs.js.map +1 -1
- package/dist/src/commands/metadata.js +2 -2
- package/dist/src/commands/metadata.js.map +1 -1
- package/dist/src/commands/prompts.js +2 -0
- package/dist/src/commands/prompts.js.map +1 -1
- package/dist/src/commands/rate-counters.d.ts +19 -0
- package/dist/src/commands/rate-counters.js +104 -0
- package/dist/src/commands/rate-counters.js.map +1 -0
- package/dist/src/commands/rule-sets.js +2 -2
- package/dist/src/commands/rule-sets.js.map +1 -1
- package/dist/src/commands/schemas.js +4 -4
- package/dist/src/commands/schemas.js.map +1 -1
- package/dist/src/commands/secrets.js +2 -0
- package/dist/src/commands/secrets.js.map +1 -1
- package/dist/src/commands/skill.js +2 -0
- package/dist/src/commands/skill.js.map +1 -1
- package/dist/src/commands/sync.d.ts +101 -2
- package/dist/src/commands/sync.js +391 -62
- package/dist/src/commands/sync.js.map +1 -1
- package/dist/src/commands/tokens.js +2 -0
- package/dist/src/commands/tokens.js.map +1 -1
- package/dist/src/commands/transitions.d.ts +54 -0
- package/dist/src/commands/transitions.js +418 -0
- package/dist/src/commands/transitions.js.map +1 -0
- package/dist/src/commands/usage.d.ts +18 -0
- package/dist/src/commands/usage.js +343 -0
- package/dist/src/commands/usage.js.map +1 -0
- package/dist/src/commands/user-properties.js +2 -2
- package/dist/src/commands/user-properties.js.map +1 -1
- package/dist/src/commands/users.js +28 -29
- package/dist/src/commands/users.js.map +1 -1
- package/dist/src/commands/vars.js +2 -0
- package/dist/src/commands/vars.js.map +1 -1
- package/dist/src/commands/waitlist.js +2 -2
- package/dist/src/commands/waitlist.js.map +1 -1
- package/dist/src/lib/api-client.d.ts +606 -2
- package/dist/src/lib/api-client.js +157 -6
- package/dist/src/lib/api-client.js.map +1 -1
- package/dist/src/lib/app-settings-descriptor.d.ts +1 -1
- package/dist/src/lib/app-settings-descriptor.js +6 -0
- package/dist/src/lib/app-settings-descriptor.js.map +1 -1
- package/dist/src/lib/auth-flow.d.ts +33 -0
- package/dist/src/lib/auth-flow.js +404 -13
- package/dist/src/lib/auth-flow.js.map +1 -1
- package/dist/src/lib/cli-manifest.d.ts +5 -4
- package/dist/src/lib/cli-manifest.js.map +1 -1
- package/dist/src/lib/command-groups.d.ts +30 -0
- package/dist/src/lib/command-groups.js +109 -0
- package/dist/src/lib/command-groups.js.map +1 -0
- package/dist/src/lib/command-status.d.ts +56 -19
- package/dist/src/lib/command-status.js +101 -19
- package/dist/src/lib/command-status.js.map +1 -1
- package/dist/src/lib/config-object-descriptor.js +0 -1
- package/dist/src/lib/config-object-descriptor.js.map +1 -1
- package/dist/src/lib/db-codegen/dbTypeIR.d.ts +7 -0
- package/dist/src/lib/db-codegen/dbTypeIR.js +3 -0
- package/dist/src/lib/db-codegen/dbTypeIR.js.map +1 -1
- package/dist/src/lib/db-type-records.d.ts +12 -1
- package/dist/src/lib/db-type-records.js +8 -3
- package/dist/src/lib/db-type-records.js.map +1 -1
- package/dist/src/lib/db3-export.js +2 -2
- package/dist/src/lib/db3-export.js.map +1 -1
- package/dist/src/lib/db3-index-output.d.ts +26 -3
- package/dist/src/lib/db3-index-output.js +48 -12
- package/dist/src/lib/db3-index-output.js.map +1 -1
- package/dist/src/lib/db3-type-models.d.ts +11 -1
- package/dist/src/lib/db3-type-models.js +22 -2
- package/dist/src/lib/db3-type-models.js.map +1 -1
- package/dist/src/lib/function-authorize-view.d.ts +12 -0
- package/dist/src/lib/function-authorize-view.js +34 -0
- package/dist/src/lib/function-authorize-view.js.map +1 -1
- package/dist/src/lib/function-collect.d.ts +13 -0
- package/dist/src/lib/function-collect.js +37 -7
- package/dist/src/lib/function-collect.js.map +1 -1
- package/dist/src/lib/function-db-types.d.ts +14 -8
- package/dist/src/lib/function-db-types.js +56 -21
- package/dist/src/lib/function-db-types.js.map +1 -1
- package/dist/src/lib/function-lint.d.ts +24 -1
- package/dist/src/lib/function-lint.js +123 -1
- package/dist/src/lib/function-lint.js.map +1 -1
- package/dist/src/lib/function-schema-codegen.d.ts +31 -7
- package/dist/src/lib/function-schema-codegen.js +131 -36
- package/dist/src/lib/function-schema-codegen.js.map +1 -1
- package/dist/src/lib/function-sync.js +9 -1
- package/dist/src/lib/function-sync.js.map +1 -1
- package/dist/src/lib/generated-command-status.d.ts +6 -0
- package/dist/src/lib/generated-command-status.js +469 -0
- package/dist/src/lib/generated-command-status.js.map +1 -0
- package/dist/src/lib/generated-config-surfaces.d.ts +28 -3
- package/dist/src/lib/generated-config-surfaces.js +91 -16
- package/dist/src/lib/generated-config-surfaces.js.map +1 -1
- package/dist/src/lib/generated-sdk-types.d.ts +1 -1
- package/dist/src/lib/generated-sdk-types.js +1 -1
- package/dist/src/lib/generated-sdk-types.js.map +1 -1
- package/dist/src/lib/hosting-build.d.ts +97 -0
- package/dist/src/lib/hosting-build.js +204 -0
- package/dist/src/lib/hosting-build.js.map +1 -0
- package/dist/src/lib/hosting-client.d.ts +167 -0
- package/dist/src/lib/hosting-client.js +340 -0
- package/dist/src/lib/hosting-client.js.map +1 -0
- package/dist/src/lib/hosting-environments.d.ts +32 -0
- package/dist/src/lib/hosting-environments.js +74 -0
- package/dist/src/lib/hosting-environments.js.map +1 -0
- package/dist/src/lib/hosting-errors.d.ts +30 -0
- package/dist/src/lib/hosting-errors.js +43 -0
- package/dist/src/lib/hosting-errors.js.map +1 -0
- package/dist/src/lib/hosting-token.d.ts +46 -0
- package/dist/src/lib/hosting-token.js +60 -0
- package/dist/src/lib/hosting-token.js.map +1 -0
- package/dist/src/lib/hosting-wait.d.ts +42 -0
- package/dist/src/lib/hosting-wait.js +84 -0
- package/dist/src/lib/hosting-wait.js.map +1 -0
- package/dist/src/lib/hosting-wfp-upload.d.ts +86 -0
- package/dist/src/lib/hosting-wfp-upload.js +149 -0
- package/dist/src/lib/hosting-wfp-upload.js.map +1 -0
- package/dist/src/lib/invoker-shared-enums.d.ts +35 -0
- package/dist/src/lib/invoker-shared-enums.js +98 -0
- package/dist/src/lib/invoker-shared-enums.js.map +1 -0
- package/dist/src/lib/log-inspection.d.ts +4 -1
- package/dist/src/lib/log-inspection.js.map +1 -1
- package/dist/src/lib/primitive-declaration.d.ts +32 -1
- package/dist/src/lib/primitive-declaration.js +153 -19
- package/dist/src/lib/primitive-declaration.js.map +1 -1
- package/dist/src/lib/prompt-schema-codegen.d.ts +1 -1
- package/dist/src/lib/prompt-schema-codegen.js +31 -19
- package/dist/src/lib/prompt-schema-codegen.js.map +1 -1
- package/dist/src/lib/prompt-schema-refs.d.ts +9 -0
- package/dist/src/lib/prompt-schema-refs.js +28 -2
- package/dist/src/lib/prompt-schema-refs.js.map +1 -1
- package/dist/src/lib/register-commands.d.ts +14 -6
- package/dist/src/lib/register-commands.js +19 -83
- package/dist/src/lib/register-commands.js.map +1 -1
- package/dist/src/lib/schema-codegen/generated-db3-bridge.js +10 -4
- package/dist/src/lib/schema-codegen/generated-db3-bridge.js.map +1 -1
- package/dist/src/lib/schema-codegen/generated-field-grammar.d.ts +11 -2
- package/dist/src/lib/schema-codegen/generated-field-grammar.js +22 -4
- package/dist/src/lib/schema-codegen/generated-field-grammar.js.map +1 -1
- package/dist/src/lib/schema-codegen/generated-schema-shape.d.ts +27 -0
- package/dist/src/lib/schema-codegen/generated-schema-shape.js +126 -0
- package/dist/src/lib/schema-codegen/generated-schema-shape.js.map +1 -0
- package/dist/src/lib/schema-codegen/valuesLists.d.ts +15 -2
- package/dist/src/lib/schema-codegen/valuesLists.js +19 -3
- package/dist/src/lib/schema-codegen/valuesLists.js.map +1 -1
- package/dist/src/lib/swift-codegen/functionGenerator.js +4 -3
- package/dist/src/lib/swift-codegen/functionGenerator.js.map +1 -1
- package/dist/src/lib/swift-codegen/sharedGenerator.js +50 -5
- package/dist/src/lib/swift-codegen/sharedGenerator.js.map +1 -1
- package/dist/src/lib/sync-resource-types.js +0 -3
- package/dist/src/lib/sync-resource-types.js.map +1 -1
- package/dist/src/lib/toml-database-config.js +3 -1
- package/dist/src/lib/toml-database-config.js.map +1 -1
- package/dist/src/lib/transition-warnings.d.ts +21 -0
- package/dist/src/lib/transition-warnings.js +49 -0
- package/dist/src/lib/transition-warnings.js.map +1 -0
- package/package.json +2 -2
|
@@ -28,6 +28,35 @@ export interface BlobInfo {
|
|
|
28
28
|
uploaded?: string | null;
|
|
29
29
|
etag?: string | null;
|
|
30
30
|
}
|
|
31
|
+
/**
|
|
32
|
+
* The `authorize` and `input` fields of one function version as the admin API
|
|
33
|
+
* answers it (a configs-list item, a version get, a push answer). `input` is
|
|
34
|
+
* the list of top-level input keys the version's `authorize` callable declared,
|
|
35
|
+
* recorded by the server at push; `null` for a version without `authorize` and
|
|
36
|
+
* for one that declared no list. Annotate a version read with it to type the
|
|
37
|
+
* two fields.
|
|
38
|
+
*/
|
|
39
|
+
export interface FunctionVersionInputFields {
|
|
40
|
+
authorize?: boolean;
|
|
41
|
+
input?: string[] | null;
|
|
42
|
+
/** #5840 — whether this version opens to signed-out callers. */
|
|
43
|
+
signedOut?: boolean;
|
|
44
|
+
}
|
|
45
|
+
/**
|
|
46
|
+
* The live version's `authorize` flag and `input` list as the function get
|
|
47
|
+
* and each functions-list item answer them. Both are `null` when no version is
|
|
48
|
+
* active; `activeConfigInput` is also `null` when the live version recorded no
|
|
49
|
+
* list.
|
|
50
|
+
*/
|
|
51
|
+
export interface FunctionActiveInputFields {
|
|
52
|
+
activeConfigAuthorize?: boolean | null;
|
|
53
|
+
activeConfigInput?: string[] | null;
|
|
54
|
+
/**
|
|
55
|
+
* #5840 — whether the live version opens to signed-out callers while the
|
|
56
|
+
* app's `signedOutAccess` is on; `null` when no version is active.
|
|
57
|
+
*/
|
|
58
|
+
activeConfigSignedOut?: boolean | null;
|
|
59
|
+
}
|
|
31
60
|
/**
|
|
32
61
|
* An app as `GET /admin/api/apps/{appId}` serializes it. Dates are ISO-8601
|
|
33
62
|
* strings. The lineage fields are null on an app with no parent, and
|
|
@@ -262,6 +291,40 @@ export interface UserWalkAnswer {
|
|
|
262
291
|
/** On a terminate only: whether this call ended the walk. */
|
|
263
292
|
terminated?: boolean;
|
|
264
293
|
}
|
|
294
|
+
/** One window length of a rate counter, as `GET rate-counters/:key` answers it. */
|
|
295
|
+
export interface RateCounterWindow {
|
|
296
|
+
windowSeconds: number;
|
|
297
|
+
/** The limit of the latest lease request. */
|
|
298
|
+
limit: number;
|
|
299
|
+
windowStart: string;
|
|
300
|
+
windowEnd: string;
|
|
301
|
+
granted: number;
|
|
302
|
+
returned: number;
|
|
303
|
+
held: number;
|
|
304
|
+
remaining: number;
|
|
305
|
+
/** Lease requests answered with no slots in the window. */
|
|
306
|
+
emptyGrants: number;
|
|
307
|
+
/** Isolates holding leases in the window; `leases` lists at most 50. */
|
|
308
|
+
leaseCount: number;
|
|
309
|
+
leases: Array<{
|
|
310
|
+
isolateId: string;
|
|
311
|
+
granted: number;
|
|
312
|
+
returned: number;
|
|
313
|
+
lastLeaseAt: string;
|
|
314
|
+
}>;
|
|
315
|
+
previous: {
|
|
316
|
+
windowStart: string;
|
|
317
|
+
granted: number;
|
|
318
|
+
returned: number;
|
|
319
|
+
emptyGrants: number;
|
|
320
|
+
} | null;
|
|
321
|
+
}
|
|
322
|
+
/** `GET /admin/api/apps/:appId/rate-counters/:key`: `counters` is empty for a key nothing counted. */
|
|
323
|
+
export interface RateCounterState {
|
|
324
|
+
appId: string;
|
|
325
|
+
key: string;
|
|
326
|
+
counters: RateCounterWindow[];
|
|
327
|
+
}
|
|
265
328
|
/** The active user properties schema, as `GET users/properties` answers it. */
|
|
266
329
|
export interface UserPropertiesActive {
|
|
267
330
|
version: number;
|
|
@@ -595,6 +658,439 @@ interface AnalyticsUserSummary {
|
|
|
595
658
|
interface AnalyticsTopUserRow extends AnalyticsUserSummary {
|
|
596
659
|
firstSeenInWindow: string;
|
|
597
660
|
}
|
|
661
|
+
/** One meter of a usage month (`GET apps/{appId}/usage`). */
|
|
662
|
+
export interface UsageMonthMeter {
|
|
663
|
+
meter: string;
|
|
664
|
+
kind: "usage" | "storage";
|
|
665
|
+
unit: string;
|
|
666
|
+
quantity: number;
|
|
667
|
+
/** Estimated cost in millionths of a dollar, unrounded. */
|
|
668
|
+
estCostMicros: number;
|
|
669
|
+
bytes: number;
|
|
670
|
+
points: number;
|
|
671
|
+
}
|
|
672
|
+
/** One meter of one day of a usage month. */
|
|
673
|
+
export interface UsageDayMeter {
|
|
674
|
+
meter: string;
|
|
675
|
+
kind: "usage" | "storage";
|
|
676
|
+
quantity: number;
|
|
677
|
+
estCostMicros: number;
|
|
678
|
+
bytes: number;
|
|
679
|
+
points: number;
|
|
680
|
+
source: "live" | "closed";
|
|
681
|
+
frozen: boolean;
|
|
682
|
+
}
|
|
683
|
+
/** A stored transition override: the value, when it was set (epoch ms) and by whom (#5821). */
|
|
684
|
+
export interface AppTransitionOverride {
|
|
685
|
+
v: string;
|
|
686
|
+
at: number;
|
|
687
|
+
by: string;
|
|
688
|
+
}
|
|
689
|
+
/** One platform transition's state for an app, with its registry entry (#5821). */
|
|
690
|
+
export interface AppTransitionState {
|
|
691
|
+
transition: string;
|
|
692
|
+
value: string;
|
|
693
|
+
source: "override" | "parent" | "newAppsFrom" | "default";
|
|
694
|
+
override: AppTransitionOverride | null;
|
|
695
|
+
values: string[];
|
|
696
|
+
v1: string;
|
|
697
|
+
v2: string;
|
|
698
|
+
existingAppsDefault: string;
|
|
699
|
+
newAppsFrom: string;
|
|
700
|
+
owner: string;
|
|
701
|
+
removeBy: string;
|
|
702
|
+
autoMove: "off" | "non-production" | "all";
|
|
703
|
+
migration: TransitionMigrationRecord | null;
|
|
704
|
+
}
|
|
705
|
+
/**
|
|
706
|
+
* An app's record of a transition's data migration (#5823): every field but
|
|
707
|
+
* `name` is null when the app has no record yet.
|
|
708
|
+
*/
|
|
709
|
+
export interface TransitionMigrationRecord {
|
|
710
|
+
name: string;
|
|
711
|
+
status: "queued" | "running" | "blocked" | "complete" | null;
|
|
712
|
+
/** The handler's position. */
|
|
713
|
+
cursor: string | null;
|
|
714
|
+
counts: {
|
|
715
|
+
scanned: number;
|
|
716
|
+
migrated: number;
|
|
717
|
+
skipped: number;
|
|
718
|
+
} | null;
|
|
719
|
+
/** The app-side step a blocked migration waits for. */
|
|
720
|
+
waitingOn: string | null;
|
|
721
|
+
finishedAt: string | null;
|
|
722
|
+
/** While a rerun is in progress, the earlier completion's finish time. */
|
|
723
|
+
previousFinishedAt: string | null;
|
|
724
|
+
startedAt: string | null;
|
|
725
|
+
lastRunAt: string | null;
|
|
726
|
+
lastError: {
|
|
727
|
+
at: string;
|
|
728
|
+
message: string;
|
|
729
|
+
} | null;
|
|
730
|
+
}
|
|
731
|
+
/** `GET apps/{appId}/transitions`: every registered transition's state for the app (#5821). */
|
|
732
|
+
export interface AppTransitionsResponse {
|
|
733
|
+
appId: string;
|
|
734
|
+
parentAppId: string | null;
|
|
735
|
+
transitions: AppTransitionState[];
|
|
736
|
+
}
|
|
737
|
+
/** A committed transition set, or `unchanged: true` for one equal to the app's override (#5821). */
|
|
738
|
+
export type AppTransitionSetResponse = {
|
|
739
|
+
appId: string;
|
|
740
|
+
transition: string;
|
|
741
|
+
from: string;
|
|
742
|
+
to: string;
|
|
743
|
+
changeId: string;
|
|
744
|
+
at: number;
|
|
745
|
+
by: string;
|
|
746
|
+
} | {
|
|
747
|
+
appId: string;
|
|
748
|
+
transition: string;
|
|
749
|
+
value: string;
|
|
750
|
+
unchanged: true;
|
|
751
|
+
};
|
|
752
|
+
/** One row of an app's transition history (#5821). */
|
|
753
|
+
export interface AppTransitionChange {
|
|
754
|
+
changeId: string;
|
|
755
|
+
transition: string;
|
|
756
|
+
from: string | null;
|
|
757
|
+
to: string | null;
|
|
758
|
+
/** Epoch ms. */
|
|
759
|
+
at: number | null;
|
|
760
|
+
by: string | null;
|
|
761
|
+
reason: string | null;
|
|
762
|
+
children: string[] | null;
|
|
763
|
+
reading: Record<string, unknown> | null;
|
|
764
|
+
}
|
|
765
|
+
/** One registered transition's facts, as `GET transitions` lists them (#5822). */
|
|
766
|
+
export interface TransitionListEntry {
|
|
767
|
+
transition: string;
|
|
768
|
+
values: string[];
|
|
769
|
+
v1: string;
|
|
770
|
+
v2: string;
|
|
771
|
+
existingAppsDefault: string;
|
|
772
|
+
newAppsFrom: string;
|
|
773
|
+
counter: string;
|
|
774
|
+
window: {
|
|
775
|
+
moveDays: number;
|
|
776
|
+
contractDays: number;
|
|
777
|
+
};
|
|
778
|
+
owner: string;
|
|
779
|
+
removeBy: string;
|
|
780
|
+
autoMove: "off" | "non-production" | "all";
|
|
781
|
+
migration: string | null;
|
|
782
|
+
firstReadAt: string | null;
|
|
783
|
+
/** This environment's contract-ready record, or null (#5824). */
|
|
784
|
+
contractReady: TransitionContractReady | null;
|
|
785
|
+
}
|
|
786
|
+
/** A transition's contract-ready record in one environment (#5824). */
|
|
787
|
+
export interface TransitionContractReady {
|
|
788
|
+
ready: boolean;
|
|
789
|
+
/** ISO instant of the sweep that wrote it. */
|
|
790
|
+
at: string;
|
|
791
|
+
/** Apps the sweep counted. */
|
|
792
|
+
apps: number;
|
|
793
|
+
/** The environment-wide count over `contractDays`. */
|
|
794
|
+
count: number;
|
|
795
|
+
}
|
|
796
|
+
/** `GET transitions`: the registry, and apps per value from one budgeted walk (#5822). */
|
|
797
|
+
export interface TransitionListResponse {
|
|
798
|
+
environment: string;
|
|
799
|
+
transitions: TransitionListEntry[];
|
|
800
|
+
apps: {
|
|
801
|
+
counted: number;
|
|
802
|
+
complete: boolean;
|
|
803
|
+
coveredThrough: string | null;
|
|
804
|
+
byValue: Record<string, Record<string, number>>;
|
|
805
|
+
} | null;
|
|
806
|
+
}
|
|
807
|
+
/** One app's line of a transition report (#5822). */
|
|
808
|
+
export interface TransitionReportItem {
|
|
809
|
+
appId: string;
|
|
810
|
+
name: string | null;
|
|
811
|
+
parentAppId: string | null;
|
|
812
|
+
deleted: boolean;
|
|
813
|
+
value: string | null;
|
|
814
|
+
source: "override" | "parent" | "newAppsFrom" | "default" | null;
|
|
815
|
+
override: AppTransitionOverride | null;
|
|
816
|
+
counts: Array<{
|
|
817
|
+
callSite: string;
|
|
818
|
+
count: number;
|
|
819
|
+
}>;
|
|
820
|
+
countsTruncated: boolean;
|
|
821
|
+
total: number;
|
|
822
|
+
lastUseAt: string | null;
|
|
823
|
+
droppedPoints: number;
|
|
824
|
+
movesWith: string | null;
|
|
825
|
+
migration: TransitionMigrationRecord | null;
|
|
826
|
+
eligibleAt: string | null;
|
|
827
|
+
eligibleOn: string | null;
|
|
828
|
+
eligibility: "moved" | "eligible" | "waiting" | "no-first-read" | "with-parent" | "incomplete" | null;
|
|
829
|
+
}
|
|
830
|
+
/** `GET transitions/{transition}/report`: one page of apps (#5822). */
|
|
831
|
+
export interface TransitionReportResponse {
|
|
832
|
+
transition: string;
|
|
833
|
+
environment: string;
|
|
834
|
+
source: "wae" | "sink";
|
|
835
|
+
window: {
|
|
836
|
+
since: string;
|
|
837
|
+
until: string;
|
|
838
|
+
days: number;
|
|
839
|
+
};
|
|
840
|
+
firstReadAt: string | null;
|
|
841
|
+
/** The transition's migration and where its nightly walk stands, or null when it declares none (#5823). */
|
|
842
|
+
migration: {
|
|
843
|
+
name: string;
|
|
844
|
+
walk: {
|
|
845
|
+
pass: number;
|
|
846
|
+
after: string | null;
|
|
847
|
+
appsCovered: number;
|
|
848
|
+
finished: boolean;
|
|
849
|
+
lastRunAt: string | null;
|
|
850
|
+
} | null;
|
|
851
|
+
} | null;
|
|
852
|
+
items: TransitionReportItem[];
|
|
853
|
+
truncated: boolean;
|
|
854
|
+
hasMore: boolean;
|
|
855
|
+
nextCursor: string | null;
|
|
856
|
+
}
|
|
857
|
+
/** One row of the deprecated-calls report: one app, operation, source and client kind (#5916). */
|
|
858
|
+
export interface DeprecatedCall {
|
|
859
|
+
appId: string;
|
|
860
|
+
/** Recorded on an admin surface for no app of its own: `appId` is the admin partition. */
|
|
861
|
+
platform: boolean;
|
|
862
|
+
/** `<surface>:<METHOD> /<pattern>` for HTTP, `ws:<type>` for a WebSocket message. */
|
|
863
|
+
operation: string;
|
|
864
|
+
/** `api`, `fn` or `ws`. */
|
|
865
|
+
source: string;
|
|
866
|
+
/** `js`, `swift`, `cli`, `fn` or `unknown`. */
|
|
867
|
+
client: string;
|
|
868
|
+
/** Calls in the window; sampling-weighted on Analytics Engine, so an estimate there. */
|
|
869
|
+
count: number;
|
|
870
|
+
lastUseAt: string | null;
|
|
871
|
+
}
|
|
872
|
+
/** `GET transitions/deprecated-calls`: recent calls to deprecated operations (#5916). */
|
|
873
|
+
export interface DeprecatedCallsResponse {
|
|
874
|
+
environment: string;
|
|
875
|
+
source: "wae" | "sink";
|
|
876
|
+
window: {
|
|
877
|
+
since: string;
|
|
878
|
+
until: string;
|
|
879
|
+
days: number;
|
|
880
|
+
};
|
|
881
|
+
/** Most calls first. */
|
|
882
|
+
calls: DeprecatedCall[];
|
|
883
|
+
/** The rows reached the limit: narrow with an app or an operation. */
|
|
884
|
+
truncated: boolean;
|
|
885
|
+
}
|
|
886
|
+
/** The reading the move step decides a unit on (#5824). */
|
|
887
|
+
export interface TransitionReading {
|
|
888
|
+
count: number;
|
|
889
|
+
droppedPoints: number;
|
|
890
|
+
environment: string;
|
|
891
|
+
source: string;
|
|
892
|
+
windowStart: string;
|
|
893
|
+
windowEnd: string;
|
|
894
|
+
observedAt: string;
|
|
895
|
+
firstReadAt: string | null;
|
|
896
|
+
}
|
|
897
|
+
/** One unit not on V2 in a transition's move plan (#5824). */
|
|
898
|
+
export interface TransitionMovePlanItem {
|
|
899
|
+
appId: string;
|
|
900
|
+
name: string | null;
|
|
901
|
+
parentAppId: string | null;
|
|
902
|
+
/** What the next run does when it reaches the unit. */
|
|
903
|
+
action: "move" | "move-if-migrated" | "hold";
|
|
904
|
+
reason: string | null;
|
|
905
|
+
/** The member a `migration` hold names. */
|
|
906
|
+
member: string | null;
|
|
907
|
+
/** `behind`: the nightly walk has passed the unit in this pass, so it waits for the next. */
|
|
908
|
+
walk: "ahead" | "behind";
|
|
909
|
+
children: string[];
|
|
910
|
+
reading: TransitionReading;
|
|
911
|
+
total: number;
|
|
912
|
+
droppedPoints: number;
|
|
913
|
+
lastUseAt: string | null;
|
|
914
|
+
eligibleAt: string | null;
|
|
915
|
+
migration: Array<{
|
|
916
|
+
appId: string;
|
|
917
|
+
status: string | null;
|
|
918
|
+
}> | null;
|
|
919
|
+
}
|
|
920
|
+
/** `GET transitions/{transition}/move-plan`: one page of what the next move run would do (#5824). */
|
|
921
|
+
export interface TransitionMovePlanResponse {
|
|
922
|
+
transition: string;
|
|
923
|
+
environment: string;
|
|
924
|
+
source: "wae" | "sink";
|
|
925
|
+
autoMove: "off" | "non-production" | "all";
|
|
926
|
+
allowed: boolean;
|
|
927
|
+
firstReadAt: string | null;
|
|
928
|
+
window: {
|
|
929
|
+
since: string;
|
|
930
|
+
until: string;
|
|
931
|
+
days: number;
|
|
932
|
+
};
|
|
933
|
+
walk: {
|
|
934
|
+
after: string | null;
|
|
935
|
+
pass: number;
|
|
936
|
+
finished: boolean;
|
|
937
|
+
retry: {
|
|
938
|
+
appId: string;
|
|
939
|
+
} | null;
|
|
940
|
+
skip: string[];
|
|
941
|
+
sweepDue: boolean;
|
|
942
|
+
} | null;
|
|
943
|
+
contractReady: TransitionContractReady | null;
|
|
944
|
+
items: TransitionMovePlanItem[];
|
|
945
|
+
hasMore: boolean;
|
|
946
|
+
nextCursor: string | null;
|
|
947
|
+
}
|
|
948
|
+
/** An app's usage and estimated cost for a month, by meter and by day. */
|
|
949
|
+
export interface AppUsageMonthResponse {
|
|
950
|
+
appId: string;
|
|
951
|
+
month: string;
|
|
952
|
+
current: boolean;
|
|
953
|
+
source: "wae" | "sink" | null;
|
|
954
|
+
app: {
|
|
955
|
+
name: string | null;
|
|
956
|
+
parentAppId: string | null;
|
|
957
|
+
createdByAdminId: string | null;
|
|
958
|
+
deleted: boolean;
|
|
959
|
+
};
|
|
960
|
+
meters: UsageMonthMeter[];
|
|
961
|
+
days: Array<{
|
|
962
|
+
day: string;
|
|
963
|
+
estCostMicros: number;
|
|
964
|
+
meters: UsageDayMeter[];
|
|
965
|
+
}>;
|
|
966
|
+
storage: {
|
|
967
|
+
current: Array<{
|
|
968
|
+
meter: string;
|
|
969
|
+
bytes: number;
|
|
970
|
+
}>;
|
|
971
|
+
};
|
|
972
|
+
/** A parent app's children, one line each. */
|
|
973
|
+
children?: Array<{
|
|
974
|
+
appId: string;
|
|
975
|
+
name: string | null;
|
|
976
|
+
deleted: boolean;
|
|
977
|
+
estCostMicros: number;
|
|
978
|
+
meters: Array<{
|
|
979
|
+
meter: string;
|
|
980
|
+
kind: "usage" | "storage";
|
|
981
|
+
quantity: number;
|
|
982
|
+
estCostMicros: number;
|
|
983
|
+
}>;
|
|
984
|
+
}>;
|
|
985
|
+
total: {
|
|
986
|
+
estCostMicros: number;
|
|
987
|
+
app: number;
|
|
988
|
+
children: number;
|
|
989
|
+
};
|
|
990
|
+
truncated: boolean;
|
|
991
|
+
}
|
|
992
|
+
/** A live usage window: ISO 8601 bounds, UTC, half-open. */
|
|
993
|
+
export interface UsageWindowParams {
|
|
994
|
+
since?: string;
|
|
995
|
+
until?: string;
|
|
996
|
+
}
|
|
997
|
+
/** An app's top users over a window. */
|
|
998
|
+
export interface AppUsageTopUsersResponse {
|
|
999
|
+
appId: string;
|
|
1000
|
+
since: string;
|
|
1001
|
+
until: string;
|
|
1002
|
+
by: "quantity" | "cost";
|
|
1003
|
+
meter: string | null;
|
|
1004
|
+
rows: Array<{
|
|
1005
|
+
billedTo: string;
|
|
1006
|
+
quantity: number | null;
|
|
1007
|
+
estCostMicros: number;
|
|
1008
|
+
points: number;
|
|
1009
|
+
}>;
|
|
1010
|
+
}
|
|
1011
|
+
/** One user's usage over a window and the bytes they own. */
|
|
1012
|
+
export interface AppUsageUserResponse {
|
|
1013
|
+
appId: string;
|
|
1014
|
+
billedTo: string;
|
|
1015
|
+
since: string;
|
|
1016
|
+
until: string;
|
|
1017
|
+
meters: Array<{
|
|
1018
|
+
meter: string;
|
|
1019
|
+
unit: string;
|
|
1020
|
+
quantity: number;
|
|
1021
|
+
estCostMicros: number;
|
|
1022
|
+
bytes: number;
|
|
1023
|
+
points: number;
|
|
1024
|
+
}>;
|
|
1025
|
+
storage: Array<{
|
|
1026
|
+
meter: string;
|
|
1027
|
+
bytes: number;
|
|
1028
|
+
}>;
|
|
1029
|
+
}
|
|
1030
|
+
/** An app's system usage by origin, source, resource and meter. */
|
|
1031
|
+
export interface AppUsageSystemResponse {
|
|
1032
|
+
appId: string;
|
|
1033
|
+
since: string;
|
|
1034
|
+
until: string;
|
|
1035
|
+
meter: string | null;
|
|
1036
|
+
rows: Array<{
|
|
1037
|
+
origin: string;
|
|
1038
|
+
source: string;
|
|
1039
|
+
resourceId: string;
|
|
1040
|
+
meter: string;
|
|
1041
|
+
quantity: number;
|
|
1042
|
+
estCostMicros: number;
|
|
1043
|
+
points: number;
|
|
1044
|
+
}>;
|
|
1045
|
+
truncated: boolean;
|
|
1046
|
+
}
|
|
1047
|
+
/** What the super-admin month-to-date rankings share. */
|
|
1048
|
+
export interface UsageMonthToDate {
|
|
1049
|
+
month: string;
|
|
1050
|
+
basis: "usage+storage";
|
|
1051
|
+
source: "wae" | "sink" | null;
|
|
1052
|
+
/** False when a walk stopped at its page budget. */
|
|
1053
|
+
complete: boolean;
|
|
1054
|
+
/** When incomplete, the last app id the walk reached. */
|
|
1055
|
+
coveredThrough: string | null;
|
|
1056
|
+
}
|
|
1057
|
+
/** The cost fields of a ranking row, in millionths of a dollar. */
|
|
1058
|
+
export interface UsageCostFields {
|
|
1059
|
+
usageEstCostMicros: number;
|
|
1060
|
+
storageEstCostMicros: number;
|
|
1061
|
+
estCostMicros: number;
|
|
1062
|
+
points: number;
|
|
1063
|
+
}
|
|
1064
|
+
/** The top apps by estimated cost, month to date. */
|
|
1065
|
+
export interface UsageTopAppsResponse extends UsageMonthToDate {
|
|
1066
|
+
rows: Array<UsageCostFields & {
|
|
1067
|
+
appId: string;
|
|
1068
|
+
name: string | null;
|
|
1069
|
+
deleted: boolean;
|
|
1070
|
+
parentAppId: string | null;
|
|
1071
|
+
createdByAdminId: string | null;
|
|
1072
|
+
}>;
|
|
1073
|
+
}
|
|
1074
|
+
/** The top developers by estimated cost, month to date. */
|
|
1075
|
+
export interface UsageTopDevelopersResponse extends UsageMonthToDate {
|
|
1076
|
+
rows: Array<UsageCostFields & {
|
|
1077
|
+
adminId: string | null;
|
|
1078
|
+
email: string | null;
|
|
1079
|
+
name: string | null;
|
|
1080
|
+
}>;
|
|
1081
|
+
}
|
|
1082
|
+
/** One usage job's state. */
|
|
1083
|
+
export interface UsageJobView {
|
|
1084
|
+
startedAt: string | null;
|
|
1085
|
+
lastRunAt: string | null;
|
|
1086
|
+
cursor: unknown;
|
|
1087
|
+
appsCovered: number | null;
|
|
1088
|
+
finished: boolean | null;
|
|
1089
|
+
}
|
|
1090
|
+
/** Every usage job's state, null for a job that never ran. */
|
|
1091
|
+
export interface UsageJobsResponse {
|
|
1092
|
+
jobs: Record<string, UsageJobView | null>;
|
|
1093
|
+
}
|
|
598
1094
|
interface AnalyticsTopUsersResponse {
|
|
599
1095
|
windowDays: number;
|
|
600
1096
|
limit: number;
|
|
@@ -941,6 +1437,29 @@ export declare class ApiClient {
|
|
|
941
1437
|
scope: string[];
|
|
942
1438
|
apps: string[];
|
|
943
1439
|
}>;
|
|
1440
|
+
/**
|
|
1441
|
+
* #5787 — what `primitive hosting` may send for the current credentials:
|
|
1442
|
+
* a CI token as it is (it cannot derive), or else nothing until a token is
|
|
1443
|
+
* derived; and whether an unexpired step-up that may reach `appId` is
|
|
1444
|
+
* stored. Throws the usual not-logged-in refusal.
|
|
1445
|
+
*/
|
|
1446
|
+
hostingCredentials(appId: string): Promise<{
|
|
1447
|
+
ciToken: string | null;
|
|
1448
|
+
stepUp: boolean;
|
|
1449
|
+
}>;
|
|
1450
|
+
/**
|
|
1451
|
+
* #5787 — `POST /admin/api/auth/token` for hosting: a `write`-only token of
|
|
1452
|
+
* 15 minutes derived from the login, or from the stored step-up on a
|
|
1453
|
+
* protected app, pinned to `appId` when that bearer is pinned and unpinned
|
|
1454
|
+
* otherwise. Sent with exactly that bearer and never retried with another.
|
|
1455
|
+
*/
|
|
1456
|
+
deriveHostingToken(input: {
|
|
1457
|
+
appId: string;
|
|
1458
|
+
from: "login" | "step-up";
|
|
1459
|
+
}): Promise<{
|
|
1460
|
+
accessToken: string;
|
|
1461
|
+
expiresAt: string;
|
|
1462
|
+
}>;
|
|
944
1463
|
get<T = any>(path: string, params?: Record<string, any>): Promise<T>;
|
|
945
1464
|
post<T = any>(path: string, body?: any): Promise<T>;
|
|
946
1465
|
put<T = any>(path: string, body?: any): Promise<T>;
|
|
@@ -1134,6 +1653,8 @@ export declare class ApiClient {
|
|
|
1134
1653
|
startUserWalk(appId: string, body: UserWalkStartBody): Promise<UserWalkStartAnswer>;
|
|
1135
1654
|
/** A users walk by its run id (`GET /admin/api/apps/:appId/users/walks/:runId`). */
|
|
1136
1655
|
getUserWalk(appId: string, runId: string): Promise<UserWalkAnswer>;
|
|
1656
|
+
/** A rate counter's state by key (`GET /admin/api/apps/:appId/rate-counters/:key`). */
|
|
1657
|
+
getRateCounter(appId: string, key: string): Promise<RateCounterState>;
|
|
1137
1658
|
/** Stop a users walk (`POST /admin/api/apps/:appId/users/walks/:runId/terminate`); batches in flight finish. */
|
|
1138
1659
|
terminateUserWalk(appId: string, runId: string): Promise<UserWalkAnswer & {
|
|
1139
1660
|
terminated: boolean;
|
|
@@ -1416,9 +1937,11 @@ export declare class ApiClient {
|
|
|
1416
1937
|
expectNotExists?: boolean;
|
|
1417
1938
|
}): Promise<any>;
|
|
1418
1939
|
deleteAppConfigVar(appId: string, key: string, expectedModifiedAt?: string): Promise<any>;
|
|
1940
|
+
/** Every function of the app; each item carries {@link FunctionActiveInputFields}. */
|
|
1419
1941
|
listFunctions(appId: string): Promise<{
|
|
1420
1942
|
items: any[];
|
|
1421
1943
|
}>;
|
|
1944
|
+
/** One function; the answer carries {@link FunctionActiveInputFields}. */
|
|
1422
1945
|
getFunction(appId: string, functionId: string): Promise<any>;
|
|
1423
1946
|
createFunction(appId: string, payload: any): Promise<any>;
|
|
1424
1947
|
updateFunction(appId: string, functionId: string, payload: any): Promise<any>;
|
|
@@ -1608,7 +2131,8 @@ export declare class ApiClient {
|
|
|
1608
2131
|
* Paging is opt-in on the server: with no `limit` and no `cursor` every
|
|
1609
2132
|
* version comes back, which is what this method did before paging existed and
|
|
1610
2133
|
* what an already-installed CLI still asks for. A caller that passes either
|
|
1611
|
-
* gets the shared `{ items, hasMore, nextCursor }` page.
|
|
2134
|
+
* gets the shared `{ items, hasMore, nextCursor }` page. Each item carries
|
|
2135
|
+
* {@link FunctionVersionInputFields}.
|
|
1612
2136
|
*/
|
|
1613
2137
|
listFunctionConfigs(appId: string, functionId: string, options?: {
|
|
1614
2138
|
limit?: number;
|
|
@@ -1624,6 +2148,7 @@ export declare class ApiClient {
|
|
|
1624
2148
|
* from the next call.
|
|
1625
2149
|
*/
|
|
1626
2150
|
activateFunctionConfig(appId: string, functionId: string, configId: string): Promise<any>;
|
|
2151
|
+
/** One version; the answer carries {@link FunctionVersionInputFields}. */
|
|
1627
2152
|
getFunctionConfig(appId: string, functionId: string, configId: string): Promise<any>;
|
|
1628
2153
|
/**
|
|
1629
2154
|
* The stored envelope: the authored TOML bytes, every source file and the
|
|
@@ -1970,6 +2495,74 @@ export declare class ApiClient {
|
|
|
1970
2495
|
windowDays?: number;
|
|
1971
2496
|
limit?: number;
|
|
1972
2497
|
} & AnalyticsFreshParam): Promise<TopPromptsResponse>;
|
|
2498
|
+
/** An app's platform transitions: each one's value and where it came from. */
|
|
2499
|
+
getAppTransitions(appId: string): Promise<AppTransitionsResponse>;
|
|
2500
|
+
/** Set one platform transition on one app, with a reason (super-admin). */
|
|
2501
|
+
setAppTransition(appId: string, transition: string, body: {
|
|
2502
|
+
value: string;
|
|
2503
|
+
reason: string;
|
|
2504
|
+
}): Promise<AppTransitionSetResponse>;
|
|
2505
|
+
/** One page of an app's transition changes, newest first (super-admin). */
|
|
2506
|
+
listAppTransitionChanges(appId: string, params?: {
|
|
2507
|
+
transition?: string;
|
|
2508
|
+
limit?: number;
|
|
2509
|
+
cursor?: string;
|
|
2510
|
+
}): Promise<{
|
|
2511
|
+
items: AppTransitionChange[];
|
|
2512
|
+
hasMore: boolean;
|
|
2513
|
+
nextCursor?: string;
|
|
2514
|
+
}>;
|
|
2515
|
+
/** The registered transitions, with apps per value from one budgeted walk (super-admin). */
|
|
2516
|
+
listTransitions(params?: {
|
|
2517
|
+
after?: string;
|
|
2518
|
+
counts?: boolean;
|
|
2519
|
+
}): Promise<TransitionListResponse>;
|
|
2520
|
+
/** One page of a transition's report: each app's state, use by call site and eligible date (super-admin). */
|
|
2521
|
+
getTransitionReport(transition: string, params?: {
|
|
2522
|
+
only?: "all" | "in-use";
|
|
2523
|
+
limit?: number;
|
|
2524
|
+
cursor?: string;
|
|
2525
|
+
}): Promise<TransitionReportResponse>;
|
|
2526
|
+
/** One page of a transition's move plan: what the daily move step would do with each unit (super-admin, #5824). */
|
|
2527
|
+
getTransitionMovePlan(transition: string, params?: {
|
|
2528
|
+
limit?: number;
|
|
2529
|
+
cursor?: string;
|
|
2530
|
+
}): Promise<TransitionMovePlanResponse>;
|
|
2531
|
+
/** Recent calls to deprecated operations, by app, operation, source and client (super-admin). */
|
|
2532
|
+
getDeprecatedCalls(params?: {
|
|
2533
|
+
days?: number;
|
|
2534
|
+
appId?: string;
|
|
2535
|
+
operation?: string;
|
|
2536
|
+
limit?: number;
|
|
2537
|
+
}): Promise<DeprecatedCallsResponse>;
|
|
2538
|
+
/** An app's usage and estimated cost for `month` (`YYYY-MM`, default the current month). */
|
|
2539
|
+
getAppUsage(appId: string, params?: {
|
|
2540
|
+
month?: string;
|
|
2541
|
+
}): Promise<AppUsageMonthResponse>;
|
|
2542
|
+
/** An app's top users over a window, by a meter's quantity or by cost. */
|
|
2543
|
+
getAppUsageTopUsers(appId: string, params?: {
|
|
2544
|
+
meter?: string;
|
|
2545
|
+
by?: "cost";
|
|
2546
|
+
} & UsageWindowParams & {
|
|
2547
|
+
limit?: number;
|
|
2548
|
+
}): Promise<AppUsageTopUsersResponse>;
|
|
2549
|
+
/** One user's usage over a window and the bytes they own. */
|
|
2550
|
+
getAppUsageUser(appId: string, userId: string, params?: UsageWindowParams): Promise<AppUsageUserResponse>;
|
|
2551
|
+
/** An app's system usage over a window, by origin, source, resource and meter. */
|
|
2552
|
+
getAppUsageSystem(appId: string, params?: UsageWindowParams & {
|
|
2553
|
+
meter?: string;
|
|
2554
|
+
limit?: number;
|
|
2555
|
+
}): Promise<AppUsageSystemResponse>;
|
|
2556
|
+
/** The top apps by estimated cost, month to date (super-admin). */
|
|
2557
|
+
listUsageTopApps(params?: {
|
|
2558
|
+
limit?: number;
|
|
2559
|
+
}): Promise<UsageTopAppsResponse>;
|
|
2560
|
+
/** The top developers by estimated cost, month to date (super-admin). */
|
|
2561
|
+
listUsageTopDevelopers(params?: {
|
|
2562
|
+
limit?: number;
|
|
2563
|
+
}): Promise<UsageTopDevelopersResponse>;
|
|
2564
|
+
/** The usage jobs' state (super-admin). */
|
|
2565
|
+
getUsageJobs(): Promise<UsageJobsResponse>;
|
|
1973
2566
|
/**
|
|
1974
2567
|
* The signed-in admin's own profile, `role` included.
|
|
1975
2568
|
*
|
|
@@ -2266,6 +2859,7 @@ export declare class ApiClient {
|
|
|
2266
2859
|
}, expectedModifiedAt?: string, options?: {
|
|
2267
2860
|
dryRun?: boolean;
|
|
2268
2861
|
acceptWarnings?: boolean;
|
|
2862
|
+
allowFieldRemoval?: boolean;
|
|
2269
2863
|
}): Promise<any>;
|
|
2270
2864
|
deleteDatabaseTypeConfig(appId: string, databaseType: string, options?: {
|
|
2271
2865
|
force?: boolean;
|
|
@@ -2986,6 +3580,13 @@ export declare class ApiClient {
|
|
|
2986
3580
|
}): Promise<any>;
|
|
2987
3581
|
/** `GET db3/:id` (#4804): the db3, with the caller's grant when it reads it through one. */
|
|
2988
3582
|
getDb3(appId: string, db3Id: string): Promise<any>;
|
|
3583
|
+
/**
|
|
3584
|
+
* `PUT db3/:id` (#5890): rename a db3, answered as `getDb3` answers it with
|
|
3585
|
+
* the new title.
|
|
3586
|
+
*/
|
|
3587
|
+
updateDb3(appId: string, db3Id: string, body: {
|
|
3588
|
+
title: string;
|
|
3589
|
+
}): Promise<any>;
|
|
2989
3590
|
/** `DELETE db3/:id` (#4804): the documents delete for a db3. */
|
|
2990
3591
|
deleteDb3(appId: string, db3Id: string): Promise<any>;
|
|
2991
3592
|
/** The db3 mount of {@link getDocumentStats}: `GET db3/:id/stats`. */
|
|
@@ -3068,7 +3669,9 @@ export declare class ApiClient {
|
|
|
3068
3669
|
getDb3TypeConfig(appId: string, name: string): Promise<any>;
|
|
3069
3670
|
/**
|
|
3070
3671
|
* `PUT db3-types/:name` (#4802): create or update the type, and push its new
|
|
3071
|
-
* revision to every db3 of it. `dryRun` judges the body and persists nothing
|
|
3672
|
+
* revision to every db3 of it. `dryRun` judges the body and persists nothing;
|
|
3673
|
+
* `allowFieldRemoval` asks for the append-only override (#6019), which the
|
|
3674
|
+
* server takes only on an app whose stored settings enable it.
|
|
3072
3675
|
*/
|
|
3073
3676
|
pushDb3Type(appId: string, name: string, data: {
|
|
3074
3677
|
ruleSetId?: string | null;
|
|
@@ -3080,6 +3683,7 @@ export declare class ApiClient {
|
|
|
3080
3683
|
expectedModifiedAt?: string;
|
|
3081
3684
|
}, options?: {
|
|
3082
3685
|
dryRun?: boolean;
|
|
3686
|
+
allowFieldRemoval?: boolean;
|
|
3083
3687
|
}): Promise<any>;
|
|
3084
3688
|
/** `DELETE db3-types/:name` (#4802): refused while a db3 is of the type. */
|
|
3085
3689
|
deleteDb3Type(appId: string, name: string): Promise<any>;
|