Skip to content

ESM update hotfix #101

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 9 commits into from
Feb 6, 2025
Merged

ESM update hotfix #101

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
6c33d57
hotfix for broken types
toptobes Feb 6, 2025
115421c
clean up & speed up build script
toptobes Feb 6, 2025
79427dd
change Coll => Collection prefixes as per vals suggestion
toptobes Feb 6, 2025
50073ff
check to make sure esm & cjs exports are the saem
toptobes Feb 6, 2025
ec6917a
update example deps
toptobes Feb 6, 2025
c3ed49f
build step to remove #private from rollup .d.ts
toptobes Feb 6, 2025
f652a87
pushing another fix
toptobes Feb 6, 2025
72bd726
update example deps
toptobes Feb 6, 2025
e90ce25
run premerge script
toptobes Feb 6, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
155 changes: 77 additions & 78 deletions etc/astra-db-ts.api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
```ts

import { BigNumber } from 'bignumber.js';
import { CollSerDesConfig as CollSerDesConfig_2 } from '../../documents/collections/ser-des/ser-des.js';
import { CollectionSerDesConfig as CollectionSerDesConfig_2 } from '../../documents/collections/ser-des/ser-des.js';
import { Decoder } from 'decoders';
import type { DecoderType } from 'decoders';
import { Monoid as Monoid_2 } from '../../lib/opts-handler.js';
Expand Down Expand Up @@ -319,6 +319,8 @@ export interface BaseSerDesCtx {
target: SerDesTarget;
}

export { BigNumber }

// @public
export const blob: (blob: DataAPIBlobLike) => DataAPIBlob;

Expand Down Expand Up @@ -350,54 +352,6 @@ export interface Camel2SnakeCaseOptions {
transformNested?: boolean | ((path: KeyTransformerCtx) => boolean);
}

// @public (undocumented)
export type CollCodec<Class extends CollCodecClass> = InstanceType<Class>;

// @public (undocumented)
export interface CollCodecClass {
// (undocumented)
[$DeserializeForCollection]: SerDesFn<CollDesCtx>;
// (undocumented)
new (...args: any[]): {
[$SerializeForCollection]: (ctx: CollSerCtx) => ReturnType<SerDesFn<any>>;
};
}

// @public (undocumented)
export class CollCodecs {
// Warning: (ae-forgotten-export) The symbol "CollCustomCodecOpts" needs to be exported by the entry point index.d.ts
//
// (undocumented)
static custom(opts: CollCustomCodecOpts): RawCollCodecs;
// (undocumented)
static Defaults: {
$date: RawCollCodecs;
$vector: RawCollCodecs;
$uuid: RawCollCodecs;
$objectId: RawCollCodecs;
};
// Warning: (ae-forgotten-export) The symbol "CollNominalCodecOpts" needs to be exported by the entry point index.d.ts
//
// (undocumented)
static forId(optsOrClass: CollNominalCodecOpts & {
class?: SomeConstructor;
} | CollCodecClass): RawCollCodecs;
// (undocumented)
static forName(name: string, optsOrClass: CollNominalCodecOpts | CollCodecClass): RawCollCodecs;
// (undocumented)
static forPath(path: (string | number)[], optsOrClass: CollNominalCodecOpts | CollCodecClass): RawCollCodecs;
// Warning: (ae-forgotten-export) The symbol "CollTypeCodecOpts" needs to be exported by the entry point index.d.ts
//
// (undocumented)
static forType(type: string, optsOrClass: CollTypeCodecOpts | CollCodecClass): RawCollCodecs;
}

// @public (undocumented)
export interface CollDesCtx extends BaseDesCtx<CollDesCtx> {
// (undocumented)
getNumRepForPath?: GetCollNumRepFn;
}

// @public
export class Collection<WSchema extends SomeDoc = SomeDoc, RSchema extends WithId<SomeDoc> = FoundDoc<WSchema>> {
// Warning: (ae-forgotten-export) The symbol "DataAPIHttpClient" needs to be exported by the entry point index.d.ts
Expand Down Expand Up @@ -445,6 +399,48 @@ export type CollectionArrayUpdate<Schema> = {
[K in keyof Schema as any[] extends Schema[K] ? K : never]?: PickArrayTypes<Schema[K]>;
};

// @public (undocumented)
export type CollectionCodec<Class extends CollectionCodecClass> = InstanceType<Class>;

// @public (undocumented)
export interface CollectionCodecClass {
// (undocumented)
[$DeserializeForCollection]: SerDesFn<CollectionDesCtx>;
// (undocumented)
new (...args: any[]): {
[$SerializeForCollection]: (ctx: CollectionSerCtx) => ReturnType<SerDesFn<any>>;
};
}

// @public (undocumented)
export class CollectionCodecs {
// Warning: (ae-forgotten-export) The symbol "CollCustomCodecOpts" needs to be exported by the entry point index.d.ts
//
// (undocumented)
static custom(opts: CollCustomCodecOpts): RawCollCodecs;
// (undocumented)
static Defaults: {
$date: RawCollCodecs;
$vector: RawCollCodecs;
$uuid: RawCollCodecs;
$objectId: RawCollCodecs;
};
// Warning: (ae-forgotten-export) The symbol "CollNominalCodecOpts" needs to be exported by the entry point index.d.ts
//
// (undocumented)
static forId(optsOrClass: CollNominalCodecOpts & {
class?: SomeConstructor;
} | CollectionCodecClass): RawCollCodecs;
// (undocumented)
static forName(name: string, optsOrClass: CollNominalCodecOpts | CollectionCodecClass): RawCollCodecs;
// (undocumented)
static forPath(path: (string | number)[], optsOrClass: CollNominalCodecOpts | CollectionCodecClass): RawCollCodecs;
// Warning: (ae-forgotten-export) The symbol "CollTypeCodecOpts" needs to be exported by the entry point index.d.ts
//
// (undocumented)
static forType(type: string, optsOrClass: CollTypeCodecOpts | CollectionCodecClass): RawCollCodecs;
}

// @public
export type CollectionCurrentDate<Schema> = {
[K in keyof Schema as Schema[K] extends Date | {
Expand Down Expand Up @@ -496,6 +492,12 @@ export interface CollectionDescriptor {
name: string;
}

// @public (undocumented)
export interface CollectionDesCtx extends BaseDesCtx<CollectionDesCtx> {
// (undocumented)
getNumRepForPath?: GetCollNumRepFn;
}

// @public
export type CollectionFilter<Schema extends SomeDoc> = {
[K in keyof ToDotNotation<NoId<Schema>>]?: CollectionFilterExpr<ToDotNotation<NoId<Schema>>[K]>;
Expand Down Expand Up @@ -585,7 +587,7 @@ export interface CollectionOptions extends WithKeyspace {
embeddingApiKey?: string | EmbeddingHeadersProvider | null;
logging?: DataAPILoggingConfig;
// @beta
serdes?: CollSerDesConfig;
serdes?: CollectionSerDesConfig;
timeoutDefaults?: Partial<TimeoutDescriptor>;
}

Expand All @@ -608,6 +610,20 @@ export type CollectionReplaceOneOptions = GenericReplaceOneOptions;
// @public
export type CollectionReplaceOneResult<RSchema> = GenericUpdateResult<IdOf<RSchema>, 0 | 1>;

// @public (undocumented)
export interface CollectionSerCtx extends BaseSerCtx<CollectionSerCtx> {
// (undocumented)
bigNumsEnabled: boolean;
}

// @public (undocumented)
export interface CollectionSerDesConfig extends BaseSerDesConfig<CollectionSerCtx, CollectionDesCtx> {
// (undocumented)
codecs?: RawCollCodecs[];
// (undocumented)
enableBigNumbers?: GetCollNumRepFn | CollNumRepCfg;
}

// @public
export interface CollectionUpdateFilter<Schema extends SomeDoc> {
$addToSet?: CollectionPush<Schema> & SomeDoc;
Expand Down Expand Up @@ -660,20 +676,6 @@ export type CollNumRep = 'number' | 'bigint' | 'bignumber' | 'string' | 'number_
// @public (undocumented)
export type CollNumRepCfg = Record<string, CollNumRep>;

// @public (undocumented)
export interface CollSerCtx extends BaseSerCtx<CollSerCtx> {
// (undocumented)
bigNumsEnabled: boolean;
}

// @public (undocumented)
export interface CollSerDesConfig extends BaseSerDesConfig<CollSerCtx, CollDesCtx> {
// (undocumented)
codecs?: RawCollCodecs[];
// (undocumented)
enableBigNumbers?: GetCollNumRepFn | CollNumRepCfg;
}

// @public
export abstract class CommandEvent extends BaseDataAPIClientEvent {
// Warning: (ae-forgotten-export) The symbol "DataAPIRequestInfo" needs to be exported by the entry point index.d.ts
Expand Down Expand Up @@ -1079,10 +1081,10 @@ export class DataAPITimeoutError extends DataAPIError {
}

// @public
export class DataAPIVector implements CollCodec<typeof DataAPIVector>, TableCodec<typeof DataAPIVector> {
static [$DeserializeForCollection](value: any, ctx: CollDesCtx): readonly [0, (DataAPIVector | undefined)?];
export class DataAPIVector implements CollectionCodec<typeof DataAPIVector>, TableCodec<typeof DataAPIVector> {
static [$DeserializeForCollection](value: any, ctx: CollectionDesCtx): readonly [0, (DataAPIVector | undefined)?];
static [$DeserializeForTable](value: any, ctx: TableDesCtx): readonly [0, (DataAPIVector | undefined)?];
[$SerializeForCollection](ctx: CollSerCtx): readonly [0, (number[] | {
[$SerializeForCollection](ctx: CollectionSerCtx): readonly [0, (number[] | {
$binary: string;
} | undefined)?];
[$SerializeForTable](ctx: TableSerCtx): readonly [0, (number[] | {
Expand Down Expand Up @@ -1179,7 +1181,7 @@ export interface DbOptions {

// @public
export interface DbSerDesConfig {
collection?: Omit<CollSerDesConfig, 'mutateInPlace'>;
collection?: Omit<CollectionSerDesConfig, 'mutateInPlace'>;
mutateInPlace?: boolean;
table?: Omit<TableSerDesConfig, 'mutateInPlace'>;
}
Expand Down Expand Up @@ -1619,7 +1621,7 @@ export abstract class KeyTransformer {
export const LIB_NAME = "astra-db-ts";

// @public
export const LIB_VERSION = "2.0.0-preview.3";
export const LIB_VERSION = "2.0.0-preview.4";

// @public
export interface ListAstraDatabasesOptions extends WithTimeout<'databaseAdminTimeoutMs'> {
Expand Down Expand Up @@ -1765,9 +1767,9 @@ export class NumCoercionError extends Error {
}

// @public
export class ObjectId implements CollCodec<typeof ObjectId> {
static [$DeserializeForCollection](value: any, ctx: CollDesCtx): readonly [0, (ObjectId | undefined)?];
[$SerializeForCollection](ctx: CollSerCtx): readonly [0, ({
export class ObjectId implements CollectionCodec<typeof ObjectId> {
static [$DeserializeForCollection](value: any, ctx: CollectionDesCtx): readonly [0, (ObjectId | undefined)?];
[$SerializeForCollection](ctx: CollectionSerCtx): readonly [0, ({
$objectId: string;
} | undefined)?];
constructor(id?: string | number | null, validate?: boolean);
Expand Down Expand Up @@ -2244,10 +2246,10 @@ export class UsernamePasswordTokenProvider extends TokenProvider {
}

// @public
export class UUID implements CollCodec<typeof UUID>, TableCodec<typeof UUID> {
static [$DeserializeForCollection](value: any, ctx: CollDesCtx): readonly [0, (UUID | undefined)?];
export class UUID implements CollectionCodec<typeof UUID>, TableCodec<typeof UUID> {
static [$DeserializeForCollection](value: any, ctx: CollectionDesCtx): readonly [0, (UUID | undefined)?];
static [$DeserializeForTable](value: any, ctx: TableDesCtx): readonly [0, (UUID | undefined)?];
[$SerializeForCollection](ctx: CollSerCtx): readonly [0, ({
[$SerializeForCollection](ctx: CollectionSerCtx): readonly [0, ({
$uuid: string;
} | undefined)?];
[$SerializeForTable](ctx: TableSerCtx): readonly [0, (string | undefined)?];
Expand Down Expand Up @@ -2316,9 +2318,6 @@ export interface WithTimeout<Timeouts extends keyof TimeoutDescriptor> {
timeout?: number | Pick<Partial<TimeoutDescriptor>, 'requestTimeoutMs' | Timeouts>;
}


export * from "bignumber.js";

// Warnings were encountered during analysis:
//
// dist/esm/documents/collections/ser-des/codecs.d.ts:41:9 - (ae-forgotten-export) The symbol "RawCollCodecs" needs to be exported by the entry point index.d.ts
Expand Down
Binary file modified examples/astra-db-ts.tgz
View file
Open in desktop
Binary file not shown.
15 changes: 4 additions & 11 deletions examples/browser/package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

15 changes: 4 additions & 11 deletions examples/cloudflare-workers/package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading