@aws-amplify/data-schema 0.0.0-20240412222732

package/lib-esm/src/CustomType.d.ts

@@ -0,0 +1,36 @@
+import type { Brand } from './util';
+import type { ModelField, InternalField, ModelFieldTypeParamOuter } from './ModelField';
+import type { RefType } from './RefType';
+import type { EnumType, EnumTypeParamShape } from './EnumType';
+/**
+ * Custom Types
+ *
+ * can be defined in-line to strongly type object types
+ *
+ */
+export type CustomTypeAllowedModifiers = 'authorization' | 'array' | 'required';
+type CustomTypeFields = Record<string, ModelField<ModelFieldTypeParamOuter, CustomTypeAllowedModifiers, any> | RefType<any, any, any> | EnumType<EnumTypeParamShape> | CustomType<CustomTypeParamShape>>;
+type InternalModelFields = Record<string, InternalField>;
+type CustomTypeData = {
+    fields: CustomTypeFields;
+    type: 'customType';
+};
+type InternalCustomTypeData = CustomTypeData & {
+    fields: InternalModelFields;
+};
+export type CustomTypeParamShape = {
+    fields: CustomTypeFields;
+};
+export type CustomType<T extends CustomTypeParamShape> = T & Brand<'customType'>;
+/**
+ * Internal representation of CustomType that exposes the `data` property.
+ * Used at buildtime.
+ */
+export type InternalCustomType = CustomType<any> & {
+    data: InternalCustomTypeData;
+};
+export declare function customType<T extends CustomTypeFields>(fields: T): CustomType<{
+    fields: T;
+}>;
+export {};
+//# sourceMappingURL=CustomType.d.ts.map

package/lib-esm/src/CustomType.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"CustomType.d.ts","sourceRoot":"","sources":["../../src/CustomType.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,QAAQ,CAAC;AACpC,OAAO,KAAK,EACV,UAAU,EACV,aAAa,EACb,wBAAwB,EACzB,MAAM,cAAc,CAAC;AACtB,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACzC,OAAO,KAAK,EAAE,QAAQ,EAAE,kBAAkB,EAAE,MAAM,YAAY,CAAC;AAE/D;;;;;GAKG;AAGH,MAAM,MAAM,0BAA0B,GAAG,eAAe,GAAG,OAAO,GAAG,UAAU,CAAC;AAEhF,KAAK,gBAAgB,GAAG,MAAM,CAC5B,MAAM,EACJ,UAAU,CAAC,wBAAwB,EAAE,0BAA0B,EAAE,GAAG,CAAC,GACrE,OAAO,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,GACtB,QAAQ,CAAC,kBAAkB,CAAC,GAC5B,UAAU,CAAC,oBAAoB,CAAC,CACnC,CAAC;AAEF,KAAK,mBAAmB,GAAG,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;AAEzD,KAAK,cAAc,GAAG;IACpB,MAAM,EAAE,gBAAgB,CAAC;IACzB,IAAI,EAAE,YAAY,CAAC;CACpB,CAAC;AAEF,KAAK,sBAAsB,GAAG,cAAc,GAAG;IAC7C,MAAM,EAAE,mBAAmB,CAAC;CAC7B,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG;IACjC,MAAM,EAAE,gBAAgB,CAAC;CAC1B,CAAC;AAEF,MAAM,MAAM,UAAU,CAAC,CAAC,SAAS,oBAAoB,IAAI,CAAC,GACxD,KAAK,CAAC,YAAY,CAAC,CAAC;AAEtB;;;GAGG;AACH,MAAM,MAAM,kBAAkB,GAAG,UAAU,CAAC,GAAG,CAAC,GAAG;IACjD,IAAI,EAAE,sBAAsB,CAAC;CAC9B,CAAC;AAWF,wBAAgB,UAAU,CAAC,CAAC,SAAS,gBAAgB,EACnD,MAAM,EAAE,CAAC,GACR,UAAU,CAAC;IAAE,MAAM,EAAE,CAAC,CAAA;CAAE,CAAC,CAE3B"}

package/lib-esm/src/CustomType.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.customType = void 0;
+function _customType(fields) {
+    const data = {
+        fields,
+        type: 'customType',
+    };
+    return { data };
+}
+function customType(fields) {
+    return _customType(fields);
+}
+exports.customType = customType;

package/lib-esm/src/EnumType.d.ts

@@ -0,0 +1,16 @@
+import { Brand } from './util';
+export type EnumTypeParamShape = {
+    type: 'enum';
+    values: readonly string[];
+};
+export type EnumType<T extends EnumTypeParamShape> = T & Brand<'enum'>;
+type EnumTypeArgFactory<Values extends readonly string[]> = {
+    type: 'enum';
+    values: Values;
+};
+/**
+ * this type param pattern allows us to infer literal type values from the array without using the `as const` suffix
+ */
+export declare function enumType<Value extends string, T extends readonly Value[]>(values: T): EnumType<EnumTypeArgFactory<T>>;
+export {};
+//# sourceMappingURL=EnumType.d.ts.map

package/lib-esm/src/EnumType.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"EnumType.d.ts","sourceRoot":"","sources":["../../src/EnumType.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,QAAQ,CAAC;AAO/B,MAAM,MAAM,kBAAkB,GAAG;IAC/B,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,SAAS,MAAM,EAAE,CAAC;CAC3B,CAAC;AAEF,MAAM,MAAM,QAAQ,CAAC,CAAC,SAAS,kBAAkB,IAAI,CAAC,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC;AAWvE,KAAK,kBAAkB,CAAC,MAAM,SAAS,SAAS,MAAM,EAAE,IAAI;IAC1D,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF;;GAEG;AACH,wBAAgB,QAAQ,CAAC,KAAK,SAAS,MAAM,EAAE,CAAC,SAAS,SAAS,KAAK,EAAE,EACvE,MAAM,EAAE,CAAC,mCAGV"}

package/lib-esm/src/EnumType.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.enumType = void 0;
+function _enum(values) {
+    const data = {
+        type: 'enum',
+        values,
+    };
+    return data;
+}
+/**
+ * this type param pattern allows us to infer literal type values from the array without using the `as const` suffix
+ */
+function enumType(values) {
+    return _enum(values);
+}
+exports.enumType = enumType;

package/lib-esm/src/Handler.d.ts

@@ -0,0 +1,58 @@
+import type { DefineFunction } from '@aws-amplify/data-schema-types';
+import { Brand } from './util';
+import { RefType } from './RefType';
+export type HandlerType = InlineSqlHandler | SqlReferenceHandler | CustomHandler | FunctionHandler;
+declare const dataSymbol: unique symbol;
+type AllHandlers = InlineSqlHandler | SqlReferenceHandler | CustomHandler | FunctionHandler;
+export declare function getHandlerData<H extends AllHandlers>(handler: H): H[typeof dataSymbol];
+declare const inlineSqlBrand = "inlineSql";
+export type InlineSqlHandler = {
+    [dataSymbol]: string;
+} & Brand<typeof inlineSqlBrand>;
+declare function inlineSql(sql: string): InlineSqlHandler;
+declare const sqlReferenceBrand = "sqlReference";
+export type SqlReferenceHandlerData = {
+    entry: string;
+    stack: string | undefined;
+};
+export type SqlReferenceHandler = {
+    [dataSymbol]: SqlReferenceHandlerData;
+} & Brand<typeof sqlReferenceBrand>;
+declare function sqlReference(sqlFilePath: string): SqlReferenceHandler;
+type CustomHandlerInput = {
+    /**
+     * The data source used by the function.
+     * Can reference a model in the schema with a.ref('ModelName') or any string data source name configured in your API
+     *
+     * Defaults to 'NONE_DS'
+     *
+     */
+    dataSource?: string | RefType<any>;
+    /**
+     * The path to the file that contains the function entry point.
+     * If this is a relative path, it is computed relative to the file where this handler is defined
+     */
+    entry: string;
+};
+export type CustomHandlerData = CustomHandlerInput & {
+    stack: string | undefined;
+};
+declare const customHandlerBrand = "customHandler";
+export type CustomHandler = {
+    [dataSymbol]: CustomHandlerData;
+} & Brand<typeof customHandlerBrand>;
+declare function custom(customHandler: CustomHandlerInput): CustomHandler;
+export type FunctionHandlerData = DefineFunction | string;
+declare const functionHandlerBrand = "functionHandler";
+export type FunctionHandler = {
+    [dataSymbol]: FunctionHandlerData;
+} & Brand<typeof functionHandlerBrand>;
+declare function fcn(fn: FunctionHandlerData): FunctionHandler;
+export declare const handler: {
+    inlineSql: typeof inlineSql;
+    sqlReference: typeof sqlReference;
+    custom: typeof custom;
+    function: typeof fcn;
+};
+export {};
+//# sourceMappingURL=Handler.d.ts.map

package/lib-esm/src/Handler.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Handler.d.ts","sourceRoot":"","sources":["../../src/Handler.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,gCAAgC,CAAC;AACrE,OAAO,EAAE,KAAK,EAAS,MAAM,QAAQ,CAAC;AACtC,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAEpC,MAAM,MAAM,WAAW,GACnB,gBAAgB,GAChB,mBAAmB,GACnB,aAAa,GACb,eAAe,CAAC;AAEpB,QAAA,MAAM,UAAU,eAAiB,CAAC;AAMlC,KAAK,WAAW,GACZ,gBAAgB,GAChB,mBAAmB,GACnB,aAAa,GACb,eAAe,CAAC;AAEpB,wBAAgB,cAAc,CAAC,CAAC,SAAS,WAAW,EAClD,OAAO,EAAE,CAAC,GACT,CAAC,CAAC,OAAO,UAAU,CAAC,CAEtB;AAID,QAAA,MAAM,cAAc,cAAc,CAAC;AAEnC,MAAM,MAAM,gBAAgB,GAAG;IAAE,CAAC,UAAU,CAAC,EAAE,MAAM,CAAA;CAAE,GAAG,KAAK,CAC7D,OAAO,cAAc,CACtB,CAAC;AAEF,iBAAS,SAAS,CAAC,GAAG,EAAE,MAAM,GAAG,gBAAgB,CAEhD;AAMD,QAAA,MAAM,iBAAiB,iBAAiB,CAAC;AAEzC,MAAM,MAAM,uBAAuB,GAAG;IACpC,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,GAAG,SAAS,CAAC;CAC3B,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG;IAChC,CAAC,UAAU,CAAC,EAAE,uBAAuB,CAAC;CACvC,GAAG,KAAK,CAAC,OAAO,iBAAiB,CAAC,CAAC;AAEpC,iBAAS,YAAY,CAAC,WAAW,EAAE,MAAM,GAAG,mBAAmB,CAO9D;AAMD,KAAK,kBAAkB,GAAG;IACxB;;;;;;OAMG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;IACnC;;;OAGG;IACH,KAAK,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,MAAM,MAAM,iBAAiB,GAAG,kBAAkB,GAAG;IACnD,KAAK,EAAE,MAAM,GAAG,SAAS,CAAC;CAC3B,CAAC;AAEF,QAAA,MAAM,kBAAkB,kBAAkB,CAAC;AAE3C,MAAM,MAAM,aAAa,GAAG;IAAE,CAAC,UAAU,CAAC,EAAE,iBAAiB,CAAA;CAAE,GAAG,KAAK,CACrE,OAAO,kBAAkB,CAC1B,CAAC;AAEF,iBAAS,MAAM,CAAC,aAAa,EAAE,kBAAkB,GAAG,aAAa,CAOhE;AAMD,MAAM,MAAM,mBAAmB,GAAG,cAAc,GAAG,MAAM,CAAC;AAE1D,QAAA,MAAM,oBAAoB,oBAAoB,CAAC;AAE/C,MAAM,MAAM,eAAe,GAAG;IAC5B,CAAC,UAAU,CAAC,EAAE,mBAAmB,CAAC;CACnC,GAAG,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAC;AAEvC,iBAAS,GAAG,CAAC,EAAE,EAAE,mBAAmB,GAAG,eAAe,CAErD;AAID,eAAO,MAAM,OAAO;;;;;CAKnB,CAAC"}

package/lib-esm/src/Handler.js

@@ -0,0 +1,48 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.handler = exports.getHandlerData = void 0;
+const util_1 = require("./util");
+const dataSymbol = Symbol('Data');
+function buildHandler(brandName) {
+    return (0, util_1.brand)(brandName);
+}
+function getHandlerData(handler) {
+    return handler[dataSymbol];
+}
+exports.getHandlerData = getHandlerData;
+//#region handler.inlineSql
+const inlineSqlBrand = 'inlineSql';
+function inlineSql(sql) {
+    return { [dataSymbol]: sql, ...buildHandler(inlineSqlBrand) };
+}
+//#endregion
+//#region handler.sqlReference
+const sqlReferenceBrand = 'sqlReference';
+function sqlReference(sqlFilePath) {
+    // used to determine caller directory in order to resolve relative path downstream
+    const stack = new Error().stack;
+    return {
+        [dataSymbol]: { stack, entry: sqlFilePath },
+        ...buildHandler(sqlReferenceBrand),
+    };
+}
+const customHandlerBrand = 'customHandler';
+function custom(customHandler) {
+    // used to determine caller directory in order to resolve relative path downstream
+    const stack = new Error().stack;
+    return {
+        [dataSymbol]: { ...customHandler, stack },
+        ...buildHandler(customHandlerBrand),
+    };
+}
+const functionHandlerBrand = 'functionHandler';
+function fcn(fn) {
+    return { [dataSymbol]: fn, ...buildHandler(functionHandlerBrand) };
+}
+//#endregion
+exports.handler = {
+    inlineSql,
+    sqlReference,
+    custom,
+    function: fcn,
+};

package/lib-esm/src/MappedTypes/CustomOperations.d.ts

@@ -0,0 +1,127 @@
+import type { GenericModelSchema } from '../ModelSchema';
+import type { NonModelTypesShape } from './ExtractNonModelTypes';
+import type { CustomOperation, CustomOperationParamShape } from '../CustomOperation';
+import type { ModelField } from '../ModelField';
+import type { RefType, RefTypeParamShape } from '../RefType';
+import type { ResolveCustomTypeFieldsRequirements, ResolveRefsOfCustomType, ResolveRefValueArrayTraits } from './ResolveFieldProperties';
+import type { AppSyncResolverHandler } from 'aws-lambda';
+import type { CustomType } from '../CustomType';
+import type { FieldTypesOfCustomType } from './ResolveSchema';
+/**
+ * Creates meta types for custom operations from a schema.
+ */
+export type ResolveCustomOperations<Schema extends GenericModelSchema<any>, FullyResolvedSchema extends Record<string, unknown>, NonModelTypes extends NonModelTypesShape, CustomOperations extends Record<string, CustomOperationParamShape> = CustomOpShapes<Schema>> = {
+    customOperations: {
+        [OpName in keyof CustomOperations]: {
+            arguments: CustomOpArguments<CustomOperations[OpName]>;
+            returnType: CustomOpReturnType<CustomOperations[OpName], FullyResolvedSchema, NonModelTypes, CustomOperations>;
+            functionRef: CustomOperations[OpName]['functionRef'];
+            typeName: CustomOperations[OpName]['typeName'];
+            authorization: CustomOperations[OpName]['authorization'];
+        };
+    };
+};
+/**
+ * Filtered, mapped list of custom operations shapes from a schema.
+ */
+export type CustomOpShapes<Schema extends GenericModelSchema<any>> = {
+    [K in keyof Schema['data']['types'] as Schema['data']['types'][K] extends CustomOperation<any, any> ? K : never]: Schema['data']['types'][K] extends CustomOperation<infer Shape, any> ? Shape : never;
+};
+/**
+ * Digs out custom operation arguments, mapped to the intended graphql types.
+ */
+export type CustomOpArguments<Shape extends CustomOperationParamShape> = Shape['arguments'] extends null ? never : {
+    [FieldName in keyof Shape['arguments']]: Shape['arguments'][FieldName] extends ModelField<infer R, any, any> ? R : never;
+};
+/**
+ * Computes the return type from the `returnType` of a custom operation shape.
+ *
+ * This entails dereferencing refs and inferring graphql types from field-type defs.
+ */
+export type CustomOpReturnType<Shape extends CustomOperationParamShape, FullyResolvedSchema extends Record<string, unknown>, NonModelTypes extends NonModelTypesShape, CustomOperations extends Record<string, CustomOperationParamShape>> = Shape['returnType'] extends RefType<infer RefShape, any, any> ? RefShape['link'] extends keyof CustomOperations ? CustomOpReturnType<CustomOperations[RefShape['link']], FullyResolvedSchema, NonModelTypes, CustomOperations> : ResolveRef<RefShape, FullyResolvedSchema, NonModelTypes, CustomOperations> : Shape['returnType'] extends ModelField<infer R, any, any> ? R : Shape['returnType'] extends CustomType<infer R> ? ResolveCustomTypeFieldsRequirements<FieldTypesOfCustomType<{
+    thisCustomType: R['fields'];
+}>['thisCustomType']> | null : never;
+/**
+ * `a.ref()` resolution specific to custom operations, for which `a.ref()`
+ * can refer to a model, custom type, or enum.
+ *
+ * This utility is a duplication of ResolveRef (src/MappedTypes/ResolveFieldProperties.ts)
+ * with the addition that allows .ref() a model with custom operations.
+ */
+export type ResolveRef<Shape extends RefTypeParamShape, FullyResolvedSchema extends Record<string, unknown>, NonModelTypes extends NonModelTypesShape, CustomOperations extends Record<string, CustomOperationParamShape>, Link = Shape['link'], RefValue = Link extends keyof FullyResolvedSchema ? FullyResolvedSchema[Link] : Link extends keyof NonModelTypes['enums'] ? NonModelTypes['enums'][Link] : Link extends keyof NonModelTypes['customTypes'] ? ResolveRefsOfCustomType<NonModelTypes, NonModelTypes['customTypes'][Link]> : Link extends keyof CustomOperations ? CustomOpReturnType<CustomOperations[Link], FullyResolvedSchema, NonModelTypes, CustomOperations> : never, Value = Shape['valueRequired'] extends true ? RefValue : RefValue | null> = ResolveRefValueArrayTraits<Shape, Value>;
+/**
+ * The kind of shape we need to map to custom handler (e.g., lambda) function
+ * signatures.
+ */
+type CustomOperationsMap = Record<string, CustomOperationMinimalDef>;
+/**
+ * The minimal amount of structure needed to extract types for a custom handler.
+ */
+type CustomOperationMinimalDef = {
+    arguments: any;
+    returnType: any;
+};
+/**
+ * Derives the signature and types for a lambda handler for a particular
+ * custom Query or Mutation from a Schema.
+ */
+type IndividualCustomHandlerTypes<Op extends CustomOperationMinimalDef> = {
+    /**
+     * Handler type for lambda function implementations. E.g.,
+     *
+     * ```typescript
+     * import type { Schema } from './resource';
+     *
+     * export const handler: Schema['echo']['functionHandler'] = async (event, context) => {
+     *  // event and context will be fully typed inside here.
+     * }
+     * ```
+     */
+    functionHandler: AppSyncResolverHandler<Op['arguments'], LambdaReturnType<Op['returnType']>>;
+    /**
+     * The `context.arguments` type for lambda function implementations.
+     *
+     * ```typescript
+     * import type { Schema } from './resource';
+     *
+     * export const handler: Schema['echo']['functionHandler'] = async (event, context) => {
+     *  // Provides this type, if needed:
+     *  const args: Schema['echo']['functionHandlerArguments'] = event.arguments;
+     * }
+     * ```
+     */
+    functionHandlerArguments: Op['arguments'];
+    /**
+     * The return type expected by a lambda function handler.
+     *
+     * ```typescript
+     * import type { Schema } from './resource';
+     *
+     * export const handler: Schema['echo']['functionHandler'] = async (event, context) => {
+     *  // Result type enforced here:
+     *  const result: Schema['echo']['functionHandlerResult'] = buildResult(...);
+     *
+     *  // `Result` type matches expected function return type here:
+     *  return result;
+     * }
+     * ```
+     */
+    functionHandlerResult: LambdaReturnType<Op['returnType']>;
+};
+/**
+ * Derives the function signatures for a lambda handlers for all the provided
+ * custom queries and mutations.
+ */
+export type CustomOperationHandlerTypes<CustomOperations extends CustomOperationsMap> = {
+    [K in keyof CustomOperations]: IndividualCustomHandlerTypes<CustomOperations[K]>;
+};
+/**
+ * Returns a return type with lazy loaders removed.
+ *
+ * (Custom handlers should not return lazy loaded fields -- they're *lazy loaded*.)
+ */
+type LambdaReturnType<T> = T extends Record<string, any> ? {
+    [K in keyof Exclude<T, null | undefined> as Exclude<T, null | undefined>[K] extends (...args: any) => any ? never : K]: Exclude<T, null | undefined>[K];
+} : T | (null extends T ? null : never) | (undefined extends T ? undefined : never);
+export {};
+//# sourceMappingURL=CustomOperations.d.ts.map

package/lib-esm/src/MappedTypes/CustomOperations.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"CustomOperations.d.ts","sourceRoot":"","sources":["../../../src/MappedTypes/CustomOperations.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,gBAAgB,CAAC;AACzD,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,wBAAwB,CAAC;AACjE,OAAO,KAAK,EACV,eAAe,EACf,yBAAyB,EAC1B,MAAM,oBAAoB,CAAC;AAC5B,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAChD,OAAO,KAAK,EAAE,OAAO,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAC;AAC7D,OAAO,KAAK,EACV,mCAAmC,EACnC,uBAAuB,EACvB,0BAA0B,EAC3B,MAAM,0BAA0B,CAAC;AAClC,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,YAAY,CAAC;AACzD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAChD,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,iBAAiB,CAAC;AAE9D;;GAEG;AACH,MAAM,MAAM,uBAAuB,CACjC,MAAM,SAAS,kBAAkB,CAAC,GAAG,CAAC,EACtC,mBAAmB,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EACnD,aAAa,SAAS,kBAAkB,EACxC,gBAAgB,SAAS,MAAM,CAC7B,MAAM,EACN,yBAAyB,CAC1B,GAAG,cAAc,CAAC,MAAM,CAAC,IACxB;IACF,gBAAgB,EAAE;SACf,MAAM,IAAI,MAAM,gBAAgB,GAAG;YAClC,SAAS,EAAE,iBAAiB,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAC,CAAC;YACvD,UAAU,EAAE,kBAAkB,CAC5B,gBAAgB,CAAC,MAAM,CAAC,EACxB,mBAAmB,EACnB,aAAa,EACb,gBAAgB,CACjB,CAAC;YACF,WAAW,EAAE,gBAAgB,CAAC,MAAM,CAAC,CAAC,aAAa,CAAC,CAAC;YACrD,QAAQ,EAAE,gBAAgB,CAAC,MAAM,CAAC,CAAC,UAAU,CAAC,CAAC;YAC/C,aAAa,EAAE,gBAAgB,CAAC,MAAM,CAAC,CAAC,eAAe,CAAC,CAAC;SAC1D;KACF,CAAC;CACH,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,cAAc,CAAC,MAAM,SAAS,kBAAkB,CAAC,GAAG,CAAC,IAAI;KAClE,CAAC,IAAI,MAAM,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,IAAI,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,SAAS,eAAe,CACvF,GAAG,EACH,GAAG,CACJ,GACG,CAAC,GACD,KAAK,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,SAAS,eAAe,CAC5D,MAAM,KAAK,EACX,GAAG,CACJ,GACG,KAAK,GACL,KAAK;CACV,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,iBAAiB,CAAC,KAAK,SAAS,yBAAyB,IACnE,KAAK,CAAC,WAAW,CAAC,SAAS,IAAI,GAC3B,KAAK,GACL;KACG,SAAS,IAAI,MAAM,KAAK,CAAC,WAAW,CAAC,GAAG,KAAK,CAAC,WAAW,CAAC,CAAC,SAAS,CAAC,SAAS,UAAU,CACvF,MAAM,CAAC,EACP,GAAG,EACH,GAAG,CACJ,GACG,CAAC,GACD,KAAK;CACV,CAAC;AAER;;;;GAIG;AACH,MAAM,MAAM,kBAAkB,CAC5B,KAAK,SAAS,yBAAyB,EACvC,mBAAmB,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EACnD,aAAa,SAAS,kBAAkB,EACxC,gBAAgB,SAAS,MAAM,CAAC,MAAM,EAAE,yBAAyB,CAAC,IAElE,KAAK,CAAC,YAAY,CAAC,SAAS,OAAO,CAAC,MAAM,QAAQ,EAAE,GAAG,EAAE,GAAG,CAAC,GACzD,QAAQ,CAAC,MAAM,CAAC,SAAS,MAAM,gBAAgB,GAE7C,kBAAkB,CAChB,gBAAgB,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,EAClC,mBAAmB,EACnB,aAAa,EACb,gBAAgB,CACjB,GACD,UAAU,CACR,QAAQ,EACR,mBAAmB,EACnB,aAAa,EACb,gBAAgB,CACjB,GACH,KAAK,CAAC,YAAY,CAAC,SAAS,UAAU,CAAC,MAAM,CAAC,EAAE,GAAG,EAAE,GAAG,CAAC,GACvD,CAAC,GACD,KAAK,CAAC,YAAY,CAAC,SAAS,UAAU,CAAC,MAAM,CAAC,CAAC,GAEzC,mCAAmC,CACjC,sBAAsB,CAAC;IACrB,cAAc,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC;CAC7B,CAAC,CAAC,gBAAgB,CAAC,CACrB,GAED,IAAI,GACR,KAAK,CAAC;AAEhB;;;;;;GAMG;AACH,MAAM,MAAM,UAAU,CACpB,KAAK,SAAS,iBAAiB,EAC/B,mBAAmB,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EACnD,aAAa,SAAS,kBAAkB,EACxC,gBAAgB,SAAS,MAAM,CAAC,MAAM,EAAE,yBAAyB,CAAC,EAClE,IAAI,GAAG,KAAK,CAAC,MAAM,CAAC,EACpB,QAAQ,GAAG,IAAI,SAAS,MAAM,mBAAmB,GAC7C,mBAAmB,CAAC,IAAI,CAAC,GACzB,IAAI,SAAS,MAAM,aAAa,CAAC,OAAO,CAAC,GACvC,aAAa,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,GAC5B,IAAI,SAAS,MAAM,aAAa,CAAC,aAAa,CAAC,GAC7C,uBAAuB,CACrB,aAAa,EACb,aAAa,CAAC,aAAa,CAAC,CAAC,IAAI,CAAC,CACnC,GACD,IAAI,SAAS,MAAM,gBAAgB,GAEjC,kBAAkB,CAChB,gBAAgB,CAAC,IAAI,CAAC,EACtB,mBAAmB,EACnB,aAAa,EACb,gBAAgB,CACjB,GACD,KAAK,EACf,KAAK,GAAG,KAAK,CAAC,eAAe,CAAC,SAAS,IAAI,GAAG,QAAQ,GAAG,QAAQ,GAAG,IAAI,IACtE,0BAA0B,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;AAM7C;;;GAGG;AACH,KAAK,mBAAmB,GAAG,MAAM,CAAC,MAAM,EAAE,yBAAyB,CAAC,CAAC;AAErE;;GAEG;AACH,KAAK,yBAAyB,GAAG;IAC/B,SAAS,EAAE,GAAG,CAAC;IACf,UAAU,EAAE,GAAG,CAAC;CACjB,CAAC;AAEF;;;GAGG;AACH,KAAK,4BAA4B,CAAC,EAAE,SAAS,yBAAyB,IAAI;IACxE;;;;;;;;;;OAUG;IACH,eAAe,EAAE,sBAAsB,CACrC,EAAE,CAAC,WAAW,CAAC,EACf,gBAAgB,CAAC,EAAE,CAAC,YAAY,CAAC,CAAC,CACnC,CAAC;IAEF;;;;;;;;;;;OAWG;IACH,wBAAwB,EAAE,EAAE,CAAC,WAAW,CAAC,CAAC;IAE1C;;;;;;;;;;;;;;OAcG;IACH,qBAAqB,EAAE,gBAAgB,CAAC,EAAE,CAAC,YAAY,CAAC,CAAC,CAAC;CAC3D,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,2BAA2B,CACrC,gBAAgB,SAAS,mBAAmB,IAC1C;KACD,CAAC,IAAI,MAAM,gBAAgB,GAAG,4BAA4B,CACzD,gBAAgB,CAAC,CAAC,CAAC,CACpB;CACF,CAAC;AAEF;;;;GAIG;AACH,KAAK,gBAAgB,CAAC,CAAC,IAAI,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GACpD;KAGG,CAAC,IAAI,MAAM,OAAO,CAAC,CAAC,EAAE,IAAI,GAAG,SAAS,CAAC,IAAI,OAAO,CACjD,CAAC,EACD,IAAI,GAAG,SAAS,CACjB,CAAC,CAAC,CAAC,SAAS,CAAC,GAAG,IAAI,EAAE,GAAG,KAAK,GAAG,GAC9B,KAAK,GACL,CAAC,GAAG,OAAO,CAAC,CAAC,EAAE,IAAI,GAAG,SAAS,CAAC,CAAC,CAAC,CAAC;CACxC,GAEG,CAAC,GAGD,CAAC,IAAI,SAAS,CAAC,GAAG,IAAI,GAAG,KAAK,CAAC,GAC/B,CAAC,SAAS,SAAS,CAAC,GAAG,SAAS,GAAG,KAAK,CAAC,CAAC"}

package/lib-esm/src/MappedTypes/CustomOperations.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib-esm/src/MappedTypes/ExtractNonModelTypes.d.ts

@@ -0,0 +1,74 @@
+import type { UnionToIntersection } from '@aws-amplify/data-schema-types';
+import type { CustomType, CustomTypeParamShape } from '../CustomType';
+import type { EnumType, EnumTypeParamShape } from '../EnumType';
+import type { SchemaTypes, ModelAndCustomTypes, FieldTypesOfCustomType } from './ResolveSchema';
+import type { ModelType, ModelTypeParamShape } from '../ModelType';
+export type NonModelTypesShape = {
+    enums: Record<string, EnumType<any>>;
+    customTypes: Record<string, any>;
+};
+export type ExtractNonModelTypes<Schema> = ResolveNonModelFields<ResolveNonModelTypes<Schema, ExtractImplicitNonModelTypes<Schema>>>;
+/**
+ * Extract all implicit non-model types a `FieldName: Field` map recursively,
+ * and store them in a flat map. The keys are serialized property path.
+ *
+ * For example, with the following schema structure:
+ * ```
+ * ExtractAndFlattenImplicitNonModelTypesFromFields<
+ *   'Post',
+ *   {
+ *     content: string,
+ *     status: enum(['reviewing'], ['published']),
+ *     meta: customType({
+ *       tag: enum(['internal', 'external']),
+ *       views: number
+ *     }),
+ *     tag: ref('SomeExplicitEnum'),
+ *   }
+ * >
+ * ```
+ * It generates the result as:
+ * ```
+ * {
+ *   PostStatus: enum(['reviewing'], ['published']),
+ *   PostMeta: customType({
+ *     tag: enum(['internal', 'external']),
+ *     views: number
+ *   }),
+ *   PostMetaTag: enum(['internal', 'external']),
+ * }
+ * ```
+ */
+export type ExtractAndFlattenImplicitNonModelTypesFromFields<ParentTypeName extends string, Fields> = {
+    [FieldProp in keyof Fields as Fields[FieldProp] extends EnumType<EnumTypeParamShape> | CustomType<CustomTypeParamShape> ? FieldProp : never]: (x: NonNullable<Fields[FieldProp]> extends infer FieldType ? FieldType extends EnumType<EnumTypeParamShape> ? {
+        [Key in `${ParentTypeName}${Capitalize<FieldProp & string>}`]: Fields[FieldProp];
+    } : FieldType extends CustomType<infer CustomTypeShape extends CustomTypeParamShape> ? // recursively extract to the Nested CustomType, and return the
+    ExtractAndFlattenImplicitNonModelTypesFromFields<`${ParentTypeName}${Capitalize<FieldProp & string>}`, CustomTypeShape['fields']> & {
+        [Key in `${ParentTypeName}${Capitalize<FieldProp & string>}`]: Fields[FieldProp];
+    } : never : never) => void;
+} extends Record<string, infer Func> ? Func extends (x: infer P) => void ? P : Record<never, never> : Record<never, never>;
+/**
+ * Pulls out implicit, i.e. field-level non-model types from `ModelType` and
+ * `CustomType` which may contain deeply nested implicit (inline) non-model
+ * types.
+ */
+export type ExtractImplicitNonModelTypes<Schema, Targets = ModelAndCustomTypes<SchemaTypes<Schema>>> = UnionToIntersection<{
+    [Model in keyof Targets]: Targets[Model] extends CustomType<infer R extends CustomTypeParamShape> ? // extract nested non-model types from it, and include itself
+    ExtractAndFlattenImplicitNonModelTypesFromFields<Capitalize<Model & string>, R['fields']> & {
+        [key in Model]: Targets[Model];
+    } : Targets[Model] extends ModelType<infer R extends ModelTypeParamShape, any> ? ExtractAndFlattenImplicitNonModelTypesFromFields<Capitalize<Model & string>, R['fields']> : Targets[Model];
+}[keyof Targets]>;
+type ResolveNonModelTypes<Schema, Extracted, ResolvedSchema = SchemaTypes<Schema> & Extracted> = {
+    enums: {
+        [Model in keyof ResolvedSchema as ResolvedSchema[Model] extends EnumType<EnumTypeParamShape> ? Model : never]: ResolvedSchema[Model] extends EnumType<infer R extends EnumTypeParamShape> ? R['values'][number] : never;
+    };
+    customTypes: {
+        [Model in keyof ResolvedSchema as ResolvedSchema[Model] extends CustomType<CustomTypeParamShape> ? Model : never]: ResolvedSchema[Model] extends CustomType<infer R extends CustomTypeParamShape> ? R['fields'] : never;
+    };
+};
+type ResolveNonModelFields<T extends NonModelTypesShape> = {
+    enums: T['enums'];
+    customTypes: FieldTypesOfCustomType<T['customTypes']>;
+};
+export {};
+//# sourceMappingURL=ExtractNonModelTypes.d.ts.map

package/lib-esm/src/MappedTypes/ExtractNonModelTypes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ExtractNonModelTypes.d.ts","sourceRoot":"","sources":["../../../src/MappedTypes/ExtractNonModelTypes.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,gCAAgC,CAAC;AAC1E,OAAO,KAAK,EAAE,UAAU,EAAE,oBAAoB,EAAE,MAAM,eAAe,CAAC;AACtE,OAAO,KAAK,EAAE,QAAQ,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAC;AAChE,OAAO,KAAK,EACV,WAAW,EACX,mBAAmB,EACnB,sBAAsB,EACvB,MAAM,iBAAiB,CAAC;AACzB,OAAO,KAAK,EAAE,SAAS,EAAE,mBAAmB,EAAE,MAAM,cAAc,CAAC;AAEnE,MAAM,MAAM,kBAAkB,GAAG;IAC/B,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC;IACrC,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAClC,CAAC;AAEF,MAAM,MAAM,oBAAoB,CAAC,MAAM,IAAI,qBAAqB,CAC9D,oBAAoB,CAAC,MAAM,EAAE,4BAA4B,CAAC,MAAM,CAAC,CAAC,CACnE,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,MAAM,MAAM,gDAAgD,CAC1D,cAAc,SAAS,MAAM,EAC7B,MAAM,IACJ;KAED,SAAS,IAAI,MAAM,MAAM,IAAI,MAAM,CAAC,SAAS,CAAC,SAC3C,QAAQ,CAAC,kBAAkB,CAAC,GAC5B,UAAU,CAAC,oBAAoB,CAAC,GAChC,SAAS,GACT,KAAK,GAAG,CACV,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,SAAS,MAAM,SAAS,GAErD,SAAS,SAAS,QAAQ,CAAC,kBAAkB,CAAC,GAC5C;SACG,GAAG,IAAI,GAAG,cAAc,GAAG,UAAU,CACpC,SAAS,GAAG,MAAM,CACnB,EAAE,GAAG,MAAM,CAAC,SAAS,CAAC;KACxB,GAED,SAAS,SAAS,UAAU,CACxB,MAAM,eAAe,SAAS,oBAAoB,CACnD,GAGD,AAFA,+DAA+D;IAE/D,gDAAgD,CAC9C,GAAG,cAAc,GAAG,UAAU,CAAC,SAAS,GAAG,MAAM,CAAC,EAAE,EACpD,eAAe,CAAC,QAAQ,CAAC,CAC1B,GAAG;SACD,GAAG,IAAI,GAAG,cAAc,GAAG,UAAU,CACpC,SAAS,GAAG,MAAM,CACnB,EAAE,GAAG,MAAM,CAAC,SAAS,CAAC;KACxB,GACD,KAAK,GACT,KAAK,KACN,IAAI;CACV,SAAS,MAAM,CAAC,MAAM,EAAE,MAAM,IAAI,CAAC,GAChC,IAAI,SAAS,CAAC,CAAC,EAAE,MAAM,CAAC,KAAK,IAAI,GAC/B,CAAC,GACD,MAAM,CAAC,KAAK,EAAE,KAAK,CAAC,GACtB,MAAM,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;AAEzB;;;;GAIG;AACH,MAAM,MAAM,4BAA4B,CACtC,MAAM,EACN,OAAO,GAAG,mBAAmB,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC,IAChD,mBAAmB,CACrB;KACG,KAAK,IAAI,MAAM,OAAO,GAAG,OAAO,CAAC,KAAK,CAAC,SAAS,UAAU,CAEzD,MAAM,CAAC,SAAS,oBAAoB,CACrC,GAEG,AADA,6DAA6D;IAC7D,gDAAgD,CAC9C,UAAU,CAAC,KAAK,GAAG,MAAM,CAAC,EAC1B,CAAC,CAAC,QAAQ,CAAC,CACZ,GAAG;SAAG,GAAG,IAAI,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC;KAAE,GAEtC,OAAO,CAAC,KAAK,CAAC,SAAS,SAAS,CAC5B,MAAM,CAAC,SAAS,mBAAmB,EACnC,GAAG,CACJ,GAED,gDAAgD,CAC9C,UAAU,CAAC,KAAK,GAAG,MAAM,CAAC,EAC1B,CAAC,CAAC,QAAQ,CAAC,CACZ,GAED,OAAO,CAAC,KAAK,CAAC;CACrB,CAAC,MAAM,OAAO,CAAC,CACjB,CAAC;AAEF,KAAK,oBAAoB,CACvB,MAAM,EACN,SAAS,EACT,cAAc,GAAG,WAAW,CAAC,MAAM,CAAC,GAAG,SAAS,IAC9C;IACF,KAAK,EAAE;SACJ,KAAK,IAAI,MAAM,cAAc,IAAI,cAAc,CAAC,KAAK,CAAC,SAAS,QAAQ,CAAC,kBAAkB,CAAC,GACxF,KAAK,GACL,KAAK,GAAG,cAAc,CAAC,KAAK,CAAC,SAAS,QAAQ,CAChD,MAAM,CAAC,SAAS,kBAAkB,CACnC,GACG,CAAC,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,GACnB,KAAK;KACV,CAAC;IACF,WAAW,EAAE;SACV,KAAK,IAAI,MAAM,cAAc,IAAI,cAAc,CAAC,KAAK,CAAC,SAAS,UAAU,CAAC,oBAAoB,CAAC,GAC5F,KAAK,GACL,KAAK,GAAG,cAAc,CAAC,KAAK,CAAC,SAAS,UAAU,CAClD,MAAM,CAAC,SAAS,oBAAoB,CACrC,GACG,CAAC,CAAC,QAAQ,CAAC,GACX,KAAK;KACV,CAAC;CACH,CAAC;AAEF,KAAK,qBAAqB,CAAC,CAAC,SAAS,kBAAkB,IAAI;IACzD,KAAK,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC;IAClB,WAAW,EAAE,sBAAsB,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC;CACvD,CAAC"}

package/lib-esm/src/MappedTypes/ExtractNonModelTypes.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib-esm/src/MappedTypes/ForeignKeys.d.ts

@@ -0,0 +1,84 @@
+import { ResolveSchema } from './ResolveSchema';
+import { UnionToIntersection } from '@aws-amplify/data-schema-types';
+import { ModelRelationalFieldParamShape, ModelRelationshipTypes } from '../ModelRelationalField';
+export type AllImpliedFKs<ResolvedSchema, Identifiers extends Record<string, {
+    identifier: string;
+}>, Schema extends Record<any, any> = ResolvedSchema extends ResolveSchema<any> ? ResolvedSchema : object, DenormalizedSchema extends Denormalized<Schema, Identifiers> = Denormalized<Schema, Identifiers>, AllModels = DenormalizedSchema['model'] | DenormalizedSchema['relationName']> = {
+    [K in Extract<AllModels, string>]: ImpliedFKs<ResolvedSchema, Identifiers, K> extends never ? object : ImpliedFKs<ResolvedSchema, Identifiers, K>;
+};
+export type Denormalized<Schema extends Record<any, any>, Identifiers extends Record<string, {
+    identifier: string;
+}>> = {
+    [ModelName in keyof Schema]: {
+        [FieldName in keyof Schema[ModelName]]: {
+            model: ModelName;
+            identifier: IdentifierFields<Identifiers, ModelName>;
+            field: FieldName;
+            type: Schema[ModelName][FieldName];
+        } & RelatedModelFields<Schema[ModelName][FieldName], Identifiers>;
+    }[keyof Schema[ModelName]];
+}[keyof Schema];
+export type ImpliedFKs<ResolvedSchema, Identifiers extends Record<string, {
+    identifier: string;
+}>, ModelName, Schema extends Record<any, any> = ResolvedSchema extends ResolveSchema<any> ? ResolvedSchema : object, DenormalizedSchema = Denormalized<Schema, Identifiers>, HasMany_Model = Extract<DenormalizedSchema, {
+    relatedModel: ModelName;
+    relationshipType: ModelRelationshipTypes.hasMany;
+}>, HasOne_Model = Extract<DenormalizedSchema, {
+    model: ModelName;
+    relationshipType: ModelRelationshipTypes.hasOne;
+}>, Model_BelongsTo = Exclude<Extract<DenormalizedSchema, {
+    model: ModelName;
+    relationshipType: ModelRelationshipTypes.belongsTo;
+}>, ImpliedHasManyBelongsTos<HasMany_Model>>, ManyToManys = Extract<DenormalizedSchema, {
+    relationName: ModelName;
+    relationshipType: ModelRelationshipTypes.manyToMany;
+}>, InferredFields = HasMany_Model_Keys<Schema, HasMany_Model> | HasOne_Model_Keys<Schema, HasOne_Model> | Model_BelongsTo_Keys<Schema, Model_BelongsTo> | ManyToManyKeys<Schema, ManyToManys>> = unknown extends UnionToIntersection<InferredFields> ? never : UnionToIntersection<InferredFields>;
+type IdentifierFields<Identifiers extends Record<string, {
+    identifier: string;
+}>, ModelName> = ModelName extends keyof Identifiers ? Identifiers[ModelName]['identifier'] : 'id';
+type RelatedModelFields<ModelField, Identifiers extends Record<string, {
+    identifier: string;
+}>> = ModelField extends ModelRelationalFieldParamShape ? {
+    relatedModel: ModelField['relatedModel'];
+    relationshipType: ModelField['relationshipType'];
+    relationName: ModelField['relationName'];
+    relatedModelIdentifier: IdentifierFields<Identifiers, ModelField['relatedModel']>;
+} : {
+    relatedModel: undefined;
+    relationshipType: undefined;
+    relationName: undefined;
+    relatedModelIdentifier: never;
+};
+type FieldWithRelationship = {
+    model: string;
+    identifier: string;
+    field: string;
+    relatedModel: string;
+    relatedModelIdentifier: string;
+    relationName: string | undefined;
+};
+/**
+ * I.e., creates a "matcher" to identify the belongsTo entries that correspond with
+ * the given hasMany relationship.
+ *
+ * The `belongsTo` side of these relationships can be ignored. The FK comes from the
+ * `hasMany` side of the relationship.
+ */
+type ImpliedHasManyBelongsTos<Relationship> = Relationship extends FieldWithRelationship ? {
+    model: Relationship['relatedModel'];
+} : never;
+type FKName<Model extends string, Field extends string, Identifier extends string> = `${Uncapitalize<Model>}${Capitalize<Field>}${Capitalize<Identifier>}`;
+type HasMany_Model_Keys<Schema extends Record<any, any>, RelDef> = RelDef extends FieldWithRelationship ? {
+    [IDField in RelDef['identifier'] as FKName<RelDef['model'], RelDef['field'], IDField>]?: IDField extends keyof Schema[RelDef['model']] ? Schema[RelDef['model']][IDField] : string;
+} : never;
+type HasOne_Model_Keys<Schema extends Record<any, any>, RelDef> = RelDef extends FieldWithRelationship ? {
+    [IDField in RelDef['relatedModelIdentifier'] as FKName<RelDef['model'], RelDef['field'], IDField>]?: IDField extends keyof Schema[RelDef['relatedModel']] ? Schema[RelDef['relatedModel']][IDField] : string;
+} : never;
+type Model_BelongsTo_Keys<Schema extends Record<any, any>, RelDef> = RelDef extends FieldWithRelationship ? {
+    [IDField in RelDef['relatedModelIdentifier'] as FKName<RelDef['model'], RelDef['field'], IDField>]?: IDField extends keyof Schema[RelDef['model']] ? Schema[RelDef['model']][IDField] : string;
+} : never;
+type ManyToManyKeys<Schema extends Record<any, any>, RelDef> = RelDef extends FieldWithRelationship ? {
+    [IDField in RelDef['identifier'] as FKName<RelDef['model'], '', IDField>]?: IDField extends keyof Schema[RelDef['model']] ? Schema[RelDef['model']][IDField] : string;
+} : never;
+export {};
+//# sourceMappingURL=ForeignKeys.d.ts.map

package/lib-esm/src/MappedTypes/ForeignKeys.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ForeignKeys.d.ts","sourceRoot":"","sources":["../../../src/MappedTypes/ForeignKeys.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EAAE,mBAAmB,EAAE,MAAM,gCAAgC,CAAC;AACrE,OAAO,EACL,8BAA8B,EAC9B,sBAAsB,EACvB,MAAM,yBAAyB,CAAC;AAEjC,MAAM,MAAM,aAAa,CACvB,cAAc,EACd,WAAW,SAAS,MAAM,CAAC,MAAM,EAAE;IAAE,UAAU,EAAE,MAAM,CAAA;CAAE,CAAC,EAC1D,MAAM,SAAS,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC,GAAG,cAAc,SAAS,aAAa,CAAC,GAAG,CAAC,GACvE,cAAc,GACd,MAAM,EACV,kBAAkB,SAAS,YAAY,CAAC,MAAM,EAAE,WAAW,CAAC,GAAG,YAAY,CACzE,MAAM,EACN,WAAW,CACZ,EACD,SAAS,GAAG,kBAAkB,CAAC,OAAO,CAAC,GAAG,kBAAkB,CAAC,cAAc,CAAC,IAC1E;KACD,CAAC,IAAI,OAAO,CAAC,SAAS,EAAE,MAAM,CAAC,GAAG,UAAU,CAC3C,cAAc,EACd,WAAW,EACX,CAAC,CACF,SAAS,KAAK,GACX,MAAM,GACN,UAAU,CAAC,cAAc,EAAE,WAAW,EAAE,CAAC,CAAC;CAC/C,CAAC;AAEF,MAAM,MAAM,YAAY,CACtB,MAAM,SAAS,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC,EAC/B,WAAW,SAAS,MAAM,CAAC,MAAM,EAAE;IAAE,UAAU,EAAE,MAAM,CAAA;CAAE,CAAC,IACxD;KACD,SAAS,IAAI,MAAM,MAAM,GAAG;SAC1B,SAAS,IAAI,MAAM,MAAM,CAAC,SAAS,CAAC,GAAG;YACtC,KAAK,EAAE,SAAS,CAAC;YACjB,UAAU,EAAE,gBAAgB,CAAC,WAAW,EAAE,SAAS,CAAC,CAAC;YACrD,KAAK,EAAE,SAAS,CAAC;YACjB,IAAI,EAAE,MAAM,CAAC,SAAS,CAAC,CAAC,SAAS,CAAC,CAAC;SACpC,GAAG,kBAAkB,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,SAAS,CAAC,EAAE,WAAW,CAAC;KAClE,CAAC,MAAM,MAAM,CAAC,SAAS,CAAC,CAAC;CAC3B,CAAC,MAAM,MAAM,CAAC,CAAC;AAEhB,MAAM,MAAM,UAAU,CACpB,cAAc,EACd,WAAW,SAAS,MAAM,CAAC,MAAM,EAAE;IAAE,UAAU,EAAE,MAAM,CAAA;CAAE,CAAC,EAC1D,SAAS,EACT,MAAM,SAAS,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC,GAAG,cAAc,SAAS,aAAa,CAAC,GAAG,CAAC,GACvE,cAAc,GACd,MAAM,EACV,kBAAkB,GAAG,YAAY,CAAC,MAAM,EAAE,WAAW,CAAC,EACtD,aAAa,GAAG,OAAO,CACrB,kBAAkB,EAClB;IACE,YAAY,EAAE,SAAS,CAAC;IACxB,gBAAgB,EAAE,sBAAsB,CAAC,OAAO,CAAC;CAClD,CACF,EACD,YAAY,GAAG,OAAO,CACpB,kBAAkB,EAClB;IAAE,KAAK,EAAE,SAAS,CAAC;IAAC,gBAAgB,EAAE,sBAAsB,CAAC,MAAM,CAAA;CAAE,CACtE,EACD,eAAe,GAAG,OAAO,CACvB,OAAO,CACL,kBAAkB,EAClB;IACE,KAAK,EAAE,SAAS,CAAC;IACjB,gBAAgB,EAAE,sBAAsB,CAAC,SAAS,CAAC;CACpD,CACF,EAGD,wBAAwB,CAAC,aAAa,CAAC,CACxC,EACD,WAAW,GAAG,OAAO,CACnB,kBAAkB,EAClB;IACE,YAAY,EAAE,SAAS,CAAC;IACxB,gBAAgB,EAAE,sBAAsB,CAAC,UAAU,CAAC;CACrD,CACF,EACD,cAAc,GACV,kBAAkB,CAAC,MAAM,EAAE,aAAa,CAAC,GACzC,iBAAiB,CAAC,MAAM,EAAE,YAAY,CAAC,GACvC,oBAAoB,CAAC,MAAM,EAAE,eAAe,CAAC,GAC7C,cAAc,CAAC,MAAM,EAAE,WAAW,CAAC,IACrC,OAAO,SAAS,mBAAmB,CAAC,cAAc,CAAC,GACnD,KAAK,GACL,mBAAmB,CAAC,cAAc,CAAC,CAAC;AAExC,KAAK,gBAAgB,CACnB,WAAW,SAAS,MAAM,CAAC,MAAM,EAAE;IAAE,UAAU,EAAE,MAAM,CAAA;CAAE,CAAC,EAC1D,SAAS,IACP,SAAS,SAAS,MAAM,WAAW,GACnC,WAAW,CAAC,SAAS,CAAC,CAAC,YAAY,CAAC,GACpC,IAAI,CAAC;AAET,KAAK,kBAAkB,CACrB,UAAU,EACV,WAAW,SAAS,MAAM,CAAC,MAAM,EAAE;IAAE,UAAU,EAAE,MAAM,CAAA;CAAE,CAAC,IACxD,UAAU,SAAS,8BAA8B,GACjD;IACE,YAAY,EAAE,UAAU,CAAC,cAAc,CAAC,CAAC;IACzC,gBAAgB,EAAE,UAAU,CAAC,kBAAkB,CAAC,CAAC;IACjD,YAAY,EAAE,UAAU,CAAC,cAAc,CAAC,CAAC;IACzC,sBAAsB,EAAE,gBAAgB,CACtC,WAAW,EACX,UAAU,CAAC,cAAc,CAAC,CAC3B,CAAC;CACH,GACD;IACE,YAAY,EAAE,SAAS,CAAC;IACxB,gBAAgB,EAAE,SAAS,CAAC;IAC5B,YAAY,EAAE,SAAS,CAAC;IACxB,sBAAsB,EAAE,KAAK,CAAC;CAC/B,CAAC;AAEN,KAAK,qBAAqB,GAAG;IAC3B,KAAK,EAAE,MAAM,CAAC;IACd,UAAU,EAAE,MAAM,CAAC;IACnB,KAAK,EAAE,MAAM,CAAC;IACd,YAAY,EAAE,MAAM,CAAC;IACrB,sBAAsB,EAAE,MAAM,CAAC;IAC/B,YAAY,EAAE,MAAM,GAAG,SAAS,CAAC;CAClC,CAAC;AAEF;;;;;;GAMG;AACH,KAAK,wBAAwB,CAAC,YAAY,IACxC,YAAY,SAAS,qBAAqB,GACtC;IACE,KAAK,EAAE,YAAY,CAAC,cAAc,CAAC,CAAC;CACrC,GACD,KAAK,CAAC;AAEZ,KAAK,MAAM,CACT,KAAK,SAAS,MAAM,EACpB,KAAK,SAAS,MAAM,EACpB,UAAU,SAAS,MAAM,IACvB,GAAG,YAAY,CAAC,KAAK,CAAC,GAAG,UAAU,CAAC,KAAK,CAAC,GAAG,UAAU,CAAC,UAAU,CAAC,EAAE,CAAC;AAE1E,KAAK,kBAAkB,CACrB,MAAM,SAAS,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC,EAC/B,MAAM,IACJ,MAAM,SAAS,qBAAqB,GACpC;KACG,OAAO,IAAI,MAAM,CAAC,YAAY,CAAC,IAAI,MAAM,CACxC,MAAM,CAAC,OAAO,CAAC,EACf,MAAM,CAAC,OAAO,CAAC,EACf,OAAO,CACR,CAAC,CAAC,EAAE,OAAO,SAAS,MAAM,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,GAC9C,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,GAChC,MAAM;CACX,GACD,KAAK,CAAC;AAEV,KAAK,iBAAiB,CACpB,MAAM,SAAS,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC,EAC/B,MAAM,IACJ,MAAM,SAAS,qBAAqB,GACpC;KACG,OAAO,IAAI,MAAM,CAAC,wBAAwB,CAAC,IAAI,MAAM,CACpD,MAAM,CAAC,OAAO,CAAC,EACf,MAAM,CAAC,OAAO,CAAC,EACf,OAAO,CACR,CAAC,CAAC,EAAE,OAAO,SAAS,MAAM,MAAM,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC,GACrD,MAAM,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC,CAAC,OAAO,CAAC,GACvC,MAAM;CACX,GACD,KAAK,CAAC;AAEV,KAAK,oBAAoB,CACvB,MAAM,SAAS,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC,EAC/B,MAAM,IACJ,MAAM,SAAS,qBAAqB,GACpC;KACG,OAAO,IAAI,MAAM,CAAC,wBAAwB,CAAC,IAAI,MAAM,CACpD,MAAM,CAAC,OAAO,CAAC,EACf,MAAM,CAAC,OAAO,CAAC,EACf,OAAO,CACR,CAAC,CAAC,EAAE,OAAO,SAAS,MAAM,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,GAC9C,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,GAChC,MAAM;CACX,GACD,KAAK,CAAC;AAEV,KAAK,cAAc,CACjB,MAAM,SAAS,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC,EAC/B,MAAM,IACJ,MAAM,SAAS,qBAAqB,GACpC;KACG,OAAO,IAAI,MAAM,CAAC,YAAY,CAAC,IAAI,MAAM,CACxC,MAAM,CAAC,OAAO,CAAC,EACf,EAAE,EACF,OAAO,CACR,CAAC,CAAC,EAAE,OAAO,SAAS,MAAM,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,GAC9C,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,GAChC,MAAM;CACX,GACD,KAAK,CAAC"}

package/lib-esm/src/MappedTypes/ForeignKeys.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib-esm/src/MappedTypes/ImplicitFieldInjector.d.ts

@@ -0,0 +1,38 @@
+type DefaultIdentifierFields = {
+    readonly id: string;
+};
+type DefaultTimestampFields = {
+    readonly createdAt: string;
+    readonly updatedAt: string;
+};
+type InitialImplicitFields<Identifier> = Identifier extends 'id' ? DefaultIdentifierFields & DefaultTimestampFields : DefaultTimestampFields;
+/**
+ * @returns true if a string union `ExplicitFieldNames` contains a given string `FieldName`
+ */
+type FieldExists<ExplicitFieldNames extends string, FieldName extends string> = Extract<ExplicitFieldNames, FieldName> extends never ? false : true;
+/**
+ * @returns union of explicitly defined field names for a model
+ */
+type GetModelFieldNames<FlatModel> = FlatModel extends Record<infer R, any> ? R : never;
+/**
+ * Generate Record type containing all implicit fields for a given model
+ */
+type ImplicitFields<FlatModel, Identifier, ModelFieldNames = GetModelFieldNames<FlatModel>> = {
+    [ImplicitField in keyof InitialImplicitFields<Identifier> as FieldExists<ModelFieldNames & string, ImplicitField & string> extends true ? never : ImplicitField]: InitialImplicitFields<Identifier>[ImplicitField];
+};
+/**
+ * @returns intersection of explicit and implicit model fields
+ */
+type InjectDefaultFieldsForModel<FlatModel, ModelIdentifier> = FlatModel & ImplicitFields<FlatModel, 'identifier' extends keyof ModelIdentifier ? ModelIdentifier['identifier'] : never>;
+/**
+ * Mapped type that injects default implicit fields for a model
+ * 1. Add "id" field to models with neither an explicit field named "id" nor a custom identifier (`.identifier(['some-field'])`)
+ * 2. Add default timestamp fields ("createdAt", "updatedAt") unless they're already explicitly defined
+ *
+ * @typeParam FlattenedSchema - resolved schema type (TODO: add detail/example/link to type)
+ */
+export type InjectImplicitModelFields<FlattenedSchema, IdentifierMeta> = {
+    [ModelName in keyof FlattenedSchema]: InjectDefaultFieldsForModel<FlattenedSchema[ModelName], ModelName extends keyof IdentifierMeta ? IdentifierMeta[ModelName] : object>;
+};
+export {};
+//# sourceMappingURL=ImplicitFieldInjector.d.ts.map

package/lib-esm/src/MappedTypes/ImplicitFieldInjector.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ImplicitFieldInjector.d.ts","sourceRoot":"","sources":["../../../src/MappedTypes/ImplicitFieldInjector.ts"],"names":[],"mappings":"AAAA,KAAK,uBAAuB,GAAG;IAE7B,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF,KAAK,sBAAsB,GAAG;IAC5B,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;CAC5B,CAAC;AAEF,KAAK,qBAAqB,CAAC,UAAU,IAAI,UAAU,SAAS,IAAI,GAC5D,uBAAuB,GAAG,sBAAsB,GAChD,sBAAsB,CAAC;AAE3B;;GAEG;AACH,KAAK,WAAW,CACd,kBAAkB,SAAS,MAAM,EACjC,SAAS,SAAS,MAAM,IACtB,OAAO,CAAC,kBAAkB,EAAE,SAAS,CAAC,SAAS,KAAK,GAAG,KAAK,GAAG,IAAI,CAAC;AAExE;;GAEG;AACH,KAAK,kBAAkB,CAAC,SAAS,IAAI,SAAS,SAAS,MAAM,CAAC,MAAM,CAAC,EAAE,GAAG,CAAC,GACvE,CAAC,GACD,KAAK,CAAC;AAEV;;GAEG;AACH,KAAK,cAAc,CACjB,SAAS,EACT,UAAU,EACV,eAAe,GAAG,kBAAkB,CAAC,SAAS,CAAC,IAC7C;KACD,aAAa,IAAI,MAAM,qBAAqB,CAAC,UAAU,CAAC,IAAI,WAAW,CACtE,eAAe,GAAG,MAAM,EACxB,aAAa,GAAG,MAAM,CACvB,SAAS,IAAI,GACV,KAAK,GACL,aAAa,GAAG,qBAAqB,CAAC,UAAU,CAAC,CAAC,aAAa,CAAC;CACrE,CAAC;AAEF;;GAEG;AACH,KAAK,2BAA2B,CAAC,SAAS,EAAE,eAAe,IAAI,SAAS,GACtE,cAAc,CACZ,SAAS,EACT,YAAY,SAAS,MAAM,eAAe,GACtC,eAAe,CAAC,YAAY,CAAC,GAC7B,KAAK,CACV,CAAC;AAEJ;;;;;;GAMG;AACH,MAAM,MAAM,yBAAyB,CAAC,eAAe,EAAE,cAAc,IAAI;KACtE,SAAS,IAAI,MAAM,eAAe,GAAG,2BAA2B,CAC/D,eAAe,CAAC,SAAS,CAAC,EAC1B,SAAS,SAAS,MAAM,cAAc,GAAG,cAAc,CAAC,SAAS,CAAC,GAAG,MAAM,CAC5E;CACF,CAAC"}

package/lib-esm/src/MappedTypes/ImplicitFieldInjector.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });