@nixxie-cms/auth 1.0.1

package/src/templates/config.ts

@@ -0,0 +1,9 @@
+export default function ({ labelField }: { labelField: string }) {
+  return `import { type AdminConfig } from '@nixxie-cms/core/types'
+import makeNavigation from '@nixxie-cms/auth/components/Navigation'
+
+export const components: AdminConfig['components'] = {
+  Navigation: makeNavigation({ labelField: '${labelField}' }),
+}
+`
+}

package/src/templates/init.ts

@@ -0,0 +1,22 @@
+import type { BaseListTypeInfo } from '@nixxie-cms/core/types'
+import type { AuthGqlNames, AuthConfig } from '../types'
+
+export default function ({
+  authGqlNames,
+  listKey,
+  initFirstItem,
+}: {
+  authGqlNames: AuthGqlNames
+  listKey: string
+  initFirstItem: NonNullable<AuthConfig<BaseListTypeInfo>['initFirstItem']>
+}) {
+  return `import makeInitPage from '@nixxie-cms/auth/pages/InitPage'
+
+export default makeInitPage(${JSON.stringify({
+    listKey,
+    authGqlNames,
+    fieldPaths: initFirstItem.fields,
+    enableWelcome: !initFirstItem.skipNixxieWelcome,
+  })})
+`
+}

package/src/templates/signin.ts

@@ -0,0 +1,20 @@
+import type { AuthGqlNames } from '../types'
+
+export default function ({
+  authGqlNames,
+  identityField,
+  secretField,
+}: {
+  authGqlNames: AuthGqlNames
+  identityField: string
+  secretField: string
+}) {
+  return `import makeSigninPage from '@nixxie-cms/auth/pages/SigninPage'
+
+export default makeSigninPage(${JSON.stringify({
+    authGqlNames,
+    identityField,
+    secretField,
+  })})
+`
+}

package/src/types.ts

@@ -0,0 +1,57 @@
+import type { BaseListTypeInfo, NixxieContext } from '@nixxie-cms/core/types'
+
+export type AuthGqlNames = {
+  itemQueryName: string
+  whereUniqueInputName: string
+
+  authenticateItemWithPassword: string
+  ItemAuthenticationWithPasswordResult: string
+  ItemAuthenticationWithPasswordSuccess: string
+  ItemAuthenticationWithPasswordFailure: string
+
+  CreateInitialInput: string
+  createInitialItem: string
+}
+
+export type SendTokenFn = (args: {
+  itemId: string | number | bigint
+  identity: string
+  token: string
+  context: NixxieContext
+}) => Promise<void> | void
+
+export type AuthTokenTypeConfig = {
+  /** Called when a user should be sent the magic signin token they requested */
+  sendToken: SendTokenFn
+  /** How long do tokens stay valid for from time of issue, in minutes **/
+  tokensValidForMins?: number
+}
+
+export type AuthConfig<ListTypeInfo extends BaseListTypeInfo> = {
+  /** The key of the list to authenticate users with */
+  listKey: ListTypeInfo['key']
+  /** The path of the field the identity is stored in; must be text-ish */
+  identityField: ListTypeInfo['fields']
+  /** The path of the field the secret is stored in; must be password-ish */
+  secretField: ListTypeInfo['fields']
+  /** The initial user/db seeding functionality */
+  initFirstItem?: InitFirstItemConfig<ListTypeInfo>
+  /** Session data population */
+  sessionData?: string
+}
+
+export type InitFirstItemConfig<ListTypeInfo extends BaseListTypeInfo> = {
+  /** Array of fields to collect, e.g ['name', 'email', 'password'] */
+  fields: readonly ListTypeInfo['fields'][]
+  /** Suppresses the second screen where we ask people to subscribe and follow Nixxie */
+  skipNixxieWelcome?: boolean
+  /** Extra input to add for the create mutation */
+  itemData?: Partial<ListTypeInfo['inputs']['create']>
+}
+
+export type AuthTokenRedemptionErrorCode = 'FAILURE' | 'TOKEN_EXPIRED' | 'TOKEN_REDEEMED'
+
+export type SecretFieldImpl = {
+  generateHash: (secret: string) => Promise<string>
+  compare: (secret: string, hash: string) => Promise<boolean>
+}