@farthershore/client 0.1.0 → 0.3.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.
Files changed (35) hide show
  1. package/CHANGELOG.md +172 -0
  2. package/README.md +9 -8
  3. package/dist/index.js +105 -54
  4. package/dist/types/api.generated.d.ts +21 -7
  5. package/dist/types/generated/schemas.d.ts +3683 -0
  6. package/dist/types/helpers/wait-for-frontend-build.d.ts +12 -4
  7. package/dist/types/index.d.ts +2 -2
  8. package/dist/types/operations/agents.d.ts +204 -12
  9. package/dist/types/operations/agreements.d.ts +139 -9
  10. package/dist/types/operations/analytics.d.ts +27 -5
  11. package/dist/types/operations/audit-notifications.d.ts +64 -7
  12. package/dist/types/operations/auth.d.ts +12 -4
  13. package/dist/types/operations/backends.d.ts +211 -9
  14. package/dist/types/operations/billing.d.ts +60 -4
  15. package/dist/types/operations/businesses.d.ts +744 -27
  16. package/dist/types/operations/change-sets.d.ts +426 -7
  17. package/dist/types/operations/consumers.d.ts +133 -14
  18. package/dist/types/operations/define.d.ts +16 -5
  19. package/dist/types/operations/environments.d.ts +40 -4
  20. package/dist/types/operations/frontend.d.ts +20 -2
  21. package/dist/types/operations/index.d.ts +3941 -193
  22. package/dist/types/operations/maker-tokens.d.ts +175 -11
  23. package/dist/types/operations/organizations.d.ts +321 -19
  24. package/dist/types/operations/personas.d.ts +98 -8
  25. package/dist/types/operations/plans-usage.d.ts +69 -3
  26. package/dist/types/operations/platform.d.ts +420 -12
  27. package/dist/types/operations/portal.d.ts +409 -16
  28. package/dist/types/operations/promo-codes.d.ts +126 -6
  29. package/dist/types/operations/variables.d.ts +170 -7
  30. package/dist/types/operations/webhooks.d.ts +77 -14
  31. package/dist/types/surface-types.d.ts +25 -3
  32. package/dist/types/transport.d.ts +5 -10
  33. package/dist/types/types.d.ts +385 -411
  34. package/dist/types/version.d.ts +2 -2
  35. package/package.json +1 -1
@@ -1,4 +1,3 @@
1
- import type { BusinessVariableRow, SecretMutationOperation } from "../types.js";
2
1
  type VariableRef = {
3
2
  businessId: string;
4
3
  name: string;
@@ -12,14 +11,178 @@ export declare const variableOperations: {
12
11
  "variables.read": import("./define.js").OperationEntry<{
13
12
  businessId: string;
14
13
  environmentId?: string;
15
- }, BusinessVariableRow[]>;
16
- "variables.create": import("./define.js").OperationEntry<WriteInput, SecretMutationOperation>;
17
- "variables.rotate": import("./define.js").OperationEntry<WriteInput, SecretMutationOperation>;
18
- "variables.revoke": import("./define.js").OperationEntry<VariableRef, SecretMutationOperation>;
19
- "variables.delete": import("./define.js").OperationEntry<VariableRef, SecretMutationOperation>;
14
+ }, {
15
+ name: string;
16
+ visibility: "public" | "secret";
17
+ value: string | null;
18
+ hasValue: boolean;
19
+ lifecycleStatus: "PENDING" | "ACTIVE" | "REVOKING" | "REVOKED" | "DELETE_PENDING" | "DELETED";
20
+ version: number | null;
21
+ }[], {
22
+ name: string;
23
+ visibility: "public" | "secret";
24
+ value: string | null;
25
+ hasValue: boolean;
26
+ lifecycleStatus: "PENDING" | "ACTIVE" | "REVOKING" | "REVOKED" | "DELETE_PENDING" | "DELETED";
27
+ version: number | null;
28
+ }[]>;
29
+ "variables.create": import("./define.js").OperationEntry<WriteInput, {
30
+ operationId: string;
31
+ kind: "CREATE" | "ROTATE" | "REVOKE" | "DELETE";
32
+ status: "PENDING" | "PROCESSING" | "WAITING_RETRY" | "SUCCEEDED" | "ABORTED";
33
+ version: number;
34
+ pending: boolean;
35
+ attemptCount: number;
36
+ nextAttemptAt: string;
37
+ lastAttemptAt: string | null;
38
+ lastError: {
39
+ code: "SECRET_PUBLICATION_FAILED";
40
+ message: string;
41
+ } | null;
42
+ completedAt: string | null;
43
+ impact: import("../generated/schemas.js").components["schemas"]["SecretMutationImpact"];
44
+ }, {
45
+ operationId: string;
46
+ kind: "CREATE" | "ROTATE" | "REVOKE" | "DELETE";
47
+ status: "PENDING" | "PROCESSING" | "WAITING_RETRY" | "SUCCEEDED" | "ABORTED";
48
+ version: number;
49
+ pending: boolean;
50
+ attemptCount: number;
51
+ nextAttemptAt: string;
52
+ lastAttemptAt: string | null;
53
+ lastError: {
54
+ code: "SECRET_PUBLICATION_FAILED";
55
+ message: string;
56
+ } | null;
57
+ completedAt: string | null;
58
+ impact: import("../generated/schemas.js").components["schemas"]["SecretMutationImpact"];
59
+ }>;
60
+ "variables.rotate": import("./define.js").OperationEntry<WriteInput, {
61
+ operationId: string;
62
+ kind: "CREATE" | "ROTATE" | "REVOKE" | "DELETE";
63
+ status: "PENDING" | "PROCESSING" | "WAITING_RETRY" | "SUCCEEDED" | "ABORTED";
64
+ version: number;
65
+ pending: boolean;
66
+ attemptCount: number;
67
+ nextAttemptAt: string;
68
+ lastAttemptAt: string | null;
69
+ lastError: {
70
+ code: "SECRET_PUBLICATION_FAILED";
71
+ message: string;
72
+ } | null;
73
+ completedAt: string | null;
74
+ impact: import("../generated/schemas.js").components["schemas"]["SecretMutationImpact"];
75
+ }, {
76
+ operationId: string;
77
+ kind: "CREATE" | "ROTATE" | "REVOKE" | "DELETE";
78
+ status: "PENDING" | "PROCESSING" | "WAITING_RETRY" | "SUCCEEDED" | "ABORTED";
79
+ version: number;
80
+ pending: boolean;
81
+ attemptCount: number;
82
+ nextAttemptAt: string;
83
+ lastAttemptAt: string | null;
84
+ lastError: {
85
+ code: "SECRET_PUBLICATION_FAILED";
86
+ message: string;
87
+ } | null;
88
+ completedAt: string | null;
89
+ impact: import("../generated/schemas.js").components["schemas"]["SecretMutationImpact"];
90
+ }>;
91
+ "variables.revoke": import("./define.js").OperationEntry<VariableRef, {
92
+ operationId: string;
93
+ kind: "CREATE" | "ROTATE" | "REVOKE" | "DELETE";
94
+ status: "PENDING" | "PROCESSING" | "WAITING_RETRY" | "SUCCEEDED" | "ABORTED";
95
+ version: number;
96
+ pending: boolean;
97
+ attemptCount: number;
98
+ nextAttemptAt: string;
99
+ lastAttemptAt: string | null;
100
+ lastError: {
101
+ code: "SECRET_PUBLICATION_FAILED";
102
+ message: string;
103
+ } | null;
104
+ completedAt: string | null;
105
+ impact: import("../generated/schemas.js").components["schemas"]["SecretMutationImpact"];
106
+ }, {
107
+ operationId: string;
108
+ kind: "CREATE" | "ROTATE" | "REVOKE" | "DELETE";
109
+ status: "PENDING" | "PROCESSING" | "WAITING_RETRY" | "SUCCEEDED" | "ABORTED";
110
+ version: number;
111
+ pending: boolean;
112
+ attemptCount: number;
113
+ nextAttemptAt: string;
114
+ lastAttemptAt: string | null;
115
+ lastError: {
116
+ code: "SECRET_PUBLICATION_FAILED";
117
+ message: string;
118
+ } | null;
119
+ completedAt: string | null;
120
+ impact: import("../generated/schemas.js").components["schemas"]["SecretMutationImpact"];
121
+ }>;
122
+ "variables.delete": import("./define.js").OperationEntry<VariableRef, {
123
+ operationId: string;
124
+ kind: "CREATE" | "ROTATE" | "REVOKE" | "DELETE";
125
+ status: "PENDING" | "PROCESSING" | "WAITING_RETRY" | "SUCCEEDED" | "ABORTED";
126
+ version: number;
127
+ pending: boolean;
128
+ attemptCount: number;
129
+ nextAttemptAt: string;
130
+ lastAttemptAt: string | null;
131
+ lastError: {
132
+ code: "SECRET_PUBLICATION_FAILED";
133
+ message: string;
134
+ } | null;
135
+ completedAt: string | null;
136
+ impact: import("../generated/schemas.js").components["schemas"]["SecretMutationImpact"];
137
+ }, {
138
+ operationId: string;
139
+ kind: "CREATE" | "ROTATE" | "REVOKE" | "DELETE";
140
+ status: "PENDING" | "PROCESSING" | "WAITING_RETRY" | "SUCCEEDED" | "ABORTED";
141
+ version: number;
142
+ pending: boolean;
143
+ attemptCount: number;
144
+ nextAttemptAt: string;
145
+ lastAttemptAt: string | null;
146
+ lastError: {
147
+ code: "SECRET_PUBLICATION_FAILED";
148
+ message: string;
149
+ } | null;
150
+ completedAt: string | null;
151
+ impact: import("../generated/schemas.js").components["schemas"]["SecretMutationImpact"];
152
+ }>;
20
153
  "variables.operation.read": import("./define.js").OperationEntry<{
21
154
  businessId: string;
22
155
  operationId: string;
23
- }, SecretMutationOperation>;
156
+ }, {
157
+ operationId: string;
158
+ kind: "CREATE" | "ROTATE" | "REVOKE" | "DELETE";
159
+ status: "PENDING" | "PROCESSING" | "WAITING_RETRY" | "SUCCEEDED" | "ABORTED";
160
+ version: number;
161
+ pending: boolean;
162
+ attemptCount: number;
163
+ nextAttemptAt: string;
164
+ lastAttemptAt: string | null;
165
+ lastError: {
166
+ code: "SECRET_PUBLICATION_FAILED";
167
+ message: string;
168
+ } | null;
169
+ completedAt: string | null;
170
+ impact: import("../generated/schemas.js").components["schemas"]["SecretMutationImpact"];
171
+ }, {
172
+ operationId: string;
173
+ kind: "CREATE" | "ROTATE" | "REVOKE" | "DELETE";
174
+ status: "PENDING" | "PROCESSING" | "WAITING_RETRY" | "SUCCEEDED" | "ABORTED";
175
+ version: number;
176
+ pending: boolean;
177
+ attemptCount: number;
178
+ nextAttemptAt: string;
179
+ lastAttemptAt: string | null;
180
+ lastError: {
181
+ code: "SECRET_PUBLICATION_FAILED";
182
+ message: string;
183
+ } | null;
184
+ completedAt: string | null;
185
+ impact: import("../generated/schemas.js").components["schemas"]["SecretMutationImpact"];
186
+ }>;
24
187
  };
25
188
  export {};
@@ -1,4 +1,3 @@
1
- import type { PaginatedResult, WebhookDelivery, WebhookEndpoint, WebhookTestResult } from "../types.js";
2
1
  type BusinessRef = {
3
2
  businessId: string;
4
3
  };
@@ -13,14 +12,32 @@ export declare const webhookOperations: {
13
12
  "webhooks.read": import("./define.js").OperationEntry<BusinessRef & {
14
13
  limit?: number | string;
15
14
  offset?: number;
16
- }, PaginatedResult<WebhookEndpoint>>;
15
+ }, {
16
+ data: import("../generated/schemas.js").components["schemas"]["WebhookEndpoint"][];
17
+ pagination: {
18
+ total: number;
19
+ limit: number;
20
+ offset: number;
21
+ hasMore: boolean;
22
+ };
23
+ }, {
24
+ data: import("../generated/schemas.js").components["schemas"]["WebhookEndpoint"][];
25
+ pagination: {
26
+ total: number;
27
+ limit: number;
28
+ offset: number;
29
+ hasMore: boolean;
30
+ };
31
+ }>;
17
32
  "webhooks.create": import("./define.js").OperationEntry<BusinessRef & {
18
33
  url: string;
19
34
  events: string[];
20
35
  /** One environment's events; null or omitted = every environment. */
21
36
  environmentId?: string | null;
22
37
  }, {
23
- data: WebhookEndpoint;
38
+ data: import("../generated/schemas.js").components["schemas"]["WebhookEndpointIssuance"];
39
+ }, {
40
+ data: import("../generated/schemas.js").components["schemas"]["WebhookEndpointIssuance"];
24
41
  }>;
25
42
  "webhooks.update": import("./define.js").OperationEntry<BusinessRef & {
26
43
  webhookId: string;
@@ -30,31 +47,52 @@ export declare const webhookOperations: {
30
47
  enabled?: boolean;
31
48
  environmentId?: string | null;
32
49
  }, {
33
- data: WebhookEndpoint;
50
+ data: import("../generated/schemas.js").components["schemas"]["WebhookEndpoint"];
51
+ }, {
52
+ data: import("../generated/schemas.js").components["schemas"]["WebhookEndpoint"];
34
53
  }>;
35
54
  "webhooks.delete": import("./define.js").OperationEntry<WebhookRef, {
36
55
  data: {
37
- deleted: boolean;
56
+ deleted: true;
57
+ };
58
+ }, {
59
+ data: {
60
+ deleted: true;
38
61
  };
39
62
  }>;
40
- "webhooks.test": import("./define.js").OperationEntry<TestInput, WebhookTestResult>;
63
+ "webhooks.test": import("./define.js").OperationEntry<TestInput, {
64
+ data: import("../generated/schemas.js").components["schemas"]["WebhookTestResult"];
65
+ }, {
66
+ data: import("../generated/schemas.js").components["schemas"]["WebhookTestResult"];
67
+ }>;
41
68
  "webhooks.trigger": import("./define.js").OperationEntry<BusinessRef & {
42
69
  webhookId: string;
43
70
  } & {
44
71
  /** The catalog event type to send a sample of (required). */
45
72
  type: string;
46
- }, WebhookTestResult>;
73
+ }, {
74
+ data: import("../generated/schemas.js").components["schemas"]["WebhookTestResult"];
75
+ }, {
76
+ data: import("../generated/schemas.js").components["schemas"]["WebhookTestResult"];
77
+ }>;
47
78
  "webhooks.rotateSecret": import("./define.js").OperationEntry<WebhookRef, {
48
- data: WebhookEndpoint & {
49
- secret: string;
50
- };
79
+ data: import("../generated/schemas.js").components["schemas"]["WebhookEndpointRotation"];
80
+ }, {
81
+ data: import("../generated/schemas.js").components["schemas"]["WebhookEndpointRotation"];
51
82
  }>;
52
83
  "webhooks.eventType.read": import("./define.js").OperationEntry<BusinessRef, {
53
84
  data: {
54
- events: Array<{
55
- name: string;
85
+ events: {
86
+ name: "subscription.created" | "subscription.updated" | "subscription.canceled" | "payment.succeeded" | "payment.failed" | "entitlement.changed" | "usage.threshold_reached";
87
+ description: string;
88
+ }[];
89
+ };
90
+ }, {
91
+ data: {
92
+ events: {
93
+ name: "subscription.created" | "subscription.updated" | "subscription.canceled" | "payment.succeeded" | "payment.failed" | "entitlement.changed" | "usage.threshold_reached";
56
94
  description: string;
57
- }>;
95
+ }[];
58
96
  };
59
97
  }>;
60
98
  "webhooks.delivery.read": import("./define.js").OperationEntry<BusinessRef & {
@@ -62,6 +100,31 @@ export declare const webhookOperations: {
62
100
  } & {
63
101
  limit?: number | string;
64
102
  offset?: number | string;
65
- }, PaginatedResult<WebhookDelivery>>;
103
+ }, {
104
+ data: import("../generated/schemas.js").components["schemas"]["WebhookDelivery"][];
105
+ pagination: {
106
+ total: number;
107
+ limit: number;
108
+ offset: number;
109
+ hasMore: boolean;
110
+ };
111
+ }, {
112
+ data: import("../generated/schemas.js").components["schemas"]["WebhookDelivery"][];
113
+ pagination: {
114
+ total: number;
115
+ limit: number;
116
+ offset: number;
117
+ hasMore: boolean;
118
+ };
119
+ }>;
120
+ "webhooks.delivery.get": import("./define.js").OperationEntry<BusinessRef & {
121
+ webhookId: string;
122
+ } & {
123
+ deliveryId: string;
124
+ }, {
125
+ data: import("../generated/schemas.js").components["schemas"]["WebhookDelivery"];
126
+ }, {
127
+ data: import("../generated/schemas.js").components["schemas"]["WebhookDelivery"];
128
+ }>;
66
129
  };
67
130
  export {};
@@ -26,9 +26,31 @@ export type OperationMeta = {
26
26
  /** The exact platform permission the operation requires. */
27
27
  readonly permission: string | null;
28
28
  };
29
- type MethodFn<I, O> = [I] extends [void] ? (input?: undefined, options?: CallOptions) => Promise<O> : undefined extends I ? (input?: I, options?: CallOptions) => Promise<O> : {} extends I ? (input?: I, options?: CallOptions) => Promise<O> : (input: I, options?: CallOptions) => Promise<O>;
29
+ /**
30
+ * What a preview call (`{ dryRun: true }`) resolves to: the server answers
31
+ * with what the operation would have returned, without applying it.
32
+ */
33
+ export type DryRunPreview<O> = {
34
+ readonly dryRun: true;
35
+ readonly wouldHave: O;
36
+ };
37
+ /** Call options that request a preview. */
38
+ type PreviewCallOptions = CallOptions & {
39
+ dryRun: true;
40
+ };
41
+ /** A method whose input may be omitted: a preview resolves to `DryRunPreview<O>`. */
42
+ type OptionalInputFn<I, O, W = O> = {
43
+ (input: I | undefined, options: PreviewCallOptions): Promise<DryRunPreview<W>>;
44
+ (input?: I, options?: CallOptions): Promise<O>;
45
+ };
46
+ /** A method that requires its input: a preview resolves to `DryRunPreview<O>`. */
47
+ type RequiredInputFn<I, O, W = O> = {
48
+ (input: I, options: PreviewCallOptions): Promise<DryRunPreview<W>>;
49
+ (input: I, options?: CallOptions): Promise<O>;
50
+ };
51
+ type MethodFn<I, O, W> = [I] extends [void] ? OptionalInputFn<undefined, O, W> : undefined extends I ? OptionalInputFn<I, O, W> : {} extends I ? OptionalInputFn<I, O, W> : RequiredInputFn<I, O, W>;
30
52
  /** A namespaced method: `(input, options?) => Promise<output>` plus `meta`. */
31
- export type MethodOf<E> = E extends OperationEntry<infer I, infer O> ? MethodFn<I, O> & {
53
+ export type MethodOf<E> = E extends OperationEntry<infer I, infer O, infer W> ? MethodFn<I, O, W> & {
32
54
  readonly meta: OperationMeta;
33
55
  } : never;
34
56
  /** The method at a dotted path. */
@@ -36,7 +58,7 @@ export type Method<P extends MethodPath> = MethodOf<OperationTable[P]>;
36
58
  /** Input of the method at a dotted path. */
37
59
  export type MethodInput<P extends MethodPath> = OperationTable[P] extends OperationEntry<infer I, unknown> ? I : never;
38
60
  /** Output of the method at a dotted path. */
39
- export type MethodOutput<P extends MethodPath> = OperationTable[P] extends OperationEntry<never, infer O> ? O : never;
61
+ export type MethodOutput<P extends MethodPath> = OperationTable[P] extends OperationEntry<never, infer O, any> ? O : never;
40
62
  type Nest<Path extends string, V> = Path extends `${infer Head}.${infer Rest}` ? {
41
63
  readonly [K in Head]: Nest<Rest, V>;
42
64
  } : {
@@ -1,4 +1,5 @@
1
1
  import type { CredentialSource } from "./credentials.js";
2
+ import type { components } from "./generated/schemas.js";
2
3
  export declare const SURFACE_HEADER = "x-fs-surface";
3
4
  export declare const CLIENT_HEADER = "x-fs-client";
4
5
  /** Per-attempt deadline; it bounds the response body read too. */
@@ -69,16 +70,10 @@ export type CreateTransportOptions = {
69
70
  clientInfo?: string;
70
71
  retry?: RetryOptions;
71
72
  };
72
- export type OrganizationSummary = {
73
- id: string;
74
- name: string;
75
- slug: string;
76
- role: string;
77
- };
78
- export type OrganizationsResponse = {
79
- userId: string;
80
- organizations: OrganizationSummary[];
81
- };
73
+ /** An organization a CLI login can act in, with the user's role key. */
74
+ export type OrganizationSummary = components["schemas"]["CliOrganizationSummary"];
75
+ /** `GET /auth/cli/organizations` (generated from the contracts zod schema). */
76
+ export type OrganizationsResponse = components["schemas"]["CliOrganizationsResponse"];
82
77
  export type Transport = {
83
78
  /** The API origin this transport targets. */
84
79
  readonly baseUrl: string;