@aws-amplify/data-schema 0.0.0-20240412222732

package/lib-esm/src/Authorization.js

@@ -0,0 +1,332 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.accessSchemaData = exports.accessData = exports.allow = exports.ResourceOperations = exports.Operations = exports.Strategies = exports.CustomProviders = exports.GroupProviders = exports.OwnerProviders = exports.PrivateProviders = exports.PublicProviders = exports.Providers = void 0;
+const __data = Symbol('data');
+/**
+ * All possible providers.
+ *
+ * This list should not be used if you need to restrict available providers
+ * according to an auth strategcy. E.g., `public` auth can only be facilitated
+ * by `apiKey` and `iam` providers.
+ */
+exports.Providers = [
+    'apiKey',
+    'iam',
+    'userPools',
+    'oidc',
+    'function',
+];
+/**
+ * The subset of auth providers that can facilitate `public` auth.
+ */
+exports.PublicProviders = ['apiKey', 'iam'];
+/**
+ * The subset of auth providers that can facilitate `private` auth.
+ */
+exports.PrivateProviders = ['userPools', 'oidc', 'iam'];
+/**
+ * The subset of auth providers that can facilitate `owner` auth.
+ */
+exports.OwnerProviders = ['userPools', 'oidc'];
+/**
+ * The subset of auth providers that can facilitate `group` auth.
+ */
+exports.GroupProviders = ['userPools', 'oidc'];
+/**
+ * The subset of auth providers that can facilitate `custom` auth.
+ */
+exports.CustomProviders = ['function'];
+exports.Strategies = [
+    'public',
+    'private',
+    'owner',
+    'groups',
+    'custom',
+];
+/**
+ * The operations that can be performed against an API.
+ */
+exports.Operations = [
+    'create',
+    'update',
+    'delete',
+    'read',
+    'get',
+    'list',
+    'sync',
+    'listen',
+    'search',
+];
+/**
+ * The operations that can be performed against an API by a Lambda function.
+ */
+exports.ResourceOperations = ['query', 'mutate', 'listen'];
+/**
+ * Creates a shallow copy of an object with an individual field pruned away.
+ *
+ * @param original The original object to prune.
+ * @param without The field to prune.
+ * @returns The pruned object.
+ */
+function omit(original, without) {
+    const pruned = { ...original };
+    delete pruned[without];
+    return pruned;
+}
+function to(operations) {
+    this[__data].operations = operations;
+    return omit(this, 'to');
+}
+function inField(field) {
+    this[__data].groupOrOwnerField = field;
+    const built = omit(this, 'inField');
+    return built;
+}
+/**
+ * Specifies a property of the identity JWT to use in place of `sub::username`
+ * as the value to match against the owner field for authorization.
+ *
+ * @param this Authorization object to operate against.
+ * @param property A property of identity JWT.
+ * @returns A copy of the Authorization object with the claim attached.
+ */
+function identityClaim(property) {
+    this[__data].identityClaim = property;
+    return omit(this, 'identityClaim');
+}
+function withClaimIn(property) {
+    this[__data].groupClaim = property;
+    return omit(this, 'withClaimIn');
+}
+function validateProvider(needle, haystack) {
+    if (needle && !haystack.includes(needle)) {
+        throw new Error(`Invalid provider (${needle}) given!`);
+    }
+}
+function authData(defaults, builderMethods) {
+    return {
+        [__data]: {
+            strategy: 'public',
+            provider: undefined,
+            operations: undefined,
+            groupOrOwnerField: undefined,
+            multiOwner: false,
+            identityClaim: undefined,
+            groups: undefined,
+            ...defaults,
+        },
+        ...builderMethods,
+    };
+}
+/**
+ * Defines an authorization rule for your data models and fields. First choose an authorization strategy (`public`,
+ * `private`, `owner`, `group`, or `custom`), then choose an auth provider (`apiKey`, `iam`, `userPools`, `oidc`, or `function`)
+ * and optionally use `.to(...)` to specify the operations that can be performed against your data models and fields.
+ */
+exports.allow = {
+    /**
+     * Authorize unauthenticated users. By default, `.public()` uses an API key based authorization. You can additionally
+     * use `.public('iam')` to use IAM based authorization for unauthenticated users.
+     * @param provider the authentication provider - supports "apiKey" or "iam" as valid providers
+     * @returns an authorization rule for unauthenticated users
+     */
+    public(provider) {
+        validateProvider(provider, exports.PublicProviders);
+        return authData({
+            strategy: 'public',
+            provider,
+        }, {
+            to,
+        });
+    },
+    /**
+     * Authorize authenticated users. By default, `.private()` uses an Amazon Cognito user pool based authorization. You can additionally
+     * use `.private("iam")` or `.private("oidc")` to use IAM or OIDC based authorization for authenticated users.
+     * @param provider the authentication provider - supports "userPools", "iam", or "oidc"
+     * @returns an authorization rule for authenticated users
+     */
+    private(provider) {
+        validateProvider(provider, exports.PrivateProviders);
+        return authData({
+            strategy: 'private',
+            provider,
+        }, {
+            to,
+        });
+    },
+    /**
+     * Authorize access on a per-user (owner) basis. By setting owner-based authorization, a new `owner: a.string()`
+     * field will be added to the model to store which user "owns" the item. Upon item creation, the "owner field" is
+     * auto-populated with the authenticated user's information. You can which field should be used as the owner field
+     * by chaining the * `.inField(...)` method.
+     *
+     * By default, `.owner()` uses an Amazon Cognito user pool based authorization. You can additionally
+     * use `.owner("oidc")` to use OIDC based authentication to designate the owner.
+     *
+     * To change the specific claim that should be used as the user identifier within the owner field, chain the
+     * `.identityClaim(...)` method.
+     *
+     * @param provider the authentication provider - supports "userPools", "iam", or "oidc"
+     * @returns an authorization rule for authenticated users
+     */
+    owner(provider) {
+        validateProvider(provider, exports.OwnerProviders);
+        return authData({
+            strategy: 'owner',
+            provider,
+            groupOrOwnerField: 'owner',
+        }, {
+            to,
+            inField,
+            identityClaim,
+        });
+    },
+    /**
+     * Authorize access for multi-user / multi-owner access. By setting multi-owner-based authorization, a new `owners: a.string().array()`
+     * field will be added to the model to store which users "own" the item. Upon item creation, the "owners field" is
+     * auto-populated with the authenticated user's information. To grant other users access to the item, append their user identifier into the `owners` array.
+     * You can which field should be used as the owners field by chaining the * `.inField(...)` method.
+     *
+     * By default, `.multipleOwners()` uses an Amazon Cognito user pool based authorization. You can additionally
+     * use `.multipleOwners("oidc")` to use OIDC based authentication to designate the owner.
+     *
+     * To change the specific claim that should be used as the user identifier within the owners field, chain the
+     * `.identityClaim(...)` method.
+     *
+     * @param provider the authentication provider - supports "userPools", "iam", or "oidc"
+     * @returns an authorization rule for authenticated users
+     */
+    multipleOwners(provider) {
+        validateProvider(provider, exports.OwnerProviders);
+        return authData({
+            strategy: 'owner',
+            multiOwner: true,
+            provider,
+            groupOrOwnerField: 'owner',
+        }, {
+            to,
+            inField,
+            identityClaim,
+        });
+    },
+    /**
+     * Authorize a specific user group. Provide the name of the specific user group to have access.
+     *
+     * By default, `.specificGroup()` uses an Amazon Cognito user pool based authorization. You can additionally
+     * use `.specificGroup("group-name", "oidc")` to use OIDC based authentication to designate the user group.
+     *
+     * To change the specific claim that should be used as the user group identifier, chain the
+     * `.withClaimIn(...)` method.
+     * @param group the name of the group to authorize
+     * @param provider the authentication provider - supports "userPools" or "oidc"
+     * @returns an authorization rule to grant access by a specific group
+     */
+    specificGroup(group, provider) {
+        return authData({
+            strategy: 'groups',
+            provider,
+            groups: [group],
+        }, {
+            to,
+            withClaimIn,
+        });
+    },
+    /**
+     * Authorize multiple specific user groups. Provide the names of the specific user groups to have access.
+     *
+     * By default, `.specificGroups()` uses an Amazon Cognito user pool based authorization. You can additionally
+     * use `.specificGroups(["group-a", "group-b"], "oidc")` to use OIDC based authentication to designate the user group.
+     *
+     * To change the specific claim that should be used as the user group identifier, chain the
+     * `.withClaimIn(...)` method.
+     * @param groups the names of the group to authorize defined as an array
+     * @param provider the authentication provider - supports "userPools" or "oidc"
+     * @returns an authorization rule to grant access by a specific group
+     */
+    specificGroups(groups, provider) {
+        return authData({
+            strategy: 'groups',
+            provider,
+            groups,
+        }, {
+            to,
+            withClaimIn,
+        });
+    },
+    /**
+     * Authorize if a user is part of a group defined in a data model field.
+     *
+     * By default, `.groupDefinedIn()` uses an Amazon Cognito user pool based authorization. You can additionally
+     * use `.groupDefinedIn("field-name", "oidc")` to use OIDC based authentication to designate the user group.
+     *
+     * To change the specific claim that should be used as the user group identifier within the groups field, chain the
+     * `.withClaimIn(...)` method.
+     * @param groupsField the field that should store the authorized user group information
+     * @param provider the authentication provider - supports "userPools" or "oidc"
+     * @returns an authorization rule to grant access by a specific group
+     */
+    groupDefinedIn(groupsField, provider) {
+        return authData({
+            strategy: 'groups',
+            provider,
+            groupOrOwnerField: groupsField,
+        }, {
+            to,
+            withClaimIn,
+        });
+    },
+    /**
+     * Authorize if a user is part of a one of the groups defined in a data model field.
+     *
+     * By default, `.groupsDefinedIn()` uses an Amazon Cognito user pool based authorization. You can additionally
+     * use `.groupsDefinedIn("field-name", "oidc")` to use OIDC based authentication to designate the user group.
+     *
+     * To change the specific claim that should be used as the user group identifier within the groups field, chain the
+     * `.withClaimIn(...)` method.
+     * @param groupsField the field that should store the list of authorized user groups
+     * @param provider the authentication provider - supports "userPools" or "oidc"
+     * @returns an authorization rule to grant access by a specific group
+     */
+    groupsDefinedIn(groupsField, provider) {
+        return authData({
+            strategy: 'groups',
+            provider,
+            groupOrOwnerField: groupsField,
+            multiOwner: true,
+        }, {
+            to,
+            withClaimIn,
+        });
+    },
+    custom(provider) {
+        return authData({
+            strategy: 'custom',
+            provider,
+        }, {
+            to,
+        });
+    },
+    resource(fn) {
+        return resourceAuthData(fn, {
+            to: resourceTo,
+        });
+    },
+};
+function resourceTo(operations) {
+    this[__data].operations = operations;
+    return omit(this, 'to');
+}
+function resourceAuthData(resource, builderMethods) {
+    return {
+        [__data]: {
+            strategy: 'resource',
+            resource,
+        },
+        ...builderMethods,
+    };
+}
+const accessData = (authorization) => authorization[__data];
+exports.accessData = accessData;
+// TODO: delete when we make resource auth available at each level in the schema (model, field)
+const accessSchemaData = (authorization) => authorization[__data];
+exports.accessSchemaData = accessSchemaData;

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

@@ -0,0 +1,54 @@
+import { type __modelMeta__ } from '@aws-amplify/data-schema-types';
+import { type GenericModelSchema, type RDSModelSchema } from './ModelSchema';
+import type { ResolveSchema, SchemaTypes } from './MappedTypes/ResolveSchema';
+import type { CreateImplicitModelsFromRelations, ResolveFieldProperties, ResolveStaticFieldProperties } from './MappedTypes/ResolveFieldProperties';
+import type { ModelIdentifier, ModelSecondaryIndexes, RelationalMetadata } from './MappedTypes/ModelMetadata';
+import type { ExtractNonModelTypes, NonModelTypesShape } from './MappedTypes/ExtractNonModelTypes';
+import { ResolveCustomOperations, CustomOperationHandlerTypes } from './MappedTypes/CustomOperations';
+import { CombinedModelSchema, CombinedSchemaIndexesUnion } from './CombineSchema';
+import { SpreadTuple } from './util';
+export type ClientSchema<Schema extends GenericModelSchema<any> | CombinedModelSchema<any>> = Schema extends GenericModelSchema<any> ? InternalClientSchema<Schema> : Schema extends CombinedModelSchema<any> ? InternalCombinedSchema<Schema> : never;
+/**
+ * Types for unwrapping generic type args into client-consumable types
+ *
+ * @typeParam Schema - Data schema builder model type
+ *
+ * The following params are used solely as variables in order to simplify mapped type usage.
+ * They should not receive external type args.
+ *
+ * @internal @typeParam NonModelTypes - Custom Types, Enums, and Custom Operations
+ * @internal @typeParam ResolvedSchema - Resolve the schema types used by other generics
+ * @internal @typeParam ImplicitModels - The implicit models created to represent relationships
+ * @internal @typeParam ImplicitModelsIdentifierMeta - The implicite model identifiers derived from ImplicitModels
+ * @internal @typeParam ResolvedFields - Resolved client-facing types used for CRUDL response shapes
+ * @internal @typeParam IdentifierMeta - Resolve the identifier fields for all models
+ * @internal @typeParam SecondaryIndexes - Map of model secondary index metadata
+ */
+type InternalClientSchema<Schema extends GenericModelSchema<any>, NonModelTypes extends NonModelTypesShape = ExtractNonModelTypes<Schema>, ResolvedSchema = ResolveSchema<Schema>, ImplicitModels = Schema extends RDSModelSchema<any, any> ? object : CreateImplicitModelsFromRelations<ResolvedSchema>, ImplicitModelsIdentifierMeta = {
+    [ImplicitModel in keyof ImplicitModels]: {
+        identifier: 'id';
+    };
+}, ResolvedFields extends Record<string, unknown> = Schema extends RDSModelSchema<any, any> ? ResolveStaticFieldProperties<Schema, NonModelTypes, object> : ResolveFieldProperties<Schema, NonModelTypes, ImplicitModels>, IdentifierMeta extends Record<string, any> = ModelIdentifier<SchemaTypes<Schema>>, SecondaryIndexes extends Record<string, any> = Schema extends RDSModelSchema<any, any> ? object : ModelSecondaryIndexes<SchemaTypes<Schema>>> = CustomOperationHandlerTypes<ResolveCustomOperations<Schema, ResolvedFields, NonModelTypes>['customOperations']> & ResolvedFields & {
+    [__modelMeta__]: IdentifierMeta & ImplicitModelsIdentifierMeta & SecondaryIndexes & RelationalMetadata<ResolvedSchema, ResolvedFields, IdentifierMeta> & NonModelTypes & ResolveCustomOperations<Schema, ResolvedFields, NonModelTypes>;
+};
+type GetInternalClientSchema<Schema> = Schema extends GenericModelSchema<any> ? InternalClientSchema<Schema> : never;
+type CombinedClientSchemas<Schemas extends CombinedModelSchema<any>['schemas']> = {
+    [Index in keyof Schemas]: Index extends CombinedSchemaIndexesUnion ? GetInternalClientSchema<Schemas[Index]> : never;
+};
+/**
+ * Types for unwrapping and combining generic type args into client-consumable types
+ * for multiple schemas
+ *
+ * @typeParam Combined - A container of multiple schemas
+ *
+ * @internal @typeParam ClientSchemas - The tuple of client schemas to combine
+ */
+type InternalCombinedSchema<Combined extends CombinedModelSchema<any>, ClientSchemas extends [...any] = CombinedClientSchemas<Combined['schemas']>> = SpreadTuple<{
+    [I in keyof ClientSchemas]: I extends CombinedSchemaIndexesUnion ? Omit<ClientSchemas[I], typeof __modelMeta__> : never;
+}> & {
+    [__modelMeta__]: SpreadTuple<{
+        [I in keyof ClientSchemas]: I extends CombinedSchemaIndexesUnion ? ClientSchemas[I][typeof __modelMeta__] : never;
+    }>;
+};
+export {};
+//# sourceMappingURL=ClientSchema.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ClientSchema.d.ts","sourceRoot":"","sources":["../../src/ClientSchema.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,aAAa,EAAE,MAAM,gCAAgC,CAAC;AACpE,OAAO,EAAE,KAAK,kBAAkB,EAAE,KAAK,cAAc,EAAE,MAAM,eAAe,CAAC;AAG7E,OAAO,KAAK,EAAE,aAAa,EAAE,WAAW,EAAE,MAAM,6BAA6B,CAAC;AAC9E,OAAO,KAAK,EACV,iCAAiC,EACjC,sBAAsB,EACtB,4BAA4B,EAC7B,MAAM,sCAAsC,CAAC;AAC9C,OAAO,KAAK,EACV,eAAe,EACf,qBAAqB,EACrB,kBAAkB,EACnB,MAAM,6BAA6B,CAAC;AACrC,OAAO,KAAK,EACV,oBAAoB,EACpB,kBAAkB,EACnB,MAAM,oCAAoC,CAAC;AAC5C,OAAO,EACL,uBAAuB,EACvB,2BAA2B,EAC5B,MAAM,gCAAgC,CAAC;AACxC,OAAO,EACL,mBAAmB,EACnB,0BAA0B,EAC3B,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAAE,WAAW,EAAE,MAAM,QAAQ,CAAC;AAErC,MAAM,MAAM,YAAY,CACtB,MAAM,SAAS,kBAAkB,CAAC,GAAG,CAAC,GAAG,mBAAmB,CAAC,GAAG,CAAC,IAC/D,MAAM,SAAS,kBAAkB,CAAC,GAAG,CAAC,GACtC,oBAAoB,CAAC,MAAM,CAAC,GAC5B,MAAM,SAAS,mBAAmB,CAAC,GAAG,CAAC,GACrC,sBAAsB,CAAC,MAAM,CAAC,GAC9B,KAAK,CAAC;AAEZ;;;;;;;;;;;;;;;GAeG;AACH,KAAK,oBAAoB,CACvB,MAAM,SAAS,kBAAkB,CAAC,GAAG,CAAC,EACtC,aAAa,SAAS,kBAAkB,GAAG,oBAAoB,CAAC,MAAM,CAAC,EACvE,cAAc,GAAG,aAAa,CAAC,MAAM,CAAC,EACtC,cAAc,GAAG,MAAM,SAAS,cAAc,CAAC,GAAG,EAAE,GAAG,CAAC,GACpD,MAAM,GACN,iCAAiC,CAAC,cAAc,CAAC,EACrD,4BAA4B,GAAG;KAC5B,aAAa,IAAI,MAAM,cAAc,GAAG;QACvC,UAAU,EAAE,IAAI,CAAC;KAClB;CACF,EACD,cAAc,SAAS,MAAM,CAC3B,MAAM,EACN,OAAO,CACR,GAAG,MAAM,SAAS,cAAc,CAAC,GAAG,EAAE,GAAG,CAAC,GACvC,4BAA4B,CAAC,MAAM,EAAE,aAAa,EAAE,MAAM,CAAC,GAC3D,sBAAsB,CAAC,MAAM,EAAE,aAAa,EAAE,cAAc,CAAC,EACjE,cAAc,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,eAAe,CAC1D,WAAW,CAAC,MAAM,CAAC,CACpB,EACD,gBAAgB,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,MAAM,SAAS,cAAc,CAC1E,GAAG,EACH,GAAG,CACJ,GACG,MAAM,GACN,qBAAqB,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC,IAC5C,2BAA2B,CAC7B,uBAAuB,CACrB,MAAM,EACN,cAAc,EACd,aAAa,CACd,CAAC,kBAAkB,CAAC,CACtB,GACC,cAAc,GAAG;IACf,CAAC,aAAa,CAAC,EAAE,cAAc,GAC7B,4BAA4B,GAC5B,gBAAgB,GAChB,kBAAkB,CAAC,cAAc,EAAE,cAAc,EAAE,cAAc,CAAC,GAClE,aAAa,GACb,uBAAuB,CAAC,MAAM,EAAE,cAAc,EAAE,aAAa,CAAC,CAAC;CAClE,CAAC;AAEJ,KAAK,uBAAuB,CAAC,MAAM,IAAI,MAAM,SAAS,kBAAkB,CAAC,GAAG,CAAC,GACzE,oBAAoB,CAAC,MAAM,CAAC,GAC5B,KAAK,CAAC;AAEV,KAAK,qBAAqB,CACxB,OAAO,SAAS,mBAAmB,CAAC,GAAG,CAAC,CAAC,SAAS,CAAC,IACjD;KACD,KAAK,IAAI,MAAM,OAAO,GAAG,KAAK,SAAS,0BAA0B,GAC9D,uBAAuB,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,GACvC,KAAK;CACV,CAAC;AAEF;;;;;;;GAOG;AACH,KAAK,sBAAsB,CACzB,QAAQ,SAAS,mBAAmB,CAAC,GAAG,CAAC,EACzC,aAAa,SAAS,CAAC,GAAG,GAAG,CAAC,GAAG,qBAAqB,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,IACzE,WAAW,CAAC;KACb,CAAC,IAAI,MAAM,aAAa,GAAG,CAAC,SAAS,0BAA0B,GAC5D,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,EAAE,OAAO,aAAa,CAAC,GAC5C,KAAK;CACV,CAAC,GAAG;IACH,CAAC,aAAa,CAAC,EAAE,WAAW,CAAC;SAC1B,CAAC,IAAI,MAAM,aAAa,GAAG,CAAC,SAAS,0BAA0B,GAC5D,aAAa,CAAC,CAAC,CAAC,CAAC,OAAO,aAAa,CAAC,GACtC,KAAK;KACV,CAAC,CAAC;CACJ,CAAC"}

package/lib-esm/src/ClientSchema.js

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

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

@@ -0,0 +1,19 @@
+import { GenericModelSchema } from './ModelSchema';
+import { Brand, IndexLimitUnion } from './util';
+declare const COMBINED_SCHEMA_LIMIT = 50;
+export type CombinedSchemaIndexesUnion = IndexLimitUnion<typeof COMBINED_SCHEMA_LIMIT>[number];
+declare const CombinedSchemaBrandName = "CombinedSchema";
+export declare const combinedSchemaBrand: Brand<"CombinedSchema">;
+export type CombinedSchemaBrand = Brand<typeof CombinedSchemaBrandName>;
+export type CombinedModelSchema<Schemas extends GenericModelSchema<any>[]> = CombinedSchemaBrand & {
+    schemas: [...Schemas];
+};
+/**
+ * The interface for merging up to 50 schemas into a single API.
+ * @param schemas The schemas to combine into a single API
+ * @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`)
+ */
+export declare function combine<Schema extends GenericModelSchema<any>[]>(schemas: [...Schema]): CombinedModelSchema<Schema>;
+export {};
+//# sourceMappingURL=CombineSchema.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"CombineSchema.d.ts","sourceRoot":"","sources":["../../src/CombineSchema.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,eAAe,CAAC;AACnD,OAAO,EAAS,KAAK,EAAE,eAAe,EAAE,MAAM,QAAQ,CAAC;AAEvD,QAAA,MAAM,qBAAqB,KAAK,CAAC;AAEjC,MAAM,MAAM,0BAA0B,GAAG,eAAe,CACtD,OAAO,qBAAqB,CAC7B,CAAC,MAAM,CAAC,CAAC;AAEV,QAAA,MAAM,uBAAuB,mBAAmB,CAAC;AACjD,eAAO,MAAM,mBAAmB,yBAAiC,CAAC;AAClE,MAAM,MAAM,mBAAmB,GAAG,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAC;AAExE,MAAM,MAAM,mBAAmB,CAAC,OAAO,SAAS,kBAAkB,CAAC,GAAG,CAAC,EAAE,IACvE,mBAAmB,GAAG;IAAE,OAAO,EAAE,CAAC,GAAG,OAAO,CAAC,CAAA;CAAE,CAAC;AAElD;;;;;GAKG;AACH,wBAAgB,OAAO,CAAC,MAAM,SAAS,kBAAkB,CAAC,GAAG,CAAC,EAAE,EAC9D,OAAO,EAAE,CAAC,GAAG,MAAM,CAAC,GACnB,mBAAmB,CAAC,MAAM,CAAC,CAE7B"}

package/lib-esm/src/CombineSchema.js

@@ -0,0 +1,40 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.combine = exports.combinedSchemaBrand = void 0;
+const util_1 = require("./util");
+const COMBINED_SCHEMA_LIMIT = 50;
+const CombinedSchemaBrandName = 'CombinedSchema';
+exports.combinedSchemaBrand = (0, util_1.brand)(CombinedSchemaBrandName);
+/**
+ * The interface for merging up to 50 schemas into a single API.
+ * @param schemas The schemas to combine into a single API
+ * @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`)
+ */
+function combine(schemas) {
+    return internalCombine(schemas);
+}
+exports.combine = combine;
+function internalCombine(schemas) {
+    validateDuplicateTypeNames(schemas);
+    return {
+        ...exports.combinedSchemaBrand,
+        schemas: schemas,
+    };
+}
+function validateDuplicateTypeNames(schemas) {
+    const allSchemaKeys = schemas.flatMap((s) => Object.keys(s.data.types));
+    const keySet = new Set();
+    const duplicateKeySet = new Set();
+    allSchemaKeys.forEach((key) => {
+        if (keySet.has(key)) {
+            duplicateKeySet.add(key);
+        }
+        else {
+            keySet.add(key);
+        }
+    });
+    if (duplicateKeySet.size > 0) {
+        throw new Error(`The schemas you are attempting to combine have a name collision. Please remove or rename ${Array.from(duplicateKeySet).join(', ')}.`);
+    }
+}

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

@@ -0,0 +1,98 @@
+import { SetTypeSubArg } from '@aws-amplify/data-schema-types';
+import { Brand } from './util';
+import { ModelField, InternalField } from './ModelField';
+import { Authorization } from './Authorization';
+import { RefType, InternalRef } from './RefType';
+import { EnumType, EnumTypeParamShape } from './EnumType';
+import { CustomType } from './CustomType';
+import type { CustomHandler, FunctionHandler, HandlerType as Handler } from './Handler';
+declare const queryBrand = "queryCustomOperation";
+declare const mutationBrand = "mutationCustomOperation";
+declare const subscriptionBrand = "subscriptionCustomOperation";
+type CustomOperationBrand = typeof queryBrand | typeof mutationBrand | typeof subscriptionBrand;
+type CustomArguments = Record<string, ModelField<any, any> | EnumType<EnumTypeParamShape>>;
+type SubscriptionSource = RefType<any, any>;
+type InternalSubscriptionSource = InternalRef;
+type CustomReturnType = RefType<any> | CustomType<any>;
+type CustomFunctionRefType = string;
+type InternalCustomArguments = Record<string, InternalField>;
+type InternalCustomReturnType = InternalRef;
+type HandlerInputType = FunctionHandler[] | CustomHandler[] | Handler;
+export declare const CustomOperationNames: readonly ["Query", "Mutation", "Subscription"];
+type CustomOperationName = (typeof CustomOperationNames)[number];
+type CustomData = {
+    arguments: CustomArguments;
+    returnType: CustomReturnType | null;
+    functionRef: string | null;
+    authorization: Authorization<any, any, any>[];
+    typeName: CustomOperationName;
+    handlers: Handler[] | null;
+    subscriptionSource: SubscriptionSource[];
+};
+type InternalCustomData = CustomData & {
+    arguments: InternalCustomArguments;
+    returnType: InternalCustomReturnType;
+    functionRef: string | null;
+    subscriptionSource: InternalSubscriptionSource[];
+    authorization: Authorization<any, any, any>[];
+};
+export type CustomOperationParamShape = {
+    arguments: CustomArguments | null;
+    returnType: CustomReturnType | null;
+    functionRef: string | null;
+    authorization: Authorization<any, any, any>[];
+    typeName: CustomOperationName;
+    handlers: Handler | null;
+};
+export type CustomOperation<T extends CustomOperationParamShape, K extends keyof CustomOperation<T> = never, B extends CustomOperationBrand = CustomOperationBrand> = Omit<{
+    arguments<Arguments extends CustomArguments>(args: Arguments): CustomOperation<SetTypeSubArg<T, 'arguments', Arguments>, K | 'arguments', B>;
+    returns<ReturnType extends CustomReturnType>(returnType: ReturnType): CustomOperation<SetTypeSubArg<T, 'returnType', ReturnType>, K | 'returns', B>;
+    /**
+     *
+     * @deprecated
+     * `.function` should no longer be used and will be removed
+     * in the next minor version of this package.
+     *
+     * Use `.handler(a.handler.function())` instead
+     */
+    function<FunctionRef extends CustomFunctionRefType>(functionRefOrName: FunctionRef): CustomOperation<SetTypeSubArg<T, 'functionRef', FunctionRef>, K | 'function', B>;
+    authorization<AuthRuleType extends Authorization<any, any, any>>(rules: AuthRuleType[]): CustomOperation<SetTypeSubArg<T, 'authorization', AuthRuleType[]>, K | 'authorization', B>;
+    handler<H extends HandlerInputType>(handlers: H): CustomOperation<T, K | 'handler', B>;
+    for<Source extends SubscriptionSource>(source: Source | Source[]): CustomOperation<T['typeName'] extends 'Subscription' ? SetTypeSubArg<T, 'returnType', Source extends SubscriptionSource[] ? Source[number] : Source> : T, K | 'for', B>;
+}, K> & Brand<B>;
+/**
+ * Internal representation of Custom Type that exposes the `data` property.
+ * Used at buildtime.
+ */
+export type InternalCustom<B extends CustomOperationBrand = any> = CustomOperation<any, never, B> & {
+    data: InternalCustomData;
+};
+export type QueryCustomOperation = CustomOperation<CustomOperationParamShape, any, typeof queryBrand>;
+export declare function query(): CustomOperation<{
+    arguments: null;
+    returnType: null;
+    functionRef: null;
+    authorization: [];
+    typeName: 'Query';
+    handlers: null;
+}, never, typeof queryBrand>;
+export type MutationCustomOperation = CustomOperation<CustomOperationParamShape, any, typeof mutationBrand>;
+export declare function mutation(): CustomOperation<{
+    arguments: null;
+    returnType: null;
+    functionRef: null;
+    authorization: [];
+    typeName: 'Mutation';
+    handlers: null;
+}, never, typeof mutationBrand>;
+export type SubscriptionCustomOperation = CustomOperation<CustomOperationParamShape, any, typeof subscriptionBrand>;
+export declare function subscription(): CustomOperation<{
+    arguments: null;
+    returnType: null;
+    functionRef: null;
+    authorization: [];
+    typeName: 'Subscription';
+    handlers: null;
+}, 'returns', typeof subscriptionBrand>;
+export {};
+//# sourceMappingURL=CustomOperation.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"CustomOperation.d.ts","sourceRoot":"","sources":["../../src/CustomOperation.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,gCAAgC,CAAC;AAC/D,OAAO,EAAE,KAAK,EAAS,MAAM,QAAQ,CAAC;AAEtC,OAAO,EAAE,UAAU,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AACzD,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EAAE,OAAO,EAAE,WAAW,EAAE,MAAM,WAAW,CAAC;AACjD,OAAO,EAAE,QAAQ,EAAE,kBAAkB,EAAE,MAAM,YAAY,CAAC;AAC1D,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC1C,OAAO,KAAK,EACV,aAAa,EACb,eAAe,EACf,WAAW,IAAI,OAAO,EACvB,MAAM,WAAW,CAAC;AAEnB,QAAA,MAAM,UAAU,yBAAyB,CAAC;AAC1C,QAAA,MAAM,aAAa,4BAA4B,CAAC;AAChD,QAAA,MAAM,iBAAiB,gCAAgC,CAAC;AAExD,KAAK,oBAAoB,GACrB,OAAO,UAAU,GACjB,OAAO,aAAa,GACpB,OAAO,iBAAiB,CAAC;AAE7B,KAAK,eAAe,GAAG,MAAM,CAC3B,MAAM,EACN,UAAU,CAAC,GAAG,EAAE,GAAG,CAAC,GAAG,QAAQ,CAAC,kBAAkB,CAAC,CACpD,CAAC;AAEF,KAAK,kBAAkB,GAAG,OAAO,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;AAC5C,KAAK,0BAA0B,GAAG,WAAW,CAAC;AAE9C,KAAK,gBAAgB,GAAG,OAAO,CAAC,GAAG,CAAC,GAAG,UAAU,CAAC,GAAG,CAAC,CAAC;AACvD,KAAK,qBAAqB,GAAG,MAAM,CAAC;AAEpC,KAAK,uBAAuB,GAAG,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;AAC7D,KAAK,wBAAwB,GAAG,WAAW,CAAC;AAC5C,KAAK,gBAAgB,GAAG,eAAe,EAAE,GAAG,aAAa,EAAE,GAAG,OAAO,CAAC;AAEtE,eAAO,MAAM,oBAAoB,gDAIvB,CAAC;AACX,KAAK,mBAAmB,GAAG,CAAC,OAAO,oBAAoB,CAAC,CAAC,MAAM,CAAC,CAAC;AAEjE,KAAK,UAAU,GAAG;IAChB,SAAS,EAAE,eAAe,CAAC;IAC3B,UAAU,EAAE,gBAAgB,GAAG,IAAI,CAAC;IACpC,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,aAAa,EAAE,aAAa,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,EAAE,CAAC;IAC9C,QAAQ,EAAE,mBAAmB,CAAC;IAC9B,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC;IAC3B,kBAAkB,EAAE,kBAAkB,EAAE,CAAC;CAC1C,CAAC;AAEF,KAAK,kBAAkB,GAAG,UAAU,GAAG;IACrC,SAAS,EAAE,uBAAuB,CAAC;IACnC,UAAU,EAAE,wBAAwB,CAAC;IACrC,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,kBAAkB,EAAE,0BAA0B,EAAE,CAAC;IACjD,aAAa,EAAE,aAAa,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,EAAE,CAAC;CAC/C,CAAC;AAEF,MAAM,MAAM,yBAAyB,GAAG;IACtC,SAAS,EAAE,eAAe,GAAG,IAAI,CAAC;IAClC,UAAU,EAAE,gBAAgB,GAAG,IAAI,CAAC;IACpC,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,aAAa,EAAE,aAAa,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,EAAE,CAAC;IAC9C,QAAQ,EAAE,mBAAmB,CAAC;IAC9B,QAAQ,EAAE,OAAO,GAAG,IAAI,CAAC;CAC1B,CAAC;AAEF,MAAM,MAAM,eAAe,CACzB,CAAC,SAAS,yBAAyB,EACnC,CAAC,SAAS,MAAM,eAAe,CAAC,CAAC,CAAC,GAAG,KAAK,EAC1C,CAAC,SAAS,oBAAoB,GAAG,oBAAoB,IACnD,IAAI,CACN;IACE,SAAS,CAAC,SAAS,SAAS,eAAe,EACzC,IAAI,EAAE,SAAS,GACd,eAAe,CAChB,aAAa,CAAC,CAAC,EAAE,WAAW,EAAE,SAAS,CAAC,EACxC,CAAC,GAAG,WAAW,EACf,CAAC,CACF,CAAC;IACF,OAAO,CAAC,UAAU,SAAS,gBAAgB,EACzC,UAAU,EAAE,UAAU,GACrB,eAAe,CAChB,aAAa,CAAC,CAAC,EAAE,YAAY,EAAE,UAAU,CAAC,EAC1C,CAAC,GAAG,SAAS,EACb,CAAC,CACF,CAAC;IACF;;;;;;;OAOG;IACH,QAAQ,CAAC,WAAW,SAAS,qBAAqB,EAChD,iBAAiB,EAAE,WAAW,GAC7B,eAAe,CAChB,aAAa,CAAC,CAAC,EAAE,aAAa,EAAE,WAAW,CAAC,EAC5C,CAAC,GAAG,UAAU,EACd,CAAC,CACF,CAAC;IACF,aAAa,CAAC,YAAY,SAAS,aAAa,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,EAC7D,KAAK,EAAE,YAAY,EAAE,GACpB,eAAe,CAChB,aAAa,CAAC,CAAC,EAAE,eAAe,EAAE,YAAY,EAAE,CAAC,EACjD,CAAC,GAAG,eAAe,EACnB,CAAC,CACF,CAAC;IACF,OAAO,CAAC,CAAC,SAAS,gBAAgB,EAChC,QAAQ,EAAE,CAAC,GACV,eAAe,CAAC,CAAC,EAAE,CAAC,GAAG,SAAS,EAAE,CAAC,CAAC,CAAC;IACxC,GAAG,CAAC,MAAM,SAAS,kBAAkB,EACnC,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,GACxB,eAAe,CAChB,CAAC,CAAC,UAAU,CAAC,SAAS,cAAc,GAChC,aAAa,CACX,CAAC,EACD,YAAY,EAIZ,MAAM,SAAS,kBAAkB,EAAE,GAAG,MAAM,CAAC,MAAM,CAAC,GAAG,MAAM,CAC9D,GACD,CAAC,EACL,CAAC,GAAG,KAAK,EACT,CAAC,CACF,CAAC;CACH,EACD,CAAC,CACF,GACC,KAAK,CAAC,CAAC,CAAC,CAAC;AASX;;;GAGG;AACH,MAAM,MAAM,cAAc,CAAC,CAAC,SAAS,oBAAoB,GAAG,GAAG,IAC7D,eAAe,CAAC,GAAG,EAAE,KAAK,EAAE,CAAC,CAAC,GAAG;IAC/B,IAAI,EAAE,kBAAkB,CAAC;CAC1B,CAAC;AA6DJ,MAAM,MAAM,oBAAoB,GAAG,eAAe,CAChD,yBAAyB,EACzB,GAAG,EACH,OAAO,UAAU,CAClB,CAAC;AAEF,wBAAgB,KAAK,IAAI,eAAe,CACtC;IACE,SAAS,EAAE,IAAI,CAAC;IAChB,UAAU,EAAE,IAAI,CAAC;IACjB,WAAW,EAAE,IAAI,CAAC;IAClB,aAAa,EAAE,EAAE,CAAC;IAClB,QAAQ,EAAE,OAAO,CAAC;IAClB,QAAQ,EAAE,IAAI,CAAC;CAChB,EACD,KAAK,EACL,OAAO,UAAU,CAClB,CAEA;AAED,MAAM,MAAM,uBAAuB,GAAG,eAAe,CACnD,yBAAyB,EACzB,GAAG,EACH,OAAO,aAAa,CACrB,CAAC;AAEF,wBAAgB,QAAQ,IAAI,eAAe,CACzC;IACE,SAAS,EAAE,IAAI,CAAC;IAChB,UAAU,EAAE,IAAI,CAAC;IACjB,WAAW,EAAE,IAAI,CAAC;IAClB,aAAa,EAAE,EAAE,CAAC;IAClB,QAAQ,EAAE,UAAU,CAAC;IACrB,QAAQ,EAAE,IAAI,CAAC;CAChB,EACD,KAAK,EACL,OAAO,aAAa,CACrB,CAEA;AAED,MAAM,MAAM,2BAA2B,GAAG,eAAe,CACvD,yBAAyB,EACzB,GAAG,EACH,OAAO,iBAAiB,CACzB,CAAC;AAEF,wBAAgB,YAAY,IAAI,eAAe,CAC7C;IACE,SAAS,EAAE,IAAI,CAAC;IAChB,UAAU,EAAE,IAAI,CAAC;IACjB,WAAW,EAAE,IAAI,CAAC;IAClB,aAAa,EAAE,EAAE,CAAC;IAClB,QAAQ,EAAE,cAAc,CAAC;IACzB,QAAQ,EAAE,IAAI,CAAC;CAChB,EACD,SAAS,EACT,OAAO,iBAAiB,CACzB,CAEA"}

package/lib-esm/src/CustomOperation.js

@@ -0,0 +1,67 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.subscription = exports.mutation = exports.query = exports.CustomOperationNames = void 0;
+const util_1 = require("./util");
+const queryBrand = 'queryCustomOperation';
+const mutationBrand = 'mutationCustomOperation';
+const subscriptionBrand = 'subscriptionCustomOperation';
+exports.CustomOperationNames = [
+    'Query',
+    'Mutation',
+    'Subscription',
+];
+function brandedBuilder(builder, brandValue) {
+    return { ...builder, ...(0, util_1.brand)(brandValue) };
+}
+function _custom(typeName, brand) {
+    const data = {
+        arguments: {},
+        returnType: null,
+        functionRef: null,
+        authorization: [],
+        typeName: typeName,
+        handlers: null,
+        subscriptionSource: [],
+    };
+    const builder = brandedBuilder({
+        arguments(args) {
+            data.arguments = args;
+            return this;
+        },
+        returns(returnType) {
+            data.returnType = returnType;
+            return this;
+        },
+        function(functionRefOrName) {
+            data.functionRef = functionRefOrName;
+            return this;
+        },
+        authorization(rules) {
+            data.authorization = rules;
+            return this;
+        },
+        handler(handlers) {
+            data.handlers = Array.isArray(handlers)
+                ? handlers
+                : [handlers];
+            return this;
+        },
+        for(source) {
+            data.subscriptionSource = Array.isArray(source) ? source : [source];
+            return this;
+        },
+    }, brand);
+    return { ...builder, data };
+}
+function query() {
+    return _custom('Query', queryBrand);
+}
+exports.query = query;
+function mutation() {
+    return _custom('Mutation', mutationBrand);
+}
+exports.mutation = mutation;
+function subscription() {
+    return _custom('Subscription', subscriptionBrand);
+}
+exports.subscription = subscription;