dinah 0.5.0 → 0.7.0

package/dist/table-DBPBsigX.d.cts

@@ -0,0 +1,145 @@
+import { Static, TSchema } from "typebox";
+
+//#region src/types.d.ts
+type Obj<T = any> = Record<string, T>;
+type AllKeys<T> = Extract<T extends any ? keyof T : never, string>;
+type PartialSome<T, K extends string | number | symbol> = Omit<T, K> & Partial<Pick<T, Extract<K, keyof T>>>;
+type DistPartialSome<T, K extends string | number | symbol> = T extends unknown ? PartialSome<T, K> : never;
+type ExtractTableDef<T> = T extends Table<any, infer Def> ? Def : never;
+type ExtractTableSchema<T> = T extends Table<infer Schema, any> ? unknown extends Static<Schema> ? any : Static<Schema> : never;
+type ExtractKey<S, D> = D extends {
+  partitionKey: infer PK;
+  sortKey?: infer SK;
+} ? PK extends keyof S ? SK extends keyof S ? Pick<S, PK | SK> : Pick<S, PK> : never : never;
+type Func = (...args: any[]) => any;
+type ExtractKeys<T, O> = { [K in AllKeys<T>]: PickTypeOf<T, K, O> extends never ? never : {
+  k: K;
+  v: PickTypeOf<T, K, O>;
+} }[AllKeys<T>]["k"];
+type PickTypeOf<T, K extends AllKeys<T>, O> = T extends { [k in K]?: O } ? T[K] : never;
+type ToUnion<T> = T extends readonly (infer U)[] ? U : T;
+/** Operators valid in a KeyConditionExpression (sort key). */
+type SortKeyOps<V> = {
+  $eq?: V;
+  $gt?: V;
+  $gte?: V;
+  $lt?: V;
+  $lte?: V;
+} & ([V] extends [string] ? {
+  $between?: [string, string];
+  $prefix?: string;
+} : [V] extends [number] ? {
+  $between?: [number, number];
+} : {});
+type SortKeyFieldCondition<V> = V | SortKeyOps<V>;
+type SortKeyPick<Schema, Keys extends keyof Schema> = { [K in Keys]: SortKeyFieldCondition<Schema[K]> };
+type SortKeyQuery<Schema, SK> = SK extends readonly [infer A extends string & keyof Schema, infer B extends string & keyof Schema, infer C extends string & keyof Schema, infer D extends string & keyof Schema] ? {} | SortKeyPick<Schema, A> | SortKeyPick<Schema, A | B> | SortKeyPick<Schema, A | B | C> | SortKeyPick<Schema, A | B | C | D> : SK extends readonly [infer A extends string & keyof Schema, infer B extends string & keyof Schema, infer C extends string & keyof Schema] ? {} | SortKeyPick<Schema, A> | SortKeyPick<Schema, A | B> | SortKeyPick<Schema, A | B | C> : SK extends readonly [infer A extends string & keyof Schema, infer B extends string & keyof Schema] ? {} | SortKeyPick<Schema, A> | SortKeyPick<Schema, A | B> : SK extends readonly [infer A extends string & keyof Schema] ? {} | SortKeyPick<Schema, A> : SK extends string & keyof Schema ? { [K in SK]?: SortKeyFieldCondition<Schema[K]> } : {};
+type ValidPrimaryKeys<T> = { [K in keyof T]: T[K] extends string | number ? K : never }[keyof T];
+type ValidTtlKeys<T> = ExtractKeys<T, number>;
+type ValidGsiKeys<T> = ExtractKeys<T, string | number>;
+/** Extract the type of field K across all members of union T */
+type ValueOfUnion<T, K extends string> = T extends unknown ? K extends keyof T ? T[K] : never : never;
+/** Comparison operators valid for ordered types (string, number) */
+interface ComparatorOps<V> {
+  $eq?: V;
+  $ne?: V;
+  $gt?: V;
+  $gte?: V;
+  $lt?: V;
+  $lte?: V;
+}
+/** String-specific operators */
+interface StringOps {
+  $prefix?: string;
+  $includes?: string;
+  $between?: [string, string];
+}
+/** Number-specific operators */
+interface NumberOps {
+  $between?: [number, number];
+}
+/** Operators valid for any attribute type */
+interface CommonOps<V> {
+  $eq?: V;
+  $ne?: V;
+  $exists?: boolean;
+  $type?: "S" | "SS" | "N" | "NS" | "B" | "BS" | "BOOL" | "NULL" | "L" | "M";
+  $in?: V[];
+  $nin?: V[];
+}
+/** Size operator — accepts a number or a comparator on number */
+interface SizeOps {
+  $size?: number | ComparatorOps<number>;
+}
+/** Path reference for cross-attribute comparisons */
+interface PathRef {
+  $path: string;
+}
+/**
+ * Map a field's value type to the set of valid operators.
+ * Uses `[V] extends [X]` (wrapped) to prevent distribution over unions.
+ */
+type FieldOps<V> = [V] extends [string] ? CommonOps<V | PathRef> & ComparatorOps<V | PathRef> & StringOps & SizeOps : [V] extends [number] ? CommonOps<V | PathRef> & ComparatorOps<V | PathRef> & NumberOps & SizeOps : [V] extends [boolean] ? CommonOps<V | PathRef> : [V] extends [any[]] ? CommonOps<V | PathRef> & {
+  $includes?: V[number];
+} & SizeOps : CommonOps<V | PathRef> & SizeOps;
+/**
+ * A single field condition: either a direct value (shorthand for $eq)
+ * or an operator object.
+ */
+type FieldCondition<T> = { [K in AllKeys<T>]?: ValueOfUnion<T, K> | FieldOps<ValueOfUnion<T, K>> };
+/**
+ * Full condition expression with compound operators.
+ */
+type Condition<T> = FieldCondition<T> & {
+  $and?: Condition<T>[];
+  $or?: Condition<T>[];
+  $not?: Condition<T>;
+};
+/** Key condition expression — only KeyConditionExpression-valid operators, no compound operators. */
+type KeyCondition<T> = { [K in AllKeys<T>]?: ValueOfUnion<T, K> | SortKeyOps<ValueOfUnion<T, K>> };
+interface Gsi<T> {
+  readonly partitionKey: ValidGsiKeys<T> | readonly ValidGsiKeys<T>[];
+  readonly sortKey?: ValidGsiKeys<T> | readonly ValidGsiKeys<T>[];
+  readonly projection?: "ALL" | "KEYS_ONLY" | readonly AllKeys<T>[];
+}
+interface TableDef<T = any> {
+  readonly name: string;
+  readonly partitionKey: ValidPrimaryKeys<T>;
+  readonly sortKey?: ValidPrimaryKeys<T>;
+  readonly gsis?: Readonly<Record<string, Gsi<T>>>;
+  readonly ttlAttribute?: ValidTtlKeys<T>;
+  readonly billingMode?: "PAY_PER_REQUEST" | "PROVISIONED";
+  readonly stream?: "KEYS_ONLY" | "NEW_IMAGE" | "OLD_IMAGE" | "NEW_AND_OLD_IMAGES";
+}
+interface TableKey {
+  name: string;
+  type: "S" | "N";
+}
+interface TableGsi {
+  indexName: string;
+  projectionType: "KEYS_ONLY" | "ALL" | "INCLUDE";
+  partitionKey: TableKey;
+  sortKey?: TableKey;
+  nonKeyAttributes?: string[];
+}
+interface TableDesc {
+  tableName: string;
+  billingMode: "PAY_PER_REQUEST" | "PROVISIONED";
+  partitionKey: TableKey;
+  sortKey?: TableKey;
+  ttlAttribute?: string;
+  gsis?: TableGsi[];
+  stream?: "KEYS_ONLY" | "NEW_IMAGE" | "OLD_IMAGE" | "NEW_AND_OLD_IMAGES";
+}
+type ResolvedAttrType = ("S" | "N" | undefined)[];
+//#endregion
+//#region src/table.d.ts
+type SchemaStatic<Schema extends TSchema> = unknown extends Static<Schema> ? any : Static<Schema>;
+declare class Table<Schema extends TSchema = TSchema, const Def extends TableDef<SchemaStatic<Schema>> = TableDef<SchemaStatic<Schema>>> {
+  readonly schema: Schema;
+  readonly def: Def;
+  constructor(schema: Schema, def: Def);
+}
+//#endregion
+export { ValidGsiKeys as C, ToUnion as S, ValidTtlKeys as T, SortKeyQuery as _, ExtractKey as a, TableGsi as b, ExtractTableSchema as c, KeyCondition as d, Obj as f, SortKeyOps as g, ResolvedAttrType as h, DistPartialSome as i, Func as l, PickTypeOf as m, AllKeys as n, ExtractKeys as o, PartialSome as p, Condition as r, ExtractTableDef as s, Table as t, Gsi as u, TableDef as v, ValidPrimaryKeys as w, TableKey as x, TableDesc as y };
+//# sourceMappingURL=table-DBPBsigX.d.cts.map

package/dist/table-DBPBsigX.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"table-DBPBsigX.d.cts","names":[],"sources":["../src/types.ts","../src/table.ts"],"mappings":";;;KAGY,GAAA,YAAe,MAAA,SAAe,CAAA;AAAA,KAM9B,OAAA,MAAa,OAAA,CAAQ,CAAA,qBAAsB,CAAA;AAAA,KAE3C,WAAA,0CAAqD,IAAA,CAAK,CAAA,EAAG,CAAA,IACvE,OAAA,CAAQ,IAAA,CAAK,CAAA,EAAG,OAAA,CAAQ,CAAA,QAAS,CAAA;AAAA,KAEvB,eAAA,0CAAyD,CAAA,mBACjE,WAAA,CAAY,CAAA,EAAG,CAAA;AAAA,KAGP,eAAA,MAAqB,CAAA,SAAU,KAAA,mBAAwB,GAAA;AAAA,KACvD,kBAAA,MACV,CAAA,SAAU,KAAA,sCACU,MAAA,CAAO,MAAA,UAErB,MAAA,CAAO,MAAA;AAAA,KAGH,UAAA,SAAmB,CAAA;EAAY,YAAA;EAAwB,OAAA;AAAA,IAC/D,EAAA,eAAiB,CAAA,GACf,EAAA,eAAiB,CAAA,GACf,IAAA,CAAK,CAAA,EAAG,EAAA,GAAK,EAAA,IACb,IAAA,CAAK,CAAA,EAAG,EAAA;AAAA,KAIJ,IAAA,OAAW,IAAA;AAAA,KAIX,WAAA,iBACJ,OAAA,CAAQ,CAAA,IAAK,UAAA,CAAW,CAAA,EAAG,CAAA,EAAG,CAAA;EAA6B,CAAA,EAAG,CAAA;EAAG,CAAA,EAAG,UAAA,CAAW,CAAA,EAAG,CAAA,EAAG,CAAA;AAAA,IAC3F,OAAA,CAAQ,CAAA;AAAA,KAEE,UAAA,cAAwB,OAAA,CAAQ,CAAA,QAAS,CAAA,iBAAkB,CAAA,IAAK,CAAA,KAAM,CAAA,CAAE,CAAA;AAAA,KAGxE,OAAA,MAAa,CAAA,gCAAiC,CAAA,GAAI,CAAA;;KAGlD,UAAA;EAAkB,GAAA,GAAM,CAAA;EAAG,GAAA,GAAM,CAAA;EAAG,IAAA,GAAO,CAAA;EAAG,GAAA,GAAM,CAAA;EAAG,IAAA,GAAO,CAAA;AAAA,MAAQ,CAAA;EAG5E,QAAA;EAA6B,OAAA;AAAA,KAC9B,CAAA;EACG,QAAA;AAAA;AAAA,KAGH,qBAAA,MAA2B,CAAA,GAAI,UAAA,CAAW,CAAA;AAAA,KAE1C,WAAA,4BAAuC,MAAA,YACpC,IAAA,GAAO,qBAAA,CAAsB,MAAA,CAAO,CAAA;AAAA,KAIhC,YAAA,eAA2B,EAAA,kDACN,MAAA,iCACA,MAAA,iCACA,MAAA,iCACA,MAAA,SAIzB,WAAA,CAAY,MAAA,EAAQ,CAAA,IACpB,WAAA,CAAY,MAAA,EAAQ,CAAA,GAAI,CAAA,IACxB,WAAA,CAAY,MAAA,EAAQ,CAAA,GAAI,CAAA,GAAI,CAAA,IAC5B,WAAA,CAAY,MAAA,EAAQ,CAAA,GAAI,CAAA,GAAI,CAAA,GAAI,CAAA,IACpC,EAAA,kDACmC,MAAA,iCACA,MAAA,iCACA,MAAA,SAE5B,WAAA,CAAY,MAAA,EAAQ,CAAA,IAAK,WAAA,CAAY,MAAA,EAAQ,CAAA,GAAI,CAAA,IAAK,WAAA,CAAY,MAAA,EAAQ,CAAA,GAAI,CAAA,GAAI,CAAA,IACvF,EAAA,kDACmC,MAAA,iCACA,MAAA,SAE5B,WAAA,CAAY,MAAA,EAAQ,CAAA,IAAK,WAAA,CAAY,MAAA,EAAQ,CAAA,GAAI,CAAA,IACtD,EAAA,kDAAoD,MAAA,SAC7C,WAAA,CAAY,MAAA,EAAQ,CAAA,IACzB,EAAA,wBAA0B,MAAA,WAChB,EAAA,IAAM,qBAAA,CAAsB,MAAA,CAAO,CAAA;AAAA,KAK3C,gBAAA,oBACE,CAAA,GAAI,CAAA,CAAE,CAAA,4BAA6B,CAAA,iBACzC,CAAA;AAAA,KAII,YAAA,MAAkB,WAAA,CAAY,CAAA;AAAA,KAI9B,YAAA,MAAkB,WAAA,CAAY,CAAA;;KAKrC,YAAA,wBAAoC,CAAA,mBACrC,CAAA,eAAgB,CAAA,GACd,CAAA,CAAE,CAAA;;UAKE,aAAA;EACR,GAAA,GAAM,CAAA;EACN,GAAA,GAAM,CAAA;EACN,GAAA,GAAM,CAAA;EACN,IAAA,GAAO,CAAA;EACP,GAAA,GAAM,CAAA;EACN,IAAA,GAAO,CAAA;AAAA;;UAIC,SAAA;EACR,OAAA;EACA,SAAA;EACA,QAAA;AAAA;;UAIQ,SAAA;EACR,QAAA;AAAA;;UAIQ,SAAA;EACR,GAAA,GAAM,CAAA;EACN,GAAA,GAAM,CAAA;EACN,OAAA;EACA,KAAA;EACA,GAAA,GAAM,CAAA;EACN,IAAA,GAAO,CAAA;AAAA;;UAIC,OAAA;EACR,KAAA,YAAiB,aAAA;AAAA;;UAIT,OAAA;EACR,KAAA;AAAA;;;AAhIF;;KAuIK,QAAA,OAAe,CAAA,qBAChB,SAAA,CAAU,CAAA,GAAI,OAAA,IAAW,aAAA,CAAc,CAAA,GAAI,OAAA,IAAW,SAAA,GAAY,OAAA,IACjE,CAAA,qBACC,SAAA,CAAU,CAAA,GAAI,OAAA,IAAW,aAAA,CAAc,CAAA,GAAI,OAAA,IAAW,SAAA,GAAY,OAAA,IACjE,CAAA,sBACC,SAAA,CAAU,CAAA,GAAI,OAAA,KACb,CAAA,oBACC,SAAA,CAAU,CAAA,GAAI,OAAA;EAAa,SAAA,GAAY,CAAA;AAAA,IAAc,OAAA,GACrD,SAAA,CAAU,CAAA,GAAI,OAAA,IAAW,OAAA;;;;;KAM9B,cAAA,cACG,OAAA,CAAQ,CAAA,KAAM,YAAA,CAAa,CAAA,EAAG,CAAA,IAAK,QAAA,CAAS,YAAA,CAAa,CAAA,EAAG,CAAA;;;;KAMxD,SAAA,MAAe,cAAA,CAAe,CAAA;EACxC,IAAA,GAAO,SAAA,CAAU,CAAA;EACjB,GAAA,GAAM,SAAA,CAAU,CAAA;EAChB,IAAA,GAAO,SAAA,CAAU,CAAA;AAAA;;KAIP,YAAA,cACJ,OAAA,CAAQ,CAAA,KAAM,YAAA,CAAa,CAAA,EAAG,CAAA,IAAK,UAAA,CAAW,YAAA,CAAa,CAAA,EAAG,CAAA;AAAA,UAOrD,GAAA;EAAA,SACN,YAAA,EAAc,YAAA,CAAa,CAAA,aAAc,YAAA,CAAa,CAAA;EAAA,SACtD,OAAA,GAAU,YAAA,CAAa,CAAA,aAAc,YAAA,CAAa,CAAA;EAAA,SAClD,UAAA,kCAA4C,OAAA,CAAQ,CAAA;AAAA;AAAA,UAG9C,QAAA;EAAA,SACN,IAAA;EAAA,SACA,YAAA,EAAc,gBAAA,CAAiB,CAAA;EAAA,SAC/B,OAAA,GAAU,gBAAA,CAAiB,CAAA;EAAA,SAC3B,IAAA,GAAO,QAAA,CAAS,MAAA,SAAe,GAAA,CAAI,CAAA;EAAA,SACnC,YAAA,GAAe,YAAA,CAAa,CAAA;EAAA,SAC5B,WAAA;EAAA,SACA,MAAA;AAAA;AAAA,UAGM,QAAA;EACf,IAAA;EACA,IAAA;AAAA;AAAA,UAGe,QAAA;EACf,SAAA;EACA,cAAA;EACA,YAAA,EAAc,QAAA;EACd,OAAA,GAAU,QAAA;EACV,gBAAA;AAAA;AAAA,UAGe,SAAA;EACf,SAAA;EACA,WAAA;EACA,YAAA,EAAc,QAAA;EACd,OAAA,GAAU,QAAA;EACV,YAAA;EACA,IAAA,GAAO,QAAA;EACP,MAAA;AAAA;AAAA,KAGU,gBAAA;;;KCzOP,YAAA,gBAA4B,OAAA,oBAA2B,MAAA,CAAO,MAAA,UAAgB,MAAA,CAAO,MAAA;AAAA,cAE7E,KAAA,gBACI,OAAA,GAAU,OAAA,oBACP,QAAA,CAAS,YAAA,CAAa,MAAA,KAAW,QAAA,CAAS,YAAA,CAAa,MAAA;EAAA,SAEhE,MAAA,EAAQ,MAAA;EAAA,SACR,GAAA,EAAK,GAAA;EAEd,WAAA,CAAY,MAAA,EAAQ,MAAA,EAAQ,GAAA,EAAK,GAAA;AAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dinah",
-  "version": "0.5.0",
+  "version": "0.7.0",
   "description": "A dynamodb client designed for typescript",
   "homepage": "https://github.com/jayalfredprufrock/dinah#readme",
   "bugs": {