@aws-amplify/data-schema 0.15.0 → 0.16.0

package/src/a.ts

@@ -0,0 +1,58 @@
+import { schema } from './ModelSchema';
+import { combine } from './CombineSchema';
+import { model } from './ModelType';
+import {
+  id,
+  string,
+  integer,
+  float,
+  boolean,
+  date,
+  time,
+  datetime,
+  timestamp,
+  email,
+  json,
+  phone,
+  url,
+  ipAddress,
+} from './ModelField';
+import { ref } from './RefType';
+import { hasOne, hasMany, belongsTo } from './ModelRelationalField';
+import { customType } from './CustomType';
+import { enumType } from './EnumType';
+import { query, mutation, subscription } from './CustomOperation';
+import { handler } from './Handler';
+
+// We are re-exporting with this pattern to make the JSDoc happy.
+// Otherwise the JSDoc wouldn't consistently show up as a customer types
+// "a."
+export {
+  schema,
+  combine,
+  model,
+  ref,
+  customType,
+  enumType as enum,
+  query,
+  mutation,
+  subscription,
+  hasOne,
+  hasMany,
+  belongsTo,
+  id,
+  string,
+  integer,
+  float,
+  boolean,
+  date,
+  time,
+  datetime,
+  timestamp,
+  email,
+  json,
+  phone,
+  url,
+  ipAddress,
+  handler,
+};

package/src/index.ts

@@ -0,0 +1,6 @@
+import * as a from './a';
+import { ClientSchema } from './ClientSchema';
+
+export { a };
+
+export type { ClientSchema };

package/src/internals/index.ts

@@ -0,0 +1,2 @@
+export { configure } from '../ModelSchema';
+export type { AllowModifier } from '../Authorization';

package/src/runtime/addSchemaToClient.ts

@@ -0,0 +1,45 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { ClientExtensions } from './client';
+import {
+  generateCustomQueriesProperty,
+  generateCustomMutationsProperty,
+  generateCustomSubscriptionsProperty,
+  generateEnumsProperty,
+  generateModelsProperty,
+} from './internals';
+import {
+  BaseClient,
+  ClientInternalsGetter,
+  GraphQLProviderConfig,
+} from './bridge-types';
+
+export function addSchemaToClient<T extends Record<any, any> = never>(
+  client: BaseClient,
+  apiGraphqlConfig: GraphQLProviderConfig['GraphQL'],
+  getInternals: ClientInternalsGetter,
+): BaseClient & ClientExtensions<T> {
+  (client as any).models = generateModelsProperty<T>(
+    client as any,
+    apiGraphqlConfig,
+    getInternals,
+  );
+  (client as any).enums = generateEnumsProperty<T>(apiGraphqlConfig);
+  (client as any).queries = generateCustomQueriesProperty<T>(
+    client as any,
+    apiGraphqlConfig,
+    getInternals,
+  );
+  (client as any).mutations = generateCustomMutationsProperty<T>(
+    client as any,
+    apiGraphqlConfig,
+    getInternals,
+  );
+  (client as any).subscriptions = generateCustomSubscriptionsProperty(
+    client as any,
+    apiGraphqlConfig,
+    getInternals,
+  );
+  return client as any;
+}

package/src/runtime/addSchemaToClientWithInstance.ts

@@ -0,0 +1,46 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { isApiGraphQLConfig } from './internals/utils/runtimeTypeGuards/isApiGraphQLProviderConfig';
+import {
+  ClientExtensionsSSRCookies,
+  ClientExtensionsSSRRequest,
+} from './client';
+import {
+  generateCustomQueriesProperty,
+  generateCustomMutationsProperty,
+  generateEnumsProperty,
+} from './internals';
+import { generateModelsProperty as generateModelsPropertyServer } from './internals/server';
+import { BaseClient, ClientInternalsGetter } from './bridge-types';
+
+// TODO: separate import path
+export function addSchemaToClientWithInstance<T extends Record<any, any>>(
+  client: BaseClient,
+  params: any,
+  getInternals: ClientInternalsGetter,
+): BaseClient &
+  (ClientExtensionsSSRCookies<T> | ClientExtensionsSSRRequest<T>) {
+  const apiGraphqlConfig = params.config?.API?.GraphQL;
+
+  if (isApiGraphQLConfig(apiGraphqlConfig)) {
+    (client as any).models = generateModelsPropertyServer<T>(
+      client as any,
+      params,
+      getInternals,
+    );
+    (client as any).enums = generateEnumsProperty<T>(apiGraphqlConfig);
+    (client as any).queries = generateCustomQueriesProperty<T>(
+      client as any,
+      apiGraphqlConfig,
+      getInternals,
+    );
+    (client as any).mutations = generateCustomMutationsProperty<T>(
+      client as any,
+      apiGraphqlConfig,
+      getInternals,
+    );
+  }
+
+  return client as any;
+}

package/src/runtime/bridge-types.ts

@@ -0,0 +1,382 @@
+/* eslint-disable @typescript-eslint/no-namespace */
+
+/**
+ * Sort-of-Minimalistic types used to allow `@aws-amplify/api-graphql` to call into
+ * `@aws-amplify/data-schema` without forcing `@aws-amplify/data-schema` to become the
+ * bucket for ALL of those types.
+ *
+ * In other words, types that relate to GraphQL category operations apart from the
+ * gen2/modeled operations should continue to live in `@aws-amplify/api-graphql`. And,
+ * `@aws-amplify/data-schema` should ideally only define those types/interfaces that are
+ * necessary to safely extend a graphql client.
+ */
+
+import { Observable } from 'rxjs';
+
+import { CustomHeaders, ModelSortDirection } from './client';
+
+export declare namespace AmplifyServer {
+  export interface ContextToken {
+    readonly value: symbol;
+  }
+  export interface ContextSpec {
+    readonly token: ContextToken;
+  }
+}
+
+export interface AmplifyClass {
+  getConfig(): Readonly<ResourcesConfig>;
+  // truncated
+}
+
+export interface ResourcesConfig {
+  API?: APIConfig;
+  // truncated.
+}
+
+interface APIRestConfig {
+  /**
+   * Required REST endpoint, must be a valid URL string.
+   */
+  endpoint: string;
+  /**
+   * Optional region string used to sign the request with IAM credentials. If Omitted, region will be extracted from
+   * the endpoint.
+   *
+   * @default 'us-east-1'
+   */
+  region?: string;
+  /**
+   * Optional service name string to sign the request with IAM credentials.
+   *s
+   * @default 'execute-api'
+   */
+  service?: string;
+}
+
+export interface RESTProviderConfig {
+  REST: Record<string, APIRestConfig>;
+}
+export type AtLeastOne<T, U = { [K in keyof T]: Pick<T, K> }> = Partial<T> &
+  U[keyof U];
+
+export type APIConfig = AtLeastOne<RESTProviderConfig & GraphQLProviderConfig>;
+
+export interface GraphQLProviderConfig {
+  readonly GraphQL: {
+    modelIntrospection?: ModelIntrospectionSchema;
+  };
+}
+
+/**
+ *
+ * TODO: Have @aws-amplify/core import these types from here?
+ *
+ */
+
+/**
+ * Root model instrospection schema shape.
+ *
+ * Borrowed from: https://github.com/aws-amplify/samsara-cli/pull/377/commits/c08ea2c1a43f36aafe63b6d14d03f884e9c0c671#diff-21ae6faa2f22c15bb25ff9b272eaab7846c0650e2d267ab720546c19559583d0R4-R108
+ */
+export interface ModelIntrospectionSchema {
+  version: 1;
+  models: SchemaModels;
+  nonModels: SchemaNonModels;
+  enums: SchemaEnums;
+  queries?: CustomOperations;
+  mutations?: CustomOperations;
+  subscriptions?: CustomOperations;
+}
+
+/**
+ * Top-level Entities on a Schema
+ */
+export type SchemaModels = Record<string, SchemaModel>;
+export type SchemaNonModels = Record<string, SchemaNonModel>;
+export type SchemaEnums = Record<string, SchemaEnum>;
+export type CustomOperations = Record<string, CustomOperation>;
+
+export interface SchemaModel {
+  name: string;
+  attributes?: ModelAttribute[];
+  fields: Fields;
+  pluralName: string;
+  syncable?: boolean;
+  primaryKeyInfo: PrimaryKeyInfo;
+}
+export interface SchemaNonModel {
+  name: string;
+  fields: Fields;
+}
+export interface SchemaEnum {
+  name: string;
+  values: string[];
+}
+
+export interface ModelAttribute {
+  type: string;
+  properties?: Record<string, any>;
+}
+
+export interface SecondaryIndexAttribute {
+  type: 'key';
+  properties: {
+    name: string;
+    queryField: string;
+    fields: string[];
+  };
+}
+
+export interface CustomOperation {
+  name: string;
+  type: FieldType;
+  isArray: boolean;
+  isRequired: boolean;
+  arguments?: CustomOperationArguments;
+}
+
+export type CustomOperationArguments = Record<string, CustomOperationArgument>;
+
+export interface CustomOperationArgument {
+  name: string;
+  type: FieldType;
+  isArray: boolean;
+  isRequired: boolean;
+  isArrayNullable?: boolean;
+}
+
+/**
+ * Field Definition
+ */
+export type Fields = Record<string, Field>;
+export interface Field {
+  name: string;
+  type: FieldType;
+  isArray: boolean;
+  isRequired: boolean;
+  isReadOnly?: boolean;
+  isArrayNullable?: boolean;
+  attributes?: FieldAttribute[];
+  association?: AssociationType;
+}
+
+export type DocumentType =
+  | null
+  | boolean
+  | number
+  | string
+  | DocumentType[]
+  | { [prop: string]: DocumentType };
+
+export type GraphQLAuthMode =
+  | 'apiKey'
+  | 'oidc'
+  | 'userPool'
+  | 'iam'
+  | 'lambda'
+  | 'none';
+
+export interface ModelFieldType {
+  model: string;
+}
+export interface NonModelFieldType {
+  nonModel: string;
+}
+
+export type FieldType =
+  | 'ID'
+  | 'String'
+  | 'Int'
+  | 'Float'
+  | 'AWSDate'
+  | 'AWSTime'
+  | 'AWSDateTime'
+  | 'AWSTimestamp'
+  | 'AWSEmail'
+  | 'AWSURL'
+  | 'AWSIPAddress'
+  | 'Boolean'
+  | 'AWSJSON'
+  | 'AWSPhone'
+  | { enum: string }
+  | ModelFieldType
+  | NonModelFieldType;
+export type FieldAttribute = ModelAttribute;
+
+/**
+ * Field-level Relationship Definitions
+ */
+export enum CodeGenConnectionType {
+  HAS_ONE = 'HAS_ONE',
+  BELONGS_TO = 'BELONGS_TO',
+  HAS_MANY = 'HAS_MANY',
+}
+export interface AssociationBaseType {
+  connectionType: CodeGenConnectionType;
+}
+
+export type AssociationHasMany = AssociationBaseType & {
+  connectionType: CodeGenConnectionType.HAS_MANY;
+  associatedWith: string[];
+};
+export type AssociationHasOne = AssociationBaseType & {
+  connectionType: CodeGenConnectionType.HAS_ONE;
+  associatedWith: string[];
+  targetNames: string[];
+};
+
+export type AssociationBelongsTo = AssociationBaseType & {
+  connectionType: CodeGenConnectionType.BELONGS_TO;
+  targetNames: string[];
+};
+export type AssociationType =
+  | AssociationHasMany
+  | AssociationHasOne
+  | AssociationBelongsTo;
+
+export interface PrimaryKeyInfo {
+  isCustomPrimaryKey: boolean;
+  primaryKeyFieldName: string;
+  sortKeyFieldNames: string[];
+}
+
+/**
+ * HUB
+ */
+
+export type IListener<
+  Channel extends string = AmplifyChannel | string,
+  EventData extends EventDataMap = EventDataMap,
+> = {
+  name: string;
+  callback: HubCallback<Channel, EventData>;
+}[];
+
+export interface EventDataMap {
+  event: string;
+  data?: unknown;
+}
+
+export interface AmplifyEventData {
+  auth: any; // edited: generalized for bridge type
+  [key: string]: EventDataMap;
+}
+export type AmplifyChannel = 'auth';
+
+export type StopListenerCallback = () => void;
+
+export interface HubCapsule<
+  Channel extends string,
+  EventData extends EventDataMap,
+> {
+  channel: Channel;
+  payload: HubPayload<EventData>;
+  source?: string;
+  patternInfo?: string[];
+}
+
+export type HubCallback<
+  Channel extends string = string,
+  EventData extends EventDataMap = EventDataMap,
+> = (capsule: HubCapsule<Channel, EventData>) => void;
+
+export type HubPayload<EventData extends EventDataMap = EventDataMap> =
+  EventData & {
+    message?: string;
+  };
+
+export interface AmplifyHubCallbackMap<Channel extends AmplifyChannel> {
+  auth: HubCallback<Channel>;
+}
+
+/**
+ * Loose/Unknown options for raw GraphQLAPICategory `graphql()`.
+ */
+export interface GraphQLOptions {
+  query: string;
+  variables?: Record<string, any>;
+  authMode?: GraphQLAuthMode;
+  authToken?: string;
+  /**
+   * @deprecated This property should not be used
+   */
+  userAgentSuffix?: string;
+}
+
+export interface GraphQLResult {
+  data: any;
+  errors?: Record<string, any>[];
+  extensions?: Record<string, any>;
+}
+
+export type GraphqlSubscriptionResult = Observable<{
+  data: Record<string, any>;
+}>;
+
+/**
+ * @private
+ *
+ * The knobs available for configuring `server/generateClient` internally.
+ */
+export interface ServerClientGenerationParams {
+  amplify:
+    | null // null expected when used with `generateServerClient`
+    // closure expected with `generateServerClientUsingCookies`
+    | ((fn: (amplify: AmplifyClass) => Promise<any>) => Promise<any>);
+  // global env-sourced config use for retrieving modelIntro
+  config: ResourcesConfig;
+}
+
+export type QueryArgs = Record<string, unknown>;
+
+export interface ListArgs extends Record<string, unknown> {
+  selectionSet?: string[];
+  filter?: Record<string, unknown>;
+  sortDirection?: ModelSortDirection;
+  headers?: CustomHeaders;
+}
+
+export interface AuthModeParams extends Record<string, unknown> {
+  authMode?: GraphQLAuthMode;
+  authToken?: string;
+}
+
+export interface GenerateServerClientParams {
+  config: ResourcesConfig;
+  authMode?: GraphQLAuthMode;
+  authToken?: string;
+}
+
+export type ClientInternals = {
+  amplify: AmplifyClass;
+  authMode: GraphQLAuthMode | undefined;
+  authToken: string | undefined;
+  headers: CustomHeaders | undefined;
+};
+
+export type ClientInternalsGetter = (client: any) => ClientInternals;
+
+export type BaseClient = BaseBrowserClient | BaseSSRClient;
+
+export type BaseBrowserClient = {
+  graphql: GraphQLMethod;
+  cancel(promise: Promise<any>, message?: string): boolean;
+  isCancelError(error: any): boolean;
+};
+export type BaseSSRClient = {
+  graphql: GraphQLMethodSSR;
+  cancel(promise: Promise<any>, message?: string): boolean;
+  isCancelError(error: any): boolean;
+};
+
+export type GraphQLMethod = (
+  options: GraphQLOptions,
+  additionalHeaders?: CustomHeaders | undefined,
+) => GraphQLResult | GraphqlSubscriptionResult;
+
+export type GraphQLMethodSSR = (
+  contextSpec: AmplifyServer.ContextSpec,
+  options: GraphQLOptions,
+  additionalHeaders?: CustomHeaders | undefined,
+) => GraphQLResult | GraphqlSubscriptionResult;