@aws-amplify/data-schema 1.2.9 → 1.3.0

package/dist/esm/runtime/internals/generateCustomOperationsProperty.d.ts

@@ -1,8 +1,15 @@
-import { CustomMutations, CustomQueries } from '../client';
+import { CustomMutations, CustomQueries, CustomSubscriptions } from '../client';
 import { BaseClient, ClientInternalsGetter, GraphQLProviderConfig } from '../bridge-types';
 type OpTypes = 'queries' | 'mutations' | 'subscriptions';
-export declare function generateCustomOperationsProperty<T extends Record<any, any>, OpType extends OpTypes>(client: BaseClient, config: GraphQLProviderConfig['GraphQL'], operationsType: OpType, getInternals: ClientInternalsGetter): OpType extends 'queries' ? CustomQueries<T> : CustomMutations<T>;
-export declare function generateCustomMutationsProperty<T extends Record<any, any>>(client: BaseClient, config: GraphQLProviderConfig['GraphQL'], getInternals: ClientInternalsGetter): CustomMutations<T>;
-export declare function generateCustomQueriesProperty<T extends Record<any, any>>(client: BaseClient, config: GraphQLProviderConfig['GraphQL'], getInternals: ClientInternalsGetter): CustomQueries<T>;
-export declare function generateCustomSubscriptionsProperty<T extends Record<any, any>>(client: BaseClient, config: GraphQLProviderConfig['GraphQL'], getInternals: ClientInternalsGetter): CustomMutations<T>;
+type CustomOpsProperty<T extends Record<any, any>, OpType extends OpTypes> = OpType extends 'queries' ? CustomQueries<T> : OpType extends 'mutations' ? CustomMutations<T> : OpType extends 'subscriptions' ? CustomSubscriptions<T> : never;
+export declare function generateCustomOperationsProperty<T extends Record<any, any>, OpType extends OpTypes>(client: BaseClient, config: GraphQLProviderConfig['GraphQL'], operationsType: OpType, getInternals: ClientInternalsGetter): CustomOpsProperty<T, OpType>;
+export declare function generateCustomMutationsProperty<T extends Record<any, any>>(client: BaseClient, config: GraphQLProviderConfig['GraphQL'], getInternals: ClientInternalsGetter): import("../client").CustomOperations<import("../../util").Select<T, {
+    __entityType: "customMutation";
+}>, "CLIENT">;
+export declare function generateCustomQueriesProperty<T extends Record<any, any>>(client: BaseClient, config: GraphQLProviderConfig['GraphQL'], getInternals: ClientInternalsGetter): import("../client").CustomOperations<import("../../util").Select<T, {
+    __entityType: "customQuery";
+}>, "CLIENT">;
+export declare function generateCustomSubscriptionsProperty<T extends Record<any, any>>(client: BaseClient, config: GraphQLProviderConfig['GraphQL'], getInternals: ClientInternalsGetter): import("../client").CustomOperations<import("../../util").Select<T, {
+    __entityType: "customSubscription";
+}>, "CLIENT">;
 export {};

package/dist/esm/util/Filters.d.ts

@@ -0,0 +1,94 @@
+/**
+ * Not actually sure if/how customer can pass this through as variables yet.
+ * Leaving it out for now:
+ *
+ * attributeType: "binary" | "binarySet" | "bool" | "list" | "map" | "number" | "numberSet" | "string" | "stringSet" | "_null"
+ */
+/**
+ * Filters options that can be used on string-like fields.
+ */
+export type StringFilter<T extends string = string> = {
+    attributeExists?: boolean;
+    beginsWith?: string;
+    between?: [string, string];
+    contains?: string;
+    eq?: T;
+    ge?: string;
+    gt?: string;
+    le?: string;
+    lt?: string;
+    ne?: T;
+    notContains?: string;
+    size?: SizeFilter;
+};
+export type NumericFilter = {
+    attributeExists?: boolean;
+    between?: [number, number];
+    eq?: number;
+    ge?: number;
+    gt?: number;
+    le?: number;
+    lt?: number;
+    ne?: number;
+};
+/**
+ * Filter options that can be used on fields where size checks are supported.
+ */
+export type SizeFilter = {
+    between?: [number, number];
+    eq?: number;
+    ge?: number;
+    gt?: number;
+    le?: number;
+    lt?: number;
+    ne?: number;
+};
+export type BooleanFilters = {
+    attributeExists?: boolean;
+    eq?: boolean;
+    ne?: boolean;
+};
+/**
+ * A composite SK (in an identifier or secondaryIndex) resolves to this type for
+ * list queries and index queries
+ *
+ * @example
+ * Given
+ * ```ts
+ * MyModel: a
+  .model({
+    pk: a.string().required(),
+    sk1: a.string().required(),
+    sk2: a.integer().required(),
+  })
+  .identifier(['pk', 'sk1', 'sk2']),
+ * ```
+ * Expected list options:
+ * ```ts
+ * {
+ *   pk?: string
+ *   sk1Sk2?: ModelPrimaryCompositeKeyConditionInput
+ * }
+ * ```
+ * Where ModelPrimaryCompositeKeyConditionInput resolves to:
+ * ```ts
+ * {
+ *   eq: {sk1: string; sk2: number};
+ *   le: {sk1: string; sk2: number};
+ *   lt: {sk1: string; sk2: number};
+ *   ge: {sk1: string; sk2: number};
+ *   gt: {sk1: string; sk2: number};
+ *   between: [ {sk1: string; sk2: number} ];
+ *   beginsWith: {sk1: string; sk2: number};
+ * }
+ * ```
+ * */
+export type ModelPrimaryCompositeKeyInput<SkIr extends Record<string, string | number>> = {
+    eq?: SkIr;
+    le?: SkIr;
+    lt?: SkIr;
+    ge?: SkIr;
+    gt?: SkIr;
+    between?: [SkIr];
+    beginsWith?: SkIr;
+};

package/dist/esm/util/Filters.mjs

@@ -0,0 +1,2 @@
+
+//# sourceMappingURL=Filters.mjs.map

package/dist/esm/util/Filters.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"Filters.mjs","sources":[],"sourcesContent":[],"names":[],"mappings":""}

package/dist/esm/util/IndexShapes.d.ts

@@ -0,0 +1,13 @@
+export interface PrimaryIndexIrShape {
+    pk: {
+        [key: string]: string | number;
+    };
+    sk: {
+        [key: string]: string | number;
+    } | never;
+    compositeSk: never | string;
+}
+export interface SecondaryIndexIrShape extends PrimaryIndexIrShape {
+    defaultQueryFieldSuffix: string;
+    queryField: string;
+}

package/dist/esm/util/IndexShapes.mjs

@@ -0,0 +1,2 @@
+
+//# sourceMappingURL=IndexShapes.mjs.map

package/dist/esm/util/IndexShapes.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"IndexShapes.mjs","sources":[],"sourcesContent":[],"names":[],"mappings":""}

package/dist/esm/util/Select.d.ts

@@ -0,0 +1,3 @@
+export type Select<T, M> = {
+    [K in keyof T as T[K] extends M ? K : never]: T[K] extends M ? T[K] : never;
+};

package/dist/esm/util/Select.mjs

@@ -0,0 +1,2 @@
+
+//# sourceMappingURL=Select.mjs.map

package/dist/esm/util/Select.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"Select.mjs","sources":[],"sourcesContent":[],"names":[],"mappings":""}

package/dist/esm/util/index.d.ts

@@ -1,3 +1,6 @@
 export { Brand, brand, getBrand } from './Brand';
 export { IndexLimitUnion } from './IndexLimit';
 export { SpreadTuple } from './SpreadTuple';
+export { Select } from './Select';
+export type * from './Filters';
+export type * from './IndexShapes';