@aws-amplify/data-schema 0.0.0-20240412222732

package/lib-esm/src/ModelSchema.js

@@ -0,0 +1,162 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isCustomPathData = exports.configure = exports.schema = exports.isModelSchema = exports.ddbSchemaBrandName = exports.rdsSchemaBrand = exports.rdsSchemaBrandName = void 0;
+const ModelType_1 = require("./ModelType");
+const SchemaProcessor_1 = require("./SchemaProcessor");
+const util_1 = require("./util");
+exports.rdsSchemaBrandName = 'RDSSchema';
+exports.rdsSchemaBrand = (0, util_1.brand)(exports.rdsSchemaBrandName);
+exports.ddbSchemaBrandName = 'DDBSchema';
+const ddbSchemaBrand = (0, util_1.brand)(exports.ddbSchemaBrandName);
+/**
+ * Filter the schema types down to only include the ModelTypes as SchemaModelType
+ *
+ * @param schemaContents The object containing all SchemaContent for this schema
+ * @returns Only the schemaContents that are ModelTypes, coerced to the SchemaModelType surface
+ */
+const filterSchemaModelTypes = (schemaContents) => {
+    const modelTypes = {};
+    if (schemaContents) {
+        Object.entries(schemaContents).forEach(([key, content]) => {
+            if ((0, ModelType_1.isSchemaModelType)(content)) {
+                modelTypes[key] = content;
+            }
+        });
+    }
+    return modelTypes;
+};
+/**
+ * Model Schema type guard
+ * @param schema - api-next ModelSchema or string
+ * @returns true if the given value is a ModelSchema
+ */
+const isModelSchema = (schema) => {
+    return typeof schema === 'object' && schema.data !== undefined;
+};
+exports.isModelSchema = isModelSchema;
+function _rdsSchema(types, config) {
+    const data = {
+        types,
+        authorization: [],
+        configuration: config,
+    };
+    const models = filterSchemaModelTypes(data.types);
+    return {
+        data,
+        models,
+        transform() {
+            const internalSchema = { data };
+            return (0, SchemaProcessor_1.processSchema)({ schema: internalSchema });
+        },
+        authorization(rules) {
+            this.data.authorization = rules;
+            const { authorization: _, ...rest } = this;
+            return rest;
+        },
+        addQueries(types) {
+            this.data.types = { ...this.data.types, ...types };
+            const { addQueries: _, ...rest } = this;
+            return rest;
+        },
+        addMutations(types) {
+            this.data.types = { ...this.data.types, ...types };
+            const { addMutations: _, ...rest } = this;
+            return rest;
+        },
+        addSubscriptions(types) {
+            this.data.types = { ...this.data.types, ...types };
+            const { addSubscriptions: _, ...rest } = this;
+            return rest;
+        },
+        setAuthorization(callback) {
+            callback(models, this);
+            const { setAuthorization: _, ...rest } = this;
+            return rest;
+        },
+        relationships(callback) {
+            const { relationships: _, ...rest } = this;
+            // The relationships are added via `models.<Model>.addRelationships`
+            // modifiers that's being called within the callback. They are modifying
+            // by references on each model, so there is not anything else to be done
+            // here.
+            callback(models);
+            return rest;
+        },
+        renameModels(callback) {
+            const { renameModels: _, ...rest } = this;
+            // returns an array of tuples [curName, newName]
+            const changeLog = callback();
+            changeLog.forEach(([curName, newName]) => {
+                const currentType = data.types[curName];
+                if (currentType === undefined) {
+                    throw new Error(`Invalid renameModels call. ${curName} is not defined in the schema`);
+                }
+                if (typeof newName !== 'string' || newName.length < 1) {
+                    throw new Error(`Invalid renameModels call. New name must be a non-empty string. Received: "${newName}"`);
+                }
+                models[newName] = currentType;
+                data.types[newName] = currentType;
+                delete models[curName];
+                delete data.types[curName];
+            });
+            return rest;
+        },
+        ...exports.rdsSchemaBrand,
+    };
+}
+function _ddbSchema(types, config) {
+    const data = {
+        types,
+        authorization: [],
+        configuration: config,
+    };
+    return {
+        data,
+        transform() {
+            const internalSchema = { data };
+            return (0, SchemaProcessor_1.processSchema)({ schema: internalSchema });
+        },
+        authorization(rules) {
+            this.data.authorization = rules;
+            const { authorization: _, ...rest } = this;
+            return rest;
+        },
+        models: filterSchemaModelTypes(data.types),
+        ...ddbSchemaBrand,
+    };
+}
+function bindConfigToSchema(config) {
+    return (types) => {
+        return (config.database.engine === 'dynamodb'
+            ? _ddbSchema(types, config)
+            : _rdsSchema(types, config));
+    };
+}
+/**
+ * The API and data model definition for Amplify Data. Pass in `{ <NAME>: a.model(...) }` to create a database table
+ * and exposes CRUDL operations via an API.
+ * @param types The API and data model definition
+ * @returns An API and data model definition to be deployed with Amplify (Gen 2) experience (`processSchema(...)`)
+ * or with the Amplify Data CDK construct (`@aws-amplify/data-construct`)
+ */
+exports.schema = bindConfigToSchema({ database: { engine: 'dynamodb' } });
+/**
+ * Configure wraps schema definition with non-default config to allow usecases other than
+ * the default DynamoDB use-case.
+ *
+ * @param config The SchemaConfig augments the schema with content like the database type
+ * @returns
+ */
+function configure(config) {
+    return {
+        schema: bindConfigToSchema(config),
+    };
+}
+exports.configure = configure;
+function isCustomPathData(obj) {
+    return ('stack' in obj &&
+        (typeof obj.stack === 'undefined' || typeof obj.stack === 'string') &&
+        'entry' in obj &&
+        typeof obj.entry === 'string');
+}
+exports.isCustomPathData = isCustomPathData;

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

@@ -0,0 +1,85 @@
+import type { SetTypeSubArg, SecondaryIndexIrShape } from '@aws-amplify/data-schema-types';
+import { Brand } from './util';
+import { ModelField, InternalField } from './ModelField';
+import type { ModelRelationalField, InternalRelationalField, ModelRelationalFieldParamShape } from './ModelRelationalField';
+import { Authorization } from './Authorization';
+import { RefType } from './RefType';
+import { EnumType, EnumTypeParamShape } from './EnumType';
+import { CustomType, CustomTypeParamShape } from './CustomType';
+import { ModelIndexType, InternalModelIndexType } from './ModelIndex';
+import { SecondaryIndexToIR } from './MappedTypes/MapSecondaryIndexes';
+declare const brandName = "modelType";
+type ModelFields = Record<string, ModelField<any, any, any> | ModelRelationalField<any, string, any, any> | RefType<any, any, any> | EnumType<EnumTypeParamShape> | CustomType<CustomTypeParamShape>>;
+type InternalModelFields = Record<string, InternalField | InternalRelationalField>;
+type ModelData = {
+    fields: ModelFields;
+    identifier: string[];
+    secondaryIndexes: ReadonlyArray<ModelIndexType<any, any, any, any, any>>;
+    authorization: Authorization<any, any, any>[];
+};
+type InternalModelData = ModelData & {
+    fields: InternalModelFields;
+    identifier: string[];
+    secondaryIndexes: ReadonlyArray<InternalModelIndexType>;
+    authorization: Authorization<any, any, any>[];
+};
+export type ModelTypeParamShape = {
+    fields: ModelFields;
+    identifier: string[];
+    secondaryIndexes: ReadonlyArray<SecondaryIndexIrShape>;
+    authorization: Authorization<any, any, any>[];
+};
+type SecondaryIndexFields<T extends Record<string, unknown>> = keyof {
+    [Field in keyof T as NonNullable<T[Field]> extends string | number ? Field : never]: T[Field];
+} & string;
+type ExtractType<T extends ModelTypeParamShape> = {
+    [FieldProp in keyof T['fields'] as T['fields'][FieldProp] extends ModelField<any, any, any> ? FieldProp : never]: T['fields'][FieldProp] extends ModelField<infer R, any, any> ? R : never;
+};
+type GetRequiredFields<T> = {
+    [FieldProp in keyof T as T[FieldProp] extends NonNullable<T[FieldProp]> ? FieldProp : never]: T[FieldProp];
+};
+type IdentifierMap<T extends ModelTypeParamShape> = GetRequiredFields<ExtractType<T>>;
+type IdentifierFields<T extends ModelTypeParamShape> = keyof IdentifierMap<T> & string;
+type IdentifierType<T extends ModelTypeParamShape, Fields extends string = IdentifierFields<T>> = Array<Fields>;
+export type AddRelationshipFieldsToModelTypeFields<Model, RelationshipFields extends Record<string, ModelRelationalField<ModelRelationalFieldParamShape, string, any, any>>> = Model extends ModelType<infer ModelParam extends ModelTypeParamShape, infer HiddenKeys> ? ModelType<SetTypeSubArg<ModelParam, 'fields', ModelParam['fields'] & RelationshipFields>, HiddenKeys> : never;
+export type ModelType<T extends ModelTypeParamShape, K extends keyof ModelType<T> = never> = Omit<{
+    identifier<ID extends IdentifierType<T> = []>(identifier: ID): ModelType<SetTypeSubArg<T, 'identifier', ID>, K | 'identifier'>;
+    secondaryIndexes<const SecondaryIndexPKPool extends string = SecondaryIndexFields<ExtractType<T>>, const Indexes extends readonly ModelIndexType<string, string, unknown, readonly [], any>[] = readonly [], const IndexesIR extends readonly any[] = SecondaryIndexToIR<Indexes, ExtractType<T>>>(callback: (index: <PK extends SecondaryIndexPKPool>(pk: PK) => ModelIndexType<SecondaryIndexPKPool, PK, ReadonlyArray<Exclude<SecondaryIndexPKPool, PK>>>) => Indexes): ModelType<SetTypeSubArg<T, 'secondaryIndexes', IndexesIR>, K | 'secondaryIndexes'>;
+    authorization<AuthRuleType extends Authorization<any, any, any>>(rules: AuthRuleType[]): ModelType<SetTypeSubArg<T, 'authorization', AuthRuleType[]>, K | 'authorization'>;
+}, K> & Brand<typeof brandName>;
+/**
+ * External representation of Model Type that exposes the `addRelationships` modifier.
+ * Used on the complete schema object.
+ */
+export type SchemaModelType<T extends ModelType<ModelTypeParamShape, never | 'identifier'> = ModelType<ModelTypeParamShape, never | 'identifier'>, ModelName extends string = string, IsRDS extends boolean = false> = IsRDS extends true ? T & {
+    addRelationships<Param extends Record<string, ModelRelationalField<any, string, any, any>> = Record<never, never>>(relationships: Param): Record<ModelName, Param>;
+    fields: T extends ModelType<infer R extends ModelTypeParamShape, any> ? R['fields'] : never;
+} : T;
+/**
+ * Internal representation of Model Type that exposes the `data` property.
+ * Used at buildtime.
+ */
+export type InternalModel = SchemaModelType<ModelType<ModelTypeParamShape>, string, true> & {
+    data: InternalModelData;
+};
+/**
+ * Model Type type guard
+ * @param modelType - api-next ModelType
+ * @returns true if the given value is a ModelSchema
+ */
+export declare const isSchemaModelType: (modelType: any | SchemaModelType) => modelType is ModelType<ModelTypeParamShape, "identifier">;
+/**
+ * A data model that creates a matching Amazon DynamoDB table and provides create, read (list and get), update,
+ * delete, and subscription APIs.
+ *
+ * @param fields database table fields. Supports scalar types and relationship types.
+ * @returns a data model definition
+ */
+export declare function model<T extends ModelFields>(fields: T): ModelType<{
+    fields: T;
+    identifier: Array<'id'>;
+    secondaryIndexes: [];
+    authorization: [];
+}>;
+export {};
+//# sourceMappingURL=ModelType.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ModelType.d.ts","sourceRoot":"","sources":["../../src/ModelType.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,aAAa,EACb,qBAAqB,EACtB,MAAM,gCAAgC,CAAC;AACxC,OAAO,EAAE,KAAK,EAAS,MAAM,QAAQ,CAAC;AACtC,OAAO,EAAE,UAAU,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AACzD,OAAO,KAAK,EACV,oBAAoB,EACpB,uBAAuB,EACvB,8BAA8B,EAC/B,MAAM,wBAAwB,CAAC;AAChC,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,QAAQ,EAAE,kBAAkB,EAAE,MAAM,YAAY,CAAC;AAC1D,OAAO,EAAE,UAAU,EAAE,oBAAoB,EAAE,MAAM,cAAc,CAAC;AAChE,OAAO,EACL,cAAc,EACd,sBAAsB,EAEvB,MAAM,cAAc,CAAC;AACtB,OAAO,EAAE,kBAAkB,EAAE,MAAM,mCAAmC,CAAC;AAEvE,QAAA,MAAM,SAAS,cAAc,CAAC;AAE9B,KAAK,WAAW,GAAG,MAAM,CACvB,MAAM,EACJ,UAAU,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,GACzB,oBAAoB,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,GAAG,CAAC,GAC3C,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,CAC/B,MAAM,EACN,aAAa,GAAG,uBAAuB,CACxC,CAAC;AAEF,KAAK,SAAS,GAAG;IACf,MAAM,EAAE,WAAW,CAAC;IACpB,UAAU,EAAE,MAAM,EAAE,CAAC;IACrB,gBAAgB,EAAE,aAAa,CAAC,cAAc,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC;IACzE,aAAa,EAAE,aAAa,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,EAAE,CAAC;CAC/C,CAAC;AAEF,KAAK,iBAAiB,GAAG,SAAS,GAAG;IACnC,MAAM,EAAE,mBAAmB,CAAC;IAC5B,UAAU,EAAE,MAAM,EAAE,CAAC;IACrB,gBAAgB,EAAE,aAAa,CAAC,sBAAsB,CAAC,CAAC;IACxD,aAAa,EAAE,aAAa,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,EAAE,CAAC;CAC/C,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG;IAChC,MAAM,EAAE,WAAW,CAAC;IACpB,UAAU,EAAE,MAAM,EAAE,CAAC;IACrB,gBAAgB,EAAE,aAAa,CAAC,qBAAqB,CAAC,CAAC;IACvD,aAAa,EAAE,aAAa,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,EAAE,CAAC;CAC/C,CAAC;AAIF,KAAK,oBAAoB,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,IAAI,MAAM;KAClE,KAAK,IAAI,MAAM,CAAC,IAAI,WAAW,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,GAC9D,KAAK,GACL,KAAK,GAAG,CAAC,CAAC,KAAK,CAAC;CACrB,GACC,MAAM,CAAC;AAET,KAAK,WAAW,CAAC,CAAC,SAAS,mBAAmB,IAAI;KAC/C,SAAS,IAAI,MAAM,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,QAAQ,CAAC,CAAC,SAAS,CAAC,SAAS,UAAU,CAC1E,GAAG,EACH,GAAG,EACH,GAAG,CACJ,GACG,SAAS,GACT,KAAK,GAAG,CAAC,CAAC,QAAQ,CAAC,CAAC,SAAS,CAAC,SAAS,UAAU,CAAC,MAAM,CAAC,EAAE,GAAG,EAAE,GAAG,CAAC,GACpE,CAAC,GACD,KAAK;CACV,CAAC;AAEF,KAAK,iBAAiB,CAAC,CAAC,IAAI;KACzB,SAAS,IAAI,MAAM,CAAC,IAAI,CAAC,CAAC,SAAS,CAAC,SAAS,WAAW,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,GACnE,SAAS,GACT,KAAK,GAAG,CAAC,CAAC,SAAS,CAAC;CACzB,CAAC;AAEF,KAAK,aAAa,CAAC,CAAC,SAAS,mBAAmB,IAAI,iBAAiB,CACnE,WAAW,CAAC,CAAC,CAAC,CACf,CAAC;AAIF,KAAK,gBAAgB,CAAC,CAAC,SAAS,mBAAmB,IAAI,MAAM,aAAa,CAAC,CAAC,CAAC,GAC3E,MAAM,CAAC;AAET,KAAK,cAAc,CACjB,CAAC,SAAS,mBAAmB,EAC7B,MAAM,SAAS,MAAM,GAAG,gBAAgB,CAAC,CAAC,CAAC,IACzC,KAAK,CAAC,MAAM,CAAC,CAAC;AAoClB,MAAM,MAAM,sCAAsC,CAChD,KAAK,EACL,kBAAkB,SAAS,MAAM,CAC/B,MAAM,EACN,oBAAoB,CAAC,8BAA8B,EAAE,MAAM,EAAE,GAAG,EAAE,GAAG,CAAC,CACvE,IAED,KAAK,SAAS,SAAS,CACrB,MAAM,UAAU,SAAS,mBAAmB,EAC5C,MAAM,UAAU,CACjB,GACG,SAAS,CACP,aAAa,CACX,UAAU,EACV,QAAQ,EACR,UAAU,CAAC,QAAQ,CAAC,GAAG,kBAAkB,CAC1C,EACD,UAAU,CACX,GACD,KAAK,CAAC;AA6BZ,MAAM,MAAM,SAAS,CACnB,CAAC,SAAS,mBAAmB,EAC7B,CAAC,SAAS,MAAM,SAAS,CAAC,CAAC,CAAC,GAAG,KAAK,IAClC,IAAI,CACN;IACE,UAAU,CAAC,EAAE,SAAS,cAAc,CAAC,CAAC,CAAC,GAAG,EAAE,EAC1C,UAAU,EAAE,EAAE,GACb,SAAS,CAAC,aAAa,CAAC,CAAC,EAAE,YAAY,EAAE,EAAE,CAAC,EAAE,CAAC,GAAG,YAAY,CAAC,CAAC;IACnE,gBAAgB,CACd,KAAK,CAAC,oBAAoB,SAAS,MAAM,GAAG,oBAAoB,CAC9D,WAAW,CAAC,CAAC,CAAC,CACf,EACD,KAAK,CAAC,OAAO,SAAS,SAAS,cAAc,CAC3C,MAAM,EACN,MAAM,EACN,OAAO,EACP,SAAS,EAAE,EACX,GAAG,CACJ,EAAE,GAAG,SAAS,EAAE,EACjB,KAAK,CAAC,SAAS,SAAS,SAAS,GAAG,EAAE,GAAG,kBAAkB,CACzD,OAAO,EACP,WAAW,CAAC,CAAC,CAAC,CACf,EAED,QAAQ,EAAE,CACR,KAAK,EAAE,CAAC,EAAE,SAAS,oBAAoB,EACrC,EAAE,EAAE,EAAE,KACH,cAAc,CACjB,oBAAoB,EACpB,EAAE,EACF,aAAa,CAAC,OAAO,CAAC,oBAAoB,EAAE,EAAE,CAAC,CAAC,CACjD,KACE,OAAO,GACX,SAAS,CACV,aAAa,CAAC,CAAC,EAAE,kBAAkB,EAAE,SAAS,CAAC,EAC/C,CAAC,GAAG,kBAAkB,CACvB,CAAC;IACF,aAAa,CAAC,YAAY,SAAS,aAAa,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,EAC7D,KAAK,EAAE,YAAY,EAAE,GACpB,SAAS,CACV,aAAa,CAAC,CAAC,EAAE,eAAe,EAAE,YAAY,EAAE,CAAC,EACjD,CAAC,GAAG,eAAe,CACpB,CAAC;CACH,EACD,CAAC,CACF,GACC,KAAK,CAAC,OAAO,SAAS,CAAC,CAAC;AAE1B;;;GAGG;AACH,MAAM,MAAM,eAAe,CACzB,CAAC,SAAS,SAAS,CAAC,mBAAmB,EAAE,KAAK,GAAG,YAAY,CAAC,GAAG,SAAS,CACxE,mBAAmB,EACnB,KAAK,GAAG,YAAY,CACrB,EACD,SAAS,SAAS,MAAM,GAAG,MAAM,EACjC,KAAK,SAAS,OAAO,GAAG,KAAK,IAC3B,KAAK,SAAS,IAAI,GAClB,CAAC,GAAG;IACF,gBAAgB,CACd,KAAK,SAAS,MAAM,CAClB,MAAM,EACN,oBAAoB,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,GAAG,CAAC,CAC5C,GAAG,MAAM,CAAC,KAAK,EAAE,KAAK,CAAC,EAExB,aAAa,EAAE,KAAK,GACnB,MAAM,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC;IAC5B,MAAM,EAAE,CAAC,SAAS,SAAS,CAAC,MAAM,CAAC,SAAS,mBAAmB,EAAE,GAAG,CAAC,GACjE,CAAC,CAAC,QAAQ,CAAC,GACX,KAAK,CAAC;CACX,GACD,CAAC,CAAC;AAEN;;;GAGG;AACH,MAAM,MAAM,aAAa,GAAG,eAAe,CACzC,SAAS,CAAC,mBAAmB,CAAC,EAC9B,MAAM,EACN,IAAI,CACL,GAAG;IACF,IAAI,EAAE,iBAAiB,CAAC;CACzB,CAAC;AAuCF;;;;GAIG;AACH,eAAO,MAAM,iBAAiB,cACjB,GAAG,GAAG,eAAe,8DAYjC,CAAC;AAEF;;;;;;GAMG;AACH,wBAAgB,KAAK,CAAC,CAAC,SAAS,WAAW,EACzC,MAAM,EAAE,CAAC,GACR,SAAS,CAAC;IACX,MAAM,EAAE,CAAC,CAAC;IACV,UAAU,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;IACxB,gBAAgB,EAAE,EAAE,CAAC;IACrB,aAAa,EAAE,EAAE,CAAC;CACnB,CAAC,CAED"}

package/lib-esm/src/ModelType.js

@@ -0,0 +1,64 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.model = exports.isSchemaModelType = void 0;
+const util_1 = require("./util");
+const ModelIndex_1 = require("./ModelIndex");
+const brandName = 'modelType';
+function _model(fields) {
+    const data = {
+        fields,
+        identifier: ['id'],
+        secondaryIndexes: [],
+        authorization: [],
+    };
+    const builder = {
+        identifier(identifier) {
+            data.identifier = identifier;
+            return this;
+        },
+        secondaryIndexes(callback) {
+            data.secondaryIndexes = callback(ModelIndex_1.modelIndex);
+            return this;
+        },
+        authorization(rules) {
+            data.authorization = rules;
+            return this;
+        },
+        ...(0, util_1.brand)(brandName),
+    };
+    return {
+        ...builder,
+        data,
+        addRelationships(relationships) {
+            data.fields = { ...data.fields, ...relationships };
+        },
+        fields: data.fields,
+    };
+}
+/**
+ * Model Type type guard
+ * @param modelType - api-next ModelType
+ * @returns true if the given value is a ModelSchema
+ */
+const isSchemaModelType = (modelType) => {
+    const internalType = modelType;
+    return (typeof internalType === 'object' &&
+        internalType.data !== undefined &&
+        internalType.data.fields !== undefined &&
+        internalType.data.authorization !== undefined &&
+        internalType.data.identifier !== undefined &&
+        internalType.data.secondaryIndexes !== undefined &&
+        typeof internalType.addRelationships === 'function');
+};
+exports.isSchemaModelType = isSchemaModelType;
+/**
+ * A data model that creates a matching Amazon DynamoDB table and provides create, read (list and get), update,
+ * delete, and subscription APIs.
+ *
+ * @param fields database table fields. Supports scalar types and relationship types.
+ * @returns a data model definition
+ */
+function model(fields) {
+    return _model(fields);
+}
+exports.model = model;

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

@@ -0,0 +1,59 @@
+import { SetTypeSubArg } from '@aws-amplify/data-schema-types';
+import { Brand } from './util';
+import { Authorization } from './Authorization';
+import { __auth } from './ModelField';
+declare const brandName = "ref";
+type RefTypeData = {
+    type: 'ref';
+    link: string;
+    valueRequired: boolean;
+    array: boolean;
+    arrayRequired: boolean;
+    mutationOperations: MutationOperations[];
+    authorization: Authorization<any, any, any>[];
+};
+export type RefTypeParamShape = {
+    type: 'ref';
+    link: string;
+    valueRequired: boolean;
+    array: boolean;
+    arrayRequired: boolean;
+    authorization: Authorization<any, any, any>[];
+};
+type MutationOperations = 'create' | 'update' | 'delete';
+export type RefType<T extends RefTypeParamShape, K extends keyof RefType<T> = never, Auth = undefined> = Omit<{
+    /**
+     * Marks a field as required.
+     */
+    required(): RefType<SetTypeSubArg<T, T['array'] extends true ? 'arrayRequired' : 'valueRequired', true>, K | 'required'>;
+    /**
+     * Marks a field as an array of the specified ref type.
+     */
+    array(): RefType<SetTypeSubArg<T, 'array', true>, Exclude<K, 'required'> | 'array'>;
+    /**
+     * Configures field-level authorization rules. Pass in an array of authorizations `(a.allow.____)` to mix and match
+     * multiple authorization rules for this field.
+     */
+    authorization<AuthRuleType extends Authorization<any, any, any>>(rules: AuthRuleType[]): RefType<T, K | 'authorization', AuthRuleType>;
+    mutations(operations: MutationOperations[]): RefType<T, K | 'mutations'>;
+}, K> & {
+    [__auth]?: Auth;
+} & Brand<typeof brandName>;
+/**
+ * Internal representation of Ref that exposes the `data` property.
+ * Used at buildtime.
+ */
+export type InternalRef = RefType<RefTypeParamShape> & {
+    data: RefTypeData;
+};
+type RefTypeArgFactory<Link extends string> = {
+    type: 'ref';
+    link: Link;
+    valueRequired: false;
+    array: false;
+    arrayRequired: false;
+    authorization: [];
+};
+export declare function ref<Value extends string, T extends Value>(link: T): RefType<RefTypeArgFactory<T>, never, undefined>;
+export {};
+//# sourceMappingURL=RefType.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"RefType.d.ts","sourceRoot":"","sources":["../../src/RefType.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,gCAAgC,CAAC;AAC/D,OAAO,EAAE,KAAK,EAAE,MAAM,QAAQ,CAAC;AAC/B,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EAAE,MAAM,EAAE,MAAM,cAAc,CAAC;AAEtC,QAAA,MAAM,SAAS,QAAQ,CAAC;AAExB,KAAK,WAAW,GAAG;IACjB,IAAI,EAAE,KAAK,CAAC;IACZ,IAAI,EAAE,MAAM,CAAC;IACb,aAAa,EAAE,OAAO,CAAC;IACvB,KAAK,EAAE,OAAO,CAAC;IACf,aAAa,EAAE,OAAO,CAAC;IACvB,kBAAkB,EAAE,kBAAkB,EAAE,CAAC;IACzC,aAAa,EAAE,aAAa,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,EAAE,CAAC;CAC/C,CAAC;AAEF,MAAM,MAAM,iBAAiB,GAAG;IAC9B,IAAI,EAAE,KAAK,CAAC;IACZ,IAAI,EAAE,MAAM,CAAC;IACb,aAAa,EAAE,OAAO,CAAC;IACvB,KAAK,EAAE,OAAO,CAAC;IACf,aAAa,EAAE,OAAO,CAAC;IACvB,aAAa,EAAE,aAAa,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,EAAE,CAAC;CAC/C,CAAC;AAEF,KAAK,kBAAkB,GAAG,QAAQ,GAAG,QAAQ,GAAG,QAAQ,CAAC;AAEzD,MAAM,MAAM,OAAO,CACjB,CAAC,SAAS,iBAAiB,EAC3B,CAAC,SAAS,MAAM,OAAO,CAAC,CAAC,CAAC,GAAG,KAAK,EAClC,IAAI,GAAG,SAAS,IAGd,IAAI,CACN;IACE;;OAEG;IACH,QAAQ,IAAI,OAAO,CACjB,aAAa,CACX,CAAC,EACD,CAAC,CAAC,OAAO,CAAC,SAAS,IAAI,GAAG,eAAe,GAAG,eAAe,EAC3D,IAAI,CACL,EACD,CAAC,GAAG,UAAU,CACf,CAAC;IACF;;OAEG;IACH,KAAK,IAAI,OAAO,CACd,aAAa,CAAC,CAAC,EAAE,OAAO,EAAE,IAAI,CAAC,EAC/B,OAAO,CAAC,CAAC,EAAE,UAAU,CAAC,GAAG,OAAO,CACjC,CAAC;IACF;;;OAGG;IACH,aAAa,CAAC,YAAY,SAAS,aAAa,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,EAC7D,KAAK,EAAE,YAAY,EAAE,GACpB,OAAO,CAAC,CAAC,EAAE,CAAC,GAAG,eAAe,EAAE,YAAY,CAAC,CAAC;IAEjD,SAAS,CAAC,UAAU,EAAE,kBAAkB,EAAE,GAAG,OAAO,CAAC,CAAC,EAAE,CAAC,GAAG,WAAW,CAAC,CAAC;CAC1E,EACD,CAAC,CACF,GAAG;IAEF,CAAC,MAAM,CAAC,CAAC,EAAE,IAAI,CAAC;CACjB,GAAG,KAAK,CAAC,OAAO,SAAS,CAAC,CAAC;AAQ5B;;;GAGG;AACH,MAAM,MAAM,WAAW,GAAG,OAAO,CAAC,iBAAiB,CAAC,GAAG;IACrD,IAAI,EAAE,WAAW,CAAC;CACnB,CAAC;AA0CF,KAAK,iBAAiB,CAAC,IAAI,SAAS,MAAM,IAAI;IAC5C,IAAI,EAAE,KAAK,CAAC;IACZ,IAAI,EAAE,IAAI,CAAC;IACX,aAAa,EAAE,KAAK,CAAC;IACrB,KAAK,EAAE,KAAK,CAAC;IACb,aAAa,EAAE,KAAK,CAAC;IACrB,aAAa,EAAE,EAAE,CAAC;CACnB,CAAC;AAEF,wBAAgB,GAAG,CAAC,KAAK,SAAS,MAAM,EAAE,CAAC,SAAS,KAAK,EAAE,IAAI,EAAE,CAAC,mDAEjE"}

package/lib-esm/src/RefType.js

@@ -0,0 +1,47 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ref = void 0;
+const ModelField_1 = require("./ModelField");
+const brandName = 'ref';
+function brandedBuilder(builder) {
+    return builder;
+}
+function _ref(link) {
+    const data = {
+        type: 'ref',
+        link,
+        valueRequired: false,
+        array: false,
+        arrayRequired: false,
+        mutationOperations: [],
+        authorization: [],
+    };
+    const builder = brandedBuilder({
+        required() {
+            if (data.array) {
+                data.arrayRequired = true;
+            }
+            else {
+                data.valueRequired = true;
+            }
+            return this;
+        },
+        array() {
+            data.array = true;
+            return this;
+        },
+        authorization(rules) {
+            data.authorization = rules;
+            return this;
+        },
+        mutations(operations) {
+            data.mutationOperations = operations;
+            return this;
+        },
+    });
+    return { ...builder, data };
+}
+function ref(link) {
+    return _ref(link);
+}
+exports.ref = ref;

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

@@ -0,0 +1,11 @@
+import { type InternalSchema } from './ModelSchema';
+import { DerivedApiDefinition } from '@aws-amplify/data-schema-types';
+/**
+ * Returns API definition from ModelSchema or string schema
+ * @param arg - { schema }
+ * @returns DerivedApiDefinition that conforms to IAmplifyGraphqlDefinition
+ */
+export declare function processSchema(arg: {
+    schema: InternalSchema;
+}): DerivedApiDefinition;
+//# sourceMappingURL=SchemaProcessor.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"SchemaProcessor.d.ts","sourceRoot":"","sources":["../../src/SchemaProcessor.ts"],"names":[],"mappings":"AAAA,OAAO,EAAuB,KAAK,cAAc,EAAE,MAAM,eAAe,CAAC;AAsBzE,OAAO,EACL,oBAAoB,EAMrB,MAAM,gCAAgC,CAAC;AA4nDxC;;;;GAIG;AACH,wBAAgB,aAAa,CAAC,GAAG,EAAE;IACjC,MAAM,EAAE,cAAc,CAAC;CACxB,GAAG,oBAAoB,CAiBvB"}