Skip to content

Commit 8b99031

Browse files
authored
Migrate shell scripts to zx+ts (#113)
* migrate shell scripts to use zx * migrate more scripts to ts + test config overhaul
1 parent bbc5687 commit 8b99031

File tree

80 files changed

+2345
-1732
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

80 files changed

+2345
-1732
lines changed

etc/astra-db-ts.api.md

Lines changed: 46 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -252,6 +252,7 @@ export class AstraAdmin extends HierarchicalLogger<AdminCommandEventMap> {
252252
timeout: 'databaseAdminTimeoutMs';
253253
}>): Promise<AstraFullDatabaseInfo>;
254254
dropDatabase(db: Db | string, options?: AstraDropDatabaseOptions): Promise<void>;
255+
findAvailableRegions(options?: AstraFindAvailableRegionsOptions): Promise<AstraAvailableRegionInfo[]>;
255256
// (undocumented)
256257
get _httpClient(): OpaqueHttpClient;
257258
listDatabases(options?: ListAstraDatabasesOptions): Promise<AstraFullDatabaseInfo[]>;
@@ -260,6 +261,17 @@ export class AstraAdmin extends HierarchicalLogger<AdminCommandEventMap> {
260261
// @public
261262
export type AstraAdminBlockingOptions = AstraPollBlockingOptions | AstraNoBlockingOptions;
262263

264+
// @public
265+
export interface AstraAvailableRegionInfo {
266+
classification: AstraRegionClassification;
267+
cloudProvider: AstraDatabaseCloudProvider;
268+
displayName: string;
269+
enabled: boolean;
270+
name: string;
271+
reservedForQualifiedUsers: boolean;
272+
zone: AstraRegionZone;
273+
}
274+
263275
// @public
264276
export interface AstraBaseDatabaseInfo {
265277
cloudProvider: AstraDatabaseCloudProvider;
@@ -328,6 +340,13 @@ export type AstraDropDatabaseOptions = AstraAdminBlockingOptions & CommandOption
328340
timeout: 'databaseAdminTimeoutMs';
329341
}>;
330342

343+
// @public
344+
export interface AstraFindAvailableRegionsOptions extends CommandOptions<{
345+
timeout: 'databaseAdminTimeoutMs';
346+
}> {
347+
onlyOrgEnabledRegions?: boolean;
348+
}
349+
331350
// @public
332351
export interface AstraFullDatabaseInfo extends AstraBaseDatabaseInfo {
333352
createdAt: Date;
@@ -354,6 +373,12 @@ export interface AstraPollBlockingOptions {
354373
pollInterval?: number;
355374
}
356375

376+
// @public
377+
export type AstraRegionClassification = 'standard' | 'premium' | 'premium_plus';
378+
379+
// @public
380+
export type AstraRegionZone = 'na' | 'apac' | 'emea' | 'sa';
381+
357382
// @public
358383
export class AWSEmbeddingHeadersProvider extends StaticHeadersProvider<'embedding'> {
359384
constructor(accessKeyId: string, secretAccessKey: string);
@@ -891,15 +916,15 @@ export class CommandFailedEvent extends CommandEvent {
891916
trimDuplicateFields(): this;
892917
}
893918

894-
// @public (undocumented)
895-
export interface CommandOptions<Cfg extends CommandOptionsOptions = Required<CommandOptionsOptions>> {
919+
// @public
920+
export interface CommandOptions<Spec extends CommandOptionsSpec = Required<CommandOptionsSpec>> {
896921
// @deprecated
897922
maxTimeMS?: 'ERROR: The `maxTimeMS` option is no longer available; the timeouts system has been overhauled, and timeouts should now be set using `timeout`';
898-
timeout?: number | Pick<Partial<TimeoutDescriptor>, 'requestTimeoutMs' | Exclude<Cfg['timeout'], undefined>>;
923+
timeout?: number | Pick<Partial<TimeoutDescriptor>, 'requestTimeoutMs' | Exclude<Spec['timeout'], undefined>>;
899924
}
900925

901-
// @public (undocumented)
902-
export interface CommandOptionsOptions {
926+
// @public
927+
export interface CommandOptionsSpec {
903928
// (undocumented)
904929
timeout?: keyof TimeoutDescriptor;
905930
}
@@ -1823,13 +1848,9 @@ export interface GenericDeleteManyResult {
18231848
// @public
18241849
export interface GenericDeleteOneOptions extends CommandOptions<{
18251850
timeout: 'generalMethodTimeoutMs';
1826-
}> {
1851+
}>, WithDeprecatedVectorSortOptions {
18271852
// (undocumented)
18281853
sort?: Sort;
1829-
// @deprecated
1830-
vector?: 'ERROR: Use `sort: { $vector: [...] }` instead';
1831-
// @deprecated
1832-
vectorize?: 'ERROR: Use `sort: { $vectorize: "..." }` instead';
18331854
}
18341855

18351856
// @public
@@ -1865,71 +1886,51 @@ export interface GenericFindAndRerankOptions extends CommandOptions<{
18651886
// @public
18661887
export interface GenericFindOneAndDeleteOptions extends CommandOptions<{
18671888
timeout: 'generalMethodTimeoutMs';
1868-
}> {
1889+
}>, WithDeprecatedVectorSortOptions {
18691890
projection?: Projection;
18701891
sort?: Sort;
1871-
// @deprecated
1872-
vector?: 'ERROR: Use `sort: { $vector: [...] }` instead';
1873-
// @deprecated
1874-
vectorize?: 'ERROR: Use `sort: { $vectorize: "..." }` instead';
18751892
}
18761893

18771894
// @public
18781895
export interface GenericFindOneAndReplaceOptions extends CommandOptions<{
18791896
timeout: 'generalMethodTimeoutMs';
1880-
}> {
1897+
}>, WithDeprecatedVectorSortOptions {
18811898
projection?: Projection;
18821899
returnDocument?: 'before' | 'after';
18831900
sort?: Sort;
18841901
upsert?: boolean;
1885-
// @deprecated
1886-
vector?: 'ERROR: Use `sort: { $vector: [...] }` instead';
1887-
// @deprecated
1888-
vectorize?: 'ERROR: Use `sort: { $vectorize: "..." }` instead';
18891902
}
18901903

18911904
// @public
18921905
export interface GenericFindOneAndUpdateOptions extends CommandOptions<{
18931906
timeout: 'generalMethodTimeoutMs';
1894-
}> {
1907+
}>, WithDeprecatedVectorSortOptions {
18951908
projection?: Projection;
18961909
returnDocument?: 'before' | 'after';
18971910
sort?: Sort;
18981911
upsert?: boolean;
1899-
// @deprecated
1900-
vector?: 'ERROR: Use `sort: { $vector: [...] }` instead';
1901-
// @deprecated
1902-
vectorize?: 'ERROR: Use `sort: { $vectorize: "..." }` instead';
19031912
}
19041913

19051914
// @public
19061915
export interface GenericFindOneOptions extends CommandOptions<{
19071916
timeout: 'generalMethodTimeoutMs';
1908-
}> {
1917+
}>, WithDeprecatedVectorSortOptions {
19091918
includeSimilarity?: boolean;
19101919
projection?: Projection;
19111920
sort?: Sort;
1912-
// @deprecated
1913-
vector?: 'ERROR: Use `sort: { $vector: [...] }` instead';
1914-
// @deprecated
1915-
vectorize?: 'ERROR: Use `sort: { $vectorize: "..." }` instead';
19161921
}
19171922

19181923
// @public
19191924
export interface GenericFindOptions extends CommandOptions<{
19201925
timeout: 'generalMethodTimeoutMs';
1921-
}> {
1926+
}>, WithDeprecatedVectorSortOptions {
19221927
includeSimilarity?: boolean;
19231928
includeSortVector?: boolean;
19241929
initialPageState?: string | null;
19251930
limit?: number;
19261931
projection?: Projection;
19271932
skip?: number;
19281933
sort?: Sort;
1929-
// @deprecated
1930-
vector?: 'ERROR: Use `sort: { $vector: [...] }` instead';
1931-
// @deprecated
1932-
vectorize?: 'ERROR: Use `sort: { $vectorize: "..." }` instead';
19331934
}
19341935

19351936
// @public
@@ -1968,15 +1969,11 @@ export type GenericInsertOneOptions = CommandOptions<{
19681969
// @public
19691970
export interface GenericReplaceOneOptions extends CommandOptions<{
19701971
timeout: 'generalMethodTimeoutMs';
1971-
}> {
1972+
}>, WithDeprecatedVectorSortOptions {
19721973
// (undocumented)
19731974
sort?: Sort;
19741975
// (undocumented)
19751976
upsert?: boolean;
1976-
// @deprecated
1977-
vector?: 'ERROR: Use `sort: { $vector: [...] }` instead';
1978-
// @deprecated
1979-
vectorize?: 'ERROR: Use `sort: { $vectorize: "..." }` instead';
19801977
}
19811978

19821979
// @public
@@ -1990,13 +1987,9 @@ export interface GenericUpdateManyOptions extends CommandOptions<{
19901987
// @public
19911988
export interface GenericUpdateOneOptions extends CommandOptions<{
19921989
timeout: 'generalMethodTimeoutMs';
1993-
}> {
1990+
}>, WithDeprecatedVectorSortOptions {
19941991
sort?: Sort;
19951992
upsert?: boolean;
1996-
// @deprecated
1997-
vector?: 'ERROR: Use `sort: { $vector: [...] }` instead';
1998-
// @deprecated
1999-
vectorize?: 'ERROR: Use `sort: { $vectorize: "..." }` instead';
20001993
}
20011994

20021995
// @public
@@ -2979,6 +2972,14 @@ export interface VectorizeServiceOptions {
29792972
provider: string;
29802973
}
29812974

2975+
// @public
2976+
export interface WithDeprecatedVectorSortOptions {
2977+
// @deprecated
2978+
vector?: 'ERROR: Use `sort: { $vector: [...] }` instead';
2979+
// @deprecated
2980+
vectorize?: 'ERROR: Use `sort: { $vectorize: "..." }` instead';
2981+
}
2982+
29822983
// @public
29832984
export type WithId<T> = T & {
29842985
_id: IdOf<T>;

examples/astra-db-ts.tgz

1.24 KB
Binary file not shown.

examples/browser/package-lock.json

Lines changed: 7 additions & 7 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

examples/cloudflare-workers/package-lock.json

Lines changed: 7 additions & 7 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

examples/customize-http/package-lock.json

Lines changed: 7 additions & 7 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)